com.technia.tvc.structurebrowser.render

Interface SpreadsheetWriter

public interface SpreadsheetWriter

This writer is used for exporting data into a spreadsheet format.

Since:

2010.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SpreadsheetWriter.AdditionalSpreadsheetContent
static interface	SpreadsheetWriter.SpreadsheetBoolField Represents a boolean field within the spreadsheet.
static interface	SpreadsheetWriter.SpreadsheetColumn Represents a column within the spreadsheet.
static interface	SpreadsheetWriter.SpreadsheetDateField Represents a date field within the spreadsheet.
static interface	SpreadsheetWriter.SpreadsheetField Represents a field within the spreadsheet.
static interface	SpreadsheetWriter.SpreadsheetFormulaField Represents a field holding a formula.
static interface	SpreadsheetWriter.SpreadsheetIntField Represents an integer field within the spreadsheet.
static interface	SpreadsheetWriter.SpreadsheetNumericField Represents a numeric field within the spreadsheet.
static interface	SpreadsheetWriter.SpreadsheetTextField Represents a text field within the spreadsheet.
static class	SpreadsheetWriter.Style Via the SpreadsheetWriter.Style class, you can manipulate how the data within a field or column is presented and formatted.

Method Summary

Modifier and Type	Method and Description
SpreadsheetWriter.SpreadsheetColumn	addColumn(java.lang.String label) Adds a column to the spreadsheet without assigning a group header to the column
SpreadsheetWriter.SpreadsheetColumn	addColumn(java.lang.String label, java.lang.String groupHeader) Adds a column to the spreadsheet.
SpreadsheetWriter.SpreadsheetField	addEmptyField() Adds an empty field
SpreadsheetWriter.SpreadsheetBoolField	addField(boolean value) Adds a boolean field
SpreadsheetWriter.SpreadsheetDateField	addField(java.util.Date value) Adds a date field
SpreadsheetWriter.SpreadsheetNumericField	addField(double value) Adds a fraction-value field
void	addField(com.technia.tvc.core.gui.image.ImageURL imageURL) Adds a field that holds an image.
SpreadsheetWriter.SpreadsheetIntField	addField(int value) Adds a boolean field
SpreadsheetWriter.SpreadsheetTextField	addField(java.lang.String content) Adds a string/text field
SpreadsheetWriter.SpreadsheetTextField	addField(java.lang.String content, boolean wrapText) Adds a string/text field
SpreadsheetWriter.SpreadsheetFormulaField	addFormula(java.lang.String formula) Adds a field that holds a spreadsheet formula.
void	beginRow() Before adding fields, this method must be called (per row).
void	endRow() When all fields on a row has been added, this method is being called.
int	getColumnCount()
java.lang.String	getFormat() Returns a string representing the format of the generated spreadsheet.
void	setAboveContent(SpreadsheetWriter.AdditionalSpreadsheetContent aboveContent) Used to provide additional content added above the table data
void	setBelowContent(SpreadsheetWriter.AdditionalSpreadsheetContent belowContent) Used to provide additional content added below the table data.

Method Detail

getFormat

java.lang.String getFormat()

Returns a string representing the format of the generated spreadsheet.

Returns:

An arbitrary string that identifies the format.

Since:

2010.3.0

getColumnCount

int getColumnCount()

Returns:

the number of columns added.

Since:

2010.3.0

addColumn

SpreadsheetWriter.SpreadsheetColumn addColumn(java.lang.String label)

Adds a column to the spreadsheet without assigning a group header to the column

Parameters:

label - The label of the column

Returns:

The created SpreadsheetWriter.SpreadsheetColumn

Since:

2010.3.0

See Also:

addColumn(String, String)

addColumn

SpreadsheetWriter.SpreadsheetColumn addColumn(java.lang.String label,
                                              java.lang.String groupHeader)

Adds a column to the spreadsheet. The column typically has a label, but additionally, the column can belong to a group (group of columns with the same group header).

Consecutive columns with the same group header will be grouped together.

Parameters:

label - The label

groupHeader - The label of the group header (optional)

Returns:

The SpreadsheetWriter.SpreadsheetColumn

Since:

2010.3.0

beginRow

void beginRow()

Before adding fields, this method must be called (per row).

Since:

2010.3.0

addField

SpreadsheetWriter.SpreadsheetBoolField addField(boolean value)

Adds a boolean field

Parameters:

value - The value to add

Returns:

The field that was added.

Since:

2010.3.0

addField

SpreadsheetWriter.SpreadsheetIntField addField(int value)

Adds a boolean field

Parameters:

value - The value to add

Returns:

The field that was added.

Since:

2010.3.0

addField

SpreadsheetWriter.SpreadsheetNumericField addField(double value)

Adds a fraction-value field

Parameters:

value - The value to add

Returns:

The field that was added.

Since:

2010.3.0

addField

SpreadsheetWriter.SpreadsheetDateField addField(java.util.Date value)

Adds a date field

Parameters:

value - The value to add

Returns:

The field that was added.

Since:

2010.3.0

addEmptyField

SpreadsheetWriter.SpreadsheetField addEmptyField()

Adds an empty field

Returns:

The field that was added.

Since:

2010.3.0

addField

SpreadsheetWriter.SpreadsheetTextField addField(java.lang.String content)

Adds a string/text field

Parameters:

content - The content to add

Returns:

The field that was added.

Since:

2010.3.0

addField

SpreadsheetWriter.SpreadsheetTextField addField(java.lang.String content,
                                                boolean wrapText)

Adds a string/text field

Parameters:

content - The content to add

wrapText - If wrapping is allowed (note that this also can be specified via the Style per field also)

Returns:

The field that was added.

Since:

2010.3.0

addFormula

SpreadsheetWriter.SpreadsheetFormulaField addFormula(java.lang.String formula)

Adds a field that holds a spreadsheet formula.

Parameters:

formula - The formula.

Returns:

The SpreadsheetWriter.SpreadsheetFormulaField that were created

Since:

2010.3.0

addField

void addField(com.technia.tvc.core.gui.image.ImageURL imageURL)

Adds a field that holds an image.

Note: The image support far from perfect! There are some problems in Excel regarding support of different image formats + problems with image sizes vs cell sizes.

Parameters:

imageURL - The image URL.

Since:

2012.2.0

endRow

void endRow()

When all fields on a row has been added, this method is being called.

Since:

2010.3.0

setAboveContent

void setAboveContent(SpreadsheetWriter.AdditionalSpreadsheetContent aboveContent)

Used to provide additional content added above the table data

Parameters:

aboveContent - An SpreadsheetWriter.AdditionalSpreadsheetContent

Since:

2010.3.0

setBelowContent

void setBelowContent(SpreadsheetWriter.AdditionalSpreadsheetContent belowContent)

Used to provide additional content added below the table data.

Parameters:

belowContent - An SpreadsheetWriter.AdditionalSpreadsheetContent

Since:

2010.3.0