You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by sk...@apache.org on 2005/12/12 02:34:28 UTC
svn commit: r356094 - /myfaces/impl/trunk/tld/myfaces_html.tld
Author: skitching
Date: Sun Dec 11 17:34:25 2005
New Revision: 356094
URL: http://svn.apache.org/viewcvs?rev=356094&view=rev
Log:
Improved docs for selectOne{Menu|Listbox|Radio} components.
Modified:
myfaces/impl/trunk/tld/myfaces_html.tld
Modified: myfaces/impl/trunk/tld/myfaces_html.tld
URL: http://svn.apache.org/viewcvs/myfaces/impl/trunk/tld/myfaces_html.tld?rev=356094&r1=356093&r2=356094&view=diff
==============================================================================
--- myfaces/impl/trunk/tld/myfaces_html.tld (original)
+++ myfaces/impl/trunk/tld/myfaces_html.tld Sun Dec 11 17:34:25 2005
@@ -507,51 +507,80 @@
&standard_select_many_menu_attributes;
</tag>
-<!-- selectOneListbox -->
+ <!-- selectOneListbox -->
<tag>
<name>selectOneListbox</name>
<tag-class>org.apache.myfaces.taglib.html.HtmlSelectOneListboxTag</tag-class>
<body-content>JSP</body-content>
- <description>
- Renders as an HTML select element, with the choices made up of
- child f:selectItem or f:selectItems elements. The size attribute is
- set to the provided value, defaulting to the number of items in the
- list if no value is provided.
-
+ <description><![CDATA[
+ Renders a listbox containing a set of choices, of which only one
+ can be chosen at a time. The available choices are defined via
+ child f:selectItem or f:selectItems elements. The size of the
+ listbox defaults to the number of available choices; if size is
+ explicitly set to a smaller value, then scrollbars will be
+ rendered. If size is set to 1 then a "drop-down menu" (aka
+ "combo-box") is rendered, though if this is the intent then
+ selectOneMenu should be used instead.
+ <p>
+ The value attribute of this component is read to determine
+ which of the available options is initially selected; its value should
+ match the "value" property of one of the child SelectItem objects.
+ <p>
+ On submit of the enclosing form, the value attribute's bound property
+ is updated to contain the "value" property from the chosen SelectItem.
+ <p>
Unless otherwise specified, all attributes accept static values
or EL expressions.
+ ]]>
</description>
&standard_select_one_listbox_attributes;
</tag>
-<!-- selectOneMenu -->
+ <!-- selectOneMenu -->
<tag>
<name>selectOneMenu</name>
<tag-class>org.apache.myfaces.taglib.html.HtmlSelectOneMenuTag</tag-class>
<body-content>JSP</body-content>
- <description>
- Renders as an HTML select element, with the choices made up of
- child f:selectItem or f:selectItems elements.
-
+ <description><![CDATA[
+ Renders a drop-down menu (aka "combo-box") containing a set of
+ choices, of which only one can be chosen at a time. The available
+ choices are defined via child f:selectItem or f:selectItems
+ elements.
+ <p>
+ The value attribute of this component is read to determine
+ which of the available options is initially selected; its value should
+ match the "value" property of one of the child SelectItem objects.
+ <p>
+ On submit of the enclosing form, the value attribute's bound property
+ is updated to contain the "value" property from the chosen SelectItem.
+ <p>
Unless otherwise specified, all attributes accept static values
or EL expressions.
+ ]]>
</description>
&standard_select_one_menu_attributes;
</tag>
-<!-- selectOneRadio -->
+ <!-- selectOneRadio -->
<tag>
<name>selectOneRadio</name>
<tag-class>org.apache.myfaces.taglib.html.HtmlSelectOneRadioTag</tag-class>
<body-content>JSP</body-content>
- <description>
- Renders as an HTML table element, containing an input element for each
- child f:selectItem or f:selectItems elements. The input elements are
- rendered as type radio. If the value of a choice matches the components
- value, its checked attribute is set.
-
+ <description><![CDATA[
+ Renders as an HTML table element, containing an input element for
+ each child f:selectItem or f:selectItems elements. The input
+ elements are rendered as type radio.
+ <p>
+ The value attribute of this component is read to determine
+ which of the available options is initially selected; its value should
+ match the "value" property of one of the child SelectItem objects.
+ <p>
+ On submit of the enclosing form, the value attribute's bound property
+ is updated to contain the "value" property from the chosen SelectItem.
+ <p>
Unless otherwise specified, all attributes accept static values
or EL expressions.
+ ]]>
</description>
&standard_select_one_radio_attributes;
</tag>