Commits

Anonymous committed 2ec9c51
  • Participants
  • Parent commits 3bc1bcd

Comments (0)

Files changed (1)

src/java/com/opensymphony/webwork/components/OptionTransferSelect.java

 import com.opensymphony.xwork.util.OgnlValueStack;
 
 /**
+ * <!-- START SNIPPET: javadoc -->
+ * 
+ * Create a option transfer select component which is basically two &lt;select ...&gt;
+ * tag with buttons in the middle of them allowing options in each of the 
+ * &lt;select ...&gt; to be moved between themselves.
+ * 
+ * <!-- END SNIPPET: javadoc -->
+ * 
+ * <p/>
+ * 
+ * <pre>
+ * <!-- START SNIPPET: example -->
+ * 
+ * &lt;-- minimum configuration --&gt;
+ * &lt;ww:optiontransferselect 
+ *   	label="Favourite Cartoons Characters"
+ *		name="leftSideCartoonCharacters" 
+ *		list="{'Popeye', 'He-Man', 'Spiderman'}" 
+ *		doubleName="rightSideCartoonCharacters"
+ *		doubleList="{'Superman', 'Mickey Mouse', 'Donald Duck'}" 
+ *	/&gt;
+ *
+ *  &lt;-- possible configuration --&gt;
+ *  &lt;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"
+ *	/&gt;
+ * 
+ * <!-- END SNIPPET: example -->
+ * </pre>
+ * 
  * 
  * @author tm_jee
  * @version $Date$ $Id$