Package com.vaadin.flow.component.gridpro

Class 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, Serializable
    Enclosing class:
    GridPro<E>
    @Tag("vaadin-grid-pro-edit-column")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",
            version="23.6.3")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js")
public static class GridPro.EditColumn<T>
extends 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:
    Serialized Form

    • Field Detail

      • grid

        protected final Grid<?> grid

      • headerTemplate

        protected com.vaadin.flow.dom.Element headerTemplate

      • footerTemplate

        protected com.vaadin.flow.dom.Element footerTemplate

    • Constructor Detail

      • 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 Detail

      • 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:
        EditorType

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

      • getGrid

        public Grid<?> getGrid()

      • setVisible

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

      • setHeaderRenderer

        @Deprecated
protected void setHeaderRenderer​(com.vaadin.flow.data.renderer.Renderer<?> arg0)
        Deprecated.

      • setFooterRenderer

        @Deprecated
protected void setFooterRenderer​(com.vaadin.flow.data.renderer.Renderer<?> arg0)
        Deprecated.

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

      • getHeaderRenderer

        @Deprecated
protected com.vaadin.flow.data.renderer.Renderer<?> getHeaderRenderer()
        Deprecated.

      • getFooterRenderer

        @Deprecated
protected com.vaadin.flow.data.renderer.Renderer<?> getFooterRenderer()
        Deprecated.

      • updateSortingIndicators

        protected void updateSortingIndicators​(boolean arg0)

      • setSortingIndicators

        protected void setSortingIndicators​(boolean arg0)

      • hasSortingIndicators

        protected boolean hasSortingIndicators()

      • addGridSorter

        protected String addGridSorter​(String arg0)

      • getBottomChildColumns

        protected List<Grid.Column<?>> getBottomChildColumns()

      • setResizable

        public default T setResizable​(boolean arg0)

      • isResizable

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

      • setFrozen

        public default T setFrozen​(boolean arg0)

      • isFrozen

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

      • setFrozenToEnd

        public default T setFrozenToEnd​(boolean arg0)

      • isFrozenToEnd

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

      • getTextAlign

        @Synchronize("text-align-changed")
public default ColumnTextAlign getTextAlign()