com.teamdev.jxmaps

Class DirectionsRenderer

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.DirectionsRenderer

All Implemented Interfaces:

java.lang.Cloneable

public class DirectionsRenderer
extends MapObject

Represents directions renderer object. Renders directions obtained from the DirectionsService.

Method Summary

Modifier and Type	Method and Description
DirectionsResult	getDirections() Returns the renderer's current set of directions.
int	getRouteIndex() Returns the current (zero-based) route index in use by this DirectionsRenderer object.
void	setDirections(DirectionsResult result) Set the renderer to use the result from the DirectionsService.
void	setOptions(DirectionsRendererOptions options) Change the options settings of this DirectionsRenderer after initialization.
void	setRouteIndex(int index) Set the (zero-based) index of the route in the DirectionsResult object to render.

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

Method Detail

setDirections

public void setDirections(DirectionsResult result)

Set the renderer to use the result from the DirectionsService. Setting a valid set of directions in this manner will display the directions on the renderer's designated map and panel.

Parameters:

result - new directions set

See Also:

getDirections()

getDirections

@Nullable
public DirectionsResult getDirections()

Returns the renderer's current set of directions.

Returns:

DirectionsResult object currently set in this renderer

See Also:

setDirections(com.teamdev.jxmaps.DirectionsResult)

getRouteIndex

public int getRouteIndex()

Returns the current (zero-based) route index in use by this DirectionsRenderer object.

Returns:

route index

See Also:

setRouteIndex(int)

setRouteIndex

public void setRouteIndex(int index)

Set the (zero-based) index of the route in the DirectionsResult object to render. By default, the first route in the array will be rendered.

Parameters:

index - new index value

See Also:

getRouteIndex()

setOptions

public void setOptions(DirectionsRendererOptions options)

Change the options settings of this DirectionsRenderer after initialization.

Parameters:

options - new options