org.apache.jetspeed.portal
Interface PanedPortletController

All Superinterfaces:

PortletController, PortletSetController, java.io.Serializable

All Known Implementing Classes:

VelocityPanedPortletController

public interface PanedPortletController

extends PortletController, PortletSetController

This interface must be implemented by all portlet controllers that don't display their entire content at one time. The methods defined in this interface allows the controls object that interact with this controller to build the correct links for referencing the hidden portlets

Version:

$Id: PanedPortletController.java,v 1.10 2005/03/21 18:21:41 sgala Exp $

Author:

Raphaël Luta, David Sean Taylor

Method Summary

java.lang.String	getPaneParameter()
java.lang.String	getParameterName() Deprecated.
org.apache.turbine.util.DynamicURI	getPortletURI(Portlet p, org.apache.turbine.util.RunData rundata) Builds a link object to access a given pane.
boolean	isSelected(Portlet p, org.apache.turbine.util.RunData rundata) Test whether the selected portlet is considered selected for the current request.
java.lang.String	retrievePaneID(org.apache.turbine.util.RunData rundata, boolean byParameter) Returns the pane id of the parameter used for pane selection
java.lang.String	retrievePaneName(org.apache.turbine.util.RunData rundata) Deprecated.
void	savePaneID(org.apache.turbine.util.RunData rundata, java.lang.String id) Saves the pane id to the session to remember selection state of menu or tab.
void	savePaneName(org.apache.turbine.util.RunData data, java.lang.String name) Deprecated.
void	setParameterName(java.lang.String name) Deprecated.

Methods inherited from interface org.apache.jetspeed.portal.PortletController

getConfig, getConstraints, getContent, getPortlets, init, setConfig, setPortlets, supportsType

Method Detail

getPaneParameter

public java.lang.String getPaneParameter()

isSelected

public boolean isSelected(Portlet p,
                          org.apache.turbine.util.RunData rundata)

Test whether the selected portlet is considered selected for the current request.

Parameters:

p - the Portlet to check

rundata - the RunData for the request

Returns:

true if the portlet is selected, false otherwise

getPortletURI

public org.apache.turbine.util.DynamicURI getPortletURI(Portlet p,
                                                        org.apache.turbine.util.RunData rundata)

Builds a link object to access a given pane.

Parameters:

p - the pane portlet object

rundata - the rundata for this request

Returns:

a DynamicURI that can be used to reference the specific portlet

retrievePaneID

public java.lang.String retrievePaneID(org.apache.turbine.util.RunData rundata,
                                       boolean byParameter)

Returns the pane id of the parameter used for pane selection

Parameters:

rundata - The request data.

byParameter - Set to true to look by query parameter first.

Returns:

String The pane id for the selected pane.

savePaneID

public void savePaneID(org.apache.turbine.util.RunData rundata,
                       java.lang.String id)

Saves the pane id to the session to remember selection state of menu or tab.

Parameters:

rundata - The request data.

id - The tab id to save for this controller

savePaneName

public void savePaneName(org.apache.turbine.util.RunData data,
                         java.lang.String name)

Deprecated.

Sets the name of the pane that should be displayed

Parameters:

name - the selection parameter name

getParameterName

public java.lang.String getParameterName()

Deprecated.

Returns the name of the pane selector parameter for this controller

setParameterName

public void setParameterName(java.lang.String name)

Deprecated.

Sets the name of the pane selector parameter for this controller

Parameters:

name - the new parameter name

retrievePaneName

public java.lang.String retrievePaneName(org.apache.turbine.util.RunData rundata)

Deprecated.

Returns the name of the pane that should be displayed