public class

BasicOptionPaneUI

extends OptionPaneUI
java.lang.Object
   ↳ javax.swing.plaf.ComponentUI
     ↳ javax.swing.plaf.OptionPaneUI
       ↳ javax.swing.plaf.basic.BasicOptionPaneUI
Known Direct Subclasses

Class Overview

Provides the basic look and feel for a JOptionPane. BasicMessagePaneUI provides a means to place an icon, message and buttons into a Container. Generally, the layout will look like:

        ------------------
        | i | message    |
        | c | message    |
        | o | message    |
        | n | message    |
        ------------------
        |     buttons    |
        |________________|
icon is an instance of Icon that is wrapped inside a JLabel. The message is an opaque object and is tested for the following: if the message is a Component it is added to the Container, if it is an Icon it is wrapped inside a JLabel and added to the Container otherwise it is wrapped inside a JLabel.

The above layout is used when the option pane's ComponentOrientation property is horizontal, left-to-right. The layout will be adjusted appropriately for other orientations.

The Container, message, icon, and buttons are all determined from abstract methods.

Summary

Nested Classes
class BasicOptionPaneUI.ButtonActionListener This inner class is marked "public" due to a compiler bug. 
class BasicOptionPaneUI.ButtonAreaLayout ButtonAreaLayout behaves in a similar manner to FlowLayout. 
class BasicOptionPaneUI.PropertyChangeHandler This inner class is marked "public" due to a compiler bug. 
Constants
int MinimumHeight
int MinimumWidth
Fields
protected boolean hasCustomComponents This is set to true in validateComponent if a Component is contained in either the message or the buttons.
protected Component initialFocusComponent Component to receive focus when messaged with selectInitialValue.
protected JComponent inputComponent JComponent provide for input if optionPane.getWantsInput() returns true.
protected Dimension minimumSize
protected JOptionPane optionPane JOptionPane that the receiver is providing the look and feel for.
protected PropertyChangeListener propertyChangeListener
Public Constructors
BasicOptionPaneUI()
Public Methods
boolean containsCustomComponents(JOptionPane op)
Returns true if in the last call to validateComponent the message or buttons contained a subclass of Component.
static ComponentUI createUI(JComponent x)
Creates a new BasicOptionPaneUI instance.
Dimension getMinimumOptionPaneSize()
Returns the minimum size the option pane should be.
Dimension getPreferredSize(JComponent c)
If c is the JOptionPane the receiver is contained in, the preferred size that is returned is the maximum of the preferred size of the LayoutManager for the JOptionPane, and getMinimumOptionPaneSize.
void installUI(JComponent c)
Installs the receiver as the L&F for the passed in JOptionPane.
void selectInitialValue(JOptionPane op)
If inputComponent is non-null, the focus is requested on that, otherwise request focus on the default value
void uninstallUI(JComponent c)
Removes the receiver from the L&F controller of the passed in split pane.
Protected Methods
void addButtonComponents(Container container, Object[] buttons, int initialIndex)
Creates the appropriate object to represent each of the objects in buttons and adds it to container.
void addIcon(Container top)
Creates and adds a JLabel representing the icon returned from getIcon to top.
void addMessageComponents(Container container, GridBagConstraints cons, Object msg, int maxll, boolean internallyCreated)
Creates the appropriate object to represent msg and places it into container.
void burstStringInto(Container c, String d, int maxll)
Recursively creates new JLabel instances to represent d.
ActionListener createButtonActionListener(int buttonIndex)
Container createButtonArea()
Creates and returns a Container containing the buttons.
LayoutManager createLayoutManager()
Container createMessageArea()
Messaged from installComponents to create a Container containing the body of the message.
PropertyChangeListener createPropertyChangeListener()
Container createSeparator()
Object[] getButtons()
Returns the buttons to display from the JOptionPane the receiver is providing the look and feel for.
Icon getIcon()
Returns the icon from the JOptionPane the receiver is providing the look and feel for, or the default icon as returned from getDefaultIcon.
Icon getIconForType(int messageType)
Returns the icon to use for the passed in type.
int getInitialValueIndex()
Returns the initial index into the buttons to select.
int getMaxCharactersPerLineCount()
Returns the maximum number of characters to place on a line.
Object getMessage()
Returns the message to display from the JOptionPane the receiver is providing the look and feel for.
boolean getSizeButtonsToSameWidth()
Returns true, basic L&F wants all the buttons to have the same width.
void installComponents()
void installDefaults()
void installKeyboardActions()
void installListeners()
void resetInputValue()
Sets the input value in the option pane the receiver is providing the look and feel for based on the value in the inputComponent.
void uninstallComponents()
void uninstallDefaults()
void uninstallKeyboardActions()
void uninstallListeners()
[Expand]
Inherited Methods
From class javax.swing.plaf.OptionPaneUI
From class javax.swing.plaf.ComponentUI
From class java.lang.Object

Constants

public static final int MinimumHeight

Constant Value: 90 (0x0000005a)

public static final int MinimumWidth

Constant Value: 262 (0x00000106)

Fields

protected boolean hasCustomComponents

This is set to true in validateComponent if a Component is contained in either the message or the buttons.

protected Component initialFocusComponent

Component to receive focus when messaged with selectInitialValue.

protected JComponent inputComponent

JComponent provide for input if optionPane.getWantsInput() returns true.

protected Dimension minimumSize

protected JOptionPane optionPane

JOptionPane that the receiver is providing the look and feel for.

protected PropertyChangeListener propertyChangeListener

Public Constructors

public BasicOptionPaneUI ()

Public Methods

public boolean containsCustomComponents (JOptionPane op)

Returns true if in the last call to validateComponent the message or buttons contained a subclass of Component.

public static ComponentUI createUI (JComponent x)

Creates a new BasicOptionPaneUI instance.

public Dimension getMinimumOptionPaneSize ()

Returns the minimum size the option pane should be. Primarily provided for subclassers wishing to offer a different minimum size.

public Dimension getPreferredSize (JComponent c)

If c is the JOptionPane the receiver is contained in, the preferred size that is returned is the maximum of the preferred size of the LayoutManager for the JOptionPane, and getMinimumOptionPaneSize.

Parameters
c the component whose preferred size is being queried; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components

public void installUI (JComponent c)

Installs the receiver as the L&F for the passed in JOptionPane.

Parameters
c the component where this UI delegate is being installed

public void selectInitialValue (JOptionPane op)

If inputComponent is non-null, the focus is requested on that, otherwise request focus on the default value

public void uninstallUI (JComponent c)

Removes the receiver from the L&F controller of the passed in split pane.

Parameters
c the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components

Protected Methods

protected void addButtonComponents (Container container, Object[] buttons, int initialIndex)

Creates the appropriate object to represent each of the objects in buttons and adds it to container. This differs from addMessageComponents in that it will recurse on buttons and that if button is not a Component it will create an instance of JButton.

protected void addIcon (Container top)

Creates and adds a JLabel representing the icon returned from getIcon to top. This is messaged from createMessageArea

protected void addMessageComponents (Container container, GridBagConstraints cons, Object msg, int maxll, boolean internallyCreated)

Creates the appropriate object to represent msg and places it into container. If msg is an instance of Component, it is added directly, if it is an Icon, a JLabel is created to represent it, otherwise a JLabel is created for the string, if d is an Object[], this method will be recursively invoked for the children. internallyCreated is true if Objc is an instance of Component and was created internally by this method (this is used to correctly set hasCustomComponents only if !internallyCreated).

protected void burstStringInto (Container c, String d, int maxll)

Recursively creates new JLabel instances to represent d. Each JLabel instance is added to c.

protected ActionListener createButtonActionListener (int buttonIndex)

protected Container createButtonArea ()

Creates and returns a Container containing the buttons. The buttons are created by calling getButtons.

protected LayoutManager createLayoutManager ()

protected Container createMessageArea ()

Messaged from installComponents to create a Container containing the body of the message. The icon is the created by calling addIcon.

protected PropertyChangeListener createPropertyChangeListener ()

protected Container createSeparator ()

protected Object[] getButtons ()

Returns the buttons to display from the JOptionPane the receiver is providing the look and feel for. If the JOptionPane has options set, they will be provided, otherwise if the optionType is YES_NO_OPTION, yesNoOptions is returned, if the type is YES_NO_CANCEL_OPTION yesNoCancelOptions is returned, otherwise defaultButtons are returned.

protected Icon getIcon ()

Returns the icon from the JOptionPane the receiver is providing the look and feel for, or the default icon as returned from getDefaultIcon.

protected Icon getIconForType (int messageType)

Returns the icon to use for the passed in type.

protected int getInitialValueIndex ()

Returns the initial index into the buttons to select. The index is calculated from the initial value from the JOptionPane and options of the JOptionPane or 0.

protected int getMaxCharactersPerLineCount ()

Returns the maximum number of characters to place on a line.

protected Object getMessage ()

Returns the message to display from the JOptionPane the receiver is providing the look and feel for.

protected boolean getSizeButtonsToSameWidth ()

Returns true, basic L&F wants all the buttons to have the same width.

protected void installComponents ()

protected void installDefaults ()

protected void installKeyboardActions ()

protected void installListeners ()

protected void resetInputValue ()

Sets the input value in the option pane the receiver is providing the look and feel for based on the value in the inputComponent.

protected void uninstallComponents ()

protected void uninstallDefaults ()

protected void uninstallKeyboardActions ()

protected void uninstallListeners ()