javax.swing.plaf

クラス ComponentUI

java.lang.Object

javax.swing.plaf.ComponentUI

直系の既知のサブクラス:

ButtonUI, ColorChooserUI, ComboBoxUI, DesktopIconUI, DesktopPaneUI, FileChooserUI, InternalFrameUI, LabelUI, LayerUI, ListUI, MenuBarUI, OptionPaneUI, PanelUI, PopupMenuUI, ProgressBarUI, RootPaneUI, ScrollBarUI, ScrollPaneUI, SeparatorUI, SliderUI, SpinnerUI, SplitPaneUI, TabbedPaneUI, TableHeaderUI, TableUI, TextUI, ToolBarUI, ToolTipUI, TreeUI, ViewportUI

public abstract class ComponentUI
extends Object

Swing のプラグイン可能な Look & Feel アーキテクチャーに含まれるすべての UI 委譲オブジェクトの基底クラスです。Swing コンポーネントの UI 委譲オブジェクトは Look & Feel に依存するコンポーネントの側面の実装を扱います。JComponent クラスは、インストールした Look & Feel によって異なる可能性があるオペレーション (ペイント、レイアウトの計算など) を委譲するために、このクラスからメソッドを呼び出します。クライアントのプログラムは、直接このクラスのメソッドを呼び出すべきではありません。

関連項目:

JComponent, UIManager

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ComponentUI() 唯一のコンストラクタです。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
boolean	contains(JComponent c, int x, int y) 指定された x,y の位置が、指定されたコンポーネントの Look & Feel 定義の形状内にある場合は、true を返します。
static ComponentUI	createUI(JComponent c) 指定されたコンポーネントの UI 委譲のインスタンスを返します。
Accessible	getAccessibleChild(JComponent c, int i) オブジェクトの i 番目の Accessible の子を返します。
int	getAccessibleChildrenCount(JComponent c) オブジェクト内のアクセシビリティー対応の子の数を返します。
int	getBaseline(JComponent c, int width, int height) ベースラインを返します。
Component.BaselineResizeBehavior	getBaselineResizeBehavior(JComponent c) サイズの変化に合わせてコンポーネントのベースラインがどのように変化するかを示す列挙を返します。
Dimension	getMaximumSize(JComponent c) 指定されたコンポーネントの、Look & Feel に適した最大サイズを返します。
Dimension	getMinimumSize(JComponent c) 指定されたコンポーネントの、Look & Feel に適した最小サイズを返します。
Dimension	getPreferredSize(JComponent c) 指定されたコンポーネントの、Look & Feel に適した推奨サイズを返します。
void	installUI(JComponent c) 指定されたコンポーネントを Look & Feel に応じて適切に構成します。
void	paint(Graphics g, JComponent c) 指定されたコンポーネントを Look &Feel に合わせてペイントします。
void	uninstallUI(JComponent c) installUI 時に、指定されたコンポーネントに対して行われた構成を取り消します。
void	update(Graphics g, JComponent c) 指定されたコンポーネントをペイントする時間になったことを、この UI 委譲に通知します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ComponentUI

public ComponentUI()

唯一のコンストラクタです。サブクラスのコンストラクタによる呼び出し用で、通常は暗黙的に呼び出されます。

メソッドの詳細

installUI

public void installUI(JComponent c)

指定されたコンポーネントを Look & Feel に応じて適切に構成します。このメソッドは、ComponentUI インスタンスが、指定されたコンポーネントの UI 委譲としてインストールされているときに呼び出されます。このメソッドは、次を含む Look & Feel 用のコンポーネントを完全に構成するべきです。

1. カラー、フォント、ボーダー、アイコン、不透明さなどのデフォルトプロパティー値をコンポーネントにインストールする。可能な場合は常に、クライアントプログラムによって初期化されたプロパティーの値をオーバーライドするべきではない。
2. 必要に応じて、コンポーネントに LayoutManager をインストールする。
3. 必要なサブコンポーネントを作成して、コンポーネントに追加する。
4. イベントリスナーを作成して、コンポーネントにインストールする。
5. コンポーネントのプロパティーの変更を適切に検出し、応答するために、PropertyChangeListener を作成してコンポーネントにインストールする。
6. キーボード UI (ニーモニック、トラバーサルなど) を、コンポーネントにインストールする。
7. 適切なインスタンスのデータを初期化する。

パラメータ:

c - UI 委譲がインストールされるコンポーネント

関連項目:

uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

uninstallUI

public void uninstallUI(JComponent c)

installUI 時に、指定されたコンポーネントに対して行われた構成を取り消します。このメソッドは、この UIComponent インスタンスが、指定されたコンポーネントの UI 委譲として削除されているときに呼び出されます。このメソッドは、installUI によって実行された構成を元に戻すべきです。この場合、JComponent インスタンスをクリーンな状態 (余分なリスナーや、Look & Feel 固有のプロパティーオブジェクトが残らないように) にするよう十分注意してください。手順には次のものが含まれるべきです。

1. UI として設定されたすべてのボーダーを、コンポーネントから削除する。
2. UI として設定されたすべてのレイアウトマネージャーを、コンポーネントから削除する。
3. UI として追加されたすべてのサブコンポーネントを、コンポーネントから削除する。
4. UI として追加されたすべてのイベント/プロパティーリスナーを、コンポーネントから削除する。
5. UI としてインストールされたすべてのキーボード UI を、コンポーネントから削除する。
6. GC の対象になるように、割り当てられたすべてのインスタンスデータオブジェクトを null に設定する。

パラメータ:

c - この UI 委譲が削除されるコンポーネント。この引数は通常無視されるが、UI オブジェクトがステートレスで、複数のコンポーネントで共有されている場合は使用されることがある

関連項目:

installUI(javax.swing.JComponent), JComponent.updateUI()

paint

public void paint(Graphics g,
         JComponent c)

指定されたコンポーネントを Look &Feel に合わせてペイントします。このメソッドは、指定されたコンポーネントがペイントされるときに ComponentUI.update メソッドから呼び出されます。サブクラスは、このメソッドをオーバーライドして、指定された Graphics オブジェクトを使ってコンポーネントの内容を描画するべきです。

パラメータ:

g - ペイント対象の Graphics コンテキスト

c - ペイントされるコンポーネント。この引数は通常無視されるが、UI オブジェクトがステートレスで、複数のコンポーネントで共有されている場合は使用されることがある

関連項目:

update(java.awt.Graphics, javax.swing.JComponent)

update

public void update(Graphics g,
          JComponent c)

指定されたコンポーネントをペイントする時間になったことを、この UI 委譲に通知します。このメソッドは、指定されたコンポーネントがペイントされるときに JComponent によって呼び出されます。

デフォルトでは、このメソッドは、指定されたコンポーネントの opaque プロパティーが true の場合に、コンポーネントをそのバックグラウンドカラーで塗りつぶし、すぐに paint を呼び出します。一般的に、このメソッドはサブクラスによってオーバーライドする必要はありません。すべての Look & Feel 描画コードは paint メソッド内に存在するべきです。

パラメータ:

g - ペイント対象の Graphics コンテキスト

c - ペイントされるコンポーネント。この引数は通常無視されるが、UI オブジェクトがステートレスで、複数のコンポーネントで共有されている場合は使用されることがある

関連項目:

paint(java.awt.Graphics, javax.swing.JComponent), JComponent.paintComponent(java.awt.Graphics)

getPreferredSize

public Dimension getPreferredSize(JComponent c)

指定されたコンポーネントの、Look & Feel に適した推奨サイズを返します。null が返された場合、適切なサイズは代わりにコンポーネントのレイアウトマネージャーによって計算されます (これは、特定のレイアウトマネージャーをインストールしてあるコンポーネントの場合に推奨する方法です)。このメソッドのデフォルト実装は null を返します。

パラメータ:

c - 推奨サイズが照会されるコンポーネント。この引数は通常無視されるが、UI オブジェクトがステートレスで、複数のコンポーネントで共有されている場合は使用されることがある

関連項目:

JComponent.getPreferredSize(), LayoutManager.preferredLayoutSize(java.awt.Container)

getMinimumSize

public Dimension getMinimumSize(JComponent c)

指定されたコンポーネントの、Look & Feel に適した最小サイズを返します。null が返された場合、最小サイズは代わりにコンポーネントのレイアウトマネージャーによって計算されます (これは、特定のレイアウトマネージャーをインストールしてあるコンポーネントの場合に推奨する方法です)。このメソッドのデフォルト実装は getPreferredSize を呼び出して、その値を返します。

パラメータ:

c - 最小サイズが照会されるコンポーネント。この引数は通常無視されるが、UI オブジェクトがステートレスで、複数のコンポーネントで共有されている場合は使用されることがある

戻り値:

Dimension オブジェクトまたは null

関連項目:

JComponent.getMinimumSize(), LayoutManager.minimumLayoutSize(java.awt.Container), getPreferredSize(javax.swing.JComponent)

getMaximumSize

public Dimension getMaximumSize(JComponent c)

指定されたコンポーネントの、Look & Feel に適した最大サイズを返します。null が返された場合、最大サイズは代わりにコンポーネントのレイアウトマネージャーによって計算されます (これは、特定のレイアウトマネージャーをインストールしてあるコンポーネントの場合に推奨する方法です)。このメソッドのデフォルト実装は getPreferredSize を呼び出して、その値を返します。

パラメータ:

c - 最大サイズが照会されるコンポーネント。この引数は通常無視されるが、UI オブジェクトがステートレスで、複数のコンポーネントで共有されている場合は使用されることがある

戻り値:

Dimension オブジェクトまたは null

関連項目:

JComponent.getMaximumSize(), LayoutManager2.maximumLayoutSize(java.awt.Container)

contains

public boolean contains(JComponent c,
               int x,
               int y)

指定された x,y の位置が、指定されたコンポーネントの Look & Feel 定義の形状内にある場合は、true を返します。x と y は、指定されたコンポーネントの座標体系を基準に定義されます。コンポーネントの bounds は矩形に制限されますが、このメソッドはヒットの検出のためにこれらの境界内で矩形以外の形状を定義する方法を提供します。

パラメータ:

c - x,y の位置が照会されるコンポーネント。この引数は通常無視されるが、UI オブジェクトがステートレスで、複数のコンポーネントに共有されている場合は使用されることがある

x - 点の x 座標

y - 点の y 座標

関連項目:

JComponent.contains(int, int), Component.contains(int, int)

createUI

public static ComponentUI createUI(JComponent c)

指定されたコンポーネントの UI 委譲のインスタンスを返します。各サブクラスは、それ自体の static createUI メソッドを提供して、その UI 委譲のサブクラスのインスタンスを返す必要があります。UI 委譲のサブクラスがステートレスの場合、複数のコンポーネントに共有されるインスタンスを返します。UI 委譲がステートフルの場合、コンポーネントごとに新しいインスタンスを返す必要があります。このメソッドは呼び出してはいけないため、そのデフォルト実装はエラーをスローします。

getBaseline

public int getBaseline(JComponent c,
              int width,
              int height)

ベースラインを返します。ベースラインは、コンポーネントの上端から測定されます。このメソッドは、主に LayoutManager がそのベースラインに沿ってコンポーネントを配置するために使用します。戻り値が 0 より小さい場合、このコンポーネントのベースラインは適切ではありません。LayoutManager は、そのベースライン上にこのコンポーネントを配置するべきではありません。

このメソッドは -1 を返します。意味のあるベースラインを持つサブクラスで適切にオーバーライドするべきです。

パラメータ:

c - ベースラインが要求される JComponent

width - ベースラインを取得する幅

height - ベースラインを取得する高さ

戻り値:

ベースラインまたは 0 より小さい値 (適切なベースラインがないことを示す)

例外:

NullPointerException - c が null である場合

IllegalArgumentException - 幅または高さが 0 より小さい場合

導入されたバージョン:

1.6

関連項目:

JComponent.getBaseline(int,int)

getBaselineResizeBehavior

public Component.BaselineResizeBehavior getBaselineResizeBehavior(JComponent c)

サイズの変化に合わせてコンポーネントのベースラインがどのように変化するかを示す列挙を返します。このメソッドは、主にレイアウトマネージャーと GUI ビルダーで使用されます。

このメソッドは BaselineResizeBehavior.OTHER を返します。ベースラインをサポートするサブクラスで、適切にオーバーライドするべきです。

パラメータ:

c - ベースラインのサイズ変更の動作を返す JComponent

戻り値:

コンポーネントサイズの変化に合わせてベースラインがどのように変化するかを示す列挙

例外:

NullPointerException - c が null である場合

導入されたバージョン:

1.6

関連項目:

JComponent.getBaseline(int, int)

getAccessibleChildrenCount

public int getAccessibleChildrenCount(JComponent c)

オブジェクト内のアクセシビリティー対応の子の数を返します。このオブジェクトのすべての子が Accessible インタフェースを実装している場合、このメソッドはこのオブジェクトの子の数を返すべきです。UI が、画面上にコンポーネントとして表示される領域は提供するが、実際のコンポーネントがこの領域を提供するために使用されない場合、UI において必要に応じてこのメソッドをオーバーライドできます。 注: バージョン 1.3 以降は、このメソッドの代わりに Component.AccessibleAWTComponent.getAccessibleChildrenCount() を呼び出すことをお勧めします。

戻り値:

オブジェクト内のアクセシビリティー対応の子の数

関連項目:

getAccessibleChild(javax.swing.JComponent, int)

getAccessibleChild

public Accessible getAccessibleChild(JComponent c,
                            int i)

オブジェクトの i 番目の Accessible の子を返します。UI が、画面上にコンポーネントとして表示される領域は提供するが、この領域を提供するのに実際のコンポーネントを使用しない場合、UI は必要に応じてこのメソッドをオーバーライドします。

注: バージョン 1.3 以降は、このメソッドの代わりに Component.AccessibleAWTComponent.getAccessibleChild() を呼び出すことをお勧めします。

パラメータ:

i - 子のゼロから始まるインデックス

戻り値:

オブジェクトの i 番目の Accessible の子

関連項目:

getAccessibleChildrenCount(javax.swing.JComponent)