Google Git
Sign in
apache / flex-site / HEAD / . / content / asdoc / mx / utils / NameUtil.html
blob: 06cf93117d18b34b70efe6767ce98e2acffa6905 [file] [log] [blame]
<!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="NameUtil,mx.utils.NameUtil,addEventListener,addEventListener,adjustBrightness,adjustBrightness2,arrayValuesMatch,arraysMatch,callProperty,callProperty,clone,compare,computeDigest,convertHSBtoRGB,convertRGBtoHSB,copy,createUID,createUID,createUniqueName,createXMLDocument,dateCompare,decode,deleteProperty,deleteProperty,dispatchEvent,dispatchEvent,displayObjectToString,drawRoundRectComplex,drawRoundRectComplex2,encode,encodeBytes,encodeUTFBytes,externalToString,find,fromByteArray,fromByteArray,getArrayValues,getAttributeByQName,getClassInfo,getClassInfo,getComplexProperty,getEnumerableProperties,getFirstItem,getFullURL,getInstance,getItemIndex,getPlatforms,getPort,getProperty,getProperty,getProtocol,getServerName,getServerNameWithPort,getUID,getUnqualifiedClassName,getValue,hasEventListener,hasEventListener,hasMetadata,hasMutualTrustBetweenParentAndChild,hasProperty,hasTokens,hasUnresolvableTokens,init,init,init,insertAfter,insertBefore,isDynamicObject,isHttpURL,isHttpsURL,isSimple,isUID,isUID,isWhitespace,isWhitespace,nextName,nextNameIndex,nextValue,normalizeURL,numericCompare,objectToString,pop,propertyChangeHandler,push,qnameToString,qnamesEqual,readExternal,registerClassAliases,remove,removeEventListener,removeEventListener,repeat,replacePort,replaceProtocol,replaceTokens,reset,reset,restrict,rgbMultiply,setProperty,setProperty,setToStringExcludes,setValue,setupPropertyList,shift,stringCompare,stringToObject,substitute,substitute,toArray,toArrayInt,toArrayObject,toByteArray,toByteArray,toByteArray,toString,toString,toString,trim,trim,trimArrayElements,trimArrayElements,unshift,unwatchXML,urisEqual,valuesAreSubsetOfObject,walkDisplayObjects,watchXML,willTrigger,willTrigger,writeExternal"><title>mx.utils.NameUtil</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 = 'NameUtil - ApacheFlex API Reference';
var baseRef = '../../';
window.onload = configPage;
--></script>
<script type="text/javascript">
scrollToNameAnchor();
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a>&nbsp;|&nbsp;<a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../index.html?mx/utils/NameUtil.html&amp;mx/utils/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">NameUtil</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("NameUtil"); titleBar_setSubNav(false,false,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
-->
</script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.utils</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class NameUtil</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">NameUtil <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p>
The NameUtil utility class defines static methods for
creating names for Flex objects.
You do not create instances of NameUtil;
instead you call static methods of the class, such as
the <code>NameUtil.createName()</code> method.
<p></p><br/><hr></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#createUniqueName()" class="signatureLink">createUniqueName</a>(object:Object):String</div><div class="summaryTableDescription">[static]
Creates a unique name for any Object instance, such as "Button12", by
combining the unqualified class name with an incrementing counter.</div></td><td class="summaryTableOwnerCol">NameUtil</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#displayObjectToString()" class="signatureLink">displayObjectToString</a>(displayObject:DisplayObject):String</div><div class="summaryTableDescription">[static]
Returns a string, such as
"MyApplication0.addressForm.lastName.TextField17",
for a DisplayObject object that indicates its position in the
hierarchy of DisplayObject objects in an application.</div></td><td class="summaryTableOwnerCol">NameUtil</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getUnqualifiedClassName()" class="signatureLink">getUnqualifiedClassName</a>(object:Object):String</div><div class="summaryTableDescription">[static]
Returns the name of the specified object's class,
such as "Button"
This string does not include the package name.</div></td><td class="summaryTableOwnerCol">NameUtil</td></tr></table></div><script language="javascript" type="text/javascript"><!--
showHideInherited();
--></script><div class="MainContent"><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="createUniqueName()"></a><a name="createUniqueName(Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">createUniqueName</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public static function createUniqueName(object:Object):String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Creates a unique name for any Object instance, such as "Button12", by
combining the unqualified class name with an incrementing counter.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">object</span>:Object</code> &mdash; Object requiring a name.
</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>String</code> &mdash; String containing the unique name.
</td></tr></table></div><a name="displayObjectToString()"></a><a name="displayObjectToString(flash.display.DisplayObject)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">displayObjectToString</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public static function displayObjectToString(displayObject:DisplayObject):String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Returns a string, such as
"MyApplication0.addressForm.lastName.TextField17",
for a DisplayObject object that indicates its position in the
hierarchy of DisplayObject objects in an 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">displayObject</span>:DisplayObject</code> &mdash; A DisplayObject object whose hierarchy in the application
is desired.
</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>String</code> &mdash; String containing the position of <code>displayObject</code>
in the hierarchy of DisplayObject objects in an application.
</td></tr></table></div><a name="getUnqualifiedClassName()"></a><a name="getUnqualifiedClassName(Object)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getUnqualifiedClassName</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public static function getUnqualifiedClassName(object:Object):String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Returns the name of the specified object'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 will return a string such as <code>"mx.controls::Button"</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">object</span>:Object</code> &mdash; 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>String</code> &mdash; The name of the specified object's class.
</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 -->