Class JInternalFrame

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JInternalFrame

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

@JavaBean(defaultProperty="JMenuBar",
          description="A frame container which is contained within another window.")
public class JInternalFrame
extends JComponent
implements Accessible, WindowConstants, RootPaneContainer

A lightweight object that provides many of the features of a native frame, including dragging, closing, becoming an icon, resizing, title display, and support for a menu bar. For task-oriented documentation and examples of using internal frames, see How to Use Internal Frames, a section in The Java Tutorial.

Generally, you add JInternalFrames to a JDesktopPane. The UI delegates the look-and-feel-specific actions to the DesktopManager object maintained by the JDesktopPane.

The JInternalFrame content pane is where you add child components. As a convenience, the add, remove, and setLayout methods of this class are overridden, so that they delegate calls to the corresponding methods of the ContentPane. For example, you can add a child component to an internal frame as follows:

       internalFrame.add(child);
 

And the child will be added to the contentPane. The content pane is actually managed by an instance of JRootPane, which also manages a layout pane, glass pane, and optional menu bar for the internal frame. Please see the JRootPane documentation for a complete description of these components. Refer to RootPaneContainer for details on adding, removing and setting the LayoutManager of a JInternalFrame.

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans has been added to the java.beans package. Please see XMLEncoder.

Since:

1.2

See Also:

• InternalFrameEvent
• JDesktopPane
• DesktopManager
• JInternalFrame.JDesktopIcon
• JRootPane
• RootPaneContainer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JInternalFrame.AccessibleJInternalFrame	This class implements accessibility support for the JInternalFrame class.
static class	JInternalFrame.JDesktopIcon	This component represents an iconified version of a JInternalFrame.

Nested classes/interfaces declared in class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces declared in class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces declared in class java.awt.Component

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

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	closable	The frame can be closed.
static final String	CONTENT_PANE_PROPERTY	Bound property name.
protected JInternalFrame.JDesktopIcon	desktopIcon	The icon that is displayed when this internal frame is iconified.
static final String	FRAME_ICON_PROPERTY	Bound property name.
protected Icon	frameIcon	The icon shown in the top-left corner of this internal frame.
static final String	GLASS_PANE_PROPERTY	Bound property name.
protected boolean	iconable	The frame can "iconified" (shrunk down and displayed as an icon-image).
static final String	IS_CLOSED_PROPERTY	Constrained property name indicating that the internal frame is closed.
static final String	IS_ICON_PROPERTY	Constrained property name indicating that the internal frame is iconified.
static final String	IS_MAXIMUM_PROPERTY	Constrained property name indicating that the internal frame is maximized.
static final String	IS_SELECTED_PROPERTY	Constrained property name indicated that this frame has selected status.
protected boolean	isClosed	The frame has been closed.
protected boolean	isIcon	The frame has been iconified.
protected boolean	isMaximum	The frame has been expanded to its maximum size.
protected boolean	isSelected	The frame is currently selected.
static final String	LAYERED_PANE_PROPERTY	Bound property name.
protected boolean	maximizable	The frame can be expanded to the size of the desktop pane.
static final String	MENU_BAR_PROPERTY	Bound property name.
protected boolean	resizable	The frame's size can be changed.
static final String	ROOT_PANE_PROPERTY	Bound property name.
protected JRootPane	rootPane	The JRootPane instance that manages the content pane and optional menu bar for this internal frame, as well as the glass pane.
protected boolean	rootPaneCheckingEnabled	If true then calls to add and setLayout will be forwarded to the contentPane.
protected String	title	The title displayed in this internal frame's title bar.
static final String	TITLE_PROPERTY	Bound property name.

Fields declared in class javax.swing.JComponent

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

Fields declared in class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields declared in interface java.awt.image.ImageObserver

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

Fields declared in interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Constructor	Description
JInternalFrame()	Creates a non-resizable, non-closable, non-maximizable, non-iconifiable JInternalFrame with no title.
JInternalFrame(String title)	Creates a non-resizable, non-closable, non-maximizable, non-iconifiable JInternalFrame with the specified title.
JInternalFrame(String title, boolean resizable)	Creates a non-closable, non-maximizable, non-iconifiable JInternalFrame with the specified title and resizability.
JInternalFrame(String title, boolean resizable, boolean closable)	Creates a non-maximizable, non-iconifiable JInternalFrame with the specified title, resizability, and closability.
JInternalFrame(String title, boolean resizable, boolean closable, boolean maximizable)	Creates a non-iconifiable JInternalFrame with the specified title, resizability, closability, and maximizability.
JInternalFrame(String title, boolean resizable, boolean closable, boolean maximizable, boolean iconifiable)	Creates a JInternalFrame with the specified title, resizability, closability, maximizability, and iconifiability.

Method Summary

Modifier and Type	Method	Description
protected void	addImpl(Component comp, Object constraints, int index)	Adds the specified child Component.
void	addInternalFrameListener(InternalFrameListener l)	Adds the specified listener to receive internal frame events from this internal frame.
protected JRootPane	createRootPane()	Called by the constructor to set up the JRootPane.
void	dispose()	Makes this internal frame invisible, unselected, and closed.
void	doDefaultCloseAction()	Fires an INTERNAL_FRAME_CLOSING event and then performs the action specified by the internal frame's default close operation.
protected void	fireInternalFrameEvent(int id)	Fires an internal frame event.
AccessibleContext	getAccessibleContext()	Gets the AccessibleContext associated with this JInternalFrame.
Container	getContentPane()	Returns the content pane for this internal frame.
int	getDefaultCloseOperation()	Returns the default operation that occurs when the user initiates a "close" on this internal frame.
JInternalFrame.JDesktopIcon	getDesktopIcon()	Returns the JDesktopIcon used when this JInternalFrame is iconified.
JDesktopPane	getDesktopPane()	Convenience method that searches the ancestor hierarchy for a JDesktop instance.
final Container	getFocusCycleRootAncestor()	Always returns null because JInternalFrames must always be roots of a focus traversal cycle.
Component	getFocusOwner()	If this JInternalFrame is active, returns the child that has focus.
Icon	getFrameIcon()	Returns the image displayed in the title bar of this internal frame (usually in the top-left corner).
Component	getGlassPane()	Returns the glass pane for this internal frame.
InternalFrameListener[]	getInternalFrameListeners()	Returns an array of all the InternalFrameListeners added to this JInternalFrame with addInternalFrameListener.
JMenuBar	getJMenuBar()	Returns the current JMenuBar for this JInternalFrame, or null if no menu bar has been set.
Cursor	getLastCursor()	Returns the last Cursor that was set by the setCursor method that is not a resizable Cursor.
int	getLayer()	Convenience method for getting the layer attribute of this component.
JLayeredPane	getLayeredPane()	Returns the layered pane for this internal frame.
JMenuBar	getMenuBar()	Deprecated. As of Swing version 1.0.3, replaced by getJMenuBar().
Component	getMostRecentFocusOwner()	Returns the child component of this JInternalFrame that will receive the focus when this JInternalFrame is selected.
Rectangle	getNormalBounds()	If the JInternalFrame is not in maximized state, returns getBounds(); otherwise, returns the bounds that the JInternalFrame would be restored to.
JRootPane	getRootPane()	Returns the rootPane object for this internal frame.
String	getTitle()	Returns the title of the JInternalFrame.
InternalFrameUI	getUI()	Returns the look-and-feel object that renders this component.
String	getUIClassID()	Returns the name of the look-and-feel class that renders this component.
final String	getWarningString()	Deprecated, for removal: This API element is subject to removal in a future version. since JDK 24
void	hide()
boolean	isClosable()	Returns whether this JInternalFrame can be closed by some user action.
boolean	isClosed()	Returns whether this JInternalFrame is currently closed.
final boolean	isFocusCycleRoot()	Always returns true because all JInternalFrames must be roots of a focus traversal cycle.
boolean	isIcon()	Returns whether the JInternalFrame is currently iconified.
boolean	isIconifiable()	Gets the iconable property, which by default is false.
boolean	isMaximizable()	Gets the value of the maximizable property.
boolean	isMaximum()	Returns whether the JInternalFrame is currently maximized.
boolean	isResizable()	Returns whether the JInternalFrame can be resized by some user action.
protected boolean	isRootPaneCheckingEnabled()	Returns whether calls to add and setLayout are forwarded to the contentPane.
boolean	isSelected()	Returns whether the JInternalFrame is the currently "selected" or active frame.
void	moveToBack()	Convenience method that moves this component to position -1 if its parent is a JLayeredPane.
void	moveToFront()	Convenience method that moves this component to position 0 if its parent is a JLayeredPane.
void	pack()	Causes subcomponents of this JInternalFrame to be laid out at their preferred size.
protected void	paintComponent(Graphics g)	Overridden to allow optimized painting when the internal frame is being dragged.
protected String	paramString()	Returns a string representation of this JInternalFrame.
void	remove(Component comp)	Removes the specified component from the container.
void	removeInternalFrameListener(InternalFrameListener l)	Removes the specified internal frame listener so that it no longer receives internal frame events from this internal frame.
void	reshape(int x, int y, int width, int height)	Moves and resizes this component.
void	restoreSubcomponentFocus()	Requests the internal frame to restore focus to the last subcomponent that had focus.
void	setClosable(boolean b)	Sets whether this JInternalFrame can be closed by some user action.
void	setClosed(boolean b)	Closes this internal frame if the argument is true.
void	setContentPane(Container c)	Sets this JInternalFrame's contentPane property.
void	setCursor(Cursor cursor)	Sets the cursor image to the specified cursor.
void	setDefaultCloseOperation(int operation)	Sets the operation that will happen by default when the user initiates a "close" on this internal frame.
void	setDesktopIcon(JInternalFrame.JDesktopIcon d)	Sets the JDesktopIcon associated with this JInternalFrame.
final void	setFocusCycleRoot(boolean focusCycleRoot)	Does nothing because JInternalFrames must always be roots of a focus traversal cycle.
void	setFrameIcon(Icon icon)	Sets an image to be displayed in the titlebar of this internal frame (usually in the top-left corner).
void	setGlassPane(Component glass)	Sets this JInternalFrame's glassPane property.
void	setIcon(boolean b)	Iconifies or de-iconifies this internal frame, if the look and feel supports iconification.
void	setIconifiable(boolean b)	Sets the iconable property, which must be true for the user to be able to make the JInternalFrame an icon.
void	setJMenuBar(JMenuBar m)	Sets the menuBar property for this JInternalFrame.
void	setLayer(int layer)	Convenience method for setting the layer attribute of this component.
void	setLayer(Integer layer)	Convenience method for setting the layer attribute of this component.
void	setLayeredPane(JLayeredPane layered)	Sets this JInternalFrame's layeredPane property.
void	setLayout(LayoutManager manager)	Ensures that, by default, the layout of this component cannot be set.
void	setMaximizable(boolean b)	Sets the maximizable property, which determines whether the JInternalFrame can be maximized by some user action.
void	setMaximum(boolean b)	Maximizes and restores this internal frame.
void	setMenuBar(JMenuBar m)	Deprecated. As of Swing version 1.0.3 replaced by setJMenuBar(JMenuBar m).
void	setNormalBounds(Rectangle r)	Sets the normal bounds for this internal frame, the bounds that this internal frame would be restored to from its maximized state.
void	setResizable(boolean b)	Sets whether the JInternalFrame can be resized by some user action.
protected void	setRootPane(JRootPane root)	Sets the rootPane property for this JInternalFrame.
protected void	setRootPaneCheckingEnabled(boolean enabled)	Sets whether calls to add and setLayout are forwarded to the contentPane.
void	setSelected(boolean selected)	Selects or deselects the internal frame if it's showing.
void	setTitle(String title)	Sets the JInternalFrame title.
void	setUI(InternalFrameUI ui)	Sets the UI delegate for this JInternalFrame.
void	show()	If the internal frame is not visible, brings the internal frame to the front, makes it visible, and attempts to select it.
void	toBack()	Sends this internal frame to the back.
void	toFront()	Brings this internal frame to the front.
void	updateUI()	Notification from the UIManager that the look and feel has changed.

Methods declared in class 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, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, 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,