| <!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="UIComponent,mx.core.UIComponent,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.UIComponent</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 = 'UIComponent - 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> | <a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a> | <a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a> | <a id="framesLink1" href="../../index.html?mx/core/UIComponent.html&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">UIComponent</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</a> | <a href="#eventSummary">Events</a> | <a href="#styleSummary">Styles</a> | <a href="#effectSummary">Effects</a> | <a href="#constantSummary">Constants</a></td></tr><tr class="titleTableRow3"><td colspan="3"> </td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve"> |
| <!-- |
| |
| if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("UIComponent"); titleBar_setSubNav(true,true,true,false,false,true,true,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 UIComponent</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">UIComponent <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../mx/core/FlexSprite.html">FlexSprite</a> <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.display.Sprite</td></tr><tr><td class="classHeaderTableLabel">Implements</td><td> <a href="../../mx/automation/IAutomationObject.html">IAutomationObject</a>, <a href="../../mx/core/IChildList.html">IChildList</a>, <a href="../../mx/core/IConstraintClient.html">IConstraintClient</a>, <a href="../../mx/core/IDeferredInstantiationUIComponent.html">IDeferredInstantiationUIComponent</a>, <a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a>, <a href="../../mx/core/IFlexModule.html">IFlexModule</a>, <a href="../../mx/core/IInvalidating.html">IInvalidating</a>, <a href="../../mx/managers/ILayoutManagerClient.html">ILayoutManagerClient</a>, <a href="../../mx/core/IPropertyChangeNotifier.html">IPropertyChangeNotifier</a>, <a href="../../mx/core/IRepeaterClient.html">IRepeaterClient</a>, <a href="../../mx/core/IStateClient.html">IStateClient</a>, <a href="../../mx/styles/IAdvancedStyleClient.html">IAdvancedStyleClient</a>, <a href="../../mx/managers/IToolTipManagerClient.html">IToolTipManagerClient</a>, <a href="../../mx/core/IUIComponent.html">IUIComponent</a>, <a href="../../mx/validators/IValidatorListener.html">IValidatorListener</a>, <a href="../../mx/core/IVisualElement.html">IVisualElement</a></td></tr><tr><td class="classHeaderTableLabel">Subclasses</td><td> <a href="../../spark/skins/ActionScriptSkinBase.html">ActionScriptSkinBase</a>, <a href="../../mx/controls/advancedDataGridClasses/AdvancedDataGridDragProxy.html">AdvancedDataGridDragProxy</a>, <a href="../../mx/controls/advancedDataGridClasses/AdvancedDataGridGroupItemRenderer.html">AdvancedDataGridGroupItemRenderer</a>, <a href="../../mx/controls/advancedDataGridClasses/AdvancedDataGridHeaderRenderer.html">AdvancedDataGridHeaderRenderer</a>, <a href="../../mx/controls/advancedDataGridClasses/AdvancedDataGridSortItemRenderer.html">AdvancedDataGridSortItemRenderer</a>, <a href="../../mx/containers/dividedBoxClasses/BoxDivider.html">BoxDivider</a>, <a href="../../mx/controls/Button.html">Button</a>, <a href="../../spark/skins/android4/supportClasses/CalloutArrow.html">CalloutArrow</a>, <a href="../../spark/skins/ios7/supportClasses/CalloutArrow.html">CalloutArrow</a>, <a href="../../spark/skins/mobile/supportClasses/CalloutArrow.html">CalloutArrow</a>, <a href="../../spark/skins/spark/supportClasses/CalloutArrow.html">CalloutArrow</a>, <a href="../../mx/charts/chartClasses/ChartBase.html">ChartBase</a>, <a href="../../mx/charts/chartClasses/ChartItemDragProxy.html">ChartItemDragProxy</a>, <a href="../../mx/charts/chartClasses/ChartLabel.html">ChartLabel</a>, <a href="../../mx/controls/ComboBase.html">ComboBase</a>, <a href="../../mx/core/Container.html">Container</a>, <a href="../../mx/controls/dataGridClasses/DataGridDragProxy.html">DataGridDragProxy</a>, <a href="../../mx/controls/dataGridClasses/DataGridHeaderBase.html">DataGridHeaderBase</a>, <a href="../../mx/charts/chartClasses/DataTip.html">DataTip</a>, <a href="../../mx/controls/DateChooser.html">DateChooser</a>, <a href="../../spark/skins/spark/DefaultItemRenderer.html">DefaultItemRenderer</a>, <a href="../../mx/charts/chartClasses/DualStyleObject.html">DualStyleObject</a>, <a href="../../mx/containers/FormHeading.html">FormHeading</a>, <a href="../../spark/components/supportClasses/GroupBase.html">GroupBase</a>, <a href="../../spark/skins/spark/HighlightBitmapCaptureSkin.html">HighlightBitmapCaptureSkin</a>, <a href="../../mx/controls/HRule.html">HRule</a>, <a href="../../spark/skins/mobile/supportClasses/HSliderDataTip.html">HSliderDataTip</a>, <a href="../../mx/controls/Label.html">Label</a>, <a href="../../spark/components/LabelItemRenderer.html">LabelItemRenderer</a>, <a href="../../mx/charts/Legend.html">Legend</a>, <a href="../../mx/charts/LegendItem.html">LegendItem</a>, <a href="../../mx/controls/listClasses/ListBaseContentHolder.html">ListBaseContentHolder</a>, <a href="../../mx/controls/listClasses/ListItemDragProxy.html">ListItemDragProxy</a>, <a href="../../mx/controls/listClasses/ListItemRenderer.html">ListItemRenderer</a>, <a href="../../mx/controls/MenuBar.html">MenuBar</a>, <a href="../../mx/controls/menuClasses/MenuBarItem.html">MenuBarItem</a>, <a href="../../mx/controls/menuClasses/MenuItemRenderer.html">MenuItemRenderer</a>, <a href="../../mx/controls/NumericStepper.html">NumericStepper</a>, <a href="../../mx/controls/olapDataGridClasses/OLAPDataGridGroupRenderer.html">OLAPDataGridGroupRenderer</a>, <a href="../../spark/components/PopUpAnchor.html">PopUpAnchor</a>, <a href="../../mx/skins/halo/PopUpButtonSkin.html">PopUpButtonSkin</a>, <a href="../../mx/controls/ProgressBar.html">ProgressBar</a>, <a href="../../spark/primitives/RectangularDropShadow.html">RectangularDropShadow</a>, <a href="../../mx/core/Repeater.html">Repeater</a>, <a href="../../spark/components/RichEditableText.html">RichEditableText</a>, <a href="../../spark/components/supportClasses/ScrollableStageText.html">ScrollableStageText</a>, <a href="../../mx/controls/scrollClasses/ScrollBar.html">ScrollBar</a>, <a href="../../mx/core/ScrollControlBase.html">ScrollControlBase</a>, <a href="../../spark/components/supportClasses/SkinnableComponent.html">SkinnableComponent</a>, <a href="../../mx/controls/sliderClasses/Slider.html">Slider</a>, <a href="../../mx/controls/Spacer.html">Spacer</a>, <a href="../../mx/core/windowClasses/StatusBar.html">StatusBar</a>, <a href="../../spark/components/supportClasses/StyleableStageText.html">StyleableStageText</a>, <a href="../../mx/skins/halo/SwatchSkin.html">SwatchSkin</a>, <a href="../../mx/controls/SWFLoader.html">SWFLoader</a>, <a href="../../spark/components/supportClasses/TextBase.html">TextBase</a>, <a href="../../mx/controls/TextInput.html">TextInput</a>, <a href="../../mx/controls/listClasses/TileListItemRenderer.html">TileListItemRenderer</a>, <a href="../../mx/core/windowClasses/TitleBar.html">TitleBar</a>, <a href="../../mx/controls/ToolTip.html">ToolTip</a>, <a href="../../mx/controls/treeClasses/TreeItemRenderer.html">TreeItemRenderer</a>, <a href="../../mx/controls/VideoDisplay.html">VideoDisplay</a>, <a href="../../spark/components/VideoDisplay.html">VideoDisplay</a>, <a href="../../mx/controls/VRule.html">VRule</a>, <a href="../../mx/skins/halo/WindowCloseButtonSkin.html">WindowCloseButtonSkin</a>, <a href="../../mx/skins/halo/WindowMaximizeButtonSkin.html">WindowMaximizeButtonSkin</a>, <a href="../../mx/skins/halo/WindowMinimizeButtonSkin.html">WindowMinimizeButtonSkin</a>, <a href="../../mx/skins/halo/WindowRestoreButtonSkin.html">WindowRestoreButtonSkin</a></td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p> |
| The UIComponent class is the base class for all visual components, |
| both interactive and noninteractive. |
| <p>An interactive component can participate in tabbing and other kinds of |
| keyboard focus manipulation, accept low-level events like keyboard and |
| mouse input, and be disabled so that it does not receive keyboard and |
| mouse input. |
| This is in contrast to noninteractive components, like Label and |
| ProgressBar, which simply display contents and are not manipulated by |
| the user.</p> |
| <p>The UIComponent class is not used as an MXML tag, but is used as a base |
| class for other classes.</p> |
| <p></p><a name="mxmlSyntaxSummary"></a><span class="classHeaderTableLabel">MXML Syntax</span><span id="showMxmlLink" style="display:none"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/collapsed.gif" title="collapsed" alt="collapsed" class="collapsedImage">Show MXML Syntax</a><br/></span><span id="hideMxmlLink"><a href="#mxmlSyntaxSummary" onclick="toggleMXMLOnly();"><img src="../../images/expanded.gif" title="expanded" alt="expanded" class="expandedImage">Hide MXML Syntax</a></span><div id="mxmlSyntax" class="mxmlSyntax"> <p>All user interface components in Flex extend the UIComponent class. |
| Flex components inherit the following properties from the UIComponent |
| class:</p> |
| <pre> |
| <mx:<i>tagname</i> |
| <b>Properties </b> |
| accessibilityDescription="null" |
| accessibilityName="null" |
| accessibilityShortcut="null" |
| accessibilitySilent="true|false" |
| automationName="null" |
| cachePolicy="auto|on|off" |
| currentState="null" |
| doubleClickEnabled="false|true" |
| enabled="true|false" |
| explicitHeight="NaN" |
| explicitMaxHeight="NaN" |
| explicitMaxWidth="NaN" |
| explicitMinHeight="NaN" |
| explicitMinWidth="NaN" |
| explicitWidth="NaN" |
| focusEnabled="true|false" |
| hasFocusableChildren="false|true" |
| height="0" |
| id="" |
| includeInLayout="true|false" |
| maxHeight="10000" |
| maxWidth="10000" |
| measuredHeight= |
| measuredMinHeight= |
| measuredMinWidth= |
| measuredWidth= |
| minHeight="0" |
| minWidth="0" |
| mouseFocusEnabled="true|false" |
| percentHeight="NaN" |
| percentWidth="NaN" |
| scaleX="1.0" |
| scaleY="1.0" |
| states="null" |
| styleName="undefined" |
| toolTip="null" |
| transitions="" |
| validationSubField |
| width="0" |
| x="0" |
| y="0" |
| <b>Styles</b> |
| bottom="undefined" |
| errorColor="0xFF0000" |
| focusBlendMode="normal" |
| focusSkin="HaloFocusRect"" |
| focusThickness="2" |
| horizontalCenter="undefined" |
| layoutDirection="ltr" |
| left="undefined" |
| right="undefined" |
| themeColor="haloGreen" |
| top="undefined" |
| verticalCenter="undefined" |
| <b>Effects</b> |
| addedEffect="<i>No default</i>" |
| creationCompleteEffect="<i>No default</i>" |
| focusInEffect="<i>No default</i>" |
| focusOutEffect="<i>No default</i>" |
| hideEffect="<i>No default</i>" |
| mouseDownEffect="<i>No default</i>" |
| mouseUpEffect="<i>No default</i>" |
| moveEffect="<i>No default</i>" |
| removedEffect="<i>No default</i>" |
| resizeEffect="<i>No default</i>" |
| rollOutEffect="<i>No default</i>" |
| rollOverEffect="<i>No default</i>" |
| showEffect="<i>No default</i>" |
| <b>Events</b> |
| add="<i>No default</i>" |
| creationComplete="<i>No default</i>" |
| currentStateChange="<i>No default</i>" |
| currentStateChanging="<i>No default</i>" |
| dragComplete="<i>No default</i>" |
| dragDrop="<i>No default</i>" |
| dragEnter="<i>No default</i>" |
| dragExit="<i>No default</i>" |
| dragOver="<i>No default</i>" |
| effectEnd="<i>No default</i>" |
| effectStart="<i>No default</i>" |
| enterState="<i>No default</i>" |
| exitState="<i>No default</i>" |
| hide="<i>No default</i>" |
| initialize="<i>No default</i>" |
| invalid="<i>No default</i>" |
| mouseDownOutside="<i>No default</i>" |
| mouseWheelOutside="<i>No default</i>" |
| move="<i>No default</i>" |
| preinitialize="<i>No default</i>" |
| remove="<i>No default</i>" |
| resize="<i>No default</i>" |
| show="<i>No default</i>" |
| toolTipCreate="<i>No default</i>" |
| toolTipEnd="<i>No default</i>" |
| toolTipHide="<i>No default</i>" |
| toolTipShow="<i>No default</i>" |
| toolTipShown="<i>No default</i>" |
| toolTipStart="<i>No default</i>" |
| updateComplete="<i>No default</i>" |
| valid="<i>No default</i>" |
| valueCommit="<i>No default</i>" |
| > |
| </pre> |
| </div><script language="javascript" type="text/javascript"><!-- |
| setMXMLOnly(); |
| --></script><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="UIComponent.html" target="">mx.core.UIComponent</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> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#accessibilityDescription" class="signatureLink">accessibilityDescription</a> : String<div class="summaryTableDescription"> |
| A convenience accessor for the description property |
| in this UIComponent's accessibilityProperties object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#accessibilityEnabled" class="signatureLink">accessibilityEnabled</a> : Boolean<div class="summaryTableDescription"> |
| A convenience accessor for the silent property |
| in this UIComponent's accessibilityProperties object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#accessibilityName" class="signatureLink">accessibilityName</a> : String<div class="summaryTableDescription"> |
| A convenience accessor for the name property |
| in this UIComponent's accessibilityProperties object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#accessibilityShortcut" class="signatureLink">accessibilityShortcut</a> : String<div class="summaryTableDescription"> |
| A convenience accessor for the shortcut property |
| in this UIComponent's accessibilityProperties object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#activeEffects" class="signatureLink">activeEffects</a> : Array<div class="summaryTableDescription">[read-only] |
| The list of effects that are currently playing on the component, |
| as an Array of EffectInstance instances.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#automationDelegate" class="signatureLink">automationDelegate</a> : Object<div class="summaryTableDescription"> |
| The delegate object that handles the automation-related functionality.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#automationEnabled" class="signatureLink">automationEnabled</a> : Boolean<div class="summaryTableDescription">[read-only] |
| |
| True if this component is enabled for automation, false |
| otherwise.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#automationName" class="signatureLink">automationName</a> : String<div class="summaryTableDescription"> |
| |
| Name that can be used as an identifier for this object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#automationOwner" class="signatureLink">automationOwner</a> : DisplayObjectContainer<div class="summaryTableDescription">[read-only] |
| |
| The owner of this component for automation purposes.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#automationParent" class="signatureLink">automationParent</a> : DisplayObjectContainer<div class="summaryTableDescription">[read-only] |
| |
| The parent of this component for automation purposes.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#automationTabularData" class="signatureLink">automationTabularData</a> : Object<div class="summaryTableDescription">[read-only] |
| |
| An implementation of the IAutomationTabularData interface, which |
| can be used to retrieve the data.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#automationValue" class="signatureLink">automationValue</a> : Array<div class="summaryTableDescription">[read-only] |
| This value generally corresponds to the rendered appearance of the |
| object and should be usable for correlating the identifier with |
| the object as it appears visually within the application.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#automationVisible" class="signatureLink">automationVisible</a> : Boolean<div class="summaryTableDescription">[read-only] |
| |
| True if this component is visible for automation, false |
| otherwise.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#baseline" class="signatureLink">baseline</a> : Object<div class="summaryTableDescription"> |
| For components, this layout constraint property is a |
| facade on top of the similarly-named style.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#baselinePosition" class="signatureLink">baselinePosition</a> : Number<div class="summaryTableDescription">[read-only] |
| |
| The y-coordinate of the baseline |
| of the first line of text of the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#bottom" class="signatureLink">bottom</a> : Object<div class="summaryTableDescription"> |
| For components, this layout constraint property is a |
| facade on top of the similarly-named style.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#cacheHeuristic" class="signatureLink">cacheHeuristic</a> : Boolean<div class="summaryTableDescription">[write-only] |
| Used by Flex to suggest bitmap caching for the object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#cachePolicy" class="signatureLink">cachePolicy</a> : String<div class="summaryTableDescription"> |
| Specifies the bitmap caching policy for this object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#className" class="signatureLink">className</a> : String<div class="summaryTableDescription">[read-only] |
| The name of this instance's class, such as "Button".</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#contentMouseX" class="signatureLink">contentMouseX</a> : Number<div class="summaryTableDescription">[read-only] |
| Returns the x position of the mouse, in the content coordinate system.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#contentMouseY" class="signatureLink">contentMouseY</a> : Number<div class="summaryTableDescription">[read-only] |
| Returns the y position of the mouse, in the content coordinate system.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#currentState" class="signatureLink">currentState</a> : String<div class="summaryTableDescription"> |
| The current view state of the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#cursorManager" class="signatureLink">cursorManager</a> : ICursorManager<div class="summaryTableDescription">[read-only] |
| Gets the CursorManager that controls the cursor for this component |
| and its peers.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#depth" class="signatureLink">depth</a> : Number<div class="summaryTableDescription"> |
| |
| Determines the order in which items inside of containers |
| are rendered.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#descriptor" class="signatureLink">descriptor</a> : <a href="../../mx/core/UIComponentDescriptor.html">UIComponentDescriptor</a><div class="summaryTableDescription"> |
| Reference to the UIComponentDescriptor, if any, that was used |
| by the createComponentFromDescriptor() method to create this |
| UIComponent instance.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#designLayer" class="signatureLink">designLayer</a> : <a href="../../mx/core/DesignLayer.html">DesignLayer</a><div class="summaryTableDescription"> |
| Specifies the optional DesignLayer instance associated with this visual |
| element.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#document" class="signatureLink">document</a> : Object<div class="summaryTableDescription"> |
| A reference to the document object associated with this UIComponent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#doubleClickEnabled" class="signatureLink">doubleClickEnabled</a> : Boolean<div class="summaryTableDescription">[override] |
| Specifies whether the UIComponent object receives doubleClick events.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#enabled" class="signatureLink">enabled</a> : Boolean<div class="summaryTableDescription"> |
| Whether the component can accept user interaction.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#errorString" class="signatureLink">errorString</a> : String<div class="summaryTableDescription"> |
| The text that displayed by a component's error tip when a |
| component is monitored by a Validator and validation fails.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#explicitHeight" class="signatureLink">explicitHeight</a> : Number<div class="summaryTableDescription"> |
| Number that specifies the explicit height of the component, |
| in pixels, in the component's coordinates.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#explicitMaxHeight" class="signatureLink">explicitMaxHeight</a> : Number<div class="summaryTableDescription"> |
| The maximum recommended height of the component to be considered |
| by the parent during layout.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#explicitMaxWidth" class="signatureLink">explicitMaxWidth</a> : Number<div class="summaryTableDescription"> |
| The maximum recommended width of the component to be considered |
| by the parent during layout.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#explicitMinHeight" class="signatureLink">explicitMinHeight</a> : Number<div class="summaryTableDescription"> |
| The minimum recommended height of the component to be considered |
| by the parent during layout.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#explicitMinWidth" class="signatureLink">explicitMinWidth</a> : Number<div class="summaryTableDescription"> |
| The minimum recommended width of the component to be considered |
| by the parent during layout.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#explicitWidth" class="signatureLink">explicitWidth</a> : Number<div class="summaryTableDescription"> |
| Number that specifies the explicit width of the component, |
| in pixels, in the component's coordinates.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#flexContextMenu" class="signatureLink">flexContextMenu</a> : <a href="../../mx/controls/IFlexContextMenu.html">IFlexContextMenu</a><div class="summaryTableDescription"> |
| The context menu for this UIComponent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#focusEnabled" class="signatureLink">focusEnabled</a> : Boolean<div class="summaryTableDescription"> |
| Indicates whether the component can receive focus when tabbed to.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#focusManager" class="signatureLink">focusManager</a> : <a href="../../mx/managers/IFocusManager.html">IFocusManager</a><div class="summaryTableDescription"> |
| Gets the FocusManager that controls focus for this component |
| and its peers.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#focusPane" class="signatureLink">focusPane</a> : Sprite<div class="summaryTableDescription"> |
| The focus pane associated with this object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#hasFocusableChildren" class="signatureLink">hasFocusableChildren</a> : Boolean<div class="summaryTableDescription"> |
| A flag that indicates whether child objects can receive focus.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#hasLayoutMatrix3D" class="signatureLink">hasLayoutMatrix3D</a> : Boolean<div class="summaryTableDescription">[read-only] |
| |
| Contains true if the element has 3D Matrix.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#height" class="signatureLink">height</a> : Number<div class="summaryTableDescription">[override] |
| Number that specifies the height of the component, in pixels, |
| in the parent's coordinates.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#horizontalCenter" class="signatureLink">horizontalCenter</a> : Object<div class="summaryTableDescription"> |
| For components, this layout constraint property is a |
| facade on top of the similarly-named style.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#id" class="signatureLink">id</a> : String<div class="summaryTableDescription"> |
| ID of the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#includeInLayout" class="signatureLink">includeInLayout</a> : Boolean<div class="summaryTableDescription"> |
| Specifies whether this component is included in the layout of the |
| parent container.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#inheritingStyles" class="signatureLink">inheritingStyles</a> : Object<div class="summaryTableDescription"> |
| The beginning of this component's chain of inheriting styles.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#initialized" class="signatureLink">initialized</a> : Boolean<div class="summaryTableDescription"> |
| A flag that determines if an object has been through all three phases |
| of layout: commitment, measurement, and layout (provided that any were required).</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#instanceIndex" class="signatureLink">instanceIndex</a> : int<div class="summaryTableDescription">[read-only] |
| The index of a repeated component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#instanceIndices" class="signatureLink">instanceIndices</a> : Array<div class="summaryTableDescription"> |
| An Array containing the indices required to reference |
| this UIComponent object from its parent document.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#is3D" class="signatureLink">is3D</a> : Boolean<div class="summaryTableDescription">[read-only] |
| |
| Contains true when the element is in 3D.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#isDocument" class="signatureLink">isDocument</a> : Boolean<div class="summaryTableDescription">[read-only] |
| Contains true if this UIComponent instance is a document object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#isPopUp" class="signatureLink">isPopUp</a> : Boolean<div class="summaryTableDescription"> |
| Set to true by the PopUpManager to indicate |
| that component has been popped up.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#layoutMatrix3D" class="signatureLink">layoutMatrix3D</a> : Matrix3D<div class="summaryTableDescription">[write-only] |
| The transform matrix that is used to calculate a component's layout |
| relative to its siblings.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#left" class="signatureLink">left</a> : Object<div class="summaryTableDescription"> |
| For components, this layout constraint property is a |
| facade on top of the similarly-named style.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#maintainProjectionCenter" class="signatureLink">maintainProjectionCenter</a> : Boolean<div class="summaryTableDescription"> |
| When true, the component keeps its projection matrix centered on the |
| middle of its bounding box.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#maxHeight" class="signatureLink">maxHeight</a> : Number<div class="summaryTableDescription"> |
| The maximum recommended height of the component to be considered |
| by the parent during layout.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#maxWidth" class="signatureLink">maxWidth</a> : Number<div class="summaryTableDescription"> |
| The maximum recommended width of the component to be considered |
| by the parent during layout.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#measuredHeight" class="signatureLink">measuredHeight</a> : Number<div class="summaryTableDescription"> |
| The default height of the component, in pixels.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#measuredMinHeight" class="signatureLink">measuredMinHeight</a> : Number<div class="summaryTableDescription"> |
| The default minimum height of the component, in pixels.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#measuredMinWidth" class="signatureLink">measuredMinWidth</a> : Number<div class="summaryTableDescription"> |
| The default minimum width of the component, in pixels.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#measuredWidth" class="signatureLink">measuredWidth</a> : Number<div class="summaryTableDescription"> |
| The default width of the component, in pixels.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#minHeight" class="signatureLink">minHeight</a> : Number<div class="summaryTableDescription"> |
| The minimum recommended height of the component to be considered |
| by the parent during layout.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#minWidth" class="signatureLink">minWidth</a> : Number<div class="summaryTableDescription"> |
| The minimum recommended width of the component to be considered |
| by the parent during layout.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#moduleFactory" class="signatureLink">moduleFactory</a> : <a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a><div class="summaryTableDescription"> |
| A module factory is used as context for using embedded fonts and for |
| finding the style manager that controls the styles for this |
| component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#mouseFocusEnabled" class="signatureLink">mouseFocusEnabled</a> : Boolean<div class="summaryTableDescription"> |
| Whether you can receive focus when clicked on.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#MXMLDescriptor" class="signatureLink">MXMLDescriptor</a> : Array<div class="summaryTableDescription">[read-only] </div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#MXMLProperties" class="signatureLink">MXMLProperties</a> : Array<div class="summaryTableDescription">[read-only] </div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#nestLevel" class="signatureLink">nestLevel</a> : int<div class="summaryTableDescription"> |
| Depth of this object in the containment hierarchy.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#nonInheritingStyles" class="signatureLink">nonInheritingStyles</a> : Object<div class="summaryTableDescription"> |
| The beginning of this component's chain of non-inheriting styles.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#numAutomationChildren" class="signatureLink">numAutomationChildren</a> : int<div class="summaryTableDescription">[read-only] |
| |
| The number of automation children this container has.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#owner" class="signatureLink">owner</a> : DisplayObjectContainer<div class="summaryTableDescription"> |
| The owner of this IVisualElement object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#parent" class="signatureLink">parent</a> : DisplayObjectContainer<div class="summaryTableDescription">[override] [read-only] |
| The parent container or component for this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#parentApplication" class="signatureLink">parentApplication</a> : Object<div class="summaryTableDescription">[read-only] |
| A reference to the Application object that contains this UIComponent |
| instance.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#parentDocument" class="signatureLink">parentDocument</a> : Object<div class="summaryTableDescription">[read-only] |
| A reference to the parent document object for this UIComponent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#percentHeight" class="signatureLink">percentHeight</a> : Number<div class="summaryTableDescription"> |
| Specifies the height of a component as a percentage |
| of its parent's size.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#percentWidth" class="signatureLink">percentWidth</a> : Number<div class="summaryTableDescription"> |
| Specifies the width of a component as a percentage |
| of its parent's size.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#postLayoutTransformOffsets" class="signatureLink">postLayoutTransformOffsets</a> : <a href="../../mx/geom/TransformOffsets.html">TransformOffsets</a><div class="summaryTableDescription"> |
| 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.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#processedDescriptors" class="signatureLink">processedDescriptors</a> : Boolean<div class="summaryTableDescription"> |
| Set to true after immediate or deferred child creation, |
| depending on which one happens.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#repeater" class="signatureLink">repeater</a> : <a href="../../mx/core/IRepeater.html">IRepeater</a><div class="summaryTableDescription">[read-only] |
| A reference to the Repeater object |
| in the parent document that produced this UIComponent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#repeaterIndex" class="signatureLink">repeaterIndex</a> : int<div class="summaryTableDescription">[read-only] |
| The index of the item in the data provider |
| of the Repeater that produced this UIComponent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#repeaterIndices" class="signatureLink">repeaterIndices</a> : Array<div class="summaryTableDescription"> |
| An Array containing the indices of the items in the data provider |
| of the Repeaters in the parent document that produced this UIComponent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#repeaters" class="signatureLink">repeaters</a> : Array<div class="summaryTableDescription"> |
| An Array containing references to the Repeater objects |
| in the parent document that produced this UIComponent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#right" class="signatureLink">right</a> : Object<div class="summaryTableDescription"> |
| For components, this layout constraint property is a |
| facade on top of the similarly-named style.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#rotation" class="signatureLink">rotation</a> : Number<div class="summaryTableDescription">[override] </div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#rotationX" class="signatureLink">rotationX</a> : Number<div class="summaryTableDescription">[override] |
| Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation |
| relative to the 3D parent container.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#rotationY" class="signatureLink">rotationY</a> : Number<div class="summaryTableDescription">[override] |
| Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation |
| relative to the 3D parent container.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#rotationZ" class="signatureLink">rotationZ</a> : Number<div class="summaryTableDescription">[override] |
| </div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scaleX" class="signatureLink">scaleX</a> : Number<div class="summaryTableDescription">[override] |
| Number that specifies the horizontal scaling factor.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scaleY" class="signatureLink">scaleY</a> : Number<div class="summaryTableDescription">[override] |
| Number that specifies the vertical scaling factor.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#scaleZ" class="signatureLink">scaleZ</a> : Number<div class="summaryTableDescription">[override] |
| Number that specifies the scaling factor along the z axis.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#screen" class="signatureLink">screen</a> : Rectangle<div class="summaryTableDescription">[read-only] |
| Returns an object that contains the size and position of the base |
| drawing surface for this object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#showInAutomationHierarchy" class="signatureLink">showInAutomationHierarchy</a> : Boolean<div class="summaryTableDescription"> |
| |
| A flag that determines if an automation object |
| shows in the automation hierarchy.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#states" class="signatureLink">states</a> : Array<div class="summaryTableDescription"> |
| The view states that are defined for this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#styleDeclaration" class="signatureLink">styleDeclaration</a> : <a href="../../mx/styles/CSSStyleDeclaration.html">CSSStyleDeclaration</a><div class="summaryTableDescription"> |
| Storage for the inline inheriting styles on this object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#styleManager" class="signatureLink">styleManager</a> : <a href="../../mx/styles/IStyleManager2.html">IStyleManager2</a><div class="summaryTableDescription">[read-only] |
| Returns the StyleManager instance used by this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#styleName" class="signatureLink">styleName</a> : Object<div class="summaryTableDescription"> |
| The class style used by this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#styleParent" class="signatureLink">styleParent</a> : <a href="../../mx/styles/IAdvancedStyleClient.html">IAdvancedStyleClient</a><div class="summaryTableDescription"> |
| A component's parent is used to evaluate descendant selectors.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#systemManager" class="signatureLink">systemManager</a> : <a href="../../mx/managers/ISystemManager.html">ISystemManager</a><div class="summaryTableDescription"> |
| Returns the SystemManager object used by this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#tabFocusEnabled" class="signatureLink">tabFocusEnabled</a> : Boolean<div class="summaryTableDescription"> |
| A flag that indicates whether this object can receive focus |
| via the TAB key |
| |
| This is similar to the tabEnabled property |
| used by the Flash Player. |
| |
| This is usually true for components that |
| handle keyboard input, but some components in controlbars |
| have them set to false because they should not steal |
| focus from another component like an editor.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#toolTip" class="signatureLink">toolTip</a> : String<div class="summaryTableDescription"> |
| Text to display in the ToolTip.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#top" class="signatureLink">top</a> : Object<div class="summaryTableDescription"> |
| For components, this layout constraint property is a |
| facade on top of the similarly-named style.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#transform" class="signatureLink">transform</a> : Transform<div class="summaryTableDescription">[override] |
| An object with properties pertaining to a display object's matrix, color transform, |
| and pixel bounds.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#transformX" class="signatureLink">transformX</a> : Number<div class="summaryTableDescription"> |
| Sets the x coordinate for the transform center of the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#transformY" class="signatureLink">transformY</a> : Number<div class="summaryTableDescription"> |
| Sets the y coordinate for the transform center of the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#transformZ" class="signatureLink">transformZ</a> : Number<div class="summaryTableDescription"> |
| Sets the z coordinate for the transform center of the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#transitions" class="signatureLink">transitions</a> : Array<div class="summaryTableDescription"> |
| An Array of Transition objects, where each Transition object defines a |
| set of effects to play when a view state change occurs.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#tweeningProperties" class="signatureLink">tweeningProperties</a> : Array<div class="summaryTableDescription"> |
| Array of properties that are currently being tweened on this object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#uid" class="signatureLink">uid</a> : String<div class="summaryTableDescription"> |
| A unique identifier for the object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#updateCompletePendingFlag" class="signatureLink">updateCompletePendingFlag</a> : Boolean<div class="summaryTableDescription"> |
| A flag that determines if an object has been through all three phases |
| of layout validation (provided that any were required).</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#validationSubField" class="signatureLink">validationSubField</a> : String<div class="summaryTableDescription"> |
| Used by a validator to associate a subfield with this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#verticalCenter" class="signatureLink">verticalCenter</a> : Object<div class="summaryTableDescription"> |
| For components, this layout constraint property is a |
| facade on top of the similarly-named style.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#visible" class="signatureLink">visible</a> : Boolean<div class="summaryTableDescription">[override] |
| Whether or not the display object is visible.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#width" class="signatureLink">width</a> : Number<div class="summaryTableDescription">[override] |
| Number that specifies the width of the component, in pixels, |
| in the parent's coordinates.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#x" class="signatureLink">x</a> : Number<div class="summaryTableDescription">[override] |
| Number that specifies the component's horizontal position, |
| in pixels, within its parent container.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#y" class="signatureLink">y</a> : Number<div class="summaryTableDescription">[override] |
| Number that specifies the component's vertical position, |
| in pixels, within its parent container.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#z" class="signatureLink">z</a> : Number<div class="summaryTableDescription">[override] |
| </div></td><td class="summaryTableOwnerCol">UIComponent</td></tr></table></div><a name="protectedPropertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Properties</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedProperty"><tr><th> </th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#currentCSSState" class="signatureLink">currentCSSState</a> : String<div class="summaryTableDescription">[read-only] |
| The state to be used when matching CSS pseudo-selectors.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#hasComplexLayoutMatrix" class="signatureLink">hasComplexLayoutMatrix</a> : Boolean<div class="summaryTableDescription">[read-only] |
| Returns true if the UIComponent has any non-translation (x,y) transform properties.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#resourceManager" class="signatureLink">resourceManager</a> : <a href="../../mx/resources/IResourceManager.html">IResourceManager</a><div class="summaryTableDescription">[read-only] |
| A reference to the object which manages |
| all of the application's localized resources.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#unscaledHeight" class="signatureLink">unscaledHeight</a> : Number<div class="summaryTableDescription">[read-only] |
| A convenience method for determining the unscaled height |
| of the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#unscaledWidth" class="signatureLink">unscaledWidth</a> : Number<div class="summaryTableDescription">[read-only] |
| A convenience method for determining the unscaled width |
| of the component |
| All of a component's drawing and child layout should be done |
| within a bounding rectangle of this width, which is also passed |
| as an argument to updateDisplayList().</div></td><td class="summaryTableOwnerCol">UIComponent</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> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#UIComponent()" class="signatureLink">UIComponent</a>()</div><div class="summaryTableDescription"> |
| Constructor.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addStyleClient()" class="signatureLink">addStyleClient</a>(styleClient:<a href="../../mx/styles/IAdvancedStyleClient.html">IAdvancedStyleClient</a>):void</div><div class="summaryTableDescription"> |
| Adds a non-visual style client to this component instance.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#callLater()" class="signatureLink">callLater</a>(method:Function, args:Array = null):void</div><div class="summaryTableDescription"> |
| Queues a function to be called later.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#clearStyle()" class="signatureLink">clearStyle</a>(styleProp:String):void</div><div class="summaryTableDescription"> |
| Deletes a style property from this component instance.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#contentToGlobal()" class="signatureLink">contentToGlobal</a>(point:Point):Point</div><div class="summaryTableDescription"> |
| Converts a Point object from content coordinates to global coordinates.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#contentToLocal()" class="signatureLink">contentToLocal</a>(point:Point):Point</div><div class="summaryTableDescription"> |
| Converts a Point object from content to local coordinates.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#createAutomationIDPart()" class="signatureLink">createAutomationIDPart</a>(child:<a href="../../mx/automation/IAutomationObject.html">IAutomationObject</a>):Object</div><div class="summaryTableDescription"> |
| |
| Returns a set of properties that identify the child within |
| this container.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#createAutomationIDPartWithRequiredProperties()" class="signatureLink">createAutomationIDPartWithRequiredProperties</a>(child:<a href="../../mx/automation/IAutomationObject.html">IAutomationObject</a>, properties:Array):Object</div><div class="summaryTableDescription"> |
| |
| Returns a set of properties as automation IDs that identify the child within |
| this container.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#createReferenceOnParentDocument()" class="signatureLink">createReferenceOnParentDocument</a>(parentDocument:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a>):void</div><div class="summaryTableDescription"> |
| |
| Creates an id reference to this IUIComponent object |
| on its parent document object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#deleteReferenceOnParentDocument()" class="signatureLink">deleteReferenceOnParentDocument</a>(parentDocument:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a>):void</div><div class="summaryTableDescription"> |
| |
| Deletes the id reference to this IUIComponent object |
| on its parent document object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#determineTextFormatFromStyles()" class="signatureLink">determineTextFormatFromStyles</a>():<a href="../../mx/core/UITextFormat.html">UITextFormat</a></div><div class="summaryTableDescription"> |
| Returns a UITextFormat object corresponding to the text styles |
| for this UIComponent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#dispatchEvent()" class="signatureLink">dispatchEvent</a>(event:Event):Boolean</div><div class="summaryTableDescription">[override] |
| Dispatches an event into the event flow.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#drawFocus()" class="signatureLink">drawFocus</a>(isFocused:Boolean):void</div><div class="summaryTableDescription"> |
| Shows or hides the focus indicator around this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#drawRoundRect()" class="signatureLink">drawRoundRect</a>(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void</div><div class="summaryTableDescription"> |
| Programmatically draws a rectangle into this skin's Graphics object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#effectFinished()" class="signatureLink">effectFinished</a>(effectInst:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a>):void</div><div class="summaryTableDescription"> |
| Called by the effect instance when it stops playing on the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#effectStarted()" class="signatureLink">effectStarted</a>(effectInst:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a>):void</div><div class="summaryTableDescription"> |
| Called by the effect instance when it starts playing on the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#endEffectsStarted()" class="signatureLink">endEffectsStarted</a>():void</div><div class="summaryTableDescription"> |
| Ends all currently playing effects on the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#executeBindings()" class="signatureLink">executeBindings</a>(recurse:Boolean = false):void</div><div class="summaryTableDescription"> |
| Executes all the bindings for which the UIComponent object is the destination.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#finishPrint()" class="signatureLink">finishPrint</a>(obj:Object, target:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a>):void</div><div class="summaryTableDescription"> |
| Called after printing is complete.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#generateMXMLArray()" class="signatureLink">generateMXMLArray</a>(document:Object, data:Array, recursive:Boolean = true):Array</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#generateMXMLVector()" class="signatureLink">generateMXMLVector</a>(document:Object, data:Array, recursive:Boolean = true):*</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getAutomationChildAt()" class="signatureLink">getAutomationChildAt</a>(index:int):<a href="../../mx/automation/IAutomationObject.html">IAutomationObject</a></div><div class="summaryTableDescription"> |
| |
| Provides the automation object at the specified index.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getAutomationChildren()" class="signatureLink">getAutomationChildren</a>():Array</div><div class="summaryTableDescription"> |
| |
| Provides the automation object list .</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getBoundsXAtSize()" class="signatureLink">getBoundsXAtSize</a>(width:Number, height:Number, postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the x coordinate of the element's bounds at the specified element size.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getBoundsYAtSize()" class="signatureLink">getBoundsYAtSize</a>(width:Number, height:Number, postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the y coordinate of the element's bounds at the specified element size.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getClassStyleDeclarations()" class="signatureLink">getClassStyleDeclarations</a>():Array</div><div class="summaryTableDescription"> |
| Finds the type selectors for this UIComponent instance.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getConstraintValue()" class="signatureLink">getConstraintValue</a>(constraintName:String):*</div><div class="summaryTableDescription"> |
| Returns a layout constraint value, which is the same as |
| getting the constraint style for this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getExplicitOrMeasuredHeight()" class="signatureLink">getExplicitOrMeasuredHeight</a>():Number</div><div class="summaryTableDescription"> |
| A convenience method for determining whether to use the |
| explicit or measured height |
| </div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getExplicitOrMeasuredWidth()" class="signatureLink">getExplicitOrMeasuredWidth</a>():Number</div><div class="summaryTableDescription"> |
| A convenience method for determining whether to use the |
| explicit or measured width |
| </div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getFocus()" class="signatureLink">getFocus</a>():InteractiveObject</div><div class="summaryTableDescription"> |
| Gets the object that currently has focus.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLayoutBoundsHeight()" class="signatureLink">getLayoutBoundsHeight</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's layout height.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLayoutBoundsWidth()" class="signatureLink">getLayoutBoundsWidth</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's layout width.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLayoutBoundsX()" class="signatureLink">getLayoutBoundsX</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the x coordinate that the element uses to draw on screen.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLayoutBoundsY()" class="signatureLink">getLayoutBoundsY</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the y coordinate that the element uses to draw on screen.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLayoutMatrix()" class="signatureLink">getLayoutMatrix</a>():Matrix</div><div class="summaryTableDescription"> |
| |
| Returns the transform matrix that is used to calculate the component's |
| layout relative to its siblings.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getLayoutMatrix3D()" class="signatureLink">getLayoutMatrix3D</a>():Matrix3D</div><div class="summaryTableDescription"> |
| |
| Returns the layout transform Matrix3D for this element.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getMaxBoundsHeight()" class="signatureLink">getMaxBoundsHeight</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's maximum height.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getMaxBoundsWidth()" class="signatureLink">getMaxBoundsWidth</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's maximum width.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getMinBoundsHeight()" class="signatureLink">getMinBoundsHeight</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's minimum height.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getMinBoundsWidth()" class="signatureLink">getMinBoundsWidth</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's minimum width.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getPreferredBoundsHeight()" class="signatureLink">getPreferredBoundsHeight</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's preferred height.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getPreferredBoundsWidth()" class="signatureLink">getPreferredBoundsWidth</a>(postLayoutTransform:Boolean = true):Number</div><div class="summaryTableDescription"> |
| |
| Returns the element's preferred width.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getRepeaterItem()" class="signatureLink">getRepeaterItem</a>(whichRepeater:int = -1):Object</div><div class="summaryTableDescription"> |
| Returns the item in the dataProvider that was used |
| by the specified Repeater to produce this Repeater, or |
| null if this Repeater isn't repeated.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getStyle()" class="signatureLink">getStyle</a>(styleProp:String):*</div><div class="summaryTableDescription"> |
| Gets a style property that has been set anywhere in this |
| component's style lookup chain.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getVisibleRect()" class="signatureLink">getVisibleRect</a>(targetParent:DisplayObject = null):Rectangle</div><div class="summaryTableDescription"> |
| Get the bounds of this object that are visible to the user |
| on the screen.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#globalToContent()" class="signatureLink">globalToContent</a>(point:Point):Point</div><div class="summaryTableDescription"> |
| Converts a Point object from global to content coordinates.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#hasCSSState()" class="signatureLink">hasCSSState</a>():Boolean</div><div class="summaryTableDescription"> |
| |
| Returns true if currentCSSState is not null.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#hasState()" class="signatureLink">hasState</a>(stateName:String):Boolean</div><div class="summaryTableDescription"> |
| Determines whether the specified state has been defined on this |
| UIComponent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#horizontalGradientMatrix()" class="signatureLink">horizontalGradientMatrix</a>(x:Number, y:Number, width:Number, height:Number):Matrix</div><div class="summaryTableDescription"> |
| Returns a box Matrix which can be passed to the |
| drawRoundRect() method |
| as the rot parameter when drawing a horizontal gradient.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initialize()" class="signatureLink">initialize</a>():void</div><div class="summaryTableDescription"> |
| Initializes the internal structure of this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initializeRepeaterArrays()" class="signatureLink">initializeRepeaterArrays</a>(parent:<a href="../../mx/core/IRepeaterClient.html">IRepeaterClient</a>):void</div><div class="summaryTableDescription"> |
| Initializes various properties which keep track of repeated instances |
| of this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#invalidateDisplayList()" class="signatureLink">invalidateDisplayList</a>():void</div><div class="summaryTableDescription"> |
| Marks a component so that its updateDisplayList() |
| method gets called during a later screen update.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#invalidateLayering()" class="signatureLink">invalidateLayering</a>():void</div><div class="summaryTableDescription"> |
| Called by a component's items to indicate that their depth |
| property has changed.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </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">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#invalidateProperties()" class="signatureLink">invalidateProperties</a>():void</div><div class="summaryTableDescription"> |
| Marks a component so that its commitProperties() |
| method gets called during a later screen update.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#invalidateSize()" class="signatureLink">invalidateSize</a>():void</div><div class="summaryTableDescription"> |
| Marks a component so that its measure() |
| method gets called during a later screen update.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#localToContent()" class="signatureLink">localToContent</a>(point:Point):Point</div><div class="summaryTableDescription"> |
| Converts a Point object from local to content coordinates.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#matchesCSSState()" class="signatureLink">matchesCSSState</a>(cssState:String):Boolean</div><div class="summaryTableDescription"> |
| |
| Returns true if cssState matches currentCSSState.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#matchesCSSType()" class="signatureLink">matchesCSSType</a>(cssType:String):Boolean</div><div class="summaryTableDescription"> |
| |
| Determines whether this instance is the same as, or is a subclass of, |
| the given type.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#measureHTMLText()" class="signatureLink">measureHTMLText</a>(htmlText:String):TextLineMetrics</div><div class="summaryTableDescription"> |
| Measures the specified HTML text, which can contain HTML tags such |
| as <font> and <b>, |
| assuming that it is displayed |
| in a single-line UITextField using a UITextFormat |
| determined by the styles of this UIComponent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#measureText()" class="signatureLink">measureText</a>(text:String):TextLineMetrics</div><div class="summaryTableDescription"> |
| Measures the specified text, assuming that it is displayed |
| in a single-line UITextField (or UIFTETextField) using a UITextFormat |
| determined by the styles of this UIComponent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#move()" class="signatureLink">move</a>(x:Number, y:Number):void</div><div class="summaryTableDescription"> |
| Moves the component to a specified position within its parent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#notifyStyleChangeInChildren()" class="signatureLink">notifyStyleChangeInChildren</a>(styleProp:String, recursive:Boolean):void</div><div class="summaryTableDescription"> |
| Propagates style changes to the children.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#owns()" class="signatureLink">owns</a>(child:DisplayObject):Boolean</div><div class="summaryTableDescription"> |
| Returns true if the chain of owner properties |
| points from child to this UIComponent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#parentChanged()" class="signatureLink">parentChanged</a>(p:DisplayObjectContainer):void</div><div class="summaryTableDescription"> |
| Called by Flex when a UIComponent object is added to or removed from a parent.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#prepareToPrint()" class="signatureLink">prepareToPrint</a>(target:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a>):Object</div><div class="summaryTableDescription"> |
| Prepares an IFlexDisplayObject for printing.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#regenerateStyleCache()" class="signatureLink">regenerateStyleCache</a>(recursive:Boolean):void</div><div class="summaryTableDescription"> |
| Builds or rebuilds the CSS style cache for this component |
| and, if the recursive parameter is true, |
| for all descendants of this component as well.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#registerEffects()" class="signatureLink">registerEffects</a>(effects:Array):void</div><div class="summaryTableDescription"> |
| For each effect event, registers the EffectManager |
| as one of the event listeners.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeStyleClient()" class="signatureLink">removeStyleClient</a>(styleClient:<a href="../../mx/styles/IAdvancedStyleClient.html">IAdvancedStyleClient</a>):void</div><div class="summaryTableDescription"> |
| Removes a non-visual style client from this component instance.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#replayAutomatableEvent()" class="signatureLink">replayAutomatableEvent</a>(event:Event):Boolean</div><div class="summaryTableDescription"> |
| |
| Replays the specified event.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#resolveAutomationIDPart()" class="signatureLink">resolveAutomationIDPart</a>(criteria:Object):Array</div><div class="summaryTableDescription"> |
| |
| Resolves a child by using the id provided.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#resumeBackgroundProcessing()" class="signatureLink">resumeBackgroundProcessing</a>():void</div><div class="summaryTableDescription">[static] |
| Resumes the background processing of methods |
| queued by callLater(), after a call to |
| suspendBackgroundProcessing().</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setActualSize()" class="signatureLink">setActualSize</a>(w:Number, h:Number):void</div><div class="summaryTableDescription"> |
| Sizes the object.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setConstraintValue()" class="signatureLink">setConstraintValue</a>(constraintName:String, value:*):void</div><div class="summaryTableDescription"> |
| Sets a layout constraint value, which is the same as |
| setting the constraint style for this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setCurrentState()" class="signatureLink">setCurrentState</a>(stateName:String, playTransition:Boolean = true):void</div><div class="summaryTableDescription"> |
| Set the current state.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setFocus()" class="signatureLink">setFocus</a>():void</div><div class="summaryTableDescription"> |
| Sets the focus to this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setLayoutBoundsPosition()" class="signatureLink">setLayoutBoundsPosition</a>(x:Number, y:Number, postLayoutTransform:Boolean = true):void</div><div class="summaryTableDescription"> |
| |
| Sets the coordinates that the element uses to draw on screen.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setLayoutBoundsSize()" class="signatureLink">setLayoutBoundsSize</a>(width:Number, height:Number, postLayoutTransform:Boolean = true):void</div><div class="summaryTableDescription"> |
| |
| Sets the layout size of the element.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setLayoutMatrix()" class="signatureLink">setLayoutMatrix</a>(value:Matrix, invalidateLayout:Boolean):void</div><div class="summaryTableDescription"> |
| |
| Sets the transform Matrix that is used to calculate the component's layout |
| size and position relative to its siblings.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setLayoutMatrix3D()" class="signatureLink">setLayoutMatrix3D</a>(value:Matrix3D, invalidateLayout:Boolean):void</div><div class="summaryTableDescription"> |
| |
| Sets the transform Matrix3D that is used to calculate the component's layout |
| size and position relative to its siblings.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setMXMLDescriptor()" class="signatureLink">setMXMLDescriptor</a>(value:Array):void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setMXMLProperties()" class="signatureLink">setMXMLProperties</a>(value:Array):void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setStyle()" class="signatureLink">setStyle</a>(styleProp:String, newValue:*):void</div><div class="summaryTableDescription"> |
| Sets a style property on this component instance.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setVisible()" class="signatureLink">setVisible</a>(value:Boolean, noEvent:Boolean = false):void</div><div class="summaryTableDescription"> |
| Called when the visible property changes.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#styleChanged()" class="signatureLink">styleChanged</a>(styleProp:String):void</div><div class="summaryTableDescription"> |
| Detects changes to style properties.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#stylesInitialized()" class="signatureLink">stylesInitialized</a>():void</div><div class="summaryTableDescription"> |
| Flex calls the stylesInitialized() method when |
| the styles for a component are first initialized.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#suspendBackgroundProcessing()" class="signatureLink">suspendBackgroundProcessing</a>():void</div><div class="summaryTableDescription">[static] |
| Blocks the background processing of methods |
| queued by callLater(), |
| until resumeBackgroundProcessing() is called.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol"> </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/FlexSprite.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/FlexSprite.html">FlexSprite</a></td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#transformAround()" class="signatureLink">transformAround</a>(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void</div><div class="summaryTableDescription"> |
| 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.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#transformPointToParent()" class="signatureLink">transformPointToParent</a>(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void</div><div class="summaryTableDescription"> |
| 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.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#validateDisplayList()" class="signatureLink">validateDisplayList</a>():void</div><div class="summaryTableDescription"> |
| |
| Validates the position and size of children and draws other |
| visuals.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#validateNow()" class="signatureLink">validateNow</a>():void</div><div class="summaryTableDescription"> |
| Validate and update the properties and layout of this object |
| and redraw it, if necessary.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#validateProperties()" class="signatureLink">validateProperties</a>():void</div><div class="summaryTableDescription"> |
| Used by layout logic to validate the properties of a component |
| by calling the commitProperties() method.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#validateSize()" class="signatureLink">validateSize</a>(recursive:Boolean = false):void</div><div class="summaryTableDescription"> |
| |
| Validates the measured size of the component |
| If the LayoutManager.invalidateSize() method is called with |
| this ILayoutManagerClient, then the validateSize() method |
| is called when it's time to do measurements.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#validationResultHandler()" class="signatureLink">validationResultHandler</a>(event:<a href="../../mx/events/ValidationResultEvent.html">ValidationResultEvent</a>):void</div><div class="summaryTableDescription"> |
| Handles both the valid and invalid events from a |
| validator assigned to this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#verticalGradientMatrix()" class="signatureLink">verticalGradientMatrix</a>(x:Number, y:Number, width:Number, height:Number):Matrix</div><div class="summaryTableDescription"> |
| Returns a box Matrix which can be passed to drawRoundRect() |
| as the rot parameter when drawing a vertical gradient.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr></table></div><a name="protectedMethodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProtectedMethod"><tr><th> </th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addMXMLChildren()" class="signatureLink">addMXMLChildren</a>(comps:Array):void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#adjustFocusRect()" class="signatureLink">adjustFocusRect</a>(obj:DisplayObject = null):void</div><div class="summaryTableDescription"> |
| Adjust the focus rectangle.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#applyComputedMatrix()" class="signatureLink">applyComputedMatrix</a>():void</div><div class="summaryTableDescription"> |
| Commits the computed matrix built from the combination of the layout |
| matrix and the transform offsets to the flash displayObject's transform.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#attachOverlay()" class="signatureLink">attachOverlay</a>():void</div><div class="summaryTableDescription"> |
| This is an internal method used by the Flex framework |
| to support the Dissolve effect.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#canSkipMeasurement()" class="signatureLink">canSkipMeasurement</a>():Boolean</div><div class="summaryTableDescription"> |
| Determines if the call to the measure() method can be skipped.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#childrenCreated()" class="signatureLink">childrenCreated</a>():void</div><div class="summaryTableDescription"> |
| Performs any final processing after child objects are created.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#commitProperties()" class="signatureLink">commitProperties</a>():void</div><div class="summaryTableDescription"> |
| Processes the properties set on the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#createChildren()" class="signatureLink">createChildren</a>():void</div><div class="summaryTableDescription"> |
| Create child objects of the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#createInFontContext()" class="signatureLink">createInFontContext</a>(classObj:Class):Object</div><div class="summaryTableDescription"> |
| Creates a new object using a context |
| based on the embedded font being used.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#createInModuleContext()" class="signatureLink">createInModuleContext</a>(moduleFactory:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a>, className:String):Object</div><div class="summaryTableDescription"> |
| Creates the object using a given moduleFactory.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#dispatchPropertyChangeEvent()" class="signatureLink">dispatchPropertyChangeEvent</a>(prop:String, oldValue:*, value:*):void</div><div class="summaryTableDescription"> |
| Helper method for dispatching a PropertyChangeEvent |
| when a property is updated.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#focusInHandler()" class="signatureLink">focusInHandler</a>(event:FocusEvent):void</div><div class="summaryTableDescription"> |
| The event handler called when a UIComponent object gets focus.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#focusOutHandler()" class="signatureLink">focusOutHandler</a>(event:FocusEvent):void</div><div class="summaryTableDescription"> |
| The event handler called when a UIComponent object loses focus.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#generateMXMLAttributes()" class="signatureLink">generateMXMLAttributes</a>(data:Array):void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#generateMXMLInstances()" class="signatureLink">generateMXMLInstances</a>(document:Object, data:Array, recursive:Boolean = true):void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#generateMXMLObject()" class="signatureLink">generateMXMLObject</a>(document:Object, data:Array):Object</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initAdvancedLayoutFeatures()" class="signatureLink">initAdvancedLayoutFeatures</a>():void</div><div class="summaryTableDescription"> |
| Initializes the implementation and storage of some of the less frequently |
| used advanced layout features of a component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initializationComplete()" class="signatureLink">initializationComplete</a>():void</div><div class="summaryTableDescription"> |
| Finalizes the initialization of this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#initializeAccessibility()" class="signatureLink">initializeAccessibility</a>():void</div><div class="summaryTableDescription"> |
| Initializes this component's accessibility code.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#invalidateParentSizeAndDisplayList()" class="signatureLink">invalidateParentSizeAndDisplayList</a>():void</div><div class="summaryTableDescription"> |
| Helper method to invalidate parent size and display list if |
| this object affects its layout (includeInLayout is true).</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#isOurFocus()" class="signatureLink">isOurFocus</a>(target:DisplayObject):Boolean</div><div class="summaryTableDescription"> |
| Typically overridden by components containing UITextField objects, |
| where the UITextField object gets focus.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#keyDownHandler()" class="signatureLink">keyDownHandler</a>(event:KeyboardEvent):void</div><div class="summaryTableDescription"> |
| The event handler called for a keyDown event.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#keyUpHandler()" class="signatureLink">keyUpHandler</a>(event:KeyboardEvent):void</div><div class="summaryTableDescription"> |
| The event handler called for a keyUp event.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#measure()" class="signatureLink">measure</a>():void</div><div class="summaryTableDescription"> |
| Calculates the default size, and optionally the default minimum size, |
| of the component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#resourcesChanged()" class="signatureLink">resourcesChanged</a>():void</div><div class="summaryTableDescription"> |
| This method is called when a UIComponent is constructed, |
| and again whenever the ResourceManager dispatches |
| a "change" Event to indicate |
| that the localized resources have changed in some way.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#setStretchXY()" class="signatureLink">setStretchXY</a>(stretchX:Number, stretchY:Number):void</div><div class="summaryTableDescription"> |
| Specifies a transform stretch factor in the horizontal and vertical direction.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#stateChanged()" class="signatureLink">stateChanged</a>(oldState:String, newState:String, recursive:Boolean):void</div><div class="summaryTableDescription"> |
| This method is called when a state changes to check whether |
| state-specific styles apply to this component.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#updateDisplayList()" class="signatureLink">updateDisplayList</a>(unscaledWidth:Number, unscaledHeight:Number):void</div><div class="summaryTableDescription"> |
| Draws the object and/or sizes and positions its children.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableEvent"><tr><th> </th><th colspan="2">Event</th><th> Summary </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:add" class="signatureLink">add</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:creationComplete" class="signatureLink">creationComplete</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:currentStateChange" class="signatureLink">currentStateChange</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched after the view state has changed.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:currentStateChanging" class="signatureLink">currentStateChanging</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched after the currentState property changes, but before the view state changes.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:dragComplete" class="signatureLink">dragComplete</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:dragDrop" class="signatureLink">dragDrop</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the drop target when the user releases the mouse over it.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:dragEnter" class="signatureLink">dragEnter</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by a component when the user moves the mouse over the component during a drag operation.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:dragExit" class="signatureLink">dragExit</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:dragOver" class="signatureLink">dragOver</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by a component when the user moves the mouse while over the component during a drag operation.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:dragStart" class="signatureLink">dragStart</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the drag initiator when starting a drag operation.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:effectEnd" class="signatureLink">effectEnd</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched after an effect ends.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:effectStart" class="signatureLink">effectStart</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched just before an effect starts.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:effectStop" class="signatureLink">effectStop</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched after an effect is stopped, which happens only by a call to stop() on the effect.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:enterState" class="signatureLink">enterState</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched after the component has entered a view state.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:exitState" class="signatureLink">exitState</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched just before the component exits a view state.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:hide" class="signatureLink">hide</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when an object's state changes from visible to invisible.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:initialize" class="signatureLink">initialize</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the component has finished its construction and has all initialization properties set.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:invalid" class="signatureLink">invalid</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when a component is monitored by a Validator and the validation failed.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:mouseDownOutside" class="signatureLink">mouseDownOutside</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched from a component opened using the PopUpManager when the user clicks outside it.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:mouseWheelOutside" class="signatureLink">mouseWheelOutside</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:move" class="signatureLink">move</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the object has moved.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:preinitialize" class="signatureLink">preinitialize</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched at the beginning of the component initialization sequence.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:remove" class="signatureLink">remove</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:resize" class="signatureLink">resize</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when the component is resized.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:show" class="signatureLink">show</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when an object's state changes from invisible to visible.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:stateChangeComplete" class="signatureLink">stateChangeComplete</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched after the component has entered a new state and any state transition animation to that state has finished playing.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:stateChangeInterrupted" class="signatureLink">stateChangeInterrupted</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when a component interrupts a transition to its current state in order to switch to a new state.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:toolTipCreate" class="signatureLink">toolTipCreate</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the component when it is time to create a ToolTip.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:toolTipEnd" class="signatureLink">toolTipEnd</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the component when its ToolTip has been hidden and is to be discarded soon.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:toolTipHide" class="signatureLink">toolTipHide</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the component when its ToolTip is about to be hidden.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:toolTipShow" class="signatureLink">toolTipShow</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the component when its ToolTip is about to be shown.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:toolTipShown" class="signatureLink">toolTipShown</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by the component when its ToolTip has been shown.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:toolTipStart" class="signatureLink">toolTipStart</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:touchInteractionEnd" class="signatureLink">touchInteractionEnd</a></div></td><td class="summaryTableDescription summaryTableCol">A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:touchInteractionStart" class="signatureLink">touchInteractionStart</a></div></td><td class="summaryTableDescription summaryTableCol">A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:touchInteractionStarting" class="signatureLink">touchInteractionStarting</a></div></td><td class="summaryTableDescription summaryTableCol">A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:updateComplete" class="signatureLink">updateComplete</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:valid" class="signatureLink">valid</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when a component is monitored by a Validator and the validation succeeded.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#event:valueCommit" class="signatureLink">valueCommit</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when values are changed programmatically or by user interaction.</td><td class="summaryTableOwnerCol">UIComponent</td></tr></table></div><a name="styleSummary"></a><div class="summarySection"><div class="summaryTableTitle">Styles</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableStyle"><tr><th> </th><th colspan="2">Style</th><th> Description </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:baseline"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">baseline</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>String <span class="label">CSS Inheritance: </span>no<br/> |
| The vertical distance in pixels from the top edge of the content area to |
| the control's baseline position. |
| If this style is set, the baseline of the component is |
| anchored to the top edge of its content area; when its container |
| is resized, the two edges maintain their separation. |
| |
| <p>This style only has an effect when used on a component in a Canvas container, |
| or when used on a component in a Panel or Application container that has the |
| <code>layout</code> property set to <code>absolute</code>.</p> |
| |
| <p>The default value is <code>undefined</code>, which means it is not set.</p> |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:bottom"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">bottom</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>String <span class="label">CSS Inheritance: </span>no<br/> |
| The vertical distance, in pixels, from the bottom edge of the component |
| to the bottom edge of its parent container's content area. |
| If this style is set, the lower edge of the component is |
| anchored to the bottom edge of its content area; when its container |
| is resized, the two edges maintain their separation. |
| |
| <p>This style only has an effect when used on a component in a Canvas container, |
| or when used on a component in a Panel or Application container that has the |
| <code>layout</code> property set to <code>absolute</code>.</p> |
| |
| <p>The default value is <code>undefined</code>, which means it is not set.</p> |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:chromeColor"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">chromeColor</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>uint <span class="label">Format: </span>Color <span class="label">CSS Inheritance: </span>yes <span class="label">Theme: </span>spark<br/> |
| The main color for a component. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:errorColor"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">errorColor</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>uint <span class="label">Format: </span>Color <span class="label">CSS Inheritance: </span>yes<br/> |
| Color of the component highlight when validation fails. |
| Flex also sets the <code>borderColor</code> style of the component to this |
| <code>errorColor</code> on a validation failure. |
| The default value for the Halo theme is <code>0xFF0000</code>. |
| The default value for the Spark theme is <code>0xFE0000</code>. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:focusBlendMode"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">focusBlendMode</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>String <span class="label">CSS Inheritance: </span>no<br/> |
| Blend mode used by the focus rectangle. |
| For more information, see the <code>blendMode</code> property |
| of the flash.display.DisplayObject class. |
| The default value is<code> "normal"</code>.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:focusSkin"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">focusSkin</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>Class <span class="label">CSS Inheritance: </span>no<br/> |
| Skin used to draw the focus rectangle. |
| The default value for Halo components is mx.skins.halo.HaloFocusRect. |
| The default value for Spark components is spark.skins.spark.FocusSkin. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:focusThickness"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">focusThickness</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>Number <span class="label">Format: </span>Length <span class="label">CSS Inheritance: </span>no<br/> |
| Thickness, in pixels, of the focus rectangle outline. |
| The default value is<code> 2</code>.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:horizontalCenter"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">horizontalCenter</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>String <span class="label">CSS Inheritance: </span>no<br/> |
| The horizontal distance in pixels from the center of the component's |
| content area to the center of the component. |
| If this style is set, the center of the component is |
| anchored to the center of its content area; when its container |
| is resized, the two centers maintain their horizontal separation. |
| |
| <p>This style only has an effect when used on a component in a Canvas container, |
| or when used on a component in a Panel or Application container that has the |
| <code>layout</code> property set to <code>absolute</code>.</p> |
| |
| <p>The default value is <code>undefined</code>, which means it is not set.</p> |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:interactionMode"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">interactionMode</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>String <span class="label">CSS Inheritance: </span>yes<br/> |
| The primary interaction mode for this component. The acceptable values are: |
| <code>mouse</code> and <code>touch</code>. |
| The default value for the Halo theme is <code>mouse</code>. |
| The default value for the Spark theme is <code>mouse</code>. |
| The default value for the Mobile theme is <code>touch</code>. |
| |
| <p><span class="label">See also</span></p><div class="seeAlso"><a href="InteractionMode.html#MOUSE" target="">mx.core.InteractionMode.MOUSE</a><br/><a href="InteractionMode.html#TOUCH" target="">mx.core.InteractionMode.TOUCH</a></div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:layoutDirection"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">layoutDirection</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>String <span class="label">CSS Inheritance: </span>yes<br/> |
| Specifies the desired layout direction of a component. The allowed values |
| are <code>"ltr"</code> for left-to-right layout, used for |
| components using Latin-style scripts, and <code>"rtl"</code> for |
| right-to-left layout, used for components using scripts such |
| as Arabic and Hebrew. |
| |
| <p>In ActionScript you can set the layoutDirection using the values |
| <code>mx.core.LayoutDirection.LTR</code>, |
| <code>mx.core.LayoutDirection.RTL</code> or |
| <code>undefined</code>, to inherit the layoutDirection from the parent.</p> |
| |
| <p>The layoutDirection should typically be set on the |
| <code>Application</code> rather than on individual components. If the |
| layoutDirection is <code>"rtl"</code>, most visual elements, except text |
| and images, will be mirrored. The directionality of text is determined |
| by the <code>direction</code> style.</p> |
| |
| <p>Components which handle Keyboard.LEFT and Keyboard.RIGHT events |
| typically swap the key’s meaning when layoutDirection is |
| <code>“rtl”</code>. In other words, left always means move left and |
| right always means move right, regardless of the |
| <code>layoutDirection</code> |
| </p> |
| |
| <p>Note: This style applies to all Spark components and MX components that |
| specify UIFTETextField as their textFieldClass.</p> |
| |
| The default value is<code> "ltr"</code>.<p><span class="label">See also</span></p><div class="seeAlso">MXFTEText.css<br/><a href="ILayoutDirectionElement.html" target="">mx.core.ILayoutDirectionElement</a><br/><a href="LayoutDirection.html" target="">mx.core.LayoutDirection</a></div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:left"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">left</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>String <span class="label">CSS Inheritance: </span>no<br/> |
| The horizontal distance, in pixels, from the left edge of the component |
| to the left edge of its parent container's content area. |
| If this style is set, the left edge of the component is |
| anchored to the left edge of its content area; when its container |
| is resized, the two edges maintain their separation. |
| |
| <p>This style only has an effect when used on a component in a Canvas container, |
| or when used on a component in a Panel or Application container that has the |
| <code>layout</code> property set to <code>absolute</code>.</p> |
| |
| <p>The default value is <code>undefined</code>, which means it is not set.</p> |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:right"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">right</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>String <span class="label">CSS Inheritance: </span>no<br/> |
| The horizontal distance, in pixels, from the right edge of the component |
| to the right edge of its parent container's content area. |
| If this style is set, the right edge of the component is |
| anchored to the right edge of its content area; when its container |
| is resized, the two edges maintain their separation. |
| |
| <p>This style only has an effect when used on a component in a Canvas container, |
| or when used on a component in a Panel or Application container that has the |
| <code>layout</code> property set to <code>absolute</code>.</p> |
| |
| <p>The default value is <code>undefined</code>, which means it is not set.</p> |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:showErrorSkin"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">showErrorSkin</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>Boolean <span class="label">CSS Inheritance: </span>yes<br/> |
| Show the error border or skin when this component is invalid |
| |
| The default value is<code> true</code>.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:showErrorTip"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">showErrorTip</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>Boolean <span class="label">CSS Inheritance: </span>yes<br/> |
| Show the error tip when this component is invalid and the user |
| rolls over it |
| |
| The default value is<code> true</code>.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:themeColor"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">themeColor</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>uint <span class="label">Format: </span>Color <span class="label">CSS Inheritance: </span>yes <span class="label">Theme: </span>halo<br/> |
| Theme color of a component. This property controls the appearance of highlights, |
| appearance when a component is selected, and other similar visual cues, but it |
| does not have any effect on the regular borders or background colors of the component. |
| The preferred values are <code>haloGreen</code>, <code>haloBlue</code>, |
| <code>haloOrange</code>, and <code>haloSilver</code>, although any valid color |
| value can be used. |
| <p>The default values of the <code>rollOverColor</code> and |
| <code>selectionColor</code> styles are based on the |
| <code>themeColor</code> value.</p> |
| The default value is<code> "haloBlue"</code>.</td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:top"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">top</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>String <span class="label">CSS Inheritance: </span>no<br/> |
| The vertical distance, in pixels, from the top edge of the component |
| to the top edge of its parent container's content area. |
| If this style is set, the top edge of the component is |
| anchored to the top edge of its content area; when its container |
| is resized, the two edges maintain their separation. |
| |
| <p>This style only has an effect when used on a component in a Canvas container, |
| or when used on a component in a Panel or Application container that has the |
| <code>layout</code> property set to <code>absolute</code>.</p> |
| |
| <p>The default value is <code>undefined</code>, which means it is not set.</p> |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="style:verticalCenter"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">verticalCenter</span></div></td><td class="summaryTableDescription"><span class="label">Type: </span>String <span class="label">CSS Inheritance: </span>no<br/> |
| The vertical distance in pixels from the center of the component's |
| content area to the center of the component. |
| If this style is set, the center of the component is |
| anchored to the center of its content area; when its container |
| is resized, the two centers maintain their vertical separation. |
| |
| <p>This style only has an effect when used on a component in a Canvas container, |
| or when used on a component in a Panel or Application container that has the |
| <code>layout</code> property set to <code>absolute</code>.</p> |
| |
| <p>The default value is <code>undefined</code>, which means it is not set.</p> |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr></table></div><a name="effectSummary"></a><div class="summarySection"><div class="summaryTableTitle">Effects</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableEffect"><tr><th> </th><th colspan="2">Effect</th><th> Description </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:addedEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">addedEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>added<br/> |
| Played when the component is added as a child to a Container. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:creationCompleteEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">creationCompleteEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>creationComplete<br/> |
| Played when the component is created. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:focusInEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">focusInEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>focusIn<br/> |
| Played when the component gains keyboard focus. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:focusOutEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">focusOutEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>focusOut<br/> |
| Played when the component loses keyboard focus. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:hideEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">hideEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>hide<br/> |
| Played when the component becomes invisible. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:mouseDownEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">mouseDownEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>mouseDown<br/> |
| Played when the user presses the mouse button while over the component. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:mouseUpEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">mouseUpEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>mouseUp<br/> |
| Played when the user releases the mouse button while over the component. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:moveEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">moveEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>move<br/> |
| Played when the component is moved. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:removedEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">removedEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>removed<br/> |
| Played when the component is removed from a Container. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:resizeEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">resizeEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>resize<br/> |
| Played when the component is resized. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:rollOutEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">rollOutEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>rollOut<br/> |
| Played when the user rolls the mouse so it is no longer over the component. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:rollOverEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">rollOverEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>rollOver<br/> |
| Played when the user rolls the mouse over the component. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"><a name="effect:showEffect"></a> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><span class="signatureLink">showEffect</span></div></td><td class="summaryTableDescription"><span class="label"> Triggering Event: </span>show<br/> |
| Played when the component becomes visible. |
| |
| </td><td class="summaryTableOwnerCol">UIComponent</td></tr></table></div><a name="constantSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Constants</div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableConstant"><tr><th> </th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#DEFAULT_MAX_HEIGHT" class="signatureLink">DEFAULT_MAX_HEIGHT</a> : Number = 10000<div class="summaryTableDescription">[static] |
| The default value for the maxHeight property.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#DEFAULT_MAX_WIDTH" class="signatureLink">DEFAULT_MAX_WIDTH</a> : Number = 10000<div class="summaryTableDescription">[static] |
| The default value for the maxWidth property.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#DEFAULT_MEASURED_HEIGHT" class="signatureLink">DEFAULT_MEASURED_HEIGHT</a> : Number = 22<div class="summaryTableDescription">[static] |
| The default value for the measuredHeight property.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#DEFAULT_MEASURED_MIN_HEIGHT" class="signatureLink">DEFAULT_MEASURED_MIN_HEIGHT</a> : Number = 22<div class="summaryTableDescription">[static] |
| The default value for the measuredMinHeight property.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#DEFAULT_MEASURED_MIN_WIDTH" class="signatureLink">DEFAULT_MEASURED_MIN_WIDTH</a> : Number = 40<div class="summaryTableDescription">[static] |
| The default value for the measuredMinWidth property.</div></td><td class="summaryTableOwnerCol">UIComponent</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><a href="#DEFAULT_MEASURED_WIDTH" class="signatureLink">DEFAULT_MEASURED_WIDTH</a> : Number = 160<div class="summaryTableDescription">[static] |
| The default value for the measuredWidth property.</div></td><td class="summaryTableOwnerCol">UIComponent</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="accessibilityDescription"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">accessibilityDescription</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>accessibilityDescription:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A convenience accessor for the <code>description</code> property |
| in this UIComponent's <code>accessibilityProperties</code> object. |
| <p>The getter simply returns <code>accessibilityProperties.description</code>, |
| or "" if <code>accessibilityProperties</code> is null. |
| The setter first checks whether <code>accessibilityProperties</code> is null, |
| and if it is, sets it to a new AccessibilityProperties instance. |
| Then it sets <code>accessibilityProperties.description</code>.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get accessibilityDescription():String</code><br/><code> public function set accessibilityDescription(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="accessibilityEnabled"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">accessibilityEnabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>accessibilityEnabled:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A convenience accessor for the <code>silent</code> property |
| in this UIComponent's <code>accessibilityProperties</code> object. |
| <p>Note that <code>accessibilityEnabled</code> has the opposite sense from silent; |
| <code>accessibilityEnabled</code> is <code>true</code> |
| when <code>silent</code> is <code>false</code>.</p> |
| <p>The getter simply returns <code>accessibilityProperties.silent</code>, |
| or <code>true</code> if <code>accessibilityProperties</code> is null. |
| The setter first checks whether <code>accessibilityProperties</code> is null, |
| and if it is, sets it to a new AccessibilityProperties instance. |
| Then it sets <code>accessibilityProperties.silent</code>.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get accessibilityEnabled():Boolean</code><br/><code> public function set accessibilityEnabled(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="accessibilityName"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">accessibilityName</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>accessibilityName:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A convenience accessor for the <code>name</code> property |
| in this UIComponent's <code>accessibilityProperties</code> object. |
| <p>The getter simply returns <code>accessibilityProperties.name</code>, |
| or "" if accessibilityProperties is null. |
| The setter first checks whether <code>accessibilityProperties</code> is null, |
| and if it is, sets it to a new AccessibilityProperties instance. |
| Then it sets <code>accessibilityProperties.name</code>.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get accessibilityName():String</code><br/><code> public function set accessibilityName(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="accessibilityShortcut"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">accessibilityShortcut</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>accessibilityShortcut:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A convenience accessor for the <code>shortcut</code> property |
| in this UIComponent's <code>accessibilityProperties</code> object. |
| <p>The getter simply returns <code>accessibilityProperties.shortcut</code>, |
| or "" if <code>accessibilityProperties</code> is null. |
| The setter first checks whether <code>accessibilityProperties</code> is null, |
| and if it is, sets it to a new AccessibilityProperties instance. |
| Then it sets <code>accessibilityProperties.shortcut</code>.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get accessibilityShortcut():String</code><br/><code> public function set accessibilityShortcut(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="activeEffects"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">activeEffects</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>activeEffects:Array</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The list of effects that are currently playing on the component, |
| as an Array of EffectInstance instances. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get activeEffects():Array</code><br/></div><a name="propertyDetail"></a><a name="automationDelegate"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">automationDelegate</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>automationDelegate:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The delegate object that handles the automation-related functionality. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get automationDelegate():Object</code><br/><code> public function set automationDelegate(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="automationEnabled"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">automationEnabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>automationEnabled:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| True if this component is enabled for automation, false |
| otherwise. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get automationEnabled():Boolean</code><br/></div><a name="propertyDetail"></a><a name="automationName"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">automationName</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>automationName:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Name that can be used as an identifier for this object. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get automationName():String</code><br/><code> public function set automationName(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="automationOwner"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">automationOwner</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>automationOwner:DisplayObjectContainer</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| The owner of this component for automation purposes. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get automationOwner():DisplayObjectContainer</code><br/></div><a name="propertyDetail"></a><a name="automationParent"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">automationParent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>automationParent:DisplayObjectContainer</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| The parent of this component for automation purposes. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get automationParent():DisplayObjectContainer</code><br/></div><a name="propertyDetail"></a><a name="automationTabularData"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">automationTabularData</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>automationTabularData:Object</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| An implementation of the <code>IAutomationTabularData</code> interface, which |
| can be used to retrieve the data. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get automationTabularData():Object</code><br/></div><a name="propertyDetail"></a><a name="automationValue"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">automationValue</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>automationValue:Array</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| This value generally corresponds to the rendered appearance of the |
| object and should be usable for correlating the identifier with |
| the object as it appears visually within the application. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get automationValue():Array</code><br/></div><a name="propertyDetail"></a><a name="automationVisible"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">automationVisible</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>automationVisible:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| True if this component is visible for automation, false |
| otherwise. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get automationVisible():Boolean</code><br/></div><a name="propertyDetail"></a><a name="baseline"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">baseline</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>baseline:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| <p>For components, this layout constraint property is a |
| facade on top of the similarly-named style. To set |
| the property to its default value of <code>undefined</code>, |
| use the @Clear() directive in MXML or the <code>undefined</code> |
| value in ActionScript code. For example, in MXML code, |
| <code>baseline.s2="@Clear()"</code> unsets the <code>baseline</code> |
| constraint in state s2. Or in ActionScript code, |
| <code>button.baseline = undefined</code> unsets the <code>baseline</code> |
| constraint on <code>button</code>.</p> |
| |
| |
| The vertical distance in pixels from the anchor target to |
| the control's baseline position. |
| <p>By default the anchor target is the top edge of the container's |
| content area. In layouts with advanced constraints, the target can be |
| a constraint row.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format: |
| "anchorTargetName:value". For example, "row1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get baseline():Object</code><br/><code> public function set baseline(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="baselinePosition"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">baselinePosition</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>baselinePosition:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| The y-coordinate of the baseline |
| of the first line of text of the component. |
| |
| <p>This property is used to implement |
| the <code>baseline</code> constraint style. |
| It is also used to align the label of a FormItem |
| with the controls in the FormItem.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get baselinePosition():Number</code><br/></div><a name="propertyDetail"></a><a name="bottom"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">bottom</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>bottom:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| <p>For components, this layout constraint property is a |
| facade on top of the similarly-named style. To set |
| the property to its default value of <code>undefined</code>, |
| use the @Clear() directive in MXML or the <code>undefined</code> |
| value in ActionScript code. For example, in MXML code, |
| <code>bottom.s2="@Clear()"</code> unsets the <code>bottom</code> |
| constraint in state s2. Or in ActionScript code, |
| <code>button.bottom = undefined</code> unsets the <code>bottom</code> |
| constraint on <code>button</code>.</p> |
| |
| |
| The vertical distance in pixels from the bottom edge of the component to the |
| anchor target's bottom edge. |
| <p>By default the anchor target is the container's content area. In layouts |
| with advanced constraints, the target can be a constraint row.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format: |
| "anchorTargetName:value". For example, "row1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get bottom():Object</code><br/><code> public function set bottom(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="cacheHeuristic"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">cacheHeuristic</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>cacheHeuristic:Boolean</code> [write-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Used by Flex to suggest bitmap caching for the object. |
| If <code>cachePolicy</code> is <code>UIComponentCachePolicy.AUTO</code>, |
| then <code>cacheHeuristic</code> |
| is used to control the object's <code>cacheAsBitmap</code> property. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function set cacheHeuristic(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="cachePolicy"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">cachePolicy</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>cachePolicy:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Specifies the bitmap caching policy for this object. |
| Possible values in MXML are <code>"on"</code>, |
| <code>"off"</code> and |
| <code>"auto"</code> (default). |
| <p>Possible values in ActionScript are <code>UIComponentCachePolicy.ON</code>, |
| <code>UIComponentCachePolicy.OFF</code> and |
| <code>UIComponentCachePolicy.AUTO</code> (default).</p> |
| <p><ul> |
| <li>A value of <code>UIComponentCachePolicy.ON</code> means that |
| the object is always cached as a bitmap.</li> |
| <li>A value of <code>UIComponentCachePolicy.OFF</code> means that |
| the object is never cached as a bitmap.</li> |
| <li>A value of <code>UIComponentCachePolicy.AUTO</code> means that |
| the framework uses heuristics to decide whether the object should |
| be cached as a bitmap.</li> |
| </ul></p> |
| </p><p> The default value is <code>UIComponentCachePolicy.AUTO</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get cachePolicy():String</code><br/><code> public function set cachePolicy(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="className"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">className</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>className:String</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The name of this instance's class, such as <code>"Button"</code>. |
| <p>This string does not include the package name. |
| If you need the package name as well, call the |
| <code>getQualifiedClassName()</code> method in the flash.utils package. |
| It returns a string such as <code>"mx.controls::Button"</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get className():String</code><br/></div><a name="propertyDetail"></a><a name="contentMouseX"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">contentMouseX</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>contentMouseX:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns the <i>x</i> position of the mouse, in the content coordinate system. |
| Content coordinates specify a pixel position relative to the upper left |
| corner of the component's content, and include all of the component's |
| content area, including any regions that are currently clipped and must |
| be accessed by scrolling the component. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get contentMouseX():Number</code><br/></div><a name="propertyDetail"></a><a name="contentMouseY"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">contentMouseY</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>contentMouseY:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns the <i>y</i> position of the mouse, in the content coordinate system. |
| Content coordinates specify a pixel position relative to the upper left |
| corner of the component's content, and include all of the component's |
| content area, including any regions that are currently clipped and must |
| be accessed by scrolling the component. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get contentMouseY():Number</code><br/></div><a name="propertyDetail"></a><a name="currentCSSState"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">currentCSSState</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>currentCSSState:String</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| The state to be used when matching CSS pseudo-selectors. By default |
| this is the <code>currentState</code>. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> protected function get currentCSSState():String</code><br/></div><a name="propertyDetail"></a><a name="currentState"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">currentState</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>currentState:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The current view state of the component. |
| Set to <code>""</code> or <code>null</code> to reset |
| the component back to its base state. |
| <p>When you use this property to set a component's state, |
| Flex applies any transition you have defined. |
| You can also use the <code>setCurrentState()</code> method to set the |
| current state; this method can optionally change states without |
| applying a transition.</p> |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get currentState():String</code><br/><code> public function set currentState(value:String):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="UIComponent.html#setCurrentState()" target="">setCurrentState()</a></div></div><a name="propertyDetail"></a><a name="cursorManager"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">cursorManager</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>cursorManager:ICursorManager</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Gets the CursorManager that controls the cursor for this component |
| and its peers. |
| Each top-level window has its own instance of a CursorManager; |
| To make sure you're talking to the right one, use this method. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get cursorManager():ICursorManager</code><br/></div><a name="propertyDetail"></a><a name="depth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">depth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>depth:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Determines the order in which items inside of containers |
| are rendered. |
| Spark containers order their items based on their |
| <code>depth</code> property, with the lowest depth in the back, |
| and the higher in the front. |
| Items with the same depth value appear in the order |
| they are added to the container. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get depth():Number</code><br/><code> public function set depth(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="descriptor"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">descriptor</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>descriptor:<a href="../../mx/core/UIComponentDescriptor.html">UIComponentDescriptor</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Reference to the UIComponentDescriptor, if any, that was used |
| by the <code>createComponentFromDescriptor()</code> method to create this |
| UIComponent instance. If this UIComponent instance |
| was not created from a descriptor, this property is null. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get descriptor():<a href="../../mx/core/UIComponentDescriptor.html">UIComponentDescriptor</a></code><br/><code> public function set descriptor(value:<a href="../../mx/core/UIComponentDescriptor.html">UIComponentDescriptor</a>):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="UIComponentDescriptor.html" target="">mx.core.UIComponentDescriptor</a></div></div><a name="propertyDetail"></a><a name="designLayer"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">designLayer</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>designLayer:<a href="../../mx/core/DesignLayer.html">DesignLayer</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Specifies the optional DesignLayer instance associated with this visual |
| element. |
| <p>When a DesignLayer is assigned, a visual element must consider the |
| visibility and alpha of its parent layer when ultimately committing its |
| own effective visibility or alpha to its backing DisplayObject |
| (if applicable).</p> |
| <p>A visual element must listen for <code>layerPropertyChange</code> |
| notifications from the associated layer parent. When the |
| <code>effectiveAlpha</code> or <code>effectiveVisibility</code> of the |
| layer changes, the element must then compute its own effective visibility |
| (or alpha) and apply it accordingly.</p> |
| <p>This property should not be set within MXML directly.</p> |
| |
| <p>The <code>designLayer</code> property is not used for z-order control, |
| please see <code>depth</code>.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get designLayer():<a href="../../mx/core/DesignLayer.html">DesignLayer</a></code><br/><code> public function set designLayer(value:<a href="../../mx/core/DesignLayer.html">DesignLayer</a>):void</code><br/></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><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>document:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A reference to the document object associated with this UIComponent. |
| A document object is an Object at the top of the hierarchy of a |
| Flex application, MXML component, or AS component. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get document():Object</code><br/><code> public function set document(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="doubleClickEnabled"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">doubleClickEnabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>doubleClickEnabled:Boolean</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Specifies whether the UIComponent object receives <code>doubleClick</code> events. |
| The default value is <code>false</code>, which means that the UIComponent object |
| does not receive <code>doubleClick</code> events. |
| <p>The <code>mouseEnabled</code> property must also be set to <code>true</code>, |
| its default value, for the object to receive <code>doubleClick</code> events.</p> |
| </p><p> The default value is <code>false</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get doubleClickEnabled():Boolean</code><br/><code> public function set doubleClickEnabled(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="enabled"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">enabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>enabled:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Whether the component can accept user interaction. After setting the <code>enabled</code> |
| property to <code>false</code>, some components still respond to mouse interactions such |
| as mouseOver. As a result, to fully disable UIComponents, |
| you should also set the value of the <code>mouseEnabled</code> property to <code>false</code>. |
| If you set the <code>enabled</code> property to <code>false</code> |
| for a container, Flex dims the color of the container and of all |
| of its children, and blocks user input to the container |
| and to all of its children. |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get enabled():Boolean</code><br/><code> public function set enabled(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="errorString"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">errorString</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>errorString:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The text that displayed by a component's error tip when a |
| component is monitored by a Validator and validation fails. |
| <p>You can use the <code>errorString</code> property to show a |
| validation error for a component, without actually using a validator class. |
| When you write a String value to the <code>errorString</code> property, |
| Flex draws a red border around the component to indicate the validation error, |
| and the String appears in a tooltip as the validation error message when you move |
| the mouse over the component, just as if a validator detected a validation error.</p> |
| <p>To clear the validation error, write an empty String, "", |
| to the <code>errorString</code> property.</p> |
| <p>Note that writing a value to the <code>errorString</code> property |
| does not trigger the valid or invalid events; it only changes the border |
| color and displays the validation error message.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get errorString():String</code><br/><code> public function set errorString(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="explicitHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">explicitHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>explicitHeight:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Number that specifies the explicit height of the component, |
| in pixels, in the component's coordinates. |
| <p>This value is used by the container in calculating |
| the size and position of the component. |
| It is not used by the component itself in determining |
| its default size. |
| Thus this property may not have any effect if parented by |
| Container, or containers that don't factor in |
| this property. |
| Because the value is in component coordinates, |
| the true <code>explicitHeight</code> with respect to its parent |
| is affected by the <code>scaleY</code> property.</p> |
| <p>Setting the <code>height</code> property also sets this property to |
| the specified height value.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get explicitHeight():Number</code><br/><code> public function set explicitHeight(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="explicitMaxHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">explicitMaxHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>explicitMaxHeight:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The maximum recommended height of the component to be considered |
| by the parent during layout. This value is in the |
| component's coordinates, in pixels. |
| <p>Application developers typically do not set the explicitMaxHeight property. Instead, they |
| set the value of the maxHeight property, which sets the explicitMaxHeight property. The |
| value of maxHeight does not change.</p> |
| <p>At layout time, if maxHeight was explicitly set by the application developer, then |
| the value of explicitMaxHeight is used. Otherwise, the default value for maxHeight |
| is used.</p> |
| <p>This value is used by the container in calculating |
| the size and position of the component. |
| It is not used by the component itself in determining |
| its default size. |
| Thus this property may not have any effect if parented by |
| Container, or containers that don't factor in |
| this property. |
| Because the value is in component coordinates, |
| the true <code>maxHeight</code> with respect to its parent |
| is affected by the <code>scaleY</code> property. |
| Some components have no theoretical limit to their height. |
| In those cases their <code>maxHeight</code> is set to |
| <code>UIComponent.DEFAULT_MAX_HEIGHT</code>.</p> |
| </p><p> The default value is <code>NaN</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get explicitMaxHeight():Number</code><br/><code> public function set explicitMaxHeight(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="explicitMaxWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">explicitMaxWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>explicitMaxWidth:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The maximum recommended width of the component to be considered |
| by the parent during layout. This value is in the |
| component's coordinates, in pixels. |
| <p>Application developers typically do not set the explicitMaxWidth property. Instead, they |
| set the value of the maxWidth property, which sets the explicitMaxWidth property. The |
| value of maxWidth does not change.</p> |
| <p>At layout time, if maxWidth was explicitly set by the application developer, then |
| the value of explicitMaxWidth is used. Otherwise, the default value for maxWidth |
| is used.</p> |
| <p>This value is used by the container in calculating |
| the size and position of the component. |
| It is not used by the component itself in determining |
| its default size. |
| Thus this property may not have any effect if parented by |
| Container, or containers that don't factor in |
| this property. |
| Because the value is in component coordinates, |
| the true <code>maxWidth</code> with respect to its parent |
| is affected by the <code>scaleX</code> property. |
| Some components have no theoretical limit to their width. |
| In those cases their <code>maxWidth</code> is set to |
| <code>UIComponent.DEFAULT_MAX_WIDTH</code>.</p> |
| </p><p> The default value is <code>NaN</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get explicitMaxWidth():Number</code><br/><code> public function set explicitMaxWidth(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="explicitMinHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">explicitMinHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>explicitMinHeight:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The minimum recommended height of the component to be considered |
| by the parent during layout. This value is in the |
| component's coordinates, in pixels. |
| <p>Application developers typically do not set the explicitMinHeight property. Instead, they |
| set the value of the minHeight property, which sets the explicitMinHeight property. The |
| value of minHeight does not change.</p> |
| <p>At layout time, if minHeight was explicitly set by the application developer, then |
| the value of explicitMinHeight is used. Otherwise, the value of measuredMinHeight |
| is used.</p> |
| <p>This value is used by the container in calculating |
| the size and position of the component. |
| It is not used by the component itself in determining |
| its default size. |
| Thus this property may not have any effect if parented by |
| Container, or containers that don't factor in |
| this property. |
| Because the value is in component coordinates, |
| the true <code>minHeight</code> with respect to its parent |
| is affected by the <code>scaleY</code> property.</p> |
| </p><p> The default value is <code>NaN</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get explicitMinHeight():Number</code><br/><code> public function set explicitMinHeight(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="explicitMinWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">explicitMinWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>explicitMinWidth:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The minimum recommended width of the component to be considered |
| by the parent during layout. This value is in the |
| component's coordinates, in pixels. |
| <p>Application developers typically do not set the explicitMinWidth property. Instead, they |
| set the value of the minWidth property, which sets the explicitMinWidth property. The |
| value of minWidth does not change.</p> |
| <p>At layout time, if minWidth was explicitly set by the application developer, then |
| the value of explicitMinWidth is used. Otherwise, the value of measuredMinWidth |
| is used.</p> |
| <p>This value is used by the container in calculating |
| the size and position of the component. |
| It is not used by the component itself in determining |
| its default size. |
| Thus this property may not have any effect if parented by |
| Container, or containers that don't factor in |
| this property. |
| Because the value is in component coordinates, |
| the true <code>minWidth</code> with respect to its parent |
| is affected by the <code>scaleX</code> property.</p> |
| </p><p> The default value is <code>NaN</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get explicitMinWidth():Number</code><br/><code> public function set explicitMinWidth(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="explicitWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">explicitWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>explicitWidth:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Number that specifies the explicit width of the component, |
| in pixels, in the component's coordinates. |
| <p>This value is used by the container in calculating |
| the size and position of the component. |
| It is not used by the component itself in determining |
| its default size. |
| Thus this property may not have any effect if parented by |
| Container, or containers that don't factor in |
| this property. |
| Because the value is in component coordinates, |
| the true <code>explicitWidth</code> with respect to its parent |
| is affected by the <code>scaleX</code> property.</p> |
| <p>Setting the <code>width</code> property also sets this property to |
| the specified width value.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get explicitWidth():Number</code><br/><code> public function set explicitWidth(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="flexContextMenu"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">flexContextMenu</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>flexContextMenu:<a href="../../mx/controls/IFlexContextMenu.html">IFlexContextMenu</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The context menu for this UIComponent. |
| </p><p> The default value is <code>null</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get flexContextMenu():<a href="../../mx/controls/IFlexContextMenu.html">IFlexContextMenu</a></code><br/><code> public function set flexContextMenu(value:<a href="../../mx/controls/IFlexContextMenu.html">IFlexContextMenu</a>):void</code><br/></div><a name="propertyDetail"></a><a name="focusEnabled"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">focusEnabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>focusEnabled:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Indicates whether the component can receive focus when tabbed to. |
| You can set <code>focusEnabled</code> to <code>false</code> |
| when a UIComponent is used as a subcomponent of another component |
| so that the outer component becomes the focusable entity. |
| If this property is <code>false</code>, focus is transferred to |
| the first parent that has <code>focusEnable</code> |
| set to <code>true</code>. |
| <p>The default value is <code>true</code>, except for the |
| spark.components.Scroller component. |
| For that component, the default value is <code>false</code>.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get focusEnabled():Boolean</code><br/><code> public function set focusEnabled(value:Boolean):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/components/Scroller.html" target="">spark.components.Scroller</a></div></div><a name="propertyDetail"></a><a name="focusManager"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">focusManager</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>focusManager:<a href="../../mx/managers/IFocusManager.html">IFocusManager</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Gets the FocusManager that controls focus for this component |
| and its peers. |
| Each popup has its own focus loop and therefore its own instance |
| of a FocusManager. |
| To make sure you're talking to the right one, use this method. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get focusManager():<a href="../../mx/managers/IFocusManager.html">IFocusManager</a></code><br/><code> public function set focusManager(value:<a href="../../mx/managers/IFocusManager.html">IFocusManager</a>):void</code><br/></div><a name="propertyDetail"></a><a name="focusPane"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">focusPane</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>focusPane:Sprite</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The focus pane associated with this object. |
| An object has a focus pane when one of its children has focus. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get focusPane():Sprite</code><br/><code> public function set focusPane(value:Sprite):void</code><br/></div><a name="propertyDetail"></a><a name="hasComplexLayoutMatrix"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hasComplexLayoutMatrix</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>hasComplexLayoutMatrix:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Returns <code>true</code> if the UIComponent has any non-translation (x,y) transform properties. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> protected function get hasComplexLayoutMatrix():Boolean</code><br/></div><a name="propertyDetail"></a><a name="hasFocusableChildren"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hasFocusableChildren</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>hasFocusableChildren:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| A flag that indicates whether child objects can receive focus. |
| |
| <p><b>Note: </b>This property is similar to the <code>tabChildren</code> property |
| used by Flash Player. |
| Use the <code>hasFocusableChildren</code> property with Flex applications. |
| Do not use the <code>tabChildren</code> property.</p> |
| |
| <p>This property is usually <code>false</code> because most components |
| either receive focus themselves or delegate focus to a single |
| internal sub-component and appear as if the component has |
| received focus. |
| For example, a TextInput control contains a focusable |
| child RichEditableText control, but while the RichEditableText |
| sub-component actually receives focus, it appears as if the |
| TextInput has focus. TextInput sets <code>hasFocusableChildren</code> |
| to <code>false</code> because TextInput is considered the |
| component that has focus. Its internal structure is an |
| abstraction.</p> |
| <p>Usually only navigator components, such as TabNavigator and |
| Accordion, have this flag set to <code>true</code> because they |
| receive focus on Tab but focus goes to components in the child |
| containers on further Tabs.</p> |
| <p>The default value is <code>false</code>, except for the |
| spark.components.Scroller component. |
| For that component, the default value is <code>true</code>.</p> |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get hasFocusableChildren():Boolean</code><br/><code> public function set hasFocusableChildren(value:Boolean):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/components/Scroller.html" target="">spark.components.Scroller</a></div></div><a name="propertyDetail"></a><a name="hasLayoutMatrix3D"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hasLayoutMatrix3D</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>hasLayoutMatrix3D:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Contains <code>true</code> if the element has 3D Matrix. |
| <p>Use <code>hasLayoutMatrix3D</code> instead of calling and examining the |
| return value of <code>getLayoutMatrix3D()</code> because that method returns a valid |
| matrix even when the element is in 2D.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get hasLayoutMatrix3D():Boolean</code><br/></div><a name="propertyDetail"></a><a name="height"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">height</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>height:Number</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Number that specifies the height of the component, in pixels, |
| in the parent's coordinates. |
| The default value is 0, but this property contains the actual component |
| height after Flex completes sizing the components in your application. |
| <p>Note: You can specify a percentage value in the MXML |
| <code>height</code> attribute, such as <code>height="100%"</code>, |
| but you cannot use a percentage value for the <code>height</code> |
| property in ActionScript; |
| use the <code>percentHeight</code> property instead.</p> |
| <p>Setting this property causes a <code>resize</code> event to be dispatched. |
| See the <code>resize</code> event for details on when |
| this event is dispatched.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get height():Number</code><br/><code> public function set height(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="UIComponent.html#percentHeight" target="">percentHeight</a></div></div><a name="propertyDetail"></a><a name="horizontalCenter"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">horizontalCenter</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>horizontalCenter:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| <p>For components, this layout constraint property is a |
| facade on top of the similarly-named style. To set |
| the property to its default value of <code>undefined</code>, |
| use the @Clear() directive in MXML or the <code>undefined</code> |
| value in ActionScript code. For example, in MXML code, |
| <code>horizontalCenter.s2="@Clear()"</code> unsets the |
| <code>horizontalCenter</code> |
| constraint in state s2. Or in ActionScript code, |
| <code>button.horizontalCenter = undefined</code> unsets the |
| <code>horizontalCenter</code> constraint on <code>button</code>.</p> |
| |
| |
| The horizontal distance in pixels from the center of the component to the |
| center of the anchor target's content area. |
| <p>The default anchor target is the container itself.</p> |
| <p>In layouts with advanced constraints, the anchor target can be a constraint column. |
| Then the content area is the space between the preceding column |
| (or container side) and the target column.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format |
| "constraintColumnId:value". For example, "col1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get horizontalCenter():Object</code><br/><code> public function set horizontalCenter(value:Object):void</code><br/></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"> </td></tr></table><div class="detailBody"><code>id:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| ID of the component. This value becomes the instance name of the object |
| and should not contain any white space or special characters. Each component |
| throughout an application should have a unique id. |
| <p>If your application is going to be tested by third party tools, give each component |
| a meaningful id. Testing tools use ids to represent the control in their scripts and |
| having a meaningful name can make scripts more readable. For example, set the |
| value of a button to submit_button rather than b1 or button1.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get id():String</code><br/><code> public function set id(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="includeInLayout"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">includeInLayout</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>includeInLayout:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Specifies whether this component is included in the layout of the |
| parent container. |
| If <code>true</code>, the object is included in its parent container's |
| layout and is sized and positioned by its parent container as per its layout rules. |
| If <code>false</code>, the object size and position are not affected by its parent container's |
| layout. |
| |
| </p><p> The default value is <code>true</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get includeInLayout():Boolean</code><br/><code> public function set includeInLayout(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="inheritingStyles"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">inheritingStyles</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>inheritingStyles:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The beginning of this component's chain of inheriting styles. |
| The <code>getStyle()</code> method simply accesses |
| <code>inheritingStyles[styleName]</code> to search the entire |
| prototype-linked chain. |
| This object is set up by <code>initProtoChain()</code>. |
| Developers typically never need to access this property directly. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get inheritingStyles():Object</code><br/><code> public function set inheritingStyles(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="initialized"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initialized</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>initialized:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A flag that determines if an object has been through all three phases |
| of layout: commitment, measurement, and layout (provided that any were required). |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get initialized():Boolean</code><br/><code> public function set initialized(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="instanceIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">instanceIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>instanceIndex:int</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The index of a repeated component. |
| If the component is not within a Repeater, the value is -1. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get instanceIndex():int</code><br/></div><a name="propertyDetail"></a><a name="instanceIndices"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">instanceIndices</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>instanceIndices:Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| An Array containing the indices required to reference |
| this UIComponent object from its parent document. |
| The Array is empty unless this UIComponent object is within one or more Repeaters. |
| The first element corresponds to the outermost Repeater. |
| For example, if the id is "b" and instanceIndices is [2,4], |
| you would reference it on the parent document as b[2][4]. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get instanceIndices():Array</code><br/><code> public function set instanceIndices(value:Array):void</code><br/></div><a name="propertyDetail"></a><a name="is3D"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">is3D</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>is3D:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Contains <code>true</code> when the element is in 3D. |
| The element can be in 3D either because |
| it has 3D transform properties or it has 3D post layout transform offsets or both. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get is3D():Boolean</code><br/></div><a name="propertyDetail"></a><a name="isDocument"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">isDocument</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>isDocument:Boolean</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Contains <code>true</code> if this UIComponent instance is a document object. |
| That means it is at the top of the hierarchy of a Flex |
| application, MXML component, or ActionScript component. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get isDocument():Boolean</code><br/></div><a name="propertyDetail"></a><a name="isPopUp"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">isPopUp</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>isPopUp:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Set to <code>true</code> by the PopUpManager to indicate |
| that component has been popped up. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get isPopUp():Boolean</code><br/><code> public function set isPopUp(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="layoutMatrix3D"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">layoutMatrix3D</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>layoutMatrix3D:Matrix3D</code> [write-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| The transform matrix that is used to calculate a component's layout |
| relative to its siblings. This matrix is defined by the component's |
| 3D properties (which include the 2D properties such as <code>x</code>, |
| <code>y</code>, <code>rotation</code>, <code>scaleX</code>, |
| <code>scaleY</code>, <code>transformX</code>, and |
| <code>transformY</code>, as well as <code>rotationX</code>, |
| <code>rotationY</code>, <code>scaleZ</code>, <code>z</code>, and |
| <code>transformZ</code>. |
| |
| <p>Most components do not have any 3D transform properties set on them.</p> |
| |
| <p>This layout matrix is combined with the values of the |
| <code>postLayoutTransformOffsets</code> property to determine the |
| component's final, computed matrix.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function set layoutMatrix3D(value:Matrix3D):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="UIComponent.html#postLayoutTransformOffsets" target="">postLayoutTransformOffsets</a></div></div><a name="propertyDetail"></a><a name="left"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">left</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>left:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| <p>For components, this layout constraint property is a |
| facade on top of the similarly-named style. To set |
| a state-specific value of the property in MXML to its default |
| value of <code>undefined</code>, |
| use the @Clear() directive. For example, in MXML code, |
| <code>left.s2="@Clear()"</code> unsets the <code>left</code> |
| constraint in state s2. Or in ActionScript code, |
| <code>button.left = undefined</code> unsets the <code>left</code> |
| constraint on <code>button</code>.</p> |
| |
| |
| The horizontal distance in pixels from the left edge of the component to the |
| anchor target's left edge. |
| <p>By default the anchor target is the container's content area. In layouts |
| with advanced constraints, the target can be a constraint column.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format |
| "anchorTargetName:value". For example, "col1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get left():Object</code><br/><code> public function set left(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="maintainProjectionCenter"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">maintainProjectionCenter</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>maintainProjectionCenter:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| When true, the component keeps its projection matrix centered on the |
| middle of its bounding box. If no projection matrix is defined on the |
| component, one is added automatically. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get maintainProjectionCenter():Boolean</code><br/><code> public function set maintainProjectionCenter(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="maxHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">maxHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>maxHeight:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The maximum recommended height of the component to be considered |
| by the parent during layout. This value is in the |
| component's coordinates, in pixels. The default value of this property is |
| set by the component developer. |
| <p>The component developer uses this property to set an upper limit on the |
| height of the component.</p> |
| <p>If the application developer overrides the default value of maxHeight, |
| the new value is stored in explicitMaxHeight. The default value of maxHeight |
| does not change. As a result, at layout time, if |
| maxHeight was explicitly set by the application developer, then the value of |
| explicitMaxHeight is used for the component's maximum recommended height. |
| If maxHeight is not set explicitly by the user, then the default value is used.</p> |
| <p>This value is used by the container in calculating |
| the size and position of the component. |
| It is not used by the component itself in determining |
| its default size. |
| |
| Thus this property may not have any effect if parented by |
| Container, or containers that don't factor in |
| this property. |
| Because the value is in component coordinates, |
| the true <code>maxHeight</code> with respect to its parent |
| is affected by the <code>scaleY</code> property. |
| Some components have no theoretical limit to their height. |
| In those cases their <code>maxHeight</code> is set to |
| <code>UIComponent.DEFAULT_MAX_HEIGHT</code>.</p> |
| </p><p> The default value is <code>10000</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get maxHeight():Number</code><br/><code> public function set maxHeight(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="maxWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">maxWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>maxWidth:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The maximum recommended width of the component to be considered |
| by the parent during layout. This value is in the |
| component's coordinates, in pixels. The default value of this property is |
| set by the component developer. |
| <p>The component developer uses this property to set an upper limit on the |
| width of the component.</p> |
| <p>If the application developer overrides the default value of maxWidth, |
| the new value is stored in explicitMaxWidth. The default value of maxWidth |
| does not change. As a result, at layout time, if |
| maxWidth was explicitly set by the application developer, then the value of |
| explicitMaxWidth is used for the component's maximum recommended width. |
| If maxWidth is not set explicitly by the user, then the default value is used.</p> |
| <p>This value is used by the container in calculating |
| the size and position of the component. |
| It is not used by the component itself in determining |
| its default size. |
| Thus this property may not have any effect if parented by |
| Container, or containers that don't factor in |
| this property. |
| Because the value is in component coordinates, |
| the true <code>maxWidth</code> with respect to its parent |
| is affected by the <code>scaleX</code> property. |
| Some components have no theoretical limit to their width. |
| In those cases their <code>maxWidth</code> is set to |
| <code>UIComponent.DEFAULT_MAX_WIDTH</code>.</p> |
| </p><p> The default value is <code>10000</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get maxWidth():Number</code><br/><code> public function set maxWidth(value:Number):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"> </td></tr></table><div class="detailBody"><code>measuredHeight:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The default height of the component, in pixels. |
| This value is set by the <code>measure()</code> method. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get measuredHeight():Number</code><br/><code> public function set measuredHeight(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="measuredMinHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">measuredMinHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>measuredMinHeight:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The default minimum height of the component, in pixels. |
| This value is set by the <code>measure()</code> method. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get measuredMinHeight():Number</code><br/><code> public function set measuredMinHeight(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="measuredMinWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">measuredMinWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>measuredMinWidth:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The default minimum width of the component, in pixels. |
| This value is set by the <code>measure()</code> method. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get measuredMinWidth():Number</code><br/><code> public function set measuredMinWidth(value:Number):void</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"> </td></tr></table><div class="detailBody"><code>measuredWidth:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The default width of the component, in pixels. |
| This value is set by the <code>measure()</code> method. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get measuredWidth():Number</code><br/><code> public function set measuredWidth(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="minHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">minHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>minHeight:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The minimum recommended height of the component to be considered |
| by the parent during layout. This value is in the |
| component's coordinates, in pixels. The default value depends on |
| the component's implementation. |
| <p>If the application developer sets the value of minHeight, |
| the new value is stored in explicitMinHeight. The default value of minHeight |
| does not change. As a result, at layout time, if |
| minHeight was explicitly set by the application developer, then the value of |
| explicitMinHeight is used for the component's minimum recommended height. |
| If minHeight is not set explicitly by the application developer, then the value of |
| measuredMinHeight is used.</p> |
| <p>This value is used by the container in calculating |
| the size and position of the component. |
| It is not used by the component itself in determining |
| its default size. |
| Thus this property may not have any effect if parented by |
| Container, or containers that don't factor in |
| this property. |
| Because the value is in component coordinates, |
| the true <code>minHeight</code> with respect to its parent |
| is affected by the <code>scaleY</code> property.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get minHeight():Number</code><br/><code> public function set minHeight(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="minWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">minWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>minWidth:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The minimum recommended width of the component to be considered |
| by the parent during layout. This value is in the |
| component's coordinates, in pixels. The default value depends on |
| the component's implementation. |
| <p>If the application developer sets the value of minWidth, |
| the new value is stored in explicitMinWidth. The default value of minWidth |
| does not change. As a result, at layout time, if |
| minWidth was explicitly set by the application developer, then the value of |
| explicitMinWidth is used for the component's minimum recommended width. |
| If minWidth is not set explicitly by the application developer, then the value of |
| measuredMinWidth is used.</p> |
| <p>This value is used by the container in calculating |
| the size and position of the component. |
| It is not used by the component itself in determining |
| its default size. |
| Thus this property may not have any effect if parented by |
| Container, or containers that don't factor in |
| this property. |
| Because the value is in component coordinates, |
| the true <code>minWidth</code> with respect to its parent |
| is affected by the <code>scaleX</code> property.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get minWidth():Number</code><br/><code> public function set minWidth(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="moduleFactory"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">moduleFactory</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>moduleFactory:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A module factory is used as context for using embedded fonts and for |
| finding the style manager that controls the styles for this |
| component. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get moduleFactory():<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a></code><br/><code> public function set moduleFactory(value:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a>):void</code><br/></div><a name="propertyDetail"></a><a name="mouseFocusEnabled"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseFocusEnabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>mouseFocusEnabled:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Whether you can receive focus when clicked on. |
| If <code>false</code>, focus is transferred to |
| the first parent that is <code>mouseFocusEnable</code> |
| set to <code>true</code>. |
| For example, you can set this property to <code>false</code> |
| on a Button control so that you can use the Tab key to move focus |
| to the control, but not have the control get focus when you click on it. |
| <p>The default value is <code>true</code> for most subclasses, except the Spark TabBar. In that case, the default is <code>false</code>.</p> |
| </p><p> The default value is <code>true</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get mouseFocusEnabled():Boolean</code><br/><code> public function set mouseFocusEnabled(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="MXMLDescriptor"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">MXMLDescriptor</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>MXMLDescriptor:Array</code> [read-only] <p></p><br/><span class="label"> Implementation </span><br/><code> public function get MXMLDescriptor():Array</code><br/></div><a name="propertyDetail"></a><a name="MXMLProperties"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">MXMLProperties</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>MXMLProperties:Array</code> [read-only] <p></p><br/><span class="label"> Implementation </span><br/><code> public function get MXMLProperties():Array</code><br/></div><a name="propertyDetail"></a><a name="nestLevel"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">nestLevel</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>nestLevel:int</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Depth of this object in the containment hierarchy. |
| This number is used by the measurement and layout code. |
| The value is 0 if this component is not on the DisplayList. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get nestLevel():int</code><br/><code> public function set nestLevel(value:int):void</code><br/></div><a name="propertyDetail"></a><a name="nonInheritingStyles"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">nonInheritingStyles</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>nonInheritingStyles:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The beginning of this component's chain of non-inheriting styles. |
| The <code>getStyle()</code> method simply accesses |
| <code>nonInheritingStyles[styleName]</code> to search the entire |
| prototype-linked chain. |
| This object is set up by <code>initProtoChain()</code>. |
| Developers typically never need to access this property directly. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get nonInheritingStyles():Object</code><br/><code> public function set nonInheritingStyles(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="numAutomationChildren"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">numAutomationChildren</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>numAutomationChildren:int</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| The number of automation children this container has. |
| This sum should not include any composite children, though |
| it does include those children not significant within the |
| automation hierarchy. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get numAutomationChildren():int</code><br/></div><a name="propertyDetail"></a><a name="owner"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">owner</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>owner:DisplayObjectContainer</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The owner of this IVisualElement object. |
| By default, it is the parent of this IVisualElement object. |
| However, if this IVisualElement object is a child component that is |
| popped up by its parent, such as the drop-down list of a ComboBox control, |
| the owner is the component that popped up this IVisualElement object. |
| <p>This property is not managed by Flex, but by each component. |
| Therefore, if you use the <code>PopUpManger.createPopUp()</code> or |
| <code>PopUpManger.addPopUp()</code> method to pop up a child component, |
| you should set the <code>owner</code> property of the child component |
| to the component that popped it up.</p> |
| <p>The default value is the value of the <code>parent</code> property.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get owner():DisplayObjectContainer</code><br/><code> public function set owner(value:DisplayObjectContainer):void</code><br/></div><a name="propertyDetail"></a><a name="parent"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">parent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>parent:DisplayObjectContainer</code> [read-only] [override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The parent container or component for this component. |
| Only visual elements should have a <code>parent</code> property. |
| Non-visual items should use another property to reference |
| the object to which they belong. |
| By convention, non-visual objects use an <code>owner</code> |
| property to reference the object to which they belong. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get parent():DisplayObjectContainer</code><br/></div><a name="propertyDetail"></a><a name="parentApplication"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">parentApplication</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>parentApplication:Object</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A reference to the Application object that contains this UIComponent |
| instance. |
| This Application object might exist in a SWFLoader control in another |
| Application, and so on, creating a chain of Application objects that |
| can be walked using parentApplication. |
| <p>The <code>parentApplication</code> property of an Application is never itself; |
| it is either the Application into which it was loaded or null |
| (for the top-level Application).</p> |
| <p>Walking the application chain using the <code>parentApplication</code> |
| property is similar to walking the document chain using the |
| <code>parentDocument</code> property. |
| You can access the top-level application using the |
| <code>application</code> property of the Application class.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get parentApplication():Object</code><br/></div><a name="propertyDetail"></a><a name="parentDocument"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">parentDocument</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>parentDocument:Object</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A reference to the parent document object for this UIComponent. |
| A document object is a UIComponent at the top of the hierarchy |
| of a Flex application, MXML component, or AS component. |
| <p>For the Application object, the <code>parentDocument</code> |
| property is null. |
| This property is useful in MXML scripts to go up a level |
| in the chain of document objects. |
| It can be used to walk this chain using |
| <code>parentDocument.parentDocument</code>, and so on.</p> |
| <p>It is typed as Object so that authors can access properties |
| and methods on ancestor document objects without casting.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get parentDocument():Object</code><br/></div><a name="propertyDetail"></a><a name="percentHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">percentHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>percentHeight:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Specifies the height of a component as a percentage |
| of its parent's size. Allowed values are 0-100. The default value is NaN. |
| Setting the <code>height</code> or <code>explicitHeight</code> properties |
| resets this property to NaN. |
| <p>This property returns a numeric value only if the property was |
| previously set; it does not reflect the exact size of the component |
| in percent.</p> |
| <p>This property is always set to NaN for the UITextField control.</p> |
| |
| <p>When used with Spark layouts, this property is used to calculate the |
| height of the component's bounds after scaling and rotation. For example |
| if the component is rotated at 90 degrees, then specifying |
| <code>percentHeight</code> will affect the component's width.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get percentHeight():Number</code><br/><code> public function set percentHeight(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="percentWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">percentWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>percentWidth:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Specifies the width of a component as a percentage |
| of its parent's size. Allowed values are 0-100. The default value is NaN. |
| Setting the <code>width</code> or <code>explicitWidth</code> properties |
| resets this property to NaN. |
| <p>This property returns a numeric value only if the property was |
| previously set; it does not reflect the exact size of the component |
| in percent.</p> |
| <p>This property is always set to NaN for the UITextField control.</p> |
| |
| <p>When used with Spark layouts, this property is used to calculate the |
| width of the component's bounds after scaling and rotation. For example |
| if the component is rotated at 90 degrees, then specifying |
| <code>percentWidth</code> will affect the component's height.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get percentWidth():Number</code><br/><code> public function set percentWidth(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="postLayoutTransformOffsets"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">postLayoutTransformOffsets</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>postLayoutTransformOffsets:<a href="../../mx/geom/TransformOffsets.html">TransformOffsets</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| 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. |
| |
| <p>For example, if you want a layout to adjust for an object |
| that is rotated 90 degrees, set the object's |
| <code>rotation</code> property. If you want the layout to <i>not</i> |
| adjust for the object being rotated, |
| set its <code>postLayoutTransformOffsets.rotationZ</code> property.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get postLayoutTransformOffsets():<a href="../../mx/geom/TransformOffsets.html">TransformOffsets</a></code><br/><code> public function set postLayoutTransformOffsets(value:<a href="../../mx/geom/TransformOffsets.html">TransformOffsets</a>):void</code><br/></div><a name="propertyDetail"></a><a name="processedDescriptors"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">processedDescriptors</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>processedDescriptors:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Set to <code>true</code> after immediate or deferred child creation, |
| depending on which one happens. For a Container object, it is set |
| to <code>true</code> at the end of |
| the <code>createComponentsFromDescriptors()</code> method, |
| meaning after the Container object creates its children from its child descriptors. |
| <p>For example, if an Accordion container uses deferred instantiation, |
| the <code>processedDescriptors</code> property for the second pane of |
| the Accordion container does not become <code>true</code> until after |
| the user navigates to that pane and the pane creates its children. |
| But, if the Accordion had set the <code>creationPolicy</code> property |
| to <code>"all"</code>, the <code>processedDescriptors</code> property |
| for its second pane is set to <code>true</code> during application startup.</p> |
| <p>For classes that are not containers, which do not have descriptors, |
| it is set to <code>true</code> after the <code>createChildren()</code> |
| method creates any internal component children.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get processedDescriptors():Boolean</code><br/><code> public function set processedDescriptors(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="repeater"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">repeater</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>repeater:<a href="../../mx/core/IRepeater.html">IRepeater</a></code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A reference to the Repeater object |
| in the parent document that produced this UIComponent. |
| Use this property, rather than the <code>repeaters</code> property, |
| when the UIComponent is created by a single Repeater object. |
| Use the <code>repeaters</code> property when this UIComponent is created |
| by nested Repeater objects. |
| <p>The property is set to <code>null</code> when this UIComponent |
| is not created by a Repeater.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get repeater():<a href="../../mx/core/IRepeater.html">IRepeater</a></code><br/></div><a name="propertyDetail"></a><a name="repeaterIndex"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">repeaterIndex</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>repeaterIndex:int</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The index of the item in the data provider |
| of the Repeater that produced this UIComponent. |
| Use this property, rather than the <code>repeaterIndices</code> property, |
| when the UIComponent is created by a single Repeater object. |
| Use the <code>repeaterIndices</code> property when this UIComponent is created |
| by nested Repeater objects. |
| <p>This property is set to -1 when this UIComponent is |
| not created by a Repeater.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get repeaterIndex():int</code><br/></div><a name="propertyDetail"></a><a name="repeaterIndices"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">repeaterIndices</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>repeaterIndices:Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| An Array containing the indices of the items in the data provider |
| of the Repeaters in the parent document that produced this UIComponent. |
| The Array is empty unless this UIComponent is within one or more Repeaters. |
| <p>The first element in the Array corresponds to the outermost Repeater. |
| For example, if <code>repeaterIndices</code> is [2,4] it means that the |
| outer repeater used item <code>dataProvider[2]</code> and the inner repeater |
| used item <code>dataProvider[4]</code>.</p> |
| <p>Note that this property differs from the <code>instanceIndices</code> property |
| if the <code>startingIndex</code> property of any of the Repeaters is not 0. |
| For example, even if a Repeater starts at <code>dataProvider[4]</code>, |
| the document reference of the first repeated object is b[0], not b[4].</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get repeaterIndices():Array</code><br/><code> public function set repeaterIndices(value:Array):void</code><br/></div><a name="propertyDetail"></a><a name="repeaters"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">repeaters</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>repeaters:Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| An Array containing references to the Repeater objects |
| in the parent document that produced this UIComponent. |
| The Array is empty unless this UIComponent is within |
| one or more Repeaters. |
| The first element corresponds to the outermost Repeater object. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get repeaters():Array</code><br/><code> public function set repeaters(value:Array):void</code><br/></div><a name="propertyDetail"></a><a name="resourceManager"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">resourceManager</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>resourceManager:<a href="../../mx/resources/IResourceManager.html">IResourceManager</a></code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A reference to the object which manages |
| all of the application's localized resources. |
| This is a singleton instance which implements |
| the IResourceManager interface. |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> protected function get resourceManager():<a href="../../mx/resources/IResourceManager.html">IResourceManager</a></code><br/></div><a name="propertyDetail"></a><a name="right"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">right</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>right:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| <p>For components, this layout constraint property is a |
| facade on top of the similarly-named style. To set |
| the property to its default value of <code>undefined</code>, |
| use the @Clear() directive in MXML or the <code>undefined</code> |
| value in ActionScript code. For example, in MXML code, |
| <code>right.s2="@Clear()"</code> unsets the <code>right</code> |
| constraint in state s2. Or in ActionScript code, |
| <code>button.right = undefined</code> unsets the <code>right</code> |
| constraint on <code>button</code>.</p> |
| |
| |
| The horizontal distance in pixels from the right edge of the component to the |
| anchor target's right edge. |
| <p>By default the anchor target is the container's content area. In layouts |
| with advanced constraints, the target can be a constraint column.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format |
| "anchorTargetName:value". For example, "col1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get right():Object</code><br/><code> public function set right(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="rotation"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rotation</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>rotation:Number</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><br/><span class="label"> Implementation </span><br/><code> public function get rotation():Number</code><br/><code> public function set rotation(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="rotationX"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rotationX</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>rotationX:Number</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation |
| relative to the 3D parent container. Values from 0 to 180 represent clockwise rotation; values |
| from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from |
| 360 to obtain a value within the range. |
| |
| This property is ignored during calculation by any of Flex's 2D layouts. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get rotationX():Number</code><br/><code> public function set rotationX(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="rotationY"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rotationY</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>rotationY:Number</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation |
| relative to the 3D parent container. Values from 0 to 180 represent clockwise rotation; values |
| from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from |
| 360 to obtain a value within the range. |
| |
| This property is ignored during calculation by any of Flex's 2D layouts. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get rotationY():Number</code><br/><code> public function set rotationY(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="rotationZ"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rotationZ</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>rotationZ:Number</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get rotationZ():Number</code><br/><code> public function set rotationZ(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="scaleX"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scaleX</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>scaleX:Number</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Number that specifies the horizontal scaling factor. |
| <p>The default value is 1.0, which means that the object |
| is not scaled. |
| A <code>scaleX</code> of 2.0 means the object has been |
| magnified by a factor of 2, and a <code>scaleX</code> of 0.5 |
| means the object has been reduced by a factor of 2.</p> |
| <p>A value of 0.0 is an invalid value. |
| Rather than setting it to 0.0, set it to a small value, or set |
| the <code>visible</code> property to <code>false</code> to hide the component.</p> |
| </p><p> The default value is <code>1.0</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get scaleX():Number</code><br/><code> public function set scaleX(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="scaleY"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scaleY</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>scaleY:Number</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Number that specifies the vertical scaling factor. |
| <p>The default value is 1.0, which means that the object |
| is not scaled. |
| A <code>scaleY</code> of 2.0 means the object has been |
| magnified by a factor of 2, and a <code>scaleY</code> of 0.5 |
| means the object has been reduced by a factor of 2.</p> |
| <p>A value of 0.0 is an invalid value. |
| Rather than setting it to 0.0, set it to a small value, or set |
| the <code>visible</code> property to <code>false</code> to hide the component.</p> |
| </p><p> The default value is <code>1.0</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get scaleY():Number</code><br/><code> public function set scaleY(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="scaleZ"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">scaleZ</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>scaleZ:Number</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Number that specifies the scaling factor along the z axis. |
| <p>A scaling along the z axis does not affect a typical component, which lies flat |
| in the z=0 plane. components with children that have 3D transforms applied, or |
| components with a non-zero transformZ, is affected.</p> |
| |
| <p>The default value is 1.0, which means that the object |
| is not scaled.</p> |
| |
| <p>This property is ignored during calculation by any of Flex's 2D layouts. </p> |
| </p><p> The default value is <code>1.0</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get scaleZ():Number</code><br/><code> public function set scaleZ(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="screen"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">screen</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>screen:Rectangle</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns an object that contains the size and position of the base |
| drawing surface for this object. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get screen():Rectangle</code><br/></div><a name="propertyDetail"></a><a name="showInAutomationHierarchy"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">showInAutomationHierarchy</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>showInAutomationHierarchy:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| A flag that determines if an automation object |
| shows in the automation hierarchy. |
| Children of containers that are not visible in the hierarchy |
| appear as children of the next highest visible parent. |
| Typically containers used for layout, such as boxes and Canvas, |
| do not appear in the hierarchy. |
| <p>Some controls force their children to appear |
| in the hierarchy when appropriate. |
| For example a List will always force item renderers, |
| including boxes, to appear in the hierarchy. |
| Implementers must support setting this property |
| to <code>true</code>.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get showInAutomationHierarchy():Boolean</code><br/><code> public function set showInAutomationHierarchy(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="states"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">states</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>states:Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The view states that are defined for this component. |
| You can specify the <code>states</code> property only on the root |
| of the application or on the root tag of an MXML component. |
| The compiler generates an error if you specify it on any other control. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get states():Array</code><br/><code> public function set states(value:Array):void</code><br/></div><a name="propertyDetail"></a><a name="styleDeclaration"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">styleDeclaration</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>styleDeclaration:<a href="../../mx/styles/CSSStyleDeclaration.html">CSSStyleDeclaration</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Storage for the inline inheriting styles on this object. |
| This CSSStyleDeclaration is created the first time that |
| the <code>setStyle()</code> method |
| is called on this component to set an inheriting style. |
| Developers typically never need to access this property directly. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get styleDeclaration():<a href="../../mx/styles/CSSStyleDeclaration.html">CSSStyleDeclaration</a></code><br/><code> public function set styleDeclaration(value:<a href="../../mx/styles/CSSStyleDeclaration.html">CSSStyleDeclaration</a>):void</code><br/></div><a name="propertyDetail"></a><a name="styleManager"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">styleManager</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>styleManager:<a href="../../mx/styles/IStyleManager2.html">IStyleManager2</a></code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Returns the StyleManager instance used by this component. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get styleManager():<a href="../../mx/styles/IStyleManager2.html">IStyleManager2</a></code><br/></div><a name="propertyDetail"></a><a name="styleName"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">styleName</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>styleName:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The class style used by this component. This can be a String, CSSStyleDeclaration |
| or an IStyleClient. |
| <p>If this is a String, it is the name of one or more whitespace delimited class |
| declarations in an <code><fx:Style></code> tag or CSS file. You do not include the period |
| in the <code>styleName</code>. For example, if you have a class style named <code>".bigText"</code>, |
| set the <code>styleName</code> property to <code>"bigText"</code> (no period).</p> |
| <p>If this is an IStyleClient (typically a UIComponent), all styles in the |
| <code>styleName</code> object are used by this component.</p> |
| </p><p> The default value is <code>null</code>.</p><br/><span class="label"> Implementation </span><br/><code> public function get styleName():Object</code><br/><code> public function set styleName(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="styleParent"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">styleParent</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>styleParent:<a href="../../mx/styles/IAdvancedStyleClient.html">IAdvancedStyleClient</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A component's parent is used to evaluate descendant selectors. A parent |
| must also be an IAdvancedStyleClient to participate in advanced style |
| declarations. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get styleParent():<a href="../../mx/styles/IAdvancedStyleClient.html">IAdvancedStyleClient</a></code><br/><code> public function set styleParent(value:<a href="../../mx/styles/IAdvancedStyleClient.html">IAdvancedStyleClient</a>):void</code><br/></div><a name="propertyDetail"></a><a name="systemManager"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">systemManager</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>systemManager:<a href="../../mx/managers/ISystemManager.html">ISystemManager</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns the SystemManager object used by this component. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get systemManager():<a href="../../mx/managers/ISystemManager.html">ISystemManager</a></code><br/><code> public function set systemManager(value:<a href="../../mx/managers/ISystemManager.html">ISystemManager</a>):void</code><br/></div><a name="propertyDetail"></a><a name="tabFocusEnabled"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">tabFocusEnabled</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>tabFocusEnabled:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| A flag that indicates whether this object can receive focus |
| via the TAB key |
| |
| <p>This is similar to the <code>tabEnabled</code> property |
| used by the Flash Player.</p> |
| |
| <p>This is usually <code>true</code> for components that |
| handle keyboard input, but some components in controlbars |
| have them set to <code>false</code> because they should not steal |
| focus from another component like an editor. |
| </p> |
| </p><p> The default value is <code>true</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get tabFocusEnabled():Boolean</code><br/><code> public function set tabFocusEnabled(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="toolTip"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toolTip</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>toolTip:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Text to display in the ToolTip. |
| </p><p> The default value is <code>null</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get toolTip():String</code><br/><code> public function set toolTip(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="top"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">top</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>top:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| <p>For components, this layout constraint property is a |
| facade on top of the similarly-named style. To set |
| the property to its default value of <code>undefined</code>, |
| use the @Clear() directive in MXML or the <code>undefined</code> |
| value in ActionScript code. For example, in MXML code, |
| <code>top.s2="@Clear()"</code> unsets the <code>top</code> |
| constraint in state s2. Or in ActionScript code, |
| <code>button.top = undefined</code> unsets the <code>top</code> |
| constraint on <code>button</code>.</p> |
| |
| |
| The vertical distance in pixels from the top edge of the component to the |
| anchor target's top edge. |
| <p>By default the anchor target is the container's content area. In layouts |
| with advanced constraints, the target can be a constraint row.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format |
| "anchorTargetName:value". For example, "row1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get top():Object</code><br/><code> public function set top(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="transform"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transform</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>transform:Transform</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| An object with properties pertaining to a display object's matrix, color transform, |
| and pixel bounds. The specific properties — matrix, colorTransform, and three read-only |
| properties (<code>concatenatedMatrix</code>, <code>concatenatedColorTransform</code>, and <code>pixelBounds</code>) — |
| are described in the entry for the <code>Transform</code> class. |
| |
| <p>Each of the transform object's properties is itself an object. This concept is |
| important because the only way to set new values for the matrix or colorTransform |
| objects is to create a new object and copy that object into the transform.matrix or |
| transform.colorTransform property.</p> |
| |
| <p>For example, to increase the tx value of a display object's matrix, you must make a copy |
| of the entire matrix object, then copy the new object into the matrix property of the |
| transform object:</p> |
| <pre> |
| var myMatrix:Matrix = myUIComponentObject.transform.matrix; |
| myMatrix.tx += 10; |
| myUIComponent.transform.matrix = myMatrix; |
| </pre> |
| |
| You cannot directly set the tx property. The following code has no effect on myUIComponent: |
| |
| <pre> |
| myUIComponent.transform.matrix.tx += 10; |
| </pre> |
| <p>Note that for <code>UIComponent</code>, unlike <code>DisplayObject</code>, the <code>transform</code> |
| keeps the <code>matrix</code> and <code>matrix3D</code> values in sync and <code>matrix3D</code> is not null |
| even when the component itself has no 3D properties set. Developers should use the <code>is3D</code> property |
| to check if the component has 3D propertis set. If the component has 3D properties, the transform's |
| <code>matrix3D</code> should be used instead of transform's <code>matrix</code>.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get transform():Transform</code><br/><code> public function set transform(value:Transform):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="UIComponent.html#setLayoutMatrix" target="">setLayoutMatrix</a><br/><a href="UIComponent.html#setLayoutMatrix3D" target="">setLayoutMatrix3D</a><br/><a href="UIComponent.html#getLayoutMatrix" target="">getLayoutMatrix</a><br/><a href="UIComponent.html#getLayoutMatrix3D" target="">getLayoutMatrix3D</a><br/><a href="UIComponent.html#is3D" target="">is3D</a><br/><a href="../../mx/geom/Transform.html" target="">mx.geom.Transform</a></div></div><a name="propertyDetail"></a><a name="transformX"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transformX</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>transformX:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Sets the x coordinate for the transform center of the component. |
| |
| <p>When this component is the target of a Spark transform effect, |
| you can override this property by setting |
| the <code>AnimateTransform.autoCenterTransform</code> property. |
| If <code>autoCenterTransform</code> is <code>false</code>, the transform |
| center is determined by the <code>transformX</code>, |
| <code>transformY</code>, and <code>transformZ</code> properties |
| of the effect target. |
| If <code>autoCenterTransform</code> is <code>true</code>, |
| the effect occurs around the center of the target, |
| <code>(width/2, height/2)</code>.</p> |
| <p>Setting this property on the Spark effect class |
| overrides the setting on the target component.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get transformX():Number</code><br/><code> public function set transformX(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/effects/AnimateTransform.html#autoCenterTransform" target="">spark.effects.AnimateTransform.autoCenterTransform</a><br/><a href="../../spark/effects/AnimateTransform.html#transformX" target="">spark.effects.AnimateTransform.transformX</a></div></div><a name="propertyDetail"></a><a name="transformY"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transformY</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>transformY:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Sets the y coordinate for the transform center of the component. |
| |
| <p>When this component is the target of a Spark transform effect, |
| you can override this property by setting |
| the <code>AnimateTransform.autoCenterTransform</code> property. |
| If <code>autoCenterTransform</code> is <code>false</code>, the transform |
| center is determined by the <code>transformX</code>, |
| <code>transformY</code>, and <code>transformZ</code> properties |
| of the effect target. |
| If <code>autoCenterTransform</code> is <code>true</code>, |
| the effect occurs around the center of the target, |
| <code>(width/2, height/2)</code>.</p> |
| <p>Seeting this property on the Spark effect class |
| overrides the setting on the target component.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get transformY():Number</code><br/><code> public function set transformY(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/effects/AnimateTransform.html#autoCenterTransform" target="">spark.effects.AnimateTransform.autoCenterTransform</a><br/><a href="../../spark/effects/AnimateTransform.html#transformY" target="">spark.effects.AnimateTransform.transformY</a></div></div><a name="propertyDetail"></a><a name="transformZ"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transformZ</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>transformZ:Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Sets the z coordinate for the transform center of the component. |
| |
| <p>When this component is the target of a Spark transform effect, |
| you can override this property by setting |
| the <code>AnimateTransform.autoCenterTransform</code> property. |
| If <code>autoCenterTransform</code> is <code>false</code>, the transform |
| center is determined by the <code>transformX</code>, |
| <code>transformY</code>, and <code>transformZ</code> properties |
| of the effect target. |
| If <code>autoCenterTransform</code> is <code>true</code>, |
| the effect occurs around the center of the target, |
| <code>(width/2, height/2)</code>.</p> |
| <p>Seeting this property on the Spark effect class |
| overrides the setting on the target component.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get transformZ():Number</code><br/><code> public function set transformZ(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../spark/effects/AnimateTransform.html#autoCenterTransform" target="">spark.effects.AnimateTransform.autoCenterTransform</a><br/><a href="../../spark/effects/AnimateTransform.html#transformZ" target="">spark.effects.AnimateTransform.transformZ</a></div></div><a name="propertyDetail"></a><a name="transitions"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transitions</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>transitions:Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| An Array of Transition objects, where each Transition object defines a |
| set of effects to play when a view state change occurs. |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get transitions():Array</code><br/><code> public function set transitions(value:Array):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/states/Transition.html" target="">mx.states.Transition</a></div></div><a name="propertyDetail"></a><a name="tweeningProperties"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">tweeningProperties</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>tweeningProperties:Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Array of properties that are currently being tweened on this object. |
| <p>Used to alert the EffectManager that certain properties of this object |
| are being tweened, so that the EffectManger doesn't attempt to animate |
| the same properties.</p> |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get tweeningProperties():Array</code><br/><code> public function set tweeningProperties(value:Array):void</code><br/></div><a name="propertyDetail"></a><a name="uid"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">uid</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>uid:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A unique identifier for the object. |
| Flex data-driven controls, including all controls that are |
| subclasses of List class, use a UID to track data provider items. |
| <p>Flex can automatically create and manage UIDs. |
| However, there are circumstances when you must supply your own |
| <code>uid</code> property by implementing the IUID interface, |
| or when supplying your own <code>uid</code> property improves processing efficiency. |
| UIDs do not need to be universally unique for most uses in Flex. |
| One exception is for messages sent by data services.</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get uid():String</code><br/><code> public function set uid(value:String):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="IUID.html" target="">IUID</a><br/><a href="../../mx/utils/UIDUtil.html" target="">mx.utils.UIDUtil</a></div></div><a name="propertyDetail"></a><a name="unscaledHeight"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">unscaledHeight</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>unscaledHeight:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A convenience method for determining the unscaled height |
| of the component. |
| All of a component's drawing and child layout should be done |
| within a bounding rectangle of this height, which is also passed |
| as an argument to <code>updateDisplayList()</code>. |
| </p><br/><span class="label"> Implementation </span><br/><code> protected function get unscaledHeight():Number</code><br/></div><a name="propertyDetail"></a><a name="unscaledWidth"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">unscaledWidth</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>unscaledWidth:Number</code> [read-only] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A convenience method for determining the unscaled width |
| of the component |
| All of a component's drawing and child layout should be done |
| within a bounding rectangle of this width, which is also passed |
| as an argument to <code>updateDisplayList()</code>. |
| </p><br/><span class="label"> Implementation </span><br/><code> protected function get unscaledWidth():Number</code><br/></div><a name="propertyDetail"></a><a name="updateCompletePendingFlag"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">updateCompletePendingFlag</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>updateCompletePendingFlag:Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A flag that determines if an object has been through all three phases |
| of layout validation (provided that any were required). |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get updateCompletePendingFlag():Boolean</code><br/><code> public function set updateCompletePendingFlag(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="validationSubField"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">validationSubField</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>validationSubField:String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Used by a validator to associate a subfield with this component. |
| |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get validationSubField():String</code><br/><code> public function set validationSubField(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="verticalCenter"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">verticalCenter</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>verticalCenter:Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| <p>For components, this layout constraint property is a |
| facade on top of the similarly-named style. To set |
| the property to its default value of <code>undefined</code>, |
| use the @Clear() directive in MXML or the <code>undefined</code> |
| value in ActionScript code. For example, in MXML code, |
| <code>verticalCenter.s2="@Clear()"</code> unsets the <code>verticalCenter</code> |
| constraint in state s2. Or in ActionScript code, |
| <code>button.verticalCenter = undefined</code> unsets the <code>verticalCenter</code> |
| constraint on <code>button</code>.</p> |
| |
| |
| The vertical distance in pixels from the center of the component to the |
| center of the anchor target's content area. |
| <p>The default anchor target is the container itself.</p> |
| <p>In layouts with advanced constraints, the anchor target can be a constraint row. |
| Then the content area is the space between the preceding row |
| (or container side) and the target row.</p> |
| <p>Setting the property to a number or to a numerical string like "10" |
| specifies use of the default anchor target.</p> |
| <p>To specify an anchor target, set the property value to a string in the format |
| "constraintColumnId:value". For example, "row1:10".</p> |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get verticalCenter():Object</code><br/><code> public function set verticalCenter(value:Object):void</code><br/></div><a name="propertyDetail"></a><a name="visible"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">visible</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>visible:Boolean</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Whether or not the display object is visible. |
| Display objects that are not visible are disabled. |
| For example, if <code>visible=false</code> for an InteractiveObject instance, |
| it cannot be clicked. |
| <p>When setting to <code>true</code>, the object dispatches |
| a <code>show</code> event. |
| When setting to <code>false</code>, the object dispatches |
| a <code>hide</code> event. |
| In either case the children of the object does not emit a |
| <code>show</code> or <code>hide</code> event unless the object |
| has specifically written an implementation to do so.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get visible():Boolean</code><br/><code> public function set visible(value:Boolean):void</code><br/></div><a name="propertyDetail"></a><a name="width"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">width</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>width:Number</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Number that specifies the width of the component, in pixels, |
| in the parent's coordinates. |
| The default value is 0, but this property contains the actual component |
| width after Flex completes sizing the components in your application. |
| <p>Note: You can specify a percentage value in the MXML |
| <code>width</code> attribute, such as <code>width="100%"</code>, |
| but you cannot use a percentage value in the <code>width</code> |
| property in ActionScript. |
| Use the <code>percentWidth</code> property instead.</p> |
| <p>Setting this property causes a <code>resize</code> event to |
| be dispatched. |
| See the <code>resize</code> event for details on when |
| this event is dispatched.</p> |
| |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get width():Number</code><br/><code> public function set width(value:Number):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="UIComponent.html#percentWidth" target="">percentWidth</a></div></div><a name="propertyDetail"></a><a name="x"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">x</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>x:Number</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Number that specifies the component's horizontal position, |
| in pixels, within its parent container. |
| <p>Setting this property directly or calling <code>move()</code> |
| has no effect -- or only a temporary effect -- if the |
| component is parented by a layout container such as HBox, Grid, |
| or Form, because the layout calculations of those containers |
| set the <code>x</code> position to the results of the calculation. |
| However, the <code>x</code> property must almost always be set |
| when the parent is a Canvas or other absolute-positioning |
| container because the default value is 0.</p> |
| </p><p> The default value is <code>0</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get x():Number</code><br/><code> public function set x(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="y"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">y</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>y:Number</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Number that specifies the component's vertical position, |
| in pixels, within its parent container. |
| <p>Setting this property directly or calling <code>move()</code> |
| has no effect -- or only a temporary effect -- if the |
| component is parented by a layout container such as HBox, Grid, |
| or Form, because the layout calculations of those containers |
| set the <code>x</code> position to the results of the calculation. |
| However, the <code>x</code> property must almost always be set |
| when the parent is a Canvas or other absolute-positioning |
| container because the default value is 0.</p> |
| </p><p> The default value is <code>0</code>.</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get y():Number</code><br/><code> public function set y(value:Number):void</code><br/></div><a name="propertyDetail"></a><a name="z"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">z</td><td class="detailHeaderType">property</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>z:Number</code>[override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| </p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code> public function get z():Number</code><br/><code> public function set z(value:Number):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="UIComponent()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">UIComponent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function UIComponent()</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p> |
| Constructor. |
| |
| </p></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="addMXMLChildren()"></a><a name="addMXMLChildren(Array)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addMXMLChildren</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> protected function addMXMLChildren(comps:Array):void</code><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">comps</span>:Array</code></td></tr></table></p></div><a name="addStyleClient()"></a><a name="addStyleClient(mx.styles.IAdvancedStyleClient)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addStyleClient</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function addStyleClient(styleClient:<a href="../../mx/styles/IAdvancedStyleClient.html">IAdvancedStyleClient</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Adds a non-visual style client to this component instance. Once |
| this method has been called, the style client will inherit style |
| changes from this component instance. Style clients that are |
| DisplayObjects must use the <code>addChild</code> or |
| <code>addChildAt</code> methods to be added to a |
| <code>UIComponent</code>. |
| |
| As a side effect, this method will set the <code>styleParent</code> |
| property of the <code>styleClient</code> parameter to reference |
| this instance of the <code>UIComponent</code>. |
| |
| If the <code>styleClient</code> parameter already has a |
| <code>styleParent</code>, this method will call |
| <code>removeStyleClient</code> from this previous |
| <code>styleParent</code>. |
| |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">styleClient</span>:<a href="../../mx/styles/IAdvancedStyleClient.html">IAdvancedStyleClient</a></code> — The <code>IAdvancedStyleClient</code> to |
| add to this component's list of non-visual style clients. |
| |
| </td></tr></table></p><br/><span class="label">Throws</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>ArgumentError </code> — if the <code>styleClient</code> parameter |
| is a <code>DisplayObject</code>. |
| |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">removeStyleClient<br/><a href="../../mx/styles/IAdvancedStyleClient.html" target="">mx.styles.IAdvancedStyleClient</a></div></div><a name="adjustFocusRect()"></a><a name="adjustFocusRect(flash.display.DisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">adjustFocusRect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function adjustFocusRect(obj:DisplayObject = null):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Adjust the focus rectangle. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">obj</span>:DisplayObject</code> (default = <code>null</code>)<code></code> — component whose focus rectangle to modify. |
| If omitted, the default value is this UIComponent object. |
| |
| </td></tr></table></p></div><a name="applyComputedMatrix()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">applyComputedMatrix</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function applyComputedMatrix():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Commits the computed matrix built from the combination of the layout |
| matrix and the transform offsets to the flash displayObject's transform. |
| |
| </p></div><a name="attachOverlay()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">attachOverlay</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function attachOverlay():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| This is an internal method used by the Flex framework |
| to support the Dissolve effect. |
| You do not have to call it or override it. |
| |
| </p></div><a name="callLater()"></a><a name="callLater(Function,Array)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">callLater</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function callLater(method:Function, args:Array = null):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Queues a function to be called later. |
| <p>Before each update of the screen, Flash Player or AIR calls |
| the set of functions that are scheduled for the update. |
| Sometimes, a function should be called in the next update |
| to allow the rest of the code scheduled for the current |
| update to be executed. |
| Some features, like effects, can cause queued functions to be |
| delayed until the feature completes.</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">method</span>:Function</code> — Reference to a method to be executed later. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">args</span>:Array</code> (default = <code>null</code>)<code></code> — Array of Objects that represent the arguments to pass to the method. |
| |
| </td></tr></table></p></div><a name="canSkipMeasurement()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">canSkipMeasurement</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function canSkipMeasurement():Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Determines if the call to the <code>measure()</code> method can be skipped. |
| |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — Returns <code>true</code> when the <code>measureSizes()</code> method can skip the call to |
| the <code>measure()</code> method. For example this is usually <code>true</code> when both <code>explicitWidth</code> and |
| <code>explicitHeight</code> are set. For paths, this is <code>true</code> when the bounds of the path |
| have not changed. |
| |
| </td></tr></table></div><a name="childrenCreated()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">childrenCreated</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function childrenCreated():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Performs any final processing after child objects are created. |
| This is an advanced method that you might override |
| when creating a subclass of UIComponent. |
| |
| </p></div><a name="clearStyle()"></a><a name="clearStyle(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">clearStyle</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function clearStyle(styleProp:String):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Deletes a style property from this component instance. |
| <p>This does not necessarily cause the <code>getStyle()</code> method |
| to return <code>undefined</code>.</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">styleProp</span>:String</code> — The name of the style property. |
| |
| </td></tr></table></p></div><a name="commitProperties()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">commitProperties</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function commitProperties():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Processes the properties set on the component. |
| This is an advanced method that you might override |
| when creating a subclass of UIComponent. |
| <p>You do not call this method directly. |
| Flex calls the <code>commitProperties()</code> method when you |
| use the <code>addChild()</code> method to add a component to a container, |
| or when you call the <code>invalidateProperties()</code> method of the component. |
| Calls to the <code>commitProperties()</code> method occur before calls to the |
| <code>measure()</code> method. This lets you set property values that might |
| be used by the <code>measure()</code> method.</p> |
| <p>Some components have properties that affect the number or kinds |
| of child objects that they need to create, or have properties that |
| interact with each other, such as the <code>horizontalScrollPolicy</code> |
| and <code>horizontalScrollPosition</code> properties. |
| It is often best at startup time to process all of these |
| properties at one time to avoid duplicating work.</p> |
| |
| </p></div><a name="contentToGlobal()"></a><a name="contentToGlobal(flash.geom.Point)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">contentToGlobal</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function contentToGlobal(point:Point):Point</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Converts a <code>Point</code> object from content coordinates to global coordinates. |
| Content coordinates specify a pixel position relative to the upper left corner |
| of the component's content, and include all of the component's content area, |
| including any regions that are currently clipped and must be |
| accessed by scrolling the component. |
| You use the content coordinate system to set and get the positions of children |
| of a container that uses absolute positioning. |
| Global coordinates specify a pixel position relative to the upper-left corner |
| of the stage, that is, the outermost edge of the application. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">point</span>:Point</code> — A Point object that |
| specifies the <i>x</i> and <i>y</i> coordinates in the content coordinate system |
| as properties. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Point</code> — A Point object with coordinates relative to the Stage. |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="UIComponent.html#globalToContent()" target="">globalToContent()</a></div></div><a name="contentToLocal()"></a><a name="contentToLocal(flash.geom.Point)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">contentToLocal</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function contentToLocal(point:Point):Point</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Converts a <code>Point</code> object from content to local coordinates. |
| Content coordinates specify a pixel position relative to the upper left corner |
| of the component's content, and include all of the component's content area, |
| including any regions that are currently clipped and must be |
| accessed by scrolling the component. |
| You use the content coordinate system to set and get the positions of children |
| of a container that uses absolute positioning. |
| Local coordinates specify a pixel position relative to the |
| upper left corner of the component. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">point</span>:Point</code> — A Point object that specifies the <i>x</i> and <i>y</i> |
| coordinates in the content coordinate system as properties. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Point</code> — Point A Point object with coordinates relative to the |
| local coordinate system. |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="UIComponent.html#contentToGlobal()" target="">contentToGlobal()</a></div></div><a name="createAutomationIDPart()"></a><a name="createAutomationIDPart(mx.automation.IAutomationObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createAutomationIDPart</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function createAutomationIDPart(child:<a href="../../mx/automation/IAutomationObject.html">IAutomationObject</a>):Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Returns a set of properties that identify the child within |
| this container. These values should not change during the |
| lifespan of the application. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">child</span>:<a href="../../mx/automation/IAutomationObject.html">IAutomationObject</a></code> — Child for which to provide the id. |
| |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Object</code> — Sets of properties describing the child which can |
| later be used to resolve the component. |
| |
| </td></tr></table></div><a name="createAutomationIDPartWithRequiredProperties()"></a><a name="createAutomationIDPartWithRequiredProperties(mx.automation.IAutomationObject,Array)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createAutomationIDPartWithRequiredProperties</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function createAutomationIDPartWithRequiredProperties(child:<a href="../../mx/automation/IAutomationObject.html">IAutomationObject</a>, properties:Array):Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns a set of properties as automation IDs that identify the child within |
| this container. These values should not change during the |
| lifespan of the application |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">child</span>:<a href="../../mx/automation/IAutomationObject.html">IAutomationObject</a></code> — Child for which to provide the id. |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">properties</span>:Array</code> — which needs to be considered for forming the Id. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Object</code> — Sets of properties describing the child which can |
| later be used to resolve the component. |
| |
| </td></tr></table></div><a name="createChildren()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createChildren</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function createChildren():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Create child objects of the component. |
| This is an advanced method that you might override |
| when creating a subclass of UIComponent. |
| <p>A component that creates other components or objects within it is called a composite component. |
| For example, the Flex ComboBox control is actually made up of a TextInput control |
| to define the text area of the ComboBox, and a Button control to define the ComboBox arrow. |
| Components implement the <code>createChildren()</code> method to create child |
| objects (such as other components) within the component.</p> |
| <p>From within an override of the <code>createChildren()</code> method, |
| you call the <code>addChild()</code> method to add each child object. </p> |
| <p>You do not call this method directly. Flex calls the |
| <code>createChildren()</code> method in response to the call to |
| the <code>addChild()</code> method to add the component to its parent. </p> |
| |
| </p></div><a name="createInFontContext()"></a><a name="createInFontContext(Class)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createInFontContext</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function createInFontContext(classObj:Class):Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Creates a new object using a context |
| based on the embedded font being used. |
| <p>This method is used to solve a problem |
| with access to fonts embedded in an application SWF |
| when the framework is loaded as an RSL |
| (the RSL has its own SWF context). |
| Embedded fonts can only be accessed from the SWF file context |
| in which they were created. |
| By using the context of the application SWF, |
| the RSL can create objects in the application SWF context |
| that has access to the application's embedded fonts.</p> |
| <p>Call this method only after the font styles |
| for this object are set.</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">classObj</span>:Class</code> — The class to create. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Object</code> — The instance of the class created in the context |
| of the SWF owning the embedded font. |
| If this object is not using an embedded font, |
| the class is created in the context of this object. |
| |
| </td></tr></table></div><a name="createInModuleContext()"></a><a name="createInModuleContext(mx.core.IFlexModuleFactory,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createInModuleContext</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function createInModuleContext(moduleFactory:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a>, className:String):Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Creates the object using a given moduleFactory. |
| If the moduleFactory is null or the object |
| cannot be created using the module factory, |
| then fall back to creating the object using a systemManager. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">moduleFactory</span>:<a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a></code> — The moduleFactory to create the class in; |
| can be null. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">className</span>:String</code> — The name of the class to create. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Object</code> — The object created in the context of the moduleFactory. |
| |
| </td></tr></table></div><a name="createReferenceOnParentDocument()"></a><a name="createReferenceOnParentDocument(mx.core.IFlexDisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createReferenceOnParentDocument</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function createReferenceOnParentDocument(parentDocument:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Creates an <code>id</code> reference to this IUIComponent object |
| on its parent document object. |
| This function can create multidimensional references |
| such as b[2][4] for objects inside one or more repeaters. |
| If the indices are null, it creates a simple non-Array reference. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">parentDocument</span>:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a></code> — The parent of this IUIComponent object. |
| |
| </td></tr></table></p></div><a name="deleteReferenceOnParentDocument()"></a><a name="deleteReferenceOnParentDocument(mx.core.IFlexDisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">deleteReferenceOnParentDocument</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function deleteReferenceOnParentDocument(parentDocument:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Deletes the <code>id</code> reference to this IUIComponent object |
| on its parent document object. |
| This function can delete from multidimensional references |
| such as b[2][4] for objects inside one or more Repeaters. |
| If the indices are null, it deletes the simple non-Array reference. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">parentDocument</span>:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a></code> — The parent of this IUIComponent object. |
| |
| </td></tr></table></p></div><a name="determineTextFormatFromStyles()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">determineTextFormatFromStyles</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function determineTextFormatFromStyles():<a href="../../mx/core/UITextFormat.html">UITextFormat</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns a UITextFormat object corresponding to the text styles |
| for this UIComponent. |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../mx/core/UITextFormat.html">UITextFormat</a></code> — UITextFormat object corresponding to the text styles |
| for this UIComponent. |
| |
| </td></tr></table></div><a name="dispatchEvent()"></a><a name="dispatchEvent(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dispatchEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>override public function dispatchEvent(event:Event):Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatches an event into the event flow. |
| The event target is the EventDispatcher object upon which |
| the <code>dispatchEvent()</code> method is called. |
| |
| Note that when <code>dispatchEvent()</code> is called by code inside a |
| <code>try</code> block, any error thrown thereafter can be caught by |
| listening to LoaderInfo.uncaughtErrorEvents. It will NOT reach the |
| <code>catch</code> block. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code> — The Event object that is dispatched into the event flow. |
| If the event is being redispatched, a clone of the event is created automatically. |
| After an event is dispatched, its <code>target</code> property cannot be changed, |
| so you must create a new copy of the event for redispatching to work. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — A value of <code>true</code> if the event was successfully dispatched. |
| A value of <code>false</code> indicates failure or that |
| the <code>preventDefault()</code> method was called on the event. |
| |
| </td></tr></table></div><a name="dispatchPropertyChangeEvent()"></a><a name="dispatchPropertyChangeEvent(String,any,any)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dispatchPropertyChangeEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Helper method for dispatching a PropertyChangeEvent |
| when a property is updated. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">prop</span>:String</code> — Name of the property that changed. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">oldValue</span>:*</code> — Old value of the property. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">value</span>:*</code> — New value of the property. |
| |
| </td></tr></table></p></div><a name="drawFocus()"></a><a name="drawFocus(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">drawFocus</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function drawFocus(isFocused:Boolean):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Shows or hides the focus indicator around this component. |
| <p>UIComponent implements this by creating an instance of the class |
| specified by the <code>focusSkin</code> style and positioning it |
| appropriately.</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">isFocused</span>:Boolean</code> — Determines if the focus indicator should be displayed. Set to |
| <code>true</code> to display the focus indicator. Set to <code>false</code> to hide it. |
| |
| </td></tr></table></p></div><a name="drawRoundRect()"></a><a name="drawRoundRect(Number,Number,Number,Number,Object,Object,Object,Object,String,Array,Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">drawRoundRect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Programmatically draws a rectangle into this skin's Graphics object. |
| <p>The rectangle can have rounded corners. |
| Its edges are stroked with the current line style |
| of the Graphics object. |
| It can have a solid color fill, a gradient fill, or no fill. |
| A solid fill can have an alpha transparency. |
| A gradient fill can be linear or radial. You can specify |
| up to 15 colors and alpha values at specified points along |
| the gradient, and you can specify a rotation angle |
| or transformation matrix for the gradient. |
| Finally, the rectangle can have a rounded rectangular hole |
| carved out of it.</p> |
| <p>This versatile rectangle-drawing routine is used by many skins. |
| It calls the <code>drawRect()</code> or |
| <code>drawRoundRect()</code> |
| methods (in the flash.display.Graphics class) to draw into this |
| skin's Graphics object.</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">x</span>:Number</code> — Horizontal position of upper-left corner |
| of rectangle within this skin. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">y</span>:Number</code> — Vertical position of upper-left corner |
| of rectangle within this skin. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">w</span>:Number</code> — Width of rectangle, in pixels. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">h</span>:Number</code> — Height of rectangle, in pixels. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">r</span>:Object</code> (default = <code>null</code>)<code></code> — Corner radius/radii of rectangle. |
| Can be <code>null</code>, a Number, or an Object. |
| If it is <code>null</code>, it specifies that the corners should be square |
| rather than rounded. |
| If it is a Number, it specifies the same radius, in pixels, |
| for all four corners. |
| If it is an Object, it should have properties named |
| <code>tl</code>, <code>tr</code>, <code>bl</code>, and |
| <code>br</code>, whose values are Numbers specifying |
| the radius, in pixels, for the top left, top right, |
| bottom left, and bottom right corners. |
| For example, you can pass a plain Object such as |
| <code>{ tl: 5, tr: 5, bl: 0, br: 0 }</code>. |
| The default value is null (square corners). |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">c</span>:Object</code> (default = <code>null</code>)<code></code> — The RGB color(s) for the fill. |
| Can be <code>null</code>, a uint, or an Array. |
| If it is <code>null</code>, the rectangle not filled. |
| If it is a uint, it specifies an RGB fill color. |
| For example, pass <code>0xFF0000</code> to fill with red. |
| If it is an Array, it should contain uints |
| specifying the gradient colors. |
| For example, pass <code>[ 0xFF0000, 0xFFFF00, 0x0000FF ]</code> |
| to fill with a red-to-yellow-to-blue gradient. |
| You can specify up to 15 colors in the gradient. |
| The default value is null (no fill). |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">alpha</span>:Object</code> (default = <code>null</code>)<code></code> — Alpha value(s) for the fill. |
| Can be null, a Number, or an Array. |
| This argument is ignored if <code>color</code> is null. |
| If <code>color</code> is a uint specifying an RGB fill color, |
| then <code>alpha</code> should be a Number specifying |
| the transparency of the fill, where 0.0 is completely transparent |
| and 1.0 is completely opaque. |
| You can also pass null instead of 1.0 in this case |
| to specify complete opaqueness. |
| If <code>color</code> is an Array specifying gradient colors, |
| then <code>alpha</code> should be an Array of Numbers, of the |
| same length, that specifies the corresponding alpha values |
| for the gradient. |
| In this case, the default value is <code>null</code> (completely opaque). |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">rot</span>:Object</code> (default = <code>null</code>)<code></code> — Matrix object used for the gradient fill. |
| The utility methods <code>horizontalGradientMatrix()</code>, |
| <code>verticalGradientMatrix()</code>, and |
| <code>rotatedGradientMatrix()</code> can be used to create the value for |
| this parameter. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">gradient</span>:String</code> (default = <code>null</code>)<code></code> — Type of gradient fill. The possible values are |
| <code>GradientType.LINEAR</code> or <code>GradientType.RADIAL</code>. |
| (The GradientType class is in the package flash.display.) |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">ratios</span>:Array</code> (default = <code>null</code>)<code></code> — |
| Specifies the distribution of colors. The number of entries must match |
| the number of colors defined in the <code>color</code> parameter. |
| Each value defines the percentage of the width where the color is |
| sampled at 100%. The value 0 represents the left-hand position in |
| the gradient box, and 255 represents the right-hand position in the |
| gradient box. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">hole</span>:Object</code> (default = <code>null</code>)<code></code> — A rounded rectangular hole |
| that should be carved out of the middle |
| of the otherwise solid rounded rectangle |
| { x: #, y: #, w: #, h: #, r: # or { br: #, bl: #, tl: #, tr: # } } |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">flash.display.Graphics.beginGradientFill()</div></div><a name="effectFinished()"></a><a name="effectFinished(mx.effects.IEffectInstance)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effectFinished</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function effectFinished(effectInst:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Called by the effect instance when it stops playing on the component. |
| You can use this method to restore a modification to the component made |
| by the <code>effectStarted()</code> method when the effect started, |
| or perform some other action when the effect ends. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">effectInst</span>:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a></code> — The effect instance object playing on the component. |
| |
| </td></tr></table></p></div><a name="effectStarted()"></a><a name="effectStarted(mx.effects.IEffectInstance)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effectStarted</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function effectStarted(effectInst:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Called by the effect instance when it starts playing on the component. |
| You can use this method to perform a modification to the component as part |
| of an effect. You can use the <code>effectFinished()</code> method |
| to restore the modification when the effect ends. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">effectInst</span>:<a href="../../mx/effects/IEffectInstance.html">IEffectInstance</a></code> — The effect instance object playing on the component. |
| |
| </td></tr></table></p></div><a name="endEffectsStarted()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">endEffectsStarted</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function endEffectsStarted():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Ends all currently playing effects on the component. |
| |
| </p></div><a name="executeBindings()"></a><a name="executeBindings(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">executeBindings</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function executeBindings(recurse:Boolean = false):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Executes all the bindings for which the UIComponent object is the destination. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">recurse</span>:Boolean</code> (default = <code>false</code>)<code></code> — Recursively execute bindings for children of this component. |
| |
| </td></tr></table></p></div><a name="finishPrint()"></a><a name="finishPrint(Object,mx.core.IFlexDisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">finishPrint</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function finishPrint(obj:Object, target:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Called after printing is complete. |
| For the UIComponent class, the method performs no action. |
| Flex containers override the method to restore the container after printing. |
| <p>This method is normally not used by application developers. </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">obj</span>:Object</code> — Contains the properties of the component that |
| restore it to its state before printing. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">target</span>:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a></code> — The component that just finished printing. |
| It can be the current component or one of its children. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/printing/FlexPrintJob.html" target="">mx.printing.FlexPrintJob</a></div></div><a name="focusInHandler()"></a><a name="focusInHandler(flash.events.FocusEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">focusInHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function focusInHandler(event:FocusEvent):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The event handler called when a UIComponent object gets focus. |
| If you override this method, make sure to call the base class version. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:FocusEvent</code> — The event object. |
| |
| </td></tr></table></p></div><a name="focusOutHandler()"></a><a name="focusOutHandler(flash.events.FocusEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">focusOutHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function focusOutHandler(event:FocusEvent):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The event handler called when a UIComponent object loses focus. |
| If you override this method, make sure to call the base class version. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:FocusEvent</code> — The event object. |
| |
| </td></tr></table></p></div><a name="generateMXMLArray()"></a><a name="generateMXMLArray(Object,Array,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">generateMXMLArray</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array</code><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">document</span>:Object</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">data</span>:Array</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">recursive</span>:Boolean</code> (default = <code>true</code>)<code></code></td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Array</code></td></tr></table></div><a name="generateMXMLAttributes()"></a><a name="generateMXMLAttributes(Array)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">generateMXMLAttributes</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function generateMXMLAttributes(data:Array):void</code><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">data</span>:Array</code></td></tr></table></p></div><a name="generateMXMLInstances()"></a><a name="generateMXMLInstances(Object,Array,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">generateMXMLInstances</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void</code><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">document</span>:Object</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">data</span>:Array</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">recursive</span>:Boolean</code> (default = <code>true</code>)<code></code></td></tr></table></p></div><a name="generateMXMLObject()"></a><a name="generateMXMLObject(Object,Array)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">generateMXMLObject</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function generateMXMLObject(document:Object, data:Array):Object</code><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">document</span>:Object</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">data</span>:Array</code></td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Object</code></td></tr></table></div><a name="generateMXMLVector()"></a><a name="generateMXMLVector(Object,Array,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">generateMXMLVector</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):*</code><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">document</span>:Object</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">data</span>:Array</code></td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">recursive</span>:Boolean</code> (default = <code>true</code>)<code></code></td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>*</code></td></tr></table></div><a name="getAutomationChildAt()"></a><a name="getAutomationChildAt(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getAutomationChildAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getAutomationChildAt(index:int):<a href="../../mx/automation/IAutomationObject.html">IAutomationObject</a></code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Provides the automation object at the specified index. This list |
| should not include any children that are composites. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">index</span>:int</code> — The index of the child to return |
| |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code><a href="../../mx/automation/IAutomationObject.html">IAutomationObject</a></code> — The child at the specified index. |
| |
| </td></tr></table></div><a name="getAutomationChildren()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getAutomationChildren</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getAutomationChildren():Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Provides the automation object list . This list |
| does not include any children that are composites. |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Array</code> — the automation children. |
| |
| </td></tr></table></div><a name="getBoundsXAtSize()"></a><a name="getBoundsXAtSize(Number,Number,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getBoundsXAtSize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the x coordinate of the element's bounds at the specified element size. |
| |
| <p>This method is typically used by layouts during a call to the |
| <code>measure()</code> method to predict what |
| the element position will be, if the element is resized to particular dimensions.</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">width</span>:Number</code> — The element's bounds width, or NaN to use the preferred width. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">height</span>:Number</code> — The element's bounds height, or NaN to use the preferred height. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| x coordinate of the element's bounding box top-left corner. |
| The bounding box is in element's parent coordinate space and is calculated |
| from the specified bounds size, layout position and layout transform matrix. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — The x coordinate of the element's bounds at the specified element size. |
| </td></tr></table></div><a name="getBoundsYAtSize()"></a><a name="getBoundsYAtSize(Number,Number,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getBoundsYAtSize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the y coordinate of the element's bounds at the specified element size. |
| |
| This method is typically used by layouts during a call to |
| the <code>measure()</code> to predict what |
| the element position will be, if the element is resized to particular dimensions. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">width</span>:Number</code> — The element's bounds width, or NaN to use the preferred width. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">height</span>:Number</code> — The element's bounds height, or NaN to use the preferred height. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| the y coordinate of the element's bounding box top-left corner. |
| The bounding box is in element's parent coordinate space and is calculated |
| from the specified bounds size, layout position and layout transform matrix. |
| |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — The y coordinate of the element's bounds at the specified element size. |
| </td></tr></table></div><a name="getClassStyleDeclarations()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getClassStyleDeclarations</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getClassStyleDeclarations():Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Finds the type selectors for this UIComponent instance. |
| The algorithm walks up the superclass chain. |
| For example, suppose that class MyButton extends Button. |
| A MyButton instance first looks for a MyButton type selector |
| then, it looks for a Button type selector. |
| then, it looks for a UIComponent type selector. |
| (The superclass chain is considered to stop at UIComponent, not Object.) |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Array</code> — An Array of type selectors for this UIComponent instance. |
| |
| </td></tr></table></div><a name="getConstraintValue()"></a><a name="getConstraintValue(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getConstraintValue</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getConstraintValue(constraintName:String):*</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns a layout constraint value, which is the same as |
| getting the constraint style for this component. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">constraintName</span>:String</code> — The name of the constraint style, which |
| can be any of the following: left, right, top, bottom, |
| verticalCenter, horizontalCenter, baseline |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>*</code> — Returns the layout constraint value, which can be |
| specified in either of two forms. It can be specified as a |
| numeric string, for example, "10" or it can be specified as |
| identifier:numeric string. For identifier:numeric string, |
| identifier is the <code>id</code> of a ConstraintRow or |
| ConstraintColumn. For example, a value of "cc1:10" specifies a |
| value of 10 for the ConstraintColumn that has the |
| <code>id</code> "cc1." |
| |
| </td></tr></table></div><a name="getExplicitOrMeasuredHeight()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getExplicitOrMeasuredHeight</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getExplicitOrMeasuredHeight():Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A convenience method for determining whether to use the |
| explicit or measured height |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — A Number which is explicitHeight if defined |
| or measuredHeight if not. |
| |
| </td></tr></table></div><a name="getExplicitOrMeasuredWidth()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getExplicitOrMeasuredWidth</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getExplicitOrMeasuredWidth():Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| A convenience method for determining whether to use the |
| explicit or measured width |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — A Number which is explicitWidth if defined |
| or measuredWidth if not. |
| |
| </td></tr></table></div><a name="getFocus()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getFocus</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getFocus():InteractiveObject</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Gets the object that currently has focus. |
| It might not be this object. |
| Note that this method does not necessarily return the component |
| that has focus. |
| It can return the internal subcomponent of the component |
| that has focus. |
| To get the component that has focus, use the |
| <code>focusManager.focus</code> property. |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>InteractiveObject</code> — Object that has focus. |
| |
| </td></tr></table></div><a name="getLayoutBoundsHeight()"></a><a name="getLayoutBoundsHeight(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLayoutBoundsHeight</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's layout height. This is the size that the element uses |
| to draw on screen. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| the element's bounding box width. The bounding box is in the element's parent |
| coordinate space and is calculated from the element's layout size and |
| layout transform matrix. |
| |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — The element's layout height. |
| </td></tr></table></div><a name="getLayoutBoundsWidth()"></a><a name="getLayoutBoundsWidth(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLayoutBoundsWidth</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's layout width. This is the size that the element uses |
| to draw on screen. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| the element's bounding box width. The bounding box is in element's parent |
| coordinate space and is calculated from the element's layout size and |
| layout transform matrix. |
| |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — The element's layout width. |
| </td></tr></table></div><a name="getLayoutBoundsX()"></a><a name="getLayoutBoundsX(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLayoutBoundsX</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLayoutBoundsX(postLayoutTransform:Boolean = true):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the x coordinate that the element uses to draw on screen. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| x coordinate of the element's bounding box top-left corner. |
| The bounding box is in the element's parent coordinate space and is calculated |
| from the element's layout size, layout position and layout transform matrix. |
| |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — The x coordinate that the element uses to draw on screen. |
| |
| </td></tr></table></div><a name="getLayoutBoundsY()"></a><a name="getLayoutBoundsY(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLayoutBoundsY</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLayoutBoundsY(postLayoutTransform:Boolean = true):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the y coordinate that the element uses to draw on screen. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| y coordinate of the element's bounding box top-left corner. |
| The bounding box is in the element's parent coordinate space and is calculated |
| from the element's layout size, layout position, and layout transform matrix. |
| |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — The y coordinate that the element uses to draw on screen. |
| |
| </td></tr></table></div><a name="getLayoutMatrix()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLayoutMatrix</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLayoutMatrix():Matrix</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the transform matrix that is used to calculate the component's |
| layout relative to its siblings. |
| <p>This matrix is typically defined by the |
| component's 2D properties such as <code>x</code>, <code>y</code>, |
| <code>rotation</code>, <code>scaleX</code>, <code>scaleY</code>, |
| <code>transformX</code>, and <code>transformY</code>. |
| Some components may have additional transform properties that |
| are applied on top of the layout matrix to determine the final, |
| computed matrix. For example <code>UIComponent</code> |
| defines the <code>offsets</code> property.</p> |
| |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Matrix</code> — The layout transform Matrix for this element. |
| Do not directly modify the return value; call the <code>setLayoutMatrix()</code> method instead. |
| |
| </td></tr></table></div><a name="getLayoutMatrix3D()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getLayoutMatrix3D</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getLayoutMatrix3D():Matrix3D</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the layout transform Matrix3D for this element. |
| |
| <p>This matrix is typically defined by the |
| component's transform properties such as <code>x</code>, <code>y</code>, |
| <code>z</code>, <code>rotationX</code>, <code>rotationY</code>, |
| <code>rotationZ</code>, <code>scaleX</code>, <code>scaleY</code>, |
| <code>scaleZ</code>, <code>transformX</code>, and <code>transformY</code>. |
| Some components may have additional transform properties that |
| are applied on top of the layout matrix to determine the final, |
| computed matrix. For example <code>UIComponent</code> |
| defines the <code>offsets</code> property.</p> |
| |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Matrix3D</code> — The layout transform Matrix3D for this element. |
| Do not directly modify the return value but call the <code>setLayoutMatrix()</code> method instead. |
| |
| </td></tr></table></div><a name="getMaxBoundsHeight()"></a><a name="getMaxBoundsHeight(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getMaxBoundsHeight</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's maximum height. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| the element's bounding box height. The bounding box is in the element's parent |
| coordinate space and is calculated from the element's maximum size and |
| layout transform matrix. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — The element's maximum height. |
| </td></tr></table></div><a name="getMaxBoundsWidth()"></a><a name="getMaxBoundsWidth(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getMaxBoundsWidth</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's maximum width. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the method returns |
| the element's bounding box width. The bounding box is in the element's parent |
| coordinate space and is calculated from the element's maximum size and |
| layout transform matrix. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — The element's maximum width. |
| </td></tr></table></div><a name="getMinBoundsHeight()"></a><a name="getMinBoundsHeight(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getMinBoundsHeight</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getMinBoundsHeight(postLayoutTransform:Boolean = true):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's minimum height. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is <code>true</code>, |
| the method returns the element's bounding box height. |
| The bounding box is in the element's parent |
| coordinate space and is calculated from the element's minimum size and |
| layout transform matrix. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — The element's maximum height. |
| </td></tr></table></div><a name="getMinBoundsWidth()"></a><a name="getMinBoundsWidth(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getMinBoundsWidth</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getMinBoundsWidth(postLayoutTransform:Boolean = true):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's minimum width. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is <code>true</code>, |
| the method returns the element's bounding box width. |
| The bounding box is in the element's parent |
| coordinate space and is calculated from the element's minimum size and |
| layout transform matrix. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — The element's maximum width. |
| </td></tr></table></div><a name="getPreferredBoundsHeight()"></a><a name="getPreferredBoundsHeight(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getPreferredBoundsHeight</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's preferred height. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is <code>true</code>, |
| the method returns the element's bounding box height. |
| The bounding box is in the element's parent |
| coordinate space and is calculated from the element's preferred size and |
| layout transform matrix. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — Returns the element's preferred height. Preferred height is |
| usually based on the default element size and any explicit overrides. |
| For UIComponent this is the same value as returned by |
| the <code>getExplicitOrMeasuredHeight()</code> method. |
| </td></tr></table></div><a name="getPreferredBoundsWidth()"></a><a name="getPreferredBoundsWidth(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getPreferredBoundsWidth</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Returns the element's preferred width. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is <code>true</code>, |
| the method returns the element's bounding box width. |
| The bounding box is in the element's parent |
| coordinate space and is calculated from the element's preferred size and |
| layout transform matrix. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Number</code> — Returns the element's preferred width. Preferred width is |
| usually based on the default element size and any explicit overrides. |
| For UIComponent this is the same value as returned by |
| the <code>getExplicitOrMeasuredWidth()</code> method. |
| |
| </td></tr></table></div><a name="getRepeaterItem()"></a><a name="getRepeaterItem(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getRepeaterItem</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getRepeaterItem(whichRepeater:int = -1):Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns the item in the <code>dataProvider</code> that was used |
| by the specified Repeater to produce this Repeater, or |
| <code>null</code> if this Repeater isn't repeated. |
| The argument <code>whichRepeater</code> is 0 for the outermost |
| Repeater, 1 for the next inner Repeater, and so on. |
| If <code>whichRepeater</code> is not specified, |
| the innermost Repeater is used. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">whichRepeater</span>:int</code> (default = <code>-1</code>)<code></code> — Number of the Repeater, |
| counting from the outermost one, starting at 0. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Object</code> — The requested repeater item. |
| |
| </td></tr></table></div><a name="getStyle()"></a><a name="getStyle(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getStyle</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getStyle(styleProp:String):*</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Gets a style property that has been set anywhere in this |
| component's style lookup chain. |
| <p>This same method is used to get any kind of style property, |
| so the value returned can be a Boolean, String, Number, int, |
| uint (for an RGB color), Class (for a skin), or any kind of object. |
| Therefore the return type is simply specified as *.</p> |
| <p>If you are getting a particular style property, you |
| know its type and often want to store the result in a |
| variable of that type. |
| No casting from * to that type is necessary.</p> |
| <p> |
| <code> |
| var backgroundColor:uint = getStyle("backgroundColor"); |
| </code> |
| </p> |
| <p>If the style property has not been set anywhere in the |
| style lookup chain, the value returned by <code>getStyle()</code> |
| is <code>undefined</code>. |
| Note that <code>undefined</code> is a special value that is |
| not the same as <code>false</code>, <code>""</code>, |
| <code>NaN</code>, <code>0</code>, or <code>null</code>. |
| No valid style value is ever <code>undefined</code>. |
| You can use the method |
| <code>IStyleManager2.isValidStyleValue()</code> |
| to test whether the value was set.</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">styleProp</span>:String</code> — Name of the style property. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>*</code> — Style value. |
| |
| </td></tr></table></div><a name="getVisibleRect()"></a><a name="getVisibleRect(flash.display.DisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getVisibleRect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getVisibleRect(targetParent:DisplayObject = null):Rectangle</code><p></p><p></p><p> |
| Get the bounds of this object that are visible to the user |
| on the screen. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">targetParent</span>:DisplayObject</code> (default = <code>null</code>)<code></code> — The parent to stop at when calculating the visible |
| bounds. If null, this object's system manager will be used as |
| the parent. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Rectangle</code> — a <code>Rectangle</code> including the visible portion of the this |
| object. The rectangle is in global coordinates. |
| </td></tr></table></div><a name="globalToContent()"></a><a name="globalToContent(flash.geom.Point)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">globalToContent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function globalToContent(point:Point):Point</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Converts a <code>Point</code> object from global to content coordinates. |
| Global coordinates specify a pixel position relative to the upper-left corner |
| of the stage, that is, the outermost edge of the application. |
| Content coordinates specify a pixel position relative to the upper left corner |
| of the component's content, and include all of the component's content area, |
| including any regions that are currently clipped and must be |
| accessed by scrolling the component. |
| You use the content coordinate system to set and get the positions of children |
| of a container that uses absolute positioning. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">point</span>:Point</code> — A Point object that |
| specifies the <i>x</i> and <i>y</i> coordinates in the global (Stage) |
| coordinate system as properties. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Point</code> — Point A Point object with coordinates relative to the component. |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="UIComponent.html#contentToGlobal()" target="">contentToGlobal()</a></div></div><a name="hasCSSState()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hasCSSState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function hasCSSState():Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4.6</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| |
| Returns <code>true</code> if <code>currentCSSState</code> is not <code>null</code>. |
| Typically, you do not call this method directly. |
| It is called by the <code>mx.styles.CSSCondition.matchesStyleClient()</code> method. |
| <p>Note Spark components use their skin state as the pseudo state. |
| Halo components use the <code>currentState</code> property.</p> |
| </p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — <code>true</code> if <code>currentCSSState</code> is not <code>null</code>. |
| By default, <code>currentCSSState</code> is the same as <code>currentState</code>. |
| If no state exists, return false. |
| |
| </td></tr></table></div><a name="hasState()"></a><a name="hasState(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hasState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function hasState(stateName:String):Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Determines whether the specified state has been defined on this |
| UIComponent. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">stateName</span>:String</code> — The name of the state being checked. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — Whether or not the specified state has been defined |
| |
| </td></tr></table></div><a name="horizontalGradientMatrix()"></a><a name="horizontalGradientMatrix(Number,Number,Number,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">horizontalGradientMatrix</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns a box Matrix which can be passed to the |
| <code>drawRoundRect()</code> method |
| as the <code>rot</code> parameter when drawing a horizontal gradient. |
| <p>For performance reasons, the Matrix is stored in a static variable |
| which is reused by all calls to <code>horizontalGradientMatrix()</code> |
| and <code>verticalGradientMatrix()</code>. |
| Therefore, pass the resulting Matrix |
| to <code>drawRoundRect()</code> before calling |
| <code>horizontalGradientMatrix()</code> |
| or <code>verticalGradientMatrix()</code> again.</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">x</span>:Number</code> — The left coordinate of the gradient, in pixels. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">y</span>:Number</code> — The top coordinate of the gradient, in pixels. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">width</span>:Number</code> — The width of the gradient, in pixels. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">height</span>:Number</code> — The height of the gradient, in pixels. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Matrix</code> — The Matrix for the horizontal gradient. |
| |
| </td></tr></table></div><a name="initAdvancedLayoutFeatures()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initAdvancedLayoutFeatures</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function initAdvancedLayoutFeatures():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Initializes the implementation and storage of some of the less frequently |
| used advanced layout features of a component. |
| |
| Call this function before attempting to use any of the features implemented |
| by the AdvancedLayoutFeatures object. |
| |
| </p></div><a name="initializationComplete()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initializationComplete</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function initializationComplete():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Finalizes the initialization of this component. |
| <p>This method is the last code that executes when you add a component |
| to a parent for the first time using <code>addChild()</code> |
| or <code>addChildAt()</code>. |
| It handles some housekeeping related to dispatching |
| the <code>initialize</code> event. |
| If you are writing a component, you do not need |
| to override this method.</p> |
| |
| </p></div><a name="initialize()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initialize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function initialize():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Initializes the internal structure of this component. |
| <p>Initializing a UIComponent is the fourth step in the creation |
| of a visual component instance, and happens automatically |
| the first time that the instance is added to a parent. |
| Therefore, you do not generally need to call |
| <code>initialize()</code>; the Flex framework calls it for you |
| from UIComponent's override of the <code>addChild()</code> |
| and <code>addChildAt()</code> methods.</p> |
| <p>The first step in the creation of a visual component instance |
| is construction, with the <code>new</code> operator:</p> |
| <pre> |
| var okButton:Button = new Button();</pre> |
| <p>After construction, the new Button instance is a solitary |
| DisplayObject; it does not yet have a UITextField as a child |
| to display its label, and it doesn't have a parent.</p> |
| <p>The second step is configuring the newly-constructed instance |
| with the appropriate properties, styles, and event handlers:</p> |
| <pre> |
| okButton.label = "OK"; |
| okButton.setStyle("cornerRadius", 0); |
| okButton.addEventListener(MouseEvent.CLICK, clickHandler);</pre> |
| <p>The third step is adding the instance to a parent:</p> |
| <pre> |
| someContainer.addChild(okButton);</pre> |
| <p>A side effect of calling <code>addChild()</code> |
| or <code>addChildAt()</code>, when adding a component to a parent |
| for the first time, is that <code>initialize</code> gets |
| automatically called.</p> |
| <p>This method first dispatches a <code>preinitialize</code> event, |
| giving developers using this component a chance to affect it |
| before its internal structure has been created. |
| Next it calls the <code>createChildren()</code> method |
| to create the component's internal structure; for a Button, |
| this method creates and adds the UITextField for the label. |
| Then it dispatches an <code>initialize</code> event, |
| giving developers a chance to affect the component |
| after its internal structure has been created.</p> |
| <p>Note that it is the act of attaching a component to a parent |
| for the first time that triggers the creation of its internal structure. |
| If its internal structure includes other UIComponents, then this is a |
| recursive process in which the tree of DisplayObjects grows by one leaf |
| node at a time.</p> |
| <p>If you are writing a component, you do not need |
| to override this method.</p> |
| |
| </p></div><a name="initializeAccessibility()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initializeAccessibility</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function initializeAccessibility():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Initializes this component's accessibility code. |
| <p>This method is called by the <code>initialize()</code> method to hook in the |
| component's accessibility code, which resides in a separate class |
| in the mx.accessibility package. |
| Each subclass that supports accessibility must override this method |
| because the hook-in process uses a different static variable |
| in each subclass.</p> |
| |
| </p></div><a name="initializeRepeaterArrays()"></a><a name="initializeRepeaterArrays(mx.core.IRepeaterClient)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initializeRepeaterArrays</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function initializeRepeaterArrays(parent:<a href="../../mx/core/IRepeaterClient.html">IRepeaterClient</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Initializes various properties which keep track of repeated instances |
| of this component. |
| <p>An MXML <code><mx:Repeater/></code> tag can cause repeated instances |
| of a component to be created, one instance for each item in the |
| Repeater's data provider. |
| The <code>instanceIndices</code>, <code>repeaters</code>, |
| and <code>repeaterIndices</code> properties of UIComponent |
| keep track of which instance came from which data item |
| and which Repeater.</p> |
| <p>This method is an internal method which is automatically called |
| by the Flex framework. |
| You do not have to call it or override it.</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">parent</span>:<a href="../../mx/core/IRepeaterClient.html">IRepeaterClient</a></code> — The parent object containing the Repeater that created |
| this component. |
| |
| </td></tr></table></p></div><a name="invalidateDisplayList()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invalidateDisplayList</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function invalidateDisplayList():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Marks a component so that its <code>updateDisplayList()</code> |
| method gets called during a later screen update. |
| <p>Invalidation is a useful mechanism for eliminating duplicate |
| work by delaying processing of changes to a component until a |
| later screen update. |
| For example, if you want to change the width and height, |
| it would be wasteful to update the component immediately after you |
| change the width and then update again with the new height. |
| It is more efficient to change both properties and then render |
| the component with its new size once.</p> |
| <p>Invalidation methods rarely get called. |
| In general, setting a property on a component automatically |
| calls the appropriate invalidation method.</p> |
| |
| </p></div><a name="invalidateLayering()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invalidateLayering</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function invalidateLayering():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.4</td></tr></table><p></p><p></p><p> |
| Called by a component's items to indicate that their <code>depth</code> |
| property has changed. Note that while this function is defined on |
| <code>UIComponent</code>, it is up to subclasses to implement support |
| for complex layering. |
| By default, only <code>Group</code> and <code>DataGroup</code> support |
| arbitrary layering of their children. |
| |
| </p><p><span class="label">See also</span></p><div class="seeAlso"><a href="UIComponent.html#depth" target="">depth</a></div></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><td class="detailHeaderRule"> </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 : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</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="invalidateParentSizeAndDisplayList()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invalidateParentSizeAndDisplayList</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function invalidateParentSizeAndDisplayList():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Helper method to invalidate parent size and display list if |
| this object affects its layout (includeInLayout is true). |
| |
| </p></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><td class="detailHeaderRule"> </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 : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Marks a component so that its <code>commitProperties()</code> |
| method gets called during a later screen update. |
| <p>Invalidation is a useful mechanism for eliminating duplicate |
| work by delaying processing of changes to a component until a |
| later screen update. |
| For example, if you want to change the text color and size, |
| it would be wasteful to update the color immediately after you |
| change it and then update the size when it gets set. |
| It is more efficient to change both properties and then render |
| the text with its new size and color once.</p> |
| <p>Invalidation methods rarely get called. |
| In general, setting a property on a component automatically |
| calls the appropriate invalidation method.</p> |
| |
| </p></div><a name="invalidateSize()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invalidateSize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function invalidateSize():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Marks a component so that its <code>measure()</code> |
| method gets called during a later screen update. |
| <p>Invalidation is a useful mechanism for eliminating duplicate |
| work by delaying processing of changes to a component until a |
| later screen update. |
| For example, if you want to change the text and font size, |
| it would be wasteful to update the text immediately after you |
| change it and then update the size when it gets set. |
| It is more efficient to change both properties and then render |
| the text with its new size once.</p> |
| <p>Invalidation methods rarely get called. |
| In general, setting a property on a component automatically |
| calls the appropriate invalidation method.</p> |
| |
| </p></div><a name="isOurFocus()"></a><a name="isOurFocus(flash.display.DisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">isOurFocus</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function isOurFocus(target:DisplayObject):Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Typically overridden by components containing UITextField objects, |
| where the UITextField object gets focus. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">target</span>:DisplayObject</code> — A UIComponent object containing a UITextField object |
| that can receive focus. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — Returns <code>true</code> if the UITextField object has focus. |
| |
| </td></tr></table></div><a name="keyDownHandler()"></a><a name="keyDownHandler(flash.events.KeyboardEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">keyDownHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function keyDownHandler(event:KeyboardEvent):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The event handler called for a <code>keyDown</code> event. |
| If you override this method, make sure to call the base class version. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:KeyboardEvent</code> — The event object. |
| |
| </td></tr></table></p></div><a name="keyUpHandler()"></a><a name="keyUpHandler(flash.events.KeyboardEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">keyUpHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function keyUpHandler(event:KeyboardEvent):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The event handler called for a <code>keyUp</code> event. |
| If you override this method, make sure to call the base class version. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:KeyboardEvent</code> — The event object. |
| |
| </td></tr></table></p></div><a name="localToContent()"></a><a name="localToContent(flash.geom.Point)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">localToContent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function localToContent(point:Point):Point</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Converts a <code>Point</code> object from local to content coordinates. |
| Local coordinates specify a pixel position relative to the |
| upper left corner of the component. |
| Content coordinates specify a pixel position relative to the upper left corner |
| of the component's content, and include all of the component's content area, |
| including any regions that are currently clipped and must be |
| accessed by scrolling the component. |
| You use the content coordinate system to set and get the positions of children |
| of a container that uses absolute positioning. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">point</span>:Point</code> — A Point object that specifies the <i>x</i> and <i>y</i> |
| coordinates in the local coordinate system as properties. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Point</code> — Point A Point object with coordinates relative to the |
| content coordinate system. |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="UIComponent.html#contentToLocal()" target="">contentToLocal()</a></div></div><a name="matchesCSSState()"></a><a name="matchesCSSState(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">matchesCSSState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function matchesCSSState(cssState:String):Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Returns <code>true</code> if <code>cssState</code> matches <code>currentCSSState</code>. |
| Typically, you do not call this method directly. |
| It is called by the <code>mx.styles.CSSCondition.matchesStyleClient()</code> method. |
| <p>Note Spark components use their skin state as the pseudo state. |
| Halo components use the <code>currentState</code> property.</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">cssState</span>:String</code> — A possible value of <code>CSSCondition.value</code>. |
| It represents the current state of this component used to match CSS pseudo-selectors. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — <code>true</code> if <code>cssState</code> matches <code>currentCSSState</code>. |
| By default, <code>currentCSSState</code> is the same as <code>currentState</code>. |
| If no state exists, return null. |
| |
| </td></tr></table></div><a name="matchesCSSType()"></a><a name="matchesCSSType(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">matchesCSSType</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function matchesCSSType(cssType:String):Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Determines whether this instance is the same as, or is a subclass of, |
| the given type. |
| Typically, you do not call this method directly. |
| It is called by the <code>mx.styles.CSSCondition.matchesStyleClient()</code> method. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">cssType</span>:String</code> — A CSSSelector object. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — <code>true</code> if <code>cssType</code> is in the hierarchy of qualified type selectors. |
| |
| </td></tr></table></div><a name="measure()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">measure</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function measure():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Calculates the default size, and optionally the default minimum size, |
| of the component. This is an advanced method that you might override when |
| creating a subclass of UIComponent. |
| <p>You do not call this method directly. Flex calls the |
| <code>measure()</code> method when the component is added to a container |
| using the <code>addChild()</code> method, and when the component's |
| <code>invalidateSize()</code> method is called. </p> |
| <p>When you set a specific height and width of a component, |
| Flex does not call the <code>measure()</code> method, |
| even if you explicitly call the <code>invalidateSize()</code> method. |
| That is, Flex only calls the <code>measure()</code> method if |
| the <code>explicitWidth</code> property or the <code>explicitHeight</code> |
| property of the component is NaN. </p> |
| <p>In your override of this method, you must set the |
| <code>measuredWidth</code> and <code>measuredHeight</code> properties |
| to define the default size. |
| You can optionally set the <code>measuredMinWidth</code> and |
| <code>measuredMinHeight</code> properties to define the default |
| minimum size.</p> |
| <p>Most components calculate these values based on the content they are |
| displaying, and from the properties that affect content display. |
| A few components simply have hard-coded default values. </p> |
| <p>The conceptual point of <code>measure()</code> is for the component to provide |
| its own natural or intrinsic size as a default. Therefore, the |
| <code>measuredWidth</code> and <code>measuredHeight</code> properties |
| should be determined by factors such as:</p> |
| <ul> |
| <li>The amount of text the component needs to display.</li> |
| <li>The styles, such as <code>fontSize</code>, for that text.</li> |
| <li>The size of a JPEG image that the component displays.</li> |
| <li>The measured or explicit sizes of the component's children.</li> |
| <li>Any borders, margins, and gaps.</li> |
| </ul> |
| <p>In some cases, there is no intrinsic way to determine default values. |
| For example, a simple GreenCircle component might simply set |
| measuredWidth = 100 and measuredHeight = 100 in its <code>measure()</code> 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.</p> |
| <p>The default implementation of <code>measure()</code> |
| sets <code>measuredWidth</code>, <code>measuredHeight</code>, |
| <code>measuredMinWidth</code>, and <code>measuredMinHeight</code> |
| to <code>0</code>.</p> |
| |
| </p></div><a name="measureHTMLText()"></a><a name="measureHTMLText(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">measureHTMLText</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function measureHTMLText(htmlText:String):TextLineMetrics</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Measures the specified HTML text, which can contain HTML tags such |
| as <code><font></code> and <code><b></code>, |
| assuming that it is displayed |
| in a single-line UITextField using a UITextFormat |
| determined by the styles of this UIComponent. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">htmlText</span>:String</code> — A String specifying the HTML text to measure. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>TextLineMetrics</code> — A TextLineMetrics object containing the text measurements. |
| |
| </td></tr></table></div><a name="measureText()"></a><a name="measureText(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">measureText</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function measureText(text:String):TextLineMetrics</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Measures the specified text, assuming that it is displayed |
| in a single-line UITextField (or UIFTETextField) using a UITextFormat |
| determined by the styles of this UIComponent. Does not |
| work for Spark components since they don't use UITextField |
| (or UIFTETextField). To measure text in Spark components, |
| get the measurements of a spark.components.Label |
| or spark.components.RichText |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">text</span>:String</code> — A String specifying the text to measure. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>TextLineMetrics</code> — A TextLineMetrics object containing the text measurements. |
| |
| </td></tr></table></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"> </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 : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Moves the component to a specified position within its parent. |
| Calling this method is exactly the same as |
| setting the component's <code>x</code> and <code>y</code> properties. |
| <p>If you are overriding the <code>updateDisplayList()</code> method |
| in a custom component, call the <code>move()</code> method |
| rather than setting the <code>x</code> and <code>y</code> properties. |
| The difference is that the <code>move()</code> method changes the location |
| of the component and then dispatches a <code>move</code> event when you |
| call the method, while setting the <code>x</code> and <code>y</code> |
| properties changes the location of the component and dispatches |
| the event on the next screen refresh.</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">x</span>:Number</code> — Left position of the component within its parent. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">y</span>:Number</code> — Top position of the component within its parent. |
| |
| </td></tr></table></p></div><a name="notifyStyleChangeInChildren()"></a><a name="notifyStyleChangeInChildren(String,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">notifyStyleChangeInChildren</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Propagates style changes to the children. |
| You typically never need to call this method. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">styleProp</span>:String</code> — String specifying the name of the style property. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">recursive</span>:Boolean</code> — Recursivly notify all children of this component. |
| |
| </td></tr></table></p></div><a name="owns()"></a><a name="owns(flash.display.DisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">owns</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function owns(child:DisplayObject):Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns <code>true</code> if the chain of <code>owner</code> properties |
| points from <code>child</code> to this UIComponent. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">child</span>:DisplayObject</code> — A UIComponent. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — <code>true</code> if the child is parented or owned by this UIComponent. |
| |
| </td></tr></table></div><a name="parentChanged()"></a><a name="parentChanged(flash.display.DisplayObjectContainer)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">parentChanged</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function parentChanged(p:DisplayObjectContainer):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Called by Flex when a UIComponent object is added to or removed from a parent. |
| Developers typically never need to call this method. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">p</span>:DisplayObjectContainer</code> — The parent of this UIComponent object. |
| |
| </td></tr></table></p></div><a name="prepareToPrint()"></a><a name="prepareToPrint(mx.core.IFlexDisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">prepareToPrint</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function prepareToPrint(target:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a>):Object</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Prepares an IFlexDisplayObject for printing. |
| For the UIComponent class, the method performs no action. |
| Flex containers override the method to prepare for printing; |
| for example, by removing scroll bars from the printed output. |
| <p>This method is normally not used by application developers. </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">target</span>:<a href="../../mx/core/IFlexDisplayObject.html">IFlexDisplayObject</a></code> — The component to be printed. |
| It can be the current component or one of its children. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Object</code> — Object containing the properties of the current component |
| required by the <code>finishPrint()</code> method |
| to restore it to its previous state. |
| </td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/printing/FlexPrintJob.html" target="">mx.printing.FlexPrintJob</a></div></div><a name="regenerateStyleCache()"></a><a name="regenerateStyleCache(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">regenerateStyleCache</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function regenerateStyleCache(recursive:Boolean):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Builds or rebuilds the CSS style cache for this component |
| and, if the <code>recursive</code> parameter is <code>true</code>, |
| for all descendants of this component as well. |
| <p>The Flex framework calls this method in the following |
| situations:</p> |
| <ul> |
| <li>When you add a UIComponent to a parent using the |
| <code>addChild()</code> or <code>addChildAt()</code> methods.</li> |
| <li>When you change the <code>styleName</code> property |
| of a UIComponent.</li> |
| <li>When you set a style in a CSS selector using the |
| <code>setStyle()</code> method of CSSStyleDeclaration.</li> |
| </ul> |
| <p>Building the style cache is a computation-intensive operation, |
| so avoid changing <code>styleName</code> or |
| setting selector styles unnecessarily.</p> |
| <p>This method is not called when you set an instance style |
| by calling the <code>setStyle()</code> method of UIComponent. |
| Setting an instance style is a relatively fast operation |
| compared with setting a selector style.</p> |
| <p>You do not need to call or override 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">recursive</span>:Boolean</code> — Recursively regenerates the style cache for |
| all children of this component. |
| |
| </td></tr></table></p></div><a name="registerEffects()"></a><a name="registerEffects(Array)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">registerEffects</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function registerEffects(effects:Array):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| For each effect event, registers the EffectManager |
| as one of the event listeners. |
| You typically never need to call this method. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">effects</span>:Array</code> — The names of the effect events. |
| |
| </td></tr></table></p></div><a name="removeStyleClient()"></a><a name="removeStyleClient(mx.styles.IAdvancedStyleClient)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeStyleClient</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeStyleClient(styleClient:<a href="../../mx/styles/IAdvancedStyleClient.html">IAdvancedStyleClient</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Removes a non-visual style client from this component instance. |
| Once this method has been called, the non-visual style client will |
| no longer inherit style changes from this component instance. |
| |
| As a side effect, this method will set the |
| <code>styleParent</code> property of the <code>styleClient</code> |
| parameter to <code>null</code>. |
| |
| If the <code>styleClient</code> has not been added to this |
| component instance, no action will be taken. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">styleClient</span>:<a href="../../mx/styles/IAdvancedStyleClient.html">IAdvancedStyleClient</a></code> — The <code>IAdvancedStyleClient</code> to remove |
| from this component's list of non-visual style clients. |
| |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso">addStyleClient<br/><a href="../../mx/styles/IAdvancedStyleClient.html" target="">mx.styles.IAdvancedStyleClient</a></div></div><a name="replayAutomatableEvent()"></a><a name="replayAutomatableEvent(flash.events.Event)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">replayAutomatableEvent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function replayAutomatableEvent(event:Event):Boolean</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Replays the specified event. A component author should probably call |
| super.replayAutomatableEvent in case default replay behavior has been defined |
| in a superclass. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">event</span>:Event</code> — The event to replay. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Boolean</code> — <code>true</code> if a replay was successful. |
| |
| </td></tr></table></div><a name="resolveAutomationIDPart()"></a><a name="resolveAutomationIDPart(Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">resolveAutomationIDPart</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function resolveAutomationIDPart(criteria:Object):Array</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Resolves a child by using the id provided. The id is a set |
| of properties as provided by the <code>createAutomationIDPart()</code> method. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">criteria</span>:Object</code> — Set of properties describing the child. |
| The criteria can contain regular expression values |
| resulting in multiple children being matched. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Array</code> — Array of children that matched the criteria |
| or <code>null</code> if no children could not be resolved. |
| |
| </td></tr></table></div><a name="resourcesChanged()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">resourcesChanged</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function resourcesChanged():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| This method is called when a UIComponent is constructed, |
| and again whenever the ResourceManager dispatches |
| a <code>"change"</code> Event to indicate |
| that the localized resources have changed in some way. |
| <p>This event is dispatched when you set the ResourceManager's |
| <code>localeChain</code> property, when a resource module |
| has finished loading, and when you call the ResourceManager's |
| <code>update()</code> method.</p> |
| <p>Subclasses should override this method and, after calling |
| <code>super.resourcesChanged()</code>, do whatever is appropriate |
| in response to having new resource values.</p> |
| |
| </p></div><a name="resumeBackgroundProcessing()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">resumeBackgroundProcessing</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public static function resumeBackgroundProcessing():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Resumes the background processing of methods |
| queued by <code>callLater()</code>, after a call to |
| <code>suspendBackgroundProcessing()</code>. |
| <p>Refer to the description of |
| <code>suspendBackgroundProcessing()</code> for more information.</p> |
| |
| </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"> </td></tr></table><div class="detailBody"><code> public function setActualSize(w:Number, h:Number):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Sizes the object. |
| Unlike directly setting the <code>width</code> and <code>height</code> |
| properties, calling the <code>setActualSize()</code> method |
| does not set the <code>explictWidth</code> and |
| <code>explicitHeight</code> properties, so a future layout |
| calculation can result in the object returning to its previous size. |
| This method is used primarily by component developers implementing |
| the <code>updateDisplayList()</code> method, by Effects, |
| and by the LayoutManager. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">w</span>:Number</code> — Width of the object. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">h</span>:Number</code> — Height of the object. |
| |
| </td></tr></table></p></div><a name="setConstraintValue()"></a><a name="setConstraintValue(String,any)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setConstraintValue</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setConstraintValue(constraintName:String, value:*):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Sets a layout constraint value, which is the same as |
| setting the constraint style for this component. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">constraintName</span>:String</code> — The name of the constraint style, which |
| can be any of the following: left, right, top, bottom, |
| verticalCenter, horizontalCenter, baseline |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">value</span>:*</code> — The value of the constraint can be specified in either |
| of two forms. It can be specified as a numeric string, for |
| example, "10" or it can be specified as identifier:numeric |
| string. For identifier:numeric string, identifier is the |
| <code>id</code> of a ConstraintRow or ConstraintColumn. For |
| example, a value of "cc1:10" specifies a value of 10 for the |
| ConstraintColumn that has the <code>id</code> "cc1." |
| |
| </td></tr></table></p></div><a name="setCurrentState()"></a><a name="setCurrentState(String,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setCurrentState</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setCurrentState(stateName:String, playTransition:Boolean = true):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Set the current state. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">stateName</span>:String</code> — The name of the new view state. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">playTransition</span>:Boolean</code> (default = <code>true</code>)<code></code> — If <code>true</code>, play |
| the appropriate transition when the view state changes. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso"><a href="UIComponent.html#currentState" target="">currentState</a></div></div><a name="setFocus()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setFocus</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setFocus():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Sets the focus to this component. |
| The component can in turn pass focus to a subcomponent. |
| <p><b>Note:</b> Only the TextInput and TextArea controls show a highlight |
| when this method sets the focus. |
| All controls show a highlight when the user tabs to the control.</p> |
| |
| </p></div><a name="setLayoutBoundsPosition()"></a><a name="setLayoutBoundsPosition(Number,Number,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setLayoutBoundsPosition</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Sets the coordinates that the element uses to draw on screen. |
| <p>Note that calls to the <code>setLayoutBoundSize()</code> method can affect the layout position, so |
| call <code>setLayoutBoundPosition()</code> after calling <code>setLayoutBoundSize()</code>.</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">x</span>:Number</code> — The x-coordinate of the top-left corner of the bounding box. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">y</span>:Number</code> — The y-coordinate of the top-left corner of the bounding box. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is <code>true</code>, |
| the element is positioned in such a way that the top-left corner of its bounding box is (x, y). |
| The bounding box is in the element's parent coordinate space and is calculated |
| from the element's layout size, layout position and layout transform matrix. |
| </td></tr></table></p></div><a name="setLayoutBoundsSize()"></a><a name="setLayoutBoundsSize(Number,Number,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setLayoutBoundsSize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Sets the layout size of the element. |
| This is the size that the element uses to draw on screen. |
| |
| <p>If the <code>width</code> and/or <code>height</code> parameters are left unspecified (NaN), |
| Flex sets the element's layout size to its preferred width and/or preferred height.</p> |
| |
| <p>Note that calls to the <code>setLayoutBoundSize()</code> method can affect the layout position, so |
| call <code>setLayoutBoundPosition()</code> after calling <code>setLayoutBoundSize()</code>.</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">width</span>:Number</code> — The element's layout width. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">height</span>:Number</code> — The element's layout height. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutTransform</span>:Boolean</code> (default = <code>true</code>)<code></code> — When <code>postLayoutTransform</code> is true, the specified sizes |
| are those of the element's bounding box. |
| The bounding box is in the element's parent coordinate space and is calculated |
| from the element's layout size, layout position, and layout transform matrix. |
| |
| </td></tr></table></p></div><a name="setLayoutMatrix()"></a><a name="setLayoutMatrix(flash.geom.Matrix,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setLayoutMatrix</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Sets the transform Matrix that is used to calculate the component's layout |
| size and position relative to its siblings. |
| <p>The matrix is typically defined by the |
| component's 2D properties such as <code>x</code>, <code>y</code>, |
| <code>rotation</code>, <code>scaleX</code>, <code>scaleY</code>, |
| <code>transformX</code>, and <code>transformY</code>. |
| Some components may have additional transform properties that |
| are applied on top of the layout matrix to determine the final, |
| computed matrix. For example <code>UIComponent</code> |
| defines the <code>offsets</code>.</p> |
| |
| <p>Note that layout Matrix is factored in the <code>getPreferredSize()</code>, |
| <code>getMinSize()</code>, <code>getMaxSize()</code>, <code>getLayoutSize()</code> |
| methods when computed in parent coordinates |
| as well as in <code>getLayoutPosition()</code> in both parent and child coordinates. |
| Layouts that calculate the transform matrix explicitly typically call |
| this method and work with sizes in child coordinates. |
| Layouts calling this method pass <code>false</code> |
| to the <code>invalidateLayout()</code> method so that a subsequent layout pass is not |
| triggered.</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">value</span>:Matrix</code> — The matrix. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">invalidateLayout</span>:Boolean</code> — <code>true</code> to cause the parent container |
| to re-layout its children. You typically pass <code>true</code> |
| to the <code>invalidateLayout()</code> method. |
| |
| </td></tr></table></p></div><a name="setLayoutMatrix3D()"></a><a name="setLayoutMatrix3D(flash.geom.Matrix3D,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setLayoutMatrix3D</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| |
| Sets the transform Matrix3D that is used to calculate the component's layout |
| size and position relative to its siblings. |
| <p>This matrix is typically defined by the |
| component's transform properties such as <code>x</code>, <code>y</code>, |
| <code>z</code>, <code>rotationX</code>, <code>rotationY</code>, |
| <code>rotationZ</code>, <code>scaleX</code>, <code>scaleY</code>, |
| <code>scaleZ</code>, <code>transformX</code>, and <code>transformY</code>. |
| Some components may have additional transform properties that |
| are applied on top of the layout matrix to determine the final, |
| computed matrix. For example <code>UIComponent</code> |
| defines the <code>offsets</code> property.</p> |
| |
| <p>Note that layout Matrix3D is factored in the <code>getPreferredSize()</code>, |
| <code>getMinSize()</code>, <code>getMaxSize()</code>, <code>getLayoutSize()</code> |
| when computed in parent coordinates |
| as well as in <code>getLayoutPosition()</code> in both parent and child coordinates. |
| Layouts that calculate the transform matrix explicitly typically call |
| this method and work with sizes in child coordinates. |
| Layouts calling this method pass <code>false</code> |
| to the <code>invalidateLayout()</code> method so that a subsequent layout pass is not |
| triggered.</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">value</span>:Matrix3D</code> — The matrix. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">invalidateLayout</span>:Boolean</code> — <code>true</code> to cause the parent container |
| to re-layout its children. You typically pass <code>true</code> |
| to the <code>invalidateLayout()</code> method. |
| |
| </td></tr></table></p></div><a name="setMXMLDescriptor()"></a><a name="setMXMLDescriptor(Array)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setMXMLDescriptor</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setMXMLDescriptor(value:Array):void</code><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">value</span>:Array</code></td></tr></table></p></div><a name="setMXMLProperties()"></a><a name="setMXMLProperties(Array)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setMXMLProperties</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setMXMLProperties(value:Array):void</code><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">value</span>:Array</code></td></tr></table></p></div><a name="setStretchXY()"></a><a name="setStretchXY(Number,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setStretchXY</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function setStretchXY(stretchX:Number, stretchY:Number):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| Specifies a transform stretch factor in the horizontal and vertical direction. |
| The stretch factor is applied to the computed matrix before any other transformation. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">stretchX</span>:Number</code> — The horizontal component of the stretch factor. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">stretchY</span>:Number</code> — The vertical component of the stretch factor. |
| |
| </td></tr></table></p></div><a name="setStyle()"></a><a name="setStyle(String,any)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setStyle</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setStyle(styleProp:String, newValue:*):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Sets a style property on this component instance. |
| <p>This can override a style that was set globally.</p> |
| <p>Calling the <code>setStyle()</code> method can result in decreased performance. |
| Use it only when necessary.</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">styleProp</span>:String</code> — Name of the style property. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">newValue</span>:*</code> — New value for the style. |
| |
| </td></tr></table></p></div><a name="setVisible()"></a><a name="setVisible(Boolean,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">setVisible</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function setVisible(value:Boolean, noEvent:Boolean = false):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Called when the <code>visible</code> property changes. |
| Set the <code>visible</code> property to show or hide |
| a component instead of calling this method directly. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">value</span>:Boolean</code> — The new value of the <code>visible</code> property. |
| Specify <code>true</code> to show the component, and <code>false</code> to hide it. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">noEvent</span>:Boolean</code> (default = <code>false</code>)<code></code> — If <code>true</code>, do not dispatch an event. |
| If <code>false</code>, dispatch a <code>show</code> event when |
| the component becomes visible, and a <code>hide</code> event when |
| the component becomes invisible. |
| |
| </td></tr></table></p></div><a name="stateChanged()"></a><a name="stateChanged(String,String,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">stateChanged</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function stateChanged(oldState:String, newState:String, recursive:Boolean):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| This method is called when a state changes to check whether |
| state-specific styles apply to this component. If there is a chance |
| of a matching CSS pseudo-selector for the current state, the style |
| cache needs to be regenerated for this instance and, potentially all |
| children, if the <code>recursive</code> param is set to <code>true</code>. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">oldState</span>:String</code> — The name of th eold state. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">newState</span>:String</code> — The name of the new state. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">recursive</span>:Boolean</code> — Set to <code>true</code> to perform a recursive check. |
| |
| </td></tr></table></p></div><a name="styleChanged()"></a><a name="styleChanged(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">styleChanged</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function styleChanged(styleProp:String):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Detects changes to style properties. When any style property is set, |
| Flex calls the <code>styleChanged()</code> method, |
| passing to it the name of the style being set. |
| <p>This is an advanced method that you might override |
| when creating a subclass of UIComponent. When you create a custom component, |
| you can override the <code>styleChanged()</code> method |
| to check the style name passed to it, and handle the change accordingly. |
| This lets you override the default behavior of an existing style, |
| or add your own custom style properties.</p> |
| <p>If you handle the style property, your override of |
| the <code>styleChanged()</code> method should call the |
| <code>invalidateDisplayList()</code> method to cause Flex to execute |
| the component's <code>updateDisplayList()</code> method at the next screen update.</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">styleProp</span>:String</code> — The name of the style property, or null if all styles for this |
| component have changed. |
| |
| </td></tr></table></p></div><a name="stylesInitialized()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">stylesInitialized</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function stylesInitialized():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Flex calls the <code>stylesInitialized()</code> method when |
| the styles for a component are first initialized. |
| <p>This is an advanced method that you might override |
| when creating a subclass of UIComponent. Flex guarantees that |
| your component's styles are fully initialized before |
| the first time your component's <code>measure</code> and |
| <code>updateDisplayList</code> methods are called. For most |
| components, that is sufficient. But if you need early access to |
| your style values, you can override the stylesInitialized() function |
| to access style properties as soon as they are initialized the first time.</p> |
| |
| </p></div><a name="suspendBackgroundProcessing()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">suspendBackgroundProcessing</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public static function suspendBackgroundProcessing():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Blocks the background processing of methods |
| queued by <code>callLater()</code>, |
| until <code>resumeBackgroundProcessing()</code> is called. |
| <p>These methods can be useful when you have time-critical code |
| which needs to execute without interruption. |
| For example, when you set the <code>suspendBackgroundProcessing</code> |
| property of an Effect to <code>true</code>, |
| <code>suspendBackgroundProcessing()</code> is automatically called |
| when it starts playing, and <code>resumeBackgroundProcessing</code> |
| is called when it stops, in order to ensure that the animation |
| is smooth.</p> |
| <p>Since the LayoutManager uses <code>callLater()</code>, |
| this means that <code>commitProperties()</code>, |
| <code>measure()</code>, and <code>updateDisplayList()</code> |
| is not called in between calls to |
| <code>suspendBackgroundProcessing()</code> and |
| <code>resumeBackgroundProcessing()</code>.</p> |
| <p>It is safe for both an outer method and an inner method |
| (i.e., one that the outer methods calls) to call |
| <code>suspendBackgroundProcessing()</code> |
| and <code>resumeBackgroundProcessing()</code>, because these |
| methods actually increment and decrement a counter |
| which determines whether background processing occurs.</p> |
| |
| </p></div><a name="transformAround()"></a><a name="transformAround(flash.geom.Vector3D,flash.geom.Vector3D,flash.geom.Vector3D,flash.geom.Vector3D,flash.geom.Vector3D,flash.geom.Vector3D,flash.geom.Vector3D,Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transformAround</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function 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</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| 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. |
| This function will assign the rotation, scale, and translation values |
| provided, then update the x/y/z properties as necessary to keep |
| the transform center fixed. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">transformCenter</span>:Vector3D</code> — The point, in the component's own coordinates, |
| to keep fixed relative to its parent. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">scale</span>:Vector3D</code> (default = <code>null</code>)<code></code> — The new values for the scale of the transform. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">rotation</span>:Vector3D</code> (default = <code>null</code>)<code></code> — the new values for the rotation of the transform |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">translation</span>:Vector3D</code> (default = <code>null</code>)<code></code> — The new values for the translation of the transform. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutScale</span>:Vector3D</code> (default = <code>null</code>)<code></code> — The new values for the post-layout scale |
| of the transform. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutRotation</span>:Vector3D</code> (default = <code>null</code>)<code></code> — The new values for the post-layout rotation |
| of the transform. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutTranslation</span>:Vector3D</code> (default = <code>null</code>)<code></code> — The new values for the post-layout translation |
| of the transform. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">invalidateLayout</span>:Boolean</code> (default = <code>true</code>)<code></code> — If <code>true</code>, the parent container size and display are |
| invalidated. Layouts calling this method pass <code>false</code> |
| so that a subsequent layout pass is not triggered. |
| |
| </td></tr></table></p></div><a name="transformPointToParent()"></a><a name="transformPointToParent(flash.geom.Vector3D,flash.geom.Vector3D,flash.geom.Vector3D)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">transformPointToParent</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 1.5</td></tr></table><p></p><p></p><p> |
| 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. The pre-layout and post-layout result is set on |
| the <code>position</code> and <code>postLayoutPosition</code> |
| parameters, if they are non-null. |
| |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">localPosition</span>:Vector3D</code> — The point to be transformed, specified in the |
| local coordinates of the object. |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">position</span>:Vector3D</code> — A Vector3D point that holds the pre-layout |
| result. If null, the parameter is ignored. |
| |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">postLayoutPosition</span>:Vector3D</code> — A Vector3D point that holds the post-layout |
| result. If null, the parameter is ignored. |
| |
| </td></tr></table></p></div><a name="updateDisplayList()"></a><a name="updateDisplayList(Number,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">updateDisplayList</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Draws the object and/or sizes and positions its children. |
| This is an advanced method that you might override |
| when creating a subclass of UIComponent. |
| <p>You do not call this method directly. Flex calls the |
| <code>updateDisplayList()</code> method when the component is added to a container |
| using the <code>addChild()</code> method, and when the component's |
| <code>invalidateDisplayList()</code> method is called. </p> |
| <p>If the component has no children, this method |
| is where you would do programmatic drawing |
| using methods on the component's Graphics object |
| such as <code>graphics.drawRect()</code>.</p> |
| <p>If the component has children, this method is where |
| you would call the <code>move()</code> and <code>setActualSize()</code> |
| methods on its children.</p> |
| <p>Components can do programmatic drawing even if |
| they have children. In doing either, use the |
| component's <code>unscaledWidth</code> and <code>unscaledHeight</code> |
| as its bounds.</p> |
| <p>It is important to use <code>unscaledWidth</code> and |
| <code>unscaledHeight</code> instead of the <code>width</code> |
| and <code>height</code> properties.</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">unscaledWidth</span>:Number</code> — Specifies the width of the component, in pixels, |
| in the component's coordinates, regardless of the value of the |
| <code>scaleX</code> property of the component. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">unscaledHeight</span>:Number</code> — Specifies the height of the component, in pixels, |
| in the component's coordinates, regardless of the value of the |
| <code>scaleY</code> property of the component. |
| |
| </td></tr></table></p></div><a name="validateDisplayList()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">validateDisplayList</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function validateDisplayList():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Validates the position and size of children and draws other |
| visuals. |
| If the <code>LayoutManager.invalidateDisplayList()</code> method is called with |
| this ILayoutManagerClient, then the <code>validateDisplayList()</code> method |
| is called when it's time to update the display list. |
| |
| </p></div><a name="validateNow()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">validateNow</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function validateNow():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Validate and update the properties and layout of this object |
| and redraw it, if necessary. |
| Processing properties that require substantial computation are normally |
| not processed until the script finishes executing. |
| For example setting the <code>width</code> property is delayed, because it can |
| require recalculating the widths of the objects children or its parent. |
| Delaying the processing prevents it from being repeated |
| multiple times if the script sets the <code>width</code> property more than once. |
| This method lets you manually override this behavior. |
| |
| </p></div><a name="validateProperties()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">validateProperties</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function validateProperties():void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Used by layout logic to validate the properties of a component |
| by calling the <code>commitProperties()</code> method. |
| In general, subclassers should |
| override the <code>commitProperties()</code> method and not this method. |
| |
| </p></div><a name="validateSize()"></a><a name="validateSize(Boolean)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">validateSize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function validateSize(recursive:Boolean = false):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| |
| Validates the measured size of the component |
| If the <code>LayoutManager.invalidateSize()</code> method is called with |
| this ILayoutManagerClient, then the <code>validateSize()</code> method |
| is called when it's time to do measurements. |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">recursive</span>:Boolean</code> (default = <code>false</code>)<code></code> — If <code>true</code>, call this method |
| on the objects children. |
| |
| </td></tr></table></p></div><a name="validationResultHandler()"></a><a name="validationResultHandler(mx.events.ValidationResultEvent)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">validationResultHandler</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function validationResultHandler(event:<a href="../../mx/events/ValidationResultEvent.html">ValidationResultEvent</a>):void</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Handles both the <code>valid</code> and <code>invalid</code> events from a |
| validator assigned to this component. |
| <p>You typically handle the <code>valid</code> and <code>invalid</code> events |
| dispatched by a validator by assigning event listeners to the validators. |
| If you want to handle validation events directly in the component that is being validated, |
| you can override this method to handle the <code>valid</code> |
| and <code>invalid</code> events. You typically call |
| <code>super.validationResultHandler(event)</code> in your override.</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">event</span>:<a href="../../mx/events/ValidationResultEvent.html">ValidationResultEvent</a></code> — The event object for the validation. |
| </td></tr></table></p><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/events/ValidationResultEvent.html" target="">mx.events.ValidationResultEvent</a></div></div><a name="verticalGradientMatrix()"></a><a name="verticalGradientMatrix(Number,Number,Number,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">verticalGradientMatrix</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Returns a box Matrix which can be passed to <code>drawRoundRect()</code> |
| as the <code>rot</code> parameter when drawing a vertical gradient. |
| <p>For performance reasons, the Matrix is stored in a static variable |
| which is reused by all calls to <code>horizontalGradientMatrix()</code> |
| and <code>verticalGradientMatrix()</code>. |
| Therefore, pass the resulting Matrix |
| to <code>drawRoundRect()</code> before calling |
| <code>horizontalGradientMatrix()</code> |
| or <code>verticalGradientMatrix()</code> again.</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">x</span>:Number</code> — The left coordinate of the gradient, in pixels. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">y</span>:Number</code> — The top coordinate of the gradient, in pixels. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">width</span>:Number</code> — The width of the gradient, in pixels. |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">height</span>:Number</code> — The height of the gradient, in pixels. |
| </td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Matrix</code> — The Matrix for the vertical gradient. |
| |
| </td></tr></table></div><div class="detailSectionHeader"> Event Detail </div><a name="event:add"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">add</td><td class="detailHeaderType"> Event </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#ADD"><code>mx.events.FlexEvent.ADD</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when the component is added to a container as a content child |
| by using the <code>addChild()</code>, <code>addChildAt()</code>, |
| <code>addElement()</code>, or <code>addElementAt()</code> method. |
| If the component is added to the container as a noncontent child by |
| using the <code>rawChildren.addChild()</code> or |
| <code>rawChildren.addChildAt()</code> method, the event is not dispatched. |
| <p>This event is only dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| |
| </p> |
| The <code>FlexEvent.ADD</code> constant defines the value of the |
| <code>type</code> property of the event object for an <code>add</code> event. |
| <p>This event will only be dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:creationComplete"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">creationComplete</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#CREATION_COMPLETE"><code>mx.events.FlexEvent.CREATION_COMPLETE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when the component has finished its construction, |
| property processing, measuring, layout, and drawing. |
| <p>At this point, depending on its <code>visible</code> property, |
| the component is not visible even though it has been drawn.</p> |
| </p> |
| The <code>FlexEvent.CREATION_COMPLETE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>creationComplete</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:currentStateChange"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">currentStateChange</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/StateChangeEvent.html"><code>mx.events.StateChangeEvent</code></a><br/><span class="label">StateChangeEvent.type property = </span><a href="../../mx/events/StateChangeEvent.html#CURRENT_STATE_CHANGE"><code>mx.events.StateChangeEvent.CURRENT_STATE_CHANGE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched after the view state has changed. |
| |
| <p>This event is only dispatched when there are one or more |
| relevant listeners attached to the dispatching object.</p> |
| </p> |
| The StateChangeEvent.CURRENT_STATE_CHANGE constant defines the |
| value of the <code>type</code> property of the event that is dispatched |
| when the view state has changed. |
| The value of this constant is "currentStateChange". |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>newState</code></td><td>The name of the view state |
| that was entered.</td></tr><tr><td><code>oldState</code></td><td>The name of the view state |
| that was exited.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr><tr><td><code>type</code></td><td>StateChangeEvent.CURRENT_STATE_CHANGE</td></tr></table> |
| </div><a name="event:currentStateChanging"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">currentStateChanging</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/StateChangeEvent.html"><code>mx.events.StateChangeEvent</code></a><br/><span class="label">StateChangeEvent.type property = </span><a href="../../mx/events/StateChangeEvent.html#CURRENT_STATE_CHANGING"><code>mx.events.StateChangeEvent.CURRENT_STATE_CHANGING</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched after the <code>currentState</code> property changes, |
| but before the view state changes. |
| |
| <p>This event is only dispatched when there are one or more |
| relevant listeners attached to the dispatching object.</p> |
| </p> |
| The StateChangeEvent.CURRENT_STATE_CHANGING constant defines the |
| value of the <code>type</code> property of the event that is dispatched |
| when the view state is about to change. |
| The value of this constant is "currentStateChanging". |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>newState</code></td><td>The name of the view state |
| that is being entered.</td></tr><tr><td><code>oldState</code></td><td>The name of the view state |
| that is being exited.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr><tr><td><code>type</code></td><td>StateChangeEvent.CURRENT_STATE_CHANGING</td></tr></table> |
| </div><a name="event:dragComplete"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dragComplete</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/DragEvent.html"><code>mx.events.DragEvent</code></a><br/><span class="label">DragEvent.type property = </span><a href="../../mx/events/DragEvent.html#DRAG_COMPLETE"><code>mx.events.DragEvent.DRAG_COMPLETE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the drag initiator (the component that is the source |
| of the data being dragged) when the drag operation completes, |
| either when you drop the dragged data onto a drop target or when you end |
| the drag-and-drop operation without performing a drop. |
| <p>You can use this event to perform any final cleanup |
| of the drag-and-drop operation. |
| For example, if you drag a List control item from one list to another, |
| you can delete the List control item from the source if you no longer |
| need it.</p> |
| <p>If you call <code>Event.preventDefault()</code> in the event handler |
| for the <code>dragComplete</code> event for |
| a Tree control when dragging data from one Tree control to another, |
| it prevents the drop.</p> |
| </p> |
| The <code>DragEvent.DRAG_COMPLETE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>dragComplete</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>action</code></td><td>The action that caused the event: |
| <code>DragManager.COPY</code>, <code>DragManager.LINK</code>, |
| <code>DragManager.MOVE</code>, or <code>DragManager.NONE</code>.</td></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>dragInitiator</code></td><td>The component that initiated the drag.</td></tr><tr><td><code>dragSource</code></td><td>The DragSource object containing the |
| data being dragged.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:dragDrop"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dragDrop</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/DragEvent.html"><code>mx.events.DragEvent</code></a><br/><span class="label">DragEvent.type property = </span><a href="../../mx/events/DragEvent.html#DRAG_DROP"><code>mx.events.DragEvent.DRAG_DROP</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the drop target when the user releases the mouse over it. |
| <p>You use this event handler to add the drag data to the drop target.</p> |
| <p>If you call <code>Event.preventDefault()</code> in the event handler |
| for the <code>dragDrop</code> event for |
| a Tree control when dragging data from one Tree control to another, |
| it prevents the drop.</p> |
| </p> |
| The <code>DragEvent.DRAG_DROP</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>dragDrop</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>action</code></td><td>The action that caused the event: |
| <code>DragManager.COPY</code>, <code>DragManager.LINK</code>, |
| <code>DragManager.MOVE</code>, or <code>DragManager.NONE</code>.</td></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>dragInitiator</code></td><td>The component that initiated the drag.</td></tr><tr><td><code>dragSource</code></td><td>The DragSource object containing the |
| data being dragged.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:dragEnter"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dragEnter</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/DragEvent.html"><code>mx.events.DragEvent</code></a><br/><span class="label">DragEvent.type property = </span><a href="../../mx/events/DragEvent.html#DRAG_ENTER"><code>mx.events.DragEvent.DRAG_ENTER</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by a component when the user moves the mouse over the component |
| during a drag operation. |
| In an application running in Flash Player, |
| the event is dispatched many times when you move the mouse over any component. |
| In an application running in AIR, the event is dispatched only once. |
| <p>In order to be a valid drop target, you must define a handler |
| for this event. |
| In the handler, you can change the appearance of the drop target |
| to provide visual feedback to the user that the component can accept |
| the drag. |
| For example, you could draw a border around the drop target, |
| or give focus to the drop target.</p> |
| <p>If you want to accept the drag, you must call the |
| <code>DragManager.acceptDragDrop()</code> method. If you don't |
| call <code>acceptDragDrop()</code>, you do not get any of the |
| other drag events.</p> |
| <p>In Flash Player, the value of the <code>action</code> property is always |
| <code>DragManager.MOVE</code>, even if you are doing a copy. |
| This is because the <code>dragEnter</code> event occurs before |
| the control recognizes that the Control key is pressed to signal a copy. |
| The <code>action</code> property of the event object for the |
| <code>dragOver</code> event does contain a value that signifies the type of |
| drag operation. You can change the type of drag action by calling the |
| <code>DragManager.showFeedback()</code> method.</p> |
| <p>In AIR, the default value of the <code>action</code> property is |
| <code>DragManager.COPY</code>.</p> |
| <p>Because of the way data to a Tree control is structured, |
| the Tree control handles drag and drop differently from the other list-based controls. |
| For the Tree control, the event handler for the <code>dragDrop</code> event |
| only performs an action when you move or copy data in the same Tree control, |
| or copy data to another Tree control. |
| If you drag data from one Tree control and drop it onto another Tree control |
| to move the data, the event handler for the <code>dragComplete</code> event |
| actually performs the work to add the data to the destination Tree control, |
| rather than the event handler for the dragDrop event, |
| and also removes the data from the source Tree control. |
| This is necessary because to reparent the data being moved, |
| Flex must remove it first from the source Tree control.</p> |
| </p> |
| The <code>DragEvent.DRAG_ENTER</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>dragEnter</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>action</code></td><td>The action that caused the event, which is always |
| <code>DragManager.MOVE</code>.</td></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>dragInitiator</code></td><td>The component that initiated the drag.</td></tr><tr><td><code>dragSource</code></td><td>The DragSource object containing the |
| data being dragged.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| <p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/managers/DragManager.html" target="">mx.managers.DragManager</a></div></div><a name="event:dragExit"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dragExit</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/DragEvent.html"><code>mx.events.DragEvent</code></a><br/><span class="label">DragEvent.type property = </span><a href="../../mx/events/DragEvent.html#DRAG_EXIT"><code>mx.events.DragEvent.DRAG_EXIT</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the component when the user drags outside the component, |
| but does not drop the data onto the target. |
| <p>You use this event to restore the drop target to its normal appearance |
| if you modified its appearance as part of handling the |
| <code>dragEnter</code> or <code>dragOver</code> event.</p> |
| </p> |
| The <code>DragEvent.DRAG_EXIT</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>dragExit</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>action</code></td><td>The action that caused the event: |
| <code>DragManager.COPY</code>, <code>DragManager.LINK</code>, |
| <code>DragManager.MOVE</code>, or <code>DragManager.NONE</code>.</td></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>dragInitiator</code></td><td>The component that initiated the drag.</td></tr><tr><td><code>dragSource</code></td><td>The DragSource object containing the |
| data being dragged.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:dragOver"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dragOver</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/DragEvent.html"><code>mx.events.DragEvent</code></a><br/><span class="label">DragEvent.type property = </span><a href="../../mx/events/DragEvent.html#DRAG_OVER"><code>mx.events.DragEvent.DRAG_OVER</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by a component when the user moves the mouse while over the component |
| during a drag operation. |
| In Flash Player, the event is dispatched |
| when you drag an item over a valid drop target. |
| In AIR, the event is dispatched when you drag an item over |
| any component, even if the component is not a valid drop target. |
| <p>In the handler, you can change the appearance of the drop target |
| to provide visual feedback to the user that the component can accept |
| the drag. |
| For example, you could draw a border around the drop target, |
| or give focus to the drop target.</p> |
| <p>Handle this event to perform additional logic |
| before allowing the drop, such as dropping data to various locations |
| in the drop target, reading keyboard input to determine if the |
| drag-and-drop action is a move or copy of the drag data, or providing |
| different types of visual feedback based on the type of drag-and-drop |
| action.</p> |
| <p>You can also change the type of drag action by changing the |
| <code>DragManager.showFeedback()</code> method. |
| The default value of the <code>action</code> property is |
| <code>DragManager.MOVE</code>.</p> |
| </p> |
| The <code>DragEvent.DRAG_OVER</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>dragOver</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>action</code></td><td>The action that caused the event: |
| <code>DragManager.COPY</code>, <code>DragManager.LINK</code>, |
| <code>DragManager.MOVE</code>, or <code>DragManager.NONE</code>.</td></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>dragInitiator</code></td><td>The component that initiated the drag.</td></tr><tr><td><code>dragSource</code></td><td>The DragSource object containing the |
| data being dragged.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| <p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/managers/DragManager.html" target="">mx.managers.DragManager</a></div></div><a name="event:dragStart"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">dragStart</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/DragEvent.html"><code>mx.events.DragEvent</code></a><br/><span class="label">DragEvent.type property = </span><a href="../../mx/events/DragEvent.html#DRAG_START"><code>mx.events.DragEvent.DRAG_START</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the drag initiator when starting a drag operation. |
| This event is used internally by the list-based controls; |
| you do not handle it when implementing drag and drop. |
| If you want to control the start of a drag-and-drop operation, |
| use the <code>mouseDown</code> or <code>mouseMove</code> event. |
| </p> |
| The DragEvent.DRAG_START constant defines the value of the |
| <code>type</code> property of the event object for a <code>dragStart</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>action</code></td><td>The action that caused the event: |
| <code>DragManager.COPY</code>, <code>DragManager.LINK</code>, |
| <code>DragManager.MOVE</code>, or <code>DragManager.NONE</code>.</td></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>dragInitiator</code></td><td>The component that initiated the drag.</td></tr><tr><td><code>dragSource</code></td><td>The DragSource object containing the |
| data being dragged.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:effectEnd"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effectEnd</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/EffectEvent.html"><code>mx.events.EffectEvent</code></a><br/><span class="label">EffectEvent.type property = </span><a href="../../mx/events/EffectEvent.html#EFFECT_END"><code>mx.events.EffectEvent.EFFECT_END</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched after an effect ends. |
| <p>The effect makes the last set of visual changes |
| before this event is fired, but those changes are not |
| rendered on the screen. |
| Thus, you might have to use the <code>callLater()</code> method |
| to delay any other changes that you want to make until after the |
| changes have been rendered onscreen.</p> |
| </p> |
| The <code>EffectEvent.EFFECT_END</code> constant defines the value of the |
| <code>type</code> property of the event object for an |
| <code>effectEnd</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>effectInstance</code></td><td>The effect instance object |
| for the event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:effectStart"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effectStart</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/EffectEvent.html"><code>mx.events.EffectEvent</code></a><br/><span class="label">EffectEvent.type property = </span><a href="../../mx/events/EffectEvent.html#EFFECT_START"><code>mx.events.EffectEvent.EFFECT_START</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched just before an effect starts. |
| <p>The effect does not start changing any visuals |
| until after this event is fired.</p> |
| </p> |
| The <code>EffectEvent.EFFECT_START</code> constant defines the value of the |
| <code>type</code> property of the event object for an |
| <code>effectStart</code> event. |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>effectInstance</code></td><td>The effect instance object |
| for the event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:effectStop"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">effectStop</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/EffectEvent.html"><code>mx.events.EffectEvent</code></a><br/><span class="label">EffectEvent.type property = </span><a href="../../mx/events/EffectEvent.html#EFFECT_STOP"><code>mx.events.EffectEvent.EFFECT_STOP</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched after an effect is stopped, which happens |
| only by a call to <code>stop()</code> on the effect. |
| <p>The effect then dispatches the EFFECT_END event |
| as the effect finishes. The purpose of the EFFECT_STOP |
| event is to let listeners know that the effect came to |
| a premature end, rather than ending naturally or as a |
| result of a call to <code>end()</code>.</p> |
| </p> |
| The <code>EffectEvent.EFFECT_STOP</code> constant defines the value of the |
| <code>type</code> property of the event object for an |
| <code>effectStop</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>effectInstance</code></td><td>The effect instance object |
| for the event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:enterState"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">enterState</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#ENTER_STATE"><code>mx.events.FlexEvent.ENTER_STATE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched after the component has entered a view state. |
| |
| <p>This event is only dispatched when there are one or more |
| relevant listeners attached to the dispatching object.</p> |
| </p> |
| The <code>FlexEvent.ENTER_STATE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>enterState</code> event. |
| <p>This event will only be dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:exitState"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">exitState</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#EXIT_STATE"><code>mx.events.FlexEvent.EXIT_STATE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched just before the component exits a view state. |
| |
| <p>This event is only dispatched when there are one or more |
| relevant listeners attached to the dispatching object.</p> |
| </p> |
| The <code>FlexEvent.EXIT_STATE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>exitState</code> event. |
| <p>This event will only be dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:hide"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">hide</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#HIDE"><code>mx.events.FlexEvent.HIDE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when an object's state changes from visible to invisible. |
| |
| <p>This event is only dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| </p> |
| The <code>FlexEvent.HIDE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>hide</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:initialize"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">initialize</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#INITIALIZE"><code>mx.events.FlexEvent.INITIALIZE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when the component has finished its construction |
| and has all initialization properties set. |
| <p>After the initialization phase, properties are processed, the component |
| is measured, laid out, and drawn, after which the |
| <code>creationComplete</code> event is dispatched.</p> |
| |
| </p> |
| The <code>FlexEvent.INITIALIZE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>initialize</code> event. |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:invalid"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">invalid</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#INVALID"><code>mx.events.FlexEvent.INVALID</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when a component is monitored by a Validator |
| and the validation failed. |
| </p> |
| The <code>FlexEvent.INVALID</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>invalid</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:mouseDownOutside"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseDownOutside</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexMouseEvent.html"><code>mx.events.FlexMouseEvent</code></a><br/><span class="label">FlexMouseEvent.type property = </span><a href="../../mx/events/FlexMouseEvent.html#MOUSE_DOWN_OUTSIDE"><code>mx.events.FlexMouseEvent.MOUSE_DOWN_OUTSIDE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched from a component opened using the PopUpManager |
| when the user clicks outside it. |
| </p> |
| The <code>FlexMouseEvent.MOUSE_DOWN_OUTSIDE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>mouseDownOutside</code> |
| event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>altKey</code></td><td>Indicates whether the Alt key is down |
| (<code>true</code>) or not (<code>false</code>).</td></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>buttonDown</code></td><td>Indicates whether the main mouse button is down |
| (<code>true</code>) or not (<code>false</code>).</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>ctrlKey</code></td><td>Indicates whether the Control key is down |
| (<code>true</code>) or not (<code>false</code>).</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. |
| For PopUpManager events, the object is the pop-up window.</td></tr><tr><td><code>delta</code></td><td>Indicates how many lines should be scrolled for each notch the user |
| scrolls the mouse wheel. |
| For PopUpManager events this value is 0.</td></tr><tr><td><code>localX</code></td><td>The horizontal position at which the event occurred. |
| For PopUpManager events, the value is relative to the pop-up control.</td></tr><tr><td><code>localY</code></td><td>The vertical position at which the event occurred. |
| For PopUpManager events, the value is relative to the pop-up control.</td></tr><tr><td><code>relatedObject</code></td><td>A reference to a display list object that is related to the event. |
| For PopUpManager events, the object is the container over which |
| the mouse pointer is located.</td></tr><tr><td><code>shiftKey</code></td><td>Indicates whether the Shift key is down |
| (<code>true</code>) or not (<code>false</code>).</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event. |
| For PopUpManager events, the object is the pop-up window.</td></tr></table> |
| </div><a name="event:mouseWheelOutside"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">mouseWheelOutside</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexMouseEvent.html"><code>mx.events.FlexMouseEvent</code></a><br/><span class="label">FlexMouseEvent.type property = </span><a href="../../mx/events/FlexMouseEvent.html#MOUSE_WHEEL_OUTSIDE"><code>mx.events.FlexMouseEvent.MOUSE_WHEEL_OUTSIDE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched from a component opened using the PopUpManager |
| when the user scrolls the mouse wheel outside it. |
| </p> |
| The <code>FlexMouseEvent.MOUSE_WHEEL_OUTSIDE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>mouseWheelOutside</code> |
| event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>altKey</code></td><td>Indicates whether the Alt key is down |
| (<code>true</code>) or not (<code>false</code>).</td></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>buttonDown</code></td><td>Indicates whether the main mouse button is down |
| (<code>true</code>) or not (<code>false</code>).</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>ctrlKey</code></td><td>Indicates whether the Control key is down |
| (<code>true</code>) or not (<code>false</code>).</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. |
| For PopUpManager events, the object is the pop-up window.</td></tr><tr><td><code>delta</code></td><td>Indicates how many lines should be scrolled for each notch the user |
| scrolls the mouse wheel. |
| For PopUpManager events this value is 0.</td></tr><tr><td><code>localX</code></td><td>The horizontal position at which the event occurred. |
| For PopUpManager events, the value is relative to the pop-up control.</td></tr><tr><td><code>localY</code></td><td>The vertical position at which the event occurred. |
| For PopUpManager events, the value is relative to the pop-up control.</td></tr><tr><td><code>relatedObject</code></td><td>A reference to a display list object that is related to the event. |
| For PopUpManager events, the object is the container over which |
| the mouse pointer is located.</td></tr><tr><td><code>shiftKey</code></td><td>Indicates whether the Shift key is down |
| (<code>true</code>) or not (<code>false</code>).</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event. |
| For PopUpManager events, the object is the pop-up window.</td></tr></table> |
| </div><a name="event:move"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">move</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/MoveEvent.html"><code>mx.events.MoveEvent</code></a><br/><span class="label">MoveEvent.type property = </span><a href="../../mx/events/MoveEvent.html#MOVE"><code>mx.events.MoveEvent.MOVE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when the object has moved. |
| <p>You can move the component by setting the <code>x</code> |
| or <code>y</code> properties, by calling the <code>move()</code> |
| method, by setting one |
| of the following properties either on the component or on other |
| components such that the LayoutManager needs to change the |
| <code>x</code> or <code>y</code> properties of the component:</p> |
| <ul> |
| <li><code>minWidth</code></li> |
| <li><code>minHeight</code></li> |
| <li><code>maxWidth</code></li> |
| <li><code>maxHeight</code></li> |
| <li><code>explicitWidth</code></li> |
| <li><code>explicitHeight</code></li> |
| </ul> |
| <p>When you call the <code>move()</code> method, the <code>move</code> |
| event is dispatched before the method returns. |
| In all other situations, the <code>move</code> event is not dispatched |
| until after the property changes.</p> |
| |
| <p>This event only dispatched when there are one or more |
| relevant listeners attached to the dispatching object.</p> |
| </p> |
| The <code>MoveEvent.MOVE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>move</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>oldX</code></td><td>The previous x coordinate of the object, in pixels.</td></tr><tr><td><code>oldY</code></td><td>The previous y coordinate of the object, in pixels.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:preinitialize"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">preinitialize</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#PREINITIALIZE"><code>mx.events.FlexEvent.PREINITIALIZE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched at the beginning of the component initialization sequence. |
| The component is in a very raw state when this event is dispatched. |
| Many components, such as the Button control, create internal child |
| components to implement functionality; for example, the Button control |
| creates an internal UITextField component to represent its label text. |
| When Flex dispatches the <code>preinitialize</code> event, |
| the children, including the internal children, of a component |
| have not yet been created. |
| |
| </p> |
| The <code>FlexEvent.PREINITIALIZE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>preinitialize</code> event. |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:remove"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">remove</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#REMOVE"><code>mx.events.FlexEvent.REMOVE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when the component is removed from a container as a content child |
| by using the <code>removeChild()</code>, <code>removeChildAt()</code>, |
| <code>removeElement()</code>, or <code>removeElementAt()</code> method. |
| If the component is removed from the container as a noncontent child by |
| using the <code>rawChildren.removeChild()</code> or |
| <code>rawChildren.removeChildAt()</code> method, the event is not dispatched. |
| <p>This event only dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| |
| </p> |
| The <code>FlexEvent.REMOVE</code> constant defines the value of the |
| <code>type</code> property of the event object for an <code>remove</code> event. |
| <p>This event will only be dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:resize"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">resize</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ResizeEvent.html"><code>mx.events.ResizeEvent</code></a><br/><span class="label">ResizeEvent.type property = </span><a href="../../mx/events/ResizeEvent.html#RESIZE"><code>mx.events.ResizeEvent.RESIZE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when the component is resized. |
| <p>You can resize the component by setting the <code>width</code> or |
| <code>height</code> property, by calling the <code>setActualSize()</code> |
| method, or by setting one of |
| the following properties either on the component or on other components |
| such that the LayoutManager needs to change the <code>width</code> or |
| <code>height</code> properties of the component:</p> |
| <ul> |
| <li><code>minWidth</code></li> |
| <li><code>minHeight</code></li> |
| <li><code>maxWidth</code></li> |
| <li><code>maxHeight</code></li> |
| <li><code>explicitWidth</code></li> |
| <li><code>explicitHeight</code></li> |
| </ul> |
| <p>The <code>resize</code> event is not |
| dispatched until after the property changes.</p> |
| |
| <p>This event only dispatched when there are one or more |
| relevant listeners attached to the dispatching object.</p> |
| </p> |
| The <code>ResizeEvent.RESIZE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>resize</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>oldHeight</code></td><td>The previous height of the object, in pixels.</td></tr><tr><td><code>oldWidth</code></td><td>The previous width of the object, in pixels.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:show"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">show</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#SHOW"><code>mx.events.FlexEvent.SHOW</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when an object's state changes from invisible to visible. |
| |
| <p>This event is only dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| </p> |
| The <code>FlexEvent.SHOW</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>show</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:stateChangeComplete"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">stateChangeComplete</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#STATE_CHANGE_COMPLETE"><code>mx.events.FlexEvent.STATE_CHANGE_COMPLETE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| Dispatched after the component has entered a new state and |
| any state transition animation to that state has finished playing. |
| The event is dispatched immediately if there's no transition playing |
| between the states. |
| If the component switches to a different state while the transition is |
| underway, this event will be dispatched after the component completes the |
| transition to that new state. |
| |
| <p>This event is only dispatched when there are one or more |
| relevant listeners attached to the dispatching object.</p> |
| </p> |
| The <code>FlexEvent.STATE_CHANGE_COMPLETE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>stateChangeComplete</code> event. |
| <p>This event will only be dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:stateChangeInterrupted"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">stateChangeInterrupted</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#STATE_CHANGE_INTERRUPTED"><code>mx.events.FlexEvent.STATE_CHANGE_INTERRUPTED</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| Dispatched when a component interrupts a transition to its current |
| state in order to switch to a new state. |
| |
| <p>This event is only dispatched when there are one or more |
| relevant listeners attached to the dispatching object.</p> |
| </p> |
| The <code>FlexEvent.STATE_CHANGE_INTERRUPTED</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>stateChangeInterrupted</code> event. |
| <p>This event will only be dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:toolTipCreate"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toolTipCreate</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ToolTipEvent.html"><code>mx.events.ToolTipEvent</code></a><br/><span class="label">ToolTipEvent.type property = </span><a href="../../mx/events/ToolTipEvent.html#TOOL_TIP_CREATE"><code>mx.events.ToolTipEvent.TOOL_TIP_CREATE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the component when it is time to create a ToolTip. |
| <p>If you create your own IToolTip object and place a reference |
| to it in the <code>toolTip</code> property of the event object |
| that is passed to your <code>toolTipCreate</code> handler, |
| the ToolTipManager displays your custom ToolTip. |
| Otherwise, the ToolTipManager creates an instance of |
| <code>ToolTipManager.toolTipClass</code> to display.</p> |
| <p>The sequence of ToolTip events is <code>toolTipStart</code>, |
| <code>toolTipCreate</code>, <code>toolTipShow</code>, |
| <code>toolTipShown</code>, <code>toolTipHide</code>, |
| and <code>toolTipEnd</code>.</p> |
| </p> |
| The <code>ToolTipEvent.TOOL_TIP_CREATE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>toolTipCreate</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr><tr><td><code>tooltip</code></td><td>The ToolTip object to |
| which this event applies.</td></tr></table> |
| </div><a name="event:toolTipEnd"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toolTipEnd</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ToolTipEvent.html"><code>mx.events.ToolTipEvent</code></a><br/><span class="label">ToolTipEvent.type property = </span><a href="../../mx/events/ToolTipEvent.html#TOOL_TIP_END"><code>mx.events.ToolTipEvent.TOOL_TIP_END</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the component when its ToolTip has been hidden |
| and is to be discarded soon. |
| <p>If you specify an effect using the |
| <code>ToolTipManager.hideEffect</code> property, |
| this event is dispatched after the effect stops playing.</p> |
| <p>The sequence of ToolTip events is <code>toolTipStart</code>, |
| <code>toolTipCreate</code>, <code>toolTipShow</code>, |
| <code>toolTipShown</code>, <code>toolTipHide</code>, |
| and <code>toolTipEnd</code>.</p> |
| </p> |
| The <code>ToolTipEvent.TOOL_TIP_END</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>toolTipEnd</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr><tr><td><code>tooltip</code></td><td>The ToolTip object to |
| which this event applies.</td></tr></table> |
| </div><a name="event:toolTipHide"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toolTipHide</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ToolTipEvent.html"><code>mx.events.ToolTipEvent</code></a><br/><span class="label">ToolTipEvent.type property = </span><a href="../../mx/events/ToolTipEvent.html#TOOL_TIP_HIDE"><code>mx.events.ToolTipEvent.TOOL_TIP_HIDE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the component when its ToolTip is about to be hidden. |
| <p>If you specify an effect using the |
| <code>ToolTipManager.hideEffect</code> property, |
| this event is dispatched before the effect starts playing.</p> |
| <p>The sequence of ToolTip events is <code>toolTipStart</code>, |
| <code>toolTipCreate</code>, <code>toolTipShow</code>, |
| <code>toolTipShown</code>, <code>toolTipHide</code>, |
| and <code>toolTipEnd</code>.</p> |
| </p> |
| The <code>ToolTipEvent.TOOL_TIP_HIDE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>toolTipHide</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr><tr><td><code>tooltip</code></td><td>The ToolTip object to |
| which this event applies.</td></tr></table> |
| </div><a name="event:toolTipShow"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toolTipShow</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ToolTipEvent.html"><code>mx.events.ToolTipEvent</code></a><br/><span class="label">ToolTipEvent.type property = </span><a href="../../mx/events/ToolTipEvent.html#TOOL_TIP_SHOW"><code>mx.events.ToolTipEvent.TOOL_TIP_SHOW</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the component when its ToolTip is about to be shown. |
| <p>If you specify an effect using the |
| <code>ToolTipManager.showEffect</code> property, |
| this event is dispatched before the effect starts playing. |
| You can use this event to modify the ToolTip before it appears.</p> |
| <p>The sequence of ToolTip events is <code>toolTipStart</code>, |
| <code>toolTipCreate</code>, <code>toolTipShow</code>, |
| <code>toolTipShown</code>, <code>toolTipHide</code>, |
| and <code>toolTipEnd</code>.</p> |
| </p> |
| The <code>ToolTipEvent.TOOL_TIP_SHOW</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>toolTipShow</code> event. |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr><tr><td><code>tooltip</code></td><td>The ToolTip object to |
| which this event applies.</td></tr></table> |
| </div><a name="event:toolTipShown"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toolTipShown</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ToolTipEvent.html"><code>mx.events.ToolTipEvent</code></a><br/><span class="label">ToolTipEvent.type property = </span><a href="../../mx/events/ToolTipEvent.html#TOOL_TIP_SHOWN"><code>mx.events.ToolTipEvent.TOOL_TIP_SHOWN</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by the component when its ToolTip has been shown. |
| <p>If you specify an effect using the |
| <code>ToolTipManager.showEffect</code> property, |
| this event is dispatched after the effect stops playing.</p> |
| <p>The sequence of ToolTip events is <code>toolTipStart</code>, |
| <code>toolTipCreate</code>, <code>toolTipShow</code>, |
| <code>toolTipShown</code>, <code>toolTipHide</code>, |
| and <code>toolTipEnd</code>.</p> |
| </p> |
| The <code>ToolTipEvent.TOOL_TIP_SHOWN</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>toolTipShown</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr><tr><td><code>tooltip</code></td><td>The ToolTip object to |
| which this event applies.</td></tr></table> |
| </div><a name="event:toolTipStart"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toolTipStart</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/ToolTipEvent.html"><code>mx.events.ToolTipEvent</code></a><br/><span class="label">ToolTipEvent.type property = </span><a href="../../mx/events/ToolTipEvent.html#TOOL_TIP_START"><code>mx.events.ToolTipEvent.TOOL_TIP_START</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched by a component whose <code>toolTip</code> property is set, |
| as soon as the user moves the mouse over it. |
| <p>The sequence of ToolTip events is <code>toolTipStart</code>, |
| <code>toolTipCreate</code>, <code>toolTipShow</code>, |
| <code>toolTipShown</code>, <code>toolTipHide</code>, |
| and <code>toolTipEnd</code>.</p> |
| </p> |
| The <code>ToolTipEvent.TOOL_TIP_START</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>toolTipStart</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr><tr><td><code>tooltip</code></td><td>The ToolTip object to |
| which this event applies.</td></tr></table> |
| </div><a name="event:touchInteractionEnd"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">touchInteractionEnd</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/TouchInteractionEvent.html"><code>mx.events.TouchInteractionEvent</code></a><br/><span class="label">TouchInteractionEvent.type property = </span><a href="../../mx/events/TouchInteractionEvent.html#TOUCH_INTERACTION_END"><code>mx.events.TouchInteractionEvent.TOUCH_INTERACTION_END</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| A non-cancellable event, dispatched by a component when it is done |
| responding to a touch interaction user gesture. |
| |
| <p>The event is a bubbling event dispatched on the |
| DisplayObject that the touch interaction |
| started (where the mouseDown/touchBegin occurred).</p> |
| |
| <p>Components responding to touch interactions should listen for |
| touch interaction events to coordinate with other components around |
| what type of touch interaction the user intended to make and which component |
| is responding to that touch interaction.</p> |
| |
| <p>A Scroller component will dispatch a touchInteractionEnd event |
| to alert other components that it is done responding to the user's |
| touch interaction.</p> |
| </p> |
| The <code>TouchInteractionEvent.TOUCH_INTERACTION_END</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>touchInteractionEnd</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>reason</code></td><td>The reason for the touch interaction event. See |
| <code>mx.events.TouchInteractionReason</code>.</td></tr><tr><td><code>relatedObject</code></td><td>The object associated with this touch interaction event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:touchInteractionStart"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">touchInteractionStart</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/TouchInteractionEvent.html"><code>mx.events.TouchInteractionEvent</code></a><br/><span class="label">TouchInteractionEvent.type property = </span><a href="../../mx/events/TouchInteractionEvent.html#TOUCH_INTERACTION_START"><code>mx.events.TouchInteractionEvent.TOUCH_INTERACTION_START</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| A non-cancellable event, dispatched by a component when it starts |
| responding to a touch interaction user gesture. |
| |
| <p>The event is a bubbling event dispatched on the |
| DisplayObject that the touch interaction |
| started (where the mouseDown/touchBegin occurred).</p> |
| |
| <p>Components responding to touch interactions should listen for |
| touch interaction events to coordinate with other components around |
| what type of touch interaction the user intended to make and which component |
| is responding to that touch interaction.</p> |
| |
| <p>A Scroller component will dispatch a touchInteractionStart event |
| to alert other components that may be responding to the same user's |
| touch interaction that it is taking control of this touch interaction. |
| When they see this event, other components should stop responding |
| to the touch interaction, remove any visual indications that it is |
| responding to the touch interaction, and perform other clean up.</p> |
| </p> |
| The <code>TouchInteractionEvent.TOUCH_INTERACTION_START</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>touchInteractionStart</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>true</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>reason</code></td><td>The reason for the touch interaction event. See |
| <code>mx.events.TouchInteractionReason</code>.</td></tr><tr><td><code>relatedObject</code></td><td>The object associated with this touch interaction event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:touchInteractionStarting"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">touchInteractionStarting</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/TouchInteractionEvent.html"><code>mx.events.TouchInteractionEvent</code></a><br/><span class="label">TouchInteractionEvent.type property = </span><a href="../../mx/events/TouchInteractionEvent.html#TOUCH_INTERACTION_STARTING"><code>mx.events.TouchInteractionEvent.TOUCH_INTERACTION_STARTING</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions : </b></td><td>Flash Player 10, AIR 2.5</td></tr></table><p></p><p></p><p> |
| A cancellable event, dispatched by a component in an attempt to |
| respond to a touch interaction user gesture. |
| |
| <p>The event is a bubbling event dispatched on the |
| DisplayObject that the touch interaction |
| started (where the mouseDown/touchBegin occurred).</p> |
| |
| <p>Components responding to touch interactions should listen for |
| touch interaction events to coordinate with other components around |
| what type of touch interaction the user intended to make and which component |
| is responding to that touch interaction.</p> |
| |
| <p>A Scroller component will dispatch a touchInteractionStarting event |
| to alert other components that may be responding to the same user's |
| touch interaction that it would like to take control of this touch interaction. |
| This is an opportunity for other components to cancel the Scroller's |
| action and to maintain control over this touch interaction.</p> |
| </p> |
| The <code>TouchInteractionEvent.TOUCH_INTERACTION_STARTING</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>touchInteractionStarting</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>true</td></tr><tr><td><code>cancelable</code></td><td>true</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>reason</code></td><td>The reason for the touch interaction event. See |
| <code>mx.events.TouchInteractionReason</code>.</td></tr><tr><td><code>relatedObject</code></td><td>The object associated with this touch interaction event.</td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:updateComplete"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">updateComplete</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#UPDATE_COMPLETE"><code>mx.events.FlexEvent.UPDATE_COMPLETE</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when an object has had its <code>commitProperties()</code>, |
| <code>measure()</code>, and |
| <code>updateDisplayList()</code> methods called (if needed). |
| <p>This is the last opportunity to alter the component before it is |
| displayed. All properties have been committed and the component has |
| been measured and layed out.</p> |
| <p>This event is only dispatched when there are one or more |
| relevant listeners attached to the dispatching object.</p> |
| |
| </p> |
| The <code>FlexEvent.UPDATE_COMPLETE</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>updateComplete</code> event. |
| |
| <p>This event will only be dispatched when there are one or more relevant listeners |
| attached to the dispatching object.</p> |
| |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:valid"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">valid</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#VALID"><code>mx.events.FlexEvent.VALID</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when a component is monitored by a Validator |
| and the validation succeeded. |
| </p> |
| The <code>FlexEvent.VALID</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>valid</code> event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><a name="event:valueCommit"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">valueCommit</td><td class="detailHeaderType"> Event </td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><span class="label">Event Object Type: </span><a href="../../mx/events/FlexEvent.html"><code>mx.events.FlexEvent</code></a><br/><span class="label">FlexEvent.type property = </span><a href="../../mx/events/FlexEvent.html#VALUE_COMMIT"><code>mx.events.FlexEvent.VALUE_COMMIT</code></a><br/><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| Dispatched when values are changed programmatically |
| or by user interaction. |
| <p>Because a programmatic change triggers this event, make sure |
| that any <code>valueCommit</code> event handler does not change |
| a value that causes another <code>valueCommit</code> event. |
| For example, do not change a control's <code>dataProvider</code> |
| property in a <code>valueCommit</code> event handler. </p> |
| </p> |
| The <code>FlexEvent.VALUE_COMMIT</code> constant defines the value of the |
| <code>type</code> property of the event object for a <code>valueCommit</code> |
| event. |
| <p>The properties of the event object have the following values:</p> |
| <table class="innertable" ><tr><th>Property</th><th>Value</th></tr><tr><td><code>bubbles</code></td><td>false</td></tr><tr><td><code>cancelable</code></td><td>false</td></tr><tr><td><code>currentTarget</code></td><td>The Object that defines the |
| event listener that handles the event. For example, if you use |
| <code>myButton.addEventListener()</code> to register an event listener, |
| myButton is the value of the <code>currentTarget</code>. </td></tr><tr><td><code>target</code></td><td>The Object that dispatched the event; |
| it is not always the Object listening for the event. |
| Use the <code>currentTarget</code> property to always access the |
| Object listening for the event.</td></tr></table> |
| </div><div class="detailSectionHeader">Constant Detail</div><a name="constantDetail"></a><a name="DEFAULT_MAX_HEIGHT"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DEFAULT_MAX_HEIGHT</td><td class="detailHeaderType">Constant</td></tr></table><div class="detailBody"><code>public static const DEFAULT_MAX_HEIGHT:Number = 10000</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The default value for the <code>maxHeight</code> property. |
| </p><p> The default value is <code>10000</code>.</p></div><a name="constantDetail"></a><a name="DEFAULT_MAX_WIDTH"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DEFAULT_MAX_WIDTH</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const DEFAULT_MAX_WIDTH:Number = 10000</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The default value for the <code>maxWidth</code> property. |
| </p><p> The default value is <code>10000</code>.</p></div><a name="constantDetail"></a><a name="DEFAULT_MEASURED_HEIGHT"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DEFAULT_MEASURED_HEIGHT</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const DEFAULT_MEASURED_HEIGHT:Number = 22</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The default value for the <code>measuredHeight</code> property. |
| Most components calculate a measuredHeight but some are flow-based and |
| have to pick a number that looks reasonable. |
| </p><p> The default value is <code>22</code>.</p></div><a name="constantDetail"></a><a name="DEFAULT_MEASURED_MIN_HEIGHT"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DEFAULT_MEASURED_MIN_HEIGHT</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const DEFAULT_MEASURED_MIN_HEIGHT:Number = 22</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The default value for the <code>measuredMinHeight</code> property. |
| Most components calculate a measuredMinHeight but some are flow-based and |
| have to pick a number that looks reasonable. |
| </p><p> The default value is <code>22</code>.</p></div><a name="constantDetail"></a><a name="DEFAULT_MEASURED_MIN_WIDTH"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DEFAULT_MEASURED_MIN_WIDTH</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const DEFAULT_MEASURED_MIN_WIDTH:Number = 40</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The default value for the <code>measuredMinWidth</code> property. |
| Most components calculate a measuredMinWidth but some are flow-based and |
| have to pick a number that looks reasonable. |
| </p><p> The default value is <code>40</code>.</p></div><a name="constantDetail"></a><a name="DEFAULT_MEASURED_WIDTH"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DEFAULT_MEASURED_WIDTH</td><td class="detailHeaderType">Constant</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code>public static const DEFAULT_MEASURED_WIDTH:Number = 160</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version : </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 : </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 : </b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p> |
| The default value for the <code>measuredWidth</code> property. |
| Most components calculate a measuredWidth but some are flow-based and |
| have to pick a number that looks reasonable. |
| </p><p> The default value is <code>160</code>.</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 --> |
