org.gm4java.im4java

Enum GMOperation.GeometryAnnotation

java.lang.Object

java.lang.Enum<GMOperation.GeometryAnnotation>

org.gm4java.im4java.GMOperation.GeometryAnnotation

All Implemented Interfaces:

Serializable, Comparable<GMOperation.GeometryAnnotation>

Enclosing class:

GMOperation

public static enum GMOperation.GeometryAnnotation
extends Enum<GMOperation.GeometryAnnotation>

Options which modify the behavior of the 'width X height' specification for geometry-based settings.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DimensionsAsPercentages Treat width and height declarations as percentage values instead of pixel lengths.
DownsizeOnly Resize the image only if its width or height exceeds the geometry specification.
FillUsingAspectRatio Resize the image while maintaining the aspect ratio using the geometry specification as minimum values.
FitUsingAspectRatio Resize the image while maintaining the aspect ratio using the geometry specification as maximum values.
ForceDimensions Resize of the image to exactly match the geometry specification.
UpsizeOnly Resize the image only if both width and height are less than the geometry specification.

Method Summary

Methods

Modifier and Type	Method and Description
String	asAnnotation() Serializes option for GraphicsMagick command-line.
static GMOperation.GeometryAnnotation	valueOf(String name) Returns the enum constant of this type with the specified name.
static GMOperation.GeometryAnnotation[]	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

FillUsingAspectRatio

public static final GMOperation.GeometryAnnotation FillUsingAspectRatio

Resize the image while maintaining the aspect ratio using the geometry specification as minimum values.

FitUsingAspectRatio

public static final GMOperation.GeometryAnnotation FitUsingAspectRatio

Resize the image while maintaining the aspect ratio using the geometry specification as maximum values.

ForceDimensions

public static final GMOperation.GeometryAnnotation ForceDimensions

Resize of the image to exactly match the geometry specification.

DimensionsAsPercentages

public static final GMOperation.GeometryAnnotation DimensionsAsPercentages

Treat width and height declarations as percentage values instead of pixel lengths.

DownsizeOnly

public static final GMOperation.GeometryAnnotation DownsizeOnly

Resize the image only if its width or height exceeds the geometry specification.

UpsizeOnly

public static final GMOperation.GeometryAnnotation UpsizeOnly

Resize the image only if both width and height are less than the geometry specification.

Method Detail

values

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

Returns:

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

valueOf

public static GMOperation.GeometryAnnotation 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

asAnnotation

public String asAnnotation()

Serializes option for GraphicsMagick command-line.

Returns:

Annotation to append to geometry specification