User Documentation

One Minute Introduction

Two Minute Introduction

Your own plugin

Coffee Break Introduction

Property substitution

FAQ

IDE Integration

Doclipse

Maven Integration

Maven2 Plugin

Maven1 Plugin

Plugins

Project Information

Mailing lists

Source Repositories

Open Issues

Team

Developer Documentation

Feeds
Print
StrutsTags

@struts tags

@struts.action-exception

Defines the action specific exception handling.

Applies to: Struts Action.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
key true Any value   no   The key to use with this handler's message resource bundle that will retrieve the error message template for this

exception.
type true Any value   no   Fully qualified Java class name of the exception type to register with this handler.
class-name false Any value   no   The configuration bean for this ExceptionHandler object. If specified, className must be a subclass of the default configuration bean.
handler false Any value   no   Fully qualified Java class name for this exception handler.
path false Any value   no   The module-relative URI to the resource that will complete the request/response if this exception occurs.
scope false request, session   no   The context ("request" or "session") that is used to access the ActionError object for this exception.

@struts.action-forward

Defines local forwards for a Struts action class.

Applies to: Struts Action.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   The name of the forward
path true Any value   no   The path of the forward
redirect false true, false   no   Whether the browser should be redirected to the specified location.

@struts.action-set-property

Creates set-property tags for action blocks.

Applies to: Struts Action.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
property true Any value   no   The name of the property to set.
value true Any value   no   The value to set the property.

@struts.action

Defines the action class and its attributes.

Applies to: Struts Action.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
name false Any value   no   The name of the action. Must be unique within the bounds of the Struts application
type false Any value   no   The class to instantiate for this action. Defaults to the current class, but can be overridden for certain uses,

such as integration with Spring.
path true Any value   no   The path that the action will match.
scope true request, session, application   no   Define the scope of the action. Must be one of: "request", "session" or "application"
input false Any value   no   The path to the input for the Action
roles false Any value   no   Comma-delimited list of security role names that are allowed access to this ActionMapping object. Since Struts

1.1.
validate false true, false   no   The validation flag for the action
parameter false Any value   no   The parameter name to use with LookupDispatchAction
unknown false Any value   no   Set to true if this action should be configured as the default for this application, to handle all requests

not handled by another action. Only one action can be defined as a default within a single application.

@struts.dynaform-field

Include property in specific struts form.

Applies to: property to be included.

Unique false

Allowed locations

class method constructor field
false true false false
Parameter Required Allowed values Default value Array Token separator Description
name false Any value   no   The name of the JavaBean property described by this element. Declare, if you want to override the generated

property name. Default is the method's name converted to a property name.
type false Any value   no   Fully qualified Java class name of the field underlying this property, optionally followed by "[]" to indicate

that the field is indexed. Declare, if you want to override the generated property type. Default is the method's

return type.
initial false Any value   no   String representation of the initial value for this property. If not specified, primitives will be initialized to

zero and objects initialized to the zero-argument instantiation of that object class. For example, Strings will

be initialized to "".
size false Any value   no   The number of array elements to create if the value of the "type" attribute specifies an array, but there is no

value specified for the "initial" attribute.

@struts.dynaform

Defines a dynamic form bean and its attributes.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   Define a unique name for the form.
type true Any value   no   Define the class type of dynamic form.
validate false true, false   no   Declare if this form should be validated. If set to true, the dynamic form validation tag will iterate over this

class and create the validation definition.

@struts.form-field

Include property in specific struts form.

Applies to: property to be included.

Unique false

Allowed locations

class method constructor field
false true false false
Parameter Required Allowed values Default value Array Token separator Description
form-name false Any value   no   Specify the name of the form this field should belong to. Required if "name" defined on

@struts.form.

@struts.form

Defines a form bean and its attributes.

Applies to: Entity beans and POJOs.

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   Define a unique name for the form. If generating a form using this tag, this attribute is not necessary. The

className+Form will be used (i.e. Address -> addressForm).
extends false Any value   no   Define which class the generated form must extend.
implements false Any value   no   Define which interface the generated form must implement.
include-pk false true, false   no   Whether to include pk field in form. Default is true. If set to false, individual pk fields can still be

included.
include-all false true, false   no   Whether to include all persistent fields in form. Default is false. Default value(s):

@struts.tiles-put

Struts Tiles Put Tag

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   Name
value true Any value   no   Value
parent false Any value   no   Parent Tile

@struts.tiles

Struts Tiles Tag

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   Name
path false Any value   no   Path
extends false Any value   no   Tile to extend

@struts.validator-args

Defines arguments for current setter field.

Applies to: Struts ValidatorForm

Unique false

Allowed locations

class method constructor field
false true false false
Parameter Required Allowed values Default value Array Token separator Description
arg0value false Any value   no   Value of argument index 0
arg0resource false Any value   no   Resource key of argument index 0
arg1value false Any value   no   Value of argument index 1
arg1resource false Any value   no   Resource key of argument index 1
arg2value false Any value   no   Value of argument index 2
arg2resource false Any value   no   Resource key of argument index 2
arg3value false Any value   no   Value of argument index 3
arg3resource false Any value   no   Resource key of argument index 3

@struts.validator

TDefines Struts Validator for current setter field. NOTE: If you're generating forms from POJOs, this tag needs to be

on the getter. It will be put on the setter in the generated Form.</br> Applies to: Struts ValidatorForm

Unique false

Allowed locations

class method constructor field
false true false false
Parameter Required Allowed values Default value Array Token separator Description
type true Any value   no   Validator type, such as "required"
msgkey false Any value   no   Override key for the validator error message
msgvalue false Any value   no   Explicitly define a validator error message
page false Any value   no   Only fields with a "page" attribute value that is equal to or less than the page property on the form JavaBean

are processed.
arg0value false Any value   no   Value of argument index 0
arg0resource false Any value   no   Resource key of argument index 0
arg1value false Any value   no   Value of argument index 1
arg1resource false Any value   no   Resource key of argument index 1
arg2value false Any value   no   Value of argument index 2
arg2resource false Any value   no   Resource key of argument index 2
arg3value false Any value   no   Value of argument index 3
arg3resource false Any value   no   Resource key of argument index 3

@struts.validator-var

Defines Struts Validator variable.

Applies to: Struts ValidatorForm

Unique false

Allowed locations

class method constructor field
false true false false
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   Variable name.
value true Any value   no   Variable value.
Copyright 2003-2006 - The Codehaus. All rights reserved unless otherwise noted.
Powered by Atlassian Confluence