com.plumtree.uiinfrastructure.editor
Class EditorAS

java.lang.Object
  com.plumtree.uiinfrastructure.activityspace.AActivitySpace
      com.plumtree.uiinfrastructure.form.AFormAS
          com.plumtree.uiinfrastructure.editor.EditorAS

All Implemented Interfaces:

IManagedObject, IMVCObject, IFormAS, IEnvironment

Direct Known Subclasses:

HostServicesAS, PTEditorAS, SubportalRulesManagerAS

public abstract class EditorAS
extends AFormAS
implements IFormAS

This is the Activity Space class for the Editor Framework. Editor Activity Space classes should extend this class.

Author:

Julie Fournier

Field Summary

protected LeftNavMenu	m_mEditorMenu JF - This is where we store the Editor left navigation.
java.lang.String	m_strModelMVCName DH- The actual MVC name of the model to use if we're going to be storing it with a different name.
java.lang.String	m_strModelName JF- Associated model name.

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

EditorAS()

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.
void	DeleteSubEditorFromList(java.lang.String _sSubEditorKey) Deletes a previously created sub Editor from the sub Editor list contained in the main Editor AS class.
abstract java.lang.String	GetEditorTitle() Returns the Editor main title.
LeftNavMenu	GetLeftMenu() Returns the Editor left nav menu.
IDisplayPage	GetPreviousPage() Returns the previous Display Page.
abstract java.lang.String	GetRepostControlName() Returns the name of the repost control class.
PTConstruct	GetSubBanner() Optional method to implement a sub banner.
ASURL	GoToSubEditor(java.lang.String _sSubEditorName, java.lang.String _sSubEditorKey, int _nSubEditorType, java.lang.String _sControlKey, java.lang.String _sControlValue) Creates and returns a ASURL object going to the Editor whose name and key were passed in argument.
void	Init() Registers Views, Controls and Models used by the Editor Framework.
void	SetCurrentPage(IDisplayPage page) Set the current page for this AActivitySpace.
void	SetCurrentPage(java.lang.String _sNewCurrentPage) Sets a new current page from any Display Page name.

Methods inherited from class com.plumtree.uiinfrastructure.form.AFormAS

DisplayCommonJavaScript, GetName

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, ReInit, SetApplication, SetCurrentFormData, SetCurrentHTTPRequestResponseObjects, 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

m_strModelName

public java.lang.String m_strModelName

JF- Associated model name.

m_strModelMVCName

public java.lang.String m_strModelMVCName

DH- The actual MVC name of the model to use if we're going to be storing it with a different name.

m_mEditorMenu

protected LeftNavMenu m_mEditorMenu

JF - This is where we store the Editor left navigation.

Constructor Detail

EditorAS

public EditorAS()

Method Detail

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:

com.plumtree.portaluiinfrastructure.activityspace.AActivitySpace#CheckBasicAccess(String, String, boolean)

GetEditorTitle

public abstract java.lang.String GetEditorTitle()

Returns the Editor main title. It will get printed out in EditorHeaderView.

Returns:

String

GetSubBanner

public PTConstruct GetSubBanner()

Optional method to implement a sub banner.

Returns:

PTConstruct

GetLeftMenu

public LeftNavMenu GetLeftMenu()

Returns the Editor left nav menu.

Returns:

LeftNavMenu

GetPreviousPage

public IDisplayPage GetPreviousPage()

Returns the previous Display Page. Return null if there was no previous display page.

Returns:

IDisplayPage

GetRepostControlName

public abstract java.lang.String GetRepostControlName()

Returns the name of the repost control class. E.g.: PropRepostControl.GetName()

Specified by:

GetRepostControlName in interface IFormAS

Overrides:

GetRepostControlName in class AFormAS

Returns:

String

DeleteSubEditorFromList

public void DeleteSubEditorFromList(java.lang.String _sSubEditorKey)

Deletes a previously created sub Editor from the sub Editor list contained in the main Editor AS class.

Parameters:

_sSubEditorKey -

GoToSubEditor

public ASURL GoToSubEditor(java.lang.String _sSubEditorName,
                           java.lang.String _sSubEditorKey,
                           int _nSubEditorType,
                           java.lang.String _sControlKey,
                           java.lang.String _sControlValue)

Creates and returns a ASURL object going to the Editor whose name and key were passed in argument.

Parameters:

_sSubEditorName -

_sSubEditorKey - - The 1st time you access that Editor, you can decide the value of the key. Next time you want to access that Editor you need to pass in the same key.

_nSubEditorType - - Sub Editor Type from EditorStartControl.

_sControlKey - Optional - only set it if you want to set an additional setting for the Control. If not, should be null. (E.g.: Can be used to set an Object class ID.)

_sControlValue - Optional - Should be the value associated to the ControlKey.

Returns:

ASURL

Init

public void Init()

Registers Views, Controls and Models used by the Editor Framework. Warning: m_myModel must be set before calling Init().

Overrides:

Init in class AFormAS

See Also:

AActivitySpace.Init()

SetCurrentPage

public void SetCurrentPage(IDisplayPage page)

Description copied from class: AActivitySpace

Set the current page for this AActivitySpace. If this AActivitySpace only has one IDisplayPage, the current page will automatically be set to that IDisplayPage. If current page tracking is on (off by default), the Interpeter will set the current page to be the most recently accessed page.

Overrides:

SetCurrentPage in class AActivitySpace

Parameters:

IDisplayPage - the current Display Page

See Also:

com.plumtree.uiinfrastructure.activityspace.AActivitySpace#SetCurrentPage()

SetCurrentPage

public void SetCurrentPage(java.lang.String _sNewCurrentPage)

Sets a new current page from any Display Page name.

Parameters:

_sNewCurrentPage -