| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| |
| --> |
| <apiPackage id="mx.modules"><apiName>mx.modules</apiName><apiDetail/><apiClassifier id="mx.modules:ModuleLoader"><apiName>ModuleLoader</apiName><shortdesc> |
| ModuleLoader はロードされたコンテンツとの約束ごとに従うことを除けば、SWFLoader と同じように動作するコンポーネントです。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion><Alternative owner="mx.modules:ModuleLoader" replacement="spark.modules.ModuleLoader" since="4.5"> |
| </Alternative></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseInterface>mx.core:IDeferredInstantiationUIComponent</apiBaseInterface><apiBaseClassifier>mx.containers:VBox</apiBaseClassifier></apiClassifierDef><apiDesc> |
| ModuleLoader はロードされたコンテンツとの約束ごとに従うことを除けば、SWFLoader と同じように動作するコンポーネントです。 この約束ごとによって子 SWF ファイルに IFlexModuleFactory が実装され、実装されたファクトリを使用して子クラスの複数のインスタンスを必要なだけ作成することができます。 |
| <p>ModuleLoader は遅延インスタンス化に接続されており、ModuleManager シングルトンを使用してネットワーク上で転送されるモジュール SWF ファイルのコピーは 1 つだけとなっています。</p> |
| |
| </apiDesc></apiClassifierDetail><related-links><link href="" invalidHref="mx.modules.ModuleManager.xml"><linktext>mx.modules.ModuleManager</linktext></link><link href="" invalidHref="mx.controls.SWFLoader.xml"><linktext>mx.controls.SWFLoader</linktext></link></related-links><adobeApiEvent id="mx.modules:ModuleLoader_mx.events.ModuleEvent.UNLOAD_unload"><apiName>unload</apiName><shortdesc> |
| モジュールデータがアンロードされると送出されます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><adobeApiEventDetail><adobeApiEventDef><apiEventType>mx.events.ModuleEvent.UNLOAD</apiEventType><adobeApiEventClassifier>mx.events.ModuleEvent</adobeApiEventClassifier><apiGeneratedEvent/></adobeApiEventDef><apiDesc> |
| モジュールデータがアンロードされると送出されます。 |
| </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="mx.modules:ModuleLoader_mx.events.ModuleEvent.PROGRESS_progress"><apiName>progress</apiName><shortdesc> |
| モジュールのロード時に一定の間隔で送出されます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><adobeApiEventDetail><adobeApiEventDef><apiEventType>mx.events.ModuleEvent.PROGRESS</apiEventType><adobeApiEventClassifier>mx.events.ModuleEvent</adobeApiEventClassifier><apiGeneratedEvent/></adobeApiEventDef><apiDesc> |
| モジュールのロード時に一定の間隔で送出されます。 |
| </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="mx.modules:ModuleLoader_mx.events.ModuleEvent.ERROR_error"><apiName>error</apiName><shortdesc> |
| モジュールがエラーをスローした場合に送出されます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><adobeApiEventDetail><adobeApiEventDef><apiEventType>mx.events.ModuleEvent.ERROR</apiEventType><adobeApiEventClassifier>mx.events.ModuleEvent</adobeApiEventClassifier><apiGeneratedEvent/></adobeApiEventDef><apiDesc> |
| モジュールがエラーをスローした場合に送出されます。 |
| </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="mx.modules:ModuleLoader_mx.events.ModuleEvent.READY_ready"><apiName>ready</apiName><shortdesc> |
| モジュールのロードが完了すると送出されます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><adobeApiEventDetail><adobeApiEventDef><apiEventType>mx.events.ModuleEvent.READY</apiEventType><adobeApiEventClassifier>mx.events.ModuleEvent</adobeApiEventClassifier><apiGeneratedEvent/></adobeApiEventDef><apiDesc> |
| モジュールのロードが完了すると送出されます。 |
| </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="mx.modules:ModuleLoader_mx.events.ModuleEvent.SETUP_setup"><apiName>setup</apiName><shortdesc> |
| info() メソッドによってモジュールに関する情報を取得できるが、モジュールの準備はできていないときに送出されます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><adobeApiEventDetail><adobeApiEventDef><apiEventType>mx.events.ModuleEvent.SETUP</apiEventType><adobeApiEventClassifier>mx.events.ModuleEvent</adobeApiEventClassifier><apiGeneratedEvent/></adobeApiEventDef><apiDesc> |
| <codeph>info()</codeph> メソッドによってモジュールに関する情報を取得できるが、モジュールの準備はできていないときに送出されます。 |
| </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="mx.modules:ModuleLoader_mx.events.FlexEvent.URL_CHANGED_urlChanged"><apiName>urlChanged</apiName><shortdesc> |
| ModuleLoader に新しい URL が指定されると送出されます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><adobeApiEventDetail><adobeApiEventDef><apiEventType>mx.events.FlexEvent.URL_CHANGED</apiEventType><adobeApiEventClassifier>flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent/></adobeApiEventDef><apiDesc> |
| ModuleLoader に新しい URL が指定されると送出されます。 |
| </apiDesc></adobeApiEventDetail></adobeApiEvent><adobeApiEvent id="mx.modules:ModuleLoader_mx.events.FlexEvent.LOADING_loading"><apiName>loading</apiName><shortdesc> |
| ModuleLoader が URL のロードを開始したときに送出されます。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><adobeApiEventDetail><adobeApiEventDef><apiEventType>mx.events.FlexEvent.LOADING</apiEventType><adobeApiEventClassifier>flash.events.Event</adobeApiEventClassifier><apiGeneratedEvent/></adobeApiEventDef><apiDesc> |
| ModuleLoader が URL のロードを開始したときに送出されます。 |
| </apiDesc></adobeApiEventDetail></adobeApiEvent><apiConstructor id="mx.modules:ModuleLoader:ModuleLoader"><apiName>ModuleLoader</apiName><shortdesc> |
| コンストラクターです。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/></apiConstructorDef><apiDesc> |
| コンストラクターです。 |
| |
| </apiDesc></apiConstructorDetail></apiConstructor><apiOperation id="mx.modules:ModuleLoader:loadModule"><apiName>loadModule</apiName><shortdesc> |
| モジュールをロードします。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="void"/></apiReturn><apiParam><apiItemName>url</apiItemName><apiType value="String"/><apiData>null</apiData><apiDesc>URL で表されるモジュールの場所です。 このパラメーターは省略可能です。 このパラメーターが null の場合は、<codeph>url</codeph> プロパティの値が使用されます。url パラメーターが指定されている場合は、<codeph>url</codeph> プロパティが url の値に更新されます。 |
| |
| </apiDesc></apiParam><apiParam><apiItemName>bytes</apiItemName><apiType value="flash.utils:ByteArray"/><apiData>null</apiData><apiDesc>ByteArray オブジェクトです。ByteArray には、コンパイルされた Module の SWF ファイルのバイトが含まれていることが予期されます。ByteArray オブジェクトは URLLoader クラスを使用して取得できます。このパラメーターが指定されている場合は、モジュールが ByteArray からロードされ、url パラメーターが <codeph>ModuleManager.getModule()</codeph> メソッドでモジュールを識別するために使用されます。url パラメーターは null でない必要があります。このパラメーターが null の場合は、url パラメーター（null でない場合）またはフォールバックとして url プロパティの url からモジュールがロードされます。 |
| |
| </apiDesc></apiParam></apiOperationDef><apiDesc> |
| モジュールをロードします。 モジュールのロードが完了すると、ModuleLoader は <codeph>addChild()</codeph> メソッドによってそのモジュールを子として追加します。 このメソッドは通常、遅延インスタンス化とともにトリガーされます。 |
| |
| <p>モジュールが既にロードされている場合は、このメソッドを呼び出しても何も実行されません。 2 度目のモジュールのロードはされません。</p> |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiOperation id="mx.modules:ModuleLoader:unloadModule"><apiName>unloadModule</apiName><shortdesc> |
| モジュールをアンロードし、そのモジュールを null に設定します。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiOperationDetail><apiOperationDef><apiAccess value="public"/><apiReturn><apiType value="void"/></apiReturn></apiOperationDef><apiDesc> |
| モジュールをアンロードし、そのモジュールを <codeph>null</codeph> に設定します。 モジュールのインスタンスが以前に子として追加されていた場合、このメソッドはその子に対して <codeph>removeChild()</codeph> メソッドを呼び出します。 |
| <p>モジュールが存在しないか、既にアンロードされている場合は、このメソッドを呼び出しても何も実行されません。</p> |
| |
| </apiDesc></apiOperationDetail></apiOperation><apiValue id="mx.modules:ModuleLoader:applicationDomain"><apiName>applicationDomain</apiName><shortdesc> |
| モジュールがロードされるアプリケーションドメインです。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiType value="flash.system:ApplicationDomain"/></apiValueDef><apiDesc> |
| モジュールがロードされるアプリケーションドメインです。 アプリケーションドメインは、同じセキュリティドメイン内にあるクラスを分割するために使用されます。これにより、同じクラスの定義が複数存在すること、および子が親の定義を再利用することが可能になります。 |
| |
| </apiDesc></apiValueDetail><related-links><link href="" invalidHref="flash.system.ApplicationDomain.xml"><linktext>flash.system.ApplicationDomain</linktext></link><link href="" invalidHref="flash.system.SecurityDomain.xml"><linktext>flash.system.SecurityDomain</linktext></link></related-links></apiValue><apiValue id="mx.modules:ModuleLoader:child"><apiName>child</apiName><shortdesc> |
| モジュールファクトリから作成される DisplayObject です。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiType value="flash.display:DisplayObject"/></apiValueDef><apiDesc> |
| モジュールファクトリから作成される DisplayObject です。 |
| |
| </apiDesc></apiValueDetail></apiValue><apiValue id="mx.modules:ModuleLoader:url:get"><apiName>url</apiName><shortdesc> |
| URL で表されるモジュールの場所です。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiValueDetail><apiValueDef><apiProperty/><apiAccess value="public"/><apiDynamic/><apiValueAccess value="readwrite"/><apiType value="String"/></apiValueDef><apiDesc> |
| URL で表されるモジュールの場所です。 |
| |
| </apiDesc></apiValueDetail></apiValue></apiClassifier><apiClassifier id="mx.modules:Module"><apiName>Module</apiName><shortdesc> |
| 動的ロードが可能な MXML ベースのモジュールの基本クラスです。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion><Alternative owner="mx.modules:Module" replacement="spark.modules.Module" since="4.5"> |
| </Alternative></asMetadata></prolog><apiClassifierDetail><apiClassifierDef><apiAccess value="public"/><apiStatic/><apiBaseInterface>mx.modules:IModule</apiBaseInterface><apiBaseClassifier>mx.core:LayoutContainer</apiBaseClassifier></apiClassifierDef><apiDesc> |
| 動的ロードが可能な MXML ベースのモジュールの基本クラスです。 このクラスを MXML で拡張するには、MXML ファイルで <codeph><mx:Module></codeph> タグを使用します。次に例を示します。 |
| |
| <pre> |
| <?xml version="1.0"?> |
| <!-- This module loads an image. --> |
| <mx:Module width="100%" height="100%" xmlns:mx="http://www.adobe.com/2006/mxml"> |
| |
| <mx:Image source="trinity.gif"/> |
| |
| </mx:Module> |
| </pre> |
| |
| <p>Module クラスを ActionScript で拡張することは、MXML ファイルで <codeph><mx:Module></codeph> タグを使用することと同じです。 モジュールとフレームワークとの間でやり取りが行われる場合、このクラスを拡張します。 Module クラスを拡張する ActionScript クラスの例を参照するには、<codeph><mx:Module></codeph> のルートタグを含む MXML ファイルを作成します。 このファイルをコンパイルするときは、<codeph>keep-generated-actionscript</codeph> コンパイラーのオプションの値を <codeph>true</codeph> に設定します。 Flex コンパイラーは、生成された ActionScript クラスを generated という名前のディレクトリに格納します。このディレクトリは表示されます。</p> |
| |
| <p>モジュールにフレームワークコードが含まれていない場合は、ModuleBase クラスを拡張するクラスを作成できます。 ModuleBase クラスを使用する場合は、通常、Module クラスに基づくモジュールを作成した場合よりもモジュールは小さくなります。これは、フレームワーククラスに対する依存関係を持たないためです。</p> |
| |
| </apiDesc></apiClassifierDetail><related-links><link href="" invalidHref="mx.modules.ModuleBase.xml"><linktext>mx.modules.ModuleBase</linktext></link></related-links><apiConstructor id="mx.modules:Module:Module"><apiName>Module</apiName><shortdesc> |
| コンストラクターです。</shortdesc><prolog><asMetadata><apiVersion><apiLanguage version="3.0"/><apiPlatform description="" name="Flash" version="9"/><apiPlatform description="" name="AIR" version="1.1"/><apiTool description="" name="Flex" version="3"/></apiVersion></asMetadata></prolog><apiConstructorDetail><apiConstructorDef><apiAccess value="public"/></apiConstructorDef><apiDesc> |
| コンストラクターです。 |
| |
| </apiDesc></apiConstructorDetail></apiConstructor></apiClassifier></apiPackage> |
