Module omix.api

Package omix.plugin.paint

Enum PaintHandlerInterface.PaintOption

java.lang.Object

java.lang.Enum<PaintHandlerInterface.PaintOption>

omix.plugin.paint.PaintHandlerInterface.PaintOption

All Implemented Interfaces:

Serializable, Comparable<PaintHandlerInterface.PaintOption>, Constable

Enclosing interface:

PaintHandlerInterface

public static enum PaintHandlerInterface.PaintOption
extends Enum<PaintHandlerInterface.PaintOption>

Options of a PaintDevice

Since:

Omix 1.3.11

Author:

Dr. Peter Droste, Omix Visualization

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
AntiAliasing	Anti-aliasing
CompressionRatio	If a file format supports compression the method PaintDeviceInterface.setCompression(int) can be used to compress the image file.
Description	If a file format supports description the method PaintDeviceInterface.setText(String, String) can be used to insert text details.
FramesPerSecond	Ability to specify a video's frames per second
Gamma	If a file format supports gamma the method PaintDeviceInterface.setGamma(float) can be used to set the gamma value of the image file.
ImageFormat	If a given file format is an image format.
InfiniteLoop	Ability to specify if an animation is looped
Name
Page	If an image format is a page oriented file format like PDF.
Quality	If a file format supports quality the method PaintDeviceInterface.setQuality(int) can be used to set the quality of the image file.
SubType
Transparency	If an image or video format supports transparency.
VideoFormat	If a given file format is a video format.

Method Summary

Modifier and Type	Method	Description
static PaintHandlerInterface.PaintOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PaintHandlerInterface.PaintOption[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Transparency

public static final PaintHandlerInterface.PaintOption Transparency

If an image or video format supports transparency.

Page

public static final PaintHandlerInterface.PaintOption Page

If an image format is a page oriented file format like PDF. This option strictly requires a QPrinter provided by the PaintHandlerInterface instance in PaintHandlerInterface.getPaintDevice(URLConnection, QSize, QColor).

ImageFormat

public static final PaintHandlerInterface.PaintOption ImageFormat

If a given file format is an image format.

VideoFormat

public static final PaintHandlerInterface.PaintOption VideoFormat

If a given file format is a video format. This option strictly requires an instance of MoviePaintDeviceInterface provided by the PaintHandlerInterface instance in PaintHandlerInterface.getPaintDevice(URLConnection, QSize, QColor).

Description

public static final PaintHandlerInterface.PaintOption Description

If a file format supports description the method PaintDeviceInterface.setText(String, String) can be used to insert text details.

See Also:

QImageIOHandler.ImageOption.Description

CompressionRatio

public static final PaintHandlerInterface.PaintOption CompressionRatio

If a file format supports compression the method PaintDeviceInterface.setCompression(int) can be used to compress the image file.

See Also:

QImageIOHandler.ImageOption.CompressionRatio

Gamma

public static final PaintHandlerInterface.PaintOption Gamma

If a file format supports gamma the method PaintDeviceInterface.setGamma(float) can be used to set the gamma value of the image file.

See Also:

QImageIOHandler.ImageOption.Gamma

Quality

public static final PaintHandlerInterface.PaintOption Quality

If a file format supports quality the method PaintDeviceInterface.setQuality(int) can be used to set the quality of the image file.

See Also:

QImageIOHandler.ImageOption.Quality

Name

public static final PaintHandlerInterface.PaintOption Name

See Also:

QImageIOHandler.ImageOption.Name

SubType

public static final PaintHandlerInterface.PaintOption SubType

See Also:

QImageIOHandler.ImageOption.SubType

AntiAliasing

public static final PaintHandlerInterface.PaintOption AntiAliasing

Anti-aliasing

FramesPerSecond

public static final PaintHandlerInterface.PaintOption FramesPerSecond

Ability to specify a video's frames per second

InfiniteLoop

public static final PaintHandlerInterface.PaintOption InfiniteLoop

Ability to specify if an animation is looped

Method Details

values

public static PaintHandlerInterface.PaintOption[] values()

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

Returns:

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

valueOf

public static PaintHandlerInterface.PaintOption 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