modules/override/PDF/Table.pm

   1 package PDF::Table;
   2
   3 use 5.006;
   4 use strict;
   5 use warnings;
   6 use Carp;
   7 use List::Util qw(sum);
   8 our $VERSION = '0.9.10';
   9
  10 print __PACKAGE__.' is version: '.$VERSION.$/ if($ENV{'PDF_TABLE_DEBUG'});
  11
  12 ############################################################
  13 #
  14 # new - Constructor
  15 #
  16 # Parameters are meta information about the PDF
  17 #
  18 # $pdf = PDF::Table->new();
  19 #
  20 ############################################################
  21
  22 sub new
  23 {
  24     my $type = shift(@_);
  25     my $class = ref($type) || $type;
  26     my $self  = {};
  27     bless ($self, $class);
  28
  29     # Pass all the rest to init for validation and initialisation
  30     $self->_init(@_);
  31
  32     return $self;
  33 }
  34
  35 sub _init
  36 {
  37     my ($self, $pdf, $page, $data, %options ) = @_;
  38
  39     # Check and set default values
  40     $self->set_defaults();
  41
  42     # Check and set mandatory params
  43     $self->set_pdf($pdf);
  44     $self->set_page($page);
  45     $self->set_data($data);
  46     $self->set_options(\%options);
  47
  48     return;
  49 }
  50
  51 sub set_defaults{
  52         my $self = shift;
  53
  54         $self->{'font_size'} = 12;
  55 }
  56
  57 sub set_pdf{
  58     my ($self, $pdf) = @_;
  59     $self->{'pdf'} = $pdf;
  60 }
  61
  62 sub set_page{
  63     my ($self, $page) = @_;
  64     if ( defined($page) && ref($page) ne 'PDF::API2::Page' ){
  65
  66         if( ref($self->{'pdf'}) eq 'PDF::API2' ){
  67             $self->{'page'} = $self->{'pdf'}->page();
  68         } else {
  69             carp 'Warning: Page must be a PDF::API2::Page object but it seems to be: '.ref($page).$/;
  70             carp 'Error: Cannot set page from passed PDF object either as it is invalid!'.$/;
  71         }
  72         return;
  73     }
  74     $self->{'page'} = $page;
  75
  76 }
  77
  78 sub set_data{
  79     my ($self, $data) = @_;
  80     #TODO: implement
  81 }
  82
  83 sub set_options{
  84     my ($self, $options) = @_;
  85     #TODO: implement
  86 }
  87
  88 ############################################################
  89 #
  90 # text_block - utility method to build multi-paragraph blocks of text
  91 #
  92 ############################################################
  93
  94 sub text_block
  95 {
  96     my $self        = shift;
  97     my $text_object = shift;
  98     my $text        = shift;    # The text to be displayed
  99     my %arg         = @_;       # Additional Arguments
 100
 101     my  ( $align, $xpos, $ypos, $xbase, $ybase, $line_width, $wordspace, $endw , $width, $height) =
 102         ( undef , undef, undef, undef , undef , undef      , undef     , undef , undef , undef  );
 103     my @line        = ();       # Temp data array with words on one line
 104     my %width       = ();       # The width of every unique word in the givven text
 105
 106     # Try to provide backward compatibility
 107     foreach my $key (keys %arg)
 108     {
 109         my $newkey = $key;
 110         if($newkey =~ s#^-##)
 111         {
 112             $arg{$newkey} = $arg{$key};
 113             delete $arg{$key};
 114         }
 115     }
 116     #####
 117
 118     #---
 119     # Lets check mandatory parameters with no default values
 120     #---
 121     $xbase  = $arg{'x'} || -1;
 122     $ybase  = $arg{'y'} || -1;
 123     $width  = $arg{'w'} || -1;
 124     $height = $arg{'h'} || -1;
 125     unless( $xbase  > 0 ){ carp "Error: Left Edge of Block is NOT defined!\n";  return; }
 126     unless( $ybase  > 0 ){ carp "Error: Base Line of Block is NOT defined!\n"; return; }
 127     unless( $width  > 0 ){ carp "Error: Width of Block is NOT defined!\n";  return; }
 128     unless( $height > 0 ){ carp "Error: Height of Block is NOT defined!\n"; return; }
 129     # Check if any text to display
 130     unless( defined( $text) and length($text) > 0 )
 131     {
 132         carp "Warning: No input text found. Trying to add dummy '-' and not to break everything.\n";
 133         $text = '-';
 134     }
 135
 136     # Strip any <CR> and Split the text into paragraphs
 137     $text =~ s/\r//g;
 138     my @paragraphs  = split(/\n/, $text);
 139
 140     # Width between lines in pixels
 141     my $line_space = defined $arg{'lead'} && $arg{'lead'} > 0 ? $arg{'lead'} : 12;
 142
 143     # Calculate width of all words
 144     my $space_width = $text_object->advancewidth("\x20");
 145     my @words = split(/\s+/, $text);
 146     foreach (@words)
 147     {
 148         next if exists $width{$_};
 149         $width{$_} = $text_object->advancewidth($_);
 150     }
 151
 152     my @paragraph = split(' ', shift(@paragraphs));
 153     my $first_line = 1;
 154     my $first_paragraph = 1;
 155
 156     # Little Init
 157     $xpos = $xbase;
 158     $ypos = $ybase;
 159     $ypos = $ybase + $line_space;
 160     my $bottom_border = $ypos - $height;
 161     # While we can add another line
 162     while ( $ypos >= $bottom_border + $line_space )
 163     {
 164         # Is there any text to render ?
 165         unless (@paragraph)
 166         {
 167             # Finish if nothing left
 168             last unless scalar @paragraphs;
 169             # Else take one line from the text
 170             @paragraph = split(' ', shift( @paragraphs ) );
 171
 172             $ypos -= $arg{'parspace'} if $arg{'parspace'};
 173             last unless $ypos >= $bottom_border;
 174         }
 175         $ypos -= $line_space;
 176         $xpos = $xbase;
 177
 178         # While there's room on the line, add another word
 179         @line = ();
 180         $line_width = 0;
 181         if( $first_line && exists $arg{'hang'} )
 182         {
 183             my $hang_width = $text_object->advancewidth($arg{'hang'});
 184
 185             $text_object->translate( $xpos, $ypos );
 186             $text_object->text( $arg{'hang'} );
 187
 188             $xpos         += $hang_width;
 189             $line_width   += $hang_width;
 190             $arg{'indent'} += $hang_width if $first_paragraph;
 191         }
 192         elsif( $first_line && exists $arg{'flindent'} && $arg{'flindent'} > 0 )
 193         {
 194             $xpos += $arg{'flindent'};
 195             $line_width += $arg{'flindent'};
 196         }
 197         elsif( $first_paragraph && exists $arg{'fpindent'} && $arg{'fpindent'} > 0 )
 198         {
 199             $xpos += $arg{'fpindent'};
 200             $line_width += $arg{'fpindent'};
 201         }
 202         elsif (exists $arg{'indent'} && $arg{'indent'} > 0 )
 203         {
 204             $xpos += $arg{'indent'};
 205             $line_width += $arg{'indent'};
 206         }
 207
 208         # Lets take from paragraph as many words as we can put into $width - $indent;
 209         while ( @paragraph and $text_object->advancewidth( join("\x20", @line)."\x20" . $paragraph[0]) +
 210                                 $line_width < $width )
 211         {
 212             push(@line, shift(@paragraph));
 213         }
 214         $line_width += $text_object->advancewidth(join('', @line));
 215
 216         # calculate the space width
 217         if( $arg{'align'} eq 'fulljustify' or ($arg{'align'} eq 'justify' and @paragraph))
 218         {
 219             @line = split(//,$line[0]) if (scalar(@line) == 1) ;
 220             $wordspace = ($width - $line_width) / (scalar(@line) - 1);
 221             $align='justify';
 222         }
 223         else
 224         {
 225             $align=($arg{'align'} eq 'justify') ? 'left' : $arg{'align'};
 226             $wordspace = $space_width;
 227         }
 228         $line_width += $wordspace * (scalar(@line) - 1);
 229
 230         if( $align eq 'justify')
 231         {
 232             foreach my $word (@line)
 233             {
 234                 $text_object->translate( $xpos, $ypos );
 235                 $text_object->text( $word );
 236                 $xpos += ($width{$word} + $wordspace) if (@line);
 237             }
 238             $endw = $width;
 239         }
 240         else
 241         {
 242             # calculate the left hand position of the line
 243             if( $align eq 'right' )
 244             {
 245                 $xpos += $width - $line_width;
 246             }
 247             elsif( $align eq 'center' )
 248             {
 249                 $xpos += ( $width / 2 ) - ( $line_width / 2 );
 250             }
 251
 252             # render the line
 253             $text_object->translate( $xpos, $ypos );
 254             $endw = $text_object->text( join("\x20", @line));
 255         }
 256         $first_line = 0;
 257     }#End of while(
 258     unshift(@paragraphs, join(' ',@paragraph)) if scalar(@paragraph);
 259     return ($endw, $ypos, join("\n", @paragraphs))
 260 }
 261
 262
 263 ################################################################
 264 # table - utility method to build multi-row, multicolumn tables
 265 ################################################################
 266 sub table
 267 {
 268     my $self    = shift;
 269     my $pdf     = shift;
 270     my $page    = shift;
 271     my $data    = shift;
 272     my %arg     = @_;
 273
 274     #=====================================
 275     # Mandatory Arguments Section
 276     #=====================================
 277     unless($pdf and $page and $data)
 278     {
 279         carp "Error: Mandatory parameter is missing pdf/page/data object!\n";
 280         return;
 281     }
 282
 283     # Validate mandatory argument data type
 284     croak "Error: Invalid pdf object received."  unless (ref($pdf) eq 'PDF::API2');
 285     croak "Error: Invalid page object received." unless (ref($page) eq 'PDF::API2::Page');
 286     croak "Error: Invalid data received."        unless ((ref($data) eq 'ARRAY') && scalar(@$data));
 287     croak "Error: Missing required settings."    unless (scalar(keys %arg));
 288
 289     # Validate settings key
 290     my %valid_settings_key = (
 291         x                     => 1,
 292         w                     => 1,
 293         start_y               => 1,
 294         start_h               => 1,
 295         next_y                => 1,
 296         next_h                => 1,
 297         lead                  => 1,
 298         padding               => 1,
 299         padding_right         => 1,
 300         padding_left          => 1,
 301         padding_top           => 1,
 302         padding_bottom        => 1,
 303         background_color      => 1,
 304         background_color_odd  => 1,
 305         background_color_even => 1,
 306         border                => 1,
 307         border_color          => 1,
 308         horizontal_borders    => 1,
 309         vertical_borders      => 1,
 310         font                  => 1,
 311         font_size             => 1,
 312         font_color            => 1,
 313         font_color_even       => 1,
 314         background_color_odd  => 1,
 315         background_color_even => 1,
 316         row_height            => 1,
 317         new_page_func         => 1,
 318         header_props          => 1,
 319         column_props          => 1,
 320         cell_props            => 1,
 321         max_word_length       => 1,
 322         num_header_rows       => 1,
 323     );
 324     foreach my $key (keys %arg) {
 325         croak "Error: Invalid setting key '$key' received."
 326             unless (exists $valid_settings_key{$key});
 327     }
 328
 329     # Try to provide backward compatibility
 330     foreach my $key (keys %arg)
 331     {
 332         my $newkey = $key;
 333         if($newkey =~ s#^-##)
 334         {
 335             $arg{$newkey} = $arg{$key};
 336             delete $arg{$key};
 337         }
 338     }
 339
 340     ######
 341     #TODO: Add code for header props compatibility and col_props comp....
 342     ######
 343     my ( $xbase, $ybase, $width, $height ) = ( undef, undef, undef, undef );
 344     # Could be 'int' or 'real' values
 345     $xbase  = $arg{'x'      } || -1;
 346     $ybase  = $arg{'start_y'} || -1;
 347     $width  = $arg{'w'      } || -1;
 348     $height = $arg{'start_h'} || -1;
 349
 350     # Global geometry parameters are also mandatory.
 351     unless( $xbase  > 0 ){ carp "Error: Left Edge of Table is NOT defined!\n";  return; }
 352     unless( $ybase  > 0 ){ carp "Error: Base Line of Table is NOT defined!\n"; return; }
 353     unless( $width  > 0 ){ carp "Error: Width of Table is NOT defined!\n";  return; }
 354     unless( $height > 0 ){ carp "Error: Height of Table is NOT defined!\n"; return; }
 355
 356     # Ensure default values for -next_y and -next_h
 357     my $next_y  = $arg{'next_y'} || $arg{'start_y'} || 0;
 358     my $next_h  = $arg{'next_h'} || $arg{'start_h'} || 0;
 359
 360     # Create Text Object
 361     my $txt     = $page->text;
 362
 363     # Set Default Properties
 364     my $fnt_name    = $arg{'font'            } || $pdf->corefont('Times',-encode => 'utf8');
 365     my $fnt_size    = $arg{'font_size'       } || 12;
 366     my $max_word_len= $arg{'max_word_length' } || 20;
 367
 368     #=====================================
 369     # Table Header Section
 370     #=====================================
 371     # Disable header row into the table
 372     my $header_props = undef;
 373     my @header_rows;
 374     # Check if the user enabled it ?
 375     if(defined $arg{'header_props'} and ref( $arg{'header_props'}) eq 'HASH')
 376     {
 377         # Transfer the reference to local variable
 378         $header_props = $arg{'header_props'};
 379
 380         # Check other params and put defaults if needed
 381         $header_props->{'repeat'        } = $header_props->{'repeat'        } || 0;
 382         $header_props->{'font'          } = $header_props->{'font'          } || $fnt_name;
 383         $header_props->{'font_color'    } = $header_props->{'font_color'    } || '#000066';
 384         $header_props->{'font_size'     } = $header_props->{'font_size'     } || $fnt_size + 2;
 385         $header_props->{'bg_color'      } = $header_props->{'bg_color'      } || '#FFFFAA';
 386         $header_props->{'justify'       } = $header_props->{'justify'       };
 387         $header_props->{num_header_rows } = $arg{num_header_rows } || 1;
 388     }
 389     #=====================================
 390     # Other Parameters check
 391     #=====================================
 392     my $lead          = $arg{'lead'          } || $fnt_size;
 393     my $pad_left      = $arg{'padding_left'  } || $arg{'padding'} || 0;
 394     my $pad_right     = $arg{'padding_right' } || $arg{'padding'} || 0;
 395     my $pad_top       = $arg{'padding_top'   } || $arg{'padding'} || 0;
 396     my $pad_bot       = $arg{'padding_bottom'} || $arg{'padding'} || 0;
 397     my $line_w        = defined $arg{'border'} ? $arg{'border'} : 1 ;
 398     my $horiz_borders = defined $arg{'horizontal_borders'}
 399         ? $arg{'horizontal_borders'}
 400         : $line_w;
 401     my $vert_borders  = defined $arg{'vertical_borders'}
 402         ? $arg{'vertical_borders'}
 403         : $line_w;
 404
 405     my $background_color_even   = $arg{'background_color_even'  } || $arg{'background_color'} || undef;
 406     my $background_color_odd    = $arg{'background_color_odd'   } || $arg{'background_color'} || undef;
 407     my $font_color_even         = $arg{'font_color_even'        } || $arg{'font_color'      } || 'black';
 408     my $font_color_odd          = $arg{'font_color_odd'         } || $arg{'font_color'      } || 'black';
 409     my $border_color            = $arg{'border_color'           } || 'black';
 410
 411     my $min_row_h   = $fnt_size + $pad_top + $pad_bot;
 412     my $row_h       = defined ($arg{'row_height'})
 413                                 &&
 414                     ($arg{'row_height'} > $min_row_h)
 415                                 ?
 416                      $arg{'row_height'} : $min_row_h;
 417
 418     my $pg_cnt      = 1;
 419     my $cur_y       = $ybase;
 420     my $cell_props  = $arg{cell_props} || [];   # per cell properties
 421
 422     #If there is no valid data array reference warn and return!
 423     if(ref $data ne 'ARRAY')
 424     {
 425         carp "Passed table data is not an ARRAY reference. It's actually a ref to ".ref($data);
 426         return ($page,0,$cur_y);
 427     }
 428
 429     # Copy the header row if header is enabled
 430     if (defined $header_props) {
 431       map { push @header_rows, $$data[$_] } (0..$header_props->{num_header_rows} - 1);
 432     }
 433     # Determine column widths based on content
 434
 435     #  an arrayref whose values are a hashref holding
 436     #  the minimum and maximum width of that column
 437     my $col_props =  $arg{'column_props'} || [];
 438
 439     # An array ref of arrayrefs whose values are
 440     #  the actual widths of the column/row intersection
 441     my $row_col_widths = [];
 442     # An array ref with the widths of the header row
 443     my @header_row_props;
 444
 445     # Scalars that hold sum of the maximum and minimum widths of all columns
 446     my ( $max_col_w  , $min_col_w   ) = ( 0,0 );
 447     my ( $row, $col_name, $col_fnt_size, $space_w );
 448
 449     my $word_widths  = {};
 450     my $rows_height  = [];
 451
 452     for( my $row_idx = 0; $row_idx < scalar(@$data) ; $row_idx++ )
 453     {
 454         push @header_row_props, [] if $row_idx < $header_props->{num_header_rows};
 455
 456         my $column_widths = []; #holds the width of each column
 457         # Init the height for this row
 458         $rows_height->[$row_idx] = 0;
 459
 460         for( my $column_idx = 0; $column_idx < scalar(@{$data->[$row_idx]}) ; $column_idx++ )
 461         {
 462             # look for font information for this column
 463             my ($cell_font, $cell_font_size);
 464
 465             if( !$row_idx and ref $header_props )
 466             {
 467                 $cell_font      = $header_props->{'font'};
 468                 $cell_font_size = $header_props->{'font_size'};
 469             }
 470
 471             # Get the most specific value if none was already set from header_props
 472             $cell_font      ||= $cell_props->[$row_idx][$column_idx]->{'font'}
 473                             ||  $col_props->[$column_idx]->{'font'}
 474                             ||  $fnt_name;
 475
 476             $cell_font_size ||= $cell_props->[$row_idx][$column_idx]->{'font_size'}
 477                             ||  $col_props->[$column_idx]->{'font_size'}
 478                             ||  $fnt_size;
 479
 480             # Set Font
 481             $txt->font( $cell_font, $cell_font_size );
 482
 483             # Set row height to biggest font size from row's cells
 484             if( $cell_font_size  > $rows_height->[$row_idx] )
 485             {
 486                 $rows_height->[$row_idx] = $cell_font_size;
 487             }
 488
 489             # This should fix a bug with very long words like serial numbers etc.
 490             if( $max_word_len > 0 )
 491             {
 492                 $data->[$row_idx][$column_idx] =~ s#(\S{$max_word_len})(?=\S)#$1 #g;
 493             }
 494
 495             # Init cell size limits
 496             $space_w                      = $txt->advancewidth( "\x20" );
 497             $column_widths->[$column_idx] = 0;
 498             $max_col_w                    = 0;
 499             $min_col_w                    = 0;
 500
 501             my @words = split( /\s+/, $data->[$row_idx][$column_idx] );
 502
 503             foreach( @words )
 504             {
 505                 unless( exists $word_widths->{$_} )
 506                 {   # Calculate the width of every word and add the space width to it
 507                     $word_widths->{$_} = $txt->advancewidth( $_ ) + $space_w;
 508                 }
 509
 510                 $column_widths->[$column_idx] += $word_widths->{$_};
 511                 $min_col_w                     = $word_widths->{$_} if( $word_widths->{$_} > $min_col_w );
 512                 $max_col_w                    += $word_widths->{$_};
 513             }
 514
 515             $min_col_w                    += $pad_left + $pad_right;
 516             $max_col_w                    += $pad_left + $pad_right;
 517             $column_widths->[$column_idx] += $pad_left + $pad_right;
 518
 519             # Keep a running total of the overall min and max widths
 520             $col_props->[$column_idx]->{'min_w'} ||= 0;
 521             $col_props->[$column_idx]->{'max_w'} ||= 0;
 522
 523             if( $min_col_w > $col_props->[$column_idx]->{'min_w'} )
 524             {   # Calculated Minimum Column Width is more than user-defined
 525                 $col_props->[$column_idx]->{'min_w'} = $min_col_w ;
 526             }
 527
 528             if( $max_col_w > $col_props->[$column_idx]->{'max_w'} )
 529             {   # Calculated Maximum Column Width is more than user-defined
 530                 $col_props->[$column_idx]->{'max_w'} = $max_col_w ;
 531             }
 532         }#End of for(my $column_idx....
 533
 534         $row_col_widths->[$row_idx] = $column_widths;
 535
 536         # Copy the calculated row properties of header row.
 537         if (ref $header_props && $row_idx < $header_props->{num_header_rows}) {
 538           push @header_row_props, [ @{ $column_widths } ];
 539         }
 540     }
 541
 542     # Calc real column widths and expand table width if needed.
 543     my $calc_column_widths;
 544     ($calc_column_widths, $width) = CalcColumnWidths( $col_props, $width );
 545     my $num_cols = scalar @{ $calc_column_widths };
 546
 547     # Lets draw what we have!
 548     my $row_index    = 0;
 549     # Store header row height for later use if headers have to be repeated
 550     my @header_row_heights = @$rows_height[0 .. $header_props->{num_header_rows}-1];
 551
 552     my ( $gfx, $gfx_bg, $background_color, $font_color, $bot_marg, $table_top_y, $text_start);
 553
 554     my $remaining_header_rows = $header_props ? $header_props->{num_header_rows} : 0;
 555
 556     # Each iteration adds a new page as neccessary
 557     while(scalar(@{$data}))
 558     {
 559         my ($page_header, $columns_number);
 560
 561         if($pg_cnt == 1)
 562         {
 563             $table_top_y = $ybase;
 564             $bot_marg = $table_top_y - $height;
 565         }
 566         else
 567         {
 568             if(ref $arg{'new_page_func'})
 569             {
 570                 $page = &{$arg{'new_page_func'}};
 571             }
 572             else
 573             {
 574                 $page = $pdf->page;
 575             }
 576
 577             $table_top_y = $next_y;
 578             $bot_marg = $table_top_y - $next_h;
 579
 580             if( ref $header_props and $header_props->{'repeat'})
 581             {
 582                 for my $idx (0 .. $header_props->{num_header_rows} - 1) {
 583                   unshift @$data,           [ @{ $header_rows[$idx]      } ];
 584                   unshift @$row_col_widths, [ @{ $header_row_props[$idx] } ];
 585                   unshift @$rows_height,    $header_row_heights[$idx];
 586                 }
 587                 $remaining_header_rows = $header_props->{num_header_rows};
 588             }
 589         }
 590
 591         # Check for safety reasons
 592         if( $bot_marg < 0 )
 593         {   # This warning should remain i think
 594 #            carp "!!! Warning: !!! Incorrect Table Geometry! Setting bottom margin to end of sheet!\n";
 595             $bot_marg = 0;
 596         }
 597
 598         $gfx_bg = $page->gfx;
 599         $txt = $page->text;
 600         $txt->font($fnt_name, $fnt_size);
 601
 602         $cur_y = $table_top_y;
 603
 604         if ($line_w)
 605         {
 606             $gfx = $page->gfx;
 607             $gfx->strokecolor($border_color);
 608             $gfx->linewidth($line_w);
 609
 610             # Draw the top line
 611             if ($horiz_borders)
 612             {
 613                 $gfx->move( $xbase , $cur_y );
 614                 $gfx->hline($xbase + $width );
 615             }
 616         }
 617         else
 618         {
 619             $gfx = undef;
 620         }
 621
 622         # Each iteration adds a row to the current page until the page is full
 623         #  or there are no more rows to add
 624         # Row_Loop
 625         while(scalar(@{$data}) and $cur_y-$row_h > $bot_marg)
 626         {
 627             # Remove the next item from $data
 628             my $record = shift @{$data};
 629
 630             # Get columns number to know later how many vertical lines to draw
 631             # TODO: get the max number of columns per page as currently last row's columns overrides
 632             $columns_number = scalar(@$record);
 633
 634             # Get the next set of row related settings
 635             # Row Height
 636             my $pre_calculated_row_height = shift @$rows_height;
 637
 638             # Row cell widths
 639             my $record_widths = shift @$row_col_widths;
 640
 641             # Row coloumn props - TODO in another commit
 642
 643             # Row cell props - TODO in another commit
 644
 645             # Added to resolve infite loop bug with returned undef values
 646             for(my $d = 0; $d < scalar(@{$record}) ; $d++)
 647             {
 648                 $record->[$d] = '-' unless( defined $record->[$d]);
 649             }
 650
 651             # Choose colors for this row
 652             $background_color = $row_index % 2 ? $background_color_even  : $background_color_odd;
 653             $font_color       = $row_index % 2 ? $font_color_even        : $font_color_odd;
 654
 655             #Determine current row height
 656             my $current_row_height = $pad_top + $pre_calculated_row_height + $pad_bot;
 657
 658             # $row_h is the calculated global user requested row height.
 659             # It will be honored, only if it has bigger value than the calculated one.
 660             # TODO: It's questionable if padding should be inclided in this calculation or not
 661             if($current_row_height < $row_h){
 662                 $current_row_height = $row_h;
 663             }
 664
 665             # Define the font y base position for this line.
 666             $text_start      = $cur_y - ($current_row_height - $pad_bot);
 667
 668             my $cur_x        = $xbase;
 669             my $leftovers    = undef;   # Reference to text that is returned from textblock()
 670             my $do_leftovers = 0;
 671             my ($colspan, @vertical_lines);
 672
 673             # Process every cell(column) from current row
 674             for( my $column_idx = 0; $column_idx < scalar( @$record); $column_idx++ )
 675             {
 676                 next unless $col_props->[$column_idx]->{'max_w'};
 677                 next unless $col_props->[$column_idx]->{'min_w'};
 678                 $leftovers->[$column_idx] = undef;
 679
 680                 # look for font information for this cell
 681                 my ($cell_font, $cell_font_size, $cell_font_color, $justify);
 682
 683                 if( $remaining_header_rows and ref $header_props)
 684                 {
 685                     $cell_font       = $header_props->{'font'};
 686                     $cell_font_size  = $header_props->{'font_size'};
 687                     $cell_font_color = $header_props->{'font_color'};
 688                     $justify         = $header_props->{'justify'};
 689                 }
 690
 691                 # Get the most specific value if none was already set from header_props
 692                 $cell_font       ||= $cell_props->[$row_index][$column_idx]->{'font'}
 693                                  ||  $col_props->[$column_idx]->{'font'}
 694                                  ||  $fnt_name;
 695
 696                 $cell_font_size  ||= $cell_props->[$row_index][$column_idx]->{'font_size'}
 697                                  ||  $col_props->[$column_idx]->{'font_size'}
 698                                  ||  $fnt_size;
 699
 700                 $cell_font_color ||= $cell_props->[$row_index][$column_idx]->{'font_color'}
 701                                  ||  $col_props->[$column_idx]->{'font_color'}
 702                                  ||  $font_color;
 703
 704                 $justify         ||= $cell_props->[$row_index][$column_idx]->{'justify'}
 705                                  ||  $col_props->[$column_idx]->{'justify'}
 706                                  ||  $arg{'justify'}
 707                                  ||  'left';
 708
 709                 # Init cell font object
 710                 $txt->font( $cell_font, $cell_font_size );
 711                 $txt->fillcolor($cell_font_color);
 712
 713                 my $this_width;
 714                 if (!$remaining_header_rows && $cell_props->[$row_index][$column_idx]->{colspan}) {
 715                     $colspan     = -1 == $cell_props->[$row_index][$column_idx]->{colspan}
 716                                  ? $num_cols - $column_idx
 717                                  : $cell_props->[$row_index][$column_idx]->{colspan};
 718                     my $last_idx = $column_idx + $colspan - 1;
 719                     $this_width  = sum @{ $calc_column_widths }[$column_idx..$last_idx];
 720
 721                 } else {
 722                     $this_width = $calc_column_widths->[$column_idx];
 723                 }
 724
 725                 # If the content is wider than the specified width, we need to add the text as a text block
 726                 if( $record->[$column_idx] !~ m/(.\n.)/ and
 727                     $record_widths->[$column_idx] and
 728                     $record_widths->[$column_idx] <= $this_width
 729                 ){
 730                     my $space = $pad_left;
 731                     if ($justify eq 'right')
 732                     {
 733                         $space = $this_width -($txt->advancewidth($record->[$column_idx]) + $pad_right);
 734                     }
 735                     elsif ($justify eq 'center')
 736                     {
 737                         $space = ($this_width - $txt->advancewidth($record->[$column_idx])) / 2;
 738                     }
 739                     $txt->translate( $cur_x + $space, $text_start );
 740                     $txt->text( $record->[$column_idx] );
 741                 }
 742                 # Otherwise just use the $page->text() method
 743                 else
 744                 {
 745                     my ($width_of_last_line, $ypos_of_last_line, $left_over_text) = $self->text_block(
 746                         $txt,
 747                         $record->[$column_idx],
 748                         x        => $cur_x + $pad_left,
 749                         y        => $text_start,
 750                         w        => $this_width - $pad_left - $pad_right,
 751                         h        => $cur_y - $bot_marg - $pad_top - $pad_bot,
 752                         align    => $justify,
 753                         lead     => $lead
 754                     );
 755                     # Desi - Removed $lead because of fixed incorrect ypos bug in text_block
 756                     my  $current_cell_height = $cur_y - $ypos_of_last_line + $pad_bot;
 757                     if( $current_cell_height > $current_row_height )
 758                     {
 759                         $current_row_height = $current_cell_height;
 760                     }
 761
 762                     if( $left_over_text )
 763                     {
 764                         $leftovers->[$column_idx] = $left_over_text;
 765                         $do_leftovers = 1;
 766                     }
 767                 }
 768                 $cur_x += $calc_column_widths->[$column_idx];
 769
 770                 push @vertical_lines, (!$colspan || (1 >= $colspan)) ? 1 : 0;
 771                 $colspan-- if $colspan;
 772             }
 773             if( $do_leftovers )
 774             {
 775                 unshift @$data, $leftovers;
 776                 unshift @$row_col_widths, $record_widths;
 777                 unshift @$rows_height, $pre_calculated_row_height;
 778             }
 779
 780             # Draw cell bgcolor
 781             # This has to be separately from the text loop
 782             #  because we do not know the final height of the cell until all text has been drawn
 783             $cur_x = $xbase;
 784             for(my $column_idx = 0 ; $column_idx < scalar(@$record) ; $column_idx++)
 785             {
 786                 my $cell_bg_color;
 787
 788                 if( $remaining_header_rows and ref $header_props)
 789                 {                                  #Compatibility                 Consistency with other props
 790                     $cell_bg_color = $header_props->{'bg_color'} || $header_props->{'background_color'};
 791                 }
 792
 793                 # Get the most specific value if none was already set from header_props
 794                 $cell_bg_color ||= $cell_props->[$row_index][$column_idx]->{'background_color'}
 795                                ||  $col_props->[$column_idx]->{'background_color'}
 796                                ||  $background_color;
 797
 798                 if ($cell_bg_color)
 799                 {
 800                     $gfx_bg->rect( $cur_x, $cur_y-$current_row_height, $calc_column_widths->[$column_idx], $current_row_height);
 801                     $gfx_bg->fillcolor($cell_bg_color);
 802                     $gfx_bg->fill();
 803                 }
 804                 $cur_x += $calc_column_widths->[$column_idx];
 805
 806                 if ($line_w && $vertical_lines[$column_idx] && ($column_idx != (scalar(@{ $record }) - 1))) {
 807                     $gfx->move($cur_x, $cur_y);
 808                     $gfx->vline($cur_y - $row_h);
 809                     $gfx->fillcolor($border_color);
 810                 }
 811             }#End of for(my $column_idx....
 812
 813             $cur_y -= $current_row_height;
 814             if ($gfx && $horiz_borders)
 815             {
 816                 $gfx->move(  $xbase , $cur_y );
 817                 $gfx->hline( $xbase + $width );
 818             }
 819
 820             if ($remaining_header_rows) {
 821               $remaining_header_rows--;
 822             } else {
 823               $row_index++ unless $do_leftovers;
 824             }
 825         }# End of Row_Loop
 826
 827         if ($gfx)
 828         {
 829             # Draw vertical lines
 830             if ($vert_borders)
 831             {
 832                 $gfx->move(  $xbase, $table_top_y);
 833                 $gfx->vline( $cur_y );
 834                 $gfx->move($xbase + sum(@{ $calc_column_widths }[0..$num_cols - 1]), $table_top_y);
 835                 $gfx->vline( $cur_y );
 836             }
 837
 838             # ACTUALLY draw all the lines
 839             $gfx->fillcolor( $border_color);
 840             $gfx->stroke;
 841         }
 842         $pg_cnt++;
 843     }# End of while(scalar(@{$data}))
 844
 845     return ($page,--$pg_cnt,$cur_y);
 846 }
 847
 848
 849 # calculate the column widths
 850 sub CalcColumnWidths
 851 {
 852     my $col_props   = shift;
 853     my $avail_width = shift;
 854     my $min_width   = 0;
 855
 856     my $calc_widths ;
 857
 858     for(my $j = 0; $j < scalar( @$col_props); $j++)
 859     {
 860         $min_width += $col_props->[$j]->{min_w} || 0;
 861     }
 862
 863     # I think this is the optimal variant when good view can be guaranateed
 864     if($avail_width < $min_width)
 865     {
 866         carp "!!! Warning !!!\n Calculated Mininal width($min_width) > Table width($avail_width).\n",
 867             ' Expanding table width to:',int($min_width)+1,' but this could lead to unexpected results.',"\n",
 868             ' Possible solutions:',"\n",
 869             '  0)Increase table width.',"\n",
 870             '  1)Decrease font size.',"\n",
 871             '  2)Choose a more narrow font.',"\n",
 872             '  3)Decrease "max_word_length" parameter.',"\n",
 873             '  4)Rotate page to landscape(if it is portrait).',"\n",
 874             '  5)Use larger paper size.',"\n",
 875             '!!! --------- !!!',"\n";
 876         $avail_width = int( $min_width) + 1;
 877
 878     }
 879
 880     # Calculate how much can be added to every column to fit the available width.
 881     for(my $j = 0; $j < scalar(@$col_props); $j++ )
 882     {
 883         $calc_widths->[$j] = $col_props->[$j]->{min_w} || 0;;
 884     }
 885
 886     # Allow columns to expand to max_w before applying extra space equally.
 887     my $is_last_iter;
 888     for (;;)
 889     {
 890         my $span = ($avail_width - $min_width) / scalar( @$col_props);
 891         last if $span <= 0;
 892
 893         $min_width = 0;
 894         my $next_will_be_last_iter = 1;
 895         for(my $j = 0; $j < scalar(@$col_props); $j++ )
 896         {
 897             my $new_w = $calc_widths->[$j] + $span;
 898
 899             if (!$is_last_iter && $new_w > $col_props->[$j]->{max_w})
 900             {
 901                 $new_w = $col_props->[$j]->{max_w}
 902             }
 903             if ($calc_widths->[$j] != $new_w )
 904             {
 905                 $calc_widths->[$j] = $new_w;
 906                 $next_will_be_last_iter = 0;
 907             }
 908             $min_width += $new_w;
 909         }
 910         last if $is_last_iter;
 911         $is_last_iter = $next_will_be_last_iter;
 912     }
 913
 914     return ($calc_widths,$avail_width);
 915 }
 916 1;
 917
 918 __END__
 919
 920 =pod
 921
 922 =head1 NAME
 923
 924 PDF::Table - A utility class for building table layouts in a PDF::API2 object.
 925
 926 =head1 SYNOPSIS
 927
 928  use PDF::API2;
 929  use PDF::Table;
 930
 931  my $pdftable = new PDF::Table;
 932  my $pdf = new PDF::API2(-file => "table_of_lorem.pdf");
 933  my $page = $pdf->page;
 934
 935  # some data to layout
 936  my $some_data =[
 937     ["1 Lorem ipsum dolor",
 938     "Donec odio neque, faucibus vel",
 939     "consequat quis, tincidunt vel, felis."],
 940     ["Nulla euismod sem eget neque.",
 941     "Donec odio neque",
 942     "Sed eu velit."],
 943     #... and so on
 944  ];
 945
 946  $left_edge_of_table = 50;
 947  # build the table layout
 948  $pdftable->table(
 949      # required params
 950      $pdf,
 951      $page,
 952      $some_data,
 953      x => $left_edge_of_table,
 954      w => 495,
 955      start_y => 500,
 956      start_h => 300,
 957      # some optional params
 958      next_y  => 750,
 959      next_h  => 500,
 960      padding => 5,
 961      padding_right => 10,
 962      background_color_odd  => "gray",
 963      background_color_even => "lightblue", #cell background color for even rows
 964   );
 965
 966  # do other stuff with $pdf
 967  $pdf->saveas();
 968 ...
 969
 970 =head1 EXAMPLE
 971
 972 For a complete working example or initial script look into distribution`s 'examples' folder.
 973
 974
 975 =head1 DESCRIPTION
 976
 977 This class is a utility for use with the PDF::API2 module from CPAN.
 978 It can be used to display text data in a table layout within a PDF.
 979 The text data must be in a 2D array (such as returned by a DBI statement handle fetchall_arrayref() call).
 980 The PDF::Table will automatically add as many new pages as necessary to display all of the data.
 981 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.
 982 Also a (non)repeated header row with different layout properties can be specified.
 983
 984 See the L</METHODS> section for complete documentation of every parameter.
 985
 986 =head1 METHODS
 987
 988 =head2 new()
 989
 990     my $pdf_table = new PDF::Table;
 991
 992 =over
 993
 994 =item Description
 995
 996 Creates a new instance of the class. (to be improved)
 997
 998 =item Parameters
 999
1000 There are no parameters.
1001
1002 =item Returns
1003
1004 Reference to the new instance
1005
1006 =back
1007
1008 =head2 table()
1009
1010     my ($final_page, $number_of_pages, $final_y) = table($pdf, $page, $data, %settings)
1011
1012 =over
1013
1014 =item Description
1015
1016 Generates a multi-row, multi-column table into an existing PDF document based on provided data set and settings.
1017
1018 =item Parameters
1019
1020     $pdf      - a PDF::API2 instance representing the document being created
1021     $page     - a PDF::API2::Page instance representing the current page of the document
1022     $data     - an ARRAY reference to a 2D data structure that will be used to build the table
1023     %settings - HASH with geometry and formatting parameters.
1024
1025 For full %settings description see section L</Table settings> below.
1026
1027 This method will add more pages to the pdf instance as required based on the formatting options and the amount of data.
1028
1029 =item Reuturns
1030
1031 The return value is a 3 items list where
1032
1033     $final_page - The first item is a PDF::API2::Page instance that the table ends on
1034     $number_of_pages - The second item is the count of pages that the table spans on
1035     $final_y - The third item is the Y coordinate of the table bottom so that additional content can be added in the same document.
1036
1037 =item Example
1038
1039     my $pdf  = new PDF::API2;
1040     my $page = $pdf->page();
1041     my $data = [
1042         ['foo1','bar1','baz1'],
1043         ['foo2','bar2','baz2']
1044     ];
1045     my %settings = (
1046         x       => 10,
1047         w       => 570,
1048         start_y => 220,
1049         start_h => 180,
1050     );
1051
1052     my ($final_page, $number_of_pages, $final_y) = $pdftable->table( $pdf, $page, $data, %options );
1053
1054 =back
1055
1056 =head3 Table settings
1057
1058 =head4 Mandatory
1059
1060 There are some mandatory parameteres for setting table geometry and position across page(s)
1061
1062 =over
1063
1064 =item B<x> - X coordinate of upper left corner of the table. Left edge of the sheet is 0.
1065
1066 B<Value:> can be any whole number satisfying 0 =< X < PageWidth
1067 B<Default:> No default value
1068
1069     x => 10
1070
1071 =item B<start_y> - Y coordinate of upper left corner of the table at the initial page.
1072
1073 B<Value:> can be any whole number satisfying 0 < start_y < PageHeight (depending on space availability when embedding a table)
1074 B<Default:> No default value
1075
1076     start_y => 327
1077
1078 =item B<w> - width of the table starting from X.
1079
1080 B<Value:> can be any whole number satisfying 0 < w < PageWidth - x
1081 B<Default:> No default value
1082
1083     w  => 570
1084
1085 =item B<start_h> - Height of the table on the initial page
1086
1087 B<Value:> can be any whole number satisfying 0 < start_h < PageHeight - Current Y position
1088 B<Default:> No default value
1089
1090     start_h => 250
1091
1092 =back
1093
1094 =head4 Optional
1095
1096 =over
1097
1098 =item B<next_h> - Height of the table on any additional page
1099
1100 B<Value:> can be any whole number satisfying 0 < next_h < PageHeight
1101 B<Default:> Value of param B<'start_h'>
1102
1103     next_h  => 700
1104
1105 =item B<next_y> - Y coordinate of upper left corner of the table at any additional page.
1106
1107 B<Value:> can be any whole number satisfying 0 < next_y < PageHeight
1108 B<Default:> Value of param B<'start_y'>
1109
1110     next_y  => 750
1111
1112 =item B<max_word_length> - Breaks long words (like serial numbers hashes etc.) by adding a space after every Nth symbol
1113
1114 B<Value:> can be any whole positive number
1115 B<Default:> 20
1116
1117     max_word_length => 20    # Will add a space after every 20 symbols
1118
1119 =item B<padding> - Padding applied to every cell
1120
1121 =item B<padding_top>    - top cell padding, overrides 'padding'
1122
1123 =item B<padding_right>  - right cell padding, overrides 'padding'
1124
1125 =item B<padding_left>   - left cell padding, overrides 'padding'
1126
1127 =item B<padding_bottom> - bottom padding, overrides 'padding'
1128
1129 B<Value:> can be any whole positive number
1130
1131 B<Default padding:> 0
1132
1133 B<Default padding_*> $padding
1134
1135     padding        => 5      # all sides cell padding
1136     padding_top    => 8,     # top cell padding, overrides 'padding'
1137     padding_right  => 6,     # right cell padding, overrides 'padding'
1138     padding_left   => 2,     # left cell padding, overrides 'padding'
1139     padding_bottom => undef  # bottom padding will be 5 as it will fallback to 'padding'
1140
1141 =item B<border> - Width of table border lines.
1142
1143 =item B<horizontal_borders> - Width of horizontal border lines. Overrides 'border' value.
1144
1145 =item B<vertical_borders> -  Width of vertical border lines. Overrides 'border' value.
1146
1147 B<Value:> can be any whole positive number. When set to 0 will disable border lines.
1148 B<Default:> 1
1149
1150     border             => 3     # border width is 3
1151     horizontal_borders => 1     # horizontal borders will be 1 overriding 3
1152     vertical_borders   => undef # vertical borders will be 3 as it will fallback to 'border'
1153
1154 =item B<vertical_borders> -  Width of vertical border lines. Overrides 'border' value.
1155
1156 B<Value:> Color specifier as 'name' or 'HEX'
1157 B<Default:> 'black'
1158
1159     border_color => 'red'
1160
1161 =item B<font> - instance of PDF::API2::Resource::Font defining the fontf to be used in the table
1162
1163 B<Value:> can be any PDF::API2::Resource::* type of font
1164 B<Default:> 'Times' with UTF8 encoding
1165
1166     font => $pdf->corefont("Helvetica", -encoding => "utf8")
1167
1168 =item B<font_size> - Default size of the font that will be used across the table
1169
1170 B<Value:> can be any positive number
1171 B<Default:> 12
1172
1173     font_size => 16
1174
1175 =item B<font_color> - Font color for all rows
1176
1177 =item B<font_color_odd> - Font color for odd rows
1178
1179 =item B<font_color_even> - Font color for even rows
1180
1181 =item B<background_color_odd> - Background color for odd rows
1182
1183 =item B<background_color_even> - Background color for even rows
1184
1185 B<Value:> Color specifier as 'name' or 'HEX'
1186 B<Default:> 'black' font on 'white' background
1187
1188     font_color            => '#333333'
1189     font_color_odd        => 'purple'
1190     font_color_even       => '#00FF00'
1191     background_color_odd  => 'gray'
1192     background_color_even => 'lightblue'
1193
1194 =item B<row_height> - Desired row height but it will be honored only if row_height > font_size + padding_top + padding_bottom
1195
1196 B<Value:> can be any whole positive number
1197 B<Default:> font_size + padding_top + padding_bottom
1198
1199     row_height => 24
1200
1201 =item B<new_page_func> - CODE reference to a function that returns a PDF::API2::Page instance.
1202
1203 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.
1204 For example you can use it to put Page Title, Page Frame, Page Numbers and other staff that you need.
1205 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.
1206 Don't forget that your function must return a page object created with PDF::API2 page() method.
1207
1208     new_page_func  => $code_ref
1209
1210 =item B<header_props> - HASH reference to specific settings for the Header row of the table. See section L</Header Row Properties> below
1211
1212     header_props => $hdr_props
1213
1214 =item B<column_props> - HASH reference to specific settings for each column of the table. See section L</Column Properties> below
1215
1216     column_props => $col_props
1217
1218 =item B<cell_props> - HASH reference to specific settings for each column of the table. See section L</Cell Properties> below
1219
1220     cell_props => $cel_props
1221
1222 =back
1223
1224 =head4 Header Row Properties
1225
1226 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.
1227 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.
1228
1229 =over
1230
1231 =item B<font> - instance of PDF::API2::Resource::Font defining the fontf to be used in the header row
1232
1233 B<Value:> can be any PDF::API2::Resource::* type of font
1234 B<Default:> 'font' of the table. See table parameter 'font' for more details.
1235
1236 =item B<font_size> - Font size of the header row
1237
1238 B<Value:> can be any positive number
1239 B<Default:> 'font_size' of the table + 2
1240
1241 =item B<font_color> - Font color of the header row
1242
1243 B<Value:> Color specifier as 'name' or 'HEX'
1244 B<Default:> '#000066'
1245
1246 =item B<bg_color> - Background color of the header row
1247
1248 B<Value:> Color specifier as 'name' or 'HEX'
1249 B<Default:> #FFFFAA
1250
1251 =item B<repeat> - Flag showing if header row should be repeated on every new page
1252
1253 B<Value:> 0,1   1-Yes/True, 0-No/False
1254 B<Default:> 0
1255
1256 =item B<justify> - Alignment of text in the header row.
1257
1258 B<Value:> One of 'left', 'right', 'center'
1259 B<Default:> Same as column alignment (or 'left' if undefined)
1260
1261     my $hdr_props =
1262     {
1263         font       => $pdf->corefont("Helvetica", -encoding => "utf8"),
1264         font_size  => 18,
1265         font_color => '#004444',
1266         bg_color   => 'yellow',
1267         repeat     => 1,
1268         justify    => 'center'
1269     };
1270
1271 =back
1272
1273 =head4 Column Properties
1274
1275 If the 'column_props' parameter is used, it should be an arrayref of hashrefs,
1276 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.
1277 If you DO NOT want to give properties for a column but to give for another just insert and empty hash reference into the array for the column that you want to skip. This will cause the counting to proceed as expected and the properties to be applyed at the right columns.
1278
1279 Each hashref can contain any of the keys shown below:
1280
1281 =over
1282
1283 =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.
1284
1285 B<Value:> can be any whole number satisfying 0 < min_w < w
1286 B<Default:> Auto calculated
1287
1288 =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.
1289
1290 B<Value:> can be any whole number satisfying 0 < max_w < w
1291 B<Default:> Auto calculated
1292
1293 =item B<font> - instance of PDF::API2::Resource::Font defining the fontf to be used in this column
1294
1295 B<Value:> can be any PDF::API2::Resource::* type of font
1296 B<Default:> 'font' of the table. See table parameter 'font' for more details.
1297
1298 =item B<font_size> - Font size of this column
1299
1300 B<Value:> can be any positive number
1301 B<Default:> 'font_size' of the table.
1302
1303 =item B<font_color> - Font color of this column
1304
1305 B<Value:> Color specifier as 'name' or 'HEX'
1306 B<Default:> 'font_color' of the table.
1307
1308 =item B<background_color> - Background color of this column
1309
1310 B<Value:> Color specifier as 'name' or 'HEX'
1311 B<Default:> undef
1312
1313 =item B<justify> - Alignment of text in this column
1314
1315 B<Value:> One of 'left', 'right', 'center'
1316 B<Default:> 'left'
1317
1318 Example:
1319
1320     my $col_props = [
1321         {},# This is an empty hash so the next one will hold the properties for the second column from left to right.
1322         {
1323             min_w => 100,       # Minimum column width of 100.
1324             max_w => 150,       # Maximum column width of 150 .
1325             justify => 'right', # Right text alignment
1326             font => $pdf->corefont("Helvetica", -encoding => "latin1"),
1327             font_size => 10,
1328             font_color=> 'blue',
1329             background_color => '#FFFF00',
1330         },
1331         # etc.
1332     ];
1333
1334 =back
1335
1336 NOTE: If 'min_w' and/or 'max_w' parameter is used in 'col_props', have in mind that it may be overriden by the calculated minimum/maximum cell witdh so that table can be created.
1337 When this happens a warning will be issued with some advises what can be done.
1338 In cases of a conflict between column formatting and odd/even row formatting, 'col_props' will override odd/even.
1339
1340 =head4 Cell Properties
1341
1342 If the 'cell_props' parameter is used, it should be an arrayref with arrays of hashrefs
1343 (of the same dimension as the data array) with one hashref for each cell of the table.
1344
1345 Each hashref can contain any of the keys shown below:
1346
1347 =over
1348
1349 =item B<font> - instance of PDF::API2::Resource::Font defining the fontf to be used in this cell
1350
1351 B<Value:> can be any PDF::API2::Resource::* type of font
1352 B<Default:> 'font' of the table. See table parameter 'font' for more details.
1353
1354 =item B<font_size> - Font size of this cell
1355
1356 B<Value:> can be any positive number
1357 B<Default:> 'font_size' of the table.
1358
1359 =item B<font_color> - Font color of this cell
1360
1361 B<Value:> Color specifier as 'name' or 'HEX'
1362 B<Default:> 'font_color' of the table.
1363
1364 =item B<background_color> - Background color of this cell
1365
1366 B<Value:> Color specifier as 'name' or 'HEX'
1367 B<Default:> undef
1368
1369 =item B<justify> - Alignment of text in this cell
1370
1371 B<Value:> One of 'left', 'right', 'center'
1372 B<Default:> 'left'
1373
1374 Example:
1375
1376     my $cell_props = [
1377         [ #This array is for the first row. If header_props is defined it will overwrite these settings.
1378             {    #Row 1 cell 1
1379                 background_color => '#AAAA00',
1380                 font_color       => 'yellow',
1381             },
1382
1383             # etc.
1384         ],
1385         [#Row 2
1386             {    #Row 2 cell 1
1387                 background_color => '#CCCC00',
1388                 font_color       => 'blue',
1389             },
1390             {    #Row 2 cell 2
1391                 background_color => '#BBBB00',
1392                 font_color       => 'red',
1393             },
1394             # etc.
1395         ],
1396         # etc.
1397     ];
1398
1399     OR
1400
1401     my $cell_props = [];
1402     $cell_props->[1][0] = {
1403         #Row 2 cell 1
1404         background_color => '#CCCC00',
1405         font_color       => 'blue',
1406     };
1407
1408 =back
1409
1410 NOTE: In case of a conflict between column, odd/even and cell formating, cell formating will overwrite the other two.
1411 In case of a conflict between header row and cell formating, header formating will override cell.
1412
1413 =head2 text_block()
1414
1415     my ($width_of_last_line, $ypos_of_last_line, $left_over_text) = text_block( $txt, $data, %settings)
1416
1417 =over
1418
1419 =item Description
1420
1421 Utility method to create a block of text. The block may contain multiple paragraphs.
1422 It is mainly used internaly but you can use it from outside for placing formated text anywhere on the sheet.
1423
1424 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.
1425 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.
1426
1427 =item Parameters
1428
1429     $txt  - a PDF::API2::Page::Text instance representing the text tool
1430     $data - a string that will be placed inside the block
1431     %settings - HASH with geometry and formatting parameters.
1432
1433 =item Reuturns
1434
1435 The return value is a 3 items list where
1436
1437     $width_of_last_line - Width of last line in the block
1438     $final_y - The Y coordinate of the block bottom so that additional content can be added after it
1439     $left_over_text - Text that was did not fit in the provided box geometry.
1440
1441 =item Example
1442
1443     # PDF::API2 objects
1444     my $page = $pdf->page;
1445     my $txt  = $page->text;
1446
1447     my %settings = (
1448         x => 10,
1449         y => 570,
1450         w => 220,
1451         h => 180
1452
1453         #OPTIONAL PARAMS
1454         lead     => $font_size | $distance_between_lines,
1455         align    => "left|right|center|justify|fulljustify",
1456         hang     => $optional_hanging_indent,
1457         Only one of the subsequent 3params can be given.
1458         They override each other.-parspace is the weightest
1459         parspace => $optional_vertical_space_before_first_paragraph,
1460         flindent => $optional_indent_of_first_line,
1461         fpindent => $optional_indent_of_first_paragraph,
1462         indent   => $optional_indent_of_text_to_every_non_first_line,
1463     );
1464
1465     my ( $width_of_last_line, $final_y, $left_over_text ) = $pdftable->text_block( $txt, $data, %settings );
1466
1467 =back
1468
1469 =head1 VERSION
1470
1471 0.9.7
1472
1473 =head1 AUTHOR
1474
1475 Daemmon Hughes
1476
1477 =head1 DEVELOPMENT
1478
1479 Further development since Ver: 0.02 - Desislav Kamenov
1480
1481 =head1 COPYRIGHT AND LICENSE
1482
1483 Copyright (C) 2006 by Daemmon Hughes, portions Copyright 2004 Stone
1484 Environmental Inc. (www.stone-env.com) All Rights Reserved.
1485
1486 This library is free software; you can redistribute it and/or modify
1487 it under the same terms as Perl itself, either Perl version 5.8.4 or,
1488 at your option, any later version of Perl 5 you may have available.
1489
1490 =head1 PLUGS
1491
1492 =over
1493
1494 =item by Daemmon Hughes
1495
1496 Much of the work on this module was sponsered by
1497 Stone Environmental Inc. (www.stone-env.com).
1498
1499 The text_block() method is a slightly modified copy of the one from
1500 Rick Measham's PDF::API2 L<tutorial|http://rick.measham.id.au/pdf-api2>.
1501
1502 =item by Desislav Kamenov (@deskata on Twitter)
1503
1504 The development of this module was supported by SEEBURGER AG (www.seeburger.com) till year 2007
1505
1506 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
1507
1508 Thanks to all GitHub contributors!
1509
1510 =back
1511
1512 =head1 CONTRIBUTION
1513
1514 Hey PDF::Table is on GitHub. You are more than welcome to contribute!
1515
1516 https://github.com/kamenov/PDF-Table
1517
1518 =head1 SEE ALSO
1519
1520 L<PDF::API2>
1521
1522 =cut
1523