Package com.jbstrap.core.event

Enum Class EventType

java.lang.Object

java.lang.Enum<EventType>

com.jbstrap.core.event.EventType

All Implemented Interfaces:

Serializable, Comparable<EventType>, Constable

public enum EventType
extends Enum<EventType>

The class containing the event types supported by the JBStrap framework and the custom events.

Since:

4.0

Author:

JBStrap

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANIMATION_END	Animation end event
ANIMATION_START	Animation start event
CALENDAR_CHANGE_VIEW_EVENT	Calendar component view change event
CALENDAR_CLICK	Calendar component click event
CALENDAR_DOUBLE_CLICK	Calendar component double-click event
CALENDAR_INIT_DONE
CALENDAR_SCHEDULE_CLICK	Calendar schedule click event
CALENDAR_SCHEDULE_MOVE	Calendar schedule move event
CHART_CLICK	Chart click event
CHART_LASSO	Chart lasso event
CLICK	Click event
CLIENT_CONNECTED	Client connected event
COPY	Copy event
CUSTOM
CUT	Cut event
DEBUG_MESSAGE
DONE	Done event
DOUBLE_CLICK	Double-click event
DRAG_END	Dragging end event
DRAG_SORT
DRAG_START	Dragging start event
DROP_EVENT	Component drop event
ENTER_PRESSED	Enter button pressed event
ERROR	Error event
FETCH_DONE	Fetch done event
FILE_ITEM_DONE
FILE_ITEM_ERROR
FILE_ITEM_UPLOAD_START
FILTERBAR_CHANGE_EDITOR	Filter bar change filter editor event
FILTERBAR_FILTERING	Filter bar filtering event
FOCUS	Focus event
FOCUS_IN	Focus in event
FOCUS_OUT	Focus out event
FORM_CHANGED	Form change event
FORM_ITEM_VALUE_CHANGE	Input field value change event
HOT_KEY	Hot key pressed event
INPUT	Input event
JAVASCRIPT_ERROR	JavaScript error event
KEY_DOWN	Key down event
KEY_PRESS	Keyboard key press event
KEY_UP	Key up event
LIST_GIRD_REFRESH_DATA	ListGrid refresh data event
LIST_GRID_COLUMN_MOVE	ListGrid column move event
LIST_GRID_COLUMN_RESIZE	ListGrid column resize event
LIST_GRID_COLUMN_SHOW	ListGrid column show or hide event
LIST_GRID_HEADER_CLICK	List grid header click event
LIST_GRID_HEADER_DOUBLE_CLICK	List grid header double-click event
LIST_GRID_NEXT_PAGE	ListGrid next page request event
LIST_GRID_RESIZE	ListGrid resize event
LIST_GRID_ROW_CLICK	ListGrid row click event
LIST_GRID_ROW_DOUBLE_CLICK	ListGrid row double-click event
LIST_GRID_SORT	ListGrid sort data event
LOSES_FOCUS	Focus loss event
MOUSE_DOWN	Mouse button down event
MOUSE_ENTER	The mouse enter event
MOUSE_LEAVE	The mouse leave event
MOUSE_MOVE	The mouse move event
MOUSE_OUT	Mouse out event
MOUSE_OVER	The mouse over event
MOUSE_UP	Mouse up event
NAVIGATION_EVENT
PAGE_RESIZE	Page resize event
PASTE	Paste event
RETURN_EVENT
SCROLL	Scroll event
TOUCH_CANCEL	Touch cancel event
TOUCH_END	Touch end event
TOUCH_MOVE	Touch move event
TOUCH_START	Touch start event
VALUE_CLEAR
WHEEL	Mousewheel event

Method Summary

Modifier and Type	Method	Description
static void	addCustomEvent(String eventName, Class<? extends BaseEvent> eventClass, Class<? extends BrowserEventHandler> eventHandlerInterface)	Registers a custom event among the event types
static EventType	fromEventType(com.google.gson.JsonElement receivedEventType, com.google.gson.JsonElement receivedBrowserEventName)	Determines the event type, based on the specified JSON elements.
String	getBrowserEventName()
String	getCoreHandlerMethodName()
BaseEvent	getEvent()
BaseEvent	getEvent(String customEventName)
Class<? extends BrowserEventHandler>	getHandlerInterface()	Gets the event handler interface class
String	getHandlerMethodName()	Gets the name of the event handler method
boolean	isClientEvent()
static EventType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EventType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ANIMATION_END

public static final EventType ANIMATION_END

Animation end event

The event is triggered when the animation ends on a component

See Also:

• AnimationEvent
• AnimationEndEventHandler

ANIMATION_START

public static final EventType ANIMATION_START

Animation start event

The event is triggered when the animation starts on a component

See Also:

• AnimationEvent
• AnimationStartEventHandler

LOSES_FOCUS

public static final EventType LOSES_FOCUS

Focus loss event

The event is triggered when a component loses focus

See Also:

• BrowserEvent
• LosesFoucusEventHandler

FOCUS

public static final EventType FOCUS

Focus event

The event is triggered when a component gains focus

See Also:

• BrowserEvent
• FocusEventHandler

FOCUS_IN

public static final EventType FOCUS_IN

Focus in event

The event is triggered when a component is about to gain focus

See Also:

• BrowserEvent
• FocusInEventHandler

FOCUS_OUT

public static final EventType FOCUS_OUT

Focus out event

The event is triggered when a component is about to lose focus

See Also:

• BrowserEvent
• FocusOutEventHandler

COPY

public static final EventType COPY

Copy event

The event is triggered when the user copies data from a component.

See Also:

• BrowserEvent
• CopyEventHandler

CUT

public static final EventType CUT

Cut event

The event is triggered when the user cuts data from a component.

See Also:

• BrowserEvent
• CutEventHandler

PASTE

public static final EventType PASTE

Paste event

The event is triggered when the user pastes data to a component.

See Also:

• BrowserEvent
• PasteEventHandler

INPUT

public static final EventType INPUT

Input event

The event is triggered when the user is inputting data into an input field.

See Also:

• BrowserEvent
• InputEventHandler

CLICK

public static final EventType CLICK

Click event

The event is triggered when the user clicks on a component.

See Also:

• MouseEvent
• ClickEventHandler

DOUBLE_CLICK

public static final EventType DOUBLE_CLICK

Double-click event

The event is triggered when the user double-clicks on a component.

See Also:

• MouseEvent
• DoubleClickEventHandler

DRAG_SORT

public static final EventType DRAG_SORT

KEY_PRESS

public static final EventType KEY_PRESS

Keyboard key press event

The event is triggered when the user presses a key.

See Also:

• KeyboardEvent
• KeyPressEventHandler

KEY_DOWN

public static final EventType KEY_DOWN

Key down event

The event is triggered when the user presses down a key

See Also:

• KeyboardEvent
• KeyDownEventHandler

KEY_UP

public static final EventType KEY_UP

Key up event

The event is triggered when the user releases a key

See Also:

• KeyboardEvent
• KeyUpEventHandler

MOUSE_DOWN

public static final EventType MOUSE_DOWN

Mouse button down event

The event is triggered when the user presses a mouse button

See Also:

• MouseEvent
• MouseDownEventHandler

MOUSE_ENTER

public static final EventType MOUSE_ENTER

The mouse enter event

The event is triggered when the user enters the component area (ie, the user mouses over the component).

See Also:

• MouseEvent
• MouseEnterEventHandler

MOUSE_LEAVE

public static final EventType MOUSE_LEAVE

The mouse leave event

The event is triggered when the user's mouse leaves the component area.

See Also:

• MouseEvent
• MouseLeaveEventHandler

MOUSE_MOVE

public static final EventType MOUSE_MOVE

The mouse move event

The event is triggered when the user moves the mouse over a component

See Also:

• MouseEvent
• MouseMoveEventHandler

MOUSE_OVER

public static final EventType MOUSE_OVER

The mouse over event

The event is triggered when the user's mouse moves over a component, or a subcomponent

See Also:

• MouseEvent
• MouseOverEventHandler

MOUSE_OUT

public static final EventType MOUSE_OUT

Mouse out event

The event is triggered when the user moves the mouse out of the component or subcomponent.

See Also:

• MouseEvent
• MouseOutEventHandler

MOUSE_UP

public static final EventType MOUSE_UP

Mouse up event

The event is triggered when the user moves the mouse over the component or subcomponent.

See Also:

• MouseEvent
• MouseUpEventHandler

WHEEL

public static final EventType WHEEL

Mousewheel event

The event is triggered when the user uses the mouse wheel

See Also:

• WheelEvent
• MouseWheelEventHandler

SCROLL

public static final EventType SCROLL

Scroll event

The event is triggered when the user scrolls the content of a scrollable component

See Also:

• BrowserEvent
• ScrollEventHandler

TOUCH_CANCEL

public static final EventType TOUCH_CANCEL

Touch cancel event

The event is triggered when the touch event is interrupted/stopped by the touchscreen device

See Also:

• TouchEvent
• TouchCancelEventHandler

TOUCH_END

public static final EventType TOUCH_END

Touch end event

The event is triggered when the user stops touching the component.

See Also:

• TouchEvent
• TouchEndEventHandler

TOUCH_MOVE

public static final EventType TOUCH_MOVE

Touch move event

The event is triggered when the user moves their finger on their touchscreen.

See Also:

• TouchEvent
• TouchMoveEventHandler

TOUCH_START

public static final EventType TOUCH_START

Touch start event

The event is triggered when the user starts touching a component.

See Also:

• TouchEvent
• TouchStartEventHandler

DONE

public static final EventType DONE

Done event

The event is triggered when a process is done.

See Also:

• DoneEvent
• DoneEventHandler

ERROR

public static final EventType ERROR

Error event

The event is triggered when a process encounters an error.

See Also:

• ErrorEvent
• ErrorEventHandler

LIST_GRID_HEADER_CLICK

public static final EventType LIST_GRID_HEADER_CLICK

List grid header click event

The event is triggered when the user clicks on the header of a ListGrid component.

See Also:

• JBStrapMouseEvent
• ListGridHeaderClickHandler

LIST_GRID_HEADER_DOUBLE_CLICK

public static final EventType LIST_GRID_HEADER_DOUBLE_CLICK

List grid header double-click event

The event is triggered when the user double-clicks on the header of a ListGrid component.

See Also:

• JBStrapMouseEvent
• ListGridHeaderDoubleClickHandler

LIST_GRID_NEXT_PAGE

public static final EventType LIST_GRID_NEXT_PAGE

ListGrid next page request event

The event is triggered when the ListGrid component is in Lazy Fetch mode, and the user scrolls down to the end of the currently displayed data.

See Also:

• ListGridNextPageRequestEvent
• ListGridNextPageEventHandler

LIST_GRID_ROW_CLICK

public static final EventType LIST_GRID_ROW_CLICK

ListGrid row click event

The event is triggered when the user clicks on a row of a ListGrid component

See Also:

• JBStrapMouseEvent
• ListGridRowClickHandler

LIST_GRID_ROW_DOUBLE_CLICK

public static final EventType LIST_GRID_ROW_DOUBLE_CLICK

ListGrid row double-click event

The event is triggered when the user double-clicks on a row of a ListGrid component

See Also:

• JBStrapMouseEvent
• ListGridRowDoubleClickHandler

LIST_GRID_COLUMN_RESIZE

public static final EventType LIST_GRID_COLUMN_RESIZE

ListGrid column resize event

The event is triggered when the user resizes the column of a ListGrid component

See Also:

• ListGridColumnResizeEvent
• ListGridColumnResizeHandler

LIST_GRID_COLUMN_MOVE

public static final EventType LIST_GRID_COLUMN_MOVE

ListGrid column move event

The event is triggered when the user moves the column of a ListGrid component

See Also:

• ListGridColumnMoveEvent
• ListGridColumnMoveHandler

LIST_GIRD_REFRESH_DATA

public static final EventType LIST_GIRD_REFRESH_DATA

ListGrid refresh data event

The event is triggered when the ListGrid component refreshing data

See Also:

• ListGridRefreshDataEvent
• ListGridRefreshDataHandler

LIST_GRID_COLUMN_SHOW

public static final EventType LIST_GRID_COLUMN_SHOW

ListGrid column show or hide event

The event is triggered when the user show or hide column on the ListGrid component

See Also:

• ListGridColumnShowEvent
• ListGridColumnShowHandler

LIST_GRID_SORT

public static final EventType LIST_GRID_SORT

ListGrid sort data event

The event is triggered when ListGrid component need sorted data

See Also:

• ListGridSortEvent
• ListGridSortEventHandler

LIST_GRID_RESIZE

public static final EventType LIST_GRID_RESIZE

ListGrid resize event

The event is triggered when the user resizes a page that contains a ListGrid component.

See Also:

• BaseJBStrapEvent

FILTERBAR_FILTERING

public static final EventType FILTERBAR_FILTERING

Filter bar filtering event

The event is triggered when user filtering in the filter bar component

See Also:

• FilterbarFilteringEvent
• FilterbarFilteringEventHandler

FILTERBAR_CHANGE_EDITOR

public static final EventType FILTERBAR_CHANGE_EDITOR

Filter bar change filter editor event

The event is triggered when filter bar change the visible filter editor component

See Also:

• FilterbarChangeEditorEvent
• FilterbarChangeEditorEventHandler

PAGE_RESIZE

public static final EventType PAGE_RESIZE

Page resize event

The event is triggered when the user resizes the browser window, that has the application displayed.

See Also:

• PageResizeEvent
• PageResizeEventHandler

FETCH_DONE

public static final EventType FETCH_DONE

Fetch done event

The event runs, when a component's data fetch has finished.

See Also:

• FetchDoneEvent
• FetchDoneEventHandler

FORM_CHANGED

public static final EventType FORM_CHANGED

Form change event

The event is triggered when the user (or the application, through code) changes the contents of a form. One such case could be if a new record is opened on the form, displaying the data of a previously saved record, modifying a displayed record, or if the user modifies the form's input field

See Also:

• FormChangedEvent
• FormChangedEventHandler

HOT_KEY

public static final EventType HOT_KEY

Hot key pressed event

The event is triggered, when the user presses a registered hotkey combination

See Also:

• HotKeyEvent
• HotKeyEventHandler

DROP_EVENT

public static final EventType DROP_EVENT

Component drop event

The event is triggered when the user drops a draggable component to another component.

See Also:

• DropEvent
• DropEventHandler

DRAG_START

public static final EventType DRAG_START

Dragging start event

The event is triggered when the user starts dragging a component

See Also:

• DragStartEvent
• DragStartEventHandler

DRAG_END

public static final EventType DRAG_END

Dragging end event

The event is triggered when the user stops dragging a component

See Also:

• DragEndEvent
• DragEndEventHandler

CALENDAR_INIT_DONE

public static final EventType CALENDAR_INIT_DONE

See Also:

• CalendarInitDoneEvent

CALENDAR_CHANGE_VIEW_EVENT

public static final EventType CALENDAR_CHANGE_VIEW_EVENT

Calendar component view change event

The event is triggered when the user changes the view mode of the calendar component

See Also:

• CalendarChangeViewEvent
• CalendarViewChangeEventHandler

CALENDAR_CLICK

public static final EventType CALENDAR_CLICK

Calendar component click event

The event is triggered when the user clicks on an area of the calendar component, that has no schedule displayed.

See Also:

• CalendarClickEvent
• CalendarClickHandler

CALENDAR_DOUBLE_CLICK

public static final EventType CALENDAR_DOUBLE_CLICK

Calendar component double-click event

The event is triggered when the user double-clicks on an area of the calendar component, that has no schedule displayed.

See Also:

• CalendarDoubleClickEvent
• CalendarDoubleClickHandler

CALENDAR_SCHEDULE_CLICK

public static final EventType CALENDAR_SCHEDULE_CLICK

Calendar schedule click event

The event is triggered when the user clicks on a displayed schedule.

See Also:

• CalendarScheduleClickEvent
• CalendarScheduleClickHandler

CALENDAR_SCHEDULE_MOVE

public static final EventType CALENDAR_SCHEDULE_MOVE

Calendar schedule move event

The event is triggered when the user moves a schedule with drag&drop to another timeslot.

See Also:

• CalendarMoveScheduleEvent
• CalendarMoveScheduleHandler

FORM_ITEM_VALUE_CHANGE

public static final EventType FORM_ITEM_VALUE_CHANGE

Input field value change event

The event is triggered, when an input field's value is modified by the user.

See Also:

• FormItemChangeEvent
• ValueChangedHandler

ENTER_PRESSED

public static final EventType ENTER_PRESSED

Enter button pressed event

The event is triggered, when the user presses the enter key, while in an input field.

See Also:

• KeyboardEvent
• EnterPressedEventHandler

NAVIGATION_EVENT

public static final EventType NAVIGATION_EVENT

See Also:

• NavigationEvent
• NavigationEventHandler

CLIENT_CONNECTED

public static final EventType CLIENT_CONNECTED

Client connected event

The event is triggered, when the client connects to the server

See Also:

• ClientConnectedEvent

JAVASCRIPT_ERROR

public static final EventType JAVASCRIPT_ERROR

JavaScript error event

The event is triggered, when the JavaScript that ran on the client encounters an error

See Also:

• JavaScriptExceptionEvent

DEBUG_MESSAGE

public static final EventType DEBUG_MESSAGE

See Also:

• DebugEvent

RETURN_EVENT

public static final EventType RETURN_EVENT

See Also:

• ReturnEvent

VALUE_CLEAR

public static final EventType VALUE_CLEAR

See Also:

• BaseJBStrapEvent

FILE_ITEM_ERROR

public static final EventType FILE_ITEM_ERROR

See Also:

• FileItemErrorEvent
• FileItemErrorHandler

FILE_ITEM_DONE

public static final EventType FILE_ITEM_DONE

See Also:

• FileItemDoneEvent
• FileItemDoneHandler

FILE_ITEM_UPLOAD_START

public static final EventType FILE_ITEM_UPLOAD_START

See Also:

• FileItemUploadStartEvent
• FileItemUploadStartHandler

CHART_CLICK

public static final EventType CHART_CLICK

Chart click event

The event is triggered when the user clicks on a chart data.

See Also:

• ChartClickEvent
• ChartClickEventHandler

CHART_LASSO

public static final EventType CHART_LASSO

Chart lasso event

The event is triggered when the user select one or more data in the chart

See Also:

• ChartLassoEvent
• ChartLassoEventHandler

CUSTOM

public static final EventType CUSTOM

Method Details

values

public static EventType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static EventType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isClientEvent

public boolean isClientEvent()

Returns:

true, if the event must be triggered by the client, otherwise false

getEvent

public BaseEvent getEvent()
                   throws InstantiationException,
IllegalAccessException

Returns:

The new event instance.

Throws:

InstantiationException - if the specified event class couldn't be instantiated.

IllegalAccessException - If the event type couldn't be set in the event instance.

getEvent

public BaseEvent getEvent(String customEventName)
                   throws InstantiationException,
IllegalAccessException

Parameters:

customEventName - The new event name

Returns:

The event instance

Throws:

InstantiationException - if the specified event class couldn't be instantiated.

IllegalAccessException - If the event type couldn't be set in the event instance.

getHandlerMethodName

public String getHandlerMethodName()

Gets the name of the event handler method

Returns:

The name of the event handler method or null if not found

getCoreHandlerMethodName

public String getCoreHandlerMethodName()

Returns:

The name of the core event handler method or null if the event has no core method

getBrowserEventName

public String getBrowserEventName()

Returns:

The name, or null if the event isn't from the browser

getHandlerInterface

public Class<? extends BrowserEventHandler> getHandlerInterface()

Gets the event handler interface class

Returns:

The event handler interface class or null if the event has no interface specified

fromEventType

public static EventType fromEventType(com.google.gson.JsonElement receivedEventType,
 com.google.gson.JsonElement receivedBrowserEventName)

Determines the event type, based on the specified JSON elements.

Parameters:

receivedEventType - The JSON element, received from the client, that contains the event name

receivedBrowserEventName - The JSON element, received from the client,that contains the browser event name

Returns:

The event type or null, if the event type was not found

addCustomEvent

public static void addCustomEvent(String eventName,
 Class<? extends BaseEvent> eventClass,
 Class<? extends BrowserEventHandler> eventHandlerInterface)

Registers a custom event among the event types

Parameters:

eventName - The custom event name

eventClass - The custom event class

eventHandlerInterface - The custom event handler interface class

Throws:

NullPointerException - If the specified event name is null

IllegalArgumentException - If the specified name is already used on an event