instrument/JTree API Documentation

org.pvv.bcd.instrument.JTree
Interface NodeInfo

All Superinterfaces:
java.lang.Cloneable
All Known Implementing Classes:
DefaultNodeInfo

public interface NodeInfo
extends java.lang.Cloneable

This is a specialized user object for use in conjunction with MutableTreeNode or DefaultMutableTreeNode type tree nodes.

Objects implementing NodeInfo are useful when you want to build instrumented trees with specialized tree nodes. While you will be best served to use DefaultMutableTreeNode type nodes, the NodeInfo interface gives you complete freedom in what kind of user objects to put into those nodes.

You will often want your NodeInfo classes to also implement Copyable. This will allow undo/redo and copy/paste to function properly in the instrumented tree.

See Also:
NodeInfo, Copyable

Method Summary
 java.lang.String getContents()
          Returns the contents of the node encoded as text
 java.lang.Object getContentsModel()
          Returns the data model of the contents
 java.lang.String getTitle()
          Returns the title of this node as a human-presentable string
 

Method Detail

getTitle

public java.lang.String getTitle()
Returns the title of this node as a human-presentable string

getContents

public java.lang.String getContents()
Returns the contents of the node encoded as text

getContentsModel

public java.lang.Object getContentsModel()
Returns the data model of the contents

instrument/JTree API Documentation