com.gargoylesoftware.htmlunit.html
Class HtmlArea

java.lang.Object
  extended by com.gargoylesoftware.htmlunit.html.DomNode
      extended by com.gargoylesoftware.htmlunit.html.DomNamespaceNode
          extended by com.gargoylesoftware.htmlunit.html.DomElement
              extended by com.gargoylesoftware.htmlunit.html.HtmlElement
                  extended by com.gargoylesoftware.htmlunit.html.StyledElement
                      extended by com.gargoylesoftware.htmlunit.html.ClickableElement
                          extended by com.gargoylesoftware.htmlunit.html.FocusableElement
                              extended by com.gargoylesoftware.htmlunit.html.HtmlArea
All Implemented Interfaces:
Serializable, Cloneable

public class HtmlArea
extends FocusableElement

Wrapper for the html element "area".

Version:
$Revision: 2132 $
Author:
Mike Bowler, David K. Taylor, Christian Sell, Marc Guillemot, Ahmed Ashour
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement
HtmlElement.ChildElementsIterator, HtmlElement.MapEntryWrappingIterator
 
Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomNode
DomNode.ChildIterator, DomNode.DescendantElementsIterator
 
Field Summary
static String TAG_NAME
          the HTML tag represented by this element
 
Fields inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement
ATTRIBUTE_NOT_DEFINED, ATTRIBUTE_VALUE_EMPTY, TAB_INDEX_OUT_OF_BOUNDS
 
Fields inherited from class com.gargoylesoftware.htmlunit.html.DomNode
ATTRIBUTE_NODE, COMMENT_NODE, DOCUMENT_NODE, ELEMENT_NODE, PROPERTY_ELEMENT, READY_STATE_COMPLETE, READY_STATE_INTERACTIVE, READY_STATE_LOADED, READY_STATE_LOADING, READY_STATE_UNINITIALIZED, TEXT_NODE
 
Constructor Summary
HtmlArea(HtmlPage page, Map attributes)
          Deprecated. You should not directly construct HtmlArea.
 
Method Summary
protected  Page doClickAction(Page defaultPage)
          This method will be called if there either wasn't an onclick handler or there was but the result of that handler was true.
 String getAccessKeyAttribute()
          Return the value of the attribute "accesskey".
 String getAltAttribute()
          Return the value of the attribute "alt".
 String getCoordsAttribute()
          Return the value of the attribute "coords".
 String getHrefAttribute()
          Return the value of the attribute "href".
 String getNoHrefAttribute()
          Return the value of the attribute "nohref".
 String getOnBlurAttribute()
          Return the value of the attribute "onblur".
 String getOnFocusAttribute()
          Return the value of the attribute "onfocus".
 String getShapeAttribute()
          Return the value of the attribute "shape".
 String getTabIndexAttribute()
          Return the value of the attribute "tabindex".
 String getTargetAttribute()
          Return the value of the attribute "target".
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.ClickableElement
click, click, click, dblClick, dblClick, getLangAttribute, getOnClickAttribute, getOnDblClickAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getTextDirectionAttribute, getXmlLangAttribute, isStateUpdateFirst
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.StyledElement
getClassAttribute, getIdAttribute, getStyleAttribute, getTitleAttribute, isRenderedVisible
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement
addHtmlAttributeChangeListener, appendChildIfNoneExists, assertNotEmpty, blur, cloneDomNode, cloneNode, fireEvent, fireEvent, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, focus, getAttribute, getAttributeEntriesIterator, getAttributeNS, getAttributeValue, getChildElementsIterator, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventHandler, getHtmlElementById, getHtmlElementsByAttribute, getHtmlElementsByTagName, getHtmlElementsByTagNames, getId, getNodeName, getNodeType, getOneHtmlElementByAttribute, getTabIndex, getTagName, hasAttribute, hasAttributeNS, hasAttributes, hasHtmlElementWithId, isAttributeDefined, isEmptyXmlTagExpanded, isSubmittableByEnter, keyDown, keyDown, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, notImplemented, preventDefault, printOpeningTagContentAsXml, printXml, removeAttribute, removeAttributeNS, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setAttribute, setAttributeNS, setAttributeValue, setAttributeValue, setEventHandler, setEventHandler, setId, toString, type, type, type, type
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNamespaceNode
getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNode
addDomChangeListener, addPropertyChangeListener, appendChild, appendDomChild, asText, asXml, fireNodeAdded, fireNodeDeleted, firePropertyChange, getAllHtmlChildElements, getByXPath, getChildIterator, getChildrenAsText, getEndColumnNumber, getEndLineNumber, getFirstByXPath, getFirstChild, getFirstDomChild, getLastChild, getLastDomChild, getLog, getNativePage, getNextDomSibling, getNextSibling, getNodeValue, getPage, getParentDomNode, getParentNode, getPreviousDomSibling, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, insertBefore, isAncestorOf, isTrimmedText, notifyIncorrectness, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, reduceWhitespace, remove, removeAllChildren, removeDomChangeListener, removePropertyChangeListener, replace, setNextSibling, setNodeValue, setParentNode, setPreviousSibling, setReadyState, setScriptObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TAG_NAME

public static final String TAG_NAME
the HTML tag represented by this element

See Also:
Constant Field Values
Constructor Detail

HtmlArea

public HtmlArea(HtmlPage page,
                Map attributes)
Deprecated. You should not directly construct HtmlArea.

Create an instance of HtmlArea

Parameters:
page - The HtmlPage that contains this element.
attributes - the initial attributes
Method Detail

doClickAction

protected Page doClickAction(Page defaultPage)
                      throws IOException
This method will be called if there either wasn't an onclick handler or there was but the result of that handler was true. This is the default behavior of clicking the element. The default implementation returns the current page - subclasses requiring different behavior (like HtmlSubmitInput) will override this method.

Overrides:
doClickAction in class ClickableElement
Parameters:
defaultPage - The default page to return if the action does not load a new page.
Returns:
The page that is currently loaded after execution of this method
Throws:
IOException - If an IO error occurred

getShapeAttribute

public final String getShapeAttribute()
Return 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()
Return 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()
Return 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()
Return 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()
Return 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()
Return 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()
Return 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()
Return 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()
Return 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()
Return 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.


Copyright © 2002-2010 Gargoyle Software Inc.. All Rights Reserved.