Class VGrid.VColumn<T>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.grid.Grid.Column<T>
org.vaadin.firitin.components.grid.VGrid.VColumn<T>
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, Serializable
Enclosing class:
VGrid<T>
public static class VGrid.VColumn<T> extends com.vaadin.flow.component.grid.Grid.Column<T>
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final com.vaadin.flow.component.grid.Grid<?>
    grid
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    VColumn(com.vaadin.flow.component.grid.Grid<T> grid, String columnId, com.vaadin.flow.data.renderer.Renderer<T> renderer)
    Constructs a new Column for use inside a Grid.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected List<com.vaadin.flow.component.grid.Grid.Column<?>>
    getBottomChildColumns()
     
    com.vaadin.flow.component.Component
    getFooterComponent()
     
    default String
    getFooterPartName()
     
    String
    getFooterText()
     
    com.vaadin.flow.component.grid.Grid<?>
    getGrid()
     
    com.vaadin.flow.component.Component
    getHeaderComponent()
     
    default String
    getHeaderPartName()
     
    String
    getHeaderText()
     
    com.vaadin.flow.dom.Style
    getStyle()
     
    default com.vaadin.flow.component.grid.ColumnTextAlign
    getTextAlign()
     
    protected boolean
    hasSortingIndicators()
     
    default boolean
    isFrozen()
     
    default boolean
    isFrozenToEnd()
     
    default boolean
    isResizable()
     
    protected void
    moveFooterContent(com.vaadin.flow.component.grid.AbstractColumn<?> arg0)
     
    protected void
    moveHeaderContent(com.vaadin.flow.component.grid.AbstractColumn<?> arg0)
     
    <C extends com.vaadin.flow.component.Component>
    VGrid.VColumn<T>
    setComponentRenderer(com.vaadin.flow.function.ValueProvider<T,C> componentProvider)
    Replaces the way this column is rendered with a component, leaving the rest of the column configuration untouched.
    protected void
    setFooterComponent(com.vaadin.flow.component.Component arg0)
     
    default com.vaadin.flow.component.grid.Grid.Column<T>
    setFooterPartName(String arg0)
     
    protected void
    setFooterText(String arg0)
     
    default com.vaadin.flow.component.grid.Grid.Column<T>
    setFrozen(boolean arg0)
     
    default com.vaadin.flow.component.grid.Grid.Column<T>
    setFrozenToEnd(boolean arg0)
     
    protected void
    setHeaderComponent(com.vaadin.flow.component.Component arg0)
     
    default com.vaadin.flow.component.grid.Grid.Column<T>
    setHeaderPartName(String arg0)
     
    protected void
    setHeaderText(String arg0)
     
    VGrid.VColumn<T>
    setKey(String key)
     
    default com.vaadin.flow.component.grid.Grid.Column<T>
    setResizable(boolean arg0)
     
    protected void
    setSortingIndicators(boolean arg0)
     
    default com.vaadin.flow.component.grid.Grid.Column<T>
    setTextAlign(com.vaadin.flow.component.grid.ColumnTextAlign arg0)
     
    void
    setVisible(boolean arg0)
     
    protected void
    updateSortingIndicators(boolean arg0)
     
    VGrid.VColumn<T>
    withKey(PropertyRef<T,?> property)
    Sets the key of this column, using a method reference to the getter of the property instead of a string.
    VGrid.VColumn<T>
    withRenderer(com.vaadin.flow.data.renderer.Renderer<T> renderer)
    Replaces the renderer of this column, leaving the rest of the column configuration untouched.
    final VGrid.VColumn<T>
    withSortProperties(PropertyRef<T,?>... properties)
    Sets the properties this column is sorted by in the backend, using method references to their getters instead of property name strings.

    Methods inherited from class com.vaadin.flow.component.grid.Grid.Column

    destroyDataGenerators, getBottomLevelColumn, getComparator, getEditorComponent, getElement, getFlexGrow, getInternalId, getKey, getPartNameGenerator, getRenderer, getSortOrder, getTooltipGenerator, getWidth, isAutoWidth, isRowHeader, isSortable, setAutoWidth, setComparator, setComparator, setEditorComponent, setEditorComponent, setFlexGrow, setFooter, setFooter, setHeader, setHeader, setPartNameGenerator, setRenderer, setRowHeader, setSortable, setSortOrderProvider, setSortProperty, setTooltipGenerator, setWidth

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, bindVisible, findAncestor, fireEvent, from, get, getChildren, getEventBus, getId, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setTestId

    Methods inherited from class Object

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

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, bindClassName, bindClassNames, getClassName, getClassNames, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

  • Field Details

    • grid

      protected final com.vaadin.flow.component.grid.Grid<?> grid

  • Constructor Details

    • VColumn

      public VColumn(com.vaadin.flow.component.grid.Grid<T> grid, String columnId, com.vaadin.flow.data.renderer.Renderer<T> renderer)
      Constructs a new Column for use inside a Grid.
      Parameters:
      grid - the grid this column is attached to
      columnId - unique identifier of this column
      renderer - the renderer to use in this column, must not be null

  • Method Details

    • withSortProperties

      @SafeVarargs public final VGrid.VColumn<T> withSortProperties(PropertyRef<T,?>... properties)
      Sets the properties this column is sorted by in the backend, using method references to their getters instead of property name strings.
      Parameters:
      properties - method references to the getters of the sort properties
      Returns:
      this column, for further configuration

    • withKey

      public VGrid.VColumn<T> withKey(PropertyRef<T,?> property)
      Sets the key of this column, using a method reference to the getter of the property instead of a string.
      Parameters:
      property - a method reference to the getter of the property
      Returns:
      this column, for further configuration

    • setComponentRenderer

      public <C extends com.vaadin.flow.component.Component> VGrid.VColumn<T> setComponentRenderer(com.vaadin.flow.function.ValueProvider<T,C> componentProvider)
      Replaces the way this column is rendered with a component, leaving the rest of the column configuration untouched.
      Type Parameters:
      C - the component type
      Parameters:
      componentProvider - creates the component to show for a row
      Returns:
      this column, for further configuration

    • withRenderer

      public VGrid.VColumn<T> withRenderer(com.vaadin.flow.data.renderer.Renderer<T> renderer)
      Replaces the renderer of this column, leaving the rest of the column configuration untouched.
      Parameters:
      renderer - the new renderer
      Returns:
      this column, for further configuration

    • setKey

      public VGrid.VColumn<T> setKey(String key)
      Overrides:
      setKey in class com.vaadin.flow.component.grid.Grid.Column<T>

    • getStyle

      public com.vaadin.flow.dom.Style getStyle()

    • getGrid

      public com.vaadin.flow.component.grid.Grid<?> getGrid()

    • setVisible

      public void setVisible(boolean arg0)
      Overrides:
      setVisible in class com.vaadin.flow.component.Component

    • getHeaderText

      public String getHeaderText()

    • setHeaderText

      protected void setHeaderText(String arg0)

    • getFooterText

      public String getFooterText()

    • setFooterText

      protected void setFooterText(String arg0)

    • getHeaderComponent

      public com.vaadin.flow.component.Component getHeaderComponent()

    • setHeaderComponent

      protected void setHeaderComponent(com.vaadin.flow.component.Component arg0)

    • getFooterComponent

      public com.vaadin.flow.component.Component getFooterComponent()

    • setFooterComponent

      protected void setFooterComponent(com.vaadin.flow.component.Component arg0)

    • moveHeaderContent

      protected void moveHeaderContent(com.vaadin.flow.component.grid.AbstractColumn<?> arg0)

    • moveFooterContent

      protected void moveFooterContent(com.vaadin.flow.component.grid.AbstractColumn<?> arg0)

    • updateSortingIndicators

      protected void updateSortingIndicators(boolean arg0)

    • setSortingIndicators

      protected void setSortingIndicators(boolean arg0)

    • hasSortingIndicators

      protected boolean hasSortingIndicators()

    • getBottomChildColumns

      protected List<com.vaadin.flow.component.grid.Grid.Column<?>> getBottomChildColumns()

    • setResizable

      default com.vaadin.flow.component.grid.Grid.Column<T> setResizable(boolean arg0)

    • isResizable

      @Synchronize("resizable-changed") default boolean isResizable()

    • setFrozen

      default com.vaadin.flow.component.grid.Grid.Column<T> setFrozen(boolean arg0)

    • isFrozen

      @Synchronize("frozen-changed") default boolean isFrozen()

    • setFrozenToEnd

      default com.vaadin.flow.component.grid.Grid.Column<T> setFrozenToEnd(boolean arg0)

    • isFrozenToEnd

      @Synchronize("frozen-to-end-changed") default boolean isFrozenToEnd()

    • setTextAlign

      default com.vaadin.flow.component.grid.Grid.Column<T> setTextAlign(com.vaadin.flow.component.grid.ColumnTextAlign arg0)

    • getTextAlign

      @Synchronize("text-align-changed") default com.vaadin.flow.component.grid.ColumnTextAlign getTextAlign()

    • setHeaderPartName

      default com.vaadin.flow.component.grid.Grid.Column<T> setHeaderPartName(String arg0)

    • getHeaderPartName

      default String getHeaderPartName()

    • setFooterPartName

      default com.vaadin.flow.component.grid.Grid.Column<T> setFooterPartName(String arg0)

    • getFooterPartName

      default String getFooterPartName()