CPDFAnnotation (ComPDFKit API)

java.lang.Object
- com.compdfkit.core.annotation.CPDFAnnotation

Direct Known Subclasses:

CPDFCircleAnnotation, CPDFFreetextAnnotation, CPDFInkAnnotation, CPDFLineAnnotation, CPDFLinkAnnotation, CPDFMarkupAnnotation, CPDFMediaAnnotation, CPDFMovieAnnotation, CPDFRedactAnnotation, CPDFReplyAnnotation, CPDFSoundAnnotation, CPDFSquareAnnotation, CPDFStampAnnotation, CPDFTextAnnotation, CPDFWidget
```
public abstract class CPDFAnnotation
extends java.lang.Object
```
An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard. PDF includes a wide variety of standard annotation types. Class Annot is the base class for all kinds of PDF annotations. It offers the base functions to get/set annotation's common properties, to move an annotation or reset appearance stream of an annotation. For concrete annotation types, please refer to derived classes. To get the count of annotations or get/add/remove an annotation, please refer to class CPDFPage. This class object can also be used to construct objects of other classes in order to do some more operation in annotation or access specified information of annotation.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CPDFAnnotation.AppearanceType`
`static class`	`CPDFAnnotation.BorderEffectIntensity`
`static class`	`CPDFAnnotation.CPDFBorderEffectType`
`static interface`	`CPDFAnnotation.Flags` A set of flags specifying various characteristics of the annotation.
`static class`	`CPDFAnnotation.MarkState`
`static class`	`CPDFAnnotation.MediaSourceType` Media resource type
`static class`	`CPDFAnnotation.ReviewState`
`static class`	`CPDFAnnotation.Type` Annotation types

Field Summary

Fields
Modifier and Type Field and Description

int index

Fields
Modifier and Type	Field and Description
`int`	`index`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addToPage()`
`abstract void`	`applyAnnotationAttr(CPDFAnnotationUndoAttr annotationAttr)`
`void`	`close()` When the object is no longer in use, call this method to release resources.
`CPDFReplyAnnotation`	`createReplyAnnotation()` Create a reply annotation.
`void`	`disableListenAttrChanged(boolean recordCurrentStatus)` 不监听属性的变化。`CPDFUndoManager`不会记录属性改变时的状态。一般用于，当需要时时刷新数据，并且改变UI的时候使用。这样防止记录很多无用的数据
`void`	`enableListenAttrChanged()` 监听属性的变化。`CPDFUndoManager` 会记录属性改变时的状态。
`boolean`	`equal(CPDFAnnotation annotation)`
`boolean`	`equal(long annotPtr1)`
`CPDFReplyAnnotation[]`	`getAllReplyAnnotations()` Get all reply annotations to the annotation.
`abstract CPDFAnnotationUndoAttr`	`getAnnotationAttr()`
`int`	`getAnnotIndexFromNative()`
`long`	`getAnnotPtr()`
`boolean`	`getAppearance(android.graphics.Bitmap bitmap)` Gets annotation appearance with Bitmap.
`boolean`	`getAppearanceByPixel(android.graphics.Bitmap bitmap, CPDFAnnotation.AppearanceType type)` Gets annotation appearance by pixel with Bitmap.
`int`	`getApRotation()` Gets rotation angle of annotation appearance.
`CPDFAnnotation.BorderEffectIntensity`	`getBordEffectIntensity()`
`CPDFAnnotation.CPDFBorderEffectType`	`getBordEffectType()`
`float`	`getBorderWidth()` Gets border width of annotation.
`java.lang.String`	`getContent()` Gets annotation content.
`CPDFDate`	`getCreationDate()` Gets the creation date of annotation.
`int`	`getFlags()` Gets annotation flags.
`CPDFAnnotation.MarkState`	`getMarkedAnnotState()` Get the mark state of the reply annotation.
`java.lang.String`	`getName()` Not in use currently
`CPDFDate`	`getRecentlyModifyDate()` Gets the modification date of annotation.
`android.graphics.RectF`	`getRect()` Gets annotation rectangle.
`CPDFAnnotation.ReviewState`	`getReviewAnnotState()` Get the review state of the reply annotation.
`android.graphics.PointF[]`	`getRotateRectPoint()`
`int`	`getRotation()`
`android.graphics.RectF`	`getSourceRect()`
`java.lang.String`	`getTitle()` Not in use currently
`CPDFAnnotation.Type`	`getType()` Gets annotation type, more:`CPDFAnnotation.Type`
`android.graphics.PointF[]`	`getVertices()`
`boolean`	`hasAp()` Whether annotation has appearance.
`boolean`	`isAllowCorrectAnnotationAp()` Whether to allow to correct annotation appearance
`boolean`	`isHidden()` This is a convenience property that checks for `CPDFAnnotationFlagHidden` in `flags`.
`boolean`	`isLocked()` This is a convenience property that checks for `CPDFAnnotationFlagLocked` in `flags`.
`boolean`	`isReadOnly()` This is a convenience property that checks for `CPDFAnnotationFlagReadOnly` in `flags`.
`boolean`	`isValid()` Whether annotation object is valid.
`boolean`	`moveAnnotIndex(int annotIndex)`
`boolean`	`removeAp()` Removes annotation appearance.
`boolean`	`removeFromPage()` Removes annotation from PDF page
`boolean`	`removeFromPageIncludeReplyAnnot()` Removes annotation and the reply annotation to it from PDF page.
`void`	`setAllowCorrectAnnotationAp(boolean allowCorrectAnnotationAp)` Sets whether to allow to correct annotation appearance
`boolean`	`setAnnotTop()`
`boolean`	`setBordEffectIntensity(CPDFAnnotation.BorderEffectIntensity intensity)`
`boolean`	`setBordEffectType(CPDFAnnotation.CPDFBorderEffectType type)`
`boolean`	`setBorderWidth(float width)` Sets border width of annotation.
`boolean`	`setContent(java.lang.String content)` Sets annotation content.
`boolean`	`setCreationDate(CPDFDate date)` Sets the creation date of annotation.
`boolean`	`setFlags(int flag)` Sets annotation flag.
`boolean`	`setHidden(boolean isHidden)` This is a convenience property that checks for `CPDFAnnotationFlagHidden` in `flags`.
`boolean`	`setLocked(boolean isLocked)` This is a convenience property that checks for `CPDFAnnotationFlagLocked` in `flags`.
`boolean`	`setMarkedAnnotState(CPDFAnnotation.MarkState markState)` Set mark state of the reply annotation.
`boolean`	`setName(java.lang.String name)` Not in use currently
`void`	`setOnAnnotationChangedListener(OnAnnotationChangedListener onAnnotationChanged)`
`boolean`	`setReadOnly(boolean isReadOnly)` This is a convenience property that checks for `CPDFAnnotationFlagReadOnly` in `flags`.
`boolean`	`setRecentlyModifyDate(CPDFDate date)` Sets the modification date of annotation.
`boolean`	`setRect(android.graphics.RectF rect)` Sets annotation rectangle.
`boolean`	`setReviewAnnotState(CPDFAnnotation.ReviewState reviewState)` Set the review state of the reply annotation.
`boolean`	`setRotation(int angle)`
`boolean`	`setSourceRect(android.graphics.RectF rect)`
`boolean`	`setTitle(java.lang.String title)` Not in use currently
`boolean`	`setVertices(android.graphics.PointF[] pointArr)`
`boolean`	`updateAp()` Updates annotation appearance.
`boolean`	`updateApWithBitmap(android.graphics.Bitmap bitmap)` Upadates annotation appearance by Bitmap.
`boolean`	`updateApWithImage(java.lang.String imagePath, java.lang.String smaskPath)` Update annotation appearance with image.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - index
```
public int index
```
- Method Detail
  - setMarkedAnnotState
```
public boolean setMarkedAnnotState(CPDFAnnotation.MarkState markState)
```
    Set mark state of the reply annotation.
    
    Parameters:
    
    markState - Mark state.
    
    Returns:
    
    Returns whether succeed to set the mark state.
  - getMarkedAnnotState
```
public CPDFAnnotation.MarkState getMarkedAnnotState()
```
    Get the mark state of the reply annotation.
    
    Returns:
    
    Returns the mark state of the reply annotation.
  - setReviewAnnotState
```
public boolean setReviewAnnotState(CPDFAnnotation.ReviewState reviewState)
```
    Set the review state of the reply annotation.
    
    Parameters:
    
    reviewState - Review state.
    
    Returns:
    
    Returns the review state of the reply annotation.
  - getReviewAnnotState
```
public CPDFAnnotation.ReviewState getReviewAnnotState()
```
    Get the review state of the reply annotation.
    
    Returns:
    
    Returns the review state of the reply annotation.
  - getAnnotationAttr
```
public abstract CPDFAnnotationUndoAttr getAnnotationAttr()
```
  - applyAnnotationAttr
```
public abstract void applyAnnotationAttr(CPDFAnnotationUndoAttr annotationAttr)
```
  - getType
```
public CPDFAnnotation.Type getType()
```
    Gets annotation type, more:CPDFAnnotation.Type
    
    Returns:
    
    Returns annotation type.
  - isValid
```
public boolean isValid()
```
    Whether annotation object is valid.
    
    Returns:
    
    Returns whether annotations are valid.
  - setVertices
```
public boolean setVertices(android.graphics.PointF[] pointArr)
```
  - setBordEffectType
```
public boolean setBordEffectType(CPDFAnnotation.CPDFBorderEffectType type)
```
  - setBordEffectIntensity
```
public boolean setBordEffectIntensity(CPDFAnnotation.BorderEffectIntensity intensity)
```
  - getVertices
```
public android.graphics.PointF[] getVertices()
```
  - getBordEffectType
```
public CPDFAnnotation.CPDFBorderEffectType getBordEffectType()
```
  - getBordEffectIntensity
```
public CPDFAnnotation.BorderEffectIntensity getBordEffectIntensity()
```
  - setRect
```
public boolean setRect(android.graphics.RectF rect)
```
    Sets annotation rectangle. 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:
    
    rect - Rectangle on the page.
    
    Returns:
    
    Returns whether to successfully set annotation rectangle.
  - getRect
```
public android.graphics.RectF getRect()
```
    Gets annotation rectangle. 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).
    
    Returns:
    
    Returns rectangle on the page.
  - setFlags
```
public boolean setFlags(int flag)
```
    Sets annotation flag.
    
    Parameters:
    
    flag - Annotation flag.
    
    Returns:
    
    Returns whether to successfully set annotation flag.
  - getFlags
```
public int getFlags()
```
    Gets annotation flags.
    
    Returns:
    
    Returns annotation flag.
  - setHidden
```
public boolean setHidden(boolean isHidden)
```
    This is a convenience property that checks for `CPDFAnnotationFlagHidden` in `flags`.
    
    Parameters:
    
    isHidden - True is hide,false otherwise
    
    Returns:
    
    Returns whether the setting is successful
  - isHidden
```
public boolean isHidden()
```
    This is a convenience property that checks for `CPDFAnnotationFlagHidden` in `flags`.
    
    Returns:
    
    Returns the result of 'CPDFAnnotationFlagHidden'
  - setReadOnly
```
public boolean setReadOnly(boolean isReadOnly)
```
    This is a convenience property that checks for `CPDFAnnotationFlagReadOnly` in `flags`.
    
    Parameters:
    
    isReadOnly - True is readOnly,false otherwise
    
    Returns:
    
    Returns whether the setting is successful
  - isReadOnly
```
public boolean isReadOnly()
```
    This is a convenience property that checks for `CPDFAnnotationFlagReadOnly` in `flags`.
    
    Returns:
    
    Returns the result of 'CPDFAnnotationFlagReadOnly'
  - setLocked
```
public boolean setLocked(boolean isLocked)
```
    This is a convenience property that checks for `CPDFAnnotationFlagLocked` in `flags`.
    
    Parameters:
    
    isLocked - True is locked,false is unlocked
    
    Returns:
    
    Returns whether the setting is successful
  - isLocked
```
public boolean isLocked()
```
    This is a convenience property that checks for `CPDFAnnotationFlagLocked` in `flags`.
    
    Returns:
    
    Returns the result of 'CPDFAnnotationFlagLocked'
  - setBorderWidth
```
public boolean setBorderWidth(float width)
```
    Sets border width of annotation.
    
    Parameters:
    
    width - Border width of annotation.
    
    Returns:
    
    Returns whether to successfully set border width of annotation.
  - getBorderWidth
```
public float getBorderWidth()
```
    Gets border width of annotation.
    
    Returns:
    
    Returns border width of annotation.
  - setContent
```
public boolean setContent(java.lang.String content)
```
    Sets annotation content.
    
    Parameters:
    
    content - Annotation content.
    
    Returns:
    
    Returns whether to successfully set annotation content.
  - getContent
```
public java.lang.String getContent()
```
    Gets annotation content.
    
    Returns:
    
    Returns annotation content.
  - setCreationDate
```
public boolean setCreationDate(CPDFDate date)
```
    Sets the creation date of annotation.
    
    Parameters:
    
    date - Creation date of annotation.
    
    Returns:
    
    Returns whether to successfully set creation date of annotation.
  - getCreationDate
```
public CPDFDate getCreationDate()
```
    Gets the creation date of annotation.
    
    Returns:
    
    Returns the creation date of annotation.
  - setRecentlyModifyDate
```
public boolean setRecentlyModifyDate(CPDFDate date)
```
    Sets the modification date of annotation.
    
    Parameters:
    
    date - Modification date of annotation.
    
    Returns:
    
    Returns whether to successfully set the modification date of annotation.
  - getRecentlyModifyDate
```
public CPDFDate getRecentlyModifyDate()
```
    Gets the modification date of annotation.
    
    Returns:
    
    Returns the modification date of annotation.
  - setTitle
```
public boolean setTitle(java.lang.String title)
```
    Not in use currently
  - getTitle
```
public java.lang.String getTitle()
```
    Not in use currently
  - setName
```
public boolean setName(java.lang.String name)
```
    Not in use currently
  - getName
```
public java.lang.String getName()
```
    Not in use currently
  - hasAp
```
public boolean hasAp()
```
    Whether annotation has appearance.
    
    Returns:
    
    Returns whether annotation has appearance.
  - removeAp
```
public boolean removeAp()
```
    Removes annotation appearance.
    
    Returns:
    
    Returns whether to successfully remove annotation appearance.
  - getApRotation
```
public int getApRotation()
```
    Gets rotation angle of annotation appearance.
    
    Returns:
    
    Returns rotation angle of annotation appearance. It is counterclockwise direction.
  - 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.
  - updateApWithImage
```
public boolean updateApWithImage(java.lang.String imagePath,
                                 java.lang.String smaskPath)
```
    Update annotation appearance with image.
    
    Parameters:
    
    imagePath - Original image path
    
    smaskPath - Mask image path
    
    Returns:
    
    Returns whether to successfully update annotation appearance with image.
  - updateApWithBitmap
```
public boolean updateApWithBitmap(android.graphics.Bitmap bitmap)
```
    Upadates annotation appearance by Bitmap.
    
    Parameters:
    
    bitmap - Image resource.
    
    Returns:
    
    Returns whether to successfully upadate annotation appearance.
  - getAppearance
```
public boolean getAppearance(android.graphics.Bitmap bitmap)
```
    Gets annotation appearance with Bitmap.
    
    Parameters:
    
    bitmap - Bitmap
    
    Returns:
    
    Returns whether to successfully get annotation appearance with Bitmap.
  - getAppearanceByPixel
```
public boolean getAppearanceByPixel(android.graphics.Bitmap bitmap,
                                    CPDFAnnotation.AppearanceType type)
```
    Gets annotation appearance by pixel with Bitmap.
    
    Parameters:
    
    bitmap - Bitmap
    
    Returns:
    
    Returns whether to successfully get annotation appearance by pixel with Bitmap.
  - isAllowCorrectAnnotationAp
```
public boolean isAllowCorrectAnnotationAp()
```
    Whether to allow to correct annotation appearance
    
    Returns:
    
    Returns whether to allow to correct annotation appearance
  - setAllowCorrectAnnotationAp
```
public void setAllowCorrectAnnotationAp(boolean allowCorrectAnnotationAp)
```
    Sets whether to allow to correct annotation appearance
    
    Parameters:
    
    allowCorrectAnnotationAp - Whether to allow to correct annotation appearance
  - removeFromPage
```
public boolean removeFromPage()
```
    Removes annotation from PDF page
    
    Returns:
    
    Returns whether to successfully remove annotation.
  - removeFromPageIncludeReplyAnnot
```
public boolean removeFromPageIncludeReplyAnnot()
```
    Removes annotation and the reply annotation to it from PDF page.
    
    Returns:
    
    Returns whether to successfully remove annotation.
  - addToPage
```
public boolean addToPage()
```
  - equal
```
public boolean equal(CPDFAnnotation annotation)
```
  - equal
```
public boolean equal(long annotPtr1)
```
  - getAnnotPtr
```
public long getAnnotPtr()
```
  - setOnAnnotationChangedListener
```
public void setOnAnnotationChangedListener(OnAnnotationChangedListener onAnnotationChanged)
```
  - disableListenAttrChanged
```
public void disableListenAttrChanged(boolean recordCurrentStatus)
```
    不监听属性的变化。CPDFUndoManager不会记录属性改变时的状态。一般用于，当需要时时刷新数据，并且改变UI的时候使用。这样防止记录很多无用的数据
    
    Parameters:
    
    recordCurrentStatus - 是否记录当前annotation的状态，若参数为true，则在enableListenAttrChanged()时将当前annotation的状态添加到CPDFUndoManager中，可以使用CPDFUndoManager.undo()进行恢复操作。否则，反之。
  - enableListenAttrChanged
```
public void enableListenAttrChanged()
```
    监听属性的变化。CPDFUndoManager 会记录属性改变时的状态。
  - close
```
public void close()
```
    When the object is no longer in use, call this method to release resources.
  - setAnnotTop
```
public boolean setAnnotTop()
```
  - getAnnotIndexFromNative
```
public int getAnnotIndexFromNative()
```
  - moveAnnotIndex
```
public boolean moveAnnotIndex(int annotIndex)
```
  - createReplyAnnotation
```
public CPDFReplyAnnotation createReplyAnnotation()
```
    Create a reply annotation.
    
    Returns:
    
    Returns CPDFReplyAnnotation object.
  - getAllReplyAnnotations
```
public CPDFReplyAnnotation[] getAllReplyAnnotations()
```
    Get all reply annotations to the annotation.
    
    Returns:
    
    Returns all reply annotations.
  - setRotation
```
public boolean setRotation(int angle)
```
  - getRotation
```
public int getRotation()
```
  - getSourceRect
```
public android.graphics.RectF getSourceRect()
```
  - setSourceRect
```
public boolean setSourceRect(android.graphics.RectF rect)
```
  - getRotateRectPoint
```
public android.graphics.PointF[] getRotateRectPoint()
```

Class CPDFAnnotation

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

index

Method Detail

setMarkedAnnotState

getMarkedAnnotState

setReviewAnnotState

getReviewAnnotState

getAnnotationAttr

applyAnnotationAttr

getType

isValid

setVertices

setBordEffectType

setBordEffectIntensity

getVertices

getBordEffectType

getBordEffectIntensity

setRect

getRect

setFlags

getFlags

setHidden

isHidden

setReadOnly

isReadOnly

setLocked

isLocked

setBorderWidth

getBorderWidth

setContent

getContent

setCreationDate

getCreationDate

setRecentlyModifyDate

getRecentlyModifyDate

setTitle

getTitle

setName

getName

hasAp

removeAp

getApRotation

updateAp

updateApWithImage

updateApWithBitmap

getAppearance

getAppearanceByPixel

isAllowCorrectAnnotationAp

setAllowCorrectAnnotationAp

removeFromPage

removeFromPageIncludeReplyAnnot

addToPage

equal

equal

getAnnotPtr

setOnAnnotationChangedListener

disableListenAttrChanged

enableListenAttrChanged

close

setAnnotTop

getAnnotIndexFromNative

moveAnnotIndex

createReplyAnnotation

getAllReplyAnnotations

setRotation

getRotation

getSourceRect

setSourceRect

getRotateRectPoint