com.github.jferard.fastods.odselement

Class ContentElement

java.lang.Object

com.github.jferard.fastods.odselement.ContentElement

All Implemented Interfaces:

OdsElement

public class ContentElement
extends Object
implements OdsElement

3.1.3.2 office:document-content

Author:

Julien Férard, Martin Schulz

Method Summary

Modifier and Type	Method and Description
void	addAutoFilter(AutoFilter autoFilter) Add an autoFilter to a table
TableCellStyle	addChildCellStyle(TableCellStyle style, CellType type) Create an automatic style for this TableCellStyle and this type of cell.
void	addEvents(ScriptEventListener... events) Add some events to the document
void	addPilotTable(PilotTable pilotTable) Add a new pilot table
Table	addTable(String name, int rowCapacity, int columnCapacity) Deprecated. use `addTable(table)`
boolean	addTable(Table table)
Table	createTable(String name, int rowCapacity, int columnCapacity) Create a new table
Table	getLastTable()
StylesContainer	getStyleTagsContainer()
Table	getTable(int tableIndex)
Table	getTable(String name)
int	getTableCount()
List<Table>	getTables()
void	write(XMLUtil util, ZipUTF8Writer writer)
void	writeEvents(XMLUtil util, ZipUTF8Writer writer)
void	writePostamble(XMLUtil util, ZipUTF8Writer writer) Write the postamble into the given writer.
void	writePreamble(XMLUtil util, ZipUTF8Writer writer) Write the preamble into the given writer.

Methods inherited from class java.lang.Object

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

Method Detail

addChildCellStyle

public TableCellStyle addChildCellStyle(TableCellStyle style,
                                        CellType type)

Create an automatic style for this TableCellStyle and this type of cell. Do not produce any effect if the type is Type.STRING or Type.VOID.

Parameters:

style - the style of the cell (color, data style, etc.)

type - the type of the cell

Returns:

the created style, or style if the type is Type.STRING or Type.VOID

addTable

@Deprecated
public Table addTable(String name,
                                  int rowCapacity,
                                  int columnCapacity)

Deprecated. use `addTable(table)`

Parameters:

name - the name of the table to create

columnCapacity - the initial capacity in columns: this will be allocated at table creation

rowCapacity - the initial capacity in rows: this will be allocated at table creation

Returns:

the table (whether it existed before call or not). Never null

addTable

public boolean addTable(Table table)

Parameters:

table - the table

Returns:

true if the table was added

createTable

public Table createTable(String name,
                         int rowCapacity,
                         int columnCapacity)

Create a new table

Parameters:

name - the name of the new table

rowCapacity - the row capacity

columnCapacity - the column capacity

Returns:

the newly created table

getLastTable

public Table getLastTable()

Returns:

the last table in the document or null

getStyleTagsContainer

public StylesContainer getStyleTagsContainer()

Returns:

the styles container

getTable

public Table getTable(int tableIndex)

Parameters:

tableIndex - an index of the table

Returns:

the table at that index

getTable

public Table getTable(String name)

Parameters:

name - the name of the table to find

Returns:

the table, or null if none present

getTableCount

public int getTableCount()

Returns:

the number of tables in the document

getTables

public List<Table> getTables()

Returns:

the list of tables

write

public void write(XMLUtil util,
                  ZipUTF8Writer writer)
           throws IOException

Specified by:

write in interface OdsElement

Parameters:

util - an util tool to write XML data

writer - the writer to which write the element

Throws:

IOException - if the element can't be written

writePreamble

public void writePreamble(XMLUtil util,
                          ZipUTF8Writer writer)
                   throws IOException

Write the preamble into the given writer. Used by the MetaAndStylesElementsFlusher and by standard write method

Parameters:

util - an XML util

writer - the destination

Throws:

IOException - if the preamble was not written

writePostamble

public void writePostamble(XMLUtil util,
                           ZipUTF8Writer writer)
                    throws IOException

Write the postamble into the given writer. Used by the FinalizeFlusher and by standard write method

Parameters:

util - an XML util

writer - the destination

Throws:

IOException - if the postamble could not be written

writeEvents

public void writeEvents(XMLUtil util,
                        ZipUTF8Writer writer)
                 throws IOException

Throws:

IOException

addAutoFilter

public void addAutoFilter(AutoFilter autoFilter)

Add an autoFilter to a table

Parameters:

autoFilter - the auto filter

addEvents

public void addEvents(ScriptEventListener... events)

Add some events to the document

Parameters:

events - the events to add

addPilotTable

public void addPilotTable(PilotTable pilotTable)

Add a new pilot table

Parameters:

pilotTable - the filter