qnx.system.QNXCover

QNXCover

Properties | Methods | Events


Packageqnx.system
Classpublic final class QNXCover
InheritanceQNXCover Inheritance flash.events.EventDispatcher

The QNXCover class provides access to app window cover related functionality.

Class information:
BlackBerry 10 Version:   10.0.0

See also

QNXCover



Public Properties

 PropertyDefined By
  badges : String
Used to specify whether badges are to be displayed on cover images.
QNXCover
  coverHeight : int
[read-only] Get the required cover image height.
QNXCover
  coverWidth : int
[read-only] Get the required cover image width.
QNXCover
  qnxCover : QNXCover
[static] [read-only] Returns the singleton QNXCover object.
QNXCover
  text : Vector.<QNXCoverText>
Used to specify the text to be displayed on the cover image.
QNXCover
  transition : String
Used to specify the transition rendering from the current app window to the cover image.
QNXCover

Public Methods

 MethodDefined By
  
Use the static qnxCover property to return a QNXCover instance.
QNXCover
  
setCoverFromFile(path:String):void
Used to specify that a file based image is to be used as the cover image for this app.
QNXCover
  
setCoverFromWindow(nativeWin:NativeWindow = null):void
Used to specify that an app managed NativeWindow is to be used as the cover image for this app.
QNXCover

Events

 Event Summary Defined By
   Dispatched when the cover image is about to be displayed.QNXCover
   Dispatched when the cover image is about to be removed.QNXCover
   Dispatched when the cover size is changed.QNXCover

Property Detail

badges


badges:String

Used to specify whether badges are to be displayed on cover images.


Implementation

public function get badges():String
public function set badges(value:String):void

See also

QNXCoverBadge

coverHeight


coverHeight:int  [read-only]

Get the required cover image height.


Implementation

public function get coverHeight():int

coverWidth


coverWidth:int  [read-only]

Get the required cover image width.


Implementation

public function get coverWidth():int

qnxCover


qnxCover:QNXCover  [read-only]

Returns the singleton QNXCover object.


Implementation

public static function get qnxCover():QNXCover

text


text:Vector.<QNXCoverText>

Used to specify the text to be displayed on the cover image.


Implementation

public function get text():Vector.<QNXCoverText>
public function set text(value:Vector.<QNXCoverText>):void

transition


transition:String

Used to specify the transition rendering from the current app window to the cover image.


Implementation

public function get transition():String
public function set transition(value:String):void

See also

QNXCoverTransition

Constructor Detail

QNXCover()


public function QNXCover()

Use the static qnxCover property to return a QNXCover instance.

See also

system

Method Detail

setCoverFromFile()


public function setCoverFromFile(path:String):void

Used to specify that a file based image is to be used as the cover image for this app.

Parameters

path:String — The path to an image file that is to be used as the cover image.

setCoverFromWindow()


public function setCoverFromWindow(nativeWin:NativeWindow = null):void

Used to specify that an app managed NativeWindow is to be used as the cover image for this app.

Parameters

nativeWin:NativeWindow (default = null) — The NativeWindow to use as the cover image.

Event Detail

coverEnter


Event Object Type: qnx.events.QNXCoverEvent
QNXCoverEvent.type property = qnx.events.QNXCoverEvent.COVER_ENTER

Dispatched when the cover image is about to be displayed.

coverExit


Event Object Type: qnx.events.QNXCoverEvent
QNXCoverEvent.type property = qnx.events.QNXCoverEvent.COVER_EXIT

Dispatched when the cover image is about to be removed.

coverSize


Event Object Type: qnx.events.QNXCoverEvent
QNXCoverEvent.type property = qnx.events.QNXCoverEvent.COVER_SIZE

Dispatched when the cover size is changed.




comments powered by Disqus