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

Since:: 1.5

PropertyEditorSupport

public PropertyEditorSupport(Object source)

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

Parameters:: source - источник, используемый для генерации событий
Since:: 1.5

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

getSource

public Object getSource()

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

Returns:: объект-источник или текущий экземпляр
Since:: 1.5

setSource

public void setSource(Object source)

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

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

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

setValue

public void setValue(Object value)

Устанавливает (или изменяет) объект, подлежащий редактированию.

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

getValue

public Object getValue()

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

Specified by:: getValue в интерфейсе PropertyEditor
Returns:: Значение свойства.

isPaintable

public boolean isPaintable()

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

Specified by:: isPaintable в интерфейсе PropertyEditor
Returns:: True, если класс будет учитывать метод paintValue.

paintValue

public void paintValue(Graphics gfx, Rectangle box)

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

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

Specified by:: paintValue в интерфейсе PropertyEditor
Parameters:: gfx - Объект Graphics для отрисовки.; box - Прямоугольник в объекте Graphics, в который необходимо нарисовать значение.

getJavaInitializationString

public String getJavaInitializationString()

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

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

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

getAsText

public String getAsText()

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

Specified by:

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

Returns:

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

Возвращает null, если значение не может быть выражено как строка.

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

setAsText

public void setAsText(String text) throws IllegalArgumentException

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

Specified by:: setAsText в интерфейсе PropertyEditor
Parameters:: text - Строка, подлежащая разбору.
Throws:: IllegalArgumentException

getTags

public String[] getTags()

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

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

getCustomEditor

public Component getCustomEditor()

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

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

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

supportsCustomEditor

public boolean supportsCustomEditor()

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

Specified by:: supportsCustomEditor в интерфейсе PropertyEditor
Returns:: True, если propertyEditor может предоставить пользовательский редактор.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

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

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

Specified by:: addPropertyChangeListener в интерфейсе PropertyEditor
Parameters:: listener - PropertyChangeListener для добавления

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

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

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

Specified by:: removePropertyChangeListener в интерфейсе PropertyEditor
Parameters:: listener - PropertyChangeListener для удаления

firePropertyChange

public void firePropertyChange()

Сообщает всем заинтересованным слушателям, что произошли изменения.

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