Simple example of usage: *
* NotifyDescriptor d =
* new NotifyDescriptor.Message("Hello...", NotifyDescriptor.INFORMATION_MESSAGE);
* DialogDisplayer.getDefault().notify(d);
*
* or to get a result:
*
* NotifyDescriptor d =
* new NotifyDescriptor.Confirmation("Really do this?!", "Dialog Title",
* NotifyDescriptor.OK_CANCEL_OPTION);
* if (DialogDisplayer.getDefault().notify(d) == NotifyDescriptor.OK_OPTION) {
* // really do it...
* }
*
* @see DialogDisplayer#notify
* @author David Peroutka, Jaroslav Tulach
*/
public class NotifyDescriptor extends Object {
// Property constants
/** Name of property for the message to be displayed. */
public static final String PROP_MESSAGE = "message"; // NOI18N
/** Name of property for the type of message to use. */
public static final String PROP_MESSAGE_TYPE = "messageType"; // NOI18N
/** Name of property for the style of options available. */
public static final String PROP_OPTION_TYPE = "optionType"; // NOI18N
/** Name of property for the exact list of options. */
public static final String PROP_OPTIONS = "options"; // NOI18N
/** Name of property for the value the user selected. */
public static final String PROP_VALUE = "value"; // NOI18N
/** Name of property for the dialog title. */
public static final String PROP_TITLE = "title"; // NOI18N
/** Name of property for the detail message reported. */
public static final String PROP_DETAIL = "detail"; // NOI18N
/** Name of property for the OK button validation. */
public static final String PROP_VALID = "valid"; // NOI18N
/** Name of property for the error message at the bottom of the wizard.
* To set such message use {@link #createNotificationLineSupport}
*
* @since 7.10
*/
public static final String PROP_ERROR_NOTIFICATION = "errorNotification"; // NOI18N
/** Name of property for the error message at the bottom of the wizard.
* To set such message use {@link #createNotificationLineSupport}
*
* @since 7.10
*/
public static final String PROP_WARNING_NOTIFICATION = "warningNotification"; // NOI18N
/** Name of property for the error message at the bottom of the wizard.
* To set such message use {@link #createNotificationLineSupport}
*
* @since 7.10
*/
public static final String PROP_INFO_NOTIFICATION = "infoNotification"; // NOI18N
//
// Return values
//
/** Return value if YES is chosen. */
public static final Object YES_OPTION = new Integer(JOptionPane.YES_OPTION);
/** Return value if NO is chosen. */
public static final Object NO_OPTION = new Integer(JOptionPane.NO_OPTION);
/** Return value if CANCEL is chosen. */
public static final Object CANCEL_OPTION = new Integer(JOptionPane.CANCEL_OPTION);
/** Return value if OK is chosen. */
public static final Object OK_OPTION = new Integer(JOptionPane.OK_OPTION);
/** Return value if user closes the window without pressing any button. */
public static final Object CLOSED_OPTION = new Integer(JOptionPane.CLOSED_OPTION);
//
// Option types
//
/** Option type used by default. */
public static final int DEFAULT_OPTION = JOptionPane.DEFAULT_OPTION;
/** Option type used for negatable confirmations. */
public static final int YES_NO_OPTION = JOptionPane.YES_NO_OPTION;
/** Option type used for negatable and cancellable confirmations. */
public static final int YES_NO_CANCEL_OPTION = JOptionPane.YES_NO_CANCEL_OPTION;
/** Option type used for cancellable confirmations. */
public static final int OK_CANCEL_OPTION = JOptionPane.OK_CANCEL_OPTION;
//
// Message types
//
/** Message type for error messages. */
public static final int ERROR_MESSAGE = JOptionPane.ERROR_MESSAGE;
/** Message type for information messages. */
public static final int INFORMATION_MESSAGE = JOptionPane.INFORMATION_MESSAGE;
/** Message type for warning messages. */
public static final int WARNING_MESSAGE = JOptionPane.WARNING_MESSAGE;
/** Message type for questions. */
public static final int QUESTION_MESSAGE = JOptionPane.QUESTION_MESSAGE;
/** Plain message type using no icon. */
public static final int PLAIN_MESSAGE = JOptionPane.PLAIN_MESSAGE;
/** Maximum text width to which the text is wrapped */
private static final int MAXIMUM_TEXT_WIDTH = 100;
/** preferred width of text area */
private static final int SIZE_PREFERRED_WIDTH = 300;
/** preferred height of text area */
private static final int SIZE_PREFERRED_HEIGHT = 100;
private Object message;
/** The message type. */
private int messageType = PLAIN_MESSAGE;
/** The option type specifying the user-selectable options. */
private int optionType;
/** The option object specifying the user-selectable options. */
private Object[] options;
/** The option object specifying the additional user-selectable options. */
private Object[] adOptions;
/** The user's choice value object. */
private Object value;
/** The default initial value. */
private Object defaultValue;
/** The title string for the report. */
private String title;
/** Is OK button valid (enabled). */
private boolean valid = true;
private NotificationLineSupport notificationLineSupport = null;
private String infoMsg;
private String warnMsg;
private String errMsg;
/** The object specifying the detail object. */
// private Object detail;
/** Property change support. */
private PropertyChangeSupport changeSupport;
/**
* Creates a new notify descriptor with specified information to report.
*
* If optionType is {@link #YES_NO_OPTION} or {@link #YES_NO_CANCEL_OPTION}
* and the options parameter is null, then the options are
* supplied by the look and feel.
*
* The messageType parameter is primarily used to supply a
* default icon from the look and feel.
*
* @param message the object to display
* @param title the title string for the dialog
* @param optionType indicates which options are available
* @param messageType indicates what type of message should be displayed
* @param options an array of objects indicating the possible choices
* @param initialValue the object that represents the default value
*
* @see #getMessage
* @see #getMessageType
* @see #getOptions
* @see #getOptionType
* @see #getValue
*/
public NotifyDescriptor(
Object message, String title, int optionType, int messageType, Object[] options, Object initialValue
) {
this.message = message;
this.messageType = messageType;
this.options = options;
this.optionType = optionType;
this.title = title;
this.value = initialValue;
this.defaultValue = initialValue;
}
/** Method that is called before a value is returned from any of
* getter methods in this object.
*
* Allows subclasses to do some additional initialization actions.
*/
protected void initialize() {
}
/** Checks for initialization.
*/
final void getterCalled() {
boolean init = false;
synchronized (this) {
if (changeSupport == null) {
changeSupport = new java.beans.PropertyChangeSupport(this);
init = true;
}
}
if (init) {
initialize();
}
}
//
// Getters/setters for properties.
//
/**
* Return true if OK button is valid (enabled), otherwise return false.
* @see #setValid
*
* @return validity status of OK button.
*/
public final boolean isValid() {
getterCalled();
return valid;
}
/** Set validity of OK button.
* @see #isValid
* @param newValid validity status of OK button
*/
public final void setValid(boolean newValid) {
boolean oldValid = valid;
valid = newValid;
firePropertyChange(
PROP_VALID, oldValid ? Boolean.TRUE : Boolean.FALSE, newValid ? Boolean.TRUE : Boolean.FALSE
);
}
/**
* Define a descriptive message to be reported. In the most common
* usage, the message is just a String. However, the type
* of this parameter is actually Object. Its interpretation depends on
* its type:
* Object[]Component is displayed in the dialog.
* Icon is wrapped in a {@link JLabel} and displayed in the dialog.
* Object to report
* @see #getMessage
*/
public void setMessage(Object newMessage) {
Object oldMessage = message;
if (newMessage instanceof String) {
// bugfix #25457, use JTextArea for word-wrapping
JTextArea area = new JTextArea((String) newMessage);
area.setPreferredSize(new Dimension(SIZE_PREFERRED_WIDTH, SIZE_PREFERRED_HEIGHT));
area.setBackground(UIManager.getColor("Label.background")); // NOI18N
area.setBorder(BorderFactory.createEmptyBorder());
area.setLineWrap(true);
area.setWrapStyleWord(true);
area.setEditable(false);
area.setFocusable(true);
area.getAccessibleContext().setAccessibleName(NbBundle.getMessage(NotifyDescriptor.class, "ACN_NotifyDescriptor_MessageJTextArea")); // NOI18N
area.getAccessibleContext().setAccessibleDescription(NbBundle.getMessage(NotifyDescriptor.class, "ACD_NotifyDescriptor_MessageJTextArea")); // NOI18N
newMessage = area;
}
message = newMessage;
firePropertyChange(PROP_MESSAGE, oldMessage, newMessage);
}
/**
* Get the message object.
* @see #setMessage
*
* @return the Object that is to be reported
*/
public Object getMessage() {
getterCalled();
return message;
}
/**
* Define the style of the message. The look and feel manager may lay out
* the dialog differently depending on this value, and will often provide
* a default icon. The possible values are:
* Strings. But the parameter type is an array of Objects. Its
* interpretation depends on its type:
* Object is {@link Object#toString converted} to a string and the result is used to
* label a JButton.
* Objects that give the user's choices
*
* @see #setOptions
*/
public Object[] getOptions() {
getterCalled();
if (options != null) {
return options.clone ();
}
return options;
}
/**
* Define an explicit description of the set of additional user-selectable options.
* Additional options are supposed to be used for help button, etc.
*
* The usual value for the options parameter is an array of
* Strings. But the parameter type is an array of Objects. Its
* interpretation depends on its type:
*
Object is {@link Object#toString converted} to a string and the result is used to
* label a JButton.
* Objects that give the user's choices
*
* @see #setOptions
*/
public Object[] getAdditionalOptions() {
getterCalled();
if (adOptions != null) {
return adOptions.clone ();
}
return null;
}
/**
* Sets the value w/o firing property change. The caller this is responsible
* to notify this change.
*/
void setValueWithoutPCH(Object newValue) {
value = newValue;
}
/**
* Set the value the user has chosen and fires appropriate property change.
* You probably do not want to call this yourself, of course.
*
* @param newValue the chosen value
*
* @see #getValue
*/
public void setValue(Object newValue) {
Object oldValue = value;
setValueWithoutPCH(newValue);
firePropertyChange(PROP_VALUE, oldValue, newValue);
}
/**
* Get the value the user has selected.
*
* @return an Object indicating the option selected by the user
*
* @see #setValue
*/
public Object getValue() {
getterCalled();
return value;
}
/**
* Get the default value of descriptor.
*
* @return an Object that represents the default value
* @since 5.9
*/
public Object getDefaultValue() {
return defaultValue;
}
/**
* Set the title string for this report description.
*
* @param newTitle the title of this description
*
* @see #getTitle
*/
public void setTitle(String newTitle) {
Object oldTitle = title;
title = newTitle;
firePropertyChange(PROP_TITLE, oldTitle, newTitle);
}
/**
* Get the title string for this report description.
*
* @return the title of this description
*
* @see #setTitle
*/
public String getTitle() {
getterCalled();
return title;
}
/** Create {@link NotificationLineSupport} if you want to notify users
* using info/warning/error messages in designed line at the bottom
* of your dialog. These message will be labelled with appropriate icons.
* null if doesn't.
* String. However, the type of this
* parameter is actually Object. Its interpretation depends on its type:
* Object[]ThrowablePropertyChangeListener to be added
*/
public void addPropertyChangeListener(PropertyChangeListener listener) {
getterCalled();
changeSupport.addPropertyChangeListener(listener);
}
/**
* Remove a {@link PropertyChangeListener} from the listener list.
*
* @param listener the PropertyChangeListener to be removed
*/
public void removePropertyChangeListener(PropertyChangeListener listener) {
if (changeSupport != null) {
changeSupport.removePropertyChangeListener(listener);
}
}
/**
* Fire a {@link PropertyChangeEvent} to each listener.
*
* @param propertyName the programmatic name of the property that was changed
* @param oldValue the old value of the property
* @param newValue the new value of the property
*/
protected void firePropertyChange(String propertyName, Object oldValue, Object newValue) {
if (changeSupport != null) {
changeSupport.firePropertyChange(propertyName, oldValue, newValue);
}
}
/**
* Get the title to use for the indicated type.
* @param messageType the type of message
* @return the title to use
*/
protected static String getTitleForType(int messageType) {
switch (messageType) {
case ERROR_MESSAGE:
return NbBundle.getMessage(NotifyDescriptor.class, "NTF_ErrorTitle");
case WARNING_MESSAGE:
return NbBundle.getMessage(NotifyDescriptor.class, "NTF_WarningTitle");
case QUESTION_MESSAGE:
return NbBundle.getMessage(NotifyDescriptor.class, "NTF_QuestionTitle");
case INFORMATION_MESSAGE:
return NbBundle.getMessage(NotifyDescriptor.class, "NTF_InformationTitle");
case PLAIN_MESSAGE:
return NbBundle.getMessage(NotifyDescriptor.class, "NTF_PlainTitle");
}
return ""; // NOI18N
}
/**
* Provides information about the results of a command. Offers
* no user choices; the user can only acknowledge the message.
*/
public static class Message extends NotifyDescriptor {
/**
* Create an informational report about the results of a command.
*
* @param message the message object
* @see NotifyDescriptor#NotifyDescriptor
*/
public Message(Object message) {
this(message, INFORMATION_MESSAGE);
}
/**
* Create a report about the results of a command.
*
* @param message the message object
* @param messageType the type of message to be displayed
* @see NotifyDescriptor#NotifyDescriptor
*/
public Message(Object message, int messageType) {
super(
message, NotifyDescriptor.getTitleForType(messageType), DEFAULT_OPTION, messageType,
new Object[] { OK_OPTION }, OK_OPTION
);
}
}
/**
* Provides a description of a possible action and requests confirmation from the user before proceeding.
* This should be used to alert the user to a condition
* or situation that requires the user's decision before proceeding, such
* as an impending action with potentially destructive or irreversible
* consequences. It is conventionally in the form of a question: for example,
* "Save changes to TestForm?"
*/
public static class Confirmation extends NotifyDescriptor {
/**
* Create a yes/no/cancel question with default title.
*
* @param message the message object
* @see NotifyDescriptor#NotifyDescriptor
*/
public Confirmation(Object message) {
this(message, YES_NO_CANCEL_OPTION);
}
/**
* Create a yes/no/cancel question.
*
* @param message the message object
* @param title the dialog title
* @see NotifyDescriptor#NotifyDescriptor
*/
public Confirmation(Object message, String title) {
this(message, title, YES_NO_CANCEL_OPTION);
}
/**
* Create a question with default title.
*
* @param message the message object
* @param optionType the type of options to display to the user
* @see NotifyDescriptor#NotifyDescriptor
*/
public Confirmation(Object message, int optionType) {
this(message, optionType, QUESTION_MESSAGE);
}
/**
* Create a question.
*
* @param message the message object
* @param title the dialog title
* @param optionType the type of options to display to the user
* @see NotifyDescriptor#NotifyDescriptor
*/
public Confirmation(Object message, String title, int optionType) {
this(message, title, optionType, QUESTION_MESSAGE);
}
/**
* Create a confirmation with default title.
*
* @param message the message object
* @param optionType the type of options to display to the user
* @param messageType the type of message to use
* @see NotifyDescriptor#NotifyDescriptor
*/
public Confirmation(Object message, int optionType, int messageType) {
super(
message, NotifyDescriptor.getTitleForType(messageType), optionType, messageType,
(optionType == DEFAULT_OPTION) ? new Object[] { OK_OPTION } : null, OK_OPTION
);
}
/**
* Create a confirmation.
*
* @param message the message object
* @param title the dialog title
* @param optionType the type of options to display to the user
* @param messageType the type of message to use
* @see NotifyDescriptor#NotifyDescriptor
*/
public Confirmation(Object message, String title, int optionType, int messageType) {
super(
message, title, optionType, messageType,
(optionType == DEFAULT_OPTION) ? new Object[] { OK_OPTION } : null, OK_OPTION
);
}
}
/**
* Provides a description of an exception that occurred during
* execution of the IDE. The best is to use this class together with
* {@link DialogDisplayer#notifyLater} as that allows an exception
* to be notified from any thread.
* @deprecated No longer used. Try {@link java.util.logging} or {@link org.openide.util.Exceptions}.
*/
@Deprecated
public static final class Exception extends Confirmation {
static final long serialVersionUID = -3387516993124229948L;
/**
* Create an exception report with default message.
*
* @param detail the detail object
*/
public Exception(Throwable detail) {
this(detail, detail.getMessage());
// handle InvocationTargetExceptions
if (detail instanceof InvocationTargetException) {
Throwable target = ((InvocationTargetException) detail).getTargetException();
this.setMessage(target);
Object msgObj = this.getMessage();
if ((msgObj == null) || "".equals(msgObj)) { // NOI18N
String msg = target.getMessage();
msg = org.openide.util.Utilities.wrapString(
msg, MAXIMUM_TEXT_WIDTH, java.text.BreakIterator.getCharacterInstance(), false
);
this.setMessage(msg);
}
}
Object obj = this.getMessage();
// emphasize user-non-friendly exceptions
if ((obj == null) || "".equals(obj)) { // NOI18N
this.setMessage(
NbBundle.getMessage(
NotifyDescriptor.class, "NTF_ExceptionalException", detail.getClass().getName(),
System.getProperty("netbeans.user") + java.io.File.separator + "system"
)
); // NOI18N
this.setTitle(NbBundle.getMessage(NotifyDescriptor.class, "NTF_ExceptionalExceptionTitle"));
}
}
/**
* Create an exception report.
*
* @param detail the detail object
* @param message the message object
*/
public Exception(Throwable detail, Object message) {
super(message, DEFAULT_OPTION, ERROR_MESSAGE);
// customize descriptor
// this.setDetail(detail);
this.setTitle(NbBundle.getMessage(NotifyDescriptor.class, "NTF_ExceptionTitle"));
}
}
/** Notification providing for a line of text input.
* @author Dafe Simonek
*/
public static class InputLine extends NotifyDescriptor {
/**
* The text field used to enter the input.
*/
protected JTextField textField;
/** Construct dialog with the specified title and label text.
* @param text label text
* @param title title of the dialog
*/
public InputLine(final String text, final String title) {
this(text, title, OK_CANCEL_OPTION, PLAIN_MESSAGE);
}
/** Construct dialog with the specified title, label text, option and
* message types.
* @param text label text
* @param title title of the dialog
* @param optionType option type (ok, cancel, ...)
* @param messageType message type (question, ...)
*/
public InputLine(final String text, final String title, final int optionType, final int messageType) {
super(null, title, optionType, messageType, null, null);
super.setMessage(createDesign(text));
}
/**
* Get the text which the user typed into the input line.
* @return the text entered by the user
*/
public String getInputText() {
return textField.getText();
}
/**
* Set the text on the input line.
* @param text the new text
*/
public void setInputText(final String text) {
textField.setText(text);
textField.selectAll();
}
/** Make a component representing the input line.
* @param text a label for the input line
* @return the component
*/
protected Component createDesign(final String text) {
JPanel panel = new JPanel();
panel.setOpaque (false);
JLabel textLabel = new JLabel();
Mnemonics.setLocalizedText(textLabel, text);
boolean longText = text.length () > 80;
textField = new JTextField(25);
textLabel.setLabelFor(textField);
textField.requestFocus();
GroupLayout layout = new GroupLayout(panel);
panel.setLayout(layout);
if (longText) {
layout.setHorizontalGroup(
layout.createParallelGroup(Alignment.LEADING)
.addGroup(layout.createSequentialGroup()
.addContainerGap()
.addGroup(layout.createParallelGroup(Alignment.LEADING)
.addGroup(layout.createSequentialGroup()
.addComponent(textLabel, GroupLayout.DEFAULT_SIZE, GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE)
.addGap(32, 32, 32))
.addComponent(textField))
.addContainerGap())
);
} else {
layout.setHorizontalGroup(
layout.createParallelGroup(Alignment.LEADING)
.addGroup(layout.createSequentialGroup()
.addContainerGap()
.addComponent(textLabel)
.addPreferredGap(LayoutStyle.ComponentPlacement.RELATED)
.addComponent(textField, GroupLayout.DEFAULT_SIZE, 207, Short.MAX_VALUE)
.addContainerGap())
);
}
if (longText) {
layout.setVerticalGroup(
layout.createParallelGroup(Alignment.LEADING)
.addGroup(layout.createSequentialGroup()
.addContainerGap()
.addComponent(textLabel)
.addPreferredGap(LayoutStyle.ComponentPlacement.RELATED)
.addComponent(textField, GroupLayout.PREFERRED_SIZE, GroupLayout.DEFAULT_SIZE, GroupLayout.PREFERRED_SIZE)
.addContainerGap(GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE))
);
} else {
layout.setVerticalGroup(
layout.createParallelGroup(Alignment.LEADING)
.addGroup(layout.createSequentialGroup()
.addContainerGap()
.addGroup(layout.createParallelGroup(Alignment.BASELINE)
.addComponent(textLabel)
.addComponent(textField, GroupLayout.PREFERRED_SIZE, GroupLayout.DEFAULT_SIZE, GroupLayout.PREFERRED_SIZE))
.addContainerGap(GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE))
);
}
javax.swing.KeyStroke enter = javax.swing.KeyStroke.getKeyStroke(java.awt.event.KeyEvent.VK_ENTER, 0);
javax.swing.text.Keymap map = textField.getKeymap();
map.removeKeyStrokeBinding(enter);
/*
textField.addActionListener (new java.awt.event.ActionListener () {
public void actionPerformed (java.awt.event.ActionEvent evt) {
System.out.println("action: " + evt);
InputLine.this.setValue (OK_OPTION);
}
}
);
*/
panel.getAccessibleContext().setAccessibleDescription(
NbBundle.getMessage(NotifyDescriptor.class, "ACSD_InputPanel")
);
textField.getAccessibleContext().setAccessibleDescription(
NbBundle.getMessage(NotifyDescriptor.class, "ACSD_InputField")
);
return panel;
}
}
// end of InputLine
}