Class Anchor

    • Field Detail

      • DEFAULT_DIRECTION_ESTIMATOR

        public static final DirectionEstimator DEFAULT_DIRECTION_ESTIMATOR
    • Constructor Detail

      • Anchor

        public Anchor()
        Creates an empty anchor.

        The anchor's href is not set, which means that the widget will not not be styled with the browser's native link styles (such as underline and font color). Use Anchor(boolean) to add a default no-op href that does not open a link but ensures the native link styles are applied.

        See Also:
        Anchor(boolean)
      • Anchor

        public Anchor​(boolean useDefaultHref)
        Creates an anchor. The anchor's href is optionally set to javascript:;, based on the expectation that listeners will be added to the anchor.
        Parameters:
        useDefaultHref - true to set the default href to javascript:;, false to leave it blank
      • Anchor

        public Anchor​(SafeHtml html)
        Creates an anchor for scripting.
        Parameters:
        html - the anchor's html
      • Anchor

        public Anchor​(SafeHtml html,
                      HasDirection.Direction dir)
        Creates an anchor for scripting. The anchor's href is set to javascript : ;, based on the expectation that listeners will be added to the anchor.
        Parameters:
        html - the anchor's html
        dir - the html's direction
      • Anchor

        public Anchor​(SafeHtml html,
                      DirectionEstimator directionEstimator)
        Creates an anchor for scripting. The anchor's href is set to javascript : ;, based on the expectation that listeners will be added to the anchor.
        Parameters:
        html - the anchor's html
        directionEstimator - A DirectionEstimator object used for automatic direction adjustment. For convenience, DEFAULT_DIRECTION_ESTIMATOR can be used.
      • Anchor

        public Anchor​(java.lang.String text)
        Creates an anchor for scripting. The anchor's href is set to javascript:;, based on the expectation that listeners will be added to the anchor.
        Parameters:
        text - the anchor's text
      • Anchor

        public Anchor​(java.lang.String text,
                      HasDirection.Direction dir)
        Creates an anchor for scripting. The anchor's href is set to javascript : ;, based on the expectation that listeners will be added to the anchor.
        Parameters:
        text - the anchor's text
        dir - the text's direction
      • Anchor

        public Anchor​(java.lang.String text,
                      DirectionEstimator directionEstimator)
        Creates an anchor for scripting. The anchor's href is set to javascript : ;, based on the expectation that listeners will be added to the anchor.
        Parameters:
        text - the anchor's text
        directionEstimator - A DirectionEstimator object used for automatic direction adjustment. For convenience, DEFAULT_DIRECTION_ESTIMATOR can be used.
      • Anchor

        public Anchor​(java.lang.String text,
                      boolean asHtml)
        Creates an anchor for scripting. The anchor's href is set to javascript:;, based on the expectation that listeners will be added to the anchor.
        Parameters:
        text - the anchor's text
        asHtml - true to treat the specified text as html
      • Anchor

        public Anchor​(SafeHtml html,
                      java.lang.String href)
        Creates an anchor with its html and href (target URL) specified.
        Parameters:
        html - the anchor's html
        href - the url to which it will link
      • Anchor

        public Anchor​(SafeHtml html,
                      SafeUri href)
        Creates an anchor with its html and href (target URL) specified.
        Parameters:
        html - the anchor's html
        href - the url to which it will link
      • Anchor

        public Anchor​(SafeHtml html,
                      HasDirection.Direction dir,
                      java.lang.String href)
        Creates an anchor with its html and href (target URL) specified.
        Parameters:
        html - the anchor's html
        dir - the html's direction
        href - the url to which it will link
      • Anchor

        public Anchor​(SafeHtml html,
                      HasDirection.Direction dir,
                      SafeUri href)
        Creates an anchor with its html and href (target URL) specified.
        Parameters:
        html - the anchor's html
        dir - the html's direction
        href - the url to which it will link
      • Anchor

        public Anchor​(SafeHtml html,
                      DirectionEstimator directionEstimator,
                      java.lang.String href)
        Creates an anchor with its html and href (target URL) specified.
        Parameters:
        html - the anchor's html
        directionEstimator - A DirectionEstimator object used for automatic direction adjustment. For convenience, DEFAULT_DIRECTION_ESTIMATOR can be used.
        href - the url to which it will link
      • Anchor

        public Anchor​(SafeHtml html,
                      DirectionEstimator directionEstimator,
                      SafeUri href)
        Creates an anchor with its html and href (target URL) specified.
        Parameters:
        html - the anchor's html
        directionEstimator - A DirectionEstimator object used for automatic direction adjustment. For convenience, DEFAULT_DIRECTION_ESTIMATOR can be used.
        href - the url to which it will link
      • Anchor

        public Anchor​(java.lang.String text,
                      java.lang.String href)
        Creates an anchor with its text and href (target URL) specified.
        Parameters:
        text - the anchor's text
        href - the url to which it will link
      • Anchor

        public Anchor​(java.lang.String text,
                      HasDirection.Direction dir,
                      java.lang.String href)
        Creates an anchor with its text and href (target URL) specified.
        Parameters:
        text - the anchor's text
        dir - the text's direction
        href - the url to which it will link
      • Anchor

        public Anchor​(java.lang.String text,
                      DirectionEstimator directionEstimator,
                      java.lang.String href)
        Creates an anchor with its text and href (target URL) specified.
        Parameters:
        text - the anchor's text
        directionEstimator - A DirectionEstimator object used for automatic direction adjustment. For convenience, DEFAULT_DIRECTION_ESTIMATOR can be used.
        href - the url to which it will link
      • Anchor

        public Anchor​(java.lang.String text,
                      boolean asHTML,
                      java.lang.String href)
        Creates an anchor with its text and href (target URL) specified.
        Parameters:
        text - the anchor's text
        asHTML - true to treat the specified text as html
        href - the url to which it will link
      • Anchor

        public Anchor​(SafeHtml html,
                      java.lang.String href,
                      java.lang.String target)
        Creates a source anchor (link to URI). That is, an anchor with an href attribute specifying the destination URI.
        Parameters:
        html - the anchor's html
        href - the url to which it will link
        target - the target frame (e.g. "_blank" to open the link in a new window)
      • Anchor

        public Anchor​(SafeHtml html,
                      SafeUri href,
                      java.lang.String target)
        Creates a source anchor (link to URI). That is, an anchor with an href attribute specifying the destination URI.
        Parameters:
        html - the anchor's html
        href - the url to which it will link
        target - the target frame (e.g. "_blank" to open the link in a new window)
      • Anchor

        public Anchor​(java.lang.String text,
                      java.lang.String href,
                      java.lang.String target)
        Creates a source anchor with a frame target.
        Parameters:
        text - the anchor's text
        href - the url to which it will link
        target - the target frame (e.g. "_blank" to open the link in a new window)
      • Anchor

        public Anchor​(java.lang.String text,
                      boolean asHtml,
                      java.lang.String href,
                      java.lang.String target)
        Creates a source anchor (link to URI). That is, an anchor with an href attribute specifying the destination URI.
        Parameters:
        text - the anchor's text
        asHtml - asHTML true to treat the specified text as html
        href - the url to which it will link
        target - the target frame (e.g. "_blank" to open the link in a new window)
      • Anchor

        protected Anchor​(Element element)
        This constructor may be used by subclasses to explicitly use an existing element. This element must be an <a> element.
        Parameters:
        element - the element to be used
    • Method Detail

      • wrap

        public static Anchor wrap​(Element element)
        Creates an Anchor widget that wraps an existing <a> element. This element must already be attached to the document. If the element is removed from the document, you must call RootPanel.detachNow(Widget).
        Parameters:
        element - the element to be wrapped
      • getDirection

        public HasDirection.Direction getDirection()
        Description copied from interface: HasDirection
        Gets the directionality of the widget.
        Specified by:
        getDirection in interface HasDirection
        Returns:
        RTL if the directionality is right-to-left, LTR if the directionality is left-to-right, or DEFAULT if the directionality is not explicitly specified
      • getHref

        public java.lang.String getHref()
        Gets the anchor's href (the url to which it links).
        Returns:
        the anchor's href
      • getHTML

        public java.lang.String getHTML()
        Description copied from interface: HasHTML
        Gets this object's contents as HTML.
        Specified by:
        getHTML in interface HasHTML
        Returns:
        the object's HTML
      • getName

        public java.lang.String getName()
        Description copied from interface: HasName
        Gets the widget's name.
        Specified by:
        getName in interface HasName
        Returns:
        the widget's name
      • getTarget

        public java.lang.String getTarget()
        Gets the anchor's target frame (the frame in which navigation will occur when the link is selected).
        Returns:
        the target frame
      • getText

        public java.lang.String getText()
        Description copied from interface: HasText
        Gets this object's text.
        Specified by:
        getText in interface HasText
        Returns:
        the object's text
      • getWordWrap

        public boolean getWordWrap()
        Description copied from interface: HasWordWrap
        Gets whether word-wrapping is enabled.
        Specified by:
        getWordWrap in interface HasWordWrap
        Returns:
        true if word-wrapping is enabled.
      • setAccessKey

        public void setAccessKey​(char key)
        Description copied from interface: Focusable
        Sets the widget's 'access key'. This key is used (in conjunction with a browser-specific modifier key) to automatically focus the widget.
        Specified by:
        setAccessKey in interface Focusable
        Overrides:
        setAccessKey in class FocusWidget
        Parameters:
        key - the widget's access key
      • setDirectionEstimator

        public void setDirectionEstimator​(DirectionEstimator directionEstimator)
        Sets the DirectionEstimator object.

        Note: DirectionEstimator should be set before the widget has any content; it's highly recommended to set it using a constructor. Reason: if the widget already has non-empty content, this will update its direction according to the new estimator's result. This may cause flicker, and thus should be avoided.

        Specified by:
        setDirectionEstimator in interface HasDirectionEstimator
        Parameters:
        directionEstimator - The DirectionEstimator to be set. null means turning off direction estimation.
      • setFocus

        public void setFocus​(boolean focused)
        Description copied from interface: Focusable
        Explicitly focus/unfocus this widget. Only one widget can have focus at a time, and the widget that does will receive all keyboard events. NOTE: Most browsers fire FocusEvents asynchronously. Especially within GWT tests, you'll need to make your test asynchronous to properly do verifications. See GWTTestCase#delayTestFinish for more information on how to do this.
        Specified by:
        setFocus in interface Focusable
        Overrides:
        setFocus in class FocusWidget
        Parameters:
        focused - whether this widget should take focus or release it
      • setHref

        public void setHref​(SafeUri href)
        Sets the anchor's href (the url to which it links).
        Parameters:
        href - the anchor's href
      • setHref

        public void setHref​(java.lang.String href)
        Sets the anchor's href (the url to which it links).
        Parameters:
        href - the anchor's href
      • setHTML

        public void setHTML​(SafeHtml html)
        Description copied from interface: HasSafeHtml
        Sets this object's contents via known-safe HTML.

        The object will behave exactly the same as when a widget's HasHTML.setHTML(String) method is invoked; however the SafeHtml passed to this method observes the contract that it can be used in an HTML context without causing unsafe script execution. Thus, unlike HasHTML.setHTML(String), using this method cannot result in Cross-Site Scripting security vulnerabilities.

        Specified by:
        setHTML in interface HasSafeHtml
        Parameters:
        html - the object's new HTML, represented as a SafeHtml object
      • setHTML

        public void setHTML​(java.lang.String html)
        Description copied from interface: HasHTML
        Sets this object's contents via HTML. Use care when setting an object's HTML; it is an easy way to expose script-based security problems. Consider using HasText.setText(String) whenever possible.
        Specified by:
        setHTML in interface HasHTML
        Parameters:
        html - the object's new HTML
      • setName

        public void setName​(java.lang.String name)
        Description copied from interface: HasName
        Sets the widget's name.
        Specified by:
        setName in interface HasName
        Parameters:
        name - the widget's new name
      • setTabIndex

        public void setTabIndex​(int index)
        Description copied from interface: Focusable
        Sets the widget's position in the tab index. If more than one widget has the same tab index, each such widget will receive focus in an arbitrary order. Setting the tab index to -1 will cause this widget to be removed from the tab order.
        Specified by:
        setTabIndex in interface Focusable
        Overrides:
        setTabIndex in class FocusWidget
        Parameters:
        index - the widget's tab index
      • setTarget

        public void setTarget​(java.lang.String target)
        Sets the anchor's target frame (the frame in which navigation will occur when the link is selected).
        Parameters:
        target - the target frame
      • setText

        public void setText​(java.lang.String text)
        Description copied from interface: HasText
        Sets this object's text.
        Specified by:
        setText in interface HasText
        Parameters:
        text - the object's new text
      • setWordWrap

        public void setWordWrap​(boolean wrap)
        Description copied from interface: HasWordWrap
        Sets whether word-wrapping is enabled.
        Specified by:
        setWordWrap in interface HasWordWrap
        Parameters:
        wrap - true to enable word-wrapping.