qnx.display.Viewer

Viewer

Properties | Methods | Events


Packageqnx.display
Classpublic final class Viewer
InheritanceViewer Inheritance flash.events.EventDispatcher

A viewer which was invoked by calling the InvokeManager.invokeViewer() method. Applications should not create their own Viewer instances.

Class information:
BlackBerry 10 Version:   10.0.0

See also

InvokeManager.invokeViewer()



Public Properties

 PropertyDefined By
  height : int
[read-only] Gets or sets the height of the viewer.
Viewer
  id : String
[read-only] Gets the id of the viewer.
Viewer
  visible : Boolean
Gets or sets the visibility of the viewer.
Viewer
  width : int
[read-only] Gets or sets the width of the viewer.
Viewer
  x : int
Gets or sets the position on the x-axis of the viewer.
Viewer
  y : int
Gets or sets the position on the y-axis of the viewer.
Viewer
  zOrder : int
Gets or sets the z order of the viewer.
Viewer

Public Methods

 MethodDefined By
  
Creates a Viewer instance.
Viewer
  
dispose():void
Disposes of the viewer.
Viewer
  
resize(width:Number, height:Number):void
Resizes the viewer to the requested width and height.
Viewer
  
sendMessage(message:String, data:Object):void
Sends a custom message to the viewer.
Viewer

Events

 Event Summary Defined By
  Dispatched when the viewer has been created.Viewer
  Dispatched when the viewer has sent a message to the application.Viewer
  Dispatched when the viewer has been successfully resized.Viewer

Property Detail

height


height:int  [read-only]

Gets or sets the height of the viewer.


Implementation

public function get height():int

id


id:String  [read-only]

Gets the id of the viewer.


Implementation

public function get id():String

visible


visible:Boolean

Gets or sets the visibility of the viewer.


Implementation

public function get visible():Boolean
public function set visible(value:Boolean):void

width


width:int  [read-only]

Gets or sets the width of the viewer.


Implementation

public function get width():int

x


x:int

Gets or sets the position on the x-axis of the viewer.


Implementation

public function get x():int
public function set x(value:int):void

y


y:int

Gets or sets the position on the y-axis of the viewer.


Implementation

public function get y():int
public function set y(value:int):void

zOrder


zOrder:int

Gets or sets the z order of the viewer.


Implementation

public function get zOrder():int
public function set zOrder(value:int):void

Constructor Detail

Viewer()


public function Viewer(request:InvokeViewerRequest)

Creates a Viewer instance. Application should not create their own instances. Viewer instances are returned by the InvokeManager.invokeViewer() method.

Parameters

request:InvokeViewerRequest — The request used to invoke the viewer.

See also

InvokeManager.invokeViewer()

Method Detail

dispose()


public function dispose():void

Disposes of the viewer.

resize()


public function resize(width:Number, height:Number):void

Resizes the viewer to the requested width and height.

Parameters

width:Number — The new width of the viewer.
height:Number — The new height of the viewer.

sendMessage()


public function sendMessage(message:String, data:Object):void

Sends a custom message to the viewer.

Parameters

message:String — The message to send to the viewer.
data:Object — The data to send to the viewer.

Event Detail

viewerCreated


Event Object Type: qnx.events.ViewerEvent
ViewerEvent.type property = qnx.events.ViewerEvent.VIEWER_CREATED

Dispatched when the viewer has been created.

Dispatched after a viewer has been successfully created.

The ViewerEvent.VIEWER_CREATED constant defines the value of the type property of the event object for an viewerCreated event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
dataThe data property is null during this event.
messageThe message property is null during this event.
typeViewerEvent.VIEWER_CREATED

viewerMessage


Event Object Type: qnx.events.ViewerEvent
ViewerEvent.type property = qnx.events.ViewerEvent.VIEWER_MESSAGE

Dispatched when the viewer has sent a message to the application.

Dispatched when a viewer sends a message to the application.

The ViewerEvent.VIEWER_MESSAGE constant defines the value of the type property of the event object for an viewerMessage event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
dataThe data associated with the message.
messageThe message sent by the viewer to the application.
typeViewerEvent.VIEWER_MESSAGE

viewerResize


Event Object Type: qnx.events.ViewerEvent
ViewerEvent.type property = qnx.events.ViewerEvent.VIEWER_RESIZE

Dispatched when the viewer has been successfully resized.

Dispatched when a viewer has been successfully resized.

The ViewerEvent.VIEWER_RESIZE constant defines the value of the type property of the event object for an viewerResize event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe object that is actively processing the Event object with an event listener.
dataThe data property is null during this event.
messageThe message property is null during this event.
typeViewerEvent.VIEWER_RESIZE




comments powered by Disqus