com.plumtree.portalpages.common.uiparts
Class NavigationControl

java.lang.Object
  com.plumtree.portalpages.common.uiparts.NavigationControl

All Implemented Interfaces:

IControl, IManagedObject, IMVCObject

public class NavigationControl
extends java.lang.Object
implements IControl

Control for collapsing and expanding Navigation sections in left vertical views.

Author:

robertz

Field Summary

static java.lang.String	ACTION_COLLAPSE Parameter name for the Collapse action
static java.lang.String	ACTION_EXPAND Parameter name for the Expand action
protected AActivitySpace	m_asOwner
protected NavigationModel	m_model
static java.lang.String	PREV_PAGE_QSPARAM Parameter name for the previous page URL
static java.lang.String	STR_MVC_CLASS_NAME MVC Name

Constructor Summary

NavigationControl()
Constructor for NavigationControl.

Method Summary

Redirect	CheckActionSecurityAndExecute(XPHashtable arguments) Updates the vertical navigation section visibility array and then redirects to the referring page.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
java.lang.String	GetName() Return the name of the MVC object.
void	Init(IModel model, AActivitySpace space) Initialize the control with the model it should use and it's parent AActivitySpace.

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 Name

See Also:

Constant Field Values

ACTION_COLLAPSE

public static final java.lang.String ACTION_COLLAPSE

Parameter name for the Collapse action

See Also:

Constant Field Values

ACTION_EXPAND

public static final java.lang.String ACTION_EXPAND

Parameter name for the Expand action

See Also:

Constant Field Values

PREV_PAGE_QSPARAM

public static final java.lang.String PREV_PAGE_QSPARAM

Parameter name for the previous page URL

See Also:

Constant Field Values

m_asOwner

protected AActivitySpace m_asOwner

m_model

protected NavigationModel m_model

Constructor Detail

NavigationControl

public NavigationControl()

Constructor for NavigationControl.

Method Detail

CheckActionSecurityAndExecute

public Redirect CheckActionSecurityAndExecute(XPHashtable arguments)

Updates the vertical navigation section visibility array and then redirects to the referring page.

Specified by:

CheckActionSecurityAndExecute in interface IControl

Returns:

Redirect where to redirect to after the control is finished executing. This will go to the login page or an error page if Redirect.SetRedirectToLogin(true) has been called.

See Also:

com.plumtree.uiinfrastructure.activityspace.IControl#Execute(com.plumtree.openfoundation.util.XPHashtable)

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

See Also:

IManagedObject.Create()

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

Init

public void Init(IModel model,
                 AActivitySpace space)

Description copied from interface: IControl

Initialize the control with the model it should use and it's parent AActivitySpace. This method needs to be called before any other methods. This method also clears all internal data so the control can be used again without fear of mixing data.

Specified by:

Init in interface IControl

See Also:

IControl.Init(com.plumtree.uiinfrastructure.activityspace.IModel, com.plumtree.uiinfrastructure.activityspace.AActivitySpace)