org.apache.struts.taglib.html

Class BaseHandlerTag

Known Direct Subclasses:
BaseInputTag, CheckboxTag, ImgTag, LinkTag, MultiboxTag, RadioTag, SelectTag, SubmitTag

public abstract class BaseHandlerTag
extends BodyTagSupport

Base class for tags that render form elements capable of including JavaScript event handlers and/or CSS Style attributes. This class does not implement the doStartTag() or doEndTag() methods. Subclasses should provide appropriate implementations of these.
Version:
$Rev: 168243 $ $Date: 2005-05-05 03:35:30 +0100 (Thu, 05 May 2005) $

Field Summary

protected String
accesskey
Access key character.
private String
alt
The alternate text of this element.
private String
altKey
The message resources key of the alternate text.
private String
bundle
The name of the message resources bundle for message lookups.
protected static Locale
defaultLocale
Deprecated. Use Locale.getDefault() directly.
private boolean
disabled
Component is disabled.
protected boolean
doDisabled
Indicates whether 'disabled' is a valid attribute
protected boolean
doReadonly
Indicates whether 'readonly' is a valid attribute.
private String
errorKey
The request attribute key for our error messages (if any).
private String
errorStyle
Style attribute associated with component when errors exist.
private String
errorStyleClass
Named Style class associated with component when errors exist.
private String
errorStyleId
Identifier associated with component when errors exist.
protected boolean
indexed
Whether to created indexed names for fields
private String
locale
The name of the session attribute key for our locale.
private static Log
log
Commons Logging instance.
private Class
loopTagStatusClass
private Method
loopTagStatusGetIndex
private Class
loopTagSupportClass
private Method
loopTagSupportGetStatus
protected static MessageResources
messages
The message resources for this package.
private String
onblur
Component lost focus event.
private String
onchange
Content changed after component lost focus event.
private String
onclick
Mouse click event.
private String
ondblclick
Mouse double click event.
private String
onfocus
Component has received focus event.
private String
onkeydown
Key down in component event.
private String
onkeypress
Key down and up together in component event.
private String
onkeyup
Key released in component event.
private String
onmousedown
Mouse pressed on component event.
private String
onmousemove
Mouse moved over component event.
private String
onmouseout
Mouse exit component event.
private String
onmouseover
Mouse over component event.
private String
onmouseup
Mouse released on component event.
private String
onselect
Text selected in component event.
private boolean
readonly
Component is readonly.
private String
style
Style attribute associated with component.
private String
styleClass
Named Style class associated with component.
private String
styleId
Identifier associated with component.
protected String
tabindex
Tab index value.
private String
title
The advisory title of this element.
private String
titleKey
The message resources key of the advisory title.
private boolean
triedJstlInit
private boolean
triedJstlSuccess

Method Summary

protected boolean
doErrorsExist()
Determine if there are errors for the component.
String
getAccesskey()
Returns the accessKey character.
String
getAlt()
Returns the alternate text attribute.
String
getAltKey()
Returns the message resources key of the alternate text.
String
getBundle()
Returns the name of the message resources bundle to use.
boolean
getDisabled()
Returns the disabled event handler.
protected String
getElementClose()
Returns the closing brace for an input element depending on xhtml status.
String
getErrorKey()
Returns the error key attribute.
String
getErrorStyle()
Returns the error style attribute.
String
getErrorStyleClass()
Returns the error style class attribute.
String
getErrorStyleId()
Returns the error style id attribute.
protected int
getIndexValue()
Returns the index value for tags with 'true' value in 'indexed' attribute.
boolean
getIndexed()
Returns the indexed value.
private Integer
getJstlLoopIndex()
String
getLocale()
Returns the name of the session attribute for our locale.
String
getOnblur()
Returns the onBlur event handler.
String
getOnchange()
Returns the onChange event handler.
String
getOnclick()
Returns the onClick event handler.
String
getOndblclick()
Returns the onDblClick event handler.
String
getOnfocus()
Returns the onFocus event handler.
String
getOnkeydown()
Returns the onKeyDown event handler.
String
getOnkeypress()
Returns the onKeyPress event handler.
String
getOnkeyup()
Returns the onKeyUp event handler.
String
getOnmousedown()
Returns the onMouseDown event handler.
String
getOnmousemove()
Returns the onMouseMove event handler.
String
getOnmouseout()
Returns the onMouseOut event handler.
String
getOnmouseover()
Returns the onMouseOver event handler.
String
getOnmouseup()
Returns the onMouseUp event handler.
String
getOnselect()
Returns the onSelect event handler.
boolean
getReadonly()
Returns the readonly event handler.
String
getStyle()
Returns the style attribute.
String
getStyleClass()
Returns the style class attribute.
String
getStyleId()
Returns the style id attribute.
String
getTabindex()
Returns the tabIndex value.
String
getTitle()
Returns the advisory title attribute.
String
getTitleKey()
Returns the message resources key of the advisory title.
protected boolean
isXhtml()
Allows HTML tags to find out if they're nested within an %lt;html:html> tag that has xhtml set to true.
protected String
lookupProperty(String beanName, String property)
Searches all scopes for the bean and calls BeanUtils.getProperty() with the given arguments and converts any exceptions into JspException.
protected String
message(String literal, String key)
Return the text specified by the literal value or the message resources key, if any; otherwise return null.
protected void
prepareAttribute(StringBuffer handlers, String name, Object value)
Prepares an attribute if the value is not null, appending it to the the given StringBuffer.
protected String
prepareEventHandlers()
Prepares the event handlers for inclusion in the component's HTML tag.
protected void
prepareFocusEvents(StringBuffer handlers)
Prepares the focus event handlers, appending them to the the given StringBuffer.
protected void
prepareIndex(StringBuffer handlers, String name)
Appends bean name with index in brackets for tags with 'true' value in 'indexed' attribute.
protected void
prepareKeyEvents(StringBuffer handlers)
Prepares the keyboard event handlers, appending them to the the given StringBuffer.
protected void
prepareMouseEvents(StringBuffer handlers)
Prepares the mouse event handlers, appending them to the the given StringBuffer.
protected String
prepareName()
Prepares the actual name of the component.
protected void
prepareOtherAttributes(StringBuffer handlers)
'Hook' to enable tags to be extended and additional attributes added.
protected String
prepareStyles()
Prepares the style attributes for inclusion in the component's HTML tag.
protected void
prepareTextEvents(StringBuffer handlers)
Prepares the text event handlers, appending them to the the given StringBuffer.
void
release()
Release any acquired resources.
void
setAccesskey(String accessKey)
Sets the accessKey character.
void
setAlt(String alt)
Sets the alternate text attribute.
void
setAltKey(String altKey)
Sets the message resources key of the alternate text.
void
setBundle(String bundle)
Sets the name of the message resources bundle to use.
void
setDisabled(boolean disabled)
Sets the disabled event handler.
void
setErrorKey(String errorKey)
Sets the error key attribute.
void
setErrorStyle(String errorStyle)
Sets the error style attribute.
void
setErrorStyleClass(String errorStyleClass)
Sets the error style class attribute.
void
setErrorStyleId(String errorStyleId)
Sets the error style id attribute.
void
setIndexed(boolean indexed)
Sets the indexed value.
void
setLocale(String locale)
Sets the name of the session attribute for our locale.
void
setOnblur(String onBlur)
Sets the onBlur event handler.
void
setOnchange(String onChange)
Sets the onChange event handler.
void
setOnclick(String onClick)
Sets the onClick event handler.
void
setOndblclick(String onDblClick)
Sets the onDblClick event handler.
void
setOnfocus(String onFocus)
Sets the onFocus event handler.
void
setOnkeydown(String onKeyDown)
Sets the onKeyDown event handler.
void
setOnkeypress(String onKeyPress)
Sets the onKeyPress event handler.
void
setOnkeyup(String onKeyUp)
Sets the onKeyUp event handler.
void
setOnmousedown(String onMouseDown)
Sets the onMouseDown event handler.
void
setOnmousemove(String onMouseMove)
Sets the onMouseMove event handler.
void
setOnmouseout(String onMouseOut)
Sets the onMouseOut event handler.
void
setOnmouseover(String onMouseOver)
Sets the onMouseOver event handler.
void
setOnmouseup(String onMouseUp)
Sets the onMouseUp event handler.
void
setOnselect(String onSelect)
Sets the onSelect event handler.
void
setReadonly(boolean readonly)
Sets the readonly event handler.
void
setStyle(String style)
Sets the style attribute.
void
setStyleClass(String styleClass)
Sets the style class attribute.
void
setStyleId(String styleId)
Sets the style id attribute.
void
setTabindex(String tabIndex)
Sets the tabIndex value.
void
setTitle(String title)
Sets the advisory title attribute.
void
setTitleKey(String titleKey)
Sets the message resources key of the advisory title.

Field Details

accesskey

protected String accesskey
Access key character.

alt

private String alt
The alternate text of this element.

altKey

private String altKey
The message resources key of the alternate text.

bundle

private String bundle
The name of the message resources bundle for message lookups.

defaultLocale

protected static final Locale defaultLocale

Deprecated. Use Locale.getDefault() directly.

The default Locale for our server.

disabled

private boolean disabled
Component is disabled.

doDisabled

protected boolean doDisabled
Indicates whether 'disabled' is a valid attribute

doReadonly

protected boolean doReadonly
Indicates whether 'readonly' is a valid attribute.

According to the HTML 4.0 Specification <readonly> is valid for <input type="text">, <input type="password"> and <textarea"> elements. Therefore, except for those tags this value is set to false.


errorKey

private String errorKey
The request attribute key for our error messages (if any).

errorStyle

private String errorStyle
Style attribute associated with component when errors exist.

errorStyleClass

private String errorStyleClass
Named Style class associated with component when errors exist.

errorStyleId

private String errorStyleId
Identifier associated with component when errors exist.

indexed

protected boolean indexed
Whether to created indexed names for fields
Since:
Struts 1.1

locale

private String locale
The name of the session attribute key for our locale.

log

private static Log log
Commons Logging instance.

loopTagStatusClass

private Class loopTagStatusClass

loopTagStatusGetIndex

private Method loopTagStatusGetIndex

loopTagSupportClass

private Class loopTagSupportClass

loopTagSupportGetStatus

private Method loopTagSupportGetStatus

messages

protected static MessageResources messages
The message resources for this package.

onblur

private String onblur
Component lost focus event.

onchange

private String onchange
Content changed after component lost focus event.

onclick

private String onclick
Mouse click event.

ondblclick

private String ondblclick
Mouse double click event.

onfocus

private String onfocus
Component has received focus event.

onkeydown

private String onkeydown
Key down in component event.

onkeypress

private String onkeypress
Key down and up together in component event.

onkeyup

private String onkeyup
Key released in component event.

onmousedown

private String onmousedown
Mouse pressed on component event.

onmousemove

private String onmousemove
Mouse moved over component event.

onmouseout

private String onmouseout
Mouse exit component event.

onmouseover

private String onmouseover
Mouse over component event.

onmouseup

private String onmouseup
Mouse released on component event.

onselect

private String onselect
Text selected in component event.

readonly

private boolean readonly
Component is readonly.

style

private String style
Style attribute associated with component.

styleClass

private String styleClass
Named Style class associated with component.

styleId

private String styleId
Identifier associated with component.

tabindex

protected String tabindex
Tab index value.

title

private String title
The advisory title of this element.

titleKey

private String titleKey
The message resources key of the advisory title.

triedJstlInit

private boolean triedJstlInit

triedJstlSuccess

private boolean triedJstlSuccess

Method Details

doErrorsExist

protected boolean doErrorsExist()
            throws JspException
Determine if there are errors for the component.
Returns:
Whether errors exist.

getAccesskey

public String getAccesskey()
Returns the accessKey character.

getAlt

public String getAlt()
Returns the alternate text attribute.

getAltKey

public String getAltKey()
Returns the message resources key of the alternate text.

getBundle

public String getBundle()
Returns the name of the message resources bundle to use.

getDisabled

public boolean getDisabled()
Returns the disabled event handler.

getElementClose

protected String getElementClose()
Returns the closing brace for an input element depending on xhtml status. The tag must be nested within an %lt;html:html> tag that has xhtml set to true.
Returns:
String - > if xhtml is false, /> if xhtml is true
Since:
Struts 1.1

getErrorKey

public String getErrorKey()
Returns the error key attribute.

getErrorStyle

public String getErrorStyle()
Returns the error style attribute.

getErrorStyleClass

public String getErrorStyleClass()
Returns the error style class attribute.

getErrorStyleId

public String getErrorStyleId()
Returns the error style id attribute.

getIndexValue

protected int getIndexValue()
            throws JspException
Returns the index value for tags with 'true' value in 'indexed' attribute.
Returns:
the index value.

getIndexed

public boolean getIndexed()
Returns the indexed value.
Since:
Struts 1.1

getJstlLoopIndex

private Integer getJstlLoopIndex()

getLocale

public String getLocale()
Returns the name of the session attribute for our locale.

getOnblur

public String getOnblur()
Returns the onBlur event handler.

getOnchange

public String getOnchange()
Returns the onChange event handler.

getOnclick

public String getOnclick()
Returns the onClick event handler.

getOndblclick

public String getOndblclick()
Returns the onDblClick event handler.

getOnfocus

public String getOnfocus()
Returns the onFocus event handler.

getOnkeydown

public String getOnkeydown()
Returns the onKeyDown event handler.

getOnkeypress

public String getOnkeypress()
Returns the onKeyPress event handler.

getOnkeyup

public String getOnkeyup()
Returns the onKeyUp event handler.

getOnmousedown

public String getOnmousedown()
Returns the onMouseDown event handler.

getOnmousemove

public String getOnmousemove()
Returns the onMouseMove event handler.

getOnmouseout

public String getOnmouseout()
Returns the onMouseOut event handler.

getOnmouseover

public String getOnmouseover()
Returns the onMouseOver event handler.

getOnmouseup

public String getOnmouseup()
Returns the onMouseUp event handler.

getOnselect

public String getOnselect()
Returns the onSelect event handler.

getReadonly

public boolean getReadonly()
Returns the readonly event handler.

getStyle

public String getStyle()
Returns the style attribute.

getStyleClass

public String getStyleClass()
Returns the style class attribute.

getStyleId

public String getStyleId()
Returns the style id attribute.

getTabindex

public String getTabindex()
Returns the tabIndex value.

getTitle

public String getTitle()
Returns the advisory title attribute.

getTitleKey

public String getTitleKey()
Returns the message resources key of the advisory title.

isXhtml

protected boolean isXhtml()
Allows HTML tags to find out if they're nested within an %lt;html:html> tag that has xhtml set to true.
Returns:
true if the tag is nested within an html tag with xhtml set to true, false otherwise.
Since:
Struts 1.1

lookupProperty

protected String lookupProperty(String beanName,
                                String property)
            throws JspException
Searches all scopes for the bean and calls BeanUtils.getProperty() with the given arguments and converts any exceptions into JspException.
Parameters:
beanName - The name of the object to get the property from.
property - The name of the property to get.
Returns:
The value of the property.
Since:
Struts 1.1

message

protected String message(String literal,
                         String key)
            throws JspException
Return the text specified by the literal value or the message resources key, if any; otherwise return null.
Parameters:
literal - Literal text value or null
key - Message resources key or null

prepareAttribute

protected void prepareAttribute(StringBuffer handlers,
                                String name,
                                Object value)
Prepares an attribute if the value is not null, appending it to the the given StringBuffer.
Parameters:
handlers - The StringBuffer that output will be appended to.

prepareEventHandlers

protected String prepareEventHandlers()
Prepares the event handlers for inclusion in the component's HTML tag.
Returns:
The prepared String for inclusion in the HTML tag.

prepareFocusEvents

protected void prepareFocusEvents(StringBuffer handlers)
Prepares the focus event handlers, appending them to the the given StringBuffer.
Parameters:
handlers - The StringBuffer that output will be appended to.

prepareIndex

protected void prepareIndex(StringBuffer handlers,
                            String name)
            throws JspException
Appends bean name with index in brackets for tags with 'true' value in 'indexed' attribute.
Parameters:
handlers - The StringBuffer that output will be appended to.

prepareKeyEvents

protected void prepareKeyEvents(StringBuffer handlers)
Prepares the keyboard event handlers, appending them to the the given StringBuffer.
Parameters:
handlers - The StringBuffer that output will be appended to.

prepareMouseEvents

protected void prepareMouseEvents(StringBuffer handlers)
Prepares the mouse event handlers, appending them to the the given StringBuffer.
Parameters:
handlers - The StringBuffer that output will be appended to.

prepareName

protected String prepareName()
            throws JspException
Prepares the actual name of the component.
Returns:
The actual component name.

prepareOtherAttributes

protected void prepareOtherAttributes(StringBuffer handlers)
'Hook' to enable tags to be extended and additional attributes added.
Parameters:
handlers - The StringBuffer that output will be appended to.

prepareStyles

protected String prepareStyles()
            throws JspException
Prepares the style attributes for inclusion in the component's HTML tag.
Returns:
The prepared String for inclusion in the HTML tag.

prepareTextEvents

protected void prepareTextEvents(StringBuffer handlers)
Prepares the text event handlers, appending them to the the given StringBuffer.
Parameters:
handlers - The StringBuffer that output will be appended to.

release

public void release()
Release any acquired resources.

setAccesskey

public void setAccesskey(String accessKey)
Sets the accessKey character.

setAlt

public void setAlt(String alt)
Sets the alternate text attribute.

setAltKey

public void setAltKey(String altKey)
Sets the message resources key of the alternate text.

setBundle

public void setBundle(String bundle)
Sets the name of the message resources bundle to use.

setDisabled

public void setDisabled(boolean disabled)
Sets the disabled event handler.

setErrorKey

public void setErrorKey(String errorKey)
Sets the error key attribute.

setErrorStyle

public void setErrorStyle(String errorStyle)
Sets the error style attribute.

setErrorStyleClass

public void setErrorStyleClass(String errorStyleClass)
Sets the error style class attribute.

setErrorStyleId

public void setErrorStyleId(String errorStyleId)
Sets the error style id attribute.

setIndexed

public void setIndexed(boolean indexed)
Sets the indexed value.
Since:
Struts 1.1

setLocale

public void setLocale(String locale)
Sets the name of the session attribute for our locale.

setOnblur

public void setOnblur(String onBlur)
Sets the onBlur event handler.

setOnchange

public void setOnchange(String onChange)
Sets the onChange event handler.

setOnclick

public void setOnclick(String onClick)
Sets the onClick event handler.

setOndblclick

public void setOndblclick(String onDblClick)
Sets the onDblClick event handler.

setOnfocus

public void setOnfocus(String onFocus)
Sets the onFocus event handler.

setOnkeydown

public void setOnkeydown(String onKeyDown)
Sets the onKeyDown event handler.

setOnkeypress

public void setOnkeypress(String onKeyPress)
Sets the onKeyPress event handler.

setOnkeyup

public void setOnkeyup(String onKeyUp)
Sets the onKeyUp event handler.

setOnmousedown

public void setOnmousedown(String onMouseDown)
Sets the onMouseDown event handler.

setOnmousemove

public void setOnmousemove(String onMouseMove)
Sets the onMouseMove event handler.

setOnmouseout

public void setOnmouseout(String onMouseOut)
Sets the onMouseOut event handler.

setOnmouseover

public void setOnmouseover(String onMouseOver)
Sets the onMouseOver event handler.

setOnmouseup

public void setOnmouseup(String onMouseUp)
Sets the onMouseUp event handler.

setOnselect

public void setOnselect(String onSelect)
Sets the onSelect event handler.

setReadonly

public void setReadonly(boolean readonly)
Sets the readonly event handler.

setStyle

public void setStyle(String style)
Sets the style attribute.

setStyleClass

public void setStyleClass(String styleClass)
Sets the style class attribute.

setStyleId

public void setStyleId(String styleId)
Sets the style id attribute.

setTabindex

public void setTabindex(String tabIndex)
Sets the tabIndex value.

setTitle

public void setTitle(String title)
Sets the advisory title attribute.

setTitleKey

public void setTitleKey(String titleKey)
Sets the message resources key of the advisory title.

Copyright B) 2000-2007 - The Apache Software Foundation