Класс 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()`	PropertyEditor может предоставить специальный компонент для редактирования значения своего свойства.
`String`	`getJavaInitializationString()`	Этот метод предназначен для генерации кода Java, устанавливающего значение свойства.
`Object`	`getSource()`	Возвращает bean-компонент, используемый в качестве источника событий.
`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)`	Устанавливает исходный bean-компонент.
`void`	`setValue(Object value)`	Устанавливает (или изменяет) объект, который необходимо редактировать.
`boolean`	`supportsCustomEditor()`	Определяет, может ли PropertyEditor предоставить пользовательский редактор.

Методы, объявленные в классе Object

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создаёт и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Финализация объявлена устаревшей и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого объекта `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

PropertyEditorSupport

public PropertyEditorSupport()

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

Начиная с:: 1.5

PropertyEditorSupport

public PropertyEditorSupport(Object source)

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

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

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

getSource

public Object getSource()

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

Возвращает:: исходный объект или этот экземпляр
Начиная с:: 1.5

setSource

public void setSource(Object source)

Устанавливает исходный bean-компонент.

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

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

setValue

public void setValue(Object value)

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

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

getValue

public Object getValue()

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

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

isPaintable

public boolean isPaintable()

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

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

paintValue

public void paintValue(Graphics gfx, Rectangle box)

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

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

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

setAsText

public void setAsText(String text) throws IllegalArgumentException

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

Определён в:: setAsText в интерфейсе PropertyEditor
Параметры:: text — строка для разбора.
Выбрасывает:: IllegalArgumentException

getTags

public String[] getTags()

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

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

getCustomEditor

public Component getCustomEditor()

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

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

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

supportsCustomEditor

public boolean supportsCustomEditor()

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

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

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.