Class: RTF::ListLevelNode

Inherits:
CommandNode show all
Defined in:
lib/rtf/node.rb

Overview

This class represents a list level, and carries out indenting information and the bullet or number that is prepended to each ListTextNode.

The class overrides the list method to implement nesting, and provides the item method to add a new list item, the ListTextNode.

Instance Attribute Summary collapse

Attributes inherited from CommandNode

#prefix, #split, #suffix, #wrap

Attributes inherited from ContainerNode

#children

Attributes inherited from Node

#parent

Instance Method Summary collapse

Methods inherited from CommandNode

#<<, #apply, #background, #bold, #colour, #font, #footnote, #foreground, #image, #italic, #line_break, #link, #paragraph, #strike, #subscript, #superscript, #table, #to_rtf, #underline

Methods inherited from ContainerNode

#[], #each, #first, #last, #size, #store, #to_rtf

Methods inherited from Node

#is_root?, #next_node, #previous_node, #root

Constructor Details

#initialize(parent, template, kind, level = 1) ⇒ ListLevelNode

Returns a new instance of ListLevelNode.



629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/rtf/node.rb', line 629

def initialize(parent, template, kind, level=1)
  @template = template
  @kind     = kind
  @level    = template.level_for(level, kind)

  prefix  = '\pard'
  prefix << @level.tabs.map {|tw| "\\tx#{tw}"}.join
  prefix << "\\li#{@level.indent}\\fi-#{@level.indent}"
  prefix << "\\ql\\qlnatural\\pardirnatural\n"
  prefix << "\\ls#{@template.id}\\ilvl#{@level.level-1}\\cf0"

  super(parent, prefix, nil, true, false)
end

Instance Attribute Details

#kind ⇒ Object (readonly)

Returns the kind of this level, either :bullets or :decimal



644
645
646
 
# File 'lib/rtf/node.rb', line 644

def kind
  @kind
end

Instance Method Details

#item {|node| ... } ⇒ Object

Creates a new ListTextNode and yields it to the calling block

Yields:

  • (node) 


652
653
654
655
656
 
# File 'lib/rtf/node.rb', line 652

def item
  node = ListTextNode.new(self, @level)
  yield node
  self.store(node)
end

#level ⇒ Object

Returns the indenting level of this list, from 1 to 9



647
648
649
 
# File 'lib/rtf/node.rb', line 647

def level
  @level.level
end

#list(kind = @kind) {|node| ... } ⇒ Object

Creates a new ListLevelNode to implement nested lists

Yields:

  • (node) 


659
660
661
662
663
 
# File 'lib/rtf/node.rb', line 659

def list(kind=@kind)
  node = ListLevelNode.new(self, @template, kind, @level.level+1)
  yield node
  self.store(node)
end