com.softwarefx.chartfx.server.adornments
Enum ImageMode

java.lang.Object
  java.lang.Enum<ImageMode>
      com.softwarefx.chartfx.server.adornments.ImageMode

All Implemented Interfaces:

Serializable, Comparable<ImageMode>

public enum ImageMode
extends Enum<ImageMode>

These values describe how an image will be displayed in the chart background when using the BackgroundImage property.

Enum Constant Summary

CENTER
Centers an image in the chart background.

CLIPPED
Places the top left corner of the image in the top left corner of the chart background area.

STRETCH
Stretches or shrinks an image to fit in the chart background area.

TILE
Tiles an image in the chart background.

WATERMARK
Creates a watermark with the configured background image.

Method Summary

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

STRETCH

public static final ImageMode STRETCH

Stretches or shrinks an image to fit in the chart background area.

CLIPPED

public static final ImageMode CLIPPED

Places the top left corner of the image in the top left corner of the chart background area.

TILE

public static final ImageMode TILE

Tiles an image in the chart background.

CENTER

public static final ImageMode CENTER

Centers an image in the chart background.

WATERMARK

public static final ImageMode WATERMARK

Creates a watermark with the configured background image.

Method Detail

values

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

Returns:

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

valueOf

public static ImageMode 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<ImageMode> getEnumSetValue(int value)

Returns a EnumSet that represents the given numeric value.

Parameters:

value - numeric representation of the Enumset.

getEnumValue

public static ImageMode 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(ImageMode 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<ImageMode> value)

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

Parameters:

value - A Enum Item or EnumSet.