OpenSymphony - ActionComponent (WebWork API

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.opensymphony.webwork.components
Class ActionComponent

java.lang.Object
  com.opensymphony.webwork.components.Component
      com.opensymphony.webwork.components.ActionComponent

public class ActionComponent
extends Component
extends Component

This tag enables developers to call actions directly from a JSP page by specifying the action name and an optional namespace. The body content of the tag is used to render the results from the Action. Any result processor defined for this action in xwork.xml will be ignored, unless the executeResult parameter is specified.

id (String) - the id (if specified) to put the action under stack's context.
name* (String) - name of the action to be executed (without the extension suffix eg. .action)
namespace (String) - default to the namespace where this action tag is invoked
executeResult (Boolean) - default is false. Decides wheather the result of this action is to be executed or not
ignoreContextParams (Boolean) - default to false. Decides wheather the request parameters are to be included when the action is invoked

 
 public class ActionTagAction extends ActionSupport {

        public String execute() throws Exception {
                return "done";
        }

        public String doDefault() throws Exception {
                ServletActionContext.getRequest().setAttribute("stringByAction", "This is a String put in by the action's doDefault()");
                return "done";
        }
 }

 
   
      ....
     
         success.jsp
     
      
         success.jsp
     
      ....

 
  The following action tag will execute result and include it in this page
        

        
  

  The following action tag will do the same as above, but invokes method specialMethod in action
        

        
  

  The following action tag will not execute result, but put a String in request scope
       under an id "stringByAction" which will be retrieved using property tag

Since:: 2.2
Version:: $Revision: 2730 $
Author:: Pat Lightbody, tm_jee ( tm_jee (at) yahoo.co.uk ), Rene Gielen

Field Summary

protected boolean executeResult


protected boolean flush


protected boolean ignoreContextParams


protected String name


protected String namespace


protected ActionProxy proxy


protected HttpServletRequest req


protected HttpServletResponse res


Fields inherited from class com.opensymphony.webwork.components.Component

COMPONENT_STACK, id, parameters, stack

Constructor Summary

ActionComponent(OgnlValueStack stack, HttpServletRequest req, HttpServletResponse res)


Method Summary

boolean end(Writer writer, String body)
          Callback for the end tag of this component.

ActionProxy getProxy()


void setExecuteResult(boolean executeResult)
          whether the result of this action (probably a view) should be executed/rendered

void setFlush(boolean flush)
          whether the writer should be flush upon end of the action tag, default to true.

void setId(String id)
          the id (if speficied) to put the action under stack's context.

void setIgnoreContextParams(boolean ignoreContextParams)
          whether the request parameters are to be included when the action is invoked

void setName(String name)
          name of the action to be executed (without the extension suffix eg.

void setNamespace(String namespace)
          namespace for action to call

Methods inherited from class com.opensymphony.webwork.components.Component

addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, start, toString, usesBody

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

res

protected HttpServletResponse res

req

protected HttpServletRequest req

proxy

protected ActionProxy proxy

name

protected String name

namespace

protected String namespace

executeResult

protected boolean executeResult

ignoreContextParams

protected boolean ignoreContextParams

flush

protected boolean flush

Constructor Detail

ActionComponent

public ActionComponent(OgnlValueStack stack,
                       HttpServletRequest req,
                       HttpServletResponse res)

Method Detail

end

public boolean end(Writer writer,
                   String body)

Description copied from class: Component

Callback for the end tag of this component. Should the body be evaluated again?

NOTE: will pop component stack.

Overrides:: end in class Component

Parameters:: writer - the output writer.; body - the rendered body.
Returns:: true if the body should be evaluated again

getProxy

public ActionProxy getProxy()

setId

public void setId(String id)

the id (if speficied) to put the action under stack's context.

Overrides:: setId in class Component

setName

public void setName(String name)

name of the action to be executed (without the extension suffix eg. .action)

setNamespace

public void setNamespace(String namespace)

namespace for action to call

setExecuteResult

public void setExecuteResult(boolean executeResult)

whether the result of this action (probably a view) should be executed/rendered

setIgnoreContextParams

public void setIgnoreContextParams(boolean ignoreContextParams)

whether the request parameters are to be included when the action is invoked

setFlush

public void setFlush(boolean flush)

whether the writer should be flush upon end of the action tag, default to true.