Observable
  GeoLocation

Class Ext.util.GeoLocation

Package:	Ext.util
Defined In:	GeoLocation.js
Class:	GeoLocation
Extends:	Observable

Provides a cross browser class for retrieving location information.

Based on the Geolocation API Specification.
If the browser does not implement that specification (Internet Explorer 6-8), it can fallback on Google Gears as long as the browser has it installed, and the following javascript file from google is included on the page:

<script type="text/javascript" src="http://code.google.com/apis/gears/gears_init.js"></script>

Note: Location implementations are only required to return timestamp, longitude, latitude, and accuracy.
Other properties (altitude, altitudeAccuracy, heading, speed) can be null or sporadically returned.

When instantiated, by default this class immediately begins tracking location information, firing a locationupdate event when new location information is available. To disable this location tracking (which may be battery intensive on mobile devices), set autoUpdate to false.
When this is done, only calls to updateLocation will trigger a location retrieval.

A locationerror event is raised when an error occurs retrieving the location, either due to a user denying the application access to it, or the browser not supporting it.

The below code shows a GeoLocation making a single retrieval of location information.

var geo = new Ext.util.GeoLocation({
    autoUpdate: false,
    listeners: {
        locationupdate: function (geo) {
            alert('New latitude: ' + geo.latitude);
        },
        locationerror: function (   geo,
                                    bTimeout, 
                                    bPermissionDenied, 
                                    bLocationUnavailable, 
                                    message) {
            if(bTimeout){
                alert('Timeout occurred.');
            }
            else{
                alert('Error occurred.');
            }
        }
    }
});
geo.updateLocation();

Config Options

Config Options		Defined By
	allowHighAccuracy : Boolean Defaults to false. When set to true, provide a hint that the application would like to receive the best possible res... Defaults to false. When set to true, provide a hint that the application would like to receive the best possible results. This may result in slower response times or increased power consumption. The user might also deny this capability, or the device might not be able to provide more accurate results than if this option was set to false.	GeoLocation
	autoUpdate : Boolean Defaults to true. When set to true, continually monitor the location of the device (beginning immediately) and fire l... Defaults to true. When set to true, continually monitor the location of the device (beginning immediately) and fire locationupdate/locationerror events. When using google gears, if the user denies access or another error occurs, this will be reset to false.	GeoLocation
	listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should ... A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once. DOM events from ExtJs Components While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's `click` event passing the node clicked on. To access DOM events directly from a a child element of a Component, we need to specify this explicitly: `new Ext.Panel({ width: 400, height: 200, dockedItems: [{ xtype: 'toolbar' }], listeners: { click: { element: 'el', //bind to the underlying el property on the panel fn: function(){ console.log('click el'); } }, dblclick: { element: 'body', //bind to the underlying body property on the panel fn: function(){ console.log('dblclick body'); } } } });`	Observable
	maximumAge : Number Defaults to 0. This option indicates that the application is willing to accept cached location information whose age ... Defaults to 0. This option indicates that the application is willing to accept cached location information whose age is no greater than the specified time in milliseconds. If maximumAge is set to 0, an attempt to retrieve new location information is made immediately. Setting the maximumAge to Infinity returns a cached position regardless of its age. If the device does not have cached location information available whose age is no greater than the specified maximumAge, then it must acquire new location information. For example, if location information no older than 10 minutes is required, set this property to 600000.	GeoLocation
	timeout : Number Defaults to Infinity. The maximum number of milliseconds allowed to elapse between a location update operation and th... Defaults to Infinity. The maximum number of milliseconds allowed to elapse between a location update operation and the corresponding locationupdate event being raised. If a location was not successfully acquired before the given timeout elapses (and no other internal errors have occurred in this interval), then a locationerror event will be raised indicating a timeout as the cause. Note that the time that is spent obtaining the user permission is not included in the period covered by the timeout. The timeout attribute only applies to the location acquisition operation. In the case of calling updateLocation, the locationerror event will be raised only once. If autoUpdate is set to true, the locationerror event could be raised repeatedly. The first timeout is relative to the moment autoUpdate was set to true (or this Ext.util.GeoLocation was initialized with the autoUpdate config option set to true). Subsequent timeouts are relative to the moment when the device determines that it's position has changed.	GeoLocation

Public Properties

Property		Defined By
	accuracy : Number Read-only property representing the last retrieved accuracy level of the latitude and longitude coordinates, specif... Read-only property representing the last retrieved accuracy level of the latitude and longitude coordinates, specified in meters. This will always be a non-negative number. This corresponds to a 95% confidence level.	GeoLocation
	altitude : Number/null Read-only property representing the last retrieved height of the position, specified in meters above the ellipsoid <... Read-only property representing the last retrieved height of the position, specified in meters above the ellipsoid [WGS84].	GeoLocation
	altitudeAccuracy : Number/null Read-only property representing the last retrieved accuracy level of the altitude coordinate, specified in meters. I... Read-only property representing the last retrieved accuracy level of the altitude coordinate, specified in meters. If altitude is not null then this will be a non-negative number. Otherwise this returns null. This corresponds to a 95% confidence level.	GeoLocation
	heading : Number/null Read-only property representing the last retrieved direction of travel of the hosting device, specified in non-nega... Read-only property representing the last retrieved direction of travel of the hosting device, specified in non-negative degrees between 0 and 359, counting clockwise relative to the true north. If speed is 0 (device is stationary), then this returns NaN	GeoLocation
	latitude : Number Read-only property representing the last retrieved geographical coordinate specified in degrees.	GeoLocation
	longitude : Number Read-only property representing the last retrieved geographical coordinate specified in degrees.	GeoLocation
	speed : Number/null Read-only property representing the last retrieved current ground speed of the device, specified in meters per secon... Read-only property representing the last retrieved current ground speed of the device, specified in meters per second. If this feature is unsupported by the device, this returns null. If the device is stationary, this returns 0, otherwise it returns a non-negative number.	GeoLocation
	timestamp : Date Read-only property representing when the last retrieved positioning information was acquired by the device.	GeoLocation

Public Methods

Method		Defined By
	addEvents( `Object\|String o`, `string Optional.` ) : void Adds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters: `o` : Object\|String Either an object with event names as properties with a value of `true` or the first event name string if multiple event names are being passed as separate parameters. `Optional.` : string Event name if multiple event names are being passed as separate parameters. Usage: `this.addEvents('storeloaded', 'storecleared');` Returns: void	Observable
	addListener( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this object. Appends an event handler to this object. Parameters: `eventName` : String The name of the event to listen for. `handler` : Function The method the event invokes. `scope` : Object (optional) The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. `options` : Object (optional) An object containing handler configuration. properties. This may contain any of the following properties: scope : Object The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. delay : Number The number of milliseconds to delay the invocation of the handler after the event fires. single : Boolean True to add a handler to handle just the next firing of the event, and then remove itself. buffer : Number Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. target : Observable Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable. element : String The element reference on the component to bind the event to. This is used to bind DOM events to underlying elements on Components. - This option is only valid for listeners bound to Components Combining Options Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener. `myPanel.on('hide', this.onClick, this, { single: true, delay: 100 });` Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. Returns: void	Observable
	addManagedListener( `Observable\|Element item`, `Object\|String ename`, `Function fn`, `Object scope`, `Object opt` ) : void Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed... Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed. Parameters: `item` : Observable\|Element The item to which to add a listener/listeners. `ename` : Object\|String The event name, or an object containing event name properties. `fn` : Function Optional. If the `ename` parameter was an event name, this is the handler function. `scope` : Object Optional. If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed. `opt` : Object Optional. If the `ename` parameter was an event name, this is the addListener options. Returns: void	Observable
	clearListeners() : void Removes all listeners for this object including the managed listeners Removes all listeners for this object including the managed listeners Parameters: None. Returns: void	Observable
	clearManagedListeners() : void Removes all managed listeners for this object. Removes all managed listeners for this object. Parameters: None. Returns: void	Observable
	enableBubble( `String/Array events` ) : void Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling `this.getBubbleTarget()` if present. There is no implementation in the Observable base class. This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly. Example: Ext.override(Ext.form.Field, { // Add functionality to Field's initComponent to enable the change event to bubble initComponent : Ext.createSequence(Ext.form.Field.prototype.initComponent, function() { this.enableBubble('change'); }), // We know that we want Field's events to bubble directly to the FormPanel. getBubbleTarget : function() { if (!this.formPanel) { this.formPanel = this.findParentByType('form'); } return this.formPanel; } }); var myForm = new Ext.formPanel({ title: 'User Details', items: [{ ... }], listeners: { change: function() { // Title goes red if form has been modified. myForm.header.setStyle('color', 'red'); } } }); Parameters: `events` : String/Array The event name to bubble, or an Array of event names. Returns: void	Observable
	fireEvent( `String eventName`, `Object... args` ) : Boolean Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble. Parameters: `eventName` : String The name of the event to fire. `args` : Object... Variable number of parameters are passed to handlers. Returns: `Boolean` returns false if any of the handlers return false otherwise it returns true.	Observable
	hasListener( `String eventName` ) : Boolean Checks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters: `eventName` : String The name of the event to check for Returns: `Boolean` True if the event is being listened for, else false	Observable
	on( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. `options` : Object (optional) An object containing handler configuration. Returns: void	Observable
	relayEvents( `Object o`, `Array events` ) : void Relays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by `this`. Parameters: `o` : Object The Observable whose events this object is to relay. `events` : Array Array of event names to relay. Returns: void	Observable
	removeListener( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes an event handler. Removes an event handler. Parameters: `eventName` : String The type of event the handler was associated with. `handler` : Function The handler to remove. This must be a reference to the function passed into the addListener call. `scope` : Object (optional) The scope originally specified for the handler. Returns: void	Observable
	removeManagedListener( `Observable\|Element item`, `Object\|String ename`, `Function fn`, `Object scope` ) : void Removes listeners that were added by the mon method. Removes listeners that were added by the mon method. Parameters: `item` : Observable\|Element The item from which to remove a listener/listeners. `ename` : Object\|String The event name, or an object containing event name properties. `fn` : Function Optional. If the `ename` parameter was an event name, this is the handler function. `scope` : Object Optional. If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed. Returns: void	Observable
	resumeEvents() : void Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event... Resume firing events. (see suspendEvents) If events were suspended using the `queueSuspended` parameter, then all events fired during event suspension will be sent to any listeners now. Parameters: None. Returns: void	Observable
	setAllowHighAccuracy( `Number allowHighAccuracy` ) : void Changes the allowHighAccuracy option and restarts any active location monitoring with the updated setting. Changes the allowHighAccuracy option and restarts any active location monitoring with the updated setting. Parameters: `allowHighAccuracy` : Number The value to set the allowHighAccuracy option to. Returns: void	GeoLocation
	setAutoUpdate( `Boolean autoUpdate` ) : Boolean Enabled/disables the auto-retrieval of the location information. If called with autoUpdate=true, it will execute an i... Enabled/disables the auto-retrieval of the location information. If called with autoUpdate=true, it will execute an immediate location update and continue monitoring for location updates. If autoUpdate=false, any current location change monitoring will be disabled. Parameters: `autoUpdate` : Boolean Whether to start/stop location monitoring. Returns: `Boolean` If enabling autoUpdate, returns false if the location tracking cannot begin due to an error supporting geolocation. A locationerror event is also fired.	GeoLocation
	setMaximumAge( `Number maximumAge` ) : void Changes the maximumAge option and restarts any active location monitoring with the updated setting. Changes the maximumAge option and restarts any active location monitoring with the updated setting. Parameters: `maximumAge` : Number The value to set the maximumAge option to. Returns: void	GeoLocation
	setTimeout( `Number timeout` ) : void Changes the timeout option and restarts any active location monitoring with the updated setting. Changes the timeout option and restarts any active location monitoring with the updated setting. Parameters: `timeout` : Number The value to set the timeout option to. Returns: void	GeoLocation
	suspendEvents( `Boolean queueSuspended` ) : void Suspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters: `queueSuspended` : Boolean Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events; Returns: void	Observable
	un( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters: `eventName` : String The type of event the handler was associated with. `handler` : Function The handler to remove. This must be a reference to the function passed into the addListener call. `scope` : Object (optional) The scope originally specified for the handler. Returns: void	Observable
	updateLocation( `Function callback`, [`Object scope`] ) : void Executes a onetime location update operation, raising either a locationupdate or locationerror event. Does not inter... Executes a onetime location update operation, raising either a locationupdate or locationerror event. Does not interfere with or restart ongoing location monitoring. Parameters: `callback` : Function A callback method to be called when the location retrieval has been completed. Will be called on both success and failure. The method will be passed one parameter, Ext.GeoLocation (this reference), set to null on failure. `geo.updateLocation(function (geo) { alert('Latitude: ' + (geo != null ? geo.latitude : 'failed')); });` `scope` : Object (optional) (optional) The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event. Returns: void	GeoLocation

Public Events

Event		Defined By
	locationerror : ( `Ext.util.GeoLocation this`, `Boolean timeout`, `Boolean permissionDenied`, `Boolean locationUnavailable`, `String message` ) Raised when a location retrieval operation failed. In the case of calling updateLocation, this event will be raised o... Raised when a location retrieval operation failed. In the case of calling updateLocation, this event will be raised only once. If autoUpdate is set to true, this event could be raised repeatedly. The first error is relative to the moment autoUpdate was set to true (or this Ext.util.GeoLocation was initialized with the autoUpdate config option set to true). Subsequent errors are relative to the moment when the device determines that it's position has changed. Listeners will be called with the following arguments: `this` : Ext.util.GeoLocation `timeout` : Boolean Boolean indicating a timeout occurred `permissionDenied` : Boolean Boolean indicating the user denied the location request `locationUnavailable` : Boolean Boolean indicating that the location of the device could not be determined. For instance, one or more of the location providers used in the location acquisition process reported an internal error that caused the process to fail entirely. `message` : String An error message describing the details of the error encountered. This attribute is primarily intended for debugging and should not be used directly in an application user interface.	GeoLocation
	locationupdate : ( `Ext.util.GeoLocation this` ) Raised when a location retrieval operation has been completed successfully. Raised when a location retrieval operation has been completed successfully. Listeners will be called with the following arguments: `this` : Ext.util.GeoLocation Retrieve the current location information from the GeoLocation object by using the read-only properties latitude, longitude, accuracy, altitude, altitudeAccuracy, heading, and speed.	GeoLocation