Class: Coradoc::AsciiDoc::Model::List::Item

Inherits:
Base
  • Object
show all
Includes:
Anchorable
Defined in:
lib/coradoc/asciidoc/model/list/item.rb

Overview

List item element for ordered and unordered AsciiDoc lists.

Represents a single item in an ordered or unordered list, which can contain text content, attached blocks (paragraphs, admonitions), and nested lists.

Examples:

Create a simple list item

item = Coradoc::AsciiDoc::Model::List::Item.new
item.content = [Coradoc::AsciiDoc::Model::TextElement.new("First item")]

Create a list item with nested list

item = Coradoc::AsciiDoc::Model::List::Item.new
item.nested = Coradoc::AsciiDoc::Model::List::Unordered.new
item.nested.items << Coradoc::AsciiDoc::Model::List::Item.new

Instance Attribute Summary collapse

Method Summary

Methods included from Anchorable

#default_anchor, #gen_anchor, included, #initialize

Methods inherited from Base

#block_level?, #inline?, #serialize_content, #simplify_block_content, #to_adoc, #to_h, visit, #visit

Instance Attribute Details

#attached ⇒ Array<Coradoc::AsciiDoc::Model::Attached> (readonly)

Returns Attached blocks.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/coradoc/asciidoc/model/list/item.rb', line 43

class Item < Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :content,
            Coradoc::AsciiDoc::Model::Base,
            polymorphic: [
              Coradoc::AsciiDoc::Model::TextElement,
              Coradoc::AsciiDoc::Model::Section
            ]
  attribute :marker, :string
  attribute :subitem, :string
  attribute :line_break, :string, default: -> { "\n" }

  attribute :attached,
            Coradoc::AsciiDoc::Model::Attached,
            polymorphic: [
              Coradoc::AsciiDoc::Model::Admonition,
              Coradoc::AsciiDoc::Model::Paragraph,
              Coradoc::AsciiDoc::Model::Block::Core
            ],
            collection: true,
            initialize_empty: true

  attribute :nested, Coradoc::AsciiDoc::Model::List::Nestable
end

#content ⇒ Array<Coradoc::AsciiDoc::Model::Base> (readonly)

Returns Polymorphic content.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/coradoc/asciidoc/model/list/item.rb', line 43

class Item < Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :content,
            Coradoc::AsciiDoc::Model::Base,
            polymorphic: [
              Coradoc::AsciiDoc::Model::TextElement,
              Coradoc::AsciiDoc::Model::Section
            ]
  attribute :marker, :string
  attribute :subitem, :string
  attribute :line_break, :string, default: -> { "\n" }

  attribute :attached,
            Coradoc::AsciiDoc::Model::Attached,
            polymorphic: [
              Coradoc::AsciiDoc::Model::Admonition,
              Coradoc::AsciiDoc::Model::Paragraph,
              Coradoc::AsciiDoc::Model::Block::Core
            ],
            collection: true,
            initialize_empty: true

  attribute :nested, Coradoc::AsciiDoc::Model::List::Nestable
end

#id ⇒ String? (readonly)

Returns Optional identifier for the list item.

Returns:

  • (String, nil) —

    Optional identifier for the list item



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/coradoc/asciidoc/model/list/item.rb', line 43

class Item < Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :content,
            Coradoc::AsciiDoc::Model::Base,
            polymorphic: [
              Coradoc::AsciiDoc::Model::TextElement,
              Coradoc::AsciiDoc::Model::Section
            ]
  attribute :marker, :string
  attribute :subitem, :string
  attribute :line_break, :string, default: -> { "\n" }

  attribute :attached,
            Coradoc::AsciiDoc::Model::Attached,
            polymorphic: [
              Coradoc::AsciiDoc::Model::Admonition,
              Coradoc::AsciiDoc::Model::Paragraph,
              Coradoc::AsciiDoc::Model::Block::Core
            ],
            collection: true,
            initialize_empty: true

  attribute :nested, Coradoc::AsciiDoc::Model::List::Nestable
end

#line_break ⇒ String (readonly)

Returns Line break character (default: “n”).

Returns:

  • (String) —

    Line break character (default: “n”)



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/coradoc/asciidoc/model/list/item.rb', line 43

class Item < Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :content,
            Coradoc::AsciiDoc::Model::Base,
            polymorphic: [
              Coradoc::AsciiDoc::Model::TextElement,
              Coradoc::AsciiDoc::Model::Section
            ]
  attribute :marker, :string
  attribute :subitem, :string
  attribute :line_break, :string, default: -> { "\n" }

  attribute :attached,
            Coradoc::AsciiDoc::Model::Attached,
            polymorphic: [
              Coradoc::AsciiDoc::Model::Admonition,
              Coradoc::AsciiDoc::Model::Paragraph,
              Coradoc::AsciiDoc::Model::Block::Core
            ],
            collection: true,
            initialize_empty: true

  attribute :nested, Coradoc::AsciiDoc::Model::List::Nestable
end

#marker ⇒ String? (readonly)

Returns Custom list marker for this item.

Returns:

  • (String, nil) —

    Custom list marker for this item



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/coradoc/asciidoc/model/list/item.rb', line 43

class Item < Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :content,
            Coradoc::AsciiDoc::Model::Base,
            polymorphic: [
              Coradoc::AsciiDoc::Model::TextElement,
              Coradoc::AsciiDoc::Model::Section
            ]
  attribute :marker, :string
  attribute :subitem, :string
  attribute :line_break, :string, default: -> { "\n" }

  attribute :attached,
            Coradoc::AsciiDoc::Model::Attached,
            polymorphic: [
              Coradoc::AsciiDoc::Model::Admonition,
              Coradoc::AsciiDoc::Model::Paragraph,
              Coradoc::AsciiDoc::Model::Block::Core
            ],
            collection: true,
            initialize_empty: true

  attribute :nested, Coradoc::AsciiDoc::Model::List::Nestable
end

#nested ⇒ Coradoc::AsciiDoc::Model::List::Nestable? (readonly)

Returns Nested list.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/coradoc/asciidoc/model/list/item.rb', line 43

class Item < Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :content,
            Coradoc::AsciiDoc::Model::Base,
            polymorphic: [
              Coradoc::AsciiDoc::Model::TextElement,
              Coradoc::AsciiDoc::Model::Section
            ]
  attribute :marker, :string
  attribute :subitem, :string
  attribute :line_break, :string, default: -> { "\n" }

  attribute :attached,
            Coradoc::AsciiDoc::Model::Attached,
            polymorphic: [
              Coradoc::AsciiDoc::Model::Admonition,
              Coradoc::AsciiDoc::Model::Paragraph,
              Coradoc::AsciiDoc::Model::Block::Core
            ],
            collection: true,
            initialize_empty: true

  attribute :nested, Coradoc::AsciiDoc::Model::List::Nestable
end

#subitem ⇒ String? (readonly)

Returns Sub-item text.

Returns:

  • (String, nil) —

    Sub-item text



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/coradoc/asciidoc/model/list/item.rb', line 43

class Item < Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :content,
            Coradoc::AsciiDoc::Model::Base,
            polymorphic: [
              Coradoc::AsciiDoc::Model::TextElement,
              Coradoc::AsciiDoc::Model::Section
            ]
  attribute :marker, :string
  attribute :subitem, :string
  attribute :line_break, :string, default: -> { "\n" }

  attribute :attached,
            Coradoc::AsciiDoc::Model::Attached,
            polymorphic: [
              Coradoc::AsciiDoc::Model::Admonition,
              Coradoc::AsciiDoc::Model::Paragraph,
              Coradoc::AsciiDoc::Model::Block::Core
            ],
            collection: true,
            initialize_empty: true

  attribute :nested, Coradoc::AsciiDoc::Model::List::Nestable
end