com.qoppa.pdfEditor.contextmenus

Class BookmarkContextMenu

java.lang.Object

com.qoppa.pdfEditor.contextmenus.BookmarkContextMenu

public class BookmarkContextMenu
extends Object

The BookmarkContextMenu represents the context menu displayed when a user right-clicks on a bookmark in BookmarkPanelEditor. There is one instance of this class per PDFEditorBean. It can be retrieved with PDFEditorBean.getBookmarkPanelEditor().getBookmarkContextMenu().

The contents of the BookmarkContextMenu may be accessed and modified with the getPopupMenu() method. For example, to add a new menu item to the popup menu:

     PDFEditorBean editorBean = new PDFEditorBean();
     BookmarkContextMenu contextMenu = editorBean.getBookmarkPanelEditor().getBookmarkContextMenu();
     JMenuItem menuItem = new JMenuItem("My Menu Item");
     contextMenu.getPopupMenu().add(menuItem);
 

The visibility and enabled state of the preset menu items is adjusted each time the JPopupMenu is displayed. The behavior of these adjustments is documented on each individual getter method. If a developer desires a different behavior for a particular item, they may remove the item and add their own. Or, they can add a PopupMenuListener to the JPopupMenu. Their Listener will be notified after any adjustments have been completed, and they can make adjustments as they wish.

Author:

Qoppa Software

Constructor Summary

Constructors

Constructor and Description
BookmarkContextMenu()

Method Summary

Methods

Modifier and Type	Method and Description
JMenuItem	getAddAfterMenuItem() The AddAfterMenuItem.
JMenuItem	getAddBeforeMenuItem() The AddBeforeMenuItem.
JMenuItem	getAddChildMenuItem() The AddChildMenuItem.
JMenu	getAddMenu() The AddMenu.
JSeparator	getAddMenuSeparator() The AddMenuSeparator.
JMenuItem	getCutMenuItem() The CutMenuItem.
JMenuItem	getDeleteMenuItem() The DeleteMenuItem.
JMenuItem	getPasteAfterMenuItem() The PasteAfterMenuItem.
JMenuItem	getPasteMenuItem() The PasteMenuItem.
JPopupMenu	getPopupMenu() Returns the actual JPopupMenu.
JMenuItem	getPropertiesMenuItem() The PropertiesMenuItem.
JMenuItem	getRenameMenuItem() The RenameMenuItem.
JMenuItem	getSetDestinationMenuItem() The SetDestinationMenuItem.
JSeparator	getSetDestinationSeparator() The SetDestinationSeparator.
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

BookmarkContextMenu

public BookmarkContextMenu()

Method Detail

getPopupMenu

public JPopupMenu getPopupMenu()

Returns the actual JPopupMenu. The list of components for this menu is constructed when JPopupMenu is instantiated, and is not modified afterwards. Therefore, any modifications that developers make to this list will be persistent.

Returns:

the PopupMenu

getCutMenuItem

public JMenuItem getCutMenuItem()

The CutMenuItem. When pressed the selected bookmark will be cut from the tree. This item will be invisible if editing is not enabled.

Returns:

the CutMenuItem

getPasteMenuItem

public JMenuItem getPasteMenuItem()

The PasteMenuItem. When pressed the bookmark will be pasted as a child of the selected bookmark. This item will be invisible if editing is not enabled.

Returns:

the PasteMenuItem

getPasteAfterMenuItem

public JMenuItem getPasteAfterMenuItem()

The PasteAfterMenuItem. When pressed the bookmark will be pasted after the selected bookmark. This item will be invisible if editing is not enabled.

Returns:

the PasteAfterMenuItem

getDeleteMenuItem

public JMenuItem getDeleteMenuItem()

The DeleteMenuItem. When pressed the selected bookmark will be deleted from the tree. This item will be invisible if editing is not enabled.

Returns:

the DeleteMenuItem

getRenameMenuItem

public JMenuItem getRenameMenuItem()

The RenameMenuItem. When pressed a dialog will be displayed to rename the selected bookmark. This item will be invisible if editing is not enabled.

Returns:

the RenameMenuItem

getPropertiesMenuItem

public JMenuItem getPropertiesMenuItem()

The PropertiesMenuItem. When pressed the properties dialog will be displayed for the selected bookmark.

Returns:

the PropertiesMenuItem

getSetDestinationMenuItem

public JMenuItem getSetDestinationMenuItem()

The SetDestinationMenuItem. When pressed the destination for the current bookmark will be set to the current page. This item will be invisible if editing is not enabled.

Returns:

the SetDestinationMenuItem

getAddMenu

public JMenu getAddMenu()

The AddMenu. A JMenu containing the AddBeforeMenuItem, AddAfterMenuItem, and AddChildMenuItem. This item will be invisible if editing is not enabled.

Returns:

the AddMenu

getAddBeforeMenuItem

public JMenuItem getAddBeforeMenuItem()

The AddBeforeMenuItem. When pressed a new bookmark will be added before the selected bookmark. This item will be invisible if editing is not enabled.

Returns:

the AddBeforeMenuItem

getAddAfterMenuItem

public JMenuItem getAddAfterMenuItem()

The AddAfterMenuItem. When pressed a new bookmark will be added after the selected bookmark. This item will be invisible if editing is not enabled.

Returns:

the AddAfterMenuItem

getAddChildMenuItem

public JMenuItem getAddChildMenuItem()

The AddChildMenuItem. When pressed a new bookmark will be added as a child of the selected bookmark. This item will be invisible if editing is not enabled.

Returns:

the AddChildMenuItem

getAddMenuSeparator

public JSeparator getAddMenuSeparator()

The AddMenuSeparator. A JSeparator that appears above the AddMenu. This item will be invisible if editing is not enabled.

Returns:

AddMenuSeparator

getSetDestinationSeparator

public JSeparator getSetDestinationSeparator()

The SetDestinationSeparator. A JSeparator that appears above the SetDestinationMenuItem. This item will be invisible if editing is not enabled.

Returns:

SetDestinationSeparator

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