Class: TaskJuggler::RichTextFunctionHandler

Inherits:
Object
  • Object
show all
Includes:
MessageHandler
Defined in:
lib/taskjuggler/RichText/FunctionHandler.rb

Overview

This class is the abstract base class for all RichText function handlers. A function handler is responsible for a certain function such as ‘example’ or ‘query’. functions are used in internal RichText references such as ‘[[example:Allocation 2]]’. ‘example’ is the function, ‘Allocation’ is the path and ‘2’ is the first argument. Arguments are optional. The function handler can turn such internal references into Strings or XMLElement trees. Therefor, each derived handler needs to implement a to_s, to_html and to_tagged method that takes two parameter. The first is the path, the second is the argument Array.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MessageHandler

#critical, #debug, #error, #fatal, #info, #warning

Constructor Details

#initialize(function, sourceFileInfo = nil) ⇒ RichTextFunctionHandler

Returns a new instance of RichTextFunctionHandler.



33
34
35
36
37
 
# File 'lib/taskjuggler/RichText/FunctionHandler.rb', line 33

def initialize(function, sourceFileInfo = nil)
  @function = function
  @blockFunction = false
  @sourceFileInfo = sourceFileInfo
end

Instance Attribute Details

#blockFunction ⇒ Object (readonly)

Returns the value of attribute blockFunction.



31
32
33
 
# File 'lib/taskjuggler/RichText/FunctionHandler.rb', line 31

def blockFunction
  @blockFunction
end

#function ⇒ Object (readonly)

Returns the value of attribute function.



31
32
33
 
# File 'lib/taskjuggler/RichText/FunctionHandler.rb', line 31

def function
  @function
end