Интерфейс PropertyEditor

Все известные реализующие классы:: PropertyEditorSupport

public interface PropertyEditor

Класс PropertyEditor предоставляет поддержку для графических интерфейсов, которые хотят позволить пользователям редактировать значение свойства заданного типа.

PropertyEditor поддерживает различные способы отображения и обновления значений свойств. Большинству PropertyEditor'ов потребуется поддержка только подмножества различных вариантов, доступных в этом API.

Простые PropertyEditor'ы могут поддерживать только методы getAsText и setAsText и не должны поддерживать (скажем) paintValue или getCustomEditor. Более сложные типы могут не поддерживать getAsText и setAsText, но вместо этого будут поддерживать paintValue и getCustomEditor.

Каждый PropertyEditor должен поддерживать один или несколько из трех простых стилей отображения. Таким образом, он может либо (1) поддерживать isPaintable, либо (2) возвращать не null массив String[] из getTags() и возвращать не null значение из getAsText, либо (3) просто возвращать не null String из getAsText().

Каждый редактор свойств должен поддерживать вызов setValue, когда аргумент объекта является типом, для которого этот редактор свойств соответствует. Кроме того, каждый редактор свойств должен либо поддерживать пользовательский редактор, либо поддерживать setAsText.

Каждый PropertyEditor должен иметь конструктор по умолчанию.

С момента:: 1.1

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

Модификатор и тип	Метод	Описание
`void`	`addPropertyChangeListener(PropertyChangeListener listener)`	Добавляет слушателя для изменения значения.
`String`	`getAsText()`	Получает значение свойства в виде текста.
`Component`	`getCustomEditor()`	PropertyEditor может выбрать предоставление полного пользовательского компонента, который редактирует его значение свойства.
`String`	`getJavaInitializationString()`	Возвращает фрагмент кода Java, который может быть использован для установки свойства, соответствующего текущему состоянию редактора.
`String[]`	`getTags()`	Если значение свойства должно быть одним из набора известных значений тегов, то этот метод должен вернуть массив тегов.
`Object`	`getValue()`	Получает значение свойства.
`boolean`	`isPaintable()`	Определяет, может ли быть нарисован этот редактор свойств.
`void`	`paintValue(Graphics gfx, Rectangle box)`	Рисует представление значения в заданной области экрана.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)`	Удаляет слушателя для изменения значения.
`void`	`setAsText(String text)`	Устанавливает значение свойства, анализируя заданную строку.
`void`	`setValue(Object value)`	Устанавливает (или изменяет) объект, который должен быть отредактирован.
`boolean`	`supportsCustomEditor()`	Определяет, поддерживает ли этот редактор свойств пользовательский редактор.

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

setValue

void setValue(Object value)

Устанавливает (или изменяет) объект, который должен быть отредактирован. Примитивные типы, такие как "int", должны быть обернуты как соответствующий тип объекта, например, "java.lang.Integer".

Параметры:: value - Новый целевой объект для редактирования. Обратите внимание, что этот объект не должен изменяться PropertyEditor, а PropertyEditor должен создать новый объект для хранения любого измененного значения.

getValue

Object getValue()

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

Возвращает:: Значение свойства. Примитивные типы, такие как "int", будут обернуты как соответствующий тип объекта, например, "java.lang.Integer".

isPaintable

boolean isPaintable()

Определяет, является ли этот редактор свойств отображаемым.

Возвращает:: True, если класс будет соблюдать метод paintValue.

paintValue

void paintValue(Graphics gfx, Rectangle box)

Отображает представление значения в заданной области экрана. Обратите внимание, что PropertyEditor отвечает за выполнение собственного обрезания, чтобы он поместился в заданный прямоугольник.

Если PropertyEditor не обрабатывает запросы на отображение (см. isPaintable), этот метод должен быть бездействующим.

Указанный объект Graphics будет иметь шрифт, цвет и т. д. по умолчанию для родительского контейнера. PropertyEditor может изменять атрибуты графики, такие как шрифт и цвет, и не должен восстанавливать старые значения.

Параметры:: gfx - Объект Graphics для рисования.; box - Прямоугольник в объекте Graphics, в котором мы должны рисовать.

getJavaInitializationString

String getJavaInitializationString()

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

Фрагмент кода должен быть контекстно-независимым и должен быть законным выражением Java, как указано в JLS.

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

Следует проявлять осторожность при оценке выражения, поскольку оно может вызвать исключения. В частности, генераторы кода должны гарантировать, что сгенерированный код будет компилироваться в присутствии выражения, которое может вызывать проверенные исключения.

Примеры результатов:

Выражение примитивного типа: 2
Конструктор класса: new java.awt.Color(127,127,34)
Статическое поле: java.awt.Color.orange
Статический метод: javax.swing.Box.createRigidArea(new java.awt.Dimension(0, 5))

Возвращает:: фрагмент кода Java, представляющий инициализатор текущего значения. Он не должен содержать точки с запятой (';') для завершения выражения.

getAsText

String getAsText()

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

Возвращает:

Значение свойства в виде редактируемой строке.

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

Если возвращается ненулевое значение, то PropertyEditor должен быть готов разобрать эту строку обратно в setAsText().

setAsText

void setAsText(String text) throws IllegalArgumentException

Устанавливает значение свойства путем разбора заданной строки. Может вызвать java.lang.IllegalArgumentException, если строка имеет неправильный формат или если этот тип свойства нельзя выразить в виде текста.

Параметры:: text - Строка для разбора.
Выбрасывает:: IllegalArgumentException

getTags

String[] getTags()

Если значение свойства должно быть одним из набора известных значений тегов, то этот метод должен возвращать массив тегов. Это можно использовать для представления (например) значений перечислений. Если PropertyEditor поддерживает теги, то он должен поддерживать использование setAsText со значением тега в качестве способа установки значения и использование getAsText для идентификации текущего значения.

Возвращает:: Значения тегов для этого свойства. Может быть null, если это свойство не может быть представлено как значение тега.

getCustomEditor

Component getCustomEditor()

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

Код более высокого уровня, который вызывает getCustomEditor, может либо встроить компонент в более крупный лист свойств, либо разместить его в собственном отдельном диалоговом окне, или ...

Возвращает:: Объект java.awt.Component, который позволит пользователю непосредственно изменить текущее значение свойства. Может быть null, если это не поддерживается.

supportsCustomEditor

boolean supportsCustomEditor()

Определяет, поддерживает ли этот редактор свойств пользовательский редактор.

Возвращает:: True, если propertyEditor может предоставить пользовательский редактор.

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

Добавляет слушателя изменений значения. Когда редактор свойств изменяет свое значение, он должен отправлять PropertyChangeEvent всем зарегистрированным PropertyChangeListener, указывая значение null для имени свойства и себя в качестве источника.

Параметры:: listener - PropertyChangeListener для добавления

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

Удаляет слушателя изменений значения.

Параметры:: listener - PropertyChangeListener для удаления

© 1993, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.desktop/java/beans/PropertyEditor.html