Package com.jbstrap.core.event

Class BaseEvent

java.lang.Object
com.jbstrap.core.event.BaseEvent
Direct Known Subclasses:
BaseJBStrapEvent, BrowserEvent, ChartClickEvent, ChartLassoEvent, ClientConnectedEvent, DebugEvent, DoneEvent, ErrorEvent, FormChangedEvent, FormItemChangeEvent, HotKeyEvent, JavaScriptExceptionEvent, JBSChartLassoEvent, PageResizeEvent, ReturnEvent
public abstract class BaseEvent extends Object

Base event class

This class contains data, that every event handler provided by the framework receives. These data are:

  • The client on which the event occurred
  • The ID of the component, on which the event occurred
  • The event type
  • The instance of the component, on which the event occurred
  • The event ID

Since:
4.0
Author:
JBStrap

  • Field Details

    • client

      protected Client client

    • senderId

      protected String senderId

    • eventType

      protected EventType eventType

  • Constructor Details

    • BaseEvent

      public BaseEvent()

  • Method Details

    • getClient

      public final Client getClient()
      Gets the client, on which the event occurred
      Returns:
      The client

    • getEventId

      public String getEventId()
      Gets the event ID
      Returns:
      The event ID

    • getSenderId

      public String getSenderId()
      Gets the ID of the component, on which the event occurred
      Returns:
      The component ID

    • getEventType

      public EventType getEventType()
      Gets the event type.
      Returns:
      The event type. For every type, see the EventType enum

    • getComponent

      public final Component<?> getComponent()
      Gets the component on which the event occurred
      Returns:
      The component or null, if the component was not found on the current UI

    • fireEvent

      public abstract void fireEvent()