public abstract class FloatControl extends Control
FloatControl object provides control over a range of floating-point values. Float controls are often represented in graphical user interfaces by continuously adjustable objects such as sliders or rotary knobs. Concrete subclasses of FloatControl implement controls, such as gain and pan, that affect a line's audio signal in some way that an application can manipulate. The FloatControl.Type inner class provides static instances of types that are used to identify some common kinds of float control. The FloatControl abstract class provides methods to set and get the control's current floating-point value. Other methods obtain the possible range of values and the control's resolution (the smallest increment between returned values). Some float controls allow ramping to a new value over a specified period of time. FloatControl also includes methods that return string labels for the minimum, maximum, and midpoint positions of the control.
| Modifier and Type | Class | Description |
|---|---|---|
static class |
FloatControl.Type |
An instance of the FloatControl.Type inner class identifies one kind of float control. |
| Modifier | Constructor | Description |
|---|---|---|
protected |
Constructs a new float control object with the given parameters. |
|
protected |
Constructs a new float control object with the given parameters. |
| Modifier and Type | Method | Description |
|---|---|---|
float |
getMaximum() |
Obtains the maximum value permitted. |
String |
getMaxLabel() |
Obtains the label for the maximum value, such as "Right" or "Full". |
String |
getMidLabel() |
Obtains the label for the mid-point value, such as "Center" or "Default". |
float |
getMinimum() |
Obtains the minimum value permitted. |
String |
getMinLabel() |
Obtains the label for the minimum value, such as "Left" or "Off". |
float |
getPrecision() |
Obtains the resolution or granularity of the control, in the units that the control measures. |
String |
getUnits() |
Obtains the label for the units in which the control's values are expressed, such as "dB" or "frames per second." |
int |
getUpdatePeriod() |
Obtains the smallest time interval, in microseconds, over which the control's value can change during a shift. |
float |
getValue() |
Obtains this control's current value. |
void |
setValue |
Sets the current value for the control. |
void |
shift |
Changes the control value from the initial value to the final value linearly over the specified time period, specified in microseconds. |
String |
toString() |
Returns a string representation of the float control. |
protected FloatControl(FloatControl.Type type, float minimum, float maximum, float precision, int updatePeriod, float initialValue, String units, String minLabel, String midLabel, String maxLabel)
type - the kind of control represented by this float control objectminimum - the smallest value permitted for the controlmaximum - the largest value permitted for the controlprecision - the resolution or granularity of the control. This is the size of the increment between discrete valid values.updatePeriod - the smallest time interval, in microseconds, over which the control can change from one discrete value to the next during a shift
initialValue - the value that the control starts with when constructedunits - the label for the units in which the control's values are expressed, such as "dB" or "frames per second"minLabel - the label for the minimum value, such as "Left" or "Off"midLabel - the label for the midpoint value, such as "Center" or "Default"maxLabel - the label for the maximum value, such as "Right" or "Full"IllegalArgumentException - if minimum is greater than maximum or initialValue does not fall within the allowable rangeprotected FloatControl(FloatControl.Type type, float minimum, float maximum, float precision, int updatePeriod, float initialValue, String units)
type - the kind of control represented by this float control objectminimum - the smallest value permitted for the controlmaximum - the largest value permitted for the controlprecision - the resolution or granularity of the control. This is the size of the increment between discrete valid values.updatePeriod - the smallest time interval, in microseconds, over which the control can change from one discrete value to the next during a shift
initialValue - the value that the control starts with when constructedunits - the label for the units in which the control's values are expressed, such as "dB" or "frames per second"IllegalArgumentException - if minimum is greater than maximum or initialValue does not fall within the allowable rangepublic void setValue(float newValue)
IllegalArgumentException is thrown. Some controls require that their line be open before they can be affected by setting a value.newValue - desired new valueIllegalArgumentException - if the value indicated does not fall within the allowable rangepublic float getValue()
public float getMaximum()
public float getMinimum()
public String getUnits()
public String getMinLabel()
public String getMidLabel()
public String getMaxLabel()
public float getPrecision()
public int getUpdatePeriod()
public void shift(float from, float to, int microseconds)
from - initial value at the beginning of the shiftto - final value after the shiftmicroseconds - maximum duration of the shift in microsecondsIllegalArgumentException - if either from or to value does not fall within the allowable rangepublic String toString()
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/sound/sampled/FloatControl.html