com.sap.sl.sdk.authoring.businesslayer
Enum FormatColor

java.lang.Object
  extended by java.lang.Enum<FormatColor>
      extended by com.sap.sl.sdk.authoring.businesslayer.FormatColor
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FormatColor>

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

A representation of the literals of the enumeration 'Format Color', and utility methods to work with them.

This enum represents the different colors that can be associated with a custom display format of a business object.


Enum Constant Summary
AUTOMATIC
          The 'Automatic' literal object.
BLACK
          The 'Black' literal object.
BLUE
          The 'Blue' literal object.
CYAN
          The 'Cyan' literal object.
DARK_BLUE
          The 'Dark Blue' literal object.
DARK_CYAN
          The 'Dark Cyan' literal object.
DARK_GREEN
          The 'Dark Green' literal object.
DARK_MAGENTA
          The 'Dark Magenta' literal object.
DARK_RED
          The 'Dark Red' literal object.
DARK_YELLOW
          The 'Dark Yellow' literal object.
GRAY
          The 'Gray' literal object.
GREEN
          The 'Green' literal object.
LIGHT_GRAY
          The 'Light Gray' literal object.
MAGENTA
          The 'Magenta' literal object.
RED
          The 'Red' literal object.
WHITE
          The 'White' literal object.
YELLOW
          The 'Yellow' literal object.
 
Field Summary
static int AUTOMATIC_VALUE
          The 'Automatic' literal value.
static int BLACK_VALUE
          The 'Black' literal value.
static int BLUE_VALUE
          The 'Blue' literal value.
static int CYAN_VALUE
          The 'Cyan' literal value.
static int DARK_BLUE_VALUE
          The 'Dark Blue' literal value.
static int DARK_CYAN_VALUE
          The 'Dark Cyan' literal value.
static int DARK_GREEN_VALUE
          The 'Dark Green' literal value.
static int DARK_MAGENTA_VALUE
          The 'Dark Magenta' literal value.
static int DARK_RED_VALUE
          The 'Dark Red' literal value.
static int DARK_YELLOW_VALUE
          The 'Dark Yellow' literal value.
static int GRAY_VALUE
          The 'Gray' literal value.
static int GREEN_VALUE
          The 'Green' literal value.
static int LIGHT_GRAY_VALUE
          The 'Light Gray' literal value.
static int MAGENTA_VALUE
          The 'Magenta' literal value.
static int RED_VALUE
          The 'Red' literal value.
static java.util.List<FormatColor> VALUES
          A public read-only list of all the 'Format Color' enumerators.
static int WHITE_VALUE
          The 'White' literal value.
static int YELLOW_VALUE
          The 'Yellow' literal value.
 
Method Summary
static FormatColor get(int value)
          Returns the 'Format Color' literal with the specified integer value.
static FormatColor get(java.lang.String literal)
          Returns the 'Format Color' literal with the specified literal value.
static FormatColor getByName(java.lang.String name)
          Returns the 'Format Color' literal with the specified name.
 java.lang.String getLiteral()
          Returns the string representation of the enumerator.
 java.lang.String getName()
          Returns the literal name of the enumerator.
 int getValue()
          Returns the literal integer value of the enumerator.
 java.lang.String toString()
          Returns the literal value of the enumerator, which is its string representation.
static FormatColor valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FormatColor[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

AUTOMATIC

public static final FormatColor AUTOMATIC
The 'Automatic' literal object.

This is the default value that means no color is defined with the format.

See Also:
AUTOMATIC_VALUE

BLACK

public static final FormatColor BLACK
The 'Black' literal object.

See Also:
BLACK_VALUE

WHITE

public static final FormatColor WHITE
The 'White' literal object.

See Also:
WHITE_VALUE

RED

public static final FormatColor RED
The 'Red' literal object.

See Also:
RED_VALUE

GREEN

public static final FormatColor GREEN
The 'Green' literal object.

See Also:
GREEN_VALUE

BLUE

public static final FormatColor BLUE
The 'Blue' literal object.

See Also:
BLUE_VALUE

YELLOW

public static final FormatColor YELLOW
The 'Yellow' literal object.

See Also:
YELLOW_VALUE

MAGENTA

public static final FormatColor MAGENTA
The 'Magenta' literal object.

See Also:
MAGENTA_VALUE

CYAN

public static final FormatColor CYAN
The 'Cyan' literal object.

See Also:
CYAN_VALUE

DARK_RED

public static final FormatColor DARK_RED
The 'Dark Red' literal object.

See Also:
DARK_RED_VALUE

DARK_GREEN

public static final FormatColor DARK_GREEN
The 'Dark Green' literal object.

See Also:
DARK_GREEN_VALUE

DARK_BLUE

public static final FormatColor DARK_BLUE
The 'Dark Blue' literal object.

See Also:
DARK_BLUE_VALUE

DARK_YELLOW

public static final FormatColor DARK_YELLOW
The 'Dark Yellow' literal object.

See Also:
DARK_YELLOW_VALUE

DARK_MAGENTA

public static final FormatColor DARK_MAGENTA
The 'Dark Magenta' literal object.

See Also:
DARK_MAGENTA_VALUE

DARK_CYAN

public static final FormatColor DARK_CYAN
The 'Dark Cyan' literal object.

See Also:
DARK_CYAN_VALUE

LIGHT_GRAY

public static final FormatColor LIGHT_GRAY
The 'Light Gray' literal object.

See Also:
LIGHT_GRAY_VALUE

GRAY

public static final FormatColor GRAY
The 'Gray' literal object.

See Also:
GRAY_VALUE
Field Detail

AUTOMATIC_VALUE

public static final int AUTOMATIC_VALUE
The 'Automatic' literal value.

See Also:
AUTOMATIC, Constant Field Values

BLACK_VALUE

public static final int BLACK_VALUE
The 'Black' literal value.

See Also:
BLACK, Constant Field Values

WHITE_VALUE

public static final int WHITE_VALUE
The 'White' literal value.

See Also:
WHITE, Constant Field Values

RED_VALUE

public static final int RED_VALUE
The 'Red' literal value.

See Also:
RED, Constant Field Values

GREEN_VALUE

public static final int GREEN_VALUE
The 'Green' literal value.

See Also:
GREEN, Constant Field Values

BLUE_VALUE

public static final int BLUE_VALUE
The 'Blue' literal value.

See Also:
BLUE, Constant Field Values

YELLOW_VALUE

public static final int YELLOW_VALUE
The 'Yellow' literal value.

See Also:
YELLOW, Constant Field Values

MAGENTA_VALUE

public static final int MAGENTA_VALUE
The 'Magenta' literal value.

See Also:
MAGENTA, Constant Field Values

CYAN_VALUE

public static final int CYAN_VALUE
The 'Cyan' literal value.

See Also:
CYAN, Constant Field Values

DARK_RED_VALUE

public static final int DARK_RED_VALUE
The 'Dark Red' literal value.

See Also:
DARK_RED, Constant Field Values

DARK_GREEN_VALUE

public static final int DARK_GREEN_VALUE
The 'Dark Green' literal value.

See Also:
DARK_GREEN, Constant Field Values

DARK_BLUE_VALUE

public static final int DARK_BLUE_VALUE
The 'Dark Blue' literal value.

See Also:
DARK_BLUE, Constant Field Values

DARK_YELLOW_VALUE

public static final int DARK_YELLOW_VALUE
The 'Dark Yellow' literal value.

See Also:
DARK_YELLOW, Constant Field Values

DARK_MAGENTA_VALUE

public static final int DARK_MAGENTA_VALUE
The 'Dark Magenta' literal value.

See Also:
DARK_MAGENTA, Constant Field Values

DARK_CYAN_VALUE

public static final int DARK_CYAN_VALUE
The 'Dark Cyan' literal value.

See Also:
DARK_CYAN, Constant Field Values

LIGHT_GRAY_VALUE

public static final int LIGHT_GRAY_VALUE
The 'Light Gray' literal value.

See Also:
LIGHT_GRAY, Constant Field Values

GRAY_VALUE

public static final int GRAY_VALUE
The 'Gray' literal value.

See Also:
GRAY, Constant Field Values

VALUES

public static final java.util.List<FormatColor> VALUES
A public read-only list of all the 'Format Color' enumerators.

Method Detail

values

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

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

valueOf

public static FormatColor 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 FormatColor get(java.lang.String literal)
Returns the 'Format Color' literal with the specified literal value.

Parameters:
literal - The enumerator literal as a string
Returns:
A FormatColor object

getByName

public static FormatColor getByName(java.lang.String name)
Returns the 'Format Color' literal with the specified name.

Parameters:
name - The literal name of the enumerator
Returns:
A FormatColor object

get

public static FormatColor get(int value)
Returns the 'Format Color' literal with the specified integer value.

Parameters:
value - The literal integer value of the enumerator
Returns:
A FormatColor object

getValue

public int getValue()
Returns the literal integer value of the enumerator.

Returns:
An integer that represents the literal value

getName

public java.lang.String getName()
Returns the literal name of the enumerator.

Returns:
A String that represents the literal name

getLiteral

public java.lang.String getLiteral()
Returns the string representation of the enumerator.

Returns:
A String that represents the enumerator

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<FormatColor>
Returns:
A String that represents the literal


© Copyright 2016 SAP SE or an SAP affiliate company. All rights reserved.