JavaTM Platform
Standard Ed. 6

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) メソッドを使用すると、高速なランダムアクセスのために、文字列の識別子を指定したカードに関連付けることができます。

導入されたバージョン:
JDK1.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()
コンポーネント間の水平方向の間隔を返します。

戻り値:
コンポーネント間の水平方向の間隔
導入されたバージョン:
JDK1.1
関連項目:
setHgap(int), getVgap()

setHgap

public void setHgap(int hgap)
コンポーネント間の水平方向の間隔を設定します。

パラメータ:
hgap - コンポーネント間の水平方向の間隔
導入されたバージョン:
JDK1.1
関連項目:
getHgap(), setVgap(int)

getVgap

public int getVgap()
コンポーネント間の垂直方向の間隔を返します。

戻り値:
コンポーネント間の垂直方向の間隔
関連項目:
setVgap(int), getHgap()

setVgap

public void setVgap(int vgap)
コンポーネント間の垂直方向の間隔を設定します。

パラメータ:
vgap - コンポーネント間の垂直方向の間隔
導入されたバージョン:
JDK1.1
関連項目:
getVgap(), setHgap(int)

addLayoutComponent

public void addLayoutComponent(Component comp,
                               Object constraints)
このカードレイアウト内部の名前テーブルに、指定されたコンポーネントを追加します。constraints によって指定されるオブジェクトは文字列でなければなりません。カードレイアウトはこの文字列を、特定のカードへのランダムアクセスに使用するキーと値のペアとして格納します。show メソッドを呼び出すことにより、アプリケーションは指定された名前のコンポーネントを表示できます。

定義:
インタフェース LayoutManager2 内の addLayoutComponent
パラメータ:
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 によって指定された文字列に関連付けます。

定義:
インタフェース LayoutManager 内の addLayoutComponent
パラメータ:
name - コンポーネントに関連付けられた文字列
comp - 追加されるコンポーネント

removeLayoutComponent

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

定義:
インタフェース LayoutManager 内の removeLayoutComponent
パラメータ:
comp - 削除される要素
関連項目:
Container.remove(java.awt.Component), Container.removeAll()

preferredLayoutSize

public Dimension preferredLayoutSize(Container parent)
このカードレイアウトを使用して、引数のコンテナの推奨サイズを判定します。

定義:
インタフェース LayoutManager 内の preferredLayoutSize
パラメータ:
parent - 配置が行われる親コンテナ
戻り値:
指定されたコンテナのサブコンポーネントを 配置するための望ましい寸法
関連項目:
Container.getPreferredSize(), minimumLayoutSize(java.awt.Container)

minimumLayoutSize

public Dimension minimumLayoutSize(Container parent)
指定されたパネルの最小サイズを算出します。

定義:
インタフェース LayoutManager 内の minimumLayoutSize
パラメータ:
parent - 配置が行われる親コンテナ
戻り値:
指定されたコンテナのサブコンポーネントを 配置するために必要な最小の寸法
関連項目:
Container.doLayout(), preferredLayoutSize(java.awt.Container)

maximumLayoutSize

public Dimension maximumLayoutSize(Container target)
指定されたターゲットコンテナの与えられたコンポーネントに対するレイアウトの最大サイズを返します。

定義:
インタフェース LayoutManager2 内の maximumLayoutSize
パラメータ:
target - レイアウトする必要があるコンポーネント
関連項目:
Container, minimumLayoutSize(java.awt.Container), preferredLayoutSize(java.awt.Container)

getLayoutAlignmentX

public float getLayoutAlignmentX(Container parent)
x 軸方向の配置を返します。これは、そのコンポーネントがほかのコンポーネントに対してどのように配置されるべきかを指定したものです。この値は 0 から 1 の間の数値で、0 は基点に沿った配置を表し、1 は基点からもっとも遠いところに、0.5 は中央に配置されます。

定義:
インタフェース LayoutManager2 内の getLayoutAlignmentX

getLayoutAlignmentY

public float getLayoutAlignmentY(Container parent)
y 軸方向の配置を返します。これは、そのコンポーネントがほかのコンポーネントに対してどのように配置されるべきかを指定したものです。この値は 0 から 1 の間の数値で、0 は基点に沿った配置を表し、1 は基点からもっとも遠いところに、0.5 は中央に配置されます。

定義:
インタフェース LayoutManager2 内の getLayoutAlignmentY

invalidateLayout

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

定義:
インタフェース LayoutManager2 内の invalidateLayout

layoutContainer

public void layoutContainer(Container parent)
このカードレイアウトを使用して、指定されたコンテナを配置します。  

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

定義:
インタフェース LayoutManager 内の layoutContainer
パラメータ:
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()
このカードレイアウトの状態を示す文字列表現を返します。

オーバーライド:
クラス Object 内の toString
戻り値:
このカードレイアウトの文字列表現

JavaTM Platform
Standard Ed. 6

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。