topical media & game development

topical media & game development

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

student-ar-fl-containers-UILoader.ax

student-ar-fl-containers-UILoader.ax [swf] flex


  // Copyright 2007. Adobe Systems Incorporated. All Rights Reserved.
  package fl.containers {
          
          import fl.core.InvalidationType;
          import fl.core.UIComponent;
          import fl.events.ComponentEvent;
          import flash.display.DisplayObject;
          import flash.display.Graphics;
          import flash.display.Loader;
          import flash.display.LoaderInfo;
          import flash.display.Shape;
          import flash.display.Sprite;
          import flash.events.Event;
          import flash.events.ProgressEvent;
          import flash.events.SecurityErrorEvent;
          import flash.events.IOErrorEvent;
          import flash.events.HTTPStatusEvent;
          import flash.net.URLRequest;
          import flash.system.ApplicationDomain;
          import flash.system.LoaderContext;
          import flash.utils.ByteArray;        
  
      //--------------------------------------
      //  Events
      //--------------------------------------

Dispatched when content loading is complete. This event is dispatched regardless of whether the load operation was triggered by an auto-load process or an explicit call to the <code>load()</code> method. @eventType flash.events.Event.COMPLETE @includeExample examples/@ax-student-ar-fl-containers-UILoader.complete.1.as -noswf
see: #event:progress @langversion 3.0 @playerversion Flash 9.0.28.0


  
          [Event("complete", type="flash.events.Event")]

Dispatched when the properties and methods of a loaded SWF file are accessible. The following conditions must exist for this event to be dispatched: <ul> <li>All the properties and methods that are associated with the loaded object, as well as those that are associated with the component, must be accessible.</li> <li>The constructors for all child objects must have completed.</li> </ul> @eventType flash.events.Event.INIT @langversion 3.0 @playerversion Flash 9.0.28.0


  
          [Event("init", type="flash.events.Event")]

Dispatched after an input or output error occurs. @includeExample examples/@ax-student-ar-fl-containers-UILoader.ioError.1.as -noswf @eventType flash.events.IOErrorEvent.IO_ERROR @langversion 3.0 @playerversion Flash 9.0.28.0


  
          [Event("ioError", type="flash.events.IOErrorEvent")]

Dispatched after a network operation starts. @eventType flash.events.Event.OPEN @langversion 3.0 @playerversion Flash 9.0.28.0


  
          [Event("open", type="flash.events.Event")]

Dispatched when content is loading. This event is dispatched regardless of whether the load operation was triggered by an auto-load process or an explicit call to the <code>load()</code> method. @includeExample examples/@ax-student-ar-fl-containers-UILoader.progress.1.as -noswf @eventType flash.events.ProgressEvent.PROGRESS
see: #event:complete @langversion 3.0 @playerversion Flash 9.0.28.0


  
          [Event("progress", type="flash.events.ProgressEvent")]

Dispatched after the component is resized. @includeExample examples/@ax-student-ar-fl-containers-UILoader.resize.1.as -noswf @eventType fl.events.ComponentEvent.RESIZE @langversion 3.0 @playerversion Flash 9.0.28.0


  
          [Event("resize", type="fl.events.ComponentEvent")]

Dispatched after a security error occurs while content is loading. @eventType flash.events.SecurityErrorEvent.SECURITY_ERROR @langversion 3.0 @playerversion Flash 9.0.28.0


  
          [Event("securityError", type="flash.events.SecurityErrorEvent")]
  
      //--------------------------------------
      //  Styles
      //--------------------------------------
      
      //--------------------------------------
      //  Class description
      //--------------------------------------

The @ax-student-ar-fl-containers-UILoader class makes it possible to set content to load and to then monitor the loading operation at run time. This class also handles the resizing of the loaded content. If loading content from a different domain (sandbox), security implications may mean content properties are inaccessible. Please see the Loader class for more information. Using ActionScript to set a property of the @ax-student-ar-fl-containers-UILoader class overrides the parameter of the same name that is set in the Property inspector or Component inspector. This component wraps flash.display.Loader. The Loader class handles all the actual loading; the @ax-student-ar-fl-containers-UILoader just provides a visual display for the Loader object. Note: When content is being loaded from a different domain or sandbox, the properties of the content may be inaccessible for security reasons. For more information about how domain security affects the load process, see the Loader class.
see: flash.display.Loader Loader @includeExample examples/@fileExample.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0


  
          public class @ax-student-ar-fl-containers-UILoader extends UIComponent {

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var _scaleContent:Boolean = true;

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var _autoLoad:Boolean = true;

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var contentInited:Boolean = false;

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var _source:Object; // Can be string, instance, class, etc.

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var loader:Loader;

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var _maintainAspectRatio:Boolean = true;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected var contentClip:Sprite;

@private @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  private static var defaultStyles:Object = {};

@copy fl.core.UIComponent#getStyleDefinition()
see: fl.core.UIComponent#getStyle() UIComponent.getStyle()
see: fl.core.UIComponent#setStyle() UIComponent.setStyle()
see: fl.managers.StyleManager StyleManager @includeExample ../core/examples/UIComponent.getStyleDefinition.1.as -noswf @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public static function getStyleDefinition():Object { return defaultStyles; }
  
          //--------------------------------------
          //  Constructor
          //--------------------------------------

Creates a new @ax-student-ar-fl-containers-UILoader component instance. @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function @ax-student-ar-fl-containers-UILoader() {
                          super();
                  }

Resizes the component to the requested size. If the <code>scaleContent</code> property is set to <code>true</code>, the @ax-student-ar-fl-containers-UILoader is not resized.
parameter: w The width of the component, in pixels.
parameter: h The height of the component, in pixels. @includeExample examples/@ax-student-ar-fl-containers-UILoader.setSize.1.as -noswf
see: #scaleContent @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  override public function setSize(w:Number, h:Number):void {
                          if (!_scaleContent && _width > 0) { return; }
                          super.setSize(w, h);
                  }
                  
                  [Inspectable(defaultValue=true)]

Gets or sets a value that indicates whether the @ax-student-ar-fl-containers-UILoader instance automatically loads the specified content. A value of <code>true</code> indicates that the @ax-student-ar-fl-containers-UILoader automatically loads the content; a value of <code>false</code> indicates that content is not loaded until the <code>load()</code> method is called. @default true @includeExample examples/@ax-student-ar-fl-containers-UILoader.autoLoad.1.as -noswf
see: #load()
see: #source @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get autoLoad():Boolean {
                          return _autoLoad;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set autoLoad(value:Boolean):void {
                          _autoLoad = value;
                          if (_autoLoad && loader == null && _source != null && _source != "") { load(); }
                  }
                  
                  [Inspectable(defaultValue=true)]

Gets or sets a value that indicates whether to automatically scale the image to the size of the @ax-student-ar-fl-containers-UILoader instance. A value of <code>true</code> indicates that the image is automatically scaled to the size of the @ax-student-ar-fl-containers-UILoader instance; a value of <code>false</code> indicates that the loaded content is automatically scaled to its default size. @default true @includeExample examples/@ax-student-ar-fl-containers-UILoader.scaleContent.1.as -noswf
see: #maintainAspectRatio @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get scaleContent():Boolean {
                          return _scaleContent;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set scaleContent(value:Boolean):void {
                          if (_scaleContent == value) { return; }
                          _scaleContent = value;
                          invalidate(InvalidationType.SIZE);
                  }
  
                  
                  [Inspectable(defaultValue=true)]

Gets or sets a value that indicates whether to maintain the aspect ratio that was used in the original image or to resize the image at the curent width and height of the @ax-student-ar-fl-containers-UILoader component. A value of <code>true</code> indicates that the original aspect ratio is to be maintained; a value of <code>false</code> indicates that the loaded content should be resized to the current dimensions of the @ax-student-ar-fl-containers-UILoader. To use this property, you must set the <code>scaleContent</code> property to <code>false</code>; otherwise, this property is ignored. @default true @includeExample examples/@ax-student-ar-fl-containers-UILoader.maintainAspectRatio.1.as -noswf
see: #scaleContent @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get maintainAspectRatio():Boolean {
                          return _maintainAspectRatio;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set maintainAspectRatio(value:Boolean):void {
                          _maintainAspectRatio = value;                        
                          invalidate(InvalidationType.SIZE);
                  }

@copy ScrollPane#bytesLoaded @default 0 @includeExample examples/@ax-student-ar-fl-containers-UILoader.progress.1.as -noswf
see: #bytesTotal
see: #percentLoaded @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get bytesLoaded():uint {
                          return (loader == null || loader.contentLoaderInfo == null) ? 0 : loader.contentLoaderInfo.bytesLoaded;
                  }

@copy ScrollPane#bytesTotal @default 0 @includeExample examples/@ax-student-ar-fl-containers-UILoader.progress.1.as -noswf
see: #bytesLoaded
see: #percentLoaded @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get bytesTotal():uint {
                          return (loader == null || loader.contentLoaderInfo == null) ? 0 : loader.contentLoaderInfo.bytesTotal;
                  }

Loads binary data that is stored in a ByteArray object.
parameter: bytes A ByteArray object that contains a file in one of the formats supported by the Loader class: SWF, GIF, JPEG, or PNG.
parameter: context Only the applicationDomain property of the LoaderContext object applies; the <code>checkPolicyFile</code> and <code>securityDomain</code> properties of the LoaderContext object do not apply. @throws ArgumentError The <code>length</code> property of the ByteArray object is 0. @throws IllegalOperationError The <code>checkPolicyFile</code> or <code>securityDomain</code> property of the <code>context</code> parameter is non-null. @throws SecurityError The <code>applicationDomain</code> property of the <code>context</code> property that was provided is from a domain that is not allowed. @includeExample examples/@ax-student-ar-fl-containers-UILoader.loadBytes.1.as -noswf
see: #source
see: flash.display.Loader#loadBytes() Loader.loadBytes()
see: flash.system.LoaderContext LoaderContext @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function loadBytes(bytes:ByteArray, context:LoaderContext = null):void {
                          _unload();
                          initLoader();
                          try {
                                  loader.loadBytes(bytes, context);
                          } catch (error:*) {
                                  throw error;
                          }
                  }

Contains the root display object of the SWF file or image file (a JPEG, PNG, or GIF format file) that was loaded by using the <code>load()</code> method or setting the <code>source</code> property. The value is <code>undefined</code> until the load begins. Set the properties for the content within an event handler function for the <code>complete</code> event. @default null @includeExample examples/@ax-student-ar-fl-containers-UILoader.content.1.as -noswf
see: #event:complete
see: #load()
see: #source @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get content():DisplayObject {
                          if (loader != null) {
                                  return loader.content;        
                          } else if (contentClip.numChildren) {
                                  return contentClip.getChildAt(0);
                          }
                          return null;
                  }
                  
          [Inspectable(defaultValue="", type="String")]

@copy fl.containers.ScrollPane#source @default null @includeExample examples/@ax-student-ar-fl-containers-UILoader.source.1.as -noswf
see: #autoLoad
see: #load() @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get source():Object {
                          return _source;
                  }

@private (setter) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function set source(value:Object):void {
                          if (value == "") { return; }
                          _source = value;
                          _unload();
                          if (_autoLoad && _source != null) { 
                                  load();
                          }
                  }

@copy ScrollPane#percentLoaded @default 0 @includeExample examples/@ax-student-ar-fl-containers-UILoader.progress.1.as -noswf
see: #bytesLoaded
see: #bytesTotal @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function get percentLoaded():Number {
                          return (bytesTotal <= 0) ? 0 : bytesLoaded/bytesTotal*100;
                  }

Loads the specified content or, if no content is specified, loads the content from the location identified by the <code>source</code> property. By default, the LoaderContext object uses the current domain as the application domain. To specify a different application domain, to check a policy file, or to change the security domain, initialize a new LoaderContext object and pass it to this method. By default, the context property uses the current domain. To specify a different ApplicationDomain, check a policy file, or change the SecurityDomain, pass a new LoaderContext object.
parameter: request The URLRequest object that identifies the location from which to load the content. If this value is not specified, the current value of the <code>source</code> property is used as the content location.
parameter: context The LoaderContext object that sets the context of the load operation.
parameter: context A LoaderContext object used to specify the context of the load . @includeExample examples/@ax-student-ar-fl-containers-UILoader.load.1.as -noswf @includeExample examples/@ax-student-ar-fl-containers-UILoader.load.2.as -noswf
see: #autoLoad
see: #close()
see: #source
see: #unload()
see: flash.system.ApplicationDomain
see: flash.system.LoaderContext @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function load(request:URLRequest=null, context:LoaderContext = null):void {
                          _unload();
                          if ((request == null || request.url == null) && (_source == null || _source == "")) { return; }
                          
                          // Try and load the asset as a class/symbol/instance
                          var asset:DisplayObject = getDisplayObjectInstance(source);
                          if (asset != null) {
                                  contentClip.addChild(asset);
                                  contentInited = true;
                                  invalidate(InvalidationType.SIZE);
                                  return;
                          }
                          
                          // Asset didn't load.  Try a URL Request
                          var request:URLRequest = request;
                          if (request == null) { // Request is null, so create it using the source.
                                  request = new URLRequest(_source.toString());
                          }
                          if (context == null) {
                                  context = new LoaderContext(false, ApplicationDomain.currentDomain);
                          }
                          
                          initLoader();
                          loader.contentLoaderInfo.addEventListener(IOErrorEvent.IO_ERROR,handleError,false,0,true);
                          loader.contentLoaderInfo.addEventListener(SecurityErrorEvent.SECURITY_ERROR,handleError,false,0,true);
                          loader.contentLoaderInfo.addEventListener(Event.OPEN,passEvent,false,0,true);
                          loader.contentLoaderInfo.addEventListener(ProgressEvent.PROGRESS,passEvent,false,0,true);
                          loader.contentLoaderInfo.addEventListener(Event.COMPLETE,handleComplete,false,0,true);
                          loader.contentLoaderInfo.addEventListener(Event.INIT,handleInit,false,0,true);
                          loader.contentLoaderInfo.addEventListener(HTTPStatusEvent.HTTP_STATUS,passEvent,false,0,true);
                          loader.load(request, context);
                  }

Removes a child of this @ax-student-ar-fl-containers-UILoader object that was loaded by using either the <code>load()</code> method or the <code>source</code> property. @includeExample examples/@ax-student-ar-fl-containers-UILoader.unload.1.as -noswf
see: #load()
see: #source @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function unload():void {
                          _source = null;
                          _unload(true);
                  }

Cancels a <code>load()</code> method operation that is currently in progress for the Loader instance. The <code>load()</code> method can also be called from the <code>source</code> parameter. @throws Error The URLStream object does not have an open stream. @includeExample examples/@ax-student-ar-fl-containers-UILoader.close.1.as -noswf
see: #load()
see: #source @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  public function close():void {
                          try { 
                                  loader.close();
                          } catch (error:*) {
                                  throw error;
                          }
                  }
  
          //--------------------------------------
          //  Protected methods
          //--------------------------------------

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function _unload(throwError:Boolean=false):void {
                          if (loader != null) {
                                  clearLoadEvents();
                                  contentClip.removeChild(loader);
                                  try {
                                          loader.close();
                                  } catch (e:Error) {
                                          // Don't throw close errors.
                                  }
                                  
                                  try {
                                          loader.unload();
                                  } catch(e:*) {
                                          // Do nothing on internally generated close or unload errors.        
                                          if (throwError) { throw e; }
                                  }
                                  loader = null;
                                  return;
                          }
                          
                          contentInited = false;
                          if (contentClip.numChildren) {
                                  contentClip.removeChildAt(0);
                          }                        
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function initLoader():void {
                          loader = new Loader();
                          contentClip.addChild(loader);        
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function handleComplete(event:Event):void {
                          clearLoadEvents();
                          passEvent(event);
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function passEvent(event:Event):void {
                          dispatchEvent(event);
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function handleError(event:Event):void {
                          passEvent(event);
                          clearLoadEvents();
                          loader.contentLoaderInfo.removeEventListener(Event.INIT,handleInit);
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function handleInit(event:Event):void {
                          loader.contentLoaderInfo.removeEventListener(Event.INIT,handleInit);
                          contentInited = true;
                          passEvent(event);
                          invalidate(InvalidationType.SIZE);
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
          protected function clearLoadEvents():void {
                          // clears all events except for INIT:
                          loader.contentLoaderInfo.removeEventListener(IOErrorEvent.IO_ERROR,handleError);
                          loader.contentLoaderInfo.removeEventListener(SecurityErrorEvent.SECURITY_ERROR,handleError);
                          loader.contentLoaderInfo.removeEventListener(Event.OPEN,passEvent);
                          loader.contentLoaderInfo.removeEventListener(ProgressEvent.PROGRESS,passEvent);
                          loader.contentLoaderInfo.removeEventListener(HTTPStatusEvent.HTTP_STATUS,passEvent);
                          loader.contentLoaderInfo.removeEventListener(Event.COMPLETE,handleComplete);
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  override protected function draw():void {
                          if (isInvalid(InvalidationType.SIZE)) {
                                  drawLayout();
                          }
                          super.draw();
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function drawLayout():void {
                          if (!contentInited) { return; }
                          var resized:Boolean = false;
                          
                          var w:Number;
                          var h:Number;                        
                          if (loader) {
                                  var cl:LoaderInfo = loader.contentLoaderInfo;
                                  w = cl.width;
                                  h = cl.height
                          } else {
                                  w = contentClip.width;        
                                  h = contentClip.height;        
                          }
                          
                          var newW:Number = _width;
                          var newH:Number = _height;
                          if (!_scaleContent) {
                                  _width = contentClip.width;
                                  _height = contentClip.height;
                          } else {
                                  sizeContent(contentClip, w, h, _width, _height);
                          }
                          
                          if (newW!= _width || newH != _height) {
                                  dispatchEvent(new ComponentEvent(ComponentEvent.RESIZE, true));
                          }
                  }

@private (protected) @langversion 3.0 @playerversion Flash 9.0.28.0


  
                  protected function sizeContent(target:DisplayObject, contentWidth:Number, contentHeight:Number, targetWidth:Number, targetHeight:Number):void {
                          var w:Number = targetWidth;
                          var h:Number = targetHeight;
                          if (_maintainAspectRatio) { // Find best fit. Center vertically or horizontally
                                  var containerRatio:Number = targetWidth / targetHeight;
                                  var imageRatio:Number = contentWidth / contentHeight;
                                  
                                  if (containerRatio < imageRatio) {
                                          h = w / imageRatio;
                                  } else {
                                          w = h * imageRatio;
                                  }
                          }
                          target.width = w;
                          target.height = h;
                          target.x = targetWidth/2 - w/2;
                          target.y = targetHeight/2 - h/2;
                  }

@private (protected)


  
                  override protected function configUI():void {
                          super.configUI();
                          contentClip = new Sprite();
                          addChild(contentClip);
                  }
          }
  }

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.