com.github.jferard.fastods

Interface OdsDocument

All Superinterfaces:

StylesModeSetter

All Known Implementing Classes:

AnonymousOdsDocument, NamedOdsDocument

public interface OdsDocument
extends StylesModeSetter

An ods document. It is part of a writer that is responsible for the recording.

Author:

Julien Férard, Martin Schulz

Method Summary

Modifier and Type	Method and Description
void	addAutoFilter(AutoFilter autoFilter) Add a new auto filter
void	addAutoFilter(String rangeName, Table table, int r1, int c1, int r2, int c2) Deprecated. use table.addAutoFilter(r1, c1, r2, c2)
void	addEvents(ScriptEventListener... events) Add some events to the document
void	addExtraDir(String fullPath) Add an extra directory to the manifest.
void	addExtraFile(String fullPath, String mediaType, byte[] bytes) Add an extra file to the document
void	addExtraObject(String fullPath, String mediaType, String version) Add an extra object (eg. a spreadsheet) to the manifest.
void	addPilotTable(PilotTable pilot) Add a new pilot table
Table	addTable(String name) Add a new table to the document, the new table is set to the active table.
Table	addTable(String name, int rowCapacity, int columnCapacity) Add a new table to the document, the new table is set to the active table.
boolean	addTable(Table table) Add a new table to the document, the new table is set to the active table.
Table	createTable(String name) *You probably need addTable* Create a new table, **but do not add it to the document**.
Table	createTable(String name, int rowCapacity, int columnCapacity) *You probably need addTable* Create a new table, **but do not add it to the document**.
void	freezeCells(Table table, int rowCount, int colCount)
Table	getOrAddTable(String name)
Table	getTable(int n) Get a table by index
Table	getTable(String name) Get a table by name
String	getTableName(int n) Returns the name of the table.
int	getTableNumber(String name) Search a table by name and return its number.
List<Table>	getTables()
boolean	setActiveTable(int tableIndex) Set the active table, this is the table that is shown if you open the file.
void	setViewSetting(String viewId, String item, String value) Set a view setting
int	tableCount() Gets the number of the last table.

Methods inherited from interface com.github.jferard.fastods.odselement.StylesModeSetter

setDataStylesMode, setMasterPageStyleMode, setObjectStyleMode, setPageLayoutStyleMode, setPageStyleMode

Method Detail

addTable

Table addTable(String name)
        throws IOException

Add a new table to the document, the new table is set to the active table.
Use setActiveTable to override the current active table, this has no influence to the program, the active table is the first table that is shown in OpenOffice.

Parameters:

name - - The name of the table to add

Returns:

the table

Throws:

IOException - if the table can't be added to document

addTable

Table addTable(String name,
               int rowCapacity,
               int columnCapacity)
        throws IOException

Add a new table to the document, the new table is set to the active table.
Use setActiveTable to override the current active table, this has no influence to the program, the active table is the first table that is shown in OpenOffice.

Parameters:

name - the name of the table to add

rowCapacity - the initial row capacity

columnCapacity - the initial column capacity

Returns:

the table or nll if the name already exists

Throws:

IOException - if the table can't be added to document

addTable

boolean addTable(Table table)
          throws IOException

Add a new table to the document, the new table is set to the active table.
Use setActiveTable to override the current active table, this has no influence to the program, the active table is the first table that is shown in OpenOffice.

Parameters:

table - the table to add

Returns:

true if the table was added

Throws:

IOException - if the table can't be added to document

createTable

Table createTable(String name)
           throws IOException

*You probably need addTable*

Create a new table, **but do not add it to the document**.

Parameters:

name - - The name of the table to add

Returns:

the table

Throws:

IOException - if the table can't be added to document

createTable

Table createTable(String name,
                  int rowCapacity,
                  int columnCapacity)
           throws IOException

*You probably need addTable*

Create a new table, **but do not add it to the document**.

Parameters:

name - - The name of the table to add

rowCapacity - the initial row capacity

columnCapacity - the initial column capacity

Returns:

the table

Throws:

IOException - if the table can't be added to document

getTable

Table getTable(int n)
        throws FastOdsException

Get a table by index

Parameters:

n - the index

Returns:

the table

Throws:

FastOdsException - if the table index is negative or ≥ number of tables

getTable

Table getTable(String name)
        throws FastOdsException

Get a table by name

Parameters:

name - the name of the table

Returns:

the table

Throws:

FastOdsException - if the table does not exist.

getOrAddTable

Table getOrAddTable(String name)
             throws IOException

Parameters:

name - the name of the table

Returns:

the table

Throws:

IOException - if the table does not exist.

getTableName

String getTableName(int n)
             throws FastOdsException

Returns the name of the table.

Parameters:

n - The number of the table

Returns:

The name of the table

Throws:

FastOdsException - if n is negative

getTableNumber

int getTableNumber(String name)

Search a table by name and return its number.

Parameters:

name - The name of the table

Returns:

The number of the table or -1 if name was not found

getTables

List<Table> getTables()

Returns:

the list of tables

setActiveTable

boolean setActiveTable(int tableIndex)

Set the active table, this is the table that is shown if you open the file.

Parameters:

tableIndex - The table number, this table should already exist, otherwise the first table is shown

Returns:

true - The active table was set, false - tab has an illegal value

setViewSetting

void setViewSetting(String viewId,
                    String item,
                    String value)

Set a view setting

Parameters:

viewId - the view id

item - the item name

value - the value

tableCount

int tableCount()

Gets the number of the last table.

Returns:

The number of the last table

addAutoFilter

@Deprecated
void addAutoFilter(String rangeName,
                               Table table,
                               int r1,
                               int c1,
                               int r2,
                               int c2)

Deprecated. use table.addAutoFilter(r1, c1, r2, c2)

Add an autoFilter to a range address

Parameters:

rangeName - the name of the range

table - the table

r1 - the top row

c1 - the left column

r2 - the bottom row

c2 - the right column

freezeCells

void freezeCells(Table table,
                 int rowCount,
                 int colCount)

Parameters:

table - the table

rowCount - the number of rows to freeze

colCount - the number of cols to freeze

addExtraFile

void addExtraFile(String fullPath,
                  String mediaType,
                  byte[] bytes)

Add an extra file to the document

Parameters:

fullPath - the path of the file in the sequence

mediaType - the MIME type of the file

bytes - the content

addExtraDir

void addExtraDir(String fullPath)

Add an extra directory to the manifest.

Parameters:

fullPath - the path of the dir

addExtraObject

void addExtraObject(String fullPath,
                    String mediaType,
                    String version)

Add an extra object (eg. a spreadsheet) to the manifest. Files have to be added with `AddExtraFile`.

Parameters:

fullPath - the path of the dir

mediaType - the type of the object

version - the version

addEvents

void addEvents(ScriptEventListener... events)

Add some events to the document

Parameters:

events - the events to add

addPilotTable

void addPilotTable(PilotTable pilot)

Add a new pilot table

Parameters:

pilot - the pilot table

addAutoFilter

void addAutoFilter(AutoFilter autoFilter)

Add a new auto filter

Parameters:

autoFilter - the filter