com.plumtree.uiinfrastructure.tree
Interface ITreeModel

All Superinterfaces:

IModelRO, IMVCObject, ITreeModelRO

All Known Implementing Classes:

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

public interface ITreeModel
extends ITreeModelRO

This interface contains all of the writable (set) methods that a tree model must implement.

Author:

Don Hayler

Method Summary

void	ExpandNode(boolean bExpand, int nNodeID) Expand or collapse a node in the tree
int	GetNextUniqueID() Accessor for managed series of unique tree ids.
void	RemoveFromSelection(int classID, int objectID) Removes an object from the selected items if it exists and is selected.
void	ResetTree() This method initializes tree variables.
void	ResetUniqueIDs() This resets the unique tree ids.
void	SetActionSubTitle(java.lang.String strSubTitle) Set the action sub-title for the tree popup I.E.
void	SetAllowEmptySubmission(boolean bAllow) Allow users to click finish on trees without selecting anything.
void	SetClassIDsToDisplay(int[] nIDs) This method will set the class IDs to be displayed.
void	SetHelpTopic(java.lang.String strHelpTopic) Set the help topic for the tree popup
void	SetMultipleSelect(boolean bMultiSelect)
void	SetObjectIDsToDisplay(int[] nIDs) This method will display only the given objects.
void	SetObjectIDsToHide(int[] nIDs) This method will hide the given objects.
void	SetObjectIDsToSelect(int[] nIDs) This method will select the given objects.
void	SetOnClickFunction(java.lang.String name)
void	SetParentFormName(java.lang.String name)
void	SetParentFormSpaceID(java.lang.String name)
void	SetParentFormSubmitFunction(java.lang.String name)
void	SetSelectMode(int nSelectMode)
void	SetSelectOptions(int nSelectOptions)
void	SetShowRoot(boolean bShowRoot) This method sets whether or not to show the root folder.
void	SetSubmitMode(int nSubmitMode)
void	SetTitle(java.lang.String strTitle) Set the title for the tree popup

Methods inherited from interface com.plumtree.uiinfrastructure.tree.ITreeModelRO

GetActionSubTitle, GetAllChecked, GetAllowEmptySubmission, GetDisplayingFlatList, GetHelpEnabled, GetLastExpandedNodeID, GetMultipleSelect, GetOnClickFunction, GetParentFormName, GetParentFormSpaceID, GetParentFormSubmitFunction, GetRootTreeIterator, GetSelectedItems, GetSelectMode, GetSelectOptions, GetShowRoot, GetSubmitMode, GetTitle, GetTreeIsEmpty

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

GetName

Method Detail

ExpandNode

void ExpandNode(boolean bExpand,
                int nNodeID)

Expand or collapse a node in the tree

GetNextUniqueID

int GetNextUniqueID()

Accessor for managed series of unique tree ids. All objects in a folder should have sequential tree ids.

ResetTree

void ResetTree()

This method initializes tree variables. sub-classes can extend this method.

ResetUniqueIDs

void ResetUniqueIDs()

This resets the unique tree ids. This should only be called when resetting the entire tree.

SetActionSubTitle

void SetActionSubTitle(java.lang.String strSubTitle)

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

Parameters:

String - the action sub-title

SetHelpTopic

void SetHelpTopic(java.lang.String strHelpTopic)

Set the help topic for the tree popup

Parameters:

String - the help topic

SetAllowEmptySubmission

void SetAllowEmptySubmission(boolean bAllow)

Allow users to click finish on trees without selecting anything.

Parameters:

boolean - true implies allow

SetClassIDsToDisplay

void SetClassIDsToDisplay(int[] nIDs)

This method will set the class IDs to be displayed. This must be run before SetObjectIDsToHide() and SetObjectIDsToSelect().

Parameters:

int[] - nIDs the class IDs to show

SetMultipleSelect

void SetMultipleSelect(boolean bMultiSelect)

Parameters:

bMultiSelect -

SetObjectIDsToDisplay

void SetObjectIDsToDisplay(int[] nIDs)

This method will display only the given objects. Only this method or SetObjectIDsToHide() can be called, not both.

Parameters:

int[] - nIDs classID1,objectID1,classID2,objectID2,etc...

SetObjectIDsToHide

void SetObjectIDsToHide(int[] nIDs)

This method will hide the given objects. Only this method or SetObjectIDsToDisplay() can be called, not both.

Parameters:

int[] - nIDs classID1,objectID1,classID2,objectID2,etc...

SetObjectIDsToSelect

void SetObjectIDsToSelect(int[] nIDs)

This method will select the given objects.

Parameters:

int[] - nIDs classID1,objectID1,classID2,objectID2,etc...

RemoveFromSelection

void RemoveFromSelection(int classID,
                         int objectID)

Removes an object from the selected items if it exists and is selected. The pair of classID,objectID uniquely identify each object. This method has no effect if the object does not exist or is not selected. This method does not throw exceptions but does log errors.

Parameters:

classID - The classID from PT_CLASSIDS of the object to remove

objectID - The objectID of the object to remove

SetOnClickFunction

void SetOnClickFunction(java.lang.String name)

Parameters:

name -

SetParentFormName

void SetParentFormName(java.lang.String name)

Parameters:

name -

SetParentFormSpaceID

void SetParentFormSpaceID(java.lang.String name)

Parameters:

name -

SetParentFormSubmitFunction

void SetParentFormSubmitFunction(java.lang.String name)

Parameters:

name -

SetSelectMode

void SetSelectMode(int nSelectMode)

Parameters:

nSelectMode -

SetSelectOptions

void SetSelectOptions(int nSelectOptions)

Parameters:

nSelectOptions -

SetShowRoot

void SetShowRoot(boolean bShowRoot)

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

Parameters:

boolean - true implies show root (default)

SetSubmitMode

void SetSubmitMode(int nSubmitMode)

Parameters:

nSubmitMode -

SetTitle

void SetTitle(java.lang.String strTitle)

Set the title for the tree popup

Parameters:

String - the title