モジュール java.desktop

パッケージ java.awt

クラスCardLayout

java.lang.Object

java.awt.CardLayout

すべての実装されたインタフェース:

LayoutManager, LayoutManager2, Serializable

public class CardLayout extends Object implements LayoutManager2, Serializable

CardLayoutオブジェクトは、コンテナのレイアウト・マネージャです。 コンテナ内の各コンポーネントをカードとして扱います。 一度に1枚のカードだけを表示し、コンテナはカードのスタックとして動作します。 CardLayoutオブジェクトに最初に追加されるコンポーネントは、コンテナが最初に表示されるときの可視コンポーネントになります。

カードの順序は、コンポーネント・オブジェクトのコンテナ自身の内部順序で決まります。 CardLayoutは、アプリケーションがこれらのカードを順番にめくったり、指定したカードを表示したりできるようにするメソッドのセットを定義します。 addLayoutComponent(java.awt.Component, java.lang.Object)メソッドを使用すると、高速なランダム・アクセスのために、文字列の識別子を指定したカードに関連付けることができます。

導入されたバージョン:

1.0

関連項目:

• Container
• 直列化された形式

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

コンストラクタ

コンストラクタ	説明
CardLayout()	新しいカード・レイアウトをサイズ・ゼロの間隔で作成します。
CardLayout(int hgap, int vgap)	指定された水平方向および垂直方向の間隔を使って新しいカード・レイアウトを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
void	addLayoutComponent(Component comp, Object constraints)	指定されたコンポーネントを、このカード・レイアウトの名前の内部表に追加します。
void	addLayoutComponent(String name, Component comp)	非推奨。 addLayoutComponent(Component, Object)に置き換えられています。
void	first(Container parent)	コンテナの最初のカードに切り替えます。
int	getHgap()	コンポーネント間の水平方向の間隔を取得します。
float	getLayoutAlignmentX(Container parent)	x軸方向の配置を返します。
float	getLayoutAlignmentY(Container parent)	y軸方向の配置を返します。
int	getVgap()	コンポーネント間の垂直方向の間隔を取得します。
void	invalidateLayout(Container target)	レイアウトを無効にします。このとき、レイアウト・マネージャが情報をキャッシュしていればそれを破棄します。
void	last(Container parent)	コンテナの最後のカードに切り替えます。
void	layoutContainer(Container parent)	このカード・レイアウトを使用して、指定されたコンテナを配置します。
Dimension	maximumLayoutSize(Container target)	指定されたターゲット・コンテナにコンポーネントが与えられた場合の、レイアウトの最大サイズを返します。
Dimension	minimumLayoutSize(Container parent)	指定されたパネルの最小サイズを計算します。
void	next(Container parent)	指定されたコンテナの次のカードに切り替えます。
Dimension	preferredLayoutSize(Container parent)	このカード・レイアウトを使用するコンテナ引数の推奨サイズを判定します。
void	previous(Container parent)	指定されたコンテナの前のカードに切り替えます。
void	removeLayoutComponent(Component comp)	指定されたコンポーネントをレイアウトから削除します。
void	setHgap(int hgap)	コンポーネント間の水平方向の間隔を設定します。
void	setVgap(int vgap)	コンポーネント間の垂直方向の間隔を設定します。
void	show(Container parent, String name)	addLayoutComponentを使用して、指定されたnameでこのレイアウトに追加されたコンポーネントに切り替えます。
String	toString()	このカード・レイアウトの状態を示す文字列表現を返します。

クラスjava.lang.Objectで宣言されたメソッド

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

コンストラクタの詳細

CardLayout

public CardLayout()

新しいカード・レイアウトをサイズ・ゼロの間隔で作成します。

CardLayout

public CardLayout(int hgap, int vgap)

指定された水平方向および垂直方向の間隔を使って新しいカード・レイアウトを作成します。 水平方向の間隔は左端および右端に配置されます。 垂直方向の間隔は上端および下端に配置されます。

パラメータ:

hgap - 水平方向の間隔。

vgap - 垂直方向の間隔。

メソッドの詳細

getHgap

public int getHgap()

コンポーネント間の水平方向の間隔を取得します。

戻り値:

コンポーネント間の水平方向の間隔

導入されたバージョン:

1.1

関連項目:

• setHgap(int)
• getVgap()

setHgap

public void setHgap(int hgap)

コンポーネント間の水平方向の間隔を設定します。

パラメータ:

hgap - コンポーネント間の水平方向の間隔

導入されたバージョン:

1.1

関連項目:

• getHgap()
• setVgap(int)

getVgap

public int getVgap()

コンポーネント間の垂直方向の間隔を取得します。

戻り値:

コンポーネント間の垂直方向の間隔

関連項目:

• setVgap(int)
• getHgap()

setVgap

public void setVgap(int vgap)

コンポーネント間の垂直方向の間隔を設定します。

パラメータ:

vgap - コンポーネント間の垂直方向の間隔

導入されたバージョン:

1.1

関連項目:

• getVgap()
• setHgap(int)

addLayoutComponent

public void addLayoutComponent(Component comp, Object constraints)

指定されたコンポーネントを、このカード・レイアウトの名前の内部表に追加します。 constraintsによって指定されるオブジェクトは文字列である必要があります。 カード・レイアウトはこの文字列を、特定のカードへのランダム・アクセスに使用するキーと値のペアとして格納します。 showメソッドを呼び出すことにより、アプリケーションは指定された名前でコンポーネントを表示できます。

定義:

addLayoutComponent、インタフェースLayoutManager2

パラメータ:

comp - 追加されるコンポーネント。

constraints - レイアウト内の特定のカードを識別するタグ

例外:

IllegalArgumentException - 制約が文字列でない場合

関連項目:

• show(java.awt.Container, java.lang.String)

addLayoutComponent

@Deprecated public void addLayoutComponent(String name, Component comp)

非推奨。

addLayoutComponent(Component, Object)に置き換えられています。

インタフェースからコピーされた説明: LayoutManager

レイアウト・マネージャがコンポーネントごとの文字列を使用する場合は、レイアウトにコンポーネントcompを追加し、それをnameによって指定された文字列に関連付けます。

定義:

addLayoutComponent、インタフェースLayoutManager

パラメータ:

name - コンポーネントに関連付けられる文字列

comp - 追加されるコンポーネント

removeLayoutComponent

public void removeLayoutComponent(Component comp)

指定されたコンポーネントをレイアウトから削除します。 カードが最前面に表示されていた場合は、その下にある次のカードが表示されます。

定義:

removeLayoutComponent、インタフェースLayoutManager

パラメータ:

comp - 削除されるコンポーネント。

関連項目:

• Container.remove(java.awt.Component)
• Container.removeAll()

preferredLayoutSize

public Dimension preferredLayoutSize(Container parent)

このカード・レイアウトを使用するコンテナ引数の推奨サイズを判定します。

定義:

preferredLayoutSize、インタフェースLayoutManager

パラメータ:

parent - レイアウトが行われる親コンテナ

戻り値:

指定されたコンテナのサブコンポーネントを配置するための望ましい寸法

関連項目:

• Container.getPreferredSize()
• minimumLayoutSize(java.awt.Container)

minimumLayoutSize

public Dimension minimumLayoutSize(Container parent)

指定されたパネルの最小サイズを計算します。

定義:

minimumLayoutSize、インタフェースLayoutManager

パラメータ:

parent - レイアウトが行われる親コンテナ

戻り値:

指定されたコンテナのサブコンポーネントを配置するための最小の寸法

関連項目:

• Container.doLayout()
• preferredLayoutSize(java.awt.Container)

maximumLayoutSize

public Dimension maximumLayoutSize(Container target)

指定されたターゲット・コンテナにコンポーネントが与えられた場合の、レイアウトの最大サイズを返します。

定義:

maximumLayoutSize、インタフェースLayoutManager2

パラメータ:

target - レイアウトが必要なコンポーネント

戻り値:

コンテナの最大サイズ

関連項目:

• Container
• minimumLayoutSize(java.awt.Container)
• preferredLayoutSize(java.awt.Container)

getLayoutAlignmentX

public float getLayoutAlignmentX(Container parent)

x軸方向の配置を返します。 これは、ほかのコンポーネントを基準にこのコンポーネントをどのように配置するかを指定します。 この値は0から1の間の数値であるはずです(0は原点に沿った配置を表し、1は原点からもっとも遠いところに、0.5は中央に配置されます)。

定義:

getLayoutAlignmentX、インタフェースLayoutManager2

パラメータ:

parent - ターゲット・コンテナ

戻り値:

x軸整列のプリファレンス

getLayoutAlignmentY

public float getLayoutAlignmentY(Container parent)

y軸方向の配置を返します。 これは、ほかのコンポーネントを基準にこのコンポーネントをどのように配置するかを指定します。 この値は0から1の間の数値であるはずです(0は原点に沿った配置を表し、1は原点からもっとも遠いところに、0.5は中央に配置されます)。

定義:

getLayoutAlignmentY、インタフェースLayoutManager2

パラメータ:

parent - ターゲット・コンテナ

戻り値:

y軸整列のプリファレンス

invalidateLayout

public void invalidateLayout(Container target)

レイアウトを無効にします。このとき、レイアウト・マネージャが情報をキャッシュしていればそれを破棄します。

定義:

invalidateLayout、インタフェースLayoutManager2

パラメータ:

target - ターゲット・コンテナ

layoutContainer

public void layoutContainer(Container parent)

このカード・レイアウトを使用して、指定されたコンテナを配置します。

parentコンテナの各コンポーネントは、コンテナから周囲のイン・セット、水平方向の間隔、および垂直方向の間隔のスペースを差し引いたサイズになるように形状変更されます。

定義:

layoutContainer、インタフェースLayoutManager

パラメータ:

parent - レイアウトが行われる親コンテナ

関連項目:

• Container.doLayout()

first

public void first(Container parent)

コンテナの最初のカードに切り替えます。

パラメータ:

parent - レイアウトが行われる親コンテナ

関連項目:

• last(java.awt.Container)

next

public void next(Container parent)

指定されたコンテナの次のカードに切り替えます。 現在表示されているカードが最後のカードである場合、このメソッドはレイアウト内の最初のカードに切り替えます。

パラメータ:

parent - レイアウトが行われる親コンテナ

関連項目:

• previous(java.awt.Container)

previous

public void previous(Container parent)

指定されたコンテナの前のカードに切り替えます。 現在表示されているカードが最初のカードである場合、このメソッドはレイアウト内の最後のカードに切り替えます。

パラメータ:

parent - レイアウトが行われる親コンテナ

関連項目:

• next(java.awt.Container)

last

public void last(Container parent)

コンテナの最後のカードに切り替えます。

パラメータ:

parent - レイアウトが行われる親コンテナ

関連項目:

• first(java.awt.Container)

show

public void show(Container parent, String name)

addLayoutComponentを使用して、指定されたnameでこのレイアウトに追加されたコンポーネントに切り替えます。 そのようなコンポーネントがない場合、処理は行われません。

パラメータ:

parent - レイアウトが行われる親コンテナ

name - コンポーネントの名前

関連項目:

• addLayoutComponent(java.awt.Component, java.lang.Object)

toString

public String toString()

このカード・レイアウトの状態を示す文字列表現を返します。

オーバーライド:

toString、クラスObject

戻り値:

このカード・レイアウトの文字列表現