Package | spark.components |
Class | public class Image |
Inheritance | Image SkinnableComponent UIComponent FlexSprite flash.display.Sprite |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
@Embed(source='filename')
.
Note: Flex also includes the SWFLoader control for loading Flex applications. You typically use the Image control for loading static graphic files and SWF files, and use the SWFLoader control for loading Flex applications. The Image control is also designed to be used in custom item renderers and item editors.
Note: Flex also includes the BitmapImage class. This class is used for embedding images into skins and FXG components.
Embedded images load immediately, because they are already part of the Flex SWF file. However, they add to the size of your application and slow down the application initialization process. Embedded images also require you to recompile your applications whenever your image files change.
The alternative to embedding a resource is to load the resource at runtime. You can load a resource from the local file system in which the SWF file runs, or you can access a remote resource, typically though an HTTP request over a network. These images are independent of your Flex application, so you can change them without causing a recompile operation as long as the names of the modified images remain the same. The referenced images add no additional overhead to an application's initial loading time. However, you might experience a delay when you use the images and load them into Flash Player or AIR.
The default skin provides a chromeless image skin with a generic progress bar based preloader and broken image icon to reflect invalid content.
To use this component in a list-based component, such as a List or DataGrid, create an item renderer. For information about creating an item renderer, see Custom Spark item renderers.
The Image control has the following default characteristics:
Characteristic | Description |
---|---|
Default size | Wide enough to hold the associated source content |
Minimum size | 0 pixels wide by 0 pixels high |
Maximum size | 10000 pixels wide and 10000 pixels high |
Default skin class | spark.skins.spark.ImageSkin |
The <s:Image>
tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:Image Properties clearOnLoad="true" contentLoader="null" contentLoaderGrouping="null" fillMode="scale" horizontalAlign="center" preliminaryHeight="NaN" preliminaryWidth="NaN" scaleMode="letterbox" smooth="false" source="null verticalAlign="middle" Styles backgroundAlpha="NaN" backgroundColor="NaN" enableLoadingState="false" smoothingQuality="default" Events complete="No default" httpStatus="No default" ioError="No default" progress="No default" ready="No default" securityError="No default" />
See also
Property | Defined By | ||
---|---|---|---|
accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | ||
automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | ||
automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | ||
automationName : String
Name that can be used as an identifier for this object. | UIComponent | ||
automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | ||
automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | ||
automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | ||
automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | ||
automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | ||
baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
baselinePosition : Number [override] [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | SkinnableComponent | ||
bitmapData : BitmapData [read-only]
Returns a copy of the BitmapData object representing
the currently loaded image content (unscaled). | Image | ||
bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
bytesLoaded : Number [read-only]
The number of bytes of the image already loaded. | Image | ||
bytesTotal : Number [read-only]
The total image data in bytes loaded or pending load. | Image | ||
cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | ||
cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | ||
className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | ||
clearOnLoad : Boolean
Denotes whether or not to clear previous
image content prior to loading new content. | Image | ||
contentLoader : IContentLoader
Optional custom image loader (e.g. | Image | ||
contentLoaderGrouping : String
Optional content grouping identifier to pass to the an
associated IContentLoader instance's load() method. | Image | ||
contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | ||
contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | ||
currentState : String
The current view state of the component. | UIComponent | ||
cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | ||
depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | ||
descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | ||
designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | ||
document : Object
A reference to the document object associated with this UIComponent. | UIComponent | ||
doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | ||
enabled : Boolean
Whether the component can accept user interaction. | UIComponent | ||
errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | ||
explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | ||
explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | ||
explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | ||
explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | ||
explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | ||
explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | ||
fillMode : String
Determines how the bitmap fills in the dimensions. | Image | ||
flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | ||
focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | ||
focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | ||
focusPane : Sprite
The focus pane associated with this object. | UIComponent | ||
hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | ||
hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | ||
height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | ||
horizontalAlign : String
The horizontal alignment of the content when it does not have
a one-to-one aspect ratio and scaleMode is set to
mx.graphics.BitmapScaleMode.LETTERBOX. | Image | ||
horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
id : String
ID of the component. | UIComponent | ||
includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | ||
inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | ||
initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | ||
instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | ||
instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | ||
is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | ||
isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | ||
isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | ||
layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | ||
left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | ||
maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | ||
maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | ||
measuredHeight : Number
The default height of the component, in pixels. | UIComponent | ||
measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | ||
measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | ||
measuredWidth : Number
The default width of the component, in pixels. | UIComponent | ||
minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | ||
minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | ||
moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | ||
mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | ||
MXMLDescriptor : Array [read-only] | UIComponent | ||
MXMLProperties : Array [read-only] | UIComponent | ||
nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | ||
nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | ||
numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | ||
owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | ||
parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | ||
parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | ||
parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | ||
percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | ||
percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | ||
postLayoutTransformOffsets : TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | ||
preliminaryHeight : Number
Provides an estimate to use for height when the "measured" bounds
of the image is requested by layout, but the image data has
yet to complete loading. | Image | ||
preliminaryWidth : Number
Provides an estimate to use for width when the "measured" bounds
of the image is requested by layout, but the image data has
yet to complete loading. | Image | ||
processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | ||
repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | ||
repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | ||
repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | ||
repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | ||
right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
rotation : Number [override] | UIComponent | ||
rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | ||
rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | ||
rotationZ : Number [override]
| UIComponent | ||
scaleMode : String
Determines how the image is scaled when fillMode is set to
mx.graphics.BitmapFillMode.SCALE. | Image | ||
scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | ||
scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | ||
scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | ||
screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | ||
showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | ||
skin : UIComponent [read-only]
The instance of the skin class for this component instance. | SkinnableComponent | ||
smooth : Boolean | Image | ||
source : Object
The source used for the bitmap fill. | Image | ||
sourceHeight : Number [read-only]
Provides the unscaled height of the original image data. | Image | ||
sourceWidth : Number [read-only]
Provides the unscaled width of the original image data. | Image | ||
states : Array
The view states that are defined for this component. | UIComponent | ||
styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | ||
styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | ||
styleName : Object
The class style used by this component. | UIComponent | ||
styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | ||
suggestedFocusSkinExclusions : Array [read-only]
Lists the skin parts that are
excluded from bitmaps captured and used to
show focus. | SkinnableComponent | ||
systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | ||
tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | ||
toolTip : String
Text to display in the ToolTip. | UIComponent | ||
top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
transform : Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | ||
transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | ||
transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | ||
transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | ||
transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | ||
trustedSource : Boolean [read-only]
A read-only flag denoting whether the currently loaded
content is considered loaded form a source whose security
policy allows for cross domain image access. | Image | ||
tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | ||
uid : String
A unique identifier for the object. | UIComponent | ||
updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | ||
validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | ||
verticalAlign : String
The vertical alignment of the content when it does not have
a one-to-one aspect ratio and scaleMode is set to
mx.graphics.BitmapScaleMode.LETTERBOX. | Image | ||
verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | ||
visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | ||
width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | ||
x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | ||
y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | ||
z : Number [override]
| UIComponent |
Method | Defined By | ||
---|---|---|---|
Image()
Constructor. | Image | ||
addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | ||
callLater(method:Function, args:Array = null):void
Queues a function to be called later. | UIComponent | ||
clearStyle(styleProp:String):void
Deletes a style property from this component instance. | UIComponent | ||
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates. | UIComponent | ||
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates. | UIComponent | ||
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | ||
createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs that identify the child within
this container. | UIComponent | ||
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | ||
dispatchEvent(event:Event):Boolean [override]
Dispatches an event into the event flow. | UIComponent | ||
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component. | UIComponent | ||
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | ||
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | ||
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | ||
endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | ||
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | ||
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | ||
generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | ||
generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | ||
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | ||
getAutomationChildren():Array
Provides the automation object list . | UIComponent | ||
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | ||
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | ||
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | ||
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | ||
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | ||
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | ||
getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | ||
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | ||
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | ||
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | ||
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | ||
getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | ||
getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | ||
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | ||
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | ||
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | ||
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | ||
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | ||
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | ||
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | ||
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | ||
getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | ||
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates. | UIComponent | ||
hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | ||
hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | ||
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | ||
initialize():void
Initializes the internal structure of this component. | UIComponent | ||
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | ||
invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | ||
invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | ||
invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | ||
invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | ||
invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | ||
invalidateSkinState():void
Marks the component so that the new state of the skin is set
during a later screen update. | SkinnableComponent | ||
localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | ||
matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | ||
matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | ||
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UIComponent | ||
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | UIComponent | ||
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | ||
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | ||
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. | UIComponent | ||
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | ||
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | ||
removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | ||
replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | ||
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | ||
resumeBackgroundProcessing():void [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | ||
setActualSize(w:Number, h:Number):void
Sizes the object. | UIComponent | ||
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | ||
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | ||
setFocus():void
Sets the focus to this component. | UIComponent | ||
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | ||
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | ||
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
setMXMLDescriptor(value:Array):void | UIComponent | ||
setMXMLProperties(value:Array):void | UIComponent | ||
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | ||
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | ||
styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | ||
stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | ||
suspendBackgroundProcessing():void [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | ||
toString():String [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | ||
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | ||
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | ||
validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | ||
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | ||
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | ||
validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | ||
validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | ||
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | |||
Dispatched when content loading is complete. | Image | |||
Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | |||
Dispatched after the view state has changed. | UIComponent | |||
Dispatched after the currentState property changes, but before the view state changes. | UIComponent | |||
Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | |||
Dispatched by the drop target when the user releases the mouse over it. | UIComponent | |||
Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | |||
Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | |||
Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | |||
Dispatched by the drag initiator when starting a drag operation. | UIComponent | |||
Dispatched after an effect ends. | UIComponent | |||
Dispatched just before an effect starts. | UIComponent | |||
Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | |||
Dispatched after the component has entered a view state. | UIComponent | |||
Dispatched just before the component exits a view state. | UIComponent | |||
Dispatched when an object's state changes from visible to invisible. | UIComponent | |||
Dispatched when a network request is made over HTTP and Flash Player or AIR can detect the HTTP status code. | Image | |||
Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | |||
Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | |||
Dispatched when an input or output error occurs. | Image | |||
Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | |||
Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | |||
Dispatched when the object has moved. | UIComponent | |||
Dispatched at the beginning of the component initialization sequence. | UIComponent | |||
Dispatched when content is loading. | Image | |||
Dispatched when content loading is complete. | Image | |||
Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | |||
Dispatched when the component is resized. | UIComponent | |||
Dispatched when a security error occurs. | Image | |||
Dispatched when an object's state changes from invisible to visible. | UIComponent | |||
Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | |||
Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | |||
Dispatched by the component when it is time to create a ToolTip. | UIComponent | |||
Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | |||
Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | |||
Dispatched by the component when its ToolTip is about to be shown. | UIComponent | |||
Dispatched by the component when its ToolTip has been shown. | UIComponent | |||
Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | |||
A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | |||
A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | |||
A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | |||
Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | |||
Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | |||
Dispatched when values are changed programmatically or by user interaction. | UIComponent |
Style | Description | Defined By | ||
---|---|---|---|---|
backgroundAlpha | Type: Number CSS Inheritance: no Theme: spark, mobile The alpha value of the background for this component. The default value is NaN . | Image | ||
backgroundColor | Type: uint Format: Color CSS Inheritance: no Theme: spark, mobile The background color for this component. The default value is NaN . | Image | ||
Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | |||
Type: String CSS Inheritance: no The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | |||
Type: uint Format: Color CSS Inheritance: yes Theme: spark, mobile The main color for a component. | SkinnableComponent | |||
enableLoadingState | Type: Boolean CSS Inheritance: no When true , enables the loading skin state.
The default value is false . | Image | ||
Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | |||
Type: Class Name of the skin class to use for this component when a validation error occurs. | SkinnableComponent | |||
Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | |||
Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | |||
Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | |||
Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | |||
Type: String CSS Inheritance: yes The primary interaction mode for this component. See also | UIComponent | |||
Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also | UIComponent | |||
Type: String CSS Inheritance: no The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | |||
Type: String CSS Inheritance: no The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | |||
Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent | |||
Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent | |||
Type: Class Name of the skin class to use for this component. | SkinnableComponent | |||
smoothingQuality | Type: String CSS Inheritance: no Style equivalent to BitmapImage's smoothingQuality property.
When set to BitmapSmoothingQuality.BEST , the image is
resampled (if data is from a trusted source) to achieve a higher quality result.
If set to BitmapSmoothingQuality.DEFAULT , the default stage
quality for scaled bitmap fills is used.
The default value is . | Image | ||
Type: String CSS Inheritance: no The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | |||
Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent |
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
Skin Part | Description | Defined By | ||
---|---|---|---|---|
imageDisplay:BitmapImage | Required: true Part Type: Static A required skin part that defines image content. | Image | ||
progressIndicator:Range | Required: false Part Type: Static An optional skin part that displays the current loading progress. As a convenience the progressIndicator value is automatically updated with the percentage complete while loading. | Image |
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
bitmapData | property |
bitmapData:BitmapData
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Returns a copy of the BitmapData object representing
the currently loaded image content (unscaled). This property
is null
for untrusted cross domain content.
The default value is null
.
public function get bitmapData():BitmapData
bytesLoaded | property |
bytesLoaded:Number
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
The number of bytes of the image already loaded. Only relevant for images loaded by request URL.
The default value is NaN
.
public function get bytesLoaded():Number
bytesTotal | property |
bytesTotal:Number
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
The total image data in bytes loaded or pending load. Only relevant for images loaded by request URL.
The default value is NaN
.
public function get bytesTotal():Number
clearOnLoad | property |
clearOnLoad:Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Denotes whether or not to clear previous image content prior to loading new content.
The default value is true
.
public function get clearOnLoad():Boolean
public function set clearOnLoad(value:Boolean):void
contentLoader | property |
contentLoader:IContentLoader
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Optional custom image loader (e.g. image cache or queue) to associate with content loader client.
The default value is null
.
public function get contentLoader():IContentLoader
public function set contentLoader(value:IContentLoader):void
contentLoaderGrouping | property |
contentLoaderGrouping:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Optional content grouping identifier to pass to the an associated IContentLoader instance's load() method. This property is only considered when a valid contentLoader is assigned.
The default value is null
.
public function get contentLoaderGrouping():String
public function set contentLoaderGrouping(value:String):void
fillMode | property |
fillMode:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Determines how the bitmap fills in the dimensions. If you set the value
of this property in a tag, use the string (such as "repeat"). If you set the value of
this property in ActionScript, use the constant (such as mx.graphics.BitmapFillMode.CLIP
).
When set to BitmapFillMode.CLIP
("clip"), the bitmap
ends at the edge of the region.
When set to BitmapFillMode.REPEAT
("repeat"), the bitmap
repeats to fill the region.
When set to BitmapFillMode.SCALE
("scale"), the bitmap
stretches to fill the region.
The default value is
.BitmapFillMode.SCALE
public function get fillMode():String
public function set fillMode(value:String):void
See also
horizontalAlign | property |
horizontalAlign:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
The horizontal alignment of the content when it does not have
a one-to-one aspect ratio and scaleMode
is set to
mx.graphics.BitmapScaleMode.LETTERBOX
.
Can be one of HorizontalAlign.LEFT
("left"),
HorizontalAlign.RIGHT
("right"), or
HorizontalAlign.CENTER
("center").
This property is only applicable when fillMode
is set to
to mx.graphics.BitmapFillMode.SCALE
("scale").
The default value is
.HorizontalAlign.CENTER
public function get horizontalAlign():String
public function set horizontalAlign(value:String):void
preliminaryHeight | property |
preliminaryHeight:Number
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Provides an estimate to use for height when the "measured" bounds of the image is requested by layout, but the image data has yet to complete loading. When NaN the measured height is 0 until the image has finished loading.
The default value is NaN
.
public function get preliminaryHeight():Number
public function set preliminaryHeight(value:Number):void
preliminaryWidth | property |
preliminaryWidth:Number
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Provides an estimate to use for width when the "measured" bounds of the image is requested by layout, but the image data has yet to complete loading. When NaN the measured width is 0 until the image has finished loading.
The default value is NaN
.
public function get preliminaryWidth():Number
public function set preliminaryWidth(value:Number):void
scaleMode | property |
scaleMode:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Determines how the image is scaled when fillMode
is set to
mx.graphics.BitmapFillMode.SCALE
.
When set to mx.graphics.BitmapScaleMode.STRETCH
("stretch"),
the image is stretched to fit.
When set to BitmapScaleMode.LETTERBOX
("letterbox"),
the image is scaled with respect to the original unscaled image's
aspect ratio.
When set to BitmapScaleMode.ZOOM
("zoom"),
the image is scaled to fit with respect to the original unscaled image's
aspect ratio. This results in cropping on one axis.
The default value is
.BitmapScaleMode.LETTERBOX
public function get scaleMode():String
public function set scaleMode(value:String):void
See also
smooth | property |
smooth:Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
The default value is false
.
public function get smooth():Boolean
public function set smooth(value:Boolean):void
source | property |
source:Object
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
The source used for the bitmap fill. The fill can render from various graphical sources, including the following:
If you use an image file for the source, it can be of type PNG, GIF, or JPG.
To specify an embedded image source, you can use the @Embed directive, as the following example shows:
source="@Embed('<i>image_location</i>')"
The image location can be specified via a URL, URLRequest, or file reference. If it is a file reference, its location is relative to the location of the file that is being compiled.
The BitmapImage class is designed to work with embedded images or images that are loaded at run time.
If the source is a Bitmap or BitmapData instance or is an external image file, it is the responsibility of the caller to dispose of the source once it is no longer needed. If ImageLoader created the BitmapData instance, then it will dispose of the BitmapData once the source has changed.
public function get source():Object
public function set source(value:Object):void
sourceHeight | property |
sourceHeight:Number
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Provides the unscaled height of the original image data.
The default value is NaN
.
public function get sourceHeight():Number
sourceWidth | property |
sourceWidth:Number
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Provides the unscaled width of the original image data.
The default value is NaN
.
public function get sourceWidth():Number
trustedSource | property |
trustedSource:Boolean
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
A read-only flag denoting whether the currently loaded
content is considered loaded form a source whose security
policy allows for cross domain image access.
When false
, advanced bitmap operations such as high quality scaling,
and tiling are not permitted. This flag is set once an
image has been fully loaded.
The default value is true
.
public function get trustedSource():Boolean
verticalAlign | property |
verticalAlign:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
The vertical alignment of the content when it does not have
a one-to-one aspect ratio and scaleMode is set to
mx.graphics.BitmapScaleMode.LETTERBOX
.
Can be one of VerticalAlign.TOP
("top"),
VerticalAlign.BOTTOM
("bottom"), or
VerticalAlign.MIDDLE
("middle").
This property is only applicable when scaleMode is set to
to BitmapFillMode.SCALE
("scale").
The default value is
.HorizontalAlign.MIDDLE
public function get verticalAlign():String
public function set verticalAlign(value:String):void
Image | () | Constructor |
public function Image()
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Constructor.
complete | Event |
flash.events.Event
flash.events.Event.COMPLETE
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Dispatched when content loading is complete. This event is only dispatched for url and ByteArray based sources (those sources requiring a Loader).
Note that for content loaded by Loader, both
ready
and complete
events
are dispatched.
ready
is dispatched.
httpStatus | Event |
flash.events.HTTPStatusEvent
flash.events.HTTPStatusEvent.HTTP_STATUS
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Dispatched when a network request is made over HTTP and Flash Player or AIR can detect the HTTP status code.
ioError | Event |
flash.events.IOErrorEvent
flash.events.IOErrorEvent.IO_ERROR
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Dispatched when an input or output error occurs.
See also
progress | Event |
flash.events.ProgressEvent
flash.events.ProgressEvent.PROGRESS
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Dispatched when content is loading.
Note:
The progress
event is not guaranteed to be dispatched.
The complete
event may be received, without any
progress
events being dispatched.
This can happen when the loaded content is a local file.
ready | Event |
mx.events.FlexEvent
mx.events.FlexEvent.READY
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Dispatched when content loading is complete. Unlike the
complete
event, this event is dispatched for
all source types.
Note that for content loaded via Loader, both
ready
and complete
events
are dispatched.
ready
is dispatched.
The FlexEvent.READY
constant defines the value of the
type
property of the event object for a ready
event. This event is dispatched by the BitmapImage and spark Image
classes to denote that the assigned image source has fully loaded.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
returnValue | null |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myImage.addEventListener() to register an event listener,
myImage is the value of the currentTarget . |
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. |
Type | FlexEvent.READY |
securityError | Event |
flash.events.SecurityErrorEvent
flash.events.SecurityErrorEvent.SECURITY_ERROR
Language Version : | ActionScript 3.0 |
Product Version : | Flex 4.5 |
Runtime Versions : | Flash Player 10, AIR 2.5 |
Dispatched when a security error occurs.
See also