com.plumtree.portalpages.admin.editors.webservice.userinfotree
Class UserInfoTreeModel

java.lang.Object
  com.plumtree.uiinfrastructure.tree.ATreeModel
      com.plumtree.portalpages.admin.editors.webservice.userinfotree.UserInfoTreeModel

All Implemented Interfaces:

IManagedObject, IModel, IModelRO, IMVCObject, IRepostModel, ITreeModel, ITreeModelRO

public class UserInfoTreeModel
extends ATreeModel
implements ITreeModel, ITreeModelRO, IRepostModel

This version of the tree allows for browsing and selecting of objects with no hierarchical structure

Author:

AdolfoC

Field Summary

protected IPTTreeIterator	m_ptIterator Tree iterator
protected XPArrayList	m_xpalKnownUserInfos Storage for the list of all known user infos.
protected XPArrayList	m_xpalSelected
static java.lang.String	STR_MVC_CLASS_NAME object name

Fields inherited from class com.plumtree.uiinfrastructure.tree.ATreeModel

m_asOwner, m_bAllChecked, m_bAllowEmptyTreeSubmission, m_bEmptyList, m_bFlatList, m_bHelpEnabled, m_bMultiSelect, m_bShowRoot, m_nLastExpandedNodeID, m_nSelectMode, m_nSelectOptions, m_nSubmitMode, m_Root, m_strActionSubTitle, m_strOnClickFunction, m_strParentFormItems, m_strParentFormName, m_strParentFormSpaceID, m_strParentFormSubmit, m_strTitle, m_xpmSelectedItems

Constructor Summary

UserInfoTreeModel()

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	ExpandNode(boolean bExpand, int nNodeID) This is called when a node is expanded.
java.lang.String	GetName() Return the name of the MVC object.
XPArrayList	GetTreeUserInfos() Returns the list of UserInfo strings that the Tree knows about (is displaying).
void	Init(AActivitySpace parent) This method initializes the model.
void	LoadUserInfo() Initializes and begins the loading of the tree.
void	SetClassIDsToDisplay(int[] nIDs) If there are multiple class ids, determine which ones to display.
void	SetObjectIDsToDisplay(int[] nIDs) Determines what items in the tree are to be displayed.
void	SetObjectIDsToHide(int[] nIDs) Determines what items in the tree are hidden.
void	SetObjectIDsToSelect(int[] nIDs) Determines what items in the tree are selected.
void	SetUserInfosToSelect(XPArrayList xpalUserInfos) Sets the userinfos that are currently selected.

Methods inherited from class com.plumtree.uiinfrastructure.tree.ATreeModel

CleanupAllData, CleanupTempData, ClearSelectedItems, Finish, GetActionSubTitle, GetAllChecked, GetAllowEmptySubmission, GetCompositeIfAlreadySelected, GetDisplayingFlatList, GetHelpEnabled, GetKeyFromNode, GetLastExpandedNodeID, GetLeafIfAlreadySelected, GetMultipleSelect, GetNextUniqueID, GetOnClickFunction, GetParentFormName, GetParentFormSpaceID, GetParentFormSubmitFunction, GetRedirectAfterFinish, GetRootTreeIterator, GetSelectedItems, GetSelectMode, GetSelectOptions, GetShowRoot, GetSubmitMode, GetTitle, GetTreeIsEmpty, RefreshTree, RemoveFromSelection, ResetTree, ResetUniqueIDs, SavePage, SetActionSubTitle, SetAllowEmptySubmission, SetHelpTopic, SetMultipleSelect, SetOnClickFunction, SetParentFormName, SetParentFormSpaceID, SetParentFormSubmitFunction, SetSelectMode, SetSelectOptions, SetShowRoot, SetSubmitMode, SetTitle

Methods inherited from class java.lang.Object

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

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

GetNextUniqueID, RemoveFromSelection, ResetTree, ResetUniqueIDs, SetActionSubTitle, SetAllowEmptySubmission, SetHelpTopic, SetMultipleSelect, SetOnClickFunction, SetParentFormName, SetParentFormSpaceID, SetParentFormSubmitFunction, SetSelectMode, SetSelectOptions, SetShowRoot, SetSubmitMode, SetTitle

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.form.IRepostModel

Finish, GetRedirectAfterFinish, SavePage

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

CleanupAllData, CleanupTempData

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

object name

See Also:

Constant Field Values

m_ptIterator

protected IPTTreeIterator m_ptIterator

Tree iterator

m_xpalKnownUserInfos

protected XPArrayList m_xpalKnownUserInfos

Storage for the list of all known user infos. This is used in order to get the UserInfo string based on the index into this array (the index is used in place of an object ID to uniquely identify each User Info).

m_xpalSelected

protected XPArrayList m_xpalSelected

Constructor Detail

UserInfoTreeModel

public UserInfoTreeModel()

Method Detail

Create

public java.lang.Object Create()

Description copied from class: ATreeModel

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Specified by:

Create in class ATreeModel

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

ExpandNode

public void ExpandNode(boolean bExpand,
                       int nNodeID)

This is called when a node is expanded. Since User Info is a flat list, there will be no recursive thoughts here. This simply retrieves all the User Info available to the user and puts it on the tree as leaf items.

Specified by:

ExpandNode in interface ITreeModel

Overrides:

ExpandNode in class ATreeModel

Parameters:

bExpand - expands the branch

nNodeID - the uniqueid for this node

GetName

public java.lang.String GetName()

Description copied from interface: IMVCObject

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class ATreeModel

Returns:

the name of the object.

See Also:

IMVCObject.GetName()

GetTreeUserInfos

public XPArrayList GetTreeUserInfos()

Returns the list of UserInfo strings that the Tree knows about (is displaying).

Returns:

XPArrayList

Init

public void Init(AActivitySpace parent)

Description copied from interface: IModel

This method initializes the model. This is called automatically when AActivitySpace.RegisterModel() is called.

Specified by:

Init in interface IModel

Overrides:

Init in class ATreeModel

Parameters:

parent - the parent Activity Space

See Also:

IModel.Init(AActivitySpace)

LoadUserInfo

public void LoadUserInfo()

Initializes and begins the loading of the tree.

SetClassIDsToDisplay

public void SetClassIDsToDisplay(int[] nIDs)

If there are multiple class ids, determine which ones to display. For User Info, we only have 1 class id, so this method is unimplemented.

Specified by:

SetClassIDsToDisplay in interface ITreeModel

Specified by:

SetClassIDsToDisplay in class ATreeModel

Parameters:

nIDs - determines which classids to display

SetObjectIDsToDisplay

public void SetObjectIDsToDisplay(int[] nIDs)

Determines what items in the tree are to be displayed.

Specified by:

SetObjectIDsToDisplay in interface ITreeModel

Specified by:

SetObjectIDsToDisplay in class ATreeModel

Parameters:

nIDs - determines which nodes are not hidden.

See Also:

ITreeModel.SetObjectIDsToDisplay(int[])

SetObjectIDsToHide

public void SetObjectIDsToHide(int[] nIDs)

Determines what items in the tree are hidden.

Specified by:

SetObjectIDsToHide in interface ITreeModel

Specified by:

SetObjectIDsToHide in class ATreeModel

Parameters:

nIDs - determines which nodes are hidden

See Also:

ITreeModel.SetObjectIDsToHide(int[])

SetObjectIDsToSelect

public void SetObjectIDsToSelect(int[] nIDs)

Determines what items in the tree are selected.

Specified by:

SetObjectIDsToSelect in interface ITreeModel

Specified by:

SetObjectIDsToSelect in class ATreeModel

Parameters:

nIDs - determines which nodes are selected

SetUserInfosToSelect

public void SetUserInfosToSelect(XPArrayList xpalUserInfos)

Sets the userinfos that are currently selected.

Parameters:

arsUserInfos -