Класс TextFormatter<V>

java.lang.Object

fx.scene.control.TextFormatter<V>

Параметры типа:: V - Тип значения

public class TextFormatter<V> extends Object

Форматтер описывает формат TextInputControl текста, используя два разных механизма:

Фильтр (getFilter()), который может перехватывать и изменять пользовательский ввод. Это помогает поддерживать текст в желаемом формате. Для предоставления начального текста можно использовать поставщик текста по умолчанию.
Преобразователь значения (getValueConverter()) и значение (valueProperty()) могут использоваться для предоставления специального формата, представляющего значение типа V. Если элемент управления редактируется и текст изменяется пользователем, значение затем обновляется для соответствия тексту.

Возможен форматтер только с фильтром или только с преобразователем значения. Если преобразователь значения не указан, установка значения приведет к IllegalStateException и значение всегда будет null.

Так как Formatter содержит значение, представляющее состояние TextInputControl, которому он в настоящее время назначен, один экземпляр Formatter может использоваться только в одном TextInputControl одновременно.

С момента:: JavaFX 8u40

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`static final class`	`TextFormatter.Change`	Содержит состояние, представляющее изменение содержимого или выделения для TextInputControl.

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

Тип	Свойство	Описание
`final ObjectProperty<V>`	`value`	Текущее значение для этого форматтера.

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final StringConverter<String>`	`IDENTITY_STRING_CONVERTER`	Этот преобразователь строк преобразует текст в то же значение String.

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

Конструктор	Описание
`TextFormatter(UnaryOperator<TextFormatter.Change> filter)`	Создает новый Formatter с предоставленным фильтром.
`TextFormatter(StringConverter<V> valueConverter)`	Создает новый Formatter с предоставленным преобразователем значений.
`TextFormatter(StringConverter<V> valueConverter, V defaultValue)`	Создает новый Formatter с предоставленным преобразователем значений и значением по умолчанию.
`TextFormatter(StringConverter<V> valueConverter, V defaultValue, UnaryOperator<TextFormatter.Change> filter)`	Создает новый Formatter с предоставленным фильтром, преобразователем значений и значением по умолчанию.

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

Модификатор и тип	Метод	Описание
`final UnaryOperator<TextFormatter.Change>`	`getFilter()`	Фильтр позволяет пользователю перехватывать и изменять любые изменения, внесенные в содержимое текста.
`final V`	`getValue()`	Получает значение свойства `value`.
`final StringConverter<V>`	`getValueConverter()`	Преобразователь между значениями и текстом.
`final void`	`setValue(V value)`	Устанавливает значение свойства `value`.
`final ObjectProperty<V>`	`valueProperty()`	Текущее значение для этого форматтера.

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

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

Подробное описание свойств

значение

public final ObjectProperty<V> valueProperty

Текущее значение для этого форматировщика. Когда форматировщик установлен на TextInputControl и имеет valueConverter, значение устанавливается элементом управления при подтверждении текста.

См. также:

Подробное описание полей

IDENTITY_STRING_CONVERTER

public static final StringConverter<String> IDENTITY_STRING_CONVERTER

Этот преобразователь строк преобразует текст в то же значение String. Это может быть полезно в случаях, когда вы хотите манипулировать текстом через значение или вам нужно предоставить значение текста по умолчанию.

Подробное описание конструкторов

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(). Значение обновляется, когда элемент управления теряет фокус или подтверждается (только для TextField). Установка значения обновит текст элемента управления, используя предоставленный преобразователь. Если невозможно преобразовать текст в значение, должно быть выброшено исключение.

Возвращает:

StringConverter для значений или null, если он не предоставлен

См. также:

getFilter

public final UnaryOperator<TextFormatter.Change> getFilter()

Фильтр позволяет пользователю перехватывать и изменять любые изменения, вносимые в содержимое текста.

Сам фильтр является UnaryOperator, который принимает объект TextFormatter.Change. Он должен вернуть объект TextFormatter.Change, который содержит фактическое (отфильтрованное) изменение. Возврат null отклоняет изменение.

Возвращает:: фильтр для этого форматировщика или null, если его нет

valueProperty

public final ObjectProperty<V> valueProperty()

Возвращает:

свойство value

См. также:

setValue

public final void setValue(V value)

Устанавливает значение свойства value.

Описание свойства:

Параметры:

value - значение для свойства value

См. также:

getValue

public final V getValue()

Получает значение свойства value.

Описание свойства:

Возвращает:

значение свойства value

См. также:

© 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.