Package com.atlassian.adf.model.node

Class Table

    • Method Detail

      • table

        public static Table table()
        Returns:
        a new, empty table. At least one table row must be added to make it valid.

      • table

        public static Table table​(TableRow content)
        Returns:
        a new table with the given content

      • table

        public static Table table​(TableRow... content)
        Returns:
        a new table with the given content

      • table

        public static Table table​(Iterable<? extends TableRow> content)
        Returns:
        a new table with the given content

      • table

        public static Table table​(Stream<? extends TableRow> content)
        Returns:
        a new table with the given content

      • table

        public static Table table​(Table.Layout layout)
        Returns:
        a new, empty table using the specified layout. At least one table row must be added to make it valid.

      • table

        public static Table table​(Table.Layout layout,
                          TableRow content)
        Returns:
        a new table with the given layout and content

      • table

        public static Table table​(Table.Layout layout,
                          TableRow... content)
        Returns:
        a new table with the given layout and content

      • tr

        public Table tr​(TableRowContent content)
        A convenience method for content(tableRow(content))
        Parameters:
        content - the content to add as a single table row within the table
        Returns:
        this

      • tr

        public Table tr​(TableRowContent... content)
        A convenience method for content(tableRow(content))
        Parameters:
        content - the content to add as a single table row within the table
        Returns:
        this

      • tr

        public Table tr​(Iterable<? extends TableRowContent> content)
        A convenience method for content(tableRow(content))
        Parameters:
        content - the content to add as a single table row within the table
        Returns:
        this

      • tr

        public Table tr​(Stream<? extends TableRowContent> content)
        A convenience method for content(tableRow(content))
        Parameters:
        content - the content to add as a single table row within the table
        Returns:
        this

      • isNumberColumnEnabled

        public boolean isNumberColumnEnabled()

      • isNumberColumnEnabled

        public Table isNumberColumnEnabled​(@Nullable
                                   Boolean isNumberColumnEnabled)

      • withNumberColumn

        public Table withNumberColumn()

      • withoutNumberColumn

        public Table withoutNumberColumn()

      • width

        public Table width​(@Nullable
                   Number width)

      • localId

        public Table localId​(@Nullable
                     String localId)

      • copy

        public Table 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.
        Specified by:
        copy in interface ContentNode<Table,​TableRow>
        Specified by:
        copy in interface Element
        Specified by:
        copy in interface Marked<Table,​TableMark>
        Specified by:
        copy in interface Node
        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".
        Specified by:
        elementType in interface Element

      • 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.
        Specified by:
        toMap in interface Element
        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<Table,​TableRow>
        Parameters:
        sb - where to write the result