public class

JInternalFrame

extends JComponent
implements Accessible RootPaneContainer WindowConstants
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ javax.swing.JComponent
         ↳ javax.swing.JInternalFrame
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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 conveniance add and its variants, remove and setLayout have been overridden to forward to the contentPane as necessary. This means you can write:

       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 JavaBeansTM has been added to the java.beans package. Please see XMLEncoder.

Summary

Nested Classes
class JInternalFrame.AccessibleJInternalFrame This class implements accessibility support for the JInternalFrame class. 
class JInternalFrame.JDesktopIcon This component represents an iconified version of a JInternalFrame
Constants
String CONTENT_PANE_PROPERTY Bound property name.
String FRAME_ICON_PROPERTY Bound property name.
String GLASS_PANE_PROPERTY Bound property name.
String IS_CLOSED_PROPERTY Constrained property name indicating that the internal frame is closed.
String IS_ICON_PROPERTY Constrained property name indicating that the internal frame is iconified.
String IS_MAXIMUM_PROPERTY Constrained property name indicating that the internal frame is maximized.
String IS_SELECTED_PROPERTY Constrained property name indicated that this frame has selected status.
String LAYERED_PANE_PROPERTY Bound property name.
String MENU_BAR_PROPERTY Bound property name.
String ROOT_PANE_PROPERTY Bound property name.
String TITLE_PROPERTY Bound property name.
[Expand]
Inherited Constants
From class javax.swing.JComponent
From class java.awt.Component
From interface java.awt.image.ImageObserver
From interface javax.swing.WindowConstants
Fields
protected boolean closable The frame can be closed.
protected JInternalFrame.JDesktopIcon desktopIcon The icon that is displayed when this internal frame is iconified.
protected Icon frameIcon The icon shown in the top-left corner of this internal frame.
protected boolean iconable The frame can "iconified" (shrunk down and displayed as an icon-image).
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.
protected boolean maximizable The frame can be expanded to the size of the desktop pane.
protected boolean resizable The frame's size can be changed.
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.
[Expand]
Inherited Fields
From class javax.swing.JComponent
Public Constructors
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.
Public Methods
void addInternalFrameListener(InternalFrameListener l)
Adds the specified listener to receive internal frame events from this internal frame.
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.
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()
This method is 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()
Gets the warning string that is displayed with this internal frame.
void hide()
This method is deprecated. As of JDK version 1.1, replaced by setVisible(boolean).
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.
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.
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)
This method is deprecated. As of JDK 5, replaced by Component.setBounds(int, int, int, int).

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(Integer layer)
Convenience method for setting the layer attribute of this component.
void setLayer(int 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)
This method is 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.
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()
This method is deprecated. As of JDK version 1.1, replaced by setVisible(boolean).
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.
Protected Methods
void addImpl(Component comp, Object constraints, int index)
Adds the specified child Component.
JRootPane createRootPane()
Called by the constructor to set up the JRootPane.
void fireInternalFrameEvent(int id)
Fires an internal frame event.
boolean isRootPaneCheckingEnabled()
Returns whether calls to add and setLayout are forwarded to the contentPane.
void paintComponent(Graphics g)
Overridden to allow optimized painting when the internal frame is being dragged.
String paramString()
Returns a string representation of this JInternalFrame.
void setRootPane(JRootPane root)
Sets the rootPane property for this JInternalFrame.
void setRootPaneCheckingEnabled(boolean enabled)
Sets whether calls to add and setLayout are forwarded to the contentPane.
[Expand]
Inherited Methods
From class javax.swing.JComponent
From class java.awt.Container
From class java.awt.Component
From class java.lang.Object
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver
From interface javax.accessibility.Accessible
From interface javax.swing.RootPaneContainer

Constants

public static final String CONTENT_PANE_PROPERTY

Bound property name.

Constant Value: "contentPane"

public static final String FRAME_ICON_PROPERTY

Bound property name.

Constant Value: "frameIcon"

public static final String GLASS_PANE_PROPERTY

Bound property name.

Constant Value: "glassPane"

public static final String IS_CLOSED_PROPERTY

Constrained property name indicating that the internal frame is closed.

Constant Value: "closed"

public static final String IS_ICON_PROPERTY

Constrained property name indicating that the internal frame is iconified.

Constant Value: "icon"

public static final String IS_MAXIMUM_PROPERTY

Constrained property name indicating that the internal frame is maximized.

Constant Value: "maximum"

public static final String IS_SELECTED_PROPERTY

Constrained property name indicated that this frame has selected status.

Constant Value: "selected"

public static final String LAYERED_PANE_PROPERTY

Bound property name.

Constant Value: "layeredPane"

public static final String MENU_BAR_PROPERTY

Bound property name.

Constant Value: "JMenuBar"

public static final String ROOT_PANE_PROPERTY

Bound property name.

Constant Value: "rootPane"

public static final String TITLE_PROPERTY

Bound property name.

Constant Value: "title"

Fields

protected boolean closable

The frame can be closed.

protected JInternalFrame.JDesktopIcon desktopIcon

The icon that is displayed when this internal frame is iconified.

See Also

protected Icon frameIcon

The icon shown in the top-left corner of this internal frame.

protected boolean iconable

The frame can "iconified" (shrunk down and displayed as an icon-image).

protected boolean isClosed

The frame has been closed.

protected boolean isIcon

The frame has been iconified.

See Also

protected boolean isMaximum

The frame has been expanded to its maximum size.

See Also

protected boolean isSelected

The frame is currently selected.

protected boolean maximizable

The frame can be expanded to the size of the desktop pane.

protected boolean resizable

The frame's size can be changed.

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. This is initially false, but is set to true when the JInternalFrame is constructed.

protected String title

The title displayed in this internal frame's title bar.

Public Constructors

public JInternalFrame ()

Creates a non-resizable, non-closable, non-maximizable, non-iconifiable JInternalFrame with no title.

public JInternalFrame (String title)

Creates a non-resizable, non-closable, non-maximizable, non-iconifiable JInternalFrame with the specified title. Note that passing in a null title results in unspecified behavior and possibly an exception.

Parameters
title the non-null String to display in the title bar

public JInternalFrame (String title, boolean resizable)

Creates a non-closable, non-maximizable, non-iconifiable JInternalFrame with the specified title and resizability.

Parameters
title the String to display in the title bar
resizable if true, the internal frame can be resized

public JInternalFrame (String title, boolean resizable, boolean closable)

Creates a non-maximizable, non-iconifiable JInternalFrame with the specified title, resizability, and closability.

Parameters
title the String to display in the title bar
resizable if true, the internal frame can be resized
closable if true, the internal frame can be closed

public JInternalFrame (String title, boolean resizable, boolean closable, boolean maximizable)

Creates a non-iconifiable JInternalFrame with the specified title, resizability, closability, and maximizability.

Parameters
title the String to display in the title bar
resizable if true, the internal frame can be resized
closable if true, the internal frame can be closed
maximizable if true, the internal frame can be maximized

public JInternalFrame (String title, boolean resizable, boolean closable, boolean maximizable, boolean iconifiable)

Creates a JInternalFrame with the specified title, resizability, closability, maximizability, and iconifiability. All JInternalFrame constructors use this one.

Parameters
title the String to display in the title bar
resizable if true, the internal frame can be resized
closable if true, the internal frame can be closed
maximizable if true, the internal frame can be maximized
iconifiable if true, the internal frame can be iconified

Public Methods

public void addInternalFrameListener (InternalFrameListener l)

Adds the specified listener to receive internal frame events from this internal frame.

Parameters
l the internal frame listener

public void dispose ()

Makes this internal frame invisible, unselected, and closed. If the frame is not already closed, this method fires an 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.

public void doDefaultCloseAction ()

Fires an 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.

public AccessibleContext getAccessibleContext ()

Gets the 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.

Returns
  • an AccessibleJInternalFrame that serves as the AccessibleContext of this JInternalFrame

public Container getContentPane ()

Returns the content pane for this internal frame.

Returns
  • the content pane

public int getDefaultCloseOperation ()

Returns the default operation that occurs when the user initiates a "close" on this internal frame.

Returns
  • the operation that will occur when the user closes the internal frame

public JInternalFrame.JDesktopIcon getDesktopIcon ()

Returns the JDesktopIcon used when this JInternalFrame is iconified.

Returns
  • the JDesktopIcon displayed on the desktop

public JDesktopPane getDesktopPane ()

Convenience method that searches the ancestor hierarchy for a JDesktop instance. If JInternalFrame finds none, the desktopIcon tree is searched.

Returns
  • the JDesktopPane this internal frame belongs to, or null if none is found

public final Container getFocusCycleRootAncestor ()

Always returns null because JInternalFrames must always be roots of a focus traversal cycle.

Returns
  • null

public Component getFocusOwner ()

If this JInternalFrame is active, returns the child that has focus. Otherwise, returns null.

Returns
  • the component with focus, or null if no children have focus

public Icon getFrameIcon ()

Returns the image displayed in the title bar of this internal frame (usually in the top-left corner).

Returns
  • the Icon displayed in the title bar

public Component getGlassPane ()

Returns the glass pane for this internal frame.

Returns
  • the glass pane

public InternalFrameListener[] getInternalFrameListeners ()

Returns an array of all the InternalFrameListeners added to this JInternalFrame with addInternalFrameListener.

Returns
  • all of the InternalFrameListeners added or an empty array if no listeners have been added

public JMenuBar getJMenuBar ()

Returns the current JMenuBar for this JInternalFrame, or null if no menu bar has been set.

Returns
  • the JMenuBar used by this internal frame

public Cursor getLastCursor ()

Returns the last Cursor that was set by the setCursor method that is not a resizable Cursor.

Returns
  • the last non-resizable Cursor

public int getLayer ()

Convenience method for getting the layer attribute of this component.

Returns
  • an Integer object specifying this frame's desktop layer
See Also

public JLayeredPane getLayeredPane ()

Returns the layered pane for this internal frame.

Returns
  • a JLayeredPane object

public JMenuBar getMenuBar ()

This method is deprecated.
As of Swing version 1.0.3, replaced by getJMenuBar().

Returns the current JMenuBar for this JInternalFrame, or null if no menu bar has been set.

Returns
  • the current menu bar, or null if none has been set

public Component getMostRecentFocusOwner ()

Returns the child component of this 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 JInternalFrame is selected

public Rectangle getNormalBounds ()

If the JInternalFrame is not in maximized state, returns getBounds(); otherwise, returns the bounds that the JInternalFrame would be restored to.

Returns
  • a Rectangle containing the bounds of this frame when in the normal state

public JRootPane getRootPane ()

Returns the rootPane object for this internal frame.

Returns
  • the rootPane property
See Also

public String getTitle ()

Returns the title of the JInternalFrame.

Returns
  • a String containing this internal frame's title
See Also

public InternalFrameUI getUI ()

Returns the look-and-feel object that renders this component.

Returns
  • the InternalFrameUI object that renders this component

public String getUIClassID ()

Returns the name of the look-and-feel class that renders this component.

Returns
  • the string "InternalFrameUI"

public final String getWarningString ()

Gets the warning string that is displayed with this internal frame. Since an internal frame is always secure (since it's fully contained within a window that might need a warning string) this method always returns null.

Returns
  • null

public void hide ()

This method is deprecated.
As of JDK version 1.1, replaced by setVisible(boolean).

public boolean isClosable ()

Returns whether this JInternalFrame can be closed by some user action.

Returns
  • true if this internal frame can be closed

public boolean isClosed ()

Returns whether this JInternalFrame is currently closed.

Returns
  • true if this internal frame is closed, false otherwise

public final boolean isFocusCycleRoot ()

Always returns true because all JInternalFrames must be roots of a focus traversal cycle.

Returns
  • true

public boolean isIcon ()

Returns whether the JInternalFrame is currently iconified.

Returns
  • true if this internal frame is iconified

public boolean isIconifiable ()

Gets the iconable property, which by default is false.

Returns
  • the value of the iconable property.

public boolean isMaximizable ()

Gets the value of the maximizable property.

Returns
  • the value of the maximizable property

public boolean isMaximum ()

Returns whether the JInternalFrame is currently maximized.

Returns
  • true if this internal frame is maximized, false otherwise

public boolean isResizable ()

Returns whether the JInternalFrame can be resized by some user action.

Returns
  • true if this internal frame can be resized, false otherwise

public boolean isSelected ()

Returns whether the JInternalFrame is the currently "selected" or active frame.

Returns
  • true if this internal frame is currently selected (active)

public void moveToBack ()

Convenience method that moves this component to position -1 if its parent is a JLayeredPane.

public void moveToFront ()

Convenience method that moves this component to position 0 if its parent is a JLayeredPane.

public void pack ()

Causes subcomponents of this 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

public void remove (Component comp)

Removes the specified component from the container. If comp is not a child of the JInternalFrame this will forward the call to the contentPane.

Parameters
comp the component to be removed
Throws
NullPointerException if comp is null

public void removeInternalFrameListener (InternalFrameListener l)

Removes the specified internal frame listener so that it no longer receives internal frame events from this internal frame.

Parameters
l the internal frame listener

public void reshape (int x, int y, int width, int height)

This method is deprecated.
As of JDK 5, replaced by Component.setBounds(int, int, int, int).

Moves and resizes this component.

Moves and resizes this component. Unlike other components, this implementation also forces re-layout, so that frame decorations such as the title bar are always redisplayed.

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

public void restoreSubcomponentFocus ()

Requests the internal frame to restore focus to the last subcomponent that had focus. This is used by the UI when the user selected this internal frame -- for example, by clicking on the title bar.

public void setClosable (boolean b)

Sets whether this JInternalFrame can be closed by some user action.

Parameters
b a boolean value, where true means this internal frame can be closed

public void setClosed (boolean b)

Closes this internal frame if the argument is 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 be true
Throws
PropertyVetoException when the attempt to set the property is vetoed by the JInternalFrame

public void setContentPane (Container c)

Sets this JInternalFrame's contentPane property.

Parameters
c the content pane for this internal frame
Throws
IllegalComponentStateException (a runtime exception) if the content pane parameter is null
See Also

public void setCursor (Cursor cursor)

Sets the cursor image to the specified cursor. This cursor image is displayed when the 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.

Parameters
cursor One of the constants defined by the Cursor class; if this parameter is null then this component will inherit the cursor of its parent

public void setDefaultCloseOperation (int operation)

Sets the operation that will happen by default when the user initiates a "close" on this internal frame. The possible choices are:

DO_NOTHING_ON_CLOSE
Do nothing. This requires the program to handle the operation in the windowClosing method of a registered InternalFrameListener object.
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 in javax.swing.WindowConstants (an interface implemented by JInternalFrame): DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE, or DISPOSE_ON_CLOSE

public void setDesktopIcon (JInternalFrame.JDesktopIcon d)

Sets the JDesktopIcon associated with this JInternalFrame.

Parameters
d the JDesktopIcon to display on the desktop
See Also

public final void setFocusCycleRoot (boolean focusCycleRoot)

Does nothing because JInternalFrames must always be roots of a focus traversal cycle.

Parameters
focusCycleRoot this value is ignored

public void setFrameIcon (Icon icon)

Sets an image to be displayed in the titlebar of this internal frame (usually in the top-left corner). This image is not the 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 the Icon to display in the title bar
See Also

public void setGlassPane (Component glass)

Sets this JInternalFrame's glassPane property.

Parameters
glass the glass pane for this internal frame
See Also

public void setIcon (boolean b)

Iconifies or de-iconifies this internal frame, if the look and feel supports iconification. If the internal frame's state changes to iconified, this method fires an INTERNAL_FRAME_ICONIFIED event. If the state changes to de-iconified, an INTERNAL_FRAME_DEICONIFIED event is fired.

Parameters
b a boolean, where true means to iconify this internal frame and false means to de-iconify it
Throws
PropertyVetoException when the attempt to set the property is vetoed by the JInternalFrame

public void setIconifiable (boolean b)

Sets the 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, where true means this internal frame can be iconified

public void setJMenuBar (JMenuBar m)

Sets the menuBar property for this JInternalFrame.

Parameters
m the JMenuBar to use in this internal frame
See Also

public void setLayer (Integer layer)

Convenience method for setting the layer attribute of this component.

Parameters
layer an Integer object specifying this frame's desktop layer
See Also

public void setLayer (int layer)

Convenience method for setting the layer attribute of this component. The method 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

public void setLayeredPane (JLayeredPane layered)

Sets this JInternalFrame's layeredPane property.

Parameters
layered the JLayeredPane for this internal frame
Throws
IllegalComponentStateException (a runtime exception) if the layered pane parameter is null

public void setLayout (LayoutManager manager)

Ensures that, by default, the layout of this component cannot be set. Overridden to conditionally forward the call to the contentPane. Refer to RootPaneContainer for more information.

Parameters
manager the LayoutManager

public void setMaximizable (boolean b)

Sets the 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 true to specify that this internal frame should be maximizable; false to specify that it should not be

public void setMaximum (boolean b)

Maximizes and restores this internal frame. A maximized frame is resized to fully fit the JDesktopPane area associated with the JInternalFrame. A restored frame's size is set to the JInternalFrame's actual size.

Parameters
b a boolean, where true maximizes this internal frame and false restores it
Throws
PropertyVetoException when the attempt to set the property is vetoed by the JInternalFrame

public void setMenuBar (JMenuBar m)

This method is deprecated.
As of Swing version 1.0.3 replaced by setJMenuBar(JMenuBar m).

Sets the menuBar property for this JInternalFrame.

Parameters
m the JMenuBar to use in this internal frame
See Also

public 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. This method is intended for use only by desktop managers.

Parameters
r the bounds that this internal frame should be restored to

public void setResizable (boolean b)

Sets whether the JInternalFrame can be resized by some user action.

Parameters
b a boolean, where true means this internal frame can be resized

public void setSelected (boolean selected)

Selects or deselects the internal frame if it's showing. A 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, where true means this internal frame should become selected (currently active) and false means it should become deselected
Throws
PropertyVetoException when the attempt to set the property is vetoed by the JInternalFrame

public void setTitle (String title)

Sets the JInternalFrame title. title may have a null value.

Parameters
title the String to display in the title bar
See Also

public void setUI (InternalFrameUI ui)

Sets the UI delegate for this JInternalFrame.

Parameters
ui the UI delegate

public void show ()

This method is deprecated.
As of JDK version 1.1, replaced by setVisible(boolean).

If the internal frame is not visible, brings the internal frame to the front, makes it visible, and attempts to select it. The first time the internal frame is made visible, this method also fires an 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).

public void toBack ()

Sends this internal frame to the back. Places this internal frame at the bottom of the stacking order and makes the corresponding adjustment to other visible internal frames.

public void toFront ()

Brings this internal frame to the front. Places this internal frame at the top of the stacking order and makes the corresponding adjustment to other visible internal frames.

public void updateUI ()

Notification from the UIManager that the look and feel has changed. Replaces the current UI object with the latest version from the UIManager.

See Also

Protected Methods

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

Adds the specified child 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.

Parameters
comp the component to be enhanced
constraints the constraints to be respected
index the index
Throws
IllegalArgumentException if index is invalid
IllegalArgumentException if adding the container's parent to itself
IllegalArgumentException if adding a window to a container

protected JRootPane createRootPane ()

Called by the constructor to set up the JRootPane.

Returns
  • a new JRootPane
See Also

protected void fireInternalFrameEvent (int id)

Fires an internal frame event.

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
If the event type is not one of the above, nothing happens.

protected boolean isRootPaneCheckingEnabled ()

Returns whether calls to add and setLayout are forwarded to the contentPane.

Returns
  • true if add and setLayout are fowarded; false otherwise

protected void paintComponent (Graphics g)

Overridden to allow optimized painting when the internal frame is being dragged.

Parameters
g the Graphics object to protect

protected String paramString ()

Returns a string representation of this 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.

Returns
  • a string representation of this JInternalFrame

protected void setRootPane (JRootPane root)

Sets the rootPane property for this JInternalFrame. This method is called by the constructor.

Parameters
root the new JRootPane object

protected void setRootPaneCheckingEnabled (boolean enabled)

Sets whether calls to add and setLayout are forwarded to the contentPane.

Parameters
enabled true if add and setLayout are forwarded, false if they should operate directly on the JInternalFrame.