com.groupdocs.viewer

Class Viewer

java.lang.Object

com.groupdocs.viewer.Viewer

All Implemented Interfaces:

Closeable, AutoCloseable

public class Viewer
extends Object
implements Closeable

Represents the main class that controls the document rendering process.

The Viewer class is the entry point for rendering documents using the GroupDocs.Viewer component. It provides methods and options to load documents from various sources, customize the rendering process, and retrieve the rendered output in different formats.

Example usage:

 try (Viewer viewer = new Viewer("source.pdf")) {
     viewer.view(new PngViewOptions("result-page{0}.png"));
 }
 

See Also:

PngViewOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_READER
static String	LOAD_OPTIONS
static String	OPTIONS
static String	SETTINGS

Constructor Summary

Constructors

Constructor and Description
Viewer(FileReader fileReader, LoadOptions loadOptions, ViewerSettings settings) Initializes a new instance of the Viewer class.
Viewer(FileReader fileReader, ViewerSettings settings) Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream) Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, boolean leaveOpen) Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, LoadOptions loadOptions) Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, LoadOptions loadOptions, boolean leaveOpen) Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings) Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, LoadOptions loadOptions, ViewerSettings settings, boolean leaveOpen) Initializes new instance of Viewer class.
Viewer(InputStream fileStream, ViewerSettings settings) Initializes a new instance of the Viewer class.
Viewer(InputStream fileStream, ViewerSettings settings, boolean leaveOpen) Initializes a new instance of the Viewer class.
Viewer(Path filePath) Initializes a new instance of the Viewer class.
Viewer(Path filePath, LoadOptions loadOptions) Initializes a new instance of the Viewer class.
Viewer(Path filePath, LoadOptions loadOptions, ViewerSettings settings) Initializes a new instance of the Viewer class.
Viewer(Path filePath, ViewerSettings settings) Initializes a new instance of the Viewer class.
Viewer(String filePath) Initializes a new instance of the Viewer class.
Viewer(String filePath, LoadOptions loadOptions) Initializes a new instance of the Viewer class.
Viewer(String filePath, LoadOptions loadOptions, ViewerSettings settings) Initializes a new instance of the Viewer class.
Viewer(String filePath, ViewerSettings settings) Initializes a new instance of the Viewer class.
Viewer(URL url) Initializes a new instance of the Viewer class.
Viewer(URL url, LoadOptions loadOptions) Initializes a new instance of the Viewer class.
Viewer(URL url, LoadOptions loadOptions, ViewerSettings settings) Initializes a new instance of the Viewer class.
Viewer(URL url, ViewerSettings settings) Initializes a new instance of the Viewer class.

Method Summary

Modifier and Type	Method and Description
void	close() Releases the file stream and managed internal resources.
com.groupdocs.viewer.fonts.IFontInfo[]	getAllFonts() Returns all fonts used in the loaded documents, including those embedded inside the document itself and those system fonts installed in the OS and used in the document.
List<Attachment>	getAttachments() Returns attachments contained by the document.
FileInfo	getFileInfo() Returns information about the file, such as file type and a flag that indicates if the file is encrypted.
ViewInfo	getViewInfo(ViewInfoOptions options) Returns information about the view and document specific information.
protected void	initViewerFromUrl(URL url, int urlConnectTimeout, int urlReadTimeout)
void	saveAttachment(Attachment attachment, OutputStream destination) Saves an attachment file to the destination stream.
void	search(com.groupdocs.viewer.options.SearchHighlightOptions options) Performs a text search and highlights matches (if found) in the loaded document according to the provided options.
void	view(ViewOptions options) Creates a view of all document pages.
void	view(ViewOptions options, int... pageNumbers) Creates a view of specific document pages.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_READER

public static final String FILE_READER

See Also:

Constant Field Values

LOAD_OPTIONS

public static final String LOAD_OPTIONS

See Also:

Constant Field Values

OPTIONS

public static final String OPTIONS

See Also:

Constant Field Values

SETTINGS

public static final String SETTINGS

See Also:

Constant Field Values

Constructor Detail

Viewer

public Viewer(FileReader fileReader,
              LoadOptions loadOptions,
              ViewerSettings settings)

Initializes a new instance of the Viewer class.

Provides functionality to load and view documents using GroupDocs.Viewer.

Note: Ensure that the file reader, load options, and settings are properly configured for accurate document processing.

Parameters:

fileReader - The file reader.

loadOptions - The load options.

settings - The Viewer settings.

Throws:

IllegalArgumentException - Thrown when fileReader is null.

IllegalArgumentException - Thrown when loadOptions is null.

IllegalArgumentException - Thrown when settings is null.

See Also:

FileReader, LoadOptions, ViewerSettings

Viewer

public Viewer(FileReader fileReader,
              ViewerSettings settings)

Initializes a new instance of the Viewer class.

This constructor allows you to create a Viewer object to view a document from a FileReader with the specified ViewerSettings.

Learn more

• To learn about the file types supported by GroupDocs.Viewer, visit: Document formats supported by GroupDocs.Viewer
• To explore the features of GroupDocs.Viewer for Java, refer to: Developer Guide

Parameters:

fileReader - The FileReader containing the document to be loaded into the Viewer.

settings - The ViewerSettings to be applied to the Viewer.

Throws:

IllegalArgumentException - Thrown when fileReader is null.

IllegalArgumentException - Thrown when settings is null.

Viewer

public Viewer(InputStream fileStream)

Initializes a new instance of the Viewer class.

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer

Parameters:

fileStream - The method that returns a readable stream.

Throws:

IllegalArgumentException - Thrown when fileStream is null.

Viewer

public Viewer(InputStream fileStream,
              boolean leaveOpen)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

fileStream - The file stream.

leaveOpen - true to leave the stream open after the Viewer object is disposed; otherwise, false.

Throws:

IllegalArgumentException - Thrown when fileStream is null.

Viewer

public Viewer(InputStream fileStream,
              LoadOptions loadOptions)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

fileStream - The readable stream.

loadOptions - The document load options.

Throws:

IllegalArgumentException - Thrown when fileStream is null.

IllegalArgumentException - Thrown when loadOptions is null.

Viewer

public Viewer(InputStream fileStream,
              LoadOptions loadOptions,
              boolean leaveOpen)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

fileStream - The file stream.

loadOptions - The document load options.

leaveOpen - true to leave the stream open after the Viewer object is disposed; otherwise, false.

Throws:

IllegalArgumentException - Thrown when fileStream is null.

IllegalArgumentException - Thrown when loadOptions is null.

Viewer

public Viewer(InputStream fileStream,
              LoadOptions loadOptions,
              ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

fileStream - The file stream.

loadOptions - The document load options.

settings - The Viewer settings.

Throws:

IllegalArgumentException - Thrown when fileStream is null.

IllegalArgumentException - Thrown when loadOptions is null.

IllegalArgumentException - Thrown when settings is null.

Viewer

public Viewer(InputStream fileStream,
              LoadOptions loadOptions,
              ViewerSettings settings,
              boolean leaveOpen)

Initializes new instance of Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

fileStream - The file stream.

loadOptions - The document load options.

settings - The Viewer settings.

leaveOpen - true to leave the stream open after the Viewer object is disposed; otherwise, false.

Viewer

public Viewer(InputStream fileStream,
              ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

fileStream - The file stream.

settings - The Viewer settings.

Throws:

IllegalArgumentException - Thrown when fileStream is null.

IllegalArgumentException - Thrown when settings is null.

Viewer

public Viewer(InputStream fileStream,
              ViewerSettings settings,
              boolean leaveOpen)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide

Parameters:

fileStream - The file stream.

settings - The Viewer settings.

leaveOpen - true to leave the stream open after the Viewer object is disposed; otherwise, false.

Throws:

IllegalArgumentException - Thrown when fileStream is null.

IllegalArgumentException - Thrown when settings is null.

Viewer

public Viewer(Path filePath)
       throws FileNotFoundException

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide

Parameters:

filePath - The path to the file to render.

Throws:

FileNotFoundException - Thrown when the file cannot be found or cannot be read.

IllegalArgumentException - Thrown when filePath is null or empty.

Viewer

public Viewer(Path filePath,
              LoadOptions loadOptions)
       throws FileNotFoundException

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view a document with GroupDocs.Viewer

Parameters:

filePath - The path to the file to render.

loadOptions - The document load options.

Throws:

FileNotFoundException - Thrown when the file cannot be found or cannot be read.

IllegalArgumentException - Thrown when filePath is null or empty.

IllegalArgumentException - Thrown when loadOptions is null.

Viewer

public Viewer(Path filePath,
              LoadOptions loadOptions,
              ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view documents with GroupDocs.Viewer

Parameters:

filePath - The path to the file to render.

loadOptions - The document load options.

settings - The Viewer settings.

Throws:

IllegalArgumentException - Thrown when filePath is null or empty.

IllegalArgumentException - Thrown when loadOptions is null.

IllegalArgumentException - Thrown when settings is null.

Viewer

public Viewer(Path filePath,
              ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide

Parameters:

filePath - The path to the file to render.

settings - The Viewer settings.

Throws:

IllegalArgumentException - Thrown when filePath is null or empty.

IllegalArgumentException - Thrown when settings is null.

Viewer

public Viewer(String filePath)
       throws FileNotFoundException

Initializes a new instance of the Viewer class.

Learn more:

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide

Parameters:

filePath - The path to the file to render.

Throws:

FileNotFoundException - Thrown when the file cannot be found or read.

IllegalArgumentException - Thrown when filePath is null or empty.

Viewer

public Viewer(String filePath,
              LoadOptions loadOptions)
       throws FileNotFoundException

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

filePath - The path to the file to render.

loadOptions - The document load options.

Throws:

FileNotFoundException - Thrown when the file cannot be found or cannot be read.

IllegalArgumentException - Thrown when filePath is null or empty.

IllegalArgumentException - Thrown when loadOptions is null.

Viewer

public Viewer(String filePath,
              LoadOptions loadOptions,
              ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading password-protected documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view documents with GroupDocs.Viewer

Parameters:

filePath - The path to the file to render.

loadOptions - The document load options.

settings - The Viewer settings.

Throws:

IllegalArgumentException - Thrown when filePath is null or empty.

IllegalArgumentException - Thrown when loadOptions is null.

IllegalArgumentException - Thrown when settings is null.

Viewer

public Viewer(String filePath,
              ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide

Parameters:

filePath - The path to the file to render.

settings - The Viewer settings.

Throws:

IllegalArgumentException - Thrown when filePath is null or empty.

IllegalArgumentException - Thrown when settings is null.

Viewer

public Viewer(URL url)

Initializes a new instance of the Viewer class.

More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer

Parameters:

url - A URL to a file that should be loaded into the Viewer.

Throws:

IllegalArgumentException - Thrown when url is null.

Viewer

public Viewer(URL url,
              LoadOptions loadOptions)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

url - A URL to a file that should be loaded into the Viewer.

loadOptions - The document load options.

Throws:

IllegalArgumentException - Thrown when url is null.

IllegalArgumentException - Thrown when loadOptions is null.

Viewer

public Viewer(URL url,
              LoadOptions loadOptions,
              ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

url - A URL to a file that should be loaded into the Viewer.

loadOptions - The document load options.

settings - The Viewer settings.

Throws:

IllegalArgumentException - Thrown when url is null.

IllegalArgumentException - Thrown when loadOptions is null.

IllegalArgumentException - Thrown when settings is null.

Viewer

public Viewer(URL url,
              ViewerSettings settings)

Initializes a new instance of the Viewer class.

Learn more

• More about file types supported by GroupDocs.Viewer: Document formats supported by GroupDocs.Viewer
• More about GroupDocs.Viewer for Java features: Developer Guide
• More about loading encrypted documents and viewing files from third-party storages with GroupDocs.Viewer for Java: How to load and view document with GroupDocs.Viewer

Parameters:

url - A URL to a file that should be loaded into the Viewer.

settings - The Viewer settings.

Throws:

IllegalArgumentException - Thrown when url is null.

IllegalArgumentException - Thrown when settings is null.

Method Detail

close

public final void close()

Releases the file stream and managed internal resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getAllFonts

public com.groupdocs.viewer.fonts.IFontInfo[] getAllFonts()
                                                   throws Exception

Returns all fonts used in the loaded documents, including those embedded inside the document itself and those system fonts installed in the OS and used in the document.

For details, see the documentation.

Returns:

Non-null list of all fonts used in the document loaded into this Viewer instance.

Throws:

Exception

getAttachments

public final List<Attachment> getAttachments()
                                      throws PasswordRequiredException,
                                             IncorrectPasswordException

Returns attachments contained by the document.

Learn more:

• Learn more about getting document attachments in Java: How to get a list of document attachments using GroupDocs.Viewer
• Learn more about saving document attachments in Java: How to save document attachments using GroupDocs.Viewer

Returns:

attachments contained by the document.

Throws:

PasswordRequiredException - Thrown when a password is required to open the document.

IncorrectPasswordException - Thrown when the specified password is incorrect.

getFileInfo

public FileInfo getFileInfo()

Returns information about the file, such as file type and a flag that indicates if the file is encrypted.

Learn more:

• Learn more about how to check if a file is encrypted: How to check if a file is encrypted

Returns:

the file information.

See Also:

FileInfo

getViewInfo

public final ViewInfo getViewInfo(ViewInfoOptions options)
                           throws IllegalArgumentException,
                                  PasswordRequiredException,
                                  IncorrectPasswordException

Returns information about the view and document specific information.

Learn more:

• Learn more about the document - file type, page count, and other format specific properties: How to get file information using GroupDocs.Viewer

Parameters:

options - The view info options.

Returns:

Information about the view and document specific information.

Throws:

IllegalArgumentException - Thrown when options is null.

PasswordRequiredException - Thrown when a password is required to open the document.

IncorrectPasswordException - Thrown when the specified password is incorrect.

initViewerFromUrl

protected void initViewerFromUrl(URL url,
                                 int urlConnectTimeout,
                                 int urlReadTimeout)

saveAttachment

public void saveAttachment(Attachment attachment,
                           OutputStream destination)

Saves an attachment file to the destination stream.

Learn more:

• Learn more about getting document attachments in Java: How to get a list of document attachments using GroupDocs.Viewer
• Learn more about saving document attachments in Java: How to save document attachments using GroupDocs.Viewer

Parameters:

attachment - The attachment.

destination - The writable stream.

Throws:

IllegalArgumentException - Thrown when attachmentId is null or empty.

IllegalArgumentException - Thrown when destination is null.

PasswordRequiredException - Thrown when a password is required to open the document.

IncorrectPasswordException - Thrown when the specified password is incorrect.

GroupDocsViewerException - Thrown when the attachment could not be found.

search

public void search(com.groupdocs.viewer.options.SearchHighlightOptions options)
            throws Exception

Performs a text search and highlights matches (if found) in the loaded document according to the provided options.

Parameters:

options - Search and highlight options, including a text phrase to search. Cannot be null.

Throws:

IllegalArgumentException - Is thrown when the options argument is null.

IllegalStateException - Is thrown when the loaded document is invalid or improperly loaded.

Exception

view

public final void view(ViewOptions options)

Creates a view of all document pages.

Learn more

• Learn more about different viewing options following this guide: How to customize document viewing output using GroupDocs.Viewer

Parameters:

options - The view options.

Throws:

IllegalArgumentException - Thrown when options is null.

PasswordRequiredException - Thrown when a password is required to open the document.

IncorrectPasswordException - Thrown when the specified password is incorrect.

GroupDocsViewerException - Thrown when the attachment could not be found.

view

public final void view(ViewOptions options,
                       int... pageNumbers)

Creates a view of specific document pages.

Learn more

• Learn more about different viewing options following this guide: How to customize document viewing output using GroupDocs.Viewer

Parameters:

options - The view options.

pageNumbers - The page numbers to view.

Throws:

IllegalArgumentException - Thrown when options is null.

IllegalArgumentException - Thrown when pageNumbers is null or empty.

PasswordRequiredException - Thrown when a password is required to open the document.

IncorrectPasswordException - Thrown when the specified password is incorrect.

GroupDocsViewerException - Thrown when the attachment could not be found.