| <!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="DisplayLayer,spark.components.supportClasses.DisplayLayer,BOTTOM,BOTTOM,CONTAINS,DOWN,DROP_INDICATOR,ENDS_WITH,EXACT,FOCUS_PANE,LEFT,MASK,NONE,NOT,NOT_EMPTY,NO_SELECTION,OVER,POP,POP_ALL,POP_TO_FIRST,PUSH,REPLACE,RIGHT,STARTS_WITH,TOP,TOP,UP,_displayAsPassword,_editable,_maxChars,_multiline,_restrict,activeView,arrowKeysWrapFocus,autoCapitalize,autoCapitalize,autoCapitalize,autoCorrect,autoCorrect,autoCorrect,autoDrawBackground,autoLayout,autoRepeat,baselinePosition,baselinePosition,caretIndex,clipAndEnableScrolling,closeDropDownOnResize,closeOnResize,content,contentHeight,contentWidth,context,currentCSSState,dataField,dataTipFormatFunction,dataTipPrecision,debugId,defaultButton,defaultStyles,densityScale,displayAsPassword,displayAsPassword,displayAsPassword,down,dragging,dropDownController,editable,editable,editable,editable,enableIME,enabled,endFunction,focusEnabled,focusSkinExclusions,gap,headerStyleName,headerText,hiddenFocusStageText,hitAreaAdditions,horizontalScrollPosition,horizontalScrollPosition,hovered,hovered,icon,iconField,iconFunction,imeMode,invalidateStyleFlag,isActive,isAndroid,isDesktop,isDropDownOpen,isDropDownOpen,isFirstRow,isFirstRow,isLastRow,isLastRow,isOpen,isTruncated,isTruncated,itemIndex,itemRenderer,keyboardPressed,label,label,label,labelDisplay,labelField,labelFunction,labelFunction,lastFocusedStageText,layout,lineBreak,luminosityClip,luminosityInvert,mask,maskType,maxChars,maxChars,maxChars,maxDisplayedLines,maxDragRate,maximum,maximum,minHeight,minWidth,minimum,mouseCaptured,mouseEnabledWhereTransparent,multiline,multiline,numDisplayObjects,numElements,object,openButton,overlay,pageSize,parentNavigator,pendingValue,pendingValue,percentWidth,persistNavigatorState,persistenceManager,preventSelection,prompt,proxy,repeatFunction,requireSelection,resizeMode,restrict,restrict,restrict,returnKeyLabel,returnKeyLabel,returnKeyLabel,rollOverOpenDelay,selectable,selected,selected,selectedIndex,selectedItem,selectionActivePosition,selectionActivePosition,selectionActivePosition,selectionActivePosition,selectionAnchorPosition,selectionAnchorPosition,selectionAnchorPosition,selectionAnchorPosition,selectionHighlighting,showDataTip,showTruncationTip,showsCaret,skin,snapInterval,snapInterval,softKeyboardType,softKeyboardType,softKeyboardType,sortDescending,sortField,sortable,stageText,startFunction,state,stepSize,stickyHighlighting,stopFunction,styleDeclaration,styleName,styleName,styleName,suggestedFocusSkinExclusions,supportedStyles,systemManager,text,text,text,text,text,text,textAlign,transitionsEnabled,typicalText,updateFunction,useVirtualLayout,value,verticalScrollPosition,verticalScrollPosition,viewMenuOpen,viewport,width,addDisplayObject,addedToStageHandler,adjustSelection,animatePaging,animateStepping,animationEnd,animationRepeat,animationStart,animationStop,animationUpdate,appendText,appendText,appendText,appendText,attachSkin,backKeyUpHandler,backKeyUpHandler,beginHighlightBitmapCapture,buttonReleased,button_buttonDownHandler,button_buttonUpHandler,changeValueByPage,changeValueByStep,clearSkinParts,clickHandler,closeDropDown,closeDropDown,closeDropDown,commitStyles,commitStyles,containsElement,createChildren,createDynamicPartInstance,createPatternString,createPersistenceManager,createProxy,createRegExp,deactivateHandler,detachSkin,disposeProxy,endHighlightBitmapCapture,endTextEdit,findRowIndex,findRowIndex,findRowIndices,findRowIndices,findSkinParts,getButtonIndices,getCurrentRendererState,getCurrentSkinState,getCurrentSkinState,getDisplayObjectAt,getDisplayObjectDepth,getDynamicPartAt,getElementAt,getElementIndex,getGlobalViewPort,getHorizontalScrollPositionDelta,getStyle,getVerticalScrollPositionDelta,getVirtualElementAt,insertText,insertText,insertText,insertText,invalidateRendererState,invalidateSkinState,invokeHandler,itemAdded,itemRemoved,itemSelected,itemShowingCaret,itemToLabel,keepSoftKeyboardActive,loadNavigatorState,loadViewData,measureTextLineHeight,menuKeyUpHandler,mouseEventHandler,moveIndexFindRow,moveIndexFindRow,moveIndexFirstRow,moveIndexFirstRow,moveIndexLastRow,moveIndexLastRow,moveIndexNextRow,moveIndexNextRow,moveIndexPreviousRow,moveIndexPreviousRow,nearestValidValue,numDynamicParts,openDropDown,openDropDown,openDropDown,partAdded,partRemoved,pointToValue,prepareForTouchScroll,processFocusOut,processKeyDown,removeDisplayObject,removeDynamicPartInstance,removedFromStageHandler,restoreStageText,saveNavigatorState,saveViewData,scrollToRange,selectAll,selectAll,selectAll,selectAll,selectRange,selectRange,selectRange,selectRange,setButtonEnabled,setButtonsEnabled,setContentSize,setFocus,setSelectedIndex,setStyle,setValue,stageText_changeHandler,stageText_completeHandler,startTextEdit,styleChanged,truncateToFit,updateControlsForView,updateDataTip,updateProxy,updateSkinDisplayList,updateViewPort"><title>spark.components.supportClasses.DisplayLayer</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 = 'DisplayLayer - 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?spark/components/supportClasses/DisplayLayer.html&spark/components/supportClasses/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">DisplayLayer</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a> | <a href="#methodSummary">Methods</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("DisplayLayer"); titleBar_setSubNav(false,true,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);} | |
| --> | |
| </script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">spark.components.supportClasses</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class DisplayLayer</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">DisplayLayer <img src="../../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> flash.events.EventDispatcher</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 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></p><p></p> | |
| A DisplayLayer class maintains an ordered list of DisplayObjects sorted on | |
| depth. | |
| You do not instantiate this class, but use the <code>overlay</code> | |
| property of <code>Group</code> and <code>DataGroup</code>. | |
| <p></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso"><a href="../../../spark/components/Group.html#overlay" target="">spark.components.Group.overlay</a><br/><a href="../../../spark/components/DataGroup.html#overlay" target="">spark.components.DataGroup.overlay</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="#numDisplayObjects" class="signatureLink">numDisplayObjects</a> : int<div class="summaryTableDescription">[read-only] | |
| Number of objects in the DisplayLayer.</div></td><td class="summaryTableOwnerCol">DisplayLayer</td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th> </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="#DisplayLayer()" class="signatureLink">DisplayLayer</a>()</div><div class="summaryTableDescription"> | |
| Constructor.</div></td><td class="summaryTableOwnerCol">DisplayLayer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#addDisplayObject()" class="signatureLink">addDisplayObject</a>(displayObject:DisplayObject, depth:Number):DisplayObject</div><div class="summaryTableDescription"> | |
| Adds a displayObject with the specified depth to the ordered list.</div></td><td class="summaryTableOwnerCol">DisplayLayer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getDisplayObjectAt()" class="signatureLink">getDisplayObjectAt</a>(index:int):DisplayObject</div><div class="summaryTableDescription"> | |
| Returns the DisplayObject with the specified index.</div></td><td class="summaryTableOwnerCol">DisplayLayer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getDisplayObjectDepth()" class="signatureLink">getDisplayObjectDepth</a>(displayObject:DisplayObject):Number</div><div class="summaryTableDescription"> | |
| Returns the depth for the specified DisplayObject.</div></td><td class="summaryTableOwnerCol">DisplayLayer</td></tr><tr class=""><td class="summaryTablePaddingCol"> </td><td class="summaryTableInheritanceCol"> </td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#removeDisplayObject()" class="signatureLink">removeDisplayObject</a>(displayObject:DisplayObject):DisplayObject</div><div class="summaryTableDescription"> | |
| Removes the specified displayObject from the sorted list.</div></td><td class="summaryTableOwnerCol">DisplayLayer</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="numDisplayObjects"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">numDisplayObjects</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>numDisplayObjects: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 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> | |
| Number of objects in the DisplayLayer. | |
| </p><br/><span class="label"> Implementation </span><br/><code> public function get numDisplayObjects():int</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="DisplayLayer()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">DisplayLayer</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function DisplayLayer()</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> | |
| Constructor. | |
| </p></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="addDisplayObject()"></a><a name="addDisplayObject(flash.display.DisplayObject,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">addDisplayObject</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function addDisplayObject(displayObject:DisplayObject, depth:Number):DisplayObject</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> | |
| Adds a <code>displayObject</code> with the specified depth to the ordered list. | |
| The position of the <code>displayObject</code> in the sorted lists is based on | |
| its depth. | |
| The object is inserted after all objects with less than or equal | |
| <code>depth</code> value. | |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">displayObject</span>:DisplayObject</code> — The object to add. | |
| </td></tr><tr><td class="paramSpacer"> </td></tr><tr><td width="20px"></td><td><code><span class="label">depth</span>:Number</code> (default = <code>NaN</code>)<code></code> — The depth of the 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>DisplayObject</code> — The index of the object. | |
| </td></tr></table></div><a name="getDisplayObjectAt()"></a><a name="getDisplayObjectAt(int)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getDisplayObjectAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getDisplayObjectAt(index:int):DisplayObject</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 DisplayObject with the specified index. | |
| </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 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>DisplayObject</code> — The object. | |
| </td></tr></table></div><a name="getDisplayObjectDepth()"></a><a name="getDisplayObjectDepth(flash.display.DisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getDisplayObjectDepth</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function getDisplayObjectDepth(displayObject:DisplayObject):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 depth for the specified DisplayObject. | |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">displayObject</span>:DisplayObject</code> — The 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>Number</code> — The depth of the object. | |
| </td></tr></table></div><a name="removeDisplayObject()"></a><a name="removeDisplayObject(flash.display.DisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">removeDisplayObject</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule"> </td></tr></table><div class="detailBody"><code> public function removeDisplayObject(displayObject:DisplayObject):DisplayObject</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> | |
| Removes the specified <code>displayObject</code> from the sorted list. | |
| </p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">displayObject</span>:DisplayObject</code> — The 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>DisplayObject</code> — The removed object. | |
| </td></tr></table></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 --> |