WordProcessingDocumentInfo

Inheritance: java.lang.Object

public class WordProcessingDocumentInfo implements IDocumentInfo

Represents metadata of one WordProcessing document

Methods

Method	Description
getFormat()	Returns a format of this WordProcessing document
getPageCount()	Returns number of pages
getSize()	Returns size in bytes of this WordProcessing document
isEncrypted()	Determines whether this specific WordProcessing document in encrypted and requires password for opening
generatePreview(int pageIndex)	Generates and returns a preview of the selected page in a form of SVG image
equals(WordProcessingDocumentInfo other)	Determines whether this instance is equal to the other specified WordProcessingDocumentInfo instance

public final WordProcessingFormats getFormat()

Returns a format of this WordProcessing document

Returns: WordProcessingFormats

public final int getPageCount()

Returns number of pages

Returns: int

public final long getSize()

Returns size in bytes of this WordProcessing document

Returns: long

public final boolean isEncrypted()

Determines whether this specific WordProcessing document in encrypted and requires password for opening

Returns: boolean

public final SvgImage generatePreview(int pageIndex)

Generates and returns a preview of the selected page in a form of SVG image

Parameters:

Parameter	Type	Description
pageIndex	int	0-based index of the desired page. Cannot be lesser then 0, cannot exceed the number of pages in this WordProcessing document.

Returns: SvgImage - SVG image as the non-null instance of the SvgImage class

public final boolean equals(WordProcessingDocumentInfo other)

Determines whether this instance is equal to the other specified WordProcessingDocumentInfo instance

Parameters:

Parameter	Type	Description
other	WordProcessingDocumentInfo	Other WordProcessingDocumentInfo instance, that should be checked on equality with this

Returns: boolean - True if are equal, false if are unequal