Merge "Allow maxlength attribute on HTMLSelectAndOtherField"
[lhc/web/wiklou.git] / resources / lib / oojs-ui / oojs-ui.js
1 /*!
2 * OOjs UI v0.1.0-pre (fe4076af75)
3 * https://www.mediawiki.org/wiki/OOjs_UI
4 *
5 * Copyright 2011–2014 OOjs Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
8 *
9 * Date: 2014-11-13T22:25:17Z
10 */
11 ( function ( OO ) {
12
13 'use strict';
14
15 /**
16 * Namespace for all classes, static methods and static properties.
17 *
18 * @class
19 * @singleton
20 */
21 OO.ui = {};
22
23 OO.ui.bind = $.proxy;
24
25 /**
26 * @property {Object}
27 */
28 OO.ui.Keys = {
29 UNDEFINED: 0,
30 BACKSPACE: 8,
31 DELETE: 46,
32 LEFT: 37,
33 RIGHT: 39,
34 UP: 38,
35 DOWN: 40,
36 ENTER: 13,
37 END: 35,
38 HOME: 36,
39 TAB: 9,
40 PAGEUP: 33,
41 PAGEDOWN: 34,
42 ESCAPE: 27,
43 SHIFT: 16,
44 SPACE: 32
45 };
46
47 /**
48 * Get the user's language and any fallback languages.
49 *
50 * These language codes are used to localize user interface elements in the user's language.
51 *
52 * In environments that provide a localization system, this function should be overridden to
53 * return the user's language(s). The default implementation returns English (en) only.
54 *
55 * @return {string[]} Language codes, in descending order of priority
56 */
57 OO.ui.getUserLanguages = function () {
58 return [ 'en' ];
59 };
60
61 /**
62 * Get a value in an object keyed by language code.
63 *
64 * @param {Object.<string,Mixed>} obj Object keyed by language code
65 * @param {string|null} [lang] Language code, if omitted or null defaults to any user language
66 * @param {string} [fallback] Fallback code, used if no matching language can be found
67 * @return {Mixed} Local value
68 */
69 OO.ui.getLocalValue = function ( obj, lang, fallback ) {
70 var i, len, langs;
71
72 // Requested language
73 if ( obj[lang] ) {
74 return obj[lang];
75 }
76 // Known user language
77 langs = OO.ui.getUserLanguages();
78 for ( i = 0, len = langs.length; i < len; i++ ) {
79 lang = langs[i];
80 if ( obj[lang] ) {
81 return obj[lang];
82 }
83 }
84 // Fallback language
85 if ( obj[fallback] ) {
86 return obj[fallback];
87 }
88 // First existing language
89 for ( lang in obj ) {
90 return obj[lang];
91 }
92
93 return undefined;
94 };
95
96 /**
97 * Check if a node is contained within another node
98 *
99 * Similar to jQuery#contains except a list of containers can be supplied
100 * and a boolean argument allows you to include the container in the match list
101 *
102 * @param {HTMLElement|HTMLElement[]} containers Container node(s) to search in
103 * @param {HTMLElement} contained Node to find
104 * @param {boolean} [matchContainers] Include the container(s) in the list of nodes to match, otherwise only match descendents
105 * @returns {boolean} The node is in the list of target nodes
106 */
107 OO.ui.contains = function ( containers, contained, matchContainers ) {
108 var i;
109 if ( !Array.isArray( containers ) ) {
110 containers = [ containers ];
111 }
112 for ( i = containers.length - 1; i >= 0; i-- ) {
113 if ( ( matchContainers && contained === containers[i] ) || $.contains( containers[i], contained ) ) {
114 return true;
115 }
116 }
117 return false;
118 };
119
120 ( function () {
121 /**
122 * Message store for the default implementation of OO.ui.msg
123 *
124 * Environments that provide a localization system should not use this, but should override
125 * OO.ui.msg altogether.
126 *
127 * @private
128 */
129 var messages = {
130 // Tool tip for a button that moves items in a list down one place
131 'ooui-outline-control-move-down': 'Move item down',
132 // Tool tip for a button that moves items in a list up one place
133 'ooui-outline-control-move-up': 'Move item up',
134 // Tool tip for a button that removes items from a list
135 'ooui-outline-control-remove': 'Remove item',
136 // Label for the toolbar group that contains a list of all other available tools
137 'ooui-toolbar-more': 'More',
138 // Label for the fake tool that expands the full list of tools in a toolbar group
139 'ooui-toolgroup-expand': 'More',
140 // Label for the fake tool that collapses the full list of tools in a toolbar group
141 'ooui-toolgroup-collapse': 'Fewer',
142 // Default label for the accept button of a confirmation dialog
143 'ooui-dialog-message-accept': 'OK',
144 // Default label for the reject button of a confirmation dialog
145 'ooui-dialog-message-reject': 'Cancel',
146 // Title for process dialog error description
147 'ooui-dialog-process-error': 'Something went wrong',
148 // Label for process dialog dismiss error button, visible when describing errors
149 'ooui-dialog-process-dismiss': 'Dismiss',
150 // Label for process dialog retry action button, visible when describing only recoverable errors
151 'ooui-dialog-process-retry': 'Try again',
152 // Label for process dialog retry action button, visible when describing only warnings
153 'ooui-dialog-process-continue': 'Continue'
154 };
155
156 /**
157 * Get a localized message.
158 *
159 * In environments that provide a localization system, this function should be overridden to
160 * return the message translated in the user's language. The default implementation always returns
161 * English messages.
162 *
163 * After the message key, message parameters may optionally be passed. In the default implementation,
164 * any occurrences of $1 are replaced with the first parameter, $2 with the second parameter, etc.
165 * Alternative implementations of OO.ui.msg may use any substitution system they like, as long as
166 * they support unnamed, ordered message parameters.
167 *
168 * @abstract
169 * @param {string} key Message key
170 * @param {Mixed...} [params] Message parameters
171 * @return {string} Translated message with parameters substituted
172 */
173 OO.ui.msg = function ( key ) {
174 var message = messages[key], params = Array.prototype.slice.call( arguments, 1 );
175 if ( typeof message === 'string' ) {
176 // Perform $1 substitution
177 message = message.replace( /\$(\d+)/g, function ( unused, n ) {
178 var i = parseInt( n, 10 );
179 return params[i - 1] !== undefined ? params[i - 1] : '$' + n;
180 } );
181 } else {
182 // Return placeholder if message not found
183 message = '[' + key + ']';
184 }
185 return message;
186 };
187
188 /**
189 * Package a message and arguments for deferred resolution.
190 *
191 * Use this when you are statically specifying a message and the message may not yet be present.
192 *
193 * @param {string} key Message key
194 * @param {Mixed...} [params] Message parameters
195 * @return {Function} Function that returns the resolved message when executed
196 */
197 OO.ui.deferMsg = function () {
198 var args = arguments;
199 return function () {
200 return OO.ui.msg.apply( OO.ui, args );
201 };
202 };
203
204 /**
205 * Resolve a message.
206 *
207 * If the message is a function it will be executed, otherwise it will pass through directly.
208 *
209 * @param {Function|string} msg Deferred message, or message text
210 * @return {string} Resolved message
211 */
212 OO.ui.resolveMsg = function ( msg ) {
213 if ( $.isFunction( msg ) ) {
214 return msg();
215 }
216 return msg;
217 };
218
219 } )();
220
221 /**
222 * Element that can be marked as pending.
223 *
224 * @abstract
225 * @class
226 *
227 * @constructor
228 * @param {Object} [config] Configuration options
229 * @cfg {jQuery} [$pending] Element to mark as pending, defaults to this.$element
230 */
231 OO.ui.PendingElement = function OoUiPendingElement( config ) {
232 // Configuration initialization
233 config = config || {};
234
235 // Properties
236 this.pending = 0;
237 this.$pending = null;
238
239 // Initialisation
240 this.setPendingElement( config.$pending || this.$element );
241 };
242
243 /* Setup */
244
245 OO.initClass( OO.ui.PendingElement );
246
247 /* Methods */
248
249 /**
250 * Set the pending element (and clean up any existing one).
251 *
252 * @param {jQuery} $pending The element to set to pending.
253 */
254 OO.ui.PendingElement.prototype.setPendingElement = function ( $pending ) {
255 if ( this.$pending ) {
256 this.$pending.removeClass( 'oo-ui-pendingElement-pending' );
257 }
258
259 this.$pending = $pending;
260 if ( this.pending > 0 ) {
261 this.$pending.addClass( 'oo-ui-pendingElement-pending' );
262 }
263 };
264
265 /**
266 * Check if input is pending.
267 *
268 * @return {boolean}
269 */
270 OO.ui.PendingElement.prototype.isPending = function () {
271 return !!this.pending;
272 };
273
274 /**
275 * Increase the pending stack.
276 *
277 * @chainable
278 */
279 OO.ui.PendingElement.prototype.pushPending = function () {
280 if ( this.pending === 0 ) {
281 this.$pending.addClass( 'oo-ui-pendingElement-pending' );
282 this.updateThemeClasses();
283 }
284 this.pending++;
285
286 return this;
287 };
288
289 /**
290 * Reduce the pending stack.
291 *
292 * Clamped at zero.
293 *
294 * @chainable
295 */
296 OO.ui.PendingElement.prototype.popPending = function () {
297 if ( this.pending === 1 ) {
298 this.$pending.removeClass( 'oo-ui-pendingElement-pending' );
299 this.updateThemeClasses();
300 }
301 this.pending = Math.max( 0, this.pending - 1 );
302
303 return this;
304 };
305
306 /**
307 * List of actions.
308 *
309 * @abstract
310 * @class
311 * @mixins OO.EventEmitter
312 *
313 * @constructor
314 * @param {Object} [config] Configuration options
315 */
316 OO.ui.ActionSet = function OoUiActionSet( config ) {
317 // Configuration intialization
318 config = config || {};
319
320 // Mixin constructors
321 OO.EventEmitter.call( this );
322
323 // Properties
324 this.list = [];
325 this.categories = {
326 actions: 'getAction',
327 flags: 'getFlags',
328 modes: 'getModes'
329 };
330 this.categorized = {};
331 this.special = {};
332 this.others = [];
333 this.organized = false;
334 this.changing = false;
335 this.changed = false;
336 };
337
338 /* Setup */
339
340 OO.mixinClass( OO.ui.ActionSet, OO.EventEmitter );
341
342 /* Static Properties */
343
344 /**
345 * Symbolic name of dialog.
346 *
347 * @abstract
348 * @static
349 * @inheritable
350 * @property {string}
351 */
352 OO.ui.ActionSet.static.specialFlags = [ 'safe', 'primary' ];
353
354 /* Events */
355
356 /**
357 * @event click
358 * @param {OO.ui.ActionWidget} action Action that was clicked
359 */
360
361 /**
362 * @event resize
363 * @param {OO.ui.ActionWidget} action Action that was resized
364 */
365
366 /**
367 * @event add
368 * @param {OO.ui.ActionWidget[]} added Actions added
369 */
370
371 /**
372 * @event remove
373 * @param {OO.ui.ActionWidget[]} added Actions removed
374 */
375
376 /**
377 * @event change
378 */
379
380 /* Methods */
381
382 /**
383 * Handle action change events.
384 *
385 * @fires change
386 */
387 OO.ui.ActionSet.prototype.onActionChange = function () {
388 this.organized = false;
389 if ( this.changing ) {
390 this.changed = true;
391 } else {
392 this.emit( 'change' );
393 }
394 };
395
396 /**
397 * Check if a action is one of the special actions.
398 *
399 * @param {OO.ui.ActionWidget} action Action to check
400 * @return {boolean} Action is special
401 */
402 OO.ui.ActionSet.prototype.isSpecial = function ( action ) {
403 var flag;
404
405 for ( flag in this.special ) {
406 if ( action === this.special[flag] ) {
407 return true;
408 }
409 }
410
411 return false;
412 };
413
414 /**
415 * Get actions.
416 *
417 * @param {Object} [filters] Filters to use, omit to get all actions
418 * @param {string|string[]} [filters.actions] Actions that actions must have
419 * @param {string|string[]} [filters.flags] Flags that actions must have
420 * @param {string|string[]} [filters.modes] Modes that actions must have
421 * @param {boolean} [filters.visible] Actions must be visible
422 * @param {boolean} [filters.disabled] Actions must be disabled
423 * @return {OO.ui.ActionWidget[]} Actions matching all criteria
424 */
425 OO.ui.ActionSet.prototype.get = function ( filters ) {
426 var i, len, list, category, actions, index, match, matches;
427
428 if ( filters ) {
429 this.organize();
430
431 // Collect category candidates
432 matches = [];
433 for ( category in this.categorized ) {
434 list = filters[category];
435 if ( list ) {
436 if ( !Array.isArray( list ) ) {
437 list = [ list ];
438 }
439 for ( i = 0, len = list.length; i < len; i++ ) {
440 actions = this.categorized[category][list[i]];
441 if ( Array.isArray( actions ) ) {
442 matches.push.apply( matches, actions );
443 }
444 }
445 }
446 }
447 // Remove by boolean filters
448 for ( i = 0, len = matches.length; i < len; i++ ) {
449 match = matches[i];
450 if (
451 ( filters.visible !== undefined && match.isVisible() !== filters.visible ) ||
452 ( filters.disabled !== undefined && match.isDisabled() !== filters.disabled )
453 ) {
454 matches.splice( i, 1 );
455 len--;
456 i--;
457 }
458 }
459 // Remove duplicates
460 for ( i = 0, len = matches.length; i < len; i++ ) {
461 match = matches[i];
462 index = matches.lastIndexOf( match );
463 while ( index !== i ) {
464 matches.splice( index, 1 );
465 len--;
466 index = matches.lastIndexOf( match );
467 }
468 }
469 return matches;
470 }
471 return this.list.slice();
472 };
473
474 /**
475 * Get special actions.
476 *
477 * Special actions are the first visible actions with special flags, such as 'safe' and 'primary'.
478 * Special flags can be configured by changing #static-specialFlags in a subclass.
479 *
480 * @return {OO.ui.ActionWidget|null} Safe action
481 */
482 OO.ui.ActionSet.prototype.getSpecial = function () {
483 this.organize();
484 return $.extend( {}, this.special );
485 };
486
487 /**
488 * Get other actions.
489 *
490 * Other actions include all non-special visible actions.
491 *
492 * @return {OO.ui.ActionWidget[]} Other actions
493 */
494 OO.ui.ActionSet.prototype.getOthers = function () {
495 this.organize();
496 return this.others.slice();
497 };
498
499 /**
500 * Toggle actions based on their modes.
501 *
502 * Unlike calling toggle on actions with matching flags, this will enforce mutually exclusive
503 * visibility; matching actions will be shown, non-matching actions will be hidden.
504 *
505 * @param {string} mode Mode actions must have
506 * @chainable
507 * @fires toggle
508 * @fires change
509 */
510 OO.ui.ActionSet.prototype.setMode = function ( mode ) {
511 var i, len, action;
512
513 this.changing = true;
514 for ( i = 0, len = this.list.length; i < len; i++ ) {
515 action = this.list[i];
516 action.toggle( action.hasMode( mode ) );
517 }
518
519 this.organized = false;
520 this.changing = false;
521 this.emit( 'change' );
522
523 return this;
524 };
525
526 /**
527 * Change which actions are able to be performed.
528 *
529 * Actions with matching actions will be disabled/enabled. Other actions will not be changed.
530 *
531 * @param {Object.<string,boolean>} actions List of abilities, keyed by action name, values
532 * indicate actions are able to be performed
533 * @chainable
534 */
535 OO.ui.ActionSet.prototype.setAbilities = function ( actions ) {
536 var i, len, action, item;
537
538 for ( i = 0, len = this.list.length; i < len; i++ ) {
539 item = this.list[i];
540 action = item.getAction();
541 if ( actions[action] !== undefined ) {
542 item.setDisabled( !actions[action] );
543 }
544 }
545
546 return this;
547 };
548
549 /**
550 * Executes a function once per action.
551 *
552 * When making changes to multiple actions, use this method instead of iterating over the actions
553 * manually to defer emitting a change event until after all actions have been changed.
554 *
555 * @param {Object|null} actions Filters to use for which actions to iterate over; see #get
556 * @param {Function} callback Callback to run for each action; callback is invoked with three
557 * arguments: the action, the action's index, the list of actions being iterated over
558 * @chainable
559 */
560 OO.ui.ActionSet.prototype.forEach = function ( filter, callback ) {
561 this.changed = false;
562 this.changing = true;
563 this.get( filter ).forEach( callback );
564 this.changing = false;
565 if ( this.changed ) {
566 this.emit( 'change' );
567 }
568
569 return this;
570 };
571
572 /**
573 * Add actions.
574 *
575 * @param {OO.ui.ActionWidget[]} actions Actions to add
576 * @chainable
577 * @fires add
578 * @fires change
579 */
580 OO.ui.ActionSet.prototype.add = function ( actions ) {
581 var i, len, action;
582
583 this.changing = true;
584 for ( i = 0, len = actions.length; i < len; i++ ) {
585 action = actions[i];
586 action.connect( this, {
587 click: [ 'emit', 'click', action ],
588 resize: [ 'emit', 'resize', action ],
589 toggle: [ 'onActionChange' ]
590 } );
591 this.list.push( action );
592 }
593 this.organized = false;
594 this.emit( 'add', actions );
595 this.changing = false;
596 this.emit( 'change' );
597
598 return this;
599 };
600
601 /**
602 * Remove actions.
603 *
604 * @param {OO.ui.ActionWidget[]} actions Actions to remove
605 * @chainable
606 * @fires remove
607 * @fires change
608 */
609 OO.ui.ActionSet.prototype.remove = function ( actions ) {
610 var i, len, index, action;
611
612 this.changing = true;
613 for ( i = 0, len = actions.length; i < len; i++ ) {
614 action = actions[i];
615 index = this.list.indexOf( action );
616 if ( index !== -1 ) {
617 action.disconnect( this );
618 this.list.splice( index, 1 );
619 }
620 }
621 this.organized = false;
622 this.emit( 'remove', actions );
623 this.changing = false;
624 this.emit( 'change' );
625
626 return this;
627 };
628
629 /**
630 * Remove all actions.
631 *
632 * @chainable
633 * @fires remove
634 * @fires change
635 */
636 OO.ui.ActionSet.prototype.clear = function () {
637 var i, len, action,
638 removed = this.list.slice();
639
640 this.changing = true;
641 for ( i = 0, len = this.list.length; i < len; i++ ) {
642 action = this.list[i];
643 action.disconnect( this );
644 }
645
646 this.list = [];
647
648 this.organized = false;
649 this.emit( 'remove', removed );
650 this.changing = false;
651 this.emit( 'change' );
652
653 return this;
654 };
655
656 /**
657 * Organize actions.
658 *
659 * This is called whenver organized information is requested. It will only reorganize the actions
660 * if something has changed since the last time it ran.
661 *
662 * @private
663 * @chainable
664 */
665 OO.ui.ActionSet.prototype.organize = function () {
666 var i, iLen, j, jLen, flag, action, category, list, item, special,
667 specialFlags = this.constructor.static.specialFlags;
668
669 if ( !this.organized ) {
670 this.categorized = {};
671 this.special = {};
672 this.others = [];
673 for ( i = 0, iLen = this.list.length; i < iLen; i++ ) {
674 action = this.list[i];
675 if ( action.isVisible() ) {
676 // Populate catgeories
677 for ( category in this.categories ) {
678 if ( !this.categorized[category] ) {
679 this.categorized[category] = {};
680 }
681 list = action[this.categories[category]]();
682 if ( !Array.isArray( list ) ) {
683 list = [ list ];
684 }
685 for ( j = 0, jLen = list.length; j < jLen; j++ ) {
686 item = list[j];
687 if ( !this.categorized[category][item] ) {
688 this.categorized[category][item] = [];
689 }
690 this.categorized[category][item].push( action );
691 }
692 }
693 // Populate special/others
694 special = false;
695 for ( j = 0, jLen = specialFlags.length; j < jLen; j++ ) {
696 flag = specialFlags[j];
697 if ( !this.special[flag] && action.hasFlag( flag ) ) {
698 this.special[flag] = action;
699 special = true;
700 break;
701 }
702 }
703 if ( !special ) {
704 this.others.push( action );
705 }
706 }
707 }
708 this.organized = true;
709 }
710
711 return this;
712 };
713
714 /**
715 * DOM element abstraction.
716 *
717 * @abstract
718 * @class
719 *
720 * @constructor
721 * @param {Object} [config] Configuration options
722 * @cfg {Function} [$] jQuery for the frame the widget is in
723 * @cfg {string[]} [classes] CSS class names to add
724 * @cfg {string} [text] Text to insert
725 * @cfg {jQuery} [$content] Content elements to append (after text)
726 */
727 OO.ui.Element = function OoUiElement( config ) {
728 // Configuration initialization
729 config = config || {};
730
731 // Properties
732 this.$ = config.$ || OO.ui.Element.getJQuery( document );
733 this.$element = this.$( this.$.context.createElement( this.getTagName() ) );
734 this.elementGroup = null;
735 this.debouncedUpdateThemeClassesHandler = this.debouncedUpdateThemeClasses.bind( this );
736 this.updateThemeClassesPending = false;
737
738 // Initialization
739 if ( $.isArray( config.classes ) ) {
740 this.$element.addClass( config.classes.join( ' ' ) );
741 }
742 if ( config.text ) {
743 this.$element.text( config.text );
744 }
745 if ( config.$content ) {
746 this.$element.append( config.$content );
747 }
748 };
749
750 /* Setup */
751
752 OO.initClass( OO.ui.Element );
753
754 /* Static Properties */
755
756 /**
757 * HTML tag name.
758 *
759 * This may be ignored if #getTagName is overridden.
760 *
761 * @static
762 * @inheritable
763 * @property {string}
764 */
765 OO.ui.Element.static.tagName = 'div';
766
767 /* Static Methods */
768
769 /**
770 * Get a jQuery function within a specific document.
771 *
772 * @static
773 * @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
774 * @param {jQuery} [$iframe] HTML iframe element that contains the document, omit if document is
775 * not in an iframe
776 * @return {Function} Bound jQuery function
777 */
778 OO.ui.Element.getJQuery = function ( context, $iframe ) {
779 function wrapper( selector ) {
780 return $( selector, wrapper.context );
781 }
782
783 wrapper.context = this.getDocument( context );
784
785 if ( $iframe ) {
786 wrapper.$iframe = $iframe;
787 }
788
789 return wrapper;
790 };
791
792 /**
793 * Get the document of an element.
794 *
795 * @static
796 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Object to get the document for
797 * @return {HTMLDocument|null} Document object
798 */
799 OO.ui.Element.getDocument = function ( obj ) {
800 // jQuery - selections created "offscreen" won't have a context, so .context isn't reliable
801 return ( obj[0] && obj[0].ownerDocument ) ||
802 // Empty jQuery selections might have a context
803 obj.context ||
804 // HTMLElement
805 obj.ownerDocument ||
806 // Window
807 obj.document ||
808 // HTMLDocument
809 ( obj.nodeType === 9 && obj ) ||
810 null;
811 };
812
813 /**
814 * Get the window of an element or document.
815 *
816 * @static
817 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the window for
818 * @return {Window} Window object
819 */
820 OO.ui.Element.getWindow = function ( obj ) {
821 var doc = this.getDocument( obj );
822 return doc.parentWindow || doc.defaultView;
823 };
824
825 /**
826 * Get the direction of an element or document.
827 *
828 * @static
829 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the direction for
830 * @return {string} Text direction, either 'ltr' or 'rtl'
831 */
832 OO.ui.Element.getDir = function ( obj ) {
833 var isDoc, isWin;
834
835 if ( obj instanceof jQuery ) {
836 obj = obj[0];
837 }
838 isDoc = obj.nodeType === 9;
839 isWin = obj.document !== undefined;
840 if ( isDoc || isWin ) {
841 if ( isWin ) {
842 obj = obj.document;
843 }
844 obj = obj.body;
845 }
846 return $( obj ).css( 'direction' );
847 };
848
849 /**
850 * Get the offset between two frames.
851 *
852 * TODO: Make this function not use recursion.
853 *
854 * @static
855 * @param {Window} from Window of the child frame
856 * @param {Window} [to=window] Window of the parent frame
857 * @param {Object} [offset] Offset to start with, used internally
858 * @return {Object} Offset object, containing left and top properties
859 */
860 OO.ui.Element.getFrameOffset = function ( from, to, offset ) {
861 var i, len, frames, frame, rect;
862
863 if ( !to ) {
864 to = window;
865 }
866 if ( !offset ) {
867 offset = { top: 0, left: 0 };
868 }
869 if ( from.parent === from ) {
870 return offset;
871 }
872
873 // Get iframe element
874 frames = from.parent.document.getElementsByTagName( 'iframe' );
875 for ( i = 0, len = frames.length; i < len; i++ ) {
876 if ( frames[i].contentWindow === from ) {
877 frame = frames[i];
878 break;
879 }
880 }
881
882 // Recursively accumulate offset values
883 if ( frame ) {
884 rect = frame.getBoundingClientRect();
885 offset.left += rect.left;
886 offset.top += rect.top;
887 if ( from !== to ) {
888 this.getFrameOffset( from.parent, offset );
889 }
890 }
891 return offset;
892 };
893
894 /**
895 * Get the offset between two elements.
896 *
897 * The two elements may be in a different frame, but in that case the frame $element is in must
898 * be contained in the frame $anchor is in.
899 *
900 * @static
901 * @param {jQuery} $element Element whose position to get
902 * @param {jQuery} $anchor Element to get $element's position relative to
903 * @return {Object} Translated position coordinates, containing top and left properties
904 */
905 OO.ui.Element.getRelativePosition = function ( $element, $anchor ) {
906 var iframe, iframePos,
907 pos = $element.offset(),
908 anchorPos = $anchor.offset(),
909 elementDocument = this.getDocument( $element ),
910 anchorDocument = this.getDocument( $anchor );
911
912 // If $element isn't in the same document as $anchor, traverse up
913 while ( elementDocument !== anchorDocument ) {
914 iframe = elementDocument.defaultView.frameElement;
915 if ( !iframe ) {
916 throw new Error( '$element frame is not contained in $anchor frame' );
917 }
918 iframePos = $( iframe ).offset();
919 pos.left += iframePos.left;
920 pos.top += iframePos.top;
921 elementDocument = iframe.ownerDocument;
922 }
923 pos.left -= anchorPos.left;
924 pos.top -= anchorPos.top;
925 return pos;
926 };
927
928 /**
929 * Get element border sizes.
930 *
931 * @static
932 * @param {HTMLElement} el Element to measure
933 * @return {Object} Dimensions object with `top`, `left`, `bottom` and `right` properties
934 */
935 OO.ui.Element.getBorders = function ( el ) {
936 var doc = el.ownerDocument,
937 win = doc.parentWindow || doc.defaultView,
938 style = win && win.getComputedStyle ?
939 win.getComputedStyle( el, null ) :
940 el.currentStyle,
941 $el = $( el ),
942 top = parseFloat( style ? style.borderTopWidth : $el.css( 'borderTopWidth' ) ) || 0,
943 left = parseFloat( style ? style.borderLeftWidth : $el.css( 'borderLeftWidth' ) ) || 0,
944 bottom = parseFloat( style ? style.borderBottomWidth : $el.css( 'borderBottomWidth' ) ) || 0,
945 right = parseFloat( style ? style.borderRightWidth : $el.css( 'borderRightWidth' ) ) || 0;
946
947 return {
948 top: Math.round( top ),
949 left: Math.round( left ),
950 bottom: Math.round( bottom ),
951 right: Math.round( right )
952 };
953 };
954
955 /**
956 * Get dimensions of an element or window.
957 *
958 * @static
959 * @param {HTMLElement|Window} el Element to measure
960 * @return {Object} Dimensions object with `borders`, `scroll`, `scrollbar` and `rect` properties
961 */
962 OO.ui.Element.getDimensions = function ( el ) {
963 var $el, $win,
964 doc = el.ownerDocument || el.document,
965 win = doc.parentWindow || doc.defaultView;
966
967 if ( win === el || el === doc.documentElement ) {
968 $win = $( win );
969 return {
970 borders: { top: 0, left: 0, bottom: 0, right: 0 },
971 scroll: {
972 top: $win.scrollTop(),
973 left: $win.scrollLeft()
974 },
975 scrollbar: { right: 0, bottom: 0 },
976 rect: {
977 top: 0,
978 left: 0,
979 bottom: $win.innerHeight(),
980 right: $win.innerWidth()
981 }
982 };
983 } else {
984 $el = $( el );
985 return {
986 borders: this.getBorders( el ),
987 scroll: {
988 top: $el.scrollTop(),
989 left: $el.scrollLeft()
990 },
991 scrollbar: {
992 right: $el.innerWidth() - el.clientWidth,
993 bottom: $el.innerHeight() - el.clientHeight
994 },
995 rect: el.getBoundingClientRect()
996 };
997 }
998 };
999
1000 /**
1001 * Get closest scrollable container.
1002 *
1003 * Traverses up until either a scrollable element or the root is reached, in which case the window
1004 * will be returned.
1005 *
1006 * @static
1007 * @param {HTMLElement} el Element to find scrollable container for
1008 * @param {string} [dimension] Dimension of scrolling to look for; `x`, `y` or omit for either
1009 * @return {HTMLElement} Closest scrollable container
1010 */
1011 OO.ui.Element.getClosestScrollableContainer = function ( el, dimension ) {
1012 var i, val,
1013 props = [ 'overflow' ],
1014 $parent = $( el ).parent();
1015
1016 if ( dimension === 'x' || dimension === 'y' ) {
1017 props.push( 'overflow-' + dimension );
1018 }
1019
1020 while ( $parent.length ) {
1021 if ( $parent[0] === el.ownerDocument.body ) {
1022 return $parent[0];
1023 }
1024 i = props.length;
1025 while ( i-- ) {
1026 val = $parent.css( props[i] );
1027 if ( val === 'auto' || val === 'scroll' ) {
1028 return $parent[0];
1029 }
1030 }
1031 $parent = $parent.parent();
1032 }
1033 return this.getDocument( el ).body;
1034 };
1035
1036 /**
1037 * Scroll element into view.
1038 *
1039 * @static
1040 * @param {HTMLElement} el Element to scroll into view
1041 * @param {Object} [config] Configuration options
1042 * @param {string} [config.duration] jQuery animation duration value
1043 * @param {string} [config.direction] Scroll in only one direction, e.g. 'x' or 'y', omit
1044 * to scroll in both directions
1045 * @param {Function} [config.complete] Function to call when scrolling completes
1046 */
1047 OO.ui.Element.scrollIntoView = function ( el, config ) {
1048 // Configuration initialization
1049 config = config || {};
1050
1051 var rel, anim = {},
1052 callback = typeof config.complete === 'function' && config.complete,
1053 sc = this.getClosestScrollableContainer( el, config.direction ),
1054 $sc = $( sc ),
1055 eld = this.getDimensions( el ),
1056 scd = this.getDimensions( sc ),
1057 $win = $( this.getWindow( el ) );
1058
1059 // Compute the distances between the edges of el and the edges of the scroll viewport
1060 if ( $sc.is( 'body' ) ) {
1061 // If the scrollable container is the <body> this is easy
1062 rel = {
1063 top: eld.rect.top,
1064 bottom: $win.innerHeight() - eld.rect.bottom,
1065 left: eld.rect.left,
1066 right: $win.innerWidth() - eld.rect.right
1067 };
1068 } else {
1069 // Otherwise, we have to subtract el's coordinates from sc's coordinates
1070 rel = {
1071 top: eld.rect.top - ( scd.rect.top + scd.borders.top ),
1072 bottom: scd.rect.bottom - scd.borders.bottom - scd.scrollbar.bottom - eld.rect.bottom,
1073 left: eld.rect.left - ( scd.rect.left + scd.borders.left ),
1074 right: scd.rect.right - scd.borders.right - scd.scrollbar.right - eld.rect.right
1075 };
1076 }
1077
1078 if ( !config.direction || config.direction === 'y' ) {
1079 if ( rel.top < 0 ) {
1080 anim.scrollTop = scd.scroll.top + rel.top;
1081 } else if ( rel.top > 0 && rel.bottom < 0 ) {
1082 anim.scrollTop = scd.scroll.top + Math.min( rel.top, -rel.bottom );
1083 }
1084 }
1085 if ( !config.direction || config.direction === 'x' ) {
1086 if ( rel.left < 0 ) {
1087 anim.scrollLeft = scd.scroll.left + rel.left;
1088 } else if ( rel.left > 0 && rel.right < 0 ) {
1089 anim.scrollLeft = scd.scroll.left + Math.min( rel.left, -rel.right );
1090 }
1091 }
1092 if ( !$.isEmptyObject( anim ) ) {
1093 $sc.stop( true ).animate( anim, config.duration || 'fast' );
1094 if ( callback ) {
1095 $sc.queue( function ( next ) {
1096 callback();
1097 next();
1098 } );
1099 }
1100 } else {
1101 if ( callback ) {
1102 callback();
1103 }
1104 }
1105 };
1106
1107 /**
1108 * Bind a handler for an event on a DOM element.
1109 *
1110 * Used to be for working around a jQuery bug (jqbug.com/14180),
1111 * but obsolete as of jQuery 1.11.0.
1112 *
1113 * @static
1114 * @deprecated Use jQuery#on instead.
1115 * @param {HTMLElement|jQuery} el DOM element
1116 * @param {string} event Event to bind
1117 * @param {Function} callback Callback to call when the event fires
1118 */
1119 OO.ui.Element.onDOMEvent = function ( el, event, callback ) {
1120 $( el ).on( event, callback );
1121 };
1122
1123 /**
1124 * Unbind a handler bound with #static-method-onDOMEvent.
1125 *
1126 * @deprecated Use jQuery#off instead.
1127 * @static
1128 * @param {HTMLElement|jQuery} el DOM element
1129 * @param {string} event Event to unbind
1130 * @param {Function} [callback] Callback to unbind
1131 */
1132 OO.ui.Element.offDOMEvent = function ( el, event, callback ) {
1133 $( el ).off( event, callback );
1134 };
1135
1136 /* Methods */
1137
1138 /**
1139 * Check if element supports one or more methods.
1140 *
1141 * @param {string|string[]} methods Method or list of methods to check
1142 * @return {boolean} All methods are supported
1143 */
1144 OO.ui.Element.prototype.supports = function ( methods ) {
1145 var i, len,
1146 support = 0;
1147
1148 methods = $.isArray( methods ) ? methods : [ methods ];
1149 for ( i = 0, len = methods.length; i < len; i++ ) {
1150 if ( $.isFunction( this[methods[i]] ) ) {
1151 support++;
1152 }
1153 }
1154
1155 return methods.length === support;
1156 };
1157
1158 /**
1159 * Update the theme-provided classes.
1160 *
1161 * @localdoc This is called in element mixins and widget classes anytime state changes.
1162 * Updating is debounced, minimizing overhead of changing multiple attributes and
1163 * guaranteeing that theme updates do not occur within an element's constructor
1164 */
1165 OO.ui.Element.prototype.updateThemeClasses = function () {
1166 if ( !this.updateThemeClassesPending ) {
1167 this.updateThemeClassesPending = true;
1168 setTimeout( this.debouncedUpdateThemeClassesHandler );
1169 }
1170 };
1171
1172 /**
1173 * @private
1174 */
1175 OO.ui.Element.prototype.debouncedUpdateThemeClasses = function () {
1176 OO.ui.theme.updateElementClasses( this );
1177 this.updateThemeClassesPending = false;
1178 };
1179
1180 /**
1181 * Get the HTML tag name.
1182 *
1183 * Override this method to base the result on instance information.
1184 *
1185 * @return {string} HTML tag name
1186 */
1187 OO.ui.Element.prototype.getTagName = function () {
1188 return this.constructor.static.tagName;
1189 };
1190
1191 /**
1192 * Check if the element is attached to the DOM
1193 * @return {boolean} The element is attached to the DOM
1194 */
1195 OO.ui.Element.prototype.isElementAttached = function () {
1196 return $.contains( this.getElementDocument(), this.$element[0] );
1197 };
1198
1199 /**
1200 * Get the DOM document.
1201 *
1202 * @return {HTMLDocument} Document object
1203 */
1204 OO.ui.Element.prototype.getElementDocument = function () {
1205 return OO.ui.Element.getDocument( this.$element );
1206 };
1207
1208 /**
1209 * Get the DOM window.
1210 *
1211 * @return {Window} Window object
1212 */
1213 OO.ui.Element.prototype.getElementWindow = function () {
1214 return OO.ui.Element.getWindow( this.$element );
1215 };
1216
1217 /**
1218 * Get closest scrollable container.
1219 */
1220 OO.ui.Element.prototype.getClosestScrollableElementContainer = function () {
1221 return OO.ui.Element.getClosestScrollableContainer( this.$element[0] );
1222 };
1223
1224 /**
1225 * Get group element is in.
1226 *
1227 * @return {OO.ui.GroupElement|null} Group element, null if none
1228 */
1229 OO.ui.Element.prototype.getElementGroup = function () {
1230 return this.elementGroup;
1231 };
1232
1233 /**
1234 * Set group element is in.
1235 *
1236 * @param {OO.ui.GroupElement|null} group Group element, null if none
1237 * @chainable
1238 */
1239 OO.ui.Element.prototype.setElementGroup = function ( group ) {
1240 this.elementGroup = group;
1241 return this;
1242 };
1243
1244 /**
1245 * Scroll element into view.
1246 *
1247 * @param {Object} [config] Configuration options
1248 */
1249 OO.ui.Element.prototype.scrollElementIntoView = function ( config ) {
1250 return OO.ui.Element.scrollIntoView( this.$element[0], config );
1251 };
1252
1253 /**
1254 * Bind a handler for an event on this.$element
1255 *
1256 * @deprecated Use jQuery#on instead.
1257 * @param {string} event
1258 * @param {Function} callback
1259 */
1260 OO.ui.Element.prototype.onDOMEvent = function ( event, callback ) {
1261 OO.ui.Element.onDOMEvent( this.$element, event, callback );
1262 };
1263
1264 /**
1265 * Unbind a handler bound with #offDOMEvent
1266 *
1267 * @deprecated Use jQuery#off instead.
1268 * @param {string} event
1269 * @param {Function} callback
1270 */
1271 OO.ui.Element.prototype.offDOMEvent = function ( event, callback ) {
1272 OO.ui.Element.offDOMEvent( this.$element, event, callback );
1273 };
1274
1275 /**
1276 * Container for elements.
1277 *
1278 * @abstract
1279 * @class
1280 * @extends OO.ui.Element
1281 * @mixins OO.EventEmitter
1282 *
1283 * @constructor
1284 * @param {Object} [config] Configuration options
1285 */
1286 OO.ui.Layout = function OoUiLayout( config ) {
1287 // Configuration initialization
1288 config = config || {};
1289
1290 // Parent constructor
1291 OO.ui.Layout.super.call( this, config );
1292
1293 // Mixin constructors
1294 OO.EventEmitter.call( this );
1295
1296 // Initialization
1297 this.$element.addClass( 'oo-ui-layout' );
1298 };
1299
1300 /* Setup */
1301
1302 OO.inheritClass( OO.ui.Layout, OO.ui.Element );
1303 OO.mixinClass( OO.ui.Layout, OO.EventEmitter );
1304
1305 /**
1306 * User interface control.
1307 *
1308 * @abstract
1309 * @class
1310 * @extends OO.ui.Element
1311 * @mixins OO.EventEmitter
1312 *
1313 * @constructor
1314 * @param {Object} [config] Configuration options
1315 * @cfg {boolean} [disabled=false] Disable
1316 */
1317 OO.ui.Widget = function OoUiWidget( config ) {
1318 // Initialize config
1319 config = $.extend( { disabled: false }, config );
1320
1321 // Parent constructor
1322 OO.ui.Widget.super.call( this, config );
1323
1324 // Mixin constructors
1325 OO.EventEmitter.call( this );
1326
1327 // Properties
1328 this.visible = true;
1329 this.disabled = null;
1330 this.wasDisabled = null;
1331
1332 // Initialization
1333 this.$element.addClass( 'oo-ui-widget' );
1334 this.setDisabled( !!config.disabled );
1335 };
1336
1337 /* Setup */
1338
1339 OO.inheritClass( OO.ui.Widget, OO.ui.Element );
1340 OO.mixinClass( OO.ui.Widget, OO.EventEmitter );
1341
1342 /* Events */
1343
1344 /**
1345 * @event disable
1346 * @param {boolean} disabled Widget is disabled
1347 */
1348
1349 /**
1350 * @event toggle
1351 * @param {boolean} visible Widget is visible
1352 */
1353
1354 /* Methods */
1355
1356 /**
1357 * Check if the widget is disabled.
1358 *
1359 * @return {boolean} Button is disabled
1360 */
1361 OO.ui.Widget.prototype.isDisabled = function () {
1362 return this.disabled;
1363 };
1364
1365 /**
1366 * Check if widget is visible.
1367 *
1368 * @return {boolean} Widget is visible
1369 */
1370 OO.ui.Widget.prototype.isVisible = function () {
1371 return this.visible;
1372 };
1373
1374 /**
1375 * Set the disabled state of the widget.
1376 *
1377 * This should probably change the widgets' appearance and prevent it from being used.
1378 *
1379 * @param {boolean} disabled Disable widget
1380 * @chainable
1381 */
1382 OO.ui.Widget.prototype.setDisabled = function ( disabled ) {
1383 var isDisabled;
1384
1385 this.disabled = !!disabled;
1386 isDisabled = this.isDisabled();
1387 if ( isDisabled !== this.wasDisabled ) {
1388 this.$element.toggleClass( 'oo-ui-widget-disabled', isDisabled );
1389 this.$element.toggleClass( 'oo-ui-widget-enabled', !isDisabled );
1390 this.emit( 'disable', isDisabled );
1391 this.updateThemeClasses();
1392 }
1393 this.wasDisabled = isDisabled;
1394
1395 return this;
1396 };
1397
1398 /**
1399 * Toggle visibility of widget.
1400 *
1401 * @param {boolean} [show] Make widget visible, omit to toggle visibility
1402 * @fires visible
1403 * @chainable
1404 */
1405 OO.ui.Widget.prototype.toggle = function ( show ) {
1406 show = show === undefined ? !this.visible : !!show;
1407
1408 if ( show !== this.isVisible() ) {
1409 this.visible = show;
1410 this.$element.toggle( show );
1411 this.emit( 'toggle', show );
1412 }
1413
1414 return this;
1415 };
1416
1417 /**
1418 * Update the disabled state, in case of changes in parent widget.
1419 *
1420 * @chainable
1421 */
1422 OO.ui.Widget.prototype.updateDisabled = function () {
1423 this.setDisabled( this.disabled );
1424 return this;
1425 };
1426
1427 /**
1428 * Container for elements in a child frame.
1429 *
1430 * Use together with OO.ui.WindowManager.
1431 *
1432 * @abstract
1433 * @class
1434 * @extends OO.ui.Element
1435 * @mixins OO.EventEmitter
1436 *
1437 * When a window is opened, the setup and ready processes are executed. Similarly, the hold and
1438 * teardown processes are executed when the window is closed.
1439 *
1440 * - {@link OO.ui.WindowManager#openWindow} or {@link #open} methods are used to start opening
1441 * - Window manager begins opening window
1442 * - {@link #getSetupProcess} method is called and its result executed
1443 * - {@link #getReadyProcess} method is called and its result executed
1444 * - Window is now open
1445 *
1446 * - {@link OO.ui.WindowManager#closeWindow} or {@link #close} methods are used to start closing
1447 * - Window manager begins closing window
1448 * - {@link #getHoldProcess} method is called and its result executed
1449 * - {@link #getTeardownProcess} method is called and its result executed
1450 * - Window is now closed
1451 *
1452 * Each process (setup, ready, hold and teardown) can be extended in subclasses by overriding
1453 * {@link #getSetupProcess}, {@link #getReadyProcess}, {@link #getHoldProcess} and
1454 * {@link #getTeardownProcess} respectively. Each process is executed in series, so asynchonous
1455 * processing can complete. Always assume window processes are executed asychronously. See
1456 * OO.ui.Process for more details about how to work with processes. Some events, as well as the
1457 * #open and #close methods, provide promises which are resolved when the window enters a new state.
1458 *
1459 * Sizing of windows is specified using symbolic names which are interpreted by the window manager.
1460 * If the requested size is not recognized, the window manager will choose a sensible fallback.
1461 *
1462 * @constructor
1463 * @param {Object} [config] Configuration options
1464 * @cfg {string} [size] Symbolic name of dialog size, `small`, `medium`, `large` or `full`; omit to
1465 * use #static-size
1466 */
1467 OO.ui.Window = function OoUiWindow( config ) {
1468 // Configuration initialization
1469 config = config || {};
1470
1471 // Parent constructor
1472 OO.ui.Window.super.call( this, config );
1473
1474 // Mixin constructors
1475 OO.EventEmitter.call( this );
1476
1477 // Properties
1478 this.manager = null;
1479 this.initialized = false;
1480 this.visible = false;
1481 this.opening = null;
1482 this.closing = null;
1483 this.opened = null;
1484 this.timing = null;
1485 this.loading = null;
1486 this.size = config.size || this.constructor.static.size;
1487 this.$frame = this.$( '<div>' );
1488 this.$overlay = this.$( '<div>' );
1489
1490 // Initialization
1491 this.$element
1492 .addClass( 'oo-ui-window' )
1493 .append( this.$frame, this.$overlay );
1494 this.$frame.addClass( 'oo-ui-window-frame' );
1495 this.$overlay.addClass( 'oo-ui-window-overlay' );
1496
1497 // NOTE: Additional intitialization will occur when #setManager is called
1498 };
1499
1500 /* Setup */
1501
1502 OO.inheritClass( OO.ui.Window, OO.ui.Element );
1503 OO.mixinClass( OO.ui.Window, OO.EventEmitter );
1504
1505 /* Static Properties */
1506
1507 /**
1508 * Symbolic name of size.
1509 *
1510 * Size is used if no size is configured during construction.
1511 *
1512 * @static
1513 * @inheritable
1514 * @property {string}
1515 */
1516 OO.ui.Window.static.size = 'medium';
1517
1518 /* Static Methods */
1519
1520 /**
1521 * Transplant the CSS styles from as parent document to a frame's document.
1522 *
1523 * This loops over the style sheets in the parent document, and copies their nodes to the
1524 * frame's document. It then polls the document to see when all styles have loaded, and once they
1525 * have, resolves the promise.
1526 *
1527 * If the styles still haven't loaded after a long time (5 seconds by default), we give up waiting
1528 * and resolve the promise anyway. This protects against cases like a display: none; iframe in
1529 * Firefox, where the styles won't load until the iframe becomes visible.
1530 *
1531 * For details of how we arrived at the strategy used in this function, see #load.
1532 *
1533 * @static
1534 * @inheritable
1535 * @param {HTMLDocument} parentDoc Document to transplant styles from
1536 * @param {HTMLDocument} frameDoc Document to transplant styles to
1537 * @param {number} [timeout=5000] How long to wait before giving up (in ms). If 0, never give up.
1538 * @return {jQuery.Promise} Promise resolved when styles have loaded
1539 */
1540 OO.ui.Window.static.transplantStyles = function ( parentDoc, frameDoc, timeout ) {
1541 var i, numSheets, styleNode, styleText, newNode, timeoutID, pollNodeId, $pendingPollNodes,
1542 $pollNodes = $( [] ),
1543 // Fake font-family value
1544 fontFamily = 'oo-ui-frame-transplantStyles-loaded',
1545 nextIndex = parentDoc.oouiFrameTransplantStylesNextIndex || 0,
1546 deferred = $.Deferred();
1547
1548 for ( i = 0, numSheets = parentDoc.styleSheets.length; i < numSheets; i++ ) {
1549 styleNode = parentDoc.styleSheets[i].ownerNode;
1550 if ( styleNode.disabled ) {
1551 continue;
1552 }
1553
1554 if ( styleNode.nodeName.toLowerCase() === 'link' ) {
1555 // External stylesheet; use @import
1556 styleText = '@import url(' + styleNode.href + ');';
1557 } else {
1558 // Internal stylesheet; just copy the text
1559 // For IE10 we need to fall back to .cssText, BUT that's undefined in
1560 // other browsers, so fall back to '' rather than 'undefined'
1561 styleText = styleNode.textContent || parentDoc.styleSheets[i].cssText || '';
1562 }
1563
1564 // Create a node with a unique ID that we're going to monitor to see when the CSS
1565 // has loaded
1566 if ( styleNode.oouiFrameTransplantStylesId ) {
1567 // If we're nesting transplantStyles operations and this node already has
1568 // a CSS rule to wait for loading, reuse it
1569 pollNodeId = styleNode.oouiFrameTransplantStylesId;
1570 } else {
1571 // Otherwise, create a new ID
1572 pollNodeId = 'oo-ui-frame-transplantStyles-loaded-' + nextIndex;
1573 nextIndex++;
1574
1575 // Add #pollNodeId { font-family: ... } to the end of the stylesheet / after the @import
1576 // The font-family rule will only take effect once the @import finishes
1577 styleText += '\n' + '#' + pollNodeId + ' { font-family: ' + fontFamily + '; }';
1578 }
1579
1580 // Create a node with id=pollNodeId
1581 $pollNodes = $pollNodes.add( $( '<div>', frameDoc )
1582 .attr( 'id', pollNodeId )
1583 .appendTo( frameDoc.body )
1584 );
1585
1586 // Add our modified CSS as a <style> tag
1587 newNode = frameDoc.createElement( 'style' );
1588 newNode.textContent = styleText;
1589 newNode.oouiFrameTransplantStylesId = pollNodeId;
1590 frameDoc.head.appendChild( newNode );
1591 }
1592 frameDoc.oouiFrameTransplantStylesNextIndex = nextIndex;
1593
1594 // Poll every 100ms until all external stylesheets have loaded
1595 $pendingPollNodes = $pollNodes;
1596 timeoutID = setTimeout( function pollExternalStylesheets() {
1597 while (
1598 $pendingPollNodes.length > 0 &&
1599 $pendingPollNodes.eq( 0 ).css( 'font-family' ) === fontFamily
1600 ) {
1601 $pendingPollNodes = $pendingPollNodes.slice( 1 );
1602 }
1603
1604 if ( $pendingPollNodes.length === 0 ) {
1605 // We're done!
1606 if ( timeoutID !== null ) {
1607 timeoutID = null;
1608 $pollNodes.remove();
1609 deferred.resolve();
1610 }
1611 } else {
1612 timeoutID = setTimeout( pollExternalStylesheets, 100 );
1613 }
1614 }, 100 );
1615 // ...but give up after a while
1616 if ( timeout !== 0 ) {
1617 setTimeout( function () {
1618 if ( timeoutID ) {
1619 clearTimeout( timeoutID );
1620 timeoutID = null;
1621 $pollNodes.remove();
1622 deferred.reject();
1623 }
1624 }, timeout || 5000 );
1625 }
1626
1627 return deferred.promise();
1628 };
1629
1630 /* Methods */
1631
1632 /**
1633 * Handle mouse down events.
1634 *
1635 * @param {jQuery.Event} e Mouse down event
1636 */
1637 OO.ui.Window.prototype.onMouseDown = function ( e ) {
1638 // Prevent clicking on the click-block from stealing focus
1639 if ( e.target === this.$element[0] ) {
1640 return false;
1641 }
1642 };
1643
1644 /**
1645 * Check if window has been initialized.
1646 *
1647 * @return {boolean} Window has been initialized
1648 */
1649 OO.ui.Window.prototype.isInitialized = function () {
1650 return this.initialized;
1651 };
1652
1653 /**
1654 * Check if window is visible.
1655 *
1656 * @return {boolean} Window is visible
1657 */
1658 OO.ui.Window.prototype.isVisible = function () {
1659 return this.visible;
1660 };
1661
1662 /**
1663 * Check if window is loading.
1664 *
1665 * @return {boolean} Window is loading
1666 */
1667 OO.ui.Window.prototype.isLoading = function () {
1668 return this.loading && this.loading.state() === 'pending';
1669 };
1670
1671 /**
1672 * Check if window is loaded.
1673 *
1674 * @return {boolean} Window is loaded
1675 */
1676 OO.ui.Window.prototype.isLoaded = function () {
1677 return this.loading && this.loading.state() === 'resolved';
1678 };
1679
1680 /**
1681 * Check if window is opening.
1682 *
1683 * This is a wrapper around OO.ui.WindowManager#isOpening.
1684 *
1685 * @return {boolean} Window is opening
1686 */
1687 OO.ui.Window.prototype.isOpening = function () {
1688 return this.manager.isOpening( this );
1689 };
1690
1691 /**
1692 * Check if window is closing.
1693 *
1694 * This is a wrapper around OO.ui.WindowManager#isClosing.
1695 *
1696 * @return {boolean} Window is closing
1697 */
1698 OO.ui.Window.prototype.isClosing = function () {
1699 return this.manager.isClosing( this );
1700 };
1701
1702 /**
1703 * Check if window is opened.
1704 *
1705 * This is a wrapper around OO.ui.WindowManager#isOpened.
1706 *
1707 * @return {boolean} Window is opened
1708 */
1709 OO.ui.Window.prototype.isOpened = function () {
1710 return this.manager.isOpened( this );
1711 };
1712
1713 /**
1714 * Get the window manager.
1715 *
1716 * @return {OO.ui.WindowManager} Manager of window
1717 */
1718 OO.ui.Window.prototype.getManager = function () {
1719 return this.manager;
1720 };
1721
1722 /**
1723 * Get the window size.
1724 *
1725 * @return {string} Symbolic size name, e.g. 'small', 'medium', 'large', 'full'
1726 */
1727 OO.ui.Window.prototype.getSize = function () {
1728 return this.size;
1729 };
1730
1731 /**
1732 * Get the height of the dialog contents.
1733 *
1734 * @return {number} Content height
1735 */
1736 OO.ui.Window.prototype.getContentHeight = function () {
1737 // Temporarily resize the frame so getBodyHeight() can use scrollHeight measurements
1738 var bodyHeight, oldHeight = this.$frame[0].style.height;
1739 this.$frame[0].style.height = '1px';
1740 bodyHeight = this.getBodyHeight();
1741 this.$frame[0].style.height = oldHeight;
1742
1743 return Math.round(
1744 // Add buffer for border
1745 ( this.$frame.outerHeight() - this.$frame.innerHeight() ) +
1746 // Use combined heights of children
1747 ( this.$head.outerHeight( true ) + bodyHeight + this.$foot.outerHeight( true ) )
1748 );
1749 };
1750
1751 /**
1752 * Get the height of the dialog contents.
1753 *
1754 * When this function is called, the dialog will temporarily have been resized
1755 * to height=1px, so .scrollHeight measurements can be taken accurately.
1756 *
1757 * @return {number} Height of content
1758 */
1759 OO.ui.Window.prototype.getBodyHeight = function () {
1760 return this.$body[0].scrollHeight;
1761 };
1762
1763 /**
1764 * Get the directionality of the frame
1765 *
1766 * @return {string} Directionality, 'ltr' or 'rtl'
1767 */
1768 OO.ui.Window.prototype.getDir = function () {
1769 return this.dir;
1770 };
1771
1772 /**
1773 * Get a process for setting up a window for use.
1774 *
1775 * Each time the window is opened this process will set it up for use in a particular context, based
1776 * on the `data` argument.
1777 *
1778 * When you override this method, you can add additional setup steps to the process the parent
1779 * method provides using the 'first' and 'next' methods.
1780 *
1781 * @abstract
1782 * @param {Object} [data] Window opening data
1783 * @return {OO.ui.Process} Setup process
1784 */
1785 OO.ui.Window.prototype.getSetupProcess = function () {
1786 return new OO.ui.Process();
1787 };
1788
1789 /**
1790 * Get a process for readying a window for use.
1791 *
1792 * Each time the window is open and setup, this process will ready it up for use in a particular
1793 * context, based on the `data` argument.
1794 *
1795 * When you override this method, you can add additional setup steps to the process the parent
1796 * method provides using the 'first' and 'next' methods.
1797 *
1798 * @abstract
1799 * @param {Object} [data] Window opening data
1800 * @return {OO.ui.Process} Setup process
1801 */
1802 OO.ui.Window.prototype.getReadyProcess = function () {
1803 return new OO.ui.Process();
1804 };
1805
1806 /**
1807 * Get a process for holding a window from use.
1808 *
1809 * Each time the window is closed, this process will hold it from use in a particular context, based
1810 * on the `data` argument.
1811 *
1812 * When you override this method, you can add additional setup steps to the process the parent
1813 * method provides using the 'first' and 'next' methods.
1814 *
1815 * @abstract
1816 * @param {Object} [data] Window closing data
1817 * @return {OO.ui.Process} Hold process
1818 */
1819 OO.ui.Window.prototype.getHoldProcess = function () {
1820 return new OO.ui.Process();
1821 };
1822
1823 /**
1824 * Get a process for tearing down a window after use.
1825 *
1826 * Each time the window is closed this process will tear it down and do something with the user's
1827 * interactions within the window, based on the `data` argument.
1828 *
1829 * When you override this method, you can add additional teardown steps to the process the parent
1830 * method provides using the 'first' and 'next' methods.
1831 *
1832 * @abstract
1833 * @param {Object} [data] Window closing data
1834 * @return {OO.ui.Process} Teardown process
1835 */
1836 OO.ui.Window.prototype.getTeardownProcess = function () {
1837 return new OO.ui.Process();
1838 };
1839
1840 /**
1841 * Toggle visibility of window.
1842 *
1843 * If the window is isolated and hasn't fully loaded yet, the visiblity property will be used
1844 * instead of display.
1845 *
1846 * @param {boolean} [show] Make window visible, omit to toggle visibility
1847 * @fires toggle
1848 * @chainable
1849 */
1850 OO.ui.Window.prototype.toggle = function ( show ) {
1851 show = show === undefined ? !this.visible : !!show;
1852
1853 if ( show !== this.isVisible() ) {
1854 this.visible = show;
1855
1856 if ( this.isolated && !this.isLoaded() ) {
1857 // Hide the window using visibility instead of display until loading is complete
1858 // Can't use display: none; because that prevents the iframe from loading in Firefox
1859 this.$element.css( 'visibility', show ? 'visible' : 'hidden' );
1860 } else {
1861 this.$element.toggle( show ).css( 'visibility', '' );
1862 }
1863 this.emit( 'toggle', show );
1864 }
1865
1866 return this;
1867 };
1868
1869 /**
1870 * Set the window manager.
1871 *
1872 * This must be called before initialize. Calling it more than once will cause an error.
1873 *
1874 * @param {OO.ui.WindowManager} manager Manager for this window
1875 * @throws {Error} If called more than once
1876 * @chainable
1877 */
1878 OO.ui.Window.prototype.setManager = function ( manager ) {
1879 if ( this.manager ) {
1880 throw new Error( 'Cannot set window manager, window already has a manager' );
1881 }
1882
1883 // Properties
1884 this.manager = manager;
1885 this.isolated = manager.shouldIsolate();
1886
1887 // Initialization
1888 if ( this.isolated ) {
1889 this.$iframe = this.$( '<iframe>' );
1890 this.$iframe.attr( { frameborder: 0, scrolling: 'no' } );
1891 this.$frame.append( this.$iframe );
1892 this.$ = function () {
1893 throw new Error( 'this.$() cannot be used until the frame has been initialized.' );
1894 };
1895 // WARNING: Do not use this.$ again until #initialize is called
1896 } else {
1897 this.$content = this.$( '<div>' );
1898 this.$document = $( this.getElementDocument() );
1899 this.$content.addClass( 'oo-ui-window-content' );
1900 this.$frame.append( this.$content );
1901 }
1902 this.toggle( false );
1903
1904 // Figure out directionality:
1905 this.dir = OO.ui.Element.getDir( this.$iframe || this.$content ) || 'ltr';
1906
1907 return this;
1908 };
1909
1910 /**
1911 * Set the window size.
1912 *
1913 * @param {string} size Symbolic size name, e.g. 'small', 'medium', 'large', 'full'
1914 * @chainable
1915 */
1916 OO.ui.Window.prototype.setSize = function ( size ) {
1917 this.size = size;
1918 this.manager.updateWindowSize( this );
1919 return this;
1920 };
1921
1922 /**
1923 * Set window dimensions.
1924 *
1925 * Properties are applied to the frame container.
1926 *
1927 * @param {Object} dim CSS dimension properties
1928 * @param {string|number} [dim.width] Width
1929 * @param {string|number} [dim.minWidth] Minimum width
1930 * @param {string|number} [dim.maxWidth] Maximum width
1931 * @param {string|number} [dim.width] Height, omit to set based on height of contents
1932 * @param {string|number} [dim.minWidth] Minimum height
1933 * @param {string|number} [dim.maxWidth] Maximum height
1934 * @chainable
1935 */
1936 OO.ui.Window.prototype.setDimensions = function ( dim ) {
1937 // Apply width before height so height is not based on wrapping content using the wrong width
1938 this.$frame.css( {
1939 width: dim.width || '',
1940 minWidth: dim.minWidth || '',
1941 maxWidth: dim.maxWidth || ''
1942 } );
1943 this.$frame.css( {
1944 height: ( dim.height !== undefined ? dim.height : this.getContentHeight() ) || '',
1945 minHeight: dim.minHeight || '',
1946 maxHeight: dim.maxHeight || ''
1947 } );
1948 return this;
1949 };
1950
1951 /**
1952 * Initialize window contents.
1953 *
1954 * The first time the window is opened, #initialize is called when it's safe to begin populating
1955 * its contents. See #getSetupProcess for a way to make changes each time the window opens.
1956 *
1957 * Once this method is called, this.$ can be used to create elements within the frame.
1958 *
1959 * @throws {Error} If not attached to a manager
1960 * @chainable
1961 */
1962 OO.ui.Window.prototype.initialize = function () {
1963 if ( !this.manager ) {
1964 throw new Error( 'Cannot initialize window, must be attached to a manager' );
1965 }
1966
1967 // Properties
1968 this.$head = this.$( '<div>' );
1969 this.$body = this.$( '<div>' );
1970 this.$foot = this.$( '<div>' );
1971 this.$innerOverlay = this.$( '<div>' );
1972
1973 // Events
1974 this.$element.on( 'mousedown', this.onMouseDown.bind( this ) );
1975
1976 // Initialization
1977 this.$head.addClass( 'oo-ui-window-head' );
1978 this.$body.addClass( 'oo-ui-window-body' );
1979 this.$foot.addClass( 'oo-ui-window-foot' );
1980 this.$innerOverlay.addClass( 'oo-ui-window-inner-overlay' );
1981 this.$content.append( this.$head, this.$body, this.$foot, this.$innerOverlay );
1982
1983 return this;
1984 };
1985
1986 /**
1987 * Open window.
1988 *
1989 * This is a wrapper around calling {@link OO.ui.WindowManager#openWindow} on the window manager.
1990 * To do something each time the window opens, use #getSetupProcess or #getReadyProcess.
1991 *
1992 * @param {Object} [data] Window opening data
1993 * @return {jQuery.Promise} Promise resolved when window is opened; when the promise is resolved the
1994 * first argument will be a promise which will be resolved when the window begins closing
1995 */
1996 OO.ui.Window.prototype.open = function ( data ) {
1997 return this.manager.openWindow( this, data );
1998 };
1999
2000 /**
2001 * Close window.
2002 *
2003 * This is a wrapper around calling OO.ui.WindowManager#closeWindow on the window manager.
2004 * To do something each time the window closes, use #getHoldProcess or #getTeardownProcess.
2005 *
2006 * @param {Object} [data] Window closing data
2007 * @return {jQuery.Promise} Promise resolved when window is closed
2008 */
2009 OO.ui.Window.prototype.close = function ( data ) {
2010 return this.manager.closeWindow( this, data );
2011 };
2012
2013 /**
2014 * Setup window.
2015 *
2016 * This is called by OO.ui.WindowManager durring window opening, and should not be called directly
2017 * by other systems.
2018 *
2019 * @param {Object} [data] Window opening data
2020 * @return {jQuery.Promise} Promise resolved when window is setup
2021 */
2022 OO.ui.Window.prototype.setup = function ( data ) {
2023 var win = this,
2024 deferred = $.Deferred();
2025
2026 this.$element.show();
2027 this.visible = true;
2028 this.getSetupProcess( data ).execute().done( function () {
2029 // Force redraw by asking the browser to measure the elements' widths
2030 win.$element.addClass( 'oo-ui-window-setup' ).width();
2031 win.$content.addClass( 'oo-ui-window-content-setup' ).width();
2032 deferred.resolve();
2033 } );
2034
2035 return deferred.promise();
2036 };
2037
2038 /**
2039 * Ready window.
2040 *
2041 * This is called by OO.ui.WindowManager durring window opening, and should not be called directly
2042 * by other systems.
2043 *
2044 * @param {Object} [data] Window opening data
2045 * @return {jQuery.Promise} Promise resolved when window is ready
2046 */
2047 OO.ui.Window.prototype.ready = function ( data ) {
2048 var win = this,
2049 deferred = $.Deferred();
2050
2051 this.$content.focus();
2052 this.getReadyProcess( data ).execute().done( function () {
2053 // Force redraw by asking the browser to measure the elements' widths
2054 win.$element.addClass( 'oo-ui-window-ready' ).width();
2055 win.$content.addClass( 'oo-ui-window-content-ready' ).width();
2056 deferred.resolve();
2057 } );
2058
2059 return deferred.promise();
2060 };
2061
2062 /**
2063 * Hold window.
2064 *
2065 * This is called by OO.ui.WindowManager durring window closing, and should not be called directly
2066 * by other systems.
2067 *
2068 * @param {Object} [data] Window closing data
2069 * @return {jQuery.Promise} Promise resolved when window is held
2070 */
2071 OO.ui.Window.prototype.hold = function ( data ) {
2072 var win = this,
2073 deferred = $.Deferred();
2074
2075 this.getHoldProcess( data ).execute().done( function () {
2076 // Get the focused element within the window's content
2077 var $focus = win.$content.find( OO.ui.Element.getDocument( win.$content ).activeElement );
2078
2079 // Blur the focused element
2080 if ( $focus.length ) {
2081 $focus[0].blur();
2082 }
2083
2084 // Force redraw by asking the browser to measure the elements' widths
2085 win.$element.removeClass( 'oo-ui-window-ready' ).width();
2086 win.$content.removeClass( 'oo-ui-window-content-ready' ).width();
2087 deferred.resolve();
2088 } );
2089
2090 return deferred.promise();
2091 };
2092
2093 /**
2094 * Teardown window.
2095 *
2096 * This is called by OO.ui.WindowManager durring window closing, and should not be called directly
2097 * by other systems.
2098 *
2099 * @param {Object} [data] Window closing data
2100 * @return {jQuery.Promise} Promise resolved when window is torn down
2101 */
2102 OO.ui.Window.prototype.teardown = function ( data ) {
2103 var win = this,
2104 deferred = $.Deferred();
2105
2106 this.getTeardownProcess( data ).execute().done( function () {
2107 // Force redraw by asking the browser to measure the elements' widths
2108 win.$element.removeClass( 'oo-ui-window-load oo-ui-window-setup' ).width();
2109 win.$content.removeClass( 'oo-ui-window-content-setup' ).width();
2110 win.$element.hide();
2111 win.visible = false;
2112 deferred.resolve();
2113 } );
2114
2115 return deferred.promise();
2116 };
2117
2118 /**
2119 * Load the frame contents.
2120 *
2121 * Once the iframe's stylesheets are loaded the returned promise will be resolved. Calling while
2122 * loading will return a promise but not trigger a new loading cycle. Calling after loading is
2123 * complete will return a promise that's already been resolved.
2124 *
2125 * Sounds simple right? Read on...
2126 *
2127 * When you create a dynamic iframe using open/write/close, the window.load event for the
2128 * iframe is triggered when you call close, and there's no further load event to indicate that
2129 * everything is actually loaded.
2130 *
2131 * In Chrome, stylesheets don't show up in document.styleSheets until they have loaded, so we could
2132 * just poll that array and wait for it to have the right length. However, in Firefox, stylesheets
2133 * are added to document.styleSheets immediately, and the only way you can determine whether they've
2134 * loaded is to attempt to access .cssRules and wait for that to stop throwing an exception. But
2135 * cross-domain stylesheets never allow .cssRules to be accessed even after they have loaded.
2136 *
2137 * The workaround is to change all `<link href="...">` tags to `<style>@import url(...)</style>`
2138 * tags. Because `@import` is blocking, Chrome won't add the stylesheet to document.styleSheets
2139 * until the `@import` has finished, and Firefox won't allow .cssRules to be accessed until the
2140 * `@import` has finished. And because the contents of the `<style>` tag are from the same origin,
2141 * accessing .cssRules is allowed.
2142 *
2143 * However, now that we control the styles we're injecting, we might as well do away with
2144 * browser-specific polling hacks like document.styleSheets and .cssRules, and instead inject
2145 * `<style>@import url(...); #foo { font-family: someValue; }</style>`, then create `<div id="foo">`
2146 * and wait for its font-family to change to someValue. Because `@import` is blocking, the
2147 * font-family rule is not applied until after the `@import` finishes.
2148 *
2149 * All this stylesheet injection and polling magic is in #transplantStyles.
2150 *
2151 * @return {jQuery.Promise} Promise resolved when loading is complete
2152 */
2153 OO.ui.Window.prototype.load = function () {
2154 var sub, doc, loading,
2155 win = this;
2156
2157 this.$element.addClass( 'oo-ui-window-load' );
2158
2159 // Non-isolated windows are already "loaded"
2160 if ( !this.loading && !this.isolated ) {
2161 this.loading = $.Deferred().resolve();
2162 this.initialize();
2163 // Set initialized state after so sub-classes aren't confused by it being set by calling
2164 // their parent initialize method
2165 this.initialized = true;
2166 }
2167
2168 // Return existing promise if already loading or loaded
2169 if ( this.loading ) {
2170 return this.loading.promise();
2171 }
2172
2173 // Load the frame
2174 loading = this.loading = $.Deferred();
2175 sub = this.$iframe.prop( 'contentWindow' );
2176 doc = sub.document;
2177
2178 // Initialize contents
2179 doc.open();
2180 doc.write(
2181 '<!doctype html>' +
2182 '<html>' +
2183 '<body class="oo-ui-window-isolated oo-ui-' + this.dir + '"' +
2184 ' style="direction:' + this.dir + ';" dir="' + this.dir + '">' +
2185 '<div class="oo-ui-window-content"></div>' +
2186 '</body>' +
2187 '</html>'
2188 );
2189 doc.close();
2190
2191 // Properties
2192 this.$ = OO.ui.Element.getJQuery( doc, this.$iframe );
2193 this.$content = this.$( '.oo-ui-window-content' ).attr( 'tabIndex', 0 );
2194 this.$document = this.$( doc );
2195
2196 // Initialization
2197 this.constructor.static.transplantStyles( this.getElementDocument(), this.$document[0] )
2198 .always( function () {
2199 // Initialize isolated windows
2200 win.initialize();
2201 // Set initialized state after so sub-classes aren't confused by it being set by calling
2202 // their parent initialize method
2203 win.initialized = true;
2204 // Undo the visibility: hidden; hack and apply display: none;
2205 // We can do this safely now that the iframe has initialized
2206 // (don't do this from within #initialize because it has to happen
2207 // after the all subclasses have been handled as well).
2208 win.toggle( win.isVisible() );
2209
2210 loading.resolve();
2211 } );
2212
2213 return loading.promise();
2214 };
2215
2216 /**
2217 * Base class for all dialogs.
2218 *
2219 * Logic:
2220 * - Manage the window (open and close, etc.).
2221 * - Store the internal name and display title.
2222 * - A stack to track one or more pending actions.
2223 * - Manage a set of actions that can be performed.
2224 * - Configure and create action widgets.
2225 *
2226 * User interface:
2227 * - Close the dialog with Escape key.
2228 * - Visually lock the dialog while an action is in
2229 * progress (aka "pending").
2230 *
2231 * Subclass responsibilities:
2232 * - Display the title somewhere.
2233 * - Add content to the dialog.
2234 * - Provide a UI to close the dialog.
2235 * - Display the action widgets somewhere.
2236 *
2237 * @abstract
2238 * @class
2239 * @extends OO.ui.Window
2240 * @mixins OO.ui.PendingElement
2241 *
2242 * @constructor
2243 * @param {Object} [config] Configuration options
2244 */
2245 OO.ui.Dialog = function OoUiDialog( config ) {
2246 // Parent constructor
2247 OO.ui.Dialog.super.call( this, config );
2248
2249 // Mixin constructors
2250 OO.ui.PendingElement.call( this );
2251
2252 // Properties
2253 this.actions = new OO.ui.ActionSet();
2254 this.attachedActions = [];
2255 this.currentAction = null;
2256
2257 // Events
2258 this.actions.connect( this, {
2259 click: 'onActionClick',
2260 resize: 'onActionResize',
2261 change: 'onActionsChange'
2262 } );
2263
2264 // Initialization
2265 this.$element
2266 .addClass( 'oo-ui-dialog' )
2267 .attr( 'role', 'dialog' );
2268 };
2269
2270 /* Setup */
2271
2272 OO.inheritClass( OO.ui.Dialog, OO.ui.Window );
2273 OO.mixinClass( OO.ui.Dialog, OO.ui.PendingElement );
2274
2275 /* Static Properties */
2276
2277 /**
2278 * Symbolic name of dialog.
2279 *
2280 * @abstract
2281 * @static
2282 * @inheritable
2283 * @property {string}
2284 */
2285 OO.ui.Dialog.static.name = '';
2286
2287 /**
2288 * Dialog title.
2289 *
2290 * @abstract
2291 * @static
2292 * @inheritable
2293 * @property {jQuery|string|Function} Label nodes, text or a function that returns nodes or text
2294 */
2295 OO.ui.Dialog.static.title = '';
2296
2297 /**
2298 * List of OO.ui.ActionWidget configuration options.
2299 *
2300 * @static
2301 * inheritable
2302 * @property {Object[]}
2303 */
2304 OO.ui.Dialog.static.actions = [];
2305
2306 /**
2307 * Close dialog when the escape key is pressed.
2308 *
2309 * @static
2310 * @abstract
2311 * @inheritable
2312 * @property {boolean}
2313 */
2314 OO.ui.Dialog.static.escapable = true;
2315
2316 /* Methods */
2317
2318 /**
2319 * Handle frame document key down events.
2320 *
2321 * @param {jQuery.Event} e Key down event
2322 */
2323 OO.ui.Dialog.prototype.onDocumentKeyDown = function ( e ) {
2324 if ( e.which === OO.ui.Keys.ESCAPE ) {
2325 this.close();
2326 return false;
2327 }
2328 };
2329
2330 /**
2331 * Handle action resized events.
2332 *
2333 * @param {OO.ui.ActionWidget} action Action that was resized
2334 */
2335 OO.ui.Dialog.prototype.onActionResize = function () {
2336 // Override in subclass
2337 };
2338
2339 /**
2340 * Handle action click events.
2341 *
2342 * @param {OO.ui.ActionWidget} action Action that was clicked
2343 */
2344 OO.ui.Dialog.prototype.onActionClick = function ( action ) {
2345 if ( !this.isPending() ) {
2346 this.currentAction = action;
2347 this.executeAction( action.getAction() );
2348 }
2349 };
2350
2351 /**
2352 * Handle actions change event.
2353 */
2354 OO.ui.Dialog.prototype.onActionsChange = function () {
2355 this.detachActions();
2356 if ( !this.isClosing() ) {
2357 this.attachActions();
2358 }
2359 };
2360
2361 /**
2362 * Get set of actions.
2363 *
2364 * @return {OO.ui.ActionSet}
2365 */
2366 OO.ui.Dialog.prototype.getActions = function () {
2367 return this.actions;
2368 };
2369
2370 /**
2371 * Get a process for taking action.
2372 *
2373 * When you override this method, you can add additional accept steps to the process the parent
2374 * method provides using the 'first' and 'next' methods.
2375 *
2376 * @abstract
2377 * @param {string} [action] Symbolic name of action
2378 * @return {OO.ui.Process} Action process
2379 */
2380 OO.ui.Dialog.prototype.getActionProcess = function ( action ) {
2381 return new OO.ui.Process()
2382 .next( function () {
2383 if ( !action ) {
2384 // An empty action always closes the dialog without data, which should always be
2385 // safe and make no changes
2386 this.close();
2387 }
2388 }, this );
2389 };
2390
2391 /**
2392 * @inheritdoc
2393 *
2394 * @param {Object} [data] Dialog opening data
2395 * @param {jQuery|string|Function|null} [data.title] Dialog title, omit to use #static-title
2396 * @param {Object[]} [data.actions] List of OO.ui.ActionWidget configuration options for each
2397 * action item, omit to use #static-actions
2398 */
2399 OO.ui.Dialog.prototype.getSetupProcess = function ( data ) {
2400 data = data || {};
2401
2402 // Parent method
2403 return OO.ui.Dialog.super.prototype.getSetupProcess.call( this, data )
2404 .next( function () {
2405 var i, len,
2406 items = [],
2407 config = this.constructor.static,
2408 actions = data.actions !== undefined ? data.actions : config.actions;
2409
2410 this.title.setLabel(
2411 data.title !== undefined ? data.title : this.constructor.static.title
2412 );
2413 for ( i = 0, len = actions.length; i < len; i++ ) {
2414 items.push(
2415 new OO.ui.ActionWidget( $.extend( { $: this.$ }, actions[i] ) )
2416 );
2417 }
2418 this.actions.add( items );
2419 }, this );
2420 };
2421
2422 /**
2423 * @inheritdoc
2424 */
2425 OO.ui.Dialog.prototype.getTeardownProcess = function ( data ) {
2426 // Parent method
2427 return OO.ui.Dialog.super.prototype.getTeardownProcess.call( this, data )
2428 .first( function () {
2429 this.actions.clear();
2430 this.currentAction = null;
2431 }, this );
2432 };
2433
2434 /**
2435 * @inheritdoc
2436 */
2437 OO.ui.Dialog.prototype.initialize = function () {
2438 // Parent method
2439 OO.ui.Dialog.super.prototype.initialize.call( this );
2440
2441 // Properties
2442 this.title = new OO.ui.LabelWidget( { $: this.$ } );
2443
2444 // Events
2445 if ( this.constructor.static.escapable ) {
2446 this.$document.on( 'keydown', this.onDocumentKeyDown.bind( this ) );
2447 }
2448
2449 // Initialization
2450 this.$content.addClass( 'oo-ui-dialog-content' );
2451 this.setPendingElement( this.$head );
2452 };
2453
2454 /**
2455 * Attach action actions.
2456 */
2457 OO.ui.Dialog.prototype.attachActions = function () {
2458 // Remember the list of potentially attached actions
2459 this.attachedActions = this.actions.get();
2460 };
2461
2462 /**
2463 * Detach action actions.
2464 *
2465 * @chainable
2466 */
2467 OO.ui.Dialog.prototype.detachActions = function () {
2468 var i, len;
2469
2470 // Detach all actions that may have been previously attached
2471 for ( i = 0, len = this.attachedActions.length; i < len; i++ ) {
2472 this.attachedActions[i].$element.detach();
2473 }
2474 this.attachedActions = [];
2475 };
2476
2477 /**
2478 * Execute an action.
2479 *
2480 * @param {string} action Symbolic name of action to execute
2481 * @return {jQuery.Promise} Promise resolved when action completes, rejected if it fails
2482 */
2483 OO.ui.Dialog.prototype.executeAction = function ( action ) {
2484 this.pushPending();
2485 return this.getActionProcess( action ).execute()
2486 .always( this.popPending.bind( this ) );
2487 };
2488
2489 /**
2490 * Collection of windows.
2491 *
2492 * @class
2493 * @extends OO.ui.Element
2494 * @mixins OO.EventEmitter
2495 *
2496 * Managed windows are mutually exclusive. If a window is opened while there is a current window
2497 * already opening or opened, the current window will be closed without data. Empty closing data
2498 * should always result in the window being closed without causing constructive or destructive
2499 * action.
2500 *
2501 * As a window is opened and closed, it passes through several stages and the manager emits several
2502 * corresponding events.
2503 *
2504 * - {@link #openWindow} or {@link OO.ui.Window#open} methods are used to start opening
2505 * - {@link #event-opening} is emitted with `opening` promise
2506 * - {@link #getSetupDelay} is called the returned value is used to time a pause in execution
2507 * - {@link OO.ui.Window#getSetupProcess} method is called on the window and its result executed
2508 * - `setup` progress notification is emitted from opening promise
2509 * - {@link #getReadyDelay} is called the returned value is used to time a pause in execution
2510 * - {@link OO.ui.Window#getReadyProcess} method is called on the window and its result executed
2511 * - `ready` progress notification is emitted from opening promise
2512 * - `opening` promise is resolved with `opened` promise
2513 * - Window is now open
2514 *
2515 * - {@link #closeWindow} or {@link OO.ui.Window#close} methods are used to start closing
2516 * - `opened` promise is resolved with `closing` promise
2517 * - {@link #event-closing} is emitted with `closing` promise
2518 * - {@link #getHoldDelay} is called the returned value is used to time a pause in execution
2519 * - {@link OO.ui.Window#getHoldProcess} method is called on the window and its result executed
2520 * - `hold` progress notification is emitted from opening promise
2521 * - {@link #getTeardownDelay} is called the returned value is used to time a pause in execution
2522 * - {@link OO.ui.Window#getTeardownProcess} method is called on the window and its result executed
2523 * - `teardown` progress notification is emitted from opening promise
2524 * - Closing promise is resolved
2525 * - Window is now closed
2526 *
2527 * @constructor
2528 * @param {Object} [config] Configuration options
2529 * @cfg {boolean} [isolate] Configure managed windows to isolate their content using inline frames
2530 * @cfg {OO.Factory} [factory] Window factory to use for automatic instantiation
2531 * @cfg {boolean} [modal=true] Prevent interaction outside the dialog
2532 */
2533 OO.ui.WindowManager = function OoUiWindowManager( config ) {
2534 // Configuration initialization
2535 config = config || {};
2536
2537 // Parent constructor
2538 OO.ui.WindowManager.super.call( this, config );
2539
2540 // Mixin constructors
2541 OO.EventEmitter.call( this );
2542
2543 // Properties
2544 this.factory = config.factory;
2545 this.modal = config.modal === undefined || !!config.modal;
2546 this.isolate = !!config.isolate;
2547 this.windows = {};
2548 this.opening = null;
2549 this.opened = null;
2550 this.closing = null;
2551 this.preparingToOpen = null;
2552 this.preparingToClose = null;
2553 this.size = null;
2554 this.currentWindow = null;
2555 this.$ariaHidden = null;
2556 this.requestedSize = null;
2557 this.onWindowResizeTimeout = null;
2558 this.onWindowResizeHandler = this.onWindowResize.bind( this );
2559 this.afterWindowResizeHandler = this.afterWindowResize.bind( this );
2560 this.onWindowMouseWheelHandler = this.onWindowMouseWheel.bind( this );
2561 this.onDocumentKeyDownHandler = this.onDocumentKeyDown.bind( this );
2562
2563 // Initialization
2564 this.$element
2565 .addClass( 'oo-ui-windowManager' )
2566 .toggleClass( 'oo-ui-windowManager-modal', this.modal );
2567 };
2568
2569 /* Setup */
2570
2571 OO.inheritClass( OO.ui.WindowManager, OO.ui.Element );
2572 OO.mixinClass( OO.ui.WindowManager, OO.EventEmitter );
2573
2574 /* Events */
2575
2576 /**
2577 * Window is opening.
2578 *
2579 * Fired when the window begins to be opened.
2580 *
2581 * @event opening
2582 * @param {OO.ui.Window} win Window that's being opened
2583 * @param {jQuery.Promise} opening Promise resolved when window is opened; when the promise is
2584 * resolved the first argument will be a promise which will be resolved when the window begins
2585 * closing, the second argument will be the opening data; progress notifications will be fired on
2586 * the promise for `setup` and `ready` when those processes are completed respectively.
2587 * @param {Object} data Window opening data
2588 */
2589
2590 /**
2591 * Window is closing.
2592 *
2593 * Fired when the window begins to be closed.
2594 *
2595 * @event closing
2596 * @param {OO.ui.Window} win Window that's being closed
2597 * @param {jQuery.Promise} opening Promise resolved when window is closed; when the promise
2598 * is resolved the first argument will be a the closing data; progress notifications will be fired
2599 * on the promise for `hold` and `teardown` when those processes are completed respectively.
2600 * @param {Object} data Window closing data
2601 */
2602
2603 /**
2604 * Window was resized.
2605 *
2606 * @event resize
2607 * @param {OO.ui.Window} win Window that was resized
2608 */
2609
2610 /* Static Properties */
2611
2612 /**
2613 * Map of symbolic size names and CSS properties.
2614 *
2615 * @static
2616 * @inheritable
2617 * @property {Object}
2618 */
2619 OO.ui.WindowManager.static.sizes = {
2620 small: {
2621 width: 300
2622 },
2623 medium: {
2624 width: 500
2625 },
2626 large: {
2627 width: 700
2628 },
2629 full: {
2630 // These can be non-numeric because they are never used in calculations
2631 width: '100%',
2632 height: '100%'
2633 }
2634 };
2635
2636 /**
2637 * Symbolic name of default size.
2638 *
2639 * Default size is used if the window's requested size is not recognized.
2640 *
2641 * @static
2642 * @inheritable
2643 * @property {string}
2644 */
2645 OO.ui.WindowManager.static.defaultSize = 'medium';
2646
2647 /* Methods */
2648
2649 /**
2650 * Handle window resize events.
2651 *
2652 * @param {jQuery.Event} e Window resize event
2653 */
2654 OO.ui.WindowManager.prototype.onWindowResize = function () {
2655 clearTimeout( this.onWindowResizeTimeout );
2656 this.onWindowResizeTimeout = setTimeout( this.afterWindowResizeHandler, 200 );
2657 };
2658
2659 /**
2660 * Handle window resize events.
2661 *
2662 * @param {jQuery.Event} e Window resize event
2663 */
2664 OO.ui.WindowManager.prototype.afterWindowResize = function () {
2665 if ( this.currentWindow ) {
2666 this.updateWindowSize( this.currentWindow );
2667 }
2668 };
2669
2670 /**
2671 * Handle window mouse wheel events.
2672 *
2673 * @param {jQuery.Event} e Mouse wheel event
2674 */
2675 OO.ui.WindowManager.prototype.onWindowMouseWheel = function ( e ) {
2676 // Kill all events in the parent window if the child window is isolated,
2677 // or if the event didn't come from the child window
2678 return !( this.shouldIsolate() || !$.contains( this.getCurrentWindow().$frame[0], e.target ) );
2679 };
2680
2681 /**
2682 * Handle document key down events.
2683 *
2684 * @param {jQuery.Event} e Key down event
2685 */
2686 OO.ui.WindowManager.prototype.onDocumentKeyDown = function ( e ) {
2687 switch ( e.which ) {
2688 case OO.ui.Keys.PAGEUP:
2689 case OO.ui.Keys.PAGEDOWN:
2690 case OO.ui.Keys.END:
2691 case OO.ui.Keys.HOME:
2692 case OO.ui.Keys.LEFT:
2693 case OO.ui.Keys.UP:
2694 case OO.ui.Keys.RIGHT:
2695 case OO.ui.Keys.DOWN:
2696 // Kill all events in the parent window if the child window is isolated,
2697 // or if the event didn't come from the child window
2698 return !( this.shouldIsolate() || !$.contains( this.getCurrentWindow().$frame[0], e.target ) );
2699 }
2700 };
2701
2702 /**
2703 * Check if window is opening.
2704 *
2705 * @return {boolean} Window is opening
2706 */
2707 OO.ui.WindowManager.prototype.isOpening = function ( win ) {
2708 return win === this.currentWindow && !!this.opening && this.opening.state() === 'pending';
2709 };
2710
2711 /**
2712 * Check if window is closing.
2713 *
2714 * @return {boolean} Window is closing
2715 */
2716 OO.ui.WindowManager.prototype.isClosing = function ( win ) {
2717 return win === this.currentWindow && !!this.closing && this.closing.state() === 'pending';
2718 };
2719
2720 /**
2721 * Check if window is opened.
2722 *
2723 * @return {boolean} Window is opened
2724 */
2725 OO.ui.WindowManager.prototype.isOpened = function ( win ) {
2726 return win === this.currentWindow && !!this.opened && this.opened.state() === 'pending';
2727 };
2728
2729 /**
2730 * Check if window contents should be isolated.
2731 *
2732 * Window content isolation is done using inline frames.
2733 *
2734 * @return {boolean} Window contents should be isolated
2735 */
2736 OO.ui.WindowManager.prototype.shouldIsolate = function () {
2737 return this.isolate;
2738 };
2739
2740 /**
2741 * Check if a window is being managed.
2742 *
2743 * @param {OO.ui.Window} win Window to check
2744 * @return {boolean} Window is being managed
2745 */
2746 OO.ui.WindowManager.prototype.hasWindow = function ( win ) {
2747 var name;
2748
2749 for ( name in this.windows ) {
2750 if ( this.windows[name] === win ) {
2751 return true;
2752 }
2753 }
2754
2755 return false;
2756 };
2757
2758 /**
2759 * Get the number of milliseconds to wait between beginning opening and executing setup process.
2760 *
2761 * @param {OO.ui.Window} win Window being opened
2762 * @param {Object} [data] Window opening data
2763 * @return {number} Milliseconds to wait
2764 */
2765 OO.ui.WindowManager.prototype.getSetupDelay = function () {
2766 return 0;
2767 };
2768
2769 /**
2770 * Get the number of milliseconds to wait between finishing setup and executing ready process.
2771 *
2772 * @param {OO.ui.Window} win Window being opened
2773 * @param {Object} [data] Window opening data
2774 * @return {number} Milliseconds to wait
2775 */
2776 OO.ui.WindowManager.prototype.getReadyDelay = function () {
2777 return 0;
2778 };
2779
2780 /**
2781 * Get the number of milliseconds to wait between beginning closing and executing hold process.
2782 *
2783 * @param {OO.ui.Window} win Window being closed
2784 * @param {Object} [data] Window closing data
2785 * @return {number} Milliseconds to wait
2786 */
2787 OO.ui.WindowManager.prototype.getHoldDelay = function () {
2788 return 0;
2789 };
2790
2791 /**
2792 * Get the number of milliseconds to wait between finishing hold and executing teardown process.
2793 *
2794 * @param {OO.ui.Window} win Window being closed
2795 * @param {Object} [data] Window closing data
2796 * @return {number} Milliseconds to wait
2797 */
2798 OO.ui.WindowManager.prototype.getTeardownDelay = function () {
2799 return this.modal ? 250 : 0;
2800 };
2801
2802 /**
2803 * Get managed window by symbolic name.
2804 *
2805 * If window is not yet instantiated, it will be instantiated and added automatically.
2806 *
2807 * @param {string} name Symbolic window name
2808 * @return {jQuery.Promise} Promise resolved with matching window, or rejected with an OO.ui.Error
2809 * @throws {Error} If the symbolic name is unrecognized by the factory
2810 * @throws {Error} If the symbolic name unrecognized as a managed window
2811 */
2812 OO.ui.WindowManager.prototype.getWindow = function ( name ) {
2813 var deferred = $.Deferred(),
2814 win = this.windows[name];
2815
2816 if ( !( win instanceof OO.ui.Window ) ) {
2817 if ( this.factory ) {
2818 if ( !this.factory.lookup( name ) ) {
2819 deferred.reject( new OO.ui.Error(
2820 'Cannot auto-instantiate window: symbolic name is unrecognized by the factory'
2821 ) );
2822 } else {
2823 win = this.factory.create( name, this, { $: this.$ } );
2824 this.addWindows( [ win ] );
2825 deferred.resolve( win );
2826 }
2827 } else {
2828 deferred.reject( new OO.ui.Error(
2829 'Cannot get unmanaged window: symbolic name unrecognized as a managed window'
2830 ) );
2831 }
2832 } else {
2833 deferred.resolve( win );
2834 }
2835
2836 return deferred.promise();
2837 };
2838
2839 /**
2840 * Get current window.
2841 *
2842 * @return {OO.ui.Window|null} Currently opening/opened/closing window
2843 */
2844 OO.ui.WindowManager.prototype.getCurrentWindow = function () {
2845 return this.currentWindow;
2846 };
2847
2848 /**
2849 * Open a window.
2850 *
2851 * @param {OO.ui.Window|string} win Window object or symbolic name of window to open
2852 * @param {Object} [data] Window opening data
2853 * @return {jQuery.Promise} Promise resolved when window is done opening; see {@link #event-opening}
2854 * for more details about the `opening` promise
2855 * @fires opening
2856 */
2857 OO.ui.WindowManager.prototype.openWindow = function ( win, data ) {
2858 var manager = this,
2859 preparing = [],
2860 opening = $.Deferred();
2861
2862 // Argument handling
2863 if ( typeof win === 'string' ) {
2864 return this.getWindow( win ).then( function ( win ) {
2865 return manager.openWindow( win, data );
2866 } );
2867 }
2868
2869 // Error handling
2870 if ( !this.hasWindow( win ) ) {
2871 opening.reject( new OO.ui.Error(
2872 'Cannot open window: window is not attached to manager'
2873 ) );
2874 } else if ( this.preparingToOpen || this.opening || this.opened ) {
2875 opening.reject( new OO.ui.Error(
2876 'Cannot open window: another window is opening or open'
2877 ) );
2878 }
2879
2880 // Window opening
2881 if ( opening.state() !== 'rejected' ) {
2882 if ( !win.getManager() ) {
2883 win.setManager( this );
2884 }
2885 preparing.push( win.load() );
2886
2887 if ( this.closing ) {
2888 // If a window is currently closing, wait for it to complete
2889 preparing.push( this.closing );
2890 }
2891
2892 this.preparingToOpen = $.when.apply( $, preparing );
2893 // Ensure handlers get called after preparingToOpen is set
2894 this.preparingToOpen.done( function () {
2895 if ( manager.modal ) {
2896 manager.toggleGlobalEvents( true );
2897 manager.toggleAriaIsolation( true );
2898 }
2899 manager.currentWindow = win;
2900 manager.opening = opening;
2901 manager.preparingToOpen = null;
2902 manager.emit( 'opening', win, opening, data );
2903 setTimeout( function () {
2904 win.setup( data ).then( function () {
2905 manager.updateWindowSize( win );
2906 manager.opening.notify( { state: 'setup' } );
2907 setTimeout( function () {
2908 win.ready( data ).then( function () {
2909 manager.opening.notify( { state: 'ready' } );
2910 manager.opening = null;
2911 manager.opened = $.Deferred();
2912 opening.resolve( manager.opened.promise(), data );
2913 } );
2914 }, manager.getReadyDelay() );
2915 } );
2916 }, manager.getSetupDelay() );
2917 } );
2918 }
2919
2920 return opening.promise();
2921 };
2922
2923 /**
2924 * Close a window.
2925 *
2926 * @param {OO.ui.Window|string} win Window object or symbolic name of window to close
2927 * @param {Object} [data] Window closing data
2928 * @return {jQuery.Promise} Promise resolved when window is done closing; see {@link #event-closing}
2929 * for more details about the `closing` promise
2930 * @throws {Error} If no window by that name is being managed
2931 * @fires closing
2932 */
2933 OO.ui.WindowManager.prototype.closeWindow = function ( win, data ) {
2934 var manager = this,
2935 preparing = [],
2936 closing = $.Deferred(),
2937 opened;
2938
2939 // Argument handling
2940 if ( typeof win === 'string' ) {
2941 win = this.windows[win];
2942 } else if ( !this.hasWindow( win ) ) {
2943 win = null;
2944 }
2945
2946 // Error handling
2947 if ( !win ) {
2948 closing.reject( new OO.ui.Error(
2949 'Cannot close window: window is not attached to manager'
2950 ) );
2951 } else if ( win !== this.currentWindow ) {
2952 closing.reject( new OO.ui.Error(
2953 'Cannot close window: window already closed with different data'
2954 ) );
2955 } else if ( this.preparingToClose || this.closing ) {
2956 closing.reject( new OO.ui.Error(
2957 'Cannot close window: window already closing with different data'
2958 ) );
2959 }
2960
2961 // Window closing
2962 if ( closing.state() !== 'rejected' ) {
2963 if ( this.opening ) {
2964 // If the window is currently opening, close it when it's done
2965 preparing.push( this.opening );
2966 }
2967
2968 this.preparingToClose = $.when.apply( $, preparing );
2969 // Ensure handlers get called after preparingToClose is set
2970 this.preparingToClose.done( function () {
2971 manager.closing = closing;
2972 manager.preparingToClose = null;
2973 manager.emit( 'closing', win, closing, data );
2974 opened = manager.opened;
2975 manager.opened = null;
2976 opened.resolve( closing.promise(), data );
2977 setTimeout( function () {
2978 win.hold( data ).then( function () {
2979 closing.notify( { state: 'hold' } );
2980 setTimeout( function () {
2981 win.teardown( data ).then( function () {
2982 closing.notify( { state: 'teardown' } );
2983 if ( manager.modal ) {
2984 manager.toggleGlobalEvents( false );
2985 manager.toggleAriaIsolation( false );
2986 }
2987 manager.closing = null;
2988 manager.currentWindow = null;
2989 closing.resolve( data );
2990 } );
2991 }, manager.getTeardownDelay() );
2992 } );
2993 }, manager.getHoldDelay() );
2994 } );
2995 }
2996
2997 return closing.promise();
2998 };
2999
3000 /**
3001 * Add windows.
3002 *
3003 * @param {Object.<string,OO.ui.Window>|OO.ui.Window[]} windows Windows to add
3004 * @throws {Error} If one of the windows being added without an explicit symbolic name does not have
3005 * a statically configured symbolic name
3006 */
3007 OO.ui.WindowManager.prototype.addWindows = function ( windows ) {
3008 var i, len, win, name, list;
3009
3010 if ( $.isArray( windows ) ) {
3011 // Convert to map of windows by looking up symbolic names from static configuration
3012 list = {};
3013 for ( i = 0, len = windows.length; i < len; i++ ) {
3014 name = windows[i].constructor.static.name;
3015 if ( typeof name !== 'string' ) {
3016 throw new Error( 'Cannot add window' );
3017 }
3018 list[name] = windows[i];
3019 }
3020 } else if ( $.isPlainObject( windows ) ) {
3021 list = windows;
3022 }
3023
3024 // Add windows
3025 for ( name in list ) {
3026 win = list[name];
3027 this.windows[name] = win;
3028 this.$element.append( win.$element );
3029 }
3030 };
3031
3032 /**
3033 * Remove windows.
3034 *
3035 * Windows will be closed before they are removed.
3036 *
3037 * @param {string} name Symbolic name of window to remove
3038 * @return {jQuery.Promise} Promise resolved when window is closed and removed
3039 * @throws {Error} If windows being removed are not being managed
3040 */
3041 OO.ui.WindowManager.prototype.removeWindows = function ( names ) {
3042 var i, len, win, name,
3043 manager = this,
3044 promises = [],
3045 cleanup = function ( name, win ) {
3046 delete manager.windows[name];
3047 win.$element.detach();
3048 };
3049
3050 for ( i = 0, len = names.length; i < len; i++ ) {
3051 name = names[i];
3052 win = this.windows[name];
3053 if ( !win ) {
3054 throw new Error( 'Cannot remove window' );
3055 }
3056 promises.push( this.closeWindow( name ).then( cleanup.bind( null, name, win ) ) );
3057 }
3058
3059 return $.when.apply( $, promises );
3060 };
3061
3062 /**
3063 * Remove all windows.
3064 *
3065 * Windows will be closed before they are removed.
3066 *
3067 * @return {jQuery.Promise} Promise resolved when all windows are closed and removed
3068 */
3069 OO.ui.WindowManager.prototype.clearWindows = function () {
3070 return this.removeWindows( Object.keys( this.windows ) );
3071 };
3072
3073 /**
3074 * Set dialog size.
3075 *
3076 * Fullscreen mode will be used if the dialog is too wide to fit in the screen.
3077 *
3078 * @chainable
3079 */
3080 OO.ui.WindowManager.prototype.updateWindowSize = function ( win ) {
3081 // Bypass for non-current, and thus invisible, windows
3082 if ( win !== this.currentWindow ) {
3083 return;
3084 }
3085
3086 var viewport = OO.ui.Element.getDimensions( win.getElementWindow() ),
3087 sizes = this.constructor.static.sizes,
3088 size = win.getSize();
3089
3090 if ( !sizes[size] ) {
3091 size = this.constructor.static.defaultSize;
3092 }
3093 if ( size !== 'full' && viewport.rect.right - viewport.rect.left < sizes[size].width ) {
3094 size = 'full';
3095 }
3096
3097 this.$element.toggleClass( 'oo-ui-windowManager-fullscreen', size === 'full' );
3098 this.$element.toggleClass( 'oo-ui-windowManager-floating', size !== 'full' );
3099 win.setDimensions( sizes[size] );
3100
3101 this.emit( 'resize', win );
3102
3103 return this;
3104 };
3105
3106 /**
3107 * Bind or unbind global events for scrolling.
3108 *
3109 * @param {boolean} [on] Bind global events
3110 * @chainable
3111 */
3112 OO.ui.WindowManager.prototype.toggleGlobalEvents = function ( on ) {
3113 on = on === undefined ? !!this.globalEvents : !!on;
3114
3115 if ( on ) {
3116 if ( !this.globalEvents ) {
3117 this.$( this.getElementDocument() ).on( {
3118 // Prevent scrolling by keys in top-level window
3119 keydown: this.onDocumentKeyDownHandler
3120 } );
3121 this.$( this.getElementWindow() ).on( {
3122 // Prevent scrolling by wheel in top-level window
3123 mousewheel: this.onWindowMouseWheelHandler,
3124 // Start listening for top-level window dimension changes
3125 'orientationchange resize': this.onWindowResizeHandler
3126 } );
3127 this.globalEvents = true;
3128 }
3129 } else if ( this.globalEvents ) {
3130 // Unbind global events
3131 this.$( this.getElementDocument() ).off( {
3132 // Allow scrolling by keys in top-level window
3133 keydown: this.onDocumentKeyDownHandler
3134 } );
3135 this.$( this.getElementWindow() ).off( {
3136 // Allow scrolling by wheel in top-level window
3137 mousewheel: this.onWindowMouseWheelHandler,
3138 // Stop listening for top-level window dimension changes
3139 'orientationchange resize': this.onWindowResizeHandler
3140 } );
3141 this.globalEvents = false;
3142 }
3143
3144 return this;
3145 };
3146
3147 /**
3148 * Toggle screen reader visibility of content other than the window manager.
3149 *
3150 * @param {boolean} [isolate] Make only the window manager visible to screen readers
3151 * @chainable
3152 */
3153 OO.ui.WindowManager.prototype.toggleAriaIsolation = function ( isolate ) {
3154 isolate = isolate === undefined ? !this.$ariaHidden : !!isolate;
3155
3156 if ( isolate ) {
3157 if ( !this.$ariaHidden ) {
3158 // Hide everything other than the window manager from screen readers
3159 this.$ariaHidden = $( 'body' )
3160 .children()
3161 .not( this.$element.parentsUntil( 'body' ).last() )
3162 .attr( 'aria-hidden', '' );
3163 }
3164 } else if ( this.$ariaHidden ) {
3165 // Restore screen reader visiblity
3166 this.$ariaHidden.removeAttr( 'aria-hidden' );
3167 this.$ariaHidden = null;
3168 }
3169
3170 return this;
3171 };
3172
3173 /**
3174 * Destroy window manager.
3175 *
3176 * Windows will not be closed, only removed from the DOM.
3177 */
3178 OO.ui.WindowManager.prototype.destroy = function () {
3179 this.toggleGlobalEvents( false );
3180 this.toggleAriaIsolation( false );
3181 this.$element.remove();
3182 };
3183
3184 /**
3185 * @abstract
3186 * @class
3187 *
3188 * @constructor
3189 * @param {string|jQuery} message Description of error
3190 * @param {Object} [config] Configuration options
3191 * @cfg {boolean} [recoverable=true] Error is recoverable
3192 * @cfg {boolean} [warning=false] Whether this error is a warning or not.
3193 */
3194 OO.ui.Error = function OoUiElement( message, config ) {
3195 // Configuration initialization
3196 config = config || {};
3197
3198 // Properties
3199 this.message = message instanceof jQuery ? message : String( message );
3200 this.recoverable = config.recoverable === undefined || !!config.recoverable;
3201 this.warning = !!config.warning;
3202 };
3203
3204 /* Setup */
3205
3206 OO.initClass( OO.ui.Error );
3207
3208 /* Methods */
3209
3210 /**
3211 * Check if error can be recovered from.
3212 *
3213 * @return {boolean} Error is recoverable
3214 */
3215 OO.ui.Error.prototype.isRecoverable = function () {
3216 return this.recoverable;
3217 };
3218
3219 /**
3220 * Check if the error is a warning
3221 *
3222 * @return {boolean} Error is warning
3223 */
3224 OO.ui.Error.prototype.isWarning = function () {
3225 return this.warning;
3226 };
3227
3228 /**
3229 * Get error message as DOM nodes.
3230 *
3231 * @return {jQuery} Error message in DOM nodes
3232 */
3233 OO.ui.Error.prototype.getMessage = function () {
3234 return this.message instanceof jQuery ?
3235 this.message.clone() :
3236 $( '<div>' ).text( this.message ).contents();
3237 };
3238
3239 /**
3240 * Get error message as text.
3241 *
3242 * @return {string} Error message
3243 */
3244 OO.ui.Error.prototype.getMessageText = function () {
3245 return this.message instanceof jQuery ? this.message.text() : this.message;
3246 };
3247
3248 /**
3249 * A list of functions, called in sequence.
3250 *
3251 * If a function added to a process returns boolean false the process will stop; if it returns an
3252 * object with a `promise` method the process will use the promise to either continue to the next
3253 * step when the promise is resolved or stop when the promise is rejected.
3254 *
3255 * @class
3256 *
3257 * @constructor
3258 * @param {number|jQuery.Promise|Function} step Time to wait, promise to wait for or function to
3259 * call, see #createStep for more information
3260 * @param {Object} [context=null] Context to call the step function in, ignored if step is a number
3261 * or a promise
3262 * @return {Object} Step object, with `callback` and `context` properties
3263 */
3264 OO.ui.Process = function ( step, context ) {
3265 // Properties
3266 this.steps = [];
3267
3268 // Initialization
3269 if ( step !== undefined ) {
3270 this.next( step, context );
3271 }
3272 };
3273
3274 /* Setup */
3275
3276 OO.initClass( OO.ui.Process );
3277
3278 /* Methods */
3279
3280 /**
3281 * Start the process.
3282 *
3283 * @return {jQuery.Promise} Promise that is resolved when all steps have completed or rejected when
3284 * any of the steps return boolean false or a promise which gets rejected; upon stopping the
3285 * process, the remaining steps will not be taken
3286 */
3287 OO.ui.Process.prototype.execute = function () {
3288 var i, len, promise;
3289
3290 /**
3291 * Continue execution.
3292 *
3293 * @ignore
3294 * @param {Array} step A function and the context it should be called in
3295 * @return {Function} Function that continues the process
3296 */
3297 function proceed( step ) {
3298 return function () {
3299 // Execute step in the correct context
3300 var deferred,
3301 result = step.callback.call( step.context );
3302
3303 if ( result === false ) {
3304 // Use rejected promise for boolean false results
3305 return $.Deferred().reject( [] ).promise();
3306 }
3307 if ( typeof result === 'number' ) {
3308 if ( result < 0 ) {
3309 throw new Error( 'Cannot go back in time: flux capacitor is out of service' );
3310 }
3311 // Use a delayed promise for numbers, expecting them to be in milliseconds
3312 deferred = $.Deferred();
3313 setTimeout( deferred.resolve, result );
3314 return deferred.promise();
3315 }
3316 if ( result instanceof OO.ui.Error ) {
3317 // Use rejected promise for error
3318 return $.Deferred().reject( [ result ] ).promise();
3319 }
3320 if ( $.isArray( result ) && result.length && result[0] instanceof OO.ui.Error ) {
3321 // Use rejected promise for list of errors
3322 return $.Deferred().reject( result ).promise();
3323 }
3324 // Duck-type the object to see if it can produce a promise
3325 if ( result && $.isFunction( result.promise ) ) {
3326 // Use a promise generated from the result
3327 return result.promise();
3328 }
3329 // Use resolved promise for other results
3330 return $.Deferred().resolve().promise();
3331 };
3332 }
3333
3334 if ( this.steps.length ) {
3335 // Generate a chain reaction of promises
3336 promise = proceed( this.steps[0] )();
3337 for ( i = 1, len = this.steps.length; i < len; i++ ) {
3338 promise = promise.then( proceed( this.steps[i] ) );
3339 }
3340 } else {
3341 promise = $.Deferred().resolve().promise();
3342 }
3343
3344 return promise;
3345 };
3346
3347 /**
3348 * Create a process step.
3349 *
3350 * @private
3351 * @param {number|jQuery.Promise|Function} step
3352 *
3353 * - Number of milliseconds to wait; or
3354 * - Promise to wait to be resolved; or
3355 * - Function to execute
3356 * - If it returns boolean false the process will stop
3357 * - If it returns an object with a `promise` method the process will use the promise to either
3358 * continue to the next step when the promise is resolved or stop when the promise is rejected
3359 * - If it returns a number, the process will wait for that number of milliseconds before
3360 * proceeding
3361 * @param {Object} [context=null] Context to call the step function in, ignored if step is a number
3362 * or a promise
3363 * @return {Object} Step object, with `callback` and `context` properties
3364 */
3365 OO.ui.Process.prototype.createStep = function ( step, context ) {
3366 if ( typeof step === 'number' || $.isFunction( step.promise ) ) {
3367 return {
3368 callback: function () {
3369 return step;
3370 },
3371 context: null
3372 };
3373 }
3374 if ( $.isFunction( step ) ) {
3375 return {
3376 callback: step,
3377 context: context
3378 };
3379 }
3380 throw new Error( 'Cannot create process step: number, promise or function expected' );
3381 };
3382
3383 /**
3384 * Add step to the beginning of the process.
3385 *
3386 * @inheritdoc #createStep
3387 * @return {OO.ui.Process} this
3388 * @chainable
3389 */
3390 OO.ui.Process.prototype.first = function ( step, context ) {
3391 this.steps.unshift( this.createStep( step, context ) );
3392 return this;
3393 };
3394
3395 /**
3396 * Add step to the end of the process.
3397 *
3398 * @inheritdoc #createStep
3399 * @return {OO.ui.Process} this
3400 * @chainable
3401 */
3402 OO.ui.Process.prototype.next = function ( step, context ) {
3403 this.steps.push( this.createStep( step, context ) );
3404 return this;
3405 };
3406
3407 /**
3408 * Factory for tools.
3409 *
3410 * @class
3411 * @extends OO.Factory
3412 * @constructor
3413 */
3414 OO.ui.ToolFactory = function OoUiToolFactory() {
3415 // Parent constructor
3416 OO.ui.ToolFactory.super.call( this );
3417 };
3418
3419 /* Setup */
3420
3421 OO.inheritClass( OO.ui.ToolFactory, OO.Factory );
3422
3423 /* Methods */
3424
3425 /** */
3426 OO.ui.ToolFactory.prototype.getTools = function ( include, exclude, promote, demote ) {
3427 var i, len, included, promoted, demoted,
3428 auto = [],
3429 used = {};
3430
3431 // Collect included and not excluded tools
3432 included = OO.simpleArrayDifference( this.extract( include ), this.extract( exclude ) );
3433
3434 // Promotion
3435 promoted = this.extract( promote, used );
3436 demoted = this.extract( demote, used );
3437
3438 // Auto
3439 for ( i = 0, len = included.length; i < len; i++ ) {
3440 if ( !used[included[i]] ) {
3441 auto.push( included[i] );
3442 }
3443 }
3444
3445 return promoted.concat( auto ).concat( demoted );
3446 };
3447
3448 /**
3449 * Get a flat list of names from a list of names or groups.
3450 *
3451 * Tools can be specified in the following ways:
3452 *
3453 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
3454 * - All tools in a group: `{ group: 'group-name' }`
3455 * - All tools: `'*'`
3456 *
3457 * @private
3458 * @param {Array|string} collection List of tools
3459 * @param {Object} [used] Object with names that should be skipped as properties; extracted
3460 * names will be added as properties
3461 * @return {string[]} List of extracted names
3462 */
3463 OO.ui.ToolFactory.prototype.extract = function ( collection, used ) {
3464 var i, len, item, name, tool,
3465 names = [];
3466
3467 if ( collection === '*' ) {
3468 for ( name in this.registry ) {
3469 tool = this.registry[name];
3470 if (
3471 // Only add tools by group name when auto-add is enabled
3472 tool.static.autoAddToCatchall &&
3473 // Exclude already used tools
3474 ( !used || !used[name] )
3475 ) {
3476 names.push( name );
3477 if ( used ) {
3478 used[name] = true;
3479 }
3480 }
3481 }
3482 } else if ( $.isArray( collection ) ) {
3483 for ( i = 0, len = collection.length; i < len; i++ ) {
3484 item = collection[i];
3485 // Allow plain strings as shorthand for named tools
3486 if ( typeof item === 'string' ) {
3487 item = { name: item };
3488 }
3489 if ( OO.isPlainObject( item ) ) {
3490 if ( item.group ) {
3491 for ( name in this.registry ) {
3492 tool = this.registry[name];
3493 if (
3494 // Include tools with matching group
3495 tool.static.group === item.group &&
3496 // Only add tools by group name when auto-add is enabled
3497 tool.static.autoAddToGroup &&
3498 // Exclude already used tools
3499 ( !used || !used[name] )
3500 ) {
3501 names.push( name );
3502 if ( used ) {
3503 used[name] = true;
3504 }
3505 }
3506 }
3507 // Include tools with matching name and exclude already used tools
3508 } else if ( item.name && ( !used || !used[item.name] ) ) {
3509 names.push( item.name );
3510 if ( used ) {
3511 used[item.name] = true;
3512 }
3513 }
3514 }
3515 }
3516 }
3517 return names;
3518 };
3519
3520 /**
3521 * Factory for tool groups.
3522 *
3523 * @class
3524 * @extends OO.Factory
3525 * @constructor
3526 */
3527 OO.ui.ToolGroupFactory = function OoUiToolGroupFactory() {
3528 // Parent constructor
3529 OO.Factory.call( this );
3530
3531 var i, l,
3532 defaultClasses = this.constructor.static.getDefaultClasses();
3533
3534 // Register default toolgroups
3535 for ( i = 0, l = defaultClasses.length; i < l; i++ ) {
3536 this.register( defaultClasses[i] );
3537 }
3538 };
3539
3540 /* Setup */
3541
3542 OO.inheritClass( OO.ui.ToolGroupFactory, OO.Factory );
3543
3544 /* Static Methods */
3545
3546 /**
3547 * Get a default set of classes to be registered on construction
3548 *
3549 * @return {Function[]} Default classes
3550 */
3551 OO.ui.ToolGroupFactory.static.getDefaultClasses = function () {
3552 return [
3553 OO.ui.BarToolGroup,
3554 OO.ui.ListToolGroup,
3555 OO.ui.MenuToolGroup
3556 ];
3557 };
3558
3559 /**
3560 * Theme logic.
3561 *
3562 * @abstract
3563 * @class
3564 *
3565 * @constructor
3566 * @param {Object} [config] Configuration options
3567 */
3568 OO.ui.Theme = function OoUiTheme( config ) {
3569 // Configuration initialization
3570 config = config || {};
3571 };
3572
3573 /* Setup */
3574
3575 OO.initClass( OO.ui.Theme );
3576
3577 /* Methods */
3578
3579 /**
3580 * Get a list of classes to be applied to a widget.
3581 *
3582 * The 'on' and 'off' lists combined MUST contain keys for all classes the theme adds or removes,
3583 * otherwise state transitions will not work properly.
3584 *
3585 * @param {OO.ui.Element} element Element for which to get classes
3586 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
3587 */
3588 OO.ui.Theme.prototype.getElementClasses = function ( /* element */ ) {
3589 return { on: [], off: [] };
3590 };
3591
3592 /**
3593 * Update CSS classes provided by the theme.
3594 *
3595 * For elements with theme logic hooks, this should be called anytime there's a state change.
3596 *
3597 * @param {OO.ui.Element} element Element for which to update classes
3598 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
3599 */
3600 OO.ui.Theme.prototype.updateElementClasses = function ( element ) {
3601 var classes = this.getElementClasses( element );
3602
3603 element.$element
3604 .removeClass( classes.off.join( ' ' ) )
3605 .addClass( classes.on.join( ' ' ) );
3606 };
3607
3608 /**
3609 * Element with a button.
3610 *
3611 * Buttons are used for controls which can be clicked. They can be configured to use tab indexing
3612 * and access keys for accessibility purposes.
3613 *
3614 * @abstract
3615 * @class
3616 *
3617 * @constructor
3618 * @param {Object} [config] Configuration options
3619 * @cfg {jQuery} [$button] Button node, assigned to #$button, omit to use a generated `<a>`
3620 * @cfg {boolean} [framed=true] Render button with a frame
3621 * @cfg {number} [tabIndex=0] Button's tab index. Use 0 to use default ordering, use -1 to prevent
3622 * tab focusing.
3623 * @cfg {string} [accessKey] Button's access key
3624 */
3625 OO.ui.ButtonElement = function OoUiButtonElement( config ) {
3626 // Configuration initialization
3627 config = config || {};
3628
3629 // Properties
3630 this.$button = null;
3631 this.framed = null;
3632 this.tabIndex = null;
3633 this.accessKey = null;
3634 this.active = false;
3635 this.onMouseUpHandler = this.onMouseUp.bind( this );
3636 this.onMouseDownHandler = this.onMouseDown.bind( this );
3637
3638 // Initialization
3639 this.$element.addClass( 'oo-ui-buttonElement' );
3640 this.toggleFramed( config.framed === undefined || config.framed );
3641 this.setTabIndex( config.tabIndex || 0 );
3642 this.setAccessKey( config.accessKey );
3643 this.setButtonElement( config.$button || this.$( '<a>' ) );
3644 };
3645
3646 /* Setup */
3647
3648 OO.initClass( OO.ui.ButtonElement );
3649
3650 /* Static Properties */
3651
3652 /**
3653 * Cancel mouse down events.
3654 *
3655 * @static
3656 * @inheritable
3657 * @property {boolean}
3658 */
3659 OO.ui.ButtonElement.static.cancelButtonMouseDownEvents = true;
3660
3661 /* Methods */
3662
3663 /**
3664 * Set the button element.
3665 *
3666 * If an element is already set, it will be cleaned up before setting up the new element.
3667 *
3668 * @param {jQuery} $button Element to use as button
3669 */
3670 OO.ui.ButtonElement.prototype.setButtonElement = function ( $button ) {
3671 if ( this.$button ) {
3672 this.$button
3673 .removeClass( 'oo-ui-buttonElement-button' )
3674 .removeAttr( 'role accesskey tabindex' )
3675 .off( this.onMouseDownHandler );
3676 }
3677
3678 this.$button = $button
3679 .addClass( 'oo-ui-buttonElement-button' )
3680 .attr( { role: 'button', accesskey: this.accessKey, tabindex: this.tabIndex } )
3681 .on( 'mousedown', this.onMouseDownHandler );
3682 };
3683
3684 /**
3685 * Handles mouse down events.
3686 *
3687 * @param {jQuery.Event} e Mouse down event
3688 */
3689 OO.ui.ButtonElement.prototype.onMouseDown = function ( e ) {
3690 if ( this.isDisabled() || e.which !== 1 ) {
3691 return false;
3692 }
3693 // Remove the tab-index while the button is down to prevent the button from stealing focus
3694 this.$button.removeAttr( 'tabindex' );
3695 this.$element.addClass( 'oo-ui-buttonElement-pressed' );
3696 // Run the mouseup handler no matter where the mouse is when the button is let go, so we can
3697 // reliably reapply the tabindex and remove the pressed class
3698 this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler, true );
3699 // Prevent change of focus unless specifically configured otherwise
3700 if ( this.constructor.static.cancelButtonMouseDownEvents ) {
3701 return false;
3702 }
3703 };
3704
3705 /**
3706 * Handles mouse up events.
3707 *
3708 * @param {jQuery.Event} e Mouse up event
3709 */
3710 OO.ui.ButtonElement.prototype.onMouseUp = function ( e ) {
3711 if ( this.isDisabled() || e.which !== 1 ) {
3712 return false;
3713 }
3714 // Restore the tab-index after the button is up to restore the button's accesssibility
3715 this.$button.attr( 'tabindex', this.tabIndex );
3716 this.$element.removeClass( 'oo-ui-buttonElement-pressed' );
3717 // Stop listening for mouseup, since we only needed this once
3718 this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler, true );
3719 };
3720
3721 /**
3722 * Check if button has a frame.
3723 *
3724 * @return {boolean} Button is framed
3725 */
3726 OO.ui.ButtonElement.prototype.isFramed = function () {
3727 return this.framed;
3728 };
3729
3730 /**
3731 * Toggle frame.
3732 *
3733 * @param {boolean} [framed] Make button framed, omit to toggle
3734 * @chainable
3735 */
3736 OO.ui.ButtonElement.prototype.toggleFramed = function ( framed ) {
3737 framed = framed === undefined ? !this.framed : !!framed;
3738 if ( framed !== this.framed ) {
3739 this.framed = framed;
3740 this.$element
3741 .toggleClass( 'oo-ui-buttonElement-frameless', !framed )
3742 .toggleClass( 'oo-ui-buttonElement-framed', framed );
3743 this.updateThemeClasses();
3744 }
3745
3746 return this;
3747 };
3748
3749 /**
3750 * Set tab index.
3751 *
3752 * @param {number|null} tabIndex Button's tab index, use null to remove
3753 * @chainable
3754 */
3755 OO.ui.ButtonElement.prototype.setTabIndex = function ( tabIndex ) {
3756 tabIndex = typeof tabIndex === 'number' && tabIndex >= 0 ? tabIndex : null;
3757
3758 if ( this.tabIndex !== tabIndex ) {
3759 if ( this.$button ) {
3760 if ( tabIndex !== null ) {
3761 this.$button.attr( 'tabindex', tabIndex );
3762 } else {
3763 this.$button.removeAttr( 'tabindex' );
3764 }
3765 }
3766 this.tabIndex = tabIndex;
3767 }
3768
3769 return this;
3770 };
3771
3772 /**
3773 * Set access key.
3774 *
3775 * @param {string} accessKey Button's access key, use empty string to remove
3776 * @chainable
3777 */
3778 OO.ui.ButtonElement.prototype.setAccessKey = function ( accessKey ) {
3779 accessKey = typeof accessKey === 'string' && accessKey.length ? accessKey : null;
3780
3781 if ( this.accessKey !== accessKey ) {
3782 if ( this.$button ) {
3783 if ( accessKey !== null ) {
3784 this.$button.attr( 'accesskey', accessKey );
3785 } else {
3786 this.$button.removeAttr( 'accesskey' );
3787 }
3788 }
3789 this.accessKey = accessKey;
3790 }
3791
3792 return this;
3793 };
3794
3795 /**
3796 * Set active state.
3797 *
3798 * @param {boolean} [value] Make button active
3799 * @chainable
3800 */
3801 OO.ui.ButtonElement.prototype.setActive = function ( value ) {
3802 this.$element.toggleClass( 'oo-ui-buttonElement-active', !!value );
3803 return this;
3804 };
3805
3806 /**
3807 * Element containing a sequence of child elements.
3808 *
3809 * @abstract
3810 * @class
3811 *
3812 * @constructor
3813 * @param {Object} [config] Configuration options
3814 * @cfg {jQuery} [$group] Container node, assigned to #$group, omit to use a generated `<div>`
3815 */
3816 OO.ui.GroupElement = function OoUiGroupElement( config ) {
3817 // Configuration intialization
3818 config = config || {};
3819
3820 // Properties
3821 this.$group = null;
3822 this.items = [];
3823 this.aggregateItemEvents = {};
3824
3825 // Initialization
3826 this.setGroupElement( config.$group || this.$( '<div>' ) );
3827 };
3828
3829 /* Methods */
3830
3831 /**
3832 * Set the group element.
3833 *
3834 * If an element is already set, items will be moved to the new element.
3835 *
3836 * @param {jQuery} $group Element to use as group
3837 */
3838 OO.ui.GroupElement.prototype.setGroupElement = function ( $group ) {
3839 var i, len;
3840
3841 this.$group = $group;
3842 for ( i = 0, len = this.items.length; i < len; i++ ) {
3843 this.$group.append( this.items[i].$element );
3844 }
3845 };
3846
3847 /**
3848 * Check if there are no items.
3849 *
3850 * @return {boolean} Group is empty
3851 */
3852 OO.ui.GroupElement.prototype.isEmpty = function () {
3853 return !this.items.length;
3854 };
3855
3856 /**
3857 * Get items.
3858 *
3859 * @return {OO.ui.Element[]} Items
3860 */
3861 OO.ui.GroupElement.prototype.getItems = function () {
3862 return this.items.slice( 0 );
3863 };
3864
3865 /**
3866 * Add an aggregate item event.
3867 *
3868 * Aggregated events are listened to on each item and then emitted by the group under a new name,
3869 * and with an additional leading parameter containing the item that emitted the original event.
3870 * Other arguments that were emitted from the original event are passed through.
3871 *
3872 * @param {Object.<string,string|null>} events Aggregate events emitted by group, keyed by item
3873 * event, use null value to remove aggregation
3874 * @throws {Error} If aggregation already exists
3875 */
3876 OO.ui.GroupElement.prototype.aggregate = function ( events ) {
3877 var i, len, item, add, remove, itemEvent, groupEvent;
3878
3879 for ( itemEvent in events ) {
3880 groupEvent = events[itemEvent];
3881
3882 // Remove existing aggregated event
3883 if ( Object.prototype.hasOwnProperty.call( this.aggregateItemEvents, itemEvent ) ) {
3884 // Don't allow duplicate aggregations
3885 if ( groupEvent ) {
3886 throw new Error( 'Duplicate item event aggregation for ' + itemEvent );
3887 }
3888 // Remove event aggregation from existing items
3889 for ( i = 0, len = this.items.length; i < len; i++ ) {
3890 item = this.items[i];
3891 if ( item.connect && item.disconnect ) {
3892 remove = {};
3893 remove[itemEvent] = [ 'emit', groupEvent, item ];
3894 item.disconnect( this, remove );
3895 }
3896 }
3897 // Prevent future items from aggregating event
3898 delete this.aggregateItemEvents[itemEvent];
3899 }
3900
3901 // Add new aggregate event
3902 if ( groupEvent ) {
3903 // Make future items aggregate event
3904 this.aggregateItemEvents[itemEvent] = groupEvent;
3905 // Add event aggregation to existing items
3906 for ( i = 0, len = this.items.length; i < len; i++ ) {
3907 item = this.items[i];
3908 if ( item.connect && item.disconnect ) {
3909 add = {};
3910 add[itemEvent] = [ 'emit', groupEvent, item ];
3911 item.connect( this, add );
3912 }
3913 }
3914 }
3915 }
3916 };
3917
3918 /**
3919 * Add items.
3920 *
3921 * Adding an existing item will move it.
3922 *
3923 * @param {OO.ui.Element[]} items Items
3924 * @param {number} [index] Index to insert items at
3925 * @chainable
3926 */
3927 OO.ui.GroupElement.prototype.addItems = function ( items, index ) {
3928 var i, len, item, event, events, currentIndex,
3929 itemElements = [];
3930
3931 for ( i = 0, len = items.length; i < len; i++ ) {
3932 item = items[i];
3933
3934 // Check if item exists then remove it first, effectively "moving" it
3935 currentIndex = $.inArray( item, this.items );
3936 if ( currentIndex >= 0 ) {
3937 this.removeItems( [ item ] );
3938 // Adjust index to compensate for removal
3939 if ( currentIndex < index ) {
3940 index--;
3941 }
3942 }
3943 // Add the item
3944 if ( item.connect && item.disconnect && !$.isEmptyObject( this.aggregateItemEvents ) ) {
3945 events = {};
3946 for ( event in this.aggregateItemEvents ) {
3947 events[event] = [ 'emit', this.aggregateItemEvents[event], item ];
3948 }
3949 item.connect( this, events );
3950 }
3951 item.setElementGroup( this );
3952 itemElements.push( item.$element.get( 0 ) );
3953 }
3954
3955 if ( index === undefined || index < 0 || index >= this.items.length ) {
3956 this.$group.append( itemElements );
3957 this.items.push.apply( this.items, items );
3958 } else if ( index === 0 ) {
3959 this.$group.prepend( itemElements );
3960 this.items.unshift.apply( this.items, items );
3961 } else {
3962 this.items[index].$element.before( itemElements );
3963 this.items.splice.apply( this.items, [ index, 0 ].concat( items ) );
3964 }
3965
3966 return this;
3967 };
3968
3969 /**
3970 * Remove items.
3971 *
3972 * Items will be detached, not removed, so they can be used later.
3973 *
3974 * @param {OO.ui.Element[]} items Items to remove
3975 * @chainable
3976 */
3977 OO.ui.GroupElement.prototype.removeItems = function ( items ) {
3978 var i, len, item, index, remove, itemEvent;
3979
3980 // Remove specific items
3981 for ( i = 0, len = items.length; i < len; i++ ) {
3982 item = items[i];
3983 index = $.inArray( item, this.items );
3984 if ( index !== -1 ) {
3985 if (
3986 item.connect && item.disconnect &&
3987 !$.isEmptyObject( this.aggregateItemEvents )
3988 ) {
3989 remove = {};
3990 if ( Object.prototype.hasOwnProperty.call( this.aggregateItemEvents, itemEvent ) ) {
3991 remove[itemEvent] = [ 'emit', this.aggregateItemEvents[itemEvent], item ];
3992 }
3993 item.disconnect( this, remove );
3994 }
3995 item.setElementGroup( null );
3996 this.items.splice( index, 1 );
3997 item.$element.detach();
3998 }
3999 }
4000
4001 return this;
4002 };
4003
4004 /**
4005 * Clear all items.
4006 *
4007 * Items will be detached, not removed, so they can be used later.
4008 *
4009 * @chainable
4010 */
4011 OO.ui.GroupElement.prototype.clearItems = function () {
4012 var i, len, item, remove, itemEvent;
4013
4014 // Remove all items
4015 for ( i = 0, len = this.items.length; i < len; i++ ) {
4016 item = this.items[i];
4017 if (
4018 item.connect && item.disconnect &&
4019 !$.isEmptyObject( this.aggregateItemEvents )
4020 ) {
4021 remove = {};
4022 if ( Object.prototype.hasOwnProperty.call( this.aggregateItemEvents, itemEvent ) ) {
4023 remove[itemEvent] = [ 'emit', this.aggregateItemEvents[itemEvent], item ];
4024 }
4025 item.disconnect( this, remove );
4026 }
4027 item.setElementGroup( null );
4028 item.$element.detach();
4029 }
4030
4031 this.items = [];
4032 return this;
4033 };
4034
4035 /**
4036 * Element containing an icon.
4037 *
4038 * Icons are graphics, about the size of normal text. They can be used to aid the user in locating
4039 * a control or convey information in a more space efficient way. Icons should rarely be used
4040 * without labels; such as in a toolbar where space is at a premium or within a context where the
4041 * meaning is very clear to the user.
4042 *
4043 * @abstract
4044 * @class
4045 *
4046 * @constructor
4047 * @param {Object} [config] Configuration options
4048 * @cfg {jQuery} [$icon] Icon node, assigned to #$icon, omit to use a generated `<span>`
4049 * @cfg {Object|string} [icon=''] Symbolic icon name, or map of icon names keyed by language ID;
4050 * use the 'default' key to specify the icon to be used when there is no icon in the user's
4051 * language
4052 * @cfg {string} [iconTitle] Icon title text or a function that returns text
4053 */
4054 OO.ui.IconElement = function OoUiIconElement( config ) {
4055 // Configuration intialization
4056 config = config || {};
4057
4058 // Properties
4059 this.$icon = null;
4060 this.icon = null;
4061 this.iconTitle = null;
4062
4063 // Initialization
4064 this.setIcon( config.icon || this.constructor.static.icon );
4065 this.setIconTitle( config.iconTitle || this.constructor.static.iconTitle );
4066 this.setIconElement( config.$icon || this.$( '<span>' ) );
4067 };
4068
4069 /* Setup */
4070
4071 OO.initClass( OO.ui.IconElement );
4072
4073 /* Static Properties */
4074
4075 /**
4076 * Icon.
4077 *
4078 * Value should be the unique portion of an icon CSS class name, such as 'up' for 'oo-ui-icon-up'.
4079 *
4080 * For i18n purposes, this property can be an object containing a `default` icon name property and
4081 * additional icon names keyed by language code.
4082 *
4083 * Example of i18n icon definition:
4084 * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
4085 *
4086 * @static
4087 * @inheritable
4088 * @property {Object|string} Symbolic icon name, or map of icon names keyed by language ID;
4089 * use the 'default' key to specify the icon to be used when there is no icon in the user's
4090 * language
4091 */
4092 OO.ui.IconElement.static.icon = null;
4093
4094 /**
4095 * Icon title.
4096 *
4097 * @static
4098 * @inheritable
4099 * @property {string|Function|null} Icon title text, a function that returns text or null for no
4100 * icon title
4101 */
4102 OO.ui.IconElement.static.iconTitle = null;
4103
4104 /* Methods */
4105
4106 /**
4107 * Set the icon element.
4108 *
4109 * If an element is already set, it will be cleaned up before setting up the new element.
4110 *
4111 * @param {jQuery} $icon Element to use as icon
4112 */
4113 OO.ui.IconElement.prototype.setIconElement = function ( $icon ) {
4114 if ( this.$icon ) {
4115 this.$icon
4116 .removeClass( 'oo-ui-iconElement-icon oo-ui-icon-' + this.icon )
4117 .removeAttr( 'title' );
4118 }
4119
4120 this.$icon = $icon
4121 .addClass( 'oo-ui-iconElement-icon' )
4122 .toggleClass( 'oo-ui-icon-' + this.icon, !!this.icon );
4123 if ( this.iconTitle !== null ) {
4124 this.$icon.attr( 'title', this.iconTitle );
4125 }
4126 };
4127
4128 /**
4129 * Set icon name.
4130 *
4131 * @param {Object|string|null} icon Symbolic icon name, or map of icon names keyed by language ID;
4132 * use the 'default' key to specify the icon to be used when there is no icon in the user's
4133 * language, use null to remove icon
4134 * @chainable
4135 */
4136 OO.ui.IconElement.prototype.setIcon = function ( icon ) {
4137 icon = OO.isPlainObject( icon ) ? OO.ui.getLocalValue( icon, null, 'default' ) : icon;
4138 icon = typeof icon === 'string' && icon.trim().length ? icon.trim() : null;
4139
4140 if ( this.icon !== icon ) {
4141 if ( this.$icon ) {
4142 if ( this.icon !== null ) {
4143 this.$icon.removeClass( 'oo-ui-icon-' + this.icon );
4144 }
4145 if ( icon !== null ) {
4146 this.$icon.addClass( 'oo-ui-icon-' + icon );
4147 }
4148 }
4149 this.icon = icon;
4150 }
4151
4152 this.$element.toggleClass( 'oo-ui-iconElement', !!this.icon );
4153 this.updateThemeClasses();
4154
4155 return this;
4156 };
4157
4158 /**
4159 * Set icon title.
4160 *
4161 * @param {string|Function|null} icon Icon title text, a function that returns text or null
4162 * for no icon title
4163 * @chainable
4164 */
4165 OO.ui.IconElement.prototype.setIconTitle = function ( iconTitle ) {
4166 iconTitle = typeof iconTitle === 'function' ||
4167 ( typeof iconTitle === 'string' && iconTitle.length ) ?
4168 OO.ui.resolveMsg( iconTitle ) : null;
4169
4170 if ( this.iconTitle !== iconTitle ) {
4171 this.iconTitle = iconTitle;
4172 if ( this.$icon ) {
4173 if ( this.iconTitle !== null ) {
4174 this.$icon.attr( 'title', iconTitle );
4175 } else {
4176 this.$icon.removeAttr( 'title' );
4177 }
4178 }
4179 }
4180
4181 return this;
4182 };
4183
4184 /**
4185 * Get icon name.
4186 *
4187 * @return {string} Icon name
4188 */
4189 OO.ui.IconElement.prototype.getIcon = function () {
4190 return this.icon;
4191 };
4192
4193 /**
4194 * Element containing an indicator.
4195 *
4196 * Indicators are graphics, smaller than normal text. They can be used to describe unique status or
4197 * behavior. Indicators should only be used in exceptional cases; such as a button that opens a menu
4198 * instead of performing an action directly, or an item in a list which has errors that need to be
4199 * resolved.
4200 *
4201 * @abstract
4202 * @class
4203 *
4204 * @constructor
4205 * @param {Object} [config] Configuration options
4206 * @cfg {jQuery} [$indicator] Indicator node, assigned to #$indicator, omit to use a generated
4207 * `<span>`
4208 * @cfg {string} [indicator] Symbolic indicator name
4209 * @cfg {string} [indicatorTitle] Indicator title text or a function that returns text
4210 */
4211 OO.ui.IndicatorElement = function OoUiIndicatorElement( config ) {
4212 // Configuration initialization
4213 config = config || {};
4214
4215 // Properties
4216 this.$indicator = null;
4217 this.indicator = null;
4218 this.indicatorTitle = null;
4219
4220 // Initialization
4221 this.setIndicator( config.indicator || this.constructor.static.indicator );
4222 this.setIndicatorTitle( config.indicatorTitle || this.constructor.static.indicatorTitle );
4223 this.setIndicatorElement( config.$indicator || this.$( '<span>' ) );
4224 };
4225
4226 /* Setup */
4227
4228 OO.initClass( OO.ui.IndicatorElement );
4229
4230 /* Static Properties */
4231
4232 /**
4233 * indicator.
4234 *
4235 * @static
4236 * @inheritable
4237 * @property {string|null} Symbolic indicator name
4238 */
4239 OO.ui.IndicatorElement.static.indicator = null;
4240
4241 /**
4242 * Indicator title.
4243 *
4244 * @static
4245 * @inheritable
4246 * @property {string|Function|null} Indicator title text, a function that returns text or null for no
4247 * indicator title
4248 */
4249 OO.ui.IndicatorElement.static.indicatorTitle = null;
4250
4251 /* Methods */
4252
4253 /**
4254 * Set the indicator element.
4255 *
4256 * If an element is already set, it will be cleaned up before setting up the new element.
4257 *
4258 * @param {jQuery} $indicator Element to use as indicator
4259 */
4260 OO.ui.IndicatorElement.prototype.setIndicatorElement = function ( $indicator ) {
4261 if ( this.$indicator ) {
4262 this.$indicator
4263 .removeClass( 'oo-ui-indicatorElement-indicator oo-ui-indicator-' + this.indicator )
4264 .removeAttr( 'title' );
4265 }
4266
4267 this.$indicator = $indicator
4268 .addClass( 'oo-ui-indicatorElement-indicator' )
4269 .toggleClass( 'oo-ui-indicator-' + this.indicator, !!this.indicator );
4270 if ( this.indicatorTitle !== null ) {
4271 this.$indicatorTitle.attr( 'title', this.indicatorTitle );
4272 }
4273 };
4274
4275 /**
4276 * Set indicator name.
4277 *
4278 * @param {string|null} indicator Symbolic name of indicator to use or null for no indicator
4279 * @chainable
4280 */
4281 OO.ui.IndicatorElement.prototype.setIndicator = function ( indicator ) {
4282 indicator = typeof indicator === 'string' && indicator.length ? indicator.trim() : null;
4283
4284 if ( this.indicator !== indicator ) {
4285 if ( this.$indicator ) {
4286 if ( this.indicator !== null ) {
4287 this.$indicator.removeClass( 'oo-ui-indicator-' + this.indicator );
4288 }
4289 if ( indicator !== null ) {
4290 this.$indicator.addClass( 'oo-ui-indicator-' + indicator );
4291 }
4292 }
4293 this.indicator = indicator;
4294 }
4295
4296 this.$element.toggleClass( 'oo-ui-indicatorElement', !!this.indicator );
4297 this.updateThemeClasses();
4298
4299 return this;
4300 };
4301
4302 /**
4303 * Set indicator title.
4304 *
4305 * @param {string|Function|null} indicator Indicator title text, a function that returns text or
4306 * null for no indicator title
4307 * @chainable
4308 */
4309 OO.ui.IndicatorElement.prototype.setIndicatorTitle = function ( indicatorTitle ) {
4310 indicatorTitle = typeof indicatorTitle === 'function' ||
4311 ( typeof indicatorTitle === 'string' && indicatorTitle.length ) ?
4312 OO.ui.resolveMsg( indicatorTitle ) : null;
4313
4314 if ( this.indicatorTitle !== indicatorTitle ) {
4315 this.indicatorTitle = indicatorTitle;
4316 if ( this.$indicator ) {
4317 if ( this.indicatorTitle !== null ) {
4318 this.$indicator.attr( 'title', indicatorTitle );
4319 } else {
4320 this.$indicator.removeAttr( 'title' );
4321 }
4322 }
4323 }
4324
4325 return this;
4326 };
4327
4328 /**
4329 * Get indicator name.
4330 *
4331 * @return {string} Symbolic name of indicator
4332 */
4333 OO.ui.IndicatorElement.prototype.getIndicator = function () {
4334 return this.indicator;
4335 };
4336
4337 /**
4338 * Get indicator title.
4339 *
4340 * @return {string} Indicator title text
4341 */
4342 OO.ui.IndicatorElement.prototype.getIndicatorTitle = function () {
4343 return this.indicatorTitle;
4344 };
4345
4346 /**
4347 * Element containing a label.
4348 *
4349 * @abstract
4350 * @class
4351 *
4352 * @constructor
4353 * @param {Object} [config] Configuration options
4354 * @cfg {jQuery} [$label] Label node, assigned to #$label, omit to use a generated `<span>`
4355 * @cfg {jQuery|string|Function} [label] Label nodes, text or a function that returns nodes or text
4356 * @cfg {boolean} [autoFitLabel=true] Whether to fit the label or not.
4357 */
4358 OO.ui.LabelElement = function OoUiLabelElement( config ) {
4359 // Configuration initialization
4360 config = config || {};
4361
4362 // Properties
4363 this.$label = null;
4364 this.label = null;
4365 this.autoFitLabel = config.autoFitLabel === undefined || !!config.autoFitLabel;
4366
4367 // Initialization
4368 this.setLabel( config.label || this.constructor.static.label );
4369 this.setLabelElement( config.$label || this.$( '<span>' ) );
4370 };
4371
4372 /* Setup */
4373
4374 OO.initClass( OO.ui.LabelElement );
4375
4376 /* Static Properties */
4377
4378 /**
4379 * Label.
4380 *
4381 * @static
4382 * @inheritable
4383 * @property {string|Function|null} Label text; a function that returns nodes or text; or null for
4384 * no label
4385 */
4386 OO.ui.LabelElement.static.label = null;
4387
4388 /* Methods */
4389
4390 /**
4391 * Set the label element.
4392 *
4393 * If an element is already set, it will be cleaned up before setting up the new element.
4394 *
4395 * @param {jQuery} $label Element to use as label
4396 */
4397 OO.ui.LabelElement.prototype.setLabelElement = function ( $label ) {
4398 if ( this.$label ) {
4399 this.$label.removeClass( 'oo-ui-labelElement-label' ).empty();
4400 }
4401
4402 this.$label = $label.addClass( 'oo-ui-labelElement-label' );
4403 this.setLabelContent( this.label );
4404 };
4405
4406 /**
4407 * Set the label.
4408 *
4409 * An empty string will result in the label being hidden. A string containing only whitespace will
4410 * be converted to a single `&nbsp;`.
4411 *
4412 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
4413 * text; or null for no label
4414 * @chainable
4415 */
4416 OO.ui.LabelElement.prototype.setLabel = function ( label ) {
4417 label = typeof label === 'function' ? OO.ui.resolveMsg( label ) : label;
4418 label = ( typeof label === 'string' && label.length ) || label instanceof jQuery ? label : null;
4419
4420 if ( this.label !== label ) {
4421 if ( this.$label ) {
4422 this.setLabelContent( label );
4423 }
4424 this.label = label;
4425 }
4426
4427 this.$element.toggleClass( 'oo-ui-labelElement', !!this.label );
4428
4429 return this;
4430 };
4431
4432 /**
4433 * Get the label.
4434 *
4435 * @return {jQuery|string|Function|null} Label nodes; text; a function that returns nodes or
4436 * text; or null for no label
4437 */
4438 OO.ui.LabelElement.prototype.getLabel = function () {
4439 return this.label;
4440 };
4441
4442 /**
4443 * Fit the label.
4444 *
4445 * @chainable
4446 */
4447 OO.ui.LabelElement.prototype.fitLabel = function () {
4448 if ( this.$label && this.$label.autoEllipsis && this.autoFitLabel ) {
4449 this.$label.autoEllipsis( { hasSpan: false, tooltip: true } );
4450 }
4451
4452 return this;
4453 };
4454
4455 /**
4456 * Set the content of the label.
4457 *
4458 * Do not call this method until after the label element has been set by #setLabelElement.
4459 *
4460 * @private
4461 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
4462 * text; or null for no label
4463 */
4464 OO.ui.LabelElement.prototype.setLabelContent = function ( label ) {
4465 if ( typeof label === 'string' ) {
4466 if ( label.match( /^\s*$/ ) ) {
4467 // Convert whitespace only string to a single non-breaking space
4468 this.$label.html( '&nbsp;' );
4469 } else {
4470 this.$label.text( label );
4471 }
4472 } else if ( label instanceof jQuery ) {
4473 this.$label.empty().append( label );
4474 } else {
4475 this.$label.empty();
4476 }
4477 this.$label.css( 'display', !label ? 'none' : '' );
4478 };
4479
4480 /**
4481 * Element containing an OO.ui.PopupWidget object.
4482 *
4483 * @abstract
4484 * @class
4485 *
4486 * @constructor
4487 * @param {Object} [config] Configuration options
4488 * @cfg {Object} [popup] Configuration to pass to popup
4489 * @cfg {boolean} [autoClose=true] Popup auto-closes when it loses focus
4490 */
4491 OO.ui.PopupElement = function OoUiPopupElement( config ) {
4492 // Configuration initialization
4493 config = config || {};
4494
4495 // Properties
4496 this.popup = new OO.ui.PopupWidget( $.extend(
4497 { autoClose: true },
4498 config.popup,
4499 { $: this.$, $autoCloseIgnore: this.$element }
4500 ) );
4501 };
4502
4503 /* Methods */
4504
4505 /**
4506 * Get popup.
4507 *
4508 * @return {OO.ui.PopupWidget} Popup widget
4509 */
4510 OO.ui.PopupElement.prototype.getPopup = function () {
4511 return this.popup;
4512 };
4513
4514 /**
4515 * Element with named flags that can be added, removed, listed and checked.
4516 *
4517 * A flag, when set, adds a CSS class on the `$element` by combining `oo-ui-flaggedElement-` with
4518 * the flag name. Flags are primarily useful for styling.
4519 *
4520 * @abstract
4521 * @class
4522 *
4523 * @constructor
4524 * @param {Object} [config] Configuration options
4525 * @cfg {string|string[]} [flags] Styling flags, e.g. 'primary', 'destructive' or 'constructive'
4526 * @cfg {jQuery} [$flagged] Flagged node, assigned to #$flagged, omit to use #$element
4527 */
4528 OO.ui.FlaggedElement = function OoUiFlaggedElement( config ) {
4529 // Configuration initialization
4530 config = config || {};
4531
4532 // Properties
4533 this.flags = {};
4534 this.$flagged = null;
4535
4536 // Initialization
4537 this.setFlags( config.flags );
4538 this.setFlaggedElement( config.$flagged || this.$element );
4539 };
4540
4541 /* Events */
4542
4543 /**
4544 * @event flag
4545 * @param {Object.<string,boolean>} changes Object keyed by flag name containing boolean
4546 * added/removed properties
4547 */
4548
4549 /* Methods */
4550
4551 /**
4552 * Set the flagged element.
4553 *
4554 * If an element is already set, it will be cleaned up before setting up the new element.
4555 *
4556 * @param {jQuery} $flagged Element to add flags to
4557 */
4558 OO.ui.FlaggedElement.prototype.setFlaggedElement = function ( $flagged ) {
4559 var classNames = Object.keys( this.flags ).map( function ( flag ) {
4560 return 'oo-ui-flaggedElement-' + flag;
4561 } ).join( ' ' );
4562
4563 if ( this.$flagged ) {
4564 this.$flagged.removeClass( classNames );
4565 }
4566
4567 this.$flagged = $flagged.addClass( classNames );
4568 };
4569
4570 /**
4571 * Check if a flag is set.
4572 *
4573 * @param {string} flag Name of flag
4574 * @return {boolean} Has flag
4575 */
4576 OO.ui.FlaggedElement.prototype.hasFlag = function ( flag ) {
4577 return flag in this.flags;
4578 };
4579
4580 /**
4581 * Get the names of all flags set.
4582 *
4583 * @return {string[]} Flag names
4584 */
4585 OO.ui.FlaggedElement.prototype.getFlags = function () {
4586 return Object.keys( this.flags );
4587 };
4588
4589 /**
4590 * Clear all flags.
4591 *
4592 * @chainable
4593 * @fires flag
4594 */
4595 OO.ui.FlaggedElement.prototype.clearFlags = function () {
4596 var flag, className,
4597 changes = {},
4598 remove = [],
4599 classPrefix = 'oo-ui-flaggedElement-';
4600
4601 for ( flag in this.flags ) {
4602 className = classPrefix + flag;
4603 changes[flag] = false;
4604 delete this.flags[flag];
4605 remove.push( className );
4606 }
4607
4608 if ( this.$flagged ) {
4609 this.$flagged.removeClass( remove.join( ' ' ) );
4610 }
4611
4612 this.updateThemeClasses();
4613 this.emit( 'flag', changes );
4614
4615 return this;
4616 };
4617
4618 /**
4619 * Add one or more flags.
4620 *
4621 * @param {string|string[]|Object.<string, boolean>} flags One or more flags to add, or an object
4622 * keyed by flag name containing boolean set/remove instructions.
4623 * @chainable
4624 * @fires flag
4625 */
4626 OO.ui.FlaggedElement.prototype.setFlags = function ( flags ) {
4627 var i, len, flag, className,
4628 changes = {},
4629 add = [],
4630 remove = [],
4631 classPrefix = 'oo-ui-flaggedElement-';
4632
4633 if ( typeof flags === 'string' ) {
4634 className = classPrefix + flags;
4635 // Set
4636 if ( !this.flags[flags] ) {
4637 this.flags[flags] = true;
4638 add.push( className );
4639 }
4640 } else if ( $.isArray( flags ) ) {
4641 for ( i = 0, len = flags.length; i < len; i++ ) {
4642 flag = flags[i];
4643 className = classPrefix + flag;
4644 // Set
4645 if ( !this.flags[flag] ) {
4646 changes[flag] = true;
4647 this.flags[flag] = true;
4648 add.push( className );
4649 }
4650 }
4651 } else if ( OO.isPlainObject( flags ) ) {
4652 for ( flag in flags ) {
4653 className = classPrefix + flag;
4654 if ( flags[flag] ) {
4655 // Set
4656 if ( !this.flags[flag] ) {
4657 changes[flag] = true;
4658 this.flags[flag] = true;
4659 add.push( className );
4660 }
4661 } else {
4662 // Remove
4663 if ( this.flags[flag] ) {
4664 changes[flag] = false;
4665 delete this.flags[flag];
4666 remove.push( className );
4667 }
4668 }
4669 }
4670 }
4671
4672 if ( this.$flagged ) {
4673 this.$flagged
4674 .addClass( add.join( ' ' ) )
4675 .removeClass( remove.join( ' ' ) );
4676 }
4677
4678 this.updateThemeClasses();
4679 this.emit( 'flag', changes );
4680
4681 return this;
4682 };
4683
4684 /**
4685 * Element with a title.
4686 *
4687 * Titles are rendered by the browser and are made visible when hovering the element. Titles are
4688 * not visible on touch devices.
4689 *
4690 * @abstract
4691 * @class
4692 *
4693 * @constructor
4694 * @param {Object} [config] Configuration options
4695 * @cfg {jQuery} [$titled] Titled node, assigned to #$titled, omit to use #$element
4696 * @cfg {string|Function} [title] Title text or a function that returns text. If not provided, the
4697 * static property 'title' is used.
4698 */
4699 OO.ui.TitledElement = function OoUiTitledElement( config ) {
4700 // Configuration initialization
4701 config = config || {};
4702
4703 // Properties
4704 this.$titled = null;
4705 this.title = null;
4706
4707 // Initialization
4708 this.setTitle( config.title || this.constructor.static.title );
4709 this.setTitledElement( config.$titled || this.$element );
4710 };
4711
4712 /* Setup */
4713
4714 OO.initClass( OO.ui.TitledElement );
4715
4716 /* Static Properties */
4717
4718 /**
4719 * Title.
4720 *
4721 * @static
4722 * @inheritable
4723 * @property {string|Function} Title text or a function that returns text
4724 */
4725 OO.ui.TitledElement.static.title = null;
4726
4727 /* Methods */
4728
4729 /**
4730 * Set the titled element.
4731 *
4732 * If an element is already set, it will be cleaned up before setting up the new element.
4733 *
4734 * @param {jQuery} $titled Element to set title on
4735 */
4736 OO.ui.TitledElement.prototype.setTitledElement = function ( $titled ) {
4737 if ( this.$titled ) {
4738 this.$titled.removeAttr( 'title' );
4739 }
4740
4741 this.$titled = $titled;
4742 if ( this.title ) {
4743 this.$titled.attr( 'title', this.title );
4744 }
4745 };
4746
4747 /**
4748 * Set title.
4749 *
4750 * @param {string|Function|null} title Title text, a function that returns text or null for no title
4751 * @chainable
4752 */
4753 OO.ui.TitledElement.prototype.setTitle = function ( title ) {
4754 title = typeof title === 'string' ? OO.ui.resolveMsg( title ) : null;
4755
4756 if ( this.title !== title ) {
4757 if ( this.$titled ) {
4758 if ( title !== null ) {
4759 this.$titled.attr( 'title', title );
4760 } else {
4761 this.$titled.removeAttr( 'title' );
4762 }
4763 }
4764 this.title = title;
4765 }
4766
4767 return this;
4768 };
4769
4770 /**
4771 * Get title.
4772 *
4773 * @return {string} Title string
4774 */
4775 OO.ui.TitledElement.prototype.getTitle = function () {
4776 return this.title;
4777 };
4778
4779 /**
4780 * Element that can be automatically clipped to visible boundaries.
4781 *
4782 * Whenever the element's natural height changes, you have to call
4783 * #clip to make sure it's still clipping correctly.
4784 *
4785 * @abstract
4786 * @class
4787 *
4788 * @constructor
4789 * @param {Object} [config] Configuration options
4790 * @cfg {jQuery} [$clippable] Nodes to clip, assigned to #$clippable, omit to use #$element
4791 */
4792 OO.ui.ClippableElement = function OoUiClippableElement( config ) {
4793 // Configuration initialization
4794 config = config || {};
4795
4796 // Properties
4797 this.$clippable = null;
4798 this.clipping = false;
4799 this.clippedHorizontally = false;
4800 this.clippedVertically = false;
4801 this.$clippableContainer = null;
4802 this.$clippableScroller = null;
4803 this.$clippableWindow = null;
4804 this.idealWidth = null;
4805 this.idealHeight = null;
4806 this.onClippableContainerScrollHandler = this.clip.bind( this );
4807 this.onClippableWindowResizeHandler = this.clip.bind( this );
4808
4809 // Initialization
4810 this.setClippableElement( config.$clippable || this.$element );
4811 };
4812
4813 /* Methods */
4814
4815 /**
4816 * Set clippable element.
4817 *
4818 * If an element is already set, it will be cleaned up before setting up the new element.
4819 *
4820 * @param {jQuery} $clippable Element to make clippable
4821 */
4822 OO.ui.ClippableElement.prototype.setClippableElement = function ( $clippable ) {
4823 if ( this.$clippable ) {
4824 this.$clippable.removeClass( 'oo-ui-clippableElement-clippable' );
4825 this.$clippable.css( { width: '', height: '' } );
4826 this.$clippable.width(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4827 this.$clippable.css( { overflowX: '', overflowY: '' } );
4828 }
4829
4830 this.$clippable = $clippable.addClass( 'oo-ui-clippableElement-clippable' );
4831 this.clip();
4832 };
4833
4834 /**
4835 * Toggle clipping.
4836 *
4837 * Do not turn clipping on until after the element is attached to the DOM and visible.
4838 *
4839 * @param {boolean} [clipping] Enable clipping, omit to toggle
4840 * @chainable
4841 */
4842 OO.ui.ClippableElement.prototype.toggleClipping = function ( clipping ) {
4843 clipping = clipping === undefined ? !this.clipping : !!clipping;
4844
4845 if ( this.clipping !== clipping ) {
4846 this.clipping = clipping;
4847 if ( clipping ) {
4848 this.$clippableContainer = this.$( this.getClosestScrollableElementContainer() );
4849 // If the clippable container is the body, we have to listen to scroll events and check
4850 // jQuery.scrollTop on the window because of browser inconsistencies
4851 this.$clippableScroller = this.$clippableContainer.is( 'body' ) ?
4852 this.$( OO.ui.Element.getWindow( this.$clippableContainer ) ) :
4853 this.$clippableContainer;
4854 this.$clippableScroller.on( 'scroll', this.onClippableContainerScrollHandler );
4855 this.$clippableWindow = this.$( this.getElementWindow() )
4856 .on( 'resize', this.onClippableWindowResizeHandler );
4857 // Initial clip after visible
4858 this.clip();
4859 } else {
4860 this.$clippable.css( { width: '', height: '' } );
4861 this.$clippable.width(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4862 this.$clippable.css( { overflowX: '', overflowY: '' } );
4863
4864 this.$clippableContainer = null;
4865 this.$clippableScroller.off( 'scroll', this.onClippableContainerScrollHandler );
4866 this.$clippableScroller = null;
4867 this.$clippableWindow.off( 'resize', this.onClippableWindowResizeHandler );
4868 this.$clippableWindow = null;
4869 }
4870 }
4871
4872 return this;
4873 };
4874
4875 /**
4876 * Check if the element will be clipped to fit the visible area of the nearest scrollable container.
4877 *
4878 * @return {boolean} Element will be clipped to the visible area
4879 */
4880 OO.ui.ClippableElement.prototype.isClipping = function () {
4881 return this.clipping;
4882 };
4883
4884 /**
4885 * Check if the bottom or right of the element is being clipped by the nearest scrollable container.
4886 *
4887 * @return {boolean} Part of the element is being clipped
4888 */
4889 OO.ui.ClippableElement.prototype.isClipped = function () {
4890 return this.clippedHorizontally || this.clippedVertically;
4891 };
4892
4893 /**
4894 * Check if the right of the element is being clipped by the nearest scrollable container.
4895 *
4896 * @return {boolean} Part of the element is being clipped
4897 */
4898 OO.ui.ClippableElement.prototype.isClippedHorizontally = function () {
4899 return this.clippedHorizontally;
4900 };
4901
4902 /**
4903 * Check if the bottom of the element is being clipped by the nearest scrollable container.
4904 *
4905 * @return {boolean} Part of the element is being clipped
4906 */
4907 OO.ui.ClippableElement.prototype.isClippedVertically = function () {
4908 return this.clippedVertically;
4909 };
4910
4911 /**
4912 * Set the ideal size. These are the dimensions the element will have when it's not being clipped.
4913 *
4914 * @param {number|string} [width] Width as a number of pixels or CSS string with unit suffix
4915 * @param {number|string} [height] Height as a number of pixels or CSS string with unit suffix
4916 */
4917 OO.ui.ClippableElement.prototype.setIdealSize = function ( width, height ) {
4918 this.idealWidth = width;
4919 this.idealHeight = height;
4920
4921 if ( !this.clipping ) {
4922 // Update dimensions
4923 this.$clippable.css( { width: width, height: height } );
4924 }
4925 // While clipping, idealWidth and idealHeight are not considered
4926 };
4927
4928 /**
4929 * Clip element to visible boundaries and allow scrolling when needed. Call this method when
4930 * the element's natural height changes.
4931 *
4932 * Element will be clipped the bottom or right of the element is within 10px of the edge of, or
4933 * overlapped by, the visible area of the nearest scrollable container.
4934 *
4935 * @chainable
4936 */
4937 OO.ui.ClippableElement.prototype.clip = function () {
4938 if ( !this.clipping ) {
4939 // this.$clippableContainer and this.$clippableWindow are null, so the below will fail
4940 return this;
4941 }
4942
4943 var buffer = 10,
4944 cOffset = this.$clippable.offset(),
4945 $container = this.$clippableContainer.is( 'body' ) ?
4946 this.$clippableWindow : this.$clippableContainer,
4947 ccOffset = $container.offset() || { top: 0, left: 0 },
4948 ccHeight = $container.innerHeight() - buffer,
4949 ccWidth = $container.innerWidth() - buffer,
4950 scrollTop = this.$clippableScroller.scrollTop(),
4951 scrollLeft = this.$clippableScroller.scrollLeft(),
4952 desiredWidth = ( ccOffset.left + scrollLeft + ccWidth ) - cOffset.left,
4953 desiredHeight = ( ccOffset.top + scrollTop + ccHeight ) - cOffset.top,
4954 naturalWidth = this.$clippable.prop( 'scrollWidth' ),
4955 naturalHeight = this.$clippable.prop( 'scrollHeight' ),
4956 clipWidth = desiredWidth < naturalWidth,
4957 clipHeight = desiredHeight < naturalHeight;
4958
4959 if ( clipWidth ) {
4960 this.$clippable.css( { overflowX: 'scroll', width: desiredWidth } );
4961 } else {
4962 this.$clippable.css( 'width', this.idealWidth || '' );
4963 this.$clippable.width(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4964 this.$clippable.css( 'overflowX', '' );
4965 }
4966 if ( clipHeight ) {
4967 this.$clippable.css( { overflowY: 'scroll', height: desiredHeight } );
4968 } else {
4969 this.$clippable.css( 'height', this.idealHeight || '' );
4970 this.$clippable.height(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4971 this.$clippable.css( 'overflowY', '' );
4972 }
4973
4974 this.clippedHorizontally = clipWidth;
4975 this.clippedVertically = clipHeight;
4976
4977 return this;
4978 };
4979
4980 /**
4981 * Generic toolbar tool.
4982 *
4983 * @abstract
4984 * @class
4985 * @extends OO.ui.Widget
4986 * @mixins OO.ui.IconElement
4987 * @mixins OO.ui.FlaggedElement
4988 *
4989 * @constructor
4990 * @param {OO.ui.ToolGroup} toolGroup
4991 * @param {Object} [config] Configuration options
4992 * @cfg {string|Function} [title] Title text or a function that returns text
4993 */
4994 OO.ui.Tool = function OoUiTool( toolGroup, config ) {
4995 // Configuration initialization
4996 config = config || {};
4997
4998 // Parent constructor
4999 OO.ui.Tool.super.call( this, config );
5000
5001 // Mixin constructors
5002 OO.ui.IconElement.call( this, config );
5003 OO.ui.FlaggedElement.call( this, config );
5004
5005 // Properties
5006 this.toolGroup = toolGroup;
5007 this.toolbar = this.toolGroup.getToolbar();
5008 this.active = false;
5009 this.$title = this.$( '<span>' );
5010 this.$titleText = this.$( '<span>' );
5011 this.$accel = this.$( '<span>' );
5012 this.$link = this.$( '<a>' );
5013 this.title = null;
5014
5015 // Events
5016 this.toolbar.connect( this, { updateState: 'onUpdateState' } );
5017
5018 // Initialization
5019 this.$titleText.addClass( 'oo-ui-tool-title-text' );
5020 this.$accel.addClass( 'oo-ui-tool-accel' );
5021 this.$title
5022 .addClass( 'oo-ui-tool-title' )
5023 .append( this.$titleText, this.$accel );
5024 this.$link
5025 .addClass( 'oo-ui-tool-link' )
5026 .append( this.$icon, this.$title )
5027 .prop( 'tabIndex', 0 )
5028 .attr( 'role', 'button' );
5029 this.$element
5030 .data( 'oo-ui-tool', this )
5031 .addClass(
5032 'oo-ui-tool ' + 'oo-ui-tool-name-' +
5033 this.constructor.static.name.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' )
5034 )
5035 .append( this.$link );
5036 this.setTitle( config.title || this.constructor.static.title );
5037 };
5038
5039 /* Setup */
5040
5041 OO.inheritClass( OO.ui.Tool, OO.ui.Widget );
5042 OO.mixinClass( OO.ui.Tool, OO.ui.IconElement );
5043 OO.mixinClass( OO.ui.Tool, OO.ui.FlaggedElement );
5044
5045 /* Events */
5046
5047 /**
5048 * @event select
5049 */
5050
5051 /* Static Properties */
5052
5053 /**
5054 * @static
5055 * @inheritdoc
5056 */
5057 OO.ui.Tool.static.tagName = 'span';
5058
5059 /**
5060 * Symbolic name of tool.
5061 *
5062 * @abstract
5063 * @static
5064 * @inheritable
5065 * @property {string}
5066 */
5067 OO.ui.Tool.static.name = '';
5068
5069 /**
5070 * Tool group.
5071 *
5072 * @abstract
5073 * @static
5074 * @inheritable
5075 * @property {string}
5076 */
5077 OO.ui.Tool.static.group = '';
5078
5079 /**
5080 * Tool title.
5081 *
5082 * Title is used as a tooltip when the tool is part of a bar tool group, or a label when the tool
5083 * is part of a list or menu tool group. If a trigger is associated with an action by the same name
5084 * as the tool, a description of its keyboard shortcut for the appropriate platform will be
5085 * appended to the title if the tool is part of a bar tool group.
5086 *
5087 * @abstract
5088 * @static
5089 * @inheritable
5090 * @property {string|Function} Title text or a function that returns text
5091 */
5092 OO.ui.Tool.static.title = '';
5093
5094 /**
5095 * Tool can be automatically added to catch-all groups.
5096 *
5097 * @static
5098 * @inheritable
5099 * @property {boolean}
5100 */
5101 OO.ui.Tool.static.autoAddToCatchall = true;
5102
5103 /**
5104 * Tool can be automatically added to named groups.
5105 *
5106 * @static
5107 * @property {boolean}
5108 * @inheritable
5109 */
5110 OO.ui.Tool.static.autoAddToGroup = true;
5111
5112 /**
5113 * Check if this tool is compatible with given data.
5114 *
5115 * @static
5116 * @inheritable
5117 * @param {Mixed} data Data to check
5118 * @return {boolean} Tool can be used with data
5119 */
5120 OO.ui.Tool.static.isCompatibleWith = function () {
5121 return false;
5122 };
5123
5124 /* Methods */
5125
5126 /**
5127 * Handle the toolbar state being updated.
5128 *
5129 * This is an abstract method that must be overridden in a concrete subclass.
5130 *
5131 * @abstract
5132 */
5133 OO.ui.Tool.prototype.onUpdateState = function () {
5134 throw new Error(
5135 'OO.ui.Tool.onUpdateState not implemented in this subclass:' + this.constructor
5136 );
5137 };
5138
5139 /**
5140 * Handle the tool being selected.
5141 *
5142 * This is an abstract method that must be overridden in a concrete subclass.
5143 *
5144 * @abstract
5145 */
5146 OO.ui.Tool.prototype.onSelect = function () {
5147 throw new Error(
5148 'OO.ui.Tool.onSelect not implemented in this subclass:' + this.constructor
5149 );
5150 };
5151
5152 /**
5153 * Check if the button is active.
5154 *
5155 * @return {boolean} Button is active
5156 */
5157 OO.ui.Tool.prototype.isActive = function () {
5158 return this.active;
5159 };
5160
5161 /**
5162 * Make the button appear active or inactive.
5163 *
5164 * @param {boolean} state Make button appear active
5165 */
5166 OO.ui.Tool.prototype.setActive = function ( state ) {
5167 this.active = !!state;
5168 if ( this.active ) {
5169 this.$element.addClass( 'oo-ui-tool-active' );
5170 } else {
5171 this.$element.removeClass( 'oo-ui-tool-active' );
5172 }
5173 };
5174
5175 /**
5176 * Get the tool title.
5177 *
5178 * @param {string|Function} title Title text or a function that returns text
5179 * @chainable
5180 */
5181 OO.ui.Tool.prototype.setTitle = function ( title ) {
5182 this.title = OO.ui.resolveMsg( title );
5183 this.updateTitle();
5184 return this;
5185 };
5186
5187 /**
5188 * Get the tool title.
5189 *
5190 * @return {string} Title text
5191 */
5192 OO.ui.Tool.prototype.getTitle = function () {
5193 return this.title;
5194 };
5195
5196 /**
5197 * Get the tool's symbolic name.
5198 *
5199 * @return {string} Symbolic name of tool
5200 */
5201 OO.ui.Tool.prototype.getName = function () {
5202 return this.constructor.static.name;
5203 };
5204
5205 /**
5206 * Update the title.
5207 */
5208 OO.ui.Tool.prototype.updateTitle = function () {
5209 var titleTooltips = this.toolGroup.constructor.static.titleTooltips,
5210 accelTooltips = this.toolGroup.constructor.static.accelTooltips,
5211 accel = this.toolbar.getToolAccelerator( this.constructor.static.name ),
5212 tooltipParts = [];
5213
5214 this.$titleText.text( this.title );
5215 this.$accel.text( accel );
5216
5217 if ( titleTooltips && typeof this.title === 'string' && this.title.length ) {
5218 tooltipParts.push( this.title );
5219 }
5220 if ( accelTooltips && typeof accel === 'string' && accel.length ) {
5221 tooltipParts.push( accel );
5222 }
5223 if ( tooltipParts.length ) {
5224 this.$link.attr( 'title', tooltipParts.join( ' ' ) );
5225 } else {
5226 this.$link.removeAttr( 'title' );
5227 }
5228 };
5229
5230 /**
5231 * Destroy tool.
5232 */
5233 OO.ui.Tool.prototype.destroy = function () {
5234 this.toolbar.disconnect( this );
5235 this.$element.remove();
5236 };
5237
5238 /**
5239 * Collection of tool groups.
5240 *
5241 * @class
5242 * @extends OO.ui.Element
5243 * @mixins OO.EventEmitter
5244 * @mixins OO.ui.GroupElement
5245 *
5246 * @constructor
5247 * @param {OO.ui.ToolFactory} toolFactory Factory for creating tools
5248 * @param {OO.ui.ToolGroupFactory} toolGroupFactory Factory for creating tool groups
5249 * @param {Object} [config] Configuration options
5250 * @cfg {boolean} [actions] Add an actions section opposite to the tools
5251 * @cfg {boolean} [shadow] Add a shadow below the toolbar
5252 */
5253 OO.ui.Toolbar = function OoUiToolbar( toolFactory, toolGroupFactory, config ) {
5254 // Configuration initialization
5255 config = config || {};
5256
5257 // Parent constructor
5258 OO.ui.Toolbar.super.call( this, config );
5259
5260 // Mixin constructors
5261 OO.EventEmitter.call( this );
5262 OO.ui.GroupElement.call( this, config );
5263
5264 // Properties
5265 this.toolFactory = toolFactory;
5266 this.toolGroupFactory = toolGroupFactory;
5267 this.groups = [];
5268 this.tools = {};
5269 this.$bar = this.$( '<div>' );
5270 this.$actions = this.$( '<div>' );
5271 this.initialized = false;
5272
5273 // Events
5274 this.$element
5275 .add( this.$bar ).add( this.$group ).add( this.$actions )
5276 .on( 'mousedown touchstart', this.onPointerDown.bind( this ) );
5277
5278 // Initialization
5279 this.$group.addClass( 'oo-ui-toolbar-tools' );
5280 this.$bar.addClass( 'oo-ui-toolbar-bar' ).append( this.$group );
5281 if ( config.actions ) {
5282 this.$actions.addClass( 'oo-ui-toolbar-actions' );
5283 this.$bar.append( this.$actions );
5284 }
5285 this.$bar.append( '<div style="clear:both"></div>' );
5286 if ( config.shadow ) {
5287 this.$bar.append( '<div class="oo-ui-toolbar-shadow"></div>' );
5288 }
5289 this.$element.addClass( 'oo-ui-toolbar' ).append( this.$bar );
5290 };
5291
5292 /* Setup */
5293
5294 OO.inheritClass( OO.ui.Toolbar, OO.ui.Element );
5295 OO.mixinClass( OO.ui.Toolbar, OO.EventEmitter );
5296 OO.mixinClass( OO.ui.Toolbar, OO.ui.GroupElement );
5297
5298 /* Methods */
5299
5300 /**
5301 * Get the tool factory.
5302 *
5303 * @return {OO.ui.ToolFactory} Tool factory
5304 */
5305 OO.ui.Toolbar.prototype.getToolFactory = function () {
5306 return this.toolFactory;
5307 };
5308
5309 /**
5310 * Get the tool group factory.
5311 *
5312 * @return {OO.Factory} Tool group factory
5313 */
5314 OO.ui.Toolbar.prototype.getToolGroupFactory = function () {
5315 return this.toolGroupFactory;
5316 };
5317
5318 /**
5319 * Handles mouse down events.
5320 *
5321 * @param {jQuery.Event} e Mouse down event
5322 */
5323 OO.ui.Toolbar.prototype.onPointerDown = function ( e ) {
5324 var $closestWidgetToEvent = this.$( e.target ).closest( '.oo-ui-widget' ),
5325 $closestWidgetToToolbar = this.$element.closest( '.oo-ui-widget' );
5326 if ( !$closestWidgetToEvent.length || $closestWidgetToEvent[0] === $closestWidgetToToolbar[0] ) {
5327 return false;
5328 }
5329 };
5330
5331 /**
5332 * Sets up handles and preloads required information for the toolbar to work.
5333 * This must be called immediately after it is attached to a visible document.
5334 */
5335 OO.ui.Toolbar.prototype.initialize = function () {
5336 this.initialized = true;
5337 };
5338
5339 /**
5340 * Setup toolbar.
5341 *
5342 * Tools can be specified in the following ways:
5343 *
5344 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
5345 * - All tools in a group: `{ group: 'group-name' }`
5346 * - All tools: `'*'` - Using this will make the group a list with a "More" label by default
5347 *
5348 * @param {Object.<string,Array>} groups List of tool group configurations
5349 * @param {Array|string} [groups.include] Tools to include
5350 * @param {Array|string} [groups.exclude] Tools to exclude
5351 * @param {Array|string} [groups.promote] Tools to promote to the beginning
5352 * @param {Array|string} [groups.demote] Tools to demote to the end
5353 */
5354 OO.ui.Toolbar.prototype.setup = function ( groups ) {
5355 var i, len, type, group,
5356 items = [],
5357 defaultType = 'bar';
5358
5359 // Cleanup previous groups
5360 this.reset();
5361
5362 // Build out new groups
5363 for ( i = 0, len = groups.length; i < len; i++ ) {
5364 group = groups[i];
5365 if ( group.include === '*' ) {
5366 // Apply defaults to catch-all groups
5367 if ( group.type === undefined ) {
5368 group.type = 'list';
5369 }
5370 if ( group.label === undefined ) {
5371 group.label = OO.ui.msg( 'ooui-toolbar-more' );
5372 }
5373 }
5374 // Check type has been registered
5375 type = this.getToolGroupFactory().lookup( group.type ) ? group.type : defaultType;
5376 items.push(
5377 this.getToolGroupFactory().create( type, this, $.extend( { $: this.$ }, group ) )
5378 );
5379 }
5380 this.addItems( items );
5381 };
5382
5383 /**
5384 * Remove all tools and groups from the toolbar.
5385 */
5386 OO.ui.Toolbar.prototype.reset = function () {
5387 var i, len;
5388
5389 this.groups = [];
5390 this.tools = {};
5391 for ( i = 0, len = this.items.length; i < len; i++ ) {
5392 this.items[i].destroy();
5393 }
5394 this.clearItems();
5395 };
5396
5397 /**
5398 * Destroys toolbar, removing event handlers and DOM elements.
5399 *
5400 * Call this whenever you are done using a toolbar.
5401 */
5402 OO.ui.Toolbar.prototype.destroy = function () {
5403 this.reset();
5404 this.$element.remove();
5405 };
5406
5407 /**
5408 * Check if tool has not been used yet.
5409 *
5410 * @param {string} name Symbolic name of tool
5411 * @return {boolean} Tool is available
5412 */
5413 OO.ui.Toolbar.prototype.isToolAvailable = function ( name ) {
5414 return !this.tools[name];
5415 };
5416
5417 /**
5418 * Prevent tool from being used again.
5419 *
5420 * @param {OO.ui.Tool} tool Tool to reserve
5421 */
5422 OO.ui.Toolbar.prototype.reserveTool = function ( tool ) {
5423 this.tools[tool.getName()] = tool;
5424 };
5425
5426 /**
5427 * Allow tool to be used again.
5428 *
5429 * @param {OO.ui.Tool} tool Tool to release
5430 */
5431 OO.ui.Toolbar.prototype.releaseTool = function ( tool ) {
5432 delete this.tools[tool.getName()];
5433 };
5434
5435 /**
5436 * Get accelerator label for tool.
5437 *
5438 * This is a stub that should be overridden to provide access to accelerator information.
5439 *
5440 * @param {string} name Symbolic name of tool
5441 * @return {string|undefined} Tool accelerator label if available
5442 */
5443 OO.ui.Toolbar.prototype.getToolAccelerator = function () {
5444 return undefined;
5445 };
5446
5447 /**
5448 * Collection of tools.
5449 *
5450 * Tools can be specified in the following ways:
5451 *
5452 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
5453 * - All tools in a group: `{ group: 'group-name' }`
5454 * - All tools: `'*'`
5455 *
5456 * @abstract
5457 * @class
5458 * @extends OO.ui.Widget
5459 * @mixins OO.ui.GroupElement
5460 *
5461 * @constructor
5462 * @param {OO.ui.Toolbar} toolbar
5463 * @param {Object} [config] Configuration options
5464 * @cfg {Array|string} [include=[]] List of tools to include
5465 * @cfg {Array|string} [exclude=[]] List of tools to exclude
5466 * @cfg {Array|string} [promote=[]] List of tools to promote to the beginning
5467 * @cfg {Array|string} [demote=[]] List of tools to demote to the end
5468 */
5469 OO.ui.ToolGroup = function OoUiToolGroup( toolbar, config ) {
5470 // Configuration initialization
5471 config = config || {};
5472
5473 // Parent constructor
5474 OO.ui.ToolGroup.super.call( this, config );
5475
5476 // Mixin constructors
5477 OO.ui.GroupElement.call( this, config );
5478
5479 // Properties
5480 this.toolbar = toolbar;
5481 this.tools = {};
5482 this.pressed = null;
5483 this.autoDisabled = false;
5484 this.include = config.include || [];
5485 this.exclude = config.exclude || [];
5486 this.promote = config.promote || [];
5487 this.demote = config.demote || [];
5488 this.onCapturedMouseUpHandler = this.onCapturedMouseUp.bind( this );
5489
5490 // Events
5491 this.$element.on( {
5492 'mousedown touchstart': this.onPointerDown.bind( this ),
5493 'mouseup touchend': this.onPointerUp.bind( this ),
5494 mouseover: this.onMouseOver.bind( this ),
5495 mouseout: this.onMouseOut.bind( this )
5496 } );
5497 this.toolbar.getToolFactory().connect( this, { register: 'onToolFactoryRegister' } );
5498 this.aggregate( { disable: 'itemDisable' } );
5499 this.connect( this, { itemDisable: 'updateDisabled' } );
5500
5501 // Initialization
5502 this.$group.addClass( 'oo-ui-toolGroup-tools' );
5503 this.$element
5504 .addClass( 'oo-ui-toolGroup' )
5505 .append( this.$group );
5506 this.populate();
5507 };
5508
5509 /* Setup */
5510
5511 OO.inheritClass( OO.ui.ToolGroup, OO.ui.Widget );
5512 OO.mixinClass( OO.ui.ToolGroup, OO.ui.GroupElement );
5513
5514 /* Events */
5515
5516 /**
5517 * @event update
5518 */
5519
5520 /* Static Properties */
5521
5522 /**
5523 * Show labels in tooltips.
5524 *
5525 * @static
5526 * @inheritable
5527 * @property {boolean}
5528 */
5529 OO.ui.ToolGroup.static.titleTooltips = false;
5530
5531 /**
5532 * Show acceleration labels in tooltips.
5533 *
5534 * @static
5535 * @inheritable
5536 * @property {boolean}
5537 */
5538 OO.ui.ToolGroup.static.accelTooltips = false;
5539
5540 /**
5541 * Automatically disable the toolgroup when all tools are disabled
5542 *
5543 * @static
5544 * @inheritable
5545 * @property {boolean}
5546 */
5547 OO.ui.ToolGroup.static.autoDisable = true;
5548
5549 /* Methods */
5550
5551 /**
5552 * @inheritdoc
5553 */
5554 OO.ui.ToolGroup.prototype.isDisabled = function () {
5555 return this.autoDisabled || OO.ui.ToolGroup.super.prototype.isDisabled.apply( this, arguments );
5556 };
5557
5558 /**
5559 * @inheritdoc
5560 */
5561 OO.ui.ToolGroup.prototype.updateDisabled = function () {
5562 var i, item, allDisabled = true;
5563
5564 if ( this.constructor.static.autoDisable ) {
5565 for ( i = this.items.length - 1; i >= 0; i-- ) {
5566 item = this.items[i];
5567 if ( !item.isDisabled() ) {
5568 allDisabled = false;
5569 break;
5570 }
5571 }
5572 this.autoDisabled = allDisabled;
5573 }
5574 OO.ui.ToolGroup.super.prototype.updateDisabled.apply( this, arguments );
5575 };
5576
5577 /**
5578 * Handle mouse down events.
5579 *
5580 * @param {jQuery.Event} e Mouse down event
5581 */
5582 OO.ui.ToolGroup.prototype.onPointerDown = function ( e ) {
5583 // e.which is 0 for touch events, 1 for left mouse button
5584 if ( !this.isDisabled() && e.which <= 1 ) {
5585 this.pressed = this.getTargetTool( e );
5586 if ( this.pressed ) {
5587 this.pressed.setActive( true );
5588 this.getElementDocument().addEventListener(
5589 'mouseup', this.onCapturedMouseUpHandler, true
5590 );
5591 }
5592 }
5593 return false;
5594 };
5595
5596 /**
5597 * Handle captured mouse up events.
5598 *
5599 * @param {Event} e Mouse up event
5600 */
5601 OO.ui.ToolGroup.prototype.onCapturedMouseUp = function ( e ) {
5602 this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseUpHandler, true );
5603 // onPointerUp may be called a second time, depending on where the mouse is when the button is
5604 // released, but since `this.pressed` will no longer be true, the second call will be ignored.
5605 this.onPointerUp( e );
5606 };
5607
5608 /**
5609 * Handle mouse up events.
5610 *
5611 * @param {jQuery.Event} e Mouse up event
5612 */
5613 OO.ui.ToolGroup.prototype.onPointerUp = function ( e ) {
5614 var tool = this.getTargetTool( e );
5615
5616 // e.which is 0 for touch events, 1 for left mouse button
5617 if ( !this.isDisabled() && e.which <= 1 && this.pressed && this.pressed === tool ) {
5618 this.pressed.onSelect();
5619 }
5620
5621 this.pressed = null;
5622 return false;
5623 };
5624
5625 /**
5626 * Handle mouse over events.
5627 *
5628 * @param {jQuery.Event} e Mouse over event
5629 */
5630 OO.ui.ToolGroup.prototype.onMouseOver = function ( e ) {
5631 var tool = this.getTargetTool( e );
5632
5633 if ( this.pressed && this.pressed === tool ) {
5634 this.pressed.setActive( true );
5635 }
5636 };
5637
5638 /**
5639 * Handle mouse out events.
5640 *
5641 * @param {jQuery.Event} e Mouse out event
5642 */
5643 OO.ui.ToolGroup.prototype.onMouseOut = function ( e ) {
5644 var tool = this.getTargetTool( e );
5645
5646 if ( this.pressed && this.pressed === tool ) {
5647 this.pressed.setActive( false );
5648 }
5649 };
5650
5651 /**
5652 * Get the closest tool to a jQuery.Event.
5653 *
5654 * Only tool links are considered, which prevents other elements in the tool such as popups from
5655 * triggering tool group interactions.
5656 *
5657 * @private
5658 * @param {jQuery.Event} e
5659 * @return {OO.ui.Tool|null} Tool, `null` if none was found
5660 */
5661 OO.ui.ToolGroup.prototype.getTargetTool = function ( e ) {
5662 var tool,
5663 $item = this.$( e.target ).closest( '.oo-ui-tool-link' );
5664
5665 if ( $item.length ) {
5666 tool = $item.parent().data( 'oo-ui-tool' );
5667 }
5668
5669 return tool && !tool.isDisabled() ? tool : null;
5670 };
5671
5672 /**
5673 * Handle tool registry register events.
5674 *
5675 * If a tool is registered after the group is created, we must repopulate the list to account for:
5676 *
5677 * - a tool being added that may be included
5678 * - a tool already included being overridden
5679 *
5680 * @param {string} name Symbolic name of tool
5681 */
5682 OO.ui.ToolGroup.prototype.onToolFactoryRegister = function () {
5683 this.populate();
5684 };
5685
5686 /**
5687 * Get the toolbar this group is in.
5688 *
5689 * @return {OO.ui.Toolbar} Toolbar of group
5690 */
5691 OO.ui.ToolGroup.prototype.getToolbar = function () {
5692 return this.toolbar;
5693 };
5694
5695 /**
5696 * Add and remove tools based on configuration.
5697 */
5698 OO.ui.ToolGroup.prototype.populate = function () {
5699 var i, len, name, tool,
5700 toolFactory = this.toolbar.getToolFactory(),
5701 names = {},
5702 add = [],
5703 remove = [],
5704 list = this.toolbar.getToolFactory().getTools(
5705 this.include, this.exclude, this.promote, this.demote
5706 );
5707
5708 // Build a list of needed tools
5709 for ( i = 0, len = list.length; i < len; i++ ) {
5710 name = list[i];
5711 if (
5712 // Tool exists
5713 toolFactory.lookup( name ) &&
5714 // Tool is available or is already in this group
5715 ( this.toolbar.isToolAvailable( name ) || this.tools[name] )
5716 ) {
5717 tool = this.tools[name];
5718 if ( !tool ) {
5719 // Auto-initialize tools on first use
5720 this.tools[name] = tool = toolFactory.create( name, this );
5721 tool.updateTitle();
5722 }
5723 this.toolbar.reserveTool( tool );
5724 add.push( tool );
5725 names[name] = true;
5726 }
5727 }
5728 // Remove tools that are no longer needed
5729 for ( name in this.tools ) {
5730 if ( !names[name] ) {
5731 this.tools[name].destroy();
5732 this.toolbar.releaseTool( this.tools[name] );
5733 remove.push( this.tools[name] );
5734 delete this.tools[name];
5735 }
5736 }
5737 if ( remove.length ) {
5738 this.removeItems( remove );
5739 }
5740 // Update emptiness state
5741 if ( add.length ) {
5742 this.$element.removeClass( 'oo-ui-toolGroup-empty' );
5743 } else {
5744 this.$element.addClass( 'oo-ui-toolGroup-empty' );
5745 }
5746 // Re-add tools (moving existing ones to new locations)
5747 this.addItems( add );
5748 // Disabled state may depend on items
5749 this.updateDisabled();
5750 };
5751
5752 /**
5753 * Destroy tool group.
5754 */
5755 OO.ui.ToolGroup.prototype.destroy = function () {
5756 var name;
5757
5758 this.clearItems();
5759 this.toolbar.getToolFactory().disconnect( this );
5760 for ( name in this.tools ) {
5761 this.toolbar.releaseTool( this.tools[name] );
5762 this.tools[name].disconnect( this ).destroy();
5763 delete this.tools[name];
5764 }
5765 this.$element.remove();
5766 };
5767
5768 /**
5769 * Dialog for showing a message.
5770 *
5771 * User interface:
5772 * - Registers two actions by default (safe and primary).
5773 * - Renders action widgets in the footer.
5774 *
5775 * @class
5776 * @extends OO.ui.Dialog
5777 *
5778 * @constructor
5779 * @param {Object} [config] Configuration options
5780 */
5781 OO.ui.MessageDialog = function OoUiMessageDialog( config ) {
5782 // Parent constructor
5783 OO.ui.MessageDialog.super.call( this, config );
5784
5785 // Properties
5786 this.verticalActionLayout = null;
5787
5788 // Initialization
5789 this.$element.addClass( 'oo-ui-messageDialog' );
5790 };
5791
5792 /* Inheritance */
5793
5794 OO.inheritClass( OO.ui.MessageDialog, OO.ui.Dialog );
5795
5796 /* Static Properties */
5797
5798 OO.ui.MessageDialog.static.name = 'message';
5799
5800 OO.ui.MessageDialog.static.size = 'small';
5801
5802 OO.ui.MessageDialog.static.verbose = false;
5803
5804 /**
5805 * Dialog title.
5806 *
5807 * A confirmation dialog's title should describe what the progressive action will do. An alert
5808 * dialog's title should describe what event occured.
5809 *
5810 * @static
5811 * inheritable
5812 * @property {jQuery|string|Function|null}
5813 */
5814 OO.ui.MessageDialog.static.title = null;
5815
5816 /**
5817 * A confirmation dialog's message should describe the consequences of the progressive action. An
5818 * alert dialog's message should describe why the event occured.
5819 *
5820 * @static
5821 * inheritable
5822 * @property {jQuery|string|Function|null}
5823 */
5824 OO.ui.MessageDialog.static.message = null;
5825
5826 OO.ui.MessageDialog.static.actions = [
5827 { action: 'accept', label: OO.ui.deferMsg( 'ooui-dialog-message-accept' ), flags: 'primary' },
5828 { action: 'reject', label: OO.ui.deferMsg( 'ooui-dialog-message-reject' ), flags: 'safe' }
5829 ];
5830
5831 /* Methods */
5832
5833 /**
5834 * @inheritdoc
5835 */
5836 OO.ui.MessageDialog.prototype.onActionResize = function ( action ) {
5837 this.fitActions();
5838 return OO.ui.ProcessDialog.super.prototype.onActionResize.call( this, action );
5839 };
5840
5841 /**
5842 * Toggle action layout between vertical and horizontal.
5843 *
5844 * @param {boolean} [value] Layout actions vertically, omit to toggle
5845 * @chainable
5846 */
5847 OO.ui.MessageDialog.prototype.toggleVerticalActionLayout = function ( value ) {
5848 value = value === undefined ? !this.verticalActionLayout : !!value;
5849
5850 if ( value !== this.verticalActionLayout ) {
5851 this.verticalActionLayout = value;
5852 this.$actions
5853 .toggleClass( 'oo-ui-messageDialog-actions-vertical', value )
5854 .toggleClass( 'oo-ui-messageDialog-actions-horizontal', !value );
5855 }
5856
5857 return this;
5858 };
5859
5860 /**
5861 * @inheritdoc
5862 */
5863 OO.ui.MessageDialog.prototype.getActionProcess = function ( action ) {
5864 if ( action ) {
5865 return new OO.ui.Process( function () {
5866 this.close( { action: action } );
5867 }, this );
5868 }
5869 return OO.ui.MessageDialog.super.prototype.getActionProcess.call( this, action );
5870 };
5871
5872 /**
5873 * @inheritdoc
5874 *
5875 * @param {Object} [data] Dialog opening data
5876 * @param {jQuery|string|Function|null} [data.title] Description of the action being confirmed
5877 * @param {jQuery|string|Function|null} [data.message] Description of the action's consequence
5878 * @param {boolean} [data.verbose] Message is verbose and should be styled as a long message
5879 * @param {Object[]} [data.actions] List of OO.ui.ActionOptionWidget configuration options for each
5880 * action item
5881 */
5882 OO.ui.MessageDialog.prototype.getSetupProcess = function ( data ) {
5883 data = data || {};
5884
5885 // Parent method
5886 return OO.ui.MessageDialog.super.prototype.getSetupProcess.call( this, data )
5887 .next( function () {
5888 this.title.setLabel(
5889 data.title !== undefined ? data.title : this.constructor.static.title
5890 );
5891 this.message.setLabel(
5892 data.message !== undefined ? data.message : this.constructor.static.message
5893 );
5894 this.message.$element.toggleClass(
5895 'oo-ui-messageDialog-message-verbose',
5896 data.verbose !== undefined ? data.verbose : this.constructor.static.verbose
5897 );
5898 }, this );
5899 };
5900
5901 /**
5902 * @inheritdoc
5903 */
5904 OO.ui.MessageDialog.prototype.getBodyHeight = function () {
5905 return Math.round( this.text.$element.outerHeight( true ) );
5906 };
5907
5908 /**
5909 * @inheritdoc
5910 */
5911 OO.ui.MessageDialog.prototype.initialize = function () {
5912 // Parent method
5913 OO.ui.MessageDialog.super.prototype.initialize.call( this );
5914
5915 // Properties
5916 this.$actions = this.$( '<div>' );
5917 this.container = new OO.ui.PanelLayout( {
5918 $: this.$, scrollable: true, classes: [ 'oo-ui-messageDialog-container' ]
5919 } );
5920 this.text = new OO.ui.PanelLayout( {
5921 $: this.$, padded: true, expanded: false, classes: [ 'oo-ui-messageDialog-text' ]
5922 } );
5923 this.message = new OO.ui.LabelWidget( {
5924 $: this.$, classes: [ 'oo-ui-messageDialog-message' ]
5925 } );
5926
5927 // Initialization
5928 this.title.$element.addClass( 'oo-ui-messageDialog-title' );
5929 this.$content.addClass( 'oo-ui-messageDialog-content' );
5930 this.container.$element.append( this.text.$element );
5931 this.text.$element.append( this.title.$element, this.message.$element );
5932 this.$body.append( this.container.$element );
5933 this.$actions.addClass( 'oo-ui-messageDialog-actions' );
5934 this.$foot.append( this.$actions );
5935 };
5936
5937 /**
5938 * @inheritdoc
5939 */
5940 OO.ui.MessageDialog.prototype.attachActions = function () {
5941 var i, len, other, special, others;
5942
5943 // Parent method
5944 OO.ui.MessageDialog.super.prototype.attachActions.call( this );
5945
5946 special = this.actions.getSpecial();
5947 others = this.actions.getOthers();
5948 if ( special.safe ) {
5949 this.$actions.append( special.safe.$element );
5950 special.safe.toggleFramed( false );
5951 }
5952 if ( others.length ) {
5953 for ( i = 0, len = others.length; i < len; i++ ) {
5954 other = others[i];
5955 this.$actions.append( other.$element );
5956 other.toggleFramed( false );
5957 }
5958 }
5959 if ( special.primary ) {
5960 this.$actions.append( special.primary.$element );
5961 special.primary.toggleFramed( false );
5962 }
5963
5964 this.fitActions();
5965 if ( !this.isOpening() ) {
5966 this.manager.updateWindowSize( this );
5967 }
5968 this.$body.css( 'bottom', this.$foot.outerHeight( true ) );
5969 };
5970
5971 /**
5972 * Fit action actions into columns or rows.
5973 *
5974 * Columns will be used if all labels can fit without overflow, otherwise rows will be used.
5975 */
5976 OO.ui.MessageDialog.prototype.fitActions = function () {
5977 var i, len, action,
5978 actions = this.actions.get();
5979
5980 // Detect clipping
5981 this.toggleVerticalActionLayout( false );
5982 for ( i = 0, len = actions.length; i < len; i++ ) {
5983 action = actions[i];
5984 if ( action.$element.innerWidth() < action.$label.outerWidth( true ) ) {
5985 this.toggleVerticalActionLayout( true );
5986 break;
5987 }
5988 }
5989 };
5990
5991 /**
5992 * Navigation dialog window.
5993 *
5994 * Logic:
5995 * - Show and hide errors.
5996 * - Retry an action.
5997 *
5998 * User interface:
5999 * - Renders header with dialog title and one action widget on either side
6000 * (a 'safe' button on the left, and a 'primary' button on the right, both of
6001 * which close the dialog).
6002 * - Displays any action widgets in the footer (none by default).
6003 * - Ability to dismiss errors.
6004 *
6005 * Subclass responsibilities:
6006 * - Register a 'safe' action.
6007 * - Register a 'primary' action.
6008 * - Add content to the dialog.
6009 *
6010 * @abstract
6011 * @class
6012 * @extends OO.ui.Dialog
6013 *
6014 * @constructor
6015 * @param {Object} [config] Configuration options
6016 */
6017 OO.ui.ProcessDialog = function OoUiProcessDialog( config ) {
6018 // Parent constructor
6019 OO.ui.ProcessDialog.super.call( this, config );
6020
6021 // Initialization
6022 this.$element.addClass( 'oo-ui-processDialog' );
6023 };
6024
6025 /* Setup */
6026
6027 OO.inheritClass( OO.ui.ProcessDialog, OO.ui.Dialog );
6028
6029 /* Methods */
6030
6031 /**
6032 * Handle dismiss button click events.
6033 *
6034 * Hides errors.
6035 */
6036 OO.ui.ProcessDialog.prototype.onDismissErrorButtonClick = function () {
6037 this.hideErrors();
6038 };
6039
6040 /**
6041 * Handle retry button click events.
6042 *
6043 * Hides errors and then tries again.
6044 */
6045 OO.ui.ProcessDialog.prototype.onRetryButtonClick = function () {
6046 this.hideErrors();
6047 this.executeAction( this.currentAction.getAction() );
6048 };
6049
6050 /**
6051 * @inheritdoc
6052 */
6053 OO.ui.ProcessDialog.prototype.onActionResize = function ( action ) {
6054 if ( this.actions.isSpecial( action ) ) {
6055 this.fitLabel();
6056 }
6057 return OO.ui.ProcessDialog.super.prototype.onActionResize.call( this, action );
6058 };
6059
6060 /**
6061 * @inheritdoc
6062 */
6063 OO.ui.ProcessDialog.prototype.initialize = function () {
6064 // Parent method
6065 OO.ui.ProcessDialog.super.prototype.initialize.call( this );
6066
6067 // Properties
6068 this.$navigation = this.$( '<div>' );
6069 this.$location = this.$( '<div>' );
6070 this.$safeActions = this.$( '<div>' );
6071 this.$primaryActions = this.$( '<div>' );
6072 this.$otherActions = this.$( '<div>' );
6073 this.dismissButton = new OO.ui.ButtonWidget( {
6074 $: this.$,
6075 label: OO.ui.msg( 'ooui-dialog-process-dismiss' )
6076 } );
6077 this.retryButton = new OO.ui.ButtonWidget( { $: this.$ } );
6078 this.$errors = this.$( '<div>' );
6079 this.$errorsTitle = this.$( '<div>' );
6080
6081 // Events
6082 this.dismissButton.connect( this, { click: 'onDismissErrorButtonClick' } );
6083 this.retryButton.connect( this, { click: 'onRetryButtonClick' } );
6084
6085 // Initialization
6086 this.title.$element.addClass( 'oo-ui-processDialog-title' );
6087 this.$location
6088 .append( this.title.$element )
6089 .addClass( 'oo-ui-processDialog-location' );
6090 this.$safeActions.addClass( 'oo-ui-processDialog-actions-safe' );
6091 this.$primaryActions.addClass( 'oo-ui-processDialog-actions-primary' );
6092 this.$otherActions.addClass( 'oo-ui-processDialog-actions-other' );
6093 this.$errorsTitle
6094 .addClass( 'oo-ui-processDialog-errors-title' )
6095 .text( OO.ui.msg( 'ooui-dialog-process-error' ) );
6096 this.$errors
6097 .addClass( 'oo-ui-processDialog-errors' )
6098 .append( this.$errorsTitle, this.dismissButton.$element, this.retryButton.$element );
6099 this.$content
6100 .addClass( 'oo-ui-processDialog-content' )
6101 .append( this.$errors );
6102 this.$navigation
6103 .addClass( 'oo-ui-processDialog-navigation' )
6104 .append( this.$safeActions, this.$location, this.$primaryActions );
6105 this.$head.append( this.$navigation );
6106 this.$foot.append( this.$otherActions );
6107 };
6108
6109 /**
6110 * @inheritdoc
6111 */
6112 OO.ui.ProcessDialog.prototype.attachActions = function () {
6113 var i, len, other, special, others;
6114
6115 // Parent method
6116 OO.ui.ProcessDialog.super.prototype.attachActions.call( this );
6117
6118 special = this.actions.getSpecial();
6119 others = this.actions.getOthers();
6120 if ( special.primary ) {
6121 this.$primaryActions.append( special.primary.$element );
6122 special.primary.toggleFramed( true );
6123 }
6124 if ( others.length ) {
6125 for ( i = 0, len = others.length; i < len; i++ ) {
6126 other = others[i];
6127 this.$otherActions.append( other.$element );
6128 other.toggleFramed( true );
6129 }
6130 }
6131 if ( special.safe ) {
6132 this.$safeActions.append( special.safe.$element );
6133 special.safe.toggleFramed( true );
6134 }
6135
6136 this.fitLabel();
6137 this.$body.css( 'bottom', this.$foot.outerHeight( true ) );
6138 };
6139
6140 /**
6141 * @inheritdoc
6142 */
6143 OO.ui.ProcessDialog.prototype.executeAction = function ( action ) {
6144 OO.ui.ProcessDialog.super.prototype.executeAction.call( this, action )
6145 .fail( this.showErrors.bind( this ) );
6146 };
6147
6148 /**
6149 * Fit label between actions.
6150 *
6151 * @chainable
6152 */
6153 OO.ui.ProcessDialog.prototype.fitLabel = function () {
6154 var width = Math.max(
6155 this.$safeActions.is( ':visible' ) ? this.$safeActions.width() : 0,
6156 this.$primaryActions.is( ':visible' ) ? this.$primaryActions.width() : 0
6157 );
6158 this.$location.css( { paddingLeft: width, paddingRight: width } );
6159
6160 return this;
6161 };
6162
6163 /**
6164 * Handle errors that occured durring accept or reject processes.
6165 *
6166 * @param {OO.ui.Error[]} errors Errors to be handled
6167 */
6168 OO.ui.ProcessDialog.prototype.showErrors = function ( errors ) {
6169 var i, len, $item,
6170 items = [],
6171 recoverable = true,
6172 warning = false;
6173
6174 for ( i = 0, len = errors.length; i < len; i++ ) {
6175 if ( !errors[i].isRecoverable() ) {
6176 recoverable = false;
6177 }
6178 if ( errors[i].isWarning() ) {
6179 warning = true;
6180 }
6181 $item = this.$( '<div>' )
6182 .addClass( 'oo-ui-processDialog-error' )
6183 .append( errors[i].getMessage() );
6184 items.push( $item[0] );
6185 }
6186 this.$errorItems = this.$( items );
6187 if ( recoverable ) {
6188 this.retryButton.clearFlags().setFlags( this.currentAction.getFlags() );
6189 } else {
6190 this.currentAction.setDisabled( true );
6191 }
6192 if ( warning ) {
6193 this.retryButton.setLabel( OO.ui.msg( 'ooui-dialog-process-continue' ) );
6194 } else {
6195 this.retryButton.setLabel( OO.ui.msg( 'ooui-dialog-process-retry' ) );
6196 }
6197 this.retryButton.toggle( recoverable );
6198 this.$errorsTitle.after( this.$errorItems );
6199 this.$errors.show().scrollTop( 0 );
6200 };
6201
6202 /**
6203 * Hide errors.
6204 */
6205 OO.ui.ProcessDialog.prototype.hideErrors = function () {
6206 this.$errors.hide();
6207 this.$errorItems.remove();
6208 this.$errorItems = null;
6209 };
6210
6211 /**
6212 * Layout containing a series of pages.
6213 *
6214 * @class
6215 * @extends OO.ui.Layout
6216 *
6217 * @constructor
6218 * @param {Object} [config] Configuration options
6219 * @cfg {boolean} [continuous=false] Show all pages, one after another
6220 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when changing to a page
6221 * @cfg {boolean} [outlined=false] Show an outline
6222 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
6223 */
6224 OO.ui.BookletLayout = function OoUiBookletLayout( config ) {
6225 // Configuration initialization
6226 config = config || {};
6227
6228 // Parent constructor
6229 OO.ui.BookletLayout.super.call( this, config );
6230
6231 // Properties
6232 this.currentPageName = null;
6233 this.pages = {};
6234 this.ignoreFocus = false;
6235 this.stackLayout = new OO.ui.StackLayout( { $: this.$, continuous: !!config.continuous } );
6236 this.autoFocus = config.autoFocus === undefined || !!config.autoFocus;
6237 this.outlineVisible = false;
6238 this.outlined = !!config.outlined;
6239 if ( this.outlined ) {
6240 this.editable = !!config.editable;
6241 this.outlineControlsWidget = null;
6242 this.outlineWidget = new OO.ui.OutlineWidget( { $: this.$ } );
6243 this.outlinePanel = new OO.ui.PanelLayout( { $: this.$, scrollable: true } );
6244 this.gridLayout = new OO.ui.GridLayout(
6245 [ this.outlinePanel, this.stackLayout ],
6246 { $: this.$, widths: [ 1, 2 ] }
6247 );
6248 this.outlineVisible = true;
6249 if ( this.editable ) {
6250 this.outlineControlsWidget = new OO.ui.OutlineControlsWidget(
6251 this.outlineWidget, { $: this.$ }
6252 );
6253 }
6254 }
6255
6256 // Events
6257 this.stackLayout.connect( this, { set: 'onStackLayoutSet' } );
6258 if ( this.outlined ) {
6259 this.outlineWidget.connect( this, { select: 'onOutlineWidgetSelect' } );
6260 }
6261 if ( this.autoFocus ) {
6262 // Event 'focus' does not bubble, but 'focusin' does
6263 this.stackLayout.onDOMEvent( 'focusin', this.onStackLayoutFocus.bind( this ) );
6264 }
6265
6266 // Initialization
6267 this.$element.addClass( 'oo-ui-bookletLayout' );
6268 this.stackLayout.$element.addClass( 'oo-ui-bookletLayout-stackLayout' );
6269 if ( this.outlined ) {
6270 this.outlinePanel.$element
6271 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
6272 .append( this.outlineWidget.$element );
6273 if ( this.editable ) {
6274 this.outlinePanel.$element
6275 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
6276 .append( this.outlineControlsWidget.$element );
6277 }
6278 this.$element.append( this.gridLayout.$element );
6279 } else {
6280 this.$element.append( this.stackLayout.$element );
6281 }
6282 };
6283
6284 /* Setup */
6285
6286 OO.inheritClass( OO.ui.BookletLayout, OO.ui.Layout );
6287
6288 /* Events */
6289
6290 /**
6291 * @event set
6292 * @param {OO.ui.PageLayout} page Current page
6293 */
6294
6295 /**
6296 * @event add
6297 * @param {OO.ui.PageLayout[]} page Added pages
6298 * @param {number} index Index pages were added at
6299 */
6300
6301 /**
6302 * @event remove
6303 * @param {OO.ui.PageLayout[]} pages Removed pages
6304 */
6305
6306 /* Methods */
6307
6308 /**
6309 * Handle stack layout focus.
6310 *
6311 * @param {jQuery.Event} e Focusin event
6312 */
6313 OO.ui.BookletLayout.prototype.onStackLayoutFocus = function ( e ) {
6314 var name, $target;
6315
6316 // Find the page that an element was focused within
6317 $target = $( e.target ).closest( '.oo-ui-pageLayout' );
6318 for ( name in this.pages ) {
6319 // Check for page match, exclude current page to find only page changes
6320 if ( this.pages[name].$element[0] === $target[0] && name !== this.currentPageName ) {
6321 this.setPage( name );
6322 break;
6323 }
6324 }
6325 };
6326
6327 /**
6328 * Handle stack layout set events.
6329 *
6330 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
6331 */
6332 OO.ui.BookletLayout.prototype.onStackLayoutSet = function ( page ) {
6333 var $input, layout = this;
6334 if ( page ) {
6335 page.scrollElementIntoView( { complete: function () {
6336 if ( layout.autoFocus ) {
6337 // Set focus to the first input if nothing on the page is focused yet
6338 if ( !page.$element.find( ':focus' ).length ) {
6339 $input = page.$element.find( ':input:first' );
6340 if ( $input.length ) {
6341 $input[0].focus();
6342 }
6343 }
6344 }
6345 } } );
6346 }
6347 };
6348
6349 /**
6350 * Handle outline widget select events.
6351 *
6352 * @param {OO.ui.OptionWidget|null} item Selected item
6353 */
6354 OO.ui.BookletLayout.prototype.onOutlineWidgetSelect = function ( item ) {
6355 if ( item ) {
6356 this.setPage( item.getData() );
6357 }
6358 };
6359
6360 /**
6361 * Check if booklet has an outline.
6362 *
6363 * @return {boolean}
6364 */
6365 OO.ui.BookletLayout.prototype.isOutlined = function () {
6366 return this.outlined;
6367 };
6368
6369 /**
6370 * Check if booklet has editing controls.
6371 *
6372 * @return {boolean}
6373 */
6374 OO.ui.BookletLayout.prototype.isEditable = function () {
6375 return this.editable;
6376 };
6377
6378 /**
6379 * Check if booklet has a visible outline.
6380 *
6381 * @return {boolean}
6382 */
6383 OO.ui.BookletLayout.prototype.isOutlineVisible = function () {
6384 return this.outlined && this.outlineVisible;
6385 };
6386
6387 /**
6388 * Hide or show the outline.
6389 *
6390 * @param {boolean} [show] Show outline, omit to invert current state
6391 * @chainable
6392 */
6393 OO.ui.BookletLayout.prototype.toggleOutline = function ( show ) {
6394 if ( this.outlined ) {
6395 show = show === undefined ? !this.outlineVisible : !!show;
6396 this.outlineVisible = show;
6397 this.gridLayout.layout( show ? [ 1, 2 ] : [ 0, 1 ], [ 1 ] );
6398 }
6399
6400 return this;
6401 };
6402
6403 /**
6404 * Get the outline widget.
6405 *
6406 * @param {OO.ui.PageLayout} page Page to be selected
6407 * @return {OO.ui.PageLayout|null} Closest page to another
6408 */
6409 OO.ui.BookletLayout.prototype.getClosestPage = function ( page ) {
6410 var next, prev, level,
6411 pages = this.stackLayout.getItems(),
6412 index = $.inArray( page, pages );
6413
6414 if ( index !== -1 ) {
6415 next = pages[index + 1];
6416 prev = pages[index - 1];
6417 // Prefer adjacent pages at the same level
6418 if ( this.outlined ) {
6419 level = this.outlineWidget.getItemFromData( page.getName() ).getLevel();
6420 if (
6421 prev &&
6422 level === this.outlineWidget.getItemFromData( prev.getName() ).getLevel()
6423 ) {
6424 return prev;
6425 }
6426 if (
6427 next &&
6428 level === this.outlineWidget.getItemFromData( next.getName() ).getLevel()
6429 ) {
6430 return next;
6431 }
6432 }
6433 }
6434 return prev || next || null;
6435 };
6436
6437 /**
6438 * Get the outline widget.
6439 *
6440 * @return {OO.ui.OutlineWidget|null} Outline widget, or null if boolet has no outline
6441 */
6442 OO.ui.BookletLayout.prototype.getOutline = function () {
6443 return this.outlineWidget;
6444 };
6445
6446 /**
6447 * Get the outline controls widget. If the outline is not editable, null is returned.
6448 *
6449 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
6450 */
6451 OO.ui.BookletLayout.prototype.getOutlineControls = function () {
6452 return this.outlineControlsWidget;
6453 };
6454
6455 /**
6456 * Get a page by name.
6457 *
6458 * @param {string} name Symbolic name of page
6459 * @return {OO.ui.PageLayout|undefined} Page, if found
6460 */
6461 OO.ui.BookletLayout.prototype.getPage = function ( name ) {
6462 return this.pages[name];
6463 };
6464
6465 /**
6466 * Get the current page name.
6467 *
6468 * @return {string|null} Current page name
6469 */
6470 OO.ui.BookletLayout.prototype.getPageName = function () {
6471 return this.currentPageName;
6472 };
6473
6474 /**
6475 * Add a page to the layout.
6476 *
6477 * When pages are added with the same names as existing pages, the existing pages will be
6478 * automatically removed before the new pages are added.
6479 *
6480 * @param {OO.ui.PageLayout[]} pages Pages to add
6481 * @param {number} index Index to insert pages after
6482 * @fires add
6483 * @chainable
6484 */
6485 OO.ui.BookletLayout.prototype.addPages = function ( pages, index ) {
6486 var i, len, name, page, item, currentIndex,
6487 stackLayoutPages = this.stackLayout.getItems(),
6488 remove = [],
6489 items = [];
6490
6491 // Remove pages with same names
6492 for ( i = 0, len = pages.length; i < len; i++ ) {
6493 page = pages[i];
6494 name = page.getName();
6495
6496 if ( Object.prototype.hasOwnProperty.call( this.pages, name ) ) {
6497 // Correct the insertion index
6498 currentIndex = $.inArray( this.pages[name], stackLayoutPages );
6499 if ( currentIndex !== -1 && currentIndex + 1 < index ) {
6500 index--;
6501 }
6502 remove.push( this.pages[name] );
6503 }
6504 }
6505 if ( remove.length ) {
6506 this.removePages( remove );
6507 }
6508
6509 // Add new pages
6510 for ( i = 0, len = pages.length; i < len; i++ ) {
6511 page = pages[i];
6512 name = page.getName();
6513 this.pages[page.getName()] = page;
6514 if ( this.outlined ) {
6515 item = new OO.ui.OutlineItemWidget( name, page, { $: this.$ } );
6516 page.setOutlineItem( item );
6517 items.push( item );
6518 }
6519 }
6520
6521 if ( this.outlined && items.length ) {
6522 this.outlineWidget.addItems( items, index );
6523 this.updateOutlineWidget();
6524 }
6525 this.stackLayout.addItems( pages, index );
6526 this.emit( 'add', pages, index );
6527
6528 return this;
6529 };
6530
6531 /**
6532 * Remove a page from the layout.
6533 *
6534 * @fires remove
6535 * @chainable
6536 */
6537 OO.ui.BookletLayout.prototype.removePages = function ( pages ) {
6538 var i, len, name, page,
6539 items = [];
6540
6541 for ( i = 0, len = pages.length; i < len; i++ ) {
6542 page = pages[i];
6543 name = page.getName();
6544 delete this.pages[name];
6545 if ( this.outlined ) {
6546 items.push( this.outlineWidget.getItemFromData( name ) );
6547 page.setOutlineItem( null );
6548 }
6549 }
6550 if ( this.outlined && items.length ) {
6551 this.outlineWidget.removeItems( items );
6552 this.updateOutlineWidget();
6553 }
6554 this.stackLayout.removeItems( pages );
6555 this.emit( 'remove', pages );
6556
6557 return this;
6558 };
6559
6560 /**
6561 * Clear all pages from the layout.
6562 *
6563 * @fires remove
6564 * @chainable
6565 */
6566 OO.ui.BookletLayout.prototype.clearPages = function () {
6567 var i, len,
6568 pages = this.stackLayout.getItems();
6569
6570 this.pages = {};
6571 this.currentPageName = null;
6572 if ( this.outlined ) {
6573 this.outlineWidget.clearItems();
6574 for ( i = 0, len = pages.length; i < len; i++ ) {
6575 pages[i].setOutlineItem( null );
6576 }
6577 }
6578 this.stackLayout.clearItems();
6579
6580 this.emit( 'remove', pages );
6581
6582 return this;
6583 };
6584
6585 /**
6586 * Set the current page by name.
6587 *
6588 * @fires set
6589 * @param {string} name Symbolic name of page
6590 */
6591 OO.ui.BookletLayout.prototype.setPage = function ( name ) {
6592 var selectedItem,
6593 $focused,
6594 page = this.pages[name];
6595
6596 if ( name !== this.currentPageName ) {
6597 if ( this.outlined ) {
6598 selectedItem = this.outlineWidget.getSelectedItem();
6599 if ( selectedItem && selectedItem.getData() !== name ) {
6600 this.outlineWidget.selectItem( this.outlineWidget.getItemFromData( name ) );
6601 }
6602 }
6603 if ( page ) {
6604 if ( this.currentPageName && this.pages[this.currentPageName] ) {
6605 this.pages[this.currentPageName].setActive( false );
6606 // Blur anything focused if the next page doesn't have anything focusable - this
6607 // is not needed if the next page has something focusable because once it is focused
6608 // this blur happens automatically
6609 if ( this.autoFocus && !page.$element.find( ':input' ).length ) {
6610 $focused = this.pages[this.currentPageName].$element.find( ':focus' );
6611 if ( $focused.length ) {
6612 $focused[0].blur();
6613 }
6614 }
6615 }
6616 this.currentPageName = name;
6617 this.stackLayout.setItem( page );
6618 page.setActive( true );
6619 this.emit( 'set', page );
6620 }
6621 }
6622 };
6623
6624 /**
6625 * Call this after adding or removing items from the OutlineWidget.
6626 *
6627 * @chainable
6628 */
6629 OO.ui.BookletLayout.prototype.updateOutlineWidget = function () {
6630 // Auto-select first item when nothing is selected anymore
6631 if ( !this.outlineWidget.getSelectedItem() ) {
6632 this.outlineWidget.selectItem( this.outlineWidget.getFirstSelectableItem() );
6633 }
6634
6635 return this;
6636 };
6637
6638 /**
6639 * Layout made of a field and optional label.
6640 *
6641 * Available label alignment modes include:
6642 * - left: Label is before the field and aligned away from it, best for when the user will be
6643 * scanning for a specific label in a form with many fields
6644 * - right: Label is before the field and aligned toward it, best for forms the user is very
6645 * familiar with and will tab through field checking quickly to verify which field they are in
6646 * - top: Label is before the field and above it, best for when the user will need to fill out all
6647 * fields from top to bottom in a form with few fields
6648 * - inline: Label is after the field and aligned toward it, best for small boolean fields like
6649 * checkboxes or radio buttons
6650 *
6651 * @class
6652 * @extends OO.ui.Layout
6653 * @mixins OO.ui.LabelElement
6654 *
6655 * @constructor
6656 * @param {OO.ui.Widget} fieldWidget Field widget
6657 * @param {Object} [config] Configuration options
6658 * @cfg {string} [align='left'] Alignment mode, either 'left', 'right', 'top' or 'inline'
6659 * @cfg {string} [help] Explanatory text shown as a '?' icon.
6660 */
6661 OO.ui.FieldLayout = function OoUiFieldLayout( fieldWidget, config ) {
6662 // Configuration initialization
6663 config = $.extend( { align: 'left' }, config );
6664
6665 // Parent constructor
6666 OO.ui.FieldLayout.super.call( this, config );
6667
6668 // Mixin constructors
6669 OO.ui.LabelElement.call( this, config );
6670
6671 // Properties
6672 this.$field = this.$( '<div>' );
6673 this.fieldWidget = fieldWidget;
6674 this.align = null;
6675 if ( config.help ) {
6676 this.popupButtonWidget = new OO.ui.PopupButtonWidget( {
6677 $: this.$,
6678 classes: [ 'oo-ui-fieldLayout-help' ],
6679 framed: false,
6680 icon: 'info'
6681 } );
6682
6683 this.popupButtonWidget.getPopup().$body.append(
6684 this.$( '<div>' )
6685 .text( config.help )
6686 .addClass( 'oo-ui-fieldLayout-help-content' )
6687 );
6688 this.$help = this.popupButtonWidget.$element;
6689 } else {
6690 this.$help = this.$( [] );
6691 }
6692
6693 // Events
6694 if ( this.fieldWidget instanceof OO.ui.InputWidget ) {
6695 this.$label.on( 'click', this.onLabelClick.bind( this ) );
6696 }
6697 this.fieldWidget.connect( this, { disable: 'onFieldDisable' } );
6698
6699 // Initialization
6700 this.$element.addClass( 'oo-ui-fieldLayout' );
6701 this.$field
6702 .addClass( 'oo-ui-fieldLayout-field' )
6703 .toggleClass( 'oo-ui-fieldLayout-disable', this.fieldWidget.isDisabled() )
6704 .append( this.fieldWidget.$element );
6705 this.setAlignment( config.align );
6706 };
6707
6708 /* Setup */
6709
6710 OO.inheritClass( OO.ui.FieldLayout, OO.ui.Layout );
6711 OO.mixinClass( OO.ui.FieldLayout, OO.ui.LabelElement );
6712
6713 /* Static Properties */
6714
6715 OO.ui.FieldLayout.static.tagName = 'label';
6716
6717 /* Methods */
6718
6719 /**
6720 * Handle field disable events.
6721 *
6722 * @param {boolean} value Field is disabled
6723 */
6724 OO.ui.FieldLayout.prototype.onFieldDisable = function ( value ) {
6725 this.$element.toggleClass( 'oo-ui-fieldLayout-disabled', value );
6726 };
6727
6728 /**
6729 * Handle label mouse click events.
6730 *
6731 * @param {jQuery.Event} e Mouse click event
6732 */
6733 OO.ui.FieldLayout.prototype.onLabelClick = function () {
6734 this.fieldWidget.simulateLabelClick();
6735 return false;
6736 };
6737
6738 /**
6739 * Get the field.
6740 *
6741 * @return {OO.ui.Widget} Field widget
6742 */
6743 OO.ui.FieldLayout.prototype.getField = function () {
6744 return this.fieldWidget;
6745 };
6746
6747 /**
6748 * Set the field alignment mode.
6749 *
6750 * @private
6751 * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
6752 * @chainable
6753 */
6754 OO.ui.FieldLayout.prototype.setAlignment = function ( value ) {
6755 if ( value !== this.align ) {
6756 // Default to 'left'
6757 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value ) === -1 ) {
6758 value = 'left';
6759 }
6760 // Reorder elements
6761 if ( value === 'inline' ) {
6762 this.$element.append( this.$field, this.$label, this.$help );
6763 } else {
6764 this.$element.append( this.$help, this.$label, this.$field );
6765 }
6766 // Set classes. The following classes can be used here:
6767 // * oo-ui-fieldLayout-align-left
6768 // * oo-ui-fieldLayout-align-right
6769 // * oo-ui-fieldLayout-align-top
6770 // * oo-ui-fieldLayout-align-inline
6771 if ( this.align ) {
6772 this.$element.removeClass( 'oo-ui-fieldLayout-align-' + this.align );
6773 }
6774 this.$element.addClass( 'oo-ui-fieldLayout-align-' + value );
6775 this.align = value;
6776 }
6777
6778 return this;
6779 };
6780
6781 /**
6782 * Layout made of a fieldset and optional legend.
6783 *
6784 * Just add OO.ui.FieldLayout items.
6785 *
6786 * @class
6787 * @extends OO.ui.Layout
6788 * @mixins OO.ui.IconElement
6789 * @mixins OO.ui.LabelElement
6790 * @mixins OO.ui.GroupElement
6791 *
6792 * @constructor
6793 * @param {Object} [config] Configuration options
6794 * @cfg {OO.ui.FieldLayout[]} [items] Items to add
6795 */
6796 OO.ui.FieldsetLayout = function OoUiFieldsetLayout( config ) {
6797 // Configuration initialization
6798 config = config || {};
6799
6800 // Parent constructor
6801 OO.ui.FieldsetLayout.super.call( this, config );
6802
6803 // Mixin constructors
6804 OO.ui.IconElement.call( this, config );
6805 OO.ui.LabelElement.call( this, config );
6806 OO.ui.GroupElement.call( this, config );
6807
6808 // Initialization
6809 this.$element
6810 .addClass( 'oo-ui-fieldsetLayout' )
6811 .prepend( this.$icon, this.$label, this.$group );
6812 if ( $.isArray( config.items ) ) {
6813 this.addItems( config.items );
6814 }
6815 };
6816
6817 /* Setup */
6818
6819 OO.inheritClass( OO.ui.FieldsetLayout, OO.ui.Layout );
6820 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.IconElement );
6821 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.LabelElement );
6822 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.GroupElement );
6823
6824 /**
6825 * Layout with an HTML form.
6826 *
6827 * @class
6828 * @extends OO.ui.Layout
6829 *
6830 * @constructor
6831 * @param {Object} [config] Configuration options
6832 * @cfg {string} [method] HTML form `method` attribute
6833 * @cfg {string} [action] HTML form `action` attribute
6834 * @cfg {string} [enctype] HTML form `enctype` attribute
6835 */
6836 OO.ui.FormLayout = function OoUiFormLayout( config ) {
6837 // Configuration initialization
6838 config = config || {};
6839
6840 // Parent constructor
6841 OO.ui.FormLayout.super.call( this, config );
6842
6843 // Events
6844 this.$element.on( 'submit', this.onFormSubmit.bind( this ) );
6845
6846 // Initialization
6847 this.$element
6848 .addClass( 'oo-ui-formLayout' )
6849 .attr( {
6850 method: config.method,
6851 action: config.action,
6852 enctype: config.enctype
6853 } );
6854 };
6855
6856 /* Setup */
6857
6858 OO.inheritClass( OO.ui.FormLayout, OO.ui.Layout );
6859
6860 /* Events */
6861
6862 /**
6863 * @event submit
6864 */
6865
6866 /* Static Properties */
6867
6868 OO.ui.FormLayout.static.tagName = 'form';
6869
6870 /* Methods */
6871
6872 /**
6873 * Handle form submit events.
6874 *
6875 * @param {jQuery.Event} e Submit event
6876 * @fires submit
6877 */
6878 OO.ui.FormLayout.prototype.onFormSubmit = function () {
6879 this.emit( 'submit' );
6880 return false;
6881 };
6882
6883 /**
6884 * Layout made of proportionally sized columns and rows.
6885 *
6886 * @class
6887 * @extends OO.ui.Layout
6888 *
6889 * @constructor
6890 * @param {OO.ui.PanelLayout[]} panels Panels in the grid
6891 * @param {Object} [config] Configuration options
6892 * @cfg {number[]} [widths] Widths of columns as ratios
6893 * @cfg {number[]} [heights] Heights of rows as ratios
6894 */
6895 OO.ui.GridLayout = function OoUiGridLayout( panels, config ) {
6896 var i, len, widths;
6897
6898 // Configuration initialization
6899 config = config || {};
6900
6901 // Parent constructor
6902 OO.ui.GridLayout.super.call( this, config );
6903
6904 // Properties
6905 this.panels = [];
6906 this.widths = [];
6907 this.heights = [];
6908
6909 // Initialization
6910 this.$element.addClass( 'oo-ui-gridLayout' );
6911 for ( i = 0, len = panels.length; i < len; i++ ) {
6912 this.panels.push( panels[i] );
6913 this.$element.append( panels[i].$element );
6914 }
6915 if ( config.widths || config.heights ) {
6916 this.layout( config.widths || [ 1 ], config.heights || [ 1 ] );
6917 } else {
6918 // Arrange in columns by default
6919 widths = this.panels.map( function () { return 1; } );
6920 this.layout( widths, [ 1 ] );
6921 }
6922 };
6923
6924 /* Setup */
6925
6926 OO.inheritClass( OO.ui.GridLayout, OO.ui.Layout );
6927
6928 /* Events */
6929
6930 /**
6931 * @event layout
6932 */
6933
6934 /**
6935 * @event update
6936 */
6937
6938 /* Methods */
6939
6940 /**
6941 * Set grid dimensions.
6942 *
6943 * @param {number[]} widths Widths of columns as ratios
6944 * @param {number[]} heights Heights of rows as ratios
6945 * @fires layout
6946 * @throws {Error} If grid is not large enough to fit all panels
6947 */
6948 OO.ui.GridLayout.prototype.layout = function ( widths, heights ) {
6949 var x, y,
6950 xd = 0,
6951 yd = 0,
6952 cols = widths.length,
6953 rows = heights.length;
6954
6955 // Verify grid is big enough to fit panels
6956 if ( cols * rows < this.panels.length ) {
6957 throw new Error( 'Grid is not large enough to fit ' + this.panels.length + 'panels' );
6958 }
6959
6960 // Sum up denominators
6961 for ( x = 0; x < cols; x++ ) {
6962 xd += widths[x];
6963 }
6964 for ( y = 0; y < rows; y++ ) {
6965 yd += heights[y];
6966 }
6967 // Store factors
6968 this.widths = [];
6969 this.heights = [];
6970 for ( x = 0; x < cols; x++ ) {
6971 this.widths[x] = widths[x] / xd;
6972 }
6973 for ( y = 0; y < rows; y++ ) {
6974 this.heights[y] = heights[y] / yd;
6975 }
6976 // Synchronize view
6977 this.update();
6978 this.emit( 'layout' );
6979 };
6980
6981 /**
6982 * Update panel positions and sizes.
6983 *
6984 * @fires update
6985 */
6986 OO.ui.GridLayout.prototype.update = function () {
6987 var x, y, panel, width, height, dimensions,
6988 i = 0,
6989 top = 0,
6990 left = 0,
6991 cols = this.widths.length,
6992 rows = this.heights.length;
6993
6994 for ( y = 0; y < rows; y++ ) {
6995 height = this.heights[y];
6996 for ( x = 0; x < cols; x++ ) {
6997 width = this.widths[x];
6998 panel = this.panels[i];
6999 dimensions = {
7000 width: Math.round( width * 100 ) + '%',
7001 height: Math.round( height * 100 ) + '%',
7002 top: Math.round( top * 100 ) + '%'
7003 };
7004 // If RTL, reverse:
7005 if ( OO.ui.Element.getDir( this.$.context ) === 'rtl' ) {
7006 dimensions.right = Math.round( left * 100 ) + '%';
7007 } else {
7008 dimensions.left = Math.round( left * 100 ) + '%';
7009 }
7010 // HACK: Work around IE bug by setting visibility: hidden; if width or height is zero
7011 if ( width === 0 || height === 0 ) {
7012 dimensions.visibility = 'hidden';
7013 } else {
7014 dimensions.visibility = '';
7015 }
7016 panel.$element.css( dimensions );
7017 i++;
7018 left += width;
7019 }
7020 top += height;
7021 left = 0;
7022 }
7023
7024 this.emit( 'update' );
7025 };
7026
7027 /**
7028 * Get a panel at a given position.
7029 *
7030 * The x and y position is affected by the current grid layout.
7031 *
7032 * @param {number} x Horizontal position
7033 * @param {number} y Vertical position
7034 * @return {OO.ui.PanelLayout} The panel at the given postion
7035 */
7036 OO.ui.GridLayout.prototype.getPanel = function ( x, y ) {
7037 return this.panels[ ( x * this.widths.length ) + y ];
7038 };
7039
7040 /**
7041 * Layout that expands to cover the entire area of its parent, with optional scrolling and padding.
7042 *
7043 * @class
7044 * @extends OO.ui.Layout
7045 *
7046 * @constructor
7047 * @param {Object} [config] Configuration options
7048 * @cfg {boolean} [scrollable=false] Allow vertical scrolling
7049 * @cfg {boolean} [padded=false] Pad the content from the edges
7050 * @cfg {boolean} [expanded=true] Expand size to fill the entire parent element
7051 */
7052 OO.ui.PanelLayout = function OoUiPanelLayout( config ) {
7053 // Configuration initialization
7054 config = $.extend( {
7055 scrollable: false,
7056 padded: false,
7057 expanded: true
7058 }, config );
7059
7060 // Parent constructor
7061 OO.ui.PanelLayout.super.call( this, config );
7062
7063 // Initialization
7064 this.$element.addClass( 'oo-ui-panelLayout' );
7065 if ( config.scrollable ) {
7066 this.$element.addClass( 'oo-ui-panelLayout-scrollable' );
7067 }
7068 if ( config.padded ) {
7069 this.$element.addClass( 'oo-ui-panelLayout-padded' );
7070 }
7071 if ( config.expanded ) {
7072 this.$element.addClass( 'oo-ui-panelLayout-expanded' );
7073 }
7074 };
7075
7076 /* Setup */
7077
7078 OO.inheritClass( OO.ui.PanelLayout, OO.ui.Layout );
7079
7080 /**
7081 * Page within an booklet layout.
7082 *
7083 * @class
7084 * @extends OO.ui.PanelLayout
7085 *
7086 * @constructor
7087 * @param {string} name Unique symbolic name of page
7088 * @param {Object} [config] Configuration options
7089 * @param {string} [outlineItem] Outline item widget
7090 */
7091 OO.ui.PageLayout = function OoUiPageLayout( name, config ) {
7092 // Configuration initialization
7093 config = $.extend( { scrollable: true }, config );
7094
7095 // Parent constructor
7096 OO.ui.PageLayout.super.call( this, config );
7097
7098 // Properties
7099 this.name = name;
7100 this.outlineItem = config.outlineItem || null;
7101 this.active = false;
7102
7103 // Initialization
7104 this.$element.addClass( 'oo-ui-pageLayout' );
7105 };
7106
7107 /* Setup */
7108
7109 OO.inheritClass( OO.ui.PageLayout, OO.ui.PanelLayout );
7110
7111 /* Events */
7112
7113 /**
7114 * @event active
7115 * @param {boolean} active Page is active
7116 */
7117
7118 /* Methods */
7119
7120 /**
7121 * Get page name.
7122 *
7123 * @return {string} Symbolic name of page
7124 */
7125 OO.ui.PageLayout.prototype.getName = function () {
7126 return this.name;
7127 };
7128
7129 /**
7130 * Check if page is active.
7131 *
7132 * @return {boolean} Page is active
7133 */
7134 OO.ui.PageLayout.prototype.isActive = function () {
7135 return this.active;
7136 };
7137
7138 /**
7139 * Get outline item.
7140 *
7141 * @return {OO.ui.OutlineItemWidget|null} Outline item widget
7142 */
7143 OO.ui.PageLayout.prototype.getOutlineItem = function () {
7144 return this.outlineItem;
7145 };
7146
7147 /**
7148 * Set outline item.
7149 *
7150 * @localdoc Subclasses should override #setupOutlineItem instead of this method to adjust the
7151 * outline item as desired; this method is called for setting (with an object) and unsetting
7152 * (with null) and overriding methods would have to check the value of `outlineItem` to avoid
7153 * operating on null instead of an OO.ui.OutlineItemWidget object.
7154 *
7155 * @param {OO.ui.OutlineItemWidget|null} outlineItem Outline item widget, null to clear
7156 * @chainable
7157 */
7158 OO.ui.PageLayout.prototype.setOutlineItem = function ( outlineItem ) {
7159 this.outlineItem = outlineItem || null;
7160 if ( outlineItem ) {
7161 this.setupOutlineItem();
7162 }
7163 return this;
7164 };
7165
7166 /**
7167 * Setup outline item.
7168 *
7169 * @localdoc Subclasses should override this method to adjust the outline item as desired.
7170 *
7171 * @param {OO.ui.OutlineItemWidget} outlineItem Outline item widget to setup
7172 * @chainable
7173 */
7174 OO.ui.PageLayout.prototype.setupOutlineItem = function () {
7175 return this;
7176 };
7177
7178 /**
7179 * Set page active state.
7180 *
7181 * @param {boolean} Page is active
7182 * @fires active
7183 */
7184 OO.ui.PageLayout.prototype.setActive = function ( active ) {
7185 active = !!active;
7186
7187 if ( active !== this.active ) {
7188 this.active = active;
7189 this.$element.toggleClass( 'oo-ui-pageLayout-active', active );
7190 this.emit( 'active', this.active );
7191 }
7192 };
7193
7194 /**
7195 * Layout containing a series of mutually exclusive pages.
7196 *
7197 * @class
7198 * @extends OO.ui.PanelLayout
7199 * @mixins OO.ui.GroupElement
7200 *
7201 * @constructor
7202 * @param {Object} [config] Configuration options
7203 * @cfg {boolean} [continuous=false] Show all pages, one after another
7204 * @cfg {string} [icon=''] Symbolic icon name
7205 * @cfg {OO.ui.Layout[]} [items] Layouts to add
7206 */
7207 OO.ui.StackLayout = function OoUiStackLayout( config ) {
7208 // Configuration initialization
7209 config = $.extend( { scrollable: true }, config );
7210
7211 // Parent constructor
7212 OO.ui.StackLayout.super.call( this, config );
7213
7214 // Mixin constructors
7215 OO.ui.GroupElement.call( this, $.extend( {}, config, { $group: this.$element } ) );
7216
7217 // Properties
7218 this.currentItem = null;
7219 this.continuous = !!config.continuous;
7220
7221 // Initialization
7222 this.$element.addClass( 'oo-ui-stackLayout' );
7223 if ( this.continuous ) {
7224 this.$element.addClass( 'oo-ui-stackLayout-continuous' );
7225 }
7226 if ( $.isArray( config.items ) ) {
7227 this.addItems( config.items );
7228 }
7229 };
7230
7231 /* Setup */
7232
7233 OO.inheritClass( OO.ui.StackLayout, OO.ui.PanelLayout );
7234 OO.mixinClass( OO.ui.StackLayout, OO.ui.GroupElement );
7235
7236 /* Events */
7237
7238 /**
7239 * @event set
7240 * @param {OO.ui.Layout|null} item Current item or null if there is no longer a layout shown
7241 */
7242
7243 /* Methods */
7244
7245 /**
7246 * Get the current item.
7247 *
7248 * @return {OO.ui.Layout|null}
7249 */
7250 OO.ui.StackLayout.prototype.getCurrentItem = function () {
7251 return this.currentItem;
7252 };
7253
7254 /**
7255 * Unset the current item.
7256 *
7257 * @private
7258 * @param {OO.ui.StackLayout} layout
7259 * @fires set
7260 */
7261 OO.ui.StackLayout.prototype.unsetCurrentItem = function () {
7262 var prevItem = this.currentItem;
7263 if ( prevItem === null ) {
7264 return;
7265 }
7266
7267 this.currentItem = null;
7268 this.emit( 'set', null );
7269 };
7270
7271 /**
7272 * Add items.
7273 *
7274 * Adding an existing item (by value) will move it.
7275 *
7276 * @param {OO.ui.Layout[]} items Items to add
7277 * @param {number} [index] Index to insert items after
7278 * @chainable
7279 */
7280 OO.ui.StackLayout.prototype.addItems = function ( items, index ) {
7281 // Mixin method
7282 OO.ui.GroupElement.prototype.addItems.call( this, items, index );
7283
7284 if ( !this.currentItem && items.length ) {
7285 this.setItem( items[0] );
7286 }
7287
7288 return this;
7289 };
7290
7291 /**
7292 * Remove items.
7293 *
7294 * Items will be detached, not removed, so they can be used later.
7295 *
7296 * @param {OO.ui.Layout[]} items Items to remove
7297 * @chainable
7298 * @fires set
7299 */
7300 OO.ui.StackLayout.prototype.removeItems = function ( items ) {
7301 // Mixin method
7302 OO.ui.GroupElement.prototype.removeItems.call( this, items );
7303
7304 if ( $.inArray( this.currentItem, items ) !== -1 ) {
7305 if ( this.items.length ) {
7306 this.setItem( this.items[0] );
7307 } else {
7308 this.unsetCurrentItem();
7309 }
7310 }
7311
7312 return this;
7313 };
7314
7315 /**
7316 * Clear all items.
7317 *
7318 * Items will be detached, not removed, so they can be used later.
7319 *
7320 * @chainable
7321 * @fires set
7322 */
7323 OO.ui.StackLayout.prototype.clearItems = function () {
7324 this.unsetCurrentItem();
7325 OO.ui.GroupElement.prototype.clearItems.call( this );
7326
7327 return this;
7328 };
7329
7330 /**
7331 * Show item.
7332 *
7333 * Any currently shown item will be hidden.
7334 *
7335 * FIXME: If the passed item to show has not been added in the items list, then
7336 * this method drops it and unsets the current item.
7337 *
7338 * @param {OO.ui.Layout} item Item to show
7339 * @chainable
7340 * @fires set
7341 */
7342 OO.ui.StackLayout.prototype.setItem = function ( item ) {
7343 var i, len;
7344
7345 if ( item !== this.currentItem ) {
7346 if ( !this.continuous ) {
7347 for ( i = 0, len = this.items.length; i < len; i++ ) {
7348 this.items[i].$element.css( 'display', '' );
7349 }
7350 }
7351 if ( $.inArray( item, this.items ) !== -1 ) {
7352 if ( !this.continuous ) {
7353 item.$element.css( 'display', 'block' );
7354 }
7355 this.currentItem = item;
7356 this.emit( 'set', item );
7357 } else {
7358 this.unsetCurrentItem();
7359 }
7360 }
7361
7362 return this;
7363 };
7364
7365 /**
7366 * Horizontal bar layout of tools as icon buttons.
7367 *
7368 * @class
7369 * @extends OO.ui.ToolGroup
7370 *
7371 * @constructor
7372 * @param {OO.ui.Toolbar} toolbar
7373 * @param {Object} [config] Configuration options
7374 */
7375 OO.ui.BarToolGroup = function OoUiBarToolGroup( toolbar, config ) {
7376 // Parent constructor
7377 OO.ui.BarToolGroup.super.call( this, toolbar, config );
7378
7379 // Initialization
7380 this.$element.addClass( 'oo-ui-barToolGroup' );
7381 };
7382
7383 /* Setup */
7384
7385 OO.inheritClass( OO.ui.BarToolGroup, OO.ui.ToolGroup );
7386
7387 /* Static Properties */
7388
7389 OO.ui.BarToolGroup.static.titleTooltips = true;
7390
7391 OO.ui.BarToolGroup.static.accelTooltips = true;
7392
7393 OO.ui.BarToolGroup.static.name = 'bar';
7394
7395 /**
7396 * Popup list of tools with an icon and optional label.
7397 *
7398 * @abstract
7399 * @class
7400 * @extends OO.ui.ToolGroup
7401 * @mixins OO.ui.IconElement
7402 * @mixins OO.ui.IndicatorElement
7403 * @mixins OO.ui.LabelElement
7404 * @mixins OO.ui.TitledElement
7405 * @mixins OO.ui.ClippableElement
7406 *
7407 * @constructor
7408 * @param {OO.ui.Toolbar} toolbar
7409 * @param {Object} [config] Configuration options
7410 * @cfg {string} [header] Text to display at the top of the pop-up
7411 */
7412 OO.ui.PopupToolGroup = function OoUiPopupToolGroup( toolbar, config ) {
7413 // Configuration initialization
7414 config = config || {};
7415
7416 // Parent constructor
7417 OO.ui.PopupToolGroup.super.call( this, toolbar, config );
7418
7419 // Mixin constructors
7420 OO.ui.IconElement.call( this, config );
7421 OO.ui.IndicatorElement.call( this, config );
7422 OO.ui.LabelElement.call( this, config );
7423 OO.ui.TitledElement.call( this, config );
7424 OO.ui.ClippableElement.call( this, $.extend( {}, config, { $clippable: this.$group } ) );
7425
7426 // Properties
7427 this.active = false;
7428 this.dragging = false;
7429 this.onBlurHandler = this.onBlur.bind( this );
7430 this.$handle = this.$( '<span>' );
7431
7432 // Events
7433 this.$handle.on( {
7434 'mousedown touchstart': this.onHandlePointerDown.bind( this ),
7435 'mouseup touchend': this.onHandlePointerUp.bind( this )
7436 } );
7437
7438 // Initialization
7439 this.$handle
7440 .addClass( 'oo-ui-popupToolGroup-handle' )
7441 .append( this.$icon, this.$label, this.$indicator );
7442 // If the pop-up should have a header, add it to the top of the toolGroup.
7443 // Note: If this feature is useful for other widgets, we could abstract it into an
7444 // OO.ui.HeaderedElement mixin constructor.
7445 if ( config.header !== undefined ) {
7446 this.$group
7447 .prepend( this.$( '<span>' )
7448 .addClass( 'oo-ui-popupToolGroup-header' )
7449 .text( config.header )
7450 );
7451 }
7452 this.$element
7453 .addClass( 'oo-ui-popupToolGroup' )
7454 .prepend( this.$handle );
7455 };
7456
7457 /* Setup */
7458
7459 OO.inheritClass( OO.ui.PopupToolGroup, OO.ui.ToolGroup );
7460 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.IconElement );
7461 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.IndicatorElement );
7462 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.LabelElement );
7463 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.TitledElement );
7464 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.ClippableElement );
7465
7466 /* Static Properties */
7467
7468 /* Methods */
7469
7470 /**
7471 * @inheritdoc
7472 */
7473 OO.ui.PopupToolGroup.prototype.setDisabled = function () {
7474 // Parent method
7475 OO.ui.PopupToolGroup.super.prototype.setDisabled.apply( this, arguments );
7476
7477 if ( this.isDisabled() && this.isElementAttached() ) {
7478 this.setActive( false );
7479 }
7480 };
7481
7482 /**
7483 * Handle focus being lost.
7484 *
7485 * The event is actually generated from a mouseup, so it is not a normal blur event object.
7486 *
7487 * @param {jQuery.Event} e Mouse up event
7488 */
7489 OO.ui.PopupToolGroup.prototype.onBlur = function ( e ) {
7490 // Only deactivate when clicking outside the dropdown element
7491 if ( this.$( e.target ).closest( '.oo-ui-popupToolGroup' )[0] !== this.$element[0] ) {
7492 this.setActive( false );
7493 }
7494 };
7495
7496 /**
7497 * @inheritdoc
7498 */
7499 OO.ui.PopupToolGroup.prototype.onPointerUp = function ( e ) {
7500 // e.which is 0 for touch events, 1 for left mouse button
7501 // Only close toolgroup when a tool was actually selected
7502 // FIXME: this duplicates logic from the parent class
7503 if ( !this.isDisabled() && e.which <= 1 && this.pressed && this.pressed === this.getTargetTool( e ) ) {
7504 this.setActive( false );
7505 }
7506 return OO.ui.PopupToolGroup.super.prototype.onPointerUp.call( this, e );
7507 };
7508
7509 /**
7510 * Handle mouse up events.
7511 *
7512 * @param {jQuery.Event} e Mouse up event
7513 */
7514 OO.ui.PopupToolGroup.prototype.onHandlePointerUp = function () {
7515 return false;
7516 };
7517
7518 /**
7519 * Handle mouse down events.
7520 *
7521 * @param {jQuery.Event} e Mouse down event
7522 */
7523 OO.ui.PopupToolGroup.prototype.onHandlePointerDown = function ( e ) {
7524 // e.which is 0 for touch events, 1 for left mouse button
7525 if ( !this.isDisabled() && e.which <= 1 ) {
7526 this.setActive( !this.active );
7527 }
7528 return false;
7529 };
7530
7531 /**
7532 * Switch into active mode.
7533 *
7534 * When active, mouseup events anywhere in the document will trigger deactivation.
7535 */
7536 OO.ui.PopupToolGroup.prototype.setActive = function ( value ) {
7537 value = !!value;
7538 if ( this.active !== value ) {
7539 this.active = value;
7540 if ( value ) {
7541 this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler, true );
7542
7543 // Try anchoring the popup to the left first
7544 this.$element.addClass( 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left' );
7545 this.toggleClipping( true );
7546 if ( this.isClippedHorizontally() ) {
7547 // Anchoring to the left caused the popup to clip, so anchor it to the right instead
7548 this.toggleClipping( false );
7549 this.$element
7550 .removeClass( 'oo-ui-popupToolGroup-left' )
7551 .addClass( 'oo-ui-popupToolGroup-right' );
7552 this.toggleClipping( true );
7553 }
7554 } else {
7555 this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler, true );
7556 this.$element.removeClass(
7557 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left oo-ui-popupToolGroup-right'
7558 );
7559 this.toggleClipping( false );
7560 }
7561 }
7562 };
7563
7564 /**
7565 * Drop down list layout of tools as labeled icon buttons.
7566 *
7567 * This layout allows some tools to be collapsible, controlled by a "More" / "Fewer" option at the
7568 * bottom of the main list. These are not automatically positioned at the bottom of the list; you
7569 * may want to use the 'promote' and 'demote' configuration options to achieve this.
7570 *
7571 * @class
7572 * @extends OO.ui.PopupToolGroup
7573 *
7574 * @constructor
7575 * @param {OO.ui.Toolbar} toolbar
7576 * @param {Object} [config] Configuration options
7577 * @cfg {Array} [allowCollapse] List of tools that can be collapsed. Remaining tools will be always
7578 * shown.
7579 * @cfg {Array} [forceExpand] List of tools that *may not* be collapsed. All remaining tools will be
7580 * allowed to be collapsed.
7581 * @cfg {boolean} [expanded=false] Whether the collapsible tools are expanded by default
7582 */
7583 OO.ui.ListToolGroup = function OoUiListToolGroup( toolbar, config ) {
7584 // Configuration intialization
7585 config = config || {};
7586
7587 // Properties (must be set before parent constructor, which calls #populate)
7588 this.allowCollapse = config.allowCollapse;
7589 this.forceExpand = config.forceExpand;
7590 this.expanded = config.expanded !== undefined ? config.expanded : false;
7591 this.collapsibleTools = [];
7592
7593 // Parent constructor
7594 OO.ui.ListToolGroup.super.call( this, toolbar, config );
7595
7596 // Initialization
7597 this.$element.addClass( 'oo-ui-listToolGroup' );
7598 };
7599
7600 /* Setup */
7601
7602 OO.inheritClass( OO.ui.ListToolGroup, OO.ui.PopupToolGroup );
7603
7604 /* Static Properties */
7605
7606 OO.ui.ListToolGroup.static.accelTooltips = true;
7607
7608 OO.ui.ListToolGroup.static.name = 'list';
7609
7610 /* Methods */
7611
7612 /**
7613 * @inheritdoc
7614 */
7615 OO.ui.ListToolGroup.prototype.populate = function () {
7616 var i, len, allowCollapse = [];
7617
7618 OO.ui.ListToolGroup.super.prototype.populate.call( this );
7619
7620 // Update the list of collapsible tools
7621 if ( this.allowCollapse !== undefined ) {
7622 allowCollapse = this.allowCollapse;
7623 } else if ( this.forceExpand !== undefined ) {
7624 allowCollapse = OO.simpleArrayDifference( Object.keys( this.tools ), this.forceExpand );
7625 }
7626
7627 this.collapsibleTools = [];
7628 for ( i = 0, len = allowCollapse.length; i < len; i++ ) {
7629 if ( this.tools[ allowCollapse[i] ] !== undefined ) {
7630 this.collapsibleTools.push( this.tools[ allowCollapse[i] ] );
7631 }
7632 }
7633
7634 // Keep at the end, even when tools are added
7635 this.$group.append( this.getExpandCollapseTool().$element );
7636
7637 this.getExpandCollapseTool().toggle( this.collapsibleTools.length !== 0 );
7638
7639 // Calling jQuery's .hide() and then .show() on a detached element caches the default value of its
7640 // 'display' attribute and restores it, and the tool uses a <span> and can be hidden and re-shown.
7641 // Is this a jQuery bug? http://jsfiddle.net/gtj4hu3h/
7642 if ( this.getExpandCollapseTool().$element.css( 'display' ) === 'inline' ) {
7643 this.getExpandCollapseTool().$element.css( 'display', 'inline-block' );
7644 }
7645
7646 this.updateCollapsibleState();
7647 };
7648
7649 OO.ui.ListToolGroup.prototype.getExpandCollapseTool = function () {
7650 if ( this.expandCollapseTool === undefined ) {
7651 var ExpandCollapseTool = function () {
7652 ExpandCollapseTool.super.apply( this, arguments );
7653 };
7654
7655 OO.inheritClass( ExpandCollapseTool, OO.ui.Tool );
7656
7657 ExpandCollapseTool.prototype.onSelect = function () {
7658 this.toolGroup.expanded = !this.toolGroup.expanded;
7659 this.toolGroup.updateCollapsibleState();
7660 this.setActive( false );
7661 };
7662 ExpandCollapseTool.prototype.onUpdateState = function () {
7663 // Do nothing. Tool interface requires an implementation of this function.
7664 };
7665
7666 ExpandCollapseTool.static.name = 'more-fewer';
7667
7668 this.expandCollapseTool = new ExpandCollapseTool( this );
7669 }
7670 return this.expandCollapseTool;
7671 };
7672
7673 /**
7674 * @inheritdoc
7675 */
7676 OO.ui.ListToolGroup.prototype.onPointerUp = function ( e ) {
7677 var ret = OO.ui.ListToolGroup.super.prototype.onPointerUp.call( this, e );
7678
7679 // Do not close the popup when the user wants to show more/fewer tools
7680 if ( this.$( e.target ).closest( '.oo-ui-tool-name-more-fewer' ).length ) {
7681 // Prevent the popup list from being hidden
7682 this.setActive( true );
7683 }
7684
7685 return ret;
7686 };
7687
7688 OO.ui.ListToolGroup.prototype.updateCollapsibleState = function () {
7689 var i, len;
7690
7691 this.getExpandCollapseTool()
7692 .setIcon( this.expanded ? 'collapse' : 'expand' )
7693 .setTitle( OO.ui.msg( this.expanded ? 'ooui-toolgroup-collapse' : 'ooui-toolgroup-expand' ) );
7694
7695 for ( i = 0, len = this.collapsibleTools.length; i < len; i++ ) {
7696 this.collapsibleTools[i].toggle( this.expanded );
7697 }
7698 };
7699
7700 /**
7701 * Drop down menu layout of tools as selectable menu items.
7702 *
7703 * @class
7704 * @extends OO.ui.PopupToolGroup
7705 *
7706 * @constructor
7707 * @param {OO.ui.Toolbar} toolbar
7708 * @param {Object} [config] Configuration options
7709 */
7710 OO.ui.MenuToolGroup = function OoUiMenuToolGroup( toolbar, config ) {
7711 // Configuration initialization
7712 config = config || {};
7713
7714 // Parent constructor
7715 OO.ui.MenuToolGroup.super.call( this, toolbar, config );
7716
7717 // Events
7718 this.toolbar.connect( this, { updateState: 'onUpdateState' } );
7719
7720 // Initialization
7721 this.$element.addClass( 'oo-ui-menuToolGroup' );
7722 };
7723
7724 /* Setup */
7725
7726 OO.inheritClass( OO.ui.MenuToolGroup, OO.ui.PopupToolGroup );
7727
7728 /* Static Properties */
7729
7730 OO.ui.MenuToolGroup.static.accelTooltips = true;
7731
7732 OO.ui.MenuToolGroup.static.name = 'menu';
7733
7734 /* Methods */
7735
7736 /**
7737 * Handle the toolbar state being updated.
7738 *
7739 * When the state changes, the title of each active item in the menu will be joined together and
7740 * used as a label for the group. The label will be empty if none of the items are active.
7741 */
7742 OO.ui.MenuToolGroup.prototype.onUpdateState = function () {
7743 var name,
7744 labelTexts = [];
7745
7746 for ( name in this.tools ) {
7747 if ( this.tools[name].isActive() ) {
7748 labelTexts.push( this.tools[name].getTitle() );
7749 }
7750 }
7751
7752 this.setLabel( labelTexts.join( ', ' ) || ' ' );
7753 };
7754
7755 /**
7756 * Tool that shows a popup when selected.
7757 *
7758 * @abstract
7759 * @class
7760 * @extends OO.ui.Tool
7761 * @mixins OO.ui.PopupElement
7762 *
7763 * @constructor
7764 * @param {OO.ui.Toolbar} toolbar
7765 * @param {Object} [config] Configuration options
7766 */
7767 OO.ui.PopupTool = function OoUiPopupTool( toolbar, config ) {
7768 // Parent constructor
7769 OO.ui.PopupTool.super.call( this, toolbar, config );
7770
7771 // Mixin constructors
7772 OO.ui.PopupElement.call( this, config );
7773
7774 // Initialization
7775 this.$element
7776 .addClass( 'oo-ui-popupTool' )
7777 .append( this.popup.$element );
7778 };
7779
7780 /* Setup */
7781
7782 OO.inheritClass( OO.ui.PopupTool, OO.ui.Tool );
7783 OO.mixinClass( OO.ui.PopupTool, OO.ui.PopupElement );
7784
7785 /* Methods */
7786
7787 /**
7788 * Handle the tool being selected.
7789 *
7790 * @inheritdoc
7791 */
7792 OO.ui.PopupTool.prototype.onSelect = function () {
7793 if ( !this.isDisabled() ) {
7794 this.popup.toggle();
7795 }
7796 this.setActive( false );
7797 return false;
7798 };
7799
7800 /**
7801 * Handle the toolbar state being updated.
7802 *
7803 * @inheritdoc
7804 */
7805 OO.ui.PopupTool.prototype.onUpdateState = function () {
7806 this.setActive( false );
7807 };
7808
7809 /**
7810 * Mixin for OO.ui.Widget subclasses to provide OO.ui.GroupElement.
7811 *
7812 * Use together with OO.ui.ItemWidget to make disabled state inheritable.
7813 *
7814 * @abstract
7815 * @class
7816 * @extends OO.ui.GroupElement
7817 *
7818 * @constructor
7819 * @param {Object} [config] Configuration options
7820 */
7821 OO.ui.GroupWidget = function OoUiGroupWidget( config ) {
7822 // Parent constructor
7823 OO.ui.GroupWidget.super.call( this, config );
7824 };
7825
7826 /* Setup */
7827
7828 OO.inheritClass( OO.ui.GroupWidget, OO.ui.GroupElement );
7829
7830 /* Methods */
7831
7832 /**
7833 * Set the disabled state of the widget.
7834 *
7835 * This will also update the disabled state of child widgets.
7836 *
7837 * @param {boolean} disabled Disable widget
7838 * @chainable
7839 */
7840 OO.ui.GroupWidget.prototype.setDisabled = function ( disabled ) {
7841 var i, len;
7842
7843 // Parent method
7844 // Note: Calling #setDisabled this way assumes this is mixed into an OO.ui.Widget
7845 OO.ui.Widget.prototype.setDisabled.call( this, disabled );
7846
7847 // During construction, #setDisabled is called before the OO.ui.GroupElement constructor
7848 if ( this.items ) {
7849 for ( i = 0, len = this.items.length; i < len; i++ ) {
7850 this.items[i].updateDisabled();
7851 }
7852 }
7853
7854 return this;
7855 };
7856
7857 /**
7858 * Mixin for widgets used as items in widgets that inherit OO.ui.GroupWidget.
7859 *
7860 * Item widgets have a reference to a OO.ui.GroupWidget while they are attached to the group. This
7861 * allows bidrectional communication.
7862 *
7863 * Use together with OO.ui.GroupWidget to make disabled state inheritable.
7864 *
7865 * @abstract
7866 * @class
7867 *
7868 * @constructor
7869 */
7870 OO.ui.ItemWidget = function OoUiItemWidget() {
7871 //
7872 };
7873
7874 /* Methods */
7875
7876 /**
7877 * Check if widget is disabled.
7878 *
7879 * Checks parent if present, making disabled state inheritable.
7880 *
7881 * @return {boolean} Widget is disabled
7882 */
7883 OO.ui.ItemWidget.prototype.isDisabled = function () {
7884 return this.disabled ||
7885 ( this.elementGroup instanceof OO.ui.Widget && this.elementGroup.isDisabled() );
7886 };
7887
7888 /**
7889 * Set group element is in.
7890 *
7891 * @param {OO.ui.GroupElement|null} group Group element, null if none
7892 * @chainable
7893 */
7894 OO.ui.ItemWidget.prototype.setElementGroup = function ( group ) {
7895 // Parent method
7896 // Note: Calling #setElementGroup this way assumes this is mixed into an OO.ui.Element
7897 OO.ui.Element.prototype.setElementGroup.call( this, group );
7898
7899 // Initialize item disabled states
7900 this.updateDisabled();
7901
7902 return this;
7903 };
7904
7905 /**
7906 * Mixin that adds a menu showing suggested values for a text input.
7907 *
7908 * Subclasses must handle `select` and `choose` events on #lookupMenu to make use of selections.
7909 *
7910 * Subclasses that set the value of #lookupInput from their `choose` or `select` handler should
7911 * be aware that this will cause new suggestions to be looked up for the new value. If this is
7912 * not desired, disable lookups with #setLookupsDisabled, then set the value, then re-enable lookups.
7913 *
7914 * @class
7915 * @abstract
7916 *
7917 * @constructor
7918 * @param {OO.ui.TextInputWidget} input Input widget
7919 * @param {Object} [config] Configuration options
7920 * @cfg {jQuery} [$overlay] Overlay for dropdown; defaults to relative positioning
7921 * @cfg {jQuery} [$container=input.$element] Element to render menu under
7922 */
7923 OO.ui.LookupInputWidget = function OoUiLookupInputWidget( input, config ) {
7924 // Configuration initialization
7925 config = config || {};
7926
7927 // Properties
7928 this.lookupInput = input;
7929 this.$overlay = config.$overlay || this.$element;
7930 this.lookupMenu = new OO.ui.TextInputMenuWidget( this, {
7931 $: OO.ui.Element.getJQuery( this.$overlay ),
7932 input: this.lookupInput,
7933 $container: config.$container
7934 } );
7935 this.lookupCache = {};
7936 this.lookupQuery = null;
7937 this.lookupRequest = null;
7938 this.lookupsDisabled = false;
7939 this.lookupInputFocused = false;
7940
7941 // Events
7942 this.lookupInput.$input.on( {
7943 focus: this.onLookupInputFocus.bind( this ),
7944 blur: this.onLookupInputBlur.bind( this ),
7945 mousedown: this.onLookupInputMouseDown.bind( this )
7946 } );
7947 this.lookupInput.connect( this, { change: 'onLookupInputChange' } );
7948 this.lookupMenu.connect( this, { toggle: 'onLookupMenuToggle' } );
7949
7950 // Initialization
7951 this.$element.addClass( 'oo-ui-lookupWidget' );
7952 this.lookupMenu.$element.addClass( 'oo-ui-lookupWidget-menu' );
7953 this.$overlay.append( this.lookupMenu.$element );
7954 };
7955
7956 /* Methods */
7957
7958 /**
7959 * Handle input focus event.
7960 *
7961 * @param {jQuery.Event} e Input focus event
7962 */
7963 OO.ui.LookupInputWidget.prototype.onLookupInputFocus = function () {
7964 this.lookupInputFocused = true;
7965 this.populateLookupMenu();
7966 };
7967
7968 /**
7969 * Handle input blur event.
7970 *
7971 * @param {jQuery.Event} e Input blur event
7972 */
7973 OO.ui.LookupInputWidget.prototype.onLookupInputBlur = function () {
7974 this.closeLookupMenu();
7975 this.lookupInputFocused = false;
7976 };
7977
7978 /**
7979 * Handle input mouse down event.
7980 *
7981 * @param {jQuery.Event} e Input mouse down event
7982 */
7983 OO.ui.LookupInputWidget.prototype.onLookupInputMouseDown = function () {
7984 // Only open the menu if the input was already focused.
7985 // This way we allow the user to open the menu again after closing it with Esc
7986 // by clicking in the input. Opening (and populating) the menu when initially
7987 // clicking into the input is handled by the focus handler.
7988 if ( this.lookupInputFocused && !this.lookupMenu.isVisible() ) {
7989 this.populateLookupMenu();
7990 }
7991 };
7992
7993 /**
7994 * Handle input change event.
7995 *
7996 * @param {string} value New input value
7997 */
7998 OO.ui.LookupInputWidget.prototype.onLookupInputChange = function () {
7999 if ( this.lookupInputFocused ) {
8000 this.populateLookupMenu();
8001 }
8002 };
8003
8004 /**
8005 * Handle the lookup menu being shown/hidden.
8006 * @param {boolean} visible Whether the lookup menu is now visible.
8007 */
8008 OO.ui.LookupInputWidget.prototype.onLookupMenuToggle = function ( visible ) {
8009 if ( !visible ) {
8010 // When the menu is hidden, abort any active request and clear the menu.
8011 // This has to be done here in addition to closeLookupMenu(), because
8012 // MenuWidget will close itself when the user presses Esc.
8013 this.abortLookupRequest();
8014 this.lookupMenu.clearItems();
8015 }
8016 };
8017
8018 /**
8019 * Get lookup menu.
8020 *
8021 * @return {OO.ui.TextInputMenuWidget}
8022 */
8023 OO.ui.LookupInputWidget.prototype.getLookupMenu = function () {
8024 return this.lookupMenu;
8025 };
8026
8027 /**
8028 * Disable or re-enable lookups.
8029 *
8030 * When lookups are disabled, calls to #populateLookupMenu will be ignored.
8031 *
8032 * @param {boolean} disabled Disable lookups
8033 */
8034 OO.ui.LookupInputWidget.prototype.setLookupsDisabled = function ( disabled ) {
8035 this.lookupsDisabled = !!disabled;
8036 };
8037
8038 /**
8039 * Open the menu. If there are no entries in the menu, this does nothing.
8040 *
8041 * @chainable
8042 */
8043 OO.ui.LookupInputWidget.prototype.openLookupMenu = function () {
8044 if ( !this.lookupMenu.isEmpty() ) {
8045 this.lookupMenu.toggle( true );
8046 }
8047 return this;
8048 };
8049
8050 /**
8051 * Close the menu, empty it, and abort any pending request.
8052 *
8053 * @chainable
8054 */
8055 OO.ui.LookupInputWidget.prototype.closeLookupMenu = function () {
8056 this.lookupMenu.toggle( false );
8057 this.abortLookupRequest();
8058 this.lookupMenu.clearItems();
8059 return this;
8060 };
8061
8062 /**
8063 * Request menu items based on the input's current value, and when they arrive,
8064 * populate the menu with these items and show the menu.
8065 *
8066 * If lookups have been disabled with #setLookupsDisabled, this function does nothing.
8067 *
8068 * @chainable
8069 */
8070 OO.ui.LookupInputWidget.prototype.populateLookupMenu = function () {
8071 var widget = this,
8072 value = this.lookupInput.getValue();
8073
8074 if ( this.lookupsDisabled ) {
8075 return;
8076 }
8077
8078 // If the input is empty, clear the menu
8079 if ( value === '' ) {
8080 this.closeLookupMenu();
8081 // Skip population if there is already a request pending for the current value
8082 } else if ( value !== this.lookupQuery ) {
8083 this.getLookupMenuItems()
8084 .done( function ( items ) {
8085 widget.lookupMenu.clearItems();
8086 if ( items.length ) {
8087 widget.lookupMenu
8088 .addItems( items )
8089 .toggle( true );
8090 widget.initializeLookupMenuSelection();
8091 } else {
8092 widget.lookupMenu.toggle( false );
8093 }
8094 } )
8095 .fail( function () {
8096 widget.lookupMenu.clearItems();
8097 } );
8098 }
8099
8100 return this;
8101 };
8102
8103 /**
8104 * Select and highlight the first selectable item in the menu.
8105 *
8106 * @chainable
8107 */
8108 OO.ui.LookupInputWidget.prototype.initializeLookupMenuSelection = function () {
8109 if ( !this.lookupMenu.getSelectedItem() ) {
8110 this.lookupMenu.selectItem( this.lookupMenu.getFirstSelectableItem() );
8111 }
8112 this.lookupMenu.highlightItem( this.lookupMenu.getSelectedItem() );
8113 };
8114
8115 /**
8116 * Get lookup menu items for the current query.
8117 *
8118 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument
8119 * of the done event. If the request was aborted to make way for a subsequent request,
8120 * this promise will not be rejected: it will remain pending forever.
8121 */
8122 OO.ui.LookupInputWidget.prototype.getLookupMenuItems = function () {
8123 var widget = this,
8124 value = this.lookupInput.getValue(),
8125 deferred = $.Deferred(),
8126 ourRequest;
8127
8128 this.abortLookupRequest();
8129 if ( Object.prototype.hasOwnProperty.call( this.lookupCache, value ) ) {
8130 deferred.resolve( this.getLookupMenuItemsFromData( this.lookupCache[value] ) );
8131 } else {
8132 this.lookupInput.pushPending();
8133 this.lookupQuery = value;
8134 ourRequest = this.lookupRequest = this.getLookupRequest();
8135 ourRequest
8136 .always( function () {
8137 // We need to pop pending even if this is an old request, otherwise
8138 // the widget will remain pending forever.
8139 // TODO: this assumes that an aborted request will fail or succeed soon after
8140 // being aborted, or at least eventually. It would be nice if we could popPending()
8141 // at abort time, but only if we knew that we hadn't already called popPending()
8142 // for that request.
8143 widget.lookupInput.popPending();
8144 } )
8145 .done( function ( data ) {
8146 // If this is an old request (and aborting it somehow caused it to still succeed),
8147 // ignore its success completely
8148 if ( ourRequest === widget.lookupRequest ) {
8149 widget.lookupQuery = null;
8150 widget.lookupRequest = null;
8151 widget.lookupCache[value] = widget.getLookupCacheItemFromData( data );
8152 deferred.resolve( widget.getLookupMenuItemsFromData( widget.lookupCache[value] ) );
8153 }
8154 } )
8155 .fail( function () {
8156 // If this is an old request (or a request failing because it's being aborted),
8157 // ignore its failure completely
8158 if ( ourRequest === widget.lookupRequest ) {
8159 widget.lookupQuery = null;
8160 widget.lookupRequest = null;
8161 deferred.reject();
8162 }
8163 } );
8164 }
8165 return deferred.promise();
8166 };
8167
8168 /**
8169 * Abort the currently pending lookup request, if any.
8170 */
8171 OO.ui.LookupInputWidget.prototype.abortLookupRequest = function () {
8172 var oldRequest = this.lookupRequest;
8173 if ( oldRequest ) {
8174 // First unset this.lookupRequest to the fail handler will notice
8175 // that the request is no longer current
8176 this.lookupRequest = null;
8177 this.lookupQuery = null;
8178 oldRequest.abort();
8179 }
8180 };
8181
8182 /**
8183 * Get a new request object of the current lookup query value.
8184 *
8185 * @abstract
8186 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
8187 */
8188 OO.ui.LookupInputWidget.prototype.getLookupRequest = function () {
8189 // Stub, implemented in subclass
8190 return null;
8191 };
8192
8193 /**
8194 * Get a list of menu item widgets from the data stored by the lookup request's done handler.
8195 *
8196 * @abstract
8197 * @param {Mixed} data Cached result data, usually an array
8198 * @return {OO.ui.MenuItemWidget[]} Menu items
8199 */
8200 OO.ui.LookupInputWidget.prototype.getLookupMenuItemsFromData = function () {
8201 // Stub, implemented in subclass
8202 return [];
8203 };
8204
8205 /**
8206 * Get lookup cache item from server response data.
8207 *
8208 * @abstract
8209 * @param {Mixed} data Response from server
8210 * @return {Mixed} Cached result data
8211 */
8212 OO.ui.LookupInputWidget.prototype.getLookupCacheItemFromData = function () {
8213 // Stub, implemented in subclass
8214 return [];
8215 };
8216
8217 /**
8218 * Set of controls for an OO.ui.OutlineWidget.
8219 *
8220 * Controls include moving items up and down, removing items, and adding different kinds of items.
8221 *
8222 * @class
8223 * @extends OO.ui.Widget
8224 * @mixins OO.ui.GroupElement
8225 * @mixins OO.ui.IconElement
8226 *
8227 * @constructor
8228 * @param {OO.ui.OutlineWidget} outline Outline to control
8229 * @param {Object} [config] Configuration options
8230 */
8231 OO.ui.OutlineControlsWidget = function OoUiOutlineControlsWidget( outline, config ) {
8232 // Configuration initialization
8233 config = $.extend( { icon: 'add' }, config );
8234
8235 // Parent constructor
8236 OO.ui.OutlineControlsWidget.super.call( this, config );
8237
8238 // Mixin constructors
8239 OO.ui.GroupElement.call( this, config );
8240 OO.ui.IconElement.call( this, config );
8241
8242 // Properties
8243 this.outline = outline;
8244 this.$movers = this.$( '<div>' );
8245 this.upButton = new OO.ui.ButtonWidget( {
8246 $: this.$,
8247 framed: false,
8248 icon: 'collapse',
8249 title: OO.ui.msg( 'ooui-outline-control-move-up' )
8250 } );
8251 this.downButton = new OO.ui.ButtonWidget( {
8252 $: this.$,
8253 framed: false,
8254 icon: 'expand',
8255 title: OO.ui.msg( 'ooui-outline-control-move-down' )
8256 } );
8257 this.removeButton = new OO.ui.ButtonWidget( {
8258 $: this.$,
8259 framed: false,
8260 icon: 'remove',
8261 title: OO.ui.msg( 'ooui-outline-control-remove' )
8262 } );
8263
8264 // Events
8265 outline.connect( this, {
8266 select: 'onOutlineChange',
8267 add: 'onOutlineChange',
8268 remove: 'onOutlineChange'
8269 } );
8270 this.upButton.connect( this, { click: [ 'emit', 'move', -1 ] } );
8271 this.downButton.connect( this, { click: [ 'emit', 'move', 1 ] } );
8272 this.removeButton.connect( this, { click: [ 'emit', 'remove' ] } );
8273
8274 // Initialization
8275 this.$element.addClass( 'oo-ui-outlineControlsWidget' );
8276 this.$group.addClass( 'oo-ui-outlineControlsWidget-items' );
8277 this.$movers
8278 .addClass( 'oo-ui-outlineControlsWidget-movers' )
8279 .append( this.removeButton.$element, this.upButton.$element, this.downButton.$element );
8280 this.$element.append( this.$icon, this.$group, this.$movers );
8281 };
8282
8283 /* Setup */
8284
8285 OO.inheritClass( OO.ui.OutlineControlsWidget, OO.ui.Widget );
8286 OO.mixinClass( OO.ui.OutlineControlsWidget, OO.ui.GroupElement );
8287 OO.mixinClass( OO.ui.OutlineControlsWidget, OO.ui.IconElement );
8288
8289 /* Events */
8290
8291 /**
8292 * @event move
8293 * @param {number} places Number of places to move
8294 */
8295
8296 /**
8297 * @event remove
8298 */
8299
8300 /* Methods */
8301
8302 /**
8303 * Handle outline change events.
8304 */
8305 OO.ui.OutlineControlsWidget.prototype.onOutlineChange = function () {
8306 var i, len, firstMovable, lastMovable,
8307 items = this.outline.getItems(),
8308 selectedItem = this.outline.getSelectedItem(),
8309 movable = selectedItem && selectedItem.isMovable(),
8310 removable = selectedItem && selectedItem.isRemovable();
8311
8312 if ( movable ) {
8313 i = -1;
8314 len = items.length;
8315 while ( ++i < len ) {
8316 if ( items[i].isMovable() ) {
8317 firstMovable = items[i];
8318 break;
8319 }
8320 }
8321 i = len;
8322 while ( i-- ) {
8323 if ( items[i].isMovable() ) {
8324 lastMovable = items[i];
8325 break;
8326 }
8327 }
8328 }
8329 this.upButton.setDisabled( !movable || selectedItem === firstMovable );
8330 this.downButton.setDisabled( !movable || selectedItem === lastMovable );
8331 this.removeButton.setDisabled( !removable );
8332 };
8333
8334 /**
8335 * Mixin for widgets with a boolean on/off state.
8336 *
8337 * @abstract
8338 * @class
8339 *
8340 * @constructor
8341 * @param {Object} [config] Configuration options
8342 * @cfg {boolean} [value=false] Initial value
8343 */
8344 OO.ui.ToggleWidget = function OoUiToggleWidget( config ) {
8345 // Configuration initialization
8346 config = config || {};
8347
8348 // Properties
8349 this.value = null;
8350
8351 // Initialization
8352 this.$element.addClass( 'oo-ui-toggleWidget' );
8353 this.setValue( !!config.value );
8354 };
8355
8356 /* Events */
8357
8358 /**
8359 * @event change
8360 * @param {boolean} value Changed value
8361 */
8362
8363 /* Methods */
8364
8365 /**
8366 * Get the value of the toggle.
8367 *
8368 * @return {boolean}
8369 */
8370 OO.ui.ToggleWidget.prototype.getValue = function () {
8371 return this.value;
8372 };
8373
8374 /**
8375 * Set the value of the toggle.
8376 *
8377 * @param {boolean} value New value
8378 * @fires change
8379 * @chainable
8380 */
8381 OO.ui.ToggleWidget.prototype.setValue = function ( value ) {
8382 value = !!value;
8383 if ( this.value !== value ) {
8384 this.value = value;
8385 this.emit( 'change', value );
8386 this.$element.toggleClass( 'oo-ui-toggleWidget-on', value );
8387 this.$element.toggleClass( 'oo-ui-toggleWidget-off', !value );
8388 }
8389 return this;
8390 };
8391
8392 /**
8393 * Group widget for multiple related buttons.
8394 *
8395 * Use together with OO.ui.ButtonWidget.
8396 *
8397 * @class
8398 * @extends OO.ui.Widget
8399 * @mixins OO.ui.GroupElement
8400 *
8401 * @constructor
8402 * @param {Object} [config] Configuration options
8403 * @cfg {OO.ui.ButtonWidget[]} [items] Buttons to add
8404 */
8405 OO.ui.ButtonGroupWidget = function OoUiButtonGroupWidget( config ) {
8406 // Configuration initialization
8407 config = config || {};
8408
8409 // Parent constructor
8410 OO.ui.ButtonGroupWidget.super.call( this, config );
8411
8412 // Mixin constructors
8413 OO.ui.GroupElement.call( this, $.extend( {}, config, { $group: this.$element } ) );
8414
8415 // Initialization
8416 this.$element.addClass( 'oo-ui-buttonGroupWidget' );
8417 if ( $.isArray( config.items ) ) {
8418 this.addItems( config.items );
8419 }
8420 };
8421
8422 /* Setup */
8423
8424 OO.inheritClass( OO.ui.ButtonGroupWidget, OO.ui.Widget );
8425 OO.mixinClass( OO.ui.ButtonGroupWidget, OO.ui.GroupElement );
8426
8427 /**
8428 * Generic widget for buttons.
8429 *
8430 * @class
8431 * @extends OO.ui.Widget
8432 * @mixins OO.ui.ButtonElement
8433 * @mixins OO.ui.IconElement
8434 * @mixins OO.ui.IndicatorElement
8435 * @mixins OO.ui.LabelElement
8436 * @mixins OO.ui.TitledElement
8437 * @mixins OO.ui.FlaggedElement
8438 *
8439 * @constructor
8440 * @param {Object} [config] Configuration options
8441 * @cfg {string} [href] Hyperlink to visit when clicked
8442 * @cfg {string} [target] Target to open hyperlink in
8443 */
8444 OO.ui.ButtonWidget = function OoUiButtonWidget( config ) {
8445 // Configuration initialization
8446 config = $.extend( { target: '_blank' }, config );
8447
8448 // Parent constructor
8449 OO.ui.ButtonWidget.super.call( this, config );
8450
8451 // Mixin constructors
8452 OO.ui.ButtonElement.call( this, config );
8453 OO.ui.IconElement.call( this, config );
8454 OO.ui.IndicatorElement.call( this, config );
8455 OO.ui.LabelElement.call( this, config );
8456 OO.ui.TitledElement.call( this, $.extend( {}, config, { $titled: this.$button } ) );
8457 OO.ui.FlaggedElement.call( this, config );
8458
8459 // Properties
8460 this.href = null;
8461 this.target = null;
8462 this.isHyperlink = false;
8463
8464 // Events
8465 this.$button.on( {
8466 click: this.onClick.bind( this ),
8467 keypress: this.onKeyPress.bind( this )
8468 } );
8469
8470 // Initialization
8471 this.$button.append( this.$icon, this.$label, this.$indicator );
8472 this.$element
8473 .addClass( 'oo-ui-buttonWidget' )
8474 .append( this.$button );
8475 this.setHref( config.href );
8476 this.setTarget( config.target );
8477 };
8478
8479 /* Setup */
8480
8481 OO.inheritClass( OO.ui.ButtonWidget, OO.ui.Widget );
8482 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.ButtonElement );
8483 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.IconElement );
8484 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.IndicatorElement );
8485 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.LabelElement );
8486 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.TitledElement );
8487 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.FlaggedElement );
8488
8489 /* Events */
8490
8491 /**
8492 * @event click
8493 */
8494
8495 /* Methods */
8496
8497 /**
8498 * Handles mouse click events.
8499 *
8500 * @param {jQuery.Event} e Mouse click event
8501 * @fires click
8502 */
8503 OO.ui.ButtonWidget.prototype.onClick = function () {
8504 if ( !this.isDisabled() ) {
8505 this.emit( 'click' );
8506 if ( this.isHyperlink ) {
8507 return true;
8508 }
8509 }
8510 return false;
8511 };
8512
8513 /**
8514 * Handles keypress events.
8515 *
8516 * @param {jQuery.Event} e Keypress event
8517 * @fires click
8518 */
8519 OO.ui.ButtonWidget.prototype.onKeyPress = function ( e ) {
8520 if ( !this.isDisabled() && ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER ) ) {
8521 this.emit( 'click' );
8522 if ( this.isHyperlink ) {
8523 return true;
8524 }
8525 }
8526 return false;
8527 };
8528
8529 /**
8530 * Get hyperlink location.
8531 *
8532 * @return {string} Hyperlink location
8533 */
8534 OO.ui.ButtonWidget.prototype.getHref = function () {
8535 return this.href;
8536 };
8537
8538 /**
8539 * Get hyperlink target.
8540 *
8541 * @return {string} Hyperlink target
8542 */
8543 OO.ui.ButtonWidget.prototype.getTarget = function () {
8544 return this.target;
8545 };
8546
8547 /**
8548 * Set hyperlink location.
8549 *
8550 * @param {string|null} href Hyperlink location, null to remove
8551 */
8552 OO.ui.ButtonWidget.prototype.setHref = function ( href ) {
8553 href = typeof href === 'string' ? href : null;
8554
8555 if ( href !== this.href ) {
8556 this.href = href;
8557 if ( href !== null ) {
8558 this.$button.attr( 'href', href );
8559 this.isHyperlink = true;
8560 } else {
8561 this.$button.removeAttr( 'href' );
8562 this.isHyperlink = false;
8563 }
8564 }
8565
8566 return this;
8567 };
8568
8569 /**
8570 * Set hyperlink target.
8571 *
8572 * @param {string|null} target Hyperlink target, null to remove
8573 */
8574 OO.ui.ButtonWidget.prototype.setTarget = function ( target ) {
8575 target = typeof target === 'string' ? target : null;
8576
8577 if ( target !== this.target ) {
8578 this.target = target;
8579 if ( target !== null ) {
8580 this.$button.attr( 'target', target );
8581 } else {
8582 this.$button.removeAttr( 'target' );
8583 }
8584 }
8585
8586 return this;
8587 };
8588
8589 /**
8590 * Button widget that executes an action and is managed by an OO.ui.ActionSet.
8591 *
8592 * @class
8593 * @extends OO.ui.ButtonWidget
8594 * @mixins OO.ui.PendingElement
8595 *
8596 * @constructor
8597 * @param {Object} [config] Configuration options
8598 * @cfg {string} [action] Symbolic action name
8599 * @cfg {string[]} [modes] Symbolic mode names
8600 * @cfg {boolean} [framed=false] Render button with a frame
8601 */
8602 OO.ui.ActionWidget = function OoUiActionWidget( config ) {
8603 // Configuration initialization
8604 config = $.extend( { framed: false }, config );
8605
8606 // Parent constructor
8607 OO.ui.ActionWidget.super.call( this, config );
8608
8609 // Mixin constructors
8610 OO.ui.PendingElement.call( this, config );
8611
8612 // Properties
8613 this.action = config.action || '';
8614 this.modes = config.modes || [];
8615 this.width = 0;
8616 this.height = 0;
8617
8618 // Initialization
8619 this.$element.addClass( 'oo-ui-actionWidget' );
8620 };
8621
8622 /* Setup */
8623
8624 OO.inheritClass( OO.ui.ActionWidget, OO.ui.ButtonWidget );
8625 OO.mixinClass( OO.ui.ActionWidget, OO.ui.PendingElement );
8626
8627 /* Events */
8628
8629 /**
8630 * @event resize
8631 */
8632
8633 /* Methods */
8634
8635 /**
8636 * Check if action is available in a certain mode.
8637 *
8638 * @param {string} mode Name of mode
8639 * @return {boolean} Has mode
8640 */
8641 OO.ui.ActionWidget.prototype.hasMode = function ( mode ) {
8642 return this.modes.indexOf( mode ) !== -1;
8643 };
8644
8645 /**
8646 * Get symbolic action name.
8647 *
8648 * @return {string}
8649 */
8650 OO.ui.ActionWidget.prototype.getAction = function () {
8651 return this.action;
8652 };
8653
8654 /**
8655 * Get symbolic action name.
8656 *
8657 * @return {string}
8658 */
8659 OO.ui.ActionWidget.prototype.getModes = function () {
8660 return this.modes.slice();
8661 };
8662
8663 /**
8664 * Emit a resize event if the size has changed.
8665 *
8666 * @chainable
8667 */
8668 OO.ui.ActionWidget.prototype.propagateResize = function () {
8669 var width, height;
8670
8671 if ( this.isElementAttached() ) {
8672 width = this.$element.width();
8673 height = this.$element.height();
8674
8675 if ( width !== this.width || height !== this.height ) {
8676 this.width = width;
8677 this.height = height;
8678 this.emit( 'resize' );
8679 }
8680 }
8681
8682 return this;
8683 };
8684
8685 /**
8686 * @inheritdoc
8687 */
8688 OO.ui.ActionWidget.prototype.setIcon = function () {
8689 // Mixin method
8690 OO.ui.IconElement.prototype.setIcon.apply( this, arguments );
8691 this.propagateResize();
8692
8693 return this;
8694 };
8695
8696 /**
8697 * @inheritdoc
8698 */
8699 OO.ui.ActionWidget.prototype.setLabel = function () {
8700 // Mixin method
8701 OO.ui.LabelElement.prototype.setLabel.apply( this, arguments );
8702 this.propagateResize();
8703
8704 return this;
8705 };
8706
8707 /**
8708 * @inheritdoc
8709 */
8710 OO.ui.ActionWidget.prototype.setFlags = function () {
8711 // Mixin method
8712 OO.ui.FlaggedElement.prototype.setFlags.apply( this, arguments );
8713 this.propagateResize();
8714
8715 return this;
8716 };
8717
8718 /**
8719 * @inheritdoc
8720 */
8721 OO.ui.ActionWidget.prototype.clearFlags = function () {
8722 // Mixin method
8723 OO.ui.FlaggedElement.prototype.clearFlags.apply( this, arguments );
8724 this.propagateResize();
8725
8726 return this;
8727 };
8728
8729 /**
8730 * Toggle visibility of button.
8731 *
8732 * @param {boolean} [show] Show button, omit to toggle visibility
8733 * @chainable
8734 */
8735 OO.ui.ActionWidget.prototype.toggle = function () {
8736 // Parent method
8737 OO.ui.ActionWidget.super.prototype.toggle.apply( this, arguments );
8738 this.propagateResize();
8739
8740 return this;
8741 };
8742
8743 /**
8744 * Button that shows and hides a popup.
8745 *
8746 * @class
8747 * @extends OO.ui.ButtonWidget
8748 * @mixins OO.ui.PopupElement
8749 *
8750 * @constructor
8751 * @param {Object} [config] Configuration options
8752 */
8753 OO.ui.PopupButtonWidget = function OoUiPopupButtonWidget( config ) {
8754 // Parent constructor
8755 OO.ui.PopupButtonWidget.super.call( this, config );
8756
8757 // Mixin constructors
8758 OO.ui.PopupElement.call( this, config );
8759
8760 // Initialization
8761 this.$element
8762 .addClass( 'oo-ui-popupButtonWidget' )
8763 .append( this.popup.$element );
8764 };
8765
8766 /* Setup */
8767
8768 OO.inheritClass( OO.ui.PopupButtonWidget, OO.ui.ButtonWidget );
8769 OO.mixinClass( OO.ui.PopupButtonWidget, OO.ui.PopupElement );
8770
8771 /* Methods */
8772
8773 /**
8774 * Handles mouse click events.
8775 *
8776 * @param {jQuery.Event} e Mouse click event
8777 */
8778 OO.ui.PopupButtonWidget.prototype.onClick = function ( e ) {
8779 // Skip clicks within the popup
8780 if ( $.contains( this.popup.$element[0], e.target ) ) {
8781 return;
8782 }
8783
8784 if ( !this.isDisabled() ) {
8785 this.popup.toggle();
8786 // Parent method
8787 OO.ui.PopupButtonWidget.super.prototype.onClick.call( this );
8788 }
8789 return false;
8790 };
8791
8792 /**
8793 * Button that toggles on and off.
8794 *
8795 * @class
8796 * @extends OO.ui.ButtonWidget
8797 * @mixins OO.ui.ToggleWidget
8798 *
8799 * @constructor
8800 * @param {Object} [config] Configuration options
8801 * @cfg {boolean} [value=false] Initial value
8802 */
8803 OO.ui.ToggleButtonWidget = function OoUiToggleButtonWidget( config ) {
8804 // Configuration initialization
8805 config = config || {};
8806
8807 // Parent constructor
8808 OO.ui.ToggleButtonWidget.super.call( this, config );
8809
8810 // Mixin constructors
8811 OO.ui.ToggleWidget.call( this, config );
8812
8813 // Initialization
8814 this.$element.addClass( 'oo-ui-toggleButtonWidget' );
8815 };
8816
8817 /* Setup */
8818
8819 OO.inheritClass( OO.ui.ToggleButtonWidget, OO.ui.ButtonWidget );
8820 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.ToggleWidget );
8821
8822 /* Methods */
8823
8824 /**
8825 * @inheritdoc
8826 */
8827 OO.ui.ToggleButtonWidget.prototype.onClick = function () {
8828 if ( !this.isDisabled() ) {
8829 this.setValue( !this.value );
8830 }
8831
8832 // Parent method
8833 return OO.ui.ToggleButtonWidget.super.prototype.onClick.call( this );
8834 };
8835
8836 /**
8837 * @inheritdoc
8838 */
8839 OO.ui.ToggleButtonWidget.prototype.setValue = function ( value ) {
8840 value = !!value;
8841 if ( value !== this.value ) {
8842 this.setActive( value );
8843 }
8844
8845 // Parent method (from mixin)
8846 OO.ui.ToggleWidget.prototype.setValue.call( this, value );
8847
8848 return this;
8849 };
8850
8851 /**
8852 * Dropdown menu of options.
8853 *
8854 * Dropdown menus provide a control for accessing a menu and compose a menu within the widget, which
8855 * can be accessed using the #getMenu method.
8856 *
8857 * Use with OO.ui.MenuItemWidget.
8858 *
8859 * @class
8860 * @extends OO.ui.Widget
8861 * @mixins OO.ui.IconElement
8862 * @mixins OO.ui.IndicatorElement
8863 * @mixins OO.ui.LabelElement
8864 * @mixins OO.ui.TitledElement
8865 *
8866 * @constructor
8867 * @param {Object} [config] Configuration options
8868 * @cfg {Object} [menu] Configuration options to pass to menu widget
8869 */
8870 OO.ui.DropdownWidget = function OoUiDropdownWidget( config ) {
8871 // Configuration initialization
8872 config = $.extend( { indicator: 'down' }, config );
8873
8874 // Parent constructor
8875 OO.ui.DropdownWidget.super.call( this, config );
8876
8877 // Mixin constructors
8878 OO.ui.IconElement.call( this, config );
8879 OO.ui.IndicatorElement.call( this, config );
8880 OO.ui.LabelElement.call( this, config );
8881 OO.ui.TitledElement.call( this, $.extend( {}, config, { $titled: this.$label } ) );
8882
8883 // Properties
8884 this.menu = new OO.ui.MenuWidget( $.extend( { $: this.$, widget: this }, config.menu ) );
8885 this.$handle = this.$( '<span>' );
8886
8887 // Events
8888 this.$element.on( { click: this.onClick.bind( this ) } );
8889 this.menu.connect( this, { select: 'onMenuSelect' } );
8890
8891 // Initialization
8892 this.$handle
8893 .addClass( 'oo-ui-dropdownWidget-handle' )
8894 .append( this.$icon, this.$label, this.$indicator );
8895 this.$element
8896 .addClass( 'oo-ui-dropdownWidget' )
8897 .append( this.$handle, this.menu.$element );
8898 };
8899
8900 /* Setup */
8901
8902 OO.inheritClass( OO.ui.DropdownWidget, OO.ui.Widget );
8903 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.IconElement );
8904 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.IndicatorElement );
8905 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.LabelElement );
8906 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.TitledElement );
8907
8908 /* Methods */
8909
8910 /**
8911 * Get the menu.
8912 *
8913 * @return {OO.ui.MenuWidget} Menu of widget
8914 */
8915 OO.ui.DropdownWidget.prototype.getMenu = function () {
8916 return this.menu;
8917 };
8918
8919 /**
8920 * Handles menu select events.
8921 *
8922 * @param {OO.ui.MenuItemWidget} item Selected menu item
8923 */
8924 OO.ui.DropdownWidget.prototype.onMenuSelect = function ( item ) {
8925 var selectedLabel;
8926
8927 if ( !item ) {
8928 return;
8929 }
8930
8931 selectedLabel = item.getLabel();
8932
8933 // If the label is a DOM element, clone it, because setLabel will append() it
8934 if ( selectedLabel instanceof jQuery ) {
8935 selectedLabel = selectedLabel.clone();
8936 }
8937
8938 this.setLabel( selectedLabel );
8939 };
8940
8941 /**
8942 * Handles mouse click events.
8943 *
8944 * @param {jQuery.Event} e Mouse click event
8945 */
8946 OO.ui.DropdownWidget.prototype.onClick = function ( e ) {
8947 // Skip clicks within the menu
8948 if ( $.contains( this.menu.$element[0], e.target ) ) {
8949 return;
8950 }
8951
8952 if ( !this.isDisabled() ) {
8953 if ( this.menu.isVisible() ) {
8954 this.menu.toggle( false );
8955 } else {
8956 this.menu.toggle( true );
8957 }
8958 }
8959 return false;
8960 };
8961
8962 /**
8963 * Icon widget.
8964 *
8965 * See OO.ui.IconElement for more information.
8966 *
8967 * @class
8968 * @extends OO.ui.Widget
8969 * @mixins OO.ui.IconElement
8970 * @mixins OO.ui.TitledElement
8971 *
8972 * @constructor
8973 * @param {Object} [config] Configuration options
8974 */
8975 OO.ui.IconWidget = function OoUiIconWidget( config ) {
8976 // Configuration initialization
8977 config = config || {};
8978
8979 // Parent constructor
8980 OO.ui.IconWidget.super.call( this, config );
8981
8982 // Mixin constructors
8983 OO.ui.IconElement.call( this, $.extend( {}, config, { $icon: this.$element } ) );
8984 OO.ui.TitledElement.call( this, $.extend( {}, config, { $titled: this.$element } ) );
8985
8986 // Initialization
8987 this.$element.addClass( 'oo-ui-iconWidget' );
8988 };
8989
8990 /* Setup */
8991
8992 OO.inheritClass( OO.ui.IconWidget, OO.ui.Widget );
8993 OO.mixinClass( OO.ui.IconWidget, OO.ui.IconElement );
8994 OO.mixinClass( OO.ui.IconWidget, OO.ui.TitledElement );
8995
8996 /* Static Properties */
8997
8998 OO.ui.IconWidget.static.tagName = 'span';
8999
9000 /**
9001 * Indicator widget.
9002 *
9003 * See OO.ui.IndicatorElement for more information.
9004 *
9005 * @class
9006 * @extends OO.ui.Widget
9007 * @mixins OO.ui.IndicatorElement
9008 * @mixins OO.ui.TitledElement
9009 *
9010 * @constructor
9011 * @param {Object} [config] Configuration options
9012 */
9013 OO.ui.IndicatorWidget = function OoUiIndicatorWidget( config ) {
9014 // Configuration initialization
9015 config = config || {};
9016
9017 // Parent constructor
9018 OO.ui.IndicatorWidget.super.call( this, config );
9019
9020 // Mixin constructors
9021 OO.ui.IndicatorElement.call( this, $.extend( {}, config, { $indicator: this.$element } ) );
9022 OO.ui.TitledElement.call( this, $.extend( {}, config, { $titled: this.$element } ) );
9023
9024 // Initialization
9025 this.$element.addClass( 'oo-ui-indicatorWidget' );
9026 };
9027
9028 /* Setup */
9029
9030 OO.inheritClass( OO.ui.IndicatorWidget, OO.ui.Widget );
9031 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.IndicatorElement );
9032 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.TitledElement );
9033
9034 /* Static Properties */
9035
9036 OO.ui.IndicatorWidget.static.tagName = 'span';
9037
9038 /**
9039 * Base class for input widgets.
9040 *
9041 * @abstract
9042 * @class
9043 * @extends OO.ui.Widget
9044 * @mixins OO.ui.FlaggedElement
9045 *
9046 * @constructor
9047 * @param {Object} [config] Configuration options
9048 * @cfg {string} [name=''] HTML input name
9049 * @cfg {string} [value=''] Input value
9050 * @cfg {Function} [inputFilter] Filter function to apply to the input. Takes a string argument and returns a string.
9051 */
9052 OO.ui.InputWidget = function OoUiInputWidget( config ) {
9053 // Configuration initialization
9054 config = config || {};
9055
9056 // Parent constructor
9057 OO.ui.InputWidget.super.call( this, config );
9058
9059 // Mixin constructors
9060 OO.ui.FlaggedElement.call( this, config );
9061
9062 // Properties
9063 this.$input = this.getInputElement( config );
9064 this.value = '';
9065 this.inputFilter = config.inputFilter;
9066
9067 // Events
9068 this.$input.on( 'keydown mouseup cut paste change input select', this.onEdit.bind( this ) );
9069
9070 // Initialization
9071 this.$input
9072 .attr( 'name', config.name )
9073 .prop( 'disabled', this.isDisabled() );
9074 this.$element.addClass( 'oo-ui-inputWidget' ).append( this.$input, $( '<span>' ) );
9075 this.setValue( config.value );
9076 };
9077
9078 /* Setup */
9079
9080 OO.inheritClass( OO.ui.InputWidget, OO.ui.Widget );
9081 OO.mixinClass( OO.ui.InputWidget, OO.ui.FlaggedElement );
9082
9083 /* Events */
9084
9085 /**
9086 * @event change
9087 * @param {string} value
9088 */
9089
9090 /* Methods */
9091
9092 /**
9093 * Get input element.
9094 *
9095 * @private
9096 * @param {Object} [config] Configuration options
9097 * @return {jQuery} Input element
9098 */
9099 OO.ui.InputWidget.prototype.getInputElement = function () {
9100 return this.$( '<input>' );
9101 };
9102
9103 /**
9104 * Handle potentially value-changing events.
9105 *
9106 * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
9107 */
9108 OO.ui.InputWidget.prototype.onEdit = function () {
9109 var widget = this;
9110 if ( !this.isDisabled() ) {
9111 // Allow the stack to clear so the value will be updated
9112 setTimeout( function () {
9113 widget.setValue( widget.$input.val() );
9114 } );
9115 }
9116 };
9117
9118 /**
9119 * Get the value of the input.
9120 *
9121 * @return {string} Input value
9122 */
9123 OO.ui.InputWidget.prototype.getValue = function () {
9124 return this.value;
9125 };
9126
9127 /**
9128 * Sets the direction of the current input, either RTL or LTR
9129 *
9130 * @param {boolean} isRTL
9131 */
9132 OO.ui.InputWidget.prototype.setRTL = function ( isRTL ) {
9133 if ( isRTL ) {
9134 this.$input.removeClass( 'oo-ui-ltr' );
9135 this.$input.addClass( 'oo-ui-rtl' );
9136 } else {
9137 this.$input.removeClass( 'oo-ui-rtl' );
9138 this.$input.addClass( 'oo-ui-ltr' );
9139 }
9140 };
9141
9142 /**
9143 * Set the value of the input.
9144 *
9145 * @param {string} value New value
9146 * @fires change
9147 * @chainable
9148 */
9149 OO.ui.InputWidget.prototype.setValue = function ( value ) {
9150 value = this.sanitizeValue( value );
9151 if ( this.value !== value ) {
9152 this.value = value;
9153 this.emit( 'change', this.value );
9154 }
9155 // Update the DOM if it has changed. Note that with sanitizeValue, it
9156 // is possible for the DOM value to change without this.value changing.
9157 if ( this.$input.val() !== this.value ) {
9158 this.$input.val( this.value );
9159 }
9160 return this;
9161 };
9162
9163 /**
9164 * Sanitize incoming value.
9165 *
9166 * Ensures value is a string, and converts undefined and null to empty string.
9167 *
9168 * @private
9169 * @param {string} value Original value
9170 * @return {string} Sanitized value
9171 */
9172 OO.ui.InputWidget.prototype.sanitizeValue = function ( value ) {
9173 if ( value === undefined || value === null ) {
9174 return '';
9175 } else if ( this.inputFilter ) {
9176 return this.inputFilter( String( value ) );
9177 } else {
9178 return String( value );
9179 }
9180 };
9181
9182 /**
9183 * Simulate the behavior of clicking on a label bound to this input.
9184 */
9185 OO.ui.InputWidget.prototype.simulateLabelClick = function () {
9186 if ( !this.isDisabled() ) {
9187 if ( this.$input.is( ':checkbox,:radio' ) ) {
9188 this.$input.click();
9189 } else if ( this.$input.is( ':input' ) ) {
9190 this.$input[0].focus();
9191 }
9192 }
9193 };
9194
9195 /**
9196 * @inheritdoc
9197 */
9198 OO.ui.InputWidget.prototype.setDisabled = function ( state ) {
9199 OO.ui.InputWidget.super.prototype.setDisabled.call( this, state );
9200 if ( this.$input ) {
9201 this.$input.prop( 'disabled', this.isDisabled() );
9202 }
9203 return this;
9204 };
9205
9206 /**
9207 * Focus the input.
9208 *
9209 * @chainable
9210 */
9211 OO.ui.InputWidget.prototype.focus = function () {
9212 this.$input[0].focus();
9213 return this;
9214 };
9215
9216 /**
9217 * Blur the input.
9218 *
9219 * @chainable
9220 */
9221 OO.ui.InputWidget.prototype.blur = function () {
9222 this.$input[0].blur();
9223 return this;
9224 };
9225
9226 /**
9227 * A button that is an input widget. Intended to be used within a OO.ui.FormLayout.
9228 *
9229 * @class
9230 * @extends OO.ui.InputWidget
9231 * @mixins OO.ui.ButtonElement
9232 * @mixins OO.ui.IconElement
9233 * @mixins OO.ui.IndicatorElement
9234 * @mixins OO.ui.LabelElement
9235 * @mixins OO.ui.TitledElement
9236 * @mixins OO.ui.FlaggedElement
9237 *
9238 * @constructor
9239 * @param {Object} [config] Configuration options
9240 * @cfg {string} [type='button'] HTML tag `type` attribute, may be 'button', 'submit' or 'reset'
9241 * @cfg {boolean} [useInputTag=false] Whether to use `<input/>` rather than `<button/>`. Only useful
9242 * if you need IE 6 support in a form with multiple buttons. If you use this option, icons and
9243 * indicators will not be displayed, it won't be possible to have a non-plaintext label, and it
9244 * won't be possible to set a value (which will internally become identical to the label).
9245 */
9246 OO.ui.ButtonInputWidget = function OoUiButtonInputWidget( config ) {
9247 // Configuration initialization
9248 config = $.extend( { type: 'button', useInputTag: false }, config );
9249
9250 // Properties (must be set before parent constructor, which calls #setValue)
9251 this.useInputTag = config.useInputTag;
9252
9253 // Parent constructor
9254 OO.ui.ButtonInputWidget.super.call( this, config );
9255
9256 // Mixin constructors
9257 OO.ui.ButtonElement.call( this, $.extend( {}, config, { $button: this.$input } ) );
9258 OO.ui.IconElement.call( this, config );
9259 OO.ui.IndicatorElement.call( this, config );
9260 OO.ui.LabelElement.call( this, config );
9261 OO.ui.TitledElement.call( this, $.extend( {}, config, { $titled: this.$input } ) );
9262 OO.ui.FlaggedElement.call( this, config );
9263
9264 // Events
9265 this.$input.on( {
9266 click: this.onClick.bind( this ),
9267 keypress: this.onKeyPress.bind( this )
9268 } );
9269
9270 // Initialization
9271 if ( !config.useInputTag ) {
9272 this.$input.append( this.$icon, this.$label, this.$indicator );
9273 }
9274 this.$element.addClass( 'oo-ui-buttonInputWidget' );
9275 };
9276
9277 /* Setup */
9278
9279 OO.inheritClass( OO.ui.ButtonInputWidget, OO.ui.InputWidget );
9280 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.ButtonElement );
9281 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.IconElement );
9282 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.IndicatorElement );
9283 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.LabelElement );
9284 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.TitledElement );
9285 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.FlaggedElement );
9286
9287 /* Events */
9288
9289 /**
9290 * @event click
9291 */
9292
9293 /* Methods */
9294
9295 /**
9296 * Get input element.
9297 *
9298 * @private
9299 * @param {Object} [config] Configuration options
9300 * @return {jQuery} Input element
9301 */
9302 OO.ui.ButtonInputWidget.prototype.getInputElement = function ( config ) {
9303 // Configuration intialization
9304 config = config || {};
9305
9306 var html = '<' + ( config.useInputTag ? 'input' : 'button' ) + ' type="' + config.type + '">';
9307
9308 return this.$( html );
9309 };
9310
9311 /**
9312 * Set label value.
9313 *
9314 * Overridden to support setting the 'value' of `<input/>` elements.
9315 *
9316 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
9317 * text; or null for no label
9318 * @chainable
9319 */
9320 OO.ui.ButtonInputWidget.prototype.setLabel = function ( label ) {
9321 OO.ui.LabelElement.prototype.setLabel.call( this, label );
9322
9323 if ( this.useInputTag ) {
9324 if ( typeof label === 'function' ) {
9325 label = OO.ui.resolveMsg( label );
9326 }
9327 if ( label instanceof jQuery ) {
9328 label = label.text();
9329 }
9330 if ( !label ) {
9331 label = '';
9332 }
9333 this.$input.val( label );
9334 }
9335
9336 return this;
9337 };
9338
9339 /**
9340 * Set the value of the input.
9341 *
9342 * Overridden to disable for `<input/>` elements, which have value identical to the label.
9343 *
9344 * @param {string} value New value
9345 * @chainable
9346 */
9347 OO.ui.ButtonInputWidget.prototype.setValue = function ( value ) {
9348 if ( !this.useInputTag ) {
9349 OO.ui.ButtonInputWidget.super.prototype.setValue.call( this, value );
9350 }
9351 return this;
9352 };
9353
9354 /**
9355 * Handles mouse click events.
9356 *
9357 * @param {jQuery.Event} e Mouse click event
9358 * @fires click
9359 */
9360 OO.ui.ButtonInputWidget.prototype.onClick = function () {
9361 if ( !this.isDisabled() ) {
9362 this.emit( 'click' );
9363 }
9364 return false;
9365 };
9366
9367 /**
9368 * Handles keypress events.
9369 *
9370 * @param {jQuery.Event} e Keypress event
9371 * @fires click
9372 */
9373 OO.ui.ButtonInputWidget.prototype.onKeyPress = function ( e ) {
9374 if ( !this.isDisabled() && ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER ) ) {
9375 this.emit( 'click' );
9376 }
9377 return false;
9378 };
9379
9380 /**
9381 * Checkbox input widget.
9382 *
9383 * @class
9384 * @extends OO.ui.InputWidget
9385 *
9386 * @constructor
9387 * @param {Object} [config] Configuration options
9388 */
9389 OO.ui.CheckboxInputWidget = function OoUiCheckboxInputWidget( config ) {
9390 // Parent constructor
9391 OO.ui.CheckboxInputWidget.super.call( this, config );
9392
9393 // Initialization
9394 this.$element.addClass( 'oo-ui-checkboxInputWidget' );
9395 };
9396
9397 /* Setup */
9398
9399 OO.inheritClass( OO.ui.CheckboxInputWidget, OO.ui.InputWidget );
9400
9401 /* Methods */
9402
9403 /**
9404 * Get input element.
9405 *
9406 * @private
9407 * @return {jQuery} Input element
9408 */
9409 OO.ui.CheckboxInputWidget.prototype.getInputElement = function () {
9410 return this.$( '<input type="checkbox" />' );
9411 };
9412
9413 /**
9414 * Get checked state of the checkbox
9415 *
9416 * @return {boolean} If the checkbox is checked
9417 */
9418 OO.ui.CheckboxInputWidget.prototype.getValue = function () {
9419 return this.value;
9420 };
9421
9422 /**
9423 * Set checked state of the checkbox
9424 *
9425 * @param {boolean} value New value
9426 */
9427 OO.ui.CheckboxInputWidget.prototype.setValue = function ( value ) {
9428 value = !!value;
9429 if ( this.value !== value ) {
9430 this.value = value;
9431 this.$input.prop( 'checked', this.value );
9432 this.emit( 'change', this.value );
9433 }
9434 };
9435
9436 /**
9437 * @inheritdoc
9438 */
9439 OO.ui.CheckboxInputWidget.prototype.onEdit = function () {
9440 var widget = this;
9441 if ( !this.isDisabled() ) {
9442 // Allow the stack to clear so the value will be updated
9443 setTimeout( function () {
9444 widget.setValue( widget.$input.prop( 'checked' ) );
9445 } );
9446 }
9447 };
9448
9449 /**
9450 * Input widget with a text field.
9451 *
9452 * @class
9453 * @extends OO.ui.InputWidget
9454 * @mixins OO.ui.IconElement
9455 * @mixins OO.ui.IndicatorElement
9456 * @mixins OO.ui.PendingElement
9457 *
9458 * @constructor
9459 * @param {Object} [config] Configuration options
9460 * @cfg {string} [type='text'] HTML tag `type` attribute
9461 * @cfg {string} [placeholder] Placeholder text
9462 * @cfg {boolean} [readOnly=false] Prevent changes
9463 * @cfg {boolean} [multiline=false] Allow multiple lines of text
9464 * @cfg {boolean} [autosize=false] Automatically resize to fit content
9465 * @cfg {boolean} [maxRows=10] Maximum number of rows to make visible when autosizing
9466 * @cfg {RegExp|string} [validate] Regular expression (or symbolic name referencing
9467 * one, see #static-validationPatterns)
9468 */
9469 OO.ui.TextInputWidget = function OoUiTextInputWidget( config ) {
9470 // Configuration initialization
9471 config = $.extend( { readOnly: false }, config );
9472
9473 // Parent constructor
9474 OO.ui.TextInputWidget.super.call( this, config );
9475
9476 // Mixin constructors
9477 OO.ui.IconElement.call( this, config );
9478 OO.ui.IndicatorElement.call( this, config );
9479 OO.ui.PendingElement.call( this, config );
9480
9481 // Properties
9482 this.readOnly = false;
9483 this.multiline = !!config.multiline;
9484 this.autosize = !!config.autosize;
9485 this.maxRows = config.maxRows !== undefined ? config.maxRows : 10;
9486 this.validate = null;
9487
9488 this.setValidation( config.validate );
9489
9490 // Events
9491 this.$input.on( {
9492 keypress: this.onKeyPress.bind( this ),
9493 blur: this.setValidityFlag.bind( this )
9494 } );
9495 this.$element.on( 'DOMNodeInsertedIntoDocument', this.onElementAttach.bind( this ) );
9496 this.$icon.on( 'mousedown', this.onIconMouseDown.bind( this ) );
9497 this.$indicator.on( 'mousedown', this.onIndicatorMouseDown.bind( this ) );
9498
9499 // Initialization
9500 this.$element
9501 .addClass( 'oo-ui-textInputWidget' )
9502 .append( this.$icon, this.$indicator );
9503 this.setReadOnly( config.readOnly );
9504 if ( config.placeholder ) {
9505 this.$input.attr( 'placeholder', config.placeholder );
9506 }
9507 this.$element.attr( 'role', 'textbox' );
9508 };
9509
9510 /* Setup */
9511
9512 OO.inheritClass( OO.ui.TextInputWidget, OO.ui.InputWidget );
9513 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.IconElement );
9514 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.IndicatorElement );
9515 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.PendingElement );
9516
9517 /* Static properties */
9518
9519 OO.ui.TextInputWidget.static.validationPatterns = {
9520 'non-empty': /.+/,
9521 integer: /^\d+$/
9522 };
9523
9524 /* Events */
9525
9526 /**
9527 * User presses enter inside the text box.
9528 *
9529 * Not called if input is multiline.
9530 *
9531 * @event enter
9532 */
9533
9534 /**
9535 * User clicks the icon.
9536 *
9537 * @event icon
9538 */
9539
9540 /**
9541 * User clicks the indicator.
9542 *
9543 * @event indicator
9544 */
9545
9546 /* Methods */
9547
9548 /**
9549 * Handle icon mouse down events.
9550 *
9551 * @param {jQuery.Event} e Mouse down event
9552 * @fires icon
9553 */
9554 OO.ui.TextInputWidget.prototype.onIconMouseDown = function ( e ) {
9555 if ( e.which === 1 ) {
9556 this.$input[0].focus();
9557 this.emit( 'icon' );
9558 return false;
9559 }
9560 };
9561
9562 /**
9563 * Handle indicator mouse down events.
9564 *
9565 * @param {jQuery.Event} e Mouse down event
9566 * @fires indicator
9567 */
9568 OO.ui.TextInputWidget.prototype.onIndicatorMouseDown = function ( e ) {
9569 if ( e.which === 1 ) {
9570 this.$input[0].focus();
9571 this.emit( 'indicator' );
9572 return false;
9573 }
9574 };
9575
9576 /**
9577 * Handle key press events.
9578 *
9579 * @param {jQuery.Event} e Key press event
9580 * @fires enter If enter key is pressed and input is not multiline
9581 */
9582 OO.ui.TextInputWidget.prototype.onKeyPress = function ( e ) {
9583 if ( e.which === OO.ui.Keys.ENTER && !this.multiline ) {
9584 this.emit( 'enter' );
9585 }
9586 };
9587
9588 /**
9589 * Handle element attach events.
9590 *
9591 * @param {jQuery.Event} e Element attach event
9592 */
9593 OO.ui.TextInputWidget.prototype.onElementAttach = function () {
9594 this.adjustSize();
9595 };
9596
9597 /**
9598 * @inheritdoc
9599 */
9600 OO.ui.TextInputWidget.prototype.onEdit = function () {
9601 this.adjustSize();
9602
9603 // Parent method
9604 return OO.ui.TextInputWidget.super.prototype.onEdit.call( this );
9605 };
9606
9607 /**
9608 * @inheritdoc
9609 */
9610 OO.ui.TextInputWidget.prototype.setValue = function ( value ) {
9611 // Parent method
9612 OO.ui.TextInputWidget.super.prototype.setValue.call( this, value );
9613
9614 this.setValidityFlag();
9615 this.adjustSize();
9616 return this;
9617 };
9618
9619 /**
9620 * Check if the widget is read-only.
9621 *
9622 * @return {boolean}
9623 */
9624 OO.ui.TextInputWidget.prototype.isReadOnly = function () {
9625 return this.readOnly;
9626 };
9627
9628 /**
9629 * Set the read-only state of the widget.
9630 *
9631 * This should probably change the widgets's appearance and prevent it from being used.
9632 *
9633 * @param {boolean} state Make input read-only
9634 * @chainable
9635 */
9636 OO.ui.TextInputWidget.prototype.setReadOnly = function ( state ) {
9637 this.readOnly = !!state;
9638 this.$input.prop( 'readOnly', this.readOnly );
9639 return this;
9640 };
9641
9642 /**
9643 * Automatically adjust the size of the text input.
9644 *
9645 * This only affects multi-line inputs that are auto-sized.
9646 *
9647 * @chainable
9648 */
9649 OO.ui.TextInputWidget.prototype.adjustSize = function () {
9650 var $clone, scrollHeight, innerHeight, outerHeight, maxInnerHeight, measurementError, idealHeight;
9651
9652 if ( this.multiline && this.autosize ) {
9653 $clone = this.$input.clone()
9654 .val( this.$input.val() )
9655 // Set inline height property to 0 to measure scroll height
9656 .css( { height: 0 } )
9657 .insertAfter( this.$input );
9658 scrollHeight = $clone[0].scrollHeight;
9659 // Remove inline height property to measure natural heights
9660 $clone.css( 'height', '' );
9661 innerHeight = $clone.innerHeight();
9662 outerHeight = $clone.outerHeight();
9663 // Measure max rows height
9664 $clone.attr( 'rows', this.maxRows ).css( 'height', 'auto' ).val( '' );
9665 maxInnerHeight = $clone.innerHeight();
9666 // Difference between reported innerHeight and scrollHeight with no scrollbars present
9667 // Equals 1 on Blink-based browsers and 0 everywhere else
9668 measurementError = maxInnerHeight - $clone[0].scrollHeight;
9669 $clone.remove();
9670 idealHeight = Math.min( maxInnerHeight, scrollHeight + measurementError );
9671 // Only apply inline height when expansion beyond natural height is needed
9672 if ( idealHeight > innerHeight ) {
9673 // Use the difference between the inner and outer height as a buffer
9674 this.$input.css( 'height', idealHeight + ( outerHeight - innerHeight ) );
9675 } else {
9676 this.$input.css( 'height', '' );
9677 }
9678 }
9679 return this;
9680 };
9681
9682 /**
9683 * Get input element.
9684 *
9685 * @private
9686 * @param {Object} [config] Configuration options
9687 * @return {jQuery} Input element
9688 */
9689 OO.ui.TextInputWidget.prototype.getInputElement = function ( config ) {
9690 // Configuration initialization
9691 config = config || {};
9692
9693 var type = config.type || 'text';
9694
9695 return config.multiline ? this.$( '<textarea>' ) : this.$( '<input type="' + type + '" />' );
9696 };
9697
9698 /**
9699 * Check if input supports multiple lines.
9700 *
9701 * @return {boolean}
9702 */
9703 OO.ui.TextInputWidget.prototype.isMultiline = function () {
9704 return !!this.multiline;
9705 };
9706
9707 /**
9708 * Check if input automatically adjusts its size.
9709 *
9710 * @return {boolean}
9711 */
9712 OO.ui.TextInputWidget.prototype.isAutosizing = function () {
9713 return !!this.autosize;
9714 };
9715
9716 /**
9717 * Select the contents of the input.
9718 *
9719 * @chainable
9720 */
9721 OO.ui.TextInputWidget.prototype.select = function () {
9722 this.$input.select();
9723 return this;
9724 };
9725
9726 /**
9727 * Sets the validation pattern to use.
9728 * @param {RegExp|string|null} validate Regular expression (or symbolic name referencing
9729 * one, see #static-validationPatterns)
9730 */
9731 OO.ui.TextInputWidget.prototype.setValidation = function ( validate ) {
9732 if ( validate instanceof RegExp ) {
9733 this.validate = validate;
9734 } else {
9735 this.validate = this.constructor.static.validationPatterns[validate] || /.*/;
9736 }
9737 };
9738
9739 /**
9740 * Sets the 'invalid' flag appropriately.
9741 */
9742 OO.ui.TextInputWidget.prototype.setValidityFlag = function () {
9743 var widget = this;
9744 this.isValid().done( function ( valid ) {
9745 widget.setFlags( { invalid: !valid } );
9746 } );
9747 };
9748
9749 /**
9750 * Returns whether or not the current value is considered valid, according to the
9751 * supplied validation pattern.
9752 *
9753 * @return {jQuery.Deferred}
9754 */
9755 OO.ui.TextInputWidget.prototype.isValid = function () {
9756 return $.Deferred().resolve( !!this.getValue().match( this.validate ) ).promise();
9757 };
9758
9759 /**
9760 * Text input with a menu of optional values.
9761 *
9762 * @class
9763 * @extends OO.ui.Widget
9764 *
9765 * @constructor
9766 * @param {Object} [config] Configuration options
9767 * @cfg {Object} [menu] Configuration options to pass to menu widget
9768 * @cfg {Object} [input] Configuration options to pass to input widget
9769 * @cfg {jQuery} [$overlay] Overlay layer; defaults to relative positioning
9770 */
9771 OO.ui.ComboBoxWidget = function OoUiComboBoxWidget( config ) {
9772 // Configuration initialization
9773 config = config || {};
9774
9775 // Parent constructor
9776 OO.ui.ComboBoxWidget.super.call( this, config );
9777
9778 // Properties
9779 this.$overlay = config.$overlay || this.$element;
9780 this.input = new OO.ui.TextInputWidget( $.extend(
9781 { $: this.$, indicator: 'down', disabled: this.isDisabled() },
9782 config.input
9783 ) );
9784 this.menu = new OO.ui.TextInputMenuWidget( this.input, $.extend(
9785 {
9786 $: OO.ui.Element.getJQuery( this.$overlay ),
9787 widget: this,
9788 input: this.input,
9789 disabled: this.isDisabled()
9790 },
9791 config.menu
9792 ) );
9793
9794 // Events
9795 this.input.connect( this, {
9796 change: 'onInputChange',
9797 indicator: 'onInputIndicator',
9798 enter: 'onInputEnter'
9799 } );
9800 this.menu.connect( this, {
9801 choose: 'onMenuChoose',
9802 add: 'onMenuItemsChange',
9803 remove: 'onMenuItemsChange'
9804 } );
9805
9806 // Initialization
9807 this.$element.addClass( 'oo-ui-comboBoxWidget' ).append( this.input.$element );
9808 this.$overlay.append( this.menu.$element );
9809 this.onMenuItemsChange();
9810 };
9811
9812 /* Setup */
9813
9814 OO.inheritClass( OO.ui.ComboBoxWidget, OO.ui.Widget );
9815
9816 /* Methods */
9817
9818 /**
9819 * Handle input change events.
9820 *
9821 * @param {string} value New value
9822 */
9823 OO.ui.ComboBoxWidget.prototype.onInputChange = function ( value ) {
9824 var match = this.menu.getItemFromData( value );
9825
9826 this.menu.selectItem( match );
9827
9828 if ( !this.isDisabled() ) {
9829 this.menu.toggle( true );
9830 }
9831 };
9832
9833 /**
9834 * Handle input indicator events.
9835 */
9836 OO.ui.ComboBoxWidget.prototype.onInputIndicator = function () {
9837 if ( !this.isDisabled() ) {
9838 this.menu.toggle();
9839 }
9840 };
9841
9842 /**
9843 * Handle input enter events.
9844 */
9845 OO.ui.ComboBoxWidget.prototype.onInputEnter = function () {
9846 if ( !this.isDisabled() ) {
9847 this.menu.toggle( false );
9848 }
9849 };
9850
9851 /**
9852 * Handle menu choose events.
9853 *
9854 * @param {OO.ui.OptionWidget} item Chosen item
9855 */
9856 OO.ui.ComboBoxWidget.prototype.onMenuChoose = function ( item ) {
9857 if ( item ) {
9858 this.input.setValue( item.getData() );
9859 }
9860 };
9861
9862 /**
9863 * Handle menu item change events.
9864 */
9865 OO.ui.ComboBoxWidget.prototype.onMenuItemsChange = function () {
9866 var match = this.menu.getItemFromData( this.input.getValue() );
9867 this.menu.selectItem( match );
9868 this.$element.toggleClass( 'oo-ui-comboBoxWidget-empty', this.menu.isEmpty() );
9869 };
9870
9871 /**
9872 * @inheritdoc
9873 */
9874 OO.ui.ComboBoxWidget.prototype.setDisabled = function ( disabled ) {
9875 // Parent method
9876 OO.ui.ComboBoxWidget.super.prototype.setDisabled.call( this, disabled );
9877
9878 if ( this.input ) {
9879 this.input.setDisabled( this.isDisabled() );
9880 }
9881 if ( this.menu ) {
9882 this.menu.setDisabled( this.isDisabled() );
9883 }
9884
9885 return this;
9886 };
9887
9888 /**
9889 * Label widget.
9890 *
9891 * @class
9892 * @extends OO.ui.Widget
9893 * @mixins OO.ui.LabelElement
9894 *
9895 * @constructor
9896 * @param {Object} [config] Configuration options
9897 */
9898 OO.ui.LabelWidget = function OoUiLabelWidget( config ) {
9899 // Configuration initialization
9900 config = config || {};
9901
9902 // Parent constructor
9903 OO.ui.LabelWidget.super.call( this, config );
9904
9905 // Mixin constructors
9906 OO.ui.LabelElement.call( this, $.extend( {}, config, { $label: this.$element } ) );
9907 OO.ui.TitledElement.call( this, config );
9908
9909 // Properties
9910 this.input = config.input;
9911
9912 // Events
9913 if ( this.input instanceof OO.ui.InputWidget ) {
9914 this.$element.on( 'click', this.onClick.bind( this ) );
9915 }
9916
9917 // Initialization
9918 this.$element.addClass( 'oo-ui-labelWidget' );
9919 };
9920
9921 /* Setup */
9922
9923 OO.inheritClass( OO.ui.LabelWidget, OO.ui.Widget );
9924 OO.mixinClass( OO.ui.LabelWidget, OO.ui.LabelElement );
9925 OO.mixinClass( OO.ui.LabelWidget, OO.ui.TitledElement );
9926
9927 /* Static Properties */
9928
9929 OO.ui.LabelWidget.static.tagName = 'span';
9930
9931 /* Methods */
9932
9933 /**
9934 * Handles label mouse click events.
9935 *
9936 * @param {jQuery.Event} e Mouse click event
9937 */
9938 OO.ui.LabelWidget.prototype.onClick = function () {
9939 this.input.simulateLabelClick();
9940 return false;
9941 };
9942
9943 /**
9944 * Generic option widget for use with OO.ui.SelectWidget.
9945 *
9946 * @class
9947 * @extends OO.ui.Widget
9948 * @mixins OO.ui.LabelElement
9949 * @mixins OO.ui.FlaggedElement
9950 *
9951 * @constructor
9952 * @param {Mixed} data Option data
9953 * @param {Object} [config] Configuration options
9954 */
9955 OO.ui.OptionWidget = function OoUiOptionWidget( data, config ) {
9956 // Configuration initialization
9957 config = config || {};
9958
9959 // Parent constructor
9960 OO.ui.OptionWidget.super.call( this, config );
9961
9962 // Mixin constructors
9963 OO.ui.ItemWidget.call( this );
9964 OO.ui.LabelElement.call( this, config );
9965 OO.ui.FlaggedElement.call( this, config );
9966
9967 // Properties
9968 this.data = data;
9969 this.selected = false;
9970 this.highlighted = false;
9971 this.pressed = false;
9972
9973 // Initialization
9974 this.$element
9975 .data( 'oo-ui-optionWidget', this )
9976 .attr( 'role', 'option' )
9977 .addClass( 'oo-ui-optionWidget' )
9978 .append( this.$label );
9979 };
9980
9981 /* Setup */
9982
9983 OO.inheritClass( OO.ui.OptionWidget, OO.ui.Widget );
9984 OO.mixinClass( OO.ui.OptionWidget, OO.ui.ItemWidget );
9985 OO.mixinClass( OO.ui.OptionWidget, OO.ui.LabelElement );
9986 OO.mixinClass( OO.ui.OptionWidget, OO.ui.FlaggedElement );
9987
9988 /* Static Properties */
9989
9990 OO.ui.OptionWidget.static.selectable = true;
9991
9992 OO.ui.OptionWidget.static.highlightable = true;
9993
9994 OO.ui.OptionWidget.static.pressable = true;
9995
9996 OO.ui.OptionWidget.static.scrollIntoViewOnSelect = false;
9997
9998 /* Methods */
9999
10000 /**
10001 * Check if option can be selected.
10002 *
10003 * @return {boolean} Item is selectable
10004 */
10005 OO.ui.OptionWidget.prototype.isSelectable = function () {
10006 return this.constructor.static.selectable && !this.isDisabled();
10007 };
10008
10009 /**
10010 * Check if option can be highlighted.
10011 *
10012 * @return {boolean} Item is highlightable
10013 */
10014 OO.ui.OptionWidget.prototype.isHighlightable = function () {
10015 return this.constructor.static.highlightable && !this.isDisabled();
10016 };
10017
10018 /**
10019 * Check if option can be pressed.
10020 *
10021 * @return {boolean} Item is pressable
10022 */
10023 OO.ui.OptionWidget.prototype.isPressable = function () {
10024 return this.constructor.static.pressable && !this.isDisabled();
10025 };
10026
10027 /**
10028 * Check if option is selected.
10029 *
10030 * @return {boolean} Item is selected
10031 */
10032 OO.ui.OptionWidget.prototype.isSelected = function () {
10033 return this.selected;
10034 };
10035
10036 /**
10037 * Check if option is highlighted.
10038 *
10039 * @return {boolean} Item is highlighted
10040 */
10041 OO.ui.OptionWidget.prototype.isHighlighted = function () {
10042 return this.highlighted;
10043 };
10044
10045 /**
10046 * Check if option is pressed.
10047 *
10048 * @return {boolean} Item is pressed
10049 */
10050 OO.ui.OptionWidget.prototype.isPressed = function () {
10051 return this.pressed;
10052 };
10053
10054 /**
10055 * Set selected state.
10056 *
10057 * @param {boolean} [state=false] Select option
10058 * @chainable
10059 */
10060 OO.ui.OptionWidget.prototype.setSelected = function ( state ) {
10061 if ( this.constructor.static.selectable ) {
10062 this.selected = !!state;
10063 this.$element.toggleClass( 'oo-ui-optionWidget-selected', state );
10064 if ( state && this.constructor.static.scrollIntoViewOnSelect ) {
10065 this.scrollElementIntoView();
10066 }
10067 this.updateThemeClasses();
10068 }
10069 return this;
10070 };
10071
10072 /**
10073 * Set highlighted state.
10074 *
10075 * @param {boolean} [state=false] Highlight option
10076 * @chainable
10077 */
10078 OO.ui.OptionWidget.prototype.setHighlighted = function ( state ) {
10079 if ( this.constructor.static.highlightable ) {
10080 this.highlighted = !!state;
10081 this.$element.toggleClass( 'oo-ui-optionWidget-highlighted', state );
10082 this.updateThemeClasses();
10083 }
10084 return this;
10085 };
10086
10087 /**
10088 * Set pressed state.
10089 *
10090 * @param {boolean} [state=false] Press option
10091 * @chainable
10092 */
10093 OO.ui.OptionWidget.prototype.setPressed = function ( state ) {
10094 if ( this.constructor.static.pressable ) {
10095 this.pressed = !!state;
10096 this.$element.toggleClass( 'oo-ui-optionWidget-pressed', state );
10097 this.updateThemeClasses();
10098 }
10099 return this;
10100 };
10101
10102 /**
10103 * Make the option's highlight flash.
10104 *
10105 * While flashing, the visual style of the pressed state is removed if present.
10106 *
10107 * @return {jQuery.Promise} Promise resolved when flashing is done
10108 */
10109 OO.ui.OptionWidget.prototype.flash = function () {
10110 var widget = this,
10111 $element = this.$element,
10112 deferred = $.Deferred();
10113
10114 if ( !this.isDisabled() && this.constructor.static.pressable ) {
10115 $element.removeClass( 'oo-ui-optionWidget-highlighted oo-ui-optionWidget-pressed' );
10116 setTimeout( function () {
10117 // Restore original classes
10118 $element
10119 .toggleClass( 'oo-ui-optionWidget-highlighted', widget.highlighted )
10120 .toggleClass( 'oo-ui-optionWidget-pressed', widget.pressed );
10121
10122 setTimeout( function () {
10123 deferred.resolve();
10124 }, 100 );
10125
10126 }, 100 );
10127 }
10128
10129 return deferred.promise();
10130 };
10131
10132 /**
10133 * Get option data.
10134 *
10135 * @return {Mixed} Option data
10136 */
10137 OO.ui.OptionWidget.prototype.getData = function () {
10138 return this.data;
10139 };
10140
10141 /**
10142 * Option widget with an option icon and indicator.
10143 *
10144 * Use together with OO.ui.SelectWidget.
10145 *
10146 * @class
10147 * @extends OO.ui.OptionWidget
10148 * @mixins OO.ui.IconElement
10149 * @mixins OO.ui.IndicatorElement
10150 *
10151 * @constructor
10152 * @param {Mixed} data Option data
10153 * @param {Object} [config] Configuration options
10154 */
10155 OO.ui.DecoratedOptionWidget = function OoUiDecoratedOptionWidget( data, config ) {
10156 // Parent constructor
10157 OO.ui.DecoratedOptionWidget.super.call( this, data, config );
10158
10159 // Mixin constructors
10160 OO.ui.IconElement.call( this, config );
10161 OO.ui.IndicatorElement.call( this, config );
10162
10163 // Initialization
10164 this.$element
10165 .addClass( 'oo-ui-decoratedOptionWidget' )
10166 .prepend( this.$icon )
10167 .append( this.$indicator );
10168 };
10169
10170 /* Setup */
10171
10172 OO.inheritClass( OO.ui.DecoratedOptionWidget, OO.ui.OptionWidget );
10173 OO.mixinClass( OO.ui.OptionWidget, OO.ui.IconElement );
10174 OO.mixinClass( OO.ui.OptionWidget, OO.ui.IndicatorElement );
10175
10176 /**
10177 * Option widget that looks like a button.
10178 *
10179 * Use together with OO.ui.ButtonSelectWidget.
10180 *
10181 * @class
10182 * @extends OO.ui.DecoratedOptionWidget
10183 * @mixins OO.ui.ButtonElement
10184 *
10185 * @constructor
10186 * @param {Mixed} data Option data
10187 * @param {Object} [config] Configuration options
10188 */
10189 OO.ui.ButtonOptionWidget = function OoUiButtonOptionWidget( data, config ) {
10190 // Parent constructor
10191 OO.ui.ButtonOptionWidget.super.call( this, data, config );
10192
10193 // Mixin constructors
10194 OO.ui.ButtonElement.call( this, config );
10195
10196 // Initialization
10197 this.$element.addClass( 'oo-ui-buttonOptionWidget' );
10198 this.$button.append( this.$element.contents() );
10199 this.$element.append( this.$button );
10200 };
10201
10202 /* Setup */
10203
10204 OO.inheritClass( OO.ui.ButtonOptionWidget, OO.ui.DecoratedOptionWidget );
10205 OO.mixinClass( OO.ui.ButtonOptionWidget, OO.ui.ButtonElement );
10206
10207 /* Static Properties */
10208
10209 // Allow button mouse down events to pass through so they can be handled by the parent select widget
10210 OO.ui.ButtonOptionWidget.static.cancelButtonMouseDownEvents = false;
10211
10212 /* Methods */
10213
10214 /**
10215 * @inheritdoc
10216 */
10217 OO.ui.ButtonOptionWidget.prototype.setSelected = function ( state ) {
10218 OO.ui.ButtonOptionWidget.super.prototype.setSelected.call( this, state );
10219
10220 if ( this.constructor.static.selectable ) {
10221 this.setActive( state );
10222 }
10223
10224 return this;
10225 };
10226
10227 /**
10228 * Item of an OO.ui.MenuWidget.
10229 *
10230 * @class
10231 * @extends OO.ui.DecoratedOptionWidget
10232 *
10233 * @constructor
10234 * @param {Mixed} data Item data
10235 * @param {Object} [config] Configuration options
10236 */
10237 OO.ui.MenuItemWidget = function OoUiMenuItemWidget( data, config ) {
10238 // Configuration initialization
10239 config = $.extend( { icon: 'check' }, config );
10240
10241 // Parent constructor
10242 OO.ui.MenuItemWidget.super.call( this, data, config );
10243
10244 // Initialization
10245 this.$element
10246 .attr( 'role', 'menuitem' )
10247 .addClass( 'oo-ui-menuItemWidget' );
10248 };
10249
10250 /* Setup */
10251
10252 OO.inheritClass( OO.ui.MenuItemWidget, OO.ui.DecoratedOptionWidget );
10253
10254 /**
10255 * Section to group one or more items in a OO.ui.MenuWidget.
10256 *
10257 * @class
10258 * @extends OO.ui.DecoratedOptionWidget
10259 *
10260 * @constructor
10261 * @param {Mixed} data Item data
10262 * @param {Object} [config] Configuration options
10263 */
10264 OO.ui.MenuSectionItemWidget = function OoUiMenuSectionItemWidget( data, config ) {
10265 // Parent constructor
10266 OO.ui.MenuSectionItemWidget.super.call( this, data, config );
10267
10268 // Initialization
10269 this.$element.addClass( 'oo-ui-menuSectionItemWidget' );
10270 };
10271
10272 /* Setup */
10273
10274 OO.inheritClass( OO.ui.MenuSectionItemWidget, OO.ui.DecoratedOptionWidget );
10275
10276 /* Static Properties */
10277
10278 OO.ui.MenuSectionItemWidget.static.selectable = false;
10279
10280 OO.ui.MenuSectionItemWidget.static.highlightable = false;
10281
10282 /**
10283 * Items for an OO.ui.OutlineWidget.
10284 *
10285 * @class
10286 * @extends OO.ui.DecoratedOptionWidget
10287 *
10288 * @constructor
10289 * @param {Mixed} data Item data
10290 * @param {Object} [config] Configuration options
10291 * @cfg {number} [level] Indentation level
10292 * @cfg {boolean} [movable] Allow modification from outline controls
10293 */
10294 OO.ui.OutlineItemWidget = function OoUiOutlineItemWidget( data, config ) {
10295 // Configuration initialization
10296 config = config || {};
10297
10298 // Parent constructor
10299 OO.ui.OutlineItemWidget.super.call( this, data, config );
10300
10301 // Properties
10302 this.level = 0;
10303 this.movable = !!config.movable;
10304 this.removable = !!config.removable;
10305
10306 // Initialization
10307 this.$element.addClass( 'oo-ui-outlineItemWidget' );
10308 this.setLevel( config.level );
10309 };
10310
10311 /* Setup */
10312
10313 OO.inheritClass( OO.ui.OutlineItemWidget, OO.ui.DecoratedOptionWidget );
10314
10315 /* Static Properties */
10316
10317 OO.ui.OutlineItemWidget.static.highlightable = false;
10318
10319 OO.ui.OutlineItemWidget.static.scrollIntoViewOnSelect = true;
10320
10321 OO.ui.OutlineItemWidget.static.levelClass = 'oo-ui-outlineItemWidget-level-';
10322
10323 OO.ui.OutlineItemWidget.static.levels = 3;
10324
10325 /* Methods */
10326
10327 /**
10328 * Check if item is movable.
10329 *
10330 * Movablilty is used by outline controls.
10331 *
10332 * @return {boolean} Item is movable
10333 */
10334 OO.ui.OutlineItemWidget.prototype.isMovable = function () {
10335 return this.movable;
10336 };
10337
10338 /**
10339 * Check if item is removable.
10340 *
10341 * Removablilty is used by outline controls.
10342 *
10343 * @return {boolean} Item is removable
10344 */
10345 OO.ui.OutlineItemWidget.prototype.isRemovable = function () {
10346 return this.removable;
10347 };
10348
10349 /**
10350 * Get indentation level.
10351 *
10352 * @return {number} Indentation level
10353 */
10354 OO.ui.OutlineItemWidget.prototype.getLevel = function () {
10355 return this.level;
10356 };
10357
10358 /**
10359 * Set movability.
10360 *
10361 * Movablilty is used by outline controls.
10362 *
10363 * @param {boolean} movable Item is movable
10364 * @chainable
10365 */
10366 OO.ui.OutlineItemWidget.prototype.setMovable = function ( movable ) {
10367 this.movable = !!movable;
10368 this.updateThemeClasses();
10369 return this;
10370 };
10371
10372 /**
10373 * Set removability.
10374 *
10375 * Removablilty is used by outline controls.
10376 *
10377 * @param {boolean} movable Item is removable
10378 * @chainable
10379 */
10380 OO.ui.OutlineItemWidget.prototype.setRemovable = function ( removable ) {
10381 this.removable = !!removable;
10382 this.updateThemeClasses();
10383 return this;
10384 };
10385
10386 /**
10387 * Set indentation level.
10388 *
10389 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
10390 * @chainable
10391 */
10392 OO.ui.OutlineItemWidget.prototype.setLevel = function ( level ) {
10393 var levels = this.constructor.static.levels,
10394 levelClass = this.constructor.static.levelClass,
10395 i = levels;
10396
10397 this.level = level ? Math.max( 0, Math.min( levels - 1, level ) ) : 0;
10398 while ( i-- ) {
10399 if ( this.level === i ) {
10400 this.$element.addClass( levelClass + i );
10401 } else {
10402 this.$element.removeClass( levelClass + i );
10403 }
10404 }
10405 this.updateThemeClasses();
10406
10407 return this;
10408 };
10409
10410 /**
10411 * Container for content that is overlaid and positioned absolutely.
10412 *
10413 * @class
10414 * @extends OO.ui.Widget
10415 * @mixins OO.ui.LabelElement
10416 *
10417 * @constructor
10418 * @param {Object} [config] Configuration options
10419 * @cfg {number} [width=320] Width of popup in pixels
10420 * @cfg {number} [height] Height of popup, omit to use automatic height
10421 * @cfg {boolean} [anchor=true] Show anchor pointing to origin of popup
10422 * @cfg {string} [align='center'] Alignment of popup to origin
10423 * @cfg {jQuery} [$container] Container to prevent popup from rendering outside of
10424 * @cfg {number} [containerPadding=10] How much padding to keep between popup and container
10425 * @cfg {jQuery} [$content] Content to append to the popup's body
10426 * @cfg {boolean} [autoClose=false] Popup auto-closes when it loses focus
10427 * @cfg {jQuery} [$autoCloseIgnore] Elements to not auto close when clicked
10428 * @cfg {boolean} [head] Show label and close button at the top
10429 * @cfg {boolean} [padded] Add padding to the body
10430 */
10431 OO.ui.PopupWidget = function OoUiPopupWidget( config ) {
10432 // Configuration initialization
10433 config = config || {};
10434
10435 // Parent constructor
10436 OO.ui.PopupWidget.super.call( this, config );
10437
10438 // Mixin constructors
10439 OO.ui.LabelElement.call( this, config );
10440 OO.ui.ClippableElement.call( this, config );
10441
10442 // Properties
10443 this.visible = false;
10444 this.$popup = this.$( '<div>' );
10445 this.$head = this.$( '<div>' );
10446 this.$body = this.$( '<div>' );
10447 this.$anchor = this.$( '<div>' );
10448 // If undefined, will be computed lazily in updateDimensions()
10449 this.$container = config.$container;
10450 this.containerPadding = config.containerPadding !== undefined ? config.containerPadding : 10;
10451 this.autoClose = !!config.autoClose;
10452 this.$autoCloseIgnore = config.$autoCloseIgnore;
10453 this.transitionTimeout = null;
10454 this.anchor = null;
10455 this.width = config.width !== undefined ? config.width : 320;
10456 this.height = config.height !== undefined ? config.height : null;
10457 this.align = config.align || 'center';
10458 this.closeButton = new OO.ui.ButtonWidget( { $: this.$, framed: false, icon: 'close' } );
10459 this.onMouseDownHandler = this.onMouseDown.bind( this );
10460
10461 // Events
10462 this.closeButton.connect( this, { click: 'onCloseButtonClick' } );
10463
10464 // Initialization
10465 this.toggleAnchor( config.anchor === undefined || config.anchor );
10466 this.$body.addClass( 'oo-ui-popupWidget-body' );
10467 this.$anchor.addClass( 'oo-ui-popupWidget-anchor' );
10468 this.$head
10469 .addClass( 'oo-ui-popupWidget-head' )
10470 .append( this.$label, this.closeButton.$element );
10471 if ( !config.head ) {
10472 this.$head.hide();
10473 }
10474 this.$popup
10475 .addClass( 'oo-ui-popupWidget-popup' )
10476 .append( this.$head, this.$body );
10477 this.$element
10478 .hide()
10479 .addClass( 'oo-ui-popupWidget' )
10480 .append( this.$popup, this.$anchor );
10481 // Move content, which was added to #$element by OO.ui.Widget, to the body
10482 if ( config.$content instanceof jQuery ) {
10483 this.$body.append( config.$content );
10484 }
10485 if ( config.padded ) {
10486 this.$body.addClass( 'oo-ui-popupWidget-body-padded' );
10487 }
10488 this.setClippableElement( this.$body );
10489 };
10490
10491 /* Setup */
10492
10493 OO.inheritClass( OO.ui.PopupWidget, OO.ui.Widget );
10494 OO.mixinClass( OO.ui.PopupWidget, OO.ui.LabelElement );
10495 OO.mixinClass( OO.ui.PopupWidget, OO.ui.ClippableElement );
10496
10497 /* Methods */
10498
10499 /**
10500 * Handles mouse down events.
10501 *
10502 * @param {jQuery.Event} e Mouse down event
10503 */
10504 OO.ui.PopupWidget.prototype.onMouseDown = function ( e ) {
10505 if (
10506 this.isVisible() &&
10507 !$.contains( this.$element[0], e.target ) &&
10508 ( !this.$autoCloseIgnore || !this.$autoCloseIgnore.has( e.target ).length )
10509 ) {
10510 this.toggle( false );
10511 }
10512 };
10513
10514 /**
10515 * Bind mouse down listener.
10516 */
10517 OO.ui.PopupWidget.prototype.bindMouseDownListener = function () {
10518 // Capture clicks outside popup
10519 this.getElementWindow().addEventListener( 'mousedown', this.onMouseDownHandler, true );
10520 };
10521
10522 /**
10523 * Handles close button click events.
10524 */
10525 OO.ui.PopupWidget.prototype.onCloseButtonClick = function () {
10526 if ( this.isVisible() ) {
10527 this.toggle( false );
10528 }
10529 };
10530
10531 /**
10532 * Unbind mouse down listener.
10533 */
10534 OO.ui.PopupWidget.prototype.unbindMouseDownListener = function () {
10535 this.getElementWindow().removeEventListener( 'mousedown', this.onMouseDownHandler, true );
10536 };
10537
10538 /**
10539 * Set whether to show a anchor.
10540 *
10541 * @param {boolean} [show] Show anchor, omit to toggle
10542 */
10543 OO.ui.PopupWidget.prototype.toggleAnchor = function ( show ) {
10544 show = show === undefined ? !this.anchored : !!show;
10545
10546 if ( this.anchored !== show ) {
10547 if ( show ) {
10548 this.$element.addClass( 'oo-ui-popupWidget-anchored' );
10549 } else {
10550 this.$element.removeClass( 'oo-ui-popupWidget-anchored' );
10551 }
10552 this.anchored = show;
10553 }
10554 };
10555
10556 /**
10557 * Check if showing a anchor.
10558 *
10559 * @return {boolean} anchor is visible
10560 */
10561 OO.ui.PopupWidget.prototype.hasAnchor = function () {
10562 return this.anchor;
10563 };
10564
10565 /**
10566 * @inheritdoc
10567 */
10568 OO.ui.PopupWidget.prototype.toggle = function ( show ) {
10569 show = show === undefined ? !this.isVisible() : !!show;
10570
10571 var change = show !== this.isVisible();
10572
10573 // Parent method
10574 OO.ui.PopupWidget.super.prototype.toggle.call( this, show );
10575
10576 if ( change ) {
10577 if ( show ) {
10578 if ( this.autoClose ) {
10579 this.bindMouseDownListener();
10580 }
10581 this.updateDimensions();
10582 this.toggleClipping( true );
10583 } else {
10584 this.toggleClipping( false );
10585 if ( this.autoClose ) {
10586 this.unbindMouseDownListener();
10587 }
10588 }
10589 }
10590
10591 return this;
10592 };
10593
10594 /**
10595 * Set the size of the popup.
10596 *
10597 * Changing the size may also change the popup's position depending on the alignment.
10598 *
10599 * @param {number} width Width
10600 * @param {number} height Height
10601 * @param {boolean} [transition=false] Use a smooth transition
10602 * @chainable
10603 */
10604 OO.ui.PopupWidget.prototype.setSize = function ( width, height, transition ) {
10605 this.width = width;
10606 this.height = height !== undefined ? height : null;
10607 if ( this.isVisible() ) {
10608 this.updateDimensions( transition );
10609 }
10610 };
10611
10612 /**
10613 * Update the size and position.
10614 *
10615 * Only use this to keep the popup properly anchored. Use #setSize to change the size, and this will
10616 * be called automatically.
10617 *
10618 * @param {boolean} [transition=false] Use a smooth transition
10619 * @chainable
10620 */
10621 OO.ui.PopupWidget.prototype.updateDimensions = function ( transition ) {
10622 var popupOffset, originOffset, containerLeft, containerWidth, containerRight,
10623 popupLeft, popupRight, overlapLeft, overlapRight, anchorWidth,
10624 widget = this;
10625
10626 if ( !this.$container ) {
10627 // Lazy-initialize $container if not specified in constructor
10628 this.$container = this.$( this.getClosestScrollableElementContainer() );
10629 }
10630
10631 // Set height and width before measuring things, since it might cause our measurements
10632 // to change (e.g. due to scrollbars appearing or disappearing)
10633 this.$popup.css( {
10634 width: this.width,
10635 height: this.height !== null ? this.height : 'auto'
10636 } );
10637
10638 // Compute initial popupOffset based on alignment
10639 popupOffset = this.width * ( { left: 0, center: -0.5, right: -1 } )[this.align];
10640
10641 // Figure out if this will cause the popup to go beyond the edge of the container
10642 originOffset = Math.round( this.$element.offset().left );
10643 containerLeft = Math.round( this.$container.offset().left );
10644 containerWidth = this.$container.innerWidth();
10645 containerRight = containerLeft + containerWidth;
10646 popupLeft = popupOffset - this.containerPadding;
10647 popupRight = popupOffset + this.containerPadding + this.width + this.containerPadding;
10648 overlapLeft = ( originOffset + popupLeft ) - containerLeft;
10649 overlapRight = containerRight - ( originOffset + popupRight );
10650
10651 // Adjust offset to make the popup not go beyond the edge, if needed
10652 if ( overlapRight < 0 ) {
10653 popupOffset += overlapRight;
10654 } else if ( overlapLeft < 0 ) {
10655 popupOffset -= overlapLeft;
10656 }
10657
10658 // Adjust offset to avoid anchor being rendered too close to the edge
10659 // $anchor.width() doesn't work with the pure CSS anchor (returns 0)
10660 // TODO: Find a measurement that works for CSS anchors and image anchors
10661 anchorWidth = this.$anchor[0].scrollWidth * 2;
10662 if ( popupOffset + this.width < anchorWidth ) {
10663 popupOffset = anchorWidth - this.width;
10664 } else if ( -popupOffset < anchorWidth ) {
10665 popupOffset = -anchorWidth;
10666 }
10667
10668 // Prevent transition from being interrupted
10669 clearTimeout( this.transitionTimeout );
10670 if ( transition ) {
10671 // Enable transition
10672 this.$element.addClass( 'oo-ui-popupWidget-transitioning' );
10673 }
10674
10675 // Position body relative to anchor
10676 this.$popup.css( 'margin-left', popupOffset );
10677
10678 if ( transition ) {
10679 // Prevent transitioning after transition is complete
10680 this.transitionTimeout = setTimeout( function () {
10681 widget.$element.removeClass( 'oo-ui-popupWidget-transitioning' );
10682 }, 200 );
10683 } else {
10684 // Prevent transitioning immediately
10685 this.$element.removeClass( 'oo-ui-popupWidget-transitioning' );
10686 }
10687
10688 // Reevaluate clipping state since we've relocated and resized the popup
10689 this.clip();
10690
10691 return this;
10692 };
10693
10694 /**
10695 * Progress bar widget.
10696 *
10697 * @class
10698 * @extends OO.ui.Widget
10699 *
10700 * @constructor
10701 * @param {Object} [config] Configuration options
10702 * @cfg {number} [progress=0] Initial progress
10703 */
10704 OO.ui.ProgressBarWidget = function OoUiProgressBarWidget( config ) {
10705 // Configuration initialization
10706 config = config || {};
10707
10708 // Parent constructor
10709 OO.ui.ProgressBarWidget.super.call( this, config );
10710
10711 // Properties
10712 this.$bar = this.$( '<div>' );
10713 this.progress = null;
10714
10715 // Initialization
10716 this.setProgress( config.progress || 0 );
10717 this.$bar.addClass( 'oo-ui-progressBarWidget-bar');
10718 this.$element
10719 .attr( {
10720 role: 'progressbar',
10721 'aria-valuemin': 0,
10722 'aria-valuemax': 100
10723 } )
10724 .addClass( 'oo-ui-progressBarWidget' )
10725 .append( this.$bar );
10726 };
10727
10728 /* Setup */
10729
10730 OO.inheritClass( OO.ui.ProgressBarWidget, OO.ui.Widget );
10731
10732 /* Static Properties */
10733
10734 OO.ui.ProgressBarWidget.static.tagName = 'div';
10735
10736 /* Methods */
10737
10738 /**
10739 * Get progress percent
10740 *
10741 * @return {number} Progress percent
10742 */
10743 OO.ui.ProgressBarWidget.prototype.getProgress = function () {
10744 return this.progress;
10745 };
10746
10747 /**
10748 * Set progress percent
10749 *
10750 * @param {number} progress Progress percent
10751 */
10752 OO.ui.ProgressBarWidget.prototype.setProgress = function ( progress ) {
10753 this.progress = progress;
10754
10755 this.$bar.css( 'width', this.progress + '%' );
10756 this.$element.attr( 'aria-valuenow', this.progress );
10757 };
10758
10759 /**
10760 * Search widget.
10761 *
10762 * Search widgets combine a query input, placed above, and a results selection widget, placed below.
10763 * Results are cleared and populated each time the query is changed.
10764 *
10765 * @class
10766 * @extends OO.ui.Widget
10767 *
10768 * @constructor
10769 * @param {Object} [config] Configuration options
10770 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
10771 * @cfg {string} [value] Initial query value
10772 */
10773 OO.ui.SearchWidget = function OoUiSearchWidget( config ) {
10774 // Configuration intialization
10775 config = config || {};
10776
10777 // Parent constructor
10778 OO.ui.SearchWidget.super.call( this, config );
10779
10780 // Properties
10781 this.query = new OO.ui.TextInputWidget( {
10782 $: this.$,
10783 icon: 'search',
10784 placeholder: config.placeholder,
10785 value: config.value
10786 } );
10787 this.results = new OO.ui.SelectWidget( { $: this.$ } );
10788 this.$query = this.$( '<div>' );
10789 this.$results = this.$( '<div>' );
10790
10791 // Events
10792 this.query.connect( this, {
10793 change: 'onQueryChange',
10794 enter: 'onQueryEnter'
10795 } );
10796 this.results.connect( this, {
10797 highlight: 'onResultsHighlight',
10798 select: 'onResultsSelect'
10799 } );
10800 this.query.$input.on( 'keydown', this.onQueryKeydown.bind( this ) );
10801
10802 // Initialization
10803 this.$query
10804 .addClass( 'oo-ui-searchWidget-query' )
10805 .append( this.query.$element );
10806 this.$results
10807 .addClass( 'oo-ui-searchWidget-results' )
10808 .append( this.results.$element );
10809 this.$element
10810 .addClass( 'oo-ui-searchWidget' )
10811 .append( this.$results, this.$query );
10812 };
10813
10814 /* Setup */
10815
10816 OO.inheritClass( OO.ui.SearchWidget, OO.ui.Widget );
10817
10818 /* Events */
10819
10820 /**
10821 * @event highlight
10822 * @param {Object|null} item Item data or null if no item is highlighted
10823 */
10824
10825 /**
10826 * @event select
10827 * @param {Object|null} item Item data or null if no item is selected
10828 */
10829
10830 /* Methods */
10831
10832 /**
10833 * Handle query key down events.
10834 *
10835 * @param {jQuery.Event} e Key down event
10836 */
10837 OO.ui.SearchWidget.prototype.onQueryKeydown = function ( e ) {
10838 var highlightedItem, nextItem,
10839 dir = e.which === OO.ui.Keys.DOWN ? 1 : ( e.which === OO.ui.Keys.UP ? -1 : 0 );
10840
10841 if ( dir ) {
10842 highlightedItem = this.results.getHighlightedItem();
10843 if ( !highlightedItem ) {
10844 highlightedItem = this.results.getSelectedItem();
10845 }
10846 nextItem = this.results.getRelativeSelectableItem( highlightedItem, dir );
10847 this.results.highlightItem( nextItem );
10848 nextItem.scrollElementIntoView();
10849 }
10850 };
10851
10852 /**
10853 * Handle select widget select events.
10854 *
10855 * Clears existing results. Subclasses should repopulate items according to new query.
10856 *
10857 * @param {string} value New value
10858 */
10859 OO.ui.SearchWidget.prototype.onQueryChange = function () {
10860 // Reset
10861 this.results.clearItems();
10862 };
10863
10864 /**
10865 * Handle select widget enter key events.
10866 *
10867 * Selects highlighted item.
10868 *
10869 * @param {string} value New value
10870 */
10871 OO.ui.SearchWidget.prototype.onQueryEnter = function () {
10872 // Reset
10873 this.results.selectItem( this.results.getHighlightedItem() );
10874 };
10875
10876 /**
10877 * Handle select widget highlight events.
10878 *
10879 * @param {OO.ui.OptionWidget} item Highlighted item
10880 * @fires highlight
10881 */
10882 OO.ui.SearchWidget.prototype.onResultsHighlight = function ( item ) {
10883 this.emit( 'highlight', item ? item.getData() : null );
10884 };
10885
10886 /**
10887 * Handle select widget select events.
10888 *
10889 * @param {OO.ui.OptionWidget} item Selected item
10890 * @fires select
10891 */
10892 OO.ui.SearchWidget.prototype.onResultsSelect = function ( item ) {
10893 this.emit( 'select', item ? item.getData() : null );
10894 };
10895
10896 /**
10897 * Get the query input.
10898 *
10899 * @return {OO.ui.TextInputWidget} Query input
10900 */
10901 OO.ui.SearchWidget.prototype.getQuery = function () {
10902 return this.query;
10903 };
10904
10905 /**
10906 * Get the results list.
10907 *
10908 * @return {OO.ui.SelectWidget} Select list
10909 */
10910 OO.ui.SearchWidget.prototype.getResults = function () {
10911 return this.results;
10912 };
10913
10914 /**
10915 * Generic selection of options.
10916 *
10917 * Items can contain any rendering, and are uniquely identified by a hash of their data. Any widget
10918 * that provides options, from which the user must choose one, should be built on this class.
10919 *
10920 * Use together with OO.ui.OptionWidget.
10921 *
10922 * @class
10923 * @extends OO.ui.Widget
10924 * @mixins OO.ui.GroupElement
10925 *
10926 * @constructor
10927 * @param {Object} [config] Configuration options
10928 * @cfg {OO.ui.OptionWidget[]} [items] Options to add
10929 */
10930 OO.ui.SelectWidget = function OoUiSelectWidget( config ) {
10931 // Configuration initialization
10932 config = config || {};
10933
10934 // Parent constructor
10935 OO.ui.SelectWidget.super.call( this, config );
10936
10937 // Mixin constructors
10938 OO.ui.GroupWidget.call( this, $.extend( {}, config, { $group: this.$element } ) );
10939
10940 // Properties
10941 this.pressed = false;
10942 this.selecting = null;
10943 this.hashes = {};
10944 this.onMouseUpHandler = this.onMouseUp.bind( this );
10945 this.onMouseMoveHandler = this.onMouseMove.bind( this );
10946
10947 // Events
10948 this.$element.on( {
10949 mousedown: this.onMouseDown.bind( this ),
10950 mouseover: this.onMouseOver.bind( this ),
10951 mouseleave: this.onMouseLeave.bind( this )
10952 } );
10953
10954 // Initialization
10955 this.$element.addClass( 'oo-ui-selectWidget oo-ui-selectWidget-depressed' );
10956 if ( $.isArray( config.items ) ) {
10957 this.addItems( config.items );
10958 }
10959 };
10960
10961 /* Setup */
10962
10963 OO.inheritClass( OO.ui.SelectWidget, OO.ui.Widget );
10964
10965 // Need to mixin base class as well
10966 OO.mixinClass( OO.ui.SelectWidget, OO.ui.GroupElement );
10967 OO.mixinClass( OO.ui.SelectWidget, OO.ui.GroupWidget );
10968
10969 /* Events */
10970
10971 /**
10972 * @event highlight
10973 * @param {OO.ui.OptionWidget|null} item Highlighted item
10974 */
10975
10976 /**
10977 * @event press
10978 * @param {OO.ui.OptionWidget|null} item Pressed item
10979 */
10980
10981 /**
10982 * @event select
10983 * @param {OO.ui.OptionWidget|null} item Selected item
10984 */
10985
10986 /**
10987 * @event choose
10988 * @param {OO.ui.OptionWidget|null} item Chosen item
10989 */
10990
10991 /**
10992 * @event add
10993 * @param {OO.ui.OptionWidget[]} items Added items
10994 * @param {number} index Index items were added at
10995 */
10996
10997 /**
10998 * @event remove
10999 * @param {OO.ui.OptionWidget[]} items Removed items
11000 */
11001
11002 /* Methods */
11003
11004 /**
11005 * Handle mouse down events.
11006 *
11007 * @private
11008 * @param {jQuery.Event} e Mouse down event
11009 */
11010 OO.ui.SelectWidget.prototype.onMouseDown = function ( e ) {
11011 var item;
11012
11013 if ( !this.isDisabled() && e.which === 1 ) {
11014 this.togglePressed( true );
11015 item = this.getTargetItem( e );
11016 if ( item && item.isSelectable() ) {
11017 this.pressItem( item );
11018 this.selecting = item;
11019 this.getElementDocument().addEventListener(
11020 'mouseup',
11021 this.onMouseUpHandler,
11022 true
11023 );
11024 this.getElementDocument().addEventListener(
11025 'mousemove',
11026 this.onMouseMoveHandler,
11027 true
11028 );
11029 }
11030 }
11031 return false;
11032 };
11033
11034 /**
11035 * Handle mouse up events.
11036 *
11037 * @private
11038 * @param {jQuery.Event} e Mouse up event
11039 */
11040 OO.ui.SelectWidget.prototype.onMouseUp = function ( e ) {
11041 var item;
11042
11043 this.togglePressed( false );
11044 if ( !this.selecting ) {
11045 item = this.getTargetItem( e );
11046 if ( item && item.isSelectable() ) {
11047 this.selecting = item;
11048 }
11049 }
11050 if ( !this.isDisabled() && e.which === 1 && this.selecting ) {
11051 this.pressItem( null );
11052 this.chooseItem( this.selecting );
11053 this.selecting = null;
11054 }
11055
11056 this.getElementDocument().removeEventListener(
11057 'mouseup',
11058 this.onMouseUpHandler,
11059 true
11060 );
11061 this.getElementDocument().removeEventListener(
11062 'mousemove',
11063 this.onMouseMoveHandler,
11064 true
11065 );
11066
11067 return false;
11068 };
11069
11070 /**
11071 * Handle mouse move events.
11072 *
11073 * @private
11074 * @param {jQuery.Event} e Mouse move event
11075 */
11076 OO.ui.SelectWidget.prototype.onMouseMove = function ( e ) {
11077 var item;
11078
11079 if ( !this.isDisabled() && this.pressed ) {
11080 item = this.getTargetItem( e );
11081 if ( item && item !== this.selecting && item.isSelectable() ) {
11082 this.pressItem( item );
11083 this.selecting = item;
11084 }
11085 }
11086 return false;
11087 };
11088
11089 /**
11090 * Handle mouse over events.
11091 *
11092 * @private
11093 * @param {jQuery.Event} e Mouse over event
11094 */
11095 OO.ui.SelectWidget.prototype.onMouseOver = function ( e ) {
11096 var item;
11097
11098 if ( !this.isDisabled() ) {
11099 item = this.getTargetItem( e );
11100 this.highlightItem( item && item.isHighlightable() ? item : null );
11101 }
11102 return false;
11103 };
11104
11105 /**
11106 * Handle mouse leave events.
11107 *
11108 * @private
11109 * @param {jQuery.Event} e Mouse over event
11110 */
11111 OO.ui.SelectWidget.prototype.onMouseLeave = function () {
11112 if ( !this.isDisabled() ) {
11113 this.highlightItem( null );
11114 }
11115 return false;
11116 };
11117
11118 /**
11119 * Get the closest item to a jQuery.Event.
11120 *
11121 * @private
11122 * @param {jQuery.Event} e
11123 * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
11124 */
11125 OO.ui.SelectWidget.prototype.getTargetItem = function ( e ) {
11126 var $item = this.$( e.target ).closest( '.oo-ui-optionWidget' );
11127 if ( $item.length ) {
11128 return $item.data( 'oo-ui-optionWidget' );
11129 }
11130 return null;
11131 };
11132
11133 /**
11134 * Get selected item.
11135 *
11136 * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
11137 */
11138 OO.ui.SelectWidget.prototype.getSelectedItem = function () {
11139 var i, len;
11140
11141 for ( i = 0, len = this.items.length; i < len; i++ ) {
11142 if ( this.items[i].isSelected() ) {
11143 return this.items[i];
11144 }
11145 }
11146 return null;
11147 };
11148
11149 /**
11150 * Get highlighted item.
11151 *
11152 * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
11153 */
11154 OO.ui.SelectWidget.prototype.getHighlightedItem = function () {
11155 var i, len;
11156
11157 for ( i = 0, len = this.items.length; i < len; i++ ) {
11158 if ( this.items[i].isHighlighted() ) {
11159 return this.items[i];
11160 }
11161 }
11162 return null;
11163 };
11164
11165 /**
11166 * Get an existing item with equivilant data.
11167 *
11168 * @param {Object} data Item data to search for
11169 * @return {OO.ui.OptionWidget|null} Item with equivilent value, `null` if none exists
11170 */
11171 OO.ui.SelectWidget.prototype.getItemFromData = function ( data ) {
11172 var hash = OO.getHash( data );
11173
11174 if ( Object.prototype.hasOwnProperty.call( this.hashes, hash ) ) {
11175 return this.hashes[hash];
11176 }
11177
11178 return null;
11179 };
11180
11181 /**
11182 * Toggle pressed state.
11183 *
11184 * @param {boolean} pressed An option is being pressed
11185 */
11186 OO.ui.SelectWidget.prototype.togglePressed = function ( pressed ) {
11187 if ( pressed === undefined ) {
11188 pressed = !this.pressed;
11189 }
11190 if ( pressed !== this.pressed ) {
11191 this.$element
11192 .toggleClass( 'oo-ui-selectWidget-pressed', pressed )
11193 .toggleClass( 'oo-ui-selectWidget-depressed', !pressed );
11194 this.pressed = pressed;
11195 }
11196 };
11197
11198 /**
11199 * Highlight an item.
11200 *
11201 * Highlighting is mutually exclusive.
11202 *
11203 * @param {OO.ui.OptionWidget} [item] Item to highlight, omit to deselect all
11204 * @fires highlight
11205 * @chainable
11206 */
11207 OO.ui.SelectWidget.prototype.highlightItem = function ( item ) {
11208 var i, len, highlighted,
11209 changed = false;
11210
11211 for ( i = 0, len = this.items.length; i < len; i++ ) {
11212 highlighted = this.items[i] === item;
11213 if ( this.items[i].isHighlighted() !== highlighted ) {
11214 this.items[i].setHighlighted( highlighted );
11215 changed = true;
11216 }
11217 }
11218 if ( changed ) {
11219 this.emit( 'highlight', item );
11220 }
11221
11222 return this;
11223 };
11224
11225 /**
11226 * Select an item.
11227 *
11228 * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
11229 * @fires select
11230 * @chainable
11231 */
11232 OO.ui.SelectWidget.prototype.selectItem = function ( item ) {
11233 var i, len, selected,
11234 changed = false;
11235
11236 for ( i = 0, len = this.items.length; i < len; i++ ) {
11237 selected = this.items[i] === item;
11238 if ( this.items[i].isSelected() !== selected ) {
11239 this.items[i].setSelected( selected );
11240 changed = true;
11241 }
11242 }
11243 if ( changed ) {
11244 this.emit( 'select', item );
11245 }
11246
11247 return this;
11248 };
11249
11250 /**
11251 * Press an item.
11252 *
11253 * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
11254 * @fires press
11255 * @chainable
11256 */
11257 OO.ui.SelectWidget.prototype.pressItem = function ( item ) {
11258 var i, len, pressed,
11259 changed = false;
11260
11261 for ( i = 0, len = this.items.length; i < len; i++ ) {
11262 pressed = this.items[i] === item;
11263 if ( this.items[i].isPressed() !== pressed ) {
11264 this.items[i].setPressed( pressed );
11265 changed = true;
11266 }
11267 }
11268 if ( changed ) {
11269 this.emit( 'press', item );
11270 }
11271
11272 return this;
11273 };
11274
11275 /**
11276 * Choose an item.
11277 *
11278 * Identical to #selectItem, but may vary in subclasses that want to take additional action when
11279 * an item is selected using the keyboard or mouse.
11280 *
11281 * @param {OO.ui.OptionWidget} item Item to choose
11282 * @fires choose
11283 * @chainable
11284 */
11285 OO.ui.SelectWidget.prototype.chooseItem = function ( item ) {
11286 this.selectItem( item );
11287 this.emit( 'choose', item );
11288
11289 return this;
11290 };
11291
11292 /**
11293 * Get an item relative to another one.
11294 *
11295 * @param {OO.ui.OptionWidget} item Item to start at
11296 * @param {number} direction Direction to move in
11297 * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the menu
11298 */
11299 OO.ui.SelectWidget.prototype.getRelativeSelectableItem = function ( item, direction ) {
11300 var inc = direction > 0 ? 1 : -1,
11301 len = this.items.length,
11302 index = item instanceof OO.ui.OptionWidget ?
11303 $.inArray( item, this.items ) : ( inc > 0 ? -1 : 0 ),
11304 stopAt = Math.max( Math.min( index, len - 1 ), 0 ),
11305 i = inc > 0 ?
11306 // Default to 0 instead of -1, if nothing is selected let's start at the beginning
11307 Math.max( index, -1 ) :
11308 // Default to n-1 instead of -1, if nothing is selected let's start at the end
11309 Math.min( index, len );
11310
11311 while ( len !== 0 ) {
11312 i = ( i + inc + len ) % len;
11313 item = this.items[i];
11314 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() ) {
11315 return item;
11316 }
11317 // Stop iterating when we've looped all the way around
11318 if ( i === stopAt ) {
11319 break;
11320 }
11321 }
11322 return null;
11323 };
11324
11325 /**
11326 * Get the next selectable item.
11327 *
11328 * @return {OO.ui.OptionWidget|null} Item, `null` if ther aren't any selectable items
11329 */
11330 OO.ui.SelectWidget.prototype.getFirstSelectableItem = function () {
11331 var i, len, item;
11332
11333 for ( i = 0, len = this.items.length; i < len; i++ ) {
11334 item = this.items[i];
11335 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() ) {
11336 return item;
11337 }
11338 }
11339
11340 return null;
11341 };
11342
11343 /**
11344 * Add items.
11345 *
11346 * When items are added with the same values as existing items, the existing items will be
11347 * automatically removed before the new items are added.
11348 *
11349 * @param {OO.ui.OptionWidget[]} items Items to add
11350 * @param {number} [index] Index to insert items after
11351 * @fires add
11352 * @chainable
11353 */
11354 OO.ui.SelectWidget.prototype.addItems = function ( items, index ) {
11355 var i, len, item, hash,
11356 remove = [];
11357
11358 for ( i = 0, len = items.length; i < len; i++ ) {
11359 item = items[i];
11360 hash = OO.getHash( item.getData() );
11361 if ( Object.prototype.hasOwnProperty.call( this.hashes, hash ) ) {
11362 // Remove item with same value
11363 remove.push( this.hashes[hash] );
11364 }
11365 this.hashes[hash] = item;
11366 }
11367 if ( remove.length ) {
11368 this.removeItems( remove );
11369 }
11370
11371 // Mixin method
11372 OO.ui.GroupWidget.prototype.addItems.call( this, items, index );
11373
11374 // Always provide an index, even if it was omitted
11375 this.emit( 'add', items, index === undefined ? this.items.length - items.length - 1 : index );
11376
11377 return this;
11378 };
11379
11380 /**
11381 * Remove items.
11382 *
11383 * Items will be detached, not removed, so they can be used later.
11384 *
11385 * @param {OO.ui.OptionWidget[]} items Items to remove
11386 * @fires remove
11387 * @chainable
11388 */
11389 OO.ui.SelectWidget.prototype.removeItems = function ( items ) {
11390 var i, len, item, hash;
11391
11392 for ( i = 0, len = items.length; i < len; i++ ) {
11393 item = items[i];
11394 hash = OO.getHash( item.getData() );
11395 if ( Object.prototype.hasOwnProperty.call( this.hashes, hash ) ) {
11396 // Remove existing item
11397 delete this.hashes[hash];
11398 }
11399 if ( item.isSelected() ) {
11400 this.selectItem( null );
11401 }
11402 }
11403
11404 // Mixin method
11405 OO.ui.GroupWidget.prototype.removeItems.call( this, items );
11406
11407 this.emit( 'remove', items );
11408
11409 return this;
11410 };
11411
11412 /**
11413 * Clear all items.
11414 *
11415 * Items will be detached, not removed, so they can be used later.
11416 *
11417 * @fires remove
11418 * @chainable
11419 */
11420 OO.ui.SelectWidget.prototype.clearItems = function () {
11421 var items = this.items.slice();
11422
11423 // Clear all items
11424 this.hashes = {};
11425 // Mixin method
11426 OO.ui.GroupWidget.prototype.clearItems.call( this );
11427 this.selectItem( null );
11428
11429 this.emit( 'remove', items );
11430
11431 return this;
11432 };
11433
11434 /**
11435 * Select widget containing button options.
11436 *
11437 * Use together with OO.ui.ButtonOptionWidget.
11438 *
11439 * @class
11440 * @extends OO.ui.SelectWidget
11441 *
11442 * @constructor
11443 * @param {Object} [config] Configuration options
11444 */
11445 OO.ui.ButtonSelectWidget = function OoUiButtonSelectWidget( config ) {
11446 // Parent constructor
11447 OO.ui.ButtonSelectWidget.super.call( this, config );
11448
11449 // Initialization
11450 this.$element.addClass( 'oo-ui-buttonSelectWidget' );
11451 };
11452
11453 /* Setup */
11454
11455 OO.inheritClass( OO.ui.ButtonSelectWidget, OO.ui.SelectWidget );
11456
11457 /**
11458 * Overlaid menu of options.
11459 *
11460 * Menus are clipped to the visible viewport. They do not provide a control for opening or closing
11461 * the menu.
11462 *
11463 * Use together with OO.ui.MenuItemWidget.
11464 *
11465 * @class
11466 * @extends OO.ui.SelectWidget
11467 * @mixins OO.ui.ClippableElement
11468 *
11469 * @constructor
11470 * @param {Object} [config] Configuration options
11471 * @cfg {OO.ui.InputWidget} [input] Input to bind keyboard handlers to
11472 * @cfg {OO.ui.Widget} [widget] Widget to bind mouse handlers to
11473 * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu
11474 */
11475 OO.ui.MenuWidget = function OoUiMenuWidget( config ) {
11476 // Configuration initialization
11477 config = config || {};
11478
11479 // Parent constructor
11480 OO.ui.MenuWidget.super.call( this, config );
11481
11482 // Mixin constructors
11483 OO.ui.ClippableElement.call( this, $.extend( {}, config, { $clippable: this.$group } ) );
11484
11485 // Properties
11486 this.flashing = false;
11487 this.visible = false;
11488 this.newItems = null;
11489 this.autoHide = config.autoHide === undefined || !!config.autoHide;
11490 this.$input = config.input ? config.input.$input : null;
11491 this.$widget = config.widget ? config.widget.$element : null;
11492 this.$previousFocus = null;
11493 this.isolated = !config.input;
11494 this.onKeyDownHandler = this.onKeyDown.bind( this );
11495 this.onDocumentMouseDownHandler = this.onDocumentMouseDown.bind( this );
11496
11497 // Initialization
11498 this.$element
11499 .hide()
11500 .attr( 'role', 'menu' )
11501 .addClass( 'oo-ui-menuWidget' );
11502 };
11503
11504 /* Setup */
11505
11506 OO.inheritClass( OO.ui.MenuWidget, OO.ui.SelectWidget );
11507 OO.mixinClass( OO.ui.MenuWidget, OO.ui.ClippableElement );
11508
11509 /* Methods */
11510
11511 /**
11512 * Handles document mouse down events.
11513 *
11514 * @param {jQuery.Event} e Key down event
11515 */
11516 OO.ui.MenuWidget.prototype.onDocumentMouseDown = function ( e ) {
11517 if (
11518 !OO.ui.contains( this.$element[0], e.target, true ) &&
11519 ( !this.$widget || !OO.ui.contains( this.$widget[0], e.target, true ) )
11520 ) {
11521 this.toggle( false );
11522 }
11523 };
11524
11525 /**
11526 * Handles key down events.
11527 *
11528 * @param {jQuery.Event} e Key down event
11529 */
11530 OO.ui.MenuWidget.prototype.onKeyDown = function ( e ) {
11531 var nextItem,
11532 handled = false,
11533 highlightItem = this.getHighlightedItem();
11534
11535 if ( !this.isDisabled() && this.isVisible() ) {
11536 if ( !highlightItem ) {
11537 highlightItem = this.getSelectedItem();
11538 }
11539 switch ( e.keyCode ) {
11540 case OO.ui.Keys.ENTER:
11541 this.chooseItem( highlightItem );
11542 handled = true;
11543 break;
11544 case OO.ui.Keys.UP:
11545 nextItem = this.getRelativeSelectableItem( highlightItem, -1 );
11546 handled = true;
11547 break;
11548 case OO.ui.Keys.DOWN:
11549 nextItem = this.getRelativeSelectableItem( highlightItem, 1 );
11550 handled = true;
11551 break;
11552 case OO.ui.Keys.ESCAPE:
11553 if ( highlightItem ) {
11554 highlightItem.setHighlighted( false );
11555 }
11556 this.toggle( false );
11557 handled = true;
11558 break;
11559 }
11560
11561 if ( nextItem ) {
11562 this.highlightItem( nextItem );
11563 nextItem.scrollElementIntoView();
11564 }
11565
11566 if ( handled ) {
11567 e.preventDefault();
11568 e.stopPropagation();
11569 return false;
11570 }
11571 }
11572 };
11573
11574 /**
11575 * Bind key down listener.
11576 */
11577 OO.ui.MenuWidget.prototype.bindKeyDownListener = function () {
11578 if ( this.$input ) {
11579 this.$input.on( 'keydown', this.onKeyDownHandler );
11580 } else {
11581 // Capture menu navigation keys
11582 this.getElementWindow().addEventListener( 'keydown', this.onKeyDownHandler, true );
11583 }
11584 };
11585
11586 /**
11587 * Unbind key down listener.
11588 */
11589 OO.ui.MenuWidget.prototype.unbindKeyDownListener = function () {
11590 if ( this.$input ) {
11591 this.$input.off( 'keydown' );
11592 } else {
11593 this.getElementWindow().removeEventListener( 'keydown', this.onKeyDownHandler, true );
11594 }
11595 };
11596
11597 /**
11598 * Choose an item.
11599 *
11600 * This will close the menu when done, unlike selectItem which only changes selection.
11601 *
11602 * @param {OO.ui.OptionWidget} item Item to choose
11603 * @chainable
11604 */
11605 OO.ui.MenuWidget.prototype.chooseItem = function ( item ) {
11606 var widget = this;
11607
11608 // Parent method
11609 OO.ui.MenuWidget.super.prototype.chooseItem.call( this, item );
11610
11611 if ( item && !this.flashing ) {
11612 this.flashing = true;
11613 item.flash().done( function () {
11614 widget.toggle( false );
11615 widget.flashing = false;
11616 } );
11617 } else {
11618 this.toggle( false );
11619 }
11620
11621 return this;
11622 };
11623
11624 /**
11625 * @inheritdoc
11626 */
11627 OO.ui.MenuWidget.prototype.addItems = function ( items, index ) {
11628 var i, len, item;
11629
11630 // Parent method
11631 OO.ui.MenuWidget.super.prototype.addItems.call( this, items, index );
11632
11633 // Auto-initialize
11634 if ( !this.newItems ) {
11635 this.newItems = [];
11636 }
11637
11638 for ( i = 0, len = items.length; i < len; i++ ) {
11639 item = items[i];
11640 if ( this.isVisible() ) {
11641 // Defer fitting label until item has been attached
11642 item.fitLabel();
11643 } else {
11644 this.newItems.push( item );
11645 }
11646 }
11647
11648 // Reevaluate clipping
11649 this.clip();
11650
11651 return this;
11652 };
11653
11654 /**
11655 * @inheritdoc
11656 */
11657 OO.ui.MenuWidget.prototype.removeItems = function ( items ) {
11658 // Parent method
11659 OO.ui.MenuWidget.super.prototype.removeItems.call( this, items );
11660
11661 // Reevaluate clipping
11662 this.clip();
11663
11664 return this;
11665 };
11666
11667 /**
11668 * @inheritdoc
11669 */
11670 OO.ui.MenuWidget.prototype.clearItems = function () {
11671 // Parent method
11672 OO.ui.MenuWidget.super.prototype.clearItems.call( this );
11673
11674 // Reevaluate clipping
11675 this.clip();
11676
11677 return this;
11678 };
11679
11680 /**
11681 * @inheritdoc
11682 */
11683 OO.ui.MenuWidget.prototype.toggle = function ( visible ) {
11684 visible = ( visible === undefined ? !this.visible : !!visible ) && !!this.items.length;
11685
11686 var i, len,
11687 change = visible !== this.isVisible(),
11688 elementDoc = this.getElementDocument(),
11689 widgetDoc = this.$widget ? this.$widget[0].ownerDocument : null;
11690
11691 // Parent method
11692 OO.ui.MenuWidget.super.prototype.toggle.call( this, visible );
11693
11694 if ( change ) {
11695 if ( visible ) {
11696 this.bindKeyDownListener();
11697
11698 // Change focus to enable keyboard navigation
11699 if ( this.isolated && this.$input && !this.$input.is( ':focus' ) ) {
11700 this.$previousFocus = this.$( ':focus' );
11701 this.$input[0].focus();
11702 }
11703 if ( this.newItems && this.newItems.length ) {
11704 for ( i = 0, len = this.newItems.length; i < len; i++ ) {
11705 this.newItems[i].fitLabel();
11706 }
11707 this.newItems = null;
11708 }
11709 this.toggleClipping( true );
11710
11711 // Auto-hide
11712 if ( this.autoHide ) {
11713 elementDoc.addEventListener(
11714 'mousedown', this.onDocumentMouseDownHandler, true
11715 );
11716 // Support $widget being in a different document
11717 if ( widgetDoc && widgetDoc !== elementDoc ) {
11718 widgetDoc.addEventListener(
11719 'mousedown', this.onDocumentMouseDownHandler, true
11720 );
11721 }
11722 }
11723 } else {
11724 this.unbindKeyDownListener();
11725 if ( this.isolated && this.$previousFocus ) {
11726 this.$previousFocus[0].focus();
11727 this.$previousFocus = null;
11728 }
11729 elementDoc.removeEventListener(
11730 'mousedown', this.onDocumentMouseDownHandler, true
11731 );
11732 // Support $widget being in a different document
11733 if ( widgetDoc && widgetDoc !== elementDoc ) {
11734 widgetDoc.removeEventListener(
11735 'mousedown', this.onDocumentMouseDownHandler, true
11736 );
11737 }
11738 this.toggleClipping( false );
11739 }
11740 }
11741
11742 return this;
11743 };
11744
11745 /**
11746 * Menu for a text input widget.
11747 *
11748 * This menu is specially designed to be positioned beneath the text input widget. Even if the input
11749 * is in a different frame, the menu's position is automatically calculated and maintained when the
11750 * menu is toggled or the window is resized.
11751 *
11752 * @class
11753 * @extends OO.ui.MenuWidget
11754 *
11755 * @constructor
11756 * @param {OO.ui.TextInputWidget} input Text input widget to provide menu for
11757 * @param {Object} [config] Configuration options
11758 * @cfg {jQuery} [$container=input.$element] Element to render menu under
11759 */
11760 OO.ui.TextInputMenuWidget = function OoUiTextInputMenuWidget( input, config ) {
11761 // Configuration intialization
11762 config = config || {};
11763
11764 // Parent constructor
11765 OO.ui.TextInputMenuWidget.super.call( this, config );
11766
11767 // Properties
11768 this.input = input;
11769 this.$container = config.$container || this.input.$element;
11770 this.onWindowResizeHandler = this.onWindowResize.bind( this );
11771
11772 // Initialization
11773 this.$element.addClass( 'oo-ui-textInputMenuWidget' );
11774 };
11775
11776 /* Setup */
11777
11778 OO.inheritClass( OO.ui.TextInputMenuWidget, OO.ui.MenuWidget );
11779
11780 /* Methods */
11781
11782 /**
11783 * Handle window resize event.
11784 *
11785 * @param {jQuery.Event} e Window resize event
11786 */
11787 OO.ui.TextInputMenuWidget.prototype.onWindowResize = function () {
11788 this.position();
11789 };
11790
11791 /**
11792 * @inheritdoc
11793 */
11794 OO.ui.TextInputMenuWidget.prototype.toggle = function ( visible ) {
11795 visible = visible === undefined ? !this.isVisible() : !!visible;
11796
11797 var change = visible !== this.isVisible();
11798
11799 if ( change && visible ) {
11800 // Make sure the width is set before the parent method runs.
11801 // After this we have to call this.position(); again to actually
11802 // position ourselves correctly.
11803 this.position();
11804 }
11805
11806 // Parent method
11807 OO.ui.TextInputMenuWidget.super.prototype.toggle.call( this, visible );
11808
11809 if ( change ) {
11810 if ( this.isVisible() ) {
11811 this.position();
11812 this.$( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler );
11813 } else {
11814 this.$( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler );
11815 }
11816 }
11817
11818 return this;
11819 };
11820
11821 /**
11822 * Position the menu.
11823 *
11824 * @chainable
11825 */
11826 OO.ui.TextInputMenuWidget.prototype.position = function () {
11827 var $container = this.$container,
11828 pos = OO.ui.Element.getRelativePosition( $container, this.$element.offsetParent() );
11829
11830 // Position under input
11831 pos.top += $container.height();
11832 this.$element.css( pos );
11833
11834 // Set width
11835 this.setIdealSize( $container.width() );
11836 // We updated the position, so re-evaluate the clipping state
11837 this.clip();
11838
11839 return this;
11840 };
11841
11842 /**
11843 * Structured list of items.
11844 *
11845 * Use with OO.ui.OutlineItemWidget.
11846 *
11847 * @class
11848 * @extends OO.ui.SelectWidget
11849 *
11850 * @constructor
11851 * @param {Object} [config] Configuration options
11852 */
11853 OO.ui.OutlineWidget = function OoUiOutlineWidget( config ) {
11854 // Configuration initialization
11855 config = config || {};
11856
11857 // Parent constructor
11858 OO.ui.OutlineWidget.super.call( this, config );
11859
11860 // Initialization
11861 this.$element.addClass( 'oo-ui-outlineWidget' );
11862 };
11863
11864 /* Setup */
11865
11866 OO.inheritClass( OO.ui.OutlineWidget, OO.ui.SelectWidget );
11867
11868 /**
11869 * Switch that slides on and off.
11870 *
11871 * @class
11872 * @extends OO.ui.Widget
11873 * @mixins OO.ui.ToggleWidget
11874 *
11875 * @constructor
11876 * @param {Object} [config] Configuration options
11877 * @cfg {boolean} [value=false] Initial value
11878 */
11879 OO.ui.ToggleSwitchWidget = function OoUiToggleSwitchWidget( config ) {
11880 // Parent constructor
11881 OO.ui.ToggleSwitchWidget.super.call( this, config );
11882
11883 // Mixin constructors
11884 OO.ui.ToggleWidget.call( this, config );
11885
11886 // Properties
11887 this.dragging = false;
11888 this.dragStart = null;
11889 this.sliding = false;
11890 this.$glow = this.$( '<span>' );
11891 this.$grip = this.$( '<span>' );
11892
11893 // Events
11894 this.$element.on( 'click', this.onClick.bind( this ) );
11895
11896 // Initialization
11897 this.$glow.addClass( 'oo-ui-toggleSwitchWidget-glow' );
11898 this.$grip.addClass( 'oo-ui-toggleSwitchWidget-grip' );
11899 this.$element
11900 .addClass( 'oo-ui-toggleSwitchWidget' )
11901 .append( this.$glow, this.$grip );
11902 };
11903
11904 /* Setup */
11905
11906 OO.inheritClass( OO.ui.ToggleSwitchWidget, OO.ui.Widget );
11907 OO.mixinClass( OO.ui.ToggleSwitchWidget, OO.ui.ToggleWidget );
11908
11909 /* Methods */
11910
11911 /**
11912 * Handle mouse down events.
11913 *
11914 * @param {jQuery.Event} e Mouse down event
11915 */
11916 OO.ui.ToggleSwitchWidget.prototype.onClick = function ( e ) {
11917 if ( !this.isDisabled() && e.which === 1 ) {
11918 this.setValue( !this.value );
11919 }
11920 };
11921
11922 }( OO ) );