public class Progress
extends java.lang.Object
Progress
represents a progressive process.
The Progress
class provides a mechanism for a long time operations to
progressive process. Foxit PDF SDK contains several different types of
progressive processes. So Progress
object can be constructed in many different ways according to its usage.
Please refer to each progress relative method for more details.
Example:
Progress progress = PDFReflowPage.startParse(int); Progress progress = PDFReflowPage.startRender(RenderContext, Renderer); Progress progress = PDFPage.startParse(int);
PDFReflowPage.startParse(int)
,
PDFReflowPage.startRender(RenderContext, Renderer)
,
PDFPage.startParse(int)
,
PDFPage.startRender(RenderContext, Renderer, int)
,
PDFPage.startRenderAnnots(RenderContext, Renderer,
com.foxit.gsdk.pdf.annots.Annot[])
,
PDFPage.startRenderPageAnnots(RenderContext, Renderer)
,
PDFPage.startRenderFormControls(RenderContext, Renderer,
com.foxit.gsdk.pdf.form.PDFFormControl[])
,
PDFPage.startRenderPageFormControls(RenderContext, Renderer)
,
PDFDocument.startSaveToFile(com.foxit.gsdk.utils.FileHandler, int)
,
PDFDocument.startImportPages(PDFDocument, int, PDFDocument, int[], String)
Modifier and Type | Field and Description |
---|---|
static int |
FINISHED
Current process has finished, and no need to do again.
|
static int |
ROLLBACK
To rollback the application process.
|
static int |
TOBECONTINUED
Current process needs to be continued.
|
Modifier and Type | Method and Description |
---|---|
int |
continueProgress(int millisecond)
Continue a progressive process.
|
int |
getPercent()
Get the percent of progressive process.
|
void |
release()
Release the current progressive process.
|
public static final int TOBECONTINUED
It's used under progressive calls, and tells caller to call function
again.
continueProgress(int)
public static final int FINISHED
public static final int ROLLBACK
public int continueProgress(int millisecond) throws PDFException
millisecond
- A integer value which represents millisecond, used to determine break state.
This value should be non-negative.
If it's 0
, the current process will not be paused.FINISHED
if the current process finishes successfully.TOBECONTINUED
if the current process is paused,
and user just needs to call this function again.PDFException
- For more exception information please see definitions
PDFException.ERRCODE_XXX
.PDFException
public int getPercent() throws PDFException
PDFException
- For more exception information please see definitions
PDFException.ERRCODE_XXX
.PDFException
public void release()