Start providing a fluent interface for the printer stuff. All printer elemnets now...
[isso.git] / PrinterRootElementTable.php
1 <?php
2 /*=====================================================================*
3 || ###################################################################
4 || # Blue Static ISSO Framework
5 || # Copyright (c)2005-2008 Blue Static
6 || #
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version 2 of the License.
10 || #
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 || # more details.
15 || #
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
21
22 /**
23 * Printer Root Element: Table (PrinterRootElementTable.php)
24 *
25 * @package ISSO
26 */
27
28 require_once(ISSO . '/PrinterRootElement.php');
29
30 /**
31 * Printer Root Element: Table
32 *
33 * Represents a <table> object. This can have a parent or not: if it does,
34 * then it will be painted as a child, otherwise it will act as a root.
35 *
36 * @author Blue Static
37 * @copyright Copyright (c)2005 - 2008, Blue Static
38 * @package ISSO
39 *
40 */
41 class BSPrinterRootElementTable extends BSPrinterRootElement
42 {
43 /**
44 * Maximum number of columns
45 * @var integer
46 */
47 private $colspan = 0;
48
49 /**
50 * Heading child elements
51 * @var array
52 */
53 private $headers = array();
54
55 /**
56 * Width of the table
57 * @var string
58 */
59 private $width = '90%';
60
61 // ###################################################################
62 /**
63 * Constructor
64 */
65 public function __construct()
66 {
67 $this->setCssClass('tborder');
68 }
69
70 /**
71 * Makes a new instance of the object in a static fashion
72 *
73 * @return object
74 */
75 public static function make()
76 {
77 $obj = new ReflectionClass(__CLASS__);
78 $args = func_get_args();
79 return $obj->newInstanceArgs($args);
80 }
81
82 // ###################################################################
83 /**
84 * Adds a table row into the child list
85 *
86 * @param BSPrinterTableElement Table element
87 */
88 public function addChild(BSPrinterElement $tr)
89 {
90 if (!$tr instanceof BSPrinterTableElement)
91 {
92 throw new Exception('BSPrinterRootElementTable::addChild() only accepts BSPrinterTableElement objects as children');
93 }
94 $this->children[] = $tr;
95 }
96
97 // ###################################################################
98 /**
99 * Adds a table element to be a heading of the table. This is still
100 * considered a child, but it goes before all other child elemends
101 *
102 * @param BSPrinterTableElement Child element
103 */
104 public function addHeadingChild(BSPrinterTableElement $tr)
105 {
106 $this->headers[] = $tr;
107 }
108
109 // ###################################################################
110 /**
111 * Sets the width of the table
112 *
113 * @param string Width value
114 */
115 public function setWidth($width)
116 {
117 $this->width = $width;
118 }
119
120 // ###################################################################
121 /**
122 * Calculates the number of columns to display based on the colspan
123 * of children elements
124 */
125 private function _calculateColumnCount()
126 {
127 foreach ($this->children AS $child)
128 {
129 if ($child->numberOfColumns() > $this->colspan)
130 {
131 $this->colspan = $child->numberOfColumns();
132 }
133 }
134 }
135
136 // ###################################################################
137 /**
138 * Returns the HTML for all printed children elements
139 *
140 * @return string Printed HTML
141 */
142 protected function _paintChildren()
143 {
144 $builder = '';
145
146 $this->children = array_merge($this->headers, $this->children);
147 $this->headers = array();
148
149 $this->_calculateColumnCount();
150
151 foreach ($this->children AS $child)
152 {
153 $child->setColumnNumber($this->colspan);
154 $builder .= "\n" . $child->paint();
155 }
156
157 return $builder;
158 }
159
160 // ###################################################################
161 /**
162 * Paints the <table>
163 *
164 * @return string Table HTML code
165 */
166 public function paint()
167 {
168 return "<br />\n<table cellpadding=\"4\" cellspacing=\"1\" border=\"0\" align=\"center\" width=\"" . $this->width . "\"" . $this->_prepareStyle() . ">" . $this->_paintChildren() . "\n</table>";
169 }
170 }
171
172 ?>