| 1 |
jonen |
1.3 |
<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 |
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 |
|
|
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 |
|
|
<head> |
| 5 |
|
|
<!-- template designed by Marco Von Ballmoos --> |
| 6 |
|
|
<title>Docs For Class InfoTable</title> |
| 7 |
|
|
<link rel="stylesheet" href="../media/stylesheet.css" /> |
| 8 |
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
| 9 |
|
|
</head> |
| 10 |
|
|
<body> |
| 11 |
|
|
<div class="page-body"> |
| 12 |
|
|
<h2 class="class-name">Class InfoTable</h2> |
| 13 |
|
|
|
| 14 |
|
|
<a name="sec-description"></a> |
| 15 |
|
|
<div class="info-box"> |
| 16 |
|
|
<div class="info-box-title">Description</div> |
| 17 |
|
|
<div class="nav-bar"> |
| 18 |
|
|
<span class="disabled">Description</span> | |
| 19 |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 20 |
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 21 |
|
|
|
| 22 |
|
|
</div> |
| 23 |
|
|
<div class="info-box-body"> |
| 24 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 25 |
|
|
<p class="short-description">This is a widget class that can build and render data in a nicely formated table with a title, column headers and data</p> |
| 26 |
|
|
<ul class="tags"> |
| 27 |
|
|
<li><span class="field">author:</span> <p>Walter A. Boring IV</p></li> |
| 28 |
|
|
</ul> |
| 29 |
|
|
<p class="notes"> |
| 30 |
|
|
Located in <a class="field" href="_widgets_InfoTable_inc.html">Program_Root/widgets/InfoTable.inc</a> (line <span class="field">23</span>) |
| 31 |
|
|
</p> |
| 32 |
|
|
|
| 33 |
|
|
|
| 34 |
|
|
<pre><a href="../phpHtmlLib/Container.html">Container</a> |
| 35 |
jonen |
1.1 |
| |
| 36 |
|
|
--<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> |
| 37 |
|
|
| |
| 38 |
|
|
--InfoTable</pre> |
| 39 |
jonen |
1.3 |
|
| 40 |
|
|
</div> |
| 41 |
|
|
</div> |
| 42 |
|
|
|
| 43 |
|
|
|
| 44 |
|
|
<a name="sec-var-summary"></a> |
| 45 |
|
|
<div class="info-box"> |
| 46 |
|
|
<div class="info-box-title">Variable Summary</span></div> |
| 47 |
|
|
<div class="nav-bar"> |
| 48 |
|
|
<a href="#sec-description">Description</a> | |
| 49 |
|
|
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
| 50 |
|
|
| |
| 51 |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 52 |
|
|
|
| 53 |
|
|
</div> |
| 54 |
|
|
<div class="info-box-body"> |
| 55 |
|
|
<div class="var-summary"> |
| 56 |
|
|
<div class="var-title"> |
| 57 |
|
|
<span class="var-type">mixed</span> |
| 58 |
|
|
<a href="#$_cellpadding" title="details" class="var-name">$_cellpadding</a> |
| 59 |
|
|
</div> |
| 60 |
|
|
<div class="var-title"> |
| 61 |
|
|
<span class="var-type">mixed</span> |
| 62 |
|
|
<a href="#$_cellspacing" title="details" class="var-name">$_cellspacing</a> |
| 63 |
|
|
</div> |
| 64 |
|
|
<div class="var-title"> |
| 65 |
|
|
<span class="var-type">mixed</span> |
| 66 |
|
|
<a href="#$_headers" title="details" class="var-name">$_headers</a> |
| 67 |
|
|
</div> |
| 68 |
|
|
<div class="var-title"> |
| 69 |
|
|
<span class="var-type">mixed</span> |
| 70 |
|
|
<a href="#$_show_vertical_cellborder" title="details" class="var-name">$_show_vertical_cellborder</a> |
| 71 |
|
|
</div> |
| 72 |
|
|
<div class="var-title"> |
| 73 |
|
|
<span class="var-type">mixed</span> |
| 74 |
|
|
<a href="#$_title_css_class" title="details" class="var-name">$_title_css_class</a> |
| 75 |
|
|
</div> |
| 76 |
|
|
<div class="var-title"> |
| 77 |
|
|
<span class="var-type">mixed</span> |
| 78 |
|
|
<a href="#$_title_text_align" title="details" class="var-name">$_title_text_align</a> |
| 79 |
|
|
</div> |
| 80 |
|
|
</div> |
| 81 |
|
|
</div> |
| 82 |
|
|
</div> |
| 83 |
|
|
|
| 84 |
|
|
<a name="sec-method-summary"></a> |
| 85 |
|
|
<div class="info-box"> |
| 86 |
|
|
<div class="info-box-title">Method Summary</span></div> |
| 87 |
|
|
<div class="nav-bar"> |
| 88 |
|
|
<a href="#sec-description">Description</a> | |
| 89 |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 90 |
|
|
|
| 91 |
|
|
| |
| 92 |
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
| 93 |
|
|
</div> |
| 94 |
|
|
<div class="info-box-body"> |
| 95 |
|
|
<div class="method-summary"> |
| 96 |
|
|
|
| 97 |
|
|
<div class="method-definition"> |
| 98 |
|
|
<span class="method-result">void</span> |
| 99 |
|
|
<a href="#InfoTable" title="details" class="method-name">InfoTable</a> |
| 100 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>, [<span class="var-type">string</span> <span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">NULL</span>]) |
| 101 |
|
|
</div> |
| 102 |
|
|
|
| 103 |
|
|
<div class="method-definition"> |
| 104 |
|
|
<span class="method-result">void</span> |
| 105 |
|
|
<a href="#add_column_header" title="details" class="method-name">add_column_header</a> |
| 106 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$width</span>, [<span class="var-type">mixed</span> <span class="var-name">$align</span> = <span class="var-default">"center"</span>]) |
| 107 |
|
|
</div> |
| 108 |
|
|
|
| 109 |
|
|
<div class="method-definition"> |
| 110 |
|
|
<span class="method-result">void</span> |
| 111 |
|
|
<a href="#add_row" title="details" class="method-name">add_row</a> |
| 112 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
| 113 |
|
|
</div> |
| 114 |
|
|
|
| 115 |
|
|
<div class="method-definition"> |
| 116 |
|
|
<span class="method-result">int</span> |
| 117 |
|
|
<a href="#get_cellpadding" title="details" class="method-name">get_cellpadding</a> |
| 118 |
|
|
() |
| 119 |
|
|
</div> |
| 120 |
|
|
|
| 121 |
|
|
<div class="method-definition"> |
| 122 |
|
|
<span class="method-result">int</span> |
| 123 |
|
|
<a href="#get_cellspacing" title="details" class="method-name">get_cellspacing</a> |
| 124 |
|
|
() |
| 125 |
|
|
</div> |
| 126 |
|
|
|
| 127 |
|
|
<div class="method-definition"> |
| 128 |
|
|
<span class="method-result">string</span> |
| 129 |
|
|
<a href="#get_title_text_align" title="details" class="method-name">get_title_text_align</a> |
| 130 |
|
|
() |
| 131 |
|
|
</div> |
| 132 |
|
|
|
| 133 |
|
|
<div class="method-definition"> |
| 134 |
|
|
<span class="method-result">string</span> |
| 135 |
|
|
<a href="#get_vertical_cellborder" title="details" class="method-name">get_vertical_cellborder</a> |
| 136 |
|
|
() |
| 137 |
|
|
</div> |
| 138 |
|
|
|
| 139 |
|
|
<div class="method-definition"> |
| 140 |
|
|
<span class="method-result">string</span> |
| 141 |
|
|
<a href="#render" title="details" class="method-name">render</a> |
| 142 |
|
|
([<span class="var-type">int</span> <span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span> <span class="var-name">$output_debug</span>) |
| 143 |
|
|
</div> |
| 144 |
|
|
|
| 145 |
|
|
<div class="method-definition"> |
| 146 |
|
|
<span class="method-result">void</span> |
| 147 |
|
|
<a href="#set_cellpadding" title="details" class="method-name">set_cellpadding</a> |
| 148 |
|
|
(<span class="var-type">int</span> <span class="var-name">$pad</span>) |
| 149 |
|
|
</div> |
| 150 |
|
|
|
| 151 |
|
|
<div class="method-definition"> |
| 152 |
|
|
<span class="method-result">void</span> |
| 153 |
|
|
<a href="#set_cellspacing" title="details" class="method-name">set_cellspacing</a> |
| 154 |
|
|
(<span class="var-type">int</span> <span class="var-name">$spacing</span>) |
| 155 |
|
|
</div> |
| 156 |
|
|
|
| 157 |
|
|
<div class="method-definition"> |
| 158 |
|
|
<span class="method-result">void</span> |
| 159 |
|
|
<a href="#set_title_text_align" title="details" class="method-name">set_title_text_align</a> |
| 160 |
|
|
([<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">"left"</span>]) |
| 161 |
|
|
</div> |
| 162 |
|
|
|
| 163 |
|
|
<div class="method-definition"> |
| 164 |
|
|
<span class="method-result">void</span> |
| 165 |
|
|
<a href="#set_vertical_cellborder" title="details" class="method-name">set_vertical_cellborder</a> |
| 166 |
|
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 167 |
|
|
</div> |
| 168 |
|
|
|
| 169 |
|
|
<div class="method-definition"> |
| 170 |
|
|
<span class="method-result"><a href="../phpHtmlLib/TRtag.html">TRtag</a></span> |
| 171 |
|
|
<a href="#_build_header" title="details" class="method-name">_build_header</a> |
| 172 |
|
|
() |
| 173 |
|
|
</div> |
| 174 |
|
|
|
| 175 |
|
|
<div class="method-definition"> |
| 176 |
|
|
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
| 177 |
|
|
<a href="#_build_td" title="details" class="method-name">_build_td</a> |
| 178 |
|
|
([<span class="var-type">int</span> <span class="var-name">$width</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">""</span>], <span class="var-type">int</span> <span class="var-name">$col_num</span>, <span class="var-type">int</span> <span class="var-name">$total_cols</span>) |
| 179 |
|
|
</div> |
| 180 |
|
|
|
| 181 |
|
|
<div class="method-definition"> |
| 182 |
|
|
<span class="method-result"><a href="../phpHtmlLib/CAPTIONtag.html">CAPTIONtag</a></span> |
| 183 |
|
|
<a href="#_build_title" title="details" class="method-name">_build_title</a> |
| 184 |
|
|
() |
| 185 |
|
|
</div> |
| 186 |
|
|
</div> |
| 187 |
|
|
</div> |
| 188 |
|
|
</div> |
| 189 |
|
|
|
| 190 |
|
|
<a name="sec-vars"></a> |
| 191 |
|
|
<div class="info-box"> |
| 192 |
|
|
<div class="info-box-title">Variables</div> |
| 193 |
|
|
<div class="nav-bar"> |
| 194 |
|
|
<a href="#sec-description">Description</a> | |
| 195 |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
| 196 |
|
|
|
| 197 |
|
|
|
| 198 |
|
|
| |
| 199 |
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
| 200 |
|
|
|
| 201 |
|
|
</div> |
| 202 |
|
|
<div class="info-box-body"> |
| 203 |
|
|
<a name="var$_cellpadding" id="$_cellpadding"><!-- --></A> |
| 204 |
|
|
<div class="evenrow"> |
| 205 |
|
|
|
| 206 |
|
|
<div class="var-header"> |
| 207 |
|
|
<span class="var-title"> |
| 208 |
|
|
<span class="var-type">mixed</span> |
| 209 |
|
|
<span class="var-name">$_cellpadding</span> |
| 210 |
|
|
= <span class="var-default">2</span> (line <span class="line-number">34</span>) |
| 211 |
|
|
</span> |
| 212 |
|
|
</div> |
| 213 |
|
|
|
| 214 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 215 |
|
|
<p class="short-description">this holds the default cellpadding</p> |
| 216 |
|
|
|
| 217 |
|
|
|
| 218 |
|
|
|
| 219 |
|
|
|
| 220 |
|
|
|
| 221 |
|
|
</div> |
| 222 |
|
|
<a name="var$_cellspacing" id="$_cellspacing"><!-- --></A> |
| 223 |
|
|
<div class="oddrow"> |
| 224 |
|
|
|
| 225 |
|
|
<div class="var-header"> |
| 226 |
|
|
<span class="var-title"> |
| 227 |
|
|
<span class="var-type">mixed</span> |
| 228 |
|
|
<span class="var-name">$_cellspacing</span> |
| 229 |
|
|
(line <span class="line-number">39</span>) |
| 230 |
|
|
</span> |
| 231 |
|
|
</div> |
| 232 |
|
|
|
| 233 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 234 |
|
|
<p class="short-description">This holds the default cellspacing</p> |
| 235 |
|
|
|
| 236 |
|
|
|
| 237 |
|
|
|
| 238 |
|
|
|
| 239 |
|
|
|
| 240 |
|
|
</div> |
| 241 |
|
|
<a name="var$_headers" id="$_headers"><!-- --></A> |
| 242 |
|
|
<div class="evenrow"> |
| 243 |
|
|
|
| 244 |
|
|
<div class="var-header"> |
| 245 |
|
|
<span class="var-title"> |
| 246 |
|
|
<span class="var-type">mixed</span> |
| 247 |
|
|
<span class="var-name">$_headers</span> |
| 248 |
|
|
= <span class="var-default">array()</span> (line <span class="line-number">29</span>) |
| 249 |
|
|
</span> |
| 250 |
jonen |
1.2 |
</div> |
| 251 |
jonen |
1.3 |
|
| 252 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 253 |
|
|
<p class="short-description">this holds the column header titles.</p> |
| 254 |
|
|
|
| 255 |
|
|
|
| 256 |
|
|
|
| 257 |
|
|
|
| 258 |
|
|
|
| 259 |
|
|
</div> |
| 260 |
|
|
<a name="var$_show_vertical_cellborder" id="$_show_vertical_cellborder"><!-- --></A> |
| 261 |
|
|
<div class="oddrow"> |
| 262 |
|
|
|
| 263 |
|
|
<div class="var-header"> |
| 264 |
|
|
<span class="var-title"> |
| 265 |
|
|
<span class="var-type">mixed</span> |
| 266 |
|
|
<span class="var-name">$_show_vertical_cellborder</span> |
| 267 |
|
|
= <span class="var-default"> TRUE</span> (line <span class="line-number">57</span>) |
| 268 |
|
|
</span> |
| 269 |
|
|
</div> |
| 270 |
|
|
|
| 271 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 272 |
|
|
<p class="short-description">Flag to tell the class to render</p> |
| 273 |
|
|
<p class="description"><p>the vertical cell border</p></p> |
| 274 |
|
|
|
| 275 |
|
|
|
| 276 |
|
|
|
| 277 |
|
|
|
| 278 |
|
|
|
| 279 |
|
|
</div> |
| 280 |
|
|
<a name="var$_title_css_class" id="$_title_css_class"><!-- --></A> |
| 281 |
|
|
<div class="evenrow"> |
| 282 |
|
|
|
| 283 |
|
|
<div class="var-header"> |
| 284 |
|
|
<span class="var-title"> |
| 285 |
|
|
<span class="var-type">mixed</span> |
| 286 |
|
|
<span class="var-name">$_title_css_class</span> |
| 287 |
|
|
= <span class="var-default"> "title"</span> (line <span class="line-number">45</span>) |
| 288 |
|
|
</span> |
| 289 |
|
|
</div> |
| 290 |
|
|
|
| 291 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 292 |
|
|
<p class="short-description">The default class used for the</p> |
| 293 |
|
|
<p class="description"><p>title</p></p> |
| 294 |
|
|
|
| 295 |
|
|
|
| 296 |
|
|
|
| 297 |
|
|
|
| 298 |
|
|
|
| 299 |
|
|
</div> |
| 300 |
|
|
<a name="var$_title_text_align" id="$_title_text_align"><!-- --></A> |
| 301 |
|
|
<div class="oddrow"> |
| 302 |
|
|
|
| 303 |
|
|
<div class="var-header"> |
| 304 |
|
|
<span class="var-title"> |
| 305 |
|
|
<span class="var-type">mixed</span> |
| 306 |
|
|
<span class="var-name">$_title_text_align</span> |
| 307 |
|
|
= <span class="var-default"> "left"</span> (line <span class="line-number">51</span>) |
| 308 |
|
|
</span> |
| 309 |
|
|
</div> |
| 310 |
|
|
|
| 311 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 312 |
|
|
<p class="short-description">The default alignment for the title text in the caption.</p> |
| 313 |
|
|
|
| 314 |
|
|
|
| 315 |
|
|
|
| 316 |
|
|
|
| 317 |
|
|
|
| 318 |
|
|
</div> |
| 319 |
|
|
<h4>Inherited Variables</h4> |
| 320 |
|
|
<A NAME='inherited_vars'><!-- --></A> |
| 321 |
|
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
| 322 |
|
|
<blockquote> |
| 323 |
|
|
<span class="var-title"> |
| 324 |
|
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> |
| 325 |
|
|
</span> |
| 326 |
|
|
<span class="var-title"> |
| 327 |
|
|
<span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> |
| 328 |
|
|
</span> |
| 329 |
|
|
</blockquote> |
| 330 |
|
|
<p>Inherited from <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
| 331 |
|
|
<blockquote> |
| 332 |
|
|
<span class="var-title"> |
| 333 |
|
|
<span class="var-name"><a href="../phpHtmlLib/Container.html#var$_flags">Container::$_flags</a></span><br> |
| 334 |
|
|
</span> |
| 335 |
|
|
</blockquote> |
| 336 |
|
|
|
| 337 |
|
|
</div> |
| 338 |
|
|
</div> |
| 339 |
|
|
|
| 340 |
|
|
<a name="sec-methods"></a> |
| 341 |
|
|
<div class="info-box"> |
| 342 |
|
|
<div class="info-box-title">Methods</div> |
| 343 |
|
|
<div class="nav-bar"> |
| 344 |
|
|
<a href="#sec-description">Description</a> | |
| 345 |
|
|
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
| 346 |
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
| 347 |
|
|
|
| 348 |
|
|
</div> |
| 349 |
|
|
<div class="info-box-body"> |
| 350 |
|
|
<A NAME='method_detail'></A> |
| 351 |
|
|
<a name="methodInfoTable" id="InfoTable"><!-- --></a> |
| 352 |
|
|
<div class="evenrow"> |
| 353 |
|
|
|
| 354 |
|
|
<div class="method-header"> |
| 355 |
|
|
<span class="method-title">Constructor InfoTable</span> (line <span class="line-number">68</span>) |
| 356 |
|
|
</div> |
| 357 |
|
|
|
| 358 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 359 |
|
|
<p class="short-description">The constructor</p> |
| 360 |
|
|
|
| 361 |
|
|
<div class="method-signature"> |
| 362 |
|
|
<span class="method-result">void</span> |
| 363 |
|
|
<span class="method-name"> |
| 364 |
|
|
InfoTable |
| 365 |
|
|
</span> |
| 366 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>, [<span class="var-type">string</span> <span class="var-name">$width</span> = <span class="var-default">"100%"</span>], [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">NULL</span>]) |
| 367 |
|
|
</div> |
| 368 |
|
|
|
| 369 |
|
|
<ul class="parameters"> |
| 370 |
|
|
<li> |
| 371 |
|
|
<span class="var-type">string</span> |
| 372 |
|
|
<span class="var-name">$title</span><span class="var-description">: <p>- the title</p></span> </li> |
| 373 |
|
|
<li> |
| 374 |
|
|
<span class="var-type">string</span> |
| 375 |
|
|
<span class="var-name">$width</span><span class="var-description">: <p>- the width of the table</p></span> </li> |
| 376 |
|
|
<li> |
| 377 |
|
|
<span class="var-type">string</span> |
| 378 |
|
|
<span class="var-name">$align</span><span class="var-description">: <p>- the alignment</p></span> </li> |
| 379 |
|
|
</ul> |
| 380 |
|
|
|
| 381 |
|
|
|
| 382 |
|
|
</div> |
| 383 |
|
|
<a name="methodadd_column_header" id="add_column_header"><!-- --></a> |
| 384 |
|
|
<div class="oddrow"> |
| 385 |
|
|
|
| 386 |
|
|
<div class="method-header"> |
| 387 |
|
|
<span class="method-title">add_column_header</span> (line <span class="line-number">131</span>) |
| 388 |
|
|
</div> |
| 389 |
|
|
|
| 390 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 391 |
|
|
<p class="short-description">This function is used to set the column header text for each column</p> |
| 392 |
|
|
|
| 393 |
|
|
<div class="method-signature"> |
| 394 |
|
|
<span class="method-result">void</span> |
| 395 |
|
|
<span class="method-name"> |
| 396 |
|
|
add_column_header |
| 397 |
|
|
</span> |
| 398 |
|
|
(<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">string</span> <span class="var-name">$width</span>, [<span class="var-type">mixed</span> <span class="var-name">$align</span> = <span class="var-default">"center"</span>]) |
| 399 |
|
|
</div> |
| 400 |
|
|
|
| 401 |
|
|
<ul class="parameters"> |
| 402 |
|
|
<li> |
| 403 |
|
|
<span class="var-type">string</span> |
| 404 |
|
|
<span class="var-name">$title</span><span class="var-description">: <p>- the title for the column</p></span> </li> |
| 405 |
|
|
<li> |
| 406 |
|
|
<span class="var-type">string</span> |
| 407 |
|
|
<span class="var-name">$width</span><span class="var-description">: <p>- the alignment of the title</p></span> </li> |
| 408 |
|
|
</ul> |
| 409 |
|
|
|
| 410 |
|
|
|
| 411 |
|
|
</div> |
| 412 |
|
|
<a name="methodadd_row" id="add_row"><!-- --></a> |
| 413 |
|
|
<div class="evenrow"> |
| 414 |
|
|
|
| 415 |
|
|
<div class="method-header"> |
| 416 |
|
|
<span class="method-title">add_row</span> (line <span class="line-number">142</span>) |
| 417 |
|
|
</div> |
| 418 |
|
|
|
| 419 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 420 |
|
|
<p class="short-description">This function is used to add a row to the table</p> |
| 421 |
|
|
|
| 422 |
|
|
<div class="method-signature"> |
| 423 |
|
|
<span class="method-result">void</span> |
| 424 |
|
|
<span class="method-name"> |
| 425 |
|
|
add_row |
| 426 |
|
|
</span> |
| 427 |
|
|
(<span class="var-type">mixed</span> <span class="var-name">0</span>) |
| 428 |
|
|
</div> |
| 429 |
|
|
|
| 430 |
|
|
<ul class="parameters"> |
| 431 |
|
|
<li> |
| 432 |
|
|
<span class="var-type">mixed</span> |
| 433 |
|
|
<span class="var-name">0</span><span class="var-description">: <p>- n number of items to push</p></span> </li> |
| 434 |
|
|
</ul> |
| 435 |
|
|
|
| 436 |
|
|
|
| 437 |
|
|
</div> |
| 438 |
|
|
<a name="methodget_cellpadding" id="get_cellpadding"><!-- --></a> |
| 439 |
|
|
<div class="oddrow"> |
| 440 |
|
|
|
| 441 |
|
|
<div class="method-header"> |
| 442 |
|
|
<span class="method-title">get_cellpadding</span> (line <span class="line-number">168</span>) |
| 443 |
|
|
</div> |
| 444 |
|
|
|
| 445 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 446 |
|
|
<p class="short-description">This gets the current value of the cellpadding</p> |
| 447 |
|
|
<ul class="tags"> |
| 448 |
|
|
<li><span class="field">return:</span> <p>- the current cellpadding</p></li> |
| 449 |
|
|
</ul> |
| 450 |
|
|
|
| 451 |
|
|
<div class="method-signature"> |
| 452 |
|
|
<span class="method-result">int</span> |
| 453 |
|
|
<span class="method-name"> |
| 454 |
|
|
get_cellpadding |
| 455 |
|
|
</span> |
| 456 |
|
|
() |
| 457 |
|
|
</div> |
| 458 |
|
|
|
| 459 |
|
|
|
| 460 |
|
|
|
| 461 |
|
|
</div> |
| 462 |
|
|
<a name="methodget_cellspacing" id="get_cellspacing"><!-- --></a> |
| 463 |
|
|
<div class="evenrow"> |
| 464 |
|
|
|
| 465 |
|
|
<div class="method-header"> |
| 466 |
|
|
<span class="method-title">get_cellspacing</span> (line <span class="line-number">188</span>) |
| 467 |
|
|
</div> |
| 468 |
|
|
|
| 469 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 470 |
|
|
<p class="short-description">This gets the current value of the cellspacing</p> |
| 471 |
|
|
<ul class="tags"> |
| 472 |
|
|
<li><span class="field">return:</span> <p>- the current cellspacing</p></li> |
| 473 |
|
|
</ul> |
| 474 |
|
|
|
| 475 |
|
|
<div class="method-signature"> |
| 476 |
|
|
<span class="method-result">int</span> |
| 477 |
|
|
<span class="method-name"> |
| 478 |
|
|
get_cellspacing |
| 479 |
|
|
</span> |
| 480 |
|
|
() |
| 481 |
|
|
</div> |
| 482 |
|
|
|
| 483 |
|
|
|
| 484 |
|
|
|
| 485 |
|
|
</div> |
| 486 |
|
|
<a name="methodget_title_text_align" id="get_title_text_align"><!-- --></a> |
| 487 |
|
|
<div class="oddrow"> |
| 488 |
|
|
|
| 489 |
|
|
<div class="method-header"> |
| 490 |
|
|
<span class="method-title">get_title_text_align</span> (line <span class="line-number">208</span>) |
| 491 |
|
|
</div> |
| 492 |
|
|
|
| 493 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 494 |
|
|
<p class="short-description">this function lets gets the default css class for the title</p> |
| 495 |
|
|
<ul class="tags"> |
| 496 |
|
|
<li><span class="field">return:</span> <p>- the css class to use</p></li> |
| 497 |
|
|
</ul> |
| 498 |
|
|
|
| 499 |
|
|
<div class="method-signature"> |
| 500 |
|
|
<span class="method-result">string</span> |
| 501 |
|
|
<span class="method-name"> |
| 502 |
|
|
get_title_text_align |
| 503 |
|
|
</span> |
| 504 |
|
|
() |
| 505 |
|
|
</div> |
| 506 |
|
|
|
| 507 |
|
|
|
| 508 |
|
|
|
| 509 |
|
|
</div> |
| 510 |
|
|
<a name="methodget_vertical_cellborder" id="get_vertical_cellborder"><!-- --></a> |
| 511 |
|
|
<div class="evenrow"> |
| 512 |
|
|
|
| 513 |
|
|
<div class="method-header"> |
| 514 |
|
|
<span class="method-title">get_vertical_cellborder</span> (line <span class="line-number">229</span>) |
| 515 |
|
|
</div> |
| 516 |
|
|
|
| 517 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 518 |
|
|
<p class="short-description">this function lets gets the default css class for the title</p> |
| 519 |
|
|
<ul class="tags"> |
| 520 |
|
|
<li><span class="field">return:</span> <p>- the css class to use</p></li> |
| 521 |
|
|
</ul> |
| 522 |
|
|
|
| 523 |
|
|
<div class="method-signature"> |
| 524 |
|
|
<span class="method-result">string</span> |
| 525 |
|
|
<span class="method-name"> |
| 526 |
|
|
get_vertical_cellborder |
| 527 |
|
|
</span> |
| 528 |
|
|
() |
| 529 |
|
|
</div> |
| 530 |
|
|
|
| 531 |
|
|
|
| 532 |
|
|
|
| 533 |
|
|
</div> |
| 534 |
|
|
<a name="methodrender" id="render"><!-- --></a> |
| 535 |
|
|
<div class="oddrow"> |
| 536 |
|
|
|
| 537 |
|
|
<div class="method-header"> |
| 538 |
|
|
<span class="method-title">render</span> (line <span class="line-number">84</span>) |
| 539 |
|
|
</div> |
| 540 |
|
|
|
| 541 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 542 |
|
|
<p class="short-description">This function renders the object.</p> |
| 543 |
|
|
<ul class="tags"> |
| 544 |
|
|
<li><span class="field">return:</span> <p>the raw html output.</p></li> |
| 545 |
|
|
</ul> |
| 546 |
|
|
|
| 547 |
|
|
<div class="method-signature"> |
| 548 |
|
|
<span class="method-result">string</span> |
| 549 |
|
|
<span class="method-name"> |
| 550 |
|
|
render |
| 551 |
|
|
</span> |
| 552 |
|
|
([<span class="var-type">int</span> <span class="var-name">$indent_level</span> = <span class="var-default">1</span>], <span class="var-type">int</span> <span class="var-name">$output_debug</span>) |
| 553 |
|
|
</div> |
| 554 |
|
|
|
| 555 |
|
|
<ul class="parameters"> |
| 556 |
|
|
<li> |
| 557 |
|
|
<span class="var-type">int</span> |
| 558 |
|
|
<span class="var-name">$indent_level</span><span class="var-description">: <p>- the indentation level for the container.</p></span> </li> |
| 559 |
|
|
<li> |
| 560 |
|
|
<span class="var-type">int</span> |
| 561 |
|
|
<span class="var-name">$output_debug</span><span class="var-description">: <p>- the output debug flag to maintain compatibility w/ the API.</p></span> </li> |
| 562 |
|
|
</ul> |
| 563 |
|
|
|
| 564 |
|
|
<hr class="separator" /> |
| 565 |
|
|
<div class="notes">Redefinition of:</div> |
| 566 |
|
|
<dl> |
| 567 |
|
|
<dt><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></dt> |
| 568 |
|
|
<dd>This function is compatible with the rest of the phpHtmllib API spec.</dd> |
| 569 |
|
|
</dl> |
| 570 |
|
|
|
| 571 |
|
|
</div> |
| 572 |
|
|
<a name="methodset_cellpadding" id="set_cellpadding"><!-- --></a> |
| 573 |
|
|
<div class="evenrow"> |
| 574 |
|
|
|
| 575 |
|
|
<div class="method-header"> |
| 576 |
|
|
<span class="method-title">set_cellpadding</span> (line <span class="line-number">158</span>) |
| 577 |
|
|
</div> |
| 578 |
|
|
|
| 579 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 580 |
|
|
<p class="short-description">This sets the cellpadding attribute for this object.</p> |
| 581 |
|
|
|
| 582 |
|
|
<div class="method-signature"> |
| 583 |
|
|
<span class="method-result">void</span> |
| 584 |
|
|
<span class="method-name"> |
| 585 |
|
|
set_cellpadding |
| 586 |
|
|
</span> |
| 587 |
|
|
(<span class="var-type">int</span> <span class="var-name">$pad</span>) |
| 588 |
|
|
</div> |
| 589 |
|
|
|
| 590 |
|
|
<ul class="parameters"> |
| 591 |
|
|
<li> |
| 592 |
|
|
<span class="var-type">int</span> |
| 593 |
|
|
<span class="var-name">$pad</span><span class="var-description">: <p>- the cellpadding value</p></span> </li> |
| 594 |
|
|
</ul> |
| 595 |
|
|
|
| 596 |
|
|
|
| 597 |
|
|
</div> |
| 598 |
|
|
<a name="methodset_cellspacing" id="set_cellspacing"><!-- --></a> |
| 599 |
|
|
<div class="oddrow"> |
| 600 |
|
|
|
| 601 |
|
|
<div class="method-header"> |
| 602 |
|
|
<span class="method-title">set_cellspacing</span> (line <span class="line-number">178</span>) |
| 603 |
|
|
</div> |
| 604 |
|
|
|
| 605 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 606 |
|
|
<p class="short-description">This sets the cellspacing attribute for this object.</p> |
| 607 |
|
|
|
| 608 |
|
|
<div class="method-signature"> |
| 609 |
|
|
<span class="method-result">void</span> |
| 610 |
|
|
<span class="method-name"> |
| 611 |
|
|
set_cellspacing |
| 612 |
|
|
</span> |
| 613 |
|
|
(<span class="var-type">int</span> <span class="var-name">$spacing</span>) |
| 614 |
|
|
</div> |
| 615 |
|
|
|
| 616 |
|
|
<ul class="parameters"> |
| 617 |
|
|
<li> |
| 618 |
|
|
<span class="var-type">int</span> |
| 619 |
|
|
<span class="var-name">$spacing</span><span class="var-description">: <p>- the cellspacing value</p></span> </li> |
| 620 |
|
|
</ul> |
| 621 |
|
|
|
| 622 |
|
|
|
| 623 |
|
|
</div> |
| 624 |
|
|
<a name="methodset_title_text_align" id="set_title_text_align"><!-- --></a> |
| 625 |
|
|
<div class="evenrow"> |
| 626 |
|
|
|
| 627 |
|
|
<div class="method-header"> |
| 628 |
|
|
<span class="method-title">set_title_text_align</span> (line <span class="line-number">198</span>) |
| 629 |
|
|
</div> |
| 630 |
|
|
|
| 631 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 632 |
|
|
<p class="short-description">this function lets you change the text alignment of the text in the title</p> |
| 633 |
|
|
|
| 634 |
|
|
<div class="method-signature"> |
| 635 |
|
|
<span class="method-result">void</span> |
| 636 |
|
|
<span class="method-name"> |
| 637 |
|
|
set_title_text_align |
| 638 |
|
|
</span> |
| 639 |
|
|
([<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">"left"</span>]) |
| 640 |
|
|
</div> |
| 641 |
|
|
|
| 642 |
|
|
<ul class="parameters"> |
| 643 |
|
|
<li> |
| 644 |
|
|
<span class="var-type">string</span> |
| 645 |
|
|
<span class="var-name">$align</span><span class="var-description">: <p>- the alignment.</p></span> </li> |
| 646 |
|
|
</ul> |
| 647 |
|
|
|
| 648 |
|
|
|
| 649 |
|
|
</div> |
| 650 |
|
|
<a name="methodset_vertical_cellborder" id="set_vertical_cellborder"><!-- --></a> |
| 651 |
|
|
<div class="oddrow"> |
| 652 |
|
|
|
| 653 |
|
|
<div class="method-header"> |
| 654 |
|
|
<span class="method-title">set_vertical_cellborder</span> (line <span class="line-number">219</span>) |
| 655 |
|
|
</div> |
| 656 |
|
|
|
| 657 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 658 |
|
|
<p class="short-description">this function sets the flag to tell the object to render (or not) the vertical cell borders</p> |
| 659 |
|
|
|
| 660 |
|
|
<div class="method-signature"> |
| 661 |
|
|
<span class="method-result">void</span> |
| 662 |
|
|
<span class="method-name"> |
| 663 |
|
|
set_vertical_cellborder |
| 664 |
|
|
</span> |
| 665 |
|
|
([<span class="var-type">boolean</span> <span class="var-name">$flag</span> = <span class="var-default">TRUE</span>]) |
| 666 |
|
|
</div> |
| 667 |
|
|
|
| 668 |
|
|
<ul class="parameters"> |
| 669 |
|
|
<li> |
| 670 |
|
|
<span class="var-type">boolean</span> |
| 671 |
|
|
<span class="var-name">$flag</span> </li> |
| 672 |
|
|
</ul> |
| 673 |
|
|
|
| 674 |
|
|
|
| 675 |
|
|
</div> |
| 676 |
|
|
<a name="method_build_header" id="_build_header"><!-- --></a> |
| 677 |
|
|
<div class="evenrow"> |
| 678 |
|
|
|
| 679 |
|
|
<div class="method-header"> |
| 680 |
|
|
<span class="method-title">_build_header</span> (line <span class="line-number">258</span>) |
| 681 |
|
|
</div> |
| 682 |
|
|
|
| 683 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 684 |
|
|
<p class="short-description">This function builds the table header</p> |
| 685 |
|
|
<ul class="tags"> |
| 686 |
|
|
<li><span class="field">return:</span> <p>object</p></li> |
| 687 |
|
|
</ul> |
| 688 |
|
|
|
| 689 |
|
|
<div class="method-signature"> |
| 690 |
|
|
<span class="method-result"><a href="../phpHtmlLib/TRtag.html">TRtag</a></span> |
| 691 |
|
|
<span class="method-name"> |
| 692 |
|
|
_build_header |
| 693 |
|
|
</span> |
| 694 |
|
|
() |
| 695 |
|
|
</div> |
| 696 |
|
|
|
| 697 |
|
|
|
| 698 |
|
|
|
| 699 |
|
|
</div> |
| 700 |
|
|
<a name="method_build_td" id="_build_td"><!-- --></a> |
| 701 |
|
|
<div class="oddrow"> |
| 702 |
|
|
|
| 703 |
|
|
<div class="method-header"> |
| 704 |
|
|
<span class="method-title">_build_td</span> (line <span class="line-number">292</span>) |
| 705 |
|
|
</div> |
| 706 |
|
|
|
| 707 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 708 |
|
|
<p class="short-description">this function builds a TD tag with the border styles set appropriatly</p> |
| 709 |
|
|
<ul class="tags"> |
| 710 |
|
|
<li><span class="field">return:</span> <p>object.</p></li> |
| 711 |
|
|
</ul> |
| 712 |
|
|
|
| 713 |
|
|
<div class="method-signature"> |
| 714 |
|
|
<span class="method-result"><a href="../phpHtmlLib/TDtag.html">TDtag</a></span> |
| 715 |
|
|
<span class="method-name"> |
| 716 |
|
|
_build_td |
| 717 |
|
|
</span> |
| 718 |
|
|
([<span class="var-type">int</span> <span class="var-name">$width</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$align</span> = <span class="var-default">""</span>], <span class="var-type">int</span> <span class="var-name">$col_num</span>, <span class="var-type">int</span> <span class="var-name">$total_cols</span>) |
| 719 |
|
|
</div> |
| 720 |
|
|
|
| 721 |
|
|
<ul class="parameters"> |
| 722 |
|
|
<li> |
| 723 |
|
|
<span class="var-type">int</span> |
| 724 |
|
|
<span class="var-name">$width</span><span class="var-description">: <p>- the width</p></span> </li> |
| 725 |
|
|
<li> |
| 726 |
|
|
<span class="var-type">string</span> |
| 727 |
|
|
<span class="var-name">$align</span><span class="var-description">: <p>- the alignment</p></span> </li> |
| 728 |
|
|
<li> |
| 729 |
|
|
<span class="var-type">int</span> |
| 730 |
|
|
<span class="var-name">$col_num</span><span class="var-description">: <p>- the current col #</p></span> </li> |
| 731 |
|
|
<li> |
| 732 |
|
|
<span class="var-type">int</span> |
| 733 |
|
|
<span class="var-name">$total_cols</span><span class="var-description">: <p>- the max cols</p></span> </li> |
| 734 |
|
|
</ul> |
| 735 |
|
|
|
| 736 |
|
|
|
| 737 |
|
|
</div> |
| 738 |
|
|
<a name="method_build_title" id="_build_title"><!-- --></a> |
| 739 |
|
|
<div class="evenrow"> |
| 740 |
|
|
|
| 741 |
|
|
<div class="method-header"> |
| 742 |
|
|
<span class="method-title">_build_title</span> (line <span class="line-number">246</span>) |
| 743 |
|
|
</div> |
| 744 |
|
|
|
| 745 |
|
|
<!-- ========== Info from phpDoc block ========= --> |
| 746 |
|
|
<p class="short-description">This function builds the title container</p> |
| 747 |
|
|
<ul class="tags"> |
| 748 |
|
|
<li><span class="field">return:</span> <p>object</p></li> |
| 749 |
|
|
</ul> |
| 750 |
|
|
|
| 751 |
|
|
<div class="method-signature"> |
| 752 |
|
|
<span class="method-result"><a href="../phpHtmlLib/CAPTIONtag.html">CAPTIONtag</a></span> |
| 753 |
|
|
<span class="method-name"> |
| 754 |
|
|
_build_title |
| 755 |
|
|
</span> |
| 756 |
|
|
() |
| 757 |
|
|
</div> |
| 758 |
|
|
|
| 759 |
|
|
|
| 760 |
|
|
|
| 761 |
|
|
</div> |
| 762 |
|
|
<h4>Inherited Methods</h4> |
| 763 |
|
|
<a name='inherited_methods'><!-- --></a> |
| 764 |
|
|
<!-- =========== Summary =========== --> |
| 765 |
|
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> |
| 766 |
|
|
<blockquote> |
| 767 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> |
| 768 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> |
| 769 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> |
| 770 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> |
| 771 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> |
| 772 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> |
| 773 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> |
| 774 |
|
|
<span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> |
| 775 |
|
|
</blockquote> |
| 776 |
|
|
<!-- =========== Summary =========== --> |
| 777 |
|
|
<p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> |
| 778 |
|
|
<blockquote> |
| 779 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> |
| 780 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> |
| 781 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> |
| 782 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> |
| 783 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> |
| 784 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> |
| 785 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> |
| 786 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> |
| 787 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> |
| 788 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> |
| 789 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> |
| 790 |
|
|
<span class="method-name"><a href="../phpHtmlLib/Container.html#method_set_flags">Container::_set_flags()</a></span><br> |
| 791 |
|
|
</blockquote> |
| 792 |
|
|
|
| 793 |
|
|
</div> |
| 794 |
|
|
</div> |
| 795 |
|
|
|
| 796 |
|
|
<p class="notes" id="credit"> |
| 797 |
|
|
Documention generated on Thu, 31 Jul 2003 18:32:52 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
| 798 |
|
|
</p> |
| 799 |
|
|
</div></body> |
| 800 |
jonen |
1.2 |
</html> |
Parent Directory
| 
Revision Log
