com.realobjects.pdfreactor

Class Configuration.OutputFormat

java.lang.Object

com.realobjects.pdfreactor.Configuration.OutputFormat

Enclosing class:

Configuration

public static class Configuration.OutputFormat
extends Object

A type containing output data.

Constructor Summary

Constructors

Constructor and Description
OutputFormat()
OutputFormat(Configuration.OutputType type, int width, int height, Boolean multiImage) Deprecated.

Method Summary

Modifier and Type	Method and Description
Configuration.OutputFormat	setHeight(Integer value) The height of the output in pixels (image formats only).
Configuration.OutputFormat	setMultiImage(Boolean value) Indicates whether the image output will be paginated into multiple images.
Configuration.OutputFormat	setPixelDensity(Integer value) The pixel density of the output (image formats only).
Configuration.OutputFormat	setPixelDensityUnit(Configuration.ResolutionUnit pixelDensityUnit) The unit of the pixel density.
Configuration.OutputFormat	setType(Configuration.OutputType value) The output format.
Configuration.OutputFormat	setWidth(Integer value) The with of the output in pixels (image formats only).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OutputFormat

public OutputFormat()

OutputFormat

@Deprecated
public OutputFormat(Configuration.OutputType type,
                                int width,
                                int height,
                                Boolean multiImage)

Deprecated.

Method Detail

setType

public Configuration.OutputFormat setType(Configuration.OutputType value)

The output format. See Configuration.OutputType constants. Defaults to Configuration.OutputType.PDF.

Returns:

The current Configuration.OutputFormat instance.

setWidth

public Configuration.OutputFormat setWidth(Integer value)

The with of the output in pixels (image formats only). Values <1 will be computed based on the specified height and the aspect ratio of the input document.

Returns:

The current Configuration.OutputFormat instance.

setHeight

public Configuration.OutputFormat setHeight(Integer value)

The height of the output in pixels (image formats only). Values <1 will be computed based on the specified width and the aspect ratio of the input document.

Returns:

The current Configuration.OutputFormat instance.

setPixelDensity

public Configuration.OutputFormat setPixelDensity(Integer value)

The pixel density of the output (image formats only). When neither 'width' nor 'height' is specified this is used to determine the dimensions of the image from the page size. Values <1 default to 96dpi.

Returns:

The current Configuration.OutputFormat instance.

See Also:

#setPixelDensityUnit(ResolutionUnit)} for the unit of this value (defaults to DPI)

setPixelDensityUnit

public Configuration.OutputFormat setPixelDensityUnit(Configuration.ResolutionUnit pixelDensityUnit)

The unit of the pixel density. Defaults to dpi.

Returns:

The current Configuration.OutputFormat instance.

setMultiImage

public Configuration.OutputFormat setMultiImage(Boolean value)

Indicates whether the image output will be paginated into multiple images.

Returns:

The current Configuration.OutputFormat instance.