Spec-Zone.ru › OpenJDK 8

Класс PropertyEditorSupport

  • java.lang.Object
    • java.beans.PropertyEditorSupport
Все реализуемые интерфейсы:
PropertyEditor

public class PropertyEditorSupport
extends Object
implements PropertyEditor

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

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

Конструкторы

Конструктор и описание
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()

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

Методы, унаследованные от класса 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()

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

Возвращает:
объект-источник или текущий экземпляр
С:
1.5

setSource

public void setSource(Object source)

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

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

Параметры:
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.

Spec-Zone.ru

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