Package org.pushingpixels.substance.api

Enum SubstanceSlices.ImageWatermarkKind

java.lang.Object

java.lang.Enum<SubstanceSlices.ImageWatermarkKind>

org.pushingpixels.substance.api.SubstanceSlices.ImageWatermarkKind

Enclosing class:

SubstanceSlices

public static enum SubstanceSlices.ImageWatermarkKind
extends java.lang.Enum<SubstanceSlices.ImageWatermarkKind>

Enumerates of image-based watermarks kinds.

See Also:

SubstanceImageWatermark.setKind(SubstanceSlices.ImageWatermarkKind)

Enum Constant Summary

Enum Constants

Enum Constant	Description
APP_ANCHOR	The image is anchored to the top-left corner of the application frame and not scaled.
APP_CENTER	The image is anchored to the center of the application frame and not scaled.
APP_TILE	The image is tiled starting from the top-left corner of the application frame and not scaled.
SCREEN_CENTER_SCALE	The default behaviour.
SCREEN_TILE	The image is tiled starting from the screen top-left corner and not scaled.

Method Summary

Modifier and Type	Method	Description
static SubstanceSlices.ImageWatermarkKind	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SubstanceSlices.ImageWatermarkKind[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SCREEN_CENTER_SCALE

public static final SubstanceSlices.ImageWatermarkKind SCREEN_CENTER_SCALE

The default behaviour. The image is centered in the screen and scaled down if necessary.

SCREEN_TILE

public static final SubstanceSlices.ImageWatermarkKind SCREEN_TILE

The image is tiled starting from the screen top-left corner and not scaled.

APP_ANCHOR

public static final SubstanceSlices.ImageWatermarkKind APP_ANCHOR

The image is anchored to the top-left corner of the application frame and not scaled.

APP_CENTER

public static final SubstanceSlices.ImageWatermarkKind APP_CENTER

The image is anchored to the center of the application frame and not scaled.

APP_TILE

public static final SubstanceSlices.ImageWatermarkKind APP_TILE

The image is tiled starting from the top-left corner of the application frame and not scaled.

Method Detail

values

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

Returns:

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

valueOf

public static SubstanceSlices.ImageWatermarkKind 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