BasicMenuItemUI
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, SynthMenuItemUI
public class BasicMenuItemUI extends MenuItemUI
BasicMenuItem implementation
Nested Classes
Modifier and Type | Class and Description |
---|---|
protected class |
BasicMenuItemUI.MouseInputHandler |
Fields
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
protected String acceleratorDelimiter
Accelerator delimiter string, such as '+'
in 'Ctrl+C'
.
- Since:
- 1.7
defaultTextIconGap
protected int defaultTextIconGap
acceleratorFont
protected Font acceleratorFont
mouseInputListener
protected MouseInputListener mouseInputListener
menuDragMouseListener
protected MenuDragMouseListener menuDragMouseListener
menuKeyListener
protected MenuKeyListener menuKeyListener
propertyChangeListener
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
.
- Since:
- 1.6
- See Also:
createPropertyChangeListener(javax.swing.JComponent)
arrowIcon
protected Icon arrowIcon
checkIcon
protected Icon checkIcon
oldBorderPainted
protected boolean oldBorderPainted
Constructors
BasicMenuItemUI
public BasicMenuItemUI()
Methods
createUI
public static ComponentUI createUI(JComponent c)
installUI
public void installUI(JComponent c)
Description copied from class: ComponentUI
Configures the specified component appropriately 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:
- Install 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.
- Install a
LayoutManager
on the component if necessary. - Create/add any required sub-components to the component.
- Create/install event listeners on the component.
- Create/install a
PropertyChangeListener
on the component in order to detect and respond to component property changes appropriately. - Install keyboard UI (mnemonics, traversal, etc.) on the component.
- Initialize any appropriate instance data.
- Overrides:
-
installUI
in classComponentUI
- 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:
- Remove any UI-set borders from the component.
- Remove any UI-set layout managers on the component.
- Remove any UI-added sub-components from the component.
- Remove any UI-added event/property listeners from the component.
- Remove any UI-installed keyboard UI from the component.
- Nullify any allocated instance data objects to allow for GC.
- Overrides:
-
uninstallUI
in classComponentUI
- 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
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 - Since:
- 1.6
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 classComponentUI
- 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 ornull
- 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 classComponentUI
- 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 classComponentUI
- 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 ornull
- See Also:
-
JComponent.getMaximumSize()
,LayoutManager2.maximumLayoutSize(java.awt.Container)
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 classComponentUI
- Parameters:
-
g
- theGraphics
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 appropriately 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 classComponentUI
- Parameters:
-
g
- theGraphics
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
getPath
public MenuElement[] getPath()
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. Ifnull
is passed as this argument, theMenuSelectionManager.defaultManager
is used. - Since:
- 1.4
- See Also:
-
MenuSelectionManager
,AbstractButton.doClick(int)
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.