net.sf.ext.jflexsett.settings
Class Setting

java.lang.Object
  extended by net.sf.ext.jflexsett.settings.Setting

public class Setting
extends java.lang.Object

A Settings definition. The setting is always added to a file (the settings file) and if specified, the setting is also editable thru the SettingsView.

Since:
1.4
Version:
1.9
Author:
Robert Jan van der Waals

Constructor Summary
Setting(int iDataType, java.lang.String sKey, java.lang.Object oValue, int componentType, java.lang.String helpText, java.lang.String labelText, boolean displayLabel, boolean showToUser)
          Creates a setting
Setting(int iDataType, java.lang.String sKey, java.lang.Object oValue, javax.swing.JComponent component, java.lang.String helpText, java.lang.String labelText, boolean displayLabel, boolean showToUser)
          Creates a setting
 
Method Summary
 boolean displayLabel()
           
 int getDataType()
           
 java.lang.String getHelpText()
           
 java.lang.String getKey()
           
 java.lang.String getLabelText()
           
 int getSettingsGroup()
           
 int getSettingsGroupParent()
           
 javax.swing.JComponent getUIComponent()
           
 java.lang.Object getValue()
           
 java.lang.String getValueAsString()
           
 void setStringAsValue(java.lang.String sValue)
           
 void setValue(java.lang.Object oValue)
           
 boolean showToUser()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Setting

public Setting(int iDataType,
               java.lang.String sKey,
               java.lang.Object oValue,
               javax.swing.JComponent component,
               java.lang.String helpText,
               java.lang.String labelText,
               boolean displayLabel,
               boolean showToUser)
Creates a setting

Parameters:
iDataType - the data type of the value
sKey - a unique identifier, also used for the settings file
oValue - the default value for thsi setting
component - the UI component
helptext - helptext for this setting, used as tooltip
labeltext - the display text for the label
displaylabel - show the label on screen ?
showToUser - is the setting meant to be display in the panel ?

Setting

public Setting(int iDataType,
               java.lang.String sKey,
               java.lang.Object oValue,
               int componentType,
               java.lang.String helpText,
               java.lang.String labelText,
               boolean displayLabel,
               boolean showToUser)
Creates a setting

Parameters:
iDataType - the data type of the value
sKey - a unique identifier, also used for the settings file
oValue - the default value for thsi setting
componentType - the UI component
helptext - helptext for this setting, used as tooltip
labeltext - the display text for the label
displaylabel - show the label on screen ?
showToUser - is the setting meant to be display in the panel ?
Method Detail

getLabelText

public java.lang.String getLabelText()

displayLabel

public boolean displayLabel()

showToUser

public boolean showToUser()

getSettingsGroup

public int getSettingsGroup()

getSettingsGroupParent

public int getSettingsGroupParent()

getUIComponent

public javax.swing.JComponent getUIComponent()

getDataType

public int getDataType()

getKey

public java.lang.String getKey()

getValue

public java.lang.Object getValue()

getHelpText

public java.lang.String getHelpText()

getValueAsString

public java.lang.String getValueAsString()

setValue

public void setValue(java.lang.Object oValue)

setStringAsValue

public void setStringAsValue(java.lang.String sValue)