BooleanControl JDK 1.6)

Description

publicabstract abstract class BooleanControl

A BooleanControl provides the ability to switch between two possible settings that affect a line's audio.

A BooleanControl provides the ability to switch between two possible settings that affect a line's audio. The settings are boolean values (true and false). A graphical user interface might represent the control by a two-state button, an on/off switch, two mutually exclusive buttons, or a checkbox (among other possibilities). For example, depressing a button might activate a MUTE control to silence the line's audio.

As with other Control subclasses, a method is provided that returns string labels for the values, suitable for display in the user interface.

See also:

Constructors

protected BooleanControl (Type type, boolean initialValue)

Constructs a new boolean control object with the given parameters.

Constructs a new boolean control object with the given parameters.
The labels for the true and false states
default to "true" and "false."
Parameters:
- type - the type of control represented by this float control object
- initialValue - the initial control value

protected BooleanControl (Type type, boolean initialValue, String trueStateLabel, String falseStateLabel)

Constructs a new boolean control object with the given parameters.

Constructs a new boolean control object with the given parameters.
Parameters:
- type - the type of control represented this float control object
- initialValue - the initial control value
- trueStateLabel - the label for the state represented by true, such as "true" or "on."
- falseStateLabel - the label for the state represented by false, such as "false" or "off."

Methods

Hide/Show inherited methods

public String getStateLabel (boolean state)

Obtains the label for the specified state.

Obtains the label for the specified state.
Returns: the label for the specified state, such as "true" or "on" for true, or "false" or "off" for false.

public Type getType () [Inherited From Control]

Obtains the control's type.

public boolean getValue ()

Obtains this control's current value.

public void setValue (boolean value)

Sets the current value for the control.

public String toString () [Overrides Control]

Provides a string representation of the control

Nested Classes

BooleanControl.Type

An instance of the BooleanControl.Type class identifies one kind of boolean control.

Control.Type

An instance of the Type class represents the type of the control.