Package org.apache.struts2.components
Class OptionTransferSelect
java.lang.Object
org.apache.struts2.components.Component
org.apache.struts2.components.UIBean
org.apache.struts2.components.ListUIBean
org.apache.struts2.components.DoubleListUIBean
org.apache.struts2.components.OptionTransferSelect
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_nameame> and <form_id>_<optiontransferselect_doubleName> respectively.
 
 <-- minimum configuration -->
 <s:optiontransferselect
      label="Favourite Cartoons Characters"
      name="leftSideCartoonCharacters"
      list="{'Popeye', 'He-Man', 'Spiderman'}"
      doubleName="rightSideCartoonCharacters"
      doubleList="{'Superman', 'Mickey Mouse', 'Donald Duck'}"
  />
  <-- possible configuration -->
  <s: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"
  />
 
 - 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected Stringprotected StringFields inherited from class org.apache.struts2.components.DoubleListUIBeandoubleAccesskey, doubleCssClass, doubleCssStyle, doubleDisabled, doubleEmptyOption, doubleHeaderKey, doubleHeaderValue, doubleId, doubleList, doubleListCssClass, doubleListCssStyle, doubleListKey, doubleListTitle, doubleListValue, doubleMultiple, doubleName, doubleOnblur, doubleOnchange, doubleOnclick, doubleOndblclick, doubleOnfocus, doubleOnkeydown, doubleOnkeypress, doubleOnkeyup, doubleOnmousedown, doubleOnmousemove, doubleOnmouseout, doubleOnmouseover, doubleOnmouseup, doubleOnselect, doubleSize, doubleValue, emptyOption, formName, headerKey, headerValue, multiple, sizeFields inherited from class org.apache.struts2.components.ListUIBeanlist, listCssClass, listCssStyle, listKey, listLabelKey, listTitle, listValue, listValueKey, throwExceptionOnNullValueAttributeFields inherited from class org.apache.struts2.components.UIBeanaccesskey, ATTR_FIELD_VALUE, ATTR_NAME_VALUE, ATTR_VALUE, cssClass, cssErrorClass, cssErrorStyle, cssStyle, defaultTemplateDir, defaultUITheme, disabled, dynamicAttributes, errorPosition, id, javascriptTooltip, key, label, labelPosition, labelSeparator, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, requiredLabel, requiredPosition, response, tabindex, template, templateDir, templateEngineManager, templateSuffix, theme, title, tooltip, tooltipConfig, tooltipCssClass, tooltipDelay, tooltipIconPath, uiStaticContentPath, uiThemeExpansionToken, valueFields inherited from class org.apache.struts2.components.ComponentactionMapper, attributes, COMPONENT_STACK, devMode, escapeHtmlBody, performClearTagStateForTagPoolingServers, stack, standardAttributesMap, throwExceptionOnELFailure
- 
Constructor SummaryConstructorsConstructorDescriptionOptionTransferSelect(ValueStack stack, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) 
- 
Method SummaryModifier and TypeMethodDescriptionvoidprotected StringA contract that requires each concrete UI Tag to specify which template should be used as a default.voidsetAddAllToLeftLabel(String addAllToLeftLabel) voidsetAddAllToLeftOnclick(String addAllToLeftOnclick) voidsetAddAllToRightLabel(String addAllToRightLabel) voidsetAddAllToRightOnclick(String addAllToRightOnclick) voidsetAddToLeftLabel(String addToLeftLabel) voidsetAddToLeftOnclick(String addToLeftOnclick) voidsetAddToRightLabel(String addToRightLabel) voidsetAddToRightOnclick(String addToRightOnclick) voidsetAllowAddAllToLeft(String allowAddAllToLeft) voidsetAllowAddAllToRight(String allowAddAllToRight) voidsetAllowAddToLeft(String allowAddToLeft) voidsetAllowAddToRight(String allowAddToRight) voidsetAllowSelectAll(String allowSelectAll) voidsetAllowUpDownOnLeft(String allowUpDownOnLeft) voidsetAllowUpDownOnRight(String allowUpDownOnRight) voidsetButtonCssClass(String buttonCssClass) voidsetButtonCssStyle(String buttonCssStyle) voidsetLeftDownLabel(String leftDownLabel) voidsetLeftTitle(String leftTitle) voidsetLeftUpLabel(String leftUpLabel) voidsetRightDownLabel(String rightDownlabel) voidsetRightTitle(String rightTitle) voidsetRightUpLabel(String rightUpLabel) voidsetSelectAllLabel(String selectAllLabel) voidsetSelectAllOnclick(String selectAllOnclick) voidsetUpDownOnLeftOnclick(String upDownOnLeftOnclick) voidsetUpDownOnRightOnclick(String upDownOnRightOnclick) Methods inherited from class org.apache.struts2.components.DoubleListUIBeangetDoubleCssClass, getDoubleCssStyle, getDoubleDisabled, getDoubleEmptyOption, getDoubleHeaderKey, getDoubleHeaderValue, getDoubleId, getDoubleList, getDoubleListKey, getDoubleListValue, getDoubleMultiple, getDoubleName, getDoubleOnblur, getDoubleOnchange, getDoubleOnclick, getDoubleOndblclick, getDoubleOnfocus, getDoubleOnkeydown, getDoubleOnkeypress, getDoubleOnkeyup, getDoubleOnmousedown, getDoubleOnmousemove, getDoubleOnmouseout, getDoubleOnmouseover, getDoubleOnmouseup, getDoubleOnselect, getDoubleSize, getDoubleValue, getFormName, setDoubleAccesskey, setDoubleCssClass, setDoubleCssStyle, setDoubleDisabled, setDoubleEmptyOption, setDoubleHeaderKey, setDoubleHeaderValue, setDoubleId, setDoubleList, setDoubleListCssClass, setDoubleListCssStyle, setDoubleListKey, setDoubleListTitle, setDoubleListValue, setDoubleMultiple, setDoubleName, setDoubleOnblur, setDoubleOnchange, setDoubleOnclick, setDoubleOndblclick, setDoubleOnfocus, setDoubleOnkeydown, setDoubleOnkeypress, setDoubleOnkeyup, setDoubleOnmousedown, setDoubleOnmousemove, setDoubleOnmouseout, setDoubleOnmouseover, setDoubleOnmouseup, setDoubleOnselect, setDoubleSize, setDoubleValue, setEmptyOption, setFormName, setHeaderKey, setHeaderValue, setMultiple, setSizeMethods inherited from class org.apache.struts2.components.ListUIBeancontains, getValueClassType, setList, setListCssClass, setListCssStyle, setListKey, setListLabelKey, setListTitle, setListValue, setListValueKey, setThrowExceptionOnNullValueAttributeMethods inherited from class org.apache.struts2.components.UIBeanaddFormParameter, applyValueParameter, buildTemplateName, copyAttributes, enableAncestorFormCustomOnsubmit, end, ensureAttributeSafelyNotEscaped, escape, evaluateNameValue, evaluateParams, getId, getTemplate, getTemplateDir, getTheme, getTooltipConfig, lazyEvaluation, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssErrorClass, setCssErrorStyle, setCssStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setDynamicAttributes, setErrorPosition, setId, setJavascriptTooltip, setKey, setLabel, setLabelPosition, setLabelSeparator, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequiredLabel, setRequiredPosition, setStaticContentPath, setStyle, setTabindex, setTemplate, setTemplateDir, setTemplateEngineManager, setTheme, setTitle, setTooltip, setTooltipConfig, setTooltipCssClass, setTooltipDelay, setTooltipIconPath, setUIThemeExpansionToken, setValueMethods inherited from class org.apache.struts2.components.ComponentaddAllAttributes, addParameter, completeExpression, determineActionURL, determineNamespace, end, escapeHtmlBody, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getAttributes, getComponentStack, getNamespace, getPerformClearTagStateForTagPoolingServers, getStack, getStandardAttributes, isAcceptableExpression, isValidTagAttribute, popComponentStack, setActionMapper, setDevMode, setEscapeHtmlBody, setNotExcludedAcceptedPatterns, setPerformClearTagStateForTagPoolingServers, setThrowExceptionsOnELFailure, setUrlHelper, start, stripExpression, toString, usesBody
- 
Field Details- 
allowAddToLeft
- 
allowAddToRight
- 
allowAddAllToLeft
- 
allowAddAllToRight
- 
allowSelectAll
- 
allowUpDownOnLeft
- 
allowUpDownOnRight
- 
leftTitle
- 
rightTitle
- 
buttonCssClass
- 
buttonCssStyle
- 
addToLeftLabel
- 
addToRightLabel
- 
addAllToLeftLabel
- 
addAllToRightLabel
- 
selectAllLabel
- 
leftUpLabel
- 
leftDownlabel
- 
rightUpLabel
- 
rightDownLabel
- 
addToLeftOnclick
- 
addToRightOnclick
- 
addAllToLeftOnclick
- 
addAllToRightOnclick
- 
selectAllOnclick
- 
upDownOnLeftOnclick
- 
upDownOnRightOnclick
 
- 
- 
Constructor Details- 
OptionTransferSelectpublic OptionTransferSelect(ValueStack stack, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) 
 
- 
- 
Method Details- 
getDefaultTemplateDescription copied from class:UIBeanA contract that requires each concrete UI Tag to specify which template should be used as a default. For example, the CheckboxTab might return "checkbox.vm" while the RadioTag might return "radio.vm". This value not begin with a '/' unless you intend to make the path absolute rather than relative to the current theme.- Specified by:
- getDefaultTemplatein class- UIBean
- Returns:
- The name of the template to be used as the default.
 
- 
evaluateExtraParamspublic void evaluateExtraParams()- Overrides:
- evaluateExtraParamsin class- DoubleListUIBean
 
- 
getAddAllToLeftLabel
- 
setAddAllToLeftLabel
- 
getAddAllToRightLabel
- 
setAddAllToRightLabel
- 
getAddToLeftLabel
- 
setAddToLeftLabel
- 
getAddToRightLabel
- 
setAddToRightLabel
- 
getAllowAddAllToLeft
- 
setAllowAddAllToLeft
- 
getAllowAddAllToRight
- 
setAllowAddAllToRight
- 
getAllowAddToLeft
- 
setAllowAddToLeft
- 
getAllowAddToRight
- 
setAllowAddToRight
- 
getLeftTitle
- 
setAllowUpDownOnLeft
- 
getAllowUpDownOnLeft
- 
setAllowUpDownOnRight
- 
getAllowUpDownOnRight
- 
setLeftTitle
- 
getRightTitle
- 
setRightTitle
- 
setAllowSelectAll
- 
getAllowSelectAll
- 
setSelectAllLabel
- 
getSelectAllLabel
- 
setButtonCssClass
- 
getButtonCssClass
- 
setButtonCssStyle
- 
getButtonCssStyle
- 
setLeftUpLabel
- 
getLeftUpLabel
- 
setLeftDownLabel
- 
getLeftDownLabel
- 
setRightUpLabel
- 
getRightUpLabel
- 
setRightDownLabel
- 
getRightDownLabel
- 
getAddAllToLeftOnclick
- 
setAddAllToLeftOnclick
- 
getAddAllToRightOnclick
- 
setAddAllToRightOnclick
- 
getAddToLeftOnclick
- 
setAddToLeftOnclick
- 
getAddToRightOnclick
- 
setAddToRightOnclick
- 
setUpDownOnLeftOnclick
- 
getUpDownOnLeftOnclick
- 
setUpDownOnRightOnclick
- 
getUpDownOnRightOnclick
- 
setSelectAllOnclick
- 
getSelectAllOnclick
 
-