-
Notifications
You must be signed in to change notification settings - Fork 6
/
jquery-1.4.4-vsdoc.js
2156 lines (2154 loc) · 84.3 KB
/
jquery-1.4.4-vsdoc.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
var jQuery = $ = function(selector, context){
/// <summary>
/// Accepts a string containing a CSS selector which is then used to match a set of elements.
/// Additional Signatures:
/// 	1. jQuery( element )
/// 	2. jQuery( elementArray )
/// 	3. jQuery( jQuery object )
/// 	4. jQuery( )
/// 	5. jQuery( html, [ownerDocument] )
/// 	6. jQuery( html, props )
/// 	7. jQuery( callback )
/// API Reference: http://api.jquery.com/jQuery
/// </summary>
/// <param name="selector" type="String">
/// A string containing a selector expression
/// </param>
/// <param name="context" type="jQuery" optional="true">
/// A DOM Element, Document, or jQuery to use as context
/// </param>
/// <returns type="jQuery" />
};
$.prototype = {
fadeToggle: function(duration, easing, callback){
/// <summary>
/// Display or hide the matched elements by animating their opacity.
/// API Reference: http://api.jquery.com/fadeToggle
/// </summary>
/// <param name="duration" type="Number" optional="true">
/// A string or number determining how long the animation will run.
/// </param>
/// <param name="easing" type="String" optional="true">
/// A string indicating which easing function to use for the transition.
/// </param>
/// <param name="callback" type="Function" optional="true">
/// A function to call once the animation is complete.
/// </param>
/// <returns type="jQuery" />
},
toggle: function(handler, handler1, handler2){
/// <summary>
/// Bind two or more handlers to the matched elements, to be executed on alternate clicks.
/// API Reference: http://api.jquery.com/toggle
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute every even time the element is clicked.
/// </param>
/// <param name="handler1" type="Function">
/// A function to execute every odd time the element is clicked.
/// </param>
/// <param name="handler2" type="Function" optional="true">
/// Additional handlers to cycle through after clicks.
/// </param>
/// <returns type="jQuery" />
},
undelegate: function(){
/// <summary>
/// Remove a handler from the event for all elements which match the current selector, now or in the future, based upon a specific set of root elements.
/// Additional Signatures:
/// 	1. .undelegate( selector, eventType )
/// 	2. .undelegate( selector, eventType, handler )
/// API Reference: http://api.jquery.com/undelegate
/// </summary>
/// <returns type="jQuery" />
},
delegate: function(selector, eventType, handler){
/// <summary>
/// Attach a handler to one or more events for all elements that match the selector, now or in the future, based on a specific set of root elements.
/// Additional Signatures:
/// 	1. .delegate( selector, eventType, eventData, handler )
/// API Reference: http://api.jquery.com/delegate
/// </summary>
/// <param name="selector" type="String">
/// A selector to filter the elements that trigger the event.
/// </param>
/// <param name="eventType" type="String">
/// A string containing one or more space-separated JavaScript event types, such as "click" or "keydown," or custom event names.
/// </param>
/// <param name="handler" type="Function">
/// A function to execute at the time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
focusout: function(handler){
/// <summary>
/// Bind an event handler to the "focusout" JavaScript event.
/// Additional Signatures:
/// 	1. .focusout( [eventData], handler )
/// API Reference: http://api.jquery.com/focusout
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
focusin: function(handler){
/// <summary>
/// Bind an event handler to the "focusin" JavaScript event.
/// Additional Signatures:
/// 	1. .focusin( [eventData], handler )
/// API Reference: http://api.jquery.com/focusin
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
has: function(selector){
/// <summary>
/// Reduce the set of matched elements to those that have a descendant that matches the selector or DOM element.
/// Additional Signatures:
/// 	1. .has( contained )
/// API Reference: http://api.jquery.com/has
/// </summary>
/// <param name="selector" type="String">
/// A string containing a selector expression to match elements against.
/// </param>
/// <returns type="jQuery" />
},
delay: function(duration, queueName){
/// <summary>
/// Set a timer to delay execution of subsequent items in the queue.
/// API Reference: http://api.jquery.com/delay
/// </summary>
/// <param name="duration" type="Number" integer="true">
/// An integer indicating the number of milliseconds to delay execution of the next item in the queue.
/// </param>
/// <param name="queueName" type="String" optional="true">
/// A string containing the name of the queue. Defaults to fx, the standard effects queue.
/// </param>
/// <returns type="jQuery" />
},
parentsUntil: function(selector){
/// <summary>
/// Get the ancestors of each element in the current set of matched elements, up to but not including the element matched by the selector.
/// API Reference: http://api.jquery.com/parentsUntil
/// </summary>
/// <param name="selector" type="String" optional="true">
/// A string containing a selector expression to indicate where to stop matching ancestor elements.
/// </param>
/// <returns type="jQuery" />
},
prevUntil: function(selector){
/// <summary>
/// Get all preceding siblings of each element up to but not including the element matched by the selector.
/// API Reference: http://api.jquery.com/prevUntil
/// </summary>
/// <param name="selector" type="String" optional="true">
/// A string containing a selector expression to indicate where to stop matching preceding sibling elements.
/// </param>
/// <returns type="jQuery" />
},
nextUntil: function(selector){
/// <summary>
/// Get all following siblings of each element up to but not including the element matched by the selector.
/// API Reference: http://api.jquery.com/nextUntil
/// </summary>
/// <param name="selector" type="String" optional="true">
/// A string containing a selector expression to indicate where to stop matching following sibling elements.
/// </param>
/// <returns type="jQuery" />
},
each: function(method){
/// <summary>
/// Iterate over a jQuery object, executing a function for each matched element.
/// API Reference: http://api.jquery.com/each
/// </summary>
/// <param name="method" type="Function">
/// A function to execute for each matched element.
/// </param>
/// <returns type="jQuery" />
},
pushStack: function(elements){
/// <summary>
/// Add a collection of DOM elements onto the jQuery stack.
/// Additional Signatures:
/// 	1. .pushStack( elements, name, arguments )
/// API Reference: http://api.jquery.com/pushStack
/// </summary>
/// <param name="elements" type="Array">
/// An array of elements to push onto the stack and make into a new jQuery object.
/// </param>
/// <returns type="jQuery" />
},
clearQueue: function(queueName){
/// <summary>
/// Remove from the queue all items that have not yet been run.
/// API Reference: http://api.jquery.com/clearQueue
/// </summary>
/// <param name="queueName" type="String" optional="true">
/// A string containing the name of the queue. Defaults to fx, the standard effects queue.
/// </param>
/// <returns type="jQuery" />
},
toArray: function(){
/// <summary>
/// Retrieve all the DOM elements contained in the jQuery set, as an array.
/// API Reference: http://api.jquery.com/toArray
/// </summary>
/// <returns type="Array" />
},
keydown: function(handler){
/// <summary>
/// Bind an event handler to the "keydown" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .keydown( [eventData], handler )
/// 	2. .keydown( )
/// API Reference: http://api.jquery.com/keydown
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
index: function(){
/// <summary>
/// Search for a given element from among the matched elements.
/// Additional Signatures:
/// 	1. .index( selector )
/// 	2. .index( element )
/// API Reference: http://api.jquery.com/index
/// </summary>
/// <returns type="Number" />
},
removeData: function(name){
/// <summary>
/// Remove a previously-stored piece of data.
/// API Reference: http://api.jquery.com/removeData
/// </summary>
/// <param name="name" type="String" optional="true">
/// A string naming the piece of data to delete.
/// </param>
/// <returns type="jQuery" />
},
data: function(key, value){
/// <summary>
/// Store arbitrary data associated with the matched elements.
/// Additional Signatures:
/// 	1. .data( obj )
/// API Reference: http://api.jquery.com/data
/// </summary>
/// <param name="key" type="String">
/// A string naming the piece of data to set.
/// </param>
/// <param name="value" type="Object">
/// The new data value; it can be any Javascript type including Array or Object.
/// </param>
/// <returns type="jQuery" />
},
data: function(key){
/// <summary>
/// Returns value at named data store for the first element in the jQuery collection, as set by data(name, value).
/// Additional Signatures:
/// 	1. .data( )
/// API Reference: http://api.jquery.com/data
/// </summary>
/// <param name="key" type="String">
/// Name of the data stored.
/// </param>
/// <returns type="Object" />
},
get: function(index){
/// <summary>
/// Retrieve the DOM elements matched by the jQuery object.
/// API Reference: http://api.jquery.com/get
/// </summary>
/// <param name="index" type="Number" optional="true">
/// A zero-based integer indicating which element to retrieve.
/// </param>
/// <returns type="Array" />
},
size: function(){
/// <summary>
/// Return the number of DOM elements matched by the jQuery object.
/// API Reference: http://api.jquery.com/size
/// </summary>
/// <returns type="Number" />
},
scroll: function(handler){
/// <summary>
/// Bind an event handler to the "scroll" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .scroll( [eventData], handler )
/// 	2. .scroll( )
/// API Reference: http://api.jquery.com/scroll
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
resize: function(handler){
/// <summary>
/// Bind an event handler to the "resize" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .resize( [eventData], handler )
/// 	2. .resize( )
/// API Reference: http://api.jquery.com/resize
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
dequeue: function(queueName){
/// <summary>
/// Execute the next function on the queue for the matched elements.
/// API Reference: http://api.jquery.com/dequeue
/// </summary>
/// <param name="queueName" type="String" optional="true">
/// A string containing the name of the queue. Defaults to fx, the standard effects queue.
/// </param>
/// <returns type="jQuery" />
},
queue: function(queueName){
/// <summary>
/// Show the queue of functions to be executed on the matched elements.
/// API Reference: http://api.jquery.com/queue
/// </summary>
/// <param name="queueName" type="String" optional="true">
/// A string containing the name of the queue. Defaults to fx, the standard effects queue.
/// </param>
/// <returns type="Array" />
},
queue: function(queueName, newQueue){
/// <summary>
/// Manipulate the queue of functions to be executed on the matched elements.
/// Additional Signatures:
/// 	1. .queue( [queueName], method )
/// API Reference: http://api.jquery.com/queue
/// </summary>
/// <param name="queueName" type="String" optional="true">
/// A string containing the name of the queue. Defaults to fx, the standard effects queue.
/// </param>
/// <param name="newQueue" type="Array">
/// An array of functions to replace the current queue contents.
/// </param>
/// <returns type="jQuery" />
},
keyup: function(handler){
/// <summary>
/// Bind an event handler to the "keyup" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .keyup( [eventData], handler )
/// 	2. .keyup( )
/// API Reference: http://api.jquery.com/keyup
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
keypress: function(handler){
/// <summary>
/// Bind an event handler to the "keypress" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .keypress( [eventData], handler )
/// 	2. .keypress( )
/// API Reference: http://api.jquery.com/keypress
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
submit: function(handler){
/// <summary>
/// Bind an event handler to the "submit" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .submit( [eventData], handler )
/// 	2. .submit( )
/// API Reference: http://api.jquery.com/submit
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
select: function(handler){
/// <summary>
/// Bind an event handler to the "select" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .select( [eventData], handler )
/// 	2. .select( )
/// API Reference: http://api.jquery.com/select
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
change: function(handler){
/// <summary>
/// Bind an event handler to the "change" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .change( [eventData], handler )
/// 	2. .change( )
/// API Reference: http://api.jquery.com/change
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
blur: function(handler){
/// <summary>
/// Bind an event handler to the "blur" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .blur( [eventData], handler )
/// 	2. .blur( )
/// API Reference: http://api.jquery.com/blur
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
focus: function(handler){
/// <summary>
/// Bind an event handler to the "focus" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .focus( [eventData], handler )
/// 	2. .focus( )
/// API Reference: http://api.jquery.com/focus
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
mousemove: function(handler){
/// <summary>
/// Bind an event handler to the "mousemove" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .mousemove( [eventData], handler )
/// 	2. .mousemove( )
/// API Reference: http://api.jquery.com/mousemove
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
hover: function(handler, handler1){
/// <summary>
/// Bind two handlers to the matched elements, to be executed when the mouse pointer enters and leaves the elements.
/// API Reference: http://api.jquery.com/hover
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute when the mouse pointer enters the element.
/// </param>
/// <param name="handler1" type="Function">
/// A function to execute when the mouse pointer leaves the element.
/// </param>
/// <returns type="jQuery" />
},
hover: function(handler){
/// <summary>
/// Bind a single handler to the matched elements, to be executed when the mouse pointer enters or leaves the elements.
/// API Reference: http://api.jquery.com/hover
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute when the mouse pointer enters or leaves the element.
/// </param>
/// <returns type="jQuery" />
},
mouseleave: function(handler){
/// <summary>
/// Bind an event handler to be fired when the mouse leaves an element, or trigger that handler on an element.
/// Additional Signatures:
/// 	1. .mouseleave( [eventData], handler )
/// 	2. .mouseleave( )
/// API Reference: http://api.jquery.com/mouseleave
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
mouseenter: function(handler){
/// <summary>
/// Bind an event handler to be fired when the mouse enters an element, or trigger that handler on an element.
/// Additional Signatures:
/// 	1. .mouseenter( [eventData], handler )
/// 	2. .mouseenter( )
/// API Reference: http://api.jquery.com/mouseenter
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
mouseout: function(handler){
/// <summary>
/// Bind an event handler to the "mouseout" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .mouseout( [eventData], handler )
/// 	2. .mouseout( )
/// API Reference: http://api.jquery.com/mouseout
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
mouseover: function(handler){
/// <summary>
/// Bind an event handler to the "mouseover" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .mouseover( [eventData], handler )
/// 	2. .mouseover( )
/// API Reference: http://api.jquery.com/mouseover
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
dblclick: function(handler){
/// <summary>
/// Bind an event handler to the "dblclick" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .dblclick( [eventData], handler )
/// 	2. .dblclick( )
/// API Reference: http://api.jquery.com/dblclick
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
click: function(handler){
/// <summary>
/// Bind an event handler to the "click" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .click( [eventData], handler )
/// 	2. .click( )
/// API Reference: http://api.jquery.com/click
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
mouseup: function(handler){
/// <summary>
/// Bind an event handler to the "mouseup" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .mouseup( [eventData], handler )
/// 	2. .mouseup( )
/// API Reference: http://api.jquery.com/mouseup
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
mousedown: function(handler){
/// <summary>
/// Bind an event handler to the "mousedown" JavaScript event, or trigger that event on an element.
/// Additional Signatures:
/// 	1. .mousedown( [eventData], handler )
/// 	2. .mousedown( )
/// API Reference: http://api.jquery.com/mousedown
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
error: function(handler){
/// <summary>
/// Bind an event handler to the "error" JavaScript event.
/// Additional Signatures:
/// 	1. .error( [eventData], handler )
/// API Reference: http://api.jquery.com/error
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute when the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
unload: function(handler){
/// <summary>
/// Bind an event handler to the "unload" JavaScript event.
/// Additional Signatures:
/// 	1. .unload( [eventData], handler )
/// API Reference: http://api.jquery.com/unload
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute when the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
load: function(handler){
/// <summary>
/// Bind an event handler to the "load" JavaScript event.
/// Additional Signatures:
/// 	1. .load( [eventData], handler )
/// API Reference: http://api.jquery.com/load
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute when the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
ready: function(handler){
/// <summary>
/// Specify a function to execute when the DOM is fully loaded.
/// API Reference: http://api.jquery.com/ready
/// </summary>
/// <param name="handler" type="Function">
/// A function to execute after the DOM is ready.
/// </param>
/// <returns type="jQuery" />
},
die: function(){
/// <summary>
/// Remove all event handlers previously attached using .live() from the elements.
/// API Reference: http://api.jquery.com/die
/// </summary>
/// <returns type="jQuery" />
},
die: function(eventType, handler){
/// <summary>
/// Remove an event handler previously attached using .live() from the elements.
/// API Reference: http://api.jquery.com/die
/// </summary>
/// <param name="eventType" type="String">
/// A string containing a JavaScript event type, such as click or keydown.
/// </param>
/// <param name="handler" type="String" optional="true">
/// The function that is to be no longer executed.
/// </param>
/// <returns type="jQuery" />
},
live: function(eventType, handler){
/// <summary>
/// Attach a handler to the event for all elements which match the current selector, now and in the future.
/// Additional Signatures:
/// 	1. .live( eventType, eventData, handler )
/// API Reference: http://api.jquery.com/live
/// </summary>
/// <param name="eventType" type="String">
/// A string containing a JavaScript event type, such as "click" or "keydown." As of jQuery 1.4 the string can contain multiple, space-separated event types or custom event names, as well.
/// </param>
/// <param name="handler" type="Function">
/// A function to execute at the time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
triggerHandler: function(eventType, extraParameters){
/// <summary>
/// Execute all handlers attached to an element for an event.
/// API Reference: http://api.jquery.com/triggerHandler
/// </summary>
/// <param name="eventType" type="String">
/// A string containing a JavaScript event type, such as click or submit.
/// </param>
/// <param name="extraParameters" type="Array">
/// An array of additional parameters to pass along to the event handler.
/// </param>
/// <returns type="Object" />
},
trigger: function(eventType, extraParameters){
/// <summary>
/// Execute all handlers and behaviors attached to the matched elements for the given event type.
/// Additional Signatures:
/// 	1. .trigger( event )
/// API Reference: http://api.jquery.com/trigger
/// </summary>
/// <param name="eventType" type="String">
/// A string containing a JavaScript event type, such as click or submit.
/// </param>
/// <param name="extraParameters" type="Array">
/// An array of additional parameters to pass along to the event handler.
/// </param>
/// <returns type="jQuery" />
},
ajaxComplete: function(handler){
/// <summary>
/// Register a handler to be called when Ajax requests complete. This is an Ajax Event.
/// API Reference: http://api.jquery.com/ajaxComplete
/// </summary>
/// <param name="handler" type="Function">
/// The function to be invoked.
/// </param>
/// <returns type="jQuery" />
},
one: function(eventType, eventData, handler){
/// <summary>
/// Attach a handler to an event for the elements. The handler is executed at most once per element.
/// API Reference: http://api.jquery.com/one
/// </summary>
/// <param name="eventType" type="String">
/// A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names.
/// </param>
/// <param name="eventData" type="Object" optional="true">
/// A map of data that will be passed to the event handler.
/// </param>
/// <param name="handler" type="Function">
/// A function to execute at the time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
serializeArray: function(){
/// <summary>
/// Encode a set of form elements as an array of names and values.
/// API Reference: http://api.jquery.com/serializeArray
/// </summary>
/// <returns type="Array" />
},
serialize: function(){
/// <summary>
/// Encode a set of form elements as a string for submission.
/// API Reference: http://api.jquery.com/serialize
/// </summary>
/// <returns type="String" />
},
ajaxSuccess: function(handler){
/// <summary>
/// Attach a function to be executed whenever an Ajax request completes successfully. This is an Ajax Event.
/// API Reference: http://api.jquery.com/ajaxSuccess
/// </summary>
/// <param name="handler" type="Function">
/// The function to be invoked.
/// </param>
/// <returns type="jQuery" />
},
ajaxStop: function(handler){
/// <summary>
/// Register a handler to be called when all Ajax requests have completed. This is an Ajax Event.
/// API Reference: http://api.jquery.com/ajaxStop
/// </summary>
/// <param name="handler" type="Function">
/// The function to be invoked.
/// </param>
/// <returns type="jQuery" />
},
ajaxStart: function(handler){
/// <summary>
/// Register a handler to be called when the first Ajax request begins. This is an Ajax Event.
/// API Reference: http://api.jquery.com/ajaxStart
/// </summary>
/// <param name="handler" type="Function">
/// The function to be invoked.
/// </param>
/// <returns type="jQuery" />
},
ajaxSend: function(handler){
/// <summary>
/// Attach a function to be executed before an Ajax request is sent. This is an Ajax Event.
/// API Reference: http://api.jquery.com/ajaxSend
/// </summary>
/// <param name="handler" type="Function">
/// The function to be invoked.
/// </param>
/// <returns type="jQuery" />
},
ajaxError: function(handler){
/// <summary>
/// Register a handler to be called when Ajax requests complete with an error. This is an Ajax Event.
/// API Reference: http://api.jquery.com/ajaxError
/// </summary>
/// <param name="handler" type="Function">
/// The function to be invoked.
/// </param>
/// <returns type="jQuery" />
},
unbind: function(eventType, handler){
/// <summary>
/// Remove a previously-attached event handler from the elements.
/// Additional Signatures:
/// 	1. .unbind( eventType, false )
/// 	2. .unbind( event )
/// API Reference: http://api.jquery.com/unbind
/// </summary>
/// <param name="eventType" type="String" optional="true">
/// A string containing a JavaScript event type, such as click or submit.
/// </param>
/// <param name="handler" type="Function" optional="true">
/// The function that is to be no longer executed.
/// </param>
/// <returns type="jQuery" />
},
bind: function(eventType, eventData, handler){
/// <summary>
/// Attach a handler to an event for the elements.
/// Additional Signatures:
/// 	1. .bind( eventType, [eventData], false )
/// 	2. .bind( events )
/// API Reference: http://api.jquery.com/bind
/// </summary>
/// <param name="eventType" type="String">
/// A string containing one or more JavaScript event types, such as "click" or "submit," or custom event names.
/// </param>
/// <param name="eventData" type="Object" optional="true">
/// A map of data that will be passed to the event handler.
/// </param>
/// <param name="handler" type="Function">
/// A function to execute each time the event is triggered.
/// </param>
/// <returns type="jQuery" />
},
first: function(){
/// <summary>
/// Reduce the set of matched elements to the first in the set.
/// API Reference: http://api.jquery.com/first
/// </summary>
/// <returns type="jQuery" />
},
last: function(){
/// <summary>
/// Reduce the set of matched elements to the final one in the set.
/// API Reference: http://api.jquery.com/last
/// </summary>
/// <returns type="jQuery" />
},
slice: function(start, end){
/// <summary>
/// Reduce the set of matched elements to a subset specified by a range of indices.
/// API Reference: http://api.jquery.com/slice
/// </summary>
/// <param name="start" type="Number" integer="true">
/// An integer indicating the 0-based position at which the elements begin to be selected. If negative, it indicates an offset from the end of the set.
/// </param>
/// <param name="end" type="Number" optional="true" integer="true">
/// An integer indicating the 0-based position at which the elements stop being selected. If negative, it indicates an offset from the end of the set. If omitted, the range continues until the end of the set.
/// </param>
/// <returns type="jQuery" />
},
stop: function(clearQueue, jumpToEnd){
/// <summary>
/// Stop the currently-running animation on the matched elements.
/// API Reference: http://api.jquery.com/stop
/// </summary>
/// <param name="clearQueue" type="Boolean" optional="true">
/// A Boolean indicating whether to remove queued animation as well. Defaults to false.
/// </param>
/// <param name="jumpToEnd" type="Boolean" optional="true">
/// A Boolean indicating whether to complete the current animation immediately. Defaults to false.
/// </param>
/// <returns type="jQuery" />
},
end: function(){
/// <summary>
/// End the most recent filtering operation in the current chain and return the set of matched elements to its previous state.
/// API Reference: http://api.jquery.com/end
/// </summary>
/// <returns type="jQuery" />
},
andSelf: function(){
/// <summary>
/// Add the previous set of elements on the stack to the current set.
/// API Reference: http://api.jquery.com/andSelf
/// </summary>
/// <returns type="jQuery" />
},
siblings: function(selector){
/// <summary>
/// Get the siblings of each element in the set of matched elements, optionally filtered by a selector.
/// API Reference: http://api.jquery.com/siblings
/// </summary>
/// <param name="selector" type="String" optional="true">
/// A string containing a selector expression to match elements against.
/// </param>
/// <returns type="jQuery" />
},
animate: function(properties, duration, easing, callback){
/// <summary>
/// Perform a custom animation of a set of CSS properties.
/// Additional Signatures:
/// 	1. .animate( properties, options )
/// API Reference: http://api.jquery.com/animate
/// </summary>
/// <param name="properties" type="Object">
/// A map of CSS properties that the animation will move toward.
/// </param>
/// <param name="duration" type="Number" optional="true">
/// A string or number determining how long the animation will run.
/// </param>
/// <param name="easing" type="String" optional="true">
/// A string indicating which easing function to use for the transition.
/// </param>
/// <param name="callback" type="Function" optional="true">
/// A function to call once the animation is complete.
/// </param>
/// <returns type="jQuery" />
},
prevAll: function(selector){
/// <summary>
/// Get all preceding siblings of each element in the set of matched elements, optionally filtered by a selector.
/// API Reference: http://api.jquery.com/prevAll
/// </summary>
/// <param name="selector" type="String" optional="true">
/// A string containing a selector expression to match elements against.
/// </param>
/// <returns type="jQuery" />
},
prev: function(selector){
/// <summary>
/// Get the immediately preceding sibling of each element in the set of matched elements, optionally filtered by a selector.
/// API Reference: http://api.jquery.com/prev
/// </summary>
/// <param name="selector" type="String" optional="true">
/// A string containing a selector expression to match elements against.
/// </param>
/// <returns type="jQuery" />
},
fadeTo: function(duration, opacity, callback){
/// <summary>
/// Adjust the opacity of the matched elements.
/// Additional Signatures:
/// 	1. .fadeTo( [duration], opacity, [easing], [callback] )
/// API Reference: http://api.jquery.com/fadeTo
/// </summary>
/// <param name="duration" type="Number">
/// A string or number determining how long the animation will run.
/// </param>
/// <param name="opacity" type="Number">
/// A number between 0 and 1 denoting the target opacity.
/// </param>
/// <param name="callback" type="Function" optional="true">
/// A function to call once the animation is complete.
/// </param>
/// <returns type="jQuery" />
},
fadeOut: function(duration, callback){
/// <summary>
/// Hide the matched elements by fading them to transparent.
/// Additional Signatures:
/// 	1. .fadeOut( [duration], [easing], [callback] )
/// API Reference: http://api.jquery.com/fadeOut
/// </summary>
/// <param name="duration" type="Number" optional="true">
/// A string or number determining how long the animation will run.
/// </param>
/// <param name="callback" type="Function" optional="true">
/// A function to call once the animation is complete.
/// </param>
/// <returns type="jQuery" />
},
parents: function(selector){
/// <summary>
/// Get the ancestors of each element in the current set of matched elements, optionally filtered by a selector.
/// API Reference: http://api.jquery.com/parents
/// </summary>
/// <param name="selector" type="String" optional="true">
/// A string containing a selector expression to match elements against.
/// </param>
/// <returns type="jQuery" />
},
fadeIn: function(duration, callback){
/// <summary>
/// Display the matched elements by fading them to opaque.
/// Additional Signatures:
/// 	1. .fadeIn( [duration], [easing], [callback] )
/// API Reference: http://api.jquery.com/fadeIn
/// </summary>
/// <param name="duration" type="Number" optional="true">
/// A string or number determining how long the animation will run.
/// </param>
/// <param name="callback" type="Function" optional="true">
/// A function to call once the animation is complete.
/// </param>
/// <returns type="jQuery" />
},
parent: function(selector){
/// <summary>
/// Get the parent of each element in the current set of matched elements, optionally filtered by a selector.
/// API Reference: http://api.jquery.com/parent
/// </summary>
/// <param name="selector" type="String" optional="true">
/// A string containing a selector expression to match elements against.
/// </param>
/// <returns type="jQuery" />
},
offsetParent: function(){
/// <summary>
/// Get the closest ancestor element that is positioned.
/// API Reference: http://api.jquery.com/offsetParent
/// </summary>
/// <returns type="jQuery" />
},
slideToggle: function(duration, callback){
/// <summary>
/// Display or hide the matched elements with a sliding motion.
/// Additional Signatures:
/// 	1. .slideToggle( [duration], [easing], [callback] )
/// API Reference: http://api.jquery.com/slideToggle
/// </summary>
/// <param name="duration" type="Number" optional="true">
/// A string or number determining how long the animation will run.
/// </param>
/// <param name="callback" type="Function" optional="true">
/// A function to call once the animation is complete.
/// </param>
/// <returns type="jQuery" />
},
slideUp: function(duration, callback){