Packagespark.primitives
Classpublic class BitmapImage
InheritanceBitmapImage Inheritance GraphicElement Inheritance flash.events.EventDispatcher

Language Version : ActionScript 3.0
Product Version : Flex 4.0
Runtime Versions : Flash Player 10, AIR 2.0

A BitmapImage element defines a rectangular region in its parent element's coordinate space, filled with bitmap data drawn from a source file or source URL.



Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The level of transparency of the graphic element.
GraphicElement
 InheritedalwaysCreateDisplayObject : Boolean
Specifies that this GraphicElement is to be associated with and be rendered to its own DisplayObject.
GraphicElement
 Inheritedbaseline : Object
The vertical distance in pixels from the anchor target to the control's baseline position.
GraphicElement
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
GraphicElement
  bitmapData : BitmapData
[read-only] Returns a copy of the BitmapData object representing the currently loaded image content (unscaled).
BitmapImage
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
GraphicElement
 Inheritedbottom : Object
The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.
GraphicElement
  bytesLoaded : Number
[read-only] The number of bytes of the image already loaded.
BitmapImage
  bytesTotal : Number
[read-only] The total image data in bytes loaded or pending load.
BitmapImage
  clearOnLoad : Boolean
Denotes whether or not to clear previous image content prior to loading new content.
BitmapImage
  contentLoader : IContentLoader
Optional custom image loader (e.g.
BitmapImage
  contentLoaderGrouping : String
Optional content grouping identifier to pass to the an associated IContentLoader instance's load() method.
BitmapImage
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
GraphicElement
 InheriteddesignLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
GraphicElement
 InheriteddisplayObject : DisplayObject
[read-only] The shared DisplayObject where this IGraphicElement is drawn.
GraphicElement
 InheriteddisplayObjectSharingMode : String
Indicates the association between this IGraphicElement and its display objects.
GraphicElement
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
GraphicElement
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
GraphicElement
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
GraphicElement
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
GraphicElement
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
GraphicElement
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
GraphicElement
  fillMode : String
Determines how the bitmap fills in the dimensions.
BitmapImage
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the graphic element.
GraphicElement
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contains true if the element has 3D Matrix.
GraphicElement
 Inheritedheight : Number
The height of the graphic element.
GraphicElement
  horizontalAlign : String
The horizontal alignment of the content when it does not have a one-to-one aspect ratio and scaleMode is set to BitmapScaleMode.LETTERBOX.
BitmapImage
 InheritedhorizontalCenter : Object
The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.
GraphicElement
 Inheritedid : String
The identity of the component.
GraphicElement
 InheritedincludeInLayout : Boolean
Specifies whether this element is included in the layout of the parent.
GraphicElement
 Inheritedis3D : Boolean
[read-only] Contains true when the element is in 3D.
GraphicElement
 InheritedlayoutDirection : String
Specifies the desired layout direction for an element: one of LayoutDirection.LTR (left to right), LayoutDirection.RTL (right to left), or null (inherit).
GraphicElement
 Inheritedleft : Object
The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.
GraphicElement
 InheritedluminosityClip : Boolean
A property that controls whether the luminosity mask clips the masked content.
GraphicElement
 InheritedluminosityInvert : Boolean
A property that controls the calculation of the RGB color value of a graphic element being masked by a luminosity mask.
GraphicElement
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
GraphicElement
 InheritedmaskType : String
Defines how the mask is applied to the GraphicElement. The possible values are MaskType.CLIP, MaskType.ALPHA, and MaskType.LUMINOSITY. Clip Masking When masking in clip mode, a clipping masks is reduced to 1-bit.
GraphicElement
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
GraphicElement
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
GraphicElement
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
GraphicElement
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
GraphicElement
 InheritedmeasuredX : Number
The default measured bounds top-left corner relative to the origin of the element.
GraphicElement
 InheritedmeasuredY : Number
The default measured bounds top-left corner relative to the origin of the element.
GraphicElement
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
GraphicElement
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
GraphicElement
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
GraphicElement
 Inheritedparent : DisplayObjectContainer
[read-only] The parent container or component for this component.
GraphicElement
 InheritedpercentHeight : Number
Specifies the height of a component as a percentage of its parent's size.
GraphicElement
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
GraphicElement
 InheritedpostLayoutTransformOffsets : 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.
GraphicElement
  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.
BitmapImage
  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.
BitmapImage
 Inheritedright : Object
The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.
GraphicElement
 Inheritedrotation : Number
Indicates the rotation of the element, in degrees, from the transform point.
GraphicElement
 InheritedrotationX : Number
Indicates the x-axis rotation of the element instance, in degrees, from its original orientation relative to the 3D parent container.
GraphicElement
 InheritedrotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
GraphicElement
 InheritedrotationZ : Number
Indicates the rotation of the element, in degrees, from the transform point.
GraphicElement
  scaleMode : String
Determines how the image is scaled when fillMode is set to BitmapFillMode.SCALE.
BitmapImage
 InheritedscaleX : Number
The horizontal scale (percentage) of the element as applied from the transform point.
GraphicElement
 InheritedscaleY : Number
The vertical scale (percentage) of the element as applied from the transform point.
GraphicElement
 InheritedscaleZ : Number
The z scale (percentage) of the element as applied from the transform point.
GraphicElement
  smooth : Boolean
BitmapImage
  smoothingQuality : String
Determines how the image is down-scaled.
BitmapImage
  source : Object
The source used for the bitmap fill.
BitmapImage
  sourceHeight : Number
[read-only] Provides the unscaled height of the original image data.
BitmapImage
  sourceWidth : Number
[read-only] Provides the unscaled width of the original image data.
BitmapImage
 Inheritedtop : Object
The vertical distance in pixels from the top edge of the component to the anchor target's top edge.
GraphicElement
 Inheritedtransform : Transform
GraphicElement
 InheritedtransformX : Number
The x position transform point of the element.
GraphicElement
 InheritedtransformY : Number
The y position transform point of the element.
GraphicElement
 InheritedtransformZ : Number
The z position transform point of the element.
GraphicElement
  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.
BitmapImage
  verticalAlign : String
The vertical alignment of the content when it does not have a one-to-one aspect ratio and scaleMode is set to BitmapScaleMode.LETTERBOX.
BitmapImage
 InheritedverticalCenter : Object
The vertical distance in pixels from the center of the component to the center of the anchor target's content area.
GraphicElement
 Inheritedvisible : Boolean
Controls the visibility of this visual element.
GraphicElement
 Inheritedwidth : Number
The width of the graphic element.
GraphicElement
 Inheritedx : Number
The x position of the graphic element.
GraphicElement
 Inheritedy : Number
The y position of the graphic element.
GraphicElement
 Inheritedz : Number
The z position of the graphic element.
GraphicElement
Protected Properties
 PropertyDefined By
 InheriteddrawnDisplayObject : DisplayObject
[read-only] The actual DisplayObject that is drawn into by the GraphicElement.
GraphicElement
 InheriteddrawX : Number
[read-only] The x position where the element should be drawn.
GraphicElement
 InheriteddrawY : Number
[read-only] The y position where the element should be drawn.
GraphicElement
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the GraphicElement has any non-translation (x,y) transform properties
GraphicElement
 InheritedlayoutFeatures : AdvancedLayoutFeatures
Contain all of the implementation details of how the GraphicElement implements transform and layering support.
GraphicElement
 InheritedneedsDisplayObject : Boolean
[read-only] True if the element requires an exclusive DisplayObject.
GraphicElement
Public Methods
 MethodDefined By
  
Constructor.
BitmapImage
 Inherited
Returns true if this IGraphicElement is compatible and can share display objects with the next IGraphicElement in the sequence.
GraphicElement
 Inherited
Returns true if this IGraphicElement is compatible and can share display objects with the previous IGraphicElement in the sequence.
GraphicElement
 Inherited
createDisplayObject():DisplayObject
Creates a new DisplayObject where this IGraphicElement is drawn.
GraphicElement
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
GraphicElement
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
GraphicElement
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
GraphicElement
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
GraphicElement
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
GraphicElement
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
GraphicElement
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
GraphicElement
 Inherited
Returns the layout transform Matrix3D for this element.
GraphicElement
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
GraphicElement
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
GraphicElement
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
GraphicElement
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
GraphicElement
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
GraphicElement
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
GraphicElement
 Inherited
initialized(document:Object, id:String):void
Called automatically by the MXML compiler when the GraphicElement is created using an MXML tag.
GraphicElement
 Inherited
Calling this method results in a call to the elements's validateDisplayList() method before the display list is rendered.
GraphicElement
 Inherited
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
GraphicElement
 Inherited
Calling this method results in a call to the elements's validateProperties() method before the display list is rendered.
GraphicElement
 Inherited
Calling this method results in a call to the elements's validateSize() method before the display list is rendered.
GraphicElement
 Inherited
localToGlobal(point:Point):Point
Converts the point object from the object's (local) coordinates to the Stage (global) coordinates.
GraphicElement
 Inherited
Called by IGraphicElementContainer when an IGraphicElement is added to or removed from the host component.
GraphicElement
 Inherited
setLayoutBoundsPosition(newBoundsX:Number, newBoundsY:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
GraphicElement
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
GraphicElement
 Inherited
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.
GraphicElement
 Inherited
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.
GraphicElement
 Inherited
setSharedDisplayObject(sharedDisplayObject:DisplayObject):Boolean
Determines whether this element can draw itself to the sharedDisplayObject of the sequence.
GraphicElement
 Inherited
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.
GraphicElement
 Inherited
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.
GraphicElement
 Inherited
Called by the IGraphicElementContainer to redraw this element in its displayObject property.
GraphicElement
 Inherited
Validates and updates the properties and layout of this object by immediately calling validateProperties(), validateSize(), and validateDisplayList(), if necessary.
GraphicElement
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
GraphicElement
 Inherited
Called by the IGraphicElementContainer to validate the size of this element.
GraphicElement
Protected Methods
 MethodDefined By
 Inherited
Determines if the call to the measure() method can be skipped.
GraphicElement
  
[override] Processes the properties set on the element.
BitmapImage
 Inherited
getStrokeExtents(postLayoutTransform:Boolean = true):Rectangle
Returns the amount of pixels occupied by the stroke on each side of the element's bounds.
GraphicElement
 Inherited
Utility method that notifies the host that this element has changed and needs its layer to be updated.
GraphicElement
 Inherited
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
GraphicElement
  
measure():void
[override] Calculates the default size of the element.
BitmapImage
 Inherited
Used for the implementation of the ILayoutElement interface, returns the explicit measured height pre-transform.
GraphicElement
 Inherited
Used for the implementation of the ILayoutElement interface, returns the explicit of measured width pre-transform.
GraphicElement
 Inherited
transformHeightForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Transform the element's size.
GraphicElement
 Inherited
transformWidthForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Transform the element's size.
GraphicElement
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override] Draws the element and/or sizes and positions its content.
BitmapImage
Events
 Event Summary Defined By
  Dispatched when content loading is complete.BitmapImage
  Dispatched when a network request is made over HTTP and Flash Player or AIR can detect the HTTP status code.BitmapImage
  Dispatched when an input/output error occurs.BitmapImage
  Dispatched when content is loading.BitmapImage
  Dispatched when content loading is complete.BitmapImage
  Dispatched when a security error occurs.BitmapImage
Property Detail
bitmapDataproperty
bitmapData:BitmapData  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.0

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.


Implementation
    public function get bitmapData():BitmapData
bytesLoadedproperty 
bytesLoaded:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.0

The number of bytes of the image already loaded. Only relevant for images loaded by request URL.

The default value is NaN.


Implementation
    public function get bytesLoaded():Number
bytesTotalproperty 
bytesTotal:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.0

The total image data in bytes loaded or pending load. Only relevant for images loaded by request URL.

The default value is NaN.


Implementation
    public function get bytesTotal():Number
clearOnLoadproperty 
clearOnLoad:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.0

Denotes whether or not to clear previous image content prior to loading new content.

The default value is true.


Implementation
    public function get clearOnLoad():Boolean
    public function set clearOnLoad(value:Boolean):void
contentLoaderproperty 
contentLoader:IContentLoader

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 1.5

Optional custom image loader (e.g. image cache or queue) to associate with content loader client.

The default value is null.


Implementation
    public function get contentLoader():IContentLoader
    public function set contentLoader(value:IContentLoader):void
contentLoaderGroupingproperty 
contentLoaderGrouping:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 1.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.


Implementation
    public function get contentLoaderGrouping():String
    public function set contentLoaderGrouping(value:String):void
fillModeproperty 
fillMode:String

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.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 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.


Implementation
    public function get fillMode():String
    public function set fillMode(value:String):void
horizontalAlignproperty 
horizontalAlign:String

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The horizontal alignment of the content when it does not have a one-to-one aspect ratio and scaleMode is set to 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 BitmapFillMode.SCALE ("scale").

The default value is HorizontalAlign.CENTER.


Implementation
    public function get horizontalAlign():String
    public function set horizontalAlign(value:String):void
preliminaryHeightproperty 
preliminaryHeight:Number

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 1.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.


Implementation
    public function get preliminaryHeight():Number
    public function set preliminaryHeight(value:Number):void
preliminaryWidthproperty 
preliminaryWidth:Number

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 1.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.


Implementation
    public function get preliminaryWidth():Number
    public function set preliminaryWidth(value:Number):void
scaleModeproperty 
scaleMode:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.0

Determines how the image is scaled when fillMode is set to BitmapFillMode.SCALE.

When set to 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.

The default value is BitmapScaleMode.STRETCH.


Implementation
    public function get scaleMode():String
    public function set scaleMode(value:String):void
smoothproperty 
smooth:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The default value is false.


Implementation
    public function get smooth():Boolean
    public function set smooth(value:Boolean):void
smoothingQualityproperty 
smoothingQuality:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 1.5

Determines how the image is down-scaled. 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 BitmapSmoothingQuality.DEFAULT.


Implementation
    public function get smoothingQuality():String
    public function set smoothingQuality(value:String):void
sourceproperty 
source:Object

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.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.

This property can be used as the source for data binding.


Implementation
    public function get source():Object
    public function set source(value:Object):void

See also

flash.display.Bitmap
flash.display.BitmapData
mx.graphics.BitmapFill
sourceHeightproperty 
sourceHeight:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 1.5

Provides the unscaled height of the original image data.

The default value is NaN.


Implementation
    public function get sourceHeight():Number
sourceWidthproperty 
sourceWidth:Number  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 1.5

Provides the unscaled width of the original image data.

The default value is NaN.


Implementation
    public function get sourceWidth():Number
trustedSourceproperty 
trustedSource:Boolean  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 9, AIR 1.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.


Implementation
    public function get trustedSource():Boolean
verticalAlignproperty 
verticalAlign:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 1.5

The vertical alignment of the content when it does not have a one-to-one aspect ratio and scaleMode is set to 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 VerticalAlign.MIDDLE.


Implementation
    public function get verticalAlign():String
    public function set verticalAlign(value:String):void
Constructor Detail
BitmapImage()Constructor
public function BitmapImage()

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Constructor.

Method Detail
commitProperties()method
override protected function commitProperties():void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Processes the properties set on the element. This is an advanced method that you might override when creating a subclass.

You do not call this method directly. Flex calls the commitProperties() method when you use the addElement() method to add an element to an IGraphicElementContainer container such as Group, or when you call the invalidateProperties() method of the element. Calls to the commitProperties() method occur before calls to the measure() method. This lets you set property values that might be used by the measure() method.

Some elements have properties that interact with each other. It is often best at startup time to process all of these properties at one time to avoid duplicating work.

measure()method 
override protected function measure():void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Calculates the default size of the element. This is an advanced method that you might override when creating a subclass of GraphicElement.

You do not call this method directly. Flex calls the measure() method when the element is added to an IGraphicElementContainer container such as Group using the addElement() method, and when the element's invalidateSize() method is called.

By default you set both explicit height and explicit width of an element, Flex does not call the measure() method, even if you explicitly call the invalidateSize() method. To override this behavior, override skipMeasure() method.

In your override of this method, you must set the measuredWidth and measuredHeight properties to define the default size. You can optionally set the measuredX and measuredY properties to define the default measured bounds top-left corner relative to the origin of the element.

The conceptual point of measure() is for the element to provide its own natural or intrinsic bounds as a default. Therefore, the measuredWidth and measuredHeight properties should be determined by factors such as:

In some cases, there is no intrinsic way to determine default values. For example, a simple GreenCircle element might simply set measuredWidth = 100 and measuredHeight = 100 in its measure() method to provide a reasonable default size. In other cases, such as a TextArea, an appropriate computation (such as finding the right width and height that would just display all the text and have the aspect ratio of a Golden Rectangle) might be too time-consuming to be worthwhile.

The default implementation of measure() sets the values of the measuredWidth, measuredHeight, measuredX, and measuredY properties to 0.

updateDisplayList()method 
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Draws the element and/or sizes and positions its content. This is an advanced method that you might override when creating a subclass of GraphicElement.

You do not call this method directly. Flex calls the updateDisplayList() method when the component is added to an IGraphicElementContainer container such as Group using the addElement() method, and when the element's invalidateDisplayList() method is called.

This method is where you would do programmatic drawing using methods on the elements's displayObject such as graphics.drawRect().

Parameters

unscaledWidth:Number — Specifies the width of the component, in pixels, in the component's coordinates, regardless of the value of the scaleX property of the component.
 
unscaledHeight:Number — Specifies the height of the component, in pixels, in the component's coordinates, regardless of the value of the scaleY property of the component.

Event Detail
complete Event
Event Object Type: flash.events.Event
Event.type property = flash.events.Event.COMPLETE

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.0

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 via Loader, both ready and complete events are dispatched.

For other source types such as embeds, only ready is dispatched.

httpStatus Event  
Event Object Type: flash.events.HTTPStatusEvent
HTTPStatusEvent.type property = flash.events.HTTPStatusEvent.HTTP_STATUS

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.0

Dispatched when a network request is made over HTTP and Flash Player or AIR can detect the HTTP status code.

ioError Event  
Event Object Type: flash.events.IOErrorEvent
IOErrorEvent.type property = flash.events.IOErrorEvent.IO_ERROR

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.0

Dispatched when an input/output error occurs.

See also

flash.events.IOErrorEvent
progress Event  
Event Object Type: flash.events.ProgressEvent
ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.0

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  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.READY

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.0

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.

For other source types such as embeds, only 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:

PropertyValue
bubblesfalse
cancelablefalse
returnValuenull
currentTargetThe 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.
targetThe 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.
TypeFlexEvent.READY
securityError Event  
Event Object Type: flash.events.SecurityErrorEvent
SecurityErrorEvent.type property = flash.events.SecurityErrorEvent.SECURITY_ERROR

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.0

Dispatched when a security error occurs.

See also

flash.events.SecurityErrorEvent