PdfRendererPreV.Page
public
final
class
PdfRendererPreV.Page
extends Object
implements
AutoCloseable
java.lang.Object | |
↳ | android.graphics.pdf.PdfRendererPreV.Page |
This class represents a PDF document page for rendering.
Summary
Public methods | |
---|---|
List<Rect>
|
applyEdit(FormEditRecord editRecord)
Applies a |
void
|
close()
Closes this page. |
FormWidgetInfo
|
getFormWidgetInfoAtIndex(int annotationIndex)
Returns information about the widget with |
FormWidgetInfo
|
getFormWidgetInfoAtPosition(int x, int y)
Returns information about the widget at the given point. |
List<FormWidgetInfo>
|
getFormWidgetInfos()
Returns information about all form widgets on the page, or an empty list if there are no form widgets on the page. |
List<FormWidgetInfo>
|
getFormWidgetInfos(int[] types)
Returns information about all form widgets of the specified types on the page, or an empty list if there are no form widgets of the specified types on the page. |
List<PdfPageGotoLinkContent>
|
getGotoLinks()
Gets bookmarks and goto links present on the page of a pdf document. |
int
|
getHeight()
Returns the height of the given |
List<PdfPageImageContent>
|
getImageContents()
Return list of |
int
|
getIndex()
Gets the page index. |
List<PdfPageLinkContent>
|
getLinkContents()
Get the bounds and URLs of all the links on the given page. |
List<PdfPageTextContent>
|
getTextContents()
Return list of |
int
|
getWidth()
Returns the width of the given |
void
|
render(Bitmap destination, Rect destClip, Matrix transform, RenderParams params)
Renders a page to a bitmap. |
List<PageMatchBounds>
|
searchText(String query)
Search for the given string on the page and returns the bounds of all the matches. |
PageSelection
|
selectContent(SelectionBoundary start, SelectionBoundary stop)
Return a |
Protected methods | |
---|---|
void
|
finalize()
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |
Inherited methods | |
---|---|
Public methods
applyEdit
public List<Rect> applyEdit (FormEditRecord editRecord)
Applies a FormEditRecord
to the PDF.
Apps must call render(android.graphics.Bitmap, android.graphics.Rect, android.graphics.Matrix, android.graphics.pdf.RenderParams)
to render new
bitmaps for the corresponding areas of the page.
For click type FormEditRecord
s, performs a click on FormEditRecord.getClickPoint()
For set text type FormEditRecord
s, sets the text value of the form widget.
For set indices type FormEditRecord
s, sets the FormEditRecord.getSelectedIndices()
as selected and all others as unselected for the
form widget indicated by the record.
Parameters | |
---|---|
editRecord |
FormEditRecord : the FormEditRecord to be applied
This value cannot be null . |
Returns | |
---|---|
List<Rect> |
Rectangular areas of the page bitmap that have been invalidated by this action.
This value cannot be null . |
Throws | |
---|---|
IllegalArgumentException |
if the provided FormEditRecord cannot be
applied to the widget indicated by the index, or if the
index does not correspond to a widget on the page. |
IllegalStateException |
If the document is already closed. |
IllegalStateException |
If the page is already closed. |
getFormWidgetInfoAtIndex
public FormWidgetInfo getFormWidgetInfoAtIndex (int annotationIndex)
Returns information about the widget with annotationIndex
.
Parameters | |
---|---|
annotationIndex |
int : the index of the widget within the page's "Annot" array in the
PDF document, available on results of previous calls to
getFormWidgetInfos(int[]) or
getFormWidgetInfoAtPosition(int, int) via
FormWidgetInfo#getWidgetIndex() .
Value is 0 or greater |
Returns | |
---|---|
FormWidgetInfo |
This value cannot be null . |
Throws | |
---|---|
IllegalArgumentException |
if there is no form widget at the provided index. |
IllegalStateException |
If the document is already closed. |
IllegalStateException |
If the page is already closed. |
getFormWidgetInfoAtPosition
public FormWidgetInfo getFormWidgetInfoAtPosition (int x, int y)
Returns information about the widget at the given point.
Parameters | |
---|---|
x |
int : the x position of the widget on the page, in points |
y |
int : the y position of the widget on the page, in points |
Returns | |
---|---|
FormWidgetInfo |
This value cannot be null . |
Throws | |
---|---|
IllegalArgumentException |
if there is no form widget at the provided position. |
IllegalStateException |
If the document is already closed. |
IllegalStateException |
If the page is already closed. |
getFormWidgetInfos
public List<FormWidgetInfo> getFormWidgetInfos ()
Returns information about all form widgets on the page, or an empty list if there are no form widgets on the page.
Returns | |
---|---|
List<FormWidgetInfo> |
This value cannot be null . |
Throws | |
---|---|
IllegalStateException |
If the document is already closed. |
IllegalStateException |
If the page is already closed. |
getFormWidgetInfos
public List<FormWidgetInfo> getFormWidgetInfos (int[] types)
Returns information about all form widgets of the specified types on the page, or an empty list if there are no form widgets of the specified types on the page.
Parameters | |
---|---|
types |
int : the types of form widgets to return, or an empty array to return all widgets
Value is FormWidgetInfo.WIDGET_TYPE_UNKNOWN , FormWidgetInfo.WIDGET_TYPE_PUSHBUTTON , FormWidgetInfo.WIDGET_TYPE_CHECKBOX , FormWidgetInfo.WIDGET_TYPE_RADIOBUTTON , FormWidgetInfo.WIDGET_TYPE_COMBOBOX , FormWidgetInfo.WIDGET_TYPE_LISTBOX , FormWidgetInfo.WIDGET_TYPE_TEXTFIELD , or FormWidgetInfo.WIDGET_TYPE_SIGNATURE
This value cannot be null . |
Returns | |
---|---|
List<FormWidgetInfo> |
This value cannot be null . |
Throws | |
---|---|
IllegalStateException |
If the document is already closed. |
IllegalStateException |
If the page is already closed. |
getGotoLinks
public List<PdfPageGotoLinkContent> getGotoLinks ()
Gets bookmarks and goto links present on the page of a pdf document. Goto Links are the internal navigation links which directs the user to different location within the same document.
Returns | |
---|---|
List<PdfPageGotoLinkContent> |
list of all goto links PdfPageGotoLinkContent on a page, ordered
left to right and top to bottom.
This value cannot be null . |
Throws | |
---|---|
IllegalStateException |
If the document/page is closed before invocation. |
getHeight
public int getHeight ()
Returns the height of the given Page
object in points (1/72"). It is not
guaranteed that all pages will have the same height and the viewport should be resized to
the given page height.
Returns | |
---|---|
int |
height of the given page Value is 0 or greater |
Throws | |
---|---|
IllegalStateException |
If the document/page is closed before invocation. |
getImageContents
public List<PdfPageImageContent> getImageContents ()
Return list of PdfPageImageContent
found on the page, ordered left to right
and top to bottom. It contains all the content associated with images found on the
page including alt text. The list will be empty if there are no results found.
Currently, localisation does not have any impact on the order in which
PdfPageImageContent
is returned.
Returns | |
---|---|
List<PdfPageImageContent> |
list of image content found on the page.
This value cannot be null . |
Throws | |
---|---|
IllegalStateException |
If the document/page is closed before invocation. |
getIndex
public int getIndex ()
Gets the page index.
Returns | |
---|---|
int |
The index. Value is 0 or greater |
getLinkContents
public List<PdfPageLinkContent> getLinkContents ()
Get the bounds and URLs of all the links on the given page.
Returns | |
---|---|
List<PdfPageLinkContent> |
list of all links on the page.
This value cannot be null . |
Throws | |
---|---|
IllegalStateException |
If the document/page is closed before invocation. |
getTextContents
public List<PdfPageTextContent> getTextContents ()
Return list of PdfPageTextContent
found on the page, ordered left to right
and top to bottom. It contains all the content associated with text found on the page.
The list will be empty if there are no results found. Currently, localisation does
not have any impact on the order in which PdfPageTextContent
is returned.
Returns | |
---|---|
List<PdfPageTextContent> |
list of text content found on the page.
This value cannot be null . |
Throws | |
---|---|
IllegalStateException |
If the document/page is closed before invocation. |
getWidth
public int getWidth ()
Returns the width of the given Page
object in points (1/72"). It is not
guaranteed that all pages will have the same width and the viewport should be resized to
the given page width.
Returns | |
---|---|
int |
width of the given page Value is 0 or greater |
Throws | |
---|---|
IllegalStateException |
If the document/page is closed before invocation. |
render
public void render (Bitmap destination, Rect destClip, Matrix transform, RenderParams params)
Renders a page to a bitmap. In case of default zoom, the Bitmap
dimensions will
be equal to the page dimensions. In this case, Rect
parameter can be null.
In case of zoom, the Rect
parameter needs to be specified which represents
the offset from top and left for tile generation purposes. In this case, the
Bitmap
dimensions should be equal to the tile dimensions.
Note: The method will take care of closing the bitmap. Should be
invoked
on the ERROR(/android.annotation.WorkerThread)
as it is long-running task.
Parameters | |
---|---|
destination |
Bitmap : Destination bitmap to write to.
This value cannot be null . |
destClip |
Rect : If null, default zoom is applied. In case the value is non-null, the
value specifies the top top-left corner of the tile. |
transform |
Matrix : Applied to scale the bitmap up/down from default 1/72 points.
This value may be null . |
params |
RenderParams : Render params for the changing display mode and/or annotations.
This value cannot be null . |
Throws | |
---|---|
IllegalStateException |
If the document/page is closed before invocation. |
searchText
public List<PageMatchBounds> searchText (String query)
Search for the given string on the page and returns the bounds of all the matches. The list will be empty if there are no matches on the given page. If this function was invoked previously for any page, it will wait for that operation to complete before this operation is started.
Note: Should be invoked on the ERROR(/android.annotation.WorkerThread)
as it is long-running task.
Parameters | |
---|---|
query |
String : plain search string for querying the document
This value cannot be null . |
Returns | |
---|---|
List<PageMatchBounds> |
List of PageMatchBounds representing the bounds of each match on the
page.
This value cannot be null . |
Throws | |
---|---|
IllegalStateException |
If the document/page is closed before invocation. |
selectContent
public PageSelection selectContent (SelectionBoundary start, SelectionBoundary stop)
Return a PageSelection
which represents the selected content that spans between
the two boundaries. The boundaries can be either exactly defined with text indexes, or
approximately defined with points on the page. The resulting selection will also be
exactly defined with both indexes and points. If the start and stop boundary are both at
the same point, selects the word at that point. In case the selection from the given
boundaries result in an empty space, then the method returns null
. The start and
stop SelectionBoundary
in PageSelection
resolves to the "nearest" index
when returned.
Note: Should be invoked on a ERROR(/android.annotation.WorkerThread)
as it is long-running task.
Parameters | |
---|---|
start |
SelectionBoundary : boundary where the selection starts (inclusive)
This value cannot be null . |
stop |
SelectionBoundary : boundary where the selection stops (exclusive)
This value cannot be null . |
Returns | |
---|---|
PageSelection |
collection of the selected content for text, images, etc. |
Throws | |
---|---|
IllegalStateException |
If the document/page is closed before invocation. |
Protected methods
finalize
protected void finalize ()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
A subclass overrides the finalize
method to dispose of
system resources or to perform other cleanup.
The general contract of finalize
is that it is invoked
if and when the Java virtual
machine has determined that there is no longer any
means by which this object can be accessed by any thread that has
not yet died, except as a result of an action taken by the
finalization of some other object or class which is ready to be
finalized. The finalize
method may take any action, including
making this object available again to other threads; the usual purpose
of finalize
, however, is to perform cleanup actions before
the object is irrevocably discarded. For example, the finalize method
for an object that represents an input/output connection might perform
explicit I/O transactions to break the connection before the object is
permanently discarded.
The finalize
method of class Object
performs no
special action; it simply returns normally. Subclasses of
Object
may override this definition.
The Java programming language does not guarantee which thread will
invoke the finalize
method for any given object. It is
guaranteed, however, that the thread that invokes finalize will not
be holding any user-visible synchronization locks when finalize is
invoked. If an uncaught exception is thrown by the finalize method,
the exception is ignored and finalization of that object terminates.
After the finalize
method has been invoked for an object, no
further action is taken until the Java virtual machine has again
determined that there is no longer any means by which this object can
be accessed by any thread that has not yet died, including possible
actions by other objects or classes which are ready to be finalized,
at which point the object may be discarded.
The finalize
method is never invoked more than once by a Java
virtual machine for any given object.
Any exception thrown by the finalize
method causes
the finalization of this object to be halted, but is otherwise
ignored.
Throws | |
---|---|
Throwable |