org.asciidoctor.ast

Interface StructuralNode

All Superinterfaces:

ContentNode

All Known Subinterfaces:

Block, DescriptionList, Document, List, ListItem, Section, Table

All Known Implementing Classes:

BlockImpl, DescriptionListEntryImpl, DescriptionListImpl, DocumentImpl, ListImpl, ListItemImpl, SectionImpl, StructuralNodeImpl, TableImpl

public interface StructuralNode
extends ContentNode

Method Summary

Modifier and Type	Method and Description
void	append(StructuralNode block) Appends a new child block as the last block to this block.
java.util.List<StructuralNode>	blocks() Deprecated. Please use getBlocks() instead
java.lang.Object	content() Deprecated. Please use getContent() instead
java.lang.String	convert()
java.util.List<StructuralNode>	findBy(java.util.Map<java.lang.Object,java.lang.Object> selector)
java.util.List<StructuralNode>	getBlocks()
java.lang.Object	getContent()
int	getLevel()
Cursor	getSourceLocation() Returns the source location of this block.
java.lang.String	getStyle()
java.lang.String	getTitle()
void	setTitle(java.lang.String title)
java.lang.String	style() Deprecated. Please use getStyle() instead
java.lang.String	title() Deprecated. Please use getTitle() instead

Methods inherited from interface org.asciidoctor.ast.ContentNode

addRole, context, document, getAttr, getAttr, getAttr, getAttributes, getContext, getDocument, getId, getNodeName, getParent, getReftext, getRole, getRoles, hasRole, iconUri, id, imageUri, imageUri, isAttr, isAttr, isBlock, isInline, isOption, isReftext, isRole, mediaUri, normalizeWebPath, parent, readAsset, removeRole, role, setAttr, setId

Method Detail

title

java.lang.String title()

Deprecated. Please use getTitle() instead

getTitle

java.lang.String getTitle()

setTitle

void setTitle(java.lang.String title)

style

java.lang.String style()

Deprecated. Please use getStyle() instead

getStyle

java.lang.String getStyle()

blocks

java.util.List<StructuralNode> blocks()

Deprecated. Please use getBlocks() instead

Returns:

The list of child blocks of this block

getBlocks

java.util.List<StructuralNode> getBlocks()

Returns:

The list of child blocks of this block

append

void append(StructuralNode block)

Appends a new child block as the last block to this block.

Parameters:

block - The new child block added as last child to this block.

content

java.lang.Object content()

Deprecated. Please use getContent() instead

getContent

java.lang.Object getContent()

convert

java.lang.String convert()

findBy

java.util.List<StructuralNode> findBy(java.util.Map<java.lang.Object,java.lang.Object> selector)

getLevel

int getLevel()

getSourceLocation

Cursor getSourceLocation()

Returns the source location of this block. This information is only available if the sourcemap option is enabled when loading or rendering the document.

Returns:

the source location of this block or null if the sourcemap option is not enabled when loading the document.