Class Index [+]

Quicksearch

TaskJuggler::RTFNavigator

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

Public Class Methods

new(project, sourceFileInfo = nil) click to toggle source
    # File lib/RTFNavigator.rb, line 25
25:     def initialize(project, sourceFileInfo = nil)
26:       @project = project
27:       super(project.messageHandler, 'navigator', sourceFileInfo)
28:       @blockFunction = true
29:     end

Public Instance Methods

to_html(args) click to toggle source

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

    # File lib/RTFNavigator.rb, line 37
37:     def to_html(args)
38:       if args.nil? || (id = args['id']).nil?
39:         error('rtf_nav_id_missing',
40:               "Argument 'id' missing to specify the navigator to be used.")
41:       end
42:       unless (navBar = @project['navigators'][id])
43:         error('rtf_nav_unknown_id', "Unknown navigator #{id}")
44:       end
45:       navBar.to_html
46:     end
to_s(args) click to toggle source

Not supported for this function

    # File lib/RTFNavigator.rb, line 32
32:     def to_s(args)
33:       ''
34:     end
to_tagged(args) click to toggle source

Not supported for this function.

    # File lib/RTFNavigator.rb, line 49
49:     def to_tagged(args)
50:       nil
51:     end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.