com.gargoylesoftware.htmlunit.html.HtmlOption 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-2010 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 java.io.IOException;
import java.io.PrintWriter;
import java.util.Map;
import com.gargoylesoftware.htmlunit.BrowserVersionFeatures;
import com.gargoylesoftware.htmlunit.Page;
import com.gargoylesoftware.htmlunit.SgmlPage;
/**
* Wrapper for the HTML element "option".
*
* @version $Revision: 5783 $
* @author Mike Bowler
* @author David K. Taylor
* @author Christian Sell
* @author David D. Kilzer
* @author Marc Guillemot
* @author Ahmed Ashour
* @author Daniel Gredler
*/
public class HtmlOption extends HtmlElement implements DisabledElement {
private static final long serialVersionUID = 8995198439134305753L;
/** The HTML tag represented by this element. */
public static final String TAG_NAME = "option";
private final boolean initialSelectedState_;
private boolean selected_;
/**
* Creates an instance.
*
* @param namespaceURI the URI that identifies an XML namespace
* @param qualifiedName the qualified name of the element type to instantiate
* @param page the page that contains this element
* @param attributes the initial attributes
*/
HtmlOption(final String namespaceURI, final String qualifiedName, final SgmlPage page,
final Map attributes) {
super(namespaceURI, qualifiedName, page, attributes);
initialSelectedState_ = hasAttribute("selected");
}
/**
* Returns true if this option is currently selected.
* @return true if this option is currently selected
*/
public boolean isSelected() {
return hasAttribute("selected") || selected_;
}
/**
* Sets the selected state of this option. This will possibly also change the
* selected properties of sibling option elements.
*
* @param selected true if this option should be selected
* @return the page that occupies this window after this change is made (may or
* may not be the same as the original page)
*/
public Page setSelected(boolean selected) {
if (selected == isSelected()) {
return getPage();
}
final HtmlSelect select = getEnclosingSelect();
if (select != null) {
if (!select.isMultipleSelectEnabled() && select.getOptionSize() == 1) {
selected = true;
}
return select.setSelectedAttribute(this, selected);
}
// for instance from JS for an option created by document.createElement('option')
// and not yet added to a select
setSelectedInternal(selected);
return getPage();
}
/**
* {@inheritDoc}
*/
@Override
public void insertBefore(final DomNode newNode) throws IllegalStateException {
super.insertBefore(newNode);
if (newNode instanceof HtmlOption) {
final HtmlOption option = (HtmlOption) newNode;
if (option.isSelected()) {
getEnclosingSelect().setSelectedAttribute(option, true);
}
}
}
/**
* Gets the enclosing select of this option.
* @return null if no select is found (for instance malformed html)
*/
public HtmlSelect getEnclosingSelect() {
return (HtmlSelect) getEnclosingElement("select");
}
/**
* Resets the option to its original selected state.
*/
public void reset() {
setSelectedInternal(initialSelectedState_);
}
/**
* Returns the value of the attribute "selected". Refer to the
* HTML 4.01
* documentation for details on the use of this attribute.
*
* @return the value of the attribute "selected"
* or an empty string if that attribute isn't defined.
*/
public final String getSelectedAttribute() {
return getAttribute("selected");
}
/**
* Returns whether this Option is selected by default.
* That is whether the "selected"
* attribute exists when the Option is constructed. This also determines
* the value of getSelectedAttribute() after a reset() on the form.
* @return whether the option is selected by default
*/
public final boolean isDefaultSelected() {
return initialSelectedState_;
}
/**
* Returns true if the disabled attribute is set for this element. Note that this
* method always returns false when emulating IE, because IE does not allow individual
* options to be disabled.
*
* @return true if the disabled attribute is set for this element (always false
* when emulating IE)
*/
public final boolean isDisabled() {
if (getPage().getWebClient().getBrowserVersion().hasFeature(
BrowserVersionFeatures.HTMLOPTION_PREVENT_DISABLED)) {
return false;
}
return hasAttribute("disabled");
}
/**
* {@inheritDoc}
*/
public final String getDisabledAttribute() {
return getAttribute("disabled");
}
/**
* Returns the value of the attribute "label". Refer to the
* HTML 4.01
* documentation for details on the use of this attribute.
*
* @return the value of the attribute "label" or an empty string if that attribute isn't defined
*/
public final String getLabelAttribute() {
return getAttribute("label");
}
/**
* Sets the value of the attribute "label". Refer to the
* HTML 4.01
* documentation for details on the use of this attribute.
*
* @param newLabel the value of the attribute "label"
*/
public final void setLabelAttribute(final String newLabel) {
setAttribute("label", newLabel);
}
/**
* Returns the value of the attribute "value". Refer to the
* HTML 4.01
* documentation for details on the use of this attribute.
* @see
* initial value if value attribute is not set
* @return the value of the attribute "value"
*/
public final String getValueAttribute() {
String value = getAttribute("value");
if (value == ATTRIBUTE_NOT_DEFINED) {
value = getText();
}
return value;
}
/**
* Sets the value of the attribute "value". Refer to the
* HTML 4.01
* documentation for details on the use of this attribute.
*
* @param newValue the value of the attribute "value"
*/
public final void setValueAttribute(final String newValue) {
setAttribute("value", newValue);
}
/**
* Selects the option if it's not already selected.
* {@inheritDoc}
*/
@Override
protected void doClickAction() throws IOException {
if (!isSelected()) {
setSelected(true);
}
}
/**
* {@inheritDoc}
*/
@Override
protected void printOpeningTagContentAsXml(final PrintWriter printWriter) {
super.printOpeningTagContentAsXml(printWriter);
if (selected_ && getAttribute("selected") == ATTRIBUTE_NOT_DEFINED) {
printWriter.print(" selected=\"selected\"");
}
}
/**
* For internal use only.
* Sets/remove the selected attribute to reflect the select state
* @param selected the selected status
*/
void setSelectedInternal(final boolean selected) {
selected_ = selected;
if (!selected) {
removeAttribute("selected");
}
}
/**
* {@inheritDoc}
* This implementation will show the label attribute before the
* content of the tag if the attribute exists.
*/
// we need to preserve this method as it is there since many versions with the above documentation.
@Override
public String asText() {
return super.asText();
}
/**
* Sets the text for this HtmlOption.
* @param text the text
*/
public void setText(final String text) {
if ((text == null || text.length() == 0)
&& getPage().getWebClient().getBrowserVersion()
.hasFeature(BrowserVersionFeatures.HTMLOPTION_EMPTY_TEXT_IS_NO_CHILDREN)) {
removeAllChildren();
}
else {
final DomNode child = getFirstChild();
if (child == null) {
appendChild(new DomText(getPage(), text));
}
else {
child.setNodeValue(text);
}
}
}
/**
* Gets the text.
* @return the text of this option.
*/
public String getText() {
final HtmlSerializer ser = new HtmlSerializer();
ser.setIgnoreMaskedElements(false);
return ser.asText(this);
}
/**
* {@inheritDoc}
*/
protected DomNode getEventTargetElement() {
final HtmlSelect select = getEnclosingSelect();
if (select != null) {
return select;
}
return super.getEventTargetElement();
}
}