com.mousebird.maply

Class LabelInfo

java.lang.Object

com.mousebird.maply.BaseInfo

com.mousebird.maply.LabelInfo

public class LabelInfo
extends BaseInfo

We use this class to designate attribute shared by a group of labels. Rather than specifying them individually they all go here. You would use this class in the course of an addLabels() or addScreenLabels() call on the MaplyController.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LabelInfo.TextJustify Justification values for text.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	fontName
static int	LabelPriorityDefault Default priority for labels.
static int	LayoutAbove
static int	LayoutBelow
static int	LayoutCenter
float	layoutImportance
static int	LayoutLeft
static int	LayoutNone
int	layoutPlacement
static int	LayoutRight

Fields inherited from class com.mousebird.maply.BaseInfo

disposeAfterUse, nativeHandle

Constructor Summary

Constructors

Constructor and Description
LabelInfo()

Method Summary

Modifier and Type	Method and Description
void	finalize()
int	getBackgroundColor() Return the background text color in a form suitable for Android.
float	getFontSize()
int	getOutlineColor() Return the outline color in a form suitable for Android.
float	getOutlineSize() Return the outline size
int	getTextColor() Return the text color in a form suitable for Android.
android.graphics.Typeface	getTypeface() Return the typeface used for the labels.
void	setBackgroundColor(float r, float g, float b, float a) Set the background color of text.
void	setBackgroundColor(int color) Set the background color from a standard Android Color value.
void	setFontSize(float size) Set the font size for the text.
void	setLayoutImportance(float newImport) The layout engine controls how text is displayed.
void	setLayoutPlacement(int newPlacement) The layout placement controls where we can put the label relative to its point.
void	setOutlineColor(float r, float g, float b, float a) Set the color of outline.
void	setOutlineColor(int color) Set the color of the outline.
void	setOutlineSize(float size) Set the outline size for the text.
void	setShadowColor(float r, float g, float b, float a) Set the color of shadow.
void	setShadowColor(int color) Set the color of the shadow.
void	setShadowSize(float size) Set the shadow size for the text.
void	setTextColor(float r, float g, float b, float a) Set the text color as float values from 0.0 to 1.0
void	setTextColor(int color) Set the text color from a standard Android Color value.
void	setTextJustify(LabelInfo.TextJustify textJustify) For multi-line labels, you can justify the text to the left, right or center.
void	setTypeface(android.graphics.Typeface typeface) Set the typeface used in the text.

Methods inherited from class com.mousebird.maply.BaseInfo

getDrawOffset, getDrawPriority, getEnable, getFadeIn, getFadeOut, getFadeOutTime, getShaderID, getViewDistRangeMax, getViewDistRangeMin, getViewerCenter, getVisibleHeightMax, getVisibleHeightMin, setDrawOffset, setDrawPriority, setEnable, setEnableTimes, setFade, setFadeInOut, setFadeOutTime, setMaxVis, setMinVis, setRenderTarget, setShader, setShaderID, setViewDistRange, setViewerCenter, setVisibleHeightRange, setZBufferRead, setZBufferWrite

Methods inherited from class java.lang.Object

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

Field Detail

LabelPriorityDefault

public static int LabelPriorityDefault

Default priority for labels. Screen labels add a big offset to this.

fontName

public java.lang.String fontName

layoutImportance

public float layoutImportance

LayoutNone

public static int LayoutNone

LayoutCenter

public static int LayoutCenter

LayoutRight

public static int LayoutRight

LayoutLeft

public static int LayoutLeft

LayoutAbove

public static int LayoutAbove

LayoutBelow

public static int LayoutBelow

layoutPlacement

public int layoutPlacement

Constructor Detail

LabelInfo

public LabelInfo()

Method Detail

finalize

public void finalize()

Overrides:

finalize in class java.lang.Object

setTextColor

public void setTextColor(int color)

Set the text color from a standard Android Color value.

Parameters:

color - Color value, including alpha.

getTextColor

public int getTextColor()

Return the text color in a form suitable for Android.

setTextColor

public void setTextColor(float r,
                         float g,
                         float b,
                         float a)

Set the text color as float values from 0.0 to 1.0

Parameters:

r - red

g - green

b - blue

a - alpha

setBackgroundColor

public void setBackgroundColor(int color)

Set the background color from a standard Android Color value.

Parameters:

color - Color value, including alpha.

setBackgroundColor

public void setBackgroundColor(float r,
                               float g,
                               float b,
                               float a)

Set the background color of text. This is what appears in the rectangles behind the text. Color components range from 0.0 to 1.0.

Parameters:

r - red

g - green

b - blue

a - alpha

getBackgroundColor

public int getBackgroundColor()

Return the background text color in a form suitable for Android.

setTypeface

public void setTypeface(android.graphics.Typeface typeface)

Set the typeface used in the text.

getTypeface

public android.graphics.Typeface getTypeface()

Return the typeface used for the labels.

setFontSize

public void setFontSize(float size)

Set the font size for the text. For screen labels this controls the geometry size as well.

getFontSize

public float getFontSize()

setOutlineColor

public void setOutlineColor(float r,
                            float g,
                            float b,
                            float a)

Set the color of outline. Color components range from 0.0 to 1.0.

Parameters:

r - red

g - green

b - blue

a - alpha

getOutlineColor

public int getOutlineColor()

Return the outline color in a form suitable for Android.

setOutlineColor

public void setOutlineColor(int color)

Set the color of the outline.

setOutlineSize

public void setOutlineSize(float size)

Set the outline size for the text.

getOutlineSize

public float getOutlineSize()

Return the outline size

setShadowColor

public void setShadowColor(float r,
                           float g,
                           float b,
                           float a)

Set the color of shadow. Color components range from 0.0 to 1.0.

Parameters:

r - red

g - green

b - blue

a - alpha

setShadowColor

public void setShadowColor(int color)

Set the color of the shadow.

setShadowSize

public void setShadowSize(float size)

Set the shadow size for the text.

setLayoutPlacement

public void setLayoutPlacement(int newPlacement)

The layout placement controls where we can put the label relative to its point.

setLayoutImportance

public void setLayoutImportance(float newImport)

The layout engine controls how text is displayed. It tries to avoid overlaps and takes priority into account. The layout importance controls which labels (or other features) are laid out first. Bigger is more important.

Defaults to MAXFLOAT, which is off. That means the layout engine does not control the associated labels.

setTextJustify

public void setTextJustify(LabelInfo.TextJustify textJustify)

For multi-line labels, you can justify the text to the left, right or center. Only works for multi-line labels.