- 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.
Interface ovi.mapsapi.dom.MouseEventTarget
This class is a virtual interface that does only exist for documentational purpose. Each class implementing
this interface will delcare that it is able to be the target of certain events. Each event in this interface
(and therefore as well within the class implementing that interface) describes an event of a specific type.
The following example will show event handling at the example of an event of the type click:
// Note that "obj" can be either a DOM node or any other JavaScript object.
var obj = ovi.mapsapi.dom.EventTarget( {} );
obj.addListener("click", function(evt) {
console.log("This is the '"+evt.type+"' event!");
});
obj.dispatch( new ovi.mapsapi.dom.Event({
type: "click"
});
As you can see the event click doesn't mean that there is a method click that is called,
but rather that an event of the type click is fired and dispatched to all listeners registered
with the object that is the target of the event.
For more information about event dispatching please read the documentation of the ovi.mapsapi.dom.EventTarget class!
| {ovi.mapsapi.dom.MouseEvent} | evt | The event object of this event. |
| {ovi.mapsapi.dom.MouseEvent} | evt | The event object of this event. |
| {ovi.mapsapi.dom.MouseEvent} | evt | The event object of this event. |
| {ovi.mapsapi.dom.MouseEvent} | evt | The event object of this event. |
The difference of the mouseenter and mouseleave events compared to the
mouseover and mouseout events is, that there can be multiple mouseenter
events without even one mouseleave event. This happens e.g. if you have a DIV tag of a size of
100x100 pixel which contains an centered image with a size of 50x50 pixel. When the mousecursor enters the outer
DIV tag it receive a mouseover and a mouseenter event (note that the order is not
guaranteed). However, if the mouse cursor is moved forward into the image now the outer DIV tag will receive
a mouseout event, because the visual area of the outer DIV is left and the image will receive
a mouseover event, because the visial area of the image is entered. Additionally the image will
receive a mouseenter event, but the outer DIV will not receive an mouseleave
event, because the physical area of the outer DIV tag is not left.
Therefore mouseenter and mouseleave events are e.g. very helpfull to build tooltips
which are going to apear right below the mouse cursor or to show overlay information as long as the mouse cursor
is above a specific area that contains child nodes.
| {ovi.mapsapi.dom.MouseEvent} | evt | The event object of this event. |
The difference of the mouseenter and mouseleave events compared to the
mouseover and mouseout events is, that there can be multiple mouseenter
events without even one mouseleave event. This happens e.g. if you have a DIV tag of a size of
100x100 pixel which contains an centered image with a size of 50x50 pixel. When the mousecursor enters the outer
DIV tag it receive a mouseover and a mouseenter event (note that the order is not
guaranteed). However, if the mouse cursor is moved forward into the image now the outer DIV tag will receive
a mouseout event, because the visual area of the outer DIV is left and the image will receive
a mouseover event, because the visial area of the image is entered. Additionally the image will
receive a mouseenter event, but the outer DIV will not receive an mouseleave
event, because the physical area of the outer DIV tag is not left.
Therefore mouseenter and mouseleave events are e.g. very helpfull to build tooltips
which are going to apear right below the mouse cursor or to show overlay information as long as the mouse cursor
is above a specific area that contains child nodes.
| {ovi.mapsapi.dom.MouseEvent} | evt | The event object of this event. |
| {ovi.mapsapi.dom.MouseEvent} | evt | The event object of this event. |
| {ovi.mapsapi.dom.MouseEvent} | evt | The event object of this event. |
| {ovi.mapsapi.dom.MouseEvent} | evt | The event object of this event. |
| {ovi.mapsapi.dom.MouseEvent} | evt | The event object of this event. |
| {ovi.mapsapi.dom.WheelEvent} | evt | The event object of this event. |