--- loncom/xml/lontable.pm 2008/12/02 11:57:25 1.4
+++ loncom/xml/lontable.pm 2008/12/23 11:49:32 1.6
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Generating TeX tables.
#
-# $Id: lontable.pm,v 1.4 2008/12/02 11:57:25 foxr Exp $
+# $Id: lontable.pm,v 1.6 2008/12/23 11:49:32 foxr Exp $
#
#
# Copyright Michigan State University Board of Trustees
@@ -39,7 +39,7 @@
# This module is a support packkage that helps londefdef generate
# LaTeX tables using the LaTeX::Table package. A prerequisite is that
-# the print generator must have added the following to the LaTeX header:
+# the print generator must have added the following to the LaTeX
#
# \usepackage{xtab}
# \usepackage{booktabs}
@@ -164,6 +164,11 @@ Table caption (configurable).
Theme desired (configurable).
+=item width
+
+If defined, the width of the table (should be supplied
+in fraction of column width e.g. .75 for 75%.
+
=item row_open
True if a row is open and not yet closed.
@@ -189,6 +194,11 @@ Default horizontal alignment for cells i
Default vertical alignment for cells in this row (may be ignored).
+=item cell_width
+
+The width of the row in cells. This is the sum of the column spans
+of the cells in the row.
+
=item cells
Array of hashes where each element represents the data for a cell.
@@ -218,6 +228,10 @@ If present, indicates the number of rows
If present indicates the number of columns this cell spans.
Note that a cell can span both rows and columns.
+=item start_col
+
+The starting column of the cell in the table grid.
+
=item contents
The contents of the cell.
@@ -278,9 +292,9 @@ sub alignment {
my ($self, $new_value) = @_;
if (defined($new_value)) {
- $self->{alignment} = $new_value;
+ $self->{'alignment'} = $new_value;
}
- return $self->{alignment};
+ return $self->{'alignment'};
}
=pod
@@ -303,9 +317,9 @@ sub table_border {
my ($self, $new_value) = @_;
if (defined($new_value)) {
- $self->{outer_border} = $new_value;
+ $self->{'outer_border'} = $new_value;
}
- return $self->{outer_border};
+ return $self->{'outer_border'};
}
@@ -329,9 +343,9 @@ sub cell_border {
my ($self, $new_value) = @_;
if (defined($new_value)) {
- $self->{inner_border} = $new_value;
+ $self->{'inner_border'} = $new_value;
}
- return $self->{inner_border};
+ return $self->{'inner_border'};
}
=pod
@@ -353,10 +367,10 @@ sub caption {
my ($self, $new_value) = @_;
if (defined($new_value)) {
- $self->{caption} = $new_value;
+ $self->{'caption'} = $new_value;
}
- return $self->{caption};
+ return $self->{'caption'};
}
=pod
@@ -378,9 +392,9 @@ sub theme {
my ($self, $new_value) = @_;
if (defined($new_value)) {
- $self->{theme} = $new_value;
+ $self->{'theme'} = $new_value;
}
- return $self->{theme};
+ return $self->{'theme'};
}
=pod
@@ -412,29 +426,31 @@ The default vertical alignment of the ro
=cut
sub start_row {
- my ($self, %config) = @_;
+ my ($self, $config) = @_;
- if ($self->{row_open}) {
+ if ($self->{'row_open'}) {
$self->end_row();
}
my $row_hash = {
default_halign => "left",
default_valign => "top",
+ cell_width => 0,
cells => []
};
# Override the defaults if the config hash is present:
- if (defined(%config)) {
- foreach my $key (keys %config) {
- $row_hash->{$key} = $config{$key};
+ if (defined($config)) {
+ foreach my $key (keys %$config) {
+ $row_hash->{$key} = $config->{$key};
}
}
+
- my $rows = $self->{rows};
+ my $rows = $self->{'rows'};
push(@$rows, $row_hash);
- $self->{row_open} = 1; # Row is now open and ready for business.
+ $self->{"row_open"} = 1; # Row is now open and ready for business.
}
=pod
@@ -453,27 +469,19 @@ Closes off a row. Once closed, cells ca
sub end_row {
my ($self) = @_;
- if ($self->{row_open}) {
+ if ($self->{'row_open'}) {
# Mostly we need to determine if this row has the maximum
# cell count of any row in existence in the table:
- my $row = $self->{rows}[-1];
- my $cells = $row->{cells};
- my $raw_cell_count = scalar(@$cells);
-
- # Need to iterate through the columns as
- # colspans affect the count:
- #
- my $cell_count = 0;
- for (my $i =0; $i < $raw_cell_count; $i++) {
- $cell_count = $cell_count + $cells->[$i]->{colspan};
- }
- if ($cell_count > $self->{column_count}) {
- $self->{column_count} = $cell_count;
+ my $row = $self->{'rows'}->[-1];
+ my $cells = $row->{'cells'};
+
+ if ($row->{'cell_width'} > $self->{'column_count'}) {
+ $self->{'column_count'} = $row->{'cell_width'};
}
- $self->{row_open} = 0;;
+ $self->{'row_open'} = 0;;
}
}
@@ -509,11 +517,11 @@ The default vertical alignment for text
sub configure_row {
my ($self, $config) = @_;
- if (!$self->{row_open}) {
+ if (!$self->{'row_open'}) {
$self->start_row();
}
- my $row = $self->{rows}[-1];
+ my $row = $self->{'rows'}[-1];
foreach my $config_item (keys %$config) {
$row->{$config_item} = $config->{$config_item};
}
@@ -568,40 +576,58 @@ sub add_cell {
# If a row is not open, we must open it:
- if (!$self->{row_open}) {
+ if (!$self->{'row_open'}) {
$self->start_row();
}
-
- my $current_row = $self->{rows}->[-1];
- my $current_cells = $current_row->{cells};
-
- # The way we handle row spans is to insert additional
- # blank cells as needed to reach this column. Each
- # cell that is inserted is empty, but has a row span decreased by one
- # from the row above. Column spans are propagated down from the row above
- # and handled when the table's LaTeX is generated.
- # There must be at least two rows in the row table to need to do this:
-
- my $row_count = scalar(@$self->{rows});
- if ($row_count > 1) {
- my $prior_row = $self->{rows}->[-2];
- my $curr_colcount = scaler(@$current_row->{cells});
- my $prior_colcount = scaler(@$prior_row->{cells});
-
- while (($curr_colcount < $prior_colcount) &&
- $prior_row->{cells}->[$curr_colcount]->{rowspan} > 1) {
- my %cell = $prior_row->{cells}->[$curr_colcount];
- %cell->{rowspan}--;
- %cell->{contents} = "";
- push(@$current_cells, \%cell);
+ my $rows = $self->{'rows'};
+ my $current_row = $rows->[-1];
+ my $current_cells = $current_row->{'cells'};
+ my $last_coord = $current_row->{'cell_width'};
+
+ # We have to worry about row spans if there is a prior row:
+
+ if (scalar(@$rows) > 1) {
+
+ my $last_row = $rows->[-2];
+ if ($last_coord < $last_row->{'cell_width'}) {
+ my $prior_coord = 0;
+ my $prior_cell_index = 0;
+ while ($prior_coord <= $last_coord) {
+
+ # Pull a cell down if it's coord matches our start coord
+ # And there's a row span > 1.
+ # Having done so, we adjust our $last_coord to match the
+ # end point of the pulled down cell.
+
+ my $prior_cell = $last_row->{'cells'}->[$prior_cell_index];
+ if (($prior_cell->{'start_col'} == $last_coord) &&
+ ($prior_cell->{'rowspan'} > 1)) {
+
+ # Need to drop the cell down
+
+ my %dropped_down_cell = %$prior_cell;
+ $dropped_down_cell{'rowspan'}--;
+ $dropped_down_cell{'contents'} = '';
+
+ push(@$current_cells, \%dropped_down_cell);
+ $last_coord += $dropped_down_cell{'colspan'};
+ $current_row->{'cell_width'} = $last_coord;
+
+ }
+ $prior_coord += $prior_cell->{'colspan'};
+ $prior_cell_index++;
+ }
}
+
}
+
#
# Now we're ready to build up our cell:
my $cell = {
rowspan => 1,
colspan => 1,
+ start_col => $last_coord,
contents => $text
};
@@ -610,10 +636,91 @@ sub add_cell {
$cell->{$key} = $config->{$key};
}
}
+ $current_row->{'cell_width'} += $cell->{'colspan'};
+
push(@$current_cells, $cell);
}
-# The following method allows for testability.
+=pod
+
+=head2 generate
+
+Call this when the structures for the table have been built.
+This will generate and return the table object that can be used
+to generate the table. Returning the table object allows for
+a certain amount of testing to be done on the generated table.
+The caller can then ask the table object to generate LaTeX.
+
+=cut
+sub generate {
+ my ($this) = @_;
+
+ my $table = LaTeX::Table->new();
+
+ # Build up the data:
+
+ my @data;
+ my $rows = $this->{'rows'};
+ my $row_count = scalar(@$rows);
+ my $inner_border = $this->{'inner_border'};
+ my $outer_border = $this->{'outer_border'};
+ my $column_count = $this->{'column_count'};
+
+ for (my $row = 0; $row < $row_count; $row++) {
+ my @row;
+ my $cells = $rows->[$row]->{'cells'};
+ my $cell_count = scalar(@$cells);
+ my $startcol = 1;
+ my @underlines; # Array of \cline cells if cellborder on.
+
+ for (my $cell = 0; $cell < $cell_count; $cell++) {
+ my $contents = $cells->[$cell]->{'contents'};
+ my $cspan = $cells->[$cell]->{'colspan'};
+ my $nextcol = $startcol + $cspan;
+ if ($cspan > 1) {
+ $contents = '\multicolumn{'.$cspan.'}{|l|}{'.$contents.'}';
+ }
+ if ($inner_border && ($cells->[$cell]->{'rowspan'} == 1)) {
+ my $lastcol = $nextcol -1;
+ push(@underlines, "\\cline{$startcol-$lastcol}");
+ }
+ $startcol = $nextcol;
+ # Rowspans should take care of themselves.
+
+
+ push(@row, $contents);
+
+ }
+ push(@data, \@row);
+ if ($inner_border) {
+ for (my $i =0; $i < scalar(@underlines); $i++) {
+ push(@data, [$underlines[$i]]);
+ }
+ }
+
+ }
+ $table->set_data(\@data);
+
+ my $coldef = "";
+ if ($outer_border || $inner_border) {
+ $coldef .= '|';
+ }
+ for (my $i =0; $i < $column_count; $i++) {
+ $coldef .= 'l';
+ if ($inner_border ||
+ ($outer_border && ($i == $column_count-1))) {
+ $coldef .= '|';
+ }
+ }
+ $table->{'coldef'} = $coldef;
+
+ # Return the table:
+
+ return $table;
+
+}
+#----------------------------------------------------------------------------
+# The following methods allow for testability.
sub get_object_attribute {
@@ -621,7 +728,11 @@ sub get_object_attribute {
return $self->{$attribute};
}
-
+sub get_row {
+ my ($self, $row) = @_;
+ my $rows = $self->{'rows'}; # ref to an array....
+ return $rows->[$row]; # ref to the row hash for the selected row.
+}
# Mandatory initialization.
BEGIN{
}