Package | feathers.controls |
Class | public class ImageLoader |
Inheritance | ImageLoader ![]() ![]() ![]() ![]() ![]() ![]() |
Product Version : | Feathers 1.0.0 |
Texture
object or
from an image file loaded with its URL. Supported image files include ATF
format and any bitmap formats that may be loaded by
flash.display.Loader
, including JPG, GIF, and PNG.
The following example passes a URL to an image loader and listens for its complete event:
var loader:ImageLoader = new ImageLoader(); loader.source = "http://example.com/example.png"; loader.addEventListener( Event.COMPLETE, loader_completeHandler ); this.addChild( loader );
The following example passes an existing texture to an image loader:
var loader:ImageLoader = new ImageLoader(); loader.source = Texture.fromBitmap( bitmap ); this.addChild( loader );
Property | Defined By | ||
---|---|---|---|
![]() | addedEffect : Function
An optional effect that is activated when the component is added to
the stage. | FeathersControl | |
![]() | alpha : Number The opacity of the object. | DisplayObject | |
asyncTextureUpload : Boolean
Determines if textures loaded from URLs are uploaded asynchronously
or not. | ImageLoader | ||
![]() | base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
![]() | blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
![]() | bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
![]() | defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
![]() | defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
delayTextureCreation : Boolean
Determines if a loaded bitmap may be converted to a texture
immediately after loading. | ImageLoader | ||
![]() | depth : int [read-only]
The component's depth in the display list, relative to the stage. | FeathersControl | |
![]() | effectsSuspended : Boolean [read-only]
Indicates if effects have been suspended. | FeathersControl | |
![]() | explicitHeight : Number [read-only]
The height value explicitly set by passing a value to the
height setter or by calling the setSize()
function. | FeathersControl | |
![]() | explicitMaxHeight : Number [read-only]
The maximum height value explicitly set by passing a value to the
maxHeight setter. | FeathersControl | |
![]() | explicitMaxWidth : Number [read-only]
The maximum width value explicitly set by passing a value to the
maxWidth setter. | FeathersControl | |
![]() | explicitMinHeight : Number [read-only]
The minimum height value explicitly set by passing a value to the
minHeight setter. | FeathersControl | |
![]() | explicitMinWidth : Number [read-only]
The minimum width value explicitly set by passing a value to the
minWidth setter. | FeathersControl | |
![]() | explicitWidth : Number [read-only]
The width value explicitly set by passing a value to the
width setter or to the setSize() method. | FeathersControl | |
![]() | filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
![]() | focusInEffect : Function
An optional effect that is activated when the component receives
focus. | FeathersControl | |
![]() | focusManager : IFocusManager
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The current focus manager for this component. | FeathersControl | |
![]() | focusOutEffect : Function
An optional effect that is activated when the component loses focus. | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Used for associating focusable display objects that are not direct
children with an "owner" focusable display object, such as pop-ups. | FeathersControl | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all ImageLoader
components. | ImageLoader | ||
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
![]() | hideEffect : Function
An optional effect that is activated when the component is hidden. | FeathersControl | |
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | is3D : Boolean [read-only] Indicates if this object or any of its parents is a 'Sprite3D' object. | DisplayObject | |
![]() | isCreated : Boolean [read-only]
Determines if the component has been initialized and validated for
the first time. | FeathersControl | |
![]() | isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
![]() | isFocusEnabled : Boolean
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Determines if this component can receive focus. | FeathersControl | |
![]() | isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
isLoaded : Boolean [read-only]
Indicates if the source has completed loading, if the source is a
URL. | ImageLoader | ||
![]() | isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
![]() | isShowingFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
Indicates if the showFocus() method has been called on
the object when it has focus. | FeathersControl | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
loaderContext : LoaderContext
If the texture is loaded using flash.display.Loader,
a custom flash.system.LoaderContext may optionally
be provided. | ImageLoader | ||
![]() | maintainTouchFocus : Boolean [read-only]
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
If true, the display object should remain in focus,
even if something else is touched. | FeathersControl | |
![]() | mask : DisplayObject The display object that acts as a mask for the current object. | DisplayObject | |
![]() | maskInverted : Boolean Indicates if the masked region of this object is set to be inverted. | DisplayObject | |
![]() | maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
![]() | minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
![]() | moveEffect : Function
An optional effect that is activated when the component is moved to
a new position. | FeathersControl | |
![]() | name : String The name of the display object (default: null). | DisplayObject | |
![]() | nextDownFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.DOWN is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextLeftFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.LEFT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextRightFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.RIGHT is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | nextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when the tab key is pressed
when a focus manager is enabled. | FeathersControl | |
![]() | nextUpFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The next object that will receive focus when
Keyboard.UP is pressed at
KeyLocation.D_PAD and a focus manager is enabled. | FeathersControl | |
![]() | numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
originalSourceHeight : Number [read-only]
The original height of the source content, in pixels. | ImageLoader | ||
originalSourceWidth : Number [read-only]
The original width of the source content, in pixels. | ImageLoader | ||
![]() | parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
![]() | pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
![]() | pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
![]() | previousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience,
but it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
The previous object that will receive focus when the tab key is
pressed while holding shift when a focus manager is enabled. | FeathersControl | |
![]() | requiresRedraw : Boolean [read-only] Indicates if the object needs to be redrawn in the upcoming frame, i.e. | DisplayObject | |
![]() | resizeEffect : Function
An optional effect that is activated when the component is resized
with new dimensions. | FeathersControl | |
![]() | root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
![]() | rotation : Number The rotation of the object in radians. | DisplayObject | |
![]() | scale : Number Sets both 'scaleX' and 'scaleY' to the same value. | DisplayObject | |
scaleFactor : Number
The scale factor value to pass to Texture.fromBitmapData()
when creating a texture loaded from a URL. | ImageLoader | ||
![]() | scaleX : Number The horizontal scale factor. | DisplayObject | |
![]() | scaleY : Number The vertical scale factor. | DisplayObject | |
![]() | showEffect : Function
An optional effect that is activated when the component is shown. | FeathersControl | |
![]() | skewX : Number The horizontal skew angle in radians. | DisplayObject | |
![]() | skewY : Number The vertical skew angle in radians. | DisplayObject | |
source : Object
The Texture to display, or a URL pointing to an image
file. | ImageLoader | ||
![]() | stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
style : MeshStyle
The style that is used to render the loader's image. | ImageLoader | ||
![]() | styleName : String
The concatenated styleNameList, with values separated
by spaces. | FeathersControl | |
![]() | styleNameList : TokenList [read-only]
Contains a list of all "styles" assigned to this control. | FeathersControl | |
![]() | styleProvider : IStyleProvider
When a component initializes, a style provider may be used to set
properties that affect the component's visual appearance. | FeathersControl | |
textureCache : TextureCache
An optional cache for textures. | ImageLoader | ||
textureFormat : String
The texture format to use when creating a texture loaded from a URL. | ImageLoader | ||
textureQueueDuration : Number
If delayTextureCreation is true and the
duration is not Number.POSITIVE_INFINITY, the loader
will be added to a queue where the textures are uploaded to the GPU
in sequence to avoid significantly affecting performance. | ImageLoader | ||
textureScale : Number
Scales the texture dimensions during measurement, but does not set
the texture's scale factor. | ImageLoader | ||
![]() | toolTip : String
Text to display in a tool tip to when hovering over this component,
if the ToolTipManager is enabled. | FeathersControl | |
![]() | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
![]() | touchGroup : Boolean If a container is a 'touchGroup', it will act as a single touchable object. | DisplayObjectContainer | |
![]() | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
![]() | transformationMatrix3D : Matrix3D [read-only] The 3D transformation matrix of the object relative to its parent. | DisplayObject | |
![]() | useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
![]() | visible : Boolean The visibility of the object. | DisplayObject | |
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl | |
![]() | x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
![]() | y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject |
Property | Defined By | ||
---|---|---|---|
![]() | actualHeight : Number = 0
The final height value that should be used for layout. | FeathersControl | |
![]() | actualMinHeight : Number = 0
The final minimum height value that should be used for layout. | FeathersControl | |
![]() | actualMinWidth : Number = 0
The final minimum width value that should be used for layout. | FeathersControl | |
![]() | actualWidth : Number = 0
The final width value that should be used for layout. | FeathersControl | |
![]() | defaultStyleProvider : IStyleProvider [read-only]
When the FeathersControl constructor is called, the
styleProvider property is set to this value. | FeathersControl | |
image : Image
The internal starling.display.Image child. | ImageLoader | ||
loader : Loader
The internal flash.display.Loader used to load textures
from URLs. | ImageLoader | ||
urlLoader : URLLoader
The internal flash.net.URLLoader used to load raw data
from URLs. | ImageLoader |
Method | Defined By | ||
---|---|---|---|
Constructor. | ImageLoader | ||
![]() | Adds a child to the container. | DisplayObjectContainer | |
![]() | Adds a child to the container at a certain index. | DisplayObjectContainer | |
![]() | addEventListener(type:String, listener:Function):void [override] Registers an event listener at a certain object. | DisplayObject | |
![]() | alignPivot(horizontalAlign:String = center, verticalAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
![]() | broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
![]() | broadcastEventWith(eventType:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
![]() | contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
![]() | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
![]() | dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
![]() | dispose():void [override] Disposes the resources of all children. | DisplayObjectContainer | |
![]() | drawToBitmapData(out:BitmapData = null, color:uint = 0x0, alpha:Number = 0.0):BitmapData Draws the object into a BitmapData object. | DisplayObject | |
![]() | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override]
Feathers components use an optimized getBounds()
implementation that may sometimes behave differently than regular
Starling display objects. | FeathersControl | |
![]() | getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
![]() | getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
![]() | getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
![]() | getTransformationMatrix(targetSpace:DisplayObject, out:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | getTransformationMatrix3D(targetSpace:DisplayObject, out:Matrix3D = null):Matrix3D Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
![]() | globalToLocal(globalPoint:Point, out:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
![]() | globalToLocal3D(globalPoint:Point, out:Vector3D = null):Vector3D Transforms a point from global (stage) coordinates to the 3D local coordinate system. | DisplayObject | |
![]() | hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | |
![]() | hideFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | hitTest(localPoint:Point):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil
if the test fails. | DisplayObjectContainer | |
![]() | hitTestMask(localPoint:Point):Boolean Checks if a certain point is inside the display object's mask. | DisplayObject | |
![]() | initializeNow():void
If the component has not yet initialized, initializes immediately. | FeathersControl | |
![]() | invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
![]() | isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
![]() | local3DToGlobal(localPoint:Vector3D, out:Point = null):Point Transforms a 3D point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | localToGlobal(localPoint:Point, out:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | Removes a child from the container. | DisplayObjectContainer | |
![]() | removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
![]() | removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
![]() | removeEventListener(type:String, listener:Function):void [override] Removes an event listener from the object. | DisplayObject | |
![]() | removeEventListeners(type:String = null):void [override] Removes all event listeners with a certain type, or all of them if type is null. | DisplayObject | |
![]() | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
![]() | removeFromParentWithEffect(effect:Function, dispose:Boolean = false):void
Plays an effect before removing the component from its parent. | FeathersControl | |
![]() | [override] Renders the display object with the help of a painter object. | DisplayObjectContainer | |
![]() | resetStyleProvider():void
Resets the styleProvider property to its default value,
which is usually the global style provider for the component. | FeathersControl | |
![]() | resumeEffects():void
Indicates that effects should be re-activated after being suspended. | FeathersControl | |
![]() | setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
![]() | setRequiresRedraw():void Forces the object to be redrawn in the next frame. | DisplayObject | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
The implementation of this method is provided for convenience, but
it cannot be used unless a subclass implements the
IFocusDisplayObject interface.
| FeathersControl | |
![]() | sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
![]() | suspendEffects():void
Indicates that effects should not be activated temporarily. | FeathersControl | |
![]() | Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
![]() | validate():void
Immediately validates the display object, if it is invalid. | FeathersControl |
Method | Defined By | ||
---|---|---|---|
autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. | ImageLoader | ||
![]() | clearInvalidationFlag(flag:String):void
Clears an invalidation flag. | FeathersControl | |
![]() | draw():void
Override to customize layout and to adjust properties of children. | FeathersControl | |
![]() | focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN
that may be overridden in subclasses to perform additional actions
when the component receives focus. | FeathersControl | |
![]() | focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT
that may be overridden in subclasses to perform additional actions
when the component loses focus. | FeathersControl | |
![]() | ignoreNextStyleRestriction():void
The next style that is set will not be restricted. | FeathersControl | |
![]() | initialize():void
Called the first time that the UI control is added to the stage, and
you should override this function to customize the initialization
process. | FeathersControl | |
![]() | processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to
determine if the setter has been called directly on the component or
from a style provider. | FeathersControl | |
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | FeathersControl | |
![]() | saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the
component. | FeathersControl | |
![]() | setInvalidationFlag(flag:String):void
Sets an invalidation flag. | FeathersControl | |
![]() | setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of
invalidating or not. | FeathersControl |
Event | Summary | Defined By | ||
---|---|---|---|---|
![]() | Dispatched when an object is added to a parent. | DisplayObject | ||
![]() | Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject | ||
Dispatched when the source finishes loading, if the source is a URL. | ImageLoader | |||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
![]() | Dispatched once every frame on every object that is connected to the stage. | DisplayObject | ||
![]() | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
Dispatched if an IO error occurs while loading the source content. | ImageLoader | |||
![]() | Dispatched when a key on the keyboard is pressed. | DisplayObject | ||
![]() | Dispatched when a key on the keyboard is released. | DisplayObject | ||
Dispatched periodically as the source loads, if the source is a URL. | ImageLoader | |||
![]() | Dispatched when an object is removed from its parent. | DisplayObject | ||
![]() | Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject | ||
![]() | Dispatched when the width or height of the control changes. | FeathersControl | ||
Dispatched if a security error occurs while loading the source content. | ImageLoader | |||
![]() | Dispatched when an object is touched. | DisplayObject |
Style | Description | Defined By | ||
---|---|---|---|---|
color | Type: uint The tint value to use on the internal starling.display.Image .
In the following example, the image loader's texture color is customized:
loader.color = 0xff00ff;
The default value is 0xffffff .See also | ImageLoader | ||
errorTexture | Type: starling.textures.Texture A texture to display when a URL source cannot be loaded for any reason. In the following example, the image loader's error texture is customized:
loader.source = "http://example.com/example.png";
loader.errorTexture = texture;
The default value is null .See also | ImageLoader | ||
![]() | Type: starling.display.DisplayObject If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.See also | FeathersControl | ||
![]() | Type: Number Quickly sets all focus padding properties to the same value. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin. See also | FeathersControl | ||
![]() | Type: Number The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin. See also | FeathersControl | ||
horizontalAlign | Type: String The location where the content is aligned horizontally (on the x-axis) when its width is larger or smaller than the width of the ImageLoader .
If the The following example aligns the content to the right:
loader.horizontalAlign = HorizontalAlign.RIGHT;
Note: The feathers.layout.HorizontalAlign.LEFT .See also | ImageLoader | ||
loadingTexture | Type: starling.textures.Texture A texture to display while a URL source is loading. In the following example, the image loader's loading texture is customized:
loader.source = "http://example.com/example.png";
loader.loadingTexture = texture;
The default value is null .See also | ImageLoader | ||
maintainAspectRatio | Type: Boolean Determines if the aspect ratio of the texture is maintained when the dimensions of the ImageLoader are changed manually and
the new dimensions have a different aspect ratio than the texture.
If the In the following example, the image loader's aspect ratio is not maintained:
loader.maintainAspectRatio = false;
The default value is true .See also | ImageLoader | ||
padding | Type: Number Quickly sets all padding properties to the same value. The padding getter always returns the value of
paddingTop , but the other padding values may be
different.
In the following example, the image loader's padding is set to 20 pixels on all sides:
loader.padding = 20;
The default value is 0 .See also | ImageLoader | ||
paddingBottom | Type: Number The minimum space, in pixels, between the control's bottom edge and the control's content. Value may be negative to extend the content outside the edges of the control. Useful for skinning. In the following example, the image loader's bottom padding is set to 20 pixels:
loader.paddingBottom = 20;
The default value is 0 .See also | ImageLoader | ||
paddingLeft | Type: Number The minimum space, in pixels, between the control's left edge and the control's content. Value may be negative to extend the content outside the edges of the control. Useful for skinning. In the following example, the image loader's left padding is set to 20 pixels:
loader.paddingLeft = 20;
The default value is 0 .See also | ImageLoader | ||
paddingRight | Type: Number The minimum space, in pixels, between the control's right edge and the control's content. Value may be negative to extend the content outside the edges of the control. Useful for skinning. In the following example, the image loader's right padding is set to 20 pixels:
loader.paddingRight = 20;
The default value is 0 .See also | ImageLoader | ||
paddingTop | Type: Number The minimum space, in pixels, between the control's top edge and the control's content. Value may be negative to extend the content outside the edges of the control. Useful for skinning. In the following example, the image loader's top padding is set to 20 pixels:
loader.paddingTop = 20;
The default value is 0 .See also | ImageLoader | ||
pixelSnapping | Type: Boolean The pixelSnapping value to use on the internal
starling.display.Image .
In the following example, the image loader's pixelSnapping is disabled:
loader.pixelSnapping = false;
The default value is true .See also | ImageLoader | ||
scale9Grid | Type: flash.geom.Rectangle The scale9Grid value to use on the internal
starling.display.Image .
If this property is not In the following example, the image loader's scale9Grid is set to a custom value:
loader.scale9Grid = Rectangle(2, 3, 7, 12);
The default value is null .See also | ImageLoader | ||
scaleContent | Type: Boolean Determines if the content will be scaled if the dimensions of the ImageLoader are changed.
In the following example, the image loader's content is not scaled:
loader.scaleContent = false;
The default value is true .See also | ImageLoader | ||
scaleMode | Type: String Determines how the texture is scaled if scaleContent and
maintainAspectRatio are both set to true .
See the starling.utils.ScaleMode class for details about
each scaling mode.
If the In the following example, the image loader's scale mode is changed:
loader.scaleMode = ScaleMode.NO_BORDER;
The default value is starling.utils.ScaleMode.SHOW_ALL .See also | ImageLoader | ||
textureSmoothing | Type: String The texture smoothing value to use on the internal starling.display.Image .
In the following example, the image loader's smoothing is set to a custom value:
loader.textureSmoothing = TextureSmoothing.NONE;
The default value is starling.textures.TextureSmoothing.BILINEAR .See also | ImageLoader | ||
tileGrid | Type: flash.geom.Rectangle The tileGrid value to use on the internal
starling.display.Image .
In the following example, the image loader's tileGrid is set to a custom value:
loader.tileGrid = Rectangle();
The default value is null .See also | ImageLoader | ||
verticalAlign | Type: String The location where the content is aligned vertically (on the y-axis) when its height is larger or smaller than the height of the ImageLoader .
If the The following example aligns the content to the bottom:
loader.verticalAlign = VerticalAlign.BOTTOM;
Note: The feathers.layout.VerticalAlign.TOP .See also | ImageLoader |
asyncTextureUpload | property |
asyncTextureUpload:Boolean
Determines if textures loaded from URLs are uploaded asynchronously or not.
Note: depending on the version of AIR and the platform it is
running on, textures may be uploaded synchronously, even when this
property is true
.
In the following example, the texture will be uploaded synchronously:
loader.asyncTextureUpload = false;
The default value is true
.
public function get asyncTextureUpload():Boolean
public function set asyncTextureUpload(value:Boolean):void
delayTextureCreation | property |
delayTextureCreation:Boolean
Determines if a loaded bitmap may be converted to a texture
immediately after loading. If true
, the loaded bitmap
will be saved until this property is set to false
, and
only then it will be used to create the texture.
This property is intended to be used while a parent container,
such as a List
, is scrolling in order to keep scrolling
as smooth as possible. Creating textures is expensive and performance
can be affected by it. Set this property to true
when
the List
dispatches FeathersEventType.SCROLL_START
and set back to false when the List
dispatches
FeathersEventType.SCROLL_COMPLETE
. You may also need
to set to false if the isScrolling
property of the
List
is true
before you listen to those
events.
In the following example, the image loader's texture creation is delayed:
loader.delayTextureCreation = true;
The default value is false
.
public function get delayTextureCreation():Boolean
public function set delayTextureCreation(value:Boolean):void
See also
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all ImageLoader
components.
The default value is null
.
See also
image | property |
protected var image:Image
The internal starling.display.Image
child.
isLoaded | property |
isLoaded:Boolean
[read-only]
Indicates if the source has completed loading, if the source is a
URL. Always returns true
when the source is a texture.
In the following example, we check if the image loader's source has finished loading:
if( loader.isLoaded ) { //do something }
public function get isLoaded():Boolean
loader | property |
protected var loader:Loader
The internal flash.display.Loader
used to load textures
from URLs.
loaderContext | property |
loaderContext:LoaderContext
If the texture is loaded using flash.display.Loader
,
a custom flash.system.LoaderContext
may optionally
be provided.
In the following example, a custom loader context is provided:
var context:LoaderContext = new LoaderContext(); context.loadPolicyFile = true; loader.loaderContext = context;
public function get loaderContext():LoaderContext
public function set loaderContext(value:LoaderContext):void
See also
originalSourceHeight | property |
originalSourceHeight:Number
[read-only]
The original height of the source content, in pixels. This value will
be 0
until the source content finishes loading. If the
source is a texture, this value will be 0
until the
ImageLoader
validates.
public function get originalSourceHeight():Number
originalSourceWidth | property |
originalSourceWidth:Number
[read-only]
The original width of the source content, in pixels. This value will
be 0
until the source content finishes loading. If the
source is a texture, this value will be 0
until the
ImageLoader
validates.
public function get originalSourceWidth():Number
scaleFactor | property |
scaleFactor:Number
The scale factor value to pass to Texture.fromBitmapData()
when creating a texture loaded from a URL.
In the following example, the image loader's scale factor is customized:
loader.scaleFactor = 2;
The default value is 1
.
public function get scaleFactor():Number
public function set scaleFactor(value:Number):void
source | property |
source:Object
The Texture
to display, or a URL pointing to an image
file. Supported image files include ATF format and any bitmap formats
that may be loaded by flash.display.Loader
, including
JPG, GIF, and PNG.
In the following example, the image loader's source is set to a texture:
loader.source = Texture.fromBitmap( bitmap );
In the following example, the image loader's source is set to the URL of a PNG image:
loader.source = "http://example.com/example.png";
The default value is null
.
public function get source():Object
public function set source(value:Object):void
See also
style | property |
style:MeshStyle
The style that is used to render the loader's image.
In the following example, the loader uses a custom style:
loader.style = new CustomMeshStyle();
The default value is null
.
public function get style():MeshStyle
public function set style(value:MeshStyle):void
textureCache | property |
textureCache:TextureCache
An optional cache for textures.
In the following example, a cache is provided for textures:
var cache:TextureCache = new TextureCache(30); loader1.textureCache = cache; loader2.textureCache = cache;
Warning: the textures in the cache will not be
disposed automatically. When the cache is no longer needed (such as
when the ImageLoader
components have all been disposed),
you must call the dispose()
method on the
TextureCache
. Failing to do so will result in a serious
memory leak.
The default value is null
.
public function get textureCache():TextureCache
public function set textureCache(value:TextureCache):void
textureFormat | property |
textureFormat:String
The texture format to use when creating a texture loaded from a URL.
In the following example, the image loader's texture format is set to a custom value:
loader.textureFormat = Context3DTextureFormat.BGRA_PACKED;
The default value is flash.display3d.Context3DTextureFormat.BGRA
.
public function get textureFormat():String
public function set textureFormat(value:String):void
See also
textureQueueDuration | property |
textureQueueDuration:Number
If delayTextureCreation
is true
and the
duration is not Number.POSITIVE_INFINITY
, the loader
will be added to a queue where the textures are uploaded to the GPU
in sequence to avoid significantly affecting performance. Useful for
lists where many textures may need to be uploaded during scrolling.
If the duration is Number.POSITIVE_INFINITY
, the
default value, the texture will not be uploaded until
delayTextureCreation
is set to false
. In
this situation, the loader will not be added to the queue, and other
loaders with a duration won't be affected.
In the following example, the image loader's texture creation is delayed by half a second:
loader.delayTextureCreation = true; loader.textureQueueDuration = 0.5;
The default value is Number.POSITIVE_INFINITY
.
public function get textureQueueDuration():Number
public function set textureQueueDuration(value:Number):void
See also
textureScale | property |
textureScale:Number
Scales the texture dimensions during measurement, but does not set
the texture's scale factor. Useful for UI that should scale based on
screen density or resolution without accounting for
contentScaleFactor
.
In the following example, the image loader's texture scale is customized:
loader.textureScale = 0.5;
The default value is 1
.
public function get textureScale():Number
public function set textureScale(value:Number):void
urlLoader | property |
protected var urlLoader:URLLoader
The internal flash.net.URLLoader
used to load raw data
from URLs.
ImageLoader | () | Constructor |
public function ImageLoader()
Constructor.
autoSizeIfNeeded | () | method |
protected function autoSizeIfNeeded():Boolean
If the component's dimensions have not been set explicitly, it will
measure its content and determine an ideal size for itself. If the
explicitWidth
or explicitHeight
member
variables are set, those value will be used without additional
measurement. If one is set, but not the other, the dimension with the
explicit value will not be measured, but the other non-explicit
dimension will still need measurement.
Calls saveMeasurements()
to set up the
actualWidth
and actualHeight
member
variables used for layout.
Meant for internal use, and subclasses may override this function with a custom implementation.
ReturnsBoolean |
complete | Event |
starling.events.Event
starling.events.Event.COMPLETE
Dispatched when the source finishes loading, if the source is a URL. This event is not dispatched when the source is a texture.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
ioError | Event |
starling.events.Event
starling.events.Event.IO_ERROR
Dispatched if an IO error occurs while loading the source content.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | The flash.events.IOErrorEvent
dispatched by the loader. |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
progress | Event |
starling.events.Event
feathers.events.FeathersEventType.PROGRESS
Dispatched periodically as the source loads, if the source is a URL. This event is not dispatched when the source is a texture.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | A value between 0.0 and 1.0 to indicate how much image data has loaded. |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |
FeathersEventType.PROGRESS
event type is used by
Feathers classes with long-running tasks to indicate that progress
has been made, but the task is incomplete.
securityError | Event |
starling.events.Event
starling.events.Event.SECURITY_ERROR
Dispatched if a security error occurs while loading the source content.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | The flash.events.SecurityErrorEvent
dispatched by the loader. |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |