|
qflib 0.98.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.util.Observable | +--de.qfs.lib.option.Option
An Option is a value with a name and some possible constraints. Its main intention is to be used as a user editable option in a GUI application, but it is also useful for configuration in general.
Options can be grouped together into an OptionSet
and
edited with the help of an OptionGroup
. A component to
edit a single Option can be created with OptionEdit.makeEdit
.
Options are serializable as long as their values are.
Constructor Summary | |
Option()
Create a new Option. |
|
Option(java.lang.String name,
java.lang.Object value)
Create a new Option with a name and a value. |
|
Option(java.lang.String name,
java.lang.Object value,
boolean nullOK)
Create a new Option with a name and a value and the nullOK flag. |
Method Summary | |
static void |
addResources(java.util.ResourceBundle resources)
Add some resources for the de.qfs.lib.option package. |
void |
addValidator(OptionValidator validator)
Add an OptionValidator to the Option. |
boolean |
checkValue(java.awt.Component component,
java.lang.Object value)
Check, whether the Option accepts a value. |
java.lang.Object |
clone()
Create a shallow copy of the Option. |
boolean |
equals(java.lang.Object object)
Two Options are considered equal if their names and values are equal. |
java.lang.String |
getName()
Get the name of the Option. |
static MapResourceBundle |
getResources()
Get the resources for the de.qfs.lib.option package. |
java.lang.Object |
getValue()
Get the value of the Option. |
int |
hashCode()
An Option's hashCode is generated from its name and value. |
boolean |
isNullOK()
Query whether null is a legal value for the Option. |
void |
removeValidator(OptionValidator validator)
Remove an OptionValidator from the Option. |
void |
setName(java.lang.String name)
Set the name of the Option. |
void |
setNullOK(boolean nullOK)
Set whether null is a legal value for the Option. |
static void |
setResources(java.util.ResourceBundle resources)
Set the resources of the de.qfs.lib.option package. |
void |
setValue(java.lang.Object value)
Set the value of the Option. |
java.lang.String |
toString()
Get a String representation for the Option. |
Methods inherited from class java.util.Observable |
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Option()
public Option(java.lang.String name, java.lang.Object value)
name
- The name to use.value
- The value to use.public Option(java.lang.String name, java.lang.Object value, boolean nullOK)
name
- The name to use.value
- The value to use.nullOK
- True to allow null values.Method Detail |
public static final MapResourceBundle getResources()
de.qfs.lib.option
package. See
the package documentation for details about the resource names used.public static final void setResources(java.util.ResourceBundle resources)
de.qfs.lib.option
package. See
the package documentation for details about the resource names used.resources
- The resources to set.public static final void addResources(java.util.ResourceBundle resources)
de.qfs.lib.option
package. See
the package documentation for details about the resource names used.resources
- The resources to add.public java.lang.String getName()
public void setName(java.lang.String name)
name
- The name to set.public java.lang.Object getValue()
public void setValue(java.lang.Object value)
value
- The value to set.public boolean isNullOK()
public void setNullOK(boolean nullOK)
nullOK
- True to allow null values.public boolean checkValue(java.awt.Component component, java.lang.Object value)
component
- The Component in which the Option is being
edited.value
- The value to check.public void addValidator(OptionValidator validator)
validator
- The OptionValidator to add.public void removeValidator(OptionValidator validator)
validator
- The OptionValidator to remove.public java.lang.String toString()
toString
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object object)
equals
in class java.lang.Object
object
- The object to compare to.public java.lang.Object clone()
clone
in class java.lang.Object
|
qflib 0.98.0 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |