javax.sound.sampled: abstract public class: BooleanControl

javax.sound.sampled
abstract public class: BooleanControl [javadoc | source]

java.lang.Object
   javax.sound.sampled.Control
      javax.sound.sampled.BooleanControl

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.

author: Kara - Kytle

since: 1.3 -

Nested Class Summary:
public static class	BooleanControl.Type	An instance of the `BooleanControl.Type` class identifies one kind of boolean control. Static instances are provided for the common types.

Constructor:

Constructor:
protected BooleanControl(Type type, boolean initialValue) { this(type, initialValue, "true", "false"); } 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) { super(type); this.value = initialValue; this.trueStateLabel = trueStateLabel; this.falseStateLabel = falseStateLabel; } 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."

 protected BooleanControl(Type type,
    boolean initialValue) {
        this(type, initialValue, "true", "false");
}

true

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) {
        super(type);
        this.value = initialValue;
        this.trueStateLabel = trueStateLabel;
        this.falseStateLabel = falseStateLabel;
}

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."

Method from javax.sound.sampled.BooleanControl Summary:
getStateLabel, getValue, setValue, toString

Methods from javax.sound.sampled.Control:
getType, toString

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.sound.sampled.BooleanControl Detail:
public String getStateLabel(boolean state) { return ((state == true) ? trueStateLabel : falseStateLabel); } Obtains the label for the specified state.
public boolean getValue() { return value; } Obtains this control's current value.
public void setValue(boolean value) { this.value = value; } Sets the current value for the control. The default implementation simply sets the value as indicated. Some controls require that their line be open before they can be affected by setting a value.
public String toString() { return new String(super.toString() + " with current value: " + getStateLabel(getValue())); } Provides a string representation of the control

Method from javax.sound.sampled.BooleanControl Detail:

 public String getStateLabel(boolean state) {
        return ((state == true) ? trueStateLabel : falseStateLabel);
}

Obtains the label for the specified state.

 public boolean getValue() {
        return value;
}

Obtains this control's current value.

 public  void setValue(boolean value) {
        this.value = value;
}

Sets the current value for the control. The default implementation simply sets the value as indicated. Some controls require that their line be open before they can be affected by setting a value.

 public String toString() {
        return new String(super.toString() + " with current value: " + getStateLabel(getValue()));
}

Provides a string representation of the control