java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPopupMenu
org.mitre.cvw.ObjectMenu
- All Implemented Interfaces:
- javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.MenuElement, java.io.Serializable
- Direct Known Subclasses:
- DocMenu, FormFolderMenu, GroupMenu, RecorderMenu, RemoteAccessMenu, RoomKeyMenu, StandardMenu, StandardNonSCMenu, UnknownMenu, UserMenu
- public abstract class ObjectMenu
- extends javax.swing.JPopupMenu
Interface for creating menus.
This class provides the basis for building different object menu types in CVW.
- Version:
- 1.1
| Nested classes inherited from class javax.swing.JPopupMenu |
javax.swing.JPopupMenu.AccessibleJPopupMenu, javax.swing.JPopupMenu.Separator |
| Nested classes inherited from class javax.swing.JComponent |
javax.swing.JComponent.AccessibleJComponent |
| Nested classes inherited from class java.awt.Container |
java.awt.Container.AccessibleAWTContainer |
| Nested classes inherited from class java.awt.Component |
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy |
| Fields inherited from class javax.swing.JPopupMenu |
|
| Fields inherited from class java.awt.Container |
|
|
Method Summary |
boolean |
callFunction(java.lang.String function)
Event callback method
Processes a right mouse menu selection by invoking the appropriate function
in the CVWObject this menu is representing. |
void |
disableItem(int index)
Disable a particular item based on position
This method will gray-out the index entered. |
void |
disableItem(java.lang.String item_name)
Disable a particular item in the menu
This method will gray-out a menu item. |
int |
getGrayoutMask(int mask_position)
Determine a mask to apply. |
abstract void |
initMenu(int dot)
Particular invocation of the menu
This function has to be overridden in classes that extend this class. |
boolean |
isShowing()
Check to see if the menu is already visible. |
protected void |
setDisabledItems(int disable_mask)
Disable items in the menu according to a mask
The bits in the mask will correspond to the items in the menu. |
void |
setShowing(boolean showing)
Set the visible indicator variable |
void |
show(java.awt.Component obj,
int x,
int y)
Display the menu at a given location. |
void |
show(java.awt.Component obj,
int disable_mask,
int x,
int y)
Display the menu at a given location |
| Methods inherited from class javax.swing.JPopupMenu |
add, add, add, addPopupMenuListener, addSeparator, createActionChangeListener, createActionComponent, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getComponent, getComponentAtIndex, getComponentIndex, getDefaultLightWeightPopupEnabled, getInvoker, getLabel, getMargin, getPopupMenuListeners, getSelectionModel, getSubElements, getUI, getUIClassID, insert, insert, isBorderPainted, isLightWeightPopupEnabled, isPopupTrigger, isVisible, menuSelectionChanged, pack, paramString, processKeyEvent, processMouseEvent, remove, removePopupMenuListener, setBorderPainted, setDefaultLightWeightPopupEnabled, setInvoker, setLabel, setLightWeightPopupEnabled, setLocation, setPopupSize, setPopupSize, setSelected, setSelectionModel, setUI, setVisible, updateUI |
| Methods inherited from class javax.swing.JComponent |
addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update |
| Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isValid, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, 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, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle |
object
CVWObject object
isShowing
boolean isShowing
masks
int[] masks
ObjectMenu
public ObjectMenu(CVWObject callback)
- constructor
ObjectMenu
public ObjectMenu()
- constructor
show
public void show(java.awt.Component obj,
int disable_mask,
int x,
int y)
- Display the menu at a given location
show
public void show(java.awt.Component obj,
int x,
int y)
- Display the menu at a given location. Do not disable any items
callFunction
public boolean callFunction(java.lang.String function)
- Event callback method
Processes a right mouse menu selection by invoking the appropriate function
in the CVWObject this menu is representing.
isShowing
public boolean isShowing()
- Check to see if the menu is already visible.
setShowing
public void setShowing(boolean showing)
- Set the visible indicator variable
setDisabledItems
protected void setDisabledItems(int disable_mask)
- Disable items in the menu according to a mask
The bits in the mask will correspond to the items in the menu.
A set bit will disable the item.
disableItem
public void disableItem(java.lang.String item_name)
- Disable a particular item in the menu
This method will gray-out a menu item.
disableItem
public void disableItem(int index)
- Disable a particular item based on position
This method will gray-out the index entered.
getGrayoutMask
public int getGrayoutMask(int mask_position)
- Determine a mask to apply.
A menu may have a gray-out mask to apply in certain situations. (Document checked out or
not). This function will allow these masks to be queried.
As a menu is created, it may change the values in masks[] above.
Current masks available:
0 - Checked out object.
1 - Non-checked out object.
initMenu
public abstract void initMenu(int dot)
- Particular invocation of the menu
This function has to be overridden in classes that extend this class. Their initMenu
function will add the required items to the menu.
JAVADOC | 
SOURCE | 
DOWNLOAD | NESTED | FIELD | CONSTR | METHOD