Package com.atlassian.adf.model.node

Class AbstractTableCellNode<N extends AbstractTableCellNode<N>>

java.lang.Object

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

com.atlassian.adf.model.node.AbstractContentNode<N,TableCellContent>

com.atlassian.adf.model.node.AbstractTableCellNode<N>

Type Parameters:

N - the subclass's own type

All Implemented Interfaces:

Element, Node, ContentNode<N,TableCellContent>, TableCellNode<N>, TableRowContent

Direct Known Subclasses:

TableCell, TableHeader

@Internal
public abstract class AbstractTableCellNode<N extends AbstractTableCellNode<N>>
extends AbstractContentNode<N,TableCellContent>
implements TableCellNode<N>

Either of the data-containing nodes that can be placed in a TableRow, meaning either a tableHeader or a tableCell.

Only the nodes that implement the TableCellContent marker interface are permitted as content.

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

Modifier and Type	Field	Description
protected String	background
protected Integer	colspan
protected int[]	colwidth
protected Integer	rowspan

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

content

Method Summary

Modifier and Type	Method	Description
protected void	appendContentNodeFields(AbstractNode.ToStringHelper buf)	Allows content nodes that have their own fields to augment the toString() implementation with their own field values.
void	appendPlainText(StringBuilder sb)	Renders this node as plain-text suitable for viewing by end users.
Optional<String>	background()	Returns the background color for the table cell, if one is set.
N	background(String background)	Sets the background color for the table cell.
Optional<Integer>	colspan()	Returns the colspan setting for the table cell, if one is set.
N	colspan(Integer colspan)
N	colspanAndColwidth(Integer colspan, int[] colwidth)	Sets the number of columns that the table cell spans, as well as the widths of those columns.
Optional<int[]>	colwidth()	Returns the column widths for the table cell's spanned columns, if set.
N	colwidth(int... colwidth)
N	content(String content)
N	content(String... content)
Class<TableCellContent>	contentClass()	Returns Class<N>, the class representing the type of items held by this node.
protected boolean	contentNodeEquals(N other)	Allows content nodes that have their own fields to augment the equals implementation with tests for their own field values.
protected int	contentNodeHashCode()	Allows content nodes that have their own fields to augment the hashCode implementation with a hash of their own field values.
protected void	contentNodeValidate()
protected N	parseTableNode(Map<String,?> map)
Optional<Integer>	rowspan()	Returns the rowspan setting for the table cell, if one is set.
N	rowspan(Integer rowspan)	Sets the number of rows that the table cell spans.
Map<String,?>	toMap()	Note: The map of attributes is always added, even if it is empty.
protected void	validateContentNodeForAppend(TableCellContent node)	Called on each content node before it is added to validate that the node can be accepted.

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

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

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

allNodes, allNodesOfType, allNodesOfTypeAsList, clear, content, content, content, content, content, copy, isEmpty, removeIf, replaceContent, transformContent, transformDescendants

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

elementType, isSupported, validate

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

toPlainText

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

isHeader

Field Detail

background

@Nullable
protected String background

colspan

@Nullable
protected Integer colspan

colwidth

@Nullable
protected int[] colwidth

rowspan

@Nullable
protected Integer rowspan

Method Detail

background

public Optional<String> background()

Description copied from interface: TableCellNode

Returns the background color for the table cell, if one is set.

Specified by:

background in interface TableCellNode<N extends AbstractTableCellNode<N>>

Returns:

the background color for the table cell, or empty() if not set

background

public N background(@Nullable
                    String background)

Description copied from interface: TableCellNode

Sets the background color for the table cell.

Specified by:

background in interface TableCellNode<N extends AbstractTableCellNode<N>>

Parameters:

background - short or long hex color code or HTML color name

Returns:

this

content

public N content(String content)

Specified by:

content in interface TableCellNode<N extends AbstractTableCellNode<N>>

content

public N content(String... content)

Specified by:

content in interface TableCellNode<N extends AbstractTableCellNode<N>>

rowspan

public Optional<Integer> rowspan()

Description copied from interface: TableCellNode

Returns the rowspan setting for the table cell, if one is set.

Specified by:

rowspan in interface TableCellNode<N extends AbstractTableCellNode<N>>

Returns:

the rowspan setting for the table cell, or empty() if not set

rowspan

public N rowspan(@Nullable
                 Integer rowspan)

Description copied from interface: TableCellNode

Sets the number of rows that the table cell spans.

Specified by:

rowspan in interface TableCellNode<N extends AbstractTableCellNode<N>>

Parameters:

rowspan - a positive integer, default 1.

Returns:

this

colspan

public Optional<Integer> colspan()

Description copied from interface: TableCellNode

Returns the colspan setting for the table cell, if one is set.

Specified by:

colspan in interface TableCellNode<N extends AbstractTableCellNode<N>>

Returns:

the colspan setting for the table cell, or empty() if not set

colwidth

public Optional<int[]> colwidth()

Description copied from interface: TableCellNode

Returns the column widths for the table cell's spanned columns, if set.

Specified by:

colwidth in interface TableCellNode<N extends AbstractTableCellNode<N>>

Returns:

the column widths for the table cell's spanned columns, or empty() if not set

colspan

public N colspan(@Nullable
                 Integer colspan)

colwidth

public N colwidth(@Nullable
                  int... colwidth)

colspanAndColwidth

public N colspanAndColwidth(@Nullable
                            Integer colspan,
                            @Nullable
                            int[] colwidth)

Description copied from interface: TableCellNode

Sets the number of columns that the table cell spans, as well as the widths of those columns.

Specified by:

colspanAndColwidth in interface TableCellNode<N extends AbstractTableCellNode<N>>

Parameters:

colspan - a positive integer, default 1.

colwidth - an array of non-negative integers, at least one of which is positive, and with exactly one value for each of the columns counted by colspan (meaning exactly 1 if colspan is null). As an example, colspanAndColwidth(3, new int[] {120, 0, 120}) is a valid request.

Returns:

this

contentNodeValidate

protected void contentNodeValidate()

Overrides:

contentNodeValidate in class AbstractContentNode<N extends AbstractTableCellNode<N>,TableCellContent>

contentClass

public Class<TableCellContent> contentClass()

Description copied from interface: ContentNode

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

Specified by:

contentClass in interface ContentNode<N extends AbstractTableCellNode<N>,TableCellContent>

toMap

public Map<String,?> toMap()

Note: The map of attributes is always added, even if it is empty. This is a temporary patch to mirror the behaviour of the TypeScript parser (which always includes an empty attributes "attrs": {} field in table cells), in order to pass consistency checks during rollout. This change will be reverted when TableParser.OMIT_TABLE_ATTRIBUTES is rolled out.

Specified by:

toMap in interface Element

Returns:

the map representation of this ADF element

parseTableNode

protected N parseTableNode(Map<String,?> map)

validateContentNodeForAppend

protected void validateContentNodeForAppend(TableCellContent node)

Description copied from class: AbstractContentNode

Called on each content node before it is added to validate that the node can be accepted.

Overrides:

validateContentNodeForAppend in class AbstractContentNode<N extends AbstractTableCellNode<N>,TableCellContent>

Parameters:

node - the node that is about to be added

contentNodeEquals

protected final boolean contentNodeEquals(N other)

Description copied from class: AbstractContentNode

Allows content nodes that have their own fields to augment the equals implementation with tests for their own field values.

Implementations need not check for identity, null, or a different node class; those are already covered by AbstractNode.equals(Object). Implementations need not check the AbstractContentNode.content(), either; that is already covered by AbstractContentNode.nodeEquals(AbstractContentNode), which is expected to be this method's only consumer.

Just as with the relationship between hashCode, equals, and toString for ordinary Java classes, subclasses of AbstractContentNode should maintain consistent implementations of contentNodeHashCode, contentNodeEquals, and appendContentNodeFields.

Overrides:

contentNodeEquals in class AbstractContentNode<N extends AbstractTableCellNode<N>,TableCellContent>

Returns:

true if all additional field values that belong to a particular type of content node test as equal; false if differences are found

See Also:

AbstractContentNode.contentNodeHashCode(), AbstractContentNode.appendContentNodeFields(ToStringHelper)

contentNodeHashCode

protected final int contentNodeHashCode()

Description copied from class: AbstractContentNode

Allows content nodes that have their own fields to augment the hashCode implementation with a hash of their own field values.

Implementations need not include the node's class; that is already covered by AbstractNode.hashCode(). Implementations need not include the content, either; that is already covered by AbstractNode.nodeHashCode(), which is expected to be this method's only consumer.

Just as with the relationship between hashCode, equals, and toString for ordinary Java classes, subclasses of AbstractContentNode should maintain consistent implementations of contentNodeHashCode, contentNodeEquals, and appendContentNodeFields.

Overrides:

contentNodeHashCode in class AbstractContentNode<N extends AbstractTableCellNode<N>,TableCellContent>

Returns:

the hash code of any additional field values that belong to a particular type of content node.

See Also:

AbstractContentNode.contentNodeEquals(AbstractContentNode), AbstractContentNode.appendContentNodeFields(ToStringHelper)

appendContentNodeFields

protected final void appendContentNodeFields(AbstractNode.ToStringHelper buf)

Description copied from class: AbstractContentNode

Allows content nodes that have their own fields to augment the toString() implementation with their own field values.

Each field's value should be provided by calling AbstractNode.ToStringHelper.appendField(String, Object). The value may be null, in which case the field is omitted, for brevity. It will handle array values gracefully, including arrays of primitive types.

Just as with the relationship between hashCode, equals, and toString for ordinary Java classes, subclasses of AbstractContentNode should maintain consistent implementations of contentNodeHashCode, contentNodeEquals, and appendContentNodeFields.

Overrides:

appendContentNodeFields in class AbstractContentNode<N extends AbstractTableCellNode<N>,TableCellContent>

Parameters:

buf - where the field values should be written

See Also:

AbstractContentNode.contentNodeHashCode(), AbstractContentNode.contentNodeEquals(AbstractContentNode)

appendPlainText

public final 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<N extends AbstractTableCellNode<N>,TableCellContent>

Parameters:

sb - where to write the result