Интерфейс PropertyEditor

public interface PropertyEditor

Класс PropertyEditor предоставляет поддержку для графических интерфейсов пользователя (GUI), которые должны позволять пользователям редактировать значение свойства заданного типа.

PropertyEditor поддерживает различные способы отображения и обновления значений свойств. Большинству PropertyEditor'ов потребуется поддержка только подмножества доступных вариантов в этой API.

Простые PropertyEditor'ы могут поддерживать только методы getAsText и setAsText и не обязаны поддерживать (например) paintValue или getCustomEditor. Более сложные типы могут не поддерживать getAsText и setAsText, но вместо этого поддерживать paintValue и getCustomEditor.

Каждый PropertyEditor должен поддерживать один или несколько из трех простых стилей отображения. Таким образом, он может (1) поддерживать isPaintable или (2) возвращать непустой массив String[] из getTags() и возвращать непустое значение из getAsText или (3) просто возвращать непустую строку из getAsText().

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

Каждый PropertyEditor должен иметь конструктор по умолчанию (с null).

Методы

setValue

void setValue(Object value)

Устанавливает (или изменяет) объект, который необходимо редактировать. Примитивные типы, такие как "int", должны быть обернуты как соответствующие типы объектов, такие как "java.lang.Integer".

Параметры:

value - Новый целевой объект для редактирования. Обратите внимание, что этот объект не должен изменяться PropertyEditor, а PropertyEditor должен создать новый объект для хранения любого измененного значения.

getValue

Object getValue()

Получает значение свойства.

Возвращает:

Значение свойства. Примитивные типы, такие как "int", будут обернуты как соответствующие типы объектов, такие как "java.lang.Integer".

isPaintable

boolean isPaintable()

Определяет, является ли этот редактор свойств отображаемым.

Возвращает:

True, если класс будет обрабатывать метод paintValue.

paintValue

void paintValue(Graphics gfx,
                Rectangle box)

Параметры:

gfx - Объект Graphics для отрисовки.

box - Прямоугольник в объекте Graphics, в котором мы должны выполнить отрисовку.

getJavaInitializationString

String getJavaInitializationString()

Возвращает:

фрагмент кода Java, представляющий инициализатор текущего значения. Он не должен содержать точки с запятой (';') для завершения выражения.

getAsText

String getAsText()

Получает значение свойства в виде текста.

Возвращает:

Значение свойства в виде строки, подлежащей редактированию пользователем.

Возвращает null, если значение нельзя выразить в виде редактируемой строки.

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

setAsText

void setAsText(String text)
        throws IllegalArgumentException

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

Параметры:

text - Строка, подлежащая анализу.

Исключения:

IllegalArgumentException

getTags

String[] getTags()

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

Возвращает:

Значения тегов для этого свойства. Может быть null, если это свойство не может быть представлено как значение с тегами.

getCustomEditor

Component getCustomEditor()

Возвращает:

java.awt.Component, который позволит пользователю напрямую редактировать текущее значение свойства. Может быть null, если это не поддерживается.

supportsCustomEditor

boolean supportsCustomEditor()

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

Возвращает:

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

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

Добавляет слушателя для изменения значения. Когда редактор свойств изменяет свое значение, он должен отправлять событие PropertyChangeEvent всем зарегистрированным слушателям PropertyChangeListener, указав значение null для имени свойства и себя в качестве источника.

Параметры:

listener - слушатель PropertyChangeListener для добавления

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

Удаляет слушателя изменения значения.

Параметры:

listener - слушатель PropertyChangeListener для удаления