TaskJuggler::ReportTableColumn

The ReportTableColumn class models the output format independend column of a ReportTable. It usually just contains the table header description. The table header comprises of one or two lines per column. So each column header consists of 2 cells. @cell1 is the top cell and must be present. @cell2 is the optional bottom cell. If @cell2 is hidden, @cell1 takes all the vertical space.

For some columns, the table does not contain the usual grid lines but another abstract object that responds to the usual generator methods such as to_html(). In such a case, @cell1 references the embedded object via its special variable. The embedded object then replaced the complete column content.

Attributes

definition[R]

cell1[R]

cell2[R]

scrollbar[RW]

Public Class Methods

new(table, definition, title) click to toggle source

Create a new column. table is a reference to the ReportTable this column belongs to. definition is the TableColumnDefinition of the column from the project definition. title is the text that is used for the column header.

    # File lib/reports/ReportTableColumn.rb, line 36
36:     def initialize(table, definition, title)
37:       @table = table
38:       # Register this new column with the ReportTable.
39:       @table.addColumn(self)
40:       @definition = definition
41:       # Register this new column with the TableColumnDefinition.
42:       definition.column = self if definition
43: 
44:       # Create the 2 cells of the header.
45:       @cell1 = ReportTableCell.new(nil, nil, title, true)
46:       @cell1.padding = 5
47:       @cell2 = ReportTableCell.new(nil, nil, '', true)
48:       # Header text is always bold.
49:       @cell1.bold = @cell2.bold = true
50:       # This variable is set to true if the column requires a scrollbar later
51:       # on.
52:       @scrollbar = false
53:     end

Public Instance Methods

minWidth() click to toggle source

Return the mininum required width for the column.

    # File lib/reports/ReportTableColumn.rb, line 56
56:     def minWidth
57:       width = @cell1.width
58:       width = @cell2.width if width.nil? || @cell2.width > width
59:       width
60:     end

to_csv(csv) click to toggle source

Put the abstract representation into an Array. csv is an Array of Arrays of Strings. We have an Array with Strings for every cell. The outer Array holds the Arrays representing the lines.

    # File lib/reports/ReportTableColumn.rb, line 74
74:     def to_csv(csv)
75:       # For CSV reports we can only include the first header line.
76:       @cell1.to_csv(csv)
77:     end

to_html(row) click to toggle source

Convert the abstract representation into HTML elements.

    # File lib/reports/ReportTableColumn.rb, line 63
63:     def to_html(row)
64:       if row == 1
65:         @cell1.to_html
66:       else
67:         @cell2.to_html
68:       end
69:     end

Home Classes Methods

In Files

Parent

Methods

Files

Class Index

TaskJuggler::ReportTableColumn

Attributes

Public Class Methods

Public Instance Methods