Contact us
Create app
com.vaadin.client.widgets.

Class Grid.AbstractGridKeyEvent<HANDLER extends AbstractGridKeyEventHandler>

  • java.lang.Object
    • com.google.web.bindery.event.shared.Event<H>
      • com.google.gwt.event.shared.GwtEvent<H>
        • com.google.gwt.event.dom.client.DomEvent<H>
          • com.google.gwt.event.dom.client.KeyEvent<HANDLER>
            • com.vaadin.client.widgets.Grid.AbstractGridKeyEvent<HANDLER>

  • Type Parameters:

    HANDLER - the event handler type

    All Implemented Interfaces:

    com.google.gwt.event.dom.client.HasNativeEvent

    Direct Known Subclasses:

    GridKeyDownEvent, GridKeyPressEvent, GridKeyUpEvent

    Enclosing class:

    Grid<T>

    public abstract static class Grid.AbstractGridKeyEvent<HANDLER extends AbstractGridKeyEventHandler>
extends com.google.gwt.event.dom.client.KeyEvent<HANDLER>

    Event class for key events that happen within the grid.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.google.gwt.event.dom.client.DomEvent

        com.google.gwt.event.dom.client.DomEvent.Type<H extends com.google.gwt.event.shared.EventHandler>

    • Method Summary

      All Methods
      Modifier and Type Method Description
      protected void dispatch​(HANDLER handler)  
      protected abstract void doDispatch​(HANDLER handler, GridConstants.Section section)

      The given handler processes the event if the handler type matches the given section.
      protected abstract String getBrowserEventType()

      Returns the BrowserEvents type that corresponds with this event.
      CellReference<?> getFocusedCell()

      Gets the reference of target cell for this event, if this event originated from a Grid.
      Grid<?> getGrid()

      Gets the Grid instance for this event, if it originated from a Grid.

      • Methods inherited from class com.google.gwt.event.dom.client.KeyEvent

        isAltKeyDown, isAnyModifierKeyDown, isControlKeyDown, isMetaKeyDown, isShiftKeyDown

      • Methods inherited from class com.google.gwt.event.dom.client.DomEvent

        fireNativeEvent, fireNativeEvent, getAssociatedType, getNativeEvent, getRelativeElement, preventDefault, setNativeEvent, setRelativeElement, stopPropagation

      • Methods inherited from class com.google.gwt.event.shared.GwtEvent

        assertLive, getSource, isLive, kill, revive

      • Methods inherited from class com.google.web.bindery.event.shared.Event

        setSource, toDebugString, toString

    • Constructor Detail

      • AbstractGridKeyEvent

        public AbstractGridKeyEvent()

        Since:

        7.7.9

      • AbstractGridKeyEvent

        @Deprecated
public AbstractGridKeyEvent​(Grid<?> grid,
                            CellReference<?> targetCell)
        Deprecated.
        This constructor's arguments are no longer used. Use the no-args constructor instead.

        Parameters:

        grid - the grid where the event occurred

        targetCell - the cell that the event targeted

    • Method Detail

      • getBrowserEventType

        protected abstract String getBrowserEventType()

        Returns the BrowserEvents type that corresponds with this event.

        Returns:

        the browser event type

      • getGrid

        public Grid<?> getGrid()

        Gets the Grid instance for this event, if it originated from a Grid.

        Returns:

        the grid this event originated from, or null if this event did not originate from a grid

      • getFocusedCell

        public CellReference<?> getFocusedCell()

        Gets the reference of target cell for this event, if this event originated from a Grid.

        Returns:

        target cell, or null if this event did not originate from a grid

      • doDispatch

        protected abstract void doDispatch​(HANDLER handler,
                                   GridConstants.Section section)

        The given handler processes the event if the handler type matches the given section.

        Parameters:

        handler - handler

        section - the section where the target element is located