--- loncom/xml/lontable.pm 2008/12/23 11:49:32 1.6 +++ loncom/xml/lontable.pm 2011/04/13 10:08:06 1.17 @@ -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.17 2011/04/13 10:08:06 foxr Exp $ # # # Copyright Michigan State University Board of Trustees @@ -38,7 +38,7 @@ # # This module is a support packkage that helps londefdef generate -# LaTeX tables using the LaTeX::Table package. A prerequisite is that +# LaTeX tables using the Apache::lonlatextable package. A prerequisite is that # the print generator must have added the following to the LaTeX # # \usepackage{xtab} @@ -55,15 +55,18 @@ package Apache::lontable; use strict; -use LaTeX::Table; +use Apache::lonlatextable; +use Apache::lonnet; # for trace logging. +use Data::Dumper; +my $tracing = 1; # Set to 1 to enable log tracing. 2 for local sub tracing. =pod =head1 lontable Table generation assistant for the LaTeX target This module contains support software for generating tables in LaTeX output mode -In this implementation, we use the LaTeX::Table package to do the actual final formatting. +In this implementation, we use the Apache::lonlatextable package to do the actual final formatting. Each table creates a new object. Table objects can have global properties configured. The main operations on a table object are: @@ -106,7 +109,8 @@ modified by this. These configuration i my $table = lontable::new(\%config_hash) -=over3 +=over 3 + =item alignment @@ -128,10 +132,17 @@ The table caption text. The theme of the table to use. Defaults to Zurich. Themes we know about are: NYC, NYC2, Zurich, Berlin, Dresden, Houston, Miami, plain, Paris. Other themes can be added -to the LaTeX::Table package, and they will become supported automatically, as theme names are -not error checked. Any use of a non-existent theme is reported by the LaTeX::Table package +to the Apache::lonlatextable package, and they will become supported automatically, as theme names are +not error checked. Any use of a non-existent theme is reported by the Apache::lonlatextable 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 @@ -201,11 +212,10 @@ of the cells in the row. =item cells + Array of hashes where each element represents the data for a cell. The contents of each element of this hash are described below: -=over 3 - =item header If present, the row is a 'header' that is it was made via the @@ -238,13 +248,13 @@ The contents of the cell. =back -=back =cut sub new { my ($class, $configuration) = @_; + if ($tracing) {&Apache::lonnet::logthis("new table"); } # Initialize the object member data with the default values # then override with any stuff in $configuration. @@ -253,10 +263,17 @@ sub new { outer_border => 0, inner_border => 0, caption => "", - theme => "Zurich", + theme => "plain", column_count => 0, row_open => 0, - rows => [], + rows => { + 'body' => [], + 'head' => [], + 'foot' => [] + }, + col_widths => {}, + part => 'body' # one of 'body', 'head', 'foot'. + }; foreach my $key (keys %$configuration) { @@ -291,6 +308,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 +335,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; } @@ -331,6 +352,22 @@ Set or get the presence of a request for drawn around them. If a paramter is passed, it will be treated as a new value for the cell border configuration. Regardless,the final value of that configuration parameter is returned. +Valid values for the parameter are: + +=over 2 + +=item 0 - no borders present. + +=item 1 - All borders (borders around all four sides of the cell. + +=item 2 - Border at top and bottom of the cell. + +=item 3 - Border at the left and right sides of the cell. + +=item 4 - Border around groups (colgroups as well as thead/tfoot/tbody). + + +=back =head3 Examples: @@ -341,7 +378,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 +403,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 +428,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 +437,27 @@ sub theme { =pod +=head2 width + +Gets and optionally sets the width of the table. + +=head3 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 +486,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(); } @@ -447,7 +506,7 @@ sub start_row { } - my $rows = $self->{'rows'}; + my $rows = $self->{'rows'}->{$self->{'part'}}; push(@$rows, $row_hash); $self->{"row_open"} = 1; # Row is now open and ready for business. @@ -468,13 +527,15 @@ 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 # cell count of any row in existence in the table: - - my $row = $self->{'rows'}->[-1]; + + &Apache::lonnet::logthis($self->{'part'}); + &Apache::lonnet::logthis(Dumper($self->{'rows'})); + my $row = $self->{'rows'}->{$self->{'part'}}->[-1]; my $cells = $row->{'cells'}; if ($row->{'cell_width'} > $self->{'column_count'}) { @@ -510,18 +571,19 @@ The default vertical alignment for text "top", "bottom" or "center" + =back =cut sub configure_row { my ($self, $config) = @_; - + if($tracing) {&Apache::lonnet::logthis("configure_row");} if (!$self->{'row_open'}) { $self->start_row(); } - my $row = $self->{'rows'}[-1]; + my $row = $self->{'rows'}->{$self->{'part'}}->[-1]; foreach my $config_item (keys %$config) { $row->{$config_item} = $config->{$config_item}; } @@ -567,19 +629,30 @@ Number of rows the cell spans. Number of columns the cell spans. +=item width + +LaTeX specification of the width of the cell. +Note that if there is a colspan this width is going to be equally divided +over the widths of the columnsn in the span. +Note as well that if width specification conflict, the last one specified wins...silently. + =back +=back + =cut 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'}) { $self->start_row(); } - my $rows = $self->{'rows'}; + my $rows = $self->{'rows'}->{$self->{'part'}}; my $current_row = $rows->[-1]; my $current_cells = $current_row->{'cells'}; my $last_coord = $current_row->{'cell_width'}; @@ -600,6 +673,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)) { @@ -633,16 +709,237 @@ sub add_cell { if (defined($config)) { foreach my $key (keys(%$config)) { + if ($key eq 'colspan') { + next if ($config->{$key} == 0); + } $cell->{$key} = $config->{$key}; } } + $current_row->{'cell_width'} += $cell->{'colspan'}; + + # + # Process the width if it exists. If supplied it must be of the form: + # float units + # Where units can be in, cm or mm. + # Regardless of the supplied units we will normalize to cm. + # This allows computation on units at final table generation time. + # + + if (exists($cell->{'width'})) { + my $width; + my $widthcm; + $width = $config->{'width'}; + $widthcm = $self->size_to_cm($width); + + # If there's a column span, the actual width is divided by the span + # and applied to each of the columns in the span. + + $widthcm = $widthcm / $cell->{'colspan'}; + for (my $i = $last_coord; $i < $last_coord + $cell->{'colspan'}; $i++) { + $self->{'col_widths'}->{$i} = $widthcm; + } + + } + 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'}->{$this->{'part'}}; + my $current_row = $rows->[-1]; + my $cells = $current_row->{'cells'}; + my $current_cell = $cells->[-1]; + $current_cell->{'contents'} .= $text; + +} +#-------------------------- Support for row/column groups. ---- + +=pod + +=head2 start_head + +starts the table head. This corresponds to the tag in +html/xml. All rows defined in this group will be +collected and placed at the front of the table come rendering time. +Furthermore, if the table has group borders enabled, a rule will be +rendered following and preceding this group of rows. + +=cut + +sub start_head { + my ($this) = @_; + if ($tracing) { &Apache::lonnet::logthis("start_head"); } + $this->{'part'} = 'head'; +} + +=pod + +=head2 end_head + +Ends a table head. This corresponds to the + closing tag in html/xml. + +=cut + +sub end_head { + my ($this) = @_; + if ($tracing) { &Apache::lonnet::logthis("end_head"); } + $this->{'part'} = 'body'; } =pod +=head2 start_foot + +Starts the table footer. All of the rows generated in the footer will +be rendered at the bottom of the table. This sub corresponds to the +
tag in html/xml. If the table has group borders enabled, a rule +will be rendered at the top and bottom of the set of columns in this +group + +=cut + +sub start_foot { + my ($this) = @_; + if ($tracing) { &Apache::lonnet::logthis("start_foot"); } + $this->{'part'} = 'foot'; +} + +=pod + +=head2 end_foot + +Ends the set of rows in the table footer. This corresponds to the + end tag in xml/html. + +=cut + +sub end_foot { + my ($this) = @_; + if ($tracing) { &Apache::lonnet::logthis("end_foot") } + $this->{'part'} = 'body'; +} + +=pod + +=head2 start_body + +Starts the set of rows that will be in the table body. Note that if +we are not in the header or footer, body rows are implied. +This correspondes to the presence of a tag in html/xml. +If group borders are on, a rule will be rendered at the top and bottom +of the body rows. + +=cut + +sub start_body { + my ($this) = @_; + if ($tracing) { &Apache::lonnet::logthis("start_body"); } + $this->{'part'} = 'body'; +} + +=pod + +=head2 end_body + +Ends the set of rows in a table body. Note that in the event we are not +in the header or footer groups this code assumes we are in the body +group. I believe this is a good match to how mot browsers render. + +=cut + +sub end_body { + my ($this) = @_; + if ($tracing) { &Apache::lonnet::logthis("end_body"); } + +} + +=pod + +=head2 define_colgroup + +Define a column group a column group corresponds to the +