Class TocOptions

java.lang.Object

com.vladsch.flexmark.ext.toc.internal.TocOptions

All Implemented Interfaces:

MutableDataSetter, Immutable<TocOptions, TocOptions.AsMutable>

public class TocOptions
extends Object
implements Immutable<TocOptions, TocOptions.AsMutable>, MutableDataSetter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TocOptions.AsMutable
static enum	TocOptions.ListType

Field Summary

Fields

Modifier and Type	Field	Description
static final TocOptions	DEFAULT
static final int	DEFAULT_LEVELS
static final String	DEFAULT_TITLE
static final int	DEFAULT_TITLE_LEVEL
final String	divClass
final boolean	isAstAddOptions
final boolean	isBlankLineSpacer
final boolean	isCaseSensitiveTocTag
final boolean	isHtml
final boolean	isNumbered
final boolean	isTextOnly
final int	levels
static final TocOptions.ListType	LIST_TYPE
final String	listClass
final TocOptions.ListType	listType
final String	title
final int	titleLevel
static final int	VALID_LEVELS

Constructor Summary

Constructors

Constructor	Description
TocOptions()
TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, int titleLevel, CharSequence title, TocOptions.ListType listType, boolean isAstAddOptions, boolean isBlankLineSpacer, CharSequence divClass, CharSequence listClass, boolean isCaseSensitiveTocTag)
TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, int titleLevel, String title, TocOptions.ListType listType)
TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, TocOptions.ListType listType)
TocOptions(@NotNull TocOptions other)
TocOptions(TocOptions.AsMutable other)
TocOptions(@Nullable DataHolder options, boolean isSimToc)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static int	getLevels(int... levelList)
String	getTitleHeading()
int	hashCode()
boolean	isLevelIncluded(int level)
@NotNull MutableDataHolder	setIn(@NotNull MutableDataHolder dataHolder)
TocOptions.AsMutable	toMutable()
String	toString()
TocOptions	withDivClass(CharSequence divClass)
TocOptions	withIsAstAddOptions(boolean isAstAddOptions)
TocOptions	withIsBlankLineSpacer(boolean isBlankLineSpacer)
TocOptions	withIsHtml(boolean isHtml)
TocOptions	withIsNumbered(boolean isNumbered)
TocOptions	withIsTextOnly(boolean isTextOnly)
TocOptions	withLevelList(int... levelList)
TocOptions	withLevels(int levels)
TocOptions	withListClass(CharSequence listClass)
TocOptions	withListType(TocOptions.ListType listType)
TocOptions	withRawTitle(CharSequence title)
TocOptions	withRawTitleLevel(int titleLevel)
TocOptions	withTitle(CharSequence title)
TocOptions	withTitleLevel(int titleLevel)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT

public static final TocOptions DEFAULT

DEFAULT_LEVELS

public static final int DEFAULT_LEVELS

See Also:

• Constant Field Values

DEFAULT_TITLE

public static final String DEFAULT_TITLE

See Also:

• Constant Field Values

DEFAULT_TITLE_LEVEL

public static final int DEFAULT_TITLE_LEVEL

See Also:

• Constant Field Values

VALID_LEVELS

public static final int VALID_LEVELS

See Also:

• Constant Field Values

LIST_TYPE

public static final TocOptions.ListType LIST_TYPE

levels

public final int levels

isTextOnly

public final boolean isTextOnly

isNumbered

public final boolean isNumbered

listType

public final TocOptions.ListType listType

isHtml

public final boolean isHtml

titleLevel

public final int titleLevel

title

public final String title

isAstAddOptions

public final boolean isAstAddOptions

isBlankLineSpacer

public final boolean isBlankLineSpacer

divClass

public final String divClass

listClass

public final String listClass

isCaseSensitiveTocTag

public final boolean isCaseSensitiveTocTag

Constructor Details

TocOptions

public TocOptions()

TocOptions

public TocOptions(int levels,
 boolean isHtml,
 boolean isTextOnly,
 boolean isNumbered,
 TocOptions.ListType listType)

TocOptions

public TocOptions(int levels,
 boolean isHtml,
 boolean isTextOnly,
 boolean isNumbered,
 int titleLevel,
 String title,
 TocOptions.ListType listType)

TocOptions

public TocOptions(@NotNull
 TocOptions.AsMutable other)

TocOptions

public TocOptions(@NotNull
 @NotNull TocOptions other)

TocOptions

public TocOptions(@Nullable
 @Nullable DataHolder options,
 boolean isSimToc)

TocOptions

public TocOptions(int levels,
 boolean isHtml,
 boolean isTextOnly,
 boolean isNumbered,
 int titleLevel,
 CharSequence title,
 TocOptions.ListType listType,
 boolean isAstAddOptions,
 boolean isBlankLineSpacer,
 CharSequence divClass,
 CharSequence listClass,
 boolean isCaseSensitiveTocTag)

Method Details

toMutable

public TocOptions.AsMutable toMutable()

Specified by:

toMutable in interface Immutable<TocOptions, TocOptions.AsMutable>

setIn

@NotNull
public @NotNull MutableDataHolder setIn(@NotNull
 @NotNull MutableDataHolder dataHolder)

Specified by:

setIn in interface MutableDataSetter

isLevelIncluded

public boolean isLevelIncluded(int level)

withLevels

public TocOptions withLevels(int levels)

withIsHtml

public TocOptions withIsHtml(boolean isHtml)

withIsTextOnly

public TocOptions withIsTextOnly(boolean isTextOnly)

withIsNumbered

public TocOptions withIsNumbered(boolean isNumbered)

withTitleLevel

public TocOptions withTitleLevel(int titleLevel)

withTitle

public TocOptions withTitle(CharSequence title)

withListType

public TocOptions withListType(TocOptions.ListType listType)

withIsAstAddOptions

public TocOptions withIsAstAddOptions(boolean isAstAddOptions)

withIsBlankLineSpacer

public TocOptions withIsBlankLineSpacer(boolean isBlankLineSpacer)

withRawTitleLevel

public TocOptions withRawTitleLevel(int titleLevel)

withRawTitle

public TocOptions withRawTitle(CharSequence title)

withDivClass

public TocOptions withDivClass(CharSequence divClass)

withListClass

public TocOptions withListClass(CharSequence listClass)

withLevelList

public TocOptions withLevelList(int... levelList)

getLevels

public static int getLevels(int... levelList)

getTitleHeading

public String getTitleHeading()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object