Blame view

export/PHPRtfLite-1.3.1/lib/PHPRtfLite/Table.php 29.3 KB
f90e19c3   Andrea Petta   plugin update
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
  <?php
  /*
      PHPRtfLite
      Copyright 2007-2008 Denis Slaveckij <sinedas@gmail.com>
      Copyright 2010-2012 Steffen Zeidler <sigma_z@sigma-scripts.de>
  
      This file is part of PHPRtfLite.
  
      PHPRtfLite is free software: you can redistribute it and/or modify
      it under the terms of the GNU Lesser General Public License as published by
      the Free Software Foundation, either version 3 of the License, or
      (at your option) any later version.
  
      PHPRtfLite is distributed in the hope that it will be useful,
      but WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      GNU Lesser General Public License for more details.
  
      You should have received a copy of the GNU Lesser General Public License
      along with PHPRtfLite.  If not, see <http://www.gnu.org/licenses/>.
  */
  
  /**
   * Class for creating tables for rtf documents.
   * @version     1.2
   * @author      Denis Slaveckij <sinedas@gmail.com>
   * @author      Steffen Zeidler <sigma_z@sigma-scripts.de>
   * @copyright   2007-2008 Denis Slaveckij, 2010-2012 Steffen Zeidler
   * @package     PHPRtfLite
   * @subpackage  PHPRtfLite_Table
   */
  class PHPRtfLite_Table
  {
  
      /**
       * constants table alignment
       */
      const ALIGN_LEFT    = 'left';
      const ALIGN_CENTER  = 'center';
      const ALIGN_RIGHT   = 'right';
  
  
      /**
       * @var PHPRtfLite_Container
       */
      protected $_container;
  
      /**
       * array of PHPRtfLite_Table_Row instances
       * @var array
       */
      protected $_rows;
  
      /**
       * array of PHPRtfLite_Table_Column instances
       * @var array
       */
      protected $_columns;
  
      /**
       * @var string
       */
      protected $_alignment;
  
      /**
       * @var boolean
       */
      protected $_preventPageBreak = false;
  
      /**
       * @var boolean
       */
      protected $_firstRowIsHeader = false;
  
      /**
       * @var boolean
       */
      protected $_repeatFirstRowHeader = false;
  
      /**
       * @var integer
       */
      protected $_leftPosition = 0;
  
      /**
       * nest depth
       * 0: main document
       * 1: table cell
       * 2: nested table cell
       * 3: double nested table cell
       * 4: three times nested table cell
       * .. and so on ..
       * @var integer
       */
      protected $_nestDepth = 1;
  
      /**
       * flag for preventing an empty paragraph after table
       * @var boolean
       */
      protected $_preventEmptyParagraph = false;
  
  
      /**
       * constructor
       *
       * @param PHPRtfLite_Container
       * @param string
       */
      public function __construct(PHPRtfLite_Container_Base $container, $alignment = self::ALIGN_LEFT, $nestDepth = 1)
      {
          $this->_container = $container;
          $this->_alignment = $alignment;
          $this->_nestDepth = $nestDepth;
      }
  
  
      /**
       * gets nested depth
       *
       * @return integer
       */
      public function getNestDepth()
      {
          return $this->_nestDepth;
      }
  
  
      /**
       * checks, if table is a nested table
       *
       * @return boolean
       */
      public function isNestedTable()
      {
          return $this->_nestDepth > 1;
      }
  
  
      /**
       * gets rtf container instance
       *
       * @return PHPRtfLite_Container
       */
      public function getContainer()
      {
          return $this->_container;
      }
  
  
      /**
       * gets rtf instance
       *
       * @return PHPRtfLite
       */
      public function getRtf()
      {
          return $this->_container->getRtf();
      }
  
      /**
       * Sets that table won't be splited by a page break. By default page break splits table.
       */
      public function setPreventPageBreak()
      {
          $this->_preventPageBreak = true;
      }
  
  
      /**
       * returns true, if a table should not be splited by a page break
       *
       * @return boolean
       */
      public function isPreventPageBreak()
      {
          return $this->_preventPageBreak;
      }
  
  
      /**
       * sets left position of table
       *
       * @param   float $leftPosition left position of table.
       */
      public function setLeftPosition($leftPosition)
      {
          $this->_leftPosition = $leftPosition;
      }
  
  
      /**
       * gets left position of table
       *
       * @return  float
       */
      public function getLeftPosition()
      {
          return $this->_leftPosition;
      }
  
  
      /**
       * Sets first row as header row. First row will be repeated at the top of each page.
       */
      public function setFirstRowAsHeader()
      {
          $this->_firstRowIsHeader = true;
      }
  
  
      /**
       * Returns true, if first row should be used as header. First row will be repeated at the top of each page.
       *
       * @return boolean
       */
      public function isFirstRowHeader()
      {
          return $this->_firstRowIsHeader;
      }
  
  
      /**
       * gets alignment
       *
       * @return string
       */
      public function getAlignment()
      {
          return $this->_alignment;
      }
  
  
      /**
       * prevents adding an empty paragraph after table
       *
       * @param boolean
       */
      public function preventEmptyParagraph($value = true)
      {
      	$this->_preventEmptyParagraph = $value;
      }
  
  
      /**
       * returns true, if no empty paragraph should be added after table
       *
       * @return boolean
       */
  	public function getPreventEmptyParagraph()
      {
  		return $this->_preventEmptyParagraph;
  	}
  
  
      /**
       * adds rows
       *
       * @param   integer $rowCnt
       * @param   float   $height row height. When null, the height is sufficient for all the text in the line;
       *   when positive, the height is guaranteed to be at least the specified height; when negative,
       *   the absolute value of the height is used, regardless of the height of the text in the line.
       */
      public function addRows($rowCnt, $height = null)
      {
          for ($i = 0; $i < $rowCnt; $i++) {
              $this->addRow($height);
          }
      }
  
  
      /**
       * adds list of rows to a table.
       *
       * @param array $heights array of heights for each row to add. When height is null,
       *   the height is sufficient for all the text in the line; when positive,
       *   the height is guaranteed to be at least the specified height; when negative,
       *   the absolute value of the height is used, regardless of the height of
       *   the text in the line.
       */
      public function addRowList($heights)
      {
          foreach ($heights as $height) {
              $this->addRow($height);
          }
      }
  
  
      /**
       * adds row
       *
       * @param   float   $height row height. When 0, the height is sufficient for all the text in the line;
       *   when positive, the height is guaranteed to be at least the specified height; when negative,
       *   the absolute value of the height is used, regardless of the height of the text in the line.
       *
       * @return  PHPRtfLite_Table_Row
       */
      public function addRow($height = null)
      {
          $row = new PHPRtfLite_Table_Row($this, $this->getRowsCount() + 1, $height);
          $this->_rows[] = $row;
  
          return $row;
      }
  
  
      /**
       * gets row instance
       *
       * @param  integer $rowIndex
       * @return PHPRtfLite_Table_Row
       * @throws PHPRtfLite_Exception, if rowIndex is not valid
       */
      public function getRow($rowIndex)
      {
          if (isset($this->_rows[$rowIndex - 1])) {
              return $this->_rows[$rowIndex - 1];
          }
  
          throw new PHPRtfLite_Exception('Invalid row index for table: ' . $rowIndex);
      }
  
  
      /**
       * adds column
       *
       * @param   float   $width column width
       * @return  PHPRtfLite_Table_Column
       */
      public function addColumn($width)
      {
          $column = new PHPRtfLite_Table_Column($this, $this->getColumnsCount() + 1, $width);
          $this->_columns[] = $column;
  
          return $column;
      }
  
  
      /**
       * gets column
       *
       * @param  integer $colIndex
       * @return PHPRtfLite_Table_Column
       * @throws PHPRtfLite_Exception, if colIndex is not valid
       */
      public function getColumn($colIndex)
      {
          if (isset($this->_columns[$colIndex - 1])) {
              return $this->_columns[$colIndex - 1];
          }
  
          throw new PHPRtfLite_Exception('Invalid column index for table: ' . $colIndex);
      }
  
  
      /**
       * adds list of columns
       *
       * @param  array array of column widths.
       */
      public function addColumnsList($columnWidths)
      {
          foreach ($columnWidths as $columnWidth) {
              $this->addColumn($columnWidth);
          }
      }
  
  
      /**
       * gets the instance of cell
       *
       * @param  integer $rowIndex
       * @param  integer $columnIndex
       * @return PHPRtfLite_Table_Cell
       * @throws PHPRtfLite_Exception, if index for row or column is not valid
       */
      public function getCell($rowIndex, $columnIndex)
      {
          if ($this->checkIfCellExists($rowIndex, $columnIndex)) {
              return $this->getRow($rowIndex)->getCellByIndex($columnIndex);
          }
  
          throw new PHPRtfLite_Exception('Wrong index for cell! You gave me: (row:' . $rowIndex . ', column:' . $columnIndex . ')');
      }
  
  
      /**
       * writes text to cell
       *
       * @param   integer                 $rowIndex           row index of cell
       * @param   integer                 $columnIndex        column index of cell
       * @param   string                  $text               Text. Also you can use html style tags. @see PHPRtfLite_Container#writeText()
       * @param   PHPRtfLite_Font         $font               Font of text
       * @param   PHPRtfLite_ParFormat    $parFormat          Paragraph format
       * @param   boolean                 $convertTagsToRtf   If false, then html style tags are not replaced with rtf code.
       * @return  PHPRtfLite_Element
       */
      public function writeToCell($rowIndex,
                                  $columnIndex,
                                  $text,
                                  PHPRtfLite_Font $font = null,
                                  PHPRtfLite_ParFormat $parFormat = null,
                                  $convertTagsToRtf = true)
      {
          $cell = $this->getCell($rowIndex, $columnIndex);
          if (is_null($font)) {
              $font = $cell->getFont();
          }
          return $cell->writeText($text, $font, $parFormat, $convertTagsToRtf);
      }
  
  
      /**
       * adds image to cell
       *
       * @param   integer                 $rowIndex       row index of cell
       * @param   integer                 $columnIndex    column index of cell
       * @param   string                  $file           image file.
       * @param   PHPRtfLite_ParFormat    $parFormat      paragraph format
       * @param   float                   $width          if null image is displayed by it's original height.
       * @param   float                   $height         if null image is displayed by it's original width. If boths parameters are null, image is displayed as it is.
       * @return  PHPRtfLite_Image
       */
      public function addImageToCell($rowIndex,
                                     $columnIndex,
                                     $file,
                                     PHPRtfLite_ParFormat $parFormat = null,
                                     $width = null,
                                     $height = null)
      {
          $cell = $this->getCell($rowIndex, $columnIndex);
          return $cell->addImage($file, $parFormat, $width, $height);
      }
  
  
      /**
       * adds image to cell
       *
       * @param   integer                 $rowIndex       row index of cell
       * @param   integer                 $columnIndex    column index of cell
       * @param   string                  $file           image file.
       * @param   PHPRtfLite_ParFormat    $parFormat      paragraph format
       * @param   float                   $width          if null image is displayed by it's original height.
       * @param   float                   $height         if null image is displayed by it's original width. If boths parameters are null, image is displayed as it is.
       * @return  PHPRtfLite_Image
       */
      public function addImageFromStringToCell(
                              $rowIndex,
                              $columnIndex,
                              $string,
                              $type,
                              PHPRtfLite_ParFormat $parFormat = null,
                              $width = null,
                              $height = null)
      {
          $cell = $this->getCell($rowIndex, $columnIndex);
          return $cell->addImageFromString($string, $type, $parFormat, $width, $height);
      }
  
  
      /**
       * corrects cell range to be valid
       *
       * @param integer $startRow
       * @param integer $startColumn
       * @param integer $endRow
       * @param integer $endColumn
       * @return array
       */
      private static function getValidCellRange($startRow, $startColumn, $endRow, $endColumn)
      {
          if ($endRow === null) {
              $endRow = $startRow;
          }
          elseif ($startRow > $endRow) {
              $temp = $startRow;
              $startRow = $endRow;
              $endRow = $temp;
          }
  
          if ($endColumn === null) {
              $endColumn = $startColumn;
          }
          elseif ($startColumn > $endColumn) {
              $temp = $startColumn;
              $startColumn = $endColumn;
              $endColumn = $temp;
          }
  
          return array($startRow, $startColumn, $endRow, $endColumn);
      }
  
  
      /**
       *
       * @param integer $startRow
       * @param integer $startColumn
       * @param integer $endRow
       * @param integer $endColumn
       * @return PHPRtfLite_Table_Cell[]
       */
      private function getCellsByCellRange($startRow, $startColumn, $endRow, $endColumn)
      {
          $cells = array();
          for ($row = $startRow; $row <= $endRow; $row++) {
              for ($column = $startColumn; $column <= $endColumn; $column++) {
                  $cells[] = $this->getCell($row, $column);
              }
          }
          return $cells;
      }
  
  
      /**
       * sets vertical alignment to cells of a given cell range
       *
       * @param   string  $verticalAlignment Vertical alignment of cell (default top). Represented by PHPRtfLite_Container::VERTICAL_ALIGN_*<br>
       *   Possible values:<br>
       *     PHPRtfLite_Container::VERTICAL_ALIGN_TOP     => 'top'    - top alignment;<br>
       *     PHPRtfLite_Container::VERTICAL_ALIGN_CENTER  => 'center' - center alignment;<br>
       *     PHPRtfLite_Container::VERTICAL_ALIGN_BOTTOM  => 'bottom' - bottom alignment.
       * @param   integer $startRow       start row
       * @param   integer $startColumn    start column
       * @param   integer $endRow         end row, if null, then vertical alignment is set only to the row range.
       * @param   integer $endColumn      end column, if null, then vertical alignment is set just to the column range.
       */
      public function setVerticalAlignmentForCellRange($verticalAlignment, $startRow, $startColumn, $endRow = null, $endColumn = null)
      {
          list($startRow, $startColumn, $endRow, $endColumn)
                  = PHPRtfLite_Table::getValidCellRange($startRow, $startColumn, $endRow, $endColumn);
  
          if ($this->checkIfCellExists($startRow, $startColumn)
              && $this->checkIfCellExists($endRow, $endColumn))
          {
              $cells = $this->getCellsByCellRange($startRow, $startColumn, $endRow, $endColumn);
              foreach ($cells as $cell) {
                  $cell->setVerticalAlignment($verticalAlignment);
              }
          }
      }
  
  
      /**
       * sets alignments to empty cells of a given cell range
       *
       * @param   string  $alignment      alignment of cell. The method PHPRtfLite_Table_Cell->writeToCell() overrides it with PHPRtfLite_ParFormat alignment.<br>
       *   Alignment is represented by class constants PHPRtfLite_Container::TEXT_ALIGN_*<br>
       *   Possible values:<br>
       *     PHPRtfLite_Container::TEXT_ALIGN_LEFT    => 'left'   - left alignment<br>
       *     PHPRtfLite_Container::TEXT_ALIGN_RIGHT   => 'right'  - right alignment<br>
       *     PHPRtfLite_Container::TEXT_ALIGN_CENTER  => 'center' - center alignment<br>
       *     PHPRtfLite_Container::TEXT_ALIGN_JUSTIFY => 'justify' - justify alignment
       * @param   integer $startRow       start row
       * @param   integer $startColumn    start column
       * @param   integer $endRow         end row, if null, then text alignment is set only to the row range.
       * @param   integer $endColumn      end column, if null, then text alignment is set just to the column range.
       */
      public function setTextAlignmentForCellRange($alignment, $startRow, $startColumn, $endRow = null, $endColumn = null)
      {
          list($startRow, $startColumn, $endRow, $endColumn)
                  = PHPRtfLite_Table::getValidCellRange($startRow, $startColumn, $endRow, $endColumn);
  
          if ($this->checkIfCellExists($startRow, $startColumn)
              && $this->checkIfCellExists($endRow, $endColumn))
          {
              $cells = $this->getCellsByCellRange($startRow, $startColumn, $endRow, $endColumn);
              foreach ($cells as $cell) {
                  $cell->setTextAlignment($alignment);
              }
          }
      }
  
  
      /**
       * sets font to empty cells of a given cell range
       *
       * @param   PHPRtfLite_Font $font           font for empty cells. The method PHPRtfLite_Table_Cell->writeToCell() overrides it with another PHPRtfLite_Font.
       * @param   integer         $startRow       start row
       * @param   integer         $startColumn    start column
       * @param   integer         $endRow         end row, if null, then font is set only to the row range.
       * @param   integer         $endColumn      end column, if null, then font is set just to the column range.
       */
      public function setFontForCellRange(PHPRtfLite_Font $font, $startRow, $startColumn, $endRow = null, $endColumn = null)
      {
          list($startRow, $startColumn, $endRow, $endColumn)
                  = PHPRtfLite_Table::getValidCellRange($startRow, $startColumn, $endRow, $endColumn);
  
          if ($this->checkIfCellExists($startRow, $startColumn)
              && $this->checkIfCellExists($endRow, $endColumn))
          {
              $cells = $this->getCellsByCellRange($startRow, $startColumn, $endRow, $endColumn);
              foreach ($cells as $cell) {
                  $cell->setFont($font);
              }
          }
      }
  
  
      /**
       * rotates cells of a given cell range
       *
       * @param   string  $rotateTo       direction of rotation<br>
       *   Possible values (represented by PHPRtfLite_Table_Cell::ROTATE_*):<br>
       *     PHPRtfLite_Table_Cell::ROTATE_RIGHT  => 'right'<br>
       *     PHPRtfLite_Table_Cell::ROTATE_LEFT   => 'left'
       * @param   integer $startRow       start row
       * @param   integer $startColumn    start column
       * @param   integer $endRow         end row, if null, then rotation is set only to the row range.
       * @param   integer $endColumn      end column, if null, then rotation is set just to the column range.
       */
      public function rotateCellRange($rotateTo, $startRow, $startColumn, $endRow = null, $endColumn = null)
      {
          list($startRow, $startColumn, $endRow, $endColumn)
                  = PHPRtfLite_Table::getValidCellRange($startRow, $startColumn, $endRow, $endColumn);
  
          if ($this->checkIfCellExists($startRow, $startColumn)
              && $this->checkIfCellExists($endRow, $endColumn))
          {
              $cells = $this->getCellsByCellRange($startRow, $startColumn, $endRow, $endColumn);
              foreach ($cells as $cell) {
                  $cell->rotateTo($rotateTo);
              }
          }
      }
  
  
      /**
       * sets background color of cells of a given cell range
       *
       * @param   string  $backgroundColor    background color
       * @param   integer $startRow           start row
       * @param   integer $startColumn        start column
       * @param   integer $endRow             end row, if null, then rotation is set only to the row range.
       * @param   integer $endColumn          end column, if null, then rotation is set just to the column range.
       */
      public function setBackgroundForCellRange($backgroundColor,
                                                $startRow,
                                                $startColumn,
                                                $endRow = null,
                                                $endColumn = null)
      {
          list($startRow, $startColumn, $endRow, $endColumn)
                  = PHPRtfLite_Table::getValidCellRange($startRow, $startColumn, $endRow, $endColumn);
  
          if ($this->checkIfCellExists($startRow, $startColumn)
              && $this->checkIfCellExists($endRow, $endColumn))
          {
              $cells = $this->getCellsByCellRange($startRow, $startColumn, $endRow, $endColumn);
              foreach ($cells as $cell) {
                  $cell->setBackgroundColor($backgroundColor);
              }
          }
      }
  
  
      /**
       * sets border to cells of a given cell range
       *
       * @param   PHPRtfLite_Border   $border         border
       * @param   integer             $startRow       start row
       * @param   integer             $startColumn    start column
       * @param   integer             $endRow         end row, if null, then border is set only to the row range.
       * @param   integer             $endColumn      end column, if null, then border is set just to the column range.
       */
      public function setBorderForCellRange(PHPRtfLite_Border $border,
                                            $startRow, $startColumn,
                                            $endRow = null, $endColumn = null)
      {
          list($startRow, $startColumn, $endRow, $endColumn)
                  = PHPRtfLite_Table::getValidCellRange($startRow, $startColumn, $endRow, $endColumn);
  
          if ($this->checkIfCellExists($startRow, $startColumn)
              && $this->checkIfCellExists($endRow, $endColumn))
          {
              $cells = $this->getCellsByCellRange($startRow, $startColumn, $endRow, $endColumn);
              foreach ($cells as $cell) {
                  $cell->setBorder(clone($border));
              }
          }
      }
  
  
      /**
       * @deprecated use setBorderForCellRange() instead
       * @see PHPRtfLite/PHPRtfLite_Table#setBorderForCellRange()
       *
       * Sets borders of cells.
       *
       * @param   PHPRtfLite_Border_Format    $borderFormat   border format
       * @param   integer                     $startRow       start row
       * @param   integer                     $startColumn    start column
       * @param   integer                     $endRow         end row, if null, then border is set only to the row range.
       * @param   integer                     $endColumn      end column, if null, then border is set just to the column range.
       * @param   boolean                     $left           if false, left border is not set (default true)
       * @param   boolean                     $top            if false, top border is not set (default true)
       * @param   boolean                     $right          if false, right border is not set (default true)
       * @param   boolean                     $bottom         if false, bottom border is not set (default true)
       */
      public function setBordersForCellRange(PHPRtfLite_Border_Format $borderFormat,
                                             $startRow,
                                             $startColumn,
                                             $endRow = null,
                                             $endColumn = null,
                                             $left = true,
                                             $top = true,
                                             $right = true,
                                             $bottom = true)
      {
          $border = new PHPRtfLite_Border($this->getRtf());
          $border->setBorders($borderFormat, $left, $top, $right, $bottom);
  
          $this->setBorderForCellRange($border, $startRow, $startColumn, $endRow, $endColumn);
      }
  
  
      /**
       * merges cells of a given cell range
       *
       * @param   integer $startRow       start row
       * @param   integer $startColumn    start column
       * @param   integer $endRow         end row
       * @param   integer $endColumn      end column
       *
       * @TODO source code commentation
       */
      public function mergeCellRange($startRow, $startColumn, $endRow, $endColumn)
      {
          list($startRow, $startColumn, $endRow, $endColumn)
                  = PHPRtfLite_Table::getValidCellRange($startRow, $startColumn, $endRow, $endColumn);
  
          if ($startRow == $endRow && $startColumn == $endColumn) {
              return;
          }
  
          if (!$this->checkIfCellExists($endRow, $endColumn)) {
              return;
          }
  
          for ($j = $startRow; $j <= $endRow; $j++) {
              $start = $startColumn;
              $cell = $this->getCell($j, $start);
  
              while ($cell->isHorizontalMerged()) {
                  $start--;
                  $cell = $this->getCell($j, $start);
              }
  
              $end = $endColumn;
  
              $cell = $this->getCell($j, $end);
              while ($cell->isHorizontalMerged()) {
                  $end++;
                  $cell = $this->getCell($j, $end + 1);
              }
  
              $width = 0;
  
              for ($i = $start; $i <= $end; $i++) {
                  $cell = $this->getCell($j, $i);
                  if ($j == $startRow) {
                      $cell->setVerticalMergeStart();
                  }
                  else {
                      $cell->setVerticalMerged();
                  }
  
                  $width += $cell->getWidth();
                  if ($i != $start) {
                      $cell->setHorizontalMerged();
                  }
              }
  
              $this->getCell($j, $start)->setWidth($width);
          }
      }
  
  
      /**
       * gets table rows
       *
       * @return array instances of PHPRtfLite_Table_Row
       */
      public function getRows()
      {
          return $this->_rows;
      }
  
  
      /**
       * gets number of rows in table
       *
       * @return integer
       */
      public function getRowsCount()
      {
          return count($this->_rows);
      }
  
  
      /**
       * gets table columns
       *
       * @return array instances of PHPRtfLite_Table_Column
       */
      public function getColumns()
      {
          return $this->_columns;
      }
  
  
      /**
       * gets number of columns in table
       *
       * @return integer
       */
      public function getColumnsCount()
      {
          return count($this->_columns);
      }
  
  
      /**
       * returns true, if column index is valid
       *
       * @param   integer $colIndex
       * @return  boolean
       */
      public function checkColumnIndex($colIndex)
      {
          return isset($this->_columns[$colIndex - 1]);
      }
  
  
      /**
       * returns true, if row index is valid
       *
       * @param   integer $rowIndex
       * @return  boolean
       */
      public function checkRowIndex($rowIndex)
      {
          return isset($this->_rows[$rowIndex - 1]);
      }
  
  
      /**
       * returns true, if rowIndex and columnIndex do exists in table
       *
       * @param  integer $rowIndex
       * @param  integer $columnIndex
       * @return boolean
       */
      public function checkIfCellExists($rowIndex, $columnIndex)
      {
          return $this->checkRowIndex($rowIndex) && $this->checkColumnIndex($columnIndex);
      }
  
  
      /**
       * gets rtf code for table
       *
       * @return string rtf code
       */
      public function render()
      {
          if (empty($this->_rows) || empty($this->_columns)) {
              return;
          }
  
          $stream = $this->getRtf()->getWriter();
  
          foreach ($this->_rows as $row) {
              $this->renderRowDefinition($row);
              $stream->write("\r\n");
              $this->renderRowCells($row);
              $stream->write("\r\n" . '\row' . "\r\n");
          }
  
          $stream->write('\pard\itap0' . "\r\n");
      }
  
  
      /**
       * renders row definition
       *
       * @param PHPRtfLite_Table_Row $row
       */
      public function renderRowDefinition(PHPRtfLite_Table_Row $row)
      {
          $rowIndex = $row->getRowIndex();
          $stream = $this->getRtf()->getWriter();
          $stream->write('\trowd');
  
          if ($this->_alignment) {
              switch ($this->_alignment) {
                  case self::ALIGN_CENTER:
                      $stream->write('\trqc');
                      break;
  
                  case self::ALIGN_RIGHT:
                      $stream->write('\trqr');
                      break;
  
                  default:
                      $stream->write('\trql');
                      break;
              }
          }
  
          $rowHeight = $row->getHeight();
          if ($rowHeight) {
              $stream->write('\trrh' . PHPRtfLite_Unit::getUnitInTwips($rowHeight));
          }
  
          if ($this->isPreventPageBreak()) {
              $stream->write('\trkeep ');
          }
  
          if ($this->isFirstRowHeader() && $rowIndex == 1) {
              $stream->write('\trhdr ');
          }
  
          if ($this->getLeftPosition() != '') {
              $stream->write('\trleft' . PHPRtfLite_Unit::getUnitInTwips($this->getLeftPosition()) . ' ');
          }
  
          $width = 0;
          foreach ($this->getColumns() as $columnIndex => $column) {
              $cell = $this->getCell($rowIndex, $columnIndex + 1);
  
              // render cell definition
              if (!$cell->isHorizontalMerged()) {
                  $cell->renderDefinition();
  
                  // cell width
                  $width += PHPRtfLite_Unit::getUnitInTwips($cell->getWidth());
                  $stream->write('\cellx' . $width);
              }
          }
      }
  
  
      /**
       * renders row cells
       *
       * @param PHPRtfLite_Table_Row $row
       */
      protected function renderRowCells(PHPRtfLite_Table_Row $row)
      {
          $rowIndex = $row->getRowIndex();
  
          foreach ($this->getColumns() as $columnIndex => $column) {
              $cell = $this->getCell($rowIndex, $columnIndex + 1);
              if (!$cell->isHorizontalMerged()) {
                  $cell->render();
              }
          }
      }
  
  }