JsDoc Toolkit テンプレート開発者向けAPIリファレンス

名前空間JSDOC.PluginManager

プラグインの登録とイベントに関する機能を管理する名前空間。

Holds functionality related to running plugins.

名前空間	JSDOC
定義	PluginManager.js

プライベートメンバを隠す

概要	名前空間 \| クラス \| 定数 \| プロパティ \| メソッド \| イベント \| 詳細トップ \| ページトップ

プロパティ ↑
<static> Object[]	JSDOC.PluginManager.plugins プラグイン名をキーとする、登録済みのプラグインのコレクション。

メソッド ↑
<static> void	JSDOC.PluginManager.registerPlugin(name , handlers) プラグインをシステムに登録します。
<static> void	JSDOC.PluginManager.run(hook , target) イベントを発生させ、プラグイン内のハンドラを実行します。

詳細	定数 \| プロパティ \| メソッド \| イベント \| 概要トップ \| ページトップ

プロパティ ↑

<static> Object[] JSDOC.PluginManager.plugins

↑

プラグイン名をキーとする、登録済みのプラグインのコレクション。

The collection of all plugins. Requires a unique name for each.

メソッド ↑

<static> void JSDOC.PluginManager.registerPlugin(name , handlers)

↑

プラグインをシステムに登録します。

引数

String	name	プラグインの名称。使用される全プラグインと重複しないものである必要があります。 A unique name that identifies that plugin.
Object	handlers	各イベントへのハンドラ関数をプロパティに持つオブジェクト。プロパティ名にはイベント名としてあらかじめ規定されたものを設定します。 A collection of named functions. The names correspond to hooks in the core code.

<static> void JSDOC.PluginManager.run(hook , target)

↑

イベントを発生させ、プラグイン内のハンドラを実行します。

引数

String	hook	発生したイベントの名称 The name of the hook that is being caught.
*	target	イベントの名称と一致するハンドラ関数に渡される引数。ハンドラは戻り値を返せないため、値の返却はここで渡されたオブジェクトの値を変更することで行わなければなりません。 Any object. This will be passed as the only argument to the handler whose name matches the hook name. Handlers cannot return a value, so must modify the target object to have an effect.

Documentation generated by JsDoc Toolkit 2.3.2 (template:aias-frame 1.6.1) on Mon Apr 05 2010 22:07:31 GMT+0900 (JST)