Package com.randomnoun.common.webapp.taglib

Class StandardHtmlTag

java.lang.Object

jakarta.servlet.jsp.tagext.TagSupport

com.randomnoun.common.webapp.taglib.StandardHtmlTag

All Implemented Interfaces:

jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable

Direct Known Subclasses:

SelectTag

public abstract class StandardHtmlTag
extends jakarta.servlet.jsp.tagext.TagSupport

This is an abstract taglib, which can be used to propagate standard HTML attributes through to a HTML page. It provides handlers for all the 'general' attributes that are present for most HTML tags (e.g. onclick, style, ...).

Other taglibs that are used to generate HTML elements (e.g. SelectTag), can extend this class to take advantage of this functionality.

Superclasses may override any method defined in this tag to provide their own special handling. The attributes handled by this tag are accesskey, styleClass, contenteditable, dir, disabled, lang, language, maxlength, size, style, title, width, onactivate, onafterupdate, onbeforeactvate, onbeforecut, onbeforedeactivate, onbeforeeditfocus, onbeforepaste, onbeforeupdate, onblur, onchange, onclick, oncontextmenu, oncontrolselect, oncut, ondblclick, ondeactivate, ondrag, ondragend, ondragenter, ondragleave, ondragover, ondragstart, ondrop, onerrorupdate, onfilterchange, onfocus, onfocusin, onfocusout, onhelp, onkeydown, onkeypress, onkeyup, onlosecapture, onmousedown, onmouseenter, onmouseleave, onmousemove, onmouseout, onmouseover, onmouseup, onmousewheel, onmove, onmoveend, onmovestart, onpaste, onpropertychange, onreadystatechange, onresize, onresizeend, onresizestart, onselect, onselectstart, ontimeerror, hidefocus, readonly, tabindex and unselectable.

Note that the HTML attribute 'class' is now called 'styleClass', since the Object.getClass() method interferes with standard JavaBean reflection.

All attributes are lower-case, except extraAttributes (see below).

Note that the attributes 'name', 'type' and 'value' are intentionally not on this list, as they would normally be generated by the specific tag libary itself.

The 'disabled' attributes has some special handling -- if it's set to the value "false", then the attribute is removed. This is due to IE treating 'disabled="false"' as actually disabling the control. Which is odd.

The IE-only attributes hidefocus, readonly, tabindex and unselectable are included on this list, because they seem reasonably useful. The IE-only attributes begin, end, datafld, datasrc, autocomplete, syncmasterm, timecontainer and vcard_name are not on this list, because they don't seem as useful. You can always add them if you think they're needed.

Values are EL-evaluated (so you can have JSTL-style ${xxxx} values).

Additional attributes can be expressed using the extraAttributes attribute, e.g. to put a non-standard attribute 'onmousewheelclick' into the element, you could use, for example:

 <mm:something extraAttribute="onmousewheelclick='doSomethingInJavascript()'" />
 

Any tag that extends this class should have the following text in it's .tld descriptor:

    <!-- Attributes understood by StandardHtmlTag -->
    <attribute><name>accesskey</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>styleClass</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>contenteditable</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>dir</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>disabled</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>lang</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>language</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>maxlength</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>size</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>style</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>title</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>width</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onactivate</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onafterupdate</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onbeforeactvate</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onbeforecut</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onbeforedeactivate</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onbeforeeditfocus</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onbeforepaste</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onbeforeupdate</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onblur</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onchange</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onclick</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>oncontextmenu</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>oncontrolselect</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>oncut</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>ondblclick</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>ondeactivate</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>ondrag</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>ondragend</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>ondragenter</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>ondragleave</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>ondragover</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>ondragstart</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>ondrop</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onerrorupdate</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onfilterchange</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onfocus</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onfocusin</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onfocusout</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onhelp</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onkeydown</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onkeypress</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onkeyup</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onlosecapture</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onmousedown</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onmouseenter</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onmouseleave</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onmousemove</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onmouseout</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onmouseover</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onmouseup</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onmousewheel</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onmove</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onmoveend</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onmovestart</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onpaste</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onpropertychange</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onreadystatechange</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onresize</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onresizeend</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onresizestart</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onselect</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>onselectstart</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>ontimeerror</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>hidefocus</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>readonly</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>tabindex</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>unselectable</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
    <attribute><name>extraAttributes</name><required>false</required><rtexprvalue>true</rtexprvalue></attribute>
 

NB: Implementing classes MUST call getAttributes().clear(); in their doEnd() method, in case the JSP container decides to reuse taglib instances.

Author:

knoxg

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	attributes
protected String	extraAttributes

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

id, 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
StandardHtmlTag()

Method Summary

Modifier and Type	Method	Description
protected void	clearAttributes()	Call this function in your tag's doEnd() method, to clear all stored attributes from this tag.
protected void	evaluateAttributes()	Allow JSTL EL expressions within all attributes.
protected Map<String,String>	getAttributes()
protected String	getAttributeString()	Returns a string with contains all attributes assigned to this tag, in key="value" format.
protected String	getExtraAttributes()
void	setAccessKey(String accessKey)
void	setContenteditable(String contentEditable)
void	setDir(String dir)
void	setDisabled(String disabled)
void	setExtraAttributes(String extraAttributes)
void	setHidefocus(String hideFocus)
void	setLang(String lang)
void	setLanguage(String language)
void	setMaxlength(String maxLength)
void	setOnactivate(String onactivate)
void	setOnafterupdate(String onafterupdate)
void	setOnbeforeactvate(String onbeforeactvate)
void	setOnbeforecut(String onbeforecut)
void	setOnbeforedeactivate(String onbeforedeactivate)
void	setOnbeforeeditfocus(String onbeforeeditfocus)
void	setOnbeforepaste(String onbeforepaste)
void	setOnbeforeupdate(String onbeforeupdate)
void	setOnblur(String onblur)
void	setOnchange(String onchange)
void	setOnclick(String onclick)
void	setOncontextmenu(String oncontextmenu)
void	setOncontrolselect(String oncontrolselect)
void	setOncut(String oncut)
void	setOndblclick(String ondblclick)
void	setOndeactivate(String ondeactivate)
void	setOndrag(String ondrag)
void	setOndragend(String ondragend)
void	setOndragenter(String ondragenter)
void	setOndragleave(String ondragleave)
void	setOndragover(String ondragover)
void	setOndragstart(String ondragstart)
void	setOndrop(String ondrop)
void	setOnerrorupdate(String onerrorupdate)
void	setOnfilterchange(String onfilterchange)
void	setOnfocus(String onfocus)
void	setOnfocusin(String onfocusin)
void	setOnfocusout(String onfocusout)
void	setOnhelp(String onhelp)
void	setOnkeydown(String onkeydown)
void	setOnkeypress(String onkeypress)
void	setOnkeyup(String onkeyup)
void	setOnlosecapture(String onlosecapture)
void	setOnmousedown(String onmousedown)
void	setOnmouseenter(String onmouseenter)
void	setOnmouseleave(String onmouseleave)
void	setOnmousemove(String onmousemove)
void	setOnmouseout(String onmouseout)
void	setOnmouseover(String onmouseover)
void	setOnmouseup(String onmouseup)
void	setOnmousewheel(String onmousewheel)
void	setOnmove(String onmove)
void	setOnmoveend(String onmoveend)
void	setOnmovestart(String onmovestart)
void	setOnpaste(String onpaste)
void	setOnpropertychange(String onpropertychange)
void	setOnreadystatechange(String onreadystatechange)
void	setOnresize(String onresize)
void	setOnresizeend(String onresizeend)
void	setOnresizestart(String onresizestart)
void	setOnselect(String onselect)
void	setOnselectstart(String onselectstart)
void	setOntimeerror(String ontimeerror)
void	setReadonly(String readOnly)
void	setSize(String size)
void	setStyle(String style)
void	setStyleClass(String clazz)
void	setTabindex(String tabIndex)
void	setTitle(String title)
void	setUnselectable(String unselectable)
void	setWidth(String width)

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

doAfterBody, doEndTag, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Field Details

attributes

protected Map<String,String> attributes

extraAttributes

protected String extraAttributes

Constructor Details

StandardHtmlTag

public StandardHtmlTag()

Method Details

setAccessKey

public void setAccessKey(String accessKey)

setStyleClass

public void setStyleClass(String clazz)

setContenteditable

public void setContenteditable(String contentEditable)

setDir

public void setDir(String dir)

setDisabled

public void setDisabled(String disabled)

setLang

public void setLang(String lang)

setLanguage

public void setLanguage(String language)

setMaxlength

public void setMaxlength(String maxLength)

setSize

public void setSize(String size)

setStyle

public void setStyle(String style)

setTitle

public void setTitle(String title)

setWidth

public void setWidth(String width)

setOnactivate

public void setOnactivate(String onactivate)

setOnafterupdate

public void setOnafterupdate(String onafterupdate)

setOnbeforeactvate

public void setOnbeforeactvate(String onbeforeactvate)

setOnbeforecut

public void setOnbeforecut(String onbeforecut)

setOnbeforedeactivate

public void setOnbeforedeactivate(String onbeforedeactivate)

setOnbeforeeditfocus

public void setOnbeforeeditfocus(String onbeforeeditfocus)

setOnbeforepaste

public void setOnbeforepaste(String onbeforepaste)

setOnbeforeupdate

public void setOnbeforeupdate(String onbeforeupdate)

setOnblur

public void setOnblur(String onblur)

setOnchange

public void setOnchange(String onchange)

setOnclick

public void setOnclick(String onclick)

setOncontextmenu

public void setOncontextmenu(String oncontextmenu)

setOncontrolselect

public void setOncontrolselect(String oncontrolselect)

setOncut

public void setOncut(String oncut)

setOndblclick

public void setOndblclick(String ondblclick)

setOndeactivate

public void setOndeactivate(String ondeactivate)

setOndrag

public void setOndrag(String ondrag)

setOndragend

public void setOndragend(String ondragend)

setOndragenter

public void setOndragenter(String ondragenter)

setOndragleave

public void setOndragleave(String ondragleave)

setOndragover

public void setOndragover(String ondragover)

setOndragstart

public void setOndragstart(String ondragstart)

setOndrop

public void setOndrop(String ondrop)

setOnerrorupdate

public void setOnerrorupdate(String onerrorupdate)

setOnfilterchange

public void setOnfilterchange(String onfilterchange)

setOnfocus

public void setOnfocus(String onfocus)

setOnfocusin

public void setOnfocusin(String onfocusin)

setOnfocusout

public void setOnfocusout(String onfocusout)

setOnhelp

public void setOnhelp(String onhelp)

setOnkeydown

public void setOnkeydown(String onkeydown)

setOnkeypress

public void setOnkeypress(String onkeypress)

setOnkeyup

public void setOnkeyup(String onkeyup)

setOnlosecapture

public void setOnlosecapture(String onlosecapture)

setOnmousedown

public void setOnmousedown(String onmousedown)

setOnmouseenter

public void setOnmouseenter(String onmouseenter)

setOnmouseleave

public void setOnmouseleave(String onmouseleave)

setOnmousemove

public void setOnmousemove(String onmousemove)

setOnmouseout

public void setOnmouseout(String onmouseout)

setOnmouseover

public void setOnmouseover(String onmouseover)

setOnmouseup

public void setOnmouseup(String onmouseup)

setOnmousewheel

public void setOnmousewheel(String onmousewheel)

setOnmove

public void setOnmove(String onmove)

setOnmoveend

public void setOnmoveend(String onmoveend)

setOnmovestart

public void setOnmovestart(String onmovestart)

setOnpaste

public void setOnpaste(String onpaste)

setOnpropertychange

public void setOnpropertychange(String onpropertychange)

setOnreadystatechange

public void setOnreadystatechange(String onreadystatechange)

setOnresize

public void setOnresize(String onresize)

setOnresizeend

public void setOnresizeend(String onresizeend)

setOnresizestart

public void setOnresizestart(String onresizestart)

setOnselect

public void setOnselect(String onselect)

setOnselectstart

public void setOnselectstart(String onselectstart)

setOntimeerror

public void setOntimeerror(String ontimeerror)

setHidefocus

public void setHidefocus(String hideFocus)

setReadonly

public void setReadonly(String readOnly)

setTabindex

public void setTabindex(String tabIndex)

setUnselectable

public void setUnselectable(String unselectable)

setExtraAttributes

public void setExtraAttributes(String extraAttributes)

getAttributes

protected Map<String,String> getAttributes()

getExtraAttributes

protected String getExtraAttributes()

evaluateAttributes

protected void evaluateAttributes()
                           throws jakarta.servlet.jsp.JspException

Allow JSTL EL expressions within all attributes.

Throws:

jakarta.servlet.jsp.JspException - An exception occurred evaluating the EL.

getAttributeString

protected String getAttributeString()

Returns a string with contains all attributes assigned to this tag, in key="value" format.

(NB: values are not currently quote-escaped here)

Returns:

All attributes assigned to this tag.

clearAttributes

protected void clearAttributes()

Call this function in your tag's doEnd() method, to clear all stored attributes from this tag.