com.nexusgeographics.cercalia.maps.styles

Class LabelStyle

java.lang.Object

com.nexusgeographics.cercalia.maps.styles.Styling<LabelStyle>

com.nexusgeographics.cercalia.maps.styles.LabelStyle

public final class LabelStyle
extends Styling<LabelStyle>

The style of Label.

Copyright (c) 2017 Nexusgeographics All rights reserved.

See Also:

Styling

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LabelStyle.Anchor

Nested classes/interfaces inherited from class com.nexusgeographics.cercalia.maps.styles.Styling

Styling.Style

Constructor Summary

Constructors

Constructor and Description
LabelStyle() Instantiates a new Point style.
LabelStyle(FontStyle font) Instantiates a new Point style.
LabelStyle(java.util.Map<java.lang.String,java.lang.String> mapStyle) Instantiates a new Point style.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlign() Gets align.
LabelStyle.Anchor	getAnchor() Gets anchor.
java.lang.Boolean	getCollide() Gets collide.
FontStyle	getFont() Gets font.
java.lang.Integer[]	getOffset() Get offset integer [ ].
java.lang.String	getOutline() Gets outline in pixels.
java.lang.Integer	getPriority() Gets priority.
java.lang.String	getRepeatDistance() Gets repeat distance.
java.lang.String	getRepeatGroup() Gets repeat group.
java.lang.String	getSprite() Gets sprite.
java.lang.String	getTextSource() Gets text source.
java.lang.String	getTextWrap() Gets text wrap.
void	setAlign(java.lang.String align) Sets align.
void	setAnchor(LabelStyle.Anchor anchor) Sets anchor.
LabelStyle	setCollide(java.lang.Boolean collide) Sets collide.
void	setFont(FontStyle font) Sets font.
LabelStyle	setOffset(java.lang.Integer[] offset) Sets offset [x, y].
LabelStyle	setOffset(int xPixels, int yPixels) Sets offset.
LabelStyle	setOutline(java.lang.String pixels) Sets outline in pixels.
LabelStyle	setPriority(java.lang.Integer priority) Sets priority.
void	setRepeatDistance(java.lang.String repeatDistance) Sets repeat distance.
void	setRepeatGroup(java.lang.String repeatGroup) Sets repeat group.
LabelStyle	setSprite(java.lang.String sprite) Sets sprite.
void	setTextSource(java.lang.String textSource) Sets text source.
void	setTextWrap(java.lang.String textWrap) Sets text wrap.

Methods inherited from class com.nexusgeographics.cercalia.maps.styles.Styling

getBlend, getColor, getMapStyle, getOrder, getStyle, getStylePath, hasStylePath, isVisible, setBlend, setColor, setOrder, setStyle, setStylePath, setVisible, toJson, toMap, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LabelStyle

public LabelStyle()

Instantiates a new Point style.

LabelStyle

public LabelStyle(FontStyle font)

Instantiates a new Point style.

Parameters:

font - the font

LabelStyle

public LabelStyle(java.util.Map<java.lang.String,java.lang.String> mapStyle)

Instantiates a new Point style.

Parameters:

mapStyle - the map style

Method Detail

getCollide

@Nullable
public java.lang.Boolean getCollide()

Gets collide.

Returns:

the collide

setCollide

public LabelStyle setCollide(@Nullable
                             java.lang.Boolean collide)

Sets collide.

Parameters:

collide - the collide

Returns:

the collide

getFont

public FontStyle getFont()

Gets font.

Returns:

the font

setFont

public void setFont(@NonNull
                    FontStyle font)

Sets font.

Parameters:

font - the font

getTextSource

public java.lang.String getTextSource()

Gets text source.

Returns:

the text source

setTextSource

public void setTextSource(java.lang.String textSource)

Sets text source.

Parameters:

textSource - the text source

getAlign

public java.lang.String getAlign()

Gets align.

Returns:

the align

setAlign

public void setAlign(java.lang.String align)

Sets align.

Parameters:

align - the align

getAnchor

public LabelStyle.Anchor getAnchor()

Gets anchor.

Returns:

the anchor

setAnchor

public void setAnchor(LabelStyle.Anchor anchor)

Sets anchor.

Parameters:

anchor - the anchor

getTextWrap

public java.lang.String getTextWrap()

Gets text wrap.

Returns:

the text wrap

setTextWrap

public void setTextWrap(java.lang.String textWrap)

Sets text wrap.

Parameters:

textWrap - the text wrap

getRepeatDistance

public java.lang.String getRepeatDistance()

Gets repeat distance.

Returns:

the repeat distance

setRepeatDistance

public void setRepeatDistance(java.lang.String repeatDistance)

Sets repeat distance.

Parameters:

repeatDistance - the repeat distance

getRepeatGroup

public java.lang.String getRepeatGroup()

Gets repeat group.

Returns:

the repeat group

setRepeatGroup

public void setRepeatGroup(java.lang.String repeatGroup)

Sets repeat group.

Parameters:

repeatGroup - the repeat group

getPriority

public java.lang.Integer getPriority()

Gets priority.

Returns:

the priority

setPriority

public LabelStyle setPriority(java.lang.Integer priority)

Sets priority.

Parameters:

priority - the priority

Returns:

the priority

getSprite

public java.lang.String getSprite()

Gets sprite.

Returns:

the sprite

setSprite

public LabelStyle setSprite(java.lang.String sprite)

Sets sprite.

Parameters:

sprite - the sprite

Returns:

the sprite

setOutline

public LabelStyle setOutline(java.lang.String pixels)

Sets outline in pixels.

Example:

LabelStyle.setOutline("1px")

Parameters:

pixels - the pixels

Returns:

the outline

getOutline

public java.lang.String getOutline()

Gets outline in pixels.

Returns:

the outline

getOffset

public java.lang.Integer[] getOffset()

Get offset integer [ ].

Returns:

the integer [ ]

setOffset

public LabelStyle setOffset(java.lang.Integer[] offset)

Sets offset [x, y].

Example:

LabelStyle.setOffset(new Integer[]{1, 1})

Parameters:

offset - the offset [x, y]

Returns:

the instance

setOffset

public LabelStyle setOffset(int xPixels,
                            int yPixels)

Sets offset.

Example:

LabelStyle.setOffset(1, 1)

Parameters:

xPixels - offset pixels in x

yPixels - offset pixels in y

Returns:

the instance