IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.struts.taglib.html
Class BaseHandlerTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended byjavax.servlet.jsp.tagext.BodyTagSupport
          extended bycom.ibm.btt.struts.taglib.html.BaseHandlerTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
BaseInputTag, ButtonTag, CancelTag, ImgTag, LinkTag, MultiboxTag, RadioTag, ResetTag, SelectTag, SubmitTag

public abstract class BaseHandlerTag
extends javax.servlet.jsp.tagext.BodyTagSupport

See Also:
Serialized Form

Field Summary
protected  java.lang.String accesskey
          Access key character.
protected static java.util.Locale defaultLocale
          The default Locale for our server.
protected  boolean indexed
          Whether to created indexed names for fields
protected static org.apache.struts.util.MessageResources messages
          The message resources for this package.
protected  java.lang.String tabindex
          Tab index value.
 
Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
BaseHandlerTag()
           
 
Method Summary
 java.lang.String getAccesskey()
          Returns the accessKey character.
 java.lang.String getAlt()
          Returns the alternate text attribute.
 java.lang.String getAltKey()
          Returns the message resources key of the alternate text.
 java.lang.String getBundle()
          Returns the name of the message resources bundle to use.
 boolean getDisabled()
          Returns the disabled event handler.
protected  java.lang.String getElementClose()
          Returns the closing brace for an input element depending on xhtml status.
 boolean getIndexed()
          Returns the indexed value.
 java.lang.String getLocale()
          Returns the name of the session attribute for our locale.
 java.lang.String getOnblur()
          Returns the onBlur event handler.
 java.lang.String getOnchange()
          Returns the onChange event handler.
 java.lang.String getOnclick()
          Returns the onClick event handler.
 java.lang.String getOndblclick()
          Returns the onDblClick event handler.
 java.lang.String getOnfocus()
          Returns the onFocus event handler.
 java.lang.String getOnkeydown()
          Returns the onKeyDown event handler.
 java.lang.String getOnkeypress()
          Returns the onKeyPress event handler.
 java.lang.String getOnkeyup()
          Returns the onKeyUp event handler.
 java.lang.String getOnmousedown()
          Returns the onMouseDown event handler.
 java.lang.String getOnmousemove()
          Returns the onMouseMove event handler.
 java.lang.String getOnmouseout()
          Returns the onMouseOut event handler.
 java.lang.String getOnmouseover()
          Returns the onMouseOver event handler.
 java.lang.String getOnmouseup()
          Returns the onMouseUp event handler.
 java.lang.String getOnselect()
          Returns the onSelect event handler.
 boolean getReadonly()
          Returns the readonly event handler.
 java.lang.String getStyle()
          Returns the style attribute.
 java.lang.String getStyleClass()
          Returns the style class attribute.
 java.lang.String getStyleId()
          Returns the style id attribute.
 java.lang.String getTabindex()
          Returns the tabIndex value.
 java.lang.String getTitle()
          Returns the advisory title attribute.
 java.lang.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  java.lang.String lookupProperty(java.lang.String beanName, java.lang.String property)
          Searches all scopes for the bean and calls BeanUtils.getProperty() with the given arguments and converts any exceptions into JspException.
protected  java.lang.String message(java.lang.String literal, java.lang.String key)
          Return the text specified by the literal value or the message resources key, if any; otherwise return null.
protected  java.lang.String prepareEventHandlers()
          Prepares the event handlers for inclusion in the component's HTML tag.
protected  void prepareFocusEvents(java.lang.StringBuffer handlers)
          Prepares the focus event handlers, appending them to the the given StringBuffer.
protected  void prepareIndex(java.lang.StringBuffer handlers, java.lang.String name)
          Appends bean name with index in brackets for tags with 'true' value in 'indexed' attribute.
protected  void prepareKeyEvents(java.lang.StringBuffer handlers)
          Prepares the keyboard event handlers, appending them to the the given StringBuffer.
protected  void prepareMouseEvents(java.lang.StringBuffer handlers)
          Prepares the mouse event handlers, appending them to the the given StringBuffer.
protected  java.lang.String prepareStyles()
          Prepares the style attributes for inclusion in the component's HTML tag.
protected  void prepareTextEvents(java.lang.StringBuffer handlers)
          Prepares the text event handlers, appending them to the the given StringBuffer.
 void release()
          Release any acquired resources.
 void setAccesskey(java.lang.String accessKey)
          Sets the accessKey character.
 void setAlt(java.lang.String alt)
          Sets the alternate text attribute.
 void setAltKey(java.lang.String altKey)
          Sets the message resources key of the alternate text.
 void setBundle(java.lang.String bundle)
          Sets the name of the message resources bundle to use.
 void setDisabled(boolean disabled)
          Sets the disabled event handler.
 void setIndexed(boolean indexed)
          Sets the indexed value.
 void setLocale(java.lang.String locale)
          Sets the name of the session attribute for our locale.
 void setOnblur(java.lang.String onBlur)
          Sets the onBlur event handler.
 void setOnchange(java.lang.String onChange)
          Sets the onChange event handler.
 void setOnclick(java.lang.String onClick)
          Sets the onClick event handler.
 void setOndblclick(java.lang.String onDblClick)
          Sets the onDblClick event handler.
 void setOnfocus(java.lang.String onFocus)
          Sets the onFocus event handler.
 void setOnkeydown(java.lang.String onKeyDown)
          Sets the onKeyDown event handler.
 void setOnkeypress(java.lang.String onKeyPress)
          Sets the onKeyPress event handler.
 void setOnkeyup(java.lang.String onKeyUp)
          Sets the onKeyUp event handler.
 void setOnmousedown(java.lang.String onMouseDown)
          Sets the onMouseDown event handler.
 void setOnmousemove(java.lang.String onMouseMove)
          Sets the onMouseMove event handler.
 void setOnmouseout(java.lang.String onMouseOut)
          Sets the onMouseOut event handler.
 void setOnmouseover(java.lang.String onMouseOver)
          Sets the onMouseOver event handler.
 void setOnmouseup(java.lang.String onMouseUp)
          Sets the onMouseUp event handler.
 void setOnselect(java.lang.String onSelect)
          Sets the onSelect event handler.
 void setReadonly(boolean readonly)
          Sets the readonly event handler.
 void setStyle(java.lang.String style)
          Sets the style attribute.
 void setStyleClass(java.lang.String styleClass)
          Sets the style class attribute.
 void setStyleId(java.lang.String styleId)
          Sets the style id attribute.
 void setTabindex(java.lang.String tabIndex)
          Sets the tabIndex value.
 void setTitle(java.lang.String title)
          Sets the advisory title attribute.
 void setTitleKey(java.lang.String titleKey)
          Sets the message resources key of the advisory title.
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doEndTag, doInitBody, doStartTag, 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, toString, wait, wait, wait
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
getParent, setPageContext, setParent
 

Field Detail

defaultLocale

protected static final java.util.Locale defaultLocale
The default Locale for our server.


messages

protected static org.apache.struts.util.MessageResources messages
The message resources for this package.


accesskey

protected java.lang.String accesskey
Access key character.


tabindex

protected java.lang.String tabindex
Tab index value.


indexed

protected boolean indexed
Whether to created indexed names for fields

Since:
Struts 1.1
Constructor Detail

BaseHandlerTag

public BaseHandlerTag()
Method Detail

setAccesskey

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


getAccesskey

public java.lang.String getAccesskey()
Returns the accessKey character.


setTabindex

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


getTabindex

public java.lang.String getTabindex()
Returns the tabIndex value.


setIndexed

public void setIndexed(boolean indexed)
Sets the indexed value.

Since:
Struts 1.1

getIndexed

public boolean getIndexed()
Returns the indexed value.

Since:
Struts 1.1

setOnclick

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


getOnclick

public java.lang.String getOnclick()
Returns the onClick event handler.


setOndblclick

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


getOndblclick

public java.lang.String getOndblclick()
Returns the onDblClick event handler.


setOnmousedown

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


getOnmousedown

public java.lang.String getOnmousedown()
Returns the onMouseDown event handler.


setOnmouseup

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


getOnmouseup

public java.lang.String getOnmouseup()
Returns the onMouseUp event handler.


setOnmousemove

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


getOnmousemove

public java.lang.String getOnmousemove()
Returns the onMouseMove event handler.


setOnmouseover

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


getOnmouseover

public java.lang.String getOnmouseover()
Returns the onMouseOver event handler.


setOnmouseout

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


getOnmouseout

public java.lang.String getOnmouseout()
Returns the onMouseOut event handler.


setOnkeydown

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


getOnkeydown

public java.lang.String getOnkeydown()
Returns the onKeyDown event handler.


setOnkeyup

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


getOnkeyup

public java.lang.String getOnkeyup()
Returns the onKeyUp event handler.


setOnkeypress

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


getOnkeypress

public java.lang.String getOnkeypress()
Returns the onKeyPress event handler.


setOnchange

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


getOnchange

public java.lang.String getOnchange()
Returns the onChange event handler.


setOnselect

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


getOnselect

public java.lang.String getOnselect()
Returns the onSelect event handler.


setOnblur

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


getOnblur

public java.lang.String getOnblur()
Returns the onBlur event handler.


setOnfocus

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


getOnfocus

public java.lang.String getOnfocus()
Returns the onFocus event handler.


setDisabled

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


getDisabled

public boolean getDisabled()
Returns the disabled event handler.


setReadonly

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


getReadonly

public boolean getReadonly()
Returns the readonly event handler.


setStyle

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


getStyle

public java.lang.String getStyle()
Returns the style attribute.


setStyleClass

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


getStyleClass

public java.lang.String getStyleClass()
Returns the style class attribute.


setStyleId

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


getStyleId

public java.lang.String getStyleId()
Returns the style id attribute.


getAlt

public java.lang.String getAlt()
Returns the alternate text attribute.


setAlt

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


getAltKey

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


setAltKey

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


getBundle

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


setBundle

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


getLocale

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


setLocale

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


getTitle

public java.lang.String getTitle()
Returns the advisory title attribute.


setTitle

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


getTitleKey

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


setTitleKey

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


release

public void release()
Release any acquired resources.


message

protected java.lang.String message(java.lang.String literal,
                                   java.lang.String key)
                            throws javax.servlet.jsp.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
Throws:
javax.servlet.jsp.JspException - if both arguments are non-null

prepareIndex

protected void prepareIndex(java.lang.StringBuffer handlers,
                            java.lang.String name)
                     throws javax.servlet.jsp.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.
Throws:
javax.servlet.jsp.JspException - if 'indexed' tag used outside of iterate tag.

prepareStyles

protected java.lang.String prepareStyles()
                                  throws javax.servlet.jsp.JspException
Prepares the style attributes for inclusion in the component's HTML tag.

Returns:
The prepared String for inclusion in the HTML tag.
Throws:
javax.servlet.jsp.JspException - if invalid attributes are specified

prepareEventHandlers

protected java.lang.String prepareEventHandlers()
Prepares the event handlers for inclusion in the component's HTML tag.

Returns:
The prepared String for inclusion in the HTML tag.

prepareMouseEvents

protected void prepareMouseEvents(java.lang.StringBuffer handlers)
Prepares the mouse event handlers, appending them to the the given StringBuffer.

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

prepareKeyEvents

protected void prepareKeyEvents(java.lang.StringBuffer handlers)
Prepares the keyboard event handlers, appending them to the the given StringBuffer.

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

prepareTextEvents

protected void prepareTextEvents(java.lang.StringBuffer handlers)
Prepares the text event handlers, appending them to the the given StringBuffer.

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

prepareFocusEvents

protected void prepareFocusEvents(java.lang.StringBuffer handlers)
Prepares the focus event handlers, appending them to the the given StringBuffer.

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

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

getElementClose

protected java.lang.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

lookupProperty

protected java.lang.String lookupProperty(java.lang.String beanName,
                                          java.lang.String property)
                                   throws javax.servlet.jsp.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.
Throws:
javax.servlet.jsp.JspException
Since:
Struts 1.1

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005