Modifier and Type | Class and Description |
---|---|
static class |
TocMacroParameters.Scope |
Constructor and Description |
---|
TocMacroParameters() |
Modifier and Type | Method and Description |
---|---|
int |
getDepth() |
String |
getReference() |
TocMacroParameters.Scope |
getScope() |
int |
getStart() |
boolean |
isCustomStart() |
boolean |
isNumbered() |
void |
setDepth(int depth) |
void |
setNumbered(boolean numbered) |
void |
setReference(String reference) |
void |
setScope(TocMacroParameters.Scope scope) |
void |
setStart(int start) |
public void setStart(int start)
start
- the minimum section level. For example if 2 then level 1 sections will not be listed.public int getStart()
public boolean isCustomStart()
public void setDepth(int depth)
depth
- the maximum section level. For example if 3 then all section levels from 4 will not be listed.public int getDepth()
public void setScope(TocMacroParameters.Scope scope)
scope
- If local only section in the current scope will be listed. For example if the macro is written in a
section, only subsections of this section will be listed.public TocMacroParameters.Scope getScope()
TocMacroParameters.Scope.LOCAL
only section in the current scope will be listed. For example if the macro is
written in a section, only subsections of this section will be listed.public void setNumbered(boolean numbered)
numbered
- if true the section title number is printed.public boolean isNumbered()
public void setReference(String reference)
reference
- the reference to the document for which to generate the table of content. If not defined, then
the current document is usedpublic String getReference()
Copyright © 2004–2021 XWiki. All rights reserved.