Package com.levigo.jadice.annotation

Class ArrowAnnotation

java.lang.Object

com.levigo.jadice.annotation.Annotation

com.levigo.jadice.annotation.ShapeBasedAnnotation

com.levigo.jadice.annotation.LineAnnotation

com.levigo.jadice.annotation.ArrowAnnotation

All Implemented Interfaces:

PermissionsProvider<Annotation>, PropertiesProvider, com.levigo.jadice.web.shared.model.annotation.internal.JwtAnnotation, Serializable, org.jadice.util.base.MementoOriginator

public class ArrowAnnotation
extends LineAnnotation

An annotation looking like an arrow.

An arrow annotation could be used to point to something interesting part of the displayed document page. For this purpose it can be rotated and change its appearance color.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.levigo.jadice.annotation.LineAnnotation

p1, p2, shape

Fields inherited from class com.levigo.jadice.annotation.ShapeBasedAnnotation

allowResize, fillColor, filled, iconified, linePainted, lineWidth, strokeColor, strokeResolution

Fields inherited from class com.levigo.jadice.annotation.Annotation

createdAt, createdBy, doFireAnnotationEvents, id, initializer, isModified, lastModifiedAt, lastModifiedBy

Constructor Summary

Constructors

Constructor	Description
ArrowAnnotation()

Method Summary

Modifier and Type	Method	Description
ArrowAnnotation	copy()
protected void	copyAttributesTo(Annotation annotation)
Rectangle2D	getBounds()	Returns an integer Rectanglethat completely encloses the annotation.
int	getHeadAngle()	Returns the head Angle in degrees.
Point2D[]	getHeadEdges()
int	getHeadLength()	Returns the head length.
Point2D[]	getPoints()	Get the points of the arrow in a point array: bottom tip edge of head arm 1 edge of head arm 2
boolean	isHeadLengthInPercent()	Returns current head length flag.
void	setBottom(Point2D bottom)
void	setHeadAngle(int headAngle)	Sets the head angle in degrees.
void	setHeadLength(int headLength)	Sets the head length which is defined by the isHeadLengthInPercent() value.
void	setHeadLengthInPercent(boolean headLengthInPercent)	Sets the mode for the setHeadAngle(int) value: true - head length in percent of the total length.
void	setTip(Point2D tip)
protected void	updateShape(LineAnnotation previousState)	Update the polygon representing the arrow.

Methods inherited from class com.levigo.jadice.annotation.LineAnnotation

getP1, getP2, getShape, isLinePainted, setLocation, setP1, setP1, setP2, setP2, setSize, translate, update

Methods inherited from class com.levigo.jadice.annotation.ShapeBasedAnnotation

getFillColor, getLineWidth, getStrokeColor, getStrokeResolution, isAllowResize, isFilled, isIconified, prepareSerialisation, setAllowResize, setFillColor, setFilled, setIconified, setLinePainted, setLineWidth, setStrokeColor, setStrokeResolution

Methods inherited from class com.levigo.jadice.annotation.Annotation

clearModified, clone, createMemento, fireAnnotationChange, getChangeHandler, getCreatedAt, getCreatedBy, getID, getInitializer, getLastModifiedAt, getLastModifiedBy, getModCount, getPermissions, getProfileId, getProperties, getType, getTypeName, initialize, isDoFireAnnotationEvents, isInitialized, isModified, restoreFrom, setChangeHandler, setCreatedBy, setCreationTimestamp, setDoFireAnnotationEvents, setID, setInitializer, setLastModifiedBy, setModified, setModifyTimestamp, setProfileId, setType, setTypeName

Methods inherited from class java.lang.Object

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

Constructor Details

ArrowAnnotation

public ArrowAnnotation()

Method Details

setTip

public void setTip(Point2D tip)

setBottom

public void setBottom(Point2D bottom)

getHeadEdges

public Point2D[] getHeadEdges()

updateShape

protected void updateShape(LineAnnotation previousState)

Update the polygon representing the arrow.

Overrides:

updateShape in class LineAnnotation

getHeadAngle

public int getHeadAngle()

Returns the head Angle in degrees.

Returns:

Head angle

getHeadLength

public int getHeadLength()

Returns the head length.

Returns:

Head length

setHeadAngle

public void setHeadAngle(int headAngle)

Sets the head angle in degrees.

Parameters:

headAngle - The headAngle to set

setHeadLength

public void setHeadLength(int headLength)

Sets the head length which is defined by the isHeadLengthInPercent() value.

Parameters:

headLength - The headLength to set

getPoints

public Point2D[] getPoints()

Get the points of the arrow in a point array:

• bottom
• tip
• edge of head arm 1
• edge of head arm 2

Overrides:

getPoints in class LineAnnotation

Returns:

Point2D[]

getBounds

public Rectangle2D getBounds()

Description copied from class: ShapeBasedAnnotation

Returns an integer Rectanglethat completely encloses the annotation.

Overrides:

getBounds in class LineAnnotation

Returns:

Rectangle annotation bounding box

copy

public ArrowAnnotation copy()

Specified by:

copy in interface com.levigo.jadice.web.shared.model.annotation.internal.JwtAnnotation

Overrides:

copy in class LineAnnotation

See Also:

• JwtAnnotation.copy()

copyAttributesTo

protected void copyAttributesTo(Annotation annotation)

Overrides:

copyAttributesTo in class LineAnnotation

isHeadLengthInPercent

public boolean isHeadLengthInPercent()

Returns current head length flag.

Returns:

Head length flag

setHeadLengthInPercent

public void setHeadLengthInPercent(boolean headLengthInPercent)

Sets the mode for the setHeadAngle(int) value:
true - head length in percent of the total length.
false - head length in pixel.
Default value is true.

Parameters:

headLengthInPercent -