org.fujion.canvas.d2

Enum CompositeOperation

java.lang.Object

java.lang.Enum<CompositeOperation>

org.fujion.canvas.d2.CompositeOperation

All Implemented Interfaces:

Serializable, Comparable<CompositeOperation>

public enum CompositeOperation
extends Enum<CompositeOperation>

The type of compositing operation to apply when drawing new shapes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COPY Displays the source image.
DESTINATION_ATOP Displays the destination image on top of the source image.
DESTINATION_IN Displays the destination image in to the source image.
DESTINATION_OUT Displays the destination image out of the source image.
DESTINATION_OVER Displays the destination image over the source image.
LIGHTER Displays the source image + the destination image.
SOURCE_ATOP Displays the source image on top of the destination image.
SOURCE_IN Displays the source image in to the destination image.
SOURCE_OUT Displays the source image out of the destination image.
SOURCE_OVER Displays the source image over the destination image.
XOR The source image is combined by using an exclusive OR with the destination image.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COPY

public static final CompositeOperation COPY

Displays the source image. The destination image is ignored.

DESTINATION_ATOP

public static final CompositeOperation DESTINATION_ATOP

Displays the destination image on top of the source image. The part of the destination image that is outside the source image is not shown.

DESTINATION_IN

public static final CompositeOperation DESTINATION_IN

Displays the destination image in to the source image. Only the part of the destination image that is INSIDE the source image is shown, and the source image is transparent.

DESTINATION_OUT

public static final CompositeOperation DESTINATION_OUT

Displays the destination image out of the source image. Only the part of the destination image that is OUTSIDE the source image is shown, and the source image is transparent.

DESTINATION_OVER

public static final CompositeOperation DESTINATION_OVER

Displays the destination image over the source image.

LIGHTER

public static final CompositeOperation LIGHTER

Displays the source image + the destination image.

SOURCE_ATOP

public static final CompositeOperation SOURCE_ATOP

Displays the source image on top of the destination image. The part of the source image that is outside the destination image is not shown.

SOURCE_IN

public static final CompositeOperation SOURCE_IN

Displays the source image in to the destination image. Only the part of the source image that is INSIDE the destination image is shown, and the destination image is transparent.

SOURCE_OUT

public static final CompositeOperation SOURCE_OUT

Displays the source image out of the destination image. Only the part of the source image that is OUTSIDE the destination image is shown, and the destination image is transparent.

SOURCE_OVER

public static final CompositeOperation SOURCE_OVER

Displays the source image over the destination image.

XOR

public static final CompositeOperation XOR

The source image is combined by using an exclusive OR with the destination image.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<CompositeOperation>