com.plumtree.uiinfrastructure.form.status
Class StatusView

java.lang.Object
  com.plumtree.uiinfrastructure.form.status.StatusView

All Implemented Interfaces:

IManagedObject, IMVCObject, IView

public class StatusView
extends java.lang.Object
implements IView

This class contains the HTML and Javascript for placing a status bar into your HTML. While it implements IView, this class does not need to be loaded into an AS in the traditional manner. Plenty of static methods allow you to insert this code into your existing DPs and Views as an optional/external component.

Author:

RickyW

Field Summary

protected AActivitySpace	m_asOwner
static java.lang.String	STR_MVC_CLASS_NAME

Constructor Summary

StatusView()

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
HTMLElement	Display() This method returns the HTMLElement that encompasses the output of the View.
HTMLScript	DisplayJavascript() This method returns the HTMLScript that encompasses the Javascript on the page.
static HTMLElement	GetDisplay(java.lang.String strLang) Alternative way to get the display from this view without the need to create an instance of it.
static HTMLScript	GetDisplayJavascript(boolean bIsSecureSpace) Alternative way to get the Javascript from this view without the need to create an instance of it.
static java.lang.String	GetJSShowStatusInBody() Gets the Javascript method that shows the status bar in place of the body.
static java.lang.String	GetJSShowStatusInBodyRestricted(java.lang.String strRepostArgument, int[] aRepostValues, java.lang.String strSpacing) Returns the method from GetJSShowStatusInBody but additionally wraps it in a check that makes sure the the repost argument is one of the values in the repost values.
java.lang.String	GetName() Return the name of the MVC object.
void	Init(IModelRO model, AActivitySpace parent) This method initializes the View with the read only model interface it is supposed to draw it's data from as well as it's parent ActivitySpace (necessary to create URLS).

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

See Also:

Constant Field Values

m_asOwner

protected AActivitySpace m_asOwner

Constructor Detail

StatusView

public StatusView()

Method Detail

Init

public void Init(IModelRO model,
                 AActivitySpace parent)

Description copied from interface: IView

This method initializes the View with the read only model interface it is supposed to draw it's data from as well as it's parent ActivitySpace (necessary to create URLS).

Specified by:

Init in interface IView

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.

Create

public java.lang.Object Create()

Description copied from interface: IManagedObject

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Returns:

A new instance of the managed class (i.e. return new Foo();)

Display

public HTMLElement Display()

Description copied from interface: IView

This method returns the HTMLElement that encompasses the output of the View.

Specified by:

Display in interface IView

DisplayJavascript

public HTMLScript DisplayJavascript()

Description copied from interface: IView

This method returns the HTMLScript that encompasses the Javascript on the page. This method should be called by IDisplayPages and the resulting Javascript should be put in the HTMLHead element. This can return null.

Specified by:

DisplayJavascript in interface IView

GetDisplay

public static HTMLElement GetDisplay(java.lang.String strLang)

Alternative way to get the display from this view without the need to create an instance of it.

Returns:

This method returns the HTMLElement for the view.

See Also:

IView.Display()

GetDisplayJavascript

public static HTMLScript GetDisplayJavascript(boolean bIsSecureSpace)

Alternative way to get the Javascript from this view without the need to create an instance of it.

Returns:

This method returns the HTMLScript for the view.

See Also:

IView.DisplayJavascript()

GetJSShowStatusInBody

public static java.lang.String GetJSShowStatusInBody()

Gets the Javascript method that shows the status bar in place of the body.

Returns:

The Javascript method that shows the status bar in place of the body.

GetJSShowStatusInBodyRestricted

public static java.lang.String GetJSShowStatusInBodyRestricted(java.lang.String strRepostArgument,
                                                               int[] aRepostValues,
                                                               java.lang.String strSpacing)

Returns the method from GetJSShowStatusInBody but additionally wraps it in a check that makes sure the the repost argument is one of the values in the repost values.

Parameters:

strRepostArgument - The argument that should contain your value.

aRepostValues - The values to check your argument against.

strSpacing - Optional spacing for formatting purposes.

Returns:

Check-Wrapped Javascript method that shows the status bar in place of the body.