Class SynthMenuItemUI

java.lang.Object

javax.swing.plaf.ComponentUI

javax.swing.plaf.ButtonUI

javax.swing.plaf.MenuItemUI

javax.swing.plaf.basic.BasicMenuItemUI

javax.swing.plaf.synth.SynthMenuItemUI

All Implemented Interfaces:

PropertyChangeListener, EventListener, SynthConstants, SynthUI

Direct Known Subclasses:

SynthCheckBoxMenuItemUI, SynthRadioButtonMenuItemUI

public class SynthMenuItemUI
extends BasicMenuItemUI
implements PropertyChangeListener, SynthUI

Provides the Synth L&F UI delegate for JMenuItem.

Since:

1.7

Nested Class Summary

Nested classes/interfaces inherited from class BasicMenuItemUI

BasicMenuItemUI.MouseInputHandler

Modifier and Type	Class	Description
protected class	BasicMenuItemUI.MouseInputHandler	Deprecated, for removal: This API element is subject to removal in a future version.

Field Summary

Fields inherited from 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.

Fields inherited from interface SynthConstants

DEFAULT, DISABLED, ENABLED, FOCUSED, MOUSE_OVER, PRESSED, SELECTED

Modifier and Type	Field	Description
static final int	DEFAULT	Indicates the region is the default.
static final int	DISABLED	Primary state indicating the region is not enabled.
static final int	ENABLED	Primary state indicating the component is enabled.
static final int	FOCUSED	Indicates the region has focus.
static final int	MOUSE_OVER	Primary state indicating the mouse is over the region.
static final int	PRESSED	Primary state indicating the region is in a pressed state.
static final int	SELECTED	Indicates the region is selected.

Constructor Summary

Constructors

Constructor	Description
SynthMenuItemUI()	Constructs a SynthMenuItemUI.

Method Summary

Modifier and Type	Method	Description
static ComponentUI	createUI(JComponent c)	Creates a new UI object for the given component.
SynthContext	getContext(JComponent c)	Returns the Context for the specified component.
protected Dimension	getPreferredMenuItemSize(JComponent c, Icon checkIcon, Icon arrowIcon, int defaultTextIconGap)	Returns the preferred size of a menu item.
protected void	installDefaults()	Installs default properties.
protected void	installListeners()	Registers listeners.
void	paint(Graphics g, JComponent c)	Paints the specified component according to the Look and Feel.
protected void	paint(SynthContext context, Graphics g)	Paints the specified component.
void	paintBorder(SynthContext context, Graphics g, int x, int y, int w, int h)	Paints the border.
void	propertyChange(PropertyChangeEvent e)	This method gets called when a bound property is changed.
protected void	uninstallDefaults()	Uninstalls default properties.
protected void	uninstallListeners()	Unregisters listeners.
void	uninstallUI(JComponent c)	Reverses configuration which was done on the specified component during installUI.
void	update(Graphics g, JComponent c)	Notifies this UI delegate to repaint the specified component.

Methods inherited from class BasicMenuItemUI

createMenuDragMouseListener, createMenuKeyListener, createMouseInputListener, createPropertyChangeListener, doClick, getMaximumSize, getMinimumSize, getPath, getPreferredSize, getPropertyPrefix, installComponents, installKeyboardActions, installUI, paintBackground, paintMenuItem, paintText, uninstallComponents, uninstallKeyboardActions

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.
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()	Returns a menu element path.
Dimension	getPreferredSize(JComponent c)	Returns the specified component's preferred size appropriate for the look and feel.
protected String	getPropertyPrefix()	Returns a property prefix.
protected void	installComponents(JMenuItem menuItem)	Registers the subcomponents of the menu.
protected void	installKeyboardActions()	Registers keyboard action.
void	installUI(JComponent c)	Configures the specified component appropriately 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)	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	uninstallKeyboardActions()	Unregisters keyboard actions.

Methods inherited from class ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior

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.

Methods inherited from class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
final Class<?>	getClass()	Returns the runtime class of this Object.
int	hashCode()	Returns a hash code value for this object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
String	toString()	Returns a string representation of the object.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

SynthMenuItemUI

public SynthMenuItemUI()

Constructs a SynthMenuItemUI.

Method Details

createUI

public static ComponentUI createUI(JComponent c)

Creates a new UI object for the given component.

Parameters:

c - component to create UI object for

Returns:

the UI object

uninstallUI

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.

Overrides:

uninstallUI in class BasicMenuItemUI

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(JComponent)
• JComponent.updateUI()

installDefaults

protected void installDefaults()

Installs default properties.

Overrides:

installDefaults in class BasicMenuItemUI

installListeners

protected void installListeners()

Registers listeners.

Overrides:

installListeners in class BasicMenuItemUI

uninstallDefaults

protected void uninstallDefaults()

Uninstalls default properties.

Overrides:

uninstallDefaults in class BasicMenuItemUI

uninstallListeners

protected void uninstallListeners()

Unregisters listeners.

Overrides:

uninstallListeners in class BasicMenuItemUI

getContext

public SynthContext getContext(JComponent c)

Returns the Context for the specified component.

Specified by:

getContext in interface SynthUI

Parameters:

c - Component requesting SynthContext.

Returns:

SynthContext describing component.

getPreferredMenuItemSize

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

Returns the preferred size of a menu item.

Overrides:

getPreferredMenuItemSize in class BasicMenuItemUI

Parameters:

c - a component

checkIcon - a check icon

arrowIcon - an arrow icon

defaultTextIconGap - a gap between a text and an icon

Returns:

the preferred size of a menu item

update

public void update(Graphics g,
 JComponent c)

Notifies this UI delegate to repaint the specified component. This method paints the component background, then calls the paint(SynthContext,Graphics) method.

In general, this method does not need to be overridden by subclasses. All Look and Feel rendering code should reside in the paint method.

Overrides:

update in class BasicMenuItemUI

Parameters:

g - the Graphics object used for painting

c - the component being painted

See Also:

• paint(SynthContext,Graphics)

paint

public void paint(Graphics g,
 JComponent c)

Paints the specified component according to the Look and Feel.

This method is not used by Synth Look and Feel. Painting is handled by the paint(SynthContext,Graphics) method.

Overrides:

paint in class BasicMenuItemUI

Parameters:

g - the Graphics object used for painting

c - the component being painted

See Also:

• paint(SynthContext,Graphics)

paint

protected void paint(SynthContext context,
 Graphics g)

Paints the specified component.

Parameters:

context - context for the component being painted

g - the Graphics object used for painting

See Also:

• update(Graphics,JComponent)

paintBorder

public void paintBorder(SynthContext context,
 Graphics g,
 int x,
 int y,
 int w,
 int h)

Paints the border.

Specified by:

paintBorder in interface SynthUI

Parameters:

context - a component context

g - Graphics to paint on

x - the X coordinate

y - the Y coordinate

w - width of the border

h - height of the border

propertyChange

public void propertyChange(PropertyChangeEvent e)

This method gets called when a bound property is changed.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

e - A PropertyChangeEvent object describing the event source and the property that has changed.