public class

BasicMenuItemUI

extends MenuItemUI
java.lang.Object
   ↳ javax.swing.plaf.ComponentUI
     ↳ javax.swing.plaf.ButtonUI
       ↳ javax.swing.plaf.MenuItemUI
         ↳ javax.swing.plaf.basic.BasicMenuItemUI
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

BasicMenuItem implementation

Summary

Nested Classes
class BasicMenuItemUI.MouseInputHandler  
Fields
protected Font acceleratorFont
protected Color acceleratorForeground
protected Color acceleratorSelectionForeground
protected Icon arrowIcon
protected Icon checkIcon
protected int defaultTextIconGap
protected Color disabledForeground
protected MenuDragMouseListener menuDragMouseListener
protected JMenuItem menuItem
protected MenuKeyListener menuKeyListener
protected MouseInputListener mouseInputListener
protected boolean oldBorderPainted
protected PropertyChangeListener propertyChangeListener PropertyChangeListener returned from createPropertyChangeListener.
protected Color selectionBackground
protected Color selectionForeground
Public Constructors
BasicMenuItemUI()
Public Methods
static ComponentUI createUI(JComponent c)
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()
Dimension getPreferredSize(JComponent c)
Returns the specified component's preferred size appropriate for the look and feel.
void installUI(JComponent c)
Configures the specified component appropriate for the look and feel.
void paint(Graphics g, JComponent c)
Paints the specified component appropriate for the look and feel.
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().
Protected Methods
MenuDragMouseListener createMenuDragMouseListener(JComponent c)
MenuKeyListener createMenuKeyListener(JComponent c)
MouseInputListener createMouseInputListener(JComponent c)
PropertyChangeListener createPropertyChangeListener(JComponent c)
Creates a PropertyChangeListener which will be added to the menu item.
void doClick(MenuSelectionManager msm)
Call this method when a menu item is to be activated.
Dimension getPreferredMenuItemSize(JComponent c, Icon checkIcon, Icon arrowIcon, int defaultTextIconGap)
String getPropertyPrefix()
void installComponents(JMenuItem menuItem)
void installDefaults()
void installKeyboardActions()
void installListeners()
void paintBackground(Graphics g, JMenuItem menuItem, Color bgColor)
Draws the background of the menu item.
void paintMenuItem(Graphics g, JComponent c, Icon checkIcon, Icon arrowIcon, Color background, Color foreground, int defaultTextIconGap)
void paintText(Graphics g, JMenuItem menuItem, Rectangle textRect, String text)
Renders the text of the current menu item.
void uninstallComponents(JMenuItem menuItem)
void uninstallDefaults()
void uninstallKeyboardActions()
void uninstallListeners()
[Expand]
Inherited Methods
From class javax.swing.plaf.ComponentUI
From class java.lang.Object

Fields

protected Font acceleratorFont

protected Color acceleratorForeground

protected Color acceleratorSelectionForeground

protected Icon arrowIcon

protected Icon checkIcon

protected int defaultTextIconGap

protected Color disabledForeground

protected MenuDragMouseListener menuDragMouseListener

protected JMenuItem menuItem

protected MenuKeyListener menuKeyListener

protected MouseInputListener mouseInputListener

protected boolean oldBorderPainted

protected PropertyChangeListener propertyChangeListener

PropertyChangeListener returned from createPropertyChangeListener. You should not need to access this field, rather if you want to customize the PropertyChangeListener override createPropertyChangeListener.

See Also

protected Color selectionBackground

protected Color selectionForeground

Public Constructors

public BasicMenuItemUI ()

Public Methods

public static ComponentUI createUI (JComponent c)

public Dimension getMaximumSize (JComponent c)

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.

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

public Dimension getMinimumSize (JComponent c)

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.

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

public MenuElement[] getPath ()

public Dimension getPreferredSize (JComponent c)

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.

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)

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.

Parameters
c the component where this UI delegate is being installed

public void paint (Graphics g, JComponent c)

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.

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

public void uninstallUI (JComponent c)

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.

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

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

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

Protected Methods

protected MenuDragMouseListener createMenuDragMouseListener (JComponent c)

protected MenuKeyListener createMenuKeyListener (JComponent c)

protected MouseInputListener createMouseInputListener (JComponent c)

protected PropertyChangeListener createPropertyChangeListener (JComponent c)

Creates a PropertyChangeListener which will be added to the menu item. If this method returns null then it will not be added to the menu item.

Returns
  • an instance of a PropertyChangeListener or null

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.
See Also

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

protected String getPropertyPrefix ()

protected void installComponents (JMenuItem menuItem)

protected void installDefaults ()

protected void installKeyboardActions ()

protected void installListeners ()

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

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.

Parameters
g graphics context
menuItem menu item to render
textRect bounding rectangle for rendering the text
text string to render

protected void uninstallComponents (JMenuItem menuItem)

protected void uninstallDefaults ()

protected void uninstallKeyboardActions ()

protected void uninstallListeners ()