com.softwarefx.chartfx.server.adornments

Enum ImageMode

java.lang.Object

java.lang.Enum<ImageMode>

com.softwarefx.chartfx.server.adornments.ImageMode

All Implemented Interfaces:

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

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
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

Methods

Modifier and Type	Method and Description
int	getUnderlyingValue() Returns a numeric value that represents the given com.softwarefx.chartfx.server.adornments.ImageMode.
static ImageMode	valueOf(java.lang.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(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

getUnderlyingValue

public int getUnderlyingValue()

Returns a numeric value that represents the given com.softwarefx.chartfx.server.adornments.ImageMode.