org.openbp.jaspira.option
Class GroupOption

java.lang.Object
  org.openbp.common.generic.description.DescriptionObjectImpl
      org.openbp.common.generic.description.DisplayObjectImpl
          org.openbp.jaspira.option.Option
              org.openbp.jaspira.option.GroupOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, javax.swing.tree.TreeNode, Copyable, DescriptionObject, Displayable, DisplayObject, Validatable

public class GroupOption
extends Option

An empty option containing several other options.

Author:

Jens Ferchland

See Also:

Serialized Form

Nested Class Summary

class

GroupOption.GroupWidget

Field Summary

Fields inherited from class org.openbp.jaspira.option.Option

DFLT_PRIORITY, priorityComparator, PROPERTY_CONDITION, PROPERTY_HEADING, PROPERTY_ICON, PROPERTY_OPTION_PARENT, PROPERTY_PRIO, PROPERTY_TYPE, TYPE_GROUP, TYPE_OPTION, TYPE_SUB_GROUP

Fields inherited from interface org.openbp.common.generic.Copyable

COPY_DEEP, COPY_FIRST_LEVEL, COPY_SHALLOW

Constructor Summary

GroupOption(ResourceCollection res, java.lang.String optionName)
Resource constructor.

GroupOption(java.lang.String optionName, java.lang.String displayName, java.lang.String description, Option parent, int prio)
Value constructor.

Method Summary

OptionWidget	createOptionWidget() Returns the widget for this option.
java.lang.String	getDescription() Returns a description of all option settings in this page.
java.lang.Object	loadFromString(java.lang.String cryptString) Deserializes the option value from a string.
java.lang.String	saveToString() Serializes the option value to a string.

Methods inherited from class org.openbp.jaspira.option.Option

addOptionChild, children, getAllowsChildren, getCachedOptionWidget, getChildAt, getChildCount, getCondition, getDefaultValue, getHeading, getIcon, getIndex, getOptionChildren, getParent, getPriority, getType, getValue, install, isLeaf, loadOptionValue, removeOptionChild, resetCachedOptionWidget, saveOptionValue, setValue, toString, uninstall

Methods inherited from class org.openbp.common.generic.description.DisplayObjectImpl

copyFrom, getDisplayName, getDisplayText, setDisplayName

Methods inherited from class org.openbp.common.generic.description.DescriptionObjectImpl

clone, compareTo, getDescriptionEscape, getDescriptionText, getName, setDescription, setDescriptionEscape, setName, validate

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openbp.common.generic.description.DescriptionObject

clone, getDescriptionText, getName, setDescription, setName

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

GroupOption

public GroupOption(ResourceCollection res,
                   java.lang.String optionName)

Resource constructor.

Parameters:

res - Resource defining the option

optionName - Name of the option

GroupOption

public GroupOption(java.lang.String optionName,
                   java.lang.String displayName,
                   java.lang.String description,
                   Option parent,
                   int prio)

Value constructor.

Parameters:

optionName - Name of the option

displayName - Display name of the option

description - Description of the option

parent - Option parent or null

prio - Priority of the option

Method Detail

createOptionWidget

public OptionWidget createOptionWidget()

Description copied from class: Option

Returns the widget for this option.

Specified by:

createOptionWidget in class Option

Returns:

The widget

See Also:

Option.createOptionWidget()

saveToString

public java.lang.String saveToString()

Description copied from class: Option

Serializes the option value to a string. This string value will be used to save the option using the SettingUtil class.

Specified by:

saveToString in class Option

Returns:

A string representing the option value
This value corresponds to the value expected by Option.loadFromString(java.lang.String).

See Also:

Option.saveToString()

loadFromString

public java.lang.Object loadFromString(java.lang.String cryptString)

Description copied from class: Option

Deserializes the option value from a string. This string value will be used to save the option using the SettingUtil class.

Specified by:

loadFromString in class Option

Parameters:

cryptString - A string representing the option value or null This value corresponds to the value returned by Option.saveToString().

Returns:

The option value

See Also:

Option.loadFromString(String)

getDescription

public java.lang.String getDescription()

Returns a description of all option settings in this page.

Specified by:

getDescription in interface DescriptionObject

Overrides:

getDescription in class DescriptionObjectImpl

Returns:

String