com.plumtree.uiinfrastructure.tree
Interface ITreeModelRO

All Superinterfaces:

IModelRO, IMVCObject

All Known Subinterfaces:

IObjectTreeModel, IObjectTreeModelRO, ITreeModel

All Known Implementing Classes:

ActivityRightsTreeModel, AdminTreeModel, AObjectTreeModel, ATreeModel, CredVaultTreeModel, DirectoryTreeModel, GlobalObjsTreeModel, ServerTreeModel, TemplateTreeModel, UserInfoTreeModel

public interface ITreeModelRO
extends IModelRO

This interface provides read only access to the tree.

Author:

Don Hayler

Method Summary

java.lang.String	GetActionSubTitle() Get the action sub-title for the tree popup I.E.
boolean	GetAllChecked() This method returns whether or not the check all box in the tree should be pre-selected or not.
boolean	GetAllowEmptySubmission() Whether or not users are allowed to click finish on trees without selecting anything.
boolean	GetDisplayingFlatList() This method returns whether or not the tree is displaying as a flat list, or as a tree.
boolean	GetHelpEnabled() Gets whether or not help is enabled
int	GetLastExpandedNodeID()
boolean	GetMultipleSelect()
java.lang.String	GetOnClickFunction()
java.lang.String	GetParentFormName()
java.lang.String	GetParentFormSpaceID()
java.lang.String	GetParentFormSubmitFunction()
TreeCompositeIterator	GetRootTreeIterator()
XPArrayList	GetSelectedItems() This returns an array of the currently selected objects/folders in the tree.
int	GetSelectMode()
int	GetSelectOptions()
boolean	GetShowRoot() This method returns whether or not to show the root folder.
int	GetSubmitMode()
java.lang.String	GetTitle() Get the title for the tree popup
boolean	GetTreeIsEmpty()

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject

GetName

Method Detail

GetActionSubTitle

java.lang.String GetActionSubTitle()

Get the action sub-title for the tree popup I.E. select a user

Returns:

String the non-HTML Encoded action sub-title

GetHelpEnabled

boolean GetHelpEnabled()

Gets whether or not help is enabled

Returns:

boolean true implies enabled.

GetAllowEmptySubmission

boolean GetAllowEmptySubmission()

Whether or not users are allowed to click finish on trees without selecting anything.

Returns:

boolean true implies allow

GetDisplayingFlatList

boolean GetDisplayingFlatList()

This method returns whether or not the tree is displaying as a flat list, or as a tree. Flat lists are displayed for smaller numbers of items.

GetAllChecked

boolean GetAllChecked()

This method returns whether or not the check all box in the tree should be pre-selected or not.

GetMultipleSelect

boolean GetMultipleSelect()

Returns:

GetOnClickFunction

java.lang.String GetOnClickFunction()

Returns:

GetParentFormName

java.lang.String GetParentFormName()

Returns:

GetParentFormSpaceID

java.lang.String GetParentFormSpaceID()

Returns:

GetParentFormSubmitFunction

java.lang.String GetParentFormSubmitFunction()

Returns:

GetTreeIsEmpty

boolean GetTreeIsEmpty()

Returns:

GetRootTreeIterator

TreeCompositeIterator GetRootTreeIterator()

Returns:

GetSelectMode

int GetSelectMode()

Returns:

GetSelectOptions

int GetSelectOptions()

Returns:

GetLastExpandedNodeID

int GetLastExpandedNodeID()

Returns:

GetSelectedItems

XPArrayList GetSelectedItems()

This returns an array of the currently selected objects/folders in the tree.

Returns:

XPArrayList of TreeLeafNode objects

GetShowRoot

boolean GetShowRoot()

This method returns whether or not to show the root folder.

GetSubmitMode

int GetSubmitMode()

Returns:

GetTitle

java.lang.String GetTitle()

Get the title for the tree popup

Returns:

String the non-HTML Encoded title