add extjs 6.0.1 sources

[extjs.git] / extjs / packages / legacy / modern / src / device / geolocation / Abstract.js

/**\r
 * @private\r
 */\r
Ext.define('Ext.device.geolocation.Abstract', {\r
    config: {\r
        /**\r
         * @cfg {Number} maximumAge\r
         * This option indicates that the application is willing to accept cached location information whose age\r
         * is no greater than the specified time in milliseconds. If maximumAge is set to 0, an attempt to retrieve\r
         * new location information is made immediately.\r
         */\r
        maximumAge: 0,\r
\r
        /**\r
         * @cfg {Number} frequency The default frequency to get the current position when using {@link Ext.device.Geolocation#watchPosition}.\r
         */\r
        frequency: 10000,\r
\r
        /**\r
         * @cfg {Boolean} allowHighAccuracy True to allow high accuracy when getting the current position.\r
         */\r
        allowHighAccuracy: false,\r
\r
        /**\r
         * @cfg {Number} timeout\r
         * The maximum number of milliseconds allowed to elapse between a location update operation.\r
         */\r
        timeout: Infinity\r
    },\r
\r
    /**\r
     * Attempts to get the current position of this device.\r
     *\r
     *     Ext.device.Geolocation.getCurrentPosition({\r
     *         success: function(position) {\r
     *             console.log(position);\r
     *         },\r
     *         failure: function() {\r
     *             Ext.Msg.alert('Geolocation', 'Something went wrong!');\r
     *         }\r
     *     });\r
     *\r
     * *Note:* If you want to watch the current position, you could use {@link Ext.device.Geolocation#watchPosition} instead.\r
     *\r
     * @param {Object} config An object which contains the following config options:\r
     *\r
     * @param {Function} config.success\r
     * The function to call when the location of the current device has been received.\r
     *\r
     * @param {Object} config.success.position\r
     *\r
     * @param {Function} config.failure\r
     * The function that is called when something goes wrong.\r
     *\r
     * @param {Object} config.scope\r
     * The scope of the `success` and `failure` functions.\r
     *\r
     * @param {Number} config.maximumAge\r
     * The maximum age of a cached location. If you do not enter a value for this, the value of {@link #maximumAge}\r
     * will be used.\r
     *\r
     * @param {Number} config.timeout\r
     * The timeout for this request. If you do not specify a value, it will default to {@link #timeout}.\r
     *\r
     * @param {Boolean} config.allowHighAccuracy\r
     * True to enable allow accuracy detection of the location of the current device. If you do not specify a value, it will\r
     * default to {@link #allowHighAccuracy}.\r
     */\r
    getCurrentPosition: function(config) {\r
        var defaultConfig = Ext.device.geolocation.Abstract.prototype.config;\r
\r
        config = Ext.applyIf(config, {\r
            maximumAge: defaultConfig.maximumAge,\r
            frequency: defaultConfig.frequency,\r
            allowHighAccuracy: defaultConfig.allowHighAccuracy,\r
            timeout: defaultConfig.timeout\r
        });\r
\r
        // <debug>\r
        if (!config.success) {\r
            Ext.Logger.warn('You need to specify a `success` function for #getCurrentPosition');\r
        }\r
        // </debug>\r
\r
        return config;\r
    },\r
\r
    /**\r
     * Watches for the current position and calls the callback when successful depending on the specified {@link #frequency}.\r
     *\r
     *     Ext.device.Geolocation.watchPosition({\r
     *         callback: function(position) {\r
     *             console.log(position);\r
     *         },\r
     *         failure: function() {\r
     *             Ext.Msg.alert('Geolocation', 'Something went wrong!');\r
     *         }\r
     *     });\r
     *\r
     * @param {Object} config An object which contains the following config options:\r
     *\r
     * @param {Function} config.callback\r
     * The function to be called when the position has been updated.\r
     *\r
     * @param {Function} config.failure\r
     * The function that is called when something goes wrong.\r
     *\r
     * @param {Object} config.scope\r
     * The scope of the `success` and `failure` functions.\r
     *\r
     * @param {Boolean} config.frequency\r
     * The frequency in which to call the supplied callback. Defaults to {@link #frequency} if you do not specify a value.\r
     *\r
     * @param {Boolean} config.allowHighAccuracy\r
     * True to enable allow accuracy detection of the location of the current device. If you do not specify a value, it will\r
     * default to {@link #allowHighAccuracy}.\r
     */\r
    watchPosition: function(config) {\r
        var defaultConfig = Ext.device.geolocation.Abstract.prototype.config;\r
\r
        config = Ext.applyIf(config, {\r
            maximumAge: defaultConfig.maximumAge,\r
            frequency: defaultConfig.frequency,\r
            allowHighAccuracy: defaultConfig.allowHighAccuracy,\r
            timeout: defaultConfig.timeout\r
        });\r
\r
        // <debug>\r
        if (!config.callback) {\r
            Ext.Logger.warn('You need to specify a `callback` function for #watchPosition');\r
        }\r
        // </debug>\r
\r
        return config;\r
    },\r
\r
    /**\r
     * If you are currently watching for the current position, this will stop that task.\r
     */\r
    clearWatch: function() {}\r
});\r