mxsdoc

依存

• std

struct MwmViewModelStruct

ビューモデルを定義するための構造体。

補足

作成パラメータ

MwmViewModelStruct viewModelName

通知

通知名	通知データ	タイミング
#BindingTable	新たなbindingTable値	bindingTableを設定した後
#CommandTable	新たなcommandTable値	commandTableを設定した後
#ModelTable	新たなmodelTable値	modelTableを設定した後
#PropertyTable	新たなpropertyTable値	propertyTableを設定した後
#TargetChanged	イベントオブジェクト	ターゲットオブジェクトの変更が通知された後
#ViewModelName	新たなviewModelName値	viewModelNameを設定した後

注意点

• コマンドオブジェクトとプロパティオブジェクトの名前はビューモデル内において一意でなければならない。

public _CP1_

プロパティ

<Name>

作成パラメータ1。ビューモデル名。既定値はundefined。

private bindingTable

プロパティ

<Dictionary <Name> <Dictionary <Name> <Struct:MwmBindingStruct>>>

バインディングオブジェクトをソース名とターゲットオブジェクト名に紐付けて格納。既定値はundefined。

private commandTable

プロパティ

<Dictionary <Name> <Struct:MwmCommandStruct>>

コマンドオブジェクトをコマンド名に紐付けて格納。既定値はundefined。

private modelTable

プロパティ

<Dictionary <Name> <Struct>>

モデルオブジェクトをモデル名に紐付けて格納。既定値はundefined。

private propertyTable

プロパティ

<Dictionary <Name> <Struct:MwmPropertyStruct>>

プロパティオブジェクトをプロパティ名に紐付けて格納。既定値はundefined。

private viewModelName

プロパティ

<Name>

ビューモデル名。既定値はundefined。

public fn AddCommand

コマンドオブジェクトを追加する。

パラメータ

command

<Struct:MwmCommandStruct>

コマンドオブジェクト。

戻り値

<BooleanClass>

追加に成功した場合はtrue、失敗した場合はfalse。

補足

無効な値の場合はfalseを返す。

public fn AddModel

モデルオブジェクトを追加する。

パラメータ

modelName

<Name>

モデル名。

パラメータ

obj

<Struct>

モデルオブジェクト。

戻り値

<BooleanClass>

追加に成功した場合はtrue、失敗した場合はfalse。

補足

無効な値の場合はfalseを返す。

public fn AddProperty

プロパティオブジェクトを追加する。

パラメータ

property

<Struct:MwmPropertyStruct>

プロパティオブジェクト。

戻り値

<BooleanClass>

追加に成功した場合はtrue、失敗した場合はfalse。

補足

無効な値の場合はfalseを返す。

public fn CanExecuteCommand

コマンドが実行可能かどうかを判定する。

パラメータ

commandName

<Name>

コマンド名。

戻り値

<BooleanClass>

補足

無効な値の場合はfalseを返す。

public fn ClearBinding

バインディングオブジェクトを削除する。

パラメータ

binding

<Struct:MwmBindingStruct>

バインディングオブジェクト。

戻り値

<BooleanClass>

追加に成功した場合はtrue、失敗した場合はfalse。

補足

無効な値の場合はfalseを返す。

public fn ExecuteCommand

コマンドを実行する。

パラメータ

commandName

<Name>

コマンド名。

戻り値

<OkClass>

補足

無効な値の場合は何もしない。

public fn GetBinding

バインディングオブジェクトを取得する。

パラメータ

sourceName

<Name>

ソース名。プロパティオブジェクトまたはコマンドオブジェクトの名前。

パラメータ

targetName

<Name>

ターゲットオブジェクトの名前。

戻り値

<Struct:MwmBindingStruct|UndefinedClass>

補足

バインディングオブジェクトが存在しない場合はundefinedを返す。

public fn GetBindingSourceNames

登録されているバインディングオブジェクトのソース名を取得する。

戻り値

<Array[<Name>]>

public fn GetBindingTargetNames

登録されているバインディングオブジェクトのターゲット名を取得する。

パラメータ

sourceName

<Name>

ソース名。プロパティオブジェクトまたはコマンドオブジェクトの名前。

戻り値

<Array[<Name>]>

補足

無効な値の場合は空の配列を返す。

public fn GetCommand

コマンドオブジェクトを取得する。

パラメータ

commandName

<Name>

コマンド名。

戻り値

<Struct:MwmCommandStruct|UndefinedClass>

補足

コマンドオブジェクトが存在しない場合はundefinedを返す。

public fn GetCommandNames

登録されているコマンドオブジェクトのコマンド名を取得する。

戻り値

<Array[<Name>]>

public fn GetModel

モデルオブジェクトを取得する。

パラメータ

modelName

<Name>

モデル名。

戻り値

<Struct|UndefinedClass>

補足

モデルオブジェクトが存在しない場合はundefinedを返す。

public fn GetModelNames

登録されているモデルオブジェクトのモデル名を取得する。

戻り値

<Array[<Name>]>

public fn GetProperty

プロパティオブジェクトを取得する。

パラメータ

propertyName

<Name>

プロパティ名。

戻り値

<Struct:MwmPropertyStruct|UndefinedClass>

補足

プロパティオブジェクトが存在しない場合はundefinedを返す。

public fn GetPropertyNames

登録されているプロパティオブジェクトのプロパティ名を取得する。

戻り値

<Array[<Name>]>

public fn GetPropertyValue

プロパティオブジェクトのプロパティ値を取得する。

パラメータ

propertyName

<Name>

プロパティ名。

戻り値

<Any>

補足

プロパティオブジェクトが存在しない場合はundefinedを返す。

public fn GetViewModelName

ビューモデル名を取得する。

戻り値

<Name|UndefinedClass>

public fn HasBinding

バインディングオブジェクトが存在するかどうかを判定する。

パラメータ

binding

<Struct:MwmBindingStruct>

戻り値

<BooleanClass>

補足

無効な値の場合はfalseを返す。

public fn HasBindingByName

名前からバインディングオブジェクトが存在するかどうかを判定する。

パラメータ

sourceName

<Name>

ソース名。プロパティオブジェクトまたはコマンドオブジェクトの名前。

パラメータ

targetName

<Name>

ターゲットオブジェクトの名前。

戻り値

<BooleanClass>

補足

無効な値の場合はfalseを返す。

public fn HasCommand

コマンドオブジェクトが存在するかどうかを判定する。

パラメータ

key

<Struct:MwmCommandStruct|Name>

コマンドオブジェクトまたはコマンド名。

戻り値

<BooleanClass>

補足

無効な値の場合はfalseを返す。

public fn HasModel

モデルオブジェクトが存在するかどうかを判定する。

パラメータ

key

<Struct|Name>

モデルオブジェクトまたはモデル名。

戻り値

<BooleanClass>

補足

無効な値の場合はfalseを返す。

public fn HasProperty

プロパティオブジェクトが存在するかどうかを判定する。

パラメータ

key

<Struct:MwmPropertyStruct|Name>

プロパティオブジェクトまたはプロパティ名。

戻り値

<BooleanClass>

補足

無効な値の場合はfalseを返す。

public fn Load

パラメータ

config

<Struct:ConfigStruct>

戻り値

<BooleanClass>

public fn RaiseTargetChanged

ターゲットオブジェクトの変更通知を発行する。

パラメータ

event

<Struct:MwmEventStruct>

イベントオブジェクト。

戻り値

<OkClass>

補足

無効な値の場合は何もしない。

public fn RefreshBinding

バインディングオブジェクトを更新してターゲットを最新の状態にする。

戻り値

<OkClass>

public fn Save

パラメータ

config

<Struct:ConfigStruct>

戻り値

<BooleanClass>

public fn SetBinding

バインディングオブジェクトを追加する。

パラメータ

binding

<Struct:MwmBindingStruct>

バインディングオブジェクト。

戻り値

<BooleanClass>

追加に成功した場合はtrue、失敗した場合はfalse。

補足

無効な値の場合はfalseを返す。

public fn SetPropertyValue

プロパティオブジェクトのプロパティ値を設定する。

パラメータ

propertyName

<Name>

プロパティ名。

パラメータ

propertyValue

<Any>

プロパティ値。

戻り値

<BooleanClass>

設定に成功した場合はtrue、失敗した場合はfalse。

補足

無効な値の場合は何もしない。

public fn SetViewModelName

ビューモデル名を設定する。

パラメータ

input

<Name>

戻り値

<Name>

補足

無効な値の場合は何もしない。

private fn isValidBinding

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidCommand

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidConfig

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidControl

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidEvent

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidModel

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidModelAttribute

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn isValidProperty

パラメータ

obj

<Any>

戻り値

<BooleanClass>

private fn setCommandTo

バインディングオブジェクトのソースにコマンドオブジェクトを設定し、コマンドオブジェクトの通知元オブジェクトにバイディングの対応メソッドを購読させる。

パラメータ

obj

<Struct:MwmBindingStruct>

戻り値

<BooleanClass>

設定に成功した場合はtrue、失敗した場合はfalse。

private fn setModelTo

モデル属性を持つオブジェクトにモデルオブジェクトを設定する。

パラメータ

obj

<Struct>

戻り値

<BooleanClass>

設定に成功した場合はtrue、失敗した場合はfalse。

private fn setPropertyTo

バインディングオブジェクトのソースにプロパティオブジェクトを設定し、プロパティオブジェクトの通知元オブジェクトにバイディングの対応メソッドを購読させる。

パラメータ

obj

<Struct:MwmBindingStruct>

戻り値

<BooleanClass>

設定に成功した場合はtrue、失敗した場合はfalse。

public fn StructName

戻り値

<Name>

public fn Dump

パラメータ

indent:

<String>

パラメータ

out:

<FileStream|StringStream|WindowStream>

出力先。既定値はlistener。

戻り値

<OkClass>

public fn Equals

パラメータ

obj

<Any>

戻り値

<BooleanClass>

補足

大文字と小文字を区別する。

public StateChanged

プロパティ

<Struct:ObservableStruct>

private targetChanged

プロパティ

<Struct:ObservableStruct>