Spec-Zone .ru
спецификации, руководства, описания, API
|
public class JOptionPane extends JComponent implements Accessible
JOptionPane
облегчает раскрываться стандартное диалоговое окно, которое запрашивает пользователей значение или сообщает им о чем-то. Для получения информации об использовании JOptionPane
, см. В то время как JOptionPane
class может казаться сложным из-за большого количества методов, почти все использование этого class является короткими звонками в одни из помех showXxxDialog
методы, показанные ниже:
Каждый из этих методов также прибывает в a
Имя метода Описание showConfirmDialog Спрашивает вопрос о подтверждении, как yes/no/cancel. showInputDialog Подсказка для некоторого ввода. showMessageDialog Скажите пользователю о чем-то, что произошло. showOptionDialog Главное Объединение вышеупомянутых трех.
showInternalXXX
разновидность, которая использует внутреннюю рамку, чтобы содержать диалоговое окно (см. JInternalFrame
). Многократные методы удобства были также определены - перегруженные версии основных методов, которые используют различные списки параметров. Все диалоговые окна модальны. Каждый showXxxDialog
метод блокирует вызывающую сторону, пока взаимодействие пользователя не полно.
значок | сообщение |
входное значение | |
переключатели |
ComponentOrientation
свойство.
Параметры:
Параметры к этим методам следуют за непротиворечивыми образцами:
- parentComponent
- Определяет
Component
это должно быть родителем этого диалогового окна. Это используется двумя способами:Frame
это содержит это, используется в качествеFrame
родитель для диалогового окна, и его экранные координаты используются в размещении диалогового окна. Вообще, диалоговое окно помещается только ниже компонента. Этот параметр может бытьnull
, когда значение по умолчаниюFrame
используется в качестве родителя, и диалоговое окно будет центрироваться на экране (в зависимости от L&F).- сообщение
- Дескриптивное сообщение, которое будет помещено в диалоговое окно. В наиболее распространенном использовании сообщение только a
String
илиString
постоянный. Однако, тип этого параметра фактическиObject
. Его интерпретация зависит от его типа:
- Объект []
- Массив объектов интерпретируется как ряд сообщений (один на объект) расположенный в вертикальном стеке. Интерпретация является рекурсивной - каждый объект в массиве интерпретируется согласно его типу.
- Компонент
Component
выводится на экран в диалоговом окне.- Значок
Icon
обертывается в aJLabel
и выведенный на экран в диалоговом окне.- другие
- Объект преобразовывается в a
String
вызываяtoString
метод. Результат обертывается в aJLabel
и выведенный на экран.- messageType
- Определяет стиль сообщения. Менеджер по Стили может разметить диалоговое окно по-другому в зависимости от этого значения, и будет часто обеспечивать значок значения по умолчанию. Возможные значения:
ERROR_MESSAGE
INFORMATION_MESSAGE
WARNING_MESSAGE
QUESTION_MESSAGE
PLAIN_MESSAGE
- optionType
- Определяет набор переключателей, которые появляются у основания диалогового окна:
Вы не ограничиваетесь этим набором переключателей. Можно обеспечить любые кнопки, Вы хотите использовать параметр опций.
DEFAULT_OPTION
YES_NO_OPTION
YES_NO_CANCEL_OPTION
OK_CANCEL_OPTION
- опции
- Более подробное описание набора переключателей, которые появятся у основания диалогового окна. Обычное значение для параметра опций является массивом
String
s. Но тип параметра является массивомObjects
. Кнопка создается для каждого объекта в зависимости от его типа:
- Компонент
- Компонент добавляется к строке кнопки непосредственно.
- Значок
- A
JButton
создается с этим как его метка.- другой
Object
преобразовывается в строку, используяtoString
метод и результат привыкли к метке aJButton
.- значок
- Декоративный значок, который будет помещен в диалоговое окно. Значение по умолчанию для этого определяется
messageType
параметр.- title
- title для диалогового окна.
- initialValue
- Выбор значения по умолчанию (входное значение).
Когда выбор изменяется, setValue
вызывается, который генерирует a PropertyChangeEvent
.
Если a JOptionPane
сконфигурировал ко всему вводу setWantsInput
связанное свойство JOptionPane.INPUT_VALUE_PROPERTY
может также слушаться, чтобы определить, когда пользователь ввел или выбрал значение.
Когда один из showXxxDialog
методы возвращают целое число, возможные значения:
YES_OPTION
NO_OPTION
CANCEL_OPTION
OK_OPTION
CLOSED_OPTION
JOptionPane.showMessageDialog(null, "alert", "alert", JOptionPane.ERROR_MESSAGE);
JOptionPane.showInternalMessageDialog(frame, "information",
"information", JOptionPane.INFORMATION_MESSAGE);
JOptionPane.showConfirmDialog(null, "choose one", "choose one", JOptionPane.YES_NO_OPTION);
JOptionPane.showInternalConfirmDialog(frame, "please choose one", "information",
JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.INFORMATION_MESSAGE);
Object[] options = { "OK", "CANCEL" };
JOptionPane.showOptionDialog(null, "Click OK to continue", "Warning", JOptionPane.DEFAULT_OPTION, JOptionPane.WARNING_MESSAGE,
null, options, options[0]);
String inputValue = JOptionPane.showInputDialog("Please input a value");
Object[] possibleValues = { "First", "Second", "Third" };
Object selectedValue = JOptionPane.showInputDialog(null, "Choose one", "Input",
JOptionPane.INFORMATION_MESSAGE, null,
possibleValues, possibleValues[0]);
JOptionPane
непосредственно, стандартный образец примерно следующие: 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 JavaBeansTM
has been added to the java.beans
package.
Please see XMLEncoder
.
JInternalFrame
Modifier and Type | Class and Description |
---|---|
protected class |
JOptionPane. AccessibleJOptionPane
This class implements accessibility support for the
JOptionPane class. |
JComponent. AccessibleJComponent
Контейнер. AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Modifier and Type | Field and Description |
---|---|
static int |
CANCEL_OPTION
Return value from class method if CANCEL is chosen.
|
static int |
CLOSED_OPTION
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 . |
static int |
DEFAULT_OPTION
Type meaning Look and Feel should not supply any options -- only
use the options from the
JOptionPane . |
static int |
ERROR_MESSAGE
Used for error messages.
|
protected Icon |
значок
Icon used in pane.
|
static String |
ICON_PROPERTY
Bound property name for
icon . |
static int |
INFORMATION_MESSAGE
Used for information messages.
|
static String |
INITIAL_SELECTION_VALUE_PROPERTY
Bound property name for
initialSelectionValue . |
static String |
INITIAL_VALUE_PROPERTY
Bound property name for
initialValue . |
protected Object |
initialSelectionValue
Initial value to select in
selectionValues . |
protected Object |
initialValue
Value that should be initially selected in
options . |
static String |
INPUT_VALUE_PROPERTY
Bound property name for
inputValue . |
protected Object |
inputValue
Value the user has input.
|
protected Object |
сообщение
Message to display.
|
static String |
MESSAGE_PROPERTY
Bound property name for
message . |
static String |
MESSAGE_TYPE_PROPERTY
Bound property name for
type . |
protected int |
messageType
Message type.
|
static int |
NO_OPTION
Return value from class method if NO is chosen.
|
static int |
OK_CANCEL_OPTION
Type used for
showConfirmDialog . |
static int |
OK_OPTION
Return value form class method if OK is chosen.
|
static String |
OPTION_TYPE_PROPERTY
Bound property name for
optionType . |
protected Object[] |
опции
Options to display to the user.
|
static String |
OPTIONS_PROPERTY
Bound property name for
option . |
protected int |
optionType
Option type, one of
DEFAULT_OPTION ,
YES_NO_OPTION ,
YES_NO_CANCEL_OPTION or
OK_CANCEL_OPTION . |
static int |
PLAIN_MESSAGE
No icon is used.
|
static int |
QUESTION_MESSAGE
Used for questions.
|
static String |
SELECTION_VALUES_PROPERTY
Bound property name for
selectionValues . |
protected Object[] |
selectionValues
Array of values the user can choose from.
|
static Object |
UNINITIALIZED_VALUE
Indicates that the user has not yet selected a value.
|
protected Object |
значение
Currently selected value, will be a valid option, or
UNINITIALIZED_VALUE or null . |
static String |
VALUE_PROPERTY
Bound property name for
value . |
static String |
WANTS_INPUT_PROPERTY
Bound property name for
wantsInput . |
protected boolean |
wantsInput
If true, a UI widget will be provided to the user to get input.
|
static int |
WARNING_MESSAGE
Used for warning messages.
|
static int |
YES_NO_CANCEL_OPTION
Type used for
showConfirmDialog . |
static int |
YES_NO_OPTION
Type used for
showConfirmDialog . |
static int |
YES_OPTION
Return value from class method if YES is chosen.
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor and Description |
---|
JOptionPane()
Creates a
JOptionPane with a test message. |
JOptionPane(Object message)
Creates a instance of
JOptionPane to display a
message using the
plain-message message type and the default options delivered by
the UI. |
JOptionPane(Object message,
int messageType)
Creates an instance of
JOptionPane to display a message
with the specified message type and the default options, |
JOptionPane(Object message,
int messageType,
int optionType)
Creates an instance of
JOptionPane to display a message
with the specified message type and options. |
JOptionPane(Object message,
int messageType,
int optionType,
Icon icon)
Creates an instance of
JOptionPane to display a message
with the specified message type, options, and icon. |
JOptionPane(Object message,
int messageType,
int optionType,
Icon icon,
Object[] options)
Creates an instance of
JOptionPane to display a message
with the specified message type, icon, and options. |
JOptionPane(Object message,
int messageType,
int optionType,
Icon icon,
Object[] options,
Object initialValue)
Creates an instance of
JOptionPane to display a message
with the specified message type, icon, and options, with the
initially-selected option specified. |
Modifier and Type | Method and Description |
---|---|
JDialog |
createDialog(Component parentComponent,
String title)
Creates and returns a new
JDialog wrapping
this centered on the parentComponent
in the parentComponent 's frame. |
JDialog |
createDialog(String title)
Creates and returns a new parentless
JDialog
with the specified title. |
JInternalFrame |
createInternalFrame(Component parentComponent,
String title)
Creates and returns an instance of
JInternalFrame . |
AccessibleContext |
getAccessibleContext()
Returns the
AccessibleContext associated with this JOptionPane. |
static JDesktopPane |
getDesktopPaneForComponent(Component parentComponent)
Returns the specified component's desktop pane.
|
static Frame |
getFrameForComponent(Component parentComponent)
Returns the specified component's
Frame . |
Значок |
getIcon()
Returns the icon this pane displays.
|
Объект |
getInitialSelectionValue()
Returns the input value that is displayed as initially selected to the user.
|
Объект |
getInitialValue()
Returns the initial value.
|
Объект |
getInputValue()
Returns the value the user has input, if
wantsInput
is true. |
int |
getMaxCharactersPerLineCount()
Returns the maximum number of characters to place on a line in a
message.
|
Объект |
getMessage()
Returns the message-object this pane displays.
|
int |
getMessageType()
Returns the message type.
|
Объект[] |
getOptions()
Returns the choices the user can make.
|
int |
getOptionType()
Returns the type of options that are displayed.
|
static Frame |
getRootFrame()
Returns the
Frame to use for the class methods in
which a frame is not provided. |
Объект[] |
getSelectionValues()
Returns the input selection values.
|
OptionPaneUI |
getUI()
Returns the UI object which implements the L&F for this component.
|
Строка |
getUIClassID()
Returns the name of the UI class that implements the
L&F for this component.
|
Объект |
getValue()
Returns the value the user has selected.
|
boolean |
getWantsInput()
Returns the value of the
wantsInput property. |
protected String |
paramString()
Returns a string representation of this
JOptionPane . |
void |
selectInitialValue()
Requests that the initial value be selected, which will set
focus to the initial value.
|
void |
setIcon(Icon newIcon)
Sets the icon to display.
|
void |
setInitialSelectionValue(Object newValue)
Sets the input value that is initially displayed as selected to the user.
|
void |
setInitialValue(Object newInitialValue)
Sets the initial value that is to be enabled -- the
Component
that has the focus when the pane is initially displayed. |
void |
setInputValue(Object newValue)
Sets the input value that was selected or input by the user.
|
void |
setMessage(Object newMessage)
Sets the option pane's message-object.
|
void |
setMessageType(int newType)
Sets the option pane's message type.
|
void |
setOptions(Object[] newOptions)
Sets the options this pane displays.
|
void |
setOptionType(int newType)
Sets the options to display.
|
static void |
setRootFrame(Frame newRootFrame)
Sets the frame to use for class methods in which a frame is
not provided.
|
void |
setSelectionValues(Object[] newValues)
Sets the input selection values for a pane that provides the user
with a list of items to choose from.
|
void |
setUI(OptionPaneUI ui)
Sets the UI object which implements the L&F for this component.
|
void |
setValue(Object newValue)
Sets the value the user has chosen.
|
void |
setWantsInput(boolean newValue)
Sets the
wantsInput property. |
static int |
showConfirmDialog(Component parentComponent,
Object message)
Brings up a dialog with the options Yes,
No and Cancel; with the
title, Select an Option.
|
static int |
showConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType)
Brings up a dialog where the number of choices is determined
by the
optionType parameter. |
static int |
showConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType)
Brings up a dialog where the number of choices is determined
by the
optionType parameter, where the
messageType
parameter determines the icon to display. |
static int |
showConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType,
Icon icon)
Brings up a dialog with a specified icon, where the number of
choices is determined by the
optionType parameter. |
static String |
showInputDialog(Component parentComponent,
Object message)
Shows a question-message dialog requesting input from the user
parented to
parentComponent . |
static String |
showInputDialog(Component parentComponent,
Object message,
Object initialSelectionValue)
Shows a question-message dialog requesting input from the user and
parented to
parentComponent . |
static String |
showInputDialog(Component parentComponent,
Object message,
String title,
int messageType)
Shows a dialog requesting input from the user parented to
parentComponent with the dialog having the title
title and message type messageType . |
static Object |
showInputDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon,
Object[] selectionValues,
Object initialSelectionValue)
Prompts the user for input in a blocking dialog where the
initial selection, possible selections, and all other options can
be specified.
|
static String |
showInputDialog(Object message)
Shows a question-message dialog requesting input from the user.
|
static String |
showInputDialog(Object message,
Object initialSelectionValue)
Shows a question-message dialog requesting input from the user, with
the input value initialized to
initialSelectionValue . |
static int |
showInternalConfirmDialog(Component parentComponent,
Object message)
Brings up an internal dialog panel with the options Yes, No
and Cancel; with the title, Select an Option.
|
static int |
showInternalConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType)
Brings up a internal dialog panel where the number of choices
is determined by the
optionType parameter. |
static int |
showInternalConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType)
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. |
static int |
showInternalConfirmDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType,
Icon icon)
Brings up an internal dialog panel with a specified icon, where
the number of choices is determined by the
optionType
parameter. |
static String |
showInternalInputDialog(Component parentComponent,
Object message)
Shows an internal question-message dialog requesting input from
the user parented to
parentComponent . |
static String |
showInternalInputDialog(Component parentComponent,
Object message,
String title,
int messageType)
Shows an internal dialog requesting input from the user parented
to
parentComponent with the dialog having the title
title and message type messageType . |
static Object |
showInternalInputDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon,
Object[] selectionValues,
Object initialSelectionValue)
Prompts the user for input in a blocking internal dialog where
the initial selection, possible selections, and all other
options can be specified.
|
static void |
showInternalMessageDialog(Component parentComponent,
Object message)
Brings up an internal confirmation dialog panel.
|
static void |
showInternalMessageDialog(Component parentComponent,
Object message,
String title,
int messageType)
Brings up an internal dialog panel that displays a message
using a default icon determined by the
messageType
parameter. |
static void |
showInternalMessageDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon)
Brings up an internal dialog panel displaying a message,
specifying all parameters.
|
static int |
showInternalOptionDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType,
Icon icon,
Object[] options,
Object initialValue)
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. |
static void |
showMessageDialog(Component parentComponent,
Object message)
Brings up an information-message dialog titled "Message".
|
static void |
showMessageDialog(Component parentComponent,
Object message,
String title,
int messageType)
Brings up a dialog that displays a message using a default
icon determined by the
messageType parameter. |
static void |
showMessageDialog(Component parentComponent,
Object message,
String title,
int messageType,
Icon icon)
Brings up a dialog displaying a message, specifying all parameters.
|
static int |
showOptionDialog(Component parentComponent,
Object message,
String title,
int optionType,
int messageType,
Icon icon,
Object[] options,
Object initialValue)
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. |
void |
updateUI()
Notification from the
UIManager that the L&F has changed. |
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
public static final Object UNINITIALIZED_VALUE
public static final int DEFAULT_OPTION
JOptionPane
.public static final int YES_NO_OPTION
showConfirmDialog
.public static final int YES_NO_CANCEL_OPTION
showConfirmDialog
.public static final int OK_CANCEL_OPTION
showConfirmDialog
.public static final int YES_OPTION
public static final int NO_OPTION
public static final int CANCEL_OPTION
public static final int OK_OPTION
public static final int CLOSED_OPTION
CANCEL_OPTION
or NO_OPTION
.public static final int ERROR_MESSAGE
public static final int INFORMATION_MESSAGE
public static final int WARNING_MESSAGE
public static final int QUESTION_MESSAGE
public static final int PLAIN_MESSAGE
public static final String ICON_PROPERTY
icon
.public static final String MESSAGE_PROPERTY
message
.public static final String VALUE_PROPERTY
value
.public static final String OPTIONS_PROPERTY
option
.public static final String INITIAL_VALUE_PROPERTY
initialValue
.public static final String MESSAGE_TYPE_PROPERTY
type
.public static final String OPTION_TYPE_PROPERTY
optionType
.public static final String SELECTION_VALUES_PROPERTY
selectionValues
.public static final String INITIAL_SELECTION_VALUE_PROPERTY
initialSelectionValue
.public static final String INPUT_VALUE_PROPERTY
inputValue
.public static final String WANTS_INPUT_PROPERTY
wantsInput
.protected transient Icon icon
protected transient Object message
protected transient Object[] options
protected transient Object initialValue
options
.protected int messageType
protected int optionType
DEFAULT_OPTION
,
YES_NO_OPTION
,
YES_NO_CANCEL_OPTION
or
OK_CANCEL_OPTION
.protected transient Object value
UNINITIALIZED_VALUE
or null
.protected transient Object[] selectionValues
protected transient Object inputValue
protected transient Object initialSelectionValue
selectionValues
.protected boolean wantsInput
public JOptionPane()
JOptionPane
with a test message.public JOptionPane(Object message)
JOptionPane
to display a
message using the
plain-message message type and the default options delivered by
the UI.message
- the Object
to displaypublic JOptionPane(Object message, int messageType)
JOptionPane
to display a message
with the specified message type and the default options,message
- the Object
to displaymessageType
- the type of message to be displayed:
ERROR_MESSAGE
,
INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
,
or PLAIN_MESSAGE
public JOptionPane(Object message, int messageType, int optionType)
JOptionPane
to display a message
with the specified message type and options.message
- the Object
to displaymessageType
- the type of message to be displayed:
ERROR_MESSAGE
,
INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
,
or PLAIN_MESSAGE
optionType
- the options to display in the pane:
DEFAULT_OPTION
, YES_NO_OPTION
,
YES_NO_CANCEL_OPTION
,
OK_CANCEL_OPTION
public JOptionPane(Object message, int messageType, int optionType, Icon icon)
JOptionPane
to display a message
with the specified message type, options, and icon.message
- the Object
to displaymessageType
- the type of message to be displayed:
ERROR_MESSAGE
,
INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
,
or PLAIN_MESSAGE
optionType
- the options to display in the pane:
DEFAULT_OPTION
, YES_NO_OPTION
,
YES_NO_CANCEL_OPTION
,
OK_CANCEL_OPTION
icon
- the Icon
image to displaypublic JOptionPane(Object message, int messageType, int optionType, Icon icon, Object[] options)
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
Component
s, (which are added directly) or
Strings
(which are wrapped in a JButton
).
If you provide Component
s, you must ensure that when the
Component
is clicked it messages setValue
in the created JOptionPane
.
message
- the Object
to displaymessageType
- the type of message to be displayed:
ERROR_MESSAGE
,
INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
,
or PLAIN_MESSAGE
optionType
- the options to display in the pane:
DEFAULT_OPTION
,
YES_NO_OPTION
,
YES_NO_CANCEL_OPTION
,
OK_CANCEL_OPTION
icon
- the Icon
image to displayoptions
- the choices the user can selectpublic JOptionPane(Object message, int messageType, int optionType, Icon icon, Object[] options, Object initialValue)
JOptionPane
to display a message
with the specified message type, icon, and options, with the
initially-selected option specified.message
- the Object
to displaymessageType
- the type of message to be displayed:
ERROR_MESSAGE
,
INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
,
or PLAIN_MESSAGE
optionType
- the options to display in the pane:
DEFAULT_OPTION
,
YES_NO_OPTION
,
YES_NO_CANCEL_OPTION
,
OK_CANCEL_OPTION
icon
- the Icon image to displayoptions
- the choices the user can selectinitialValue
- the choice that is initially selected; if
null
, then nothing will be initially selected;
only meaningful if options
is usedpublic static String showInputDialog(Object message) throws HeadlessException
message
- the Object
to displayHeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public static String showInputDialog(Object message, Object initialSelectionValue)
initialSelectionValue
. The
dialog uses the default frame, which usually means it is centered on
the screen.message
- the Object
to displayinitialSelectionValue
- the value used to initialize the input
fieldpublic static String showInputDialog(Component parentComponent, Object message) throws HeadlessException
parentComponent
.
The dialog is displayed on top of the Component
's
frame, and is usually positioned below the Component
.parentComponent
- the parent Component
for the
dialogmessage
- the Object
to displayHeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public static String showInputDialog(Component parentComponent, Object message, Object initialSelectionValue)
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
.parentComponent
- the parent Component
for the
dialogmessage
- the Object
to displayinitialSelectionValue
- the value used to initialize the input
fieldpublic static String showInputDialog(Component parentComponent, Object message, String title, int messageType) throws HeadlessException
parentComponent
with the dialog having the title
title
and message type messageType
.parentComponent
- the parent Component
for the
dialogmessage
- the Object
to displaytitle
- the String
to display in the dialog
title barmessageType
- the type of message that is to be displayed:
ERROR_MESSAGE
,
INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
,
or PLAIN_MESSAGE
HeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public static Object showInputDialog(Component parentComponent, Object message, String title, int messageType, Icon icon, Object[] selectionValues, Object initialSelectionValue) throws HeadlessException
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.parentComponent
- the parent Component
for the
dialogmessage
- the Object
to displaytitle
- the String
to display in the
dialog title barmessageType
- the type of message to be displayed:
ERROR_MESSAGE
,
INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
,
or PLAIN_MESSAGE
icon
- the Icon
image to displayselectionValues
- an array of Object
s that
gives the possible selectionsinitialSelectionValue
- the value used to initialize the input
fieldnull
meaning the user
canceled the inputHeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public static void showMessageDialog(Component parentComponent, Object message) throws HeadlessException
parentComponent
- determines the Frame
in
which the dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a default Frame
is usedmessage
- the Object
to displayHeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public static void showMessageDialog(Component parentComponent, Object message, String title, int messageType) throws HeadlessException
messageType
parameter.parentComponent
- determines the Frame
in which the dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a default Frame
is usedmessage
- the Object
to displaytitle
- the title string for the dialogmessageType
- the type of message to be displayed:
ERROR_MESSAGE
,
INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
,
or PLAIN_MESSAGE
HeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public static void showMessageDialog(Component parentComponent, Object message, String title, int messageType, Icon icon) throws HeadlessException
parentComponent
- determines the Frame
in which the
dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a
default Frame
is usedmessage
- the Object
to displaytitle
- the title string for the dialogmessageType
- the type of message to be displayed:
ERROR_MESSAGE
,
INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
,
or PLAIN_MESSAGE
icon
- an icon to display in the dialog that helps the user
identify the kind of message that is being displayedHeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public static int showConfirmDialog(Component parentComponent, Object message) throws HeadlessException
parentComponent
- determines the Frame
in which the
dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a
default Frame
is usedmessage
- the Object
to displayHeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public static int showConfirmDialog(Component parentComponent, Object message, String title, int optionType) throws HeadlessException
optionType
parameter.parentComponent
- determines the Frame
in which the
dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a
default Frame
is usedmessage
- the Object
to displaytitle
- the title string for the dialogoptionType
- an int designating the options available on the dialog:
YES_NO_OPTION
,
YES_NO_CANCEL_OPTION
,
or OK_CANCEL_OPTION
HeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public static int showConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType) throws HeadlessException
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.parentComponent
- determines the Frame
in
which the dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a
default Frame
is used.message
- the Object
to displaytitle
- the title string for the dialogoptionType
- an integer designating the options available
on the dialog: YES_NO_OPTION
,
YES_NO_CANCEL_OPTION
,
or OK_CANCEL_OPTION
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
HeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public static int showConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon) throws HeadlessException
optionType
parameter.
The messageType
parameter is primarily used to supply
a default icon from the look and feel.parentComponent
- determines the Frame
in which the
dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a
default Frame
is usedmessage
- the Object to displaytitle
- the title string for the dialogoptionType
- an int designating the options available on the dialog:
YES_NO_OPTION
,
YES_NO_CANCEL_OPTION
,
or OK_CANCEL_OPTION
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
icon
- the icon to display in the dialogHeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public static int showOptionDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon, Object[] options, Object initialValue) throws HeadlessException
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.
parentComponent
- determines the Frame
in which the dialog is displayed; if
null
, or if the
parentComponent
has no
Frame
, a
default Frame
is usedmessage
- the Object
to displaytitle
- the title string for the dialogoptionType
- an integer designating the options available on the
dialog: DEFAULT_OPTION
,
YES_NO_OPTION
,
YES_NO_CANCEL_OPTION
,
or OK_CANCEL_OPTION
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
icon
- the icon to display in the dialogoptions
- 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 FeelinitialValue
- the object that represents the default selection
for the dialog; only meaningful if options
is used; can be null
CLOSED_OPTION
if the user closed
the dialogHeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public JDialog createDialog(Component parentComponent, String title) throws HeadlessException
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.parentComponent
- determines the frame in which the dialog
is displayed; if the parentComponent
has
no Frame
, a default Frame
is usedtitle
- the title string for the dialogJDialog
containing this instanceHeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public JDialog createDialog(String title) throws HeadlessException
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.title
- the title string for the dialogJDialog
containing this instanceHeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
GraphicsEnvironment.isHeadless()
public static void showInternalMessageDialog(Component parentComponent, Object message)
parentComponent
- determines the Frame
in which the dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a default Frame
is usedmessage
- the object to displaypublic static void showInternalMessageDialog(Component parentComponent, Object message, String title, int messageType)
messageType
parameter.parentComponent
- determines the Frame
in which the dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a default Frame
is usedmessage
- the Object
to displaytitle
- the title string for the dialogmessageType
- the type of message to be displayed:
ERROR_MESSAGE
,
INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
,
or PLAIN_MESSAGE
public static void showInternalMessageDialog(Component parentComponent, Object message, String title, int messageType, Icon icon)
parentComponent
- determines the Frame
in which the dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a default Frame
is usedmessage
- the Object
to displaytitle
- the title string for the dialogmessageType
- the type of message to be displayed:
ERROR_MESSAGE
,
INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
,
or PLAIN_MESSAGE
icon
- an icon to display in the dialog that helps the user
identify the kind of message that is being displayedpublic static int showInternalConfirmDialog(Component parentComponent, Object message)
parentComponent
- determines the Frame
in
which the dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a default Frame
is usedmessage
- the Object
to displaypublic static int showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType)
optionType
parameter.parentComponent
- determines the Frame
in which the dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a default Frame
is usedmessage
- 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
methodtitle
- the title string for the dialogoptionType
- an integer designating the options
available on the dialog: YES_NO_OPTION
,
or YES_NO_CANCEL_OPTION
public static int showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType)
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.parentComponent
- determines the Frame
in
which the dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a default Frame
is usedmessage
- 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
methodtitle
- the title string for the dialogoptionType
- an integer designating the options
available on the dialog:
YES_NO_OPTION
, or YES_NO_CANCEL_OPTION
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
public static int showInternalConfirmDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon)
optionType
parameter.
The messageType
parameter is primarily used to supply
a default icon from the look and feel.parentComponent
- determines the Frame
in which the dialog is displayed; if null
,
or if the parentComponent has no Frame, a
default Frame
is usedmessage
- 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
methodtitle
- the title string for the dialogoptionType
- an integer designating the options available
on the dialog:
YES_NO_OPTION
, or
YES_NO_CANCEL_OPTION
.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
icon
- the icon to display in the dialogpublic static int showInternalOptionDialog(Component parentComponent, Object message, String title, int optionType, int messageType, Icon icon, Object[] options, Object initialValue)
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.
parentComponent
- determines the Frame
in which the dialog is displayed; if null
,
or if the parentComponent
has no
Frame
, a default Frame
is usedmessage
- 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
methodtitle
- the title string for the dialogoptionType
- an integer designating the options available
on the dialog: YES_NO_OPTION
,
or YES_NO_CANCEL_OPTION
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
icon
- the icon to display in the dialogoptions
- 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 FeelinitialValue
- the object that represents the default selection
for the dialog; only meaningful if options
is used; can be null
CLOSED_OPTION
if the user closed the Dialogpublic static String showInternalInputDialog(Component parentComponent, Object message)
parentComponent
. The dialog
is displayed in the Component
's frame,
and is usually positioned below the Component
.parentComponent
- the parent Component
for the dialogmessage
- the Object
to displaypublic static String showInternalInputDialog(Component parentComponent, Object message, String title, int messageType)
parentComponent
with the dialog having the title
title
and message type messageType
.parentComponent
- the parent Component
for the dialogmessage
- the Object
to displaytitle
- the String
to display in the
dialog title barmessageType
- the type of message that is to be displayed:
ERROR_MESSAGE, INFORMATION_MESSAGE, WARNING_MESSAGE,
QUESTION_MESSAGE, or PLAIN_MESSAGEpublic static Object showInternalInputDialog(Component parentComponent, Object message, String title, int messageType, Icon icon, Object[] selectionValues, Object initialSelectionValue)
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.parentComponent
- the parent Component
for the dialogmessage
- the Object
to displaytitle
- the String
to display in the dialog
title barmessageType
- the type of message to be displayed:
ERROR_MESSAGE
, INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
, or PLAIN_MESSAGE
icon
- the Icon
image to displayselectionValues
- an array of Objects
that
gives the possible selectionsinitialSelectionValue
- the value used to initialize the input
fieldnull
meaning the user
canceled the inputpublic JInternalFrame createInternalFrame(Component parentComponent, String title)
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.parentComponent
- the parent Component
for
the internal frametitle
- the String
to display in the
frame's title barJInternalFrame
containing a
JOptionPane
RuntimeException
- if parentComponent
does
not have a valid parentpublic static Frame getFrameForComponent(Component parentComponent) throws HeadlessException
Frame
.parentComponent
- the Component
to check for a
Frame
Frame
that contains the component,
or getRootFrame
if the component is null
,
or does not have a valid Frame
parentHeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
getRootFrame()
,
GraphicsEnvironment.isHeadless()
public static JDesktopPane getDesktopPaneForComponent(Component parentComponent)
parentComponent
- the Component
to check for a
desktopJDesktopPane
that contains the component,
or null
if the component is null
or does not have an ancestor that is a
JInternalFrame
public static void setRootFrame(Frame newRootFrame)
Note: It is recommended that rather than using this method you supply a valid parent.
newRootFrame
- the default Frame
to usepublic static Frame getRootFrame() throws HeadlessException
Frame
to use for the class methods in
which a frame is not provided.Frame
to useHeadlessException
- if
GraphicsEnvironment.isHeadless
returns
true
setRootFrame(java.awt.Frame)
,
GraphicsEnvironment.isHeadless()
public void setUI(OptionPaneUI ui)
ui
- the OptionPaneUI
L&F objectUIDefaults.getUI(javax.swing.JComponent)
public OptionPaneUI getUI()
OptionPaneUI
objectpublic void updateUI()
UIManager
that the L&F has changed.
Replaces the current UI object with the latest version from the
UIManager
.updateUI
in class JComponent
JComponent.updateUI()
public String getUIClassID()
getUIClassID
in class JComponent
JComponent.getUIClassID()
,
UIDefaults.getUI(javax.swing.JComponent)
public void setMessage(Object newMessage)
newMessage
- the Object
to displaygetMessage()
public Object getMessage()
Object
that is displayedsetMessage(java.lang.Object)
public void setIcon(Icon newIcon)
null
, the look and feel
does not provide an icon.newIcon
- the Icon
to displaygetIcon()
public Icon getIcon()
Icon
that is displayedsetIcon(javax.swing.Icon)
public void setValue(Object newValue)
newValue
- the chosen valuegetValue()
public Object getValue()
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.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 choicesetValue(java.lang.Object)
public void setOptions(Object[] newOptions)
newOptions
is a Component
it is added directly to the pane,
otherwise a button is created for the element.newOptions
- an array of Objects
that create the
buttons the user can click on, or arbitrary
Components
to add to the panegetOptions()
public Object[] getOptions()
Objects
that give the user's choicessetOptions(java.lang.Object[])
public void setInitialValue(Object newInitialValue)
Component
that has the focus when the pane is initially displayed.newInitialValue
- the Object
that gets the initial
keyboard focusgetInitialValue()
public Object getInitialValue()
Object
that gets the initial keyboard focussetInitialValue(java.lang.Object)
public void setMessageType(int newType)
parentComponent
.newType
- an integer specifying the kind of message to display:
ERROR_MESSAGE
, INFORMATION_MESSAGE
,
WARNING_MESSAGE
,
QUESTION_MESSAGE
, or PLAIN_MESSAGE
RuntimeException
- if newType
is not one of the
legal values listed abovegetMessageType()
public int getMessageType()
setMessageType(int)
public void setOptionType(int newType)
newType
- an integer specifying the options the L&F is to display:
DEFAULT_OPTION
,
YES_NO_OPTION
,
YES_NO_CANCEL_OPTION
,
or OK_CANCEL_OPTION
RuntimeException
- if newType
is not one of
the legal values listed abovegetOptionType()
,
setOptions(java.lang.Object[])
public int getOptionType()
setOptionType(int)
public void setSelectionValues(Object[] newValues)
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.
newValues
- an array of Objects
the user to be
displayed
(usually in a list or combo-box) from which
the user can make a selectionsetWantsInput(boolean)
,
setInitialSelectionValue(java.lang.Object)
,
getSelectionValues()
public Object[] getSelectionValues()
Objects
the user can selectsetSelectionValues(java.lang.Object[])
public void setInitialSelectionValue(Object newValue)
wantsInput
is true.newValue
- the initially selected valuesetSelectionValues(java.lang.Object[])
,
getInitialSelectionValue()
public Object getInitialSelectionValue()
setInitialSelectionValue(java.lang.Object)
,
setSelectionValues(java.lang.Object[])
public void setInputValue(Object newValue)
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
.newValue
- the Object
used to set the
value that the user specified (usually in a text field)setSelectionValues(java.lang.Object[])
,
setInitialSelectionValue(java.lang.Object)
,
setWantsInput(boolean)
,
getInputValue()
public Object getInputValue()
wantsInput
is true.Object
the user specified,
if it was one of the objects, or a
String
if it was a value typed into a
fieldsetSelectionValues(java.lang.Object[])
,
setWantsInput(boolean)
,
setInputValue(java.lang.Object)
public int getMaxCharactersPerLineCount()
Integer.MAX_VALUE
.
The value can be
changed by overriding this method in a subclass.public void setWantsInput(boolean newValue)
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.
public boolean getWantsInput()
wantsInput
property.setWantsInput(boolean)
public void selectInitialValue()
protected String paramString()
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
.paramString
in class JComponent
JOptionPane
public AccessibleContext getAccessibleContext()
AccessibleContext
associated with this JOptionPane.
For option panes, the AccessibleContext
takes the form of an
AccessibleJOptionPane
.
A new AccessibleJOptionPane
instance is created if necessary.getAccessibleContext
in interface Accessible
getAccessibleContext
in class Component
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b92