HDIV API 2.0.4

org.hdiv.web.servlet.tags.form
Class OptionTagHDIV

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by org.springframework.web.servlet.tags.RequestContextAwareTag
          extended by org.springframework.web.servlet.tags.HtmlEscapingAwareTag
              extended by org.springframework.web.servlet.tags.form.AbstractFormTag
                  extended by org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
                      extended by org.springframework.web.servlet.tags.form.AbstractHtmlElementTag
                          extended by org.springframework.web.servlet.tags.form.AbstractHtmlElementBodyTag
                              extended by org.springframework.web.servlet.tags.form.OptionTag
                                  extended by org.hdiv.web.servlet.tags.form.OptionTagHDIV
All Implemented Interfaces:
java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

public class OptionTagHDIV
extends org.springframework.web.servlet.tags.form.OptionTag

JSP tag for rendering an HTML 'option' tag.

Must be used nested inside a SelectTag.

Provides full support for databinding by marking an 'option' as 'selected' if the value matches the value bound to the out SelectTag.

The value property is required and corresponds to the 'value' attribute of the rendered 'option'.

An optional label property can be specified, the value of which corresponds to inner text of the rendered 'option' tag. If no label is specified then the value property will be used when rendering the inner text.

Since:
HDIV 2.0
Author:
Gorka Vicente
See Also:
OptionTag, Serialized Form

Field Summary
static java.lang.String DISPLAY_VALUE_VARIABLE_NAME
          The name of the JSP variable used to expose the display value for this tag.
static java.lang.String VALUE_VARIABLE_NAME
          The name of the JSP variable used to expose the value for this tag.
 
Fields inherited from class org.springframework.web.servlet.tags.form.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 org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
COMMAND_NAME_ATTRIBUTE, COMMAND_NAME_VARIABLE_NAME, ID_ATTRIBUTE
 
Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag
logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
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
OptionTagHDIV()
           
 
Method Summary
protected  void exposeAttributes()
           
protected  org.springframework.web.servlet.support.BindStatus getBindStatus()
           
protected  java.lang.String getDisabled()
          Get the value of the 'disabled' attribute.
protected  java.lang.String getLabel()
          Get the text body of the rendered HTML <option> tag.
protected  java.lang.Object getValue()
          Get the 'value' attribute of the rendered HTML <option> tag.
protected  boolean isDisabled()
          Is the current HTML tag disabled?
protected  void onWriteTagContent()
          Make sure we are under a 'select' tag before proceeding.
protected  void removeAttributes()
           
protected  void renderDefaultContent(org.springframework.web.servlet.tags.form.TagWriter tagWriter)
           
protected  void renderFromBodyContent(javax.servlet.jsp.tagext.BodyContent bodyContent, org.springframework.web.servlet.tags.form.TagWriter tagWriter)
           
 void setDisabled(java.lang.String disabled)
          Set the value of the 'disabled' attribute.
 void setLabel(java.lang.String label)
          Set the text body of the rendered HTML <option> tag.
 void setValue(java.lang.Object value)
          Set the 'value' attribute of the rendered HTML <option> tag.
 
Methods inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementBodyTag
doEndTag, doFinally, doInitBody, flushBufferedBodyContent, setBodyContent, shouldRender, writeTagContent
 
Methods inherited from class org.springframework.web.servlet.tags.form.AbstractHtmlElementTag
getCssClass, getCssErrorClass, getCssStyle, getDir, getLang, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTabindex, getTitle, resolveCssClass, setCssClass, setCssErrorClass, setCssStyle, setDir, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setTabindex, setTitle, writeDefaultAttributes
 
Methods inherited from class org.springframework.web.servlet.tags.form.AbstractDataBoundFormElementTag
autogenerateId, getBoundValue, getCompletePath, getId, getName, getNestedPath, getPath, getPropertyEditor, setId, setPath
 
Methods inherited from class org.springframework.web.servlet.tags.form.AbstractFormTag
createTagWriter, doStartTagInternal, evaluate, getDisplayString, getDisplayString, writeOptionalAttribute
 
Methods inherited from class org.springframework.web.servlet.tags.HtmlEscapingAwareTag
isHtmlEscape, setHtmlEscape
 
Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag
doCatch, doStartTag, getRequestContext
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getParent, getValue, getValues, release, removeValue, 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.BodyTag
doInitBody, setBodyContent
 
Methods inherited from interface javax.servlet.jsp.tagext.IterationTag
doAfterBody
 
Methods inherited from interface javax.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, release, setPageContext, setParent
 

Field Detail

VALUE_VARIABLE_NAME

public static final java.lang.String VALUE_VARIABLE_NAME
The name of the JSP variable used to expose the value for this tag.

See Also:
Constant Field Values

DISPLAY_VALUE_VARIABLE_NAME

public static final java.lang.String DISPLAY_VALUE_VARIABLE_NAME
The name of the JSP variable used to expose the display value for this tag.

See Also:
Constant Field Values
Constructor Detail

OptionTagHDIV

public OptionTagHDIV()
Method Detail

setValue

public void setValue(java.lang.Object value)
Set the 'value' attribute of the rendered HTML <option> tag.

May be a runtime expression.

Overrides:
setValue in class org.springframework.web.servlet.tags.form.OptionTag

getValue

protected java.lang.Object getValue()
Get the 'value' attribute of the rendered HTML <option> tag.

May be a runtime expression.

Overrides:
getValue in class org.springframework.web.servlet.tags.form.OptionTag

setDisabled

public void setDisabled(java.lang.String disabled)
Set the value of the 'disabled' attribute.

May be a runtime expression.

Overrides:
setDisabled in class org.springframework.web.servlet.tags.form.OptionTag
Parameters:
disabled - the value of the 'disabled' attribute

getDisabled

protected java.lang.String getDisabled()
Get the value of the 'disabled' attribute.

May be a runtime expression.

Overrides:
getDisabled in class org.springframework.web.servlet.tags.form.OptionTag
Returns:
the value of the 'disabled' attribute

isDisabled

protected boolean isDisabled()
Is the current HTML tag disabled?

Overrides:
isDisabled in class org.springframework.web.servlet.tags.form.OptionTag
Returns:
true if this tag is disabled

setLabel

public void setLabel(java.lang.String label)
Set the text body of the rendered HTML <option> tag.

May be a runtime expression.

Overrides:
setLabel in class org.springframework.web.servlet.tags.form.OptionTag
Throws:
java.lang.IllegalArgumentException - if the supplied label is null

getLabel

protected java.lang.String getLabel()
Get the text body of the rendered HTML <option> tag.

May be a runtime expression.

Overrides:
getLabel in class org.springframework.web.servlet.tags.form.OptionTag

renderDefaultContent

protected void renderDefaultContent(org.springframework.web.servlet.tags.form.TagWriter tagWriter)
                             throws javax.servlet.jsp.JspException
Overrides:
renderDefaultContent in class org.springframework.web.servlet.tags.form.OptionTag
Throws:
javax.servlet.jsp.JspException

renderFromBodyContent

protected void renderFromBodyContent(javax.servlet.jsp.tagext.BodyContent bodyContent,
                                     org.springframework.web.servlet.tags.form.TagWriter tagWriter)
                              throws javax.servlet.jsp.JspException
Overrides:
renderFromBodyContent in class org.springframework.web.servlet.tags.form.OptionTag
Throws:
javax.servlet.jsp.JspException

onWriteTagContent

protected void onWriteTagContent()
Make sure we are under a 'select' tag before proceeding.

Overrides:
onWriteTagContent in class org.springframework.web.servlet.tags.form.OptionTag

exposeAttributes

protected void exposeAttributes()
                         throws javax.servlet.jsp.JspException
Overrides:
exposeAttributes in class org.springframework.web.servlet.tags.form.OptionTag
Throws:
javax.servlet.jsp.JspException

getBindStatus

protected org.springframework.web.servlet.support.BindStatus getBindStatus()
Overrides:
getBindStatus in class org.springframework.web.servlet.tags.form.OptionTag

removeAttributes

protected void removeAttributes()
Overrides:
removeAttributes in class org.springframework.web.servlet.tags.form.OptionTag

HDIV 2.0.4

Copyright © 2008 hdiv.org. All Rights Reserved.