HDIV API 2.0.4

org.hdiv.components
Class OptionTransferSelectHDIV

java.lang.Object
  extended by org.apache.struts2.components.Component
      extended by org.apache.struts2.components.UIBean
          extended by org.apache.struts2.components.ListUIBean
              extended by org.apache.struts2.components.DoubleListUIBean
                  extended by org.apache.struts2.components.OptionTransferSelect
                      extended by org.hdiv.components.OptionTransferSelectHDIV

public class OptionTransferSelectHDIV
extends 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_doubleName> 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"
  />

 
 

Author:
Gorka Vicente

Field Summary
 
Fields inherited from class org.apache.struts2.components.OptionTransferSelect
addAllToLeftLabel, addAllToRightLabel, addToLeftLabel, addToRightLabel, allowAddAllToLeft, allowAddAllToRight, allowAddToLeft, allowAddToRight, allowSelectAll, allowUpDownOnLeft, allowUpDownOnRight, buttonCssClass, buttonCssStyle, leftDownlabel, leftTitle, leftUpLabel, rightDownLabel, rightTitle, rightUpLabel, selectAllLabel
 
Fields inherited from class org.apache.struts2.components.DoubleListUIBean
doubleAccesskey, doubleCssClass, doubleCssStyle, doubleDisabled, doubleEmptyOption, doubleHeaderKey, doubleHeaderValue, doubleId, doubleList, doubleListKey, doubleListValue, doubleMultiple, doubleName, doubleOnblur, doubleOnchange, doubleOnclick, doubleOndblclick, doubleOnfocus, doubleOnkeydown, doubleOnkeypress, doubleOnkeyup, doubleOnmousedown, doubleOnmousemove, doubleOnmouseout, doubleOnmouseover, doubleOnmouseup, doubleOnselect, doubleSize, doubleValue, emptyOption, formName, headerKey, headerValue, multiple, size
 
Fields inherited from class org.apache.struts2.components.ListUIBean
list, listKey, listValue, throwExceptionOnNullValueAttribute
 
Fields inherited from class org.apache.struts2.components.UIBean
accesskey, cssClass, cssStyle, defaultTemplateDir, defaultUITheme, disabled, key, label, labelPosition, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateEngineManager, templateSuffix, theme, title, tooltip, tooltipConfig, value
 
Fields inherited from class org.apache.struts2.components.Component
actionMapper, COMPONENT_STACK, id, parameters, stack
 
Constructor Summary
OptionTransferSelectHDIV(com.opensymphony.xwork2.util.ValueStack stack, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 
Method Summary
 org.hdiv.dataComposer.IDataComposer getDataComposer()
           
protected  java.lang.String getDefaultTemplate()
           
 
Methods inherited from class org.apache.struts2.components.OptionTransferSelect
evaluateExtraParams, getAddAllToLeftLabel, getAddAllToRightLabel, getAddToLeftLabel, getAddToRightLabel, getAllowAddAllToLeft, getAllowAddAllToRight, getAllowAddToLeft, getAllowAddToRight, getAllowSelectAll, getAllowUpDownOnLeft, getAllowUpDownOnRight, getButtonCssClass, getButtonCssStyle, getLeftDownLabel, getLeftTitle, getLeftUpLabel, getRightDownLabel, getRightTitle, getRightUpLabel, getSelectAllLabel, setAddAllToLeftLabel, setAddAllToRightLabel, setAddToLeftLabel, setAddToRightLabel, setAllowAddAllToLeft, setAllowAddAllToRight, setAllowAddToLeft, setAllowAddToRight, setAllowSelectAll, setAllowUpDownOnLeft, setAllowUpDownOnRight, setButtonCssClass, setButtonCssStyle, setLeftDownLabel, setLeftTitle, setLeftUpLabel, setRightDownLabel, setRightTitle, setRightUpLabel, setSelectAllLabel
 
Methods inherited from class org.apache.struts2.components.DoubleListUIBean
getDoubleCssClass, 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, setDoubleListKey, setDoubleListValue, setDoubleMultiple, setDoubleName, setDoubleOnblur, setDoubleOnchange, setDoubleOnclick, setDoubleOndblclick, setDoubleOnfocus, setDoubleOnkeydown, setDoubleOnkeypress, setDoubleOnkeyup, setDoubleOnmousedown, setDoubleOnmousemove, setDoubleOnmouseout, setDoubleOnmouseover, setDoubleOnmouseup, setDoubleOnselect, setDoubleSize, setDoubleValue, setEmptyOption, setFormName, setHeaderKey, setHeaderValue, setMultiple, setSize
 
Methods inherited from class org.apache.struts2.components.ListUIBean
contains, getValueClassType, setList, setListKey, setListValue, setThrowExceptionOnNullValueAttribute
 
Methods inherited from class org.apache.struts2.components.UIBean
addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, escape, evaluateNameValue, evaluateParams, getTemplate, getTemplateDir, getTheme, getTooltipConfig, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssStyle, setDefaultTemplateDir, setDefaultUITheme, setDisabled, setKey, setLabel, setLabelposition, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTemplateEngineManager, setTheme, setTitle, setTooltip, setTooltipConfig, setValue
 
Methods inherited from class org.apache.struts2.components.Component
addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setActionMapper, setId, start, toString, usesBody
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OptionTransferSelectHDIV

public OptionTransferSelectHDIV(com.opensymphony.xwork2.util.ValueStack stack,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
Method Detail

getDefaultTemplate

protected java.lang.String getDefaultTemplate()
Overrides:
getDefaultTemplate in class org.apache.struts2.components.OptionTransferSelect

getDataComposer

public org.hdiv.dataComposer.IDataComposer getDataComposer()
Returns:
Returns data composer from request

HDIV 2.0.4

Copyright © 2008 hdiv.org. All Rights Reserved.