webapp/resources/datatables-1.9.4/docs/DataTable.defaults.oLanguage.oAria.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>Namespace: oAria - 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">Namespace: oAria</h1>
  24                                         <h2 class="ancestors">Ancestry: <span class="ancestors"><a href="DataTable.html">DataTable</a> » <a href="DataTable.defaults.html">.defaults</a> » <a href="DataTable.defaults.oLanguage.html">.oLanguage</a>.</span> » oAria</h2>
  25                                         <div class="page-info">
  26                                                 DataTables v1.9.4 documentation
  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>Classes (0)</td><td>Namespaces (0)</td></tr><tr><td>Properties (0)</td><td><a href="#summary_properties_static">Static properties (2)</a></td></tr><tr><td>Methods (0)</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>Properties (0)</td><td><a href="#summary_properties_static">Static properties (2)</a></td></tr><tr><td>Methods (0)</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                                                 <p>Strings that are used for WAI-ARIA labels and controls only (these are not
  56 actually visible on the page, but will be read by screenreaders, and thus
  57 must be internationalised as well).</p><dl class="details">
  58
  59 </dl>
  60
  61                                         </div>
  62
  63
  64                                         <div class="doc_summary">
  65                                                 <a name="summary"></a>
  66                                                 <h2>Summary</h2>
  67
  68                                                 <div class="doc_group"><a name="summary_properties_static"></a><h3 class="subsection-title">Properties - static</h3>
  69
  70 <dl>
  71     <dt class="  even"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sSortAscending">sSortAscending</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class="  even"><p>ARIA label that is added to the table headers when the column may be
  72 sorted ascending by activing the column (click or return when focused).
  73 Note that the column header is prefixed to this string.</p></dd><dt class="  odd"><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sSortDescending">sSortDescending</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class="  odd"><p>ARIA label that is added to the table headers when the column may be
  74 sorted descending by activing the column (click or return when focused).
  75 Note that the column header is prefixed to this string.</p></dd>
  76 </dl></div>
  77                                         </div>
  78
  79
  80
  81
  82                                         <div class="doc_details">
  83                                                 <a name="details"></a>
  84                                                 <h2>Details</h2>
  85                                                 <div class="doc_group"><a name="details_properties"></a><h3 class="subsection-title">Properties - static</h3>
  86 <dl>
  87     <dt class="  even"><a name="sSortAscending"></a><a name="sSortAscending_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sSortAscending">sSortAscending</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class="  even"><p>ARIA label that is added to the table headers when the column may be
  88 sorted ascending by activing the column (click or return when focused).
  89 Note that the column header is prefixed to this string.</p><div class="collapse_details"><dl class="details">
  90
  91 </dl>
  92 <h5>Example</h5>
  93     <div class="example-code">
  94         <pre class="brush: js">   $(document).ready( function() {
  95      $('#example').dataTable( {
  96        "oLanguage": {
  97          "oAria": {
  98            "sSortAscending": " - click/return to sort ascending"
  99          }
 100        }
 101      } );
 102    } );</pre>
 103     </div>
 104 </div></dd><dt class="  odd"><a name="sSortDescending"></a><a name="sSortDescending_details"></a><span class="type-attr"><span class="type-signature">&lt;static> </span></span><span class="type-name"><a href="#sSortDescending">sSortDescending</a></span><span class="type-sig"><span class="type-signature"> :string</span></span></dt><dd class="  odd"><p>ARIA label that is added to the table headers when the column may be
 105 sorted descending by activing the column (click or return when focused).
 106 Note that the column header is prefixed to this string.</p><div class="collapse_details"><dl class="details">
 107
 108 </dl>
 109 <h5>Example</h5>
 110     <div class="example-code">
 111         <pre class="brush: js">   $(document).ready( function() {
 112      $('#example').dataTable( {
 113        "oLanguage": {
 114          "oAria": {
 115            "sSortDescending": " - click/return to sort descending"
 116          }
 117        }
 118      } );
 119    } );</pre>
 120     </div>
 121 </div></dd>
 122 </dl></div>
 123                                         </div>
 124
 125                 </div>
 126
 127                 <div class="fw_footer">
 128                         DataTables: Copyright 2008-2012 Allan Jardine, all rights reserved<br>
 129
 130                         Documentation generated by <a href="https://github.com/micmath/JSDoc">JSDoc 3</a> on
 131                         23th Sep 2012 - 14:27
 132                         with the <a href="http://datatables.net/">DataTables</a> template.
 133                 </div>
 134         </body>
 135 </html>