- 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 ovi.mapsapi.map.component.ZoomBar
Class Summary
Defines and controls a control panel to zoom the map. The implementation varies between the web and device versions. In the web version, the zoom bar consists of a slider and two button (+ & -) to change the map's zoom levels incrementally. Additionally, there are four zoom level bookmark buttons that allow for setting predefined zoom levels. In the device version, no slider is present. Only the two incremental zoom buttons and the zoom bookmarks are present in this version.
Extends
ovi.mapsapi.ui.UIComponent.
Method Summary
addListener
(type, listener, useCapture)
: Object
Registers an event listener, depending on the useCapture parameter, on the capture phase of the event flow or its target and bubbling phases.
addListenerNS
(namespaceURI, type, listener, useCapture)
: ovi.mapsapi.dom.EventTarget
Registers an event listener, depending on the useCapture parameter, on the capture phase of the event flow or its target and bubbling phases.
addObserver
(key, callback, [context])
: ovi.mapsapi.util.OObject
Register an observer for a property.
attach
(mapDisplay)
Will be called when this component gets added to a map display.
attach
(mapDisplay)
Callback method that is invoked when the component is attached to a map.
build
()
Creates all DomElements and other entities which must created to generate a visual appearance.
collapse
()
Shortcut function for set("expanded", false).
detach
(mapDisplay)
Will be called when this component gets removed from a map display.
detach
(mapDisplay)
Callback method that is invoked when the component is detached from a map.
disableDrag
()
: ovi.mapsapi.dom.EventTarget
Disable the dragging of this event target, disallowing this event target to receive
dragstart, drag and dragend events.
disableUserSelect
()
: ovi.mapsapi.dom.EventTarget
Forbids the user to select text and elements within the event target and prevents the magnifier at the iPhone or other similar mobile devices.
dispatch
(evt)
: Boolean
Dispatches an event.
doc
()
: DomDocument
Returns the DomDocument instance this UI component MUST use for creating DomElements at run time.
enableDrag
()
: ovi.mapsapi.dom.EventTarget
Enable the dragging of this event target and disables the user selection, allowing this event target to receive
dragstart, drag and dragend events.
enableUserSelect
()
: ovi.mapsapi.dom.EventTarget
Allows the user to select text and elements within the event target and allows the magnifier at the iPhone or other similar mobile devices.
expand
()
Shortcut function for set("expanded", true).
expandedSetter
(expanded)
Will be called when this UI component's expansion state gets changed.
findElement
(cssClassName, [node])
Returns the first element within the component's root node, that has the passed css class assigned.
get
(key)
: Variant
Returns the value of the property with the given name.
getClippingNode
()
: DomElement
Returns the node containing all UI component's dom elements which get clipped automatically.
getId
()
: String
Returns a unique identifier of the component.
getRootNode
()
: DomElement
Returns the node containing all UI component's dom elements.
getSize
([node])
: Object
Returns the height and width of a given node or, by default, the UIComponent system's root node.
getVersion
()
: String
Returns the version of the component.
hide
()
Shortcut function for set("hidden", true).
hitTest
(pageX, pageY)
: Boolean
Tests if the given x/y position relative to the document lies within the outer bounding box of this node.
insertListener
(type, listener, useCapture)
: Object
Registers an event listener as first listener in the listener chain, depending on the useCapture parameter, on the capture phase of the event flow or its target and bubbling phases.
insertListenerNS
(namespaceURI, type, listener, useCapture)
: ovi.mapsapi.dom.EventTarget
Registers an event listener as first listener in the listener chain, depending on the useCapture parameter, on the capture phase of the event flow or its target and bubbling phases.
queryReference
()
: ovi.mapsapi.map.component.Component
Queries a new reference to this component.
releaseReference
()
: Number
Release a reference to this component and return the new updated reference count.
remove
(key)
: ovi.mapsapi.util.OObject
Removes the property with the given name.
removeListener
(type, listener, useCapture)
: ovi.mapsapi.dom.EventTarget
Removes an event listener.
removeListenerNS
(namespaceURI, type, listener, useCapture)
: ovi.mapsapi.dom.EventTarget
Removes an event listener.
removeObserver
(key, callback, context)
: ovi.mapsapi.util.OObject
Remove an observer from a key.
set
(nameOrObject, [value, [force]])
: ovi.mapsapi.util.OObject
Set the value(s) of a property or properties of given name(s) to given value(s).
show
()
Shortcut function for set("hidden", false).
Field Summary
Boolean
draggable
True if this event target is draggable and may receive a
dragstart, drag and dragend events; false otherwise.
Object
eventListener
Either undefined or a hashtable that contains for every event type an array with the values: (listener, useCapture, namespaceURI)(, listener, useCapture, namespaceURI)(,…)
Boolean
expanded
Indicates whether this component is in an expanded state
Boolean
hidden
Indicates whether this component is hidden
Boolean
isEventTarget
A property to indicate that an object implements the ovi.mapsapi.dom.EventTarget interface.
ovi.mapsapi.map.Display
mapDisplay
A reference to the map to which this component belongs.
ovi.mapsapi.dom.EventTarget
parentNode
If this property is set, it shall refer to the parent event target.
Object
parentNodes
If this property is set, it shall be a hash table that contains as key the "namespaceURI" for which the assigned value is the parent event target.
Direct Inheritance
Inherited from ovi.mapsapi.ui.UIComponent:
attach
build
collapse
detach
doc
expand
expandedSetter
findElement
getClippingNode
getRootNode
getSize
hide
show
expanded
hidden
Indirect Inheritance
Inherited from ovi.mapsapi.map.component.Component:
attach
detach
getId
getVersion
queryReference
releaseReference
mapDisplay
Constructor Detail
The constructor of all UIComponents. It must be called by all implementing subclasses. Example of how to extend / implement a UIComponent:
new ovi.mapsapi.ui.UIComponent([props])
Parameters:
| {Object} | [props]: | an object which can contain properties / methods which should be appended to instances of this class. It can be used to extend a component. |