- java.lang.Object
-
- javafx.scene.control.TextFormatter<V>
-
- Тип параметров:
-
V- Тип значения
public class TextFormatter<V> extends Object
Форматировщик описывает формат текстовогоTextInputControl, используя два различных механизма:- Фильтр (
getFilter()), который может перехватывать и изменять ввод пользователя. Это помогает сохранить текст в нужном формате. Можно использовать поставщик текста по умолчанию для предоставления начального текста. - Преобразователь значений (
getValueConverter()) и значение (valueProperty()) могут быть использованы для предоставления специального формата, представляющего значение типаV. Если элемент управления редактируемый, и текст изменяется пользователем, значение обновляется для соответствия тексту.
Возможен форматировщик только с фильтром или преобразователем значений. Однако, если преобразователь значений не указан, установка значения приведёт к
IllegalStateExceptionи значение всегда будет равно null.Так как
Formatterсодержит значение, которое представляет состояниеTextInputControl, которому он в настоящее время назначен, один экземплярFormatterможет быть использован только в одномTextInputControlодновременно.- С момента:
- JavaFX 8u40
-
Сводка свойств
Свойства Тип Свойство Описание ObjectProperty<V>valueТекущее значение для данного форматировщика.
-
Сводка вложенных классов
Вложенные классы Модификатор и тип Класс Описание static classTextFormatter.ChangeСодержит состояние, представляющее изменение содержимого или выбора для TextInputControl.
-
Сводка полей
Поля Модификатор и тип Поле Описание static StringConverter<String>IDENTITY_STRING_CONVERTERЭтот преобразователь строк преобразует текст в то же значение строки.
-
Сводка по конструкторам
Конструкторы Конструктор Описание TextFormatter(UnaryOperator<TextFormatter.Change> filter)Создаёт новый форматировщик с заданным фильтром.TextFormatter(StringConverter<V> valueConverter)Создаёт новый форматировщик с заданным преобразователем значений.TextFormatter(StringConverter<V> valueConverter, V defaultValue)Создаёт новый форматировщик с заданным преобразователем значений и значением по умолчанию.TextFormatter(StringConverter<V> valueConverter, V defaultValue, UnaryOperator<TextFormatter.Change> filter)Создаёт новый форматировщик с заданным фильтром, преобразователем значений и значением по умолчанию.
-
Сводка методов
Все методыМетоды экземпляраКонкретные методы Модификатор и тип Метод Описание UnaryOperator<TextFormatter.Change>getFilter()Фильтр позволяет пользователю перехватывать и изменять любые изменения, внесённые в содержимое текста.VgetValue()Возвращает значение свойства value.StringConverter<V>getValueConverter()Преобразователь между значениями и текстом.voidsetValue(V value)Устанавливает значение свойства value.ObjectProperty<V>valueProperty()Текущее значение для данного форматировщика.
-
Подробности свойства
-
value
public final ObjectProperty<V> valueProperty
Текущее значение для этого форматера. Когда форматер настроен наTextInputControlи имеетvalueConverter, значение устанавливается элементом управления при подтверждении текста.- См. также:
-
getValue(),setValue(V)
-
-
Подробности поля
-
IDENTITY_STRING_CONVERTER
public static final StringConverter<String> IDENTITY_STRING_CONVERTER
Этот преобразователь строк преобразует текст в то же значение строки. Это может быть полезно в тех случаях, когда вы хотите манипулировать текстом через значение или вам нужно предоставить значение текста по умолчанию.
-
-
Подробности конструктора
-
TextFormatter
public TextFormatter(UnaryOperator<TextFormatter.Change> filter)
Создаёт новый форматер с указанным фильтром.- Параметры:
-
filter- Фильтр для использования в этом форматере или null
-
TextFormatter
public TextFormatter(StringConverter<V> valueConverter, V defaultValue, UnaryOperator<TextFormatter.Change> filter)
Создаёт новый форматер с указанным фильтром, преобразователем значений и значением по умолчанию.- Параметры:
-
valueConverter- Преобразователь значений для использования в этом форматере или null. -
defaultValue- значение по умолчанию. -
filter- Фильтр для использования в этом форматере или null
-
TextFormatter
public TextFormatter(StringConverter<V> valueConverter, V defaultValue)
Создаёт новый форматер с указанным преобразователем значений и значением по умолчанию.- Параметры:
-
valueConverter- Преобразователь значений для использования в этом форматере. Не должен быть null. -
defaultValue- значение по умолчанию
-
TextFormatter
public TextFormatter(StringConverter<V> valueConverter)
Создаёт новый форматер с указанным преобразователем значений. Значение по умолчанию будет null.- Параметры:
-
valueConverter- Преобразователь значений для использования в этом форматере. Не должен быть null.
-
-
Подробности метода
-
getValueConverter
public final StringConverter<V> getValueConverter()
Преобразователь между значениями и текстом. Он поддерживает «связь» междуTextInputControl.textProperty()} иvalueProperty()}. Значение обновляется, когда элемент управления теряет фокус или подтверждается (только для текстовых полей). Установка значения обновит текст элемента управления, используя предоставленный преобразователь. Если преобразование текста в значение невозможно, должно быть выброшено исключение.- Возвращает:
- StringConverter для значений или null, если не предоставлен
- См. также:
-
TextInputControl.commitValue(),TextInputControl.cancelEdit()
-
getFilter
public final UnaryOperator<TextFormatter.Change> getFilter()
Фильтр позволяет пользователю перехватывать и изменять любые изменения, внесённые в содержимое текста.Сам фильтр является
UnaryOperator, который принимаетTextFormatter.Changeобъект. Он должен возвращатьTextFormatter.Changeобъект, содержащий фактическое (отфильтрованное) изменение. Возвращение null отклоняет изменение.- Возвращает:
- фильтр для этого форматера или null, если его нет
-
valueProperty
public final ObjectProperty<V> valueProperty()
Текущее значение для этого форматера. Когда форматер настроен наTextInputControlи имеетvalueConverter, значение устанавливается элементом управления при подтверждении текста.- См. также:
-
getValue(),setValue(V)
-
setValue
public final void setValue(V value)
Устанавливает значение свойства value.- Описание свойства:
- Текущее значение для этого форматера. Когда форматер настроен на
TextInputControlи имеетvalueConverter, значение устанавливается элементом управления при подтверждении текста.
-
getValue
public final V getValue()
Возвращает значение свойства value.- Описание свойства:
- Текущее значение для этого форматера. Когда форматер настроен на
TextInputControlи имеетvalueConverter, значение устанавливается элементом управления при подтверждении текста.
-
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.