com.google.maps.gwt.client
Class Polygon

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

public class Polygon
extends MVCObject

A polygon (like a polyline) defines a series of connected coordinates in an ordered sequence; additionally, polygons form a closed loop and define a filled region. THIS SOURCE CODE IS GENERATED, DO NOT MODIFY


Nested Class Summary
static interface Polygon.ClickHandler
          This event is fired when the DOM click event is fired on the Polygon.
static interface Polygon.DblClickHandler
          This event is fired when the DOM dblclick event is fired on the Polygon.
static interface Polygon.MouseDownHandler
          This event is fired when the DOM mousedown event is fired on the Polygon.
static interface Polygon.MouseMoveHandler
          This event is fired when the DOM mousemove event is fired on the Polygon.
static interface Polygon.MouseOutHandler
          This event is fired on Polygon mouseout.
static interface Polygon.MouseOverHandler
          This event is fired on Polygon mouseover.
static interface Polygon.MouseUpHandler
          This event is fired when the DOM mouseup event is fired on the Polygon.
static interface Polygon.RightClickHandler
          This event is fired when the Polygon is right-clicked on.
 
Constructor Summary
protected Polygon()
          Protected constructor avoids default public constructor.
 
Method Summary
 void addClickListener(Polygon.ClickHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addClickListenerOnce(Polygon.ClickHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addDblClickListener(Polygon.DblClickHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addDblClickListenerOnce(Polygon.DblClickHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseDownListener(Polygon.MouseDownHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseDownListenerOnce(Polygon.MouseDownHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseMoveListener(Polygon.MouseMoveHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseMoveListenerOnce(Polygon.MouseMoveHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseOutListener(Polygon.MouseOutHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseOutListenerOnce(Polygon.MouseOutHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseOverListener(Polygon.MouseOverHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseOverListenerOnce(Polygon.MouseOverHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseUpListener(Polygon.MouseUpHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseUpListenerOnce(Polygon.MouseUpHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addRightClickListener(Polygon.RightClickHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addRightClickListenerOnce(Polygon.RightClickHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 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 clearRightClickListeners()
          Removes all listeners for the given event for the given instance.
static Polygon create()
          Create a polygon using the passed PolygonOptions , which specify the polygon's path, the stroke style for the polygon's edges, and the fill style for the polygon's interior regions.
static Polygon create(PolygonOptions opts)
          Create a polygon using the passed PolygonOptions , which specify the polygon's path, the stroke style for the polygon's edges, and the fill style for the polygon's interior regions.
 boolean getEditable()
          Returns whether this shape can be edited by the user.
 GoogleMap getMap()
          Returns the map on which this shape is attached.
 MVCArray<LatLng> getPath()
          Retrieves the first path.
 MVCArray<MVCArray<LatLng>> getPaths()
          Retrieves the paths for this polygon.
 boolean getVisible()
          Returns whether this poly is visible on the map.
 void setEditable(boolean editable)
          If set to true, the user can edit this shape by dragging the control points shown at the vertices and on each segment.
 void setMap(GoogleMap map)
          Renders this shape on the specified map.
 void setOptions(PolygonOptions options)
           
 void setPath( path)
          Sets the first path.
 void setPath(MVCArray<LatLng> path)
          Sets the first path.
 void setPaths( paths)
          Sets the path for this polygon.
 void setPaths(MVCArray<MVCArray<LatLng>> paths)
          Sets the path for this polygon.
 void setVisible(boolean visible)
          Hides this poly if set to false .
 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 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

Polygon

protected Polygon()
Protected constructor avoids default public constructor.

Method Detail

create

public static Polygon create(PolygonOptions opts)
Create a polygon using the passed PolygonOptions , which specify the polygon's path, the stroke style for the polygon's edges, and the fill style for the polygon's interior regions. A polygon may contain one or more paths, where each path consists of an array of LatLng s. You may pass either an array of LatLngs or an MVCArray of LatLng s when constructing these paths. Arrays are converted to MVCArray s within the polygon upon instantiation.


create

public static Polygon create()
Create a polygon using the passed PolygonOptions , which specify the polygon's path, the stroke style for the polygon's edges, and the fill style for the polygon's interior regions. A polygon may contain one or more paths, where each path consists of an array of LatLng s. You may pass either an array of LatLngs or an MVCArray of LatLng s when constructing these paths. Arrays are converted to MVCArray s within the polygon upon instantiation.


addClickListener

public final void addClickListener(Polygon.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(Polygon.ClickHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addDblClickListener

public final void addDblClickListener(Polygon.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(Polygon.DblClickHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addMouseDownListener

public final void addMouseDownListener(Polygon.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(Polygon.MouseDownHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addMouseMoveListener

public final void addMouseMoveListener(Polygon.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(Polygon.MouseMoveHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addMouseOutListener

public final void addMouseOutListener(Polygon.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(Polygon.MouseOutHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addMouseOverListener

public final void addMouseOverListener(Polygon.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(Polygon.MouseOverHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addMouseUpListener

public final void addMouseUpListener(Polygon.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(Polygon.MouseUpHandler handler)
Like addListener, but the handler removes itself after handling the first event.


addRightClickListener

public final void addRightClickListener(Polygon.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(Polygon.RightClickHandler handler)
Like addListener, but the handler removes itself after handling the first event.


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.


clearRightClickListeners

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


getEditable

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


getMap

public final GoogleMap getMap()
Returns the map on which this shape is attached.


getPath

public final MVCArray<LatLng> getPath()
Retrieves the first path.


getPaths

public final MVCArray<MVCArray<LatLng>> getPaths()
Retrieves the paths for this polygon.


getVisible

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


setEditable

public final void setEditable(boolean editable)
If set to true, the user can edit this shape by dragging the control points shown at the vertices and on each segment.


setMap

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


setOptions

public final void setOptions(PolygonOptions options)

setPath

public final void setPath(MVCArray<LatLng> path)
Sets the first path. See PolylineOptions for more details.


setPath

public final void setPath( path)
Sets the first path. See PolylineOptions for more details.


setPaths

public final void setPaths(MVCArray<MVCArray<LatLng>> paths)
Sets the path for this polygon.


setPaths

public final void setPaths( paths)
Sets the path for this polygon.


setVisible

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


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.


triggerRightClick

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