com.plumtree.portalpages.common.uiparts
Class PlumtreeDP

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

All Implemented Interfaces:

IDisplayPage, IMVCObject

Direct Known Subclasses:

AdminSearchDP, AdvancedSearchDP, BasicSearchDP, CommunityInvitationJoinDP, CommunityUnsubscribeDP, CreateAccountDP, DebugDP, DebugLayoutDP, DirBrowseDP, DirBrowseDP_D, DirCardPropertiesDP_D, DirEditDP, DirRelatedResourcesMoreDP_D, ErrorDP, FlyoutCommunitySelectionDP, FlyoutPortletSelectionDP, GatewayErrorDP, GatewayHostedDP, HTTPMemoryDebugDP, LoginDP, MembersDP, MyPortalDP, NetworkSearchLaunchDP, NetworkSearchLaunchDP_D, NetworkSearchResultsDP, NetworkSearchResultsDP_D, NoCommunityAccessDP, NoMyPageAccessDP, ObjMgrDP, ObjMgrRootDP, PortalSettingsDP, PowerSearchDP, SearchResultDP, SiteMapDP, SubCommunitiesDP, WelcomeDP

public abstract class PlumtreeDP
extends AFormDP

Main display page for the Portal product.

Author:

RobZ, DavidP, BridgetF, NaveenP, michaeld

Field Summary

static java.lang.String	JAVASCRIPT_INITIALIZE_EVENTS
protected boolean	m_bAddMainForm Whether or not to display the main form
protected int	m_nLeftWidth
protected int	m_nLeftWidthAlone
protected int	m_nRightWidth
protected int	m_nRightWidthAlone
protected int	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

PlumtreeDP()

Method Summary

void	Display(IWebData pageData) Construct the HTMLPage for Display.
protected HTMLBody	DisplayBody(int nNavScheme) Constructs the body for the Plumtree display page.
protected HTMLHead	DisplayHead(int nNavScheme) Constructs the head for the Plumtree display page.
protected HTMLScript	DisplayJavaScriptToHead() This is a helper method that all classes that inherit from PlumtreeDP need to implement.
protected HTMLElement	DisplayLayout(int _nWebServiceID, boolean _bMainPage) This helper method displays a particular layout from a web service.
protected HTMLElement	DisplayLayout(Layouts layout) This method checks whether or not the page should be displayed using layout mode and then displays it.
boolean	GetAddMainForm()
HTMLScriptCollection	GetBasicJavascript()
java.lang.String	GetFormTitle() This is a helper method that all classes that inherit from AFormDP need to implement.
HTMLScript	GetInitializeEventsJavaScript()
HTMLMeta	GetMetaRefresh() Forms meta-refresh tag for page auto refreshing.
abstract java.lang.String	GetName() Return the name of the MVC object.
int	GetNavScheme() This method is also used by the BasePage layout NavArea tag.
abstract java.lang.String	GetSubtitleForBanner() This string will be added as the subtitle in a banner that has a subtitle.
abstract java.lang.String	GetTitleForBanner() This string will be added as the title in a banner that has a title.
abstract HTMLElement	PageDisplay() This is a helper method that all classes that inherit from PlumtreeDP need to implement.
protected void	RegisterNavScheme(int nCurrentScheme)
void	SetAddMainForm(boolean _bAddMainForm) Set the AddMainForm member variable.

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

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

JAVASCRIPT_INITIALIZE_EVENTS

public static final java.lang.String JAVASCRIPT_INITIALIZE_EVENTS

See Also:

Constant Field Values

m_bAddMainForm

protected boolean m_bAddMainForm

Whether or not to display the main form

m_nTableSpacing

protected int m_nTableSpacing

m_nLeftWidth

protected int m_nLeftWidth

m_nRightWidth

protected int m_nRightWidth

m_nLeftWidthAlone

protected int m_nLeftWidthAlone

m_nRightWidthAlone

protected int m_nRightWidthAlone

Constructor Detail

PlumtreeDP

public PlumtreeDP()

Method Detail

GetName

public abstract 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 AFormDP

Returns:

the name of the object.

See Also:

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

GetSubtitleForBanner

public abstract java.lang.String GetSubtitleForBanner()

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.

Returns:

SubHeader

GetTitleForBanner

public abstract java.lang.String GetTitleForBanner()

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.

Returns:

Header

PageDisplay

public abstract HTMLElement PageDisplay()

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 AFormDP

Returns:

HTML of the page

Throws:

HTMLException

GetNavScheme

public int GetNavScheme()

This method is also used by the BasePage layout NavArea tag.

Returns:

Returns NavScheme.

Display

public void Display(IWebData pageData)

Description copied from interface: IDisplayPage

Construct the HTMLPage for Display.

Specified by:

Display in interface IDisplayPage

Overrides:

Display in class AFormDP

See Also:

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

DisplayLayout

protected HTMLElement DisplayLayout(Layouts layout)

This method checks whether or not the page should be displayed using layout mode and then displays it.

Parameters:

_pageData -

Returns:

The HTML output of the layout, or null if the layout was disabled.

DisplayLayout

protected HTMLElement DisplayLayout(int _nWebServiceID,
                                    boolean _bMainPage)

This helper method displays a particular layout from a web service.

Parameters:

_nWebServiceID - The webservice to display.

_bMainPage - whether or not to process the head element for a main page. This should only be true for one layout per page.

Returns:

the HTML output of displaying the layout.

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.

Specified by:

GetFormTitle in class AFormDP

Returns:

String the HTML Encoded title for the form header

See Also:

AFormDP.GetFormTitle()

SetAddMainForm

public void SetAddMainForm(boolean _bAddMainForm)

Set the AddMainForm member variable. Set it to true if you want to have the form tag and have the postToSelf javascript automatically printed out.

Parameters:

_bAddMainForm -

GetAddMainForm

public boolean GetAddMainForm()

Returns:

whether or not to add the form tag and have the postToSelf javascript automatically printed out.

DisplayBody

protected HTMLBody DisplayBody(int nNavScheme)

Constructs the body for the Plumtree display page. Note that this function must be called prior to calling DisplayHead(), because of the special case of intrinsic portlets on the MyPortalDP. Intrinsic portlets view registration, which occurs in PageDisplay(), must occur prior to Javascript generation, which occurs during DisplayJavaScriptFromChild().

Parameters:

nNavScheme - Navigation scheme ID

Returns:

HTMLBody

See Also:

NavTypeConstants

GetInitializeEventsJavaScript

public HTMLScript GetInitializeEventsJavaScript()

GetBasicJavascript

public HTMLScriptCollection GetBasicJavascript()

DisplayHead

protected HTMLHead DisplayHead(int nNavScheme)

Constructs the head for the Plumtree display page. Note that this function must be called after calling DisplayBody(), because of the special case of intrinsic portlets on the MyPortalDP. Intrinsic portlets view registration, which occurs in PageDisplay(), must occur prior to Javascript generation, which occurs during DisplayJavaScriptFromChild().

Parameters:

nNavScheme - Navigation scheme ID

Returns:

HTMLHead

See Also:

NavTypeConstants

DisplayJavaScriptToHead

protected HTMLScript DisplayJavaScriptToHead()

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 use the DisplayJavaScript and add it to the head.

Returns:

HTMLScript block

Throws:

HTMLException

GetMetaRefresh

public HTMLMeta GetMetaRefresh()

Forms meta-refresh tag for page auto refreshing. Override this method to do custom page refreshes.

Returns:

HTMLMeta to be included, or null

RegisterNavScheme

protected void RegisterNavScheme(int nCurrentScheme)