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.PageSize Standard page size.
static class	CPDFPage.PDFDisplayBox Not in use
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) Adds annotations on page according to the type of annotation, more: CPDFAnnotation.Type
void	addAnnot(CPDFAnnotation annotation)
CPDFWidget	addFormWidget(CPDFWidget.WidgetType type) 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.
android.graphics.PointF	convertPointFromPage(boolean isCropMode, float showWidth, float showHeight, android.graphics.PointF srcPoint) Converts PDF page coordinates to device coordinates.
android.graphics.PointF	convertPointToPage(boolean isCropMode, float showWidth, float showHeight, android.graphics.PointF srcPoint) Converts the screen coordinates of a point to page coordinates.
android.graphics.RectF	convertRectFromPage(boolean isCropMode, float showWidth, float showHeight, android.graphics.RectF srcRect) Converts page coordinates to the screen coordinates of a point.
android.graphics.RectF	convertRectFromPage(android.graphics.RectF srcRect, android.graphics.Matrix invertMatrix)
android.graphics.RectF	convertRectToPage(boolean isCropMode, float showWidth, float showHeight, android.graphics.RectF srcRect) Converts the screen coordinates of a point to page coordinates.
boolean	deleteAnnotation(CPDFAnnotation annotation) Removes the specified annotation from the page.
void	endEdit() Exit text editing mode and release resources.
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()
java.util.List<CPDFAnnotation>	getAnnotationsRecreate()
int	getAnnotCount() Gets the count of annotations on the page.
android.graphics.RectF	getBounds() not in use currently
android.graphics.RectF	getBoundsForBox(CPDFPage.PDFDisplayBox displayBox) not in use currently
android.graphics.RectF	getCropBounds() Gets crop rectangle.
void	getDisplayMatrix(android.graphics.Matrix matrixInstance, boolean isCropMode, float ox, float oy, float width, float height, int rotation)
CPDFEditPage	getEditPage(boolean isNative)
int	getPageNum()
long	getPagePtr() Get the page pointer in the native layer.
int	getRotation() Gets the rotation angle for the page in degrees.
android.graphics.RectF	getSize() Gets page size, the width isRectF.width(), the height isRectF.height()
CPDFTextPage	getTextPage() Gets TextPage, this class is for text related functions, more: CPDFTextPage
boolean	isImagePage() Whether the page is image page.
boolean	isValid() Whether object is valid.
void	refreshTextPage() Reload a new CPDFTextPage.
void	releaseAllAnnotations() Releases all annotation resources on the page.
boolean	removeAllAnnotations() Removes all the annotations from the page.
boolean	removeAllFormAnnotations() Removes all the form widgets from the page.
boolean	removeAllSign() Removes all signatures on the page.
boolean	removeAllSignStamps() Removes all signatures and stamps on the page.
boolean	renderPage(android.graphics.Bitmap bitmap, float scale, int width, int height, int startX, int startY, int drawSizeHor, int drawSizeVer, int bgColor, int bgColor_a, int rotate, boolean drawAnnot, boolean drawForm) Render contents of a page to a device independent bitmap.
boolean	renderPage(android.graphics.Bitmap bitmap, int startX, int startY, int drawSizeHor, int drawSizeVer, int bgColor, int bgColor_a, int rotate, boolean drawAnnot, boolean drawForm) Render contents of a page to a device independent bitmap.
boolean	renderPageByPixel(android.graphics.Bitmap bitmap, float scale, int width, int height, int startX, int startY, int drawSizeHor, int drawSizeVer, int bgColor, int bgColor_a, int rotate, boolean drawAnnot, boolean drawForm) Render contents of a page to a device independent bitmap.
boolean	resetAllForm() Resets all forms on the page.
boolean	setBoundsForBox(CPDFPage.PDFDisplayBox displayBox, android.graphics.RectF bounds) not in use currently
boolean	setRotation(int rotation) Sets the rotation angle for the page in degrees.
java.util.List<CPDFAnnotation>	updateHighlightAnnotations()

Methods inherited from class java.lang.Object

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

Field Detail

lockObj

public static final java.lang.Object lockObj

Method Detail

getPageNum

public int getPageNum()

isValid

public boolean isValid()

Whether object is valid.

Returns:

Returns whether object is valid.

getPagePtr

public long getPagePtr()

Get the page pointer in the native layer.

Returns:

page pointer

getBoundsForBox

public android.graphics.RectF getBoundsForBox(CPDFPage.PDFDisplayBox displayBox)

not in use currently

setBoundsForBox

public boolean setBoundsForBox(CPDFPage.PDFDisplayBox displayBox,
                               android.graphics.RectF bounds)

not in use currently

getCropBounds

public android.graphics.RectF getCropBounds()

Gets crop rectangle.

Returns:

Returns crop rectangle.

getBounds

public android.graphics.RectF getBounds()

not in use currently

getSize

public android.graphics.RectF getSize()

Gets page size, the width isRectF.width(), the height isRectF.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. Clockwise direction, opposite toCPDFAnnotation.getApRotation()

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.

convertPointToPage

public android.graphics.PointF convertPointToPage(boolean isCropMode,
                                                  float showWidth,
                                                  float showHeight,
                                                  android.graphics.PointF srcPoint)

Converts the screen coordinates of a point to page coordinates.

Parameters:

isCropMode - Whether it is crop mode.

showWidth - Width of the display area in device coordinates.

showHeight - Height of the display area in device coordinates.

srcPoint - The coordinates of the device coordinate system to be converted.

Returns:

Returns the converted PDF page coordinates.

convertPointFromPage

public android.graphics.PointF convertPointFromPage(boolean isCropMode,
                                                    float showWidth,
                                                    float showHeight,
                                                    android.graphics.PointF srcPoint)

Converts PDF page coordinates to device coordinates.

Parameters:

isCropMode - Whether it is crop mode.

showWidth - Width of the display area in device coordinates.

showHeight - Height of the display area in device coordinates.

srcPoint - The coordinates of the PDF page to be converted.

Returns:

Returns the converted device coordinates.

convertRectToPage

public android.graphics.RectF convertRectToPage(boolean isCropMode,
                                                float showWidth,
                                                float showHeight,
                                                android.graphics.RectF srcRect)

Converts the screen coordinates of a point to page coordinates.

Parameters:

isCropMode - Whether it is crop mode.

showWidth - Width of the display area in device coordinates.

showHeight - Height of the display area in device coordinates.

srcRect - The coordinates of the device coordinate system to be converted.

Returns:

Returns the converted coordinates.

convertRectFromPage

public android.graphics.RectF convertRectFromPage(boolean isCropMode,
                                                  float showWidth,
                                                  float showHeight,
                                                  android.graphics.RectF srcRect)

Converts page coordinates to the screen coordinates of a point.

Parameters:

isCropMode - Whether it is crop mode.

showWidth - Width of the display area in device coordinates.

showHeight - Height of the display area in device coordinates.

srcRect - The coordinates of the device coordinate system to be converted.

Returns:

Returns the converted coordinates.

getDisplayMatrix

public void getDisplayMatrix(android.graphics.Matrix matrixInstance,
                             boolean isCropMode,
                             float ox,
                             float oy,
                             float width,
                             float height,
                             int rotation)

convertRectFromPage

public android.graphics.RectF convertRectFromPage(android.graphics.RectF srcRect,
                                                  android.graphics.Matrix invertMatrix)

renderPage

public boolean renderPage(android.graphics.Bitmap bitmap,
                          int startX,
                          int startY,
                          int drawSizeHor,
                          int drawSizeVer,
                          int bgColor,
                          int bgColor_a,
                          int rotate,
                          boolean drawAnnot,
                          boolean drawForm)

Render contents of a page to a device independent bitmap.

Parameters:

bitmap - Handle to the device independent bitmap (as the output buffer).

startX - Left pixel position of the display area in bitmap coordinates.

startY - Top pixel position of the display area in bitmap coordinates.

drawSizeHor - Horizontal size (in pixels) for displaying the page.

drawSizeVer - Vertical size (in pixels) for displaying the page.

bgColor - Background color of the image.

bgColor_a - Background opacity of the image.

rotate - Rotation angle.

drawAnnot - Whether to draw annotation.

drawForm - Whether to draw forms.

Returns:

Returns whether to successfully render PDF page.

renderPage

public boolean renderPage(android.graphics.Bitmap bitmap,
                          float scale,
                          int width,
                          int height,
                          int startX,
                          int startY,
                          int drawSizeHor,
                          int drawSizeVer,
                          int bgColor,
                          int bgColor_a,
                          int rotate,
                          boolean drawAnnot,
                          boolean drawForm)

Render contents of a page to a device independent bitmap.

Parameters:

bitmap - Handle to the device independent bitmap (as the output buffer).

scale - Scale coefficient.

width - Width of the page.

height - Height of the page.

startX - Left pixel position of the display area in bitmap coordinates.

startY - Top pixel position of the display area in bitmap coordinates.

drawSizeHor - Horizontal size (in pixels) for displaying the page.

drawSizeVer - Vertical size (in pixels) for displaying the page.

bgColor - Background color of the image.

bgColor_a - Background opacity of the image.

rotate - Rotation angle.

drawAnnot - Whether to draw annotation.

drawForm - Whether to draw forms.

Returns:

Returns whether to successfully render PDF page.

renderPageByPixel

public boolean renderPageByPixel(android.graphics.Bitmap bitmap,
                                 float scale,
                                 int width,
                                 int height,
                                 int startX,
                                 int startY,
                                 int drawSizeHor,
                                 int drawSizeVer,
                                 int bgColor,
                                 int bgColor_a,
                                 int rotate,
                                 boolean drawAnnot,
                                 boolean drawForm)

Render contents of a page to a device independent bitmap.

Parameters:

bitmap - Handle to the device independent bitmap (as the output buffer).

scale - Scale coefficient.

width - Width of the page.

height - Height of the page.

startX - Left pixel position of the display area in bitmap coordinates.

startY - Top pixel position of the display area in bitmap coordinates.

drawSizeHor - Horizontal size (in pixels) for displaying the page.

drawSizeVer - Vertical size (in pixels) for displaying the page.

bgColor - Background color of the image.

bgColor_a - Background opacity of the image.

rotate - Rotation angle.

drawAnnot - Whether to draw annotation.

drawForm - Whether to draw forms.

Returns:

Returns whether to successfully render PDF 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.

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()

updateHighlightAnnotations

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

getAnnotationsRecreate

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

addAnnot

public void addAnnot(CPDFAnnotation annotation)

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)

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

Returns:

Returns the added annotations object.

addFormWidget

public CPDFWidget addFormWidget(CPDFWidget.WidgetType type)

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

Returns:

Returns the added form widgets object.

removeAllAnnotations

public boolean removeAllAnnotations()

Removes all the annotations from the page.

Returns:

Returns whether to successfully remove all the annotations from the page.

removeAllFormAnnotations

public boolean removeAllFormAnnotations()

Removes all the form widgets from the page.

Returns:

Returns whether to successfully remove all the form widgets from the page.

removeAllSignStamps

public boolean removeAllSignStamps()

Removes all signatures and stamps on the page.

Returns:

Returns whether to successfully remove all signatures and stamps on the page.

resetAllForm

public boolean resetAllForm()

Resets all forms on the page.

Returns:

Whether to successfully reset all forms on the page.

getTextPage

public CPDFTextPage getTextPage()

Gets TextPage, this class is for text related functions, more: CPDFTextPage

Returns:

Returns this class for text related functions, more: CPDFTextPage

removeAllSign

public boolean removeAllSign()

Removes all signatures on the page.

Returns:

Returns whether to successfully remove all signatures on the page.

close

public void close()

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

endEdit

public void endEdit()

Exit text editing mode and release resources.

releaseAllAnnotations

public void releaseAllAnnotations()

Releases all annotation resources on the page.

applyRedactions

public boolean applyRedactions()

Applies redaction annotations in current page.

Returns:

Returns whether to successfully apply redaction in current page.

getEditPage

public CPDFEditPage getEditPage(boolean isNative)

refreshTextPage

public void refreshTextPage()

Reload a new CPDFTextPage.

isImagePage

public boolean isImagePage()

Whether the page is image page.

Returns:

Whether the page is image page.