Top Inners Fields Constructors Methods
org.stringtemplate.v4.gui

public Class JTreeSTModel

extends Object
implements TreeModel
Class Inheritance
All Implemented Interfaces
javax.swing.tree.TreeModel
Imports
org.stringtemplate.v4.Interpreter, .ST, .StringRenderer, org.stringtemplate.v4.debug.EvalTemplateEvent, javax.swing.event.TreeModelListener, javax.swing.tree.TreeModel, .TreePath

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
JTreeSTModel.Wrapper

Field Summary

Modifier and TypeField and Description
public Interpreter
interp

public JTreeSTModel.Wrapper
root

Constructor Summary

AccessConstructor and Description
public
JTreeSTModel(Interpreter interp, EvalTemplateEvent root)

Method Summary

Modifier and TypeMethod and Description
public void
addTreeModelListener(TreeModelListener
the listener to add
treeModelListener)

Implements javax.swing.tree.TreeModel.addTreeModelListener.

Adds a listener for the TreeModelEvent posted after the tree changes.
public Object
getChild(Object
a node in the tree, obtained from this data source
parent, int
index of child to be returned
index)

Implements javax.swing.tree.TreeModel.getChild.

Returns the child of parent at index index in the parent's child array.
public int
getChildCount(Object
a node in the tree, obtained from this data source
parent)

Implements javax.swing.tree.TreeModel.getChildCount.

Returns the number of children of parent.
public int
getIndexOfChild(Object
a node in the tree, obtained from this data source
parent, Object
the node we are interested in
child)

Implements javax.swing.tree.TreeModel.getIndexOfChild.

Returns the index of child in parent.
public Object
getRoot()

Implements javax.swing.tree.TreeModel.getRoot.

Returns the root of the tree.
public boolean
isLeaf(Object
a node in the tree, obtained from this data source
node)

Implements javax.swing.tree.TreeModel.isLeaf.

Returns true if node is a leaf.
public void
removeTreeModelListener(TreeModelListener
the listener to remove
treeModelListener)

Implements javax.swing.tree.TreeModel.removeTreeModelListener.

Removes a listener previously added with addTreeModelListener.
public void
valueForPathChanged(TreePath
path to the node that the user has altered
treePath, Object
the new value from the TreeCellEditor
o)

Implements javax.swing.tree.TreeModel.valueForPathChanged.

Messaged when the user has altered the value for the item identified by path to newValue.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

interpback to summary
public Interpreter interp
rootback to summary
public JTreeSTModel.Wrapper root

Constructor Detail

JTreeSTModelback to summary
public JTreeSTModel(Interpreter interp, EvalTemplateEvent root)

Method Detail

addTreeModelListenerback to summary
public void addTreeModelListener(TreeModelListener treeModelListener)

Implements javax.swing.tree.TreeModel.addTreeModelListener.

Doc from javax.swing.tree.TreeModel.addTreeModelListener.

Adds a listener for the TreeModelEvent posted after the tree changes.

Parameters
treeModelListener:TreeModelListener

the listener to add

Annotations
@Override
getChildback to summary
public Object getChild(Object parent, int index)

Implements javax.swing.tree.TreeModel.getChild.

Doc from javax.swing.tree.TreeModel.getChild.

Returns the child of parent at index index in the parent's child array. parent must be a node previously obtained from this data source. This should not return null if index is a valid index for parent (that is index >= 0 && index < getChildCount(parent)).

Parameters
parent:Object

a node in the tree, obtained from this data source

index:int

index of child to be returned

Returns:Object

the child of parent at index index

Annotations
@Override
getChildCountback to summary
public int getChildCount(Object parent)

Implements javax.swing.tree.TreeModel.getChildCount.

Doc from javax.swing.tree.TreeModel.getChildCount.

Returns the number of children of parent. Returns 0 if the node is a leaf or if it has no children. parent must be a node previously obtained from this data source.

Parameters
parent:Object

a node in the tree, obtained from this data source

Returns:int

the number of children of the node parent

Annotations
@Override
getIndexOfChildback to summary
public int getIndexOfChild(Object parent, Object child)

Implements javax.swing.tree.TreeModel.getIndexOfChild.

Doc from javax.swing.tree.TreeModel.getIndexOfChild.

Returns the index of child in parent. If either parent or child is null, returns -1. If either parent or child don't belong to this tree model, returns -1.

Parameters
parent:Object

a node in the tree, obtained from this data source

child:Object

the node we are interested in

Returns:int

the index of the child in the parent, or -1 if either child or parent are null or don't belong to this tree model

Annotations
@Override
getRootback to summary
public Object getRoot()

Implements javax.swing.tree.TreeModel.getRoot.

Doc from javax.swing.tree.TreeModel.getRoot.

Returns the root of the tree. Returns null only if the tree has no nodes.

Returns:Object

the root of the tree

Annotations
@Override
isLeafback to summary
public boolean isLeaf(Object node)

Implements javax.swing.tree.TreeModel.isLeaf.

Doc from javax.swing.tree.TreeModel.isLeaf.

Returns true if node is a leaf. It is possible for this method to return false even if node has no children. A directory in a filesystem, for example, may contain no files; the node representing the directory is not a leaf, but it also has no children.

Parameters
node:Object

a node in the tree, obtained from this data source

Returns:boolean

true if node is a leaf

Annotations
@Override
removeTreeModelListenerback to summary
public void removeTreeModelListener(TreeModelListener treeModelListener)

Implements javax.swing.tree.TreeModel.removeTreeModelListener.

Doc from javax.swing.tree.TreeModel.removeTreeModelListener.

Removes a listener previously added with addTreeModelListener.

Parameters
treeModelListener:TreeModelListener

the listener to remove

Annotations
@Override
valueForPathChangedback to summary
public void valueForPathChanged(TreePath treePath, Object o)

Implements javax.swing.tree.TreeModel.valueForPathChanged.

Doc from javax.swing.tree.TreeModel.valueForPathChanged.

Messaged when the user has altered the value for the item identified by path to newValue. If newValue signifies a truly new value the model should post a treeNodesChanged event.

Parameters
treePath:TreePath

path to the node that the user has altered

o:Object

the new value from the TreeCellEditor

Annotations
@Override
org.stringtemplate.v4.gui back to summary

public Class JTreeSTModel.Wrapper

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv EvalTemplateEvent
event

Constructor Summary

AccessConstructor and Description
public
Wrapper(EvalTemplateEvent event)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

eventback to summary
pack-priv EvalTemplateEvent event

Constructor Detail

Wrapperback to summary
public Wrapper(EvalTemplateEvent event)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations
@Override