モジュール java.desktop

パッケージ javax.swing

クラスJDesktopPane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JLayeredPane

javax.swing.JDesktopPane

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

ImageObserver, MenuContainer, Serializable, Accessible

@JavaBean(defaultProperty="UI") public class JDesktopPane extends JLayeredPane implements Accessible

マルチドキュメント・インタフェースまたは仮想デスクトップを生成するコンテナです。 JInternalFrameオブジェクトを生成し、JDesktopPaneに追加します。 JDesktopPaneはJLayeredPaneを拡張し、オーバーラップの可能性がある内部フレームを管理します。 また、現在のルック・アンド・フィール (L&F)に対してUIクラスで設定されたDesktopManagerのインスタンスへの参照も維持します。 JDesktopPaneはボーダーをサポートしません。

このクラスは通常、JInternalFramesの親として使用され、プラグイン可能なDesktopManagerオブジェクトをJInternalFramesに提供します。 L&F別に実装されるinstallUIで、desktopManager変数を適切に設定します。 JInternalFrameの親がJDesktopPaneの場合、クローズやサイズ変更などの動作のほとんどをdesktopManagerに委譲します。

詳細と使用例については、「The Java Tutorial」の「How to Use Internal Frames」を参照してください。

警告: Swingはスレッドに対して安全ではありません。 詳細は、「Swing's Threading Policy」を参照してください。

警告: このクラスの直列化されたオブジェクトは、今後のSwingリリースと互換ではなくなる予定です。 現在の直列化のサポートは、短期間の格納や、同じバージョンのSwingを実行するアプリケーション間のRMIに適しています。 1.4では、すべてのJavaBeansの長期ストレージのサポートがjava.beansパッケージに追加されました。 XMLEncoderを参照してください。

導入されたバージョン:

1.2

関連項目:

• JInternalFrame
• JInternalFrame.JDesktopIcon
• DesktopManager

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	クラス	説明
protected class	JDesktopPane.AccessibleJDesktopPane	このクラスはJDesktopPaneクラスのアクセシビリティ・サポートを実装しています。

クラスjavax.swing.JLayeredPaneで宣言されたネストされたクラス/インタフェース

JLayeredPane.AccessibleJLayeredPane

クラスjavax.swing.JComponentで宣言されたネストされたクラス/インタフェース

JComponent.AccessibleJComponent

クラスjava.awt.Containerで宣言されたネストされたクラス/インタフェース

Container.AccessibleAWTContainer

クラスjava.awt.Componentで宣言されたネストされたクラス/インタフェース

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static final int	LIVE_DRAG_MODE	ドラッグの対象となっている項目のコンテンツ全体をデスクトップ・ペイン内に表示することを示します。
static final int	OUTLINE_DRAG_MODE	ドラッグの対象となっている項目のアウトラインだけをデスクトップ・ペイン内に表示することを示します。

クラスjavax.swing.JLayeredPaneで宣言されたフィールド

DEFAULT_LAYER, DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER

クラスjavax.swing.JComponentで宣言されたフィールド

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

クラスjava.awt.Componentで宣言されたフィールド

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

インタフェースjava.awt.image.ImageObserverで宣言されているフィールド

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

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

コンストラクタ

コンストラクタ	説明
JDesktopPane()	新しいJDesktopPaneを作成します。

メソッドのサマリー

修飾子と型	メソッド	説明
protected void	addImpl(Component comp, Object constraints, int index)	指定されたコンポーネントを、指定されたインデックスで、コンテナへ追加します。
AccessibleContext	getAccessibleContext()	このJDesktopPaneに関連付けられているAccessibleContextを取得します。
JInternalFrame[]	getAllFrames()	現在デスクトップに表示されているすべてのJInternalFramesを返します。
JInternalFrame[]	getAllFramesInLayer(int layer)	デスクトップの指定したレイヤーに現在表示されているすべてのJInternalFramesを返します。
DesktopManager	getDesktopManager()	デスクトップ固有のUIアクションを処理するDesktopMangerを返します。
int	getDragMode()	デスクトップ・ペインで現在使用されている「ドラッグ・スタイル」を取得します。
JInternalFrame	getSelectedFrame()	このJDesktopPaneの現在アクティブなJInternalFrameを返します。現在JInternalFrameがアクティブでない場合は、nullを返します。
DesktopPaneUI	getUI()	このコンポーネントをレンダリングするL&Fオブジェクトを返します。
String	getUIClassID()	このコンポーネントをレンダリングするL&Fクラスの名前を返します。
protected String	paramString()	このJDesktopPaneの文字列表現を返します。
void	remove(int index)	このペインからインデックス付きのコンポーネントを削除します。
void	removeAll()	このコンテナからすべてのコンポーネントを削除します。
JInternalFrame	selectFrame(boolean forward)	このデスクトップ・ペイン内の次のJInternalFrameを選択します。
void	setComponentZOrder(Component comp, int index)	指定されたコンポーネントを、コンテナの指定されたZ軸順のインデックスに移動します。
void	setDesktopManager(DesktopManager d)	デスクトップ固有のUIアクションを処理するDesktopMangerを設定します。
void	setDragMode(int dragMode)	デスクトップ・ペインで使用される「ドラッグ・スタイル」を設定します。
void	setSelectedFrame(JInternalFrame f)	このJDesktopPaneに現在アクティブなJInternalFrameを設定します。
void	setUI(DesktopPaneUI ui)	このコンポーネントをレンダリングするL&Fオブジェクトを設定します。
void	updateUI()	L&Fが変更されたことを示す、UIManagerからの通知です。

クラスjavax.swing.JLayeredPaneで宣言されたメソッド

getComponentCountInLayer, getComponentsInLayer, getComponentToLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getObjectForLayer, getPosition, highestLayer, insertIndexForLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paint, putLayer, setLayer, setLayer, setPosition

クラスjavax.swing.JComponentで宣言されたメソッド

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

クラスjava.awt.Containerで宣言されたメソッド

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeContainerListener, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

クラスjava.awt.Componentで宣言されたメソッド

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

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

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

フィールド詳細

LIVE_DRAG_MODE

public static final int LIVE_DRAG_MODE

ドラッグの対象となっている項目のコンテンツ全体をデスクトップ・ペイン内に表示することを示します。

関連項目:

• OUTLINE_DRAG_MODE
• setDragMode(int)
• 定数フィールド値

OUTLINE_DRAG_MODE

public static final int OUTLINE_DRAG_MODE

ドラッグの対象となっている項目のアウトラインだけをデスクトップ・ペイン内に表示することを示します。

関連項目:

• LIVE_DRAG_MODE
• setDragMode(int)
• 定数フィールド値

コンストラクタの詳細

JDesktopPane

public JDesktopPane()

新しいJDesktopPaneを作成します。

メソッドの詳細

getUI

public DesktopPaneUI getUI()

このコンポーネントをレンダリングするL&Fオブジェクトを返します。

オーバーライド:

クラスJComponentのgetUI

戻り値:

このコンポーネントをレンダリングするDesktopPaneUIオブジェクト

setUI

@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component\'s LookAndFeel.") public void setUI(DesktopPaneUI ui)

このコンポーネントをレンダリングするL&Fオブジェクトを設定します。

パラメータ:

ui - DesktopPaneUIのL&Fオブジェクト

関連項目:

• UIDefaults.getUI(javax.swing.JComponent)

setDragMode

@BeanProperty(enumerationValues={"JDesktopPane.LIVE_DRAG_MODE","JDesktopPane.OUTLINE_DRAG_MODE"}, description="Dragging style for internal frame children.") public void setDragMode(int dragMode)

デスクトップ・ペインで使用される「ドラッグ・スタイル」を設定します。 パフォーマンス上または表示上の理由で、別のモードに変更することができます。

パラメータ:

dragMode - デスクトップの項目に使用するドラッグのスタイル

導入されたバージョン:

1.3

関連項目:

• LIVE_DRAG_MODE
• OUTLINE_DRAG_MODE

getDragMode

public int getDragMode()

デスクトップ・ペインで現在使用されている「ドラッグ・スタイル」を取得します。

戻り値:

Live_DRAG_MODEまたはOUTLINE_DRAG_MODE

導入されたバージョン:

1.3

関連項目:

• setDragMode(int)

getDesktopManager

public DesktopManager getDesktopManager()

デスクトップ固有のUIアクションを処理するDesktopMangerを返します。

戻り値:

デスクトップ固有のUIアクションを処理するDesktopManger

setDesktopManager

@BeanProperty(description="Desktop manager to handle the internal frames in the desktop pane.") public void setDesktopManager(DesktopManager d)

デスクトップ固有のUIアクションを処理するDesktopMangerを設定します。 これをLookAndFeelでオーバーライドしてもかまいません。

パラメータ:

d - 使用するDesktopManager

updateUI

public void updateUI()

L&Fが変更されたことを示す、UIManagerからの通知です。 現在のUIオブジェクトをUIManagerの最新バージョンに置き換えます。

オーバーライド:

updateUI、クラスJComponent

関連項目:

• JComponent.updateUI()

getUIClassID

@BeanProperty(bound=false) public String getUIClassID()

このコンポーネントをレンダリングするL&Fクラスの名前を返します。

オーバーライド:

getUIClassID、クラスJComponent

戻り値:

DesktopPaneUIの文字列

関連項目:

• JComponent.getUIClassID()
• UIDefaults.getUI(javax.swing.JComponent)

getAllFrames

@BeanProperty(bound=false) public JInternalFrame[] getAllFrames()

現在デスクトップに表示されているすべてのJInternalFramesを返します。 展開表示されているフレームだけでなく、アイコン化されているフレームも返します。

戻り値:

JInternalFrameオブジェクトの配列

getSelectedFrame

public JInternalFrame getSelectedFrame()

このJDesktopPaneの現在アクティブなJInternalFrameを返します。現在JInternalFrameがアクティブでない場合は、nullを返します。

戻り値:

現在アクティブなJInternalFrameまたはnull

導入されたバージョン:

1.3

setSelectedFrame

public void setSelectedFrame(JInternalFrame f)

このJDesktopPaneに現在アクティブなJInternalFrameを設定します。 このメソッドは、JDesktopPaneとプラットフォーム実装コード間のパッケージのギャップを埋め合わせるために使用されます。直接呼び出さないでください。 フレームを視覚的に選択するために、クライアントはJInternalFrame.setSelected(true)を呼び出してフレームをアクティブにする必要があります。

パラメータ:

f - 現在選択されている内部フレーム

導入されたバージョン:

1.3

関連項目:

• JInternalFrame.setSelected(boolean)

getAllFramesInLayer

public JInternalFrame[] getAllFramesInLayer(int layer)

デスクトップの指定したレイヤーに現在表示されているすべてのJInternalFramesを返します。 展開表示されているフレームだけでなく、アイコン化されているフレームも返します。

パラメータ:

layer - デスクトップ・レイヤーを指定する整数値

戻り値:

JInternalFrameオブジェクトの配列

関連項目:

• JLayeredPane

selectFrame

public JInternalFrame selectFrame(boolean forward)

このデスクトップ・ペイン内の次のJInternalFrameを選択します。

パラメータ:

forward - 選択する方向を示すboolean値。前方の場合はtrue、後方の場合はfalse

戻り値:

選択されたJInternalFrame。何も選択されなかった場合はnull

導入されたバージョン:

1.6

addImpl

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

指定されたコンポーネントを、指定されたインデックスで、コンテナへ追加します。 また、このメソッドは、addLayoutComponentメソッドを使用して、指定された制約オブジェクトを使ってこのコンテナのレイアウトにコンポーネントを追加することをレイアウト・マネージャに通知します。

制約は、使用されているレイアウト・マネージャで定義されます。 たとえばBorderLayoutクラスは、BorderLayout.NORTH、BorderLayout.SOUTH、BorderLayout.EAST、BorderLayout.WEST、およびBorderLayout.CENTERの5つの制約を定義します。

GridBagLayoutクラスにはGridBagConstraintsオブジェクトが必要です。 正しい型の制約オブジェクトを渡さないと、IllegalArgumentExceptionが発生します。

現在のレイアウト・マネージャがLayoutManager2を実装する場合は、LayoutManager2.addLayoutComponent(Component,Object)が呼び出されます。 現在のレイアウト・マネージャがLayoutManager2を実装せず、制約がStringの場合は、LayoutManager.addLayoutComponent(String,Component)が呼び出されます。

コンポーネントがこのコンテナの祖先ではなく、nullでない親を持つ場合は、このコンテナに追加される前に現在の親から削除されます。

これは、プログラムがコンテナへのすべての追加要求を追跡する必要がある場合にオーバーライドするメソッドです。他のすべての追加メソッドはこれに従います。 オーバーライドするメソッドには、通常、メソッドのスーパークラス・バージョンへの呼出しを含めるようにしてください。

super.addImpl(comp, constraints, index)

このメソッドではレイアウトに関連する情報が変更されるため、コンポーネント階層が無効になります。 コンテナがすでに表示されている場合は、追加されたコンポーネントを表示するために、あとで階層を検証する必要があります。

オーバーライド:

addImpl、クラスContainer

パラメータ:

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

constraints - このコンポーネントのレイアウト制約を表現するオブジェクト

index - コンポーネントを挿入するコンテナのリスト内での位置。-1は最後に挿入することを意味する

導入されたバージョン:

1.6

関連項目:

• Container.add(Component)
• Container.add(Component, int)
• Container.add(Component, java.lang.Object)
• Container.invalidate()
• LayoutManager
• LayoutManager2

remove

public void remove(int index)

このペインからインデックス付きのコンポーネントを削除します。 絶対インデックスであり、レイヤーは無視します。

オーバーライド:

remove、クラスJLayeredPane

パラメータ:

index - 削除するコンポーネントを指定したint値

導入されたバージョン:

1.6

関連項目:

• JLayeredPane.getIndexOf(java.awt.Component)

removeAll

public void removeAll()

このコンテナからすべてのコンポーネントを削除します。

オーバーライド:

removeAll、クラスJLayeredPane

導入されたバージョン:

1.6

関連項目:

• Container.add(java.awt.Component)
• Container.remove(int)
• Container.invalidate()

setComponentZOrder

public void setComponentZOrder(Component comp, int index)

指定されたコンポーネントを、コンテナの指定されたZ軸順のインデックスに移動します。 Z軸順によって、コンポーネントがペイントされる順番が決まります。Z軸順が最高のコンポーネントが最初にペイントされ、Z軸順が最低のコンポーネントが最後にペイントされます。 コンポーネントがオーバーラップされる場合、Z軸順の低いコンポーネントがZ軸順の高いコンポーネントの上にペイントされます。

コンポーネントがほかのコンテナの子である場合、このコンテナに追加される前にそのコンテナから削除されます。 このメソッドとjava.awt.Container.add(Component, int)の違いは、前のコンテナから削除される際に、必要でないかぎり、またベースとなるネィティブ・ウィンドウ・システムによって許可されているかぎり、このメソッドがコンポーネントに対してremoveNotifyを呼び出さないことです。 このように、コンポーネントにキーボード・フォーカスがある場合、そのコンポーネントが新しい位置に移動されてもフォーカスを維持します。

このプロパティは軽量のContainer以外のコンポーネントのみに適用されます。

このメソッドではレイアウトに関連する情報が変更されるため、コンポーネント階層が無効になります。

ノート: removeNotifyを呼び出さずに、別のコンテナへの重量コンポーネントのZ軸順の変更をサポートしていないプラットフォームもあります。 プラットフォームでこれがサポートされているかどうかを判断する方法はないため、開発者は推測しないようにしてください。

オーバーライド:

setComponentZOrder、クラスContainer

パラメータ:

comp - 移動されるコンポーネント

index - コンポーネントを挿入するコンテナのリスト内での位置。getComponentCount()は末尾に挿入することを意味する

導入されたバージョン:

1.6

関連項目:

• Container.getComponentZOrder(java.awt.Component)
• Container.invalidate()

paramString

protected String paramString()

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

オーバーライド:

paramString、クラスJLayeredPane

戻り値:

このJDesktopPaneの文字列表現

getAccessibleContext

@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()

このJDesktopPaneに関連付けられているAccessibleContextを取得します。 AccessibleContextはデスクトップ・ペインのフォームをAccessibleJDesktopPaneから取得します。 必要に応じて、新しいAccessibleJDesktopPaneインスタンスが作成されます。

定義:

getAccessibleContext、インタフェースAccessible

オーバーライド:

getAccessibleContext、クラスJLayeredPane

戻り値:

このJDesktopPaneのAccessibleContextとして機能するAccessibleJDesktopPane