PDFErrorHandling (Qoppa jPDFPrint API)

java.lang.Object
- com.qoppa.pdf.errors.PDFErrorHandling

```
public class PDFErrorHandling
extends Object
```
This class is used to set different error handling options within the PDF library. With the methods in this class, the host application can tell the library whether to display an error in the rendering of a page or to abort the entire rendering operation. Additionally, The class has methods for the library to keep track of errors and for the host application to get the list of errors in the last rendering operation.

Author:

Qoppa Software

Constructor Summary

Constructors
Constructor and Description

PDFErrorHandling()

Constructors
Constructor and Description
`PDFErrorHandling()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`addError(RenderError error)` Deprecated. This method has been deprecated and now has no effect.
`static void`	`addError(Throwable t, String prefixMsg)` Deprecated. This method has been deprecated and now has no effect.
`static void`	`checkForErrors_UsePDFException(String errorMsg)` Deprecated. This method has been deprecated and now has no effect.
`static void`	`checkForErrors_UsePrinterException(String errorMsg)` Deprecated. This method has been deprecated and now has no effect.
`static void`	`clearErrors()` Deprecated. This method has been deprecated and now has no effect.
`static int`	`getErrorHandling()` Deprecated. This method has been deprecated and now has no effect, the method now always returns 0.
`static Vector<RenderError>`	`getErrors()` Deprecated. This method has been deprecated and now has no effect, the method returns null always.
`static boolean`	`isThrowParseException()` Returns the value of the flag that controls whether or not an exception is thrown when there is a problem parsing the contents of a page.
`static boolean`	`isThrowXFADynamicException()` Returns the value of the flag that controls whether or not an exception is thrown when trying to build a document with an AcroForm that has Adobe XML Forms Architecture (XFA) data, and is a Dynamic Form.
`static void`	`setErrorHandling(int errorHandling)` Deprecated. This method has been deprecated and now has no effect.
`static void`	`setThrowParseException(boolean throwParseException)` When the flag is set to true, the library will throw an exception if there is an error parsing the contents of a page.
`static void`	`setThrowXFADynamicException(boolean throwDynamicXFAException)` When the flag is set to true (the default), the library will throw an error if the document being built has an AcroForm that has Adobe XML Forms Architecture (XFA) data, and is a Dynamic Form.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PDFErrorHandling
```
public PDFErrorHandling()
```
- Method Detail
  - clearErrors
```
public static void clearErrors()
```
    Deprecated. This method has been deprecated and now has no effect.
    
    Clear any errors that have accumulated from previous pages. This method is called by any page rendering operations within the library.
  - addError
```
public static void addError(RenderError error)
```
    Deprecated. This method has been deprecated and now has no effect.
    
    Add an error to the list of errors accumulated. This method is called by the internal classes in the library anytime there is an error rendering an element in a PDF page (such as an error on an image or in a font).
    
    Parameters:
    
    error - The error.
  - addError
```
public static void addError(Throwable t,
                            String prefixMsg)
```
    Deprecated. This method has been deprecated and now has no effect.
    
    Add an error to the list of errors accumulated. This method is called by the internal classes in the library anytime there is an error rendering an element in a PDF page (such as an error on an image or in a font). THis is a convenience method that takes an exception and an error message and then creates a RenderError object to add to the error list.
    
    Parameters:
    
    t - The exception that was thrown.
    
    prefixMsg - A message to prefix to error string.
  - getErrors
```
public static Vector<RenderError> getErrors()
```
    Deprecated. This method has been deprecated and now has no effect, the method returns null always.
    
    Gets a list of errors in the last rendering. This method can be called by the host application after a rendering when the error handling is set to EH_SHOW_ERROR_AND_CONTINUE to find out if there were any errors in the rendering.
    
    Returns:
    
    A list of errors.
  - checkForErrors_UsePrinterException
```
public static void checkForErrors_UsePrinterException(String errorMsg)
```
    Deprecated. This method has been deprecated and now has no effect.
    
    This is a convenience method that gets called by the library after printing a page. If there were errors when printing the page, and error handling is set to EH_ABORT_PAGE, the method throws a PrinterException.
    
    Parameters:
    
    errorMsg - The error message to use in the PrinterException.
  - checkForErrors_UsePDFException
```
public static void checkForErrors_UsePDFException(String errorMsg)
```
    Deprecated. This method has been deprecated and now has no effect.
    
    This is a convenience method that gets called by the library after a rendering. If there were errors when rendering the contents of a page, and error handling is set to EH_ABORT_RENDERING, the method throws a PDFException, thereby aborting the entire rendering of the document.
    
    Parameters:
    
    errorMsg - The error message to use in the PDFException.
  - getErrorHandling
```
public static int getErrorHandling()
```
    Deprecated. This method has been deprecated and now has no effect, the method now always returns 0.
    
    Returns the current value of the error handling flag.
    
    Returns:
    
    The current value of the error handling flag. This value can be either EH_SHOW_ERROR_AND_CONTINUE or EH_ABORT_RENDERING.
  - setErrorHandling
```
public static void setErrorHandling(int errorHandling)
```
    Deprecated. This method has been deprecated and now has no effect.
    
    Sets the value of the error handling flag. THis can be either EH_SHOW_ERROR_AND_CONTINUE or EH_ABORT_RENDERING.
    
    Parameters:
    
    errorHandling - The new value of the error handling flag.
  - isThrowXFADynamicException
```
public static boolean isThrowXFADynamicException()
```
    Returns the value of the flag that controls whether or not an exception is thrown when trying to build a document with an AcroForm that has Adobe XML Forms Architecture (XFA) data, and is a Dynamic Form.
    
    Returns:
    
    Boolean flag that indicates whether to throw an exception on documents with a Dynamic Form.
  - setThrowXFADynamicException
```
public static void setThrowXFADynamicException(boolean throwDynamicXFAException)
```
    When the flag is set to true (the default), the library will throw an error if the document being built has an AcroForm that has Adobe XML Forms Architecture (XFA) data, and is a Dynamic Form. If the flag is false, there will be no error.
    
    Parameters:
    
    throwDynamicXFAException - The new value of the flag.
  - isThrowParseException
```
public static boolean isThrowParseException()
```
    Returns the value of the flag that controls whether or not an exception is thrown when there is a problem parsing the contents of a page.
    
    Returns:
    
    Boolean flag that indicates whether to throw an exception on errors parsing page content.
  - setThrowParseException
```
public static void setThrowParseException(boolean throwParseException)
```
    When the flag is set to true, the library will throw an exception if there is an error parsing the contents of a page. When false, the library will attempt to continue to parse the page and display what contents it is able to parse. *
    
    Parameters:
    
    throwParseException - The new value of the flag.

Class PDFErrorHandling

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PDFErrorHandling

Method Detail

clearErrors

addError

addError

getErrors

checkForErrors_UsePrinterException

checkForErrors_UsePDFException

getErrorHandling

setErrorHandling

isThrowXFADynamicException

setThrowXFADynamicException

isThrowParseException

setThrowParseException