javax.swing

Class JInternalFrame

Implemented Interfaces:
Accessible, ImageObserver, MenuContainer, RootPaneContainer, Serializable, WindowConstants

public class JInternalFrame
extends JComponent
implements Accessible, WindowConstants, RootPaneContainer

This class implements a Swing widget that looks and acts like a native frame. The frame can be dragged, resized, closed, etc. Typically, JInternalFrames are placed in JDesktopPanes. The actions that the JInternalFrame performs (maximizing, minimizing, etc.) are performed by a DesktopManager. As with regular frames, components are added by calling frame.getContentPane().add.
See Also:
Serialized Form

Nested Class Summary

protected class
JInternalFrame.AccessibleJInternalFrame
Provides the accessibility features for the JInternalFrame component.
static class
JInternalFrame.JDesktopIcon
This class represents the JInternalFrame while it is iconified.

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

static String
CONTENT_PANE_PROPERTY
The property fired in a PropertyChangeEvent when the contentPane property changes.
static String
FRAME_ICON_PROPERTY
The property fired in a PropertyChangeEvent when the frameIcon property changes.
static String
GLASS_PANE_PROPERTY
The property fired in a PropertyChangeEvent when the glassPane property changes.
static String
IS_CLOSED_PROPERTY
The property fired in a PropertyChangeEvent when the closed property changes.
static String
IS_ICON_PROPERTY
The property fired in a PropertyChangeEvent when the icon property changes.
static String
IS_MAXIMUM_PROPERTY
The property fired in a PropertyChangeEvent when the maximum property changes.
static String
IS_SELECTED_PROPERTY
The property fired in a PropertyChangeEvent when the selected property changes.
static String
LAYERED_PANE_PROPERTY
The property fired in a PropertyChangeEvent when the layeredPane property changes.
static String
MENU_BAR_PROPERTY
The property fired in a PropertyChangeEvent when the jMenuBar property changes.
static String
ROOT_PANE_PROPERTY
The property fired in a PropertyChangeEvent when the rootPane property changes.
static String
TITLE_PROPERTY
The property fired in a PropertyChangeEvent when the title property changes.
protected boolean
closable
Whether the JInternalFrame is closable.
protected JInternalFrame.JDesktopIcon
desktopIcon
The JDesktopIcon that represents the JInternalFrame while it is iconified.
protected Icon
frameIcon
The icon used in the JMenuBar in the TitlePane.
protected boolean
iconable
Whether the JInternalFrame can be iconified.
protected boolean
isClosed
Whether the JInternalFrame is closed.
protected boolean
isIcon
Whether the JInternalFrame has been iconified.
protected boolean
isMaximum
Whether the JInternalFrame has been maximized.
protected boolean
isSelected
Whether the JInternalFrame is the active frame.
protected boolean
maximizable
Whether the JInternalFrame can be maximized.
protected boolean
resizable
Whether the JInternalFrame is resizable.
protected JRootPane
rootPane
The rootPane of the JInternalFrame.
protected boolean
rootPaneCheckingEnabled
Whether the JInternalFrame has rootPaneChecking enabled.
protected String
title
The title on the TitlePane of the JInternalFrame.

Fields inherited from class javax.swing.JComponent

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

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

JInternalFrame()
Creates a new JInternalFrame object that has an empty string for its title, and is non-resizable, non-maximizable, non-iconifiable, and non-closable.
JInternalFrame(String title)
Creates a new JInternalFrame object with the given title and is non-resizable, non-maximizable, non-iconifiable, and non-closable.
JInternalFrame(String title, boolean resizable)
Creates a new JInternalFrame object with the given title and resizable properties.
JInternalFrame(String title, boolean resizable, boolean closable)
Creates a new JInternalFrame object with the given title, resizable, and closable properties.
JInternalFrame(String title, boolean resizable, boolean closable, boolean maximizable)
Creates a new JInternalFrame object with the given title, resizable, closable and maximizable properties.
JInternalFrame(String title, boolean resizable, boolean closable, boolean maximizable, boolean iconifiable)
Creates a new JInternalFrame object with the given title, resizable, closable, maximizable and iconifiable properties.

Method Summary

protected void
addImpl(Component comp, Object constraints, int index)
This method adds Components to this Container.
void
addInternalFrameListener(InternalFrameListener l)
This method adds an InternalFrameListener to this JInternalFrame.
protected JRootPane
createRootPane()
This method is used to create a root pane for the JInternalFrame.
void
dispose()
This method makes this JInternalFrame invisible, unselected and closed.
void
doDefaultCloseAction()
This method is used for closing this JInternalFrame.
protected void
fireInternalFrameEvent(int id)
This method fires an InternalFrameEvent to the listeners.
AccessibleContext
getAccessibleContext()
Returns the object that provides accessibility features for this JInternalFrame component.
Container
getContentPane()
This method returns the Content Pane for this JInternalFrame.
int
getDefaultCloseOperation()
Returns a code for the default action taken when this JInternalFrame is closed.
JInternalFrame.JDesktopIcon
getDesktopIcon()
Returns the JDesktopIcon that represents this JInternalFrame while it is iconified.
JDesktopPane
getDesktopPane()
This method searches this JInternalFrame ancestors for an instance of JDesktopPane.
Container
getFocusCycleRootAncestor()
This method returns null because this must always be the root of a focus traversal.
Component
getFocusOwner()
This method returns the child Component that will receive focus if this JInternalFrame is selected.
Icon
getFrameIcon()
This method returns the Frame Icon (the icon used in the JInternalFrame TitlePane and iconified frame).
Component
getGlassPane()
This method returns the Glass Pane used with this JInternalFrame.
InternalFrameListener[]
getInternalFrameListeners()
This method returns an array of InternalFrameListeners that are listening to this JInternalFrame.
JMenuBar
getJMenuBar()
This method returns the JMenuBar for this JInternalFrame.
int
getLayer()
This method returns the layer that this JInternalFrame resides in.
JLayeredPane
getLayeredPane()
This method returns the LayeredPane for this JInternalFrame.
JMenuBar
getMenuBar()
Deprecated. 1.0.3
Component
getMostRecentFocusOwner()
This method returns the child Component that will receive focus when the JInternalFrame is selected.
Rectangle
getNormalBounds()
This method returns the bounds of the JInternalFrame if it is not maximized.
JRootPane
getRootPane()
This method returns the Root Pane for this JInternalFrame.
String
getTitle()
Returns the frame's title.
InternalFrameUI
getUI()
This method returns the UI used to represent the JInternalFrame.
String
getUIClassID()
This method returns a String identifier that is used to determine which class acts as the JInternalFrame's UI.
String
getWarningString()
This method returns null.
void
hide()
This method deselects this JInternalFrame and hides it.
boolean
isClosable()
This method returns whether this JInternalFrame is closable.
boolean
isClosed()
This method returns whether this JInternalFrame has been closed.
boolean
isFocusCycleRoot()
This must always return true.
boolean
isIcon()
This method returns whether this JInternalFrame is currently iconified.
boolean
isIconifiable()
This method returns whether the JInternalFrame can be iconified.
boolean
isMaximizable()
This method returns whether this JInternalFrame can be maximized.
boolean
isMaximum()
This method returns whether this JInternalFrame is currently maximized.
boolean
isResizable()
This method returns whether this JInternalFrame is resizable.
protected boolean
isRootPaneCheckingEnabled()
This method returns whether root pane checking is enabled.
boolean
isSelected()
This method returns whether this JInternalFrame is selected.
void
moveToBack()
A helper method that moves this JInternalFrame to the back if the parent is a JLayeredPane.
void
moveToFront()
A helper method that moves this JInternalFrame to the front if the parent is a JLayeredPane.
void
pack()
This method causes the children of this JInternalFrame to be laid out.
protected void
paintComponent(Graphics g)
This method is overridden to allow for speedier painting while this JInternalFramme is being dragged.
protected String
paramString()
An implementation dependent string describing the current state of this JInternalFrame instance.
void
remove(Component comp)
This method removes the given Component from the Container.
void
removeInternalFrameListener(InternalFrameListener l)
This method removes an InternalFrameListener from this JInternalFrame.
void
reshape(int x, int y, int width, int height)
This method resizes and positions this JInternalFrame.
void
restoreSubcomponentFocus()
This method gives focus to the last child Component that had focus.
void
setClosable(boolean b)
This method sets whether this JInternalFrame can be closed.
void
setClosed(boolean b)
This method closes the JInternalFrame if the given boolean is true.
void
setContentPane(Container c)
This method sets the Container to be used as a Content Pane for this JInternalFrame.
void
setDefaultCloseOperation(int operation)
Sets a code for the action to be taken when this JInternalFrame is closed.
void
setDesktopIcon(JInternalFrame.JDesktopIcon d)
Sets the JDesktopIcon instance that represents this JInternalFrame while it is iconified and, if the new icon is not the same instance as the existing icon, sends a PropertyChangeEvent (with the property name "desktopIcon") to all registered listeners..
void
setFocusCycleRoot(boolean focusCycleRoot)
This method does nothing because this must be the root of a focus traversal cycle.
void
setFrameIcon(Icon icon)
This method sets the Icon to be used in two places.
void
setGlassPane(Component glass)
This method sets the Glass Pane used with this JInternalFrame.
void
setIcon(boolean b)
This method iconifies or deiconifies this JInternalFrame given the boolean argument.
void
setIconifiable(boolean b)
This method sets whether the JInternalFrame can be iconified.
void
setJMenuBar(JMenuBar b)
This method sets the JMenuBar to be used with this JInternalFrame.
void
setLayer(int layer)
A helper method that set the layer that this JInternalFrame resides in.
void
setLayer(Integer layer)
A helper method that sets the layer that this JInternalFrame resides in.
void
setLayeredPane(JLayeredPane layered)
This method sets the JLayeredPane to use with this JInternalFrame.
void
setLayout(LayoutManager manager)
This method sets the Layout Manager used in the JInternalFrame.
void
setMaximizable(boolean b)
This method sets whether the JInternalFrame can be maximized.
void
setMaximum(boolean b)
This method sets the JInternalFrame to maximized (if the given argument is true) or restores the JInternalFrame to its normal bounds otherwise.
void
setMenuBar(JMenuBar m)
Deprecated. 1.0.3
void
setNormalBounds(Rectangle r)
This method sets the bounds that this JInternalFrame will be restored to.
void
setResizable(boolean b)
This method sets whether the JInternalFrame can be resized by a user action (like dragging at the frame borders).
protected void
setRootPane(JRootPane root)
This method sets the Root Pane for this JInternalFrame.
protected void
setRootPaneCheckingEnabled(boolean enabled)
This method sets whether root pane checking is enabled.
void
setSelected(boolean selected)
This method sets whether this JInternalFrame is the selected frame in the JDesktopPane (or other container).
void
setTitle(String title)
Sets the title for the JInternalFrame and sends a PropertyChangeEvent (with the property name TITLE_PROPERTY) to all registered listeners.
void
setUI(InternalFrameUI ui)
This method is used to set the UI responsible for the JInternalFrame.
void
show()
This method displays the JInternalFrame.
void
toBack()
This method causes the JInternalFrame to be brough to back in the z-order.
void
toFront()
This method causes the JInternalFrame to be brought to front in the z-order.
void
updateUI()
This method resets the UI to the Look and Feel defaults.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, 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, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setNextFocusableComponent, setOpaque, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, extends EventListener> T[] getListeners, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponentZOrder, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, extends EventListener> T[] getListeners, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFocusable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFocusable, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CONTENT_PANE_PROPERTY

public static final String CONTENT_PANE_PROPERTY
The property fired in a PropertyChangeEvent when the contentPane property changes.
Field Value:
"contentPane"

FRAME_ICON_PROPERTY

public static final String FRAME_ICON_PROPERTY
The property fired in a PropertyChangeEvent when the frameIcon property changes.
Field Value:
"frameIcon"

GLASS_PANE_PROPERTY

public static final String GLASS_PANE_PROPERTY
The property fired in a PropertyChangeEvent when the glassPane property changes.
Field Value:
"glassPane"

IS_CLOSED_PROPERTY

public static final String IS_CLOSED_PROPERTY
The property fired in a PropertyChangeEvent when the closed property changes.
Field Value:
"closed"

IS_ICON_PROPERTY

public static final String IS_ICON_PROPERTY
The property fired in a PropertyChangeEvent when the icon property changes.
Field Value:
"icon"

IS_MAXIMUM_PROPERTY

public static final String IS_MAXIMUM_PROPERTY
The property fired in a PropertyChangeEvent when the maximum property changes.
Field Value:
"maximum"

IS_SELECTED_PROPERTY

public static final String IS_SELECTED_PROPERTY
The property fired in a PropertyChangeEvent when the selected property changes.
Field Value:
"selected"

LAYERED_PANE_PROPERTY

public static final String LAYERED_PANE_PROPERTY
The property fired in a PropertyChangeEvent when the layeredPane property changes.
Field Value:
"layeredPane"

MENU_BAR_PROPERTY

public static final String MENU_BAR_PROPERTY
The property fired in a PropertyChangeEvent when the jMenuBar property changes.
Field Value:
"JMenuBar"

ROOT_PANE_PROPERTY

public static final String ROOT_PANE_PROPERTY
The property fired in a PropertyChangeEvent when the rootPane property changes.
Field Value:
"rootPane"

TITLE_PROPERTY

public static final String TITLE_PROPERTY
The property fired in a PropertyChangeEvent when the title property changes.
Field Value:
"title"

closable

protected boolean closable
Whether the JInternalFrame is closable.

desktopIcon

protected JInternalFrame.JDesktopIcon desktopIcon
The JDesktopIcon that represents the JInternalFrame while it is iconified.

frameIcon

protected Icon