Package org.jpedal.render.output.io

Enum Class ImageType

java.lang.Object

java.lang.Enum<ImageType>

org.jpedal.render.output.io.ImageType

All Implemented Interfaces:

Serializable, Comparable<ImageType>, Constable

public enum ImageType
extends Enum<ImageType>

Enum used within the CustomIO API for overriding the file type of image content.

The ImageType specifies what the image is used for in conversion. For example, is it a background image, a thumbnail image, etc.

It is possible that behavior may need to change between image types. For example background images do not require transparency and can use JPG, however SVG images do require transparency and must use PNG.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BACKGROUND	Used in image_* text modes.
FORM	Used for rasterising PDF forms (non XFA).
SHADE	Used in svg_* text modes.
SVG_ALPHA_NOT_REQUIRED	Used in svg_* text modes.
SVG_ALPHA_REQUIRED	Used in svg_* text modes.
THUMBNAIL	Used in the IDRViewer, or if thumbnails are enabled in the options.

Method Summary

Modifier and Type	Method	Description
static ImageType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ImageType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BACKGROUND

public static final ImageType BACKGROUND

Used in image_* text modes. Does not require transparency.

THUMBNAIL

public static final ImageType THUMBNAIL

Used in the IDRViewer, or if thumbnails are enabled in the options. Does not require transparency.

SVG_ALPHA_REQUIRED

public static final ImageType SVG_ALPHA_REQUIRED

Used in svg_* text modes. Images are used by the SVG file produced. Requires transparency.

SVG_ALPHA_NOT_REQUIRED

public static final ImageType SVG_ALPHA_NOT_REQUIRED

Used in svg_* text modes. Images are used by the SVG file produced. Does not require transparency.

FORM

public static final ImageType FORM

Used for rasterising PDF forms (non XFA). Requires transparency.

SHADE

public static final ImageType SHADE

Used in svg_* text modes. Images are used by the SVG file produced. Requires transparency.

Method Details

values

public static ImageType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ImageType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null