com.plumtree.uiinfrastructure.editor
Class EditorRepostControl

java.lang.Object
  com.plumtree.uiinfrastructure.form.RepostControl
      com.plumtree.uiinfrastructure.editor.EditorRepostControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

Direct Known Subclasses:

ApprovalControl, AuditManagerRepostControl, AutomationServerRepostControl, BestBetRepostControl, CredentialVaultManagerRepostControl, CustomActivityRepostControl, DiagnosticPageRepostControl, DirPrefsRepostControl, DisplayOptRepostControl, EditPageRepostControl, EditPortletPrefsRepostControl, EODPortletPrefsRepostControl, GbDocTypeExtRepostControl, GbDocTypeRepostControl, GlobalACLSyncMapRepostControl, JobFoldersRepostControl, LayoutSelectionRepostControl, LocaleSettingsRepostControl, LocalizedStringsControl, MainActivityRightsRepostControl, MigrationUtilityRepostControl, ObjectLockManagerRepostControl, ObjectSelectionRepostControl, ObjEditorRepostControl, ObjPropMapRepostControl, PasswordManagerRepostControl, PropertyMapEditorRepostControl, SavedSearchPortletPrefsRepostControl, SearchServerSettingsEditorRepostControl, SearchServerTuningEditorRepostControl, SecurityMatrixRepostControl, SetServerSettingsRepostControl, SiteMapPortletPrefsRepostControl, SubportalRulesManagerRepostControl, SubscribeMatrixRepostControl, TagLibRepostControl, UnsubscribeCommunitiesRepostControl, UserInfoPropMapRepostControl, UserLockManagerRepostControl, UserProfileRepostControl, UsrProfMgrRepostControl

public class EditorRepostControl
extends RepostControl

This repost control implements the repost actions for Editor pages.

Author:

Julie Fournier

Field Summary

static int	POSTTOSELF_ACTION_ONRETURN_FROM_SUBEDITOR Repost action constant: This action is called when the user goes back to a main Editor after finishing a sub Editor (the main Editor form is posted).
static java.lang.String	STR_MVC_CLASS_NAME Object Name for AS

Fields inherited from class com.plumtree.uiinfrastructure.form.RepostControl

HTMLINPUT_PASSTHRU_ARGS, HTMLINPUT_PASSTHRU_CONTROL, HTMLINPUT_POSTTOSELF, HTMLSUBMIT_508_POSTTOSELF, m_asOwner, m_bInitialized, m_htFormData, m_model, m_nAction, m_nPageStatus, m_rRedirect, PAGE_STATUS_INVALID, PAGE_STATUS_VALID, POSTTOSELF_ACTION_APPLY_CHANGES, POSTTOSELF_ACTION_CANCEL, POSTTOSELF_ACTION_FINISH, POSTTOSELF_ACTION_GOTOPAGE, POSTTOSELF_ACTION_IN_PLACE_REFRESH, POSTTOSELF_ACTION_PASSTHRU, POSTTOSELF_ACTION_SIMPLEREPOST, POSTTOSELF_ACTION_UNDEFINED

Constructor Summary

EditorRepostControl()

Method Summary

Redirect	CheckActionSecurityAndExecute(XPHashtable arguments) This code is called by the AS Servlet each time there is a repost.
protected void	CheckMandatoryPages() Checks if any mandatory page has not been visited.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
java.lang.String	GetName() Returns the Class name.
protected void	PerformAction(int _nAction) Performs repost actions.
protected void	PerformCancelAction() Helper method to implement the Cancel action.
void	PerformFinishAction() Helper method to implement the Finish action.
protected void	PerformReadOnlyAction(int _nAction) Performs repost actions in Read-Only mode.
protected void	SaveCurrentPage() Get the current page name and call the save method on the model.
protected void	SetRedirectToCloseSubEditor() This method is called when we finish a sub Editor.

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

GetPageStatus, GetRepostAction, Init, PerformPassthruAction, SetPageStatus, SetRedirect, SetRepostAction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Object Name for AS

See Also:

Constant Field Values

POSTTOSELF_ACTION_ONRETURN_FROM_SUBEDITOR

public static final int POSTTOSELF_ACTION_ONRETURN_FROM_SUBEDITOR

Repost action constant: This action is called when the user goes back to a main Editor after finishing a sub Editor (the main Editor form is posted).

See Also:

Constant Field Values

Constructor Detail

EditorRepostControl

public EditorRepostControl()

Method Detail

CheckActionSecurityAndExecute

public Redirect CheckActionSecurityAndExecute(XPHashtable arguments)

Description copied from class: RepostControl

This code is called by the AS Servlet each time there is a repost. First it saves the page and then performs any repost action. If the Redirect object returned is not null, the Servlet will go to the page specified by the Redirect. If the Redirect is null, the Servlet will get the current page from the AS and display it.

Specified by:

CheckActionSecurityAndExecute in interface IControl

Overrides:

CheckActionSecurityAndExecute in class RepostControl

Returns:

Redirect

See Also:

RepostControl.CheckActionSecurityAndExecute(XPHashtable)

Create

public java.lang.Object Create()

Description copied from interface: IManagedObject

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Overrides:

Create in class RepostControl

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Overrides:

GetName in class RepostControl

Returns:

String

PerformFinishAction

public void PerformFinishAction()

Helper method to implement the Finish action. If this is a sub Editor we don't want to call the Finish method. If this is the main Editor and it has some sub Editors we also want to call the Finish method on each sub Editor.

CheckMandatoryPages

protected void CheckMandatoryPages()

Checks if any mandatory page has not been visited. If there are any, raises an error and sets the page status to invalid.

PerformReadOnlyAction

protected void PerformReadOnlyAction(int _nAction)

Performs repost actions in Read-Only mode.

Parameters:

_nAction -

PerformAction

protected void PerformAction(int _nAction)

Performs repost actions.

Overrides:

PerformAction in class RepostControl

Parameters:

_nAction -

SaveCurrentPage

protected void SaveCurrentPage()

Description copied from class: RepostControl

Get the current page name and call the save method on the model.

Overrides:

SaveCurrentPage in class RepostControl

See Also:

RepostControl.SaveCurrentPage()

SetRedirectToCloseSubEditor

protected void SetRedirectToCloseSubEditor()

This method is called when we finish a sub Editor. It takes care of closing the sub Editor pop-up winodws and repost the main Editor window.

PerformCancelAction

protected void PerformCancelAction()

Helper method to implement the Cancel action. On cancel, we just redirect to whatever is returned by GetRedirectAfterFinish. If this is a sub Editor in Create mode we also delete the sub Editor from the list. And then we close the pop-up.