Module com.iamsoft.util.ui

Package com.iamsoft.util.ui.swing.mdi

Class WindowMenu

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JMenuItem

javax.swing.JMenu

com.iamsoft.util.ui.swing.mdi.WindowMenu

All Implemented Interfaces:

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

public class WindowMenu
extends JMenu

A JMenu that lists available windows and provides a dialog for selecting them. A list of open windows is provided at the bottom of the menu. All of the WindowArranger code needs to un-maximize the windows to prevent some odd bugs that occur when multiple maximized internal frames are present.

Typical usage:

        final EnhancedDesktopPane desktop = getDesktop();
        final WindowMenu menu = new WindowMenu();
        menu.setDesktop(desktop);
        menu.setWindowListModel(desktop.getListModel());
 

TODO: Ctrl-[Shift-]Tab

See Also:

WindowArranger, EnhancedDesktopPane, Windows: Adding a "Window" Menu, Serialized Form

Nested Class Summary

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

JMenu.AccessibleJMenu, JMenu.WinListener

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

Modifier and Type	Field	Description
static int	DEFAULT_INSERTION_INDEX	Index at which to insert new menu items (if so desired).

Fields inherited from class javax.swing.JMenu

popupListener

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
WindowMenu(JDesktopPane pDesktop, ListModel pWindowListModel)

Method Summary

Modifier and Type	Method	Description
Component	add(Component pComponent)	Adjusts internal indices after calling super implementation.
Component	add(Component pComponent, int pIdx)	Adjusts internal indices after calling super implementation.
JMenuItem	add(String pStr)	Adjusts internal indices after calling super implementation.
JMenuItem	add(Action pAction)	Adjusts internal indices after calling super implementation.
JMenuItem	add(JMenuItem pMenuItem)	Adjusts internal indices after calling super implementation.
void	addSeparator()	Adjusts internal indices after calling super implementation.
JDesktopPane	getDesktop()	Desktop pane associated with menu.
protected String	getFrameName(JInternalFrame pFrame)
LaunchWindowDialogWindowAction	getLaunchWindowDialogAction()
CascadeWindowAction	getWindowCascadeAction()
WindowListBoxDialog<?>	getWindowListDialog()
TileHorizontallyWindowAction	getWindowTileHorizontallyAction()
TileVerticallyWindowAction	getWindowTileVerticallyAction()
void	insert(String pStr, int pIdx)	Adjusts internal indices after calling super implementation.
JMenuItem	insert(Action pAction, int pIdx)	Adjusts internal indices after calling super implementation.
JMenuItem	insert(JMenuItem pMenuItem, int pIdx)	Adjusts internal indices after calling super implementation.
void	insertSeparator(int pIdx)	Adjusts internal indices after calling super implementation.
void	remove(int pIdx)	Adjusts internal indices after calling super implementation.
void	remove(Component pComponent)	Adjusts internal indices after calling super implementation.
void	remove(JMenuItem pItem)	Adjusts internal indices after calling super implementation.
static void	selectFrame(JInternalFrame pFrame)	Grant focus to the argument frame.

Methods inherited from class javax.swing.JMenu

addMenuListener, applyComponentOrientation, createActionChangeListener, createActionComponent, createWinListener, doClick, fireMenuCanceled, fireMenuDeselected, fireMenuSelected, getAccessibleContext, getComponent, getDelay, getItem, getItemCount, getMenuComponent, getMenuComponentCount, getMenuComponents, getMenuListeners, getPopupMenu, getPopupMenuOrigin, getSubElements, getUIClassID, isMenuComponent, isPopupMenuVisible, isSelected, isTearOff, isTopLevelMenu, menuSelectionChanged, paramString, processKeyEvent, removeAll, removeMenuListener, setAccelerator, setComponentOrientation, setDelay, setMenuLocation, setModel, setPopupMenuVisible, setSelected, updateUI

Methods inherited from class javax.swing.JMenuItem

actionPropertyChanged, addMenuDragMouseListener, addMenuKeyListener, configurePropertiesFromAction, fireMenuDragMouseDragged, fireMenuDragMouseEntered, fireMenuDragMouseExited, fireMenuDragMouseReleased, fireMenuKeyPressed, fireMenuKeyReleased, fireMenuKeyTyped, getAccelerator, getMenuDragMouseListeners, getMenuKeyListeners, init, isArmed, processKeyEvent, processMenuDragMouseEvent, processMenuKeyEvent, processMouseEvent, removeMenuDragMouseListener, removeMenuKeyListener, setArmed, setEnabled, setUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, 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, paintBorder, removeActionListener, removeChangeListener, removeItemListener, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelectedIcon, setText, 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, 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, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, 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, 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, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, 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

Methods inherited from interface javax.swing.MenuElement

processKeyEvent, processMouseEvent

Field Detail

DEFAULT_INSERTION_INDEX

public static final int DEFAULT_INSERTION_INDEX

Index at which to insert new menu items (if so desired). If additional menu items are required, they should generally be located after the window arrangement items but before all other items.

See Also:

Constant Field Values

Constructor Detail

WindowMenu

public WindowMenu(JDesktopPane pDesktop,
                  ListModel pWindowListModel)

Method Detail

getDesktop

public JDesktopPane getDesktop()

Desktop pane associated with menu.

getWindowCascadeAction

public CascadeWindowAction getWindowCascadeAction()

getWindowTileHorizontallyAction

public TileHorizontallyWindowAction getWindowTileHorizontallyAction()

getWindowTileVerticallyAction

public TileVerticallyWindowAction getWindowTileVerticallyAction()

getLaunchWindowDialogAction

public LaunchWindowDialogWindowAction getLaunchWindowDialogAction()

getWindowListDialog

public WindowListBoxDialog<?> getWindowListDialog()

selectFrame

public static void selectFrame(JInternalFrame pFrame)

Grant focus to the argument frame.

getFrameName

protected String getFrameName(JInternalFrame pFrame)

add

public final JMenuItem add(Action pAction)

Adjusts internal indices after calling super implementation.

Overrides:

add in class JMenu

add

public final Component add(Component pComponent)

Adjusts internal indices after calling super implementation.

Overrides:

add in class JMenu

add

public final Component add(Component pComponent,
                           int pIdx)

Adjusts internal indices after calling super implementation.

Overrides:

add in class JMenu

add

public final JMenuItem add(JMenuItem pMenuItem)

Adjusts internal indices after calling super implementation.

Overrides:

add in class JMenu

add

public final JMenuItem add(String pStr)

Adjusts internal indices after calling super implementation.

Overrides:

add in class JMenu

addSeparator

public void addSeparator()

Adjusts internal indices after calling super implementation.

Overrides:

addSeparator in class JMenu

insert

public final JMenuItem insert(Action pAction,
                              int pIdx)

Adjusts internal indices after calling super implementation.

Overrides:

insert in class JMenu

insert

public final JMenuItem insert(JMenuItem pMenuItem,
                              int pIdx)

Adjusts internal indices after calling super implementation.

Overrides:

insert in class JMenu

insert

public final void insert(String pStr,
                         int pIdx)

Adjusts internal indices after calling super implementation.

Overrides:

insert in class JMenu

insertSeparator

public void insertSeparator(int pIdx)

Adjusts internal indices after calling super implementation.

Overrides:

insertSeparator in class JMenu

remove

public final void remove(Component pComponent)

Adjusts internal indices after calling super implementation.

Overrides:

remove in class JMenu

remove

public final void remove(JMenuItem pItem)

Adjusts internal indices after calling super implementation.

Overrides:

remove in class JMenu

remove

public final void remove(int pIdx)

Adjusts internal indices after calling super implementation.

Overrides:

remove in class JMenu