uk.co.ordnancesurvey.android.maps

Class Polyline

java.lang.Object

uk.co.ordnancesurvey.android.maps.Polyline

public final class Polyline
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
int	getColor()
int	getFillColor() Returns the fill color of this Shape.
List<GridPoint>	getPoints()
int	getStrokeColor() Returns the stroke color.
float	getStrokeWidth() Returns the stroke width.
float	getWidth()
float	getZIndex() Returns the zIndex.
boolean	isVisible() Checks whether the shape is visible.
void	remove() Removes this shape from the map.
void	setColor(int color)
void	setFillColor(int fillColor) Sets the fill color.
void	setPoints(List<GridPoint> points)
void	setStrokeColor(int color) Sets the stroke color.
void	setStrokeWidth(float width) Sets the stroke width.
void	setVisible(boolean visible) Sets the visibility of the shape.
void	setWidth(float width)
void	setZIndex(float zIndex) Sets the zIndex.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setColor

public void setColor(int color)

setWidth

public void setWidth(float width)

getColor

public int getColor()

getWidth

public float getWidth()

setPoints

public void setPoints(List<GridPoint> points)

getPoints

public List<GridPoint> getPoints()

setZIndex

public void setZIndex(float zIndex)

Sets the zIndex. Overlays (such as shapes) with higher zIndices are drawn above those with lower indices.

Parameters:

zIndex -

setVisible

public void setVisible(boolean visible)

Sets the visibility of the shape. If this shape is not visible then it will not be drawn. All other state is preserved. Defaults to True.

Parameters:

visible - false to make this shape invisible.

getZIndex

public float getZIndex()

Returns the zIndex.

Returns:

The zIndex of this shape.

isVisible

public boolean isVisible()

Checks whether the shape is visible.

Returns:

True if the shape is visible; false if it is invisible.

setStrokeColor

public void setStrokeColor(int color)

Sets the stroke color.

The stroke color is the color of this shape's outline, in the integer format specified by android.graphics.Color. If TRANSPARENT is used then no outline is drawn.

Parameters:

color - The stroke color in the android.graphics.Color format.

setStrokeWidth

public void setStrokeWidth(float width)

Sets the stroke width.

The stroke width is the width (in screen pixels) of the shape's outline. It must be zero or greater. If it is zero then no outline is drawn. The default value is 10.

Behaviour with a negative width is undefined.

Parameters:

width - The stroke width, in screen pixels.

getStrokeColor

public int getStrokeColor()

Returns the stroke color.

Returns:

The color of the circle in ARGB format.

getStrokeWidth

public float getStrokeWidth()

Returns the stroke width.

Returns:

The width in screen pixels.

getFillColor

public int getFillColor()

Returns the fill color of this Shape.

Returns:

The fill color of the shape in ARGB format.

setFillColor

public void setFillColor(int fillColor)

Sets the fill color.

The fill color is the color inside the shape, in the integer format specified by android.graphics.Color. If TRANSPARENT is used then no fill is drawn.

Parameters:

fillColor - The color in the android.graphics.Color format.

remove

public final void remove()

Removes this shape from the map.