qnx.events.ViewerEvent

ViewerEvent

Properties | Methods | Constants


Packageqnx.events
Classpublic class ViewerEvent
InheritanceViewerEvent Inheritance flash.events.Event

An event dispatched by a Viewer instance.

Class information:
BlackBerry 10 Version:   10.0.0
Found in:  QNXDevice.ane

See also

qnx.display.Viewer



Public Properties

 PropertyDefined By
  data : Object
[read-only] Gets the data of the event.
ViewerEvent
  message : String
[read-only] Returns the message for the event.
ViewerEvent

Public Methods

 MethodDefined By
  
ViewerEvent(type:String, message:String = null, data:Object = null, cancelable:Boolean = false)
Creates a ViewerEvent instance.
ViewerEvent

Public Constants

 ConstantDefined By
  VIEWER_CLOSED : String = viewerClosed
[static] Dispatched when a viewer is closed.
ViewerEvent
  VIEWER_CLOSING : String = viewerClosing
[static] Dispatched when a viewer is closing.
ViewerEvent
  VIEWER_CREATED : String = viewerCreated
[static] Dispatched after a viewer has been successfully created.
ViewerEvent
  VIEWER_MESSAGE : String = viewerMessage
[static] Dispatched when a viewer sends a message to the application.
ViewerEvent
  VIEWER_RESIZE : String = viewerResize
[static] Dispatched when a viewer has been successfully resized.
ViewerEvent

Property Detail

data


data:Object  [read-only]

Gets the data of the event.


Implementation

public function get data():Object

message


message:String  [read-only]

Returns the message for the event.


Implementation

public function get message():String

Constructor Detail

ViewerEvent()


public function ViewerEvent(type:String, message:String = null, data:Object = null, cancelable:Boolean = false)

Creates a ViewerEvent instance.

Parameters

type:String — The event type.
message:String (default = null) — The message of the event.
data:Object (default = null) — The data for the event.
cancelable:Boolean (default = false) — Wether the event can be canceled.

Constant Detail

VIEWER_CLOSED


public static const VIEWER_CLOSED:String = viewerClosed

Dispatched when a viewer is closed.

The ViewerEvent.VIEWER_CLOSED constant defines the value of the type property of the event object for an viewerClosed 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_CLOSED

VIEWER_CLOSING


public static const VIEWER_CLOSING:String = viewerClosing

Dispatched when a viewer is closing.

This event can be canceled if applications wish to close the viewer themselves. This is useful if you wish to transition the viewer out on a close. If canceled it is the responsibility of the application to call dispose() on the viewer.

The ViewerEvent.VIEWER_CLOSING constant defines the value of the type property of the event object for an viewerClosing event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
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_CLOSING

VIEWER_CREATED


public static const VIEWER_CREATED:String = viewerCreated

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

VIEWER_MESSAGE


public static const VIEWER_MESSAGE:String = viewerMessage

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

VIEWER_RESIZE


public static const VIEWER_RESIZE:String = viewerResize

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