| Package | qnx.display |
| Class | public class IowWindow |
| Inheritance | IowWindow  flash.events.EventDispatcher |
IowWindow class contains properties that define the appearance and behavior of your
application display window.
See also
| Property | Defined By | ||
|---|---|---|---|
| acceptsFocus : Boolean
Gets or sets a value that determines if the window accepts keyboard focus when tappped. | IowWindow | ||
| alpha : Number
Gets or sets the global alpha property of the window. | IowWindow | ||
| bufferProtection : int
Gets or sets the DRM buffer locking value. | IowWindow | ||
| clipHeight : int
Gets or sets the height of the clip area for the window (in screen coordinates). | IowWindow | ||
| clipWidth : int
Gets or sets the width of the clip area for the window (in screen coordinates). | IowWindow | ||
| clipX : int
Gets or sets the x coordinate of the clip area for the window (in screen
coordinates). | IowWindow | ||
| clipY : int
Gets or sets the y coordinate of the clip area for the window (in screen
coordinates). | IowWindow | ||
| dialogGroup : String [static]
Gets or sets the window group that is used for internally displayed dialogs. | IowWindow | ||
| displayIndex : int [read-only]
Gets the index of the display on which the window is currently displayed. | IowWindow | ||
| effect : IowWindowEffect | IowWindow | ||
| group : String
Gets or sets the group property of the window. | IowWindow | ||
| height : int
Gets or sets the height of the window. | IowWindow | ||
| id : String
Gets or sets the ID of the window. | IowWindow | ||
| idleMode : String
Provides finer grain control than NativeApplication.systemIdleMode
for cases where there are multiple displays. | IowWindow | ||
| numBuffers : int
Gets or sets the number of buffers. | IowWindow | ||
| ownWindow : Boolean [read-only]
Gets a Boolean that determines if this window belongs to this process. | IowWindow | ||
| pid : int [read-only]
Gets the process ID that is associated with the window. | IowWindow | ||
| rotation : int
Gets or sets the orientation of the window with respect to the device. | IowWindow | ||
| scaleQuality : int [write-only]
Sets the scale quality level. | IowWindow | ||
| sensitivity : String
Gets or sets the sensitivity of the window to pointer events. | IowWindow | ||
| srcHeight : int
Gets or sets the height of the sub-area of the window that is to be displayed. | IowWindow | ||
| srcWidth : int
Gets or sets the width of the sub-area of the window that is to be displayed. | IowWindow | ||
| srcX : int
Gets or sets the x coordinate of the upper left hand corner of the sub-area
of the window to be displayed. | IowWindow | ||
| srcY : int
Gets or sets the y coordinate of the upper left hand corner of the sub-area
of the window to be displayed. | IowWindow | ||
| state : String [read-only]
Gets the state of the window. | IowWindow | ||
| surfaceHeight : int [read-only]
Gets or sets the height of the surface that is associated with the window. | IowWindow | ||
| surfaceWidth : int [read-only]
Gets or sets the width of the surface that is associated with the window. | IowWindow | ||
| swapInterval : int
Gets or sets the swap interval of the window. | IowWindow | ||
| transparency : String
Determines how the window is blended with underlying windows. | IowWindow | ||
| valid : Boolean [read-only]
Gets a value that indicates whether or not the the window currently exists. | IowWindow | ||
| visible : Boolean
Gets or sets the visibility of the window. | IowWindow | ||
| width : int
Gets or sets the width of the window. | IowWindow | ||
| windowClass : String [read-only]
Gets the window class that is associated with the window. | IowWindow | ||
| x : int
Gets or sets the x coordinate of the upper left corner of the window. | IowWindow | ||
| y : int
Gets or sets the y coordinate of the upper left corner of the window. | IowWindow | ||
| zOrder : int
Gets or sets the z-Order property of the window. | IowWindow | ||
| Method | Defined By | ||
|---|---|---|---|
Creates an IowWindow instance. | IowWindow | ||
close():void
Closes the window. | IowWindow | ||
createSnapshot(width:int, height:int, id:String = null, asWindow:Boolean = false):Boolean
Creates a snapshot of the window given a width and height. | IowWindow | ||
Creates a second IowWindow instance that shares the buffers of the original window. | IowWindow | ||
getAirWindow(nativeWin:NativeWindow = null):IowWindow [static]
Returns an IowWindow object for one of the AIR player's windows. | IowWindow | ||
getExternalWindow(pid:int, id:String):IowWindow [static]
Returns an IowWindow object associated with the window of an external application. | IowWindow | ||
keepWindow(keep:Boolean):void
Determines whether or not the window will be destroyed when the owning
process dies. | IowWindow | ||
sendMouseEvent(pressed:Boolean, x:int, y:int):void
Sends a mouse event to the window. | IowWindow | ||
setWindowProperty(propertyId:int, value:int):void
Sets the general window properties, given a property ID and an integer value. | IowWindow | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the snapshot operation completes successfully. | IowWindow | |||
| Dispatched when the snapshot operation fails. | IowWindow | |||
| Dispatched when a window is created. | IowWindow | |||
| Dispatched when a window is destroyed. | IowWindow | |||
| Dispatched when the state of the window changes. | IowWindow | |||
| Dispatched when the visibility of the window changes. | IowWindow | |||
| acceptsFocus | property |
acceptsFocus:BooleanGets or sets a value that determines if the window accepts keyboard focus when tappped. If true the window takes keyboard focus, otherwise false.
public function get acceptsFocus():Boolean public function set acceptsFocus(value:Boolean):void| alpha | property |
alpha:NumberGets or sets the global alpha property of the window.
public function get alpha():Number public function set alpha(value:Number):void| bufferProtection | property |
bufferProtection:intGets or sets the DRM buffer locking value.
public function get bufferProtection():int public function set bufferProtection(value:int):void| clipHeight | property |
clipHeight:intGets or sets the height of the clip area for the window (in screen coordinates).
public function get clipHeight():int public function set clipHeight(value:int):void| clipWidth | property |
clipWidth:intGets or sets the width of the clip area for the window (in screen coordinates).
public function get clipWidth():int public function set clipWidth(value:int):void| clipX | property |
clipX:intGets or sets the x coordinate of the clip area for the window (in screen coordinates).
public function get clipX():int public function set clipX(value:int):void| clipY | property |
clipY:intGets or sets the y coordinate of the clip area for the window (in screen coordinates).
public function get clipY():int public function set clipY(value:int):void| dialogGroup | property |
dialogGroup:StringGets or sets the window group that is used for internally displayed dialogs.
This must match the group ID of an existing window. If set to null, dialogs are created without a group.
public static function get dialogGroup():String public static function set dialogGroup(value:String):void| displayIndex | property |
displayIndex:int [read-only] Gets the index of the display on which the window is currently displayed.
public function get displayIndex():int| effect | property |
effect:IowWindowEffect public function get effect():IowWindowEffect public function set effect(value:IowWindowEffect):void| group | property |
group:StringGets or sets the group property of the window. All windows in the same group are tied together so that moving, scaling, or changing the visibility of the top level window in a group affects all group members.
public function get group():String public function set group(value:String):void| height | property |
height:int
Gets or sets the height of the window. If this is different than srcHeight,
the window is stretched or shrunk.
public function get height():int public function set height(value:int):void| id | property |
id:StringGets or sets the ID of the window.
public function get id():String public function set id(value:String):void| idleMode | property |
idleMode:String
Provides finer grain control than NativeApplication.systemIdleMode
for cases where there are multiple displays. Allows one display
to be kept on while allowing others to turn off. The values for
for this property are defined by the SystemIdleMode class.
public function get idleMode():String public function set idleMode(value:String):void| numBuffers | property |
numBuffers:intGets or sets the number of buffers. Valid values are 1 and 2.
public function get numBuffers():int public function set numBuffers(value:int):void| ownWindow | property |
ownWindow:Boolean [read-only] Gets a Boolean that determines if this window belongs to this process.
public function get ownWindow():Boolean| pid | property |
pid:int [read-only] Gets the process ID that is associated with the window.
public function get pid():int| rotation | property |
rotation:intGets or sets the orientation of the window with respect to the device. The allowed values are 0, 90, 180 and 270.
public function get rotation():int public function set rotation(value:int):void| scaleQuality | property |
scaleQuality:int [write-only] Sets the scale quality level.
public function set scaleQuality(value:int):void| sensitivity | property |
sensitivity:String
Gets or sets the sensitivity of the window to pointer events. Constants
for the valid values of this property are given by the
IowWindowSensitivity class.
public function get sensitivity():String public function set sensitivity(value:String):voidSee also
| srcHeight | property |
srcHeight:intGets or sets the height of the sub-area of the window that is to be displayed.
public function get srcHeight():int public function set srcHeight(value:int):void| srcWidth | property |
srcWidth:intGets or sets the width of the sub-area of the window that is to be displayed.
public function get srcWidth():int public function set srcWidth(value:int):void| srcX | property |
srcX:intGets or sets the x coordinate of the upper left hand corner of the sub-area of the window to be displayed.
public function get srcX():int public function set srcX(value:int):void| srcY | property |
srcY:intGets or sets the y coordinate of the upper left hand corner of the sub-area of the window to be displayed.
public function get srcY():int public function set srcY(value:int):void| state | property |
state:String [read-only] Gets the state of the window. The possible states are defined by the IowWindowState class. The state property applies only to top level application windows owned by the application.
public function get state():String| surfaceHeight | property |
surfaceHeight:int [read-only] Gets or sets the height of the surface that is associated with the window.
public function get surfaceHeight():int| surfaceWidth | property |
surfaceWidth:int [read-only] Gets or sets the width of the surface that is associated with the window.
public function get surfaceWidth():int| swapInterval | property |
swapInterval:intGets or sets the swap interval of the window.
The swap interval determines the maximum update rate of the window. A value of 1 allows an update on every frame (say 60fps), a value of 2 means every second frame (30fps).
public function get swapInterval():int public function set swapInterval(value:int):void| transparency | property |
transparency:StringDetermines how the window is blended with underlying windows.
Constants for the valid values of this property are given by the
IowWindowTransparency class.
public function get transparency():String public function set transparency(value:String):voidSee also
| valid | property |
valid:Boolean [read-only]
Gets a value that indicates whether or not the the window currently exists. true
if the window exists, otherwise false.
public function get valid():Boolean| visible | property |
visible:BooleanGets or sets the visibility of the window.
public function get visible():Boolean public function set visible(value:Boolean):void| width | property |
width:int
Gets or sets the width of the window. If this is different than srcWidth,
then the window is stretched or shrunk.
public function get width():int public function set width(value:int):void| windowClass | property |
windowClass:String [read-only] Gets the window class that is associated with the window.
public function get windowClass():String| x | property |
x:intGets or sets the x coordinate of the upper left corner of the window.
public function get x():int public function set x(value:int):void| y | property |
y:intGets or sets the y coordinate of the upper left corner of the window.
public function get y():int public function set y(value:int):void| zOrder | property |
zOrder:intGets or sets the z-Order property of the window.
public function get zOrder():int public function set zOrder(value:int):void| IowWindow | () | Constructor |
public function IowWindow()
Creates an IowWindow instance.
| close | () | method |
public function close():voidCloses the window.
This function can only close snapshot windows. Non-snapshot windows that belong to the current process must be
closed using the NativeWindow that is associated with them. Windows that belong to external processes
cannot be closed.
| createSnapshot | () | method |
public function createSnapshot(width:int, height:int, id:String = null, asWindow:Boolean = false):BooleanCreates a snapshot of the window given a width and height.
When complete, a SNAPSHOT_CREATED event is fired that contains a bitmap or window with
the snapshot. Only a single snapshot can be created at a time.
Parameters
width:int — The width of snapshot image.
| |
height:int — The height of snapshot image.
| |
id:String (default = null) | |
asWindow:Boolean (default = false) |
Boolean — Returns true if snapshot request is queued, or false if the window does
not exist, or is busy taking another snapshot.
|
| duplicateWindow | () | method |
public function duplicateWindow():IowWindow
Creates a second IowWindow instance that shares the buffers of the original window.
IowWindow |
| getAirWindow | () | method |
public static function getAirWindow(nativeWin:NativeWindow = null):IowWindow
Returns an IowWindow object for one of the AIR player's windows.
By default, this function returns the application's main window.
Parameters
nativeWin:NativeWindow (default = null) |
IowWindow — An IowWindow instance.
|
| getExternalWindow | () | method |
public static function getExternalWindow(pid:int, id:String):IowWindow
Returns an IowWindow object associated with the window of an external application.
The window does not have to exist at the time the method is called. You can attach an event listener to listen for composition manager window creation and destruction events.
Parameters
pid:int — The process ID to match, or -1 to match any process ID.
| |
id:String — The string ID of the window to match or null to match any ID.
|
IowWindow — The window.
|
| keepWindow | () | method |
public function keepWindow(keep:Boolean):voidDetermines whether or not the window will be destroyed when the owning process dies. This is only useful for a window manager.
Parameters
keep:Boolean — If true, the window will be kept if the owner dies. If false the window will not be kept.
|
| sendMouseEvent | () | method |
public function sendMouseEvent(pressed:Boolean, x:int, y:int):voidSends a mouse event to the window.
Parameters
pressed:Boolean — true if the event should indicate that the button is pressed.
| |
x:int — The x coordinate of event relative to upper left corner of window.
| |
y:int — The y coordinate of event relative to upper left corner of window.
|
| setWindowProperty | () | method |
public function setWindowProperty(propertyId:int, value:int):voidSets the general window properties, given a property ID and an integer value.
Parameters
propertyId:int — The window property to set.
| |
value:int — The value of the property.
|
| snapshotCreated | Event |
qnx.events.IowWindowSnapshotEventqnx.events.IowWindowSnapshotEvent.SNAPSHOT_CREATEDDispatched when the snapshot operation completes successfully.
| snapshotFailed | Event |
qnx.events.IowWindowSnapshotEventqnx.events.IowWindowSnapshotEvent.SNAPSHOT_FAILEDDispatched when the snapshot operation fails.
| windowCreated | Event |
qnx.events.IowWindowEventqnx.events.IowWindowEvent.WINDOW_CREATEDDispatched when a window is created.
The event is dispatched to both the IowWindow object that is associated
with the window (based on pid and id properties) as well as to the main
AIR window.
| windowDestroyed | Event |
qnx.events.IowWindowEventqnx.events.IowWindowEvent.WINDOW_DESTROYEDDispatched when a window is destroyed.
The event is dispatched by both the IowWindow object that is associated
with the window (based on pid and id properties) as well as to the main
AIR window.
| windowStateChanged | Event |
qnx.events.IowWindowEventqnx.events.IowWindowEvent.WINDOW_STATE_CHANGEDDispatched when the state of the window changes.
| windowVisibilityChanged | Event |
qnx.events.IowWindowEventqnx.events.IowWindowEvent.WINDOW_VISIBILITY_CHANGEDDispatched when the visibility of the window changes.
This applies to the AIR window only.