Package de.espirit.firstspirit.access.store.templatestore

Enum Class StyleTemplateLink.Region

java.lang.Object

java.lang.Enum<StyleTemplateLink.Region>

de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink.Region

All Implemented Interfaces:

Serializable, Comparable<StyleTemplateLink.Region>, Constable

Enclosing interface:

StyleTemplateLink

public static enum StyleTemplateLink.Region
extends Enum<StyleTemplateLink.Region>

The region targeted by this link.

Since:

4.0.120

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
ALL	All areas.
CUSTOM	A custom definition of targeted rows/columns.
EVEN	Even rows/columns only.
FIRST	The first row/column only.
LAST	The last row/column only.
ODD	Odd rows/columns only.

Method Summary

Modifier and Type	Method	Description
static StyleTemplateLink.Region	forName(@NotNull String name)	Provides a region for the given name.
String	getName()	Provides the name of this link.
boolean	matches(int value, int current, boolean last)	Checks, whether the given arguments are applicable with this region.
static StyleTemplateLink.Region	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StyleTemplateLink.Region[]	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

ALL

public static final StyleTemplateLink.Region ALL

All areas.

Since:

4.0.120

EVEN

public static final StyleTemplateLink.Region EVEN

Even rows/columns only.

Since:

4.0.120

ODD

public static final StyleTemplateLink.Region ODD

Odd rows/columns only.

Since:

4.0.120

FIRST

public static final StyleTemplateLink.Region FIRST

The first row/column only.

Since:

4.0.120

LAST

public static final StyleTemplateLink.Region LAST

The last row/column only.

Since:

4.0.120

CUSTOM

public static final StyleTemplateLink.Region CUSTOM

A custom definition of targeted rows/columns.

Since:

4.0.120

Method Details

values

public static StyleTemplateLink.Region[] 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 StyleTemplateLink.Region 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

getName

public String getName()

Provides the name of this link.

Returns:

The name.

Since:

4.0.120

forName

public static StyleTemplateLink.Region forName(@NotNull
 @NotNull String name)

Provides a region for the given name.

Returns:

The matching region.

Throws:

IllegalArgumentException - if there is no region with the requested name.

Since:

4.0.120

matches

public boolean matches(int value,
 int current,
 boolean last)

Checks, whether the given arguments are applicable with this region.

Parameters:

value - The value.

current - The current location.

last - The last location.

Since:

4.0.120