com.groupdocs.viewer.options

Class ViewInfoOptions

java.lang.Object

com.groupdocs.viewer.options.BaseViewOptions

com.groupdocs.viewer.options.ViewInfoOptions

All Implemented Interfaces:

IMaxSizeOptions

public class ViewInfoOptions
extends BaseViewOptions
implements IMaxSizeOptions

Provides options used for retrieving information about view.

The ViewInfoOptions class encapsulates additional settings and parameters that can be used to retrieve information about a view in the GroupDocs.Viewer component.

Example usage:

 ViewInfoOptions viewInfoOptions = ViewInfoOptions.forPngView(false);
 try (Viewer viewer = new Viewer("document.pdf")) {
     ViewInfo viewInfo = viewer.getViewInfo(viewInfoOptions);
     // Use the viewInfo object for further operations
 }
 

Note: The ViewInfoOptions class implements the IMaxSizeOptions interface to provide additional settings and size constraints for view information retrieval.

See Also:

Viewer, ViewInfo

Method Summary

Modifier and Type	Method and Description
static ViewInfoOptions	forHtmlView() Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into HTML.
static ViewInfoOptions	forHtmlView(boolean renderSinglePage) Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into HTML.
static ViewInfoOptions	forJpgView() Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into JPG.
static ViewInfoOptions	forJpgView(boolean extractText) Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into JPG.
static ViewInfoOptions	forPdfView() Initializes a new instance of the ViewInfoOptions class to retrieve information about view when rendering into PDF.
static ViewInfoOptions	forPngView() Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into PNG.
static ViewInfoOptions	forPngView(boolean extractText) Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into PNG.
static ViewInfoOptions	fromHtmlViewOptions(HtmlViewOptions options) Initializes a new instance of the ViewInfoOptions class based on the HtmlViewOptions object.
static ViewInfoOptions	fromJpgViewOptions(JpgViewOptions options) Initializes a new instance of the ViewInfoOptions class based on the JpgViewOptions object.
static ViewInfoOptions	fromPdfViewOptions(PdfViewOptions options) Initializes a new instance of the ViewInfoOptions class based on a PdfViewOptions object.
static ViewInfoOptions	fromPngViewOptions(PngViewOptions options) Initializes a new instance of the ViewInfoOptions class based on the PngViewOptions object.
int	getHeight() The height of the output image (in pixels, for rendering to PNG/JPG only).
int	getMaxHeight() Returns the maximum height of the output image for rendering to PNG/JPG.
int	getMaxWidth() Returns the maximum width of the output image for rendering to PNG/JPG.
int	getWidth() The width of the output image (in pixels, for rendering to PNG/JPG only).
boolean	isExtractText() Indicates whether text extraction is enabled.
void	setExtractText(boolean extractText) Sets the flag indicating whether text extraction is enabled.
void	setHeight(int height) The height of the output image (in pixels, for rendering to PNG/JPG only).
void	setMaxHeight(int maxHeight) Sets the maximum height of an output image (in pixels, for rendering to PNG/JPG only).
void	setMaxWidth(int maxWidth) Sets the maximum width of an output image (in pixels, for rendering to PNG/JPG only).
void	setWidth(int width) The width of the output image (in pixels, for rendering to PNG/JPG only).

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

Method Detail

forHtmlView

public static ViewInfoOptions forHtmlView()

Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into HTML.

Returns:

New instance of the ViewInfoOptions class.

forHtmlView

public static ViewInfoOptions forHtmlView(boolean renderSinglePage)

Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into HTML.

Note: By default, HTML content will be rendered on multiple pages.

Parameters:

renderSinglePage - Enables HTML content to be rendered on a single page.

Returns:

New instance of ViewInfoOptions class.

forJpgView

public static ViewInfoOptions forJpgView()

Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into JPG.

Returns:

New instance of ViewInfoOptions class.

forJpgView

public static ViewInfoOptions forJpgView(boolean extractText)

Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into JPG.

Parameters:

extractText - Enables text extraction.

Returns:

New instance of ViewInfoOptions class.

forPdfView

public static ViewInfoOptions forPdfView()

Initializes a new instance of the ViewInfoOptions class to retrieve information about view when rendering into PDF.

Returns:

A new instance of the ViewInfoOptions class.

forPngView

public static ViewInfoOptions forPngView()

Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into PNG.

Returns:

New instance of ViewInfoOptions class.

forPngView

public static ViewInfoOptions forPngView(boolean extractText)

Initializes a new instance of the ViewInfoOptions class to retrieve information about the view when rendering into PNG.

Parameters:

extractText - Enables text extraction.

Returns:

New instance of ViewInfoOptions class.

fromHtmlViewOptions

public static ViewInfoOptions fromHtmlViewOptions(HtmlViewOptions options)

Initializes a new instance of the ViewInfoOptions class based on the HtmlViewOptions object.

Parameters:

options - The HTML view options.

Returns:

New instance of ViewInfoOptions class.

Throws:

IllegalArgumentException - Thrown when options is null.

See Also:

HtmlViewOptions

fromJpgViewOptions

public static ViewInfoOptions fromJpgViewOptions(JpgViewOptions options)

Initializes a new instance of the ViewInfoOptions class based on the JpgViewOptions object.

Parameters:

options - The JPG view options.

Returns:

New instance of ViewInfoOptions class.

Throws:

IllegalArgumentException - Thrown when options is null.

See Also:

JpgViewOptions

fromPdfViewOptions

public static ViewInfoOptions fromPdfViewOptions(PdfViewOptions options)

Initializes a new instance of the ViewInfoOptions class based on a PdfViewOptions object.

Parameters:

options - The PDF view options.

Returns:

A new instance of the ViewInfoOptions class.

Throws:

IllegalArgumentException - Thrown when options is null.

fromPngViewOptions

public static ViewInfoOptions fromPngViewOptions(PngViewOptions options)

Initializes a new instance of the ViewInfoOptions class based on the PngViewOptions object.

Parameters:

options - The PNG view options.

Returns:

New instance of ViewInfoOptions class.

Throws:

IllegalArgumentException - Thrown when options is null.

See Also:

PngViewOptions

getHeight

public int getHeight()

The height of the output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the output image height (in pixels). For code example, see the documentation. If you set this property, the property is ignored.

Returns:

the height of the image.

getMaxHeight

public int getMaxHeight()

Returns the maximum height of the output image for rendering to PNG/JPG.

Use this property to set the maximum output image height (in pixels). For code example, see the documentation. If you set the property, this property is ignored.

Specified by:

getMaxHeight in interface IMaxSizeOptions

Returns:

the maximum height of the output image.

getMaxWidth

public int getMaxWidth()

Returns the maximum width of the output image for rendering to PNG/JPG.

Use this property to set the maximum output image width (in pixels). For code example, see the documentation. If you set the property, this property is ignored.

Specified by:

getMaxWidth in interface IMaxSizeOptions

Returns:

the maximum width of the output image.

getWidth

public int getWidth()

The width of the output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the output image width (in pixels). For code example, see the documentation. If you set this property, the property is ignored.

Returns:

the width of the image.

isExtractText

public boolean isExtractText()

Indicates whether text extraction is enabled.

Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering. For code example, see the documentation.

Returns:

True if text extraction is enabled, false otherwise.

setExtractText

public void setExtractText(boolean extractText)

Sets the flag indicating whether text extraction is enabled.

Use this property to get the text contained in a source document and its coordinates. Then you can use this data to add a selectable text over the image or to implement a text search in image-based rendering. For code example, see the documentation.

Parameters:

extractText - True to enable text extraction, false to disable.

setHeight

public void setHeight(int height)

The height of the output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the output image height (in pixels). For code example, see the documentation. If you set this property, the property is ignored.

Parameters:

height - The height of the image.

setMaxHeight

public void setMaxHeight(int maxHeight)

Sets the maximum height of an output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the maximum output image height (in pixels). For code example, see the documentation. If you set the property, this property is ignored.

Specified by:

setMaxHeight in interface IMaxSizeOptions

Parameters:

maxHeight - The maximum height of the output image.

setMaxWidth

public void setMaxWidth(int maxWidth)

Sets the maximum width of an output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the maximum output image width (in pixels). For code example, see the documentation. If you set the property, this property is ignored.

Specified by:

setMaxWidth in interface IMaxSizeOptions

Parameters:

maxWidth - The maximum width of the output image.

setWidth

public void setWidth(int width)

The width of the output image (in pixels, for rendering to PNG/JPG only).

Use this property to set the output image width (in pixels). For code example, see the documentation. If you set this property, the property is ignored.

Parameters:

width - The width of the image.