Интерфейс PropertyEditor

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

public interface PropertyEditor

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

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

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

Каждый PropertyEditor должен поддерживать один или несколько из трех простых стилей отображения. Таким образом, он может либо (1) поддерживать isPaintable, либо (2) возвращать непустой массив String[] из getTags() и возвращать непустое значение из getAsText, либо (3) просто возвращать непустую строку из 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, 2021, 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/17/docs/api/java.desktop/java/beans/PropertyEditor.html