no.g9.client.spreadsheet

Class TableColumnData

java.lang.Object

no.g9.client.spreadsheet.TableColumnData

public class TableColumnData
extends Object

Holds information about a column in a table.

The information contained within an instance of this class is used when exporting a table to spreadsheet.

Constructor Summary

Constructors

Constructor and Description
TableColumnData(DialogObjectConstant diaConst, short cellAlignment, String cellFormat, String bcMethod, int sortIndex, ListRowComparator.Sorting sorting) Assigns the provided data to the class' global variables.

Method Summary

Modifier and Type	Method and Description
String	getBcMethod() Gets the name of the placement method used to place the Basic Container within this column.
short	getCellAlignment() Gets a short representing the cell style, used for all cells in the current column.
String	getCellFormat() Gets a String representation of the cell format, used for all cells in the current column.
DialogObjectConstant	getDiaConst() Gets the column's DialogObjectConstant.
int	getSortIndex() Gets the index used to keep track of the order columns should be looked at, when comparing different rows.
ListRowComparator.Sorting	getSorting() Gets an enum representing the sort direction, i.e.
void	setSortIndex(int sortIndex) Sets the index used to keep track of the order columns should be looked at, when comparing different rows.
void	setSorting(ListRowComparator.Sorting sorting) Sets the sort direction, represented as an enum.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableColumnData

public TableColumnData(DialogObjectConstant diaConst,
                       short cellAlignment,
                       String cellFormat,
                       String bcMethod,
                       int sortIndex,
                       ListRowComparator.Sorting sorting)

Assigns the provided data to the class' global variables.

Parameters:

diaConst - The column's DialogObjectConstant

cellAlignment - A short representing the cell style. The value should be set according to the values in CellStyle

cellFormat - A String representation of the cell format

bcMethod - The name of a placement method, if the current column contains a Basic Container

sortIndex - An index used to keep track of the order columns should be looked at, when comparing different rows

sorting - An enum representing the sort direction

Method Detail

getDiaConst

public DialogObjectConstant getDiaConst()

Gets the column's DialogObjectConstant.

Returns:

the column's DialogObjectConstant

getCellAlignment

public short getCellAlignment()

Gets a short representing the cell style, used for all cells in the current column.

The value should be set according to the values in CellStyle

Returns:

a short representing the cell style

getCellFormat

public String getCellFormat()

Gets a String representation of the cell format, used for all cells in the current column.

Returns:

a String representation of the cell format

getBcMethod

public String getBcMethod()

Gets the name of the placement method used to place the Basic Container within this column.

If this column does not contain a Basic Container, the returned value is an empty String.

Returns:

name of the placement method used to place the Basic Container within this column, if the column's content is a Basic Container

getSorting

public ListRowComparator.Sorting getSorting()

Gets an enum representing the sort direction, i.e. information about whether this column should be sorted in an ascending or descending order, or not sorted at all.

The value is used when sorting tables.

Returns:

an enum representing the sort direction

setSorting

public void setSorting(ListRowComparator.Sorting sorting)

Sets the sort direction, represented as an enum.

The value is used when sorting tables.

Parameters:

sorting - the sort direction represented as an enum

getSortIndex

public int getSortIndex()

Gets the index used to keep track of the order columns should be looked at, when comparing different rows.

The value is used when sorting tables.

Returns:

the index telling when this column should be checked when comparing two rows

setSortIndex

public void setSortIndex(int sortIndex)

Sets the index used to keep track of the order columns should be looked at, when comparing different rows.

The value is used when sorting tables.

Parameters:

sortIndex - the index telling when this column should be checked when comparing two rows