|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Option
An option describes something which can be customized by the user.
GameOptions
Field Summary | |
---|---|
static java.lang.String |
NO_ID
|
Method Summary | |
---|---|
void |
addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
Adds a new PropertyChangeListener for monitoring state
changes. |
java.lang.String |
getId()
Returns the id of this Option . |
java.lang.String |
getName()
Returns the name of this Option . |
java.lang.String |
getShortDescription()
Gives a short description of this Option . |
boolean |
isPreviewEnabled()
Should this option be updated directly so that changes may be previewes? |
void |
readFromXML(javax.xml.stream.XMLStreamReader in)
Initializes this object from an XML-representation of this object. |
void |
readFromXMLElement(org.w3c.dom.Element element)
Initializes this object from an XML-representation of this object. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
Remove the given PropertyChangeListener . |
java.lang.String |
toString()
Returns a textual representation of this object. |
void |
toXML(javax.xml.stream.XMLStreamWriter out)
Makes an XML-representation of this object. |
org.w3c.dom.Element |
toXMLElement(org.w3c.dom.Document document)
Makes an XML-representation of this object. |
Field Detail |
---|
static final java.lang.String NO_ID
Method Detail |
---|
java.lang.String getShortDescription()
Option
.
Can for instance be used as a tooltip text.
java.lang.String toString()
toString
in class java.lang.Object
Option
.#getLocalizedName
java.lang.String getId()
Option
.
java.lang.String getName()
Option
.
boolean isPreviewEnabled()
true
if changes to this
option should be made directly (and reset
back later if the changes are not stored).void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
PropertyChangeListener
for monitoring state
changes. Events are generated when variables are changed.
pcl
- The PropertyChangeListener
to be added.void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
PropertyChangeListener
.
pcl
- The PropertyChangeListener
to be removed.org.w3c.dom.Element toXMLElement(org.w3c.dom.Document document)
document
- The document to use when creating new componenets.
void readFromXMLElement(org.w3c.dom.Element element)
element
- The DOM-element ("Document Object Model") made to represent this "Option".void readFromXML(javax.xml.stream.XMLStreamReader in) throws javax.xml.stream.XMLStreamException
in
- The input stream with the XML.
javax.xml.stream.XMLStreamException
- if there are any problems writing
to the stream.void toXML(javax.xml.stream.XMLStreamWriter out) throws javax.xml.stream.XMLStreamException
out
- The output stream.
javax.xml.stream.XMLStreamException
- if there are any problems writing
to the stream.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |