com.plumtree.uiinfrastructure.tree
Class ATreeAS

java.lang.Object
  extended by com.plumtree.uiinfrastructure.activityspace.AActivitySpace
      extended by com.plumtree.uiinfrastructure.form.AFormAS
          extended by com.plumtree.uiinfrastructure.tree.ATreeAS
All Implemented Interfaces:
IManagedObject, IMVCObject, IFormAS, IEnvironment
Direct Known Subclasses:
ActivityRightsTreeAS, CredVaultTreeAS, ServerTreeAS, TreeAS, UserInfoTreeAS

public abstract class ATreeAS
extends AFormAS
implements IFormAS

Author:
Don Hayler

Field Summary
static java.lang.String JS_PARENT_CLOSE
          Non-localized Strings
static int MAX_DISPLAYED_NAME_LENGTH
          The maximum length of names of objects when displayed.
static java.lang.String OBJECT_CLASS_ID
          The name of the javascript array member variable for the class id
static java.lang.String OBJECT_NAME
          The name of the javascript array member variable for the object name
static java.lang.String OBJECT_OBJECT_ID
          The name of the javascript array member variable for the object id
static java.lang.String TREE_BAR_ANCHOR
          anchor name for tree bar.
static java.lang.String TREECLOSEPOPUP
          storage name for ClosePopUpDP (used for closing the TreeDP only)
static java.lang.String TREEMODEL
          storage name for tree model (no matter what type of model it is)
 
Fields inherited from class com.plumtree.uiinfrastructure.form.AFormAS
JAVASCRIPT_GVAR_PTHELPSVRBASEURL, JAVASCRIPT_GVAR_PTIMGSVRIMGSURL, JAVASCRIPT_GVAR_SHAREDIMGSVRIMGSURL
 
Fields inherited from class com.plumtree.uiinfrastructure.activityspace.AActivitySpace
m_stringReferences
 
Constructor Summary
ATreeAS()
           
 
Method Summary
 void CleanupTempData()
          This method is called at the end of every HTTP request by the Interpreter.
abstract  java.lang.String GetName()
          This method is used to identify the type of this space.
 IDisplayPage GetPage(java.lang.String pageName)
          This method handles the ClosePopUpDP and passes everything else to the base implementation.
 java.lang.String GetRepostControlName()
          Returns the name of the repost control class.
 java.lang.String GetTreeSpecificArrayDataToAppend(int iSelectedItemIndex)
          Override this method to attach additional information specific to your implementation of the tree.
 void Init()
          Initialize the Activity Space.
 
Methods inherited from class com.plumtree.uiinfrastructure.form.AFormAS
DisplayCommonJavaScript
 
Methods inherited from class com.plumtree.uiinfrastructure.activityspace.AActivitySpace
ChangeSubSpaceKey, CheckBasicAccess, CleanupAllData, Create, DeleteSubSpace, GetAccessStyle, GetApplication, GetControl, GetControlExists, GetControlsEnumerator, GetCurrentFormData, GetCurrentHTTPRequest, GetCurrentHTTPResponse, GetCurrentNormalizedBaseURL, GetCurrentPage, GetCurrentRequestURL, GetHelpTopic, GetIsAccessStyleNonStandard, GetIsAccessStyleStandard, GetIsInPlaceRefreshDisplayOn, GetIsInPlaceRefreshEnabled, GetIsSecuredSpace, GetLanguage, GetLocale, GetModel, GetModelExists, GetModelsEnumerator, GetPageExists, GetPagesEnumerator, GetParentSpace, GetParentSpaceID, GetParentSpaceName, GetPersistentSubSession, GetResourceManager, GetSpaceID, GetString, GetStyleSheetLinks, GetSubSession, GetSubSpace, GetSubSpaceExists, GetSubSpaceKey, GetSubSpacesEnumerator, GetTimeZone, GetUserSession, GetVarPack, GetView, GetViewExists, GetViewsEnumerator, IsSubSpace, refString, RegisterControl, RegisterControl, RegisterModel, RegisterModel, RegisterPage, RegisterPage, RegisterSubSpace, RegisterView, RegisterView, ReInit, SetApplication, SetCurrentFormData, SetCurrentHTTPRequestResponseObjects, SetCurrentPage, SetCurrentRequestURL, SetHelpTopic, SetIsASSecured, SetIsInPlaceRefreshDisplayOn, SetIsInPlaceRefreshEnabled, SetOverWriteSubSpaces, SetParentSpace, SetPersistentSubSession, SetSpaceID, SetSubSession, SetSubSpaceKey, SetTrackCurrentPage, SetUserSession, unrefString, UnRegisterControl, UnRegisterModel, UnRegisterPage, UnRegisterView
 
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.form.IFormAS
DisplayCommonJavaScript
 

Field Detail

TREEMODEL

public static final java.lang.String TREEMODEL
storage name for tree model (no matter what type of model it is)

See Also:
Constant Field Values

TREECLOSEPOPUP

public static final java.lang.String TREECLOSEPOPUP
storage name for ClosePopUpDP (used for closing the TreeDP only)

See Also:
Constant Field Values

TREE_BAR_ANCHOR

public static final java.lang.String TREE_BAR_ANCHOR
anchor name for tree bar.

See Also:
Constant Field Values

MAX_DISPLAYED_NAME_LENGTH

public static final int MAX_DISPLAYED_NAME_LENGTH
The maximum length of names of objects when displayed. This is actually the max length a word can be before the entire string gets truncated.

See Also:
Constant Field Values

JS_PARENT_CLOSE

public static final java.lang.String JS_PARENT_CLOSE
Non-localized Strings

See Also:
Constant Field Values

OBJECT_NAME

public static final java.lang.String OBJECT_NAME
The name of the javascript array member variable for the object name

See Also:
Constant Field Values

OBJECT_OBJECT_ID

public static final java.lang.String OBJECT_OBJECT_ID
The name of the javascript array member variable for the object id

See Also:
Constant Field Values

OBJECT_CLASS_ID

public static final java.lang.String OBJECT_CLASS_ID
The name of the javascript array member variable for the class id

See Also:
Constant Field Values
Constructor Detail

ATreeAS

public ATreeAS()
Method Detail

GetName

public abstract java.lang.String GetName()
Description copied from class: AActivitySpace
This method is used to identify the type of this space.

Specified by:
GetName in interface IMVCObject
Specified by:
GetName in class AFormAS
Returns:
String the name of this AActivitySpace
See Also:
AActivitySpace.GetName()

CleanupTempData

public final void CleanupTempData()
This method is called at the end of every HTTP request by the Interpreter. This method then calls IModel.CleanupTempData() on all IModels registered using RegisterModel(). This method is intended for cleaning up temporary data that is only used for the lifetime of a single request, like DB query results.

Overrides:
CleanupTempData in class AActivitySpace
See Also:
AActivitySpace.CleanupTempData()

GetPage

public IDisplayPage GetPage(java.lang.String pageName)
This method handles the ClosePopUpDP and passes everything else to the base implementation. It adds javascript to the ClosePopUpDP that sets the selected items on the opener window (if it's a remote tree) and calls a javascript function on the opener window.

Overrides:
GetPage in class AActivitySpace
Returns:
IDisplayPage the requested page
See Also:
AActivitySpace.GetPage(String)

GetTreeSpecificArrayDataToAppend

public java.lang.String GetTreeSpecificArrayDataToAppend(int iSelectedItemIndex)
Override this method to attach additional information specific to your implementation of the tree. Below is an example of how to do this. ITreeModelRO myModel = (ITreeModelRO) GetModel(TREEMODEL); XPArrayList mySelectedItems = myModel.GetSelectedItems(); XPStringBuilder sb = new XPStringBuilder(); sb.Append("myArray[").Append(iSelectedItemIndex).Append("].") .Append(OBJECT_CLASS_ID).Append(" = '") .Append(((TreeLeafNode) mySelectedItems.GetElement(iSelectedItemIndex)).m_nClassID) .Append("';\n"); return sb.ToString();

Parameters:
index - of the selected Item
Returns:
String

GetRepostControlName

public java.lang.String GetRepostControlName()
Description copied from class: AFormAS
Returns the name of the repost control class. E.g.: PropRepostControl.GetName() This can also be overridden on a per DP basis. See AFormDP#GetRepostControlName() The repost control does not necessarily need to extend RepostControl. A form can be submitted to any type of control as long as it knows how to properly interpret the form.

Specified by:
GetRepostControlName in interface IFormAS
Overrides:
GetRepostControlName in class AFormAS
Returns:
String
See Also:
com.plumtree.uiinfrastructure.form.IRepostAS#GetRepostControlName()

Init

public void Init()
Description copied from class: AActivitySpace
Initialize the Activity Space. This method is called after common attributes like ID, parent, session, application, etc... are set. Get methods are not valid until this method is called. This method should be overridden and called as super.Init();

Overrides:
Init in class AFormAS
See Also:
Sub classes need to provide their own implementation that calls into this implementation and adds all of the MVC elements (other than DPs). The model should be stored as this.TREEMODEL.



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.