public class MessageDialog
extends java.lang.Object
implements java.awt.event.ActionListener, java.awt.event.ComponentListener
The properties include the dialog type, the content, and the set of command button labels.
The dialog type is supplied as a constant of class MessageDialog.Type, and determines layout and icon. The types are the following:
ERROR INFORMATION PLAIN No icon. QUESTION WARNING
The content is supplied as Objects. The objects are displayed in a vertical stack in accordance with their type:
Object[] Displayed in a vertical stack in accordance with their type. Component Displayed as supplied. Icon Displayed in a JLabel. other Displayed using its toString() in a JLabel.The contents can be supplied in one call through
setContent(java.lang.Object...)
or
piecemeal through addContent(java.lang.Object...)
.
The commands are specified as an array of Object
s, where the
object can be either a String or a Component. Components (usually buttons)
are placed in the dialog directly; for each string, a button is created and
placed with the string as the text.
The show()
method indicates the command chosen by the user by
returning the corresponding string or component. It returns null
if the user closed the dialog without choosing a command.
Modifier and Type | Class and Description |
---|---|
protected static class |
MessageDialog.OptionPane |
static class |
MessageDialog.Type |
Modifier and Type | Field and Description |
---|---|
static MessageDialog.Type |
ERROR |
static MessageDialog.Type |
INFORMATION |
static MessageDialog.Type |
PLAIN |
static MessageDialog.Type |
QUESTION |
static MessageDialog.Type |
WARNING |
Constructor and Description |
---|
MessageDialog()
Creates a message dialog.
|
MessageDialog(MessageDialog.Type type)
Creates an option dialog of a specific type.
|
Modifier and Type | Method and Description |
---|---|
void |
actionPerformed(java.awt.event.ActionEvent event)
Handle the action performed event for a command supplied as an
AbstractButton . |
void |
addContent(java.lang.Object... content)
Adds content to the dialog.
|
void |
componentHidden(java.awt.event.ComponentEvent e) |
void |
componentMoved(java.awt.event.ComponentEvent e) |
void |
componentResized(java.awt.event.ComponentEvent e) |
void |
componentShown(java.awt.event.ComponentEvent e) |
void |
setCommands(java.lang.Object... commands)
Sets the commands of the dialog.
|
void |
setContent(java.lang.Object... content)
Sets the content of the dialog.
|
void |
setException(java.lang.Throwable exception)
Sets an exception associated with the content of this dialog.
|
void |
setResizeable(boolean resizeable)
Sets whether the dialog is resizeable.
|
void |
setTitle(java.lang.String title)
Sets the title of the dialog.
|
void |
setType(MessageDialog.Type type)
Sets the type of the dialog.
|
java.lang.Object |
show()
Show the dialog with a default parent.
|
java.lang.Object |
show(java.awt.Component parent)
Show the dialog.
|
public static final MessageDialog.Type ERROR
public static final MessageDialog.Type INFORMATION
public static final MessageDialog.Type PLAIN
public static final MessageDialog.Type QUESTION
public static final MessageDialog.Type WARNING
public MessageDialog()
public MessageDialog(MessageDialog.Type type)
type
- The type of the message, one of the following MessageDialog.Type
constants:ERROR
INFORMATION
PLAIN
(no icon)
QUESTION
WARNING
setType(oracle.jdevimpl.audit.swing.MessageDialog.Type)
public void addContent(java.lang.Object... content)
content
- The content to be appended to the dialog box.public void setCommands(java.lang.Object... commands)
commands
- The command names or components.public void setContent(java.lang.Object... content)
content
- The content to be placed in the dialog box.public void setException(java.lang.Throwable exception)
exception
- public void setResizeable(boolean resizeable)
public void setTitle(java.lang.String title)
title
- The title of the dialog.public void setType(MessageDialog.Type type)
type
- The type of the message, one of the following
MessageDialog.Type constants:ERROR
INFORMATION
PLAIN
No icon.QUESTION
WARNING
public java.lang.Object show()
public java.lang.Object show(java.awt.Component parent)
parent
- The parent component of this dialog.public void actionPerformed(java.awt.event.ActionEvent event)
AbstractButton
.actionPerformed
in interface java.awt.event.ActionListener
public void componentHidden(java.awt.event.ComponentEvent e)
componentHidden
in interface java.awt.event.ComponentListener
public void componentMoved(java.awt.event.ComponentEvent e)
componentMoved
in interface java.awt.event.ComponentListener
public void componentResized(java.awt.event.ComponentEvent e)
componentResized
in interface java.awt.event.ComponentListener
public void componentShown(java.awt.event.ComponentEvent e)
componentShown
in interface java.awt.event.ComponentListener