Module org.icepdf.ri.viewer

Package org.icepdf.ri.common.tools

Class RedactionAnnotationHandler

java.lang.Object

org.icepdf.ri.common.tools.CommonToolHandler

org.icepdf.ri.common.tools.SelectionBoxHandler

org.icepdf.ri.common.tools.TextSelection

org.icepdf.ri.common.tools.TextSelectionPageHandler

org.icepdf.ri.common.tools.HighLightAnnotationHandler

org.icepdf.ri.common.tools.RedactionAnnotationHandler

All Implemented Interfaces:

ActionListener, KeyListener, MouseListener, MouseMotionListener, EventListener, MouseInputListener, ToolHandler

public class RedactionAnnotationHandler
extends HighLightAnnotationHandler

RedactionAnnotationHandler tool extends HighlightSelectionPageHandler which takes care visually selected text as the mouse is dragged across text on the current page as well as double and triple word selection. The tool also allows the selection of image content for redactoin
Redaction annotation type only marks section of the PDF document for redaction. For content to be removed the document must be exported using the DocumentBuilder WriteMode.FULL_UPDATE mode. During the export all content is removed from the PDF.

Since:

7.2.0

Field Summary

Fields inherited from class org.icepdf.ri.common.tools.HighLightAnnotationHandler

annotation, enableHighlightContents, markupSubType

Fields inherited from class org.icepdf.ri.common.tools.TextSelectionPageHandler

isClearSelection, isMouseDrag

Fields inherited from class org.icepdf.ri.common.tools.TextSelection

bottomMargin, bottomMarginExclusion, enableMarginExclusion, enableMarginExclusionBorder, lastMouseLocation, lastMousePressedLocation, logger, pageLock, selectedCount, topMargin, topMarginExclusion

Fields inherited from class org.icepdf.ri.common.tools.SelectionBoxHandler

currentRect, dash1, previousRectDrawn, rectToDraw, selectionBoxColour, stroke

Fields inherited from class org.icepdf.ri.common.tools.CommonToolHandler

documentViewController, pageViewComponent, preferences

Constructor Summary

Constructors

Constructor	Description
RedactionAnnotationHandler(DocumentViewController documentViewController, AbstractPageViewComponent pageViewComponent)

Method Summary

Modifier and Type	Method	Description
void	createMarkupAnnotationFromSelectionBox()
protected void	createMarkupAnnotationFromTextSelection(MouseEvent e)
void	createRedactionAnnotation(ArrayList<Shape> redactionBounds)
void	mouseDragged(MouseEvent e)	Invoked when a mouse button is pressed on a component and then dragged.
void	mouseMoved(MouseEvent e)	Invoked when the mouse cursor has been moved onto a component but no buttons have been pushed.
void	mousePressed(MouseEvent e)	Invoked when a mouse button has been pressed on a component.
void	mouseReleased(MouseEvent e)	Invoked when a mouse button has been released on a component.
protected void	paintRectangle(Graphics2D gg, Rectangle rectToDraw)
void	paintTool(Graphics g)	Paints the tools pre-annotation creation state.
void	selectionImageSelectIcon(Point mouseLocation, AbstractPageViewComponent pageViewComponent)

Methods inherited from class org.icepdf.ri.common.tools.HighLightAnnotationHandler

actionPerformed, checkAndApplyPreferences, createMarkupAnnotation, getSelectedText, getSelectedTextBounds, installTool, keyPressed, keyReleased, keyTyped, mouseClicked, uninstallTool

Methods inherited from class org.icepdf.ri.common.tools.TextSelectionPageHandler

cancelSelection, mouseEntered, mouseExited, setDocumentViewController, setSelectionRectangle

Methods inherited from class org.icepdf.ri.common.tools.TextSelection

calculateTextSelectionExclusion, clearSelection, clearSelectionState, convertTextShapesToBounds, convertToPageSpace, lineSelectHandler, multiLineSelectHandler, paintSelectedText, paintTextBounds, selection, selectionEnd, selectionStart, selectionTextSelectIcon, setBottomMargin, setTopMargin, wordLineSelection, wordSelectHandler

Methods inherited from class org.icepdf.ri.common.tools.SelectionBoxHandler

clearRectangle, getCurrentRect, getRectToDraw, isOverPageComponent, paintSelectionBox, resetRectangle, setCurrentRect, setRectToDraw, setSelectionSize, updateDrawableRect, updateSelectionSize

Methods inherited from class org.icepdf.ri.common.tools.CommonToolHandler

convertToPageSpace, convertToPageSpace, convertToPageSpace, convertToPageSpace, getPageTransform, getPageTransform, getToPageSpaceTransform, getToPageSpaceTransform

Methods inherited from class java.lang.Object

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

Constructor Detail

RedactionAnnotationHandler

public RedactionAnnotationHandler(DocumentViewController documentViewController,
                                  AbstractPageViewComponent pageViewComponent)

Method Detail

createMarkupAnnotationFromTextSelection

protected void createMarkupAnnotationFromTextSelection(MouseEvent e)

Overrides:

createMarkupAnnotationFromTextSelection in class HighLightAnnotationHandler

mouseMoved

public void mouseMoved(MouseEvent e)

Description copied from class: TextSelectionPageHandler

Invoked when the mouse cursor has been moved onto a component but no buttons have been pushed.

Specified by:

mouseMoved in interface MouseMotionListener

Overrides:

mouseMoved in class TextSelectionPageHandler

mousePressed

public void mousePressed(MouseEvent e)

Description copied from class: TextSelectionPageHandler

Invoked when a mouse button has been pressed on a component.

Specified by:

mousePressed in interface MouseListener

Overrides:

mousePressed in class TextSelectionPageHandler

mouseReleased

public void mouseReleased(MouseEvent e)

Description copied from class: HighLightAnnotationHandler

Invoked when a mouse button has been released on a component.

Specified by:

mouseReleased in interface MouseListener

Overrides:

mouseReleased in class HighLightAnnotationHandler

mouseDragged

public void mouseDragged(MouseEvent e)

Description copied from class: TextSelectionPageHandler

Invoked when a mouse button is pressed on a component and then dragged. MOUSE_DRAGGED events will continue to be delivered to the component where the drag originated until the mouse button is released (regardless of whether the mouse position is within the bounds of the component).
Due to platform-dependent Drag&Drop implementations, MOUSE_DRAGGED events may not be delivered during a native Drag&Drop operation.

Specified by:

mouseDragged in interface MouseMotionListener

Overrides:

mouseDragged in class TextSelectionPageHandler

paintTool

public void paintTool(Graphics g)

Description copied from interface: ToolHandler

Paints the tools pre-annotation creation state.

Specified by:

paintTool in interface ToolHandler

Overrides:

paintTool in class TextSelectionPageHandler

Parameters:

g - graphics context

paintRectangle

protected void paintRectangle(Graphics2D gg,
                              Rectangle rectToDraw)

Overrides:

paintRectangle in class SelectionBoxHandler

selectionImageSelectIcon

public void selectionImageSelectIcon(Point mouseLocation,
                                     AbstractPageViewComponent pageViewComponent)

createMarkupAnnotationFromSelectionBox

public void createMarkupAnnotationFromSelectionBox()

createRedactionAnnotation

public void createRedactionAnnotation(ArrayList<Shape> redactionBounds)