com.groupdocs.signature.domain.documentpreview

Class DocumentInfo

java.lang.Object

com.groupdocs.signature.domain.documentpreview.DocumentInfo

All Implemented Interfaces:

IDocumentInfo

public class DocumentInfo
extends Object
implements IDocumentInfo

Defines document description properties.

Constructor Summary

Constructors

Constructor and Description
DocumentInfo() Initializes a new instance of the DocumentInfo class.

Method Summary

Modifier and Type	Method and Description
PageInfo	addPage(int pageWidth, int pageHeight, int pageIndex)
List<BarcodeSignature>	getBarcodeSignatures() Collection of document barcode signatures added or updated by Signature methods.
List<DigitalSignature>	getDigitalSignatures() Collection of document digital signatures added or updated by Signature methods.
FileType	getFileType() File format type.
List<FormFieldSignature>	getFormFields() Collection of all existing supported Form Fields in the document.
List<FormFieldSignature>	getFormFieldSignatures() Collection of document Form Field signatures added or updated by Signature methods.
List<ImageSignature>	getImageSignatures() Collection of document image signatures added or updated by Signature methods.
int	getMaxPageHeight() Specifies max page height.
List<MetadataSignature>	getMetadataSignatures() Collection of document Metadata signatures.
int	getPageCount() Document pages count.
List<PageInfo>	getPages() Collection of document pages descriptions.
List<ProcessLog>	getProcessLogs() Collection of document history processes like Sign, Update, Delete.
List<QrCodeSignature>	getQrCodeSignatures() Collection of document QR-code signatures added or updated by Signature methods.
List<BaseSignature>	getSignatures() Collection of document all types signatures BaseSignature.
long	getSize() Document size in bytes.
List<TextSignature>	getTextSignatures() Collection of document text signatures.
int	getWidthForMaxHeight() Specifies width for max page height.
void	setFileType(FileType value) File format type.
void	setMaxPageHeight(int value) Specifies max page height.
void	setPageCount(int value) Document pages count.
void	setPages(List<PageInfo> value) Collection of document pages descriptions.
void	setSize(long value) Document size in bytes.
void	setWidthForMaxHeight(int value) Specifies width for max page height.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.groupdocs.signature.domain.documentpreview.IDocumentInfo

getDocuments

Constructor Detail

DocumentInfo

public DocumentInfo()

Initializes a new instance of the DocumentInfo class.

Method Detail

addPage

public final PageInfo addPage(int pageWidth,
                              int pageHeight,
                              int pageIndex)

getBarcodeSignatures

public final List<BarcodeSignature> getBarcodeSignatures()

Collection of document barcode signatures added or updated by Signature methods.

Specified by:

getBarcodeSignatures in interface IDocumentInfo

getDigitalSignatures

public final List<DigitalSignature> getDigitalSignatures()

Collection of document digital signatures added or updated by Signature methods.

Specified by:

getDigitalSignatures in interface IDocumentInfo

getFileType

public final FileType getFileType()

File format type.

Specified by:

getFileType in interface IDocumentInfo

getFormFields

public final List<FormFieldSignature> getFormFields()

Collection of all existing supported Form Fields in the document. This property is supported only for Pdf and Word Processing document types.

Specified by:

getFormFields in interface IDocumentInfo

getFormFieldSignatures

public final List<FormFieldSignature> getFormFieldSignatures()

Collection of document Form Field signatures added or updated by Signature methods.

Specified by:

getFormFieldSignatures in interface IDocumentInfo

getImageSignatures

public final List<ImageSignature> getImageSignatures()

Collection of document image signatures added or updated by Signature methods.

Specified by:

getImageSignatures in interface IDocumentInfo

getMaxPageHeight

public final int getMaxPageHeight()

Specifies max page height.

Specified by:

getMaxPageHeight in interface IDocumentInfo

getMetadataSignatures

public final List<MetadataSignature> getMetadataSignatures()

Collection of document Metadata signatures.

Specified by:

getMetadataSignatures in interface IDocumentInfo

getPageCount

public final int getPageCount()

Document pages count.

Specified by:

getPageCount in interface IDocumentInfo

getPages

public final List<PageInfo> getPages()

Collection of document pages descriptions.

Specified by:

getPages in interface IDocumentInfo

getProcessLogs

public final List<ProcessLog> getProcessLogs()

Collection of document history processes like Sign, Update, Delete.

Specified by:

getProcessLogs in interface IDocumentInfo

getQrCodeSignatures

public final List<QrCodeSignature> getQrCodeSignatures()

Collection of document QR-code signatures added or updated by Signature methods.

Specified by:

getQrCodeSignatures in interface IDocumentInfo

getSignatures

public final List<BaseSignature> getSignatures()

Collection of document all types signatures BaseSignature.

Specified by:

getSignatures in interface IDocumentInfo

getSize

public final long getSize()

Document size in bytes.

Specified by:

getSize in interface IDocumentInfo

getTextSignatures

public final List<TextSignature> getTextSignatures()

Collection of document text signatures.

Specified by:

getTextSignatures in interface IDocumentInfo

getWidthForMaxHeight

public final int getWidthForMaxHeight()

Specifies width for max page height.

Specified by:

getWidthForMaxHeight in interface IDocumentInfo

setFileType

public final void setFileType(FileType value)

File format type.

Specified by:

setFileType in interface IDocumentInfo

setMaxPageHeight

public final void setMaxPageHeight(int value)

Specifies max page height.

Specified by:

setMaxPageHeight in interface IDocumentInfo

setPageCount

public final void setPageCount(int value)

Document pages count.

Specified by:

setPageCount in interface IDocumentInfo

setPages

public final void setPages(List<PageInfo> value)

Collection of document pages descriptions.

Specified by:

setPages in interface IDocumentInfo

setSize

public final void setSize(long value)

Document size in bytes.

Specified by:

setSize in interface IDocumentInfo

setWidthForMaxHeight

public final void setWidthForMaxHeight(int value)

Specifies width for max page height.

Specified by:

setWidthForMaxHeight in interface IDocumentInfo