|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.tree.ATreeModel
public abstract class ATreeModel
This model handles generating a tree for admin objects.
Field Summary | |
---|---|
protected AActivitySpace |
m_asOwner
|
protected boolean |
m_bAllChecked
|
protected boolean |
m_bAllowEmptyTreeSubmission
|
protected boolean |
m_bEmptyList
|
protected boolean |
m_bFlatList
|
protected boolean |
m_bHelpEnabled
|
protected boolean |
m_bMultiSelect
|
protected boolean |
m_bShowRoot
|
protected int |
m_nLastExpandedNodeID
|
protected int |
m_nSelectMode
|
protected int |
m_nSelectOptions
|
protected int |
m_nSubmitMode
|
protected TreeCompositeNode |
m_Root
|
protected java.lang.String |
m_strActionSubTitle
|
protected java.lang.String |
m_strOnClickFunction
|
protected java.lang.String |
m_strParentFormItems
|
protected java.lang.String |
m_strParentFormName
|
protected java.lang.String |
m_strParentFormSpaceID
|
protected java.lang.String |
m_strParentFormSubmit
|
protected java.lang.String |
m_strTitle
|
protected XPHashtable |
m_xpmSelectedItems
|
Constructor Summary | |
---|---|
ATreeModel()
|
Method Summary | |
---|---|
void |
CleanupAllData()
This method is called when an ActivitySpace is removed from the cache. |
void |
CleanupTempData()
This method is called at the end of every HTTP request by the Interpreter. |
void |
ClearSelectedItems()
|
abstract 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. |
void |
Finish()
Implement some code to execute when the user clicks on "Finish". |
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. |
protected TreeCompositeNode |
GetCompositeIfAlreadySelected(java.lang.String strKey)
|
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 |
protected java.lang.String |
GetKeyFromNode(TreeLeafNode node)
This function creates a unique key given a node. |
int |
GetLastExpandedNodeID()
Returns the most recently expanded or collapsed node in the tree. |
protected TreeLeafNode |
GetLeafIfAlreadySelected(java.lang.String strKey)
|
boolean |
GetMultipleSelect()
|
abstract java.lang.String |
GetName()
Return the name of the MVC object. |
int |
GetNextUniqueID()
Accessor for managed series of unique tree ids. |
java.lang.String |
GetOnClickFunction()
|
java.lang.String |
GetParentFormName()
|
java.lang.String |
GetParentFormSpaceID()
|
java.lang.String |
GetParentFormSubmitFunction()
|
Redirect |
GetRedirectAfterFinish()
Returns the Redirect object (this is were we need to go at the end of the Editor). |
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()
|
void |
Init(AActivitySpace parent)
This method initializes the model. |
void |
RefreshTree()
This method goes through the selected items list and makes sure that all nodes (including multiply instanced nodes) are correctly selected. |
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. |
int |
SavePage(java.lang.String _sPageName,
XPHashtable _htFormData)
Calls the right save function according to the page name passed in argument. |
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. |
abstract 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)
|
abstract void |
SetObjectIDsToDisplay(int[] nIDs)
This method will display only the given objects. |
abstract void |
SetObjectIDsToHide(int[] nIDs)
This method will hide the given objects. |
abstract 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 nMode)
|
void |
SetTitle(java.lang.String strTitle)
Set the title for the tree popup |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected AActivitySpace m_asOwner
protected java.lang.String m_strActionSubTitle
protected java.lang.String m_strOnClickFunction
protected java.lang.String m_strParentFormItems
protected java.lang.String m_strParentFormName
protected java.lang.String m_strParentFormSpaceID
protected java.lang.String m_strParentFormSubmit
protected java.lang.String m_strTitle
protected TreeCompositeNode m_Root
protected XPHashtable m_xpmSelectedItems
protected boolean m_bFlatList
protected boolean m_bAllChecked
protected boolean m_bMultiSelect
protected boolean m_bShowRoot
protected boolean m_bEmptyList
protected boolean m_bAllowEmptyTreeSubmission
protected boolean m_bHelpEnabled
protected int m_nSelectMode
protected int m_nSelectOptions
protected int m_nSubmitMode
protected int m_nLastExpandedNodeID
Constructor Detail |
---|
public ATreeModel()
Method Detail |
---|
public void ClearSelectedItems()
public void ExpandNode(boolean bExpand, int nNodeID)
ExpandNode
in interface ITreeModel
boolean
- bExpandint
- nNodeID the unique node of the ID in the treepublic int GetLastExpandedNodeID()
GetLastExpandedNodeID
in interface ITreeModelRO
int
- nNodeID the unique node of the ID in the tree that was
most recently expanded or collapsed. -1 implies no node was expanded
or collapsed in the last repost.
public void CleanupTempData()
IModel
CleanupTempData
in interface IModel
IModel.CleanupTempData()
public void CleanupAllData()
IModel
CleanupAllData
in interface IModel
IModel.CleanupAllData()
public abstract java.lang.Object Create()
Create
in interface IManagedObject
public void Finish()
IRepostModel
Finish
in interface IRepostModel
IRepostModel.Finish()
public java.lang.String GetActionSubTitle()
ITreeModelRO
GetActionSubTitle
in interface ITreeModelRO
ITreeModelRO.GetActionSubTitle()
public boolean GetHelpEnabled()
ITreeModelRO
GetHelpEnabled
in interface ITreeModelRO
ITreeModelRO.GetHelpEnabled()
public boolean GetAllowEmptySubmission()
ITreeModelRO
GetAllowEmptySubmission
in interface ITreeModelRO
ITreeModelRO.GetAllowEmptySubmission()
public boolean GetDisplayingFlatList()
ITreeModelRO
GetDisplayingFlatList
in interface ITreeModelRO
ITreeModelRO.GetDisplayingFlatList()
public boolean GetAllChecked()
ITreeModelRO
GetAllChecked
in interface ITreeModelRO
ITreeModelRO.GetDisplayingFlatList()
public boolean GetMultipleSelect()
GetMultipleSelect
in interface ITreeModelRO
public abstract java.lang.String GetName()
IMVCObject
GetName
in interface IMVCObject
IMVCObject.GetName()
public java.lang.String GetOnClickFunction()
GetOnClickFunction
in interface ITreeModelRO
public java.lang.String GetParentFormName()
GetParentFormName
in interface ITreeModelRO
public java.lang.String GetParentFormSpaceID()
GetParentFormSpaceID
in interface ITreeModelRO
public java.lang.String GetParentFormSubmitFunction()
GetParentFormSubmitFunction
in interface ITreeModelRO
public Redirect GetRedirectAfterFinish()
IRepostModel
GetRedirectAfterFinish
in interface IRepostModel
IRepostModel.GetRedirectAfterFinish()
public boolean GetTreeIsEmpty()
GetTreeIsEmpty
in interface ITreeModelRO
ITreeModelRO.GetTreeIsEmpty()
public TreeCompositeIterator GetRootTreeIterator()
GetRootTreeIterator
in interface ITreeModelRO
ITreeModelRO.GetRootTreeIterator()
public int GetSelectMode()
GetSelectMode
in interface ITreeModelRO
public int GetSelectOptions()
GetSelectOptions
in interface ITreeModelRO
public XPArrayList GetSelectedItems()
ITreeModelRO
GetSelectedItems
in interface ITreeModelRO
ITreeModelRO.GetSelectedItems()
public boolean GetShowRoot()
ITreeModelRO
GetShowRoot
in interface ITreeModelRO
ITreeModelRO.GetShowRoot()
public int GetSubmitMode()
GetSubmitMode
in interface ITreeModelRO
ITreeModelRO.GetSubmitMode()
public java.lang.String GetTitle()
ITreeModelRO
GetTitle
in interface ITreeModelRO
ITreeModelRO.GetTitle()
public void Init(AActivitySpace parent)
IModel
Init
in interface IModel
parent
- the parent Activity SpaceIModel.Init(AActivitySpace)
public void RefreshTree()
public void ResetTree()
ITreeModel
ResetTree
in interface ITreeModel
public void ResetUniqueIDs()
ITreeModel
ResetUniqueIDs
in interface ITreeModel
public int SavePage(java.lang.String _sPageName, XPHashtable _htFormData)
IRepostModel
SavePage
in interface IRepostModel
IRepostModel.SavePage(String, XPHashtable)
public void RemoveFromSelection(int classID, int objectID)
ITreeModel
RemoveFromSelection
in interface ITreeModel
classID
- The classID from PT_CLASSIDS of the object to removeobjectID
- The objectID of the object to removeITreeModel.RemoveFromSelection(int classID, int objectID)
public void SetActionSubTitle(java.lang.String strSubTitle)
ITreeModel
SetActionSubTitle
in interface ITreeModel
ITreeModel.SetActionSubTitle(String)
public void SetAllowEmptySubmission(boolean bAllow)
ITreeModel
SetAllowEmptySubmission
in interface ITreeModel
ITreeModel.SetAllowEmptySubmission(boolean)
public void SetHelpTopic(java.lang.String strHelpTopic)
ITreeModel
SetHelpTopic
in interface ITreeModel
ITreeModel.SetHelpTopic(String)
public abstract void SetClassIDsToDisplay(int[] nIDs)
ITreeModel
SetClassIDsToDisplay
in interface ITreeModel
nIDs
- public void SetMultipleSelect(boolean bMultiSelect)
SetMultipleSelect
in interface ITreeModel
bMultiSelect
- public abstract void SetObjectIDsToDisplay(int[] nIDs)
ITreeModel
SetObjectIDsToDisplay
in interface ITreeModel
nIDs
- public abstract void SetObjectIDsToHide(int[] nIDs)
ITreeModel
SetObjectIDsToHide
in interface ITreeModel
nIDs
- public abstract void SetObjectIDsToSelect(int[] nIDs)
ITreeModel
SetObjectIDsToSelect
in interface ITreeModel
nIDs
- public int GetNextUniqueID()
ITreeModel
GetNextUniqueID
in interface ITreeModel
public void SetOnClickFunction(java.lang.String name)
SetOnClickFunction
in interface ITreeModel
name
- public void SetParentFormName(java.lang.String name)
SetParentFormName
in interface ITreeModel
name
- public void SetParentFormSpaceID(java.lang.String name)
SetParentFormSpaceID
in interface ITreeModel
name
- public void SetParentFormSubmitFunction(java.lang.String name)
SetParentFormSubmitFunction
in interface ITreeModel
name
- public void SetSelectMode(int nSelectMode)
SetSelectMode
in interface ITreeModel
nSelectMode
- public void SetSelectOptions(int nSelectOptions)
SetSelectOptions
in interface ITreeModel
nSelectOptions
- public void SetShowRoot(boolean bShowRoot)
ITreeModel
SetShowRoot
in interface ITreeModel
ITreeModel.SetShowRoot(boolean)
public void SetSubmitMode(int nMode)
SetSubmitMode
in interface ITreeModel
ITreeModel.SetSubmitMode(int)
public void SetTitle(java.lang.String strTitle)
ITreeModel
SetTitle
in interface ITreeModel
ITreeModel.SetTitle(String)
protected TreeCompositeNode GetCompositeIfAlreadySelected(java.lang.String strKey)
strKey
-
protected TreeLeafNode GetLeafIfAlreadySelected(java.lang.String strKey)
strKey
-
protected java.lang.String GetKeyFromNode(TreeLeafNode node)
node
-
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |