com.google.gwt.maps.client.base.LatLngBounds Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-maps-api Show documentation
There is a newer version: 3.10.0-alpha-7
package com.google.gwt.maps.client.base;

/*
 * #%L
 * GWT Maps API V3 - Core API
 * %%
 * Copyright (C) 2011 - 2012 GWT Maps API V3
 * %%
 * 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.
 * #L%
 */

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

/**
 * A LatLngBounds instance represents a rectangle in geographical coordinates, including one that crosses the 180
 * degrees longitudinal meridian. 

 * 

 * See LatLngBounds API
 * Doc
 */
public class LatLngBounds extends JavaScriptObject {

  /**
   * A LatLngBounds instance represents a rectangle in geographical coordinates, including one that crosses the 180
   * degrees longitudinal meridian. use newInstance(...);
   */
  protected LatLngBounds() {
  }

  /**
   * creates A LatLngBounds instance represents a rectangle in geographical coordinates, including one that crosses the
   * 180 degrees longitudinal meridian.
   * 
   * @param sw {@link LatLng}
   * @param ne {@link LatLng}
   */
  public final static LatLngBounds newInstance(LatLng sw, LatLng ne) {
    return createJso(sw, ne).cast();
  }

  private final static native JavaScriptObject createJso(LatLng sw, LatLng ne) /*-{
    return new $wnd.google.maps.LatLngBounds(sw, ne);
  }-*/;

  /**
   * Returns true if the given lat/lng is in this bounds.
   * 
   * @param latlng {@link LatLng}
   */
  public final native boolean contains(LatLng latlng) /*-{
    return this.contains(latlng);
  }-*/;

  /**
   * Returns true if this bounds approximately equals the given bounds.
   * 
   * @param other {@link LatLngBounds}
   */
  public final native boolean equals(LatLngBounds other) /*-{
    return this.equals(other);
  }-*/;

  /**
   * Extends this bounds to contain the given point.
   * 
   * @param point {@link LatLng}
   * @return {@link LatLngBounds}
   */
  public final native LatLngBounds extend(LatLng point) /*-{
    return this.extend(point);
  }-*/;

  /**
   * Computes the center of this LatLngBounds
   * 
   * @return {@link LatLng}
   */
  public final native LatLng getCenter() /*-{
    return this.getCenter();
  }-*/;

  /**
   * Returns the north-east corner of this bounds.
   * 
   * @return {@link LatLng}
   */
  public final native LatLng getNorthEast() /*-{
    return this.getNorthEast();
  }-*/;

  /**
   * Returns the south-west corner of this bounds.
   * 
   * @return {@link LatLng}
   */
  public final native LatLng getSouthWest() /*-{
    return this.getSouthWest();
  }-*/;

  /**
   * Returns true if this bounds shares any points with this bounds.
   * 
   * @param other {@link LatLngBounds}
   * @return boolean
   */
  public final native boolean intersects(LatLngBounds other) /*-{
    return this.intersects(other);
  }-*/;

  /**
   * Returns if the bounds are empty.
   * 
   * @return boolean
   */
  public final native boolean isEmpty() /*-{
    return this.isEmpty();
  }-*/;

  /**
   * Converts the given map bounds to a lat/lng span.
   * 
   * @return {@link LatLng}
   */
  public final native LatLng toSpan() /*-{
    return this.toSpan();
  }-*/;

  /**
   * Converts to string.
   * 
   * @return boolean
   */
  public final native String getToString() /*-{
    return this.toString();
  }-*/;

  /**
   * Returns a string of the form "lat_lo,lng_lo,lat_hi,lng_hi" for this bounds, where "lo" corresponds to the southwest
   * corner of the bounding box, while "hi" corresponds to the northeast corner of that box.
   * 
   * @param precision
   * @return String
   */
  public final native String toUrlValue(int precision) /*-{
    return this.toUrlValue(precision);
  }-*/;

  /**
   * Extends this bounds to contain the union of this and the given bounds.
   * 
   * @param other {@link LatLngBounds}
   * @return {@link LatLngBounds}
   */
  public final native LatLngBounds union(LatLngBounds other) /*-{
    return this.union(other);
  }-*/;

}