javax.swing.plaf.basic
Class BasicMenuItemUI

java.lang.Object
  javax.swing.plaf.ComponentUI
      javax.swing.plaf.ButtonUI
          javax.swing.plaf.MenuItemUI
              javax.swing.plaf.basic.BasicMenuItemUI

Direct Known Subclasses:

BasicCheckBoxMenuItemUI, BasicMenuUI, BasicRadioButtonMenuItemUI

public class BasicMenuItemUI

extends MenuItemUI

BasicMenuItem implementation

Author:

Georges Saab, David Karlton, Arnaud Weber, Fredrik Lagerblad

Nested Class Summary

private static class	BasicMenuItemUI.ClickAction
private class	BasicMenuItemUI.MenuDragMouseHandler
private class	BasicMenuItemUI.MenuKeyHandler
protected class	BasicMenuItemUI.MouseInputHandler
private class	BasicMenuItemUI.PropertyChangeHandler

Field Summary

private String	acceleratorDelimiter
protected Font	acceleratorFont
protected Color	acceleratorForeground
(package private) static Rectangle	acceleratorRect
protected Color	acceleratorSelectionForeground
protected Icon	arrowIcon
(package private) static Rectangle	arrowIconRect
protected Icon	checkIcon
(package private) static Rectangle	checkIconRect
private static boolean	DEBUG
protected int	defaultTextIconGap
protected Color	disabledForeground
(package private) static Rectangle	iconRect
(package private) static String	MAX_ACC_WIDTH
(package private) static String	MAX_TEXT_WIDTH
protected MenuDragMouseListener	menuDragMouseListener
protected JMenuItem	menuItem
protected MenuKeyListener	menuKeyListener
protected MouseInputListener	mouseInputListener
protected boolean	oldBorderPainted
private java.beans.PropertyChangeListener	propertyChangeListener
(package private) static Rectangle	r
protected Color	selectionBackground
protected Color	selectionForeground
(package private) static Rectangle	textRect
private static boolean	TRACE
private static boolean	VERBOSE
(package private) static Rectangle	viewRect
(package private) InputMap	windowInputMap Used for accelerator binding, lazily created.
(package private) static Rectangle	zeroRect

Constructor Summary

BasicMenuItemUI()

Method Summary

(package private) ActionMap	createActionMap()
(package private) InputMap	createInputMap(int condition)
protected MenuDragMouseListener	createMenuDragMouseListener(JComponent c)
protected MenuKeyListener	createMenuKeyListener(JComponent c)
protected MouseInputListener	createMouseInputListener(JComponent c)
private java.beans.PropertyChangeListener	createPropertyChangeListener(JComponent c)
static ComponentUI	createUI(JComponent c) Returns an instance of the UI delegate for the specified component.
protected void	doClick(MenuSelectionManager msm) Call this method when a menu item is to be activated.
(package private) ActionMap	getActionMap()
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.
MenuElement[]	getPath()
protected Dimension	getPreferredMenuItemSize(JComponent c, Icon checkIcon, Icon arrowIcon, int defaultTextIconGap)
Dimension	getPreferredSize(JComponent c) Returns the specified component's preferred size appropriate for the look and feel.
protected String	getPropertyPrefix()
protected void	installComponents(JMenuItem menuItem)
protected void	installDefaults()
protected void	installKeyboardActions()
protected void	installListeners()
void	installUI(JComponent c) Configures the specified component appropriate for the look and feel.
private boolean	isInternalFrameSystemMenu() This is to see if the menu item in question is part of the system menu on an internal frame.
private String	layoutMenuItem(FontMetrics fm, String text, FontMetrics fmAccel, String acceleratorText, Icon icon, Icon checkIcon, Icon arrowIcon, int verticalAlignment, int horizontalAlignment, int verticalTextPosition, int horizontalTextPosition, Rectangle viewRect, Rectangle iconRect, Rectangle textRect, Rectangle acceleratorRect, Rectangle checkIconRect, Rectangle arrowIconRect, int textIconGap, int menuItemGap) Compute and return the location of the icons origin, the location of origin of the text baseline, and a possibly clipped version of the compound labels string.
void	paint(Graphics g, JComponent c) Paints the specified component appropriate for the look and feel.
protected void	paintBackground(Graphics g, JMenuItem menuItem, Color bgColor) Draws the background of the menu item.
protected void	paintMenuItem(Graphics g, JComponent c, Icon checkIcon, Icon arrowIcon, Color background, Color foreground, int defaultTextIconGap)
protected void	paintText(Graphics g, JMenuItem menuItem, Rectangle textRect, String text) Renders the text of the current menu item.
(package private) void	printMenuElementArray(MenuElement[] path, boolean dumpStack)
private void	resetRects()
protected void	uninstallComponents(JMenuItem menuItem)
protected void	uninstallDefaults()
protected void	uninstallKeyboardActions()
protected void	uninstallListeners()
void	uninstallUI(JComponent c) Reverses configuration which was done on the specified component during installUI.
void	update(Graphics g, JComponent c) We draw the background in paintMenuItem() so override update (which fills the background of opaque components by default) to just call paint().
(package private) void	updateAcceleratorBinding()
private boolean	useCheckAndArrow()

Methods inherited from class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount

Methods inherited from class java.lang.Object

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

Field Detail

menuItem

protected JMenuItem menuItem

selectionBackground

protected Color selectionBackground

selectionForeground

protected Color selectionForeground

disabledForeground

protected Color disabledForeground

acceleratorForeground

protected Color acceleratorForeground

acceleratorSelectionForeground

protected Color acceleratorSelectionForeground

acceleratorDelimiter

private String acceleratorDelimiter

defaultTextIconGap

protected int defaultTextIconGap

acceleratorFont

protected Font acceleratorFont

mouseInputListener

protected MouseInputListener mouseInputListener

menuDragMouseListener

protected MenuDragMouseListener menuDragMouseListener

menuKeyListener

protected MenuKeyListener menuKeyListener

propertyChangeListener

private java.beans.PropertyChangeListener propertyChangeListener

arrowIcon

protected Icon arrowIcon

checkIcon

protected Icon checkIcon

oldBorderPainted

protected boolean oldBorderPainted

windowInputMap

InputMap windowInputMap

Used for accelerator binding, lazily created.

TRACE

private static final boolean TRACE

See Also:

Constant Field Values

VERBOSE

private static final boolean VERBOSE

See Also:

Constant Field Values

DEBUG

private static final boolean DEBUG

See Also:

Constant Field Values

MAX_TEXT_WIDTH

static final String MAX_TEXT_WIDTH

See Also:

Constant Field Values

MAX_ACC_WIDTH

static final String MAX_ACC_WIDTH

See Also:

Constant Field Values

zeroRect

static Rectangle zeroRect

iconRect

static Rectangle iconRect

textRect

static Rectangle textRect

acceleratorRect

static Rectangle acceleratorRect

checkIconRect

static Rectangle checkIconRect

arrowIconRect

static Rectangle arrowIconRect

viewRect

static Rectangle viewRect

r

static Rectangle r

Constructor Detail

BasicMenuItemUI

public BasicMenuItemUI()

Method Detail

createUI

public static ComponentUI createUI(JComponent c)

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

protected void installDefaults()

installComponents

protected void installComponents(JMenuItem menuItem)

Since:

1.3

getPropertyPrefix

protected String getPropertyPrefix()

installListeners

protected void installListeners()

installKeyboardActions

protected void installKeyboardActions()

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

uninstallComponents

protected void uninstallComponents(JMenuItem menuItem)

Since:

1.3

uninstallListeners

protected void uninstallListeners()

uninstallKeyboardActions

protected void uninstallKeyboardActions()

createMouseInputListener

protected MouseInputListener createMouseInputListener(JComponent c)

createMenuDragMouseListener

protected MenuDragMouseListener createMenuDragMouseListener(JComponent c)

createMenuKeyListener

protected MenuKeyListener createMenuKeyListener(JComponent c)

createPropertyChangeListener

private java.beans.PropertyChangeListener createPropertyChangeListener(JComponent c)

getActionMap

ActionMap getActionMap()

createActionMap

ActionMap createActionMap()

createInputMap

InputMap createInputMap(int condition)

updateAcceleratorBinding

void updateAcceleratorBinding()

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)

resetRects

private void resetRects()

getPreferredMenuItemSize

protected Dimension getPreferredMenuItemSize(JComponent c,
                                             Icon checkIcon,
                                             Icon arrowIcon,
                                             int defaultTextIconGap)

update

public void update(Graphics g,
                   JComponent c)

We draw the background in paintMenuItem() so override update (which fills the background of opaque components by default) to just call paint().

Overrides:

update in class ComponentUI

Parameters:

g - the Graphics context in which to paint

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

See Also:

ComponentUI.paint(java.awt.Graphics, javax.swing.JComponent), JComponent.paintComponent(java.awt.Graphics)

paint

public void paint(Graphics g,
                  JComponent c)

Description copied from class: ComponentUI

Paints the specified component appropriate for the look and feel. This method is invoked from the ComponentUI.update method when the specified component is being painted. Subclasses should override this method and use the specified Graphics object to render the content of the component.

Overrides:

paint in class ComponentUI

Parameters:

g - the Graphics context in which to paint

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

See Also:

ComponentUI.update(java.awt.Graphics, javax.swing.JComponent)

paintMenuItem

protected void paintMenuItem(Graphics g,
                             JComponent c,
                             Icon checkIcon,
                             Icon arrowIcon,
                             Color background,
                             Color foreground,
                             int defaultTextIconGap)

paintBackground

protected void paintBackground(Graphics g,
                               JMenuItem menuItem,
                               Color bgColor)

Draws the background of the menu item.

Parameters:

g - the paint graphics

menuItem - menu item to be painted

bgColor - selection background color

Since:

1.4

paintText

protected void paintText(Graphics g,
                         JMenuItem menuItem,
                         Rectangle textRect,
                         String text)

Renders the text of the current menu item.

Parameters:

g - graphics context

menuItem - menu item to render

textRect - bounding rectangle for rendering the text

text - string to render

Since:

1.4

layoutMenuItem

private String layoutMenuItem(FontMetrics fm,
                              String text,
                              FontMetrics fmAccel,
                              String acceleratorText,
                              Icon icon,
                              Icon checkIcon,
                              Icon arrowIcon,
                              int verticalAlignment,
                              int horizontalAlignment,
                              int verticalTextPosition,
                              int horizontalTextPosition,
                              Rectangle viewRect,
                              Rectangle iconRect,
                              Rectangle textRect,
                              Rectangle acceleratorRect,
                              Rectangle checkIconRect,
                              Rectangle arrowIconRect,
                              int textIconGap,
                              int menuItemGap)

Compute and return the location of the icons origin, the location of origin of the text baseline, and a possibly clipped version of the compound labels string. Locations are computed relative to the viewRect rectangle.

useCheckAndArrow

private boolean useCheckAndArrow()

getPath

public MenuElement[] getPath()

printMenuElementArray

void printMenuElementArray(MenuElement[] path,
                           boolean dumpStack)

doClick

protected void doClick(MenuSelectionManager msm)

Call this method when a menu item is to be activated. This method handles some of the details of menu item activation such as clearing the selected path and messaging the JMenuItem's doClick() method.

Parameters:

msm - A MenuSelectionManager. The visual feedback and internal bookkeeping tasks are delegated to this MenuSelectionManager. If null is passed as this argument, the MenuSelectionManager.defaultManager is used.

Since:

1.4

See Also:

MenuSelectionManager, AbstractButton.doClick(int)

isInternalFrameSystemMenu

private boolean isInternalFrameSystemMenu()

This is to see if the menu item in question is part of the system menu on an internal frame. The Strings that are being checked can be found in MetalInternalFrameTitlePaneUI.java, WindowsInternalFrameTitlePaneUI.java, and MotifInternalFrameTitlePaneUI.java.

Since:

1.4