Class 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
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:
Nested Class Summary
| 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
| 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
| Constructor | Description |
|---|---|
JInternalFrame() |
Creates a non-resizable, non-closable, non-maximizable, non-iconifiable JInternalFrame with no title. |
JInternalFrame |
Creates a non-resizable, non-closable, non-maximizable, non-iconifiable JInternalFrame with the specified title. |
JInternalFrame |
Creates a non-closable, non-maximizable, non-iconifiable JInternalFrame with the specified title and resizability. |
JInternalFrame |
Creates a non-maximizable, non-iconifiable JInternalFrame with the specified title, resizability, and closability. |
JInternalFrame |
Creates a non-iconifiable JInternalFrame with the specified title, resizability, closability, and maximizability. |
JInternalFrame |
Creates a JInternalFrame with the specified title, resizability, closability, maximizability, and iconifiability. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
protected void |
addImpl |
Adds the specified child Component. |
void |
addInternalFrameListener |
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 |
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. |
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() |
Gets the warning string that is displayed with this internal frame. |
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 |
Overridden to allow optimized painting when the internal frame is being dragged. |
protected String |
paramString() |
Returns a string representation of this JInternalFrame. |
void |
remove |
Removes the specified component from the container. |
void |
removeInternalFrameListener |
Removes the specified internal frame listener so that it no longer receives internal frame events from this internal frame. |
void |
reshape |
Moves and resizes this component. |
void |
restoreSubcomponentFocus() |
Requests the internal frame to restore focus to the last subcomponent that had focus. |
void |
setClosable |
Sets whether this JInternalFrame can be closed by some user action. |
void |
setClosed |
Closes this internal frame if the argument is true. |
void |
setContentPane |
Sets this JInternalFrame's contentPane property. |
void |
setCursor |
Sets the cursor image to the specified cursor. |
void |
setDefaultCloseOperation |
Sets the operation that will happen by default when the user initiates a "close" on this internal frame. |
void |
setDesktopIcon |
Sets the JDesktopIcon associated with this JInternalFrame. |
final void |
setFocusCycleRoot |
Does nothing because JInternalFrames must always be roots of a focus traversal cycle. |
void |
setFrameIcon |
Sets an image to be displayed in the titlebar of this internal frame (usually in the top-left corner). |
void |
setGlassPane |
Sets this JInternalFrame's glassPane property. |
void |
setIcon |
Iconifies or de-iconifies this internal frame, if the look and feel supports iconification. |
void |
setIconifiable |
Sets the iconable property, which must be true for the user to be able to make the JInternalFrame an icon. |
void |
setJMenuBar |
Sets the menuBar property for this JInternalFrame. |
void |
setLayer |
Convenience method for setting the layer attribute of this component. |
void |
setLayer |
Convenience method for setting the layer attribute of this component. |
void |
setLayeredPane |
Sets this JInternalFrame's layeredPane property. |
void |
setLayout |
Ensures that, by default, the layout of this component cannot be set. |
void |
setMaximizable |
Sets the maximizable property, which determines whether the JInternalFrame can be maximized by some user action. |
void |
setMaximum |
Maximizes and restores this internal frame. |
void |
setMenuBar |
Deprecated. As of Swing version 1.0.3 replaced by setJMenuBar(JMenuBar m). |
void |
setNormalBounds |
Sets the normal bounds for this internal frame, the bounds that this internal frame would be restored to from its maximized state. |
void |
setResizable |
Sets whether the JInternalFrame can be resized by some user action. |
protected void |
setRootPane |
Sets the rootPane property for this JInternalFrame. |
protected void |
setRootPaneCheckingEnabled |
Sets whether calls to add and setLayout are forwarded to the contentPane. |
void |
setSelected |
Selects or deselects the internal frame if it's showing. |
void |
setTitle |
Sets the JInternalFrame title. |
void |
setUI |
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, unregisterKeyboardAction, update
Methods declared in class 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, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree
Methods declared in class 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, 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, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
Field Details
rootPane
protected JRootPane rootPane
JRootPane instance that manages the content pane and optional menu bar for this internal frame, as well as the glass pane.- See Also:
rootPaneCheckingEnabled
protected boolean rootPaneCheckingEnabled
add and setLayout will be forwarded to the contentPane. This is initially false, but is set to true when the JInternalFrame is constructed.closable
protected boolean closable
isClosed
protected boolean isClosed
maximizable
protected boolean maximizable
isMaximum
protected boolean isMaximum
- See Also:
iconable
protected boolean iconable
isIcon
protected boolean isIcon
- See Also:
resizable
protected boolean resizable
isSelected
protected boolean isSelected
frameIcon
protected Icon frameIcon
title
protected String title
desktopIcon
protected JInternalFrame.JDesktopIcon desktopIcon
- See Also:
CONTENT_PANE_PROPERTY
public static final String CONTENT_PANE_PROPERTY
- See Also:
MENU_BAR_PROPERTY
public static final String MENU_BAR_PROPERTY
- See Also:
TITLE_PROPERTY
public static final String TITLE_PROPERTY
- See Also:
LAYERED_PANE_PROPERTY
public static final String LAYERED_PANE_PROPERTY
- See Also:
ROOT_PANE_PROPERTY
public static final String ROOT_PANE_PROPERTY
- See Also:
GLASS_PANE_PROPERTY
public static final String GLASS_PANE_PROPERTY
- See Also:
FRAME_ICON_PROPERTY
public static final String FRAME_ICON_PROPERTY
- See Also:
IS_SELECTED_PROPERTY
public static final String IS_SELECTED_PROPERTY
- See Also:
IS_CLOSED_PROPERTY
public static final String IS_CLOSED_PROPERTY
- See Also:
IS_MAXIMUM_PROPERTY
public static final String IS_MAXIMUM_PROPERTY
- See Also:
IS_ICON_PROPERTY
public static final String IS_ICON_PROPERTY
- See Also:
Constructor Details
JInternalFrame
public JInternalFrame()
JInternalFrame with no title.JInternalFrame
public JInternalFrame(String title)
JInternalFrame with the specified title. Note that passing in a null title results in unspecified behavior and possibly an exception.- Parameters:
-
title- the non-nullStringto display in the title bar
JInternalFrame
public JInternalFrame(String title, boolean resizable)
JInternalFrame with the specified title and resizability.- Parameters:
-
title- theStringto display in the title bar -
resizable- iftrue, the internal frame can be resized
JInternalFrame
public JInternalFrame(String title, boolean resizable, boolean closable)
JInternalFrame with the specified title, resizability, and closability.- Parameters:
-
title- theStringto display in the title bar -
resizable- iftrue, the internal frame can be resized -
closable- iftrue, the internal frame can be closed
JInternalFrame
public JInternalFrame(String title, boolean resizable, boolean closable, boolean maximizable)
JInternalFrame with the specified title, resizability, closability, and maximizability.- Parameters:
-
title- theStringto display in the title bar -
resizable- iftrue, the internal frame can be resized -
closable- iftrue, the internal frame can be closed -
maximizable- iftrue, the internal frame can be maximized
JInternalFrame
public JInternalFrame(String title, boolean resizable, boolean closable, boolean maximizable, boolean iconifiable)
JInternalFrame with the specified title, resizability, closability, maximizability, and iconifiability. All JInternalFrame constructors use this one.- Parameters:
-
title- theStringto display in the title bar -
resizable- iftrue, the internal frame can be resized -
closable- iftrue, the internal frame can be closed -
maximizable- iftrue, the internal frame can be maximized -
iconifiable- iftrue, the internal frame can be iconified
Method Details
createRootPane
protected JRootPane createRootPane()
JRootPane.- Returns:
- a new
JRootPane - See Also:
getUI
public InternalFrameUI getUI()
- Overrides:
-
getUIin classJComponent - Returns:
- the
InternalFrameUIobject that renders this component
setUI
@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component\'s LookAndFeel.") public void setUI(InternalFrameUI ui)
JInternalFrame.- Parameters:
-
ui- the UI delegate
updateUI
public void updateUI()
UIManager that the look and feel has changed. Replaces the current UI object with the latest version from the UIManager.- Overrides:
-
updateUIin classJComponent - See Also:
getUIClassID
@BeanProperty(bound=false, description="UIClassID") public String getUIClassID()
- Overrides:
-
getUIClassIDin classJComponent - Returns:
- the string "InternalFrameUI"
- See Also:
isRootPaneCheckingEnabled
protected boolean isRootPaneCheckingEnabled()
add and setLayout are forwarded to the contentPane.- Returns:
- true if
addandsetLayoutare forwarded; false otherwise - See Also:
setRootPaneCheckingEnabled
@BeanProperty(hidden=true, description="Whether the add and setLayout methods are forwarded") protected void setRootPaneCheckingEnabled(boolean enabled)
add and setLayout are forwarded to the contentPane.- Parameters:
-
enabled- true ifaddandsetLayoutare forwarded, false if they should operate directly on theJInternalFrame. - See Also:
addImpl
protected void addImpl(Component comp, Object constraints, int index)
Component. This method is overridden to conditionally forward calls to the contentPane. By default, children are added to the contentPane instead of the frame, refer to RootPaneContainer for details.- Overrides:
-
addImplin classContainer - Parameters:
-
comp- the component to be enhanced -
constraints- the constraints to be respected -
index- the index - Throws:
-
IllegalArgumentException- ifindexis invalid -
IllegalArgumentException- if adding the container's parent to itself -
IllegalArgumentException- if adding a window to a container - See Also:
remove
public void remove(Component comp)
comp is not a child of the JInternalFrame this will forward the call to the contentPane.- Overrides:
-
removein classContainer - Parameters:
-
comp- the component to be removed - Throws:
-
NullPointerException- ifcompis null - See Also:
setLayout
public void setLayout(LayoutManager manager)
contentPane. Refer to RootPaneContainer for more information.getMenuBar
@Deprecated public JMenuBar getMenuBar()
getJMenuBar().JMenuBar for this JInternalFrame, or null if no menu bar has been set.- Returns:
- the current menu bar, or
nullif none has been set
getJMenuBar
public JMenuBar getJMenuBar()
JMenuBar for this JInternalFrame, or null if no menu bar has been set.- Returns:
- the
JMenuBarused by this internal frame - See Also:
setMenuBar
@Deprecated public void setMenuBar(JMenuBar m)
setJMenuBar(JMenuBar m).menuBar property for this JInternalFrame.- Parameters:
-
m- theJMenuBarto use in this internal frame - See Also:
setJMenuBar
@BeanProperty(preferred=true, description="The menu bar for accessing pulldown menus from this internal frame.") public void setJMenuBar(JMenuBar m)
menuBar property for this JInternalFrame.- Parameters:
-
m- theJMenuBarto use in this internal frame - See Also:
getContentPane
public Container getContentPane()
- Specified by:
-
getContentPanein interfaceRootPaneContainer - Returns:
- the content pane
- See Also:
setContentPane
@BeanProperty(hidden=true, description="The client area of the internal frame where child components are normally inserted.") public void setContentPane(Container c)
JInternalFrame's contentPane property.- Specified by:
-
setContentPanein interfaceRootPaneContainer - Parameters:
-
c- the content pane for this internal frame - Throws:
-
IllegalComponentStateException- (a runtime exception) if the content pane parameter isnull - See Also:
getLayeredPane
public JLayeredPane getLayeredPane()
- Specified by:
-
getLayeredPanein interfaceRootPaneContainer - Returns:
- a
JLayeredPaneobject - See Also:
setLayeredPane
@BeanProperty(hidden=true, description="The pane which holds the various desktop layers.") public void setLayeredPane(JLayeredPane layered)
JInternalFrame's layeredPane property.- Specified by:
-
setLayeredPanein interfaceRootPaneContainer - Parameters:
-
layered- theJLayeredPanefor this internal frame - Throws:
-
IllegalComponentStateException- (a runtime exception) if the layered pane parameter isnull - See Also:
getGlassPane
public Component getGlassPane()
- Specified by:
-
getGlassPanein interfaceRootPaneContainer - Returns:
- the glass pane
- See Also:
setGlassPane
@BeanProperty(hidden=true, description="A transparent pane used for menu rendering.") public void setGlassPane(Component glass)
JInternalFrame's glassPane property.- Specified by:
-
setGlassPanein interfaceRootPaneContainer - Parameters:
-
glass- the glass pane for this internal frame - See Also:
getRootPane
@BeanProperty(hidden=true, description="The root pane used by this internal frame.") public JRootPane getRootPane()
rootPane object for this internal frame.- Specified by:
-
getRootPanein interfaceRootPaneContainer - Overrides:
-
getRootPanein classJComponent - Returns:
- the
rootPaneproperty - See Also:
setRootPane
protected void setRootPane(JRootPane root)
rootPane property for this JInternalFrame. This method is called by the constructor.- Parameters:
-
root- the newJRootPaneobject
setClosable
@BeanProperty(preferred=true, description="Indicates whether this internal frame can be closed.") public void setClosable(boolean b)
JInternalFrame can be closed by some user action.- Parameters:
-
b- a boolean value, wheretruemeans this internal frame can be closed
isClosable
public boolean isClosable()
JInternalFrame can be closed by some user action.- Returns:
-
trueif this internal frame can be closed
isClosed
public boolean isClosed()
JInternalFrame is currently closed.- Returns:
-
trueif this internal frame is closed,falseotherwise
setClosed
@BeanProperty(description="Indicates whether this internal frame has been closed.") public void setClosed(boolean b) throws PropertyVetoException
true. Do not invoke this method with a false argument; the result of invoking setClosed(false) is unspecified. If the internal frame is already closed, this method does nothing and returns immediately. Otherwise, this method begins by firing an INTERNAL_FRAME_CLOSING event. Then this method sets the closed property to true unless a listener vetoes the property change. This method finishes by making the internal frame invisible and unselected, and then firing an INTERNAL_FRAME_CLOSED event.
Note: To reuse an internal frame that has been closed, you must add it to a container (even if you never removed it from its previous container). Typically, this container will be the JDesktopPane that previously contained the internal frame.
- Parameters:
-
b- must betrue - Throws:
-
PropertyVetoException- when the attempt to set the property is vetoed by theJInternalFrame - See Also:
setResizable
@BeanProperty(preferred=true, description="Determines whether this internal frame can be resized by the user.") public void setResizable(boolean b)
JInternalFrame can be resized by some user action.- Parameters:
-
b- a boolean, wheretruemeans this internal frame can be resized
isResizable
public boolean isResizable()
JInternalFrame can be resized by some user action.- Returns:
-
trueif this internal frame can be resized,falseotherwise
setIconifiable
@BeanProperty(preferred=true, description="Determines whether this internal frame can be iconified.") public void setIconifiable(boolean b)
iconable property, which must be true for the user to be able to make the JInternalFrame an icon. Some look and feels might not implement iconification; they will ignore this property.- Parameters:
-
b- a boolean, wheretruemeans this internal frame can be iconified
isIconifiable
public boolean isIconifiable()
iconable property, which by default is false.- Returns:
- the value of the
iconableproperty. - See Also:
isIcon
public boolean isIcon()
JInternalFrame is currently iconified.- Returns:
-
trueif this internal frame is iconified
setIcon
@BeanProperty(description="The image displayed when this internal frame is minimized.") public void setIcon(boolean b) throws PropertyVetoException
INTERNAL_FRAME_ICONIFIED event. If the state changes to de-iconified, an INTERNAL_FRAME_DEICONIFIED event is fired.- Parameters:
-
b- a boolean, wheretruemeans to iconify this internal frame andfalsemeans to de-iconify it - Throws:
-
PropertyVetoException- when the attempt to set the property is vetoed by theJInternalFrame - See Also:
setMaximizable
@BeanProperty(preferred=true, description="Determines whether this internal frame can be maximized.") public void setMaximizable(boolean b)
maximizable property, which determines whether the JInternalFrame can be maximized by some user action. Some look and feels might not support maximizing internal frames; they will ignore this property.- Parameters:
-
b-trueto specify that this internal frame should be maximizable;falseto specify that it should not be
isMaximizable
public boolean isMaximizable()
maximizable property.- Returns:
- the value of the
maximizableproperty - See Also:
isMaximum
public boolean isMaximum()
JInternalFrame is currently maximized.- Returns:
-
trueif this internal frame is maximized,falseotherwise
setMaximum
@BeanProperty(description="Indicates whether this internal frame is maximized.") public void setMaximum(boolean b) throws PropertyVetoException
JDesktopPane area associated with the JInternalFrame. A restored frame's size is set to the JInternalFrame's actual size.- Parameters:
-
b- a boolean, wheretruemaximizes this internal frame andfalserestores it - Throws:
-
PropertyVetoException- when the attempt to set the property is vetoed by theJInternalFrame
getTitle
public String getTitle()
JInternalFrame.- Returns:
- a
Stringcontaining this internal frame's title - See Also:
setTitle
@BeanProperty(preferred=true, description="The text displayed in the title bar.") public void setTitle(String title)
JInternalFrame title. title may have a null value.- Parameters:
-
title- theStringto display in the title bar - See Also:
setSelected
@BeanProperty(description="Indicates whether this internal frame is currently the active frame.") public void setSelected(boolean selected) throws PropertyVetoException
JInternalFrame normally draws its title bar differently if it is the selected frame, which indicates to the user that this internal frame has the focus. When this method changes the state of the internal frame from deselected to selected, it fires an InternalFrameEvent.INTERNAL_FRAME_ACTIVATED event. If the change is from selected to deselected, an InternalFrameEvent.INTERNAL_FRAME_DEACTIVATED event is fired.- Parameters:
-
selected- a boolean, wheretruemeans this internal frame should become selected (currently active) andfalsemeans it should become deselected - Throws:
-
PropertyVetoException- when the attempt to set the property is vetoed by theJInternalFrame - See Also:
isSelected
public boolean isSelected()
JInternalFrame is the currently "selected" or active frame.- Returns:
-
trueif this internal frame is currently selected (active) - See Also:
setFrameIcon
@BeanProperty(description="The icon shown in the top-left corner of this internal frame.") public void setFrameIcon(Icon icon)
desktopIcon object, which is the image displayed in the JDesktop when this internal frame is iconified. Passing null to this function is valid, but the look and feel can choose the appropriate behavior for that situation, such as displaying no icon or a default icon for the look and feel.- Parameters:
-
icon- theIconto display in the title bar - See Also:
getFrameIcon
public Icon getFrameIcon()
- Returns:
- the
Icondisplayed in the title bar - See Also:
moveToFront
public void moveToFront()
JLayeredPane.moveToBack
public void moveToBack()
JLayeredPane.getLastCursor
@BeanProperty(bound=false) public Cursor getLastCursor()
Cursor that was set by the setCursor method that is not a resizable Cursor.- Returns:
- the last non-resizable
Cursor - Since:
- 1.6
setCursor
public void setCursor(Cursor cursor)
contains method for this component returns true for the current cursor location, and this Component is visible, displayable, and enabled. Setting the cursor of a Container causes that cursor to be displayed within all of the container's subcomponents, except for those that have a non-null cursor. The method may have no visual effect if the Java platform implementation and/or the native system do not support changing the mouse cursor shape.
setLayer
@BeanProperty(bound=false, expert=true, description="Specifies what desktop layer is used.") public void setLayer(Integer layer)
- Parameters:
-
layer- anIntegerobject specifying this frame's desktop layer - Throws:
-
NullPointerException- iflayerisnull - See Also:
setLayer
@BeanProperty(bound=false, expert=true, description="Specifies what desktop layer is used.") public void setLayer(int layer)
setLayer(Integer) should be used for layer values predefined in JLayeredPane. When using setLayer(int), care must be taken not to accidentally clash with those values.- Parameters:
-
layer- an integer specifying this internal frame's desktop layer - Since:
- 1.3
- See Also:
getLayer
public int getLayer()
- Returns:
- an
Integerobject specifying this frame's desktop layer - See Also:
getDesktopPane
@BeanProperty(bound=false) public JDesktopPane getDesktopPane()
JDesktop instance. If JInternalFrame finds none, the desktopIcon tree is searched.- Returns:
- the
JDesktopPanethis internal frame belongs to, ornullif none is found
setDesktopIcon
@BeanProperty(description="The icon shown when this internal frame is minimized.") public void setDesktopIcon(JInternalFrame.JDesktopIcon d)
JDesktopIcon associated with this JInternalFrame.- Parameters:
-
d- theJDesktopIconto display on the desktop - See Also:
getDesktopIcon
public JInternalFrame.JDesktopIcon getDesktopIcon()
JDesktopIcon used when this JInternalFrame is iconified.- Returns:
- the
JDesktopIcondisplayed on the desktop - See Also:
getNormalBounds
public Rectangle getNormalBounds()
JInternalFrame is not in maximized state, returns getBounds(); otherwise, returns the bounds that the JInternalFrame would be restored to.- Returns:
- a
Rectanglecontaining the bounds of this frame when in the normal state - Since:
- 1.3
setNormalBounds
public void setNormalBounds(Rectangle r)
- Parameters:
-
r- the bounds that this internal frame should be restored to - Since:
- 1.3
getFocusOwner
public Component getFocusOwner()
JInternalFrame is active, returns the child that has focus. Otherwise, returns null.- Returns:
- the component with focus, or
nullif no children have focus - Since:
- 1.3
getMostRecentFocusOwner
@BeanProperty(bound=false) public Component getMostRecentFocusOwner()
JInternalFrame that will receive the focus when this JInternalFrame is selected. If this JInternalFrame is currently selected, this method returns the same component as the getFocusOwner method. If this JInternalFrame is not selected, then the child component that most recently requested focus will be returned. If no child component has ever requested focus, then this JInternalFrame's initial focusable component is returned. If no such child exists, then this JInternalFrame's default component to focus is returned.- Returns:
- the child component that will receive focus when this
JInternalFrameis selected - Since:
- 1.4
- See Also:
restoreSubcomponentFocus
public void restoreSubcomponentFocus()
- Since:
- 1.3
reshape
public void reshape(int x, int y, int width, int height)
- Overrides:
-
reshapein classJComponent - Parameters:
-
x- an integer giving the component's new horizontal position measured in pixels from the left of its container -
y- an integer giving the component's new vertical position, measured in pixels from the bottom of its container -
width- an integer giving the component's new width in pixels -
height- an integer giving the component's new height in pixels - See Also:
addInternalFrameListener
public void addInternalFrameListener(InternalFrameListener l)
- Parameters:
-
l- the internal frame listener
removeInternalFrameListener
public void removeInternalFrameListener(InternalFrameListener l)
- Parameters:
-
l- the internal frame listener
getInternalFrameListeners
@BeanProperty(bound=false) public InternalFrameListener[] getInternalFrameListeners()
InternalFrameListeners added to this JInternalFrame with addInternalFrameListener.- Returns:
- all of the
InternalFrameListeners added or an empty array if no listeners have been added - Since:
- 1.4
- See Also:
fireInternalFrameEvent
protected void fireInternalFrameEvent(int id)
- Parameters:
-
id- the type of the event being fired; one of the following:-
InternalFrameEvent.INTERNAL_FRAME_OPENED -
InternalFrameEvent.INTERNAL_FRAME_CLOSING -
InternalFrameEvent.INTERNAL_FRAME_CLOSED -
InternalFrameEvent.INTERNAL_FRAME_ICONIFIED -
InternalFrameEvent.INTERNAL_FRAME_DEICONIFIED -
InternalFrameEvent.INTERNAL_FRAME_ACTIVATED -
InternalFrameEvent.INTERNAL_FRAME_DEACTIVATED
-
doDefaultCloseAction
public void doDefaultCloseAction()
INTERNAL_FRAME_CLOSING event and then performs the action specified by the internal frame's default close operation. This method is typically invoked by the look-and-feel-implemented action handler for the internal frame's close button.- Since:
- 1.3
- See Also:
setDefaultCloseOperation
public void setDefaultCloseOperation(int operation)
-
DO_NOTHING_ON_CLOSE - Do nothing. This requires the program to handle the operation in the
internalFrameClosingmethod of a registeredInternalFrameListenerobject. -
HIDE_ON_CLOSE - Automatically make the internal frame invisible.
-
DISPOSE_ON_CLOSE - Automatically dispose of the internal frame.
The default value is DISPOSE_ON_CLOSE. Before performing the specified close operation, the internal frame fires an INTERNAL_FRAME_CLOSING event.
- Parameters:
-
operation- one of the following constants defined injavax.swing.WindowConstants(an interface implemented byJInternalFrame):DO_NOTHING_ON_CLOSE,HIDE_ON_CLOSE, orDISPOSE_ON_CLOSE - See Also:
getDefaultCloseOperation
public int getDefaultCloseOperation()
- Returns:
- the operation that will occur when the user closes the internal frame
- See Also:
pack
public void pack()
JInternalFrame to be laid out at their preferred size. Internal frames that are iconized or maximized are first restored and then packed. If the internal frame is unable to be restored its state is not changed and will not be packed.- See Also:
show
public void show()
INTERNAL_FRAME_OPENED event. This method does nothing if the internal frame is already visible. Invoking this method has the same result as invoking setVisible(true).hide
public void hide()
JComponent- Overrides:
-
hidein classJComponent
dispose
public void dispose()
INTERNAL_FRAME_CLOSED event. The results of invoking this method are similar to setClosed(true), but dispose always succeeds in closing the internal frame and does not fire an INTERNAL_FRAME_CLOSING event.toFront
public void toFront()
- See Also:
toBack
public void toBack()
- See Also:
setFocusCycleRoot
public final void setFocusCycleRoot(boolean focusCycleRoot)
JInternalFrames must always be roots of a focus traversal cycle.- Overrides:
-
setFocusCycleRootin classContainer - Parameters:
-
focusCycleRoot- this value is ignored - Since:
- 1.4
- See Also:
isFocusCycleRoot
public final boolean isFocusCycleRoot()
true because all JInternalFrames must be roots of a focus traversal cycle.- Overrides:
-
isFocusCycleRootin classContainer - Returns:
true- Since:
- 1.4
- See Also:
getFocusCycleRootAncestor
@BeanProperty(bound=false) public final Container getFocusCycleRootAncestor()
null because JInternalFrames must always be roots of a focus traversal cycle.- Overrides:
-
getFocusCycleRootAncestorin classComponent - Returns:
null- Since:
- 1.4
- See Also:
getWarningString
@BeanProperty(bound=false) public final String getWarningString()
null.- Returns:
null- See Also:
paramString
protected String paramString()
JInternalFrame. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.- Overrides:
-
paramStringin classJComponent - Returns:
- a string representation of this
JInternalFrame
paintComponent
protected void paintComponent(Graphics g)
- Overrides:
-
paintComponentin classJComponent - Parameters:
-
g- theGraphicsobject to protect - See Also:
getAccessibleContext
@BeanProperty(bound=false) public AccessibleContext getAccessibleContext()
AccessibleContext associated with this JInternalFrame. For internal frames, the AccessibleContext takes the form of an AccessibleJInternalFrame object. A new AccessibleJInternalFrame instance is created if necessary.- Specified by:
-
getAccessibleContextin interfaceAccessible - Overrides:
-
getAccessibleContextin classComponent - Returns:
- an
AccessibleJInternalFramethat serves as theAccessibleContextof thisJInternalFrame - See Also:
© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.desktop/javax/swing/JInternalFrame.html
getJMenuBar().