com.qoppa.pdfNotes

Class AnnotToolbar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JToolBar

com.qoppa.pdfNotes.AnnotToolbar

All Implemented Interfaces:

MouseListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, SwingConstants

public class AnnotToolbar
extends JToolBar
implements MouseListener

This class implements the toolbar that provides annotation tools. The toolbar is displayed above the PDF document and provides tools to draw the following types of annotations: circles, lines, squares, pencil, free text, sticky notes, sound recording and links. The host application can get a reference to this object by calling PDFNotesBean.getAnnotToolbar. After getting a reference, the host application can call any of get getjb... methods to get a reference to any of the toolbar buttons to hide, disable or change them.

Author:

Qoppa Software

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JToolBar

JToolBar.Separator

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Component

Component.BaselineResizeBehavior

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 javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
AnnotToolbar() This method initializes the annotations toolbar.

Method Summary

Modifier and Type	Method and Description
static JMenuItem	createStampMenuItem(Image image, ImageCompression imageCompression) Creates a JMenuItem that draws a preview of the rubber stamp.
static JMenuItem	createStampMenuItem(RubberStamp stamp) Creates a JMenuItem that draws a preview of the rubber stamp.
static JMenuItem	createStampMenuItem(String text, Color color) Creates a JMenuItem that draws a preview of the rubber stamp.
JToggleButton	getjbArea() Returns the Area button.
JToggleButton	getjbArrow() Returns the arrow button.
JButton	getjbAttachFile() Returns the toolbar button that initiates the tool to attach files in a PDF document.
JToggleButton	getjbCallOut()
JToggleButton	getjbCircle() Returns the circle button.
JToggleButton	getjbCloud() Returns the polygon button.
JToggleButton	getjbCreateSignField() Returns the toolbar button that initiates the tool to create signature fields.
JToggleButton	getjbDistance() Returns the Distance button.
JToggleButton	getjbFreeText() Returns the freetext button.
JToggleButton	getjbHighlight() This method initializes jbHighlight
JButton	getjbImage() Returns the image button.
JToggleButton	getjbLine() Returns the line button.
JToggleButton	getjbLink() Returns the link button.
JToggleButton	getjbNote() Returns the note button.
JToggleButton	getjbPencil() Returns the pencil button.
JToggleButton	getjbPerimeter() Returns the Perimeter button.
JToggleButton	getjbPolygon() Returns the polygon button.
JToggleButton	getjbPolyline() Returns the polyline button.
JToggleButton	getjbSound() Returns the sound button.
JToggleButton	getjbSquare() Returns the square button.
JToggleButton	getjbStamp() Returns the stamp button.
JToggleButton	getjbTextCrossout() This method initializes jbTextCrossout
JToggleButton	getjbTextHighlight() This method initializes jbTextHighlight
JToggleButton	getjbTextInsert() Returns the caret button.
JToggleButton	getjbTextReplacement() Returns the toolbar button that initiates the tool to create a caret text markup annotation.
JToggleButton	getjbTextSquiggly() Returns the toolbar button that initiates the tool to create a squiggly text markup annotation.
JToggleButton	getjbTextUnderline() This method initializes ToolbarButton
JToggleButton	getjbTypeWriter() Returns the typewriter button.
JMenuItem	getJcbmToolSticky() This method initializes jcbmToolSticky
JPopupMenu	getJmAddStamps() This method initializes jmAddStamps
JMenuItem	getJmiAddStampApproved() This method initializes jmiAddStampApproved
JMenuItem	getJmiAddStampAsIs() This method initializes jmiAddStampAsIs
JMenuItem	getJmiAddStampCompleted() This method initializes jmiAddStampCompleted
JMenuItem	getJmiAddStampConfidential() This method initializes jmiAddStampConfidential
JMenuItem	getJmiAddStampDepartmental() This method initializes jmiAddStampDepartmental
JMenuItem	getJmiAddStampDraft() This method initializes jmiAddStampDraft
JMenuItem	getJmiAddStampExperimental() This method initializes jmiAddStampExperimental
JMenuItem	getJmiAddStampExpired() This method initializes jmiAddStampExpired
JMenuItem	getJmiAddStampFinal() This method initializes jmiAddStampFinal
JMenuItem	getJmiAddStampForComment() This method initializes jmiAddStampForComment
JMenuItem	getJmiAddStampForPublicRelease() This method initializes jmiAddStampForPublicRelease
JMenuItem	getJmiAddStampInformationOnly() This method initializes jmiAddStampInformationOnly
JMenuItem	getJmiAddStampNotApproved() This method initializes jmiAddStampNotApproved
JMenuItem	getJmiAddStampNotForPublicRelease() This method initializes jmiAddStampNotApproved
JMenuItem	getJmiAddStampPreliminaryResults() This method initializes jmiAddStampPreliminaryResults
JMenuItem	getJmiAddStampSold() This method initializes jmiAddStampNotApproved
JMenuItem	getJmiAddStampTopSecret() This method initializes jmiAddStampTopSecret
JMenuItem	getJmiAddStampVoid() This method initializes jmiAddStampVoid
JMenuItem	getJmiToolProperties() This method initializes jmiToolProperties
JPopupMenu	getJpmToolProperties() This method initializes jpmToolProperties
JSeparator	gettsSeparator1() Get the JSeparator that is between the Polyline and FreeText buttons.
JSeparator	gettsSeparator2() Get the JSeparator that is between the AttachFile and TextHighlight buttons.
JSeparator	gettsSeparator3() Get the JSeparator that is between the AreaHighlight and Distance buttons.
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)

Methods inherited from class javax.swing.JToolBar

add, addSeparator, addSeparator, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, isRollover, setBorderPainted, setFloatable, setLayout, setMargin, setOrientation, setRollover, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, 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, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotToolbar

public AnnotToolbar()

This method initializes the annotations toolbar.

Method Detail

getjbCircle

public JToggleButton getjbCircle()

Returns the circle button.

Returns:

Circle button.

getjbSquare

public JToggleButton getjbSquare()

Returns the square button.

Returns:

Square button.

getjbStamp

public JToggleButton getjbStamp()

Returns the stamp button.

Returns:

Stamp button.

getjbPolygon

public JToggleButton getjbPolygon()

Returns the polygon button.

Returns:

Polygon button.

getjbCloud

public JToggleButton getjbCloud()

Returns the polygon button.

Returns:

Polygon button.

getjbPolyline

public JToggleButton getjbPolyline()

Returns the polyline button.

Returns:

Polyline button.

gettsSeparator1

public JSeparator gettsSeparator1()

Get the JSeparator that is between the Polyline and FreeText buttons.

Returns:

JSeparator

getjbLine

public JToggleButton getjbLine()

Returns the line button.

Returns:

Line button.

getjbArrow

public JToggleButton getjbArrow()

Returns the arrow button.

Returns:

Arrow button.

getjbDistance

public JToggleButton getjbDistance()

Returns the Distance button.

Returns:

Distance button.

getjbPerimeter

public JToggleButton getjbPerimeter()

Returns the Perimeter button.

Returns:

Perimeter button.

getjbArea

public JToggleButton getjbArea()

Returns the Area button.

Returns:

Area button.

getjbPencil

public JToggleButton getjbPencil()

Returns the pencil button.

Returns:

Pencil button.

getjbFreeText

public JToggleButton getjbFreeText()

Returns the freetext button.

Returns:

FreeText button.

getjbCallOut

public JToggleButton getjbCallOut()

getjbTypeWriter

public JToggleButton getjbTypeWriter()

Returns the typewriter button.

Returns:

TypeWriter button.

getjbNote

public JToggleButton getjbNote()

Returns the note button.

Returns:

Note button.

getjbTextInsert

public JToggleButton getjbTextInsert()

Returns the caret button.

Returns:

Caret button.

getjbSound

public JToggleButton getjbSound()

Returns the sound button.

Returns:

Sound button.

getjbImage

public JButton getjbImage()

Returns the image button.

Returns:

Image button.

getjbLink

public JToggleButton getjbLink()

Returns the link button.

Returns:

Link button.

getJmiAddStampApproved

public JMenuItem getJmiAddStampApproved()

This method initializes jmiAddStampApproved

Returns:

javax.swing.JMenuItem

getJmiAddStampAsIs

public JMenuItem getJmiAddStampAsIs()

This method initializes jmiAddStampAsIs

Returns:

javax.swing.JMenuItem

getJmiAddStampConfidential

public JMenuItem getJmiAddStampConfidential()

This method initializes jmiAddStampConfidential

Returns:

javax.swing.JMenuItem

getJmiAddStampDepartmental

public JMenuItem getJmiAddStampDepartmental()

This method initializes jmiAddStampDepartmental

Returns:

javax.swing.JMenuItem

getJmiAddStampDraft

public JMenuItem getJmiAddStampDraft()

This method initializes jmiAddStampDraft

Returns:

javax.swing.JMenuItem

getJmiAddStampExperimental

public JMenuItem getJmiAddStampExperimental()

This method initializes jmiAddStampExperimental

Returns:

javax.swing.JMenuItem

getJmiAddStampExpired

public JMenuItem getJmiAddStampExpired()

This method initializes jmiAddStampExpired

Returns:

javax.swing.JMenuItem

getJmiAddStampFinal

public JMenuItem getJmiAddStampFinal()

This method initializes jmiAddStampFinal

Returns:

javax.swing.JMenuItem

getJmiAddStampForComment

public JMenuItem getJmiAddStampForComment()

This method initializes jmiAddStampForComment

Returns:

javax.swing.JMenuItem

getJmiAddStampForPublicRelease

public JMenuItem getJmiAddStampForPublicRelease()

This method initializes jmiAddStampForPublicRelease

Returns:

javax.swing.JMenuItem

getJmiAddStampNotApproved

public JMenuItem getJmiAddStampNotApproved()

This method initializes jmiAddStampNotApproved

Returns:

javax.swing.JMenuItem

getJmiAddStampNotForPublicRelease

public JMenuItem getJmiAddStampNotForPublicRelease()

This method initializes jmiAddStampNotApproved

Returns:

javax.swing.JMenuItem

getJmiAddStampSold

public JMenuItem getJmiAddStampSold()

This method initializes jmiAddStampNotApproved

Returns:

javax.swing.JMenuItem

getJmiAddStampTopSecret

public JMenuItem getJmiAddStampTopSecret()

This method initializes jmiAddStampTopSecret

Returns:

javax.swing.JMenuItem

getJmiAddStampInformationOnly

public JMenuItem getJmiAddStampInformationOnly()

This method initializes jmiAddStampInformationOnly

getJmiAddStampPreliminaryResults

public JMenuItem getJmiAddStampPreliminaryResults()

This method initializes jmiAddStampPreliminaryResults

getJmiAddStampVoid

public JMenuItem getJmiAddStampVoid()

This method initializes jmiAddStampVoid

getJmiAddStampCompleted

public JMenuItem getJmiAddStampCompleted()

This method initializes jmiAddStampCompleted

getJmAddStamps

public JPopupMenu getJmAddStamps()

This method initializes jmAddStamps

Returns:

javax.swing.JMenu

getjbTextHighlight

public JToggleButton getjbTextHighlight()

This method initializes jbTextHighlight

Returns:

javax.swing.JToggleButton

getjbTextUnderline

public JToggleButton getjbTextUnderline()

This method initializes ToolbarButton

Returns:

javax.swing.JToggleButton

getjbTextCrossout

public JToggleButton getjbTextCrossout()

This method initializes jbTextCrossout

Returns:

javax.swing.JToggleButton

getjbTextSquiggly

public JToggleButton getjbTextSquiggly()

Returns the toolbar button that initiates the tool to create a squiggly text markup annotation.

Returns:

javax.swing.JToggleButton

getjbTextReplacement

public JToggleButton getjbTextReplacement()

Returns the toolbar button that initiates the tool to create a caret text markup annotation.

Returns:

javax.swing.JToggleButton

getjbHighlight

public JToggleButton getjbHighlight()

This method initializes jbHighlight

Returns:

javax.swing.JToggleButton

gettsSeparator3

public JSeparator gettsSeparator3()

Get the JSeparator that is between the AreaHighlight and Distance buttons.

Returns:

JSeparator

getjbCreateSignField

public JToggleButton getjbCreateSignField()

Returns the toolbar button that initiates the tool to create signature fields.

Returns:

javax.swing.JButton

getjbAttachFile

public JButton getjbAttachFile()

Returns the toolbar button that initiates the tool to attach files in a PDF document.

Returns:

JButton

gettsSeparator2

public JSeparator gettsSeparator2()

Get the JSeparator that is between the AttachFile and TextHighlight buttons.

Returns:

JSeparator

getJpmToolProperties

public JPopupMenu getJpmToolProperties()

This method initializes jpmToolProperties

Returns:

javax.swing.JPopupMenu

getJmiToolProperties

public JMenuItem getJmiToolProperties()

This method initializes jmiToolProperties

Returns:

javax.swing.JMenuItem

getJcbmToolSticky

public JMenuItem getJcbmToolSticky()

This method initializes jcbmToolSticky

Returns:

javax.swing.JMenuItem

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

createStampMenuItem

public static JMenuItem createStampMenuItem(Image image,
                                            ImageCompression imageCompression)
                                     throws PDFException

Creates a JMenuItem that draws a preview of the rubber stamp.

Parameters:

image - a java image

imageCompression - the settings for the image

Returns:

The JMenuItem that draws a preview

Throws:

PDFException

createStampMenuItem

public static JMenuItem createStampMenuItem(String text,
                                            Color color)
                                     throws PDFException

Creates a JMenuItem that draws a preview of the rubber stamp.

Parameters:

text - the text to display in the stamp

color - the color of the text

Returns:

The JMenuItem that draws a preview

Throws:

PDFException

createStampMenuItem

public static JMenuItem createStampMenuItem(RubberStamp stamp)

Creates a JMenuItem that draws a preview of the rubber stamp.

Parameters:

stamp - the stamp to display

Returns:

The JMenuItem that draws a preview