com.gargoylesoftware.htmlunit.html.HtmlCheckBoxInput Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of htmlunit Show documentation
Show all versions of htmlunit Show documentation
A headless browser intended for use in testing web-based applications.
/*
* Copyright (c) 2002-2016 Gargoyle Software Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.gargoylesoftware.htmlunit.html;
import static com.gargoylesoftware.htmlunit.BrowserVersionFeatures.EVENT_ONCHANGE_AFTER_ONCLICK;
import static com.gargoylesoftware.htmlunit.BrowserVersionFeatures.HTMLINPUT_CHECKBOX_DOES_NOT_CLICK_SURROUNDING_ANCHOR;
import java.io.IOException;
import java.util.Map;
import com.gargoylesoftware.htmlunit.Page;
import com.gargoylesoftware.htmlunit.ScriptResult;
import com.gargoylesoftware.htmlunit.SgmlPage;
import com.gargoylesoftware.htmlunit.javascript.host.event.Event;
/**
* Wrapper for the HTML element "input".
*
* @author Mike Bowler
* @author David K. Taylor
* @author Jun Chen
* @author Christian Sell
* @author Marc Guillemot
* @author Mike Bresnahan
* @author Daniel Gredler
* @author Ahmed Ashour
* @author Ronald Brill
* @author Frank Danek
*/
public class HtmlCheckBoxInput extends HtmlInput {
/**
* Value to use if no specified value attribute.
*/
private static final String DEFAULT_VALUE = "on";
private boolean defaultCheckedState_;
private boolean checkedState_;
/**
* Creates an instance.
* If no value is specified, it is set to "on" as browsers do (e.g. IE6 and Mozilla 1.7)
* even if spec says that it is not allowed
* (W3C).
*
* @param qualifiedName the qualified name of the element type to instantiate
* @param page the page that contains this element
* @param attributes the initial attributes
*/
HtmlCheckBoxInput(final String qualifiedName, final SgmlPage page,
final Map attributes) {
// default value for both IE6 and Mozilla 1.7 even if spec says it is unspecified
super(qualifiedName, page, addValueIfNeeded(page, attributes));
// fix the default value in case we have set it
if (getAttribute("value") == DEFAULT_VALUE) {
setDefaultValue(ATTRIBUTE_NOT_DEFINED, false);
}
defaultCheckedState_ = hasAttribute("checked");
checkedState_ = defaultCheckedState_;
}
/**
* Add missing attribute if needed by fixing attribute map rather to add it afterwards as this second option
* triggers the instantiation of the script object at a time where the DOM node has not yet been added to its
* parent.
*/
private static Map addValueIfNeeded(final SgmlPage page,
final Map attributes) {
for (final String key : attributes.keySet()) {
if ("value".equalsIgnoreCase(key)) {
return attributes; // value attribute was specified
}
}
// value attribute was not specified, add it
final DomAttr newAttr = new DomAttr(page, null, "value", DEFAULT_VALUE, true);
attributes.put("value", newAttr);
return attributes;
}
/**
* {@inheritDoc}
*
* @see SubmittableElement#reset()
*/
@Override
public void reset() {
setChecked(defaultCheckedState_);
}
/**
* Returns {@code true} if this element is currently selected.
* @return {@code true} if this element is currently selected
*/
@Override
public boolean isChecked() {
return checkedState_;
}
/**
* {@inheritDoc}
*/
@Override
public Page setChecked(final boolean isChecked) {
checkedState_ = isChecked;
return executeOnChangeHandlerIfAppropriate(this);
}
/**
* A checkbox does not have a textual representation,
* but we invent one for it because it is useful for testing.
* @return "checked" or "unchecked" according to the radio state
*/
// we need to preserve this method as it is there since many versions with the above documentation.
@Override
public String asText() {
return super.asText();
}
/**
* {@inheritDoc}
*/
@Override
protected boolean doClickStateUpdate() throws IOException {
checkedState_ = !isChecked();
super.doClickStateUpdate();
return true;
}
/**
* {@inheritDoc}
*/
@Override
protected ScriptResult doClickFireClickEvent(final Event event) {
if (!hasFeature(EVENT_ONCHANGE_AFTER_ONCLICK)) {
executeOnChangeHandlerIfAppropriate(this);
}
return super.doClickFireClickEvent(event);
}
/**
* {@inheritDoc}
*/
@Override
protected void doClickFireChangeEvent() {
if (hasFeature(EVENT_ONCHANGE_AFTER_ONCLICK)) {
executeOnChangeHandlerIfAppropriate(this);
}
}
/**
* Both IE and Mozilla will first update the internal state of checkbox
* and then handle "onclick" event.
* {@inheritDoc}
*/
@Override
protected boolean isStateUpdateFirst() {
return true;
}
/**
* {@inheritDoc}
*/
@Override
protected void preventDefault() {
checkedState_ = !checkedState_;
}
/**
* {@inheritDoc} Also sets the value to the new default value.
* @see SubmittableElement#setDefaultValue(String)
*/
@Override
public void setDefaultValue(final String defaultValue) {
super.setDefaultValue(defaultValue);
setValueAttribute(defaultValue);
}
/**
* {@inheritDoc}
* @see SubmittableElement#setDefaultChecked(boolean)
*/
@Override
public void setDefaultChecked(final boolean defaultChecked) {
defaultCheckedState_ = defaultChecked;
setChecked(defaultChecked);
}
/**
* {@inheritDoc}
* @see SubmittableElement#isDefaultChecked()
*/
@Override
public boolean isDefaultChecked() {
return defaultCheckedState_;
}
@Override
Object getInternalValue() {
return isChecked();
}
@Override
void handleFocusLostValueChanged() {
}
/**
* {@inheritDoc}
*/
@Override
public void setAttributeNS(final String namespaceURI, final String qualifiedName, final String attributeValue) {
if ("value".equals(qualifiedName)) {
setDefaultValue(attributeValue, false);
}
if ("checked".equals(qualifiedName)) {
checkedState_ = true;
}
super.setAttributeNS(namespaceURI, qualifiedName, attributeValue);
}
/**
* {@inheritDoc}
*/
@Override
protected boolean propagateClickStateUpdateToParent() {
return !hasFeature(HTMLINPUT_CHECKBOX_DOES_NOT_CLICK_SURROUNDING_ANCHOR)
&& super.propagateClickStateUpdateToParent();
}
}