typematic.js.uncompressed.js 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  1. define("dijit/typematic", [
  2. "dojo/_base/array", // array.forEach
  3. "dojo/_base/connect", // connect.connect
  4. "dojo/_base/event", // event.stop
  5. "dojo/_base/kernel", // kernel.deprecated
  6. "dojo/_base/lang", // lang.mixin, lang.hitch
  7. "dojo/on",
  8. "dojo/sniff", // has("ie")
  9. "./main" // setting dijit.typematic global
  10. ], function(array, connect, event, kernel, lang, on, has, dijit){
  11. // module:
  12. // dijit/typematic
  13. var typematic = (dijit.typematic = {
  14. // summary:
  15. // These functions are used to repetitively call a user specified callback
  16. // method when a specific key or mouse click over a specific DOM node is
  17. // held down for a specific amount of time.
  18. // Only 1 such event is allowed to occur on the browser page at 1 time.
  19. _fireEventAndReload: function(){
  20. this._timer = null;
  21. this._callback(++this._count, this._node, this._evt);
  22. // Schedule next event, timer is at most minDelay (default 10ms) to avoid
  23. // browser overload (particularly avoiding starving DOH robot so it never gets to send a mouseup)
  24. this._currentTimeout = Math.max(
  25. this._currentTimeout < 0 ? this._initialDelay :
  26. (this._subsequentDelay > 1 ? this._subsequentDelay : Math.round(this._currentTimeout * this._subsequentDelay)),
  27. this._minDelay);
  28. this._timer = setTimeout(lang.hitch(this, "_fireEventAndReload"), this._currentTimeout);
  29. },
  30. trigger: function(/*Event*/ evt, /*Object*/ _this, /*DOMNode*/ node, /*Function*/ callback, /*Object*/ obj, /*Number?*/ subsequentDelay, /*Number?*/ initialDelay, /*Number?*/ minDelay){
  31. // summary:
  32. // Start a timed, repeating callback sequence.
  33. // If already started, the function call is ignored.
  34. // This method is not normally called by the user but can be
  35. // when the normal listener code is insufficient.
  36. // evt:
  37. // key or mouse event object to pass to the user callback
  38. // _this:
  39. // pointer to the user's widget space.
  40. // node:
  41. // the DOM node object to pass the the callback function
  42. // callback:
  43. // function to call until the sequence is stopped called with 3 parameters:
  44. // count:
  45. // integer representing number of repeated calls (0..n) with -1 indicating the iteration has stopped
  46. // node:
  47. // the DOM node object passed in
  48. // evt:
  49. // key or mouse event object
  50. // obj:
  51. // user space object used to uniquely identify each typematic sequence
  52. // subsequentDelay:
  53. // if > 1, the number of milliseconds until the 3->n events occur
  54. // or else the fractional time multiplier for the next event's delay, default=0.9
  55. // initialDelay:
  56. // the number of milliseconds until the 2nd event occurs, default=500ms
  57. // minDelay:
  58. // the maximum delay in milliseconds for event to fire, default=10ms
  59. if(obj != this._obj){
  60. this.stop();
  61. this._initialDelay = initialDelay || 500;
  62. this._subsequentDelay = subsequentDelay || 0.90;
  63. this._minDelay = minDelay || 10;
  64. this._obj = obj;
  65. this._node = node;
  66. this._currentTimeout = -1;
  67. this._count = -1;
  68. this._callback = lang.hitch(_this, callback);
  69. this._evt = { faux: true };
  70. for(var attr in evt){
  71. if(attr != "layerX" && attr != "layerY"){ // prevent WebKit warnings
  72. var v = evt[attr];
  73. if(typeof v != "function" && typeof v != "undefined"){ this._evt[attr] = v }
  74. }
  75. }
  76. this._fireEventAndReload();
  77. }
  78. },
  79. stop: function(){
  80. // summary:
  81. // Stop an ongoing timed, repeating callback sequence.
  82. if(this._timer){
  83. clearTimeout(this._timer);
  84. this._timer = null;
  85. }
  86. if(this._obj){
  87. this._callback(-1, this._node, this._evt);
  88. this._obj = null;
  89. }
  90. },
  91. addKeyListener: function(/*DOMNode*/ node, /*Object*/ keyObject, /*Object*/ _this, /*Function*/ callback, /*Number*/ subsequentDelay, /*Number*/ initialDelay, /*Number?*/ minDelay){
  92. // summary:
  93. // Start listening for a specific typematic key.
  94. // See also the trigger method for other parameters.
  95. // keyObject:
  96. // an object defining the key to listen for:
  97. //
  98. // - charOrCode: the printable character (string) or keyCode (number) to listen for.
  99. // - keyCode: (deprecated - use charOrCode) the keyCode (number) to listen for (implies charCode = 0).
  100. // - charCode: (deprecated - use charOrCode) the charCode (number) to listen for.
  101. // - ctrlKey: desired ctrl key state to initiate the callback sequence:
  102. // - pressed (true)
  103. // - released (false)
  104. // - either (unspecified)
  105. // - altKey: same as ctrlKey but for the alt key
  106. // - shiftKey: same as ctrlKey but for the shift key
  107. // returns:
  108. // a connection handle
  109. if(keyObject.keyCode){
  110. keyObject.charOrCode = keyObject.keyCode;
  111. kernel.deprecated("keyCode attribute parameter for dijit.typematic.addKeyListener is deprecated. Use charOrCode instead.", "", "2.0");
  112. }else if(keyObject.charCode){
  113. keyObject.charOrCode = String.fromCharCode(keyObject.charCode);
  114. kernel.deprecated("charCode attribute parameter for dijit.typematic.addKeyListener is deprecated. Use charOrCode instead.", "", "2.0");
  115. }
  116. var handles = [
  117. on(node, connect._keypress, lang.hitch(this, function(evt){
  118. if(evt.charOrCode == keyObject.charOrCode &&
  119. (keyObject.ctrlKey === undefined || keyObject.ctrlKey == evt.ctrlKey) &&
  120. (keyObject.altKey === undefined || keyObject.altKey == evt.altKey) &&
  121. (keyObject.metaKey === undefined || keyObject.metaKey == (evt.metaKey || false)) && // IE doesn't even set metaKey
  122. (keyObject.shiftKey === undefined || keyObject.shiftKey == evt.shiftKey)){
  123. event.stop(evt);
  124. typematic.trigger(evt, _this, node, callback, keyObject, subsequentDelay, initialDelay, minDelay);
  125. }else if(typematic._obj == keyObject){
  126. typematic.stop();
  127. }
  128. })),
  129. on(node, "keyup", lang.hitch(this, function(){
  130. if(typematic._obj == keyObject){
  131. typematic.stop();
  132. }
  133. }))
  134. ];
  135. return { remove: function(){ array.forEach(handles, function(h){ h.remove(); }); } };
  136. },
  137. addMouseListener: function(/*DOMNode*/ node, /*Object*/ _this, /*Function*/ callback, /*Number*/ subsequentDelay, /*Number*/ initialDelay, /*Number?*/ minDelay){
  138. // summary:
  139. // Start listening for a typematic mouse click.
  140. // See the trigger method for other parameters.
  141. // returns:
  142. // a connection handle
  143. var handles = [
  144. on(node, "mousedown", lang.hitch(this, function(evt){
  145. evt.preventDefault();
  146. typematic.trigger(evt, _this, node, callback, node, subsequentDelay, initialDelay, minDelay);
  147. })),
  148. on(node, "mouseup", lang.hitch(this, function(evt){
  149. if(this._obj){
  150. evt.preventDefault();
  151. }
  152. typematic.stop();
  153. })),
  154. on(node, "mouseout", lang.hitch(this, function(evt){
  155. if(this._obj){
  156. evt.preventDefault();
  157. }
  158. typematic.stop();
  159. })),
  160. on(node, "dblclick", lang.hitch(this, function(evt){
  161. evt.preventDefault();
  162. if(has("ie") < 9){
  163. typematic.trigger(evt, _this, node, callback, node, subsequentDelay, initialDelay, minDelay);
  164. setTimeout(lang.hitch(this, typematic.stop), 50);
  165. }
  166. }))
  167. ];
  168. return { remove: function(){ array.forEach(handles, function(h){ h.remove(); }); } };
  169. },
  170. addListener: function(/*Node*/ mouseNode, /*Node*/ keyNode, /*Object*/ keyObject, /*Object*/ _this, /*Function*/ callback, /*Number*/ subsequentDelay, /*Number*/ initialDelay, /*Number?*/ minDelay){
  171. // summary:
  172. // Start listening for a specific typematic key and mouseclick.
  173. // This is a thin wrapper to addKeyListener and addMouseListener.
  174. // See the addMouseListener and addKeyListener methods for other parameters.
  175. // mouseNode:
  176. // the DOM node object to listen on for mouse events.
  177. // keyNode:
  178. // the DOM node object to listen on for key events.
  179. // returns:
  180. // a connection handle
  181. var handles = [
  182. this.addKeyListener(keyNode, keyObject, _this, callback, subsequentDelay, initialDelay, minDelay),
  183. this.addMouseListener(mouseNode, _this, callback, subsequentDelay, initialDelay, minDelay)
  184. ];
  185. return { remove: function(){ array.forEach(handles, function(h){ h.remove(); }); } };
  186. }
  187. });
  188. return typematic;
  189. });