public class EventStreamEvent extends DataClass
Experimental Features for more information.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.Experimental FeaturesfactoryCreated, factoryProperties| Constructor and Description |
|---|
EventStreamEvent() |
EventStreamEvent(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.Integer |
getCount()
Contains a count of the number of events (if any) collapsed into this event if collapsing is active, which includes:
move events key events wheel events page events The count, if present, includes the
event itself so it will always be a number greater than or equal to two. |
java.lang.Boolean |
getCtrlKey()
Present for
key events if the control key was
down when the event got triggered. |
java.lang.Double |
getDeltaX()
The
horizontal scroll delta, present for wheel events. |
java.lang.Double |
getDeltaY()
The
vertiacl scroll delta, present for wheel events. |
java.lang.Boolean |
getDragCanceled()
Set on the event captured at the end of a drag if the drag is canceled.
|
java.lang.String |
getDragTargetClass()
The class name of the
drag target, present for most drag events. |
java.lang.String |
getDragTargetID()
|
java.lang.String |
getDropTargetClass()
The class name of the
drop target, present for some drag events. |
java.lang.String |
getDropTargetID()
|
java.lang.Boolean |
getErrorEvent()
Present along with
errorTrace and threadCode if the event triggering the error wasn't
already captured, and required adding a new event. |
java.lang.String |
getErrorTrace()
The stack reported when a JavaScript error is hit processing an event.
|
java.lang.String |
getEventType()
The type of the
EventStreamEvent. |
java.lang.Integer |
getHeight()
The
page height, present for page-level resize events. |
java.lang.String |
getKeyName()
The name of the key that triggered this event, present for
key events. |
java.lang.String |
getKeyNames()
When
key event collapsing is active and other
events have been collapsed into this one, contains a string representing the concatenated keyNames from the collapsed events. |
java.lang.String |
getLocator()
The locator representing the event target, if one exists.
|
java.lang.Boolean |
getMetaKey()
Present for
key events if the meta key was down
when the event got triggered. |
static EventStreamEvent |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getOriginalType()
For synthetic events (where the
EventHandler has (re)dispatched a DOM event as a new
type), the original eventType. |
java.lang.Boolean |
getShiftKey()
Present for
key events if the shift key was
down when the event got triggered. |
java.lang.Boolean |
getSynthetic()
True For synthetic events.
|
java.lang.String |
getTargetClass()
The class name of the event target, if one exists.
|
java.lang.String |
getTargetID()
The
widget ID of the event target, if one exists. |
java.lang.Integer |
getTargetX()
The horizontal offset of the event from the
left edge of the event
target, if one exists. |
java.lang.Integer |
getTargetY()
The vertical offset of the event from the
top edge of the event
target, if one exists. |
java.lang.String |
getThreadCode()
A symbolic thead ID useful for debugging, present when a JavaScript error is hit processing an event.
|
java.lang.Integer |
getTimeOffset()
The time offset of this event from
EventStreamData.startTime, when capturing started, in milliseconds. |
java.lang.String |
getURL()
The transaction
URL associated wtih the successful relogin. |
java.lang.Integer |
getWidth()
The
page width, present for page-level resize events. |
java.lang.Integer |
getX()
The left offset of the event on the page.
|
java.lang.Integer |
getY()
The top offset of the event on the page.
|
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, setFactoryCreatedpublic EventStreamEvent()
public EventStreamEvent(com.google.gwt.core.client.JavaScriptObject jsObj)
public static EventStreamEvent getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public java.lang.Integer getCount()
public java.lang.Boolean getCtrlKey()
key events if the control key was
down when the event got triggered. Otherwise, not present.getKeyName(),
getShiftKey(),
getMetaKey()public java.lang.Double getDeltaX()
horizontal scroll delta, present for wheel events.getDeltaY()public java.lang.Double getDeltaY()
vertiacl scroll delta, present for wheel events.getDeltaX()public java.lang.Boolean getDragCanceled()
dragStop, dragRepositionStop, dragResizeStop, or dragSelectStop, but
if drag events aren't being captured, this
property may be set on the mouseUp ending the drag.public java.lang.String getDragTargetClass()
drag target, present for most drag events. Note that if drag events are not
being captured, it will be populated for the mouseUp event terminating the drag.
getDragTargetID(),
getDropTargetID(),
getDropTargetClass()public java.lang.String getDragTargetID()
widget ID of the drag target, present for most drag events. Note that if drag events are not
being captured, it will be populated for the mouseUp event terminating the drag.
getDropTargetID(),
getDropTargetClass(),
getDragTargetClass(),
GlobalIdpublic java.lang.String getDropTargetClass()
drop target, present for some drag events. Note that if drag events are not
being captured, it will be populated for the mouseUp event terminating the drag.
getDropTargetID(),
getDragTargetID(),
getDragTargetClass()public java.lang.String getDropTargetID()
widget ID of the drop target, present for some drag events.
Note that if drag events are not being captured, it will be populated for the mouseUp event terminating
the drag.
getDragTargetID(),
getDragTargetClass(),
getDropTargetClass(),
GlobalIdpublic java.lang.Boolean getErrorEvent()
errorTrace and threadCode if the event triggering the error wasn't
already captured, and required adding a new event. If a stream is configured to capture event errors, then through error reporting
it may capture eventTypes not specified by the
filters.getEventType(),
getErrorTrace()public java.lang.String getErrorTrace()
errorTrace contains an initial
description of the error, and formatting whitespace and newlines to make the trace readable.getThreadCode(),
getErrorEvent()public java.lang.String getEventType()
EventStreamEvent. For DOM events, this is just the official
EventHandler name for the event, such as mouseDown. Otherwise, it's
unique to EventStream, but should reflect what event was captured, such as
fileLoad or relogin.public java.lang.Integer getHeight()
page height, present for page-level resize events.getWidth()public java.lang.String getKeyName()
key events. For flexibility and ease of conversion to
formats such as Selenese, the keyName for self-inserting keys (e.g. alphanumerics, "!", "@", etc.) reflects
the actual character typed, factoring in the shift key. This aligns with EventHandler.getKeyEventKey() rather than EventHandler.getKey(), but refer to String for special keys. Note that
the keyName for special keys may be more than one character, such as "Enter", or "Down". For improved
collapsing, 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.
getShiftKey(),
getCtrlKey(),
getMetaKey(),
getKeyNames()public java.lang.String getKeyNames()
key event collapsing is active and other
events have been collapsed into this one, contains a string representing the concatenated keyNames from the collapsed events. The length of this
string should match count, and the first character in
the string should be keyName. Note that only self-inserting keys can be concentated by collapsing, not special keys.
getKeyName()public java.lang.String getLocator()
Canvas, FormItem, or widget part such as a row of a ListGrid.com.smartgwt.client.util.AutoTest#getObject,
AutoTestLocatorpublic java.lang.Boolean getMetaKey()
key events if the meta key was down
when the event got triggered. Otherwise, not present.getKeyName(),
getShiftKey(),
getCtrlKey()public java.lang.String getOriginalType()
EventHandler has (re)dispatched a DOM event as a new
type), the original eventType.getSynthetic()public java.lang.Boolean getShiftKey()
key events if the shift key was
down when the event got triggered. Otherwise, not present.getKeyName(),
getCtrlKey(),
getMetaKey()public java.lang.Boolean getSynthetic()
originalType should be set indicating the original
eventType.getOriginalType()public java.lang.String getTargetClass()
getTargetID(),
getTargetX(),
getTargetY()public java.lang.String getTargetID()
widget ID of the event target, if one exists. Page-level and
non-DOM events may not have any target.getTargetClass(),
getTargetX(),
getTargetY(),
GlobalIdpublic java.lang.Integer getTargetX()
left edge of the event
target, if one exists. Keyboard, page-level, and non-DOM events may not have any target.getTargetID(),
getTargetClass(),
getTargetY()public java.lang.Integer getTargetY()
top edge of the event
target, if one exists. Keyboard, page-level, and non-DOM events may not have any target.getTargetID(),
getTargetClass(),
getTargetY()public java.lang.String getThreadCode()
getErrorTrace(),
getErrorEvent()public java.lang.Integer getTimeOffset()
EventStreamData.startTime, when capturing started, in milliseconds.public java.lang.String getURL()
URLpublic java.lang.Integer getWidth()
page width, present for page-level resize events.getHeight()public java.lang.Integer getX()
target is present and the event has an errorTrace.getY()public java.lang.Integer getY()
target is present and the event has an errorTrace.getX()