Package io.jmix.groupgridflowui.component.adapter

Class DataGridColumnAdapter<E>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.grid.Grid.Column<E>
io.jmix.flowui.component.grid.DataGridColumn<E>
io.jmix.flowui.component.groupgrid.adapter.AbstractGroupDataGridColumnAdapter<E>
io.jmix.groupgridflowui.component.adapter.DataGridColumnAdapter<E>
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, Serializable, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
Direct Known Subclasses:
GroupDataGridColumnAdapter
public class DataGridColumnAdapter<E> extends AbstractGroupDataGridColumnAdapter<E>
See Also:

  • Field Details

    • adaptee

      protected DataGridColumn<E> adaptee

    • grid

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

  • Constructor Details

    • DataGridColumnAdapter

      public DataGridColumnAdapter(com.vaadin.flow.component.grid.Grid<E> grid, String columnId, com.vaadin.flow.data.renderer.Renderer<E> renderer, DataGridColumn<E> adaptee)

  • Method Details

    • getAdaptee

      public DataGridColumn<E> getAdaptee()
      Specified by:
      getAdaptee in class AbstractGroupDataGridColumnAdapter<E>
      Returns:
      the adaptee column

    • getStoredHeaderText

      @Nullable public String getStoredHeaderText()
      Description copied from class: AbstractGroupDataGridColumnAdapter
      Returns the header text that was directly set on the adaptee column.

      The header text can be deleted from the column if a grid contains additional headers. In this case, the header text must be retrieved from the cell of the header row. However, the grouping column is not attached to the grid and at the same time contains empty header text. In such cases, to get a correct header text, this method should be used.

      Specified by:
      getStoredHeaderText in class AbstractGroupDataGridColumnAdapter<E>
      Returns:
      the header text or null if not set

    • getStoredHeaderComponent

      @Nullable public com.vaadin.flow.component.Component getStoredHeaderComponent()
      Description copied from class: AbstractGroupDataGridColumnAdapter
      Returns the header component that was directly set on the adaptee column.

      The header component can be deleted from the column if a grid contains additional headers. In this case, the header component must be retrieved from the cell of the header row. However, the grouping column is not attached to the grid and at the same time does not contain a header component. In such cases, to get a header component, this method should be used.

      Specified by:
      getStoredHeaderComponent in class AbstractGroupDataGridColumnAdapter<E>
      Returns:
      the header component or null if not set

    • setClassNameGenerator

      public com.vaadin.flow.component.grid.Grid.Column<E> setClassNameGenerator(com.vaadin.flow.function.SerializableFunction<E,String> classNameGenerator)
      Overrides:
      setClassNameGenerator in class DataGridColumn<E>

    • setFilterable

      public void setFilterable(boolean filterable)
      Description copied from class: DataGridColumn
      Sets the filtering for a column. If the filtering is enabled, a filter button will be added to the column header. The filtering is disabled by default.
      Overrides:
      setFilterable in class DataGridColumn<E>
      Parameters:
      filterable - whether to add a filter to the header

    • isFilterable

      public boolean isFilterable()
      Overrides:
      isFilterable in class DataGridColumn<E>
      Returns:
      true if the filter is added to the column header, false otherwise

    • setHeader

      public com.vaadin.flow.component.grid.Grid.Column<E> setHeader(String labelText)
      Overrides:
      setHeader in class DataGridColumn<E>

    • setHeader

      public com.vaadin.flow.component.grid.Grid.Column<E> setHeader(com.vaadin.flow.component.Component headerComponent)
      Overrides:
      setHeader in class DataGridColumn<E>

    • setVisible

      public void setVisible(boolean visible)
      Overrides:
      setVisible in class DataGridColumn<E>

    • addColumnVisibilityChangedListener

      public com.vaadin.flow.shared.Registration addColumnVisibilityChangedListener(com.vaadin.flow.component.ComponentEventListener<DataGridColumnVisibilityChangedEvent<E>> listener)
      Description copied from class: DataGridColumn
      Add listener for event of column visibility change
      Overrides:
      addColumnVisibilityChangedListener in class DataGridColumn<E>
      Parameters:
      listener - the listener to add
      Returns:
      a registration handle to remove the listener

    • getRenderer

      public com.vaadin.flow.data.renderer.Renderer<E> getRenderer()
      Overrides:
      getRenderer in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setRenderer

      public com.vaadin.flow.component.grid.Grid.Column<E> setRenderer(com.vaadin.flow.data.renderer.Renderer<E> renderer)
      Overrides:
      setRenderer in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setWidth

      public com.vaadin.flow.component.grid.Grid.Column<E> setWidth(String width)
      Overrides:
      setWidth in class com.vaadin.flow.component.grid.Grid.Column<E>

    • getWidth

      public String getWidth()
      Overrides:
      getWidth in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setFlexGrow

      public com.vaadin.flow.component.grid.Grid.Column<E> setFlexGrow(int flexGrow)
      Overrides:
      setFlexGrow in class com.vaadin.flow.component.grid.Grid.Column<E>

    • getFlexGrow

      public int getFlexGrow()
      Overrides:
      getFlexGrow in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setAutoWidth

      public com.vaadin.flow.component.grid.Grid.Column<E> setAutoWidth(boolean autoWidth)
      Overrides:
      setAutoWidth in class com.vaadin.flow.component.grid.Grid.Column<E>

    • isAutoWidth

      public boolean isAutoWidth()
      Overrides:
      isAutoWidth in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setKey

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

    • getKey

      public String getKey()
      Overrides:
      getKey in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setComparator

      public com.vaadin.flow.component.grid.Grid.Column<E> setComparator(Comparator<E> comparator)
      Overrides:
      setComparator in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setComparator

      public <V extends Comparable<? super V>> com.vaadin.flow.component.grid.Grid.Column<E> setComparator(com.vaadin.flow.function.ValueProvider<E,V> keyExtractor)
      Overrides:
      setComparator in class com.vaadin.flow.component.grid.Grid.Column<E>

    • getComparator

      public com.vaadin.flow.function.SerializableComparator<E> getComparator(com.vaadin.flow.data.provider.SortDirection sortDirection)
      Overrides:
      getComparator in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setSortProperty

      public com.vaadin.flow.component.grid.Grid.Column<E> setSortProperty(String... properties)
      Overrides:
      setSortProperty in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setSortOrderProvider

      public com.vaadin.flow.component.grid.Grid.Column<E> setSortOrderProvider(com.vaadin.flow.component.grid.SortOrderProvider provider)
      Overrides:
      setSortOrderProvider in class com.vaadin.flow.component.grid.Grid.Column<E>

    • getSortOrder

      public Stream<com.vaadin.flow.data.provider.QuerySortOrder> getSortOrder(com.vaadin.flow.data.provider.SortDirection direction)
      Overrides:
      getSortOrder in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setSortable

      public com.vaadin.flow.component.grid.Grid.Column<E> setSortable(boolean sortable)
      Overrides:
      setSortable in class com.vaadin.flow.component.grid.Grid.Column<E>

    • isSortable

      public boolean isSortable()
      Overrides:
      isSortable in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setFooter

      public com.vaadin.flow.component.grid.Grid.Column<E> setFooter(String labelText)
      Overrides:
      setFooter in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setFooter

      public com.vaadin.flow.component.grid.Grid.Column<E> setFooter(com.vaadin.flow.component.Component footerComponent)
      Overrides:
      setFooter in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setEditorComponent

      public com.vaadin.flow.component.grid.Grid.Column<E> setEditorComponent(com.vaadin.flow.component.Component editorComponent)
      Overrides:
      setEditorComponent in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setEditorComponent

      public com.vaadin.flow.component.grid.Grid.Column<E> setEditorComponent(com.vaadin.flow.function.SerializableFunction<E,? extends com.vaadin.flow.component.Component> componentCallback)
      Overrides:
      setEditorComponent in class com.vaadin.flow.component.grid.Grid.Column<E>

    • getEditorComponent

      public com.vaadin.flow.component.Component getEditorComponent()
      Overrides:
      getEditorComponent in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setPartNameGenerator

      public com.vaadin.flow.component.grid.Grid.Column<E> setPartNameGenerator(com.vaadin.flow.function.SerializableFunction<E,String> partNameGenerator)
      Overrides:
      setPartNameGenerator in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setTooltipGenerator

      public com.vaadin.flow.component.grid.Grid.Column<E> setTooltipGenerator(com.vaadin.flow.function.SerializableFunction<E,String> tooltipGenerator)
      Overrides:
      setTooltipGenerator in class com.vaadin.flow.component.grid.Grid.Column<E>

    • getClassNameGenerator

      public com.vaadin.flow.function.SerializableFunction<E,String> getClassNameGenerator()
      Overrides:
      getClassNameGenerator in class com.vaadin.flow.component.grid.Grid.Column<E>

    • getPartNameGenerator

      public com.vaadin.flow.function.SerializableFunction<E,String> getPartNameGenerator()
      Overrides:
      getPartNameGenerator in class com.vaadin.flow.component.grid.Grid.Column<E>

    • getTooltipGenerator

      public com.vaadin.flow.function.SerializableFunction<E,String> getTooltipGenerator()
      Overrides:
      getTooltipGenerator in class com.vaadin.flow.component.grid.Grid.Column<E>

    • isRowHeader

      public boolean isRowHeader()
      Overrides:
      isRowHeader in class com.vaadin.flow.component.grid.Grid.Column<E>

    • setRowHeader

      public com.vaadin.flow.component.grid.Grid.Column<E> setRowHeader(boolean rowHeader)
      Overrides:
      setRowHeader in class com.vaadin.flow.component.grid.Grid.Column<E>

    • getHeaderText

      public String getHeaderText()

    • getFooterText

      public String getFooterText()

    • getHeaderComponent

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

    • getFooterComponent

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

    • getChildren

      public Stream<com.vaadin.flow.component.Component> getChildren()
      Overrides:
      getChildren in class com.vaadin.flow.component.Component

    • getUI

      public Optional<com.vaadin.flow.component.UI> getUI()
      Overrides:
      getUI in class com.vaadin.flow.component.Component

    • setId

      public void setId(String id)
      Overrides:
      setId in class com.vaadin.flow.component.Component

    • getId

      public Optional<String> getId()
      Overrides:
      getId in class com.vaadin.flow.component.Component

    • isAttached

      public boolean isAttached()
      Overrides:
      isAttached in class com.vaadin.flow.component.Component

    • isVisible

      public boolean isVisible()
      Overrides:
      isVisible in class com.vaadin.flow.component.Component

    • addClassName

      public void addClassName(String className)

    • removeClassName

      public boolean removeClassName(String className)

    • setClassName

      public void setClassName(String className)

    • getClassName

      public String getClassName()

    • getClassNames

      public com.vaadin.flow.dom.ClassList getClassNames()

    • setClassName

      public void setClassName(String className, boolean set)

    • hasClassName

      public boolean hasClassName(String className)

    • getStyle

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

    • addClassNames

      public void addClassNames(String... classNames)

    • removeClassNames

      public void removeClassNames(String... classNames)

    • setResizable

      public com.vaadin.flow.component.grid.Grid.Column<E> setResizable(boolean resizable)

    • isResizable

      public boolean isResizable()

    • setFrozen

      public com.vaadin.flow.component.grid.Grid.Column<E> setFrozen(boolean frozen)

    • isFrozen

      public boolean isFrozen()

    • setFrozenToEnd

      public com.vaadin.flow.component.grid.Grid.Column<E> setFrozenToEnd(boolean frozenToEnd)

    • isFrozenToEnd

      public boolean isFrozenToEnd()

    • setTextAlign

      public com.vaadin.flow.component.grid.Grid.Column<E> setTextAlign(com.vaadin.flow.component.grid.ColumnTextAlign textAlign)

    • getTextAlign

      public com.vaadin.flow.component.grid.ColumnTextAlign getTextAlign()

    • setHeaderPartName

      public com.vaadin.flow.component.grid.Grid.Column<E> setHeaderPartName(String headerPartName)

    • getHeaderPartName

      public String getHeaderPartName()

    • setFooterPartName

      public com.vaadin.flow.component.grid.Grid.Column<E> setFooterPartName(String footerPartName)

    • getFooterPartName

      public String getFooterPartName()

    • getTranslation

      public String getTranslation(String key, Object... params)
      Overrides:
      getTranslation in class com.vaadin.flow.component.Component

    • getTranslation

      public String getTranslation(Object key, Object... params)
      Overrides:
      getTranslation in class com.vaadin.flow.component.Component

    • getTranslation

      public String getTranslation(Locale locale, String key, Object... params)
      Overrides:
      getTranslation in class com.vaadin.flow.component.Component

    • getTranslation

      public String getTranslation(Locale locale, Object key, Object... params)
      Overrides:
      getTranslation in class com.vaadin.flow.component.Component

    • scrollIntoView

      public void scrollIntoView()
      Overrides:
      scrollIntoView in class com.vaadin.flow.component.Component

    • scrollIntoView

      public void scrollIntoView(com.vaadin.flow.component.ScrollOptions scrollOptions)
      Overrides:
      scrollIntoView in class com.vaadin.flow.component.Component

    • findAncestor

      public <T> T findAncestor(Class<T> componentType)
      Overrides:
      findAncestor in class com.vaadin.flow.component.Component

    • removeFromParent

      public void removeFromParent()
      Overrides:
      removeFromParent in class com.vaadin.flow.component.Component

    • addAttachListener

      public com.vaadin.flow.shared.Registration addAttachListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.AttachEvent> listener)

    • addDetachListener

      public com.vaadin.flow.shared.Registration addDetachListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.DetachEvent> listener)

    • getGrid

      public com.vaadin.flow.component.grid.Grid<?> getGrid()
      Should return a grid of adapter. To get group grid of adaptee, use getAdapteeGrid() instead.
      Returns:
      flow grid instance

    • getAdapteeGrid

      public Grid<?> getAdapteeGrid()
      Returns:
      group grid instance

    • getParent

      public Optional<com.vaadin.flow.component.Component> getParent()
      Should return a parent of adapter. To get parent of adaptee, use getAdapteeParent() instead.
      Overrides:
      getParent in class com.vaadin.flow.component.Component
      Returns:
      flow parent instance

    • getAdapteeParent

      public Optional<com.vaadin.flow.component.Component> getAdapteeParent()
      Returns:
      parent of adaptee

    • getElement

      public com.vaadin.flow.dom.Element getElement()
      Should return an element of adapter to avoid broken grid. To get an element of adaptee, use getAdapteeElement() instead.
      Specified by:
      getElement in interface com.vaadin.flow.component.HasElement
      Overrides:
      getElement in class com.vaadin.flow.component.grid.Grid.Column<E>
      Returns:
      column element

    • getAdapteeElement

      public com.vaadin.flow.dom.Element getAdapteeElement()
      Returns:
      element of adaptee

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • onColumnVisibilityChanged

      protected void onColumnVisibilityChanged(GroupDataGridColumnVisibilityChangedEvent<E> event, com.vaadin.flow.component.ComponentEventListener<DataGridColumnVisibilityChangedEvent<E>> listener)

    • setHeaderText

      protected void setHeaderText(String arg0)

    • setFooterText

      protected void setFooterText(String arg0)

    • setHeaderComponent

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

    • 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()