|
BEA NetUI tags and APIs are included for backward compatibility only. For new applications, use the Beehive tags and APIs. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.servlet.jsp.tagext.TagSupport javax.servlet.jsp.tagext.BodyTagSupport com.bea.wlw.netui.tags.AbstractBaseTag com.bea.wlw.netui.tags.DataSourceTag com.bea.wlw.netui.tags.DefaultableDataSourceTag com.bea.wlw.netui.tags.OptionsDataSourceTag com.bea.wlw.netui.tags.html.Select
public class Select
Renders a select containing a set of SelectOptions. Select binds to an Iterator of Strings. If Select uses any Format tags, it must have those tags come before any nested SelectOption tags.
Attribute Descriptions | |||
---|---|---|---|
Attribute | Required | Runtime Expression Evaluation | Data Bindable |
accessKey | No | No | No |
Define the keyboard navigation key for the element. | |||
dataSource | Yes | No | Read / Write |
The name of a form bean property or an expression that contains the Select state. | |||
defaultValue | No | No | Read Only |
A literal value or an expression that is used to set the Select's initial state. | |||
disabled | No | No | Read Only |
A boolean value which if true will cause the Select to be disabled. | |||
multiple | No | No | No |
Whether or not multi-selection is enabled. | |||
nullable | No | No | No |
Whether a (null) option should be added to the bottom of the list. If the Select has multiple=true, (null) won't be shown regardless. | |||
nullableOptionText | No | No | No |
If nullable is true , then this is optional text
for the option. The default is to use the empty string, "", as the value. | |||
optionsDataSource | No | No | Read Only |
An expression which is used to generate a set of dynamic SelectOption tags. | |||
tagId | No | No | No |
The ID of this select used by the enclosing html tag to get the tag's name for javascript and focus purposes. | |||
size | No | No | No |
The number of visible options. |
SelectOption
,
Serialized FormoptionsDataSource
attribute to reference a
dynamically generated dropdown list.
<netui:select dataSource="{actionForm.selectedOption}" optionsDataSource="{actionForm.itemOptions}" />
Assume that the optionsDataSource
attribute refers to
a java.util.Map
object.
The Map object will be rendered as a series
of <option> tags. HTML that is similar to the following will be
rendered in the browser:
<select> <option value="633">Aurora Bridge</option> <option value="631">FA-18 fighter jet</option> <option value="635">Space Needle</option> <option value="642">Thin Mints</option> ... </select>
[BEA_HOME]/weblogic81/samples/workshop/SamplesApp/WebApp/tagSamples/select/
[BEA_HOME]/weblogic81/samples/workshop/SamplesApp/WebApp/handlingData/dropdown/
The <netui:select> tag can generate a set of selectable options in two ways:
- they can be dynamically generated by pointing the <netui:select> tag at a String[] object or
java.util.HashMap
- they can be statically generated by providing a set of children
SelectOption
tags
Dynamically Generated Options
You can dynamically generate a set of selectable options by pointing the <netui:select> tag at a String[].
public String[] _options = {"red", "green", "blue", "orange", "pink", "aqua", "black", "brown", "tan"};
To point the <netui:select> tag
at the String[] object use the optionsDataSource
attribute.
<netui:select optionsDataSource="{pageFlow._options}"Note that you can make the display value and the submitted value differ by pointing the <netui:select> tag at a HashMap object. (Any object that implements the
java.util.Map
interface will work.)
public HashMap _hashMap = new HashMap(); protected void onCreate() { _hashMap.put("#ff3333", "red"); _hashMap.put("#3333ff", "blue"); _hashMap.put("#33ff33", "green"); }The following HTML will be generated.
<select size="3"> <option value="#3333ff">blue</option> <option value="#33ff33">green</option> <option value="#ff3333">red</option> </select>
Statically Generated Options
To statically generate selecable options, place a set of <netui:selectOption> tags inside the <netui:select> tag.
<netui:select dataSource="{actionForm.selections}" size="5"> <netui:selectOption value="red" /> <netui:selectOption value="blue" /> <netui:selectOption value="green" /> <netui:selectOption value="yellow" /> <netui:selectOption value="orange" /> </netui:select>
Submitting Selections
A <netui:select> is submitted as a String or String[] object, depending on whether the
multiple
attribute is set to true. In the following example, the dataSource
attribute points at a String[] object.
</netui:select dataSource="{actionForm.selections}">
In this case, the <netui:select> tag submits to a String[] field of a Form Bean.
public static class SubmitForm extends FormData { private String[] selections; public void setSelections(String[] selections) { this.selections = selections; } public String[] getSelections() { return this.selections; } }
Nested Class Summary | |
---|---|
static class |
Select.SelectPrefixHandler
|
Field Summary | |
---|---|
static String |
NULL_VALUE
|
Fields inherited from class com.bea.wlw.netui.tags.AbstractBaseTag |
---|
ATTR_GENERAL, ATTR_GENERAL_EXPRESSION, ATTR_JAVASCRIPT, ATTR_STYLE, JAVASCRIPT_STATUS, NETUI_UNIQUE_CNT |
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 com.bea.wlw.netui.tags.html.HtmlConstants |
---|
ACCEPT, ACCESSKEY, ACTION, ALIGN, ALINK, ALT, ANCHOR, BACKGROUND, BASE, BGCOLOR, BODY, BORDER, BR, CAPTION, CELLPADDING, CELLSPACING, CHAR, CHAROFF, CHARSET, CHECKED, CLASS, COLS, COORDS, DIR, DISABLED, DIV, ENCTYPE, FOR, FORM, FORM_GET, FORM_POST, FRAME, HEIGHT, HREF, HREFLANG, HSPACE, HTML, ID, IMAGE, INPUT, INPUT_BUTTON, INPUT_CHECKBOX, INPUT_FILE, INPUT_HIDDEN, INPUT_IMAGE, INPUT_PASSWORD, INPUT_RADIO, INPUT_RESET, INPUT_SUBMIT, INPUT_TEXT, ISMAP, LABEL, LANG, LINK, LONGDESC, MAXLENGTH, METHOD, NAME, ONBLUR, ONCHANGE, ONCLICK, ONDBLCLICK, ONFOCUS, ONKEYDOWN, ONKEYPRESS, ONKEYUP, ONLOAD, ONMOUSEDOWN, ONMOUSEMOVE, ONMOUSEOUT, ONMOUSEOVER, ONMOUSEUP, ONRESET, ONSELECT, ONSUBMIT, ONUNLOAD, OPTION, READONLY, REL, REV, ROWS, RULES, SELECT, SHAPE, SIZE, SPAN, SRC, STYLE, SUMMARY, TABINDEX, TABLE, TARGET, TD, TEXT, TEXTAREA, TITLE, TR, TYPE, USEMAP, VALIGN, VALUE, VLINK, VSPACE, WIDTH |
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 | |
---|---|
Select()
|
Method Summary | |
---|---|
void |
addFormatter(FormatTag.Formatter formatter)
Adds a FormatTag.Formatter to the Select's set of formatters |
void |
addOptionToList(String value)
|
protected boolean |
containsString(List list,
String value)
Return true, if the list contains an Object.toString().equals(value). |
int |
doAfterBody()
Save any body content of this tag, which will generally be the option(s) representing the values displayed to the user. |
int |
doEndTag()
Render the end of this select. |
int |
doStartTag()
Render the beginning of this select. |
protected Object |
evaluateDefaultValue()
Evaluate the defaultValues |
protected Object |
evaluateOptionsDataSource()
|
String |
formatText(Object text)
Apply the Select's set of formatters to the given text |
String |
getAccessKey()
Gets the accessKey attribute value. |
String |
getDisabled()
Returns the boolean value or expression indicating the disable state of the Select. |
boolean |
getMultiple()
Gets whether multiple selections are allowed. |
String |
getNullableOptionText()
If the nullable |
boolean |
getNullableTop()
Returns the boolean value indicating whether the null option is at the top (true) or the bottom (false) of the select list. |
String |
getOnBlur()
Gets the onBlur javascript event. |
String |
getOnChange()
Gets the onChange javascript event. |
String |
getOnClick()
Gets the onClick javascript event. |
String |
getOnDblClick()
Gets the onDblClick javascript event. |
String |
getOnFocus()
Gets the onFocus javascript event. |
String |
getOnKeyDown()
Gets the onKeyDown javascript event. |
String |
getOnKeyPress()
Gets the onKeyPress javascript event. |
String |
getOnKeyUp()
Gets the onKeyUp javascript event. |
String |
getOnMouseDown()
Gets the onMouseDown javascript event. |
String |
getOnMouseMove()
Gets the onMouseMove javascript event. |
String |
getOnMouseOut()
Gets the onMouseOut javascript event. |
String |
getOnMouseOver()
Gets the onMouseOver javascript event. |
String |
getOnMouseUp()
Gets the onMouseUp javascript event. |
String |
getOnSelect()
Gets the onSelect javascript event. |
String |
getSize()
Gets how many options are displayed. |
String |
getStyle()
Gets the style of the rendered html tag. |
String |
getStyleClass()
Gets the style class of the rendered html tag. |
String |
getTabindex()
Gets the tabIndex of the rendered html tag. |
String |
getTagId()
Return the ID of the select. |
String |
getTagName()
Return the name of the Tag. |
boolean |
isMatched(String value)
Does the specified value match one of those we are looking for? |
boolean |
isNullable()
Gets whether a null option is desired. |
protected void |
localRelease()
Release any acquired resources. |
void |
setAccessKey(String accessKey)
Sets the accessKey attribute value. |
void |
setAttribute(String name,
String value)
Set an attribute value. |
void |
setDisabled(String disabled)
Set the disable state either with the literal "true" or "false" or with an expression. |
void |
setMultiple(boolean multiple)
Set whether multiple selections are allowed. |
void |
setNullable(boolean nullable)
Set whethera null option is desired. |
void |
setNullableOptionText(String nullableOptionText)
Set the text of the nullable option. |
void |
setNullableTop(boolean nullableTop)
Set to true if the null option should be at the top of the select list. |
void |
setOnBlur(String onblur)
Sets the onBlur javascript event. |
void |
setOnChange(String onchange)
Sets the onChange javascript event. |
void |
setOnClick(String onclick)
Sets the onClick javascript event. |
void |
setOnDblClick(String ondblclick)
Sets the onDblClick javascript event. |
void |
setOnFocus(String onfocus)
Sets the onFocus javascript event. |
void |
setOnKeyDown(String onkeydown)
Sets the onKeyDown javascript event. |
void |
setOnKeyPress(String onkeypress)
Sets the onKeyPress javascript event. |
void |
setOnKeyUp(String onkeyup)
Sets the onKeyUp javascript event. |
void |
setOnMouseDown(String onmousedown)
Sets the onMouseDown javascript event. |
void |
setOnMouseMove(String onmousemove)
Sets the onMouseMove javascript event. |
void |
setOnMouseOut(String onmouseout)
Sets the onMouseOut javascript event. |
void |
setOnMouseOver(String onmouseover)
Sets the onMouseOver javascript event. |
void |
setOnMouseUp(String onmouseup)
Sets the onMouseUp javascript event. |
void |
setOnSelect(String onselect)
Sets the onSelect javascript event. |
void |
setSize(String size)
Sets how many options are displayed. |
void |
setStyle(String style)
Sets the style of the rendered html tag. |
void |
setStyleClass(String styleClass)
Sets the style class of the rendered html tag. |
void |
setTabindex(String tabindex)
Sets the tabIndex of the rendered html tag. |
void |
setTagId(String tagId)
Set the ID of the select. |
Methods inherited from class com.bea.wlw.netui.tags.OptionsDataSourceTag |
---|
getOptionsDataSource, setOptionsDataSource |
Methods inherited from class com.bea.wlw.netui.tags.DefaultableDataSourceTag |
---|
getDefaultValue, setDefaultValue |
Methods inherited from class com.bea.wlw.netui.tags.DataSourceTag |
---|
addNamingInterceptor, doNaming, evaluateDataSource, getDataSource, qualifyAttribute, removeNamingInterceptor, setDataSource |
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport |
---|
doInitBody, getBodyContent, getPreviousOut, setBodyContent |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, 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, setParent |
Field Detail |
---|
public static final String NULL_VALUE
Constructor Detail |
---|
public Select()
Method Detail |
---|
public String getTagName()
getTagName
in class AbstractBaseTag
public void setAttribute(String name, String value) throws javax.servlet.jsp.JspException
name
represents
the name of the attribute.
The value
represents the value and may contain
a netui expression. This method may result in errors being generated.
This requires that the tag buffer its body and
write attributes in the end tag. For the select tag it is not legal to set
the id
or name
attributes with this method.
setAttribute
in interface IAttributeConsumer
name
- The name of the attribute. This value may not be null or the empty string.value
- The value of the attribute. This may contain a netui expression.
javax.servlet.jsp.JspException
- A JspException may be thrown if there is an error setting the attribute.protected Object evaluateDefaultValue()
evaluateDefaultValue
in class DefaultableDataSourceTag
public boolean getMultiple()
public void setMultiple(boolean multiple)
multiple
- - the multiple value ("true" or "false")nullable
is set to true.public boolean isNullable()
public void setNullable(boolean nullable)
nullable
- - the nullable valueattribute
set to true, the null option won't be shown.public String getNullableOptionText()
nullable option is true, this is
the text of that option. The default is "";
- Returns:
- the text of the nullable option
public void setNullableOptionText(String nullableOptionText)
nullable option is true, this is
the text of that option. The default is "";
- Beadoc.attributedescription:
- Boolean.
If the
nullable
attribute is set to true, then the nullableOptionText
attribute determines the display text of the null option.
The default is to use the empty string, "", as the display text.
- Beadoc.attributesyntaxvalue:
- boolean_nullableOptionText
- Beadoc.databindable:
- false
protected Object evaluateOptionsDataSource() throws javax.servlet.jsp.JspException
evaluateOptionsDataSource
in class OptionsDataSourceTag
javax.servlet.jsp.JspException
public String getSize()
public void setSize(String size)
size
- - the size (a number)public String getTagId()
public void setTagId(String tagId)
tagId
- - the ID.String value. Sets the id
(or name
) attribute of the rendered HTML tag.
Note that the real id attribute rendered in the browser may be
changed by the application container (for example, Portal containers may change
the rendered id value to ensure the uniqueness of
id's on the page). In this case, the real id rendered
in the browser may be looked up
through the JavaScript function getNetuiTagName( tagId, tag ).
For example, assume that some tag's tagId
attribute is set to foo
.
<netui:textBox tagId="foo" />
Then the following JavaScript function will return the real id attribute rendered in the browser:
getNetuiTagName( "foo", this )
To get a <netui:form> element and all of its children elements in JavaScript, use
the same JavaScript function getNetuiTagName( tagId, tag )
. For example,
assume that there is a <netui:form> whose
tagId attribute is set to bar
.
<netui:form tagId="bar" >
Then the following JavaScript function will return the <netui:form> element and its children (packaged as an array).
document[getNetuiTagName( "bar", this )]
To retreive the value entered into a <netui:textBox> within the <netui:form> tag, use the following JavaScript expression.
document[getNetuiTagName("bar", this)][getNetuiTagName("foo", this)].value
The second parameter ensures that the JavaScript function
begins its search within the correct Portlet scope. Pass the
JavaScript keyword this
as the second parameter.
For detailed information on using the function
getNetuiTagName( tagId, tag )
see
Using JavaScript in Page Flow and Portal Applications.
public String getDisabled()
public void setDisabled(String disabled)
disabled
- - true or false or an expressionpublic boolean getNullableTop()
public void setNullableTop(boolean nullableTop)
nullableTop
- - true if nullable should be at the top of the listpublic boolean isMatched(String value)
value
- Value to be comparedpublic int doStartTag() throws javax.servlet.jsp.JspException
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class javax.servlet.jsp.tagext.BodyTagSupport
javax.servlet.jsp.JspException
- if a JSP exception has occurredpublic int doAfterBody() throws javax.servlet.jsp.JspException
doAfterBody
in interface javax.servlet.jsp.tagext.IterationTag
doAfterBody
in class javax.servlet.jsp.tagext.BodyTagSupport
javax.servlet.jsp.JspException
- if a JSP exception has occurredpublic int doEndTag() throws javax.servlet.jsp.JspException
doEndTag
in interface javax.servlet.jsp.tagext.Tag
doEndTag
in class javax.servlet.jsp.tagext.BodyTagSupport
javax.servlet.jsp.JspException
- if a JSP exception has occurredprotected void localRelease()
localRelease
in class OptionsDataSourceTag
public void addFormatter(FormatTag.Formatter formatter)
addFormatter
in interface Formattable
formatter
- - a FormatTag.Formatter added by a child FormatTag.public void addOptionToList(String value)
protected boolean containsString(List list, String value)
list
- value
-
public String formatText(Object text)
text
- - the text to format.
public void setTabindex(String tabindex)
tabindex
- - the tab index.public String getTabindex()
public void setStyle(String style)
style
- - the html style.public String getStyle()
public void setStyleClass(String styleClass)
styleClass
- - the html style class.public String getStyleClass()
public String getAccessKey()
public void setAccessKey(String accessKey)
A, C, E, F, G,
H, V, left arrow, and right arrow
.
accessKey
- - the accessKey value.A, C, E, F, G,
H, V, left arrow, and right arrow
public String getOnClick()
public void setOnClick(String onclick)
onclick
- - the onClick event.public String getOnDblClick()
public void setOnDblClick(String ondblclick)
ondblclick
- - the onDblClick event.public String getOnKeyDown()
public void setOnKeyDown(String onkeydown)
onkeydown
- - the onKeyDown event.public String getOnKeyPress()
public void setOnKeyPress(String onkeypress)
onkeypress
- - the onKeyPress event.public String getOnKeyUp()
public void setOnKeyUp(String onkeyup)
onkeyup
- - the onKeyUp event.public String getOnMouseDown()
public void setOnMouseDown(String onmousedown)
onmousedown
- - the onMouseDown event.public String getOnMouseMove()
public void setOnMouseMove(String onmousemove)
onmousemove
- - the onMouseMove event.public String getOnMouseOut()
public void setOnMouseOut(String onmouseout)
onmouseout
- - the onMouseOut event.public String getOnMouseOver()
public void setOnMouseOver(String onmouseover)
onmouseover
- - the onMouseOver event.public String getOnMouseUp()
public void setOnMouseUp(String onmouseup)
onmouseup
- - the onMouseUp event.public String getOnBlur()
public void setOnBlur(String onblur)
onblur
- - the onBlur event.public String getOnFocus()
public void setOnFocus(String onfocus)
onfocus
- - the onFocus event.public String getOnChange()
public void setOnChange(String onchange)
onchange
- - the onChange event.public String getOnSelect()
public void setOnSelect(String onselect)
onselect
- - the onSelect event.
|
BEA NetUI tags and APIs are included for backward compatibility only. For new applications, use the Beehive tags and APIs. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |