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

public Class JTreeScopeStackModel

extends Object
implements TreeModel
Class Inheritance
All Implemented Interfaces
javax.swing.tree.TreeModel
Imports
org.antlr.runtime.tree.CommonTree, org.stringtemplate.v4.InstanceScope, .Interpreter, .ST, .StringRenderer, org.stringtemplate.v4.debug.AddAttributeEvent, javax.swing.event.TreeModelListener, javax.swing.tree.TreeModel, .TreePath, java.util.HashSet, .List, .Map, .Set
From a scope, get stack of enclosing scopes in order from root down to scope. Then show each scope's (ST's) attributes as children.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
JTreeScopeStackModel.StringTree

Field Summary

Modifier and TypeField and Description
pack-priv CommonTree
root

Constructor Summary

AccessConstructor and Description
public
JTreeScopeStackModel(InstanceScope scope)

Method Summary

Modifier and TypeMethod and Description
public void
addAttributeDescriptions(ST st, JTreeScopeStackModel.StringTree node, Set<String> names)

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
i)

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

rootback to summary
pack-priv CommonTree root

Constructor Detail

JTreeScopeStackModelback to summary
public JTreeScopeStackModel(InstanceScope scope)

Method Detail

addAttributeDescriptionsback to summary
public void addAttributeDescriptions(ST st, JTreeScopeStackModel.StringTree node, Set<String> names)
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 i)

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

i: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 JTreeScopeStackModel.StringTree

extends CommonTree
Class Inheritance

Field Summary

Modifier and TypeField and Description
pack-priv String
text

Inherited from org.antlr.runtime.tree.CommonTree:
childIndexparentstartIndexstopIndextoken

Constructor Summary

AccessConstructor and Description
public
StringTree(String text)

Method Summary

Modifier and TypeMethod and Description
public boolean
isNil()

Overrides org.antlr.runtime.tree.CommonTree.isNil.

Implements org.antlr.runtime.tree.Tree.isNil.

Indicates the node is a nil node but may still have children, meaning the tree is a flat list.
public String
toString()

Overrides org.antlr.runtime.tree.CommonTree.toString.

Implements org.antlr.runtime.tree.Tree.toString.

Override to say how a node (not a tree) should look as text
Inherited from org.antlr.runtime.tree.CommonTree:
dupNodegetCharPositionInLinegetChildIndexgetLinegetParentgetTextgetTokengetTokenStartIndexgetTokenStopIndexgetTypesetChildIndexsetParentsetTokenStartIndexsetTokenStopIndexsetUnknownTokenBoundaries

Field Detail

textback to summary
pack-priv String text

Constructor Detail

StringTreeback to summary
public StringTree(String text)

Method Detail

isNilback to summary
public boolean isNil()

Overrides org.antlr.runtime.tree.CommonTree.isNil.

Implements org.antlr.runtime.tree.Tree.isNil.

Doc from org.antlr.runtime.tree.Tree.isNil.

Indicates the node is a nil node but may still have children, meaning the tree is a flat list.

Annotations
@Override
toStringback to summary
public String toString()

Overrides org.antlr.runtime.tree.CommonTree.toString.

Implements org.antlr.runtime.tree.Tree.toString.

Doc from org.antlr.runtime.tree.BaseTree.toString.

Override to say how a node (not a tree) should look as text

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations
@Override