org.kepler.gui

Class SubsetWorkflowOutlineTreeModel

java.lang.Object

ptolemy.vergil.tree.EntityTreeModel

ptolemy.vergil.tree.ClassAndEntityTreeModel

org.kepler.gui.WorkflowOutlineTreeModel

org.kepler.gui.SubsetWorkflowOutlineTreeModel

All Implemented Interfaces:

javax.swing.tree.TreeModel

public class SubsetWorkflowOutlineTreeModel
extends WorkflowOutlineTreeModel

A tree model that can display a subset of a workflow. Use addToSubset() to select which NamedObjs are in the tree, and then call showSubset() to activate.

Author:

Daniel Crawl

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.vergil.tree.EntityTreeModel

EntityTreeModel.TreeUpdateListener

Field Summary

Fields inherited from class org.kepler.gui.WorkflowOutlineTreeModel

includeAttributes, includePorts, includeRelations

Fields inherited from class ptolemy.vergil.tree.EntityTreeModel

_root

Constructor Summary

Constructors

Constructor and Description
SubsetWorkflowOutlineTreeModel(CompositeEntity root) Create a new SubsetWorkflowOutlineTreeModel with the specified root.

Method Summary

Modifier and Type	Method and Description
void	addToSubset(NamedObj namedObj) Add an object to the subset tree.
java.lang.Object	getChild(java.lang.Object parent, int index) Get the child of the given parent at the given index.
int	getChildCount(java.lang.Object parent) Returns the number of children of the given parent.
int	getIndexOfChild(java.lang.Object parent, java.lang.Object child) Return the index of the given child within the given parent.
boolean	isLeaf(java.lang.Object object) Returns true if the object is a leaf node.
void	showAll() Show everything in the tree.
void	showSubset() Show only the nodes containing objects that were called with addToSubset().

Methods inherited from class org.kepler.gui.WorkflowOutlineTreeModel

_visibleAttributes

Methods inherited from class ptolemy.vergil.tree.ClassAndEntityTreeModel

_classes

Methods inherited from class ptolemy.vergil.tree.EntityTreeModel

addTreeModelListener, getRoot, removeTreeModelListener, setRoot, valueForPathChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubsetWorkflowOutlineTreeModel

public SubsetWorkflowOutlineTreeModel(CompositeEntity root)

Create a new SubsetWorkflowOutlineTreeModel with the specified root.

Method Detail

addToSubset

public void addToSubset(NamedObj namedObj)

Add an object to the subset tree. NOTE: the subset tree is not activated until showSubset() is called.

getChild

public java.lang.Object getChild(java.lang.Object parent,
                                 int index)

Get the child of the given parent at the given index. If the child does not exist, then return null.

Specified by:

getChild in interface javax.swing.tree.TreeModel

Overrides:

getChild in class WorkflowOutlineTreeModel

Parameters:

parent - A node in the tree.

index - The index of the desired child.

Returns:

A node, or null if there is no such child.

getChildCount

public int getChildCount(java.lang.Object parent)

Returns the number of children of the given parent.

Specified by:

getChildCount in interface javax.swing.tree.TreeModel

Overrides:

getChildCount in class WorkflowOutlineTreeModel

Parameters:

parent - A parent node.

Returns:

The number of children.

getIndexOfChild

public int getIndexOfChild(java.lang.Object parent,
                           java.lang.Object child)

Return the index of the given child within the given parent. If the parent is not contained in the child, return -1.

Specified by:

getIndexOfChild in interface javax.swing.tree.TreeModel

Overrides:

getIndexOfChild in class WorkflowOutlineTreeModel

Parameters:

parent - The parent.

child - The child.

Returns:

The index of the specified child.

isLeaf

public boolean isLeaf(java.lang.Object object)

Returns true if the object is a leaf node.

Specified by:

isLeaf in interface javax.swing.tree.TreeModel

Overrides:

isLeaf in class WorkflowOutlineTreeModel

Parameters:

object - The object.

Returns:

True if the node has no children.

showAll

public void showAll()

Show everything in the tree.

showSubset

public void showSubset()

Show only the nodes containing objects that were called with addToSubset(). Do not call this method until everything to be displayed has been added with addToSubset().