com.teamdev.jxmaps

Class DirectionsRendererOptions

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.DirectionsRendererOptions

All Implemented Interfaces:

java.lang.Cloneable

public class DirectionsRendererOptions
extends MapObject

Represents directions renderer options object. This object defines the properties that can be set on a DirectionsRenderer object.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
DirectionsResult	getDirections() Returns value of directions property.
boolean	getDraggable() Returns value of draggable property.
boolean	getHideRouteList() Returns value of hideRouteList property.
InfoWindow	getInfoWindow() Returns value of infoWindow property.
MarkerOptions	getMarkerOptions() Returns value of markerOptions property.
PolylineOptions	getPolylineOptions() Returns value of polylineOptions property.
boolean	getPreserveViewport() Returns value of preserveViewport property.
int	getRouteIndex() Returns value of routeIndex property.
boolean	getSuppressBicyclingLayer() Returns value of suppressBicyclingLayer property.
boolean	getSuppressInfoWindows() Returns value of suppressInfoWindows property.
boolean	getSuppressMarkers() Returns value of suppressMarkers property.
boolean	getSuppressPolylines() Returns value of suppressPolylines property.
void	setDirections(DirectionsResult value) Sets new value for directions property.
void	setDraggable(boolean value) Sets new value for draggable property.
void	setHideRouteList(boolean value) Sets new value for getHideRouteList property.
void	setInfoWindow(InfoWindow value) Sets new value for infoWindow property.
void	setMarkerOptions(MarkerOptions value) Sets new value for markerOptions property.
void	setPolylineOptions(PolylineOptions value) Sets new value for polylineOptions property.
void	setPreserveViewport(boolean value) Sets new value for preserveViewport property.
void	setRouteIndex(int value) Sets new value for routeIndex property.
void	setSuppressBicyclingLayer(boolean value) Sets new value for suppressBicyclingLayer property.
void	setSuppressInfoWindows(boolean value) Sets new value for suppressInfoWindows property.
void	setSuppressMarkers(boolean value) Sets new value for suppressMarkers property.
void	setSuppressPolylines(boolean value) Sets new value for suppressPolylines 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

DirectionsRendererOptions

public DirectionsRendererOptions()

Creates new DirectionsRendererOptions object

DirectionsRendererOptions

@Deprecated
public DirectionsRendererOptions(Map map)

Deprecated.

Creates new DirectionsRendererOptions object

Parameters:

map - owner Map object

Method Detail

getDirections

public DirectionsResult getDirections()

Returns value of directions property.

Represents the directions to display on the map, retrieved as a DirectionsResult object from DirectionsService.

Returns:

property value

See Also:

setDirections(com.teamdev.jxmaps.DirectionsResult)

setDirections

public void setDirections(DirectionsResult value)

Sets new value for directions property.

Parameters:

value - new property value

See Also:

getDirections()

getDraggable

public boolean getDraggable()

Returns value of draggable property.

If true, allows the user to drag and modify the paths of routes rendered by this DirectionsRenderer.

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

getHideRouteList

public boolean getHideRouteList()

Returns value of hideRouteList property.

This property indicates whether the renderer should provide UI to select amongst alternative routes. By default, this flag is false and a user-selectable list of routes will be shown in the directions' associated panel. To hide that list, set hideRouteList to true.

Returns:

property value

See Also:

setHideRouteList(boolean)

setHideRouteList

public void setHideRouteList(boolean value)

Sets new value for getHideRouteList property.

Parameters:

value - new property value

See Also:

getHideRouteList()

getPreserveViewport

public boolean getPreserveViewport()

Returns value of preserveViewport property.

By default, the input map is centered and zoomed to the bounding box of this set of directions. If this option is set to true, the viewport is left unchanged, unless the map's center and zoom were never set.

Returns:

property value

See Also:

setPreserveViewport(boolean)

setPreserveViewport

public void setPreserveViewport(boolean value)

Sets new value for preserveViewport property.

Parameters:

value - new property value

See Also:

getPreserveViewport()

getSuppressBicyclingLayer

public boolean getSuppressBicyclingLayer()

Returns value of suppressBicyclingLayer property.

Suppress the rendering of the BicyclingLayer when bicycling directions are requested.

Returns:

property value

See Also:

setSuppressBicyclingLayer(boolean)

setSuppressBicyclingLayer

public void setSuppressBicyclingLayer(boolean value)

Sets new value for suppressBicyclingLayer property.

Parameters:

value - new property value

See Also:

getSuppressBicyclingLayer()

getSuppressInfoWindows

public boolean getSuppressInfoWindows()

Returns value of suppressInfoWindows property.

Suppress the rendering of info windows.

Returns:

property value

See Also:

setSuppressInfoWindows(boolean)

setSuppressInfoWindows

public void setSuppressInfoWindows(boolean value)

Sets new value for suppressInfoWindows property.

Parameters:

value - new property value

See Also:

getSuppressInfoWindows()

getSuppressMarkers

public boolean getSuppressMarkers()

Returns value of suppressMarkers property.

Suppress the rendering of markers.

Returns:

property value

See Also:

setSuppressMarkers(boolean)

setSuppressMarkers

public void setSuppressMarkers(boolean value)

Sets new value for suppressMarkers property.

Parameters:

value - new property value

See Also:

getSuppressMarkers()

getSuppressPolylines

public boolean getSuppressPolylines()

Returns value of suppressPolylines property.

Suppress the rendering of polylines.

Returns:

property value

See Also:

setSuppressPolylines(boolean)

setSuppressPolylines

public void setSuppressPolylines(boolean value)

Sets new value for suppressPolylines property.

Parameters:

value - new property value

See Also:

getSuppressPolylines()

getRouteIndex

public int getRouteIndex()

Returns value of routeIndex property.

Represents the index of the route within the DirectionsResult object. The default value is 0.

Returns:

property value

See Also:

setRouteIndex(int)

setRouteIndex

public void setRouteIndex(int value)

Sets new value for routeIndex property.

Parameters:

value - new property value

See Also:

getRouteIndex()

getInfoWindow

public InfoWindow getInfoWindow()

Returns value of infoWindow property.

Represents the InfoWindow in which to render text information when a marker is clicked. Existing info window content will be overwritten and its position moved. If no info window is specified, the DirectionsRenderer will create and use its own info window. This property will be ignored if suppressInfoWindows is set to true.

Returns:

property value

See Also:

setInfoWindow(com.teamdev.jxmaps.InfoWindow)

setInfoWindow

public void setInfoWindow(InfoWindow value)

Sets new value for infoWindow property.

Parameters:

value - new property value

See Also:

getInfoWindow()

getMarkerOptions

public MarkerOptions getMarkerOptions()

Returns value of markerOptions property.

Represents options for the markers. All markers rendered by the DirectionsRenderer will use these options.

Returns:

property value

See Also:

setMarkerOptions(com.teamdev.jxmaps.MarkerOptions)

setMarkerOptions

public void setMarkerOptions(MarkerOptions value)

Sets new value for markerOptions property.

Parameters:

value - new property value

See Also:

getMarkerOptions()

getPolylineOptions

public PolylineOptions getPolylineOptions()

Returns value of polylineOptions property.

Represents options for the polylines. All polylines rendered by the DirectionsRenderer will use these options.

Returns:

property value

See Also:

setPolylineOptions(com.teamdev.jxmaps.PolylineOptions)

setPolylineOptions

public void setPolylineOptions(PolylineOptions value)

Sets new value for polylineOptions property.

Parameters:

value - new property value

See Also:

getPolylineOptions()