declare namespace javax { namespace swing { /** * JOptionPane makes it easy to pop up a standard dialog box that * prompts users for a value or informs them of something. * For information about using JOptionPane, see * How to Make Dialogs, * a section in The Java Tutorial. *

* While the JOptionPane * class may appear complex because of the large number of methods, almost * all uses of this class are one-line calls to one of the static * showXxxDialog methods shown below: *

* * * * * * * * * * * * * * * * * * * * * *
Method Name Description
showConfirmDialog Asks a confirming question, like yes/no/cancel.
showInputDialog Prompt for some input.
showMessageDialog Tell the user about something that has happened.
showOptionDialog The Grand Unification of the above three.
*

Method Name	Description
showConfirmDialog	Asks a confirming question, like yes/no/cancel.
showInputDialog	Prompt for some input.
showMessageDialog	Tell the user about something that has happened.
showOptionDialog	The Grand Unification of the above three.

* Each of these methods also comes in a showInternalXXX * flavor, which uses an internal frame to hold the dialog box (see * {@link JInternalFrame}). * Multiple convenience methods have also been defined -- overloaded * versions of the basic methods that use different parameter lists. *

* All dialogs are modal. Each showXxxDialog method blocks * the caller until the user's interaction is complete. * * * * * * * * * * * *
icon message
input value
option buttons
* The basic appearance of one of these dialog boxes is generally * similar to the picture at the right, although the various * look-and-feels are * ultimately responsible for the final result. In particular, the * look-and-feels will adjust the layout to accommodate the option pane's * ComponentOrientation property. *
*

* Parameters:
* The parameters to these methods follow consistent patterns: *

*
*
parentComponent
* Defines the Component that is to be the parent of this * dialog box. * It is used in two ways: the Frame that contains * it is used as the Frame * parent for the dialog box, and its screen coordinates are used in * the placement of the dialog box. In general, the dialog box is placed * just below the component. This parameter may be null, * in which case a default Frame is used as the parent, * and the dialog will be * centered on the screen (depending on the {@literal L&F}). *
message
* A descriptive message to be placed in the dialog box. * In the most common usage, message is just a String or * String constant. * However, the type of this parameter is actually Object. Its * interpretation depends on its type: *
*
Object[]
An array of objects is interpreted as a series of * messages (one per object) arranged in a vertical stack. * The interpretation is recursive -- each object in the * array is interpreted according to its type. *
Component
The Component is displayed in the dialog. *
Icon
The Icon is wrapped in a JLabel * and displayed in the dialog. *
others
The object is converted to a String by calling * its toString method. The result is wrapped in a * JLabel and displayed. *
*
messageType
Defines 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: *
*
ERROR_MESSAGE *
INFORMATION_MESSAGE *
WARNING_MESSAGE *
QUESTION_MESSAGE *
PLAIN_MESSAGE *
*
optionType
Defines the set of option buttons that appear at * the bottom of the dialog box: *
*
DEFAULT_OPTION *
YES_NO_OPTION *
YES_NO_CANCEL_OPTION *
OK_CANCEL_OPTION *
* You aren't limited to this set of option buttons. You can provide any * buttons you want using the options parameter. *
options
A more detailed description of the set of option buttons * that will appear at the bottom of the dialog box. * The usual value for the options parameter is an array of * Strings. But * the parameter type is an array of Objects. * A button is created for each object depending on its type: *
*
Component
The component is added to the button row directly. *
Icon
A JButton is created with this as its label. *
other
The Object is converted to a string using its * toString method and the result is used to * label a JButton. *
*
icon
A decorative icon to be placed in the dialog box. A default * value for this is determined by the messageType parameter. *
title
The title for the dialog box. *
initialValue
The default selection (input value). *
*

* When the selection is changed, setValue is invoked, * which generates a PropertyChangeEvent. *

* If a JOptionPane has configured to all input * setWantsInput * the bound property JOptionPane.INPUT_VALUE_PROPERTY * can also be listened * to, to determine when the user has input or selected a value. *

* When one of the showXxxDialog methods returns an integer, * the possible values are: *

YES_OPTION *
NO_OPTION *
CANCEL_OPTION *
OK_OPTION *
CLOSED_OPTION *

* Examples: *

Show an error dialog that displays the message, 'alert': *


         * JOptionPane.showMessageDialog(null, "alert", "alert", JOptionPane.ERROR_MESSAGE);
         *

Show an internal information dialog with the message, 'information': *

         * JOptionPane.showInternalMessageDialog(frame, "information",
         * "information", JOptionPane.INFORMATION_MESSAGE);
         *

Show an information panel with the options yes/no and message 'choose one': *

JOptionPane.showConfirmDialog(null,
         * "choose one", "choose one", JOptionPane.YES_NO_OPTION);
         *

Show an internal information dialog with the options yes/no/cancel and * message 'please choose one' and title information: *

JOptionPane.showInternalConfirmDialog(frame,
         * "please choose one", "information",
         * JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.INFORMATION_MESSAGE);
         *

Show a warning dialog with the options OK, CANCEL, title 'Warning', and * message 'Click OK to continue': *

         * Object[] options = { "OK", "CANCEL" };
         * JOptionPane.showOptionDialog(null, "Click OK to continue", "Warning",
         * JOptionPane.DEFAULT_OPTION, JOptionPane.WARNING_MESSAGE,
         * null, options, options[0]);
         *

Show a dialog asking the user to type in a String: *


         * String inputValue = JOptionPane.showInputDialog("Please input a value");
         *

Show a dialog asking the user to select a String: *

         * Object[] possibleValues = { "First", "Second", "Third" };

         * Object selectedValue = JOptionPane.showInputDialog(null,
         * "Choose one", "Input",
         * JOptionPane.INFORMATION_MESSAGE, null,
         * possibleValues, possibleValues[0]);
         *

* Direct Use:
* To create and use an JOptionPane directly, the * standard pattern is roughly as follows: *

         * JOptionPane pane = new JOptionPane(arguments);
         * pane.set.Xxxx(...); // Configure
         * JDialog dialog = pane.createDialog(parentComponent, title);
         * dialog.show();
         * Object selectedValue = pane.getValue();
         * if(selectedValue == null)
         * return CLOSED_OPTION;
         * //If there is not an array of option buttons:
         * if(options == null) {
         * if(selectedValue instanceof Integer)
         * return ((Integer)selectedValue).intValue();
         * return CLOSED_OPTION;
         * }
         * //If there is an array of option buttons:
         * for(int counter = 0, maxCounter = options.length;
         * counter < maxCounter; counter++) {
         * if(options[counter].equals(selectedValue))
         * return counter;
         * }
         * return CLOSED_OPTION;
         *

* Warning: Swing is not thread safe. For more * information see Swing's Threading * Policy. *

* 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. As of 1.4, support for long term storage * of all JavaBeans™ * has been added to the java.beans package. * Please see {@link java.beans.XMLEncoder}. * @see JInternalFrame * @beaninfo attribute: isContainer true * description: A component which implements standard dialog box controls. * @author James Gosling * @author Scott Violet */ // @ts-ignore class JOptionPane extends javax.swing.JComponent implements javax.accessibility.Accessible { /** * Creates a JOptionPane with a test message. */ // @ts-ignore constructor() /** * Creates a instance of JOptionPane to display a * message using the * plain-message message type and the default options delivered by * the UI. * @param message the Object to display */ // @ts-ignore constructor(message: java.lang.Object | any) /** * Creates an instance of JOptionPane to display a message * with the specified message type and the default options, * @param message the Object to display * @param messageType the type of message to be displayed: * ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE */ // @ts-ignore constructor(message: java.lang.Object | any, messageType: number /*int*/) /** * Creates an instance of JOptionPane to display a message * with the specified message type and options. * @param message the Object to display * @param messageType the type of message to be displayed: * ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE * @param optionType the options to display in the pane: * DEFAULT_OPTION, YES_NO_OPTION, * YES_NO_CANCEL_OPTION, * OK_CANCEL_OPTION */ // @ts-ignore constructor(message: java.lang.Object | any, messageType: number /*int*/, optionType: number /*int*/) /** * Creates an instance of JOptionPane to display a message * with the specified message type, options, and icon. * @param message the Object to display * @param messageType the type of message to be displayed: * ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE * @param optionType the options to display in the pane: * DEFAULT_OPTION, YES_NO_OPTION, * YES_NO_CANCEL_OPTION, * OK_CANCEL_OPTION * @param icon the Icon image to display */ // @ts-ignore constructor(message: java.lang.Object | any, messageType: number /*int*/, optionType: number /*int*/, icon: javax.swing.Icon) /** * Creates an instance of JOptionPane to display a message * with the specified message type, icon, and options. * None of the options is initially selected. *

* The options objects should contain either instances of * Components, (which are added directly) or * Strings (which are wrapped in a JButton). * If you provide Components, you must ensure that when the * Component is clicked it messages setValue * in the created JOptionPane. * @param message the Object to display * @param messageType the type of message to be displayed: * ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE * @param optionType the options to display in the pane: * DEFAULT_OPTION, * YES_NO_OPTION, * YES_NO_CANCEL_OPTION, * OK_CANCEL_OPTION * @param icon the Icon image to display * @param options the choices the user can select */ // @ts-ignore constructor(message: java.lang.Object | any, messageType: number /*int*/, optionType: number /*int*/, icon: javax.swing.Icon, options: java.lang.Object[] | any[]) /** * Creates an instance of JOptionPane to display a message * with the specified message type, icon, and options, with the * initially-selected option specified. * @param message the Object to display * @param messageType the type of message to be displayed: * ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE * @param optionType the options to display in the pane: * DEFAULT_OPTION, * YES_NO_OPTION, * YES_NO_CANCEL_OPTION, * OK_CANCEL_OPTION * @param icon the Icon image to display * @param options the choices the user can select * @param initialValue the choice that is initially selected; if * null, then nothing will be initially selected; * only meaningful if options is used */ // @ts-ignore constructor(message: java.lang.Object | any, messageType: number /*int*/, optionType: number /*int*/, icon: javax.swing.Icon, options: java.lang.Object[] | any[], initialValue: java.lang.Object | any) /** * Indicates that the user has not yet selected a value. */ // @ts-ignore public static readonly UNINITIALIZED_VALUE: java.lang.Object | any /** * Type meaning Look and Feel should not supply any options -- only * use the options from the JOptionPane. */ // @ts-ignore public static readonly DEFAULT_OPTION: number /*int*/ /** * Type used for showConfirmDialog. */ // @ts-ignore public static readonly YES_NO_OPTION: number /*int*/ /** * Type used for showConfirmDialog. */ // @ts-ignore public static readonly YES_NO_CANCEL_OPTION: number /*int*/ /** * Type used for showConfirmDialog. */ // @ts-ignore public static readonly OK_CANCEL_OPTION: number /*int*/ /** * Return value from class method if YES is chosen. */ // @ts-ignore public static readonly YES_OPTION: number /*int*/ /** * Return value from class method if NO is chosen. */ // @ts-ignore public static readonly NO_OPTION: number /*int*/ /** * Return value from class method if CANCEL is chosen. */ // @ts-ignore public static readonly CANCEL_OPTION: number /*int*/ /** * Return value form class method if OK is chosen. */ // @ts-ignore public static readonly OK_OPTION: number /*int*/ /** * Return value from class method if user closes window without selecting * anything, more than likely this should be treated as either a * CANCEL_OPTION or NO_OPTION. */ // @ts-ignore public static readonly CLOSED_OPTION: number /*int*/ /** * Used for error messages. */ // @ts-ignore public static readonly ERROR_MESSAGE: number /*int*/ /** * Used for information messages. */ // @ts-ignore public static readonly INFORMATION_MESSAGE: number /*int*/ /** * Used for warning messages. */ // @ts-ignore public static readonly WARNING_MESSAGE: number /*int*/ /** * Used for questions. */ // @ts-ignore public static readonly QUESTION_MESSAGE: number /*int*/ /** * No icon is used. */ // @ts-ignore public static readonly PLAIN_MESSAGE: number /*int*/ /** * Bound property name for icon. */ // @ts-ignore public static readonly ICON_PROPERTY: java.lang.String | string /** * Bound property name for message. */ // @ts-ignore public static readonly MESSAGE_PROPERTY: java.lang.String | string /** * Bound property name for value. */ // @ts-ignore public static readonly VALUE_PROPERTY: java.lang.String | string /** * Bound property name for option. */ // @ts-ignore public static readonly OPTIONS_PROPERTY: java.lang.String | string /** * Bound property name for initialValue. */ // @ts-ignore public static readonly INITIAL_VALUE_PROPERTY: java.lang.String | string /** * Bound property name for type. */ // @ts-ignore public static readonly MESSAGE_TYPE_PROPERTY: java.lang.String | string /** * Bound property name for optionType. */ // @ts-ignore public static readonly OPTION_TYPE_PROPERTY: java.lang.String | string /** * Bound property name for selectionValues. */ // @ts-ignore public static readonly SELECTION_VALUES_PROPERTY: java.lang.String | string /** * Bound property name for initialSelectionValue. */ // @ts-ignore public static readonly INITIAL_SELECTION_VALUE_PROPERTY: java.lang.String | string /** * Bound property name for inputValue. */ // @ts-ignore public static readonly INPUT_VALUE_PROPERTY: java.lang.String | string /** * Bound property name for wantsInput. */ // @ts-ignore public static readonly WANTS_INPUT_PROPERTY: java.lang.String | string /** * Icon used in pane. */ // @ts-ignore icon: javax.swing.Icon /** * Message to display. */ // @ts-ignore message: java.lang.Object | any /** * Options to display to the user. */ // @ts-ignore options: java.lang.Object[] | any[] /** * Value that should be initially selected in options. */ // @ts-ignore initialValue: java.lang.Object | any /** * Message type. */ // @ts-ignore messageType: number /*int*/ /** * Option type, one of DEFAULT_OPTION, * YES_NO_OPTION, * YES_NO_CANCEL_OPTION or * OK_CANCEL_OPTION. */ // @ts-ignore optionType: number /*int*/ /** * Currently selected value, will be a valid option, or * UNINITIALIZED_VALUE or null. */ // @ts-ignore value: java.lang.Object | any /** * Array of values the user can choose from. Look and feel will * provide the UI component to choose this from. */ // @ts-ignore selectionValues: java.lang.Object[] | any[] /** * Value the user has input. */ // @ts-ignore inputValue: java.lang.Object | any /** * Initial value to select in selectionValues. */ // @ts-ignore initialSelectionValue: java.lang.Object | any /** * If true, a UI widget will be provided to the user to get input. */ // @ts-ignore wantsInput: boolean /** * Shows a question-message dialog requesting input from the user. The * dialog uses the default frame, which usually means it is centered on * the screen. * @param message the Object to display * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static showInputDialog(message: java.lang.Object | any): string /** * Shows a question-message dialog requesting input from the user, with * the input value initialized to initialSelectionValue. The * dialog uses the default frame, which usually means it is centered on * the screen. * @param message the Object to display * @param initialSelectionValue the value used to initialize the input * field * @since 1.4 */ // @ts-ignore public static showInputDialog(message: java.lang.Object | any, initialSelectionValue: java.lang.Object | any): string /** * Shows a question-message dialog requesting input from the user * parented to parentComponent. * The dialog is displayed on top of the Component's * frame, and is usually positioned below the Component. * @param parentComponent the parent Component for the * dialog * @param message the Object to display * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static showInputDialog(parentComponent: java.awt.Component, message: java.lang.Object | any): string /** * Shows a question-message dialog requesting input from the user and * parented to parentComponent. The input value will be * initialized to initialSelectionValue. * The dialog is displayed on top of the Component's * frame, and is usually positioned below the Component. * @param parentComponent the parent Component for the * dialog * @param message the Object to display * @param initialSelectionValue the value used to initialize the input * field * @since 1.4 */ // @ts-ignore public static showInputDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, initialSelectionValue: java.lang.Object | any): string /** * Shows a dialog requesting input from the user parented to * parentComponent with the dialog having the title * title and message type messageType. * @param parentComponent the parent Component for the * dialog * @param message the Object to display * @param title the String to display in the dialog * title bar * @param messageType the type of message that is to be displayed: * ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static showInputDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, messageType: number /*int*/): string /** * Prompts the user for input in a blocking dialog where the * initial selection, possible selections, and all other options can * be specified. The user will able to choose from * selectionValues, where null implies the * user can input * whatever they wish, usually by means of a JTextField. * initialSelectionValue is the initial value to prompt * the user with. It is up to the UI to decide how best to represent * the selectionValues, but usually a * JComboBox, JList, or * JTextField will be used. * @param parentComponent the parent Component for the * dialog * @param message the Object to display * @param title the String to display in the * dialog title bar * @param messageType the type of message to be displayed: * ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE * @param icon the Icon image to display * @param selectionValues an array of Objects that * gives the possible selections * @param initialSelectionValue the value used to initialize the input * field * @return user's input, or null meaning the user * canceled the input * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static showInputDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, messageType: number /*int*/, icon: javax.swing.Icon, selectionValues: java.lang.Object[] | any[], initialSelectionValue: java.lang.Object | any): any /** * Brings up an information-message dialog titled "Message". * @param parentComponent determines the Frame in * which the dialog is displayed; if null, * or if the parentComponent has no * Frame, a default Frame is used * @param message the Object to display * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static showMessageDialog(parentComponent: java.awt.Component, message: java.lang.Object | any): void /** * Brings up a dialog that displays a message using a default * icon determined by the messageType parameter. * @param parentComponent determines the Frame * in which the dialog is displayed; if null, * or if the parentComponent has no * Frame, a default Frame is used * @param message the Object to display * @param title the title string for the dialog * @param messageType the type of message to be displayed: * ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static showMessageDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, messageType: number /*int*/): void /** * Brings up a dialog displaying a message, specifying all parameters. * @param parentComponent determines the Frame in which the * dialog is displayed; if null, * or if the parentComponent has no * Frame, a * default Frame is used * @param message the Object to display * @param title the title string for the dialog * @param messageType the type of message to be displayed: * ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE * @param icon an icon to display in the dialog that helps the user * identify the kind of message that is being displayed * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static showMessageDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, messageType: number /*int*/, icon: javax.swing.Icon): void /** * Brings up a dialog with the options Yes, * No and Cancel; with the * title, Select an Option. * @param parentComponent determines the Frame in which the * dialog is displayed; if null, * or if the parentComponent has no * Frame, a * default Frame is used * @param message the Object to display * @return an integer indicating the option selected by the user * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static showConfirmDialog(parentComponent: java.awt.Component, message: java.lang.Object | any): number /*int*/ /** * Brings up a dialog where the number of choices is determined * by the optionType parameter. * @param parentComponent determines the Frame in which the * dialog is displayed; if null, * or if the parentComponent has no * Frame, a * default Frame is used * @param message the Object to display * @param title the title string for the dialog * @param optionType an int designating the options available on the dialog: * YES_NO_OPTION, * YES_NO_CANCEL_OPTION, * or OK_CANCEL_OPTION * @return an int indicating the option selected by the user * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static showConfirmDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, optionType: number /*int*/): number /*int*/ /** * Brings up a dialog where the number of choices is determined * by the optionType parameter, where the * messageType * parameter determines the icon to display. * The messageType parameter is primarily used to supply * a default icon from the Look and Feel. * @param parentComponent determines the Frame in * which the dialog is displayed; if null, * or if the parentComponent has no * Frame, a * default Frame is used. * @param message the Object to display * @param title the title string for the dialog * @param optionType an integer designating the options available * on the dialog: YES_NO_OPTION, * YES_NO_CANCEL_OPTION, * or OK_CANCEL_OPTION * @param messageType an integer designating the kind of message this is; * primarily used to determine the icon from the pluggable * Look and Feel: ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE * @return an integer indicating the option selected by the user * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static showConfirmDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, optionType: number /*int*/, messageType: number /*int*/): number /*int*/ /** * Brings up a dialog with a specified icon, where the number of * choices is determined by the optionType parameter. * The messageType parameter is primarily used to supply * a default icon from the look and feel. * @param parentComponent determines the Frame in which the * dialog is displayed; if null, * or if the parentComponent has no * Frame, a * default Frame is used * @param message the Object to display * @param title the title string for the dialog * @param optionType an int designating the options available on the dialog: * YES_NO_OPTION, * YES_NO_CANCEL_OPTION, * or OK_CANCEL_OPTION * @param messageType an int designating the kind of message this is, * primarily used to determine the icon from the pluggable * Look and Feel: ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE * @param icon the icon to display in the dialog * @return an int indicating the option selected by the user * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static showConfirmDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, optionType: number /*int*/, messageType: number /*int*/, icon: javax.swing.Icon): number /*int*/ /** * Brings up a dialog with a specified icon, where the initial * choice is determined by the initialValue parameter and * the number of choices is determined by the optionType * parameter. *

* If optionType is YES_NO_OPTION, * or 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 parentComponent determines the Frame * in which the dialog is displayed; if * null, or if the * parentComponent has no * Frame, a * default Frame is used * @param message the Object to display * @param title the title string for the dialog * @param optionType an integer designating the options available on the * dialog: DEFAULT_OPTION, * YES_NO_OPTION, * YES_NO_CANCEL_OPTION, * or OK_CANCEL_OPTION * @param messageType an integer designating the kind of message this is, * primarily used to determine the icon from the * pluggable Look and Feel: ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE * @param icon the icon to display in the dialog * @param options an array of objects indicating the possible choices * the user can make; if the objects are components, they * are rendered properly; non-String * objects are * rendered using their toString methods; * if this parameter is null, * the options are determined by the Look and Feel * @param initialValue the object that represents the default selection * for the dialog; only meaningful if options * is used; can be null * @return an integer indicating the option chosen by the user, * or CLOSED_OPTION if the user closed * the dialog * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static showOptionDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, optionType: number /*int*/, messageType: number /*int*/, icon: javax.swing.Icon, options: java.lang.Object[] | any[], initialValue: java.lang.Object | any): number /*int*/ /** * Creates and returns a new JDialog wrapping * this centered on the parentComponent * in the parentComponent's frame. * title is the title of the returned dialog. * The returned JDialog will not be resizable by the * user, however programs can invoke setResizable on * the JDialog instance to change this property. * The returned JDialog will be set up such that * once it is closed, or the user clicks on one of the buttons, * the optionpane's value property will be set accordingly and * the dialog will be closed. Each time the dialog is made visible, * it will reset the option pane's value property to * JOptionPane.UNINITIALIZED_VALUE to ensure the * user's subsequent action closes the dialog properly. * @param parentComponent determines the frame in which the dialog * is displayed; if the parentComponent has * no Frame, a default Frame is used * @param title the title string for the dialog * @return a new JDialog containing this instance * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public createDialog(parentComponent: java.awt.Component, title: java.lang.String | string): javax.swing.JDialog /** * Creates and returns a new parentless JDialog * with the specified title. * The returned JDialog will not be resizable by the * user, however programs can invoke setResizable on * the JDialog instance to change this property. * The returned JDialog will be set up such that * once it is closed, or the user clicks on one of the buttons, * the optionpane's value property will be set accordingly and * the dialog will be closed. Each time the dialog is made visible, * it will reset the option pane's value property to * JOptionPane.UNINITIALIZED_VALUE to ensure the * user's subsequent action closes the dialog properly. * @param title the title string for the dialog * @return a new JDialog containing this instance * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see java.awt.GraphicsEnvironment#isHeadless * @since 1.6 */ // @ts-ignore public createDialog(title: java.lang.String | string): javax.swing.JDialog /** * Brings up an internal confirmation dialog panel. The dialog * is a information-message dialog titled "Message". * @param parentComponent determines the Frame * in which the dialog is displayed; if null, * or if the parentComponent has no * Frame, a default Frame is used * @param message the object to display */ // @ts-ignore public static showInternalMessageDialog(parentComponent: java.awt.Component, message: java.lang.Object | any): void /** * Brings up an internal dialog panel that displays a message * using a default icon determined by the messageType * parameter. * @param parentComponent determines the Frame * in which the dialog is displayed; if null, * or if the parentComponent has no * Frame, a default Frame is used * @param message the Object to display * @param title the title string for the dialog * @param messageType the type of message to be displayed: * ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE */ // @ts-ignore public static showInternalMessageDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, messageType: number /*int*/): void /** * Brings up an internal dialog panel displaying a message, * specifying all parameters. * @param parentComponent determines the Frame * in which the dialog is displayed; if null, * or if the parentComponent has no * Frame, a default Frame is used * @param message the Object to display * @param title the title string for the dialog * @param messageType the type of message to be displayed: * ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, * or PLAIN_MESSAGE * @param icon an icon to display in the dialog that helps the user * identify the kind of message that is being displayed */ // @ts-ignore public static showInternalMessageDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, messageType: number /*int*/, icon: javax.swing.Icon): void /** * Brings up an internal dialog panel with the options Yes, No * and Cancel; with the title, Select an Option. * @param parentComponent determines the Frame in * which the dialog is displayed; if null, * or if the parentComponent has no * Frame, a default Frame is used * @param message the Object to display * @return an integer indicating the option selected by the user */ // @ts-ignore public static showInternalConfirmDialog(parentComponent: java.awt.Component, message: java.lang.Object | any): number /*int*/ /** * Brings up a internal dialog panel where the number of choices * is determined by the optionType parameter. * @param parentComponent determines the Frame * in which the dialog is displayed; if null, * or if the parentComponent has no * Frame, a default Frame is used * @param message the object to display in the dialog; a * Component object is rendered as a * Component; a String * object is rendered as a string; other objects * are converted to a String using the * toString method * @param title the title string for the dialog * @param optionType an integer designating the options * available on the dialog: YES_NO_OPTION, * or YES_NO_CANCEL_OPTION * @return an integer indicating the option selected by the user */ // @ts-ignore public static showInternalConfirmDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, optionType: number /*int*/): number /*int*/ /** * Brings up an internal dialog panel where the number of choices * is determined by the optionType parameter, where * the messageType parameter determines the icon to display. * The messageType parameter is primarily used to supply * a default icon from the Look and Feel. * @param parentComponent determines the Frame in * which the dialog is displayed; if null, * or if the parentComponent has no * Frame, a default Frame is used * @param message the object to display in the dialog; a * Component object is rendered as a * Component; a String * object is rendered as a string; other objects are * converted to a String using the * toString method * @param title the title string for the dialog * @param optionType an integer designating the options * available on the dialog: * YES_NO_OPTION, or YES_NO_CANCEL_OPTION * @param messageType an integer designating the kind of message this is, * primarily used to determine the icon from the * pluggable Look and Feel: ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, QUESTION_MESSAGE, * or PLAIN_MESSAGE * @return an integer indicating the option selected by the user */ // @ts-ignore public static showInternalConfirmDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, optionType: number /*int*/, messageType: number /*int*/): number /*int*/ /** * Brings up an internal dialog panel with a specified icon, where * the number of choices is determined by the optionType * parameter. * The messageType parameter is primarily used to supply * a default icon from the look and feel. * @param parentComponent determines the Frame * in which the dialog is displayed; if null, * or if the parentComponent has no Frame, a * default Frame is used * @param message the object to display in the dialog; a * Component object is rendered as a * Component; a String * object is rendered as a string; other objects are * converted to a String using the * toString method * @param title the title string for the dialog * @param optionType an integer designating the options available * on the dialog: * YES_NO_OPTION, or * YES_NO_CANCEL_OPTION. * @param messageType an integer designating the kind of message this is, * primarily used to determine the icon from the pluggable * Look and Feel: ERROR_MESSAGE, * INFORMATION_MESSAGE, * WARNING_MESSAGE, QUESTION_MESSAGE, * or PLAIN_MESSAGE * @param icon the icon to display in the dialog * @return an integer indicating the option selected by the user */ // @ts-ignore public static showInternalConfirmDialog(parentComponent: java.awt.Component, message: java.lang.Object | any, title: java.lang.String | string, optionType: number /*int*/, messageType: number /*int*/, icon: javax.swing.Icon): number /*int*/ /** * Brings up an internal dialog panel with a specified icon, where * the initial choice is determined by the initialValue * parameter and the number of choices is determined by the * optionType parameter. *

* If optionType is YES_NO_OPTION, or * YES_NO_CANCEL_OPTION * and the options parameter is null, * then the options are supplied by the Look and Feel. *

* Note: * It is recommended that rather than using this method you supply a valid parent. * @param newRootFrame the default Frame to use */ // @ts-ignore public static setRootFrame(newRootFrame: java.awt.Frame): void /** * Returns the Frame to use for the class methods in * which a frame is not provided. * @return the default Frame to use * @exception HeadlessException if * GraphicsEnvironment.isHeadless returns * true * @see #setRootFrame * @see java.awt.GraphicsEnvironment#isHeadless */ // @ts-ignore public static getRootFrame(): java.awt.Frame /** * Sets the UI object which implements the {@literal L&F} for this component. * @param ui the OptionPaneUI {#literal L&F} object * @see UIDefaults#getUI * @beaninfo bound: true * hidden: true * description: The UI object that implements the optionpane's LookAndFeel */ // @ts-ignore public setUI(ui: javax.swing.plaf.OptionPaneUI): void /** * Returns the UI object which implements the {@literal L&F} for this component. * @return the OptionPaneUI object */ // @ts-ignore public getUI(): javax.swing.plaf.OptionPaneUI /** * Notification from the UIManager that the {@literal L&F} has changed. * Replaces the current UI object with the latest version from the * UIManager. * @see JComponent#updateUI */ // @ts-ignore public updateUI(): void /** * Returns the name of the UI class that implements the * {@literal L&F} for this component. * @return the string "OptionPaneUI" * @see JComponent#getUIClassID * @see UIDefaults#getUI */ // @ts-ignore public getUIClassID(): string /** * Sets the option pane's message-object. * @param newMessage the Object to display * @see #getMessage * @beaninfo preferred: true * bound: true * description: The optionpane's message object. */ // @ts-ignore public setMessage(newMessage: java.lang.Object | any): void /** * Returns the message-object this pane displays. * @see #setMessage * @return the Object that is displayed */ // @ts-ignore public getMessage(): any /** * Sets the icon to display. If non-null, the look and feel * does not provide an icon. * @param newIcon the Icon to display * @see #getIcon * @beaninfo preferred: true * bound: true * description: The option pane's type icon. */ // @ts-ignore public setIcon(newIcon: javax.swing.Icon): void /** * Returns the icon this pane displays. * @return the Icon that is displayed * @see #setIcon */ // @ts-ignore public getIcon(): javax.swing.Icon /** * Sets the value the user has chosen. * @param newValue the chosen value * @see #getValue * @beaninfo preferred: true * bound: true * description: The option pane's value object. */ // @ts-ignore public setValue(newValue: java.lang.Object | any): void /** * Returns the value the user has selected. UNINITIALIZED_VALUE * implies the user has not yet made a choice, null means the * user closed the window with out choosing anything. Otherwise * the returned value will be one of the options defined in this * object. * @return the Object chosen by the user, * UNINITIALIZED_VALUE * if the user has not yet made a choice, or null if * the user closed the window without making a choice * @see #setValue */ // @ts-ignore public getValue(): any /** * Sets the options this pane displays. If an element in * newOptions is a Component * it is added directly to the pane, * otherwise a button is created for the element. * @param newOptions an array of Objects that create the * buttons the user can click on, or arbitrary * Components to add to the pane * @see #getOptions * @beaninfo bound: true * description: The option pane's options objects. */ // @ts-ignore public setOptions(newOptions: java.lang.Object[] | any[]): void /** * Returns the choices the user can make. * @return the array of Objects that give the user's choices * @see #setOptions */ // @ts-ignore public getOptions(): any[] /** * Sets the initial value that is to be enabled -- the * Component * that has the focus when the pane is initially displayed. * @param newInitialValue the Object that gets the initial * keyboard focus * @see #getInitialValue * @beaninfo preferred: true * bound: true * description: The option pane's initial value object. */ // @ts-ignore public setInitialValue(newInitialValue: java.lang.Object | any): void /** * Returns the initial value. * @return the Object that gets the initial keyboard focus * @see #setInitialValue */ // @ts-ignore public getInitialValue(): any /** * Sets the option pane's message type. * The message type is used by the Look and Feel to determine the * icon to display (if not supplied) as well as potentially how to * lay out the parentComponent. * @param newType an integer specifying the kind of message to display: * ERROR_MESSAGE, INFORMATION_MESSAGE, * WARNING_MESSAGE, * QUESTION_MESSAGE, or PLAIN_MESSAGE * @exception RuntimeException if newType is not one of the * legal values listed above * @see #getMessageType * @beaninfo preferred: true * bound: true * description: The option pane's message type. */ // @ts-ignore public setMessageType(newType: number /*int*/): void /** * Returns the message type. * @return an integer specifying the message type * @see #setMessageType */ // @ts-ignore public getMessageType(): number /*int*/ /** * Sets the options to display. * The option type is used by the Look and Feel to * determine what buttons to show (unless options are supplied). * @param newType an integer specifying the options the {#literal L&F} is to display: * DEFAULT_OPTION, * YES_NO_OPTION, * YES_NO_CANCEL_OPTION, * or OK_CANCEL_OPTION * @exception RuntimeException if newType is not one of * the legal values listed above * @see #getOptionType * @see #setOptions * @beaninfo preferred: true * bound: true * description: The option pane's option type. */ // @ts-ignore public setOptionType(newType: number /*int*/): void /** * Returns the type of options that are displayed. * @return an integer specifying the user-selectable options * @see #setOptionType */ // @ts-ignore public getOptionType(): number /*int*/ /** * Sets the input selection values for a pane that provides the user * with a list of items to choose from. (The UI provides a widget * for choosing one of the values.) A null value * implies the user can input whatever they wish, usually by means * of a JTextField. *

* Sets wantsInput to true. Use * setInitialSelectionValue to specify the initially-chosen * value. After the pane as been enabled, inputValue is * set to the value the user has selected. * @param newValues an array of Objects the user to be * displayed * (usually in a list or combo-box) from which * the user can make a selection * @see #setWantsInput * @see #setInitialSelectionValue * @see #getSelectionValues * @beaninfo bound: true * description: The option pane's selection values. */ // @ts-ignore public setSelectionValues(newValues: java.lang.Object[] | any[]): void /** * Returns the input selection values. * @return the array of Objects the user can select * @see #setSelectionValues */ // @ts-ignore public getSelectionValues(): any[] /** * Sets the input value that is initially displayed as selected to the user. * Only used if wantsInput is true. * @param newValue the initially selected value * @see #setSelectionValues * @see #getInitialSelectionValue * @beaninfo bound: true * description: The option pane's initial selection value object. */ // @ts-ignore public setInitialSelectionValue(newValue: java.lang.Object | any): void /** * Returns the input value that is displayed as initially selected to the user. * @return the initially selected value * @see #setInitialSelectionValue * @see #setSelectionValues */ // @ts-ignore public getInitialSelectionValue(): any /** * Sets the input value that was selected or input by the user. * Only used if wantsInput is true. Note that this method * is invoked internally by the option pane (in response to user action) * and should generally not be called by client programs. To set the * input value initially displayed as selected to the user, use * setInitialSelectionValue. * @param newValue the Object used to set the * value that the user specified (usually in a text field) * @see #setSelectionValues * @see #setInitialSelectionValue * @see #setWantsInput * @see #getInputValue * @beaninfo preferred: true * bound: true * description: The option pane's input value object. */ // @ts-ignore public setInputValue(newValue: java.lang.Object | any): void /** * Returns the value the user has input, if wantsInput * is true. * @return the Object the user specified, * if it was one of the objects, or a * String if it was a value typed into a * field * @see #setSelectionValues * @see #setWantsInput * @see #setInputValue */ // @ts-ignore public getInputValue(): any /** * Returns the maximum number of characters to place on a line in a * message. Default is to return Integer.MAX_VALUE. * The value can be * changed by overriding this method in a subclass. * @return an integer giving the maximum number of characters on a line */ // @ts-ignore public getMaxCharactersPerLineCount(): number /*int*/ /** * Sets the wantsInput property. * If newValue is true, an input component * (such as a text field or combo box) whose parent is * parentComponent is provided to * allow the user to input a value. If getSelectionValues * returns a non-null array, the input value is one of the * objects in that array. Otherwise the input value is whatever * the user inputs. *

* This is a bound property. * @see #setSelectionValues * @see #setInputValue * @beaninfo preferred: true * bound: true * description: Flag which allows the user to input a value. */ // @ts-ignore public setWantsInput(newValue: boolean): void /** * Returns the value of the wantsInput property. * @return true if an input component will be provided * @see #setWantsInput */ // @ts-ignore public getWantsInput(): boolean /** * Requests that the initial value be selected, which will set * focus to the initial value. This method * should be invoked after the window containing the option pane * is made visible. */ // @ts-ignore public selectInitialValue(): void /** * Returns a string representation of this JOptionPane. * 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. * @return a string representation of this JOptionPane */ // @ts-ignore paramString(): string /** * Returns the AccessibleContext associated with this JOptionPane. * For option panes, the AccessibleContext takes the form of an * AccessibleJOptionPane. * A new AccessibleJOptionPane instance is created if necessary. * @return an AccessibleJOptionPane that serves as the * AccessibleContext of this AccessibleJOptionPane * @beaninfo expert: true * description: The AccessibleContext associated with this option pane */ // @ts-ignore public getAccessibleContext(): javax.accessibility.AccessibleContext } } }