|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--java.awt.Window | +--java.awt.Dialog | +--javax.swing.JDialog
The main class for creating a dialog window. You can use this class
to create a custom dialog, or invoke the many class methods
in JOptionPane
to create a variety of standard dialogs.
For information about creating dialogs, see
The Java Tutorial section
How
to Make Dialogs.
The JDialog
component contains a JRootPane
as its 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.
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 applications running the same version of Swing. A future release of Swing will provide support for long term persistence.
JOptionPane
,
JRootPane
, Serialized FormInner Class Summary | |
protected class |
JDialog.AccessibleJDialog
This class implements accessibility support for the JDialog class. |
Inner classes inherited from class java.awt.Dialog |
Dialog.AccessibleAWTDialog |
Inner classes inherited from class java.awt.Window |
Window.AccessibleAWTWindow |
Inner classes inherited from class java.awt.Container |
Container.AccessibleAWTContainer |
Inner classes inherited from class java.awt.Component |
Component.AccessibleAWTComponent |
Field Summary | |
protected AccessibleContext |
accessibleContext
|
protected JRootPane |
rootPane
|
protected boolean |
rootPaneCheckingEnabled
|
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface javax.swing.WindowConstants |
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
JDialog()
Creates a non-modal dialog without a title and without a specified Frame owner. |
|
JDialog(Dialog owner)
Creates a non-modal dialog without a title with the specifed Dialog as its owner. |
|
JDialog(Dialog owner,
boolean modal)
Creates a modal or non-modal dialog without a title and with the specified owner dialog. |
|
JDialog(Dialog owner,
String title)
Creates a non-modal dialog with the specified title and with the specified owner dialog. |
|
JDialog(Dialog owner,
String title,
boolean modal)
Creates a modal or non-modal dialog with the specified title and the specified owner frame. |
|
JDialog(Frame owner)
Creates a non-modal dialog without a title with the specifed Frame as its owner. |
|
JDialog(Frame owner,
boolean modal)
Creates a modal or non-modal dialog without a title and with the specified owner Frame . |
|
JDialog(Frame owner,
String title)
Creates a non-modal dialog with the specified title and with the specified owner frame. |
|
JDialog(Frame owner,
String title,
boolean modal)
Creates a modal or non-modal dialog with the specified title and the specified owner Frame . |
Method Summary | |
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. |
protected JRootPane |
createRootPane()
Called by the constructor methods to create the default rootPane . |
protected void |
dialogInit()
Called by the constructors to init the JDialog properly. |
AccessibleContext |
getAccessibleContext()
Gets the AccessibleContext associated with this JDialog. |
Container |
getContentPane()
Returns the contentPane object for this dialog. |
int |
getDefaultCloseOperation()
Returns the operation which occurs when the user initiates a "close" on this dialog. |
Component |
getGlassPane()
Returns the glassPane object for this dialog. |
JMenuBar |
getJMenuBar()
Returns the menubar set on this dialog. |
JLayeredPane |
getLayeredPane()
Returns the layeredPane object for this dialog. |
JRootPane |
getRootPane()
Returns the rootPane object for this dialog. |
protected boolean |
isRootPaneCheckingEnabled()
Returns true if the methods add and setLayout
should be checked. |
protected String |
paramString()
Returns a string representation of this JDialog . |
protected void |
processKeyEvent(KeyEvent e)
Processes key events occurring on this component and, if appropriate, passes them on to components in the dialog which have registered interest in them. |
protected void |
processWindowEvent(WindowEvent e)
Handles window events depending on the state of the defaultCloseOperation property. |
void |
remove(Component comp)
Removes the specified component from this container. |
void |
setContentPane(Container contentPane)
Sets the contentPane property. |
void |
setDefaultCloseOperation(int operation)
Sets the operation which will happen by default when the user initiates a "close" on this dialog. |
void |
setGlassPane(Component glassPane)
Sets the glassPane property. |
void |
setJMenuBar(JMenuBar menu)
Sets the menubar for this dialog. |
void |
setLayeredPane(JLayeredPane layeredPane)
Sets the layeredPane property. |
void |
setLayout(LayoutManager manager)
By default the layout of this component may not be set, the layout of its contentPane should be set instead. |
void |
setLocationRelativeTo(Component c)
Sets the location of the dialog relative to the specified component. |
protected void |
setRootPane(JRootPane root)
Sets the rootPane property. |
protected void |
setRootPaneCheckingEnabled(boolean enabled)
If true then calls to add and setLayout
will cause an exception to be thrown. |
void |
update(Graphics g)
Calls paint(g) . |
Methods inherited from class java.awt.Dialog |
addNotify, dispose, getTitle, hide, isModal, isResizable, setModal, setResizable, setTitle, show |
Methods inherited from class java.awt.Window |
addWindowListener, applyResourceBundle, applyResourceBundle, finalize, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, toBack, toFront |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFont, validate, validateTree |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected JRootPane rootPane
getRootPane()
,
setRootPane(javax.swing.JRootPane)
protected boolean rootPaneCheckingEnabled
isRootPaneCheckingEnabled()
,
setRootPaneCheckingEnabled(boolean)
protected AccessibleContext accessibleContext
Constructor Detail |
public JDialog()
Frame
owner. A shared, hidden frame will be
set as the owner of the dialog.public JDialog(Frame owner)
Frame
as its owner.owner
- the Frame
from which the dialog is displayedpublic JDialog(Frame owner, boolean modal)
Frame
.owner
- the Frame
from which the dialog is displayedmodal
- true for a modal dialog, false for one that allows
others windows to be active at the same timepublic JDialog(Frame owner, String title)
owner
- the Frame
from which the dialog is displayedtitle
- the String
to display in the dialog's
title barpublic JDialog(Frame owner, String title, boolean modal)
Frame
. All constructors
defer to this one.
NOTE: Any popup components (JComboBox
,
JPopupMenu
, JMenuBar
)
created within a modal dialog will be forced to be lightweight.
owner
- the Frame
from which the dialog is displayedtitle
- the String
to display in the dialog's
title barmodal
- true for a modal dialog, false for one that allows
other windows to be active at the same timepublic JDialog(Dialog owner)
Dialog
as its owner.owner
- the Dialog
from which the dialog is displayedpublic JDialog(Dialog owner, boolean modal)
owner
- the Dialog
from which the dialog is displayedmodal
- true for a modal dialog, false for one that allows
other windows to be active at the same timepublic JDialog(Dialog owner, String title)
owner
- the Dialog
from which the dialog is displayedtitle
- the String
to display in the dialog's
title barpublic JDialog(Dialog owner, String title, boolean modal)
owner
- the Dialog
from which the dialog is displayedtitle
- the String
to display in the dialog's
title barmodal
- true for a modal dialog, false for one that allows
other windows to be active at the same timeMethod Detail |
protected void dialogInit()
JDialog
properly.protected JRootPane createRootPane()
rootPane
.protected void processKeyEvent(KeyEvent e)
processKeyEvent
in class Component
e
- the key eventComponent.processKeyEvent(java.awt.event.KeyEvent)
protected void processWindowEvent(WindowEvent e)
defaultCloseOperation
property.processWindowEvent
in class Window
setDefaultCloseOperation(int)
public void setDefaultCloseOperation(int operation)
windowClosing
method of a registered WindowListener
object.
WindowListener
objects
WindowListener
objects
The value is set to HIDE_ON_CLOSE by default.
Window.addWindowListener(java.awt.event.WindowListener)
,
getDefaultCloseOperation()
public int getDefaultCloseOperation()
setDefaultCloseOperation(int)
public void update(Graphics g)
paint(g)
. This method was overridden to
prevent an unneccessary call to clear the background.update
in class Container
java.awt.Container
g
- the specified Graphics windowComponent.update(java.awt.Graphics)
public void setJMenuBar(JMenuBar menu)
menubar
- the menubar being placed in the dialoggetJMenuBar()
public JMenuBar getJMenuBar()
setJMenuBar(javax.swing.JMenuBar)
protected boolean isRootPaneCheckingEnabled()
add
and setLayout
should be checked.add
and setLayout
should
be checkedaddImpl(java.awt.Component, java.lang.Object, int)
,
setLayout(java.awt.LayoutManager)
,
setRootPaneCheckingEnabled(boolean)
protected void setRootPaneCheckingEnabled(boolean enabled)
add
and setLayout
will cause an exception to be thrown.addImpl(java.awt.Component, java.lang.Object, int)
,
setLayout(java.awt.LayoutManager)
,
isRootPaneCheckingEnabled()
protected void addImpl(Component comp, Object constraints, int index)
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 if rootPaneCheckingEnabled is true. Subclasses can disable this behavior.
addImpl
in class Container
comp
- the Component
to be enhancedconstraints
- the constraints to be respectedindex
- the index (an integer)Error
- if called with rootPaneCheckingEnabled truesetRootPaneCheckingEnabled(boolean)
public void remove(Component comp)
remove
in class Container
comp
- the component to be removedContainer.add(java.awt.Component)
public void setLayout(LayoutManager manager)
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 if rootPaneCheckingEnabled is true. Subclasses can disable this behavior.
setLayout
in class Container
manager
- the LayoutManager
Error
- if called with rootPaneChecking truesetRootPaneCheckingEnabled(boolean)
public JRootPane getRootPane()
rootPane
object for this dialog.getRootPane
in interface RootPaneContainer
setRootPane(javax.swing.JRootPane)
,
RootPaneContainer.getRootPane()
protected void setRootPane(JRootPane root)
rootPane
property.
This method is called by the constructor.root
- the rootPane
object for this dialoggetRootPane()
public Container getContentPane()
contentPane
object for this dialog.getContentPane
in interface RootPaneContainer
contentPane
propertysetContentPane(java.awt.Container)
,
RootPaneContainer.getContentPane()
public void setContentPane(Container contentPane)
contentPane
property.
This method is called by the constructor.setContentPane
in interface RootPaneContainer
contentPane
- the contentPane
object for this dialogIllegalComponentStateException
- (a runtime
exception) if the content pane parameter is null
getContentPane()
,
RootPaneContainer.setContentPane(java.awt.Container)
public JLayeredPane getLayeredPane()
layeredPane
object for this dialog.getLayeredPane
in interface RootPaneContainer
layeredPane
propertysetLayeredPane(javax.swing.JLayeredPane)
,
RootPaneContainer.getLayeredPane()
public void setLayeredPane(JLayeredPane layeredPane)
layeredPane
property.
This method is called by the constructor.setLayeredPane
in interface RootPaneContainer
layeredPane
- the new layeredPane
propertyIllegalComponentStateException
- (a runtime
exception) if the layered pane parameter is nullgetLayeredPane()
,
RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)
public Component getGlassPane()
glassPane
object for this dialog.getGlassPane
in interface RootPaneContainer
glassPane
propertysetGlassPane(java.awt.Component)
,
RootPaneContainer.getGlassPane()
public void setGlassPane(Component glassPane)
glassPane
property.
This method is called by the constructor.setGlassPane
in interface RootPaneContainer
glassPane
- the glassPane
object for this dialoggetGlassPane()
,
RootPaneContainer.setGlassPane(java.awt.Component)
public void setLocationRelativeTo(Component c)
c
- the component in relation to which the dialog's location
is determinedprotected String paramString()
JDialog
.
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
.paramString
in class Dialog
JDialog
.public AccessibleContext getAccessibleContext()
getAccessibleContext
in interface Accessible
getAccessibleContext
in class Dialog
|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.