projekt kivitendo

Copyright (C) 2006 by Daemmon Hughes

Extended by Desislav Kamenov since version 0.02

This library is free software; you can redistribute it and/or modify

it under the same terms as Perl itself, either Perl version 5.8.7 or,

at your option, any later version of Perl 5 you may have available.

use 5.006;

use strict;

use warnings;

use Carp;

print __PACKAGE__.' is version: '.$VERSION.$/ if($ENV{'PDF_TABLE_DEBUG'});

{

    my ($self, $pdf, $page, $data, %options ) = @_;

    $self->set_defaults();

    # Check and set mandatory params

}

sub set_defaults{

}

sub set_pdf{

    my $text        = shift;    # The text to be displayed

    my %arg         = @_;       # Additional Arguments

        ( undef , undef, undef, undef , undef , undef      , undef     , undef , undef , undef  );

    my %width       = ();       # The width of every unique word in the givven text

    # Try to provide backward compatibility

    # Check if any text to display

    unless( defined( $text) and length($text) > 0 )

    {

    }

    # Strip any <CR> and Split the text into paragraphs

    # Calculate width of all words

    my $space_width = $text_object->advancewidth("\x20");

    my @words = split(/\s+/, $text);

    {

        next if exists $width{$_};

        $width{$_} = $text_object->advancewidth($_);

    $xpos = $xbase;

    $ypos = $ybase;

    $ypos = $ybase + $line_space;

    # While we can add another line

    {

        # Is there any text to render ?

        {

            # Finish if nothing left

            last unless scalar @paragraphs;

        # While there's room on the line, add another word

        @line = ();

        $line_width = 0;

        {

            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;

        }

        {

            $xpos += $arg{'flindent'};

            $line_width += $arg{'flindent'};

        }

        {

            $xpos += $arg{'fpindent'};

            $line_width += $arg{'fpindent'};

        }

        {

            $xpos += $arg{'indent'};

            $line_width += $arg{'indent'};

        }

        {

            push(@line, shift(@paragraph));

        }

        $line_width += $text_object->advancewidth(join('', @line));

        # calculate the space width

        {

            @line = split(//,$line[0]) if (scalar(@line) == 1) ;

            $wordspace = ($width - $line_width) / (scalar(@line) - 1);

            $align='justify';

        {

            $align=($arg{'align'} eq 'justify') ? 'left' : $arg{'align'};

            $wordspace = $space_width;

        }

        $line_width += $wordspace * (scalar(@line) - 1);

        {

            {

                $text_object->translate( $xpos, $ypos );

                $text_object->text( $word );

                $xpos += ($width{$word} + $wordspace) if (@line);

            }

            $endw = $width;

        {

            # calculate the left hand position of the line

            {

                $xpos += $width - $line_width;

            {

                $xpos += ( $width / 2 ) - ( $line_width / 2 );

            }

            # render the line

            $text_object->translate( $xpos, $ypos );

            $endw = $text_object->text( join("\x20", @line));

    # Validate settings key

    my %valid_settings_key = (

        w                     => 1,

        start_y               => 1,

        start_h               => 1,

        vertical_borders      => 1,

        font                  => 1,

        font_size             => 1,

        font_color            => 1,

        font_color_even       => 1,

        background_color_odd  => 1,

        background_color_even => 1,

        row_height            => 1,

        column_props          => 1,

        cell_props            => 1,

        max_word_length       => 1,

    );

    foreach my $key (keys %arg)

    {

    }

    ######

    #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

    $ybase  = $arg{'start_y'} || -1;

    $width  = $arg{'w'      } || -1;

    $height = $arg{'start_h'} || -1;

    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; }

    my $txt     = $page->text;

    # Set Default Properties

    #=====================================

    # Table Header Section

    #=====================================

    # Disable header row into the table

    my $header_props = undef;

    # Check if the user enabled it ?

    if(defined $arg{'header_props'} and ref( $arg{'header_props'}) eq 'HASH')

    {

        $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';

        $header_props->{'justify'       } = $header_props->{'justify'       };

    }

    #=====================================

    # Other Parameters check

    #=====================================

    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 $line_w        = defined $arg{'border'} ? $arg{'border'} : 1 ;

    my $horiz_borders = defined $arg{'horizontal_borders'}

        ? $arg{'horizontal_borders'}

    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 $border_color            = $arg{'border_color'           } || 'black';

    my $min_row_h   = $fnt_size + $pad_top + $pad_bot;

                     $arg{'row_height'} : $min_row_h;

    my $pg_cnt      = 1;

    }

    # Copy the header row if header is enabled

    # Determine column widths based on content

    #  the minimum and maximum width of that column

    my $col_props =  $arg{'column_props'} || [];

    #  the actual widths of the column/row intersection

    my $row_col_widths = [];

    my ( $max_col_w  , $min_col_w   ) = ( 0,0 );

    my $word_widths  = {};

    my $rows_height  = [];

    for( my $row_idx = 0; $row_idx < scalar(@$data) ; $row_idx++ )

    {

        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

            if( !$row_idx and ref $header_props )

            }

            # Get the most specific value if none was already set from header_props

                            ||  $col_props->[$column_idx]->{'font'}

                            ||  $fnt_name;

            $cell_font_size ||= $cell_props->[$row_idx][$column_idx]->{'font_size'}

                            ||  $col_props->[$column_idx]->{'font_size'}

                            ||  $fnt_size;

            # Set Font

            # 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;

            }

            # This should fix a bug with very long words like serial numbers etc.

            {

                $data->[$row_idx][$column_idx] =~ s#(\S{$max_word_len})(?=\S)#$1 #g;

            }

            my @words = split( /\s+/, $data->[$row_idx][$column_idx] );

            {

                unless( exists $word_widths->{$_} )

                {   # Calculate the width of every word and add the space width to it

                    $word_widths->{$_} = $txt->advancewidth( $_ ) + $space_w;

                }

                $column_widths->[$column_idx] += $word_widths->{$_};

                $min_col_w                     = $word_widths->{$_} if( $word_widths->{$_} > $min_col_w );

                $max_col_w                    += $word_widths->{$_};

            }

            $min_col_w                    += $pad_left + $pad_right;

            $max_col_w                    += $pad_left + $pad_right;

            $column_widths->[$column_idx] += $pad_left + $pad_right;

            {   # 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....

        $row_col_widths->[$row_idx] = $column_widths;

    }

    # Calc real column widths and expand table width if needed.

    ($calc_column_widths, $width) = CalcColumnWidths( $col_props, $width );

    # Lets draw what we have!

    my $row_index    = 0;

    # Store header row height for later use if headers have to be repeated

    my ( $gfx, $gfx_bg, $background_color, $font_color, $bot_marg, $table_top_y, $text_start);

    # Each iteration adds a new page as neccessary

    while(scalar(@{$data}))

    {

        if($pg_cnt == 1)

        {

            $table_top_y = $ybase;

            $bot_marg = $table_top_y - $height;

        }

        else

        {

            if(ref $arg{'new_page_func'})

            }

            else

            }

            $table_top_y = $next_y;

            $bot_marg = $table_top_y - $next_h;

            if( ref $header_props and $header_props->{'repeat'})

            {

            }

        }

        $gfx_bg = $page->gfx;

        $txt = $page->text;

        $cur_y = $table_top_y;

            $gfx->linewidth($line_w);

            # Draw the top line

            {

                $gfx->move( $xbase , $cur_y );

                $gfx->hline($xbase + $width );

            $gfx = undef;

        }

        #  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};

            # Get the next set of row related settings

            # Row Height

            # Row cell props - TODO in another commit

            # Choose colors for this row

            #Determine current row height

            my $current_row_height = $pad_top + $pre_calculated_row_height + $pad_bot;

            my $cur_x        = $xbase;

            my $leftovers    = undef;   # Reference to text that is returned from textblock()

            my $do_leftovers = 0;

            # Process every cell(column) from current row

            {

                next unless $col_props->[$column_idx]->{'max_w'};

                $leftovers->[$column_idx] = undef;

                # look for font information for this cell

                }

                # Get the most specific value if none was already set from header_props

                                 ||  $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;

                $justify         ||= $cell_props->[$row_index][$column_idx]->{'justify'}

                                 ||  $col_props->[$column_idx]->{'justify'}

                                 ||  $arg{'justify'}

                # Init cell font object

                $txt->font( $cell_font, $cell_font_size );

                $txt->fillcolor($cell_font_color);

                # 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

                ){

                    my $space = $pad_left;

                    if ($justify eq 'right')

                    {

                    }

                    elsif ($justify eq 'center')

                    {

                    }

                    $txt->translate( $cur_x + $space, $text_start );

                }

                # Otherwise just use the $page->text() method

                else

                        $record->[$column_idx],

                        x        => $cur_x + $pad_left,

                        y        => $text_start,

                        h        => $cur_y - $bot_marg - $pad_top - $pad_bot,

                        align    => $justify,

                        lead     => $lead

                    {

                        $current_row_height = $current_cell_height;

                    }

                    if( $left_over_text )

                    {

                        $leftovers->[$column_idx] = $left_over_text;

                        $do_leftovers = 1;

                    }

                }

            }

            if( $do_leftovers )

            {

                unshift @$row_col_widths, $record_widths;

                unshift @$rows_height, $pre_calculated_row_height;

            }

            # Draw cell bgcolor

            #  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;

                    $cell_bg_color = $header_props->{'bg_color'} || $header_props->{'background_color'};

                }

                # Get the most specific value if none was already set from header_props

                               ||  $col_props->[$column_idx]->{'background_color'}

                               ||  $background_color;

                    $gfx_bg->fill();

                }

                $cur_x += $calc_column_widths->[$column_idx];

            }#End of for(my $column_idx....

            $cur_y -= $current_row_height;

                $gfx->hline( $xbase + $width );

            }

        }# End of Row_Loop

        if ($gfx)

        {

            # Draw vertical lines

            {

                $gfx->move(  $xbase, $table_top_y);

                $gfx->vline( $cur_y );

            }

            # ACTUALLY draw all the lines

        $calc_widths->[$j] = $col_props->[$j]->{min_w} || 0;;

    }

    }

    return ($calc_widths,$avail_width);

=head1 DESCRIPTION

See the L</METHODS> section for complete documentation of every parameter.

=item Parameters

=item Returns

=head2 table()

    my ($final_page, $number_of_pages, $final_y) = table($pdf, $page, $data, %settings)

=over

=item Description

    $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

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.

    $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

        start_y => 220,

        start_h => 180,

    );

    my ($final_page, $number_of_pages, $final_y) = $pdftable->table( $pdf, $page, $data, %options );

=back

There are some mandatory parameteres for setting table geometry and position across page(s)

=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

    x => 10

B<Default:> No default value

    start_h => 250

=back

=head4 Optional

    next_y  => 750

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_top>    - top cell padding, overrides 'padding'

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<horizontal_borders> - Width of horizontal 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'

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<background_color_odd> - Background color for odd rows

    font_color            => '#333333'

    font_color_odd        => 'purple'

    font_color_even       => '#00FF00'

    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.

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

=back

=head4 Header Row Properties

=item B<font_size> - Font size of the header row

B<Value:> can be any positive number

=item B<font_color> - Font color of the header row

B<Value:> Color specifier as 'name' or 'HEX'

B<Default:> '#000066'

=item B<bg_color> - Background color of the header row

B<Value:> Color specifier as 'name' or 'HEX'

=item B<repeat> - Flag showing if header row should be repeated on every new page

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)

    {

        font       => $pdf->corefont("Helvetica", -encoding => "utf8"),

        font_size  => 18,

        font_color => '#004444',

        justify    => 'center'

    };

=head4 Column Properties

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.

Each hashref can contain any of the keys shown below:

B<Value:> Color specifier as 'name' or 'HEX'

B<Default:> 'font_color' of the table.

=item B<background_color> - Background color of this column

B<Value:> Color specifier as 'name' or 'HEX'

=back

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.

B<Value:> Color specifier as 'name' or 'HEX'

B<Default:> 'font_color' of the table.

=item B<background_color> - Background color of this cell

B<Value:> Color specifier as 'name' or 'HEX'

            {    #Row 1 cell 1

                background_color => '#AAAA00',

                font_color       => 'yellow',

            },

            # etc.

    ];

    OR

    my $cell_props = [];

    $cell_props->[1][0] = {

        #Row 2 cell 1

    };

=back

=head2 text_block()

=item Description

Utility method to create a block of text. The block may contain multiple paragraphs.

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.

    $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.

=item Reuturns

    $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.

=item Example

    # PDF::API2 objects

        y => 570,

        w => 220,

        h => 180

        #OPTIONAL PARAMS

        lead     => $font_size | $distance_between_lines,

        align    => "left|right|center|justify|fulljustify",

        hang     => $optional_hanging_indent,

        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

=head1 PLUGS

=item by Daemmon Hughes

Stone Environmental Inc. (www.stone-env.com).

The text_block() method is a slightly modified copy of the one from

=item by Desislav Kamenov (@deskata on Twitter)