Package org.htmlunit.html

Class HtmlAnchor

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.w3c.dom.Element, org.w3c.dom.Node
    public class HtmlAnchor
extends HtmlElement
    Wrapper for the HTML element "a".
    See Also:
    Serialized Form

    • 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

      • click

        public <P extends Page> P click​(org.htmlunit.javascript.host.event.Event event,
                                boolean shiftKey,
                                boolean ctrlKey,
                                boolean altKey,
                                boolean ignoreVisibility)
                         throws java.io.IOException
        INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
        Simulates clicking on this element, returning the page in the window that has the focus after the element has been clicked. Note that the returned page may or may not be the same as the original page, depending on the type of element being clicked, the presence of JavaScript action listeners, etc.
        Overrides:
        click in class DomElement
        Type Parameters:
        P - the page type
        Parameters:
        event - the click event used
        shiftKey - true if SHIFT is pressed during the click
        ctrlKey - true if CTRL is pressed during the click
        altKey - true if ALT is pressed during the click
        ignoreVisibility - whether to ignore visibility or not
        Returns:
        the page contained in the current window as returned by WebClient.getCurrentWindow()
        Throws:
        java.io.IOException - if an IO error occurs

      • doClickStateUpdate

        protected void doClickStateUpdate​(boolean shiftKey,
                                  boolean ctrlKey,
                                  java.lang.String hrefSuffix)
                           throws java.io.IOException
        Same as doClickStateUpdate(boolean, boolean), except that it accepts an href suffix, needed when a click is performed on an image map to pass information on the click position.
        Parameters:
        shiftKey - true if SHIFT is pressed
        ctrlKey - true if CTRL is pressed
        hrefSuffix - the suffix to add to the anchor's href attribute (for instance coordinates from an image map)
        Throws:
        java.io.IOException - if an IO error occurs

      • getTargetUrl

        public static java.net.URL getTargetUrl​(java.lang.String href,
                                        HtmlPage page)
                                 throws java.net.MalformedURLException
        INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
        Parameters:
        href - the href
        page - the HtmlPage
        Returns:
        the calculated target url.
        Throws:
        java.net.MalformedURLException - if an IO error occurs

      • doClickStateUpdate

        protected boolean doClickStateUpdate​(boolean shiftKey,
                                     boolean ctrlKey)
                              throws java.io.IOException
        This method implements the control state update part of the click action.

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

        Overrides:
        doClickStateUpdate in class DomElement
        Parameters:
        shiftKey - true if SHIFT is pressed
        ctrlKey - true if CTRL is pressed
        Returns:
        true if doClickFireEvent method has to be called later on (to signal, that the value was changed)
        Throws:
        java.io.IOException - if an IO error occurs

      • 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

      • 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

      • getNameAttribute

        public final java.lang.String getNameAttribute()
        Returns the value of the attribute name. Refer to the HTML 4.01 documentation for details on the use of this attribute.
        Returns:
        the value of the attribute name 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

      • 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

      • getAccessKeyAttribute

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

      • getShapeAttribute

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

      • getTabIndexAttribute

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

      • getOnFocusAttribute

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

      • openLinkInNewWindow

        public final Page openLinkInNewWindow()
                               throws java.net.MalformedURLException
        Open this link in a new window, much as web browsers do when you shift-click a link or use the context menu to open in a new window.

        It should be noted that even web browsers will sometimes not give the expected result when using this method of following links. Links that have no real href and rely on JavaScript to do their work will fail.

        Returns:
        the page opened by this link, nested in a new TopLevelWindow
        Throws:
        java.net.MalformedURLException - if the href could not be converted to a valid URL

      • isEmptyXmlTagExpanded

        protected boolean isEmptyXmlTagExpanded()
        Description copied from class: DomElement
        Indicates if a node without children should be written in expanded form as XML (i.e. with closing tag rather than with "/>")
        Overrides:
        isEmptyXmlTagExpanded in class DomElement
        Returns:
        false by default

      • handles

        public boolean handles​(org.htmlunit.javascript.host.event.Event event)
        Indicates if the provided event can be applied to this node. Overwrite this.
        Overrides:
        handles in class HtmlElement
        Parameters:
        event - the event
        Returns:
        false if the event can't be applied

      • getPingAttribute

        public final java.lang.String getPingAttribute()
        Returns the value of the attribute ping.
        Returns:
        the value of the attribute ping

      • getDownloadAttribute

        public final java.lang.String getDownloadAttribute()
        Returns the value of the attribute download.
        Returns:
        the value of the attribute download