com.gargoylesoftware.htmlunit.html
Class HtmlOption

java.lang.Object
  com.gargoylesoftware.htmlunit.html.DomNode
      com.gargoylesoftware.htmlunit.html.DomNamespaceNode
          com.gargoylesoftware.htmlunit.html.DomElement
              com.gargoylesoftware.htmlunit.html.HtmlElement
                  com.gargoylesoftware.htmlunit.html.HtmlOption

All Implemented Interfaces:

DisabledElement, Serializable, Cloneable, Element, ElementTraversal, Node

public class HtmlOption
extends HtmlElement
implements DisabledElement

Wrapper for the HTML element "option".

Version:

$Revision: 8230 $

Author:

Mike Bowler, David K. Taylor, Christian Sell, David D. Kilzer, Marc Guillemot, Ahmed Ashour, Daniel Gredler, Ronald Brill

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomElement

DomElement.ChildElementsIterator

Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomNode

DomNode.ChildIterator, DomNode.DescendantElementsIterator<T extends DomNode>

Field Summary

static String

TAG_NAME The HTML tag represented by this element.

Fields inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

TAB_INDEX_OUT_OF_BOUNDS

Fields inherited from class com.gargoylesoftware.htmlunit.html.DomElement

ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY

Fields inherited from class com.gargoylesoftware.htmlunit.html.DomNode

AS_TEXT_BLANK, AS_TEXT_BLOCK_SEPARATOR, AS_TEXT_NEW_LINE, AS_TEXT_TAB, PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Method Summary

String	asText() Returns a textual representation of this element that represents what would be visible to the user if this page was shown in a web browser.
protected ScriptResult	doClickFireClickEvent(Event event) This method implements the control onclick handler call during the click action.
protected boolean	doClickStateUpdate() Selects the option if it's not already selected.
String	getDisabledAttribute() Returns the value of the attribute "disabled".
HtmlSelect	getEnclosingSelect() Gets the enclosing select of this option.
protected DomNode	getEventTargetElement() Returns the event target element.
String	getLabelAttribute() Returns the value of the attribute "label".
String	getSelectedAttribute() Returns the value of the attribute "selected".
String	getText() Gets the text.
String	getValueAttribute() Returns the value of the attribute "value".
void	insertBefore(DomNode newNode) Inserts a new child node before this node into the child relationship this node is a part of.
boolean	isDefaultSelected() Returns whether this Option is selected by default.
boolean	isDisabled() Returns true if the disabled attribute is set for this element.
boolean	isSelected() Returns true if this option is currently selected.
protected boolean	isStateUpdateFirst() Returns true if state updates should be done before onclick event handling.
Page	mouseDown(boolean shiftKey, boolean ctrlKey, boolean altKey, int button) Selects the option if it's not already selected.
Page	mouseUp(boolean shiftKey, boolean ctrlKey, boolean altKey, int button) Selects the option if it's not already selected.
protected void	printOpeningTagContentAsXml(PrintWriter printWriter) Prints the content between "<" and ">" (or "/>") in the output of the tag name and its attributes in XML format.
void	reset() Resets the option to its original selected state.
void	setLabelAttribute(String newLabel) Sets the value of the attribute "label".
Page	setSelected(boolean selected) Sets the selected state of this option.
void	setSelected(boolean selected, boolean invokeOnFocus) INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. Sets the selected state of this option.
void	setText(String text) Sets the text for this HtmlOption.
void	setValueAttribute(String newValue) Sets the value of the attribute "value".

Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement

addHtmlAttributeChangeListener, appendChildIfNoneExists, blur, checkChildHierarchy, click, click, click, dblClick, dblClick, doClickFireChangeEvent, doType, fireEvent, fireEvent, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, focus, getCanonicalXPath, getElementById, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getHtmlElementsByTagName, getHtmlElementsByTagNames, getLangAttribute, getNodeName, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, hasEventHandlers, hasHtmlElementWithId, isAttributeCaseSensitive, isSubmittableByEnter, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, preventDefault, querySelector, querySelectorAll, removeAttribute, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setAttributeNS, setEventHandler, setEventHandler, setId, toString, type, type, type, type, type, type

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomElement

cloneNode, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getChildElementCount, getChildElements, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getId, getLastElementChild, getNextElementSibling, getNodeType, getPreviousElementSibling, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isEmptyXmlTagExpanded, namespaces, printXml, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNamespaceNode

getLocalName, getNamespaceURI, getPrefix, getQualifiedName, processImportNode, setPrefix

Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNode

addDomChangeListener, appendChild, asXml, compareDocumentPosition, detach, fireNodeAdded, fireNodeDeleted, getAncestors, getBaseURI, getByXPath, getByXPath, getChildNodes, getChildren, getDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getHtmlPageOrNull, getIndex, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getPage, getParentNode, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, hasChildNodes, hasFeature, insertBefore, isAncestorOf, isAncestorOfAny, isBlock, isDefaultNamespace, isDescendant, isDirectlyAttachedToPage, isDisplayed, isEqualNode, isSameNode, isSupported, isTrimmedText, lookupNamespaceURI, lookupPrefix, mayBeDisplayed, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, remove, removeAllChildren, removeChild, removeDomChangeListener, replace, replaceChild, setNextSibling, setNodeValue, setParentNode, setPreviousSibling, setReadyState, setScriptObject, setTextContent, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

appendChild, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

TAG_NAME

public static final String TAG_NAME

The HTML tag represented by this element.

See Also:

Constant Field Values

Method Detail

isSelected

public boolean isSelected()

Returns true if this option is currently selected.

Returns:

true if this option is currently selected

setSelected

public Page setSelected(boolean selected)

Sets the selected state of this option. This will possibly also change the selected properties of sibling option elements.

Parameters:

selected - true if this option should be selected

Returns:

the page that occupies this window after this change is made (may or may not be the same as the original page)

setSelected

public void setSelected(boolean selected,
                        boolean invokeOnFocus)

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Sets the selected state of this option. This will possibly also change the selected properties of sibling option elements.

Parameters:

selected - true if this option should be selected

invokeOnFocus - whether to set focus or not.

insertBefore

public void insertBefore(DomNode newNode)
                  throws IllegalStateException

Inserts a new child node before this node into the child relationship this node is a part of. If the specified node is this node, this method is a no-op.

Overrides:

insertBefore in class DomNode

Parameters:

newNode - the new node to insert

Throws:

IllegalStateException - if this node is not a child of any other node

getEnclosingSelect

public HtmlSelect getEnclosingSelect()

Gets the enclosing select of this option.

Returns:

null if no select is found (for instance malformed HTML)

reset

public void reset()

Resets the option to its original selected state.

getSelectedAttribute

public final String getSelectedAttribute()

Returns the value of the attribute "selected". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute "selected" or an empty string if that attribute isn't defined.

isDefaultSelected

public final boolean isDefaultSelected()

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.

Returns:

whether the option is selected by default

isDisabled

public final boolean isDisabled()

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.

Specified by:

isDisabled in interface DisabledElement

Returns:

true if the disabled attribute is set for this element (always false when emulating IE)

getDisabledAttribute

public final String getDisabledAttribute()

Returns the value of the attribute "disabled". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Specified by:

getDisabledAttribute in interface DisabledElement

Returns:

the value of the attribute "disabled" or an empty string if that attribute isn't defined

getLabelAttribute

public final String getLabelAttribute()

Returns the value of the attribute "label". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute "label" or an empty string if that attribute isn't defined

setLabelAttribute

public final void setLabelAttribute(String newLabel)

Sets the value of the attribute "label". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Parameters:

newLabel - the value of the attribute "label"

getValueAttribute

public final String getValueAttribute()

Returns the value of the attribute "value". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Returns:

the value of the attribute "value"

See Also:

initial value if value attribute is not set

setValueAttribute

public final void setValueAttribute(String newValue)

Sets the value of the attribute "value". Refer to the HTML 4.01 documentation for details on the use of this attribute.

Parameters:

newValue - the value of the attribute "value"

mouseDown

public Page mouseDown(boolean shiftKey,
                      boolean ctrlKey,
                      boolean altKey,
                      int button)

Selects the option if it's not already selected. Simulates clicking the mouse on this element, returning the page which this element's window contains after the mouse click. The returned page may or may not be the same as the original page, depending on JavaScript event handlers, etc.

Overrides:

mouseDown in class HtmlElement

Parameters:

shiftKey - true if SHIFT is pressed during the mouse click

ctrlKey - true if CTRL is pressed during the mouse click

altKey - true if ALT is pressed during the mouse click

button - the button code, must be MouseEvent.BUTTON_LEFT, MouseEvent.BUTTON_MIDDLE or MouseEvent.BUTTON_RIGHT

Returns:

the page which this element's window contains after the mouse click

mouseUp

public Page mouseUp(boolean shiftKey,
                    boolean ctrlKey,
                    boolean altKey,
                    int button)

Selects the option if it's not already selected. Simulates releasing the mouse click on this element, returning the page which this element's window contains after the mouse click release. The returned page may or may not be the same as the original page, depending on JavaScript event handlers, etc.

Overrides:

mouseUp in class HtmlElement

Parameters:

shiftKey - true if SHIFT is pressed during the mouse click release

ctrlKey - true if CTRL is pressed during the mouse click release

altKey - true if ALT is pressed during the mouse click release

button - the button code, must be MouseEvent.BUTTON_LEFT, MouseEvent.BUTTON_MIDDLE or MouseEvent.BUTTON_RIGHT

Returns:

the page which this element's window contains after the mouse click release

doClickStateUpdate

protected boolean doClickStateUpdate()
                              throws IOException

Selects the option if it's not already selected. This method implements the control state update part of the click action.

The default implementation only calls doClickStateUpdate on parent's HtmlElement (if any). Subclasses requiring different behavior (like HtmlSubmitInput) will override this method.

Overrides:

doClickStateUpdate in class HtmlElement

Returns:

true if doClickFireEvent method has to be called later on (to signal, that the value was changed)

Throws:

IOException - if an IO error occurs

doClickFireClickEvent

protected ScriptResult doClickFireClickEvent(Event event)
                                      throws IOException

This method implements the control onclick handler call during the click action.

Overrides:

doClickFireClickEvent in class HtmlElement

Parameters:

event - the click event used

Returns:

the script result

Throws:

IOException - if an IO error occurs

printOpeningTagContentAsXml

protected void printOpeningTagContentAsXml(PrintWriter printWriter)

Prints the content between "<" and ">" (or "/>") in the output of the tag name and its attributes in XML format.

Overrides:

printOpeningTagContentAsXml in class DomElement

Parameters:

printWriter - the writer to print in

asText

public String asText()

Returns a textual representation of this element that represents what would be visible to the user if this page was shown in a web browser. For example, a single-selection select element would return the currently selected value as text. This implementation will show the label attribute before the content of the tag if the attribute exists.

Overrides:

asText in class DomNode

Returns:

a textual representation of this element that represents what would be visible to the user if this page was shown in a web browser

setText

public void setText(String text)

Sets the text for this HtmlOption.

Parameters:

text - the text

getText

public String getText()

Gets the text.

Returns:

the text of this option.

getEventTargetElement

protected DomNode getEventTargetElement()

Returns the event target element. This could be overridden by subclasses to have other targets. The default implementation returns 'this'.

Overrides:

getEventTargetElement in class HtmlElement

Returns:

the event target element.

isStateUpdateFirst

protected boolean isStateUpdateFirst()

Returns true if state updates should be done before onclick event handling. This method returns false by default, and is expected to be overridden to return true by derived classes like HtmlCheckBoxInput.

Overrides:

isStateUpdateFirst in class HtmlElement

Returns:

true if state updates should be done before onclick event handling