Module org.icepdf.ri.viewer

Package org.icepdf.ri.common.tools

Class FreeTextAnnotationHandler

java.lang.Object

org.icepdf.ri.common.tools.CommonToolHandler

org.icepdf.ri.common.tools.SelectionBoxHandler

org.icepdf.ri.common.tools.FreeTextAnnotationHandler

All Implemented Interfaces:

MouseListener, MouseMotionListener, EventListener, MouseInputListener, ToolHandler

public class FreeTextAnnotationHandler
extends SelectionBoxHandler
implements ToolHandler

FreeTextAnnotationHandler tool is responsible for painting representation of a FreeTextAnnotationHandler on the screen during a click and drag mouse event. The box created by this mouse event will be used be used as the bounding box of the annotation that will be created.
Once the mouseReleased event is fired this handler will create new FreeTextAnnotationHandler and respective AnnotationComponent. The addition of the Annotation object to the page is handled by the annotation callback.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_HEIGHT
static int	DEFAULT_WIDTH

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
FreeTextAnnotationHandler(DocumentViewController documentViewController, AbstractPageViewComponent pageViewComponent)	New Text selection handler.

Method Summary

Modifier and Type	Method	Description
protected void	checkAndApplyPreferences()
void	createFreeTextAnnotation(int x, int y)
void	createFreeTextAnnotation(int x, int y, boolean setSelectionTool)
void	installTool()	Callback code that allows post construct task to take place when the tool is selected via the AbstractDocumentView.setToolMode(int) call.
void	mouseClicked(MouseEvent e)
void	mouseDragged(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mouseMoved(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	paintTool(Graphics g)	Paints the tools pre-annotation creation state.
void	setSelectionRectangle(Point cursorLocation, Rectangle selection)
void	uninstallTool()	Callback code that allows pre destroy task to take place when the tool is unselected via the AbstractDocumentView.setToolMode(int) call.

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

clearRectangle, getCurrentRect, getRectToDraw, isOverPageComponent, paintRectangle, 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

Field Detail

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final int DEFAULT_HEIGHT

See Also:

Constant Field Values

Constructor Detail

FreeTextAnnotationHandler

public FreeTextAnnotationHandler(DocumentViewController documentViewController,
                                 AbstractPageViewComponent pageViewComponent)

New Text selection handler. Make sure to correctly and and remove this mouse and text listeners.

Parameters:

pageViewComponent - page component that this handler is bound to.

documentViewController - view controller.

Method Detail

setSelectionRectangle

public void setSelectionRectangle(Point cursorLocation,
                                  Rectangle selection)

Specified by:

setSelectionRectangle in class SelectionBoxHandler

paintTool

public void paintTool(Graphics g)

Description copied from interface: ToolHandler

Paints the tools pre-annotation creation state.

Specified by:

paintTool in interface ToolHandler

Parameters:

g - graphics context

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

createFreeTextAnnotation

public void createFreeTextAnnotation(int x,
                                     int y)

createFreeTextAnnotation

public void createFreeTextAnnotation(int x,
                                     int y,
                                     boolean setSelectionTool)

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

checkAndApplyPreferences

protected void checkAndApplyPreferences()

Specified by:

checkAndApplyPreferences in class CommonToolHandler

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

mouseMoved

public void mouseMoved(MouseEvent e)

Specified by:

mouseMoved in interface MouseMotionListener

installTool

public void installTool()

Description copied from interface: ToolHandler

Callback code that allows post construct task to take place when the tool is selected via the AbstractDocumentView.setToolMode(int) call.

Specified by:

installTool in interface ToolHandler

uninstallTool

public void uninstallTool()

Description copied from interface: ToolHandler

Callback code that allows pre destroy task to take place when the tool is unselected via the AbstractDocumentView.setToolMode(int) call.

Specified by:

uninstallTool in interface ToolHandler