com.plumtree.uiinfrastructure.common
Class FrameSetDP

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

All Implemented Interfaces:

IDisplayPage, IMVCObject

Direct Known Subclasses:

AYSPopupDP, EditDefaultProfileDP, HelpFrameSetDP, ObjSelFrameSetDP, PreviewCommunityDP, SaveObjectFoldersFrameDP, SaveObjectMainFrameDP, TreeFrameDP

public abstract class FrameSetDP
extends java.lang.Object
implements IDisplayPage

This class implements a frame set page.

Author:

robertz

Field Summary

static java.lang.String	BODY_FRAME
static java.lang.String	BOTTOM_FRAME
protected AActivitySpace	m_asOwner Activity Space
static java.lang.String	TOP_FRAME Frame names for JS manipulation

Constructor Summary

FrameSetDP()

Method Summary

void	Display(IWebData webData) Construct the HTMLPage for Display.
java.lang.String	GetFrameNameBody() Set Frame Name Body The frame name and title are used by 508 users.
java.lang.String	GetFrameNameBottom() Set Frame Name Bottom 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	GetFrameScrollBody() Set Frame Scroll Body
boolean	GetFrameScrollBottom() Set Frame Scroll Bottom
boolean	GetFrameScrollTop() Set Frame Scroll Top
java.lang.String	GetFrameSetAttributes() Set FrameSet Attributes
abstract 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	GetFrameTitleBottom() Set Frame Title Bottom 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.
abstract ASURL	GetFrameURLBody() Set Frame URL Body
ASURL	GetFrameURLBottom() Set Frame URL Bottom
java.lang.String	GetFrameURLStringTop() Set Frame URL Top This method is only called if the GetFrameURLTop method returns null;
abstract ASURL	GetFrameURLTop() Set Frame URL Top
abstract java.lang.String	GetName() Return the name of the MVC object.
HTMLElementCollection	GetNoFrames() Set NOFRAMES Body Element The NOFRAMES element is useful for 508 users.
AActivitySpace	GetOwner() Return the owning Activity Space.
void	Init(AActivitySpace parent) Initialize the Display Page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TOP_FRAME

public static final java.lang.String TOP_FRAME

Frame names for JS manipulation

See Also:

Constant Field Values

BODY_FRAME

public static final java.lang.String BODY_FRAME

See Also:

Constant Field Values

BOTTOM_FRAME

public static final java.lang.String BOTTOM_FRAME

See Also:

Constant Field Values

m_asOwner

protected AActivitySpace m_asOwner

Activity Space

Constructor Detail

FrameSetDP

public FrameSetDP()

Method Detail

Display

public void Display(IWebData webData)

Description copied from interface: IDisplayPage

Construct the HTMLPage for Display.

Specified by:

Display in interface IDisplayPage

See Also:

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

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

Returns:

the name of the object.

See Also:

IMVCObject.GetName()

GetOwner

public AActivitySpace GetOwner()

Description copied from interface: IDisplayPage

Return the owning Activity Space.

Specified by:

GetOwner in interface IDisplayPage

See Also:

com.plumtree.uiinfrastructure.activityspace.IDisplayPage#GetParent()

Init

public void Init(AActivitySpace parent)

Description copied from interface: IDisplayPage

Initialize the Display Page.

Specified by:

Init in interface IDisplayPage

See Also:

IDisplayPage.Init(AActivitySpace)

GetFrameScrollBody

public boolean GetFrameScrollBody()

Set Frame Scroll Body

Returns:

boolean true implies scrolling

GetFrameScrollBottom

public boolean GetFrameScrollBottom()

Set Frame Scroll Bottom

Returns:

boolean true implies scrolling

GetFrameScrollTop

public boolean GetFrameScrollTop()

Set Frame Scroll Top

Returns:

boolean true implies scrolling

GetFrameSetAttributes

public java.lang.String GetFrameSetAttributes()

Set FrameSet Attributes

Returns:

String

GetFrameURLBottom

public ASURL GetFrameURLBottom()

Set Frame URL Bottom

Returns:

ASURL, null implies no bottom frame

GetFrameURLStringTop

public java.lang.String GetFrameURLStringTop()

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

Returns:

String

GetFrameNameTop

public java.lang.String GetFrameNameTop()

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

Returns:

String

GetFrameNameBody

public java.lang.String GetFrameNameBody()

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

Returns:

String

GetFrameNameBottom

public java.lang.String GetFrameNameBottom()

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

Returns:

String

GetFrameTitleTop

public java.lang.String GetFrameTitleTop()

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

Returns:

String

GetFrameTitleBody

public java.lang.String GetFrameTitleBody()

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

Returns:

String

GetFrameTitleBottom

public java.lang.String GetFrameTitleBottom()

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

Returns:

String

GetNoFrames

public HTMLElementCollection GetNoFrames()

Set NOFRAMES Body Element The NOFRAMES element is useful for 508 users.

Returns:

HTMLElementCollection

GetFrameSetTitle

public abstract java.lang.String GetFrameSetTitle()

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

Returns:

String

GetFrameURLBody

public abstract ASURL GetFrameURLBody()

Set Frame URL Body

Returns:

ASURL

GetFrameURLTop

public abstract ASURL GetFrameURLTop()

Set Frame URL Top

Returns:

ASURL