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

Class Grid.AbstractGridMouseEvent<HANDLER extends AbstractGridMouseEventHandler>

  • 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.HumanInputEvent<H>
            • com.google.gwt.event.dom.client.MouseEvent<HANDLER>
              • com.vaadin.client.widgets.Grid.AbstractGridMouseEvent<HANDLER>

  • Type Parameters:

    HANDLER - the event handler type

    All Implemented Interfaces:

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

    Direct Known Subclasses:

    GridClickEvent, GridDoubleClickEvent

    Enclosing class:

    Grid<T>

    public abstract static class Grid.AbstractGridMouseEvent<HANDLER extends AbstractGridMouseEventHandler>
extends com.google.gwt.event.dom.client.MouseEvent<HANDLER>

    Event class for mouse 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.
      Grid<?> getGrid()

      Gets the Grid instance for this event, if it originated from a Grid.
      CellReference<?> getTargetCell()

      Gets the reference of target cell for this event, if this event originated from a Grid.
      protected boolean ignoreEventFromTarget​(Grid<?> grid, com.google.gwt.dom.client.Element targetElement)

      Returns whether the mouse event on the target element should be ignored.

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

        getClientX, getClientY, getNativeButton, getRelativeX, getRelativeY, getScreenX, getScreenY, getX, getY

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

        isAltKeyDown, 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

      • AbstractGridMouseEvent

        public AbstractGridMouseEvent()

        Since:

        7.7.9

      • AbstractGridMouseEvent

        @Deprecated
public AbstractGridMouseEvent​(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

      • getTargetCell

        public CellReference<?> getTargetCell()

        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

      • ignoreEventFromTarget

        protected boolean ignoreEventFromTarget​(Grid<?> grid,
                                        com.google.gwt.dom.client.Element targetElement)

        Returns whether the mouse event on the target element should be ignored.

        Parameters:

        grid - the Grid instance from which the event originated

        targetElement - the element from which the event originated

        Returns:

        true if the event should be ignored, false if it should be handled

        Since:

        8.2

      • 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