javax.swing.plaf.basic
Class BasicPopupMenuUI

java.lang.Object
  javax.swing.plaf.ComponentUI
      javax.swing.plaf.PopupMenuUI
          javax.swing.plaf.basic.BasicPopupMenuUI

public class BasicPopupMenuUI

extends PopupMenuUI

A Windows L&F implementation of PopupMenuUI. This implementation is a "combined" view/controller.

Author:

Georges Saab, David Karlton, Arnaud Weber

Nested Class Summary

private class	BasicPopupMenuUI.BasicPopupMenuListener This Listener fires the Action that provides the correct auditory feedback.
private static class	BasicPopupMenuUI.CancelAction
private static class	BasicPopupMenuUI.MenuKeyboardHelper This helper is added to MenuSelectionManager as a ChangeListener to listen to menu selection changes.
private static class	BasicPopupMenuUI.MouseGrabber
private static class	BasicPopupMenuUI.ReturnAction
private static class	BasicPopupMenuUI.SelectNextItemAction
private static class	BasicPopupMenuUI.SelectParentChildAction

Field Summary

private PopupMenuListener	basicPopupMenuListener
(package private) static BasicPopupMenuUI.MenuKeyboardHelper	menuKeyboardHelper
(package private) static boolean	menuKeyboardHelperInstalled
private static BasicPopupMenuUI.MouseGrabber	mouseGrabber
protected JPopupMenu	popupMenu

Constructor Summary

BasicPopupMenuUI()

Method Summary

private static boolean	checkInvokerEqual(MenuElement present, MenuElement last)
(package private) static ActionMap	createActionMap()
private PopupMenuListener	createPopupMenuListener()
static ComponentUI	createUI(JComponent x) Returns an instance of the UI delegate for the specified component.
private static MenuElement	findEnabledChild(MenuElement[] e, int fromIndex, boolean forward)
private static MenuElement	findEnabledChild(MenuElement[] e, MenuElement elem, boolean forward)
(package private) static ActionMap	getActionMap()
private static MenuElement	getFirstPopup()
(package private) static InputMap	getInputMap(JPopupMenu popup, JComponent c)
private static JPopupMenu	getLastPopup()
Dimension	getMaximumSize(JComponent c) Returns the specified component's maximum size appropriate for the look and feel.
Dimension	getMinimumSize(JComponent c) Returns the specified component's minimum size appropriate for the look and feel.
private static List	getPopups()
Dimension	getPreferredSize(JComponent c) Returns the specified component's preferred size appropriate for the look and feel.
private static Window	getWindow(Component c)
void	installDefaults()
protected void	installKeyboardActions()
protected void	installListeners()
void	installUI(JComponent c) Configures the specified component appropriate for the look and feel.
boolean	isPopupTrigger(MouseEvent e)
private static MenuElement	nextEnabledChild(MenuElement[] e, int fromIndex, int toIndex)
private static MenuElement	previousEnabledChild(MenuElement[] e, int fromIndex, int toIndex)
protected void	uninstallDefaults()
protected void	uninstallKeyboardActions()
protected void	uninstallListeners()
void	uninstallUI(JComponent c) Reverses configuration which was done on the specified component during installUI.

Methods inherited from class javax.swing.plaf.PopupMenuUI

getPopup

Methods inherited from class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, paint, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

popupMenu

protected JPopupMenu popupMenu

menuKeyboardHelperInstalled

static boolean menuKeyboardHelperInstalled

menuKeyboardHelper

static BasicPopupMenuUI.MenuKeyboardHelper menuKeyboardHelper

mouseGrabber

private static transient BasicPopupMenuUI.MouseGrabber mouseGrabber

basicPopupMenuListener

private transient PopupMenuListener basicPopupMenuListener

Constructor Detail

BasicPopupMenuUI

public BasicPopupMenuUI()

Method Detail

checkInvokerEqual

private static boolean checkInvokerEqual(MenuElement present,
                                         MenuElement last)

createUI

public static ComponentUI createUI(JComponent x)

Description copied from class: ComponentUI

Returns an instance of the UI delegate for the specified component. Each subclass must provide its own static createUI method that returns an instance of that UI delegate subclass. If the UI delegate subclass is stateless, it may return an instance that is shared by multiple components. If the UI delegate is stateful, then it should return a new instance per component. The default implementation of this method throws an error, as it should never be invoked.

installUI

public void installUI(JComponent c)

Description copied from class: ComponentUI

Configures the specified component appropriate for the look and feel. This method is invoked when the ComponentUI instance is being installed as the UI delegate on the specified component. This method should completely configure the component for the look and feel, including the following:

1. Install any default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should not be overridden.
2. Install a LayoutManager on the component if necessary.
3. Create/add any required sub-components to the component.
4. Create/install event listeners on the component.
5. Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately.
6. Install keyboard UI (mnemonics, traversal, etc.) on the component.
7. Initialize any appropriate instance data.

Overrides:

installUI in class ComponentUI

Parameters:

c - the component where this UI delegate is being installed

See Also:

ComponentUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

installDefaults

public void installDefaults()

installListeners

protected void installListeners()

installKeyboardActions

protected void installKeyboardActions()

getInputMap

static InputMap getInputMap(JPopupMenu popup,
                            JComponent c)

getActionMap

static ActionMap getActionMap()

createActionMap

static ActionMap createActionMap()

uninstallUI

public void uninstallUI(JComponent c)

Description copied from class: ComponentUI

Reverses configuration which was done on the specified component during installUI. This method is invoked when this UIComponent instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed in installUI, being careful to leave the JComponent instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:

1. Remove any UI-set borders from the component.
2. Remove any UI-set layout managers on the component.
3. Remove any UI-added sub-components from the component.
4. Remove any UI-added event/property listeners from the component.
5. Remove any UI-installed keyboard UI from the component.
6. Nullify any allocated instance data objects to allow for GC.

Overrides:

uninstallUI in class ComponentUI

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

See Also:

ComponentUI.installUI(javax.swing.JComponent), JComponent.updateUI()

uninstallDefaults

protected void uninstallDefaults()

uninstallListeners

protected void uninstallListeners()

uninstallKeyboardActions

protected void uninstallKeyboardActions()

getMinimumSize

public Dimension getMinimumSize(JComponent c)

Description copied from class: ComponentUI

Returns the specified component's minimum size appropriate for the look and feel. If null is returned, the minimum size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method invokes getPreferredSize and returns that value.

Overrides:

getMinimumSize in class ComponentUI

Parameters:

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

Returns:

a Dimension object or null

See Also:

JComponent.getMinimumSize(), LayoutManager.minimumLayoutSize(java.awt.Container), ComponentUI.getPreferredSize(javax.swing.JComponent)

getPreferredSize

public Dimension getPreferredSize(JComponent c)

Description copied from class: ComponentUI

Returns the specified component's preferred size appropriate for the look and feel. If null is returned, the preferred size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method returns null.

Overrides:

getPreferredSize in class ComponentUI

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

See Also:

JComponent.getPreferredSize(), LayoutManager.preferredLayoutSize(java.awt.Container)

getMaximumSize

public Dimension getMaximumSize(JComponent c)

Description copied from class: ComponentUI

Returns the specified component's maximum size appropriate for the look and feel. If null is returned, the maximum size will be calculated by the component's layout manager instead (this is the preferred approach for any component with a specific layout manager installed). The default implementation of this method invokes getPreferredSize and returns that value.

Overrides:

getMaximumSize in class ComponentUI

Parameters:

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

Returns:

a Dimension object or null

See Also:

JComponent.getMaximumSize(), LayoutManager2.maximumLayoutSize(java.awt.Container)

getWindow

private static Window getWindow(Component c)

getFirstPopup

private static MenuElement getFirstPopup()

getLastPopup

private static JPopupMenu getLastPopup()

getPopups

private static List getPopups()

isPopupTrigger

public boolean isPopupTrigger(MouseEvent e)

Overrides:

isPopupTrigger in class PopupMenuUI

createPopupMenuListener

private PopupMenuListener createPopupMenuListener()

nextEnabledChild

private static MenuElement nextEnabledChild(MenuElement[] e,
                                            int fromIndex,
                                            int toIndex)

previousEnabledChild

private static MenuElement previousEnabledChild(MenuElement[] e,
                                                int fromIndex,
                                                int toIndex)

findEnabledChild

private static MenuElement findEnabledChild(MenuElement[] e,
                                            int fromIndex,
                                            boolean forward)

findEnabledChild

private static MenuElement findEnabledChild(MenuElement[] e,
                                            MenuElement elem,
                                            boolean forward)