GPBean (ACS-2016.6)

All Known Subinterfaces:

NodeUpdater

All Known Implementing Classes:

BeanSupport, IntrospectionBasedNodeUpdater, SimpleDemoBean
```
public interface GPBean
```
This interface defines the additional information a bean may provide in order to interact with the node that represents it.
A node that is built based on a given bean will use introspection to find those methods. The bean can implements any of them and possibly none of them. The node will use whatever information is available to initialize itself. The information non available through those methods will be taken from the BeanInfo or defaulted to a given value.
A bean that aimed to be used in GP Layer can choose one of the following strategies :
- inherits from BeanSupport and override any of those methods to return an appropriated value. The methods non overriden are implemented in BeanSupport and return null
- implements directly the methods defined here without inheriting from BeanSupport. Since the methods are found by introspection it is not strictly necessary to implement this interface. Nevertheless the interface brings a compile time check that can prove to be useful. It the bean implements the interface it needs to implement all methods are can return null for those where it doesn't want to specify a value.
- as above, implements directly 0 or more methods defined here without inheriting from BeanSupport and provides an explicit BeanInfo for the specifying additional information.
Author:

Lionel Mestre

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_PROPERTY_NAME` the class property name
`static java.lang.String`	`DISPLAYNAME_PROPERTY_DISPLAY_NAME` the display name of the display name property
`static java.lang.String`	`DISPLAYNAME_PROPERTY_NAME` the display name property name
`static java.lang.String`	`NAME_PROPERTY_DISPLAY_NAME` the display name of the name property
`static java.lang.String`	`NAME_PROPERTY_NAME` the name property name
`static java.lang.String`	`NODE_ACTIONS_PROPERTY_NAME` the node actions property name
`static java.lang.String`	`NODE_DEFAULT_ACTION_PROPERTY_NAME` the node default action property name
`static java.lang.String`	`NODE_ICON_PROPERTY_NAME` the node icon property name
`static java.lang.String`	`NODE_PROPERTIES_CACHEABLE_PROPERTY_NAME` the node property cacheable property name
`static java.lang.String`	`PROPERTY_INFO_PROPERTY_NAME` the property info property name
`static java.lang.String`	`SHORTDESCRIPTION_PROPERTY_DISPLAY_NAME` the display name of the short description property
`static java.lang.String`	`SHORTDESCRIPTION_PROPERTY_NAME` the short description property name

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDisplayName()` Returns the internal display name of the associated bean.
`java.lang.String`	`getName()` Returns the internal name of the associated bean.
`java.lang.String[]`	`getNodeActions()` Returns an array of qualified name of actions for the node representing the associated bean.
`java.lang.String`	`getNodeDefaultAction()` Returns the qualified name of the default action for the node representing the associated bean.
`java.awt.Image`	`getNodeIcon()` Returns the icon in 16x16 size used to display the node representing the associated bean.
`java.lang.Boolean`	`getNodePropertiesCacheable()` Returns true if the value of the properties can be cached in the node, false if they cannot or null if no behavior is specified.
`PropertyInfo[]`	`getPropertyInfo()` Returns an array of `PropertyInfo` specifying information on some properties.
`java.lang.String`	`getShortDescription()` Returns a short description of the associated bean (used in tooltip for instance).

- Field Detail
  - CLASS_PROPERTY_NAME
```
static final java.lang.String CLASS_PROPERTY_NAME
```
    the class property name
    
    See Also:
    
    Constant Field Values
  - NAME_PROPERTY_NAME
```
static final java.lang.String NAME_PROPERTY_NAME
```
    the name property name
    
    See Also:
    
    Constant Field Values
  - DISPLAYNAME_PROPERTY_NAME
```
static final java.lang.String DISPLAYNAME_PROPERTY_NAME
```
    the display name property name
    
    See Also:
    
    Constant Field Values
  - SHORTDESCRIPTION_PROPERTY_NAME
```
static final java.lang.String SHORTDESCRIPTION_PROPERTY_NAME
```
    the short description property name
    
    See Also:
    
    Constant Field Values
  - NODE_ICON_PROPERTY_NAME
```
static final java.lang.String NODE_ICON_PROPERTY_NAME
```
    the node icon property name
    
    See Also:
    
    Constant Field Values
  - NODE_DEFAULT_ACTION_PROPERTY_NAME
```
static final java.lang.String NODE_DEFAULT_ACTION_PROPERTY_NAME
```
    the node default action property name
    
    See Also:
    
    Constant Field Values
  - NODE_ACTIONS_PROPERTY_NAME
```
static final java.lang.String NODE_ACTIONS_PROPERTY_NAME
```
    the node actions property name
    
    See Also:
    
    Constant Field Values
  - NODE_PROPERTIES_CACHEABLE_PROPERTY_NAME
```
static final java.lang.String NODE_PROPERTIES_CACHEABLE_PROPERTY_NAME
```
    the node property cacheable property name
    
    See Also:
    
    Constant Field Values
  - PROPERTY_INFO_PROPERTY_NAME
```
static final java.lang.String PROPERTY_INFO_PROPERTY_NAME
```
    the property info property name
    
    See Also:
    
    Constant Field Values
  - NAME_PROPERTY_DISPLAY_NAME
```
static final java.lang.String NAME_PROPERTY_DISPLAY_NAME
```
    the display name of the name property
    
    See Also:
    
    Constant Field Values
  - DISPLAYNAME_PROPERTY_DISPLAY_NAME
```
static final java.lang.String DISPLAYNAME_PROPERTY_DISPLAY_NAME
```
    the display name of the display name property
    
    See Also:
    
    Constant Field Values
  - SHORTDESCRIPTION_PROPERTY_DISPLAY_NAME
```
static final java.lang.String SHORTDESCRIPTION_PROPERTY_DISPLAY_NAME
```
    the display name of the short description property
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns the internal name of the associated bean. If null is returned a default name will be used.
    - Property name : name
    - Visibility : normal (visible in a property sheet)
    - Default value (when null is returned from this method) : a unique name generated using BeanUtils. generateUniqueBeanName()
    Returns:
    
    the internal name of the associated bean or null.
  - getDisplayName
```
java.lang.String getDisplayName()
```
    Returns the internal display name of the associated bean. If null is returned a default name will be used.
    - Property name : displayName
    - Visibility : normal (visible in a property sheet)
    - Default value (when null is returned from this method) : if getName() is available it is used instead of getDisplayName(), else beanInfo.getBeanDescriptor().getDisplayName() is used
    Returns:
    
    the internal display name of the associated bean or null
  - getShortDescription
```
java.lang.String getShortDescription()
```
    Returns a short description of the associated bean (used in tooltip for instance). If null is returned a default description will be used.
    - Property name : shortDescription
    - Visibility : normal (visible in a property sheet)
    - Default value (when null is returned from this method) : beanInfo.getBeanDescriptor(). getShortDescription()
    Returns:
    
    a short description of the associated bean or null
  - getNodeIcon
```
java.awt.Image getNodeIcon()
```
    Returns the icon in 16x16 size used to display the node representing the associated bean. If null is returned a default icon will be used.
    - Property name : nodeIcon
    - Visibility : hidden (not visible in a property sheet)
    - Default value (when null is returned from this method) : beanInfo.getIcon()
    Returns:
    
    the icon in 16x16 size used to display the node representing the associated bean or null
  - getNodeDefaultAction
```
java.lang.String getNodeDefaultAction()
```
    Returns the qualified name of the default action for the node representing the associated bean. The default action is the one triggered when the user double-clic on the node. If null is returned a default default action will be used.
    - Property name : nodeDefaultAction
    - Visibility : hidden
    - Default value (when null is returned from this method) : use the possible tagging of the BeanDescriptor of the BeanInfo : BeanTagger.getDefaultAction(beanInfo.getBeanDescriptor())
    Returns:
    
    the qualified name of the default action for the node or null representing the associated bean.
  - getNodeActions
```
java.lang.String[] getNodeActions()
```
    Returns an array of qualified name of actions for the node representing the associated bean. Null can be used in the array to represent a separator.
    - Property name : nodeActions
    - Visibility : hidden (not visible in a property sheet)
    - Default value (when null is returned from this method) : use the possible tagging of the BeanDescriptor of the BeanInfo : BeanTagger.getActions(beanInfo.getBeanDescriptor())
    Returns:
    
    an array of qualified name of actions for a node representing the bean.
  - getNodePropertiesCacheable
```
java.lang.Boolean getNodePropertiesCacheable()
```
    Returns true if the value of the properties can be cached in the node, false if they cannot or null if no behavior is specified. The default behavior is not to cache the value of the properties.
    If the value of a property is not cached, the getter method will be invoked whenever the node need to get the value of the property.
    If the value of the property is cached, the getter method for the property will only be invoked once to read the value. Then, whenever the node need the value of the property it will used the cached one until a PropertyChangeEvent for the property (or for all properties) is fired.
    Caching values can improve performance greatly but it adds one more responsibility on the developer who has to fire PropertyChangeEvent whenever the property values change.
    This property gives the caching strategy for all properties. It is possible to override the bean level caching strategy at the property level by using the property information getPropertyInformation().
    - Property name : nodePropertiesCacheable
    - Visibility : hidden (not visible in a property sheet)
    - Default value (when null is returned from this method) : use the possible tagging of the BeanDescriptor of the BeanInfo : BeanTagger.isCacheable(beanInfo.getBeanDescriptor())
    Returns:
    
    true is the value of the properties can be cached in the node, false else or null for default behavior
  - getPropertyInfo
```
PropertyInfo[] getPropertyInfo()
```
    Returns an array of PropertyInfo specifying information on some properties.
    Each PropertyInfo of this array defines information for one property of this bean. Defining a PropertyInfo for a given property is usefull when there is no explicit BeanInfo for the bean and when the property have non default characteristics such as, for instance, a specific PropertyEditor.
    - Property name : propertyInfo
    - Visibility : hidden (not visible in a property sheet)
    - Default value (when null is returned from this method) : use PropertyDescriptors from BeanInfo
    Returns:
    
    true is the value of the properties can be cached in the node, false else or null for default behavior

Interface GPBean

Field Summary

Method Summary

Field Detail

CLASS_PROPERTY_NAME

NAME_PROPERTY_NAME

DISPLAYNAME_PROPERTY_NAME

SHORTDESCRIPTION_PROPERTY_NAME

NODE_ICON_PROPERTY_NAME

NODE_DEFAULT_ACTION_PROPERTY_NAME

NODE_ACTIONS_PROPERTY_NAME

NODE_PROPERTIES_CACHEABLE_PROPERTY_NAME

PROPERTY_INFO_PROPERTY_NAME

NAME_PROPERTY_DISPLAY_NAME

DISPLAYNAME_PROPERTY_DISPLAY_NAME

SHORTDESCRIPTION_PROPERTY_DISPLAY_NAME

Method Detail

getName

getDisplayName

getShortDescription

getNodeIcon

getNodeDefaultAction

getNodeActions

getNodePropertiesCacheable

getPropertyInfo