Класс FloatControl

public abstract class FloatControl
extends Control

Объект типа FloatControl предоставляет управление диапазоном значений с плавающей запятой. Управление плавающей точкой часто представлено в графических пользовательских интерфейсах непрерывно настраиваемыми объектами, такими как ползунки или вращающиеся регуляторы. Конкретные подклассы FloatControl реализуют управления, такие как усиление и панорамирование, которые каким-либо образом влияют на аудиосигнал линии, что может быть изменено приложением. Внутренний класс FloatControl.Type предоставляет статические экземпляры типов, которые используются для идентификации некоторых распространенных типов управления плавающей точкой.

Абстрактный класс FloatControl предоставляет методы для установки и получения текущего значения управления с плавающей запятой. Другие методы получают возможный диапазон значений и разрешение управления (наименьший приращение между возвращаемыми значениями). Некоторые управления плавающей точкой позволяют плавное изменение значения в течение заданного периода времени. FloatControl также включает методы, которые возвращают строковые метки для минимального, максимального и среднего значений управления.

Since:
1.3
См. также:
Line.getControls(), Line.isControlSupported(javax.sound.sampled.Control.Type)

Вложенные классы

Модификатор и тип Класс Описание
static class  FloatControl.Type

Экземпляр внутреннего класса FloatControl.Type идентифицирует один вид управления плавающей точкой.

Краткое описание конструкторов

Модификатор Конструктор Описание
protected FloatControl​(FloatControl.Type type, float minimum, float maximum, float precision, int updatePeriod, float initialValue, String units)

Создает новый объект управления плавающей точкой с заданными параметрами.
protected FloatControl​(FloatControl.Type type, float minimum, float maximum, float precision, int updatePeriod, float initialValue, String units, String minLabel, String midLabel, String maxLabel)

Создает новый объект управления плавающей точкой с заданными параметрами.

Краткое описание методов

Модификатор и тип Метод Описание
float getMaximum()

Получает максимальное разрешенное значение.
String getMaxLabel()

Получает метку максимального значения, например, "Вправо" или "Полный".
String getMidLabel()

Получает метку для значения середины, например, "Центр" или "По умолчанию".
float getMinimum()

Получает минимальное разрешенное значение.
String getMinLabel()

Получает метку минимального значения, например, "Слева" или "Выключено".
float getPrecision()

Получает разрешение или зернистость управления в единицах, в которых измеряется управление.
String getUnits()

Получает метку единиц, в которых выражены значения управления, такие как "дБ" или "кадры в секунду".
int getUpdatePeriod()

Получает наименьший интервал времени в микросекундах, в течение которого значение управления может измениться во время сдвига.
float getValue()

Получает текущее значение этого управления.
void setValue​(float newValue)

Устанавливает текущее значение для управления.
void shift​(float from, float to, int microseconds)

Изменяет значение управления от начального до конечного значения линейно в течение указанного периода времени, указанного в микросекундах.
String toString()

Предоставляет строковое представление управления.

Методы, объявленные в классе javax.sound.sampled.Control

getType

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Конструкторы

FloatControl

protected FloatControl(FloatControl.Type type,
                       float minimum,
                       float maximum,
                       float precision,
                       int updatePeriod,
                       float initialValue,
                       String units,
                       String minLabel,
                       String midLabel,
                       String maxLabel)

Создаёт новый объект управления плавающей точкой с заданными параметрами.

Параметры:
type - тип управления, представляемый этим объектом управления плавающей точкой
minimum - наименьшее допустимое значение для управления
maximum - наибольшее допустимое значение для управления
precision - разрешение или гранулярность управления. Это размер приращения между дискретными допустимыми значениями.
updatePeriod - минимальный интервал времени в микросекундах, за который управление может измениться с одного дискретного значения на другое во время shift
initialValue - значение, с которым управление начинается при создании
units - метка единиц, в которых выражаются значения управления, например, "дБ" или "кадров в секунду"
minLabel - метка минимального значения, например, "Левый" или "Выключено"
midLabel - метка среднего значения, например, "Центр" или "По умолчанию"
maxLabel - метка максимального значения, например, "Правый" или "Полный"
Исключения:
IllegalArgumentException - если minimum больше, чем maximum или initialValue не попадает в допустимый диапазон

FloatControl

protected FloatControl(FloatControl.Type type,
                       float minimum,
                       float maximum,
                       float precision,
                       int updatePeriod,
                       float initialValue,
                       String units)

Создаёт новый объект управления плавающей точкой с заданными параметрами. Метки для минимального, максимального и среднего значений устанавливаются в строки нулевой длины.

Параметры:
type - тип управления, представляемый этим объектом управления плавающей точкой
minimum - наименьшее допустимое значение для управления
maximum - наибольшее допустимое значение для управления
precision - разрешение или гранулярность управления. Это размер приращения между дискретными допустимыми значениями.
updatePeriod - минимальный интервал времени в микросекундах, за который управление может измениться с одного дискретного значения на другое во время shift
initialValue - значение, с которым управление начинается при создании
units - метка единиц, в которых выражаются значения управления, например, "дБ" или "кадров в секунду"
Исключения:
IllegalArgumentException - если minimum больше, чем maximum или initialValue не попадает в допустимый диапазон

Методы

setValue

public void setValue(float newValue)

Устанавливает текущее значение для управления. Реализация по умолчанию просто устанавливает указанное значение. Если указанное значение больше максимального или меньше минимального, выбрасывается IllegalArgumentException. Некоторые управления требуют, чтобы их линия была открыта, прежде чем они могут быть затронуты установкой значения.

Параметры:
newValue - желаемое новое значение
Исключения:
IllegalArgumentException - если указанное значение не попадает в допустимый диапазон

getValue

public float getValue()

Получает текущее значение этого управления.

Возвращает:
текущее значение

getMaximum

public float getMaximum()

Получает максимальное допустимое значение.

Возвращает:
максимальное допустимое значение

getMinimum

public float getMinimum()

Получает минимальное допустимое значение.

Возвращает:
минимальное допустимое значение

getUnits

public String getUnits()

Получает метку единиц, в которых выражаются значения управления, например, "дБ" или "кадров в секунду".

Возвращает:
метка единиц или строка нулевой длины, если метка отсутствует

getMinLabel

public String getMinLabel()

Получает метку минимального значения, например, "Левый" или "Выключено".

Возвращает:
метка минимального значения или строка нулевой длины, если метка не была установлена

getMidLabel

public String getMidLabel()

Получает метку среднего значения, например, "Центр" или "По умолчанию".

Возвращает:
метка среднего значения или строка нулевой длины, если метка не была установлена

getMaxLabel

public String getMaxLabel()

Получает метку максимального значения, например, "Правый" или "Полный".

Возвращает:
метка максимального значения или строка нулевой длины, если метка не была установлена

getPrecision

public float getPrecision()

Получает разрешение или гранулярность управления в единицах, которые измеряет управление. Точность — это размер приращения между дискретными допустимыми значениями для данного управления над набором поддерживаемых значений с плавающей точкой.

Возвращает:
точность управления

getUpdatePeriod

public int getUpdatePeriod()

Получает минимальный интервал времени в микросекундах, за который значение управления может измениться во время сдвига. Период обновления — это обратное значение частоты, с которой управление обновляет своё значение во время сдвига. Если реализация не поддерживает сдвиг значения во времени, она должна установить значение управления в конечное значение немедленно и вернуть -1 из этого метода.

Возвращает:
период обновления в микросекундах или -1, если сдвиг во времени не поддерживается
См. также:
shift(float, float, int)

shift

public void shift(float from,
                  float to,
                  int microseconds)

Линейно изменяет значение управления от начального до конечного значения за указанный период времени в микросекундах. Этот метод возвращается без блокировки; он не ожидает завершения сдвига. Реализация должна завершить операцию в указанное время. Реализация по умолчанию просто немедленно изменяет значение на конечное значение.

Параметры:
from - начальное значение в начале сдвига
to - конечное значение после сдвига
microseconds - максимальная продолжительность сдвига в микросекундах
Исключения:
IllegalArgumentException - если значение from или to не попадает в допустимый диапазон
См. также:
getUpdatePeriod()

toString

public String toString()

Предоставляет строковое представление управления.

Переопределяет:
toString в классе Control
Возвращает:
описание в виде строки

© 1993, 2020, 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/11/docs/api/java.desktop/javax/sound/sampled/FloatControl.html

Spec-Zone .ru
спецификации, руководства, описания, API