Groupdocs API References – com.groupdocs.merger.domain.result

Nodejs-Java: DocumentInfo

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

All Implemented Interfaces: com.groupdocs.merger.domain.result.IDocumentInfo

public class DocumentInfo implements IDocumentInfo

Defines document description properties.

Constructors

Constructor	Description
DocumentInfo(int index, InputStream stream, FileType fileType, String password)	Initializes new instance of DocumentInfo class.
DocumentInfo(int index, InputStream stream, FileType fileType, String password, IPageInfo[] pages, long size)	Initializes new instance of DocumentInfo class.
DocumentInfo(FileType fileType, IPageInfo[] pages, long size)	Initializes new instance of DocumentInfo class.

Methods

Method	Description
getIndex()	The document index.
getStream()	The document stream.
getPassword()	The document password.
getType()	Gets the file type.
getPages()	Defines document pages collection.
getPageCount()	The document pages count.
getSize()	Document size in bytes
toString()	Returns a string that represents the current object.

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

public DocumentInfo(int index, InputStream stream, FileType fileType, String password)

Initializes new instance of DocumentInfo class.

Parameters:

Parameter	Type	Description
index	int
stream	java.io.InputStream
fileType	FileType	The type of the file.
password	java.lang.String

DocumentInfo(int index, InputStream stream, FileType fileType, String password, IPageInfo[] pages, long size)

public DocumentInfo(int index, InputStream stream, FileType fileType, String password, IPageInfo[] pages, long size)

Initializes new instance of DocumentInfo class.

Parameters:

Parameter	Type	Description
index	int
stream	java.io.InputStream
fileType	FileType	The type of the file.
password	java.lang.String
pages	IPageInfo[]	The list of pages to view.
size	long	The size of the file.

DocumentInfo(FileType fileType, IPageInfo[] pages, long size)

public DocumentInfo(FileType fileType, IPageInfo[] pages, long size)

Initializes new instance of DocumentInfo class.

Parameters:

Parameter	Type	Description
fileType	FileType	The type of the file.
pages	IPageInfo[]	The list of pages to view.
size	long	The size of the file.

getIndex()

public final int getIndex()

The document index.

Returns: int

getStream()

public final InputStream getStream()

The document stream.

Returns: java.io.InputStream

getPassword()

public final String getPassword()

The document password.

Returns: java.lang.String

getType()

public final FileType getType()

Gets the file type.

Returns: FileType

getPages()

public final IPageInfo[] getPages()

Defines document pages collection.

Returns: com.groupdocs.merger.domain.result.IPageInfo[]

getPageCount()

public final int getPageCount()

The document pages count.

Returns: int

getSize()

public final long getSize()

Document size in bytes

Returns: long

toString()

public String toString()

Returns a string that represents the current object.

Returns: java.lang.String - A string that represents the current object.

Nodejs-Java: PageInfo

Mon, 01 Jan 0001 00:00:00 +0000

Inheritance: java.lang.Object

All Implemented Interfaces: com.groupdocs.merger.domain.result.IPageInfo

public class PageInfo implements IPageInfo

Defines page description properties.

Constructors

Constructor	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.

Methods

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

PageInfo(int number, boolean visible)

public PageInfo(int number, boolean visible)

Initializes new instance of PageInfo class.

Parameters:

Parameter	Type	Description
number	int	The page number.
visible	boolean	The page visibility indicator.

PageInfo(int number, boolean visible, int width, int height)

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

Initializes new instance of PageInfo class.

Parameters:

Parameter	Type	Description
number	int	The page number.
visible	boolean	The page visibility indicator.
width	int	The width of the page in pixels when viewing as JPG or PNG.
height	int	The height of the page in pixels when viewing as JPG or PNG.

getDocument()

public final DocumentInfo getDocument()

Gets the document info.

Returns: DocumentInfo

setDocument(DocumentInfo value)

public final void setDocument(DocumentInfo value)

Gets the document info.

Parameters:

Parameter	Type	Description
value	DocumentInfo

getNumber()

public final int getNumber()

Gets the page number.

Returns: int

getVisible()

public final boolean getVisible()

Indicates whether page is visibile or not.

Returns: boolean

getWidth()

public final int getWidth()

Gets page width in pixels when converted to image.

Returns: int

getHeight()

public final int getHeight()

Gets page height in pixels when converted to image.

Returns: int

Nodejs-Java: IDocumentInfo

Mon, 01 Jan 0001 00:00:00 +0000

public interface IDocumentInfo

Interface for the document description properties.

Methods

Method	Description
getType()	Gets the file type.
getPages()	Defines document pages collection.
getPageCount()	The document pages count.
getSize()	Document size in bytes.

getType()

public abstract FileType getType()

Gets the file type.

Returns: FileType

getPages()

public abstract IPageInfo[] getPages()

Defines document pages collection.

Returns: com.groupdocs.merger.domain.result.IPageInfo[]

getPageCount()

public abstract int getPageCount()

The document pages count.

Returns: int

getSize()

public abstract long getSize()

Document size in bytes.

Returns: long

Nodejs-Java: IPageInfo

Mon, 01 Jan 0001 00:00:00 +0000

public interface IPageInfo

Interface for the page description properties.

Methods

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

getDocument()

public abstract DocumentInfo getDocument()

Gets the document info.

Returns: DocumentInfo

setDocument(DocumentInfo value)

public abstract void setDocument(DocumentInfo value)

Gets the document info.

Parameters:

Parameter	Type	Description
value	DocumentInfo

getNumber()

public abstract int getNumber()

Gets the page number.

Returns: int

getVisible()

public abstract boolean getVisible()

Indicates whether page is visibile or not.

Returns: boolean

getWidth()

public abstract int getWidth()

Gets page width in pixels when converted to image.

Returns: int

getHeight()

public abstract int getHeight()

Gets page height in pixels when converted to image.

Returns: int