com.plumtree.uiinfrastructure.help
Class HelpFrameSetDP

java.lang.Object
  com.plumtree.uiinfrastructure.common.FrameSetDP
      com.plumtree.uiinfrastructure.help.HelpFrameSetDP

All Implemented Interfaces:

IDisplayPage, IMVCObject

public class HelpFrameSetDP
extends FrameSetDP

Author:

donh This Display Page provides a frameset with a "back" navigation link at the bottom for 508 users.

Field Summary

static java.lang.String

STR_MVC_CLASS_NAME MVC object name

Fields inherited from class com.plumtree.uiinfrastructure.common.FrameSetDP

BODY_FRAME, BOTTOM_FRAME, m_asOwner, TOP_FRAME

Constructor Summary

HelpFrameSetDP()

Method Summary

java.lang.String	GetFrameNameBody() Set Frame Name Body The frame name and title are used by 508 users.
java.lang.String	GetFrameNameTop() Set Frame Name Top The frame name and title are used by 508 users.
boolean	GetFrameScrollTop() Set Frame Scroll Top
java.lang.String	GetFrameSetAttributes() Set FrameSet Attributes
java.lang.String	GetFrameSetTitle() Set FrameSet Title This string will be HTML Encoded for safe display by this class.
java.lang.String	GetFrameTitleBody() Set Frame Title Body The frame name and title are used by 508 users.
java.lang.String	GetFrameTitleTop() Set Frame Title Top The frame name and title are used by 508 users.
ASURL	GetFrameURLBody() Set Frame URL Body
java.lang.String	GetFrameURLStringTop() Set Frame URL Top This method is only called if the GetFrameURLTop method returns null;
ASURL	GetFrameURLTop() Set Frame URL Top
java.lang.String	GetName() Return the name of the MVC object.

Methods inherited from class com.plumtree.uiinfrastructure.common.FrameSetDP

Display, GetFrameNameBottom, GetFrameScrollBody, GetFrameScrollBottom, GetFrameTitleBottom, GetFrameURLBottom, GetNoFrames, GetOwner, Init

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 object name

See Also:

Constant Field Values

Constructor Detail

HelpFrameSetDP

public HelpFrameSetDP()

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 FrameSetDP

Returns:

the name of the object.

See Also:

IMVCObject.GetName()

GetFrameSetTitle

public java.lang.String GetFrameSetTitle()

Description copied from class: FrameSetDP

Set FrameSet Title This string will be HTML Encoded for safe display by this class.

Specified by:

GetFrameSetTitle in class FrameSetDP

Returns:

String

GetFrameURLTop

public ASURL GetFrameURLTop()

Description copied from class: FrameSetDP

Set Frame URL Top

Specified by:

GetFrameURLTop in class FrameSetDP

Returns:

ASURL

GetFrameURLStringTop

public java.lang.String GetFrameURLStringTop()

Description copied from class: FrameSetDP

Set Frame URL Top This method is only called if the GetFrameURLTop method returns null;

Overrides:

GetFrameURLStringTop in class FrameSetDP

Returns:

String

GetFrameScrollTop

public boolean GetFrameScrollTop()

Set Frame Scroll Top

Overrides:

GetFrameScrollTop in class FrameSetDP

Returns:

boolean true implies scrolling

GetFrameURLBody

public ASURL GetFrameURLBody()

Description copied from class: FrameSetDP

Set Frame URL Body

Specified by:

GetFrameURLBody in class FrameSetDP

Returns:

ASURL

GetFrameNameTop

public java.lang.String GetFrameNameTop()

Set Frame Name Top The frame name and title are used by 508 users.

Overrides:

GetFrameNameTop in class FrameSetDP

Returns:

String

GetFrameNameBody

public java.lang.String GetFrameNameBody()

Set Frame Name Body The frame name and title are used by 508 users.

Overrides:

GetFrameNameBody in class FrameSetDP

Returns:

String

GetFrameTitleTop

public java.lang.String GetFrameTitleTop()

Set Frame Title Top The frame name and title are used by 508 users.

Overrides:

GetFrameTitleTop in class FrameSetDP

Returns:

String

GetFrameTitleBody

public java.lang.String GetFrameTitleBody()

Set Frame Title Body The frame name and title are used by 508 users.

Overrides:

GetFrameTitleBody in class FrameSetDP

Returns:

String

GetFrameSetAttributes

public java.lang.String GetFrameSetAttributes()

Set FrameSet Attributes

Overrides:

GetFrameSetAttributes in class FrameSetDP

Returns:

String