パッケージmx.formatters
クラスpublic class Formatter
継承Formatter Inheritance Object
サブクラス CurrencyFormatter, DateFormatter, NumberFormatter, PhoneFormatter, ZipCodeFormatter

Formatter クラスはすべてのデータフォーマッタの基本クラスです。 Formatter クラスのすべてのサブクラスでは、format() メソッドをオーバーライドする必要があります。

MXML のシンタックスexpandedMXML シンタックスを隠す

The Formatter class defines the following tag attributes, which all of its subclasses inherit:

  <mx:tagname
    Properties
    error=""
  />
  

例を表示

関連項目

Creating a custom formatter


パブリックプロパティ
 プロパティ定義元
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  defaultInvalidFormatError : String
[静的] 無効なフォーマットストリングがフォーマッタに指定されたことを示すエラーメッセージです。
Formatter
  defaultInvalidValueError : String
[静的] 無効な値がフォーマッタに指定されたことを示すエラーメッセージです。
Formatter
  error : String
エラーが発生したときにフォーマッタによって保存される説明を表します。
Formatter
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
プロテクトプロパティ
 プロパティ定義元
  resourceManager : IResourceManager
[読み取り専用] アプリケーションのローカライズされたすべてのリソースを管理するオブジェクトへの参照です。
Formatter
パブリックメソッド
 メソッド定義元
  
コンストラクタです。
Formatter
  
値をフォーマットし、新しくフォーマットされた値を含むストリングを返します。
Formatter
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
プロテクトメソッド
 メソッド定義元
  
このメソッドは、Formatter の作成時に呼び出されます。また、ローカライズされたリソースが何らかの方法で変更されたことを示すために、ResourceManager が "change" イベントを送出した時点で常に呼び出されます。
Formatter
プロパティの詳細
defaultInvalidFormatErrorプロパティ
defaultInvalidFormatError:String

無効なフォーマットストリングがフォーマッタに指定されたことを示すエラーメッセージです。

デフォルト値 : "Invalid format".



実装
    public static function get defaultInvalidFormatError():String
    public function set defaultInvalidFormatError(value:String):void
defaultInvalidValueErrorプロパティ 
defaultInvalidValueError:String

無効な値がフォーマッタに指定されたことを示すエラーメッセージです。

デフォルト値 : "Invalid value".



実装
    public static function get defaultInvalidValueError():String
    public function set defaultInvalidValueError(value:String):void
errorプロパティ 
public var error:String

エラーが発生したときにフォーマッタによって保存される説明を表します。 このプロパティで使用可能な値については、各フォーマッタの説明を参照してください。

サブクラスでは format() メソッドの中でこの値を設定する必要があります。

resourceManagerプロパティ 
resourceManager:IResourceManager  [読み取り専用]

アプリケーションのローカライズされたすべてのリソースを管理するオブジェクトへの参照です。これは、IResourceManager インターフェイスを実装するシングルトンインスタンスです。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 unused イベントが送出されます。



実装
    protected function get resourceManager():IResourceManager
コンストラクタの詳細
Formatter()コンストラクタ
public function Formatter()

コンストラクタです。

メソッドの詳細
format()メソッド
public function format(value:Object):String

値をフォーマットし、新しくフォーマットされた値を含むストリングを返します。 すべてのサブクラスでこのメソッドをオーバーライドし、フォーマッタを実装する必要があります。

パラメータ

value:Object — フォーマットする値を表します。

戻り値
String — フォーマットしたストリングを表します。
resourcesChanged()メソッド 
protected function resourcesChanged():void

このメソッドは、Formatter の作成時に呼び出されます。また、ローカライズされたリソースが何らかの方法で変更されたことを示すために、ResourceManager が "change" イベントを送出した時点で常に呼び出されます。

このイベントは、ResourceManager の localeChain プロパティを設定したとき、リソースモジュールがロードを終了したとき、および ResourceManager の update() メソッドを呼び出すときに送出されます。

サブクラスでこのメソッドをオーバーライドする必要があります。super.resourcesChanged() を呼び出した後は、新しいリソース値に応じて適切な操作を実行してください。

例の使用法
SimpleFormatterExample.mxml
<?xml version="1.0"?>
<!-- Simple example to demonstrate the Formatter class. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">

    <mx:Script>
        <![CDATA[

            // Event handler to format the input.            
            private function Format():void
            {
                // The format() method returns the formatted String,
                // or an empty String if there is an error.
                var formattedVal:String = numberFormatter.format(inputVal.text);

                if (formattedVal.length==0) {
                    // If there is an error, the Format.error property 
                    // contains the reason.
                    formattedNumber.text=numberFormatter.error;
                }
                
                else {
                    formattedNumber.text=formattedVal;
                }
            }
        ]]>
    </mx:Script>

    <mx:NumberFormatter id="numberFormatter"/>

    <mx:Panel title="NumberFormatter Example" width="75%" height="75%" 
            paddingTop="10" paddingLeft="10" paddingRight="10" paddingBottom="10">

        <mx:Form>
            <mx:FormItem label="Enter number - a letter is invalid:">
                <mx:TextInput id="inputVal" text="" width="75%"/>
            </mx:FormItem>

            <mx:FormItem label="Formatted number: ">
                <mx:TextInput id="formattedNumber" editable="false" width="75%"/>
            </mx:FormItem>

            <mx:FormItem>
                <mx:Button label="Validate and Format" click="Format();"/>
            </mx:FormItem>
        </mx:Form>
  
    </mx:Panel>
</mx:Application>




 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/formatters/Formatter.html