org.htmlunit.html.HtmlRadioButtonInput Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of xlt Show documentation
Show all versions of xlt Show documentation
XLT (Xceptance LoadTest) is an extensive load and performance test tool developed and maintained by Xceptance.
/*
* Copyright (c) 2002-2024 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
* https://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 org.htmlunit.html;
import static org.htmlunit.BrowserVersionFeatures.EVENT_ONCHANGE_AFTER_ONCLICK;
import static org.htmlunit.BrowserVersionFeatures.HTMLINPUT_CHECKBOX_DOES_NOT_CLICK_SURROUNDING_ANCHOR;
import java.io.IOException;
import java.util.Map;
import org.htmlunit.Page;
import org.htmlunit.ScriptResult;
import org.htmlunit.SgmlPage;
import org.htmlunit.javascript.host.event.Event;
/**
* Wrapper for the HTML element "input".
*
* @author Mike Bowler
* @author David K. Taylor
* @author Christian Sell
* @author Marc Guillemot
* @author Mike Bresnahan
* @author Daniel Gredler
* @author Bruce Faulkner
* @author Ahmed Ashour
* @author Benoit Heinrich
* @author Ronald Brill
* @author Frank Danek
*/
public class HtmlRadioButtonInput extends HtmlInput implements LabelableElement {
/**
* 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
* 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
*/
HtmlRadioButtonInput(final String qualifiedName, final SgmlPage page,
final Map attributes) {
super(qualifiedName, page, attributes);
if (getAttributeDirect(VALUE_ATTRIBUTE) == ATTRIBUTE_NOT_DEFINED) {
setRawValue(DEFAULT_VALUE);
}
defaultCheckedState_ = hasAttribute(ATTRIBUTE_CHECKED);
checkedState_ = 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}
* @see SubmittableElement#reset()
*/
@Override
public void reset() {
setChecked(defaultCheckedState_);
}
void setCheckedInternal(final boolean isChecked) {
checkedState_ = isChecked;
}
/**
* Sets the {@code checked} attribute.
*
* @param isChecked true if this element is to be selected
* @return the page that occupies this window after setting checked status
* It may be the same window or it may be a freshly loaded one.
*/
@Override
public Page setChecked(final boolean isChecked) {
Page page = getPage();
final boolean changed = isChecked() != isChecked;
checkedState_ = isChecked;
if (isChecked) {
final HtmlForm form = getEnclosingForm();
if (form != null) {
form.setCheckedRadioButton(this);
}
else if (page != null && page.isHtmlPage()) {
setCheckedForPage((HtmlPage) page);
}
}
if (changed) {
final ScriptResult scriptResult = fireEvent(Event.TYPE_CHANGE);
if (scriptResult != null && page != null) {
page = page.getEnclosingWindow().getWebClient().getCurrentWindow().getEnclosedPage();
}
}
return page;
}
/**
* Override of default clickAction that makes this radio button the selected
* one when it is clicked.
* {@inheritDoc}
*
* @throws IOException if an IO error occurred
*/
@Override
protected boolean doClickStateUpdate(final boolean shiftKey, final boolean ctrlKey) throws IOException {
final HtmlForm form = getEnclosingForm();
final boolean changed = !isChecked();
final Page page = getPage();
if (form != null) {
form.setCheckedRadioButton(this);
}
else if (page != null && page.isHtmlPage()) {
setCheckedForPage((HtmlPage) page);
}
super.doClickStateUpdate(shiftKey, ctrlKey);
return changed;
}
/**
* Select the specified radio button in the page (outside any <form>).
*/
private void setCheckedForPage(final HtmlPage htmlPage) {
final String name = getNameAttribute();
for (final HtmlElement htmlElement : htmlPage.getHtmlElementDescendants()) {
if (htmlElement instanceof HtmlRadioButtonInput) {
final HtmlRadioButtonInput radioInput = (HtmlRadioButtonInput) htmlElement;
if (name.equals(radioInput.getAttribute(DomElement.NAME_ATTRIBUTE))
&& radioInput.getEnclosingForm() == null) {
if (radioInput == this) {
setCheckedInternal(true);
}
else {
radioInput.setCheckedInternal(false);
}
}
}
}
}
/**
* {@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);
}
}
/**
* {@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);
setValue(defaultValue);
}
/**
* {@inheritDoc}
* Also sets the default value.
*/
@Override
public void setValue(final String newValue) {
super.setValue(newValue);
super.setDefaultValue(newValue);
}
/**
* {@inheritDoc}
* @see SubmittableElement#setDefaultChecked(boolean)
*/
@Override
public void setDefaultChecked(final boolean defaultChecked) {
defaultCheckedState_ = defaultChecked;
setChecked(isDefaultChecked());
}
/**
* {@inheritDoc}
* @see SubmittableElement#isDefaultChecked()
*/
@Override
public boolean isDefaultChecked() {
return defaultCheckedState_;
}
/**
* {@inheritDoc}
*/
@Override
protected boolean isStateUpdateFirst() {
return true;
}
/**
* {@inheritDoc}
*/
@Override
protected void onAddedToPage() {
super.onAddedToPage();
setChecked(isChecked());
}
@Override
protected Object getInternalValue() {
return isChecked();
}
@Override
void handleFocusLostValueChanged() {
// ignore
}
/**
* {@inheritDoc}
*/
@Override
protected void setAttributeNS(final String namespaceURI, final String qualifiedName, final String attributeValue,
final boolean notifyAttributeChangeListeners, final boolean notifyMutationObservers) {
final String qualifiedNameLC = org.htmlunit.util.StringUtils.toRootLowerCase(qualifiedName);
if (VALUE_ATTRIBUTE.equals(qualifiedNameLC)) {
super.setAttributeNS(namespaceURI, qualifiedNameLC, attributeValue, notifyAttributeChangeListeners,
notifyMutationObservers);
setRawValue(attributeValue);
return;
}
if (ATTRIBUTE_CHECKED.equals(qualifiedNameLC)) {
checkedState_ = true;
}
super.setAttributeNS(namespaceURI, qualifiedNameLC, attributeValue, notifyAttributeChangeListeners,
notifyMutationObservers);
}
/**
* {@inheritDoc}
*/
@Override
protected boolean propagateClickStateUpdateToParent() {
return !hasFeature(HTMLINPUT_CHECKBOX_DOES_NOT_CLICK_SURROUNDING_ANCHOR)
&& super.propagateClickStateUpdateToParent();
}
@Override
public boolean isValueMissingValidityState() {
if (ATTRIBUTE_NOT_DEFINED == getAttributeDirect(ATTRIBUTE_REQUIRED)) {
return false;
}
if (ATTRIBUTE_NOT_DEFINED == getNameAttribute()) {
return false;
}
final String name = getNameAttribute();
for (final HtmlElement htmlElement : getPage().getHtmlElementDescendants()) {
if (htmlElement instanceof HtmlRadioButtonInput) {
final HtmlRadioButtonInput radioInput = (HtmlRadioButtonInput) htmlElement;
if (name.equals(radioInput.getAttribute(DomElement.NAME_ATTRIBUTE))
&& radioInput.isChecked()) {
return false;
}
}
}
return true;
}
}