blob: 2c9d4e75a5746e4d299e12db4a473c4cb3c4e5a0 [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="CurrencyValidator,spark.validators.CurrencyValidator,currencyISOCode,currencyStringError,currencySymbol,negativeCurrencyFormat,negativeCurrencyFormatError,negativeNumberFormat,negativeNumberFormatError,positiveCurrencyFormat,positiveCurrencyFormatError,validateCurrency,validateNumber"><title>spark.validators.CurrencyValidator</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 = 'CurrencyValidator - 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/validators/CurrencyValidator.html&amp;spark/validators/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">CurrencyValidator</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("CurrencyValidator"); 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.validators</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class CurrencyValidator</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">CurrencyValidator <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</a> <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> <a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a> <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>CurrencyValidator</code> class ensures that a String represents
a valid currency amount according to the conventions of a locale.
This class uses the <code>locale</code> style for specifying the Locale ID.
<p>The validator can ensure that a currency string falls within a given
range (specified by <code>minValue</code> and <code>maxValue</code>
properties), is an integer (specified by <code>domain</code> property),
is non-negative (specified by <code>allowNegative</code> property),
correctly specifies negative and positive numbers,
has the correct currency ISO code or currency symbol,
and does not exceed the specified number of <code>fractionalDigits</code>.
The validator sets default property values by making use of the
<code>flash.globalization.CurrencyFormatter</code> class and therefore the
locale specific values are supplied by the operating system.</p>
<p>The <code>flash.globalization.CurrencyFormatter</code> class uses the
underlying operating system to supply the locale specific data. In case
the operating system does not provide currency formatting, this class
provides fallback functionality.</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>The <code>&lt;s:CurrencyValidator&gt;</code> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:</p>
<pre>
&lt;s:CurrencyValidator
<strong>Properties</strong>
currencyISOCode="<i>locale specified string or customized by user</i>."
currencyStringError="Currency name is repeated or not correct."
currencySymbol="<i>locale specified string or customized by user</i>."
negativeCurrencyFormat="<i>locale specified string or customized by user</i>."
negativeCurrencyFormatError="The negative format of the input currency is incorrect."
positiveCurrencyFormat="<i>locale specified string or customized by user</i>."
positiveCurrencyFormatError="The positive format of the input currency is incorrect."
/&gt;
</pre>
</div><script language="javascript" type="text/javascript"><!--
setMXMLOnly();
--></script><p><a href="#includeExamplesSummary">View the examples</a></p><p><span class="classHeaderTableLabel">See also</span></p><div class="seeAlso">flash.globalization.CurrencyFormatter</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="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="../../spark/globalization/supportClasses/GlobalizationBase.html#actualLocaleIDName" class="signatureLink">actualLocaleIDName</a> : String<div class="summaryTableDescription">[read-only]
The name of the actual locale ID used by this class object.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/globalization/supportClasses/GlobalizationBase.html">GlobalizationBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#allowNegative" class="signatureLink">allowNegative</a> : Boolean<div class="summaryTableDescription">
Specifies whether negative numbers are permitted.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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#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=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#currencyISOCode" class="signatureLink">currencyISOCode</a> : String<div class="summaryTableDescription">
The three letter ISO 4217 currency code for the locale
being used.</div></td><td class="summaryTableOwnerCol">CurrencyValidator</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#currencyStringError" class="signatureLink">currencyStringError</a> : String<div class="summaryTableDescription">
Error message when the currency symbol or currency ISO code is repeated
or is in the incorrect location.</div></td><td class="summaryTableOwnerCol">CurrencyValidator</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#currencySymbol" class="signatureLink">currencySymbol</a> : String<div class="summaryTableDescription">
The currency symbol or string for the locale being used.</div></td><td class="summaryTableOwnerCol">CurrencyValidator</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="../../spark/validators/supportClasses/NumberValidatorBase.html#decimalPointCountError" class="signatureLink">decimalPointCountError</a> : String<div class="summaryTableDescription">
Error message when the decimal separator character occurs more than
once.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#decimalSeparator" class="signatureLink">decimalSeparator</a> : String<div class="summaryTableDescription">
The decimal separator character used for validating numbers that have
a decimal part.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#digitsType" class="signatureLink">digitsType</a> : uint<div class="summaryTableDescription">
Defines the set of digit characters to be used when
validating numbers.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#domain" class="signatureLink">domain</a> : String<div class="summaryTableDescription">
Type of number to be validated.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#enabled" class="signatureLink">enabled</a> : Boolean<div class="summaryTableDescription">
Setting this value to false will stop the validator
from performing validation.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#fractionalDigits" class="signatureLink">fractionalDigits</a> : int<div class="summaryTableDescription">
The maximum number of digits that can appear after the decimal
separator.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#fractionalDigitsError" class="signatureLink">fractionalDigitsError</a> : String<div class="summaryTableDescription">
Error message when fraction digits exceeds the value specified
by the fractionalDigits property.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#greaterThanMaxError" class="signatureLink">greaterThanMaxError</a> : String<div class="summaryTableDescription">
Error message when the value exceeds the maxValue property.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#groupingSeparator" class="signatureLink">groupingSeparator</a> : String<div class="summaryTableDescription">
The character or string used for the grouping separator.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="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="../../spark/validators/supportClasses/NumberValidatorBase.html#invalidCharError" class="signatureLink">invalidCharError</a> : String<div class="summaryTableDescription">
Error message when the value contains invalid characters.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#invalidFormatCharsError" class="signatureLink">invalidFormatCharsError</a> : String<div class="summaryTableDescription">
Error message when the value contains invalid format characters, which
means that it contains a digit or minus sign (-) as a separator
character, or it contains two or more consecutive separator characters.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#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"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#lessThanMinError" class="signatureLink">lessThanMinError</a> : String<div class="summaryTableDescription">
Error message when the value is less than the minValue.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#listener" class="signatureLink">listener</a> : Object<div class="summaryTableDescription">
Specifies the validation listener.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#localeUndefinedError" class="signatureLink">localeUndefinedError</a> : String<div class="summaryTableDescription">
Error message when the locale is undefined or is not available.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#maxValue" class="signatureLink">maxValue</a> : Number<div class="summaryTableDescription">
Maximum value for a valid number.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#minValue" class="signatureLink">minValue</a> : Number<div class="summaryTableDescription">
Minimum value for a valid number.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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#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=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#negativeCurrencyFormat" class="signatureLink">negativeCurrencyFormat</a> : uint<div class="summaryTableDescription">
A numeric value that indicates a validating pattern for negative
currency amounts.</div></td><td class="summaryTableOwnerCol">CurrencyValidator</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#negativeCurrencyFormatError" class="signatureLink">negativeCurrencyFormatError</a> : String<div class="summaryTableDescription">
Error message when the negative number format of the input currency
string is incorrect.</div></td><td class="summaryTableOwnerCol">CurrencyValidator</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="../../spark/validators/supportClasses/NumberValidatorBase.html#negativeError" class="signatureLink">negativeError</a> : String<div class="summaryTableDescription">
Error message when the value is negative and the
allowNegative property is false.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#negativeSymbol" class="signatureLink">negativeSymbol</a> : String<div class="summaryTableDescription">[read-only]
The negative symbol to be used when validating negative values.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#negativeSymbolError" class="signatureLink">negativeSymbolError</a> : String<div class="summaryTableDescription">
Error message when the negative symbol is repeated or is in wrong place.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#notAnIntegerError" class="signatureLink">notAnIntegerError</a> : String<div class="summaryTableDescription">
Error message when the number must be an integer, as defined
by the domain property.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</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="../../spark/validators/supportClasses/NumberValidatorBase.html#parseError" class="signatureLink">parseError</a> : String<div class="summaryTableDescription">
Error message when number could not be parsed.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/NumberValidatorBase.html">NumberValidatorBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#positiveCurrencyFormat" class="signatureLink">positiveCurrencyFormat</a> : uint<div class="summaryTableDescription">
A numeric value that indicates a validating pattern for positive
currency amounts.</div></td><td class="summaryTableOwnerCol">CurrencyValidator</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a href="#positiveCurrencyFormatError" class="signatureLink">positiveCurrencyFormatError</a> : String<div class="summaryTableDescription">
Error message when the positive currency number format is incorrect.</div></td><td class="summaryTableOwnerCol">CurrencyValidator</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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#property" class="signatureLink">property</a> : String<div class="summaryTableDescription">
A String specifying the name of the property
of the source object that contains
the value to validate.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#required" class="signatureLink">required</a> : Boolean = true<div class="summaryTableDescription">
If true, specifies that a missing or empty
value causes a validation error.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#requiredFieldError" class="signatureLink">requiredFieldError</a> : String<div class="summaryTableDescription">
Error message when a value is missing and the
required property is true.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#source" class="signatureLink">source</a> : Object<div class="summaryTableDescription">
Specifies the object containing the property to validate.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</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><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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#trigger" class="signatureLink">trigger</a> : IEventDispatcher<div class="summaryTableDescription">
Specifies the component generating the event that triggers the
validator.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#triggerEvent" class="signatureLink">triggerEvent</a> : String<div class="summaryTableDescription">
Specifies the event that triggers the validation.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></tr></table></div><a name="protectedPropertySummary"></a><div class="summarySection"><div class="summaryTableTitle">Protected Properties</div><div class="showHideLinks"><div id="hideInheritedProtectedProperty" class="hideInheritedProtectedProperty"><a class="showHideLink" href="#protectedPropertySummary" onclick="javascript:setInheritedVisible(false,'ProtectedProperty');"><img class="showHideLinkImage" src="../../images/expanded.gif"> Hide Inherited Protected Properties</a></div><div id="showInheritedProtectedProperty" class="showInheritedProtectedProperty"><a class="showHideLink" href="#protectedPropertySummary" onclick="javascript:setInheritedVisible(true,'ProtectedProperty');"><img class="showHideLinkImage" src="../../images/collapsed.gif"> Show Inherited Protected Properties</a></div></div><table cellspacing="0" cellpadding="3" class="summaryTable hideInheritedProtectedProperty" id="summaryTableProtectedProperty"><tr><th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class="hideInheritedProtectedProperty"><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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#actualListeners" class="signatureLink">actualListeners</a> : Array<div class="summaryTableDescription">[read-only]
Contains an Array of listener objects, if any,
or the source object.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></tr><tr class="hideInheritedProtectedProperty"><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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#actualTrigger" class="signatureLink">actualTrigger</a> : IEventDispatcher<div class="summaryTableDescription">[read-only]
Contains the trigger object, if any,
or the source object.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></tr><tr class="hideInheritedProtectedProperty"><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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#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"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></tr><tr class="hideInheritedProtectedProperty"><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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#subFields" class="signatureLink">subFields</a> : Array<div class="summaryTableDescription">
An Array of Strings containing the names for the properties contained
in the value Object passed to the validate()
method.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</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="#CurrencyValidator()" class="signatureLink">CurrencyValidator</a>()</div><div class="summaryTableDescription">
Constructs a new CurrencyValidator object to validate
numbers representing currency amounts according to
the conventions of a given locale.</div></td><td class="summaryTableOwnerCol">CurrencyValidator</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="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="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/validators/supportClasses/GlobalizationValidatorBase.html#validate()" class="signatureLink">validate</a>(value:Object = null, suppressEvents:Boolean = false):<a href="../../mx/events/ValidationResultEvent.html">ValidationResultEvent</a></div><div class="summaryTableDescription">
Performs validation and optionally notifies
the listeners of the result.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</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/validators/supportClasses/GlobalizationValidatorBase.html#validateAll()" class="signatureLink">validateAll</a>(validators:Array):Array</div><div class="summaryTableDescription">[static]
Invokes all the validators in the validators Array.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#validateCurrency()" class="signatureLink">validateCurrency</a>(value:Object, baseField:String):Array</div><div class="summaryTableDescription">
Convenience method for calling a validator
from within a custom validation function.</div></td><td class="summaryTableOwnerCol">CurrencyValidator</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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#addListenerHandler()" class="signatureLink">addListenerHandler</a>():void</div><div class="summaryTableDescription">
Sets up all of the listeners for the
valid and invalid
events dispatched from the validator.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#doValidation()" class="signatureLink">doValidation</a>(value:Object):Array</div><div class="summaryTableDescription">
Executes the validation logic of this validator,
including validating that a missing or empty value
causes a validation error as defined by
the value of the required property.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#getValueFromSource()" class="signatureLink">getValueFromSource</a>():Object</div><div class="summaryTableDescription">
Returns the Object to validate.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#handleResults()" class="signatureLink">handleResults</a>(errorResults:Array):<a href="../../mx/events/ValidationResultEvent.html">ValidationResultEvent</a></div><div class="summaryTableDescription">
Returns a ValidationResultEvent from the Array of error results.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#isRealValue()" class="signatureLink">isRealValue</a>(value:Object):Boolean</div><div class="summaryTableDescription">
Returns true if value is not null.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#removeListenerHandler()" class="signatureLink">removeListenerHandler</a>():void</div><div class="summaryTableDescription">
Disconnects all of the listeners for the
valid and invalid
events dispatched from the validator.</div></td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></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="../../spark/validators/supportClasses/GlobalizationValidatorBase.html#resourcesChanged()" class="signatureLink">resourcesChanged</a>():void</div><div class="summaryTableDescription">
This method is called when a GlobalizationValidatorBase 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"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></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><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/validators/supportClasses/GlobalizationValidatorBase.html#event:invalid" class="signatureLink">invalid</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when validation fails.</td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</a></td></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/validators/supportClasses/GlobalizationValidatorBase.html#event:valid" class="signatureLink">valid</a></div></td><td class="summaryTableDescription summaryTableCol">Dispatched when validation succeeds.</td><td class="summaryTableOwnerCol"><a href="../../spark/validators/supportClasses/GlobalizationValidatorBase.html">GlobalizationValidatorBase</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="currencyISOCode"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">currencyISOCode</td><td class="detailHeaderType">property</td></tr></table><div class="detailBody"><code>currencyISOCode: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>
The three letter ISO 4217 currency code for the locale
being used.
<p>This property is used to validate the currency string or symbol
present in the input currency amounts using the <code>validate()</code>
method.
</p>
<p>This property is initialized by the constructor
based on the actual locale that is used. When a fallback
locale is used this property reflects the preferred, default
currency code for the fallback locale.</p>
<p>The default value is dependent on the actual locale and
<code>operating system</code>.</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 currencyISOCode():String</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set currencyISOCode(value:String):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="CurrencyValidator.html#validate()" target="">validate()</a><br/><a href="CurrencyValidator.html#currencySymbol" target="">currencySymbol</a></div></div><a name="propertyDetail"></a><a name="currencyStringError"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">currencyStringError</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>currencyStringError: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>
Error message when the currency symbol or currency ISO code is repeated
or is in the incorrect location.
</p><p> The default value is <code>"Currency name is repeated or not correct."</code>.</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 currencyStringError():String</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set currencyStringError(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="currencySymbol"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">currencySymbol</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>currencySymbol: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>
The currency symbol or string for the locale being used.
<p>This property is used as the currency symbol when validating
currency amounts using the <code>validate()</code> method.The
currency symbol or currency name in the validation string,
must match either the value of the <code>currencySymbol</code> property
or the value of the <code>currencyISOCode</code> property. </p>
<p>This property is initialized by the constructor based on
the actual locale that is used. When a fallback
locale is used this property reflects the preferred, default
currency symbol for the fallback locale.</p>
<p>The default value is dependent on the actual locale and
<code>operating system</code>.</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 currencySymbol():String</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set currencySymbol(value:String):void</code><br/><p><span class="label">See also</span></p><div class="seeAlso"><a href="CurrencyValidator.html#format()" target="">format()</a><br/><a href="CurrencyValidator.html#setCurrency()" target="">setCurrency()</a><br/><a href="CurrencyValidator.html#formattingWithCurrencySymbolIsSafe()" target="">formattingWithCurrencySymbolIsSafe()</a><br/><a href="CurrencyValidator.html#currencyISOCode" target="">currencyISOCode</a></div></div><a name="propertyDetail"></a><a name="negativeCurrencyFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">negativeCurrencyFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>negativeCurrencyFormat:uint</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>
A numeric value that indicates a validating pattern for negative
currency amounts. This property defines the location of the
currency symbol and the negative symbol or parentheses in
relation to the numeric portion of the currency
amount. This property is used to validate whether or not the input
currency string follows this pattern for negative amounts.
<p>The value of this property must be one of the constants
defined in the table below.
</p>
<ul>
<li>The '¤' symbol represents the location of the currencyISOCode
or the currencySymbol in the currency string.
</li>
<li>The '-' character represents the location of the
negativeNumberSymbol.</li>
<li>The 'n' character represents the currency amount.</li>
</ul>
<table class="innertable" ><tr><td>Negative currency format type</td><td>Formatting pattern</td></tr><tr><td>0</td><td>(¤n)</td></tr><tr><td>1</td><td>-¤n</td></tr><tr><td>2</td><td>¤-n</td></tr><tr><td>3</td><td>¤n-</td></tr><tr><td>4</td><td>(n¤)</td></tr><tr><td>5</td><td>-n¤</td></tr><tr><td>6</td><td>n-¤</td></tr><tr><td>7</td><td>n¤-</td></tr><tr><td>8</td><td>-n ¤</td></tr><tr><td>9</td><td>-¤ n</td></tr><tr><td>10</td><td>n ¤-</td></tr><tr><td>11</td><td>¤ n-</td></tr><tr><td>12</td><td>¤ -n</td></tr><tr><td>13</td><td>n- ¤</td></tr><tr><td>14</td><td>(¤ n)</td></tr><tr><td>15</td><td>(n ¤)</td></tr></table>
<p>The default value is dependent on the actual locale and
operating system.</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 negativeCurrencyFormat():uint</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set negativeCurrencyFormat(value:uint):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>ArgumentError </code> &mdash; if the assigned value is not between 0 and 15.
</td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="CurrencyValidator.html#format()" target="">format()</a><br/><a href="CurrencyValidator.html#currencySymbol" target="">currencySymbol</a><br/><a href="CurrencyValidator.html#negativeSymbol" target="">negativeSymbol</a></div></div><a name="propertyDetail"></a><a name="negativeCurrencyFormatError"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">negativeCurrencyFormatError</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>negativeCurrencyFormatError: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>
Error message when the negative number format of the input currency
string is incorrect.
</p><p> The default value is <code>"The negative format of the input currency is incorrect."</code>.</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 negativeCurrencyFormatError():String</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set negativeCurrencyFormatError(value:String):void</code><br/></div><a name="propertyDetail"></a><a name="positiveCurrencyFormat"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">positiveCurrencyFormat</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>positiveCurrencyFormat:uint</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>
A numeric value that indicates a validating pattern for positive
currency amounts. This property defines the location of currency symbol
relative to the numeric portion of the currency amount. This property
is used to validate if the input currency string
follows this pattern for positive amounts.
<p>The value of this property must be one of the constants
defined in the table below.
</p>
<ul>
<li>The '¤' symbol represents the location of the
<code>currencyISOCode</code> or the <code>currencySymbol</code>
in the currency string.</li>
<li>The 'n' character represents the location of the
<code>currencyISOCode</code> or the <code>currencySymbol</code>
in the currency string.</li>
</ul>
<table class="innertable" ><tr><td>Positive currency format type</td><td>Formatting pattern</td></tr><tr><td>0</td><td>¤n</td></tr><tr><td>1</td><td>n¤</td></tr><tr><td>2</td><td>¤ n</td></tr><tr><td>3</td><td>n ¤</td></tr></table>
<p>The default value is dependent on the actual locale and
operating system.</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 positiveCurrencyFormat():uint</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set positiveCurrencyFormat(value:uint):void</code><br/><br/><span class="label"> Throws </span><br/><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>ArgumentError </code> &mdash; if the assigned value is not between 0 and 3.
</td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="CurrencyValidator.html#currencySymbol" target="">currencySymbol</a><br/><a href="CurrencyValidator.html#format()" target="">format()</a></div></div><a name="propertyDetail"></a><a name="positiveCurrencyFormatError"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">positiveCurrencyFormatError</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code>positiveCurrencyFormatError: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>
Error message when the positive currency number format is incorrect.
</p><p> The default value is <code>"The positive format of the input currency is incorrect."</code>.</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 positiveCurrencyFormatError():String</code><br/><code>&nbsp;&nbsp;&nbsp;&nbsp;public function set positiveCurrencyFormatError(value:String):void</code><br/></div><a name="constructorDetail"></a><div class="detailSectionHeader">Constructor Detail</div><a name="CurrencyValidator()"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">CurrencyValidator</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">Constructor</td></tr></table><div class="detailBody"><code>public function CurrencyValidator()</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 <code>CurrencyValidator</code> object to validate
numbers representing currency amounts according to
the conventions of a given locale.
<p>
The locale for this class is supplied by the <code>locale</code>
style property.
The <code>locale</code> style can be set in several ways:
</p>
<ul>
<li>
Inheriting the style from a <code>UIComponent</code> by calling the
<code>UIComponent</code>'s <code>addStyleClient</code> method.
</li>
<li>
By using the class in an MXML declaration and inheriting the
locale from the document that contains the declaration.
</li>
<pre>
&lt;fx:Declarations>
&lt;s:CurrencyValidator id="cv" />
&lt;/fx:Declarations>
</pre>
<li>
By using an MXML declaration and specifying the locale value
in the list of assignments.
</li>
<pre>
&lt;fx:Declarations>
&lt;s:CurrencyValidator id="cv_turkish" locale="tr-TR" />
&lt;/fx:Declarations>
</pre>
<li>
Calling the setStyle method,
For example: <code>cv.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>The properties related to the currency string format are set to
default values based on the locale.</p>
<p><b>NOTE:</b> When a fallback locale is used, the currency
properties are set to default values of en_US locale,
and therefore might not match the currency for which the validation is
intended.
It is a good idea to
examine the <code>currencySymbol</code> and <code>currencyISOCode</code>
property values before validating a currency amount.
</p>
</p><p><span class="label">See also</span></p><div class="seeAlso">flash.globalization.CurrencyFormatter.actualLocaleIDName</div></div><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="validateCurrency()"></a><a name="validateCurrency(Object,String)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">validateCurrency</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public function validateCurrency(value:Object, baseField:String):Array</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>
Convenience method for calling a validator
from within a custom validation function.
Each of the standard Flex validators has a similar convenience method.
Caller must check the <code>ValidationResult</code> objects in the
returned array for validation status.
</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>:Object</code> &mdash; A currency number string to validate.The number string can
use unicode minus symbols 0x2212, 0xFE63, 0xFF0D besides ascii minus.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">baseField</span>:String</code> &mdash; Text representation of the subfield
specified in the <code>value</code> parameter.
For example, if the <code>value</code> parameter specifies value.number,
the <code>baseField</code> value is "number".
</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> &mdash; An Array of <code>ValidationResult</code> objects, with
one <code>ValidationResult</code> object for each field examined by
the validator.
</td></tr></table><p><span class="label">See also</span></p><div class="seeAlso"><a href="../../mx/validators/ValidationResult.html" target="">mx.validators.ValidationResult</a><br/>flash.globalization.CurrencyFormatter</div></div><a name="includeExamplesSummary"></a><div class="detailSectionHeader">Examples</div><div class="exampleHeader">CurrencyValidatorExample1.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.formatters.NumberValidator --&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:CurrencyValidator id="currencyValidator" source='{inputNumber}'
property="text" trigger='{validateBtn}'
triggerEvent="click" /&gt;
&lt;s:CurrencyFormatter id="currencyFormatter" useCurrencySymbol="true"
useGrouping="true"/&gt;
&lt;/fx:Declarations&gt;
&lt;fx:Script&gt;
&lt;![CDATA[
[Bindable]
private var number:Number = 123456789.12;
]]&gt;
&lt;/fx:Script&gt;
&lt;mx:Form&gt;
&lt;mx:FormItem label="Input Locale ID Name"&gt;
&lt;mx:HBox&gt;
&lt;s:TextInput id="inputLocaleIDName" text="en-US"/&gt;
&lt;!-- Upon button click, sets the locale style on the document
UI component. The formatter will inherit this style. --&gt;
&lt;s:Button click="setStyle('locale', inputLocaleIDName.text);"
label="Apply"/&gt;
&lt;/mx:HBox&gt;
&lt;mx:Text text="Example: 'en-US', 'fr-FR', 'ja-JP', 'ar-SA'"/&gt;
&lt;/mx:FormItem&gt;
&lt;mx:FormItem label="Allow Negative"&gt;
&lt;mx:CheckBox id="alowNegative" selected="true"
change="currencyValidator.allowNegative = alowNegative.selected"/&gt;
&lt;/mx:FormItem&gt;
&lt;mx:FormItem label="Fractional Digits"&gt;
&lt;mx:TextInput id="fractionalDigits" text='{currencyValidator.fractionalDigits}'
change="currencyFormatter.fractionalDigits =
currencyValidator.fractionalDigits = Number(fractionalDigits.text)"/&gt;
&lt;/mx:FormItem&gt;
&lt;mx:FormItem label="Currency Symbol"&gt;
&lt;mx:TextInput id="currencySymbol" text='{currencyValidator.currencySymbol}'
change="currencyFormatter.currencySymbol =
currencyValidator.currencySymbol = currencySymbol.text"/&gt;
&lt;/mx:FormItem&gt;
&lt;mx:FormItem label="Actual Locale ID Name"&gt;
&lt;mx:Text text="{currencyValidator.actualLocaleIDName}"/&gt;
&lt;/mx:FormItem&gt;
&lt;mx:FormItem label="Enter currency amount" &gt;
&lt;mx:HBox&gt;
&lt;mx:TextInput id="inputNumber" /&gt;
&lt;mx:Button id="validateBtn" label="Validate" /&gt;
&lt;/mx:HBox&gt;
&lt;/mx:FormItem&gt;
&lt;mx:FormItem label="Example currency"&gt;
&lt;mx:Text text="{currencyFormatter.format(123456789.12)}"/&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/CurrencyValidatorExample1", "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 -->