Package org.asciidoctor.ast
Interface Cell
-
- All Superinterfaces:
ContentNode
,StructuralNode
- All Known Implementing Classes:
CellImpl
public interface Cell 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description int
getColspan()
Column
getColumn()
java.lang.Object
getContent()
Table.HorizontalAlignment
getHorizontalAlignment()
Returns the horizonzal alignment of this cell.Document
getInnerDocument()
If the style of a cell isasciidoc
the content of the cell is an inner document.int
getRowspan()
java.lang.String
getSource()
java.lang.String
getStyle()
Returns the style of this cell.java.lang.String
getText()
Table.VerticalAlignment
getVerticalAlignment()
Returns the vertical alignment of this cell.void
setHorizontalAlignment(Table.HorizontalAlignment halign)
Sets the horizontal alignment of this cell.void
setInnerDocument(Document document)
void
setSource(java.lang.String source)
Sets the source of the Cell.void
setStyle(java.lang.String style)
Sets the style of this cell.void
setVerticalAlignment(Table.VerticalAlignment valign)
Sets the vertical alignment of this cell.-
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
-
Methods inherited from interface org.asciidoctor.ast.StructuralNode
addSubstitution, append, blocks, content, convert, findBy, getBlocks, getCaption, getContentModel, getLevel, getSourceLocation, getSubstitutions, getTitle, isSubstitutionEnabled, prependSubstitution, removeSubstitution, setCaption, setLevel, setSubstitutions, setTitle, style, title
-
-
-
-
Method Detail
-
getColumn
Column getColumn()
-
getColspan
int getColspan()
-
getRowspan
int getRowspan()
-
getText
java.lang.String getText()
- Returns:
- The text of the cell including substitutions being applied.
-
getSource
java.lang.String getSource()
- Returns:
- The text of the cell without substitutions being applied.
-
setSource
void setSource(java.lang.String source)
Sets the source of the Cell.- Parameters:
source
- The source of this Cell, substitutions will still be applied.
-
getContent
java.lang.Object getContent()
- Specified by:
getContent
in interfaceStructuralNode
-
getStyle
java.lang.String getStyle()
Returns the style of this cell. The default isnull
. Possible values are:null
"strong"
"emphasis"
"monospaced"
"header"
"literal"
"verse"
"asciidoc"
- Specified by:
getStyle
in interfaceStructuralNode
- Returns:
- The style of this cell.
-
setStyle
void setStyle(java.lang.String style)
Sets the style of this cell.- Specified by:
setStyle
in interfaceStructuralNode
- Parameters:
style
- Values likeasciidoc
,verse
,literal
orheader
.- See Also:
getStyle()
-
getHorizontalAlignment
Table.HorizontalAlignment getHorizontalAlignment()
Returns the horizonzal alignment of this cell.- Returns:
- a constant representing the horizontal alignment.
-
setHorizontalAlignment
void setHorizontalAlignment(Table.HorizontalAlignment halign)
Sets the horizontal alignment of this cell.- Parameters:
halign
- EitherTable.HorizontalAlignment.LEFT
,Table.HorizontalAlignment.CENTER
orTable.HorizontalAlignment.RIGHT
-
getVerticalAlignment
Table.VerticalAlignment getVerticalAlignment()
Returns the vertical alignment of this cell.- Returns:
- a constant representing the vertical alignment.
-
setVerticalAlignment
void setVerticalAlignment(Table.VerticalAlignment valign)
Sets the vertical alignment of this cell.- Parameters:
valign
- EitherTable.VerticalAlignment.TOP
,Table.VerticalAlignment.MIDDLE
orTable.VerticalAlignment.BOTTOM
-
getInnerDocument
Document getInnerDocument()
If the style of a cell isasciidoc
the content of the cell is an inner document. This method returns this inner document.- Returns:
- The inner document if the cell style is
asciidoc
-
setInnerDocument
void setInnerDocument(Document document)
- See Also:
getInnerDocument()
-
-