com.vaadin.client.ui.grid
Interface ColumnConfiguration

public interface ColumnConfiguration

A representation of the columns in an instance of Escalator.

Since:

Author:

Vaadin Ltd

See Also:

Escalator.getColumnConfiguration()

Method Summary

int	getColumnCount() Returns the number of columns in the escalator.
int	getColumnWidth(int index) Returns the user-defined width of a column.
int	getColumnWidthActual(int index) Returns the actual width of a column.
int	getFrozenColumnCount() Get the number of leftmost columns that are not affected by horizontal scrolling.
void	insertColumns(int index, int numberOfColumns) Adds columns at a certain index.
void	removeColumns(int index, int numberOfColumns) Removes columns at certain indices.
void	setColumnWidth(int index, int px) Sets (or unsets) an explicit width for a column.
void	setFrozenColumnCount(int count) Sets the number of leftmost columns that are not affected by horizontal scrolling.

Method Detail

removeColumns

void removeColumns(int index,
                   int numberOfColumns)
                   throws java.lang.IndexOutOfBoundsException,
                          java.lang.IllegalArgumentException

Removes columns at certain indices.

If any of the removed columns were frozen, the number of frozen columns will be reduced by the number of the removed columns that were frozen.

Parameters:

index - the index of the first column to be removed

numberOfColumns - the number of rows to remove, starting from index

Throws:

java.lang.IndexOutOfBoundsException - if the entire range of removed columns is not currently present in the escalator

java.lang.IllegalArgumentException - if numberOfColumns is less than 1.

insertColumns

void insertColumns(int index,
                   int numberOfColumns)
                   throws java.lang.IndexOutOfBoundsException,
                          java.lang.IllegalArgumentException

Adds columns at a certain index.

The new columns will be inserted between the column at the index, and the column before (an index of 0 means that the columns are inserted at the beginning). Therefore, the columns at the index and afterwards will be moved to the right.

The contents of the inserted columns will be queried from the respective cell renderers in the header, body and footer.

If there are frozen columns and the first added column is to the left of the last frozen column, the number of frozen columns will be increased by the number of inserted columns.

Note: Only the contents of the inserted columns will be rendered. If inserting new columns affects the contents of existing columns, RowContainer.refreshRows(int, int) needs to be called as appropriate.

Parameters:

index - the index of the column before which new columns are inserted, or getColumnCount() to add new columns at the end

numberOfColumns - the number of columns to insert after the index

Throws:

java.lang.IndexOutOfBoundsException - if index is not an integer in the range [0..getColumnCount()]

java.lang.IllegalArgumentException - if numberOfColumns is less than 1.

getColumnCount

int getColumnCount()

Returns the number of columns in the escalator.

Returns:

the number of columns in the escalator

setFrozenColumnCount

void setFrozenColumnCount(int count)
                          throws java.lang.IllegalArgumentException

Sets the number of leftmost columns that are not affected by horizontal scrolling.

Parameters:

count - the number of columns to freeze

Throws:

java.lang.IllegalArgumentException - if the column count is < 0 or > the number of columns

getFrozenColumnCount

int getFrozenColumnCount()

Get the number of leftmost columns that are not affected by horizontal scrolling.

Returns:

the number of frozen columns

setColumnWidth

void setColumnWidth(int index,
                    int px)
                    throws java.lang.IllegalArgumentException

Sets (or unsets) an explicit width for a column.

Parameters:

index - the index of the column for which to set a width

px - the number of pixels the indicated column should be, or a negative number to let the escalator decide

Throws:

java.lang.IllegalArgumentException - if index is not a valid column index

getColumnWidth

int getColumnWidth(int index)
                   throws java.lang.IllegalArgumentException

Returns the user-defined width of a column.

Parameters:

index - the index of the column for which to retrieve the width

Returns:

the column's width in pixels, or a negative number if the width is implicitly decided by the escalator

Throws:

java.lang.IllegalArgumentException - if index is not a valid column index

getColumnWidthActual

int getColumnWidthActual(int index)
                         throws java.lang.IllegalArgumentException

Returns the actual width of a column.

Parameters:

index - the index of the column for which to retrieve the width

Returns:

the column's actual width in pixels

Throws:

java.lang.IllegalArgumentException - if index is not a valid column index