Class TocOptions
- java.lang.Object
-
- com.vladsch.flexmark.ext.toc.internal.TocOptions
-
- All Implemented Interfaces:
MutableDataSetter
,Immutable<TocOptions,TocOptions.AsMutable>
public class TocOptions extends java.lang.Object implements Immutable<TocOptions,TocOptions.AsMutable>, MutableDataSetter
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TocOptions.AsMutable
static class
TocOptions.ListType
-
Field Summary
Fields Modifier and Type Field Description static TocOptions
DEFAULT
static int
DEFAULT_LEVELS
static java.lang.String
DEFAULT_TITLE
static int
DEFAULT_TITLE_LEVEL
java.lang.String
divClass
boolean
isAstAddOptions
boolean
isBlankLineSpacer
boolean
isCaseSensitiveTocTag
boolean
isHtml
boolean
isNumbered
boolean
isTextOnly
int
levels
static TocOptions.ListType
LIST_TYPE
java.lang.String
listClass
TocOptions.ListType
listType
java.lang.String
title
int
titleLevel
static int
VALID_LEVELS
-
Constructor Summary
Constructors Constructor Description TocOptions()
TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, int titleLevel, java.lang.CharSequence title, TocOptions.ListType listType, boolean isAstAddOptions, boolean isBlankLineSpacer, java.lang.CharSequence divClass, java.lang.CharSequence listClass, boolean isCaseSensitiveTocTag)
TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, int titleLevel, java.lang.String title, TocOptions.ListType listType)
TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, TocOptions.ListType listType)
TocOptions(TocOptions other)
TocOptions(TocOptions.AsMutable other)
TocOptions(DataHolder options, boolean isSimToc)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
static int
getLevels(int... levelList)
java.lang.String
getTitleHeading()
int
hashCode()
boolean
isLevelIncluded(int level)
MutableDataHolder
setIn(MutableDataHolder dataHolder)
TocOptions.AsMutable
toMutable()
java.lang.String
toString()
TocOptions
withDivClass(java.lang.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(java.lang.CharSequence listClass)
TocOptions
withListType(TocOptions.ListType listType)
TocOptions
withRawTitle(java.lang.CharSequence title)
TocOptions
withRawTitleLevel(int titleLevel)
TocOptions
withTitle(java.lang.CharSequence title)
TocOptions
withTitleLevel(int titleLevel)
-
-
-
Field Detail
-
DEFAULT
public static final TocOptions DEFAULT
-
DEFAULT_LEVELS
public static final int DEFAULT_LEVELS
- See Also:
- Constant Field Values
-
DEFAULT_TITLE
public static final java.lang.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 java.lang.String title
-
isAstAddOptions
public final boolean isAstAddOptions
-
isBlankLineSpacer
public final boolean isBlankLineSpacer
-
divClass
public final java.lang.String divClass
-
listClass
public final java.lang.String listClass
-
isCaseSensitiveTocTag
public final boolean isCaseSensitiveTocTag
-
-
Constructor Detail
-
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, java.lang.String title, TocOptions.ListType listType)
-
TocOptions
public TocOptions(@NotNull TocOptions.AsMutable other)
-
TocOptions
public TocOptions(@NotNull TocOptions other)
-
TocOptions
public TocOptions(@Nullable DataHolder options, boolean isSimToc)
-
TocOptions
public TocOptions(int levels, boolean isHtml, boolean isTextOnly, boolean isNumbered, int titleLevel, java.lang.CharSequence title, TocOptions.ListType listType, boolean isAstAddOptions, boolean isBlankLineSpacer, java.lang.CharSequence divClass, java.lang.CharSequence listClass, boolean isCaseSensitiveTocTag)
-
-
Method Detail
-
toMutable
public TocOptions.AsMutable toMutable()
- Specified by:
toMutable
in interfaceImmutable<TocOptions,TocOptions.AsMutable>
-
setIn
@NotNull public MutableDataHolder setIn(@NotNull MutableDataHolder dataHolder)
- Specified by:
setIn
in interfaceMutableDataSetter
-
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(java.lang.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(java.lang.CharSequence title)
-
withDivClass
public TocOptions withDivClass(java.lang.CharSequence divClass)
-
withListClass
public TocOptions withListClass(java.lang.CharSequence listClass)
-
withLevelList
public TocOptions withLevelList(int... levelList)
-
getLevels
public static int getLevels(int... levelList)
-
getTitleHeading
public java.lang.String getTitleHeading()
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-