Cover Labels

Represents a label object to be displayed on the application's window cover.


Learning Resources:

Sample - Using a label on a Window Cover Sample that demonstrates how to use the BlackBerry CoverLabel API [BlackBerry on GitHub].

Supported Platform(s)

- BlackBerry 10
View Supported Platform Table
APIBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
label           Y 
size           Y 
wrap           Y 

Configuration Document Settings

To use all of the API described for this object, you must ensure the following settings are in your configuration document:

You must declare the feature element(s) below in your configuration document:

Feature IDBB5.0BB6.0BB7.0PB1.0PB2.0BB10Ripple
<feature id="blackberry.ui.cover" />           Y 

Permission Elements (PlayBook and BlackBerry 10+)
This API does not require a <permission> element to be declared in the configuration document of your BlackBerry WebWorks Application.

Properties

String label
Number size
Boolean wrap

Properties

String label


text to be displayed for this label


Supported Platforms
 - BlackBerry 10

Number size


text size


Supported Platforms
 - BlackBerry 10

Boolean wrap


whether or not the label text should wrap to the next line


Supported Platforms
 - BlackBerry 10

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Feb 11 2013 14:51:05 GMT-0500 (EST)