Package com.vaadin.flow.component.shared

Enum Class Tooltip.AriaLinkMode

java.lang.Object

java.lang.Enum<Tooltip.AriaLinkMode>

com.vaadin.flow.component.shared.Tooltip.AriaLinkMode

All Implemented Interfaces:

Serializable, Comparable<Tooltip.AriaLinkMode>, Constable

Enclosing class:

Tooltip

public static enum Tooltip.AriaLinkMode
extends Enum<Tooltip.AriaLinkMode>

Controls which ARIA attribute links the target element(s) with the tooltip content.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARIA_DESCRIBED_BY	Links the tooltip as a description of the target using aria-describedby.
ARIA_LABELLED_BY	Links the tooltip as the accessible name of the target using aria-labelledby.
NONE	Does not add any ARIA linking attribute to the target.

Method Summary

Modifier and Type	Method	Description
static Tooltip.AriaLinkMode	fromValue(String value)	Gets the Tooltip.AriaLinkMode for the given value string.
String	getValue()
static Tooltip.AriaLinkMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Tooltip.AriaLinkMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ARIA_DESCRIBED_BY

public static final Tooltip.AriaLinkMode ARIA_DESCRIBED_BY

Links the tooltip as a description of the target using aria-describedby. This is the default.

ARIA_LABELLED_BY

public static final Tooltip.AriaLinkMode ARIA_LABELLED_BY

Links the tooltip as the accessible name of the target using aria-labelledby.

NONE

public static final Tooltip.AriaLinkMode NONE

Does not add any ARIA linking attribute to the target.

Method Details

values

public static Tooltip.AriaLinkMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Tooltip.AriaLinkMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

fromValue

public static Tooltip.AriaLinkMode fromValue(String value)

Gets the Tooltip.AriaLinkMode for the given value string. Returns ARIA_DESCRIBED_BY if no match is found.

Parameters:

value - the value string

Returns:

the Tooltip.AriaLinkMode