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
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_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 Details

    • allowAddToLeft

      protected String allowAddToLeft

    • allowAddToRight

      protected String allowAddToRight

    • allowAddAllToLeft

      protected String allowAddAllToLeft

    • allowAddAllToRight

      protected String allowAddAllToRight

    • allowSelectAll

      protected String allowSelectAll

    • allowUpDownOnLeft

      protected String allowUpDownOnLeft

    • allowUpDownOnRight

      protected String allowUpDownOnRight

    • 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

    • leftUpLabel

      protected String leftUpLabel

    • leftDownlabel

      protected String leftDownlabel

    • rightUpLabel

      protected String rightUpLabel

    • rightDownLabel

      protected String rightDownLabel

    • addToLeftOnclick

      protected String addToLeftOnclick

    • addToRightOnclick

      protected String addToRightOnclick

    • addAllToLeftOnclick

      protected String addAllToLeftOnclick

    • addAllToRightOnclick

      protected String addAllToRightOnclick

    • selectAllOnclick

      protected String selectAllOnclick

    • upDownOnLeftOnclick

      protected String upDownOnLeftOnclick

    • upDownOnRightOnclick

      protected String upDownOnRightOnclick

  • Constructor Details

    • OptionTransferSelect

      public OptionTransferSelect(ValueStack stack, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)

  • Method Details

    • 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)

    • getAddAllToRightLabel

      public String getAddAllToRightLabel()

    • setAddAllToRightLabel

      public void setAddAllToRightLabel(String addAllToRightLabel)

    • getAddToLeftLabel

      public String getAddToLeftLabel()

    • setAddToLeftLabel

      public void setAddToLeftLabel(String addToLeftLabel)

    • getAddToRightLabel

      public String getAddToRightLabel()

    • setAddToRightLabel

      public void setAddToRightLabel(String addToRightLabel)

    • getAllowAddAllToLeft

      public String getAllowAddAllToLeft()

    • setAllowAddAllToLeft

      public void setAllowAddAllToLeft(String allowAddAllToLeft)

    • getAllowAddAllToRight

      public String getAllowAddAllToRight()

    • setAllowAddAllToRight

      public void setAllowAddAllToRight(String allowAddAllToRight)

    • getAllowAddToLeft

      public String getAllowAddToLeft()

    • setAllowAddToLeft

      public void setAllowAddToLeft(String allowAddToLeft)

    • getAllowAddToRight

      public String getAllowAddToRight()

    • setAllowAddToRight

      public void setAllowAddToRight(String allowAddToRight)

    • getLeftTitle

      public String getLeftTitle()

    • setAllowUpDownOnLeft

      public void setAllowUpDownOnLeft(String allowUpDownOnLeft)

    • getAllowUpDownOnLeft

      public String getAllowUpDownOnLeft()

    • setAllowUpDownOnRight

      public void setAllowUpDownOnRight(String allowUpDownOnRight)

    • getAllowUpDownOnRight

      public String getAllowUpDownOnRight()

    • setLeftTitle

      public void setLeftTitle(String leftTitle)

    • getRightTitle

      public String getRightTitle()

    • setRightTitle

      public void setRightTitle(String rightTitle)

    • setAllowSelectAll

      public void setAllowSelectAll(String allowSelectAll)

    • getAllowSelectAll

      public String getAllowSelectAll()

    • setSelectAllLabel

      public void setSelectAllLabel(String selectAllLabel)

    • getSelectAllLabel

      public String getSelectAllLabel()

    • setButtonCssClass

      public void setButtonCssClass(String buttonCssClass)

    • getButtonCssClass

      public String getButtonCssClass()

    • setButtonCssStyle

      public void setButtonCssStyle(String buttonCssStyle)

    • getButtonCssStyle

      public String getButtonCssStyle()

    • setLeftUpLabel

      public void setLeftUpLabel(String leftUpLabel)

    • getLeftUpLabel

      public String getLeftUpLabel()

    • setLeftDownLabel

      public void setLeftDownLabel(String leftDownLabel)

    • getLeftDownLabel

      public String getLeftDownLabel()

    • setRightUpLabel

      public void setRightUpLabel(String rightUpLabel)

    • getRightUpLabel

      public String getRightUpLabel()

    • setRightDownLabel

      public void setRightDownLabel(String rightDownlabel)

    • getRightDownLabel

      public String getRightDownLabel()

    • getAddAllToLeftOnclick

      public String getAddAllToLeftOnclick()

    • setAddAllToLeftOnclick

      public void setAddAllToLeftOnclick(String addAllToLeftOnclick)

    • getAddAllToRightOnclick

      public String getAddAllToRightOnclick()

    • setAddAllToRightOnclick

      public void setAddAllToRightOnclick(String addAllToRightOnclick)

    • getAddToLeftOnclick

      public String getAddToLeftOnclick()

    • setAddToLeftOnclick

      public void setAddToLeftOnclick(String addToLeftOnclick)

    • getAddToRightOnclick

      public String getAddToRightOnclick()

    • setAddToRightOnclick

      public void setAddToRightOnclick(String addToRightOnclick)

    • setUpDownOnLeftOnclick

      public void setUpDownOnLeftOnclick(String upDownOnLeftOnclick)

    • getUpDownOnLeftOnclick

      public String getUpDownOnLeftOnclick()

    • setUpDownOnRightOnclick

      public void setUpDownOnRightOnclick(String upDownOnRightOnclick)

    • getUpDownOnRightOnclick

      public String getUpDownOnRightOnclick()

    • setSelectAllOnclick

      public void setSelectAllOnclick(String selectAllOnclick)

    • getSelectAllOnclick

      public String getSelectAllOnclick()