SpreadsheetDocumentInfo

Inheritance: java.lang.Object

public class SpreadsheetDocumentInfo implements IDocumentInfo

Represents metadata of one Spreadsheet document

Constructors

Constructor	Description
SpreadsheetDocumentInfo()

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

public SpreadsheetDocumentInfo()

public final SpreadsheetFormats getFormat()

Returns a format of this Spreadsheet document

Returns: SpreadsheetFormats

public final int getPageCount()

Returns number of tabs

Returns: int

public final long getSize()

Returns size in bytes of this Spreadsheet document

Returns: long

public final boolean isEncrypted()

Indicates whether this specific Spreadsheet document in encrypted and requires password for opening

Returns: boolean

public final SvgImage generatePreview(int worksheetIndex)

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

Parameters:

Parameter	Type	Description
worksheetIndex	int	0-based index of the desired worksheet. Cannot be lesser then 0, cannot exceed the number of worksheets in this spreadsheet.

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

public final boolean equals(SpreadsheetDocumentInfo other)

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

Parameters:

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

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