com.plumtree.uiinfrastructure.form
Class ClosePopUpDP

java.lang.Object
  com.plumtree.uiinfrastructure.form.ClosePopUpDP

All Implemented Interfaces:

IDisplayPage, IMVCObject

public class ClosePopUpDP
extends java.lang.Object
implements IDisplayPage

This Display Page adds client specified Javascript to the page and then closes the window. This is useful for closing pop-ups after they are finished.

Author:

Don Hayler

Field Summary

static java.lang.String

STR_MVC_CLASS_NAME Object Name

Constructor Summary

ClosePopUpDP()

Method Summary

void	Display(IWebData webData) Construct the HTMLPage for Display.
java.lang.String	GetName() Return the name of the MVC object.
AActivitySpace	GetOwner() Return the owning Activity Space.
void	Init(AActivitySpace parent) Initialize the Display Page.
void	SetScript(HTMLScript script) Set the script that will be added before the window is closed.
void	SetToClose(boolean bShouldClose) This function sets a boolean to check whether the ClosePopUpDP should actually close.

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

Object Name

See Also:

Constant Field Values

Constructor Detail

ClosePopUpDP

public ClosePopUpDP()

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:

IDisplayPage.Display(IWebData)

GetName

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

SetScript

public void SetScript(HTMLScript script)

Set the script that will be added before the window is closed. This is where you should call javascript functions on the opening window if desired.

Parameters:

script - the script to add before closing

SetToClose

public void SetToClose(boolean bShouldClose)

This function sets a boolean to check whether the ClosePopUpDP should actually close. This is useful for pages that redirect and would like to set some JavaScript but not close. A good example of this is a page that uses frames and needs the parent.location to change - a redirect object doesn't work, and ClosePopupDP gives us the script. so we call this function to keep the window open.

Parameters:

bShouldClose -