net.ctdp.rfdynhud.properties
Class BooleanProperty

java.lang.Object
  extended by net.ctdp.rfdynhud.properties.Property
      extended by net.ctdp.rfdynhud.properties.BooleanProperty

public class BooleanProperty
extends Property

The BooleanProperty serves for customizing a primitive boolean value.

Author:
Marvin Froehlich (CTDP)

Constructor Summary
BooleanProperty(java.lang.String name, boolean defaultValue)
           
BooleanProperty(java.lang.String name, boolean defaultValue, boolean readonly)
           
BooleanProperty(java.lang.String name, java.lang.String nameForDisplay, boolean defaultValue)
           
BooleanProperty(java.lang.String name, java.lang.String nameForDisplay, boolean defaultValue, boolean readonly)
           
 
Method Summary
 boolean getBooleanValue()
          Gets the property's current value.
 java.lang.Boolean getValue()
          Gets the current value fo this property.
 void loadValue(PropertyLoader loader, java.lang.String value)
          Loads the value from the configuration file.
protected  void onKeeperSet()
          
protected  void onValueChanged(java.lang.Boolean oldValue, boolean newValue)
          Invoked when the value has changed.
 boolean setBooleanValue(boolean value)
          Sets the property's value.
protected  boolean setBooleanValue(boolean value, boolean firstTime)
          Sets the property's value.
 void setValue(java.lang.Object value)
          Sets the new value for this property.
 
Methods inherited from class net.ctdp.rfdynhud.properties.Property
getButtonText, getButtonTooltip, getDocumentationSource, getEditorType, getKeeper, getName, getNameForDisplay, getValueForConfigurationFile, isMatchingKey, isReadOnly, onButtonClicked, quoteValueInConfigurationFile, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BooleanProperty

public BooleanProperty(java.lang.String name,
                       java.lang.String nameForDisplay,
                       boolean defaultValue,
                       boolean readonly)
Parameters:
name - the technical name used internally. See Property.getName().
nameForDisplay - the name displayed in the editor. See Property.getNameForDisplay(). If null is passed, the value of the name parameter is used.
defaultValue - the default value
readonly - read only property?

BooleanProperty

public BooleanProperty(java.lang.String name,
                       java.lang.String nameForDisplay,
                       boolean defaultValue)
Parameters:
name - the technical name used internally. See Property.getName().
nameForDisplay - the name displayed in the editor. See Property.getNameForDisplay(). If null is passed, the value of the name parameter is used.
defaultValue - the default value

BooleanProperty

public BooleanProperty(java.lang.String name,
                       boolean defaultValue,
                       boolean readonly)
Parameters:
name - the technical name used internally. See Property.getName(). 'nameForDisplay' is set to the same value.
defaultValue - the default value
readonly - read only property?

BooleanProperty

public BooleanProperty(java.lang.String name,
                       boolean defaultValue)
Parameters:
name - the technical name used internally. See Property.getName(). 'nameForDisplay' is set to the same value.
defaultValue - the default value
Method Detail

onKeeperSet

protected void onKeeperSet()

Overrides:
onKeeperSet in class Property

onValueChanged

protected void onValueChanged(java.lang.Boolean oldValue,
                              boolean newValue)
Invoked when the value has changed.

Parameters:
oldValue - the old value
newValue - the new value

setBooleanValue

protected final boolean setBooleanValue(boolean value,
                                        boolean firstTime)
Sets the property's value.

Parameters:
value - the new value
firstTime -
Returns:
changed?

setBooleanValue

public final boolean setBooleanValue(boolean value)
Sets the property's value.

Parameters:
value - the new value
Returns:
changed?

getBooleanValue

public final boolean getBooleanValue()
Gets the property's current value.

Returns:
the property's current value.

setValue

public void setValue(java.lang.Object value)
Sets the new value for this property.

Specified by:
setValue in class Property
Parameters:
value - the new value

getValue

public java.lang.Boolean getValue()
Gets the current value fo this property.

Specified by:
getValue in class Property
Returns:
the current value fo this property.

loadValue

public void loadValue(PropertyLoader loader,
                      java.lang.String value)
Loads the value from the configuration file.

Specified by:
loadValue in class Property
Parameters:
loader - the loader
value - the value to load