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

YKLookComponent


YKLook の多くのGUIオブジェクト共通のスーパークラスとして機能します。
具体的には、画面上に配置し一定の表示領域を持つようなGUI表示部品についての共通のスーパークラスになります。

補足: 画面上に一定の領域を占めるものの、このクラスを継承しないものは YKLookBoxFiller クラスだけです。




クラスメソッド: なし
インスタンスメソッド:   yk_back   yk_font   yk_fore   yk_is_enabled   yk_is_visible   yk_request_focus   yk_send_client_property   yk_set_alignment_x   yk_set_alignment_y   yk_set_back   yk_set_border   yk_set_border   yk_set_border   yk_set_cursor   yk_set_enabled   yk_set_font   yk_set_fore   yk_set_maximum_size   yk_set_maximum_size   yk_set_maximum_size   yk_set_minimum_size   yk_set_minimum_size   yk_set_minimum_size   yk_set_opaque   yk_set_preferred_size   yk_set_preferred_size   yk_set_preferred_size   yk_set_tooltip   yk_set_visible
その他の項目: なし


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


なし



yk_back()  

現在指定されている背景色を返します。
指定されていないときは、 nil を返します。
このメソッドの戻り値は yk_set_back() の引数をそのまま返します。
有効な戻り値を返すには、事前に yk_set_back() で背景色を指定している必要があります。




yk_font()  

現在指定されている YKLookFont オブジェクトを返します。
指定されていないときは、 nil を返します。
有効な戻り値を返すには、事前に yk_set_font() でフォントを指定している必要があります。




yk_fore()  

現在指定されている色(前景色)を返します。
指定されていないときは、 nil を返します。
このメソッドの戻り値は yk_set_fore() の引数をそのまま返します。
有効な戻り値を返すには、事前に yk_set_fore() で色(前景色)を指定している必要があります。




yk_is_enabled()  

有効・無効状態を返します。
戻り値が true のときは有効状態です。
戻り値が false のときは無効状態です。




yk_is_visible()  

表示・非表示状態を返します。
戻り値が true のときは表示状態です。
戻り値が false のときは非表示状態です。




yk_request_focus()  

このGUI表示部品にキーボードフォーカスを指定します。
GUI表示部品によっては指定できないものもあります。
また、状況によって効果がない場合もあります。




yk_send_client_property( key , value )  

画面上のGUI表示部品に対してプロパティを送信します。
引数の key および value に指定できるのは下記のクラスのオブジェクトです。

このメソッドに指定可能なキーと値はGUI表示部品ごとに決まっています。
また、OSに依存するものもあります。
それらを説明するのは YKLook の範囲を超えます。
詳細については Java Swing に関する資料をご覧ください。




yk_set_alignment_x( align )  

このGUIオブジェクトをパネル内に配置する際、パネルの大きさに余裕があり隙間が生じる場合に、このGUIオブジェクトの水平方向の位置を決めるためのヒント情報を指定します。
引数 align は、パーセント( 0 から 100 までの整数)または下記の文字列で指定します。
指定 意味
'LEFT' 左側に配置
'RIGHT' 右側に配置
'CENTER' 中央に配置
英字の大文字小文字はどちらでも受け付けます。また、 YKLook 内部では、指定された文字列の先頭の1文字だけを見ています。

gui.yk_set_alignment_x(   0 )  # 左側に置く
gui.yk_set_alignment_x(  50 )  # 中央に置く
gui.yk_set_alignment_x( 100 )  # 右側に置く
gui.yk_set_alignment_x( 'L' )  # 左側に置く
gui.yk_set_alignment_x( 'C' )  # 中央に置く
gui.yk_set_alignment_x( 'R' )  # 右側に置く




yk_set_alignment_y( align )  

このGUIオブジェクトをパネル内に配置する際、パネルの大きさに余裕があり隙間が生じる場合に、このGUIオブジェクトの垂直方向の位置を決めるためのヒント情報を指定します。
引数 align は、パーセント( 0 から 100 までの整数)または下記の文字列で指定します。
指定 意味
'TOP' 上側に配置
'BOTTOM' 下側に配置
'CENTER' 中央に配置
英字の大文字小文字はどちらでも受け付けます。また、 YKLook 内部では、指定された文字列の先頭の1文字だけを見ています。

gui.yk_set_alignment_y(   0 )  # 上側に置く
gui.yk_set_alignment_y(  50 )  # 中央に置く
gui.yk_set_alignment_y( 100 )  # 下側に置く
gui.yk_set_alignment_y( 'T' )  # 上側に置く
gui.yk_set_alignment_y( 'C' )  # 中央に置く
gui.yk_set_alignment_y( 'B' )  # 下側に置く




yk_set_back( color )  

背景色を指定します。
引数の指定方法は、色名での指定やRGB等いろいろあります。
YKLookColor.new() の引数と同じですので、そちらをご覧ください。
引数に nil を指定すると、画面上の階層構造に従います。

ラベル等いくつかのGUI表示部品は、背景色を指定しても実際の表示には反映されない場合があります。そのようなときは事前に yk_set_opaque() を使うと背景色が表示される可能性があります。




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

ボーダー(枠)を指定します。
おもにパネル類で使います。
ラベル YKLookLabel で使うこともあります。

panel.yk_set_border()
panel.yk_set_border( nil )
panel.yk_set_border( ['etched'] )
これらの例はいずれも同じ意味です。

このメソッドを使うときは、 swingborder をロードしてください。

require 'yklook/swing'
require 'yklook/swingborder'

注意: パネル以外のGUI表示部品にボーダー(枠)を指定した場合、OSによっては正しく表示されません。
ラベル YKLookLabel に指定するのは問題が少ないようです。




呼び出し形式[2]
yk_set_border( border )

ボーダー(枠)を指定します。
おもにパネル類で使います。
ラベル YKLookLabel で使うこともあります。

引数の border は、以下のいずれかになります。
nil を指定したときは、配列で ['etched'] を指定したものと同じです。

例1
bdr = YKLookBorder.new( ['line', 'red'] )
pan = YKLookPanelBox.new( 'H' )
pan.yk_set_border( bdr )

例2
pan = YKLookPanelBox.new( 'H' )
pan.yk_set_border( ['line', 'red'] )

このメソッドを使うときは、 swingborder をロードしてください。

require 'yklook/swing'
require 'yklook/swingborder'

注意: パネル以外のGUI表示部品にボーダー(枠)を指定した場合、OSによっては正しく表示されません。
ラベル YKLookLabel に指定するのは問題が少ないようです。




呼び出し形式[3]
yk_set_border( border , title )

ボーダー(枠)を指定し、そのボーダーにタイトル文字列を付加します。
おもにパネル類で使います。
ラベル YKLookLabel で使うこともあります。

pan = YKLookPanelBox.new( 'H' )
pan.yk_set_border( ['line', 'red'], 'title' )

引数 border の説明は、 yk_set_border( border ) をご覧ください。
引数 title の説明は YKLookBorderTitled.new() をご覧ください。
内部的には、以下の処理と同じです。

処理
b = YKLookBorderTitled.new( border, title )
yk_set_border( b )

このメソッドを使うときは、 swingborder をロードしてください。

require 'yklook/swing'
require 'yklook/swingborder'

注意: パネル以外のGUI表示部品にボーダー(枠)を指定した場合、OSによっては正しく表示されません。
ラベル YKLookLabel に指定するのは問題が少ないようです。




yk_set_cursor( cursor )  

マウスカーソルを指定します。
引数の cursor は、 YKLookCursor クラスのオブジェクトまたは文字列または nil を指定します。

文字列を指定したときは、内部的には以下の処理と同じです。
処理
c = YKLookCursor.new( 文字列 )
yk_set_cursor( c )

nil を指定したときは、画面上の階層構造に従ったデフォルトのカーソルになります。

カーソルを変更したはずなのに、実際には変更されていないときは、以下の原因が考えられます。




yk_set_enabled( bool )  

有効・無効状態を指定します。
引数が true のときは有効状態です。
引数が false のときは無効状態です。




yk_set_font( font )  

フォントを指定します。
引数の font は、 nil または YKLookFont オブジェクトを指定します。
nil のときは、画面上の階層構造に従います。




yk_set_fore( color )  

色(前景色)を指定します。
ラベルやボタンの場合には表示する文字列の色になります。
引数の指定方法は、色名での指定やRGB等いろいろあります。
YKLookColor.new() の引数と同じですので、そちらをご覧ください。
引数に nil を指定すると、画面上の階層構造に従います。




呼び出し形式[1]
yk_set_maximum_size( width , height )

最大サイズを指定します。
引数の width は左右の幅を整数で指定します。単位はピクセルです。
引数の height は上下の高さを整数で指定します。単位はピクセルです。




呼び出し形式[2]
yk_set_maximum_size( dim )

最大サイズを指定します。
引数の dim はふたつの整数を要素とする配列で、それぞれ幅と高さを示します。単位はピクセルです。




呼び出し形式[3]
yk_set_maximum_size( dim1 , dim2 )

最大サイズを指定します。
引数の説明は、 yk_set_minimum_size( dim1 , dim2 ) をご覧ください。




呼び出し形式[1]
yk_set_minimum_size( width , height )

最小サイズを指定します。
引数の width は左右の幅を整数で指定します。単位はピクセルです。
引数の height は上下の高さを整数で指定します。単位はピクセルです。




呼び出し形式[2]
yk_set_minimum_size( dim )

最小サイズを指定します。
引数の dim はふたつの整数を要素とする配列で、それぞれ幅と高さを示します。単位はピクセルです。




呼び出し形式[3]
yk_set_minimum_size( dim1 , dim2 )

最小サイズを指定します。
引数の dim1 はふたつの整数を要素とする配列で、それぞれ幅と高さを示します。単位はピクセルです。
dim1 の幅と高さのいずれかを nil にすることができます。
このとき、 nil でないほうの値だけを変更します。
引数の dim2 はふたつの整数を要素とする配列で、それぞれ幅と高さを示します。単位はピクセルです。
dim2 は、 dim1 の幅と高さのいずれかが nil のときだけ意味を持ちます。
nil にしたほうの値のデフォルト値として使います。




yk_set_opaque( bool )  

背景色の指定を有効にするか無効にするかを指定します。
引数の bool true を指定すると、有効にします。
引数の bool false を指定すると、無効にします。

デフォルト値はGUI表示部品の各クラスごとに標準的な値になっています。

このメソッドによる設定は絶対的なものではありません。
実際にどのような効果があるかはOSごとに異なる場合があります。




呼び出し形式[1]
yk_set_preferred_size( width , height )

推奨サイズを指定します。
引数の width は左右の幅を整数で指定します。単位はピクセルです。
引数の height は上下の高さを整数で指定します。単位はピクセルです。




呼び出し形式[2]
yk_set_preferred_size( dim )

推奨サイズを指定します。
引数の dim はふたつの整数を要素とする配列で、それぞれ幅と高さを示します。単位はピクセルです。




呼び出し形式[3]
yk_set_preferred_size( dim1 , dim2 )

推奨サイズを指定します。
引数の説明は、 yk_set_minimum_size( dim1 , dim2 ) をご覧ください。




yk_set_tooltip( text )  

ツールチップを文字列で指定します。
nil を指定すると、ツールチップを削除します。

ツールチップを変更したはずなのに、実際には変更されていないときは、以下の原因が考えられます。




yk_set_visible( bool )  

表示・非表示状態を返します。
引数が true のときは表示状態です。
引数が false のときは非表示状態です。



なし



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


Copyright (c) 2003-2010 YorozuKotowariYa Ltd.