com.google.gwt.maps.client.overlays

Class Polyline

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.google.gwt.maps.client.mvc.MVCObject<Polyline>

com.google.gwt.maps.client.overlays.Polyline

public class Polyline
extends MVCObject<Polyline>

A polyline is a linear overlay of connected line segments on the map. This class extends MVCObject.

See Polyline API Doc

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Polyline() use newInstance();

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addClickHandler(ClickMapHandler handler) This event is fired when the DOM click event is fired on the Polyline.
HandlerRegistration	addDblClickHandler(DblClickMapHandler handler) This event is fired when the DOM dblclick event is fired on the Polyline.
HandlerRegistration	addMouseDownHandler(MouseDownMapHandler handler) This event is fired when the DOM mousedown event is fired on the Polyline.
HandlerRegistration	addMouseMoveHandler(MouseMoveMapHandler handler) This event is fired when the DOM mousemove event is fired on the Polyline.
HandlerRegistration	addMouseOutMoveHandler(MouseOutMapHandler handler) This event is fired on Polyline mouseout.
HandlerRegistration	addMouseOverHandler(MouseOverMapHandler handler) This event is fired on Polyline mouseover.
HandlerRegistration	addMouseUpHandler(MouseUpMapHandler handler) This event is fired when the DOM mouseup event is fired on the Polyline.
HandlerRegistration	addRightClickHandler(RightClickMapHandler handler) This event is fired when the Polyline is right-clicked on.
boolean	getEditable() Returns whether this shape can be edited by the user.
MapWidget	getMap() Returns the map on which this shape is attached.
MVCArray<LatLng>	getPath() Retrieves the first path.
static Polyline	newInstance(PolylineOptions options) 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.
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(MapWidget mapWidget) Renders this shape on the specified map.
void	setOptions(PolylineOptions options) set Options
void	setPath(JsArray<LatLng> path) Sets the first path.
void	setPath(MVCArray<LatLng> path) Sets the first path.

Methods inherited from class com.google.gwt.maps.client.mvc.MVCObject

bindTo, bindTo, bindTo, changed, createInstanceOfMVCObject, get, notify, set, setValues, unbind, unbindAll

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Polyline

protected Polyline()

use newInstance();

Method Detail

newInstance

public static final Polyline newInstance(PolylineOptions options)

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 LatLngs or an MVCArray of LatLngs when constructing a polyline, though simple arrays are converted to MVCArrays within the polyline upon instantiation.

Parameters:

options - PolylineOptions

getEditable

public final boolean getEditable()

Returns whether this shape can be edited by the user.

getMap

public final MapWidget getMap()

Returns the map on which this shape is attached.

getPath

public final MVCArray<LatLng> getPath()

Retrieves the first path.

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.

Parameters:

editable -

setMap

public final void setMap(MapWidget mapWidget)

Renders this shape on the specified map. If map is set to null, the shape will be removed.

Parameters:

mapWidget -

setOptions

public final void setOptions(PolylineOptions options)

set Options

Parameters:

options -

setPath

public final void setPath(MVCArray<LatLng> path)

Sets the first path. See PolylineOptions for more details.

Parameters:

path -

setPath

public final void setPath(JsArray<LatLng> path)

Sets the first path. See PolylineOptions for more details.

Parameters:

path -

addClickHandler

public final HandlerRegistration addClickHandler(ClickMapHandler handler)

This event is fired when the DOM click event is fired on the Polyline.

Parameters:

handler -

addDblClickHandler

public final HandlerRegistration addDblClickHandler(DblClickMapHandler handler)

This event is fired when the DOM dblclick event is fired on the Polyline.

Parameters:

handler -

addMouseDownHandler

public final HandlerRegistration addMouseDownHandler(MouseDownMapHandler handler)

This event is fired when the DOM mousedown event is fired on the Polyline.

Parameters:

handler -

addMouseMoveHandler

public final HandlerRegistration addMouseMoveHandler(MouseMoveMapHandler handler)

This event is fired when the DOM mousemove event is fired on the Polyline.

Parameters:

handler -

addMouseOutMoveHandler

public final HandlerRegistration addMouseOutMoveHandler(MouseOutMapHandler handler)

This event is fired on Polyline mouseout.

Parameters:

handler -

addMouseOverHandler

public final HandlerRegistration addMouseOverHandler(MouseOverMapHandler handler)

This event is fired on Polyline mouseover.

Parameters:

handler -

addMouseUpHandler

public final HandlerRegistration addMouseUpHandler(MouseUpMapHandler handler)

This event is fired when the DOM mouseup event is fired on the Polyline.

Parameters:

handler -

addRightClickHandler

public final HandlerRegistration addRightClickHandler(RightClickMapHandler handler)

This event is fired when the Polyline is right-clicked on.

Parameters:

handler -