Package com.compdfkit.core.annotation

Class CPDFMarkupAnnotation

java.lang.Object

com.compdfkit.core.annotation.CPDFAnnotation

com.compdfkit.core.annotation.CPDFMarkupAnnotation

Direct Known Subclasses:

CPDFHighlightAnnotation, CPDFSquigglyAnnotation, CPDFStrikeoutAnnotation, CPDFUnderlineAnnotation

public class CPDFMarkupAnnotation
extends CPDFAnnotation

Nested Class Summary

Nested classes/interfaces inherited from class com.compdfkit.core.annotation.CPDFAnnotation

CPDFAnnotation.AppearanceType, CPDFAnnotation.Flags, CPDFAnnotation.PSOAnnotationState, CPDFAnnotation.Type

Method Summary

Modifier and Type	Method	Description
int	getAlpha()	Gets opacity.
int	getColor()	Gets color.
String	getMarkedText()	Gets marked text.
PointF[]	getQuadPoints()	Gets the array of quadrilateral points defining the bounds of the markup.
RectF[]	getQuadRects()	Gets the array of quadrilateral points defining the bounds of the markup.
boolean	setAlpha(int alpha)	Sets opacity.
boolean	setColor(int color)	Sets color.
boolean	setMarkedText(String text)	Sets marked text.
boolean	setQuadPoints(PointF[] quadPoints)	Sets the array of quadrilateral points defining the bounds of the markup.
boolean	setQuadRects(RectF[] quadRects)	Sets the array of quadrilateral points defining the bounds of the markup.
boolean	updateAp()	Updates annotation appearance.

Methods inherited from class com.compdfkit.core.annotation.CPDFAnnotation

addToPage, close, createReplyAnnotation, createReplyStateAnnotation, getContent, getCreationDate, getFlags, getMainAnnotNM, getName, getRecentlyModifyDate, getRect, getReplies, getState, getTitle, getType, hasAp, isAllowCorrectAnnotationAp, isExitMainAnnot, isHidden, isLocked, isMarkedStateAnnot, isReplyAnnot, isReviewStateAnnot, isValid, removeFromPage, removeFromPageIncludeReplyAnnot, setAllowCorrectAnnotationAp, setContent, setCreationDate, setFlags, setHidden, setLocked, setMarkedAnnotState, setName, setRecentlyModifyDate, setRect, setReviewAnnotState, setState, setTitle

Methods inherited from class java.lang.Object

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

Method Details

setQuadRects

public boolean setQuadRects(RectF[] quadRects)

Sets the array of quadrilateral points defining the bounds of the markup. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.

Parameters:

quadRects - Array of quadrilateral points defining the bounds of the markup.

Returns:

Returns whether to successfully set the array of quadrilateral points defining the bounds of the markup.

getQuadRects

public RectF[] getQuadRects()

Gets the array of quadrilateral points defining the bounds of the markup. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.

Returns:

Returns the array of quadrilateral points defining the bounds of the markup.

setQuadPoints

public boolean setQuadPoints(PointF[] quadPoints)

Sets the array of quadrilateral points defining the bounds of the markup. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.

Parameters:

quadPoints - Array of quadrilateral points defining the bounds of the markup.

Returns:

Returns whether to successfully set the array of quadrilateral points defining the bounds of the markup.

getQuadPoints

public PointF[] getQuadPoints()

Gets the array of quadrilateral points defining the bounds of the markup. The page coordinate system has its origin at the left-bottom corner of the page, with the X-axis on the bottom going to the right, and the Y-axis on the left side going up. The device coordinate system is device dependent. For screen device, its origin is at the left-top corner of the window.

Returns:

Returns the array of quadrilateral points defining the bounds of the markup.

setMarkedText

public boolean setMarkedText(String text)

Sets marked text.

Parameters:

text - Marked text.

Returns:

Returns whether to successfully set marked text.

getMarkedText

public String getMarkedText()

Gets marked text.

Returns:

Returns marked text.

setColor

public boolean setColor(int color)

Sets color.

Parameters:

color - Color value (0x00000000~0xFFFFFFFF)

Returns:

Returns whether to successfully set color.

getColor

public int getColor()

Gets color.

Returns:

Returns color value (0x00000000~0xFFFFFFFF)

setAlpha

public boolean setAlpha(int alpha)

Sets opacity.

Parameters:

alpha - Opacity value (0~255)

Returns:

Returns whether to successfully set opacity.

getAlpha

public int getAlpha()

Gets opacity.

Returns:

Returns opacity value (0~255)

updateAp

public boolean updateAp()

Updates annotation appearance. Call this function to update annotation appearance after modifying annotation attribute.

Returns:

Returns whether to successfully update annotation appearance.