Google Git
Sign in
apache / flex-site / HEAD / . / content / asdoc / spark / globalization / StringTools.html
blob: c61e0e53d314bdbeb511fefd44850f5f6e5744c8 [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="StringTools,spark.globalization.StringTools,BUFFER_OVERFLOW_ERROR,ERROR_CODE_UNKNOWN,ILLEGAL_ARGUMENT_ERROR,INDEX_OUT_OF_BOUNDS_ERROR,INVALID_ATTR_VALUE,INVALID_CHAR_FOUND,LOCALE_UNDEFINED_ERROR,MEMORY_ALLOCATION_ERROR,NO_ERROR,NUMBER_OVERFLOW_ERROR,PARSE_ERROR,PATTERN_SYNTAX_ERROR,PLATFORM_API_FAILED,TRUNCATED_CHAR_FOUND,UNEXPECTED_TOKEN,UNSUPPORTED_ERROR,USING_DEFAULT_WARNING,USING_FALLBACK_WARNING,actualLocaleIDName,lastOperationStatus,getAvailableLocaleIDNames,toLowerCase,toUpperCase"><title>spark.globalization.StringTools</title><script src="../../AC_OETags.js" type="text/javascript"></script></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 = 'StringTools - 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?spark/globalization/StringTools.html&amp;spark/globalization/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">StringTools</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a>&nbsp;| <a href="#eventSummary">Events</a>&nbsp;| <a href="#styleSummary">Styles</a>&nbsp;| <a href="#includeExamplesSummary">Examples</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("StringTools"); titleBar_setSubNav(false,true,true,false,false,false,true,false,true,true,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.globalization</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class StringTools</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">StringTools <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../spark/globalization/supportClasses/GlobalizationBase.html">GlobalizationBase</a> <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a> <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 :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10.1, AIR 2.5</td></tr></table><p></p><p></p><p></p><p></p>
The <code>StringTools</code> class provides locale-sensitve case
conversion methods.
<p>This class is a wrapper class around the
<code>flash.globalization.StringTools</code>.
Therefore, the case conversion functionality is provided by the
<code>flash.globalization.StringTools</code> class.
However, this <code>StringTools</code> class can be used in MXML
declartions, uses the locale style for the requested Locale ID name, and
has methods and properties that are bindable.
Additionally, events are generated if there is an error or warning
generated by the flash.globalization class.</p>
<p>The <code>flash.globalization.StringTools</code> class uses the
underlying operating system for the case conversion functionality and
on some operating systems, the <code>flash.globalization</code> classes
are unsupported, this wrapper class provides fallback that makes use of
the case conversion provided by the <code>String</code> class.</p>
<p></p><p><a href="#includeExamplesSummary">View the examples</a></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso">flash.globalization.StringTools</div><br/><hr></div><a name="propertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Properties</div><div class="showHideLinks"><div id="hideInheritedProperty" class="hideInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(false,'Property');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Properties</a></div><div id="showInheritedProperty" class="showInheritedProperty"><a class="showHideLink" href="#propertySummary" onclick="javascript:setInheritedVisible(true,'Property');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableProperty"><tr><th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#actualLocaleIDName" class="signatureLink">actualLocaleIDName</a> : String<div class="summaryTableDescription">[override] [read-only]
The name of the actual locale ID used by this class object.</div></td><td class="summaryTableOwnerCol">StringTools</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/styles/AdvancedStyleClient.html#className" class="signatureLink">className</a> : String<div class="summaryTableDescription">[read-only]
The name of the component class.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/styles/AdvancedStyleClient.html#id" class="signatureLink">id</a> : String<div class="summaryTableDescription">
The identity of the component.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/styles/AdvancedStyleClient.html#inheritingStyles" class="signatureLink">inheritingStyles</a> : Object<div class="summaryTableDescription">
An object containing the inheritable styles for this non-visual
style client instance.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#lastOperationStatus" class="signatureLink">lastOperationStatus</a> : String<div class="summaryTableDescription">[override] [read-only]
The status of the most recent operation that this class object
performed.</div></td><td class="summaryTableOwnerCol">StringTools</td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/styles/AdvancedStyleClient.html#moduleFactory" class="signatureLink">moduleFactory</a> : <a href="../../mx/core/IFlexModuleFactory.html">IFlexModuleFactory</a><div class="summaryTableDescription">
A module factory is used as context for
finding the style manager that controls the styles for this
non-visual style client instance.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/styles/AdvancedStyleClient.html#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"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/styles/AdvancedStyleClient.html#styleDeclaration" class="signatureLink">styleDeclaration</a> : <a href="../../mx/styles/CSSStyleDeclaration.html">CSSStyleDeclaration</a><div class="summaryTableDescription">
The style declaration that holds the inline styles declared by this
object.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/styles/AdvancedStyleClient.html#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"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/styles/AdvancedStyleClient.html#styleName" class="signatureLink">styleName</a> : Object<div class="summaryTableDescription">
The source of this object's style values.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedProperty"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><a href="../../mx/styles/AdvancedStyleClient.html#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"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr></table></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><div class="showHideLinks"><div id="hideInheritedMethod" class="hideInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(false,'Method');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Public Methods</a></div><div id="showInheritedMethod" class="showInheritedMethod"><a class="showHideLink" href="#methodSummary" onclick="javascript:setInheritedVisible(true,'Method');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Public Methods</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#StringTools()" class="signatureLink">StringTools</a>()</div><div class="summaryTableDescription">
Constructs a new StringTools object that provides case conversion and
other utilities according to the conventions of a given locale.</div></td><td class="summaryTableOwnerCol">StringTools</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#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"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#getAvailableLocaleIDNames()" class="signatureLink">getAvailableLocaleIDNames</a>():Vector.&lt;String&gt;</div><div class="summaryTableDescription">[static]
Lists all of the locale ID names supported by this class.</div></td><td class="summaryTableOwnerCol">StringTools</td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#getClassStyleDeclarations()" class="signatureLink">getClassStyleDeclarations</a>():Array</div><div class="summaryTableDescription">
Returns an Array of CSSStyleDeclaration objects for the type selector
that applies to this component, or null if none exist.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/globalization/supportClasses/GlobalizationBase.html#getStyle()" class="signatureLink">getStyle</a>(styleProp:String):*</div><div class="summaryTableDescription">[override]
Gets a style property that has been set anywhere in this
component's style lookup chain.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/globalization/supportClasses/GlobalizationBase.html">GlobalizationBase</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#hasCSSState()" class="signatureLink">hasCSSState</a>():Boolean</div><div class="summaryTableDescription">
Returns true if currentCSSState is not null.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#initialized()" class="signatureLink">initialized</a>(document:Object, id:String):void</div><div class="summaryTableDescription">
The initialized method is called when this class or a class that
extends this class is used in an MXML declaration.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#matchesCSSState()" class="signatureLink">matchesCSSState</a>(cssState:String):Boolean</div><div class="summaryTableDescription">
Returns true if cssState matches currentCSSState.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#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"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#notifyStyleChangeInChildren()" class="signatureLink">notifyStyleChangeInChildren</a>(styleProp:String, recursive:Boolean):void</div><div class="summaryTableDescription">
Propagates style changes to the children of this style client
instance.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#regenerateStyleCache()" class="signatureLink">regenerateStyleCache</a>(recursive:Boolean):void</div><div class="summaryTableDescription">
Sets up the internal style cache values so that the
getStyle()
method functions.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#registerEffects()" class="signatureLink">registerEffects</a>(effects:Array):void</div><div class="summaryTableDescription">
Registers the EffectManager as one of the event listeners
for each effect event.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#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"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#styleChanged()" class="signatureLink">styleChanged</a>(styleProp:String):void</div><div class="summaryTableDescription">
Detects changes to style properties.</div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class="hideInheritedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#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"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#toLowerCase()" class="signatureLink">toLowerCase</a>(s:String):String</div><div class="summaryTableDescription">
Converts a string to lowercase according to language conventions.</div></td><td class="summaryTableOwnerCol">StringTools</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#toUpperCase()" class="signatureLink">toUpperCase</a>(s:String):String</div><div class="summaryTableDescription">
Converts a string to uppercase according to language conventions.</div></td><td class="summaryTableOwnerCol">StringTools</td></tr></table></div><a name="protectedMethodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Methods </div><div class="showHideLinks"><div id="hideInheritedProtectedMethod" class="hideInheritedProtectedMethod"><a class="showHideLink" href="#protectedMethodSummary" onclick="javascript:setInheritedVisible(false,'ProtectedMethod');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Show Inherited Protected Methods</a></div><div id="showInheritedProtectedMethod" class="showInheritedProtectedMethod"><a class="showHideLink" href="#protectedMethodSummary" onclick="javascript:setInheritedVisible(true,'ProtectedMethod');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Protected Methods</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedProtectedMethod" id="summaryTableProtectedMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProtectedMethod"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../mx/styles/AdvancedStyleClient.html#setDeferredStyles()" class="signatureLink">setDeferredStyles</a>():void</div><div class="summaryTableDescription"></div></td><td class="summaryTableOwnerCol"><a href="../../mx/styles/AdvancedStyleClient.html">AdvancedStyleClient</a></td></tr></table></div><a name="eventSummary"></a><div class="summarySection"><div class="summaryTableTitle">Events</div><div class="showHideLinks"><div id="hideInheritedEvent" class="hideInheritedEvent"><a class="showHideLink" href="#eventSummary" onclick="javascript:setInheritedVisible(false,'Event');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Events</a></div><div id="showInheritedEvent" class="showInheritedEvent"><a class="showHideLink" href="#eventSummary" onclick="javascript:setInheritedVisible(true,'Event');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Events</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedEvent" id="summaryTableEvent"><tr><th>&nbsp;</th><th colspan="2">Event</th><th> Summary </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedEvent"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/globalization/supportClasses/GlobalizationBase.html#event:change" class="signatureLink">change</a></div></td><td class="summaryTableDescription summaryTableCol">The change event is generated whenever the locale style is changed or another property is set that would cause the format of a number to change or cause updates to the other values available through this class.</td><td class="summaryTableOwnerCol"><a href="../../spark/globalization/supportClasses/GlobalizationBase.html">GlobalizationBase</a></td></tr></table></div><a name="styleSummary"></a><div class="summarySection"><div class="summaryTableTitle">Styles</div><div class="showHideLinks"><div id="hideInheritedStyle" class="hideInheritedStyle"><a class="showHideLink" href="#styleSummary" onclick="javascript:setInheritedVisible(false,'Style');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Styles</a></div><div id="showInheritedStyle" class="showInheritedStyle"><a class="showHideLink" href="#styleSummary" onclick="javascript:setInheritedVisible(true,'Style');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Styles</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedStyle" id="summaryTableStyle"><tr><th>&nbsp;</th><th colspan="2">Style</th><th> Description </th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedStyle"><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img src="../../images/inheritedSummary.gif" alt="Inherited" title="Inherited" class="inheritedSummaryImage"></td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="../../spark/globalization/supportClasses/GlobalizationBase.html#style:locale" class="signatureLink">locale</a></div></td><td class="summaryTableDescription"><span class="label">Type: </span>String&nbsp;<span class="label">CSS Inheritance: </span>yes<br/>The locale identifier that specifies the language, region, script and optionally other related tags and keys.<p><span class="label">See also</span></p><div class="seeAlso"><a href="http://www.unicode.org/reports/tr35/" target="mm_external">http://www.unicode.org/reports/tr35/</a></div></td><td class="summaryTableOwnerCol"><a href="../../spark/globalization/supportClasses/GlobalizationBase.html">GlobalizationBase</a></td></tr></table></div><script language="javascript" type="text/javascript"><!--
showHideInherited();
--></script><div class="MainContent"><div class="detailSectionHeader">Property Detail</div><a name="propertyDetail"></a><a name="actualLocaleIDName"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">actualLocaleIDName</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>actualLocaleIDName:String</code>&nbsp;&nbsp;[read-only] [override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10.1, AIR 2.5</td></tr></table><p></p><p></p><p>
The name of the actual locale ID used by this class object.
This is the locale that is used to access the formatting data and
functionality from the operating system.
<p>If the locale that was set by the <code>locale</code> style is not available,
then the value of the <code>actualLocaleIDName</code> is different
from the value of the <code>locale</code> style.
It indicates the fallback locale that is being used.
If the locale style was set to <code>LocaleID.DEFAULT</code> the
name of the locale specified by the user's operating system is
used.</p>
</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get actualLocaleIDName():String</code><br/><p><span class="label">See also</span></p><div class="seeAlso">flash.globalization.StringTools.actualLocaleIDName<br/><a href="StringTools.html#StringTools()" target="">StringTools()</a></div></div><a name="propertyDetail"></a><a name="lastOperationStatus"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">lastOperationStatus</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>lastOperationStatus:String</code>&nbsp;&nbsp;[read-only] [override] <p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10.1, AIR 2.5</td></tr></table><p></p><p></p><p>
The status of the most recent operation that this class object
performed.
The <code>lastOperationStatus</code> is set whenever the constructor
or a method of this class is called, or when a property is set.
For the possible values see the description under each method.
</p><p>This property can be used as the source for data binding.</p><br/><span class="label"> Implementation </span><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function get lastOperationStatus():String</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="StringTools()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">StringTools</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function StringTools()</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10.1, AIR 2.5</td></tr></table><p></p><p>
Constructs a new StringTools object that provides case conversion and
other utilities according to the conventions of a given locale.
The locale for this class is supplied by the locale style.
The locale style can be set in several ways:
<ul>
<li>Inheriting the style from a <code>UIComponent</code> by calling the
UIComponent's addStyleClient method.</li>
<li>By using the class in an MXML declaration and inheriting the
locale from the document that contains the declaration.
Example:
<pre>
&lt;fx:Declarations>
&lt;s:StringTools id="st" />
&lt;/fx:Declarations>
</pre>
</li>
<li>By using an MXML declaration and specifying the locale value in
the list of assignments.
Example:
<pre>
&lt;fx:Declarations>
&lt;s:StringTools id="st_turkish" locale="tr-TR" />
&lt;/fx:Declarations>
</pre>
</li>
<li>Calling the setStyle method, e.g.
<code>st.setStyle("locale", "tr-TR")</code></li>
</ul>
<p>
If the <code>locale</code> style is not set by one of the above
techniques, the instance of this class will be added as a
<code>StyleClient</code> to the <code>topLevelApplication</code> and
will therefore inherit the <code>locale</code> style from the
<code>topLevelApplication</code> object when the <code>locale</code>
dependent property getter or <code>locale</code> dependent method is
called.
</p>
</p><p><span class="label">See also</span></p><div class="seeAlso">flash.globalization.StringTools</div></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="getAvailableLocaleIDNames()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">getAvailableLocaleIDNames</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public static function getAvailableLocaleIDNames():Vector.&lt;String&gt;</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10.1, AIR 2.5</td></tr></table><p></p><p></p><p>
Lists all of the locale ID names supported by this class.
</p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>Vector.&lt;String&gt;</code> &mdash; A vector of strings containing all of the locale ID names
supported by this class and operating system.
</td></tr></table></div><a name="toLowerCase()"></a><a name="toLowerCase(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toLowerCase</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function toLowerCase(s:String):String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10.1, AIR 2.5</td></tr></table><p></p><p></p><p>
Converts a string to lowercase according to language conventions.
Depending on the locale, the output string length can differ from the
input string length.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">s</span>:String</code> &mdash; <code>String</code> to convert to lowercase.
</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 converted lowercase string.
</td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.globalization.StringTools</div></div><a name="toUpperCase()"></a><a name="toUpperCase(String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">toUpperCase</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public function toUpperCase(s:String):String</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 4.5</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 10.1, AIR 2.5</td></tr></table><p></p><p></p><p>
Converts a string to uppercase according to language conventions.
Depending on the locale, the output string length can differ from the
input string length.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">s</span>:String</code> &mdash; <code>String</code> to convert to uppercase.
</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 converted uppercase string.
</td></tr></table><p><span class="label">See also</span></p><div class="seeAlso">flash.globalization.StringTools</div></div><a name="includeExamplesSummary"></a><div class="detailSectionHeader">Examples</div><div class="exampleHeader">StringToolsExample.mxml</div><div class="detailBody"><div class="listing"><pre>&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
--&gt;
&lt;!-- Sample program for spark.globalization.StringTools --&gt;
&lt;s:Application
xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx"&gt;
&lt;fx:Declarations&gt;
&lt;s:StringTools id="stringTools" /&gt;
&lt;/fx:Declarations&gt;
&lt;fx:Script&gt;
&lt;![CDATA[
import mx.collections.ArrayCollection;
private static const localeList:ArrayCollection
= new ArrayCollection([
{ label:"Turkish (tr)", data:"tr" },
{ label:"Greek (el)", data:"el" },
{ label:"German (de)", data:"de" },
{ label:"English (en)", data:"en" } ]);
private static const inputString:String =
"aáḁæａ Iıİi (Turkish), σςΣΣ (Greek), SSß (German), bβв (Latin/Greek/Cyrillic)";
]]&gt;
&lt;/fx:Script&gt;
&lt;mx:Form width="100%"&gt;
&lt;mx:FormItem label="Select Language"&gt;
&lt;mx:ComboBox id="localeSelector"
change="setStyle('locale', localeSelector.selectedItem.data);"
dataProvider="{localeList}"/&gt;
&lt;/mx:FormItem&gt;
&lt;mx:FormItem label="Actual Locale ID Name"&gt;
&lt;mx:Text text="{stringTools.actualLocaleIDName}"/&gt;
&lt;/mx:FormItem&gt;
&lt;mx:FormItem width="100%" label="Upper Case Result"&gt;
&lt;mx:Text width="100%"
text="{stringTools.toUpperCase(inputString)}"/&gt;
&lt;/mx:FormItem&gt;
&lt;mx:FormItem width="100%" label="Lower Case Result"&gt;
&lt;mx:Text width="100%"
text="{stringTools.toLowerCase(inputString)}"/&gt;
&lt;/mx:FormItem&gt;
&lt;/mx:Form&gt;
&lt;/s:Application&gt;
</pre></div><script language="javascript" type="text/javascript"><!-- AC_FL_RunContent( "src", "examples/StringToolsExample", "width", "100%",
"height","400px", "salign", "TL", "id", "example1", "quality", "high", "bgcolor", "", "name",
"example1", "flashvars","", "allowScriptAccess","sameDomain", "type",
"application/x-shockwave-flash","pluginspage", "http://www.macromedia.com/go/getflashplayer" ); --></script></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 -->