Package io.guise.framework.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

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ROOT_NODE_PROPERTY
    The bound property of the root node.

  • Method Summary

    Modifier and Type
    Method
    Description
    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 io.guise.framework.event.ActionListenable

    addActionListener, removeActionListener

    Methods inherited from interface io.guise.framework.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

  • Field Details

    • ROOT_NODE_PROPERTY

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

  • Method Details

    • 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:
      NullPointerException - if the given root node is null.
      See Also:

    • 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.