org.eclipse.e4.ui.model.application.ui

Enum SideValue

java.lang.Object

java.lang.Enum<SideValue>

org.eclipse.e4.ui.model.application.ui.SideValue

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SideValue>

public enum SideValue
extends java.lang.Enum<SideValue>

A representation of the literals of the enumeration 'Side Value', and utility methods for working with them.

An enum providing the specific values determining the side of a trimmedWindow on which particular trim bars should be displayed.

Since:

1.0

See Also:

UiPackageImpl.getSideValue()

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM The 'Bottom' literal object
LEFT The 'Left' literal object
RIGHT The 'Right' literal object
TOP The 'Top' literal object

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOTTOM_VALUE The 'Bottom' literal value
static int	LEFT_VALUE The 'Left' literal value
static int	RIGHT_VALUE The 'Right' literal value
static int	TOP_VALUE The 'Top' literal value
static java.util.List<SideValue>	VALUES A public read-only list of all the 'Side Value' enumerators

Method Summary

Modifier and Type	Method and Description
static SideValue	get(int value) Returns the 'Side Value' literal with the specified integer value
static SideValue	get(java.lang.String literal) Returns the 'Side Value' literal with the specified literal value
static SideValue	getByName(java.lang.String name) Returns the 'Side Value' literal with the specified name
java.lang.String	getLiteral()
java.lang.String	getName()
int	getValue()
java.lang.String	toString() Returns the literal value of the enumerator, which is its string representation
static SideValue	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SideValue[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TOP

public static final SideValue TOP

The 'Top' literal object.

See Also:

TOP_VALUE

BOTTOM

public static final SideValue BOTTOM

The 'Bottom' literal object.

See Also:

BOTTOM_VALUE

LEFT

public static final SideValue LEFT

The 'Left' literal object.

See Also:

LEFT_VALUE

RIGHT

public static final SideValue RIGHT

The 'Right' literal object.

See Also:

RIGHT_VALUE

Field Detail

TOP_VALUE

public static final int TOP_VALUE

The 'Top' literal value.

See Also:

TOP, Constant Field Values

BOTTOM_VALUE

public static final int BOTTOM_VALUE

The 'Bottom' literal value.

See Also:

BOTTOM, Constant Field Values

LEFT_VALUE

public static final int LEFT_VALUE

The 'Left' literal value.

See Also:

LEFT, Constant Field Values

RIGHT_VALUE

public static final int RIGHT_VALUE

The 'Right' literal value.

See Also:

RIGHT, Constant Field Values

VALUES

public static final java.util.List<SideValue> VALUES

A public read-only list of all the 'Side Value' enumerators.

Method Detail

values

public static SideValue[] 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 (SideValue c : SideValue.values())
    System.out.println(c);

Returns:

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

valueOf

public static SideValue valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

get

public static SideValue get(java.lang.String literal)

Returns the 'Side Value' literal with the specified literal value.

Parameters:

literal - the literal.

Returns:

the matching enumerator or null.

getByName

public static SideValue getByName(java.lang.String name)

Returns the 'Side Value' literal with the specified name.

Parameters:

name - the name.

Returns:

the matching enumerator or null.

get

public static SideValue get(int value)

Returns the 'Side Value' literal with the specified integer value.

Parameters:

value - the integer value.

Returns:

the matching enumerator or null.

getValue

public int getValue()

getName

public java.lang.String getName()

getLiteral

public java.lang.String getLiteral()

toString

public java.lang.String toString()

Returns the literal value of the enumerator, which is its string representation.

Overrides:

toString in class java.lang.Enum<SideValue>