Class EventStreamEvent
- All Implemented Interfaces:
HasHandlers
Experimental Features for more information.A JavaScript object representing an event captured by a
EventStream.
EventStreamEvents may represent DOM events (wrapped by the EventHandler),
or other operations such as relogins or
Reify file operations on screens and projects.
An eventType should always be present, but not
all properties
will be present for a given EventStreamEvent, since their relevance depends on the
eventType.
In addition to the instance attributes documented for EventStreamEvent, if
we're capturing move events but not
drag events, the move event starting a drag
will
be tagged with the drag start eventType as a boolean attribute. So for
example,
dragResizeStart: true
might appear in the EventStreamEvent for a mouseMove, if it started
a drag but we weren't capturing drag events.- See Also:
-
Field Summary
Fields inherited from class com.smartgwt.client.core.DataClass
factoryCreated, factoryProperties -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetCount()Contains a count of the number of events (if any) collapsed into this event if collapsing is active, which includes:move eventskey eventswheel eventspage eventsThe count, if present, includes the event itself so it will always be a number greater than or equal to two.Present forkey eventsif the control key was down when the event got triggered.Thehorizontal scroll delta, present forwheel events.Thevertiacl scroll delta, present forwheel events.Set on the event captured at the end of a drag if the drag is canceled.The class name of thedrag target, present for mostdrag events.The class name of thedrop target, present for somedrag events.Present along witherrorTraceandthreadCodeif the event triggering the error wasn't already captured, and required adding a new event.The stack reported when a JavaScript error is hit processing an event.The type of theEventStreamEvent.Thepage height, present for page-levelresize events.The name of the key that triggered this event, present forkey events.Whenkey event collapsingis active and other events have been collapsed into this one, contains a string representing the concatenatedkeyNamesfrom the collapsed events.The locator representing the event target, if one exists.Present forkey eventsif the meta key was down when the event got triggered.static EventStreamEventgetOrCreateRef(JavaScriptObject jsObj) For synthetic events (where theEventHandlerhas (re)dispatched a DOM event as a new type), the originaleventType.Present forkey eventsif the shift key was down when the event got triggered.True For synthetic events.The class name of the event target, if one exists.Thewidget IDof the event target, if one exists.The horizontal offset of the event from theleft edgeof the event target, if one exists.The vertical offset of the event from thetop edgeof the event target, if one exists.A symbolic thead ID useful for debugging, present when a JavaScript error is hit processing an event.The time offset of this event fromEventStreamData.startTime, when capturing started, in milliseconds.getURL()The transactionURLassociated wtih the successfulrelogin.getWidth()Thepage width, present for page-levelresize events.getX()The left offset of the event on the page.getY()The top offset of the event on the page.Methods inherited from class com.smartgwt.client.core.DataClass
applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated
-
Constructor Details
-
EventStreamEvent
public EventStreamEvent() -
EventStreamEvent
-
-
Method Details
-
getOrCreateRef
-
getCount
Contains a count of the number of events (if any) collapsed into this event if collapsing is active, which includes: The count, if present, includes the event itself so it will always be a number greater than or equal to two.- Returns:
- Current count value. Default value is null
-
getCtrlKey
Present forkey eventsif the control key was down when the event got triggered. Otherwise, not present.- Returns:
- Current ctrlKey value. Default value is null
- See Also:
-
getDeltaX
Thehorizontal scroll delta, present forwheel events.- Returns:
- Current deltaX value. Default value is null
- See Also:
-
getDeltaY
Thevertiacl scroll delta, present forwheel events.- Returns:
- Current deltaY value. Default value is null
- See Also:
-
getDragCanceled
Set on the event captured at the end of a drag if the drag is canceled. This is normally an event such asdragStop,dragRepositionStop,dragResizeStop, ordragSelectStop, but ifdrag eventsaren't being captured, this property may be set on themouseUpending the drag.- Returns:
- Current dragCanceled value. Default value is null
-
getDragTargetClass
The class name of thedrag target, present for mostdrag events.Note that if drag events are not being captured, it will be populated for the
mouseUpevent terminating the drag.- Returns:
- Current dragTargetClass value. Default value is null
- See Also:
-
getDragTargetID
Thewidget IDof thedrag target, present for mostdrag events.Note that if drag events are not being captured, it will be populated for the
mouseUpevent terminating the drag.- Returns:
- Current dragTargetID value. Default value is null
- See Also:
-
getDropTargetClass
The class name of thedrop target, present for somedrag events.Note that if drag events are not being captured, it will be populated for the
mouseUpevent terminating the drag.- Returns:
- Current dropTargetClass value. Default value is null
- See Also:
-
getDropTargetID
Thewidget IDof thedrop target, present for somedrag events.Note that if drag events are not being captured, it will be populated for the
mouseUpevent terminating the drag.- Returns:
- Current dropTargetID value. Default value is null
- See Also:
-
getErrorEvent
Present along witherrorTraceandthreadCodeif the event triggering the error wasn't already captured, and required adding a new event. If a stream is configured tocapture event errors, then through error reporting it may captureeventTypes not specified by the filters.- Returns:
- Current errorEvent value. Default value is null
- See Also:
-
getErrorTrace
The stack reported when a JavaScript error is hit processing an event. TheerrorTracecontains an initial description of the error, and formatting whitespace and newlines to make the trace readable.- Returns:
- Current errorTrace value. Default value is null
- See Also:
-
getEventType
The type of theEventStreamEvent. For DOM events, this is just the officialEventHandlername for the event, such asmouseDown. Otherwise, it's unique toEventStream, but should reflect what event was captured, such asfileLoadorrelogin.- Returns:
- Current eventType value. Default value is null
-
getHeight
Thepage height, present for page-levelresize events.- Returns:
- Current height value. Default value is null
- See Also:
-
getKeyName
The name of the key that triggered this event, present forkey events. For flexibility and ease of conversion to formats such as Selenese, thekeyNamefor self-inserting keys (e.g. alphanumerics, "!", "@", etc.) reflects the actual character typed, factoring in the shift key. This aligns withEventHandler.getKeyEventKey()rather thanEventHandler.getKey(), but refer to String for special keys.Note that the
keyNamefor special keys may be more than one character, such as "Enter", or "Down". For improvedcollapsing, the space key is always reported as the self-inserting key " ", rather than the special key "Space", since we can't collapse special and self-inserting keys into one event.- Returns:
- Current keyName value. Default value is null
- See Also:
-
getKeyNames
Whenkey event collapsingis active and other events have been collapsed into this one, contains a string representing the concatenatedkeyNamesfrom the collapsed events. The length of this string should matchcount, and the first character in the string should bekeyName.Note that only self-inserting keys can be concentated by collapsing, not special keys.
- Returns:
- Current keyNames value. Default value is null
- See Also:
-
getLocator
The locator representing the event target, if one exists. Designed to be robust, the the locator provides a future-proof way to specify aCanvas,FormItem, or widget part such as a row of aListGrid.- Returns:
- Current locator value. Default value is null
- See Also:
-
com.smartgwt.client.util.AutoTest#getObjectAutoTestLocator
-
getMetaKey
Present forkey eventsif the meta key was down when the event got triggered. Otherwise, not present.- Returns:
- Current metaKey value. Default value is null
- See Also:
-
getOriginalType
For synthetic events (where theEventHandlerhas (re)dispatched a DOM event as a new type), the originaleventType.- Returns:
- Current originalType value. Default value is null
- See Also:
-
getShiftKey
Present forkey eventsif the shift key was down when the event got triggered. Otherwise, not present.- Returns:
- Current shiftKey value. Default value is null
- See Also:
-
getSynthetic
True For synthetic events. Otherwise, not present at all. When true,originalTypeshould be set indicating the originaleventType.- Returns:
- Current synthetic value. Default value is null
- See Also:
-
getTargetClass
The class name of the event target, if one exists. Page-level and non-DOM events may not have any target.- Returns:
- Current targetClass value. Default value is null
- See Also:
-
getTargetID
Thewidget IDof the event target, if one exists. Page-level and non-DOM events may not have any target.- Returns:
- Current targetID value. Default value is null
- See Also:
-
getTargetX
The horizontal offset of the event from theleft edgeof the event target, if one exists. Keyboard, page-level, and non-DOM events may not have any target.- Returns:
- Current targetX value. Default value is null
- See Also:
-
getTargetY
The vertical offset of the event from thetop edgeof the event target, if one exists. Keyboard, page-level, and non-DOM events may not have any target.- Returns:
- Current targetY value. Default value is null
- See Also:
-
getThreadCode
A symbolic thead ID useful for debugging, present when a JavaScript error is hit processing an event.- Returns:
- Current threadCode value. Default value is null
- See Also:
-
getTimeOffset
The time offset of this event fromEventStreamData.startTime, when capturing started, in milliseconds.- Returns:
- Current timeOffset value. Default value is null
-
getURL
- Returns:
- Current URL value. Default value is null
- See Also:
-
getWidth
Thepage width, present for page-levelresize events.- Returns:
- Current width value. Default value is null
- See Also:
-
getX
The left offset of the event on the page. This property typically won't be set unless notargetis present and the event has anerrorTrace.- Returns:
- Current X value. Default value is null
- See Also:
-
getY
The top offset of the event on the page. This property typically won't be set unless notargetis present and the event has anerrorTrace.- Returns:
- Current Y value. Default value is null
- See Also:
-