net.sf.freecol.common.option
Class LanguageOption

java.lang.Object
  extended by net.sf.freecol.common.model.FreeColObject
      extended by net.sf.freecol.common.option.AbstractOption
          extended by net.sf.freecol.common.option.LanguageOption
All Implemented Interfaces:
Option

public class LanguageOption
extends AbstractOption

Option for selecting a language. The possible choices are determined using the available language files in "data/strings".


Nested Class Summary
 class LanguageOption.Language
           
 
Field Summary
static java.lang.String AUTO
           
 
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
LanguageOption(java.lang.String id)
          Creates a new LanguageOption.
LanguageOption(java.lang.String id, OptionGroup optionGroup)
           
LanguageOption(javax.xml.stream.XMLStreamReader in)
          Creates a new IntegerOption.
 
Method Summary
static java.util.Locale getLocale(java.lang.String languageID)
          Returns the Locale decided by the given name.
 LanguageOption.Language[] getOptions()
          Returns a list of the available languages.
 LanguageOption.Language getValue()
          Get the Value value.
static java.lang.String getXMLElementTagName()
          Gets the tag name of the root element representing this object.
 void setValue(LanguageOption.Language newValue)
          Set the Value value.
 
Methods inherited from class net.sf.freecol.common.option.AbstractOption
getGroup, getName, getShortDescription, isPreviewEnabled, setGroup, setPreviewEnabled, toString
 
Methods inherited from class net.sf.freecol.common.model.FreeColObject
addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAttribute, getAttribute, getAttribute, getAttribute, getId, getPropertyChangeListeners, getPropertyChangeListeners, hasAbility, hasAttribute, hasListeners, readFromXML, readFromXMLElement, removePropertyChangeListener, removePropertyChangeListener, toXML, toXML, toXML, toXMLElement, toXMLElement, toXMLElement, toXMLElement, toXMLElementPartial, writeAttribute, writeFreeColGameObject
 
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
 

Field Detail

AUTO

public static final java.lang.String AUTO
See Also:
Constant Field Values
Constructor Detail

LanguageOption

public LanguageOption(javax.xml.stream.XMLStreamReader in)
               throws javax.xml.stream.XMLStreamException
Creates a new IntegerOption.

Parameters:
in - The XMLStreamReader containing the data.
Throws:
javax.xml.stream.XMLStreamException

LanguageOption

public LanguageOption(java.lang.String id)
Creates a new LanguageOption.

Parameters:
id - The identifier for this option. This is used when the object should be found in an OptionGroup.

LanguageOption

public LanguageOption(java.lang.String id,
                      OptionGroup optionGroup)
Method Detail

getValue

public final LanguageOption.Language getValue()
Get the Value value.

Returns:
a String value

setValue

public final void setValue(LanguageOption.Language newValue)
Set the Value value.

Parameters:
newValue - The new Value value.

getOptions

public LanguageOption.Language[] getOptions()
Returns a list of the available languages.

Returns:
The available languages in a human readable format.

getLocale

public static java.util.Locale getLocale(java.lang.String languageID)
Returns the Locale decided by the given name.

Parameters:
languageID - A String using the same format as #getStringValue().
Returns:
The Locale.

getXMLElementTagName

public static java.lang.String getXMLElementTagName()
Gets the tag name of the root element representing this object.

Returns:
"selectOption".