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

Class AbstractClickEventHandler

  • All Implemented Interfaces:

    com.google.gwt.event.dom.client.ContextMenuHandler, com.google.gwt.event.dom.client.DoubleClickHandler, com.google.gwt.event.dom.client.MouseDownHandler, com.google.gwt.event.dom.client.MouseUpHandler, com.google.gwt.event.shared.EventHandler

    Direct Known Subclasses:

    ClickEventHandler, LayoutClickEventHandler

    public abstract class AbstractClickEventHandler
extends Object
implements com.google.gwt.event.dom.client.MouseDownHandler, com.google.gwt.event.dom.client.MouseUpHandler, com.google.gwt.event.dom.client.DoubleClickHandler, com.google.gwt.event.dom.client.ContextMenuHandler

    • Method Summary

      All Methods
      Modifier and Type Method Description
      protected abstract void fireClick​(com.google.gwt.dom.client.NativeEvent event)

      Sends the click event based on the given native event.
      protected com.google.gwt.user.client.Element getRelativeToElement()

      Click event calculates and returns coordinates relative to the element returned by this method.
      void handleEventHandlerRegistration()  
      boolean hasEventListener()

      Checks if there is a server side event listener registered for clicks.
      void onContextMenu​(com.google.gwt.event.dom.client.ContextMenuEvent event)

      Event handler for context menu.
      void onDoubleClick​(com.google.gwt.event.dom.client.DoubleClickEvent event)

      Event handler for double clicks.
      void onMouseDown​(com.google.gwt.event.dom.client.MouseDownEvent event)  
      void onMouseUp​(com.google.gwt.event.dom.client.MouseUpEvent event)  
      protected <H extends com.google.gwt.event.shared.EventHandler>
      com.google.gwt.event.shared.HandlerRegistration      		 registerHandler​(H handler, com.google.gwt.event.dom.client.DomEvent.Type<H> type)

      Registers the given handler to the widget so that the necessary events are passed to this ClickEventHandler.
      protected boolean shouldFireEvent​(com.google.gwt.event.dom.client.DomEvent<?> event)

      Called before firing a click event.

    • Constructor Detail

      • AbstractClickEventHandler

        public AbstractClickEventHandler​(ComponentConnector connector,
                                 String clickEventIdentifier)

    • Method Detail

      • handleEventHandlerRegistration

        public void handleEventHandlerRegistration()

      • registerHandler

        protected <H extends com.google.gwt.event.shared.EventHandler> com.google.gwt.event.shared.HandlerRegistration registerHandler​(H handler,
                                                                                                                               com.google.gwt.event.dom.client.DomEvent.Type<H> type)

        Registers the given handler to the widget so that the necessary events are passed to this ClickEventHandler.

        By default registers the handler with the connector root widget.

        Type Parameters:

        H -

        Parameters:

        handler - The handler to register

        type - The type of the handler.

        Returns:

        A reference for the registration of the handler.

      • hasEventListener

        public boolean hasEventListener()

        Checks if there is a server side event listener registered for clicks.

        Returns:

        true if there is a server side event listener registered, false otherwise

      • onContextMenu

        public void onContextMenu​(com.google.gwt.event.dom.client.ContextMenuEvent event)

        Event handler for context menu. Prevents the browser context menu from popping up if there is a listener for right clicks.

        Specified by:

        onContextMenu in interface com.google.gwt.event.dom.client.ContextMenuHandler

      • onMouseDown

        public void onMouseDown​(com.google.gwt.event.dom.client.MouseDownEvent event)

        Specified by:

        onMouseDown in interface com.google.gwt.event.dom.client.MouseDownHandler

      • onMouseUp

        public void onMouseUp​(com.google.gwt.event.dom.client.MouseUpEvent event)

        Specified by:

        onMouseUp in interface com.google.gwt.event.dom.client.MouseUpHandler

      • fireClick

        protected abstract void fireClick​(com.google.gwt.dom.client.NativeEvent event)

        Sends the click event based on the given native event.

        Parameters:

        event - The native event that caused this click event

      • shouldFireEvent

        protected boolean shouldFireEvent​(com.google.gwt.event.dom.client.DomEvent<?> event)

        Called before firing a click event. Allows sub classes to decide if this in an event that should cause an event or not.

        Parameters:

        event - The user event

        Returns:

        true if the event should be fired, false otherwise

      • onDoubleClick

        public void onDoubleClick​(com.google.gwt.event.dom.client.DoubleClickEvent event)

        Event handler for double clicks. Used to fire double click events. Note that browsers typically fail to prevent the second click event so a double click will result in two click events and one double click event.

        Specified by:

        onDoubleClick in interface com.google.gwt.event.dom.client.DoubleClickHandler

      • getRelativeToElement

        protected com.google.gwt.user.client.Element getRelativeToElement()

        Click event calculates and returns coordinates relative to the element returned by this method. Default implementation uses the root element of the widget. Override to provide a different relative element.

        Returns:

        The Element used for calculating relative coordinates for a click or null if no relative coordinates can be calculated.