| パッケージ | spark.validators |
| クラス | public class NumberValidator |
| 継承 | NumberValidator  NumberValidatorBase GlobalizationValidatorBase GlobalizationBase AdvancedStyleClient EventDispatcher Object |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
int、uint および Number オブジェクトを表すストリングを検証できます。
このクラスでは、要求されたロケール ID を指定するために locale スタイルを使用します。
このバリデーターでは、入力が（minValue プロパティと maxValue プロパティで）指定した範囲に収まっていること、整数であること（domain プロパティで指定）、負でないこと（allowNegative プロパティで指定）、負と正の数を正しく指定していること、fractionalDigits の指定数を超えていないことを検証できます。デフォルトのプロパティ値の設定には、flash.globalization.NumberFormatter が使用されるため、ロケール固有の値がオペレーティングシステムによって提供されます。
NumberValidator クラスは MXML 宣言で使用したり、または ActionScript コードで使用したりすることができます。このクラスでは、flash.globalization.NumberFormatter クラスで必要な、要求されたロケール ID を指定するためにロケールスタイルが使用され、バインド可能なメソッドおよびプロパティを持ちます。
MXML シンタックスを表示
MXML シンタックスを隠すThe <spark:NumberValidator> tag
inherits all of the tag attributes of its superclass,
and adds the following tag attributes:
<s:NumberValidator
Properties
negativeNumberFormat="locale specified string or customized by user."
negativeNumberFormatError="The negative format of the input number is incorrect."
/>
関連する API エレメント
パブリックプロパティ
| プロパティ | 定義元 | ||
|---|---|---|---|
 | actualLocaleIDName : String [読み取り専用]
このクラスオブジェクトで使用される実際のロケール ID の名前。 | GlobalizationBase | |
| allowNegative : Boolean
負の数値が使用可能かどうかを指定します。 | NumberValidatorBase | |
| className : String [読み取り専用]
コンポーネントクラスの名前です。 | AdvancedStyleClient | |
| constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| decimalPointCountError : String
小数点の記号を複数個含む場合に発生するエラーメッセージを表します。 | NumberValidatorBase | |
| decimalSeparator : String
小数部分がある数字の検証に使用される小数点区切り文字です。 | NumberValidatorBase | |
| digitsType : uint
数字を検証するときに使用される数字のセットを定義します。 | NumberValidatorBase | |
| domain : String
検証する数値の型を表します。 | NumberValidatorBase | |
| enabled : Boolean
この値を false に設定すると、バリデーターによる検証が行えなくなります。 | GlobalizationValidatorBase | |
| fractionalDigits : int
小数点記号の後に表示できる最大桁数。 | NumberValidatorBase | |
| fractionalDigitsError : String
fractionalDigits プロパティによって指定された値を小数桁が超えたときのエラーメッセージを表します。 | NumberValidatorBase | |
| greaterThanMaxError : String
値が maxValue プロパティの値を超過する場合に発生するエラーメッセージを表します。 | NumberValidatorBase | |
| groupingSeparator : String
グループ化区切りに使用される文字または文字列。 | NumberValidatorBase | |
| id : String
コンポーネントの ID です。 | AdvancedStyleClient | |
| inheritingStyles : Object
このビジュアルでないスタイルクライアントのインスタンスの継承可能なスタイルを含むオブジェクトです。 | AdvancedStyleClient | |
| invalidCharError : String
値に無効な文字が含まれている場合に発生するエラーメッセージを表します。 | NumberValidatorBase | |
| invalidFormatCharsError : String
値に無効な形式の文字が含まれる場合に発生するエラーメッセージを表します。具体的には、区切り文字に数字またはマイナス記号（-）が使用されている場合や区切り文字が複数個連続して使用されている場合がそれに該当します。 | NumberValidatorBase | |
| lastOperationStatus : String [オーバーライド] [読み取り専用]
このクラスオブジェクトが実行した最新の操作のステータス。 | NumberValidatorBase | |
| lessThanMinError : String
値が minValue 未満の場合に発生するエラーメッセージを表します。 | NumberValidatorBase | |
| listener : Object
検証のリスナーを指定します。 | GlobalizationValidatorBase | |
| localeUndefinedError : String
ロケールが未定義であるか使用できない場合に発生するエラーメッセージを表します。 | NumberValidatorBase | |
| maxValue : Number
有効な数値の最大値を表します。 | NumberValidatorBase | |
| minValue : Number
有効な数値の最小値を表します。 | NumberValidatorBase | |
| moduleFactory : IFlexModuleFactory
モジュールファクトリは、このビジュアルでないスタイルクライアントのインスタンスのスタイルを制御するスタイルマネージャーを検索するためのコンテキストとして使用されます。 | AdvancedStyleClient | |
| negativeError : String
負の値で、allowNegative プロパティが false の場合に発生するエラーメッセージを表します。 | NumberValidatorBase | |
| negativeNumberFormat : uint
負の数の検証パターンを示す数値です。 | NumberValidator | ||
| negativeNumberFormatError : String
入力数値の負の数のフォーマットが、negativeNumberFormat プロパティで指定されたパターンに従わない場合に発生するエラーメッセージを表します。 | NumberValidator | ||
| negativeSymbol : String [読み取り専用]
負の値を検証するときに使用されるマイナス記号です。 | NumberValidatorBase | |
| negativeSymbolError : String
マイナス記号が繰り返されているか、または間違った場所にある場合に発生するエラーメッセージを表します。 | NumberValidatorBase | |
| nonInheritingStyles : Object
このコンポーネントの非継承スタイルのチェーンの始まりです。 | AdvancedStyleClient | |
| notAnIntegerError : String
domain プロパティで数値型に整数を指定する必要がある場合に発生するエラーメッセージを表します。 | NumberValidatorBase | |
| parseError : String
数字を解析できなかった場合に発生するエラーメッセージを表します。 | NumberValidatorBase | |
| property : String
検証する値を含む source オブジェクトのプロパティの名前を指定するストリングを表します。 | GlobalizationValidatorBase | |
| required : Boolean = true
true の場合、検証エラーの原因となる欠損値または空値を指定します。 | GlobalizationValidatorBase | |
| requiredFieldError : String
値が欠損し、required プロパティが true の場合に発生するエラーメッセージです。 | GlobalizationValidatorBase | |
| source : Object
検証するプロパティを含むオブジェクトを指定します。 | GlobalizationValidatorBase | |
| styleDeclaration : CSSStyleDeclaration
このオブジェクトで宣言されたインラインスタイルを保持するスタイル宣言です。 | AdvancedStyleClient | |
| styleManager : IStyleManager2 [読み取り専用]
このコンポーネントで使用する StyleManager インスタンスを返します。 | AdvancedStyleClient | |
| styleName : Object
オブジェクトのスタイル値のソースです。 | AdvancedStyleClient | |
| styleParent : IAdvancedStyleClient
コンポーネントの親は、下位要素のセレクターを評価するために使用されます。 | AdvancedStyleClient | |
| trigger : IEventDispatcher
バリデーターをトリガーするイベントの生成を行うコンポーネントを指定します。 | GlobalizationValidatorBase | |
| triggerEvent : String
検証をトリガーするイベントを指定します。 | GlobalizationValidatorBase | |
プロテクトプロパティ
パブリックメソッド
| メソッド | 定義元 | ||
|---|---|---|---|
所定のロケールの規則に基づいて数字を検証するために、新しい NumberValidator オブジェクトを構築します。 | NumberValidator | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。 | EventDispatcher | |
|
このコンポーネントインスタンスからスタイルプロパティを削除します。 | AdvancedStyleClient | |
|
イベントをイベントフローに送出します。 | EventDispatcher | |
|
このコンポーネントに適用されるタイプセレクターの CSSStyleDeclaration オブジェクトの配列を返します。何も存在しない場合は null を返します。 | AdvancedStyleClient | |
| [オーバーライド]
このコンポーネントのスタイル参照チェーンのいずれかの場所に設定されたスタイルプロパティを取得します。 | GlobalizationBase | |
|
currentCSSState が null でない場合、true を返します。 | AdvancedStyleClient | |
|
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。 | EventDispatcher | |
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
initialized メソッドは、このクラスまたはこのクラスを拡張するクラスが MXML 宣言で使用されると呼び出されます。 | AdvancedStyleClient | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
cssState が currentCSSState に一致した場合は、true を返します。 | AdvancedStyleClient | |
|
このインスタンスが、指定されたタイプと同じであるのか、それともそのサブクラスであるのかを判別します。 | AdvancedStyleClient | |
|
スタイルの変更を、このスタイルクライアントのインスタンスの子に通知します。 | AdvancedStyleClient | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
|
getStyle() メソッドが機能するように、内部のスタイルキャッシュ値を設定します。 | AdvancedStyleClient | |
|
各エフェクトイベントのイベントリスナーの 1 つとして、EffectManager を登録します。 | AdvancedStyleClient | |
|
EventDispatcher オブジェクトからリスナーを削除します。 | EventDispatcher | |
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
このコンポーネントインスタンスのスタイルプロパティを設定します。 | AdvancedStyleClient | |
|
スタイルプロパティの変更を検出します。 | AdvancedStyleClient | |
|
コンポーネントのスタイルを初めて初期化するとき、Flex は stylesInitialized() メソッドを呼び出します。 | AdvancedStyleClient | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
検証を実行し、リスナーに任意で結果を通知します。 | GlobalizationValidatorBase | |
| [静的]
validators 配列に含まれるすべてのバリデーターを呼び出します。 | GlobalizationValidatorBase | |
カスタム検証関数からバリデーターを呼び出す便利なメソッドです。 | NumberValidator | ||
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
|
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。 | EventDispatcher | |
プロテクトメソッド
スタイル
スタイルには共通スタイルと特定のテーマに関連するスタイルがあります。共通スタイルは、任意のテーマと共に使用できます。特定のテーマに関連するスタイルは、アプリケーションがそのテーマを使用する場合にのみ使用できます。
共通スタイル
プロパティの詳細
negativeNumberFormat | プロパティ |
negativeNumberFormat:uint| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
負の数の検証パターンを示す数値です。このパターンは、検証される数字の数値部分に関連するマイナス記号または括弧の位置を定義します。
次の表は、負の数の有効なフォーマットの概要を示しています。負の数が検証されるとき、マイナス記号は negativeSymbol プロパティの値を表し、「n」の文字は数値を表します。
| 負の数のフォーマットの種類 | 形式 |
| 0 | (n) |
| 1 | -n |
| 2 | - n |
| 3 | n- |
| 4 | n - |
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。
実装
public function get negativeNumberFormat():uint public function set negativeNumberFormat(value:uint):void例外
ArgumentError — 割り当てられた値が 0～4 の数字でない場合。
|
関連する API エレメント
negativeNumberFormatError | プロパティ |
negativeNumberFormatError:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
入力数値の負の数のフォーマットが、negativeNumberFormat プロパティで指定されたパターンに従わない場合に発生するエラーメッセージを表します。
デフォルト値： "The negative format of the input number is incorrect."。
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 change イベントが送出されます。
実装
public function get negativeNumberFormatError():String public function set negativeNumberFormatError(value:String):voidコンストラクターの詳細
NumberValidator | () | コンストラクター |
public function NumberValidator()| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
所定のロケールの規則に基づいて数字を検証するために、新しい NumberValidator オブジェクトを構築します。
このクラスのロケールは locale スタイルによって提供されます。 locale スタイルは、次のいくつかの方法で設定できます。
-
UIComponentのaddStyleClientメソッドを呼び出すことによってUIComponentからスタイルを継承する。 -
MXML 宣言内でクラスを使用し、宣言を格納するドキュメントからロケールを継承する。
<fx:Declarations> <s:NumberValidator id="nv" /> </fx:Declarations> -
MXML 宣言を使用し、代入のリスト内でロケールの値を指定する。
<fx:Declarations> <s:NumberValidator id="nv_French_France" locale="fr_FR" /> </fx:Declarations> -
setStyleメソッドを呼び出す。例：nv.setStyle("locale", "fr-FR")
locale スタイルが上記のいずれかの手法で設定されていない場合は、このクラスのインスタンスが StyleClient として topLevelApplication に追加されるため、locale 依存のプロパティ getter または locale 依存のメソッドが呼び出されるときに、topLevelApplication オブジェクトから locale が継承されます。
メソッドの詳細
validateNumber | () | メソッド |
public function validateNumber(value:Object, baseField:String):Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 4.5 |
| ランタイムバージョン: | Flash Player 10.1, AIR 2.5 |
カスタム検証関数からバリデーターを呼び出す便利なメソッドです。 他の標準 Flex バリデーターにもそれぞれ同様の便利なメソッドがあります。 呼び出し元は返された配列の ValidationResult オブジェクトで検証ステータスをチェックする必要があります。
パラメーター
value:Object — 検証する数字文字列です。
| |
baseField:String — value オブジェクトで指定したサブフィールドのテキスト表現です。 例えば、value パラメーターで value.number を指定する場合、baseField の値は "number" です。
|
Array — ValidationResult オブジェクトの配列です。このオブジェクトは、検証が行われるフィールドごとに 1 つ含まれます。 |
関連する API エレメント
例 この例の使用方法
NumberValidatorExample1.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Sample program for spark.formatters.NumberValidator -->
<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">
<fx:Declarations>
<s:NumberValidator id="numberValidator" source='{inputNumber}'
property="text" trigger='{validateBtn}'
triggerEvent="click" />
<s:NumberFormatter id="numberFormatter" useGrouping="true"/>
</fx:Declarations>
<fx:Script>
<![CDATA[
[Bindable]
private var number:Number = 123456789.12;
]]>
</fx:Script>
<mx:Form>
<mx:FormItem label="Input Locale ID Name">
<mx:HBox>
<s:TextInput id="inputLocaleIDName" text="en-US"/>
<!-- Upon button click, sets the locale style on the document
UI component. The formatter will inherit this style. -->
<s:Button click="setStyle('locale', inputLocaleIDName.text);"
label="Apply"/>
</mx:HBox>
<mx:Text text="Example: 'en-US', 'fr-FR', 'ja-JP', 'ar-SA'"/>
</mx:FormItem>
<mx:FormItem label="Allow Negative">
<mx:CheckBox id="alowNegative" selected="true"
change="numberValidator.allowNegative = alowNegative.selected"/>
</mx:FormItem>
<mx:FormItem label="Fractional Digits">
<mx:TextInput id="fractionalDigits" text='{numberValidator.fractionalDigits}'
change="numberFormatter.fractionalDigits =
numberValidator.fractionalDigits = Number(fractionalDigits.text)"/>
</mx:FormItem>
<mx:FormItem label="Actual Locale ID Name">
<mx:Text text="{numberValidator.actualLocaleIDName}"/>
</mx:FormItem>
<mx:FormItem label="Input number" >
<mx:HBox>
<mx:TextInput id="inputNumber" />
<mx:Button id="validateBtn" label="Validate" />
</mx:HBox>
</mx:FormItem>
<mx:FormItem label="Example number">
<mx:Text text="{numberFormatter.format(123456789.12)}"/>
</mx:FormItem>
</mx:Form>
</s:Application>
Tue Jun 12 2018, 10:34 AM Z