Package com.vaadin.flow.component.html

Class Anchor

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.HtmlComponent
com.vaadin.flow.component.HtmlContainer
com.vaadin.flow.component.html.Anchor
All Implemented Interfaces:
AttachNotifier, BlurNotifier<Anchor>, DetachNotifier, Focusable<Anchor>, FocusNotifier<Anchor>, HasAriaLabel, HasComponents, HasElement, HasEnabled, HasSize, HasStyle, HasText, Serializable
@Tag("a") public class Anchor extends HtmlContainer implements Focusable<Anchor>, HasAriaLabel
Component representing an <a> element.
Since:
1.0
Author:
Vaadin Ltd
See Also:

  • Constructor Details

  • Method Details

    • setHref

      public void setHref(String href)
      Sets the URL that this anchor links to.

      A disabled Anchor removes the attribute from the HTML element, but it is stored (and reused when enabled again) in the server-side component.

      Use the method removeHref() to remove the href attribute instead of setting it to an empty string.

      Parameters:
      href - the href to set
      See Also:

    • removeHref

      public void removeHref()
      Removes href attribute.
      See Also:

    • setHref

      @Deprecated(since="24.8", forRemoval=true) public void setHref(AbstractStreamResource href)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use setHref(DownloadHandler) instead
      Sets the URL that this anchor links to with the URL of the given StreamResource.
      Parameters:
      href - the resource value, not null

    • setHref

      public void setHref(DownloadHandler downloadHandler)
      Sets the URL that this anchor links to and that is bound to a given DownloadHandler callback on the server for handling data download from the server to the client when clicking an anchor.

      Sets the 'download' attribute for link when given a non-inline handler implementing AbstractDownloadHandler.

      Parameters:
      downloadHandler - the callback that handles data download, not null

    • setHref

      public void setHref(DownloadHandler downloadHandler, AttachmentType attachmentType)
      Sets the URL that this anchor links to and that is bound to a given DownloadHandler callback on the server for handling data download from the server to the client when clicking an anchor.

      LinkMode determines if the attribute `download` should be set or not. AttachmentType.DOWNLOAD will set the download attribute, where as AttachmentType.INLINE will remove it.

      Parameters:
      downloadHandler - the callback that handles data download, not null
      attachmentType - set the correct attribute for anchor according to given mode, null will set the type to AttachmentType.DOWNLOAD

    • setDownload

      public void setDownload(boolean download)
      Set the download state of the anchor.

      true will add the download attribute making the anchor target to be downloaded on click.

      false will remove the download attribute.

      Parameters:
      download - true to add the 'download' attribute and false to remove it

    • isDownload

      public boolean isDownload()
      Check if the anchor target will be downloaded for a click.
      Returns:
      true if download is set for this anchor

    • setRouterIgnore

      public void setRouterIgnore(boolean ignore)
      The routing mechanism in Vaadin by default intercepts all anchor elements with relative URL. This method can be used make the router ignore this anchor and this way make this anchor behave normally and cause a full page load.
      Parameters:
      ignore - true if this link should not be intercepted by the single-page web application routing mechanism in Vaadin.

    • isRouterIgnore

      public boolean isRouterIgnore()
      Returns:
      true if this anchor should be ignored by the Vaadin router and behave normally.

    • getHref

      public String getHref()
      Gets the URL that this anchor links to.
      Returns:
      the href value, or "" if no href has been set
      See Also:

    • onEnabledStateChanged

      public void onEnabledStateChanged(boolean enabled)
      Description copied from class: Component
      Handle component enable state when the enabled state changes.

      By default this sets or removes the 'disabled' attribute from the element. This can be overridden to have custom handling.

      Overrides:
      onEnabledStateChanged in class Component
      Parameters:
      enabled - the new enabled state of the component

    • setTarget

      public void setTarget(String target)
      Sets the target window, tab or frame for this anchor. The target is either the window.name of a specific target, or one of these special values:
      • _self: Open the link in the current context. This is the default behavior.
      • _blank: Opens the link in a new unnamed context.
      • _parent: Opens the link in the parent context, or the current context if there is no parent context.
      • _top: Opens the link in the top most grandparent context, or the current context if there is no parent context.
      Parameters:
      target - the target value, or "" to remove the target value

    • getTarget

      public Optional<String> getTarget()
      Gets the target window, tab or frame name for this anchor.
      Returns:
      an optional target, or an empty optional if no target has been set
      See Also:

    • setTarget

      public void setTarget(AnchorTargetValue target)
      Sets the target window, tab or frame for this anchor. The target may be the one of these special values:
      • AnchorTarget.DEFAULT: Removes the target value. This has the same effect as setting the target to AnchorTarget.SELF.
      • AnchorTarget.SELF: Opens the link in the current context.
      • AnchorTarget.BLANK: Opens the link in a new unnamed context.
      • AnchorTarget.PARENT: Opens the link in the parent context, or the current context if there is no parent context.
      • AnchorTarget.TOP: Opens the link in the top most grandparent context, or the current context if there is no parent context.
      Parameters:
      target - the target value, not null

    • getTargetValue

      public AnchorTargetValue getTargetValue()
      Gets the target window, tab or frame value for this anchor.
      Returns:
      the target window value , or AnchorTarget.DEFAULT if no target has been set
      See Also: