| java.lang.Object | ||||
| ↳ | com.carto.styles.Style | |||
| ↳ | com.carto.styles.BillboardStyle | |||
| ↳ | com.carto.styles.LabelStyle | |||
| ↳ | com.carto.styles.TextStyle | |||
Class Overview
A style for text labels. Contains attributes for configuring how the text label is drawn on the screen.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| synchronized void | delete() | ||||||||||
| Color |
getBackgroundColor()
Returns the background color of the text.
| ||||||||||
| Color |
getBorderColor()
Returns the color of the border.
| ||||||||||
| float |
getBorderWidth()
Returns the width of the border.
| ||||||||||
| Color |
getFontColor()
Returns the font's color.
| ||||||||||
| String |
getFontName()
Returns the font's name.
| ||||||||||
| float |
getFontSize()
Returns the font's size.
| ||||||||||
| Color |
getStrokeColor()
Returns the color of the stroke.
| ||||||||||
| float |
getStrokeWidth()
Returns the width of the stroke.
| ||||||||||
| String |
getTextField()
Returns the text field variable to use.
| ||||||||||
| TextMargins |
getTextMargins()
Returns the margins for the text.
| ||||||||||
| boolean |
isBreakLines()
Returns the state of the 'break lines' flag.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.carto.styles.LabelStyle
| |||||||||||
|
From class
com.carto.styles.BillboardStyle
| |||||||||||
|
From class
com.carto.styles.Style
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Methods
public synchronized void delete ()
public Color getBackgroundColor ()
Returns the background color of the text.
Returns
- The background color of the text.
public Color getBorderColor ()
Returns the color of the border.
Returns
- The color of the border around the text.
public float getBorderWidth ()
Returns the width of the border.
Returns
- The width of the border around the text.
public String getFontName ()
Returns the font's name.
Returns
- The platform dependent name of the font.
public float getFontSize ()
Returns the font's size.
Returns
- The size of the font in points.
public Color getStrokeColor ()
Returns the color of the stroke.
Returns
- The color of the stroke around the text.
public float getStrokeWidth ()
Returns the width of the stroke.
Returns
- The width of the stroke around the text.
public String getTextField ()
Returns the text field variable to use.
Returns
- The text field variable.
public TextMargins getTextMargins ()
Returns the margins for the text.
Returns
- The margins for the text.
public boolean isBreakLines ()
Returns the state of the 'break lines' flag.
Returns
- The state of the 'break lines' flag.