The Toggle Widget

View Class: Toggle
Spec Class: ToggleSpec

The Toggle Widget is used to provide changing of a boolean state that is either on (true) or off (false). It also serves as indicator for boolean values.

The Basics Section:

ID	Unique symbolic name (ID) of the toggle. This ID can be used by the application to access the widget via `"builder>>componentAt:#ID"`.
Label	Label of the toggle. If the check box Label Is Image is turned off, this is the label string. Otherwise, it is the name of the selector, which returns the label - either a string or a bitmap from the application.
Model	Aspect selector or binding for the state (on/off) of the toggle. It should return a `ValueModel`* instance with a `Boolean` instance**.
Be Default	Turns on/off displaying of a return key after the label string.
Size As Default	Turns on/off that the toggle computes its size including space for the default (return) image. Useful for toggles which are initially not default toggles, but become a default toggle dynamically.
Label Is Image	Turns on/off that the name of the label is taken as selector. The selector should return a string or bitmap image used as logo in the toggle.
Translate Label	Turns on/off that the label string is translated via the resource mechanism to a national language string. A translation for that string must be define in the resource file of the application class.

The Details Section:

Font	Defines the font style of the toggle's label. After selecting the check toggle the font style can be chosen by selecting one of the Family/Face/Style/Size buttons. If no font style is selected, the toggle takes its default font style from the style sheet.
FG-Color	Defines the foreground color of the toggle, i.e. the color of the letters. After selecting the check toggle the foreground color can be chosen by selecting the desired colored button. If no color is selected, the toggle takes its default foreground color from the style sheet.
BG-Color	Defines the background color of the toggle, i.e. the color of the toggle's view. After selecting the check toggle the background color can be chosen by selecting the desired colored button. If no color is selected, the toggle takes its default background color from the style sheet.
Show Lamp	Turns on/off that a colored lamp is shown.
Lamp Color	Defines the color of the lamp. After selecting the check toggle the lamp color can be chosen by selecting the desired colored button. If no color is selected, the toggle takes its default lamp color from the style sheet.
Initially Disabled	Turns on/off that the toggle is initially disabled.
Initially Invisible	Turns on/off that the toggle is initially invisible.
Can Tab	Turns on/off that the toggle can be reached by tabbing.

The Channels Section:

Enable	Aspect selector or binding for en-/disabling the toggle. It should return a - `Boolean` instance** (only for static behavior) - `ValueModel`* instance with a `Boolean` instance** A value model is used to provide a dynamically changing of the ability of the toggle.
Label	Aspect selector or binding for the label of the toggle. It should return a `ValueModel`* instance with a `String` instance. It is used to provide a dynamically changing of the label.
FG-Color	Aspect selector or binding for the foreground color of the toggle. It should return a - `Color` instance (only for static behavior) - `ValueModel`* instance with a `Color` instance. A value model is used to provide a dynamically changing of the foreground color.
BG-Color	Aspect selector or binding for the background color of the toggle. It should return a - `Color` instance (only for static behavior) - `ValueModel`* instance with a `Color` instance. A value model is used to provide a dynamically changing of the background color.

* = ValueHolder, AspectAdaptor, BufferedValueHolder, RangeAdaptor, TriggerValue
** = true, false

Selected

Name of the selector sent to the application when the toggle was pressed.

The Help Section:

see document "Using the Help Tool"

The Layout Section:

see document "The Layout of the Widgets"