com.altair.hwm.toolkit.utils
Class HWMMenuBarContainer

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JMenuBar
                  com.jidesoft.action.DockableBar
                      com.jidesoft.action.CommandBar
                          com.jidesoft.action.CommandMenuBar
                              com.altair.hwm.guilibrary.AltairJMenuBar
                                  com.altair.hwm.toolkit.utils.HWMMenuBarContainer

All Implemented Interfaces:

com.jidesoft.action.Dockable, com.jidesoft.swing.Alignable, com.jidesoft.swing.TopLevelMenuContainer, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.MenuElement, javax.swing.SwingConstants

public class HWMMenuBarContainer
extends AltairJMenuBar

Title: HWMMenuBarContainer

Description: The menubar that contains the various menus

Company: Altair Engineering, Inc.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.jidesoft.action.CommandBar

com.jidesoft.action.CommandBar.Expansion

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

javax.swing.JComponent.AccessibleJComponent

Field Summary

Fields inherited from class com.jidesoft.action.CommandBar

PROPERTY_MENU_BAR, PROPERTY_PAINT_BACKGROUND

Fields inherited from class com.jidesoft.action.DockableBar

m, PROPERTY_ALLOWED_DOCK_SIDES, PROPERTY_FLOATABLE, PROPERTY_FLOATED, PROPERTY_HIDABLE, PROPERTY_HIDDEN, PROPERTY_HORI_DOCKED, PROPERTY_INIT_INDEX, PROPERTY_INIT_MODE, PROPERTY_INIT_SIDE, PROPERTY_INIT_SUBINDEX, PROPERTY_KEY, PROPERTY_REARRANGABLE, PROPERTY_STRETCH, PROPERTY_TITLE, PROPERTY_UNDOCKED_BOUNDS, PROPERTY_VERT_DOCKED

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

HWMMenuBarContainer()
Constructor

Method Summary

void	AddMenu(java.lang.String strName, javax.swing.JMenu menu) Add menu with given name as its ID
void	EnableMenu(java.lang.String strName, boolean bEnable) Enable/disable menu with given name
void	EnableMenuItem(java.lang.String strMenuName, java.lang.String strMenuItemName, boolean bEnable) Enable/Disable menuitem with given name in the menu with given name
void	EnableMenuItems(java.lang.String strMenuName, java.lang.String[] arrstrMenuItemName, boolean bEnable) Enable/Disable array of menuitem with given names present in the menu
javax.swing.JMenu	GetMenu(java.lang.String strName) Get menu with given name
java.awt.Component	GetMenuItem(java.lang.String strMenuName, java.lang.String strMenuItemName) Returns menuitem with given name in the menu with given name
void	ShowMenu(java.lang.String strName, boolean bShow) Show/hide menu with given name
void	ShowMenuItem(java.lang.String strMenuName, java.lang.String strMenuItemName, boolean bShow) Show/hide menuitem with given name in the menu with given name
void	ShowMenuItems(java.lang.String strMenuName, java.lang.String[] arrstrMenuItemName, boolean bShow) Enable/Disable array of menuitem with given names present in the menu

Methods inherited from class com.jidesoft.action.CommandBar

add, addExpansion, addSeparator, addSeparator, getAccessibleContext, getHiddenComponents, getMargin, getMenu, getMenuCount, getPreferredRowCount, getUI, getUIClassID, isBorderPainted, isMenuBar, isOpaque, isPaintBackground, isScreenMenuBar, remove, removeAll, removeAllHiddenComponents, setBorderPainted, setChangingContainer, setMargin, setMenuBar, setPaintBackground, setPreferredRowCount, setUI, updateUI, validateWindowIfFloating

Methods inherited from class com.jidesoft.action.DockableBar

addDockableBarListener, getAllowedDockSides, getCanSide, getContext, getDockableBarListeners, getDockableBarManager, getDockID, getInitIndex, getInitMode, getInitSide, getInitSubindex, getKey, getOrientation, getTitle, getUndockedBounds, isFloatable, isFloating, isHidable, isHidden, isHoriDocked, isRearrangable, isStretch, isVertDocked, readElement, removeDockableBarListener, resetDockID, setAllowedDockSides, setCanSide, setContext, setDockableBarManager, setDockID, setFloatable, setFloating, setHidable, setHidden, setHoriDocked, setInitIndex, setInitMode, setInitSide, setInitSubindex, setKey, setLayout, setOrientation, setRearrangable, setStretch, setTitle, setUndockedBounds, setVertDocked, supportHorizontalOrientation, supportVerticalOrientation

Methods inherited from class javax.swing.JMenuBar

add, addNotify, getComponent, getComponentAtIndex, getComponentIndex, getHelpMenu, getSelectionModel, getSubElements, isSelected, menuSelectionChanged, processKeyEvent, processMouseEvent, removeNotify, setHelpMenu, setSelected, setSelectionModel, setUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, 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, remove, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, hide, 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, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HWMMenuBarContainer

public HWMMenuBarContainer()

Constructor

Method Detail

AddMenu

public void AddMenu(java.lang.String strName,
                    javax.swing.JMenu menu)

Add menu with given name as its ID

Parameters:

strName - The name for the menu (NOTE: not the display name)

menu - The menu to be added

GetMenu

public javax.swing.JMenu GetMenu(java.lang.String strName)
                          throws java.lang.Exception

Get menu with given name

Parameters:

strName - The name of the menu to return

Returns:

JMenu The mneuwith given name

Throws:

java.lang.Exception

ShowMenu

public void ShowMenu(java.lang.String strName,
                     boolean bShow)
              throws java.lang.Exception

Show/hide menu with given name

Parameters:

strName - The name of the menu to show/hide

bShow - If true, the menu is shown else hidden

Throws:

java.lang.Exception

EnableMenu

public void EnableMenu(java.lang.String strName,
                       boolean bEnable)
                throws java.lang.Exception

Enable/disable menu with given name

Parameters:

strName - The name of the menu to enable/disable

bEnable - If true, the menu is enabled else disabled

Throws:

java.lang.Exception

GetMenuItem

public java.awt.Component GetMenuItem(java.lang.String strMenuName,
                                      java.lang.String strMenuItemName)
                               throws java.lang.Exception

Returns menuitem with given name in the menu with given name

Parameters:

strMenuName - The name of the menu in which the menu item is present

strMenuItemName - The name of the menu item to return

Returns:

Component

Throws:

java.lang.Exception

EnableMenuItem

public void EnableMenuItem(java.lang.String strMenuName,
                           java.lang.String strMenuItemName,
                           boolean bEnable)
                    throws java.lang.Exception

Enable/Disable menuitem with given name in the menu with given name

Parameters:

strMenuName - The name of the menu in which the menu item is present

strMenuItemName - The name of the menu item to enable/disable

bEnable - If true, the menu is enabled else disabled

Throws:

java.lang.Exception

EnableMenuItems

public void EnableMenuItems(java.lang.String strMenuName,
                            java.lang.String[] arrstrMenuItemName,
                            boolean bEnable)
                     throws java.lang.Exception

Enable/Disable array of menuitem with given names present in the menu

Parameters:

strMenuName - The name of the menu in which the menu items are present

arrstrMenuItemName - The array of names of the menu items to enable/disable

bEnable - If true, the menu is enabled else disabled

Throws:

java.lang.Exception

ShowMenuItem

public void ShowMenuItem(java.lang.String strMenuName,
                         java.lang.String strMenuItemName,
                         boolean bShow)
                  throws java.lang.Exception

Show/hide menuitem with given name in the menu with given name

Parameters:

strMenuName - The name of the menu in which the menu item is present

strMenuItemName - The name of the menu item to Show/hide

bShow - If true, the menu item is shown else hidden

Throws:

java.lang.Exception

ShowMenuItems

public void ShowMenuItems(java.lang.String strMenuName,
                          java.lang.String[] arrstrMenuItemName,
                          boolean bShow)
                   throws java.lang.Exception

Enable/Disable array of menuitem with given names present in the menu

Parameters:

strMenuName - The name of the menu in which the menu items are present

arrstrMenuItemName - The array of names of the menu items to enable/disable

bShow - If true, the menu is shown else hidden

Throws:

java.lang.Exception