Apache Struts API Documentation: Class BaseFieldTag

Apache Struts API

previous page next page

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.struts.taglib.html Class BaseFieldTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--javax.servlet.jsp.tagext.BodyTagSupport
              |
              +--org.apache.struts.taglib.html.BaseHandlerTag
                    |
                    +--org.apache.struts.taglib.html.BaseInputTag
                          |
                          +--org.apache.struts.taglib.html.BaseFieldTag

All Implemented Interfaces:: javax.servlet.jsp.tagext.BodyTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:: FileTag, HiddenTag, PasswordTag, TextTag

public abstract class BaseFieldTag
extends BaseInputTag

Convenience base class for the various input tags for text fields.

Version:: $Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
See Also:: Serialized Form

Field Summary
`protected java.lang.String`	`accept` Comma-delimited list of content types that a server processing this form will handle correctly.
`protected boolean`	`redisplay` The "redisplay contents" flag (used only on `password`).
`protected java.lang.String`	`type` The type of input field represented by this tag (text, password, or hidden).

Fields inherited from class org.apache.struts.taglib.html.BaseInputTag

cols, maxlength, messages, name, property, rows, value

Fields inherited from class org.apache.struts.taglib.html.BaseHandlerTag

accesskey, alt, altKey, bundle, defaultLocale, disabled, doDisabled, doReadonly, errorKey, errorStyle, errorStyleClass, errorStyleId, indexed, locale, log, loopTagStatusClass, loopTagStatusGetIndex, loopTagSupportClass, loopTagSupportGetStatus, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, readonly, style, styleClass, styleId, tabindex, title, titleKey, triedJstlInit, triedJstlSuccess

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext, parent, values

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary
`BaseFieldTag()`

Method Summary
`int`	`doStartTag()` Generate the required input tag.
`protected java.lang.String`	`formatValue(java.lang.Object value)` Return the given value as a formatted `String`.
`java.lang.String`	`getAccept()`
`boolean`	`getRedisplay()`
`protected void`	`prepareValue(java.lang.StringBuffer results)` Render the value element
`void`	`release()` Release any acquired resources.
`protected java.lang.String`	`renderInputElement()` Renders a fully formed <input> element.
`void`	`setAccept(java.lang.String accept)`
`void`	`setRedisplay(boolean redisplay)`

Methods inherited from class org.apache.struts.taglib.html.BaseInputTag

doEndTag, getCols, getMaxlength, getName, getProperty, getRows, getSize, getValue, prepareName, setCols, setMaxlength, setName, setProperty, setRows, setSize, setValue

Methods inherited from class org.apache.struts.taglib.html.BaseHandlerTag

doErrorsExist, getAccesskey, getAlt, getAltKey, getBundle, getDisabled, getElementClose, getErrorKey, getErrorStyle, getErrorStyleClass, getErrorStyleId, getIndexed, getIndexValue, getJstlLoopIndex, getLocale, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getReadonly, getStyle, getStyleClass, getStyleId, getTabindex, getTitle, getTitleKey, isXhtml, lookupProperty, message, prepareAttribute, prepareEventHandlers, prepareFocusEvents, prepareIndex, prepareKeyEvents, prepareMouseEvents, prepareOtherAttributes, prepareStyles, prepareTextEvents, setAccesskey, setAlt, setAltKey, setBundle, setDisabled, setErrorKey, setErrorStyle, setErrorStyleClass, setErrorStyleId, setIndexed, setLocale, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setStyle, setStyleClass, setStyleId, setTabindex, setTitle, setTitleKey

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Detail

accept

protected java.lang.String accept

Comma-delimited list of content types that a server processing this form will handle correctly. This property is defined only for the file tag, but is implemented here because it affects the rendered HTML of the corresponding <input> tag.

redisplay

protected boolean redisplay

The "redisplay contents" flag (used only on password).

type

protected java.lang.String type

The type of input field represented by this tag (text, password, or hidden).

Constructor Detail

BaseFieldTag

public BaseFieldTag()

Method Detail

getAccept

public java.lang.String getAccept()

setAccept

public void setAccept(java.lang.String accept)

getRedisplay

public boolean getRedisplay()

setRedisplay

public void setRedisplay(boolean redisplay)

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Generate the required input tag.

Support for indexed property since Struts 1.1

Overrides:: doStartTag in class BaseInputTag

Throws:: javax.servlet.jsp.JspException - if a JSP exception has occurred

renderInputElement

protected java.lang.String renderInputElement()
                                       throws javax.servlet.jsp.JspException

Renders a fully formed <input> element.

Throws:: javax.servlet.jsp.JspException -
Since:: Struts 1.2

prepareValue

protected void prepareValue(java.lang.StringBuffer results)
                     throws javax.servlet.jsp.JspException

Render the value element

Parameters:: results - The StringBuffer that output will be appended to.

formatValue

protected java.lang.String formatValue(java.lang.Object value)
                                throws javax.servlet.jsp.JspException

Return the given value as a formatted String. This implementation escapes potentially harmful HTML characters.

Parameters:: value - The value to be formatted. null values will be returned as the empty String "".
Throws:: javax.servlet.jsp.JspException - if a JSP exception has occurred
Since:: Struts 1.2

release

public void release()

Release any acquired resources.

Overrides:: release in class BaseInputTag