Packagejp.co.fujitsu.reffi.client.flex.controller
Classpublic class ParameterMapping

[概 要]

MVC各レイヤを伝播するパラメータオブジェクトです.

[詳 細]

AVMから提供される情報、フレームワークが動作する為の情報、ビジネスロジックから 参照が必要な情報が格納されます。
イベント発生時にコントローラによってインスタンス生成され、 アクション→コントローラ→モデル→コントローラ→アクション→コントローラ
と伝播して、イベントハンドリングが終了した後に破棄されます。

setParameter(Object, Object)を使用することで、 ビジネスロジック固有のパラメータを格納することが出来ます。
MVCの各フックポイントでこのクラスの同一インスタンスを参照することで、 「アクションレイヤで設定したパラメータをモデルレイヤで参照する」 といった処理を、広いスコープの変数を用意することなく実装出来ます。

[備 考]

Reffiによって自動的にset系メソッドがコールされ、情報が設定されます。

Copyright (c) 2008-2009 FUJITSU Japan All rights reserved.



Public Properties
 PropertyDefined by
  actionInstance : AbstractAction

[概 要]

実行中のアクションインスタンスです.
ParameterMapping
  event : Event

[概 要]

このParameterMappingが生成される起因となったイベントです.
ParameterMapping
  eventSourceObject : DisplayObject

[概 要]

アクションを起動したDisplayObjectです.
ParameterMapping
  invokeCompleteHandler : Function

[概 要]

コントローラ#invokeの成功時に実行されるファンクションです.
ParameterMapping
  invokeFailureHandler : Function

[概 要]

コントローラ#invokeの失敗時に実行されるファンクションです.
ParameterMapping
  isRunModelsAndNoWait : Boolean

[概 要]

複数予約されたモデルの実行動作を制御します.
ParameterMapping
  modelFinishedNum : int

[概 要]

モデル完了イベント「ModelProcessEvent.FINISHED」を発行したモデルの数です.
ParameterMapping
  modelReservedNum : int

[概 要]

登録されているモデルクラス型の数です.
ParameterMapping
  models : Array

[概 要]

アクションで登録された機能モデルクラス型の配列です.
ParameterMapping
  parameters : Dictionary

[概 要]

パラメータデータをマップ保持するプロパティです.
ParameterMapping
  validators : Array

[概 要]

アクションで登録されたバリデータインスタンス配列です.
ParameterMapping
  waitModelsDone : Boolean

[概 要]

登録されているモデル群が全終了するまで画面をモーダル状態にするかどうかのフラグです.
ParameterMapping
  waitModelsMessage : String

[概 要]

モーダル状態時のプログレスバーメッセージを設定します。

[詳 細]

[備 考]

ParameterMapping
Public Methods
 MethodDefined by
  

[概 要]

このクラスオブジェクトの複製を返却します.
ParameterMapping
  
getParameter(key:String):Object

[概 要]

パラメータデータマップ保持プロパティから値を取得します.
ParameterMapping
  
setParameter(key:String, value:Object):void

[概 要]

パラメータデータマップ保持プロパティに値を設定します.
ParameterMapping
Public Constants
 ConstantDefined by
  ACTION_INSTANCE : String = "ACTION_INSTANCE"
[static] アクションインスタンスを示す定数です。
ParameterMapping
  EVENT : String = "EVENT"
[static] アクションを起動したイベントを示す定数です。
ParameterMapping
  EVENT_SOURCE_OBJECT : String = "EVENT_SOURCE_OBJECT"
[static] アクションを起動したコンポーネント
ParameterMapping
  INVOKE_COMPLETE_HANDLER : String = "INVOKE_COMPLETE_HANDLER"
[static] コントローラ#invokeの完了時に呼ばれるファンクションを示す定数です
ParameterMapping
  INVOKE_FAILURE_HANDLER : String = "INVOKE_FAILURE_HANDLER"
[static] コントローラ#invokeの失敗時に呼ばれるファンクションを示す定数です
ParameterMapping
  IS_RUN_MODELS_AND_NO_WAIT : String = "IS_RUN_MODELS_AND_NO_WAIT"
[static] モデルシーケンシャル実行フラグを示す定数です。
ParameterMapping
  MODEL_FINISHED_NUM : String = "MODEL_FINISHED_NUM"
[static] モデルの終了数を示す定数です。
ParameterMapping
  MODEL_RESERVE_NUM : String = "MODEL_RESERVE_NUM"
[static] モデルの登録数を示す定数です。
ParameterMapping
  MODELS : String = "MODELS"
[static] 登録モデル群を示す定数です。
ParameterMapping
  VALIDATORS : String = "VALIDATORS"
[static] 登録バリデータ群を示す定数です。
ParameterMapping
  WAIT_MODELS_DONE : String = "WAIT_MODELS_DONE"
[static] モデル処理待ちフラグを示す定数です。
ParameterMapping
  WAIT_MODELS_MESSAGE : String = "WAIT_MODELS_MESSAGE"
[static] モデル処理待ちダイアログのメッセージを示す定数です。
ParameterMapping
Property detail
actionInstanceproperty
actionInstance:AbstractAction  [read-write]

[概 要]

実行中のアクションインスタンスです.

[詳 細]

このParameterMappingオブジェクトが生成されたイベントで、 コントローラに生成されたActionのインスタンスです。

[備 考]

実装
    public function get actionInstance():AbstractAction
    public function set actionInstance(value:AbstractAction):void
eventproperty 
event:Event  [read-write]

[概 要]

このParameterMappingが生成される起因となったイベントです.

[詳 細]

統括的なイベントハンドラであるBaseController#handlerFacade に引数譲渡されたイベントオブジェクトです。

[備 考]

実装
    public function get event():Event
    public function set event(value:Event):void
eventSourceObjectproperty 
eventSourceObject:DisplayObject  [read-write]

[概 要]

アクションを起動したDisplayObjectです.

[詳 細]

Event#currentTargetと同値ですが、 この値はイベントフェーズによって変化しません。

[備 考]

実装
    public function get eventSourceObject():DisplayObject
    public function set eventSourceObject(value:DisplayObject):void
invokeCompleteHandlerproperty 
invokeCompleteHandler:Function  [read-write]

[概 要]

コントローラ#invokeの成功時に実行されるファンクションです.

[詳 細]

このプロパティを設定することで、アクション#completeの後に 実行する処理を予約することができます。

[備 考]

実装
    public function get invokeCompleteHandler():Function
    public function set invokeCompleteHandler(value:Function):void
invokeFailureHandlerproperty 
invokeFailureHandler:Function  [read-write]

[概 要]

コントローラ#invokeの失敗時に実行されるファンクションです.

[詳 細]

このプロパティを設定することで、アクション#failureForwardの後に 実行する処理を予約することができます。

[備 考]

実装
    public function get invokeFailureHandler():Function
    public function set invokeFailureHandler(value:Function):void
isRunModelsAndNoWaitproperty 
isRunModelsAndNoWait:Boolean  [read-write]

[概 要]

複数予約されたモデルの実行動作を制御します.

[詳 細]

モデル群がコントローラに連続実行される際、モデルの処理結果を待たずに 次のモデルを実行するかどうかのフラグです。
モデルの処理結果を待たずに次のモデルを実行する場合はtrueを設定します。

[備 考]

モデルをシーケンシャルに実行しない場合、モデルは登録された順序で実行されますが レスポンスを待たずに次のモデルが実行されます。

The default value is false.

実装
    public function get isRunModelsAndNoWait():Boolean
    public function set isRunModelsAndNoWait(value:Boolean):void
modelFinishedNumproperty 
modelFinishedNum:int  [read-write]

[概 要]

モデル完了イベント「ModelProcessEvent.FINISHED」を発行したモデルの数です.

[詳 細]

登録されているモデルの内、処理が完了したモデルの数を保持します。 この数がmodelReservedNumと等しくなった時、アクションに対してcomplete通知 が行われます。

[備 考]

実装
    public function get modelFinishedNum():int
    public function set modelFinishedNum(value:int):void
modelReservedNumproperty 
modelReservedNum:int  [read-write]

[概 要]

登録されているモデルクラス型の数です.

[詳 細]

コントローラに実行委譲予約された機能モデルの数です。
モデルが予約されなかった場合でも、デフォルト実行されるモデルの 数は換算されます。

[備 考]

実装
    public function get modelReservedNum():int
    public function set modelReservedNum(value:int):void
modelsproperty 
models:Array  [read-write]

[概 要]

アクションで登録された機能モデルクラス型の配列です.

[詳 細]

BaseAction#run終了後にコントローラに実行されるモデルクラス型配列です。 BaseAction#reserveModelsの返却値が登録されます。

[備 考]

実装
    public function get models():Array
    public function set models(value:Array):void
parametersproperty 
parameters:Dictionary  [read-write]

[概 要]

パラメータデータをマップ保持するプロパティです.

[詳 細]

定数キーに対する値、任意に設定されたキーに対する値を保持します。

[備 考]

実装
    public function get parameters():Dictionary
    public function set parameters(value:Dictionary):void
validatorsproperty 
validators:Array  [read-write]

[概 要]

アクションで登録されたバリデータインスタンス配列です.

[詳 細]

BaseAction#validateメソッドで使用されるバリデータ配列です。
BaseAction#validatorsメソッドの返却値が登録されます。

[備 考]

実装
    public function get validators():Array
    public function set validators(value:Array):void
waitModelsDoneproperty 
waitModelsDone:Boolean  [read-write]

[概 要]

登録されているモデル群が全終了するまで画面をモーダル状態にするかどうかのフラグです.

[詳 細]

true設定されていると、コントローラによるモデル群実行が全て終了するまで 表示リスト最上部にモーダルポップアップを表示します。

[備 考]

実装
    public function get waitModelsDone():Boolean
    public function set waitModelsDone(value:Boolean):void
waitModelsMessageproperty 
waitModelsMessage:String  [read-write]

[概 要]

モーダル状態時のプログレスバーメッセージを設定します。

[詳 細]

[備 考]

実装
    public function get waitModelsMessage():String
    public function set waitModelsMessage(value:String):void
Method detail
clone()method
public function clone():ParameterMapping

[概 要]

このクラスオブジェクトの複製を返却します.

[詳 細]

ParameterMappingオブジェクト、及び保持するプロパティは完全なコピーを作りますが、 parametersプロパティ内で保持する定数キー要素値のアドレス参照はコピーしません。

parameterMapping.parametersと、
clonedParameterMapping.parameters
は異なるアドレスで保持されますが、

parameterMapping.eventSourceObjectと、
clonedParameterMapping.eventSourceObject
は同じアドレスを返却します。

[備 考]

このメソッドはアクションからコントローラに別アクション実行を委譲する場合等に使用します。
            override protected function prepare(parameterMapping:ParameterMapping):Boolean {
                controller.invoke(Class(OtherAction), parameterMapping.clone());
                 
                return true;
            }
   
コントローラはコールバック(successForwardやfailureForward)先アクションアドレスを ParameterMapping#actionInstanceで判別しますが、invokeが呼ばれると左記のアドレスを指定 された新規アクションのアドレスで上書きします。
上記のようにinvokeを呼び出すことで、コントローラが認識するアクションアドレスの上書き を抑止することが出来ます。

戻り値
ParameterMapping — 複製されたParameterMappingオブジェクト
getParameter()method 
public function getParameter(key:String):Object

[概 要]

パラメータデータマップ保持プロパティから値を取得します.

[詳 細]

parametersプロパティから引数keyに対応する値を取得して返却します。

[備 考]

パラメータ
key:String — 取得する値のキー

戻り値
Object
setParameter()method 
public function setParameter(key:String, value:Object):void

[概 要]

パラメータデータマップ保持プロパティに値を設定します.

[詳 細]

parametersプロパティに引数keyをキーにして引数valueを登録します。

[備 考]

パラメータ
key:String — 設定する値のキー
 
value:Object — 設定する値
Constant detail
ACTION_INSTANCEconstant
public static const ACTION_INSTANCE:String = "ACTION_INSTANCE"

アクションインスタンスを示す定数です。

EVENTconstant 
public static const EVENT:String = "EVENT"

アクションを起動したイベントを示す定数です。

EVENT_SOURCE_OBJECTconstant 
public static const EVENT_SOURCE_OBJECT:String = "EVENT_SOURCE_OBJECT"

アクションを起動したコンポーネント

INVOKE_COMPLETE_HANDLERconstant 
public static const INVOKE_COMPLETE_HANDLER:String = "INVOKE_COMPLETE_HANDLER"

コントローラ#invokeの完了時に呼ばれるファンクションを示す定数です

INVOKE_FAILURE_HANDLERconstant 
public static const INVOKE_FAILURE_HANDLER:String = "INVOKE_FAILURE_HANDLER"

コントローラ#invokeの失敗時に呼ばれるファンクションを示す定数です

IS_RUN_MODELS_AND_NO_WAITconstant 
public static const IS_RUN_MODELS_AND_NO_WAIT:String = "IS_RUN_MODELS_AND_NO_WAIT"

モデルシーケンシャル実行フラグを示す定数です。

MODEL_FINISHED_NUMconstant 
public static const MODEL_FINISHED_NUM:String = "MODEL_FINISHED_NUM"

モデルの終了数を示す定数です。

MODEL_RESERVE_NUMconstant 
public static const MODEL_RESERVE_NUM:String = "MODEL_RESERVE_NUM"

モデルの登録数を示す定数です。

MODELSconstant 
public static const MODELS:String = "MODELS"

登録モデル群を示す定数です。

VALIDATORSconstant 
public static const VALIDATORS:String = "VALIDATORS"

登録バリデータ群を示す定数です。

WAIT_MODELS_DONEconstant 
public static const WAIT_MODELS_DONE:String = "WAIT_MODELS_DONE"

モデル処理待ちフラグを示す定数です。

WAIT_MODELS_MESSAGEconstant 
public static const WAIT_MODELS_MESSAGE:String = "WAIT_MODELS_MESSAGE"

モデル処理待ちダイアログのメッセージを示す定数です。