com.haulmont.cuba.gui.components.columnmanager

Interface ColumnManager

public interface ColumnManager

Class provides methods for Table.Column manipulation.

See Also:

Table, GroupTable, TreeTable

Method Summary

Modifier and Type	Method and Description
void	addAggregationProperty(java.lang.String columnId, AggregationInfo.Type type) Adds aggregation type to the column.
void	addAggregationProperty(Table.Column columnId, AggregationInfo.Type type) Adds aggregation type to the column.
void	removeAggregationProperty(java.lang.String columnId) Removes the column from aggregation cells list.
void	setColumnAlignment(java.lang.String columnId, Table.ColumnAlignment alignment) Sets text alignment for a column in runtime.
void	setColumnAlignment(Table.Column column, Table.ColumnAlignment alignment) Sets text alignment for a column in runtime.
void	setColumnCaption(java.lang.String columnId, java.lang.String caption) Assign caption for column in runtime.
void	setColumnCaption(Table.Column column, java.lang.String caption) Assign caption for column in runtime.
void	setColumnCaptionAsHtml(java.lang.String columnId, boolean captionAsHtml) Sets whether caption of column with the given columnId should be interpreted as HTML or not.
void	setColumnCaptionAsHtml(Table.Column column, boolean captionAsHtml) Sets whether caption of the given column should be interpreted as HTML or not.
void	setColumnCollapsed(java.lang.String columnId, boolean collapsed) Show/hide column in runtime.
void	setColumnCollapsed(Table.Column column, boolean collapsed) Show/hide column in runtime.
void	setColumnDescription(java.lang.String columnId, java.lang.String description) Assign description for column in runtime.
void	setColumnDescription(Table.Column column, java.lang.String description) Assign description for column in runtime.
void	setColumnSortable(java.lang.String columnId, boolean sortable) Enables sortable for the column.
void	setColumnSortable(Table.Column column, boolean sortable) Enables sortable for the column.
void	setColumnWidth(java.lang.String columnId, int width) Set column width in runtime.
void	setColumnWidth(Table.Column column, int width) Set column width in runtime.

Method Detail

setColumnCaption

void setColumnCaption(java.lang.String columnId,
                      java.lang.String caption)

Assign caption for column in runtime.

Parameters:

columnId - column id

caption - column caption

setColumnCaption

void setColumnCaption(Table.Column column,
                      java.lang.String caption)

Assign caption for column in runtime.

Parameters:

column - column instance

caption - column caption

setColumnDescription

void setColumnDescription(java.lang.String columnId,
                          java.lang.String description)

Assign description for column in runtime.

Parameters:

columnId - column id

description - column description

setColumnDescription

void setColumnDescription(Table.Column column,
                          java.lang.String description)

Assign description for column in runtime.

Parameters:

column - column instance

description - column description

setColumnAlignment

void setColumnAlignment(java.lang.String columnId,
                        Table.ColumnAlignment alignment)

Sets text alignment for a column in runtime.

Parameters:

columnId - column id

alignment - text alignment

setColumnAlignment

void setColumnAlignment(Table.Column column,
                        Table.ColumnAlignment alignment)

Sets text alignment for a column in runtime.

Parameters:

column - column instance

alignment - text alignment

setColumnCollapsed

void setColumnCollapsed(java.lang.String columnId,
                        boolean collapsed)

Show/hide column in runtime. Hidden column will be available in column control.

Parameters:

columnId - column id

collapsed - collapsed option

setColumnCollapsed

void setColumnCollapsed(Table.Column column,
                        boolean collapsed)

Show/hide column in runtime. Hidden column will be available in column control.

Parameters:

column - column instance

collapsed - collapsed option

setColumnWidth

void setColumnWidth(java.lang.String columnId,
                    int width)

Set column width in runtime.

Parameters:

columnId - column id

width - column width

setColumnWidth

void setColumnWidth(Table.Column column,
                    int width)

Set column width in runtime.

Parameters:

column - column instance

width - column width

addAggregationProperty

void addAggregationProperty(java.lang.String columnId,
                            AggregationInfo.Type type)

Adds aggregation type to the column.

Parameters:

columnId - column id

type - aggregation type

addAggregationProperty

void addAggregationProperty(Table.Column columnId,
                            AggregationInfo.Type type)

Adds aggregation type to the column.

Parameters:

columnId - column id

type - aggregation type

removeAggregationProperty

void removeAggregationProperty(java.lang.String columnId)

Removes the column from aggregation cells list.

Parameters:

columnId - column id

setColumnSortable

void setColumnSortable(Table.Column column,
                       boolean sortable)

Enables sortable for the column.

Parameters:

column - column instance

sortable - sortable option

setColumnSortable

void setColumnSortable(java.lang.String columnId,
                       boolean sortable)

Enables sortable for the column.

Parameters:

columnId - column id

sortable - sortable option

setColumnCaptionAsHtml

void setColumnCaptionAsHtml(java.lang.String columnId,
                            boolean captionAsHtml)

Sets whether caption of column with the given columnId should be interpreted as HTML or not.

Parameters:

columnId - column id

captionAsHtml - interpret caption as HTML or not

setColumnCaptionAsHtml

void setColumnCaptionAsHtml(Table.Column column,
                            boolean captionAsHtml)

Sets whether caption of the given column should be interpreted as HTML or not.

Parameters:

column - column

captionAsHtml - interpret caption as HTML or not