Класс PropertyEditorSupport

java.lang.Object

java.beans.PropertyEditorSupport

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

public class PropertyEditorSupport extends Object implements PropertyEditor

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

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

C тех пор как:: 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, если значение нельзя представить в виде строки.

Если возвращается ненулевое значение, то редактор свойств должен быть готов проанализировать эту строку в методе 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, 2023, 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/21/docs/api/java.desktop/java/beans/PropertyEditorSupport.html