com.softwarefx.chartfx.server
Enum BorderEffect

java.lang.Object
  java.lang.Enum<BorderEffect>
      com.softwarefx.chartfx.server.BorderEffect

All Implemented Interfaces:

Serializable, Comparable<BorderEffect>

public enum BorderEffect
extends Enum<BorderEffect>

Specify different border effects that may be applied to a object.

Enum Constant Summary

DARK
Apply dark color to the border using the series/points color.

LIGHT
Apply light color to the border using the series/points color.

NONE
No border effect is applied.

OPPOSITE
Chooses between dark and light border depending on the object color.

RAISED
The border has raised inner and outer edges.

SHADOW
The border will have shadow.

Method Summary

static EnumSet<BorderEffect>	getEnumSetValue(int value) Returns a EnumSet that represents the given numeric value.
static BorderEffect	getEnumValue(int value) Returns a Enum Item that represents the given numeric value.
static int	getUnderlyingValue(BorderEffect value) Returns a numeric value that represents the given EnumSet or Enum item.
static int	getUnderlyingValue(EnumSet<BorderEffect> value) Returns a numeric value that represents the given EnumSet or Enum item.
static BorderEffect	valueOf(String name) Returns the enum constant of this type with the specified name.
static BorderEffect[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final BorderEffect NONE

No border effect is applied. The border effect must be None for the BorderColor property to take effect.

RAISED

public static final BorderEffect RAISED

The border has raised inner and outer edges.

LIGHT

public static final BorderEffect LIGHT

Apply light color to the border using the series/points color.

DARK

public static final BorderEffect DARK

Apply dark color to the border using the series/points color.

OPPOSITE

public static final BorderEffect OPPOSITE

Chooses between dark and light border depending on the object color. If the color is dark the chart will choose a light border color. If the color is light the chart will choose a dark border color.

SHADOW

public static final BorderEffect SHADOW

The border will have shadow.

Method Detail

values

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

Returns:

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

valueOf

public static BorderEffect 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

getEnumSetValue

public static EnumSet<BorderEffect> getEnumSetValue(int value)

Returns a EnumSet that represents the given numeric value.

Parameters:

value - numeric representation of the Enumset.

getEnumValue

public static BorderEffect getEnumValue(int value)

Returns a Enum Item that represents the given numeric value.

Parameters:

value - numeric representation of the Enum item.

getUnderlyingValue

public static int getUnderlyingValue(BorderEffect value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.

getUnderlyingValue

public static int getUnderlyingValue(EnumSet<BorderEffect> value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.