com.qoppa.pdfViewer
Class ViewerContextMenu

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPopupMenu
                  com.qoppa.pdfViewer.ViewerContextMenu

All Implemented Interfaces:

Accessible, ActionListener, EventListener, IContextMenu, ImageObserver, MenuContainer, MenuElement, Serializable

Direct Known Subclasses:

NotesContextMenu

public class ViewerContextMenu

extends JPopupMenu

implements ActionListener, IContextMenu

This is the popup menu that is shown when a user right-clicks on the content pane of the viewer. This class allows the host application to manage the menu by removing any of the entries, or adding their own entries. Some of the tools in jPDFViewer, such as the text selection tool, use this object to add their own entries during the time that the tool is active.

Author:

Qoppa Software

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPopupMenu

JPopupMenu.Separator

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Field Summary

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 java.awt.image.ImageObserver

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

Method Summary

void	actionPerformed(ActionEvent ae) Handle the actions of the default menu items.
void	clearSelection() This method clears the Hand Tool, Text Select, and Zoom Tool menu item check boxes.
JCheckBoxMenuItem	getHandToolMenuItem() The Hand Tool menu item for the page view context menu.
JCheckBoxMenuItem	getTextSelMenuItem() The Text Select menu item for the page view context menu.
JCheckBoxMenuItem	getZoomToolMenuItem() The Zoom Tool menu item for the page view context menu.
boolean	isActive() Returns the Active flag.
void	setActive(boolean active) Sets the value of the Active flag.
void	show(Component invoker, int x, int y) This method is overridden so that if no components are visible, the popup menu will not be shown.

Methods inherited from class javax.swing.JPopupMenu

add, add, add, addPopupMenuListener, addSeparator, getAccessibleContext, getComponent, getComponentAtIndex, getComponentIndex, getDefaultLightWeightPopupEnabled, getInvoker, getLabel, getMargin, getPopupMenuListeners, getSelectionModel, getSubElements, getUI, getUIClassID, insert, insert, isBorderPainted, isLightWeightPopupEnabled, isPopupTrigger, isVisible, menuSelectionChanged, pack, 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, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, 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, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, 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, 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, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, 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, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, 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

Methods inherited from interface com.qoppa.pdfViewer.IContextMenu

add, addPopupMenuListener, addSeparator, getComponent, getComponentCount, getComponentIndex, insert, remove, removePopupMenuListener

Method Detail

actionPerformed

public void actionPerformed(ActionEvent ae)

Handle the actions of the default menu items. Any actions caused by any menu items added by the host application will have to be handled by the application.

Specified by:

actionPerformed in interface ActionListener

Parameters:

ae - The action event.

getHandToolMenuItem

public JCheckBoxMenuItem getHandToolMenuItem()

The Hand Tool menu item for the page view context menu.

Returns:

Hand Tool menu item

getTextSelMenuItem

public JCheckBoxMenuItem getTextSelMenuItem()

The Text Select menu item for the page view context menu.

Returns:

Text Select menu item

getZoomToolMenuItem

public JCheckBoxMenuItem getZoomToolMenuItem()

The Zoom Tool menu item for the page view context menu.

Returns:

Zoom Tool menu item

show

public void show(Component invoker,
                 int x,
                 int y)

This method is overridden so that if no components are visible, the popup menu will not be shown.

clearSelection

public void clearSelection()

This method clears the Hand Tool, Text Select, and Zoom Tool menu item check boxes.

isActive

public boolean isActive()

Returns the Active flag. This flag determines whether the menu will be shown when the user right clicks on the viewer panel.

Returns:

The value of the active flag.

setActive

public void setActive(boolean active)

Sets the value of the Active flag. This flags determines whether the viewer context menu should be shown when the user right clicks on the viewer panel.

Parameters:

active - The new value of the Active flag.