This project has retired. For details please refer to its Attic page.

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

java.lang.Object
  org.apache.turbine.modules.Assembler
      org.apache.turbine.modules.Action
          org.apache.turbine.modules.ActionEvent
              org.apache.jetspeed.modules.actions.portlets.PortletActionEvent
                  org.apache.jetspeed.modules.actions.portlets.PortletAction
                      org.apache.jetspeed.modules.actions.portlets.GenericMVCAction
                          org.apache.jetspeed.modules.actions.portlets.VelocityPortletAction
                              org.apache.jetspeed.modules.actions.portlets.CustomizeAction

public class CustomizeAction

extends VelocityPortletAction

This action implements the default portlet behavior customizer

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

Author:

Raphaël Luta

Field Summary

static java.lang.String

PARAM_NAMESPACE

Fields inherited from class org.apache.turbine.modules.ActionEvent

BUTTON, BUTTON_LENGTH, LENGTH, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX

Constructor Summary

CustomizeAction()

Method Summary

protected 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 Context Description action Action to use current_skin Current skin for this portlet INSTANCE params List of configurable parameters from the REGISTRY entry. portlet Portlet, not the Portlet Instance! skins List of skins security List of security ref security_ref Current securityRef for this portlet INSTANCE
void	doCancel(org.apache.turbine.util.RunData rundata, org.apache.velocity.context.Context context) Clean up the customization state
void	doDefault(org.apache.turbine.util.RunData rundata, org.apache.velocity.context.Context context) Resets the portlet settings to default
void	doUpdate(org.apache.turbine.util.RunData rundata, org.apache.velocity.context.Context context) Updates the customized portlet entry

Methods inherited from class org.apache.jetspeed.modules.actions.portlets.VelocityPortletAction

buildConfigureContext, buildConfigureContext, buildMaximizedContext, buildMaximizedContext, buildNormalContext

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

Field Detail

PARAM_NAMESPACE

public static final java.lang.String PARAM_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

CustomizeAction

public CustomizeAction()

Method Detail

buildNormalContext

protected 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

Context	Description
action	Action to use
current_skin	Current skin for this portlet INSTANCE
params	List of configurable parameters from the REGISTRY entry.
portlet	Portlet, not the Portlet Instance!
skins	List of skins
security	List of security ref
security_ref	Current securityRef for this portlet INSTANCE

Specified by:

buildNormalContext in class VelocityPortletAction

doCancel

public void doCancel(org.apache.turbine.util.RunData rundata,
                     org.apache.velocity.context.Context context)

Clean up the customization state

doDefault

public void doDefault(org.apache.turbine.util.RunData rundata,
                      org.apache.velocity.context.Context context)

Resets the portlet settings to default

Parameters:

rundata -

context -

doUpdate

public void doUpdate(org.apache.turbine.util.RunData rundata,
                     org.apache.velocity.context.Context context)

Updates the customized portlet entry