Класс 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

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

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

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

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

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

Модификатор и тип	Поле	Описание
`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, значение устанавливается элементом управления при подтверждении текста.

См. также:

getValue()
setValue(V)
valueProperty()

Подробности поля

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

См. также:

getValue()
setValue(V)

setValue

public final void setValue(V value)

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

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

Параметры:

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

См. также:

getValue()
valueProperty()

getValue

public final V getValue()

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

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

Возвращает:

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

См. также:

setValue(V)
valueProperty()

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