commonj.connector.metadata.discovery.properties
Interface TreeProperty

All Superinterfaces:
Cloneable, PropertyDescriptor

public interface TreeProperty
extends PropertyDescriptor

An interface for a property that represents a tree of selectable nodes. Such a tree could be rendered using a selectable JTree for example. The tree consists of nodes that can be selected, or de-selected.

Since:
1.0

Method Summary
 NodeProperty getRoot()
          Returns the root node of the property tree.
 boolean selectableNodes()
          Returns true if the tree has selectable nodes or otherwise false.
 boolean showRoot()
          Indicates if the Root node of the property tree should be displayed or not.
 
Methods inherited from interface commonj.connector.metadata.discovery.properties.PropertyDescriptor
addPropertyChangeListener, clone, getDescription, getDisplayName, getID, getName, isEnabled, removePropertyChangeListener
 

Method Detail

showRoot

boolean showRoot()
Indicates if the Root node of the property tree should be displayed or not.

Returns:
a boolean value indicating if the Root node of the property tree should be displayed or not.

getRoot

NodeProperty getRoot()
Returns the root node of the property tree.

Returns:
a non-null root node of the property tree.

selectableNodes

boolean selectableNodes()
Returns true if the tree has selectable nodes or otherwise false.

If true, by default all the child NodeProperty nodes will have their NodeProperty.isSelected() ignored.

Returns:
true if the tree has selectable nodes false otherwise.
Since:
1.1