Module org.commonmark
Package org.commonmark.node

Class ListItem

java.lang.Object
org.commonmark.node.Node
org.commonmark.node.Block
org.commonmark.node.ListItem
public class ListItem extends Block
A child of a ListBlock, containing other blocks (e.g. Paragraph, other lists, etc).

Note that a list item can't directly contain Text, it needs to be: ListItem : Paragraph : Text. If you want a list that is rendered tightly, create a list with ListBlock.setTight(boolean).

See Also:

  • Field Details

    • markerIndent

      private Integer markerIndent

    • contentIndent

      private Integer contentIndent

  • Constructor Details

    • ListItem

      public ListItem()

  • Method Details

    • accept

      public void accept(Visitor visitor)
      Specified by:
      accept in class Node

    • getMarkerIndent

      public Integer getMarkerIndent()
      Returns the indent of the marker such as "-" or "1." in columns (spaces or tab stop of 4) if available, or null otherwise.

      Some examples and their marker indent: 

      - Foo
      Marker indent: 0 
       - Foo
      Marker indent: 1 
        1. Foo
      Marker indent: 2

    • setMarkerIndent

      public void setMarkerIndent(Integer markerIndent)

    • getContentIndent

      public Integer getContentIndent()
      Returns the indent of the content in columns (spaces or tab stop of 4) if available, or null otherwise. The content indent is counted from the beginning of the line and includes the marker on the first line.

      Some examples and their content indent: 

      - Foo
      Content indent: 2 
       - Foo
      Content indent: 3 
        1. Foo
      Content indent: 5

      Note that subsequent lines in the same list item need to be indented by at least the content indent to be counted as part of the list item.

    • setContentIndent

      public void setContentIndent(Integer contentIndent)

    • appendChild

      @Deprecated public void appendChild(Node child)
      Deprecated.
      list items should only contain block nodes; if you're trying to create a list that is rendered without paragraphs, use ListBlock.setTight(boolean) instead.
      Overrides:
      appendChild in class Node

    • appendChild

      public void appendChild(Block child)