com.plumtree.portalpages.browsing.myportal
Class MyPortalDP

java.lang.Object
  com.plumtree.uiinfrastructure.form.AFormDP
      com.plumtree.portalpages.common.uiparts.PlumtreeDP
          com.plumtree.portalpages.browsing.myportal.MyPortalDP

All Implemented Interfaces:

IDisplayPage, IMVCObject

public class MyPortalDP
extends PlumtreeDP

Main display page for community and my pages

Author:

MichaelD

Field Summary

static java.lang.String	AUTOREFRESH
static java.lang.String	EMPTYSTRING
static java.lang.String	REFRESH
static java.lang.String	STR_MVC_CLASS_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

MyPortalDP()

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	GetFormTitle() This is a helper method that all classes that inherit from AFormDP need to implement.
protected HTMLElement	GetHTMLBelowSubHeader() Implement this method to add HTML below the sub header.
HTMLMeta	GetMetaRefresh() Forms meta-refresh tag for MyPage auto refreshing based on personal settings value.
java.lang.String	GetName() Return the name of the MVC object.
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.
boolean	GetUseJavascript()
void	Init(AActivitySpace parent) Initialize the Display Page.
HTMLElement	PageDisplay() This is a helper method that all classes that inherit from PlumtreeDP need to implement.

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

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

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

AddToValidationFunction, DisplayForm, DisplayHTMLAfterForm, DisplayHTMLBeforeForm, DisplayHTMLinHEAD, DisplayJavascript, Get508RepostURL, GetCloseOnCancel, GetFormPageType, GetOnLoad, GetOwner, GetRepostControlName, GetRepostTypeIsPost, GetStatusViewEnabled, GetStatusViewRepostValues, GetWindowFocusEnabled, InsertJavascriptBeforeFormSubmit, 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

See Also:

Constant Field Values

AUTOREFRESH

public static final java.lang.String AUTOREFRESH

See Also:

Constant Field Values

REFRESH

public static final java.lang.String REFRESH

See Also:

Constant Field Values

EMPTYSTRING

public static final java.lang.String EMPTYSTRING

See Also:

Constant Field Values

Constructor Detail

MyPortalDP

public MyPortalDP()

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()

Init

public void Init(AActivitySpace parent)

Description copied from interface: IDisplayPage

Initialize the Display Page.

Specified by:

Init in interface IDisplayPage

Overrides:

Init in class AFormDP

See Also:

IDisplayPage.Init(AActivitySpace)

GetHTMLBelowSubHeader

protected HTMLElement GetHTMLBelowSubHeader()

Implement this method to add HTML below the sub header.

Returns:

HTMLElement

Throws:

HTMLException

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()

GetFormTitle

public java.lang.String GetFormTitle()

Description copied from class: AFormDP

This is a helper method that all classes that inherit from AFormDP need to implement. The method should return the title that should be displayed in the window TITLE element as well as on the form header bar, if displayed. The String returned by this method needs to already be HTML Encoded for safe display.

Overrides:

GetFormTitle in class PlumtreeDP

Returns:

String the HTML Encoded title for the form header

See Also:

AFormDP.GetFormTitle()

PageDisplay

public HTMLElement PageDisplay()

Description copied from class: PlumtreeDP

This is a helper method that all classes that inherit from PlumtreeDP need to implement. The method should add whatever HTML the child class wants to display to the body argument. The parent class will then add that HTML to the HTMLPage after filling in the banner and navigation.

Specified by:

PageDisplay in class PlumtreeDP

Returns:

HTML of the page

See Also:

com.plumtree.xpshared.activityspace.AformDP#PageDisplay()

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

See Also:

AFormDP.DisplayJavaScriptFromChild()

GetMetaRefresh

public HTMLMeta GetMetaRefresh()

Forms meta-refresh tag for MyPage auto refreshing based on personal settings value. Adds the parameter "autorefresh=1" to the querystring of the refresh URL to distinguish between urls that are arrived at via autorefresh and those that aren't.

Overrides:

GetMetaRefresh in class PlumtreeDP

Returns:

HTMLMeta to be included

GetUseJavascript

public boolean GetUseJavascript()

Overrides:

GetUseJavascript in class AFormDP