javax.sound.sampled
Class BooleanControl
- java.lang.Object
-
- javax.sound.sampled.Control
-
- javax.sound.sampled.BooleanControl
-
public abstract class BooleanControl extends Control
ABooleanControlprovides the ability to switch between two possible settings that affect a line's audio. The settings are boolean values (trueandfalse). 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 aMUTEAs with other
Control- Since:
- 1.3
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static classBooleanControl.TypeAn instance of theBooleanControl.Typeclass identifies one kind of boolean control.
-
Constructor Summary
Constructors Modifier Constructor and Description protectedBooleanControl(BooleanControl.Type type, boolean initialValue)Constructs a new boolean control object with the given parameters.protectedBooleanControl(BooleanControl.Type type, boolean initialValue, String trueStateLabel, String falseStateLabel)Constructs a new boolean control object with the given parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description StringgetStateLabel(boolean state)Obtains the label for the specified state.booleangetValue()Obtains this control's current value.voidsetValue(boolean value)Sets the current value for the control.StringtoString()Provides a string representation of the control
-
-
-
Constructor Detail
BooleanControl
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 bytrue, such as "true" or "on." -
falseStateLabel- the label for the state represented byfalse, such as "false" or "off."
BooleanControl
protected BooleanControl(BooleanControl.Type type, boolean initialValue)
Constructs a new boolean control object with the given parameters. The labels for thetrueandfalsestates default to "true" and "false."- Parameters:
-
type- the type of control represented by this float control object -
initialValue- the initial control value
-
Method Detail
setValue
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.
getValue
public boolean getValue()
Obtains this control's current value.- Returns:
- current value.
getStateLabel
public String getStateLabel(boolean state)
Obtains the label for the specified state.- Parameters:
-
state- the state whose label will be returned - Returns:
-
the label for the specified state, such as "true" or "on" for
true, or "false" or "off" forfalse.
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
