Packagecom.greensock.loading.data
Classpublic class ImageLoaderVars
InheritanceImageLoaderVars Inheritance Object

Can be used instead of a generic object to define the vars parameter of an ImageLoader's constructor.

There are 2 primary benefits of using a ImageLoaderVars instance to define your ImageLoader variables:

  1. In most code editors, code hinting will be activated which helps remind you which special properties are available in ImageLoader
  2. It enables strict data typing for improved debugging (ensuring, for example, that you don't define a Boolean value for onComplete where a Function is expected).

USAGE

Note that each method returns the ImageLoaderVars instance, so you can reduce the lines of code by method chaining (see example below).

Without ImageLoaderVars:

new ImageLoader("photo1.jpg", {name:"photo1", estimatedBytes:11500, container:this, width:200, height:100, onComplete:completeHandler, onProgress:progressHandler})

With ImageLoaderVars

new ImageLoader("photo1.jpg", new ImageLoaderVars().name("photo1").estimatedBytes(11500).container(this).width(200).height(100).onComplete(completeHandler).onProgress(progressHandler))

NOTES:

Copyright 2010-2013, GreenSock. All rights reserved. This work is subject to the terms in http://www.greensock.com/terms_of_use.html or for Club GreenSock members, the software agreement that was issued with the membership.



Public Properties
 PropertyDefined By
  vars : Object
[read-only] The generic Object populated by all of the method calls in the ImageLoaderVars instance.
ImageLoaderVars
Public Methods
 MethodDefined By
  
ImageLoaderVars(vars:Object = null)
Constructor
ImageLoaderVars
  
Normally, the URL will be parsed and any variables in the query string (like "?name=test&state=il&gender=m") will be placed into a URLVariables object which is added to the URLRequest.
ImageLoaderVars
  
alpha(value:Number):ImageLoaderVars
Sets the ContentDisplay's alpha property.
ImageLoaderVars
  
If you define an alternateURL, the loader will initially try to load from its original url and if it fails, it will automatically (and permanently) change the loader's url to the alternateURL and try again.
ImageLoaderVars
  
When autoDispose is true, the loader will be disposed immediately after it completes (it calls the dispose() method internally after dispatching its COMPLETE event).
ImageLoaderVars
  
bgAlpha(value:Number):ImageLoaderVars
Controls the alpha of the rectangle that is drawn when a width and height are defined.
ImageLoaderVars
  
When a width and height are defined, a rectangle will be drawn inside the ContentDisplay Sprite immediately in order to ease the development process.
ImageLoaderVars
  
Sets the ContentDisplay's blendMode property.
ImageLoaderVars
  
If true, the registration point will be placed in the center of the ContentDisplay which can be useful if, for example, you want to animate its scale and have it grow/shrink from its center.
ImageLoaderVars
  
container(value:DisplayObjectContainer):ImageLoaderVars
A DisplayObjectContainer into which the ContentDisplay Sprite should be added immediately.
ImageLoaderVars
  
context(value:LoaderContext):ImageLoaderVars
To control whether or not a policy file is checked (which is required if you're loading an image from another domain and you want to use it in BitmapData operations), define a LoaderContext object.
ImageLoaderVars
  
crop(value:Boolean):ImageLoaderVars
When a width and height are defined, setting crop to true will cause the image to be cropped within that area (by applying a scrollRect for maximum performance).
ImageLoaderVars
  
Initially, the loader's bytesTotal is set to the estimatedBytes value (or LoaderMax.defaultEstimatedBytes if one isn't defined).
ImageLoaderVars
  
hAlign(value:String):ImageLoaderVars
When a width and height is defined, the hAlign determines how the image is horizontally aligned within that area.
ImageLoaderVars
  
height(value:Number):ImageLoaderVars
Sets the ContentDisplay's height property (applied before rotation, scaleX, and scaleY).
ImageLoaderVars
  
name(value:String):ImageLoaderVars
A name that is used to identify the loader instance.
ImageLoaderVars
  
noCache(value:Boolean):ImageLoaderVars
If true, a "gsCacheBusterID" parameter will be appended to the url with a random set of numbers to prevent caching (don't worry, this info is ignored when you LoaderMax.getLoader() or LoaderMax.getContent() by url or when you're running locally).
ImageLoaderVars
  
onCancel(value:Function):ImageLoaderVars
A handler function for LoaderEvent.CANCEL events which are dispatched when loading is aborted due to either a failure or because another loader was prioritized or cancel() was manually called.
ImageLoaderVars
  
onComplete(value:Function):ImageLoaderVars
A handler function for LoaderEvent.COMPLETE events which are dispatched when the loader has finished loading successfully.
ImageLoaderVars
  
onError(value:Function):ImageLoaderVars
A handler function for LoaderEvent.ERROR events which are dispatched whenever the loader experiences an error (typically an IO_ERROR or SECURITY_ERROR).
ImageLoaderVars
  
onFail(value:Function):ImageLoaderVars
A handler function for LoaderEvent.FAIL events which are dispatched whenever the loader fails and its status changes to LoaderStatus.FAILED.
ImageLoaderVars
  
A handler function for LoaderEvent.HTTP_STATUS events.
ImageLoaderVars
  
onIOError(value:Function):ImageLoaderVars
A handler function for LoaderEvent.IO_ERROR events which will also call the onError handler, so you can use that as more of a catch-all whereas onIOError is specifically for LoaderEvent.IO_ERROR events.
ImageLoaderVars
  
onOpen(value:Function):ImageLoaderVars
A handler function for LoaderEvent.OPEN events which are dispatched when the loader begins loading.
ImageLoaderVars
  
onProgress(value:Function):ImageLoaderVars
A handler function for LoaderEvent.PROGRESS events which are dispatched whenever the bytesLoaded changes.
ImageLoaderVars
  
A handler function for LoaderEvent.SECURITY_ERROR events which onError handles as well, so you can use that as more of a catch-all whereas onSecurityError is specifically for SECURITY_ERROR events.
ImageLoaderVars
  
prop(property:String, value:*):ImageLoaderVars
Adds a dynamic property to the vars object containing any value you want.
ImageLoaderVars
  
requireWithRoot(value:DisplayObject):ImageLoaderVars
LoaderMax supports subloading, where an object can be factored into a parent's loading progress.
ImageLoaderVars
  
Sets the ContentDisplay's rotation property.
ImageLoaderVars
  
Sets the ContentDisplay's rotationX property.
ImageLoaderVars
  
Sets the ContentDisplay's rotationY property.
ImageLoaderVars
  
Sets the ContentDisplay's rotationZ property.
ImageLoaderVars
  
When a width and height are defined, the scaleMode controls how the loaded image will be scaled to fit the area.
ImageLoaderVars
  
scaleX(value:Number):ImageLoaderVars
Sets the ContentDisplay's scaleX property.
ImageLoaderVars
  
scaleY(value:Number):ImageLoaderVars
Sets the ContentDisplay's scaleY property.
ImageLoaderVars
  
smoothing(value:Boolean):ImageLoaderVars
When smoothing is true (the default), smoothing will be enabled for the image which typically leads to much better scaling results (otherwise the image can look crunchy/jagged).
ImageLoaderVars
  
vAlign(value:String):ImageLoaderVars
When a width and height is defined, the vAlign determines how the image is vertically aligned within that area.
ImageLoaderVars
  
visible(value:Boolean):ImageLoaderVars
Sets the ContentDisplay's visible property.
ImageLoaderVars
  
width(value:Number):ImageLoaderVars
Sets the ContentDisplay's width property (applied before rotation, scaleX, and scaleY).
ImageLoaderVars
  
x(value:Number):ImageLoaderVars
Sets the ContentDisplay's x property (for positioning on the stage).
ImageLoaderVars
  
y(value:Number):ImageLoaderVars
Sets the ContentDisplay's y property (for positioning on the stage).
ImageLoaderVars
  
z(value:Number):ImageLoaderVars
Sets the ContentDisplay's z property (for positioning on the stage).
ImageLoaderVars
Property Detail
varsproperty
vars:Object  [read-only]

The generic Object populated by all of the method calls in the ImageLoaderVars instance. This is the raw data that gets passed to the loader.


Implementation
    public function get vars():Object
Constructor Detail
ImageLoaderVars()Constructor
public function ImageLoaderVars(vars:Object = null)

Constructor

Parameters
vars:Object (default = null) — A generic Object containing properties that you'd like to add to this ImageLoaderVars instance.
Method Detail
allowMalformedURL()method
public function allowMalformedURL(value:Boolean):ImageLoaderVars

Normally, the URL will be parsed and any variables in the query string (like "?name=test&state=il&gender=m") will be placed into a URLVariables object which is added to the URLRequest. This avoids a few bugs in Flash, but if you need to keep the entire URL intact (no parsing into URLVariables), set allowMalformedURL:true. For example, if your URL has duplicate variables in the query string like http://www.greensock.com/?c=S&c=SE&c=SW, it is technically considered a malformed URL and a URLVariables object can't properly contain all the duplicates, so in this case you'd want to set allowMalformedURL to true.

Parameters

value:Boolean

Returns
ImageLoaderVars
alpha()method 
public function alpha(value:Number):ImageLoaderVars

Sets the ContentDisplay's alpha property.

Parameters

value:Number

Returns
ImageLoaderVars
alternateURL()method 
public function alternateURL(value:String):ImageLoaderVars

If you define an alternateURL, the loader will initially try to load from its original url and if it fails, it will automatically (and permanently) change the loader's url to the alternateURL and try again. Think of it as a fallback or backup url. It is perfectly acceptable to use the same alternateURL for multiple loaders (maybe a default image for various ImageLoaders for example).

Parameters

value:String

Returns
ImageLoaderVars
autoDispose()method 
public function autoDispose(value:Boolean):ImageLoaderVars

When autoDispose is true, the loader will be disposed immediately after it completes (it calls the dispose() method internally after dispatching its COMPLETE event). This will remove any listeners that were defined in the vars object (like onComplete, onProgress, onError, onInit). Once a loader is disposed, it can no longer be found with LoaderMax.getLoader() or LoaderMax.getContent() - it is essentially destroyed but its content is not unloaded (you must call unload() or dispose(true) to unload its content). The default autoDispose value is false.

Parameters

value:Boolean

Returns
ImageLoaderVars
bgAlpha()method 
public function bgAlpha(value:Number):ImageLoaderVars

Controls the alpha of the rectangle that is drawn when a width and height are defined.

Parameters

value:Number

Returns
ImageLoaderVars
bgColor()method 
public function bgColor(value:uint):ImageLoaderVars

When a width and height are defined, a rectangle will be drawn inside the ContentDisplay Sprite immediately in order to ease the development process. It is transparent by default, but you may define a bgColor if you prefer.

Parameters

value:uint

Returns
ImageLoaderVars
blendMode()method 
public function blendMode(value:String):ImageLoaderVars

Sets the ContentDisplay's blendMode property.

Parameters

value:String

Returns
ImageLoaderVars
centerRegistration()method 
public function centerRegistration(value:Boolean):ImageLoaderVars

If true, the registration point will be placed in the center of the ContentDisplay which can be useful if, for example, you want to animate its scale and have it grow/shrink from its center.

Parameters

value:Boolean

Returns
ImageLoaderVars
container()method 
public function container(value:DisplayObjectContainer):ImageLoaderVars

A DisplayObjectContainer into which the ContentDisplay Sprite should be added immediately.

Parameters

value:DisplayObjectContainer

Returns
ImageLoaderVars
context()method 
public function context(value:LoaderContext):ImageLoaderVars

To control whether or not a policy file is checked (which is required if you're loading an image from another domain and you want to use it in BitmapData operations), define a LoaderContext object. By default, the policy file will be checked when running remotely, so make sure the appropriate crossdomain.xml file is in place. See Adobe's LoaderContext documentation for details and precautions.

Parameters

value:LoaderContext

Returns
ImageLoaderVars
crop()method 
public function crop(value:Boolean):ImageLoaderVars

When a width and height are defined, setting crop to true will cause the image to be cropped within that area (by applying a scrollRect for maximum performance). This is typically useful when the scaleMode is "proportionalOutside" or "none" so that any parts of the image that exceed the dimensions defined by width and height are visually chopped off. Use the hAlign and vAlign special properties to control the vertical and horizontal alignment within the cropped area.

Parameters

value:Boolean

Returns
ImageLoaderVars
estimatedBytes()method 
public function estimatedBytes(value:uint):ImageLoaderVars

Initially, the loader's bytesTotal is set to the estimatedBytes value (or LoaderMax.defaultEstimatedBytes if one isn't defined). Then, when the loader begins loading and it can accurately determine the bytesTotal, it will do so. Setting estimatedBytes is optional, but the more accurate the value, the more accurate your loaders' overall progress will be initially. If the loader is inserted into a LoaderMax instance (for queue management), its auditSize feature can attempt to automatically determine the bytesTotal at runtime (there is a slight performance penalty for this, however - see LoaderMax's documentation for details).

Parameters

value:uint

Returns
ImageLoaderVars
hAlign()method 
public function hAlign(value:String):ImageLoaderVars

When a width and height is defined, the hAlign determines how the image is horizontally aligned within that area. The following values are recognized (you may use the com.greensock.layout.AlignMode constants if you prefer):

Parameters

value:String

Returns
ImageLoaderVars
height()method 
public function height(value:Number):ImageLoaderVars

Sets the ContentDisplay's height property (applied before rotation, scaleX, and scaleY).

Parameters

value:Number

Returns
ImageLoaderVars
name()method 
public function name(value:String):ImageLoaderVars

A name that is used to identify the loader instance. This name can be fed to the LoaderMax.getLoader() or LoaderMax.getContent() methods or traced at any time. Each loader's name should be unique. If you don't define one, a unique name will be created automatically, like "loader21".

Parameters

value:String

Returns
ImageLoaderVars
noCache()method 
public function noCache(value:Boolean):ImageLoaderVars

If true, a "gsCacheBusterID" parameter will be appended to the url with a random set of numbers to prevent caching (don't worry, this info is ignored when you LoaderMax.getLoader() or LoaderMax.getContent() by url or when you're running locally).

Parameters

value:Boolean

Returns
ImageLoaderVars
onCancel()method 
public function onCancel(value:Function):ImageLoaderVars

A handler function for LoaderEvent.CANCEL events which are dispatched when loading is aborted due to either a failure or because another loader was prioritized or cancel() was manually called. Make sure your onCancel function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).

Parameters

value:Function

Returns
ImageLoaderVars
onComplete()method 
public function onComplete(value:Function):ImageLoaderVars

A handler function for LoaderEvent.COMPLETE events which are dispatched when the loader has finished loading successfully. Make sure your onComplete function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).

Parameters

value:Function

Returns
ImageLoaderVars
onError()method 
public function onError(value:Function):ImageLoaderVars

A handler function for LoaderEvent.ERROR events which are dispatched whenever the loader experiences an error (typically an IO_ERROR or SECURITY_ERROR). An error doesn't necessarily mean the loader failed, however - to listen for when a loader fails, use the onFail special property. Make sure your onError function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).

Parameters

value:Function

Returns
ImageLoaderVars
onFail()method 
public function onFail(value:Function):ImageLoaderVars

A handler function for LoaderEvent.FAIL events which are dispatched whenever the loader fails and its status changes to LoaderStatus.FAILED. Make sure your onFail function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).

Parameters

value:Function

Returns
ImageLoaderVars
onHTTPStatus()method 
public function onHTTPStatus(value:Function):ImageLoaderVars

A handler function for LoaderEvent.HTTP_STATUS events. Make sure your onHTTPStatus function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent). You can determine the httpStatus code using the LoaderEvent's target.httpStatus (LoaderItems keep track of their httpStatus when possible, although certain environments prevent Flash from getting httpStatus information).

Parameters

value:Function

Returns
ImageLoaderVars
onIOError()method 
public function onIOError(value:Function):ImageLoaderVars

A handler function for LoaderEvent.IO_ERROR events which will also call the onError handler, so you can use that as more of a catch-all whereas onIOError is specifically for LoaderEvent.IO_ERROR events. Make sure your onIOError function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).

Parameters

value:Function

Returns
ImageLoaderVars
onOpen()method 
public function onOpen(value:Function):ImageLoaderVars

A handler function for LoaderEvent.OPEN events which are dispatched when the loader begins loading. Make sure your onOpen function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).

Parameters

value:Function

Returns
ImageLoaderVars
onProgress()method 
public function onProgress(value:Function):ImageLoaderVars

A handler function for LoaderEvent.PROGRESS events which are dispatched whenever the bytesLoaded changes. Make sure your onProgress function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent). You can use the LoaderEvent's target.progress to get the loader's progress value or use its target.bytesLoaded and target.bytesTotal.

Parameters

value:Function

Returns
ImageLoaderVars
onSecurityError()method 
public function onSecurityError(value:Function):ImageLoaderVars

A handler function for LoaderEvent.SECURITY_ERROR events which onError handles as well, so you can use that as more of a catch-all whereas onSecurityError is specifically for SECURITY_ERROR events. Make sure your onSecurityError function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).

Parameters

value:Function

Returns
ImageLoaderVars
prop()method 
public function prop(property:String, value:*):ImageLoaderVars

Adds a dynamic property to the vars object containing any value you want. This can be useful in situations where you need to associate certain data with a particular loader. Just make sure that the property name is a valid variable name (starts with a letter or underscore, no special characters, etc.) and that it doesn't use a reserved property name like "name" or "onComplete", etc. For example, to set an "index" property to 5, do: prop("index", 5);

Parameters

property:String — Property name
 
value:* — Value

Returns
ImageLoaderVars
requireWithRoot()method 
public function requireWithRoot(value:DisplayObject):ImageLoaderVars

LoaderMax supports subloading, where an object can be factored into a parent's loading progress. If you want LoaderMax to require this loader as part of its parent SWFLoader's progress, you must set the requireWithRoot property to your swf's root. For example, vars.requireWithRoot = this.root;.

Parameters

value:DisplayObject

Returns
ImageLoaderVars
rotation()method 
public function rotation(value:Number):ImageLoaderVars

Sets the ContentDisplay's rotation property.

Parameters

value:Number

Returns
ImageLoaderVars
rotationX()method 
public function rotationX(value:Number):ImageLoaderVars

Sets the ContentDisplay's rotationX property.

Parameters

value:Number

Returns
ImageLoaderVars
rotationY()method 
public function rotationY(value:Number):ImageLoaderVars

Sets the ContentDisplay's rotationY property.

Parameters

value:Number

Returns
ImageLoaderVars
rotationZ()method 
public function rotationZ(value:Number):ImageLoaderVars

Sets the ContentDisplay's rotationZ property.

Parameters

value:Number

Returns
ImageLoaderVars
scaleMode()method 
public function scaleMode(value:String):ImageLoaderVars

When a width and height are defined, the scaleMode controls how the loaded image will be scaled to fit the area. The following values are recognized (you may use the com.greensock.layout.ScaleMode constants if you prefer):

Parameters

value:String

Returns
ImageLoaderVars
scaleX()method 
public function scaleX(value:Number):ImageLoaderVars

Sets the ContentDisplay's scaleX property.

Parameters

value:Number

Returns
ImageLoaderVars
scaleY()method 
public function scaleY(value:Number):ImageLoaderVars

Sets the ContentDisplay's scaleY property.

Parameters

value:Number

Returns
ImageLoaderVars
smoothing()method 
public function smoothing(value:Boolean):ImageLoaderVars

When smoothing is true (the default), smoothing will be enabled for the image which typically leads to much better scaling results (otherwise the image can look crunchy/jagged). If your image is loaded from another domain where the appropriate crossdomain.xml file doesn't grant permission, Flash will not allow smoothing to be enabled (it's a security restriction).

Parameters

value:Boolean

Returns
ImageLoaderVars
vAlign()method 
public function vAlign(value:String):ImageLoaderVars

When a width and height is defined, the vAlign determines how the image is vertically aligned within that area. The following values are recognized (you may use the com.greensock.layout.AlignMode constants if you prefer):

Parameters

value:String

Returns
ImageLoaderVars
visible()method 
public function visible(value:Boolean):ImageLoaderVars

Sets the ContentDisplay's visible property.

Parameters

value:Boolean

Returns
ImageLoaderVars
width()method 
public function width(value:Number):ImageLoaderVars

Sets the ContentDisplay's width property (applied before rotation, scaleX, and scaleY).

Parameters

value:Number

Returns
ImageLoaderVars
x()method 
public function x(value:Number):ImageLoaderVars

Sets the ContentDisplay's x property (for positioning on the stage).

Parameters

value:Number

Returns
ImageLoaderVars
y()method 
public function y(value:Number):ImageLoaderVars

Sets the ContentDisplay's y property (for positioning on the stage).

Parameters

value:Number

Returns
ImageLoaderVars
z()method 
public function z(value:Number):ImageLoaderVars

Sets the ContentDisplay's z property (for positioning on the stage).

Parameters

value:Number

Returns
ImageLoaderVars