Module org.icepdf.ri.viewer

Package org.icepdf.ri.common.tools

Class SquareAnnotationHandler

java.lang.Object

org.icepdf.ri.common.tools.CommonToolHandler

org.icepdf.ri.common.tools.SelectionBoxHandler

org.icepdf.ri.common.tools.SquareAnnotationHandler

All Implemented Interfaces:

MouseListener, MouseMotionListener, EventListener, MouseInputListener, ToolHandler

Direct Known Subclasses:

CircleAnnotationHandler

public class SquareAnnotationHandler
extends SelectionBoxHandler
implements ToolHandler

SquareAnnotationHandler tool is responsible for painting representation of a square on the screen during a click and drag mouse event. The box created by this mouse event will be used to draw square within its bounds.
Once the mouseReleased event is fired this handler will create new SquareAnnotation 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
protected BorderStyle	borderStyle
protected static float	DEFAULT_STROKE_WIDTH
protected Rectangle	rectangle

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

currentRect, dash1, previousRectDrawn, rectToDraw, selectionBoxColour

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

documentViewController, pageViewComponent, preferences

Constructor Summary

Constructors

Constructor	Description
SquareAnnotationHandler(DocumentViewController documentViewController, AbstractPageViewComponent pageViewComponent)	New Text selection handler.

Method Summary

Modifier and Type	Method	Description
protected void	checkAndApplyPreferences()
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_STROKE_WIDTH

protected static final float DEFAULT_STROKE_WIDTH

See Also:

Constant Field Values

rectangle

protected Rectangle rectangle

borderStyle

protected final BorderStyle borderStyle

Constructor Detail

SquareAnnotationHandler

public SquareAnnotationHandler(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

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

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

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

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

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

mouseDragged

public void mouseDragged(MouseEvent e)

Specified by:

mouseDragged in interface MouseMotionListener

setSelectionRectangle

public void setSelectionRectangle(Point cursorLocation,
                                  Rectangle selection)

Specified by:

setSelectionRectangle in class SelectionBoxHandler