com.google.gwt.maps.client.overlay
Class GroundOverlay

java.lang.Object
  extended by com.google.gwt.maps.client.overlay.Overlay
      extended by com.google.gwt.maps.client.overlay.Overlay.ConcreteOverlay
          extended by com.google.gwt.maps.client.overlay.GroundOverlay

public class GroundOverlay
extends Overlay.ConcreteOverlay

A rectangular image overlay whose boundaries are defined by a LatLngBounds. Example:

  MapWidget map; = ...;
  Overlay overlay = new GroundOverlay(url, bounds);
  map.addOverlay(overlay);
 

See Also:
MapWidget.addOverlay(Overlay)

Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.maps.client.overlay.Overlay
Overlay.ConcreteOverlay
 
Field Summary
 
Fields inherited from class com.google.gwt.maps.client.overlay.Overlay
jsoPeer
 
Constructor Summary
GroundOverlay(java.lang.String imageUrl, LatLngBounds bounds)
          Creates a new ground overlay from the given image with the specified size.
 
Method Summary
 void addGroundOverlayVisibilityChangedHandler(GroundOverlayVisibilityChangedHandler handler)
          This event is fired when the visibility of the ground overlay is changed (i.e.
static GroundOverlay createPeer(com.google.gwt.core.client.JavaScriptObject jsoPeer)
           
 boolean isVisible()
          Returns true if the overlay is currently visible.
 void removeGroundOverlayVisibilityChangedHandler(GroundOverlayVisibilityChangedHandler handler)
          Removes a single handler of this map previously added with addGroundOverlayVisibilityChangedHandler(GroundOverlayVisibilityChangedHandler).
 void setVisible(boolean enabled)
          Sets the overlay visible by passing true or hide it b passing false.
 
Methods inherited from class com.google.gwt.maps.client.overlay.Overlay.ConcreteOverlay
copy, initialize, redraw, remove
 
Methods inherited from class com.google.gwt.maps.client.overlay.Overlay
getZIndex
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroundOverlay

public GroundOverlay(java.lang.String imageUrl,
                     LatLngBounds bounds)
Creates a new ground overlay from the given image with the specified size.

Parameters:
imageUrl - the URL of the overlay image
bounds - the rectangle defining the bounds of the overlay
Method Detail

createPeer

public static GroundOverlay createPeer(com.google.gwt.core.client.JavaScriptObject jsoPeer)

addGroundOverlayVisibilityChangedHandler

public void addGroundOverlayVisibilityChangedHandler(GroundOverlayVisibilityChangedHandler handler)
This event is fired when the visibility of the ground overlay is changed (i.e. the visibility is flipped from visible to hidden or vice-versa). The visible parameter refers to the state of the ground overlay after the visibility change has happened.

Parameters:
handler - the handler to call when this event fires.

isVisible

public boolean isVisible()
Returns true if the overlay is currently visible.

Returns:
true if the overlay is currently visible.

removeGroundOverlayVisibilityChangedHandler

public void removeGroundOverlayVisibilityChangedHandler(GroundOverlayVisibilityChangedHandler handler)
Removes a single handler of this map previously added with addGroundOverlayVisibilityChangedHandler(GroundOverlayVisibilityChangedHandler).

Parameters:
handler - the handler to remove

setVisible

public void setVisible(boolean enabled)
Sets the overlay visible by passing true or hide it b passing false.

Parameters:
enabled - sets the overlay visible by passing true or hide it b passing false.