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

Modifier and Type	Method and Description
int	getIndex()
int	getNumber() Deprecated. Please use getNumeral()
java.lang.String	getNumeral() Section numeral.
java.lang.String	getSectionName()
int	index() Deprecated. Please use getIndex()
boolean	isNumbered()
boolean	isSpecial()
int	number() Deprecated. Please use getNumber()
boolean	numbered() Deprecated. Please use isNumbered()
java.lang.String	sectname() Deprecated. Please use getSectionName()
boolean	special() Deprecated. Please use isSpecial()

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

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

Method Detail

index

@Deprecated
int index()

Deprecated. Please use getIndex()

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 use getNumber()

Returns:

the number of this section within the parent block

getNumber

@Deprecated
int getNumber()

Deprecated. Please use getNumeral()

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 use getSectionName()

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 use isSpecial()

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 use isNumbered()

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)