Class: ViewClass

Iroha. ViewClass

new ViewClass(constructor)

Parameters:
Name Type Argument Description
constructor Function <optional>
対象のコンストラクタ関数
Source:
Returns:
汎用クラスプロパティ・メソッド群を与えられたコンストラクタ

Members

<private> defMethods :Object

コンストラクタの prototype が備えているべき「既定のメソッド」。無ければここから補われる。
Type:
  • Object
Source:

instances :Array

生成したインスタンス群からなる配列
Type:
  • Array
Source:

<constant> isIrohaViewClass :boolean

Iroha.ViewClass のものであることを示すフラグ
Type:
  • boolean
Source:

key :string

インスタンスのインデックス番号を格納するためのキー。
Type:
  • string
Source:

Methods

<static> applyTo(constructor) → {Function}

与えられたコンストラクタ(クラス)に汎用クラスプロパティ・メソッド群を与える。
Parameters:
Name Type Description
constructor Function 対象のコンストラクタ関数
Source:
Returns:
汎用クラスプロパティ・メソッド群を与えられたコンストラクタ
Type
Function

add(args) → {Object}

新しいインスタンスを生成し、このクラス(コンストラクタ)のインスタンスリストに追加する。 create() の第1引数に要素ノードを(まだ)与えることができない場合に、このメソッドを用いることができる。 生成されたインスタンスに init(), dispose() 等の既定のメソッドが無ければ、最低限度の機能のそれらが付与される。 最後に instance.init() が自動的に呼び出される。 instance.init() で最低限必要な処理は、第1引数として与えられる「基底要素ノード」を instance.$node に格納することである。
Parameters:
Name Type Argument Description
args Arguments <optional>
instance.init() に渡される引数(群)。
Source:
Returns:
生成したインスタンス
Type
Object

create(node, args) → {Object}

任意の要素ノードを与えて新しくインスタンスを生成するか、同じ要素ノードから生成された既存のインスタンスを得る。 第1引数には要素ノードを与えなければならない。この要素ノードを、インスタンスが主として取扱う「基底要素ノード」と定義する。 生成されたインスタンスに init(), dispose() 等の既定のメソッドが無ければ、最低限度の機能のそれらが付与される。 最後に instance.init() が自動的に呼び出される。 instance.init() で最低限必要な処理は、第1引数として与えられる「基底要素ノード」を instance.$node に格納することである。
Parameters:
Name Type Argument Description
node jQuery | Element | string インスタンスが主として取扱う「基底要素ノード」。instance.init() の第1引数として渡される。
args Arguments <optional>
instance.init() に渡される2番目以降の引数。
Source:
Returns:
生成したインスタンス
Type
Object

disposeInstance(instance)

クラスから作られた既存インスタンスを破棄する。
Parameters:
Name Type Description
instance Object 破棄対象のインスタンス
Source:

extend(constructor) → {Function}

指定したコンストラクタ(クラス)のプロトタイプを現在のコンテキストのコンストラクタ(クラス)へ継承させる。
Parameters:
Name Type Description
constructor Function 継承元のコンストラクタ(クラス)
Source:
Returns:
コンテキストのコンストラクタ自身
Type
Function

getInstance(arg) → {Object}

クラスから作られた既存インスタンスを得る。
Parameters:
Name Type Argument Description
arg number | jQuery | Element | string <optional>
インデックス番号、またはインスタンス生成時に指定した「基底要素ノード」。 引数無指定時は全ての既存インスタンスからなる配列が返る。
Source:
Returns:
該当のインスタンス。存在しなければ undefined が返る。引数無指定時は全ての既存インスタンスからなる配列が返る。
Type
Object

<private> storeInstance(instance) → {Object}

クラスから生成されたインスタンスを格納する
Parameters:
Name Type Description
instance Object 生成したインスタンス
Source:
Returns:
格納したインスタンスそれ自身
Type
Object

Iroha. ViewClass

new ViewClass() → {Iroha.ViewClass}

新規インスタンスを生成して返す。
Source:
Returns:
新規インスタンス
Type
Iroha.ViewClass

Members

<private> defMethods :Object

コンストラクタの prototype が備えているべき「既定のメソッド」。無ければここから補われる。
Type:
  • Object
Source:

instances :Array

生成したインスタンス群からなる配列
Type:
  • Array
Source:

<constant> isIrohaViewClass :boolean

Iroha.ViewClass のものであることを示すフラグ
Type:
  • boolean
Source:

key :string

インスタンスのインデックス番号を格納するためのキー。
Type:
  • string
Source:

Methods

<static> applyTo(constructor) → {Function}

与えられたコンストラクタ(クラス)に汎用クラスプロパティ・メソッド群を与える。
Parameters:
Name Type Description
constructor Function 対象のコンストラクタ関数
Source:
Returns:
汎用クラスプロパティ・メソッド群を与えられたコンストラクタ
Type
Function

add(args) → {Object}

新しいインスタンスを生成し、このクラス(コンストラクタ)のインスタンスリストに追加する。 create() の第1引数に要素ノードを(まだ)与えることができない場合に、このメソッドを用いることができる。 生成されたインスタンスに init(), dispose() 等の既定のメソッドが無ければ、最低限度の機能のそれらが付与される。 最後に instance.init() が自動的に呼び出される。 instance.init() で最低限必要な処理は、第1引数として与えられる「基底要素ノード」を instance.$node に格納することである。
Parameters:
Name Type Argument Description
args Arguments <optional>
instance.init() に渡される引数(群)。
Source:
Returns:
生成したインスタンス
Type
Object

create(node, args) → {Object}

任意の要素ノードを与えて新しくインスタンスを生成するか、同じ要素ノードから生成された既存のインスタンスを得る。 第1引数には要素ノードを与えなければならない。この要素ノードを、インスタンスが主として取扱う「基底要素ノード」と定義する。 生成されたインスタンスに init(), dispose() 等の既定のメソッドが無ければ、最低限度の機能のそれらが付与される。 最後に instance.init() が自動的に呼び出される。 instance.init() で最低限必要な処理は、第1引数として与えられる「基底要素ノード」を instance.$node に格納することである。
Parameters:
Name Type Argument Description
node jQuery | Element | string インスタンスが主として取扱う「基底要素ノード」。instance.init() の第1引数として渡される。
args Arguments <optional>
instance.init() に渡される2番目以降の引数。
Source:
Returns:
生成したインスタンス
Type
Object

disposeInstance(instance)

クラスから作られた既存インスタンスを破棄する。
Parameters:
Name Type Description
instance Object 破棄対象のインスタンス
Source:

extend(constructor) → {Function}

指定したコンストラクタ(クラス)のプロトタイプを現在のコンテキストのコンストラクタ(クラス)へ継承させる。
Parameters:
Name Type Description
constructor Function 継承元のコンストラクタ(クラス)
Source:
Returns:
コンテキストのコンストラクタ自身
Type
Function

getInstance(arg) → {Object}

クラスから作られた既存インスタンスを得る。
Parameters:
Name Type Argument Description
arg number | jQuery | Element | string <optional>
インデックス番号、またはインスタンス生成時に指定した「基底要素ノード」。 引数無指定時は全ての既存インスタンスからなる配列が返る。
Source:
Returns:
該当のインスタンス。存在しなければ undefined が返る。引数無指定時は全ての既存インスタンスからなる配列が返る。
Type
Object

<private> storeInstance(instance) → {Object}

クラスから生成されたインスタンスを格納する
Parameters:
Name Type Description
instance Object 生成したインスタンス
Source:
Returns:
格納したインスタンスそれ自身
Type
Object