AbstractDataGrid.ColumnImpl (Jmix-ui 1.0 API)

java.lang.Object
- io.jmix.ui.component.impl.AbstractDataGrid.ColumnImpl<E>

All Implemented Interfaces:

Component.HasXmlDescriptor, DataGrid.Column<E>, java.io.Serializable

Enclosing class:

AbstractDataGrid<C extends com.vaadin.ui.Grid<E> & JmixEnhancedGrid<E>,E>
```
protected static class AbstractDataGrid.ColumnImpl<E>
extends java.lang.Object
implements DataGrid.Column<E>, Component.HasXmlDescriptor
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected AggregationInfo`	`aggregation`
`protected java.lang.String`	`caption`
`protected boolean`	`collapsed`
`protected boolean`	`collapsible`
`protected java.lang.String`	`collapsingToggleCaption`
`protected ContentMode`	`descriptionContentMode`
`protected java.util.function.Function<? super E,java.lang.String>`	`descriptionProvider`
`protected boolean`	`editable`
`protected org.dom4j.Element`	`element`
`protected int`	`expandRatio`
`protected boolean`	`generated`
`protected java.util.function.Function<DataGrid.EditorFieldGenerationContext<E>,Field<?>>`	`generator`
`protected com.vaadin.ui.Grid.Column<E,?>`	`gridColumn`
`protected java.lang.String`	`id`
`protected double`	`maxWidth`
`protected double`	`minWidth`
`protected AbstractDataGrid<?,E>`	`owner`
`protected java.util.function.Function`	`presentationProvider`
`protected io.jmix.core.metamodel.model.MetaPropertyPath`	`propertyPath`
`protected AbstractDataGrid.AbstractRenderer<E,?>`	`renderer`
`protected boolean`	`resizable`
`protected boolean`	`sortable`
`protected java.util.function.Function<? super E,java.lang.String>`	`styleProvider`
`protected java.lang.String`	`valueDescription`
`protected boolean`	`visible`
`protected double`	`width`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ColumnImpl(java.lang.String id, io.jmix.core.metamodel.model.MetaPropertyPath propertyPath, AbstractDataGrid<?,E> owner)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearExpandRatio()` Clears the expand ratio for this column.
`boolean`	`equals(java.lang.Object o)`
`AggregationInfo`	`getAggregation()`
`java.lang.String`	`getCaption()`
`java.lang.String`	`getCollapsingToggleCaption()`
`ContentMode`	`getDescriptionContentMode()`
`java.util.function.Function<E,java.lang.String>`	`getDescriptionProvider()`
`java.util.function.Function<DataGrid.EditorFieldGenerationContext<E>,Field<?>>`	`getEditFieldGenerator()`
`int`	`getExpandRatio()`
`com.vaadin.ui.Grid.Column<E,?>`	`getGridColumn()`
`java.lang.String`	`getId()`
`double`	`getMaximumWidth()`
`protected io.jmix.core.metamodel.model.MetaProperty`	`getMetaProperty()`
`double`	`getMinimumWidth()`
`DataGrid<E>`	`getOwner()`
`java.util.function.Function`	`getPresentationProvider()`
`java.lang.Object`	`getPropertyId()`
`io.jmix.core.metamodel.model.MetaPropertyPath`	`getPropertyPath()`
`DataGrid.Renderer`	`getRenderer()` Returns the renderer instance used by this column.
`java.util.function.Function<E,java.lang.String>`	`getStyleProvider()`
`java.lang.String`	`getValueDescription()`
`double`	`getWidth()`
`org.dom4j.Element`	`getXmlDescriptor()`
`int`	`hashCode()`
`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.
`protected boolean`	`isEditingPermitted()`
`boolean`	`isGenerated()`
`protected boolean`	`isRepresentsCollection()`
`boolean`	`isResizable()` Returns whether this column can be resized by the user.
`boolean`	`isShouldBeEditable()`
`boolean`	`isSortable()` Returns whether the user can sort the grid by this column.
`boolean`	`isVisible()`
`boolean`	`isWidthAuto()`
`void`	`setAggregation(AggregationInfo info)` Sets an aggregation info in order to perform aggregation for this column.
`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`	`setDescriptionProvider(java.util.function.Function<? super E,java.lang.String> descriptionProvider)` Sets the description provider that is used for generating descriptions for cells in this column.
`void`	`setDescriptionProvider(java.util.function.Function<? super E,java.lang.String> descriptionProvider, ContentMode contentMode)` Sets the description provider that is used for generating descriptions for cells in this column.
`void`	`setEditable(boolean editable)` Sets whether the properties corresponding to this column should be editable when the item editor is active.
`void`	`setEditFieldGenerator(java.util.function.Function<DataGrid.EditorFieldGenerationContext<E>,Field<?>> generator)`
`void`	`setExpandRatio(int expandRatio)` Sets the ratio with which the column expands.
`void`	`setGenerated(boolean generated)`
`void`	`setGridColumn(com.vaadin.ui.Grid.Column<E,?> gridColumn)`
`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<E> owner)`
`void`	`setRenderer(DataGrid.Renderer renderer)` Sets the renderer for this column.
`void`	`setRenderer(DataGrid.Renderer renderer, java.util.function.Function presentationProvider)` 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`	`setStyleProvider(java.util.function.Function<? super E,java.lang.String> styleProvider)` Sets the style provider for the DataGrid column.
`protected void`	`setupDefaults()`
`void`	`setValueDescription(java.lang.String valueDescription)` Sets value description for aggregated row cells.
`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.
`void`	`setXmlDescriptor(org.dom4j.Element element)`
`java.lang.String`	`toString()`
`void`	`updateCollapsible()`
`protected void`	`updateEditable()`
`protected void`	`updateRendererInternal()`
`void`	`updateSortable()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.jmix.ui.component.DataGrid.Column
setColumnGenerator

- Field Detail
  - id
```
protected final java.lang.String id
```
  - propertyPath
```
protected final io.jmix.core.metamodel.model.MetaPropertyPath propertyPath
```
  - caption
```
protected java.lang.String caption
```
  - collapsingToggleCaption
```
protected java.lang.String collapsingToggleCaption
```
  - width
```
protected double width
```
  - minWidth
```
protected double minWidth
```
  - maxWidth
```
protected double maxWidth
```
  - expandRatio
```
protected int expandRatio
```
  - collapsed
```
protected boolean collapsed
```
  - visible
```
protected boolean visible
```
  - collapsible
```
protected boolean collapsible
```
  - sortable
```
protected boolean sortable
```
  - resizable
```
protected boolean resizable
```
  - editable
```
protected boolean editable
```
  - generated
```
protected boolean generated
```
  - aggregation
```
protected AggregationInfo aggregation
```
  - valueDescription
```
protected java.lang.String valueDescription
```
  - renderer
```
protected AbstractDataGrid.AbstractRenderer<E,?> renderer
```
  - presentationProvider
```
protected java.util.function.Function presentationProvider
```
  - styleProvider
```
protected java.util.function.Function<? super E,java.lang.String> styleProvider
```
  - descriptionProvider
```
protected java.util.function.Function<? super E,java.lang.String> descriptionProvider
```
  - descriptionContentMode
```
protected ContentMode descriptionContentMode
```
  - element
```
protected org.dom4j.Element element
```
  - owner
```
protected AbstractDataGrid<?,E> owner
```
  - gridColumn
```
protected com.vaadin.ui.Grid.Column<E,?> gridColumn
```
  - generator
```
protected java.util.function.Function<DataGrid.EditorFieldGenerationContext<E>,Field<?>> generator
```
- Constructor Detail
  - ColumnImpl
```
protected ColumnImpl(java.lang.String id,
                     @Nullable
                     io.jmix.core.metamodel.model.MetaPropertyPath propertyPath,
                     AbstractDataGrid<?,E> owner)
```
- Method Detail
  - setupDefaults
```
protected void setupDefaults()
```
  - getId
```
public java.lang.String getId()
```
    Specified by:
    
    getId in interface DataGrid.Column<E>
    
    Returns:
    
    id of a column
  - getPropertyPath
```
@Nullable
public io.jmix.core.metamodel.model.MetaPropertyPath getPropertyPath()
```
    Specified by:
    
    getPropertyPath in interface DataGrid.Column<E>
    
    Returns:
    
    the instance of MetaPropertyPath representing a relative path to a property from certain MetaClass
  - getPropertyId
```
public java.lang.Object getPropertyId()
```
  - getCaption
```
@Nullable
public java.lang.String getCaption()
```
    Specified by:
    
    getCaption in interface DataGrid.Column<E>
    
    Returns:
    
    the caption of the header
  - setCaption
```
public void setCaption(java.lang.String caption)
```
    Description copied from interface: DataGrid.Column
    
    Sets the caption of the header. This caption is also used as the hiding toggle caption, unless it is explicitly set via DataGrid.Column.setCollapsingToggleCaption(String).
    
    Specified by:
    
    setCaption in interface DataGrid.Column<E>
    
    Parameters:
    
    caption - the text to show in the caption
  - getCollapsingToggleCaption
```
public java.lang.String getCollapsingToggleCaption()
```
    Specified by:
    
    getCollapsingToggleCaption in interface DataGrid.Column<E>
    
    Returns:
    
    the caption for the hiding toggle for this column
  - setCollapsingToggleCaption
```
public void setCollapsingToggleCaption(@Nullable
                                       java.lang.String collapsingToggleCaption)
```
    Description copied from interface: DataGrid.Column
    
    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.
    
    Specified by:
    
    setCollapsingToggleCaption in interface DataGrid.Column<E>
    
    Parameters:
    
    collapsingToggleCaption - the text to show in the column hiding toggle
  - getWidth
```
public double getWidth()
```
    Specified by:
    
    getWidth in interface DataGrid.Column<E>
    
    Returns:
    
    the width in pixels of the column
  - setWidth
```
public void setWidth(double width)
```
    Description copied from interface: DataGrid.Column
    
    Sets the width (in pixels).
    This overrides any configuration set by any of DataGrid.Column.setExpandRatio(int), DataGrid.Column.setMinimumWidth(double) or DataGrid.Column.setMaximumWidth(double).
    
    Specified by:
    
    setWidth in interface DataGrid.Column<E>
    
    Parameters:
    
    width - the new pixel width of the column
  - isWidthAuto
```
public boolean isWidthAuto()
```
    Specified by:
    
    isWidthAuto in interface DataGrid.Column<E>
    
    Returns:
    
    whether the width is auto
  - setWidthAuto
```
public void setWidthAuto()
```
    Description copied from interface: DataGrid.Column
    
    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.
    
    Specified by:
    
    setWidthAuto in interface DataGrid.Column<E>
  - getExpandRatio
```
public int getExpandRatio()
```
    Specified by:
    
    getExpandRatio in interface DataGrid.Column<E>
    
    Returns:
    
    the column's expand ratio
    
    See Also:
    
    DataGrid.Column.setExpandRatio(int)
  - setExpandRatio
```
public void setExpandRatio(int expandRatio)
```
    Description copied from interface: DataGrid.Column
    
    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 (DataGrid.Column.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.
    
    Specified by:
    
    setExpandRatio in interface DataGrid.Column<E>
    
    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:
    
    DataGrid.Column.setWidth(double)
  - clearExpandRatio
```
public void clearExpandRatio()
```
    Description copied from interface: DataGrid.Column
    
    Clears the expand ratio for this column.
    Equal to calling setExpandRatio(-1)
    
    Specified by:
    
    clearExpandRatio in interface DataGrid.Column<E>
  - getMinimumWidth
```
public double getMinimumWidth()
```
    Specified by:
    
    getMinimumWidth in interface DataGrid.Column<E>
    
    Returns:
    
    the minimum width for this column
    
    See Also:
    
    DataGrid.Column.setMinimumWidth(double)
  - setMinimumWidth
```
public void setMinimumWidth(double pixels)
```
    Description copied from interface: DataGrid.Column
    
    Sets the minimum width for this column.
    This defines the minimum guaranteed pixel width of the column when it is set to expand.
    
    Specified by:
    
    setMinimumWidth in interface DataGrid.Column<E>
    
    Parameters:
    
    pixels - the new minimum pixel width of the column
    
    See Also:
    
    DataGrid.Column.setWidth(double), DataGrid.Column.setExpandRatio(int)
  - getMaximumWidth
```
public double getMaximumWidth()
```
    Specified by:
    
    getMaximumWidth in interface DataGrid.Column<E>
    
    Returns:
    
    the maximum width for this column
    
    See Also:
    
    DataGrid.Column.setMaximumWidth(double)
  - setMaximumWidth
```
public void setMaximumWidth(double pixels)
```
    Description copied from interface: DataGrid.Column
    
    Sets the maximum width for this column.
    This defines the maximum allowed pixel width of the column when it is set to expand.
    
    Specified by:
    
    setMaximumWidth in interface DataGrid.Column<E>
    
    Parameters:
    
    pixels - the new maximum pixel width of the column
    
    See Also:
    
    DataGrid.Column.setWidth(double), DataGrid.Column.setExpandRatio(int)
  - isVisible
```
public boolean isVisible()
```
    Specified by:
    
    isVisible in interface DataGrid.Column<E>
    
    Returns:
    
    false if the column is currently hidden by security permissions, true otherwise
  - setVisible
```
public void setVisible(boolean visible)
```
    Description copied from interface: DataGrid.Column
    
    Hides or shows the column according to security permissions. Invisible column doesn't send any data to client side.
    
    Specified by:
    
    setVisible in interface DataGrid.Column<E>
    
    Parameters:
    
    visible - false to hide the column, true to show
  - isCollapsed
```
public boolean isCollapsed()
```
    Specified by:
    
    isCollapsed in interface DataGrid.Column<E>
    
    Returns:
    
    true if the column is currently hidden, false otherwise
  - setCollapsed
```
public void setCollapsed(boolean collapsed)
```
    Description copied from interface: DataGrid.Column
    
    Hides or shows the column. By default columns are visible before explicitly hiding them.
    
    Specified by:
    
    setCollapsed in interface DataGrid.Column<E>
    
    Parameters:
    
    collapsed - true to hide the column, false to show
  - isCollapsible
```
public boolean isCollapsible()
```
    Description copied from interface: DataGrid.Column
    
    Returns whether this column can be hidden by the user. Default is true. Note: the column can be programmatically hidden using DataGrid.Column.setCollapsed(boolean) regardless of the returned value.
    
    Specified by:
    
    isCollapsible in interface DataGrid.Column<E>
    
    Returns:
    
    true if the user can hide the column, false if not
    
    See Also:
    
    DataGrid.isColumnsCollapsingAllowed(), DataGrid.setColumnsCollapsingAllowed(boolean)
  - setCollapsible
```
public void setCollapsible(boolean collapsible)
```
    Description copied from interface: DataGrid.Column
    
    Sets whether this column can be hidden by the user. Hidable columns can be hidden and shown via the sidebar menu.
    
    Specified by:
    
    setCollapsible in interface DataGrid.Column<E>
    
    Parameters:
    
    collapsible - true if the column may be hidden by the user via UI interaction
    
    See Also:
    
    DataGrid.isColumnsCollapsingAllowed(), DataGrid.setColumnsCollapsingAllowed(boolean)
  - updateCollapsible
```
public void updateCollapsible()
```
  - isSortable
```
public boolean isSortable()
```
    Description copied from interface: DataGrid.Column
    
    Returns whether the user can sort the grid by this column.
    
    Specified by:
    
    isSortable in interface DataGrid.Column<E>
    
    Returns:
    
    true if the column is sortable by the user, false otherwise
  - setSortable
```
public void setSortable(boolean sortable)
```
    Description copied from interface: DataGrid.Column
    
    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.
    
    Specified by:
    
    setSortable in interface DataGrid.Column<E>
    
    Parameters:
    
    sortable - true if the user should be able to sort the column, false otherwise
    
    See Also:
    
    DataGrid.setSortable(boolean)
  - updateSortable
```
public void updateSortable()
```
  - isResizable
```
public boolean isResizable()
```
    Description copied from interface: DataGrid.Column
    
    Returns whether this column can be resized by the user. Default is true. Note: the column can be programmatically resized using DataGrid.Column.setWidth(double) and DataGrid.Column.setWidthAuto() regardless of the returned value.
    
    Specified by:
    
    isResizable in interface DataGrid.Column<E>
    
    Returns:
    
    true if this column is resizable, false otherwise
  - setResizable
```
public void setResizable(boolean resizable)
```
    Description copied from interface: DataGrid.Column
    
    Sets whether this column can be resized by the user.
    
    Specified by:
    
    setResizable in interface DataGrid.Column<E>
    
    Parameters:
    
    resizable - true if this column should be resizable, false otherwise
  - getMetaProperty
```
@Nullable
protected io.jmix.core.metamodel.model.MetaProperty getMetaProperty()
```
  - getXmlDescriptor
```
@Nullable
public org.dom4j.Element getXmlDescriptor()
```
    Specified by:
    
    getXmlDescriptor in interface Component.HasXmlDescriptor
  - setXmlDescriptor
```
public void setXmlDescriptor(@Nullable
                             org.dom4j.Element element)
```
    Specified by:
    
    setXmlDescriptor in interface Component.HasXmlDescriptor
  - getRenderer
```
@Nullable
public DataGrid.Renderer getRenderer()
```
    Description copied from interface: DataGrid.Column
    
    Returns the renderer instance used by this column.
    
    Specified by:
    
    getRenderer in interface DataGrid.Column<E>
    
    Returns:
    
    the renderer
  - setRenderer
```
public void setRenderer(@Nullable
                        DataGrid.Renderer renderer)
```
    Description copied from interface: DataGrid.Column
    
    Sets the renderer for this column. If given renderer is null, then the default renderer will be used.
    
    Specified by:
    
    setRenderer in interface DataGrid.Column<E>
    
    Parameters:
    
    renderer - the renderer to use
    
    See Also:
    
    #setRenderer(Renderer, Function)
  - setRenderer
```
public void setRenderer(@Nullable
                        DataGrid.Renderer renderer,
                        @Nullable
                        java.util.function.Function presentationProvider)
```
    Description copied from interface: DataGrid.Column
    
    Sets the renderer for this column. If given renderer is null, then the default renderer will be used.
    The presentation provider is a Function that takes the value of this column on a single row, and converts that to a value that the renderer accepts.
    The presentation provider takes precedence over formatter.
    
    Specified by:
    
    setRenderer in interface DataGrid.Column<E>
    
    Parameters:
    
    renderer - the renderer to use
    
    presentationProvider - the presentation provider to use
    
    See Also:
    
    #setRenderer(Renderer)
  - updateRendererInternal
```
protected void updateRendererInternal()
```
  - getPresentationProvider
```
@Nullable
public java.util.function.Function getPresentationProvider()
```
    Specified by:
    
    getPresentationProvider in interface DataGrid.Column<E>
    
    Returns:
    
    a function to get presentations from the value of this column
  - isGenerated
```
public boolean isGenerated()
```
  - setGenerated
```
public void setGenerated(boolean generated)
```
  - isEditable
```
public boolean isEditable()
```
    Description copied from interface: DataGrid.Column
    
    Returns whether the properties corresponding to this column should be editable when the item editor is active.
    
    Specified by:
    
    isEditable in interface DataGrid.Column<E>
    
    Returns:
    
    true if this column is editable, false otherwise
    
    See Also:
    
    DataGrid.edit(Object), DataGrid.Column.setEditable(boolean)
  - isShouldBeEditable
```
public boolean isShouldBeEditable()
```
  - isRepresentsCollection
```
protected boolean isRepresentsCollection()
```
  - isEditingPermitted
```
protected boolean isEditingPermitted()
```
  - setEditable
```
public void setEditable(boolean editable)
```
    Description copied from interface: DataGrid.Column
    
    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.
    
    Specified by:
    
    setEditable in interface DataGrid.Column<E>
    
    Parameters:
    
    editable - true if this column should be editable, false otherwise
    
    See Also:
    
    DataGrid.edit(Object), DataGrid.isEditorActive()
  - updateEditable
```
protected void updateEditable()
```
  - getEditFieldGenerator
```
@Nullable
public java.util.function.Function<DataGrid.EditorFieldGenerationContext<E>,Field<?>> getEditFieldGenerator()
```
    Specified by:
    
    getEditFieldGenerator in interface DataGrid.Column<E>
    
    Returns:
    
    field generator that generates a component for this column in DataGrid editor
  - setEditFieldGenerator
```
public void setEditFieldGenerator(@Nullable
                                  java.util.function.Function<DataGrid.EditorFieldGenerationContext<E>,Field<?>> generator)
```
    Specified by:
    
    setEditFieldGenerator in interface DataGrid.Column<E>
    
    Parameters:
    
    generator - field generator that generates a component for this column in DataGrid editor.
  - getStyleProvider
```
@Nullable
public java.util.function.Function<E,java.lang.String> getStyleProvider()
```
    Specified by:
    
    getStyleProvider in interface DataGrid.Column<E>
    
    Returns:
    
    the style provider that is used for generating styles for cells
  - setStyleProvider
```
public void setStyleProvider(@Nullable
                             java.util.function.Function<? super E,java.lang.String> styleProvider)
```
    Description copied from interface: DataGrid.Column
    
    Sets the style provider for the DataGrid column.
    
    Specified by:
    
    setStyleProvider in interface DataGrid.Column<E>
    
    Parameters:
    
    styleProvider - a style provider to set
  - getDescriptionProvider
```
@Nullable
public java.util.function.Function<E,java.lang.String> getDescriptionProvider()
```
    Specified by:
    
    getDescriptionProvider in interface DataGrid.Column<E>
    
    Returns:
    
    the description provider that is used for generating descriptions for cells in this column
  - setDescriptionProvider
```
public void setDescriptionProvider(@Nullable
                                   java.util.function.Function<? super E,java.lang.String> descriptionProvider)
```
    Description copied from interface: DataGrid.Column
    
    Sets the description provider that is used for generating descriptions for cells in this column.
    This method uses the ContentMode.PREFORMATTED content mode.
    
    Specified by:
    
    setDescriptionProvider in interface DataGrid.Column<E>
    
    Parameters:
    
    descriptionProvider - a description provider to set, or null to remove a previously set generator
  - setDescriptionProvider
```
public void setDescriptionProvider(@Nullable
                                   java.util.function.Function<? super E,java.lang.String> descriptionProvider,
                                   ContentMode contentMode)
```
    Description copied from interface: DataGrid.Column
    
    Sets the description provider that is used for generating descriptions for cells in this column.
    
    Specified by:
    
    setDescriptionProvider in interface DataGrid.Column<E>
    
    Parameters:
    
    descriptionProvider - a description provider to set, or null to remove a previously set generator
    
    contentMode - a content mode for row tooltips
  - getDescriptionContentMode
```
public ContentMode getDescriptionContentMode()
```
  - getGridColumn
```
public com.vaadin.ui.Grid.Column<E,?> getGridColumn()
```
  - setGridColumn
```
public void setGridColumn(@Nullable
                          com.vaadin.ui.Grid.Column<E,?> gridColumn)
```
  - getOwner
```
@Nullable
public DataGrid<E> getOwner()
```
    Specified by:
    
    getOwner in interface DataGrid.Column<E>
    
    Returns:
    
    The DataGrid this column belongs to
  - setOwner
```
public void setOwner(@Nullable
                     DataGrid<E> owner)
```
    Specified by:
    
    setOwner in interface DataGrid.Column<E>
    
    Parameters:
    
    owner - The DataGrid this column belongs to
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getAggregation
```
@Nullable
public AggregationInfo getAggregation()
```
    Specified by:
    
    getAggregation in interface DataGrid.Column<E>
    
    Returns:
    
    aggregation info
    
    See Also:
    
    DataGrid.setAggregatable(boolean)
  - setAggregation
```
public void setAggregation(@Nullable
                           AggregationInfo info)
```
    Description copied from interface: DataGrid.Column
    
    Sets an aggregation info in order to perform aggregation for this column.
    
    Specified by:
    
    setAggregation in interface DataGrid.Column<E>
    
    Parameters:
    
    info - aggregation info
    
    See Also:
    
    DataGrid.setAggregatable(boolean)
  - getValueDescription
```
@Nullable
public java.lang.String getValueDescription()
```
    Specified by:
    
    getValueDescription in interface DataGrid.Column<E>
    
    Returns:
    
    value description for aggregation row cells
    
    See Also:
    
    DataGrid.setAggregatable(boolean)
  - setValueDescription
```
public void setValueDescription(@Nullable
                                java.lang.String valueDescription)
```
    Description copied from interface: DataGrid.Column
    
    Sets value description for aggregated row cells.
    
    Specified by:
    
    setValueDescription in interface DataGrid.Column<E>
    
    Parameters:
    
    valueDescription - value description
    
    See Also:
    
    DataGrid.setAggregatable(boolean)

Class AbstractDataGrid.ColumnImpl<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.jmix.ui.component.DataGrid.Column

Field Detail

id

propertyPath

caption

collapsingToggleCaption

width

minWidth

maxWidth

expandRatio

collapsed

visible

collapsible

sortable

resizable

editable

generated

aggregation

valueDescription

renderer

presentationProvider

styleProvider

descriptionProvider

descriptionContentMode

element

owner

gridColumn

generator

Constructor Detail

ColumnImpl

Method Detail

setupDefaults

getId

getPropertyPath

getPropertyId

getCaption

setCaption

getCollapsingToggleCaption

setCollapsingToggleCaption

getWidth

setWidth

isWidthAuto

setWidthAuto

getExpandRatio

setExpandRatio

clearExpandRatio

getMinimumWidth

setMinimumWidth

getMaximumWidth

setMaximumWidth

isVisible

setVisible

isCollapsed

setCollapsed

isCollapsible

setCollapsible

updateCollapsible

isSortable

setSortable

updateSortable

isResizable

setResizable

getMetaProperty

getXmlDescriptor

setXmlDescriptor

getRenderer

setRenderer

setRenderer

updateRendererInternal

getPresentationProvider

isGenerated

setGenerated

isEditable

isShouldBeEditable

isRepresentsCollection