Liking cljdoc? Tell your friends :D

javax.swing.JOptionPane

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.

Each of these methods also comes in a showInternalXXX flavor, which uses an internal frame to hold the dialog box (see 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 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. ComponentThe Component is displayed in the dialog. IconThe Icon is wrapped in a JLabel and displayed in the dialog. othersThe object is converted to a String by calling its toString method. The result is wrapped in a JLabel and displayed.

messageTypeDefines 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

optionTypeDefines 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. optionsA 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:

ComponentThe component is added to the button row directly. IconA JButton is created with this as its label. otherThe Object is converted to a string using its toString method and the result is used to label a JButton.

iconA decorative icon to be placed in the dialog box. A default value for this is determined by the messageType parameter. titleThe title for the dialog box. initialValueThe 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 XMLEncoder.

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.




 Each of these methods also comes in a showInternalXXX
 flavor, which uses an internal frame to hold the dialog box (see
 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 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.
 ComponentThe Component is displayed in the dialog.
 IconThe Icon is wrapped in a JLabel
               and displayed in the dialog.
 othersThe object is converted to a String by calling
               its toString method. The result is wrapped in a
               JLabel and displayed.

 messageTypeDefines 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

 optionTypeDefines 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.
 optionsA 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:

 ComponentThe component is added to the button row directly.
 IconA JButton is created with this as its label.
 otherThe Object is converted to a string using its
              toString method and the result is used to
              label a JButton.

 iconA decorative icon to be placed in the dialog box. A default
 value for this is determined by the messageType parameter.
 titleThe title for the dialog box.
 initialValueThe 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 XMLEncoder.
raw docstring

*-cancel-optionclj

Static Constant.

Return value from class method if CANCEL is chosen.

type: int

Static Constant.

Return value from class method if CANCEL is chosen.

type: int
raw docstring

*-closed-optionclj

Static Constant.

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.

type: int

Static Constant.

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.

type: int
raw docstring

*-default-optionclj

Static Constant.

Type meaning Look and Feel should not supply any options -- only use the options from the JOptionPane.

type: int

Static Constant.

Type meaning Look and Feel should not supply any options -- only
 use the options from the JOptionPane.

type: int
raw docstring

*-error-messageclj

Static Constant.

Used for error messages.

type: int

Static Constant.

Used for error messages.

type: int
raw docstring

*-icon-propertyclj

Static Constant.

Bound property name for icon.

type: java.lang.String

Static Constant.

Bound property name for icon.

type: java.lang.String
raw docstring

*-information-messageclj

Static Constant.

Used for information messages.

type: int

Static Constant.

Used for information messages.

type: int
raw docstring

*-initial-selection-value-propertyclj

Static Constant.

Bound property name for initialSelectionValue.

type: java.lang.String

Static Constant.

Bound property name for initialSelectionValue.

type: java.lang.String
raw docstring

*-initial-value-propertyclj

Static Constant.

Bound property name for initialValue.

type: java.lang.String

Static Constant.

Bound property name for initialValue.

type: java.lang.String
raw docstring

*-input-value-propertyclj

Static Constant.

Bound property name for inputValue.

type: java.lang.String

Static Constant.

Bound property name for inputValue.

type: java.lang.String
raw docstring

*-message-propertyclj

Static Constant.

Bound property name for message.

type: java.lang.String

Static Constant.

Bound property name for message.

type: java.lang.String
raw docstring

*-message-type-propertyclj

Static Constant.

Bound property name for type.

type: java.lang.String

Static Constant.

Bound property name for type.

type: java.lang.String
raw docstring

*-no-optionclj

Static Constant.

Return value from class method if NO is chosen.

type: int

Static Constant.

Return value from class method if NO is chosen.

type: int
raw docstring

*-ok-cancel-optionclj

Static Constant.

Type used for showConfirmDialog.

type: int

Static Constant.

Type used for showConfirmDialog.

type: int
raw docstring

*-ok-optionclj

Static Constant.

Return value form class method if OK is chosen.

type: int

Static Constant.

Return value form class method if OK is chosen.

type: int
raw docstring

*-option-type-propertyclj

Static Constant.

Bound property name for optionType.

type: java.lang.String

Static Constant.

Bound property name for optionType.

type: java.lang.String
raw docstring

*-options-propertyclj

Static Constant.

Bound property name for option.

type: java.lang.String

Static Constant.

Bound property name for option.

type: java.lang.String
raw docstring

*-plain-messageclj

Static Constant.

No icon is used.

type: int

Static Constant.

No icon is used.

type: int
raw docstring

*-question-messageclj

Static Constant.

Used for questions.

type: int

Static Constant.

Used for questions.

type: int
raw docstring

*-selection-values-propertyclj

Static Constant.

Bound property name for selectionValues.

type: java.lang.String

Static Constant.

Bound property name for selectionValues.

type: java.lang.String
raw docstring

*-uninitialized-valueclj

Static Constant.

Indicates that the user has not yet selected a value.

type: java.lang.Object

Static Constant.

Indicates that the user has not yet selected a value.

type: java.lang.Object
raw docstring

*-value-propertyclj

Static Constant.

Bound property name for value.

type: java.lang.String

Static Constant.

Bound property name for value.

type: java.lang.String
raw docstring

*-wants-input-propertyclj

Static Constant.

Bound property name for wantsInput.

type: java.lang.String

Static Constant.

Bound property name for wantsInput.

type: java.lang.String
raw docstring

*-warning-messageclj

Static Constant.

Used for warning messages.

type: int

Static Constant.

Used for warning messages.

type: int
raw docstring

*-yes-no-cancel-optionclj

Static Constant.

Type used for showConfirmDialog.

type: int

Static Constant.

Type used for showConfirmDialog.

type: int
raw docstring

*-yes-no-optionclj

Static Constant.

Type used for showConfirmDialog.

type: int

Static Constant.

Type used for showConfirmDialog.

type: int
raw docstring

*-yes-optionclj

Static Constant.

Return value from class method if YES is chosen.

type: int

Static Constant.

Return value from class method if YES is chosen.

type: int
raw docstring

*get-desktop-pane-for-componentclj

(*get-desktop-pane-for-component parent-component)

Returns the specified component's desktop pane.

parent-component - the Component to check for a desktop - java.awt.Component

returns: the JDesktopPane that contains the component, or null if the component is null or does not have an ancestor that is a JInternalFrame - javax.swing.JDesktopPane

Returns the specified component's desktop pane.

parent-component - the Component to check for a desktop - `java.awt.Component`

returns: the JDesktopPane that contains the component,
          or null if the component is null
          or does not have an ancestor that is a
          JInternalFrame - `javax.swing.JDesktopPane`
raw docstring

*get-frame-for-componentclj

(*get-frame-for-component parent-component)

Returns the specified component's Frame.

parent-component - the Component to check for a Frame - java.awt.Component

returns: the Frame that contains the component, or getRootFrame if the component is null, or does not have a valid Frame parent - java.awt.Frame

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

Returns the specified component's Frame.

parent-component - the Component to check for a Frame - `java.awt.Component`

returns: the Frame that contains the component,
          or getRootFrame
          if the component is null,
          or does not have a valid Frame parent - `java.awt.Frame`

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true
raw docstring

*get-root-frameclj

(*get-root-frame)

Returns the Frame to use for the class methods in which a frame is not provided.

returns: the default Frame to use - java.awt.Frame

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

Returns the Frame to use for the class methods in
 which a frame is not provided.

returns: the default Frame to use - `java.awt.Frame`

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true
raw docstring

*set-root-frameclj

(*set-root-frame new-root-frame)

Sets the frame to use for class methods in which a frame is not provided.

Note: It is recommended that rather than using this method you supply a valid parent.

new-root-frame - the default Frame to use - java.awt.Frame

Sets the frame to use for class methods in which a frame is
 not provided.

 Note:
 It is recommended that rather than using this method you supply a valid parent.

new-root-frame - the default Frame to use - `java.awt.Frame`
raw docstring

*show-confirm-dialogclj

(*show-confirm-dialog parent-component message)
(*show-confirm-dialog parent-component message title option-type)
(*show-confirm-dialog parent-component message title option-type message-type)
(*show-confirm-dialog parent-component
                      message
                      title
                      option-type
                      message-type
                      icon)

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.

parent-component - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used - java.awt.Component message - the Object to display - java.lang.Object title - the title string for the dialog - java.lang.String option-type - an int designating the options available on the dialog: YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION - int message-type - 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 - int icon - the icon to display in the dialog - javax.swing.Icon

returns: an int indicating the option selected by the user - int

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

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.

parent-component - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used - `java.awt.Component`
message - the Object to display - `java.lang.Object`
title - the title string for the dialog - `java.lang.String`
option-type - an int designating the options available on the dialog: YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION - `int`
message-type - 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 - `int`
icon - the icon to display in the dialog - `javax.swing.Icon`

returns: an int indicating the option selected by the user - `int`

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true
raw docstring

*show-input-dialogclj

(*show-input-dialog message)
(*show-input-dialog message initial-selection-value)
(*show-input-dialog parent-component message initial-selection-value)
(*show-input-dialog parent-component message title message-type)
(*show-input-dialog parent-component
                    message
                    title
                    message-type
                    icon
                    selection-values
                    initial-selection-value)

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.

parent-component - the parent Component for the dialog - java.awt.Component message - the Object to display - java.lang.Object title - the String to display in the dialog title bar - java.lang.String message-type - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE - int icon - the Icon image to display - javax.swing.Icon selection-values - an array of Objects that gives the possible selections - java.lang.Object[] initial-selection-value - the value used to initialize the input field - java.lang.Object

returns: user's input, or null meaning the user canceled the input - java.lang.Object

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

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.

parent-component - the parent Component for the dialog - `java.awt.Component`
message - the Object to display - `java.lang.Object`
title - the String to display in the dialog title bar - `java.lang.String`
message-type - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE - `int`
icon - the Icon image to display - `javax.swing.Icon`
selection-values - an array of Objects that gives the possible selections - `java.lang.Object[]`
initial-selection-value - the value used to initialize the input field - `java.lang.Object`

returns: user's input, or null meaning the user
                  canceled the input - `java.lang.Object`

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true
raw docstring

*show-internal-confirm-dialogclj

(*show-internal-confirm-dialog parent-component message)
(*show-internal-confirm-dialog parent-component message title option-type)
(*show-internal-confirm-dialog parent-component
                               message
                               title
                               option-type
                               message-type)
(*show-internal-confirm-dialog parent-component
                               message
                               title
                               option-type
                               message-type
                               icon)

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.

parent-component - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used - java.awt.Component 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 - java.lang.Object title - the title string for the dialog - java.lang.String option-type - an integer designating the options available on the dialog: YES_NO_OPTION, or YES_NO_CANCEL_OPTION. - int message-type - 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 - int icon - the icon to display in the dialog - javax.swing.Icon

returns: an integer indicating the option selected by the user - 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.

parent-component - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used - `java.awt.Component`
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 - `java.lang.Object`
title - the title string for the dialog - `java.lang.String`
option-type - an integer designating the options available on the dialog: YES_NO_OPTION, or YES_NO_CANCEL_OPTION. - `int`
message-type - 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 - `int`
icon - the icon to display in the dialog - `javax.swing.Icon`

returns: an integer indicating the option selected by the user - `int`
raw docstring

*show-internal-input-dialogclj

(*show-internal-input-dialog parent-component message)
(*show-internal-input-dialog parent-component message title message-type)
(*show-internal-input-dialog parent-component
                             message
                             title
                             message-type
                             icon
                             selection-values
                             initial-selection-value)

Prompts the user for input in a blocking internal 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.

parent-component - the parent Component for the dialog - java.awt.Component message - the Object to display - java.lang.Object title - the String to display in the dialog title bar - java.lang.String message-type - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE - int icon - the Icon image to display - javax.swing.Icon selection-values - an array of Objects that gives the possible selections - java.lang.Object[] initial-selection-value - the value used to initialize the input field - java.lang.Object

returns: user's input, or null meaning the user canceled the input - java.lang.Object

Prompts the user for input in a blocking internal 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.

parent-component - the parent Component for the dialog - `java.awt.Component`
message - the Object to display - `java.lang.Object`
title - the String to display in the dialog title bar - `java.lang.String`
message-type - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE - `int`
icon - the Icon image to display - `javax.swing.Icon`
selection-values - an array of Objects that gives the possible selections - `java.lang.Object[]`
initial-selection-value - the value used to initialize the input field - `java.lang.Object`

returns: user's input, or null meaning the user
          canceled the input - `java.lang.Object`
raw docstring

*show-internal-message-dialogclj

(*show-internal-message-dialog parent-component message)
(*show-internal-message-dialog parent-component message title message-type)
(*show-internal-message-dialog parent-component message title message-type icon)

Brings up an internal dialog panel displaying a message, specifying all parameters.

parent-component - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used - java.awt.Component message - the Object to display - java.lang.Object title - the title string for the dialog - java.lang.String message-type - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE - int icon - an icon to display in the dialog that helps the user identify the kind of message that is being displayed - javax.swing.Icon

Brings up an internal dialog panel displaying a message,
 specifying all parameters.

parent-component - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used - `java.awt.Component`
message - the Object to display - `java.lang.Object`
title - the title string for the dialog - `java.lang.String`
message-type - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE - `int`
icon - an icon to display in the dialog that helps the user identify the kind of message that is being displayed - `javax.swing.Icon`
raw docstring

*show-internal-option-dialogclj

(*show-internal-option-dialog parent-component
                              message
                              title
                              option-type
                              message-type
                              icon
                              options
                              initial-value)

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.

The messageType parameter is primarily used to supply a default icon from the look and feel.

parent-component - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used - java.awt.Component 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 - java.lang.Object title - the title string for the dialog - java.lang.String option-type - an integer designating the options available on the dialog: YES_NO_OPTION, or YES_NO_CANCEL_OPTION - int message-type - 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 - int icon - the icon to display in the dialog - javax.swing.Icon 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 - java.lang.Object[] initial-value - the object that represents the default selection for the dialog; only meaningful if options is used; can be null - java.lang.Object

returns: an integer indicating the option chosen by the user, or CLOSED_OPTION if the user closed the Dialog - 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.

 The messageType parameter is primarily used to supply
 a default icon from the look and feel.

parent-component - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used - `java.awt.Component`
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 - `java.lang.Object`
title - the title string for the dialog - `java.lang.String`
option-type - an integer designating the options available on the dialog: YES_NO_OPTION, or YES_NO_CANCEL_OPTION - `int`
message-type - 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 - `int`
icon - the icon to display in the dialog - `javax.swing.Icon`
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 - `java.lang.Object[]`
initial-value - the object that represents the default selection for the dialog; only meaningful if options is used; can be null - `java.lang.Object`

returns: an integer indicating the option chosen by the user,
          or CLOSED_OPTION if the user closed the Dialog - `int`
raw docstring

*show-message-dialogclj

(*show-message-dialog parent-component message)
(*show-message-dialog parent-component message title message-type)
(*show-message-dialog parent-component message title message-type icon)

Brings up a dialog displaying a message, specifying all parameters.

parent-component - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used - java.awt.Component message - the Object to display - java.lang.Object title - the title string for the dialog - java.lang.String message-type - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE - int icon - an icon to display in the dialog that helps the user identify the kind of message that is being displayed - javax.swing.Icon

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

Brings up a dialog displaying a message, specifying all parameters.

parent-component - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used - `java.awt.Component`
message - the Object to display - `java.lang.Object`
title - the title string for the dialog - `java.lang.String`
message-type - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE - `int`
icon - an icon to display in the dialog that helps the user identify the kind of message that is being displayed - `javax.swing.Icon`

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true
raw docstring

*show-option-dialogclj

(*show-option-dialog parent-component
                     message
                     title
                     option-type
                     message-type
                     icon
                     options
                     initial-value)

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.

parent-component - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used - java.awt.Component message - the Object to display - java.lang.Object title - the title string for the dialog - java.lang.String option-type - an integer designating the options available on the dialog: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION - int message-type - 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 - int icon - the icon to display in the dialog - javax.swing.Icon 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 - java.lang.Object[] initial-value - the object that represents the default selection for the dialog; only meaningful if options is used; can be null - java.lang.Object

returns: an integer indicating the option chosen by the user, or CLOSED_OPTION if the user closed the dialog - int

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

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.

parent-component - determines the Frame in which the dialog is displayed; if null, or if the parentComponent has no Frame, a default Frame is used - `java.awt.Component`
message - the Object to display - `java.lang.Object`
title - the title string for the dialog - `java.lang.String`
option-type - an integer designating the options available on the dialog: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION - `int`
message-type - 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 - `int`
icon - the icon to display in the dialog - `javax.swing.Icon`
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 - `java.lang.Object[]`
initial-value - the object that represents the default selection for the dialog; only meaningful if options is used; can be null - `java.lang.Object`

returns: an integer indicating the option chosen by the user,
                  or CLOSED_OPTION if the user closed
                  the dialog - `int`

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true
raw docstring

->j-option-paneclj

(->j-option-pane)
(->j-option-pane message)
(->j-option-pane message message-type)
(->j-option-pane message message-type option-type)
(->j-option-pane message message-type option-type icon)
(->j-option-pane message message-type option-type icon options)
(->j-option-pane message message-type option-type icon options initial-value)

Constructor.

Creates an instance of JOptionPane to display a message with the specified message type, icon, and options, with the initially-selected option specified.

message - the Object to display - java.lang.Object message-type - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE - int option-type - the options to display in the pane: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, OK_CANCEL_OPTION - int icon - the Icon image to display - javax.swing.Icon options - the choices the user can select - java.lang.Object[] initial-value - the choice that is initially selected; if null, then nothing will be initially selected; only meaningful if options is used - java.lang.Object

Constructor.

Creates an instance of JOptionPane to display a message
 with the specified message type, icon, and options, with the
 initially-selected option specified.

message - the Object to display - `java.lang.Object`
message-type - the type of message to be displayed: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE - `int`
option-type - the options to display in the pane: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, OK_CANCEL_OPTION - `int`
icon - the Icon image to display - `javax.swing.Icon`
options - the choices the user can select - `java.lang.Object[]`
initial-value - the choice that is initially selected; if null, then nothing will be initially selected; only meaningful if options is used - `java.lang.Object`
raw docstring

create-dialogclj

(create-dialog this title)
(create-dialog this parent-component title)

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.

parent-component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used - java.awt.Component title - the title string for the dialog - java.lang.String

returns: a new JDialog containing this instance - javax.swing.JDialog

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true

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.

parent-component - determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used - `java.awt.Component`
title - the title string for the dialog - `java.lang.String`

returns: a new JDialog containing this instance - `javax.swing.JDialog`

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless returns true
raw docstring

create-internal-frameclj

(create-internal-frame this parent-component title)

Creates and returns an instance of JInternalFrame. The internal frame is created with the specified title, and wrapping the JOptionPane. The returned JInternalFrame is added to the JDesktopPane ancestor of parentComponent, or components parent if one its ancestors isn't a JDesktopPane, or if parentComponent doesn't have a parent then a RuntimeException is thrown.

parent-component - the parent Component for the internal frame - java.awt.Component title - the String to display in the frame's title bar - java.lang.String

returns: a JInternalFrame containing a JOptionPane - javax.swing.JInternalFrame

throws: java.lang.RuntimeException - if parentComponent does not have a valid parent

Creates and returns an instance of JInternalFrame.
 The internal frame is created with the specified title,
 and wrapping the JOptionPane.
 The returned JInternalFrame is
 added to the JDesktopPane ancestor of
 parentComponent, or components
 parent if one its ancestors isn't a JDesktopPane,
 or if parentComponent
 doesn't have a parent then a RuntimeException is thrown.

parent-component - the parent Component for the internal frame - `java.awt.Component`
title - the String to display in the frame's title bar - `java.lang.String`

returns: a JInternalFrame containing a
          JOptionPane - `javax.swing.JInternalFrame`

throws: java.lang.RuntimeException - if parentComponent does not have a valid parent
raw docstring

get-accessible-contextclj

(get-accessible-context this)

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.

returns: an AccessibleJOptionPane that serves as the AccessibleContext of this AccessibleJOptionPane - javax.accessibility.AccessibleContext

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.

returns: an AccessibleJOptionPane that serves as the
         AccessibleContext of this AccessibleJOptionPane - `javax.accessibility.AccessibleContext`
raw docstring

get-iconclj

(get-icon this)

Returns the icon this pane displays.

returns: the Icon that is displayed - javax.swing.Icon

Returns the icon this pane displays.

returns: the Icon that is displayed - `javax.swing.Icon`
raw docstring

get-initial-selection-valueclj

(get-initial-selection-value this)

Returns the input value that is displayed as initially selected to the user.

returns: the initially selected value - java.lang.Object

Returns the input value that is displayed as initially selected to the user.

returns: the initially selected value - `java.lang.Object`
raw docstring

get-initial-valueclj

(get-initial-value this)

Returns the initial value.

returns: the Object that gets the initial keyboard focus - java.lang.Object

Returns the initial value.

returns: the Object that gets the initial keyboard focus - `java.lang.Object`
raw docstring

get-input-valueclj

(get-input-value this)

Returns the value the user has input, if wantsInput is true.

returns: the Object the user specified, if it was one of the objects, or a String if it was a value typed into a field - java.lang.Object

Returns the value the user has input, if wantsInput
 is true.

returns: the Object the user specified,
          if it was one of the objects, or a
          String if it was a value typed into a
          field - `java.lang.Object`
raw docstring

get-max-characters-per-line-countclj

(get-max-characters-per-line-count this)

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.

returns: an integer giving the maximum number of characters on a line - int

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.

returns: an integer giving the maximum number of characters on a line - `int`
raw docstring

get-messageclj

(get-message this)

Returns the message-object this pane displays.

returns: the Object that is displayed - java.lang.Object

Returns the message-object this pane displays.

returns: the Object that is displayed - `java.lang.Object`
raw docstring

get-message-typeclj

(get-message-type this)

Returns the message type.

returns: an integer specifying the message type - int

Returns the message type.

returns: an integer specifying the message type - `int`
raw docstring

get-option-typeclj

(get-option-type this)

Returns the type of options that are displayed.

returns: an integer specifying the user-selectable options - int

Returns the type of options that are displayed.

returns: an integer specifying the user-selectable options - `int`
raw docstring

get-optionsclj

(get-options this)

Returns the choices the user can make.

returns: the array of Objects that give the user's choices - java.lang.Object[]

Returns the choices the user can make.

returns: the array of Objects that give the user's choices - `java.lang.Object[]`
raw docstring

get-selection-valuesclj

(get-selection-values this)

Returns the input selection values.

returns: the array of Objects the user can select - java.lang.Object[]

Returns the input selection values.

returns: the array of Objects the user can select - `java.lang.Object[]`
raw docstring

get-uiclj

(get-ui this)

Returns the UI object which implements the L&F for this component.

returns: the OptionPaneUI object - javax.swing.plaf.OptionPaneUI

Returns the UI object which implements the L&F for this component.

returns: the OptionPaneUI object - `javax.swing.plaf.OptionPaneUI`
raw docstring

get-ui-class-idclj

(get-ui-class-id this)

Returns the name of the UI class that implements the L&F for this component.

returns: the string "OptionPaneUI" - java.lang.String

Returns the name of the UI class that implements the
 L&F for this component.

returns: the string "OptionPaneUI" - `java.lang.String`
raw docstring

get-valueclj

(get-value this)

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.

returns: 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 - java.lang.Object

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.

returns: 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 - `java.lang.Object`
raw docstring

get-wants-input?clj

(get-wants-input? this)

Returns the value of the wantsInput property.

returns: true if an input component will be provided - boolean

Returns the value of the wantsInput property.

returns: true if an input component will be provided - `boolean`
raw docstring

select-initial-valueclj

(select-initial-value this)

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.

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.
raw docstring

set-iconclj

(set-icon this new-icon)

Sets the icon to display. If non-null, the look and feel does not provide an icon.

new-icon - the Icon to display - javax.swing.Icon

Sets the icon to display. If non-null, the look and feel
 does not provide an icon.

new-icon - the Icon to display - `javax.swing.Icon`
raw docstring

set-initial-selection-valueclj

(set-initial-selection-value this new-value)

Sets the input value that is initially displayed as selected to the user. Only used if wantsInput is true.

new-value - the initially selected value - java.lang.Object

Sets the input value that is initially displayed as selected to the user.
 Only used if wantsInput is true.

new-value - the initially selected value - `java.lang.Object`
raw docstring

set-initial-valueclj

(set-initial-value this new-initial-value)

Sets the initial value that is to be enabled -- the Component that has the focus when the pane is initially displayed.

new-initial-value - the Object that gets the initial keyboard focus - java.lang.Object

Sets the initial value that is to be enabled -- the
 Component
 that has the focus when the pane is initially displayed.

new-initial-value - the Object that gets the initial keyboard focus - `java.lang.Object`
raw docstring

set-input-valueclj

(set-input-value this new-value)

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.

new-value - the Object used to set the value that the user specified (usually in a text field) - java.lang.Object

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.

new-value - the Object used to set the value that the user specified (usually in a text field) - `java.lang.Object`
raw docstring

set-messageclj

(set-message this new-message)

Sets the option pane's message-object.

new-message - the Object to display - java.lang.Object

Sets the option pane's message-object.

new-message - the Object to display - `java.lang.Object`
raw docstring

set-message-typeclj

(set-message-type this new-type)

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.

new-type - an integer specifying the kind of message to display: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE - int

throws: java.lang.RuntimeException - if newType is not one of the legal values listed above

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.

new-type - an integer specifying the kind of message to display: ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE, QUESTION_MESSAGE, or PLAIN_MESSAGE - `int`

throws: java.lang.RuntimeException - if newType is not one of the legal values listed above
raw docstring

set-option-typeclj

(set-option-type this new-type)

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).

new-type - an integer specifying the options the L&F is to display: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION - int

throws: java.lang.RuntimeException - if newType is not one of the legal values listed above

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).

new-type - an integer specifying the options the L&F is to display: DEFAULT_OPTION, YES_NO_OPTION, YES_NO_CANCEL_OPTION, or OK_CANCEL_OPTION - `int`

throws: java.lang.RuntimeException - if newType is not one of the legal values listed above
raw docstring

set-optionsclj

(set-options this new-options)

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.

new-options - an array of Objects that create the buttons the user can click on, or arbitrary Components to add to the pane - java.lang.Object[]

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.

new-options - an array of Objects that create the buttons the user can click on, or arbitrary Components to add to the pane - `java.lang.Object[]`
raw docstring

set-selection-valuesclj

(set-selection-values this new-values)

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.

new-values - an array of Objects the user to be displayed (usually in a list or combo-box) from which the user can make a selection - java.lang.Object[]

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.

new-values - an array of Objects the user to be displayed (usually in a list or combo-box) from which the user can make a selection - `java.lang.Object[]`
raw docstring

set-uiclj

(set-ui this ui)

Sets the UI object which implements the L&F for this component.

ui - the OptionPaneUI L&F object - javax.swing.plaf.OptionPaneUI

Sets the UI object which implements the L&F for this component.

ui - the OptionPaneUI L&F object - `javax.swing.plaf.OptionPaneUI`
raw docstring

set-valueclj

(set-value this new-value)

Sets the value the user has chosen.

new-value - the chosen value - java.lang.Object

Sets the value the user has chosen.

new-value - the chosen value - `java.lang.Object`
raw docstring

set-wants-inputclj

(set-wants-input this new-value)

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.

new-value - boolean

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.

new-value - `boolean`
raw docstring

update-uiclj

(update-ui this)

Notification from the UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager.

Notification from the UIManager that the L&F has changed.
Replaces the current UI object with the latest version from the
UIManager.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close