org.favabeans.base
Class BeanProperties

java.lang.Object
  |
  +--org.favabeans.base.DefaultFacet
        |
        +--org.favabeans.base.BeanProperties

All Implemented Interfaces:

Facet, Faceted, Properties

Direct Known Subclasses:

Defaults.PropertiesOfDataSource

public class BeanProperties

extends DefaultFacet

implements Properties

Constructor Summary

BeanProperties(Object primaryObject)

Method Summary

void	addPropertyChangeListener(PropertyChangeListener l)
void	addPropertyChangeListener(String propertyName, PropertyChangeListener l)
protected Collection	buildNonBeanAdditionalProperties() Build and return a set of additional Property objects which are not obtainable via Bean introspection.
Property[]	getAdditionalProperties() Additional properties defined by the application, and not provided as results of a getpropertyNameProperty() method on this interface.
String	getDisplayName() Shortcut to value of getDisplayNameProperty().
Property	getDisplayNameProperty() The localized display name of this object.
Property	getExpertProperty() This property is used to distinguish between those objects that are intended for expert users from those that are intended for normal users.
Property	getHiddenProperty() This property is used to identify objects that are intended only for tool use, and which should not be exposed to humans.
Icon	getLargeIcon() Shortcut to value of getLargeIconProperty().
Property	getLargeIconProperty() A large (32 pixels square) icon to represent this object.
String	getName() Shortcut to value of getNameProperty().
Property	getNameProperty() The programmatic name of this object.
Property	getPreferredProperty() This property is used to identify objects that are particularly important for presenting to humans.
String	getShortDescription() Shortcut to value of getPreferredProperty().
Property	getShortDescriptionProperty() The short description of the object.
Icon	getSmallIcon() Shortcut to value of getSmallIconProperty().
Property	getSmallIconProperty() A small (16 pixels square) icon to represent this object in menus and toolbars.
boolean	isExpert() Shortcut to value of getExpertProperty().
boolean	isHidden() Shortcut to value of getHiddenProperty().
boolean	isPreferred() Shortcut to value of getPreferredProperty().
void	removePropertyChangeListener(PropertyChangeListener l)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener l)
protected boolean	shouldIncludeBeanProperty(PropertyDescriptor pd) Indicate whether a given introspected Bean property should be included in the Properties Facet of the primary object.

Methods inherited from class org.favabeans.base.DefaultFacet

finalize, getFacet, getPrimaryObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.favabeans.base.Facet

getPrimaryObject

Constructor Detail

BeanProperties

public BeanProperties(Object primaryObject)

Method Detail

getName

public String getName()

Description copied from interface: Properties

Shortcut to value of Properties.getNameProperty().

Specified by:

getName in interface Properties

getDisplayName

public String getDisplayName()

Description copied from interface: Properties

Shortcut to value of Properties.getDisplayNameProperty().

Specified by:

getDisplayName in interface Properties

isExpert

public boolean isExpert()

Description copied from interface: Properties

Shortcut to value of Properties.getExpertProperty().

Specified by:

isExpert in interface Properties

isHidden

public boolean isHidden()

Description copied from interface: Properties

Shortcut to value of Properties.getHiddenProperty().

Specified by:

isHidden in interface Properties

isPreferred

public boolean isPreferred()

Description copied from interface: Properties

Shortcut to value of Properties.getPreferredProperty().

Specified by:

isPreferred in interface Properties

getShortDescription

public String getShortDescription()

Description copied from interface: Properties

Shortcut to value of Properties.getPreferredProperty(). The short description of the object.

Specified by:

getShortDescription in interface Properties

getSmallIcon

public Icon getSmallIcon()

Description copied from interface: Properties

Shortcut to value of Properties.getSmallIconProperty().

Specified by:

getSmallIcon in interface Properties

getLargeIcon

public Icon getLargeIcon()

Description copied from interface: Properties

Shortcut to value of Properties.getLargeIconProperty().

Specified by:

getLargeIcon in interface Properties

getNameProperty

public Property getNameProperty()

Description copied from interface: Properties

The programmatic name of this object.

Specified by:

getNameProperty in interface Properties

getDisplayNameProperty

public Property getDisplayNameProperty()

Description copied from interface: Properties

The localized display name of this object.

Specified by:

getDisplayNameProperty in interface Properties

getExpertProperty

public Property getExpertProperty()

Description copied from interface: Properties

This property is used to distinguish between those objects that are intended for expert users from those that are intended for normal users.

Specified by:

getExpertProperty in interface Properties

getHiddenProperty

public Property getHiddenProperty()

Description copied from interface: Properties

This property is used to identify objects that are intended only for tool use, and which should not be exposed to humans.

Specified by:

getHiddenProperty in interface Properties

getPreferredProperty

public Property getPreferredProperty()

Description copied from interface: Properties

This property is used to identify objects that are particularly important for presenting to humans.

Specified by:

getPreferredProperty in interface Properties

getShortDescriptionProperty

public Property getShortDescriptionProperty()

Description copied from interface: Properties

The short description of the object.

Specified by:

getShortDescriptionProperty in interface Properties

getSmallIconProperty

public Property getSmallIconProperty()

Description copied from interface: Properties

A small (16 pixels square) icon to represent this object in menus and toolbars.

Specified by:

getSmallIconProperty in interface Properties

getLargeIconProperty

public Property getLargeIconProperty()

Description copied from interface: Properties

A large (32 pixels square) icon to represent this object.

Specified by:

getLargeIconProperty in interface Properties

getAdditionalProperties

public Property[] getAdditionalProperties()

Description copied from interface: Properties

Additional properties defined by the application, and not provided as results of a getpropertyNameProperty() method on this interface.

Specified by:

getAdditionalProperties in interface Properties

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Specified by:

addPropertyChangeListener in interface Properties

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Specified by:

removePropertyChangeListener in interface Properties

addPropertyChangeListener

public void addPropertyChangeListener(String propertyName,
                                      PropertyChangeListener l)

Specified by:

addPropertyChangeListener in interface Properties

removePropertyChangeListener

public void removePropertyChangeListener(String propertyName,
                                         PropertyChangeListener l)

Specified by:

removePropertyChangeListener in interface Properties

shouldIncludeBeanProperty

protected boolean shouldIncludeBeanProperty(PropertyDescriptor pd)

Indicate whether a given introspected Bean property should be included in the Properties Facet of the primary object.

This method is for the convenience of subclasses. The default implementation of this method always returns true.

Parameters:

pd - the Bean property descriptor for the given property.

Returns:

true if the property should be included; false otherwise.

buildNonBeanAdditionalProperties

protected Collection buildNonBeanAdditionalProperties()

Build and return a set of additional Property objects which are not obtainable via Bean introspection.

This method is for the convenience of subclasses. The default implementation of this method returns an empty collection.

Returns:

the additional Property objects.