com.gargoylesoftware.htmlunit.javascript.host.event

Class MessageEvent

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.event.Event

com.gargoylesoftware.htmlunit.javascript.host.event.MessageEvent

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable

public class MessageEvent
extends Event

A JavaScript object for MessageEvent. For general information on which properties and functions should be supported, see Event definitions.

Author:

Ahmed Ashour, Frank Danek

See Also:

Mozilla documentation, Serialized Form

Field Summary

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

ALT_MASK, AT_TARGET, BLUR, BUBBLING_PHASE, CAPTURING_PHASE, CHANGE, CLICK, CONTROL_MASK, DBLCLICK, DRAGDROP, FOCUS, KEY_CURRENT_EVENT, KEYDOWN, KEYPRESS, KEYUP, META_MASK, MOUSEDOWN, MOUSEDRAG, MOUSEMOVE, MOUSEOUT, MOUSEOVER, MOUSEUP, NONE, SELECT, SHIFT_MASK, TYPE_BEFORE_UNLOAD, TYPE_BLUR, TYPE_CHANGE, TYPE_CLOSE, TYPE_DOM_DOCUMENT_LOADED, TYPE_ERROR, TYPE_FOCUS, TYPE_FOCUS_IN, TYPE_FOCUS_OUT, TYPE_HASH_CHANGE, TYPE_INPUT, TYPE_KEY_DOWN, TYPE_KEY_PRESS, TYPE_KEY_UP, TYPE_LOAD, TYPE_MESSAGE, TYPE_OPEN, TYPE_POPSTATE, TYPE_PROPERTY_CHANGE, TYPE_READY_STATE_CHANGE, TYPE_RESET, TYPE_SUBMIT, TYPE_UNLOAD

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

Constructors

Constructor and Description
MessageEvent() Default constructor used to build the prototype.
MessageEvent(Object data) Constructs a Message Event with the provided data.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getData() Retrieves the data contained.
String	getLastEventId() Retrieves the identifier of the last event.
String	getOrigin() Gets the URI of the document of origin.
Object	getPorts() Returns the ports property.
Window	getSource() Retrieves the data contained.
void	initMessageEvent(String type, boolean canBubble, boolean cancelable, Object data, String origin, String lastEventId, Window source, Object ports) Initializes an event object.
void	jsConstructor(String type, net.sourceforge.htmlunit.corejs.javascript.ScriptableObject details) JavaScript constructor.
void	setOrigin(String origin) Sets the URI of the document of origin.

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

createPropertyChangeEvent, endFire, eventCreated, getAltKey, getBubbles, getCancelable, getCancelBubble, getCtrlKey, getCurrentTarget, getDefaultPrevented, getEventPhase, getKeyCode, getPropertyName, getReturnValue, getShiftKey, getSrcElement, getTarget, getTimeStamp, getType, initEvent, isAborted, isPropagationStopped, preventDefault, setAltKey, setBubbles, setCancelable, setCancelBubble, setCtrlKey, setCurrentTarget, setEventPhase, setEventType, setKeyCode, setReturnValue, setShiftKey, setSrcElement, setTarget, setType, startFire, stopPropagation, toString

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

clone, equivalentValues, get, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, isReadOnlySettable, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement

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

defineFunctionProperties, defineProperty, getClassName, setClassName, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageEvent

public MessageEvent()

Default constructor used to build the prototype.

MessageEvent

public MessageEvent(Object data)

Constructs a Message Event with the provided data.

Parameters:

data - the data

Method Detail

jsConstructor

public void jsConstructor(String type,
                 net.sourceforge.htmlunit.corejs.javascript.ScriptableObject details)

JavaScript constructor.

Overrides:

jsConstructor in class Event

Parameters:

type - the event type

details - the event details (optional)

initMessageEvent

public void initMessageEvent(String type,
                    boolean canBubble,
                    boolean cancelable,
                    Object data,
                    String origin,
                    String lastEventId,
                    Window source,
                    Object ports)

Initializes an event object.

Parameters:

type - the event type

canBubble - can the event bubble

cancelable - can the event be canceled

data - the message

origin - the scheme, hostname and port of the document that caused the event

lastEventId - the identifier of the last event

source - the window object that contains the document that caused the event

ports - the message ports

getData

public Object getData()

Retrieves the data contained.

Returns:

the data contained

getOrigin

public String getOrigin()

Gets the URI of the document of origin.

Returns:

the origin

setOrigin

public void setOrigin(String origin)

Sets the URI of the document of origin.

Parameters:

origin - the origin

getLastEventId

public String getLastEventId()

Retrieves the identifier of the last event.

Returns:

the identified of the last event

getSource

public Window getSource()

Retrieves the data contained.

Returns:

the data contained

getPorts

public Object getPorts()

Returns the ports property.

Returns:

the ports property