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

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

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

Direct Known Subclasses:

PortletAction

public abstract class PortletActionEvent

extends org.apache.turbine.modules.ActionEvent

Provides form based action handling via the eventSubmit_do[action] pattern. Works just like the mechanism described for the velocity portlet. Extends this convienent functionality to all GenericMVCPortlets

Version:

$Id: PortletActionEvent.java,v 1.3.2.1 2003/02/24 18:45:42 tkuebler Exp $

Author:

tkuebler, Scott T. Weaver

Field Summary

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

BUTTON, BUTTON_LENGTH, LENGTH, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX

Constructor Summary

PortletActionEvent()

Method Summary

abstract void	doPerform(org.apache.turbine.util.RunData data) You need to implement this in your classes that extend this class.
void	executeEvents(org.apache.turbine.util.RunData data, org.apache.velocity.context.Context context) This method should be called to execute the event based system.
protected boolean	fireEvent(org.apache.turbine.util.RunData data, java.lang.Class deltaClass, java.lang.Object deltaValue, java.lang.String theButton) Convenience method for firing portlet events.
protected void	perform(org.apache.turbine.util.RunData data) This overrides the default Action.perform() to execute the doEvent() method.

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

PortletActionEvent

public PortletActionEvent()

Method Detail

doPerform

public abstract void doPerform(org.apache.turbine.util.RunData data)
                        throws java.lang.Exception

You need to implement this in your classes that extend this class.

Parameters:

data - A Turbine RunData object.

Throws:

Exception, - a generic exception.

java.lang.Exception

perform

protected void perform(org.apache.turbine.util.RunData data)
                throws java.lang.Exception

This overrides the default Action.perform() to execute the doEvent() method. If that fails, then it will execute the doPerform() method instead.

Parameters:

data - A Turbine RunData object.

Throws:

Exception, - a generic exception.

java.lang.Exception

executeEvents

public void executeEvents(org.apache.turbine.util.RunData data,
                          org.apache.velocity.context.Context context)
                   throws java.lang.Exception

This method should be called to execute the event based system.

Parameters:

data - A Turbine RunData object.

context - context information.

Throws:

Exception, - a generic exception.

java.lang.Exception

fireEvent

protected boolean fireEvent(org.apache.turbine.util.RunData data,
                            java.lang.Class deltaClass,
                            java.lang.Object deltaValue,
                            java.lang.String theButton)

Convenience method for firing portlet events.