<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
<!-- saved from url=(0014)about:internet --> | |
<HTML> | |
<HEAD> | |
<!-- Generated by javadoc (build 1.5.0_19) on Sun Mar 20 20:56:36 PKT 2011 --> | |
<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
<TITLE> | |
CheckList (Click Extras API - v2.3.0) | |
</TITLE> | |
<META NAME="keywords" CONTENT="org.apache.click.extras.control.CheckList class"> | |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
<SCRIPT type="text/javascript"> | |
function windowTitle() | |
{ | |
parent.document.title="CheckList (Click Extras API - v2.3.0)"; | |
} | |
</SCRIPT> | |
<NOSCRIPT> | |
</NOSCRIPT> | |
</HEAD> | |
<BODY BGCOLOR="white"> | |
<!-- ========= START OF TOP NAVBAR ======= --> | |
<A NAME="navbar_top"><!-- --></A> | |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_top_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../org/apache/click/extras/control/AutoCompleteTextField.html" title="class in org.apache.click.extras.control"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../org/apache/click/extras/control/ColorPicker.html" title="class in org.apache.click.extras.control"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/click/extras/control/CheckList.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="CheckList.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_top"></A> | |
<!-- ========= END OF TOP NAVBAR ========= --> | |
<HR> | |
<!-- ======== START OF CLASS DATA ======== --> | |
<H2> | |
<FONT SIZE="-1"> | |
org.apache.click.extras.control</FONT> | |
<BR> | |
Class CheckList</H2> | |
<PRE> | |
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html" title="class or interface in org.apache.click.control">org.apache.click.control.AbstractControl</A> | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html" title="class or interface in org.apache.click.control">org.apache.click.control.Field</A> | |
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.click.extras.control.CheckList</B> | |
</PRE> | |
<DL> | |
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/Control.html" title="class or interface in org.apache.click">Control</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/Stateful.html" title="class or interface in org.apache.click">Stateful</A></DD> | |
</DL> | |
<HR> | |
<DL> | |
<DT><PRE>public class <B>CheckList</B><DT>extends <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html" title="class or interface in org.apache.click.control">Field</A></DL> | |
</PRE> | |
<P> | |
Provides a check list control. This is an implementation of the Checklist | |
from <a href="http://c82.net/article.php?ID=25">Check it don't select it</a> | |
<p/> | |
A check list is a more user friendly substitution for | |
multiple-select-boxes. It is a scrollable div which has many select-boxes. | |
<h3><a name="checklist-example"></a>CheckList Examples</h3> | |
<pre class="prettyprint"> | |
public class MyPage extends Page { | |
public void onInit() { | |
CheckList checkList = new ChecList("languages"); | |
checkList.add(new Option("001", "Java")); | |
checkList.add(new Option("002", "Ruby")); | |
checkList.add(new Option("003", "Perl")); | |
// Set the Java as a selected option | |
checkList.addSelectedValue("001"); | |
} | |
} </pre> | |
Unless you use a <a href="#dataprovider">DataProvider</a>, remember to always | |
populate the CheckList option list before it is processed. Do not populate the | |
option list in a Page's onRender() method. | |
<h3><a name="dataprovider"></a>DataProvider</h3> | |
A common issue new Click users face is which page event (onInit or onRender) | |
to populate the CheckList <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getOptionList()"><CODE>optionList</CODE></A> in. To alleviate | |
this problem you can set a | |
<A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setDataProvider(org.apache.click.dataprovider.DataProvider)"><CODE>dataProvider</CODE></A> | |
which allows the CheckList to fetch data when needed. This is | |
particularly useful if retrieving CheckList data is expensive e.g. loading | |
from a database. | |
<p/> | |
Below is a simple example: | |
<pre class="prettyprint"> | |
public class LanguagePage extends Page { | |
public Form form = new Form(); | |
private Select languageCheckList = new CheckList("languages"); | |
public LanguagePage() { | |
// Set a DataProvider which "getData" method will be called to | |
// populate the optionList. The "getData" method is only called when | |
// the optionList data is needed | |
languageCheckList.setDataProvider(new DataProvider() { | |
public List getData() { | |
List options = new ArrayList(); | |
options.add(new Option("001", "Java")); | |
options.add(new Option("002", "Ruby")); | |
options.add(new Option("003", "Perl")); | |
return options; | |
} | |
}); | |
form.add(languageCheckList); | |
form.add(new Submit("ok", " OK ")); | |
} | |
} </pre> | |
CheckList also supports a scrollable mode. To make the CheckList scrollable, | |
set the height of the CheckList through <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setHeight(java.lang.String)"><CODE>setHeight(String)</CODE></A>. | |
<p/> | |
<b>Note</b> when setting the height it is recommended that the CheckList | |
should not be sortable, because of browser incompatibilities. | |
<p/> | |
The CheckList is also sortable by drag-drop if the | |
<A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setSortable(boolean)"><CODE>setSortable(boolean)</CODE></A> property is set to true. In this case the | |
method <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getSortorder()"><CODE>getSortorder()</CODE></A> returns the keys of all the options whether | |
they where selected or not in the order provided by the user. | |
<p/> | |
Sortable is provided by scriptaculous which is only supported on IE6, FF and | |
Safari1.2 and higher. This control is only tested on IE6 and FF on Windows. | |
With IE the text of the dragged element has a black-outline which does not | |
look good. To turn this off define an explicit back-ground color for the | |
<li> elements. Typically you will do this in a style: .listClass li | |
{background-color: #xxx}, where the listClass is set through | |
<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#addStyleClass(java.lang.String)" title="class or interface in org.apache.click.control"><CODE>AbstractControl.addStyleClass(String)</CODE></A>. | |
<p/> | |
If a select is required at least one item must be | |
selected so that the input is valid. Other validations are not done. | |
<p/> | |
The Control listener will be invoked in any case whether the CheckList is valid or not. | |
<p/> | |
The values of the CheckList are provided by | |
<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control"><CODE>Option</CODE></A> instances. To populate the CheckList with | |
Options, use the add methods. | |
<p/> | |
The label of the Option is shown to the user and the value is what is | |
provided in the <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getSelectedValues()"><CODE>getSelectedValues()</CODE></A> and <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getSortorder()"><CODE>getSortorder()</CODE></A> | |
Lists. | |
<p/> | |
The selected values can be retrieved from <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getSelectedValues()"><CODE>getSelectedValues()</CODE></A>. The | |
get/setValue() property is not supported. | |
<p/> | |
The select uses the /click/checklist/checklist.css style. By providing a style which | |
extends this style the appearance of the list can be changed. | |
<p/> | |
To set the additional style class use <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#addStyleClass(java.lang.String)" title="class or interface in org.apache.click.control"><CODE>AbstractControl.addStyleClass(String)</CODE></A>. | |
This will append the given class to the default class of this control. | |
Alternatively <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#setStyle(java.lang.String, java.lang.String)" title="class or interface in org.apache.click.control"><CODE>AbstractControl.setStyle(String, String)</CODE></A> can be used to set the style | |
of the outer div. | |
<p/> | |
For an example please look at the click-examples and the at the above blog. | |
<a name="resources"></a> | |
<h3>CSS and JavaScript resources</h3> | |
The CheckList control makes use of the following resources | |
(which Click automatically deploys to the application directories, | |
<tt>/click/checklist</tt> and <tt>/click/prototype</tt>): | |
<ul> | |
<li><tt>click/checklist/checklist.css</tt></li> | |
<li><tt>click/checklist/checklist.js</tt></li> | |
<li><tt>click/prototype/builder.js</tt></li> | |
<li><tt>click/prototype/controls.js</tt></li> | |
<li><tt>click/prototype/dragdrop.js</tt></li> | |
<li><tt>click/prototype/effects.js</tt></li> | |
<li><tt>click/prototype/prototype.js</tt></li> | |
<li><tt>click/prototype/slider.js</tt></li> | |
</ul> | |
To import these CheckList files simply reference the variables | |
<span class="blue">$headElements</span> and | |
<span class="blue">$jsElements</span> in the page template. | |
<P> | |
<P> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control"><CODE>Option</CODE></A>, | |
<A HREF="../../../../../serialized-form.html#org.apache.click.extras.control.CheckList">Serialized Form</A></DL> | |
<HR> | |
<P> | |
<!-- =========== FIELD SUMMARY =========== --> | |
<A NAME="field_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Field Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://click.apache.org/docs/click-api/org/apache/click/dataprovider/DataProvider.html" title="class or interface in org.apache.click.dataprovider">DataProvider</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#dataProvider">dataProvider</A></B></CODE> | |
<BR> | |
The select data provider.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#height">height</A></B></CODE> | |
<BR> | |
The height if null not scrollable.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#optionList">optionList</A></B></CODE> | |
<BR> | |
The Select Option list.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#selectedValues">selectedValues</A></B></CODE> | |
<BR> | |
The selected values.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#sortable">sortable</A></B></CODE> | |
<BR> | |
If sortable by drag and drop.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#sortorder">sortorder</A></B></CODE> | |
<BR> | |
The key of the values in the order they are present (only set when | |
sortable).</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#STYLE_CLASS">STYLE_CLASS</A></B></CODE> | |
<BR> | |
The style class which is always set on this element (checkList).</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected static <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#VALIDATE_CHECKLIST_FUNCTION">VALIDATE_CHECKLIST_FUNCTION</A></B></CODE> | |
<BR> | |
The field validation JavaScript function template.</TD> | |
</TR> | |
</TABLE> | |
<A NAME="fields_inherited_from_class_org.apache.click.control.Field"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Fields inherited from class org.apache.click.control.<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html" title="class or interface in org.apache.click.control">Field</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#disabled" title="class or interface in org.apache.click.control">disabled</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#error" title="class or interface in org.apache.click.control">error</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#focus" title="class or interface in org.apache.click.control">focus</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#form" title="class or interface in org.apache.click.control">form</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#help" title="class or interface in org.apache.click.control">help</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#label" title="class or interface in org.apache.click.control">label</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#labelStyle" title="class or interface in org.apache.click.control">labelStyle</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#labelStyleClass" title="class or interface in org.apache.click.control">labelStyleClass</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#parentStyleClassHint" title="class or interface in org.apache.click.control">parentStyleClassHint</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#parentStyleHint" title="class or interface in org.apache.click.control">parentStyleHint</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#readonly" title="class or interface in org.apache.click.control">readonly</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#required" title="class or interface in org.apache.click.control">required</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#tabindex" title="class or interface in org.apache.click.control">tabindex</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#title" title="class or interface in org.apache.click.control">title</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#trim" title="class or interface in org.apache.click.control">trim</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#validate" title="class or interface in org.apache.click.control">validate</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#value" title="class or interface in org.apache.click.control">value</A></CODE></TD> | |
</TR> | |
</TABLE> | |
<A NAME="fields_inherited_from_class_org.apache.click.control.AbstractControl"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Fields inherited from class org.apache.click.control.<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html" title="class or interface in org.apache.click.control">AbstractControl</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#actionListener" title="class or interface in org.apache.click.control">actionListener</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#attributes" title="class or interface in org.apache.click.control">attributes</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#behaviors" title="class or interface in org.apache.click.control">behaviors</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#headElements" title="class or interface in org.apache.click.control">headElements</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#listener" title="class or interface in org.apache.click.control">listener</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#listenerMethod" title="class or interface in org.apache.click.control">listenerMethod</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#messages" title="class or interface in org.apache.click.control">messages</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#name" title="class or interface in org.apache.click.control">name</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#parent" title="class or interface in org.apache.click.control">parent</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#styles" title="class or interface in org.apache.click.control">styles</A></CODE></TD> | |
</TR> | |
</TABLE> | |
<A NAME="fields_inherited_from_class_org.apache.click.Control"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Fields inherited from interface org.apache.click.<A HREF="http://click.apache.org/docs/click-api/org/apache/click/Control.html" title="class or interface in org.apache.click">Control</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/Control.html#CONTROL_MESSAGES" title="class or interface in org.apache.click">CONTROL_MESSAGES</A></CODE></TD> | |
</TR> | |
</TABLE> | |
| |
<!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
<A NAME="constructor_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Constructor Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#CheckList()">CheckList</A></B>()</CODE> | |
<BR> | |
Create a CheckList field with no name defined.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#CheckList(java.lang.String)">CheckList</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</CODE> | |
<BR> | |
Create a CheckList field with the given name.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#CheckList(java.lang.String, boolean)">CheckList</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, | |
boolean required)</CODE> | |
<BR> | |
Create a CheckList field with the given name and required status.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#CheckList(java.lang.String, java.lang.String)">CheckList</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, | |
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> label)</CODE> | |
<BR> | |
Create a CheckList field with the given name and label.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#CheckList(java.lang.String, java.lang.String, boolean)">CheckList</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, | |
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> label, | |
boolean required)</CODE> | |
<BR> | |
Create a CheckList field with the given name, label and required status.</TD> | |
</TR> | |
</TABLE> | |
| |
<!-- ========== METHOD SUMMARY =========== --> | |
<A NAME="method_summary"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
<B>Method Summary</B></FONT></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#add(java.lang.Object)">add</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> option)</CODE> | |
<BR> | |
Add the given Option/String/Number/Boolean to the CheckList.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#add(org.apache.click.control.Option)">add</A></B>(<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A> option)</CODE> | |
<BR> | |
Add the given Option.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#add(java.lang.String)">add</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value)</CODE> | |
<BR> | |
Add the given option value.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#addAll(java.util.Collection)">addAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A><?> options)</CODE> | |
<BR> | |
Add the given Option/String/Number/Boolean collection to the CheckList.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#addAll(java.util.Collection, java.lang.String, java.lang.String)">addAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A><?> objects, | |
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> optionValueProperty, | |
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> optionLabelProperty)</CODE> | |
<BR> | |
Add the given collection of objects to the CheckList, creating new Option | |
instances based on the object properties specified by optionValueProperty | |
and optionLabelProperty.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#addAll(java.util.Map)">addAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A><?,?> options)</CODE> | |
<BR> | |
Add the given Map of option values and labels to the CheckList.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#addAll(java.lang.String[])">addAll</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] options)</CODE> | |
<BR> | |
Add the given array of string options to the Select option list.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#addStyle(java.lang.String)">addStyle</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> style)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>use @{link #setStyle(String, String)}</I></TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#bindRequestValue()">bindRequestValue</A></B>()</CODE> | |
<BR> | |
Bind the request submission, setting the <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#selectedValues"><CODE>selectedValues</CODE></A> and | |
sort order if the checkList is sortable.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> int</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getControlSizeEst()">getControlSizeEst</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://click.apache.org/docs/click-api/org/apache/click/dataprovider/DataProvider.html" title="class or interface in org.apache.click.dataprovider">DataProvider</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getDataProvider()">getDataProvider</A></B>()</CODE> | |
<BR> | |
Return the CheckList optionList DataProvider.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getFocusJavaScript()">getFocusJavaScript</A></B>()</CODE> | |
<BR> | |
Return the Field focus JavaScript.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/element/Element.html" title="class or interface in org.apache.click.element">Element</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getHeadElements()">getHeadElements</A></B>()</CODE> | |
<BR> | |
Return the CheckList HEAD elements to be included in the page.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getHeight()">getHeight</A></B>()</CODE> | |
<BR> | |
The css-height attribute.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getHtmlClass()">getHtmlClass</A></B>()</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>use <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getAttribute(java.lang.String)" title="class or interface in org.apache.click.control"><CODE>AbstractControl.getAttribute(String)</CODE></A> instead</I></TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getOptionList()">getOptionList</A></B>()</CODE> | |
<BR> | |
Return the Option list.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getSelectedValues()">getSelectedValues</A></B>()</CODE> | |
<BR> | |
Return the list of selected values as a <tt>List</tt> of Strings.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getSortorder()">getSortorder</A></B>()</CODE> | |
<BR> | |
A list of the values transmitted in the order they are present in the | |
list.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getTag()">getTag</A></B>()</CODE> | |
<BR> | |
</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getValidationJavaScript()">getValidationJavaScript</A></B>()</CODE> | |
<BR> | |
Return the CheckList JavaScript client side validation function.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getValueObject()">getValueObject</A></B>()</CODE> | |
<BR> | |
This method delegates to <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getSelectedValues()"><CODE>getSelectedValues()</CODE></A> to return the | |
selected values as a <tt>java.util.List</tt> of Strings.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>></CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getValues()">getValues</A></B>()</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>use <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getSelectedValues()"><CODE>getSelectedValues()</CODE></A> instead</I></TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#isSortable()">isSortable</A></B>()</CODE> | |
<BR> | |
Whether the list is also sortable.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> boolean</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#onProcess()">onProcess</A></B>()</CODE> | |
<BR> | |
Process the request Context setting the CheckList selectedValues if | |
selected and invoking the control's listener if defined.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#render(org.apache.click.util.HtmlStringBuffer)">render</A></B>(<A HREF="http://click.apache.org/docs/click-api/org/apache/click/util/HtmlStringBuffer.html" title="class or interface in org.apache.click.util">HtmlStringBuffer</A> buffer)</CODE> | |
<BR> | |
Render the HTML representation of the CheckList.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setDataProvider(org.apache.click.dataprovider.DataProvider)">setDataProvider</A></B>(<A HREF="http://click.apache.org/docs/click-api/org/apache/click/dataprovider/DataProvider.html" title="class or interface in org.apache.click.dataprovider">DataProvider</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A>> dataProvider)</CODE> | |
<BR> | |
Set the CheckList option list DataProvider.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setHeight(java.lang.String)">setHeight</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> height)</CODE> | |
<BR> | |
The css height attribute-value.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setHtmlClass(java.lang.String)">setHtmlClass</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> clazz)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>use <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#addStyleClass(java.lang.String)" title="class or interface in org.apache.click.control"><CODE>AbstractControl.addStyleClass(String)</CODE></A> instead</I></TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setOptionList(java.util.List)">setOptionList</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A>> options)</CODE> | |
<BR> | |
Set the Option list.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setSelectedValues(java.util.List)">setSelectedValues</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> selectedValues)</CODE> | |
<BR> | |
Set the list of selected values.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setSortable(boolean)">setSortable</A></B>(boolean sortable)</CODE> | |
<BR> | |
Whether the list should be drag-drop sortable.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setValueObject(java.lang.Object)">setValueObject</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> object)</CODE> | |
<BR> | |
This method delegates to <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setSelectedValues(java.util.List)"><CODE>setSelectedValues(java.util.List)</CODE></A> | |
to set the selected values of the CheckList.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setValues(java.util.List)">setValues</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> values)</CODE> | |
<BR> | |
<B>Deprecated.</B> <I>use <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setSelectedValues(java.util.List)"><CODE>setSelectedValues(List)</CODE></A> instead</I></TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE>protected void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#sortOptions(java.lang.String[])">sortOptions</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] order)</CODE> | |
<BR> | |
Sorts the current Options List.</TD> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
<CODE> void</CODE></FONT></TD> | |
<TD><CODE><B><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#validate()">validate</A></B>()</CODE> | |
<BR> | |
Validate the CheckList request submission.</TD> | |
</TR> | |
</TABLE> | |
<A NAME="methods_inherited_from_class_org.apache.click.control.Field"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Methods inherited from class org.apache.click.control.<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html" title="class or interface in org.apache.click.control">Field</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getError()" title="class or interface in org.apache.click.control">getError</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getErrorLabel()" title="class or interface in org.apache.click.control">getErrorLabel</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getFocus()" title="class or interface in org.apache.click.control">getFocus</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getForm()" title="class or interface in org.apache.click.control">getForm</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getHelp()" title="class or interface in org.apache.click.control">getHelp</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getId()" title="class or interface in org.apache.click.control">getId</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getLabel()" title="class or interface in org.apache.click.control">getLabel</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getLabelStyle()" title="class or interface in org.apache.click.control">getLabelStyle</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getLabelStyleClass()" title="class or interface in org.apache.click.control">getLabelStyleClass</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getParentStyleClassHint()" title="class or interface in org.apache.click.control">getParentStyleClassHint</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getParentStyleHint()" title="class or interface in org.apache.click.control">getParentStyleHint</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getRequestValue()" title="class or interface in org.apache.click.control">getRequestValue</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getState()" title="class or interface in org.apache.click.control">getState</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getTabIndex()" title="class or interface in org.apache.click.control">getTabIndex</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getTextAlign()" title="class or interface in org.apache.click.control">getTextAlign</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getTitle()" title="class or interface in org.apache.click.control">getTitle</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getValidate()" title="class or interface in org.apache.click.control">getValidate</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getValue()" title="class or interface in org.apache.click.control">getValue</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getWidth()" title="class or interface in org.apache.click.control">getWidth</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#isDisabled()" title="class or interface in org.apache.click.control">isDisabled</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#isHidden()" title="class or interface in org.apache.click.control">isHidden</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#isReadonly()" title="class or interface in org.apache.click.control">isReadonly</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#isRequired()" title="class or interface in org.apache.click.control">isRequired</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#isTrim()" title="class or interface in org.apache.click.control">isTrim</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#isValid()" title="class or interface in org.apache.click.control">isValid</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#removeState(org.apache.click.Context)" title="class or interface in org.apache.click.control">removeState</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#renderTagBegin(java.lang.String, org.apache.click.util.HtmlStringBuffer)" title="class or interface in org.apache.click.control">renderTagBegin</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#restoreState(org.apache.click.Context)" title="class or interface in org.apache.click.control">restoreState</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#saveState(org.apache.click.Context)" title="class or interface in org.apache.click.control">saveState</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setDisabled(boolean)" title="class or interface in org.apache.click.control">setDisabled</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setError(java.lang.String)" title="class or interface in org.apache.click.control">setError</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setErrorMessage(java.lang.String)" title="class or interface in org.apache.click.control">setErrorMessage</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setErrorMessage(java.lang.String, T)" title="class or interface in org.apache.click.control">setErrorMessage</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setFocus(boolean)" title="class or interface in org.apache.click.control">setFocus</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setForm(org.apache.click.control.Form)" title="class or interface in org.apache.click.control">setForm</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setHelp(java.lang.String)" title="class or interface in org.apache.click.control">setHelp</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setLabel(java.lang.String)" title="class or interface in org.apache.click.control">setLabel</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setLabelStyle(java.lang.String)" title="class or interface in org.apache.click.control">setLabelStyle</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setLabelStyleClass(java.lang.String)" title="class or interface in org.apache.click.control">setLabelStyleClass</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setListener(java.lang.Object, java.lang.String)" title="class or interface in org.apache.click.control">setListener</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setParent(java.lang.Object)" title="class or interface in org.apache.click.control">setParent</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setParentStyleClassHint(java.lang.String)" title="class or interface in org.apache.click.control">setParentStyleClassHint</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setParentStyleHint(java.lang.String)" title="class or interface in org.apache.click.control">setParentStyleHint</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setReadonly(boolean)" title="class or interface in org.apache.click.control">setReadonly</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setRequired(boolean)" title="class or interface in org.apache.click.control">setRequired</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setState(java.lang.Object)" title="class or interface in org.apache.click.control">setState</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setTabIndex(int)" title="class or interface in org.apache.click.control">setTabIndex</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setTextAlign(java.lang.String)" title="class or interface in org.apache.click.control">setTextAlign</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setTitle(java.lang.String)" title="class or interface in org.apache.click.control">setTitle</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setTrim(boolean)" title="class or interface in org.apache.click.control">setTrim</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setValidate(boolean)" title="class or interface in org.apache.click.control">setValidate</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setValue(java.lang.String)" title="class or interface in org.apache.click.control">setValue</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setWidth(java.lang.String)" title="class or interface in org.apache.click.control">setWidth</A></CODE></TD> | |
</TR> | |
</TABLE> | |
<A NAME="methods_inherited_from_class_org.apache.click.control.AbstractControl"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Methods inherited from class org.apache.click.control.<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html" title="class or interface in org.apache.click.control">AbstractControl</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#addBehavior(org.apache.click.Behavior)" title="class or interface in org.apache.click.control">addBehavior</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#addStyleClass(java.lang.String)" title="class or interface in org.apache.click.control">addStyleClass</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#appendAttributes(org.apache.click.util.HtmlStringBuffer)" title="class or interface in org.apache.click.control">appendAttributes</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#dispatchActionEvent()" title="class or interface in org.apache.click.control">dispatchActionEvent</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getActionListener()" title="class or interface in org.apache.click.control">getActionListener</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getAttribute(java.lang.String)" title="class or interface in org.apache.click.control">getAttribute</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getAttributes()" title="class or interface in org.apache.click.control">getAttributes</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getBehaviors()" title="class or interface in org.apache.click.control">getBehaviors</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getContext()" title="class or interface in org.apache.click.control">getContext</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getHtmlImports()" title="class or interface in org.apache.click.control">getHtmlImports</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getMessage(java.lang.String)" title="class or interface in org.apache.click.control">getMessage</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getMessage(java.lang.String, java.lang.Object...)" title="class or interface in org.apache.click.control">getMessage</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getMessages()" title="class or interface in org.apache.click.control">getMessages</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getName()" title="class or interface in org.apache.click.control">getName</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getPage()" title="class or interface in org.apache.click.control">getPage</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getParent()" title="class or interface in org.apache.click.control">getParent</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getStyle(java.lang.String)" title="class or interface in org.apache.click.control">getStyle</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getStyles()" title="class or interface in org.apache.click.control">getStyles</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#hasAttribute(java.lang.String)" title="class or interface in org.apache.click.control">hasAttribute</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#hasAttributes()" title="class or interface in org.apache.click.control">hasAttributes</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#hasBehaviors()" title="class or interface in org.apache.click.control">hasBehaviors</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#hasStyles()" title="class or interface in org.apache.click.control">hasStyles</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#isAjaxTarget(org.apache.click.Context)" title="class or interface in org.apache.click.control">isAjaxTarget</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#onDeploy(javax.servlet.ServletContext)" title="class or interface in org.apache.click.control">onDeploy</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#onDestroy()" title="class or interface in org.apache.click.control">onDestroy</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#onInit()" title="class or interface in org.apache.click.control">onInit</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#onRender()" title="class or interface in org.apache.click.control">onRender</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#removeBehavior(org.apache.click.Behavior)" title="class or interface in org.apache.click.control">removeBehavior</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#removeStyleClass(java.lang.String)" title="class or interface in org.apache.click.control">removeStyleClass</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#renderTagEnd(java.lang.String, org.apache.click.util.HtmlStringBuffer)" title="class or interface in org.apache.click.control">renderTagEnd</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#setActionListener(org.apache.click.ActionListener)" title="class or interface in org.apache.click.control">setActionListener</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#setAttribute(java.lang.String, java.lang.String)" title="class or interface in org.apache.click.control">setAttribute</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#setId(java.lang.String)" title="class or interface in org.apache.click.control">setId</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#setName(java.lang.String)" title="class or interface in org.apache.click.control">setName</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#setStyle(java.lang.String, java.lang.String)" title="class or interface in org.apache.click.control">setStyle</A>, <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#toString()" title="class or interface in org.apache.click.control">toString</A></CODE></TD> | |
</TR> | |
</TABLE> | |
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> | |
</TR> | |
<TR BGCOLOR="white" CLASS="TableRowColor"> | |
<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> | |
</TR> | |
</TABLE> | |
| |
<P> | |
<!-- ============ FIELD DETAIL =========== --> | |
<A NAME="field_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Field Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="STYLE_CLASS"><!-- --></A><H3> | |
STYLE_CLASS</H3> | |
<PRE> | |
protected static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>STYLE_CLASS</B></PRE> | |
<DL> | |
<DD>The style class which is always set on this element (checkList). | |
<P> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.click.extras.control.CheckList.STYLE_CLASS">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="VALIDATE_CHECKLIST_FUNCTION"><!-- --></A><H3> | |
VALIDATE_CHECKLIST_FUNCTION</H3> | |
<PRE> | |
protected static final <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>VALIDATE_CHECKLIST_FUNCTION</B></PRE> | |
<DL> | |
<DD>The field validation JavaScript function template. | |
The function template arguments are: <ul> | |
<li>0 - is the field id</li> | |
<li>1 - is the name of the checkbox</li> | |
<li>2 - is the id of the form</li> | |
<li>3 - is the Field required status</li> | |
<li>4 - is the localized error message for required validation</li> | |
</ul> | |
<P> | |
<DL> | |
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.click.extras.control.CheckList.VALIDATE_CHECKLIST_FUNCTION">Constant Field Values</A></DL> | |
</DL> | |
<HR> | |
<A NAME="dataProvider"><!-- --></A><H3> | |
dataProvider</H3> | |
<PRE> | |
protected <A HREF="http://click.apache.org/docs/click-api/org/apache/click/dataprovider/DataProvider.html" title="class or interface in org.apache.click.dataprovider">DataProvider</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A>> <B>dataProvider</B></PRE> | |
<DL> | |
<DD>The select data provider. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="height"><!-- --></A><H3> | |
height</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>height</B></PRE> | |
<DL> | |
<DD>The height if null not scrollable. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="optionList"><!-- --></A><H3> | |
optionList</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A>> <B>optionList</B></PRE> | |
<DL> | |
<DD>The Select Option list. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="sortable"><!-- --></A><H3> | |
sortable</H3> | |
<PRE> | |
protected boolean <B>sortable</B></PRE> | |
<DL> | |
<DD>If sortable by drag and drop. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="sortorder"><!-- --></A><H3> | |
sortorder</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> <B>sortorder</B></PRE> | |
<DL> | |
<DD>The key of the values in the order they are present (only set when | |
sortable). | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<HR> | |
<A NAME="selectedValues"><!-- --></A><H3> | |
selectedValues</H3> | |
<PRE> | |
protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> <B>selectedValues</B></PRE> | |
<DL> | |
<DD>The selected values. | |
<P> | |
<DL> | |
</DL> | |
</DL> | |
<!-- ========= CONSTRUCTOR DETAIL ======== --> | |
<A NAME="constructor_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Constructor Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="CheckList(java.lang.String)"><!-- --></A><H3> | |
CheckList</H3> | |
<PRE> | |
public <B>CheckList</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name)</PRE> | |
<DL> | |
<DD>Create a CheckList field with the given name. | |
<P> | |
<DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the field</DL> | |
</DL> | |
<HR> | |
<A NAME="CheckList(java.lang.String, java.lang.String)"><!-- --></A><H3> | |
CheckList</H3> | |
<PRE> | |
public <B>CheckList</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, | |
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> label)</PRE> | |
<DL> | |
<DD>Create a CheckList field with the given name and label. | |
<P> | |
<DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the field<DD><CODE>label</CODE> - the label of the field</DL> | |
</DL> | |
<HR> | |
<A NAME="CheckList(java.lang.String, boolean)"><!-- --></A><H3> | |
CheckList</H3> | |
<PRE> | |
public <B>CheckList</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, | |
boolean required)</PRE> | |
<DL> | |
<DD>Create a CheckList field with the given name and required status. | |
<P> | |
<DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the field<DD><CODE>required</CODE> - the field required status</DL> | |
</DL> | |
<HR> | |
<A NAME="CheckList(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3> | |
CheckList</H3> | |
<PRE> | |
public <B>CheckList</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> name, | |
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> label, | |
boolean required)</PRE> | |
<DL> | |
<DD>Create a CheckList field with the given name, label and required status. | |
<P> | |
<DL> | |
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the field<DD><CODE>label</CODE> - the label of the field<DD><CODE>required</CODE> - the field required status</DL> | |
</DL> | |
<HR> | |
<A NAME="CheckList()"><!-- --></A><H3> | |
CheckList</H3> | |
<PRE> | |
public <B>CheckList</B>()</PRE> | |
<DL> | |
<DD>Create a CheckList field with no name defined. | |
<p/> | |
<b>Please note</b> the control's name must be defined before it is valid. | |
<P> | |
</DL> | |
<!-- ============ METHOD DETAIL ========== --> | |
<A NAME="method_detail"><!-- --></A> | |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
<B>Method Detail</B></FONT></TH> | |
</TR> | |
</TABLE> | |
<A NAME="getTag()"><!-- --></A><H3> | |
getTag</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getTag</B>()</PRE> | |
<DL> | |
<DD><DL> | |
<DT><B>Overrides:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getTag()" title="class or interface in org.apache.click.control">getTag</A></CODE> in class <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html" title="class or interface in org.apache.click.control">AbstractControl</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>this controls html tag<DT><B>See Also:</B><DD><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getTag()" title="class or interface in org.apache.click.control"><CODE>AbstractControl.getTag()</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="add(org.apache.click.control.Option)"><!-- --></A><H3> | |
add</H3> | |
<PRE> | |
public void <B>add</B>(<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A> option)</PRE> | |
<DL> | |
<DD>Add the given Option. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>option</CODE> - the Option value to add | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if option is null</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="add(java.lang.String)"><!-- --></A><H3> | |
add</H3> | |
<PRE> | |
public void <B>add</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> value)</PRE> | |
<DL> | |
<DD>Add the given option value. This convenience method will create a new | |
<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control"><CODE>Option</CODE></A> with the given value and add it to the CheckList. The new | |
Option display label will be the same as its value. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>value</CODE> - the option value to add | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the value is null</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="add(java.lang.Object)"><!-- --></A><H3> | |
add</H3> | |
<PRE> | |
public void <B>add</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> option)</PRE> | |
<DL> | |
<DD>Add the given Option/String/Number/Boolean to the CheckList. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>option</CODE> - one of either Option/String/Number/Boolean to add | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if option is null, or the option | |
is an unsupported class</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="addAll(java.util.Collection)"><!-- --></A><H3> | |
addAll</H3> | |
<PRE> | |
public void <B>addAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A><?> options)</PRE> | |
<DL> | |
<DD>Add the given Option/String/Number/Boolean collection to the CheckList. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>options</CODE> - the collection of Option/String/Number/Boolean | |
objects to add | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if options is null, or the collection | |
contains an unsupported class</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="addAll(java.util.Map)"><!-- --></A><H3> | |
addAll</H3> | |
<PRE> | |
public void <B>addAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A><?,?> options)</PRE> | |
<DL> | |
<DD>Add the given Map of option values and labels to the CheckList. The Map | |
entry key will be used as the option value and the Map entry value will | |
be used as the option label. | |
<p/> | |
It is recommended that <tt>LinkedHashMap</tt> is used as the Map | |
parameter to maintain the order of the option vales. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>options</CODE> - the Map of option values and labels to add | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if options is null</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="addAll(java.lang.String[])"><!-- --></A><H3> | |
addAll</H3> | |
<PRE> | |
public void <B>addAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] options)</PRE> | |
<DL> | |
<DD>Add the given array of string options to the Select option list. <p/> The | |
options array string value will be used for the <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html#value" title="class or interface in org.apache.click.control"><CODE>Option.value</CODE></A> and | |
<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html#label" title="class or interface in org.apache.click.control"><CODE>Option.label</CODE></A>. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>options</CODE> - the array of option values to add | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if options is null</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="addAll(java.util.Collection, java.lang.String, java.lang.String)"><!-- --></A><H3> | |
addAll</H3> | |
<PRE> | |
public void <B>addAll</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A><?> objects, | |
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> optionValueProperty, | |
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> optionLabelProperty)</PRE> | |
<DL> | |
<DD>Add the given collection of objects to the CheckList, creating new Option | |
instances based on the object properties specified by optionValueProperty | |
and optionLabelProperty. | |
<pre class="prettyprint"> | |
CheckList list = new CheckList("type", "Type:"); | |
list.addAll(getCustomerService().getCustomerTypes(), "id", "name"); | |
form.add(select); </pre> | |
For example given the Collection of CustomerType <tt>objects</tt>, | |
<tt>optionValueProperty</tt> "id" and <tt>optionLabelProperty</tt> "name", | |
the <tt>id</tt> and <tt>name</tt> properties of each CustomerType will be | |
retrieved. For each CustomerType in the Collection a new | |
<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control"><CODE>Option</CODE></A> instance is created and its | |
<tt>value</tt> and <tt>label</tt> is set to the <tt>id</tt> and | |
<tt>name</tt> retrieved from the CustomerType instance. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>objects</CODE> - the collection of objects to render as options<DD><CODE>optionValueProperty</CODE> - the name of the object property to render as | |
the Option value<DD><CODE>optionLabelProperty</CODE> - the name of the object property to render as | |
the Option label | |
<DT><B>Throws:</B> | |
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if objects or optionValueProperty | |
parameter is null</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getDataProvider()"><!-- --></A><H3> | |
getDataProvider</H3> | |
<PRE> | |
public <A HREF="http://click.apache.org/docs/click-api/org/apache/click/dataprovider/DataProvider.html" title="class or interface in org.apache.click.dataprovider">DataProvider</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A>> <B>getDataProvider</B>()</PRE> | |
<DL> | |
<DD>Return the CheckList optionList DataProvider. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the CheckList optionList DataProvider</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setDataProvider(org.apache.click.dataprovider.DataProvider)"><!-- --></A><H3> | |
setDataProvider</H3> | |
<PRE> | |
public void <B>setDataProvider</B>(<A HREF="http://click.apache.org/docs/click-api/org/apache/click/dataprovider/DataProvider.html" title="class or interface in org.apache.click.dataprovider">DataProvider</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A>> dataProvider)</PRE> | |
<DL> | |
<DD>Set the CheckList option list DataProvider. The dataProvider must return | |
a list containing Option values. | |
<p/> | |
Example usage: | |
<pre class="prettyprint"> | |
CheckList checkList = new CheckList("languages"); | |
select.setDataProvider(new DataProvider() { | |
public List getData() { | |
List options = new ArrayList(); | |
options.add(new Option("001", "Java")); | |
options.add(new Option("002", "Ruby")); | |
options.add(new Option("003", "Perl")); | |
return options; | |
} | |
}); </pre> | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>dataProvider</CODE> - the CheckList option list DataProvider</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="addStyle(java.lang.String)"><!-- --></A><H3> | |
addStyle</H3> | |
<PRE> | |
public void <B>addStyle</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> style)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>use @{link #setStyle(String, String)}</I> | |
<P> | |
<DD>Adds the given style-value pair to the style attribute of the outer div. | |
Does not check whether the style is already set. | |
<p/> | |
Typically used for the width: | |
<pre class="codeJava"> | |
list.addStyle(<span class="st">""width: 100%; height: 25em""</span>); </pre> | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>style</CODE> - the style name:value pair without a ending ;</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getFocusJavaScript()"><!-- --></A><H3> | |
getFocusJavaScript</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getFocusJavaScript</B>()</PRE> | |
<DL> | |
<DD>Return the Field focus JavaScript. | |
<P> | |
<DD><DL> | |
<DT><B>Overrides:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getFocusJavaScript()" title="class or interface in org.apache.click.control">getFocusJavaScript</A></CODE> in class <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html" title="class or interface in org.apache.click.control">Field</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the Field focus JavaScript</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setHeight(java.lang.String)"><!-- --></A><H3> | |
setHeight</H3> | |
<PRE> | |
public void <B>setHeight</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> height)</PRE> | |
<DL> | |
<DD>The css height attribute-value. | |
If null no height is set and the CheckList is not scrollable. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>height</CODE> - one of css height values (ie 40px) or null.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getHeight()"><!-- --></A><H3> | |
getHeight</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getHeight</B>()</PRE> | |
<DL> | |
<DD>The css-height attribute. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>Returns the height or null.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setHtmlClass(java.lang.String)"><!-- --></A><H3> | |
setHtmlClass</H3> | |
<PRE> | |
public void <B>setHtmlClass</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> clazz)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>use <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#addStyleClass(java.lang.String)" title="class or interface in org.apache.click.control"><CODE>AbstractControl.addStyleClass(String)</CODE></A> instead</I> | |
<P> | |
<DD>Set the given html class. The class will be set on the select list | |
together with the <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#STYLE_CLASS"><CODE>STYLE_CLASS</CODE></A>. Ie class="checkList my-class" | |
where my-class is the set class. The default value is null. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>clazz</CODE> - the class to set or null</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getHtmlClass()"><!-- --></A><H3> | |
getHtmlClass</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getHtmlClass</B>()</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>use <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getAttribute(java.lang.String)" title="class or interface in org.apache.click.control"><CODE>AbstractControl.getAttribute(String)</CODE></A> instead</I> | |
<P> | |
<DD>The html class to set on this control. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the class or null (default null)<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setHtmlClass(java.lang.String)"><CODE>setHtmlClass(String)</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getHeadElements()"><!-- --></A><H3> | |
getHeadElements</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/element/Element.html" title="class or interface in org.apache.click.element">Element</A>> <B>getHeadElements</B>()</PRE> | |
<DL> | |
<DD>Return the CheckList HEAD elements to be included in the page. | |
The following resources are returned: | |
<ul> | |
<li><tt>click/checklist/checklist.css</tt></li> | |
<li><tt>click/checklist/checklist.js</tt></li> | |
<li><tt>click/prototype/builder.js</tt></li> | |
<li><tt>click/prototype/controls.js</tt></li> | |
<li><tt>click/prototype/dragdrop.js</tt></li> | |
<li><tt>click/prototype/effects.js</tt></li> | |
<li><tt>click/prototype/prototype.js</tt></li> | |
<li><tt>click/prototype/slider.js</tt></li> | |
</ul> | |
<P> | |
<DD><DL> | |
<DT><B>Specified by:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/Control.html#getHeadElements()" title="class or interface in org.apache.click">getHeadElements</A></CODE> in interface <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/Control.html" title="class or interface in org.apache.click">Control</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getHeadElements()" title="class or interface in org.apache.click.control">getHeadElements</A></CODE> in class <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html" title="class or interface in org.apache.click.control">AbstractControl</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the HTML head import statements for the control<DT><B>See Also:</B><DD><A HREF="http://click.apache.org/docs/click-api/org/apache/click/Control.html#getHeadElements()" title="class or interface in org.apache.click"><CODE>Control.getHeadElements()</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getOptionList()"><!-- --></A><H3> | |
getOptionList</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A>> <B>getOptionList</B>()</PRE> | |
<DL> | |
<DD>Return the Option list. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the Option list</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setOptionList(java.util.List)"><!-- --></A><H3> | |
setOptionList</H3> | |
<PRE> | |
public void <B>setOptionList</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Option.html" title="class or interface in org.apache.click.control">Option</A>> options)</PRE> | |
<DL> | |
<DD>Set the Option list. Note: if the CheckList is sortable | |
than the List <b>must be fully modifiable</b>, because | |
it will be sorted according to the order chosen by the | |
user. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>options</CODE> - a list of Option objects</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setSortable(boolean)"><!-- --></A><H3> | |
setSortable</H3> | |
<PRE> | |
public void <B>setSortable</B>(boolean sortable)</PRE> | |
<DL> | |
<DD>Whether the list should be drag-drop sortable. This is supported by | |
scriptaculous. Note when the list also has a size than this might not work | |
on different browsers. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>sortable</CODE> - default is false.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="isSortable()"><!-- --></A><H3> | |
isSortable</H3> | |
<PRE> | |
public boolean <B>isSortable</B>()</PRE> | |
<DL> | |
<DD>Whether the list is also sortable. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>Returns the sortable.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getSortorder()"><!-- --></A><H3> | |
getSortorder</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> <B>getSortorder</B>()</PRE> | |
<DL> | |
<DD>A list of the values transmitted in the order they are present in the | |
list. This is only available if the list is sortable | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>Returns list of strings of the option values.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getValues()"><!-- --></A><H3> | |
getValues</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> <B>getValues</B>()</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>use <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getSelectedValues()"><CODE>getSelectedValues()</CODE></A> instead</I> | |
<P> | |
<DD>Return the list of selected values as a <tt>List</tt> of Strings. The | |
returned List will contain the values of the Options selected. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>a list of Strings</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getSelectedValues()"><!-- --></A><H3> | |
getSelectedValues</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> <B>getSelectedValues</B>()</PRE> | |
<DL> | |
<DD>Return the list of selected values as a <tt>List</tt> of Strings. The | |
returned List will contain the values of the Options selected. | |
<P> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the list of selected values</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setValues(java.util.List)"><!-- --></A><H3> | |
setValues</H3> | |
<PRE> | |
public void <B>setValues</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> values)</PRE> | |
<DL> | |
<DD><B>Deprecated.</B> <I>use <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setSelectedValues(java.util.List)"><CODE>setSelectedValues(List)</CODE></A> instead</I> | |
<P> | |
<DD>Set the list of selected values. The specified values must be Strings and | |
match the values of the Options. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>values</CODE> - a list of strings or null</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setSelectedValues(java.util.List)"><!-- --></A><H3> | |
setSelectedValues</H3> | |
<PRE> | |
public void <B>setSelectedValues</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html" title="class or interface in java.util">List</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>> selectedValues)</PRE> | |
<DL> | |
<DD>Set the list of selected values. The specified values must be Strings and | |
match the values of the Options. | |
<p/> | |
For example: | |
<pre class="prettyprint"> | |
CheckList checkList = new CheckList("checkList"); | |
public void onInit() { | |
List options = new ArrayList(); | |
options.add(new Option("1", "Option 1"); | |
options.add(new Option("2", "Option 2"); | |
options.add(new Option("3", "Option 3"); | |
checkList.setOptionList(options); | |
... | |
} | |
public void onRender() { | |
// Preselect some Options. | |
List selected = new ArrayList(); | |
selected.add("1")); | |
selected.add("3"); | |
checkList.setSelectedValues(selected); | |
} </pre> | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>selectedValues</CODE> - the list of selected string values or null</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getValueObject()"><!-- --></A><H3> | |
getValueObject</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> <B>getValueObject</B>()</PRE> | |
<DL> | |
<DD>This method delegates to <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getSelectedValues()"><CODE>getSelectedValues()</CODE></A> to return the | |
selected values as a <tt>java.util.List</tt> of Strings. | |
<P> | |
<DD><DL> | |
<DT><B>Overrides:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getValueObject()" title="class or interface in org.apache.click.control">getValueObject</A></CODE> in class <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html" title="class or interface in org.apache.click.control">Field</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>selected values as a List of Strings<DT><B>See Also:</B><DD><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getValueObject()" title="class or interface in org.apache.click.control"><CODE>Field.getValueObject()</CODE></A>, | |
<A HREF="../../../../../org/apache/click/extras/control/CheckList.html#getSelectedValues()"><CODE>getSelectedValues()</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="setValueObject(java.lang.Object)"><!-- --></A><H3> | |
setValueObject</H3> | |
<PRE> | |
public void <B>setValueObject</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A> object)</PRE> | |
<DL> | |
<DD>This method delegates to <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setSelectedValues(java.util.List)"><CODE>setSelectedValues(java.util.List)</CODE></A> | |
to set the selected values of the CheckList. The given object parameter | |
must be a <tt>java.util.List</tt> of Strings, otherwise it is ignored. | |
<p/> | |
The List of values match the values of the Options. | |
<P> | |
<DD><DL> | |
<DT><B>Overrides:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setValueObject(java.lang.Object)" title="class or interface in org.apache.click.control">setValueObject</A></CODE> in class <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html" title="class or interface in org.apache.click.control">Field</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>object</CODE> - a List of Strings<DT><B>See Also:</B><DD><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#setValueObject(java.lang.Object)" title="class or interface in org.apache.click.control"><CODE>Field.setValueObject(java.lang.Object)</CODE></A>, | |
<A HREF="../../../../../org/apache/click/extras/control/CheckList.html#setSelectedValues(java.util.List)"><CODE>setSelectedValues(java.util.List)</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getValidationJavaScript()"><!-- --></A><H3> | |
getValidationJavaScript</H3> | |
<PRE> | |
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getValidationJavaScript</B>()</PRE> | |
<DL> | |
<DD>Return the CheckList JavaScript client side validation function. | |
<P> | |
<DD><DL> | |
<DT><B>Overrides:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#getValidationJavaScript()" title="class or interface in org.apache.click.control">getValidationJavaScript</A></CODE> in class <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html" title="class or interface in org.apache.click.control">Field</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the field JavaScript client side validation function</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="bindRequestValue()"><!-- --></A><H3> | |
bindRequestValue</H3> | |
<PRE> | |
public void <B>bindRequestValue</B>()</PRE> | |
<DL> | |
<DD>Bind the request submission, setting the <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#selectedValues"><CODE>selectedValues</CODE></A> and | |
sort order if the checkList is sortable. | |
<P> | |
<DD><DL> | |
<DT><B>Overrides:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#bindRequestValue()" title="class or interface in org.apache.click.control">bindRequestValue</A></CODE> in class <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html" title="class or interface in org.apache.click.control">Field</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="onProcess()"><!-- --></A><H3> | |
onProcess</H3> | |
<PRE> | |
public boolean <B>onProcess</B>()</PRE> | |
<DL> | |
<DD>Process the request Context setting the CheckList selectedValues if | |
selected and invoking the control's listener if defined. | |
<P> | |
<DD><DL> | |
<DT><B>Specified by:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/Control.html#onProcess()" title="class or interface in org.apache.click">onProcess</A></CODE> in interface <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/Control.html" title="class or interface in org.apache.click">Control</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#onProcess()" title="class or interface in org.apache.click.control">onProcess</A></CODE> in class <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html" title="class or interface in org.apache.click.control">Field</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>true to continue Page event processing, false otherwise</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="sortOptions(java.lang.String[])"><!-- --></A><H3> | |
sortOptions</H3> | |
<PRE> | |
protected void <B>sortOptions</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[] order)</PRE> | |
<DL> | |
<DD>Sorts the current Options List. This method is called | |
in <A HREF="../../../../../org/apache/click/extras/control/CheckList.html#bindRequestValue()"><CODE>bindRequestValue()</CODE></A> when the CheckList | |
is sortable. | |
<P> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>order</CODE> - values in the order to sort the list.</DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="getControlSizeEst()"><!-- --></A><H3> | |
getControlSizeEst</H3> | |
<PRE> | |
public int <B>getControlSizeEst</B>()</PRE> | |
<DL> | |
<DD><DL> | |
<DT><B>Overrides:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getControlSizeEst()" title="class or interface in org.apache.click.control">getControlSizeEst</A></CODE> in class <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html" title="class or interface in org.apache.click.control">AbstractControl</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Returns:</B><DD>the estimated rendered control size in characters<DT><B>See Also:</B><DD><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#getControlSizeEst()" title="class or interface in org.apache.click.control"><CODE>AbstractControl.getControlSizeEst()</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="render(org.apache.click.util.HtmlStringBuffer)"><!-- --></A><H3> | |
render</H3> | |
<PRE> | |
public void <B>render</B>(<A HREF="http://click.apache.org/docs/click-api/org/apache/click/util/HtmlStringBuffer.html" title="class or interface in org.apache.click.util">HtmlStringBuffer</A> buffer)</PRE> | |
<DL> | |
<DD>Render the HTML representation of the CheckList. | |
<P> | |
<DD><DL> | |
<DT><B>Specified by:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/Control.html#render(org.apache.click.util.HtmlStringBuffer)" title="class or interface in org.apache.click">render</A></CODE> in interface <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/Control.html" title="class or interface in org.apache.click">Control</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#render(org.apache.click.util.HtmlStringBuffer)" title="class or interface in org.apache.click.control">render</A></CODE> in class <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html" title="class or interface in org.apache.click.control">AbstractControl</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - the specified buffer to render the control's output to<DT><B>See Also:</B><DD><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/AbstractControl.html#toString()" title="class or interface in org.apache.click.control"><CODE>AbstractControl.toString()</CODE></A></DL> | |
</DD> | |
</DL> | |
<HR> | |
<A NAME="validate()"><!-- --></A><H3> | |
validate</H3> | |
<PRE> | |
public void <B>validate</B>()</PRE> | |
<DL> | |
<DD>Validate the CheckList request submission. | |
<p/> | |
If a CheckList is <A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#required" title="class or interface in org.apache.click.control"><CODE>Field.required</CODE></A> then the user must select a value, | |
otherwise the Select will have a validation error. If the Select is not | |
required then no validation errors will occur. | |
<p/> | |
A field error message is displayed if a validation error occurs. These | |
messages are defined in the resource bundle: <blockquote> | |
<pre class="codeConfig> | |
/click-control.properties </pre> | |
</blockquote> <p/> Error message bundle key names include: <blockquote> | |
<ul> | |
<li>select-error</li> | |
</ul> | |
</blockquote> | |
<P> | |
<DD><DL> | |
<DT><B>Overrides:</B><DD><CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html#validate()" title="class or interface in org.apache.click.control">validate</A></CODE> in class <CODE><A HREF="http://click.apache.org/docs/click-api/org/apache/click/control/Field.html" title="class or interface in org.apache.click.control">Field</A></CODE></DL> | |
</DD> | |
<DD><DL> | |
</DL> | |
</DD> | |
</DL> | |
<!-- ========= END OF CLASS DATA ========= --> | |
<HR> | |
<!-- ======= START OF BOTTOM NAVBAR ====== --> | |
<A NAME="navbar_bottom"><!-- --></A> | |
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
<TR> | |
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
<A NAME="navbar_bottom_firstrow"><!-- --></A> | |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
<TR ALIGN="center" VALIGN="top"> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
</TR> | |
</TABLE> | |
</TD> | |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
</EM> | |
</TD> | |
</TR> | |
<TR> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../org/apache/click/extras/control/AutoCompleteTextField.html" title="class in org.apache.click.extras.control"><B>PREV CLASS</B></A> | |
<A HREF="../../../../../org/apache/click/extras/control/ColorPicker.html" title="class in org.apache.click.extras.control"><B>NEXT CLASS</B></A></FONT></TD> | |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
<A HREF="../../../../../index.html?org/apache/click/extras/control/CheckList.html" target="_top"><B>FRAMES</B></A> | |
<A HREF="CheckList.html" target="_top"><B>NO FRAMES</B></A> | |
<SCRIPT type="text/javascript"> | |
<!-- | |
if(window==top) { | |
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
} | |
//--> | |
</SCRIPT> | |
<NOSCRIPT> | |
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
</NOSCRIPT> | |
</FONT></TD> | |
</TR> | |
<TR> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
</TR> | |
</TABLE> | |
<A NAME="skip-navbar_bottom"></A> | |
<!-- ======== END OF BOTTOM NAVBAR ======= --> | |
<HR> | |
<style type='text/css'>.str{color:#2A00FF;}.kwd{color:#7F0055;font-weight:bold;}.com{color:#3F7F5F;}.typ{color:#000;}.lit{color:#066;}.pun{color:#660;}.pln{color:#000;}.tag{color:#000099;font-weight:bold;}.atn{color:#009900;}.atv{color:#000;}.dec{color:#606;}pre.prettyprint{padding:1em;border:1px solid #888;overflow:auto;}@media print{.str{color:#2A00FF;}.kwd{color:#7F0055;font-weight:bold;}.com{color:#3F7F5F;font-style:italic;}.typ{color:#000;font-weight:bold;}.lit{color:#044;}.pun{color:#440;}.pln{color:#000;}.tag{color:#000099;font-weight:bold;}.atn{color:#009900;}.atv{color:#000;}}</style><script type='text/javascript'>var PR_keywords={};(function(){var CPP_KEYWORDS='abstract bool break case catch char class const '+'const_cast continue default delete deprecated dllexport dllimport do '+'double dynamic_cast else enum explicit extern false float for friend '+'goto if inline int long mutable naked namespace new noinline noreturn '+'nothrow novtable operator private property protected public register '+'reinterpret_cast return selectany short signed sizeof static '+'static_cast struct switch template this thread throw true try typedef '+'typeid typename union unsigned using declaration, directive uuid '+'virtual void volatile while typeof';var CSHARP_KEYWORDS='as base by byte checked decimal delegate descending '+'event finally fixed foreach from group implicit in interface internal '+'into is lock null object override orderby params readonly ref sbyte '+'sealed stackalloc string select uint ulong unchecked unsafe ushort var';var JAVA_KEYWORDS='package synchronized boolean implements import throws '+'instanceof transient extends final strictfp native super';var JSCRIPT_KEYWORDS='debugger export function with NaN Infinity';var PERL_KEYWORDS='require sub unless until use elsif BEGIN END';var PYTHON_KEYWORDS='and assert def del elif except exec global lambda '+'not or pass print raise yield False True None';var RUBY_KEYWORDS='then end begin rescue ensure module when undef next '+'redo retry alias defined';var SH_KEYWORDS='done fi';var KEYWORDS=[CPP_KEYWORDS,CSHARP_KEYWORDS,JAVA_KEYWORDS,JSCRIPT_KEYWORDS,PERL_KEYWORDS,PYTHON_KEYWORDS,RUBY_KEYWORDS,SH_KEYWORDS];for(var k=0;k<KEYWORDS.length;k++){var kw=KEYWORDS[k].split(' ');for(var i=0;i<kw.length;i++){if(kw[i]){PR_keywords[kw[i]]=true;}}}}).call(this);var PR_STRING='str';var PR_KEYWORD='kwd';var PR_COMMENT='com';var PR_TYPE='typ';var PR_LITERAL='lit';var PR_PUNCTUATION='pun';var PR_PLAIN='pln';var PR_TAG='tag';var PR_DECLARATION='dec';var PR_SOURCE='src';var PR_ATTRIB_NAME='atn';var PR_ATTRIB_VALUE='atv';var PR_TAB_WIDTH=8;function PR_isWordChar(ch){return(ch>='a'&&ch<='z')||(ch>='A'&&ch<='Z');}function PR_spliceArrayInto(inserted,container,containerPosition,countReplaced){inserted.unshift(containerPosition,countReplaced||0);try{container.splice.apply(container,inserted);}finally{inserted.splice(0,2);}}var REGEXP_PRECEDER_PATTERN=(function(){var preceders=['!','!=','!==','#','%','%=','&','&&','&&=','&=','(','*','*=','+=',',','-=','->','/','/=',':','::',';','<','<<','<<=','<=','=','==','===','>','>=','>>','>>=','>>>','>>>=','?','@','[','^','^=','^^','^^=','{','|','|=','||','||=','~','break','case','continue','delete','do','else','finally','instanceof','return','throw','try','typeof'];var pattern='(?:'+'(?:(?:^|[^0-9\.])\\.{1,3})|'+'(?:(?:^|[^\\+])\\+)|'+'(?:(?:^|[^\\-])-)';for(var i=0;i<preceders.length;++i){var preceder=preceders[i];if(PR_isWordChar(preceder.charAt(0))){pattern+='|\\b'+preceder;}else{pattern+='|'+preceder.replace(/([^=<>:&])/g,'\\$1');}}pattern+='|^)\\s*$';return new RegExp(pattern);})();var pr_amp=/&/g;var pr_lt=/</g;var pr_gt=/>/g;var pr_quot=/"/g;function PR_attribToHtml(str){return str.replace(pr_amp,'&').replace(pr_lt,'<').replace(pr_gt,'>').replace(pr_quot,'"');}function PR_textToHtml(str){return str.replace(pr_amp,'&').replace(pr_lt,'<').replace(pr_gt,'>');}var pr_ltEnt=/</g;var pr_gtEnt=/>/g;var pr_aposEnt=/'/g;var pr_quotEnt=/"/g;var pr_ampEnt=/&/g;function PR_htmlToText(html){var pos=html.indexOf('&');if(pos<0){return html;}for(--pos;(pos=html.indexOf('&#',pos+1))>=0;){var end=html.indexOf(';',pos);if(end>=0){var num=html.substring(pos+3,end);var radix=10;if(num&&num.charAt(0)=='x'){num=num.substring(1);radix=16;}var codePoint=parseInt(num,radix);if(!isNaN(codePoint)){html=(html.substring(0,pos)+String.fromCharCode(codePoint)+html.substring(end+1));}}}return html.replace(pr_ltEnt,'<').replace(pr_gtEnt,'>').replace(pr_aposEnt,"'").replace(pr_quotEnt,'"').replace(pr_ampEnt,'&');}function PR_isRawContent(node){return'XMP'==node.tagName;}var PR_innerHtmlWorks=null;function PR_getInnerHtml(node){if(null===PR_innerHtmlWorks){var testNode=document.createElement('PRE');testNode.appendChild(document.createTextNode('<!DOCTYPE foo PUBLIC "foo bar">\n<foo />'));PR_innerHtmlWorks=!/</.test(testNode.innerHTML);}if(PR_innerHtmlWorks){var content=node.innerHTML;if(PR_isRawContent(node)){content=PR_textToHtml(content);}return content;}var out=[];for(var child=node.firstChild;child;child=child.nextSibling){PR_normalizedHtml(child,out);}return out.join('');}function PR_normalizedHtml(node,out){switch(node.nodeType){case 1:var name=node.tagName.toLowerCase();out.push('\074',name);for(var i=0;i<node.attributes.length;++i){var attr=node.attributes[i];if(!attr.specified){continue;}out.push(' ');PR_normalizedHtml(attr,out);}out.push('>');for(var child=node.firstChild;child;child=child.nextSibling){PR_normalizedHtml(child,out);}if(node.firstChild||!/^(?:br|link|img)$/.test(name)){out.push('<\/',name,'>');}break;case 2:out.push(node.name.toLowerCase(),'="',PR_attribToHtml(node.value),'"');break;case 3:case 4:out.push(PR_textToHtml(node.nodeValue));break;}}function PR_tabExpander(tabWidth){var SPACES=' ';var charInLine=0;return function(plainText){var out=null;var pos=0;for(var i=0,n=plainText.length;i<n;++i){var ch=plainText.charAt(i);switch(ch){case'\t':if(!out){out=[];}out.push(plainText.substring(pos,i));var nSpaces=tabWidth-(charInLine%tabWidth);charInLine+=nSpaces;for(;nSpaces>=0;nSpaces-=SPACES.length){out.push(SPACES.substring(0,nSpaces));}pos=i+1;break;case'\n':charInLine=0;break;default:++charInLine;}}if(!out){return plainText;}out.push(plainText.substring(pos));return out.join('');};}var pr_chunkPattern=/(?:[^<]+|<!--[\s\S]*?-->|<!\[CDATA\[([\s\S]*?)\]\]>|<\/?[a-zA-Z][^>]*>|<)/g;var pr_commentPrefix=/^<!--/;var pr_cdataPrefix=/^<\[CDATA\[/;var pr_brPrefix=/^<br\b/i;function PR_extractTags(s){var matches=s.match(pr_chunkPattern);var sourceBuf=[];var sourceBufLen=0;var extractedTags=[];if(matches){for(var i=0,n=matches.length;i<n;++i){var match=matches[i];if(match.length>1&&match.charAt(0)==='<'){if(pr_commentPrefix.test(match)){continue;}if(pr_cdataPrefix.test(match)){sourceBuf.push(match.substring(9,match.length-3));sourceBufLen+=match.length-12;}else if(pr_brPrefix.test(match)){sourceBuf.push('\n');sourceBufLen+=1;}else{extractedTags.push(sourceBufLen,match);}}else{var literalText=PR_htmlToText(match);sourceBuf.push(literalText);sourceBufLen+=literalText.length;}}}return{source:sourceBuf.join(''),tags:extractedTags};}function PR_createSimpleLexer(shortcutStylePatterns,fallthroughStylePatterns){var shortcuts={};(function(){var allPatterns=shortcutStylePatterns.concat(fallthroughStylePatterns);for(var i=allPatterns.length;--i>=0;){var patternParts=allPatterns[i];var shortcutChars=patternParts[3];if(shortcutChars){for(var c=shortcutChars.length;--c>=0;){shortcuts[shortcutChars.charAt(c)]=patternParts;}}}})();var nPatterns=fallthroughStylePatterns.length;return function(sourceCode,opt_basePos){opt_basePos=opt_basePos||0;var decorations=[opt_basePos,PR_PLAIN];var lastToken='';var pos=0;var tail=sourceCode;while(tail.length){var style;var token=null;var patternParts=shortcuts[tail.charAt(0)];if(patternParts){var match=tail.match(patternParts[1]);token=match[0];style=patternParts[0];}else{for(var i=0;i<nPatterns;++i){patternParts=fallthroughStylePatterns[i];var contextPattern=patternParts[2];if(contextPattern&&!contextPattern.test(lastToken)){continue;}var match=tail.match(patternParts[1]);if(match){token=match[0];style=patternParts[0];break;}}if(!token){style=PR_PLAIN;token=tail.substring(0,1);}}decorations.push(opt_basePos+pos,style);pos+=token.length;tail=tail.substring(token.length);if(style!==PR_COMMENT&&/\S/.test(token)){lastToken=token;}}return decorations;};}var PR_C_STYLE_STRING_AND_COMMENT_LEXER=PR_createSimpleLexer([[PR_STRING,/^\'(?:[^\\\']|\\[\s\S])*(?:\'|$)/,null,"'"],[PR_STRING,/^"(?:[^\\"]|\\[\s\S])*(?:"|$)/,null,'"'],[PR_STRING,/^\`(?:[^\\\`]|\\[\s\S])*(?:\`|$)/,null,'`']],[[PR_PLAIN,/^(?:[^\'"\`\/\#]+)/,null,' \r\n'],[PR_COMMENT,/^#[^\r\n]*/,null,'#'],[PR_COMMENT,/^\/\/[^\r\n]*/,null],[PR_STRING,/^\/(?:[^\\\*\/]|\\[\s\S])+(?:\/|$)/,REGEXP_PRECEDER_PATTERN],[PR_COMMENT,/^\/\*[\s\S]*?(?:\*\/|$)/,null]]);function PR_splitStringAndCommentTokens(sourceCode){return PR_C_STYLE_STRING_AND_COMMENT_LEXER(sourceCode);}var PR_C_STYLE_LITERAL_IDENTIFIER_PUNC_RECOGNIZER=PR_createSimpleLexer([],[[PR_PLAIN,/^\s+/,null,' \r\n'],[PR_PLAIN,/^[a-z_$@][a-z_$@0-9]*/i,null],[PR_LITERAL,/^0x[a-f0-9]+[a-z]/i,null],[PR_LITERAL,/^(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?[a-z]*/i,null,'123456789'],[PR_PUNCTUATION,/^[^\s\w\.$@]+/,null]]);function PR_splitNonStringNonCommentTokens(source,decorations){for(var i=0;i<decorations.length;i+=2){var style=decorations[i+1];if(style===PR_PLAIN){var start=decorations[i];var end=i+2<decorations.length?decorations[i+2]:source.length;var chunk=source.substring(start,end);var subDecs=PR_C_STYLE_LITERAL_IDENTIFIER_PUNC_RECOGNIZER(chunk,start);for(var j=0,m=subDecs.length;j<m;j+=2){var subStyle=subDecs[j+1];if(subStyle===PR_PLAIN){var subStart=subDecs[j];var subEnd=j+2<m?subDecs[j+2]:chunk.length;var token=source.substring(subStart,subEnd);if(token=='.'){subDecs[j+1]=PR_PUNCTUATION;}else if(token in PR_keywords){subDecs[j+1]=PR_KEYWORD;}else if(/^@?[A-Z][A-Z$]*[a-z][A-Za-z$]*$/.test(token)){subDecs[j+1]=token.charAt(0)=='@'?PR_LITERAL:PR_TYPE;}}}PR_spliceArrayInto(subDecs,decorations,i,2);i+=subDecs.length-2;}}return decorations;}var PR_MARKUP_LEXER=PR_createSimpleLexer([],[[PR_PLAIN,/^[^<]+/,null],[PR_DECLARATION,/^<!\w[^>]*(?:>|$)/,null],[PR_COMMENT,/^<!--[\s\S]*?(?:-->|$)/,null],[PR_SOURCE,/^<\?[\s\S]*?(?:\?>|$)/,null],[PR_SOURCE,/^<%[\s\S]*?(?:%>|$)/,null],[PR_SOURCE,/^<(script|style|xmp)\b[^>]*>[\s\S]*?<\/\1\b[^>]*>/i,null],[PR_TAG,/^<\/?\w[^<>]*>/,null]]);var PR_SOURCE_CHUNK_PARTS=/^(<[^>]*>)([\s\S]*)(<\/[^>]*>)$/;function PR_tokenizeMarkup(source){var decorations=PR_MARKUP_LEXER(source);for(var i=0;i<decorations.length;i+=2){if(decorations[i+1]===PR_SOURCE){var start=decorations[i];var end=i+2<decorations.length?decorations[i+2]:source.length;var sourceChunk=source.substring(start,end);var match=(sourceChunk.match(PR_SOURCE_CHUNK_PARTS));if(match){decorations.splice(i,2,start,PR_TAG,start+match[1].length,PR_SOURCE,start+match[1].length+(match[2]||'').length,PR_TAG);}}}return decorations;}var PR_TAG_LEXER=PR_createSimpleLexer([[PR_ATTRIB_VALUE,/^\'[^\']*(?:\'|$)/,null,"'"],[PR_ATTRIB_VALUE,/^"[^"]*(?:"|$)/,null,'"'],[PR_PUNCTUATION,/^[<>\/=]+/,null,'<>/=']],[[PR_TAG,/^[\w-]+/,/^</],[PR_ATTRIB_VALUE,/^[\w-]+/,/^=/],[PR_ATTRIB_NAME,/^[\w-]+/,null],[PR_PLAIN,/^\s+/,null,' \r\n']]);function PR_splitTagAttributes(source,decorations){for(var i=0;i<decorations.length;i+=2){var style=decorations[i+1];if(style===PR_TAG){var start=decorations[i];var end=i+2<decorations.length?decorations[i+2]:source.length;var chunk=source.substring(start,end);var subDecorations=PR_TAG_LEXER(chunk,start);PR_spliceArrayInto(subDecorations,decorations,i,2);i+=subDecorations.length-2;}}return decorations;}function PR_splitSourceNodes(source,decorations){for(var i=0;i<decorations.length;i+=2){var style=decorations[i+1];if(style==PR_SOURCE){var start=decorations[i];var end=i+2<decorations.length?decorations[i+2]:source.length;var subDecorations=PR_decorateSource(source.substring(start,end));for(var j=0,m=subDecorations.length;j<m;j+=2){subDecorations[j]+=start;}PR_spliceArrayInto(subDecorations,decorations,i,2);i+=subDecorations.length-2;}}return decorations;}function PR_splitSourceAttributes(source,decorations){var nextValueIsSource=false;for(var i=0;i<decorations.length;i+=2){var style=decorations[i+1];if(style===PR_ATTRIB_NAME){var start=decorations[i];var end=i+2<decorations.length?decorations[i+2]:source.length;nextValueIsSource=/^on|^style$/i.test(source.substring(start,end));}else if(style==PR_ATTRIB_VALUE){if(nextValueIsSource){var start=decorations[i];var end=i+2<decorations.length?decorations[i+2]:source.length;var attribValue=source.substring(start,end);var attribLen=attribValue.length;var quoted=(attribLen>=2&&/^["\']/.test(attribValue)&&attribValue.charAt(0)===attribValue.charAt(attribLen-1));var attribSource;var attribSourceStart;var attribSourceEnd;if(quoted){attribSourceStart=start+1;attribSourceEnd=end-1;attribSource=attribValue;}else{attribSourceStart=start+1;attribSourceEnd=end-1;attribSource=attribValue.substring(1,attribValue.length-1);}var attribSourceDecorations=PR_decorateSource(attribSource);for(var j=0,m=attribSourceDecorations.length;j<m;j+=2){attribSourceDecorations[j]+=attribSourceStart;}if(quoted){attribSourceDecorations.push(attribSourceEnd,PR_ATTRIB_VALUE);PR_spliceArrayInto(attribSourceDecorations,decorations,i+2,0);}else{PR_spliceArrayInto(attribSourceDecorations,decorations,i,2);}}nextValueIsSource=false;}}return decorations;}function PR_decorateSource(sourceCode){var decorations=PR_splitStringAndCommentTokens(sourceCode);decorations=PR_splitNonStringNonCommentTokens(sourceCode,decorations);return decorations;}function PR_decorateMarkup(sourceCode){var decorations=PR_tokenizeMarkup(sourceCode);decorations=PR_splitTagAttributes(sourceCode,decorations);decorations=PR_splitSourceNodes(sourceCode,decorations);decorations=PR_splitSourceAttributes(sourceCode,decorations);return decorations;}function PR_recombineTagsAndDecorations(sourceText,extractedTags,decorations){var html=[];var outputIdx=0;var openDecoration=null;var currentDecoration=null;var tagPos=0;var decPos=0;var tabExpander=PR_tabExpander(PR_TAB_WIDTH);function emitTextUpTo(sourceIdx){if(sourceIdx>outputIdx){if(openDecoration&&openDecoration!==currentDecoration){html.push('</span>');openDecoration=null;}if(!openDecoration&¤tDecoration){openDecoration=currentDecoration;html.push('<span class="',openDecoration,'">');}var htmlChunk=PR_textToHtml(tabExpander(sourceText.substring(outputIdx,sourceIdx))).replace(/(\r\n?|\n| ) /g,'$1 ').replace(/\r\n?|\n/g,' <br>');html.push(htmlChunk);outputIdx=sourceIdx;}}while(true){var outputTag;if(tagPos<extractedTags.length){if(decPos<decorations.length){outputTag=extractedTags[tagPos]<=decorations[decPos];}else{outputTag=true;}}else{outputTag=false;}if(outputTag){emitTextUpTo(extractedTags[tagPos]);if(openDecoration){html.push('</span>');openDecoration=null;}html.push(extractedTags[tagPos+1]);tagPos+=2;}else if(decPos<decorations.length){emitTextUpTo(decorations[decPos]);currentDecoration=decorations[decPos+1];decPos+=2;}else{break;}}emitTextUpTo(sourceText.length);if(openDecoration){html.push('</span>');}return html.join('');}function prettyPrintOne(sourceCodeHtml){try{var sourceAndExtractedTags=PR_extractTags(sourceCodeHtml);var source=sourceAndExtractedTags.source;var extractedTags=sourceAndExtractedTags.tags;var isMarkup=/^\s*</.test(source)&&/>\s*$/.test(source);var decorations=isMarkup?PR_decorateMarkup(source):PR_decorateSource(source);return PR_recombineTagsAndDecorations(source,extractedTags,decorations);}catch(e){if('console'in window){console.log(e);console.trace();}return sourceCodeHtml;}}var PR_SHOULD_USE_CONTINUATION=true;function prettyPrint(opt_whenDone){var codeSegments=[document.getElementsByTagName('pre'),document.getElementsByTagName('code'),document.getElementsByTagName('xmp')];var elements=[];for(var i=0;i<codeSegments.length;++i){for(var j=0;j<codeSegments[i].length;++j){elements.push(codeSegments[i][j]);}}codeSegments=null;var k=0;function doWork(){var endTime=(PR_SHOULD_USE_CONTINUATION?new Date().getTime()+250:Infinity);for(;k<elements.length&&new Date().getTime()<endTime;k++){var cs=elements[k];if(cs.className&&cs.className.indexOf('prettyprint')>=0){var nested=false;for(var p=cs.parentNode;p!=null;p=p.parentNode){if((p.tagName=='pre'||p.tagName=='code'||p.tagName=='xmp')&&p.className&&p.className.indexOf('prettyprint')>=0){nested=true;break;}}if(!nested){var content=PR_getInnerHtml(cs);content=content.replace(/(?:\r\n?|\n)$/,'');var newContent=prettyPrintOne(content);if(!PR_isRawContent(cs)){cs.innerHTML=newContent;}else{var pre=document.createElement('PRE');for(var i=0;i<cs.attributes.length;++i){var a=cs.attributes[i];if(a.specified){pre.setAttribute(a.name,a.value);}}pre.innerHTML=newContent;cs.parentNode.replaceChild(pre,cs);}}}}if(k<elements.length){setTimeout(doWork,250);}else if(opt_whenDone){opt_whenDone();}}doWork();}</script><script type='text/javascript'>prettyPrint();</script></BODY> | |
</HTML> |