javax.swing
クラス JFrame

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame

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

Accessible, ImageObserver, MenuContainer, RootPaneContainer, Serializable, WindowConstants

public class JFrame

extends Frame

implements WindowConstants, Accessible, RootPaneContainer

JFC/Swing コンポーネントアーキテクチャのサポートを強化する java.awt.Frame の拡張バージョンです。JFrame の使用に関するタスク指向のドキュメントについては「The Java Tutorial」の「How to Make Frames」を参照してください。

JFrame クラスは Frame と多少互換性のないところがあります。ほかのすべての JFC/Swing トップレベルコンテナと同様、JFrame は JRootPane を唯一の子として保持します。原則として、ルート区画が提供するコンテンツ区画には JFrame が表示するメニュー以外のすべてのコンポーネントが含まれる必要があります。この点は AWT の Frame の場合とは異なります。たとえば、AWT のフレームに子を追加するには、次のように記述します。

       frame.add(child);

しかし、JFrame を使う場合は、次のように JFrame のコンテンツ区画に子を追加する必要があります。

       frame.getContentPane().add(child);

レイアウトマネージャの設定、コンポーネントの削除、子のリスト表示などについても同様です。これらのメソッドは、通常すべて JFrame 自体ではなくコンテンツ区画に送る必要があります。コンテンツ区画は常に null 以外です。null に設定しようとすると JFrame は例外をスローします。デフォルトのコンテンツ区画には、BorderLayout マネージャが設定されます。

Frame とは異なり、JFrame にはユーザがウィンドウを閉じようとしたときにどのように対応するかという概念があります。デフォルトの動作は、ユーザがウィンドウを閉じたら単に JFrame を隠すというものです。デフォルト動作を変更するには、メソッド setDefaultCloseOperation(int) を呼び出します。JFrame を Frame インスタンスと同じように動作させるには、setDefaultCloseOperation(WindowConstants.DO_NOTHING_ON_CLOSE) を使用します。

コンテンツ区画の詳細、およびルート区画が提供するその他の機能の詳細については、「The Java Tutorial」の「Using Top-Level Containers」を参照してください。

マルチスクリーン環境の場合には、異なった画面デバイス上で JFrame を生成できます。詳細は、Frame を参照してください。

標準の Look & Feel (L&F) 表現でこのコンポーネントが使用するキーボードのキーについては、JFrame のキーの割り当てを参照してください。

警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。今後の Swing リリースでは、長期間の持続性をサポートする予定です。

関連項目:

JRootPane, setDefaultCloseOperation(int), WindowListener.windowClosing(java.awt.event.WindowEvent), 直列化された形式

内部クラスの概要

protected class

JFrame.AccessibleJFrame このクラスは JFrame クラス用のユーザ補助機能のサポートを実装しています。

クラス java.awt.Frame から継承した内部クラス

Frame.AccessibleAWTFrame

クラス java.awt.Window から継承した内部クラス

Window.AccessibleAWTWindow

クラス java.awt.Container から継承した内部クラス

Container.AccessibleAWTContainer

クラス java.awt.Component から継承した内部クラス

Component.AccessibleAWTComponent

フィールドの概要

protected AccessibleContext	accessibleContext ユーザ補助機能のコンテキストプロパティです。
static int	EXIT_ON_CLOSE 終了するアプリケーションのデフォルトのウィンドウにクローズオペレーションです。
protected JRootPane	rootPane glassPane だけでなく、このフレームの contentPane およびオプションの menuBar を管理する JRootPane のインスタンスです。
protected boolean	rootPaneCheckingEnabled true の場合、add および setLayout を呼び出すと例外がスローされます。

クラス java.awt.Frame から継承したフィールド

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

クラス java.awt.Component から継承したフィールド

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

インタフェース javax.swing.WindowConstants から継承したフィールド

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

インタフェース java.awt.image.ImageObserver から継承したフィールド

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

コンストラクタの概要

JFrame()
初期状態が不可視である、新しい Frame を構築します。

JFrame(GraphicsConfiguration gc)
Frame を、画面デバイスの指定された GraphicsConfiguration にタイトルなしで作成します。

JFrame(String title)
指定されたタイトルで、初期状態で不可視の新しい Frame を構築します。

JFrame(String title, GraphicsConfiguration gc)
Frame を、指定されたタイトルで、画面デバイスの指定された GraphicsConfiguration に作成します。

メソッドの概要

protected void	addImpl(Component comp, Object constraints, int index) デフォルトでは、子はこのコンポーネントに直接追加できず、代わりに contentPane に追加されなければなりません。
protected JRootPane	createRootPane() コンストラクタメソッドによって呼び出され、デフォルトの rootPane を作成します。
protected void	frameInit() JFrame を適切に初期化するためにコンストラクタによって呼び出されます。
AccessibleContext	getAccessibleContext() この JFrame に関連した AccessibleContext を返します。
Container	getContentPane() このフレームの contentPane オブジェクトを返します。
int	getDefaultCloseOperation() ユーザがこのフレームで「クローズ」を開始したときに実行される処理を返します。
Component	getGlassPane() このフレームの glassPane オブジェクトを返します。
JMenuBar	getJMenuBar() このフレームに設定されているメニューバーを返します。
JLayeredPane	getLayeredPane() このフレームの layeredPane オブジェクトを返します。
JRootPane	getRootPane() このフレームの rootPane オブジェクトを返します。
protected boolean	isRootPaneCheckingEnabled() add および setLayout の呼び出しが例外をスローするかどうかを返します。
protected String	paramString() この JFrame の文字列表現を返します。
protected void	processKeyEvent(KeyEvent e) このコンポーネントで発生するキーイベントを処理し、必要な場合にはイベントを、キーイベントの通知を登録しているフレーム内のコンポーネントに渡します。
protected void	processWindowEvent(WindowEvent e) このコンポーネントで発生するウィンドウイベントを処理します。
void	remove(Component comp) コンテナから、指定されたコンポーネントを削除します。
void	setContentPane(Container contentPane) contentPane プロパティを設定します。
void	setDefaultCloseOperation(int operation) ユーザがこのフレームの「クローズ」を開始したときに、デフォルトで実行される処理を設定します。
void	setGlassPane(Component glassPane) glassPane プロパティを設定します。
void	setJMenuBar(JMenuBar menubar) このフレームのメニューバーを設定します。
void	setLayeredPane(JLayeredPane layeredPane) layeredPane プロパティを設定します。
void	setLayout(LayoutManager manager) デフォルトでは、このコンポーネントのレイアウトは設定できず、代わりに、contentPane のレイアウトを設定しなければなりません。
protected void	setRootPane(JRootPane root) rootPane プロパティを設定します。
protected void	setRootPaneCheckingEnabled(boolean enabled) add および setLayout の呼び出しが例外をスローするかどうかを設定します。
void	update(Graphics g) paint(g) を呼び出します。

クラス java.awt.Frame から継承したメソッド

addNotify, finalize, getCursorType, getFrames, getIconImage, getMenuBar, getState, getTitle, isResizable, remove, removeNotify, setCursor, setIconImage, setMenuBar, setResizable, setState, setTitle

クラス java.awt.Window から継承したメソッド

addWindowListener, applyResourceBundle, applyResourceBundle, dispose, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, hide, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, show, toBack, toFront

クラス java.awt.Container から継承したメソッド

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFont, validate, validateTree

クラス java.awt.Component から継承したメソッド

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus

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

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

インタフェース java.awt.MenuContainer から継承したメソッド

getFont, postEvent

フィールドの詳細

EXIT_ON_CLOSE

public static final int EXIT_ON_CLOSE

終了するアプリケーションのデフォルトのウィンドウにクローズオペレーションです。ウィンドウにクローズオペレーションとしてこのフィールドが設定されている場合、アプレットでクローズすると、SecurityException がスローされます。このオペレーションはアプリケーションだけで使用することをお勧めします。

導入されたバージョン:

1.3

rootPane

protected JRootPane rootPane

glassPane だけでなく、このフレームの contentPane およびオプションの menuBar を管理する JRootPane のインスタンスです。

関連項目:

JRootPane, RootPaneContainer

rootPaneCheckingEnabled

protected boolean rootPaneCheckingEnabled

true の場合、add および setLayout を呼び出すと例外がスローされます。デフォルトは false です。

関連項目:

isRootPaneCheckingEnabled(), setRootPaneCheckingEnabled(boolean)

accessibleContext

protected AccessibleContext accessibleContext

ユーザ補助機能のコンテキストプロパティです。

コンストラクタの詳細

JFrame

public JFrame()

初期状態が不可視である、新しい Frame を構築します。

関連項目:

Component.setSize(int, int), Component.setVisible(boolean)

JFrame

public JFrame(GraphicsConfiguration gc)

Frame を、画面デバイスの指定された GraphicsConfiguration にタイトルなしで作成します。

パラメータ:

gc - 新しい Frame を構築するために使用される GraphicsConfiguration。gc が null の場合は、システムのデフォルトは、GraphicsConfiguration と考えられる

例外:

IllegalArgumentException - gc が画面デバイスで指定されたものでない場合

導入されたバージョン:

1.3

JFrame

public JFrame(String title)

指定されたタイトルで、初期状態で不可視の新しい Frame を構築します。

パラメータ:

title - フレームのタイトル

関連項目:

Component.setSize(int, int), Component.setVisible(boolean)

JFrame

public JFrame(String title,
              GraphicsConfiguration gc)

Frame を、指定されたタイトルで、画面デバイスの指定された GraphicsConfiguration に作成します。

パラメータ:

title - フレームのボーダに表示されるタイトル。null 値は空の文字列 "" として扱われる

gc - 新しい JFrame を構築するために使用される GraphicsConfiguration。gc が null の場合、システムのデフォルトは、GraphicsConfiguration と考えられる

例外:

IllegalArgumentException - gc が画面デバイスで指定されたものでない場合

導入されたバージョン:

1.3

メソッドの詳細

frameInit

protected void frameInit()

JFrame を適切に初期化するためにコンストラクタによって呼び出されます。

createRootPane

protected JRootPane createRootPane()

コンストラクタメソッドによって呼び出され、デフォルトの rootPane を作成します。

processKeyEvent

protected void processKeyEvent(KeyEvent e)

このコンポーネントで発生するキーイベントを処理し、必要な場合にはイベントを、キーイベントの通知を登録しているフレーム内のコンポーネントに渡します。

オーバーライド:

クラス Component 内の processKeyEvent

パラメータ:

e - キーイベント

関連項目:

Component.processKeyEvent(java.awt.event.KeyEvent)

processWindowEvent

protected void processWindowEvent(WindowEvent e)

このコンポーネントで発生するウィンドウイベントを処理します。defaultCloseOperation プロパティの設定値に従って、ウィンドウを非表示にするか、または破棄します。

オーバーライド:

クラス Window 内の processWindowEvent

パラメータ:

e - ウィンドウイベント

関連項目:

setDefaultCloseOperation(int), Window.processWindowEvent(java.awt.event.WindowEvent)

setDefaultCloseOperation

public void setDefaultCloseOperation(int operation)

ユーザがこのフレームの「クローズ」を開始したときに、デフォルトで実行される処理を設定します。以下のうち 1 つを指定する必要があります。

• DO_NOTHING_ON_CLOSE （WindowConstants に定義): 何も行わない。プログラムは登録されている WindowListener オブジェクトの windowClosing メソッドで処理を行う必要がある
• HIDE_ON_CLOSE （WindowConstants に定義): 登録されている任意の WindowListener オブジェクトを呼び出したあとで、自動的にフレームを隠す
• DISPOSE_ON_CLOSE （WindowConstants に定義): 登録されている任意の WindowListener オブジェクトを呼び出したあとで、自動的にフレームを隠して破棄する
• EXIT_ON_CLOSE （JFrame に定義): System の exit メソッドを使用してアプリケーションを終了する。アプリケーションでのみ使用

デフォルトでは HIDE_ON_CLOSE が設定されます。

関連項目:

Window.addWindowListener(java.awt.event.WindowListener), getDefaultCloseOperation(), WindowConstants

getDefaultCloseOperation

public int getDefaultCloseOperation()

ユーザがこのフレームで「クローズ」を開始したときに実行される処理を返します。

戻り値:

ウィンドウクローズオペレーションを示す int 値

関連項目:

setDefaultCloseOperation(int)

update

public void update(Graphics g)

paint(g) を呼び出します。このメソッドは、バックグラウンドをクリアする不必要な呼び出しが行われないようにするためにオーバーライドされました。

オーバーライド:

クラス Container 内の update

パラメータ:

g - ペイント先となる Graphics コンテキスト

setJMenuBar

public void setJMenuBar(JMenuBar menubar)

このフレームのメニューバーを設定します。

パラメータ:

menubar - フレーム内に配置されているメニューバー

関連項目:

getJMenuBar()

getJMenuBar

public JMenuBar getJMenuBar()

このフレームに設定されているメニューバーを返します。

戻り値:

このフレームのメニューバー

関連項目:

setJMenuBar(javax.swing.JMenuBar)

isRootPaneCheckingEnabled

protected boolean isRootPaneCheckingEnabled()

add および setLayout の呼び出しが例外をスローするかどうかを返します。

戻り値:

add および setLayout が調べられる場合は true、そうでない場合は false

関連項目:

addImpl(java.awt.Component, java.lang.Object, int), setLayout(java.awt.LayoutManager), setRootPaneCheckingEnabled(boolean)

setRootPaneCheckingEnabled

protected void setRootPaneCheckingEnabled(boolean enabled)

add および setLayout の呼び出しが例外をスローするかどうかを設定します。

パラメータ:

enabled - 調査を有効にして例外をスローする場合は、true

関連項目:

addImpl(java.awt.Component, java.lang.Object, int), setLayout(java.awt.LayoutManager), isRootPaneCheckingEnabled()

addImpl

protected void addImpl(Component comp,
                       Object constraints,
                       int index)

デフォルトでは、子はこのコンポーネントに直接追加できず、代わりに contentPane に追加されなければなりません。次に例を示します。

 thisComponent.getContentPane().add(child)

このコンポーネントに直接追加しようとすると、実行時例外がスローされます。サブクラスはこの動作を無効にできます。

オーバーライド:

クラス Container 内の addImpl

パラメータ:

comp - 拡張されるコンポーネント

constraints - 遵守されるべき制約

index - インデックス

例外:

Error - rootPaneChecking で呼び出された場合は true

関連項目:

setRootPaneCheckingEnabled(boolean)

remove

public void remove(Component comp)

コンテナから、指定されたコンポーネントを削除します。

オーバーライド:

クラス Container 内の remove

パラメータ:

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

関連項目:

Container.add(java.awt.Component)

setLayout

public void setLayout(LayoutManager manager)

デフォルトでは、このコンポーネントのレイアウトは設定できず、代わりに、contentPane のレイアウトを設定しなければなりません。次に例を示します。

 thiComponent.getContentPane().setLayout(new BorderLayout())

このコンポーネントのレイアウトを設定しようとすると、実行時例外がスローされます。サブクラスはこの動作を無効にできます。

オーバーライド:

クラス Container 内の setLayout

パラメータ:

manager - LayoutManager

例外:

Error - rootPaneChecking で呼び出された場合は、true

関連項目:

setRootPaneCheckingEnabled(boolean)

getRootPane

public JRootPane getRootPane()

このフレームの rootPane オブジェクトを返します。

定義:

インタフェース RootPaneContainer 内の getRootPane

戻り値:

rootPane プロパティ

関連項目:

setRootPane(javax.swing.JRootPane), RootPaneContainer.getRootPane()

setRootPane

protected void setRootPane(JRootPane root)

rootPane プロパティを設定します。このメソッドはコンストラクタによって呼び出されます。

パラメータ:

root - このフレームの rootPane オブジェクト

関連項目:

getRootPane()

getContentPane

public Container getContentPane()

このフレームの contentPane オブジェクトを返します。

定義:

インタフェース RootPaneContainer 内の getContentPane

戻り値:

contentPane プロパティ

関連項目:

setContentPane(java.awt.Container), RootPaneContainer.getContentPane()

setContentPane

public void setContentPane(Container contentPane)

contentPane プロパティを設定します。このメソッドはコンストラクタによって呼び出されます。

定義:

インタフェース RootPaneContainer 内の setContentPane

パラメータ:

contentPane - このフレームの contentPane オブジェクト

例外:

IllegalComponentStateException - コンテンツ区画パラメータが null の場合 (実行時例外)

関連項目:

getContentPane(), RootPaneContainer.setContentPane(java.awt.Container)

getLayeredPane

public JLayeredPane getLayeredPane()

このフレームの layeredPane オブジェクトを返します。

定義:

インタフェース RootPaneContainer 内の getLayeredPane

戻り値:

layeredPane プロパティ

関連項目:

setLayeredPane(javax.swing.JLayeredPane), RootPaneContainer.getLayeredPane()

setLayeredPane

public void setLayeredPane(JLayeredPane layeredPane)

layeredPane プロパティを設定します。このメソッドはコンストラクタによって呼び出されます。

定義:

インタフェース RootPaneContainer 内の setLayeredPane

パラメータ:

layeredPane - このフレームの layeredPane オブジェクト

例外:

IllegalComponentStateException - 階層化区画パラメータが null の場合 (実行時例外)

関連項目:

getLayeredPane(), RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)

getGlassPane

public Component getGlassPane()

このフレームの glassPane オブジェクトを返します。

定義:

インタフェース RootPaneContainer 内の getGlassPane

戻り値:

glassPane プロパティ

関連項目:

setGlassPane(java.awt.Component), RootPaneContainer.getGlassPane()

setGlassPane

public void setGlassPane(Component glassPane)

glassPane プロパティを設定します。このメソッドはコンストラクタによって呼び出されます。

定義:

インタフェース RootPaneContainer 内の setGlassPane

パラメータ:

glassPane - このフレームの glassPane オブジェクト

関連項目:

getGlassPane(), RootPaneContainer.setGlassPane(java.awt.Component)

paramString

protected String paramString()

この JFrame の文字列表現を返します。このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なります。返される文字列は空の場合がありますが、null にはなりません。

オーバーライド:

クラス Frame 内の paramString

戻り値:

この JFrame の文字列表現

getAccessibleContext

public AccessibleContext getAccessibleContext()

この JFrame に関連した AccessibleContext を返します。JFrame の場合、AccessibleContext は AccessibleJFrame の形式を取ります。必要に応じて新規の AccessibleJFrame インスタンスが作成されます。

定義:

インタフェース Accessible 内の getAccessibleContext

オーバーライド:

クラス Frame 内の getAccessibleContext

戻り値:

この JFrame の AccessibleContext として機能する AccessibleJFrame