webapp/resources/datatables-1.9.4/extras/AutoFill/media/docs/global.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3         <head>
   4                 <meta http-equiv="Content-type" content="text/html; charset=utf-8">
   5                 <title>Global - documentation</title>
   6
   7                 <style type="text/css" media="screen">
   8                         @import "media/css/doc.css";
   9                         @import "media/css/shCore.css";
  10                         @import "media/css/shThemeDataTables.css";
  11                 </style>
  12
  13                 <script type="text/javascript" src="media/js/shCore.js"></script>
  14                 <script type="text/javascript" src="media/js/shBrushJScript.js"></script>
  15                 <script type="text/javascript" src="media/js/jquery.js"></script>
  16                 <script type="text/javascript" src="media/js/doc.js"></script>
  17         </head>
  18         <body>
  19                 <div class="fw_container">
  20
  21                                 <a name="top"></a>
  22                                 <div class="fw_header">
  23                                         <h1 class="page-title">Global</h1>
  24
  25                                         <div class="page-info">
  26
  27                                         </div>
  28                                 </div>
  29
  30
  31
  32                                 <div class="fw_nav">
  33                                         <h2>Navigation</h2>
  34                                         <ul>
  35                                         <li><a href="#top">Overview</a></li>
  36                                         <li><a href="#summary">Summary</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td><a href="#summary_classes">Classes (1)</a></td><td>Namespaces (0)</td></tr><tr><td><a href="#summary_properties">Properties (2)</a></td><td>Static properties (0)</td></tr><tr><td><a href="#summary_methods">Methods (13)</a></td><td>Static methods (0)</td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></div></li><li><a href="#details">Details</a><div><table cellpadding="5" border="0" cellspacing="0" width="100%"><tbody><tr><td><a href="#summary_properties">Properties (2)</a></td><td>Static properties (0)</td></tr><tr><td><a href="#summary_methods">Methods (13)</a></td><td>Static methods (0)</td></tr><tr><td>Events (0)</td><td></td></tr></tbody></table></div></li></ul>
  37                                         <div style="margin-top: 10px;">
  38                                                 <input type="hidden" name="show_private" value="0">
  39                                                 <span id="private_label">Hiding</span> private elements
  40                                                         (<a id="private_toggle" href="">toggle</a>)
  41                                                 </span>
  42                                         </div>
  43                                         <div>
  44                                                 <input type="hidden" name="show_extended" value="1">
  45                                                 <span id="extended_label">Showing</span> extended elements
  46                                                         (<a id="extended_toggle" href="">toggle</a>)
  47                                                 </span>
  48                                         </div>
  49                                 </div>
  50
  51                                 <div class="fw_content">
  52                                         <a name="overview"></a>
  53                                         <div class="doc_overview">
  54                                                 <div class="nav_blocker"></div>
  55                                                 <dl class="details">
  56
  57 </dl>
  58
  59                                         </div>
  60
  61
  62                                         <div class="doc_summary">
  63                                                 <a name="summary"></a>
  64                                                 <h2>Summary</h2>
  65
  66                                                 <div class="doc_group"><a name="summary_classes"></a><h3 class="subsection-title">Classes</h3>
  67 <dl>
  68         <dt class="even"><span class="type-name"><a href="AutoFill.html">AutoFill</a></span></dt><dd class="even"><p>AutoFill provides Excel like auto fill features for a DataTable</p></dd>
  69 </dl></div><div class="doc_group"><a name="summary_properties"></a><h3 class="subsection-title">Properties - instance</h3>
  70
  71 <dl>
  72     <dt class="  even"><span class="type-attr"><span class="type-signature">&lt;constant> </span></span><span class="type-name"><a href="#CLASS">CLASS</a></span><span class="type-sig"><span class="type-signature"> :String</span></span></dt><dd class="  even"><p>Name of this class</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature">&lt;constant> </span></span><span class="type-name"><a href="#VERSION">VERSION</a></span><span class="type-sig"><span class="type-signature"> :String</span></span></dt><dd class="  odd"><p>AutoFill version</p></dd>
  73 </dl></div><div class="doc_group"><a name="summary_methods"></a><h3 class="subsection-title">Methods - instance</h3>
  74
  75 <dl>
  76     <dt class="  even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#fnSettings">fnSettings</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></span></dt><dd class="  even"><p>Retreieve the settings object from an instance</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnFillerDisplay">_fnFillerDisplay</a></span><span class="type-sig"><span class="signature">(e)</span><span class="type-signature"></span></span></dt><dd class="  odd"><p>Display the drag handle on mouse over cell</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnFillerDragMove">_fnFillerDragMove</a></span><span class="type-sig"><span class="signature">(e)</span><span class="type-signature"></span></span></dt><dd class="  even"><p>Mouse move event handler for during a move. See if we want to update the display based on the
  77 new cursor position</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnFillerDragStart">_fnFillerDragStart</a></span><span class="type-sig"><span class="signature">(e)</span><span class="type-signature"></span></span></dt><dd class="  odd"><p>Mouse down event handler for starting a drag</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnFillerFinish">_fnFillerFinish</a></span><span class="type-sig"><span class="signature">(e)</span><span class="type-signature"></span></span></dt><dd class="  even"><p>Mouse release handler - end the drag and take action to update the cells with the needed values</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnFillerPosition">_fnFillerPosition</a></span><span class="type-sig"><span class="signature">(nTd)</span><span class="type-signature"></span></span></dt><dd class="  odd"><p>Position the filler icon over a cell</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnInit">_fnInit</a></span><span class="type-sig"><span class="signature">(oDT, oConfig)</span><span class="type-signature"></span></span></dt><dd class="  even"><p>Initialisation</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnPrep">_fnPrep</a></span><span class="type-sig"><span class="signature">(sStr)</span><span class="type-signature"> &rarr; {Object}</span></span></dt><dd class="  odd"><p>Chunk a string such that it can be filled in by the stepper function</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnReadCell">_fnReadCell</a></span><span class="type-sig"><span class="signature">(nTd)</span><span class="type-signature"> &rarr; {String}</span></span></dt><dd class="  even"><p>Read informaiton from a cell, possibly using live DOM elements if suitable</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnStep">_fnStep</a></span><span class="type-sig"><span class="signature">(nTd, oPrepped, iDiff, bIncrement, sToken)</span><span class="type-signature"> &rarr; {String}</span></span></dt><dd class="  odd"><p>Render a string for it's position in the table after the drag (incrememt numbers)</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnTargetCoords">_fnTargetCoords</a></span><span class="type-sig"><span class="signature">(nTd)</span><span class="type-signature"> &rarr; {Object}</span></span></dt><dd class="  even"><p>Find out the coordinates of a given TD cell in a table</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnUpdateBorder">_fnUpdateBorder</a></span><span class="type-sig"><span class="signature">(nStart, nEnd)</span><span class="type-signature"></span></span></dt><dd class="  odd"><p>Display the border around one or more cells (from start to end)</p></dd><dt class="  even"><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a href="#_fnWriteCell">_fnWriteCell</a></span><span class="type-sig"><span class="signature">(nTd, sVal, bLast)</span><span class="type-signature"></span></span></dt><dd class="  even"><p>Write informaiton to a cell, possibly using live DOM elements if suitable</p></dd>
  78 </dl>
  79 </div>
  80                                         </div>
  81
  82
  83
  84
  85                                         <div class="doc_details">
  86                                                 <a name="details"></a>
  87                                                 <h2>Details</h2>
  88                                                 <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - instance</h3>
  89 <dl>
  90     <dt class="  even"><a name="CLASS"></a><a name="CLASS_details"></a><span class="type-attr"><span class="type-signature">&lt;constant> </span></span><span class="type-name"><a href="#CLASS">CLASS</a></span><span class="type-sig"><span class="type-signature"> :String</span></span></dt><dd class="  even"><p>Name of this class</p><div class="collapse_details"><dl class="details">
  91
  92 </dl>
  93 </div></dd><dt class="  odd"><a name="VERSION"></a><a name="VERSION_details"></a><span class="type-attr"><span class="type-signature">&lt;constant> </span></span><span class="type-name"><a href="#VERSION">VERSION</a></span><span class="type-sig"><span class="type-signature"> :String</span></span></dt><dd class="  odd"><p>AutoFill version</p><div class="collapse_details"><dl class="details">
  94
  95 </dl>
  96 </div></dd>
  97 </dl></div><div class="doc_group"><a name="details_methods"></a><h3 class="subsection-title">Methods - instance</h3>
  98 <dl>
  99     <dt id="fnSettings" class="  even"><a name="fnSettings"></a><a name="fnSettings_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>fnSettings</a></span><span class="type-sig"><span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></span></span></dt><dd class="  even"><p>Retreieve the settings object from an instance</p><div class="collapse_details"><dl class="details">
 100
 101 </dl>
 102 <h5>Returns:</h5><p class="returns"><p>AutoFill settings object</p></p></div>
 103 <dt id="_fnFillerDisplay" class="  odd"><a name="_fnFillerDisplay"></a><a name="_fnFillerDisplay_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnFillerDisplay</a></span><span class="type-sig"><span class="signature">(e)</span><span class="type-signature"></span></span></span></dt><dd class="  odd"><p>Display the drag handle on mouse over cell</p><div class="collapse_details"><dl class="details">
 104
 105 </dl>
 106 <h5>Parameters:</h5>
 107
 108 <table class="params">
 109     <thead>
 110         <tr>
 111         <th width="20"></th>
 112         <th width="12%" class="bottom_border name">Name</th>
 113                 <th width="10%" class="bottom_border">Type</th>
 114                 <th width="10%" class="bottom_border">Attributes</th>
 115                 <th width="10%" class="bottom_border">Default</th>
 116                 <th class="last bottom_border">Description</th>
 117         </tr>
 118         </thead>
 119
 120         <tbody>
 121         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">Object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Event object</p></td></tr>
 122         </tbody>
 123 </table><h5>Returns:</h5><p class="returns"><p>void</p></p></div>
 124 <dt id="_fnFillerDragMove" class="  even"><a name="_fnFillerDragMove"></a><a name="_fnFillerDragMove_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnFillerDragMove</a></span><span class="type-sig"><span class="signature">(e)</span><span class="type-signature"></span></span></span></dt><dd class="  even"><p>Mouse move event handler for during a move. See if we want to update the display based on the
 125 new cursor position</p><div class="collapse_details"><dl class="details">
 126
 127 </dl>
 128 <h5>Parameters:</h5>
 129
 130 <table class="params">
 131     <thead>
 132         <tr>
 133         <th width="20"></th>
 134         <th width="12%" class="bottom_border name">Name</th>
 135                 <th width="10%" class="bottom_border">Type</th>
 136                 <th width="10%" class="bottom_border">Attributes</th>
 137                 <th width="10%" class="bottom_border">Default</th>
 138                 <th class="last bottom_border">Description</th>
 139         </tr>
 140         </thead>
 141
 142         <tbody>
 143         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">Object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Event object</p></td></tr>
 144         </tbody>
 145 </table><h5>Returns:</h5><p class="returns"><p>void</p></p></div>
 146 <dt id="_fnFillerDragStart" class="  odd"><a name="_fnFillerDragStart"></a><a name="_fnFillerDragStart_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnFillerDragStart</a></span><span class="type-sig"><span class="signature">(e)</span><span class="type-signature"></span></span></span></dt><dd class="  odd"><p>Mouse down event handler for starting a drag</p><div class="collapse_details"><dl class="details">
 147
 148 </dl>
 149 <h5>Parameters:</h5>
 150
 151 <table class="params">
 152     <thead>
 153         <tr>
 154         <th width="20"></th>
 155         <th width="12%" class="bottom_border name">Name</th>
 156                 <th width="10%" class="bottom_border">Type</th>
 157                 <th width="10%" class="bottom_border">Attributes</th>
 158                 <th width="10%" class="bottom_border">Default</th>
 159                 <th class="last bottom_border">Description</th>
 160         </tr>
 161         </thead>
 162
 163         <tbody>
 164         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">Object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Event object</p></td></tr>
 165         </tbody>
 166 </table><h5>Returns:</h5><p class="returns"><p>void</p></p></div>
 167 <dt id="_fnFillerFinish" class="  even"><a name="_fnFillerFinish"></a><a name="_fnFillerFinish_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnFillerFinish</a></span><span class="type-sig"><span class="signature">(e)</span><span class="type-signature"></span></span></span></dt><dd class="  even"><p>Mouse release handler - end the drag and take action to update the cells with the needed values</p><div class="collapse_details"><dl class="details">
 168
 169 </dl>
 170 <h5>Parameters:</h5>
 171
 172 <table class="params">
 173     <thead>
 174         <tr>
 175         <th width="20"></th>
 176         <th width="12%" class="bottom_border name">Name</th>
 177                 <th width="10%" class="bottom_border">Type</th>
 178                 <th width="10%" class="bottom_border">Attributes</th>
 179                 <th width="10%" class="bottom_border">Default</th>
 180                 <th class="last bottom_border">Description</th>
 181         </tr>
 182         </thead>
 183
 184         <tbody>
 185         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">e</td><td class="type type-param">Object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Event object</p></td></tr>
 186         </tbody>
 187 </table><h5>Returns:</h5><p class="returns"><p>void</p></p></div>
 188 <dt id="_fnFillerPosition" class="  odd"><a name="_fnFillerPosition"></a><a name="_fnFillerPosition_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnFillerPosition</a></span><span class="type-sig"><span class="signature">(nTd)</span><span class="type-signature"></span></span></span></dt><dd class="  odd"><p>Position the filler icon over a cell</p><div class="collapse_details"><dl class="details">
 189
 190 </dl>
 191 <h5>Parameters:</h5>
 192
 193 <table class="params">
 194     <thead>
 195         <tr>
 196         <th width="20"></th>
 197         <th width="12%" class="bottom_border name">Name</th>
 198                 <th width="10%" class="bottom_border">Type</th>
 199                 <th width="10%" class="bottom_border">Attributes</th>
 200                 <th width="10%" class="bottom_border">Default</th>
 201                 <th class="last bottom_border">Description</th>
 202         </tr>
 203         </thead>
 204
 205         <tbody>
 206         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nTd</td><td class="type type-param">Node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Cell to position filler icon over</p></td></tr>
 207         </tbody>
 208 </table><h5>Returns:</h5><p class="returns"><p>void</p></p></div>
 209 <dt id="_fnInit" class="  even"><a name="_fnInit"></a><a name="_fnInit_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnInit</a></span><span class="type-sig"><span class="signature">(oDT, oConfig)</span><span class="type-signature"></span></span></span></dt><dd class="  even"><p>Initialisation</p><div class="collapse_details"><dl class="details">
 210
 211 </dl>
 212 <h5>Parameters:</h5>
 213
 214 <table class="params">
 215     <thead>
 216         <tr>
 217         <th width="20"></th>
 218         <th width="12%" class="bottom_border name">Name</th>
 219                 <th width="10%" class="bottom_border">Type</th>
 220                 <th width="10%" class="bottom_border">Attributes</th>
 221                 <th width="10%" class="bottom_border">Default</th>
 222                 <th class="last bottom_border">Description</th>
 223         </tr>
 224         </thead>
 225
 226         <tbody>
 227         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">oDT</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>DataTables settings object</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oConfig</td><td class="type type-param">object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Configuration object for AutoFill</p></td></tr>
 228         </tbody>
 229 </table><h5>Returns:</h5><p class="returns"><p>void</p></p></div>
 230 <dt id="_fnPrep" class="  odd"><a name="_fnPrep"></a><a name="_fnPrep_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnPrep</a></span><span class="type-sig"><span class="signature">(sStr)</span><span class="type-signature"> &rarr; {Object}</span></span></span></dt><dd class="  odd"><p>Chunk a string such that it can be filled in by the stepper function</p><div class="collapse_details"><dl class="details">
 231
 232 </dl>
 233 <h5>Parameters:</h5>
 234
 235 <table class="params">
 236     <thead>
 237         <tr>
 238         <th width="20"></th>
 239         <th width="12%" class="bottom_border name">Name</th>
 240                 <th width="10%" class="bottom_border">Type</th>
 241                 <th width="10%" class="bottom_border">Attributes</th>
 242                 <th width="10%" class="bottom_border">Default</th>
 243                 <th class="last bottom_border">Description</th>
 244         </tr>
 245         </thead>
 246
 247         <tbody>
 248         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">sStr</td><td class="type type-param">String</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>String to prep</p></td></tr>
 249         </tbody>
 250 </table><h5>Returns:</h5><p class="returns"><p>with parameters, iStart, sStr and sPostFix</p></p></div>
 251 <dt id="_fnReadCell" class="  even"><a name="_fnReadCell"></a><a name="_fnReadCell_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnReadCell</a></span><span class="type-sig"><span class="signature">(nTd)</span><span class="type-signature"> &rarr; {String}</span></span></span></dt><dd class="  even"><p>Read informaiton from a cell, possibly using live DOM elements if suitable</p><div class="collapse_details"><dl class="details">
 252
 253 </dl>
 254 <h5>Parameters:</h5>
 255
 256 <table class="params">
 257     <thead>
 258         <tr>
 259         <th width="20"></th>
 260         <th width="12%" class="bottom_border name">Name</th>
 261                 <th width="10%" class="bottom_border">Type</th>
 262                 <th width="10%" class="bottom_border">Attributes</th>
 263                 <th width="10%" class="bottom_border">Default</th>
 264                 <th class="last bottom_border">Description</th>
 265         </tr>
 266         </thead>
 267
 268         <tbody>
 269         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nTd</td><td class="type type-param">Node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Cell to read</p></td></tr>
 270         </tbody>
 271 </table><h5>Returns:</h5><p class="returns"><p>Read value</p></p></div>
 272 <dt id="_fnStep" class="  odd"><a name="_fnStep"></a><a name="_fnStep_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnStep</a></span><span class="type-sig"><span class="signature">(nTd, oPrepped, iDiff, bIncrement, sToken)</span><span class="type-signature"> &rarr; {String}</span></span></span></dt><dd class="  odd"><p>Render a string for it's position in the table after the drag (incrememt numbers)</p><div class="collapse_details"><dl class="details">
 273
 274 </dl>
 275 <h5>Parameters:</h5>
 276
 277 <table class="params">
 278     <thead>
 279         <tr>
 280         <th width="20"></th>
 281         <th width="12%" class="bottom_border name">Name</th>
 282                 <th width="10%" class="bottom_border">Type</th>
 283                 <th width="10%" class="bottom_border">Attributes</th>
 284                 <th width="10%" class="bottom_border">Default</th>
 285                 <th class="last bottom_border">Description</th>
 286         </tr>
 287         </thead>
 288
 289         <tbody>
 290         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nTd</td><td class="type type-param">Node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Cell being written to</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">oPrepped</td><td class="type type-param">Object</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Prepared object for the stepper (from _fnPrep)</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">iDiff</td><td class="type type-param">Int</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Step difference</p></td></tr><tr class="odd"><td class="number right_border"><div>4</div></td><td class="name">bIncrement</td><td class="type type-param">Boolean</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Increment (true) or decriment (false)</p></td></tr><tr class="even"><td class="number right_border"><div>5</div></td><td class="name">sToken</td><td class="type type-param">String</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Token to replace</p></td></tr>
 291         </tbody>
 292 </table><h5>Returns:</h5><p class="returns"><p>Rendered information</p></p></div>
 293 <dt id="_fnTargetCoords" class="  even"><a name="_fnTargetCoords"></a><a name="_fnTargetCoords_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnTargetCoords</a></span><span class="type-sig"><span class="signature">(nTd)</span><span class="type-signature"> &rarr; {Object}</span></span></span></dt><dd class="  even"><p>Find out the coordinates of a given TD cell in a table</p><div class="collapse_details"><dl class="details">
 294
 295 </dl>
 296 <h5>Parameters:</h5>
 297
 298 <table class="params">
 299     <thead>
 300         <tr>
 301         <th width="20"></th>
 302         <th width="12%" class="bottom_border name">Name</th>
 303                 <th width="10%" class="bottom_border">Type</th>
 304                 <th width="10%" class="bottom_border">Attributes</th>
 305                 <th width="10%" class="bottom_border">Default</th>
 306                 <th class="last bottom_border">Description</th>
 307         </tr>
 308         </thead>
 309
 310         <tbody>
 311         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nTd</td><td class="type type-param">Node</td><td class="attributes"></td><td class="default"></td><td class="description last">undefined</td></tr>
 312         </tbody>
 313 </table><h5>Returns:</h5><p class="returns"><p>x and y properties, for the position of the cell in the tables DOM</p></p></div>
 314 <dt id="_fnUpdateBorder" class="  odd"><a name="_fnUpdateBorder"></a><a name="_fnUpdateBorder_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnUpdateBorder</a></span><span class="type-sig"><span class="signature">(nStart, nEnd)</span><span class="type-signature"></span></span></span></dt><dd class="  odd"><p>Display the border around one or more cells (from start to end)</p><div class="collapse_details"><dl class="details">
 315
 316 </dl>
 317 <h5>Parameters:</h5>
 318
 319 <table class="params">
 320     <thead>
 321         <tr>
 322         <th width="20"></th>
 323         <th width="12%" class="bottom_border name">Name</th>
 324                 <th width="10%" class="bottom_border">Type</th>
 325                 <th width="10%" class="bottom_border">Attributes</th>
 326                 <th width="10%" class="bottom_border">Default</th>
 327                 <th class="last bottom_border">Description</th>
 328         </tr>
 329         </thead>
 330
 331         <tbody>
 332         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nStart</td><td class="type type-param">Node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Starting cell</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">nEnd</td><td class="type type-param">Node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Ending cell</p></td></tr>
 333         </tbody>
 334 </table><h5>Returns:</h5><p class="returns"><p>void</p></p></div>
 335 <dt id="_fnWriteCell" class="  even"><a name="_fnWriteCell"></a><a name="_fnWriteCell_details"></a><span class="type-attr"><span class="type-signature"></span></span><span class="type-name"><a>_fnWriteCell</a></span><span class="type-sig"><span class="signature">(nTd, sVal, bLast)</span><span class="type-signature"></span></span></span></dt><dd class="  even"><p>Write informaiton to a cell, possibly using live DOM elements if suitable</p><div class="collapse_details"><dl class="details">
 336
 337 </dl>
 338 <h5>Parameters:</h5>
 339
 340 <table class="params">
 341     <thead>
 342         <tr>
 343         <th width="20"></th>
 344         <th width="12%" class="bottom_border name">Name</th>
 345                 <th width="10%" class="bottom_border">Type</th>
 346                 <th width="10%" class="bottom_border">Attributes</th>
 347                 <th width="10%" class="bottom_border">Default</th>
 348                 <th class="last bottom_border">Description</th>
 349         </tr>
 350         </thead>
 351
 352         <tbody>
 353         <tr class="even"><td class="number right_border"><div>1</div></td><td class="name">nTd</td><td class="type type-param">Node</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Cell to write</p></td></tr><tr class="odd"><td class="number right_border"><div>2</div></td><td class="name">sVal</td><td class="type type-param">String</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Value to write</p></td></tr><tr class="even"><td class="number right_border"><div>3</div></td><td class="name">bLast</td><td class="type type-param">Boolean</td><td class="attributes"></td><td class="default"></td><td class="description last"><p>Flag to show if this is that last update</p></td></tr>
 354         </tbody>
 355 </table><h5>Returns:</h5><p class="returns"><p>void</p></p></div>
 356
 357 </dd>
 358 </div>
 359                                         </div>
 360
 361                 </div>
 362
 363                 <div class="fw_footer">
 364
 365
 366                         Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
 367                         23th Sep 2012 - 14:27
 368                         with the <a href="http://datatables.net/">DataTables</a> template.
 369                 </div>
 370         </body>
 371 </html>