com.gargoylesoftware.htmlunit.html

Class HtmlLink

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

All Implemented Interfaces:

Serializable, Cloneable, Element, ElementTraversal, Node

public class HtmlLink
extends HtmlElement

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

Author:

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

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
String	getCharsetAttribute() Returns the value of the attribute charset.
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	getHrefLangAttribute() Returns the value of the attribute hreflang.
String	getMediaAttribute() Returns the value of the attribute media.
String	getRelAttribute() Returns the value of the attribute rel.
String	getRevAttribute() Returns the value of the attribute rev.
String	getTargetAttribute() Returns the value of the attribute target.
String	getTypeAttribute() Returns the value of the attribute type.
WebRequest	getWebRequest() Returns the request 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.
WebResponse	getWebResponse(boolean downloadIfNeeded, WebRequest request) INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. If the linked content is not already downloaded it triggers a download.
boolean	mayBeDisplayed() Returns true if nodes of this type can ever be displayed, false otherwise.

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

acceptChar, addHtmlAttributeChangeListener, appendChildIfNoneExists, checkChildHierarchy, detach, doType, doType, fireHtmlAttributeAdded, fireHtmlAttributeRemoved, fireHtmlAttributeReplaced, getCanonicalXPath, getElementsByAttribute, getEnclosingElement, getEnclosingForm, getEnclosingFormOrDie, getHtmlElementsByTagName, getHtmlElementsByTagNames, getLangAttribute, getNodeName, getOnClickAttribute, getOnDblClickAttribute, getOneHtmlElementByAttribute, getOnKeyDownAttribute, getOnKeyPressAttribute, getOnKeyUpAttribute, getOnMouseDownAttribute, getOnMouseMoveAttribute, getOnMouseOutAttribute, getOnMouseOverAttribute, getOnMouseUpAttribute, getSrcAttributeNormalized, getTabIndex, getTextDirectionAttribute, getXmlLangAttribute, handles, hasEventHandlers, isAltPressed, isAttributeCaseSensitive, isCtrlPressed, isDisplayed, isShiftPressed, isSubmittableByEnter, removeAttribute, removeChild, removeEventHandler, removeHtmlAttributeChangeListener, setAttributeNode, setAttributeNS, setEventHandler, setEventHandler, setId, type, type, type, type, typeDone

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

blur, click, click, click, cloneNode, dblClick, dblClick, doClickFireChangeEvent, doClickFireClickEvent, doClickStateUpdate, fireEvent, fireEvent, focus, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesMap, getChildElementCount, getChildElements, getElementsByTagName, getElementsByTagNameNS, getEventTargetElement, getFirstElementChild, getId, getLastElementChild, getNextElementSibling, getNodeType, getPreviousElementSibling, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, hasAttributes, isEmptyXmlTagExpanded, isMouseOver, isStateUpdateFirst, mouseDown, mouseDown, mouseMove, mouseMove, mouseOut, mouseOut, mouseOver, mouseOver, mouseUp, mouseUp, namespaces, preventDefault, printOpeningTagContentAsXml, printXml, propagateClickStateUpdateToParent, removeAttributeNode, removeAttributeNS, removeFocus, rightClick, rightClick, setAttribute, setAttributeNodeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, toString

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

getLocalName, getNamespaceURI, getPrefix, getQualifiedName, processImportNode, setPrefix

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

addCharacterDataChangeListener, addDomChangeListener, appendChild, asText, asXml, compareDocumentPosition, fireCharacterDataChanged, fireNodeAdded, fireNodeDeleted, getAncestors, getBaseURI, getByXPath, getByXPath, getChildNodes, getChildren, getDescendants, getDomElementDescendants, getEndColumnNumber, getEndLineNumber, getFeature, getFirstByXPath, getFirstByXPath, getFirstChild, getHtmlElementDescendants, getHtmlPageOrNull, getIndex, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getPage, getParentNode, getPreviousSibling, getReadyState, getScriptableObject, getStartColumnNumber, getStartLineNumber, getTextContent, getUserData, hasChildNodes, hasFeature, insertBefore, insertBefore, isAncestorOf, isAncestorOfAny, isAttachedToPage, isDefaultNamespace, isEqualNode, isSameNode, isSupported, isTrimmedText, lookupNamespaceURI, lookupPrefix, normalize, notifyIncorrectness, onAddedToDocumentFragment, onAddedToPage, onAllChildrenAddedToPage, printChildrenAsXml, querySelector, querySelectorAll, remove, removeAllChildren, removeCharacterDataChangeListener, removeChild, removeDomChangeListener, replace, replaceChild, setNextSibling, setNodeValue, setParentNode, setPreviousSibling, setReadyState, setScriptableObject, 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

getCharsetAttribute

public final 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 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 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 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 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 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 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 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 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:

IOException - if an error occurs while downloading the content

getWebResponse

public WebResponse getWebResponse(boolean downloadIfNeeded,
                         WebRequest request)
                           throws IOException

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - 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

request - the request; if null getWebRequest() is called to create one

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:

IOException - if an error occurs while downloading the content

getWebRequest

public WebRequest getWebRequest()
                         throws MalformedURLException

Returns the request which will allow us to retrieve the content referenced by the href attribute.

Returns:

the request which will allow us to retrieve the content referenced by the href attribute

Throws:

MalformedURLException - in case of problem resolving the URL

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

mayBeDisplayed

public boolean mayBeDisplayed()

Returns true if nodes of this type can ever be displayed, false otherwise. Examples of nodes that can never be displayed are <head>, <meta>, <script>, etc.

Overrides:

mayBeDisplayed in class DomNode

Returns:

true if nodes of this type can ever be displayed, false otherwise

See Also:

DomNode.isDisplayed()