com.vaadin.flow.component.html

Enum AnchorTarget

java.lang.Object

java.lang.Enum<AnchorTarget>

com.vaadin.flow.component.html.AnchorTarget

All Implemented Interfaces:

AnchorTargetValue, Serializable, Comparable<AnchorTarget>

public enum AnchorTarget
extends Enum<AnchorTarget>
implements AnchorTargetValue

Enum representing target attribute values for an <a> element.

Since:

Author:

Vaadin Ltd

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLANK Open a link in a new unnamed context.
DEFAULT Remove the target value.
PARENT Open a link in the parent context, or the current context if there is no parent context.
SELF Open a link in the current context.
TOP Open a link in the top most grandparent context, or the current context if there is no parent context.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.html.AnchorTargetValue

forString

Enum Constant Detail

DEFAULT

public static final AnchorTarget DEFAULT

Remove the target value. This has the same effect as SELF.

SELF

public static final AnchorTarget SELF

Open a link in the current context.

BLANK

public static final AnchorTarget BLANK

Open a link in a new unnamed context.

PARENT

public static final AnchorTarget PARENT

Open a link in the parent context, or the current context if there is no parent context.

TOP

public static final AnchorTarget TOP

Open a link in the top most grandparent context, or the current context if there is no parent context.

Method Detail

values

public static AnchorTarget[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AnchorTarget c : AnchorTarget.values())
    System.out.println(c);

Returns:

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

valueOf

public static AnchorTarget valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Description copied from interface: AnchorTargetValue

Gets the string value representation.

Specified by:

getValue in interface AnchorTargetValue

Returns:

value the text value to use by an <a> (anchor) tag.