com.teamdev.jxmaps

Class PolygonOptions

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.PolygonOptions

All Implemented Interfaces:

java.lang.Cloneable

public class PolygonOptions
extends MapObject

Represents a polygon options.

Constructor Summary

Constructors

Constructor and Description
PolygonOptions() Creates new PolygonOptions object.
PolygonOptions(Map map) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	getClickable() Returns value of clickable property.
boolean	getDraggable() Returns value of draggable property.
boolean	getEditable() Returns value of editable property.
java.lang.String	getFillColor() Returns value of fillColor property.
double	getFillOpacity() Returns value of fillOpacity property.
boolean	getGeodesic() Returns value of geodesic property.
LatLng[][]	getPaths() Returns value of paths property.
java.lang.String	getStrokeColor() Returns value of strokeColor property.
double	getStrokeOpacity() Returns value of strokeOpacity property.
StrokePosition	getStrokePosition() Returns value of strokePosition property.
double	getStrokeWeight() Returns value of strokeWeight property.
boolean	getVisible() Returns value of visible property.
double	getZIndex() Returns value of zIndex property.
void	setClickable(boolean value) Sets new value for clickable property.
void	setDraggable(boolean value) Sets new value for draggable property.
void	setEditable(boolean value) Sets new value for editable property.
void	setFillColor(java.lang.String value) Sets new value for fillColor property.
void	setFillOpacity(double value) Sets new value for fillOpacity property.
void	setGeodesic(boolean value) Sets new value for geodesic property.
void	setPaths(LatLng[][] items) Sets new value for paths property.
void	setStrokeColor(java.lang.String value) Sets new value for strokeColor property.
void	setStrokeOpacity(double value) Sets new value for strokeOpacity property.
void	setStrokePosition(StrokePosition value) Sets new value for strokePosition property.
void	setStrokeWeight(double value) Sets new value for strokeWeight property.
void	setVisible(boolean value) Sets new value for visible property.
void	setZIndex(double value) Sets new value for zIndex property.

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

PolygonOptions

public PolygonOptions()

Creates new PolygonOptions object.

PolygonOptions

@Deprecated
public PolygonOptions(Map map)

Deprecated.

Creates new PolygonOptions object.

Parameters:

map - owner Map object

Method Detail

getClickable

public boolean getClickable()

Returns value of clickable property.

Indicates whether this Polygon handles mouse events. Defaults to true.

Returns:

property value

See Also:

setClickable(boolean)

setClickable

public void setClickable(boolean value)

Sets new value for clickable property.

Parameters:

value - new property value

See Also:

getClickable()

getDraggable

public boolean getDraggable()

Returns value of draggable property.

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

Returns:

property value

See Also:

setDraggable(boolean)

setDraggable

public void setDraggable(boolean value)

Sets new value for draggable property.

Parameters:

value - new property value

See Also:

getDraggable()

getEditable

public boolean getEditable()

Returns value of editable property.

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

Returns:

property value

See Also:

setEditable(boolean)

setEditable

public void setEditable(boolean value)

Sets new value for editable property.

Parameters:

value - new property value

See Also:

getEditable()

getGeodesic

public boolean getGeodesic()

Returns value of geodesic property.

When true, edges of the polygon are interpreted as geodesic and will follow the curvature of the Earth. When false, edges of the polygon are rendered as straight lines in screen space. Note that the shape of a geodesic polygon may appear to change when dragged, as the dimensions are maintained relative to the surface of the earth. Defaults to false.

Returns:

property value

See Also:

setGeodesic(boolean)

setGeodesic

public void setGeodesic(boolean value)

Sets new value for geodesic property.

Parameters:

value - new property value

See Also:

getGeodesic()

getVisible

public boolean getVisible()

Returns value of visible property.

Indicates whether this polygon is visible on the map. Defaults to true.

Returns:

property value

See Also:

setVisible(boolean)

setVisible

public void setVisible(boolean value)

Sets new value for visible property.

Parameters:

value - new property value

See Also:

getVisible()

getPaths

public LatLng[][] getPaths()

Returns value of paths property.

Represents the ordered sequence of coordinates that designates a closed loop. Unlike polylines, a polygon may consist of one or more paths. As a result, the paths property may specify one or more arrays of LatLng coordinates. Paths are closed automatically; do not repeat the first vertex of the path as the last vertex. Simple polygons may be defined using a single array of LatLngs. More complex polygons may specify an array of arrays.

Returns:

property value

See Also:

setPaths(com.teamdev.jxmaps.LatLng[][])

setPaths

public void setPaths(LatLng[][] items)

Sets new value for paths property.

Parameters:

items - new property value

See Also:

getPaths()

getStrokeColor

public java.lang.String getStrokeColor()

Returns value of strokeColor property.

Contains the stroke color. All CSS3 colors are supported except for extended named colors.

Returns:

property value

See Also:

setStrokeColor(java.lang.String)

setStrokeColor

public void setStrokeColor(java.lang.String value)

Sets new value for strokeColor property.

Parameters:

value - new property value

See Also:

getStrokeColor()

getFillColor

public java.lang.String getFillColor()

Returns value of fillColor property.

Contains the fill color. All CSS3 colors are supported except for extended named colors.

Returns:

property value

See Also:

setFillColor(java.lang.String)

setFillColor

public void setFillColor(java.lang.String value)

Sets new value for fillColor property.

Parameters:

value - new property value

See Also:

getFillColor()

getStrokeWeight

public double getStrokeWeight()

Returns value of strokeWeight property.

The stroke width in pixels.

Returns:

property value

See Also:

setStrokeWeight(double)

setStrokeWeight

public void setStrokeWeight(double value)

Sets new value for strokeWeight property.

Parameters:

value - new property value

See Also:

getStrokeWeight()

getStrokeOpacity

public double getStrokeOpacity()

Returns value of strokeOpacity property.

Contains the stroke opacity between 0.0 and 1.0

Returns:

property value

See Also:

setStrokeOpacity(double)

setStrokeOpacity

public void setStrokeOpacity(double value)

Sets new value for strokeOpacity property.

Parameters:

value - new property value

See Also:

getStrokeOpacity()

getFillOpacity

public double getFillOpacity()

Returns value of fillOpacity property.

Contains the fill opacity between 0.0 and 1.0

Returns:

property value

See Also:

setFillOpacity(double)

setFillOpacity

public void setFillOpacity(double value)

Sets new value for fillOpacity property.

Parameters:

value - new property value

See Also:

getFillOpacity()

getZIndex

public double getZIndex()

Returns value of zIndex property.

Contains the zIndex compared to other polys.

Returns:

property value

See Also:

setZIndex(double)

setZIndex

public void setZIndex(double value)

Sets new value for zIndex property.

Parameters:

value - new property value

See Also:

getZIndex()

getStrokePosition

public StrokePosition getStrokePosition()

Returns value of strokePosition property.

Contains the stroke position. Defaults to CENTER. This property is not supported on Internet Explorer 8 and earlier.

Returns:

property value

See Also:

setStrokePosition(com.teamdev.jxmaps.StrokePosition)

setStrokePosition

public void setStrokePosition(StrokePosition value)

Sets new value for strokePosition property.

Parameters:

value - new property value

See Also:

getStrokePosition()