Spec-Zone.ru › OpenJDK 25

Класс 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()
Возвращает 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()
Определяет, может ли редактор свойств предоставить пользовательский редактор.

Методы, объявленные в классе 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()
Возвращает 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 не обрабатывает запросы на отрисовку (см. 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()
Если значение свойства должно быть одним из набора известных значений с метками, этот метод должен возвращать массив значений меток. Это можно использовать, например, для представления значений перечисления. Если PropertyEditor поддерживает метки, он также должен поддерживать использование 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()
Сообщает всем заинтересованным слушателям об изменении.

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/java/beans/PropertyEditorSupport.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API