Packagespark.validators.supportClasses
Classpublic class NumberValidatorBase
InheritanceNumberValidatorBase Inheritance GlobalizationValidatorBase Inheritance GlobalizationBase Inheritance AdvancedStyleClient Inheritance flash.events.EventDispatcher
Subclasses CurrencyValidator, NumberValidator

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

The NumberValidatorBase class contains all the common functionality that is required by the NumberValidator and CurrencyValidator classes.

MXML SyntaxexpandedHide MXML Syntax

The <s:NumberValidator> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <s:NumberValidatorBase
    Properties
    allowNegative="true"
    decimalPointCountError="The decimal separator can only occur once."
    decimalSeparator="locale specified string or customized by user."
    digitsType="locale specified string or customized by user."
    domain="real"
    fractionalDigits="locale specified string or customized by user."
    fractionalDigitsError="The amount entered has too many digits beyond the decimal point."
    greaterThanMaxError="The number entered is too large."
    groupingSeparator="locale specified string or customized by user."
    invalidCharError="The input contains invalid characters."
    invalidFormatCharsError="One of the formatting parameters is invalid."
    lessThanMinError="The amount entered is too small."
    localeUndefinedError="Locale is undefined."
    maxValue="NaN"
    minValue="NaN"
    negativeError="The amount may not be negative."
    negativeSymbolError="The negative symbol is repeated or not in right place."
    notAnIntegerError="The number must be an integer."
    parseError="The input string could not be parsed."
  />

See also

spark.formatters.supportClasses.NumberFormatterBase

Public Properties
 PropertyDefined By
 InheritedactualLocaleIDName : String
[read-only] The name of the actual locale ID used by this class object.
GlobalizationBase
  allowNegative : Boolean
Specifies whether negative numbers are permitted.
NumberValidatorBase
 InheritedclassName : String
[read-only] The name of the component class.
AdvancedStyleClient
  decimalPointCountError : String
Error message when the decimal separator character occurs more than once.
NumberValidatorBase
  decimalSeparator : String
The decimal separator character used for validating numbers that have a decimal part.
NumberValidatorBase
  digitsType : uint
Defines the set of digit characters to be used when validating numbers.
NumberValidatorBase
  domain : String
Type of number to be validated.
NumberValidatorBase
 Inheritedenabled : Boolean
Setting this value to false will stop the validator from performing validation.
GlobalizationValidatorBase
  fractionalDigits : int
The maximum number of digits that can appear after the decimal separator.
NumberValidatorBase
  fractionalDigitsError : String
Error message when fraction digits exceeds the value specified by the fractionalDigits property.
NumberValidatorBase
  greaterThanMaxError : String
Error message when the value exceeds the maxValue property.
NumberValidatorBase
  groupingSeparator : String
The character or string used for the grouping separator.
NumberValidatorBase
 Inheritedid : String
The identity of the component.
AdvancedStyleClient
 InheritedinheritingStyles : Object
An object containing the inheritable styles for this non-visual style client instance.
AdvancedStyleClient
  invalidCharError : String
Error message when the value contains invalid characters.
NumberValidatorBase
  invalidFormatCharsError : String
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.
NumberValidatorBase
  lastOperationStatus : String
[override] [read-only] The status of the most recent operation that this class object performed.
NumberValidatorBase
  lessThanMinError : String
Error message when the value is less than the minValue.
NumberValidatorBase
 Inheritedlistener : Object
Specifies the validation listener.
GlobalizationValidatorBase
  localeUndefinedError : String
Error message when the locale is undefined or is not available.
NumberValidatorBase
  maxValue : Number
Maximum value for a valid number.
NumberValidatorBase
  minValue : Number
Minimum value for a valid number.
NumberValidatorBase
 InheritedmoduleFactory : IFlexModuleFactory
A module factory is used as context for finding the style manager that controls the styles for this non-visual style client instance.
AdvancedStyleClient
  negativeError : String
Error message when the value is negative and the allowNegative property is false.
NumberValidatorBase
  negativeSymbol : String
[read-only] The negative symbol to be used when validating negative values.
NumberValidatorBase
  negativeSymbolError : String
Error message when the negative symbol is repeated or is in wrong place.
NumberValidatorBase
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
AdvancedStyleClient
  notAnIntegerError : String
Error message when the number must be an integer, as defined by the domain property.
NumberValidatorBase
  parseError : String
Error message when number could not be parsed.
NumberValidatorBase
 Inheritedproperty : String
A String specifying the name of the property of the source object that contains the value to validate.
GlobalizationValidatorBase
 Inheritedrequired : Boolean = true
If true, specifies that a missing or empty value causes a validation error.
GlobalizationValidatorBase
 InheritedrequiredFieldError : String
Error message when a value is missing and the required property is true.
GlobalizationValidatorBase
 Inheritedsource : Object
Specifies the object containing the property to validate.
GlobalizationValidatorBase
 InheritedstyleDeclaration : CSSStyleDeclaration
The style declaration that holds the inline styles declared by this object.
AdvancedStyleClient
 InheritedstyleManager : IStyleManager2
[read-only] Returns the StyleManager instance used by this component.
AdvancedStyleClient
 InheritedstyleName : Object
The source of this object's style values.
AdvancedStyleClient
 InheritedstyleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors.
AdvancedStyleClient
 Inheritedtrigger : IEventDispatcher
Specifies the component generating the event that triggers the validator.
GlobalizationValidatorBase
 InheritedtriggerEvent : String
Specifies the event that triggers the validation.
GlobalizationValidatorBase
Protected Properties
 PropertyDefined By
 InheritedactualListeners : Array
[read-only] Contains an Array of listener objects, if any, or the source object.
GlobalizationValidatorBase
 InheritedactualTrigger : IEventDispatcher
[read-only] Contains the trigger object, if any, or the source object.
GlobalizationValidatorBase
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
GlobalizationValidatorBase
 InheritedsubFields : Array
An Array of Strings containing the names for the properties contained in the value Object passed to the validate() method.
GlobalizationValidatorBase
Public Methods
 MethodDefined By
  
NumberValidatorBase()
Constructor.
NumberValidatorBase
 Inherited
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
AdvancedStyleClient
 Inherited
getClassStyleDeclarations():Array
Returns an Array of CSSStyleDeclaration objects for the type selector that applies to this component, or null if none exist.
AdvancedStyleClient
 Inherited
getStyle(styleProp:String):*
[override] Gets a style property that has been set anywhere in this component's style lookup chain.
GlobalizationBase
 Inherited
hasCSSState():Boolean
Returns true if currentCSSState is not null.
AdvancedStyleClient
 Inherited
initialized(document:Object, id:String):void
The initialized method is called when this class or a class that extends this class is used in an MXML declaration.
AdvancedStyleClient
 Inherited
matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState.
AdvancedStyleClient
 Inherited
matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of, the given type.
AdvancedStyleClient
 Inherited
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children of this style client instance.
AdvancedStyleClient
 Inherited
regenerateStyleCache(recursive:Boolean):void
Sets up the internal style cache values so that the getStyle() method functions.
AdvancedStyleClient
 Inherited
registerEffects(effects:Array):void
Registers the EffectManager as one of the event listeners for each effect event.
AdvancedStyleClient
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
AdvancedStyleClient
 Inherited
styleChanged(styleProp:String):void
Detects changes to style properties.
AdvancedStyleClient
 Inherited
stylesInitialized():void
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
AdvancedStyleClient
 Inherited
validate(value:Object = null, suppressEvents:Boolean = false):ValidationResultEvent
Performs validation and optionally notifies the listeners of the result.
GlobalizationValidatorBase
 Inherited
validateAll(validators:Array):Array
[static] Invokes all the validators in the validators Array.
GlobalizationValidatorBase
Protected Methods
 MethodDefined By
 Inherited
addListenerHandler():void
Sets up all of the listeners for the valid and invalid events dispatched from the validator.
GlobalizationValidatorBase
 Inherited
doValidation(value:Object):Array
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.
GlobalizationValidatorBase
 Inherited
getValueFromSource():Object
Returns the Object to validate.
GlobalizationValidatorBase
 Inherited
handleResults(errorResults:Array):ValidationResultEvent
Returns a ValidationResultEvent from the Array of error results.
GlobalizationValidatorBase
 Inherited
isRealValue(value:Object):Boolean
Returns true if value is not null.
GlobalizationValidatorBase
 Inherited
removeListenerHandler():void
Disconnects all of the listeners for the valid and invalid events dispatched from the validator.
GlobalizationValidatorBase
 Inherited
resourcesChanged():void
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.
GlobalizationValidatorBase
 Inherited
setDeferredStyles():void
AdvancedStyleClient
Events
 Event Summary Defined By
 Inherited
change
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.GlobalizationBase
 Inherited
invalid
Dispatched when validation fails.GlobalizationValidatorBase
 Inherited
valid
Dispatched when validation succeeds.GlobalizationValidatorBase
Styles
 Style Description Defined By
 Inherited
locale
Type: String CSS Inheritance: yes
The locale identifier that specifies the language, region, script and optionally other related tags and keys.

See also

http://www.unicode.org/reports/tr35/
GlobalizationBase
Property Detail
allowNegativeproperty
allowNegative:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Specifies whether negative numbers are permitted. Valid values are true or false.

The default value is true.

This property can be used as the source for data binding.


Implementation
    public function get allowNegative():Boolean
    public function set allowNegative(value:Boolean):void
decimalPointCountErrorproperty 
decimalPointCountError:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Error message when the decimal separator character occurs more than once.

The default value is "The decimal separator can occur only once.".

This property can be used as the source for data binding.


Implementation
    public function get decimalPointCountError():String
    public function set decimalPointCountError(value:String):void
decimalSeparatorproperty 
decimalSeparator:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

The decimal separator character used for validating numbers that have a decimal part.

This property is initially set based on the locale style of the validator object.

The default value is dependent on the locale and operating system.

This property can be used as the source for data binding.


Implementation
    public function get decimalSeparator():String
    public function set decimalSeparator(value:String):void

Throws
TypeError — if this property is assigned a null value.

See also

validate()
digitsTypeproperty 
digitsType:uint

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Defines the set of digit characters to be used when validating numbers.

Different languages and regions use different sets of characters to represent the digits 0 through 9. This property defines the set of digits to be used.

The value of this property represents the Unicode value for the zero digit of a decimal digit set. The valid values for this property are defined in the NationalDigitsType class.

The default value is dependent on the locale and operating system.

This property can be used as the source for data binding.


Implementation
    public function get digitsType():uint
    public function set digitsType(value:uint):void

See also

flash.globalization.NationalDigitsType
domainproperty 
domain:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Type of number to be validated. Permitted values are "real" and "int".

In ActionScript, you can use the following constants to set this property: NumberValidatorDomainType.REAL or NumberValidatorDomainType.INT.

The default value is "real".

This property can be used as the source for data binding.


Implementation
    public function get domain():String
    public function set domain(value:String):void

See also

NumberValidatorDomainType
fractionalDigitsproperty 
fractionalDigits:int

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

The maximum number of digits that can appear after the decimal separator.

The default value is dependent on the locale and operating system.

This property can be used as the source for data binding.


Implementation
    public function get fractionalDigits():int
    public function set fractionalDigits(value:int):void
fractionalDigitsErrorproperty 
fractionalDigitsError:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Error message when fraction digits exceeds the value specified by the fractionalDigits property.

The default value is "The amount entered has too many digits beyond the decimal point.".

This property can be used as the source for data binding.


Implementation
    public function get fractionalDigitsError():String
    public function set fractionalDigitsError(value:String):void
greaterThanMaxErrorproperty 
greaterThanMaxError:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Error message when the value exceeds the maxValue property.

The default value is "The number entered is too large.".

This property can be used as the source for data binding.


Implementation
    public function get greaterThanMaxError():String
    public function set greaterThanMaxError(value:String):void
groupingSeparatorproperty 
groupingSeparator:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

The character or string used for the grouping separator.

The value of this property is used as the grouping separator when validating numbers. This property is initially set based on the locale that is selected when the validator object is constructed.

This property can be used as the source for data binding.


Implementation
    public function get groupingSeparator():String
    public function set groupingSeparator(value:String):void

Throws
TypeError — if this property is assigned a null value.

The default value is dependent on the locale and operating system.

See also

validate()
groupingPattern
invalidCharErrorproperty 
invalidCharError:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Error message when the value contains invalid characters.

The default value is "The input contains invalid characters.".

This property can be used as the source for data binding.


Implementation
    public function get invalidCharError():String
    public function set invalidCharError(value:String):void
invalidFormatCharsErrorproperty 
invalidFormatCharsError:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

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.

The default value is "One of the formatting parameters is invalid.".

This property can be used as the source for data binding.


Implementation
    public function get invalidFormatCharsError():String
    public function set invalidFormatCharsError(value:String):void
lastOperationStatusproperty 
lastOperationStatus:String  [read-only] [override]

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

The status of the most recent operation that this class object performed. The lastOperationStatus 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.

This property can be used as the source for data binding.


Implementation
    public function get lastOperationStatus():String

See also

spark.Globalization.LastOperationStatus
lessThanMinErrorproperty 
lessThanMinError:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Error message when the value is less than the minValue.

The default value is "The amount entered is too small.".

This property can be used as the source for data binding.


Implementation
    public function get lessThanMinError():String
    public function set lessThanMinError(value:String):void
localeUndefinedErrorproperty 
localeUndefinedError:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Error message when the locale is undefined or is not available.

The default value is "Locale is undefined.".

This property can be used as the source for data binding.


Implementation
    public function get localeUndefinedError():String
    public function set localeUndefinedError(value:String):void
maxValueproperty 
maxValue:Number

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Maximum value for a valid number. A value of NaN means there is no maximum.

The default value is NaN.

This property can be used as the source for data binding.


Implementation
    public function get maxValue():Number
    public function set maxValue(value:Number):void
minValueproperty 
minValue:Number

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Minimum value for a valid number. A value of NaN means there is no minimum.

The default value is NaN.

This property can be used as the source for data binding.


Implementation
    public function get minValue():Number
    public function set minValue(value:Number):void
negativeErrorproperty 
negativeError:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Error message when the value is negative and the allowNegative property is false.

The default value is "The amount may not be negative.".

This property can be used as the source for data binding.


Implementation
    public function get negativeError():String
    public function set negativeError(value:String):void
negativeSymbolproperty 
negativeSymbol:String  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

The negative symbol to be used when validating negative values.

This symbol is used when validating a negative number. This is read-only property as not all operating systems allow customizing of this property.

This property is set to a default value specified by the locale.

This property can be used as the source for data binding.


Implementation
    public function get negativeSymbol():String

See also

negativeNumberFormat
validate()
negativeSymbolErrorproperty 
negativeSymbolError:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Error message when the negative symbol is repeated or is in wrong place.

The default value is "The negative symbol is repeated or not in right place.".

This property can be used as the source for data binding.


Implementation
    public function get negativeSymbolError():String
    public function set negativeSymbolError(value:String):void
notAnIntegerErrorproperty 
notAnIntegerError:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Error message when the number must be an integer, as defined by the domain property.

The default value is "The number must be an integer.".

This property can be used as the source for data binding.


Implementation
    public function get notAnIntegerError():String
    public function set notAnIntegerError(value:String):void
parseErrorproperty 
parseError:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Error message when number could not be parsed.

The default value is "The input string could not be parsed.".

This property can be used as the source for data binding.


Implementation
    public function get parseError():String
    public function set parseError(value:String):void
Constructor Detail
NumberValidatorBase()Constructor
public function NumberValidatorBase()

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.1, AIR 2.5

Constructor.




The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00