org.apache.jetspeed.portal.controllers
Class VelocityPanedPortletController

java.lang.Object
  extended byorg.apache.jetspeed.portal.controllers.AbstractPortletController
      extended byorg.apache.jetspeed.portal.controllers.VelocityPortletController
          extended byorg.apache.jetspeed.portal.controllers.VelocityPanedPortletController
All Implemented Interfaces:
PanedPortletController, PortletController, PortletSetController, java.io.Serializable

public class VelocityPanedPortletController
extends VelocityPortletController
implements PanedPortletController

A Velocity based portlet controller implementation that can be used to manage paned content (ie, where a only a subset of all portlets is visible at any given time)

Version:
$Id: VelocityPanedPortletController.java,v 1.14 2005/03/21 18:21:41 sgala Exp $
Author:
RaphaŽl Luta, David Sean Taylor
See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_PARAMETER
           
 
Fields inherited from class org.apache.jetspeed.portal.controllers.AbstractPortletController
DEFAULT_PADDING
 
Constructor Summary
VelocityPanedPortletController()
           
 
Method Summary
 java.lang.String getPaneParameter()
           
 java.lang.String getParameterName()
          Deprecated.  
 org.apache.turbine.util.DynamicURI getPortletURI(Portlet portlet, org.apache.turbine.util.RunData rundata)
          Builds the link to access to 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
protected  java.lang.String retrievePaneIDFromSession(org.apache.turbine.util.RunData rundata)
          Returns the pane id from the session for pane selection of this portlet set / portal page
 java.lang.String retrievePaneName(org.apache.turbine.util.RunData rundata)
          Deprecated.  
 void savePaneID(org.apache.turbine.util.RunData data, java.lang.String id)
          Saves the pane id to the session to remember selection state of menu or tab for this portlet set / portal page.
 void savePaneName(org.apache.turbine.util.RunData data, java.lang.String name)
          Deprecated.  
 void setParameterName(java.lang.String name)
          Deprecated.  
 
Methods inherited from class org.apache.jetspeed.portal.controllers.VelocityPortletController
buildContext, getContent
 
Methods inherited from class org.apache.jetspeed.portal.controllers.AbstractPortletController
getConfig, getConstraints, getContent, getHTMLContent, getPadding, getPortlets, getWidth, getWMLContent, init, setConfig, setPadding, setPadding, setPortlets, setWidth, supportsType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.jetspeed.portal.PortletController
getConfig, getConstraints, getContent, getPortlets, init, setConfig, setPortlets, supportsType
 

Field Detail

DEFAULT_PARAMETER

public static final java.lang.String DEFAULT_PARAMETER
See Also:
Constant Field Values
Constructor Detail

VelocityPanedPortletController

public VelocityPanedPortletController()
Method Detail

getPaneParameter

public java.lang.String getPaneParameter()
Specified by:
getPaneParameter in interface PanedPortletController

isSelected

public boolean isSelected(Portlet p,
                          org.apache.turbine.util.RunData rundata)
Test whether the selected portlet is considered selected for the current request.

Specified by:
isSelected in interface PanedPortletController
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 portlet,
                                                        org.apache.turbine.util.RunData rundata)
Builds the link to access to a given pane.

Specified by:
getPortletURI in interface PanedPortletController
Parameters:
rundata - The request data.
portlet - The portlet to build the link for by id.
Returns:
DynamicURI A new Dynamic URI with the query parameter

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

Specified by:
retrievePaneID in interface PanedPortletController
Parameters:
rundata - The request data.
byParameter - Set to true to look by query parameter first.
Returns:
String The pane id for the selected pane.

retrievePaneIDFromSession

protected java.lang.String retrievePaneIDFromSession(org.apache.turbine.util.RunData rundata)
Returns the pane id from the session for pane selection of this portlet set / portal page

Parameters:
rundata - The request data.
Returns:
String The pane id for the selected pane.

savePaneID

public void savePaneID(org.apache.turbine.util.RunData data,
                       java.lang.String id)
Saves the pane id to the session to remember selection state of menu or tab for this portlet set / portal page.

Specified by:
savePaneID in interface PanedPortletController
Parameters:
id - The tab id to save for this controller
data - The request data.

setParameterName

public void setParameterName(java.lang.String name)
Deprecated.  

Sets the name of the parameter that will define which pane should be displayed

Specified by:
setParameterName in interface PanedPortletController
Parameters:
name - the selection parameter name

getParameterName

public java.lang.String getParameterName()
Deprecated.  

Returns the name of the parameter used for pane selection

Specified by:
getParameterName in interface PanedPortletController

retrievePaneName

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

Returns the name of the parameter used for pane selection

Specified by:
retrievePaneName in interface PanedPortletController

savePaneName

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

Sets the name of the parameter that will define which pane should be displayed

Specified by:
savePaneName in interface PanedPortletController
Parameters:
name - the selection parameter name


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.