com.qoppa.pdfViewer.contextmenus

Class PageViewContextMenu

java.lang.Object

com.qoppa.pdfViewer.contextmenus.PageViewContextMenu

Direct Known Subclasses:

PageViewContextMenuNotes

public class PageViewContextMenu
extends Object

The PageViewContextMenu represents the popup menu that is displayed when the user right clicks on the PageViewPanel and the Text Selection Tool is not active. A reference to the PageViewContextMenu of the PDFViewerBean can be obtained with PDFViewerBean.getPageViewPanel().getPageContextMenu(). By default, this menu is composed of: HandToolMenuItem, TextSelectionMenuItem, and ZoomToolMenuItem. These items may be modified by retrieving them with their individual getter methods. The contents of the PageViewContextMenu may be accessed and modified with the getPopupMenu() method. For example, to add a new menu item to the popup menu:

     PDFViewerBean viewerBean = new PDFViewerBean();
     PageViewContextMenu contextMenu = viewerBean.getPageViewPanel().getPageContextMenu();
     JMenuItem menuItem = new JMenuItem("My Menu Item");
     contextMenu.getPopupMenu().add(menuItem);
 

Author:

Qoppa Software

Constructor Summary

Constructors

Constructor and Description
PageViewContextMenu() Constructs a new ViewerContextMenu

Method Summary

Modifier and Type	Method and Description
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.
JPopupMenu	getPopupMenu() Retrieves the actual JPopupMenu with the copyMenuItem either visible or not
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 whether or not the JPopupMenu for the context menu in getPopupMenu() is active.
void	setActive(boolean active) Sets whether or not the JPopupMenu for the context menu in getPopupMenu() is active.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageViewContextMenu

public PageViewContextMenu()

Constructs a new ViewerContextMenu

Method Detail

getPopupMenu

public JPopupMenu getPopupMenu()

Retrieves the actual JPopupMenu with the copyMenuItem either visible or not

getHandToolMenuItem

public JCheckBoxMenuItem getHandToolMenuItem()

The Hand Tool menu item for the page view context menu. This item is the actual item used by the JPopupMenu, so it is mutable; the setVisible(...) method may be called to change the visibility of this item in the JPopupMenu, setText(...) will modify the label of the corresponding menuItem, etc.

Returns:

Hand Tool menu item

getTextSelMenuItem

public JCheckBoxMenuItem getTextSelMenuItem()

The Text Select menu item for the page view context menu. This item is the actual item used by the JPopupMenu, so it is mutable; the setVisible(...) method may be called to change the visibility of this item in the JPopupMenu, setText(...) will modify the label of the corresponding menuItem, etc.

Returns:

Text Select menu item

getZoomToolMenuItem

public JCheckBoxMenuItem getZoomToolMenuItem()

The Zoom Tool menu item for the page view context menu. This item is the actual item used by the JPopupMenu, so it is mutable; the setVisible(...) method may be called to change the visibility of this item in the JPopupMenu, setText(...) will modify the label of the corresponding menuItem, etc.

Returns:

Zoom Tool menu item

clearSelection

public void clearSelection()

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

setActive

public void setActive(boolean active)

Sets whether or not the JPopupMenu for the context menu in getPopupMenu() is active. A JPopupMenu that is not active will not be shown when the JPopupMenu is triggered.

Parameters:

active - true to set the JPopupMenu active, false otherwise

isActive

public boolean isActive()

Returns whether or not the JPopupMenu for the context menu in getPopupMenu() is active. A JPopupMenu that is not active will not be shown when the JPopupMenu is triggered.

Returns:

true if the JPopupMenu is active, false otherwise