Package org.asciidoctor.ast
Interface Section
-
- All Superinterfaces:
ContentNode
,StructuralNode
- All Known Implementing Classes:
SectionImpl
public interface Section extends StructuralNode
-
-
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
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description int
getIndex()
int
getNumber()
Deprecated.Please usegetNumeral()
java.lang.String
getNumeral()
Section numeral.java.lang.String
getSectionName()
int
index()
Deprecated.Please usegetIndex()
boolean
isNumbered()
boolean
isSpecial()
int
number()
Deprecated.Please usegetNumber()
boolean
numbered()
Deprecated.Please useisNumbered()
java.lang.String
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 Detail
-
index
@Deprecated int 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 int number()
Deprecated.Please usegetNumber()
- Returns:
- the number of this section within the parent block
-
getNumber
@Deprecated int getNumber()
Deprecated.Please usegetNumeral()
- Returns:
- the number of this section within the parent block
-
getNumeral
java.lang.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 java.lang.String sectname()
Deprecated.Please usegetSectionName()
- Returns:
- the section name of this section
-
getSectionName
java.lang.String getSectionName()
- Returns:
- the section name of this section
-
special
@Deprecated boolean 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 boolean 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)
-
-