Summary: Ctors | Methods | Inherited Methods | [Expand All]
public class

# PDFUAOptions

extends OptionsBase

java.lang.Object
↳ | com.pdftron.pdf.OptionsBase
| ↳ | com.pdftron.pdf.pdfua.PDFUAOptions

## Summary

Public Constructors
| PDFUAOptions() Constructor.
| PDFUAOptions(String json_string) Constructor.

Public Methods
int | getConformanceLevel() Gets the value ConformanceLevel from the options object.
String | getDefaultLangCode() Gets the value DefaultLangCode from the options object.
String | getFigureAltTextPrefix() Gets the value FigureAltTextPrefix from the options object.
boolean | getFirstStop() Gets the value FirstStop from the options object.
int | getMaxRefObjs() Gets the value MaxRefObjs from the options object.
String | getPassword() Gets the value Password from the options object.
boolean | getSaveLinearized() Gets the value SaveLinearized from the options object.
PDFUAOptions | setConformanceLevel(int value) Sets the value for ConformanceLevel in the options object.
PDFUAOptions | setDefaultLangCode(String value) Sets the value for DefaultLangCode in the options object.
PDFUAOptions | setFigureAltTextPrefix(String value) Sets the value for FigureAltTextPrefix in the options object.
PDFUAOptions | setFirstStop(boolean value) Sets the value for FirstStop in the options object.
PDFUAOptions | setMaxRefObjs(int value) Sets the value for MaxRefObjs in the options object.
PDFUAOptions | setPassword(String value) Sets the value for Password in the options object.
PDFUAOptions | setSaveLinearized(boolean value) Sets the value for SaveLinearized in the options object.

[Expand] Inherited Methods
From class java.lang.Object
boolean | equals(Object arg0)
final Class<?> | getClass()
int | hashCode()
final void | notify()
final void | notifyAll()
String | toString()
final void | wait(long arg0, int arg1)
final void | wait(long arg0)
final void | wait()

## Public Constructors

#### public PDFUAOptions ()

Constructor.

##### Throws

PDFNetException |

#### public PDFUAOptions (String json_string)

Constructor.

##### Throws

PDFNetException |

## Public Methods

#### public int getConformanceLevel ()

Gets the value ConformanceLevel from the options object. The PDF/UA conformance level. By default the conformance level is PDF/UA-1.

##### Returns

- The PDF/UA conformance level. By default the conformance level is PDF/UA-1.

##### Throws

PDFNetException |

#### public String getDefaultLangCode ()

Gets the value DefaultLangCode from the options object. The natural language code to set on the document if it is missing.

##### Returns

- The current value for DefaultLangCode.

##### Throws

PDFNetException |

#### public String getFigureAltTextPrefix ()

Gets the value FigureAltTextPrefix from the options object. The prefix to use when setting Alt for Image and Graphic tags. By default, and when this is empty, the tag name will be used.

##### Returns

- The current value for FigureAltTextPrefix.

##### Throws

PDFNetException |

#### public boolean getFirstStop ()

Gets the value FirstStop from the options object. Whether to stop processing after the first PDF/UA error is detected. By default, processing continues.

##### Returns

- Whether to stop processing after the first PDF/UA error is detected. By default, processing continues.

##### Throws

PDFNetException |

#### public int getMaxRefObjs ()

Gets the value MaxRefObjs from the options object. The maximum number of object references per error condition. This is 10 by default.

##### Returns

- The maximum number of object references per error condition. This is 10 by default.

##### Throws

PDFNetException |

#### public String getPassword ()

Gets the value Password from the options object. The password to be used for encrypted PDF documents. By default, no password is used.

##### Returns

- The password to be used for encrypted PDF documents. By default, no password is used.

##### Throws

PDFNetException |

#### public boolean getSaveLinearized ()

Gets the value SaveLinearized from the options object. Whether to linearize when saving converted output. By default, the output is not linearized.

##### Returns

- Whether to linearize when saving converted output. By default, the output is not linearized.

##### Throws

PDFNetException |

#### public PDFUAOptions setConformanceLevel (int value)

Sets the value for ConformanceLevel in the options object. The PDF/UA conformance level. By default the conformance level is PDF/UA-1.

##### Parameters

value | The PDF/UA conformance level. By default the conformance level is PDF/UA-1.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public PDFUAOptions setDefaultLangCode (String value)

Sets the value for DefaultLangCode in the options object. The natural language code to set on the document if it is missing.

##### Parameters

value | The new value for DefaultLangCode.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public PDFUAOptions setFigureAltTextPrefix (String value)

Sets the value for FigureAltTextPrefix in the options object. The prefix to use when setting Alt for Image and Graphic tags. By default, and when this is empty, the tag name will be used.

##### Parameters

value | The new value for FigureAltTextPrefix.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public PDFUAOptions setFirstStop (boolean value)

Sets the value for FirstStop in the options object. Whether to stop processing after the first PDF/UA error is detected. By default, processing continues.

##### Parameters

value | Whether to stop processing after the first PDF/UA error is detected. By default, processing continues.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public PDFUAOptions setMaxRefObjs (int value)

Sets the value for MaxRefObjs in the options object. The maximum number of object references per error condition. This is 10 by default.

##### Parameters

value | The maximum number of object references per error condition. This is 10 by default.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public PDFUAOptions setPassword (String value)

Sets the value for Password in the options object. The password to be used for encrypted PDF documents. By default, no password is used.

##### Parameters

value | The password to be used for encrypted PDF documents. By default, no password is used.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |

#### public PDFUAOptions setSaveLinearized (boolean value)

Sets the value for SaveLinearized in the options object. Whether to linearize when saving converted output. By default, the output is not linearized.

##### Parameters

value | Whether to linearize when saving converted output. By default, the output is not linearized.

##### Returns

- This object, for call chaining.

##### Throws

PDFNetException |