LibreOffice Module xmerge (master) 1
Public Member Functions | List of all members
org.openoffice.xmerge.converter.xml.sxc.SpreadsheetEncoder Class Referenceabstract

This class is an abstract class for encoding an SXC into an alternative spreadsheet format. More...

Public Member Functions

abstract void createWorksheet (String sheetName) throws IOException
 Create a new WorkSheet within the WorkBook. More...
 
abstract void addCell (int row, int column, Format fmt, String cellContents) throws IOException
 Add a cell to the current WorkSheet. More...
 
abstract int getNumberOfSheets ()
 Get the number of sheets in the WorkBook. More...
 
abstract void setColumnRows (ArrayList< ColumnRowInfo > columnRows) throws IOException
 Set the width of the columns in the WorkBook. More...
 
abstract void setNameDefinition (NameDefinition nd) throws IOException
 Set the name definition of this spreadsheet. More...
 
abstract void addSettings (BookSettings s) throws IOException
 Adds settings to the WorkBook. More...
 

Detailed Description

This class is an abstract class for encoding an SXC into an alternative spreadsheet format.

ToDo - Add appropriate exceptions to each of the methods.

Definition at line 31 of file SpreadsheetEncoder.java.

Member Function Documentation

◆ addCell()

abstract void org.openoffice.xmerge.converter.xml.sxc.SpreadsheetEncoder.addCell ( int  row,
int  column,
Format  fmt,
String  cellContents 
) throws IOException
abstract

Add a cell to the current WorkSheet.

Parameters
rowThe row number of the cell
columnThe column number of the cell
fmtThe Format object describing the appearance of this cell.
cellContentsThe text or formula of the cell's contents.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.addCell().

◆ addSettings()

abstract void org.openoffice.xmerge.converter.xml.sxc.SpreadsheetEncoder.addSettings ( BookSettings  s) throws IOException
abstract

Adds settings to the WorkBook.

Parameters
sThe BookSettings to add.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseSettings().

◆ createWorksheet()

abstract void org.openoffice.xmerge.converter.xml.sxc.SpreadsheetEncoder.createWorksheet ( String  sheetName) throws IOException
abstract

Create a new WorkSheet within the WorkBook.

Parameters
sheetNameThe name of the WorkSheet.
Exceptions
IOExceptionIf any I/O error occurs.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseTable().

◆ getNumberOfSheets()

abstract int org.openoffice.xmerge.converter.xml.sxc.SpreadsheetEncoder.getNumberOfSheets ( )
abstract

Get the number of sheets in the WorkBook.

Returns
The number of sheets in the WorkBook.

◆ setColumnRows()

abstract void org.openoffice.xmerge.converter.xml.sxc.SpreadsheetEncoder.setColumnRows ( ArrayList< ColumnRowInfo columnRows) throws IOException
abstract

Set the width of the columns in the WorkBook.

Parameters
columnRowsAn IntArrayList of column widths.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseTable().

◆ setNameDefinition()

abstract void org.openoffice.xmerge.converter.xml.sxc.SpreadsheetEncoder.setNameDefinition ( NameDefinition  nd) throws IOException
abstract

Set the name definition of this spreadsheet.

Parameters
ndThe NameDefinition to use.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializer.traverseNamedExpressions().


The documentation for this class was generated from the following file: