com.gargoylesoftware.htmlunit.javascript.host

Class Event

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.Event

All Implemented Interfaces:

Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

Direct Known Subclasses:

UIEvent

public class Event
extends SimpleScriptable

JavaScript object representing an event that is passed into event handlers when they are invoked. For general information on which properties and functions should be supported, see the mozilla docs, the W3C DOM Level 2 Event Documentation or IE's IHTMLEventObj interface.

Version:

$Revision: 2132 $

Author:

Chris Eldredge, Mike Bowler, Chris Erskine, Marc Guillemot, Daniel Gredler, Brad Murray, Ahmed Ashour, Rob Di Marco

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static short	AT_TARGET The second event phase: at the event target.
static short	BUBBLING_PHASE The third (and final) event phase: the bubbling phase.
static short	CAPTURING_PHASE The first event phase: the capturing phase.
static String	TYPE_BEFORE_UNLOAD The beforeunload event type, triggered by "onbeforeunload" event handlers.
static String	TYPE_BLUR The blur event type, triggered by "onblur" event handlers.
static String	TYPE_CHANGE The change event type, triggered by "onchange" event handlers.
static String	TYPE_DOM_DOCUMENT_LOADED Triggered after the DOM has loaded but before images etc.
static String	TYPE_FOCUS The focus event type, triggered by "onfocus" event handlers.
static String	TYPE_KEY_DOWN The key down event type, triggered by "onkeydown" event handlers.
static String	TYPE_KEY_PRESS The key down event type, triggered by "onkeypress" event handlers.
static String	TYPE_KEY_UP The key down event type, triggered by "onkeyup" event handlers.
static String	TYPE_LOAD The load event type, triggered by "onload" event handlers.
static String	TYPE_RESET The submit event type, triggered by "onreset" event handlers.
static String	TYPE_SUBMIT The submit event type, triggered by "onsubmit" event handlers.
static String	TYPE_UNLOAD The unload event type, triggered by "onunload" event handlers.

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
Event() Used to build the prototype.
Event(DomNode domNode, String type) Creates a new event instance.
Event(DomNode domNode, String type, boolean shiftKey, boolean ctrlKey, boolean altKey) Creates a new event instance.
Event(DomNode domNode, String type, int keyCode, boolean shiftKey, boolean ctrlKey, boolean altKey) Creates a new event instance for a keypress event.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyPropertiesFrom(Event event) Copies properties from another event to this event.
boolean	isPreventDefault() Returns if the preventDefault() method has been called for this event.
boolean	isPropagationStopped() Indicates if event propagation is stopped.
void	jsxFunction_initEvent(String type, boolean bubbles, boolean cancelable) Initializes this event.
void	jsxFunction_preventDefault() If, during any stage of event flow, this method is called the event is canceled.
void	jsxFunction_stopPropagation() Stops the event from propagating.
boolean	jsxGet_altKey()
boolean	jsxGet_bubbles()
boolean	jsxGet_cancelable()
boolean	jsxGet_cancelBubble()
boolean	jsxGet_ctrlKey()
Object	jsxGet_currentTarget() Returns the event target whose event listeners are currently being processed.
int	jsxGet_eventPhase()
Object	jsxGet_keyCode() Returns the key code associated with the event.
Object	jsxGet_returnValue() Returns the return value associated with the event.
boolean	jsxGet_shiftKey()
Object	jsxGet_srcElement() Returns the object that fired the event.
Object	jsxGet_target() Returns the event target to which the event was originally dispatched.
long	jsxGet_timeStamp() Returns the time at which this event was created.
String	jsxGet_type() Returns the event type.
void	jsxSet_cancelBubble(boolean newValue)
void	jsxSet_returnValue(Object returnValue) Sets the return value associated with the event.
void	jsxSet_srcElement(Object srcElement) Sets the object that fired the event.
protected void	setAltKey(boolean altKey)
protected void	setCtrlKey(boolean ctrlKey)
void	setCurrentTarget(org.mozilla.javascript.Scriptable target) Sets the current target
void	setEventPhase(short phase) Sets the current event phase.
void	setEventType(String eventType) Sets the event type.
protected void	setShiftKey(boolean shiftKey)
String	toString()

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

get, getBooleanArg, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getIntArg, getLog, getObjectArg, getPrototype, getScriptableFor, getStartingScope, getStringArg, getTransformerScriptableFor, getWindow, getWindow, getWithPreemption, makeScriptableFor, setDomNode, setDomNode, setHtmlElement

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, equivalentValues, get, getAllIds, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, has, has, hasInstance, hasProperty, hasProperty, isConst, isSealed, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_SUBMIT

public static final String TYPE_SUBMIT

The submit event type, triggered by "onsubmit" event handlers.

See Also:

Constant Field Values

TYPE_CHANGE

public static final String TYPE_CHANGE

The change event type, triggered by "onchange" event handlers.

See Also:

Constant Field Values

TYPE_LOAD

public static final String TYPE_LOAD

The load event type, triggered by "onload" event handlers.

See Also:

Constant Field Values

TYPE_UNLOAD

public static final String TYPE_UNLOAD

The unload event type, triggered by "onunload" event handlers.

See Also:

Constant Field Values

TYPE_FOCUS

public static final String TYPE_FOCUS

The focus event type, triggered by "onfocus" event handlers.

See Also:

Constant Field Values

TYPE_BLUR

public static final String TYPE_BLUR

The blur event type, triggered by "onblur" event handlers.

See Also:

Constant Field Values

TYPE_KEY_DOWN

public static final String TYPE_KEY_DOWN

The key down event type, triggered by "onkeydown" event handlers.

See Also:

Constant Field Values

TYPE_KEY_PRESS

public static final String TYPE_KEY_PRESS

The key down event type, triggered by "onkeypress" event handlers.

See Also:

Constant Field Values

TYPE_KEY_UP

public static final String TYPE_KEY_UP

The key down event type, triggered by "onkeyup" event handlers.

See Also:

Constant Field Values

TYPE_RESET

public static final String TYPE_RESET

The submit event type, triggered by "onreset" event handlers.

See Also:

Constant Field Values

TYPE_BEFORE_UNLOAD

public static final String TYPE_BEFORE_UNLOAD

The beforeunload event type, triggered by "onbeforeunload" event handlers.

See Also:

Constant Field Values

TYPE_DOM_DOCUMENT_LOADED

public static final String TYPE_DOM_DOCUMENT_LOADED

Triggered after the DOM has loaded but before images etc.

See Also:

Constant Field Values

CAPTURING_PHASE

public static final short CAPTURING_PHASE

The first event phase: the capturing phase.

See Also:

Constant Field Values

AT_TARGET

public static final short AT_TARGET

The second event phase: at the event target.

See Also:

Constant Field Values

BUBBLING_PHASE

public static final short BUBBLING_PHASE

The third (and final) event phase: the bubbling phase.

See Also:

Constant Field Values

Constructor Detail

Event

public Event(DomNode domNode,
     String type)

Creates a new event instance.

Parameters:

domNode - The DOM node that triggered the event.

type - The event type.

Event

public Event(DomNode domNode,
     String type,
     boolean shiftKey,
     boolean ctrlKey,
     boolean altKey)

Creates a new event instance.

Parameters:

domNode - The DOM node that triggered the event.

type - The event type.

shiftKey - true if SHIFT is pressed

ctrlKey - true if CTRL is pressed

altKey - true if ALT is pressed

Event

public Event(DomNode domNode,
     String type,
     int keyCode,
     boolean shiftKey,
     boolean ctrlKey,
     boolean altKey)

Creates a new event instance for a keypress event.

Parameters:

domNode - the DOM node that triggered the event.

type - The event type.

keyCode - The key code associated with the event.

shiftKey - true if SHIFT is pressed

ctrlKey - true if CTRL is pressed

altKey - true if ALT is pressed

Event

public Event()

Used to build the prototype.

Method Detail

jsxGet_srcElement

public Object jsxGet_srcElement()

Returns the object that fired the event. This is an IE-only property.

Returns:

The object that fired the event.

jsxSet_srcElement

public void jsxSet_srcElement(Object srcElement)

Sets the object that fired the event. This is an IE-only property.

Parameters:

srcElement - The object that fired the event.

jsxGet_target

public Object jsxGet_target()

Returns the event target to which the event was originally dispatched.

Returns:

The event target to which the event was originally dispatched.

jsxGet_currentTarget

public Object jsxGet_currentTarget()

Returns the event target whose event listeners are currently being processed. This is useful during event capturing and event bubbling.

Returns:

The current event target.

setCurrentTarget

public void setCurrentTarget(org.mozilla.javascript.Scriptable target)

Sets the current target

Parameters:

target - the new value

jsxGet_type

public String jsxGet_type()

Returns the event type.

Returns:

The event type.

setEventType

public void setEventType(String eventType)

Sets the event type.

Parameters:

eventType - The event type.

jsxGet_timeStamp

public long jsxGet_timeStamp()

Returns the time at which this event was created.

Returns:

the time at which this event was created

jsxGet_keyCode

public Object jsxGet_keyCode()

Returns the key code associated with the event.

Returns:

The key code associated with the event.

jsxGet_shiftKey

public boolean jsxGet_shiftKey()

Returns:

whether SHIFT has been pressed during this event or not.

setShiftKey

protected void setShiftKey(boolean shiftKey)

Parameters:

shiftKey - whether SHIFT has been pressed during this event or not.

jsxGet_ctrlKey

public boolean jsxGet_ctrlKey()

Returns:

whether CTRL has been pressed during this event or not.

setCtrlKey

protected void setCtrlKey(boolean ctrlKey)

Parameters:

ctrlKey - whether CTRL has been pressed during this event or not.

jsxGet_altKey

public boolean jsxGet_altKey()

Returns:

whether ALT has been pressed during this event or not.

setAltKey

protected void setAltKey(boolean altKey)

Parameters:

altKey - whether ALT has been pressed during this event or not.

jsxGet_eventPhase

public int jsxGet_eventPhase()

Returns:

the current event phase for the event.

setEventPhase

public void setEventPhase(short phase)

Sets the current event phase. Must be one of CAPTURING_PHASE, AT_TARGET or BUBBLING_PHASE.

Parameters:

phase - the phase the event is in

jsxGet_bubbles

public boolean jsxGet_bubbles()

Returns:

whether or not this event bubbles.

jsxGet_cancelable

public boolean jsxGet_cancelable()

Returns:

whether or not this event can be canceled.

jsxGet_cancelBubble

public boolean jsxGet_cancelBubble()

Returns:

indicates if event propagation is stopped.

jsxSet_cancelBubble

public void jsxSet_cancelBubble(boolean newValue)

Parameters:

newValue - indicates if event propagation is stopped.

jsxFunction_stopPropagation

public void jsxFunction_stopPropagation()

Stops the event from propagating.

isPropagationStopped

public boolean isPropagationStopped()

Indicates if event propagation is stopped.

Returns:

the status

jsxGet_returnValue

public Object jsxGet_returnValue()

Returns the return value associated with the event.

Returns:

The return value associated with the event.

jsxSet_returnValue

public void jsxSet_returnValue(Object returnValue)

Sets the return value associated with the event.

Parameters:

returnValue - The return value associated with the event.

jsxFunction_initEvent

public void jsxFunction_initEvent(String type,
                         boolean bubbles,
                         boolean cancelable)

Initializes this event.

Parameters:

type - the event type

bubbles - whether or not the event should bubble

cancelable - whether or not the event the event should be cancelable

jsxFunction_preventDefault

public void jsxFunction_preventDefault()

If, during any stage of event flow, this method is called the event is canceled. Any default action associated with the event will not occur. Calling this method for a non-cancelable event has no effect.

isPreventDefault

public boolean isPreventDefault()

Returns if the preventDefault() method has been called for this event.

Returns:

if the preventDefault() method has been called for this event.

copyPropertiesFrom

public void copyPropertiesFrom(Event event)

Copies properties from another event to this event. This method should be overridden in subclasses in order to account for extra properties.

Parameters:

event - the event to copy the properties from

toString

public String toString()

Overrides:

toString in class Object