org.asciidoctor.ast

Interface DocumentRuby

All Superinterfaces:

AbstractBlock

All Known Implementing Classes:

Document

public interface DocumentRuby
extends AbstractBlock

Method Summary

Modifier and Type	Method and Description
boolean	basebackend(java.lang.String backend)
java.util.List<AbstractBlock>	blocks()
java.lang.Object	doctitle(java.util.Map<java.lang.Object,java.lang.Object> opts) Get doc title
java.util.Map<java.lang.String,java.lang.Object>	getAttributes()
java.util.Map<java.lang.Object,java.lang.Object>	getOptions()
java.lang.String	title()

Methods inherited from interface org.asciidoctor.ast.AbstractBlock

attributes, content, context, convert, delegate, document, findBy, id, role, style

Method Detail

doctitle

java.lang.Object doctitle(java.util.Map<java.lang.Object,java.lang.Object> opts)

Get doc title

Parameters:

opts - to get the doc title. Key should be Ruby symbols.

Returns:

String if partition flag is not set to false or not present, Title if partition is set to true.

See Also:

Title

title

java.lang.String title()

Specified by:

title in interface AbstractBlock

Returns:

page title

getAttributes

java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Returns:

attributes defined in document

basebackend

boolean basebackend(java.lang.String backend)

Returns:

basebackend attribute value

blocks

java.util.List<AbstractBlock> blocks()

Specified by:

blocks in interface AbstractBlock

Returns:

blocks contained within current Document.

getOptions

java.util.Map<java.lang.Object,java.lang.Object> getOptions()

Returns:

options defined in document.