Google Git
Sign in
apache/flex-site/HEAD/./content/asdoc/mx/core/ComponentDescriptor.html
blob: 0e322bceb9a6ed5ffc12a0d923cd23571417fca2 [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="ComponentDescriptor,mx.core.ComponentDescriptor,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.ComponentDescriptor</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 = 'ComponentDescriptor - 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/ComponentDescriptor.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">ComponentDescriptor</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("ComponentDescriptor"); 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 ComponentDescriptor</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">ComponentDescriptor <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr><tr><td class="classHeaderTableLabel">Subclasses</td><td> <a href="../../mx/core/UIComponentDescriptor.html">UIComponentDescriptor</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>
ComponentDescriptor is the base class for the UIComponentDescriptor class,
which encapsulates the information that you specified in an MXML tag
for an instance of a visual component.
In Flex, non-visual components are treated differently and do not
have descriptors, but in a future version the ComponentDescriptor
base class may be used for them as well.
<p>Most of the tags in an MXML file describe a tree of UIComponent objects.
For example, the <code>&lt;mx:Application&gt;</code> tag represents a
UIComponent object, and its child containers and controls are all
UIComponent objects.</p>
<p>The MXML compiler compiles each of these MXML tags into a
UIComponentDescriptor instance.
To be precise, the MXML compiler autogenerates an ActionScript
data structure which is a tree of UIComponentDescriptor objects.</p>
<p>At runtime, the <code>createComponentsFromDescriptors()</code> method
of the Container class uses the information in the UIComponentDescriptor
objects in the container's <code>childDescriptors</code> array to create
the actual UIComponent objects that are the container's children,
plus deeper descendants as well.
Depending on the value of the container's <code>creationPolicy</code>,
property, the descendants might be created at application startup,
when some part of the component is about to become visible,
or when the application developer manually calls
the <code>createComponentsFromDescriptors()</code> method.</p>
<p>You do not typically create ComponentDescriptor or UIComponentDescriptor
instances yourself; you can access the ones that the MXML compiler
autogenerates, via the <code>childDescriptors</code> array
of the Container class.</p>
<p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="UIComponentDescriptor.html" target="">mx.core.UIComponentDescriptor</a><br/><a href="Container.html#childDescriptors" target="">mx.core.Container.childDescriptors</a><br/><a href="Container.html#creationPolicy" target="">mx.core.Container.creationPolicy</a><br/><a href="Container.html#createComponentsFromDescriptors()" target="">mx.core.Container.createComponentsFromDescriptors()</a></div><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="#document" class="signatureLink">document</a> : Object<div class="summaryTableDescription">
A reference to the document Object in which the component
is to be created.</div></td><td class="summaryTableOwnerCol">ComponentDescriptor</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#events" class="signatureLink">events</a> : Object<div class="summaryTableDescription">
An Object containing name/value pairs for the component's
event handlers, as specified in MXML.</div></td><td class="summaryTableOwnerCol">ComponentDescriptor</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#id" class="signatureLink">id</a> : String<div class="summaryTableDescription">
The identifier for the component, as specified in MXML.</div></td><td class="summaryTableOwnerCol">ComponentDescriptor</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#properties" class="signatureLink">properties</a> : Object<div class="summaryTableDescription">[read-only]
An Object containing name/value pairs for the component's properties,
as specified in MXML.</div></td><td class="summaryTableOwnerCol">ComponentDescriptor</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#propertiesFactory" class="signatureLink">propertiesFactory</a> : Function<div class="summaryTableDescription">
A Function that returns an Object containing name/value pairs
for the component's properties, as specified in MXML.</div></td><td class="summaryTableOwnerCol">ComponentDescriptor</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#type" class="signatureLink">type</a> : Class<div class="summaryTableDescription">
The Class of the component, as specified in MXML.</div></td><td class="summaryTableOwnerCol">ComponentDescriptor</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </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="#ComponentDescriptor()" class="signatureLink">ComponentDescriptor</a>(descriptorProperties:Object)</div><div class="summaryTableDescription">
Constructor.</div></td><td class="summaryTableOwnerCol">ComponentDescriptor</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#invalidateProperties()" class="signatureLink">invalidateProperties</a>():void</div><div class="summaryTableDescription">
Invalidates the cached properties property.</div></td><td class="summaryTableOwnerCol">ComponentDescriptor</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#toString()" class="signatureLink">toString</a>():String</div><div class="summaryTableDescription">
Returns the string "ComponentDescriptor_" plus the value of the
id property.</div></td><td class="summaryTableOwnerCol">ComponentDescriptor</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="document"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">document</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>public var document:Object</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>
A reference to the document Object in which the component
is to be created.
</p><p><span class="label">See also</span></p><div class="seeAlso"><a href="IUIComponent.html#document" target="">mx.core.IUIComponent.document</a></div></div><a name="propertyDetail"></a><a name="events"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">events</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public var events:Object</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>
An Object containing name/value pairs for the component's
event handlers, as specified in MXML.
<p>For example, if you write</p>
<pre>
&lt;mx:DataGrid id="dg" initialize="fetchData(); initDataGrid();" change="changeHandler(event);"/>
</pre>
<p>then the descriptor's <code>events</code> property is the Object</p>
<pre>
{ initialize: "__dg_initialize", change: "__dg_change" }
</pre>
<p>The <code>event</code>property is <code>null</code>
if no MXML event handlers were specified for the component</p>
<p>The strings <code>"__dg_initialize"</code>
and <code>"__dg_change"</code> are the names of event handler
methods that the MXML compiler autogenerates.
The body of these methods contain the ActionScript statements
that you specified as the values of the event attributes.
For example, the autogenerated <code>initialize</code> handler is</p>
<pre>
public function __dg_initialize(event:mx.events.FlexEvent):void
{
fetchData();
initDataGrid();
}
</pre>
<p>You should not assume that the autogenerated event handlers
will always be specified by name; this may change in a future
version of Flex.</p>
<p>This property is used by the Container method
<code>createComponentsFromDescriptors()</code>
to register the autogenerated event handlers
using the <code>addEventListener()</code> method.</p>
</p></div><a name="propertyDetail"></a><a name="id"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">id</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public var id: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 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 identifier for the component, as specified in MXML.
<p>For example, if you write</p>
<pre>
&lt;mx:TextInput id="firstName" text="Enter your first name here"/>
</pre>
<p>then the descriptor's <code>id</code> property is the String
<code>"firstName"</code>.</p>
<p>The <code>id</code> property is <code>null</code>
if no MXML id was specified for the component.</p>
<p>The value of the <code>id</code> property becomes the name
of a public variable in the MXML document object,
autogenerated by the MXML compiler.
The value of this variable is a reference to the UIComponent object
created from this descriptor.
This is why you can, for example, reference the TextInput control's
<code>text</code> property as <code>firstName.text</code>
from anywhere within the document containing this TextInput instance.</p>
<p>If an <code>id</code> is specified, and it isn't the empty string,
it also becomes the <code>name</code> of the DisplayObject object.
If an <code>id</code> is not specified or is empty, the DisplayObject
object's <code>name</code> remains an autogenerated string,
such as <code>"Button3"</code>, as returned by the
<code>NameUtil.createUniqueName()</code> method.
The <code>name</code> is used in generating the string returned
by the <code>toString()</code> method.
It can also be used to find the component from its parent
by calling <code>getChildByName()</code>.</p>
</p><p><span class="label">See also</span></p><div class="seeAlso">flash.display.DisplayObject.name</div></div><a name="propertyDetail"></a><a name="properties"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">properties</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>properties:Object</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>
An Object containing name/value pairs for the component's properties,
as specified in MXML.
<p>For example, if you write</p>
<pre>
&lt;mx:TextInput width="150" text="Hello"/>
</pre>
<p>then the descriptor's <code>properties</code> property
is the Object</p>
<pre>
{ width: 150, text: "Hello" }
</pre>
<p>The <code>properties</code> property is <code>null</code>
if no MXML properties were specified for the component.
In this case, the component will use default property values.</p>
<p> This Object is produced by calling the function specified by the
<code>propertiesFactory</code> property, and then cached
for subsequent access.
However, when a Repeater produces multiple instances of a component
from the same descriptor, a fresh copy of the <code>properties</code>
Object should be produced for each component instance so that they
don't share property values which are Arrays or Object references.
The Repeater accomplishes this by calling the
<code>invalidateProperties()</code> method on the descriptor.</p>
</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get properties():Object</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="ComponentDescriptor.html#propertiesFactory" target="">propertiesFactory</a><br/><a href="ComponentDescriptor.html#invalidateProperties()" target="">invalidateProperties()</a></div></div><a name="propertyDetail"></a><a name="propertiesFactory"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">propertiesFactory</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public var propertiesFactory:Function</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>
A Function that returns an Object containing name/value pairs
for the component's properties, as specified in MXML.
<p>For example, if you write</p>
<pre>
&lt;mx:TextInput width="150" text="Hello">
</pre>
<p>then the descriptor's <code>propertiesFactory</code> property
is the Function:</p>
<pre>
function():Object { return { width: 150, text: "Hello" }; }
</pre>
<p>The <code>propertiesFactory</code>property is <code>null</code>
if no MXML properties were specified for the component.
In this case, the component will use default property values.</p>
<p>The reason that <code>propertyFactory</code> is a
Function returning an Object rather than an actual Object
is to allow the tree of ComponentDescriptor objects
to "unfold" incrementally.
If all the descriptors in the descriptor tree for the document
were created at launch time, the time to launch would be greater.</p>
<p>The <code>properties</code> property returns a cached Object
that was produced by this factory function.</p>
<p>Note: Event handlers such as <code>click="doSomething();"</code>
appear in the <code>events</code> Object,
not in the <code>properties</code> Object.</p>
</p><p><span class="label">See also</span></p><div class="seeAlso"><a href="ComponentDescriptor.html#properties" target="">properties</a></div></div><a name="propertyDetail"></a><a name="type"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">type</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>public var type:Class</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>
The Class of the component, as specified in MXML.
<p>For example, if you write</p>
<pre>
&lt;mx:TextInput/>
</pre>
<p>then the descriptor's <code>type</code> property
the Class mx.controls.TextInput.</p>
<p>The property is never <code>null</code> for the
ComponentDescriptor objects created by the MXML compiler,
because every MXML tag has a tag name such as mx:TextInput.</p>
<p>The mapping between an MXML tag and its corresponding class
is determined by the XML namespace and the "manifest" file,
if any, that is associated with that namespace.
For example, the standard Flex namespace
<code>http://www.adobe.com/2006/mxml</code>
represented by the mx: prefix is associated (in the flex-config.xml
file) with the manifest file mxml-manifest.xml,
and this file has the tag</p>
<pre>
&lt;component id="TextInput" class="mx.controls.TextInput"/>
</pre>
<p>which maps the tag name mx:TextInput
to the Class mx.controls.TextInput.
Note that the use of a manifest file allows components in single
XML namespace to map to classes in multiple ActionScript packages.</p>
</p></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="ComponentDescriptor()"></a><a name="ComponentDescriptor(Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">ComponentDescriptor</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function ComponentDescriptor(descriptorProperties:Object)</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">descriptorProperties</span>:Object</code> &mdash; An Object containing name/value pairs
for the properties of the ComponentDescriptor object, such as its
<code>type</code>, <code>id</code>, <code>propertiesFactory</code>
and <code>events</code>.
</td></tr></table></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="invalidateProperties()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invalidateProperties</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function invalidateProperties():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>
Invalidates the cached <code>properties</code> property.
The next time you read the <code>properties</code> property,
the properties are regenerated from the function specified by the
value of the <code>propertiesFactory</code> property.
</p></div><a name="toString()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function toString():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 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>
Returns the string "ComponentDescriptor_" plus the value of the
<code>id</code> property.
</p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>String</code> &mdash; The string "ComponentDescriptor_" plus the value of the
<code>id</code> property.
</td></tr></table></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 -->