Class ButtonTag

java.lang.Object

jakarta.servlet.jsp.tagext.TagSupport

org.springframework.web.servlet.tags.RequestContextAwareTag

org.springframework.web.servlet.tags.HtmlEscapingAwareTag

org.springframework.web.servlet.tags.form.AbstractFormTag

org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag

org.springframework.web.servlet.tags.form.AbstractHtmlElementTag

org.springframework.web.servlet.tags.form.ButtonTag

All Implemented Interfaces:

jakarta.servlet.jsp.tagext.DynamicAttributes, jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, jakarta.servlet.jsp.tagext.TryCatchFinally, Serializable, EditorAwareTag

public class ButtonTag
extends AbstractHtmlElementTag

The <button> tag renders a form field label in an HTML 'button' tag. It is provided for completeness if the application relies on a RequestDataValueProcessor.

Attribute Summary

Attribute	Required?	Runtime Expression?	Description
disabled	false	true	HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element.
id	false	true	HTML Standard Attribute
name	false	true	The name attribute for the HTML button tag
value	false	true	The name attribute for the HTML button tag

Since:

3.1

Author:

Rossen Stoyanchev

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DISABLED_ATTRIBUTE	The name of the 'disabled' attribute.

Fields inherited from class AbstractHtmlElementTag

CLASS_ATTRIBUTE, DIR_ATTRIBUTE, LANG_ATTRIBUTE, ONCLICK_ATTRIBUTE, ONDBLCLICK_ATTRIBUTE, ONKEYDOWN_ATTRIBUTE, ONKEYPRESS_ATTRIBUTE, ONKEYUP_ATTRIBUTE, ONMOUSEDOWN_ATTRIBUTE, ONMOUSEMOVE_ATTRIBUTE, ONMOUSEOUT_ATTRIBUTE, ONMOUSEOVER_ATTRIBUTE, ONMOUSEUP_ATTRIBUTE, STYLE_ATTRIBUTE, TABINDEX_ATTRIBUTE, TITLE_ATTRIBUTE

Fields inherited from class AbstractDataBoundFormElementTag

NESTED_PATH_VARIABLE_NAME

Fields inherited from class RequestContextAwareTag

logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE

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

pageContext

Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
ButtonTag()

Method Summary

Modifier and Type	Method	Description
int	doEndTag()	Closes the 'button' block tag.
protected String	getDefaultValue()	Return the default value.
@Nullable String	getName()	Set the value of the 'name' attribute.
protected String	getType()	Get the value of the 'type' attribute.
@Nullable String	getValue()	Get the value of the 'value' attribute.
boolean	isDisabled()	Get the value of the 'disabled' attribute.
void	setDisabled(boolean disabled)	Set the value of the 'disabled' attribute.
void	setName(String name)	Get the value of the 'name' attribute.
void	setValue(@Nullable String value)	Set the value of the 'value' attribute.
protected int	writeTagContent(TagWriter tagWriter)	Subclasses should implement this method to perform tag content rendering.
protected void	writeValue(TagWriter tagWriter)	Writes the 'value' attribute to the supplied TagWriter.

Methods inherited from class AbstractHtmlElementTag

getCssClass, getCssErrorClass, getCssStyle, getDir, getDynamicAttributes, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTabindex, getTitle, isValidDynamicAttribute, resolveCssClass, setCssClass, setCssErrorClass, setCssStyle, setDir, setDynamicAttribute, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setTabindex, setTitle, writeDefaultAttributes, writeOptionalAttributes

Methods inherited from class AbstractDataBoundFormElementTag

autogenerateId, convertToDisplayString, doFinally, getBindStatus, getBoundValue, getEditor, getId, getNestedPath, getPath, getPropertyEditor, getPropertyPath, processFieldValue, resolveId, setId, setPath

Methods inherited from class AbstractFormTag

createTagWriter, doStartTagInternal, evaluate, getDisplayString, getDisplayString, isDefaultHtmlEscape, writeOptionalAttribute

Methods inherited from class HtmlEscapingAwareTag

htmlEscape, isHtmlEscape, isResponseEncodedHtmlEscape, setHtmlEscape

Methods inherited from class RequestContextAwareTag

doCatch, doStartTag, getRequestContext

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

doAfterBody, findAncestorWithClass, getParent, getValue, getValues, release, removeValue, setPageContext, setParent, setValue

Methods inherited from class Object

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

Field Details

DISABLED_ATTRIBUTE

public static final String DISABLED_ATTRIBUTE

The name of the 'disabled' attribute.

See Also:

• Constant Field Values

Constructor Details

ButtonTag

public ButtonTag()

Method Details

setName

public void setName(String name)

Get the value of the 'name' attribute.

getName

public @Nullable String getName()

Set the value of the 'name' attribute.

Overrides:

getName in class AbstractDataBoundFormElementTag

Returns:

the value for the HTML 'name' attribute

setValue

public void setValue(@Nullable String value)

Set the value of the 'value' attribute.

getValue

public @Nullable String getValue()

Get the value of the 'value' attribute.

setDisabled

public void setDisabled(boolean disabled)

Set the value of the 'disabled' attribute.

isDisabled

public boolean isDisabled()

Get the value of the 'disabled' attribute.

writeTagContent

protected int writeTagContent(TagWriter tagWriter)
                       throws jakarta.servlet.jsp.JspException

Description copied from class: AbstractFormTag

Subclasses should implement this method to perform tag content rendering.

Specified by:

writeTagContent in class AbstractFormTag

Returns:

valid tag render instruction as per Tag.doStartTag().

Throws:

jakarta.servlet.jsp.JspException

writeValue

protected void writeValue(TagWriter tagWriter)
                   throws jakarta.servlet.jsp.JspException

Writes the 'value' attribute to the supplied TagWriter. Subclasses may choose to override this implementation to control exactly when the value is written.

Throws:

jakarta.servlet.jsp.JspException

getDefaultValue

protected String getDefaultValue()

Return the default value.

Returns:

the default value if none supplied

getType

protected String getType()

Get the value of the 'type' attribute. Subclasses can override this to change the type of 'input' element rendered. Default value is 'submit'.

doEndTag

public int doEndTag()
             throws jakarta.servlet.jsp.JspException

Closes the 'button' block tag.

Specified by:

doEndTag in interface jakarta.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class jakarta.servlet.jsp.tagext.TagSupport

Throws:

jakarta.servlet.jsp.JspException