com.isti.util.gui

Class IstiMenu

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JList

com.isti.util.gui.IstiMenu

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.Scrollable

public class IstiMenu
extends javax.swing.JList
implements java.awt.event.MouseMotionListener, java.awt.event.MouseListener

A Menu-looking widget that is happier than a JMenu to sit on a panel. [HS] 6-23-2003 - Initial version [ET] 6-25-2003 - Made 'optionNameToOptionInfo' declaration include "final". [HS] 7-01-2003 - Added removeMenuItem() [HS] 7-02-2003 - Made non-rollover (and mostly non selectable) items out of the items that have no ActionListeners [HS] 7-02-2003 - Added support for a default list of ActionListeners [KF] 2-06-2004 - Added 'getNumMenuItems' method. [KF] 2-22-2021 - Added 'getToolTipText' method and modifiers to the ActionEvent.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JList.AccessibleJList, javax.swing.JList.DropLocation

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JList

HORIZONTAL_WRAP, VERTICAL, VERTICAL_WRAP

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

Constructor Summary

Constructors

Constructor and Description
IstiMenu() Create an empty IstiMenu object

Method Summary

Modifier and Type	Method and Description
void	addActionListenerToMenuItem(java.lang.String name, java.awt.event.ActionListener l) Add another ActionListener to a menu item
void	addDefaultActionListener(java.awt.event.ActionListener listener) Add a new ActionListener to the default list.
void	addMenuItem(java.lang.String name, java.lang.String tooltipStr) Add a menu item.
void	addMenuItem(java.lang.String name, java.lang.String tooltipStr, java.awt.event.ActionListener listener) Add a menu item, and a coresponding ActionListener.
static int	getActionModifiers(java.awt.event.MouseEvent e) Get the action modifiers for the specified mouse event.
int	getNumMenuItems() Gets the number of items in the menu.
java.lang.String	getToolTipText() Get the tool tip text.
java.lang.String	getToolTipText(java.awt.event.MouseEvent e) This is where tooltips are implemented.
void	mouseClicked(java.awt.event.MouseEvent e) Method to implement the MouseListener interface.
void	mouseDragged(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e) Give ourselves a hand cursor
void	mouseExited(java.awt.event.MouseEvent e)
void	mouseMoved(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	removeDefaultActionListener(java.awt.event.ActionListener listener) Remove an ActionListener from the list of default ActionListeners
void	removeMenuItem(java.lang.String name) Remove a menu item from the menu.
void	setMouseoverCursor(java.awt.Cursor c) Set the cursor we should use when the mouse enters the menu.
void	setSelectedIndex(int index) Local setSelectedIndex to avoid non-selectable items from being selected

Methods inherited from class javax.swing.JList

addListSelectionListener, addSelectionInterval, clearSelection, createSelectionModel, ensureIndexIsVisible, fireSelectionValueChanged, getAccessibleContext, getAnchorSelectionIndex, getCellBounds, getCellRenderer, getDragEnabled, getDropLocation, getDropMode, getFirstVisibleIndex, getFixedCellHeight, getFixedCellWidth, getLastVisibleIndex, getLayoutOrientation, getLeadSelectionIndex, getListSelectionListeners, getMaxSelectionIndex, getMinSelectionIndex, getModel, getNextMatch, getPreferredScrollableViewportSize, getPrototypeCellValue, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedIndex, getSelectedIndices, getSelectedValue, getSelectedValues, getSelectedValuesList, getSelectionBackground, getSelectionForeground, getSelectionMode, getSelectionModel, getUI, getUIClassID, getValueIsAdjusting, getVisibleRowCount, indexToLocation, isSelectedIndex, isSelectionEmpty, locationToIndex, paramString, removeListSelectionListener, removeSelectionInterval, setCellRenderer, setDragEnabled, setDropMode, setFixedCellHeight, setFixedCellWidth, setLayoutOrientation, setListData, setListData, setModel, setPrototypeCellValue, setSelectedIndices, setSelectedValue, setSelectionBackground, setSelectionForeground, setSelectionInterval, setSelectionMode, setSelectionModel, setUI, setValueIsAdjusting, setVisibleRowCount, updateUI

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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, 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, addImpl, 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, setLayout, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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 Detail

IstiMenu

public IstiMenu()

Create an empty IstiMenu object

Method Detail

getActionModifiers

public static int getActionModifiers(java.awt.event.MouseEvent e)

Get the action modifiers for the specified mouse event.

Parameters:

e - the mouse event.

Returns:

the action modifiers.

addDefaultActionListener

public void addDefaultActionListener(java.awt.event.ActionListener listener)

Add a new ActionListener to the default list. These listeners are alerted when a menu item without any other ActionListeners is selected.

Parameters:

listener - a new default ActionListener

removeDefaultActionListener

public void removeDefaultActionListener(java.awt.event.ActionListener listener)

Remove an ActionListener from the list of default ActionListeners

Parameters:

listener - the ActionListener to remove

addMenuItem

public void addMenuItem(java.lang.String name,
                        java.lang.String tooltipStr,
                        java.awt.event.ActionListener listener)

Add a menu item, and a coresponding ActionListener.

Parameters:

name - the name of the item.

tooltipStr - tooltip text for this option, or null for none.

listener - an ActionListener associated with this item, or null for none.

removeMenuItem

public void removeMenuItem(java.lang.String name)

Remove a menu item from the menu.

Parameters:

name - The menu item to remove

addMenuItem

public void addMenuItem(java.lang.String name,
                        java.lang.String tooltipStr)

Add a menu item.

Parameters:

name - The menu item.

tooltipStr - tooltip text for this option.

getNumMenuItems

public int getNumMenuItems()

Gets the number of items in the menu.

Returns:

the number of items in the menu.

addActionListenerToMenuItem

public void addActionListenerToMenuItem(java.lang.String name,
                                        java.awt.event.ActionListener l)

Add another ActionListener to a menu item

Parameters:

name - The name of the menu item

l - the action to be performed

getToolTipText

public java.lang.String getToolTipText()

Get the tool tip text.

Overrides:

getToolTipText in class javax.swing.JComponent

Returns:

the tool tip text or an empty string if none.

getToolTipText

public java.lang.String getToolTipText(java.awt.event.MouseEvent e)

This is where tooltips are implemented.

Overrides:

getToolTipText in class javax.swing.JList

Parameters:

e - A MouseEvent so we can see where the cursor is

Returns:

The string for the desired tooltip

setMouseoverCursor

public void setMouseoverCursor(java.awt.Cursor c)

Set the cursor we should use when the mouse enters the menu.

Parameters:

c - A Cursor object

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Method to implement the MouseListener interface.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Parameters:

e - mouse event object.

setSelectedIndex

public void setSelectedIndex(int index)

Local setSelectedIndex to avoid non-selectable items from being selected

Overrides:

setSelectedIndex in class javax.swing.JList

Parameters:

index - the index of the item being selected

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Give ourselves a hand cursor

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Parameters:

e - the mouse event

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener