com.mapbox.mapboxsdk.annotations

Class BaseMarkerViewOptions<U extends MarkerView,T extends BaseMarkerViewOptions<U,T>>

java.lang.Object

com.mapbox.mapboxsdk.annotations.BaseMarkerViewOptions<U,T>

Type Parameters:

U - Type of the marker view to be composed.

T - Type of the builder to be used for composing.

All Implemented Interfaces:

Parcelable

Direct Known Subclasses:

MarkerViewOptions

public abstract class BaseMarkerViewOptions<U extends MarkerView,T extends BaseMarkerViewOptions<U,T>>
extends Object
implements Parcelable

Abstract builder class for composing custom MarkerView objects.

Extending this class requires implementing Parceable interface.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected float	alpha
protected float	anchorU
protected float	anchorV
protected boolean	flat
protected Icon	icon
protected float	infoWindowAnchorU
protected float	infoWindowAnchorV
protected LatLng	position
protected float	rotation
protected boolean	selected
protected String	snippet
protected String	title
protected boolean	visible

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
BaseMarkerViewOptions() Default constructor

Method Summary

Modifier and Type	Method and Description
T	alpha(float alpha) Set the alpha of the MarkerView.
T	anchor(float u, float v) Set the anchor of the MarkerView.
T	flat(boolean flat) Set the flat state of the MarkerView.
float	getAlpha() Get the alpha of the MarkerView.
float	getAnchorU() Get the u-value of the MarkerView anchor.
float	getAnchorV() Get the v-value of the MarkerView anchor.
Icon	getIcon() Get the icon of the MarkerView.
float	getInfoWindowAnchorU() Get the u-value of the MarkerView InfoWindow anchor.
float	getInfoWindowAnchorV() Get the v-value of the MarkerView InfoWindow anchor.
abstract U	getMarker() Get the MarkerView.
LatLng	getPosition() Get the geographical location of the MarkerView.
float	getRotation() Get the rotation of the MarkerView.
String	getSnippet() Get the snippet of the MarkerView.
abstract T	getThis() Get the instance of the object for which this method was called.
String	getTitle() Get the title of the MarkerView.
T	icon(Icon icon) Set the icon of the MarkerView.
T	infoWindowAnchor(float u, float v) Set the InfoWindow anchor of the MarkerView.
boolean	isFlat() Get the flat state of the MarkerView.
boolean	isVisible() Get the visibility state of the MarkerView.
T	position(LatLng position) Set the geographical location of the MarkerView.
T	rotation(float rotation) Set the rotation of the MarkerView.
T	snippet(String snippet) Set the snippet of the MarkerView.
T	title(String title) Set the title of the MarkerView.
T	visible(boolean visible) Set the visibility state of the MarkerView.

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

position

protected LatLng position

snippet

protected String snippet

title

protected String title

icon

protected Icon icon

flat

protected boolean flat

anchorU

protected float anchorU

anchorV

protected float anchorV

infoWindowAnchorU

protected float infoWindowAnchorU

infoWindowAnchorV

protected float infoWindowAnchorV

rotation

protected float rotation

visible

protected boolean visible

selected

protected boolean selected

alpha

protected float alpha

Constructor Detail

BaseMarkerViewOptions

public BaseMarkerViewOptions()

Default constructor

Method Detail

position

public T position(@NonNull
                  LatLng position)

Set the geographical location of the MarkerView.

Parameters:

position - the location to position the MarkerView.

Returns:

the object for which the method was called.

snippet

public T snippet(String snippet)

Set the snippet of the MarkerView.

Parameters:

snippet - the snippet of the MarkerView.

Returns:

the object for which the method was called.

title

public T title(String title)

Set the title of the MarkerView.

Parameters:

title - the title of the MarkerView.

Returns:

the object for which the method was called.

icon

public T icon(Icon icon)

Set the icon of the MarkerView.

Parameters:

icon - the icon of the MarkerView.

Returns:

the object for which the method was called.

flat

public T flat(boolean flat)

Set the flat state of the MarkerView.

Parameters:

flat - the flat state of the MarkerView.

Returns:

the object for which the method was called.

anchor

public T anchor(float u,
                float v)

Set the anchor of the MarkerView.

Parameters:

u - the u-value.

v - the v-value.

Returns:

the object for which the method was called.

infoWindowAnchor

public T infoWindowAnchor(float u,
                          float v)

Set the InfoWindow anchor of the MarkerView.

Parameters:

u - the u-value.

v - the v-values.

Returns:

the object for which the method was called.

rotation

public T rotation(float rotation)

Set the rotation of the MarkerView.

Parameters:

rotation - the rotation value.

Returns:

the object for which the method was called.

visible

public T visible(boolean visible)

Set the visibility state of the MarkerView.

Parameters:

visible - the visible state.

Returns:

the object for which the method was called.

alpha

public T alpha(float alpha)

Set the alpha of the MarkerView.

Parameters:

alpha - the alpha value.

Returns:

the object for which the method was called.

getPosition

public LatLng getPosition()

Get the geographical location of the MarkerView.

Returns:

the geographical location.

getSnippet

public String getSnippet()

Get the snippet of the MarkerView.

Returns:

the snippet.

getTitle

public String getTitle()

Get the title of the MarkerView.

Returns:

the title.

getIcon

public Icon getIcon()

Get the icon of the MarkerView.

Returns:

the icon.

isFlat

public boolean isFlat()

Get the flat state of the MarkerView.

Returns:

the flat state.

getAnchorU

public float getAnchorU()

Get the u-value of the MarkerView anchor.

Returns:

the u-value.

getAnchorV

public float getAnchorV()

Get the v-value of the MarkerView anchor.

Returns:

the v-value.

getInfoWindowAnchorU

public float getInfoWindowAnchorU()

Get the u-value of the MarkerView InfoWindow anchor.

Returns:

the u-value.

getInfoWindowAnchorV

public float getInfoWindowAnchorV()

Get the v-value of the MarkerView InfoWindow anchor.

Returns:

the v-value.

getRotation

public float getRotation()

Get the rotation of the MarkerView.

Returns:

the rotation value.

isVisible

public boolean isVisible()

Get the visibility state of the MarkerView.

Returns:

the visibility state.

getAlpha

public float getAlpha()

Get the alpha of the MarkerView.

Returns:

the alpha value.

getThis

public abstract T getThis()

Get the instance of the object for which this method was called.

Returns:

the object for which the this method was called.

getMarker

public abstract U getMarker()

Get the MarkerView.

Returns:

the MarkerView created from this builder.