Dreamweaver API リファレンス

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

このファイルは、Dreamweaver をインストールしたフォルダ内にある Configuration/Shared/MM/Scripts/Common フォルダに保存されています。ファイルには、ビヘイビアの作成を補助するための関数が用意されています。

  getRootNode ()
説明

現在編集しているページの DOM オブジェクトツリー内で一番上にあるオブジェクトを取得します。

引数

なし

戻り値

DOM オブジェクトツリー内で一番上にあるオブジェクトを返します。

HTMLの内容を表示します。
var obj = getRootNode();
alert( obj.outerHTML );


  findTag ()
説明

指定したタグがページ中に含まれているかどうか調べます。

引数

tagName, startNode
tagName
調べたいタグ名(たとえば "IMG"、"FORM"、"HR" など)を指定します。
startNode
検索範囲に設定するオブジェクトを指定します。この引数が指定されない場合は、ページ全体から検索します。

戻り値

見つかった場合には、そのタグのオブジェクトを返し、見つからなかった場合は null を返します。

IMG タグを検索し、見つかったタグの内容を表示します。
var theDOM = dw.getDocumentDOM( "document" );
var obj = findTag( "IMG", theDOM.documentElement );
if( obj != null )
{
var selArray = theDOM.nodeToOffsets( obj );
var outerHTML = theDOM.documentElement.outerHTML;
alert( outerHTML.substring( selArray[ 0 ], selArray[ 1 ] ) );
}


  traverse ()
説明

引数で指定したオブジェクト内を検索し、オブジェクトの種類別に引数で指定した関数を呼び出します。

引数

node, fElementHandler,fTextHandler, fCommentHandler, userData
node
検索するオブジェクトを指定します。この引数が null の場合は、現在編集中のページのオブジェクトが使用されます。
fElementHandler
HTML オブジェクトが見つかったときに呼び出す関数を指定します。引数には、見つかったオブジェクトが設定されます。
fTextHandler
テキストオブジェクトが見つかったときに呼び出す関数を指定します。引数には、見つかったオブジェクトが設定されます。この引数は省略することが出来ます。
fCommentHandler
コメントオブジェクトが見つかったときに呼び出す関数を指定します。引数には、見つかったオブジェクトが設定されます。この引数は省略することが出来ます。
userData
関数を呼び出すときに、引数として追加する値を指定します。この引数は省略することが出来ます。

戻り値

なし

ページ内を検索し、テキストオブジェクトが見つかった場合にその内容を新規ドキュメントに追加します。
var theDOM = dw.createDocument();
traverse( null, null, null, TextAdd, theDOM );
function TextAdd( obj, usrdata )
{
usrdata.body.innerHTML += obj.text + "<br>\n";
}


  isInsideTag ()
説明

指定したオブジェクトを含んでいるタグをすべて調べ、見つかったタグが指定したタグのリスト内に存在するかどうかを返します。

引数

tag, tagNames
tag
検索するオブジェクトを指定します。
tagNames
調べるタグの種類を指定します。複数のタグを指定する場合は、カンマ区切りで指定します。

戻り値

見つかった場合は true、見つからなかった場合は false を返します。

現在選択しているオブジェクトにリンクされているかどうか調べます。
var theDOM = dw.getDocumentDOM();
var obj = theDOM.getSelectedNode();
if( isInsideTag( obj, "A" ) )
alert( "リンクが設定されています" );
//Popups up a command. Before popping it up, updates globals. Command can then
//use these globals to get and receive arguments from the caller.


  callCommand ()
説明

指定したコマンドを呼び出し、実行結果を返します。

引数

cmdName,argObject
cmdName
呼び出すコマンドのファイル名を指定します。呼び出すコマンドファイルは、MM.commandArgument で引数を取得し、MM.commandReturnValue に結果を返すように記述されていなければ、意味がありません。
argObject
コマンドに渡す引数を指定します。

戻り値

呼び出したコマンドの結果を返します。

「ロールオーバーイメージの挿入」のコマンドファイルを呼び出し、結果を取得します。
var rolloverTag = callCommand("Rollover.htm");


  updateBehaviorFns ()
説明

ページ中に設定されているビヘイビアのバージョンを調べ、バージョンが低い場合はそのビヘイビアを更新します。

引数

{behNames1}, {behNames2},...{behNamesN}
更新したいビヘイビアの名前を指定します。複数のビヘイビアを指定する場合には、引数を追加します。

戻り値

更新した場合に true、更新しなかった場合には false を返します。

MM_findObj", "MM_swapImage", "MM_swapImgRestore" の3つのビヘイビアのバージョンを調べ、ビヘイビアを更新します。 updateBehaviorFns("MM_findObj","MM_swapImage","MM_swapImgRestore");


  getFunctionVersion ()
説明

ページ内に記述されている関数のバージョンを調べます。

引数

fnName, dom
fnName
バージョンを調べる関数名を指定します。指定出来る関数は、下のように記述されている必要があります。
function myFunction() { //v2.0
この場合は 2 を戻り値として返します。このように記述されていない場合は 0 を返します。
dom
バージョンを調べるページの DOM オブジェクトを指定します。この引数が指定されない場合は、現在編集中のページが対象となります。

戻り値

見つかった関数のバージョンを返します。見つからなかった場合は -1 が返されます。

ページに記述されている MM_swapImage() 関数のバージョンを調べます。
var version = getFunctionVersion( "MM_swapImage" );
deleteFunction

説明

ページ内から指定した関数の記述を削除します。

引数

fnName, dom
fnName
削除する関数名を指定します。
dom
関数を削除するページの DOM オブジェクトを指定します。この引数が指定されない場合は、現在編集中のページが対象となります。

戻り値

削除した場合は、削除した関数の記述内容を返します。削除しなかった場合は false を返します。

ページ内から、MM_swapImage() 関数の記述を削除します。
deleteFunction( "MM_swapImage" );


  deleteFunctionCall ()
説明

ページ内から指定した関数が呼び出されている部分を削除します。

引数

fnName, dom
fnName
削除する関数名を指定します。
dom
関数を削除するページの DOM オブジェクトを指定します。この引数が指定されない場合は、現在編集中のページが対象となります。

戻り値

削除した場合は、削除した関数の呼び出し部の記述内容を返します。削除しなかった場合は false を返します。

ページ内から、MM_swapImage() 関数の記述を削除し、呼び出している部分をすべて削除します。
deleteFunction( "MM_swapImage" );
while( deleteFunctionCall( "MM_swapImage" ) );


  hasFunctionCall ()
説明

ページ内で指定した関数が呼び出されているかどうか調べます。

引数

fnName, dom
fnName
調べる関数名を指定します。
dom
関数の呼び出しを調べるページの DOM オブジェクトを指定します。この引数が指定されない場合は、現在編集中のページが対象となります。

戻り値

関数が呼び出されている部分が見つかった場合は true、見つからなかった場合は false を返します。

ページ内から、MM_swapImage() 関数の記述を削除し、呼び出しているかどうか調べ、見つかった場合は呼び出している部分をすべて削除します。
deleteFunction( "MM_swapImage" );
if( hasFunctionCall( "MM_swapImage" ) )
while( deleteFunctionCall( "MM_swapImage" ) );


  scriptIsEmpty ()
説明

指定したSCRIPTタグの内容が空かどうか調べます。

引数

aScript
SCRIPTタグの内容が格納された文字列を指定します

戻り値

SCRIPT タグ内が空である場合には true、空でない場合には false を返します。

ページ中に含まれる空の SCRIPT タグをすべて削除します。
var theDOM = dw.getDocumentDOM();
var allScripts = theDOM.getElementsByTagName( "SCRIPT" );
for( var i = 0; i < allScripts.length; i++ )
{
if( allScripts[ i ].hasChildNodes() )
{
aScript = allScripts[ i ].childNodes[ 0 ].data;
if( scriptIsEmpty( aScript ) )
{
allScripts[ i ].outerHTML = "";
}
}
}



TOP > Dreamweaver徹底活用 >