com.compdfkit.core.annotation

Class CPDFAnnotation

java.lang.Object

com.compdfkit.core.annotation.CPDFAnnotation

Direct Known Subclasses:

CPDFCircleAnnotation, CPDFFreetextAnnotation, CPDFInkAnnotation, CPDFLineAnnotation, CPDFLinkAnnotation, CPDFMarkupAnnotation, CPDFMovieAnnotation, CPDFRedactAnnotation, 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 interface	CPDFAnnotation.Flags A set of flags specifying various characteristics of the annotation.
static class	CPDFAnnotation.Type Annotation types

Field Summary

Fields

Modifier and Type	Field and Description
protected long	annotPtr
protected java.lang.Integer	apRotation
protected CPDFPage	pdfPage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CPDFAnnotation(long annotPtr, CPDFAnnotation.Type type)

Method Summary

Modifier and Type	Method and Description
boolean	addToPage() Adds annotation into PDF page
protected boolean	clearFilledRGBColor() Clear annotation fill color.
protected boolean	clearFilledTransparency() Clear annotation fill transparency.
void	close() When the object is no longer in use, call this method to release resources.
protected int[]	getAppearanceByPixel(int width, int height, CPDFAnnotation.AppearanceType type) Gets annotation appearance by pixel with Bitmap.
protected int	getApRotation() Gets rotation angle of annotation appearance.
protected float[]	getBgRGBColor() Gets background color of annotation.
protected float[]	getBorderRGBColor() Gets line color of annotation.
protected CPDFBorderStyle	getBorderStyle() Gets border style, more: CPDFBorderStyle
protected float	getBorderWidth() Gets border width of annotation.
java.lang.String	getContent() Gets annotation content.
CPDFDate	getCreationDate() Gets the creation date of annotation.
protected float[]	getFilledRGBColor() Gets annotation fill color.
protected float	getFilledTransparency() Gets fill color opacity.
int	getFlags() Gets annotation flags.
java.lang.String	getName() Not in use currently
protected java.lang.String	getOverLayText()
CPDFDate	getRecentlyModifyDate() Gets the modification date of annotation.
RectF	getRect() Gets annotation rectangle.
protected float[]	getRGBColor() Gets annotation color.
java.lang.String	getTitle() Not in use currently
protected float	getTransparency() Gets annotation opacity, Range 0-1, 0 is completely transparent, 1 is completely opaque.
CPDFAnnotation.Type	getType() Gets annotation type, more:CPDFAnnotation.Type
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`.
protected boolean	isReadOnly() This is a convenience property that checks for `CPDFAnnotationFlagReadOnly` in `flags`.
boolean	isValid() Whether annotation object is valid.
protected boolean	removeAp() Removes annotation appearance.
boolean	removeFromPage() Removes annotation from PDF page
void	setAllowCorrectAnnotationAp(boolean allowCorrectAnnotationAp) Sets whether to allow to correct annotation appearance
protected boolean	setBgRGBColor(float r, float g, float b) Sets background color of annotation.
protected boolean	setBorderRGBColor(float r, float g, float b) Sets line color of annotation .
protected boolean	setBorderStyle(CPDFBorderStyle borderStyle) Sets border style, more: CPDFBorderStyle
protected 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.
protected boolean	setFilledRGBColor(float r, float g, float b) Sets annotation fill color.
protected boolean	setFilledTransparency(float transparency) Sets fill color opacity.
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	setName(java.lang.String name) Not in use currently
protected boolean	setOverLayText(java.lang.String overlayText)
protected 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(RectF rect) Sets annotation rectangle.
protected boolean	setRGBColor(float r, float g, float b) Sets annotation color.
boolean	setTitle(java.lang.String title) Not in use currently
protected boolean	setTransparency(float transparency) Sets annotation opacity, Range 0-1, 0 is completely transparent, 1 is completely opaque.
protected boolean	updateAp() Updates annotation appearance.
protected boolean	updateApWithBitmap(int[] pixels, int width, int height) Upadates annotation appearance by Bitmap.
protected boolean	updateApWithImage(java.lang.String imagePath, java.lang.String smaskPath) Update annotation appearance with image.

Methods inherited from class java.lang.Object

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

Field Detail

annotPtr

protected long annotPtr

pdfPage

protected CPDFPage pdfPage

apRotation

protected java.lang.Integer apRotation

Constructor Detail

CPDFAnnotation

protected CPDFAnnotation(long annotPtr,
                         CPDFAnnotation.Type type)

Method Detail

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.

setRect

public boolean setRect(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.

Parameters:

rect - Rectangle on the page.

Returns:

Returns whether to successfully set annotation rectangle.

getRect

public 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.

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'

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'

setReadOnly

protected 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

protected boolean isReadOnly()

This is a convenience property that checks for `CPDFAnnotationFlagReadOnly` in `flags`.

Returns:

Returns the result of 'CPDFAnnotationFlagReadOnly'

setBorderWidth

protected 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

protected float getBorderWidth()

Gets border width of annotation.

Returns:

Returns border width of annotation.

setRGBColor

protected boolean setRGBColor(float r,
                              float g,
                              float b)

Sets annotation color.

Parameters:

r - Range 0-1

g - Range 0-1

b - Range 0-1

Returns:

Returns whether to successfully set annotation color.

getRGBColor

protected float[] getRGBColor()

Gets annotation color.

Returns:

Returns annotation color value: r, g, b

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

setTransparency

protected boolean setTransparency(float transparency)

Sets annotation opacity, Range 0-1, 0 is completely transparent, 1 is completely opaque.

Parameters:

transparency - Annotation opacity.

Returns:

Returns whether to successfully set annotation opacity.

getTransparency

protected float getTransparency()

Gets annotation opacity, Range 0-1, 0 is completely transparent, 1 is completely opaque. If the transparency of the annotation is not available, the default is 0.6.

Returns:

Returns annotation opacity.

setFilledRGBColor

protected boolean setFilledRGBColor(float r,
                                    float g,
                                    float b)

Sets annotation fill color.

Parameters:

r - Range 0-1

g - Range 0-1

b - Range 0-1

Returns:

Returns whether to successfully set annotation fill color.

getFilledRGBColor

protected float[] getFilledRGBColor()

Gets annotation fill color.

Returns:

Returns annotation fill color.

clearFilledRGBColor

protected boolean clearFilledRGBColor()

Clear annotation fill color.

Returns:

Returns whether to successfully clear annotation fill color.

setFilledTransparency

protected boolean setFilledTransparency(float transparency)

Sets fill color opacity.

Parameters:

transparency - Fill color opacity, range 0-1

Returns:

Returns whether to successfully set fill color opacity.

getFilledTransparency

protected float getFilledTransparency()

Gets fill color opacity.

Returns:

Returns fill color opacity , range 0-1

clearFilledTransparency

protected boolean clearFilledTransparency()

Clear annotation fill transparency.

Returns:

Returns whether to successfully clear annotation fill transparency.

setOverLayText

protected boolean setOverLayText(java.lang.String overlayText)

getOverLayText

protected java.lang.String getOverLayText()

setBorderRGBColor

protected boolean setBorderRGBColor(float r,
                                    float g,
                                    float b)

Sets line color of annotation .

Parameters:

r - Range 0-1

g - Range 0-1

b - Range 0-1

Returns:

Returns whether to successfully set line color of annotation.

getBorderRGBColor

protected float[] getBorderRGBColor()

Gets line color of annotation.

Returns:

Returns line color of annotation.

setBgRGBColor

protected boolean setBgRGBColor(float r,
                                float g,
                                float b)

Sets background color of annotation.

Parameters:

r - Range 0-1

g - Range 0-1

b - Range 0-1

Returns:

Returns whether to successfully set annotation background color.

getBgRGBColor

protected float[] getBgRGBColor()

Gets background color of annotation.

Returns:

Returns background color of annotation.

setBorderStyle

protected boolean setBorderStyle(CPDFBorderStyle borderStyle)

Sets border style, more: CPDFBorderStyle

Parameters:

borderStyle - Border style, more: CPDFBorderStyle

Returns:

Returns whether to successfully set border style.

getBorderStyle

protected CPDFBorderStyle getBorderStyle()

Gets border style, more: CPDFBorderStyle

Returns:

Returns border style, more: CPDFBorderStyle

removeFromPage

public boolean removeFromPage()

Removes annotation from PDF page

Returns:

Returns whether to successfully remove annotation.

addToPage

public boolean addToPage()

Adds annotation into PDF page

Returns:

Returns whether to successfully add annotation.

hasAp

public boolean hasAp()

Whether annotation has appearance.

Returns:

Returns whether annotation has appearance.

removeAp

protected boolean removeAp()

Removes annotation appearance.

Returns:

Returns whether to successfully remove annotation appearance.

getApRotation

protected int getApRotation()

Gets rotation angle of annotation appearance.

Returns:

Returns rotation angle of annotation appearance. It is counterclockwise direction.

updateAp

protected 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

protected 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

protected boolean updateApWithBitmap(int[] pixels,
                                     int width,
                                     int height)

Upadates annotation appearance by Bitmap.

Parameters:

pixels - Bitmap pixels.

width - Bitmap width.

height - Bitmap height.

Returns:

Returns whether to successfully upadate annotation appearance.

getAppearanceByPixel

protected int[] getAppearanceByPixel(int width,
                                     int height,
                                     CPDFAnnotation.AppearanceType type)

Gets annotation appearance by pixel with Bitmap.

Parameters:

width - Bitmap width.

height - Bitmap height.

type - AppearanceType.

Returns:

Returns pixels 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

close

public void close()

When the object is no longer in use, call this method to release resources.