Class BasicMenuUI

java.lang.Object

javax.swing.plaf.ComponentUI

javax.swing.plaf.ButtonUI

javax.swing.plaf.MenuItemUI

javax.swing.plaf.basic.BasicMenuItemUI

javax.swing.plaf.basic.BasicMenuUI

Direct Known Subclasses:

SynthMenuUI

public class BasicMenuUI
extends BasicMenuItemUI

A default L&F implementation of MenuUI. This implementation is a "combined" view/controller.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BasicMenuUI.ChangeHandler	As of Java 2 platform 1.4, this previously undocumented class is now obsolete.
protected class	BasicMenuUI.MouseInputHandler	Instantiated and used by a menu item to handle the current menu selection from mouse events.

Field Summary

Fields

Modifier and Type	Field	Description
protected ChangeListener	changeListener	The instance of ChangeListener.
protected MenuListener	menuListener	The instance of MenuListener.

Fields declared in class BasicMenuItemUI

acceleratorDelimiter, acceleratorFont, acceleratorForeground, acceleratorSelectionForeground, arrowIcon, checkIcon, defaultTextIconGap, disabledForeground, menuDragMouseListener, menuItem, menuKeyListener, mouseInputListener, oldBorderPainted, propertyChangeListener, selectionBackground, selectionForeground

Modifier and Type	Field	Description
protected String	acceleratorDelimiter	Accelerator delimiter string, such as '+' in 'Ctrl+C'.
protected Font	acceleratorFont	The accelerator font.
protected Color	acceleratorForeground	The color of the accelerator foreground.
protected Color	acceleratorSelectionForeground	The color of the accelerator selection.
protected Icon	arrowIcon	The arrow icon.
protected Icon	checkIcon	The check icon.
protected int	defaultTextIconGap	The gap between the text and the icon.
protected Color	disabledForeground	The color of the disabled foreground.
protected MenuDragMouseListener	menuDragMouseListener	The instance of MenuDragMouseListener.
protected JMenuItem	menuItem	The instance of JMenuItem.
protected MenuKeyListener	menuKeyListener	The instance of MenuKeyListener.
protected MouseInputListener	mouseInputListener	The instance of MouseInputListener.
protected boolean	oldBorderPainted	The value represents if the old border is painted.
protected PropertyChangeListener	propertyChangeListener	PropertyChangeListener returned from createPropertyChangeListener.
protected Color	selectionBackground	The color of the selection background.
protected Color	selectionForeground	The color of the selection foreground.

Constructor Summary

Constructors

Constructor	Description
BasicMenuUI()	Constructs a BasicMenuUI.

Method Summary

Modifier and Type	Method	Description
protected ChangeListener	createChangeListener(JComponent c)	Returns an instance of ChangeListener.
protected MenuListener	createMenuListener(JComponent c)	Returns an instance of MenuListener.
static ComponentUI	createUI(JComponent x)	Constructs a new instance of BasicMenuUI.
protected void	setupPostTimer(JMenu menu)	Sets timer to the menu.

Methods declared in class BasicMenuItemUI

createMenuDragMouseListener, createMenuKeyListener, createMouseInputListener, createPropertyChangeListener, doClick, getPath, getPreferredMenuItemSize, getPropertyPrefix, installComponents, installDefaults, installKeyboardActions, installListeners, paintBackground, paintMenuItem, paintText, uninstallComponents, uninstallDefaults, uninstallKeyboardActions, uninstallListeners, update

Modifier and Type	Method	Description
protected MenuDragMouseListener	createMenuDragMouseListener(JComponent c)	Returns an instance of MenuDragMouseListener.
protected MenuKeyListener	createMenuKeyListener(JComponent c)	Returns an instance of MenuKeyListener.
protected MouseInputListener	createMouseInputListener(JComponent c)	Returns an instance of MouseInputListener.
protected PropertyChangeListener	createPropertyChangeListener(JComponent c)	Creates a PropertyChangeListener which will be added to the menu item.
protected void	doClick(MenuSelectionManager msm)	Call this method when a menu item is to be activated.
MenuElement[]	getPath()	Returns a menu element path.
protected Dimension	getPreferredMenuItemSize(JComponent c, Icon checkIcon, Icon arrowIcon, int defaultTextIconGap)	Returns the preferred size of a menu item.
protected String	getPropertyPrefix()	Returns a property prefix.
protected void	installComponents(JMenuItem menuItem)	Registers the subcomponents of the menu.
protected void	installDefaults()	Installs default properties.
protected void	installKeyboardActions()	Registers keyboard action.
protected void	installListeners()	Registers listeners.
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)	Paints a menu item.
protected void	paintText(Graphics g, JMenuItem menuItem, Rectangle textRect, String text)	Renders the text of the current menu item.
protected void	uninstallComponents(JMenuItem menuItem)	Unregisters components.
protected void	uninstallDefaults()	Uninstalls default properties.
protected void	uninstallKeyboardActions()	Unregisters keyboard actions.
protected void	uninstallListeners()	Unregisters listeners.
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().

Methods declared in class ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMaximumSize, getMinimumSize, getPreferredSize, installUI, paint, uninstallUI

Modifier and Type	Method	Description
boolean	contains(JComponent c, int x, int y)	Returns true if the specified x,y location is contained within the look and feel's defined shape of the specified component.
Accessible	getAccessibleChild(JComponent c, int i)	Returns the ith Accessible child of the object.
int	getAccessibleChildrenCount(JComponent c)	Returns the number of accessible children in the object.
int	getBaseline(JComponent c, int width, int height)	Returns the baseline.
Component.BaselineResizeBehavior	getBaselineResizeBehavior(JComponent c)	Returns an enum indicating how the baseline of the component changes as the size changes.
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.
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 appropriately for the look and feel.
void	paint(Graphics g, JComponent c)	Paints the specified component appropriately for the look and feel.
void	uninstallUI(JComponent c)	Reverses configuration which was done on the specified component during installUI.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Field Details

changeListener

protected ChangeListener changeListener

The instance of ChangeListener.

menuListener

protected MenuListener menuListener

The instance of MenuListener.

Constructor Details

BasicMenuUI

public BasicMenuUI()

Constructs a BasicMenuUI.

Method Details

createUI

public static ComponentUI createUI(JComponent x)

Constructs a new instance of BasicMenuUI.

Parameters:

x - a component

Returns:

a new instance of BasicMenuUI

createMenuListener

protected MenuListener createMenuListener(JComponent c)

Returns an instance of MenuListener.

Parameters:

c - a component

Returns:

an instance of MenuListener

createChangeListener

protected ChangeListener createChangeListener(JComponent c)

Returns an instance of ChangeListener.

Parameters:

c - a component

Returns:

an instance of ChangeListener

setupPostTimer

protected void setupPostTimer(JMenu menu)

Sets timer to the menu.

Parameters:

menu - an instance of JMenu.