Module org.bzdev.desktop

Package org.bzdev.swing

Class IMenuItem

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JMenuItem

org.bzdev.swing.IMenuItem

All Implemented Interfaces:

ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, MenuElement, SwingConstants

public class IMenuItem
extends JMenuItem

Menu with internationalization support. The constructors take the name of a resource bundle and keys used to look up menu names and icons from the bundle. Changing the locale then automatically changes the icon and/or menu name.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JMenuItem

JMenuItem.AccessibleJMenuItem

Nested classes/interfaces inherited from class javax.swing.AbstractButton

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor	Description
IMenuItem()	Constructor.
IMenuItem(String text)	Constructor given specified text.
IMenuItem(String bundleName, String key)	Constructor given a bundle pathname and a key for text.
IMenuItem(String bundleName, String key1, String key2)	Constructor given a bundle pathname, a key for text, and a key for either an icon or a mnemonic.
IMenuItem(Locale locale, String bundleName, String key)	Constructor given a locale, a bundle pathname and a key for text.
IMenuItem(Locale locale, String bundleName, String key1, String key2)	Constructor given a locale, a bundle pathname, a key for text, and a key for either an icon or a mnemonic.
IMenuItem(Action a)	Constructor given an Action.
IMenuItem(Icon icon)	Constructor given an Icon

Method Summary

Modifier and Type	Method	Description
void	setDisabledIcon(Icon icon)
void	setDisabledIconKey(String key)	Set a menu item's disabled icon by key instead of by value.
void	setDisabledSelectedIcon(Icon icon)
void	setDisabledSelectedIconKey(String key)	Set a menu item's disabled-selected icon by key instead of by value.
void	setIcon(Icon icon)
void	setIconKey(String key)	Set a menu item's icon by key instead of by value.
void	setLocale(Locale locale)
void	setMnemonic(int mnemonic)
void	setMnemonicKey(String key)	Set a menu item's mnemonic code by key instead of by value.
void	setPressedIcon(Icon icon)
void	setPressedIconKey(String key)	Set a menu item's pressed icon by key instead of by value.
void	setRolloverIcon(Icon icon)
void	setRolloverIconKey(String key)	Set a menu item's rollover icon by key instead of by value.
void	setRolloverSelectedIcon(Icon icon)
void	setRolloverSelectedIconKey(String key)	Set a menu item's rollover-selected icon by key instead of by value.
void	setSelectedIcon(Icon icon)
void	setSelectedIconKey(String key)	Set a menu item's selected icon by key instead of by value.
void	setText(String text)
void	setTextKey(String key)	Set a menu item's text by key instead of by value.

Methods inherited from class javax.swing.JMenuItem

actionPropertyChanged, addMenuDragMouseListener, addMenuKeyListener, configurePropertiesFromAction, fireMenuDragMouseDragged, fireMenuDragMouseEntered, fireMenuDragMouseExited, fireMenuDragMouseReleased, fireMenuKeyPressed, fireMenuKeyReleased, fireMenuKeyTyped, getAccelerator, getAccessibleContext, getComponent, getMenuDragMouseListeners, getMenuKeyListeners, getSubElements, getUIClassID, init, isArmed, menuSelectionChanged, paramString, processKeyEvent, processMenuDragMouseEvent, processMenuKeyEvent, processMouseEvent, removeMenuDragMouseListener, removeMenuKeyListener, setAccelerator, setArmed, setEnabled, setModel, setUI, updateUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisplayedMnemonicIndex, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMultiClickThreshhold, setRolloverEnabled, setSelected, setUI, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Details

IMenuItem

public IMenuItem()

Constructor.

IMenuItem

public IMenuItem(Action a)

Constructor given an Action.

Parameters:

a - the action that determine this menu item's appearance and behavior

IMenuItem

public IMenuItem(Icon icon)

Constructor given an Icon

Parameters:

icon - the icon that represents this menu item.

IMenuItem

public IMenuItem(String text)

Constructor given specified text.

Parameters:

text - the text that labels this menu item

IMenuItem

public IMenuItem(String bundleName,
 String key)
          throws IllegalArgumentException

Constructor given a bundle pathname and a key for text.

Parameters:

bundleName - the pathname of a resource bundle

key - the resource bundle's key for the text labeling this menu item

Throws:

IllegalArgumentException - the path name for a resource bundle pointed to a resource that does not exist

IMenuItem

public IMenuItem(Locale locale,
 String bundleName,
 String key)
          throws IllegalArgumentException

Constructor given a locale, a bundle pathname and a key for text.

Parameters:

locale - a locale

bundleName - the pathname of a resource bundle

key - the resource bundle's key for the text labeling this menu item

Throws:

IllegalArgumentException - the path name for a resource bundle pointed to a resource that does not exist

IMenuItem

public IMenuItem(String bundleName,
 String key1,
 String key2)
          throws IllegalArgumentException

Constructor given a bundle pathname, a key for text, and a key for either an icon or a mnemonic.

Parameters:

bundleName - the pathname of a resource bundle

key1 - the resource bundle's key for the text labeling this menu item

key2 - the resource bundle's key for either an icon or for a mnemonic

Throws:

IllegalArgumentException - the path name for a resource bundle pointed to a resource that does not exist

IMenuItem

public IMenuItem(Locale locale,
 String bundleName,
 String key1,
 String key2)
          throws IllegalArgumentException

Constructor given a locale, a bundle pathname, a key for text, and a key for either an icon or a mnemonic. The resource bundle is expected to provide an object that is an Icon when key2 refers to an icon or an Integer when key2 refers to a mnemonic.

Parameters:

locale - the locale

bundleName - the pathname of a resource bundle

key1 - the resource bundle's key for the text labeling this menu item

key2 - the resource bundle's key for either an icon or for a mnemonic

Throws:

IllegalArgumentException - the path name for a resource bundle pointed to a resource that does not exist

Method Details

setLocale

public void setLocale(Locale locale)

Overrides:

setLocale in class Component

setText

public void setText(String text)

Overrides:

setText in class AbstractButton

setTextKey

public void setTextKey(String key)

Set a menu item's text by key instead of by value.

Parameters:

key - the key used by a resource bundle to find the text used to label this menu item

setIcon

public void setIcon(Icon icon)

Overrides:

setIcon in class AbstractButton

setIconKey

public void setIconKey(String key)

Set a menu item's icon by key instead of by value.

Parameters:

key - the key used by a resource bundle to find the icon for this menu item

See Also:

• setIcon(Icon)

setSelectedIcon

public void setSelectedIcon(Icon icon)

Overrides:

setSelectedIcon in class AbstractButton

setSelectedIconKey

public void setSelectedIconKey(String key)

Set a menu item's selected icon by key instead of by value.

Parameters:

key - the key used by a resource bundle to find the icon for this menu item

See Also:

• setSelectedIcon(Icon)

setDisabledIcon

public void setDisabledIcon(Icon icon)

Overrides:

setDisabledIcon in class AbstractButton

setDisabledIconKey

public void setDisabledIconKey(String key)

Set a menu item's disabled icon by key instead of by value.

Parameters:

key - the key used by a resource bundle to find the icon for this menu item

See Also:

• setDisabledIcon(Icon)

setDisabledSelectedIcon

public void setDisabledSelectedIcon(Icon icon)

Overrides:

setDisabledSelectedIcon in class AbstractButton

setDisabledSelectedIconKey

public void setDisabledSelectedIconKey(String key)

Set a menu item's disabled-selected icon by key instead of by value.

Parameters:

key - the key used by a resource bundle to find the icon for this menu item

See Also:

• setDisabledSelectedIcon(Icon)

setRolloverIcon

public void setRolloverIcon(Icon icon)

Overrides:

setRolloverIcon in class AbstractButton

setRolloverIconKey

public void setRolloverIconKey(String key)

Set a menu item's rollover icon by key instead of by value.

Parameters:

key - the key used by a resource bundle to find the icon for this menu item

See Also:

• setRolloverIcon(Icon)

setRolloverSelectedIcon

public void setRolloverSelectedIcon(Icon icon)

Overrides:

setRolloverSelectedIcon in class AbstractButton

setRolloverSelectedIconKey

public void setRolloverSelectedIconKey(String key)

Set a menu item's rollover-selected icon by key instead of by value.

Parameters:

key - the key used by a resource bundle to find the icon for this menu item

See Also:

• setRolloverSelectedIcon(Icon)

setPressedIcon

public void setPressedIcon(Icon icon)

Overrides:

setPressedIcon in class AbstractButton

setPressedIconKey

public void setPressedIconKey(String key)

Set a menu item's pressed icon by key instead of by value.

Parameters:

key - the key used by a resource bundle to find the icon for this menu item

See Also:

• setPressedIcon(Icon)

setMnemonic

public void setMnemonic(int mnemonic)

Overrides:

setMnemonic in class AbstractButton

setMnemonicKey

public void setMnemonicKey(String key)

Set a menu item's mnemonic code by key instead of by value.

Parameters:

key - the key used by a resource bundle to find the mnemonic code for this menu item

See Also:

• setMnemonic(int)