Cover

Represents a cover object to pass to updateCovers.

Since: BlackBerry WebWorks 2.1

Synopsis:

blackberry.ui.cover.Cover(name, type)

Example:

new blackberry.ui.cover.Cover("fullSize", blackberry.ui.cover.TYPE_SNAPSHOT)
Arguments to constructor
Argument Type Argument Name
String name
String type
Property Type Property Name
String name
String type
Label[] text
String transition
Boolean badges
Object capture
String path

name

The name of the cover. Cover names can be obtained using the getCoverSizes() function. In BlackBerry 10.3, available names are "fullSize" and "halfSize".

Synopsis:

String Cover.name

type

The type of cover. See Window Covers constants.

Synopsis:

String Cover.type

text

Array of labels.

Synopsis:

Label[] Cover.text

transition

The transition animation. See Window Covers constants.

Synopsis:

String Cover.transition

badges

When true, notification badges will appear on top of the cover.

Synopsis:

Boolean Cover.badges

capture

Boundaries when using TYPE_SNAPSHOT.

Synopsis:

Object Cover.capture

Parameters

rect
Type: Object

The rectangle to capture (optional; defaults to full screen).

x
Type: Number

Horizontal displacement of the rectangle from the upper-left corner, in pixels.

y
Type: Number

Vertical displacement of the rectangle from the upper-left corner, in pixels.

Width
Type: Number

Width of the rectangle in pixels.

Height
Type: Number

Height of the rectangle in pixels.

path

Path to the image when using TYPE_IMAGE.

Synopsis:

String Cover.path

Last modified: 2015-02-19



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus