MSFBalloonPopupStyleBuilder

Objective-C


@interface MSFBalloonPopupStyleBuilder : MSFPopupStyleBuilder

Swift

class MSFBalloonPopupStyleBuilder : MSFPopupStyleBuilder

A builder class for BalloonPopupStyle.

  • Constructs a BalloonPopupStyleBuilder object with all parameters set to defaults.

    Declaration

    Objective-C

    - (id)init;

    Swift

    init!()

  • Returns the corner radius of the popup.

    Declaration

    Objective-C

    - (int)getCornerRadius;

    Swift

    func getCornerRadius() -> Int32

    Return Value

    The corner radius of the popup in dp.

  • Sets the corner radius of the popup. Bigger values mean rounder corners, 0 creates a rectangular popup. The default is 3.

    Declaration

    Objective-C

    - (void)setCornerRadius:(int)cornerRadius;

    Swift

    func setCornerRadius(_ cornerRadius: Int32)

    Parameters

    cornerRadius

    The new corner radius in dp.

  • Returns the background color of the left part of the popup.

    Declaration

    Objective-C

    - (MSFColor *)getLeftColor;

    Swift

    func getLeftColor() -> MSFColor!

    Return Value

    The background color of the left part of the popup.

  • Sets the background color of the left part of the popup. The size of the colored area is determined by the left margins and the left image. The default is 0xFF00B483.

    Declaration

    Objective-C

    - (void)setLeftColor:(MSFColor *)leftColor;

    Swift

    func setLeftColor(_ leftColor: MSFColor!)

    Parameters

    leftColor

    The new color for the left part of the popup.

  • Returns the image of the left part of the popup.

    Declaration

    Objective-C

    - (MSFBitmap *)getLeftImage;

    Swift

    func getLeftImage() -> MSFBitmap!

    Return Value

    The image of the left part of the popup.

  • Sets the image for the left part of the popup. If null is passed no image will be drawn. The default is null.

    Declaration

    Objective-C

    - (void)setLeftImage:(MSFBitmap *)leftImage;

    Swift

    func setLeftImage(_ leftImage: MSFBitmap!)

    Parameters

    leftImage

    The new image for the left part of the popup.

  • Returns the margins of the left part of the popup.

    Declaration

    Objective-C

    - (MSFBalloonPopupMargins *)getLeftMargins;

    Swift

    func getLeftMargins() -> MSFBalloonPopupMargins!

    Return Value

    The margins of the left part of the popup.

  • Sets the margins for the left part of the popup. The margins will determine how much empty space should surround the left image. The default is BalloonPopupMargins(5, 0, 5, 0).

    Declaration

    Objective-C

    - (void)setLeftMargins:(MSFBalloonPopupMargins *)leftMargins;

    Swift

    func setLeftMargins(_ leftMargins: MSFBalloonPopupMargins!)

    Parameters

    leftMargins

    The new margins for the left part of the popup in dp.

  • Returns the background color of the right part of the popup.

    Declaration

    Objective-C

    - (MSFColor *)getRightColor;

    Swift

    func getRightColor() -> MSFColor!

    Return Value

    The background color of the right part of the popup.

  • Sets the background color of the right part of the popup. The size of the colored area is determined by the right margins and the right image. The default is 0xFF00B483.

    Declaration

    Objective-C

    - (void)setRightColor:(MSFColor *)rightColor;

    Swift

    func setRightColor(_ rightColor: MSFColor!)

    Parameters

    rightColor

    The new color for the right part of the popup.

  • Returns the image of the right part of the popup.

    Declaration

    Objective-C

    - (MSFBitmap *)getRightImage;

    Swift

    func getRightImage() -> MSFBitmap!

    Return Value

    The image of the right part of the popup.

  • Sets the image for the right part of the popup. If null is passed no image will be drawn. The default is null.

    Declaration

    Objective-C

    - (void)setRightImage:(MSFBitmap *)rightImage;

    Swift

    func setRightImage(_ rightImage: MSFBitmap!)

    Parameters

    rightImage

    The new image for the right part of the popup.

  • Returns the margins of the right part of the popup.

    Declaration

    Objective-C

    - (MSFBalloonPopupMargins *)getRightMargins;

    Swift

    func getRightMargins() -> MSFBalloonPopupMargins!

    Return Value

    The margins of the right part of the popup.

  • Sets the margins for the right part of the popup. The margins will determine how much empty space should surround the right image. The default is BalloonPopupMargins(5, 0, 5, 0).

    Declaration

    Objective-C

    - (void)setRightMargins:(MSFBalloonPopupMargins *)rightMargins;

    Swift

    func setRightMargins(_ rightMargins: MSFBalloonPopupMargins!)

    Parameters

    rightMargins

    The new margins for the right part of the popup in dp.

  • Returns the color of the title.

    Declaration

    Objective-C

    - (MSFColor *)getTitleColor;

    Swift

    func getTitleColor() -> MSFColor!

    Return Value

    The color of the title.

  • Sets the color of the title. The default is 0xFF000000.

    Declaration

    Objective-C

    - (void)setTitleColor:(MSFColor *)titleColor;

    Swift

    func setTitleColor(_ titleColor: MSFColor!)

    Parameters

    titleColor

    The new color for the title.

  • Returns the name of the title font.

    Declaration

    Objective-C

    - (NSString *)getTitleFontName;

    Swift

    func getTitleFontName() -> String!

    Return Value

    The name of the title font.

  • Sets the name of the title font. Accepts a CSS-like list, the most preferred name first, entries optionally tagged with the platform they are for (“android:Roboto, ios:Helvetica Neue, sans-serif”). A name the device has no font for is skipped; generic names (“sans-serif”, “serif”, “monospace”, “Arial”, …) map to the platform font. The default is HelveticaNeue-Light.

    Declaration

    Objective-C

    - (void)setTitleFontName:(NSString *)titleFontName;

    Swift

    func setTitleFontName(_ titleFontName: String!)

    Parameters

    titleFontName

    The new name for the title font.

  • Returns the title field variable. If not empty, this variable is used to read actual text string from object meta info.

    Declaration

    Objective-C

    - (NSString *)getTitleField;

    Swift

    func getTitleField() -> String!

    Return Value

    The current title variable.

  • Sets the title field variable. If not empty, this variable is used to read actual text string from object meta info.

    Declaration

    Objective-C

    - (void)setTitleField:(NSString *)field;

    Swift

    func setTitleField(_ field: String!)

    Parameters

    field

    The text field to use for displaying title from metainfo.

  • Returns the size of the title font.

    Declaration

    Objective-C

    - (int)getTitleFontSize;

    Swift

    func getTitleFontSize() -> Int32

    Return Value

    The size of the title font.

  • Sets the size of the title font. The default is 16.

    Declaration

    Objective-C

    - (void)setTitleFontSize:(int)titleFontSize;

    Swift

    func setTitleFontSize(_ titleFontSize: Int32)

    Parameters

    titleFontSize

    The new size for the title font in pts.

  • Returns the margins of the title.

    Declaration

    Objective-C

    - (MSFBalloonPopupMargins *)getTitleMargins;

    Swift

    func getTitleMargins() -> MSFBalloonPopupMargins!

    Return Value

    The margins of the title.

  • Sets the margins for the title. The margins will determine how much empty space should surround the title. The default is BalloonPopupMargins(8, 4, 8, 0).

    Declaration

    Objective-C

    - (void)setTitleMargins:(MSFBalloonPopupMargins *)titleMargins;

    Swift

    func setTitleMargins(_ titleMargins: MSFBalloonPopupMargins!)

    Parameters

    titleMargins

    The new margins for the title in dp.

  • Returns the state of the title wrap parameter.

    Declaration

    Objective-C

    - (BOOL)isTitleWrap;

    Swift

    func isTitleWrap() -> Bool

    Return Value

    True if long titles are wrapped, false if it is truncated.

  • Sets the state of the title wrap parameter. If set to true, long titles that are wider than the sreen width will be wrapped to multiple lines, increasing the height of the popup. If set to false, long titles are truncated with three dots.

    Declaration

    Objective-C

    - (void)setTitleWrap:(BOOL)titleWrap;

    Swift

    func setTitleWrap(_ titleWrap: Bool)

    Parameters

    titleWrap

    The new state of the title wrap parameter.

  • Returns the color of the description.

    Declaration

    Objective-C

    - (MSFColor *)getDescriptionColor;

    Swift

    func getDescriptionColor() -> MSFColor!

    Return Value

    The color of the description.

  • Sets the color of the description. The default is 0xFF000000.

    Declaration

    Objective-C

    - (void)setDescriptionColor:(MSFColor *)descColor;

    Swift

    func setDescriptionColor(_ descColor: MSFColor!)

    Parameters

    descColor

    The new color for the description.

  • Returns the name of the description font.

    Declaration

    Objective-C

    - (NSString *)getDescriptionFontName;

    Swift

    func getDescriptionFontName() -> String!

    Return Value

    The name of the description font.

  • Sets the name of the description font. Accepts a CSS-like list, the most preferred name first, entries optionally tagged with the platform they are for (“android:Roboto, ios:Helvetica Neue, sans-serif”). A name the device has no font for is skipped; generic names (“sans-serif”, “serif”, “monospace”, “Arial”, …) map to the platform font. The default is HelveticaNeue-Light.

    Declaration

    Objective-C

    - (void)setDescriptionFontName:(NSString *)descFontName;

    Swift

    func setDescriptionFontName(_ descFontName: String!)

    Parameters

    descFontName

    The new name for the description font.

  • Returns the description field variable. If not empty, this variable is used to read actual text string from object meta info.

    Declaration

    Objective-C

    - (NSString *)getDescriptionField;

    Swift

    func getDescriptionField() -> String!

    Return Value

    The current description variable.

  • Sets the description field variable. If not empty, this variable is used to read actual text string from object meta info.

    Declaration

    Objective-C

    - (void)setDescriptionField:(NSString *)field;

    Swift

    func setDescriptionField(_ field: String!)

    Parameters

    field

    The description field to use for displaying text from metainfo.

  • Returns the size of the description font.

    Declaration

    Objective-C

    - (int)getDescriptionFontSize;

    Swift

    func getDescriptionFontSize() -> Int32

    Return Value

    The size of the description font.

  • Sets the size of the description font. The default is 14.

    Declaration

    Objective-C

    - (void)setDescriptionFontSize:(int)descFontSize;

    Swift

    func setDescriptionFontSize(_ descFontSize: Int32)

    Parameters

    descFontSize

    The new size for the description font in pts.

  • Returns the margins of the description.

    Declaration

    Objective-C

    - (MSFBalloonPopupMargins *)getDescriptionMargins;

    Swift

    func getDescriptionMargins() -> MSFBalloonPopupMargins!

    Return Value

    The margins of the description.

  • Sets the margins for the description. The margins will determine how much empty space should surround the description. The default is BalloonPopupMargins(8, 0, 8, 6).

    Declaration

    Objective-C

    - (void)setDescriptionMargins:(MSFBalloonPopupMargins *)descMargins;

    Swift

    func setDescriptionMargins(_ descMargins: MSFBalloonPopupMargins!)

    Parameters

    descMargins

    The new margins for the description in dp.

  • Returns the state of the description wrap parameter.

    Declaration

    Objective-C

    - (BOOL)isDescriptionWrap;

    Swift

    func isDescriptionWrap() -> Bool

    Return Value

    True if long descriptions are wrapped, false if it is truncated.

  • Sets the state of the description wrap parameter. If set to true, long descriptions that are wider than the sreen width will be wrapped to multiple lines, increasing the height of the popup. If set to false, long descriptions are truncated with three dots.

    Declaration

    Objective-C

    - (void)setDescriptionWrap:(BOOL)descWrap;

    Swift

    func setDescriptionWrap(_ descWrap: Bool)

    Parameters

    descWrap

    The new state of the description wrap parameter.

  • Returns the margins for popup buttons.

    Declaration

    Objective-C

    - (MSFBalloonPopupMargins *)getButtonMargins;

    Swift

    func getButtonMargins() -> MSFBalloonPopupMargins!

    Return Value

    The margins for popup buttons.

  • Sets the margins for popup buttons. The margins will determine how much empty space should surround the buttons. The default is BalloonPopupMargins(8, 0, 8, 8).

    Declaration

    Objective-C

    - (void)setButtonMargins:(MSFBalloonPopupMargins *)buttonMargins;

    Swift

    func setButtonMargins(_ buttonMargins: MSFBalloonPopupMargins!)

    Parameters

    buttonMargins

    The new popup margins for the buttons in dp.

  • Returns the color of the stroke surrounding the popup.

    Declaration

    Objective-C

    - (MSFColor *)getStrokeColor;

    Swift

    func getStrokeColor() -> MSFColor!

    Return Value

    The color of the stroke surrounding the popup.

  • Sets the color of the stroke surrounding the popup. The default is 0xFF000000.

    Declaration

    Objective-C

    - (void)setStrokeColor:(MSFColor *)strokeColor;

    Swift

    func setStroke(_ strokeColor: MSFColor!)

    Parameters

    strokeColor

    The new color of the stroke surrounding the popup.

  • Returns the width of the stroke surrounding the popup.

    Declaration

    Objective-C

    - (int)getStrokeWidth;

    Swift

    func getStrokeWidth() -> Int32

    Return Value

    The width of the stroke surrounding the popup in dp.

  • Sets the width of the stroke surrounding the popup. The default is 1.

    Declaration

    Objective-C

    - (void)setStrokeWidth:(int)strokeWidth;

    Swift

    func setStrokeWidth(_ strokeWidth: Int32)

    Parameters

    strokeWidth

    The new width of the stroke surrounding the popup.

  • Returns the width of the triangle at the bottom of the popup.

    Declaration

    Objective-C

    - (int)getTriangleWidth;

    Swift

    func getTriangleWidth() -> Int32

    Return Value

    The width of the triangle at the bottom of the popup in dp.

  • Sets the width of the triangle at the bottom of the popup. The default is 20.

    Declaration

    Objective-C

    - (void)setTriangleWidth:(int)triangleWidth;

    Swift

    func setTriangleWidth(_ triangleWidth: Int32)

    Parameters

    triangleWidth

    The new width of the triangle at the bottom of the popup.

  • Returns the height of the triangle at the bottom of the popup.

    Declaration

    Objective-C

    - (int)getTriangleHeight;

    Swift

    func getTriangleHeight() -> Int32

    Return Value

    The height of the triangle at the bottom of the popup in dp.

  • Sets the height of the triangle at the bottom of the popup. The default is 10.

    Declaration

    Objective-C

    - (void)setTriangleHeight:(int)triangleHeight;

    Swift

    func setTriangleHeight(_ triangleHeight: Int32)

    Parameters

    triangleHeight

    The new height of the triangle at the bottom of the popup.

  • Builds a new instance of the BalloonPopupStyle object using previously set parameters.

    Declaration

    Objective-C

    - (MSFBalloonPopupStyle *)buildStyle;

    Swift

    func buildStyle() -> MSFBalloonPopupStyle!

    Return Value

    A new BalloonPopupStyle object.

  • Undocumented

    Declaration

    Objective-C

    -(void)dealloc;

    Swift

    func dealloc()