commonj.connector.metadata.discovery.properties
Interface NodeProperty

All Superinterfaces:
Cloneable, Property, PropertyDescriptor

public interface NodeProperty
extends Property

An interface for a property node that is part of a TreeProperty. Each property node can be selected, or de-selected.

Optionally, each node can have a set of additional configuration properties. If a node does have configuration properties, then the user interface is responsible for rendering them and presenting them to the user whenever the node is selected.

Since:
1.0

Method Summary
 void applyConfigurationProperties(PropertyGroup properties)
          * Applies the configured property values to the node
 PropertyGroup createConfigurationProperties()
          Creates a new instance of the properties that are used to configure this node.
 NodeProperty[] getChildren()
          Returns any children nodes of this node.
 boolean isSelected()
          Returns if the node is selected or not.
 void setHighLighted()
          Sets the node which is highlighted.
 void setSelected(boolean selected)
          Sets the selection state of the node.
 
Methods inherited from interface commonj.connector.metadata.discovery.properties.Property
getValidationMessage, isSet, isValid, unSet
 
Methods inherited from interface commonj.connector.metadata.discovery.properties.PropertyDescriptor
addPropertyChangeListener, clone, getDescription, getDisplayName, getID, getName, isEnabled, removePropertyChangeListener
 

Method Detail

isSelected

boolean isSelected()
Returns if the node is selected or not.

Returns:
a boolean indicating if the node is selected or not.

setSelected

void setSelected(boolean selected)
Sets the selection state of the node.

Parameters:
selected - - a boolean value indicating if the node should be set to the selected state or not.

getChildren

NodeProperty[] getChildren()
Returns any children nodes of this node.

Returns:
any children nodes of this node, or null if none exist.

createConfigurationProperties

PropertyGroup createConfigurationProperties()
Creates a new instance of the properties that are used to configure this node. Configuration properties are optional so if no configuration properties exist this method must return null.

The value settings of the properties returned must match any values currently applied via a previous call to applyConfigurationProperties(commonj.connector.metadata.discovery.properties.PropertyGroup).

Returns:
a PropertyGroup representing the available configuration properties for the node import or null if no configuration properties exist.

applyConfigurationProperties

void applyConfigurationProperties(PropertyGroup properties)
* Applies the configured property values to the node

Parameters:
properties - a non null property group that has been configured with values. The property group instance must have been created using the createConfigurationProperties() method.

setHighLighted

void setHighLighted()
Sets the node which is highlighted. State is not maintained. The PropertyEvent.TREE_NODE_HIGHLIGHTED event is fired.

Since:
1.1