Provider.html 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  5. <title>The source code</title>
  6. <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
  7. <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
  8. <style type="text/css">
  9. .highlight { display: block; background-color: #ddd; }
  10. </style>
  11. <script type="text/javascript">
  12. function highlight() {
  13. document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
  14. }
  15. </script>
  16. </head>
  17. <body onload="prettyPrint(); highlight();">
  18. <pre class="prettyprint lang-js"><span id='Ext-direct-Provider'>/**
  19. </span> * Ext.direct.Provider is an abstract class meant to be extended.
  20. *
  21. * For example Ext JS implements the following subclasses:
  22. *
  23. * Provider
  24. * |
  25. * +---{@link Ext.direct.JsonProvider JsonProvider}
  26. * |
  27. * +---{@link Ext.direct.PollingProvider PollingProvider}
  28. * |
  29. * +---{@link Ext.direct.RemotingProvider RemotingProvider}
  30. *
  31. * @abstract
  32. */
  33. Ext.define('Ext.direct.Provider', {
  34. /* Begin Definitions */
  35. alias: 'direct.provider',
  36. mixins: {
  37. observable: 'Ext.util.Observable'
  38. },
  39. /* End Definitions */
  40. <span id='Ext-direct-Provider-cfg-id'> /**
  41. </span> * @cfg {String} id
  42. * The unique id of the provider (defaults to an {@link Ext#id auto-assigned id}).
  43. * You should assign an id if you need to be able to access the provider later and you do
  44. * not have an object reference available, for example:
  45. *
  46. * Ext.direct.Manager.addProvider({
  47. * type: 'polling',
  48. * url: 'php/poll.php',
  49. * id: 'poll-provider'
  50. * });
  51. * var p = {@link Ext.direct.Manager}.{@link Ext.direct.Manager#getProvider getProvider}('poll-provider');
  52. * p.disconnect();
  53. *
  54. */
  55. constructor : function(config){
  56. var me = this;
  57. Ext.apply(me, config);
  58. me.addEvents(
  59. <span id='Ext-direct-Provider-event-connect'> /**
  60. </span> * @event connect
  61. * Fires when the Provider connects to the server-side
  62. * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
  63. */
  64. 'connect',
  65. <span id='Ext-direct-Provider-event-disconnect'> /**
  66. </span> * @event disconnect
  67. * Fires when the Provider disconnects from the server-side
  68. * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
  69. */
  70. 'disconnect',
  71. <span id='Ext-direct-Provider-event-data'> /**
  72. </span> * @event data
  73. * Fires when the Provider receives data from the server-side
  74. * @param {Ext.direct.Provider} provider The {@link Ext.direct.Provider Provider}.
  75. * @param {Ext.direct.Event} e The Ext.direct.Event type that occurred.
  76. */
  77. 'data',
  78. <span id='Ext-direct-Provider-event-exception'> /**
  79. </span> * @event exception
  80. * Fires when the Provider receives an exception from the server-side
  81. */
  82. 'exception'
  83. );
  84. me.mixins.observable.constructor.call(me, config);
  85. },
  86. <span id='Ext-direct-Provider-method-isConnected'> /**
  87. </span> * Returns whether or not the server-side is currently connected.
  88. * Abstract method for subclasses to implement.
  89. */
  90. isConnected: function(){
  91. return false;
  92. },
  93. <span id='Ext-direct-Provider-method-connect'> /**
  94. </span> * Abstract methods for subclasses to implement.
  95. * @method
  96. */
  97. connect: Ext.emptyFn,
  98. <span id='Ext-direct-Provider-method-disconnect'> /**
  99. </span> * Abstract methods for subclasses to implement.
  100. * @method
  101. */
  102. disconnect: Ext.emptyFn
  103. });
  104. </pre>
  105. </body>
  106. </html>