|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.freecol.common.model.FreeColObject
net.sf.freecol.common.option.AbstractOption
net.sf.freecol.common.option.OptionGroup
public class OptionGroup
Used for grouping objects of Option
s.
Field Summary |
---|
Fields inherited from class net.sf.freecol.common.option.AbstractOption |
---|
NO_ID |
Fields inherited from class net.sf.freecol.common.model.FreeColObject |
---|
ID_ATTRIBUTE_TAG |
Constructor Summary | |
---|---|
OptionGroup()
Creates a new OptionGroup . |
|
OptionGroup(java.lang.String id)
Creates a new OptionGroup . |
|
OptionGroup(javax.xml.stream.XMLStreamReader in)
Creates a new OptionGroup . |
Method Summary | |
---|---|
void |
add(Option option)
Adds the given Option . |
java.lang.String |
getName()
Returns the name of this Option . |
java.lang.String |
getShortDescription()
Gives a short description of this Option . |
static java.lang.String |
getXMLElementTagName()
Gets the tag name of the root element representing this object. |
java.util.Iterator<Option> |
iterator()
Returns an Iterator for the Option s. |
void |
removeAll()
Removes all of the Option s from this OptionGroup . |
Methods inherited from class net.sf.freecol.common.option.AbstractOption |
---|
getGroup, isPreviewEnabled, setGroup, setPreviewEnabled, toString |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface net.sf.freecol.common.option.Option |
---|
addPropertyChangeListener, getId, readFromXML, readFromXMLElement, removePropertyChangeListener, toXML, toXMLElement |
Constructor Detail |
---|
public OptionGroup()
OptionGroup
.
public OptionGroup(java.lang.String id)
OptionGroup
.
id
- The identifier for this option. This is used when the object should be
found in an OptionGroup
.public OptionGroup(javax.xml.stream.XMLStreamReader in) throws javax.xml.stream.XMLStreamException
OptionGroup
.
in
- The XMLStreamReader
containing the data.
javax.xml.stream.XMLStreamException
Method Detail |
---|
public void add(Option option)
Option
.
option
- The Option
that should be
added to this OptionGroup
.public void removeAll()
Option
s from this OptionGroup
.
public java.util.Iterator<Option> iterator()
Iterator
for the Option
s.
Iterator
.public static java.lang.String getXMLElementTagName()
public java.lang.String getName()
Option
.
getName
in interface Option
getName
in class AbstractOption
public java.lang.String getShortDescription()
Option
. Can for
instance be used as a tooltip text.
getShortDescription
in interface Option
getShortDescription
in class AbstractOption
Option
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |