コントローラ化することにより利用可能になるメソッド
Last modified by simdy on 2015/06/02, 17:50
コントローラ化することにより利用可能になるメソッド
定義オブジェクトをコントローラ化すると、以下のメソッドが使えるようになります。
要素の選択・テンプレートの使用・UIブロックなどが簡単に行えます。
| メソッド | 説明 |
|---|---|
| $find(selector) | コントローラ内で指定されたセレクタにマッチする要素を選択します。 selector - セレクタを指定します。 戻り値 - jQueryオブジェクト |
| deferred() | Deferredオブジェクトを返します。 |
| trigger(eventName, parameter) | イベントを発火させます。 eventName - イベント名を指定します。 parameter - パラメータを指定します。渡せるパラメータは1つのみです。複数のパラメータを渡したい場合、オブジェクトのプロパティとして設定してください。 |
| own(func) | 他のライブラリのコールバックにコントローラのメソッドを指定したい時に使用します。 指定されたメソッドに対して、コンテキスト(this)をコントローラに変更したメソッドを返します。 func - コントローラのメソッドを指定します。 戻り値 - コンテキスト(this)をコントローラに変更したメソッド |
| ownWithOrg(func) | 他のライブラリのコールバックにコントローラのメソッドを指定したい時に使用します。 指定されたメソッドに対して、コンテキスト(this)をコントローラに変更し、元々のthisを第1引数に加えたメソッドを返します。 func - コントローラのメソッドを指定します。 戻り値 - コンテキスト(this)をコントローラに変更し、元々のthisを第1引数に加えたメソッド |
| unbind() | コントローラの要素へのバインドを解除します。 |
| indicator(options) | インジケータや画面ブロックを表示するために必要な項目を設定します。 このメソッドを実行しただけではインジケータや画面ブロックは表示されません。 このメソッドの戻り値であるオブジェクトが持つshowメソッドを実行することで、インジケータや画面ブロックの表示を実行します。 options.target - 対象となる要素(オブジェクトまたはセレクタで指定)未指定の場合はコントローラをバインドしたオブジェクト options.message - メッセージ。未指定の場合は何も表示しない。 optons.percent - 進捗を[0～100]の値で指定する。未指定の場合は何も表示しない。 options.block - 操作できないよう画面をブロックするか(デフォルト:する[true]) 戻り値 - Indicatorオブジェクト サンプル - インジケータのサンプル JSDoc - Controller#indicator |
| enableListeners() | コントローラの全てのイベントハンドラが動作するようにします。 |
| disableListeners() | コントローラの全てのイベントハンドラが動作しないようにします。 |
| on(target, eventName, listener) | イベントハンドラを動的にバインドします。onでバインドしたハンドラは、コントローラのアンバインド時にアンバインドされます |
| off(target, eventName, listener) | イベントハンドラをアンバインドします target - ターゲット。コントローラのイベントハンドラ記述で使用できるセレクタでの記述が可能。('{window}'や、'{this.target}'など) eventName - イベント名 listener - イベントリスナ |
| manageChild(controller) | 子コントローラを動的に追加します。引数はルートコントローラである必要があります target - ターゲット eventName - イベント名 listener - イベントリスナ controller - 子コントローラにしたいコントローラインスタンス |
| unmanageChild(controller, andDispose) | 子コントローラを動的に外します。第1引数はコントローラの直接の子コントローラである必要があります controller - 子コントローラから外したいコントローラインスタンス andDispose - 子コントローラから外すときにそのコントローラをdisposeするかどうか。デフォルトはtrueでdisposeします。 |