- Legend to Symbols
-
Namespace
The namespace is really just an object where further objects and their methods and properties are attached bundling up all the functionality using a unique name.
Interface
The Interface is a contract by which the implementing class adheres. It describes a desired behavior and enforces adherence for any class that implements the interface.
Class
Classes define types of objects that will be used by the application.
Method
A function associated with a class or object.
Field
A variable associated with a class or object.
Inherited Method
A function inherited from the parent class. The present documentation scheme differentiates between a direct or indirect inheritance relationship.
Inherited Field
A variable inherited from the parent class. The present documentation scheme differentiates between a direct or indirect inheritance relationship.
Event
Events are actions that occur because of user interaction. They are normally used in combination with functions, and the function will not be executed before the event occurs.
Class nokia.maps.dom.Event
Class Summary
This class implements the W3C interface Event.
For more details about event dispatch please refer to the documentation of the class nokia.maps.dom.EventTarget.
new nokia.maps.dom.Event
([defaults])
Method Summary
cancel
()
: nokia.maps.dom.Event
This method cancels the given event.
clone
()
: nokia.maps.dom.Event
This method clones the given event without cloning the properties (non-recursive cloning only).
preventDefault
()
: nokia.maps.dom.Event
This method cancels the default action for the given event.
preventUnload
(msg)
: nokia.maps.dom.Event
This method can be used only when the given event is of the type "beforeunload" to ask the user to confirm whether he wants to leave the page.
stopImmediatePropagation
()
: nokia.maps.dom.Event
This method prevents other event listeners from being triggered and, in contrast to
Event.stopPropagation(), its effect is immediate.
stopPropagation
()
: nokia.maps.dom.Event
This method prevents other event listeners from being triggered, but its effect is deferred until all event listeners attached on the
Event.currentTarget have been triggered.
Field Summary
Number
AT_TARGET
This field is an event phase identifier, indicating the target phase, which means it is being evaluated at the event target.
Number
BUBBLING_PHASE
This field is an event phase identifier, indicating the bubbling phase.
Number
CAPTURING_PHASE
This field is an event phase identifier, indicating the capture phase.
Number
PROPAGATION_OK
This field is an identifier, indicating that the propagation of the event has not been stopped.
Number
PROPAGATION_STOP
This field is an identifier, indicating that the propagation of the event has been stopped.
Number
PROPAGATION_STOP_IMMEDIATE
This field is an identifier, indicating that the propagation of the event has been stopped with immediate effect.
Boolean
bubbles
This property indicates whether the event is a bubbling event (
true) or not (false).
Boolean
canBubble
This property indicates whether the event can bubble (
true) or not (false).
Boolean
canSicker
This property indicates whether the event can sicker (whether in the capture phase, listeners can be iterated from the top down) or not.
Boolean
cancelable
This property indicates whether or not an event can have its default action canceled (prevented).
nokia.maps.dom.EventTarget
currentTarget
This property indicates the object whose
eventListeners are currently being processed.
Boolean
defaultPrevented
This property indicates whether
preventDefault() has been called for this event.
Number
eventPhase
This property indicates the phase in the event flow the given event has reached.
String
namespaceURI
This property holds the namespace URI associated with the event or
null if it is unspecified.
Event
nativeEvent
This property holds a reference to the native DOM event on which the given normalized event object is based.
nokia.maps.dom.Page
page
This property holds a reference to the page to which the given event relates.
Number
propagation
This property indicates the status of event propagation.
nokia.maps.dom.EventTarget
target
This property holds the target object of the event.
Number
timeStamp
This property specifies the time at which the event was created in milliseconds relative to 1970-01-01T00:00:00Z.
String
type
This property holds the local name of the event type.
Constructor Detail
This class implements the W3C interface Event.
For more details about event dispatch please refer to the documentation of the class nokia.maps.dom.EventTarget.
new nokia.maps.dom.Event([defaults])
Parameters:
| {Object} | [defaults]: | If this argument is provided, all properties from it are copied into the given event object. |
Method Detail
cancel
()
: nokia.maps.dom.Event
This method cancels the given event. It stops the event propagation immediately and
prevents the default action.
This is a proprietary member and not part of the W3C interface specification this class implements.
Returns:
| {nokia.maps.dom.Event} | A reference to this event |
clone
()
: nokia.maps.dom.Event
This method clones the given event without cloning the properties
(non-recursive cloning only).
This is a proprietary member and not part of the W3C interface specification this class implements.
Returns:
| {nokia.maps.dom.Event} | A refernece to the cloned event |
preventDefault
()
: nokia.maps.dom.Event
This method cancels the default action for the given event. Calling this method
for a non-cancelable event has no effect.
Returns:
| {nokia.maps.dom.Event} | A reference to this event |
preventUnload
(msg)
: nokia.maps.dom.Event
This method can be used only when the given event is of the type "beforeunload"
to ask the user to confirm whether he wants to leave the page.
Note that this method can be useful in debugging to ensure that everything is cleared up when the user has left the page. However, bear in mind that the method cannot be used to prevent the user from leaving the page.
This is a proprietary member and not part of the W3C interface specification this class implements.
Parameters:
| {String} | msg | The message the browser should display in the confirmation dialog |
Returns:
| {nokia.maps.dom.Event} | A reference to the current event |
stopImmediatePropagation
()
: nokia.maps.dom.Event
This method prevents other event listeners from being triggered and,
in contrast to
Event.stopPropagation(), its effect is
immediate. Once it has been called, further calls to this method have
no effect.
Returns:
| {nokia.maps.dom.Event} | A reference to this event |
stopPropagation
()
: nokia.maps.dom.Event
This method prevents other event listeners from being triggered, but its effect
is deferred until all event listeners attached on the
Event.currentTarget
have been triggered. Once it has been called, further calls to this method have
no effect.
Returns:
| {nokia.maps.dom.Event} | A reference to this event |
Field Detail
Number
AT_TARGET
This field is an event phase identifier, indicating the target phase,
which means it is being evaluated at the event target.
Number
PROPAGATION_OK
This field is an identifier, indicating that the propagation of the event has
not been stopped.
This is a proprietary member and not part of the W3C interface specification this class implements.
Number
PROPAGATION_STOP
This field is an identifier, indicating that the propagation of the event has
been stopped.
This is a proprietary member and not part of the W3C interface specification this class implements.
Number
PROPAGATION_STOP_IMMEDIATE
This field is an identifier, indicating that the propagation of the event has
been stopped with immediate effect.
This is a proprietary member and not part of the W3C interface specification this class implements.
Boolean
bubbles
This property indicates whether the event is a bubbling event (
true) or
not (false).
Boolean
canBubble
This property indicates whether the event can bubble (
true) or
not (false).
This is a proprietary member and not part of the W3C interface specification this class implements.
Boolean
canSicker
This property indicates whether the event can sicker (whether in the capture
phase, listeners can be iterated from the top down) or not.
This is a proprietary member and not part of the W3C interface specification this class implements.
Boolean
cancelable
This property indicates whether or not an event can have its default action
canceled (prevented). If the default action can
be canceled, the value is
true, otherwise it is false.
nokia.maps.dom.EventTarget
currentTarget
This property indicates the object whose
eventListeners are
currently being processed. This is particularly useful during the capture
and bubbling phases to identify where the event is in the
propagation path.
Boolean
defaultPrevented
This property indicates whether
preventDefault() has been called
for this event.
Number
eventPhase
This property indicates the phase in the event flow the given event has reached.
The value is one of: CAPTURING_PHASE, AT_TARGET, or BUBBLING_PHASE.
String
namespaceURI
This property holds the namespace URI associated with the event or
null
if it is unspecified.
Event
nativeEvent
This property holds a reference to the native DOM event on which the given
normalized event object is based. The property is not W3C-conformant and
is not part of the W3C specification this class implements. It contains
either
null or a reference to the native event as sent by the
browser.
nokia.maps.dom.Page
page
This property holds a reference to the page to which the given event relates.
The property is not part of the W3C interface specifications this class implements.
Number
propagation
This property indicates the status of event propagation.
Its possible values are
PROPAGATION_OK, PROPAGATION_STOP
or PROPAGATION_STOP_IMMEDIATE.
This is a proprietary member and not part of the W3C interface specification this class implements.