パッケージ | flash.desktop |
クラス | public final class NativeApplication |
継承 | NativeApplication EventDispatcher Object |
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
NativeApplication クラスは、アプリケーション情報とアプリケーション全体の関数を提供し、アプリケーションレベルのイベントを送出します。
NativeApplication オブジェクトは、起動時に自動的に作成されるシングルトンオブジェクトです。静的な NativeApplication.nativeApplication
プロパティを持つアプリケーションの NativeApplication インスタンスを取得します。
プロパティ | 定義元 | ||
---|---|---|---|
activeWindow : NativeWindow [読み取り専用]
アクティブなアプリケーションウィンドウです。 | NativeApplication | ||
applicationDescriptor : XML [読み取り専用]
この AIR アプリケーション用のアプリケーション記述ファイルの内容です。 | NativeApplication | ||
applicationID : String [読み取り専用]
このアプリケーションのアプリケーション ID です。 | NativeApplication | ||
autoExit : Boolean
すべてのウィンドウを閉じたときにアプリケーションを自動的に終了するかどうかを指定します。 | NativeApplication | ||
constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | ||
executeInBackground : Boolean
アプリケーションをバックグラウンドで実行するかどうかを指定します。 | NativeApplication | ||
icon : InteractiveIcon [読み取り専用]
アプリケーションアイコンです。 | NativeApplication | ||
idleThreshold : int
ユーザー入力が行われなくなってから userIdle イベントを送出するまでの秒数です。 | NativeApplication | ||
isCompiledAOT : Boolean [読み取り専用]
アプリケーションが目的のプラットフォーム用にコンパイルまたは解釈されているかどうかを示します。 | NativeApplication | ||
menu : NativeMenu
アプリケーションメニューです。 | NativeApplication | ||
nativeApplication : NativeApplication [静的] [読み取り専用]
NativeApplication オブジェクトのシングルトンインスタンスです。 | NativeApplication | ||
openedWindows : Array [読み取り専用]
このアプリケーションの開いているすべてのネイティブウィンドウを含む配列です。 | NativeApplication | ||
publisherID : String [読み取り専用]
このアプリケーションの発行者 ID です。 | NativeApplication | ||
runtimePatchLevel : uint [読み取り専用]
このアプリケーションをホストしているランタイムのパッチレベルです。 | NativeApplication | ||
runtimeVersion : String [読み取り専用]
このアプリケーションをホストしているランタイムのバージョン番号です。 | NativeApplication | ||
startAtLogin : Boolean
現在のユーザーがログインしたときは常にこのアプリケーションを自動的に起動するかどうかを指定します。 | NativeApplication | ||
supportsDefaultApplication : Boolean [静的] [読み取り専用]
setAsDefaultApplication()、removeAsDefaultApplication() および isSetAsDefaultApplication() が現在のプラットフォームでサポートされているかどうかを示します。 | NativeApplication | ||
supportsDockIcon : Boolean [静的] [読み取り専用]
AIR が、現在のオペレーティングシステムでドック形式のアプリケーションアイコンをサポートするかどうかを示します。 | NativeApplication | ||
supportsMenu : Boolean [静的] [読み取り専用]
現在のオペレーティングシステムがグローバルアプリケーションメニューバーをサポートするかどうかを指定します。 | NativeApplication | ||
supportsStartAtLogin : Boolean [静的] [読み取り専用]
現在のプラットフォームで、startAtLogin がサポートされているかどうかを示します。 | NativeApplication | ||
supportsSystemTrayIcon : Boolean [静的] [読み取り専用]
AIR が現在のオペレーティングシステムのシステムトレイアイコンをサポートするかどうかを指定します。 | NativeApplication | ||
systemIdleMode : String
ユーザーインターフェイスが「アイドル」モードに入るのを妨げる手段をアプリケーションに提供します。 | NativeApplication | ||
timeSinceLastUserInput : int [読み取り専用]
最後のユーザー入力が行われてからの時間(秒)を示します。 | NativeApplication |
メソッド | 定義元 | ||
---|---|---|---|
このアプリケーションをアクティブ化します。 | NativeApplication | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void [オーバーライド]
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | NativeApplication | ||
フォーカスがある表示オブジェクトで内部 delete コマンドを起動します。 | NativeApplication | ||
フォーカスがある表示オブジェクトで内部 copy コマンドを起動します。 | NativeApplication | ||
フォーカスがある表示オブジェクトで内部 cut コマンドを起動します。 | NativeApplication | ||
[オーバーライド]
イベントをイベントフローに送出します。 | NativeApplication | ||
このアプリケーションを終了します。 | NativeApplication | ||
指定された拡張子を持つ開始ファイル用のデフォルトのアプリケーションを取得します。 | NativeApplication | ||
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | ||
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | ||
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | ||
現在このアプリケーションが、指定された拡張子を持つ開始ファイル用のデフォルトのアプリケーションかどうかを指定します。 | NativeApplication | ||
フォーカスがある表示オブジェクトで内部 paste コマンドを起動します。 | NativeApplication | ||
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | ||
このアプリケーションを、指定された拡張子を持つ開始ファイルに対するデフォルト指定から解除します。 | NativeApplication | ||
[オーバーライド]
EventDispatcher オブジェクトからリスナーを削除します。 | NativeApplication | ||
フォーカスがある表示オブジェクトで内部 selectAll コマンドを起動します。 | NativeApplication | ||
このアプリケーションを、指定された拡張子を持つ開始ファイル用のデフォルトのアプリケーションとして設定します。 | NativeApplication | ||
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | ||
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | ||
指定されたオブジェクトのストリング表現を返します。 | Object | ||
指定されたオブジェクトのプリミティブな値を返します。 | Object | ||
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher |
イベント | 概要 | 定義元 | ||
---|---|---|---|---|
このアプリケーションがアクティブデスクトップアプリケーションになると送出されます。 | NativeApplication | |||
アプリケーションがユーザーのブラウザーを実行している SWF ファイルによって起動されたときに送出されます。 | NativeApplication | |||
デスクトップのフォーカスが別のアプリケーションに切り替わると送出されます。 | NativeApplication | |||
アプリケーションの終了シーケンスが開始されると送出されます。 | NativeApplication | |||
アプリケーションが起動されたときに送出されます。 | NativeApplication | |||
ユーザーがキーを押したときに送出されます。 | NativeApplication | |||
ユーザーがキーを離したときに送出されます。 | NativeApplication | |||
新しいネットワーク接続が使用可能になるか、既存のネットワーク接続が失われると送出されます。 | NativeApplication | |||
アプリケーションがオペレーティングシステムによって中断される直前に送出されます。 | NativeApplication | |||
ユーザーがアイドル状態になっているときに送出されます。 | NativeApplication | |||
アイドル期間の後にオペレーティングシステムがマウスまたはキーボードの操作を検出すると送出されます。 | NativeApplication |
activeWindow | プロパティ |
activeWindow:NativeWindow
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
アクティブなアプリケーションウィンドウです。
アクティブなデスクトップウィンドウがこのアプリケーションに属していない場合、またはアクティブなウィンドウがない場合、activeWindow
は null
です。
このプロパティは、NativeWindow クラスをサポートしていないプラットフォームでは無効です。
実装
public function get activeWindow():NativeWindow
applicationDescriptor | プロパティ |
applicationDescriptor:XML
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
この AIR アプリケーション用のアプリケーション記述ファイルの内容です。
実装
public function get applicationDescriptor():XML
例 ( この例の使用方法 )
copyright
要素と version
要素を読み取ります。アプリケーション記述子 XML に定義されたデフォルトの名前空間を使用する必要があります。
var appDescriptor:XML = NativeApplication.nativeApplication.applicationDescriptor; var ns:Namespace = appDescriptor.namespace(); var appCopyright:String = appDescriptor.ns::copyright; var appVersion:String = appDescriptor.ns::version; trace("appId:", appCopyright); trace("version:", appVersion);
applicationID | プロパティ |
autoExit | プロパティ |
autoExit:Boolean
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
すべてのウィンドウを閉じたときにアプリケーションを自動的に終了するかどうかを指定します。
autoExit
がデフォルトの true
の場合、すべてのウィンドウを閉じるとアプリケーションが終了します。exiting
イベントと exit
イベントの両方が送出されます。autoExit
が false
の場合、NativeApplication.nativeApplication.exit()
を呼び出してアプリケーションを終了する必要があります。
このプロパティは、NativeWindow クラスをサポートしていないプラットフォームでは無効です。
実装
public function get autoExit():Boolean
public function set autoExit(value:Boolean):void
executeInBackground | プロパティ |
executeInBackground:Boolean
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 3.3 |
アプリケーションをバックグラウンドで実行するかどうかを指定します。
executeInBackground
が false
の場合(デフォルト)、アプリケーションが中断状態のままバックグラウンドに切り替わります。executeInBackground
が true
の場合は、アプリケーションをバックグラウンドで実行できます。
注意:swf バージョン 21 以前では、レンダリングモードがダイレクトに設定されている場合、AIR は iOS と Android でのバックグラウンドでの実行をサポートしません。この制約から、Stage3D ベースのアプリでは、オーディオ再生、位置の更新、ネットワークアップロードまたはダウンロードなどのバックグラウンドタスクを実行できません。iOS ではバックグラウンドで OpenGLES またはレンダリングを呼び出すことはできません。バックグラウンドで OpenGL を呼び出そうとしたアプリケーションは、iOS によって終了されます。Android では、バックグラウンドでの OpenGLES の呼び出し、またはその他のバックグラウンドタスク(オーディオ再生など)の実行について、アプリケーションへの制約はありません。swf バージョン 22 以降では、レンダリングモードがダイレクトに設定されている場合、AIR モバイルアプリケーションはバックグラウンドで実行できます。OpenGLES の呼び出しがバックグラウンドで実行されると、AIR iOS ランタイムでは ActionScript エラー(3768 - バックグラウンドでの実行中、Stage3D API は使用できません)が発生します。ただし、Android ではネイティブアプリケーションがバックグラウンドで OpenGLES を呼び出すことが可能なので、エラーは発生しません。モバイルリソースを最適に利用するため、アプリケーションがバックグラウンドで実行されている間はレンダリングの呼び出しを行わないでください。
このプロパティは AIR iOS と Android でサポートされています。
実装
public function get executeInBackground():Boolean
public function set executeInBackground(value:Boolean):void
icon | プロパティ |
icon:InteractiveIcon
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
アプリケーションアイコンです。
NativeApplication.supportsDockIcon
と NativeApplication.supportsSystemTrayIcon
を使用して、icon クラスを判別します。タイプは、InteractiveIcon のいずれかのサブクラスです。Mac® OS X では、NativeApplication.icon
は DockIcon
タイプのオブジェクトです。Windows® の場合、NativeApplication.icon
はタイプが SystemTrayIcon
のオブジェクトです。アプリケーションアイコンがサポートされていない場合、NativeApplication.supportsDockIcon
および NativeApplication.supportsSystemTrayIcon
は両方とも false
で、icon
プロパティは null
になります。
icon
オブジェクトは自動的に作成されますが、イメージデータで初期化されません。Mac OS X などの一部のオペレーティングシステムでは、デフォルトのイメージが指定されます。一方、Windows などのオペレーティングシステムでは、アイコンにイメージデータが割り当てられない限りアイコンは表示されません。アイコンイメージを割り当てるには、少なくとも 1 つの BitmapData オブジェクトが格納されている配列を icon.bitmaps
プロパティに設定します。配列に複数の BitmapData オブジェクトが格納されている場合、サイズがアイコンの表示サイズに最も近いイメージをオペレーティングシステムが選択し、必要に応じてイメージを伸縮します。
実装
public function get icon():InteractiveIcon
関連する API エレメント
idleThreshold | プロパティ |
idleThreshold:int
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
ユーザー入力が行われなくなってから userIdle イベントを送出するまでの秒数です。
デフォルトでは、アイドル時間のしきい値は 300 秒(5 分)に設定されています。許容される値の範囲は、5(5 秒)以上 86,400(1 日)以下です。
実装
public function get idleThreshold():int
public function set idleThreshold(value:int):void
例外
ArgumentError — プロパティに無効な値を設定しようとした場合に発生します。許容される値の範囲は、5(5 秒)以上 86,400(1 日)以下です。
|
関連する API エレメント
isCompiledAOT | プロパティ |
menu | プロパティ |
menu:NativeMenu
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
アプリケーションメニューです。
アプリケーションメニューは、NativeApplication.supportsMenu
が true
のときにサポートされます。アプリケーションメニューをサポートしないオペレーティングシステムもあります。例えば、Mac OS X ではアプリケーションメニューがサポートされますが、Windows または Linux ではサポートされません。NativeApplication.supportsMenu
が false
の場合も、このプロパティに NativeMenu オブジェクトを割り当てることはできますが、効果はありません。使用しているオペレーティングシステムでアプリケーションメニューがサポートされているか確認するには、必ず NativeApplication.supportsMenu
プロパティを使用してください。その他の方法(Capabilities.os
など)でサポートの有無を判断すると、プログラミングエラーの原因になる可能性があります(ターゲットとなり得るオペレーティングシステムの種類についての配慮が完全でない場合)。
AIR プロファイルのサポート:この機能はモバイルデバイスまたは AIR for TV デバイスではサポートされません。複数のプロファイル間での API サポートについて詳しくは、AIR プロファイルのサポートを参照してください。
注意:Mac OS X の場合、menu
プロパティはオペレーティングシステムで指定されたデフォルトのアプリケーションメニューを参照します。アイテムやサブメニューを追加および削除したり、イベントリスナーを追加することで、既存のメニュー構造を変更できます。新しい NativeMenu オブジェクトをこの menu
プロパティに割り当てることによって、デフォルトのメニュー全体を置き換えることもできます。
実装
public function get menu():NativeMenu
public function set menu(value:NativeMenu):void
関連する API エレメント
nativeApplication | プロパティ |
nativeApplication:NativeApplication
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
NativeApplication オブジェクトのシングルトンインスタンスです。
実装
public static function get nativeApplication():NativeApplication
例外
Error — アプリケーションのセキュリティサンドボックス外部のコンテンツでアクセスした場合。
|
openedWindows | プロパティ |
publisherID | プロパティ |
runtimePatchLevel | プロパティ |
runtimeVersion | プロパティ |
startAtLogin | プロパティ |
startAtLogin:Boolean
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
現在のユーザーがログインしたときは常にこのアプリケーションを自動的に起動するかどうかを指定します。
AIR プロファイルのサポート:この機能はすべてのデスクトップオペレーティングシステムでサポートされますが、モバイルデバイスまたは AIR for TV デバイスではサポートされません。NativeApplication.supportsStartAtLogin
プロパティを使用して、サポートされているかどうかを実行時にテストすることができます。複数のプロファイル間での API サポートについて詳しくは、AIR プロファイルのサポートを参照してください。
startAtLogin
プロパティは、ユーザーがログインするとアプリケーションを自動的に開始することを指定するためにオペレーティングシステムに定義されたメカニズムのステータスを反映します。ユーザーは、オペレーティングシステムのユーザーインターフェイスでこのステータスを変更できます。このプロパティは、AIR アプリケーションまたはオペレーティングシステムによってこのステータスが最近変更されたかどうかについての現在のステータスを反映します。
実装
public function get startAtLogin():Boolean
public function set startAtLogin(value:Boolean):void
例外
IllegalOperationError — Windows では、同じ名前を持つ(ただし、実行可能ファイルへのパスが異なる)別のアプリケーションが、このユーザーがログインすると起動するように既に設定されている場合。
| |
IllegalOperationError — このアプリケーションがインストールされていない場合、AIR Debug Launcher(ADL)によって起動された可能性があります。
|
関連する API エレメント
supportsDefaultApplication | プロパティ |
supportsDefaultApplication:Boolean
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 2 |
setAsDefaultApplication()
、removeAsDefaultApplication()
、isSetAsDefaultApplication()
が現在のプラットフォームでサポートされているかどうかを示します。
true
の場合、これらのメソッドは、説明のとおりに機能します。false
の場合、setAsDefaultApplication()
およびremoveDefaultApplication()
は何もしません。isSetAsDefaultApplication()
は false
を返します。
実装
public static function get supportsDefaultApplication():Boolean
関連する API エレメント
supportsDockIcon | プロパティ |
supportsDockIcon:Boolean
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
AIR が、現在のオペレーティングシステムでドック形式のアプリケーションアイコンをサポートするかどうかを示します。
true
の場合、NativeApplication.icon
プロパティは DockIcon
タイプです。
Mac OS X ユーザーインターフェイスには、実行中または頻繁に使用されるアプリケーションのアイコンが入っているアプリケーション「ドック」が用意されています。
使用しているオペレーティングシステムでアプリケーションのドックアイコンがサポートされているか確認するには、必ず NativeApplication.supportsDockIcon
プロパティを使用してください。その他の方法(Capabilities.os
など)でサポートの有無を判断すると、プログラミングエラーの原因になる可能性があります(ターゲットとなり得るオペレーティングシステムの種類についての配慮が完全でない場合)。
実装
public static function get supportsDockIcon():Boolean
関連する API エレメント
supportsMenu | プロパティ |
supportsMenu:Boolean
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
現在のオペレーティングシステムがグローバルアプリケーションメニューバーをサポートするかどうかを指定します。
true
の場合、NativeApplication.menu
プロパティを使用してネイティブアプリケーションメニューを定義(またはネイティブアプリケーションメニューにアクセス)できます。
使用しているオペレーティングシステムでアプリケーションメニューバーがサポートされているか確認するには、必ず NativeApplication.supportsMenu
プロパティを使用してください。その他の方法(Capabilities.os
など)でサポートの有無を判断すると、プログラミングエラーの原因になる可能性があります(ターゲットとなり得るオペレーティングシステムの種類についての配慮が完全でない場合)。
実装
public static function get supportsMenu():Boolean
関連する API エレメント
supportsStartAtLogin | プロパティ |
supportsSystemTrayIcon | プロパティ |
supportsSystemTrayIcon:Boolean
[読み取り専用] 言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
AIR が現在のオペレーティングシステムのシステムトレイアイコンをサポートするかどうかを指定します。
true
の場合、NativeApplication.icon
プロパティは SystemTrayIcon
タイプです。
Windows ユーザーインターフェイスには、タスクバーの「システムトレイ」領域が用意されています。正式には「通知領域」と呼ばれ、この領域にアプリケーションアイコンが表示されます。表示されるデフォルトのアイコンはありません。アイコンを表示するには、icon オブジェクトの bitmaps
配列を設定する必要があります。
使用しているオペレーティングシステムでシステムトレイアイコンがサポートされているか確認するには、必ず NativeApplication.supportsSystemTrayIcon
プロパティを使用してください。その他の方法(Capabilities.os
など)でサポートの有無を判断すると、プログラミングエラーの原因になる可能性があります(ターゲットとなり得るオペレーティングシステムの種類についての配慮が完全でない場合)。
実装
public static function get supportsSystemTrayIcon():Boolean
関連する API エレメント
systemIdleMode | プロパティ |
systemIdleMode:String
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 2 |
ユーザーインターフェイスが「アイドル」モードに入るのを妨げる手段をアプリケーションに提供します。
SystemIdleMode クラスの値です。ホストシステムのアイドルモード動作に影響します。このプロパティは、入力フォーカスのあるアプリケーションにのみ影響し、アプリケーションサンドボックス内で実行されるコンテンツからのみアクセスできます。
AIR プロファイルのサポート:この機能はモバイルデバイスでサポートされますが、デスクトップオペレーティングシステムまたは AIR for TV デバイスではサポートされません。複数のプロファイル間での API サポートについて詳しくは、AIR プロファイルのサポートを参照してください。
実装
public function get systemIdleMode():String
public function set systemIdleMode(value:String):void
関連する API エレメント
timeSinceLastUserInput | プロパティ |
activate | () | メソッド |
public function activate(window:NativeWindow = null):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
このアプリケーションをアクティブ化します。
このメソッドは、NativeWindow クラスをサポートしていないプラットフォームでは無効です。
オペレーティングシステムによって決められた一部の環境下では、このメソッドでアプリケーションはアクティブになりません。ほとんどのオペレーティングシステムでは、アプリケーション自体でアクティブになる機能を制限することにより、誤った操作や悪意のある操作によってユーザーが他のアプリケーションを使用できなくなることを防止しています。
オペレーティングシステムでアクティブ化が許可されている場合は、指定したウィンドウがアクティブになり、デスクトップのフォアグラウンド、つまり他のアプリケーションのウィンドウよりも手前に表示されます(window
パラメーターが null
の場合、このアプリケーションの表示ウィンドウがアクティブになります)。
アプリケーションに表示ウィンドウがない場合、activate()
メソッドは無効です。
アクティブ化操作は、同期的です。
パラメーター
window:NativeWindow (default = null ) — アプリケーションと共にアクティブ化するウィンドウの NativeWindow オブジェクトです。
|
イベント
activate: — アクティブ状態が変化すると送出されます。
|
addEventListener | () | メソッド |
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
ランタイムバージョン: | AIR 1.0 |
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。イベントリスナーは、特定のタイプのイベント、段階、および優先度に関する表示リスト内のすべてのノードに登録できます。
イベントリスナーが正常に登録された後に、addEventListener()
をさらに呼び出して優先度を変更することはできません。リスナーの優先度を変更するには、最初に removeListener()
を呼び出す必要があります。その後、同じリスナーを新しい優先度レベルで再度登録できます。
リスナーが登録された後に、addEventListener()
(type
または useCapture
に別の値を設定)を再度呼び出すと、別のリスナー登録が作成されることに注意してください。例えば、最初にリスナーを登録するときに useCapture
を true
に設定すると、そのリスナーはキャプチャ段階のみでリスニングします。同じリスナーオブジェクトを使用して再度 addEventListener()
を呼び出すと(このとき、useCapture
に false
を設定)、異なる 2 つのリスナーが登録されます。1 つはキャプチャ段階でリスニングするリスナーで、もう 1 つはターゲット段階とバブリング段階でリスニングするリスナーです。
ターゲット段階またはバブリング段階のみを対象とするイベントリスナーを登録することはできません。登録時にこれらの段階が組み合わされるのは、バブリングはターゲットノードの祖先にしか適用されないためです。
イベントリスナーが不要になった場合は、removeEventListener()
を呼び出して、イベントリスナーを削除します。削除しない場合、メモリの問題が発生する可能性があります。ガベージコレクションでは、オブジェクトの送出が行われている限り、リスナーを削除しないので、イベントリスナーは自動的には削除されません(useWeakReference
パラメーターが true
に設定されていない場合)。
EventDispatcher インスタンスをコピーしても、それに関連付けられているイベントリスナーはコピーされません。新しく作成したノードにイベントリスナーが必要な場合は、ノードを作成した後に、リスナーを関連付ける必要があります。ただし、EventDispatcher インスタンスを移動した場合は、関連付けられているイベントリスナーも一緒に移動されます。
イベントがノードで処理されるときに、イベントリスナーがそのノードに登録中であれば、イベントリスナーは現在の段階ではトリガーされません。ただし、バブリング段階など、イベントフローの後の段階でトリガーすることができます。
イベントがノードで処理されているときにイベントリスナーがノードから削除された場合でも、イベントは現在のアクションによってトリガーされます。削除された後は、その後の処理で再び登録されない限り、イベントリスナーは二度と呼び出されません。
パラメーター
type:String — イベントのタイプです。
| |
listener:Function — イベントを処理するリスナー関数です。この関数は、次の例のように、Event オブジェクトを唯一のパラメーターとして受け取り、何も返さないものである必要があります。
function(evt:Event):void 関数の名前は任意に付けられます。 | |
useCapture:Boolean (default = false ) —
リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。useCapture を true に設定すると、リスナーはキャプチャ段階のみでイベントを処理し、ターゲット段階またはバブリング段階では処理しません。useCapture を false に設定すると、リスナーはターゲット段階またはバブリング段階のみでイベントを処理します。3 つの段階すべてでイベントを受け取るには、addEventListener を 2 回呼び出します。useCapture を true に設定して呼び出し、useCapture を false に設定してもう一度呼び出します。
| |
priority:int (default = 0 ) — イベントリスナーの優先度レベルです。優先度は、符号付き 32 bit 整数で指定します。数値が大きくなるほど優先度が高くなります。優先度が n のすべてのリスナーは、優先度が n-1 のリスナーよりも前に処理されます。複数のリスナーに対して同じ優先度が設定されている場合、それらは追加された順番に処理されます。デフォルトの優先度は 0 です。
| |
useWeakReference:Boolean (default = false ) — リスナーへの参照が強参照と弱参照のいずれであるかを判断します。デフォルトである強参照の場合は、リスナーのガベージコレクションが回避されます。弱参照では回避されません。 クラスレベルメンバー関数はガベージコレクションの対象外であるため、クラスレベルメンバー関数の |
clear | () | メソッド |
public function clear():Boolean
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
フォーカスがある表示オブジェクトで内部 delete コマンドを起動します。
この関数呼び出しは、フォーカスがあるオブジェクトがコマンドを実装しない場合には無視されます。現在このコマンドを実装しているのは、TextField クラスまたは HTMLLoader クラスの下位にある表示コマンドのみです。
注意:clear()
コマンドは、選択したテキストを削除します。何も選択しない場合は、どのテキストもクリアされません。
Boolean — true .
|
copy | () | メソッド |
cut | () | メソッド |
dispatchEvent | () | メソッド |
override public function dispatchEvent(event:Event):Boolean
ランタイムバージョン: | AIR 1.0 |
イベントをイベントフローに送出します。イベントターゲットは EventDispatcher オブジェクトです。これに対して dispatchEvent()
メソッドが呼び出されます。
パラメーター
event:Event — イベントフローに送出されるイベントオブジェクトです。イベントが再度送出されると、イベントのクローンが自動的に作成されます。イベントが送出された後にそのイベントの target プロパティは変更できないため、再送出処理のためにはイベントの新しいコピーを作成する必要があります。
|
Boolean — 値が true の場合、イベントは正常に送出されました。値が false の場合、イベントの送出に失敗したか、イベントで preventDefault() が呼び出されたことを示しています。
|
exit | () | メソッド |
public function exit(errorCode:int = 0):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
このアプリケーションを終了します。
exit()
メソッドの呼び出しによって返されます。現在実行中のコード(現在のイベントハンドラーなど)が完了するまで、シャットダウンシーケンスは開始されません。 保留中の非同期操作はキャンセルされ、操作が完了しない場合もあります。
exiting
イベントは送出されません。アプリケーションのロジック上 exiting
イベントが必要な場合は、NativeApplication.nativeApplication.dispatchEvent()
を呼び出し、タイプが exiting
の Event オブジェクトを渡します。開いているウィンドウに対して、NativeWindow オブジェクトは closing
イベントと close
イベントを送出します。closing
イベントオブジェクトの preventDefault()
メソッドを呼び出すと、アプリケーションが終了できなくなります。
注意:このメソッドは iOS オペレーティングシステムでサポートされていません。
パラメーター
errorCode:int (default = 0 ) — このアプリケーションが終了するときにオペレーティングシステムに報告される終了コードです。
|
getDefaultApplication | () | メソッド |
public function getDefaultApplication(extension:String):String
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
指定された拡張子を持つ開始ファイル用のデフォルトのアプリケーションを取得します。
注意:このメソッドは、アプリケーション記述子の fileTypes
ステートメントに宣言されたファイルタイプでのみ使用できます。
このメソッドは AIR for TV デバイスでは使用できません。アプリケーション記述子で宣言したファイルタイプを指定して呼び出すと、null
が返されます。
パラメーター
extension:String — 「.」を除く、対象のファイルタイプの拡張子を含む String です。
|
String — デフォルトアプリケーションのパスです。
|
例外
Error — extension パラメーターがアプリケーション記述子に宣言されたファイル拡張子を含まない場合。
|
関連する API エレメント
isSetAsDefaultApplication | () | メソッド |
public function isSetAsDefaultApplication(extension:String):Boolean
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
現在このアプリケーションが、指定された拡張子を持つ開始ファイル用のデフォルトのアプリケーションかどうかを指定します。
AIR プロファイルのサポート:この機能はすべてのデスクトップオペレーティングシステムでサポートされますが、モバイルデバイスまたは AIR for TV デバイスではサポートされません。NativeApplication.supportsDefaultApplication
プロパティを使用して、サポートされているかどうかを実行時にテストすることができます。複数のプロファイル間での API サポートについて詳しくは、AIR プロファイルのサポートを参照してください。
パラメーター
extension:String — 「.」を除く、対象のファイルタイプの拡張子を含む String です。
|
Boolean — このアプリケーションがデフォルトである場合は true です。
|
例外
Error — extension パラメーターがアプリケーション記述子に宣言されたファイル拡張子を含まない場合。
|
関連する API エレメント
paste | () | メソッド |
removeAsDefaultApplication | () | メソッド |
public function removeAsDefaultApplication(extension:String):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
このアプリケーションを、指定された拡張子を持つ開始ファイルに対するデフォルト指定から解除します。
注意:このメソッドは、アプリケーション記述子の fileTypes
ステートメントに示されたファイルタイプでのみ使用できます。
パラメーター
extension:String — 「.」を除く、対象のファイルタイプの拡張子を含む String です。
|
例外
Error — extension パラメーターがアプリケーション記述子に宣言されたファイル拡張子を含まない場合。
|
関連する API エレメント
removeEventListener | () | メソッド |
override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
ランタイムバージョン: | AIR 1.0 |
EventDispatcher オブジェクトからリスナーを削除します。対応するリスナーが EventDispatcher オブジェクトに登録されていない場合は、このメソッドを呼び出しても効果はありません。
パラメーター
type:String — イベントのタイプです。
| |
listener:Function — 削除するリスナーオブジェクトです。
| |
useCapture:Boolean (default = false ) —
リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階に対して登録されたかどうかを示します。リスナーがキャプチャ段階だけでなくターゲット段階とバブリング段階にも登録されている場合は、removeEventListener() を 2 回呼び出して両方のリスナーを削除する必要があります。1 回は useCapture() を true に設定し、もう 1 回は useCapture() を false に設定する必要があります。
|
selectAll | () | メソッド |
setAsDefaultApplication | () | メソッド |
public function setAsDefaultApplication(extension:String):void
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
このアプリケーションを、指定された拡張子を持つ開始ファイル用のデフォルトのアプリケーションとして設定します。
注意:このメソッドは、アプリケーション記述子の fileTypes
ステートメントに宣言されたファイルタイプでのみ使用できます。
パラメーター
extension:String — 「.」を除く、対象のファイルタイプの拡張子を含む String です。
|
例外
Error — extension パラメーターがアプリケーション記述子に宣言されたファイル拡張子を含まない場合。
|
関連する API エレメント
activate | イベント |
flash.events.Event
プロパティ Event.type =
flash.events.Event.ACTIVATE
ランタイムバージョン: | AIR 1.0 |
このアプリケーションがアクティブデスクトップアプリケーションになると送出されます。
ACTIVATE
定数は、type
プロパティ(activate
イベントオブジェクト)の値を定義します。
注意:このイベントには「キャプチャ段階」と「バブリング段階」はありません。したがって、ターゲットが表示リストにあるかないかに関わらず、潜在的なターゲットにはイベントリスナーを直接追加する必要があります。
AIR for TV デバイスでは、このイベントが自動的に送出されることはありません。手動での送出は可能です。
このイベントには、次のプロパティがあります。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | false は、キャンセルするデフォルトの動作がないことを示します。 |
currentTarget | イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
target | activate イベントに対するリスナーが登録された任意の DisplayObject インスタンスです。 |
browserInvoke | イベント |
flash.events.BrowserInvokeEvent
プロパティ BrowserInvokeEvent.type =
flash.events.BrowserInvokeEvent.Browser_INVOKE
ランタイムバージョン: | AIR 1.0 |
アプリケーションがユーザーのブラウザーを実行している SWF ファイルによって起動されたときに送出されます。
ブラウザー呼び出しが許可されるのは、アプリケーション記述ファイルで次のように指定されている場合のみです。
<allowBrowserInvocation>true</allowBrowserInvocation>
deactivate | イベント |
flash.events.Event
プロパティ Event.type =
flash.events.Event.DEACTIVATE
ランタイムバージョン: | AIR 1.0 |
デスクトップのフォーカスが別のアプリケーションに切り替わると送出されます。
Event.DEACTIVATE
定数は、type
プロパティ(deactivate
イベントオブジェクト)の値を定義します。
注意:このイベントには「キャプチャ段階」と「バブリング段階」はありません。したがって、ターゲットが表示リストにあるかないかに関わらず、潜在的なターゲットにはイベントリスナーを直接追加する必要があります。
AIR for TV デバイスでは、このイベントが自動的に送出されることはありません。手動での送出は可能です。
このイベントには、次のプロパティがあります。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | false は、キャンセルするデフォルトの動作がないことを示します。 |
currentTarget | イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
target | deactivate イベントに対するリスナーが登録された任意の DisplayObject インスタンスです。 |
exiting | イベント |
flash.events.Event
プロパティ Event.type =
flash.events.Event.EXITING
ランタイムバージョン: | AIR 1.0 |
アプリケーションの終了シーケンスが開始されると送出されます。
オペレーティングシステムによってアプリケーションの終了が開始されると、exiting
イベントが送出されます。例えば、Command+Q
キーが押された場合や(Mac OS X)、NativeApplication オブジェクトの autoExit
プロパティが true
に設定されているとき最後のアプリケーションウィンドウが閉じられた場合などがこれに該当します。このイベントをキャンセルすると、アプリケーションは終了しません。
AIR for TV デバイスでは、exiting
イベントが送出されることはありません。
注意:NativeApplication の exit()
メソッドを呼び出しても、exiting
イベントは送出されません。間もなく終了することをコンポーネントに警告するには、exit()
を呼び出す前に exiting
イベントを送出します。
Event.EXITING
定数は、type
プロパティ(exiting
イベントオブジェクト)の値を定義します。
このイベントには、次のプロパティがあります。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | true 。このイベントオブジェクトをキャンセルすると、終了操作がキャンセルされます。 |
currentTarget | NativeApplication オブジェクトです。 |
target | NativeApplication オブジェクトです。 |
invoke | イベント |
flash.events.InvokeEvent
プロパティ InvokeEvent.type =
flash.events.InvokeEvent.INVOKE
ランタイムバージョン: | AIR 1.0 |
アプリケーションが起動されたときに送出されます。
1 つのアプリケーションを 2 回起動しても、そのアプリケーションの別のインスタンスは起動しません。代わりに、最初のインスタンスが追加の invoke イベントを受け取ります。アプリケーションで後続の invoke
イベントを適切に処理する必要があります。
注意:invoke
イベントはすべてキューに置かれます。このイベントのリスナーは、登録されると、新しいイベントおよびキュー内のすべてのイベントを受け取ります。キューに置かれたイベントは、新しい invoke
イベントの前または後に配信されます。
InvokeEvent.INVOKE
定数は、InvokeEvent オブジェクトの type
プロパティの値を定義します。
InvokeEvent オブジェクトには、次のプロパティがあります。
プロパティ | 値 |
---|---|
arguments | この呼び出し中に渡されるストリング引数の配列です。 |
currentDirectory | arguments 配列内の相対パスの解決に使用されるディレクトリを表す File オブジェクトです。 |
reason | invoke イベントが送出された原因を示すコード。アプリケーションがログイン時に自動的に開始した(InvokeEventReason.LOGIN )、リモート通知へのレスポンスとして開始した(InvokeEventReason.NOTIFICATION - iOS のみ)、アプリケーションが別のアプリケーションによって起動された(InvokeEventReason.OPEN_URL )またはその他の理由(InvokeEventReason.STANDARD )のいずれかです。AIR バージョン 1.5.1 から使用できます。 |
bubbles | false |
cancelable | false は、キャンセルするデフォルトの動作がないことを示します。 |
currentTarget | イベントリスナーで InvokeEvent オブジェクトをアクティブに処理しているオブジェクトを示します。 |
target | 常に NativeApplication object オブジェクトです。 |
keyDown | イベント |
flash.events.KeyboardEvent
プロパティ KeyboardEvent.type =
flash.events.KeyboardEvent.KEY_DOWN
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
ユーザーがキーを押したときに送出されます。NativeApplication インスタンスは、キーボードアクセラレーターをサポートするためにこのイベントを提供します。このキーボードイベントは最初に NativeApplication に送出されます。このイベントをキャンセルすると、NativeWindow メニューアクセラレーターもキャンセルされます。このイベントは、keyUp
イベントの前に発生します。
KeyboardEvent.KEY_DOWN
定数は、keyDown
イベントオブジェクトの type
プロパティの値を定義します。
このイベントには、次のプロパティがあります。
プロパティ | 値 |
---|---|
bubbles | true |
cancelable | AIR の場合は true 、Flash Player の場合は false です。このイベントをキャンセルすると、テキストフィールドに文字が入力されなくなります。 |
charCode | 押したキーまたは離したキーの文字コード値です。 |
commandKey | Mac では Command キーがアクティブになっている場合は true です。それ以外の場合は、false を返します。 |
controlKey | Windows および Linux では Ctrl キーがアクティブになっている場合は、true です。Mac では Control キーがアクティブになっている場合は true です。それ以外の場合は、false を返します。 |
ctrlKey | Windows および Linux では Ctrl キーがアクティブになっている場合は、true です。Macintosh では Ctrl キーまたは Command キーがアクティブになっている場合は、true です。それ以外の場合は false です。 |
currentTarget | イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
keyCode | 押したキーまたは離したキーのキーコード値です。 |
keyLocation | キーボードのキーの場所です。 |
shiftKey | Shift キーがアクティブになっている場合は true 、非アクティブになっている場合は false です。 |
target | フォーカスを持っている InteractiveObject インスタンスです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。 |
関連する API エレメント
keyUp | イベント |
flash.events.KeyboardEvent
プロパティ KeyboardEvent.type =
flash.events.KeyboardEvent.KEY_UP
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 1.0 |
ユーザーがキーを離したときに送出されます。NativeApplication インスタンスは、キーボードアクセラレーターをサポートするためにこのイベントを提供します。このキーボードイベントは最初に NativeApplication に送出されます。このイベントをキャンセルしても、他のオブジェクト(NativeWindow メニューアクセラレーターなど)には何の影響もありません。このイベントは、keyDown
イベントの後に発生します。
KeyboardEvent.KEY_UP
定数は、keyUp
イベントオブジェクトの type
プロパティの値を定義します。
このイベントには、次のプロパティがあります。
プロパティ | 値 |
---|---|
bubbles | true |
cancelable | false は、キャンセルするデフォルトの動作がないことを示します。 |
charCode | 押したキーまたは離したキーの文字コード値を含みます。 |
commandKey | Mac では Command キーがアクティブになっている場合は true です。それ以外の場合は、false を返します。 |
controlKey | Windows および Linux では Ctrl キーがアクティブになっている場合は、true です。Mac では Control キーがアクティブになっている場合は true です。それ以外の場合は、false を返します。 |
ctrlKey | Windows では Ctrl キーがアクティブになっている場合は、true です。Macintosh では Ctrl キーまたは Command キーがアクティブになっている場合は、true です。それ以外の場合は false です。 |
currentTarget | イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
keyCode | 押したキーまたは離したキーのキーコード値です。 |
keyLocation | キーボードのキーの場所です。 |
shiftKey | Shift キーがアクティブになっている場合は true 、非アクティブになっている場合は false です。 |
target | フォーカスを持っている InteractiveObject インスタンスです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。 |
関連する API エレメント
networkChange | イベント |
flash.events.Event
プロパティ Event.type =
flash.events.Event.NETWORK_CHANGE
ランタイムバージョン: | AIR 1.0 |
新しいネットワーク接続が使用可能になるか、既存のネットワーク接続が失われると送出されます。
networkChange
イベントは、ホストコンピューターがオンラインまたはオフラインになったことを示しているとは限りません。接続がある種類から別の種類に移行したことを示している場合もあります。 アプリケーションはこのイベントを使用して、リモートリソースの可用性を監視するタスクを最適化できます。networkChange
イベントが送出されたときに、リモートリソースの可用性を確認することをお勧めします。
注意:
- ネットワークに変更が発生してからこのイベントが送出されるまでに少し時間がかかることがあります。
- Android では、ネットワーク接続に変化があるたびに、NativeApplication オブジェクトから複数の networkChange イベントが送出されます。
Event.NETWORK_CHANGE
定数は、type
プロパティ(networkChange
イベントオブジェクト)の値を定義します。
このイベントには、次のプロパティがあります。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | false は、キャンセルするデフォルトの動作がないことを示します。 |
currentTarget | イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。 |
target | NativeApplication オブジェクトです。 |
suspend | イベント |
flash.events.Event
プロパティ Event.type =
flash.events.Event.SUSPEND
言語バージョン: | ActionScript 3.0 |
ランタイムバージョン: | AIR 3.3 |
アプリケーションがオペレーティングシステムによって中断される直前に送出されます。
Event.SUSPEND
定数は、suspend
イベントオブジェクトの type
プロパティの値を定義します。このイベントは AIR iOS でのみ送出されます。
このイベントには、次のプロパティがあります。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | false は、キャンセルするデフォルトの動作がないことを示します。 |
currentTarget | NativeApplication オブジェクトです。 |
target | NativeApplication オブジェクトです。 |
userIdle | イベント |
flash.events.Event
プロパティ Event.type =
flash.events.Event.USER_IDLE
ランタイムバージョン: | AIR 1.0 |
ユーザーがアイドル状態になっているときに送出されます。
idleThreshold
プロパティを使用してこのイベントが送出される前に、ユーザーをアイドル状態にする必要がある期間を指定します。ユーザーがアイドル状態になってからの経過時間は、timeSinceLastUserInput
プロパティで判断できます。
注意:このイベントはモバイルデバイスまたは AIR for TV デバイスでは送出されません。
Event.USER_IDLE
定数は、type
プロパティ(userIdle
イベントオブジェクト)の値を定義します。
このイベントには、次のプロパティがあります。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | false は、キャンセルするデフォルトの動作がないことを示します。 |
target | NativeApplication オブジェクトです。 |
関連する API エレメント
userPresent | イベント |
flash.events.Event
プロパティ Event.type =
flash.events.Event.USER_PRESENT
ランタイムバージョン: | AIR 1.0 |
アイドル期間の後にオペレーティングシステムがマウスまたはキーボードの操作を検出すると送出されます。
注意:このイベントはモバイルデバイスまたは AIR for TV デバイスでは送出されません。
idleThreshold
プロパティを使用すると、アイドル状態にあると見なす時間の長さを設定できます。ユーザーがアイドル状態になってからの経過時間は、timeSinceLastUserInput
プロパティで判断できます。
Event.USER_PRESENT
定数は、type
プロパティ(userPresent
イベントオブジェクト)の値を定義します。
このイベントには、次のプロパティがあります。
プロパティ | 値 |
---|---|
bubbles | false |
cancelable | false は、キャンセルするデフォルトの動作がないことを示します。 |
target | NativeApplication オブジェクトです。 |
関連する API エレメント
Tue Jun 12 2018, 10:34 AM Z