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 abstract class CPDFMarkupAnnotation
extends CPDFAnnotation

Markup annotations are used primarily to mark up PDF documents. These annotations have text that appears as part of the annotation and may be displayed in other ways by a viewer application, such as in a Comments pane. Markup base class includes sub class: highlight, underline, strikeout, squiggly.

See Also:

CPDFHighlightAnnotation, CPDFUnderlineAnnotation, CPDFStrikeoutAnnotation, CPDFSquigglyAnnotation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CPDFMarkupAnnotation.CPDFMarkupAnnotationAttr

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

CPDFAnnotation.AppearanceType, CPDFAnnotation.BorderEffectIntensity, CPDFAnnotation.CPDFBorderEffectType, CPDFAnnotation.Flags, CPDFAnnotation.MarkState, CPDFAnnotation.MediaSourceType, CPDFAnnotation.ReviewState, CPDFAnnotation.Type

Field Summary

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

index

Method Summary

Modifier and Type	Method and Description
void	applyAnnotationAttr(CPDFAnnotationUndoAttr annotationAttr)
int	getAlpha() Gets opacity.
CPDFAnnotationUndoAttr	getAnnotationAttr()
int	getColor() Gets color.
java.lang.String	getMarkedText() Gets marked text.
android.graphics.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(java.lang.String text) Sets marked text.
boolean	setQuadRects(android.graphics.RectF[] quadRects) Sets the array of quadrilateral points defining the bounds of the markup.

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

addToPage, close, createReplyAnnotation, disableListenAttrChanged, enableListenAttrChanged, equal, equal, getAllReplyAnnotations, getAnnotIndexFromNative, getAnnotPtr, getAppearance, getAppearanceByPixel, getApRotation, getBordEffectIntensity, getBordEffectType, getBorderWidth, getContent, getCreationDate, getFlags, getMarkedAnnotState, getName, getRecentlyModifyDate, getRect, getReviewAnnotState, getRotateRectPoint, getRotation, getSourceRect, getTitle, getType, getVertices, hasAp, isAllowCorrectAnnotationAp, isHidden, isLocked, isReadOnly, isValid, moveAnnotIndex, removeAp, removeFromPage, removeFromPageIncludeReplyAnnot, setAllowCorrectAnnotationAp, setAnnotTop, setBordEffectIntensity, setBordEffectType, setBorderWidth, setContent, setCreationDate, setFlags, setHidden, setLocked, setMarkedAnnotState, setName, setOnAnnotationChangedListener, setReadOnly, setRecentlyModifyDate, setRect, setReviewAnnotState, setRotation, setSourceRect, setTitle, setVertices, updateAp, updateApWithBitmap, updateApWithImage

Methods inherited from class java.lang.Object

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

Method Detail

setQuadRects

public boolean setQuadRects(android.graphics.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. Convert function: CPDFPage.convertRectToPage(boolean, float, float, RectF).

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 android.graphics.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. Convert function: CPDFPage.convertRectFromPage(boolean, float, float, RectF).

Returns:

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

setMarkedText

public boolean setMarkedText(java.lang.String text)

Sets marked text.

Parameters:

text - Marked text.

Returns:

Returns whether to successfully set marked text.

getMarkedText

public java.lang.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)

applyAnnotationAttr

public void applyAnnotationAttr(CPDFAnnotationUndoAttr annotationAttr)

Specified by:

applyAnnotationAttr in class CPDFAnnotation

getAnnotationAttr

public CPDFAnnotationUndoAttr getAnnotationAttr()

Specified by:

getAnnotationAttr in class CPDFAnnotation