com.jidesoft.grid
Class CsvTableUtils.CsvTableExportConfig

java.lang.Object
  com.jidesoft.grid.CsvTableUtils.CsvTableExportConfig

Enclosing class:

CsvTableUtils

public static class CsvTableUtils.CsvTableExportConfig
extends Object

A class that has all the parameters that could be customized when exporting a table or a TableScrollPane to csv file.

Since:

3.3.8

Constructor Summary

CsvTableUtils.CsvTableExportConfig()
The constructor.

Method Summary

ValueConverter	getCellValueConverter() Gets the cell value converter.
String	getCharsetName() Gets the charset name.
StringConverter	getColumnNameConverter() Gets the column name converter.
int	getFirstColumn() Gets the first column to be exported.
int	getFirstRow() Gets the first row to be exported.
int	getNumOfColumns() Gets the number of columns to be exported.
int	getNumOfRows() Gets the number of rows to be exported.
char	getSeparator() Gets the separator to separate the cells.
boolean	isHeaderIncluded() Gets the flag indicating if the table header should be exported.
void	setCellValueConverter(ValueConverter cellValueConverter) Sets the cell value converter.
void	setCharsetName(String charsetName) Sets the charset name.
void	setColumnNameConverter(StringConverter columnNameConverter) Sets the column name converter.
void	setFirstColumn(int firstColumn) Sets the first column to be exported.
void	setFirstRow(int firstRow) Sets the first row to be exported.
void	setHeaderIncluded(boolean headerIncluded) Sets the flag indicating if the table header should be exported.
void	setNumOfColumns(int numOfColumns) Sets the number of columns to be exported.
void	setNumOfRows(int numOfRows) Sets the number of rows to be exported.
void	setSeparator(char separator) Sets the separator to separate the cells.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvTableUtils.CsvTableExportConfig

public CsvTableUtils.CsvTableExportConfig()

The constructor.

Method Detail

isHeaderIncluded

public boolean isHeaderIncluded()

Gets the flag indicating if the table header should be exported.

Returns:

true if the table header should be exported. Otherwise false.

setHeaderIncluded

public void setHeaderIncluded(boolean headerIncluded)

Sets the flag indicating if the table header should be exported.

Parameters:

headerIncluded - the flag

getCellValueConverter

public ValueConverter getCellValueConverter()

Gets the cell value converter.

Returns:

the cell value converter.

setCellValueConverter

public void setCellValueConverter(ValueConverter cellValueConverter)

Sets the cell value converter.

Parameters:

cellValueConverter - the cell value converter

getColumnNameConverter

public StringConverter getColumnNameConverter()

Gets the column name converter.

Returns:

the column name converter.

setColumnNameConverter

public void setColumnNameConverter(StringConverter columnNameConverter)

Sets the column name converter.

Parameters:

columnNameConverter - the column name converter

getFirstRow

public int getFirstRow()

Gets the first row to be exported.

Returns:

the first row to be exported. -1 to export from the first row.

setFirstRow

public void setFirstRow(int firstRow)

Sets the first row to be exported.

Parameters:

firstRow - the first row

getFirstColumn

public int getFirstColumn()

Gets the first column to be exported.

Returns:

the first column to be exported. -1 to export from the first column.

setFirstColumn

public void setFirstColumn(int firstColumn)

Sets the first column to be exported.

Parameters:

firstColumn - the first column

getNumOfRows

public int getNumOfRows()

Gets the number of rows to be exported.

Returns:

the number of rows to be exported. -1 to export all rows from the first row.

setNumOfRows

public void setNumOfRows(int numOfRows)

Sets the number of rows to be exported.

Parameters:

numOfRows - the number of rows to be exported

getNumOfColumns

public int getNumOfColumns()

Gets the number of columns to be exported.

Returns:

the number of columns to be exported. -1 to export all columns from the first column.

setNumOfColumns

public void setNumOfColumns(int numOfColumns)

Sets the number of columns to be exported.

Parameters:

numOfColumns - the number of columns to be exported

getSeparator

public char getSeparator()

Gets the separator to separate the cells.

Returns:

the separator. By default, it's a comma.

setSeparator

public void setSeparator(char separator)

Sets the separator to separate the cells.

Parameters:

separator - the separator

getCharsetName

public String getCharsetName()

Gets the charset name.

Returns:

the charset name.

setCharsetName

public void setCharsetName(String charsetName)

Sets the charset name.

Parameters:

charsetName - the charset name