public class PreviewOptions extends Object
Provides options to sets requirements and stream delegates for preview generation.
Modifier and Type | Class and Description |
---|---|
static class |
PreviewOptions.PreviewFormats
Represents supported preview formats.
|
Constructor and Description |
---|
PreviewOptions(ICreatePageStream createPageStream)
Initializes a new instance of the
class causing the output stream to be closed. |
PreviewOptions(ICreatePageStream createPageStream,
IReleasePageStream releasePageStream)
Initializes a new instance of
class causing the output stream to be returned
to the client for further use. |
Modifier and Type | Method and Description |
---|---|
ICreatePageStream |
getCreatePageStream()
Gets or sets an instance of the page stream creation class.
|
int |
getHeight()
Gets the page preview height.
|
int[] |
getPageNumbers()
Gets an array of page numbers to generate previews.
|
int |
getPreviewFormat()
Gets the preview image format.
|
IReleasePageStream |
getReleasePageStream()
Gets or sets an instance of the page preview completion class.
|
int |
getWidth()
Gets the page preview width.
|
void |
setCreatePageStream(ICreatePageStream value)
Gets or sets an instance of the page stream creation class.
|
void |
setHeight(int value)
Sets the page preview height.
|
void |
setPageNumbers(int[] value)
Sets an array of page numbers to generate previews.
|
void |
setPreviewFormat(int value)
Sets the preview image format.
|
void |
setReleasePageStream(IReleasePageStream value)
Gets or sets an instance of the page preview completion class.
|
void |
setWidth(int value)
Sets the page preview width.
|
public PreviewOptions(ICreatePageStream createPageStream)
PreviewOptions
class causing the output stream to be closed.createPageStream
- Creates a stream for a specific page preview.public PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
PreviewOptions
class causing the output stream to be returned
to the client for further use.createPageStream
- Creates a stream for a specific page preview.releasePageStream
- Notifies that the page preview generation is done and gets the output stream.public final int getWidth()
Gets the page preview width.
public final void setWidth(int value)
Sets the page preview width.
value
- The page preview width.public final int getHeight()
Gets the page preview height.
public final void setHeight(int value)
Sets the page preview height.
value
- The page preview height.public final int[] getPageNumbers()
Gets an array of page numbers to generate previews.
public final void setPageNumbers(int[] value)
Sets an array of page numbers to generate previews.
value
- The array of page numbers to generate previews.public final int getPreviewFormat()
Gets the preview image format.
public final void setPreviewFormat(int value)
Sets the preview image format.
value
- The preview image format.public final ICreatePageStream getCreatePageStream()
Gets or sets an instance of the page stream creation class.
public final void setCreatePageStream(ICreatePageStream value)
Gets or sets an instance of the page stream creation class.
public final IReleasePageStream getReleasePageStream()
Gets or sets an instance of the page preview completion class.
public final void setReleasePageStream(IReleasePageStream value)
Gets or sets an instance of the page preview completion class.