Package com.vaadin.flow.component.grid

Class GridSelectionColumn

  • All Implemented Interfaces:
    com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, Serializable
    @Tag("vaadin-grid-flow-selection-column")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",
            version="23.6.2")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("./vaadin-grid-flow-selection-column.js")
public class GridSelectionColumn
extends com.vaadin.flow.component.Component
    Server side implementation for the flow specific grid selection column.
    Author:
    Vaadin Ltd.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      GridSelectionColumn​(com.vaadin.flow.function.SerializableRunnable selectAllCallback, com.vaadin.flow.function.SerializableRunnable deselectAllCallback)
      Constructs a new grid selection column configured to use the given callbacks whenever the select all checkbox is toggled on the client side.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isDragSelect()
      Gets whether grid drag select is enabled or not.
      boolean isFrozen()
      Gets the this column's frozen state.
      void setDragSelect​(boolean dragSelect)
      If true, grid rows can be selected or deselected by dragging the mouse cursor over grid's selection column.
      void setFrozen​(boolean frozen)
      Sets this column's frozen state.
      void setSelectAllCheckboxIndeterminateState​(boolean indeterminate)
      Sets the indeterminate state of the select all checkbox on the client.
      void setSelectAllCheckboxState​(boolean selectAll)
      Sets the checked state of the select all checkbox on the client.
      void setSelectAllCheckBoxVisibility​(boolean visible)
      Sets the visibility of the select all checkbox on the client.

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

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

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

        addAttachListener

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

        addDetachListener

    • Constructor Detail

      • GridSelectionColumn

        public GridSelectionColumn​(com.vaadin.flow.function.SerializableRunnable selectAllCallback,
                           com.vaadin.flow.function.SerializableRunnable deselectAllCallback)
        Constructs a new grid selection column configured to use the given callbacks whenever the select all checkbox is toggled on the client side.
        Parameters:
        selectAllCallback - the runnable to run when the select all checkbox has been checked
        deselectAllCallback - the runnable to run when the select all checkbox has been unchecked

    • Method Detail

      • setSelectAllCheckboxState

        public void setSelectAllCheckboxState​(boolean selectAll)
        Sets the checked state of the select all checkbox on the client.
        Parameters:
        selectAll - the new state of the select all checkbox

      • setSelectAllCheckboxIndeterminateState

        public void setSelectAllCheckboxIndeterminateState​(boolean indeterminate)
        Sets the indeterminate state of the select all checkbox on the client.
        Parameters:
        indeterminate - the new indeterminate state of the select all checkbox

      • setSelectAllCheckBoxVisibility

        public void setSelectAllCheckBoxVisibility​(boolean visible)
        Sets the visibility of the select all checkbox on the client.
        Parameters:
        visible - whether to display the select all checkbox or hide it

      • setFrozen

        public void setFrozen​(boolean frozen)
        Sets this column's frozen state.
        Parameters:
        frozen - whether to freeze or unfreeze this column

      • isFrozen

        @Synchronize("frozen-changed")
public boolean isFrozen()
        Gets the this column's frozen state.
        Returns:
        whether this column is frozen

      • setDragSelect

        public void setDragSelect​(boolean dragSelect)
        If true, grid rows can be selected or deselected by dragging the mouse cursor over grid's selection column.
        Parameters:
        dragSelect - true to enable drag select feature, false for disabling it

      • isDragSelect

        @Synchronize("drag-select-changed")
public boolean isDragSelect()
        Gets whether grid drag select is enabled or not.
        Returns:
        true if drag select feature is enabled, false otherwise