JOptionPane

Class Overview

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.

All dialogs are modal. Each showXxxDialog method blocks the caller until the user's interaction is complete.

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.

Component

The Component is displayed in the dialog.

Icon

The Icon is wrapped in a JLabel and displayed in the dialog.

others

The object is converted to a String by calling its toString method. The result is wrapped in a JLabel and displayed.

messageType

Defines the style of the message. The Look and Feel manager may lay out the dialog differently depending on this value, and will often provide a default icon. The possible values are:

• ERROR_MESSAGE
• INFORMATION_MESSAGE
• WARNING_MESSAGE
• QUESTION_MESSAGE
• PLAIN_MESSAGE

optionType

Defines the set of option buttons that appear at the bottom of the dialog box:

• DEFAULT_OPTION
• YES_NO_OPTION
• YES_NO_CANCEL_OPTION
• OK_CANCEL_OPTION

You aren't limited to this set of option buttons. You can provide any buttons you want using the options parameter.

options

A more detailed description of the set of option buttons that will appear at the bottom of the dialog box. The usual value for the options parameter is an array of Strings. But the parameter type is an array of Objects. A button is created for each object depending on its type:

Component

The component is added to the button row directly.

Icon

A JButton is created with this as its label.

other

The Object is converted to a string using its toString method and the result is used to label a JButton.

icon

A decorative icon to be placed in the dialog box. A default value for this is determined by the messageType parameter.

title

The title for the dialog box.

initialValue

The default selection (input value).

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

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

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

• YES_OPTION
• NO_OPTION
• CANCEL_OPTION
• OK_OPTION
• CLOSED_OPTION

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]);

     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^TM has been added to the java.beans package. Please see XMLEncoder.

Summary

[Expand] Inherited Constants
From class javax.swing.JComponent String TOOL_TIP_TEXT_KEY The comment to display when the cursor is over the component, also known as a "value tip", "flyover help", or "flyover label". int UNDEFINED_CONDITION Constant used by some of the APIs to mean that no condition is defined. int WHEN_ANCESTOR_OF_FOCUSED_COMPONENT Constant used for registerKeyboardAction that means that the command should be invoked when the receiving component is an ancestor of the focused component or is itself the focused component. int WHEN_FOCUSED Constant used for registerKeyboardAction that means that the command should be invoked when the component has the focus. int WHEN_IN_FOCUSED_WINDOW Constant used for registerKeyboardAction that means that the command should be invoked when the receiving component is in the window that has the focus or is itself the focused component.
From class java.awt.Component float BOTTOM_ALIGNMENT Ease-of-use constant for getAlignmentY. float CENTER_ALIGNMENT Ease-of-use constant for getAlignmentY and getAlignmentX. float LEFT_ALIGNMENT Ease-of-use constant for getAlignmentX. float RIGHT_ALIGNMENT Ease-of-use constant for getAlignmentX. float TOP_ALIGNMENT Ease-of-use constant for getAlignmentY().
From interface java.awt.image.ImageObserver int ABORT This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously was aborted before production was complete. int ALLBITS This flag in the infoflags argument to imageUpdate indicates that a static image which was previously drawn is now complete and can be drawn again in its final form. int ERROR This flag in the infoflags argument to imageUpdate indicates that an image which was being tracked asynchronously has encountered an error. int FRAMEBITS This flag in the infoflags argument to imageUpdate indicates that another complete frame of a multi-frame image which was previously drawn is now available to be drawn again. int HEIGHT This flag in the infoflags argument to imageUpdate indicates that the height of the base image is now available and can be taken from the height argument to the imageUpdate callback method. int PROPERTIES This flag in the infoflags argument to imageUpdate indicates that the properties of the image are now available. int SOMEBITS This flag in the infoflags argument to imageUpdate indicates that more pixels needed for drawing a scaled variation of the image are available. int WIDTH This flag in the infoflags argument to imageUpdate indicates that the width of the base image is now available and can be taken from the width argument to the imageUpdate callback method.

[Expand] Inherited Fields
From class javax.swing.JComponent protected AccessibleContext accessibleContext The AccessibleContext associated with this JComponent. protected EventListenerList listenerList A list of event listeners for this component. protected ComponentUI ui The look and feel delegate for this component.

[Expand] Inherited Methods
From class javax.swing.JComponent void addAncestorListener(AncestorListener listener) Registers listener so that it will receive AncestorEvents when it or any of its ancestors move or are made visible or invisible. void addNotify() Notifies this component that it now has a parent component. synchronized void addVetoableChangeListener(VetoableChangeListener listener) Adds a VetoableChangeListener to the listener list. void computeVisibleRect(Rectangle visibleRect) Returns the Component's "visible rect rectangle" - the intersection of the visible rectangles for this component and all of its ancestors. boolean contains(int x, int y) Gives the UI delegate an opportunity to define the precise shape of this component for the sake of mouse processing. JToolTip createToolTip() Returns the instance of JToolTip that should be used to display the tooltip. void disable() This method is deprecated. As of JDK version 1.1, replaced by java.awt.Component.setEnabled(boolean). void enable() This method is deprecated. As of JDK version 1.1, replaced by java.awt.Component.setEnabled(boolean). void firePropertyChange(String propertyName, boolean oldValue, boolean newValue) Support for reporting bound property changes for boolean properties. void firePropertyChange(String propertyName, char oldValue, char newValue) Reports a bound property change. void firePropertyChange(String propertyName, int oldValue, int newValue) Support for reporting bound property changes for integer properties. void fireVetoableChange(String propertyName, Object oldValue, Object newValue) Supports reporting constrained property changes. AccessibleContext getAccessibleContext() Returns the AccessibleContext associated with this JComponent. ActionListener getActionForKeyStroke(KeyStroke aKeyStroke) Returns the object that will perform the action registered for a given keystroke. final ActionMap getActionMap() Returns the ActionMap used to determine what Action to fire for particular KeyStroke binding. float getAlignmentX() Overrides Container.getAlignmentX to return the vertical alignment. float getAlignmentY() Overrides Container.getAlignmentY to return the horizontal alignment. AncestorListener[] getAncestorListeners() Returns an array of all the ancestor listeners registered on this component. boolean getAutoscrolls() Gets the autoscrolls property. int getBaseline(int width, int height) Returns the baseline. Component.BaselineResizeBehavior getBaselineResizeBehavior() Returns an enum indicating how the baseline of the component changes as the size changes. Border getBorder() Returns the border of this component or null if no border is currently set. Rectangle getBounds(Rectangle rv) Stores the bounds of this component into "return value" rv and returns rv. final Object getClientProperty(Object key) Returns the value of the property with the specified key. Graphics getComponentGraphics(Graphics g) Returns the graphics object used to paint this component. JPopupMenu getComponentPopupMenu() Returns JPopupMenu that assigned for this component. int getConditionForKeyStroke(KeyStroke aKeyStroke) Returns the condition that determines whether a registered action occurs in response to the specified keystroke. int getDebugGraphicsOptions() Returns the state of graphics debugging. static Locale getDefaultLocale() Returns the default locale used to initialize each JComponent's locale property upon creation. FontMetrics getFontMetrics(Font font) Gets the FontMetrics for the specified Font. Graphics getGraphics() Returns this component's graphics context, which lets you draw on a component. int getHeight() Returns the current height of this component. boolean getInheritsPopupMenu() Returns true if the JPopupMenu should be inherited from the parent. final InputMap getInputMap() Returns the InputMap that is used when the component has focus. final InputMap getInputMap(int condition) Returns the InputMap that is used during condition. InputVerifier getInputVerifier() Returns the input verifier for this component. Insets getInsets() If a border has been set on this component, returns the border's insets; otherwise calls super.getInsets. Insets getInsets(Insets insets) Returns an Insets object containing this component's inset values. <T extends EventListener> T[] getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as FooListeners upon this JComponent. Point getLocation(Point rv) Stores the x,y origin of this component into "return value" rv and returns rv. Dimension getMaximumSize() If the maximum size has been set to a non-null value just returns it. Dimension getMinimumSize() If the minimum size has been set to a non-null value just returns it. Component getNextFocusableComponent() This method is deprecated. As of 1.4, replaced by FocusTraversalPolicy. Point getPopupLocation(MouseEvent event) Returns the preferred location to display the popup menu in this component's coordinate system. Dimension getPreferredSize() If the preferredSize has been set to a non-null value just returns it. KeyStroke[] getRegisteredKeyStrokes() Returns the KeyStrokes that will initiate registered actions. JRootPane getRootPane() Returns the JRootPane ancestor for this component. Dimension getSize(Dimension rv) Stores the width/height of this component into "return value" rv and returns rv. Point getToolTipLocation(MouseEvent event) Returns the tooltip location in this component's coordinate system. String getToolTipText() Returns the tooltip string that has been set with setToolTipText. String getToolTipText(MouseEvent event) Returns the string to be used as the tooltip for event. Container getTopLevelAncestor() Returns the top-level ancestor of this component (either the containing Window or Applet), or null if this component has not been added to any container. TransferHandler getTransferHandler() Gets the transferHandler property. String getUIClassID() Returns the UIDefaults key used to look up the name of the swing.plaf.ComponentUI class that defines the look and feel for this component. boolean getVerifyInputWhenFocusTarget() Returns the value that indicates whether the input verifier for the current focus owner will be called before this component requests focus. synchronized VetoableChangeListener[] getVetoableChangeListeners() Returns an array of all the vetoable change listeners registered on this component. Rectangle getVisibleRect() Returns the Component's "visible rectangle" - the intersection of this component's visible rectangle, new Rectangle(0, 0, getWidth(), getHeight()), and all of its ancestors' visible rectangles. int getWidth() Returns the current width of this component. int getX() Returns the current x coordinate of the component's origin. int getY() Returns the current y coordinate of the component's origin. void grabFocus() Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window. boolean isDoubleBuffered() Returns whether this component should use a buffer to paint. static boolean isLightweightComponent(Component c) Returns true if this component is lightweight, that is, if it doesn't have a native window system peer. boolean isManagingFocus() This method is deprecated. As of 1.4, replaced by Component.setFocusTraversalKeys(int, Set) and Container.setFocusCycleRoot(boolean). boolean isOpaque() Returns true if this component is completely opaque. boolean isOptimizedDrawingEnabled() Returns true if this component tiles its children -- that is, if it can guarantee that the children will not overlap. final boolean isPaintingForPrint() Returns true if the current painting operation on this component is part of a print operation. boolean isPaintingTile() Returns true if the component is currently painting a tile. boolean isRequestFocusEnabled() Returns true if this JComponent should get focus; otherwise returns false. boolean isValidateRoot() If this method returns true, revalidate calls by descendants of this component will cause the entire tree beginning with this root to be validated. void paint(Graphics g) Invoked by Swing to draw components. void paintBorder(Graphics g) Paints the component's border. void paintChildren(Graphics g) Paints this component's children. void paintComponent(Graphics g) Calls the UI delegate's paint method, if the UI delegate is non-null. void paintImmediately(int x, int y, int w, int h) Paints the specified region in this component and all of its descendants that overlap the region, immediately. void paintImmediately(Rectangle r) Paints the specified region now. String paramString() Returns a string representation of this JComponent. void print(Graphics g) Invoke this method to print the component to the specified Graphics. void printAll(Graphics g) Invoke this method to print the component. void printBorder(Graphics g) Prints the component's border. void printChildren(Graphics g) Prints this component's children. void printComponent(Graphics g) This is invoked during a printing operation. void processComponentKeyEvent(KeyEvent e) Processes any key events that the component itself recognizes. boolean processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed) Invoked to process the key bindings for ks as the result of the KeyEvent e. void processKeyEvent(KeyEvent e) Overrides processKeyEvent to process events. void processMouseEvent(MouseEvent e) Processes mouse events occurring on this component by dispatching them to any registered MouseListener objects, refer to processMouseEvent(MouseEvent) for a complete description of this method. void processMouseMotionEvent(MouseEvent e) Processes mouse motion events, such as MouseEvent.MOUSE_DRAGGED. final void putClientProperty(Object key, Object value) Adds an arbitrary key/value "client property" to this component. void registerKeyboardAction(ActionListener anAction, KeyStroke aKeyStroke, int aCondition) This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similiar behavior. void registerKeyboardAction(ActionListener anAction, String aCommand, KeyStroke aKeyStroke, int aCondition) This method is now obsolete, please use a combination of getActionMap() and getInputMap() for similiar behavior. void removeAncestorListener(AncestorListener listener) Unregisters listener so that it will no longer receive AncestorEvents. void removeNotify() Notifies this component that it no longer has a parent component. synchronized void removeVetoableChangeListener(VetoableChangeListener listener) Removes a VetoableChangeListener from the listener list. void repaint(long tm, int x, int y, int width, int height) Adds the specified region to the dirty region list if the component is showing. void repaint(Rectangle r) Adds the specified region to the dirty region list if the component is showing. boolean requestDefaultFocus() This method is deprecated. As of 1.4, replaced by FocusTraversalPolicy.getDefaultComponent(Container).requestFocus() void requestFocus() Requests that this Component gets the input focus. boolean requestFocus(boolean temporary) Requests that this Component gets the input focus. boolean requestFocusInWindow(boolean temporary) Requests that this Component gets the input focus. boolean requestFocusInWindow() Requests that this Component gets the input focus. void resetKeyboardActions() Unregisters all the bindings in the first tier InputMaps and ActionMap. void reshape(int x, int y, int w, int h) This method is deprecated. As of JDK 5, replaced by Component.setBounds(int, int, int, int). Moves and resizes this component. void revalidate() Supports deferred automatic layout. void scrollRectToVisible(Rectangle aRect) Forwards the scrollRectToVisible() message to the JComponent's parent. final void setActionMap(ActionMap am) Sets the ActionMap to am. void setAlignmentX(float alignmentX) Sets the the vertical alignment. void setAlignmentY(float alignmentY) Sets the the horizontal alignment. void setAutoscrolls(boolean autoscrolls) Sets the autoscrolls property. void setBackground(Color bg) Sets the background color of this component. void setBorder(Border border) Sets the border of this component. void setComponentPopupMenu(JPopupMenu popup) Sets the JPopupMenu for this JComponent. void setDebugGraphicsOptions(int debugOptions) Enables or disables diagnostic information about every graphics operation performed within the component or one of its children. static void setDefaultLocale(Locale l) Sets the default locale used to initialize each JComponent's locale property upon creation. void setDoubleBuffered(boolean aFlag) Sets whether this component should use a buffer to paint. void setEnabled(boolean enabled) Sets whether or not this component is enabled. void setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes) Sets the focus traversal keys for a given traversal operation for this Component. void setFont(Font font) Sets the font for this component. void setForeground(Color fg) Sets the foreground color of this component. void setInheritsPopupMenu(boolean value) Sets whether or not getComponentPopupMenu should delegate to the parent if this component does not have a JPopupMenu assigned to it. final void setInputMap(int condition, InputMap map) Sets the InputMap to use under the condition condition to map. void setInputVerifier(InputVerifier inputVerifier) Sets the input verifier for this component. void setMaximumSize(Dimension maximumSize) Sets the maximum size of this component to a constant value. void setMinimumSize(Dimension minimumSize) Sets the minimum size of this component to a constant value. void setNextFocusableComponent(Component aComponent) This method is deprecated. As of 1.4, replaced by FocusTraversalPolicy void setOpaque(boolean isOpaque) If true the component paints every pixel within its bounds. void setPreferredSize(Dimension preferredSize) Sets the preferred size of this component. void setRequestFocusEnabled(boolean requestFocusEnabled) Provides a hint as to whether or not this JComponent should get focus. void setToolTipText(String text) Registers the text to display in a tool tip. void setTransferHandler(TransferHandler newHandler) Sets the transferHandler property, which is null if the component does not support data transfer operations. void setUI(ComponentUI newUI) Sets the look and feel delegate for this component. void setVerifyInputWhenFocusTarget(boolean verifyInputWhenFocusTarget) Sets the value to indicate whether input verifier for the current focus owner will be called before this component requests focus. void setVisible(boolean aFlag) Makes the component visible or invisible. void unregisterKeyboardAction(KeyStroke aKeyStroke) This method is now obsolete. void update(Graphics g) Calls paint. void updateUI() Resets the UI property to a value from the current look and feel.
From class java.awt.Container void add(Component comp, Object constraints) Adds the specified component to the end of this container. Component add(String name, Component comp) Adds the specified component to this container. Component add(Component comp, int index) Adds the specified component to this container at the given position. Component add(Component comp) Appends the specified component to the end of this container. void add(Component comp, Object constraints, int index) Adds the specified component to this container with the specified constraints at the specified index. synchronized void addContainerListener(ContainerListener l) Adds the specified container listener to receive container events from this container. void addImpl(Component comp, Object constraints, int index) Adds the specified component to this container at the specified index. void addNotify() Makes this Container displayable by connecting it to a native screen resource. void addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list for a specific property. void addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list. void applyComponentOrientation(ComponentOrientation o) Sets the ComponentOrientation property of this container and all components contained within it. boolean areFocusTraversalKeysSet(int id) Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Container. int countComponents() This method is deprecated. As of JDK version 1.1, replaced by getComponentCount(). void deliverEvent(Event e) This method is deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent e) void doLayout() Causes this container to lay out its components. Component findComponentAt(Point p) Locates the visible child component that contains the specified point. Component findComponentAt(int x, int y) Locates the visible child component that contains the specified position. float getAlignmentX() Returns the alignment along the x axis. float getAlignmentY() Returns the alignment along the y axis. Component getComponent(int n) Gets the nth component in this container. Component getComponentAt(int x, int y) Locates the component that contains the x,y position. Component getComponentAt(Point p) Gets the component that contains the specified point. int getComponentCount() Gets the number of components in this panel. int getComponentZOrder(Component comp) Returns the z-order index of the component inside the container. Component[] getComponents() Gets all the components in this container. synchronized ContainerListener[] getContainerListeners() Returns an array of all the container listeners registered on this container. Set<AWTKeyStroke> getFocusTraversalKeys(int id) Returns the Set of focus traversal keys for a given traversal operation for this Container. FocusTraversalPolicy getFocusTraversalPolicy() Returns the focus traversal policy that will manage keyboard traversal of this Container's children, or null if this Container is not a focus cycle root. Insets getInsets() Determines the insets of this container, which indicate the size of the container's border. LayoutManager getLayout() Gets the layout manager for this container. <T extends EventListener> T[] getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as FooListeners upon this Container. Dimension getMaximumSize() Returns the maximum size of this container. Dimension getMinimumSize() Returns the minimum size of this container. Point getMousePosition(boolean allowChildren) Returns the position of the mouse pointer in this Container's coordinate space if the Container is under the mouse pointer, otherwise returns null. Dimension getPreferredSize() Returns the preferred size of this container. Insets insets() This method is deprecated. As of JDK version 1.1, replaced by getInsets(). void invalidate() Invalidates the container. boolean isAncestorOf(Component c) Checks if the component is contained in the component hierarchy of this container. boolean isFocusCycleRoot(Container container) Returns whether the specified Container is the focus cycle root of this Container's focus traversal cycle. boolean isFocusCycleRoot() Returns whether this Container is the root of a focus traversal cycle. final boolean isFocusTraversalPolicyProvider() Returns whether this container provides focus traversal policy. boolean isFocusTraversalPolicySet() Returns whether the focus traversal policy has been explicitly set for this Container. void layout() This method is deprecated. As of JDK version 1.1, replaced by doLayout(). void list(PrintStream out, int indent) Prints a listing of this container to the specified output stream. void list(PrintWriter out, int indent) Prints out a list, starting at the specified indentation, to the specified print writer. Component locate(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by getComponentAt(int, int). Dimension minimumSize() This method is deprecated. As of JDK version 1.1, replaced by getMinimumSize(). void paint(Graphics g) Paints the container. void paintComponents(Graphics g) Paints each of the components in this container. String paramString() Returns a string representing the state of this Container. Dimension preferredSize() This method is deprecated. As of JDK version 1.1, replaced by getPreferredSize(). void print(Graphics g) Prints the container. void printComponents(Graphics g) Prints each of the components in this container. void processContainerEvent(ContainerEvent e) Processes container events occurring on this container by dispatching them to any registered ContainerListener objects. void processEvent(AWTEvent e) Processes events on this container. void remove(Component comp) Removes the specified component from this container. void remove(int index) Removes the component, specified by index, from this container. void removeAll() Removes all the components from this container. synchronized void removeContainerListener(ContainerListener l) Removes the specified container listener so it no longer receives container events from this container. void removeNotify() Makes this Container undisplayable by removing its connection to its native screen resource. void setComponentZOrder(Component comp, int index) Moves the specified component to the specified z-order index in the container. void setFocusCycleRoot(boolean focusCycleRoot) Sets whether this Container is the root of a focus traversal cycle. void setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes) Sets the focus traversal keys for a given traversal operation for this Container. void setFocusTraversalPolicy(FocusTraversalPolicy policy) Sets the focus traversal policy that will manage keyboard traversal of this Container's children, if this Container is a focus cycle root. final void setFocusTraversalPolicyProvider(boolean provider) Sets whether this container will be used to provide focus traversal policy. void setFont(Font f) Sets the font of this container. void setLayout(LayoutManager mgr) Sets the layout manager for this container. void transferFocusDownCycle() Transfers the focus down one focus traversal cycle. void update(Graphics g) Updates the container. void validate() Validates this container and all of its subcomponents. void validateTree() Recursively descends the container tree and recomputes the layout for any subtrees marked as needing it (those marked as invalid).
From class java.awt.Component boolean action(Event evt, Object what) This method is deprecated. As of JDK version 1.1, should register this component as ActionListener on component which fires action events. void add(PopupMenu popup) Adds the specified popup menu to the component. synchronized void addComponentListener(ComponentListener l) Adds the specified component listener to receive component events from this component. synchronized void addFocusListener(FocusListener l) Adds the specified focus listener to receive focus events from this component when this component gains input focus. void addHierarchyBoundsListener(HierarchyBoundsListener l) Adds the specified hierarchy bounds listener to receive hierarchy bounds events from this component when the hierarchy to which this container belongs changes. void addHierarchyListener(HierarchyListener l) Adds the specified hierarchy listener to receive hierarchy changed events from this component when the hierarchy to which this container belongs changes. synchronized void addInputMethodListener(InputMethodListener l) Adds the specified input method listener to receive input method events from this component. synchronized void addKeyListener(KeyListener l) Adds the specified key listener to receive key events from this component. synchronized void addMouseListener(MouseListener l) Adds the specified mouse listener to receive mouse events from this component. synchronized void addMouseMotionListener(MouseMotionListener l) Adds the specified mouse motion listener to receive mouse motion events from this component. synchronized void addMouseWheelListener(MouseWheelListener l) Adds the specified mouse wheel listener to receive mouse wheel events from this component. void addNotify() Makes this Component displayable by connecting it to a native screen resource. void addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list for a specific property. void addPropertyChangeListener(PropertyChangeListener listener) Adds a PropertyChangeListener to the listener list. void applyComponentOrientation(ComponentOrientation orientation) Sets the ComponentOrientation property of this component and all components contained within it. boolean areFocusTraversalKeysSet(int id) Returns whether the Set of focus traversal keys for the given focus traversal operation has been explicitly defined for this Component. Rectangle bounds() This method is deprecated. As of JDK version 1.1, replaced by getBounds(). int checkImage(Image image, ImageObserver observer) Returns the status of the construction of a screen representation of the specified image. int checkImage(Image image, int width, int height, ImageObserver observer) Returns the status of the construction of a screen representation of the specified image. AWTEvent coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent) Potentially coalesce an event being posted with an existing event. boolean contains(Point p) Checks whether this component "contains" the specified point, where the point's x and y coordinates are defined to be relative to the coordinate system of this component. boolean contains(int x, int y) Checks whether this component "contains" the specified point, where x and y are defined to be relative to the coordinate system of this component. Image createImage(int width, int height) Creates an off-screen drawable image to be used for double buffering. Image createImage(ImageProducer producer) Creates an image from the specified image producer. VolatileImage createVolatileImage(int width, int height, ImageCapabilities caps) Creates a volatile off-screen drawable image, with the given capabilities. VolatileImage createVolatileImage(int width, int height) Creates a volatile off-screen drawable image to be used for double buffering. void deliverEvent(Event e) This method is deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent e). void disable() This method is deprecated. As of JDK version 1.1, replaced by setEnabled(boolean). final void disableEvents(long eventsToDisable) Disables the events defined by the specified event mask parameter from being delivered to this component. final void dispatchEvent(AWTEvent e) Dispatches an event to this component or one of its sub components. void doLayout() Prompts the layout manager to lay out this component. void enable() This method is deprecated. As of JDK version 1.1, replaced by setEnabled(boolean). void enable(boolean b) This method is deprecated. As of JDK version 1.1, replaced by setEnabled(boolean). final void enableEvents(long eventsToEnable) Enables the events defined by the specified event mask parameter to be delivered to this component. void enableInputMethods(boolean enable) Enables or disables input method support for this component. void firePropertyChange(String propertyName, float oldValue, float newValue) Reports a bound property change. void firePropertyChange(String propertyName, byte oldValue, byte newValue) Reports a bound property change. void firePropertyChange(String propertyName, char oldValue, char newValue) Reports a bound property change. void firePropertyChange(String propertyName, short oldValue, short newValue) Reports a bound property change. void firePropertyChange(String propertyName, long oldValue, long newValue) Reports a bound property change. void firePropertyChange(String propertyName, boolean oldValue, boolean newValue) Support for reporting bound property changes for boolean properties. void firePropertyChange(String propertyName, double oldValue, double newValue) Reports a bound property change. void firePropertyChange(String propertyName, Object oldValue, Object newValue) Support for reporting bound property changes for Object properties. void firePropertyChange(String propertyName, int oldValue, int newValue) Support for reporting bound property changes for integer properties. AccessibleContext getAccessibleContext() Gets the AccessibleContext associated with this Component. float getAlignmentX() Returns the alignment along the x axis. float getAlignmentY() Returns the alignment along the y axis. Color getBackground() Gets the background color of this component. int getBaseline(int width, int height) Returns the baseline. Component.BaselineResizeBehavior getBaselineResizeBehavior() Returns an enum indicating how the baseline of the component changes as the size changes. Rectangle getBounds(Rectangle rv) Stores the bounds of this component into "return value" rv and return rv. Rectangle getBounds() Gets the bounds of this component in the form of a Rectangle object. ColorModel getColorModel() Gets the instance of ColorModel used to display the component on the output device. Component getComponentAt(Point p) Returns the component or subcomponent that contains the specified point. Component getComponentAt(int x, int y) Determines if this component or one of its immediate subcomponents contains the (x, y) location, and if so, returns the containing component. synchronized ComponentListener[] getComponentListeners() Returns an array of all the component listeners registered on this component. ComponentOrientation getComponentOrientation() Retrieves the language-sensitive orientation that is to be used to order the elements or text within this component. Cursor getCursor() Gets the cursor set in the component. synchronized DropTarget getDropTarget() Gets the DropTarget associated with this Component. Container getFocusCycleRootAncestor() Returns the Container which is the focus cycle root of this Component's focus traversal cycle. synchronized FocusListener[] getFocusListeners() Returns an array of all the focus listeners registered on this component. Set<AWTKeyStroke> getFocusTraversalKeys(int id) Returns the Set of focus traversal keys for a given traversal operation for this Component. boolean getFocusTraversalKeysEnabled() Returns whether focus traversal keys are enabled for this Component. Font getFont() Gets the font of this component. FontMetrics getFontMetrics(Font font) Gets the font metrics for the specified font. Color getForeground() Gets the foreground color of this component. Graphics getGraphics() Creates a graphics context for this component. GraphicsConfiguration getGraphicsConfiguration() Gets the GraphicsConfiguration associated with this Component. int getHeight() Returns the current height of this component. synchronized HierarchyBoundsListener[] getHierarchyBoundsListeners() Returns an array of all the hierarchy bounds listeners registered on this component. synchronized HierarchyListener[] getHierarchyListeners() Returns an array of all the hierarchy listeners registered on this component. boolean getIgnoreRepaint() InputContext getInputContext() Gets the input context used by this component for handling the communication with input methods when text is entered in this component. synchronized InputMethodListener[] getInputMethodListeners() Returns an array of all the input method listeners registered on this component. InputMethodRequests getInputMethodRequests() Gets the input method request handler which supports requests from input methods for this component. synchronized KeyListener[] getKeyListeners() Returns an array of all the key listeners registered on this component. <T extends EventListener> T[] getListeners(Class<T> listenerType) Returns an array of all the objects currently registered as FooListeners upon this Component. Locale getLocale() Gets the locale of this component. Point getLocation() Gets the location of this component in the form of a point specifying the component's top-left corner. Point getLocation(Point rv) Stores the x,y origin of this component into "return value" rv and return rv. Point getLocationOnScreen() Gets the location of this component in the form of a point specifying the component's top-left corner in the screen's coordinate space. Dimension getMaximumSize() Gets the maximum size of this component. Dimension getMinimumSize() Gets the mininimum size of this component. synchronized MouseListener[] getMouseListeners() Returns an array of all the mouse listeners registered on this component. synchronized MouseMotionListener[] getMouseMotionListeners() Returns an array of all the mouse motion listeners registered on this component. Point getMousePosition() Returns the position of the mouse pointer in this Component's coordinate space if the Component is directly under the mouse pointer, otherwise returns null. synchronized MouseWheelListener[] getMouseWheelListeners() Returns an array of all the mouse wheel listeners registered on this component. String getName() Gets the name of the component. Container getParent() Gets the parent of this component. ComponentPeer getPeer() This method is deprecated. As of JDK version 1.1, programs should not directly manipulate peers; replaced by boolean isDisplayable(). Dimension getPreferredSize() Gets the preferred size of this component. PropertyChangeListener[] getPropertyChangeListeners() Returns an array of all the property change listeners registered on this component. PropertyChangeListener[] getPropertyChangeListeners(String propertyName) Returns an array of all the listeners which have been associated with the named property. Dimension getSize() Returns the size of this component in the form of a Dimension object. Dimension getSize(Dimension rv) Stores the width/height of this component into "return value" rv and return rv. Toolkit getToolkit() Gets the toolkit of this component. final Object getTreeLock() Gets this component's locking object (the object that owns the thread sychronization monitor) for AWT component-tree and layout operations. int getWidth() Returns the current width of this component. int getX() Returns the current x coordinate of the components origin. int getY() Returns the current y coordinate of the components origin. boolean gotFocus(Event evt, Object what) This method is deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent). boolean handleEvent(Event evt) This method is deprecated. As of JDK version 1.1 replaced by processEvent(AWTEvent). boolean hasFocus() Returns true if this Component is the focus owner. void hide() This method is deprecated. As of JDK version 1.1, replaced by setVisible(boolean). boolean imageUpdate(Image img, int infoflags, int x, int y, int w, int h) Repaints the component when the image has changed. boolean inside(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by contains(int, int). void invalidate() Invalidates this component. boolean isBackgroundSet() Returns whether the background color has been explicitly set for this Component. boolean isCursorSet() Returns whether the cursor has been explicitly set for this Component. boolean isDisplayable() Determines whether this component is displayable. boolean isDoubleBuffered() Returns true if this component is painted to an offscreen image ("buffer") that's copied to the screen later. boolean isEnabled() Determines whether this component is enabled. boolean isFocusCycleRoot(Container container) Returns whether the specified Container is the focus cycle root of this Component's focus traversal cycle. boolean isFocusOwner() Returns true if this Component is the focus owner. boolean isFocusTraversable() This method is deprecated. As of 1.4, replaced by isFocusable(). boolean isFocusable() Returns whether this Component can be focused. boolean isFontSet() Returns whether the font has been explicitly set for this Component. boolean isForegroundSet() Returns whether the foreground color has been explicitly set for this Component. boolean isLightweight() A lightweight component doesn't have a native toolkit peer. boolean isMaximumSizeSet() Returns true if the maximum size has been set to a non-null value otherwise returns false. boolean isMinimumSizeSet() Returns whether or not setMinimumSize has been invoked with a non-null value. boolean isOpaque() Returns true if this component is completely opaque, returns false by default. boolean isPreferredSizeSet() Returns true if the preferred size has been set to a non-null value otherwise returns false. boolean isShowing() Determines whether this component is showing on screen. boolean isValid() Determines whether this component is valid. boolean isVisible() Determines whether this component should be visible when its parent is visible. boolean keyDown(Event evt, int key) This method is deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent). boolean keyUp(Event evt, int key) This method is deprecated. As of JDK version 1.1, replaced by processKeyEvent(KeyEvent). void layout() This method is deprecated. As of JDK version 1.1, replaced by doLayout(). void list(PrintStream out) Prints a listing of this component to the specified output stream. void list() Prints a listing of this component to the standard system output stream System.out. void list(PrintStream out, int indent) Prints out a list, starting at the specified indentation, to the specified print stream. void list(PrintWriter out) Prints a listing to the specified print writer. void list(PrintWriter out, int indent) Prints out a list, starting at the specified indentation, to the specified print writer. Component locate(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by getComponentAt(int, int). Point location() This method is deprecated. As of JDK version 1.1, replaced by getLocation(). boolean lostFocus(Event evt, Object what) This method is deprecated. As of JDK version 1.1, replaced by processFocusEvent(FocusEvent). Dimension minimumSize() This method is deprecated. As of JDK version 1.1, replaced by getMinimumSize(). boolean mouseDown(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent). boolean mouseDrag(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent). boolean mouseEnter(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent). boolean mouseExit(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent). boolean mouseMove(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseMotionEvent(MouseEvent). boolean mouseUp(Event evt, int x, int y) This method is deprecated. As of JDK version 1.1, replaced by processMouseEvent(MouseEvent). void move(int x, int y) This method is deprecated. As of JDK version 1.1, replaced by setLocation(int, int). void nextFocus() This method is deprecated. As of JDK version 1.1, replaced by transferFocus(). void paint(Graphics g) Paints this component. void paintAll(Graphics g) Paints this component and all of its subcomponents. String paramString() Returns a string representing the state of this component. boolean postEvent(Event e) This method is deprecated. As of JDK version 1.1, replaced by dispatchEvent(AWTEvent). Dimension preferredSize() This method is deprecated. As of JDK version 1.1, replaced by getPreferredSize(). boolean prepareImage(Image image, ImageObserver observer) Prepares an image for rendering on this component. boolean prepareImage(Image image, int width, int height, ImageObserver observer) Prepares an image for rendering on this component at the specified width and height. void print(Graphics g) Prints this component. void printAll(Graphics g) Prints this component and all of its subcomponents. void processComponentEvent(ComponentEvent e) Processes component events occurring on this component by dispatching them to any registered ComponentListener objects. void processEvent(AWTEvent e) Processes events occurring on this component. void processFocusEvent(FocusEvent e) Processes focus events occurring on this component by dispatching them to any registered FocusListener objects. void processHierarchyBoundsEvent(HierarchyEvent e) Processes hierarchy bounds events occurring on this component by dispatching them to any registered HierarchyBoundsListener objects. void processHierarchyEvent(HierarchyEvent e) Processes hierarchy events occurring on this component by dispatching them to any registered HierarchyListener objects. void processInputMethodEvent(InputMethodEvent e) Processes input method events occurring on this component by dispatching them to any registered InputMethodListener objects. void processKeyEvent(KeyEvent e) Processes key events occurring on this component by dispatching them to any registered KeyListener objects. void processMouseEvent(MouseEvent e) Processes mouse events occurring on this component by dispatching them to any registered MouseListener objects. void processMouseMotionEvent(MouseEvent e) Processes mouse motion events occurring on this component by dispatching them to any registered MouseMotionListener objects. void processMouseWheelEvent(MouseWheelEvent e) Processes mouse wheel events occurring on this component by dispatching them to any registered MouseWheelListener objects. void remove(MenuComponent popup) Removes the specified popup menu from the component. synchronized void removeComponentListener(ComponentListener l) Removes the specified component listener so that it no longer receives component events from this component. synchronized void removeFocusListener(FocusListener l) Removes the specified focus listener so that it no longer receives focus events from this component. void removeHierarchyBoundsListener(HierarchyBoundsListener l) Removes the specified hierarchy bounds listener so that it no longer receives hierarchy bounds events from this component. void removeHierarchyListener(HierarchyListener l) Removes the specified hierarchy listener so that it no longer receives hierarchy changed events from this component. synchronized void removeInputMethodListener(InputMethodListener l) Removes the specified input method listener so that it no longer receives input method events from this component. synchronized void removeKeyListener(KeyListener l) Removes the specified key listener so that it no longer receives key events from this component. synchronized void removeMouseListener(MouseListener l) Removes the specified mouse listener so that it no longer receives mouse events from this component. synchronized void removeMouseMotionListener(MouseMotionListener l) Removes the specified mouse motion listener so that it no longer receives mouse motion events from this component. synchronized void removeMouseWheelListener(MouseWheelListener l) Removes the specified mouse wheel listener so that it no longer receives mouse wheel events from this component. void removeNotify() Makes this Component undisplayable by destroying it native screen resource. void removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Removes a PropertyChangeListener from the listener list for a specific property. void removePropertyChangeListener(PropertyChangeListener listener) Removes a PropertyChangeListener from the listener list. void repaint(int x, int y, int width, int height) Repaints the specified rectangle of this component. void repaint(long tm, int x, int y, int width, int height) Repaints the specified rectangle of this component within tm milliseconds. void repaint() Repaints this component. void repaint(long tm) Repaints the component. void requestFocus() Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window. boolean requestFocus(boolean temporary) Requests that this Component get the input focus, and that this Component's top-level ancestor become the focused Window. boolean requestFocusInWindow(boolean temporary) Requests that this Component get the input focus, if this Component's top-level ancestor is already the focused Window. boolean requestFocusInWindow() Requests that this Component get the input focus, if this Component's top-level ancestor is already the focused Window. void reshape(int x, int y, int width, int height) This method is deprecated. As of JDK version 1.1, replaced by setBounds(int, int, int, int). void resize(Dimension d) This method is deprecated. As of JDK version 1.1, replaced by setSize(Dimension). void resize(int width, int height) This method is deprecated. As of JDK version 1.1, replaced by setSize(int, int). void setBackground(Color c) Sets the background color of this component. void setBounds(int x, int y, int width, int height) Moves and resizes this component. void setBounds(Rectangle r) Moves and resizes this component to conform to the new bounding rectangle r. void setComponentOrientation(ComponentOrientation o) Sets the language-sensitive orientation that is to be used to order the elements or text within this component. void setCursor(Cursor cursor) Sets the cursor image to the specified cursor. synchronized void setDropTarget(DropTarget dt) Associate a DropTarget with this component. void setEnabled(boolean b) Enables or disables this component, depending on the value of the parameter b. void setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes) Sets the focus traversal keys for a given traversal operation for this Component. void setFocusTraversalKeysEnabled(boolean focusTraversalKeysEnabled) Sets whether focus traversal keys are enabled for this Component. void setFocusable(boolean focusable) Sets the focusable state of this Component to the specified value. void setFont(Font f) Sets the font of this component. void setForeground(Color c) Sets the foreground color of this component. void setIgnoreRepaint(boolean ignoreRepaint) Sets whether or not paint messages received from the operating system should be ignored. void setLocale(Locale l) Sets the locale of this component. void setLocation(int x, int y) Moves this component to a new location. void setLocation(Point p) Moves this component to a new location. void setMaximumSize(Dimension maximumSize) Sets the maximum size of this component to a constant value. void setMinimumSize(Dimension minimumSize) Sets the minimum size of this component to a constant value. void setName(String name) Sets the name of the component to the specified string. void setPreferredSize(Dimension preferredSize) Sets the preferred size of this component to a constant value. void setSize(int width, int height) Resizes this component so that it has width width and height height. void setSize(Dimension d) Resizes this component so that it has width d.width and height d.height. void setVisible(boolean b) Shows or hides this component depending on the value of parameter b. void show() This method is deprecated. As of JDK version 1.1, replaced by setVisible(boolean). void show(boolean b) This method is deprecated. As of JDK version 1.1, replaced by setVisible(boolean). Dimension size() This method is deprecated. As of JDK version 1.1, replaced by getSize(). String toString() Returns a string representation of this component and its values. void transferFocus() Transfers the focus to the next component, as though this Component were the focus owner. void transferFocusBackward() Transfers the focus to the previous component, as though this Component were the focus owner. void transferFocusUpCycle() Transfers the focus up one focus traversal cycle. void update(Graphics g) Updates this component. void validate() Ensures that this component has a valid layout.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait() Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object. final void wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes the current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed.
From interface java.awt.MenuContainer abstract Font getFont() abstract boolean postEvent(Event evt) This method is deprecated. As of JDK version 1.1 replaced by dispatchEvent(AWTEvent). abstract void remove(MenuComponent comp)
From interface java.awt.image.ImageObserver abstract boolean imageUpdate(Image img, int infoflags, int x, int y, int width, int height) This method is called when information about an image which was previously requested using an asynchronous interface becomes available.
From interface javax.accessibility.Accessible abstract AccessibleContext getAccessibleContext() Returns the AccessibleContext associated with this object.