YKLook説明書 クラス解説 YKLookSwingBase 機能別   ABC
ページ内リンク一覧   スーパークラス   クラスメソッド   インスタンスメソッド   その他の項目  

YKLookSwingBase


YKLook のすべてのGUIオブジェクトのスーパークラスです。




クラスメソッド:   new   yk_find_objects   yk_find_objects   yk_find_objects   yk_find_objects_frame   yk_look   yk_look   yk_look_frame
インスタンスメソッド:   yk_get_property   yk_put_property   yk_set_tag   yk_tag   yk_tagname   yk_tagno   yk_var
その他の項目: なし


 Object (Ruby 組み込みのクラス。すべてのオブジェクトのスーパークラス)
   ┃
   ┗ YKLookSwingBase (このクラス)


new()  

インスタンスを生成します。
タグ名は nil に、タグ番号は 0 になります。




呼び出し形式[1]
yk_find_objects()

このクラスのGUIオブジェクトをすべて返します。
このメソッドの戻り値は常に配列で、配列の要素がGUIオブジェクトです。
GUIオブジェクトがないときは、要素数が0の空の配列を返します。

このメソッドを使うときは、 YKLookSwingBase.yk_find_objects() という使い方はしません。
例えば、 YKLookLabel.yk_find_objects() というふうに、実際のGUIオブジェクトのクラスメソッドとして使います。
これにより、そのGUIクラスのオブジェクトだけを処理の対象としています。

YKLookMain クラスには、すべてのGUIクラスを対象とした同じ名前のメソッド YKLookMain.yk_find_objects() YKLookMain#yk_find_objects() があります。




呼び出し形式[2]
yk_find_objects( tagname )

このクラスのGUIオブジェクトの中から、引数で指定されたタグ名に一致するものを返します。
このメソッドの戻り値は常に配列で、配列の要素がGUIオブジェクトです。
一致するものがないときは、要素数が0の空の配列を返します。

引数のタグ名は文字列または正規表現または nil です。
引数のタグ名が nil のときは、このクラスのすべてのGUIオブジェクトを返します。

このメソッドを使うときは、 YKLookSwingBase.yk_find_objects( tag ) という使い方はしません。
例えば、 YKLookLabel.yk_find_objects( tag ) というふうに、実際のGUIオブジェクトのクラスメソッドとして使います。
これにより、そのGUIクラスのオブジェクトだけを処理の対象としています。

YKLookMain クラスには、すべてのGUIクラスを対象とした同じ名前のメソッド YKLookMain.yk_find_objects() YKLookMain#yk_find_objects() があります。

各GUIオブジェクトにタグを付けるには yk_set_tag() を使ってください。




呼び出し形式[3]
yk_find_objects( tagname , tagno )

このクラスのGUIオブジェクトの中から、引数で指定されたタグ名とタグ番号に一致するものを返します。
このメソッドの戻り値は常に配列で、配列の要素がGUIオブジェクトです。
一致するものがないときは、要素数が0の空の配列を返します。

引数のタグ名は文字列または正規表現または nil です。
引数のタグ番号は数値または nil です。
引数のタグ名が nil のときは、タグ番号が一致するかどうかだけを見ます。
引数のタグ番号が nil のときは、タグ名が一致するかどうかだけを見ます。
ふたつの引数がどちらも nil のときは、このクラスについてのすべてのGUIオブジェクトを返します。

このメソッドを使うときは、 YKLookSwingBase.yk_find_objects() という使い方はしません。
例えば、 YKLookLabel.yk_find_objects() というふうに、実際のGUIオブジェクトのクラスメソッドとして使います。
これにより、そのGUIクラスのオブジェクトだけを処理の対象としています。

YKLookMain クラスには、すべてのGUIクラスを対象とした同じ名前のメソッド YKLookMain.yk_find_objects() YKLookMain#yk_find_objects() があります。

各GUIオブジェクトにタグを付けるには yk_set_tag() を使ってください。




yk_find_objects_frame( frame )  
yk_find_objects_frame( frame , tagname )
yk_find_objects_frame( frame , tagname , tagno )

機能は yk_find_objects() に似ていますが、引数の frame で指定されたウインドウ内のGUIオブジェクトのみを対象とします。
引数 frame には、 YKLookMain または YKLookMainFrame の派生クラスのインスタンスオブジェクトを指定します。
通常は、以下の例のように self を使います。

例1
gui = YKLookButton.yk_find_objects_frame( self )
この例では、 YKLookMain または YKLookMainFrame の派生クラス内のメソッドからの呼び出し方法を示しています。

例2
gui = YKLookCheckBox.yk_find_objects_frame( YKLookMain.yk_main() )
この例では、メインウインドウ内のチェックボックスを見つけます。

このメソッドを使うには、以下のように swingframe をロードする必要があります。
必ず swing の後に記述してください。

処理
require 'yklook/swing'
require 'yklook/swingframe'




呼び出し形式[1]
yk_look( tagname )

このクラスのオブジェクトの中から、引数で指定されたタグ名に一致するものを返します。
一致するものが複数あるときは、最初に見つけたものを返します。
一致するものがないときは、 nil を返します。
引数のタグ名は文字列または正規表現です。

このメソッドを使うときは、 YKLookSwingBase.yk_look( name ) という使い方はしません。
例えば、 YKLookLabel.yk_look( name ) というふうに、実際のGUIオブジェクトのクラスメソッドとして使います。
これにより、そのGUIクラスのオブジェクトだけを処理の対象としています。

YKLookMain クラスには、すべてのGUIクラスを対象とした同じ名前のメソッド YKLookMain.yk_look() YKLookMain#yk_look() があります。

各GUIオブジェクトにタグを付けるには yk_set_tag() を使ってください。




呼び出し形式[2]
yk_look( tagname , tagno )

このクラスのオブジェクトの中から、引数で指定されたタグ名とタグ番号に一致するものを返します。
一致するものが複数あるときは、最初に見つけたものを返します。
一致するものがないときは、 nil を返します。

引数のタグ名は文字列または正規表現または nil です。
引数のタグ番号は数値または nil です。
引数のタグ名が nil のときは、タグ番号が一致するかどうかだけを見ます。
引数のタグ番号が nil のときは、タグ名が一致するかどうかだけを見ます。

このメソッドを使うときは、 YKLookSwingBase.yk_look( name , no ) という使い方はしません。
例えば、 YKLookLabel.yk_look( name , no ) というふうに、実際のGUIオブジェクトのクラスメソッドとして使います。
これにより、そのGUIクラスのオブジェクトだけを処理の対象としています。

YKLookMain クラスには、すべてのGUIクラスを対象とした同じ名前のメソッド YKLookMain.yk_look() YKLookMain#yk_look() があります。

各GUIオブジェクトにタグを付けるには yk_set_tag() を使ってください。




yk_look_frame( frame , tagname )  
yk_look_frame( frame , tagname , tagno )

機能は yk_look() に似ていますが、引数の frame で指定されたウインドウ内のGUIオブジェクトのみを対象とします。
引数 frame には、 YKLookMain または YKLookMainFrame の派生クラスのインスタンスオブジェクトを指定します。
通常は、以下の例のように self を使います。

例1
gui = YKLookButton.yk_look_frame( self, 'apple' )
この例では、 YKLookMain または YKLookMainFrame の派生クラス内のメソッドからの呼び出し方法を示しています。

例2
gui = YKLookCheckBox.yk_look_frame( YKLookMain.yk_main(), 'apple' )
この例では、メインウインドウ内のチェックボックスのうちタグ名が 'apple' のものを見つけます。

このメソッドを使うには、以下のように swingframe をロードする必要があります。
必ず swing の後に記述してください。

処理
require 'yklook/swing'
require 'yklook/swingframe'



yk_get_property( key )  

self が保持している属性(プロパティ)の中から、指定されたキーに対応する値を返します。
引数を省略するか nil を指定すると、すべてのキーの配列を返します。




yk_put_property( key , value )  

指定されたキーとそれに対応する値を属性(プロパティ)として self 内に保持します。
キーは文字列で、先頭が 'yk' 以外であれば任意です。
値は下記のいずれかのクラスに限ります。
Array の要素や、 Hash のキーと値も、上記のクラスに限ります。
その範囲内であれば Array Hash を入れ子にしたり組み合わせることもできます。
厳密には、 Ruby の組み込み Marshal 機能でシリアライズが可能なオブジェクトである限り、指定することができます。

このメソッドは、プログラム製作者の便宜をはかるために用意しています。
コンピュータ画面に表示する内容には全く影響ありません。




yk_set_tag( tagname )  
yk_set_tag( tagname , tagno )

タグ名とタグ番号を指定します。
引数の tagname はタグ名で、文字列または nil を指定してください。
タグ名の先頭が 'yk' で始まっているものは指定できません。

引数の tagno はタグ番号で、整数を指定してください。
省略したときは 0 とみなします。
このメソッドの戻り値は、 self です。

このメソッドは、プログラム製作者の便宜をはかるために用意しています。
コンピュータ画面に表示する内容には全く影響ありません。




yk_tag()  

タグ名とタグ番号を要素とする配列を返します。

ary = obj.yk_tag()
tagname = ary[0]
tagno   = ary[1]




yk_tagname()  

タグ名を返します。
戻り値は nil または文字列です。
デフォルトのタグ名は nil になります。




yk_tagno()  

タグ番号を返します。
戻り値は整数です。
デフォルトのタグ番号は 0 になります。




yk_var( name )  

self を値として持つインスタンス変数を YKLookMain クラスまたは YKLookMainFrame クラスに作り、その変数名を、このメソッドの引数で指定された名前にします。
このインスタンス変数は、セッション管理対象になります。

注意: self オブジェクトに対してインスタンス変数を作るのではなく、 YKLookMain クラスまたは YKLookMainFrame クラス(実際にはプログラム製作者のサブクラス)のオブジェクトに対してインスタンス変数を作ります。

このメソッドで指定できるインスタンス変数の名前には、以下の制約があります。
良い例
yk_var( '@abc' )  # OK
yk_var( '@kyx'  ) # OK
yk_var( '@yjx'  ) # OK
悪い例
yk_var( 'abc'   ) # NG 先頭が @ でない
yk_var( '@@abc' ) # NG クラス変数になっている
yk_var( '@ykx'  ) # NG 先頭の3文字が @yk になっている

このメソッドの戻り値は、 self です。
YKLookMain#yk_var() YKLookMainFrame#yk_var() の説明も参考にしてください。



なし



ページ内リンク一覧   スーパークラス   クラスメソッド   インスタンスメソッド   その他の項目  
YKLook説明書 クラス解説 YKLookSwingBase 機能別   ABC


Copyright (c) 2003-2010 YorozuKotowariYa Ltd.