public abstract class

BooleanControl

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

Class Overview

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.

Summary

Nested Classes
class BooleanControl.Type An instance of the BooleanControl.Type class identifies one kind of boolean control. 
Protected Constructors
BooleanControl(BooleanControl.Type type, boolean initialValue, String trueStateLabel, String falseStateLabel)
Constructs a new boolean control object with the given parameters.
BooleanControl(BooleanControl.Type type, boolean initialValue)
Constructs a new boolean control object with the given parameters.
Public Methods
String getStateLabel(boolean state)
Obtains the label for the specified state.
boolean getValue()
Obtains this control's current value.
void setValue(boolean value)
Sets the current value for the control.
String toString()
Provides a string representation of the control
[Expand]
Inherited Methods
From class javax.sound.sampled.Control
From class java.lang.Object

Protected Constructors

protected BooleanControl (BooleanControl.Type type, boolean initialValue, String trueStateLabel, String 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 (BooleanControl.Type type, boolean initialValue)

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

Public Methods

public String getStateLabel (boolean 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 boolean getValue ()

Obtains this control's current value.

Returns
  • current value.

public void setValue (boolean 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.

Parameters
value desired new value.

public String toString ()

Provides a string representation of the control

Returns
  • a string description