Package org.asciidoctor.ast

Interface Table

All Superinterfaces:

ContentNode, StructuralNode

All Known Implementing Classes:

TableImpl

public interface Table
extends StructuralNode

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Table.HorizontalAlignment
static class	Table.VerticalAlignment

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	Description
void	assignColumnWidths()	Computes the percentual column widths for all columns.
java.util.List<Row>	getBody()
java.util.List<Column>	getColumns()
java.util.List<Row>	getFooter()
java.lang.String	getFrame()	Returns the frame attribute of the table that defines what frame to render around the table.
java.lang.String	getGrid()	Returns the grid attribute that defines what boundary lines to draw between rows and columns.
java.util.List<Row>	getHeader()
boolean	hasHeaderOption()
void	setFrame(java.lang.String frame)	Sets the frame attribute.
void	setGrid(java.lang.String grid)	Sets the value of the attribute.

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, setContext, 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

hasHeaderOption

boolean hasHeaderOption()

getColumns

java.util.List<Column> getColumns()

getHeader

java.util.List<Row> getHeader()

getFooter

java.util.List<Row> getFooter()

getBody

java.util.List<Row> getBody()

getFrame

java.lang.String getFrame()

Returns the frame attribute of the table that defines what frame to render around the table. By default, the frame attribute is assigned the all value, which draws a border on each side of the table. If you set the frame attribute, you can override the default value with topbot, sides or none.

Returns:

the frame attribute

setFrame

void setFrame(java.lang.String frame)

Sets the frame attribute.

Parameters:

frame - all, topbot, sides or none

See Also:

getFrame()

getGrid

java.lang.String getGrid()

Returns the grid attribute that defines what boundary lines to draw between rows and columns. By default the grid attribute is assigned the all value, which draws lines around each cell. Alternative values are cols to draw lines between columns, rows to draw boundary lines between rows and none to draw no boundary lines

Returns:

the value of the grid attribute, usually either all, cols, rows or none

setGrid

void setGrid(java.lang.String grid)

Sets the value of the attribute.

Parameters:

grid - usually either all, cols, rows or none

See Also:

getGrid()

assignColumnWidths

void assignColumnWidths()

Computes the percentual column widths for all columns. Before calling this method all columns must have been added to the Table by adding them to getColumns() and the desired widths must have been set by calling Column.setWidth(int).