|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTTreeIterator
IPTTreeIterator allows clients to walk a tree of information in a generic manner (e.g. to write a generic tree UI.) An implementation of IPTTreeIterator is stateful. Clients can walk the tree by calling Children to get information about children of the current location, then calling MoveTo to reset the state to be at the location of a child. By calling Children and MoveTo, a client can navigate the entire tree. Helper functions like MoveToParent and MoveToRoot make it easier to implement a client that walks the tree in an application specific manner.
Method Summary | |
---|---|
java.lang.Object[][] |
Children(int lStart,
int lCount)
Returns information about the children of the current location. |
java.lang.Object[][] |
CurrentLocInfo()
Retrieve information about the current location. |
boolean |
GetAtRoot()
Is this iterator at root? |
int |
GetChildCount()
Returns the number of children (both nodes and containers) of the current location. |
java.lang.String |
GetLocation()
Retrieve the identifier of the current location |
int |
GetStyle()
Returns the current display style, from PT_TREE_ITERATOR_STYLES. |
void |
InitializeIterator(java.lang.Object varInitArg)
Each iterator implmentation requires it's own type of initialization information. |
void |
MoveTo(java.lang.String sLocation)
Move to a specified location in the tree. |
void |
MoveToParent()
Move "up" one position in the tree, to the parent of the current node |
void |
MoveToRoot()
Move to the root of the tree |
void |
SetStyle(int Value)
Sets the current display style, to a value from PT_TREE_ITERATOR_STYLES. |
Method Detail |
---|
int GetStyle()
PT_TREE_ITERATOR_STYLES
void SetStyle(int Value)
Value
- the desired stylePT_TREE_ITERATOR_STYLES
int GetChildCount()
java.lang.Object[][] Children(int lStart, int lCount)
lStart
- number of rows to skip at the beginning, or 0 for nonelCount
- maximum number of rows to return, or -1 for all
PT_TREE_ITERATOR_CHILD_INFO
void MoveToParent()
void MoveToRoot()
void MoveTo(java.lang.String sLocation)
sLocation
- the location to which to movejava.lang.String GetLocation()
java.lang.Object[][] CurrentLocInfo()
boolean GetAtRoot()
void InitializeIterator(java.lang.Object varInitArg)
varInitArg
- the initialization information, in an implementation
specific format
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |