Class TaskJuggler::RTFNavigator
In: lib/taskjuggler/RichText/RTFNavigator.rb
Parent: RichTextFunctionHandler

This class is a specialized RichTextFunctionHandler that generates a navigation bar for all reports that match the specified LogicalExpression. It currently only supports HTML.

Methods

new   to_html   to_s   to_tagged  

Public Class methods

new(project, sourceFileInfo = nil)

[Source]

# File lib/taskjuggler/RichText/RTFNavigator.rb, line 25
    def initialize(project, sourceFileInfo = nil)
      @project = project
      super('navigator', sourceFileInfo)
      @blockFunction = true
    end

Public Instance methods

to_html(args)

Return a XMLElement tree that represents the navigator in HTML code.

[Source]

# File lib/taskjuggler/RichText/RTFNavigator.rb, line 37
    def to_html(args)
      if args.nil? || (id = args['id']).nil?
        error('rtf_nav_id_missing',
              "Argument 'id' missing to specify the navigator to be used.")
      end
      unless (navBar = @project['navigators'][id])
        error('rtf_nav_unknown_id', "Unknown navigator #{id}")
      end
      navBar.to_html
    end
to_s(args)

Not supported for this function

[Source]

# File lib/taskjuggler/RichText/RTFNavigator.rb, line 32
    def to_s(args)
      ''
    end
to_tagged(args)

Not supported for this function.

[Source]

# File lib/taskjuggler/RichText/RTFNavigator.rb, line 49
    def to_tagged(args)
      nil
    end

[Validate]