com.mapbox.mapboxsdk.style.types

Class FormattedSection

java.lang.Object

com.mapbox.mapboxsdk.style.types.FormattedSection

public class FormattedSection
extends java.lang.Object

A component of the Formatted.

Constructor Summary

Constructors

Constructor and Description
FormattedSection(java.lang.String text) Creates a formatted section.
FormattedSection(java.lang.String text, java.lang.Number fontScale) Deprecated. use FormattedSection(String) and setters or FormattedSection(String, Number, String[], String) instead
FormattedSection(java.lang.String text, java.lang.Number fontScale, java.lang.String[] fontStack) Deprecated. use FormattedSection(String) and setters or FormattedSection(String, Number, String[], String) instead
FormattedSection(java.lang.String text, java.lang.Number fontScale, java.lang.String[] fontStack, java.lang.String textColor) Creates a formatted section.
FormattedSection(java.lang.String text, java.lang.String[] fontStack) Deprecated. use FormattedSection(String) and setters or FormattedSection(String, Number, String[], String) instead

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.Number	getFontScale() Returns displayed text's font scale.
java.lang.String[]	getFontStack() Returns the font stack with main and fallback fonts.
java.lang.String	getText() Returns the displayed text.
java.lang.String	getTextColor() Returns the text color.
int	hashCode()
void	setFontScale(java.lang.Number fontScale) Set font scale.
void	setFontStack(java.lang.String[] fontStack) Set main and fallback fonts that are a part of the style.
void	setTextColor(int textColor) Set the text color.
void	setTextColor(java.lang.String textColor) Set text color.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FormattedSection

public FormattedSection(@NonNull
                        java.lang.String text)

Creates a formatted section.

Parameters:

text - displayed string

FormattedSection

public FormattedSection(@NonNull
                        java.lang.String text,
                        @Nullable
                        java.lang.Number fontScale,
                        @Nullable
                        java.lang.String[] fontStack,
                        @Nullable
                        java.lang.String textColor)

Creates a formatted section.

Parameters:

text - displayed string

fontScale - scale of the font, setting to null will fall back to style's default settings

fontStack - main and fallback fonts that are a part of the style, setting null will fall back to style's default settings. The requested font stack has to be a part of the used style. For more information see the documentation.

textColor - text color, setting to null will fall back to style's default settings. Value of red, green, blue components must range between 0 and 255, an alpha component must range between 0 and 1.

For more information see the documentation.

FormattedSection

@Deprecated
public FormattedSection(@NonNull
                                    java.lang.String text,
                                    @Nullable
                                    java.lang.Number fontScale,
                                    @Nullable
                                    java.lang.String[] fontStack)

Deprecated. use FormattedSection(String) and setters or FormattedSection(String, Number, String[], String) instead

Creates a formatted section.

Parameters:

text - displayed string

fontScale - scale of the font, setting to null will fall back to style's default settings

fontStack - main and fallback fonts that are a part of the style, setting null will fall back to style's default settings

FormattedSection

@Deprecated
public FormattedSection(@NonNull
                                    java.lang.String text,
                                    @Nullable
                                    java.lang.Number fontScale)

Deprecated. use FormattedSection(String) and setters or FormattedSection(String, Number, String[], String) instead

Creates a formatted section.

Parameters:

text - displayed string

fontScale - scale of the font, setting to null will fall back to style's default settings

FormattedSection

@Deprecated
public FormattedSection(@NonNull
                                    java.lang.String text,
                                    @Nullable
                                    java.lang.String[] fontStack)

Deprecated. use FormattedSection(String) and setters or FormattedSection(String, Number, String[], String) instead

Creates a formatted section.

Parameters:

text - displayed string

fontStack - main and fallback fonts that are a part of the style, setting null will fall back to style's default settings

Method Detail

getText

@NonNull
public java.lang.String getText()

Returns the displayed text.

Returns:

text

getFontScale

@Nullable
public java.lang.Number getFontScale()

Returns displayed text's font scale.

Returns:

font scale

getFontStack

@Nullable
public java.lang.String[] getFontStack()

Returns the font stack with main and fallback fonts.

Returns:

font stack

getTextColor

public java.lang.String getTextColor()

Returns the text color.

Returns:

text color

setFontScale

public void setFontScale(@Nullable
                         java.lang.Number fontScale)

Set font scale. Setting to null will fall back to style's default settings.

Parameters:

fontScale - fontScale

setFontStack

public void setFontStack(@Nullable
                         java.lang.String[] fontStack)

Set main and fallback fonts that are a part of the style. Setting null will fall back to style's default settings.

The requested font stack has to be a part of the used style. For more information see the documentation.

Parameters:

fontStack - fontStack

setTextColor

public void setTextColor(@Nullable
                         java.lang.String textColor)

Set text color. Setting to null will fall back to style's default settings. Value of red, green, blue components must range between 0 and 255, an alpha component must range between 0 and 1.

For more information see the documentation.

Parameters:

textColor - text color

setTextColor

public void setTextColor(int textColor)

Set the text color.

Parameters:

textColor - text color.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object