Package | feathers.controls |
Class | public class ImageLoader |
Inheritance | ImageLoader ![]() ![]() |
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 | ||
---|---|---|---|
color : uint
The tint value to use on the internal Image. | ImageLoader | ||
![]() | 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 | |
errorTexture : Texture
A texture to display when a URL source cannot be loaded for any
reason. | ImageLoader | ||
![]() | focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be
displayed above the component when showFocus() is
called. | FeathersControl | |
![]() | focusManager : IFocusManager | FeathersControl | |
![]() | focusOwner : IFocusDisplayObject | FeathersControl | |
![]() | focusPadding : Number
Quickly sets all focus padding properties to the same value. | FeathersControl | |
![]() | focusPaddingBottom : Number
The minimum space, in pixels, between the object's bottom edge and the
bottom edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingLeft : Number
The minimum space, in pixels, between the object's left edge and the
left edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingRight : Number
The minimum space, in pixels, between the object's right edge and the
right edge of the focus indicator skin. | FeathersControl | |
![]() | focusPaddingTop : Number
The minimum space, in pixels, between the object's top edge and the
top edge of the focus indicator skin. | FeathersControl | |
globalStyleProvider : IStyleProvider [static]
The default IStyleProvider for all ImageLoader
components. | ImageLoader | ||
![]() | height : Number [override]
The height of the component, in pixels. | FeathersControl | |
horizontalAlign : 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. | ImageLoader | ||
![]() | includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
![]() | 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 | 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 | |
![]() | layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
loadingTexture : Texture
A texture to display while a URL source is loading. | ImageLoader | ||
maintainAspectRatio : 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. | ImageLoader | ||
![]() | 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 | |
![]() | nextTabFocus : IFocusDisplayObject | FeathersControl | |
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 | ||
padding : Number
Quickly sets all padding properties to the same value. | ImageLoader | ||
paddingBottom : Number
The minimum space, in pixels, between the control's bottom edge and the
control's content. | ImageLoader | ||
paddingLeft : Number
The minimum space, in pixels, between the control's left edge and the
control's content. | ImageLoader | ||
paddingRight : Number
The minimum space, in pixels, between the control's right edge and the
control's content. | ImageLoader | ||
paddingTop : Number
The minimum space, in pixels, between the control's top edge and the
control's content. | ImageLoader | ||
![]() | previousTabFocus : IFocusDisplayObject | FeathersControl | |
scaleContent : Boolean
Determines if the content will be scaled if the dimensions of the
ImageLoader are changed. | ImageLoader | ||
scaleMode : String
Determines how the texture is scaled if scaleContent and
maintainAspectRatio are both set to true. | ImageLoader | ||
smoothing : String
The smoothing value to use on the internal Image. | ImageLoader | ||
snapToPixels : Boolean
Determines if the image should be snapped to the nearest global whole
pixel when rendered. | ImageLoader | ||
source : Object
The Texture to display, or a URL pointing to an image
file. | 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 | |
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. | ImageLoader | ||
verticalAlign : 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. | ImageLoader | ||
![]() | width : Number [override]
The width of the component, in pixels. | FeathersControl |
Property | Defined By | ||
---|---|---|---|
![]() | actualHeight : Number = 0
The final height 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
globalStyleProvider property is set to this value. | FeathersControl | |
![]() | explicitHeight : Number = NaN
The height value explicitly set by calling the height setter or
setSize(). | FeathersControl | |
![]() | explicitWidth : Number = NaN
The width value explicitly set by calling the width setter or
setSize(). | 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 | ||
![]() | hideFocus():void
If the visual indicator of focus has been displayed by
showFocus(), call this function to hide it. | 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 | |
![]() | move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single
function call. | FeathersControl | |
![]() | setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single
function call. | FeathersControl | |
![]() | showFocus():void
If the object has focus, an additional visual indicator may
optionally be displayed to highlight the object. | FeathersControl | |
![]() | 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 | |
![]() | 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 | |
![]() | refreshFocusIndicator():void
Updates the focus indicator skin by showing or hiding it and
adjusting its position and dimensions. | 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 the source finishes loading, if the source is a URL. | ImageLoader | |||
![]() | Dispatched after the component has validated for the first time. | FeathersControl | ||
DEPRECATED: Replaced by Event.IO_ERROR and Event.SECURITY_ERROR. | ImageLoader | |||
![]() | 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 periodically as the source loads, if the source is a URL. | ImageLoader | |||
![]() | Dispatched when the width or height of the control changes. | FeathersControl | ||
Dispatched if a security error occurs while loading the source content. | ImageLoader |
Constant | Defined By | ||
---|---|---|---|
HORIZONTAL_ALIGN_CENTER : String = center [static]
The content will be aligned horizontally to the center of the
ImageLoader. | ImageLoader | ||
HORIZONTAL_ALIGN_LEFT : String = left [static]
The content will be aligned horizontally to the left edge of the
ImageLoader. | ImageLoader | ||
HORIZONTAL_ALIGN_RIGHT : String = right [static]
The content will be aligned horizontally to the right edge of the
ImageLoader. | ImageLoader | ||
![]() | INVALIDATION_FLAG_ALL : String = all [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | |
![]() | INVALIDATION_FLAG_DATA : String = data [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_FOCUS : String = focus [static]
Invalidation flag to indicate that the focus of the UI control has
changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_LAYOUT : String = layout [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SCROLL : String = scroll [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SELECTED : String = selected [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SIZE : String = size [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_SKIN : String = skin [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_STATE : String = state [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | |
![]() | INVALIDATION_FLAG_STYLES : String = styles [static]
Invalidation flag to indicate that the styles or visual appearance of
the UI control has changed. | FeathersControl | |
VERTICAL_ALIGN_BOTTOM : String = bottom [static]
The content will be aligned vertically to the bottom edge of the
ImageLoader. | ImageLoader | ||
VERTICAL_ALIGN_MIDDLE : String = middle [static]
The content will be aligned vertically to the middle of the
ImageLoader. | ImageLoader | ||
VERTICAL_ALIGN_TOP : String = top [static]
The content will be aligned vertically to the top edge of the
ImageLoader. | ImageLoader |
color | property |
color:uint
The tint value to use on the internal Image
.
In the following example, the image loader's texture color is customized:
loader.color = 0xff00ff;
The default value is 0xffffff
.
public function get color():uint
public function set color(value:uint):void
See also
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
errorTexture | property |
errorTexture: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
.
public function get errorTexture():Texture
public function set errorTexture(value:Texture):void
See also
globalStyleProvider | property |
public static var globalStyleProvider:IStyleProvider
The default IStyleProvider
for all ImageLoader
components.
The default value is null
.
See also
horizontalAlign | property |
horizontalAlign: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 scaleContent
property is set to
true
, the horizontalAlign
property is
ignored.
The following example aligns the content to the right:
loader.horizontalAlign = ImageLoader.HORIZONTAL_ALIGN_RIGHT;
The default value is ImageLoader.HORIZONTAL_ALIGN_LEFT
.
public function get horizontalAlign():String
public function set horizontalAlign(value:String):void
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.
loadingTexture | property |
loadingTexture: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
.
public function get loadingTexture():Texture
public function set loadingTexture(value:Texture):void
See also
maintainAspectRatio | property |
maintainAspectRatio: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 scaleContent
property is set to
false
, the maintainAspectRatio
property is
ignored.
In the following example, the image loader's aspect ratio is not maintained:
loader.maintainAspectRatio = false;
The default value is true
.
public function get maintainAspectRatio():Boolean
public function set maintainAspectRatio(value:Boolean):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
padding | property |
padding: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
.
public function get padding():Number
public function set padding(value:Number):void
See also
paddingBottom | property |
paddingBottom: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
.
public function get paddingBottom():Number
public function set paddingBottom(value:Number):void
paddingLeft | property |
paddingLeft: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
.
public function get paddingLeft():Number
public function set paddingLeft(value:Number):void
paddingRight | property |
paddingRight: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
.
public function get paddingRight():Number
public function set paddingRight(value:Number):void
paddingTop | property |
paddingTop: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
.
public function get paddingTop():Number
public function set paddingTop(value:Number):void
scaleContent | property |
scaleContent: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
.
public function get scaleContent():Boolean
public function set scaleContent(value:Boolean):void
See also
scaleMode | property |
scaleMode: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 scaleContent
property is set to
false
, or the maintainAspectRatio
property
is set to false, the scaleMode
property is ignored.
In the following example, the image loader's aspect ratio is not maintained:
loader.scaleMode = ScaleMode.NO_BORDER;
The default value is starling.utils.ScaleMode.SHOW_ALL
.
public function get scaleMode():String
public function set scaleMode(value:String):void
See also
smoothing | property |
smoothing:String
The smoothing value to use on the internal Image
.
In the following example, the image loader's smoothing is set to a custom value:
loader.smoothing = TextureSmoothing.NONE;
The default value is starling.textures.TextureSmoothing.BILINEAR
.
public function get smoothing():String
public function set smoothing(value:String):void
See also
snapToPixels | property |
snapToPixels:Boolean
Determines if the image should be snapped to the nearest global whole pixel when rendered. Turning this on helps to avoid blurring.
In the following example, the image loader's position is snapped to pixels:
loader.snapToPixels = true;
The default value is false
.
public function get snapToPixels():Boolean
public function set snapToPixels(value:Boolean):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
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. Useful for UI that should scale based on screen density or resolution.
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.
verticalAlign | property |
verticalAlign: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 scaleContent
property is set to
true
, the verticalAlign
property is
ignored.
The following example aligns the content to the bottom:
loader.verticalAlign = ImageLoader.VERTICAL_ALIGN_BOTTOM;
The default value is ImageLoader.VERTICAL_ALIGN_TOP
.
public function get verticalAlign():String
public function set verticalAlign(value:String):void
See also
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 setSizeInternal()
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. |
error | Event |
starling.events.Event
feathers.events.FeathersEventType.ERROR
DEPRECATED: Replaced by Event.IO_ERROR
and
Event.SECURITY_ERROR
.
DEPRECATION WARNING: This event is deprecated starting with Feathers 2.2. It will be removed in a future version of Feathers according to the standard Feathers deprecation policy.
TheFeathersEventType.ERROR
event type is used by
Feathers controls when an error occurs that can be caught and
safely ignored.
See also
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. |
HORIZONTAL_ALIGN_CENTER | Constant |
public static const HORIZONTAL_ALIGN_CENTER:String = center
The content will be aligned horizontally to the center of the
ImageLoader
.
See also
HORIZONTAL_ALIGN_LEFT | Constant |
public static const HORIZONTAL_ALIGN_LEFT:String = left
The content will be aligned horizontally to the left edge of the
ImageLoader
.
See also
HORIZONTAL_ALIGN_RIGHT | Constant |
public static const HORIZONTAL_ALIGN_RIGHT:String = right
The content will be aligned horizontally to the right edge of the
ImageLoader
.
See also
VERTICAL_ALIGN_BOTTOM | Constant |
public static const VERTICAL_ALIGN_BOTTOM:String = bottom
The content will be aligned vertically to the bottom edge of the
ImageLoader
.
See also
VERTICAL_ALIGN_MIDDLE | Constant |
public static const VERTICAL_ALIGN_MIDDLE:String = middle
The content will be aligned vertically to the middle of the
ImageLoader
.
See also
VERTICAL_ALIGN_TOP | Constant |
public static const VERTICAL_ALIGN_TOP:String = top
The content will be aligned vertically to the top edge of the
ImageLoader
.
See also