summaryrefslogtreecommitdiff
path: root/src/jquery.ui.waitbutton.js
blob: 02253781afde8610684552219d5d5aa3bdbf417c (plain)
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
/*!
 * Copyright (c) 2013 Ben Olson (https://github.com/bseth99/jquery-ui-extensions)
 * jQuery UI WaitButton @VERSION
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * Depends:
 *  jquery.ui.core.js
 *  jquery.ui.widget.js
 *  jquery.ui.button.js
 */
 (function ( $, undefined ) {
    $.widget( "ui.waitbutton", $.ui.button, {

       version: "@VERSION",

       // Keep button prefix instead of waitbutton
       // otherwise waiting event is waitbuttonwaiting
       // which is weird.
       widgetEventPrefix: "button",

       options: {
          waitLabel: null,
          waitIcon: 'ui-icon-waiting'
       },

       _saved: null,

       _create: function() {

          this._super();

          this.element.addClass('ui-wait-button');
          this._saved = {};

          this._saveOptions();

       },

       _init: function() {

          this._super();

          this.disable();
          this._toggleWaitState();
          this._initWaitClick();

       },

       _initWaitClick: function() {

          /**
          *   channel clicks through waiting event instead
          *   base button does not listen to click -
          *   it listens to mousedown/up.  This prevents any external
          *   listeners from firing when we want to use the callback
          *   provided by the waiting event.
          */
          this.element.off( 'click' );

          this.element.one( 'click', $.proxy( this, '_toggleWaitState' ) );
       },

       _toggleWaitState: function() {

          var event;

          if ( this.options.disabled ) {

             this._setOptions({
                disabled: false,
                label: this._saved.label,
                icons: { primary: this._saved.icon }
             });

          } else {

             this._saveOptions();

             this._setOptions({
                disabled: true,
                label: this.options.waitLabel || this.options.label,
                icons: { primary: this.options.waitIcon }
             });

             event = arguments[0] || (new jQuery.Event( 'click', { target: this.element } ) );

             /* channel clicks through waiting event instead */
             event.preventDefault();
             event.stopPropagation();
             event.stopImmediatePropagation();

             this._trigger( 'waiting', event, { done: $.proxy( this, '_waitComplete' ) } );
          }

       },

       _waitComplete: function() {

          // Juggle arguments
          var label = (arguments[0] && typeof( arguments[0] ) == 'string' ? arguments[0] : null),
              enable = (label ? arguments[1] : arguments[0]);

          // Determine next state - either return to start or
          // use a different label and/or leave in disabled state

          if ( typeof( enable ) == 'undefined' ) enable = true;

          this._toggleWaitState();
          if ( enable ) {
             this._initWaitClick();
          } else {
             this.disable();
          }

          if ( label ) {
             this._setOption( 'label', label );
          }
       },

       _saveOptions: function() {

          this._saved.icon = this.options.icons.primary;
          this._saved.label = this.options.label;

       }

    });

})(jQuery);