com.teamdev.jxmaps

Class PolylineOptions

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.PolylineOptions

All Implemented Interfaces:

java.lang.Cloneable

public class PolylineOptions
extends MapObject

Represents a polyline options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PolylineOptions.Property

Constructor Summary

Constructors

Constructor and Description
PolylineOptions() Creates new PolylineOptions object.
PolylineOptions(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.
boolean	getGeodesic() Returns value of geodesic property.
IconSequence[]	getIcons() Returns value of icons property.
LatLng[]	getPath() Returns value of path property.
java.lang.String	getStrokeColor() Returns value of strokeColor property.
double	getStrokeOpacity() Returns value of strokeOpacity 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	setGeodesic(boolean value) Sets new value for geodesic property.
void	setIcons(IconSequence[] icons) Sets new value for icons property.
void	setPath(LatLng[] items) Sets new value for path property.
void	setStrokeColor(java.lang.String value) Sets new value for strokeColor property.
void	setStrokeOpacity(double value) Sets new value for strokeOpacity 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

PolylineOptions

public PolylineOptions()

Creates new PolylineOptions object.

PolylineOptions

@Deprecated
public PolylineOptions(Map map)

Deprecated.

Creates new PolylineOptions 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 polyline are interpreted as geodesic and will follow the curvature of the Earth. When false, edges of the polyline are rendered as straight lines in screen space. Note that the shape of a geodesic polyline 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 polyline 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()

getIcons

public IconSequence[] getIcons()

Returns value of icons property.

Contains the icons to be rendered along the polyline.

Returns:

property value

See Also:

setIcons(com.teamdev.jxmaps.IconSequence[])

setIcons

public void setIcons(IconSequence[] icons)

Sets new value for icons property.

Parameters:

icons - new property value

See Also:

getIcons()

getPath

public LatLng[] getPath()

Returns value of path property.

Contains the ordered sequence of coordinates of the Polyline.

Returns:

property value

See Also:

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

setPath

public void setPath(LatLng[] items)

Sets new value for path property.

Parameters:

items - new property value

See Also:

getPath()

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()

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()

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()