com.haulmont.cuba.gui.components

Interface DataGrid.Column

All Superinterfaces:

Component.HasFormatter, Component.HasXmlDescriptor, java.io.Serializable

Enclosing interface:

DataGrid<E extends Entity>

public static interface DataGrid.Column
extends Component.HasXmlDescriptor, Component.HasFormatter, java.io.Serializable

A column in the DataGrid.

Method Summary

Modifier and Type	Method and Description
void	clearExpandRatio() Clears the expand ratio for this column.
java.lang.String	getCaption()
java.lang.String	getCollapsingToggleCaption()
DataGrid.Converter<?,?>	getConverter() Returns the converter instance used by this column.
DataGrid.ColumnEditorFieldGenerator	getEditorFieldGenerator()
int	getExpandRatio()
java.lang.String	getId()
double	getMaximumWidth()
double	getMinimumWidth()
DataGrid	getOwner()
MetaPropertyPath	getPropertyPath()
DataGrid.Renderer	getRenderer() Returns the renderer instance used by this column.
java.lang.Class	getType()
double	getWidth()
boolean	isCollapsed()
boolean	isCollapsible() Returns whether this column can be hidden by the user.
boolean	isEditable() Returns whether the properties corresponding to this column should be editable when the item editor is active.
boolean	isResizable() Returns whether this column can be resized by the user.
boolean	isSortable() Returns whether the user can sort the grid by this column.
boolean	isVisible()
boolean	isWidthAuto()
void	setCaption(java.lang.String caption) Sets the caption of the header.
void	setCollapsed(boolean collapsed) Hides or shows the column.
void	setCollapsible(boolean collapsible) Sets whether this column can be hidden by the user.
void	setCollapsingToggleCaption(java.lang.String collapsingToggleCaption) Sets the caption of the hiding toggle for this column.
void	setConverter(DataGrid.Converter<?,?> converter) Sets the converter used to convert from the property value type to the renderer presentation type.
void	setEditable(boolean editable) Sets whether the properties corresponding to this column should be editable when the item editor is active.
void	setEditorFieldGenerator(DataGrid.ColumnEditorFieldGenerator fieldFactory)
void	setExpandRatio(int expandRatio) Sets the ratio with which the column expands.
void	setLastFrozenColumn() Sets this column as the last frozen column in its grid.
void	setMaximumWidth(double pixels) Sets the maximum width for this column.
void	setMinimumWidth(double pixels) Sets the minimum width for this column.
void	setOwner(DataGrid owner)
void	setRenderer(DataGrid.Renderer renderer) Sets the renderer for this column.
void	setResizable(boolean resizable) Sets whether this column can be resized by the user.
void	setSortable(boolean sortable) Sets whether this column is sortable by the user.
void	setVisible(boolean visible) Hides or shows the column according to security permissions.
void	setWidth(double width) Sets the width (in pixels).
void	setWidthAuto() Marks the column width as auto.

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasXmlDescriptor

getXmlDescriptor, setXmlDescriptor

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasFormatter

getFormatter, setFormatter

Method Detail

getId

java.lang.String getId()

Returns:

id of a column

getPropertyPath

@Nullable
MetaPropertyPath getPropertyPath()

Returns:

the instance of MetaPropertyPath representing a relative path to a property from certain MetaClass

getCaption

java.lang.String getCaption()

Returns:

the caption of the header

setCaption

void setCaption(java.lang.String caption)

Sets the caption of the header. This caption is also used as the hiding toggle caption, unless it is explicitly set via setCollapsingToggleCaption(String).

Parameters:

caption - the text to show in the caption

getCollapsingToggleCaption

java.lang.String getCollapsingToggleCaption()

Returns:

the caption for the hiding toggle for this column

setCollapsingToggleCaption

void setCollapsingToggleCaption(java.lang.String collapsingToggleCaption)

Sets the caption of the hiding toggle for this column. Shown in the toggle for this column in the DataGrid's sidebar when the column is hidable.

The default value is null, and in that case the column's header caption is used.

NOTE: setting this to empty string might cause the hiding toggle to not render correctly.

Parameters:

collapsingToggleCaption - the text to show in the column hiding toggle

getWidth

double getWidth()

Returns:

the width in pixels of the column

setWidth

void setWidth(double width)

Sets the width (in pixels).

This overrides any configuration set by any of setExpandRatio(int), setMinimumWidth(double) or setMaximumWidth(double).

Parameters:

width - the new pixel width of the column

isWidthAuto

boolean isWidthAuto()

Returns:

whether the width is auto

setWidthAuto

void setWidthAuto()

Marks the column width as auto. An auto width means the DataGrid is free to resize the column based on the cell contents and available space in the grid.

getExpandRatio

int getExpandRatio()

Returns:

the column's expand ratio

See Also:

setExpandRatio(int)

setExpandRatio

void setExpandRatio(int expandRatio)

Sets the ratio with which the column expands.

By default, all columns expand equally (treated as if all of them had an expand ratio of 1). Once at least one column gets a defined expand ratio, the implicit expand ratio is removed, and only the defined expand ratios are taken into account.

If a column has a defined width (setWidth(double)), it overrides this method's effects.

Example: A DataGrid with three columns, with expand ratios 0, 1 and 2, respectively. The column with a ratio of 0 is exactly as wide as its contents requires. The column with a ratio of 1 is as wide as it needs, plus a third of any excess space, because we have 3 parts total, and this column reserves only one of those. The column with a ratio of 2, is as wide as it needs to be, plus two thirds of the excess width.

Parameters:

expandRatio - the expand ratio of this column. 0 to not have it expand at all. A negative number to clear the expand value.

See Also:

setWidth(double)

clearExpandRatio

void clearExpandRatio()

Clears the expand ratio for this column.

Equal to calling setExpandRatio(-1)

getMinimumWidth

double getMinimumWidth()

Returns:

the minimum width for this column

See Also:

setMinimumWidth(double)

setMinimumWidth

void setMinimumWidth(double pixels)

Sets the minimum width for this column.

This defines the minimum guaranteed pixel width of the column when it is set to expand.

Parameters:

pixels - the new minimum pixel width of the column

See Also:

setWidth(double), setExpandRatio(int)

getMaximumWidth

double getMaximumWidth()

Returns:

the maximum width for this column

See Also:

setMaximumWidth(double)

setMaximumWidth

void setMaximumWidth(double pixels)

Sets the maximum width for this column.

This defines the maximum allowed pixel width of the column when it is set to expand.

Parameters:

pixels - the new maximum pixel width of the column

See Also:

setWidth(double), setExpandRatio(int)

isVisible

boolean isVisible()

Returns:

false if the column is currently hidden by security permissions, true otherwise

setVisible

void setVisible(boolean visible)

Hides or shows the column according to security permissions. Invisible column doesn't send any data to client side.

Parameters:

visible - false to hide the column, true to show

isCollapsed

boolean isCollapsed()

Returns:

true if the column is currently hidden, false otherwise

setCollapsed

void setCollapsed(boolean collapsed)

Hides or shows the column. By default columns are visible before explicitly hiding them.

Parameters:

collapsed - true to hide the column, false to show

isCollapsible

boolean isCollapsible()

Returns whether this column can be hidden by the user. Default is true.

Note: the column can be programmatically hidden using setCollapsed(boolean) regardless of the returned value.

Returns:

true if the user can hide the column, false if not

See Also:

DataGrid.isColumnsCollapsingAllowed(), DataGrid.setColumnsCollapsingAllowed(boolean)

setCollapsible

void setCollapsible(boolean collapsible)

Sets whether this column can be hidden by the user. Hidable columns can be hidden and shown via the sidebar menu.

Parameters:

collapsible - true if the column may be hidden by the user via UI interaction

See Also:

DataGrid.isColumnsCollapsingAllowed(), DataGrid.setColumnsCollapsingAllowed(boolean)

isSortable

boolean isSortable()

Returns whether the user can sort the grid by this column.

Returns:

true if the column is sortable by the user, false otherwise

setSortable

void setSortable(boolean sortable)

Sets whether this column is sortable by the user. The DataGrid can be sorted by a sortable column by clicking or tapping the column's default header.

Parameters:

sortable - true if the user should be able to sort the column, false otherwise

See Also:

DataGrid.setSortable(boolean)

isResizable

boolean isResizable()

Returns whether this column can be resized by the user. Default is true.

Note: the column can be programmatically resized using setWidth(double) and setWidthAuto() regardless of the returned value.

Returns:

true if this column is resizable, false otherwise

setResizable

void setResizable(boolean resizable)

Sets whether this column can be resized by the user.

Parameters:

resizable - true if this column should be resizable, false otherwise

setLastFrozenColumn

void setLastFrozenColumn()

Sets this column as the last frozen column in its grid.

See Also:

DataGrid.setFrozenColumnCount(int)

getRenderer

DataGrid.Renderer getRenderer()

Returns the renderer instance used by this column.

Returns:

the renderer

setRenderer

void setRenderer(DataGrid.Renderer renderer)

Sets the renderer for this column. If given renderer is null, then the default renderer will be used.

Parameters:

renderer - the renderer to use

See Also:

#setConverter(Converter)

getConverter

DataGrid.Converter<?,?> getConverter()

Returns the converter instance used by this column.

Returns:

the converter

setConverter

void setConverter(DataGrid.Converter<?,?> converter)

Sets the converter used to convert from the property value type to the renderer presentation type. If given converter is null, then the default converter will be used.

Parameters:

converter - the converter to use, or null to not use any converters

See Also:

#setRenderer(Renderer)

getType

@Nullable
java.lang.Class getType()

Returns:

the type of value represented by this column

isEditable

boolean isEditable()

Returns whether the properties corresponding to this column should be editable when the item editor is active.

Returns:

true if this column is editable, false otherwise

See Also:

DataGrid.edit(Entity), setEditable(boolean)

setEditable

void setEditable(boolean editable)

Sets whether the properties corresponding to this column should be editable when the item editor is active. By default columns are editable.

Values in non-editable columns are currently not displayed when the editor is active, but this will probably change in the future. They are not automatically assigned an editor field and, if one is manually assigned, it is not used. Columns that cannot (or should not) be edited even in principle should be set non-editable.

Parameters:

editable - true if this column should be editable, false otherwise

See Also:

DataGrid.edit(Entity), DataGrid.isEditorActive()

getEditorFieldGenerator

DataGrid.ColumnEditorFieldGenerator getEditorFieldGenerator()

Returns:

field generator that generates component for this column in DataGrid editor.

setEditorFieldGenerator

void setEditorFieldGenerator(DataGrid.ColumnEditorFieldGenerator fieldFactory)

Parameters:

fieldFactory - field generator that generates component for this column in DataGrid editor.

getOwner

DataGrid getOwner()

Returns:

The DataGrid this column belongs to

setOwner

void setOwner(DataGrid owner)

Parameters:

owner - The DataGrid this column belongs to