Accessors for class IlvToggle

Properties

alignment
bitmap
checkSize
indeterminate
indeterminateMode
label
position
radioType
state

Description

The IlvToggle class handles objects that have to display a state. This is achieved by drawing a rectangle or a diamond next to a label or an icon.
The object located to the left (or to the right) of the label (or the bitmap) of these buttons is called the state marker. It can be on (or off) according to the Boolean value of the state.
A toggle has two different modes, the usual mode, where it has two different states (set and not set) and indeterminate mode, where it can have three possible states (set, not set, and indeterminate). When a toggle is in indeterminate state it is grayed.

Type Name Description Notes

Direction alignment Gets or sets the alignment of the toggle.

Bitmap bitmap Gets or sets the bitmap displayed by this object. If there was a bitmap before, then it is unlocked.

UInt checkSize Gets or sets the size of the state marker, that is, the width or the height of the state marker's bounding box.

Boolean indeterminate Gets or sets the indeterminate state of a toggle.
If the toggle is not already in the indeterminate mode then this method does nothing.

A toggle with a radio button look must be used in an IlvSelector and therefore may not be in the indeterminate mode.

Boolean indeterminateMode Gets or sets a toggle's indeterminate mode (three possible states, set/not set/indeterminate).

String label Gets or sets the label displayed by this object.

Direction position Gets or sets the location of the label or the bitmap relative to the state marker. This value can be either IlvRight or IlvLeft.

Boolean radioType Gets or sets the radio mode of a toggle. If radioType is set to true then this toggle button displays its state with a radio button look. If radioType is set to false, the state of the marker is displayed like a check box.

Boolean state Gets or sets the toggle's state.