| |
| <html> |
| <head> |
| <title><a2:updownselect /></title> |
| </head> |
| |
| <body> |
| |
| <h1>Tag Name: <a2:updownselect /></h1> |
| |
| <h2>Description</h2> |
| <p> |
| |
| Render a up down select element |
| |
| </p> |
| |
| <p> |
| <!-- START SNIPPET: javadoc --> Create a Select component with buttons to move the elements in the select component up and down. When the containing form is submited, its elements will be submitted in the order they are arranged (top to bottom). <!-- END SNIPPET: javadoc --> <p/> <pre> <!-- START SNIPPET: example --> <!-- Example 1: simple example --> <a:updownselect list="#{'england':'England', 'america':'America', 'germany':'Germany'}" name="prioritisedFavouriteCountries" headerKey="-1" headerValue="--- Please Order Them Accordingly ---" emptyOption="true" /> <!-- Example 2: more complex example --> <a:updownselect list="defaultFavouriteCartoonCharacters" name="prioritisedFavouriteCartoonCharacters" headerKey="-1" headerValue="--- Please Order ---" emptyOption="true" allowMoveUp="true" allowMoveDown="true" allowSelectAll="true" moveUpLabel="Move Up" moveDownLabel="Move Down" selectAllLabel="Select All" /> <!-- END SNIPPET: example --> </pre> |
| </p> |
| |
| <h2>Attributes</h2> |
| <p> |
| |
| <!-- START SNIPPET: tagattributes --> |
| <table width="100%"> |
| <tr> |
| |
| <th align="left" valign="top"><h4>Name</h4></th> |
| <th align="left" valign="top"><h4>Required</h4></th> |
| <th align="left" valign="top"><h4>Default</h4></th> |
| <th align="left" valign="top"><h4>Type</h4></th> |
| <th align="left" valign="top"><h4>Description</h4></th> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">allowMoveUp</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top">true</td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Boolean</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Whether move up button should be displayed</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">allowMoveDown</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top">true</td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Boolean</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Whether move down button should be displayed</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">allowSelectAll</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top">true</td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Boolean</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Whether or not select all button should be displayed</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">moveUpLabel</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top">^</td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Text to display on the move up button</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">moveDownLabel</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top">v</td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Text to display on the move down button</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">selectAllLabel</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top">*</td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Text to display on the select all button</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">emptyOption</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Boolean</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Whether or not to add an empty (--) option after the header option</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">headerKey</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Key for first item in list. Must not be empty! "'-1'" and "''" is correct, "" is bad.</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">headerValue</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Value expression for first item in list</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">multiple</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Boolean</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Creates a multiple select. The tag will pre-select multiple values if the values are passed as an Array (of appropriate types) via the value attribute. Passing a Collection may work too? Haven't tested this.</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">size</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Integer</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Size of the element box (# of elements to show)</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">list</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top"><b>true</b></td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Iterable source to populate from. If the list is a Map (key, value), the Map key will become the option "value" parameter and the Map value will become the option body.</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">listKey</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Property of list objects to get field value from</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">listValue</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Property of list objects to get field content from</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">templateDir</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">The template directory.</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">theme</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">The theme (other than default) to use for rendering the element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">template</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">The template (other than default) to use for rendering the element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">cssClass</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">The css class to use for element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">cssStyle</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">The css style definitions for element ro use</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">title</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html title attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">disabled</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html disabled attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">label</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Label expression used for rendering a element specific label</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">labelposition</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">define label position of form element (top/left)</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">requiredposition</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">define required position of required form element (left|right)</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">name</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">The name to set for element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">required</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Boolean</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">If set to true, the rendered element will indicate that input is required</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">tabindex</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html tabindex attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">value</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Preset the value of input element.</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onclick</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onclick attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">ondblclick</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html ondblclick attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onmousedown</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onmousedown attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onmouseup</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onmouseup attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onmouseover</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onmouseover attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onmousemove</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onmousemove attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onmouseout</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onmouseout attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onfocus</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onfocus attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onblur</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onblur attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onkeypress</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onkeypress attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onkeydown</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onkeydown attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onkeyup</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onkeyup attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onselect</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onselect attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">onchange</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html onchange attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">accesskey</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the html accesskey attribute on rendered html element</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">tooltip</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"></td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the tooltip of this particular component</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">tooltipConfig</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"></td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">Set the tooltip configuration</td> |
| |
| </tr> |
| |
| <tr> |
| <!-- Attribute name --> |
| <td align="left" valign="top">id</td> |
| |
| <!-- Required --> |
| <td align="left" valign="top">false</td> |
| |
| <!-- Default --> |
| <td align="left" valign="top"> </td> |
| |
| <!-- Type --> |
| <td align="left" valign="top">Object/String</td> |
| |
| <!-- Description --> |
| <td align="left" valign="top">id for referencing element. For UI and form tags it will be used as HTML id attribute</td> |
| |
| </tr> |
| |
| </table> |
| <!-- END SNIPPET: tagattributes --> |
| |
| </p> |
| <p> |
| <center><a href="index.html">Back to Taglib Index</a></center> |
| </p> |
| </body> |
| </html> |
| |
