001: /*
002: * Copyright (c) 2002-2008 Gargoyle Software Inc. All rights reserved.
003: *
004: * Redistribution and use in source and binary forms, with or without
005: * modification, are permitted provided that the following conditions are met:
006: *
007: * 1. Redistributions of source code must retain the above copyright notice,
008: * this list of conditions and the following disclaimer.
009: * 2. Redistributions in binary form must reproduce the above copyright notice,
010: * this list of conditions and the following disclaimer in the documentation
011: * and/or other materials provided with the distribution.
012: * 3. The end-user documentation included with the redistribution, if any, must
013: * include the following acknowledgment:
014: *
015: * "This product includes software developed by Gargoyle Software Inc.
016: * (http://www.GargoyleSoftware.com/)."
017: *
018: * Alternately, this acknowledgment may appear in the software itself, if
019: * and wherever such third-party acknowledgments normally appear.
020: * 4. The name "Gargoyle Software" must not be used to endorse or promote
021: * products derived from this software without prior written permission.
022: * For written permission, please contact info@GargoyleSoftware.com.
023: * 5. Products derived from this software may not be called "HtmlUnit", nor may
024: * "HtmlUnit" appear in their name, without prior written permission of
025: * Gargoyle Software Inc.
026: *
027: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
028: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
029: * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARGOYLE
030: * SOFTWARE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
031: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
032: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
033: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
034: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
035: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
036: * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
037: */
038: package com.gargoylesoftware.htmlunit.html;
039:
040: import java.io.IOException;
041: import java.util.Map;
042:
043: import com.gargoylesoftware.htmlunit.Page;
044:
045: /**
046: * Wrapper for the html element "input"
047: *
048: * @version $Revision: 2132 $
049: * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
050: * @author David K. Taylor
051: * @author <a href="mailto:chen_jun@users.sourceforge.net">Jun Chen</a>
052: * @author <a href="mailto:cse@dynabean.de">Christian Sell</a>
053: * @author Marc Guillemot
054: * @author Mike Bresnahan
055: * @author Daniel Gredler
056: * @author Ahmed Ashour
057: */
058: public class HtmlCheckBoxInput extends HtmlInput {
059:
060: private static final long serialVersionUID = 3567976425357413976L;
061:
062: private boolean defaultCheckedState_;
063:
064: /**
065: * Create an instance.
066: * If no value is specified, it is set to "on" as browsers do (e.g. IE6 and Mozilla 1.7)
067: * even if spec says that it is not allowed
068: * (<a href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-value-INPUT">W3C</a>).
069: * @param page The page that contains this element
070: * @param attributes the initial attributes
071: * @deprecated You should not directly construct HtmlCheckBoxInput.
072: */
073: //TODO: to be removed, deprecated after 1.11
074: public HtmlCheckBoxInput(final HtmlPage page, final Map attributes) {
075: this (null, TAG_NAME, page, attributes);
076: }
077:
078: /**
079: * Create an instance.
080: * If no value is specified, it is set to "on" as browsers do (e.g. IE6 and Mozilla 1.7)
081: * even if spec says that it is not allowed
082: * (<a href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-value-INPUT">W3C</a>).
083: *
084: * @param namespaceURI the URI that identifies an XML namespace.
085: * @param qualifiedName The qualified name of the element type to instantiate
086: * @param page The page that contains this element
087: * @param attributes the initial attributes
088: */
089: HtmlCheckBoxInput(final String namespaceURI,
090: final String qualifiedName, final HtmlPage page,
091: final Map attributes) {
092: super (namespaceURI, qualifiedName, page, attributes);
093:
094: //From the checkbox creator
095: defaultCheckedState_ = isAttributeDefined("checked");
096:
097: // default value for both IE6 and Mozilla 1.7 even if spec says it is unspecified
098: if (getAttributeValue("value") == ATTRIBUTE_NOT_DEFINED) {
099: setAttributeValue("value", "on");
100: }
101: }
102:
103: /**
104: * {@inheritDoc}
105: * @see SubmittableElement#reset()
106: */
107: public void reset() {
108: setChecked(defaultCheckedState_);
109: }
110:
111: /**
112: * Set the "checked" attribute
113: *
114: * @param isChecked true if this element is to be selected
115: * @return The page that occupies this window after setting checked status.
116: * It may be the same window or it may be a freshly loaded one.
117: */
118: public Page setChecked(final boolean isChecked) {
119: if (isChecked) {
120: setAttributeValue("checked", "checked");
121: } else {
122: removeAttribute("checked");
123: }
124: return executeOnChangeHandlerIfAppropriate(this );
125: }
126:
127: /**
128: * A checkbox does not have a textual representation,
129: * but we invent one for it because it is useful for testing.
130: * @return "checked" or "unchecked" according to the radio state
131: */
132: public String asText() {
133: if (isChecked()) {
134: return "checked";
135: } else {
136: return "unchecked";
137: }
138: }
139:
140: /**
141: * Override so that checkbox can change its state correctly when its
142: * click() method is called.
143: *
144: * {@inheritDoc}
145: */
146: protected Page doClickAction(final Page defaultPage)
147: throws IOException {
148: setChecked(!isChecked());
149: return super .doClickAction(defaultPage);
150: }
151:
152: /**
153: * Both IE and Mozilla will first update the internal state of checkbox
154: * and then handle "onclick" event.
155: * {@inheritDoc}
156: */
157: protected boolean isStateUpdateFirst() {
158: return true;
159: }
160:
161: /**
162: * {@inheritDoc}
163: */
164: protected void preventDefault() {
165: setChecked(!isChecked());
166: }
167:
168: /**
169: * {@inheritDoc} Also sets the value to the new default value.
170: * @see SubmittableElement#setDefaultValue(String)
171: */
172: public void setDefaultValue(final String defaultValue) {
173: super .setDefaultValue(defaultValue);
174: setValueAttribute(defaultValue);
175: }
176:
177: /**
178: * {@inheritDoc}
179: * @see SubmittableElement#setDefaultChecked(boolean)
180: */
181: public void setDefaultChecked(final boolean defaultChecked) {
182: defaultCheckedState_ = defaultChecked;
183: if (getPage().getWebClient().getBrowserVersion().isNetscape()) {
184: setChecked(defaultChecked);
185: }
186: }
187:
188: /**
189: * {@inheritDoc}
190: * @see SubmittableElement#isDefaultChecked()
191: */
192: public boolean isDefaultChecked() {
193: return defaultCheckedState_;
194: }
195:
196: }
|