com.opensymphony.webwork.components
Class OptionTransferSelect

java.lang.Object
  extended by com.opensymphony.webwork.components.Component
      extended by com.opensymphony.webwork.components.UIBean
          extended by com.opensymphony.webwork.components.ListUIBean
              extended by com.opensymphony.webwork.components.DoubleListUIBean
                  extended by com.opensymphony.webwork.components.OptionTransferSelect

public class OptionTransferSelect
extends DoubleListUIBean

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 -->
 <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"
        />
 
 
 

Version:
$Date: 2006-03-19 00:28:55 +0800 (Sun, 19 Mar 2006) $ $Id: OptionTransferSelect.java 2468 2006-03-18 16:28:55Z rgielen $
Author:
tm_jee

Field Summary
protected  String addAllToLeftLabel
           
protected  String addAllToRightLabel
           
protected  String addToLeftLabel
           
protected  String addToRightLabel
           
protected  String allowAddAllToLeft
           
protected  String allowAddAllToRight
           
protected  String allowAddToLeft
           
protected  String allowAddToRight
           
protected  String allowSelectAll
           
protected  String buttonCssClass
           
protected  String buttonCssStyle
           
protected  String leftTitle
           
protected  String rightTitle
           
protected  String selectAllLabel
           
 
Fields inherited from class com.opensymphony.webwork.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 com.opensymphony.webwork.components.ListUIBean
list, listKey, listValue, throwExceptionOnNullValueAttribute
 
Fields inherited from class com.opensymphony.webwork.components.UIBean
accesskey, cssClass, cssStyle, disabled, label, labelPosition, name, onblur, onchange, onclick, ondblclick, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, request, required, requiredposition, response, tabindex, template, templateDir, templateSuffix, theme, title, tooltip, tooltipConfig, value
 
Fields inherited from class com.opensymphony.webwork.components.Component
COMPONENT_STACK, id, parameters, stack
 
Constructor Summary
OptionTransferSelect(OgnlValueStack stack, HttpServletRequest request, HttpServletResponse response)
           
 
Method Summary
 void evaluateExtraParams()
           
 String getAddAllToLeftLabel()
           
 String getAddAllToRightLabel()
           
 String getAddToLeftLabel()
           
 String getAddToRightLabel()
           
 String getAllowAddAllToLeft()
           
 String getAllowAddAllToRight()
           
 String getAllowAddToLeft()
           
 String getAllowAddToRight()
           
 String getAllowSelectAll()
           
 String getButtonCssClass()
           
 String getButtonCssStyle()
           
protected  String getDefaultTemplate()
          A contract that requires each concrete UI Tag to specify which template should be used as a default.
 String getLeftTitle()
           
 String getRightTitle()
           
 String getSelectAllLabel()
           
 void setAddAllToLeftLabel(String addAllToLeftLabel)
          set Add To Left button label
 void setAddAllToRightLabel(String addAllToRightLabel)
          set Add All To Right button label
 void setAddToLeftLabel(String addToLeftLabel)
          set Add To Left button label
 void setAddToRightLabel(String addToRightLabel)
          set Add To Right button label
 void setAllowAddAllToLeft(String allowAddAllToLeft)
          enable Add All To Left button
 void setAllowAddAllToRight(String allowAddAllToRight)
          enable Add All To Right button
 void setAllowAddToLeft(String allowAddToLeft)
          enable Add To Left button
 void setAllowAddToRight(String allowAddToRight)
          enable Add To Right button
 void setAllowSelectAll(String allowSelectAll)
          enable Select All button
 void setButtonCssClass(String buttonCssClass)
          set buttons css class
 void setButtonCssStyle(String buttonCssStyle)
          set button css style
 void setLeftTitle(String leftTitle)
          set Left title
 void setRightTitle(String rightTitle)
          set Right title
 void setSelectAllLabel(String selectAllLabel)
          set Select All button label
 
Methods inherited from class com.opensymphony.webwork.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 com.opensymphony.webwork.components.ListUIBean
contains, getValueClassType, setList, setListKey, setListValue, setThrowExceptionOnNullValueAttribute
 
Methods inherited from class com.opensymphony.webwork.components.UIBean
addFormParameter, buildTemplateName, enableAncestorFormCustomOnsubmit, end, escape, evaluateNameValue, evaluateParams, getTemplate, getTemplateDir, getTheme, getTooltipConfig, mergeTemplate, populateComponentHtmlId, setAccesskey, setCssClass, setCssStyle, setDisabled, setLabel, setLabelposition, setLabelPosition, setName, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setRequired, setRequiredposition, setTabindex, setTemplate, setTemplateDir, setTheme, setTitle, setTooltip, setTooltipConfig, setValue
 
Methods inherited from class com.opensymphony.webwork.components.Component
addAllParameters, addParameter, altSyntax, copyParams, determineActionURL, determineNamespace, end, fieldError, findAncestor, findString, findString, findValue, findValue, findValue, getComponentStack, getId, getParameters, getStack, popComponentStack, setId, start, toString, usesBody
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

allowAddToLeft

protected String allowAddToLeft

allowAddToRight

protected String allowAddToRight

allowAddAllToLeft

protected String allowAddAllToLeft

allowAddAllToRight

protected String allowAddAllToRight

allowSelectAll

protected String allowSelectAll

leftTitle

protected String leftTitle

rightTitle

protected String rightTitle

buttonCssClass

protected String buttonCssClass

buttonCssStyle

protected String buttonCssStyle

addToLeftLabel

protected String addToLeftLabel

addToRightLabel

protected String addToRightLabel

addAllToLeftLabel

protected String addAllToLeftLabel

addAllToRightLabel

protected String addAllToRightLabel

selectAllLabel

protected String selectAllLabel
Constructor Detail

OptionTransferSelect

public OptionTransferSelect(OgnlValueStack stack,
                            HttpServletRequest request,
                            HttpServletResponse response)
Method Detail

getDefaultTemplate

protected String getDefaultTemplate()
Description copied from class: UIBean
A 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:
getDefaultTemplate in class UIBean
Returns:
The name of the template to be used as the default.

evaluateExtraParams

public void evaluateExtraParams()
Overrides:
evaluateExtraParams in class DoubleListUIBean

getAddAllToLeftLabel

public String getAddAllToLeftLabel()

setAddAllToLeftLabel

public void setAddAllToLeftLabel(String addAllToLeftLabel)
set Add To Left button label


getAddAllToRightLabel

public String getAddAllToRightLabel()

setAddAllToRightLabel

public void setAddAllToRightLabel(String addAllToRightLabel)
set Add All To Right button label


getAddToLeftLabel

public String getAddToLeftLabel()

setAddToLeftLabel

public void setAddToLeftLabel(String addToLeftLabel)
set Add To Left button label


getAddToRightLabel

public String getAddToRightLabel()

setAddToRightLabel

public void setAddToRightLabel(String addToRightLabel)
set Add To Right button label


getAllowAddAllToLeft

public String getAllowAddAllToLeft()

setAllowAddAllToLeft

public void setAllowAddAllToLeft(String allowAddAllToLeft)
enable Add All To Left button


getAllowAddAllToRight

public String getAllowAddAllToRight()

setAllowAddAllToRight

public void setAllowAddAllToRight(String allowAddAllToRight)
enable Add All To Right button


getAllowAddToLeft

public String getAllowAddToLeft()

setAllowAddToLeft

public void setAllowAddToLeft(String allowAddToLeft)
enable Add To Left button


getAllowAddToRight

public String getAllowAddToRight()

setAllowAddToRight

public void setAllowAddToRight(String allowAddToRight)
enable Add To Right button


getLeftTitle

public String getLeftTitle()

setLeftTitle

public void setLeftTitle(String leftTitle)
set Left title


getRightTitle

public String getRightTitle()

setRightTitle

public void setRightTitle(String rightTitle)
set Right title


setAllowSelectAll

public void setAllowSelectAll(String allowSelectAll)
enable Select All button


getAllowSelectAll

public String getAllowSelectAll()

setSelectAllLabel

public void setSelectAllLabel(String selectAllLabel)
set Select All button label


getSelectAllLabel

public String getSelectAllLabel()

setButtonCssClass

public void setButtonCssClass(String buttonCssClass)
set buttons css class


getButtonCssClass

public String getButtonCssClass()

setButtonCssStyle

public void setButtonCssStyle(String buttonCssStyle)
set button css style


getButtonCssStyle

public String getButtonCssStyle()

WebWork Project Page