Apache PDFBox

https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8
Admin
Apache PDFBox is an open-source Java library used for creating, manipulating, and extracting content...
Tokens:1,507,036
Snippets:22,796
Trust Score:9.5
Update:3 days ago
Show doc for...
Tokens:
Raw
### getStartColour()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/documentinterchange/taggedpdf/PDFourColours.html

Gets the colour for the start edge.

```APIDOC
## Method: getStartColour()

### Description
Gets the colour for the start edge.

### Signature
public PDGamma getStartColour()

### Parameters
None

### Returns
- **PDGamma** - The colour for the start edge.
```

--------------------------------

### getStartBookmark()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Gets the bookmark where text extraction should start, inclusive. Default is null.

```APIDOC
## getStartBookmark()

### Description
Gets the bookmark where text extraction should start, inclusive. Default is null.

### Method
getStartBookmark

### Parameters
None

### Returns
- **PDOutlineItem** - The starting bookmark.
```

--------------------------------

### PDActionLaunch(COSDictionary a)

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/action/PDActionLaunch.html

Constructor that initializes the action from an existing COSDictionary.

```APIDOC
## PDActionLaunch(COSDictionary a)

### Description
Constructor that initializes the action from an existing COSDictionary.

### Constructor
`public PDActionLaunch(COSDictionary a)`

### Parameters
- **a** (COSDictionary) - Required - The action dictionary.
```

--------------------------------

### PDActionLaunch()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/action/PDActionLaunch.html

Default constructor for creating a new PDActionLaunch instance.

```APIDOC
## PDActionLaunch()

### Description
Default constructor for creating a new PDActionLaunch instance.

### Constructor
`public PDActionLaunch()`

### Parameters
None.
```

--------------------------------

### getRegions() - PDFTextStripperByArea

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Get the list of regions that have been setup.

```APIDOC
## getRegions()

### Description
Get the list of regions that have been setup.

### Method
GET

### Endpoint
org.apache.pdfbox.text.PDFTextStripperByArea.getRegions()

### Parameters
None

### Response
#### Success Response
- **List<String>** - The list of region names.
```

--------------------------------

### PDFTextStripper.getStartBookmark()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/class-use/PDOutlineItem.html

Gets the bookmark where text extraction should start, inclusive.

```APIDOC
## PDFTextStripper.getStartBookmark()

### Description
Gets the bookmark where text extraction should start, inclusive.

### Method
`PDOutlineItem getStartBookmark()`

### Returns
- **PDOutlineItem** - The start bookmark, or null if not set.
```

--------------------------------

### PDWindowsLaunchParams(COSDictionary)

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Constructor for PDWindowsLaunchParams.

```APIDOC
## Constructor: PDWindowsLaunchParams(COSDictionary)

### Description
Constructor.

### Class
org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams

### Parameters
- **COSDictionary** - The dictionary.
```

--------------------------------

### getStartPointEndingStyle()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/fdf/FDFAnnotationPolyline.html

Gets the line ending style for the start point of the polyline.

```APIDOC
## getStartPointEndingStyle()

### Description
This will retrieve the line ending style for the start point, possible values shown in the LE_ constants section.

### Method
getStartPointEndingStyle

### Signature
`public String getStartPointEndingStyle()`

### Parameters
None

### Returns
- **String** - The line ending style for the start point.
```

--------------------------------

### PDActionLaunch.getFile()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/common/filespecification/class-use/PDFileSpecification.html

Returns the file specification for the application to launch or document to open or print.

```APIDOC
## Method: getFile()

### Description
This will get the application to be launched or the document to be opened or printed.

### Return Type
PDFileSpecification

### Belongs to
PDActionLaunch
```

--------------------------------

### getWinLaunchParams() - PDActionLaunch

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Gets a dictionary containing Windows-specific launch parameters.

```APIDOC
## getWinLaunchParams()

### Description
This will get a dictionary containing Windows-specific launch parameters.

### Method
getWinLaunchParams()

### Class
org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch

### Return Type
Not specified in source.
```

--------------------------------

### getPageStart()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Returns the string used at the beginning of a page.

```APIDOC
## Method: getPageStart()

### Description
Returns the string which will be used at the beginning of a page.

### Signature
`public String getPageStart()`

### Parameters
None.

### Returns
String - The page start string.
```

--------------------------------

### getRegions()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripperByArea.html

Get the list of regions that have been setup. Returns a list of region names.

```APIDOC
## Method: getRegions()

### Description
Get the list of regions that have been setup. Returns a list of region names.

### Signature
public List<String> getRegions()

### Returns
- **List<String>** - The list of region names.
```

--------------------------------

### getStartIndent

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/documentinterchange/taggedpdf/PDLayoutAttributeObject.html

Gets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent). The default value is 0.

```APIDOC
## getStartIndent

### Description
Gets the distance from the start edge of the reference area to that of the BLSE in the inline-progression direction (StartIndent). The default value is 0.

### Method
getStartIndent

### Returns
- **float** - the start indent
```

--------------------------------

### init()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/graphics/color/PDDeviceCMYK.html

Lazy loads the ICC profile because it is slow.

```APIDOC
## Method: init()

### Description
Lazy load the ICC profile, because it's slow.

### Signature
protected void init() throws IOException

### Throws
- IOException - if the ICC profile could not be initialized
```

--------------------------------

### getTextMatrix() - TextPosition

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Gets the matrix containing the starting text position and scaling. This method is part of the PDFBox text positioning API.

```APIDOC
## getTextMatrix()

### Description
Gets the matrix containing the starting text position and scaling.

### Method
GET

### Class
org.apache.pdfbox.text.TextPosition

### Returns
- **textMatrix** (Matrix) - The text matrix.
```

--------------------------------

### PDWindowsLaunchParams()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Default constructor for PDWindowsLaunchParams.

```APIDOC
## Constructor: PDWindowsLaunchParams()

### Description
Default constructor.

### Class
org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams
```

--------------------------------

### getO

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/action/PDActionLaunch.html

Gets the string specifying the operation to perform: open to open a document, print to print a document. Returns the O entry of the specific Windows launch parameter dictionary.

```APIDOC
## getO()

### Description
Gets the string specifying the operation to perform: open to open a document, print to print a document. If the F entry designates an application instead of a document, this entry is ignored and the application is launched. Default value: open.

### Method
public String getO()

### Returns
- String - The O entry of the specific Windows launch parameter dictionary.
```

--------------------------------

### getTextIndent

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/documentinterchange/taggedpdf/PDLayoutAttributeObject.html

Gets the additional distance in the inline-progression direction from the start edge of the BLSE, as specified by StartIndent, to that of the first line of text (TextIndent). The default value is 0.

```APIDOC
## getTextIndent

### Description
Gets the additional distance in the inline-progression direction from the start edge of the BLSE, as specified by StartIndent, to that of the first line of text (TextIndent). The default value is 0.

### Method
public float getTextIndent()

### Returns
- the text indent
```

--------------------------------

### getPageStart

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Returns the string which will be used at the beginning of a page.

```APIDOC
## getPageStart

### Description
Returns the string which will be used at the beginning of a page.

### Method
GET

### Endpoint
public String getPageStart()

### Returns
- **String** - The page start string

```

--------------------------------

### getInnerForm

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.html

Gets the inner form that is in this location: AcroForm/DR/XObject/{holder form name}/Resources/XObject/{inner name}. By default inner form name starts with 'n' and then a number is added.

```APIDOC
## getInnerForm

### Description
Gets the inner form that is in this location: AcroForm/DR/XObject/{holder form name}/Resources/XObject/{inner name}. By default inner form name starts with 'n' and then a number is added.

### Method
GET

### Endpoint
N/A (Java method)

### Parameters
None

### Returns
- **innerForm** (PDFormXObject) - The inner form.
```

--------------------------------

### setDirectory(String) - PDWindowsLaunchParams

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Sets the directory to launch from.

```APIDOC
## setDirectory(String)

### Description
Set the dir to launch from.

### Method
setDirectory

### Class
org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams

### Parameters
- **String** - The directory.
```

--------------------------------

### getTextIndent() - PDLayoutAttributeObject

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Gets the additional distance in the inline-progression direction from the start edge of the BLSE, as specified by StartIndent, to that of the first line of text (TextIndent). This method is part of the PDFBox tagged PDF API.

```APIDOC
## getTextIndent()

### Description
Gets the additional distance in the inline-progression direction from the start edge of the BLSE, as specified by StartIndent, to that of the first line of text (TextIndent).

### Method
GET

### Class
org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDLayoutAttributeObject

### Returns
- **textIndent** (float) - The text indent.
```

--------------------------------

### getIndentThreshold

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Returns the multiple of whitespace character widths for the current text which the current line start can be indented from the previous line start beyond which the current line start is considered to be a paragraph start.

```APIDOC
## getIndentThreshold

### Description
Returns the multiple of whitespace character widths for the current text which the current line start can be indented from the previous line start beyond which the current line start is considered to be a paragraph start.

### Method
GET

### Endpoint
public float getIndentThreshold()

### Returns
- **float** - The number of whitespace character widths to use when detecting paragraph indents.

```

--------------------------------

### startPage(PDPage page)

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Starts a new page. Default implementation does nothing; subclasses may override.

```APIDOC
## startPage(PDPage page)

### Description
Starts a new page. Default implementation does nothing; subclasses may override.

### Method
protected void startPage(PDPage page) throws IOException

### Parameters
- **page** (PDPage) - Required - The page we are about to process.

### Throws
- **IOException** - If there is any error writing to the stream.
```

--------------------------------

### PDActionGoTo()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/action/PDActionGoTo.html

Default constructor for creating a new PDActionGoTo instance.

```APIDOC
## PDActionGoTo()

### Description
Default constructor for creating a new PDActionGoTo instance.

### Method
Constructor

### Signature
public PDActionGoTo()

### Parameters
None

### Returns
A new PDActionGoTo object.
```

--------------------------------

### getIndentThreshold()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Returns the multiple of whitespace character widths for the current text which the current line start can be indented from the previous line start beyond which the current line start is considered a paragraph start.

```APIDOC
## Method: getIndentThreshold()

### Description
Returns the multiple of whitespace character widths for the current text which the current line start can be indented from the previous line start beyond which the current line start is considered to be a paragraph start.

### Signature
`public float getIndentThreshold()`

### Parameters
None.

### Returns
float - The indent threshold value.
```

--------------------------------

### Constructor

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/graphics/state/PDGraphicsState.html

Constructor with a given page size to initialize the clipping path.

```APIDOC
## Constructor

### Description
Constructor with a given page size to initialize the clipping path.

### Parameters
- `page` (PDPage) - Required - the size of the page

```

--------------------------------

### getIndentThreshold() - PDFTextStripper

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Returns the multiple of whitespace character widths for the current text which the current line start can be indented from the previous line start beyond which the current line start is considered to be a paragraph start.

```APIDOC
## getIndentThreshold()

### Description
Returns the multiple of whitespace character widths for the current text which the current line start can be indented from the previous line start beyond which the current line start is considered to be a paragraph start.

### Method
GET

### Endpoint
org.apache.pdfbox.text.PDFTextStripper#getIndentThreshold()

### Parameters
None

### Response
#### Success Response
- Returns the indent threshold value.

```

--------------------------------

### setIndentThreshold(float indentThresholdValue)

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Sets the multiple of whitespace character widths for the current text which the current line start can be indented from the previous line start beyond which the current line start is considered to be a paragraph start.

```APIDOC
## setIndentThreshold(float indentThresholdValue)

### Description
Sets the multiple of whitespace character widths for the current text which the current line start can be indented from the previous line start beyond which the current line start is considered to be a paragraph start.

### Method
POST

### Parameters
- **indentThresholdValue** (float) - Required - The indent threshold value.

### Returns
- **void** - No return value.

```

--------------------------------

### setWinLaunchParams(PDWindowsLaunchParams) - PDActionLaunch

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Sets a dictionary containing Windows-specific launch parameters for a launch action.

```APIDOC
## setWinLaunchParams(PDWindowsLaunchParams)

### Description
Sets a dictionary containing Windows-specific launch parameters.

### Method
setWinLaunchParams(PDWindowsLaunchParams)

### Parameters
- **winLaunchParams** (PDWindowsLaunchParams) - The Windows-specific launch parameters.

### Returns
void
```

--------------------------------

### setIndentThreshold

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Sets the multiple of whitespace character widths for the current text which the current line start can be indented from the previous line start beyond which the current line start is considered to be a paragraph start. The default value is 2.0.

```APIDOC
## setIndentThreshold

### Description
Sets the multiple of whitespace character widths for the current text which the current line start can be indented from the previous line start beyond which the current line start is considered to be a paragraph start. The default value is 2.0.

### Method
SET

### Endpoint
public void setIndentThreshold(float indentThresholdValue)

### Parameters
- **indentThresholdValue** (float) - Required - The number of whitespace character widths to use when detecting paragraph indents.

```

--------------------------------

### getStart()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/common/PDPageLabelRange.html

Returns the start value for page numbering in this page range.

```APIDOC
## getStart()

### Description
Returns the start value for page numbering in this page range.

### Method
`public int getStart()`

### Parameters
None

### Returns
- **int** - A positive integer the start value for numbering.
```

--------------------------------

### InstructionSequence()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/common/function/type4/InstructionSequence.html

Constructs a new InstructionSequence instance.

```APIDOC
## InstructionSequence()

### Description
Constructs a new InstructionSequence instance.

### Constructor
`public InstructionSequence()`

### Parameters
None.
```

--------------------------------

### get Methods

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/PDResources.html

Methods to retrieve resources by name and to get the names of all resources of a given type.

```APIDOC
## PDColorSpace getColorSpace(COSName name)

### Description
Returns the color space resource with the given name, or null if none exists.

### Method
getColorSpace

### Signature
public PDColorSpace getColorSpace(COSName name)

### Parameters
- **name** (COSName) - Required - The name of the resource.

### Returns
- **PDColorSpace** - The color space resource, or null.

## PDColorSpace getColorSpace(COSName name, boolean wasDefault)

### Description
Returns the color space resource with the given name, or null if none exists.

### Method
getColorSpace

### Signature
public PDColorSpace getColorSpace(COSName name, boolean wasDefault)

### Parameters
- **name** (COSName) - Required - The name of the resource.
- **wasDefault** (boolean) - Required - Indicates if the resource was default.

### Returns
- **PDColorSpace** - The color space resource, or null.

## Iterable<COSName> getColorSpaceNames()

### Description
Returns the names of the color space resources, if any.

### Method
getColorSpaceNames

### Signature
public Iterable<COSName> getColorSpaceNames()

### Returns
- **Iterable<COSName>** - The names of the color space resources.

## COSDictionary getCOSObject()

### Description
Returns the underlying dictionary.

### Method
getCOSObject

### Signature
public COSDictionary getCOSObject()

### Returns
- **COSDictionary** - The underlying dictionary.

## PDExtendedGraphicsState getExtGState(COSName name)

### Description
Returns the extended graphics state resource with the given name, or null if none exists.

### Method
getExtGState

### Signature
public PDExtendedGraphicsState getExtGState(COSName name)

### Parameters
- **name** (COSName) - Required - The name of the resource.

### Returns
- **PDExtendedGraphicsState** - The extended graphics state resource, or null.

## Iterable<COSName> getExtGStateNames()

### Description
Returns the names of the extended graphics state resources, if any.

### Method
getExtGStateNames

### Signature
public Iterable<COSName> getExtGStateNames()

### Returns
- **Iterable<COSName>** - The names of the extended graphics state resources.

## PDFont getFont(COSName name)

### Description
Returns the font resource with the given name, or null if none exists.

### Method
getFont

### Signature
public PDFont getFont(COSName name)

### Parameters
- **name** (COSName) - Required - The name of the resource.

### Returns
- **PDFont** - The font resource, or null.

## Iterable<COSName> getFontNames()

### Description
Returns the names of the font resources, if any.

### Method
getFontNames

### Signature
public Iterable<COSName> getFontNames()

### Returns
- **Iterable<COSName>** - The names of the font resources.

## PDAbstractPattern getPattern(COSName name)

### Description
Returns the pattern resource with the given name, or null if none exists.

### Method
getPattern

### Signature
public PDAbstractPattern getPattern(COSName name)

### Parameters
- **name** (COSName) - Required - The name of the resource.

### Returns
- **PDAbstractPattern** - The pattern resource, or null.

## Iterable<COSName> getPatternNames()

### Description
Returns the names of the pattern resources, if any.

### Method
getPatternNames

### Signature
public Iterable<COSName> getPatternNames()

### Returns
- **Iterable<COSName>** - The names of the pattern resources.

## PDPropertyList getProperties(COSName name)

### Description
Returns the property list resource with the given name, or null if none exists.

### Method
getProperties

### Signature
public PDPropertyList getProperties(COSName name)

### Parameters
- **name** (COSName) - Required - The name of the resource.

### Returns
- **PDPropertyList** - The property list resource, or null.

## Iterable<COSName> getPropertiesNames()

### Description
Returns the names of the property list resources, if any.

### Method
getPropertiesNames

### Signature
public Iterable<COSName> getPropertiesNames()

### Returns
- **Iterable<COSName>** - The names of the property list resources.

## ResourceCache getResourceCache()

### Description
Returns the resource cache associated with the Resources, or null if there is none.

### Method
getResourceCache

### Signature
public ResourceCache getResourceCache()

### Returns
- **ResourceCache** - The resource cache, or null.

## PDShading getShading(COSName name)

### Description
Returns the shading resource with the given name, or null if none exists.

### Method
getShading

### Signature
public PDShading getShading(COSName name)

### Parameters
- **name** (COSName) - Required - The name of the resource.

### Returns
- **PDShading** - The shading resource, or null.

## Iterable<COSName> getShadingNames()

### Description
Returns the names of the shading resources, if any.

### Method
getShadingNames

### Signature
public Iterable<COSName> getShadingNames()

### Returns
- **Iterable<COSName>** - The names of the shading resources.

## PDXObject getXObject(COSName name)

### Description
Returns the XObject resource with the given name, or null if none exists.

### Method
getXObject

### Signature
public PDXObject getXObject(COSName name)

### Parameters
- **name** (COSName) - Required - The name of the resource.

### Returns
- **PDXObject** - The XObject resource, or null.

## Iterable<COSName> getXObjectNames()

### Description
Returns the names of the XObject resources, if any.

### Method
getXObjectNames

### Signature
public Iterable<COSName> getXObjectNames()

### Returns
- **Iterable<COSName>** - The names of the XObject resources.
```

--------------------------------

### setStart

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/common/PDPageLabelRange.html

Sets the start value for page numbering in this page range. Throws IllegalArgumentException if the start value is not a positive integer.

```APIDOC
## setStart

### Description
Sets the start value for page numbering in this page range.

### Method
setStart

### Parameters
- **start** (int) - Required - A positive integer representing the start value.

### Throws
- **IllegalArgumentException** - if start is not a positive integer

```

--------------------------------

### getOS() - PDPropBuildDataDict

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Indicates the operating system.

```APIDOC
## getOS() - Method in class org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict

### Description
Indicates the operating system.

### Method
getOS()

### Class
org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDPropBuildDataDict

### Returns
The operating system.
```

--------------------------------

### getDropThreshold

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Returns the minimum whitespace, as a multiple of the max height of the current characters beyond which the current line start is considered to be a paragraph start.

```APIDOC
## getDropThreshold

### Description
Returns the minimum whitespace, as a multiple of the max height of the current characters beyond which the current line start is considered to be a paragraph start.

### Method
GET

### Endpoint
public float getDropThreshold()

### Returns
- **float** - The character height multiple for max allowed whitespace between lines in the same paragraph.

```

--------------------------------

### getDropThreshold()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Returns the minimum whitespace, as a multiple of the max height of current characters, beyond which the current line start is considered a paragraph start.

```APIDOC
## Method: getDropThreshold()

### Description
The minimum whitespace, as a multiple of the max height of the current characters beyond which the current line start is considered to be a paragraph start.

### Signature
`public float getDropThreshold()`

### Parameters
None.

### Returns
float - The drop threshold value.
```

--------------------------------

### getPageStart() - PDFTextStripper

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Returns the string used at the beginning of a page.

```APIDOC
## getPageStart()

### Description
Returns the string which will be used at the beginning of a page.

### Method
GET

### Endpoint
org.apache.pdfbox.text.PDFTextStripper#getPageStart()

### Parameters
None

### Response
#### Success Response
- **String** - The page start string.
```

--------------------------------

### setFilename(String) - PDWindowsLaunchParams

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Sets the file to launch.

```APIDOC
## setFilename(String)

### Description
Sets the file to launch.

### Method
setFilename

### Parameters
- **filename** (String) - The file name to set.

### Returns
void
```

--------------------------------

### newLineAtOffset(float tx, float ty)

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/PDAppearanceContentStream.html

The Td operator. Moves to the start of the next line, offset from the start of the current line by (tx, ty).

```APIDOC
## newLineAtOffset(float tx, float ty)

### Description
The Td operator. Moves to the start of the next line, offset from the start of the current line by (tx, ty).

### Method
newLineAtOffset(float tx, float ty)

### Parameters
- **tx** (float) - Required - The x-offset.
- **ty** (float) - Required - The y-offset.

### Return Type
void
```

--------------------------------

### setDropThreshold(float dropThresholdValue)

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Sets the minimum whitespace, as a multiple of the max height of the current characters, beyond which the current line start is considered to be a paragraph start.

```APIDOC
## setDropThreshold(float dropThresholdValue)

### Description
Sets the minimum whitespace, as a multiple of the max height of the current characters, beyond which the current line start is considered to be a paragraph start.

### Method
POST

### Parameters
- **dropThresholdValue** (float) - Required - The drop threshold value.

### Returns
- **void** - No return value.

```

--------------------------------

### getArticleStart

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Returns the string which will be used at the beginning of an article.

```APIDOC
## getArticleStart

### Description
Returns the string which will be used at the beginning of an article.

### Method
GET

### Endpoint
public String getArticleStart()

### Returns
- **String** - The article start string

```

--------------------------------

### getYStep()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/graphics/pattern/PDTilingPattern.html

Returns the YStep value.

```APIDOC
## Method: getYStep()

### Description
Returns the YStep value.

### Returns
- **float** - The YStep value.

```

--------------------------------

### setDropThreshold

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Sets the minimum whitespace, as a multiple of the max height of the current characters beyond which the current line start is considered to be a paragraph start. The default value is 2.5.

```APIDOC
## setDropThreshold

### Description
Sets the minimum whitespace, as a multiple of the max height of the current characters beyond which the current line start is considered to be a paragraph start. The default value is 2.5.

### Method
SET

### Endpoint
public void setDropThreshold(float dropThresholdValue)

### Parameters
- **dropThresholdValue** (float) - Required - The character height multiple for max allowed whitespace between lines in the same paragraph.

```

--------------------------------

### PDMarkInfo()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDMarkInfo.html

Default constructor for creating a new PDMarkInfo instance.

```APIDOC
## PDMarkInfo()

### Description
Default Constructor.

### Constructor
`public PDMarkInfo()`

### Parameters
None.

### Returns
A new PDMarkInfo instance.
```

--------------------------------

### PDRange Methods

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/common/PDRange.html

Instance methods for PDRange to get and set the minimum and maximum values, retrieve the underlying COSArray, convert to a COS object, and get a string representation.

```APIDOC
## getCOSObject()

### Description
Convert this standard java object to a COS object.

### Method
public COSBase getCOSObject()

### Returns
- **COSBase** - The cos object that matches this Java object.

## getCOSArray()

### Description
This will get the underlying array value.

### Method
public COSArray getCOSArray()

### Returns
- **COSArray** - The cos object that this object wraps.

## getMin()

### Description
This will get the minimum value of the range.

### Method
public float getMin()

### Returns
- **float** - The min value.

## setMin(float min)

### Description
This will set the minimum value for the range.

### Method
public void setMin(float min)

### Parameters
- **min** (float) - Required - The new minimum for the range.

## getMax()

### Description
This will get the maximum value of the range.

### Method
public float getMax()

### Returns
- **float** - The max value.

## setMax(float max)

### Description
This will set the maximum value for the range.

### Method
public void setMax(float max)

### Parameters
- **max** (float) - Required - The new maximum for the range.

## toString()

### Description
Returns a string representation of the object.

### Method
public String toString()

### Returns
- **String** - A string representation of the object.
```

--------------------------------

### get(String number)

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/cos/COSNumber.html

Static factory method to get the appropriate number object (either float or int) from a string representation. Throws IOException if the string is not a number.

```APIDOC
## get(String number)

### Description
This factory method will get the appropriate number object.

### Method Signature
public static COSNumber get(String number) throws IOException

### Parameters
- **number** (String) - Required - The string representation of the number.

### Returns
- **COSNumber** - A number object, either float or int.

### Throws
- **IOException** - If the string is not a number.
```

--------------------------------

### getP

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/action/PDActionLaunch.html

Gets a parameter string to be passed to the application designated by the F entry. Returns the P entry of the specific Windows launch parameter dictionary.

```APIDOC
## getP()

### Description
Gets a parameter string to be passed to the application designated by the F entry. This entry should be omitted if F designates a document.

### Method
public String getP()

### Returns
- String - The P entry of the specific Windows launch parameter dictionary.
```

--------------------------------

### getAffineTransform()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.html

Gets the AffineTransform.

```APIDOC
## getAffineTransform()

### Description
Gets the AffineTransform.

### Method
GET

### Endpoint
PDFTemplateStructure.getAffineTransform()

### Returns
- **AffineTransform** - the AffineTransform
```

--------------------------------

### PDActionRemoteGoTo(COSDictionary a)

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/action/PDActionRemoteGoTo.html

Constructor that initializes a PDActionRemoteGoTo from an existing action dictionary.

```APIDOC
## PDActionRemoteGoTo(COSDictionary a)

### Description
Constructor that initializes a PDActionRemoteGoTo from an existing action dictionary.

### Method
Constructor

### Signature
public PDActionRemoteGoTo(COSDictionary a)

### Parameters
- **a** (COSDictionary) - Required - The action dictionary.

### Returns
A new PDActionRemoteGoTo object.
```

--------------------------------

### getFileDescription()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/common/filespecification/PDComplexFileSpecification.html

Gets the description.

```APIDOC
## getFileDescription()

### Description
Gets the description.

### Method
public String getFileDescription()

### Returns
The file description.
```

--------------------------------

### writePageStart() - Method in class org.apache.pdfbox.text.PDFTextStripper

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Writes something (if defined) at the start of a page.

```APIDOC
## writePageStart()

### Description
Write something (if defined) at the start of a page.

### Method
writePageStart()

### Class
org.apache.pdfbox.text.PDFTextStripper

### Usage
Call this method to write custom content at the start of a page.
```

--------------------------------

### PDFTemplateStructure.getSignatureRectangle()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/common/class-use/PDRectangle.html

Gets SignatureRectangle.

```APIDOC
## PDFTemplateStructure.getSignatureRectangle()

### Description
Gets SignatureRectangle.

### Method
getSignatureRectangle()

### Return Type
PDRectangle

### Package
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible
```

--------------------------------

### getFile

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/action/PDActionLaunch.html

Retrieves the file specification for the launch action. Returns the F entry of the specific launch action dictionary.

```APIDOC
## getFile()

### Description
Retrieves the file specification for the launch action. Returns the F entry of the specific launch action dictionary.

### Method
public PDFileSpecification getFile()

### Returns
- PDFileSpecification - The file specification.

### Throws
- IOException - If there is an error creating the file spec.
```

--------------------------------

### XrefTrailerResolver.nextXrefObj(long startBytePos, XrefTrailerResolver.XRefType type)

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdfparser/class-use/XrefTrailerResolver.XRefType.html

Signals that a new XRef object (table or stream) starts. This method is used to notify the resolver of the start position and type of a new cross-reference object.

```APIDOC
## XrefTrailerResolver.nextXrefObj(long startBytePos, XrefTrailerResolver.XRefType type)

### Description
Signals that a new XRef object (table or stream) starts.

### Method
`void nextXrefObj(long startBytePos, XrefTrailerResolver.XRefType type)`

### Parameters
- **startBytePos** (long) - Required - The start byte position of the new XRef object.
- **type** (XrefTrailerResolver.XRefType) - Required - The type of the new XRef object (table or stream).

### Return Type
`void`
```

--------------------------------

### PDTargetDirectory()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/action/PDTargetDirectory.html

Default constructor that creates a target directory.

```APIDOC
## Constructor: PDTargetDirectory()

### Description
Default constructor, creates target directory.

### Signature
public PDTargetDirectory()

### Parameters
None.

### Returns
A new PDTargetDirectory instance.
```

--------------------------------

### getLineSeparator()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Gets the line separator.

```APIDOC
## Method: getLineSeparator()

### Description
This will get the line separator.

### Signature
`public String getLineSeparator()`

### Parameters
None.

### Returns
String - The line separator string.
```

--------------------------------

### getOperation() - PDWindowsLaunchParams

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Gets the operation to perform on the file.

```APIDOC
## getOperation() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams

### Description
Get the operation to perform on the file.

### Method
getOperation()

### Class
org.apache.pdfbox.pdmodel.interactive.action.PDWindowsLaunchParams

### Returns
The operation to perform.
```

--------------------------------

### getRenderingHints()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/printing/PDFPageable.html

Get the rendering hints.

```APIDOC
## Method: RenderingHints getRenderingHints()

### Description
Get the rendering hints.

### Signature
public RenderingHints getRenderingHints()

### Returns
- **RenderingHints** - The rendering hints.
```

--------------------------------

### getO() - PDActionLaunch

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Retrieves the operation to perform when launching an action, such as 'open' or 'print'.

```APIDOC
## getO() - Method in class org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch

### Description
This will get the string specifying the operation to perform: open to open a document, print to print a document. If the F entry designates an application instead of a document, this entry is ignored and the application is launched.

### Method
GET

### Endpoint
org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch#getO()

### Parameters
None

### Response
#### Success Response (200)
- **operation** (String) - The operation to perform (e.g., "open" or "print").

#### Response Example
{
  "operation": "open"
}
```

--------------------------------

### setDirectory(String dir)

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/action/PDWindowsLaunchParams.html

Sets the directory to launch from.

```APIDOC
## setDirectory(String dir)

### Description
Sets the directory to launch from.

### Method
Instance Method

### Signature
public void setDirectory(String dir)

### Parameters
- **dir** (String) - Required - The directory of the executable/document to launch.

### Returns
void
```

--------------------------------

### hideMenubar

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/viewerpreferences/PDViewerPreferences.html

Gets the menubar preference.

```APIDOC
## hideMenubar

### Description
Gets the menubar preference.

### Method
public boolean hideMenubar()

### Returns
boolean - the menubar preference.
```

--------------------------------

### hideToolbar

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/viewerpreferences/PDViewerPreferences.html

Gets the toolbar preference.

```APIDOC
## hideToolbar

### Description
Gets the toolbar preference.

### Method
public boolean hideToolbar()

### Returns
boolean - the toolbar preference.
```

--------------------------------

### getArticleStart() - PDFTextStripper

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Returns the string used at the beginning of an article.

```APIDOC
## getArticleStart()

### Description
Returns the string which will be used at the beginning of an article.

### Method
GET

### Endpoint
org.apache.pdfbox.text.PDFTextStripper#getArticleStart()

### Returns
- **String** - The article start string.
```

--------------------------------

### hideToolbar()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/viewerpreferences/PDViewerPreferences.html

Gets the toolbar preference.

```APIDOC
## hideToolbar()

### Description
Get the toolbar preference.

### Method
`public boolean hideToolbar()`

### Returns
- **boolean** - The toolbar preference.
```

--------------------------------

### getF() - PDActionLaunch

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/index-all.html

Gets the file name to be launched or the document to be opened or printed, in standard Windows pathname format.

```APIDOC
## getF()

### Description
This will get the file name to be launched or the document to be opened or printed, in standard Windows pathname format.

### Method
GET

### Class
org.apache.pdfbox.pdmodel.interactive.action.PDActionLaunch

### Return Type
String

### Parameters
None

### Response
#### Success Response
- **file** (String) - The file name or document path.

#### Response Example
{
  "file": "C:\\example.pdf"
}
```

--------------------------------

### hideMenubar()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/viewerpreferences/PDViewerPreferences.html

Gets the menubar preference.

```APIDOC
## hideMenubar()

### Description
Get the menubar preference.

### Method
`public boolean hideMenubar()`

### Returns
- **boolean** - The menubar preference.
```

--------------------------------

### PDActionMovie()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/action/PDActionMovie.html

Default constructor for creating a new PDActionMovie instance.

```APIDOC
## PDActionMovie()

### Description
Default constructor for creating a new PDActionMovie instance.

### Method
Constructor

### Signature
public PDActionMovie()

### Parameters
None

### Returns
A new PDActionMovie instance.
```

--------------------------------

### getStartXref()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/cos/COSDocument.html

Returns the startXref position of the parsed document.

```APIDOC
## getStartXref()

### Description
Returns the startXref position of the parsed document.

### Method
getStartXref

### Signature
public long getStartXref()

### Parameters
None

### Returns
- **long** - The startXref position.
```

--------------------------------

### getDuplex()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/viewerpreferences/PDViewerPreferences.html

Gets the Duplex preference.

```APIDOC
## getDuplex()

### Description
Get the Duplex preference.

### Method
`public String getDuplex()`

### Returns
- **String** - The Duplex preference.
```

--------------------------------

### getAction()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/documentnavigation/outline/PDOutlineItem.html

Gets the action of this node.

```APIDOC
## getAction()

### Description
Get the action of this node.

### Method
getAction

### Signature
public PDAction getAction()

### Parameters
None

### Returns
- **PDAction** - The action of this node.
```

--------------------------------

### setPageStart

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/text/PDFTextStripper.html

Sets the string which will be used at the beginning of a page.

```APIDOC
## setPageStart

### Description
Sets the string which will be used at the beginning of a page.

### Method
SET

### Endpoint
public void setPageStart(String pageStartValue)

### Parameters
- **pageStartValue** (String) - Required - The page start string

```

--------------------------------

### getWidgetDictionary

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.html

Gets the widget dictionary.

```APIDOC
## getWidgetDictionary

### Description
Gets the widget dictionary.

### Method
GET

### Endpoint
N/A (Java method)

### Parameters
None

### Returns
- **widgetDictionary** (COSDictionary) - The widget dictionary.
```

--------------------------------

### getAcroFormFields

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.html

Gets the AcroForm fields.

```APIDOC
## getAcroFormFields

### Description
Gets the AcroForm fields.

### Method
GET

### Endpoint
N/A (Java method)

### Parameters
None

### Returns
- **acroFormFields** (List<PDField>) - The AcroForm fields.
```

--------------------------------

### getApp()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/digitalsignature/PDPropBuild.html

Returns the build data dictionary for the viewing application software module that was used to create the parent signature.

```APIDOC
## getApp()

### Description
Returns the build data dictionary for the viewing application software module that was used to create the parent signature.

### Method
Instance Method

### Signature
public PDPropBuildDataDict getApp()

### Parameters
None

### Returns
- **PDPropBuildDataDict** - The App as PDPropBuildApp object.
```

--------------------------------

### getAppearanceDictionary()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.html

Gets the appearance dictionary.

```APIDOC
## getAppearanceDictionary()

### Description
Gets the appearance dictionary.

### Method
GET

### Endpoint
PDFTemplateStructure.getAppearanceDictionary()

### Returns
- **PDAppearanceDictionary** - the appearance dictionary
```

--------------------------------

### ShadingContext(PDShading shading, ColorModel cm, AffineTransform xform, Matrix matrix)

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/graphics/shading/ShadingContext.html

Constructor for ShadingContext. Initializes the shading context with the given shading type, color model, transformation, and matrix. Throws IOException if there is an error getting the color space or doing background color conversion.

```APIDOC
## Constructor: ShadingContext

### Description
Creates a ShadingContext instance with the specified shading, color model, transformation, and matrix.

### Signature
public ShadingContext(PDShading shading, ColorModel cm, AffineTransform xform, Matrix matrix) throws IOException

### Parameters
- **shading** (PDShading) - Required - The shading type to be used.
- **cm** (ColorModel) - Required - The color model to be used.
- **xform** (AffineTransform) - Required - Transformation for user to device space.
- **matrix** (Matrix) - Required - The pattern matrix concatenated with that of the parent content stream.

### Throws
- **IOException** - If there is an error getting the color space or doing background color conversion.

### Example
```java
// Example usage (not provided in source)
```
```

--------------------------------

### PDPageFitDestination()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/documentnavigation/destination/PDPageFitDestination.html

Default constructor for creating a new PDPageFitDestination instance.

```APIDOC
## PDPageFitDestination()

### Description
Default constructor for creating a new PDPageFitDestination instance.

### Method
Constructor

### Signature
public PDPageFitDestination()

### Parameters
None

### Returns
A new PDPageFitDestination object.
```

--------------------------------

### getProcSet()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.html

Gets the ProcSet array.

```APIDOC
## getProcSet()

### Description
Gets the ProcSet array.

### Method
GET

### Endpoint
PDFTemplateStructure.getProcSet()

### Returns
- **COSArray** - the ProcSet array
```

--------------------------------

### PDActionGoTo(COSDictionary a)

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/action/PDActionGoTo.html

Constructor that creates a PDActionGoTo from an existing COSDictionary.

```APIDOC
## PDActionGoTo(COSDictionary a)

### Description
Constructor that creates a PDActionGoTo from an existing COSDictionary.

### Method
Constructor

### Signature
public PDActionGoTo(COSDictionary a)

### Parameters
- **a** (COSDictionary) - Required - The action dictionary.

### Returns
A new PDActionGoTo object.
```

--------------------------------

### getSignatureRectangle()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.html

Gets the rectangle for the signature.

```APIDOC
## getSignatureRectangle()

### Description
Gets the rectangle for the signature.

### Method
GET

### Endpoint
PDFTemplateStructure.getSignatureRectangle()

### Returns
- **PDRectangle** - the rectangle for the signature
```

--------------------------------

### getPdSignature()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateStructure.html

Gets the PDSignature object.

```APIDOC
## getPdSignature()

### Description
Gets the PDSignature object.

### Method
GET

### Endpoint
PDFTemplateStructure.getPdSignature()

### Returns
- **PDSignature** - the signature
```

--------------------------------

### getDirectory()

Source: https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.8/org/apache/pdfbox/pdmodel/interactive/action/PDWindowsLaunchParams.html

Returns the directory to launch from.

```APIDOC
## getDirectory()

### Description
Returns the directory to launch from.

### Method
Instance Method

### Signature
public String getDirectory()

### Parameters
None

### Returns
- **String** - The directory of the executable/document to launch.
```
Tokens:
Raw