Skip navigation links

oracle.imaging
Class RenderOptions

java.lang.Object
oracle.imaging.RenderOptions

Direct Known Subclasses:

RenderResult

public class RenderOptions

extends java.lang.Object

A data structure that defines the options used to render a document. This structure is passed in to the DocumentService.retrievePage and DocumentService.retrieveRendition operations. The class contents default to the following state: fitMode = FITSCALE scalefactor = 100 format = TIFF rotation = ZERO pageNumber = 1 withAnnotations = true

Nested Class Summary

static class	RenderOptions.CompressionType
static class	RenderOptions.FitMode
static class	RenderOptions.OutputFormat
static class	RenderOptions.RenditionOutput
static class	RenderOptions.RotationStop

Field Summary

static int	MAX_SCALE_FACTOR
static int	MIN_SCALE_FACTOR

Constructor Summary

RenderOptions()

Method Summary

java.awt.Rectangle	getBoundRect() Gets the current boundRect property value
RenderOptions.FitMode	getFitMode() Gets the fitMode property
RenderOptions.OutputFormat	getFormat() Gets the Format property.
int	getPageNumber() Gets the Format property.
RenderOptions.RotationStop	getRotation() Gets the Rotation property.
int	getScaleFactor() Gets the ScaleFactor property.
boolean	getWithAnnotations() Gets the WithAnnotations property.
void	setBoundRect(int width, int height) Sets the boundRect property.
void	setBoundRect(java.awt.Rectangle newboundRect) Sets the boundRect property.
void	setFitMode(RenderOptions.FitMode newfitMode) Sets the fitMode property.
void	setFormat(RenderOptions.OutputFormat format) Sets the Format property.
RenderOptions.OutputFormat	setFormat(java.lang.String mimeType) Sets the Format property.
void	setPageNumber(int value) Sets the pageNumber property.
void	setRotation(RenderOptions.RotationStop rotation) Sets the Rotation property.
void	setScaleFactor(int value) Sets the ScaleFactor property.
void	setWithAnnotations(boolean value) Sets the WithAnnotations property.

Methods inherited from class java.lang.Object

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

Field Detail

MIN_SCALE_FACTOR

public static final int MIN_SCALE_FACTOR

See Also:

Constant Field Values

MAX_SCALE_FACTOR

public static final int MAX_SCALE_FACTOR

See Also:

Constant Field Values

Constructor Detail

RenderOptions

public RenderOptions()

Method Detail

setFormat

public void setFormat(RenderOptions.OutputFormat format)

Sets the Format property. Default format setting is Format.TIFF

Parameters:

format - The new Format property value of type @see{RenderOptions.Format}.

setFormat

public RenderOptions.OutputFormat setFormat(java.lang.String mimeType)

Sets the Format property.

Parameters:

mimeType - The mime-type form which to set the new Format property value.

getFormat

public RenderOptions.OutputFormat getFormat()

Gets the Format property.

Returns:

The Format property value.

setRotation

public void setRotation(RenderOptions.RotationStop rotation)

Sets the Rotation property. Default value for rotation is RotationStop.ZERO.

Parameters:

rotation - The new Rotation property value of type @see{RenderOptions.RotationStop}.

getRotation

public RenderOptions.RotationStop getRotation()

Gets the Rotation property.

Returns:

The Rotation property value.

setScaleFactor

public void setScaleFactor(int value)
                    throws ImagingException

Sets the ScaleFactor property. Allowed @see{integer} values range from 10 to 400. The default scale factor is 100.

Parameters:

value - The new ScaleFactor property value.

Throws:

ImagingException

getScaleFactor

public int getScaleFactor()

Gets the ScaleFactor property.

Returns:

The ScaleFactor property value.

setPageNumber

public void setPageNumber(int value)
                   throws ImagingException

Sets the pageNumber property. Default pageNumber is 1.

Parameters:

value - The new pageNumber property value.

Throws:

ImagingException

getPageNumber

public int getPageNumber()

Gets the Format property.

Returns:

The pageNumber property value.

setWithAnnotations

public void setWithAnnotations(boolean value)

Sets the WithAnnotations property. Default value is true.

Parameters:

value - The new WithAnnotations property value.

getWithAnnotations

public boolean getWithAnnotations()

Gets the WithAnnotations property.

setFitMode

public void setFitMode(RenderOptions.FitMode newfitMode)

Sets the fitMode property. Default value is FitScale

Parameters:

newfitMode - is a @see{FitMode} which controls scaling operation.

getFitMode

public RenderOptions.FitMode getFitMode()

Gets the fitMode property

Returns:

the current fitMode property value.

setBoundRect

public void setBoundRect(java.awt.Rectangle newboundRect)
                  throws ImagingException

Sets the boundRect property.

Parameters:

newboundRect - a @see{Rectangle} defining the bounding rectangle used for cropping and scaling

Throws:

ImagingException

setBoundRect

public void setBoundRect(int width,
                         int height)
                  throws ImagingException

Sets the boundRect property. The origin of the rectangle will be set to 0, 0.

Parameters:

width - an @see{int} defining the bounding rectangle width used for cropping and scaling

height - an @see{int} defining the bounding rectangle height used for cropping and scaling

Throws:

ImagingException

getBoundRect

public java.awt.Rectangle getBoundRect()

Gets the current boundRect property value

Returns:

a @see{Rectangle} object containing the bounding rectangle coordinates

Skip navigation links