com.teamdev.jxmaps

Class DirectionsRoute

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.DirectionsRoute

All Implemented Interfaces:

java.lang.Cloneable

public class DirectionsRoute
extends MapObject

Represents directions route object. Contains a single route containing a set of legs in a DirectionsResult.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DirectionsRoute.ArrayProperty

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LatLngBounds	getBounds() Returns value of bounds property.
java.lang.String	getCopyrights() Returns value of copyrights property.
DirectionsLeg[]	getLegs() Returns value of legs property.
LatLng[]	getOverviewPath() Returns value of overviewPath property.
java.lang.String	getOverviewPolyline() Returns value of overviewPolyline property.
java.lang.String[]	getWarnings() Returns value of warnings property.
double[]	getWaypointOrder() Returns value of waypointOrder property.
void	setBounds(LatLngBounds value) Sets new value for bounds property.
void	setCopyrights(java.lang.String value) Sets new value for copyrights property.
void	setLegs(DirectionsLeg[] legs) Sets new value for legs property.
void	setOverviewPath(LatLng[] latlngs) Sets new value for overviewPath property.
void	setOverviewPolyline(java.lang.String value) Sets new value for overviewPolyline property.
void	setWarnings(java.lang.String[] warnings) Sets new value for warnings property.
void	setWaypointOrder(double[] order) Sets new value for waypointOrder 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

DirectionsRoute

public DirectionsRoute()

Creates new DirectionsRoute object.

DirectionsRoute

@Deprecated
public DirectionsRoute(Map map)

Deprecated.

Creates new DirectionsRoute object.

Parameters:

map - owner Map object

Method Detail

getBounds

public LatLngBounds getBounds()

Returns value of bounds property.

Represents the bounds for this route.

Returns:

property value

See Also:

setBounds(com.teamdev.jxmaps.LatLngBounds)

setBounds

public void setBounds(LatLngBounds value)

Sets new value for bounds property.

Parameters:

value - new property value

See Also:

getBounds()

getCopyrights

public java.lang.String getCopyrights()

Returns value of copyrights property.

Represents the copyrights text to be displayed for this route.

Returns:

property value

See Also:

setCopyrights(java.lang.String)

setCopyrights

public void setCopyrights(java.lang.String value)

Sets new value for copyrights property.

Parameters:

value - new property value

See Also:

getCopyrights()

getLegs

public DirectionsLeg[] getLegs()

Returns value of legs property.

Collection of DirectionsLegs, each of which contains information about the steps of which it is composed. There will be one leg for each waypoint or destination specified. So a route with no waypoints will contain one DirectionsLeg and a route with one waypoint will contain two.

Returns:

property value

See Also:

setLegs(com.teamdev.jxmaps.DirectionsLeg[])

setLegs

public void setLegs(DirectionsLeg[] legs)

Sets new value for legs property.

Parameters:

legs - new property value

See Also:

getLegs()

getOverviewPath

public LatLng[] getOverviewPath()

Returns value of overviewPath property.

Collection of LatLngs representing the entire course of this route. The path is simplified in order to make it suitable in contexts where a small number of vertices is required (such as Static Maps API URLs).

Returns:

property value

See Also:

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

setOverviewPath

public void setOverviewPath(LatLng[] latlngs)

Sets new value for overviewPath property.

Parameters:

latlngs - new property value

See Also:

getOverviewPath()

getOverviewPolyline

public java.lang.String getOverviewPolyline()

Returns value of overviewPolyline property.

Represents an encoded polyline representation of the route in overview_path. This polyline is an approximate (smoothed) path of the resulting directions.

Returns:

property value

See Also:

setOverviewPolyline(java.lang.String)

setOverviewPolyline

public void setOverviewPolyline(java.lang.String value)

Sets new value for overviewPolyline property.

Parameters:

value - new property value

See Also:

getOverviewPolyline()

getWarnings

public java.lang.String[] getWarnings()

Returns value of warnings property.

Collection of string, each of which contains warnings to be displayed when showing these directions.

Returns:

property value

See Also:

setWarnings(java.lang.String[])

setWarnings

public void setWarnings(java.lang.String[] warnings)

Sets new value for warnings property.

Parameters:

warnings - new property value

See Also:

getWarnings()

getWaypointOrder

public double[] getWaypointOrder()

Returns value of waypointOrder property.

If optimizeWaypoints was set to true, this field will contain the re-ordered permutation of the input waypoints.

Returns:

property value

See Also:

setWaypointOrder(double[])

setWaypointOrder

public void setWaypointOrder(double[] order)

Sets new value for waypointOrder property.

Parameters:

order - new property value

See Also:

getWaypointOrder()