com.compdfkit.core.page

Class CPDFPage

java.lang.Object

com.compdfkit.core.page.CPDFPage

public class CPDFPage
extends java.lang.Object

TPDFPage defines methods used to render PDF pages and work with annotations, text, selections and so on.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CPDFPage.PDFFlattenOption flatten options

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Object	lockObj

Method Summary

Modifier and Type	Method and Description
CPDFAnnotation	addAnnot(CPDFAnnotation.Type type, CPDFDocument document) Adds annotations on page according to the type of annotation, more: CPDFAnnotation.Type
CPDFWidget	addFormWidget(CPDFWidget.WidgetType type, CPDFDocument document) Adds a form widget on the page according to the type of form widgets.
boolean	applyRedactions() Applies redaction annotations in current page.
void	close() When the object is no longer in use, call this method to release resources.
boolean	deleteAnnotation(CPDFAnnotation annotation) Removes the specified annotation from the page.
boolean	extractImages(java.lang.String filePath) Exports all the images on the page.
boolean	flatten(CPDFPage.PDFFlattenOption flattenOption) Flatten annotations and form fields into the page contents.
java.util.List<CPDFAnnotation>	getAnnotations() Gets all the annotation collections on the page.
int	getAnnotCount() Gets the count of annotations on the page.
RectF	getBounds() not in use currently
int	getPageNum()
long	getPagePtr() Get the page pointer in the native layer.
int	getRotation() Gets the rotation angle for the page in degrees.
RectF	getSize() Gets page size, the width iscandroid.graphics.RectF#width(), the height isandroid.graphics.RectF#height()
boolean	isValid() Whether object is valid.
void	releaseAllAnnotations() Releases all annotation resources on the page.
void	setPageNum(int pageNum)
boolean	setRotation(int rotation) Sets the rotation angle for the page in degrees.

Methods inherited from class java.lang.Object

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

Field Detail

lockObj

public static final java.lang.Object lockObj

Method Detail

getPageNum

public int getPageNum()

setPageNum

public void setPageNum(int pageNum)

getBounds

public RectF getBounds()

not in use currently

getSize

public RectF getSize()

Gets page size, the width iscandroid.graphics.RectF#width(), the height isandroid.graphics.RectF#height()

Returns:

Returns page size.

getRotation

public int getRotation()

Gets the rotation angle for the page in degrees.

Returns:

Returns the rotation angle for the page in degrees.

setRotation

public boolean setRotation(int rotation)

Sets the rotation angle for the page in degrees.

Parameters:

rotation - Rotation on a page. Must be 0, 90, 180 or 270.

Returns:

Whether to successfully set the rotation angle for the page in degrees.

flatten

public boolean flatten(CPDFPage.PDFFlattenOption flattenOption)

Flatten annotations and form fields into the page contents.

Parameters:

flattenOption - One of the flattenOption values denoting the page usage, more CPDFPage.PDFFlattenOption

Returns:

Returns whether to successfully flatten.

getAnnotCount

public int getAnnotCount()

Gets the count of annotations on the page.

Returns:

Returns the count of annotations on the page.

getAnnotations

public java.util.List<CPDFAnnotation> getAnnotations()

Gets all the annotation collections on the page.

Returns:

Returns all the annotation collections on the page.

deleteAnnotation

public boolean deleteAnnotation(CPDFAnnotation annotation)

Removes the specified annotation from the page.

Parameters:

annotation - The specified annotation to be removed

Returns:

Returns whether to successfully remove the specified annotation from the page.

addAnnot

public CPDFAnnotation addAnnot(CPDFAnnotation.Type type,
                               CPDFDocument document)

Adds annotations on page according to the type of annotation, more: CPDFAnnotation.Type

Parameters:

type - The type of annotation to be added, more: CPDFAnnotation.Type

document - This class is about CPDFDocument, one CPDFDocument class for one document.

Returns:

Returns the added annotations object.

applyRedactions

public boolean applyRedactions()

Applies redaction annotations in current page.

Returns:

Returns whether to successfully apply redaction in current page.

extractImages

public boolean extractImages(java.lang.String filePath)

Exports all the images on the page.

Parameters:

filePath - Exports image to specified path.

Returns:

Returns whether to successfully export all the images.

addFormWidget

public CPDFWidget addFormWidget(CPDFWidget.WidgetType type,
                                CPDFDocument document)

Adds a form widget on the page according to the type of form widgets. , more: CPDFAnnotation.Type

Parameters:

type - Type of form widgets, more: CPDFAnnotation.Type

document - This class is about CPDFDocument, one CPDFDocument class for one document.

Returns:

Returns the added form widgets object.

getPagePtr

public long getPagePtr()

Get the page pointer in the native layer.

Returns:

page pointer

isValid

public boolean isValid()

Whether object is valid.

Returns:

Returns whether object is valid.

releaseAllAnnotations

public void releaseAllAnnotations()

Releases all annotation resources on the page.

close

public void close()

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