| 1 | jonen | 1.1 | <?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 StandardDialogWidget</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 StandardDialogWidget</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-descendents">Descendents</a> | 
| 20 |  |  | |                                                                                       <a href="#sec-vars">Vars</a> | 
| 21 |  |  | |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) | 
| 22 |  |  |  | 
| 23 |  |  | </div> | 
| 24 |  |  | <div class="info-box-body"> | 
| 25 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 26 |  |  | <p class="short-description">This class is used to build a DialogWidget that  can have 'blocks' for messages.</p> | 
| 27 |  |  | <ul class="tags"> | 
| 28 |  |  | <li><span class="field">author:</span> Walter A. Boring IV <<a href="mailto:waboring@buildabetterweb.com">waboring@buildabetterweb.com</a>></li> | 
| 29 |  |  | </ul> | 
| 30 |  |  | <p class="notes"> | 
| 31 |  |  | Located in <a class="field" href="_widgets_StandardDialogWidget_inc.html">/widgets/StandardDialogWidget.inc</a> (line <span class="field">23</span>) | 
| 32 |  |  | </p> | 
| 33 |  |  |  | 
| 34 |  |  |  | 
| 35 |  |  | <pre><a href="../phpHtmlLib/Container.html">Container</a> | 
| 36 |  |  | | | 
| 37 |  |  | --<a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a> | 
| 38 |  |  | | | 
| 39 |  |  | --<a href="../phpHtmlLib/DialogWidget.html">DialogWidget</a> | 
| 40 |  |  | | | 
| 41 |  |  | --StandardDialogWidget</pre> | 
| 42 |  |  |  | 
| 43 |  |  | </div> | 
| 44 |  |  | </div> | 
| 45 |  |  |  | 
| 46 |  |  | <a name="sec-descendents"></a> | 
| 47 |  |  | <div class="info-box"> | 
| 48 |  |  | <div class="info-box-title">Direct descendents</div> | 
| 49 |  |  | <div class="nav-bar"> | 
| 50 |  |  | <a href="#sec-description">Description</a> | | 
| 51 |  |  | <span class="disabled">Descendents</span> | 
| 52 |  |  | |                                                                                               <a href="#sec-vars">Vars</a> | 
| 53 |  |  | |                                                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) | 
| 54 |  |  |  | 
| 55 |  |  | </div> | 
| 56 |  |  | <div class="info-box-body"> | 
| 57 |  |  | <table cellpadding="2" cellspacing="0" class="class-table"> | 
| 58 |  |  | <tr> | 
| 59 |  |  | <th class="class-table-header">Class</th> | 
| 60 |  |  | <th class="class-table-header">Description</th> | 
| 61 |  |  | </tr> | 
| 62 |  |  | <tr> | 
| 63 |  |  | <td style="padding-right: 2em"><a href="../phpHtmlLib/MessageBoxWidget.html">MessageBoxWidget</a></td> | 
| 64 |  |  | <td> | 
| 65 |  |  | This class is used to build a DialogWidget that  can have 'blocks' for messages. | 
| 66 |  |  | </td> | 
| 67 |  |  | </tr> | 
| 68 |  |  | </table> | 
| 69 |  |  | </div> | 
| 70 |  |  | </div> | 
| 71 |  |  |  | 
| 72 |  |  |  | 
| 73 |  |  |  | 
| 74 |  |  | <a name="sec-method-summary"></a> | 
| 75 |  |  | <div class="info-box"> | 
| 76 |  |  | <div class="info-box-title">Method Summary</span></div> | 
| 77 |  |  | <div class="nav-bar"> | 
| 78 |  |  | <a href="#sec-description">Description</a> | | 
| 79 |  |  | <a href="#sec-descendents">Descendents</a> | | 
| 80 |  |  | <a href="#sec-vars">Vars</a> | 
| 81 |  |  |  | 
| 82 |  |  | | | 
| 83 |  |  | <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) | 
| 84 |  |  | </div> | 
| 85 |  |  | <div class="info-box-body"> | 
| 86 |  |  | <div class="method-summary"> | 
| 87 |  |  |  | 
| 88 |  |  | <div class="method-definition"> | 
| 89 |  |  | <span class="method-result">void</span> | 
| 90 |  |  | <a href="#add_block" title="details" class="method-name">add_block</a> | 
| 91 |  |  | (<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">mixed</span> <span class="var-name">$content</span>) | 
| 92 |  |  | </div> | 
| 93 |  |  |  | 
| 94 |  |  | <div class="method-definition"> | 
| 95 |  |  | <span class="method-result">object -</span> | 
| 96 |  |  | <a href="#_build_message_container" title="details" class="method-name">&_build_message_container</a> | 
| 97 |  |  | () | 
| 98 |  |  | </div> | 
| 99 |  |  | </div> | 
| 100 |  |  | </div> | 
| 101 |  |  | </div> | 
| 102 |  |  |  | 
| 103 |  |  | <a name="sec-vars"></a> | 
| 104 |  |  | <div class="info-box"> | 
| 105 |  |  | <div class="info-box-title">Variables</div> | 
| 106 |  |  | <div class="nav-bar"> | 
| 107 |  |  | <a href="#sec-description">Description</a> | | 
| 108 |  |  | <a href="#sec-descendents">Descendents</a> | | 
| 109 |  |  | <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) | 
| 110 |  |  |  | 
| 111 |  |  |  | 
| 112 |  |  | | | 
| 113 |  |  | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) | 
| 114 |  |  |  | 
| 115 |  |  | </div> | 
| 116 |  |  | <div class="info-box-body"> | 
| 117 |  |  | <h4>Inherited Variables</h4> | 
| 118 |  |  | <A NAME='inherited_vars'><!-- --></A> | 
| 119 |  |  | <p>Inherited from <span class="classname"><a href="../phpHtmlLib/DialogWidget.html">DialogWidget</a></span></p> | 
| 120 |  |  | <blockquote> | 
| 121 |  |  | <span class="var-title"> | 
| 122 |  |  | <span class="var-name"><a href="../phpHtmlLib/DialogWidget.html#var$_buttons">DialogWidget::$_buttons</a></span><br> | 
| 123 |  |  | </span> | 
| 124 |  |  | <span class="var-title"> | 
| 125 |  |  | <span class="var-name"><a href="../phpHtmlLib/DialogWidget.html#var$_cancel_url">DialogWidget::$_cancel_url</a></span><br> | 
| 126 |  |  | </span> | 
| 127 |  |  | <span class="var-title"> | 
| 128 |  |  | <span class="var-name"><a href="../phpHtmlLib/DialogWidget.html#var$_show_cancel_button">DialogWidget::$_show_cancel_button</a></span><br> | 
| 129 |  |  | </span> | 
| 130 |  |  | </blockquote> | 
| 131 |  |  | <p>Inherited from <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> | 
| 132 |  |  | <blockquote> | 
| 133 |  |  | <span class="var-title"> | 
| 134 |  |  | <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$title">BaseWidget::$title</a></span><br> | 
| 135 |  |  | </span> | 
| 136 |  |  | <span class="var-title"> | 
| 137 |  |  | <span class="var-name"><a href="../phpHtmlLib/BaseWidget.html#var$width">BaseWidget::$width</a></span><br> | 
| 138 |  |  | </span> | 
| 139 |  |  | </blockquote> | 
| 140 |  |  |  | 
| 141 |  |  | </div> | 
| 142 |  |  | </div> | 
| 143 |  |  |  | 
| 144 |  |  | <a name="sec-methods"></a> | 
| 145 |  |  | <div class="info-box"> | 
| 146 |  |  | <div class="info-box-title">Methods</div> | 
| 147 |  |  | <div class="nav-bar"> | 
| 148 |  |  | <a href="#sec-description">Description</a> | | 
| 149 |  |  | <a href="#sec-descendents">Descendents</a> | | 
| 150 |  |  | <a href="#sec-vars">Vars</a> | 
| 151 |  |  | <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) | 
| 152 |  |  |  | 
| 153 |  |  | </div> | 
| 154 |  |  | <div class="info-box-body"> | 
| 155 |  |  | <A NAME='method_detail'></A> | 
| 156 |  |  | <a name="methodadd_block" id="add_block"><!-- --></a> | 
| 157 |  |  | <div class="oddrow"> | 
| 158 |  |  |  | 
| 159 |  |  | <div class="method-header"> | 
| 160 |  |  | <span class="method-title">add_block</span> (line <span class="line-number">35</span>) | 
| 161 |  |  | </div> | 
| 162 |  |  |  | 
| 163 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 164 |  |  | <p class="short-description">Pushes a block content onto the data object  Each pushed block is separated by some white space  defined in $_block_spacing</p> | 
| 165 |  |  | <ul class="tags"> | 
| 166 |  |  | <li><span class="field">access:</span> public</li> | 
| 167 |  |  | </ul> | 
| 168 |  |  |  | 
| 169 |  |  | <div class="method-signature"> | 
| 170 |  |  | <span class="method-result">void</span> | 
| 171 |  |  | <span class="method-name"> | 
| 172 |  |  | add_block | 
| 173 |  |  | </span> | 
| 174 |  |  | (<span class="var-type">string</span> <span class="var-name">$title</span>, <span class="var-type">mixed</span> <span class="var-name">$content</span>) | 
| 175 |  |  | </div> | 
| 176 |  |  |  | 
| 177 |  |  | <ul class="parameters"> | 
| 178 |  |  | <li> | 
| 179 |  |  | <span class="var-type">string</span> | 
| 180 |  |  | <span class="var-name">$title</span><span class="var-description">: - block title</span>                        </li> | 
| 181 |  |  | <li> | 
| 182 |  |  | <span class="var-type">mixed</span> | 
| 183 |  |  | <span class="var-name">$content</span><span class="var-description">: - either string, or tag object.</span>                    </li> | 
| 184 |  |  | </ul> | 
| 185 |  |  |  | 
| 186 |  |  |  | 
| 187 |  |  | </div> | 
| 188 |  |  | <a name="method_build_message_container" id="_build_message_container"><!-- --></a> | 
| 189 |  |  | <div class="evenrow"> | 
| 190 |  |  |  | 
| 191 |  |  | <div class="method-header"> | 
| 192 |  |  | <span class="method-title">_build_message_container</span> (line <span class="line-number">47</span>) | 
| 193 |  |  | </div> | 
| 194 |  |  |  | 
| 195 |  |  | <!-- ========== Info from phpDoc block ========= --> | 
| 196 |  |  | <p class="short-description">This method is used to add the message blocks  to the appropriate container</p> | 
| 197 |  |  | <ul class="tags"> | 
| 198 |  |  | <li><span class="field">return:</span> the container object with the messages.</li> | 
| 199 |  |  | </ul> | 
| 200 |  |  |  | 
| 201 |  |  | <div class="method-signature"> | 
| 202 |  |  | <span class="method-result">object -</span> | 
| 203 |  |  | <span class="method-name"> | 
| 204 |  |  | &_build_message_container | 
| 205 |  |  | </span> | 
| 206 |  |  | () | 
| 207 |  |  | </div> | 
| 208 |  |  |  | 
| 209 |  |  |  | 
| 210 |  |  | <hr class="separator" /> | 
| 211 |  |  | <div class="notes">Redefinition of:</div> | 
| 212 |  |  | <dl> | 
| 213 |  |  | <dt><a href="../phpHtmlLib/DialogWidget.html#method_build_message_container">DialogWidget::_build_message_container()</a></dt> | 
| 214 |  |  | <dd>This method is used to add the message blocks  to the appropriate container</dd> | 
| 215 |  |  | </dl> | 
| 216 |  |  |  | 
| 217 |  |  | </div> | 
| 218 |  |  | <h4>Inherited Methods</h4> | 
| 219 |  |  | <a name='inherited_methods'><!-- --></a> | 
| 220 |  |  | <!-- =========== Summary =========== --> | 
| 221 |  |  | <p>Inherited From <span class="classname"><a href="../phpHtmlLib/DialogWidget.html">DialogWidget</a></span></p> | 
| 222 |  |  | <blockquote> | 
| 223 |  |  | <span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#methodDialogWidget">DialogWidget::DialogWidget()</a></span><br> | 
| 224 |  |  | <span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#methodadd">DialogWidget::add()</a></span><br> | 
| 225 |  |  | <span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#methodadd_button">DialogWidget::add_button()</a></span><br> | 
| 226 |  |  | <span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#methodrender">DialogWidget::render()</a></span><br> | 
| 227 |  |  | <span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#methodset_cancel_url">DialogWidget::set_cancel_url()</a></span><br> | 
| 228 |  |  | <span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#methodshow_cancel_button">DialogWidget::show_cancel_button()</a></span><br> | 
| 229 |  |  | <span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#method_build_cancel_url">DialogWidget::_build_cancel_url()</a></span><br> | 
| 230 |  |  | <span class="method-name"><a href="../phpHtmlLib/DialogWidget.html#method_build_message_container">DialogWidget::_build_message_container()</a></span><br> | 
| 231 |  |  | </blockquote> | 
| 232 |  |  | <!-- =========== Summary =========== --> | 
| 233 |  |  | <p>Inherited From <span class="classname"><a href="../phpHtmlLib/BaseWidget.html">BaseWidget</a></span></p> | 
| 234 |  |  | <blockquote> | 
| 235 |  |  | <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_align">BaseWidget::get_align()</a></span><br> | 
| 236 |  |  | <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_css">BaseWidget::get_css()</a></span><br> | 
| 237 |  |  | <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_javascript">BaseWidget::get_javascript()</a></span><br> | 
| 238 |  |  | <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_title">BaseWidget::get_title()</a></span><br> | 
| 239 |  |  | <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodget_width">BaseWidget::get_width()</a></span><br> | 
| 240 |  |  | <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_align">BaseWidget::set_align()</a></span><br> | 
| 241 |  |  | <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_title">BaseWidget::set_title()</a></span><br> | 
| 242 |  |  | <span class="method-name"><a href="../phpHtmlLib/BaseWidget.html#methodset_width">BaseWidget::set_width()</a></span><br> | 
| 243 |  |  | </blockquote> | 
| 244 |  |  | <!-- =========== Summary =========== --> | 
| 245 |  |  | <p>Inherited From <span class="classname"><a href="../phpHtmlLib/Container.html">Container</a></span></p> | 
| 246 |  |  | <blockquote> | 
| 247 |  |  | <span class="method-name"><a href="../phpHtmlLib/Container.html#methodContainer">Container::Container()</a></span><br> | 
| 248 |  |  | <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd">Container::add()</a></span><br> | 
| 249 |  |  | <span class="method-name"><a href="../phpHtmlLib/Container.html#methodadd_reference">Container::add_reference()</a></span><br> | 
| 250 |  |  | <span class="method-name"><a href="../phpHtmlLib/Container.html#methodcount_content">Container::count_content()</a></span><br> | 
| 251 |  |  | <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_element">Container::get_element()</a></span><br> | 
| 252 |  |  | <span class="method-name"><a href="../phpHtmlLib/Container.html#methodget_indent_flag">Container::get_indent_flag()</a></span><br> | 
| 253 |  |  | <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush">Container::push()</a></span><br> | 
| 254 |  |  | <span class="method-name"><a href="../phpHtmlLib/Container.html#methodpush_reference">Container::push_reference()</a></span><br> | 
| 255 |  |  | <span class="method-name"><a href="../phpHtmlLib/Container.html#methodrender">Container::render()</a></span><br> | 
| 256 |  |  | <span class="method-name"><a href="../phpHtmlLib/Container.html#methodreset_content">Container::reset_content()</a></span><br> | 
| 257 |  |  | <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_collapse">Container::set_collapse()</a></span><br> | 
| 258 |  |  | <span class="method-name"><a href="../phpHtmlLib/Container.html#methodset_indent_flag">Container::set_indent_flag()</a></span><br> | 
| 259 |  |  | </blockquote> | 
| 260 |  |  |  | 
| 261 |  |  | </div> | 
| 262 |  |  | </div> | 
| 263 |  |  |  | 
| 264 |  |  |  | 
| 265 |  |  | <p class="notes" id="credit"> | 
| 266 |  |  | Documentation generated on Thu,  1 Apr 2004 09:39:13 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> | 
| 267 |  |  | </p> | 
| 268 |  |  | </div></body> | 
| 269 |  |  | </html> |