KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > gargoylesoftware > htmlunit > html > HtmlCheckBoxInput


1 /*
2  * Copyright (c) 2002, 2005 Gargoyle Software Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright notice,
10  * this list of conditions and the following disclaimer in the documentation
11  * and/or other materials provided with the distribution.
12  * 3. The end-user documentation included with the redistribution, if any, must
13  * include the following acknowledgment:
14  *
15  * "This product includes software developed by Gargoyle Software Inc.
16  * (http://www.GargoyleSoftware.com/)."
17  *
18  * Alternately, this acknowledgment may appear in the software itself, if
19  * and wherever such third-party acknowledgments normally appear.
20  * 4. The name "Gargoyle Software" must not be used to endorse or promote
21  * products derived from this software without prior written permission.
22  * For written permission, please contact info@GargoyleSoftware.com.
23  * 5. Products derived from this software may not be called "HtmlUnit", nor may
24  * "HtmlUnit" appear in their name, without prior written permission of
25  * Gargoyle Software Inc.
26  *
27  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
28  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
29  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
30  * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
31  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
33  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
36  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37  */
38 package com.gargoylesoftware.htmlunit.html;
39
40 import java.io.IOException JavaDoc;
41 import java.util.Map JavaDoc;
42
43 import com.gargoylesoftware.htmlunit.Page;
44
45 /**
46  * Wrapper for the html element "input"
47  *
48  * @version $Revision: 100 $
49  * @author <a HREF="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
50  * @author David K. Taylor
51  * @author <a HREF="mailto:chen_jun@users.sourceforge.net">Jun Chen</a>
52  * @author <a HREF="mailto:cse@dynabean.de">Christian Sell</a>
53  * @author Marc Guillemot
54  * @author Mike Bresnahan
55  */
56 public class HtmlCheckBoxInput extends HtmlInput {
57
58     //For Checkbox, radio
59 private final boolean initialCheckedState_;
60
61     /**
62      * Create an instance.
63      * If no value is specified, it is set to "on" as browsers do (eg IE6 and Mozilla 1.7)
64      * even if spec says that it is not allowed
65      * (<a HREF="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-value-INPUT">W3C</a>).
66      * @param page The page that contains this element
67      * @param attributes the initial attributes
68      */
69     public HtmlCheckBoxInput( final HtmlPage page, final Map JavaDoc attributes) {
70         super( page, attributes );
71
72         //From the checkbox creator
73 initialCheckedState_ = isAttributeDefined("checked");
74
75         // default value for both IE6 and Mozilla 1.7 even if spec says it is unspecified
76 if (getAttributeValue("value") == ATTRIBUTE_NOT_DEFINED) {
77             setAttributeValue("value", "on");
78         }
79     }
80
81
82     /**
83      * Reset this element to its original values.
84      */
85     public void reset() {
86         setChecked(initialCheckedState_);
87     }
88
89     /**
90      * Set the "checked" attribute
91      *
92      * @param isChecked true if this element is to be selected
93      */
94     public void setChecked( final boolean isChecked ) {
95         if( isChecked ) {
96             setAttributeValue( "checked", "checked" );
97         }
98         else {
99             removeAttribute( "checked" );
100         }
101     }
102
103     /**
104      * A checkbox does not have a textual representation,
105      * but we invent one for it because it is useful for testing.
106      * @return "checked" or "unchecked" according to the radio state
107      */
108     public String JavaDoc asText() {
109         if (isChecked()) {
110             return "checked";
111         }
112         else {
113             return "unchecked";
114         }
115     }
116
117     /**
118      * Override so that checkbox can change its state correctly when its
119      * click() method is called.
120      *
121      * {@inheritDoc}
122      */
123     protected Page doClickAction(final Page defaultPage) throws IOException JavaDoc {
124         if (isChecked()) {
125             setChecked(false);
126         }
127         else {
128             setChecked(true);
129         }
130
131         return super.doClickAction(defaultPage);
132     }
133
134     /**
135      * Both IE and Mozilla will first update the internal state of checkbox
136      * and then handle "onclick" event.
137      * {@inheritDoc}
138      */
139     protected boolean isStateUpdateFirst() {
140         return true;
141     }
142 }
143
144
Popular Tags