javax.swing

Class JInternalFrame

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.

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.

Field Summary
protected boolean	closable Whether the JInternalFrame is closable.
static String	CONTENT_PANE_PROPERTY The property fired in a PropertyChangeEvent when the contentPane property changes.
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.
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.
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.
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.
protected boolean	maximizable Whether the JInternalFrame can be maximized.
static String	MENU_BAR_PROPERTY The property fired in a PropertyChangeEvent when the jMenuBar property changes.
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.
static String	ROOT_PANE_PROPERTY The property fired in a PropertyChangeEvent when the rootPane property changes.
protected String	title The title on the TitlePane of the JInternalFrame.
static String	TITLE_PROPERTY The property fired in a PropertyChangeEvent when the title property changes.

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() This method is deprecated.
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 {@link 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) This method is deprecated.
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 {@link PropertyChangeEvent} (with the property name {@link #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.

Field Detail

closable

protected boolean closable

Whether the JInternalFrame is closable.

CONTENT_PANE_PROPERTY

public static final String CONTENT_PANE_PROPERTY

The property fired in a PropertyChangeEvent when the contentPane property changes.

desktopIcon

protected JInternalFrame.JDesktopIcon desktopIcon

The JDesktopIcon that represents the JInternalFrame while it is iconified.

frameIcon

protected Icon frameIcon

The icon used in the JMenuBar in the TitlePane.

FRAME_ICON_PROPERTY

public static final String FRAME_ICON_PROPERTY

The property fired in a PropertyChangeEvent when the frameIcon property changes.

GLASS_PANE_PROPERTY

public static final String GLASS_PANE_PROPERTY

The property fired in a PropertyChangeEvent when the glassPane property changes.

iconable

protected boolean iconable

Whether the JInternalFrame can be iconified.

isClosed

protected boolean isClosed

Whether the JInternalFrame is closed.

isIcon

protected boolean isIcon

Whether the JInternalFrame has been iconified.

isMaximum

protected boolean isMaximum

Whether the JInternalFrame has been maximized.

isSelected

protected boolean isSelected

Whether the JInternalFrame is the active frame.

IS_CLOSED_PROPERTY

public static final String IS_CLOSED_PROPERTY

The property fired in a PropertyChangeEvent when the closed property changes.

IS_ICON_PROPERTY

public static final String IS_ICON_PROPERTY

The property fired in a PropertyChangeEvent when the icon property changes.

IS_MAXIMUM_PROPERTY

public static final String IS_MAXIMUM_PROPERTY

The property fired in a PropertyChangeEvent when the maximum property changes.

IS_SELECTED_PROPERTY

public static final String IS_SELECTED_PROPERTY

The property fired in a PropertyChangeEvent when the selected property changes.

LAYERED_PANE_PROPERTY

public static final String LAYERED_PANE_PROPERTY

The property fired in a PropertyChangeEvent when the layeredPane property changes.

maximizable

protected boolean maximizable

Whether the JInternalFrame can be maximized.

MENU_BAR_PROPERTY

public static final String MENU_BAR_PROPERTY

The property fired in a PropertyChangeEvent when the jMenuBar property changes.

resizable

protected boolean resizable

Whether the JInternalFrame is resizable.

rootPane

protected JRootPane rootPane

The rootPane of the JInternalFrame.

rootPaneCheckingEnabled

protected boolean rootPaneCheckingEnabled

Whether the JInternalFrame has rootPaneChecking enabled.

UNKNOWN: Should be false to comply with J2SE 5.0

ROOT_PANE_PROPERTY

public static final String ROOT_PANE_PROPERTY

The property fired in a PropertyChangeEvent when the rootPane property changes.

title

protected String title

The title on the TitlePane of the JInternalFrame.

TITLE_PROPERTY

public static final String TITLE_PROPERTY

The property fired in a PropertyChangeEvent when the title property changes.

Constructor Detail

JInternalFrame

public 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

public JInternalFrame(String title)

Creates a new JInternalFrame object with the given title and is non-resizable, non-maximizable, non-iconifiable, and non-closable.

Parameters: title The title displayed in the JInternalFrame.

JInternalFrame

public JInternalFrame(String title, boolean resizable)

Creates a new JInternalFrame object with the given title and resizable properties. The JInternalFrame is non-maximizable, non-iconifiable, and non-closable.

Parameters: title The title displayed in the JInternalFrame. resizable Whether the JInternalFrame is resizable.

JInternalFrame

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

Creates a new JInternalFrame object with the given title, resizable, and closable properties. The JInternalFrame is non-maximizable and non-iconifiable.

Parameters: title The title displayed in the JInternalFrame. resizable Whether the JInternalFrame is resizable. closable Whether the JInternalFrame is closable.

JInternalFrame

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

Creates a new JInternalFrame object with the given title, resizable, closable and maximizable properties. The JInternalFrame is non-iconifiable.

Parameters: title The title displayed in the JInternalFrame. resizable Whether the JInternalFrame is resizable. closable Whether the JInternalFrame is closable. maximizable Whether the JInternalFrame is maximizable.

JInternalFrame

public 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 Detail

addImpl

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

This method adds Components to this Container. For JInternalFrames, instead of calling add directly on the JInternalFrame, it should be called with JInternalFrame.getContentPane().add. If root pane checking is enabled, calling this method will cause an exception to be thrown.

Parameters: comp The Component to add. constraints The constraints on the Component added. index The position to place the Component.

Throws: Error DOCUMENT ME!

addInternalFrameListener

public void addInternalFrameListener(InternalFrameListener l)

This method adds an InternalFrameListener to this JInternalFrame.

Parameters: l The listener to add.

createRootPane

protected JRootPane createRootPane()

This method is used to create a root pane for the JInternalFrame. This method is called by the constructors.

Returns: A root pane for the JInternalFrame to use.

dispose

public void dispose()

This method makes this JInternalFrame invisible, unselected and closed. If this JInternalFrame is not closed already, it will fire an INTERNAL_FRAME_CLoSED event. This method is similar to setClosed but it doesn't give vetoable listeners a chance to veto and it will not fire an INTERNAL_FRAME_CLOSING event.

doDefaultCloseAction

public void doDefaultCloseAction()

This method is used for closing this JInternalFrame. It fires an INTERNAL_FRAME_CLOSING event and then performs the action specified by the default close operation.

fireInternalFrameEvent

protected void fireInternalFrameEvent(int id)

This method fires an InternalFrameEvent to the listeners.

Parameters: id The type of event being fired. See InternalFrameEvent.

getAccessibleContext

public AccessibleContext getAccessibleContext()

Returns the object that provides accessibility features for this JInternalFrame component.

Returns: The accessible context (an instance of {@link AccessibleJInternalFrame}).

getContentPane

public Container getContentPane()

This method returns the Content Pane for this JInternalFrame.

Returns: The Content Pane for this JInternalFrame.

getDefaultCloseOperation

public int getDefaultCloseOperation()

Returns a code for the default action taken when this JInternalFrame is closed.

Returns: The action code (usually one of {@link WindowConstants#DO_NOTHING_ON_CLOSE}, {@link WindowConstants#HIDE_ON_CLOSE}, or {@link WindowConstants#DISPOSE_ON_CLOSE}).

getDesktopIcon

public JInternalFrame.JDesktopIcon getDesktopIcon()

Returns the JDesktopIcon that represents this JInternalFrame while it is iconified.

Returns: The desktop icon component.

getDesktopPane

public JDesktopPane getDesktopPane()

This method searches this JInternalFrame ancestors for an instance of JDesktopPane. If one is found, it is returned. If none is found, then it will search the JDesktopIcon for a JDesktopPane.

Returns: The JDesktopPane that this JInternalFrame belongs to.

getFocusCycleRootAncestor

public final Container getFocusCycleRootAncestor()

This method returns null because this must always be the root of a focus traversal.

Returns: always null

Since: 1.4

getFocusOwner

public Component getFocusOwner()

This method returns the child Component that will receive focus if this JInternalFrame is selected.

Returns: The child Component that will receive focus.

getFrameIcon

public Icon getFrameIcon()

This method returns the Frame Icon (the icon used in the JInternalFrame TitlePane and iconified frame).

Returns: The Frame Icon.

getGlassPane

public Component getGlassPane()

This method returns the Glass Pane used with this JInternalFrame.

Returns: The Glass Pane used with this JInternalFrame.

getInternalFrameListeners

public InternalFrameListener[] getInternalFrameListeners()

This method returns an array of InternalFrameListeners that are listening to this JInternalFrame.

Returns: An array of InternalFrameListeners that are listening to this JInternalFrame.

getJMenuBar

public JMenuBar getJMenuBar()

This method returns the JMenuBar for this JInternalFrame.

Returns: The JMenuBar for this JInternalFrame.

getLayer

public int getLayer()

This method returns the layer that this JInternalFrame resides in.

Returns: The layer that this JInternalFrame resides in.

getLayeredPane

public JLayeredPane getLayeredPane()

This method returns the LayeredPane for this JInternalFrame.

Returns: The LayeredPane for this JInternalFrame.

getMenuBar

public JMenuBar getMenuBar()

Deprecated: 1.0.3

This method is deprecated. This method returns the JMenuBar for this JInternalFrame.

Returns: The JMenuBar for this JInternalFrame.

getMostRecentFocusOwner

public Component getMostRecentFocusOwner()

This method returns the child Component that will receive focus when the JInternalFrame is selected. If the JInternalFrame is selected, this method returns getFocusOwner(). Otherwise, it will return the child Component that most recently requested focus. If that is null, then the initial focus Component is returned. If that is null, then the default focus component is returned.

Returns: The most recent focus owner.

getNormalBounds

public Rectangle getNormalBounds()

This method returns the bounds of the JInternalFrame if it is not maximized. If it is maximized, it returns the bounds of the JInternalFrame before it was maximized (the bounds that it will be restored to).

Returns: A Rectangle that contains this JInternalFrame's normal bounds (or just its bounds if it is not maximized).

getRootPane

public JRootPane getRootPane()

This method returns the Root Pane for this JInternalFrame.

Returns: The Root Pane for this JInternalFrame.

getTitle

public String getTitle()

Returns the frame's title.

Returns: The frame's title (can be null).

getUI

public InternalFrameUI getUI()

This method returns the UI used to represent the JInternalFrame.

Returns: The UI used to represent the JInternalFrame.

getUIClassID

public String getUIClassID()

This method returns a String identifier that is used to determine which class acts as the JInternalFrame's UI.

Returns: A String identifier to determine a UI class.

getWarningString

public final String getWarningString()

This method returns null.

Returns: null.

hide

public void hide()

This method deselects this JInternalFrame and hides it.

isClosable

public boolean isClosable()

This method returns whether this JInternalFrame is closable.

Returns: Whether this JInternalFrame is closable.

isClosed

public boolean isClosed()

This method returns whether this JInternalFrame has been closed.

Returns: Whether this JInternalFrame is closed.

isFocusCycleRoot

public final boolean isFocusCycleRoot()

This must always return true.

Returns: always true

Since: 1.4

isIcon

public boolean isIcon()

This method returns whether this JInternalFrame is currently iconified.

Returns: Whether this JInternalFrame is currently iconified.

isIconifiable

public boolean isIconifiable()

This method returns whether the JInternalFrame can be iconified.

Returns: Whether the JInternalFrame can be iconified.

isMaximizable

public boolean isMaximizable()

This method returns whether this JInternalFrame can be maximized.

Returns: Whether this JInternalFrame can be maximized.

isMaximum

public boolean isMaximum()

This method returns whether this JInternalFrame is currently maximized.

Returns: Whether this JInternalFrame is maximized.

isResizable

public boolean isResizable()

This method returns whether this JInternalFrame is resizable.

Returns: Whether this JInternalFrame is resizable.

isRootPaneCheckingEnabled

protected boolean isRootPaneCheckingEnabled()

This method returns whether root pane checking is enabled. If root pane checking is enabled, then calls to addImpl and setLayout will throw exceptions.

Returns: Whether root pane checking is enabled.

isSelected

public boolean isSelected()

This method returns whether this JInternalFrame is selected.

Returns: Whether this JInternalFrame is selected.

moveToBack

public void moveToBack()

A helper method that moves this JInternalFrame to the back if the parent is a JLayeredPane.

moveToFront

public void moveToFront()

A helper method that moves this JInternalFrame to the front if the parent is a JLayeredPane.

pack

public void pack()

This method causes the children of this JInternalFrame to be laid out. Before it begins, if this JInternalFrame is an icon, then it will be deiconified. If it is maximized, then it will be restored. If either operation fails, then this method will return.

paintComponent

protected void paintComponent(Graphics g)

This method is overridden to allow for speedier painting while this JInternalFramme is being dragged.

Parameters: g The Graphics object to paint with.

paramString

protected String paramString()

An implementation dependent string describing the current state of this JInternalFrame instance.

Returns: A string describing the current state of this JInternalFrame instance.

remove

public void remove(Component comp)

This method removes the given Component from the Container.

Parameters: comp The Component to remove.

removeInternalFrameListener

public void removeInternalFrameListener(InternalFrameListener l)

This method removes an InternalFrameListener from this JInternalFrame.

Parameters: l The listener to remove.

reshape

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

This method resizes and positions this JInternalFrame. It also forces a relayout of the Container.

Parameters: x The x position of this JInternalFrame. y The y position of this JInternalFrame. width The width of this JInternalFrame. height The height of this JInternalFrame.

restoreSubcomponentFocus

public void restoreSubcomponentFocus()

This method gives focus to the last child Component that had focus. This is used by the UI when this JInternalFrame is activated.

setClosable

public void setClosable(boolean b)

This method sets whether this JInternalFrame can be closed.

Parameters: b Whether this JInternalFrame can be closed.

setClosed

public void setClosed(boolean b)

This method closes the JInternalFrame if the given boolean is true. If it is false, then the result of this method is unspecified. If the JInternalFrame is closed, this method does nothing. This method will first fire an INTERNAL_FRAME_CLOSING event and give a chance for veto listeners to cancel the close. If no listener vetoes the change, the closed property is set to true and the JInternalFrame is hidden and unselected. The method will finish by firing an INTERNAL_FRAME_CLOSED event.

Parameters: b Whether the JInternalFrame will be closed.

Throws: PropertyVetoException If a VetoableChangeListener vetoes the change.

setContentPane

public void setContentPane(Container c)

This method sets the Container to be used as a Content Pane for this JInternalFrame.

Parameters: c The Container to use as a Content Pane.

setDefaultCloseOperation

public void setDefaultCloseOperation(int operation)

Sets a code for the action to be taken when this JInternalFrame is closed. Note that no validation is performed on the operation code, any integer will be accepted (nevertheless, you should pass in one of the listed values).

Parameters: operation one of {@link WindowConstants#DO_NOTHING_ON_CLOSE}, {@link WindowConstants#HIDE_ON_CLOSE} or {@link WindowConstants#DISPOSE_ON_CLOSE}.

setDesktopIcon

public 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 {@link PropertyChangeEvent} (with the property name "desktopIcon") to all registered listeners..

Parameters: d the icon.

setFocusCycleRoot

public final void setFocusCycleRoot(boolean focusCycleRoot)

This method does nothing because this must be the root of a focus traversal cycle.

Parameters: focusCycleRoot Not used.

setFrameIcon

public void setFrameIcon(Icon icon)

This method sets the Icon to be used in two places. The first is icon that is painted at the top left corner of the JInternalFrame when it is not iconified (clicking on that icon will activate the TitlePane JMenuBar). When the JInternalFrame is iconified, it will be the icon displayed in the JDesktopIcon. If no icon is set, the JInternalFrame will use a Look and Feel default.

Parameters: icon The Icon used in the TitlePane JMenuBar and iconified frames.

setGlassPane

public void setGlassPane(Component glass)

This method sets the Glass Pane used with this JInternalFrame.

Parameters: glass The Glass Pane to use with this JInternalFrame.

setIcon

public void setIcon(boolean b)

This method iconifies or deiconifies this JInternalFrame given the boolean argument. If the JInternalFrame becomes iconified, it will fire an INTERNAL_FRAME_ICONIFIED event. If the JInternalFrame becomes deiconified, it will fire anINTERNAL_FRAME_DEICONIFIED event.

Parameters: b Whether this JInternalFrame is to be iconified or deiconified.

Throws: PropertyVetoException DOCUMENT ME!

setIconifiable

public void setIconifiable(boolean b)

This method sets whether the JInternalFrame can be iconified. (This means that the JInternalFrame can be turned into an icon if minimized).

Parameters: b Whether the JInternalFrame can be iconified.

setJMenuBar

public void setJMenuBar(JMenuBar b)

This method sets the JMenuBar to be used with this JInternalFrame.

Parameters: b The JMenuBar to be used with this JInternalFrame.

setLayer

public void setLayer(int layer)

A helper method that set the layer that this JInternalFrame resides in. Using this version of the method means that the user should not set it to values that are already defined in JLayeredPane. If predefined values are to be used, the user should use the setLayer(Integer) version.

Parameters: layer The layer to place this JInternalFrame in.

setLayer

public void setLayer(Integer layer)

A helper method that sets the layer that this JInternalFrame resides in. Calling this version of the method should use layer values that are already defined in JLayeredPane.

Parameters: layer The layer to place this JInternalFrame in.

setLayeredPane

public void setLayeredPane(JLayeredPane layered)

This method sets the JLayeredPane to use with this JInternalFrame.

Parameters: layered The JLayeredPane to use as a layeredPane.

setLayout

public void setLayout(LayoutManager manager)

This method sets the Layout Manager used in the JInternalFrame. SetLayout should not be called on the JInternalFrame directly. Instead, it should be called with JInternalFrame.getContentPane().setLayout. Calls to this method with root pane checking enabled will cause exceptions to be thrown.

Parameters: manager The Layout Manager to be used with the JInternalFrame.

Throws: Error If rootPaneChecking is enabled.

setMaximizable

public void setMaximizable(boolean b)

This method sets whether the JInternalFrame can be maximized.

Parameters: b Whether this JInternalFrame can be maximized.

setMaximum

public 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.

Parameters: b Whether this JInteralFrame will be maximized or restored.

Throws: PropertyVetoException If a VetoableChangeListener vetoes the change.

setMenuBar

public void setMenuBar(JMenuBar m)

Deprecated: 1.0.3

This method is deprecated. This method sets the JMenuBar used with this JInternalFrame.

Parameters: m The JMenuBar to use with this JInternalFrame.

setNormalBounds

public void setNormalBounds(Rectangle r)

This method sets the bounds that this JInternalFrame will be restored to.

Parameters: r The bounds that this JInternalFrame will be restored to.

setResizable

public void setResizable(boolean b)

This method sets whether the JInternalFrame can be resized by a user action (like dragging at the frame borders).

Parameters: b Whether this JInternalFramer can be resized.

setRootPane

protected void setRootPane(JRootPane root)

This method sets the Root Pane for this JInternalFrame.

Parameters: root The Root Pane for this JInternalFrame.

setRootPaneCheckingEnabled

protected void setRootPaneCheckingEnabled(boolean enabled)

This method sets whether root pane checking is enabled. If root pane checking is enabled, then calls to addImpl and setLayout will throw exceptions.

Parameters: enabled Whether root pane checking is enabled.

setSelected

public void setSelected(boolean selected)

This method sets whether this JInternalFrame is the selected frame in the JDesktopPane (or other container). When selected, a JInternalFrame will have focus and paint its TitlePane differently (usually a different colour). If this method selects the frame, this JInternalFrame will fire an INTERNAL_FRAME_ACTIVATED event. If it deselects this frame, it will fire an INTERNAL_FRAME_DEACTIVATED event.

Parameters: selected Whether this JInternalFrame will become selected or deselected.

Throws: PropertyVetoException If a VetoableChangeListener vetoes the change.

setTitle

public void setTitle(String title)

Sets the title for the JInternalFrame and sends a {@link PropertyChangeEvent} (with the property name {@link #TITLE_PROPERTY}) to all registered listeners.

Parameters: title the new title (null permitted).

setUI

public void setUI(InternalFrameUI ui)

This method is used to set the UI responsible for the JInternalFrame.

Parameters: ui The UI responsible for the JInternalFrame.

show

public void show()

This method displays the JInternalFrame. If it is not visible, this method will bring this JInternalFrame to the front, make it visible and select it. If this is the first time this JInternalFrame is made visible, an INTERNAL_FRAME_OPENED event will be fired.