org.asciidoctor
Class Attributes

java.lang.Object
  org.asciidoctor.Attributes

public class Attributes
extends Object

Field Summary

static String	BACKEND
static String	COPY_CSS
static String	DATA_URI
static String	DOCDATE
static String	DOCTIME
static String	DOCTYPE
static String	EXPERIMENTAL
static String	FONTAWESOME_ADMONITION_ICONS
static String	ICONS
static String	ICONS_DIR
static String	IMAGESDIR
static String	LINK_ATTRS
static String	LINK_CSS
static String	LOCALDATE
static String	LOCALTIME
static String	NOT_STYLESHEET_NAME
static String	ORIGINAL_ADMONITION_ICONS_WITH_IMG
static String	SECTION_NUMBERS
static String	SOURCE_HIGHLIGHTER
static String	STYLES_DIR
static String	STYLESHEET_NAME
static String	TITLE
static String	TOC

Constructor Summary

Attributes()

Attributes(Map<String,Object> attributes)

Method Summary

Map<String,Object>	map()
void	setAttribute(String attributeName, Object attributeValue)
void	setAttributes(Map<String,Object> attributes) Adds all attributes.
void	setAttributes(String... attributes) Sets attributes in array form.
void	setAttributes(String attributes) Sets attributes in string form.
void	setBackend(String backend)
void	setCopyCss(boolean copyCss) Sets copy css attribute.
void	setDataUri(boolean dataUri) Sets data-uri attribute.
void	setDocDate(Date docDate) Sets date in format yyyy-MM-dd
void	setDocTime(Date docTime) Sets time in format HH:mm:ss z
void	setDocType(String docType)
void	setExperimental(boolean experimental) Sets experimental attribute.
void	setIcons(String iconsName) Sets which admonition icons to use.
void	setIconsDir(String iconsDir) Sets icons directory.
void	setImagesDir(String imagesDir)
void	setLinkAttrs(boolean linkAttrs) Sets linkattrs attribute.
void	setLinkCss(boolean linkCss) Sets link css attribute.
void	setLocalDate(Date localDate) Sets date in format yyyy-MM-dd
void	setLocalTime(Date localTime) Sets time in format HH:mm:ss z
void	setSectionNumbers(boolean sectionNumbers) auto-number section titles in the HTML backend
void	setSourceHighlighter(String sourceHighlighter)
void	setStylesDir(String stylesDir) Sets the styles dir.
void	setStyleSheetName(String styleSheetName) Sets stylesheet name.
void	setTableOfContents(boolean toc) Sets if a table of contents should be rendered or not.
void	setTitle(String title)
static String	toAsciidoctorFlag(boolean flag)
void	unsetStyleSheet() Unsets stylesheet name so document will be generated without style.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BACKEND

public static final String BACKEND

See Also:

Constant Field Values

TITLE

public static final String TITLE

See Also:

Constant Field Values

DOCTYPE

public static final String DOCTYPE

See Also:

Constant Field Values

IMAGESDIR

public static final String IMAGESDIR

See Also:

Constant Field Values

SOURCE_HIGHLIGHTER

public static final String SOURCE_HIGHLIGHTER

See Also:

Constant Field Values

LOCALDATE

public static final String LOCALDATE

See Also:

Constant Field Values

LOCALTIME

public static final String LOCALTIME

See Also:

Constant Field Values

DOCDATE

public static final String DOCDATE

See Also:

Constant Field Values

DOCTIME

public static final String DOCTIME

See Also:

Constant Field Values

TOC

public static final String TOC

See Also:

Constant Field Values

STYLESHEET_NAME

public static final String STYLESHEET_NAME

See Also:

Constant Field Values

STYLES_DIR

public static final String STYLES_DIR

See Also:

Constant Field Values

NOT_STYLESHEET_NAME

public static final String NOT_STYLESHEET_NAME

See Also:

Constant Field Values

LINK_CSS

public static final String LINK_CSS

See Also:

Constant Field Values

COPY_CSS

public static final String COPY_CSS

See Also:

Constant Field Values

ICONS

public static final String ICONS

See Also:

Constant Field Values

ICONS_DIR

public static final String ICONS_DIR

See Also:

Constant Field Values

DATA_URI

public static final String DATA_URI

See Also:

Constant Field Values

SECTION_NUMBERS

public static final String SECTION_NUMBERS

See Also:

Constant Field Values

ORIGINAL_ADMONITION_ICONS_WITH_IMG

public static final String ORIGINAL_ADMONITION_ICONS_WITH_IMG

See Also:

Constant Field Values

FONTAWESOME_ADMONITION_ICONS

public static final String FONTAWESOME_ADMONITION_ICONS

See Also:

Constant Field Values

LINK_ATTRS

public static final String LINK_ATTRS

See Also:

Constant Field Values

EXPERIMENTAL

public static final String EXPERIMENTAL

See Also:

Constant Field Values

Constructor Detail

Attributes

public Attributes()

Attributes

public Attributes(Map<String,Object> attributes)

Method Detail

setBackend

public void setBackend(String backend)

setTitle

public void setTitle(String title)

setDocType

public void setDocType(String docType)

setImagesDir

public void setImagesDir(String imagesDir)

setSourceHighlighter

public void setSourceHighlighter(String sourceHighlighter)

setTableOfContents

public void setTableOfContents(boolean toc)

Sets if a table of contents should be rendered or not.

Parameters:

toc - value.

setLocalDate

public void setLocalDate(Date localDate)

Sets date in format yyyy-MM-dd

Parameters:

localDate - object.

setLocalTime

public void setLocalTime(Date localTime)

Sets time in format HH:mm:ss z

Parameters:

localTime - object.

setDocDate

public void setDocDate(Date docDate)

Sets date in format yyyy-MM-dd

Parameters:

docDate - object.

setDocTime

public void setDocTime(Date docTime)

Sets time in format HH:mm:ss z

Parameters:

docTime - object.

setStyleSheetName

public void setStyleSheetName(String styleSheetName)

Sets stylesheet name.

Parameters:

styleSheetName - of css file.

unsetStyleSheet

public void unsetStyleSheet()

Unsets stylesheet name so document will be generated without style.

setStylesDir

public void setStylesDir(String stylesDir)

Sets the styles dir.

Parameters:

stylesDir - directory.

setLinkCss

public void setLinkCss(boolean linkCss)

Sets link css attribute.

Parameters:

linkCss - true if css is linked, false if css is embedded.

setCopyCss

public void setCopyCss(boolean copyCss)

Sets copy css attribute.

Parameters:

copyCss - true if css should be copied to the output location, false otherwise.

setIcons

public void setIcons(String iconsName)

Sets which admonition icons to use. Attributes.ORIGINAL_ADMONITION_ICONS_WITH_IMG constant can be used to use the original icons with images.

Parameters:

iconsName - value.

setDataUri

public void setDataUri(boolean dataUri)

Sets data-uri attribute.

Parameters:

dataUri - true if images should be embedded, false otherwise.

setIconsDir

public void setIconsDir(String iconsDir)

Sets icons directory.

Parameters:

iconsDir -

setSectionNumbers

public void setSectionNumbers(boolean sectionNumbers)

auto-number section titles in the HTML backend

Parameters:

sectionNumbers -

setLinkAttrs

public void setLinkAttrs(boolean linkAttrs)

Sets linkattrs attribute.

Parameters:

linkAttrs - true if Asciidoctor should parse link macro attributes, false otherwise.

setExperimental

public void setExperimental(boolean experimental)

Sets experimental attribute.

Parameters:

experimental - true if experimental features should be enabled, false otherwise.

setAttribute

public void setAttribute(String attributeName,
                         Object attributeValue)

setAttributes

public void setAttributes(String attributes)

Sets attributes in string form. An example of a valid string would be: 'toc numbered source-highlighter=coderay' where you are adding three attributes: toc, numbered and source-highlighter with value coderay.

Parameters:

attributes - in string format.

setAttributes

public void setAttributes(String... attributes)

Sets attributes in array form. An example of a valid array would be: '['toc', 'numbered']' where you are adding three attributes: toc and numbered.

Parameters:

attributes - in array format.

setAttributes

public void setAttributes(Map<String,Object> attributes)

Adds all attributes.

Parameters:

attributes - to add.

map

public Map<String,Object> map()

toAsciidoctorFlag

public static String toAsciidoctorFlag(boolean flag)