com.guiseframework.model
Interface TreeModel

All Superinterfaces:
ActionListenable, ActionModel, Model, com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable
All Known Implementing Classes:
DefaultTreeModel, TreeControl

public interface TreeModel
extends ActionModel

A model for a tree of nodes.

Author:
Garret Wilson

Field Summary
static java.lang.String ROOT_NODE_PROPERTY
          The bound property of the root node.
 
Fields inherited from interface com.guiseframework.model.Model
PLAIN_TEXT_CONTENT_TYPE, XHTML_CONTENT_TYPE, XHTML_FRAGMENT_CONTENT_TYPE
 
Method Summary
 TreeNodeModel<?> getRootNode()
           
 void setAllExpanded(boolean newAllExpanded)
          Sets whether all tree nodes are expanded.
 void setRootNode(TreeNodeModel<?> newRootNode)
          Sets the root node of the tree model.
 
Methods inherited from interface com.guiseframework.model.ActionModel
getActionListeners, performAction, performAction
 
Methods inherited from interface com.globalmentor.beans.PropertyBindable
addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
 
Methods inherited from interface com.globalmentor.beans.PropertyConstrainable
addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, hasVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener
 
Methods inherited from interface com.guiseframework.event.ActionListenable
addActionListener, removeActionListener
 

Field Detail

ROOT_NODE_PROPERTY

static final java.lang.String ROOT_NODE_PROPERTY
The bound property of the root node.

Method Detail

getRootNode

TreeNodeModel<?> getRootNode()
Returns:
The root node of the tree model.

setRootNode

void setRootNode(TreeNodeModel<?> newRootNode)
Sets the root node of the tree model. This is a bound property.

Parameters:
newRootNode - The new root node of the tree model.
Throws:
java.lang.NullPointerException - if the given root node is null.
See Also:
ROOT_NODE_PROPERTY

setAllExpanded

void setAllExpanded(boolean newAllExpanded)
Sets whether all tree nodes are expanded. This method delegates to the root node TreeNodeModel.setAllExpanded(boolean).

Parameters:
newAllExpanded - true if all the nodes should be expanded, or false if they should be collapsed.


Copyright © 2005-2010 GlobalMentor, Inc. All Rights Reserved.