com.groupdocs.viewer.results

Interface Page

All Superinterfaces:

Serializable

public interface Page
extends Serializable

Represents a single page that can be viewed.

The Page interface defines the contract for accessing and manipulating a single page that can be viewed in the GroupDocs.Viewer component. It provides methods to retrieve information such as the page number, size, and other properties.

Example usage:

 try (Viewer viewer = new Viewer("document.pst")) {
     final OutlookViewInfo viewInfo = (OutlookViewInfo) viewer.getViewInfo(ViewInfoOptions.forHtmlView());
     List<Page> pages = viewInfo.getPages();
     for (Page page : pages) {
         // Use the page object for further operations
     }
 }
 

Note: The default implementation of this interface is PageImpl.

See Also:

Viewer, OutlookViewInfo, ViewInfoOptions

Method Summary

Modifier and Type	Method and Description
int	getHeight() Retrieves the height of the page in pixels when viewing as JPG or PNG.
List<Line>	getLines() Retrieves the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction.
String	getName() Retrieves the name of the worksheet or page.
int	getNumber() Retrieves the page number.
int	getWidth() Retrieves the width of the page in pixels when viewing as JPG or PNG.
boolean	isVisible() Retrieves the page visibility indicator.
void	setHeight(int height) Sets the height of the page in pixels when viewing as JPG or PNG.
void	setLines(List<Line> lines) Sets the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction.
void	setName(String name) Sets the name of the worksheet or page.
void	setNumber(int number) Sets the page number.
void	setVisible(boolean visible) Sets the page visibility indicator.
void	setWidth(int width) Sets the width of the page in pixels when viewing as JPG or PNG.

Method Detail

getHeight

int getHeight()

Retrieves the height of the page in pixels when viewing as JPG or PNG.

Returns:

the height of the page.

getLines

List<Line> getLines()

Retrieves the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction.

Returns:

the lines contained in the page.

See Also:

Line

getName

String getName()

Retrieves the name of the worksheet or page.

Returns:

the name of the worksheet or page.

getNumber

int getNumber()

Retrieves the page number.

Returns:

the page number.

getWidth

int getWidth()

Retrieves the width of the page in pixels when viewing as JPG or PNG.

Returns:

the width of the page.

isVisible

boolean isVisible()

Retrieves the page visibility indicator.

Returns:

the page visibility indicator.

setHeight

void setHeight(int height)

Sets the height of the page in pixels when viewing as JPG or PNG.

Parameters:

height - the height to set for the page.

setLines

void setLines(List<Line> lines)

Sets the lines contained in the page when viewing as JPG or PNG with enabled Text Extraction.

Parameters:

lines - the list of lines to set for the page.

setName

void setName(String name)

Sets the name of the worksheet or page.

Parameters:

name - the name to set for the worksheet or page.

setNumber

void setNumber(int number)

Sets the page number.

Parameters:

number - the page number to set.

setVisible

void setVisible(boolean visible)

Sets the page visibility indicator.

Parameters:

visible - true if the page is visible, false otherwise.

setWidth

void setWidth(int width)

Sets the width of the page in pixels when viewing as JPG or PNG.

Parameters:

width - the width to set for the page.