public class DocumentConversion
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static int |
e_failure |
static int |
e_incomplete |
static int |
e_success |
Constructor and Description |
---|
DocumentConversion(long impl_ptr) |
Modifier and Type | Method and Description |
---|---|
long |
__GetHandle() |
void |
cancelConversion()
Cancel the current conversion, forcing TryConvert or Convert to return.
|
void |
convert()
Perform the conversion.
|
void |
convertNextPage()
Perform the conversion.
|
void |
destroy()
Frees the native memory of the object.
|
int |
getConversionStatus()
Get the state of the conversion process.
|
PDFDoc |
getDoc()
Get a reference to the output pdf.
|
java.lang.String |
getErrorString()
If the conversion finsihed with some kind of error, this returns the value of the the error description ()otherwise returns an empty string.
|
int |
getNumConvertedPages()
Returns the number of pages which have been added to the destination document.
|
int |
getNumWarnings()
Return the number of warning strings generated during the conversion process.
|
double |
getProgress()
Returns a number from 0.0 to 1.0, representing the best estimate of conversion progress.
|
java.lang.String |
getProgressLabel()
Returns the label for the current conversion stage.
|
java.lang.String |
getWarningString(int index)
Retrieve warning strings that have been collected during the conversion process.
|
boolean |
hasProgressTracking()
Determine whether this DocumentConversion has progress reporting capability.
|
boolean |
isCancelled()
Has the conversion been cancelled?.
|
int |
tryConvert()
Perform the conversion.
|
public static final int e_success
public static final int e_incomplete
public static final int e_failure
public void destroy() throws PDFNetException
PDFNetException
public int tryConvert() throws PDFNetException
PDFNetException
public void convert() throws PDFNetException
PDFNetException
public void convertNextPage() throws PDFNetException
PDFNetException
public PDFDoc getDoc() throws PDFNetException
PDFNetException
public int getConversionStatus() throws PDFNetException
PDFNetException
public void cancelConversion() throws PDFNetException
PDFNetException
public boolean isCancelled() throws PDFNetException
PDFNetException
public boolean hasProgressTracking() throws PDFNetException
PDFNetException
public double getProgress() throws PDFNetException
PDFNetException
public java.lang.String getProgressLabel() throws PDFNetException
PDFNetException
public int getNumConvertedPages() throws PDFNetException
PDFNetException
public java.lang.String getErrorString() throws PDFNetException
PDFNetException
public int getNumWarnings() throws PDFNetException
PDFNetException
public java.lang.String getWarningString(int index) throws PDFNetException
index
- -- the index of the string to be retrieved. Must be less than GetNumWarnings().PDFNetException
public long __GetHandle()