Package org.asciidoctor.ast
Interface Section
- All Superinterfaces:
ContentNode
,StructuralNode
- All Known Implementing Classes:
SectionImpl
-
Field Summary
Fields inherited from interface org.asciidoctor.ast.StructuralNode
SUBSTITUTION_ATTRIBUTES, SUBSTITUTION_MACROS, SUBSTITUTION_POST_REPLACEMENTS, SUBSTITUTION_QUOTES, SUBSTITUTION_REPLACEMENTS, SUBSTITUTION_SPECIAL_CHARACTERS
-
Method Summary
Modifier and TypeMethodDescriptionint
getIndex()
int
Deprecated.Section numeral.int
index()
Deprecated.Please usegetIndex()
boolean
boolean
int
number()
Deprecated.Please usegetNumber()
boolean
numbered()
Deprecated.Please useisNumbered()
sectname()
Deprecated.Please usegetSectionName()
boolean
special()
Deprecated.Please useisSpecial()
Methods inherited from interface org.asciidoctor.ast.ContentNode
addRole, context, document, getAttr, getAttr, getAttr, getAttribute, getAttribute, getAttribute, getAttributes, getContext, getDocument, getId, getNodeName, getParent, getReftext, getRole, getRoles, hasAttr, hasAttr, hasAttribute, hasAttribute, hasRole, iconUri, id, imageUri, imageUri, isAttr, isAttr, isAttribute, isAttribute, isBlock, isInline, isOption, isReftext, isRole, mediaUri, normalizeWebPath, parent, readAsset, removeRole, role, setAttr, setAttribute, setId
Methods inherited from interface org.asciidoctor.ast.StructuralNode
addSubstitution, append, blocks, content, convert, findBy, getBlocks, getCaption, getContent, getContentModel, getLevel, getSourceLocation, getStyle, getSubstitutions, getTitle, isSubstitutionEnabled, prependSubstitution, removeSubstitution, setCaption, setLevel, setStyle, setSubstitutions, setTitle, style, title
-
Method Details
-
index
Deprecated.Please usegetIndex()
- Returns:
- the 0-based index order of this section within the parent block
-
getIndex
int getIndex()- Returns:
- the 0-based index order of this section within the parent block
-
number
Deprecated.Please usegetNumber()
- Returns:
- the number of this section within the parent block
-
getNumber
Deprecated.Please usegetNumeral()
- Returns:
- the number of this section within the parent block
-
getNumeral
String getNumeral()Section numeral. This is a roman numeral for book parts, arabic numeral for regular sections, and a letter for special sections.- Returns:
- the section numeral
-
sectname
Deprecated.Please usegetSectionName()
- Returns:
- the section name of this section
-
getSectionName
String getSectionName()- Returns:
- the section name of this section
-
special
Deprecated.Please useisSpecial()
- Returns:
- Get the flag to indicate whether this is a special section or a child of one
-
isSpecial
boolean isSpecial()- Returns:
- Get the flag to indicate whether this is a special section or a child of one
-
numbered
Deprecated.Please useisNumbered()
- Returns:
- the state of the numbered attribute at this section (need to preserve for creating TOC)
-
isNumbered
boolean isNumbered()- Returns:
- the state of the numbered attribute at this section (need to preserve for creating TOC)
-
getNumeral()