Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JInternalFrame
public class JInternalFrame
extends JComponent
implements Accessible, WindowConstants, RootPaneContainer
Nested Class Summary | |
protected class |
|
static class |
|
Nested classes/interfaces inherited from class javax.swing.JComponent | |
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container | |
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component | |
Component.AccessibleAWTComponent , Component.BltBufferStrategy , Component.FlipBufferStrategy |
Field Summary | |
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
static String |
|
protected boolean |
|
protected JInternalFrame.JDesktopIcon |
|
protected Icon |
|
protected boolean |
|
protected boolean |
|
protected boolean |
|
protected boolean |
|
protected boolean |
|
protected boolean |
|
protected boolean |
|
protected JRootPane |
|
protected boolean |
|
protected String |
|
Fields inherited from class javax.swing.JComponent | |
TOOL_TIP_TEXT_KEY , UNDEFINED_CONDITION , WHEN_ANCESTOR_OF_FOCUSED_COMPONENT , WHEN_FOCUSED , WHEN_IN_FOCUSED_WINDOW , accessibleContext , listenerList , ui |
Fields inherited from class java.awt.Component | |
BOTTOM_ALIGNMENT , CENTER_ALIGNMENT , LEFT_ALIGNMENT , RIGHT_ALIGNMENT , TOP_ALIGNMENT |
Fields inherited from interface java.awt.image.ImageObserver | |
ABORT , ALLBITS , ERROR , FRAMEBITS , HEIGHT , PROPERTIES , SOMEBITS , WIDTH |
Fields inherited from interface javax.swing.WindowConstants | |
DISPOSE_ON_CLOSE , DO_NOTHING_ON_CLOSE , EXIT_ON_CLOSE , HIDE_ON_CLOSE |
Constructor Summary | |
| |
| |
| |
| |
| |
|
Method Summary | |
protected void | |
void |
|
protected JRootPane |
|
void |
|
void |
|
protected void |
|
AccessibleContext |
|
Container |
|
int |
|
JInternalFrame.JDesktopIcon |
|
JDesktopPane |
|
Container |
|
Component |
|
Icon |
|
Component |
|
InternalFrameListener[] |
|
JMenuBar |
|
int |
|
JLayeredPane |
|
JMenuBar |
|
Component |
|
Rectangle |
|
JRootPane |
|
String |
|
InternalFrameUI |
|
String |
|
String |
|
void |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
protected boolean |
|
boolean |
|
void |
|
void |
|
void |
|
protected void |
|
protected String |
|
void | |
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void | |
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected void |
|
protected void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
Methods inherited from class java.lang.Object | |
clone , equals , extends Object> getClass , finalize , hashCode , notify , notifyAll , toString , wait , wait , wait |
public static final String CONTENT_PANE_PROPERTY
The property fired in a PropertyChangeEvent when the contentPane property changes.
- Field Value:
- "contentPane"
public static final String FRAME_ICON_PROPERTY
The property fired in a PropertyChangeEvent when the frameIcon property changes.
- Field Value:
- "frameIcon"
public static final String GLASS_PANE_PROPERTY
The property fired in a PropertyChangeEvent when the glassPane property changes.
- Field Value:
- "glassPane"
public static final String IS_CLOSED_PROPERTY
The property fired in a PropertyChangeEvent when the closed property changes.
- Field Value:
- "closed"
public static final String IS_ICON_PROPERTY
The property fired in a PropertyChangeEvent when the icon property changes.
- Field Value:
- "icon"
public static final String IS_MAXIMUM_PROPERTY
The property fired in a PropertyChangeEvent when the maximum property changes.
- Field Value:
- "maximum"
public static final String IS_SELECTED_PROPERTY
The property fired in a PropertyChangeEvent when the selected property changes.
- Field Value:
- "selected"
public static final String LAYERED_PANE_PROPERTY
The property fired in a PropertyChangeEvent when the layeredPane property changes.
- Field Value:
- "layeredPane"
public static final String MENU_BAR_PROPERTY
The property fired in a PropertyChangeEvent when the jMenuBar property changes.
- Field Value:
- "JMenuBar"
public static final String ROOT_PANE_PROPERTY
The property fired in a PropertyChangeEvent when the rootPane property changes.
- Field Value:
- "rootPane"
public static final String TITLE_PROPERTY
The property fired in a PropertyChangeEvent when the title property changes.
- Field Value:
- "title"
protected JInternalFrame.JDesktopIcon desktopIcon
The JDesktopIcon that represents the JInternalFrame while it is iconified.
protected boolean rootPaneCheckingEnabled
Whether the JInternalFrame has rootPaneChecking enabled.
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.
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.
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.
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.
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.
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.
- 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.iconifiable
- Whether the JInternalFrame is iconifiable.
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.
public void addInternalFrameListener(InternalFrameListener l)
This method adds an InternalFrameListener to this JInternalFrame.
- Parameters:
l
- The listener to add.
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.
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.
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.
protected void fireInternalFrameEvent(int id)
This method fires an InternalFrameEvent to the listeners.
- Parameters:
id
- The type of event being fired. See InternalFrameEvent.
public AccessibleContext getAccessibleContext()
Returns the object that provides accessibility features for thisJInternalFrame
component.
- Specified by:
- getAccessibleContext in interface Accessible
- Overrides:
- getAccessibleContext in interface JComponent
- Returns:
- The accessible context (an instance of
JInternalFrame.AccessibleJInternalFrame
).
public Container getContentPane()
This method returns the Content Pane for this JInternalFrame.
- Specified by:
- getContentPane in interface RootPaneContainer
- Returns:
- The Content Pane for this JInternalFrame.
public int getDefaultCloseOperation()
Returns a code for the default action taken when thisJInternalFrame
is closed.
- Returns:
- The action code (usually one of
WindowConstants.DO_NOTHING_ON_CLOSE
,WindowConstants.HIDE_ON_CLOSE
, orWindowConstants.DISPOSE_ON_CLOSE
).
public JInternalFrame.JDesktopIcon getDesktopIcon()
Returns theJDesktopIcon
that represents thisJInternalFrame
while it is iconified.
- Returns:
- The desktop icon component.
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.
public final Container getFocusCycleRootAncestor()
This method returns null because this must always be the root of a focus traversal.
- Overrides:
- getFocusCycleRootAncestor in interface Component
- Returns:
- always null
- Since:
- 1.4
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.
public Icon getFrameIcon()
This method returns the Frame Icon (the icon used in the JInternalFrame TitlePane and iconified frame).
- Returns:
- The Frame Icon.
public Component getGlassPane()
This method returns the Glass Pane used with this JInternalFrame.
- Specified by:
- getGlassPane in interface RootPaneContainer
- Returns:
- The Glass Pane used with this JInternalFrame.
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.
public JMenuBar getJMenuBar()
This method returns the JMenuBar for this JInternalFrame.
- Returns:
- The JMenuBar for this JInternalFrame.
public int getLayer()
This method returns the layer that this JInternalFrame resides in.
- Returns:
- The layer that this JInternalFrame resides in.
public JLayeredPane getLayeredPane()
This method returns the LayeredPane for this JInternalFrame.
- Specified by:
- getLayeredPane in interface RootPaneContainer
- Returns:
- The LayeredPane for this JInternalFrame.
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.
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.
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).
public JRootPane getRootPane()
This method returns the Root Pane for this JInternalFrame.
- Specified by:
- getRootPane in interface RootPaneContainer
- Overrides:
- getRootPane in interface JComponent
- Returns:
- The Root Pane for this JInternalFrame.
public String getTitle()
Returns the frame's title.
- Returns:
- The frame's title (can be
null
).
- See Also:
setTitle(String)
public InternalFrameUI getUI()
This method returns the UI used to represent the JInternalFrame.
- Returns:
- The UI used to represent the JInternalFrame.
public String getUIClassID()
This method returns a String identifier that is used to determine which class acts as the JInternalFrame's UI.
- Overrides:
- getUIClassID in interface JComponent
- Returns:
- A String identifier to determine a UI class.
public boolean isClosable()
This method returns whether this JInternalFrame is closable.
- Returns:
- Whether this JInternalFrame is closable.
public boolean isClosed()
This method returns whether this JInternalFrame has been closed.
- Returns:
- Whether this JInternalFrame is closed.
public final boolean isFocusCycleRoot()
This must always return true.
- Overrides:
- isFocusCycleRoot in interface Container
- Returns:
- always true
- Since:
- 1.4
public boolean isIcon()
This method returns whether this JInternalFrame is currently iconified.
- Returns:
- Whether this JInternalFrame is currently iconified.
public boolean isIconifiable()
This method returns whether the JInternalFrame can be iconified.
- Returns:
- Whether the JInternalFrame can be iconified.
public boolean isMaximizable()
This method returns whether this JInternalFrame can be maximized.
- Returns:
- Whether this JInternalFrame can be maximized.
public boolean isMaximum()
This method returns whether this JInternalFrame is currently maximized.
- Returns:
- Whether this JInternalFrame is maximized.
public boolean isResizable()
This method returns whether this JInternalFrame is resizable.
- Returns:
- Whether this JInternalFrame is resizable.
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.
public boolean isSelected()
This method returns whether this JInternalFrame is selected.
- Returns:
- Whether this JInternalFrame is selected.
public void moveToBack()
A helper method that moves this JInternalFrame to the back if the parent is a JLayeredPane.
public void moveToFront()
A helper method that moves this JInternalFrame to the front if the parent is a JLayeredPane.
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.
protected void paintComponent(Graphics g)
This method is overridden to allow for speedier painting while this JInternalFramme is being dragged.
- Overrides:
- paintComponent in interface JComponent
- Parameters:
g
- The Graphics object to paint with.
protected String paramString()
An implementation dependent string describing the current state of thisJInternalFrame
instance.
- Overrides:
- paramString in interface JComponent
- Returns:
- A string describing the current state of this
JInternalFrame
instance.
public void remove(Component comp)
This method removes the given Component from the Container.
- Parameters:
comp
- The Component to remove.
public void removeInternalFrameListener(InternalFrameListener l)
This method removes an InternalFrameListener from this JInternalFrame.
- Parameters:
l
- The listener to remove.
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.
- Overrides:
- reshape in interface JComponent
- 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.
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.
public void setClosable(boolean b)
This method sets whether this JInternalFrame can be closed.
- Parameters:
b
- Whether this JInternalFrame can be closed.
public void setClosed(boolean b) throws PropertyVetoException
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.
public void setContentPane(Container c)
This method sets the Container to be used as a Content Pane for this JInternalFrame.
- Specified by:
- setContentPane in interface RootPaneContainer
- Parameters:
c
- The Container to use as a Content Pane.
public void setDefaultCloseOperation(int operation)
Sets a code for the action to be taken when thisJInternalFrame
is closed. Note that no validation is performed on theoperation
code, any integer will be accepted (nevertheless, you should pass in one of the listed values).
- Parameters:
operation
- one ofWindowConstants.DO_NOTHING_ON_CLOSE
,WindowConstants.HIDE_ON_CLOSE
orWindowConstants.DISPOSE_ON_CLOSE
.
public void setDesktopIcon(JInternalFrame.JDesktopIcon d)
Sets theJDesktopIcon
instance that represents thisJInternalFrame
while it is iconified and, if the new icon is not the same instance as the existing icon, sends aPropertyChangeEvent
(with the property name"desktopIcon"
) to all registered listeners..
- Parameters:
d
- the icon.
- See Also:
getDesktopIcon()
public final void setFocusCycleRoot(boolean focusCycleRoot)
This method does nothing because this must be the root of a focus traversal cycle.
- Overrides:
- setFocusCycleRoot in interface Container
- Parameters:
focusCycleRoot
- Not used.
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.
public void setGlassPane(Component glass)
This method sets the Glass Pane used with this JInternalFrame.
- Specified by:
- setGlassPane in interface RootPaneContainer
- Parameters:
glass
- The Glass Pane to use with this JInternalFrame.
public void setIcon(boolean b) throws PropertyVetoException
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!
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.
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.
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.
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.
public void setLayeredPane(JLayeredPane layered)
This method sets the JLayeredPane to use with this JInternalFrame.
- Specified by:
- setLayeredPane in interface RootPaneContainer
- Parameters:
layered
- The JLayeredPane to use as a layeredPane.
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.
public void setMaximizable(boolean b)
This method sets whether the JInternalFrame can be maximized.
- Parameters:
b
- Whether this JInternalFrame can be maximized.
public void setMaximum(boolean b) throws PropertyVetoException
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.
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.
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.
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.
protected void setRootPane(JRootPane root)
This method sets the Root Pane for this JInternalFrame.
- Parameters:
root
- The Root Pane for this JInternalFrame.
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.
public void setSelected(boolean selected) throws PropertyVetoException
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.
public void setTitle(String title)
Sets the title for theJInternalFrame
and sends aPropertyChangeEvent
(with the property nameTITLE_PROPERTY
) to all registered listeners.
- Parameters:
title
- the new title (null
permitted).
- See Also:
getTitle()
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.
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.
public void toBack()
This method causes the JInternalFrame to be brough to back in the z-order.
public void toFront()
This method causes the JInternalFrame to be brought to front in the z-order.
public void updateUI()
This method resets the UI to the Look and Feel defaults.
- Overrides:
- updateUI in interface JComponent