com.gargoylesoftware.htmlunit.javascript.host
Class UIEvent

java.lang.Object
  extended by net.sourceforge.htmlunit.corejs.javascript.ScriptableObject
      extended by com.gargoylesoftware.htmlunit.javascript.SimpleScriptable
          extended by com.gargoylesoftware.htmlunit.javascript.host.Event
              extended by com.gargoylesoftware.htmlunit.javascript.host.UIEvent
All Implemented Interfaces:
Serializable, Cloneable, Map, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable
Direct Known Subclasses:
KeyboardEvent, 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: 5301 $
Author:
Daniel Gredler, Ahmed Ashour
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Field Summary
 
Fields inherited from class com.gargoylesoftware.htmlunit.javascript.host.Event
ABORT, ALT_MASK, AT_TARGET, BACK, BLUR, BUBBLING_PHASE, CAPTURING_PHASE, CHANGE, CLICK, CONTROL_MASK, DBLCLICK, DRAGDROP, ERROR, FOCUS, FORWARD, HELP, KEYDOWN, KEYPRESS, KEYUP, LOAD, LOCATE, META_MASK, MOUSEDOWN, MOUSEDRAG, MOUSEMOVE, MOUSEOUT, MOUSEOVER, MOUSEUP, MOVE, RESET, RESIZE, SCROLL, SELECT, SHIFT_MASK, SUBMIT, TEXT, TYPE_BEFORE_UNLOAD, TYPE_BLUR, TYPE_CHANGE, TYPE_DOM_DOCUMENT_LOADED, TYPE_ERROR, TYPE_FOCUS, TYPE_FOCUS_IN, TYPE_FOCUS_OUT, TYPE_INPUT, TYPE_KEY_DOWN, TYPE_KEY_PRESS, TYPE_KEY_UP, TYPE_LOAD, TYPE_PROPERTY_CHANGE, TYPE_READY_STATE_CHANGE, TYPE_RESET, TYPE_SUBMIT, TYPE_UNLOAD, UNLOAD, XFER_DONE
 
Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject
CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST
 
Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable
NOT_FOUND
 
Constructor Summary
UIEvent()
          Creates a new UI event instance.
UIEvent(DomNode domNode, String type)
          Creates a new UI event instance.
 
Method Summary
 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.
 boolean jsxGet_metaKey()
          Returns whether or not the "meta" key was pressed during the event firing.
 Object jsxGet_view()
          Returns the view from which the event was generated.
protected  void setDetail(long detail)
          Sets the detail information for this event.
protected  void setMetaKey(boolean metaKey)
           
 
Methods inherited from class com.gargoylesoftware.htmlunit.javascript.host.Event
applies, createPropertyChangeEvent, isAborted, isPropagationStopped, jsxFunction_initEvent, jsxFunction_preventDefault, jsxFunction_stopPropagation, jsxGet_altKey, jsxGet_bubbles, jsxGet_cancelable, jsxGet_cancelBubble, jsxGet_ctrlKey, jsxGet_currentTarget, jsxGet_eventPhase, jsxGet_keyCode, jsxGet_propertyName, jsxGet_returnValue, jsxGet_shiftKey, jsxGet_srcElement, jsxGet_target, jsxGet_timeStamp, jsxGet_type, jsxSet_cancelBubble, jsxSet_returnValue, jsxSet_srcElement, setAltKey, setCtrlKey, setCurrentTarget, setEventPhase, setEventType, setKeyCode, setShiftKey, setTarget, toString
 
Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable
clone, defineFunctionProperties, defineProperty, equivalentValues, get, getBrowserVersion, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getTransformerScriptableFor, getWindow, getWindow, getWithPreemption, hasInstance, initParentScope, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement
 
Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject
applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, clear, containsKey, containsValue, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, entrySet, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypeOf, has, has, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, keySet, preventExtensions, put, put, put, putAll, putConst, putConstProperty, putProperty, putProperty, redefineProperty, remove, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setGetterOrSetter, setParentScope, setPrototype, size, values
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Constructor Detail

UIEvent

public UIEvent()
Creates a new UI event instance.


UIEvent

public UIEvent(DomNode domNode,
               String type)
Creates a new UI event instance.

Parameters:
domNode - the DOM node that triggered the event
type - the event type
Method Detail

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

jsxGet_metaKey

public boolean jsxGet_metaKey()
Returns whether or not the "meta" key was pressed during the event firing.

Returns:
whether or not the "meta" key was pressed during the event firing

setMetaKey

protected void setMetaKey(boolean metaKey)
Parameters:
metaKey - whether Meta has been pressed during this event or not


Copyright © 2002-2011 Gargoyle Software Inc.. All Rights Reserved.