Property (gui.swing 0.2.2 API)

java.lang.Object
- xyz.cofe.gui.swing.properties.Property

```
public class Property
extends Object
```
Описание свойства

Author:

nt.gocha@gmail.com

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Property.PropertyQuery
Запрос к списку свойства

Nested Classes
Modifier and Type	Class and Description
`static class`	`Property.PropertyQuery` Запрос к списку свойства

Field Summary

Fields
Modifier and Type	Field and Description
`protected Object`	`bean`
`protected boolean`	`bound`
`protected boolean`	`constrained`
`protected String`	`displayName`
`protected boolean`	`expret`
`protected boolean`	`hidden`
`protected String`	`htmlDescription`
`protected String`	`name`
`protected boolean`	`notNull`
`protected boolean`	`preffered`
`protected PropertyDescriptor`	`propertyDescriptor`
`protected Class<?>`	`propertyEditorClass`
`protected Class`	`propertyType`
`protected xyz.cofe.collection.Func0`	`readFn`
`protected Method`	`readMethod`
`protected Boolean`	`readOnly`
`protected Boolean`	`readOnlyDescent`
`protected String`	`shortDescription`
`protected xyz.cofe.gui.swing.bean.UiBean`	`uiBean`
`protected static WeakHashMap<PropertyDescriptor,Boolean>`	`uiBeanApplied`
`protected xyz.cofe.collection.Func1`	`writeFn`
`protected Method`	`writeMethod`

Constructor Summary

Constructors
Constructor and Description
`Property()` Конструктор по умолчанию
`Property(Object bean, PropertyDescriptor src)` Конструктор
`Property(Property src)` Конструктор копирования
`Property(String name, Class type, xyz.cofe.collection.Func0 read, xyz.cofe.collection.Func1 write)` Конструктор

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Closeable`	`addPropertyChangeListener(PropertyChangeListener listener)` Добавляет подписчика на уведомления о изменении свойства
`Enumeration<String>`	`attributeNames()` Возвращает атрибуты свойства
`Property`	`clone()` Создание клона
`PropertyEditor`	`createPropertyEditor(Object bean)`
`Object`	`getBean()` Возвращает владельца свойства (объект)
`String`	`getDisplayName()` Указывает отображаемое имя свойства
`String`	`getHtmlDescription()` Возвращает описание свойства в вормате html
`String`	`getName()` Указывает имя свойства
`PropertyDescriptor`	`getPropertyDescriptor()` Возвращает описание свойства
`Class<?>`	`getPropertyEditorClass()` Указывает редактор свойства
`String`	`getPropertyName()` Возвращает имя свойства
`Class<?>`	`getPropertyType()` Указывает тип данных свойства
`xyz.cofe.collection.Func0`	`getReadFn()` Возвращает функцию чтения свойства
`Method`	`getReadMethod()` Возвращает метод чтения значения свойства
`Boolean`	`getReadOnlyDescent()` Дочерние свойства/объекты - так же должны быть только для чтения
`String`	`getShortDescription()` Возвращает краткое описание свойства
`xyz.cofe.gui.swing.bean.UiBean`	`getUiBean()` Возвращает настройки отображения/редактирования свойства
`Object`	`getValue(String attributeName)` Возвращает атрибут свойства
`xyz.cofe.collection.Func1`	`getWriteFn()` Указывает функцию записи значения в свойство
`Method`	`getWriteMethod()` Указывает метод записи значения в свойство
`boolean`	`isBound()` Указывает что свойство генерирует событие PropertyChange
`boolean`	`isConstrained()` Указывает что возможен запрет на изменение свойства
`boolean`	`isExpert()` Указывает что данное свойство доступно для экспертов
`boolean`	`isHidden()` Указывает что свойство должно быть скрытым и не отображаться в редакторе
`boolean`	`isNotNull()` Указывает требует ли свойство не null значения
`boolean`	`isPreferred()` Указывает что свойство предпочитаемое для редактирования
`boolean`	`isReadOnly()` Свойство доступно только для записи или нет
`static Set<Property>`	`propertiesOf(Class cls, Object bean)` Возвращает свойства для заданного объекта
`static Set<Property>`	`propertiesOf(Class cls, Object bean, boolean include, String... names)` Получает свойства объекта
`static Set<Property>`	`propertiesOf(Class cls, Object bean, xyz.cofe.collection.Predicate<PropertyDescriptor> filter)` Получение свойств объекта согласно указанному фильтру
`static Set<Property>`	`propertiesOf(Class cls, Object bean, xyz.cofe.collection.Predicate<PropertyDescriptor> filter, xyz.cofe.collection.Convertor<xyz.cofe.collection.Pair<PropertyDescriptor,Object>,Property> propertyBuilder)` Получение свойств объекта согласно указанному фильтру
`static Property.PropertyQuery`	`propertyQuery()` Создает запрос для фильтрации свойств
`Object`	`read()` Чтегие свойства
`void`	`setBean(Object bean)` устанавливает владельца свойства (объект)
`void`	`setBound(boolean bound)` Указывает что свойство генерирует событие PropertyChange
`void`	`setConstrained(boolean constrained)` Указывает что возможен запрет на изменение свойства
`void`	`setDisplayName(String displayName)` Указывает отображаемое имя свойства
`void`	`setExpert(boolean expert)` Указывает что данное свойство доступно для экспертов
`void`	`setHidden(boolean hidden)` Указывает что свойство должно быть скрытым и не отображаться в редакторе
`void`	`setHtmlDescription(String htmlDescription)` Указывает описание свойства в вормате html
`void`	`setName(String name)` Указывает имя свойства
`void`	`setNotNull(boolean notNull)` Указывает требовать ли наличие значения
`void`	`setPreferred(boolean preferred)` Указывает что свойство предпочитаемое для редактирования
`void`	`setPropertyDescriptor(PropertyDescriptor propertyDescriptor)` Указывает описание свойства
`void`	`setPropertyEditorClass(Class<?> propertyEditorClass)` Указывает редактор свойства
`void`	`setPropertyType(Class<?> pt)` Указывает тип данных свойства
`void`	`setReadFn(xyz.cofe.collection.Func0 readFn)` Указывает функцию чтения свойства
`void`	`setReadMethod(Method readMethod)` Указывает метод чтения значения свойства
`void`	`setReadOnly(Boolean readOnly)` Свойство доступно только для записи или нет
`void`	`setReadOnlyDescent(Boolean readOnlyDescent)` Дочерние свойства/объекты - так же должны быть только для чтения
`void`	`setShortDescription(String text)` Указывает краткое описание свойства
`void`	`setUiBean(xyz.cofe.gui.swing.bean.UiBean uiBean)` Указывает настройки отображения/редактирования свойства
`void`	`setValue(String attributeName, Object value)` Указывает атрибут свойства
`void`	`setWriteFn(xyz.cofe.collection.Func1 writeFn)` Указывает функцию записи значения в свойство
`void`	`setWriteMethod(Method writeMethod)` Указывает метод записи значения в свойство
`void`	`write(Object val)` Запись свойства

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - uiBeanApplied
```
protected static final WeakHashMap<PropertyDescriptor,Boolean> uiBeanApplied
```
  - uiBean
```
protected volatile xyz.cofe.gui.swing.bean.UiBean uiBean
```
  - propertyDescriptor
```
protected volatile PropertyDescriptor propertyDescriptor
```
  - bean
```
protected volatile Object bean
```
  - readFn
```
protected volatile xyz.cofe.collection.Func0 readFn
```
  - writeFn
```
protected volatile xyz.cofe.collection.Func1 writeFn
```
  - readOnly
```
protected volatile Boolean readOnly
```
  - readOnlyDescent
```
protected volatile Boolean readOnlyDescent
```
  - notNull
```
protected volatile boolean notNull
```
  - propertyType
```
protected volatile Class propertyType
```
  - readMethod
```
protected volatile Method readMethod
```
  - writeMethod
```
protected volatile Method writeMethod
```
  - bound
```
protected volatile boolean bound
```
  - constrained
```
protected volatile boolean constrained
```
  - propertyEditorClass
```
protected volatile Class<?> propertyEditorClass
```
  - name
```
protected volatile String name
```
  - displayName
```
protected volatile String displayName
```
  - expret
```
protected volatile boolean expret
```
  - hidden
```
protected volatile boolean hidden
```
  - preffered
```
protected volatile boolean preffered
```
  - shortDescription
```
protected volatile String shortDescription
```
  - htmlDescription
```
protected volatile String htmlDescription
```
- Constructor Detail
  - Property
```
public Property()
```
    Конструктор по умолчанию
  - Property
```
public Property(String name,
                Class type,
                xyz.cofe.collection.Func0 read,
                xyz.cofe.collection.Func1 write)
```
    Конструктор
    
    Parameters:
    
    name - Имя свойства
    
    type - Тип свойства
    
    read - Чтение
    
    write - Запись
  - Property
```
public Property(Property src)
```
    Конструктор копирования
    
    Parameters:
    
    src - образец для копирования
  - Property
```
public Property(Object bean,
                PropertyDescriptor src)
```
    Конструктор
    
    Parameters:
    
    bean - исходный объект владелец свойства
    
    src - Описание свойства
- Method Detail
  - clone
```
public Property clone()
```
    Создание клона
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    клон
  - getPropertyName
```
public String getPropertyName()
```
    Возвращает имя свойства
    
    Returns:
    
    имя свойства
  - getUiBean
```
public xyz.cofe.gui.swing.bean.UiBean getUiBean()
```
    Возвращает настройки отображения/редактирования свойства
    
    Returns:
    
    настройки или null
  - setUiBean
```
public void setUiBean(xyz.cofe.gui.swing.bean.UiBean uiBean)
```
    Указывает настройки отображения/редактирования свойства
    
    Parameters:
    
    uiBean - настройки
  - getPropertyDescriptor
```
public PropertyDescriptor getPropertyDescriptor()
```
    Возвращает описание свойства
    
    Returns:
    
    описание свойства или null
  - setPropertyDescriptor
```
public void setPropertyDescriptor(PropertyDescriptor propertyDescriptor)
```
    Указывает описание свойства
    
    Parameters:
    
    propertyDescriptor - описапние
  - getBean
```
public Object getBean()
```
    Возвращает владельца свойства (объект)
    
    Returns:
    
    владелец свойства (объект)
  - setBean
```
public void setBean(Object bean)
```
    устанавливает владельца свойства (объект)
    
    Parameters:
    
    bean - владелец свойства (объект)
  - getReadFn
```
public xyz.cofe.collection.Func0 getReadFn()
```
    Возвращает функцию чтения свойства
    
    Returns:
    
    функция чтения
  - setReadFn
```
public void setReadFn(xyz.cofe.collection.Func0 readFn)
```
    Указывает функцию чтения свойства
    
    Parameters:
    
    readFn - функция чтения
  - getWriteFn
```
public xyz.cofe.collection.Func1 getWriteFn()
```
    Указывает функцию записи значения в свойство
    
    Returns:
    
    функция записи
  - setWriteFn
```
public void setWriteFn(xyz.cofe.collection.Func1 writeFn)
```
    Указывает функцию записи значения в свойство
    
    Parameters:
    
    writeFn - функция записи
  - read
```
public Object read()
```
    Чтегие свойства
    
    Returns:
    
    значение
    
    Throws:
    
    Error - - ошибка чтения свойства
  - write
```
public void write(Object val)
```
    Запись свойства
    
    Parameters:
    
    val - значение
  - addPropertyChangeListener
```
public Closeable addPropertyChangeListener(PropertyChangeListener listener)
```
    Добавляет подписчика на уведомления о изменении свойства
    
    Parameters:
    
    listener - подписчик
    
    Returns:
    
    отписка от уведомлений
  - isReadOnly
```
public boolean isReadOnly()
```
    Свойство доступно только для записи или нет
    
    Returns:
    
    true - только для записи
  - setReadOnly
```
public void setReadOnly(Boolean readOnly)
```
    Свойство доступно только для записи или нет
    
    Parameters:
    
    readOnly - true - только для записи
  - getReadOnlyDescent
```
public Boolean getReadOnlyDescent()
```
    Дочерние свойства/объекты - так же должны быть только для чтения
    
    Returns:
    
    true - дочрение так же readOnly; null - как есть
  - setReadOnlyDescent
```
public void setReadOnlyDescent(Boolean readOnlyDescent)
```
    Дочерние свойства/объекты - так же должны быть только для чтения
    
    Parameters:
    
    readOnlyDescent - true - дочрение так же readOnly; null - как есть
  - isNotNull
```
public boolean isNotNull()
```
    Указывает требует ли свойство не null значения
    
    Returns:
    
    true - не допускаются null значения
  - setNotNull
```
public void setNotNull(boolean notNull)
```
    Указывает требовать ли наличие значения
    
    Parameters:
    
    notNull - true - не допускаются null значения
  - getPropertyType
```
public Class<?> getPropertyType()
```
    Указывает тип данных свойства
    
    Returns:
    
    тип данных
  - setPropertyType
```
public void setPropertyType(Class<?> pt)
```
    Указывает тип данных свойства
    
    Parameters:
    
    pt - тип данных
  - setValue
```
public void setValue(String attributeName,
                     Object value)
```
    Указывает атрибут свойства
    
    Parameters:
    
    attributeName - имя атрибута
    
    value - значение
    
    See Also:
    
    FeatureDescriptor.setValue(java.lang.String, java.lang.Object)
  - getValue
```
public Object getValue(String attributeName)
```
    Возвращает атрибут свойства
    
    Parameters:
    
    attributeName - имя атрибута
    
    Returns:
    
    значение атрибута
    
    See Also:
    
    FeatureDescriptor.getValue(java.lang.String)
  - attributeNames
```
public Enumeration<String> attributeNames()
```
    Возвращает атрибуты свойства
    
    Returns:
    
    атрибуты
    
    See Also:
    
    FeatureDescriptor.attributeNames()
  - getReadMethod
```
public Method getReadMethod()
```
    Возвращает метод чтения значения свойства
    
    Returns:
    
    метод или null
  - setReadMethod
```
public void setReadMethod(Method readMethod)
                   throws IntrospectionException
```
    Указывает метод чтения значения свойства
    
    Parameters:
    
    readMethod - метод
    
    Throws:
    
    IntrospectionException - см propertyDescriptor
  - getWriteMethod
```
public Method getWriteMethod()
```
    Указывает метод записи значения в свойство
    
    Returns:
    
    метод или null
  - setWriteMethod
```
public void setWriteMethod(Method writeMethod)
                    throws IntrospectionException
```
    Указывает метод записи значения в свойство
    
    Parameters:
    
    writeMethod - метод
    
    Throws:
    
    IntrospectionException - см propertyDescriptor
  - isBound
```
public boolean isBound()
```
    Указывает что свойство генерирует событие PropertyChange
    
    Returns:
    
    true - свойство генерирует событие / false - наверно не генерирует
  - setBound
```
public void setBound(boolean bound)
```
    Указывает что свойство генерирует событие PropertyChange
    
    Parameters:
    
    bound - true - свойство генерирует событие / false - наверно не генерирует
  - isConstrained
```
public boolean isConstrained()
```
    Указывает что возможен запрет на изменение свойства
    
    Returns:
    
    true - на свойстве надоложено ограничение
    
    See Also:
    
    PropertyDescriptor.isConstrained()
  - setConstrained
```
public void setConstrained(boolean constrained)
```
    Указывает что возможен запрет на изменение свойства
    
    Parameters:
    
    constrained - true - на свойстве надоложено ограничение
    
    See Also:
    
    PropertyDescriptor.setConstrained(boolean)
  - setPropertyEditorClass
```
public void setPropertyEditorClass(Class<?> propertyEditorClass)
```
    Указывает редактор свойства
    
    Parameters:
    
    propertyEditorClass - редактор свойства
  - getPropertyEditorClass
```
public Class<?> getPropertyEditorClass()
```
    Указывает редактор свойства
    
    Returns:
    
    редактор свойства
  - createPropertyEditor
```
public PropertyEditor createPropertyEditor(Object bean)
```
  - getName
```
public String getName()
```
    Указывает имя свойства
    
    Returns:
    
    имя свойства
  - setName
```
public void setName(String name)
```
    Указывает имя свойства
    
    Parameters:
    
    name - имя свойства
  - getDisplayName
```
public String getDisplayName()
```
    Указывает отображаемое имя свойства
    
    Returns:
    
    отображаемое имя свойства
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Указывает отображаемое имя свойства
    
    Parameters:
    
    displayName - отображаемое имя свойства
  - isExpert
```
public boolean isExpert()
```
    Указывает что данное свойство доступно для экспертов
    
    Returns:
    
    true - желательно чтоб правил его эксперт
    
    See Also:
    
    FeatureDescriptor.isExpert()
  - setExpert
```
public void setExpert(boolean expert)
```
    Указывает что данное свойство доступно для экспертов
    
    Parameters:
    
    expert - true - желательно чтоб правил его эксперт
    
    See Also:
    
    FeatureDescriptor.setExpert(boolean)
  - isHidden
```
public boolean isHidden()
```
    Указывает что свойство должно быть скрытым и не отображаться в редакторе
    
    Returns:
    
    true - свойство скрыто от редактирования
  - setHidden
```
public void setHidden(boolean hidden)
```
    Указывает что свойство должно быть скрытым и не отображаться в редакторе
    
    Parameters:
    
    hidden - true - свойство скрыто от редактирования
  - isPreferred
```
public boolean isPreferred()
```
    Указывает что свойство предпочитаемое для редактирования
    
    Returns:
    
    свойство часто редактируемое
    
    See Also:
    
    FeatureDescriptor.isPreferred()
  - setPreferred
```
public void setPreferred(boolean preferred)
```
    Указывает что свойство предпочитаемое для редактирования
    
    Parameters:
    
    preferred - свойство часто редактируемое
    
    See Also:
    
    FeatureDescriptor.setPreferred(boolean)
  - getShortDescription
```
public String getShortDescription()
```
    Возвращает краткое описание свойства
    
    Returns:
    
    краткое описание или null
  - setShortDescription
```
public void setShortDescription(String text)
```
    Указывает краткое описание свойства
    
    Parameters:
    
    text - краткое описание
  - getHtmlDescription
```
public String getHtmlDescription()
```
    Возвращает описание свойства в вормате html
    
    Returns:
    
    описание или null
  - setHtmlDescription
```
public void setHtmlDescription(String htmlDescription)
```
    Указывает описание свойства в вормате html
    
    Parameters:
    
    htmlDescription - описание или null
  - propertiesOf
```
public static Set<Property> propertiesOf(Class cls,
                                         Object bean)
```
    Возвращает свойства для заданного объекта
    
    Parameters:
    
    cls - тип объекта
    
    bean - сам объект
    
    Returns:
    
    свойства
  - propertyQuery
```
public static Property.PropertyQuery propertyQuery()
```
    Создает запрос для фильтрации свойств
    
    Returns:
    
    запрос фильтрации свойств
  - propertiesOf
```
public static Set<Property> propertiesOf(Class cls,
                                         Object bean,
                                         boolean include,
                                         String... names)
```
    Получает свойства объекта
    
    Parameters:
    
    cls - Тип объекта
    
    bean - Сам объект
    
    include - true - Включать только указанные / false - исключать указанные
    
    names - имена включаемых/исключаемых свойств
    
    Returns:
    
    Свойства
  - propertiesOf
```
public static Set<Property> propertiesOf(Class cls,
                                         Object bean,
                                         xyz.cofe.collection.Predicate<PropertyDescriptor> filter)
```
    Получение свойств объекта согласно указанному фильтру
    
    Parameters:
    
    cls - Тип объекта
    
    bean - объект
    
    filter - фильтр
    
    Returns:
    
    Свойства
  - propertiesOf
```
public static Set<Property> propertiesOf(Class cls,
                                         Object bean,
                                         xyz.cofe.collection.Predicate<PropertyDescriptor> filter,
                                         xyz.cofe.collection.Convertor<xyz.cofe.collection.Pair<PropertyDescriptor,Object>,Property> propertyBuilder)
```
    Получение свойств объекта согласно указанному фильтру
    
    Parameters:
    
    cls - Тип объекта
    
    bean - объект
    
    filter - фильтр
    
    propertyBuilder - конвертирование свойств
    
    Returns:
    
    Свойства

Class Property

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

uiBeanApplied

uiBean

propertyDescriptor

bean

readFn

writeFn

readOnly

readOnlyDescent

notNull

propertyType

readMethod

writeMethod

bound

constrained

propertyEditorClass

name

displayName

expret

hidden

preffered

shortDescription

htmlDescription

Constructor Detail

Property

Property

Property

Property

Method Detail

clone

getPropertyName

getUiBean

setUiBean

getPropertyDescriptor

setPropertyDescriptor

getBean

setBean

getReadFn

setReadFn

getWriteFn

setWriteFn

read

write

addPropertyChangeListener

isReadOnly

setReadOnly

getReadOnlyDescent

setReadOnlyDescent

isNotNull

setNotNull

getPropertyType

setPropertyType

setValue

getValue

attributeNames

getReadMethod

setReadMethod

getWriteMethod

setWriteMethod

isBound

setBound

isConstrained

setConstrained

setPropertyEditorClass

getPropertyEditorClass

createPropertyEditor

getName

setName

getDisplayName

setDisplayName

isExpert

setExpert

isHidden

setHidden