PageBuilder

Inheritance: java.lang.Object

public class PageBuilder

PageInfo builder for getting the page collection from the documents.

Constructors

Constructor	Description
PageBuilder()	Initializes a new instance of the PageBuilder class.
PageBuilder(PageBuilderOptions options)	Initializes a new instance of the PageBuilder class.

Methods

Method	Description
getOptions()	The page builder options.
getPages()	The page collection.
getDocuments()	The document collection.
addDocument(int index, InputStream stream, FileType fileType, String password)	Add document to the document collection.
addDocument(DocumentInfo document)	Add document to the document collection.
addPage(int documentIndex, int pageNumber)	Add page to the page collection.
addPage(IPageInfo page)	Add page to the page collection.
addPageRange(IPageInfo[] pages)	Add pages to the page collection.
clear()	Clear the internal collections.

PageBuilder()

public PageBuilder()

Initializes a new instance of the PageBuilder class.

PageBuilder(PageBuilderOptions options)

public PageBuilder(PageBuilderOptions options)

Initializes a new instance of the PageBuilder class.

Parameters:

Parameter	Type	Description
options	PageBuilderOptions	The page builder options.

getOptions()

public final PageBuilderOptions getOptions()

The page builder options.

Returns: PageBuilderOptions

getPages()

public final List<PageInfo> getPages()

The page collection.

Returns: java.util.List<com.groupdocs.merger.domain.result.PageInfo>

getDocuments()

public final Map<Integer,DocumentInfo> getDocuments()

The document collection.

Returns: java.util.Map<java.lang.Integer,com.groupdocs.merger.domain.result.DocumentInfo>

addDocument(int index, InputStream stream, FileType fileType, String password)

public final void addDocument(int index, InputStream stream, FileType fileType, String password)

Add document to the document collection.

Parameters:

Parameter	Type	Description
index	int	DocumentInfo index.
stream	java.io.InputStream	DocumentInfo stream.
fileType	FileType	DocumentInfo type.
password	java.lang.String	DocumentInfo password.

addDocument(DocumentInfo document)

public final void addDocument(DocumentInfo document)

Add document to the document collection.

Parameters:

Parameter	Type	Description
document	DocumentInfo	DocumentInfo instance.

addPage(int documentIndex, int pageNumber)

public final void addPage(int documentIndex, int pageNumber)

Add page to the page collection.

Parameters:

Parameter	Type	Description
documentIndex	int	DocumentInfo index.
pageNumber	int	PageInfo number.

addPage(IPageInfo page)

public final void addPage(IPageInfo page)

Add page to the page collection.

Parameters:

Parameter	Type	Description
page	IPageInfo	PageInfo instance.

addPageRange(IPageInfo[] pages)

public final void addPageRange(IPageInfo[] pages)

Add pages to the page collection.

Parameters:

Parameter	Type	Description
pages	IPageInfo[]	Pages array.

clear()

public final void clear()

Clear the internal collections.