Packagecom.degrafa.utilities.external
Classpublic class ExternalBitmapData
InheritanceExternalBitmapData Inheritance ExternalDataAsset Inheritance DegrafaObject
ImplementsIExternalData

The ExternalDataAsset class defines the properties for an external data source used at runtime by Degrafa. You can use an ExternalDataAsset object in actionscript - it may be useful to set up preloading, for example, but in mxml use of an ExternalDataAsset is already encapsulated into the Degrafa class that uses the content (when it is ready) by virtue of its source property assignment. The data content provided by an ExternalDataAsset will only be available once the asset from the external url has loaded.


Public Properties
 PropertyDefined by
 InheritedbytesLoaded : Number
the current bytes loaded for this ExternalDataAsset
ExternalDataAsset
 InheritedbytesTotal : Number
the bytesTotal for this ExternalDataAsset if known (i.e.
ExternalDataAsset
 Inheritedcontent : Object
The loaded content (a BitmapData instance) if it is available or false (Boolean) if not available (triggers a loading request if not already requested).
ExternalDataAsset
 Inheriteddocument : Object
The MXML document that created this object.
DegrafaObject
 InheritedenableEvents : Boolean
Enable events for this object.
DegrafaObject
 InheritedhasEventManager : Boolean
Tests to see if a EventDispatcher instance has been created for this object.
DegrafaObject
 Inheritedid : String
The identifier used by document to refer to this object.
DegrafaObject
 InheritedisInitialized : Boolean
DegrafaObject
 InheritedloadingLocation : LoadingLocation
ptional loadingLocation reference.
ExternalDataAsset
 Inheritedname : String
The name that refers to this object.
DegrafaObject
 InheritedobjectBindings : Array
DegrafaObject
 Inheritedparent : IDegrafaObject
The current degrafa object parent.
DegrafaObject
 InheritedrequestBitmapDataAccess : LoaderContext
[static]
ExternalDataAsset
 InheritedsuppressEventProcessing : Boolean
Temporarily suppress event processing for this object.
DegrafaObject
 Inheritedurl : String
the url of the external asset assignable as either a string representing a url relative to an associated LoadingGroup basePath or as a regular url For alternate domain loading or for redundancy support (multple locations) loading on error, use an associated LoadingGroup assigned via the loadingGroup property and make this url relative to the basePath defined in the LoadingGroup
ExternalDataAsset
Protected Properties
 PropertyDefined by
 Inherited_data : Object
ExternalDataAsset
 InheriteddataType : Class
ExternalDataAsset
 InheritedeventDispatcher : EventDispatcher
EventDispatcher instance for this object.
DegrafaObject
 Inherited_url : String
ExternalDataAsset
Public Methods
 MethodDefined by
  
ExternalBitmapData(url:String = null, totalBytes:Number, loc:LoadingLocation = null)
Constructor for ExternalBitmapData
ExternalBitmapData
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
DegrafaObject
 Inherited
dispatchEvent(evt:Event):Boolean
Dispatches an event into the event flow.
DegrafaObject
 Inherited
dispatchPropertyChange(bubbles:Boolean = false, property:Object = null, oldValue:Object = null, newValue:Object = null, source:Object = null):Boolean
Dispatches an property change event into the event flow.
DegrafaObject
  
getUniqueInstance(url:String = null, loc:LoadingLocation = null):ExternalBitmapData
[static]
ExternalBitmapData
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
DegrafaObject
 Inherited
initChange(property:String, oldValue:Object, newValue:Object, source:Object):void
Helper function for dispatching property changes
DegrafaObject
 Inherited
initialized(document:Object, id:String):void
Called after the implementing object has been created and all component properties specified on the MXML tag have been initialized.
DegrafaObject
 Inherited
load():void
load this item, using LoadingGroup settings if this ExternalDataAsset is associated with a LoadingGroup instance
ExternalDataAsset
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
DegrafaObject
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
DegrafaObject
Protected Methods
 MethodDefined by
  
cleanUp():void
ExternalBitmapData
  
processLoad(loader:Object):String
ExternalBitmapData
 Inherited
reset():Boolean
resets the status to waiting prior to load, stopping any current load in progress.
ExternalDataAsset
Events
 EventSummaryDefined by
 Inherited
initialize
 DegrafaObject
 Inherited
propertyChange
 DegrafaObject
Public Constants
 ConstantDefined by
 InheritedSTATUS_DATA_ERROR : String = "itemDataError"
[static]
ExternalDataAsset
 InheritedSTATUS_IDENTIFIED : String = "itemIdentified"
[static]
ExternalDataAsset
 InheritedSTATUS_INITIALIZING : String = "itemInitializing"
[static]
ExternalDataAsset
 InheritedSTATUS_LOAD_ERROR : String = "itemLoadError"
[static]
ExternalDataAsset
 InheritedSTATUS_PROGRESS : String = "itemLoadProgress"
[static]
ExternalDataAsset
 InheritedSTATUS_READY : String = "itemReady"
[static]
ExternalDataAsset
 InheritedSTATUS_REQUESTED : String = "itemRequested"
[static]
ExternalDataAsset
 InheritedSTATUS_SECURITY_ERROR : String = "itemSecurityError"
[static]
ExternalDataAsset
 InheritedSTATUS_STARTED : String = "itemLoadStarted"
[static]
ExternalDataAsset
 InheritedSTATUS_WAITING : String = "itemWaiting"
[static]
ExternalDataAsset
 InheritedTYPE_IMAGE_GIF : String = "image/gif"
[static]
ExternalDataAsset
 InheritedTYPE_IMAGE_JPEG : String = "image/jpeg"
[static]
ExternalDataAsset
 InheritedTYPE_IMAGE_PNG : String = "image/png"
[static]
ExternalDataAsset
 InheritedTYPE_SWF : String = "application/x-shockwave-flash"
[static]
ExternalDataAsset
 InheritedTYPE_UNKNOWN : String
[static]
ExternalDataAsset
Constructor detail
ExternalBitmapData()constructor
public function ExternalBitmapData(url:String = null, totalBytes:Number, loc:LoadingLocation = null)

Constructor for ExternalBitmapData

Parameters
url:String (default = null) — absolute or relative url to external asset (must be relative if a LoadingLocation is used)
 
totalBytes:Number — [optional] total bytes, if known before loading commences
 
loc:LoadingLocation (default = null) — a LoadingLocation for security handling
Method detail
cleanUp()method
protected override function cleanUp():void
getUniqueInstance()method 
public static function getUniqueInstance(url:String = null, loc:LoadingLocation = null):ExternalBitmapDataParameters
url:String (default = null)
 
loc:LoadingLocation (default = null)

Returns
ExternalBitmapData
processLoad()method 
protected override function processLoad(loader:Object):StringParameters
loader:Object

Returns
String