YKLookList
リストです。
クラスメソッド：
new
yk_find_objects
yk_find_objects_frame
yk_look
yk_look_frame
インスタンスメソッド：
yk_add_item
yk_add_item
yk_remove_at_item
yk_remove_at_index
yk_replace_item
yk_scroll_to_index
yk_scroll_to_item
yk_select_none
yk_selected_index
yk_selected_item
yk_set_item
yk_set_listener
yk_set_listener
yk_set_row
yk_set_select_mode
yk_set_selected_index
yk_set_selected_item
その他の項目：
なし
Object （Ruby 組み込みのクラス。すべてのオブジェクトのスーパークラス）
┃
┗ YKLookSwingBase （YKLook のすべてのＧＵＩオブジェクトの共通クラス）
┃
┗ YKLookCompoent （YKLook のＧＵＩ表示部品の共通クラス）
┃
┗ YKLookList （このクラス）
new()
new( array )
yk_find_objects()
yk_find_objects( tagname )
yk_find_objects( tagname , tagno )
yk_find_objects_frame( frame )
yk_find_objects_frame( frame , tagname )
yk_find_objects_frame( frame , tagname , tagno )
yk_look( tagname )
yk_look( tagname , tagno )
yk_look_frame( frame , tagname )
yk_look_frame( frame , tagname , tagno )
呼び出し形式[1]
yk_add_item( obj )
呼び出し形式[2]
yk_add_item( obj , index )
引数のオブジェクトを選択肢の任意の位置に追加します。
指定可能なオブジェクトのクラスは、
yk_set_item() と同じです。
２番目の引数
index は
0 以上の整数で追加する位置を指定します。
yk_remove_at_item( obj )
引数のオブジェクトを選択肢から削除します。
yk_remove_at_index( index )
引数のインデックスに対応するオブジェクトを選択肢から削除します。
インデックスは 0 以上の整数です。
yk_replace_item( obj , index )
選択肢の任意の位置のオブジェクトを入れ替えます。
指定可能なオブジェクトのクラスは、
yk_set_item() と同じです。
２番目の引数
index は
0 以上の整数で入れ替える位置を指定します。
yk_scroll_to_index( index )
引数のインデックスに対応するオブジェクトが表示領域内に現れるようにリストをスクロールします。
インデックスは 0 以上の整数です。
yk_scroll_to_item( obj )
引数のオブジェクトが表示領域内に現れるようにリストをスクロールします。
yk_select_none()
リストのすべての選択肢を、非選択状態にします。
このメソッドを呼び出した時点では、表示中の画面の状態は変わりません。
メインループに戻った時に画面の表示を更新しています。
yk_selected_index()
選択状態のインデックスを返します。
複数選択していることもあるので、このメソッドの戻り値は配列です。
配列の各要素は整数で、これがインデックスを示します。
何も選択されていないときは、空の配列を返します。
このメソッドは、実際に表示している画面上の状態を返します。
一度も画面を表示していないときは、有効な値を返しません。
yk_selected_item()
選択状態のオブジェクトを返します。
複数選択していることもあるので、このメソッドの戻り値は配列です。
配列の各要素がオブジェクトを示します。
何も選択されていないときは、空の配列を返します。
このメソッドは、実際に表示している画面上の状態を返します。
一度も画面を表示していないときは、有効な値を返しません。
yk_set_item( array )
引数のオブジェクトを選択肢のリストとします。
引数は常に配列の形で指定してください。
配列内の各要素を、その順番どおりに選択肢のリストとします。
要素オブジェクトに指定できるのは以下のクラスのオブジェクトです。
文字列として、
YKLookLabel#yk_set_text() と同じように
HTML 風の指定もできます。
呼び出し形式[1]
yk_set_listener( method_name )
リストがクリックされたときのコールバック用メソッドを文字列またはシンボルで指定します。
nil を指定すると、コールバック用メソッドを未指定にします。
名前の先頭が
'yk' で始まるものは指定できません。
コールバック用のメソッドは、プログラム製作者が
YKLookMain や
YKLookMainFrame のサブクラスに定義する必要があります。
コールバック用のメソッドには引数がひとつあり、
YKLookEventListClick クラスのオブジェクトです。
実際にコールバックするのはリストがクリックされたときで、なおかつこのときに選択状態になっているものがひとつだけのときです。
呼び出し形式[2]
yk_set_listener( method_name , click )
引数の
click は整数で
1 または
2 を指定し、以下のようになります。
-
1 のとき、マウスのシングルクリックでコールバックする。
-
2 のとき、マウスのダブルクリックでコールバックする。
デフォルトは
1 です。
| 補足： |
このメソッドで指定するクリック回数は、あくまでもコールバックをするためのものです。リストの各項目を選択状態にする操作とは何の関係もありません。
|
yk_set_row( row )
リスト表示時の最大表示行数を指定します。
これは、スクロールせずに表示できる行数の指定です。
選択肢の個数とは関係ありません。
yk_set_select_mode( sel )
選択形式を指定します。
引数は文字列で、以下のようになります。
| 指定 |
意味 |
| 'single' |
ひとつの項目のみ選択可能。
|
| 'interval' |
連続した項目であれば複数選択も可能。
|
| 'multiple' |
離れた項目でも複数選択が可能。
|
英字の大文字小文字は、どちらでも受け付けます。
YKLook の内部では、文字列の先頭１文字だけを見ています。
上記のいずれでもないときは、デフォルトの設定になります。
デフォルトでは
'multiple' です。
yk_set_selected_index( index )
引数のインデックスに対応するオブジェクトを選択状態にします。
インデックスは
0 以上の整数です。
引数をインデックスの配列にすると、複数のインデックスを指定できます。
| 良い例 |
yk_set_selected_index( 2 ) # OK
yk_set_selected_index( [2, 3] ) # OK
|
| 悪い例 |
yk_set_selected_index( 2, 3 ) # NG
|
このメソッドを呼び出した時点では、表示中の画面の状態は変わりません。
メインループに戻った時に画面の表示を更新しています。
選択形式を、
yk_set_select_mode() にて変更している場合、その形式によっては複数選択できません。
yk_set_selected_item( obj )
引数のオブジェクトを選択状態にします。
引数をオブジェクトの配列にすると、複数のオブジェクトを指定できます。
| 良い例 |
yk_set_selected_item( obj ) # OK
yk_set_selected_item( [obj1, obj2] ) # OK
|
| 悪い例 |
yk_set_selected_item( obj1, obj2 ) # NG
|
このメソッドを呼び出した時点では、表示中の画面の状態は変わりません。
メインループに戻った時に画面の表示を更新しています。
選択形式を、
yk_set_select_mode() にて変更している場合、その形式によっては複数選択できません。
なし
Copyright (c) 2003-2010 YorozuKotowariYa Ltd.