--- loncom/xml/lontable.pm 2008/12/23 11:49:32 1.6 +++ loncom/xml/lontable.pm 2010/08/11 10:57:36 1.11 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Generating TeX tables. # -# $Id: lontable.pm,v 1.6 2008/12/23 11:49:32 foxr Exp $ +# $Id: lontable.pm,v 1.11 2010/08/11 10:57:36 foxr Exp $ # # # Copyright Michigan State University Board of Trustees @@ -56,7 +56,9 @@ package Apache::lontable; use strict; use LaTeX::Table; +use Apache::lonnet; # for trace logging. +my $tracing = 0; # Set to 1 to enable log tracing. 2 for local sub tracing. =pod @@ -108,6 +110,7 @@ modified by this. These configuration i =over3 + =item alignment Table alignment. Some table styles support this but not all. @@ -132,6 +135,13 @@ to the LaTeX::Table package, and they wi not error checked. Any use of a non-existent theme is reported by the LaTeX::Table package when the table text is generated. +=item width + +The width of the table. in any +TeX unit measure e.g. 10.8cm This forces the table to the +tabularx environment. It also forces the declarations for +cells to be paragraph mode which supports more internal formatting. + =back =head3 Member data @@ -245,6 +255,8 @@ The contents of the cell. sub new { my ($class, $configuration) = @_; + if($tracing) {&Apache::lonnet::logthis("new table object");} + # Initialize the object member data with the default values # then override with any stuff in $configuration. @@ -253,7 +265,7 @@ sub new { outer_border => 0, inner_border => 0, caption => "", - theme => "Zurich", + theme => "plain", column_count => 0, row_open => 0, rows => [], @@ -291,6 +303,8 @@ Regardless, the current alignment is use sub alignment { my ($self, $new_value) = @_; + if ($tracing) {&Apache::lonnet::logthis("alignment = $new_value");} + if (defined($new_value)) { $self->{'alignment'} = $new_value; } @@ -316,6 +330,8 @@ the final value of the outer_border requ sub table_border { my ($self, $new_value) = @_; + if ($tracing) {&Apache::lonnet::logthis("table_border $new_value");} + if (defined($new_value)) { $self->{'outer_border'} = $new_value; } @@ -341,7 +357,7 @@ value of that configuration parameter is sub cell_border { my ($self, $new_value) = @_; - + if($tracing) {&Apache::lonnet::logthis("cell_border: $new_value"); } if (defined($new_value)) { $self->{'inner_border'} = $new_value; } @@ -366,6 +382,7 @@ the table. If a parameter is supplied i sub caption { my ($self, $new_value) = @_; + if($tracing) {&Apache::lonnet::logthis("caption: $new_value"); } if (defined($new_value)) { $self->{'caption'} = $new_value; } @@ -390,7 +407,7 @@ will be the new theme selection. sub theme { my ($self, $new_value) = @_; - + if($tracing) {&Apache::lonnet::logthis("theme $new_value"); } if (defined($new_value)) { $self->{'theme'} = $new_value; } @@ -399,6 +416,27 @@ sub theme { =pod +=head 2 width + +Gets and optionally sets the width of the table. + +=head 3 Examples: + + my $newwidth = $table->width("10cm"); # 10cm width returns "10cm". + +=cut +sub width { + my ($self, $new_value) = @_; + if($tracing) {&Apache::lonnet::logthis("width = $new_value"); } + + if (defined($new_value)) { + $self->{'width'} = $new_value; + } + return $self->{'width'}; # Could be undef. +} + +=pod + =head2 start_row Begins a new row in the table. If a row is already open, that row is @@ -427,7 +465,7 @@ The default vertical alignment of the ro sub start_row { my ($self, $config) = @_; - + if($tracing) {&Apache::lonnet::logthis("start_row"); } if ($self->{'row_open'}) { $self->end_row(); } @@ -468,7 +506,7 @@ Closes off a row. Once closed, cells ca sub end_row { my ($self) = @_; - + if($tracing) {&Apache::lonnet::logthis("end_row"); } if ($self->{'row_open'}) { # Mostly we need to determine if this row has the maximum @@ -516,7 +554,7 @@ The default vertical alignment for text sub configure_row { my ($self, $config) = @_; - + if($tracing) {&Apache::lonnet::logthis("configure_row");} if (!$self->{'row_open'}) { $self->start_row(); } @@ -574,6 +612,8 @@ Number of columns the cell spans. sub add_cell { my ($self, $text, $config) = @_; + if($tracing) {&Apache::lonnet::logthis("add_cell : $text"); } + # If a row is not open, we must open it: if (!$self->{'row_open'}) { @@ -600,6 +640,9 @@ sub add_cell { # end point of the pulled down cell. my $prior_cell = $last_row->{'cells'}->[$prior_cell_index]; + if (!defined($prior_cell)) { + last; + } if (($prior_cell->{'start_col'} == $last_coord) && ($prior_cell->{'rowspan'} > 1)) { @@ -639,8 +682,36 @@ sub add_cell { $current_row->{'cell_width'} += $cell->{'colspan'}; push(@$current_cells, $cell); + + if ($tracing) { &Apache::lonnet::logthis("add_cell done"); } } + +=pod + +=head2 append_cell_text + +Sometimes it's necessary to create/configure the cell and then later add text to it. +This sub allows text to be appended to the most recently created cell. + +=head3 Parameters + +The text to add to the cell. + +=cut +sub append_cell_text { + my ($this, $text) = @_; + + if($tracing) {&Apache::lonnet::logthis("append_cell_text: $text"); } + my $rows = $this->{'rows'}; + my $current_row = $rows->[-1]; + my $cells = $current_row->{'cells'}; + my $current_cell = $cells->[-1]; + $current_cell->{'contents'} .= $text; + +} + + =pod =head2 generate @@ -654,8 +725,33 @@ The caller can then ask the table object =cut sub generate { my ($this) = @_; + my $useP = 0; + my $colwidth; + my $colunits; + if($tracing) {&Apache::lonnet::logthis("generate"); } my $table = LaTeX::Table->new(); + $table->set_center(0); # loncapa tables don't float. + $table->set_environment(0); + $table->set_theme($this->{'theme'}); + + + # Add the caption if supplied. + + if ($this->{'caption'} ne "") { + $table->set_caption($this->caption); + } + + # Set the width if defined: + + if (defined ($this->{'width'})) { +# $table->set_width($this->{'width'}); +# $table->set_width_environment('tabularx'); + $useP = 1; + ($colwidth, $colunits) = split(/ /, $this->{'width'}); + $colwidth = $colwidth/$this->{'column_count'}; + + } # Build up the data: @@ -666,47 +762,131 @@ sub generate { my $outer_border = $this->{'outer_border'}; my $column_count = $this->{'column_count'}; + # Add a top line if the outer or inner border is enabled: + + if ($outer_border || $inner_border) { + push(@data, ["\\cline{1-$column_count}"]); + + } + for (my $row = 0; $row < $row_count; $row++) { my @row; my $cells = $rows->[$row]->{'cells'}; + my $def_halign = $rows->[$row]->{'default_halign'}; 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'}; + + # + # Cell alignment is the default alignment unless + # explicitly specified in the cell. + # NOTE: at this point I don't know how to do vert alignment. + # + + my $halign = $def_halign; + if (defined ($cells->[$cell]->{'halign'})) { + $halign = $cells->[$cell]->{'halign'}; + } + + # Create the horizontal alignment character: + + my $col_align = 'l'; + my $embeddedAlignStart = ""; + my $embeddedAlignEnd = ""; + + if ($halign eq 'right') { + $col_align = 'r'; + $embeddedAlignStart = '\begin{flushright} '; + $embeddedAlignEnd = ' \end{flushright}'; + } + if ($halign eq 'center') { + $col_align = 'c'; + $embeddedAlignStart = '\begin{center}'; + $embeddedAlignEnd = '\end{center}'; + } + + # If the width has been specified, turn these into + # para mode; and wrap the contents in the start/stop stuff: + + if ($useP) { + my $cw = $colwidth * $cells->[$cell]->{'colspan'}; + $col_align = "p{$cw $colunits}"; + $contents = $embeddedAlignStart . $contents . $embeddedAlignEnd; + } + + if ($inner_border || ($outer_border && ($cell == 0))) { + $col_align = '|'.$col_align; + } + if ($inner_border || ($outer_border && ($cell == ($cell_count -1)))) { + $col_align = $col_align.'|'; + } + + #factor in spans: + my $cspan = $cells->[$cell]->{'colspan'}; my $nextcol = $startcol + $cspan; - if ($cspan > 1) { - $contents = '\multicolumn{'.$cspan.'}{|l|}{'.$contents.'}'; + + # If we can avoid the \multicolumn directive that's best as + # that makes some things like \parpic invalid in LaTeX which + # screws everything up. + + if (($cspan > 1) || !($col_align =~ /l/)) { + + $contents = '\multicolumn{'.$cspan.'}{'.$col_align.'}{'.$contents.'}'; + + # A nasty edge case. If there's only one cell, the software will assume + # we're in complete control of the row so we need to end the row ourselves. + + if ($cell_count == 1) { + $contents .= ' \\\\'; + } } if ($inner_border && ($cells->[$cell]->{'rowspan'} == 1)) { + &Apache::lonnet::logthis("Pushing underlines $inner_border"); 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) { + &Apache::lonnet::logthis("Pushing underlines with inner_border"); for (my $i =0; $i < scalar(@underlines); $i++) { push(@data, [$underlines[$i]]); } } } + # + # Add bottom border if necessary: if the inner border was on, the loops above + # will have done a bottom line under the last cell. + # + if ($outer_border && !$inner_border) { + push(@data, ["\\cline{1-$column_count}"]); + + } $table->set_data(\@data); my $coldef = ""; if ($outer_border || $inner_border) { + &Apache::lonnet::logthis("adding | $outer_border : $inner_border"); $coldef .= '|'; } for (my $i =0; $i < $column_count; $i++) { - $coldef .= 'l'; + if ($useP) { + $coldef .= "p{$colwidth $colunits}"; + } else { + $coldef .= 'l'; + } if ($inner_border || ($outer_border && ($i == $column_count-1))) { $coldef .= '|'; @@ -716,6 +896,8 @@ sub generate { # Return the table: + if ($tracing) { &Apache::lonnet::logthis("Leaving generate"); } + return $table; } @@ -725,11 +907,14 @@ sub generate { sub get_object_attribute { my ($self, $attribute) = @_; + if ($tracing > 1) { &Apache::lonnet::logthis("get_object_attribute: $attribute"); } return $self->{$attribute}; } sub get_row { my ($self, $row) = @_; + if ($tracing > 1) { &Apache::lonnet::logthis("get_row"); } + my $rows = $self->{'rows'}; # ref to an array.... return $rows->[$row]; # ref to the row hash for the selected row. }