Dreamweaver API リファレンス

Dreamweaver3の頃は、日本語訳がなく、英語版のみ提供されていたので、勝手に翻訳して公開しています。現在のDreamweaverでは日本語訳が付いているので、今となっては役に立たないコンテンツです。ただ、共通ライブラリについては元からヘルプがないので、その部分は役に立つと思います。/Commonと/Classは/Configurations/Shared/MM/Scriptsフォルダ内にあるフォルダです。

このファイルは、Dreamweaver をインストールしたフォルダ内にある Configuration/Shared/MM/Scripts/Class フォルダに保存されています。ファイルには、TabControl クラスからのイベントを処理するためのクラスが記述されていますが、ファイルに記述されている PageControl クラスはサンプルのソースコードになっています。実際に使う場合には、自分でこの PageControl クラスを定義して使用します。このクラスを定義しておけば、TabControl クラスの中で PageControl クラスを呼び出すので、TabControl クラスと連携することが出来ます。

  PageControl ()
説明

タブページのイベントを処理する PageControl クラスを初期化します。メンバ変数を初期化する処理を記述します。

引数

theTabLabel
タブページで使用されるラベル名が設定されます。

戻り値

なし。

PageControl クラスを初期化する関数を定義します。関数内では、メンバ変数を初期化します。
function PageControl( theTabLabel )
{
this.tabLabel = theTabLabel;
this.mode = 0;
var doc = dw.getDocumentDOM( "document" );
this.text = doc.body.text;
this.bgcolor = doc.body.bgcolor;
this.link = doc.body.link;
}


  PageControl.getTabLabel ()
説明

タブページのラベル名を取得します。ラベルを表示するときに呼び出される関数です。この関数の処理は、ラベル名を返すだけでいいので、サンプルの記述内容を変更する必要はありません。

引数

なし。

戻り値

タブページのラベル名を返します。

getTabLabel() 関数を定義します。関数内では、ラベル名を返すように記述します。
PageControl.prototype.getTabLabel = PageControl_getTabLabel;
function PageControl_getTabLabel()
{
return this.tabLabel;
}


  PageControl.canLoad ()
説明

タブページの切り替えるかどうか調べます。タブページの切り替え時に呼び出される関数です。この関数を定義しない場合は常に切り替え可能になります。また、切り替え前に処理したい内容を記述することもできます。

引数

なし。

戻り値

タブページの切り替えを許可する場合は true、許可しない場合は false を返します。

canLoad() 関数を定義します。関数内では、切り替えが可能かどうか調べます。
PageControl.prototype.canLoad = PageControl_canLoad;
function PageControl_canLoad()
{
if( mode == 0 )
return true;
else
return false;
}


  PageControl.load ()
説明

タブページを切り替えたときに呼び出されます。関数内では、タブページを表示したときに処理する内容を記述します。

引数

なし。

戻り値

なし。

load() 関数を定義します。関数内では、レイヤー内のフォーム内容をリセットするように記述しています。
PageControl.prototype.load = PageControl_load;
function PageControl_load()
{
var textField = findObject( "text" );
textField.value = "";
}


  PageControl.update ()
説明

タブページを更新したときに呼び出される関数です。関数内では、更新する内容等を記述します。

引数

theItemName

戻り値

なし。

update() 関数を定義します。関数内では、ドキュメントの BODY タグの色を再取得します。
function PageControl_update(theItemName)
{
var textColor = findObject( "text" );
var bgColor = findObject( "bg" );
var linkColor = findObject( "link" );
var doc = dw.getDocumentDOM( "document" );
textColor.value = doc.body.text;
bgColor.value = doc.body.bgcolor;
linkColor.value = doc.body.link;
}


  PageControl.unload ()
説明

タブページが切り替わる前に呼び出される関数です。関数内では、タブページの非表示するときの処理を記述します。

引数

なし。

戻り値

切り替えに成功した場合は true、失敗した場合は false を返します。

unload() 関数を定義します。関数内では、タブページで変更した内容をメンバ変数に保存する処理を記述します。
PageControl.prototype.unload = PageControl_unload;
function PageControl_unload()
{
var textColor = findObject( "text" );
var bgColor = findObject( "bg" );
var linkColor = findObject( "link" );
this.text = textColor.value;
this.bgcolor = bgColor.value;
this.link = linkColor.value;
return true;
}


  PageControl.lastUnload ()
説明

タブページを終了するときに呼び出される関数です。関数内では、タブページで設定した内容を反映させるための処理を記述します。

引数

なし。

戻り値

正しく終了できた場合は true、終了できなかった場合は false を返します。

lastUnload() 関数を定義します。関数内では、タブページで設定した色をドキュメントの BODY タグに設定します。
PageControl.prototype.lastUnload = PageControl_lastUnload;
function PageControl_lastUnload()
{
var doc = dw.getDocumentDOM( "document" );
doc.body.text = this.text;
doc.body.bgcolor = this.bgcolor;
doc.body.link = this.link;
return true;
}



TOP > Dreamweaver徹底活用 >