KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > services > html > CheckBox


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64
65 package com.jcorporate.expresso.services.html;
66
67 /**
68  * CheckBox.java
69  *
70  * Copyright 1999, 2000, 2001 Jcorporate Ltd.
71  */
72
73 import java.io.PrintWriter JavaDoc;
74 import java.util.Enumeration JavaDoc;
75 import java.util.Vector JavaDoc;
76
77
78 /**
79  * An HTML checkbox for use on HTML forms
80  *
81  * @author Michael Nash
82  * @version $Revision: 1.8 $ $Date: 2004/11/17 20:48:18 $
83  */
84 public class CheckBox
85         extends HtmlElement {
86     private String JavaDoc fieldName = null;
87     protected String JavaDoc currentValue = ("");
88     private Vector JavaDoc values = new Vector JavaDoc(3);
89     private Vector JavaDoc labels = new Vector JavaDoc(3);
90     private boolean isChecked = false;
91     private String JavaDoc thisClass = (this.getClass().getName() + ".");
92     private boolean isVertical = false;
93
94     /**
95      * Constructor
96      *
97      * @throws HtmlException If the superclass constructor fails
98      */
99     public CheckBox()
100             throws HtmlException {
101         super();
102     } /* CheckBox() */
103
104     /**
105      * Create a checkbox with the field name as given with a specific current value
106      *
107      * @param newFieldName Field name of the new checkbox
108      * @param newCurrentValue Current value of the drop down (selected item)
109      * @throws HtmlException If the parameters are invalid
110      */
111     public CheckBox(String JavaDoc newFieldName, String JavaDoc newCurrentValue)
112             throws HtmlException {
113         super(newFieldName);
114         fieldName = newFieldName;
115         currentValue = newCurrentValue;
116     } /* CheckBox(String, String) */
117
118     /**
119      * Constructor
120      * Create the checkbox with a given name and value and state
121      *
122      * @param newFieldName Name of the field on the form
123      * @param newFieldValue Value of the field when checked
124      * @param newChecked True if the box's initial state is checked, else false
125      * @throws HtmlException If a parameter is invalid
126      */
127     public CheckBox(String JavaDoc newFieldName, String JavaDoc newFieldValue,
128                     boolean newChecked)
129             throws HtmlException {
130         super(newFieldName);
131         fieldName = newFieldName;
132         addOption(newFieldValue, "");
133         setCurrentValue(newFieldValue);
134         isChecked = newChecked;
135     } /* CheckBox(String, String, boolean) */
136
137     /**
138      * Add a new option to this checkbox
139      *
140      * @param fieldValue Value of the new option
141      * @param fieldLabel Label of the new option
142      * @throws HtmlException If the parameters are invalid
143      */
144     public synchronized void addOption(String JavaDoc fieldValue, String JavaDoc fieldLabel)
145             throws HtmlException {
146         values.addElement(fieldValue);
147         labels.addElement(fieldLabel);
148     } /* addOption(String, String) */
149
150
151     /**
152      * Display this CheckBox to the appropriate PrintWriter
153      *
154      * @param out PrintWriter to display
155      * @param depth the number of tabs to indent
156      * @throws HtmlException If the Radio cannot be displayed
157      */
158     protected synchronized void display(PrintWriter JavaDoc out, int depth)
159             throws HtmlException {
160         String JavaDoc myName = (thisClass + "display(PrintWriter)");
161
162         if (values.size() == 0) {
163             throw new HtmlException(myName + ":CheckBox " + getName() +
164                     " has no choices");
165         }
166
167         String JavaDoc oneValue = null;
168         String JavaDoc oneLabel = null;
169         Enumeration JavaDoc e2 = labels.elements();
170
171         for (Enumeration JavaDoc e = values.elements(); e.hasMoreElements();) {
172             oneValue = (String JavaDoc) e.nextElement();
173             oneLabel = (String JavaDoc) e2.nextElement();
174
175             if (isVertical) {
176                 this.padWithTabs(out, depth);
177                 out.print("<br />");
178             }
179             if ((oneLabel != null) && !(oneLabel.trim().equals(""))) {
180                 out.println(oneLabel);
181             }
182             if (isChecked) {
183                 this.padWithTabs(out, depth);
184                 out.println("<input type=checkbox name=\"" + fieldName +
185                         "\" checked value=\"" + oneValue + "\"/>");
186             } else {
187                 this.padWithTabs(out, depth);
188                 out.println("<input type=checkbox name=\"" + fieldName +
189                         "\" value=\"" + oneValue + "\"/>");
190             }
191         }
192
193         setDisplayed();
194     } /* display(PrintWriter) */
195
196
197     /**
198      * Set the current "checked" status
199      *
200      * @param newChecked set to true if checked
201      * @throws HtmlException If the parameter is invalid
202      */
203     public void setChecked(boolean newChecked)
204             throws HtmlException {
205         isChecked = newChecked;
206     } /* setChecked(boolean) */
207
208
209     /**
210      * Set the currently selected value for this checkbox
211      *
212      * @param newCurrentValue The value for this checkbox
213      * @throws HtmlException If the parameter is invalid
214      */
215     public void setCurrentValue(String JavaDoc newCurrentValue)
216             throws HtmlException {
217         currentValue = newCurrentValue;
218     } /* setCurrentValue(String) */
219
220
221     /**
222      * @param state set to true if the checkboxes are vertical
223      */
224     public void setVertical(boolean state) {
225         isVertical = state;
226     } /* setVertical(boolean) */
227
228 } /* CheckBox */
229
230 /* CheckBox */
Popular Tags