net.sf.freecol.common.option
Class AudioMixerOption

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.AudioMixerOption
All Implemented Interfaces:
Option

public class AudioMixerOption
extends AbstractOption

Option for selecting an audio mixer.


Nested Class Summary
static class AudioMixerOption.MixerWrapper
           
 
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
AudioMixerOption(java.lang.String id)
          Creates a new AudioMixerOption.
AudioMixerOption(java.lang.String id, OptionGroup optionGroup)
           
 
Method Summary
 AudioMixerOption.MixerWrapper[] getOptions()
          Returns a list of the available audioMixers.
 AudioMixerOption.MixerWrapper getValue()
          Get the Value value.
static java.lang.String getXMLElementTagName()
          Gets the tag name of the root element representing this object.
 void setValue(AudioMixerOption.MixerWrapper 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
Constructor Detail

AudioMixerOption

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

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

AudioMixerOption

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

getValue

public final AudioMixerOption.MixerWrapper getValue()
Get the Value value.

Returns:
a String value

setValue

public final void setValue(AudioMixerOption.MixerWrapper newValue)
Set the Value value.

Parameters:
newValue - The new Value value.

getOptions

public AudioMixerOption.MixerWrapper[] getOptions()
Returns a list of the available audioMixers.

Returns:
The available audioMixers in a human readable format.

getXMLElementTagName

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

Returns:
"audioMixerOption".