SignatureOptions (Apache PDFBox 2.0.1 API)

java.lang.Object
- org.apache.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class SignatureOptions
extends Object
implements Closeable
```
TODO description needed

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_SIGNATURE_SIZE

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_SIGNATURE_SIZE`

Constructor Summary

Constructors
Constructor and Description

SignatureOptions()
Creates the default signature options.

Constructors
Constructor and Description
`SignatureOptions()` Creates the default signature options.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the visual signature COSDocument, if any.
`int`	`getPage()` Get the 0-based page number.
`int`	`getPreferredSignatureSize()` Get the preferred size of the signature.
`COSDocument`	`getVisualSignature()` Get the visual signature.
`void`	`setPage(int pageNo)` Set the 0-based page number.
`void`	`setPreferredSignatureSize(int size)` Set the preferred size of the signature.
`void`	`setVisualSignature(File file)` Reads the visual signature from the given file.
`void`	`setVisualSignature(InputStream is)` Reads the visual signature from the given input stream.
`void`	`setVisualSignature(PDVisibleSigProperties visSignatureProperties)` Reads the visual signature from the given visual signature properties

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

- Field Detail
  - DEFAULT_SIGNATURE_SIZE
```
public static final int DEFAULT_SIGNATURE_SIZE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SignatureOptions
```
public SignatureOptions()
```
    Creates the default signature options.
- Method Detail
  - setPage
```
public void setPage(int pageNo)
```
    Set the 0-based page number.
    
    Parameters:
    pageNo - the page number
  - getPage
```
public int getPage()
```
    Get the 0-based page number.
    
    Returns:
    the page number
  - setVisualSignature
```
public void setVisualSignature(File file)
                        throws IOException
```
    Reads the visual signature from the given file.
    
    Parameters:
    file - the file containing the visual signature
    
    Throws:
    
    IOException - when something went wrong during parsing
  - setVisualSignature
```
public void setVisualSignature(InputStream is)
                        throws IOException
```
    Reads the visual signature from the given input stream.
    
    Parameters:
    is - the input stream containing the visual signature
    
    Throws:
    
    IOException - when something went wrong during parsing
  - setVisualSignature
```
public void setVisualSignature(PDVisibleSigProperties visSignatureProperties)
                        throws IOException
```
    Reads the visual signature from the given visual signature properties
    
    Parameters:
    visSignatureProperties - the PDVisibleSigProperties object containing the visual signature
    
    Throws:
    
    IOException - when something went wrong during parsing
  - getVisualSignature
```
public COSDocument getVisualSignature()
```
    Get the visual signature.
    
    Returns:
    the visual signature
  - getPreferredSignatureSize
```
public int getPreferredSignatureSize()
```
    Get the preferred size of the signature.
    
    Returns:
    the preferred size of the signature in bytes.
  - setPreferredSignatureSize
```
public void setPreferredSignatureSize(int size)
```
    Set the preferred size of the signature.
    
    Parameters:
    size - the size of the signature in bytes. Only values above 0 will be considered.
  - close
```
public void close()
           throws IOException
```
    Closes the visual signature COSDocument, if any.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException - if the document could not be closed

Class SignatureOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SIGNATURE_SIZE

Constructor Detail

SignatureOptions

Method Detail

setPage

getPage

setVisualSignature

setVisualSignature

setVisualSignature

getVisualSignature

getPreferredSignatureSize

setPreferredSignatureSize

close