org.apache.jetspeed.modules.actions.portlets
Class VelocityPortletAction

java.lang.Object
  extended byorg.apache.turbine.modules.Assembler
      extended byorg.apache.turbine.modules.Action
          extended byorg.apache.turbine.modules.ActionEvent
              extended byorg.apache.jetspeed.modules.actions.portlets.PortletActionEvent
                  extended byorg.apache.jetspeed.modules.actions.portlets.PortletAction
                      extended byorg.apache.jetspeed.modules.actions.portlets.GenericMVCAction
                          extended byorg.apache.jetspeed.modules.actions.portlets.VelocityPortletAction
Direct Known Subclasses:
CustomizeAction, CustomizeSetAction, DatabaseBrowserAction, EmailPortlet, ForwardDemoAction, GroupBrowserAction, HeaderAction, HelloAction, PermissionBrowserAction, PsmlBrowseAction, RoleBrowserAction, SecureVelocityPortletAction, StockQuoteAction, UserBrowserAction, WeatherAction

public abstract class VelocityPortletAction
extends GenericMVCAction

An abstract action class to build VelocityPortlet actions.

Don't call it from the URL, the Portlet and the Action are automatically associated through the registry PortletName

NOTE:This supports the pre-MVC style of template based portlet development and is supplied for backward compatibility. It is suggested you use a combination of

Version:
$Id: VelocityPortletAction.java,v 1.15 2005/03/21 18:21:36 sgala Exp $
Author:
RaphaŽl Luta, Roberto Carrasco
See Also:
along with subclassing @see org.apache.jetspeed.portal.portlets.GenericMVCAction for future portlet development.


Field Summary
 
Fields inherited from class org.apache.jetspeed.modules.actions.portlets.GenericMVCAction
logger
 
Fields inherited from class org.apache.turbine.modules.ActionEvent
BUTTON, BUTTON_LENGTH, LENGTH, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX
 
Constructor Summary
VelocityPortletAction()
           
 
Method Summary
protected  void buildConfigureContext(Portlet portlet, org.apache.velocity.context.Context context, org.apache.turbine.util.RunData data)
          Subclasses should override this method if they wish to provide their own customization behavior.
protected  void buildConfigureContext(VelocityPortlet portlet, org.apache.velocity.context.Context context, org.apache.turbine.util.RunData data)
          prevents possible self-referencing loop when sub-classes invoke super.buildConfigureContext().
protected  void buildMaximizedContext(Portlet portlet, org.apache.velocity.context.Context context, org.apache.turbine.util.RunData data)
          Subclasses should override this method if they wish to build specific content when maximized.
protected  void buildMaximizedContext(VelocityPortlet portlet, org.apache.velocity.context.Context context, org.apache.turbine.util.RunData data)
          prevents possible self-referencing loop when sub-classes invoke super.buildMaximizedContext().
protected  void buildNormalContext(Portlet portlet, org.apache.velocity.context.Context context, org.apache.turbine.util.RunData data)
          STW: Backwards compatibility so the overriden method is called specifically using a cast to VelocityPortlet
protected abstract  void buildNormalContext(VelocityPortlet portlet, org.apache.velocity.context.Context context, org.apache.turbine.util.RunData rundata)
          Subclasses must override this method to provide default behavior for the portlet action
 
Methods inherited from class org.apache.jetspeed.modules.actions.portlets.GenericMVCAction
checkAdministrativeAction, doPerform, getAttribute, getAttribute, getPortletInstance, perform, setAttribute
 
Methods inherited from class org.apache.jetspeed.modules.actions.portlets.PortletAction
doPerform, getContext, getPortlet, getTemplate, resetTemplate, setTemplate, setTemplate
 
Methods inherited from class org.apache.jetspeed.modules.actions.portlets.PortletActionEvent
executeEvents, fireEvent
 
Methods inherited from class org.apache.turbine.modules.ActionEvent
executeEvents, formatString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VelocityPortletAction

public VelocityPortletAction()
Method Detail

buildNormalContext

protected abstract void buildNormalContext(VelocityPortlet portlet,
                                           org.apache.velocity.context.Context context,
                                           org.apache.turbine.util.RunData rundata)
                                    throws java.lang.Exception
Subclasses must override this method to provide default behavior for the portlet action

Throws:
java.lang.Exception

buildNormalContext

protected void buildNormalContext(Portlet portlet,
                                  org.apache.velocity.context.Context context,
                                  org.apache.turbine.util.RunData data)
                           throws java.lang.Exception
STW: Backwards compatibility so the overriden method is called specifically using a cast to VelocityPortlet

Overrides:
buildNormalContext in class GenericMVCAction
Throws:
java.lang.Exception
See Also:
org.apache.jetspeed.portal.portlets.mvc.PortletAction#buildNormalContext(Portlet, Context, RunData)

buildConfigureContext

protected void buildConfigureContext(Portlet portlet,
                                     org.apache.velocity.context.Context context,
                                     org.apache.turbine.util.RunData data)
                              throws java.lang.Exception
Description copied from class: GenericMVCAction
Subclasses should override this method if they wish to provide their own customization behavior. Default is to use Portal base customizer action

Overrides:
buildConfigureContext in class GenericMVCAction
Throws:
java.lang.Exception
See Also:
org.apache.jetspeed.portal.portlets.mvc.PortletAction#buildConfigureContext(Portlet, Context, RunData)

buildConfigureContext

protected void buildConfigureContext(VelocityPortlet portlet,
                                     org.apache.velocity.context.Context context,
                                     org.apache.turbine.util.RunData data)
                              throws java.lang.Exception
prevents possible self-referencing loop when sub-classes invoke super.buildConfigureContext().

Throws:
java.lang.Exception

buildMaximizedContext

protected void buildMaximizedContext(Portlet portlet,
                                     org.apache.velocity.context.Context context,
                                     org.apache.turbine.util.RunData data)
                              throws java.lang.Exception
Description copied from class: GenericMVCAction
Subclasses should override this method if they wish to build specific content when maximized. Default behavior is to do the same as normal content.

Overrides:
buildMaximizedContext in class GenericMVCAction
Throws:
java.lang.Exception

buildMaximizedContext

protected void buildMaximizedContext(VelocityPortlet portlet,
                                     org.apache.velocity.context.Context context,
                                     org.apache.turbine.util.RunData data)
                              throws java.lang.Exception
prevents possible self-referencing loop when sub-classes invoke super.buildMaximizedContext().

Throws:
java.lang.Exception


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