com.plumtree.portaluiinfrastructure.intrinsicportlets
Class IntrinsicPortletView

java.lang.Object
  com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletView

All Implemented Interfaces:

IManagedObject, IMVCObject, IView

Direct Known Subclasses:

CommunitiesPortletView, EODPortletView, FoldersPortletView, JobHistoryPortletView, LoginPortletView, SavedSearchPortletView, SearchPortletView, SiteMapPortletView, StandardFooterView, StandardHeaderView

public abstract class IntrinsicPortletView
extends java.lang.Object
implements IView

This is the base intrinsic portlet view. All intrinsic portlet views should extend this base class.

Author:

josephc

Field Summary

static java.lang.String	INTRINSIC_PORTLET_HTMLFORM_NAME The name of the intrinsic portlet form prefix (for use in Javascript, etc...).
static java.lang.String	INTRINSIC_PORTLET_JAVASCRIPT_SUBMIT_FORM The name of the JavaScript used to submit the form.
protected AActivitySpace	m_asOwner Parent Activity Space
protected boolean	m_bAddFormToPortlet Set to true if you want your portlet to have a form and JavaScript for repost.
protected boolean	m_bMultiPart Set to true if you want your portlet to have a multi-part form
protected IModelRO	m_model RO interface to model

Constructor Summary

IntrinsicPortletView()

Method Summary

abstract java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
HTMLElement	Display() This is called by the MyPortalContentView, which aggregates all the intrinsic portlet views.
HTMLScript	DisplayJavascript() Portlet Javascript is aggregated by PlumtreeDP.
abstract HTMLElement	DisplayPortlet() Displays the HTML for the portlet.
abstract java.lang.String	DisplayPortletWML() Displays the WML for the portlet.
java.lang.String	DisplayWML() This is called by the ??, which aggregates all the intrinsic portlet WML views.
abstract java.lang.String	GetName() Return the name of the MVC object.
void	Init(IModelRO model, AActivitySpace parent) Inits the Section with the read-only Model and the Activity Space.

Methods inherited from class java.lang.Object

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

Field Detail

INTRINSIC_PORTLET_HTMLFORM_NAME

public static final java.lang.String INTRINSIC_PORTLET_HTMLFORM_NAME

The name of the intrinsic portlet form prefix (for use in Javascript, etc...). The portlet ID will be appended to the prefix.

See Also:

Constant Field Values

INTRINSIC_PORTLET_JAVASCRIPT_SUBMIT_FORM

public static final java.lang.String INTRINSIC_PORTLET_JAVASCRIPT_SUBMIT_FORM

The name of the JavaScript used to submit the form. The portlet ID will be appended to the prefix.

See Also:

Constant Field Values

m_asOwner

protected AActivitySpace m_asOwner

Parent Activity Space

m_model

protected IModelRO m_model

RO interface to model

m_bAddFormToPortlet

protected boolean m_bAddFormToPortlet

Set to true if you want your portlet to have a form and JavaScript for repost.

m_bMultiPart

protected boolean m_bMultiPart

Set to true if you want your portlet to have a multi-part form

Constructor Detail

IntrinsicPortletView

public IntrinsicPortletView()

Method Detail

Create

public abstract java.lang.Object Create()

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

See Also:

IManagedObject.Create()

Display

public HTMLElement Display()

This is called by the MyPortalContentView, which aggregates all the intrinsic portlet views. This method calls DisplayPortlet() in order to generate the HTML specific to the portlet. If a form is required, then the HTML returned from DisplayPortlet() is put into a form.

Specified by:

Display in interface IView

Returns:

HTMLElement

Throws:

XPException - Exception thrown if portlet was uanble to display.

See Also:

IView.Display()

DisplayWML

public java.lang.String DisplayWML()

This is called by the ??, which aggregates all the intrinsic portlet WML views. This method calls DisplayPortletWML() in order to generate the WML specific to the portlet.

Returns:

HTMLElement representing WML for portlet

DisplayJavascript

public HTMLScript DisplayJavascript()

Portlet Javascript is aggregated by PlumtreeDP. Note that you may need to take into account the portletID in your Javascript.

Specified by:

DisplayJavascript in interface IView

Returns:

HTMLScript

Throws:

XPException - Exception thrown if portlet was uanble to generate JavaScript.

See Also:

IView.DisplayJavascript()

DisplayPortlet

public abstract HTMLElement DisplayPortlet()

Displays the HTML for the portlet. The child classes must implement this function. This function is called by Display().

Returns:

HTML for portlet

DisplayPortletWML

public abstract java.lang.String DisplayPortletWML()

Displays the WML for the portlet. The child classes must implement this function. This function is called by DisplayWML().

Returns:

WML for portlet

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

Init

public void Init(IModelRO model,
                 AActivitySpace parent)

Inits the Section with the read-only Model and the Activity Space.

Specified by:

Init in interface IView

Parameters:

model -

parent -

See Also:

IView.Init(IModelRO, AActivitySpace)