com.gargoylesoftware.htmlunit.html

Class HtmlArea

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.HtmlArea

All Implemented Interfaces:

Serializable, Cloneable, Element, ElementTraversal, Node

public class HtmlArea
extends HtmlElement

Wrapper for the HTML element "area".

Version:

$Revision: 10214 $

Author:

Mike Bowler, David K. Taylor, Christian Sell, Marc Guillemot, Ahmed Ashour, Frank Danek

See Also:

Serialized Form

Nested Class Summary

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

HtmlElement.DisplayStyle

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

Fields

Modifier and Type	Field and Description
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

Methods

Modifier and Type	Method and Description
protected boolean	doClickStateUpdate() This method implements the control state update part of the click action.
String	getAccessKeyAttribute() Returns the value of the attribute "accesskey".
String	getAltAttribute() Returns the value of the attribute "alt".
String	getCoordsAttribute() Returns the value of the attribute "coords".
HtmlElement.DisplayStyle	getDefaultStyleDisplay() INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. Returns the default display style.
String	getHrefAttribute() Returns the value of the attribute "href".
String	getNoHrefAttribute() Returns the value of the attribute "nohref".
String	getOnBlurAttribute() Returns the value of the attribute "onblur".
String	getOnFocusAttribute() Returns the value of the attribute "onfocus".
String	getShapeAttribute() Returns the value of the attribute "shape".
String	getTabIndexAttribute() Returns the value of the attribute "tabindex".
String	getTargetAttribute() Returns the value of the attribute "target".
boolean	isDisplayed() Returns true if this node is displayed and can be visible to the user (ignoring screen size, scrolling limitations, color, font-size, or overlapping nodes).

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

addHtmlAttributeChangeListener, appendChildIfNoneExists, blur, checkChildHierarchy, click, click, click, dblClick, dblClick, doClickFireChangeEvent, doClickFireClickEvent, doType, fireEvent, fireEvent, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, focus, getCanonicalXPath, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventTargetElement, getHtmlElementsByTagName, getHtmlElementsByTagNames, getLangAttribute, getNodeName, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getSrcAttributeNormalized, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, hasEventHandlers, isAttributeCaseSensitive, isStateUpdateFirst, isSubmittableByEnter, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, preventDefault, propagateClickStateUpdateToParent, querySelector, querySelectorAll, removeAttribute, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setAttributeNode, 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, printOpeningTagContentAsXml, printXml, removeAttributeNode, removeAttributeNS, setAttribute, 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, asText, 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, insertBefore, isAncestorOf, isAncestorOfAny, isBlock, isDefaultNamespace, isDescendant, isDirectlyAttachedToPage, 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

doClickStateUpdate

protected boolean doClickStateUpdate()
                              throws IOException

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

getShapeAttribute

public final String getShapeAttribute()

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

Returns:

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

getCoordsAttribute

public final String getCoordsAttribute()

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

Returns:

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

getHrefAttribute

public final String getHrefAttribute()

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

Returns:

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

getNoHrefAttribute

public final String getNoHrefAttribute()

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

Returns:

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

getAltAttribute

public final String getAltAttribute()

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

Returns:

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

getTabIndexAttribute

public final String getTabIndexAttribute()

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

Returns:

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

getAccessKeyAttribute

public final String getAccessKeyAttribute()

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

Returns:

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

getOnFocusAttribute

public final String getOnFocusAttribute()

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

Returns:

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

getOnBlurAttribute

public final String getOnBlurAttribute()

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

Returns:

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

getTargetAttribute

public final String getTargetAttribute()

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

Returns:

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

getDefaultStyleDisplay

public HtmlElement.DisplayStyle getDefaultStyleDisplay()

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
Returns the default display style.

Overrides:

getDefaultStyleDisplay in class HtmlElement

Returns:

the default display style

isDisplayed

public boolean isDisplayed()

Returns true if this node is displayed and can be visible to the user (ignoring screen size, scrolling limitations, color, font-size, or overlapping nodes).

NOTE: If CSS is disabled, this method does not take this element's style into consideration!

Overrides:

isDisplayed in class DomNode

Returns:

true if the node is visible to the user, false otherwise

See Also:

CSS2 Visibility, CSS2 Display, MSDN Documentation, DomNode.mayBeDisplayed()