NTBalloonPopupStyleBuilder
@interface NTBalloonPopupStyleBuilder : NTPopupStyleBuilder
A builder class for BalloonPopupStyle.
-
Constructs a BalloonPopupStyleBuilder object with all parameters set to defaults.
Declaration
Objective-C
- (id)init;
-
Returns the corner radius of the popup.
Declaration
Objective-C
- (int)getCornerRadius;
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;
Parameters
cornerRadius
The new corner radius in dp.
-
Returns the background color of the left part of the popup.
Declaration
Objective-C
- (NTColor *)getLeftColor;
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:(NTColor *)leftColor;
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
- (NTBitmap *)getLeftImage;
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:(NTBitmap *)leftImage;
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
- (NTBalloonPopupMargins *)getLeftMargins;
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:(NTBalloonPopupMargins *)leftMargins;
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
- (NTColor *)getRightColor;
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:(NTColor *)rightColor;
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
- (NTBitmap *)getRightImage;
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:(NTBitmap *)rightImage;
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
- (NTBalloonPopupMargins *)getRightMargins;
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:(NTBalloonPopupMargins *)rightMargins;
Parameters
rightMargins
The new margins for the right part of the popup in dp.
-
Returns the color of the title.
Declaration
Objective-C
- (NTColor *)getTitleColor;
Return Value
The color of the title.
-
Sets the color of the title. The default is 0xFF000000.
Declaration
Objective-C
- (void)setTitleColor:(NTColor *)titleColor;
Parameters
titleColor
The new color for the title.
-
Returns the name of the title font.
Declaration
Objective-C
- (NSString *)getTitleFontName;
Return Value
The name of the title font.
-
Sets the name of the title font. It must be one of the fonts bundled with the platform. The default is HelveticaNeue-Light.
Declaration
Objective-C
- (void)setTitleFontName:(NSString *)titleFontName;
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;
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;
Parameters
field
The text field to use for displaying title from metainfo.
-
Returns the size of the title font.
Declaration
Objective-C
- (int)getTitleFontSize;
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;
Parameters
titleFontSize
The new size for the title font in pts.
-
Returns the margins of the title.
Declaration
Objective-C
- (NTBalloonPopupMargins *)getTitleMargins;
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:(NTBalloonPopupMargins *)titleMargins;
Parameters
titleMargins
The new margins for the title in dp.
-
Returns the state of the title wrap parameter.
Declaration
Objective-C
- (BOOL)isTitleWrap;
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;
Parameters
titleWrap
The new state of the title wrap parameter.
-
Returns the color of the description.
Declaration
Objective-C
- (NTColor *)getDescriptionColor;
Return Value
The color of the description.
-
Sets the color of the description. The default is 0xFF000000.
Declaration
Objective-C
- (void)setDescriptionColor:(NTColor *)descColor;
Parameters
descColor
The new color for the description.
-
Returns the name of the description font.
Declaration
Objective-C
- (NSString *)getDescriptionFontName;
Return Value
The name of the description font.
-
Sets the name of the description font. It must be one of the fonts bundled with the platform. The default is HelveticaNeue-Light.
Declaration
Objective-C
- (void)setDescriptionFontName:(NSString *)descFontName;
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;
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;
Parameters
field
The description field to use for displaying text from metainfo.
-
Returns the size of the description font.
Declaration
Objective-C
- (int)getDescriptionFontSize;
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;
Parameters
descFontSize
The new size for the description font in pts.
-
Returns the margins of the description.
Declaration
Objective-C
- (NTBalloonPopupMargins *)getDescriptionMargins;
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:(NTBalloonPopupMargins *)descMargins;
Parameters
descMargins
The new margins for the description in dp.
-
Returns the state of the description wrap parameter.
Declaration
Objective-C
- (BOOL)isDescriptionWrap;
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;
Parameters
descWrap
The new state of the description wrap parameter.
-
Returns the margins for popup buttons.
Declaration
Objective-C
- (NTBalloonPopupMargins *)getButtonMargins;
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:(NTBalloonPopupMargins *)buttonMargins;
Parameters
buttonMargins
The new popup margins for the buttons in dp.
-
Returns the color of the stroke surrounding the popup.
Declaration
Objective-C
- (NTColor *)getStrokeColor;
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:(NTColor *)strokeColor;
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;
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;
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;
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;
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;
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;
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
- (NTBalloonPopupStyle *)buildStyle;
Return Value
A new BalloonPopupStyle object.
-
Undocumented
Declaration
Objective-C
-(void)dealloc;