com.gargoylesoftware.htmlunit.javascript.host

Class UIEvent

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.Event

com.gargoylesoftware.htmlunit.javascript.host.UIEvent

All Implemented Interfaces:

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

Direct Known Subclasses:

MouseEvent

public class UIEvent
extends Event

JavaScript object representing a UI event. For general information on which properties and functions should be supported, see DOM Level 3 Events.

Version:

$Revision: 2132 $

Author:

Daniel Gredler

See Also:

Serialized Form

Field Summary

Fields inherited from class com.gargoylesoftware.htmlunit.javascript.host.Event

AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE, TYPE_BEFORE_UNLOAD, TYPE_BLUR, TYPE_CHANGE, TYPE_DOM_DOCUMENT_LOADED, TYPE_FOCUS, TYPE_KEY_DOWN, TYPE_KEY_PRESS, TYPE_KEY_UP, TYPE_LOAD, TYPE_RESET, TYPE_SUBMIT, TYPE_UNLOAD

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
UIEvent() Creates a new UI event instance.
UIEvent(DomNode domNode, String type, boolean shiftKey, boolean ctrlKey, boolean altKey) Creates a new UI event instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	copyPropertiesFrom(Event event) Copies properties from another event to this event.
void	jsxFunction_initUIEvent(String type, boolean bubbles, boolean cancelable, Object view, int detail) Implementation of the DOM Level 3 Event method for initializing the UI event.
long	jsxGet_detail() Returns some detail information about the event, depending on the event type.
Object	jsxGet_view() Returns the view from which the event was generated.
protected void	setDetail(long detail) Sets the detail information for this event.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.Event

isPreventDefault, isPropagationStopped, jsxFunction_initEvent, jsxFunction_preventDefault, jsxFunction_stopPropagation, jsxGet_altKey, jsxGet_bubbles, jsxGet_cancelable, jsxGet_cancelBubble, jsxGet_ctrlKey, jsxGet_currentTarget, jsxGet_eventPhase, jsxGet_keyCode, jsxGet_returnValue, jsxGet_shiftKey, jsxGet_srcElement, jsxGet_target, jsxGet_timeStamp, jsxGet_type, jsxSet_cancelBubble, jsxSet_returnValue, jsxSet_srcElement, setAltKey, setCtrlKey, setCurrentTarget, setEventPhase, setEventType, setShiftKey, 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

Constructor Detail

UIEvent

public UIEvent()

Creates a new UI event instance.

UIEvent

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

Creates a new UI 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

Method Detail

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.

Overrides:

copyPropertiesFrom in class Event

Parameters:

event - the event to copy the properties from

jsxGet_detail

public long jsxGet_detail()

Returns some detail information about the event, depending on the event type. For mouse events, the detail property indicates how many times the mouse has been clicked in the same location for this event.

Returns:

some detail information about the event, depending on the event type

setDetail

protected void setDetail(long detail)

Sets the detail information for this event.

Parameters:

detail - the detail information for this event

jsxGet_view

public Object jsxGet_view()

Returns the view from which the event was generated. In browsers, this is the originating window.

Returns:

the view from which the event was generated

jsxFunction_initUIEvent

public void jsxFunction_initUIEvent(String type,
                           boolean bubbles,
                           boolean cancelable,
                           Object view,
                           int detail)

Implementation of the DOM Level 3 Event method for initializing the UI event.

Parameters:

type - the event type

bubbles - can the event bubble

cancelable - can the event be canceled

view - the view to use for this event

detail - the detail to set for the event