Properties for Struts bean tags

Properties for Struts bean tags

This documentation describes the properties for the elements that are defined in the Struts bean tag library. By default, the name of each of these elements has a bean: prefix.

Each Struts element has a number of properties that you can set by using the element's Properties view. Use this table of properties while working with the element's Properties view, to look up properties for which you want additional detail. Some properties have the same name but different usage in different elements. The properties are listed in alphabetical order.

Properties In element Description
arg0 message Specifies the first parametric replacement value, if any.
arg1 message Specifies the second parametric replacement value, if any.
arg2 message Specifies the third parametric replacement value, if any.
arg3 message Specifies the fourth parametric replacement value, if any.
arg4 message Specifies the fifth parametric replacement value, if any.
bundle message, write Specifies the name of the application scope bean under which the MessageResources object that contains messages is stored. The default is Globals.MESSAGES_KEY.
filter write If set to false, suppresses filtering of the rendered property value for characters that are sensitive in HTML. By default, such values are converted to their entity equivalents.
format write Specifies the format string to use to convert a bean or property value to the String object. By default, the format string for value data type will be searched in message resources according to key.
formatKey write Specifies the key to be used to search a format string in application resources.
id define Specifies the name of the scripting variable (and associated page scope attribute) that will be made available with the value of the specified property. [Required]
ignore write If set to true and the bean specified by the name and scope properties does not exist, returns without writing anything. If set to false and the bean does not exist, throws a run-time exception.
key message Specifies the message key of the requested message, which must have a corresponding value in the message resources. By default, the key is obtained from the name and property properties.
locale message, write Specifies the name of the session scope bean under which our currently selected Locale object is stored. The default is Globals.LOCALE_KEY.
name define Specifies the attribute name of the bean whose property is accessed to define a new page scope attribute (if property is also specified) or the attribute name of the bean that is duplicated with the new reference created by this tag (if property is not also specified). This attribute is required unless you specify a value attribute or nested body content.
name message Specifies the attribute name of the bean whose property is accessed to retrieve the value specified by property (if specified). If you omit property, the value of this bean itself will be used as the message resource key.
property define Specifies the name of the property to be accessed on the bean specified by name. This value can be a simple, indexed, or nested property reference expression. By default, the bean identified by name is given a new reference identified by id.
property message Specifies the name of the property to be accessed on the bean specified by name. This value can be a simple, indexed, or nested property reference expression. By default, the value of the bean identified by name will itself be used as the message resource key.
property write Specifies the name of the property to be accessed on the bean specified by name. This value can be a simple, indexed, or nested property reference expression. By default, the bean identified by name will itself be rendered. If the specified property returns null, no output will be rendered.
scope define, message, write Specifies the variable scope that to be searched to retrieve the bean specified by name. By default, the default rules applied by PageContext.findAttribute() are applied.
toScope define Specifies the variable scope into which the newly defined bean will be created. By default, the bean is created in page scope.
type define Specifies the fully qualified class name of the value to be exposed as the id attribute. The default is java.lang.String if you specify a value attribute or java.lang.Object otherwise.
value define Specifies the java.lang.String value to which the exposed bean should be set. This attribute is required unless you specify the name attribute or nested body content.

Related tasks
Adding Struts tags to a JSP file

Related reference
Properties for Struts tiles tags
Properties for Struts HTML tags
Properties for Struts logic tags
Properties for Struts nested tags
Properties for Struts tags

Feedback

Properties	In element	Description
arg0	message	Specifies the first parametric replacement value, if any.
arg1	message	Specifies the second parametric replacement value, if any.
arg2	message	Specifies the third parametric replacement value, if any.
arg3	message	Specifies the fourth parametric replacement value, if any.
arg4	message	Specifies the fifth parametric replacement value, if any.
bundle	message, write	Specifies the name of the application scope bean under which the MessageResources object that contains messages is stored. The default is Globals.MESSAGES_KEY.
filter	write	If set to false, suppresses filtering of the rendered property value for characters that are sensitive in HTML. By default, such values are converted to their entity equivalents.
format	write	Specifies the format string to use to convert a bean or property value to the String object. By default, the format string for value data type will be searched in message resources according to key.
formatKey	write	Specifies the key to be used to search a format string in application resources.
id	define	Specifies the name of the scripting variable (and associated page scope attribute) that will be made available with the value of the specified property. [Required]
ignore	write	If set to true and the bean specified by the name and scope properties does not exist, returns without writing anything. If set to false and the bean does not exist, throws a run-time exception.
key	message	Specifies the message key of the requested message, which must have a corresponding value in the message resources. By default, the key is obtained from the name and property properties.
locale	message, write	Specifies the name of the session scope bean under which our currently selected Locale object is stored. The default is Globals.LOCALE_KEY.
name	define	Specifies the attribute name of the bean whose property is accessed to define a new page scope attribute (if property is also specified) or the attribute name of the bean that is duplicated with the new reference created by this tag (if property is not also specified). This attribute is required unless you specify a value attribute or nested body content.
name	message	Specifies the attribute name of the bean whose property is accessed to retrieve the value specified by property (if specified). If you omit property, the value of this bean itself will be used as the message resource key.
property	define	Specifies the name of the property to be accessed on the bean specified by name. This value can be a simple, indexed, or nested property reference expression. By default, the bean identified by name is given a new reference identified by id.
property	message	Specifies the name of the property to be accessed on the bean specified by name. This value can be a simple, indexed, or nested property reference expression. By default, the value of the bean identified by name will itself be used as the message resource key.
property	write	Specifies the name of the property to be accessed on the bean specified by name. This value can be a simple, indexed, or nested property reference expression. By default, the bean identified by name will itself be rendered. If the specified property returns null, no output will be rendered.
scope	define, message, write	Specifies the variable scope that to be searched to retrieve the bean specified by name. By default, the default rules applied by PageContext.findAttribute() are applied.
toScope	define	Specifies the variable scope into which the newly defined bean will be created. By default, the bean is created in page scope.
type	define	Specifies the fully qualified class name of the value to be exposed as the id attribute. The default is java.lang.String if you specify a value attribute or java.lang.Object otherwise.
value	define	Specifies the java.lang.String value to which the exposed bean should be set. This attribute is required unless you specify the name attribute or nested body content.