Module org.icepdf.ri.viewer

Package org.icepdf.ri.common.views.annotations

Class MarkupAnnotationComponent<T extends MarkupAnnotation>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.icepdf.ri.common.views.annotations.AbstractAnnotationComponent<T>

org.icepdf.ri.common.views.annotations.MarkupAnnotationComponent<T>

All Implemented Interfaces:

FocusListener, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener, MouseInputListener, AnnotationComponent, ResizeableComponent

Direct Known Subclasses:

CircleAnnotationComponent, FreeTextAnnotationComponent, InkAnnotationComponent, LineAnnotationComponent, PolygonAnnotationComponent, PolyLineAnnotationComponent, RedactionAnnotationComponent, SquareAnnotationComponent, TextAnnotationComponent, TextMarkupAnnotationComponent

public abstract class MarkupAnnotationComponent<T extends MarkupAnnotation>
extends AbstractAnnotationComponent<T>

MarkupAnnotationComponent class encapsulates the component functionality needed to display an MarkupAnnotations PopupAnnnotaion component. When a MarkupAnnotationComponent is double clicked is child PopupAnnotation component will be displayed.

Since:

5.0

See Also:

CircleAnnotationComponent, FreeTextAnnotationComponent, InkAnnotationComponent, LineAnnotationComponent, LinkAnnotationComponent, PolygonAnnotationComponent, PolyLineAnnotationComponent, SquareAnnotationComponent, TextAnnotationComponent, TextMarkupAnnotationComponent, Serialized Form

Nested Class Summary

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected static boolean	isInteractivePopupAnnotationsEnabled
protected static Logger	logger

Fields inherited from class org.icepdf.ri.common.views.annotations.AbstractAnnotationComponent

annotation, annotationHighlightAlpha, annotationHighlightColor, contextMenu, currentRotation, currentZoom, cursor, documentViewController, dx, dy, endOfMousePress, isEditable, isMousePressed, isMovable, isResizable, isRollover, isSelected, isShowInvisibleBorder, isSynthetic, messageBundle, pageViewComponent, previousAnnotationState, resizableBorder, resizeBoxSize, resized, startOfMousePress, startPos, wasResized

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
MarkupAnnotationComponent(T annotation, DocumentViewController documentViewController, AbstractPageViewComponent pageViewComponent)

Method Summary

Modifier and Type	Method	Description
void	buildContextMenu()
boolean	contains(int x, int y)
PopupAnnotationComponent	createPopupAnnotationComponent(boolean isNew)
PopupAnnotationComponent	getPopupAnnotationComponent()
boolean	isActive()
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent me)
void	resetAppearanceShapes()	Rest the annotation appearance stream.
void	togglePopupAnnotationVisibility()

Methods inherited from class org.icepdf.ri.common.views.annotations.AbstractAnnotationComponent

additionalActionsHandler, convertToPageSpace, convertToPageSpace, dispose, focusGained, focusLost, getAnnotation, getDocument, getPageIndex, getPageSpaceTransform, getPageViewComponent, getToPageSpaceTransform, initiateMouseMoved, isBorderStyle, isEditable, isMovable, isResizable, isRollover, isSelected, isShowInvisibleBorder, isSynthetic, limitAnnotationPosition, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, paintComponent, refreshAnnotationRect, refreshDirtyBounds, removeMouseListeners, resize, setBounds, setSelected, setSynthetic, validate

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, 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, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, 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, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, 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, 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, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.icepdf.ri.common.views.AnnotationComponent

hasFocus, repaint

Field Detail

logger

protected static final Logger logger

isInteractivePopupAnnotationsEnabled

protected static final boolean isInteractivePopupAnnotationsEnabled

Constructor Detail

MarkupAnnotationComponent

public MarkupAnnotationComponent(T annotation,
                                 DocumentViewController documentViewController,
                                 AbstractPageViewComponent pageViewComponent)

Method Detail

buildContextMenu

public void buildContextMenu()

resetAppearanceShapes

public void resetAppearanceShapes()

Description copied from interface: AnnotationComponent

Rest the annotation appearance stream.

Specified by:

resetAppearanceShapes in interface AnnotationComponent

Specified by:

resetAppearanceShapes in class AbstractAnnotationComponent<T extends MarkupAnnotation>

getPopupAnnotationComponent

public PopupAnnotationComponent getPopupAnnotationComponent()

createPopupAnnotationComponent

public PopupAnnotationComponent createPopupAnnotationComponent(boolean isNew)

contains

public boolean contains(int x,
                        int y)

Overrides:

contains in class JComponent

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

Overrides:

mouseClicked in class AbstractAnnotationComponent<T extends MarkupAnnotation>

mouseDragged

public void mouseDragged(MouseEvent me)

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class AbstractAnnotationComponent<T extends MarkupAnnotation>

togglePopupAnnotationVisibility

public void togglePopupAnnotationVisibility()

isActive

public boolean isActive()

Specified by:

isActive in interface AnnotationComponent

Specified by:

isActive in class AbstractAnnotationComponent<T extends MarkupAnnotation>