com.plumtree.portaluiinfrastructure.tree
Class ServerTreeModel

java.lang.Object
  com.plumtree.uiinfrastructure.tree.ATreeModel
      com.plumtree.portaluiinfrastructure.tree.ServerTreeModel

All Implemented Interfaces:

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

public class ServerTreeModel
extends ATreeModel
implements ITreeModel, ITreeModelRO, IRepostModel, IServerTreeModel

Author:

Don Hayler This class allows you to browse IPTTreeIterator interfaces the same way you browse admin and card objects.

Field Summary

static int	m_nCOMMPAGE_TREE Community Page Type
static int	m_nPROP_PICK_TREE Interface types -- This should probably be an enum
protected IPTTreeIterator	m_ptIterator Private data members
static int	s_nSITEMAP_TREE Site Map Type
static java.lang.String	STR_MVC_CLASS_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

ServerTreeModel()

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) Expand or collapse a node in the tree.
protected java.lang.String	GetKeyFromNode(TreeLeafNode node) This function creates a unique key given a node.
java.lang.String	GetName() Return the name of the MVC object.
void	Init(AActivitySpace parent) This method initializes the model.
void	SetClassIDsToDisplay(int[] nIDs) This method will set the class IDs to be displayed.
void	SetIterator(int nInterfaceType, java.lang.String strInitData) This method initializes the model to a particular IPTTreeIterator Each iterator type will need custom code in this method.
void	SetLocationsToHide(java.lang.String strLocs) Note: because of the fact that locations may contain commas (','), we use the semi-colon (';') to delimit the locations.
void	SetLocationsToSelect(java.lang.String strLocs) Note: because of the fact that locations may contain commas (','), we use the semi-colon (';') to delimit the locations.
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.

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

CleanupAllData, CleanupTempData, ClearSelectedItems, Finish, GetActionSubTitle, GetAllChecked, GetAllowEmptySubmission, GetCompositeIfAlreadySelected, GetDisplayingFlatList, GetHelpEnabled, 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

See Also:

Constant Field Values

m_nPROP_PICK_TREE

public static final int m_nPROP_PICK_TREE

Interface types -- This should probably be an enum

See Also:

Constant Field Values

s_nSITEMAP_TREE

public static final int s_nSITEMAP_TREE

Site Map Type

See Also:

Constant Field Values

m_nCOMMPAGE_TREE

public static final int m_nCOMMPAGE_TREE

Community Page Type

See Also:

Constant Field Values

m_ptIterator

protected IPTTreeIterator m_ptIterator

Private data members

Constructor Detail

ServerTreeModel

public ServerTreeModel()

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)

Description copied from class: ATreeModel

Expand or collapse a node in the tree. This method is responsible for updating the last expanded node member (m_nLastExpandedNodeID).

Specified by:

ExpandNode in interface ITreeModel

Overrides:

ExpandNode in class ATreeModel

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()

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)

SetClassIDsToDisplay

public void SetClassIDsToDisplay(int[] nIDs)

Description copied from interface: ITreeModel

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

Specified by:

SetClassIDsToDisplay in interface ITreeModel

Specified by:

SetClassIDsToDisplay in class ATreeModel

SetIterator

public void SetIterator(int nInterfaceType,
                        java.lang.String strInitData)

This method initializes the model to a particular IPTTreeIterator Each iterator type will need custom code in this method. strInitData can be null.

SetObjectIDsToDisplay

public void SetObjectIDsToDisplay(int[] nIDs)

Description copied from interface: ITreeModel

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

Specified by:

SetObjectIDsToDisplay in interface ITreeModel

Specified by:

SetObjectIDsToDisplay in class ATreeModel

See Also:

ITreeModel.SetObjectIDsToDisplay(int[])

SetObjectIDsToHide

public void SetObjectIDsToHide(int[] nIDs)

Description copied from interface: ITreeModel

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

Specified by:

SetObjectIDsToHide in interface ITreeModel

Specified by:

SetObjectIDsToHide in class ATreeModel

See Also:

ITreeModel.SetObjectIDsToHide(int[])

SetObjectIDsToSelect

public void SetObjectIDsToSelect(int[] nIDs)

Description copied from interface: ITreeModel

This method will select the given objects.

Specified by:

SetObjectIDsToSelect in interface ITreeModel

Specified by:

SetObjectIDsToSelect in class ATreeModel

Parameters:

nIDs -

SetLocationsToSelect

public void SetLocationsToSelect(java.lang.String strLocs)

Note: because of the fact that locations may contain commas (','), we use the semi-colon (';') to delimit the locations. Be sure to pass in strings with semi-colon delimted strings.

Specified by:

SetLocationsToSelect in interface IServerTreeModel

See Also:

com.plumtree.portaluiinfrastructure.tree.IServerTreeModel#SetLocationsToSelect(String[])

SetLocationsToHide

public void SetLocationsToHide(java.lang.String strLocs)

Note: because of the fact that locations may contain commas (','), we use the semi-colon (';') to delimit the locations. Be sure to pass in strings with semi-colon delimted strings.

Specified by:

SetLocationsToHide in interface IServerTreeModel

See Also:

IServerTreeModel.SetLocationsToHide(String)

GetKeyFromNode

protected java.lang.String GetKeyFromNode(TreeLeafNode node)

Description copied from class: ATreeModel

This function creates a unique key given a node. It is used to store items in XPHashtables. Override this function if your tree's nodes can't be differentiated by "classid, objectid"

Overrides:

GetKeyFromNode in class ATreeModel

Returns:

String

See Also:

ATreeModel.GetKeyFromNode(TreeLeafNode)