com.plumtree.portalpages.common.uiparts
Class PlumtreeAS

java.lang.Object
  extended by com.plumtree.uiinfrastructure.activityspace.AActivitySpace
      extended by com.plumtree.uiinfrastructure.form.AFormAS
          extended by com.plumtree.portalpages.common.uiparts.PlumtreeAS
All Implemented Interfaces:
ITypes, IManagedObject, IMVCObject, IFormAS, IEnvironment
Direct Known Subclasses:
AdminSearchAS, AdvancedSearchAS, AreYouSureAS, AssociatedObjectsAS, BasicSearchAS, CommunityPageAS, CreateAccountAS, DebugAS, DebugLayoutAS, DirAS, EditDefaultProfileAS, EditWebLinkAS, EnsembleHandlerAS, ErrorAS, GatewayAS, HTTPMemoryDebugAS, LoginAS, MyPageAS, NetworkSearchAS, ObjMgrAS, PortalSettingsAS, PreviewCommunityAS, PreviewCommunityBarAS, PreviewPortletAS, SearchResultAS, SendInvitationAS, SessionPrefsAS, SiteMapAS, TopBestBetHandlerAS

public abstract class PlumtreeAS
extends AFormAS
implements ITypes

This is the base class for all AS's with a banner.

Author:
RobZ, DavidP

Field Summary
protected static java.lang.String REGISTERED_VIEW_SESSION_ATTRIBUTE
           
 
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
PlumtreeAS()
           
 
Method Summary
 boolean CheckBasicAccess(java.lang.String strPage, java.lang.String strControl, boolean bSameSpace)
          This method is called by the Interpreter at the beginning of every HTTP request to determine whether or not the current user has the security privileges necessary to view the requested page.
 HTMLScriptCollection DisplayCommonJavaScript()
          This is a helper method that all classes that inherit from AFormDP can override if they like.
abstract  java.lang.String GetName()
          This method is used to identify the type of this space.
 INavTypes GetNavType(int nNavScheme)
          This method gets the correct navtype for the nav scheme, correcting for Macintosh users.
 java.lang.String GetStrLayoutStyleClass()
           
 void Init()
          Initialize the Activity Space.
 void ReInit()
          Re-Initialize the Activity Space in case models are holding on to an old session.
 void SetStrLayoutStyleClass(java.lang.String strLayoutStyleClass)
           
 
Methods inherited from class com.plumtree.uiinfrastructure.form.AFormAS
GetRepostControlName
 
Methods inherited from class com.plumtree.uiinfrastructure.activityspace.AActivitySpace
ChangeSubSpaceKey, CleanupAllData, CleanupTempData, Create, DeleteSubSpace, GetAccessStyle, GetApplication, GetControl, GetControlExists, GetControlsEnumerator, GetCurrentFormData, GetCurrentHTTPRequest, GetCurrentHTTPResponse, GetCurrentNormalizedBaseURL, GetCurrentPage, GetCurrentRequestURL, GetHelpTopic, GetIsAccessStyleNonStandard, GetIsAccessStyleStandard, GetIsInPlaceRefreshDisplayOn, GetIsInPlaceRefreshEnabled, GetIsSecuredSpace, GetLanguage, GetLocale, GetModel, GetModelExists, GetModelsEnumerator, GetPage, 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, 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
 

Field Detail

REGISTERED_VIEW_SESSION_ATTRIBUTE

protected static final java.lang.String REGISTERED_VIEW_SESSION_ATTRIBUTE
See Also:
Constant Field Values
Constructor Detail

PlumtreeAS

public PlumtreeAS()
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:
com.plumtree.xpshared.activityspace.AActivitySpace#GetName()

CheckBasicAccess

public boolean CheckBasicAccess(java.lang.String strPage,
                                java.lang.String strControl,
                                boolean bSameSpace)
Description copied from class: AActivitySpace
This method is called by the Interpreter at the beginning of every HTTP request to determine whether or not the current user has the security privileges necessary to view the requested page. This method is designed for checking whether or not a particular user has any access to the space, page, and control. More detailed checking (of query string parameters, for instance), should be done in the IControl.CheckActionSecurityAndExecute() method. For Plumtree portal applications (IPTActivitySpaces), since the IPTSession is guaranteed to be set before Init() & CheckBasicAccess() are called, you can check access as follows: return (GetIPTSession().GetSessionInfo().CheckForActivityRight (new Integer(PT_ACTIVITY_RIGHTS.PT_ACTIVITY_RIGHT_ACCESS_ADMINISTRATION)) == 1);

Specified by:
CheckBasicAccess in class AActivitySpace
Returns:
boolean true implies access is allowed, false implies access is denied
See Also:
AS that extends PlumtreeAS must call this super method if overridden to check for changed navigation scheme

DisplayCommonJavaScript

public HTMLScriptCollection DisplayCommonJavaScript()
Description copied from class: AFormAS
This is a helper method that all classes that inherit from AFormDP can override if they like. The method provides a hook into the head so that DP's can add javascript. Simply override and return and HTMLScript. Also, it is best to return the results of the DisplayJavaScript functions from the appropriate views. Override this method to Display javascript from child IViews

Specified by:
DisplayCommonJavaScript in interface IFormAS
Overrides:
DisplayCommonJavaScript in class AFormAS
Returns:
HTMLScriptCollection the Javascript from the Child IViews
See Also:
IFormAS.DisplayCommonJavaScript()

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:
com.plumtree.xpshared.activityspace.AActivitySpace#Init()

ReInit

public void ReInit()
Re-Initialize the Activity Space in case models are holding on to an old session.

Overrides:
ReInit in class AActivitySpace

GetNavType

public INavTypes GetNavType(int nNavScheme)
This method gets the correct navtype for the nav scheme, correcting for Macintosh users.

Specified by:
GetNavType in interface ITypes
Parameters:
int - nNavScheme the desired navigation scheme.
Returns:
INavTypes the appropriate navigation scheme.

GetStrLayoutStyleClass

public java.lang.String GetStrLayoutStyleClass()

SetStrLayoutStyleClass

public void SetStrLayoutStyleClass(java.lang.String strLayoutStyleClass)



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