com.plumtree.uiinfrastructure.tree
Class TreeHeaderDP

java.lang.Object
  com.plumtree.uiinfrastructure.form.AFormDP
      com.plumtree.uiinfrastructure.tree.TreeHeaderDP

All Implemented Interfaces:

IDisplayPage, IMVCObject

Direct Known Subclasses:

TemplateTreeHeaderDP

public class TreeHeaderDP
extends AFormDP

The header displays common code and the header bar at the top of the tree.

Author:

Don Hayler

Field Summary

static java.lang.String	JAVASCRIPT_SUBMIT_TREE JS to submit the tree form in the body frame.
static java.lang.String	JAVASCRIPT_SUBMIT_TRIES
static java.lang.String	STR_MVC_CLASS_NAME Tree Header object name

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

TreeHeaderDP()

Method Summary

protected HTMLScriptCollection	DisplayJavaScriptFromChild() This is a helper method that all classes that inherit from AFormDP can override if they like.
FormPageTypes	GetFormPageType() This method returns the current page type.
java.lang.String	GetFormTitle() This is a helper method that all classes that inherit from AFormDP need to implement.
java.lang.String	GetName() Return the name of the MVC object.
HTMLElement	PageDisplay() This is a helper method that all classes that inherit from AFormDP need to implement.

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

AddToValidationFunction, Display, DisplayForm, DisplayHTMLAfterForm, DisplayHTMLBeforeForm, DisplayHTMLinHEAD, DisplayJavascript, Get508RepostURL, GetCloseOnCancel, 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

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Tree Header object name

See Also:

Constant Field Values

JAVASCRIPT_SUBMIT_TREE

public static final java.lang.String JAVASCRIPT_SUBMIT_TREE

JS to submit the tree form in the body frame.

See Also:

Constant Field Values

JAVASCRIPT_SUBMIT_TRIES

public static final java.lang.String JAVASCRIPT_SUBMIT_TRIES

See Also:

Constant Field Values

Constructor Detail

TreeHeaderDP

public TreeHeaderDP()

Method Detail

GetFormPageType

public FormPageTypes GetFormPageType()

Description copied from class: AFormDP

This method returns the current page type. Override this method to display a different page type (small pop-up, etc...) This gets called at Init() time. Default has no buttons on the form.

Overrides:

GetFormPageType in class AFormDP

Returns:

FormPageTypes the type of the page to display

See Also:

AFormDP.GetFormPageType()

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

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 AFormDP

Returns:

the name of the object.

See Also:

IMVCObject.GetName()

PageDisplay

public HTMLElement PageDisplay()

Description copied from class: AFormDP

This is a helper method that all classes that inherit from AFormDP 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:

HTMLElement the HTML to put inside the form

See Also:

AFormDP.PageDisplay()

DisplayJavaScriptFromChild

protected HTMLScriptCollection DisplayJavaScriptFromChild()

Description copied from class: AFormDP

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

Overrides:

DisplayJavaScriptFromChild in class AFormDP

Returns:

HTMLScriptCollection the Javascript from the Child IViews

See Also:

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.