KAIDEN.base.foundation.GadgetManager
- GadgetManager
Constructor
ガジェットに関する管理やメディエータの役目をします
シングルトンのため、
new GadgetManager()
を何度行っても必ず単一のインスタンスを返却します。
Instance members
Instance Methods
- args : Object
- イベント引数
- callerGadgetId : String
- 呼び出し元ガジェットID
- gadgetId4forceOnly : String
- 特定のガジェットIDのみにイベントを発行する場合のガジェットID
- blockId4forceOnly : String
- 特定のブロックIDのみにイベントを発行する場合のブロックID
- positionMin : int
- 処理順の最小値(指定値を含む)
- positionMax : int
- 処理順の最大値(指定値を含まない)
- args : Object
- イベント引数
- callerGadgetId : String
- 呼び出し元ガジェットID
- gadgetId4forceOnly : String
- 特定のガジェットIDのみにイベントを発行する場合のガジェットID
- blockId4forceOnly : String
- 特定のブロックIDのみにイベントを発行する場合のブロックID
- positionMin : int
- 処理順の最小値(指定値を含む)
- positionMax : int
- 処理順の最大値(指定値を含まない)
- eventKey : String
- イベントキー
- arg : Object
- イベント引数
- callerGadgetId : String
- 呼び出し元ガジェットID
- gadgetId4forceOnly : String
- 特定のガジェットIDのみにイベントを発行する場合のガジェットID
- Object[]
- 各ガジェットの戻り値配列 ※以下をプロパティに持つオブジェクトの配列
- gadgetAttr:ガジェット属性オブジェクト
- result:戻り値
- eventKey : String
- イベントキー
- arg : Object
- イベント引数
- callerGadgetId : String
- 呼び出し元ガジェットID
- gadgetId4forceOnly : String
- 特定のガジェットIDのみにイベントを発行する場合のガジェットID
- unknown
- 各ガジェットの戻り値配列 ※以下をプロパティに持つオブジェクトの配列
- gadgetAttr:ガジェット属性オブジェクト
- result:戻り値
シンタックスシュガーのKAIDEN.getGadget("ガジェットId");
が便利です。
- gadgetId : String
- ガジェットID
- Object
- ガジェットオブジェクト
- gadgetIds : String/String[]
- 指定したガジェットのみ返却。省略した場合は全ガジェット
- Object
- 入力値データを保持したオブジェクト.
{ガジェットId:{フィールドキー:値 ... }, ガジェットId:{TmtableId:[{フィールドキー:値},{フィールドキー:値}] } }
の形式で返却します
- "fail"
- "warn"
- "success"
それぞれメッセージが返却されていた場合にはメッセージを表示します。
ガジェット間通信の戻り値が、「jp.co.slcs.kaiden.v2.base.foundation.model.dto.LogicResultDto」をである必要があります
- ret : Object[]
- ガジェット間通信の戻り値
- String
- "success"/"warn"/"fail"のいずれか
- target : Object
- 対象エレメント(HtmlElement)、または所属オブジェクト(「KAIDEN.gadgetMan.whereMe」の結果)
- name : String
- 検索するelementの名前
- skipDistinctionUiType : boolean
- trueを設定するとユーザ定義のエレメントタイプを判定しません
- element : HtmlElement
- 対象エレメント(HtmlElement)
- unknown
- 下記いずれかを返却
- true:カードブロックに所属する場合
- false:カードブロックに所属しない場合
- element : HtmlElement
- 対象エレメント(HtmlElement)
- unknown
- 下記いずれかを返却
- true:TMテーブルに所属する場合
- false:TMテーブルに所属しない場合
- gadgetId : String
- ガジェットID
すべてのガジェットが"true"を返却した(もしくは処理該当ガジェットが存在しない)場合のみ、trueを返却します
単項目チェック後に処理を行い、なんらかの理由で後続処理を実施しないように制御したい場合には、イベントリスナよりfalseを返却してください
引数は省略可能ですが、すべての引数を省略した場合のみ、前回と同じ引数をイベントに渡します。それ以外は指定された引数をイベントに渡します。
- arg : Object
- イベント引数
- boolean
- 処理結果
すべてのガジェットが"true"を返却した(もしくは処理該当ガジェットが存在しない)場合のみ、trueを返却します
単項目チェック前に処理を行い、なんらかの理由で単項目チェックを実施しないように制御したい場合には、イベントリスナよりfalseを返却してください
引数は省略可能ですが、すべての引数を省略した場合のみ、前回と同じ引数をイベントに渡します。それ以外は指定された引数をイベントに渡します。
- arg : Object
- イベント引数
- boolean
- 処理結果
通常、ガジェットに対する操作は、以下のようにの後に行う必要があります。
<k:gadgetContainer>~省略~</k:gadgetContainer>
<script type="text/javascript">
//ガジェットに対する処理
</script>
ガジェット内部でインクルードJSPに処理が書かれているなど、どうしてもガジェット内でそのガジェットの操作が必要な場合に、ファンクションを登録します。
登録されたファンクションは、ガジェット初期化後に実行されます。
- gadgetId : String
- ガジェットID
- func : Function
- 関数
すべてのガジェットはこの機能でガジェットマネージャに登録する必要があります。
ただし、通常はタグリブ(
- 本機能では、ガジェット内の要素に対して、以下のルールでname属性、id属性を付与し初期化します。
また、tmtableに属するエレメントは行挿入時などにname属性にタプルIDも付与されます。- name属性の先頭に【ガジェットID + "-" + ブロックID + "-"】 を付与。
※変更前のname属性は、data-kaiden-org-nameに保持。 - id属性の先頭に【ガジェットID + "-" + ブロックID + "-"】 を付与。
※ 変更前のid属性はdata-kaiden-org-idに保持。
- name属性の先頭に【ガジェットID + "-" + ブロックID + "-"】 を付与。
- エラーコンテナにガジェット自身のバリデーションエラー表示エリアを登録します。
初期化後、以下のようにガジェットオブジェクトを取り出せます。
KAIDEN.base.foundation.GadgetManager().get("ガジェットId");
シンタックスシュガーのKAIDEN.getGadget("ガジェットId");
が便利です。
ガジェットオブジェクトには以下のものが格納されています。
- attr (Object)
以下のガジェット属性が格納されています。- gadgetClass (String)
- gadgetVariation (String)
- gadgetInstance (String)
- gadgetId (String)
- errorContainerId (String)
- gadgetCapterTitle (String) ※ガジェットチャプタータイトル
- formId (String) ※ガジェット内のformId
- tmtables (配列)
KAIDEN.base.foundation.Tmtableが格納されています。
取り出すには、tmtables["TmテーブルID"]としてください。 - blockAccessors (配列)
KAIDEN..base.foundation.BlockAccessorsが格納されています。
取り出すには、blockAccessors["ブロックID"]としてください。 - validationManager (Object) ※開発者が利用することはありません
- eventManager (Object)
KAIDEN.base.foundation.GadgetEventManagerが格納されています。
ガジェットにイベントを登録する場合に取り出して利用してください。 - dialogs(配列)
KAIDEN.base.foundation.Dialogが格納されています。 取り出すには、dialogs["ダイアログID"]としてください。 - clearInput (Function(blockId))
特定のブロック(tmtable除く)をクリアします。 - variable (Object)
空のオブジェクトです。 ※機能実装時に一時的に値等を格納するのに利用してください。
- gadgetId : String
- ガジェットID
- gadgetCapterTitle : String
- ガジェットチャプタータイトル
ガジェットデータを以下の形式にすると、ガジェット内の同名フィールドに対して値を自動的に設定します
{ガジェットId:{フィールドキー:値 ... }, ガジェットId:{TmtableId:[{フィールドキー:値},{フィールドキー:値}] } }
- gadgetIds : String
- ガジェットID
- data : Object
- ガジェットデータ
- isReplaceTmtable : boolean
- true:tmtalbeを洗い替える(タプルID復元) false:tmtableにデータを追記する
- exclude : Object
- 除外フィールド(形式:
{ブロックId|(tmtalbeId)}:field}
)
- gadgetId : String
- No description.
- func : Function
- No description.
ガジェットブロック(ID="caution")が存在する場合のみ実行されます。
- gadgetId : String
- ガジェットID
- type : String
- "warn"もしくは"fail"
- message : String
- メッセージ
単項目チェック後に、関連チェック(relationValidate)およびガジェット間チェック(gadgetRelationValidate)イベントを発行し、単項目・関連チェック・ガジェット間チェックのすべてがtrueの場合のみ、trueを返却します
※関連チェック(relationValidate)およびガジェット間チェック(gadgetRelationValidate)イベントは、true/falseいずれかを返却してください
引数は省略可能ですが、すべての引数を省略した場合のみ、前回と同じ条件でバリデーションを行います。それ以外は指定された条件でバリデーションを行います。
- eventKey : String
- イベントキー
- escalationDefaultValidate : boolean
- イベントキーに対するバリデートに加えてデフォルトバリデートを実行
- arg : Object
- 関連チェック、ガジェット間チェックに対するバリデーション引数
- booelan
- バリデーション結果(true:エラーなし、false:エラーあり)
各項目のエラー状態がリセットされます
- element : HtmlElement
- 対象エレメント(HtmlElement)
- Object
- 以下のプロパティを持つオブジェクト
- gadgetId:ガジェットID
- tmtableId:TmテーブルID
- tmtTupleId:Tmテーブル内のタプルID
- cardId:カードID
- cardBlockId:カード内のブロックID
- blockId:ブロックID