class TaskJuggler::TableOfContents

This class can be used to store a table of contents. It’s just an Array of TOCEntry objects. Each TOCEntry objects represents the title of a section.

Public Class Methods

new() click to toggle source

Create an empty TableOfContents object.

# File lib/taskjuggler/RichText/TableOfContents.rb, line 24
def initialize
  @entries = []
end

Public Instance Methods

addEntry(entry) click to toggle source

This method must be used to add new TOCEntry objects to the TableOfContents. entry must be a TOCEntry object reference.

# File lib/taskjuggler/RichText/TableOfContents.rb, line 30
def addEntry(entry)
  @entries << entry
end

each() { |e| ... } click to toggle source

# File lib/taskjuggler/RichText/TableOfContents.rb, line 34
def each
  @entries.each { |e| yield e }
end

to_html() click to toggle source

Return HTML elements that represent the content of the TableOfContents object. The result is a tree of XMLElement objects.

# File lib/taskjuggler/RichText/TableOfContents.rb, line 40
def to_html
  div = XMLElement.new('div',
                       'style' => 'margin-left:15%; margin-right:15%;')
  div << (table = XMLElement.new('table'))
  @entries.each { |e| table << e.to_html }

  div
end