com.google.maps.gwt.client
Class Polyline

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

public class Polyline
extends MVCObject

A polyline is a linear overlay of connected line segments on the map. THIS SOURCE CODE IS GENERATED, DO NOT MODIFY


Nested Class Summary
static interface Polyline.ClickHandler
          This event is fired when the DOM click event is fired on the Polyline.
static interface Polyline.DblClickHandler
          This event is fired when the DOM dblclick event is fired on the Polyline.
static interface Polyline.MouseDownHandler
          This event is fired when the DOM mousedown event is fired on the Polyline.
static interface Polyline.MouseMoveHandler
          This event is fired when the DOM mousemove event is fired on the Polyline.
static interface Polyline.MouseOutHandler
          This event is fired on Polyline mouseout.
static interface Polyline.MouseOverHandler
          This event is fired on Polyline mouseover.
static interface Polyline.MouseUpHandler
          This event is fired when the DOM mouseup event is fired on the Polyline.
static interface Polyline.RightClickHandler
          This event is fired when the Polyline is right-clicked on.
 
Constructor Summary
protected Polyline()
          Protected constructor avoids default public constructor.
 
Method Summary
 void addClickListener(Polyline.ClickHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addClickListenerOnce(Polyline.ClickHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addDblClickListener(Polyline.DblClickHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addDblClickListenerOnce(Polyline.DblClickHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseDownListener(Polyline.MouseDownHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseDownListenerOnce(Polyline.MouseDownHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseMoveListener(Polyline.MouseMoveHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseMoveListenerOnce(Polyline.MouseMoveHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseOutListener(Polyline.MouseOutHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseOutListenerOnce(Polyline.MouseOutHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseOverListener(Polyline.MouseOverHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseOverListenerOnce(Polyline.MouseOverHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addMouseUpListener(Polyline.MouseUpHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addMouseUpListenerOnce(Polyline.MouseUpHandler handler)
          Like addListener, but the handler removes itself after handling the first event.
 void addRightClickListener(Polyline.RightClickHandler handler)
          Adds the given listener function to the given event name for the given object instance.
 void addRightClickListenerOnce(Polyline.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 Polyline create()
          Create a polyline using the passed PolylineOptions , which specify both the path of the polyline and the stroke style to use when drawing the polyline.
static Polyline create(PolylineOptions opts)
          Create a polyline using the passed PolylineOptions , which specify both the path of the polyline and the stroke style to use when drawing the polyline.
 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.
 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(PolylineOptions options)
           
 void setPath( path)
          Sets the first path.
 void setPath(MVCArray<LatLng> path)
          Sets the first path.
 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

Polyline

protected Polyline()
Protected constructor avoids default public constructor.

Method Detail

create

public static Polyline create(PolylineOptions opts)
Create a polyline using the passed PolylineOptions , which specify both the path of the polyline and the stroke style to use when drawing the polyline. You may pass either an array of LatLng s or an MVCArray of LatLng s when constructing a polyline, though simple arrays are converted to MVCArray s within the polyline upon instantiation.


create

public static Polyline create()
Create a polyline using the passed PolylineOptions , which specify both the path of the polyline and the stroke style to use when drawing the polyline. You may pass either an array of LatLng s or an MVCArray of LatLng s when constructing a polyline, though simple arrays are converted to MVCArray s within the polyline upon instantiation.


addClickListener

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


addDblClickListener

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


addMouseDownListener

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


addMouseMoveListener

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


addMouseOutListener

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


addMouseOverListener

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


addMouseUpListener

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


addRightClickListener

public final void addRightClickListener(Polyline.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(Polyline.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.


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(PolylineOptions 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.


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.