cern.gp.nodes.impl

Class BeanNode

java.lang.Object

org.openide.nodes.AbstractNode

cern.gp.nodes.impl.BeanNode

All Implemented Interfaces:

Cacheable

Direct Known Subclasses:

GPBeanNode

public class BeanNode
extends org.openide.nodes.AbstractNode
implements Cacheable

**For internal use only** Represents one JavaBean in the nodes hierarchy. It provides all methods that are needed for communication between the NetBeans platform and the bean.

You may use this node type for an already-existing JavaBean in order for its JavaBean properties to be reflected as corresponding node properties. Thus, it serves as a compatibility wrapper.

This BeanNode is based on a NodeUpdater that provides it the information it needs. BeanNode builds a NodeUpdater based on the introspection of the bean. Then it tries to register itself as PropertyChangeListener provided that the bean implements the method addPropertyChangeListener. In such a case, the BeanNode will receive the PropertyChangeEvent and update itself when needed.

Whether or not the BeanNode can register itself as PropertyChangeListener or receives any PropertyChangeEvent, it will still try to use the getters available through introspection to initialize itself. When a given getter is not available for a property needed by the node, the node will try to find a default value in the BeanInfo.

To see the property this node is interested in, see the class cern.gp.beans.IntrospectionBasedNodeUpdater.

Author:

Lionel Mestre

See Also:

NodeUpdater, NodeUpdaterProvider, IntrospectionBasedNodeUpdater

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BeanNode(java.lang.Object bean, Children children) Constructs a node for a JavaBean with a defined child list.

Method Summary

Modifier and Type	Method and Description
protected SystemAction[]	createActions() Returns the actions that shall be displayed in the pop-up menu for this node.
protected void	createProperties(java.lang.Object bean, java.beans.BeanInfo info, PropertyInfo[] propertyInfo) Prepare node properties based on the bean, storing them into the current property sheet.
void	destroy() Detaches all listeners from the bean and destroys it.
java.lang.Object	getBean()
java.awt.Component	getCustomizer() Returns the customizer component.
java.awt.Image	getIcon(int type) Get an icon for this node in the closed state.
java.awt.Image	getOpenedIcon(int type) Get an icon for this node in the open state.
javax.swing.Action	getPreferredAction()
boolean	hasCustomizer() Test if there is a customizer for this node.
void	resetCache() reset the cache for this Node.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanNode

protected BeanNode(java.lang.Object bean,
                   Children children)
            throws java.beans.IntrospectionException

Constructs a node for a JavaBean with a defined child list. Intended for use by subclasses with different strategies for computing the children.

Parameters:

bean - the bean this node will be based on

children - the children of this node

Throws:

java.beans.IntrospectionException - if the bean cannot be analyzed

Method Detail

getPreferredAction

public javax.swing.Action getPreferredAction()

getBean

public java.lang.Object getBean()

destroy

public void destroy()
             throws java.io.IOException

Detaches all listeners from the bean and destroys it.

Throws:

IOException - if there was a problem

getIcon

public java.awt.Image getIcon(int type)

Get an icon for this node in the closed state. Uses the Bean's icon if possible.

Parameters:

type - constant from BeanInfo

Returns:

icon to use

getOpenedIcon

public java.awt.Image getOpenedIcon(int type)

Get an icon for this node in the open state.

Parameters:

type - type constants

Returns:

icon to use. The default implementation just uses getIcon(int).

hasCustomizer

public boolean hasCustomizer()

Test if there is a customizer for this node. If true the customizer can be obtained via getCustomizer method.

Returns:

true if there is a customizer.

getCustomizer

public java.awt.Component getCustomizer()

Returns the customizer component.

Returns:

the component or null if there is no customizer

resetCache

public void resetCache()

reset the cache for this Node. As a result the node will reset the cache of all its properties.

Specified by:

resetCache in interface Cacheable

createProperties

protected void createProperties(java.lang.Object bean,
                                java.beans.BeanInfo info,
                                PropertyInfo[] propertyInfo)

Prepare node properties based on the bean, storing them into the current property sheet. Called when the bean info is ready. This implementation always creates a set for standard properties and may create a set for expert ones if there are any.

Parameters:

bean - bean to compute properties for

info - information about the bean

propertyInfo - extra information of some properties (possibly null)

See Also:

org.openide.nodes.BeanNode#computeProperties

createActions

protected SystemAction[] createActions()

Returns the actions that shall be displayed in the pop-up menu for this node. This method is called by Netbeans Explorer to build the pop-up menu for this node. It uses the BeanInfo associated with the contained bean for finding the actions.