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 javax.swing.plaf.MenuItemUI

UI Delegate for JMenuItem.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BasicMenuItemUI.MouseInputHandler This class handles mouse events occuring inside the menu item.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Font	acceleratorFont Font to be used when displaying menu item's accelerator.
protected java.awt.Color	acceleratorForeground Color to be used when displaying menu item's accelerator.
protected java.awt.Color	acceleratorSelectionForeground Color to be used when displaying menu item's accelerator when menu item is selected.
protected javax.swing.Icon	arrowIcon Icon that is displayed after the text to indicated that this menu contains submenu.
protected javax.swing.Icon	checkIcon Icon that is displayed before the text.
protected int	defaultTextIconGap Number of spaces between icon and text.
protected java.awt.Color	disabledForeground Color of the text when menu item is disabled
protected javax.swing.event.MenuDragMouseListener	menuDragMouseListener The menu Drag mouse listener listening to the menu item.
protected javax.swing.JMenuItem	menuItem The menu item itself
protected javax.swing.event.MenuKeyListener	menuKeyListener Menu Key listener listening to the menu item.
protected javax.swing.event.MouseInputListener	mouseInputListener mouse input listener listening to menu item.
protected boolean	oldBorderPainted Indicates if border should be painted
protected java.awt.Color	selectionBackground Color of text that is used when menu item is selected
protected java.awt.Color	selectionForeground Color of the text that is used when menu item is selected.

Constructor Summary

Constructors

Constructor and Description
BasicMenuItemUI() Creates a new BasicMenuItemUI object.

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.swing.event.MenuDragMouseListener	createMenuDragMouseListener(javax.swing.JComponent c) Create MenuDragMouseListener to listen for mouse dragged events.
protected javax.swing.event.MenuKeyListener	createMenuKeyListener(javax.swing.JComponent c) Creates MenuKeyListener to listen to key events occuring when menu item is visible on the screen.
protected javax.swing.event.MouseInputListener	createMouseInputListener(javax.swing.JComponent c) Handles mouse input events occuring for this menu item
static javax.swing.plaf.ComponentUI	createUI(javax.swing.JComponent c) Factory method to create a BasicMenuItemUI for the given JComponent, which should be a JMenuItem.
protected void	doClick(javax.swing.MenuSelectionManager msm) Programatically clicks menu item.
java.awt.Dimension	getMaximumSize(javax.swing.JComponent c) Returns maximum size for the specified menu item
java.awt.Dimension	getMinimumSize(javax.swing.JComponent c) Returns minimum size for the specified menu item
javax.swing.MenuElement[]	getPath() Returns path to this menu item.
protected java.awt.Dimension	getPreferredMenuItemSize(javax.swing.JComponent c, javax.swing.Icon checkIcon, javax.swing.Icon arrowIcon, int defaultTextIconGap) Returns preferred size for the given menu item.
java.awt.Dimension	getPreferredSize(javax.swing.JComponent c) Returns preferred size of the given component
protected java.lang.String	getPropertyPrefix() Returns the prefix for entries in the UIDefaults table.
protected void	installComponents(javax.swing.JMenuItem menuItem) This method installs the components for this JMenuItem.
protected void	installDefaults() This method installs the defaults that are defined in the Basic look and feel for this JMenuItem.
protected void	installKeyboardActions() This method installs the keyboard actions for this JMenuItem.
protected void	installListeners() This method installs the listeners for the JMenuItem.
void	installUI(javax.swing.JComponent c) Installs and initializes all fields for this UI delegate.
void	paint(java.awt.Graphics g, javax.swing.JComponent c) Paints given menu item using specified graphics context
protected void	paintBackground(java.awt.Graphics g, javax.swing.JMenuItem menuItem, java.awt.Color bgColor) Paints background of the menu item
protected void	paintMenuItem(java.awt.Graphics g, javax.swing.JComponent c, javax.swing.Icon checkIcon, javax.swing.Icon arrowIcon, java.awt.Color background, java.awt.Color foreground, int defaultTextIconGap) Paints specified menu item
protected void	paintText(java.awt.Graphics g, javax.swing.JMenuItem menuItem, java.awt.Rectangle textRect, java.lang.String text) Paints label for the given menu item
protected void	uninstallComponents(javax.swing.JMenuItem menuItem) This method uninstalls the components for this JMenuItem.
protected void	uninstallDefaults() This method uninstalls the defaults and sets any objects created during install to null
protected void	uninstallKeyboardActions() Uninstalls any keyboard actions.
protected void	uninstallListeners() Unregisters all the listeners that this UI delegate was using.
void	uninstallUI(javax.swing.JComponent c) Performs the opposite of installUI.
void	update(java.awt.Graphics g, javax.swing.JComponent c) This method calls paint.

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

acceleratorFont

protected java.awt.Font acceleratorFont

Font to be used when displaying menu item's accelerator.

acceleratorForeground

protected java.awt.Color acceleratorForeground

Color to be used when displaying menu item's accelerator.

acceleratorSelectionForeground

protected java.awt.Color acceleratorSelectionForeground

Color to be used when displaying menu item's accelerator when menu item is selected.

arrowIcon

protected javax.swing.Icon arrowIcon

Icon that is displayed after the text to indicated that this menu contains submenu.

checkIcon

protected javax.swing.Icon checkIcon

Icon that is displayed before the text. This icon is only used in JCheckBoxMenuItem or JRadioBoxMenuItem.

defaultTextIconGap

protected int defaultTextIconGap

Number of spaces between icon and text.

disabledForeground

protected java.awt.Color disabledForeground

Color of the text when menu item is disabled

menuDragMouseListener

protected javax.swing.event.MenuDragMouseListener menuDragMouseListener

The menu Drag mouse listener listening to the menu item.

menuItem

protected javax.swing.JMenuItem menuItem

The menu item itself

menuKeyListener

protected javax.swing.event.MenuKeyListener menuKeyListener

Menu Key listener listening to the menu item.

mouseInputListener

protected javax.swing.event.MouseInputListener mouseInputListener

mouse input listener listening to menu item.

oldBorderPainted

protected boolean oldBorderPainted

Indicates if border should be painted

selectionBackground

protected java.awt.Color selectionBackground

Color of text that is used when menu item is selected

selectionForeground

protected java.awt.Color selectionForeground

Color of the text that is used when menu item is selected.

Constructor Detail

BasicMenuItemUI

public BasicMenuItemUI()

Creates a new BasicMenuItemUI object.

Method Detail

createMenuDragMouseListener

protected javax.swing.event.MenuDragMouseListener createMenuDragMouseListener(javax.swing.JComponent c)

Create MenuDragMouseListener to listen for mouse dragged events.

Parameters:

c - menu item to listen to

Returns:

The MenuDragMouseListener

createMenuKeyListener

protected javax.swing.event.MenuKeyListener createMenuKeyListener(javax.swing.JComponent c)

Creates MenuKeyListener to listen to key events occuring when menu item is visible on the screen.

Parameters:

c - menu item to listen to

Returns:

The MenuKeyListener

createMouseInputListener

protected javax.swing.event.MouseInputListener createMouseInputListener(javax.swing.JComponent c)

Handles mouse input events occuring for this menu item

Parameters:

c - menu item to listen to

Returns:

The MouseInputListener

createUI

public static javax.swing.plaf.ComponentUI createUI(javax.swing.JComponent c)

Factory method to create a BasicMenuItemUI for the given JComponent, which should be a JMenuItem.

Parameters:

c - The JComponent a UI is being created for.

Returns:

A BasicMenuItemUI for the JComponent.

doClick

protected void doClick(javax.swing.MenuSelectionManager msm)

Programatically clicks menu item.

Parameters:

msm - MenuSelectionManager for the menu hierarchy

getMaximumSize

public java.awt.Dimension getMaximumSize(javax.swing.JComponent c)

Returns maximum size for the specified menu item

Overrides:

getMaximumSize in class javax.swing.plaf.ComponentUI

Parameters:

c - component for which to get maximum size

Returns:

Maximum size for the specified menu item.

getMinimumSize

public java.awt.Dimension getMinimumSize(javax.swing.JComponent c)

Returns minimum size for the specified menu item

Overrides:

getMinimumSize in class javax.swing.plaf.ComponentUI

Parameters:

c - component for which to get minimum size

Returns:

Minimum size for the specified menu item.

getPath

public javax.swing.MenuElement[] getPath()

Returns path to this menu item.

Returns:

$MenuElement[]$ Returns array of menu elements that constitute a path to this menu item.

getPreferredMenuItemSize

protected java.awt.Dimension getPreferredMenuItemSize(javax.swing.JComponent c,
                                          javax.swing.Icon checkIcon,
                                          javax.swing.Icon arrowIcon,
                                          int defaultTextIconGap)

Returns preferred size for the given menu item.

Parameters:

c - menu item for which to get preferred size

checkIcon - check icon displayed in the given menu item

arrowIcon - arrow icon displayed in the given menu item

defaultTextIconGap - space between icon and text in the given menuItem

Returns:

$Dimension$ preferred size for the given menu item

getPreferredSize

public java.awt.Dimension getPreferredSize(javax.swing.JComponent c)

Returns preferred size of the given component

Overrides:

getPreferredSize in class javax.swing.plaf.ComponentUI

Parameters:

c - component for which to return preferred size

Returns:

$Dimension$ preferred size for the given component

getPropertyPrefix

protected java.lang.String getPropertyPrefix()

Returns the prefix for entries in the UIDefaults table.

Returns:

"MenuItem"

installComponents

protected void installComponents(javax.swing.JMenuItem menuItem)

This method installs the components for this JMenuItem.

Parameters:

menuItem - The JMenuItem to install components for.

installDefaults

protected void installDefaults()

This method installs the defaults that are defined in the Basic look and feel for this JMenuItem.

installKeyboardActions

protected void installKeyboardActions()

This method installs the keyboard actions for this JMenuItem.

installListeners

protected void installListeners()

This method installs the listeners for the JMenuItem.

installUI

public void installUI(javax.swing.JComponent c)

Installs and initializes all fields for this UI delegate. Any properties of the UI that need to be initialized and/or set to defaults will be done now. It will also install any listeners necessary.

Overrides:

installUI in class javax.swing.plaf.ComponentUI

Parameters:

c - The JComponent that is having this UI installed.

See Also:

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

paint

public void paint(java.awt.Graphics g,
         javax.swing.JComponent c)

Paints given menu item using specified graphics context

Overrides:

paint in class javax.swing.plaf.ComponentUI

Parameters:

g - The graphics context used to paint this menu item

c - Menu Item to paint

paintBackground

protected void paintBackground(java.awt.Graphics g,
                   javax.swing.JMenuItem menuItem,
                   java.awt.Color bgColor)

Paints background of the menu item

Parameters:

g - The graphics context used to paint this menu item

menuItem - menu item to paint

bgColor - Background color to use when painting menu item

paintMenuItem

protected void paintMenuItem(java.awt.Graphics g,
                 javax.swing.JComponent c,
                 javax.swing.Icon checkIcon,
                 javax.swing.Icon arrowIcon,
                 java.awt.Color background,
                 java.awt.Color foreground,
                 int defaultTextIconGap)

Paints specified menu item

Parameters:

g - The graphics context used to paint this menu item

c - menu item to paint

checkIcon - check icon to use when painting menu item

arrowIcon - arrow icon to use when painting menu item

background - Background color of the menu item

foreground - Foreground color of the menu item

defaultTextIconGap - space to use between icon and text when painting menu item

paintText

protected void paintText(java.awt.Graphics g,
             javax.swing.JMenuItem menuItem,
             java.awt.Rectangle textRect,
             java.lang.String text)

Paints label for the given menu item

Parameters:

g - The graphics context used to paint this menu item

menuItem - menu item for which to draw its label

textRect - rectangle specifiying position of the text relative to the given menu item

text - label of the menu item

uninstallComponents

protected void uninstallComponents(javax.swing.JMenuItem menuItem)

This method uninstalls the components for this JMenuItem.

Parameters:

menuItem - The JMenuItem to uninstall components for.

uninstallDefaults

protected void uninstallDefaults()

This method uninstalls the defaults and sets any objects created during install to null

uninstallKeyboardActions

protected void uninstallKeyboardActions()

Uninstalls any keyboard actions.

uninstallListeners

protected void uninstallListeners()

Unregisters all the listeners that this UI delegate was using.

uninstallUI

public void uninstallUI(javax.swing.JComponent c)

Performs the opposite of installUI. Any properties or resources that need to be cleaned up will be done now. It will also uninstall any listeners it has. In addition, any properties of this UI will be nulled.

Overrides:

uninstallUI in class javax.swing.plaf.ComponentUI

Parameters:

c - The JComponent that is having this UI uninstalled.

See Also:

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

update

public void update(java.awt.Graphics g,
          javax.swing.JComponent c)

This method calls paint.

Overrides:

update in class javax.swing.plaf.ComponentUI

Parameters:

g - The graphics context used to paint this menu item

c - The menu item to paint

See Also:

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