Класс PropertyEditorSupport

java.lang.Object

java.beans.PropertyEditorSupport

Все реализованные интерфейсы:: PropertyEditor

public class PropertyEditorSupport extends Object implements PropertyEditor

Это вспомогательный класс для построения редакторов свойств.

Его можно использовать как базовый класс, так и как делегат.

С тех пор:: 1.1

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

Конструктор	Описание
`PropertyEditorSupport()`	Создаёт объект `PropertyEditorSupport`.
`PropertyEditorSupport(Object source)`	Создаёт объект `PropertyEditorSupport`.

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

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

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

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

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

PropertyEditorSupport

public PropertyEditorSupport()

Создаёт объект PropertyEditorSupport.

С момента:: 1.5

PropertyEditorSupport

public PropertyEditorSupport(Object source)

Создаёт объект PropertyEditorSupport.

Параметры:: source - источник, используемый для срабатывания событий
С момента:: 1.5

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

getSource

public Object getSource()

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

Возвращает:: объект-источник или этот экземпляр
С момента:: 1.5

setSource

public void setSource(Object source)

Устанавливает компонент-источник.

Компонент-источник используется в качестве источника событий для изменений свойств. Этот источник должен использоваться только для получения информации и не должен изменяться редактором свойств.

Параметры:: source - объект-источник, используемый для событий
С момента:: 1.5

setValue

public void setValue(Object value)

Устанавливает (или изменяет) объект, который необходимо редактировать.

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

getValue

public Object getValue()

Возвращает значение свойства.

Определено в:: getValue в интерфейсе PropertyEditor
Возвращает:: Значение свойства.

isPaintable

public boolean isPaintable()

Определяет, будет ли класс обрабатывать метод paintValue.

Определено в:: isPaintable в интерфейсе PropertyEditor
Возвращает:: True, если класс будет обрабатывать метод paintValue.

paintValue

public void paintValue(Graphics gfx, Rectangle box)

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

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

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

getJavaInitializationString

public String getJavaInitializationString()

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

Примеры результатов: "2", "new Color(127,127,34)", "Color.orange" и т.д.

Определено в:: getJavaInitializationString в интерфейсе PropertyEditor
Возвращает:: Фрагмент Java-кода, представляющий инициализатор текущего значения.

getAsText

public String getAsText()

Возвращает значение свойства в виде строки, подходящей для редактирования человеком.

Определено в:

getAsText в интерфейсе PropertyEditor

Возвращает:

Значение свойства в виде строки, подходящей для редактирования человеком.

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

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

setAsText

public void setAsText(String text) throws IllegalArgumentException

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

Определено в:: setAsText в интерфейсе PropertyEditor
Параметры:: text - строка для анализа.
Исключения:: IllegalArgumentException

getTags

public String[] getTags()

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

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

getCustomEditor

public Component getCustomEditor()

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

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

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

supportsCustomEditor

public boolean supportsCustomEditor()

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

Определено в:: supportsCustomEditor в интерфейсе PropertyEditor
Возвращает:: True, если редактор свойств может предоставить пользовательский редактор.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

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

Один и тот же объект слушателя может быть добавлен более одного раза, и будет вызываться столько раз, сколько он добавлен. Если listener является null, исключение не генерируется и никаких действий не выполняется.

Определено в:: addPropertyChangeListener в интерфейсе PropertyEditor
Параметры:: listener - слушатель PropertyChangeListener для добавления

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

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

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

Определено в:: removePropertyChangeListener в интерфейсе PropertyEditor
Параметры:: listener - слушатель PropertyChangeListener для удаления

firePropertyChange

public void firePropertyChange()

Сообщает всем заинтересованным слушателям о модификации.

© 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/PropertyEditorSupport.html