com.gargoylesoftware.htmlunit.html
Class HtmlLink

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.HtmlLink
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, org.w3c.dom.Element, org.w3c.dom.Node

public class HtmlLink
extends ClickableElement

Wrapper for the HTML element "link". Note: This is not a clickable link, that one is an HtmlAnchor

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

Nested Class Summary
 
Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement
HtmlElement.ChildElementsIterator
 
Nested classes/interfaces inherited from class com.gargoylesoftware.htmlunit.html.DomNode
DomNode.ChildIterator, DomNode.DescendantElementsIterator
 
Field Summary
static java.lang.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
 java.lang.String getCharsetAttribute()
          Returns the value of the attribute "charset".
 java.lang.String getHrefAttribute()
          Returns the value of the attribute "href".
 java.lang.String getHrefLangAttribute()
          Returns the value of the attribute "hreflang".
 java.lang.String getMediaAttribute()
          Returns the value of the attribute "media".
 java.lang.String getRelAttribute()
          Returns the value of the attribute "rel".
 java.lang.String getRevAttribute()
          Returns the value of the attribute "rev".
 java.lang.String getTargetAttribute()
          Returns the value of the attribute "target".
 java.lang.String getTypeAttribute()
          Returns the value of the attribute "type".
 WebRequestSettings getWebRequestSettings()
          Returns the request settings which will allow us to retrieve the content referenced by the "href" attribute.
 WebResponse getWebResponse(boolean downloadIfNeeded)
          POTENIAL PERFORMANCE KILLER - DOWNLOADS THE RESOURCE - USE AT YOUR OWN RISK.
If the linked content is not already downloaded it triggers a download.
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.StyledElement
getClassAttribute, getIdAttribute, getStyleAttribute, getTitleAttribute
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.HtmlElement
addHtmlAttributeChangeListener, appendChildIfNoneExists, blur, checkChildHierarchy, click, click, click, dblClick, dblClick, doClickAction, doType, fireEvent, fireEvent, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, focus, getChildElements, getElementById, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getEventHandler, getHtmlElementsByTagName, getHtmlElementsByTagNames, getId, getLangAttribute, getNodeName, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, hasHtmlElementWithId, isAttributeCaseSensitive, isStateUpdateFirst, isSubmittableByEnter, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, preventDefault, removeAttribute, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, rightClick, rightClick, setAttributeNS, setEventHandler, setEventHandler, setId, toString, type, type, type, type
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.DomElement
cloneNode, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getElementsByTagName, getElementsByTagNameNS, getNodeType, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isEmptyXmlTagExpanded, namespaces, printOpeningTagContentAsXml, printXml, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNamespaceNode
getLocalName, getNamespaceURI, getPrefix, getQualifiedName, setPrefix
 
Methods inherited from class com.gargoylesoftware.htmlunit.html.DomNode
addDomChangeListener, appendChild, asText, asXml, compareDocumentPosition, fireNodeAdded, fireNodeDeleted, getAllHtmlChildElements, getAncestors, getBaseURI, getByXPath, getCanonicalXPath, getChildNodes, getChildren, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getPage, getParentNode, getPreviousSibling, getReadyState, getScriptObject, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, hasChildNodes, insertBefore, insertBefore, isAncestorOf, isBlock, isDefaultNamespace, isDisplayed, isEqualNode, isSameNode, isSupported, isTrimmedText, lookupNamespaceURI, lookupPrefix, normalize, notifyIncorrectness, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, remove, removeAllChildren, removeChild, removeDomChangeListener, replace, replaceChild, selectNodes, selectSingleNode, 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 java.lang.String TAG_NAME
The HTML tag represented by this element.

See Also:
Constant Field Values
Method Detail

getCharsetAttribute

public final java.lang.String getCharsetAttribute()
Returns the value of the attribute "charset". Refer to the HTML 4.01 documentation for details on the use of this attribute.

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

getHrefAttribute

public final java.lang.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.

getHrefLangAttribute

public final java.lang.String getHrefLangAttribute()
Returns the value of the attribute "hreflang". Refer to the HTML 4.01 documentation for details on the use of this attribute.

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

getTypeAttribute

public final java.lang.String getTypeAttribute()
Returns the value of the attribute "type". Refer to the HTML 4.01 documentation for details on the use of this attribute.

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

getRelAttribute

public final java.lang.String getRelAttribute()
Returns the value of the attribute "rel". Refer to the HTML 4.01 documentation for details on the use of this attribute.

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

getRevAttribute

public final java.lang.String getRevAttribute()
Returns the value of the attribute "rev". Refer to the HTML 4.01 documentation for details on the use of this attribute.

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

getMediaAttribute

public final java.lang.String getMediaAttribute()
Returns the value of the attribute "media". Refer to the HTML 4.01 documentation for details on the use of this attribute.

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

getTargetAttribute

public final java.lang.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.

getWebResponse

public WebResponse getWebResponse(boolean downloadIfNeeded)
                           throws java.io.IOException
POTENIAL PERFORMANCE KILLER - DOWNLOADS THE RESOURCE - USE AT YOUR OWN RISK.
If the linked content is not already downloaded it triggers a download. Then it stores the response for later use.

Parameters:
downloadIfNeeded - indicates if a request should be performed this hasn't been done previously
Returns:
null if no download should be performed and when this wasn't already done; the response received when performing a request for the content referenced by this tag otherwise
Throws:
java.io.IOException - if an error occurs while downloading the content

getWebRequestSettings

public WebRequestSettings getWebRequestSettings()
                                         throws java.net.MalformedURLException
Returns the request settings which will allow us to retrieve the content referenced by the "href" attribute.

Returns:
the request settings which will allow us to retrieve the content referenced by the "href" attribute
Throws:
java.net.MalformedURLException - in case of problem resolving the URL


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