Dreamweaver API リファレンス

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

このファイルは、Dreamweaver をインストールしたフォルダ内にある Configuration/Shared/MM/Scripts/Class フォルダに保存されています。ファイルには、リストボックスの管理を行う ListControl クラスが記述されています。

  ListControl ()
説明

リストボックスの管理を行う ListControl クラスを初期化します。

引数

selName
ListControl クラスで管理するリストボックスの名前を指定します。
layerObj
管理するリストボックスが挿入されているオブジェクトを指定します。この引数を指定しない場合は、"document" オブジェクトから検索します。

戻り値

なし。

ListControl クラスを初期化します。
var list = new ListControl( "menulist" );


  ListControl.setAll ()
説明

リストボックスの項目を設定します。

引数

newList, newValueList
newList
リストボックスに追加する項目のテキストのリストを指定します。
newValueList
リストボックスの項目のvalue 属性に設定する値のリストを指定します。この引数を省略すると、value 属性には項目名と同じ内容が設定されます。

戻り値

項目の設定に成功した場合は true、失敗した場合は false を返します。

リストボックスに項目を設定します。
var nameList = new Array( "name1", "name2", "name3" );
var valueList = new Array( "value1", "value2", "value3" );
var list = new ListControl( "menulist" );
list.setAll( nameList, valueList );


  ListControl.add ()
説明

リストボックスの現在選択している項目の下に項目を追加します。

引数

newItemStr, newValueStr
newItemStr
リストボックスに追加する項目のテキストの内容を指定します。この引数は省略することが出来ます。
newValueStr
リストボックスに追加する項目の value 属性の属性値を指定します。この引数は省略することが出来ます。

戻り値

項目の追加に成功した場合は true、失敗した場合は false を返します。

リストボックスに 空の項目を2つ追加し、"name1", "name2" の項目を追加します。"name2" には "value2" の value 属性を設定します。リストボックスの項目は、"","","name1","name2" の順番になります。
var list = new ListControl( "menulist" );
list.add();
list.add();
list.add( "name1" );
list.add( "name2", "value2" );


  ListControl.append ()
説明

リストボックスの項目の最後に項目を追加します。

引数

newItemStr, newValueStr
newItemStr
リストボックスに追加する項目のテキストの内容を指定します。この引数は省略することが出来ます。
newValueStr
リストボックスに追加する項目の value 属性の属性値を指定します。この引数は省略することが出来ます。

戻り値

項目の追加に成功した場合は true、失敗した場合は false を返します。

リストボックスに 空の項目を2つ追加し、"name1", "name2" の項目を追加します。"name2" には "value2" の value 属性を設定します。リストボックスの項目は、"","","name1","name2" の順番になります。
var list = new ListControl( "menulist" );
list.add();
list.append();
list.add( "name1" );
list.append( "name2", "value2" );


  ListControl.del ()
説明

現在選択しているリストボックスの項目を削除します。

引数

なし。

戻り値

削除に成功した場合は true、失敗した場合は false を返します。

リストボックスの項目を削除します。リストボックスの項目は、"","","name2" の順番になります。
var list = new ListControl( "menulist" );
list.add();
list.append();
list.add( "name1" );
list.del();
list.append( "name2", "value2" );


  ListControl.set ()
説明

リストボックスの項目のテキストを変更します。

引数

newItemStr, itemNum
newItemStr
変更する項目のテキストの内容を指定します。
itemNum
変更する項目の位置を指定します。この引数を指定しない場合は、現在選択されている項目のテキストを変更します。

戻り値

変更に成功した場合は true、失敗した場合は false を返します。

リストボックスの項目を変更します。リストボックスの項目は、"name3","","name1" の順番になります。
var list = new ListControl( "menulist" );
list.add();
list.append();
list.add( "name1" );
list.set( "name3", 0 );


  ListControl.setValue ()
説明

リストボックスの項目のvalue 属性を変更します。

引数

newValueStr, itemNum
newValueStr
変更する項目のvalue 属性の属性値を指定します。
itemNum
変更する項目の位置を指定します。この引数を指定しない場合は、現在選択されている項目のテキストを変更します。

戻り値

変更に成功した場合は true、失敗した場合は false を返します。

リストボックスの項目の value 属性を変更します。リストボックスの項目は、"","","name1" の順番になります。項目の1番目の value 属性には "value3" が設定されます。
var list = new ListControl( "menulist" );
list.add();
list.append();
list.add( "name1" );
list.setValue( "value3", 0 );


  ListControl.get ()
説明

指定したリストボックスの項目のテキストを取得します。

引数

optIndex
取得する項目の位置を指定します。引数を指定しない場合は、現在選択している項目になります。"all"とするとすべてのリストボックスの項目を取得します。

戻り値

指定した項目のテキストを返します。

一番上のある項目のテキストを取得します。
var list = new ListControl( "menulist" );
list.add( "name1" );
list.add();
list.add();
list.add( "name2" );
alert( list.get( 0 ) );


  ListControl.getValue ()
説明

指定したリストボックスの項目の value 属性の属性値を取得します。

引数

optIndex
取得する項目の位置を指定します。引数を指定しない場合は、現在選択している項目になります。"all"とするとすべてのリストボックスの項目を取得します。

戻り値

指定した項目のvalue 属性の属性値を返します。

現在選択している項目の value 属性の属性値を取得します。
var list = new ListControl( "menulist" );
list.add( "name1" );
list.add();
list.add();
list.add( "name2" );
alert( list.getValue() );


  ListControl.setIndex ()
説明

リストボックスの選択位置を変更します。

引数

変更するリストボックスの位置を指定します。

戻り値

位置の変更に成功した場合は true、失敗した場合は false を返します。

現在選択位置を一番上に変更します。
var list = new ListControl( "menulist" );
list.add( "name1" );
list.add();
list.add();
list.add( "name2" );
list.setIndex( 0 );


  ListControl.pickValue ()
説明

指定した値を value 属性に持つリストボックスの項目を調べ、見つかった場合は、その項目を選択状態にします。

引数

調べる属性値を指定します。

戻り値

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

"value2" をvalue 属性に持つリストボックスの項目を調べます。
var list = new ListControl( "menulist" );
list.add( "name1", "value1" );
list.add( "name2", "value2" );
list.add( "name3", "value3" );
list.add( "name4", "value4" );
if( list.pickValue( "value2" ) )
alert( "見つかりました" );


  ListControl.getIndex ()
説明

現在選択されているリストボックスの項目の位置を取得します。

引数

なし。

戻り値

現在選択されているリストボックスの項目の位置を返します。-1 が返った場合は何も選択されていない状態となります。

現在の選択位置を取得します。
var nameList = new Array( "name1", "name2", "name3" );
var valueList = new Array( "value1", "value2", "value3" );
var list = new ListControl( "menulist" );
list.setAll( nameList, valueList );
alert( "現在選択している位置:" + list.getIndex() );


  ListControl.getLen ()
説明

リストボックスの項目の数を取得します。

引数

なし。

戻り値

リストボックスの項目の数を返します。

リストボックスの項目の数を取得します。
var nameList = new Array( "name1", "name2", "name3" );
var valueList = new Array( "value1", "value2", "value3" );
var list = new ListControl( "menulist" );
list.setAll( nameList, valueList );
alert( "リストボックスの項目の数:" + list.getLen() );


  ListControl.refresh ()
説明

現在選択されている位置の更新を行います。ListControl クラスのプロパティ index に現在の選択位置が設定されます。

引数

なし。

戻り値

なし。

リストボックスの選択位置を更新します。
var nameList = new Array( "name1", "name2", "name3" );
var valueList = new Array( "value1", "value2", "value3" );
var list = new ListControl( "menulist" );
list.setAll( nameList, valueList );
list.refresh();



TOP > Dreamweaver徹底活用 >