Package com.vaadin.flow.component.gridpro

Class GridPro.EditColumn<T>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.grid.Grid.Column<T>
com.vaadin.flow.component.gridpro.GridPro.EditColumn<T>
Type Parameters:
T - type of the underlying grid this column is compatible with
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:
GridPro<E>
@Tag("vaadin-grid-pro-edit-column") public static class GridPro.EditColumn<T> extends com.vaadin.flow.component.grid.Grid.Column<T>
Server-side component for the <vaadin-grid-edit-column> element.

Every added column sends data to the client side regardless of its visibility state. Don't add a new column at all or use Grid.removeColumn(Column) to avoid sending extra data.

See Also:

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    EditColumn(GridPro<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()
     
    protected com.vaadin.flow.component.HasValueAndElement
    getEditorField()
     
    protected String
    getEditorType()
    Gets the type of the editor that is used for modifying cell value.
    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()
     
    protected String
    getInternalId()
     
    protected ItemUpdater<T,String>
    getItemUpdater()
    Gets the itemUpdater function that will be called on item changed.
    protected List<String>
    getOptions()
    Gets the list of options that is used for select type of the editor.
    default com.vaadin.flow.component.grid.ColumnTextAlign
    getTextAlign()
     
    com.vaadin.flow.function.ValueProvider<T,?>
    getValueProvider()
     
    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)
     
    protected void
    setEditorField(com.vaadin.flow.component.HasValueAndElement editorField)
     
    protected GridPro.EditColumn<T>
    setEditorType(EditorType type)
    Sets the type of the editor that is used for modifying cell value.
    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)
     
    protected GridPro.EditColumn<T>
    setItemUpdater(ItemUpdater<T,String> itemUpdater)
    Sets the itemUpdater function that will be called on item changed.
    protected GridPro.EditColumn<T>
    setOptions(List<String> options)
    Sets the list of options that is used for select type of the editor.
    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
    setValueProvider(com.vaadin.flow.function.ValueProvider<T,?> valueProvider)
     
    void
    setVisible(boolean arg0)
     
    protected void
    updateSortingIndicators(boolean arg0)
     

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

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

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

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

    Methods inherited from class java.lang.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, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

  • Field Details

    • grid

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

  • Constructor Details

    • EditColumn

      public EditColumn(GridPro<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

    • setItemUpdater

      protected GridPro.EditColumn<T> setItemUpdater(ItemUpdater<T,String> itemUpdater)
      Sets the itemUpdater function that will be called on item changed.
      Parameters:
      itemUpdater - the callback function that is called when item is changed. It receives two arguments: item and newValue.
      Returns:
      this column instance

    • getItemUpdater

      protected ItemUpdater<T,String> getItemUpdater()
      Gets the itemUpdater function that will be called on item changed.
      Returns:
      the instance of itemUpdater for this column

    • getEditorField

      protected com.vaadin.flow.component.HasValueAndElement getEditorField()

    • setEditorField

      protected void setEditorField(com.vaadin.flow.component.HasValueAndElement editorField)

    • setEditorType

      protected GridPro.EditColumn<T> setEditorType(EditorType type)
      Sets the type of the editor that is used for modifying cell value.
      Parameters:
      type - the type of the editor
      Returns:
      this column instance
      See Also:

    • getEditorType

      @Synchronize("editor-type-changed") protected String getEditorType()
      Gets the type of the editor that is used for modifying cell value.
      Returns:
      the editor type

    • setOptions

      protected GridPro.EditColumn<T> setOptions(List<String> options)
      Sets the list of options that is used for select type of the editor.
      Parameters:
      options - the list of options
      Returns:
      this column instance

    • getOptions

      @Synchronize("editor-options-changed") protected List<String> getOptions()
      Gets the list of options that is used for select type of the editor.
      Returns:
      the list of options

    • getValueProvider

      public com.vaadin.flow.function.ValueProvider<T,?> getValueProvider()

    • setValueProvider

      public void setValueProvider(com.vaadin.flow.function.ValueProvider<T,?> valueProvider)

    • getInternalId

      protected String getInternalId()
      Overrides:
      getInternalId in class com.vaadin.flow.component.grid.Grid.Column<T>

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