Dreamweaver API リファレンス

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

このファイルは、Dreamweaver をインストールしたフォルダ内にある Configuration/Shared/MM/Scripts/Class フォルダに保存されています。ファイルには、レイヤーを利用したタブページを管理する TabControl クラスが記述されています。TabControl クラスは、PageControl クラスと一緒に使用します。

  TabControl ()
説明

タブページを管理する TabControl クラスを初期化します。

引数

thePrefix
タブページにするレイヤーの名前を指定します。 レイヤーは、"名前" + 数字 の形式で名前を付けている必要があり、この形式になっているレイヤーはすべて TabControl クラスによって管理されるようになります。この引数を指定しない場合は、名前に "Tab" を使用します。

戻り値

なし。

TabControl クラスを初期化します。
var tabPages = new TabControl();


  TabControl.getPageNum ()
説明

指定した名前をもつタブページの位置を取得します。

引数

thePageName
位置を取得するタブページの名前を指定します。

戻り値

タブページの位置を返します。見つからなかった場合は、-1 を返します。

タブページを生成し、その中にある "Tab1" レイヤーの位置を取得します。
var tabPages = new TabControl();
var tab1 = new PageControl( "Tab1" );
var tab2 = new PageControl( "Tab2" );
tabPages.addPage( "Tab1", tab1 );
tabPages.addPage( "Tab2", tab2 );
alert( "Tab1 の位置: " + tabPages.getPageNum( "Tab1" ) );


  TabControl.start ()
説明

タブページの状態を初期化し、指定したページ番号のタブページを表示します。

引数

startPage
表示するタブページの位置を指定します。この引数を指定しない場合は、最初に位置にあるタブページが表示されます。

戻り値

なし。

タブページを生成し、タブページの状態を初期化します。
var tabPages = new TabControl();
var tab1 = new PageControl( "Tab1" );
var tab2 = new PageControl( "Tab2" );
tabPages.addPage( "Tab1", tab1 );
tabPages.addPage( "Tab2", tab2 );
tabPages.start();


  TabControl.finish ()
説明

タブページを終了します。タブページに設定されている PageControl クラスに lastUnload イベントを発行します。

引数

なし。

戻り値

最後に表示していたタブページの名前を返します。

タブページを終了します。終了すると、TabControl クラスに設定した PageControl クラスの tab1, tab2 に lastUnload イベントを発行します。
var tabPages = new TabControl();

tabPages.finish();


  TabControl.addGroup ()
説明

タブページにグループを追加します。TabControl クラスは複数のタブページを管理することが出来ますが、同時に他のグループのタブページを使うことは出来ません。

引数

theGroupName, theGroupArray
theGroupName
グループにつける名前を指定します。
theGroupArray
グループで管理するタブページの名前のリストを指定します。

戻り値

グループを追加できた場合は true、追加できなかった場合は false を返します。

タブページにグループを追加します。
var tabPages = new TabControl();
var theGroupArray = new Array( "Tab1", "Tab2", "Tab3" );
tabPages.addGroup( "info", theGroupArray );


  TabControl.showGroup ()
説明

指定したグループのタブページを管理するように切り替えます。この関数を呼んだ後には、start() 関数を呼び出すようにして下さい。

引数

切り替えるグループの名前を指定します。

戻り値

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

タブグループを切り替えします。
var tabPages = new TabControl();
var TopGroupArray = new Array( "Side1", "Side2", "Side3" );
var SideGroupArray = new Array( "Top1", "Top2", "Top3" );
tabPages.addGroup( "top", TopGroupArray );
tabPages.addGroup( "side", SideGroupArray );
tabPages.showGroup( "top" );
tabPages.start();


  TabControl.addPage ()
説明

タブページを追加します。

引数

thePageName, thePageObject
thePageName
タブページにするレイヤーの名前を指定します。
thePageObject
タブページからのイベントを受け取る PageControl クラスのオブジェクトを指定します。この引数を省略すると、タブページからのイベントを受け取ることは出来ません。

戻り値

タブページを追加できた場合は true、追加できなかった場合は false を返します。

タブページを追加します。
var tabPages = new TabControl();
var tab1 = new PageControl( "Tab1" );
var tab2 = new PageControl( "Tab2" );
tabPages.addPage( "Tab1", tab1 );
tabPages.addPage( "Tab2", tab2 );


  TabControl.showPage ()
説明

アクティブなタブページを切り替えます。

引数

thePageName, dontUnloadCurPg
thePageName
切り替えるタブボタンの名前を指定します。
dontUnloadCurPg
タブページの切り替え時に Unload イベントを発生させるかどうか指定します。

戻り値

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

タブページを切り替えします。
var tabPages = new TabControl();

tabPages.showPage( "Tab1" );


  TabControl.showPageNum ()
説明

showPage() 関数と同じ機能ですが、この関数は名前ではなく位置で切り替えるタブページを指定します。

引数

pageNumber
切り替えるタブページの位置を指定します。

戻り値

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

タブページを切り替えします。
var tabPages = new TabControl();

tabPages.showPageNum( 0 );


  TabControl.nextPage ()
説明

次の位置にあるタブページに切り替えます。

引数

なし。

戻り値

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

次のタブページに切り替えます。
var tabPages = new TabControl();

tabPages.nextPage();


  TabControl.previousPage ()
説明

前の位置にあるタブページに切り替えます。

引数

なし。

戻り値

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

前のタブページに切り替えます。
var tabPages = new TabControl();

tabPages.previousPage();


  TabControl.refresh ()
説明

タブページを再表示します。

引数

なし。

戻り値

再表示できた場合は true、できなかった場合は false を返します。

タブページを再表示します。
var tabPages = new TabControl();

tabPages.refresh();


  TabControl.insertPage ()
説明

指定したタブページの後にタブページを挿入します。

引数

thePageName, insertBeforeName, allowDuplicate
thePageName
追加する位置のタブページの名前を指定します。
insertBeforeName
追加するタブページの名前を指定します。
allowDuplicate
追加するタブページの名前方のタブページの名前との重複を許可する場合は true、許可しない場合は false を指定します。

戻り値

追加できた場合は true、できなかった場合は false を返します。

タブページを挿入します。
var tabPages = new TabControl();

tabPages.insertPage( "Tab1", "Tab12", false );


  TabControl.removePage ()
説明

タブページを削除します。

引数

削除するタブページの名前を指定します。

戻り値

削除できた場合は true、できなかった場合は false を返します。

タブページを削除します。
var tabPages = new TabControl();

tabPages.removePage( "Tab1" );


  TabControl.update ()
説明

現在アクティブであるタブページに update イベントを発行します。

引数

theItemName
update イベントに渡す値を指定します。

戻り値

なし。

update イベントを発行します。update イベントを発行すると、タブページに設定した PageControl クラス内の update() 関数が呼び出されます。
var tabPages = new TabControl();
var tab1 = new PageControl( "Tab1" );
var tab2 = new PageControl( "Tab2" );
tabPages.addPage( "Tab1", tab1 );
tabPages.addPage( "Tab2", tab2 );
tabPages,start();
tabPages.update( 1001 );



TOP > Dreamweaver徹底活用 >