com.starteam
Class ViewMemberListManager.GroupNode

java.lang.Object
  com.starteam.ViewMemberListManager.GroupNode

Enclosing class:

ViewMemberListManager

public static final class ViewMemberListManager.GroupNode
extends java.lang.Object

Describes a group of objects that may be a subgroup of a larger, indexable group. Maintains a range mapping into the underlying ordered collection. Each Node may be in an expanded or collapsed state. Note that it is the client's responsibility to ensure valid index ranges relative to the underlying collection.

Method Summary

void	addChild(ViewMemberListManager.GroupNode child) Adds a GroupNode as a child of this GroupNode.
ViewMemberListManager.GroupNode[]	getChildren() Returns the direct subgroups of this group.
java.lang.String	getDebugString() Prints a String representation of the GroupNode, helpful for debugging.
int	getDepth() Returns the zero-based depth of this GroupNode in the grouping hierarchy.
int	getLength() Returns the number of contiguous objects spanned in the underlying indexable collection.
java.lang.String	getName() Returns the display name of this group.
int	getNumChildren() Returns the number of direct subgroups of this group.
int	getNumVisibleLines() Returns the number of visible lines represented in this node, based on the current collapsed/expanded state of the hierarchy.
ViewMemberListManager.GroupNode	getParent() Returns the parent GroupNode.
int	getStart() Returns the index of the first leaf object of this node in the associated indexable collection.
boolean	isExpanded() Returns true if this GroupNode is expanded.
boolean	isLeafNode() Returns true if this is a leaf-level GroupNode.
void	setExpanded(boolean bExpand) Expands or collapses this GroupNode.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Returns the display name of this group.

Returns:

the display name of this group.

getDepth

public int getDepth()

Returns the zero-based depth of this GroupNode in the grouping hierarchy.

Returns:

the zero-based depth of this GroupNode in the grouping hierarchy.

isExpanded

public boolean isExpanded()

Returns true if this GroupNode is expanded.

Returns:

true if this GroupNode is expanded.

setExpanded

public void setExpanded(boolean bExpand)

Expands or collapses this GroupNode.

Parameters:

bExpand - true = expand, false = collapse.

getNumChildren

public int getNumChildren()

Returns the number of direct subgroups of this group.

Returns:

the number of direct subgroups of this group.

getChildren

public ViewMemberListManager.GroupNode[] getChildren()

Returns the direct subgroups of this group.

Returns:

the direct subgroups of this group.

isLeafNode

public boolean isLeafNode()

Returns true if this is a leaf-level GroupNode.

Returns:

true if this is a leaf-level GroupNode.

getParent

public ViewMemberListManager.GroupNode getParent()

Returns the parent GroupNode.

Returns:

the parent GroupNode.

addChild

public void addChild(ViewMemberListManager.GroupNode child)

Adds a GroupNode as a child of this GroupNode.

Parameters:

child - The GroupNode to add as a child of this one.

getNumVisibleLines

public int getNumVisibleLines()

Returns the number of visible lines represented in this node, based on the current collapsed/expanded state of the hierarchy.

Returns:

the number of visible lines represented in this node, based on the current collapsed/expanded state of the hierarchy.

getStart

public int getStart()

Returns the index of the first leaf object of this node in the associated indexable collection.

Returns:

the index of the first leaf object of this node in the associated indexable collection.

getLength

public int getLength()

Returns the number of contiguous objects spanned in the underlying indexable collection.

Returns:

the number of contiguous objects spanned in the underlying indexable collection.

getDebugString

public java.lang.String getDebugString()

Prints a String representation of the GroupNode, helpful for debugging.