-package PDF::Table;
+#!/usr/bin/env perl
+# vim: softtabstop=4 tabstop=4 shiftwidth=4 ft=perl expandtab smarttab
use 5.006;
use strict;
use warnings;
-our $VERSION = '0.9.3';
+package PDF::Table;
+
+use Carp;
use List::Util qw(sum);
+our $VERSION = '0.10.1';
+
+print __PACKAGE__.' is version: '.$VERSION.$/ if($ENV{'PDF_TABLE_DEBUG'});
+
############################################################
#
# new - Constructor
#
############################################################
-sub new {
- my ($type) = @_;
+sub new
+{
+ my $type = shift(@_);
+ my $class = ref($type) || $type;
+ my $self = {};
+ bless ($self, $class);
+
+ # Pass all the rest to init for validation and initialisation
+ $self->_init(@_);
+
+ return $self;
+}
+
+sub _init
+{
+ my ($self, $pdf, $page, $data, %options ) = @_;
+
+ # Check and set default values
+ $self->set_defaults();
+
+ # Check and set mandatory params
+ $self->set_pdf($pdf);
+ $self->set_page($page);
+ $self->set_data($data);
+ $self->set_options(\%options);
+
+ return;
+}
+
+sub set_defaults{
+ my $self = shift;
+
+ $self->{'font_size'} = 12;
+}
+
+sub set_pdf{
+ my ($self, $pdf) = @_;
+ $self->{'pdf'} = $pdf;
+}
+
+sub set_page{
+ my ($self, $page) = @_;
+ if ( defined($page) && ref($page) ne 'PDF::API2::Page' ){
- my $class = ref($type) || $type;
- my $self = {};
- bless ($self, $class);
- return $self;
+ if( ref($self->{'pdf'}) eq 'PDF::API2' ){
+ $self->{'page'} = $self->{'pdf'}->page();
+ } else {
+ carp 'Warning: Page must be a PDF::API2::Page object but it seems to be: '.ref($page).$/;
+ carp 'Error: Cannot set page from passed PDF object either as it is invalid!'.$/;
+ }
+ return;
+ }
+ $self->{'page'} = $page;
+
+}
+
+sub set_data{
+ my ($self, $data) = @_;
+ #TODO: implement
+}
+
+sub set_options{
+ my ($self, $options) = @_;
+ #TODO: implement
}
############################################################
#
############################################################
-sub text_block {
- my $self = shift;
- my $text_object = shift;
- my $text = shift; # The text to be displayed
- my %arg = @_; # Additional Arguments
-
- my ($align, $xpos, $ypos, $xbase, $ybase, $line_width, $wordspace, $endw , $width, $height)
- = (undef , undef, undef, undef , undef , undef , undef , undef , undef , undef );
- my @line = (); # Temp data array with words on one line
- my %width = (); # The width of every unique word in the givven text
-
- # Try to provide backward compatibility
- foreach my $key (keys %arg) {
- my $newkey = $key;
- if ($newkey =~ s#^-##) {
- $arg{$newkey} = $arg{$key};
- delete $arg{$key};
+sub text_block
+{
+ my $self = shift;
+ my $text_object = shift;
+ my $text = shift; # The text to be displayed
+ my %arg = @_; # Additional Arguments
+
+ my ( $align, $xpos, $ypos, $xbase, $ybase, $line_width, $wordspace, $endw , $width, $height) =
+ ( undef , undef, undef, undef , undef , undef , undef , undef , undef , undef );
+ my @line = (); # Temp data array with words on one line
+ my %width = (); # The width of every unique word in the givven text
+
+ # Try to provide backward compatibility
+ foreach my $key (keys %arg)
+ {
+ my $newkey = $key;
+ if($newkey =~ s#^-##)
+ {
+ $arg{$newkey} = $arg{$key};
+ delete $arg{$key};
+ }
}
- }
- #####
-
- #---
- # Lets check mandatory parameters with no default values
- #---
- $xbase = $arg{'x'} || -1;
- $ybase = $arg{'y'} || -1;
- $width = $arg{'w'} || -1;
- $height = $arg{'h'} || -1;
- unless ( $xbase > 0 ) { print "Error: Left Edge of Block is NOT defined!\n"; return; }
- unless ( $ybase > 0 ) { print "Error: Base Line of Block is NOT defined!\n"; return; }
- unless ( $width > 0 ) { print "Error: Width of Block is NOT defined!\n"; return; }
- unless ( $height > 0 ) { print "Error: Height of Block is NOT defined!\n"; return; }
- # Check if any text to display
- unless ( defined( $text) and length($text) > 0 ) {
- print "Warning: No input text found. Trying to add dummy '-' and not to break everything.\n";
- $text = '-';
- }
-
- # Strip any <CR> and Split the text into paragraphs
- $text =~ s/\r//g;
- my @paragraphs = split(/\n/, $text);
-
- # Width between lines in pixels
- my $line_space = defined $arg{'lead'} && $arg{'lead'} > 0 ? $arg{'lead'} : 12;
-
- # Calculate width of all words
- my $space_width = $text_object->advancewidth("\x20");
- my @words = split(/\s+/, $text);
- foreach (@words) {
- next if exists $width{$_};
- $width{$_} = $text_object->advancewidth($_);
- }
-
- my @paragraph = split(' ', shift(@paragraphs));
- my $first_line = 1;
- my $first_paragraph = 1;
-
- # Little Init
- $xpos = $xbase;
- $ypos = $ybase;
- $ypos = $ybase + $line_space;
- my $bottom_border = $ybase - $height;
- # While we can add another line
- while ( $ypos >= $bottom_border + $line_space ) {
- # Is there any text to render ?
- unless (@paragraph) {
- # Finish if nothing left
- last unless scalar @paragraphs;
- # Else take one line from the text
- @paragraph = split(' ', shift( @paragraphs ) );
-
- $ypos -= $arg{'parspace'} if $arg{'parspace'};
- last unless $ypos >= $bottom_border;
+ #####
+
+ #---
+ # Lets check mandatory parameters with no default values
+ #---
+ $xbase = $arg{'x'} || -1;
+ $ybase = $arg{'y'} || -1;
+ $width = $arg{'w'} || -1;
+ $height = $arg{'h'} || -1;
+ unless( $xbase > 0 ){ carp "Error: Left Edge of Block is NOT defined!\n"; return; }
+ unless( $ybase > 0 ){ carp "Error: Base Line of Block is NOT defined!\n"; return; }
+ unless( $width > 0 ){ carp "Error: Width of Block is NOT defined!\n"; return; }
+ unless( $height > 0 ){ carp "Error: Height of Block is NOT defined!\n"; return; }
+ # Check if any text to display
+ unless( defined( $text) and length($text) > 0 )
+ {
+# carp "Warning: No input text found. Trying to add dummy '-' and not to break everything.\n";
+ $text = ' ';
}
- $ypos -= $line_space;
- $xpos = $xbase;
- # While there's room on the line, add another word
- @line = ();
- $line_width = 0;
- if ( $first_line && exists $arg{'hang'} ) {
- my $hang_width = $text_object->advancewidth($arg{'hang'});
+ # Strip any <CR> and Split the text into paragraphs
+ $text =~ s/\r//g;
+ my @paragraphs = split(/\n/, $text);
- $text_object->translate( $xpos, $ypos );
- $text_object->text( $arg{'hang'} );
+ # Width between lines in pixels
+ my $line_space = defined $arg{'lead'} && $arg{'lead'} > 0 ? $arg{'lead'} : 12;
- $xpos += $hang_width;
- $line_width += $hang_width;
- $arg{'indent'} += $hang_width if $first_paragraph;
-
- } elsif ( $first_line && exists $arg{'flindent'} && $arg{'flindent'} > 0 ) {
- $xpos += $arg{'flindent'};
- $line_width += $arg{'flindent'};
+ # Calculate width of all words
+ my $space_width = $text_object->advancewidth("\x20");
+ my @words = split(/\s+/, $text);
+ foreach (@words)
+ {
+ next if exists $width{$_};
+ $width{$_} = $text_object->advancewidth($_);
+ }
- } elsif ( $first_paragraph && exists $arg{'fpindent'} && $arg{'fpindent'} > 0 ) {
- $xpos += $arg{'fpindent'};
- $line_width += $arg{'fpindent'};
+ my @paragraph = split(' ', shift(@paragraphs));
+ my $first_line = 1;
+ my $first_paragraph = 1;
+
+ # Little Init
+ $xpos = $xbase;
+ $ypos = $ybase;
+ $ypos = $ybase + $line_space;
+ my $bottom_border = $ypos - $height;
+ # While we can add another line
+ while ( $ypos >= $bottom_border + $line_space )
+ {
+ # Is there any text to render ?
+ unless (@paragraph)
+ {
+ # Finish if nothing left
+ last unless scalar @paragraphs;
+ # Else take one line from the text
+ @paragraph = split(' ', shift( @paragraphs ) );
+
+ $ypos -= $arg{'parspace'} if $arg{'parspace'};
+ last unless $ypos >= $bottom_border;
+ }
+ $ypos -= $line_space;
+ $xpos = $xbase;
+
+ # While there's room on the line, add another word
+ @line = ();
+ $line_width = 0;
+ if( $first_line && exists $arg{'hang'} )
+ {
+ my $hang_width = $text_object->advancewidth($arg{'hang'});
+
+ $text_object->translate( $xpos, $ypos );
+ $text_object->text( $arg{'hang'} );
+
+ $xpos += $hang_width;
+ $line_width += $hang_width;
+ $arg{'indent'} += $hang_width if $first_paragraph;
+ }
+ elsif( $first_line && exists $arg{'flindent'} && $arg{'flindent'} > 0 )
+ {
+ $xpos += $arg{'flindent'};
+ $line_width += $arg{'flindent'};
+ }
+ elsif( $first_paragraph && exists $arg{'fpindent'} && $arg{'fpindent'} > 0 )
+ {
+ $xpos += $arg{'fpindent'};
+ $line_width += $arg{'fpindent'};
+ }
+ elsif (exists $arg{'indent'} && $arg{'indent'} > 0 )
+ {
+ $xpos += $arg{'indent'};
+ $line_width += $arg{'indent'};
+ }
- } elsif (exists $arg{'indent'} && $arg{'indent'} > 0 ) {
- $xpos += $arg{'indent'};
- $line_width += $arg{'indent'};
- }
+ # Lets take from paragraph as many words as we can put into $width - $indent;
+ # Always take at least one word; otherwise we'd end up in an infinite loop.
+ while ( !scalar(@line) || (
+ @paragraph && (
+ $text_object->advancewidth( join("\x20", @line)."\x20" . $paragraph[0]) + $line_width < $width
+ )
+ ))
+ {
+ push(@line, shift(@paragraph));
+ }
+ $line_width += $text_object->advancewidth(join('', @line));
+
+ # calculate the space width
+ if( $arg{'align'} eq 'fulljustify' or ($arg{'align'} eq 'justify' and @paragraph))
+ {
+ @line = split(//,$line[0]) if (scalar(@line) == 1) ;
+ $wordspace = ($width - $line_width) / (scalar(@line) - 1);
+ $align='justify';
+ }
+ else
+ {
+ $align=($arg{'align'} eq 'justify') ? 'left' : $arg{'align'};
+ $wordspace = $space_width;
+ }
+ $line_width += $wordspace * (scalar(@line) - 1);
+
+ if( $align eq 'justify')
+ {
+ foreach my $word (@line)
+ {
+ $text_object->translate( $xpos, $ypos );
+ $text_object->text( $word );
+ $xpos += ($width{$word} + $wordspace) if (@line);
+ }
+ $endw = $width;
+ }
+ else
+ {
+ # calculate the left hand position of the line
+ if( $align eq 'right' )
+ {
+ $xpos += $width - $line_width;
+ }
+ elsif( $align eq 'center' )
+ {
+ $xpos += ( $width / 2 ) - ( $line_width / 2 );
+ }
- # Lets take from paragraph as many words as we can put into $width - $indent;. Always take at least one word; otherwise we'd end up in an infinite loop.
- while (!scalar(@line) || (@paragraph && ($text_object->advancewidth( join("\x20", @line)."\x20" . $paragraph[0]) + $line_width < $width))) {
- push(@line, shift(@paragraph));
- }
- $line_width += $text_object->advancewidth(join('', @line));
+ # render the line
+ $text_object->translate( $xpos, $ypos );
+ $endw = $text_object->text( join("\x20", @line));
+ }
+ $first_line = 0;
+ }#End of while(
+ unshift(@paragraphs, join(' ',@paragraph)) if scalar(@paragraph);
+ return ($endw, $ypos, join("\n", @paragraphs))
+}
- # calculate the space width
- if ( $arg{'align'} eq 'fulljustify' or ($arg{'align'} eq 'justify' and @paragraph)) {
- @line = split(//,$line[0]) if (scalar(@line) == 1) ;
- $wordspace = ($width - $line_width) / (scalar(@line) - 1);
- $align ='justify';
- } else {
- $align = ($arg{'align'} eq 'justify') ? 'left' : $arg{'align'};
- $wordspace = $space_width;
- }
- $line_width += $wordspace * (scalar(@line) - 1);
-
- if ( $align eq 'justify') {
- foreach my $word (@line) {
- $text_object->translate( $xpos, $ypos );
- $text_object->text( $word );
- $xpos += ($width{$word} + $wordspace) if (@line);
- }
- $endw = $width;
-
- } else {
- # calculate the left hand position of the line
- if ( $align eq 'right' ) {
- $xpos += $width - $line_width;
-
- } elsif ( $align eq 'center' ) {
- $xpos += ( $width / 2 ) - ( $line_width / 2 );
- }
-
- # render the line
- $text_object->translate( $xpos, $ypos );
- $endw = $text_object->text( join("\x20", @line));
+################################################################
+# table - utility method to build multi-row, multicolumn tables
+################################################################
+sub table
+{
+ my $self = shift;
+ my $pdf = shift;
+ my $page = shift;
+ my $data = shift;
+ my %arg = @_;
+
+ #=====================================
+ # Mandatory Arguments Section
+ #=====================================
+ unless($pdf and $page and $data)
+ {
+ carp "Error: Mandatory parameter is missing pdf/page/data object!\n";
+ return;
}
- $first_line = 0;
- }#End of while(
- unshift(@paragraphs, join(' ',@paragraph)) if scalar(@paragraph);
+ # Validate mandatory argument data type
+ croak "Error: Invalid pdf object received." unless (ref($pdf) eq 'PDF::API2');
+ croak "Error: Invalid page object received." unless (ref($page) eq 'PDF::API2::Page');
+ croak "Error: Invalid data received." unless ((ref($data) eq 'ARRAY') && scalar(@$data));
+ croak "Error: Missing required settings." unless (scalar(keys %arg));
+
+ # Validate settings key
+ my %valid_settings_key = (
+ x => 1,
+ w => 1,
+ start_y => 1,
+ start_h => 1,
+ next_y => 1,
+ next_h => 1,
+ lead => 1,
+ padding => 1,
+ padding_right => 1,
+ padding_left => 1,
+ padding_top => 1,
+ padding_bottom => 1,
+ background_color => 1,
+ background_color_odd => 1,
+ background_color_even => 1,
+ border => 1,
+ border_color => 1,
+ horizontal_borders => 1,
+ vertical_borders => 1,
+ font => 1,
+ font_size => 1,
+ font_underline => 1,
+ font_color => 1,
+ font_color_even => 1,
+ font_color_odd => 1,
+ background_color_odd => 1,
+ background_color_even => 1,
+ row_height => 1,
+ new_page_func => 1,
+ header_props => 1,
+ column_props => 1,
+ cell_props => 1,
+ max_word_length => 1,
+ cell_render_hook => 1,
+ default_text => 1,
+ num_header_rows => 1,
+ );
+ foreach my $key (keys %arg)
+ {
+ # Provide backward compatibility
+ $arg{$key} = delete $arg{"-$key"} if $key =~ s/^-//;
- return ($endw, $ypos, join("\n", @paragraphs))
-}
+ croak "Error: Invalid setting key '$key' received."
+ unless exists $valid_settings_key{$key};
+ }
-############################################################
-# table - utility method to build multi-row, multicolumn tables
-############################################################
-sub table {
- my $self = shift;
- my $pdf = shift;
- my $page = shift;
- my $data = shift;
- my %arg = @_;
-
- #=====================================
- # Mandatory Arguments Section
- #=====================================
- unless ($pdf and $page and $data) {
- print "Error: Mandatory parameter is missing pdf/page/data object!\n";
- return;
- }
- # Try to provide backward compatibility
- foreach my $key (keys %arg) {
- my $newkey = $key;
- if ($newkey =~ s#^-##) {
- $arg{$newkey} = $arg{$key};
- delete $arg{$key};
+ ######
+ #TODO: Add code for header props compatibility and col_props comp....
+ ######
+ my ( $xbase, $ybase, $width, $height ) = ( undef, undef, undef, undef );
+ # Could be 'int' or 'real' values
+ $xbase = $arg{'x' } || -1;
+ $ybase = $arg{'start_y'} || -1;
+ $width = $arg{'w' } || -1;
+ $height = $arg{'start_h'} || -1;
+
+ # Global geometry parameters are also mandatory.
+ unless( $xbase > 0 ){ carp "Error: Left Edge of Table is NOT defined!\n"; return; }
+ unless( $ybase > 0 ){ carp "Error: Base Line of Table is NOT defined!\n"; return; }
+ unless( $width > 0 ){ carp "Error: Width of Table is NOT defined!\n"; return; }
+ unless( $height > 0 ){ carp "Error: Height of Table is NOT defined!\n"; return; }
+
+ # Ensure default values for -next_y and -next_h
+ my $next_y = $arg{'next_y'} || $arg{'start_y'} || 0;
+ my $next_h = $arg{'next_h'} || $arg{'start_h'} || 0;
+
+ # Create Text Object
+ my $txt = $page->text;
+
+ # Set Default Properties
+ my $fnt_name = $arg{'font' } || $pdf->corefont('Times',-encode => 'utf8');
+ my $fnt_size = $arg{'font_size' } || 12;
+ my $fnt_underline = $arg{'font_underline' } || undef; # merely stating undef is the intended default
+ my $max_word_len = $arg{'max_word_length' } || 20;
+
+ #=====================================
+ # Table Header Section
+ #=====================================
+ # Disable header row into the table
+ my $header_props = undef;
+ my (@header_rows, @header_row_cell_props);
+ # Check if the user enabled it ?
+ if(defined $arg{'header_props'} and ref( $arg{'header_props'}) eq 'HASH')
+ {
+ # Transfer the reference to local variable
+ $header_props = $arg{'header_props'};
+
+ # Check other params and put defaults if needed
+ $header_props->{'repeat' } = $header_props->{'repeat' } || 0;
+ $header_props->{'font' } = $header_props->{'font' } || $fnt_name;
+ $header_props->{'font_color' } = $header_props->{'font_color' } || '#000066';
+ $header_props->{'font_size' } = $header_props->{'font_size' } || $fnt_size + 2;
+ $header_props->{'font_underline'} = $header_props->{'font_underline'} || $fnt_underline;
+ $header_props->{'bg_color' } = $header_props->{'bg_color' } || '#FFFFAA';
+ $header_props->{'justify' } = $header_props->{'justify' };
+ $header_props->{num_header_rows } = $arg{num_header_rows } || 1;
+ }
+ #=====================================
+ # Other Parameters check
+ #=====================================
+ my $lead = $arg{'lead' } || $fnt_size;
+ my $pad_left = $arg{'padding_left' } || $arg{'padding'} || 0;
+ my $pad_right = $arg{'padding_right' } || $arg{'padding'} || 0;
+ my $pad_top = $arg{'padding_top' } || $arg{'padding'} || 0;
+ my $pad_bot = $arg{'padding_bottom'} || $arg{'padding'} || 0;
+ my $default_text = $arg{'default_text' } // '-';
+ my $line_w = defined $arg{'border'} ? $arg{'border'} : 1 ;
+ my $horiz_borders = defined $arg{'horizontal_borders'}
+ ? $arg{'horizontal_borders'}
+ : $line_w;
+ my $vert_borders = defined $arg{'vertical_borders'}
+ ? $arg{'vertical_borders'}
+ : $line_w;
+
+ my $background_color_even = $arg{'background_color_even' } || $arg{'background_color'} || undef;
+ my $background_color_odd = $arg{'background_color_odd' } || $arg{'background_color'} || undef;
+ my $font_color_even = $arg{'font_color_even' } || $arg{'font_color' } || 'black';
+ my $font_color_odd = $arg{'font_color_odd' } || $arg{'font_color' } || 'black';
+ my $border_color = $arg{'border_color' } || 'black';
+
+ my $min_row_h = $fnt_size + $pad_top + $pad_bot;
+ my $row_h = defined ($arg{'row_height'})
+ &&
+ ($arg{'row_height'} > $min_row_h)
+ ?
+ $arg{'row_height'} : $min_row_h;
+
+ my $pg_cnt = 1;
+ my $cur_y = $ybase;
+ my $cell_props = $arg{cell_props} || []; # per cell properties
+
+ #If there is no valid data array reference warn and return!
+ if(ref $data ne 'ARRAY')
+ {
+ carp "Passed table data is not an ARRAY reference. It's actually a ref to ".ref($data);
+ return ($page,0,$cur_y);
}
- }
- #TODO: Add code for header props compatibility and col_props comp....
- #####
- my ( $xbase, $ybase, $width, $height ) = ( undef, undef, undef, undef );
- # Could be 'int' or 'real' values
- $xbase = $arg{'x' } || -1;
- $ybase = $arg{'start_y'} || -1;
- $width = $arg{'w' } || -1;
- $height = $arg{'start_h'} || -1;
-
- # Global geometry parameters are also mandatory.
- unless ( $xbase > 0 ) { print "Error: Left Edge of Table is NOT defined!\n"; return; }
- unless ( $ybase > 0 ) { print "Error: Base Line of Table is NOT defined!\n"; return; }
- unless ( $width > 0 ) { print "Error: Width of Table is NOT defined!\n"; return; }
- unless ( $height > 0 ) { print "Error: Height of Table is NOT defined!\n"; return; }
-
- # Ensure default values for -next_y and -next_h
- my $next_y = $arg{'next_y'} || $arg{'start_y'} || 0;
- my $next_h = $arg{'next_h'} || $arg{'start_h'} || 0;
-
- # Create Text Object
- my $txt = $page->text;
- # Set Default Properties
- my $fnt_name = $arg{'font'} || $pdf->corefont('Times', -encode => 'utf8');
- my $fnt_size = $arg{'font_size'} || 12;
- my $max_word_len = $arg{'max_word_length'} || 20;
-
- #=====================================
- # Table Header Section
- #=====================================
- # Disable header row into the table
- my $header_props;
- my $num_header_rows = 0;
- my (@header_rows, @header_row_cell_props);
- # Check if the user enabled it ?
- if (defined $arg{'header_props'} and ref( $arg{'header_props'}) eq 'HASH') {
- # Transfer the reference to local variable
- $header_props = $arg{'header_props'};
- # Check other params and put defaults if needed
- $header_props->{'repeat'} = $header_props->{'repeat'} || 0;
- $header_props->{'font'} = $header_props->{'font'} || $fnt_name;
- $header_props->{'font_color'} = $header_props->{'font_color'} || '#000066';
- $header_props->{'font_size'} = $header_props->{'font_size'} || $fnt_size + 2;
- $header_props->{'bg_color'} = $header_props->{'bg_color'} || '#FFFFAA';
-
- $num_header_rows = $arg{'num_header_rows'} || 1;
- }
- #=====================================
- # Other Parameters check
- #=====================================
-
- my $lead = $arg{'lead'} || $fnt_size;
- my $pad_left = $arg{'padding_left'} || $arg{'padding'} || 0;
- my $pad_right = $arg{'padding_right'} || $arg{'padding'} || 0;
- my $pad_top = $arg{'padding_top'} || $arg{'padding'} || 0;
- my $pad_bot = $arg{'padding_bottom'} || $arg{'padding'} || 0;
- my $pad_w = $pad_left + $pad_right;
- my $pad_h = $pad_top + $pad_bot ;
- my $line_w = defined $arg{'border'} ? $arg{'border'} : 1 ;
-
- my $background_color_even = $arg{'background_color_even'} || $arg{'background_color'} || undef;
- my $background_color_odd = $arg{'background_color_odd'} || $arg{'background_color'} || undef;
- my $font_color_even = $arg{'font_color_even'} || $arg{'font_color'} || 'black';
- my $font_color_odd = $arg{'font_color_odd'} || $arg{'font_color'} || 'black';
- my $border_color = $arg{'border_color'} || 'black';
-
- my $min_row_h = $fnt_size + $pad_top + $pad_bot;
- my $row_h = defined ($arg{'row_height'}) && ($arg{'row_height'} > $min_row_h) ? $arg{'row_height'} : $min_row_h;
-
- my $pg_cnt = 1;
- my $cur_y = $ybase;
- my $cell_props = $arg{cell_props} || []; # per cell properties
- my $row_cnt = $num_header_rows;
-
- #If there is valid data array reference use it!
- if (ref $data eq 'ARRAY') {
+
# Copy the header row if header is enabled
if (defined $header_props) {
- map { push @header_rows, $$data[$_] } (0..$num_header_rows - 1);
- map { push @header_row_cell_props, $$cell_props[$_] } (0..$num_header_rows - 1);
+ map { push @header_rows, $$data[$_] } (0..$header_props->{num_header_rows} - 1);
+ map { push @header_row_cell_props, $$cell_props[$_] } (0..$header_props->{num_header_rows} - 1);
}
# Determine column widths based on content
# An array ref of arrayrefs whose values are
# the actual widths of the column/row intersection
- my $row_props = [];
+ my $row_col_widths = [];
# An array ref with the widths of the header row
my @header_row_widths;
# Scalars that hold sum of the maximum and minimum widths of all columns
- my ( $max_col_w, $min_col_w ) = ( 0,0 );
- my ( $row, $col_name, $col_fnt_size, $space_w );
+ my ( $max_col_w , $min_col_w ) = ( 0,0 );
+ my ( $row, $col_name, $col_fnt_size, $col_fnt_underline, $space_w );
- # Hash that will hold the width of every word from input text
- my $word_w = {};
- my $rows_counter = 0;
+ my $word_widths = {};
+ my $rows_height = [];
+ my $first_row = 1;
- foreach $row ( @{$data} ) {
- push(@header_row_widths, []) if ($rows_counter < $num_header_rows);
+ for( my $row_idx = 0; $row_idx < scalar(@$data) ; $row_idx++ )
+ {
+ #push @header_row_widths, [] if $row_idx < $header_props->{num_header_rows};
+
+ my $column_widths = []; #holds the width of each column
+ # Init the height for this row
+ $rows_height->[$row_idx] = 0;
+
+ for( my $column_idx = 0; $column_idx < scalar(@{$data->[$row_idx]}) ; $column_idx++ )
+ {
+ # look for font information for this column
+ my ($cell_font, $cell_font_size, $cell_font_underline);
+
+ if( !$row_idx and ref $header_props )
+ {
+ $cell_font = $header_props->{'font'};
+ $cell_font_size = $header_props->{'font_size'};
+ $cell_font_underline = $header_props->{'font_underline'};
+ }
- my $column_widths = []; #holds the width of each column
- for( my $j = 0; $j < scalar(@$row) ; $j++ ) {
- # look for font information for this column
- $col_fnt_size = $col_props->[$j]->{'font_size'} || $fnt_size;
- if ( !$rows_counter and ref $header_props) {
- $txt->font( $header_props->{'font'}, $header_props->{'font_size'} );
+ # Get the most specific value if none was already set from header_props
+ $cell_font ||= $cell_props->[$row_idx][$column_idx]->{'font'}
+ || $col_props->[$column_idx]->{'font'}
+ || $fnt_name;
- } elsif ( $col_props->[$j]->{'font'} ) {
- $txt->font( $col_props->[$j]->{'font'}, $col_fnt_size );
+ $cell_font_size ||= $cell_props->[$row_idx][$column_idx]->{'font_size'}
+ || $col_props->[$column_idx]->{'font_size'}
+ || $fnt_size;
- } else {
- $txt->font( $fnt_name, $col_fnt_size );
- }
+ $cell_font_underline ||= $cell_props->[$row_idx][$column_idx]->{'font_underline'}
+ || $col_props->[$column_idx]->{'font_underline'}
+ || $fnt_underline;
- # This should fix a bug with very long word like serial numbers etc.
- # $myone is used because $1 gets out of scope in while condition
- my $myone;
- do {
- $myone = 0;
- # This RegEx will split any word that is longer than {25} symbols
- $row->[$j] =~ s#(\b\S{$max_word_len}?)(\S.*?\b)# $1 $2#;
- $myone = 1 if ( defined $2 );
- } while( $myone );
- $row->[$j] =~ s/^\s+//;
-
- $space_w = $txt->advancewidth( "\x20" );
- $column_widths->[$j] = 0;
- $max_col_w = 0;
- $min_col_w = 0;
-
- my @words = split( /\s+/, $row->[$j] );
-
- foreach( @words ) {
- unless ( exists $word_w->{$_} ) { # Calculate the width of every word and add the space width to it
- $word_w->{$_} = $txt->advancewidth( $_ ) + $space_w;
- }
- $column_widths->[$j] += $word_w->{$_};
- $min_col_w = $word_w->{$_} if $word_w->{$_} > $min_col_w;
- $max_col_w += $word_w->{$_};
- }
- $min_col_w += $pad_w;
- $max_col_w += $pad_w;
- $column_widths->[$j] += $pad_w;
+ # Set Font
- # Keep a running total of the overall min and max widths
- $col_props->[$j]->{min_w} = $col_props->[$j]->{min_w} || 0;
- $col_props->[$j]->{max_w} = $col_props->[$j]->{max_w} || 0;
+ # Set Font
+ $txt->font( $cell_font, $cell_font_size );
- if ( $min_col_w > $col_props->[$j]->{min_w} ) { # Calculated Minimum Column Width is more than user-defined
- $col_props->[$j]->{min_w} = $min_col_w ;
- }
- if ( $max_col_w > $col_props->[$j]->{max_w} ) { # Calculated Maximum Column Width is more than user-defined
- $col_props->[$j]->{max_w} = $max_col_w ;
- }
- }#End of for(my $j....
- $row_props->[$rows_counter] = $column_widths;
- # Copy the calculated row properties of header row.
- if (($rows_counter < $num_header_rows) && $header_props) {
- push(@header_row_widths, [ @{ $column_widths } ]);
- }
- $rows_counter++;
- }
- # Calc real column widths and expand table width if needed.
- my $calc_column_widths;
- ($calc_column_widths, $width) = $self->CalcColumnWidths( $col_props, $width );
- my $num_cols = scalar @{ $calc_column_widths };
- my $comp_cnt = 1;
- $rows_counter = 0;
+ # Set row height to biggest font size from row's cells
+ if( $cell_font_size > $rows_height->[$row_idx] )
+ {
+ $rows_height->[$row_idx] = $cell_font_size;
+ }
+
+ if (!defined $data->[$row_idx][$column_idx]) {
+ $data->[$row_idx][$column_idx] = ' ';
+ }
- my ( $gfx , $gfx_bg , $background_color , $font_color, );
- my ( $bot_marg, $table_top_y, $text_start , $record, $record_widths );
+ # This should fix a bug with very long words like serial numbers etc.
+ if( $max_word_len > 0 && $data->[$row_idx][$column_idx])
+ {
+ $data->[$row_idx][$column_idx] =~ s#(\S{$max_word_len})(?=\S)#$1 #g;
+ }
- my $remaining_header_rows = $header_props ? $num_header_rows : 0;
+ # Init cell size limits
+ $space_w = $txt->advancewidth( "\x20" );
+ $column_widths->[$column_idx] = 0;
+ $max_col_w = 0;
+ $min_col_w = 0;
- # Each iteration adds a new page as neccessary
- while(scalar(@{$data})) {
- my $page_header;
- if ($pg_cnt == 1) {
- $table_top_y = $ybase;
- $bot_marg = $table_top_y - $height;
+ my @words = split( /\s+/, $data->[$row_idx][$column_idx] );
- } else {
- if (ref $arg{'new_page_func'}) {
- $page = &{$arg{'new_page_func'}};
+ foreach( @words )
+ {
+ unless( exists $word_widths->{$_} )
+ { # Calculate the width of every word and add the space width to it
+ $word_widths->{$_} = $txt->advancewidth( $_ ) + $space_w;
+ }
- } else {
- $page = $pdf->page;
- }
+ $column_widths->[$column_idx] += $word_widths->{$_};
+ $min_col_w = $word_widths->{$_} if( $word_widths->{$_} > $min_col_w );
+ $max_col_w += $word_widths->{$_};
+ }
- $table_top_y = $next_y;
- $bot_marg = $table_top_y - $next_h;
+ $min_col_w += $pad_left + $pad_right;
+ $max_col_w += $pad_left + $pad_right;
+ $column_widths->[$column_idx] += $pad_left + $pad_right;
- if ( ref $header_props and $header_props->{'repeat'}) {
- foreach my $idx (0 .. $num_header_rows - 1) {
- unshift @$data, [ @{ $header_rows[$idx] } ];
- unshift @$row_props, [ @{ $header_row_widths[$idx] } ];
- }
- $remaining_header_rows = $num_header_rows;
- }
- }
-
- # Check for safety reasons
- if ( $bot_marg < 0 ) { # This warning should remain i think
-# print "!!! Warning: !!! Incorrect Table Geometry! Setting bottom margin to end of sheet!\n";
- $bot_marg = 0;
- }
-
- $gfx_bg = $page->gfx;
- $txt = $page->text;
- $txt->font($fnt_name, $fnt_size);
- $gfx = $page->gfx;
- $gfx->strokecolor($border_color);
- $gfx->linewidth($line_w);
-
- # Draw the top line
- $cur_y = $table_top_y;
- $gfx->move( $xbase , $cur_y );
- $gfx->hline($xbase + $width );
-
- # Each iteration adds a row to the current page until the page is full
- # or there are no more rows to add
- while(scalar(@{$data}) and $cur_y-$row_h > $bot_marg) {
- # Remove the next item from $data
- $record = shift @{$data};
- # Added to resolve infite loop bug with returned undef values
- for(my $d = 0; $d < scalar(@{$record}) ; $d++) {
- $record->[$d] = '-' unless ( defined $record->[$d]);
- }
+ # Keep a running total of the overall min and max widths
+ $col_props->[$column_idx]->{'min_w'} ||= 0;
+ $col_props->[$column_idx]->{'max_w'} ||= 0;
- $record_widths = shift @$row_props;
- next unless $record;
+ if( $min_col_w > $col_props->[$column_idx]->{'min_w'} )
+ { # Calculated Minimum Column Width is more than user-defined
+ $col_props->[$column_idx]->{'min_w'} = $min_col_w ;
+ }
+
+ if( $max_col_w > $col_props->[$column_idx]->{'max_w'} )
+ { # Calculated Maximum Column Width is more than user-defined
+ $col_props->[$column_idx]->{'max_w'} = $max_col_w ;
+ }
+ }#End of for(my $column_idx....
- # Choose colors for this row
- $background_color = $rows_counter % 2 ? $background_color_even : $background_color_odd;
- $font_color = $rows_counter % 2 ? $font_color_even : $font_color_odd;
+ $row_col_widths->[$row_idx] = $column_widths;
- if ($remaining_header_rows and ref $header_props) {
- $background_color = $header_props->{'bg_color'}
+ # Copy the calculated row properties of header row.
+ if (ref $header_props && $row_idx < $header_props->{num_header_rows}) {
+ push @header_row_widths, [ @{ $column_widths } ];
}
- $text_start = $cur_y - $fnt_size - $pad_top;
- my $cur_x = $xbase;
- my $leftovers = undef; # Reference to text that is returned from textblock()
- my $do_leftovers = 0;
+ }
+
+ # Calc real column widths and expand table width if needed.
+ my $calc_column_widths;
+ ($calc_column_widths, $width) = CalcColumnWidths( $col_props, $width );
+ my $num_cols = scalar @{ $calc_column_widths };
+
+ # Lets draw what we have!
+ my $row_index = 0;
+ # Store header row height for later use if headers have to be repeated
+ my @header_row_heights = @$rows_height[0 .. $header_props->{num_header_rows}-1];
- my ($colspan, @vertical_lines);
+ my ( $gfx, $gfx_bg, $background_color, $font_color, $bot_marg, $table_top_y, $text_start);
- # Process every column from current row
- for( my $j = 0; $j < scalar( @$record); $j++ ) {
- next unless $col_props->[$j]->{max_w};
- next unless $col_props->[$j]->{min_w};
- $leftovers->[$j] = undef;
+ my $remaining_header_rows = $header_props ? $header_props->{num_header_rows} : 0;
- # Choose font color
- if ( $remaining_header_rows and ref $header_props ) {
- $txt->fillcolor( $header_props->{'font_color'} );
+ # Each iteration adds a new page as neccessary
+ while(scalar(@{$data}))
+ {
+ my ($page_header);
+ my $columns_number = 0;
+
+ if($pg_cnt == 1)
+ {
+ $table_top_y = $ybase;
+ $bot_marg = $table_top_y - $height;
+
+ # Check for safety reasons
+ if( $bot_marg < 0 )
+ { # This warning should remain i think
+ #carp "!!! Warning: !!! Incorrect Table Geometry! start_h (${height}) is above start_y (${table_top_y}). Setting bottom margin to end of sheet!\n";
+ $bot_marg = 0;
+ }
- } elsif ( $cell_props->[$row_cnt][$j]{font_color} ) {
- $txt->fillcolor( $cell_props->[$row_cnt][$j]{font_color} );
+ }
+ else
+ {
+ if(ref $arg{'new_page_func'})
+ {
+ $page = &{$arg{'new_page_func'}};
+ }
+ else
+ {
+ $page = $pdf->page;
+ }
- } elsif ( $col_props->[$j]->{'font_color'} ) {
- $txt->fillcolor( $col_props->[$j]->{'font_color'} );
+ $table_top_y = $next_y;
+ $bot_marg = $table_top_y - $next_h;
- } else {
- $txt->fillcolor($font_color);
- }
+ # Check for safety reasons
+ if( $bot_marg < 0 )
+ { # This warning should remain i think
+ #carp "!!! Warning: !!! Incorrect Table Geometry! next_y or start_y (${next_y}) is above next_h or start_h (${next_h}). Setting bottom margin to end of sheet!\n";
+ $bot_marg = 0;
+ }
- # Choose font size
- if ( $remaining_header_rows and ref $header_props ) {
- $col_fnt_size = $header_props->{'font_size'};
+ if( ref $header_props and $header_props->{'repeat'})
+ {
+ unshift @$data, @header_rows;
+ unshift @$row_col_widths, @header_row_widths;
+ unshift @$rows_height, @header_row_heights;
+ $remaining_header_rows = $header_props->{num_header_rows};
+ $first_row = 1;
+ }
+ }
- } elsif ( $col_props->[$j]->{'font_size'} ) {
- $col_fnt_size = $col_props->[$j]->{'font_size'};
+ $gfx_bg = $page->gfx;
+ $txt = $page->text;
+ $txt->font($fnt_name, $fnt_size);
- } else {
- $col_fnt_size = $fnt_size;
- }
+ $cur_y = $table_top_y;
- # Choose font family
- if ( $remaining_header_rows and ref $header_props ) {
- $txt->font( $header_props->{'font'}, $header_props->{'font_size'});
+ if ($line_w)
+ {
+ $gfx = $page->gfx;
+ $gfx->strokecolor($border_color);
+ $gfx->linewidth($line_w);
- } elsif ( $col_props->[$j]->{'font'} ) {
- $txt->font( $col_props->[$j]->{'font'}, $col_fnt_size);
+ # Draw the top line
+ if ($horiz_borders)
+ {
+ $gfx->move( $xbase , $cur_y );
+ $gfx->hline($xbase + $width );
+ }
+ }
+ else
+ {
+ $gfx = undef;
+ }
- } else {
- $txt->font( $fnt_name, $col_fnt_size);
- }
- #TODO: Implement Center text align
- $col_props->[$j]->{justify} = $col_props->[$j]->{justify} || 'left';
+ # Each iteration adds a row to the current page until the page is full
+ # or there are no more rows to add
+ # Row_Loop
+ while(scalar(@{$data}) and $cur_y-$row_h > $bot_marg)
+ {
+ # Remove the next item from $data
+ my $record = shift @{$data};
- my $this_width;
- if (!$remaining_header_rows && $cell_props->[$row_cnt]->[$j]->{colspan}) {
- $colspan = $cell_props->[$row_cnt]->[$j]->{colspan};
+ # Get max columns number to know later how many vertical lines to draw
+ $columns_number = scalar(@$record)
+ if scalar(@$record) > $columns_number;
- } elsif ($remaining_header_rows && $header_row_cell_props[$num_header_rows - $remaining_header_rows]->[$j]->{colspan}) {
- $colspan = $header_row_cell_props[$num_header_rows - $remaining_header_rows]->[$j]->{colspan};
+ # Get the next set of row related settings
+ # Row Height
+ my $pre_calculated_row_height = shift @$rows_height;
- }
+ # Row cell widths
+ my $record_widths = shift @$row_col_widths;
- if ($colspan) {
- $colspan = $num_cols - $j if (-1 == $colspan);
- my $last_idx = $j + $colspan - 1;
- $this_width = sum @{ $calc_column_widths }[$j..$last_idx];
+ # Row coloumn props - TODO in another commit
- } else {
- $this_width = $calc_column_widths->[$j];
- }
+ # Row cell props - TODO in another commit
- # If the content is wider than the specified width, we need to add the text as a text block
- if ($record->[$j] !~ m#(.\n.)# and $record_widths->[$j] and ($record_widths->[$j] < $this_width)) {
- my $space = $pad_left;
- if ($col_props->[$j]->{justify} eq 'right') {
- $space = $this_width -($txt->advancewidth($record->[$j]) + $pad_right);
- }
- $txt->translate( $cur_x + $space, $text_start );
- $txt->text( $record->[$j] );
- } else { # Otherwise just use the $page->text() method
- my($width_of_last_line, $ypos_of_last_line, $left_over_text) =
- $self->text_block($txt,
- $record->[$j],
- 'x' => $cur_x + $pad_left,
- 'y' => $text_start,
- 'w' => $this_width - $pad_w,
- 'h' => $cur_y - $bot_marg - $pad_top - $pad_bot,
- 'align' => $col_props->[$j]->{justify},
- 'lead' => $lead
- );
- # Desi - Removed $lead because of fixed incorrect ypos bug in text_block
- my $this_row_h = $cur_y - ( $ypos_of_last_line - $pad_bot );
- $row_h = $this_row_h if $this_row_h > $row_h;
- if ( $left_over_text ) {
- $leftovers->[$j] = $left_over_text;
- $do_leftovers = 1;
+ # Added to resolve infite loop bug with returned undef values
+ for(my $d = 0; $d < scalar(@{$record}) ; $d++)
+ {
+ $record->[$d] = ' ' unless( defined $record->[$d]);
}
- }
- $cur_x += $calc_column_widths->[$j];
- push @vertical_lines, (!$colspan || (1 >= $colspan)) ? 1 : 0;
- $colspan-- if ($colspan);
- }
+ # Choose colors for this row
+ $background_color = ($row_index - $header_props->{num_header_rows}) % 2 ? $background_color_even : $background_color_odd;
+ $font_color = ($row_index - $header_props->{num_header_rows}) % 2 ? $font_color_even : $font_color_odd;
- if ( $do_leftovers ) {
- unshift @$data, $leftovers;
- unshift @$row_props, $record_widths;
- $rows_counter--;
- }
+ #Determine current row height
+ my $current_row_height = $pad_top + $pre_calculated_row_height + $pad_bot;
- # Draw cell bgcolor
- # This has to be separately from the text loop
- # because we do not know the final height of the cell until all text has been drawn
- $cur_x = $xbase;
- for(my $j =0;$j < scalar(@$record);$j++) {
- if ( $cell_props->[$row_cnt][$j]->{'background_color'} ||
- $col_props->[$j]->{'background_color'} ||
- $background_color ) {
- $gfx_bg->rect( $cur_x, $cur_y-$row_h, $calc_column_widths->[$j], $row_h);
- if ( $cell_props->[$row_cnt][$j]->{'background_color'} && !$remaining_header_rows ) {
- $gfx_bg->fillcolor($cell_props->[$row_cnt][$j]->{'background_color'});
-
- } elsif ( $col_props->[$j]->{'background_color'} && !$remaining_header_rows ) {
- $gfx_bg->fillcolor($col_props->[$j]->{'background_color'});
+ # $row_h is the calculated global user requested row height.
+ # It will be honored, only if it has bigger value than the calculated one.
+ # TODO: It's questionable if padding should be inclided in this calculation or not
+ if($current_row_height < $row_h){
+ $current_row_height = $row_h;
+ }
+
+ # Define the font y base position for this line.
+ $text_start = $cur_y - ($current_row_height - $pad_bot);
+
+ my $cur_x = $xbase;
+ my $leftovers = undef; # Reference to text that is returned from textblock()
+ my $do_leftovers = 0;
+ my ($colspan, @vertical_lines);
+
+ # Process every cell(column) from current row
+ for( my $column_idx = 0; $column_idx < scalar( @$record); $column_idx++ )
+ {
+ next unless $col_props->[$column_idx]->{'max_w'};
+ next unless $col_props->[$column_idx]->{'min_w'};
+ $leftovers->[$column_idx] = undef;
+
+ # look for font information for this cell
+ my ($cell_font, $cell_font_size, $cell_font_color, $cell_font_underline, $justify);
+
+ if( $remaining_header_rows and ref $header_props)
+ {
+ $cell_font = $header_props->{'font'};
+ $cell_font_size = $header_props->{'font_size'};
+ $cell_font_color = $header_props->{'font_color'};
+ $cell_font_underline = $header_props->{'font_underline'};
+ $justify = $header_props->{'justify'};
+ }
+
+ # Get the most specific value if none was already set from header_props
+ $cell_font ||= $cell_props->[$row_index][$column_idx]->{'font'}
+ || $col_props->[$column_idx]->{'font'}
+ || $fnt_name;
+
+ $cell_font_size ||= $cell_props->[$row_index][$column_idx]->{'font_size'}
+ || $col_props->[$column_idx]->{'font_size'}
+ || $fnt_size;
+
+ $cell_font_color ||= $cell_props->[$row_index][$column_idx]->{'font_color'}
+ || $col_props->[$column_idx]->{'font_color'}
+ || $font_color;
+
+ $cell_font_underline ||= $cell_props->[$row_index][$column_idx]->{'font_underline'}
+ || $col_props->[$column_idx]->{'font_underline'}
+ || $fnt_underline;
+
+
+ $justify ||= $cell_props->[$row_index][$column_idx]->{'justify'}
+ || $col_props->[$column_idx]->{'justify'}
+ || $arg{'justify'}
+ || 'left';
+
+ # Init cell font object
+ $txt->font( $cell_font, $cell_font_size );
+ $txt->fillcolor($cell_font_color);
+
+ # Added to resolve infite loop bug with returned undef values
+ $record->[$column_idx] //= $cell_props->[$row_index][$column_idx]->{'default_text'}
+ // $col_props->[$column_idx]->{'default_text'}
+ // $default_text;
+
+ my $this_width;
+ if (!$remaining_header_rows && $cell_props->[$row_index + $header_props->{num_header_rows}][$column_idx]->{colspan}) {
+ $colspan = $cell_props->[$row_index + $header_props->{num_header_rows}][$column_idx]->{colspan};
+ } elsif ($remaining_header_rows && ($header_row_cell_props[$header_props->{num_header_rows} - $remaining_header_rows][$column_idx]->{colspan})) {
+ $colspan = $header_row_cell_props[$header_props->{num_header_rows} - $remaining_header_rows][$column_idx]->{colspan};
+ }
+
+ if ($colspan) {
+ $colspan = $num_cols - $column_idx if (-1 == $colspan);
+ my $last_idx = $column_idx + $colspan - 1;
+ $this_width = sum @{ $calc_column_widths }[$column_idx..$last_idx];
+ } else {
+ $this_width = $calc_column_widths->[$column_idx];
+ }
+
+ # If the content is wider than the specified width, we need to add the text as a text block
+ if( $record->[$column_idx] !~ m/(.\n.)/ and
+ $record_widths->[$column_idx] and
+ $record_widths->[$column_idx] <= $this_width
+ ){
+ my $space = $pad_left;
+ if ($justify eq 'right')
+ {
+ $space = $this_width -($txt->advancewidth($record->[$column_idx]) + $pad_right);
+ }
+ elsif ($justify eq 'center')
+ {
+ $space = ($this_width - $txt->advancewidth($record->[$column_idx])) / 2;
+ }
+ $txt->translate( $cur_x + $space, $text_start );
+ my %text_options;
+ $text_options{'-underline'} = $cell_font_underline if $cell_font_underline;
+ $txt->text( $record->[$column_idx], %text_options );
+ }
+ # Otherwise just use the $page->text() method
+ else
+ {
+ my ($width_of_last_line, $ypos_of_last_line, $left_over_text) = $self->text_block(
+ $txt,
+ $record->[$column_idx],
+ x => $cur_x + $pad_left,
+ y => $text_start,
+ w => $this_width - $pad_left - $pad_right,
+ h => $cur_y - $bot_marg - $pad_top - $pad_bot,
+ align => $justify,
+ lead => $lead
+ );
+ # Desi - Removed $lead because of fixed incorrect ypos bug in text_block
+ my $current_cell_height = $cur_y - $ypos_of_last_line + $pad_bot;
+ if( $current_cell_height > $current_row_height )
+ {
+ $current_row_height = $current_cell_height;
+ }
+
+ if( $left_over_text )
+ {
+ $leftovers->[$column_idx] = $left_over_text;
+ $do_leftovers = 1;
+ }
+ }
+
+ # Hook to pass coordinates back - http://www.perlmonks.org/?node_id=754777
+ if (ref $arg{cell_render_hook} eq 'CODE') {
+ $arg{cell_render_hook}->(
+ $page,
+ $first_row,
+ $row_index,
+ $column_idx,
+ $cur_x,
+ $cur_y-$row_h,
+ $calc_column_widths->[$column_idx],
+ $row_h
+ );
+ }
+
+ $cur_x += $calc_column_widths->[$column_idx];
+
+ push @vertical_lines, (!$colspan || (1 >= $colspan)) ? 1 : 0;
+ $colspan-- if $colspan;
+ }
+ if( $do_leftovers )
+ {
+ unshift @$data, $leftovers;
+ unshift @$row_col_widths, $record_widths;
+ unshift @$rows_height, $pre_calculated_row_height;
+ }
+
+ # Draw cell bgcolor
+ # This has to be separately from the text loop
+ # because we do not know the final height of the cell until all text has been drawn
+ $cur_x = $xbase;
+ for(my $column_idx = 0 ; $column_idx < scalar(@$record) ; $column_idx++)
+ {
+ my $cell_bg_color;
+
+ if( $remaining_header_rows and ref $header_props)
+ { #Compatibility Consistency with other props
+ $cell_bg_color = $header_props->{'bg_color'} || $header_props->{'background_color'};
+ }
+
+ # Get the most specific value if none was already set from header_props
+ $cell_bg_color ||= $cell_props->[$row_index + $header_props->{num_header_rows}][$column_idx]->{'background_color'}
+ || $col_props->[$column_idx]->{'background_color'}
+ || $background_color;
+
+ if ($cell_bg_color)
+ {
+ $gfx_bg->rect( $cur_x, $cur_y-$current_row_height, $calc_column_widths->[$column_idx], $current_row_height);
+ $gfx_bg->fillcolor($cell_bg_color);
+ $gfx_bg->fill();
+ }
+ $cur_x += $calc_column_widths->[$column_idx];
+
+ if ($line_w && $vertical_lines[$column_idx] && ($column_idx != (scalar(@{ $record }) - 1))) {
+ $gfx->move($cur_x, $cur_y);
+ $gfx->vline($cur_y - $current_row_height);
+ $gfx->fillcolor($border_color);
+ }
+ }#End of for(my $column_idx....
+
+ $cur_y -= $current_row_height;
+ if ($gfx && $horiz_borders)
+ {
+ $gfx->move( $xbase , $cur_y );
+ $gfx->hline( $xbase + $width );
+ }
+ $first_row = 0;
+ if ($remaining_header_rows) {
+ $remaining_header_rows--;
} else {
- $gfx_bg->fillcolor($background_color);
+ $row_index++ unless $do_leftovers;
}
- $gfx_bg->fill();
- }
-
- $cur_x += $calc_column_widths->[$j];
-
- if ($line_w && $vertical_lines[$j] && ($j != (scalar(@{ $record }) - 1))) {
- $gfx->move($cur_x, $cur_y);
- $gfx->vline($cur_y - $row_h);
- $gfx->fillcolor($border_color);
- }
- }#End of for(my $j....
-
- $cur_y -= $row_h;
- $row_h = $min_row_h;
- $gfx->move( $xbase , $cur_y );
- $gfx->hline( $xbase + $width );
- $rows_counter++;
- if ($remaining_header_rows) {
- $remaining_header_rows--;
- } else {
- $row_cnt++ unless $do_leftovers;
+ }# End of Row_Loop
+
+ if ($gfx)
+ {
+ # Draw vertical lines
+ if ($vert_borders)
+ {
+ $gfx->move( $xbase, $table_top_y);
+ $gfx->vline( $cur_y );
+ $gfx->move($xbase + sum(@{ $calc_column_widths }[0..$num_cols - 1]), $table_top_y);
+ $gfx->vline( $cur_y );
+ }
+
+ # ACTUALLY draw all the lines
+ $gfx->fillcolor( $border_color);
+ $gfx->stroke;
}
- }# End of while(scalar(@{$data}) and $cur_y-$row_h > $bot_marg)
-
- # Draw vertical lines
- if ($line_w) {
- $gfx->move($xbase, $table_top_y);
- $gfx->vline($cur_y);
- $gfx->move($xbase + sum(@{ $calc_column_widths }[0..$num_cols - 1]), $table_top_y);
- $gfx->vline($cur_y);
- $gfx->fillcolor($border_color);
- $gfx->stroke();
- }
- $pg_cnt++;
+ $pg_cnt++;
}# End of while(scalar(@{$data}))
- }# End of if (ref $data eq 'ARRAY')
- return ($page,--$pg_cnt,$cur_y);
+ return ($page,--$pg_cnt,$cur_y);
}
# calculate the column widths
-sub CalcColumnWidths {
- my $self = shift;
- my $col_props = shift;
- my $avail_width = shift;
- my $min_width = 0;
-
- my $calc_widths ;
- for(my $j = 0; $j < scalar( @$col_props); $j++) {
- $min_width += $col_props->[$j]->{min_w};
- }
-
- # I think this is the optimal variant when good view can be guaranateed
- if ($avail_width < $min_width) {
-# print "!!! Warning !!!\n Calculated Mininal width($min_width) > Table width($avail_width).\n",
-# ' Expanding table width to:',int($min_width)+1,' but this could lead to unexpected results.',"\n",
-# ' Possible solutions:',"\n",
-# ' 0)Increase table width.',"\n",
-# ' 1)Decrease font size.',"\n",
-# ' 2)Choose a more narrow font.',"\n",
-# ' 3)Decrease "max_word_length" parameter.',"\n",
-# ' 4)Rotate page to landscape(if it is portrait).',"\n",
-# ' 5)Use larger paper size.',"\n",
-# '!!! --------- !!!',"\n";
- $avail_width = int( $min_width) + 1;
-
- }
-
- my $span = 0;
- # Calculate how much can be added to every column to fit the available width
- $span = ($avail_width - $min_width) / scalar( @$col_props);
- for (my $j = 0; $j < scalar(@$col_props); $j++ ) {
- $calc_widths->[$j] = $col_props->[$j]->{min_w} + $span;
- }
-
- return ($calc_widths,$avail_width);
+sub CalcColumnWidths
+{
+ my $col_props = shift;
+ my $avail_width = shift;
+ my $min_width = 0;
+
+ my $calc_widths ;
+
+ for(my $j = 0; $j < scalar( @$col_props); $j++)
+ {
+ $min_width += $col_props->[$j]->{min_w} || 0;
+ }
+
+ # I think this is the optimal variant when good view can be guaranateed
+ if($avail_width < $min_width)
+ {
+ carp "!!! Warning !!!\n Calculated Mininal width($min_width) > Table width($avail_width).\n",
+ ' Expanding table width to:',int($min_width)+1,' but this could lead to unexpected results.',"\n",
+ ' Possible solutions:',"\n",
+ ' 0)Increase table width.',"\n",
+ ' 1)Decrease font size.',"\n",
+ ' 2)Choose a more narrow font.',"\n",
+ ' 3)Decrease "max_word_length" parameter.',"\n",
+ ' 4)Rotate page to landscape(if it is portrait).',"\n",
+ ' 5)Use larger paper size.',"\n",
+ '!!! --------- !!!',"\n";
+ $avail_width = int( $min_width) + 1;
+
+ }
+
+ # Calculate how much can be added to every column to fit the available width.
+ for(my $j = 0; $j < scalar(@$col_props); $j++ )
+ {
+ $calc_widths->[$j] = $col_props->[$j]->{min_w} || 0;;
+ }
+
+ my $span = 0;
+ # Calculate how much can be added to every column to fit the available width
+ $span = ($avail_width - $min_width) / scalar( @$col_props);
+ for (my $j = 0; $j < scalar(@$col_props); $j++ ) {
+ $calc_widths->[$j] = $col_props->[$j]->{min_w} + $span;
+ }
+
+ return ($calc_widths,$avail_width);
}
1;
$some_data,
x => $left_edge_of_table,
w => 495,
- start_y => 750,
- next_y => 700,
+ start_y => 500,
start_h => 300,
- next_h => 500,
# some optional params
+ next_y => 750,
+ next_h => 500,
padding => 5,
padding_right => 10,
background_color_odd => "gray",
=head1 DESCRIPTION
This class is a utility for use with the PDF::API2 module from CPAN.
-It can be used to display text data in a table layout within the PDF.
-The text data must be in a 2d array (such as returned by a DBI statement handle fetchall_arrayref() call).
+It can be used to display text data in a table layout within a PDF.
+The text data must be in a 2D array (such as returned by a DBI statement handle fetchall_arrayref() call).
The PDF::Table will automatically add as many new pages as necessary to display all of the data.
Various layout properties, such as font, font size, and cell padding and background color can be specified for each column and/or for even/odd rows.
Also a (non)repeated header row with different layout properties can be specified.
-See the METHODS section for complete documentation of every parameter.
+See the L</METHODS> section for complete documentation of every parameter.
-=head1 METHODS
+=head1 METHODS
-=head2 new
+=head2 new()
+
+ my $pdf_table = new PDF::Table;
=over
-Returns an instance of the class. There are no parameters.
+=item Description
+
+Creates a new instance of the class. (to be improved)
+
+=item Parameters
+
+There are no parameters.
+
+=item Returns
+
+Reference to the new instance
=back
-=head2 table($pdf, $page_obj, $data, %opts)
+=head2 table()
+
+ my ($final_page, $number_of_pages, $final_y) = table($pdf, $page, $data, %settings)
=over
-The main method of this class.
-Takes a PDF::API2 instance, a page instance, some data to build the table and formatting options.
-The formatting options should be passed as named parameters.
+=item Description
+
+Generates a multi-row, multi-column table into an existing PDF document based on provided data set and settings.
+
+=item Parameters
+
+ $pdf - a PDF::API2 instance representing the document being created
+ $page - a PDF::API2::Page instance representing the current page of the document
+ $data - an ARRAY reference to a 2D data structure that will be used to build the table
+ %settings - HASH with geometry and formatting parameters.
+
+For full %settings description see section L</Table settings> below.
+
This method will add more pages to the pdf instance as required based on the formatting options and the amount of data.
+=item Returns
+
+The return value is a 3 items list where
+
+ $final_page - The first item is a PDF::API2::Page instance that the table ends on
+ $number_of_pages - The second item is the count of pages that the table spans on
+ $final_y - The third item is the Y coordinate of the table bottom so that additional content can be added in the same document.
+
+=item Example
+
+ my $pdf = new PDF::API2;
+ my $page = $pdf->page();
+ my $data = [
+ ['foo1','bar1','baz1'],
+ ['foo2','bar2','baz2']
+ ];
+ my %settings = (
+ x => 10,
+ w => 570,
+ start_y => 220,
+ start_h => 180,
+ );
+
+ my ($final_page, $number_of_pages, $final_y) = $pdftable->table( $pdf, $page, $data, %options );
+
=back
+=head3 Table settings
+
+=head4 Mandatory
+
+There are some mandatory parameteres for setting table geometry and position across page(s)
+
=over
-The return value is a 3 item list where
-The first item is the PDF::API2::Page instance that the table ends on,
-The second item is the count of pages that the table spans, and
-The third item is the y position of the table bottom.
+=item B<x> - X coordinate of upper left corner of the table. Left edge of the sheet is 0.
+
+B<Value:> can be any whole number satisfying 0 =< X < PageWidth
+B<Default:> No default value
+
+ x => 10
+
+=item B<start_y> - Y coordinate of upper left corner of the table at the initial page.
+
+B<Value:> can be any whole number satisfying 0 < start_y < PageHeight (depending on space availability when embedding a table)
+B<Default:> No default value
+
+ start_y => 327
+
+=item B<w> - width of the table starting from X.
+
+B<Value:> can be any whole number satisfying 0 < w < PageWidth - x
+B<Default:> No default value
+
+ w => 570
+
+=item B<start_h> - Height of the table on the initial page
+
+B<Value:> can be any whole number satisfying 0 < start_h < PageHeight - Current Y position
+B<Default:> No default value
+
+ start_h => 250
=back
+=head4 Optional
+
=over
-=item Example:
-
- ($end_page, $pages_spanned, $table_bot_y) = $pdftable->table(
- $pdf, # A PDF::API2 instance
- $page_to_start_on, # A PDF::API2::Page instance created with $page_to_start_on = $pdf->page();
- $data, # 2D arrayref of text strings
- x => $left_edge_of_table, #X - coordinate of upper left corner
- w => 570, # width of table.
- start_y => $initial_y_position_on_first_page,
- next_y => $initial_y_position_on_every_new_page,
- start_h => $table_height_on_first_page,
- next_h => $table_height_on_every_new_page,
- #OPTIONAL PARAMS BELOW
- max_word_length=> 20, # add a space after every 20th symbol in long words like serial numbers
- padding => 5, # cell padding
- padding_top => 10, # top cell padding, overides padding
- padding_right => 10, # right cell padding, overides padding
- padding_left => 10, # left cell padding, overides padding
- padding_bottom => 10, # bottom padding, overides -padding
- border => 1, # border width, default 1, use 0 for no border
- border_color => 'red',# default black
- font => $pdf->corefont("Helvetica", -encoding => "utf8"), # default font
- font_size => 12,
- font_color_odd => 'purple',
- font_color_even=> 'black',
- background_color_odd => 'gray', #cell background color for odd rows
- background_color_even => 'lightblue', #cell background color for even rows
- new_page_func => $code_ref, # see section TABLE SPANNING
- header_props => $hdr_props, # see section HEADER ROW PROPERTIES
- column_props => $col_props, # see section COLUMN PROPERTIES
- cell_props => $row_props, # see section CELL PROPERTIES
- )
+=item B<next_h> - Height of the table on any additional page
+
+B<Value:> can be any whole number satisfying 0 < next_h < PageHeight
+B<Default:> Value of param B<'start_h'>
+
+ next_h => 700
+
+=item B<next_y> - Y coordinate of upper left corner of the table at any additional page.
+
+B<Value:> can be any whole number satisfying 0 < next_y < PageHeight
+B<Default:> Value of param B<'start_y'>
+
+ next_y => 750
+
+=item B<max_word_length> - Breaks long words (like serial numbers hashes etc.) by adding a space after every Nth symbol
+
+B<Value:> can be any whole positive number
+B<Default:> 20
+
+ max_word_length => 20 # Will add a space after every 20 symbols
+
+=item B<padding> - Padding applied to every cell
+
+=item B<padding_top> - top cell padding, overrides 'padding'
+
+=item B<padding_right> - right cell padding, overrides 'padding'
+
+=item B<padding_left> - left cell padding, overrides 'padding'
+
+=item B<padding_bottom> - bottom padding, overrides 'padding'
+
+B<Value:> can be any whole positive number
+
+B<Default padding:> 0
+
+B<Default padding_*> $padding
+
+ padding => 5 # all sides cell padding
+ padding_top => 8, # top cell padding, overrides 'padding'
+ padding_right => 6, # right cell padding, overrides 'padding'
+ padding_left => 2, # left cell padding, overrides 'padding'
+ padding_bottom => undef # bottom padding will be 5 as it will fallback to 'padding'
+
+=item B<border> - Width of table border lines.
+
+=item B<horizontal_borders> - Width of horizontal border lines. Overrides 'border' value.
+
+=item B<vertical_borders> - Width of vertical border lines. Overrides 'border' value.
+
+B<Value:> can be any whole positive number. When set to 0 will disable border lines.
+B<Default:> 1
+
+ border => 3 # border width is 3
+ horizontal_borders => 1 # horizontal borders will be 1 overriding 3
+ vertical_borders => undef # vertical borders will be 3 as it will fallback to 'border'
+
+=item B<vertical_borders> - Width of vertical border lines. Overrides 'border' value.
+
+B<Value:> Color specifier as 'name' or 'HEX'
+B<Default:> 'black'
+
+ border_color => 'red'
+
+=item B<font> - instance of PDF::API2::Resource::Font defining the fontf to be used in the table
+
+B<Value:> can be any PDF::API2::Resource::* type of font
+B<Default:> 'Times' with UTF8 encoding
+
+ font => $pdf->corefont("Helvetica", -encoding => "utf8")
+
+=item B<font_size> - Default size of the font that will be used across the table
+
+B<Value:> can be any positive number
+B<Default:> 12
+
+ font_size => 16
+
+=item B<font_color> - Font color for all rows
+
+=item B<font_color_odd> - Font color for odd rows
+
+=item B<font_color_even> - Font color for even rows
+
+=item B<font_underline> - Font underline of the header row
+
+B<Value:> 'auto', integer of distance, or arrayref of distance & thickness (more than one pair will provide mlultiple underlines. Negative distance gives strike-through.
+B<Default:> none
+
+=item B<background_color_odd> - Background color for odd rows
+
+=item B<background_color_even> - Background color for even rows
+
+B<Value:> Color specifier as 'name' or 'HEX'
+B<Default:> 'black' font on 'white' background
+
+ font_color => '#333333'
+ font_color_odd => 'purple'
+ font_color_even => '#00FF00'
+ background_color_odd => 'gray'
+ background_color_even => 'lightblue'
+
+=item B<row_height> - Desired row height but it will be honored only if row_height > font_size + padding_top + padding_bottom
+
+B<Value:> can be any whole positive number
+B<Default:> font_size + padding_top + padding_bottom
+
+ row_height => 24
+
+=item B<new_page_func> - CODE reference to a function that returns a PDF::API2::Page instance.
+
+If used the parameter 'new_page_func' must be a function reference which when executed will create a new page and will return the object back to the module.
+For example you can use it to put Page Title, Page Frame, Page Numbers and other staff that you need.
+Also if you need some different type of paper size and orientation than the default A4-Portrait for example B2-Landscape you can use this function ref to set it up for you. For more info about creating pages refer to PDF::API2 PAGE METHODS Section.
+Don't forget that your function must return a page object created with PDF::API2 page() method.
+
+ new_page_func => $code_ref
+
+=item B<header_props> - HASH reference to specific settings for the Header row of the table. See section L</Header Row Properties> below
+
+ header_props => $hdr_props
+
+=item B<column_props> - HASH reference to specific settings for each column of the table. See section L</Column Properties> below
+
+ column_props => $col_props
+
+=item B<cell_props> - HASH reference to specific settings for each column of the table. See section L</Cell Properties> below
+
+ cell_props => $cel_props
+
+=item B<cell_render_hook> - CODE reference to a function called with the current cell coordinates. If used the parameter 'cell_render_hook' must be a function reference. It is most useful for creating a url link inside of a cell. The following example adds a link in the first column of each non-header row:
+
+ cell_render_hook => sub {
+ my ($page, $first_row, $row, $col, $x, $y, $w, $h) = @_;
+
+ # Do nothing except for first column (and not a header row)
+ return unless ($col == 0);
+ return if ($first_row);
+
+ # Create link
+ my $value = $list_of_vals[$row-1];
+ my $url = "https://${hostname}/app/${value}";
+
+ my $annot = $page->annotation();
+ $annot->url( $url, -rect => [$x, $y, $x+$w, $y+$h] );
+ },
=back
+=head4 Header Row Properties
+
+If the 'header_props' parameter is used, it should be a hashref. Passing an empty HASH will trigger a header row initialised with Default values.
+There is no 'data' variable for the content, because the module asumes that first table row will become the header row. It will copy this row and put it on every new page if 'repeat' param is set.
+
=over
-=item HEADER ROW PROPERTIES
+=item B<font> - instance of PDF::API2::Resource::Font defining the fontf to be used in the header row
-If the 'header_props' parameter is used, it should be a hashref.
-It is your choice if it will be anonymous inline hash or predefined one.
-Also as you can see there is no data variable for the content because the module asumes that the first table row will become the header row. It will copy this row and put it on every new page if 'repeat' param is set.
+B<Value:> can be any PDF::API2::Resource::* type of font
+B<Default:> 'font' of the table. See table parameter 'font' for more details.
-=back
+=item B<font_size> - Font size of the header row
+
+B<Value:> can be any positive number
+B<Default:> 'font_size' of the table + 2
+
+=item B<font_color> - Font color of the header row
+
+B<Value:> Color specifier as 'name' or 'HEX'
+B<Default:> '#000066'
+
+=item B<font_underline> - Font underline of the header row
+
+B<Value:> 'auto', integer of distance, or arrayref of distance & thickness (more than one pair will provide mlultiple underlines. Negative distance gives strike-through.
+B<Default:> none
+
+=item B<bg_color> - Background color of the header row
+
+B<Value:> Color specifier as 'name' or 'HEX'
+B<Default:> #FFFFAA
+
+=item B<repeat> - Flag showing if header row should be repeated on every new page
- $hdr_props =
+B<Value:> 0,1 1-Yes/True, 0-No/False
+B<Default:> 0
+
+=item B<justify> - Alignment of text in the header row.
+
+B<Value:> One of 'left', 'right', 'center'
+B<Default:> Same as column alignment (or 'left' if undefined)
+
+ my $hdr_props =
{
- # This param could be a pdf core font or user specified TTF.
- # See PDF::API2 FONT METHODS for more information
- font => $pdf->corefont("Times", -encoding => "utf8"),
- font_size => 10,
- font_color => '#006666',
+ font => $pdf->corefont("Helvetica", -encoding => "utf8"),
+ font_size => 18,
+ font_color => '#004444',
bg_color => 'yellow',
- repeat => 1, # 1/0 eq On/Off if the header row should be repeated to every new page
+ repeat => 1,
+ justify => 'center'
};
-=over
+=back
-=item COLUMN PROPERTIES
+=head4 Column Properties
If the 'column_props' parameter is used, it should be an arrayref of hashrefs,
with one hashref for each column of the table. The columns are counted from left to right so the hash reference at $col_props[0] will hold properties for the first column from left to right.
Each hashref can contain any of the keys shown below:
-=back
+=over
- $col_props = [
- {},# This is an empty hash so the next one will hold the properties for the second row from left to right.
- {
- min_w => 100, # Minimum column width.
- justify => 'right', # One of left|right ,
- font => $pdf->corefont("Times", -encoding => "latin1"),
- font_size => 10,
- font_color=> 'blue',
- background_color => '#FFFF00',
- },
- # etc.
- ];
+=item B<min_w> - Minimum width of this column. Auto calculation will try its best to honour this param but aplying it is NOT guaranteed.
-=over
+B<Value:> can be any whole number satisfying 0 < min_w < w
+B<Default:> Auto calculated
+
+=item B<max_w> - Maximum width of this column. Auto calculation will try its best to honour this param but aplying it is NOT guaranteed.
+
+B<Value:> can be any whole number satisfying 0 < max_w < w
+B<Default:> Auto calculated
+
+=item B<font> - instance of PDF::API2::Resource::Font defining the fontf to be used in this column
+
+B<Value:> can be any PDF::API2::Resource::* type of font
+B<Default:> 'font' of the table. See table parameter 'font' for more details.
+
+=item B<font_size> - Font size of this column
+
+B<Value:> can be any positive number
+B<Default:> 'font_size' of the table.
+
+=item B<font_color> - Font color of this column
+
+B<Value:> Color specifier as 'name' or 'HEX'
+B<Default:> 'font_color' of the table.
+
+=item B<font_underline> - Font underline of this cell
+
+B<Value:> 'auto', integer of distance, or arrayref of distance & thickness (more than one pair will provide mlultiple underlines. Negative distance gives strike-through.
+B<Default:> none
-If the 'min_w' parameter is used for 'col_props', have in mind that it can be overwritten
-by the calculated minimum cell witdh if the userdefined value is less that calculated.
-This is done for safety reasons.
-In cases of a conflict between column formatting and odd/even row formatting,
-the former will override the latter.
+=item B<background_color> - Background color of this column
+
+B<Value:> Color specifier as 'name' or 'HEX'
+B<Default:> undef
+
+=item B<justify> - Alignment of text in this column
+
+B<Value:> One of 'left', 'right', 'center'
+B<Default:> 'left'
+
+Example:
+
+ my $col_props = [
+ {},# This is an empty hash so the next one will hold the properties for the second column from left to right.
+ {
+ min_w => 100, # Minimum column width of 100.
+ max_w => 150, # Maximum column width of 150 .
+ justify => 'right', # Right text alignment
+ font => $pdf->corefont("Helvetica", -encoding => "latin1"),
+ font_size => 10,
+ font_color=> 'blue',
+ background_color => '#FFFF00',
+ },
+ # etc.
+ ];
=back
-=over
+NOTE: If 'min_w' and/or 'max_w' parameter is used in 'col_props', have in mind that it may be overridden by the calculated minimum/maximum cell witdh so that table can be created.
+When this happens a warning will be issued with some advises what can be done.
+In cases of a conflict between column formatting and odd/even row formatting, 'col_props' will override odd/even.
-=item CELL PROPERTIES
+=head4 Cell Properties
If the 'cell_props' parameter is used, it should be an arrayref with arrays of hashrefs
(of the same dimension as the data array) with one hashref for each cell of the table.
-Each hashref can contain any of keys shown here:
-
-=back
- $cell_props = [
- [ #This array is for the first row. If header_props is defined it will overwrite this settings.
- {#Row 1 cell 1
- background_color => '#AAAA00',
- font_color => 'blue',
- },
- # etc.
- ],
- [ #Row 2
- {#Row 2 cell 1
- background_color => '#CCCC00',
- font_color => 'blue',
- },
- {#Row 2 cell 2
- background_color => '#CCCC00',
- font_color => 'blue',
- },
- # etc.
- ],
- # etc.
- ];
+Each hashref can contain any of the keys shown below:
=over
-In case of a conflict between column, odd/even and cell formating, cell formating will overwrite the other two.
-In case of a conflict between header row cell formating, header formating will win.
+=item B<font> - instance of PDF::API2::Resource::Font defining the fontf to be used in this cell
-=back
+B<Value:> can be any PDF::API2::Resource::* type of font
+B<Default:> 'font' of the table. See table parameter 'font' for more details.
-=over
+=item B<font_size> - Font size of this cell
+B<Value:> can be any positive number
+B<Default:> 'font_size' of the table.
+=item B<font_color> - Font color of this cell
-=item TABLE SPANNING
+B<Value:> Color specifier as 'name' or 'HEX'
+B<Default:> 'font_color' of the table.
-If used the parameter 'new_page_func' must be a function reference which when executed will create a new page and will return the object back to the module.
-For example you can use it to put Page Title, Page Frame, Page Numbers and other staff that you need.
-Also if you need some different type of paper size and orientation than the default A4-Portrait for example B2-Landscape you can use this function ref to set it up for you. For more info about creating pages refer to PDF::API2 PAGE METHODS Section.
-Dont forget that your function must return a page object created with PDF::API2 page() method.
+=item B<font_underline> - Font underline of this cell
+
+B<Value:> 'auto', integer of distance, or arrayref of distance & thickness (more than one pair will provide mlultiple underlines. Negative distance gives strike-through.
+B<Default:> none
+
+=item B<background_color> - Background color of this cell
+
+B<Value:> Color specifier as 'name' or 'HEX'
+B<Default:> undef
+
+=item B<justify> - Alignment of text in this cell
+
+B<Value:> One of 'left', 'right', 'center'
+B<Default:> 'left'
+
+Example:
+
+ my $cell_props = [
+ [ #This array is for the first row. If header_props is defined it will overwrite these settings.
+ { #Row 1 cell 1
+ background_color => '#AAAA00',
+ font_color => 'yellow',
+ font_underline => [ 2, 2 ],
+ },
+
+ # etc.
+ ],
+ [#Row 2
+ { #Row 2 cell 1
+ background_color => '#CCCC00',
+ font_color => 'blue',
+ },
+ { #Row 2 cell 2
+ background_color => '#BBBB00',
+ font_color => 'red',
+ },
+ # etc.
+ ],
+ # etc.
+ ];
+
+ OR
+
+ my $cell_props = [];
+ $cell_props->[1][0] = {
+ #Row 2 cell 1
+ background_color => '#CCCC00',
+ font_color => 'blue',
+ };
=back
-=head2 text_block( $txtobj, $string, x => $x, y => $y, w => $width, h => $height)
+NOTE: In case of a conflict between column, odd/even and cell formatting, cell formatting will overwrite the other two.
+In case of a conflict between header row and cell formatting, header formatting will override cell.
+
+=head2 text_block()
+
+ my ($width_of_last_line, $ypos_of_last_line, $left_over_text) = text_block( $txt, $data, %settings)
=over
+=item Description
+
Utility method to create a block of text. The block may contain multiple paragraphs.
-It is mainly used internaly but you can use it from outside for placing formated text anywhere on the sheet.
+It is mainly used internaly but you can use it from outside for placing formatted text anywhere on the sheet.
-=back
+NOTE: This method will NOT add more pages to the pdf instance if the space is not enough to place the string inside the block.
+Leftover text will be returned and has to be handled by the caller - i.e. add a new page and a new block with the leftover.
-=over
+=item Parameters
-=item Example:
+ $txt - a PDF::API2::Page::Text instance representing the text tool
+ $data - a string that will be placed inside the block
+ %settings - HASH with geometry and formatting parameters.
-=back
+=item Reuturns
-=over
+The return value is a 3 items list where
- # PDF::API2 objects
- my $page = $pdf->page;
- my $txt = $page->text;
+ $width_of_last_line - Width of last line in the block
+ $final_y - The Y coordinate of the block bottom so that additional content can be added after it
+ $left_over_text - Text that was did not fit in the provided box geometry.
-=back
+=item Example
-=over
+ # PDF::API2 objects
+ my $page = $pdf->page;
+ my $txt = $page->text;
+
+ my %settings = (
+ x => 10,
+ y => 570,
+ w => 220,
+ h => 180
- ($width_of_last_line, $ypos_of_last_line, $left_over_text) = $pdftable->text_block(
- $txt,
- $text_to_place,
- #X,Y - coordinates of upper left corner
- x => $left_edge_of_block,
- y => $y_position_of_first_line,
- w => $width_of_block,
- h => $height_of_block,
- #OPTIONAL PARAMS
- lead => $font_size | $distance_between_lines,
- align => "left|right|center|justify|fulljustify",
- hang => $optional_hanging_indent,
- Only one of the subsequent 3params can be given.
- They override each other.-parspace is the weightest
- parspace => $optional_vertical_space_before_first_paragraph,
- flindent => $optional_indent_of_first_line,
- fpindent => $optional_indent_of_first_paragraph,
-
- indent => $optional_indent_of_text_to_every_non_first_line,
- );
+ #OPTIONAL PARAMS
+ lead => $font_size | $distance_between_lines,
+ align => "left|right|center|justify|fulljustify",
+ hang => $optional_hanging_indent,
+ Only one of the subsequent 3params can be given.
+ They override each other.-parspace is the weightest
+ parspace => $optional_vertical_space_before_first_paragraph,
+ flindent => $optional_indent_of_first_line,
+ fpindent => $optional_indent_of_first_paragraph,
+ indent => $optional_indent_of_text_to_every_non_first_line,
+ );
+ my ( $width_of_last_line, $final_y, $left_over_text ) = $pdftable->text_block( $txt, $data, %settings );
=back
+=head1 VERSION
+
+0.9.7
+
=head1 AUTHOR
Daemmon Hughes
=head1 DEVELOPMENT
-ALL IMPROVEMENTS and BUGS Since Ver: 0.02
-
-Desislav Kamenov
-
-=head1 VERSION
-
-0.9.3
+Further development since Ver: 0.02 - Desislav Kamenov
=head1 COPYRIGHT AND LICENSE
=head1 PLUGS
-by Daemmon Hughes
+=over
+
+=item by Daemmon Hughes
Much of the work on this module was sponsered by
Stone Environmental Inc. (www.stone-env.com).
The text_block() method is a slightly modified copy of the one from
Rick Measham's PDF::API2 tutorial at
http://pdfapi2.sourceforge.net/cgi-bin/view/Main/YourFirstDocument
-update: The tutorial is no longer available. Please visit http://pdfapi2.sourceforge.net .
-by Desislav Kamenov
+=item by Desislav Kamenov (@deskata on Twitter)
+
+The development of this module was supported by SEEBURGER AG (www.seeburger.com) till year 2007
-The development of this module is sponsored by SEEBURGER AG (www.seeburger.com)
+Thanks to my friends Krasimir Berov and Alex Kantchev for helpful tips and QA during development of versions 0.9.0 to 0.9.5
-Thanks to my friends Krasimir Berov and Alex Kantchev for helpful tips and QA during development.
+Thanks to all GitHub contributors!
+
+=back
+
+=head1 CONTRIBUTION
+
+Hey PDF::Table is on GitHub. You are more than welcome to contribute!
+
+https://github.com/kamenov/PDF-Table
=head1 SEE ALSO
L<PDF::API2>
=cut
+
projects / kivitendo-erp.git / blobdiff