Cairngorm Code

/**
 *  Copyright (c) 2007 - 2009 Adobe
 *  All rights reserved.
 *
 *  Permission is hereby granted, free of charge, to any person obtaining
 *  a copy of this software and associated documentation files (the "Software"),
 *  to deal in the Software without restriction, including without limitation
 *  the rights to use, copy, modify, merge, publish, distribute, sublicense,
 *  and/or sell copies of the Software, and to permit persons to whom the
 *  Software is furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included
 *  in all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 *  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 *  IN THE SOFTWARE.
 */
package samples
{
    import com.adobe.cairngorm.task.Task;

    import flash.system.ApplicationDomain;

    import mx.events.ModuleEvent;
    import mx.modules.IModuleInfo;
    import mx.modules.ModuleManager;

    /**
     * A task-item for loading a module into an application domain.
     */
    public class LoadModule extends Task
    {
        //------------------------------------------------------------------------
        //
        //  Private variables
        //
        //------------------------------------------------------------------------

        private var info:IModuleInfo;

        //------------------------------------------------------------------------
        //
        //  Public properties
        //
        //------------------------------------------------------------------------

        //-------------------------------
        //  Simple bindables
        //-------------------------------

        [Bindable]
        public var url:String;

        [Bindable]
        public var applicationDomain:ApplicationDomain = ApplicationDomain.currentDomain;

        //------------------------------------------------------------------------
        //
        //  Implementation : TaskItem
        //
        //------------------------------------------------------------------------

        override protected function performTask():void
        {
            if (url == null)
                fault("A url must be specified");

            info = ModuleManager.getModule(url);
            info.addEventListener(ModuleEvent.READY, onModuleReady);
            info.addEventListener(ModuleEvent.ERROR, onModuleError);
            info.load(applicationDomain);
        }

        //------------------------------------------------------------------------
        //
        //  Protected Methods
        //
        //------------------------------------------------------------------------

        /**
         * This event handler can be overridden to perform additional logic when
         * the module is ready. Ensure that <code>super.onModuleReady()</code> is
         * called from the overriding method.
         */
        protected function onModuleReady(event:ModuleEvent):void
        {
            cleanUp();
            complete();
        }

        //------------------------------------------------------------------------
        //
        //  Private Methods
        //
        //------------------------------------------------------------------------

        private function onModuleError(event:ModuleEvent):void
        {
            cleanUp();
            fault(event.errorText);
        }

        private function cleanUp():void
        {
            info.removeEventListener(ModuleEvent.READY, onModuleReady);
            info.removeEventListener(ModuleEvent.ERROR, onModuleError);
            info = null;
        }
    }
}