com.plumtree.portalpages.admin.objmgr
Class ObjMgrDP

java.lang.Object
  com.plumtree.uiinfrastructure.form.AFormDP
      com.plumtree.portalpages.common.uiparts.PlumtreeDP
          com.plumtree.portalpages.admin.objmgr.ObjMgrDP

All Implemented Interfaces:

IDisplayPage, IMVCObject

public class ObjMgrDP
extends PlumtreeDP

Author:

Don Hayler This implements the admin directory for sub-folders

Field Summary

static java.lang.String	JAVASCRIPT_ONLOAD Javascript function name for the onload function
static int	MAX_TYPES Javascript function name for the onload function
static java.lang.String	OBJECT_ID_PREFIX prefix for object type div
static java.lang.String	STR_MVC_CLASS_NAME MVC component name

Fields inherited from class com.plumtree.portalpages.common.uiparts.PlumtreeDP

JAVASCRIPT_INITIALIZE_EVENTS, m_bAddMainForm, m_nLeftWidth, m_nLeftWidthAlone, m_nRightWidth, m_nRightWidthAlone, m_nTableSpacing

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

GET, HTMLFORM_NAME, JAVASCRIPT_SETUP_FOR_SUBMIT_TO_CONTROL, JAVASCRIPT_SUBMIT_FORM, JAVASCRIPT_SUBMIT_TO_CONTROL, m_asOwner, MULTIPART_ENCODING, POST

Constructor Summary

ObjMgrDP()

Method Summary

protected HTMLScriptCollection	DisplayJavaScriptFromChild() This is a helper method that all classes that inherit from AFormDP can override if they like.
java.lang.String	GetName() Return the name of the MVC object.
protected boolean	GetRepostTypeIsPost() Override this method to set the form submission type.
java.lang.String	GetSubtitleForBanner() This string will be added as the subtitle in a banner that has a subtitle.
java.lang.String	GetTitleForBanner() This string will be added as the title in a banner that has a title.
void	InsertJavascriptBeforeFormSubmit(XPStringBuilder sb) Helper method to insert custom javascript in the form submit method right before the form is submitted.
HTMLElement	PageDisplay() helper display method for PlumtreeDP Fill in the body argument with HTML to display in the page.

Methods inherited from class com.plumtree.portalpages.common.uiparts.PlumtreeDP

Display, DisplayBody, DisplayHead, DisplayJavaScriptToHead, DisplayLayout, DisplayLayout, GetAddMainForm, GetBasicJavascript, GetFormTitle, GetInitializeEventsJavaScript, GetMetaRefresh, GetNavScheme, RegisterNavScheme, SetAddMainForm

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

AddToValidationFunction, DisplayForm, DisplayHTMLAfterForm, DisplayHTMLBeforeForm, DisplayHTMLinHEAD, DisplayJavascript, Get508RepostURL, GetCloseOnCancel, GetFormPageType, GetOnLoad, GetOwner, GetRepostControlName, GetStatusViewEnabled, GetStatusViewRepostValues, GetUseJavascript, GetWindowFocusEnabled, Init, PartialContentDisplay, RemoveFromValidationFunction, SetMultiPartEncoding, SetShow508FormFooter, SetStatusViewEnabled, SetStatusViewRepostValues

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

MVC component name

See Also:

Constant Field Values

OBJECT_ID_PREFIX

public static final java.lang.String OBJECT_ID_PREFIX

prefix for object type div

See Also:

Constant Field Values

JAVASCRIPT_ONLOAD

public static final java.lang.String JAVASCRIPT_ONLOAD

Javascript function name for the onload function

See Also:

Constant Field Values

MAX_TYPES

public static final int MAX_TYPES

Javascript function name for the onload function

See Also:

Constant Field Values

Constructor Detail

ObjMgrDP

public ObjMgrDP()

Method Detail

GetName

public java.lang.String GetName()

Description copied from interface: IMVCObject

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class PlumtreeDP

Returns:

the name of the object.

See Also:

com.plumtree.xpshared.activityspace.IDisplayPage#GetName()

GetSubtitleForBanner

public java.lang.String GetSubtitleForBanner()

Description copied from class: PlumtreeDP

This string will be added as the subtitle in a banner that has a subtitle. For example, if you were on a my page named "Green Page", then return "Green Page" here.

Specified by:

GetSubtitleForBanner in class PlumtreeDP

Returns:

SubHeader

See Also:

PlumtreeDP.GetSubtitleForBanner()

GetTitleForBanner

public java.lang.String GetTitleForBanner()

Description copied from class: PlumtreeDP

This string will be added as the title in a banner that has a title. For example, if this is a my page, return "My Pages" here. If you think you don't need a title, then you need to seriously rethink why you are inheriting from PlumtreeDP. Because the WHOLE POINT of PlumtreeDP is that it has a banner.

Specified by:

GetTitleForBanner in class PlumtreeDP

Returns:

Header

See Also:

PlumtreeDP.GetTitleForBanner()

PageDisplay

public HTMLElement PageDisplay()

helper display method for PlumtreeDP Fill in the body argument with HTML to display in the page.

Specified by:

PageDisplay in class PlumtreeDP

Returns:

HTMLElement

DisplayJavaScriptFromChild

protected HTMLScriptCollection DisplayJavaScriptFromChild()

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.

Overrides:

DisplayJavaScriptFromChild in class AFormDP

Returns:

HTMLScriptCollection the Javascript from the Child IViews

InsertJavascriptBeforeFormSubmit

public void InsertJavascriptBeforeFormSubmit(XPStringBuilder sb)

Description copied from class: AFormDP

Helper method to insert custom javascript in the form submit method right before the form is submitted. javascript should have 4 spaces indenting each line to make it line up with the code it is being inserted into.

Overrides:

InsertJavascriptBeforeFormSubmit in class AFormDP

Parameters:

sb - StringBuilder to add your custom javascript to.

See Also:

Helper method to insert custom javascript in the form submit method right before the form is submitted.

GetRepostTypeIsPost

protected boolean GetRepostTypeIsPost()

Description copied from class: AFormDP

Override this method to set the form submission type.

Overrides:

GetRepostTypeIsPost in class AFormDP

Returns:

boolean true implies POST, false implies GET

See Also:

AFormDP.GetRepostTypeIsPost()