com.google.maps.gwt.client
Class Circle

java.lang.Object
  extended by JavaScriptObject
      extended by com.google.maps.gwt.client.MVCObject
          extended by com.google.maps.gwt.client.Circle

public class Circle
extends MVCObject

A circle on the Earth's surface; also known as a "spherical cap". THIS SOURCE CODE IS GENERATED, DO NOT MODIFY


Nested Class Summary
static interface Circle.CenterChangedHandler
          This event is fired when the circle's center is changed.
static interface Circle.ClickHandler
          This event is fired when the DOM click event is fired on the circle.
static interface Circle.DblClickHandler
          This event is fired when the DOM dblclick event is fired on the circle.
static interface Circle.MouseDownHandler
          This event is fired when the DOM mousedown event is fired on the circle.
static interface Circle.MouseMoveHandler
          This event is fired when the DOM mousemove event is fired on the circle.
static interface Circle.MouseOutHandler
          This event is fired on circle mouseout.
static interface Circle.MouseOverHandler
          This event is fired on circle mouseover.
static interface Circle.MouseUpHandler
          This event is fired when the DOM mouseup event is fired on the circle.
static interface Circle.RadiusChangedHandler
          This event is fired when the circle's radius is changed.
static interface Circle.RightClickHandler
          This event is fired when the circle is right-clicked on.
 
Constructor Summary
protected Circle()
          Protected constructor avoids default public constructor.
 
Method Summary
 void addCenterChangedListener(Circle.CenterChangedHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addCenterChangedListenerOnce(Circle.CenterChangedHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addClickListener(Circle.ClickHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addClickListenerOnce(Circle.ClickHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addDblClickListener(Circle.DblClickHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addDblClickListenerOnce(Circle.DblClickHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseDownListener(Circle.MouseDownHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseDownListenerOnce(Circle.MouseDownHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseMoveListener(Circle.MouseMoveHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseMoveListenerOnce(Circle.MouseMoveHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseOutListener(Circle.MouseOutHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseOutListenerOnce(Circle.MouseOutHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseOverListener(Circle.MouseOverHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseOverListenerOnce(Circle.MouseOverHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseUpListener(Circle.MouseUpHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseUpListenerOnce(Circle.MouseUpHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addRadiusChangedListener(Circle.RadiusChangedHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addRadiusChangedListenerOnce(Circle.RadiusChangedHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addRightClickListener(Circle.RightClickHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addRightClickListenerOnce(Circle.RightClickHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void clearCenterChangedListeners()
          Removes all listeners for the given event for the given instance.
 void clearClickListeners()
          Removes all listeners for the given event for the given instance.
 void clearDblClickListeners()
          Removes all listeners for the given event for the given instance.
 void clearInstanceListeners()
          Removes all listeners for all events for the given instance.
 void clearMouseDownListeners()
          Removes all listeners for the given event for the given instance.
 void clearMouseMoveListeners()
          Removes all listeners for the given event for the given instance.
 void clearMouseOutListeners()
          Removes all listeners for the given event for the given instance.
 void clearMouseOverListeners()
          Removes all listeners for the given event for the given instance.
 void clearMouseUpListeners()
          Removes all listeners for the given event for the given instance.
 void clearRadiusChangedListeners()
          Removes all listeners for the given event for the given instance.
 void clearRightClickListeners()
          Removes all listeners for the given event for the given instance.
static Circle create()
          Create a circle using the passed CircleOptions , which specify the center, radius, and style.
static Circle create(CircleOptions opts)
          Create a circle using the passed CircleOptions , which specify the center, radius, and style.
 LatLngBounds getBounds()
          Gets the LatLngBounds of this Circle.
 LatLng getCenter()
          Returns the center of this circle.
 boolean getEditable()
          Returns whether this circle can be edited by the user.
 GoogleMap getMap()
          Returns the map on which this circle is displayed.
 double getRadius()
          Returns the radius of this circle (in meters).
 boolean getVisible()
          Returns whether this circle is visible on the map.
 void setCenter(LatLng center)
          Sets the center of this circle.
 void setEditable(boolean editable)
          If set to true, the user can edit this circle by dragging the control points shown at the center and around the circumference of the circle.
 void setMap(GoogleMap map)
          Renders the circle on the specified map.
 void setOptions(CircleOptions options)
           
 void setRadius(double radius)
          Sets the radius of this circle (in meters).
 void setVisible(boolean visible)
          Hides this circle if set to false .
 void triggerCenterChanged(JavaScriptObject... varargs)
          Triggers the given event.
 void triggerClick(JavaScriptObject... varargs)
          Triggers the given event.
 void triggerDblClick(JavaScriptObject... varargs)
          Triggers the given event.
 void triggerMouseDown(JavaScriptObject... varargs)
          Triggers the given event.
 void triggerMouseMove(JavaScriptObject... varargs)
          Triggers the given event.
 void triggerMouseOut(JavaScriptObject... varargs)
          Triggers the given event.
 void triggerMouseOver(JavaScriptObject... varargs)
          Triggers the given event.
 void triggerMouseUp(JavaScriptObject... varargs)
          Triggers the given event.
 void triggerRadiusChanged(JavaScriptObject... varargs)
          Triggers the given event.
 void triggerRightClick(JavaScriptObject... varargs)
          Triggers the given event.
 
Methods inherited from class com.google.maps.gwt.client.MVCObject
bindTo, bindTo, bindTo, bindTo, changed, get, notify, set, setValues, setValues, unbind, unbindAll
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Circle

protected Circle()
Protected constructor avoids default public constructor.

Method Detail

create

public static Circle create(CircleOptions opts)
Create a circle using the passed CircleOptions , which specify the center, radius, and style.


create

public static Circle create()
Create a circle using the passed CircleOptions , which specify the center, radius, and style.


addCenterChangedListener

public final void addCenterChangedListener(Circle.CenterChangedHandler handler)
Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().


addCenterChangedListenerOnce

public final void addCenterChangedListenerOnce(Circle.CenterChangedHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addClickListener

public final void addClickListener(Circle.ClickHandler handler)
Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().


addClickListenerOnce

public final void addClickListenerOnce(Circle.ClickHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addDblClickListener

public final void addDblClickListener(Circle.DblClickHandler handler)
Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().


addDblClickListenerOnce

public final void addDblClickListenerOnce(Circle.DblClickHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addMouseDownListener

public final void addMouseDownListener(Circle.MouseDownHandler handler)
Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().


addMouseDownListenerOnce

public final void addMouseDownListenerOnce(Circle.MouseDownHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addMouseMoveListener

public final void addMouseMoveListener(Circle.MouseMoveHandler handler)
Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().


addMouseMoveListenerOnce

public final void addMouseMoveListenerOnce(Circle.MouseMoveHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addMouseOutListener

public final void addMouseOutListener(Circle.MouseOutHandler handler)
Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().


addMouseOutListenerOnce

public final void addMouseOutListenerOnce(Circle.MouseOutHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addMouseOverListener

public final void addMouseOverListener(Circle.MouseOverHandler handler)
Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().


addMouseOverListenerOnce

public final void addMouseOverListenerOnce(Circle.MouseOverHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addMouseUpListener

public final void addMouseUpListener(Circle.MouseUpHandler handler)
Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().


addMouseUpListenerOnce

public final void addMouseUpListenerOnce(Circle.MouseUpHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addRadiusChangedListener

public final void addRadiusChangedListener(Circle.RadiusChangedHandler handler)
Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().


addRadiusChangedListenerOnce

public final void addRadiusChangedListenerOnce(Circle.RadiusChangedHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addRightClickListener

public final void addRightClickListener(Circle.RightClickHandler handler)
Adds the given listener function to the given event name for the given object instance. Returns an identifier for this listener that can be used with removeListener().


addRightClickListenerOnce

public final void addRightClickListenerOnce(Circle.RightClickHandler handler)
Like addListener, but the handler removes itself after handling the first event.


clearCenterChangedListeners

public final void clearCenterChangedListeners()
Removes all listeners for the given event for the given instance.


clearClickListeners

public final void clearClickListeners()
Removes all listeners for the given event for the given instance.


clearDblClickListeners

public final void clearDblClickListeners()
Removes all listeners for the given event for the given instance.


clearInstanceListeners

public final void clearInstanceListeners()
Removes all listeners for all events for the given instance.


clearMouseDownListeners

public final void clearMouseDownListeners()
Removes all listeners for the given event for the given instance.


clearMouseMoveListeners

public final void clearMouseMoveListeners()
Removes all listeners for the given event for the given instance.


clearMouseOutListeners

public final void clearMouseOutListeners()
Removes all listeners for the given event for the given instance.


clearMouseOverListeners

public final void clearMouseOverListeners()
Removes all listeners for the given event for the given instance.


clearMouseUpListeners

public final void clearMouseUpListeners()
Removes all listeners for the given event for the given instance.


clearRadiusChangedListeners

public final void clearRadiusChangedListeners()
Removes all listeners for the given event for the given instance.


clearRightClickListeners

public final void clearRightClickListeners()
Removes all listeners for the given event for the given instance.


getBounds

public final LatLngBounds getBounds()
Gets the LatLngBounds of this Circle.


getCenter

public final LatLng getCenter()
Returns the center of this circle.


getEditable

public final boolean getEditable()
Returns whether this circle can be edited by the user.


getMap

public final GoogleMap getMap()
Returns the map on which this circle is displayed.


getRadius

public final double getRadius()
Returns the radius of this circle (in meters).


getVisible

public final boolean getVisible()
Returns whether this circle is visible on the map.


setCenter

public final void setCenter(LatLng center)
Sets the center of this circle.


setEditable

public final void setEditable(boolean editable)
If set to true, the user can edit this circle by dragging the control points shown at the center and around the circumference of the circle.


setMap

public final void setMap(GoogleMap map)
Renders the circle on the specified map. If map is set to null, the circle will be removed.


setOptions

public final void setOptions(CircleOptions options)

setRadius

public final void setRadius(double radius)
Sets the radius of this circle (in meters).


setVisible

public final void setVisible(boolean visible)
Hides this circle if set to false .


triggerCenterChanged

public final void triggerCenterChanged(JavaScriptObject... varargs)
Triggers the given event. All arguments after eventName are passed as arguments to the listeners.


triggerClick

public final void triggerClick(JavaScriptObject... varargs)
Triggers the given event. All arguments after eventName are passed as arguments to the listeners.


triggerDblClick

public final void triggerDblClick(JavaScriptObject... varargs)
Triggers the given event. All arguments after eventName are passed as arguments to the listeners.


triggerMouseDown

public final void triggerMouseDown(JavaScriptObject... varargs)
Triggers the given event. All arguments after eventName are passed as arguments to the listeners.


triggerMouseMove

public final void triggerMouseMove(JavaScriptObject... varargs)
Triggers the given event. All arguments after eventName are passed as arguments to the listeners.


triggerMouseOut

public final void triggerMouseOut(JavaScriptObject... varargs)
Triggers the given event. All arguments after eventName are passed as arguments to the listeners.


triggerMouseOver

public final void triggerMouseOver(JavaScriptObject... varargs)
Triggers the given event. All arguments after eventName are passed as arguments to the listeners.


triggerMouseUp

public final void triggerMouseUp(JavaScriptObject... varargs)
Triggers the given event. All arguments after eventName are passed as arguments to the listeners.


triggerRadiusChanged

public final void triggerRadiusChanged(JavaScriptObject... varargs)
Triggers the given event. All arguments after eventName are passed as arguments to the listeners.


triggerRightClick

public final void triggerRightClick(JavaScriptObject... varargs)
Triggers the given event. All arguments after eventName are passed as arguments to the listeners.