public class OptionsTag extends AbstractHtmlElementTag
<options>
tag renders a list of HTML 'option' tags.
Sets 'selected' as appropriate based on bound value.
Must be used within a 'select' tag
.
Attribute | Required? | Runtime Expression? | Description |
---|---|---|---|
cssClass |
false |
true |
HTML Optional Attribute |
cssErrorClass |
false |
true |
HTML Optional Attribute. Used when the bound field has errors. |
cssStyle |
false |
true |
HTML Optional Attribute |
dir |
false |
true |
HTML Standard Attribute |
disabled |
false |
true |
HTML Optional Attribute. Setting the value of this attribute to 'true' will disable the HTML element. |
htmlEscape |
false |
true |
Enable/disable HTML escaping of rendered values. |
id |
false |
true |
HTML Standard Attribute |
itemLabel |
false |
true |
Name of the property mapped to the inner text of the 'option' tag |
items |
true |
true |
The Collection, Map or array of objects used to generate the inner 'option' tags |
itemValue |
false |
true |
Name of the property mapped to 'value' attribute of the 'option' tag |
lang |
false |
true |
HTML Standard Attribute |
onclick |
false |
true |
HTML Event Attribute |
ondblclick |
false |
true |
HTML Event Attribute |
onkeydown |
false |
true |
HTML Event Attribute |
onkeypress |
false |
true |
HTML Event Attribute |
onkeyup |
false |
true |
HTML Event Attribute |
onmousedown |
false |
true |
HTML Event Attribute |
onmousemove |
false |
true |
HTML Event Attribute |
onmouseout |
false |
true |
HTML Event Attribute |
onmouseover |
false |
true |
HTML Event Attribute |
onmouseup |
false |
true |
HTML Event Attribute |
tabindex |
false |
true |
HTML Standard Attribute |
title |
false |
true |
HTML Standard Attribute |
Modifier and Type | Class and Description |
---|---|
private class |
OptionsTag.OptionsWriter
Inner class that adapts OptionWriter for multiple options to be rendered.
|
Modifier and Type | Field and Description |
---|---|
private boolean |
disabled |
private java.lang.String |
itemLabel
The name of the property mapped to the inner text of the
'
option ' tag. |
private java.lang.Object |
items
The
Collection , Map or array of
objects used to generate the inner 'option ' tags. |
private java.lang.String |
itemValue
The name of the property mapped to the '
value ' attribute
of the 'option ' tag. |
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
NESTED_PATH_VARIABLE_NAME
logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE
Constructor and Description |
---|
OptionsTag() |
Modifier and Type | Method and Description |
---|---|
protected BindStatus |
getBindStatus()
Get the
BindStatus for this tag. |
protected java.lang.String |
getItemLabel()
Get the name of the property mapped to the label (inner text) of the
'
option ' tag. |
protected java.lang.Object |
getItems()
Get the
Collection , Map or array
of objects used to generate the inner 'option ' tags. |
protected java.lang.String |
getItemValue()
Return the name of the property mapped to the '
value '
attribute of the 'option ' tag. |
private SelectTag |
getSelectTag() |
protected boolean |
isDisabled()
Get the value of the '
disabled ' attribute. |
protected java.lang.String |
resolveId()
Appends a counter to a specified id,
since we're dealing with multiple HTML elements.
|
void |
setDisabled(boolean disabled)
Set the value of the '
disabled ' attribute. |
void |
setItemLabel(java.lang.String itemLabel)
Set the name of the property mapped to the label (inner text) of the
'
option ' tag. |
void |
setItems(java.lang.Object items)
Set the
Collection , Map or array
of objects used to generate the inner 'option ' tags. |
void |
setItemValue(java.lang.String itemValue)
Set the name of the property mapped to the '
value '
attribute of the 'option ' tag. |
protected int |
writeTagContent(TagWriter tagWriter)
Subclasses should implement this method to perform tag content rendering.
|
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
autogenerateId, convertToDisplayString, doFinally, getBoundValue, getEditor, getId, getName, getNestedPath, getPath, getPropertyEditor, getPropertyPath, processFieldValue, setId, setPath
createTagWriter, doStartTagInternal, evaluate, getDisplayString, getDisplayString, isDefaultHtmlEscape, writeOptionalAttribute
htmlEscape, isHtmlEscape, isResponseEncodedHtmlEscape, setHtmlEscape
doCatch, doStartTag, getRequestContext
@Nullable private java.lang.Object items
Collection
, Map
or array of
objects used to generate the inner 'option
' tags.@Nullable private java.lang.String itemValue
value
' attribute
of the 'option
' tag.@Nullable private java.lang.String itemLabel
option
' tag.private boolean disabled
public void setItems(java.lang.Object items)
Collection
, Map
or array
of objects used to generate the inner 'option
' tags.
Required when wishing to render 'option
' tags from an
array, Collection
or Map
.
Typically a runtime expression.
@Nullable protected java.lang.Object getItems()
Collection
, Map
or array
of objects used to generate the inner 'option
' tags.
Typically a runtime expression.
public void setItemValue(java.lang.String itemValue)
value
'
attribute of the 'option
' tag.
Required when wishing to render 'option
' tags from
an array or Collection
.
@Nullable protected java.lang.String getItemValue()
value
'
attribute of the 'option
' tag.public void setItemLabel(java.lang.String itemLabel)
option
' tag.@Nullable protected java.lang.String getItemLabel()
option
' tag.public void setDisabled(boolean disabled)
disabled
' attribute.protected boolean isDisabled()
disabled
' attribute.protected int writeTagContent(TagWriter tagWriter) throws JspException
AbstractFormTag
writeTagContent
in class AbstractFormTag
javax.servlet.jsp.tagext.Tag#doStartTag()
.JspException
protected java.lang.String resolveId() throws JspException
resolveId
in class AbstractDataBoundFormElementTag
JspException
AbstractDataBoundFormElementTag.getId()
,
AbstractDataBoundFormElementTag.autogenerateId()
private SelectTag getSelectTag()
protected BindStatus getBindStatus()
AbstractDataBoundFormElementTag
BindStatus
for this tag.getBindStatus
in class AbstractDataBoundFormElementTag