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

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