javax.swing

クラス LookAndFeel

java.lang.Object

javax.swing.LookAndFeel

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

BasicLookAndFeel, MultiLookAndFeel

public abstract class LookAndFeel
extends Object

LookAndFeel は、その名前が示す通り、Look & Feel をカプセル化します。Look & Feel のインストール時以外に、開発者が直接 LookAndFeel と情報をやりとりすることは、ほとんどありません。通常は、開発者が Look & Feel をカスタマイズする場合にのみ、このクラスに注意する必要があります。

Swing の構築基盤では、各 JComponent サブクラスが特定の ComponentUI サブクラスの実装を持っています。ComponentUI は、通常、「UI」、「コンポーネント UI」、「Look & Feel の委譲」などと呼ばれます。ComponentUI サブクラスは、コンポーネントの特定の機能の Look & Feel を提供します。たとえば、JTree は、ComponentUI サブクラス TreeUI の実装を必要とします。特定の ComponentUI サブクラスの実装は、LookAndFeel によって提供されます。各 JComponent サブクラスは、JComponent メソッド getUIClassID を使用して、必要な ComponentUI サブクラスを識別します。

各 LookAndFeel 実装は、getDefaults から返される、UIDefaults オブジェクト内に各 Swing UI クラス ID の値を指定することにより、適切な ComponentUI サブクラスの実装を提供する必要があります。たとえば、BasicLookAndFeel は、BasicTreeUI を TreeUI の具象実装として使用します。このために、BasicLookAndFeel は、getDefaults から返される UIDefaults 内にキーと値のペア "TreeUI"-"javax.swing.plaf.basic.BasicTreeUI" を指定します。ComponentUI サブクラスの実装を取得する方法については、UIDefaults.getUI(JComponent) を参照してください。

LookAndFeel がインストールされるとき、UIManager はすべての UI クラス ID のエントリが存在するかどうかを確認しません。このため、現在の Look & Feel で特定の UI クラス ID の値が指定されておらず、JComponent サブクラスのインスタンスが作成されている場合、ランダム例外が発生します。

Look & Feel の推奨事項

UIManager に記載されているとおり、各 LookAndFeel に、開発者やシステムのデフォルトによって階層化されたデフォルトのセットを提供する機会が与えられます。一部の Swing コンポーネントは、特定のデフォルトのセットを提供するために Look & Feel を要求します。これらについては、特定のデフォルトを必要とする個々のクラスにドキュメント化されています。

ComponentUI とデフォルト

一般に、すべての ComponentUIs は、ComponentUI が Look & Feel を提供する JComponent 上にさまざまなプロパティーを設定する必要があります。この処理は、通常、ComponentUI が JComponent 上にインストールされるときに行われます。プロパティーの設定は、開発者がプロパティーを設定していない場合にのみ行われるべきです。値が非プリミティブである場合は、現在の値が null であるか、UIResource を実装している場合にのみ、JComponent 上で ComponentUI がプロパティーを変更するようにしてください。現在の値が null であるか、UIResource を実装している場合は、開発者がプロパティーを設定していません。このため、UI を自由に変更できます。たとえば、BasicButtonUI.installDefaults は、button.getFont() の戻り値が null であるか、UIResource を実装している場合にのみ、JButton のフォントを変更します。一方、button.getFont() の戻り値が non-null で、UIResource を実装していない場合、BasicButtonUI.installDefaults は JButton のフォントを変更しません。

値がプリミティブである場合、たとえば opaque である場合は、installProperty メソッドが呼び出されるはずです。 installProperty は、開発者が値を変更していない場合にのみ、対応するプロパティーを変更します。

ComponentUI 実装は、推奨ガイドラインに従って必要なチェックを行い、プロパティーをインストールするときに、このクラスが提供するさまざまなインストールメソッドを使用します。

例外

変更されるプロパティーの値が null または UIResource である場合、LookAndFeel が提供するすべてのインストールメソッドは、デフォルト値にアクセスする必要があります。たとえば、フォントのインストールでは、次の処理が行われます。

   JComponent c;
   Font font = c.getFont();
   if (font == null || (font instanceof UIResource)) {
       c.setFont(UIManager.getFont("fontKey"));
   }
 

フォントが null または UIResource である場合、fontKey というキーにより、デフォルトテーブルが照会されます。UIDefault's の取得メソッドはすべて、null を渡された場合に NullPointerException をスローします。このため、特に記載がないかぎり、現在の値が null または UIResource で、デフォルトキーとして null が指定された場合、LookAndFeel の個々のインストールメソッドは NullPointerException をスローします。また、特に指定がないかぎり、null コンポーネントが渡された場合、これらすべての install メソッドは NullPointerException をスローします。

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

コンストラクタ

コンストラクタと説明
LookAndFeel()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
UIDefaults	getDefaults() Look & Feel のデフォルトを返します。
abstract String	getDescription() この Look & Feel の実装に関する 1 行の説明を返します。
static Object	getDesktopPropertyValue(String systemPropertyName, Object fallbackValue) Toolkit.getDefaultToolkit().getDesktopProperty() を呼び出すことで、指定されたシステムデスクトッププロパティーの値を返します。
Icon	getDisabledIcon(JComponent component, Icon icon) 無効な状態の Icon を返します。
Icon	getDisabledSelectedIcon(JComponent component, Icon icon) 無効で、かつ選択されているコンポーネントによって使用される Icon を返します。
abstract String	getID() この Look & Feel を識別する文字列を返します。
LayoutStyle	getLayoutStyle() この Look & Feel の LayoutStyle を返します。
abstract String	getName() この Look & Feel を識別する短い文字列を返します。
boolean	getSupportsWindowDecorations() RootPaneUI インスタンスを返す LookAndFeel が JRootPane での Window 装飾の提供をサポートする場合は、true を返します。
void	initialize() Look & Feel を初期化します。
static void	installBorder(JComponent c, String defaultBorderName) コンポーネントのボーダーのプロパティーにデフォルト値を設定する簡易メソッドです。
static void	installColors(JComponent c, String defaultBgName, String defaultFgName) コンポーネントのフォアグラウンドカラーおよびバックグラウンドカラーのプロパティーにデフォルト値を設定する簡易メソッドです。
static void	installColorsAndFont(JComponent c, String defaultBgName, String defaultFgName, String defaultFontName) コンポーネントのフォアグラウンド、バックグラウンド、およびフォントのプロパティーにデフォルト値を設定する簡易メソッドです。
static void	installProperty(JComponent c, String propertyName, Object propertyValue) 開発者がまだプロパティーを設定していない場合に、指定された名前と値でプロパティーをコンポーネントにインストールする簡易メソッドです。
abstract boolean	isNativeLookAndFeel() 基本のプラットフォームに「ネイティブな」Look & Feel があり、現在の Look & Feel がその実装である場合に true を返します。
abstract boolean	isSupportedLookAndFeel() 基本のプラットフォームがこの Look & Feel をサポートする場合、または許可する場合に true を返します。
static void	loadKeyBindings(InputMap retMap, Object[] keys) 指定されたバインディングで InputMap を生成します。
static ComponentInputMap	makeComponentInputMap(JComponent c, Object[] keys) keys から ComponentInputMapUIResource を作成します。
static Object	makeIcon(Class<?> baseClass, String gifFile) イメージをロードする UIDefault.LazyValue を作成して返します。
static InputMap	makeInputMap(Object[] keys) keys から InputMapUIResource を作成します。
static JTextComponent.KeyBinding[]	makeKeyBindings(Object[] keyBindingList) KeyBindings の配列を構築する簡易メソッドです。
void	provideErrorFeedback(Component component) ユーザーが、フォーカスを持つ編集不可能な JTextField へのペーストなどの無効な操作を行おうとしたときに呼び出されます。
String	toString() このオブジェクトのプロパティーを表示および識別する文字列を返します。
void	uninitialize() Look & Feel の初期化を解除します。
static void	uninstallBorder(JComponent c) ボーダーをアンインストールする簡易メソッドです。

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

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

コンストラクタの詳細

LookAndFeel

public LookAndFeel()

メソッドの詳細

installColors

public static void installColors(JComponent c,
                 String defaultBgName,
                 String defaultFgName)

コンポーネントのフォアグラウンドカラーおよびバックグラウンドカラーのプロパティーにデフォルト値を設定する簡易メソッドです。プロパティーが設定されるのは、現在の値が null または UIResource の場合だけです。

パラメータ:

c - 色を設定するコンポーネント

defaultBgName - バックグラウンドのキー

defaultFgName - フォアグラウンドのキー

例外:

NullPointerException - 「例外」に記載されているとおり

関連項目:

installColorsAndFont(javax.swing.JComponent, java.lang.String, java.lang.String, java.lang.String), UIManager.getColor(java.lang.Object)

installColorsAndFont

public static void installColorsAndFont(JComponent c,
                        String defaultBgName,
                        String defaultFgName,
                        String defaultFontName)

コンポーネントのフォアグラウンド、バックグラウンド、およびフォントのプロパティーにデフォルト値を設定する簡易メソッドです。プロパティーが設定されるのは、現在の値が null または UIResource の場合だけです。

パラメータ:

c - 色とフォントを設定するコンポーネント

defaultBgName - バックグラウンドのキー

defaultFgName - フォアグラウンドのキー

defaultFontName - フォントのキー

例外:

NullPointerException - 「例外」に記載されているとおり

関連項目:

installColors(javax.swing.JComponent, java.lang.String, java.lang.String), UIManager.getColor(java.lang.Object), UIManager.getFont(java.lang.Object)

installBorder

public static void installBorder(JComponent c,
                 String defaultBorderName)

コンポーネントのボーダーのプロパティーにデフォルト値を設定する簡易メソッドです。ボーダーが設定されるのは、ボーダーが null であるか、UIResource のインスタンスである場合だけです。

パラメータ:

c - ボーダーを設定するコンポーネント

defaultBorderName - ボーダーを指定するキー

例外:

NullPointerException - 「例外」に記載されているとおり

uninstallBorder

public static void uninstallBorder(JComponent c)

ボーダーをアンインストールする簡易メソッドです。コンポーネントのボーダーが UIResource である場合、null に設定されます。

パラメータ:

c - ボーダーをアンインストールするコンポーネント

例外:

NullPointerException - c が null である場合

installProperty

public static void installProperty(JComponent c,
                   String propertyName,
                   Object propertyValue)

開発者がまだプロパティーを設定していない場合に、指定された名前と値でプロパティーをコンポーネントにインストールする簡易メソッドです。このメソッドは、プリミティブ型 (boolean、int など) のプロパティーのデフォルト値を指定する必要があるが、クライアントによって設定された値はオーバーライドしない UI 委譲のインスタンスによって使用されます。プリミティブ型のプロパティー値は UIResource マーカーでラップできないため、このメソッドは非公開状態を使用してプロパティーがクライアントによって設定されているかどうかを判断します。

パラメータ:

c - プロパティーの設定対象のコンポーネント

propertyName - 設定するプロパティーの名前

propertyValue - プロパティーの値

例外:

IllegalArgumentException - 指定されたプロパティーがこのメソッドを使用して設定できるものでない場合

ClassCastException - 開発者がプロパティー値を設定しておらず、型がプロパティーの型と一致しない場合

NullPointerException - c が null であるか、開発者が名前付きプロパティーを設定しておらず、propertyValue が null である場合

導入されたバージョン:

1.5

makeKeyBindings

public static JTextComponent.KeyBinding[] makeKeyBindings(Object[] keyBindingList)

KeyBindings の配列を構築する簡易メソッドです。このメソッドは非推奨ではありませんが、開発者がキーバインディングを指定するときは、このメソッドではなく、ActionMap と InputMap を使用するようにしてください。

このメソッドは、keyBindingList の交互になる key-action のペアごとの、KeyBindings の配列を返します。key は、KeyStroke.getKeyStroke メソッドで指定された形式の String、または KeyStroke です。キーとアクションのペアの action 部分は、Action の名前に対応する String になっています。

次に、6 組の交互になる key-action のペアから 1 つの KeyBinding 配列を作成する例を示します。

  JTextComponent.KeyBinding[] multilineBindings = makeKeyBindings( new Object[] {
          "UP", DefaultEditorKit.upAction,
        "DOWN", DefaultEditorKit.downAction,
     "PAGE_UP", DefaultEditorKit.pageUpAction,
   "PAGE_DOWN", DefaultEditorKit.pageDownAction,
       "ENTER", DefaultEditorKit.insertBreakAction,
         "TAB", DefaultEditorKit.insertTabAction
  });
 

keyBindingList's の長さが奇数の場合、最後の要素は無視されます。

key-action のペアの key 部分または action 部分に null 値を指定すると、対応する値 null を持つ KeyBinding が作成されます。Swing のその他の部分では、KeyBinding を構成する値として non-null が求められるので、key-action のペアの key 部分にも action 部分にも、null を指定しないようにしてください。

パラメータ:

keyBindingList - key-action のペアの配列

戻り値:

KeyBindings の配列

例外:

NullPointerException - keyBindingList が null である場合

ClassCastException - ペアの key 部分が KeyStroke でも String でもない場合、またはペアの action 部分が String でない場合

関連項目:

ActionMap, InputMap, KeyStroke.getKeyStroke(char)

makeInputMap

public static InputMap makeInputMap(Object[] keys)

keys から InputMapUIResource を作成します。これは、新しい InputMapUIResource を作成し、loadKeyBindings(map, keys) を呼び出して、InputMapUIResource を返す簡易メソッドです。

パラメータ:

keys - 交互になる keystroke-action key のペア (loadKeyBindings(javax.swing.InputMap, java.lang.Object[]) で説明)

戻り値:

新しく作成された InputMapUIResource

導入されたバージョン:

1.3

関連項目:

loadKeyBindings(javax.swing.InputMap, java.lang.Object[])

makeComponentInputMap

public static ComponentInputMap makeComponentInputMap(JComponent c,
                                      Object[] keys)

keys から ComponentInputMapUIResource を作成します。これは、新しい ComponentInputMapUIResource を作成し、loadKeyBindings(map, keys) を呼び出して、ComponentInputMapUIResource を返す簡易メソッドです。

パラメータ:

c - ComponentInputMapUIResource の作成に使用するコンポーネント

keys - 交互になる keystroke-action key のペア (loadKeyBindings(javax.swing.InputMap, java.lang.Object[]) で説明)

戻り値:

新しく作成された InputMapUIResource

例外:

IllegalArgumentException - c が null である場合

導入されたバージョン:

1.3

関連項目:

loadKeyBindings(javax.swing.InputMap, java.lang.Object[]), ComponentInputMapUIResource

loadKeyBindings

public static void loadKeyBindings(InputMap retMap,
                   Object[] keys)

指定されたバインディングで InputMap を生成します。バインディングは、交互になる keystroke-action key のペアのリストとして指定されます。keystroke は、KeyStroke のインスタンスか、バインディングの KeyStroke を示す String になります。特定の形式については、KeyStroke.getKeyStroke(String) を参照してください。ペアの action key 部分は、KeyStroke の InputMap 内の登録済みのキーになっています。

次に、2 組の key-action のペアを使って、InputMap をロードする例を示します。

   LookAndFeel.loadKeyBindings(inputMap, new Object[] {
     "control X", "cut",
     "control V", "paste"
   });
 

バインディング (keys) のリストとして null を指定した場合、retMap は変更されません。

action key として null を指定した場合、InputMap から keystroke's のエントリが削除されます。keystroke null は無視されます。

パラメータ:

retMap - key-action のペアを追加する InputMap

keys - retMap に追加するバインディング

例外:

NullPointerException - keys が non-null で、空でなく、かつ retMap が null である場合

導入されたバージョン:

1.3

関連項目:

KeyStroke.getKeyStroke(String), InputMap

makeIcon

public static Object makeIcon(Class<?> baseClass,
              String gifFile)

イメージをロードする UIDefault.LazyValue を作成して返します。戻り値は、UIDefaults.LazyValue の実装になります。返されたオブジェクト上で createValue が呼び出されると、イメージがロードされます。non-null のイメージは、UIResource を実装する Icon にラップされます。イメージのロードは、Class.getResourceAsStream(gifFile) を使って行われます。

このメソッドは、引数のチェックを行いません。non-null の値を指定することを強くお勧めします。そうしないと、返されたオブジェクト上で createValue を呼び出したとき、例外が発生する可能性があります。

パラメータ:

baseClass - リソースのロードに使用する Class

gifFile - イメージをロードするパス

戻り値:

UIDefaults.LazyValue。解決時に、LazyValue は指定されたイメージをロードする

関連項目:

UIDefaults.LazyValue, Icon, Class.getResourceAsStream(String)

getLayoutStyle

public LayoutStyle getLayoutStyle()

この Look & Feel の LayoutStyle を返します。戻り値は null 以外です。

通常、Look & Feel の LayoutStyle は使用しません。代わりに、LayoutStyle メソッド getInstance を使用します。

戻り値:

この Look & Feel の LayoutStyle

導入されたバージョン:

1.6

関連項目:

LayoutStyle.getInstance()

provideErrorFeedback

public void provideErrorFeedback(Component component)

ユーザーが、フォーカスを持つ編集不可能な JTextField へのペーストなどの無効な操作を行おうとしたときに呼び出されます。デフォルトの実装では、ビープ音を鳴らします。別の動作を行う場合は、デフォルトの実装をサブクラスによってオーバーライドし、別のフィードバックを指定する必要があります。

パラメータ:

component - エラーが発生したComponent。null も指定できる (この場合、エラー条件は Component と直接関連付けられない)

導入されたバージョン:

1.4

getDesktopPropertyValue

public static Object getDesktopPropertyValue(String systemPropertyName,
                             Object fallbackValue)

Toolkit.getDefaultToolkit().getDesktopProperty() を呼び出すことで、指定されたシステムデスクトッププロパティーの値を返します。指定されたプロパティーの値が null の場合、fallbackValue が返されます。

パラメータ:

systemPropertyName - 照会するシステムデスクトッププロパティーの名前

fallbackValue - システム値が null の場合、値として戻るオブジェクト

戻り値:

デスクトッププロパティーの現在の値

導入されたバージョン:

1.4

関連項目:

Toolkit.getDesktopProperty(java.lang.String)

getDisabledIcon

public Icon getDisabledIcon(JComponent component,
                   Icon icon)

無効な状態の Icon を返します。このメソッドは、無効な状態の Icon が指定されていない場合に、それを生成するために使用されます。たとえば、JButton を作成し、setIcon により Icon のみを指定した場合このメソッドが呼び出され、無効な状態の Icon が作成されます。icon として null が渡された場合、このメソッドは null を返します。

Look & Feel によっては無効な状態の Icon が描画されないことがあり、その場合、これは無視されます。

パラメータ:

component - Icon を表示する JComponent。null も可

icon - 無効な状態のアイコンを生成する Icon

戻り値:

無効な状態の Icon。適切な Icon を生成できない場合は null

導入されたバージョン:

1.5

getDisabledSelectedIcon

public Icon getDisabledSelectedIcon(JComponent component,
                           Icon icon)

無効で、かつ選択されているコンポーネントによって使用される Icon を返します。このメソッドは、無効で、かつ選択されている状態のコンポーネントに対して、この状態の特定の Icon が設定されていない場合に、Icon を生成するために使用します。たとえば、JButton を作成し、setIcon により Icon のみを指定した場合、このメソッドが呼び出され、無効でかつ選択されている Icon が作成されます。icon として null が渡された場合、このメソッドは null を返します。

Look & Feel によっては、無効で、かつ選択されている状態の Icon が描画されないことがありますが、その場合、このメソッドは無視されます。

パラメータ:

component - Icon を表示する JComponent。null も可

icon - 無効で、かつ選択されている状態のアイコンを生成する Icon。

戻り値:

選択された無効な状態のアイコン。適切な Icon を生成できない場合は null。

導入されたバージョン:

1.5

getName

public abstract String getName()

「CDE/Motif」など、この Look & Feel を識別する短い文字列を返します。この文字列は、メニュー項目に適しています。Look & Feel は、それぞれ異なる名前を持っています。たとえば、数個のコンポーネントの描画方法を変更する MotifLookAndFeel のサブクラスは、「CDE/Motif My Way」などと呼ばれます。こうした名前は、ユーザーが名前のリストから L&F を選択するときに便利です。

戻り値:

この Look & Feel を識別する短い識別子

getID

public abstract String getID()

この Look & Feel を識別する文字列を返します。この文字列は、有名な Look & Feel の実装を認識するアプリケーション/サービスで使用されます。現在、有名なものとしては「Motif」、「Windows」、「Mac」、「Metal」などです。Look & Feel に基本的な変更を加えない有名なスーパークラスから派生した LookAndFeel は、このメソッドをオーバーライドすべきではありません。

戻り値:

この Look & Feel を識別する識別子

getDescription

public abstract String getDescription()

「The CDE/Motif Look and Feel」など、この Look & Feel の実装に対する 1 行の説明を返します。これはユーザー向けの文字列で、ウィンドウのタイトルやツールヒントメッセージなどに使用されます。

戻り値:

この Look & Feel の短い説明

getSupportsWindowDecorations

public boolean getSupportsWindowDecorations()

RootPaneUI インスタンスを返す LookAndFeel が JRootPane での Window 装飾の提供をサポートする場合は、true を返します。

デフォルトの実装は false を返します。Window 装飾をサポートするサブクラスは、この実装をオーバーライドし、true を返すようにします。

戻り値:

この Look & Feel によって作成された RootPaneUI インスタンスがクライアント側の装飾をサポートする場合、true

導入されたバージョン:

1.4

関連項目:

JDialog.setDefaultLookAndFeelDecorated(boolean), JFrame.setDefaultLookAndFeelDecorated(boolean), JRootPane.setWindowDecorationStyle(int)

isNativeLookAndFeel

public abstract boolean isNativeLookAndFeel()

基本のプラットフォームに「ネイティブな」Look & Feel があり、現在の Look & Feel がその実装である場合に true を返します。たとえば、基本のプラットフォームが CDE を実行する Solaris である場合、CDE/Motif の Look & Feel の実装が true を返します。

戻り値:

この Look & Feel が基本のプラットフォームの Look & Feel を表す場合、true

isSupportedLookAndFeel

public abstract boolean isSupportedLookAndFeel()

基本のプラットフォームがこの Look & Feel をサポートする場合、または許可する場合に true を返します。Look & Feel が特殊なリソースや、現在のプラットフォームに対して定義されていない法的契約に依存する場合、このメソッドは false を返します。

戻り値:

これがサポートされている Look & Feel である場合、true

関連項目:

UIManager.setLookAndFeel(javax.swing.LookAndFeel)

initialize

public void initialize()

Look & Feel を初期化します。このメソッドは public メソッドですが、Look & Feel が現在の Look & Feel としてインストールされたときにのみ、UIManager によって呼び出すようにしてください。このメソッドは、UIManager が getDefaults を呼び出す前に呼び出されます。このメソッドは、Look & Feel の初期化を実行するためのメソッドです。static イニシャライザではなくサブクラスが、必要とする 1 回かぎりの設定を実行するべきです。Look & Feel クラスオブジェクトは、isSupportedLookAndFeel() が false を返すことを検出するためだけにロードされる可能性があるためです。

関連項目:

uninitialize(), UIManager.setLookAndFeel(javax.swing.LookAndFeel)

uninitialize

public void uninitialize()

Look & Feel の初期化を解除します。このメソッドは public メソッドですが、Look & Feel がアンインストールされるときに UIManager によって呼び出すようにしてください。たとえば、UIManager.setLookAndFeel が Look & Feel の変更時にこのメソッドを呼び出します。

サブクラスがここで一部のリソースを解放することを選択してもかまいません。

関連項目:

initialize(), UIManager.setLookAndFeel(javax.swing.LookAndFeel)

getDefaults

public UIDefaults getDefaults()

Look & Feel のデフォルトを返します。このメソッドは public メソッドですが、Look & Feel が現在の Look & Feel として設定され、initialize が呼び出されたあとにのみ、UIManager によって呼び出すようにしてください。

戻り値:

Look & Feel のデフォルト

関連項目:

initialize(), uninitialize(), UIManager.setLookAndFeel(javax.swing.LookAndFeel)

toString

public String toString()

このオブジェクトのプロパティーを表示および識別する文字列を返します。

オーバーライド:

toString、クラス: Object

戻り値:

このオブジェクトの文字列表現