blob: 6847895532ac8952723d6234377ad88a25a7494a [file]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../override.css" type="text/css"><meta name="keywords" content="BitmapAsset,mx.core.BitmapAsset,ABSOLUTE,ALL,AUTO,AUTO,AUTO,BINDING,CURRENT,CURRENT_VERSION,CURSOR_MANAGEMENT,DEFAULT,DEFAULT,DEFAULT_HANDLER,DEFAULT_MAX_HEIGHT,DEFAULT_MAX_WIDTH,DEFAULT_MEASURED_HEIGHT,DEFAULT_MEASURED_MIN_HEIGHT,DEFAULT_MEASURED_MIN_WIDTH,DEFAULT_MEASURED_WIDTH,DPI_120,DPI_160,DPI_240,DPI_320,DPI_480,DPI_640,EFFECT,EMPTY,HORIZONTAL,LTR,MOUSE,MXMLDescriptor,MXMLProperties,NONE,OFF,OFF,ON,ON,PARENT,QUEUED,RTL,TOP_LEVEL,TOUCH,VERSION_2_0,VERSION_2_0_1,VERSION_3_0,VERSION_4_0,VERSION_4_10,VERSION_4_11,VERSION_4_12,VERSION_4_13,VERSION_4_14,VERSION_4_15,VERSION_4_16,VERSION_4_16_1,VERSION_4_5,VERSION_4_6,VERSION_4_8,VERSION_4_9,VERSION_ALREADY_READ,VERSION_ALREADY_SET,VERTICAL,accessibilityDescription,accessibilityEnabled,accessibilityName,accessibilityProperties,accessibilityShortcut,activeEffects,actualCreationPolicy,allowDomainsInNewRSLs,allowInsecureDomainsInNewRSLs,alpha,alpha,alpha,alwaysInFront,alwaysInFront,alwaysShowSelection,alwaysShowSelection,antiAliasType,antiAliasType,antiAliasType,application,applicationDomainTarget,applicationID,autoExit,autoLayout,autoSize,autoSize,automationDelegate,automationDelegate,automationDelegate,automationEnabled,automationEnabled,automationEnabled,automationName,automationName,automationName,automationOwner,automationOwner,automationOwner,automationParent,automationParent,automationParent,automationTabularData,automationValue,automationValue,automationValue,automationVisible,automationVisible,automationVisible,background,background,backgroundColor,backgroundColor,backgroundFrameRate,backgroundImageBounds,baseline,baseline,baselinePosition,baselinePosition,baselinePosition,baselinePosition,baselinePosition,blendMode,border,border,border,borderColor,borderColor,borderMetrics,borderMetrics,borderMetrics,borderMetrics,borderMetrics,bottom,bottom,bottom,bottomScrollV,bottomScrollV,boxLayoutClass,buttonMode,cacheAsBitmap,cacheHeuristic,cacheHeuristic,cachePolicy,cachePolicy,canvasLayoutClass,caretIndex,caretIndex,childAllowsParent,childDescriptors,childDescriptors,className,className,className,clipContent,closed,closed,compatibilityErrorFunction,compatibilityVersion,compatibilityVersionString,computedMatrix,computedMatrix3D,condenseWhite,condenseWhite,constraintColumns,constraintRows,container,container,contentMouseX,contentMouseX,contentMouseY,contentMouseY,controlBar,controlBar,count,count,creatingContentPane,creatingContentPane,creationIndex,creationPolicy,creationPolicy,currentCSSState,currentIndex,currentIndex,currentItem,currentItem,currentState,currentState,cursorManager,data,data,dataProvider,dataProvider,defaultButton,defaultButton,defaultTextFormat,defaultTextFormat,deferredContentCreated,deferredContentCreated,depth,depth,descriptor,descriptor,designLayer,designLayer,digest,direction,direction,displayAsPassword,displayAsPassword,dockIconMenu,document,document,document,document,document,doubleClickEnabled,doubleClickEnabled,doubleClickEnabled,dropTarget,editable,effectiveAlpha,effectiveVisibility,effects,embedFonts,embedFonts,emphasized,enableIME,enableIME,enableIME,enableIME,enabled,enabled,enabled,enabled,errorString,events,explicitHeight,explicitHeight,explicitHeight,explicitHeight,explicitMaxHeight,explicitMaxHeight,explicitMaxHeight,explicitMaxHeight,explicitMaxWidth,explicitMaxWidth,explicitMaxWidth,explicitMaxWidth,explicitMinHeight,explicitMinHeight,explicitMinHeight,explicitMinHeight,explicitMinWidth,explicitMinWidth,explicitMinWidth,explicitMinWidth,explicitWidth,explicitWidth,explicitWidth,explicitWidth,filters,flexContextMenu,focusEnabled,focusEnabled,focusManager,focusManager,focusPane,focusPane,focusPane,focusPane,focusRect,focusRect,fontContext,fontContext,formats,frameRate,generator,graphics,gridFitType,gridFitType,gridFitType,hasBackgroundImage,hasComplexLayoutMatrix,hasFocusableChildren,hasFocusableChildren,hasLayoutMatrix3D,hasLayoutMatrix3D,hashType,height,height,height,historyManagementEnabled,hitArea,horizontalCenter,horizontalCenter,horizontalLineScrollSize,horizontalPageScrollSize,horizontalScrollBar,horizontalScrollBar,horizontalScrollPolicy,horizontalScrollPolicy,horizontalScrollPosition,horizontalScrollPosition,horizontalScrollPosition,horizontalScrollPosition,htmlText,htmlText,icon,icon,id,id,id,id,ignorePadding,ignorePadding,ignorePadding,imeMode,imeMode,imeMode,imeMode,includeInLayout,includeInLayout,includeInLayout,includeInLayout,includeInLayout,inheritingStyles,inheritingStyles,inheritingStyles,inheritingStyles,initialHeight,initialWidth,initialized,initialized,initialized,instanceIndex,instanceIndices,instanceIndices,is3D,is3D,is3D,isDocument,isDocument,isPopUp,isPopUp,isPopUp,isPopUp,isSigned,label,label,label,layout,layoutDirection,layoutDirection,layoutDirection,layoutIs3D,layoutMatrix,layoutMatrix3D,layoutMatrix3D,layoutRotationX,layoutRotationY,layoutRotationZ,layoutScaleX,layoutScaleY,layoutScaleZ,layoutWidth,layoutX,layoutY,layoutZ,left,left,left,length,length,liveScrolling,loadForCompatibility,loaderInfo,locale,locale,maintainProjectionCenter,mask,maskShape,maxChars,maxChars,maxChars,maxHeight,maxHeight,maxHeight,maxHeight,maxHorizontalScrollPosition,maxHorizontalScrollPosition,maxScrollH,maxScrollH,maxScrollV,maxScrollV,maxVerticalScrollPosition,maxVerticalScrollPosition,maxWidth,maxWidth,maxWidth,maxWidth,maximizable,maximizable,maximizable,measuredHeight,measuredHeight,measuredHeight,measuredHeight,measuredHeight,measuredHeight,measuredHeight,measuredHeight,measuredHeight,measuredMinHeight,measuredMinHeight,measuredMinHeight,measuredMinHeight,measuredMinWidth,measuredMinWidth,measuredMinWidth,measuredMinWidth,measuredWidth,measuredWidth,measuredWidth,measuredWidth,measuredWidth,measuredWidth,measuredWidth,measuredWidth,measuredWidth,menu,menu,minHeight,minHeight,minHeight,minHeight,minWidth,minWidth,minWidth,minWidth,minimizable,minimizable,minimizable,mirror,moduleFactory,moduleFactory,moduleFactory,moduleFactory,moduleFactory,moduleFactory,mouseChildren,mouseChildren,mouseEnabled,mouseEnabled,mouseEnabled,mouseFocusEnabled,mouseFocusEnabled,mouseWheelEnabled,mouseWheelEnabled,mouseX,mouseY,movieClipData,multiline,multiline,name,nativeApplication,nativeWindow,nativeWindow,nativeWindow,nestLevel,nestLevel,nestLevel,nestLevel,nonInheritingStyles,nonInheritingStyles,nonInheritingStyles,nonInheritingStyles,nonZeroTextHeight,nonZeroTextHeight,nonZeroTextHeight,numAutomationChildren,numChildren,numChildren,numChildren,numElements,numElements,numLayers,numLines,numLines,opaqueBackground,owner,owner,owner,owner,owner,pageTitle,parameters,parent,parent,parent,parent,parent,parent,parentAllowsChild,parentApplication,parentBridge,parentBridge,parentDocument,parentDrawsFocus,percentHeight,percentHeight,percentHeight,percentHeight,percentHeight,percentWidth,percentWidth,percentWidth,percentWidth,percentWidth,policyFileURL,postLayoutTransformOffsets,postLayoutTransformOffsets,preloadedRSLs,preloader,preloaderChromeColor,processedDescriptors,processedDescriptors,processedDescriptors,properties,properties,propertiesFactory,rawChildren,rawChildren,recycleChildren,recycleChildren,repeater,repeaterIndex,repeaterIndices,repeaterIndices,repeaters,repeaters,resetHistory,resizable,resizable,resizable,resourceManager,restrict,restrict,restrict,right,right,right,root,rotation,rotation,rotationX,rotationY,rotationZ,rslURL,runtimeDPI,scale9Grid,scaleX,scaleX,scaleY,scaleY,scaleZ,screen,screen,scriptRecursionLimit,scriptTimeLimit,scrollAreaChanged,scrollH,scrollH,scrollRect,scrollTipFunction,scrollV,scrollV,selectable,selectable,selectable,selectedIndex,selectionActivePosition,selectionAnchorPosition,selectionBeginIndex,selectionBeginIndex,selectionEndIndex,selectionEndIndex,sharpness,sharpness,sharpness,showGripper,showGripper,showInAutomationHierarchy,showScrollTips,showStatusBar,showStatusBar,showTitleBar,showTitleBar,soundTransform,stage,startingIndex,startingIndex,states,states,status,status,status,statusBar,statusBar,statusBarFactory,statusBarFactory,statusBarStyleFilters,statusBarStyleFilters,stretchX,stretchY,styleDeclaration,styleManager,styleName,styleName,styleName,styleParent,styleSheet,styleSheet,stylesFactory,swfBridge,systemChrome,systemChrome,systemChrome,systemManager,systemManager,systemManager,systemManager,systemTrayIconMenu,tabChildren,tabEnabled,tabEnabled,tabFocusEnabled,tabFocusEnabled,tabIndex,tabIndex,text,text,text,text,textColor,textColor,textHeight,textHeight,textSnapshot,textWidth,textWidth,thickness,thickness,thickness,title,title,title,titleBar,titleBar,titleBarFactory,titleBarFactory,titleBarStyleFilters,titleBarStyleFilters,titleIcon,titleIcon,titleIcon,toolTip,toolTip,toolTip,top,top,top,topLevelApplication,transform,transform,transformX,transformX,transformY,transformY,transformZ,transformZ,transitions,transitions,transparent,transparent,transparent,tweeningProperties,tweeningProperties,tweeningProperties,tweeningProperties,type,type,type,type,type,type,uid,uid,unscaledHeight,unscaledWidth,updateCompletePendingFlag,updateCompletePendingFlag,updateCompletePendingFlag,url,useFTE,useHandCursor,useNativeDragManager,usePreloader,useRichTextClipboard,useRichTextClipboard,validationSubField,verifyDigest,verticalCenter,verticalCenter,verticalLineScrollSize,verticalPageScrollSize,verticalScrollBar,verticalScrollBar,verticalScrollPolicy,verticalScrollPolicy,verticalScrollPosition,verticalScrollPosition,verticalScrollPosition,viewMetrics,viewMetrics,viewMetrics,viewMetricsAndPadding,viewSourceURL,visible,visible,visible,visible,visible,width,width,width,wordWrap,wordWrap,x,x,x,y,y,y,z,activate,activate,addChild,addChild,addChild,addChildAt,addChildAt,addChildAt,addChildBridge,addChildBridge,addData,addElement,addElement,addElementAt,addElementAt,addHandler,addLayer,addMXMLChildren,addPreloadedRSL,addStyleClient,addToCreationQueue,adjustFocusRect,allowDomain,allowInsecureDomain,appendText,appendText,applyComputedMatrix,areInaccessibleObjectsUnderPoint,assignFocus,attachOverlay,attachOverlay,callInContext,callLater,callLater,canSkipMeasurement,childrenCreated,clearStyle,clone,close,close,close,commitProperties,contains,contains,containsBridge,containsBridge,contentToGlobal,contentToGlobal,contentToLocal,contentToLocal,create,createAutomationIDPart,createAutomationIDPartWithRequiredProperties,createBorder,createBorder,createChildren,createChildren,createComponentFromDescriptor,createComponentsFromDescriptors,createDeferredContent,createDeferredContent,createInFontContext,createInModuleContext,createReferenceOnParentDocument,createReferenceOnParentDocument,dataForFormat,deleteReferenceOnParentDocument,deleteReferenceOnParentDocument,determineTextFormatFromStyles,dispatchEvent,dispatchPropertyChangeEvent,drawFocus,drawFocus,drawRoundRect,effectFinished,effectStarted,endEffectsStarted,executeBindings,executeBindings,executeBindings,executeChildBindings,executeChildBindings,executeChildBindings,exit,finishPrint,focusInHandler,focusOutHandler,generateMXMLArray,generateMXMLAttributes,generateMXMLInstances,generateMXMLObject,generateMXMLVector,getAutomationChildAt,getAutomationChildren,getBounds,getBoundsXAtSize,getBoundsXAtSize,getBoundsYAtSize,getBoundsYAtSize,getCharBoundaries,getCharBoundaries,getCharIndexAtPoint,getCharIndexAtPoint,getChildAt,getChildAt,getChildAt,getChildBridgeProvider,getChildBridgeProvider,getChildBridges,getChildBridges,getChildByName,getChildByName,getChildByName,getChildIndex,getChildIndex,getChildIndex,getChildren,getClassStyleDeclarations,getConstraintValue,getConstraintValue,getElementAt,getElementAt,getElementIndex,getElementIndex,getExplicitOrMeasuredHeight,getExplicitOrMeasuredHeight,getExplicitOrMeasuredHeight,getExplicitOrMeasuredHeight,getExplicitOrMeasuredWidth,getExplicitOrMeasuredWidth,getExplicitOrMeasuredWidth,getExplicitOrMeasuredWidth,getFirstCharInParagraph,getFirstCharInParagraph,getFocus,getImageReference,getImageReference,getImplementation,getInstance,getInstance,getInstance,getLayerAt,getLayoutBoundsHeight,getLayoutBoundsHeight,getLayoutBoundsWidth,getLayoutBoundsWidth,getLayoutBoundsX,getLayoutBoundsX,getLayoutBoundsY,getLayoutBoundsY,getLayoutMatrix,getLayoutMatrix,getLayoutMatrix3D,getLayoutMatrix3D,getLineIndexAtPoint,getLineIndexAtPoint,getLineIndexOfChar,getLineIndexOfChar,getLineLength,getLineLength,getLineMetrics,getLineMetrics,getLineOffset,getLineOffset,getLineText,getLineText,getMaxBoundsHeight,getMaxBoundsHeight,getMaxBoundsWidth,getMaxBoundsWidth,getMinBoundsHeight,getMinBoundsHeight,getMinBoundsWidth,getMinBoundsWidth,getObjectsUnderPoint,getObjectsUnderPoint,getParagraphLength,getParagraphLength,getPreferredBoundsHeight,getPreferredBoundsHeight,getPreferredBoundsWidth,getPreferredBoundsWidth,getRect,getRepeaterItem,getStyle,getStyle,getStyle,getStyle,getTextFormat,getTextFormat,getTextStyles,getTextStyles,getUITextFormat,getUITextFormat,getUITextFormat,getVisibleApplicationRect,getVisibleRect,getWindow,globalToContent,globalToContent,globalToLocal,hasCSSState,hasFormat,hasState,hasState,hitTestObject,hitTestPoint,horizontalGradientMatrix,info,initAdvancedLayoutFeatures,initializationComplete,initialize,initialize,initialize,initialize,initializeAccessibility,initializeRepeater,initializeRepeater,initializeRepeaterArrays,initializeRepeaterArrays,initialized,initialized,initialized,invalidateDisplayList,invalidateDisplayList,invalidateDisplayList,invalidateDisplayList,invalidateLayering,invalidateLayoutDirection,invalidateLayoutDirection,invalidateLayoutDirection,invalidateLayoutDirection,invalidateParentSizeAndDisplayList,invalidateProperties,invalidateProperties,invalidateProperties,invalidateProperties,invalidateProperties,invalidateSize,invalidateSize,invalidateSize,invalidateSize,isOurFocus,keyDownHandler,keyUpHandler,layoutBackgroundImage,layoutChrome,layoutChrome,localToContent,localToContent,localToGlobal,matchesCSSState,matchesCSSType,maximize,maximize,maximize,measure,measureHTMLText,measureHTMLText,measureText,measureText,minimize,minimize,minimize,mouseWheelHandler,move,move,move,move,move,move,move,move,move,newInstance,newInstance,newInstance,notifyStyleChangeInChildren,open,orderInBackOf,orderInBackOf,orderInFrontOf,orderInFrontOf,orderToBack,orderToBack,orderToFront,orderToFront,owns,owns,owns,owns,parentChanged,parentChanged,parentChanged,parentChanged,prepareToPrint,regenerateStyleCache,registerEffects,registerEffects,registerImplementation,removeAllChildren,removeAllElements,removeAllElements,removeChild,removeChild,removeChild,removeChildAt,removeChildAt,removeChildAt,removeChildBridge,removeChildBridge,removeElement,removeElement,removeElementAt,removeElementAt,removeLayer,removeStyleClient,replaceSelectedText,replaceSelectedText,replaceText,replaceText,replayAutomatableEvent,replayAutomatableEvent,replayAutomatableEvent,reset,reset,reset,resolveAutomationIDPart,resourcesChanged,restore,restore,restore,resumeBackgroundProcessing,roomForScrollBar,scrollChildren,scrollHandler,selectRange,setActualSize,setActualSize,setActualSize,setActualSize,setActualSize,setActualSize,setActualSize,setActualSize,setActualSize,setChildIndex,setChildIndex,setChildIndex,setColor,setColor,setColor,setConstraintValue,setConstraintValue,setCurrentState,setElementIndex,setElementIndex,setFocus,setFocus,setFocus,setFocus,setFocus,setLayoutBoundsPosition,setLayoutBoundsPosition,setLayoutBoundsSize,setLayoutBoundsSize,setLayoutMatrix,setLayoutMatrix,setLayoutMatrix3D,setLayoutMatrix3D,setMXMLDescriptor,setMXMLProperties,setScrollBarProperties,setSelection,setSelection,setStretchXY,setStyle,setStyle,setStyle,setTextFormat,setTextFormat,setVisible,setVisible,setVisible,setVisible,showBorderAndBackground,startDrag,stateChanged,stopDrag,styleChanged,styleChanged,styleChanged,stylesInitialized,suspendBackgroundProcessing,swapChildren,swapChildrenAt,swapElements,swapElements,swapElementsAt,swapElementsAt,toString,toString,toString,toString,toString,toString,toString,toString,toString,transformAround,transformAround,transformPointToParent,truncateToFit,truncateToFit,truncateToFit,updateDisplayList,updateDisplayList,validateDisplayList,validateDisplayList,validateNow,validateNow,validateNow,validateNow,validateNow,validateProperties,validateSize,validationResultHandler,verticalGradientMatrix"><title>mx.core.BitmapAsset</title></head><body><script language="javascript" type="text/javascript" src="../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../help.js"></script><script language="javascript" type="text/javascript" src="../../cookies.js"></script><script language="javascript" type="text/javascript"><!--
asdocTitle = 'BitmapAsset - ApacheFlex API Reference';
var baseRef = '../../';
window.onload = configPage;
--></script>
<script type="text/javascript">
scrollToNameAnchor();
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a>&nbsp;|&nbsp;<a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../index.html?mx/core/BitmapAsset.html&amp;mx/core/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">BitmapAsset</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("BitmapAsset"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
-->
</script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.core</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class BitmapAsset</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">BitmapAsset <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../mx/core/FlexBitmap.html">FlexBitmap</a> <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.display.Bitmap</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../mx/core/IFlexAsset.html">IFlexAsset</a>, <a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a>, <a href="../../mx/core/ILayoutDirectionElement.html">ILayoutDirectionElement</a></td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p>
BitmapAsset is a subclass of the flash.display.Bitmap class
which represents bitmap images that you embed in a Flex application.
It implements the IFlexDisplayObject interface, which makes it
possible for an embedded bitmap image to be displayed in an Image control,
or to be used as a container background or a component skin.
<p>The bitmap image that you're embedding can be in a JPEG, GIF,
or PNG file.
You can also embed a bitmap symbol that is in a SWF file produced
by Flash.
In each of these cases, the MXML compiler autogenerates a class
that extends BitmapAsset to represent the embedded bitmap image.</p>
<p>You don't generally have to use the BitmapAsset class directly
when you write a Flex application.
For example, you can embed a GIF file and display the image
in an Image control by writing the gollowing:</p>
<pre>
&lt;mx:Image id="logo" source="@Embed(source='Logo.gif')"/></pre>
<p>or use it as the application's background image in CSS syntax
by writing</p>
<pre>
&lt;fx:Style>
@namespace mx "library://ns.adobe.com/flex/mx"
mx|Application {
backgroundImage: Embed(source="Logo.gif")
}
&lt;fx:Style/></pre>
<p>without having to understand that the MXML compiler has created
a subclass of BitmapAsset for you.</p>
<p>However, it may be useful to understand what is happening
at the ActionScript level.
To embed a bitmap image in ActionScript, you declare a variable
of type Class, and put <code>[Embed]</code> metadata on it.
For example, you embed a GIF file like this:</p>
<pre>
[Bindable]
[Embed(source="Logo.gif")]
private var logoClass:Class;</pre>
<p>The MXML compiler sees the .gif extension, transcodes the GIF data
into the bitmap format that the player uses, autogenerates
a subclass of the BitmapAsset class, and sets your variable
to be a reference to this autogenerated class.
You can then use this class reference to create instances of the
BitmapAsset using the <code>new</code> operator, and you can use
APIs of the BitmapAsset class on them:</p>
<pre>
var logo:BitmapAsset = BitmapAsset(new logoClass());
logo.bitmapData.noise(4);</pre>
<p>However, you rarely need to create BitmapAsset instances yourself
because image-related properties and styles can simply be set to an
image-producing class, and components will create image instances
as necessary.
For example, to display this image in an Image control, you can
set the Image's <code>source</code> property to <code>logoClass</code>.
In MXML you could do this as follows:</p>
<pre>
&lt;mx:Image id="logo" source="{logoClass}"/></pre>
<p></p><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#layoutDirection" class="signatureLink">layoutDirection</a> : String<div class="summaryTableDescription">
Specifies the desired layout direction for an element: one of LayoutDirection.LTR
(left to right), LayoutDirection.RTL (right to left), or null (inherit).</div></td><td class="summaryTableOwnerCol">BitmapAsset</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#measuredHeight" class="signatureLink">measuredHeight</a> : Number<div class="summaryTableDescription">[read-only]
The measured height of this object.</div></td><td class="summaryTableOwnerCol">BitmapAsset</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#measuredWidth" class="signatureLink">measuredWidth</a> : Number<div class="summaryTableDescription">[read-only]
The measured width of this object.</div></td><td class="summaryTableOwnerCol">BitmapAsset</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Methods</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#BitmapAsset()" class="signatureLink">BitmapAsset</a>(bitmapData:BitmapData = null, pixelSnapping:String = auto, smoothing:Boolean = false)</div><div class="summaryTableDescription">
Constructor.</div></td><td class="summaryTableOwnerCol">BitmapAsset</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#invalidateLayoutDirection()" class="signatureLink">invalidateLayoutDirection</a>():void</div><div class="summaryTableDescription">
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes.</div></td><td class="summaryTableOwnerCol">BitmapAsset</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#move()" class="signatureLink">move</a>(x:Number, y:Number):void</div><div class="summaryTableDescription">
Moves this object to the specified x and y coordinates.</div></td><td class="summaryTableOwnerCol">BitmapAsset</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setActualSize()" class="signatureLink">setActualSize</a>(newWidth:Number, newHeight:Number):void</div><div class="summaryTableDescription">
Sets the actual size of this object.</div></td><td class="summaryTableOwnerCol">BitmapAsset</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/core/FlexBitmap.html#toString()" class="signatureLink">toString</a>():String</div><div class="summaryTableDescription">[override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/core/FlexBitmap.html">FlexBitmap</a></td></tr></table></div><script language="javascript" type="text/javascript"><!--
showHideInherited();
--></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="layoutDirection"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">layoutDirection</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>layoutDirection:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.1</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p>
Specifies the desired layout direction for an element: one of LayoutDirection.LTR
(left to right), LayoutDirection.RTL (right to left), or null (inherit).
This property is typically backed by an inheriting style. If null,
the layoutDirection style will be set to undefined.
Classes like GraphicElement, which implement ILayoutDirectionElement but do not
support styles, must additionally support a null value for this property
which means the layoutDirection must be inherited from its parent.
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get layoutDirection():String</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set layoutDirection(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="measuredHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">measuredHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>measuredHeight:Number</code>&nbsp;&nbsp;[read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
The measured height of this object.
<p>This is typically hard-coded for graphical skins
because this number is simply the number of pixels in the graphic.
For code skins, it can also be hard-coded
if you expect to be drawn at a certain size.
If your size can change based on properties, you may want
to also be an ILayoutManagerClient so a <code>measure()</code>
method will be called at an appropriate time,
giving you an opportunity to compute a <code>measuredHeight</code>.</p>
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get measuredHeight():Number</code><br/></div><a name="propertyDetail"></a><a name="measuredWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">measuredWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>measuredWidth:Number</code>&nbsp;&nbsp;[read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
The measured width of this object.
<p>This is typically hard-coded for graphical skins
because this number is simply the number of pixels in the graphic.
For code skins, it can also be hard-coded
if you expect to be drawn at a certain size.
If your size can change based on properties, you may want
to also be an ILayoutManagerClient so a <code>measure()</code>
method will be called at an appropriate time,
giving you an opportunity to compute a <code>measuredHeight</code>.</p>
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get measuredWidth():Number</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="BitmapAsset()"></a><a name="BitmapAsset(flash.display.BitmapData,String,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">BitmapAsset</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function BitmapAsset(bitmapData:BitmapData = null, pixelSnapping:String = auto, smoothing:Boolean = false)</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p>
Constructor.
</p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">bitmapData</span>:BitmapData</code> (default = <code>null</code>)<code></code> &mdash; The data for the bitmap image.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">pixelSnapping</span>:String</code> (default = <code>auto</code>)<code></code> &mdash; Whether or not the bitmap is snapped
to the nearest pixel.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">smoothing</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Whether or not the bitmap is smoothed when scaled.
</td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="invalidateLayoutDirection()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invalidateLayoutDirection</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function invalidateLayoutDirection():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.1</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p>
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes.
If they differ, this method is responsible for mirroring the element’s contents
and for updating the element’s post-layout transform so that descendants inherit
a mirrored coordinate system. IVisualElements typically implement
mirroring by using postLayoutTransformOffsets to scale the X axis by -1 and
to translate the x coordinate of the origin by the element's width.
The net effect of this "mirror" transform is to reverse the direction
in which the X axis increases without changing the element's location
relative to its parent's origin.
</p></div><a name="move()"></a><a name="move(Number,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">move</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function move(x:Number, y:Number):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Moves this object to the specified x and y coordinates.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">x</span>:Number</code> &mdash; The new x-position for this object.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">y</span>:Number</code> &mdash; The new y-position for this object.
</td></tr></table></p></div><a name="setActualSize()"></a><a name="setActualSize(Number,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setActualSize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function setActualSize(newWidth:Number, newHeight:Number):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Sets the actual size of this object.
<p>This method is mainly for use in implementing the
<code>updateDisplayList()</code> method, which is where
you compute this object's actual size based on
its explicit size, parent-relative (percent) size,
and measured size.
You then apply this actual size to the object
by calling <code>setActualSize()</code>.</p>
<p>In other situations, you should be setting properties
such as <code>width</code>, <code>height</code>,
<code>percentWidth</code>, or <code>percentHeight</code>
rather than calling this method.</p>
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">newWidth</span>:Number</code> &mdash; The new width for this object.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">newHeight</span>:Number</code> &mdash; The new height for this object.
</td></tr></table></p></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 -->