com.groupdocs.viewer.options

Class ViewOptions

java.lang.Object

com.groupdocs.viewer.options.BaseViewOptions

com.groupdocs.viewer.options.ViewOptions

Direct Known Subclasses:

HtmlViewOptions, JpgViewOptions, PdfViewOptions, PngViewOptions

public abstract class ViewOptions
extends BaseViewOptions

Contains the rendering options.

The ViewOptions class extends the BaseViewOptions class and serves as a base class for rendering options in the GroupDocs.Viewer component. It encapsulates common settings and parameters that can be used for rendering various types of documents into different formats.

Note: The ViewOptions class should not be used directly, use HtmlViewOptions, PdfViewOptions, PngViewOptions and so on instead.

See Also:

JpgViewOptions

Constructor Summary

Constructors

Constructor and Description
ViewOptions()

Method Summary

Modifier and Type	Method and Description
Map<Integer,Rotation>	getPageRotations() Retrieves the page rotations.
Watermark	getWatermark() Gets the text watermark applied to each page.
boolean	isPageRotationsInitialized_Internal() To prevent creating the instance just to check that it is empty
void	rotatePage(int pageNumber, Rotation rotation) Applies a clockwise rotation to the specified page.
void	setWatermark(Watermark value) Sets the text watermark to be applied to each page.

Methods inherited from class com.groupdocs.viewer.options.BaseViewOptions

getArchiveOptions, getCadOptions, getDefaultFontName, getEmailOptions, getMailStorageOptions, getOutlookOptions, getPdfOptions, getPresentationOptions, getProjectManagementOptions, getSpreadsheetOptions, getTextOptions, getVisioRenderingOptions, getWebDocumentOptions, getWordProcessingOptions, isCadOptionsInitialized_Internal, isRenderComments, isRenderHiddenPages, isRenderNotes, setArchiveOptions, setCadOptions, setDefaultFontName, setEmailOptions, setMailStorageOptions, setOutlookOptions, setPdfOptions, setPresentationOptions, setProjectManagementOptions, setRenderComments, setRenderHiddenPages, setRenderNotes, setSpreadsheetOptions, setTextOptions, setVisioRenderingOptions, setWebDocumentOptions, setWordProcessingOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewOptions

public ViewOptions()

Method Detail

getPageRotations

public Map<Integer,Rotation> getPageRotations()

Retrieves the page rotations.

If both setWatermark(Watermark) and getPageRotations() are specified, the watermark will be applied to the rotated pages. For details, see the documentation.

Returns:

a map containing the page numbers as keys and their corresponding rotations as values.

getWatermark

public final Watermark getWatermark()

Gets the text watermark applied to each page.

In case both setWatermark(Watermark) and getPageRotations() are specified, the watermark will be applied to the rotated pages. For details, see the documentation.

Returns:

the text watermark applied to each page.

isPageRotationsInitialized_Internal

public boolean isPageRotationsInitialized_Internal()

To prevent creating the instance just to check that it is empty

rotatePage

public final void rotatePage(int pageNumber,
                             Rotation rotation)

Applies a clockwise rotation to the specified page.

For details, see the documentation.

Parameters:

pageNumber - The page number, must be strictly greater than 0.

rotation - The rotation value.

Throws:

IllegalArgumentException - Thrown when pageNumber is less than or equal to zero.

IllegalArgumentException - Thrown when the rotation for the page with number pageNumber has already been added.

setWatermark

public final void setWatermark(Watermark value)

Sets the text watermark to be applied to each page.

In case both ViewOptions.Watermark and getPageRotations() are specified, the watermark will be applied to the rotated pages. For details, see the documentation.

Parameters:

value - The text watermark to be set.