Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
spark.primitives 
BitmapImage 
Packagespark.primitives
Classpublic class BitmapImage
InheritanceBitmapImage Inheritance GraphicElement Inheritance EventDispatcher Inheritance Object

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

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

View the examples

See also



Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The level of transparency of the graphic element.
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
 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
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 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
The fillMode 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] Contians true if the element has 3D Matrix.
GraphicElement
 Inheritedheight : Number
The height of the graphic element.
GraphicElement
 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 group.
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
Number that 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 : mx.geom: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
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 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
 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
Specifies whether to apply a smoothing algorithm to the bitmap image.
BitmapImage
  source : Object
The source used for the bitmap fill.
BitmapImage
 Inheritedtop : Object
The vertical distance in pixels from the top edge of the component to the anchor target's top edge.
GraphicElement
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
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
 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
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 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
Creates a new DisplayObject where this IGraphicElement is drawn.
GraphicElement
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 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
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
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
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Converts the point object from the object's (local) coordinates to the Stage (global) coordinates.
GraphicElement
 Inherited
Called by Group when an IGraphicElement is added to or removed from a Group.
GraphicElement
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 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
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Determines whether this element can draw itself to the sharedDisplayObject of the sequence.
GraphicElement
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 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 parent Group 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 parent Group to validate the size of this element.
GraphicElement
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
Determines if the call to the measure() method can be skipped.
GraphicElement
 Inherited
Processes the properties set on the element.
GraphicElement
 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
  
[override] Calculates the default size of the element.
BitmapImage
 Inherited
Used for the implementation of the ILayoutElement interface, returns the explicit of 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
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Property Detail

fillMode

property
fillMode:String

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

The fillMode 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

smooth

property 
smooth:Boolean

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

Specifies whether to apply a smoothing algorithm to the bitmap image.

If false, upscaled bitmap images are rendered by using a nearest-neighbor algorithm and look pixelated. If true, upscaled bitmap images are rendered by using a bilinear algorithm. Rendering by using the nearest neighbor algorithm is usually faster.

The default value is false.



Implementation
    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
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:

  • A Bitmap or BitmapData instance.
  • A class representing a subclass of DisplayObject. The BitmapFill instantiates the class and creates a bitmap rendering of it.
  • An instance of a DisplayObject. The BitmapFill copies it into a Bitmap for filling.

If you use an image file for the source, it can be of type PNG, GIF, or JPG.

To specify an image as a source, you must use the @Embed directive, as the following example shows:

      source="@Embed('image_location')"
      

The image location can be a URL or file reference. If it is a file reference, its location is relative to the location of the file that is being compiled.

If the source is a Bitmap or BitmapData instance, it is the responsibility of the caller to dispose of the source once it is no longer needed. If BitmapImage created the BitmapData instance, then it will dispose of the BitmapData once the source has changed.



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

See also

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

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 a 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:

  • The amount of text the component needs to display.
  • The size of a JPEG image that the component displays.

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 a 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.

BitmapImageExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- BitmapGraphicExample.mxml -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark">

    <s:Panel title="Bitmap Graphic Example"
            width="75%" height="75%"
            horizontalCenter="0" verticalCenter="0">
        <s:Group left="10" right="10" top="10" bottom="10">
            <!-- Single image, not resized, not repeated. -->
            <s:Graphic x="0" y="0">             
                <s:BitmapImage id="bg1" source="@Embed('assets/AirIcon12x12.gif')" fillMode="clip"/>
            </s:Graphic>

            <!-- Single image, scaled to fit specified dimensions. -->
            <s:Graphic x="150" y="0">
                <s:BitmapImage id="bg2" source="@Embed('assets/AirIcon12x12.gif')" width="60" height="60" fillMode="scale"/>
            </s:Graphic>

            <!-- Repeated image to fit specified dimensions. -->
            <s:Graphic x="300" y="0">
                <s:BitmapImage id="bg3" source="@Embed('assets/AirIcon12x12.gif')" width="120" height="120" fillMode="repeat"/>
            </s:Graphic>
        </s:Group>
    </s:Panel>

</s:Application>