com.groupdocs.merger.domain.result

Class PageInfo

java.lang.Object

com.groupdocs.merger.domain.result.PageInfo

All Implemented Interfaces:

IPageInfo

public class PageInfo
extends Object
implements IPageInfo

Defines page description properties.

Constructor Summary

Constructors

Constructor and Description
PageInfo(int number, boolean visible) Initializes new instance of PageInfo class.
PageInfo(int number, boolean visible, int width, int height) Initializes new instance of PageInfo class.

Method Summary

Modifier and Type	Method and Description
DocumentInfo	getDocument() Gets the document info.
int	getHeight() Gets page height in pixels when converted to image.
int	getNumber() Gets the page number.
boolean	getVisible() Indicates whether page is visibile or not.
int	getWidth() Gets page width in pixels when converted to image.
void	setDocument(DocumentInfo value) Gets the document info.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageInfo

public PageInfo(int number,
                boolean visible)
         throws Exception

Initializes new instance of PageInfo class.

Parameters:

number - The page number.

visible - The page visibility indicator.

Throws:

Exception - Thrown when number is less or equal to zero.

PageInfo

public PageInfo(int number,
                boolean visible,
                int width,
                int height)
         throws Exception

Initializes new instance of PageInfo class.

Parameters:

number - The page number.

visible - The page visibility indicator.

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

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

Throws:

Exception - Thrown when number is less or equal to zero.

Exception - Thrown when width is less or equal to zero.

Exception - Thrown when height is less or equal to zero.

Method Detail

getDocument

public final DocumentInfo getDocument()

Gets the document info.

Specified by:

getDocument in interface IPageInfo

getHeight

public final int getHeight()

Gets page height in pixels when converted to image.

Specified by:

getHeight in interface IPageInfo

getNumber

public final int getNumber()

Gets the page number.

Specified by:

getNumber in interface IPageInfo

getVisible

public final boolean getVisible()

Indicates whether page is visibile or not.

Specified by:

getVisible in interface IPageInfo

getWidth

public final int getWidth()

Gets page width in pixels when converted to image.

Specified by:

getWidth in interface IPageInfo

setDocument

public final void setDocument(DocumentInfo value)

Gets the document info.

Specified by:

setDocument in interface IPageInfo