org.osmdroid.views.overlay

Class FolderOverlay

java.lang.Object

org.osmdroid.views.overlay.Overlay

org.osmdroid.views.overlay.FolderOverlay

All Implemented Interfaces:

OverlayConstants

public class FolderOverlay
extends Overlay

A FolderOverlay is just a group of other Overlays.

Nested Class Summary

Nested classes/interfaces inherited from class org.osmdroid.views.overlay.Overlay

Overlay.Snappable

Field Summary

Fields

Modifier and Type	Field and Description
protected String	mDescription
protected String	mName
protected OverlayManager	mOverlayManager

Fields inherited from class org.osmdroid.views.overlay.Overlay

mBounds, SHADOW_X_SKEW, SHADOW_Y_SCALE

Fields inherited from interface org.osmdroid.views.util.constants.OverlayConstants

DEFAULT_ZOOMLEVEL_MINIMAP_DIFFERENCE, NOT_SET

Constructor Summary

Constructors

Constructor and Description
FolderOverlay()
FolderOverlay(Context ctx) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	add(Overlay item)
void	closeAllInfoWindows() Close all opened InfoWindows of overlays it contains.
void	draw(Canvas pCanvas, MapView pMapView, boolean pShadow) Draw the overlay over the map.
void	draw(Canvas pCanvas, Projection pProjection)
String	getDescription()
List<Overlay>	getItems()
String	getName()
void	onDetach(MapView mapView) Override to perform clean up of resources before shutdown.
boolean	onLongPress(MotionEvent e, MapView mapView) By default does nothing (return false).
boolean	onSingleTapConfirmed(MotionEvent e, MapView mapView) By default does nothing (return false).
boolean	onSingleTapUp(MotionEvent e, MapView mapView) By default does nothing (return false).
boolean	onTouchEvent(MotionEvent e, MapView mapView) You can prevent all(!) other Touch-related events from happening! By default does nothing (return false).
boolean	remove(Overlay item)
void	setDescription(String description)
void	setName(String name)

Methods inherited from class org.osmdroid.views.overlay.Overlay

drawAt, getBounds, getSafeMenuId, getSafeMenuIdSequence, isEnabled, onDoubleTap, onDoubleTapEvent, onDown, onFling, onKeyDown, onKeyUp, onPause, onResume, onScroll, onShowPress, onTrackballEvent, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

mOverlayManager

protected OverlayManager mOverlayManager

mName

protected String mName

mDescription

protected String mDescription

Constructor Detail

FolderOverlay

@Deprecated
public FolderOverlay(Context ctx)

Deprecated.

Use FolderOverlay() instead

FolderOverlay

public FolderOverlay()

Method Detail

setName

public void setName(String name)

getName

public String getName()

setDescription

public void setDescription(String description)

getDescription

public String getDescription()

getItems

public List<Overlay> getItems()

Returns:

the list of components of this folder. Doesn't provide a copy, but the actual list.

add

public boolean add(Overlay item)

remove

public boolean remove(Overlay item)

draw

public void draw(Canvas pCanvas,
                 Projection pProjection)

Overrides:

draw in class Overlay

draw

public void draw(Canvas pCanvas,
                 MapView pMapView,
                 boolean pShadow)

Description copied from class: Overlay

Draw the overlay over the map. This will be called on all active overlays with shadow=true, to lay down the shadow layer, and then again on all overlays with shadow=false. Callers should check isEnabled() before calling draw(). By default, draws nothing. changed for 5.6 to be public see https://github.com/osmdroid/osmdroid/issues/466 If possible, use Overlay.draw(Canvas, Projection) instead (cf. MapSnapshot

Overrides:

draw in class Overlay

onSingleTapUp

public boolean onSingleTapUp(MotionEvent e,
                             MapView mapView)

Description copied from class: Overlay

By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.

Overrides:

onSingleTapUp in class Overlay

onSingleTapConfirmed

public boolean onSingleTapConfirmed(MotionEvent e,
                                    MapView mapView)

Description copied from class: Overlay

By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.

Overrides:

onSingleTapConfirmed in class Overlay

onLongPress

public boolean onLongPress(MotionEvent e,
                           MapView mapView)

Description copied from class: Overlay

By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.

Overrides:

onLongPress in class Overlay

onTouchEvent

public boolean onTouchEvent(MotionEvent e,
                            MapView mapView)

Description copied from class: Overlay

You can prevent all(!) other Touch-related events from happening!
By default does nothing (return false). If you handled the Event, return true , otherwise return false. If you returned true none of the following Overlays or the underlying MapView has the chance to handle this event.

Overrides:

onTouchEvent in class Overlay

closeAllInfoWindows

public void closeAllInfoWindows()

Close all opened InfoWindows of overlays it contains. This only operates on overlays that inherit from OverlayWithIW.

onDetach

public void onDetach(MapView mapView)

Description copied from class: Overlay

Override to perform clean up of resources before shutdown. By default does nothing.

Overrides:

onDetach in class Overlay