com.google.code.gwt.geolocation.client.PositionOptions.java Source code

Introduction

Here is the source code for com.google.code.gwt.geolocation.client.PositionOptions.java

Source

/*
 * Copyright 2010 Bart Guijt and others.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.code.gwt.geolocation.client;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * Represents options to configure the {@link Geolocation} operations.
 * 
 * <p>
 * Use {@link #create()} or {@link #getPositionOptions(boolean, int, int)} to
 * create an instance.
 * </p>
 * 
 * @author bguijt
 * 
 * @see <a href="http://www.w3.org/TR/geolocation-API/#position-options">W3C
 *      Geolocation API - PositionOptions interface</a>
 */
public class PositionOptions extends JavaScriptObject {

    protected PositionOptions() {
    }

    /**
     * Creates a new, empty PositionOptions object to use in the
     * {@link Geolocation} functions.
     * 
     * @return a new PositionOptions instance
     */
    public static final PositionOptions create() {
        return JavaScriptObject.createObject().cast();
    }

    public static PositionOptions getPositionOptions(boolean enableHighAccuracy, int timeout, int maximumAge) {
        PositionOptions po = create();
        po.setEnableHighAccuracy(enableHighAccuracy);
        po.setTimeout(timeout);
        po.setMaximumAge(maximumAge);
        return po;
    }

    /**
     * Sets a hint that the application would like to receive the best possible
     * results
     */
    public final native void setEnableHighAccuracy(boolean enableHighAccuracy) /*-{
                                                                               this.enableHighAccuracy = enableHighAccuracy;
                                                                               }-*/;

    /**
     * @return a hint that the application would like to receive the best possible
     *         results
     */
    public final native boolean isEnableHighAccuracy() /*-{
                                                       return this.enableHighAccuracy;
                                                       }-*/;

    /**
     * Sets the maximum length of time (expressed in milliseconds) that is allowed
     * to pass from the the call to
     * {@link Geolocation#getCurrentPosition(PositionCallback)} or
     * {@link Geolocation#watchPosition(PositionCallback)} until the corresponding
     * {@link PositionCallback} is invoked
     */
    public final native void setTimeout(int timeout) /*-{
                                                     this.timeout = timeout;
                                                     }-*/;

    /**
     * @return the maximum length of time (expressed in milliseconds) that is
     *         allowed to pass from the the call to
     *         {@link Geolocation#getCurrentPosition(PositionCallback)} or
     *         {@link Geolocation#watchPosition(PositionCallback)} until the
     *         corresponding {@link PositionCallback} is invoked
     */
    public final native int getTimeout() /*-{
                                         return this.timeout;
                                         }-*/;

    /**
     * Sets the age in milliseconds of a cached position that the application is
     * willing to accept
     */
    public final native void setMaximumAge(int maximumAge) /*-{
                                                           this.maximumAge = maximumAge;
                                                           }-*/;

    /**
     * @return the age in milliseconds of a cached position that the application
     *         is willing to accept
     */
    public final native int getMaximumAge() /*-{
                                            return this.maximumAge;
                                            }-*/;
}