---

layout: default title: Tag Developers Guide

textfield

Please make sure you have read the Tag Syntax document and understand how tag attribute syntax works.

|

Description

{% comment %}start snippet id=javadoc|javadoc=true|url=org.apache.struts2.components.TextField {% endcomment %}

Parameters

{% comment %}start snippet id=tagattributes|javadoc=false|url=struts2-tags/textfield.html {% endcomment %}

		<tr>

			<td colspan="6"><h4>Dynamic Attributes Allowed:</h4> true</td>

		</tr>

		<tr>

			<td colspan="6">&nbsp;</td>

		</tr>

		<tr>

			<th align="left" valign="top"><h4>Name</h4></th>

			<th align="left" valign="top"><h4>Required</h4></th>

			<th align="left" valign="top"><h4>Default</h4></th>

			<th align="left" valign="top"><h4>Evaluated</h4></th>

			<th align="left" valign="top"><h4>Type</h4></th>

			<th align="left" valign="top"><h4>Description</h4></th>

		</tr>

			<tr>

				<td align="left" valign="top">accesskey</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html accesskey attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">class</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">The css class to use for element - it's an alias of cssClass attribute.</td>

			</tr>

			<tr>

				<td align="left" valign="top">cssClass</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">The css class to use for element</td>

			</tr>

			<tr>

				<td align="left" valign="top">cssErrorClass</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">The css error class to use for element</td>

			</tr>

			<tr>

				<td align="left" valign="top">cssErrorStyle</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">The css error style definitions for element to use</td>

			</tr>

			<tr>

				<td align="left" valign="top">cssStyle</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">The css style definitions for element to use</td>

			</tr>

			<tr>

				<td align="left" valign="top">disabled</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html disabled attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">errorPosition</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Define error position of form element (top|bottom)</td>

			</tr>

			<tr>

				<td align="left" valign="top">id</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">HTML id attribute</td>

			</tr>

			<tr>

				<td align="left" valign="top">javascriptTooltip</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">Boolean</td>

				<td align="left" valign="top">Use JavaScript to generate tooltips</td>

			</tr>

			<tr>

				<td align="left" valign="top">key</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the key (name, value, label) for this particular component</td>

			</tr>

			<tr>

				<td align="left" valign="top">label</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Label expression used for rendering an element specific label</td>

			</tr>

			<tr>

				<td align="left" valign="top">labelSeparator</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">:</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">String that will be appended to the label</td>

			</tr>

			<tr>

				<td align="left" valign="top">labelposition</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Define label position of form element (top/left)</td>

			</tr>

			<tr>

				<td align="left" valign="top">maxLength</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">Integer</td>

				<td align="left" valign="top">Deprecated. Use maxlength instead.</td>

			</tr>

			<tr>

				<td align="left" valign="top">maxlength</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">Integer</td>

				<td align="left" valign="top">HTML maxlength attribute</td>

			</tr>

			<tr>

				<td align="left" valign="top">name</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">The name to set for element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onblur</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top"> Set the html onblur attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onchange</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html onchange attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onclick</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html onclick attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">ondblclick</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html ondblclick attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onfocus</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html onfocus attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onkeydown</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html onkeydown attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onkeypress</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html onkeypress attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onkeyup</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html onkeyup attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onmousedown</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html onmousedown attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onmousemove</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html onmousemove attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onmouseout</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html onmouseout attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onmouseover</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html onmouseover attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onmouseup</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html onmouseup attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">onselect</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html onselect attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">readonly</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">Boolean</td>

				<td align="left" valign="top">Whether the input is readonly</td>

			</tr>

			<tr>

				<td align="left" valign="top">requiredLabel</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">Boolean</td>

				<td align="left" valign="top">If set to true, the rendered element will indicate that input is required</td>

			</tr>

			<tr>

				<td align="left" valign="top">requiredPosition</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Define required position of required form element (left|right)</td>

			</tr>

			<tr>

				<td align="left" valign="top">size</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">Integer</td>

				<td align="left" valign="top">HTML size attribute</td>

			</tr>

			<tr>

				<td align="left" valign="top">style</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">The css style definitions for element to use - it's an alias of cssStyle attribute.</td>

			</tr>

			<tr>

				<td align="left" valign="top">tabindex</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html tabindex attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">template</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">The template (other than default) to use for rendering the element</td>

			</tr>

			<tr>

				<td align="left" valign="top">templateDir</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">The template directory.</td>

			</tr>

			<tr>

				<td align="left" valign="top">theme</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">The theme (other than default) to use for rendering the element</td>

			</tr>

			<tr>

				<td align="left" valign="top">title</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the html title attribute on rendered html element</td>

			</tr>

			<tr>

				<td align="left" valign="top">tooltip</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Set the tooltip of this particular component</td>

			</tr>

			<tr>

				<td align="left" valign="top">tooltipConfig</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Deprecated. Use individual tooltip configuration attributes instead.</td>

			</tr>

			<tr>

				<td align="left" valign="top">tooltipCssClass</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">StrutsTTClassic</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">CSS class applied to JavaScrip tooltips</td>

			</tr>

			<tr>

				<td align="left" valign="top">tooltipDelay</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">Classic</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Delay in milliseconds, before showing JavaScript tooltips </td>

			</tr>

			<tr>

				<td align="left" valign="top">tooltipIconPath</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Icon path used for image that will have the tooltip</td>

			</tr>

			<tr>

				<td align="left" valign="top">type</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">text</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Specifies the html5 type element to display. e.g. text, email, url</td>

			</tr>

			<tr>

				<td align="left" valign="top">value</td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top"></td>

				<td align="left" valign="top">false</td>

				<td align="left" valign="top">String</td>

				<td align="left" valign="top">Preset the value of input element.</td>

			</tr>

	</table>

Examples

{% comment %}start snippet id=exdescription|lang=none|javadoc=true|url=org.apache.struts2.components.TextField {% endcomment %}

 In this example, a text control for the "user" property is rendered. The label is also retrieved from a ResourceBundle via the key attribute.

{% comment %}end snippet id=exdescription|lang=none|javadoc=true|url=org.apache.struts2.components.TextField {% endcomment %}

{% comment %}start snippet id=example|lang=xml|javadoc=true|url=org.apache.struts2.components.TextField {% endcomment %}

 <s:textfield key="user" />

{% comment %}end snippet id=example|lang=xml|javadoc=true|url=org.apache.struts2.components.TextField {% endcomment %}