com.qoppa.pdfEditor.contextmenus

Class ContentEditContextMenu

java.lang.Object

com.qoppa.pdfEditor.contextmenus.ContentEditContextMenu

public class ContentEditContextMenu
extends Object

This class manages the context menu shown when the content editing tool is active. A host application can use this class to manage the items that show in the context menu.

Author:

Qoppa Software

Constructor Summary

Constructors

Constructor and Description
ContentEditContextMenu()

Method Summary

Modifier and Type	Method and Description
JMenuItem	getAlignBottom()
JMenuItem	getAlignCenter()
JMenuItem	getAlignHeight()
JMenuItem	getAlignLeft()
JMenu	getAlignmentMenu() The Alignment menu.
JMenuItem	getAlignmentMenuItemyName(String name)
JMenuItem	getAlignMiddle()
JMenuItem	getAlignPageHorzCenter()
JMenuItem	getAlignPageVertCenter()
JMenuItem	getAlignRight()
JMenuItem	getAlignTop()
JMenuItem	getAlignWidth()
JMenuItem	getAlignWidthAndHeight()
JMenuItem	getBringForwardMenuItem() The Bring Forward menu item.
JMenuItem	getBringToFrontMenuItem() The Move To Front menu item.
JMenuItem	getDistributeHorizontally()
JMenuItem	getDistributeVertically()
JMenuItem	getJmiCopy() Returns the "Copy" menu item.
JMenuItem	getJmiCut() Returns the "Cut" menu item.
JMenuItem	getJmiDelete() Returns the Delete menu item.
JMenuItem	getJmiMarkForRedaction() Returns the "Mark for redaction" menu item.
JMenuItem	getJmiPaste() Returns the "Paste" menu item.
JMenuItem	getJmiProperties() Return the Properties menu item.
JMenuItem	getJmiRedact() Returns the Redact menu item.
JMenuItem	getJmiReloadImage() Returns the "Reload Image File" menu item.
JMenuItem	getJmiReplaceImage() Returns the "Replace Image..." menu item.
JMenuItem	getJmiSaveImageAs() Returns the "Save Image As..." menu item.
JSeparator	getJSep1() Returns the first JSeparator in the menu.
JSeparator	getJSep2() Returns the second JSeparator in the menu.
JMenu	getMoveMenu() The Move menu.
JPopupMenu	getPopupMenu() Retrieves the actual JPopupMenu that will be shown when a user right-clicks.
JMenuItem	getSendBackwardsMenuItem() The Send Backward menu item.
JMenuItem	getSendToBackMenuItem() The Move To Back 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

ContentEditContextMenu

public ContentEditContextMenu()

Method Detail

getPopupMenu

public JPopupMenu getPopupMenu()

Retrieves the actual JPopupMenu that will be shown when a user right-clicks.

getJmiDelete

public JMenuItem getJmiDelete()

Returns the Delete menu item.

getJmiProperties

public JMenuItem getJmiProperties()

Return the Properties menu item.

getJmiRedact

public JMenuItem getJmiRedact()

Returns the Redact menu item.

getJmiMarkForRedaction

public JMenuItem getJmiMarkForRedaction()

Returns the "Mark for redaction" menu item.

Returns:

getJmiSaveImageAs

public JMenuItem getJmiSaveImageAs()

Returns the "Save Image As..." menu item.

getJmiReplaceImage

public JMenuItem getJmiReplaceImage()

Returns the "Replace Image..." menu item.

Returns:

the "Replace Image..." menu item.

getJmiReloadImage

public JMenuItem getJmiReloadImage()

Returns the "Reload Image File" menu item.

Returns:

the "Reload Image File" menu item.

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

getJmiCut

public JMenuItem getJmiCut()

Returns the "Cut" menu item.

Returns:

the "Cut" menu item.

getJmiCopy

public JMenuItem getJmiCopy()

Returns the "Copy" menu item.

Returns:

the "Copy" menu item.

getJmiPaste

public JMenuItem getJmiPaste()

Returns the "Paste" menu item.

Returns:

the "Paste" menu item.

getJSep1

public JSeparator getJSep1()

Returns the first JSeparator in the menu.

Returns:

the first JSeparator in the menu.

getJSep2

public JSeparator getJSep2()

Returns the second JSeparator in the menu.

Returns:

the second JSeparator in the menu.

getAlignLeft

public JMenuItem getAlignLeft()

getAlignRight

public JMenuItem getAlignRight()

getAlignCenter

public JMenuItem getAlignCenter()

getAlignTop

public JMenuItem getAlignTop()

getAlignBottom

public JMenuItem getAlignBottom()

getAlignMiddle

public JMenuItem getAlignMiddle()

getAlignPageHorzCenter

public JMenuItem getAlignPageHorzCenter()

getAlignPageVertCenter

public JMenuItem getAlignPageVertCenter()

getDistributeHorizontally

public JMenuItem getDistributeHorizontally()

getDistributeVertically

public JMenuItem getDistributeVertically()

getAlignWidth

public JMenuItem getAlignWidth()

getAlignHeight

public JMenuItem getAlignHeight()

getAlignWidthAndHeight

public JMenuItem getAlignWidthAndHeight()

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 changing the relative Z-order or foreground order of overlapping content.

Returns:

the MoveMenu

getBringToFrontMenuItem

public JMenuItem getBringToFrontMenuItem()

The Move To Front menu item. When pressed, the currently selected content is brought to the top of foreground, resulting in that content appearing in front of all other overlapping content.

Returns:

the MoveToFrontMenuItem

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 MoveToFrontMenuItem

getSendToBackMenuItem

public JMenuItem getSendToBackMenuItem()

The Move To Back menu item. When pressed, the currently selected content is moved to the rear of the foreground, causing that content to appear behind all other overlapping content.

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 MoveToFrontMenuItem

getAlignmentMenuItemyName

public JMenuItem getAlignmentMenuItemyName(String name)