|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.imaging.RenderOptions
public class RenderOptions
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 |
---|
public static final int MIN_SCALE_FACTOR
public static final int MAX_SCALE_FACTOR
Constructor Detail |
---|
public RenderOptions()
Method Detail |
---|
public void setFormat(RenderOptions.OutputFormat format)
format
- The new Format property value of type @see{RenderOptions.Format}.public RenderOptions.OutputFormat setFormat(java.lang.String mimeType)
mimeType
- The mime-type form which to set the new Format property value.public RenderOptions.OutputFormat getFormat()
public void setRotation(RenderOptions.RotationStop rotation)
rotation
- The new Rotation property value of type @see{RenderOptions.RotationStop}.public RenderOptions.RotationStop getRotation()
public void setScaleFactor(int value) throws ImagingException
value
- The new ScaleFactor property value.ImagingException
public int getScaleFactor()
public void setPageNumber(int value) throws ImagingException
value
- The new pageNumber property value.ImagingException
public int getPageNumber()
public void setWithAnnotations(boolean value)
value
- The new WithAnnotations property value.public boolean getWithAnnotations()
public void setFitMode(RenderOptions.FitMode newfitMode)
newfitMode
- is a @see{FitMode} which controls scaling operation.public RenderOptions.FitMode getFitMode()
public void setBoundRect(java.awt.Rectangle newboundRect) throws ImagingException
newboundRect
- a @see{Rectangle} defining the bounding rectangle used for cropping and scalingImagingException
public void setBoundRect(int width, int height) throws ImagingException
width
- an @see{int} defining the bounding rectangle width used for cropping and scalingheight
- an @see{int} defining the bounding rectangle height used for cropping and scalingImagingException
public java.awt.Rectangle getBoundRect()
|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |