com.teamdev.jxmaps

Class Polygon

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.Polygon

All Implemented Interfaces:

java.lang.Cloneable

public class Polygon
extends MapObject

Represents 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.

Constructor Summary

Constructors

Constructor and Description
Polygon(Map map) Creates new Polygon object.

Method Summary

Modifier and Type	Method and Description
boolean	getDraggable() Returns whether this shape can be dragged by the user.
boolean	getEditable() Returns whether this shape can be edited by the user.
LatLng[]	getPath() Retrieves the first path.
LatLng[][]	getPaths() Retrieves the paths for this polygon.
boolean	getVisible() Returns whether this polygon is visible on the map.
void	remove() Removes polygon from the map.
void	setDraggable(boolean value) If set to true, the user can drag this shape over the map.
void	setEditable(boolean value) If set to true, the user can edit this shape by dragging the control points shown at the vertices and on each segment.
void	setOptions(PolygonOptions options) Sets new options for current shape.
void	setPath(LatLng[] values) Sets the first path.
void	setPaths(LatLng[][] items) Sets the path for this polygon.
void	setVisible(boolean value) Hides this poly if set to false.

Methods inherited from class com.teamdev.jxmaps.MapObject

addEventListener, attachObject, cacheProperties, cacheProperties, clone, createJSValue, dispose, fromJSValue, getJSObject, getMap, getProperties, invokeMethod, propertyChanged, removeEventListener, updateProperty

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Polygon

public Polygon(Map map)

Creates new Polygon object.

Parameters:

map - owner Map object

Method Detail

getDraggable

public boolean getDraggable()

Returns whether this shape can be dragged by the user.

Returns:

property value

getEditable

public boolean getEditable()

Returns whether this shape can be edited by the user.

Returns:

property value

getVisible

public boolean getVisible()

Returns whether this polygon is visible on the map.

Returns:

property value

setDraggable

public void setDraggable(boolean value)

If set to true, the user can drag this shape over the map. The geodesic property defines the mode of dragging.

Parameters:

value - new value

setEditable

public void setEditable(boolean value)

If set to true, the user can edit this shape by dragging the control points shown at the vertices and on each segment.

Parameters:

value - new value

setVisible

public void setVisible(boolean value)

Hides this poly if set to false.

Parameters:

value - new value

setOptions

public void setOptions(PolygonOptions options)

Sets new options for current shape.

Parameters:

options - new options object

getPath

@Nullable
public LatLng[] getPath()

Retrieves the first path.

Returns:

array of coords that represents path

getPaths

@Nullable
public LatLng[][] getPaths()

Retrieves the paths for this polygon.

Returns:

array of paths that represents polygon. each path is represented as array of coords.

remove

public void remove()

Removes polygon from the map.

setPath

public void setPath(LatLng[] values)

Sets the first path. See PolygonOptions for more details.

Parameters:

values - array of LatLng values that represents the new path

setPaths

public void setPaths(LatLng[][] items)

Sets the path for this polygon.

Parameters:

items - collection of paths