Please make sure you have read the Tag Syntax document and understand how tag attribute syntax works.

Important

Note that the doublelistkey and doublelistvalue attribute will default to "key" and "value" respectively only when the doublelist attribute is evaluated to a Map or its decendant. Other thing else, will result in doublelistkey and doublelistvalue to be null and not used.

Description

Create a option transfer select component which is basically two <select ...> tag with buttons in the middle of them allowing options in each of the <select ...> to be moved between themselves. Will auto-select all its elements upon its containing form submision.

NOTE: The id and doubleId need not be supplied as they will generated provided that the optiontransferselect tag is being used in a form tag. The generated id and doubleId will be <form_id>_<optiontransferselect_doubleName> and <form_id>_<optiontransferselect_doubleName> respectively.

 

Parameters

Name

Required

Default

Type

Description

addAllToLeftLabel false   Object/String set Add To Left button label
addAllToRightLabel false   Object/String set Add All To Right button label
addToLeftLabel false   Object/String set Add To Left button label
addToRightLabel false   Object/String set Add To Right button label
allowAddAllToLeft false   Object/String enable Add All To Left button
allowAddAllToRight false   Object/String enable Add All To Right button
allowAddToLeft false   Object/String enable Add To Left button
allowAddToRight false   Object/String enable Add To Right button
leftTitle false   Object/String set Left title
rightTitle false   Object/String set Right title
allowSelectAll false   Object/String enable Select All button
selectAllLabel false   Object/String set Select All button label
buttonCssClass false   Object/String set buttons css class
buttonCssStyle false   Object/String set button css style
doubleList true   Object/String The second iterable source to populate from.
doubleListKey false   Object/String The key expression to use for second list
doubleListValue false   Object/String The value expression to use for second list
doubleName true   Object/String The name for complete component
doubleValue false   Object/String The value expression for complete component
formName false   Object/String The form name this component resides in and populates to
doubleCssClass false   Object/String The css class for the second list
doubleCssStyle false   Object/String The css style for the second list
doubleHeaderKey false   Object/String The header key for the second list
doubleHeaderValue false   Object/String The header value for the second list
doubleEmptyOption false   Object/String Decides if the second list will add an empty option
doubleDisabled false   Object/String Decides if a disable attribute should be added to the second list
doubleId false   Object/String The id of the second list
doubleMultiple false   Object/String Decides if multiple attribute should be set on the second list
doubleOnblur false   Object/String Set the onblur attribute of the second list
doubleOnchange false   Object/String Set the onchange attribute of the second list
doubleOnclick false   Object/String Set the onclick attribute of the second list
doubleOndblclick false   Object/String Set the ondbclick attribute of the second list
doubleOnfocus false   Object/String Set the onfocus attribute of the second list
doubleOnkeydown false   Object/String Set the onkeydown attribute of the second list
doubleOnkeypress false   Object/String Set the onkeypress attribute of the second list
doubleOnkeyup false   Object/String Set the onkeyup attribute of the second list
doubleOnmousedown false   Object/String Set the onmousedown attribute of the second list
doubleOnmousemove false   Object/String Set the onmousemove attribute of the second list
doubleOnmouseout false   Object/String Set the onmouseout attribute of the second list
doubleOnmouseover false   Object/String Set the onmouseover attribute of the second list
doubleOnmouseup false   Object/String Set the onmouseup attribute of the second list
doubleOnselect false   Object/String Set the onselect attribute of the second list
doubleSize false   Object/String Set the size attribute of the second list
doubleListKey false   Object/String Set the list key of the second attribute
emptyOption false false Boolean Decides of an empty option is to be inserted in the second list
headerKey false   Object/String Set the header key of the second list. Must not be empty! "'-1'" and "''" is correct, "" is bad.
headerValue false   Object/String Set the header value of the second list
multiple false   Object/String 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.
size false   Integer Size of the element box (# of elements to show)
list true   Object/String 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.
listKey false   Object/String Property of list objects to get field value from
listValue false   Object/String Property of list objects to get field content from
theme false   Object/String The theme (other than default) to use for rendering the element
templateDir false   Object/String The template directory (other than default) to used to find the themes and hence the template.
template false   Object/String The template (other than default) to use for rendering the element
cssClass false   Object/String The css class to use for element
cssStyle false   Object/String The css style definitions for element ro use
title false   Object/String Set the html title attribute on rendered html element
disabled false   Object/String Set the html disabled attribute on rendered html element
label false   Object/String Label expression used for rendering a element specific label
labelPosition false left Object/String deprecated.
labelposition false   Object/String define label position of form element (top/left)
requiredposition false   Object/String define required position of required form element (left|right)
name false   Object/String The name to set for element
required false false Boolean If set to true, the rendered element will indicate that input is required
tabindex false   Object/String Set the html tabindex attribute on rendered html element
value false   Object/String Preset the value of input element.
onclick false   Object/String Set the html onclick attribute on rendered html element
ondblclick false   Object/String Set the html ondblclick attribute on rendered html element
onmousedown false   Object/String Set the html onmousedown attribute on rendered html element
onmouseup false   Object/String Set the html onmouseup attribute on rendered html element
onmouseover false   Object/String Set the html onmouseover attribute on rendered html element
onmousemove false   Object/String Set the html onmousemove attribute on rendered html element
onmouseout false   Object/String Set the html onmouseout attribute on rendered html element
onfocus false   Object/String Set the html onfocus attribute on rendered html element
onblur false   Object/String Set the html onblur attribute on rendered html element
onkeypress false   Object/String Set the html onkeypress attribute on rendered html element
onkeydown false   Object/String Set the html onkeydown attribute on rendered html element
onkeyup false   Object/String Set the html onkeyup attribute on rendered html element
onselect false   Object/String Set the html onselect attribute on rendered html element
onchange false   Object/String Set the html onchange attribute on rendered html element
accesskey false   Object/String Set the html accesskey attribute on rendered html ekement
tooltip false String Set the tooltip of this particular component
tooltipConfig false String Set the tooltip configuration
id false   Object/String id for referencing element. For UI and form tags it will be used as HTML id attribute

 

Examples

<-- minimum configuration -->
<ww:optiontransferselect 
  	label="Favourite Cartoons Characters"
	name="leftSideCartoonCharacters" 
	list="{'Popeye', 'He-Man', 'Spiderman'}" 
	doubleName="rightSideCartoonCharacters"
	doubleList="{'Superman', 'Mickey Mouse', 'Donald Duck'}" 
/>

 <-- possible configuration -->
 <ww:optiontransferselect 
  	label="Favourite Cartoons Characters"
	name="leftSideCartoonCharacters" 
	leftTitle="Left Title"
	rightTitle="Right Title"
	list="{'Popeye', 'He-Man', 'Spiderman'}" 
	multiple="true"
	headerKey="headerKey"
	headerValue="--- Please Select ---"
	emptyOption="true"
	doubleList="{'Superman', 'Mickey Mouse', 'Donald Duck'}" 
	doubleName="rightSideCartoonCharacters"
	doubleHeaderKey="doubleHeaderKey"
	doubleHeaderValue="--- Please Select ---" 
	doubleEmptyOption="true"
	doubleMultiple="true"
/>