Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

cern::gp::beans::PropertyInfoSupport Class Reference

Inheritance diagram for cern::gp::beans::PropertyInfoSupport:

Inheritance graph
[legend]
Collaboration diagram for cern::gp::beans::PropertyInfoSupport:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 PropertyInfoSupport (String name, Class propertyEditorClass)
 PropertyInfoSupport (String name, String displayName)
 PropertyInfoSupport (String name, String displayName, Class propertyEditorClass)
 PropertyInfoSupport (String name, boolean isHidden)
void setIsCached (Boolean isCached)
void setIsExpert (boolean isExpert)
void setIsHidden (boolean isHidden)
void updatePropertyDescriptor (PropertyDescriptor propertyDescriptor)
String getName ()
String getDisplayName ()
Class getPropertyEditorClass ()
Boolean isCacheable ()
boolean isExpert ()
boolean isHidden ()

Private Member Functions

 PropertyInfoSupport (String name, String displayName, Class propertyEditorClass, boolean isHidden)

Private Attributes

String name
String displayName
Class propertyEditorClass
Boolean isCacheable
boolean isExpert
boolean isHidden

Detailed Description

Support class allowing to create instances of PropertyInfo.

See also:
PropertyInfo

cern.gp.beans.editors.support.BeanDependentPropertyEditor

Version:
Revision
1.2
Date
2006/09/25 08:52:36
Author:
Lionel Mestre


Constructor & Destructor Documentation

cern::gp::beans::PropertyInfoSupport::PropertyInfoSupport String  name,
Class  propertyEditorClass
[inline]
 

Creates a new PropertyInfoSupport with a given PropertyEditorClass that is non cached, non expert and non hidden. The display name of the property will the name of the property.

Parameters:
name the name of the property that PropertyInfo object is for
propertyEditorClass the class of the property editor for this property
See also:
cern.gp.beans.editors.support.BeanDependentPropertyEditor

cern::gp::beans::PropertyInfoSupport::PropertyInfoSupport String  name,
String  displayName
[inline]
 

Creates a new PropertyInfoSupport with no PropertyEditor that is non cached, non expert and non hidden. The display name of the property will be the one specified.

Parameters:
name the name of the property that PropertyInfo object is for
propertyEditorClass the class of the property editor for this property
See also:
cern.gp.beans.editors.support.BeanDependentPropertyEditor

cern::gp::beans::PropertyInfoSupport::PropertyInfoSupport String  name,
String  displayName,
Class  propertyEditorClass
[inline]
 

Creates a new PropertyInfoSupport with a given PropertyEditorClass that is non cached, non expert and non hidden. The display name of the property will be the one specified.

Parameters:
name the name of the property that PropertyInfo object is for
displayName the display name of the property
propertyEditorClass the class of the property editor for this property
See also:
cern.gp.beans.editors.support.BeanDependentPropertyEditor

cern::gp::beans::PropertyInfoSupport::PropertyInfoSupport String  name,
boolean  isHidden
[inline]
 

Creates a new PropertyInfoSupport with no PropertyEditorClass that is non cached, non expert and hidden or not depending of the given value.

Parameters:
name the name of the property that PropertyInfo object is for
isHidden whether this property is hidden or not

cern::gp::beans::PropertyInfoSupport::PropertyInfoSupport String  name,
String  displayName,
Class  propertyEditorClass,
boolean  isHidden
[inline, private]
 


Member Function Documentation

String cern::gp::beans::PropertyInfoSupport::getDisplayName  )  [inline]
 

Returns the display name of the property

Returns:
the display name of the property

Implements cern::gp::beans::PropertyInfo.

String cern::gp::beans::PropertyInfoSupport::getName  )  [inline]
 

Returns the name of the property

Returns:
the name of the property

Implements cern::gp::beans::PropertyInfo.

Class cern::gp::beans::PropertyInfoSupport::getPropertyEditorClass  )  [inline]
 

Gets an explicit PropertyEditor Class for this property. The method will return "null" for indicating that no special editor has been registered, so the PropertyEditorManager should be used to locate a suitable PropertyEditor.

Returns:
An explicit PropertyEditor Class for this property or null.

Implements cern::gp::beans::PropertyInfo.

Boolean cern::gp::beans::PropertyInfoSupport::isCacheable  )  [inline]
 

Returns a boolean indicating the caching strategy for this property. Three value can be returned :

  • null : no caching strategy specified, the property inherit from the one defined for the bean or from the default one if the bean does not specified one.
  • True : the property can be cached. This will override the caching strategy defined at the bean level. It is the responsibility of the bean to send PropertyChangeEvent to update the cached value
  • False : the property cannot be cached. This will override the caching strategy defined at the bean level.
Returns:
null, True or False depending the caching strategy specified.

Implements cern::gp::beans::PropertyInfo.

boolean cern::gp::beans::PropertyInfoSupport::isExpert  )  [inline]
 

Returns if this property is expert. The "expert" flag is used to distinguish between those features that are intended for expert users from those that are intended for normal users.

Returns:
true if this property is intended for use by experts only

Implements cern::gp::beans::PropertyInfo.

boolean cern::gp::beans::PropertyInfoSupport::isHidden  )  [inline]
 

Returns if this property is hidden. The "hidden" flag is used to identify features that are intended only for tool use, and which should not be exposed to humans.

Returns:
true if this property should be hidden from human users.

Implements cern::gp::beans::PropertyInfo.

void cern::gp::beans::PropertyInfoSupport::setIsCached Boolean  isCached  )  [inline]
 

Sets whether the property is cached or no. Null can be used to specify the default behavior.

Parameters:
isCached whether the property is cached or no.

void cern::gp::beans::PropertyInfoSupport::setIsExpert boolean  isExpert  )  [inline]
 

Sets whether the property is only visible to experts or no

Parameters:
isExpert whether the property is only visible to experts or no

void cern::gp::beans::PropertyInfoSupport::setIsHidden boolean  isHidden  )  [inline]
 

Sets whether the property is hidden or no

Parameters:
isHidden whether the property is hidden or no

void cern::gp::beans::PropertyInfoSupport::updatePropertyDescriptor PropertyDescriptor  propertyDescriptor  )  [inline]
 

Update the given PropertyDescriptor with the information contained in this PropertyInfo

Parameters:
propertyDescriptor the PropertyDescriptor to update

Implements cern::gp::beans::PropertyInfo.


Member Data Documentation

String cern::gp::beans::PropertyInfoSupport::displayName [private]
 

Boolean cern::gp::beans::PropertyInfoSupport::isCacheable [private]
 

boolean cern::gp::beans::PropertyInfoSupport::isExpert [private]
 

boolean cern::gp::beans::PropertyInfoSupport::isHidden [private]
 

String cern::gp::beans::PropertyInfoSupport::name [private]
 

Class cern::gp::beans::PropertyInfoSupport::propertyEditorClass [private]
 


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 03:08:16 2009 for ACS Java API by doxygen 1.3.8