Package com.vaadin.client.widget.grid.selection

Class MultiSelectionRenderer<T>

  • Type Parameters:
    T - the type of the items in the associated Grid
    All Implemented Interfaces:
    com.google.gwt.event.dom.client.ClickHandler, com.google.gwt.event.shared.EventHandler, Renderer<Boolean>
    public class MultiSelectionRenderer<T>
extends ClickableRenderer<Boolean,​com.google.gwt.user.client.ui.CheckBox>
    Renderer showing multi selection check boxes.
    Since:
    7.4
    Author:
    Vaadin Ltd

    • Constructor Detail

      • MultiSelectionRenderer

        public MultiSelectionRenderer​(Grid<T> grid)
        Constructs a renderer for a selection column with multi-selection CheckBoxes.
        Parameters:
        grid - the parent grid

    • Method Detail

      • createWidget

        public com.google.gwt.user.client.ui.CheckBox createWidget()
        Description copied from class: ClickableRenderer
        Creates a widget to attach to a cell. The widgets will be attached to the cell after the cell element has been attached to DOM.

        Implementation note: It is the implementing method's responsibility to add this as a click handler of the returned widget, or a widget nested therein, in order to make click events propagate properly to handlers registered via addClickHandler.

        Specified by:
        createWidget in class ClickableRenderer<Boolean,​com.google.gwt.user.client.ui.CheckBox>
        Returns:
        widget to attach to a cell. All returned instances should be new widget instances without a parent.

      • render

        public void render​(RendererCellReference cell,
                   Boolean data,
                   com.google.gwt.user.client.ui.CheckBox checkBox)
        Description copied from class: WidgetRenderer
        Renders a cell with a widget. This provides a way to update any information in the widget that is cell specific. Do not detach the Widget here, it will be done automatically by the Grid when the widget is no longer needed.

        For optimal performance, work done in this method should be kept to a minimum since it will be called continuously while the user is scrolling. The renderer can use Widget.setLayoutData(Object) to store cell data that might be needed in e.g. event listeners.

        Specified by:
        render in class WidgetRenderer<Boolean,​com.google.gwt.user.client.ui.CheckBox>
        Parameters:
        cell - The cell to render. Note that the cell is a flyweight and should not be stored and used outside of this method as its contents will change.
        data - the data of the cell
        checkBox - the widget embedded in the cell

      • getConsumedEvents

        public Collection<String> getConsumedEvents()
        Description copied from class: ComplexRenderer
        Returns the events that the renderer should consume. These are also the events that the Grid will pass to #onBrowserEvent(Cell, NativeEvent) when they occur.
        Overrides:
        getConsumedEvents in class ComplexRenderer<Boolean>
        Returns:
        a list of consumed events
        See Also:
        BrowserEvents

      • onBrowserEvent

        public boolean onBrowserEvent​(CellReference<?> cell,
                              com.google.gwt.dom.client.NativeEvent event)
        Description copied from class: ComplexRenderer
        Called whenever a registered event is triggered in the column the renderer renders.

        The events that triggers this needs to be returned by the ComplexRenderer.getConsumedEvents() method.

        Returns boolean telling if the event has been completely handled and should not cause any other actions.

        Overrides:
        onBrowserEvent in class ComplexRenderer<Boolean>
        Parameters:
        cell - Object containing information about the cell the event was triggered on.
        event - The original DOM event
        Returns:
        true if event should not be handled by grid

      • isSelected

        protected boolean isSelected​(int logicalRow)
        Checks whether the given row is selected.
        Parameters:
        logicalRow - logical index of the row to check
        Returns:
        true if the current selection model considers the row selected, false otherwise

      • setSelected

        protected void setSelected​(int logicalRow,
                           boolean select)
        Updates selection status for the given row.
        Parameters:
        logicalRow - logical index of the row to update
        select - true if the row should be marked selected, false otherwise