docs/api/awl/Browser/_classBrowser.php.html

   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 page classBrowser.php</title>
   7                         <link rel="stylesheet" href="../../media/stylesheet.css" />
   8                                                 <script src="../../media/lib/classTree.js"></script>
   9                                                                                                 <script language="javascript" type="text/javascript">
  10                                 var imgPlus = new Image();
  11                                 var imgMinus = new Image();
  12                                 imgPlus.src = "../../media/images/plus.png";
  13                                 imgMinus.src = "../../media/images/minus.png";
  14
  15                                 function showNode(Node){
  16                                                         switch(navigator.family){
  17                                                                 case 'nn4':
  18                                                                         // Nav 4.x code fork...
  19                                                         var oTable = document.layers["span" + Node];
  20                                                         var oImg = document.layers["img" + Node];
  21                                                                         break;
  22                                                                 case 'ie4':
  23                                                                         // IE 4/5 code fork...
  24                                                         var oTable = document.all["span" + Node];
  25                                                         var oImg = document.all["img" + Node];
  26                                                                         break;
  27                                                                 case 'gecko':
  28                                                                         // Standards Compliant code fork...
  29                                                         var oTable = document.getElementById("span" + Node);
  30                                                         var oImg = document.getElementById("img" + Node);
  31                                                                         break;
  32                                                         }
  33                                         oImg.src = imgMinus.src;
  34                                         oTable.style.display = "block";
  35                                 }
  36
  37                                 function hideNode(Node){
  38                                                         switch(navigator.family){
  39                                                                 case 'nn4':
  40                                                                         // Nav 4.x code fork...
  41                                                         var oTable = document.layers["span" + Node];
  42                                                         var oImg = document.layers["img" + Node];
  43                                                                         break;
  44                                                                 case 'ie4':
  45                                                                         // IE 4/5 code fork...
  46                                                         var oTable = document.all["span" + Node];
  47                                                         var oImg = document.all["img" + Node];
  48                                                                         break;
  49                                                                 case 'gecko':
  50                                                                         // Standards Compliant code fork...
  51                                                         var oTable = document.getElementById("span" + Node);
  52                                                         var oImg = document.getElementById("img" + Node);
  53                                                                         break;
  54                                                         }
  55                                         oImg.src = imgPlus.src;
  56                                         oTable.style.display = "none";
  57                                 }
  58
  59                                 function nodeIsVisible(Node){
  60                                                         switch(navigator.family){
  61                                                                 case 'nn4':
  62                                                                         // Nav 4.x code fork...
  63                                                         var oTable = document.layers["span" + Node];
  64                                                                         break;
  65                                                                 case 'ie4':
  66                                                                         // IE 4/5 code fork...
  67                                                         var oTable = document.all["span" + Node];
  68                                                                         break;
  69                                                                 case 'gecko':
  70                                                                         // Standards Compliant code fork...
  71                                                         var oTable = document.getElementById("span" + Node);
  72                                                                         break;
  73                                                         }
  74                                         return (oTable && oTable.style.display == "block");
  75                                 }
  76
  77                                 function toggleNodeVisibility(Node){
  78                                         if (nodeIsVisible(Node)){
  79                                                 hideNode(Node);
  80                                         }else{
  81                                                 showNode(Node);
  82                                         }
  83                                 }
  84                         </script>
  85                                         </head>
  86                 <body>
  87                         <div class="page-body">
  88 <h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/classBrowser.php</h2>
  89
  90 <a name="sec-description"></a>
  91 <div class="info-box">
  92         <div class="info-box-title">Description</div>
  93         <div class="nav-bar">
  94                                         <span class="disabled">Description</span> |
  95                                                         <a href="#sec-classes">Classes</a>
  96                         |                                                       <a href="#sec-includes">Includes</a>
  97                                                                                                 </div>
  98         <div class="info-box-body">
  99                 <!-- ========== Info from phpDoc block ========= -->
 100 <p class="short-description">Table browser / lister class</p>
 101 <p class="description"><p>Browsers are constructed from BrowserColumns and can support sorting  and other interactive behaviour.  Cells may contain data which is  formatted as a link, or the entire row may be linked through an onclick  action.</p></p>
 102         <ul class="tags">
 103                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
 104                                 <li><span class="field">copyright:</span> Catalyst IT Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
 105                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
 106                         </ul>
 107
 108                         </div>
 109 </div>
 110
 111         <a name="sec-classes"></a>
 112         <div class="info-box">
 113                 <div class="info-box-title">Classes</div>
 114                 <div class="nav-bar">
 115                         <a href="#sec-description">Description</a> |
 116                         <span class="disabled">Classes</span>
 117                         |                                                       <a href="#sec-includes">Includes</a>
 118                                                                                                                                                 </div>
 119                 <div class="info-box-body">
 120                         <table cellpadding="2" cellspacing="0" class="class-table">
 121                                 <tr>
 122                                         <th class="class-table-header">Class</th>
 123                                         <th class="class-table-header">Description</th>
 124                                 </tr>
 125                                                                 <tr>
 126                                         <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
 127                                                 <img src="../../media/images/Class.png"
 128                                                                  alt=" class"
 129                                                                  title=" class"/>
 130                                                 <a href="../../awl/Browser/BrowserColumn.html">BrowserColumn</a>
 131                                         </td>
 132                                         <td>
 133                                                                                         BrowserColumns are the basic building blocks.  You can specify just the  field name, and the column header or you can get fancy and specify an  alignment, format string, SQL formula and cell CSS class.
 134                                                                                 </td>
 135                                 </tr>
 136                                                                 <tr>
 137                                         <td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
 138                                                 <img src="../../media/images/Class.png"
 139                                                                  alt=" class"
 140                                                                  title=" class"/>
 141                                                 <a href="../../awl/Browser/Browser.html">Browser</a>
 142                                         </td>
 143                                         <td>
 144                                                                                         Start a new Browser, add columns, set a join and Render it to create a basic  list of records in a table.
 145                                                                                 </td>
 146                                 </tr>
 147                                                         </table>
 148                 </div>
 149         </div>
 150
 151         <a name="sec-includes"></a>
 152         <div class="info-box">
 153                 <div class="info-box-title">Includes</div>
 154                 <div class="nav-bar">
 155                         <a href="#sec-description">Description</a> |
 156                                                         <a href="#sec-classes">Classes</a>
 157                                 |                                               <span class="disabled">Includes</span>
 158                                                                                                                 </div>
 159                 <div class="info-box-body">
 160                         <a name="_AWLUtilities_php"><!-- --></a>
 161 <div class="oddrow">
 162
 163         <div>
 164                 <img src="../../media/images/Page.png" alt=" " />
 165                 <span class="include-title">
 166                         <span class="include-type">require_once</span>
 167                         (<span class="include-name"><a href="../../awl/Utilities/_AWLUtilities.php.html">"AWLUtilities.php"</a></span>)
 168                         (line <span class="line-number">17</span>)
 169                 </span>
 170         </div>
 171
 172         <!-- ========== Info from phpDoc block ========= -->
 173
 174 </div>
 175                 </div>
 176         </div>
 177
 178
 179
 180
 181         <p class="notes" id="credit">
 182                 Documentation generated on Tue, 28 Dec 2010 02:01:35 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 183         </p>
 184         </div></body>
 185 </html>