net.coobird.thumbnailator.geometry
Enum Positions

java.lang.Object
  java.lang.Enum<Positions>
      net.coobird.thumbnailator.geometry.Positions

All Implemented Interfaces:

Serializable, Comparable<Positions>, Position

public enum Positions
extends Enum<Positions>
implements Position

An enum of predefined Positions.

Primary use of this enum is for selecting a position to place watermarks (using the Watermark class), captions (using the Caption class) and other ImageFilters.

Author:

coobird

Enum Constant Summary

BOTTOM_CENTER
Calculates the Point at which an enclosed image should be placed if it is to be horizontally centered at the bottom of the enclosing image.

BOTTOM_LEFT
Calculates the Point at which an enclosed image should be placed if it is to be placed at the bottom left-hand corner of the enclosing image.

BOTTOM_RIGHT
Calculates the Point at which an enclosed image should be placed if it is to be placed at the bottom right-hand corner of the enclosing image.

CENTER
Calculates the Point at which an enclosed image should be placed horizontally and vertically centered in the enclosing image.

CENTER_LEFT
Calculates the Point at which an enclosed image should be placed if it is to be placed vertically centered at the left-hand corner of the enclosing image.

CENTER_RIGHT
Calculates the Point at which an enclosed image should be placed if it is to be placed vertically centered at the right-hand corner of the enclosing image.

TOP_CENTER
Calculates the Point at which an enclosed image should be placed if it is to be horizontally centered at the top of the enclosing image.

TOP_LEFT
Calculates the Point at which an enclosed image should be placed if it is to be placed at the top left-hand corner of the enclosing image.

TOP_RIGHT
Calculates the Point at which an enclosed image should be placed if it is to be placed at the top right-hand corner of the enclosing image.

Method Summary

static Positions	valueOf(String name) Returns the enum constant of this type with the specified name.
static Positions[]	values() Returns an array containing the constants of this enum type, in the order they're 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

Methods inherited from interface net.coobird.thumbnailator.geometry.Position

calculate

Enum Constant Detail

TOP_LEFT

public static final Positions TOP_LEFT

Calculates the Point at which an enclosed image should be placed if it is to be placed at the top left-hand corner of the enclosing image.

TOP_CENTER

public static final Positions TOP_CENTER

Calculates the Point at which an enclosed image should be placed if it is to be horizontally centered at the top of the enclosing image.

TOP_RIGHT

public static final Positions TOP_RIGHT

Calculates the Point at which an enclosed image should be placed if it is to be placed at the top right-hand corner of the enclosing image.

CENTER_LEFT

public static final Positions CENTER_LEFT

Calculates the Point at which an enclosed image should be placed if it is to be placed vertically centered at the left-hand corner of the enclosing image.

CENTER

public static final Positions CENTER

Calculates the Point at which an enclosed image should be placed horizontally and vertically centered in the enclosing image.

CENTER_RIGHT

public static final Positions CENTER_RIGHT

Calculates the Point at which an enclosed image should be placed if it is to be placed vertically centered at the right-hand corner of the enclosing image.

BOTTOM_LEFT

public static final Positions BOTTOM_LEFT

Calculates the Point at which an enclosed image should be placed if it is to be placed at the bottom left-hand corner of the enclosing image.

BOTTOM_CENTER

public static final Positions BOTTOM_CENTER

Calculates the Point at which an enclosed image should be placed if it is to be horizontally centered at the bottom of the enclosing image.

BOTTOM_RIGHT

public static final Positions BOTTOM_RIGHT

Calculates the Point at which an enclosed image should be placed if it is to be placed at the bottom right-hand corner of the enclosing image.

Method Detail

values

public static final Positions[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(Positions c : Positions.values())
        System.out.println(c);

Returns:

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

valueOf

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