|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.ctdp.rfdynhud.properties.Property
public abstract class Property
The Property
serves as a general data container and adapter.
You can use it to put data into a GUI component and live update it.
Constructor Summary | |
---|---|
|
Property(java.lang.String name,
boolean readonly,
PropertyEditorType editorType)
|
|
Property(java.lang.String name,
boolean readonly,
PropertyEditorType editorType,
java.lang.String buttonText,
java.lang.String buttonTooltip)
|
|
Property(java.lang.String name,
PropertyEditorType editorType)
|
|
Property(java.lang.String name,
java.lang.String nameForDisplay,
boolean readonly,
PropertyEditorType editorType)
|
protected |
Property(java.lang.String name,
java.lang.String nameForDisplay,
boolean readonly,
PropertyEditorType editorType,
java.lang.String buttonText,
java.lang.String buttonTooltip)
|
|
Property(java.lang.String name,
java.lang.String nameForDisplay,
PropertyEditorType editorType)
|
Method Summary | |
---|---|
java.lang.String |
getButtonText()
|
java.lang.String |
getButtonTooltip()
|
java.lang.String |
getDocumentationSource()
Loads documentation for this Property from a "e;doc"e; folder under the keeper's package. |
PropertyEditorType |
getEditorType()
Gets the proeprty editor type. |
PropertiesKeeper |
getKeeper()
Gets the owner PropertiesKeeper . |
java.lang.String |
getName()
Gets the property's technical name. |
java.lang.String |
getNameForDisplay()
Gets the property's name for editor display. |
abstract java.lang.Object |
getValue()
Gets the current value fo this property. |
java.lang.Object |
getValueForConfigurationFile()
Gets the value prepared for the configuration file. |
boolean |
isMatchingKey(java.lang.String key)
Checks whether the given key (from the configuration file) belongs to this Property . |
boolean |
isReadOnly()
Is read only property? |
abstract void |
loadValue(PropertyLoader loader,
java.lang.String value)
Loads the value from the configuration file. |
void |
onButtonClicked(java.lang.Object button)
|
protected void |
onKeeperSet()
|
java.lang.Boolean |
quoteValueInConfigurationFile()
Gets whether to quote this property's value in the config file (default is null, type dependent, numbers won't, others will). |
abstract void |
setValue(java.lang.Object value)
Sets the new value for this property. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected Property(java.lang.String name, java.lang.String nameForDisplay, boolean readonly, PropertyEditorType editorType, java.lang.String buttonText, java.lang.String buttonTooltip)
name
- the property namenameForDisplay
- the name for editor display (null
to use name)readonly
- read only property?editorType
- the property editor typebuttonText
- the text for the button (may be null
)buttonTooltip
- the tooltip for the button (ignored when button text is null
)public Property(java.lang.String name, java.lang.String nameForDisplay, boolean readonly, PropertyEditorType editorType)
name
- the technical name used internally. See getName()
.nameForDisplay
- the name displayed in the editor. See getNameForDisplay()
. If null
is passed, the value of the name parameter is used.readonly
- read only property?editorType
- the property editor typepublic Property(java.lang.String name, java.lang.String nameForDisplay, PropertyEditorType editorType)
name
- the technical name used internally. See getName()
.nameForDisplay
- the name displayed in the editor. See getNameForDisplay()
. If null
is passed, the value of the name parameter is used.editorType
- the property editor typepublic Property(java.lang.String name, boolean readonly, PropertyEditorType editorType, java.lang.String buttonText, java.lang.String buttonTooltip)
name
- the technical name used internally. See getName()
.readonly
- read only property?editorType
- the property editor typebuttonText
- the text for the button (may be null
)buttonTooltip
- the tooltip for the button (ignored when button text is null
)public Property(java.lang.String name, boolean readonly, PropertyEditorType editorType)
name
- the technical name used internally. See getName()
.readonly
- read only property?editorType
- the property editor typepublic Property(java.lang.String name, PropertyEditorType editorType)
name
- the technical name used internally. See getName()
.editorType
- the property editor typeMethod Detail |
---|
protected void onKeeperSet()
public final PropertiesKeeper getKeeper()
PropertiesKeeper
.
PropertiesKeeper
.public final java.lang.String getName()
public java.lang.String getNameForDisplay()
public final boolean isReadOnly()
public final PropertyEditorType getEditorType()
public java.lang.String getButtonText()
public java.lang.String getButtonTooltip()
public abstract void setValue(java.lang.Object value)
value
- the new valuepublic abstract java.lang.Object getValue()
public void onButtonClicked(java.lang.Object button)
button
- the clicked buttonpublic java.lang.Boolean quoteValueInConfigurationFile()
public java.lang.Object getValueForConfigurationFile()
public boolean isMatchingKey(java.lang.String key)
Property
.
key
- the probed property key
Property
.public abstract void loadValue(PropertyLoader loader, java.lang.String value)
loader
- the loadervalue
- the value to loadpublic java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getDocumentationSource()
Property
from a "e;doc"e; folder under the keeper's package.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |