com.mapbox.mapboxsdk.annotations

Class IconFactory

java.lang.Object

com.mapbox.mapboxsdk.annotations.IconFactory

public final class IconFactory
extends java.lang.Object

Factory for creating Icons from bitmap images.

icon is used to display bitmaps on top of the map using Marker and MarkerView.

See Also:

Icon

Field Summary

Fields

Modifier and Type	Field and Description
static android.graphics.Bitmap	ICON_MARKERVIEW_BITMAP
static java.lang.String	ICON_MARKERVIEW_ID

Method Summary

Modifier and Type	Method and Description
Icon	defaultMarker() Provides an icon using the default marker icon used for Marker.
Icon	defaultMarkerView() Provides an icon using the default marker icon used for MarkerView.
Icon	fromAsset(java.lang.String assetName) Creates an Icon using the name of a Bitmap image in the assets directory.
Icon	fromBitmap(android.graphics.Bitmap bitmap) Creates an icon from a given Bitmap image.
Icon	fromFile(java.lang.String fileName) Create an Icon using the name of a Bitmap image file located in the internal storage.
Icon	fromPath(java.lang.String absolutePath) Creates an Icon using the absolute file path of a Bitmap image.
Icon	fromResource(int resourceId) Creates an icon using the resource ID of a Bitmap image.
static IconFactory	getInstance(android.content.Context context) Get a single instance of IconFactory.
static Icon	recreate(java.lang.String iconId, android.graphics.Bitmap bitmap) Create an Icon using a previously created icon identifier along with a provided Bitmap.

Methods inherited from class java.lang.Object

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

Field Detail

ICON_MARKERVIEW_BITMAP

public static final android.graphics.Bitmap ICON_MARKERVIEW_BITMAP

ICON_MARKERVIEW_ID

public static final java.lang.String ICON_MARKERVIEW_ID

See Also:

Constant Field Values

Method Detail

getInstance

public static IconFactory getInstance(@NonNull
                                      android.content.Context context)

Get a single instance of IconFactory.

Parameters:

context - the context to derive the application context from

Returns:

the single instance of IconFactory

fromBitmap

public Icon fromBitmap(@NonNull
                       android.graphics.Bitmap bitmap)

Creates an icon from a given Bitmap image.

Parameters:

bitmap - image used for creating the Icon.

Returns:

The icon using the given Bitmap image.

fromResource

public Icon fromResource(@DrawableRes
                         int resourceId)

Creates an icon using the resource ID of a Bitmap image.

Parameters:

resourceId - The resource ID of a Bitmap image.

Returns:

The icon that was loaded from the asset or null if failed to load.

defaultMarker

public Icon defaultMarker()

Provides an icon using the default marker icon used for Marker.

Returns:

An icon with the default Marker icon.

defaultMarkerView

public Icon defaultMarkerView()

Provides an icon using the default marker icon used for MarkerView.

Returns:

An icon with the default MarkerView icon.

fromAsset

public Icon fromAsset(@NonNull
                      java.lang.String assetName)

Creates an Icon using the name of a Bitmap image in the assets directory.

Parameters:

assetName - The name of a Bitmap image in the assets directory.

Returns:

The Icon that was loaded from the asset or null if failed to load.

fromPath

public Icon fromPath(@NonNull
                     java.lang.String absolutePath)

Creates an Icon using the absolute file path of a Bitmap image.

Parameters:

absolutePath - The absolute path of the Bitmap image.

Returns:

The Icon that was loaded from the absolute path or null if failed to load.

fromFile

public Icon fromFile(@NonNull
                     java.lang.String fileName)

Create an Icon using the name of a Bitmap image file located in the internal storage. In particular, this calls Context#openFileInput(String).

Parameters:

fileName - The name of the Bitmap image file.

Returns:

The Icon that was loaded from the asset or null if failed to load.

See Also:

Using the Internal Storage

recreate

public static Icon recreate(@NonNull
                            java.lang.String iconId,
                            @NonNull
                            android.graphics.Bitmap bitmap)

Create an Icon using a previously created icon identifier along with a provided Bitmap.

Parameters:

iconId - The Icon identifier you'd like to recreate.

bitmap - a Bitmap used to replace the current one.

Returns:

The Icon using the new Bitmap.