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, DetachNotifier, HasComponents, HasElement, HasEnabled, HasSize, HasStyle, HasText, Serializable

@Tag(value="a")
public class Anchor
extends HtmlContainer

Component representing an <a> element.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Anchor() Creates a new empty anchor component.
Anchor(AbstractStreamResource href, String text) Creates an anchor component with the given text content and stream resource.
Anchor(String href, String text) Creates an anchor component with the given text content and href.

Method Summary

Modifier and Type	Method and Description
String	getHref() Gets the URL that this anchor links to.
Optional<String>	getTarget() Gets the target window, tab or frame name for this anchor.
void	removeHref() Removes href attribute.
void	setHref(AbstractStreamResource href) Sets the URL that this anchor links to with the URL of the given StreamResource.
void	setHref(String href) Sets the URL that this anchor links to.
void	setTarget(String target) Sets the target window, tab or frame for this anchor.

Methods inherited from class com.vaadin.flow.component.HtmlComponent

getTitle, setTitle

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.HasComponents

add, addComponentAsFirst, addComponentAtIndex, remove, removeAll

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasText

getText, setText

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getWidth, setHeight, setSizeFull, setSizeUndefined, setWidth

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Constructor Detail

Anchor

public Anchor()

Creates a new empty anchor component.

Anchor

public Anchor(String href,
              String text)

Creates an anchor component with the given text content and href.

Parameters:

href - the href to set

text - the text content to set

See Also:

setHref(String), HasText.setText(String)

Anchor

public Anchor(AbstractStreamResource href,
              String text)

Creates an anchor component with the given text content and stream resource.

Parameters:

href - the resource value, not null

text - the text content to set

See Also:

setHref(AbstractStreamResource), HasText.setText(String)

Method Detail

setHref

public void setHref(String href)

Sets the URL that this anchor links to.

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(), setHref(AbstractStreamResource)

removeHref

public void removeHref()

Removes href attribute.

See Also:

setHref(String)

setHref

public void setHref(AbstractStreamResource href)

Sets the URL that this anchor links to with the URL of the given StreamResource.

Parameters:

href - the resource value, not null

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:

setHref(String)

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(String)