AnnotationContextMenu (Qoppa jPDFEditor API)

java.lang.Object
- com.qoppa.pdfNotes.contextmenus.AnnotationContextMenu

```
public class AnnotationContextMenu
extends Object
```
The AnnotationContextMenu represents the context menu displayed when a user right-clicks on an AnnotationComponent or a row in the CommentPanelNotes. There is one instance of this class per PDFNotesBean, it can be retrieved with PDFNotesBean.getCommentPanelNotes().getAnnotContextMenu().
Different context menus are displayed depending on the selected annotations. All possible menu items are represented in this class and can be retrieved by the provided getters. When initially constructed, all menu items in this class are added to the JPopupMenu. After the JPopupMenu is constructed, only the visibility and enabled state of its menu items can be modified, the actual contents of the list of items can not. Therefore, any changes developers make to the JPopupMenu's component list will be persistent. This is the recommended way to either add or remove components to the AnnotationContextMenu. The contents of the AnnotationContextMenu may be accessed and modified with the getPopupMenu() method. For example, to add a new menu item to the popup menu:
```
     PDFNotesBean notesBean = new PDFNotesBean();
     AnnotationContextMenu contextMenu = notesBean.getCommentPanelNotes().getAnnotContextMenu();
     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

AnnotationContextMenu()

Constructors
Constructor and Description
`AnnotationContextMenu()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JMenu`	`getAlignmentMenu()` The Alignment menu.
`JMenuItem`	`getBringForwardMenuItem()` The Bring Forward menu item.
`JMenuItem`	`getCheckmarkMenuItem()` The CheckmarkMenuItem.
`JMenuItem`	`getConvertToPerimeterMenuItem()` The Convert to Perimeter menu item.
`JMenuItem`	`getCopyMenuItem()` The Copy menu item.
`JMenuItem`	`getCopyNoteMenuItem()` The Copy Note menu item.
`JMenuItem`	`getCopyTextMenuItem()` The Copy Text menu item.
`JMenuItem`	`getCreatePerimeterMenuItem()` The Create Perimeter menu item.
`JMenuItem`	`getCutMenuItem()` The Cut menu item.
`JMenuItem`	`getDeleteMenuItem()` The Delete menu item.
`JSeparator`	`getFlattenDivider()` The JSeparator that follows the FlattenMenuItem This Separator is only visible if the FlattenMenuItem or DeleteMenuItem or CopyMenuItem or CutMenuItem are visible
`JMenuItem`	`getFlattenMenuItem()` The Flatten menu item.
`JSeparator`	`getGroupDivider()` The JSeparator that follows the GroupMenuItem This Separator is only visible if the GroupMenuItem is visible
`JMenuItem`	`getGroupMenuItem()` The Group menu item.
`JSeparator`	`getMoveAndAlignSeparator()` The JSeparator that follows the Alignment and Move menus.
`JMenu`	`getMoveMenu()` The Move menu.
`JMenuItem`	`getMoveToBackMenuItem()` The Move To Back menu item.
`JMenuItem`	`getMoveToFrontMenuItem()` The Move To Front menu item.
`JSeparator`	`getNoteDivider()` The JSeparator that follows the ShowNoteMenuItem This Separator is only visible if the ShowNoteMenuItem is visible
`JMenuItem`	`getOpenAttachmentMenuItem()` The Open attachment menu item.
`JMenuItem`	`getPasteMenuItem()` The Paste menu item.
`JPopupMenu`	`getPopupMenu()` Returns the actual JPopupMenu.
`JMenuItem`	`getPropertiesMenuItem()` The Properties menu item.
`JSeparator`	`getPropertiesSeparator()` The JSeparator that follows the PropertiesMenuItem.
`JMenuItem`	`getResetMenuItem()` The Reset menu item.
`JSeparator`	`getReviewDivider()` The JSeparator that follows the ReviewMenu This Separator is only visible if the ReviewMenu or the CheckMarkMenuItem are visible
`JMenu`	`getReviewMenu()` The Review status menu.
`JMenuItem`	`getSaveAttachmentMenuItem()` The Save attachment menu item.
`JMenuItem`	`getSendBackwardsMenuItem()` The Send Backward menu item.
`JMenuItem`	`getShowNoteMenuItem()` The ShowNoteMenuItem.
`JMenuItem`	`getSoundMenuItem()` The Play sound menu item.
`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
  - AnnotationContextMenu
```
public AnnotationContextMenu()
```
- 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
  - getShowNoteMenuItem
```
public JMenuItem getShowNoteMenuItem()
```
    The ShowNoteMenuItem. When pressed, this will show the popup note associated with the selected annotation.
    
    This MenuItem is invisible if the selected annotation does not support popup notes. It will be visible but disabled if multiple annotations are selected.
    
    Returns:
    
    the ShowNoteMenuItem
  - getCheckmarkMenuItem
```
public JMenuItem getCheckmarkMenuItem()
```
    The CheckmarkMenuItem. When pressed, this mark annotations with a checkmark, if they currently are unchecked. If checked, it will remove the checkmark.
    
    This MenuItem is invisible if AnnotationTools.isReviewEnabled() is false.
    
    Returns:
    
    the CheckmarkMenuItem
  - getReviewMenu
```
public JMenu getReviewMenu()
```
    The Review status menu. This menu contains review items for setting the annotations' review status.
    
    This MenuItem is invisible if AnnotationTools.isReviewEnabled() is false.
    
    Returns:
    
    the ReviewMenu
  - getGroupMenuItem
```
public JMenuItem getGroupMenuItem()
```
    The Group menu item. When pressed, the currently selected annotations are grouped. If the currently selected annotations already belong to the same group, they are ungrouped.
    
    This MenuItem is invisible if AnnotationTools.isGroupingEnabled() is false.
    It is disabled if less than two annotations are selected, or the selection contains annotations that are not groupable.
    
    Returns:
    
    the GroupMenuItem
  - getCutMenuItem
```
public JMenuItem getCutMenuItem()
```
    The Cut menu item. When pressed, the currently selected annotations are copied to the system clipboard and deleted.
    
    This MenuItem is disabled if any selected annotations are unable to be modified.
    
    Returns:
    
    the CutMenuItem
  - getCopyMenuItem
```
public JMenuItem getCopyMenuItem()
```
    The Copy menu item. When pressed, the currently selected annotations are copied to the system clipboard
    
    Returns:
    
    the CopyMenuItem
  - getPasteMenuItem
```
public JMenuItem getPasteMenuItem()
```
    The Paste menu item. When pressed, anything in the system clipboard will be pasted.
    
    Returns:
    
    the PasteMenuItem
  - getDeleteMenuItem
```
public JMenuItem getDeleteMenuItem()
```
    The Delete menu item. When pressed, the currently selected annotations are deleted.
    
    This MenuItem is invisible if AnnotationTools.isDeleteEnabled() is false.
    It is disabled if any selected annotations are unable to be modified.
    
    Returns:
    
    the DeleteMenuItem
  - getFlattenMenuItem
```
public JMenuItem getFlattenMenuItem()
```
    The Flatten menu item. When pressed, the currently selected annotations are flattened.
    
    This MenuItem is invisible if AnnotationTools.isFlatteningEnabled() is false or an unflattenable annotation is selected.
    It is disabled if any selected annotations are unable to be modified.
    
    Returns:
    
    the FlattenMenuItem
  - getResetMenuItem
```
public JMenuItem getResetMenuItem()
```
    The Reset menu item. Only shows for widgets. When clicked, will reset the widget to its field's default value.
    
    Returns:
    
    the FlattenMenuItem
  - getAlignmentMenu
```
public JMenu getAlignmentMenu()
```
    The Alignment menu. This menu contains options for realigning the selected annotations.
    
    Returns:
    
    the AlignmentMenu
  - getMoveMenu
```
public JMenu getMoveMenu()
```
    The Move menu. This menu contains options for moving the selected annotation to the foreground/background.
    
    This Menu is visible only if one annotation is selected.
    
    Returns:
    
    the MoveMenu
  - getMoveToFrontMenuItem
```
public JMenuItem getMoveToFrontMenuItem()
```
    The Move To Front menu item. When pressed, the currently selected annotation is brought to the foreground.
    
    This MenuItem is disabled if the selected annotation is already the front most annotation on the page.
    
    Returns:
    
    the MoveToFrontMenuItem
  - getMoveToBackMenuItem
```
public JMenuItem getMoveToBackMenuItem()
```
    The Move To Back menu item. When pressed, the currently selected annotation is moved to the background.
    
    This MenuItem is disabled if the selected annotation is already the back most annotation on the page.
    
    Returns:
    
    the MoveToBackMenuItem
  - getSendBackwardsMenuItem
```
public JMenuItem getSendBackwardsMenuItem()
```
    The Send Backward menu item. When pressed, the currently selected content is sent backwards one place in relative foreground order, resulting in that content appearing behind a previously overlapped item of content if present.
    
    Returns:
    
    the SendBackwardsMenuItem
  - getBringForwardMenuItem
```
public JMenuItem getBringForwardMenuItem()
```
    The Bring Forward menu item. When pressed, the currently selected content is brought forward one place in relative foreground order, resulting in that content appearing in front of the next overlapping item of content if present.
    
    Returns:
    
    the BringForwardMenuItem
  - getPropertiesMenuItem
```
public JMenuItem getPropertiesMenuItem()
```
    The Properties menu item. When pressed, the properties dialog for the selected annotation is displayed.
    
    This MenuItem is disabled if multiple annotations are selected.
    
    Returns:
    
    the FlattenMenuItem
  - getSoundMenuItem
```
public JMenuItem getSoundMenuItem()
```
    The Play sound menu item. When pressed, plays the sound for the selected Sound.
    
    This menu item is only visible if the only selected annotation is a Sound.
    
    Returns:
    
    the SoundMenuItem
  - getOpenAttachmentMenuItem
```
public JMenuItem getOpenAttachmentMenuItem()
```
    The Open attachment menu item. When pressed, plays opens the attached doc for the FileAttachment.
    
    This menu item is only visible if the only selected annotation is a FileAttachment.
    
    Returns:
    
    the OpenAttachmentItem
  - getSaveAttachmentMenuItem
```
public JMenuItem getSaveAttachmentMenuItem()
```
    The Save attachment menu item. When pressed, plays saves the attached doc for the FileAttachment.
    
    This menu item is only visible if the only selected annotation is a FileAttachment.
    
    Returns:
    
    the SaveAttachmentItem
  - getCreatePerimeterMenuItem
```
public JMenuItem getCreatePerimeterMenuItem()
```
    The Create Perimeter menu item. When pressed, creates a new perimeter annotation from the area annotation.
    
    This menu item is only visible if the selected annotation is an area annotation.
    
    Returns:
    
    the CreatePerimeterItem
  - getConvertToPerimeterMenuItem
```
public JMenuItem getConvertToPerimeterMenuItem()
```
    The Convert to Perimeter menu item. When pressed, converts the selected area annotation to a perimeter annotation.
    
    This menu item is only visible if the selected annotation is an area annotation.
    
    Returns:
    
    the ConvertToPerimeterItem
  - getNoteDivider
```
public JSeparator getNoteDivider()
```
    The JSeparator that follows the ShowNoteMenuItem
    
    This Separator is only visible if the ShowNoteMenuItem is visible
    
    Returns:
    
    the JSeparator
  - getReviewDivider
```
public JSeparator getReviewDivider()
```
    The JSeparator that follows the ReviewMenu
    
    This Separator is only visible if the ReviewMenu or the CheckMarkMenuItem are visible
    
    Returns:
    
    the JSeparator
  - getGroupDivider
```
public JSeparator getGroupDivider()
```
    The JSeparator that follows the GroupMenuItem
    
    This Separator is only visible if the GroupMenuItem is visible
    
    Returns:
    
    the JSeparator
  - getFlattenDivider
```
public JSeparator getFlattenDivider()
```
    The JSeparator that follows the FlattenMenuItem
    
    This Separator is only visible if the FlattenMenuItem or DeleteMenuItem or CopyMenuItem or CutMenuItem are visible
    
    Returns:
    
    the JSeparator
  - getMoveAndAlignSeparator
```
public JSeparator getMoveAndAlignSeparator()
```
    The JSeparator that follows the Alignment and Move menus. This Separator is only visible if the AlignmentMenu or MoveMenu is visible
    
    Returns:
    
    the JSeparator
  - getPropertiesSeparator
```
public JSeparator getPropertiesSeparator()
```
    The JSeparator that follows the PropertiesMenuItem. Since the PropertiesMenuItem is typically the last item on the list, this Separator is only visible if the PropertiesMenuItem is visible and the SaveAttachmentMenuItem or the OpenAttachmentMenuItem or the PlaySoundMenuItem are visible.
    
    Returns:
    
    the JSeparator
  - getCopyTextMenuItem
```
public JMenuItem getCopyTextMenuItem()
```
    The Copy Text menu item. When pressed, the text enclosed by the quadrilaterals of a TextMarkup annotation is copied to the clipboard
    
    Returns:
    
    the CopyTextMenuItem
  - getCopyNoteMenuItem
```
public JMenuItem getCopyNoteMenuItem()
```
    The Copy Note menu item. When pressed, the text from the annotation's note is copied to the clipboard.
    
    Returns:
    
    the CopyNoteMenuItem
  - 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

Class AnnotationContextMenu

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnnotationContextMenu

Method Detail

getPopupMenu

getShowNoteMenuItem

getCheckmarkMenuItem

getReviewMenu

getGroupMenuItem

getCutMenuItem

getCopyMenuItem

getPasteMenuItem

getDeleteMenuItem

getFlattenMenuItem

getResetMenuItem

getAlignmentMenu

getMoveMenu

getMoveToFrontMenuItem

getMoveToBackMenuItem

getSendBackwardsMenuItem

getBringForwardMenuItem

getPropertiesMenuItem

getSoundMenuItem

getOpenAttachmentMenuItem

getSaveAttachmentMenuItem

getCreatePerimeterMenuItem

getConvertToPerimeterMenuItem

getNoteDivider

getReviewDivider

getGroupDivider

getFlattenDivider

getMoveAndAlignSeparator

getPropertiesSeparator

getCopyTextMenuItem

getCopyNoteMenuItem

setActive

isActive