qflib 0.98.0

Package de.qfs.lib.option

This package forms a framework for creating, managing, (re)storing and editing options.

See:
          Description

Interface Summary
ConfigurableOption Options that implement this interface will be saved and restored via the Configuration mechanism, when they are contained in an OptionSet that is registered with the Configuration.
OptionValidator The range of legal values for an Option can be restricted by adding an OptionValidator with Option.addValidator.
 

Class Summary
BooleanOption A BooleanOption's value is of class Boolean.
BooleanOptionEdit An OptionEdit for a BooleanOption.
ChoiceOption A ChoiceOption is an Option that is edited with the help of a ChoiceOptionEdit.
ChoiceOptionEdit An OptionEdit for a ChoiceOption.
ChoiceOptionGroup Deprecated. Removed in version 0.98.0.
EditorOption An EditorOption is similar to a StringOption except that its edit Component is a JEditorPane.
EditorOptionEdit An OptionEdit for an EditorOption.
FileOption A FileOption's value is of class File.
FramedOptionGroup Deprecated. Replaced by PlainOptionGroup with the frame property set to true as of version 0.98.0.
IntegerOption An IntegerOption has a value of class Integer and an additional flag defining whether negative values are OK.
IntegerOptionEdit An OptionEdit for an IntegerOption.
NestedOption A NestedOption's value is an OptionSet.
NestedOptionGroup A NestedOptionGroup represents a NestedOption in an OptionSet.
Option An Option is a value with a name and some possible constraints.
OptionDialog This class offers a convenient way to bring up a dialog in which an application's options can be edited.
OptionDialog.OptionButtonData Extend the structure that encapsulates the values for a button.
OptionEdit An OptionEdit is a component used to edit an Option's value.
OptionGroup OptionGroups form a hierarchie of nested GUI components in which Options are grouped together for convenient editing.
OptionSet An OptionSet bundles Options together, offering convenience methods for easy, typed access to their values.
PlainOptionGroup A PlainOptionGroup packs Options and Subgroups together into a Grid.
RadioOptionGroup A RadioOptionGroup consists of a group of mutually exclusive RadioButtons for one Option value.
SimpleOptionEdit Common baseclass for similar kinds of OptionEdits that are built from a JLabel and a JTextComponent.
StringOption A StringOption's value is of class String.
StringOptionEdit An OptionEdit for a StringOption.
TabbedOptionGroup A TabbedOptionGroup uses a JTabbedPane to distribute its OptionGroup members into several tabs.
TextOption A TextOption is similar to a StringOption except that its edit Component is a mulitline text area.
TextOptionEdit A multiline OptionEdit for a TextOption.
 

Package de.qfs.lib.option Description

This package forms a framework for creating, managing, (re)storing and editing options.

Options have a name and a value and are packed together in an OptionSet, which offers convenient access to their typed values. An OptionSet implements the Configurable interface, so it is easy to save and restore Options.

To edit options, they can be arranged in a hierarchie of OptionGroups and OptionEdits.

The most convenient way to bring up a dialog to edit a set of Options is to create an OptionDialog and call its doModal method .

The type, layout and labels of the components used to edit a set of Options are determined by a set of resources, that must be set with Option.setResources.

For the standard error messages and the button labels of an OptionDialog, these resources must include the following values, which are read by default from /de/qfs/lib/resources/properties/qflib in qflib.jar.

Resource name Usage
option.error.empty.title Title for the Empty value message.
option.error.empty.message Message for the Empty value message.
option.error.notANumber.title Title for the Bad format message.
option.error.notANumber.message Message for the Bad format message.
option.error.negative.title Title for the Negative value message.
option.error.negative.message Message for the Negative value message.
option.dialog.ok.name Label for the OK button of an OptionDialog.
option.dialog.ok.mnemonic Shortcut for the OK button of an OptionDialog.
option.dialog.cancel.name Label for the Cancel button of an OptionDialog.
option.dialog.cancel.mnemonic Shortcut for the Cancel button of an OptionDialog.

The additional resource names must have the following format (name denotes the name of an Option and groupname the name of an OptionGroup):

Resource name Usage
option.name.label The label for the Option (optional, default empty).
option.name.mnemonic Keyboard accelerator (optional, default none).
option.name.disabled If true, the OptionEdit will be disabled and remain so even if setEnabled(true) is called (optional, default false).
option.name.height Preferred width in characters for a TextOptionEdit or an EditorOptionEdit.
option.name.height Preferred height in lines for a TextOptionEdit or an EditorOptionEdit.
option.name.font The font for a TextOptionEdit or an EditorOptionEdit (optional, default is standard TextField font).
option.name.weight The weight (a double) to use for a TextOptionEdit or an EditorOptionEdit when placed in the Grid of a PlainOptionGroup (optional, default 0).
option.name.scroll If true a TextOptionEdit or EditorOptionEdit will get its own scroll pane (optional, default true).
option.name.type The content type for the JEditorPane of an EditorOptionEdit (optional, default text/plain).
option.name.numchoices The number of choices in a ChoiceOptionEdit.
option.name.choicen.label The label for the nth choice of a ChoiceOptionEdit, where n is between 1 and numchoices.
option.group.groupname.type The type of an OptionGroup. Supported types are plain, radio, tab, nested and custom.
option.name.disabled If true, the OptionGroup will be disabled and remain so even if setEnabled(true) is called (optional, default false).
option.group.groupname.members The members of an OptionGroup of type plain. A space separated list where name denotes an Option and group.groupname denotes an OptionGroup.
option.group.groupname.columns The number of columns in which to place the members of the OptionGroup (optional, default 1). Used with plain and radio groups.
option.group.groupname.frame Whether the group should have a framed border (optional, default false).
option.group.groupname.title The title for a framed border of the group. Ignored if no frame is specified(optonal, default empty).
option.group.groupname.option The name of the Option for a RadioOptionGroup or a NestedOptionGroup.
option.group.groupname.numchoices The number of Buttons in a RadioOptionGroup.
option.group.groupname.choicen.label The label for the nth button of a RadioOptionGroup, where n is between 1 and numchoices.
option.group.groupname.numtabs The number of tabs in a TabbedOptionGroup.
option.group.groupname.tabn.group The name of the OptionGroup to put on the nth tab, where n is between 1 and numtabs.
option.group.groupname.tabn.title The title for the nth tab, where n is between 1 and numtabs.
option.group.groupname.class The fully qualified name of the class for the custom OptionGroup.


qflib 0.98.0