| java.lang.Object | ||||
| ↳ | com.carto.styles.Style | |||
| ↳ | com.carto.styles.BillboardStyle | |||
| ↳ | com.carto.styles.PopupStyle | |||
| ↳ | com.carto.styles.BalloonPopupStyle | |||
Class Overview
A style for balloon popups. Contains attributes for configuring how the balloon popup is drawn on the screen.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| synchronized void | delete() | ||||||||||
| Color |
getBackgroundColor()
Returns the background color of the popup.
| ||||||||||
| BalloonPopupMargins |
getButtonMargins()
Returns the margins for the buttons of the popup.
| ||||||||||
| int |
getCornerRadius()
Returns the corner radius of the popup.
| ||||||||||
| Color |
getDescriptionColor()
Returns the color of the description.
| ||||||||||
| String |
getDescriptionField()
Returns the description field variable to use.
| ||||||||||
| String |
getDescriptionFontName()
Returns the name of the description font.
| ||||||||||
| int |
getDescriptionFontSize()
Returns the size of the description font.
| ||||||||||
| BalloonPopupMargins |
getDescriptionMargins()
Returns the margins of the description.
| ||||||||||
| Color |
getLeftColor()
Returns the background color of the left part of the popup.
| ||||||||||
| Bitmap |
getLeftImage()
Returns the image of the left part of the popup.
| ||||||||||
| BalloonPopupMargins |
getLeftMargins()
Returns the margins of the left part of the popup.
| ||||||||||
| Color |
getRightColor()
Returns the background color of the right part of the popup.
| ||||||||||
| Bitmap |
getRightImage()
Returns the image of the right part of the popup.
| ||||||||||
| BalloonPopupMargins |
getRightMargins()
Returns the margins of the right part of the popup.
| ||||||||||
| Color |
getStrokeColor()
Returns the color of the stroke surrounding the popup.
| ||||||||||
| int |
getStrokeWidth()
Returns the width of the stroke surrounding the popup.
| ||||||||||
| Color |
getTitleColor()
Returns the color of the title.
| ||||||||||
| String |
getTitleField()
Returns the title field variable to use.
| ||||||||||
| String |
getTitleFontName()
Returns the name of the title font.
| ||||||||||
| int |
getTitleFontSize()
Returns the size of the title font.
| ||||||||||
| BalloonPopupMargins |
getTitleMargins()
Returns the margins of the title.
| ||||||||||
| int |
getTriangleHeight()
Returns the height of the triangle at the bottom of the popup.
| ||||||||||
| int |
getTriangleWidth()
Returns the width of the triangle at the bottom of the popup.
| ||||||||||
| boolean |
isDescriptionWrap()
Returns the state of the description wrap parameter.
| ||||||||||
| boolean |
isTitleWrap()
Returns the state of the title wrap parameter.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.carto.styles.PopupStyle
| |||||||||||
|
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 popup.
Returns
- The background color of the popup.
public BalloonPopupMargins getButtonMargins ()
Returns the margins for the buttons of the popup.
Returns
- The margins for the buttons of the popup.
public int getCornerRadius ()
Returns the corner radius of the popup.
Returns
- The corner radius of the popup.
public Color getDescriptionColor ()
Returns the color of the description.
Returns
- The color of the description.
public String getDescriptionField ()
Returns the description field variable to use.
Returns
- The description field variable.
public String getDescriptionFontName ()
Returns the name of the description font.
Returns
- The name of the description font.
public int getDescriptionFontSize ()
Returns the size of the description font.
Returns
- The size of the description font.
public BalloonPopupMargins getDescriptionMargins ()
Returns the margins of the description.
Returns
- The margins of the description.
public Color getLeftColor ()
Returns the background color of the left part of the popup.
Returns
- The background color of the left part of the popup.
public Bitmap getLeftImage ()
Returns the image of the left part of the popup.
Returns
- The image of the left part of the popup.
public BalloonPopupMargins getLeftMargins ()
Returns the margins of the left part of the popup.
Returns
- The margins of the left part of the popup.
public Color getRightColor ()
Returns the background color of the right part of the popup.
Returns
- The background color of the right part of the popup.
public Bitmap getRightImage ()
Returns the image of the right part of the popup.
Returns
- The image of the right part of the popup.
public BalloonPopupMargins getRightMargins ()
Returns the margins of the right part of the popup.
Returns
- The margins of the right part of the popup.
public Color getStrokeColor ()
Returns the color of the stroke surrounding the popup.
Returns
- The color of the stroke surrounding the popup.
public int getStrokeWidth ()
Returns the width of the stroke surrounding the popup.
Returns
- The width of the stroke surrounding the popup in dp.
public String getTitleField ()
Returns the title field variable to use.
Returns
- The title field variable.
public String getTitleFontName ()
Returns the name of the title font.
Returns
- The name of the title font.
public int getTitleFontSize ()
Returns the size of the title font.
Returns
- The size of the title font.
public BalloonPopupMargins getTitleMargins ()
Returns the margins of the title.
Returns
- The margins of the title.
public int getTriangleHeight ()
Returns the height of the triangle at the bottom of the popup.
Returns
- The height of the triangle at the bottom of the popup in dp.
public int getTriangleWidth ()
Returns the width of the triangle at the bottom of the popup.
Returns
- The width of the triangle at the bottom of the popup in dp.
public boolean isDescriptionWrap ()
Returns the state of the description wrap parameter.
Returns
- True if long descriptions are wrapped, false if it is truncated.
public boolean isTitleWrap ()
Returns the state of the title wrap parameter.
Returns
- True if long titles are wrapped, false if it is truncated.