|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.datacrow.core.settings.Setting
public class Setting
A Settings definition. The setting is always added to a file (the settings file) and if specified, the setting is also editable in the SettingsView.
Constructor Summary | |
---|---|
Setting(int dataType,
java.lang.String key,
java.lang.Object value,
int componentType,
java.lang.String helpText,
java.lang.String labelText,
boolean displayLabel,
boolean showToUser)
Creates a setting |
Method Summary | |
---|---|
boolean |
displayLabel()
|
int |
getDataType()
The value type. |
java.lang.String |
getHelpText()
|
java.lang.String |
getKey()
The setting key ( DcRepository.Settings , DcRepository.ModuleSettings ). |
java.lang.String |
getLabelText()
|
int |
getSettingsGroup()
|
int |
getSettingsGroupParent()
|
javax.swing.JComponent |
getUIComponent()
|
java.lang.Object |
getValue()
|
java.lang.String |
getValueAsString()
Creates a string representation of the value which can be used to store the value. |
boolean |
isTemporary()
|
void |
isTemporary(boolean b)
|
void |
setStringAsValue(java.lang.String s)
Allows a string representation to be set as a value. |
void |
setValue(java.lang.Object o)
|
boolean |
showToUser()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Setting(int dataType, java.lang.String key, java.lang.Object value, int componentType, java.lang.String helpText, java.lang.String labelText, boolean displayLabel, boolean showToUser)
iDataType
- the data type of the valuesKey
- a unique identifier, also used for the settings fileoValue
- the default value for thsi settingcomponentType
- the UI componenthelptext
- helptext for this setting, used as tooltiplabeltext
- the display text for the labeldisplaylabel
- show the label on screen ?showToUser
- is the setting meant to be display in the panel ?Method Detail |
---|
public void isTemporary(boolean b)
public boolean isTemporary()
public java.lang.String getLabelText()
public boolean displayLabel()
public boolean showToUser()
public int getSettingsGroup()
public int getSettingsGroupParent()
public javax.swing.JComponent getUIComponent()
public int getDataType()
DcRepository.ValueTypes
public java.lang.String getKey()
DcRepository.Settings
, DcRepository.ModuleSettings
).
public java.lang.Object getValue()
public java.lang.String getHelpText()
public java.lang.String getValueAsString()
public void setValue(java.lang.Object o)
public void setStringAsValue(java.lang.String s)
s
- String representation of the value.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |