PageRenderTime 45ms CodeModel.GetById 18ms RepoModel.GetById 1ms app.codeStats 0ms

/ZendFramework-1.11.12/extras/documentation/api/extras/db_ZendX_JQuery_View_Helper_AutoComplete.html

#
HTML | 252 lines | 239 code | 13 blank | 0 comment | 0 complexity | d93866e8ad19fe41aa5fda1401d88550 MD5 | raw file
Possible License(s): BSD-3-Clause, LGPL-2.0, MIT, ISC 
    

  1. <html xmlns="http://www.w3.org/1999/xhtml"><head><title>Zend Framework Extras API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="css/jquery-ui.css" type="text/css"></link><link rel="stylesheet" href="css/docblox/jquery-ui-1.8.16.custom.css" type="text/css"></link><link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link><link rel="stylesheet" href="css/theme.css" type="text/css"></link><script type="text/javascript" src="js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="js/jquery.cookie.js"></script><script type="text/javascript" src="js/jquery.treeview.js"></script><script type="text/javascript">
    2. 

  2.             $(document).ready(function() {
    3. 

  3.                 $(".filetree").treeview({
    4. 

  4.                     collapsed: true,
    5. 

  5.                     persist: "cookie"
    6. 

  6.                 });
    7. 

  7. 

  8.                 $("#accordion").accordion({
    9. 

  9.                     collapsible: true,
    10. 

  10.                     autoHeight:  false,
    11. 

  11.                     fillSpace:   true
    12. 

  12.                 });
    13. 

  13. 

  14.                 $(".tabs").tabs();
    15. 

  15.             });
    16. 

  16.         </script></head><body><div xmlns="" class="content">
    17. 

  17. <div class="sub-page-main-header-api-documentation"><h2>API Documentation</h2></div>
    18. 

  18. <div class="dotted-line"></div>
    19. 

  19. </div>
    20. 

  20. <div xmlns="" id="content">
    21. 

  21. <script xmlns:dbx="http://docblox-project.org/xsl/functions">
    22. 

  22. 

  23.       function filterElements()
    24. 

  24.       {
    25. 

  25.         inherited = !$('#show-inherited').hasClass('deselected');
    26. 

  26.         public    = !$('#show-public').hasClass('deselected');
    27. 

  27.         protected = !$('#show-protected').hasClass('deselected');
    28. 

  28.         private   = !$('#show-private').hasClass('deselected');
    29. 

  29. 

  30.         $('div.public').each(function(index, val) {
    31. 

  31.             $(val).toggle(public && !($(val).hasClass('inherited_from') && !inherited));
    32. 

  32.         });
    33. 

  33.         $('div.protected').each(function(index, val) {
    34. 

  34.             $(val).toggle(protected && !($(val).hasClass('inherited_from') && !inherited));
    35. 

  35.         });
    36. 

  36.         $('div.private').each(function(index, val) {
    37. 

  37.             $(val).toggle(private && !($(val).hasClass('inherited_from') && !inherited));
    38. 

  38.         });
    39. 

  39.       }
    40. 

  40. 

  41.       $(document).ready(function() {
    42. 

  42.         $('a.gripper').click(function() {
    43. 

  43.             $(this).nextAll('div.code-tabs').slideToggle();
    44. 

  44.             $(this).children('img').toggle();
    45. 

  45.             return false;
    46. 

  46.         });
    47. 

  47. 

  48.         $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').css('cursor', 'pointer');
    49. 

  49. 

  50.         $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').click(function() {
    51. 

  51.             $(this).parent().nextAll('div.code-tabs').slideToggle();
    52. 

  52.             $(this).parent().prevAll('a.gripper').children('img').toggle();
    53. 

  53.             return false;
    54. 

  54.         });
    55. 

  55. 

  56.         $('div.code-tabs').hide();
    57. 

  57.         $('a.gripper').show();
    58. 

  58.         $('div.code-tabs:empty').prevAll('a.gripper').html('');
    59. 

  59. 

  60.         $('#show-public, #show-protected, #show-private, #show-inherited')
    61. 

  61.             .css('cursor', 'pointer')
    62. 

  62.             .click(function(){
    63. 

  63.                 $(this).toggleClass('deselected');
    64. 

  64.                 if ($(this).hasClass('deselected')) {
    65. 

  65.                   $(this).fadeTo('fast', '0.4');
    66. 

  66.                 } else {
    67. 

  67.                   $(this).fadeTo('fast', '1.0');
    68. 

  68.                 }
    69. 

  69.                 filterElements();
    70. 

  70.                 return false;
    71. 

  71.             });
    72. 

  72.         $('#show-protected, #show-private').click();
    73. 

  73. 

  74.         // add the sliding behaviour to the file navigation and show it
    75. 

  75.         // it is initially hidden for non-JS users.
    76. 

  76.         $("#file-nav-box").show().hover(function() {
    77. 

  77.             $("#file-nav-container").slideDown(400);
    78. 

  78.         }, function() {
    79. 

  79.             $("#file-nav-container").slideUp(400);
    80. 

  80.         });
    81. 

  81.       });
    82. 

  82. 

  83.       
    84. 

  84.     </script><h1 xmlns:dbx="http://docblox-project.org/xsl/functions" class="file">ZendX/JQuery/View/Helper/AutoComplete.php</h1>
    85. 

  85. <div xmlns:dbx="http://docblox-project.org/xsl/functions" id="file-nav-box">
    86. 

  86. <div id="file-nav-options">
    87. 

  87.               Show:
    88. 

  88.               <img src="images/icons/visibility_public.png" id="show-public"><img src="images/icons/visibility_protected.png" id="show-protected"><img src="images/icons/visibility_private.png" id="show-private"><span class="attribute" id="show-inherited">inherited</span>
    89. 

  89. </div>
    90. 

  90. <div id="file-nav-container">
    91. 

  91. <ul id="file-nav"><li>
    92. 

  92. <a href="#classes"><img src="images/icons/class.png" height="14">
    93. 

  93.                           Classes
    94. 

  94.                       </a><ul><li><a href="#%5CZendX_JQuery_View_Helper_AutoComplete">\ZendX_JQuery_View_Helper_AutoComplete</a></li></ul>
    95. 

  95. </li></ul>
    96. 

  96. <div style="clear: left;"></div>
    97. 

  97. </div>
    98. 

  98. <div id="file-nav-tab">
    99. 

  99.               Table of Contents
    100. 

  100.           </div>
    101. 

  101. </div>
    102. 

  102. <a xmlns:dbx="http://docblox-project.org/xsl/functions" name="top" class="anchor"></a><div id="file-description">
    103. 

  103. <p xmlns:dbx="http://docblox-project.org/xsl/functions" class="short-description">Zend Framework</p>
    104. 

  104. <div xmlns:dbx="http://docblox-project.org/xsl/functions" class="long-description"><p>LICENSE</p>
    105. 

  105. 

  106. <p>This source file is subject to the new BSD license that is bundled
    107. 

  107. with this package in the file LICENSE.txt.
    108. 

  108. It is also available through the world-wide-web at this URL:
    109. 

  109. http://framework.zend.com/license/new-bsd
    110. 

  110. If you did not receive a copy of the license and are unable to
    111. 

  111. obtain it through the world-wide-web, please send an email
    112. 

  112. to license@zend.com so we can send you a copy immediately.</p>
    113. 

  113. </div>
    114. 

  114. </div>
    115. 

  115. <dl class="file-info">
    116. 

  116. <dt xmlns:dbx="http://docblox-project.org/xsl/functions">Category</dt>
    117. 

  117. <dd xmlns:dbx="http://docblox-project.org/xsl/functions">ZendX
    118. 

  118.          
    119. 

  119.     </dd>
    120. 

  120. <dt xmlns:dbx="http://docblox-project.org/xsl/functions">Copyright</dt>
    121. 

  121. <dd xmlns:dbx="http://docblox-project.org/xsl/functions">Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
    122. 

  122.          
    123. 

  123.     </dd>
    124. 

  124. <dt xmlns:dbx="http://docblox-project.org/xsl/functions">License</dt>
    125. 

  125. <dd xmlns:dbx="http://docblox-project.org/xsl/functions">
    126. 

  126. <a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
    127. 

  127.          
    128. 

  128.     </dd>
    129. 

  129. <dt xmlns:dbx="http://docblox-project.org/xsl/functions">Package</dt>
    130. 

  130. <dd xmlns:dbx="http://docblox-project.org/xsl/functions">ZendX_JQuery
    131. 

  131.          
    132. 

  132.     </dd>
    133. 

  133. <dt xmlns:dbx="http://docblox-project.org/xsl/functions">Subpackage</dt>
    134. 

  134. <dd xmlns:dbx="http://docblox-project.org/xsl/functions">View
    135. 

  135.          
    136. 

  136.     </dd>
    137. 

  137. <dt xmlns:dbx="http://docblox-project.org/xsl/functions">Version</dt>
    138. 

  138. <dd xmlns:dbx="http://docblox-project.org/xsl/functions">$Id: AutoComplete.php 20752 2010-01-29 11:31:30Z beberlei $
    139. 

  139.          
    140. 

  140.     </dd>
    141. 

  141. </dl>
    142. 

  142. <a name="classes" class="anchor"></a><a xmlns:dbx="http://docblox-project.org/xsl/functions" id="\ZendX_JQuery_View_Helper_AutoComplete" class="anchor"></a><h2 xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">\ZendX_JQuery_View_Helper_AutoComplete<div class="to-top"><a href="#top">jump to top</a></div>
    143. 

  143. </h2>
    144. 

  144. <div xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">
    145. 

  145. <small class="package"><b>Package: </b>ZendX\JQuery\View</small><p class="short-description">jQuery Autocomplete View Helper</p>
    146. 

  146. <div class="long-description">
    147. 

  147. </div>
    148. 

  148. <dl class="class-info">
    149. 

  149. <dt>Parent(s)</dt>
    150. 

  150. <dd>
    151. 

  151. <a href="db_ZendX_JQuery_View_Helper_UiWidget.html#%5CZendX_JQuery_View_Helper_UiWidget">\ZendX_JQuery_View_Helper_UiWidget</a>
    152. 

  152.             &lt;
    153. 

  153.             \Zend_View_Helper_HtmlElement</dd>
    154. 

  154. <dt>Copyright</dt>
    155. 

  155. <dd>Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
    156. 

  156.          
    157. 

  157.     </dd>
    158. 

  158. <dt>License</dt>
    159. 

  159. <dd>
    160. 

  160. <a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
    161. 

  161.          
    162. 

  162.     </dd>
    163. 

  163. <dt>Uses</dt>
    164. 

  164. <dd>\Zend_Json,
    165. 

  165.          
    166. 

  166.     </dd>
    167. 

  167. </dl>
    168. 

  168. <h3>Methods</h3>
    169. 

  169. <div>
    170. 

  170. <a id="\ZendX_JQuery_View_Helper_AutoComplete::autoComplete()" class="anchor"></a><div class="method public">
    171. 

  171. <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">autoComplete</span><span class="nb-faded-text">(
    172. 

  172.           String $id, String $value
    173. 

  173.               =
    174. 

  174.               null, array $params
    175. 

  175.               =
    176. 

  176.               array(), array $attribs
    177. 

  177.               =
    178. 

  178.               array()
    179. 

  179.           )
    180. 

  180.         </span>
    181. 

  181.         :
    182. 

  182.           String</code><div class="description"><p class="short_description">Builds an AutoComplete ready input field.</p></div>
    183. 

  183. <div class="code-tabs">
    184. 

  184. <div class="long-description"><p>This view helper builds an input field with the {@link Zend_View_Helper_FormText} FormText
    185. 

  185. Helper and adds additional javascript to the jQuery stack to initialize an AutoComplete
    186. 

  186. field. Make sure you have set one out of the two following options: $params['data'] or
    187. 

  187. $params['url']. The first one accepts an array as data input to the autoComplete, the
    188. 

  188. second accepts an url, where the autoComplete content is returned from. For the format
    189. 

  189. see jQuery documentation.</p>
    190. 

  190. </div>
    191. 

  191. <strong>Parameters</strong><table class="argument-info">
    192. 

  192. <thead><tr>
    193. 

  193. <th>Name</th>
    194. 

  194. <th>Type</th>
    195. 

  195. <th>Description</th>
    196. 

  196. </tr></thead>
    197. 

  197. <tr>
    198. 

  198. <th>$id</th>
    199. 

  199. <td>String</td>
    200. 

  200. <td><em></em></td>
    201. 

  201. </tr>
    202. 

  202. <tr>
    203. 

  203. <th>$value</th>
    204. 

  204. <td>String</td>
    205. 

  205. <td><em></em></td>
    206. 

  206. </tr>
    207. 

  207. <tr>
    208. 

  208. <th>$params</th>
    209. 

  209. <td>array</td>
    210. 

  210. <td><em></em></td>
    211. 

  211. </tr>
    212. 

  212. <tr>
    213. 

  213. <th>$attribs</th>
    214. 

  214. <td>array</td>
    215. 

  215. <td><em></em></td>
    216. 

  216. </tr>
    217. 

  217. </table>
    218. 

  218. <strong>Returns</strong><table class="argument-info">
    219. 

  219. <thead><tr>
    220. 

  220. <th>Type</th>
    221. 

  221. <th>Description</th>
    222. 

  222. </tr></thead>
    223. 

  223. <tr>
    224. 

  224. <td>String</td>
    225. 

  225. <td></td>
    226. 

  226. </tr>
    227. 

  227. </table>
    228. 

  228. <strong>Throws</strong><table class="argument-info">
    229. 

  229. <thead><tr>
    230. 

  230. <th>Exception</th>
    231. 

  231. <th>Description</th>
    232. 

  232. </tr></thead>
    233. 

  233. <tr>
    234. 

  234. <td><a href="db_ZendX_JQuery_Exception.html#%5CZendX_JQuery_Exception">\ZendX_JQuery_Exception</a></td>
    235. 

  235. <td><em></em></td>
    236. 

  236. </tr>
    237. 

  237. </table>
    238. 

  238. <strong>Details</strong><dl class="function-info">
    239. 

  239. <dt>Link</dt>
    240. 

  240. <dd>
    241. 

  241. <a href="http://docs.jquery.com/UI/Autocomplete">http://docs.jquery.com/UI/Autocomplete</a>
    242. 

  242.          
    243. 

  243.     </dd>
    244. 

  244. </dl>
    245. 

  245. </div>
    246. 

  246. <div class="clear"></div>
    247. 

  247. </div>
    248. 

  248. </div>
    249. 

  249. </div>
    250. 

  250. </div>
    251. 

  251. <small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.15.1</a>.
    252. 

  252.     </small></body></html>
    253. 

  253.