com.plumtree.uiinfrastructure.form
Class AFormAS

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

All Implemented Interfaces:

IManagedObject, IMVCObject, IFormAS, IEnvironment

Direct Known Subclasses:

AFileDownloadAS, AjaxAS, ATreeAS, EditorAS, JobLogAS, PlumtreeAS, RulesDebugMSGAS, SaveObjectAS, VarPackAS

public abstract class AFormAS
extends AActivitySpace
implements IFormAS

This AS provides a base implementation for an HTML Form.

Author:

Don Hayler

Field Summary

static java.lang.String	JAVASCRIPT_GVAR_PTHELPSVRBASEURL help server variable
static java.lang.String	JAVASCRIPT_GVAR_PTIMGSVRIMGSURL image server variable
static java.lang.String	JAVASCRIPT_GVAR_SHAREDIMGSVRIMGSURL Shared image server variable

Fields inherited from class com.plumtree.uiinfrastructure.activityspace.AActivitySpace

m_stringReferences

Constructor Summary

AFormAS()

Method Summary

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.
java.lang.String	GetRepostControlName() Returns the name of the repost control class.
void	Init() Initialize the Activity Space.

Methods inherited from class com.plumtree.uiinfrastructure.activityspace.AActivitySpace

ChangeSubSpaceKey, CheckBasicAccess, 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, 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

JAVASCRIPT_GVAR_PTIMGSVRIMGSURL

public static final java.lang.String JAVASCRIPT_GVAR_PTIMGSVRIMGSURL

image server variable

See Also:

Constant Field Values

JAVASCRIPT_GVAR_SHAREDIMGSVRIMGSURL

public static final java.lang.String JAVASCRIPT_GVAR_SHAREDIMGSVRIMGSURL

Shared image server variable

See Also:

Constant Field Values

JAVASCRIPT_GVAR_PTHELPSVRBASEURL

public static final java.lang.String JAVASCRIPT_GVAR_PTHELPSVRBASEURL

help server variable

See Also:

Constant Field Values

Constructor Detail

AFormAS

public AFormAS()

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 AActivitySpace

Returns:

String the name of this AActivitySpace

See Also:

IMVCObject.GetName()

DisplayCommonJavaScript

public HTMLScriptCollection DisplayCommonJavaScript()

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

Returns:

HTMLScriptCollection the Javascript from the Child IViews

GetRepostControlName

public java.lang.String GetRepostControlName()

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

Returns:

String

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 AActivitySpace

See Also:

AActivitySpace.Init()