Package com.atlassian.adf.model.node

Class TableRow

java.lang.Object

com.atlassian.adf.model.node.AbstractNode<C>

com.atlassian.adf.model.node.AbstractContentNode<TableRow,TableRowContent>

com.atlassian.adf.model.node.TableRow

All Implemented Interfaces:

Element, Node, ContentNode<TableRow,TableRowContent>

@Documentation(state=REVIEWED,
               date="2023-07-26")
public class TableRow
extends AbstractContentNode<TableRow,TableRowContent>

Defines rows within a table and is a container for table heading and table cell nodes.

⚠️ WARNING: Tables are documented as supported on web and desktop only. Mobile rendering support for tables may be restricted or entirely unavailable.

Example

Java

 tr(
         th(
                 p(
                         text("Heading one").strong()
                 )
         )
 )
 

ADF

   {
     "type": "tableRow",
     "content": [
       {
         "type": "tableHeader",
         "attrs": {},
         "content": [
           {
             "type": "paragraph",
             "content": [
               {
                 "type": "text",
                 "text": "Heading one",
                 "marks": [
                   {
                     "type": "strong"
                   }
                 ]
               }
             ]
           }
         ]
       }
     ]
   }
 

Result

Heading one

See Also:

Node - tableRow

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.adf.model.node.AbstractNode

AbstractNode.ToStringHelper

Nested classes/interfaces inherited from interface com.atlassian.adf.model.node.Node

Node.Attr, Node.Key, Node.Type

Field Summary

Fields inherited from class com.atlassian.adf.model.node.AbstractContentNode

content

Method Summary

Modifier and Type	Method	Description
void	appendPlainText(StringBuilder sb)	Renders this node as plain-text suitable for viewing by end users.
Class<TableRowContent>	contentClass()	Returns Class<N>, the class representing the type of items held by this node.
protected void	contentNodeValidate()
TableRow	copy()	Returns a deep copy of this element, including copies of any nodes or marks that it contains.
String	elementType()	The type value that identifies this element, such as "paragraph" or "strong".
static TableRow	tableRow()
static TableRow	tableRow(TableRowContent content)
static TableRow	tableRow(TableRowContent... content)
static TableRow	tableRow(Iterable<? extends TableRowContent> content)
static TableRow	tableRow(Stream<? extends TableRowContent> content)
Map<String,?>	toMap()	Transforms this element to a map of String values to various basic object types suitable for direct rendering as JSON content.
static TableRow	tr()
static TableRow	tr(TableRowContent content)
static TableRow	tr(TableRowContent... content)
static TableRow	tr(Iterable<? extends TableRowContent> content)
static TableRow	tr(Stream<? extends TableRowContent> content)

Methods inherited from class com.atlassian.adf.model.node.AbstractContentNode

addContent, addContentIfPresent, allNodes, appendContentNodeFields, appendNodeFields, appendPlainTextContentJoinedWith, appendPlainTextInlineContent, clear, content, content, content, content, content, contentFieldMaps, contentNodeEquals, contentNodeHashCode, isEmpty, nodeEquals, nodeHashCode, parseContentItem, parseContentItems, parseOptionalContent, parseRequiredContent, parseRequiredContentAllowEmpty, removeIf, replaceContent, requireNotEmpty, transformContent, transformDescendants, trim, validate, validateContentItems, validateContentNodeForAppend

Methods inherited from class com.atlassian.adf.model.node.AbstractNode

doubleEq, doubleHash, equals, hashCode, isSupported, mapWithType, numberEq, numberHash, self, toPlainText, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.adf.model.node.type.ContentNode

allNodesOfType, allNodesOfTypeAsList

Methods inherited from interface com.atlassian.adf.model.Element

isSupported

Methods inherited from interface com.atlassian.adf.model.node.Node

toPlainText

Method Detail

tr

public static TableRow tr()

Returns:

a new, empty table row. At least one TableHeader or TableCell must be added as content to make the table row valid.

tr

public static TableRow tr(TableRowContent content)

Returns:

a new table row with the given content

tr

public static TableRow tr(TableRowContent... content)

Returns:

a new table row with the given content

tr

public static TableRow tr(Iterable<? extends TableRowContent> content)

Returns:

a new table row with the given content

tr

public static TableRow tr(Stream<? extends TableRowContent> content)

Returns:

a new table row with the given content

tableRow

public static TableRow tableRow()

See Also:

tr()

tableRow

public static TableRow tableRow(TableRowContent content)

See Also:

tr(TableRowContent)

tableRow

public static TableRow tableRow(TableRowContent... content)

See Also:

tr(TableRowContent[])

tableRow

public static TableRow tableRow(Iterable<? extends TableRowContent> content)

See Also:

tr(Iterable)

tableRow

public static TableRow tableRow(Stream<? extends TableRowContent> content)

See Also:

tr(Stream)

contentClass

public Class<TableRowContent> contentClass()

Description copied from interface: ContentNode

Returns Class<N>, the class representing the type of items held by this node.

copy

public TableRow copy()

Description copied from interface: Element

Returns a deep copy of this element, including copies of any nodes or marks that it contains. The copy will not necessarily be in exactly the same state as the original in some cases. For example, a text node that is used inside a codeBlock will have the ability to use marks on it disabled, but a copy made of the text node using this method will not similarly disallow marks unless it is also added to a content node with those same restrictions.

Implementations notes:

• Implementations should narrow the return type.
• Implementations should return this if the element is immutable. The @Immutable annotation should be used on the class to offer additional confirmation of this intent.
• Implementations should return parse(toMap()) if they have state.
• While there may be cases where it is worthwhile to do something more efficient than the conversion to a map and back, this is discouraged because it would add yet another fragile piece of code that breaks when new data is added to the node. The parse and toMap methods already have to be updated in these circumstances, so it makes sense to take advantage of that.

Returns:

a copy of this element, or this if the element is immutable anyway

elementType

public String elementType()

Description copied from interface: Element

The type value that identifies this element, such as "paragraph" or "strong".

contentNodeValidate

protected void contentNodeValidate()

Overrides:

contentNodeValidate in class AbstractContentNode<TableRow,TableRowContent>

toMap

public Map<String,?> toMap()

Description copied from interface: Element

Transforms this element to a map of String values to various basic object types suitable for direct rendering as JSON content.

Returns:

the map representation of this ADF element

appendPlainText

public void appendPlainText(StringBuilder sb)

Description copied from interface: Node

Renders this node as plain-text suitable for viewing by end users. This is equivalent to calling Node.toPlainText() and appending the result to the given buffer, except that it may be slightly more efficient, since it will write directly to the existing buffer instead of using a temporary buffer and having to make a copy of the result.

Specified by:

appendPlainText in interface Node

Overrides:

appendPlainText in class AbstractContentNode<TableRow,TableRowContent>

Parameters:

sb - where to write the result