PDFTocMacroParameters (XWiki Platform - Export - PDF - API 14.8-rc-1 API)

java.lang.Object
- org.xwiki.export.pdf.macro.PDFTocMacroParameters

```
@Unstable
public class PDFTocMacroParameters
extends Object
```
The parameters supported by PDFTocMacro.

Since:

14.4.2, 14.5

Version:

$Id: 5a5de7659e8745ab160c10c40a65715a43f13745 $

Constructor Summary

Constructors
Constructor Description

PDFTocMacroParameters()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getDepth()`
`String`	`getJobId()`
`void`	`setDepth(int depth)`
`void`	`setJobId(String jobId)`	Specifies the PDF export job for which to generate the table of contents.

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

- Constructor Detail
  - PDFTocMacroParameters
```
public PDFTocMacroParameters()
```
- Method Detail
  - getJobId
```
public String getJobId()
```
    Returns:
    
    the id of the PDF export job for which to generate the table of contents
  - setJobId
```
public void setJobId(String jobId)
```
    Specifies the PDF export job for which to generate the table of contents.
    
    Parameters:
    
    jobId - the id of the PDF export job
  - getDepth
```
public int getDepth()
```
    Returns:
    
    the maximum section level; for example if 3 then all section levels from 4 will not be listed
  - setDepth
```
public void setDepth(int depth)
```
    Parameters:
    
    depth - the maximum section level; for example if 3 then all section levels from 4 will not be listed