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