All Packages Class Hierarchy This Package Previous Next Index
Class com.sun.java.swing.JDialog
java.lang.Object
|
+----java.awt.Component
|
+----java.awt.Container
|
+----java.awt.Window
|
+----java.awt.Dialog
|
+----com.sun.java.swing.JDialog
- public class JDialog
- extends Dialog
- implements WindowConstants, Accessible, RootPaneContainer
The main class for creating a dialog window. You can use this class
to create a custom dialog, or invoke the many static methods
in JOptionPane to create a variety of standard dialogs.
The JDialog component contains a JRootPane as it's only
child.
The contentPane
should be the parent of any children of
the JDialog. From the older java.awt.Window
object you
would normally do something like this:
dialog.add(child);
Using JDialog the proper semantic is:
dialog.getContentPane().add(child);
The same priniciple holds true for setting layout managers, removing
components, listing children, etc. All these methods should normally
be sent to the contentPane
instead of to the JDialog.
The contentPane
is always non-null. Attempting to set it
to null generates an exception. The default contentPane
has a BorderLayout manager set on it.
Please see the JRootPane documentation for a complete
description of the contentPane
, glassPane
,
and layeredPane
components.
NOTE: For 1.1, Modal dialogs are currently constrained to only allow
lightweight popup menus (JPopupMenu, JComboBox, JMenuBar) because
of window ownership limitations in AWT1.1. This creates the further
limitation of not being able to mix Swing popup components with
AWT heavyweight components in a modal dialog since the heavyweight
components would always overlap the lightweights, potentially
obscuring the popup menu.
(A heavyweight component uses a native-platform component (peer)
component for its implementation -- AWT components are heavyweight
components.)
For the keyboard keys used by this component in the standard Look and
Feel (L&F) renditions, see the
JDialog key assignments.
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 Swing1.0 applications. It will
not be possible to load serialized Swing1.0 objects with future releases
of Swing. The JDK1.2 release of Swing will be the compatibility
baseline for the serialized form of Swing objects.
- See Also:
- JOptionPane, JRootPane
-
accessibleContext
-
-
rootPane
-
-
rootPaneCheckingEnabled
-
-
JDialog()
- Creates a non-modal dialog without a title and without
a specified Frame owner.
-
JDialog(Frame)
- Creates a non-modal dialog without a title with the
specifed Frame as its owner.
-
JDialog(Frame, boolean)
- Creates a modal or non-modal dialog without a title and
with the specified owner frame.
-
JDialog(Frame, String)
- Creates a non-modal dialog with the specified title and
with the specified owner frame.
-
JDialog(Frame, String, boolean)
- Creates a modal or non-modal dialog with the specified title
and the specified owner frame.
-
addImpl(Component, Object, int)
- By default, children may not be added directly to a this component,
they must be added to its contentPane instead.
-
createRootPane()
- Called by the constructor methods to create the default rootPane.
-
dialogInit()
- Called by the constructors to init the JDialog properly.
-
getAccessibleContext()
- Get the AccessibleContext associated with this JDialog
-
getContentPane()
- Returns the contentPane object for this dialog.
-
getDefaultCloseOperation()
- Returns the operation which occurs when the user
initiates a "close" on this dialog.
-
getGlassPane()
- Returns the glassPane object for this dialog.
-
getJMenuBar()
- Returns the menubar set on this dialog.
-
getLayeredPane()
- Returns the layeredPane object for this dialog.
-
getRootPane()
- Returns the rootPane object for this dialog.
-
isRootPaneCheckingEnabled()
-
-
processWindowEvent(WindowEvent)
- Handles window events depending on the state of the
defaultCloseOperation
property.
-
setContentPane(Container)
- Sets the contentPane property.
-
setDefaultCloseOperation(int)
- Sets the operation which will happen by default when
the user initiates a "close" on this dialog.
-
setGlassPane(Component)
- Sets the glassPane property.
-
setJMenuBar(JMenuBar)
- Sets the menubar for this dialog.
-
setLayeredPane(JLayeredPane)
- Sets the layeredPane property.
-
setLayout(LayoutManager)
- By default the layout of this component may not be set,
the layout of its contentPane should be set instead.
-
setLocationRelativeTo(Component)
- Sets the location of the dialog relative to the specified
component.
-
setRootPane(JRootPane)
- Sets the rootPane property.
-
setRootPaneCheckingEnabled(boolean)
- If true then calls to add() and setLayout() will cause an exception
to be thrown.
-
update(Graphics)
-
Just calls
paint(g)
.
rootPane
protected JRootPane rootPane
- See Also:
- getRootPane, setRootPane
rootPaneCheckingEnabled
protected boolean rootPaneCheckingEnabled
- See Also:
- isRootPaneCheckingEnabled, setRootPaneCheckingEnabled
accessibleContext
protected AccessibleContext accessibleContext
JDialog
public JDialog()
- Creates a non-modal dialog without a title and without
a specified Frame owner. A shared, hidden frame will be
set as the owner of the Dialog.
JDialog
public JDialog(Frame owner)
- Creates a non-modal dialog without a title with the
specifed Frame as its owner.
- Parameters:
- owner - the Frame from which the dialog is displayed
JDialog
public JDialog(Frame owner,
boolean modal)
- Creates a modal or non-modal dialog without a title and
with the specified owner frame.
NOTE: Modal dialogs cannot have heavyweight components in them.
- Parameters:
- owner - the Frame from which the dialog is displayed
- modal - true for a modal dialog, false for one that allows
others windows to be active at the same time
JDialog
public JDialog(Frame owner,
String title)
- Creates a non-modal dialog with the specified title and
with the specified owner frame.
- Parameters:
- owner - the Frame from which the dialog is displayed
- title - the String to display in the dialog's title bar
JDialog
public JDialog(Frame owner,
String title,
boolean modal)
- Creates a modal or non-modal dialog with the specified title
and the specified owner frame.
NOTE: Any popup components (JComboBox, JPopupMenu, JMenuBar)
created within a modal dialog will be forced to be lightweight.
- Parameters:
- owner - the frame from which the dialog is displayed
- title - the String to display in the dialog's title bar
- modal - true for a modal dialog, false for one that allows
others windows to be active at the same time
dialogInit
protected void dialogInit()
- Called by the constructors to init the JDialog properly.
createRootPane
protected JRootPane createRootPane()
- Called by the constructor methods to create the default rootPane.
processWindowEvent
protected void processWindowEvent(WindowEvent e)
- Handles window events depending on the state of the
defaultCloseOperation
property.
- Overrides:
- processWindowEvent in class Window
- See Also:
- setDefaultCloseOperation
setDefaultCloseOperation
public void setDefaultCloseOperation(int operation)
- Sets the operation which will happen by default when
the user initiates a "close" on this dialog.
The possible choices are:
- DO_NOTHING_ON_CLOSE - do not do anything - require the
program to handle the operation in the windowClosing
method of a registered WindowListener object.
- HIDE_ON_CLOSE - automatically hide the dialog after
invoking any registered WindowListener objects
- DISPOSE_ON_CLOSE - automatically hide and dispose the
dialog after invoking any registered WindowListener objects
The value is set to HIDE_ON_CLOSE by default.
- See Also:
- addWindowListener, getDefaultCloseOperation
getDefaultCloseOperation
public int getDefaultCloseOperation()
- Returns the operation which occurs when the user
initiates a "close" on this dialog.
- Returns:
- an int indicating the window-close operation
- See Also:
- setDefaultCloseOperation
update
public void update(Graphics g)
- Just calls
paint(g)
. This method was overridden to
prevent an unneccessary call to clear the background.
- Overrides:
- update in class Container
setJMenuBar
public void setJMenuBar(JMenuBar menu)
- Sets the menubar for this dialog.
- Parameters:
- menubar - the menubar being placed in the dialog
- See Also:
- getJMenuBar
getJMenuBar
public JMenuBar getJMenuBar()
- Returns the menubar set on this dialog.
- See Also:
- setJMenuBar
isRootPaneCheckingEnabled
protected boolean isRootPaneCheckingEnabled()
- Returns:
- true if add and setLayout should be checked
- See Also:
- addImpl, setLayout, setRootPaneCheckingEnabled
setRootPaneCheckingEnabled
protected void setRootPaneCheckingEnabled(boolean enabled)
- If true then calls to add() and setLayout() will cause an exception
to be thrown.
- See Also:
- addImpl, setLayout, isRootPaneCheckingEnabled
addImpl
protected void addImpl(Component comp,
Object constraints,
int index)
- By default, children may not be added directly to a this component,
they must be added to its contentPane instead. For example:
thisComponent.getContentPane().add(child)
An attempt to add to directly to this component will cause an
runtime exception to be thrown. Subclasses can disable this
behavior.
- Throws: Error
- if called with rootPaneChecking true
- Overrides:
- addImpl in class Container
- See Also:
- setRootPaneCheckingEnabled
setLayout
public void setLayout(LayoutManager manager)
- By default the layout of this component may not be set,
the layout of its contentPane should be set instead.
For example:
thisComponent.getContentPane().setLayout(new BorderLayout())
An attempt to set the layout of this component will cause an
runtime exception to be thrown. Subclasses can disable this
behavior.
- Throws: Error
- if called with rootPaneChecking true
- Overrides:
- setLayout in class Container
- See Also:
- setRootPaneCheckingEnabled
getRootPane
public JRootPane getRootPane()
- Returns the rootPane object for this dialog.
- See Also:
- setRootPane, getRootPane
setRootPane
protected void setRootPane(JRootPane root)
- Sets the rootPane property. This method is called by the constructor.
- Parameters:
- root - the rootPane object for this dialog
- See Also:
- getRootPane
getContentPane
public Container getContentPane()
- Returns the contentPane object for this dialog.
- See Also:
- setContentPane, getContentPane
setContentPane
public void setContentPane(Container contentPane)
- Sets the contentPane property. This method is called by the constructor.
- Parameters:
- contentPane - the contentPane object for this dialog
- Throws: IllegalComponentStateException
- (a runtime
exception) if the content pane parameter is null
- See Also:
- getContentPane, setContentPane
getLayeredPane
public JLayeredPane getLayeredPane()
- Returns the layeredPane object for this dialog.
- See Also:
- setLayeredPane, getLayeredPane
setLayeredPane
public void setLayeredPane(JLayeredPane layeredPane)
- Sets the layeredPane property. This method is called by the constructor.
- Parameters:
- layeredPane - the layeredPane object for this dialog
- Throws: IllegalComponentStateException
- (a runtime
exception) if the layered pane parameter is null
- See Also:
- getLayeredPane, setLayeredPane
getGlassPane
public Component getGlassPane()
- Returns the glassPane object for this dialog.
- See Also:
- setGlassPane, getGlassPane
setGlassPane
public void setGlassPane(Component glassPane)
- Sets the glassPane property.
This method is called by the constructor.
- Parameters:
- glassPane - the glassPane object for this dialog
- See Also:
- getGlassPane, setGlassPane
setLocationRelativeTo
public void setLocationRelativeTo(Component c)
- Sets the location of the dialog relative to the specified
component. If the component is not currently showing, the
dialog is centered on the screen.
- Parameters:
- c - the component in relation to which the dialog's location
is determined
getAccessibleContext
public AccessibleContext getAccessibleContext()
- Get the AccessibleContext associated with this JDialog
- Returns:
- the AccessibleContext of this JDialog
All Packages Class Hierarchy This Package Previous Next Index