Merge "Avoid DBPerformance warnings on PURGE/TRACE requests"
[lhc/web/wiklou.git] / resources / lib / oojs-ui / oojs-ui-core.js
1 /*!
2 * OOjs UI v0.17.3
3 * https://www.mediawiki.org/wiki/OOjs_UI
4 *
5 * Copyright 2011–2016 OOjs UI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
8 *
9 * Date: 2016-05-24T22:46:32Z
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 * Constants for MouseEvent.which
49 *
50 * @property {Object}
51 */
52 OO.ui.MouseButtons = {
53 LEFT: 1,
54 MIDDLE: 2,
55 RIGHT: 3
56 };
57
58 /**
59 * @property {number}
60 */
61 OO.ui.elementId = 0;
62
63 /**
64 * Generate a unique ID for element
65 *
66 * @return {string} [id]
67 */
68 OO.ui.generateElementId = function () {
69 OO.ui.elementId += 1;
70 return 'oojsui-' + OO.ui.elementId;
71 };
72
73 /**
74 * Check if an element is focusable.
75 * Inspired from :focusable in jQueryUI v1.11.4 - 2015-04-14
76 *
77 * @param {jQuery} $element Element to test
78 * @return {boolean}
79 */
80 OO.ui.isFocusableElement = function ( $element ) {
81 var nodeName,
82 element = $element[ 0 ];
83
84 // Anything disabled is not focusable
85 if ( element.disabled ) {
86 return false;
87 }
88
89 // Check if the element is visible
90 if ( !(
91 // This is quicker than calling $element.is( ':visible' )
92 $.expr.filters.visible( element ) &&
93 // Check that all parents are visible
94 !$element.parents().addBack().filter( function () {
95 return $.css( this, 'visibility' ) === 'hidden';
96 } ).length
97 ) ) {
98 return false;
99 }
100
101 // Check if the element is ContentEditable, which is the string 'true'
102 if ( element.contentEditable === 'true' ) {
103 return true;
104 }
105
106 // Anything with a non-negative numeric tabIndex is focusable.
107 // Use .prop to avoid browser bugs
108 if ( $element.prop( 'tabIndex' ) >= 0 ) {
109 return true;
110 }
111
112 // Some element types are naturally focusable
113 // (indexOf is much faster than regex in Chrome and about the
114 // same in FF: https://jsperf.com/regex-vs-indexof-array2)
115 nodeName = element.nodeName.toLowerCase();
116 if ( [ 'input', 'select', 'textarea', 'button', 'object' ].indexOf( nodeName ) !== -1 ) {
117 return true;
118 }
119
120 // Links and areas are focusable if they have an href
121 if ( ( nodeName === 'a' || nodeName === 'area' ) && $element.attr( 'href' ) !== undefined ) {
122 return true;
123 }
124
125 return false;
126 };
127
128 /**
129 * Find a focusable child
130 *
131 * @param {jQuery} $container Container to search in
132 * @param {boolean} [backwards] Search backwards
133 * @return {jQuery} Focusable child, an empty jQuery object if none found
134 */
135 OO.ui.findFocusable = function ( $container, backwards ) {
136 var $focusable = $( [] ),
137 // $focusableCandidates is a superset of things that
138 // could get matched by isFocusableElement
139 $focusableCandidates = $container
140 .find( 'input, select, textarea, button, object, a, area, [contenteditable], [tabindex]' );
141
142 if ( backwards ) {
143 $focusableCandidates = Array.prototype.reverse.call( $focusableCandidates );
144 }
145
146 $focusableCandidates.each( function () {
147 var $this = $( this );
148 if ( OO.ui.isFocusableElement( $this ) ) {
149 $focusable = $this;
150 return false;
151 }
152 } );
153 return $focusable;
154 };
155
156 /**
157 * Get the user's language and any fallback languages.
158 *
159 * These language codes are used to localize user interface elements in the user's language.
160 *
161 * In environments that provide a localization system, this function should be overridden to
162 * return the user's language(s). The default implementation returns English (en) only.
163 *
164 * @return {string[]} Language codes, in descending order of priority
165 */
166 OO.ui.getUserLanguages = function () {
167 return [ 'en' ];
168 };
169
170 /**
171 * Get a value in an object keyed by language code.
172 *
173 * @param {Object.<string,Mixed>} obj Object keyed by language code
174 * @param {string|null} [lang] Language code, if omitted or null defaults to any user language
175 * @param {string} [fallback] Fallback code, used if no matching language can be found
176 * @return {Mixed} Local value
177 */
178 OO.ui.getLocalValue = function ( obj, lang, fallback ) {
179 var i, len, langs;
180
181 // Requested language
182 if ( obj[ lang ] ) {
183 return obj[ lang ];
184 }
185 // Known user language
186 langs = OO.ui.getUserLanguages();
187 for ( i = 0, len = langs.length; i < len; i++ ) {
188 lang = langs[ i ];
189 if ( obj[ lang ] ) {
190 return obj[ lang ];
191 }
192 }
193 // Fallback language
194 if ( obj[ fallback ] ) {
195 return obj[ fallback ];
196 }
197 // First existing language
198 for ( lang in obj ) {
199 return obj[ lang ];
200 }
201
202 return undefined;
203 };
204
205 /**
206 * Check if a node is contained within another node
207 *
208 * Similar to jQuery#contains except a list of containers can be supplied
209 * and a boolean argument allows you to include the container in the match list
210 *
211 * @param {HTMLElement|HTMLElement[]} containers Container node(s) to search in
212 * @param {HTMLElement} contained Node to find
213 * @param {boolean} [matchContainers] Include the container(s) in the list of nodes to match, otherwise only match descendants
214 * @return {boolean} The node is in the list of target nodes
215 */
216 OO.ui.contains = function ( containers, contained, matchContainers ) {
217 var i;
218 if ( !Array.isArray( containers ) ) {
219 containers = [ containers ];
220 }
221 for ( i = containers.length - 1; i >= 0; i-- ) {
222 if ( ( matchContainers && contained === containers[ i ] ) || $.contains( containers[ i ], contained ) ) {
223 return true;
224 }
225 }
226 return false;
227 };
228
229 /**
230 * Return a function, that, as long as it continues to be invoked, will not
231 * be triggered. The function will be called after it stops being called for
232 * N milliseconds. If `immediate` is passed, trigger the function on the
233 * leading edge, instead of the trailing.
234 *
235 * Ported from: http://underscorejs.org/underscore.js
236 *
237 * @param {Function} func
238 * @param {number} wait
239 * @param {boolean} immediate
240 * @return {Function}
241 */
242 OO.ui.debounce = function ( func, wait, immediate ) {
243 var timeout;
244 return function () {
245 var context = this,
246 args = arguments,
247 later = function () {
248 timeout = null;
249 if ( !immediate ) {
250 func.apply( context, args );
251 }
252 };
253 if ( immediate && !timeout ) {
254 func.apply( context, args );
255 }
256 if ( !timeout || wait ) {
257 clearTimeout( timeout );
258 timeout = setTimeout( later, wait );
259 }
260 };
261 };
262
263 /**
264 * Returns a function, that, when invoked, will only be triggered at most once
265 * during a given window of time. If called again during that window, it will
266 * wait until the window ends and then trigger itself again.
267 *
268 * As it's not knowable to the caller whether the function will actually run
269 * when the wrapper is called, return values from the function are entirely
270 * discarded.
271 *
272 * @param {Function} func
273 * @param {number} wait
274 * @return {Function}
275 */
276 OO.ui.throttle = function ( func, wait ) {
277 var context, args, timeout,
278 previous = 0,
279 run = function () {
280 timeout = null;
281 previous = OO.ui.now();
282 func.apply( context, args );
283 };
284 return function () {
285 // Check how long it's been since the last time the function was
286 // called, and whether it's more or less than the requested throttle
287 // period. If it's less, run the function immediately. If it's more,
288 // set a timeout for the remaining time -- but don't replace an
289 // existing timeout, since that'd indefinitely prolong the wait.
290 var remaining = wait - ( OO.ui.now() - previous );
291 context = this;
292 args = arguments;
293 if ( remaining <= 0 ) {
294 // Note: unless wait was ridiculously large, this means we'll
295 // automatically run the first time the function was called in a
296 // given period. (If you provide a wait period larger than the
297 // current Unix timestamp, you *deserve* unexpected behavior.)
298 clearTimeout( timeout );
299 run();
300 } else if ( !timeout ) {
301 timeout = setTimeout( run, remaining );
302 }
303 };
304 };
305
306 /**
307 * A (possibly faster) way to get the current timestamp as an integer
308 *
309 * @return {number} Current timestamp
310 */
311 OO.ui.now = Date.now || function () {
312 return new Date().getTime();
313 };
314
315 /**
316 * Proxy for `node.addEventListener( eventName, handler, true )`.
317 *
318 * @param {HTMLElement} node
319 * @param {string} eventName
320 * @param {Function} handler
321 * @deprecated since 0.15.0
322 */
323 OO.ui.addCaptureEventListener = function ( node, eventName, handler ) {
324 node.addEventListener( eventName, handler, true );
325 };
326
327 /**
328 * Proxy for `node.removeEventListener( eventName, handler, true )`.
329 *
330 * @param {HTMLElement} node
331 * @param {string} eventName
332 * @param {Function} handler
333 * @deprecated since 0.15.0
334 */
335 OO.ui.removeCaptureEventListener = function ( node, eventName, handler ) {
336 node.removeEventListener( eventName, handler, true );
337 };
338
339 /**
340 * Reconstitute a JavaScript object corresponding to a widget created by
341 * the PHP implementation.
342 *
343 * This is an alias for `OO.ui.Element.static.infuse()`.
344 *
345 * @param {string|HTMLElement|jQuery} idOrNode
346 * A DOM id (if a string) or node for the widget to infuse.
347 * @return {OO.ui.Element}
348 * The `OO.ui.Element` corresponding to this (infusable) document node.
349 */
350 OO.ui.infuse = function ( idOrNode ) {
351 return OO.ui.Element.static.infuse( idOrNode );
352 };
353
354 ( function () {
355 /**
356 * Message store for the default implementation of OO.ui.msg
357 *
358 * Environments that provide a localization system should not use this, but should override
359 * OO.ui.msg altogether.
360 *
361 * @private
362 */
363 var messages = {
364 // Tool tip for a button that moves items in a list down one place
365 'ooui-outline-control-move-down': 'Move item down',
366 // Tool tip for a button that moves items in a list up one place
367 'ooui-outline-control-move-up': 'Move item up',
368 // Tool tip for a button that removes items from a list
369 'ooui-outline-control-remove': 'Remove item',
370 // Label for the toolbar group that contains a list of all other available tools
371 'ooui-toolbar-more': 'More',
372 // Label for the fake tool that expands the full list of tools in a toolbar group
373 'ooui-toolgroup-expand': 'More',
374 // Label for the fake tool that collapses the full list of tools in a toolbar group
375 'ooui-toolgroup-collapse': 'Fewer',
376 // Default label for the accept button of a confirmation dialog
377 'ooui-dialog-message-accept': 'OK',
378 // Default label for the reject button of a confirmation dialog
379 'ooui-dialog-message-reject': 'Cancel',
380 // Title for process dialog error description
381 'ooui-dialog-process-error': 'Something went wrong',
382 // Label for process dialog dismiss error button, visible when describing errors
383 'ooui-dialog-process-dismiss': 'Dismiss',
384 // Label for process dialog retry action button, visible when describing only recoverable errors
385 'ooui-dialog-process-retry': 'Try again',
386 // Label for process dialog retry action button, visible when describing only warnings
387 'ooui-dialog-process-continue': 'Continue',
388 // Label for the file selection widget's select file button
389 'ooui-selectfile-button-select': 'Select a file',
390 // Label for the file selection widget if file selection is not supported
391 'ooui-selectfile-not-supported': 'File selection is not supported',
392 // Label for the file selection widget when no file is currently selected
393 'ooui-selectfile-placeholder': 'No file is selected',
394 // Label for the file selection widget's drop target
395 'ooui-selectfile-dragdrop-placeholder': 'Drop file here'
396 };
397
398 /**
399 * Get a localized message.
400 *
401 * In environments that provide a localization system, this function should be overridden to
402 * return the message translated in the user's language. The default implementation always returns
403 * English messages.
404 *
405 * After the message key, message parameters may optionally be passed. In the default implementation,
406 * any occurrences of $1 are replaced with the first parameter, $2 with the second parameter, etc.
407 * Alternative implementations of OO.ui.msg may use any substitution system they like, as long as
408 * they support unnamed, ordered message parameters.
409 *
410 * @param {string} key Message key
411 * @param {...Mixed} [params] Message parameters
412 * @return {string} Translated message with parameters substituted
413 */
414 OO.ui.msg = function ( key ) {
415 var message = messages[ key ],
416 params = Array.prototype.slice.call( arguments, 1 );
417 if ( typeof message === 'string' ) {
418 // Perform $1 substitution
419 message = message.replace( /\$(\d+)/g, function ( unused, n ) {
420 var i = parseInt( n, 10 );
421 return params[ i - 1 ] !== undefined ? params[ i - 1 ] : '$' + n;
422 } );
423 } else {
424 // Return placeholder if message not found
425 message = '[' + key + ']';
426 }
427 return message;
428 };
429 } )();
430
431 /**
432 * Package a message and arguments for deferred resolution.
433 *
434 * Use this when you are statically specifying a message and the message may not yet be present.
435 *
436 * @param {string} key Message key
437 * @param {...Mixed} [params] Message parameters
438 * @return {Function} Function that returns the resolved message when executed
439 */
440 OO.ui.deferMsg = function () {
441 var args = arguments;
442 return function () {
443 return OO.ui.msg.apply( OO.ui, args );
444 };
445 };
446
447 /**
448 * Resolve a message.
449 *
450 * If the message is a function it will be executed, otherwise it will pass through directly.
451 *
452 * @param {Function|string} msg Deferred message, or message text
453 * @return {string} Resolved message
454 */
455 OO.ui.resolveMsg = function ( msg ) {
456 if ( $.isFunction( msg ) ) {
457 return msg();
458 }
459 return msg;
460 };
461
462 /**
463 * @param {string} url
464 * @return {boolean}
465 */
466 OO.ui.isSafeUrl = function ( url ) {
467 // Keep this function in sync with php/Tag.php
468 var i, protocolWhitelist;
469
470 function stringStartsWith( haystack, needle ) {
471 return haystack.substr( 0, needle.length ) === needle;
472 }
473
474 protocolWhitelist = [
475 'bitcoin', 'ftp', 'ftps', 'geo', 'git', 'gopher', 'http', 'https', 'irc', 'ircs',
476 'magnet', 'mailto', 'mms', 'news', 'nntp', 'redis', 'sftp', 'sip', 'sips', 'sms', 'ssh',
477 'svn', 'tel', 'telnet', 'urn', 'worldwind', 'xmpp'
478 ];
479
480 if ( url === '' ) {
481 return true;
482 }
483
484 for ( i = 0; i < protocolWhitelist.length; i++ ) {
485 if ( stringStartsWith( url, protocolWhitelist[ i ] + ':' ) ) {
486 return true;
487 }
488 }
489
490 // This matches '//' too
491 if ( stringStartsWith( url, '/' ) || stringStartsWith( url, './' ) ) {
492 return true;
493 }
494 if ( stringStartsWith( url, '?' ) || stringStartsWith( url, '#' ) ) {
495 return true;
496 }
497
498 return false;
499 };
500
501 /*!
502 * Mixin namespace.
503 */
504
505 /**
506 * Namespace for OOjs UI mixins.
507 *
508 * Mixins are named according to the type of object they are intended to
509 * be mixed in to. For example, OO.ui.mixin.GroupElement is intended to be
510 * mixed in to an instance of OO.ui.Element, and OO.ui.mixin.GroupWidget
511 * is intended to be mixed in to an instance of OO.ui.Widget.
512 *
513 * @class
514 * @singleton
515 */
516 OO.ui.mixin = {};
517
518 /**
519 * Each Element represents a rendering in the DOM—a button or an icon, for example, or anything
520 * that is visible to a user. Unlike {@link OO.ui.Widget widgets}, plain elements usually do not have events
521 * connected to them and can't be interacted with.
522 *
523 * @abstract
524 * @class
525 *
526 * @constructor
527 * @param {Object} [config] Configuration options
528 * @cfg {string[]} [classes] The names of the CSS classes to apply to the element. CSS styles are added
529 * to the top level (e.g., the outermost div) of the element. See the [OOjs UI documentation on MediaWiki][2]
530 * for an example.
531 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches#cssExample
532 * @cfg {string} [id] The HTML id attribute used in the rendered tag.
533 * @cfg {string} [text] Text to insert
534 * @cfg {Array} [content] An array of content elements to append (after #text).
535 * Strings will be html-escaped; use an OO.ui.HtmlSnippet to append raw HTML.
536 * Instances of OO.ui.Element will have their $element appended.
537 * @cfg {jQuery} [$content] Content elements to append (after #text).
538 * @cfg {jQuery} [$element] Wrapper element. Defaults to a new element with #getTagName.
539 * @cfg {Mixed} [data] Custom data of any type or combination of types (e.g., string, number, array, object).
540 * Data can also be specified with the #setData method.
541 */
542 OO.ui.Element = function OoUiElement( config ) {
543 // Configuration initialization
544 config = config || {};
545
546 // Properties
547 this.$ = $;
548 this.visible = true;
549 this.data = config.data;
550 this.$element = config.$element ||
551 $( document.createElement( this.getTagName() ) );
552 this.elementGroup = null;
553 this.debouncedUpdateThemeClassesHandler = OO.ui.debounce( this.debouncedUpdateThemeClasses );
554
555 // Initialization
556 if ( Array.isArray( config.classes ) ) {
557 this.$element.addClass( config.classes.join( ' ' ) );
558 }
559 if ( config.id ) {
560 this.$element.attr( 'id', config.id );
561 }
562 if ( config.text ) {
563 this.$element.text( config.text );
564 }
565 if ( config.content ) {
566 // The `content` property treats plain strings as text; use an
567 // HtmlSnippet to append HTML content. `OO.ui.Element`s get their
568 // appropriate $element appended.
569 this.$element.append( config.content.map( function ( v ) {
570 if ( typeof v === 'string' ) {
571 // Escape string so it is properly represented in HTML.
572 return document.createTextNode( v );
573 } else if ( v instanceof OO.ui.HtmlSnippet ) {
574 // Bypass escaping.
575 return v.toString();
576 } else if ( v instanceof OO.ui.Element ) {
577 return v.$element;
578 }
579 return v;
580 } ) );
581 }
582 if ( config.$content ) {
583 // The `$content` property treats plain strings as HTML.
584 this.$element.append( config.$content );
585 }
586 };
587
588 /* Setup */
589
590 OO.initClass( OO.ui.Element );
591
592 /* Static Properties */
593
594 /**
595 * The name of the HTML tag used by the element.
596 *
597 * The static value may be ignored if the #getTagName method is overridden.
598 *
599 * @static
600 * @inheritable
601 * @property {string}
602 */
603 OO.ui.Element.static.tagName = 'div';
604
605 /* Static Methods */
606
607 /**
608 * Reconstitute a JavaScript object corresponding to a widget created
609 * by the PHP implementation.
610 *
611 * @param {string|HTMLElement|jQuery} idOrNode
612 * A DOM id (if a string) or node for the widget to infuse.
613 * @return {OO.ui.Element}
614 * The `OO.ui.Element` corresponding to this (infusable) document node.
615 * For `Tag` objects emitted on the HTML side (used occasionally for content)
616 * the value returned is a newly-created Element wrapping around the existing
617 * DOM node.
618 */
619 OO.ui.Element.static.infuse = function ( idOrNode ) {
620 var obj = OO.ui.Element.static.unsafeInfuse( idOrNode, false );
621 // Verify that the type matches up.
622 // FIXME: uncomment after T89721 is fixed (see T90929)
623 /*
624 if ( !( obj instanceof this['class'] ) ) {
625 throw new Error( 'Infusion type mismatch!' );
626 }
627 */
628 return obj;
629 };
630
631 /**
632 * Implementation helper for `infuse`; skips the type check and has an
633 * extra property so that only the top-level invocation touches the DOM.
634 *
635 * @private
636 * @param {string|HTMLElement|jQuery} idOrNode
637 * @param {jQuery.Promise|boolean} domPromise A promise that will be resolved
638 * when the top-level widget of this infusion is inserted into DOM,
639 * replacing the original node; or false for top-level invocation.
640 * @return {OO.ui.Element}
641 */
642 OO.ui.Element.static.unsafeInfuse = function ( idOrNode, domPromise ) {
643 // look for a cached result of a previous infusion.
644 var id, $elem, data, cls, parts, parent, obj, top, state, infusedChildren;
645 if ( typeof idOrNode === 'string' ) {
646 id = idOrNode;
647 $elem = $( document.getElementById( id ) );
648 } else {
649 $elem = $( idOrNode );
650 id = $elem.attr( 'id' );
651 }
652 if ( !$elem.length ) {
653 throw new Error( 'Widget not found: ' + id );
654 }
655 if ( $elem[ 0 ].oouiInfused ) {
656 $elem = $elem[ 0 ].oouiInfused;
657 }
658 data = $elem.data( 'ooui-infused' );
659 if ( data ) {
660 // cached!
661 if ( data === true ) {
662 throw new Error( 'Circular dependency! ' + id );
663 }
664 if ( domPromise ) {
665 // pick up dynamic state, like focus, value of form inputs, scroll position, etc.
666 state = data.constructor.static.gatherPreInfuseState( $elem, data );
667 // restore dynamic state after the new element is re-inserted into DOM under infused parent
668 domPromise.done( data.restorePreInfuseState.bind( data, state ) );
669 infusedChildren = $elem.data( 'ooui-infused-children' );
670 if ( infusedChildren && infusedChildren.length ) {
671 infusedChildren.forEach( function ( data ) {
672 var state = data.constructor.static.gatherPreInfuseState( $elem, data );
673 domPromise.done( data.restorePreInfuseState.bind( data, state ) );
674 } );
675 }
676 }
677 return data;
678 }
679 data = $elem.attr( 'data-ooui' );
680 if ( !data ) {
681 throw new Error( 'No infusion data found: ' + id );
682 }
683 try {
684 data = $.parseJSON( data );
685 } catch ( _ ) {
686 data = null;
687 }
688 if ( !( data && data._ ) ) {
689 throw new Error( 'No valid infusion data found: ' + id );
690 }
691 if ( data._ === 'Tag' ) {
692 // Special case: this is a raw Tag; wrap existing node, don't rebuild.
693 return new OO.ui.Element( { $element: $elem } );
694 }
695 parts = data._.split( '.' );
696 cls = OO.getProp.apply( OO, [ window ].concat( parts ) );
697 if ( cls === undefined ) {
698 // The PHP output might be old and not including the "OO.ui" prefix
699 // TODO: Remove this back-compat after next major release
700 cls = OO.getProp.apply( OO, [ OO.ui ].concat( parts ) );
701 if ( cls === undefined ) {
702 throw new Error( 'Unknown widget type: id: ' + id + ', class: ' + data._ );
703 }
704 }
705
706 // Verify that we're creating an OO.ui.Element instance
707 parent = cls.parent;
708
709 while ( parent !== undefined ) {
710 if ( parent === OO.ui.Element ) {
711 // Safe
712 break;
713 }
714
715 parent = parent.parent;
716 }
717
718 if ( parent !== OO.ui.Element ) {
719 throw new Error( 'Unknown widget type: id: ' + id + ', class: ' + data._ );
720 }
721
722 if ( domPromise === false ) {
723 top = $.Deferred();
724 domPromise = top.promise();
725 }
726 $elem.data( 'ooui-infused', true ); // prevent loops
727 data.id = id; // implicit
728 infusedChildren = [];
729 data = OO.copy( data, null, function deserialize( value ) {
730 var infused;
731 if ( OO.isPlainObject( value ) ) {
732 if ( value.tag ) {
733 infused = OO.ui.Element.static.unsafeInfuse( value.tag, domPromise );
734 infusedChildren.push( infused );
735 // Flatten the structure
736 infusedChildren.push.apply( infusedChildren, infused.$element.data( 'ooui-infused-children' ) || [] );
737 infused.$element.removeData( 'ooui-infused-children' );
738 return infused;
739 }
740 if ( value.html !== undefined ) {
741 return new OO.ui.HtmlSnippet( value.html );
742 }
743 }
744 } );
745 // allow widgets to reuse parts of the DOM
746 data = cls.static.reusePreInfuseDOM( $elem[ 0 ], data );
747 // pick up dynamic state, like focus, value of form inputs, scroll position, etc.
748 state = cls.static.gatherPreInfuseState( $elem[ 0 ], data );
749 // rebuild widget
750 // jscs:disable requireCapitalizedConstructors
751 obj = new cls( data );
752 // jscs:enable requireCapitalizedConstructors
753 // now replace old DOM with this new DOM.
754 if ( top ) {
755 // An efficient constructor might be able to reuse the entire DOM tree of the original element,
756 // so only mutate the DOM if we need to.
757 if ( $elem[ 0 ] !== obj.$element[ 0 ] ) {
758 $elem.replaceWith( obj.$element );
759 // This element is now gone from the DOM, but if anyone is holding a reference to it,
760 // let's allow them to OO.ui.infuse() it and do what they expect (T105828).
761 // Do not use jQuery.data(), as using it on detached nodes leaks memory in 1.x line by design.
762 $elem[ 0 ].oouiInfused = obj.$element;
763 }
764 top.resolve();
765 }
766 obj.$element.data( 'ooui-infused', obj );
767 obj.$element.data( 'ooui-infused-children', infusedChildren );
768 // set the 'data-ooui' attribute so we can identify infused widgets
769 obj.$element.attr( 'data-ooui', '' );
770 // restore dynamic state after the new element is inserted into DOM
771 domPromise.done( obj.restorePreInfuseState.bind( obj, state ) );
772 return obj;
773 };
774
775 /**
776 * Pick out parts of `node`'s DOM to be reused when infusing a widget.
777 *
778 * This method **must not** make any changes to the DOM, only find interesting pieces and add them
779 * to `config` (which should then be returned). Actual DOM juggling should then be done by the
780 * constructor, which will be given the enhanced config.
781 *
782 * @protected
783 * @param {HTMLElement} node
784 * @param {Object} config
785 * @return {Object}
786 */
787 OO.ui.Element.static.reusePreInfuseDOM = function ( node, config ) {
788 return config;
789 };
790
791 /**
792 * Gather the dynamic state (focus, value of form inputs, scroll position, etc.) of a HTML DOM node
793 * (and its children) that represent an Element of the same class and the given configuration,
794 * generated by the PHP implementation.
795 *
796 * This method is called just before `node` is detached from the DOM. The return value of this
797 * function will be passed to #restorePreInfuseState after the newly created widget's #$element
798 * is inserted into DOM to replace `node`.
799 *
800 * @protected
801 * @param {HTMLElement} node
802 * @param {Object} config
803 * @return {Object}
804 */
805 OO.ui.Element.static.gatherPreInfuseState = function () {
806 return {};
807 };
808
809 /**
810 * Get a jQuery function within a specific document.
811 *
812 * @static
813 * @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
814 * @param {jQuery} [$iframe] HTML iframe element that contains the document, omit if document is
815 * not in an iframe
816 * @return {Function} Bound jQuery function
817 */
818 OO.ui.Element.static.getJQuery = function ( context, $iframe ) {
819 function wrapper( selector ) {
820 return $( selector, wrapper.context );
821 }
822
823 wrapper.context = this.getDocument( context );
824
825 if ( $iframe ) {
826 wrapper.$iframe = $iframe;
827 }
828
829 return wrapper;
830 };
831
832 /**
833 * Get the document of an element.
834 *
835 * @static
836 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Object to get the document for
837 * @return {HTMLDocument|null} Document object
838 */
839 OO.ui.Element.static.getDocument = function ( obj ) {
840 // jQuery - selections created "offscreen" won't have a context, so .context isn't reliable
841 return ( obj[ 0 ] && obj[ 0 ].ownerDocument ) ||
842 // Empty jQuery selections might have a context
843 obj.context ||
844 // HTMLElement
845 obj.ownerDocument ||
846 // Window
847 obj.document ||
848 // HTMLDocument
849 ( obj.nodeType === 9 && obj ) ||
850 null;
851 };
852
853 /**
854 * Get the window of an element or document.
855 *
856 * @static
857 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the window for
858 * @return {Window} Window object
859 */
860 OO.ui.Element.static.getWindow = function ( obj ) {
861 var doc = this.getDocument( obj );
862 return doc.defaultView;
863 };
864
865 /**
866 * Get the direction of an element or document.
867 *
868 * @static
869 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the direction for
870 * @return {string} Text direction, either 'ltr' or 'rtl'
871 */
872 OO.ui.Element.static.getDir = function ( obj ) {
873 var isDoc, isWin;
874
875 if ( obj instanceof jQuery ) {
876 obj = obj[ 0 ];
877 }
878 isDoc = obj.nodeType === 9;
879 isWin = obj.document !== undefined;
880 if ( isDoc || isWin ) {
881 if ( isWin ) {
882 obj = obj.document;
883 }
884 obj = obj.body;
885 }
886 return $( obj ).css( 'direction' );
887 };
888
889 /**
890 * Get the offset between two frames.
891 *
892 * TODO: Make this function not use recursion.
893 *
894 * @static
895 * @param {Window} from Window of the child frame
896 * @param {Window} [to=window] Window of the parent frame
897 * @param {Object} [offset] Offset to start with, used internally
898 * @return {Object} Offset object, containing left and top properties
899 */
900 OO.ui.Element.static.getFrameOffset = function ( from, to, offset ) {
901 var i, len, frames, frame, rect;
902
903 if ( !to ) {
904 to = window;
905 }
906 if ( !offset ) {
907 offset = { top: 0, left: 0 };
908 }
909 if ( from.parent === from ) {
910 return offset;
911 }
912
913 // Get iframe element
914 frames = from.parent.document.getElementsByTagName( 'iframe' );
915 for ( i = 0, len = frames.length; i < len; i++ ) {
916 if ( frames[ i ].contentWindow === from ) {
917 frame = frames[ i ];
918 break;
919 }
920 }
921
922 // Recursively accumulate offset values
923 if ( frame ) {
924 rect = frame.getBoundingClientRect();
925 offset.left += rect.left;
926 offset.top += rect.top;
927 if ( from !== to ) {
928 this.getFrameOffset( from.parent, offset );
929 }
930 }
931 return offset;
932 };
933
934 /**
935 * Get the offset between two elements.
936 *
937 * The two elements may be in a different frame, but in that case the frame $element is in must
938 * be contained in the frame $anchor is in.
939 *
940 * @static
941 * @param {jQuery} $element Element whose position to get
942 * @param {jQuery} $anchor Element to get $element's position relative to
943 * @return {Object} Translated position coordinates, containing top and left properties
944 */
945 OO.ui.Element.static.getRelativePosition = function ( $element, $anchor ) {
946 var iframe, iframePos,
947 pos = $element.offset(),
948 anchorPos = $anchor.offset(),
949 elementDocument = this.getDocument( $element ),
950 anchorDocument = this.getDocument( $anchor );
951
952 // If $element isn't in the same document as $anchor, traverse up
953 while ( elementDocument !== anchorDocument ) {
954 iframe = elementDocument.defaultView.frameElement;
955 if ( !iframe ) {
956 throw new Error( '$element frame is not contained in $anchor frame' );
957 }
958 iframePos = $( iframe ).offset();
959 pos.left += iframePos.left;
960 pos.top += iframePos.top;
961 elementDocument = iframe.ownerDocument;
962 }
963 pos.left -= anchorPos.left;
964 pos.top -= anchorPos.top;
965 return pos;
966 };
967
968 /**
969 * Get element border sizes.
970 *
971 * @static
972 * @param {HTMLElement} el Element to measure
973 * @return {Object} Dimensions object with `top`, `left`, `bottom` and `right` properties
974 */
975 OO.ui.Element.static.getBorders = function ( el ) {
976 var doc = el.ownerDocument,
977 win = doc.defaultView,
978 style = win.getComputedStyle( el, null ),
979 $el = $( el ),
980 top = parseFloat( style ? style.borderTopWidth : $el.css( 'borderTopWidth' ) ) || 0,
981 left = parseFloat( style ? style.borderLeftWidth : $el.css( 'borderLeftWidth' ) ) || 0,
982 bottom = parseFloat( style ? style.borderBottomWidth : $el.css( 'borderBottomWidth' ) ) || 0,
983 right = parseFloat( style ? style.borderRightWidth : $el.css( 'borderRightWidth' ) ) || 0;
984
985 return {
986 top: top,
987 left: left,
988 bottom: bottom,
989 right: right
990 };
991 };
992
993 /**
994 * Get dimensions of an element or window.
995 *
996 * @static
997 * @param {HTMLElement|Window} el Element to measure
998 * @return {Object} Dimensions object with `borders`, `scroll`, `scrollbar` and `rect` properties
999 */
1000 OO.ui.Element.static.getDimensions = function ( el ) {
1001 var $el, $win,
1002 doc = el.ownerDocument || el.document,
1003 win = doc.defaultView;
1004
1005 if ( win === el || el === doc.documentElement ) {
1006 $win = $( win );
1007 return {
1008 borders: { top: 0, left: 0, bottom: 0, right: 0 },
1009 scroll: {
1010 top: $win.scrollTop(),
1011 left: $win.scrollLeft()
1012 },
1013 scrollbar: { right: 0, bottom: 0 },
1014 rect: {
1015 top: 0,
1016 left: 0,
1017 bottom: $win.innerHeight(),
1018 right: $win.innerWidth()
1019 }
1020 };
1021 } else {
1022 $el = $( el );
1023 return {
1024 borders: this.getBorders( el ),
1025 scroll: {
1026 top: $el.scrollTop(),
1027 left: $el.scrollLeft()
1028 },
1029 scrollbar: {
1030 right: $el.innerWidth() - el.clientWidth,
1031 bottom: $el.innerHeight() - el.clientHeight
1032 },
1033 rect: el.getBoundingClientRect()
1034 };
1035 }
1036 };
1037
1038 /**
1039 * Get scrollable object parent
1040 *
1041 * documentElement can't be used to get or set the scrollTop
1042 * property on Blink. Changing and testing its value lets us
1043 * use 'body' or 'documentElement' based on what is working.
1044 *
1045 * https://code.google.com/p/chromium/issues/detail?id=303131
1046 *
1047 * @static
1048 * @param {HTMLElement} el Element to find scrollable parent for
1049 * @return {HTMLElement} Scrollable parent
1050 */
1051 OO.ui.Element.static.getRootScrollableElement = function ( el ) {
1052 var scrollTop, body;
1053
1054 if ( OO.ui.scrollableElement === undefined ) {
1055 body = el.ownerDocument.body;
1056 scrollTop = body.scrollTop;
1057 body.scrollTop = 1;
1058
1059 if ( body.scrollTop === 1 ) {
1060 body.scrollTop = scrollTop;
1061 OO.ui.scrollableElement = 'body';
1062 } else {
1063 OO.ui.scrollableElement = 'documentElement';
1064 }
1065 }
1066
1067 return el.ownerDocument[ OO.ui.scrollableElement ];
1068 };
1069
1070 /**
1071 * Get closest scrollable container.
1072 *
1073 * Traverses up until either a scrollable element or the root is reached, in which case the window
1074 * will be returned.
1075 *
1076 * @static
1077 * @param {HTMLElement} el Element to find scrollable container for
1078 * @param {string} [dimension] Dimension of scrolling to look for; `x`, `y` or omit for either
1079 * @return {HTMLElement} Closest scrollable container
1080 */
1081 OO.ui.Element.static.getClosestScrollableContainer = function ( el, dimension ) {
1082 var i, val,
1083 // props = [ 'overflow' ] doesn't work due to https://bugzilla.mozilla.org/show_bug.cgi?id=889091
1084 props = [ 'overflow-x', 'overflow-y' ],
1085 $parent = $( el ).parent();
1086
1087 if ( dimension === 'x' || dimension === 'y' ) {
1088 props = [ 'overflow-' + dimension ];
1089 }
1090
1091 while ( $parent.length ) {
1092 if ( $parent[ 0 ] === this.getRootScrollableElement( el ) ) {
1093 return $parent[ 0 ];
1094 }
1095 i = props.length;
1096 while ( i-- ) {
1097 val = $parent.css( props[ i ] );
1098 if ( val === 'auto' || val === 'scroll' ) {
1099 return $parent[ 0 ];
1100 }
1101 }
1102 $parent = $parent.parent();
1103 }
1104 return this.getDocument( el ).body;
1105 };
1106
1107 /**
1108 * Scroll element into view.
1109 *
1110 * @static
1111 * @param {HTMLElement} el Element to scroll into view
1112 * @param {Object} [config] Configuration options
1113 * @param {string} [config.duration='fast'] jQuery animation duration value
1114 * @param {string} [config.direction] Scroll in only one direction, e.g. 'x' or 'y', omit
1115 * to scroll in both directions
1116 * @param {Function} [config.complete] Function to call when scrolling completes.
1117 * Deprecated since 0.15.4, use the return promise instead.
1118 * @return {jQuery.Promise} Promise which resolves when the scroll is complete
1119 */
1120 OO.ui.Element.static.scrollIntoView = function ( el, config ) {
1121 var position, animations, callback, container, $container, elementDimensions, containerDimensions, $window,
1122 deferred = $.Deferred();
1123
1124 // Configuration initialization
1125 config = config || {};
1126
1127 animations = {};
1128 callback = typeof config.complete === 'function' && config.complete;
1129 container = this.getClosestScrollableContainer( el, config.direction );
1130 $container = $( container );
1131 elementDimensions = this.getDimensions( el );
1132 containerDimensions = this.getDimensions( container );
1133 $window = $( this.getWindow( el ) );
1134
1135 // Compute the element's position relative to the container
1136 if ( $container.is( 'html, body' ) ) {
1137 // If the scrollable container is the root, this is easy
1138 position = {
1139 top: elementDimensions.rect.top,
1140 bottom: $window.innerHeight() - elementDimensions.rect.bottom,
1141 left: elementDimensions.rect.left,
1142 right: $window.innerWidth() - elementDimensions.rect.right
1143 };
1144 } else {
1145 // Otherwise, we have to subtract el's coordinates from container's coordinates
1146 position = {
1147 top: elementDimensions.rect.top - ( containerDimensions.rect.top + containerDimensions.borders.top ),
1148 bottom: containerDimensions.rect.bottom - containerDimensions.borders.bottom - containerDimensions.scrollbar.bottom - elementDimensions.rect.bottom,
1149 left: elementDimensions.rect.left - ( containerDimensions.rect.left + containerDimensions.borders.left ),
1150 right: containerDimensions.rect.right - containerDimensions.borders.right - containerDimensions.scrollbar.right - elementDimensions.rect.right
1151 };
1152 }
1153
1154 if ( !config.direction || config.direction === 'y' ) {
1155 if ( position.top < 0 ) {
1156 animations.scrollTop = containerDimensions.scroll.top + position.top;
1157 } else if ( position.top > 0 && position.bottom < 0 ) {
1158 animations.scrollTop = containerDimensions.scroll.top + Math.min( position.top, -position.bottom );
1159 }
1160 }
1161 if ( !config.direction || config.direction === 'x' ) {
1162 if ( position.left < 0 ) {
1163 animations.scrollLeft = containerDimensions.scroll.left + position.left;
1164 } else if ( position.left > 0 && position.right < 0 ) {
1165 animations.scrollLeft = containerDimensions.scroll.left + Math.min( position.left, -position.right );
1166 }
1167 }
1168 if ( !$.isEmptyObject( animations ) ) {
1169 $container.stop( true ).animate( animations, config.duration === undefined ? 'fast' : config.duration );
1170 $container.queue( function ( next ) {
1171 if ( callback ) {
1172 callback();
1173 }
1174 deferred.resolve();
1175 next();
1176 } );
1177 } else {
1178 if ( callback ) {
1179 callback();
1180 }
1181 deferred.resolve();
1182 }
1183 return deferred.promise();
1184 };
1185
1186 /**
1187 * Force the browser to reconsider whether it really needs to render scrollbars inside the element
1188 * and reserve space for them, because it probably doesn't.
1189 *
1190 * Workaround primarily for <https://code.google.com/p/chromium/issues/detail?id=387290>, but also
1191 * similar bugs in other browsers. "Just" forcing a reflow is not sufficient in all cases, we need
1192 * to first actually detach (or hide, but detaching is simpler) all children, *then* force a reflow,
1193 * and then reattach (or show) them back.
1194 *
1195 * @static
1196 * @param {HTMLElement} el Element to reconsider the scrollbars on
1197 */
1198 OO.ui.Element.static.reconsiderScrollbars = function ( el ) {
1199 var i, len, scrollLeft, scrollTop, nodes = [];
1200 // Save scroll position
1201 scrollLeft = el.scrollLeft;
1202 scrollTop = el.scrollTop;
1203 // Detach all children
1204 while ( el.firstChild ) {
1205 nodes.push( el.firstChild );
1206 el.removeChild( el.firstChild );
1207 }
1208 // Force reflow
1209 void el.offsetHeight;
1210 // Reattach all children
1211 for ( i = 0, len = nodes.length; i < len; i++ ) {
1212 el.appendChild( nodes[ i ] );
1213 }
1214 // Restore scroll position (no-op if scrollbars disappeared)
1215 el.scrollLeft = scrollLeft;
1216 el.scrollTop = scrollTop;
1217 };
1218
1219 /* Methods */
1220
1221 /**
1222 * Toggle visibility of an element.
1223 *
1224 * @param {boolean} [show] Make element visible, omit to toggle visibility
1225 * @fires visible
1226 * @chainable
1227 */
1228 OO.ui.Element.prototype.toggle = function ( show ) {
1229 show = show === undefined ? !this.visible : !!show;
1230
1231 if ( show !== this.isVisible() ) {
1232 this.visible = show;
1233 this.$element.toggleClass( 'oo-ui-element-hidden', !this.visible );
1234 this.emit( 'toggle', show );
1235 }
1236
1237 return this;
1238 };
1239
1240 /**
1241 * Check if element is visible.
1242 *
1243 * @return {boolean} element is visible
1244 */
1245 OO.ui.Element.prototype.isVisible = function () {
1246 return this.visible;
1247 };
1248
1249 /**
1250 * Get element data.
1251 *
1252 * @return {Mixed} Element data
1253 */
1254 OO.ui.Element.prototype.getData = function () {
1255 return this.data;
1256 };
1257
1258 /**
1259 * Set element data.
1260 *
1261 * @param {Mixed} data Element data
1262 * @chainable
1263 */
1264 OO.ui.Element.prototype.setData = function ( data ) {
1265 this.data = data;
1266 return this;
1267 };
1268
1269 /**
1270 * Check if element supports one or more methods.
1271 *
1272 * @param {string|string[]} methods Method or list of methods to check
1273 * @return {boolean} All methods are supported
1274 */
1275 OO.ui.Element.prototype.supports = function ( methods ) {
1276 var i, len,
1277 support = 0;
1278
1279 methods = Array.isArray( methods ) ? methods : [ methods ];
1280 for ( i = 0, len = methods.length; i < len; i++ ) {
1281 if ( $.isFunction( this[ methods[ i ] ] ) ) {
1282 support++;
1283 }
1284 }
1285
1286 return methods.length === support;
1287 };
1288
1289 /**
1290 * Update the theme-provided classes.
1291 *
1292 * @localdoc This is called in element mixins and widget classes any time state changes.
1293 * Updating is debounced, minimizing overhead of changing multiple attributes and
1294 * guaranteeing that theme updates do not occur within an element's constructor
1295 */
1296 OO.ui.Element.prototype.updateThemeClasses = function () {
1297 this.debouncedUpdateThemeClassesHandler();
1298 };
1299
1300 /**
1301 * @private
1302 * @localdoc This method is called directly from the QUnit tests instead of #updateThemeClasses, to
1303 * make them synchronous.
1304 */
1305 OO.ui.Element.prototype.debouncedUpdateThemeClasses = function () {
1306 OO.ui.theme.updateElementClasses( this );
1307 };
1308
1309 /**
1310 * Get the HTML tag name.
1311 *
1312 * Override this method to base the result on instance information.
1313 *
1314 * @return {string} HTML tag name
1315 */
1316 OO.ui.Element.prototype.getTagName = function () {
1317 return this.constructor.static.tagName;
1318 };
1319
1320 /**
1321 * Check if the element is attached to the DOM
1322 *
1323 * @return {boolean} The element is attached to the DOM
1324 */
1325 OO.ui.Element.prototype.isElementAttached = function () {
1326 return $.contains( this.getElementDocument(), this.$element[ 0 ] );
1327 };
1328
1329 /**
1330 * Get the DOM document.
1331 *
1332 * @return {HTMLDocument} Document object
1333 */
1334 OO.ui.Element.prototype.getElementDocument = function () {
1335 // Don't cache this in other ways either because subclasses could can change this.$element
1336 return OO.ui.Element.static.getDocument( this.$element );
1337 };
1338
1339 /**
1340 * Get the DOM window.
1341 *
1342 * @return {Window} Window object
1343 */
1344 OO.ui.Element.prototype.getElementWindow = function () {
1345 return OO.ui.Element.static.getWindow( this.$element );
1346 };
1347
1348 /**
1349 * Get closest scrollable container.
1350 *
1351 * @return {HTMLElement} Closest scrollable container
1352 */
1353 OO.ui.Element.prototype.getClosestScrollableElementContainer = function () {
1354 return OO.ui.Element.static.getClosestScrollableContainer( this.$element[ 0 ] );
1355 };
1356
1357 /**
1358 * Get group element is in.
1359 *
1360 * @return {OO.ui.mixin.GroupElement|null} Group element, null if none
1361 */
1362 OO.ui.Element.prototype.getElementGroup = function () {
1363 return this.elementGroup;
1364 };
1365
1366 /**
1367 * Set group element is in.
1368 *
1369 * @param {OO.ui.mixin.GroupElement|null} group Group element, null if none
1370 * @chainable
1371 */
1372 OO.ui.Element.prototype.setElementGroup = function ( group ) {
1373 this.elementGroup = group;
1374 return this;
1375 };
1376
1377 /**
1378 * Scroll element into view.
1379 *
1380 * @param {Object} [config] Configuration options
1381 * @return {jQuery.Promise} Promise which resolves when the scroll is complete
1382 */
1383 OO.ui.Element.prototype.scrollElementIntoView = function ( config ) {
1384 return OO.ui.Element.static.scrollIntoView( this.$element[ 0 ], config );
1385 };
1386
1387 /**
1388 * Restore the pre-infusion dynamic state for this widget.
1389 *
1390 * This method is called after #$element has been inserted into DOM. The parameter is the return
1391 * value of #gatherPreInfuseState.
1392 *
1393 * @protected
1394 * @param {Object} state
1395 */
1396 OO.ui.Element.prototype.restorePreInfuseState = function () {
1397 };
1398
1399 /**
1400 * Wraps an HTML snippet for use with configuration values which default
1401 * to strings. This bypasses the default html-escaping done to string
1402 * values.
1403 *
1404 * @class
1405 *
1406 * @constructor
1407 * @param {string} [content] HTML content
1408 */
1409 OO.ui.HtmlSnippet = function OoUiHtmlSnippet( content ) {
1410 // Properties
1411 this.content = content;
1412 };
1413
1414 /* Setup */
1415
1416 OO.initClass( OO.ui.HtmlSnippet );
1417
1418 /* Methods */
1419
1420 /**
1421 * Render into HTML.
1422 *
1423 * @return {string} Unchanged HTML snippet.
1424 */
1425 OO.ui.HtmlSnippet.prototype.toString = function () {
1426 return this.content;
1427 };
1428
1429 /**
1430 * Layouts are containers for elements and are used to arrange other widgets of arbitrary type in a way
1431 * that is centrally controlled and can be updated dynamically. Layouts can be, and usually are, combined.
1432 * See {@link OO.ui.FieldsetLayout FieldsetLayout}, {@link OO.ui.FieldLayout FieldLayout}, {@link OO.ui.FormLayout FormLayout},
1433 * {@link OO.ui.PanelLayout PanelLayout}, {@link OO.ui.StackLayout StackLayout}, {@link OO.ui.PageLayout PageLayout},
1434 * {@link OO.ui.HorizontalLayout HorizontalLayout}, and {@link OO.ui.BookletLayout BookletLayout} for more information and examples.
1435 *
1436 * @abstract
1437 * @class
1438 * @extends OO.ui.Element
1439 * @mixins OO.EventEmitter
1440 *
1441 * @constructor
1442 * @param {Object} [config] Configuration options
1443 */
1444 OO.ui.Layout = function OoUiLayout( config ) {
1445 // Configuration initialization
1446 config = config || {};
1447
1448 // Parent constructor
1449 OO.ui.Layout.parent.call( this, config );
1450
1451 // Mixin constructors
1452 OO.EventEmitter.call( this );
1453
1454 // Initialization
1455 this.$element.addClass( 'oo-ui-layout' );
1456 };
1457
1458 /* Setup */
1459
1460 OO.inheritClass( OO.ui.Layout, OO.ui.Element );
1461 OO.mixinClass( OO.ui.Layout, OO.EventEmitter );
1462
1463 /**
1464 * Widgets are compositions of one or more OOjs UI elements that users can both view
1465 * and interact with. All widgets can be configured and modified via a standard API,
1466 * and their state can change dynamically according to a model.
1467 *
1468 * @abstract
1469 * @class
1470 * @extends OO.ui.Element
1471 * @mixins OO.EventEmitter
1472 *
1473 * @constructor
1474 * @param {Object} [config] Configuration options
1475 * @cfg {boolean} [disabled=false] Disable the widget. Disabled widgets cannot be used and their
1476 * appearance reflects this state.
1477 */
1478 OO.ui.Widget = function OoUiWidget( config ) {
1479 // Initialize config
1480 config = $.extend( { disabled: false }, config );
1481
1482 // Parent constructor
1483 OO.ui.Widget.parent.call( this, config );
1484
1485 // Mixin constructors
1486 OO.EventEmitter.call( this );
1487
1488 // Properties
1489 this.disabled = null;
1490 this.wasDisabled = null;
1491
1492 // Initialization
1493 this.$element.addClass( 'oo-ui-widget' );
1494 this.setDisabled( !!config.disabled );
1495 };
1496
1497 /* Setup */
1498
1499 OO.inheritClass( OO.ui.Widget, OO.ui.Element );
1500 OO.mixinClass( OO.ui.Widget, OO.EventEmitter );
1501
1502 /* Static Properties */
1503
1504 /**
1505 * Whether this widget will behave reasonably when wrapped in a HTML `<label>`. If this is true,
1506 * wrappers such as OO.ui.FieldLayout may use a `<label>` instead of implementing own label click
1507 * handling.
1508 *
1509 * @static
1510 * @inheritable
1511 * @property {boolean}
1512 */
1513 OO.ui.Widget.static.supportsSimpleLabel = false;
1514
1515 /* Events */
1516
1517 /**
1518 * @event disable
1519 *
1520 * A 'disable' event is emitted when the disabled state of the widget changes
1521 * (i.e. on disable **and** enable).
1522 *
1523 * @param {boolean} disabled Widget is disabled
1524 */
1525
1526 /**
1527 * @event toggle
1528 *
1529 * A 'toggle' event is emitted when the visibility of the widget changes.
1530 *
1531 * @param {boolean} visible Widget is visible
1532 */
1533
1534 /* Methods */
1535
1536 /**
1537 * Check if the widget is disabled.
1538 *
1539 * @return {boolean} Widget is disabled
1540 */
1541 OO.ui.Widget.prototype.isDisabled = function () {
1542 return this.disabled;
1543 };
1544
1545 /**
1546 * Set the 'disabled' state of the widget.
1547 *
1548 * When a widget is disabled, it cannot be used and its appearance is updated to reflect this state.
1549 *
1550 * @param {boolean} disabled Disable widget
1551 * @chainable
1552 */
1553 OO.ui.Widget.prototype.setDisabled = function ( disabled ) {
1554 var isDisabled;
1555
1556 this.disabled = !!disabled;
1557 isDisabled = this.isDisabled();
1558 if ( isDisabled !== this.wasDisabled ) {
1559 this.$element.toggleClass( 'oo-ui-widget-disabled', isDisabled );
1560 this.$element.toggleClass( 'oo-ui-widget-enabled', !isDisabled );
1561 this.$element.attr( 'aria-disabled', isDisabled.toString() );
1562 this.emit( 'disable', isDisabled );
1563 this.updateThemeClasses();
1564 }
1565 this.wasDisabled = isDisabled;
1566
1567 return this;
1568 };
1569
1570 /**
1571 * Update the disabled state, in case of changes in parent widget.
1572 *
1573 * @chainable
1574 */
1575 OO.ui.Widget.prototype.updateDisabled = function () {
1576 this.setDisabled( this.disabled );
1577 return this;
1578 };
1579
1580 /**
1581 * Theme logic.
1582 *
1583 * @abstract
1584 * @class
1585 *
1586 * @constructor
1587 * @param {Object} [config] Configuration options
1588 */
1589 OO.ui.Theme = function OoUiTheme( config ) {
1590 // Configuration initialization
1591 config = config || {};
1592 };
1593
1594 /* Setup */
1595
1596 OO.initClass( OO.ui.Theme );
1597
1598 /* Methods */
1599
1600 /**
1601 * Get a list of classes to be applied to a widget.
1602 *
1603 * The 'on' and 'off' lists combined MUST contain keys for all classes the theme adds or removes,
1604 * otherwise state transitions will not work properly.
1605 *
1606 * @param {OO.ui.Element} element Element for which to get classes
1607 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
1608 */
1609 OO.ui.Theme.prototype.getElementClasses = function () {
1610 return { on: [], off: [] };
1611 };
1612
1613 /**
1614 * Update CSS classes provided by the theme.
1615 *
1616 * For elements with theme logic hooks, this should be called any time there's a state change.
1617 *
1618 * @param {OO.ui.Element} element Element for which to update classes
1619 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
1620 */
1621 OO.ui.Theme.prototype.updateElementClasses = function ( element ) {
1622 var $elements = $( [] ),
1623 classes = this.getElementClasses( element );
1624
1625 if ( element.$icon ) {
1626 $elements = $elements.add( element.$icon );
1627 }
1628 if ( element.$indicator ) {
1629 $elements = $elements.add( element.$indicator );
1630 }
1631
1632 $elements
1633 .removeClass( classes.off.join( ' ' ) )
1634 .addClass( classes.on.join( ' ' ) );
1635 };
1636
1637 /**
1638 * The TabIndexedElement class is an attribute mixin used to add additional functionality to an
1639 * element created by another class. The mixin provides a ‘tabIndex’ property, which specifies the
1640 * order in which users will navigate through the focusable elements via the "tab" key.
1641 *
1642 * @example
1643 * // TabIndexedElement is mixed into the ButtonWidget class
1644 * // to provide a tabIndex property.
1645 * var button1 = new OO.ui.ButtonWidget( {
1646 * label: 'fourth',
1647 * tabIndex: 4
1648 * } );
1649 * var button2 = new OO.ui.ButtonWidget( {
1650 * label: 'second',
1651 * tabIndex: 2
1652 * } );
1653 * var button3 = new OO.ui.ButtonWidget( {
1654 * label: 'third',
1655 * tabIndex: 3
1656 * } );
1657 * var button4 = new OO.ui.ButtonWidget( {
1658 * label: 'first',
1659 * tabIndex: 1
1660 * } );
1661 * $( 'body' ).append( button1.$element, button2.$element, button3.$element, button4.$element );
1662 *
1663 * @abstract
1664 * @class
1665 *
1666 * @constructor
1667 * @param {Object} [config] Configuration options
1668 * @cfg {jQuery} [$tabIndexed] The element that should use the tabindex functionality. By default,
1669 * the functionality is applied to the element created by the class ($element). If a different element is specified, the tabindex
1670 * functionality will be applied to it instead.
1671 * @cfg {number|null} [tabIndex=0] Number that specifies the element’s position in the tab-navigation
1672 * order (e.g., 1 for the first focusable element). Use 0 to use the default navigation order; use -1
1673 * to remove the element from the tab-navigation flow.
1674 */
1675 OO.ui.mixin.TabIndexedElement = function OoUiMixinTabIndexedElement( config ) {
1676 // Configuration initialization
1677 config = $.extend( { tabIndex: 0 }, config );
1678
1679 // Properties
1680 this.$tabIndexed = null;
1681 this.tabIndex = null;
1682
1683 // Events
1684 this.connect( this, { disable: 'onTabIndexedElementDisable' } );
1685
1686 // Initialization
1687 this.setTabIndex( config.tabIndex );
1688 this.setTabIndexedElement( config.$tabIndexed || this.$element );
1689 };
1690
1691 /* Setup */
1692
1693 OO.initClass( OO.ui.mixin.TabIndexedElement );
1694
1695 /* Methods */
1696
1697 /**
1698 * Set the element that should use the tabindex functionality.
1699 *
1700 * This method is used to retarget a tabindex mixin so that its functionality applies
1701 * to the specified element. If an element is currently using the functionality, the mixin’s
1702 * effect on that element is removed before the new element is set up.
1703 *
1704 * @param {jQuery} $tabIndexed Element that should use the tabindex functionality
1705 * @chainable
1706 */
1707 OO.ui.mixin.TabIndexedElement.prototype.setTabIndexedElement = function ( $tabIndexed ) {
1708 var tabIndex = this.tabIndex;
1709 // Remove attributes from old $tabIndexed
1710 this.setTabIndex( null );
1711 // Force update of new $tabIndexed
1712 this.$tabIndexed = $tabIndexed;
1713 this.tabIndex = tabIndex;
1714 return this.updateTabIndex();
1715 };
1716
1717 /**
1718 * Set the value of the tabindex.
1719 *
1720 * @param {number|null} tabIndex Tabindex value, or `null` for no tabindex
1721 * @chainable
1722 */
1723 OO.ui.mixin.TabIndexedElement.prototype.setTabIndex = function ( tabIndex ) {
1724 tabIndex = typeof tabIndex === 'number' ? tabIndex : null;
1725
1726 if ( this.tabIndex !== tabIndex ) {
1727 this.tabIndex = tabIndex;
1728 this.updateTabIndex();
1729 }
1730
1731 return this;
1732 };
1733
1734 /**
1735 * Update the `tabindex` attribute, in case of changes to tab index or
1736 * disabled state.
1737 *
1738 * @private
1739 * @chainable
1740 */
1741 OO.ui.mixin.TabIndexedElement.prototype.updateTabIndex = function () {
1742 if ( this.$tabIndexed ) {
1743 if ( this.tabIndex !== null ) {
1744 // Do not index over disabled elements
1745 this.$tabIndexed.attr( {
1746 tabindex: this.isDisabled() ? -1 : this.tabIndex,
1747 // Support: ChromeVox and NVDA
1748 // These do not seem to inherit aria-disabled from parent elements
1749 'aria-disabled': this.isDisabled().toString()
1750 } );
1751 } else {
1752 this.$tabIndexed.removeAttr( 'tabindex aria-disabled' );
1753 }
1754 }
1755 return this;
1756 };
1757
1758 /**
1759 * Handle disable events.
1760 *
1761 * @private
1762 * @param {boolean} disabled Element is disabled
1763 */
1764 OO.ui.mixin.TabIndexedElement.prototype.onTabIndexedElementDisable = function () {
1765 this.updateTabIndex();
1766 };
1767
1768 /**
1769 * Get the value of the tabindex.
1770 *
1771 * @return {number|null} Tabindex value
1772 */
1773 OO.ui.mixin.TabIndexedElement.prototype.getTabIndex = function () {
1774 return this.tabIndex;
1775 };
1776
1777 /**
1778 * ButtonElement is often mixed into other classes to generate a button, which is a clickable
1779 * interface element that can be configured with access keys for accessibility.
1780 * See the [OOjs UI documentation on MediaWiki] [1] for examples.
1781 *
1782 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches#Buttons
1783 *
1784 * @abstract
1785 * @class
1786 *
1787 * @constructor
1788 * @param {Object} [config] Configuration options
1789 * @cfg {jQuery} [$button] The button element created by the class.
1790 * If this configuration is omitted, the button element will use a generated `<a>`.
1791 * @cfg {boolean} [framed=true] Render the button with a frame
1792 */
1793 OO.ui.mixin.ButtonElement = function OoUiMixinButtonElement( config ) {
1794 // Configuration initialization
1795 config = config || {};
1796
1797 // Properties
1798 this.$button = null;
1799 this.framed = null;
1800 this.active = false;
1801 this.onMouseUpHandler = this.onMouseUp.bind( this );
1802 this.onMouseDownHandler = this.onMouseDown.bind( this );
1803 this.onKeyDownHandler = this.onKeyDown.bind( this );
1804 this.onKeyUpHandler = this.onKeyUp.bind( this );
1805 this.onClickHandler = this.onClick.bind( this );
1806 this.onKeyPressHandler = this.onKeyPress.bind( this );
1807
1808 // Initialization
1809 this.$element.addClass( 'oo-ui-buttonElement' );
1810 this.toggleFramed( config.framed === undefined || config.framed );
1811 this.setButtonElement( config.$button || $( '<a>' ) );
1812 };
1813
1814 /* Setup */
1815
1816 OO.initClass( OO.ui.mixin.ButtonElement );
1817
1818 /* Static Properties */
1819
1820 /**
1821 * Cancel mouse down events.
1822 *
1823 * This property is usually set to `true` to prevent the focus from changing when the button is clicked.
1824 * Classes such as {@link OO.ui.mixin.DraggableElement DraggableElement} and {@link OO.ui.ButtonOptionWidget ButtonOptionWidget}
1825 * use a value of `false` so that dragging behavior is possible and mousedown events can be handled by a
1826 * parent widget.
1827 *
1828 * @static
1829 * @inheritable
1830 * @property {boolean}
1831 */
1832 OO.ui.mixin.ButtonElement.static.cancelButtonMouseDownEvents = true;
1833
1834 /* Events */
1835
1836 /**
1837 * A 'click' event is emitted when the button element is clicked.
1838 *
1839 * @event click
1840 */
1841
1842 /* Methods */
1843
1844 /**
1845 * Set the button element.
1846 *
1847 * This method is used to retarget a button mixin so that its functionality applies to
1848 * the specified button element instead of the one created by the class. If a button element
1849 * is already set, the method will remove the mixin’s effect on that element.
1850 *
1851 * @param {jQuery} $button Element to use as button
1852 */
1853 OO.ui.mixin.ButtonElement.prototype.setButtonElement = function ( $button ) {
1854 if ( this.$button ) {
1855 this.$button
1856 .removeClass( 'oo-ui-buttonElement-button' )
1857 .removeAttr( 'role accesskey' )
1858 .off( {
1859 mousedown: this.onMouseDownHandler,
1860 keydown: this.onKeyDownHandler,
1861 click: this.onClickHandler,
1862 keypress: this.onKeyPressHandler
1863 } );
1864 }
1865
1866 this.$button = $button
1867 .addClass( 'oo-ui-buttonElement-button' )
1868 .attr( { role: 'button' } )
1869 .on( {
1870 mousedown: this.onMouseDownHandler,
1871 keydown: this.onKeyDownHandler,
1872 click: this.onClickHandler,
1873 keypress: this.onKeyPressHandler
1874 } );
1875 };
1876
1877 /**
1878 * Handles mouse down events.
1879 *
1880 * @protected
1881 * @param {jQuery.Event} e Mouse down event
1882 */
1883 OO.ui.mixin.ButtonElement.prototype.onMouseDown = function ( e ) {
1884 if ( this.isDisabled() || e.which !== OO.ui.MouseButtons.LEFT ) {
1885 return;
1886 }
1887 this.$element.addClass( 'oo-ui-buttonElement-pressed' );
1888 // Run the mouseup handler no matter where the mouse is when the button is let go, so we can
1889 // reliably remove the pressed class
1890 this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler, true );
1891 // Prevent change of focus unless specifically configured otherwise
1892 if ( this.constructor.static.cancelButtonMouseDownEvents ) {
1893 return false;
1894 }
1895 };
1896
1897 /**
1898 * Handles mouse up events.
1899 *
1900 * @protected
1901 * @param {MouseEvent} e Mouse up event
1902 */
1903 OO.ui.mixin.ButtonElement.prototype.onMouseUp = function ( e ) {
1904 if ( this.isDisabled() || e.which !== OO.ui.MouseButtons.LEFT ) {
1905 return;
1906 }
1907 this.$element.removeClass( 'oo-ui-buttonElement-pressed' );
1908 // Stop listening for mouseup, since we only needed this once
1909 this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler, true );
1910 };
1911
1912 /**
1913 * Handles mouse click events.
1914 *
1915 * @protected
1916 * @param {jQuery.Event} e Mouse click event
1917 * @fires click
1918 */
1919 OO.ui.mixin.ButtonElement.prototype.onClick = function ( e ) {
1920 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
1921 if ( this.emit( 'click' ) ) {
1922 return false;
1923 }
1924 }
1925 };
1926
1927 /**
1928 * Handles key down events.
1929 *
1930 * @protected
1931 * @param {jQuery.Event} e Key down event
1932 */
1933 OO.ui.mixin.ButtonElement.prototype.onKeyDown = function ( e ) {
1934 if ( this.isDisabled() || ( e.which !== OO.ui.Keys.SPACE && e.which !== OO.ui.Keys.ENTER ) ) {
1935 return;
1936 }
1937 this.$element.addClass( 'oo-ui-buttonElement-pressed' );
1938 // Run the keyup handler no matter where the key is when the button is let go, so we can
1939 // reliably remove the pressed class
1940 this.getElementDocument().addEventListener( 'keyup', this.onKeyUpHandler, true );
1941 };
1942
1943 /**
1944 * Handles key up events.
1945 *
1946 * @protected
1947 * @param {KeyboardEvent} e Key up event
1948 */
1949 OO.ui.mixin.ButtonElement.prototype.onKeyUp = function ( e ) {
1950 if ( this.isDisabled() || ( e.which !== OO.ui.Keys.SPACE && e.which !== OO.ui.Keys.ENTER ) ) {
1951 return;
1952 }
1953 this.$element.removeClass( 'oo-ui-buttonElement-pressed' );
1954 // Stop listening for keyup, since we only needed this once
1955 this.getElementDocument().removeEventListener( 'keyup', this.onKeyUpHandler, true );
1956 };
1957
1958 /**
1959 * Handles key press events.
1960 *
1961 * @protected
1962 * @param {jQuery.Event} e Key press event
1963 * @fires click
1964 */
1965 OO.ui.mixin.ButtonElement.prototype.onKeyPress = function ( e ) {
1966 if ( !this.isDisabled() && ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER ) ) {
1967 if ( this.emit( 'click' ) ) {
1968 return false;
1969 }
1970 }
1971 };
1972
1973 /**
1974 * Check if button has a frame.
1975 *
1976 * @return {boolean} Button is framed
1977 */
1978 OO.ui.mixin.ButtonElement.prototype.isFramed = function () {
1979 return this.framed;
1980 };
1981
1982 /**
1983 * Render the button with or without a frame. Omit the `framed` parameter to toggle the button frame on and off.
1984 *
1985 * @param {boolean} [framed] Make button framed, omit to toggle
1986 * @chainable
1987 */
1988 OO.ui.mixin.ButtonElement.prototype.toggleFramed = function ( framed ) {
1989 framed = framed === undefined ? !this.framed : !!framed;
1990 if ( framed !== this.framed ) {
1991 this.framed = framed;
1992 this.$element
1993 .toggleClass( 'oo-ui-buttonElement-frameless', !framed )
1994 .toggleClass( 'oo-ui-buttonElement-framed', framed );
1995 this.updateThemeClasses();
1996 }
1997
1998 return this;
1999 };
2000
2001 /**
2002 * Set the button's active state.
2003 *
2004 * The active state can be set on:
2005 *
2006 * - {@link OO.ui.ButtonOptionWidget ButtonOptionWidget} when it is selected
2007 * - {@link OO.ui.ToggleButtonWidget ToggleButtonWidget} when it is toggle on
2008 * - {@link OO.ui.ButtonWidget ButtonWidget} when clicking the button would only refresh the page
2009 *
2010 * @protected
2011 * @param {boolean} value Make button active
2012 * @chainable
2013 */
2014 OO.ui.mixin.ButtonElement.prototype.setActive = function ( value ) {
2015 this.active = !!value;
2016 this.$element.toggleClass( 'oo-ui-buttonElement-active', this.active );
2017 return this;
2018 };
2019
2020 /**
2021 * Check if the button is active
2022 *
2023 * @protected
2024 * @return {boolean} The button is active
2025 */
2026 OO.ui.mixin.ButtonElement.prototype.isActive = function () {
2027 return this.active;
2028 };
2029
2030 /**
2031 * Any OOjs UI widget that contains other widgets (such as {@link OO.ui.ButtonWidget buttons} or
2032 * {@link OO.ui.OptionWidget options}) mixes in GroupElement. Adding, removing, and clearing
2033 * items from the group is done through the interface the class provides.
2034 * For more information, please see the [OOjs UI documentation on MediaWiki] [1].
2035 *
2036 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Elements/Groups
2037 *
2038 * @abstract
2039 * @class
2040 *
2041 * @constructor
2042 * @param {Object} [config] Configuration options
2043 * @cfg {jQuery} [$group] The container element created by the class. If this configuration
2044 * is omitted, the group element will use a generated `<div>`.
2045 */
2046 OO.ui.mixin.GroupElement = function OoUiMixinGroupElement( config ) {
2047 // Configuration initialization
2048 config = config || {};
2049
2050 // Properties
2051 this.$group = null;
2052 this.items = [];
2053 this.aggregateItemEvents = {};
2054
2055 // Initialization
2056 this.setGroupElement( config.$group || $( '<div>' ) );
2057 };
2058
2059 /* Events */
2060
2061 /**
2062 * @event change
2063 *
2064 * A change event is emitted when the set of selected items changes.
2065 *
2066 * @param {OO.ui.Element[]} items Items currently in the group
2067 */
2068
2069 /* Methods */
2070
2071 /**
2072 * Set the group element.
2073 *
2074 * If an element is already set, items will be moved to the new element.
2075 *
2076 * @param {jQuery} $group Element to use as group
2077 */
2078 OO.ui.mixin.GroupElement.prototype.setGroupElement = function ( $group ) {
2079 var i, len;
2080
2081 this.$group = $group;
2082 for ( i = 0, len = this.items.length; i < len; i++ ) {
2083 this.$group.append( this.items[ i ].$element );
2084 }
2085 };
2086
2087 /**
2088 * Check if a group contains no items.
2089 *
2090 * @return {boolean} Group is empty
2091 */
2092 OO.ui.mixin.GroupElement.prototype.isEmpty = function () {
2093 return !this.items.length;
2094 };
2095
2096 /**
2097 * Get all items in the group.
2098 *
2099 * The method returns an array of item references (e.g., [button1, button2, button3]) and is useful
2100 * when synchronizing groups of items, or whenever the references are required (e.g., when removing items
2101 * from a group).
2102 *
2103 * @return {OO.ui.Element[]} An array of items.
2104 */
2105 OO.ui.mixin.GroupElement.prototype.getItems = function () {
2106 return this.items.slice( 0 );
2107 };
2108
2109 /**
2110 * Get an item by its data.
2111 *
2112 * Only the first item with matching data will be returned. To return all matching items,
2113 * use the #getItemsFromData method.
2114 *
2115 * @param {Object} data Item data to search for
2116 * @return {OO.ui.Element|null} Item with equivalent data, `null` if none exists
2117 */
2118 OO.ui.mixin.GroupElement.prototype.getItemFromData = function ( data ) {
2119 var i, len, item,
2120 hash = OO.getHash( data );
2121
2122 for ( i = 0, len = this.items.length; i < len; i++ ) {
2123 item = this.items[ i ];
2124 if ( hash === OO.getHash( item.getData() ) ) {
2125 return item;
2126 }
2127 }
2128
2129 return null;
2130 };
2131
2132 /**
2133 * Get items by their data.
2134 *
2135 * All items with matching data will be returned. To return only the first match, use the #getItemFromData method instead.
2136 *
2137 * @param {Object} data Item data to search for
2138 * @return {OO.ui.Element[]} Items with equivalent data
2139 */
2140 OO.ui.mixin.GroupElement.prototype.getItemsFromData = function ( data ) {
2141 var i, len, item,
2142 hash = OO.getHash( data ),
2143 items = [];
2144
2145 for ( i = 0, len = this.items.length; i < len; i++ ) {
2146 item = this.items[ i ];
2147 if ( hash === OO.getHash( item.getData() ) ) {
2148 items.push( item );
2149 }
2150 }
2151
2152 return items;
2153 };
2154
2155 /**
2156 * Aggregate the events emitted by the group.
2157 *
2158 * When events are aggregated, the group will listen to all contained items for the event,
2159 * and then emit the event under a new name. The new event will contain an additional leading
2160 * parameter containing the item that emitted the original event. Other arguments emitted from
2161 * the original event are passed through.
2162 *
2163 * @param {Object.<string,string|null>} events An object keyed by the name of the event that should be
2164 * aggregated (e.g., ‘click’) and the value of the new name to use (e.g., ‘groupClick’).
2165 * A `null` value will remove aggregated events.
2166
2167 * @throws {Error} An error is thrown if aggregation already exists.
2168 */
2169 OO.ui.mixin.GroupElement.prototype.aggregate = function ( events ) {
2170 var i, len, item, add, remove, itemEvent, groupEvent;
2171
2172 for ( itemEvent in events ) {
2173 groupEvent = events[ itemEvent ];
2174
2175 // Remove existing aggregated event
2176 if ( Object.prototype.hasOwnProperty.call( this.aggregateItemEvents, itemEvent ) ) {
2177 // Don't allow duplicate aggregations
2178 if ( groupEvent ) {
2179 throw new Error( 'Duplicate item event aggregation for ' + itemEvent );
2180 }
2181 // Remove event aggregation from existing items
2182 for ( i = 0, len = this.items.length; i < len; i++ ) {
2183 item = this.items[ i ];
2184 if ( item.connect && item.disconnect ) {
2185 remove = {};
2186 remove[ itemEvent ] = [ 'emit', this.aggregateItemEvents[ itemEvent ], item ];
2187 item.disconnect( this, remove );
2188 }
2189 }
2190 // Prevent future items from aggregating event
2191 delete this.aggregateItemEvents[ itemEvent ];
2192 }
2193
2194 // Add new aggregate event
2195 if ( groupEvent ) {
2196 // Make future items aggregate event
2197 this.aggregateItemEvents[ itemEvent ] = groupEvent;
2198 // Add event aggregation to existing items
2199 for ( i = 0, len = this.items.length; i < len; i++ ) {
2200 item = this.items[ i ];
2201 if ( item.connect && item.disconnect ) {
2202 add = {};
2203 add[ itemEvent ] = [ 'emit', groupEvent, item ];
2204 item.connect( this, add );
2205 }
2206 }
2207 }
2208 }
2209 };
2210
2211 /**
2212 * Add items to the group.
2213 *
2214 * Items will be added to the end of the group array unless the optional `index` parameter specifies
2215 * a different insertion point. Adding an existing item will move it to the end of the array or the point specified by the `index`.
2216 *
2217 * @param {OO.ui.Element[]} items An array of items to add to the group
2218 * @param {number} [index] Index of the insertion point
2219 * @chainable
2220 */
2221 OO.ui.mixin.GroupElement.prototype.addItems = function ( items, index ) {
2222 var i, len, item, event, events, currentIndex,
2223 itemElements = [];
2224
2225 for ( i = 0, len = items.length; i < len; i++ ) {
2226 item = items[ i ];
2227
2228 // Check if item exists then remove it first, effectively "moving" it
2229 currentIndex = this.items.indexOf( item );
2230 if ( currentIndex >= 0 ) {
2231 this.removeItems( [ item ] );
2232 // Adjust index to compensate for removal
2233 if ( currentIndex < index ) {
2234 index--;
2235 }
2236 }
2237 // Add the item
2238 if ( item.connect && item.disconnect && !$.isEmptyObject( this.aggregateItemEvents ) ) {
2239 events = {};
2240 for ( event in this.aggregateItemEvents ) {
2241 events[ event ] = [ 'emit', this.aggregateItemEvents[ event ], item ];
2242 }
2243 item.connect( this, events );
2244 }
2245 item.setElementGroup( this );
2246 itemElements.push( item.$element.get( 0 ) );
2247 }
2248
2249 if ( index === undefined || index < 0 || index >= this.items.length ) {
2250 this.$group.append( itemElements );
2251 this.items.push.apply( this.items, items );
2252 } else if ( index === 0 ) {
2253 this.$group.prepend( itemElements );
2254 this.items.unshift.apply( this.items, items );
2255 } else {
2256 this.items[ index ].$element.before( itemElements );
2257 this.items.splice.apply( this.items, [ index, 0 ].concat( items ) );
2258 }
2259
2260 this.emit( 'change', this.getItems() );
2261 return this;
2262 };
2263
2264 /**
2265 * Remove the specified items from a group.
2266 *
2267 * Removed items are detached (not removed) from the DOM so that they may be reused.
2268 * To remove all items from a group, you may wish to use the #clearItems method instead.
2269 *
2270 * @param {OO.ui.Element[]} items An array of items to remove
2271 * @chainable
2272 */
2273 OO.ui.mixin.GroupElement.prototype.removeItems = function ( items ) {
2274 var i, len, item, index, remove, itemEvent;
2275
2276 // Remove specific items
2277 for ( i = 0, len = items.length; i < len; i++ ) {
2278 item = items[ i ];
2279 index = this.items.indexOf( item );
2280 if ( index !== -1 ) {
2281 if (
2282 item.connect && item.disconnect &&
2283 !$.isEmptyObject( this.aggregateItemEvents )
2284 ) {
2285 remove = {};
2286 if ( Object.prototype.hasOwnProperty.call( this.aggregateItemEvents, itemEvent ) ) {
2287 remove[ itemEvent ] = [ 'emit', this.aggregateItemEvents[ itemEvent ], item ];
2288 }
2289 item.disconnect( this, remove );
2290 }
2291 item.setElementGroup( null );
2292 this.items.splice( index, 1 );
2293 item.$element.detach();
2294 }
2295 }
2296
2297 this.emit( 'change', this.getItems() );
2298 return this;
2299 };
2300
2301 /**
2302 * Clear all items from the group.
2303 *
2304 * Cleared items are detached from the DOM, not removed, so that they may be reused.
2305 * To remove only a subset of items from a group, use the #removeItems method.
2306 *
2307 * @chainable
2308 */
2309 OO.ui.mixin.GroupElement.prototype.clearItems = function () {
2310 var i, len, item, remove, itemEvent;
2311
2312 // Remove all items
2313 for ( i = 0, len = this.items.length; i < len; i++ ) {
2314 item = this.items[ i ];
2315 if (
2316 item.connect && item.disconnect &&
2317 !$.isEmptyObject( this.aggregateItemEvents )
2318 ) {
2319 remove = {};
2320 if ( Object.prototype.hasOwnProperty.call( this.aggregateItemEvents, itemEvent ) ) {
2321 remove[ itemEvent ] = [ 'emit', this.aggregateItemEvents[ itemEvent ], item ];
2322 }
2323 item.disconnect( this, remove );
2324 }
2325 item.setElementGroup( null );
2326 item.$element.detach();
2327 }
2328
2329 this.emit( 'change', this.getItems() );
2330 this.items = [];
2331 return this;
2332 };
2333
2334 /**
2335 * IconElement is often mixed into other classes to generate an icon.
2336 * Icons are graphics, about the size of normal text. They are used to aid the user
2337 * in locating a control or to convey information in a space-efficient way. See the
2338 * [OOjs UI documentation on MediaWiki] [1] for a list of icons
2339 * included in the library.
2340 *
2341 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Icons
2342 *
2343 * @abstract
2344 * @class
2345 *
2346 * @constructor
2347 * @param {Object} [config] Configuration options
2348 * @cfg {jQuery} [$icon] The icon element created by the class. If this configuration is omitted,
2349 * the icon element will use a generated `<span>`. To use a different HTML tag, or to specify that
2350 * the icon element be set to an existing icon instead of the one generated by this class, set a
2351 * value using a jQuery selection. For example:
2352 *
2353 * // Use a <div> tag instead of a <span>
2354 * $icon: $("<div>")
2355 * // Use an existing icon element instead of the one generated by the class
2356 * $icon: this.$element
2357 * // Use an icon element from a child widget
2358 * $icon: this.childwidget.$element
2359 * @cfg {Object|string} [icon=''] The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of
2360 * symbolic names. A map is used for i18n purposes and contains a `default` icon
2361 * name and additional names keyed by language code. The `default` name is used when no icon is keyed
2362 * by the user's language.
2363 *
2364 * Example of an i18n map:
2365 *
2366 * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
2367 * See the [OOjs UI documentation on MediaWiki] [2] for a list of icons included in the library.
2368 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Icons
2369 * @cfg {string|Function} [iconTitle] A text string used as the icon title, or a function that returns title
2370 * text. The icon title is displayed when users move the mouse over the icon.
2371 */
2372 OO.ui.mixin.IconElement = function OoUiMixinIconElement( config ) {
2373 // Configuration initialization
2374 config = config || {};
2375
2376 // Properties
2377 this.$icon = null;
2378 this.icon = null;
2379 this.iconTitle = null;
2380
2381 // Initialization
2382 this.setIcon( config.icon || this.constructor.static.icon );
2383 this.setIconTitle( config.iconTitle || this.constructor.static.iconTitle );
2384 this.setIconElement( config.$icon || $( '<span>' ) );
2385 };
2386
2387 /* Setup */
2388
2389 OO.initClass( OO.ui.mixin.IconElement );
2390
2391 /* Static Properties */
2392
2393 /**
2394 * The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of symbolic names. A map is used
2395 * for i18n purposes and contains a `default` icon name and additional names keyed by
2396 * language code. The `default` name is used when no icon is keyed by the user's language.
2397 *
2398 * Example of an i18n map:
2399 *
2400 * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
2401 *
2402 * Note: the static property will be overridden if the #icon configuration is used.
2403 *
2404 * @static
2405 * @inheritable
2406 * @property {Object|string}
2407 */
2408 OO.ui.mixin.IconElement.static.icon = null;
2409
2410 /**
2411 * The icon title, displayed when users move the mouse over the icon. The value can be text, a
2412 * function that returns title text, or `null` for no title.
2413 *
2414 * The static property will be overridden if the #iconTitle configuration is used.
2415 *
2416 * @static
2417 * @inheritable
2418 * @property {string|Function|null}
2419 */
2420 OO.ui.mixin.IconElement.static.iconTitle = null;
2421
2422 /* Methods */
2423
2424 /**
2425 * Set the icon element. This method is used to retarget an icon mixin so that its functionality
2426 * applies to the specified icon element instead of the one created by the class. If an icon
2427 * element is already set, the mixin’s effect on that element is removed. Generated CSS classes
2428 * and mixin methods will no longer affect the element.
2429 *
2430 * @param {jQuery} $icon Element to use as icon
2431 */
2432 OO.ui.mixin.IconElement.prototype.setIconElement = function ( $icon ) {
2433 if ( this.$icon ) {
2434 this.$icon
2435 .removeClass( 'oo-ui-iconElement-icon oo-ui-icon-' + this.icon )
2436 .removeAttr( 'title' );
2437 }
2438
2439 this.$icon = $icon
2440 .addClass( 'oo-ui-iconElement-icon' )
2441 .toggleClass( 'oo-ui-icon-' + this.icon, !!this.icon );
2442 if ( this.iconTitle !== null ) {
2443 this.$icon.attr( 'title', this.iconTitle );
2444 }
2445
2446 this.updateThemeClasses();
2447 };
2448
2449 /**
2450 * Set icon by symbolic name (e.g., ‘remove’ or ‘menu’). Use `null` to remove an icon.
2451 * The icon parameter can also be set to a map of icon names. See the #icon config setting
2452 * for an example.
2453 *
2454 * @param {Object|string|null} icon A symbolic icon name, a {@link #icon map of icon names} keyed
2455 * by language code, or `null` to remove the icon.
2456 * @chainable
2457 */
2458 OO.ui.mixin.IconElement.prototype.setIcon = function ( icon ) {
2459 icon = OO.isPlainObject( icon ) ? OO.ui.getLocalValue( icon, null, 'default' ) : icon;
2460 icon = typeof icon === 'string' && icon.trim().length ? icon.trim() : null;
2461
2462 if ( this.icon !== icon ) {
2463 if ( this.$icon ) {
2464 if ( this.icon !== null ) {
2465 this.$icon.removeClass( 'oo-ui-icon-' + this.icon );
2466 }
2467 if ( icon !== null ) {
2468 this.$icon.addClass( 'oo-ui-icon-' + icon );
2469 }
2470 }
2471 this.icon = icon;
2472 }
2473
2474 this.$element.toggleClass( 'oo-ui-iconElement', !!this.icon );
2475 this.updateThemeClasses();
2476
2477 return this;
2478 };
2479
2480 /**
2481 * Set the icon title. Use `null` to remove the title.
2482 *
2483 * @param {string|Function|null} iconTitle A text string used as the icon title,
2484 * a function that returns title text, or `null` for no title.
2485 * @chainable
2486 */
2487 OO.ui.mixin.IconElement.prototype.setIconTitle = function ( iconTitle ) {
2488 iconTitle = typeof iconTitle === 'function' ||
2489 ( typeof iconTitle === 'string' && iconTitle.length ) ?
2490 OO.ui.resolveMsg( iconTitle ) : null;
2491
2492 if ( this.iconTitle !== iconTitle ) {
2493 this.iconTitle = iconTitle;
2494 if ( this.$icon ) {
2495 if ( this.iconTitle !== null ) {
2496 this.$icon.attr( 'title', iconTitle );
2497 } else {
2498 this.$icon.removeAttr( 'title' );
2499 }
2500 }
2501 }
2502
2503 return this;
2504 };
2505
2506 /**
2507 * Get the symbolic name of the icon.
2508 *
2509 * @return {string} Icon name
2510 */
2511 OO.ui.mixin.IconElement.prototype.getIcon = function () {
2512 return this.icon;
2513 };
2514
2515 /**
2516 * Get the icon title. The title text is displayed when a user moves the mouse over the icon.
2517 *
2518 * @return {string} Icon title text
2519 */
2520 OO.ui.mixin.IconElement.prototype.getIconTitle = function () {
2521 return this.iconTitle;
2522 };
2523
2524 /**
2525 * IndicatorElement is often mixed into other classes to generate an indicator.
2526 * Indicators are small graphics that are generally used in two ways:
2527 *
2528 * - To draw attention to the status of an item. For example, an indicator might be
2529 * used to show that an item in a list has errors that need to be resolved.
2530 * - To clarify the function of a control that acts in an exceptional way (a button
2531 * that opens a menu instead of performing an action directly, for example).
2532 *
2533 * For a list of indicators included in the library, please see the
2534 * [OOjs UI documentation on MediaWiki] [1].
2535 *
2536 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Indicators
2537 *
2538 * @abstract
2539 * @class
2540 *
2541 * @constructor
2542 * @param {Object} [config] Configuration options
2543 * @cfg {jQuery} [$indicator] The indicator element created by the class. If this
2544 * configuration is omitted, the indicator element will use a generated `<span>`.
2545 * @cfg {string} [indicator] Symbolic name of the indicator (e.g., ‘alert’ or ‘down’).
2546 * See the [OOjs UI documentation on MediaWiki][2] for a list of indicators included
2547 * in the library.
2548 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Indicators
2549 * @cfg {string|Function} [indicatorTitle] A text string used as the indicator title,
2550 * or a function that returns title text. The indicator title is displayed when users move
2551 * the mouse over the indicator.
2552 */
2553 OO.ui.mixin.IndicatorElement = function OoUiMixinIndicatorElement( config ) {
2554 // Configuration initialization
2555 config = config || {};
2556
2557 // Properties
2558 this.$indicator = null;
2559 this.indicator = null;
2560 this.indicatorTitle = null;
2561
2562 // Initialization
2563 this.setIndicator( config.indicator || this.constructor.static.indicator );
2564 this.setIndicatorTitle( config.indicatorTitle || this.constructor.static.indicatorTitle );
2565 this.setIndicatorElement( config.$indicator || $( '<span>' ) );
2566 };
2567
2568 /* Setup */
2569
2570 OO.initClass( OO.ui.mixin.IndicatorElement );
2571
2572 /* Static Properties */
2573
2574 /**
2575 * Symbolic name of the indicator (e.g., ‘alert’ or ‘down’).
2576 * The static property will be overridden if the #indicator configuration is used.
2577 *
2578 * @static
2579 * @inheritable
2580 * @property {string|null}
2581 */
2582 OO.ui.mixin.IndicatorElement.static.indicator = null;
2583
2584 /**
2585 * A text string used as the indicator title, a function that returns title text, or `null`
2586 * for no title. The static property will be overridden if the #indicatorTitle configuration is used.
2587 *
2588 * @static
2589 * @inheritable
2590 * @property {string|Function|null}
2591 */
2592 OO.ui.mixin.IndicatorElement.static.indicatorTitle = null;
2593
2594 /* Methods */
2595
2596 /**
2597 * Set the indicator element.
2598 *
2599 * If an element is already set, it will be cleaned up before setting up the new element.
2600 *
2601 * @param {jQuery} $indicator Element to use as indicator
2602 */
2603 OO.ui.mixin.IndicatorElement.prototype.setIndicatorElement = function ( $indicator ) {
2604 if ( this.$indicator ) {
2605 this.$indicator
2606 .removeClass( 'oo-ui-indicatorElement-indicator oo-ui-indicator-' + this.indicator )
2607 .removeAttr( 'title' );
2608 }
2609
2610 this.$indicator = $indicator
2611 .addClass( 'oo-ui-indicatorElement-indicator' )
2612 .toggleClass( 'oo-ui-indicator-' + this.indicator, !!this.indicator );
2613 if ( this.indicatorTitle !== null ) {
2614 this.$indicator.attr( 'title', this.indicatorTitle );
2615 }
2616
2617 this.updateThemeClasses();
2618 };
2619
2620 /**
2621 * Set the indicator by its symbolic name: ‘alert’, ‘down’, ‘next’, ‘previous’, ‘required’, ‘up’. Use `null` to remove the indicator.
2622 *
2623 * @param {string|null} indicator Symbolic name of indicator, or `null` for no indicator
2624 * @chainable
2625 */
2626 OO.ui.mixin.IndicatorElement.prototype.setIndicator = function ( indicator ) {
2627 indicator = typeof indicator === 'string' && indicator.length ? indicator.trim() : null;
2628
2629 if ( this.indicator !== indicator ) {
2630 if ( this.$indicator ) {
2631 if ( this.indicator !== null ) {
2632 this.$indicator.removeClass( 'oo-ui-indicator-' + this.indicator );
2633 }
2634 if ( indicator !== null ) {
2635 this.$indicator.addClass( 'oo-ui-indicator-' + indicator );
2636 }
2637 }
2638 this.indicator = indicator;
2639 }
2640
2641 this.$element.toggleClass( 'oo-ui-indicatorElement', !!this.indicator );
2642 this.updateThemeClasses();
2643
2644 return this;
2645 };
2646
2647 /**
2648 * Set the indicator title.
2649 *
2650 * The title is displayed when a user moves the mouse over the indicator.
2651 *
2652 * @param {string|Function|null} indicatorTitle Indicator title text, a function that returns text, or
2653 * `null` for no indicator title
2654 * @chainable
2655 */
2656 OO.ui.mixin.IndicatorElement.prototype.setIndicatorTitle = function ( indicatorTitle ) {
2657 indicatorTitle = typeof indicatorTitle === 'function' ||
2658 ( typeof indicatorTitle === 'string' && indicatorTitle.length ) ?
2659 OO.ui.resolveMsg( indicatorTitle ) : null;
2660
2661 if ( this.indicatorTitle !== indicatorTitle ) {
2662 this.indicatorTitle = indicatorTitle;
2663 if ( this.$indicator ) {
2664 if ( this.indicatorTitle !== null ) {
2665 this.$indicator.attr( 'title', indicatorTitle );
2666 } else {
2667 this.$indicator.removeAttr( 'title' );
2668 }
2669 }
2670 }
2671
2672 return this;
2673 };
2674
2675 /**
2676 * Get the symbolic name of the indicator (e.g., ‘alert’ or ‘down’).
2677 *
2678 * @return {string} Symbolic name of indicator
2679 */
2680 OO.ui.mixin.IndicatorElement.prototype.getIndicator = function () {
2681 return this.indicator;
2682 };
2683
2684 /**
2685 * Get the indicator title.
2686 *
2687 * The title is displayed when a user moves the mouse over the indicator.
2688 *
2689 * @return {string} Indicator title text
2690 */
2691 OO.ui.mixin.IndicatorElement.prototype.getIndicatorTitle = function () {
2692 return this.indicatorTitle;
2693 };
2694
2695 /**
2696 * LabelElement is often mixed into other classes to generate a label, which
2697 * helps identify the function of an interface element.
2698 * See the [OOjs UI documentation on MediaWiki] [1] for more information.
2699 *
2700 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Labels
2701 *
2702 * @abstract
2703 * @class
2704 *
2705 * @constructor
2706 * @param {Object} [config] Configuration options
2707 * @cfg {jQuery} [$label] The label element created by the class. If this
2708 * configuration is omitted, the label element will use a generated `<span>`.
2709 * @cfg {jQuery|string|Function|OO.ui.HtmlSnippet} [label] The label text. The label can be specified
2710 * as a plaintext string, a jQuery selection of elements, or a function that will produce a string
2711 * in the future. See the [OOjs UI documentation on MediaWiki] [2] for examples.
2712 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Labels
2713 */
2714 OO.ui.mixin.LabelElement = function OoUiMixinLabelElement( config ) {
2715 // Configuration initialization
2716 config = config || {};
2717
2718 // Properties
2719 this.$label = null;
2720 this.label = null;
2721
2722 // Initialization
2723 this.setLabel( config.label || this.constructor.static.label );
2724 this.setLabelElement( config.$label || $( '<span>' ) );
2725 };
2726
2727 /* Setup */
2728
2729 OO.initClass( OO.ui.mixin.LabelElement );
2730
2731 /* Events */
2732
2733 /**
2734 * @event labelChange
2735 * @param {string} value
2736 */
2737
2738 /* Static Properties */
2739
2740 /**
2741 * The label text. The label can be specified as a plaintext string, a function that will
2742 * produce a string in the future, or `null` for no label. The static value will
2743 * be overridden if a label is specified with the #label config option.
2744 *
2745 * @static
2746 * @inheritable
2747 * @property {string|Function|null}
2748 */
2749 OO.ui.mixin.LabelElement.static.label = null;
2750
2751 /* Static methods */
2752
2753 /**
2754 * Highlight the first occurrence of the query in the given text
2755 *
2756 * @param {string} text Text
2757 * @param {string} query Query to find
2758 * @return {jQuery} Text with the first match of the query
2759 * sub-string wrapped in highlighted span
2760 */
2761 OO.ui.mixin.LabelElement.static.highlightQuery = function ( text, query ) {
2762 var $result = $( '<span>' ),
2763 offset = text.toLowerCase().indexOf( query.toLowerCase() );
2764
2765 if ( !query.length || offset === -1 ) {
2766 return $result.text( text );
2767 }
2768 $result.append(
2769 document.createTextNode( text.slice( 0, offset ) ),
2770 $( '<span>' )
2771 .addClass( 'oo-ui-labelElement-label-highlight' )
2772 .text( text.slice( offset, offset + query.length ) ),
2773 document.createTextNode( text.slice( offset + query.length ) )
2774 );
2775 return $result.contents();
2776 };
2777
2778 /* Methods */
2779
2780 /**
2781 * Set the label element.
2782 *
2783 * If an element is already set, it will be cleaned up before setting up the new element.
2784 *
2785 * @param {jQuery} $label Element to use as label
2786 */
2787 OO.ui.mixin.LabelElement.prototype.setLabelElement = function ( $label ) {
2788 if ( this.$label ) {
2789 this.$label.removeClass( 'oo-ui-labelElement-label' ).empty();
2790 }
2791
2792 this.$label = $label.addClass( 'oo-ui-labelElement-label' );
2793 this.setLabelContent( this.label );
2794 };
2795
2796 /**
2797 * Set the label.
2798 *
2799 * An empty string will result in the label being hidden. A string containing only whitespace will
2800 * be converted to a single `&nbsp;`.
2801 *
2802 * @param {jQuery|string|OO.ui.HtmlSnippet|Function|null} label Label nodes; text; a function that returns nodes or
2803 * text; or null for no label
2804 * @chainable
2805 */
2806 OO.ui.mixin.LabelElement.prototype.setLabel = function ( label ) {
2807 label = typeof label === 'function' ? OO.ui.resolveMsg( label ) : label;
2808 label = ( ( typeof label === 'string' || label instanceof jQuery ) && label.length ) || ( label instanceof OO.ui.HtmlSnippet && label.toString().length ) ? label : null;
2809
2810 if ( this.label !== label ) {
2811 if ( this.$label ) {
2812 this.setLabelContent( label );
2813 }
2814 this.label = label;
2815 this.emit( 'labelChange' );
2816 }
2817
2818 this.$element.toggleClass( 'oo-ui-labelElement', !!this.label );
2819
2820 return this;
2821 };
2822
2823 /**
2824 * Set the label as plain text with a highlighted query
2825 *
2826 * @param {string} text Text label to set
2827 * @param {string} query Substring of text to highlight
2828 * @chainable
2829 */
2830 OO.ui.mixin.LabelElement.prototype.setHighlightedQuery = function ( text, query ) {
2831 return this.setLabel( this.constructor.static.highlightQuery( text, query ) );
2832 };
2833
2834 /**
2835 * Get the label.
2836 *
2837 * @return {jQuery|string|Function|null} Label nodes; text; a function that returns nodes or
2838 * text; or null for no label
2839 */
2840 OO.ui.mixin.LabelElement.prototype.getLabel = function () {
2841 return this.label;
2842 };
2843
2844 /**
2845 * Fit the label.
2846 *
2847 * @chainable
2848 * @deprecated since 0.16.0
2849 */
2850 OO.ui.mixin.LabelElement.prototype.fitLabel = function () {
2851 return this;
2852 };
2853
2854 /**
2855 * Set the content of the label.
2856 *
2857 * Do not call this method until after the label element has been set by #setLabelElement.
2858 *
2859 * @private
2860 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
2861 * text; or null for no label
2862 */
2863 OO.ui.mixin.LabelElement.prototype.setLabelContent = function ( label ) {
2864 if ( typeof label === 'string' ) {
2865 if ( label.match( /^\s*$/ ) ) {
2866 // Convert whitespace only string to a single non-breaking space
2867 this.$label.html( '&nbsp;' );
2868 } else {
2869 this.$label.text( label );
2870 }
2871 } else if ( label instanceof OO.ui.HtmlSnippet ) {
2872 this.$label.html( label.toString() );
2873 } else if ( label instanceof jQuery ) {
2874 this.$label.empty().append( label );
2875 } else {
2876 this.$label.empty();
2877 }
2878 };
2879
2880 /**
2881 * The FlaggedElement class is an attribute mixin, meaning that it is used to add
2882 * additional functionality to an element created by another class. The class provides
2883 * a ‘flags’ property assigned the name (or an array of names) of styling flags,
2884 * which are used to customize the look and feel of a widget to better describe its
2885 * importance and functionality.
2886 *
2887 * The library currently contains the following styling flags for general use:
2888 *
2889 * - **progressive**: Progressive styling is applied to convey that the widget will move the user forward in a process.
2890 * - **destructive**: Destructive styling is applied to convey that the widget will remove something.
2891 * - **constructive**: Constructive styling is applied to convey that the widget will create something.
2892 *
2893 * The flags affect the appearance of the buttons:
2894 *
2895 * @example
2896 * // FlaggedElement is mixed into ButtonWidget to provide styling flags
2897 * var button1 = new OO.ui.ButtonWidget( {
2898 * label: 'Constructive',
2899 * flags: 'constructive'
2900 * } );
2901 * var button2 = new OO.ui.ButtonWidget( {
2902 * label: 'Destructive',
2903 * flags: 'destructive'
2904 * } );
2905 * var button3 = new OO.ui.ButtonWidget( {
2906 * label: 'Progressive',
2907 * flags: 'progressive'
2908 * } );
2909 * $( 'body' ).append( button1.$element, button2.$element, button3.$element );
2910 *
2911 * {@link OO.ui.ActionWidget ActionWidgets}, which are a special kind of button that execute an action, use these flags: **primary** and **safe**.
2912 * Please see the [OOjs UI documentation on MediaWiki] [1] for more information.
2913 *
2914 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Elements/Flagged
2915 *
2916 * @abstract
2917 * @class
2918 *
2919 * @constructor
2920 * @param {Object} [config] Configuration options
2921 * @cfg {string|string[]} [flags] The name or names of the flags (e.g., 'constructive' or 'primary') to apply.
2922 * Please see the [OOjs UI documentation on MediaWiki] [2] for more information about available flags.
2923 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Elements/Flagged
2924 * @cfg {jQuery} [$flagged] The flagged element. By default,
2925 * the flagged functionality is applied to the element created by the class ($element).
2926 * If a different element is specified, the flagged functionality will be applied to it instead.
2927 */
2928 OO.ui.mixin.FlaggedElement = function OoUiMixinFlaggedElement( config ) {
2929 // Configuration initialization
2930 config = config || {};
2931
2932 // Properties
2933 this.flags = {};
2934 this.$flagged = null;
2935
2936 // Initialization
2937 this.setFlags( config.flags );
2938 this.setFlaggedElement( config.$flagged || this.$element );
2939 };
2940
2941 /* Events */
2942
2943 /**
2944 * @event flag
2945 * A flag event is emitted when the #clearFlags or #setFlags methods are used. The `changes`
2946 * parameter contains the name of each modified flag and indicates whether it was
2947 * added or removed.
2948 *
2949 * @param {Object.<string,boolean>} changes Object keyed by flag name. A Boolean `true` indicates
2950 * that the flag was added, `false` that the flag was removed.
2951 */
2952
2953 /* Methods */
2954
2955 /**
2956 * Set the flagged element.
2957 *
2958 * This method is used to retarget a flagged mixin so that its functionality applies to the specified element.
2959 * If an element is already set, the method will remove the mixin’s effect on that element.
2960 *
2961 * @param {jQuery} $flagged Element that should be flagged
2962 */
2963 OO.ui.mixin.FlaggedElement.prototype.setFlaggedElement = function ( $flagged ) {
2964 var classNames = Object.keys( this.flags ).map( function ( flag ) {
2965 return 'oo-ui-flaggedElement-' + flag;
2966 } ).join( ' ' );
2967
2968 if ( this.$flagged ) {
2969 this.$flagged.removeClass( classNames );
2970 }
2971
2972 this.$flagged = $flagged.addClass( classNames );
2973 };
2974
2975 /**
2976 * Check if the specified flag is set.
2977 *
2978 * @param {string} flag Name of flag
2979 * @return {boolean} The flag is set
2980 */
2981 OO.ui.mixin.FlaggedElement.prototype.hasFlag = function ( flag ) {
2982 // This may be called before the constructor, thus before this.flags is set
2983 return this.flags && ( flag in this.flags );
2984 };
2985
2986 /**
2987 * Get the names of all flags set.
2988 *
2989 * @return {string[]} Flag names
2990 */
2991 OO.ui.mixin.FlaggedElement.prototype.getFlags = function () {
2992 // This may be called before the constructor, thus before this.flags is set
2993 return Object.keys( this.flags || {} );
2994 };
2995
2996 /**
2997 * Clear all flags.
2998 *
2999 * @chainable
3000 * @fires flag
3001 */
3002 OO.ui.mixin.FlaggedElement.prototype.clearFlags = function () {
3003 var flag, className,
3004 changes = {},
3005 remove = [],
3006 classPrefix = 'oo-ui-flaggedElement-';
3007
3008 for ( flag in this.flags ) {
3009 className = classPrefix + flag;
3010 changes[ flag ] = false;
3011 delete this.flags[ flag ];
3012 remove.push( className );
3013 }
3014
3015 if ( this.$flagged ) {
3016 this.$flagged.removeClass( remove.join( ' ' ) );
3017 }
3018
3019 this.updateThemeClasses();
3020 this.emit( 'flag', changes );
3021
3022 return this;
3023 };
3024
3025 /**
3026 * Add one or more flags.
3027 *
3028 * @param {string|string[]|Object.<string, boolean>} flags A flag name, an array of flag names,
3029 * or an object keyed by flag name with a boolean value that indicates whether the flag should
3030 * be added (`true`) or removed (`false`).
3031 * @chainable
3032 * @fires flag
3033 */
3034 OO.ui.mixin.FlaggedElement.prototype.setFlags = function ( flags ) {
3035 var i, len, flag, className,
3036 changes = {},
3037 add = [],
3038 remove = [],
3039 classPrefix = 'oo-ui-flaggedElement-';
3040
3041 if ( typeof flags === 'string' ) {
3042 className = classPrefix + flags;
3043 // Set
3044 if ( !this.flags[ flags ] ) {
3045 this.flags[ flags ] = true;
3046 add.push( className );
3047 }
3048 } else if ( Array.isArray( flags ) ) {
3049 for ( i = 0, len = flags.length; i < len; i++ ) {
3050 flag = flags[ i ];
3051 className = classPrefix + flag;
3052 // Set
3053 if ( !this.flags[ flag ] ) {
3054 changes[ flag ] = true;
3055 this.flags[ flag ] = true;
3056 add.push( className );
3057 }
3058 }
3059 } else if ( OO.isPlainObject( flags ) ) {
3060 for ( flag in flags ) {
3061 className = classPrefix + flag;
3062 if ( flags[ flag ] ) {
3063 // Set
3064 if ( !this.flags[ flag ] ) {
3065 changes[ flag ] = true;
3066 this.flags[ flag ] = true;
3067 add.push( className );
3068 }
3069 } else {
3070 // Remove
3071 if ( this.flags[ flag ] ) {
3072 changes[ flag ] = false;
3073 delete this.flags[ flag ];
3074 remove.push( className );
3075 }
3076 }
3077 }
3078 }
3079
3080 if ( this.$flagged ) {
3081 this.$flagged
3082 .addClass( add.join( ' ' ) )
3083 .removeClass( remove.join( ' ' ) );
3084 }
3085
3086 this.updateThemeClasses();
3087 this.emit( 'flag', changes );
3088
3089 return this;
3090 };
3091
3092 /**
3093 * TitledElement is mixed into other classes to provide a `title` attribute.
3094 * Titles are rendered by the browser and are made visible when the user moves
3095 * the mouse over the element. Titles are not visible on touch devices.
3096 *
3097 * @example
3098 * // TitledElement provides a 'title' attribute to the
3099 * // ButtonWidget class
3100 * var button = new OO.ui.ButtonWidget( {
3101 * label: 'Button with Title',
3102 * title: 'I am a button'
3103 * } );
3104 * $( 'body' ).append( button.$element );
3105 *
3106 * @abstract
3107 * @class
3108 *
3109 * @constructor
3110 * @param {Object} [config] Configuration options
3111 * @cfg {jQuery} [$titled] The element to which the `title` attribute is applied.
3112 * If this config is omitted, the title functionality is applied to $element, the
3113 * element created by the class.
3114 * @cfg {string|Function} [title] The title text or a function that returns text. If
3115 * this config is omitted, the value of the {@link #static-title static title} property is used.
3116 */
3117 OO.ui.mixin.TitledElement = function OoUiMixinTitledElement( config ) {
3118 // Configuration initialization
3119 config = config || {};
3120
3121 // Properties
3122 this.$titled = null;
3123 this.title = null;
3124
3125 // Initialization
3126 this.setTitle( config.title !== undefined ? config.title : this.constructor.static.title );
3127 this.setTitledElement( config.$titled || this.$element );
3128 };
3129
3130 /* Setup */
3131
3132 OO.initClass( OO.ui.mixin.TitledElement );
3133
3134 /* Static Properties */
3135
3136 /**
3137 * The title text, a function that returns text, or `null` for no title. The value of the static property
3138 * is overridden if the #title config option is used.
3139 *
3140 * @static
3141 * @inheritable
3142 * @property {string|Function|null}
3143 */
3144 OO.ui.mixin.TitledElement.static.title = null;
3145
3146 /* Methods */
3147
3148 /**
3149 * Set the titled element.
3150 *
3151 * This method is used to retarget a titledElement mixin so that its functionality applies to the specified element.
3152 * If an element is already set, the mixin’s effect on that element is removed before the new element is set up.
3153 *
3154 * @param {jQuery} $titled Element that should use the 'titled' functionality
3155 */
3156 OO.ui.mixin.TitledElement.prototype.setTitledElement = function ( $titled ) {
3157 if ( this.$titled ) {
3158 this.$titled.removeAttr( 'title' );
3159 }
3160
3161 this.$titled = $titled;
3162 if ( this.title ) {
3163 this.$titled.attr( 'title', this.title );
3164 }
3165 };
3166
3167 /**
3168 * Set title.
3169 *
3170 * @param {string|Function|null} title Title text, a function that returns text, or `null` for no title
3171 * @chainable
3172 */
3173 OO.ui.mixin.TitledElement.prototype.setTitle = function ( title ) {
3174 title = typeof title === 'function' ? OO.ui.resolveMsg( title ) : title;
3175 title = ( typeof title === 'string' && title.length ) ? title : null;
3176
3177 if ( this.title !== title ) {
3178 if ( this.$titled ) {
3179 if ( title !== null ) {
3180 this.$titled.attr( 'title', title );
3181 } else {
3182 this.$titled.removeAttr( 'title' );
3183 }
3184 }
3185 this.title = title;
3186 }
3187
3188 return this;
3189 };
3190
3191 /**
3192 * Get title.
3193 *
3194 * @return {string} Title string
3195 */
3196 OO.ui.mixin.TitledElement.prototype.getTitle = function () {
3197 return this.title;
3198 };
3199
3200 /**
3201 * AccessKeyedElement is mixed into other classes to provide an `accesskey` attribute.
3202 * Accesskeys allow an user to go to a specific element by using
3203 * a shortcut combination of a browser specific keys + the key
3204 * set to the field.
3205 *
3206 * @example
3207 * // AccessKeyedElement provides an 'accesskey' attribute to the
3208 * // ButtonWidget class
3209 * var button = new OO.ui.ButtonWidget( {
3210 * label: 'Button with Accesskey',
3211 * accessKey: 'k'
3212 * } );
3213 * $( 'body' ).append( button.$element );
3214 *
3215 * @abstract
3216 * @class
3217 *
3218 * @constructor
3219 * @param {Object} [config] Configuration options
3220 * @cfg {jQuery} [$accessKeyed] The element to which the `accesskey` attribute is applied.
3221 * If this config is omitted, the accesskey functionality is applied to $element, the
3222 * element created by the class.
3223 * @cfg {string|Function} [accessKey] The key or a function that returns the key. If
3224 * this config is omitted, no accesskey will be added.
3225 */
3226 OO.ui.mixin.AccessKeyedElement = function OoUiMixinAccessKeyedElement( config ) {
3227 // Configuration initialization
3228 config = config || {};
3229
3230 // Properties
3231 this.$accessKeyed = null;
3232 this.accessKey = null;
3233
3234 // Initialization
3235 this.setAccessKey( config.accessKey || null );
3236 this.setAccessKeyedElement( config.$accessKeyed || this.$element );
3237 };
3238
3239 /* Setup */
3240
3241 OO.initClass( OO.ui.mixin.AccessKeyedElement );
3242
3243 /* Static Properties */
3244
3245 /**
3246 * The access key, a function that returns a key, or `null` for no accesskey.
3247 *
3248 * @static
3249 * @inheritable
3250 * @property {string|Function|null}
3251 */
3252 OO.ui.mixin.AccessKeyedElement.static.accessKey = null;
3253
3254 /* Methods */
3255
3256 /**
3257 * Set the accesskeyed element.
3258 *
3259 * This method is used to retarget a AccessKeyedElement mixin so that its functionality applies to the specified element.
3260 * If an element is already set, the mixin's effect on that element is removed before the new element is set up.
3261 *
3262 * @param {jQuery} $accessKeyed Element that should use the 'accesskeyes' functionality
3263 */
3264 OO.ui.mixin.AccessKeyedElement.prototype.setAccessKeyedElement = function ( $accessKeyed ) {
3265 if ( this.$accessKeyed ) {
3266 this.$accessKeyed.removeAttr( 'accesskey' );
3267 }
3268
3269 this.$accessKeyed = $accessKeyed;
3270 if ( this.accessKey ) {
3271 this.$accessKeyed.attr( 'accesskey', this.accessKey );
3272 }
3273 };
3274
3275 /**
3276 * Set accesskey.
3277 *
3278 * @param {string|Function|null} accessKey Key, a function that returns a key, or `null` for no accesskey
3279 * @chainable
3280 */
3281 OO.ui.mixin.AccessKeyedElement.prototype.setAccessKey = function ( accessKey ) {
3282 accessKey = typeof accessKey === 'string' ? OO.ui.resolveMsg( accessKey ) : null;
3283
3284 if ( this.accessKey !== accessKey ) {
3285 if ( this.$accessKeyed ) {
3286 if ( accessKey !== null ) {
3287 this.$accessKeyed.attr( 'accesskey', accessKey );
3288 } else {
3289 this.$accessKeyed.removeAttr( 'accesskey' );
3290 }
3291 }
3292 this.accessKey = accessKey;
3293 }
3294
3295 return this;
3296 };
3297
3298 /**
3299 * Get accesskey.
3300 *
3301 * @return {string} accessKey string
3302 */
3303 OO.ui.mixin.AccessKeyedElement.prototype.getAccessKey = function () {
3304 return this.accessKey;
3305 };
3306
3307 /**
3308 * ButtonWidget is a generic widget for buttons. A wide variety of looks,
3309 * feels, and functionality can be customized via the class’s configuration options
3310 * and methods. Please see the [OOjs UI documentation on MediaWiki] [1] for more information
3311 * and examples.
3312 *
3313 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches
3314 *
3315 * @example
3316 * // A button widget
3317 * var button = new OO.ui.ButtonWidget( {
3318 * label: 'Button with Icon',
3319 * icon: 'remove',
3320 * iconTitle: 'Remove'
3321 * } );
3322 * $( 'body' ).append( button.$element );
3323 *
3324 * NOTE: HTML form buttons should use the OO.ui.ButtonInputWidget class.
3325 *
3326 * @class
3327 * @extends OO.ui.Widget
3328 * @mixins OO.ui.mixin.ButtonElement
3329 * @mixins OO.ui.mixin.IconElement
3330 * @mixins OO.ui.mixin.IndicatorElement
3331 * @mixins OO.ui.mixin.LabelElement
3332 * @mixins OO.ui.mixin.TitledElement
3333 * @mixins OO.ui.mixin.FlaggedElement
3334 * @mixins OO.ui.mixin.TabIndexedElement
3335 * @mixins OO.ui.mixin.AccessKeyedElement
3336 *
3337 * @constructor
3338 * @param {Object} [config] Configuration options
3339 * @cfg {boolean} [active=false] Whether button should be shown as active
3340 * @cfg {string} [href] Hyperlink to visit when the button is clicked.
3341 * @cfg {string} [target] The frame or window in which to open the hyperlink.
3342 * @cfg {boolean} [noFollow] Search engine traversal hint (default: true)
3343 */
3344 OO.ui.ButtonWidget = function OoUiButtonWidget( config ) {
3345 // Configuration initialization
3346 config = config || {};
3347
3348 // Parent constructor
3349 OO.ui.ButtonWidget.parent.call( this, config );
3350
3351 // Mixin constructors
3352 OO.ui.mixin.ButtonElement.call( this, config );
3353 OO.ui.mixin.IconElement.call( this, config );
3354 OO.ui.mixin.IndicatorElement.call( this, config );
3355 OO.ui.mixin.LabelElement.call( this, config );
3356 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$button } ) );
3357 OO.ui.mixin.FlaggedElement.call( this, config );
3358 OO.ui.mixin.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$button } ) );
3359 OO.ui.mixin.AccessKeyedElement.call( this, $.extend( {}, config, { $accessKeyed: this.$button } ) );
3360
3361 // Properties
3362 this.href = null;
3363 this.target = null;
3364 this.noFollow = false;
3365
3366 // Events
3367 this.connect( this, { disable: 'onDisable' } );
3368
3369 // Initialization
3370 this.$button.append( this.$icon, this.$label, this.$indicator );
3371 this.$element
3372 .addClass( 'oo-ui-buttonWidget' )
3373 .append( this.$button );
3374 this.setActive( config.active );
3375 this.setHref( config.href );
3376 this.setTarget( config.target );
3377 this.setNoFollow( config.noFollow );
3378 };
3379
3380 /* Setup */
3381
3382 OO.inheritClass( OO.ui.ButtonWidget, OO.ui.Widget );
3383 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.ButtonElement );
3384 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.IconElement );
3385 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.IndicatorElement );
3386 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.LabelElement );
3387 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.TitledElement );
3388 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.FlaggedElement );
3389 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.TabIndexedElement );
3390 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.AccessKeyedElement );
3391
3392 /* Methods */
3393
3394 /**
3395 * @inheritdoc
3396 */
3397 OO.ui.ButtonWidget.prototype.onMouseDown = function ( e ) {
3398 if ( !this.isDisabled() ) {
3399 // Remove the tab-index while the button is down to prevent the button from stealing focus
3400 this.$button.removeAttr( 'tabindex' );
3401 }
3402
3403 return OO.ui.mixin.ButtonElement.prototype.onMouseDown.call( this, e );
3404 };
3405
3406 /**
3407 * @inheritdoc
3408 */
3409 OO.ui.ButtonWidget.prototype.onMouseUp = function ( e ) {
3410 if ( !this.isDisabled() ) {
3411 // Restore the tab-index after the button is up to restore the button's accessibility
3412 this.$button.attr( 'tabindex', this.tabIndex );
3413 }
3414
3415 return OO.ui.mixin.ButtonElement.prototype.onMouseUp.call( this, e );
3416 };
3417
3418 /**
3419 * Get hyperlink location.
3420 *
3421 * @return {string} Hyperlink location
3422 */
3423 OO.ui.ButtonWidget.prototype.getHref = function () {
3424 return this.href;
3425 };
3426
3427 /**
3428 * Get hyperlink target.
3429 *
3430 * @return {string} Hyperlink target
3431 */
3432 OO.ui.ButtonWidget.prototype.getTarget = function () {
3433 return this.target;
3434 };
3435
3436 /**
3437 * Get search engine traversal hint.
3438 *
3439 * @return {boolean} Whether search engines should avoid traversing this hyperlink
3440 */
3441 OO.ui.ButtonWidget.prototype.getNoFollow = function () {
3442 return this.noFollow;
3443 };
3444
3445 /**
3446 * Set hyperlink location.
3447 *
3448 * @param {string|null} href Hyperlink location, null to remove
3449 */
3450 OO.ui.ButtonWidget.prototype.setHref = function ( href ) {
3451 href = typeof href === 'string' ? href : null;
3452 if ( href !== null && !OO.ui.isSafeUrl( href ) ) {
3453 href = './' + href;
3454 }
3455
3456 if ( href !== this.href ) {
3457 this.href = href;
3458 this.updateHref();
3459 }
3460
3461 return this;
3462 };
3463
3464 /**
3465 * Update the `href` attribute, in case of changes to href or
3466 * disabled state.
3467 *
3468 * @private
3469 * @chainable
3470 */
3471 OO.ui.ButtonWidget.prototype.updateHref = function () {
3472 if ( this.href !== null && !this.isDisabled() ) {
3473 this.$button.attr( 'href', this.href );
3474 } else {
3475 this.$button.removeAttr( 'href' );
3476 }
3477
3478 return this;
3479 };
3480
3481 /**
3482 * Handle disable events.
3483 *
3484 * @private
3485 * @param {boolean} disabled Element is disabled
3486 */
3487 OO.ui.ButtonWidget.prototype.onDisable = function () {
3488 this.updateHref();
3489 };
3490
3491 /**
3492 * Set hyperlink target.
3493 *
3494 * @param {string|null} target Hyperlink target, null to remove
3495 */
3496 OO.ui.ButtonWidget.prototype.setTarget = function ( target ) {
3497 target = typeof target === 'string' ? target : null;
3498
3499 if ( target !== this.target ) {
3500 this.target = target;
3501 if ( target !== null ) {
3502 this.$button.attr( 'target', target );
3503 } else {
3504 this.$button.removeAttr( 'target' );
3505 }
3506 }
3507
3508 return this;
3509 };
3510
3511 /**
3512 * Set search engine traversal hint.
3513 *
3514 * @param {boolean} noFollow True if search engines should avoid traversing this hyperlink
3515 */
3516 OO.ui.ButtonWidget.prototype.setNoFollow = function ( noFollow ) {
3517 noFollow = typeof noFollow === 'boolean' ? noFollow : true;
3518
3519 if ( noFollow !== this.noFollow ) {
3520 this.noFollow = noFollow;
3521 if ( noFollow ) {
3522 this.$button.attr( 'rel', 'nofollow' );
3523 } else {
3524 this.$button.removeAttr( 'rel' );
3525 }
3526 }
3527
3528 return this;
3529 };
3530
3531 // Override method visibility hints from ButtonElement
3532 /**
3533 * @method setActive
3534 */
3535 /**
3536 * @method isActive
3537 */
3538
3539 /**
3540 * A ButtonGroupWidget groups related buttons and is used together with OO.ui.ButtonWidget and
3541 * its subclasses. Each button in a group is addressed by a unique reference. Buttons can be added,
3542 * removed, and cleared from the group.
3543 *
3544 * @example
3545 * // Example: A ButtonGroupWidget with two buttons
3546 * var button1 = new OO.ui.PopupButtonWidget( {
3547 * label: 'Select a category',
3548 * icon: 'menu',
3549 * popup: {
3550 * $content: $( '<p>List of categories...</p>' ),
3551 * padded: true,
3552 * align: 'left'
3553 * }
3554 * } );
3555 * var button2 = new OO.ui.ButtonWidget( {
3556 * label: 'Add item'
3557 * });
3558 * var buttonGroup = new OO.ui.ButtonGroupWidget( {
3559 * items: [button1, button2]
3560 * } );
3561 * $( 'body' ).append( buttonGroup.$element );
3562 *
3563 * @class
3564 * @extends OO.ui.Widget
3565 * @mixins OO.ui.mixin.GroupElement
3566 *
3567 * @constructor
3568 * @param {Object} [config] Configuration options
3569 * @cfg {OO.ui.ButtonWidget[]} [items] Buttons to add
3570 */
3571 OO.ui.ButtonGroupWidget = function OoUiButtonGroupWidget( config ) {
3572 // Configuration initialization
3573 config = config || {};
3574
3575 // Parent constructor
3576 OO.ui.ButtonGroupWidget.parent.call( this, config );
3577
3578 // Mixin constructors
3579 OO.ui.mixin.GroupElement.call( this, $.extend( {}, config, { $group: this.$element } ) );
3580
3581 // Initialization
3582 this.$element.addClass( 'oo-ui-buttonGroupWidget' );
3583 if ( Array.isArray( config.items ) ) {
3584 this.addItems( config.items );
3585 }
3586 };
3587
3588 /* Setup */
3589
3590 OO.inheritClass( OO.ui.ButtonGroupWidget, OO.ui.Widget );
3591 OO.mixinClass( OO.ui.ButtonGroupWidget, OO.ui.mixin.GroupElement );
3592
3593 /**
3594 * IconWidget is a generic widget for {@link OO.ui.mixin.IconElement icons}. In general, IconWidgets should be used with OO.ui.LabelWidget,
3595 * which creates a label that identifies the icon’s function. See the [OOjs UI documentation on MediaWiki] [1]
3596 * for a list of icons included in the library.
3597 *
3598 * @example
3599 * // An icon widget with a label
3600 * var myIcon = new OO.ui.IconWidget( {
3601 * icon: 'help',
3602 * iconTitle: 'Help'
3603 * } );
3604 * // Create a label.
3605 * var iconLabel = new OO.ui.LabelWidget( {
3606 * label: 'Help'
3607 * } );
3608 * $( 'body' ).append( myIcon.$element, iconLabel.$element );
3609 *
3610 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Icons
3611 *
3612 * @class
3613 * @extends OO.ui.Widget
3614 * @mixins OO.ui.mixin.IconElement
3615 * @mixins OO.ui.mixin.TitledElement
3616 * @mixins OO.ui.mixin.FlaggedElement
3617 *
3618 * @constructor
3619 * @param {Object} [config] Configuration options
3620 */
3621 OO.ui.IconWidget = function OoUiIconWidget( config ) {
3622 // Configuration initialization
3623 config = config || {};
3624
3625 // Parent constructor
3626 OO.ui.IconWidget.parent.call( this, config );
3627
3628 // Mixin constructors
3629 OO.ui.mixin.IconElement.call( this, $.extend( {}, config, { $icon: this.$element } ) );
3630 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$element } ) );
3631 OO.ui.mixin.FlaggedElement.call( this, $.extend( {}, config, { $flagged: this.$element } ) );
3632
3633 // Initialization
3634 this.$element.addClass( 'oo-ui-iconWidget' );
3635 };
3636
3637 /* Setup */
3638
3639 OO.inheritClass( OO.ui.IconWidget, OO.ui.Widget );
3640 OO.mixinClass( OO.ui.IconWidget, OO.ui.mixin.IconElement );
3641 OO.mixinClass( OO.ui.IconWidget, OO.ui.mixin.TitledElement );
3642 OO.mixinClass( OO.ui.IconWidget, OO.ui.mixin.FlaggedElement );
3643
3644 /* Static Properties */
3645
3646 OO.ui.IconWidget.static.tagName = 'span';
3647
3648 /**
3649 * IndicatorWidgets create indicators, which are small graphics that are generally used to draw
3650 * attention to the status of an item or to clarify the function of a control. For a list of
3651 * indicators included in the library, please see the [OOjs UI documentation on MediaWiki][1].
3652 *
3653 * @example
3654 * // Example of an indicator widget
3655 * var indicator1 = new OO.ui.IndicatorWidget( {
3656 * indicator: 'alert'
3657 * } );
3658 *
3659 * // Create a fieldset layout to add a label
3660 * var fieldset = new OO.ui.FieldsetLayout();
3661 * fieldset.addItems( [
3662 * new OO.ui.FieldLayout( indicator1, { label: 'An alert indicator:' } )
3663 * ] );
3664 * $( 'body' ).append( fieldset.$element );
3665 *
3666 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Indicators
3667 *
3668 * @class
3669 * @extends OO.ui.Widget
3670 * @mixins OO.ui.mixin.IndicatorElement
3671 * @mixins OO.ui.mixin.TitledElement
3672 *
3673 * @constructor
3674 * @param {Object} [config] Configuration options
3675 */
3676 OO.ui.IndicatorWidget = function OoUiIndicatorWidget( config ) {
3677 // Configuration initialization
3678 config = config || {};
3679
3680 // Parent constructor
3681 OO.ui.IndicatorWidget.parent.call( this, config );
3682
3683 // Mixin constructors
3684 OO.ui.mixin.IndicatorElement.call( this, $.extend( {}, config, { $indicator: this.$element } ) );
3685 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$element } ) );
3686
3687 // Initialization
3688 this.$element.addClass( 'oo-ui-indicatorWidget' );
3689 };
3690
3691 /* Setup */
3692
3693 OO.inheritClass( OO.ui.IndicatorWidget, OO.ui.Widget );
3694 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.mixin.IndicatorElement );
3695 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.mixin.TitledElement );
3696
3697 /* Static Properties */
3698
3699 OO.ui.IndicatorWidget.static.tagName = 'span';
3700
3701 /**
3702 * LabelWidgets help identify the function of interface elements. Each LabelWidget can
3703 * be configured with a `label` option that is set to a string, a label node, or a function:
3704 *
3705 * - String: a plaintext string
3706 * - jQuery selection: a jQuery selection, used for anything other than a plaintext label, e.g., a
3707 * label that includes a link or special styling, such as a gray color or additional graphical elements.
3708 * - Function: a function that will produce a string in the future. Functions are used
3709 * in cases where the value of the label is not currently defined.
3710 *
3711 * In addition, the LabelWidget can be associated with an {@link OO.ui.InputWidget input widget}, which
3712 * will come into focus when the label is clicked.
3713 *
3714 * @example
3715 * // Examples of LabelWidgets
3716 * var label1 = new OO.ui.LabelWidget( {
3717 * label: 'plaintext label'
3718 * } );
3719 * var label2 = new OO.ui.LabelWidget( {
3720 * label: $( '<a href="default.html">jQuery label</a>' )
3721 * } );
3722 * // Create a fieldset layout with fields for each example
3723 * var fieldset = new OO.ui.FieldsetLayout();
3724 * fieldset.addItems( [
3725 * new OO.ui.FieldLayout( label1 ),
3726 * new OO.ui.FieldLayout( label2 )
3727 * ] );
3728 * $( 'body' ).append( fieldset.$element );
3729 *
3730 * @class
3731 * @extends OO.ui.Widget
3732 * @mixins OO.ui.mixin.LabelElement
3733 *
3734 * @constructor
3735 * @param {Object} [config] Configuration options
3736 * @cfg {OO.ui.InputWidget} [input] {@link OO.ui.InputWidget Input widget} that uses the label.
3737 * Clicking the label will focus the specified input field.
3738 */
3739 OO.ui.LabelWidget = function OoUiLabelWidget( config ) {
3740 // Configuration initialization
3741 config = config || {};
3742
3743 // Parent constructor
3744 OO.ui.LabelWidget.parent.call( this, config );
3745
3746 // Mixin constructors
3747 OO.ui.mixin.LabelElement.call( this, $.extend( {}, config, { $label: this.$element } ) );
3748 OO.ui.mixin.TitledElement.call( this, config );
3749
3750 // Properties
3751 this.input = config.input;
3752
3753 // Events
3754 if ( this.input instanceof OO.ui.InputWidget ) {
3755 this.$element.on( 'click', this.onClick.bind( this ) );
3756 }
3757
3758 // Initialization
3759 this.$element.addClass( 'oo-ui-labelWidget' );
3760 };
3761
3762 /* Setup */
3763
3764 OO.inheritClass( OO.ui.LabelWidget, OO.ui.Widget );
3765 OO.mixinClass( OO.ui.LabelWidget, OO.ui.mixin.LabelElement );
3766 OO.mixinClass( OO.ui.LabelWidget, OO.ui.mixin.TitledElement );
3767
3768 /* Static Properties */
3769
3770 OO.ui.LabelWidget.static.tagName = 'span';
3771
3772 /* Methods */
3773
3774 /**
3775 * Handles label mouse click events.
3776 *
3777 * @private
3778 * @param {jQuery.Event} e Mouse click event
3779 */
3780 OO.ui.LabelWidget.prototype.onClick = function () {
3781 this.input.simulateLabelClick();
3782 return false;
3783 };
3784
3785 /**
3786 * PendingElement is a mixin that is used to create elements that notify users that something is happening
3787 * and that they should wait before proceeding. The pending state is visually represented with a pending
3788 * texture that appears in the head of a pending {@link OO.ui.ProcessDialog process dialog} or in the input
3789 * field of a {@link OO.ui.TextInputWidget text input widget}.
3790 *
3791 * Currently, {@link OO.ui.ActionWidget Action widgets}, which mix in this class, can also be marked as pending, but only when
3792 * used in {@link OO.ui.MessageDialog message dialogs}. The behavior is not currently supported for action widgets used
3793 * in process dialogs.
3794 *
3795 * @example
3796 * function MessageDialog( config ) {
3797 * MessageDialog.parent.call( this, config );
3798 * }
3799 * OO.inheritClass( MessageDialog, OO.ui.MessageDialog );
3800 *
3801 * MessageDialog.static.actions = [
3802 * { action: 'save', label: 'Done', flags: 'primary' },
3803 * { label: 'Cancel', flags: 'safe' }
3804 * ];
3805 *
3806 * MessageDialog.prototype.initialize = function () {
3807 * MessageDialog.parent.prototype.initialize.apply( this, arguments );
3808 * this.content = new OO.ui.PanelLayout( { $: this.$, padded: true } );
3809 * this.content.$element.append( '<p>Click the \'Done\' action widget to see its pending state. Note that action widgets can be marked pending in message dialogs but not process dialogs.</p>' );
3810 * this.$body.append( this.content.$element );
3811 * };
3812 * MessageDialog.prototype.getBodyHeight = function () {
3813 * return 100;
3814 * }
3815 * MessageDialog.prototype.getActionProcess = function ( action ) {
3816 * var dialog = this;
3817 * if ( action === 'save' ) {
3818 * dialog.getActions().get({actions: 'save'})[0].pushPending();
3819 * return new OO.ui.Process()
3820 * .next( 1000 )
3821 * .next( function () {
3822 * dialog.getActions().get({actions: 'save'})[0].popPending();
3823 * } );
3824 * }
3825 * return MessageDialog.parent.prototype.getActionProcess.call( this, action );
3826 * };
3827 *
3828 * var windowManager = new OO.ui.WindowManager();
3829 * $( 'body' ).append( windowManager.$element );
3830 *
3831 * var dialog = new MessageDialog();
3832 * windowManager.addWindows( [ dialog ] );
3833 * windowManager.openWindow( dialog );
3834 *
3835 * @abstract
3836 * @class
3837 *
3838 * @constructor
3839 * @param {Object} [config] Configuration options
3840 * @cfg {jQuery} [$pending] Element to mark as pending, defaults to this.$element
3841 */
3842 OO.ui.mixin.PendingElement = function OoUiMixinPendingElement( config ) {
3843 // Configuration initialization
3844 config = config || {};
3845
3846 // Properties
3847 this.pending = 0;
3848 this.$pending = null;
3849
3850 // Initialisation
3851 this.setPendingElement( config.$pending || this.$element );
3852 };
3853
3854 /* Setup */
3855
3856 OO.initClass( OO.ui.mixin.PendingElement );
3857
3858 /* Methods */
3859
3860 /**
3861 * Set the pending element (and clean up any existing one).
3862 *
3863 * @param {jQuery} $pending The element to set to pending.
3864 */
3865 OO.ui.mixin.PendingElement.prototype.setPendingElement = function ( $pending ) {
3866 if ( this.$pending ) {
3867 this.$pending.removeClass( 'oo-ui-pendingElement-pending' );
3868 }
3869
3870 this.$pending = $pending;
3871 if ( this.pending > 0 ) {
3872 this.$pending.addClass( 'oo-ui-pendingElement-pending' );
3873 }
3874 };
3875
3876 /**
3877 * Check if an element is pending.
3878 *
3879 * @return {boolean} Element is pending
3880 */
3881 OO.ui.mixin.PendingElement.prototype.isPending = function () {
3882 return !!this.pending;
3883 };
3884
3885 /**
3886 * Increase the pending counter. The pending state will remain active until the counter is zero
3887 * (i.e., the number of calls to #pushPending and #popPending is the same).
3888 *
3889 * @chainable
3890 */
3891 OO.ui.mixin.PendingElement.prototype.pushPending = function () {
3892 if ( this.pending === 0 ) {
3893 this.$pending.addClass( 'oo-ui-pendingElement-pending' );
3894 this.updateThemeClasses();
3895 }
3896 this.pending++;
3897
3898 return this;
3899 };
3900
3901 /**
3902 * Decrease the pending counter. The pending state will remain active until the counter is zero
3903 * (i.e., the number of calls to #pushPending and #popPending is the same).
3904 *
3905 * @chainable
3906 */
3907 OO.ui.mixin.PendingElement.prototype.popPending = function () {
3908 if ( this.pending === 1 ) {
3909 this.$pending.removeClass( 'oo-ui-pendingElement-pending' );
3910 this.updateThemeClasses();
3911 }
3912 this.pending = Math.max( 0, this.pending - 1 );
3913
3914 return this;
3915 };
3916
3917 /**
3918 * Element that can be automatically clipped to visible boundaries.
3919 *
3920 * Whenever the element's natural height changes, you have to call
3921 * {@link OO.ui.mixin.ClippableElement#clip} to make sure it's still
3922 * clipping correctly.
3923 *
3924 * The dimensions of #$clippableContainer will be compared to the boundaries of the
3925 * nearest scrollable container. If #$clippableContainer is too tall and/or too wide,
3926 * then #$clippable will be given a fixed reduced height and/or width and will be made
3927 * scrollable. By default, #$clippable and #$clippableContainer are the same element,
3928 * but you can build a static footer by setting #$clippableContainer to an element that contains
3929 * #$clippable and the footer.
3930 *
3931 * @abstract
3932 * @class
3933 *
3934 * @constructor
3935 * @param {Object} [config] Configuration options
3936 * @cfg {jQuery} [$clippable] Node to clip, assigned to #$clippable, omit to use #$element
3937 * @cfg {jQuery} [$clippableContainer] Node to keep visible, assigned to #$clippableContainer,
3938 * omit to use #$clippable
3939 */
3940 OO.ui.mixin.ClippableElement = function OoUiMixinClippableElement( config ) {
3941 // Configuration initialization
3942 config = config || {};
3943
3944 // Properties
3945 this.$clippable = null;
3946 this.$clippableContainer = null;
3947 this.clipping = false;
3948 this.clippedHorizontally = false;
3949 this.clippedVertically = false;
3950 this.$clippableScrollableContainer = null;
3951 this.$clippableScroller = null;
3952 this.$clippableWindow = null;
3953 this.idealWidth = null;
3954 this.idealHeight = null;
3955 this.onClippableScrollHandler = this.clip.bind( this );
3956 this.onClippableWindowResizeHandler = this.clip.bind( this );
3957
3958 // Initialization
3959 if ( config.$clippableContainer ) {
3960 this.setClippableContainer( config.$clippableContainer );
3961 }
3962 this.setClippableElement( config.$clippable || this.$element );
3963 };
3964
3965 /* Methods */
3966
3967 /**
3968 * Set clippable element.
3969 *
3970 * If an element is already set, it will be cleaned up before setting up the new element.
3971 *
3972 * @param {jQuery} $clippable Element to make clippable
3973 */
3974 OO.ui.mixin.ClippableElement.prototype.setClippableElement = function ( $clippable ) {
3975 if ( this.$clippable ) {
3976 this.$clippable.removeClass( 'oo-ui-clippableElement-clippable' );
3977 this.$clippable.css( { width: '', height: '', overflowX: '', overflowY: '' } );
3978 OO.ui.Element.static.reconsiderScrollbars( this.$clippable[ 0 ] );
3979 }
3980
3981 this.$clippable = $clippable.addClass( 'oo-ui-clippableElement-clippable' );
3982 this.clip();
3983 };
3984
3985 /**
3986 * Set clippable container.
3987 *
3988 * This is the container that will be measured when deciding whether to clip. When clipping,
3989 * #$clippable will be resized in order to keep the clippable container fully visible.
3990 *
3991 * If the clippable container is unset, #$clippable will be used.
3992 *
3993 * @param {jQuery|null} $clippableContainer Container to keep visible, or null to unset
3994 */
3995 OO.ui.mixin.ClippableElement.prototype.setClippableContainer = function ( $clippableContainer ) {
3996 this.$clippableContainer = $clippableContainer;
3997 if ( this.$clippable ) {
3998 this.clip();
3999 }
4000 };
4001
4002 /**
4003 * Toggle clipping.
4004 *
4005 * Do not turn clipping on until after the element is attached to the DOM and visible.
4006 *
4007 * @param {boolean} [clipping] Enable clipping, omit to toggle
4008 * @chainable
4009 */
4010 OO.ui.mixin.ClippableElement.prototype.toggleClipping = function ( clipping ) {
4011 clipping = clipping === undefined ? !this.clipping : !!clipping;
4012
4013 if ( this.clipping !== clipping ) {
4014 this.clipping = clipping;
4015 if ( clipping ) {
4016 this.$clippableScrollableContainer = $( this.getClosestScrollableElementContainer() );
4017 // If the clippable container is the root, we have to listen to scroll events and check
4018 // jQuery.scrollTop on the window because of browser inconsistencies
4019 this.$clippableScroller = this.$clippableScrollableContainer.is( 'html, body' ) ?
4020 $( OO.ui.Element.static.getWindow( this.$clippableScrollableContainer ) ) :
4021 this.$clippableScrollableContainer;
4022 this.$clippableScroller.on( 'scroll', this.onClippableScrollHandler );
4023 this.$clippableWindow = $( this.getElementWindow() )
4024 .on( 'resize', this.onClippableWindowResizeHandler );
4025 // Initial clip after visible
4026 this.clip();
4027 } else {
4028 this.$clippable.css( { width: '', height: '', overflowX: '', overflowY: '' } );
4029 OO.ui.Element.static.reconsiderScrollbars( this.$clippable[ 0 ] );
4030
4031 this.$clippableScrollableContainer = null;
4032 this.$clippableScroller.off( 'scroll', this.onClippableScrollHandler );
4033 this.$clippableScroller = null;
4034 this.$clippableWindow.off( 'resize', this.onClippableWindowResizeHandler );
4035 this.$clippableWindow = null;
4036 }
4037 }
4038
4039 return this;
4040 };
4041
4042 /**
4043 * Check if the element will be clipped to fit the visible area of the nearest scrollable container.
4044 *
4045 * @return {boolean} Element will be clipped to the visible area
4046 */
4047 OO.ui.mixin.ClippableElement.prototype.isClipping = function () {
4048 return this.clipping;
4049 };
4050
4051 /**
4052 * Check if the bottom or right of the element is being clipped by the nearest scrollable container.
4053 *
4054 * @return {boolean} Part of the element is being clipped
4055 */
4056 OO.ui.mixin.ClippableElement.prototype.isClipped = function () {
4057 return this.clippedHorizontally || this.clippedVertically;
4058 };
4059
4060 /**
4061 * Check if the right of the element is being clipped by the nearest scrollable container.
4062 *
4063 * @return {boolean} Part of the element is being clipped
4064 */
4065 OO.ui.mixin.ClippableElement.prototype.isClippedHorizontally = function () {
4066 return this.clippedHorizontally;
4067 };
4068
4069 /**
4070 * Check if the bottom of the element is being clipped by the nearest scrollable container.
4071 *
4072 * @return {boolean} Part of the element is being clipped
4073 */
4074 OO.ui.mixin.ClippableElement.prototype.isClippedVertically = function () {
4075 return this.clippedVertically;
4076 };
4077
4078 /**
4079 * Set the ideal size. These are the dimensions the element will have when it's not being clipped.
4080 *
4081 * @param {number|string} [width] Width as a number of pixels or CSS string with unit suffix
4082 * @param {number|string} [height] Height as a number of pixels or CSS string with unit suffix
4083 */
4084 OO.ui.mixin.ClippableElement.prototype.setIdealSize = function ( width, height ) {
4085 this.idealWidth = width;
4086 this.idealHeight = height;
4087
4088 if ( !this.clipping ) {
4089 // Update dimensions
4090 this.$clippable.css( { width: width, height: height } );
4091 }
4092 // While clipping, idealWidth and idealHeight are not considered
4093 };
4094
4095 /**
4096 * Clip element to visible boundaries and allow scrolling when needed. You should call this method
4097 * when the element's natural height changes.
4098 *
4099 * Element will be clipped the bottom or right of the element is within 10px of the edge of, or
4100 * overlapped by, the visible area of the nearest scrollable container.
4101 *
4102 * Because calling clip() when the natural height changes isn't always possible, we also set
4103 * max-height when the element isn't being clipped. This means that if the element tries to grow
4104 * beyond the edge, something reasonable will happen before clip() is called.
4105 *
4106 * @chainable
4107 */
4108 OO.ui.mixin.ClippableElement.prototype.clip = function () {
4109 var $container, extraHeight, extraWidth, ccOffset,
4110 $scrollableContainer, scOffset, scHeight, scWidth,
4111 ccWidth, scrollerIsWindow, scrollTop, scrollLeft,
4112 desiredWidth, desiredHeight, allotedWidth, allotedHeight,
4113 naturalWidth, naturalHeight, clipWidth, clipHeight,
4114 buffer = 7; // Chosen by fair dice roll
4115
4116 if ( !this.clipping ) {
4117 // this.$clippableScrollableContainer and this.$clippableWindow are null, so the below will fail
4118 return this;
4119 }
4120
4121 $container = this.$clippableContainer || this.$clippable;
4122 extraHeight = $container.outerHeight() - this.$clippable.outerHeight();
4123 extraWidth = $container.outerWidth() - this.$clippable.outerWidth();
4124 ccOffset = $container.offset();
4125 $scrollableContainer = this.$clippableScrollableContainer.is( 'html, body' ) ?
4126 this.$clippableWindow : this.$clippableScrollableContainer;
4127 scOffset = $scrollableContainer.offset() || { top: 0, left: 0 };
4128 scHeight = $scrollableContainer.innerHeight() - buffer;
4129 scWidth = $scrollableContainer.innerWidth() - buffer;
4130 ccWidth = $container.outerWidth() + buffer;
4131 scrollerIsWindow = this.$clippableScroller[ 0 ] === this.$clippableWindow[ 0 ];
4132 scrollTop = scrollerIsWindow ? this.$clippableScroller.scrollTop() : 0;
4133 scrollLeft = scrollerIsWindow ? this.$clippableScroller.scrollLeft() : 0;
4134 desiredWidth = ccOffset.left < 0 ?
4135 ccWidth + ccOffset.left :
4136 ( scOffset.left + scrollLeft + scWidth ) - ccOffset.left;
4137 desiredHeight = ( scOffset.top + scrollTop + scHeight ) - ccOffset.top;
4138 // It should never be desirable to exceed the dimensions of the browser viewport... right?
4139 desiredWidth = Math.min( desiredWidth, document.documentElement.clientWidth );
4140 desiredHeight = Math.min( desiredHeight, document.documentElement.clientHeight );
4141 allotedWidth = Math.ceil( desiredWidth - extraWidth );
4142 allotedHeight = Math.ceil( desiredHeight - extraHeight );
4143 naturalWidth = this.$clippable.prop( 'scrollWidth' );
4144 naturalHeight = this.$clippable.prop( 'scrollHeight' );
4145 clipWidth = allotedWidth < naturalWidth;
4146 clipHeight = allotedHeight < naturalHeight;
4147
4148 if ( clipWidth ) {
4149 this.$clippable.css( {
4150 overflowX: 'scroll',
4151 width: Math.max( 0, allotedWidth ),
4152 maxWidth: ''
4153 } );
4154 } else {
4155 this.$clippable.css( {
4156 overflowX: '',
4157 width: this.idealWidth ? this.idealWidth - extraWidth : '',
4158 maxWidth: Math.max( 0, allotedWidth )
4159 } );
4160 }
4161 if ( clipHeight ) {
4162 this.$clippable.css( {
4163 overflowY: 'scroll',
4164 height: Math.max( 0, allotedHeight ),
4165 maxHeight: ''
4166 } );
4167 } else {
4168 this.$clippable.css( {
4169 overflowY: '',
4170 height: this.idealHeight ? this.idealHeight - extraHeight : '',
4171 maxHeight: Math.max( 0, allotedHeight )
4172 } );
4173 }
4174
4175 // If we stopped clipping in at least one of the dimensions
4176 if ( ( this.clippedHorizontally && !clipWidth ) || ( this.clippedVertically && !clipHeight ) ) {
4177 OO.ui.Element.static.reconsiderScrollbars( this.$clippable[ 0 ] );
4178 }
4179
4180 this.clippedHorizontally = clipWidth;
4181 this.clippedVertically = clipHeight;
4182
4183 return this;
4184 };
4185
4186 /**
4187 * PopupWidget is a container for content. The popup is overlaid and positioned absolutely.
4188 * By default, each popup has an anchor that points toward its origin.
4189 * Please see the [OOjs UI documentation on Mediawiki] [1] for more information and examples.
4190 *
4191 * @example
4192 * // A popup widget.
4193 * var popup = new OO.ui.PopupWidget( {
4194 * $content: $( '<p>Hi there!</p>' ),
4195 * padded: true,
4196 * width: 300
4197 * } );
4198 *
4199 * $( 'body' ).append( popup.$element );
4200 * // To display the popup, toggle the visibility to 'true'.
4201 * popup.toggle( true );
4202 *
4203 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Popups
4204 *
4205 * @class
4206 * @extends OO.ui.Widget
4207 * @mixins OO.ui.mixin.LabelElement
4208 * @mixins OO.ui.mixin.ClippableElement
4209 *
4210 * @constructor
4211 * @param {Object} [config] Configuration options
4212 * @cfg {number} [width=320] Width of popup in pixels
4213 * @cfg {number} [height] Height of popup in pixels. Omit to use the automatic height.
4214 * @cfg {boolean} [anchor=true] Show anchor pointing to origin of popup
4215 * @cfg {string} [align='center'] Alignment of the popup: `center`, `force-left`, `force-right`, `backwards` or `forwards`.
4216 * If the popup is forced-left the popup body is leaning towards the left. For force-right alignment, the body of the
4217 * popup is leaning towards the right of the screen.
4218 * Using 'backwards' is a logical direction which will result in the popup leaning towards the beginning of the sentence
4219 * in the given language, which means it will flip to the correct positioning in right-to-left languages.
4220 * Using 'forward' will also result in a logical alignment where the body of the popup leans towards the end of the
4221 * sentence in the given language.
4222 * @cfg {jQuery} [$container] Constrain the popup to the boundaries of the specified container.
4223 * See the [OOjs UI docs on MediaWiki][3] for an example.
4224 * [3]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Popups#containerExample
4225 * @cfg {number} [containerPadding=10] Padding between the popup and its container, specified as a number of pixels.
4226 * @cfg {jQuery} [$content] Content to append to the popup's body
4227 * @cfg {jQuery} [$footer] Content to append to the popup's footer
4228 * @cfg {boolean} [autoClose=false] Automatically close the popup when it loses focus.
4229 * @cfg {jQuery} [$autoCloseIgnore] Elements that will not close the popup when clicked.
4230 * This config option is only relevant if #autoClose is set to `true`. See the [OOjs UI docs on MediaWiki][2]
4231 * for an example.
4232 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Popups#autocloseExample
4233 * @cfg {boolean} [head=false] Show a popup header that contains a #label (if specified) and close
4234 * button.
4235 * @cfg {boolean} [padded=false] Add padding to the popup's body
4236 */
4237 OO.ui.PopupWidget = function OoUiPopupWidget( config ) {
4238 // Configuration initialization
4239 config = config || {};
4240
4241 // Parent constructor
4242 OO.ui.PopupWidget.parent.call( this, config );
4243
4244 // Properties (must be set before ClippableElement constructor call)
4245 this.$body = $( '<div>' );
4246 this.$popup = $( '<div>' );
4247
4248 // Mixin constructors
4249 OO.ui.mixin.LabelElement.call( this, config );
4250 OO.ui.mixin.ClippableElement.call( this, $.extend( {}, config, {
4251 $clippable: this.$body,
4252 $clippableContainer: this.$popup
4253 } ) );
4254
4255 // Properties
4256 this.$anchor = $( '<div>' );
4257 // If undefined, will be computed lazily in updateDimensions()
4258 this.$container = config.$container;
4259 this.containerPadding = config.containerPadding !== undefined ? config.containerPadding : 10;
4260 this.autoClose = !!config.autoClose;
4261 this.$autoCloseIgnore = config.$autoCloseIgnore;
4262 this.transitionTimeout = null;
4263 this.anchor = null;
4264 this.width = config.width !== undefined ? config.width : 320;
4265 this.height = config.height !== undefined ? config.height : null;
4266 this.setAlignment( config.align );
4267 this.onMouseDownHandler = this.onMouseDown.bind( this );
4268 this.onDocumentKeyDownHandler = this.onDocumentKeyDown.bind( this );
4269
4270 // Initialization
4271 this.toggleAnchor( config.anchor === undefined || config.anchor );
4272 this.$body.addClass( 'oo-ui-popupWidget-body' );
4273 this.$anchor.addClass( 'oo-ui-popupWidget-anchor' );
4274 this.$popup
4275 .addClass( 'oo-ui-popupWidget-popup' )
4276 .append( this.$body );
4277 this.$element
4278 .addClass( 'oo-ui-popupWidget' )
4279 .append( this.$popup, this.$anchor );
4280 // Move content, which was added to #$element by OO.ui.Widget, to the body
4281 // FIXME This is gross, we should use '$body' or something for the config
4282 if ( config.$content instanceof jQuery ) {
4283 this.$body.append( config.$content );
4284 }
4285
4286 if ( config.padded ) {
4287 this.$body.addClass( 'oo-ui-popupWidget-body-padded' );
4288 }
4289
4290 if ( config.head ) {
4291 this.closeButton = new OO.ui.ButtonWidget( { framed: false, icon: 'close' } );
4292 this.closeButton.connect( this, { click: 'onCloseButtonClick' } );
4293 this.$head = $( '<div>' )
4294 .addClass( 'oo-ui-popupWidget-head' )
4295 .append( this.$label, this.closeButton.$element );
4296 this.$popup.prepend( this.$head );
4297 }
4298
4299 if ( config.$footer ) {
4300 this.$footer = $( '<div>' )
4301 .addClass( 'oo-ui-popupWidget-footer' )
4302 .append( config.$footer );
4303 this.$popup.append( this.$footer );
4304 }
4305
4306 // Initially hidden - using #toggle may cause errors if subclasses override toggle with methods
4307 // that reference properties not initialized at that time of parent class construction
4308 // TODO: Find a better way to handle post-constructor setup
4309 this.visible = false;
4310 this.$element.addClass( 'oo-ui-element-hidden' );
4311 };
4312
4313 /* Setup */
4314
4315 OO.inheritClass( OO.ui.PopupWidget, OO.ui.Widget );
4316 OO.mixinClass( OO.ui.PopupWidget, OO.ui.mixin.LabelElement );
4317 OO.mixinClass( OO.ui.PopupWidget, OO.ui.mixin.ClippableElement );
4318
4319 /* Methods */
4320
4321 /**
4322 * Handles mouse down events.
4323 *
4324 * @private
4325 * @param {MouseEvent} e Mouse down event
4326 */
4327 OO.ui.PopupWidget.prototype.onMouseDown = function ( e ) {
4328 if (
4329 this.isVisible() &&
4330 !$.contains( this.$element[ 0 ], e.target ) &&
4331 ( !this.$autoCloseIgnore || !this.$autoCloseIgnore.has( e.target ).length )
4332 ) {
4333 this.toggle( false );
4334 }
4335 };
4336
4337 /**
4338 * Bind mouse down listener.
4339 *
4340 * @private
4341 */
4342 OO.ui.PopupWidget.prototype.bindMouseDownListener = function () {
4343 // Capture clicks outside popup
4344 this.getElementWindow().addEventListener( 'mousedown', this.onMouseDownHandler, true );
4345 };
4346
4347 /**
4348 * Handles close button click events.
4349 *
4350 * @private
4351 */
4352 OO.ui.PopupWidget.prototype.onCloseButtonClick = function () {
4353 if ( this.isVisible() ) {
4354 this.toggle( false );
4355 }
4356 };
4357
4358 /**
4359 * Unbind mouse down listener.
4360 *
4361 * @private
4362 */
4363 OO.ui.PopupWidget.prototype.unbindMouseDownListener = function () {
4364 this.getElementWindow().removeEventListener( 'mousedown', this.onMouseDownHandler, true );
4365 };
4366
4367 /**
4368 * Handles key down events.
4369 *
4370 * @private
4371 * @param {KeyboardEvent} e Key down event
4372 */
4373 OO.ui.PopupWidget.prototype.onDocumentKeyDown = function ( e ) {
4374 if (
4375 e.which === OO.ui.Keys.ESCAPE &&
4376 this.isVisible()
4377 ) {
4378 this.toggle( false );
4379 e.preventDefault();
4380 e.stopPropagation();
4381 }
4382 };
4383
4384 /**
4385 * Bind key down listener.
4386 *
4387 * @private
4388 */
4389 OO.ui.PopupWidget.prototype.bindKeyDownListener = function () {
4390 this.getElementWindow().addEventListener( 'keydown', this.onDocumentKeyDownHandler, true );
4391 };
4392
4393 /**
4394 * Unbind key down listener.
4395 *
4396 * @private
4397 */
4398 OO.ui.PopupWidget.prototype.unbindKeyDownListener = function () {
4399 this.getElementWindow().removeEventListener( 'keydown', this.onDocumentKeyDownHandler, true );
4400 };
4401
4402 /**
4403 * Show, hide, or toggle the visibility of the anchor.
4404 *
4405 * @param {boolean} [show] Show anchor, omit to toggle
4406 */
4407 OO.ui.PopupWidget.prototype.toggleAnchor = function ( show ) {
4408 show = show === undefined ? !this.anchored : !!show;
4409
4410 if ( this.anchored !== show ) {
4411 if ( show ) {
4412 this.$element.addClass( 'oo-ui-popupWidget-anchored' );
4413 } else {
4414 this.$element.removeClass( 'oo-ui-popupWidget-anchored' );
4415 }
4416 this.anchored = show;
4417 }
4418 };
4419
4420 /**
4421 * Check if the anchor is visible.
4422 *
4423 * @return {boolean} Anchor is visible
4424 */
4425 OO.ui.PopupWidget.prototype.hasAnchor = function () {
4426 return this.anchor;
4427 };
4428
4429 /**
4430 * @inheritdoc
4431 */
4432 OO.ui.PopupWidget.prototype.toggle = function ( show ) {
4433 var change;
4434 show = show === undefined ? !this.isVisible() : !!show;
4435
4436 change = show !== this.isVisible();
4437
4438 // Parent method
4439 OO.ui.PopupWidget.parent.prototype.toggle.call( this, show );
4440
4441 if ( change ) {
4442 if ( show ) {
4443 if ( this.autoClose ) {
4444 this.bindMouseDownListener();
4445 this.bindKeyDownListener();
4446 }
4447 this.updateDimensions();
4448 this.toggleClipping( true );
4449 } else {
4450 this.toggleClipping( false );
4451 if ( this.autoClose ) {
4452 this.unbindMouseDownListener();
4453 this.unbindKeyDownListener();
4454 }
4455 }
4456 }
4457
4458 return this;
4459 };
4460
4461 /**
4462 * Set the size of the popup.
4463 *
4464 * Changing the size may also change the popup's position depending on the alignment.
4465 *
4466 * @param {number} width Width in pixels
4467 * @param {number} height Height in pixels
4468 * @param {boolean} [transition=false] Use a smooth transition
4469 * @chainable
4470 */
4471 OO.ui.PopupWidget.prototype.setSize = function ( width, height, transition ) {
4472 this.width = width;
4473 this.height = height !== undefined ? height : null;
4474 if ( this.isVisible() ) {
4475 this.updateDimensions( transition );
4476 }
4477 };
4478
4479 /**
4480 * Update the size and position.
4481 *
4482 * Only use this to keep the popup properly anchored. Use #setSize to change the size, and this will
4483 * be called automatically.
4484 *
4485 * @param {boolean} [transition=false] Use a smooth transition
4486 * @chainable
4487 */
4488 OO.ui.PopupWidget.prototype.updateDimensions = function ( transition ) {
4489 var popupOffset, originOffset, containerLeft, containerWidth, containerRight,
4490 popupLeft, popupRight, overlapLeft, overlapRight, anchorWidth,
4491 align = this.align,
4492 widget = this;
4493
4494 if ( !this.$container ) {
4495 // Lazy-initialize $container if not specified in constructor
4496 this.$container = $( this.getClosestScrollableElementContainer() );
4497 }
4498
4499 // Set height and width before measuring things, since it might cause our measurements
4500 // to change (e.g. due to scrollbars appearing or disappearing)
4501 this.$popup.css( {
4502 width: this.width,
4503 height: this.height !== null ? this.height : 'auto'
4504 } );
4505
4506 // If we are in RTL, we need to flip the alignment, unless it is center
4507 if ( align === 'forwards' || align === 'backwards' ) {
4508 if ( this.$container.css( 'direction' ) === 'rtl' ) {
4509 align = ( { forwards: 'force-left', backwards: 'force-right' } )[ this.align ];
4510 } else {
4511 align = ( { forwards: 'force-right', backwards: 'force-left' } )[ this.align ];
4512 }
4513
4514 }
4515
4516 // Compute initial popupOffset based on alignment
4517 popupOffset = this.width * ( { 'force-left': -1, center: -0.5, 'force-right': 0 } )[ align ];
4518
4519 // Figure out if this will cause the popup to go beyond the edge of the container
4520 originOffset = this.$element.offset().left;
4521 containerLeft = this.$container.offset().left;
4522 containerWidth = this.$container.innerWidth();
4523 containerRight = containerLeft + containerWidth;
4524 popupLeft = popupOffset - this.containerPadding;
4525 popupRight = popupOffset + this.containerPadding + this.width + this.containerPadding;
4526 overlapLeft = ( originOffset + popupLeft ) - containerLeft;
4527 overlapRight = containerRight - ( originOffset + popupRight );
4528
4529 // Adjust offset to make the popup not go beyond the edge, if needed
4530 if ( overlapRight < 0 ) {
4531 popupOffset += overlapRight;
4532 } else if ( overlapLeft < 0 ) {
4533 popupOffset -= overlapLeft;
4534 }
4535
4536 // Adjust offset to avoid anchor being rendered too close to the edge
4537 // $anchor.width() doesn't work with the pure CSS anchor (returns 0)
4538 // TODO: Find a measurement that works for CSS anchors and image anchors
4539 anchorWidth = this.$anchor[ 0 ].scrollWidth * 2;
4540 if ( popupOffset + this.width < anchorWidth ) {
4541 popupOffset = anchorWidth - this.width;
4542 } else if ( -popupOffset < anchorWidth ) {
4543 popupOffset = -anchorWidth;
4544 }
4545
4546 // Prevent transition from being interrupted
4547 clearTimeout( this.transitionTimeout );
4548 if ( transition ) {
4549 // Enable transition
4550 this.$element.addClass( 'oo-ui-popupWidget-transitioning' );
4551 }
4552
4553 // Position body relative to anchor
4554 this.$popup.css( 'margin-left', popupOffset );
4555
4556 if ( transition ) {
4557 // Prevent transitioning after transition is complete
4558 this.transitionTimeout = setTimeout( function () {
4559 widget.$element.removeClass( 'oo-ui-popupWidget-transitioning' );
4560 }, 200 );
4561 } else {
4562 // Prevent transitioning immediately
4563 this.$element.removeClass( 'oo-ui-popupWidget-transitioning' );
4564 }
4565
4566 // Reevaluate clipping state since we've relocated and resized the popup
4567 this.clip();
4568
4569 return this;
4570 };
4571
4572 /**
4573 * Set popup alignment
4574 *
4575 * @param {string} align Alignment of the popup, `center`, `force-left`, `force-right`,
4576 * `backwards` or `forwards`.
4577 */
4578 OO.ui.PopupWidget.prototype.setAlignment = function ( align ) {
4579 // Validate alignment and transform deprecated values
4580 if ( [ 'left', 'right', 'force-left', 'force-right', 'backwards', 'forwards', 'center' ].indexOf( align ) > -1 ) {
4581 this.align = { left: 'force-right', right: 'force-left' }[ align ] || align;
4582 } else {
4583 this.align = 'center';
4584 }
4585 };
4586
4587 /**
4588 * Get popup alignment
4589 *
4590 * @return {string} align Alignment of the popup, `center`, `force-left`, `force-right`,
4591 * `backwards` or `forwards`.
4592 */
4593 OO.ui.PopupWidget.prototype.getAlignment = function () {
4594 return this.align;
4595 };
4596
4597 /**
4598 * PopupElement is mixed into other classes to generate a {@link OO.ui.PopupWidget popup widget}.
4599 * A popup is a container for content. It is overlaid and positioned absolutely. By default, each
4600 * popup has an anchor, which is an arrow-like protrusion that points toward the popup’s origin.
4601 * See {@link OO.ui.PopupWidget PopupWidget} for an example.
4602 *
4603 * @abstract
4604 * @class
4605 *
4606 * @constructor
4607 * @param {Object} [config] Configuration options
4608 * @cfg {Object} [popup] Configuration to pass to popup
4609 * @cfg {boolean} [popup.autoClose=true] Popup auto-closes when it loses focus
4610 */
4611 OO.ui.mixin.PopupElement = function OoUiMixinPopupElement( config ) {
4612 // Configuration initialization
4613 config = config || {};
4614
4615 // Properties
4616 this.popup = new OO.ui.PopupWidget( $.extend(
4617 { autoClose: true },
4618 config.popup,
4619 { $autoCloseIgnore: this.$element }
4620 ) );
4621 };
4622
4623 /* Methods */
4624
4625 /**
4626 * Get popup.
4627 *
4628 * @return {OO.ui.PopupWidget} Popup widget
4629 */
4630 OO.ui.mixin.PopupElement.prototype.getPopup = function () {
4631 return this.popup;
4632 };
4633
4634 /**
4635 * PopupButtonWidgets toggle the visibility of a contained {@link OO.ui.PopupWidget PopupWidget},
4636 * which is used to display additional information or options.
4637 *
4638 * @example
4639 * // Example of a popup button.
4640 * var popupButton = new OO.ui.PopupButtonWidget( {
4641 * label: 'Popup button with options',
4642 * icon: 'menu',
4643 * popup: {
4644 * $content: $( '<p>Additional options here.</p>' ),
4645 * padded: true,
4646 * align: 'force-left'
4647 * }
4648 * } );
4649 * // Append the button to the DOM.
4650 * $( 'body' ).append( popupButton.$element );
4651 *
4652 * @class
4653 * @extends OO.ui.ButtonWidget
4654 * @mixins OO.ui.mixin.PopupElement
4655 *
4656 * @constructor
4657 * @param {Object} [config] Configuration options
4658 */
4659 OO.ui.PopupButtonWidget = function OoUiPopupButtonWidget( config ) {
4660 // Parent constructor
4661 OO.ui.PopupButtonWidget.parent.call( this, config );
4662
4663 // Mixin constructors
4664 OO.ui.mixin.PopupElement.call( this, config );
4665
4666 // Events
4667 this.connect( this, { click: 'onAction' } );
4668
4669 // Initialization
4670 this.$element
4671 .addClass( 'oo-ui-popupButtonWidget' )
4672 .attr( 'aria-haspopup', 'true' )
4673 .append( this.popup.$element );
4674 };
4675
4676 /* Setup */
4677
4678 OO.inheritClass( OO.ui.PopupButtonWidget, OO.ui.ButtonWidget );
4679 OO.mixinClass( OO.ui.PopupButtonWidget, OO.ui.mixin.PopupElement );
4680
4681 /* Methods */
4682
4683 /**
4684 * Handle the button action being triggered.
4685 *
4686 * @private
4687 */
4688 OO.ui.PopupButtonWidget.prototype.onAction = function () {
4689 this.popup.toggle();
4690 };
4691
4692 /**
4693 * Mixin for OO.ui.Widget subclasses to provide OO.ui.mixin.GroupElement.
4694 *
4695 * Use together with OO.ui.mixin.ItemWidget to make disabled state inheritable.
4696 *
4697 * @private
4698 * @abstract
4699 * @class
4700 * @extends OO.ui.mixin.GroupElement
4701 *
4702 * @constructor
4703 * @param {Object} [config] Configuration options
4704 */
4705 OO.ui.mixin.GroupWidget = function OoUiMixinGroupWidget( config ) {
4706 // Parent constructor
4707 OO.ui.mixin.GroupWidget.parent.call( this, config );
4708 };
4709
4710 /* Setup */
4711
4712 OO.inheritClass( OO.ui.mixin.GroupWidget, OO.ui.mixin.GroupElement );
4713
4714 /* Methods */
4715
4716 /**
4717 * Set the disabled state of the widget.
4718 *
4719 * This will also update the disabled state of child widgets.
4720 *
4721 * @param {boolean} disabled Disable widget
4722 * @chainable
4723 */
4724 OO.ui.mixin.GroupWidget.prototype.setDisabled = function ( disabled ) {
4725 var i, len;
4726
4727 // Parent method
4728 // Note: Calling #setDisabled this way assumes this is mixed into an OO.ui.Widget
4729 OO.ui.Widget.prototype.setDisabled.call( this, disabled );
4730
4731 // During construction, #setDisabled is called before the OO.ui.mixin.GroupElement constructor
4732 if ( this.items ) {
4733 for ( i = 0, len = this.items.length; i < len; i++ ) {
4734 this.items[ i ].updateDisabled();
4735 }
4736 }
4737
4738 return this;
4739 };
4740
4741 /**
4742 * Mixin for widgets used as items in widgets that mix in OO.ui.mixin.GroupWidget.
4743 *
4744 * Item widgets have a reference to a OO.ui.mixin.GroupWidget while they are attached to the group. This
4745 * allows bidirectional communication.
4746 *
4747 * Use together with OO.ui.mixin.GroupWidget to make disabled state inheritable.
4748 *
4749 * @private
4750 * @abstract
4751 * @class
4752 *
4753 * @constructor
4754 */
4755 OO.ui.mixin.ItemWidget = function OoUiMixinItemWidget() {
4756 //
4757 };
4758
4759 /* Methods */
4760
4761 /**
4762 * Check if widget is disabled.
4763 *
4764 * Checks parent if present, making disabled state inheritable.
4765 *
4766 * @return {boolean} Widget is disabled
4767 */
4768 OO.ui.mixin.ItemWidget.prototype.isDisabled = function () {
4769 return this.disabled ||
4770 ( this.elementGroup instanceof OO.ui.Widget && this.elementGroup.isDisabled() );
4771 };
4772
4773 /**
4774 * Set group element is in.
4775 *
4776 * @param {OO.ui.mixin.GroupElement|null} group Group element, null if none
4777 * @chainable
4778 */
4779 OO.ui.mixin.ItemWidget.prototype.setElementGroup = function ( group ) {
4780 // Parent method
4781 // Note: Calling #setElementGroup this way assumes this is mixed into an OO.ui.Element
4782 OO.ui.Element.prototype.setElementGroup.call( this, group );
4783
4784 // Initialize item disabled states
4785 this.updateDisabled();
4786
4787 return this;
4788 };
4789
4790 /**
4791 * OptionWidgets are special elements that can be selected and configured with data. The
4792 * data is often unique for each option, but it does not have to be. OptionWidgets are used
4793 * with OO.ui.SelectWidget to create a selection of mutually exclusive options. For more information
4794 * and examples, please see the [OOjs UI documentation on MediaWiki][1].
4795 *
4796 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
4797 *
4798 * @class
4799 * @extends OO.ui.Widget
4800 * @mixins OO.ui.mixin.ItemWidget
4801 * @mixins OO.ui.mixin.LabelElement
4802 * @mixins OO.ui.mixin.FlaggedElement
4803 * @mixins OO.ui.mixin.AccessKeyedElement
4804 *
4805 * @constructor
4806 * @param {Object} [config] Configuration options
4807 */
4808 OO.ui.OptionWidget = function OoUiOptionWidget( config ) {
4809 // Configuration initialization
4810 config = config || {};
4811
4812 // Parent constructor
4813 OO.ui.OptionWidget.parent.call( this, config );
4814
4815 // Mixin constructors
4816 OO.ui.mixin.ItemWidget.call( this );
4817 OO.ui.mixin.LabelElement.call( this, config );
4818 OO.ui.mixin.FlaggedElement.call( this, config );
4819 OO.ui.mixin.AccessKeyedElement.call( this, config );
4820
4821 // Properties
4822 this.selected = false;
4823 this.highlighted = false;
4824 this.pressed = false;
4825
4826 // Initialization
4827 this.$element
4828 .data( 'oo-ui-optionWidget', this )
4829 // Allow programmatic focussing (and by accesskey), but not tabbing
4830 .attr( 'tabindex', '-1' )
4831 .attr( 'role', 'option' )
4832 .attr( 'aria-selected', 'false' )
4833 .addClass( 'oo-ui-optionWidget' )
4834 .append( this.$label );
4835 };
4836
4837 /* Setup */
4838
4839 OO.inheritClass( OO.ui.OptionWidget, OO.ui.Widget );
4840 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.ItemWidget );
4841 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.LabelElement );
4842 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.FlaggedElement );
4843 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.AccessKeyedElement );
4844
4845 /* Static Properties */
4846
4847 OO.ui.OptionWidget.static.selectable = true;
4848
4849 OO.ui.OptionWidget.static.highlightable = true;
4850
4851 OO.ui.OptionWidget.static.pressable = true;
4852
4853 OO.ui.OptionWidget.static.scrollIntoViewOnSelect = false;
4854
4855 /* Methods */
4856
4857 /**
4858 * Check if the option can be selected.
4859 *
4860 * @return {boolean} Item is selectable
4861 */
4862 OO.ui.OptionWidget.prototype.isSelectable = function () {
4863 return this.constructor.static.selectable && !this.isDisabled() && this.isVisible();
4864 };
4865
4866 /**
4867 * Check if the option can be highlighted. A highlight indicates that the option
4868 * may be selected when a user presses enter or clicks. Disabled items cannot
4869 * be highlighted.
4870 *
4871 * @return {boolean} Item is highlightable
4872 */
4873 OO.ui.OptionWidget.prototype.isHighlightable = function () {
4874 return this.constructor.static.highlightable && !this.isDisabled() && this.isVisible();
4875 };
4876
4877 /**
4878 * Check if the option can be pressed. The pressed state occurs when a user mouses
4879 * down on an item, but has not yet let go of the mouse.
4880 *
4881 * @return {boolean} Item is pressable
4882 */
4883 OO.ui.OptionWidget.prototype.isPressable = function () {
4884 return this.constructor.static.pressable && !this.isDisabled() && this.isVisible();
4885 };
4886
4887 /**
4888 * Check if the option is selected.
4889 *
4890 * @return {boolean} Item is selected
4891 */
4892 OO.ui.OptionWidget.prototype.isSelected = function () {
4893 return this.selected;
4894 };
4895
4896 /**
4897 * Check if the option is highlighted. A highlight indicates that the
4898 * item may be selected when a user presses enter or clicks.
4899 *
4900 * @return {boolean} Item is highlighted
4901 */
4902 OO.ui.OptionWidget.prototype.isHighlighted = function () {
4903 return this.highlighted;
4904 };
4905
4906 /**
4907 * Check if the option is pressed. The pressed state occurs when a user mouses
4908 * down on an item, but has not yet let go of the mouse. The item may appear
4909 * selected, but it will not be selected until the user releases the mouse.
4910 *
4911 * @return {boolean} Item is pressed
4912 */
4913 OO.ui.OptionWidget.prototype.isPressed = function () {
4914 return this.pressed;
4915 };
4916
4917 /**
4918 * Set the option’s selected state. In general, all modifications to the selection
4919 * should be handled by the SelectWidget’s {@link OO.ui.SelectWidget#selectItem selectItem( [item] )}
4920 * method instead of this method.
4921 *
4922 * @param {boolean} [state=false] Select option
4923 * @chainable
4924 */
4925 OO.ui.OptionWidget.prototype.setSelected = function ( state ) {
4926 if ( this.constructor.static.selectable ) {
4927 this.selected = !!state;
4928 this.$element
4929 .toggleClass( 'oo-ui-optionWidget-selected', state )
4930 .attr( 'aria-selected', state.toString() );
4931 if ( state && this.constructor.static.scrollIntoViewOnSelect ) {
4932 this.scrollElementIntoView();
4933 }
4934 this.updateThemeClasses();
4935 }
4936 return this;
4937 };
4938
4939 /**
4940 * Set the option’s highlighted state. In general, all programmatic
4941 * modifications to the highlight should be handled by the
4942 * SelectWidget’s {@link OO.ui.SelectWidget#highlightItem highlightItem( [item] )}
4943 * method instead of this method.
4944 *
4945 * @param {boolean} [state=false] Highlight option
4946 * @chainable
4947 */
4948 OO.ui.OptionWidget.prototype.setHighlighted = function ( state ) {
4949 if ( this.constructor.static.highlightable ) {
4950 this.highlighted = !!state;
4951 this.$element.toggleClass( 'oo-ui-optionWidget-highlighted', state );
4952 this.updateThemeClasses();
4953 }
4954 return this;
4955 };
4956
4957 /**
4958 * Set the option’s pressed state. In general, all
4959 * programmatic modifications to the pressed state should be handled by the
4960 * SelectWidget’s {@link OO.ui.SelectWidget#pressItem pressItem( [item] )}
4961 * method instead of this method.
4962 *
4963 * @param {boolean} [state=false] Press option
4964 * @chainable
4965 */
4966 OO.ui.OptionWidget.prototype.setPressed = function ( state ) {
4967 if ( this.constructor.static.pressable ) {
4968 this.pressed = !!state;
4969 this.$element.toggleClass( 'oo-ui-optionWidget-pressed', state );
4970 this.updateThemeClasses();
4971 }
4972 return this;
4973 };
4974
4975 /**
4976 * A SelectWidget is of a generic selection of options. The OOjs UI library contains several types of
4977 * select widgets, including {@link OO.ui.ButtonSelectWidget button selects},
4978 * {@link OO.ui.RadioSelectWidget radio selects}, and {@link OO.ui.MenuSelectWidget
4979 * menu selects}.
4980 *
4981 * This class should be used together with OO.ui.OptionWidget or OO.ui.DecoratedOptionWidget. For more
4982 * information, please see the [OOjs UI documentation on MediaWiki][1].
4983 *
4984 * @example
4985 * // Example of a select widget with three options
4986 * var select = new OO.ui.SelectWidget( {
4987 * items: [
4988 * new OO.ui.OptionWidget( {
4989 * data: 'a',
4990 * label: 'Option One',
4991 * } ),
4992 * new OO.ui.OptionWidget( {
4993 * data: 'b',
4994 * label: 'Option Two',
4995 * } ),
4996 * new OO.ui.OptionWidget( {
4997 * data: 'c',
4998 * label: 'Option Three',
4999 * } )
5000 * ]
5001 * } );
5002 * $( 'body' ).append( select.$element );
5003 *
5004 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
5005 *
5006 * @abstract
5007 * @class
5008 * @extends OO.ui.Widget
5009 * @mixins OO.ui.mixin.GroupWidget
5010 *
5011 * @constructor
5012 * @param {Object} [config] Configuration options
5013 * @cfg {OO.ui.OptionWidget[]} [items] An array of options to add to the select.
5014 * Options are created with {@link OO.ui.OptionWidget OptionWidget} classes. See
5015 * the [OOjs UI documentation on MediaWiki] [2] for examples.
5016 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
5017 */
5018 OO.ui.SelectWidget = function OoUiSelectWidget( config ) {
5019 // Configuration initialization
5020 config = config || {};
5021
5022 // Parent constructor
5023 OO.ui.SelectWidget.parent.call( this, config );
5024
5025 // Mixin constructors
5026 OO.ui.mixin.GroupWidget.call( this, $.extend( {}, config, { $group: this.$element } ) );
5027
5028 // Properties
5029 this.pressed = false;
5030 this.selecting = null;
5031 this.onMouseUpHandler = this.onMouseUp.bind( this );
5032 this.onMouseMoveHandler = this.onMouseMove.bind( this );
5033 this.onKeyDownHandler = this.onKeyDown.bind( this );
5034 this.onKeyPressHandler = this.onKeyPress.bind( this );
5035 this.keyPressBuffer = '';
5036 this.keyPressBufferTimer = null;
5037 this.blockMouseOverEvents = 0;
5038
5039 // Events
5040 this.connect( this, {
5041 toggle: 'onToggle'
5042 } );
5043 this.$element.on( {
5044 focusin: this.onFocus.bind( this ),
5045 mousedown: this.onMouseDown.bind( this ),
5046 mouseover: this.onMouseOver.bind( this ),
5047 mouseleave: this.onMouseLeave.bind( this )
5048 } );
5049
5050 // Initialization
5051 this.$element
5052 .addClass( 'oo-ui-selectWidget oo-ui-selectWidget-depressed' )
5053 .attr( 'role', 'listbox' );
5054 if ( Array.isArray( config.items ) ) {
5055 this.addItems( config.items );
5056 }
5057 };
5058
5059 /* Setup */
5060
5061 OO.inheritClass( OO.ui.SelectWidget, OO.ui.Widget );
5062
5063 // Need to mixin base class as well
5064 OO.mixinClass( OO.ui.SelectWidget, OO.ui.mixin.GroupElement );
5065 OO.mixinClass( OO.ui.SelectWidget, OO.ui.mixin.GroupWidget );
5066
5067 /* Static */
5068 OO.ui.SelectWidget.static.passAllFilter = function () {
5069 return true;
5070 };
5071
5072 /* Events */
5073
5074 /**
5075 * @event highlight
5076 *
5077 * A `highlight` event is emitted when the highlight is changed with the #highlightItem method.
5078 *
5079 * @param {OO.ui.OptionWidget|null} item Highlighted item
5080 */
5081
5082 /**
5083 * @event press
5084 *
5085 * A `press` event is emitted when the #pressItem method is used to programmatically modify the
5086 * pressed state of an option.
5087 *
5088 * @param {OO.ui.OptionWidget|null} item Pressed item
5089 */
5090
5091 /**
5092 * @event select
5093 *
5094 * A `select` event is emitted when the selection is modified programmatically with the #selectItem method.
5095 *
5096 * @param {OO.ui.OptionWidget|null} item Selected item
5097 */
5098
5099 /**
5100 * @event choose
5101 * A `choose` event is emitted when an item is chosen with the #chooseItem method.
5102 * @param {OO.ui.OptionWidget} item Chosen item
5103 */
5104
5105 /**
5106 * @event add
5107 *
5108 * An `add` event is emitted when options are added to the select with the #addItems method.
5109 *
5110 * @param {OO.ui.OptionWidget[]} items Added items
5111 * @param {number} index Index of insertion point
5112 */
5113
5114 /**
5115 * @event remove
5116 *
5117 * A `remove` event is emitted when options are removed from the select with the #clearItems
5118 * or #removeItems methods.
5119 *
5120 * @param {OO.ui.OptionWidget[]} items Removed items
5121 */
5122
5123 /* Methods */
5124
5125 /**
5126 * Handle focus events
5127 *
5128 * @private
5129 * @param {jQuery.Event} event
5130 */
5131 OO.ui.SelectWidget.prototype.onFocus = function ( event ) {
5132 if ( event.target === this.$element[ 0 ] ) {
5133 // This widget was focussed, e.g. by the user tabbing to it.
5134 // The styles for focus state depend on one of the items being selected.
5135 if ( !this.getSelectedItem() ) {
5136 this.selectItem( this.getFirstSelectableItem() );
5137 }
5138 } else {
5139 // One of the options got focussed (and the event bubbled up here).
5140 // They can't be tabbed to, but they can be activated using accesskeys.
5141 this.selectItem( this.getTargetItem( event ) );
5142 this.$element.focus();
5143 }
5144 };
5145
5146 /**
5147 * Handle mouse down events.
5148 *
5149 * @private
5150 * @param {jQuery.Event} e Mouse down event
5151 */
5152 OO.ui.SelectWidget.prototype.onMouseDown = function ( e ) {
5153 var item;
5154
5155 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
5156 this.togglePressed( true );
5157 item = this.getTargetItem( e );
5158 if ( item && item.isSelectable() ) {
5159 this.pressItem( item );
5160 this.selecting = item;
5161 this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler, true );
5162 this.getElementDocument().addEventListener( 'mousemove', this.onMouseMoveHandler, true );
5163 }
5164 }
5165 return false;
5166 };
5167
5168 /**
5169 * Handle mouse up events.
5170 *
5171 * @private
5172 * @param {MouseEvent} e Mouse up event
5173 */
5174 OO.ui.SelectWidget.prototype.onMouseUp = function ( e ) {
5175 var item;
5176
5177 this.togglePressed( false );
5178 if ( !this.selecting ) {
5179 item = this.getTargetItem( e );
5180 if ( item && item.isSelectable() ) {
5181 this.selecting = item;
5182 }
5183 }
5184 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT && this.selecting ) {
5185 this.pressItem( null );
5186 this.chooseItem( this.selecting );
5187 this.selecting = null;
5188 }
5189
5190 this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler, true );
5191 this.getElementDocument().removeEventListener( 'mousemove', this.onMouseMoveHandler, true );
5192
5193 return false;
5194 };
5195
5196 /**
5197 * Handle mouse move events.
5198 *
5199 * @private
5200 * @param {MouseEvent} e Mouse move event
5201 */
5202 OO.ui.SelectWidget.prototype.onMouseMove = function ( e ) {
5203 var item;
5204
5205 if ( !this.isDisabled() && this.pressed ) {
5206 item = this.getTargetItem( e );
5207 if ( item && item !== this.selecting && item.isSelectable() ) {
5208 this.pressItem( item );
5209 this.selecting = item;
5210 }
5211 }
5212 };
5213
5214 /**
5215 * Handle mouse over events.
5216 *
5217 * @private
5218 * @param {jQuery.Event} e Mouse over event
5219 */
5220 OO.ui.SelectWidget.prototype.onMouseOver = function ( e ) {
5221 var item;
5222 if ( this.blockMouseOverEvents ) {
5223 return;
5224 }
5225 if ( !this.isDisabled() ) {
5226 item = this.getTargetItem( e );
5227 this.highlightItem( item && item.isHighlightable() ? item : null );
5228 }
5229 return false;
5230 };
5231
5232 /**
5233 * Handle mouse leave events.
5234 *
5235 * @private
5236 * @param {jQuery.Event} e Mouse over event
5237 */
5238 OO.ui.SelectWidget.prototype.onMouseLeave = function () {
5239 if ( !this.isDisabled() ) {
5240 this.highlightItem( null );
5241 }
5242 return false;
5243 };
5244
5245 /**
5246 * Handle key down events.
5247 *
5248 * @protected
5249 * @param {KeyboardEvent} e Key down event
5250 */
5251 OO.ui.SelectWidget.prototype.onKeyDown = function ( e ) {
5252 var nextItem,
5253 handled = false,
5254 currentItem = this.getHighlightedItem() || this.getSelectedItem();
5255
5256 if ( !this.isDisabled() && this.isVisible() ) {
5257 switch ( e.keyCode ) {
5258 case OO.ui.Keys.ENTER:
5259 if ( currentItem && currentItem.constructor.static.highlightable ) {
5260 // Was only highlighted, now let's select it. No-op if already selected.
5261 this.chooseItem( currentItem );
5262 handled = true;
5263 }
5264 break;
5265 case OO.ui.Keys.UP:
5266 case OO.ui.Keys.LEFT:
5267 this.clearKeyPressBuffer();
5268 nextItem = this.getRelativeSelectableItem( currentItem, -1 );
5269 handled = true;
5270 break;
5271 case OO.ui.Keys.DOWN:
5272 case OO.ui.Keys.RIGHT:
5273 this.clearKeyPressBuffer();
5274 nextItem = this.getRelativeSelectableItem( currentItem, 1 );
5275 handled = true;
5276 break;
5277 case OO.ui.Keys.ESCAPE:
5278 case OO.ui.Keys.TAB:
5279 if ( currentItem && currentItem.constructor.static.highlightable ) {
5280 currentItem.setHighlighted( false );
5281 }
5282 this.unbindKeyDownListener();
5283 this.unbindKeyPressListener();
5284 // Don't prevent tabbing away / defocusing
5285 handled = false;
5286 break;
5287 }
5288
5289 if ( nextItem ) {
5290 if ( nextItem.constructor.static.highlightable ) {
5291 this.highlightItem( nextItem );
5292 } else {
5293 this.chooseItem( nextItem );
5294 }
5295 this.scrollItemIntoView( nextItem );
5296 }
5297
5298 if ( handled ) {
5299 e.preventDefault();
5300 e.stopPropagation();
5301 }
5302 }
5303 };
5304
5305 /**
5306 * Bind key down listener.
5307 *
5308 * @protected
5309 */
5310 OO.ui.SelectWidget.prototype.bindKeyDownListener = function () {
5311 this.getElementWindow().addEventListener( 'keydown', this.onKeyDownHandler, true );
5312 };
5313
5314 /**
5315 * Unbind key down listener.
5316 *
5317 * @protected
5318 */
5319 OO.ui.SelectWidget.prototype.unbindKeyDownListener = function () {
5320 this.getElementWindow().removeEventListener( 'keydown', this.onKeyDownHandler, true );
5321 };
5322
5323 /**
5324 * Scroll item into view, preventing spurious mouse highlight actions from happening.
5325 *
5326 * @param {OO.ui.OptionWidget} item Item to scroll into view
5327 */
5328 OO.ui.SelectWidget.prototype.scrollItemIntoView = function ( item ) {
5329 var widget = this;
5330 // Chromium's Blink engine will generate spurious 'mouseover' events during programmatic scrolling
5331 // and around 100-150 ms after it is finished.
5332 this.blockMouseOverEvents++;
5333 item.scrollElementIntoView().done( function () {
5334 setTimeout( function () {
5335 widget.blockMouseOverEvents--;
5336 }, 200 );
5337 } );
5338 };
5339
5340 /**
5341 * Clear the key-press buffer
5342 *
5343 * @protected
5344 */
5345 OO.ui.SelectWidget.prototype.clearKeyPressBuffer = function () {
5346 if ( this.keyPressBufferTimer ) {
5347 clearTimeout( this.keyPressBufferTimer );
5348 this.keyPressBufferTimer = null;
5349 }
5350 this.keyPressBuffer = '';
5351 };
5352
5353 /**
5354 * Handle key press events.
5355 *
5356 * @protected
5357 * @param {KeyboardEvent} e Key press event
5358 */
5359 OO.ui.SelectWidget.prototype.onKeyPress = function ( e ) {
5360 var c, filter, item;
5361
5362 if ( !e.charCode ) {
5363 if ( e.keyCode === OO.ui.Keys.BACKSPACE && this.keyPressBuffer !== '' ) {
5364 this.keyPressBuffer = this.keyPressBuffer.substr( 0, this.keyPressBuffer.length - 1 );
5365 return false;
5366 }
5367 return;
5368 }
5369 if ( String.fromCodePoint ) {
5370 c = String.fromCodePoint( e.charCode );
5371 } else {
5372 c = String.fromCharCode( e.charCode );
5373 }
5374
5375 if ( this.keyPressBufferTimer ) {
5376 clearTimeout( this.keyPressBufferTimer );
5377 }
5378 this.keyPressBufferTimer = setTimeout( this.clearKeyPressBuffer.bind( this ), 1500 );
5379
5380 item = this.getHighlightedItem() || this.getSelectedItem();
5381
5382 if ( this.keyPressBuffer === c ) {
5383 // Common (if weird) special case: typing "xxxx" will cycle through all
5384 // the items beginning with "x".
5385 if ( item ) {
5386 item = this.getRelativeSelectableItem( item, 1 );
5387 }
5388 } else {
5389 this.keyPressBuffer += c;
5390 }
5391
5392 filter = this.getItemMatcher( this.keyPressBuffer, false );
5393 if ( !item || !filter( item ) ) {
5394 item = this.getRelativeSelectableItem( item, 1, filter );
5395 }
5396 if ( item ) {
5397 if ( item.constructor.static.highlightable ) {
5398 this.highlightItem( item );
5399 } else {
5400 this.chooseItem( item );
5401 }
5402 this.scrollItemIntoView( item );
5403 }
5404
5405 e.preventDefault();
5406 e.stopPropagation();
5407 };
5408
5409 /**
5410 * Get a matcher for the specific string
5411 *
5412 * @protected
5413 * @param {string} s String to match against items
5414 * @param {boolean} [exact=false] Only accept exact matches
5415 * @return {Function} function ( OO.ui.OptionItem ) => boolean
5416 */
5417 OO.ui.SelectWidget.prototype.getItemMatcher = function ( s, exact ) {
5418 var re;
5419
5420 if ( s.normalize ) {
5421 s = s.normalize();
5422 }
5423 s = exact ? s.trim() : s.replace( /^\s+/, '' );
5424 re = '^\\s*' + s.replace( /([\\{}()|.?*+\-\^$\[\]])/g, '\\$1' ).replace( /\s+/g, '\\s+' );
5425 if ( exact ) {
5426 re += '\\s*$';
5427 }
5428 re = new RegExp( re, 'i' );
5429 return function ( item ) {
5430 var l = item.getLabel();
5431 if ( typeof l !== 'string' ) {
5432 l = item.$label.text();
5433 }
5434 if ( l.normalize ) {
5435 l = l.normalize();
5436 }
5437 return re.test( l );
5438 };
5439 };
5440
5441 /**
5442 * Bind key press listener.
5443 *
5444 * @protected
5445 */
5446 OO.ui.SelectWidget.prototype.bindKeyPressListener = function () {
5447 this.getElementWindow().addEventListener( 'keypress', this.onKeyPressHandler, true );
5448 };
5449
5450 /**
5451 * Unbind key down listener.
5452 *
5453 * If you override this, be sure to call this.clearKeyPressBuffer() from your
5454 * implementation.
5455 *
5456 * @protected
5457 */
5458 OO.ui.SelectWidget.prototype.unbindKeyPressListener = function () {
5459 this.getElementWindow().removeEventListener( 'keypress', this.onKeyPressHandler, true );
5460 this.clearKeyPressBuffer();
5461 };
5462
5463 /**
5464 * Visibility change handler
5465 *
5466 * @protected
5467 * @param {boolean} visible
5468 */
5469 OO.ui.SelectWidget.prototype.onToggle = function ( visible ) {
5470 if ( !visible ) {
5471 this.clearKeyPressBuffer();
5472 }
5473 };
5474
5475 /**
5476 * Get the closest item to a jQuery.Event.
5477 *
5478 * @private
5479 * @param {jQuery.Event} e
5480 * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
5481 */
5482 OO.ui.SelectWidget.prototype.getTargetItem = function ( e ) {
5483 return $( e.target ).closest( '.oo-ui-optionWidget' ).data( 'oo-ui-optionWidget' ) || null;
5484 };
5485
5486 /**
5487 * Get selected item.
5488 *
5489 * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
5490 */
5491 OO.ui.SelectWidget.prototype.getSelectedItem = function () {
5492 var i, len;
5493
5494 for ( i = 0, len = this.items.length; i < len; i++ ) {
5495 if ( this.items[ i ].isSelected() ) {
5496 return this.items[ i ];
5497 }
5498 }
5499 return null;
5500 };
5501
5502 /**
5503 * Get highlighted item.
5504 *
5505 * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
5506 */
5507 OO.ui.SelectWidget.prototype.getHighlightedItem = function () {
5508 var i, len;
5509
5510 for ( i = 0, len = this.items.length; i < len; i++ ) {
5511 if ( this.items[ i ].isHighlighted() ) {
5512 return this.items[ i ];
5513 }
5514 }
5515 return null;
5516 };
5517
5518 /**
5519 * Toggle pressed state.
5520 *
5521 * Press is a state that occurs when a user mouses down on an item, but
5522 * has not yet let go of the mouse. The item may appear selected, but it will not be selected
5523 * until the user releases the mouse.
5524 *
5525 * @param {boolean} pressed An option is being pressed
5526 */
5527 OO.ui.SelectWidget.prototype.togglePressed = function ( pressed ) {
5528 if ( pressed === undefined ) {
5529 pressed = !this.pressed;
5530 }
5531 if ( pressed !== this.pressed ) {
5532 this.$element
5533 .toggleClass( 'oo-ui-selectWidget-pressed', pressed )
5534 .toggleClass( 'oo-ui-selectWidget-depressed', !pressed );
5535 this.pressed = pressed;
5536 }
5537 };
5538
5539 /**
5540 * Highlight an option. If the `item` param is omitted, no options will be highlighted
5541 * and any existing highlight will be removed. The highlight is mutually exclusive.
5542 *
5543 * @param {OO.ui.OptionWidget} [item] Item to highlight, omit for no highlight
5544 * @fires highlight
5545 * @chainable
5546 */
5547 OO.ui.SelectWidget.prototype.highlightItem = function ( item ) {
5548 var i, len, highlighted,
5549 changed = false;
5550
5551 for ( i = 0, len = this.items.length; i < len; i++ ) {
5552 highlighted = this.items[ i ] === item;
5553 if ( this.items[ i ].isHighlighted() !== highlighted ) {
5554 this.items[ i ].setHighlighted( highlighted );
5555 changed = true;
5556 }
5557 }
5558 if ( changed ) {
5559 this.emit( 'highlight', item );
5560 }
5561
5562 return this;
5563 };
5564
5565 /**
5566 * Fetch an item by its label.
5567 *
5568 * @param {string} label Label of the item to select.
5569 * @param {boolean} [prefix=false] Allow a prefix match, if only a single item matches
5570 * @return {OO.ui.Element|null} Item with equivalent label, `null` if none exists
5571 */
5572 OO.ui.SelectWidget.prototype.getItemFromLabel = function ( label, prefix ) {
5573 var i, item, found,
5574 len = this.items.length,
5575 filter = this.getItemMatcher( label, true );
5576
5577 for ( i = 0; i < len; i++ ) {
5578 item = this.items[ i ];
5579 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() && filter( item ) ) {
5580 return item;
5581 }
5582 }
5583
5584 if ( prefix ) {
5585 found = null;
5586 filter = this.getItemMatcher( label, false );
5587 for ( i = 0; i < len; i++ ) {
5588 item = this.items[ i ];
5589 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() && filter( item ) ) {
5590 if ( found ) {
5591 return null;
5592 }
5593 found = item;
5594 }
5595 }
5596 if ( found ) {
5597 return found;
5598 }
5599 }
5600
5601 return null;
5602 };
5603
5604 /**
5605 * Programmatically select an option by its label. If the item does not exist,
5606 * all options will be deselected.
5607 *
5608 * @param {string} [label] Label of the item to select.
5609 * @param {boolean} [prefix=false] Allow a prefix match, if only a single item matches
5610 * @fires select
5611 * @chainable
5612 */
5613 OO.ui.SelectWidget.prototype.selectItemByLabel = function ( label, prefix ) {
5614 var itemFromLabel = this.getItemFromLabel( label, !!prefix );
5615 if ( label === undefined || !itemFromLabel ) {
5616 return this.selectItem();
5617 }
5618 return this.selectItem( itemFromLabel );
5619 };
5620
5621 /**
5622 * Programmatically select an option by its data. If the `data` parameter is omitted,
5623 * or if the item does not exist, all options will be deselected.
5624 *
5625 * @param {Object|string} [data] Value of the item to select, omit to deselect all
5626 * @fires select
5627 * @chainable
5628 */
5629 OO.ui.SelectWidget.prototype.selectItemByData = function ( data ) {
5630 var itemFromData = this.getItemFromData( data );
5631 if ( data === undefined || !itemFromData ) {
5632 return this.selectItem();
5633 }
5634 return this.selectItem( itemFromData );
5635 };
5636
5637 /**
5638 * Programmatically select an option by its reference. If the `item` parameter is omitted,
5639 * all options will be deselected.
5640 *
5641 * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
5642 * @fires select
5643 * @chainable
5644 */
5645 OO.ui.SelectWidget.prototype.selectItem = function ( item ) {
5646 var i, len, selected,
5647 changed = false;
5648
5649 for ( i = 0, len = this.items.length; i < len; i++ ) {
5650 selected = this.items[ i ] === item;
5651 if ( this.items[ i ].isSelected() !== selected ) {
5652 this.items[ i ].setSelected( selected );
5653 changed = true;
5654 }
5655 }
5656 if ( changed ) {
5657 this.emit( 'select', item );
5658 }
5659
5660 return this;
5661 };
5662
5663 /**
5664 * Press an item.
5665 *
5666 * Press is a state that occurs when a user mouses down on an item, but has not
5667 * yet let go of the mouse. The item may appear selected, but it will not be selected until the user
5668 * releases the mouse.
5669 *
5670 * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
5671 * @fires press
5672 * @chainable
5673 */
5674 OO.ui.SelectWidget.prototype.pressItem = function ( item ) {
5675 var i, len, pressed,
5676 changed = false;
5677
5678 for ( i = 0, len = this.items.length; i < len; i++ ) {
5679 pressed = this.items[ i ] === item;
5680 if ( this.items[ i ].isPressed() !== pressed ) {
5681 this.items[ i ].setPressed( pressed );
5682 changed = true;
5683 }
5684 }
5685 if ( changed ) {
5686 this.emit( 'press', item );
5687 }
5688
5689 return this;
5690 };
5691
5692 /**
5693 * Choose an item.
5694 *
5695 * Note that ‘choose’ should never be modified programmatically. A user can choose
5696 * an option with the keyboard or mouse and it becomes selected. To select an item programmatically,
5697 * use the #selectItem method.
5698 *
5699 * This method is identical to #selectItem, but may vary in subclasses that take additional action
5700 * when users choose an item with the keyboard or mouse.
5701 *
5702 * @param {OO.ui.OptionWidget} item Item to choose
5703 * @fires choose
5704 * @chainable
5705 */
5706 OO.ui.SelectWidget.prototype.chooseItem = function ( item ) {
5707 if ( item ) {
5708 this.selectItem( item );
5709 this.emit( 'choose', item );
5710 }
5711
5712 return this;
5713 };
5714
5715 /**
5716 * Get an option by its position relative to the specified item (or to the start of the option array,
5717 * if item is `null`). The direction in which to search through the option array is specified with a
5718 * number: -1 for reverse (the default) or 1 for forward. The method will return an option, or
5719 * `null` if there are no options in the array.
5720 *
5721 * @param {OO.ui.OptionWidget|null} item Item to describe the start position, or `null` to start at the beginning of the array.
5722 * @param {number} direction Direction to move in: -1 to move backward, 1 to move forward
5723 * @param {Function} filter Only consider items for which this function returns
5724 * true. Function takes an OO.ui.OptionWidget and returns a boolean.
5725 * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the select
5726 */
5727 OO.ui.SelectWidget.prototype.getRelativeSelectableItem = function ( item, direction, filter ) {
5728 var currentIndex, nextIndex, i,
5729 increase = direction > 0 ? 1 : -1,
5730 len = this.items.length;
5731
5732 if ( !$.isFunction( filter ) ) {
5733 filter = OO.ui.SelectWidget.static.passAllFilter;
5734 }
5735
5736 if ( item instanceof OO.ui.OptionWidget ) {
5737 currentIndex = this.items.indexOf( item );
5738 nextIndex = ( currentIndex + increase + len ) % len;
5739 } else {
5740 // If no item is selected and moving forward, start at the beginning.
5741 // If moving backward, start at the end.
5742 nextIndex = direction > 0 ? 0 : len - 1;
5743 }
5744
5745 for ( i = 0; i < len; i++ ) {
5746 item = this.items[ nextIndex ];
5747 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() && filter( item ) ) {
5748 return item;
5749 }
5750 nextIndex = ( nextIndex + increase + len ) % len;
5751 }
5752 return null;
5753 };
5754
5755 /**
5756 * Get the next selectable item or `null` if there are no selectable items.
5757 * Disabled options and menu-section markers and breaks are not selectable.
5758 *
5759 * @return {OO.ui.OptionWidget|null} Item, `null` if there aren't any selectable items
5760 */
5761 OO.ui.SelectWidget.prototype.getFirstSelectableItem = function () {
5762 var i, len, item;
5763
5764 for ( i = 0, len = this.items.length; i < len; i++ ) {
5765 item = this.items[ i ];
5766 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() ) {
5767 return item;
5768 }
5769 }
5770
5771 return null;
5772 };
5773
5774 /**
5775 * Add an array of options to the select. Optionally, an index number can be used to
5776 * specify an insertion point.
5777 *
5778 * @param {OO.ui.OptionWidget[]} items Items to add
5779 * @param {number} [index] Index to insert items after
5780 * @fires add
5781 * @chainable
5782 */
5783 OO.ui.SelectWidget.prototype.addItems = function ( items, index ) {
5784 // Mixin method
5785 OO.ui.mixin.GroupWidget.prototype.addItems.call( this, items, index );
5786
5787 // Always provide an index, even if it was omitted
5788 this.emit( 'add', items, index === undefined ? this.items.length - items.length - 1 : index );
5789
5790 return this;
5791 };
5792
5793 /**
5794 * Remove the specified array of options from the select. Options will be detached
5795 * from the DOM, not removed, so they can be reused later. To remove all options from
5796 * the select, you may wish to use the #clearItems method instead.
5797 *
5798 * @param {OO.ui.OptionWidget[]} items Items to remove
5799 * @fires remove
5800 * @chainable
5801 */
5802 OO.ui.SelectWidget.prototype.removeItems = function ( items ) {
5803 var i, len, item;
5804
5805 // Deselect items being removed
5806 for ( i = 0, len = items.length; i < len; i++ ) {
5807 item = items[ i ];
5808 if ( item.isSelected() ) {
5809 this.selectItem( null );
5810 }
5811 }
5812
5813 // Mixin method
5814 OO.ui.mixin.GroupWidget.prototype.removeItems.call( this, items );
5815
5816 this.emit( 'remove', items );
5817
5818 return this;
5819 };
5820
5821 /**
5822 * Clear all options from the select. Options will be detached from the DOM, not removed,
5823 * so that they can be reused later. To remove a subset of options from the select, use
5824 * the #removeItems method.
5825 *
5826 * @fires remove
5827 * @chainable
5828 */
5829 OO.ui.SelectWidget.prototype.clearItems = function () {
5830 var items = this.items.slice();
5831
5832 // Mixin method
5833 OO.ui.mixin.GroupWidget.prototype.clearItems.call( this );
5834
5835 // Clear selection
5836 this.selectItem( null );
5837
5838 this.emit( 'remove', items );
5839
5840 return this;
5841 };
5842
5843 /**
5844 * DecoratedOptionWidgets are {@link OO.ui.OptionWidget options} that can be configured
5845 * with an {@link OO.ui.mixin.IconElement icon} and/or {@link OO.ui.mixin.IndicatorElement indicator}.
5846 * This class is used with OO.ui.SelectWidget to create a selection of mutually exclusive
5847 * options. For more information about options and selects, please see the
5848 * [OOjs UI documentation on MediaWiki][1].
5849 *
5850 * @example
5851 * // Decorated options in a select widget
5852 * var select = new OO.ui.SelectWidget( {
5853 * items: [
5854 * new OO.ui.DecoratedOptionWidget( {
5855 * data: 'a',
5856 * label: 'Option with icon',
5857 * icon: 'help'
5858 * } ),
5859 * new OO.ui.DecoratedOptionWidget( {
5860 * data: 'b',
5861 * label: 'Option with indicator',
5862 * indicator: 'next'
5863 * } )
5864 * ]
5865 * } );
5866 * $( 'body' ).append( select.$element );
5867 *
5868 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
5869 *
5870 * @class
5871 * @extends OO.ui.OptionWidget
5872 * @mixins OO.ui.mixin.IconElement
5873 * @mixins OO.ui.mixin.IndicatorElement
5874 *
5875 * @constructor
5876 * @param {Object} [config] Configuration options
5877 */
5878 OO.ui.DecoratedOptionWidget = function OoUiDecoratedOptionWidget( config ) {
5879 // Parent constructor
5880 OO.ui.DecoratedOptionWidget.parent.call( this, config );
5881
5882 // Mixin constructors
5883 OO.ui.mixin.IconElement.call( this, config );
5884 OO.ui.mixin.IndicatorElement.call( this, config );
5885
5886 // Initialization
5887 this.$element
5888 .addClass( 'oo-ui-decoratedOptionWidget' )
5889 .prepend( this.$icon )
5890 .append( this.$indicator );
5891 };
5892
5893 /* Setup */
5894
5895 OO.inheritClass( OO.ui.DecoratedOptionWidget, OO.ui.OptionWidget );
5896 OO.mixinClass( OO.ui.DecoratedOptionWidget, OO.ui.mixin.IconElement );
5897 OO.mixinClass( OO.ui.DecoratedOptionWidget, OO.ui.mixin.IndicatorElement );
5898
5899 /**
5900 * MenuOptionWidget is an option widget that looks like a menu item. The class is used with
5901 * OO.ui.MenuSelectWidget to create a menu of mutually exclusive options. Please see
5902 * the [OOjs UI documentation on MediaWiki] [1] for more information.
5903 *
5904 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
5905 *
5906 * @class
5907 * @extends OO.ui.DecoratedOptionWidget
5908 *
5909 * @constructor
5910 * @param {Object} [config] Configuration options
5911 */
5912 OO.ui.MenuOptionWidget = function OoUiMenuOptionWidget( config ) {
5913 // Configuration initialization
5914 config = $.extend( { icon: 'check' }, config );
5915
5916 // Parent constructor
5917 OO.ui.MenuOptionWidget.parent.call( this, config );
5918
5919 // Initialization
5920 this.$element
5921 .attr( 'role', 'menuitem' )
5922 .addClass( 'oo-ui-menuOptionWidget' );
5923 };
5924
5925 /* Setup */
5926
5927 OO.inheritClass( OO.ui.MenuOptionWidget, OO.ui.DecoratedOptionWidget );
5928
5929 /* Static Properties */
5930
5931 OO.ui.MenuOptionWidget.static.scrollIntoViewOnSelect = true;
5932
5933 /**
5934 * MenuSectionOptionWidgets are used inside {@link OO.ui.MenuSelectWidget menu select widgets} to group one or more related
5935 * {@link OO.ui.MenuOptionWidget menu options}. MenuSectionOptionWidgets cannot be highlighted or selected.
5936 *
5937 * @example
5938 * var myDropdown = new OO.ui.DropdownWidget( {
5939 * menu: {
5940 * items: [
5941 * new OO.ui.MenuSectionOptionWidget( {
5942 * label: 'Dogs'
5943 * } ),
5944 * new OO.ui.MenuOptionWidget( {
5945 * data: 'corgi',
5946 * label: 'Welsh Corgi'
5947 * } ),
5948 * new OO.ui.MenuOptionWidget( {
5949 * data: 'poodle',
5950 * label: 'Standard Poodle'
5951 * } ),
5952 * new OO.ui.MenuSectionOptionWidget( {
5953 * label: 'Cats'
5954 * } ),
5955 * new OO.ui.MenuOptionWidget( {
5956 * data: 'lion',
5957 * label: 'Lion'
5958 * } )
5959 * ]
5960 * }
5961 * } );
5962 * $( 'body' ).append( myDropdown.$element );
5963 *
5964 * @class
5965 * @extends OO.ui.DecoratedOptionWidget
5966 *
5967 * @constructor
5968 * @param {Object} [config] Configuration options
5969 */
5970 OO.ui.MenuSectionOptionWidget = function OoUiMenuSectionOptionWidget( config ) {
5971 // Parent constructor
5972 OO.ui.MenuSectionOptionWidget.parent.call( this, config );
5973
5974 // Initialization
5975 this.$element.addClass( 'oo-ui-menuSectionOptionWidget' );
5976 };
5977
5978 /* Setup */
5979
5980 OO.inheritClass( OO.ui.MenuSectionOptionWidget, OO.ui.DecoratedOptionWidget );
5981
5982 /* Static Properties */
5983
5984 OO.ui.MenuSectionOptionWidget.static.selectable = false;
5985
5986 OO.ui.MenuSectionOptionWidget.static.highlightable = false;
5987
5988 /**
5989 * MenuSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains options and
5990 * is used together with OO.ui.MenuOptionWidget. It is designed be used as part of another widget.
5991 * See {@link OO.ui.DropdownWidget DropdownWidget}, {@link OO.ui.ComboBoxInputWidget ComboBoxInputWidget},
5992 * and {@link OO.ui.mixin.LookupElement LookupElement} for examples of widgets that contain menus.
5993 * MenuSelectWidgets themselves are not instantiated directly, rather subclassed
5994 * and customized to be opened, closed, and displayed as needed.
5995 *
5996 * By default, menus are clipped to the visible viewport and are not visible when a user presses the
5997 * mouse outside the menu.
5998 *
5999 * Menus also have support for keyboard interaction:
6000 *
6001 * - Enter/Return key: choose and select a menu option
6002 * - Up-arrow key: highlight the previous menu option
6003 * - Down-arrow key: highlight the next menu option
6004 * - Esc key: hide the menu
6005 *
6006 * Please see the [OOjs UI documentation on MediaWiki][1] for more information.
6007 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
6008 *
6009 * @class
6010 * @extends OO.ui.SelectWidget
6011 * @mixins OO.ui.mixin.ClippableElement
6012 *
6013 * @constructor
6014 * @param {Object} [config] Configuration options
6015 * @cfg {OO.ui.TextInputWidget} [input] Text input used to implement option highlighting for menu items that match
6016 * the text the user types. This config is used by {@link OO.ui.ComboBoxInputWidget ComboBoxInputWidget}
6017 * and {@link OO.ui.mixin.LookupElement LookupElement}
6018 * @cfg {jQuery} [$input] Text input used to implement option highlighting for menu items that match
6019 * the text the user types. This config is used by {@link OO.ui.CapsuleMultiselectWidget CapsuleMultiselectWidget}
6020 * @cfg {OO.ui.Widget} [widget] Widget associated with the menu's active state. If the user clicks the mouse
6021 * anywhere on the page outside of this widget, the menu is hidden. For example, if there is a button
6022 * that toggles the menu's visibility on click, the menu will be hidden then re-shown when the user clicks
6023 * that button, unless the button (or its parent widget) is passed in here.
6024 * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu.
6025 * @cfg {boolean} [filterFromInput=false] Filter the displayed options from the input
6026 */
6027 OO.ui.MenuSelectWidget = function OoUiMenuSelectWidget( config ) {
6028 // Configuration initialization
6029 config = config || {};
6030
6031 // Parent constructor
6032 OO.ui.MenuSelectWidget.parent.call( this, config );
6033
6034 // Mixin constructors
6035 OO.ui.mixin.ClippableElement.call( this, $.extend( {}, config, { $clippable: this.$group } ) );
6036
6037 // Properties
6038 this.autoHide = config.autoHide === undefined || !!config.autoHide;
6039 this.filterFromInput = !!config.filterFromInput;
6040 this.$input = config.$input ? config.$input : config.input ? config.input.$input : null;
6041 this.$widget = config.widget ? config.widget.$element : null;
6042 this.onDocumentMouseDownHandler = this.onDocumentMouseDown.bind( this );
6043 this.onInputEditHandler = OO.ui.debounce( this.updateItemVisibility.bind( this ), 100 );
6044
6045 // Initialization
6046 this.$element
6047 .addClass( 'oo-ui-menuSelectWidget' )
6048 .attr( 'role', 'menu' );
6049
6050 // Initially hidden - using #toggle may cause errors if subclasses override toggle with methods
6051 // that reference properties not initialized at that time of parent class construction
6052 // TODO: Find a better way to handle post-constructor setup
6053 this.visible = false;
6054 this.$element.addClass( 'oo-ui-element-hidden' );
6055 };
6056
6057 /* Setup */
6058
6059 OO.inheritClass( OO.ui.MenuSelectWidget, OO.ui.SelectWidget );
6060 OO.mixinClass( OO.ui.MenuSelectWidget, OO.ui.mixin.ClippableElement );
6061
6062 /* Methods */
6063
6064 /**
6065 * Handles document mouse down events.
6066 *
6067 * @protected
6068 * @param {MouseEvent} e Mouse down event
6069 */
6070 OO.ui.MenuSelectWidget.prototype.onDocumentMouseDown = function ( e ) {
6071 if (
6072 !OO.ui.contains( this.$element[ 0 ], e.target, true ) &&
6073 ( !this.$widget || !OO.ui.contains( this.$widget[ 0 ], e.target, true ) )
6074 ) {
6075 this.toggle( false );
6076 }
6077 };
6078
6079 /**
6080 * @inheritdoc
6081 */
6082 OO.ui.MenuSelectWidget.prototype.onKeyDown = function ( e ) {
6083 var currentItem = this.getHighlightedItem() || this.getSelectedItem();
6084
6085 if ( !this.isDisabled() && this.isVisible() ) {
6086 switch ( e.keyCode ) {
6087 case OO.ui.Keys.LEFT:
6088 case OO.ui.Keys.RIGHT:
6089 // Do nothing if a text field is associated, arrow keys will be handled natively
6090 if ( !this.$input ) {
6091 OO.ui.MenuSelectWidget.parent.prototype.onKeyDown.call( this, e );
6092 }
6093 break;
6094 case OO.ui.Keys.ESCAPE:
6095 case OO.ui.Keys.TAB:
6096 if ( currentItem ) {
6097 currentItem.setHighlighted( false );
6098 }
6099 this.toggle( false );
6100 // Don't prevent tabbing away, prevent defocusing
6101 if ( e.keyCode === OO.ui.Keys.ESCAPE ) {
6102 e.preventDefault();
6103 e.stopPropagation();
6104 }
6105 break;
6106 default:
6107 OO.ui.MenuSelectWidget.parent.prototype.onKeyDown.call( this, e );
6108 return;
6109 }
6110 }
6111 };
6112
6113 /**
6114 * Update menu item visibility after input changes.
6115 *
6116 * @protected
6117 */
6118 OO.ui.MenuSelectWidget.prototype.updateItemVisibility = function () {
6119 var i, item,
6120 len = this.items.length,
6121 showAll = !this.isVisible(),
6122 filter = showAll ? null : this.getItemMatcher( this.$input.val() );
6123
6124 for ( i = 0; i < len; i++ ) {
6125 item = this.items[ i ];
6126 if ( item instanceof OO.ui.OptionWidget ) {
6127 item.toggle( showAll || filter( item ) );
6128 }
6129 }
6130
6131 // Reevaluate clipping
6132 this.clip();
6133 };
6134
6135 /**
6136 * @inheritdoc
6137 */
6138 OO.ui.MenuSelectWidget.prototype.bindKeyDownListener = function () {
6139 if ( this.$input ) {
6140 this.$input.on( 'keydown', this.onKeyDownHandler );
6141 } else {
6142 OO.ui.MenuSelectWidget.parent.prototype.bindKeyDownListener.call( this );
6143 }
6144 };
6145
6146 /**
6147 * @inheritdoc
6148 */
6149 OO.ui.MenuSelectWidget.prototype.unbindKeyDownListener = function () {
6150 if ( this.$input ) {
6151 this.$input.off( 'keydown', this.onKeyDownHandler );
6152 } else {
6153 OO.ui.MenuSelectWidget.parent.prototype.unbindKeyDownListener.call( this );
6154 }
6155 };
6156
6157 /**
6158 * @inheritdoc
6159 */
6160 OO.ui.MenuSelectWidget.prototype.bindKeyPressListener = function () {
6161 if ( this.$input ) {
6162 if ( this.filterFromInput ) {
6163 this.$input.on( 'keydown mouseup cut paste change input select', this.onInputEditHandler );
6164 }
6165 } else {
6166 OO.ui.MenuSelectWidget.parent.prototype.bindKeyPressListener.call( this );
6167 }
6168 };
6169
6170 /**
6171 * @inheritdoc
6172 */
6173 OO.ui.MenuSelectWidget.prototype.unbindKeyPressListener = function () {
6174 if ( this.$input ) {
6175 if ( this.filterFromInput ) {
6176 this.$input.off( 'keydown mouseup cut paste change input select', this.onInputEditHandler );
6177 this.updateItemVisibility();
6178 }
6179 } else {
6180 OO.ui.MenuSelectWidget.parent.prototype.unbindKeyPressListener.call( this );
6181 }
6182 };
6183
6184 /**
6185 * Choose an item.
6186 *
6187 * When a user chooses an item, the menu is closed.
6188 *
6189 * Note that ‘choose’ should never be modified programmatically. A user can choose an option with the keyboard
6190 * or mouse and it becomes selected. To select an item programmatically, use the #selectItem method.
6191 *
6192 * @param {OO.ui.OptionWidget} item Item to choose
6193 * @chainable
6194 */
6195 OO.ui.MenuSelectWidget.prototype.chooseItem = function ( item ) {
6196 OO.ui.MenuSelectWidget.parent.prototype.chooseItem.call( this, item );
6197 this.toggle( false );
6198 return this;
6199 };
6200
6201 /**
6202 * @inheritdoc
6203 */
6204 OO.ui.MenuSelectWidget.prototype.addItems = function ( items, index ) {
6205 // Parent method
6206 OO.ui.MenuSelectWidget.parent.prototype.addItems.call( this, items, index );
6207
6208 // Reevaluate clipping
6209 this.clip();
6210
6211 return this;
6212 };
6213
6214 /**
6215 * @inheritdoc
6216 */
6217 OO.ui.MenuSelectWidget.prototype.removeItems = function ( items ) {
6218 // Parent method
6219 OO.ui.MenuSelectWidget.parent.prototype.removeItems.call( this, items );
6220
6221 // Reevaluate clipping
6222 this.clip();
6223
6224 return this;
6225 };
6226
6227 /**
6228 * @inheritdoc
6229 */
6230 OO.ui.MenuSelectWidget.prototype.clearItems = function () {
6231 // Parent method
6232 OO.ui.MenuSelectWidget.parent.prototype.clearItems.call( this );
6233
6234 // Reevaluate clipping
6235 this.clip();
6236
6237 return this;
6238 };
6239
6240 /**
6241 * @inheritdoc
6242 */
6243 OO.ui.MenuSelectWidget.prototype.toggle = function ( visible ) {
6244 var change;
6245
6246 visible = ( visible === undefined ? !this.visible : !!visible ) && !!this.items.length;
6247 change = visible !== this.isVisible();
6248
6249 // Parent method
6250 OO.ui.MenuSelectWidget.parent.prototype.toggle.call( this, visible );
6251
6252 if ( change ) {
6253 if ( visible ) {
6254 this.bindKeyDownListener();
6255 this.bindKeyPressListener();
6256
6257 this.toggleClipping( true );
6258
6259 if ( this.getSelectedItem() ) {
6260 this.getSelectedItem().scrollElementIntoView( { duration: 0 } );
6261 }
6262
6263 // Auto-hide
6264 if ( this.autoHide ) {
6265 this.getElementDocument().addEventListener( 'mousedown', this.onDocumentMouseDownHandler, true );
6266 }
6267 } else {
6268 this.unbindKeyDownListener();
6269 this.unbindKeyPressListener();
6270 this.getElementDocument().removeEventListener( 'mousedown', this.onDocumentMouseDownHandler, true );
6271 this.toggleClipping( false );
6272 }
6273 }
6274
6275 return this;
6276 };
6277
6278 /**
6279 * DropdownWidgets are not menus themselves, rather they contain a menu of options created with
6280 * OO.ui.MenuOptionWidget. The DropdownWidget takes care of opening and displaying the menu so that
6281 * users can interact with it.
6282 *
6283 * If you want to use this within a HTML form, such as a OO.ui.FormLayout, use
6284 * OO.ui.DropdownInputWidget instead.
6285 *
6286 * @example
6287 * // Example: A DropdownWidget with a menu that contains three options
6288 * var dropDown = new OO.ui.DropdownWidget( {
6289 * label: 'Dropdown menu: Select a menu option',
6290 * menu: {
6291 * items: [
6292 * new OO.ui.MenuOptionWidget( {
6293 * data: 'a',
6294 * label: 'First'
6295 * } ),
6296 * new OO.ui.MenuOptionWidget( {
6297 * data: 'b',
6298 * label: 'Second'
6299 * } ),
6300 * new OO.ui.MenuOptionWidget( {
6301 * data: 'c',
6302 * label: 'Third'
6303 * } )
6304 * ]
6305 * }
6306 * } );
6307 *
6308 * $( 'body' ).append( dropDown.$element );
6309 *
6310 * dropDown.getMenu().selectItemByData( 'b' );
6311 *
6312 * dropDown.getMenu().getSelectedItem().getData(); // returns 'b'
6313 *
6314 * For more information, please see the [OOjs UI documentation on MediaWiki] [1].
6315 *
6316 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
6317 *
6318 * @class
6319 * @extends OO.ui.Widget
6320 * @mixins OO.ui.mixin.IconElement
6321 * @mixins OO.ui.mixin.IndicatorElement
6322 * @mixins OO.ui.mixin.LabelElement
6323 * @mixins OO.ui.mixin.TitledElement
6324 * @mixins OO.ui.mixin.TabIndexedElement
6325 *
6326 * @constructor
6327 * @param {Object} [config] Configuration options
6328 * @cfg {Object} [menu] Configuration options to pass to {@link OO.ui.FloatingMenuSelectWidget menu select widget}
6329 * @cfg {jQuery} [$overlay] Render the menu into a separate layer. This configuration is useful in cases where
6330 * the expanded menu is larger than its containing `<div>`. The specified overlay layer is usually on top of the
6331 * containing `<div>` and has a larger area. By default, the menu uses relative positioning.
6332 */
6333 OO.ui.DropdownWidget = function OoUiDropdownWidget( config ) {
6334 // Configuration initialization
6335 config = $.extend( { indicator: 'down' }, config );
6336
6337 // Parent constructor
6338 OO.ui.DropdownWidget.parent.call( this, config );
6339
6340 // Properties (must be set before TabIndexedElement constructor call)
6341 this.$handle = this.$( '<span>' );
6342 this.$overlay = config.$overlay || this.$element;
6343
6344 // Mixin constructors
6345 OO.ui.mixin.IconElement.call( this, config );
6346 OO.ui.mixin.IndicatorElement.call( this, config );
6347 OO.ui.mixin.LabelElement.call( this, config );
6348 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$label } ) );
6349 OO.ui.mixin.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$handle } ) );
6350
6351 // Properties
6352 this.menu = new OO.ui.FloatingMenuSelectWidget( $.extend( {
6353 widget: this,
6354 $container: this.$element
6355 }, config.menu ) );
6356
6357 // Events
6358 this.$handle.on( {
6359 click: this.onClick.bind( this ),
6360 keydown: this.onKeyDown.bind( this )
6361 } );
6362 this.menu.connect( this, { select: 'onMenuSelect' } );
6363
6364 // Initialization
6365 this.$handle
6366 .addClass( 'oo-ui-dropdownWidget-handle' )
6367 .append( this.$icon, this.$label, this.$indicator );
6368 this.$element
6369 .addClass( 'oo-ui-dropdownWidget' )
6370 .append( this.$handle );
6371 this.$overlay.append( this.menu.$element );
6372 };
6373
6374 /* Setup */
6375
6376 OO.inheritClass( OO.ui.DropdownWidget, OO.ui.Widget );
6377 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.IconElement );
6378 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.IndicatorElement );
6379 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.LabelElement );
6380 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.TitledElement );
6381 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.TabIndexedElement );
6382
6383 /* Methods */
6384
6385 /**
6386 * Get the menu.
6387 *
6388 * @return {OO.ui.MenuSelectWidget} Menu of widget
6389 */
6390 OO.ui.DropdownWidget.prototype.getMenu = function () {
6391 return this.menu;
6392 };
6393
6394 /**
6395 * Handles menu select events.
6396 *
6397 * @private
6398 * @param {OO.ui.MenuOptionWidget} item Selected menu item
6399 */
6400 OO.ui.DropdownWidget.prototype.onMenuSelect = function ( item ) {
6401 var selectedLabel;
6402
6403 if ( !item ) {
6404 this.setLabel( null );
6405 return;
6406 }
6407
6408 selectedLabel = item.getLabel();
6409
6410 // If the label is a DOM element, clone it, because setLabel will append() it
6411 if ( selectedLabel instanceof jQuery ) {
6412 selectedLabel = selectedLabel.clone();
6413 }
6414
6415 this.setLabel( selectedLabel );
6416 };
6417
6418 /**
6419 * Handle mouse click events.
6420 *
6421 * @private
6422 * @param {jQuery.Event} e Mouse click event
6423 */
6424 OO.ui.DropdownWidget.prototype.onClick = function ( e ) {
6425 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
6426 this.menu.toggle();
6427 }
6428 return false;
6429 };
6430
6431 /**
6432 * Handle key down events.
6433 *
6434 * @private
6435 * @param {jQuery.Event} e Key down event
6436 */
6437 OO.ui.DropdownWidget.prototype.onKeyDown = function ( e ) {
6438 if (
6439 !this.isDisabled() &&
6440 (
6441 e.which === OO.ui.Keys.ENTER ||
6442 (
6443 !this.menu.isVisible() &&
6444 (
6445 e.which === OO.ui.Keys.SPACE ||
6446 e.which === OO.ui.Keys.UP ||
6447 e.which === OO.ui.Keys.DOWN
6448 )
6449 )
6450 )
6451 ) {
6452 this.menu.toggle();
6453 return false;
6454 }
6455 };
6456
6457 /**
6458 * RadioOptionWidget is an option widget that looks like a radio button.
6459 * The class is used with OO.ui.RadioSelectWidget to create a selection of radio options.
6460 * Please see the [OOjs UI documentation on MediaWiki] [1] for more information.
6461 *
6462 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Button_selects_and_option
6463 *
6464 * @class
6465 * @extends OO.ui.OptionWidget
6466 *
6467 * @constructor
6468 * @param {Object} [config] Configuration options
6469 */
6470 OO.ui.RadioOptionWidget = function OoUiRadioOptionWidget( config ) {
6471 // Configuration initialization
6472 config = config || {};
6473
6474 // Properties (must be done before parent constructor which calls #setDisabled)
6475 this.radio = new OO.ui.RadioInputWidget( { value: config.data, tabIndex: -1 } );
6476
6477 // Parent constructor
6478 OO.ui.RadioOptionWidget.parent.call( this, config );
6479
6480 // Initialization
6481 // Remove implicit role, we're handling it ourselves
6482 this.radio.$input.attr( 'role', 'presentation' );
6483 this.$element
6484 .addClass( 'oo-ui-radioOptionWidget' )
6485 .attr( 'role', 'radio' )
6486 .attr( 'aria-checked', 'false' )
6487 .removeAttr( 'aria-selected' )
6488 .prepend( this.radio.$element );
6489 };
6490
6491 /* Setup */
6492
6493 OO.inheritClass( OO.ui.RadioOptionWidget, OO.ui.OptionWidget );
6494
6495 /* Static Properties */
6496
6497 OO.ui.RadioOptionWidget.static.highlightable = false;
6498
6499 OO.ui.RadioOptionWidget.static.scrollIntoViewOnSelect = true;
6500
6501 OO.ui.RadioOptionWidget.static.pressable = false;
6502
6503 OO.ui.RadioOptionWidget.static.tagName = 'label';
6504
6505 /* Methods */
6506
6507 /**
6508 * @inheritdoc
6509 */
6510 OO.ui.RadioOptionWidget.prototype.setSelected = function ( state ) {
6511 OO.ui.RadioOptionWidget.parent.prototype.setSelected.call( this, state );
6512
6513 this.radio.setSelected( state );
6514 this.$element
6515 .attr( 'aria-checked', state.toString() )
6516 .removeAttr( 'aria-selected' );
6517
6518 return this;
6519 };
6520
6521 /**
6522 * @inheritdoc
6523 */
6524 OO.ui.RadioOptionWidget.prototype.setDisabled = function ( disabled ) {
6525 OO.ui.RadioOptionWidget.parent.prototype.setDisabled.call( this, disabled );
6526
6527 this.radio.setDisabled( this.isDisabled() );
6528
6529 return this;
6530 };
6531
6532 /**
6533 * RadioSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains radio
6534 * options and is used together with OO.ui.RadioOptionWidget. The RadioSelectWidget provides
6535 * an interface for adding, removing and selecting options.
6536 * Please see the [OOjs UI documentation on MediaWiki][1] for more information.
6537 *
6538 * If you want to use this within a HTML form, such as a OO.ui.FormLayout, use
6539 * OO.ui.RadioSelectInputWidget instead.
6540 *
6541 * @example
6542 * // A RadioSelectWidget with RadioOptions.
6543 * var option1 = new OO.ui.RadioOptionWidget( {
6544 * data: 'a',
6545 * label: 'Selected radio option'
6546 * } );
6547 *
6548 * var option2 = new OO.ui.RadioOptionWidget( {
6549 * data: 'b',
6550 * label: 'Unselected radio option'
6551 * } );
6552 *
6553 * var radioSelect=new OO.ui.RadioSelectWidget( {
6554 * items: [ option1, option2 ]
6555 * } );
6556 *
6557 * // Select 'option 1' using the RadioSelectWidget's selectItem() method.
6558 * radioSelect.selectItem( option1 );
6559 *
6560 * $( 'body' ).append( radioSelect.$element );
6561 *
6562 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
6563
6564 *
6565 * @class
6566 * @extends OO.ui.SelectWidget
6567 * @mixins OO.ui.mixin.TabIndexedElement
6568 *
6569 * @constructor
6570 * @param {Object} [config] Configuration options
6571 */
6572 OO.ui.RadioSelectWidget = function OoUiRadioSelectWidget( config ) {
6573 // Parent constructor
6574 OO.ui.RadioSelectWidget.parent.call( this, config );
6575
6576 // Mixin constructors
6577 OO.ui.mixin.TabIndexedElement.call( this, config );
6578
6579 // Events
6580 this.$element.on( {
6581 focus: this.bindKeyDownListener.bind( this ),
6582 blur: this.unbindKeyDownListener.bind( this )
6583 } );
6584
6585 // Initialization
6586 this.$element
6587 .addClass( 'oo-ui-radioSelectWidget' )
6588 .attr( 'role', 'radiogroup' );
6589 };
6590
6591 /* Setup */
6592
6593 OO.inheritClass( OO.ui.RadioSelectWidget, OO.ui.SelectWidget );
6594 OO.mixinClass( OO.ui.RadioSelectWidget, OO.ui.mixin.TabIndexedElement );
6595
6596 /**
6597 * Element that will stick under a specified container, even when it is inserted elsewhere in the
6598 * document (for example, in a OO.ui.Window's $overlay).
6599 *
6600 * The elements's position is automatically calculated and maintained when window is resized or the
6601 * page is scrolled. If you reposition the container manually, you have to call #position to make
6602 * sure the element is still placed correctly.
6603 *
6604 * As positioning is only possible when both the element and the container are attached to the DOM
6605 * and visible, it's only done after you call #togglePositioning. You might want to do this inside
6606 * the #toggle method to display a floating popup, for example.
6607 *
6608 * @abstract
6609 * @class
6610 *
6611 * @constructor
6612 * @param {Object} [config] Configuration options
6613 * @cfg {jQuery} [$floatable] Node to position, assigned to #$floatable, omit to use #$element
6614 * @cfg {jQuery} [$floatableContainer] Node to position below
6615 */
6616 OO.ui.mixin.FloatableElement = function OoUiMixinFloatableElement( config ) {
6617 // Configuration initialization
6618 config = config || {};
6619
6620 // Properties
6621 this.$floatable = null;
6622 this.$floatableContainer = null;
6623 this.$floatableWindow = null;
6624 this.$floatableClosestScrollable = null;
6625 this.onFloatableScrollHandler = this.position.bind( this );
6626 this.onFloatableWindowResizeHandler = this.position.bind( this );
6627
6628 // Initialization
6629 this.setFloatableContainer( config.$floatableContainer );
6630 this.setFloatableElement( config.$floatable || this.$element );
6631 };
6632
6633 /* Methods */
6634
6635 /**
6636 * Set floatable element.
6637 *
6638 * If an element is already set, it will be cleaned up before setting up the new element.
6639 *
6640 * @param {jQuery} $floatable Element to make floatable
6641 */
6642 OO.ui.mixin.FloatableElement.prototype.setFloatableElement = function ( $floatable ) {
6643 if ( this.$floatable ) {
6644 this.$floatable.removeClass( 'oo-ui-floatableElement-floatable' );
6645 this.$floatable.css( { left: '', top: '' } );
6646 }
6647
6648 this.$floatable = $floatable.addClass( 'oo-ui-floatableElement-floatable' );
6649 this.position();
6650 };
6651
6652 /**
6653 * Set floatable container.
6654 *
6655 * The element will be always positioned under the specified container.
6656 *
6657 * @param {jQuery|null} $floatableContainer Container to keep visible, or null to unset
6658 */
6659 OO.ui.mixin.FloatableElement.prototype.setFloatableContainer = function ( $floatableContainer ) {
6660 this.$floatableContainer = $floatableContainer;
6661 if ( this.$floatable ) {
6662 this.position();
6663 }
6664 };
6665
6666 /**
6667 * Toggle positioning.
6668 *
6669 * Do not turn positioning on until after the element is attached to the DOM and visible.
6670 *
6671 * @param {boolean} [positioning] Enable positioning, omit to toggle
6672 * @chainable
6673 */
6674 OO.ui.mixin.FloatableElement.prototype.togglePositioning = function ( positioning ) {
6675 var closestScrollableOfContainer, closestScrollableOfFloatable;
6676
6677 positioning = positioning === undefined ? !this.positioning : !!positioning;
6678
6679 if ( this.positioning !== positioning ) {
6680 this.positioning = positioning;
6681
6682 closestScrollableOfContainer = OO.ui.Element.static.getClosestScrollableContainer( this.$floatableContainer[ 0 ] );
6683 closestScrollableOfFloatable = OO.ui.Element.static.getClosestScrollableContainer( this.$floatable[ 0 ] );
6684 this.needsCustomPosition = closestScrollableOfContainer !== closestScrollableOfFloatable;
6685 // If the scrollable is the root, we have to listen to scroll events
6686 // on the window because of browser inconsistencies.
6687 if ( $( closestScrollableOfContainer ).is( 'html, body' ) ) {
6688 closestScrollableOfContainer = OO.ui.Element.static.getWindow( closestScrollableOfContainer );
6689 }
6690
6691 if ( positioning ) {
6692 this.$floatableWindow = $( this.getElementWindow() );
6693 this.$floatableWindow.on( 'resize', this.onFloatableWindowResizeHandler );
6694
6695 this.$floatableClosestScrollable = $( closestScrollableOfContainer );
6696 this.$floatableClosestScrollable.on( 'scroll', this.onFloatableScrollHandler );
6697
6698 // Initial position after visible
6699 this.position();
6700 } else {
6701 if ( this.$floatableWindow ) {
6702 this.$floatableWindow.off( 'resize', this.onFloatableWindowResizeHandler );
6703 this.$floatableWindow = null;
6704 }
6705
6706 if ( this.$floatableClosestScrollable ) {
6707 this.$floatableClosestScrollable.off( 'scroll', this.onFloatableScrollHandler );
6708 this.$floatableClosestScrollable = null;
6709 }
6710
6711 this.$floatable.css( { left: '', top: '' } );
6712 }
6713 }
6714
6715 return this;
6716 };
6717
6718 /**
6719 * Check whether the bottom edge of the given element is within the viewport of the given container.
6720 *
6721 * @private
6722 * @param {jQuery} $element
6723 * @param {jQuery} $container
6724 * @return {boolean}
6725 */
6726 OO.ui.mixin.FloatableElement.prototype.isElementInViewport = function ( $element, $container ) {
6727 var elemRect, contRect,
6728 topEdgeInBounds = false,
6729 leftEdgeInBounds = false,
6730 bottomEdgeInBounds = false,
6731 rightEdgeInBounds = false;
6732
6733 elemRect = $element[ 0 ].getBoundingClientRect();
6734 if ( $container[ 0 ] === window ) {
6735 contRect = {
6736 top: 0,
6737 left: 0,
6738 right: document.documentElement.clientWidth,
6739 bottom: document.documentElement.clientHeight
6740 };
6741 } else {
6742 contRect = $container[ 0 ].getBoundingClientRect();
6743 }
6744
6745 if ( elemRect.top >= contRect.top && elemRect.top <= contRect.bottom ) {
6746 topEdgeInBounds = true;
6747 }
6748 if ( elemRect.left >= contRect.left && elemRect.left <= contRect.right ) {
6749 leftEdgeInBounds = true;
6750 }
6751 if ( elemRect.bottom >= contRect.top && elemRect.bottom <= contRect.bottom ) {
6752 bottomEdgeInBounds = true;
6753 }
6754 if ( elemRect.right >= contRect.left && elemRect.right <= contRect.right ) {
6755 rightEdgeInBounds = true;
6756 }
6757
6758 // We only care that any part of the bottom edge is visible
6759 return bottomEdgeInBounds && ( leftEdgeInBounds || rightEdgeInBounds );
6760 };
6761
6762 /**
6763 * Position the floatable below its container.
6764 *
6765 * This should only be done when both of them are attached to the DOM and visible.
6766 *
6767 * @chainable
6768 */
6769 OO.ui.mixin.FloatableElement.prototype.position = function () {
6770 var pos;
6771
6772 if ( !this.positioning ) {
6773 return this;
6774 }
6775
6776 if ( !this.isElementInViewport( this.$floatableContainer, this.$floatableClosestScrollable ) ) {
6777 this.$floatable.addClass( 'oo-ui-floatableElement-hidden' );
6778 return;
6779 } else {
6780 this.$floatable.removeClass( 'oo-ui-floatableElement-hidden' );
6781 }
6782
6783 if ( !this.needsCustomPosition ) {
6784 return;
6785 }
6786
6787 pos = OO.ui.Element.static.getRelativePosition( this.$floatableContainer, this.$floatable.offsetParent() );
6788
6789 // Position under container
6790 pos.top += this.$floatableContainer.height();
6791 this.$floatable.css( pos );
6792
6793 // We updated the position, so re-evaluate the clipping state.
6794 // (ClippableElement does not listen to 'scroll' events on $floatableContainer's parent, and so
6795 // will not notice the need to update itself.)
6796 // TODO: This is terrible, we shouldn't need to know about ClippableElement at all here. Why does
6797 // it not listen to the right events in the right places?
6798 if ( this.clip ) {
6799 this.clip();
6800 }
6801
6802 return this;
6803 };
6804
6805 /**
6806 * FloatingMenuSelectWidget is a menu that will stick under a specified
6807 * container, even when it is inserted elsewhere in the document (for example,
6808 * in a OO.ui.Window's $overlay). This is sometimes necessary to prevent the
6809 * menu from being clipped too aggresively.
6810 *
6811 * The menu's position is automatically calculated and maintained when the menu
6812 * is toggled or the window is resized.
6813 *
6814 * See OO.ui.ComboBoxInputWidget for an example of a widget that uses this class.
6815 *
6816 * @class
6817 * @extends OO.ui.MenuSelectWidget
6818 * @mixins OO.ui.mixin.FloatableElement
6819 *
6820 * @constructor
6821 * @param {OO.ui.Widget} [inputWidget] Widget to provide the menu for.
6822 * Deprecated, omit this parameter and specify `$container` instead.
6823 * @param {Object} [config] Configuration options
6824 * @cfg {jQuery} [$container=inputWidget.$element] Element to render menu under
6825 */
6826 OO.ui.FloatingMenuSelectWidget = function OoUiFloatingMenuSelectWidget( inputWidget, config ) {
6827 // Allow 'inputWidget' parameter and config for backwards compatibility
6828 if ( OO.isPlainObject( inputWidget ) && config === undefined ) {
6829 config = inputWidget;
6830 inputWidget = config.inputWidget;
6831 }
6832
6833 // Configuration initialization
6834 config = config || {};
6835
6836 // Parent constructor
6837 OO.ui.FloatingMenuSelectWidget.parent.call( this, config );
6838
6839 // Properties (must be set before mixin constructors)
6840 this.inputWidget = inputWidget; // For backwards compatibility
6841 this.$container = config.$container || this.inputWidget.$element;
6842
6843 // Mixins constructors
6844 OO.ui.mixin.FloatableElement.call( this, $.extend( {}, config, { $floatableContainer: this.$container } ) );
6845
6846 // Initialization
6847 this.$element.addClass( 'oo-ui-floatingMenuSelectWidget' );
6848 // For backwards compatibility
6849 this.$element.addClass( 'oo-ui-textInputMenuSelectWidget' );
6850 };
6851
6852 /* Setup */
6853
6854 OO.inheritClass( OO.ui.FloatingMenuSelectWidget, OO.ui.MenuSelectWidget );
6855 OO.mixinClass( OO.ui.FloatingMenuSelectWidget, OO.ui.mixin.FloatableElement );
6856
6857 // For backwards compatibility
6858 OO.ui.TextInputMenuSelectWidget = OO.ui.FloatingMenuSelectWidget;
6859
6860 /* Methods */
6861
6862 /**
6863 * @inheritdoc
6864 */
6865 OO.ui.FloatingMenuSelectWidget.prototype.toggle = function ( visible ) {
6866 var change;
6867 visible = visible === undefined ? !this.isVisible() : !!visible;
6868 change = visible !== this.isVisible();
6869
6870 if ( change && visible ) {
6871 // Make sure the width is set before the parent method runs.
6872 this.setIdealSize( this.$container.width() );
6873 }
6874
6875 // Parent method
6876 // This will call this.clip(), which is nonsensical since we're not positioned yet...
6877 OO.ui.FloatingMenuSelectWidget.parent.prototype.toggle.call( this, visible );
6878
6879 if ( change ) {
6880 this.togglePositioning( this.isVisible() );
6881 }
6882
6883 return this;
6884 };
6885
6886 /**
6887 * InputWidget is the base class for all input widgets, which
6888 * include {@link OO.ui.TextInputWidget text inputs}, {@link OO.ui.CheckboxInputWidget checkbox inputs},
6889 * {@link OO.ui.RadioInputWidget radio inputs}, and {@link OO.ui.ButtonInputWidget button inputs}.
6890 * See the [OOjs UI documentation on MediaWiki] [1] for more information and examples.
6891 *
6892 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
6893 *
6894 * @abstract
6895 * @class
6896 * @extends OO.ui.Widget
6897 * @mixins OO.ui.mixin.FlaggedElement
6898 * @mixins OO.ui.mixin.TabIndexedElement
6899 * @mixins OO.ui.mixin.TitledElement
6900 * @mixins OO.ui.mixin.AccessKeyedElement
6901 *
6902 * @constructor
6903 * @param {Object} [config] Configuration options
6904 * @cfg {string} [name=''] The value of the input’s HTML `name` attribute.
6905 * @cfg {string} [value=''] The value of the input.
6906 * @cfg {string} [dir] The directionality of the input (ltr/rtl).
6907 * @cfg {Function} [inputFilter] The name of an input filter function. Input filters modify the value of an input
6908 * before it is accepted.
6909 */
6910 OO.ui.InputWidget = function OoUiInputWidget( config ) {
6911 // Configuration initialization
6912 config = config || {};
6913
6914 // Parent constructor
6915 OO.ui.InputWidget.parent.call( this, config );
6916
6917 // Properties
6918 // See #reusePreInfuseDOM about config.$input
6919 this.$input = config.$input || this.getInputElement( config );
6920 this.value = '';
6921 this.inputFilter = config.inputFilter;
6922
6923 // Mixin constructors
6924 OO.ui.mixin.FlaggedElement.call( this, config );
6925 OO.ui.mixin.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$input } ) );
6926 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$input } ) );
6927 OO.ui.mixin.AccessKeyedElement.call( this, $.extend( {}, config, { $accessKeyed: this.$input } ) );
6928
6929 // Events
6930 this.$input.on( 'keydown mouseup cut paste change input select', this.onEdit.bind( this ) );
6931
6932 // Initialization
6933 this.$input
6934 .addClass( 'oo-ui-inputWidget-input' )
6935 .attr( 'name', config.name )
6936 .prop( 'disabled', this.isDisabled() );
6937 this.$element
6938 .addClass( 'oo-ui-inputWidget' )
6939 .append( this.$input );
6940 this.setValue( config.value );
6941 if ( config.dir ) {
6942 this.setDir( config.dir );
6943 }
6944 };
6945
6946 /* Setup */
6947
6948 OO.inheritClass( OO.ui.InputWidget, OO.ui.Widget );
6949 OO.mixinClass( OO.ui.InputWidget, OO.ui.mixin.FlaggedElement );
6950 OO.mixinClass( OO.ui.InputWidget, OO.ui.mixin.TabIndexedElement );
6951 OO.mixinClass( OO.ui.InputWidget, OO.ui.mixin.TitledElement );
6952 OO.mixinClass( OO.ui.InputWidget, OO.ui.mixin.AccessKeyedElement );
6953
6954 /* Static Properties */
6955
6956 OO.ui.InputWidget.static.supportsSimpleLabel = true;
6957
6958 /* Static Methods */
6959
6960 /**
6961 * @inheritdoc
6962 */
6963 OO.ui.InputWidget.static.reusePreInfuseDOM = function ( node, config ) {
6964 config = OO.ui.InputWidget.parent.static.reusePreInfuseDOM( node, config );
6965 // Reusing $input lets browsers preserve inputted values across page reloads (T114134)
6966 config.$input = $( node ).find( '.oo-ui-inputWidget-input' );
6967 return config;
6968 };
6969
6970 /**
6971 * @inheritdoc
6972 */
6973 OO.ui.InputWidget.static.gatherPreInfuseState = function ( node, config ) {
6974 var state = OO.ui.InputWidget.parent.static.gatherPreInfuseState( node, config );
6975 if ( config.$input && config.$input.length ) {
6976 state.value = config.$input.val();
6977 // Might be better in TabIndexedElement, but it's awkward to do there because mixins are awkward
6978 state.focus = config.$input.is( ':focus' );
6979 }
6980 return state;
6981 };
6982
6983 /* Events */
6984
6985 /**
6986 * @event change
6987 *
6988 * A change event is emitted when the value of the input changes.
6989 *
6990 * @param {string} value
6991 */
6992
6993 /* Methods */
6994
6995 /**
6996 * Get input element.
6997 *
6998 * Subclasses of OO.ui.InputWidget use the `config` parameter to produce different elements in
6999 * different circumstances. The element must have a `value` property (like form elements).
7000 *
7001 * @protected
7002 * @param {Object} config Configuration options
7003 * @return {jQuery} Input element
7004 */
7005 OO.ui.InputWidget.prototype.getInputElement = function () {
7006 return $( '<input>' );
7007 };
7008
7009 /**
7010 * Handle potentially value-changing events.
7011 *
7012 * @private
7013 * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
7014 */
7015 OO.ui.InputWidget.prototype.onEdit = function () {
7016 var widget = this;
7017 if ( !this.isDisabled() ) {
7018 // Allow the stack to clear so the value will be updated
7019 setTimeout( function () {
7020 widget.setValue( widget.$input.val() );
7021 } );
7022 }
7023 };
7024
7025 /**
7026 * Get the value of the input.
7027 *
7028 * @return {string} Input value
7029 */
7030 OO.ui.InputWidget.prototype.getValue = function () {
7031 // Resynchronize our internal data with DOM data. Other scripts executing on the page can modify
7032 // it, and we won't know unless they're kind enough to trigger a 'change' event.
7033 var value = this.$input.val();
7034 if ( this.value !== value ) {
7035 this.setValue( value );
7036 }
7037 return this.value;
7038 };
7039
7040 /**
7041 * Set the directionality of the input, either RTL (right-to-left) or LTR (left-to-right).
7042 *
7043 * @deprecated since v0.13.1; use #setDir directly
7044 * @param {boolean} isRTL Directionality is right-to-left
7045 * @chainable
7046 */
7047 OO.ui.InputWidget.prototype.setRTL = function ( isRTL ) {
7048 this.setDir( isRTL ? 'rtl' : 'ltr' );
7049 return this;
7050 };
7051
7052 /**
7053 * Set the directionality of the input.
7054 *
7055 * @param {string} dir Text directionality: 'ltr', 'rtl' or 'auto'
7056 * @chainable
7057 */
7058 OO.ui.InputWidget.prototype.setDir = function ( dir ) {
7059 this.$input.prop( 'dir', dir );
7060 return this;
7061 };
7062
7063 /**
7064 * Set the value of the input.
7065 *
7066 * @param {string} value New value
7067 * @fires change
7068 * @chainable
7069 */
7070 OO.ui.InputWidget.prototype.setValue = function ( value ) {
7071 value = this.cleanUpValue( value );
7072 // Update the DOM if it has changed. Note that with cleanUpValue, it
7073 // is possible for the DOM value to change without this.value changing.
7074 if ( this.$input.val() !== value ) {
7075 this.$input.val( value );
7076 }
7077 if ( this.value !== value ) {
7078 this.value = value;
7079 this.emit( 'change', this.value );
7080 }
7081 return this;
7082 };
7083
7084 /**
7085 * Clean up incoming value.
7086 *
7087 * Ensures value is a string, and converts undefined and null to empty string.
7088 *
7089 * @private
7090 * @param {string} value Original value
7091 * @return {string} Cleaned up value
7092 */
7093 OO.ui.InputWidget.prototype.cleanUpValue = function ( value ) {
7094 if ( value === undefined || value === null ) {
7095 return '';
7096 } else if ( this.inputFilter ) {
7097 return this.inputFilter( String( value ) );
7098 } else {
7099 return String( value );
7100 }
7101 };
7102
7103 /**
7104 * Simulate the behavior of clicking on a label bound to this input. This method is only called by
7105 * {@link OO.ui.LabelWidget LabelWidget} and {@link OO.ui.FieldLayout FieldLayout}. It should not be
7106 * called directly.
7107 */
7108 OO.ui.InputWidget.prototype.simulateLabelClick = function () {
7109 if ( !this.isDisabled() ) {
7110 if ( this.$input.is( ':checkbox, :radio' ) ) {
7111 this.$input.click();
7112 }
7113 if ( this.$input.is( ':input' ) ) {
7114 this.$input[ 0 ].focus();
7115 }
7116 }
7117 };
7118
7119 /**
7120 * @inheritdoc
7121 */
7122 OO.ui.InputWidget.prototype.setDisabled = function ( state ) {
7123 OO.ui.InputWidget.parent.prototype.setDisabled.call( this, state );
7124 if ( this.$input ) {
7125 this.$input.prop( 'disabled', this.isDisabled() );
7126 }
7127 return this;
7128 };
7129
7130 /**
7131 * Focus the input.
7132 *
7133 * @chainable
7134 */
7135 OO.ui.InputWidget.prototype.focus = function () {
7136 this.$input[ 0 ].focus();
7137 return this;
7138 };
7139
7140 /**
7141 * Blur the input.
7142 *
7143 * @chainable
7144 */
7145 OO.ui.InputWidget.prototype.blur = function () {
7146 this.$input[ 0 ].blur();
7147 return this;
7148 };
7149
7150 /**
7151 * @inheritdoc
7152 */
7153 OO.ui.InputWidget.prototype.restorePreInfuseState = function ( state ) {
7154 OO.ui.InputWidget.parent.prototype.restorePreInfuseState.call( this, state );
7155 if ( state.value !== undefined && state.value !== this.getValue() ) {
7156 this.setValue( state.value );
7157 }
7158 if ( state.focus ) {
7159 this.focus();
7160 }
7161 };
7162
7163 /**
7164 * ButtonInputWidget is used to submit HTML forms and is intended to be used within
7165 * a OO.ui.FormLayout. If you do not need the button to work with HTML forms, you probably
7166 * want to use OO.ui.ButtonWidget instead. Button input widgets can be rendered as either an
7167 * HTML `<button/>` (the default) or an HTML `<input/>` tags. See the
7168 * [OOjs UI documentation on MediaWiki] [1] for more information.
7169 *
7170 * @example
7171 * // A ButtonInputWidget rendered as an HTML button, the default.
7172 * var button = new OO.ui.ButtonInputWidget( {
7173 * label: 'Input button',
7174 * icon: 'check',
7175 * value: 'check'
7176 * } );
7177 * $( 'body' ).append( button.$element );
7178 *
7179 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs#Button_inputs
7180 *
7181 * @class
7182 * @extends OO.ui.InputWidget
7183 * @mixins OO.ui.mixin.ButtonElement
7184 * @mixins OO.ui.mixin.IconElement
7185 * @mixins OO.ui.mixin.IndicatorElement
7186 * @mixins OO.ui.mixin.LabelElement
7187 * @mixins OO.ui.mixin.TitledElement
7188 *
7189 * @constructor
7190 * @param {Object} [config] Configuration options
7191 * @cfg {string} [type='button'] The value of the HTML `'type'` attribute: 'button', 'submit' or 'reset'.
7192 * @cfg {boolean} [useInputTag=false] Use an `<input/>` tag instead of a `<button/>` tag, the default.
7193 * Widgets configured to be an `<input/>` do not support {@link #icon icons} and {@link #indicator indicators},
7194 * non-plaintext {@link #label labels}, or {@link #value values}. In general, useInputTag should only
7195 * be set to `true` when there’s need to support IE 6 in a form with multiple buttons.
7196 */
7197 OO.ui.ButtonInputWidget = function OoUiButtonInputWidget( config ) {
7198 // Configuration initialization
7199 config = $.extend( { type: 'button', useInputTag: false }, config );
7200
7201 // See InputWidget#reusePreInfuseDOM about config.$input
7202 if ( config.$input ) {
7203 config.$input.empty();
7204 }
7205
7206 // Properties (must be set before parent constructor, which calls #setValue)
7207 this.useInputTag = config.useInputTag;
7208
7209 // Parent constructor
7210 OO.ui.ButtonInputWidget.parent.call( this, config );
7211
7212 // Mixin constructors
7213 OO.ui.mixin.ButtonElement.call( this, $.extend( {}, config, { $button: this.$input } ) );
7214 OO.ui.mixin.IconElement.call( this, config );
7215 OO.ui.mixin.IndicatorElement.call( this, config );
7216 OO.ui.mixin.LabelElement.call( this, config );
7217 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$input } ) );
7218
7219 // Initialization
7220 if ( !config.useInputTag ) {
7221 this.$input.append( this.$icon, this.$label, this.$indicator );
7222 }
7223 this.$element.addClass( 'oo-ui-buttonInputWidget' );
7224 };
7225
7226 /* Setup */
7227
7228 OO.inheritClass( OO.ui.ButtonInputWidget, OO.ui.InputWidget );
7229 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.ButtonElement );
7230 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.IconElement );
7231 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.IndicatorElement );
7232 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.LabelElement );
7233 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.TitledElement );
7234
7235 /* Static Properties */
7236
7237 /**
7238 * Disable generating `<label>` elements for buttons. One would very rarely need additional label
7239 * for a button, and it's already a big clickable target, and it causes unexpected rendering.
7240 */
7241 OO.ui.ButtonInputWidget.static.supportsSimpleLabel = false;
7242
7243 /* Methods */
7244
7245 /**
7246 * @inheritdoc
7247 * @protected
7248 */
7249 OO.ui.ButtonInputWidget.prototype.getInputElement = function ( config ) {
7250 var type;
7251 type = [ 'button', 'submit', 'reset' ].indexOf( config.type ) !== -1 ? config.type : 'button';
7252 return $( '<' + ( config.useInputTag ? 'input' : 'button' ) + ' type="' + type + '">' );
7253 };
7254
7255 /**
7256 * Set label value.
7257 *
7258 * If #useInputTag is `true`, the label is set as the `value` of the `<input/>` tag.
7259 *
7260 * @param {jQuery|string|Function|null} label Label nodes, text, a function that returns nodes or
7261 * text, or `null` for no label
7262 * @chainable
7263 */
7264 OO.ui.ButtonInputWidget.prototype.setLabel = function ( label ) {
7265 if ( typeof label === 'function' ) {
7266 label = OO.ui.resolveMsg( label );
7267 }
7268
7269 if ( this.useInputTag ) {
7270 // Discard non-plaintext labels
7271 if ( typeof label !== 'string' ) {
7272 label = '';
7273 }
7274
7275 this.$input.val( label );
7276 }
7277
7278 return OO.ui.mixin.LabelElement.prototype.setLabel.call( this, label );
7279 };
7280
7281 /**
7282 * Set the value of the input.
7283 *
7284 * This method is disabled for button inputs configured as {@link #useInputTag <input/> tags}, as
7285 * they do not support {@link #value values}.
7286 *
7287 * @param {string} value New value
7288 * @chainable
7289 */
7290 OO.ui.ButtonInputWidget.prototype.setValue = function ( value ) {
7291 if ( !this.useInputTag ) {
7292 OO.ui.ButtonInputWidget.parent.prototype.setValue.call( this, value );
7293 }
7294 return this;
7295 };
7296
7297 /**
7298 * CheckboxInputWidgets, like HTML checkboxes, can be selected and/or configured with a value.
7299 * Note that these {@link OO.ui.InputWidget input widgets} are best laid out
7300 * in {@link OO.ui.FieldLayout field layouts} that use the {@link OO.ui.FieldLayout#align inline}
7301 * alignment. For more information, please see the [OOjs UI documentation on MediaWiki][1].
7302 *
7303 * This widget can be used inside a HTML form, such as a OO.ui.FormLayout.
7304 *
7305 * @example
7306 * // An example of selected, unselected, and disabled checkbox inputs
7307 * var checkbox1=new OO.ui.CheckboxInputWidget( {
7308 * value: 'a',
7309 * selected: true
7310 * } );
7311 * var checkbox2=new OO.ui.CheckboxInputWidget( {
7312 * value: 'b'
7313 * } );
7314 * var checkbox3=new OO.ui.CheckboxInputWidget( {
7315 * value:'c',
7316 * disabled: true
7317 * } );
7318 * // Create a fieldset layout with fields for each checkbox.
7319 * var fieldset = new OO.ui.FieldsetLayout( {
7320 * label: 'Checkboxes'
7321 * } );
7322 * fieldset.addItems( [
7323 * new OO.ui.FieldLayout( checkbox1, { label: 'Selected checkbox', align: 'inline' } ),
7324 * new OO.ui.FieldLayout( checkbox2, { label: 'Unselected checkbox', align: 'inline' } ),
7325 * new OO.ui.FieldLayout( checkbox3, { label: 'Disabled checkbox', align: 'inline' } ),
7326 * ] );
7327 * $( 'body' ).append( fieldset.$element );
7328 *
7329 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
7330 *
7331 * @class
7332 * @extends OO.ui.InputWidget
7333 *
7334 * @constructor
7335 * @param {Object} [config] Configuration options
7336 * @cfg {boolean} [selected=false] Select the checkbox initially. By default, the checkbox is not selected.
7337 */
7338 OO.ui.CheckboxInputWidget = function OoUiCheckboxInputWidget( config ) {
7339 // Configuration initialization
7340 config = config || {};
7341
7342 // Parent constructor
7343 OO.ui.CheckboxInputWidget.parent.call( this, config );
7344
7345 // Initialization
7346 this.$element
7347 .addClass( 'oo-ui-checkboxInputWidget' )
7348 // Required for pretty styling in MediaWiki theme
7349 .append( $( '<span>' ) );
7350 this.setSelected( config.selected !== undefined ? config.selected : false );
7351 };
7352
7353 /* Setup */
7354
7355 OO.inheritClass( OO.ui.CheckboxInputWidget, OO.ui.InputWidget );
7356
7357 /* Static Methods */
7358
7359 /**
7360 * @inheritdoc
7361 */
7362 OO.ui.CheckboxInputWidget.static.gatherPreInfuseState = function ( node, config ) {
7363 var state = OO.ui.CheckboxInputWidget.parent.static.gatherPreInfuseState( node, config );
7364 state.checked = config.$input.prop( 'checked' );
7365 return state;
7366 };
7367
7368 /* Methods */
7369
7370 /**
7371 * @inheritdoc
7372 * @protected
7373 */
7374 OO.ui.CheckboxInputWidget.prototype.getInputElement = function () {
7375 return $( '<input>' ).attr( 'type', 'checkbox' );
7376 };
7377
7378 /**
7379 * @inheritdoc
7380 */
7381 OO.ui.CheckboxInputWidget.prototype.onEdit = function () {
7382 var widget = this;
7383 if ( !this.isDisabled() ) {
7384 // Allow the stack to clear so the value will be updated
7385 setTimeout( function () {
7386 widget.setSelected( widget.$input.prop( 'checked' ) );
7387 } );
7388 }
7389 };
7390
7391 /**
7392 * Set selection state of this checkbox.
7393 *
7394 * @param {boolean} state `true` for selected
7395 * @chainable
7396 */
7397 OO.ui.CheckboxInputWidget.prototype.setSelected = function ( state ) {
7398 state = !!state;
7399 if ( this.selected !== state ) {
7400 this.selected = state;
7401 this.$input.prop( 'checked', this.selected );
7402 this.emit( 'change', this.selected );
7403 }
7404 return this;
7405 };
7406
7407 /**
7408 * Check if this checkbox is selected.
7409 *
7410 * @return {boolean} Checkbox is selected
7411 */
7412 OO.ui.CheckboxInputWidget.prototype.isSelected = function () {
7413 // Resynchronize our internal data with DOM data. Other scripts executing on the page can modify
7414 // it, and we won't know unless they're kind enough to trigger a 'change' event.
7415 var selected = this.$input.prop( 'checked' );
7416 if ( this.selected !== selected ) {
7417 this.setSelected( selected );
7418 }
7419 return this.selected;
7420 };
7421
7422 /**
7423 * @inheritdoc
7424 */
7425 OO.ui.CheckboxInputWidget.prototype.restorePreInfuseState = function ( state ) {
7426 OO.ui.CheckboxInputWidget.parent.prototype.restorePreInfuseState.call( this, state );
7427 if ( state.checked !== undefined && state.checked !== this.isSelected() ) {
7428 this.setSelected( state.checked );
7429 }
7430 };
7431
7432 /**
7433 * DropdownInputWidget is a {@link OO.ui.DropdownWidget DropdownWidget} intended to be used
7434 * within a HTML form, such as a OO.ui.FormLayout. The selected value is synchronized with the value
7435 * of a hidden HTML `input` tag. Please see the [OOjs UI documentation on MediaWiki][1] for
7436 * more information about input widgets.
7437 *
7438 * A DropdownInputWidget always has a value (one of the options is always selected), unless there
7439 * are no options. If no `value` configuration option is provided, the first option is selected.
7440 * If you need a state representing no value (no option being selected), use a DropdownWidget.
7441 *
7442 * This and OO.ui.RadioSelectInputWidget support the same configuration options.
7443 *
7444 * @example
7445 * // Example: A DropdownInputWidget with three options
7446 * var dropdownInput = new OO.ui.DropdownInputWidget( {
7447 * options: [
7448 * { data: 'a', label: 'First' },
7449 * { data: 'b', label: 'Second'},
7450 * { data: 'c', label: 'Third' }
7451 * ]
7452 * } );
7453 * $( 'body' ).append( dropdownInput.$element );
7454 *
7455 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
7456 *
7457 * @class
7458 * @extends OO.ui.InputWidget
7459 * @mixins OO.ui.mixin.TitledElement
7460 *
7461 * @constructor
7462 * @param {Object} [config] Configuration options
7463 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
7464 * @cfg {Object} [dropdown] Configuration options for {@link OO.ui.DropdownWidget DropdownWidget}
7465 */
7466 OO.ui.DropdownInputWidget = function OoUiDropdownInputWidget( config ) {
7467 // Configuration initialization
7468 config = config || {};
7469
7470 // See InputWidget#reusePreInfuseDOM about config.$input
7471 if ( config.$input ) {
7472 config.$input.addClass( 'oo-ui-element-hidden' );
7473 }
7474
7475 // Properties (must be done before parent constructor which calls #setDisabled)
7476 this.dropdownWidget = new OO.ui.DropdownWidget( config.dropdown );
7477
7478 // Parent constructor
7479 OO.ui.DropdownInputWidget.parent.call( this, config );
7480
7481 // Mixin constructors
7482 OO.ui.mixin.TitledElement.call( this, config );
7483
7484 // Events
7485 this.dropdownWidget.getMenu().connect( this, { select: 'onMenuSelect' } );
7486
7487 // Initialization
7488 this.setOptions( config.options || [] );
7489 this.$element
7490 .addClass( 'oo-ui-dropdownInputWidget' )
7491 .append( this.dropdownWidget.$element );
7492 };
7493
7494 /* Setup */
7495
7496 OO.inheritClass( OO.ui.DropdownInputWidget, OO.ui.InputWidget );
7497 OO.mixinClass( OO.ui.DropdownInputWidget, OO.ui.mixin.TitledElement );
7498
7499 /* Methods */
7500
7501 /**
7502 * @inheritdoc
7503 * @protected
7504 */
7505 OO.ui.DropdownInputWidget.prototype.getInputElement = function () {
7506 return $( '<input>' ).attr( 'type', 'hidden' );
7507 };
7508
7509 /**
7510 * Handles menu select events.
7511 *
7512 * @private
7513 * @param {OO.ui.MenuOptionWidget} item Selected menu item
7514 */
7515 OO.ui.DropdownInputWidget.prototype.onMenuSelect = function ( item ) {
7516 this.setValue( item.getData() );
7517 };
7518
7519 /**
7520 * @inheritdoc
7521 */
7522 OO.ui.DropdownInputWidget.prototype.setValue = function ( value ) {
7523 value = this.cleanUpValue( value );
7524 this.dropdownWidget.getMenu().selectItemByData( value );
7525 OO.ui.DropdownInputWidget.parent.prototype.setValue.call( this, value );
7526 return this;
7527 };
7528
7529 /**
7530 * @inheritdoc
7531 */
7532 OO.ui.DropdownInputWidget.prototype.setDisabled = function ( state ) {
7533 this.dropdownWidget.setDisabled( state );
7534 OO.ui.DropdownInputWidget.parent.prototype.setDisabled.call( this, state );
7535 return this;
7536 };
7537
7538 /**
7539 * Set the options available for this input.
7540 *
7541 * @param {Object[]} options Array of menu options in the format `{ data: …, label: … }`
7542 * @chainable
7543 */
7544 OO.ui.DropdownInputWidget.prototype.setOptions = function ( options ) {
7545 var
7546 value = this.getValue(),
7547 widget = this;
7548
7549 // Rebuild the dropdown menu
7550 this.dropdownWidget.getMenu()
7551 .clearItems()
7552 .addItems( options.map( function ( opt ) {
7553 var optValue = widget.cleanUpValue( opt.data );
7554 return new OO.ui.MenuOptionWidget( {
7555 data: optValue,
7556 label: opt.label !== undefined ? opt.label : optValue
7557 } );
7558 } ) );
7559
7560 // Restore the previous value, or reset to something sensible
7561 if ( this.dropdownWidget.getMenu().getItemFromData( value ) ) {
7562 // Previous value is still available, ensure consistency with the dropdown
7563 this.setValue( value );
7564 } else {
7565 // No longer valid, reset
7566 if ( options.length ) {
7567 this.setValue( options[ 0 ].data );
7568 }
7569 }
7570
7571 return this;
7572 };
7573
7574 /**
7575 * @inheritdoc
7576 */
7577 OO.ui.DropdownInputWidget.prototype.focus = function () {
7578 this.dropdownWidget.getMenu().toggle( true );
7579 return this;
7580 };
7581
7582 /**
7583 * @inheritdoc
7584 */
7585 OO.ui.DropdownInputWidget.prototype.blur = function () {
7586 this.dropdownWidget.getMenu().toggle( false );
7587 return this;
7588 };
7589
7590 /**
7591 * RadioInputWidget creates a single radio button. Because radio buttons are usually used as a set,
7592 * in most cases you will want to use a {@link OO.ui.RadioSelectWidget radio select}
7593 * with {@link OO.ui.RadioOptionWidget radio options} instead of this class. For more information,
7594 * please see the [OOjs UI documentation on MediaWiki][1].
7595 *
7596 * This widget can be used inside a HTML form, such as a OO.ui.FormLayout.
7597 *
7598 * @example
7599 * // An example of selected, unselected, and disabled radio inputs
7600 * var radio1 = new OO.ui.RadioInputWidget( {
7601 * value: 'a',
7602 * selected: true
7603 * } );
7604 * var radio2 = new OO.ui.RadioInputWidget( {
7605 * value: 'b'
7606 * } );
7607 * var radio3 = new OO.ui.RadioInputWidget( {
7608 * value: 'c',
7609 * disabled: true
7610 * } );
7611 * // Create a fieldset layout with fields for each radio button.
7612 * var fieldset = new OO.ui.FieldsetLayout( {
7613 * label: 'Radio inputs'
7614 * } );
7615 * fieldset.addItems( [
7616 * new OO.ui.FieldLayout( radio1, { label: 'Selected', align: 'inline' } ),
7617 * new OO.ui.FieldLayout( radio2, { label: 'Unselected', align: 'inline' } ),
7618 * new OO.ui.FieldLayout( radio3, { label: 'Disabled', align: 'inline' } ),
7619 * ] );
7620 * $( 'body' ).append( fieldset.$element );
7621 *
7622 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
7623 *
7624 * @class
7625 * @extends OO.ui.InputWidget
7626 *
7627 * @constructor
7628 * @param {Object} [config] Configuration options
7629 * @cfg {boolean} [selected=false] Select the radio button initially. By default, the radio button is not selected.
7630 */
7631 OO.ui.RadioInputWidget = function OoUiRadioInputWidget( config ) {
7632 // Configuration initialization
7633 config = config || {};
7634
7635 // Parent constructor
7636 OO.ui.RadioInputWidget.parent.call( this, config );
7637
7638 // Initialization
7639 this.$element
7640 .addClass( 'oo-ui-radioInputWidget' )
7641 // Required for pretty styling in MediaWiki theme
7642 .append( $( '<span>' ) );
7643 this.setSelected( config.selected !== undefined ? config.selected : false );
7644 };
7645
7646 /* Setup */
7647
7648 OO.inheritClass( OO.ui.RadioInputWidget, OO.ui.InputWidget );
7649
7650 /* Static Methods */
7651
7652 /**
7653 * @inheritdoc
7654 */
7655 OO.ui.RadioInputWidget.static.gatherPreInfuseState = function ( node, config ) {
7656 var state = OO.ui.RadioInputWidget.parent.static.gatherPreInfuseState( node, config );
7657 state.checked = config.$input.prop( 'checked' );
7658 return state;
7659 };
7660
7661 /* Methods */
7662
7663 /**
7664 * @inheritdoc
7665 * @protected
7666 */
7667 OO.ui.RadioInputWidget.prototype.getInputElement = function () {
7668 return $( '<input>' ).attr( 'type', 'radio' );
7669 };
7670
7671 /**
7672 * @inheritdoc
7673 */
7674 OO.ui.RadioInputWidget.prototype.onEdit = function () {
7675 // RadioInputWidget doesn't track its state.
7676 };
7677
7678 /**
7679 * Set selection state of this radio button.
7680 *
7681 * @param {boolean} state `true` for selected
7682 * @chainable
7683 */
7684 OO.ui.RadioInputWidget.prototype.setSelected = function ( state ) {
7685 // RadioInputWidget doesn't track its state.
7686 this.$input.prop( 'checked', state );
7687 return this;
7688 };
7689
7690 /**
7691 * Check if this radio button is selected.
7692 *
7693 * @return {boolean} Radio is selected
7694 */
7695 OO.ui.RadioInputWidget.prototype.isSelected = function () {
7696 return this.$input.prop( 'checked' );
7697 };
7698
7699 /**
7700 * @inheritdoc
7701 */
7702 OO.ui.RadioInputWidget.prototype.restorePreInfuseState = function ( state ) {
7703 OO.ui.RadioInputWidget.parent.prototype.restorePreInfuseState.call( this, state );
7704 if ( state.checked !== undefined && state.checked !== this.isSelected() ) {
7705 this.setSelected( state.checked );
7706 }
7707 };
7708
7709 /**
7710 * RadioSelectInputWidget is a {@link OO.ui.RadioSelectWidget RadioSelectWidget} intended to be used
7711 * within a HTML form, such as a OO.ui.FormLayout. The selected value is synchronized with the value
7712 * of a hidden HTML `input` tag. Please see the [OOjs UI documentation on MediaWiki][1] for
7713 * more information about input widgets.
7714 *
7715 * This and OO.ui.DropdownInputWidget support the same configuration options.
7716 *
7717 * @example
7718 * // Example: A RadioSelectInputWidget with three options
7719 * var radioSelectInput = new OO.ui.RadioSelectInputWidget( {
7720 * options: [
7721 * { data: 'a', label: 'First' },
7722 * { data: 'b', label: 'Second'},
7723 * { data: 'c', label: 'Third' }
7724 * ]
7725 * } );
7726 * $( 'body' ).append( radioSelectInput.$element );
7727 *
7728 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
7729 *
7730 * @class
7731 * @extends OO.ui.InputWidget
7732 *
7733 * @constructor
7734 * @param {Object} [config] Configuration options
7735 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
7736 */
7737 OO.ui.RadioSelectInputWidget = function OoUiRadioSelectInputWidget( config ) {
7738 // Configuration initialization
7739 config = config || {};
7740
7741 // Properties (must be done before parent constructor which calls #setDisabled)
7742 this.radioSelectWidget = new OO.ui.RadioSelectWidget();
7743
7744 // Parent constructor
7745 OO.ui.RadioSelectInputWidget.parent.call( this, config );
7746
7747 // Events
7748 this.radioSelectWidget.connect( this, { select: 'onMenuSelect' } );
7749
7750 // Initialization
7751 this.setOptions( config.options || [] );
7752 this.$element
7753 .addClass( 'oo-ui-radioSelectInputWidget' )
7754 .append( this.radioSelectWidget.$element );
7755 };
7756
7757 /* Setup */
7758
7759 OO.inheritClass( OO.ui.RadioSelectInputWidget, OO.ui.InputWidget );
7760
7761 /* Static Properties */
7762
7763 OO.ui.RadioSelectInputWidget.static.supportsSimpleLabel = false;
7764
7765 /* Static Methods */
7766
7767 /**
7768 * @inheritdoc
7769 */
7770 OO.ui.RadioSelectInputWidget.static.gatherPreInfuseState = function ( node, config ) {
7771 var state = OO.ui.RadioSelectInputWidget.parent.static.gatherPreInfuseState( node, config );
7772 state.value = $( node ).find( '.oo-ui-radioInputWidget .oo-ui-inputWidget-input:checked' ).val();
7773 return state;
7774 };
7775
7776 /**
7777 * @inheritdoc
7778 */
7779 OO.ui.RadioSelectInputWidget.static.reusePreInfuseDOM = function ( node, config ) {
7780 config = OO.ui.RadioSelectInputWidget.parent.static.reusePreInfuseDOM( node, config );
7781 // Cannot reuse the `<input type=radio>` set
7782 delete config.$input;
7783 return config;
7784 };
7785
7786 /* Methods */
7787
7788 /**
7789 * @inheritdoc
7790 * @protected
7791 */
7792 OO.ui.RadioSelectInputWidget.prototype.getInputElement = function () {
7793 return $( '<input>' ).attr( 'type', 'hidden' );
7794 };
7795
7796 /**
7797 * Handles menu select events.
7798 *
7799 * @private
7800 * @param {OO.ui.RadioOptionWidget} item Selected menu item
7801 */
7802 OO.ui.RadioSelectInputWidget.prototype.onMenuSelect = function ( item ) {
7803 this.setValue( item.getData() );
7804 };
7805
7806 /**
7807 * @inheritdoc
7808 */
7809 OO.ui.RadioSelectInputWidget.prototype.setValue = function ( value ) {
7810 value = this.cleanUpValue( value );
7811 this.radioSelectWidget.selectItemByData( value );
7812 OO.ui.RadioSelectInputWidget.parent.prototype.setValue.call( this, value );
7813 return this;
7814 };
7815
7816 /**
7817 * @inheritdoc
7818 */
7819 OO.ui.RadioSelectInputWidget.prototype.setDisabled = function ( state ) {
7820 this.radioSelectWidget.setDisabled( state );
7821 OO.ui.RadioSelectInputWidget.parent.prototype.setDisabled.call( this, state );
7822 return this;
7823 };
7824
7825 /**
7826 * Set the options available for this input.
7827 *
7828 * @param {Object[]} options Array of menu options in the format `{ data: …, label: … }`
7829 * @chainable
7830 */
7831 OO.ui.RadioSelectInputWidget.prototype.setOptions = function ( options ) {
7832 var
7833 value = this.getValue(),
7834 widget = this;
7835
7836 // Rebuild the radioSelect menu
7837 this.radioSelectWidget
7838 .clearItems()
7839 .addItems( options.map( function ( opt ) {
7840 var optValue = widget.cleanUpValue( opt.data );
7841 return new OO.ui.RadioOptionWidget( {
7842 data: optValue,
7843 label: opt.label !== undefined ? opt.label : optValue
7844 } );
7845 } ) );
7846
7847 // Restore the previous value, or reset to something sensible
7848 if ( this.radioSelectWidget.getItemFromData( value ) ) {
7849 // Previous value is still available, ensure consistency with the radioSelect
7850 this.setValue( value );
7851 } else {
7852 // No longer valid, reset
7853 if ( options.length ) {
7854 this.setValue( options[ 0 ].data );
7855 }
7856 }
7857
7858 return this;
7859 };
7860
7861 /**
7862 * TextInputWidgets, like HTML text inputs, can be configured with options that customize the
7863 * size of the field as well as its presentation. In addition, these widgets can be configured
7864 * with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators}, an optional
7865 * validation-pattern (used to determine if an input value is valid or not) and an input filter,
7866 * which modifies incoming values rather than validating them.
7867 * Please see the [OOjs UI documentation on MediaWiki] [1] for more information and examples.
7868 *
7869 * This widget can be used inside a HTML form, such as a OO.ui.FormLayout.
7870 *
7871 * @example
7872 * // Example of a text input widget
7873 * var textInput = new OO.ui.TextInputWidget( {
7874 * value: 'Text input'
7875 * } )
7876 * $( 'body' ).append( textInput.$element );
7877 *
7878 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
7879 *
7880 * @class
7881 * @extends OO.ui.InputWidget
7882 * @mixins OO.ui.mixin.IconElement
7883 * @mixins OO.ui.mixin.IndicatorElement
7884 * @mixins OO.ui.mixin.PendingElement
7885 * @mixins OO.ui.mixin.LabelElement
7886 *
7887 * @constructor
7888 * @param {Object} [config] Configuration options
7889 * @cfg {string} [type='text'] The value of the HTML `type` attribute: 'text', 'password', 'search',
7890 * 'email', 'url', 'date' or 'number'. Ignored if `multiline` is true.
7891 *
7892 * Some values of `type` result in additional behaviors:
7893 *
7894 * - `search`: implies `icon: 'search'` and `indicator: 'clear'`; when clicked, the indicator
7895 * empties the text field
7896 * @cfg {string} [placeholder] Placeholder text
7897 * @cfg {boolean} [autofocus=false] Use an HTML `autofocus` attribute to
7898 * instruct the browser to focus this widget.
7899 * @cfg {boolean} [readOnly=false] Prevent changes to the value of the text input.
7900 * @cfg {number} [maxLength] Maximum number of characters allowed in the input.
7901 * @cfg {boolean} [multiline=false] Allow multiple lines of text
7902 * @cfg {number} [rows] If multiline, number of visible lines in textarea. If used with `autosize`,
7903 * specifies minimum number of rows to display.
7904 * @cfg {boolean} [autosize=false] Automatically resize the text input to fit its content.
7905 * Use the #maxRows config to specify a maximum number of displayed rows.
7906 * @cfg {boolean} [maxRows] Maximum number of rows to display when #autosize is set to true.
7907 * Defaults to the maximum of `10` and `2 * rows`, or `10` if `rows` isn't provided.
7908 * @cfg {string} [labelPosition='after'] The position of the inline label relative to that of
7909 * the value or placeholder text: `'before'` or `'after'`
7910 * @cfg {boolean} [required=false] Mark the field as required. Implies `indicator: 'required'`.
7911 * @cfg {boolean} [autocomplete=true] Should the browser support autocomplete for this field
7912 * @cfg {RegExp|Function|string} [validate] Validation pattern: when string, a symbolic name of a
7913 * pattern defined by the class: 'non-empty' (the value cannot be an empty string) or 'integer'
7914 * (the value must contain only numbers); when RegExp, a regular expression that must match the
7915 * value for it to be considered valid; when Function, a function receiving the value as parameter
7916 * that must return true, or promise resolving to true, for it to be considered valid.
7917 */
7918 OO.ui.TextInputWidget = function OoUiTextInputWidget( config ) {
7919 // Configuration initialization
7920 config = $.extend( {
7921 type: 'text',
7922 labelPosition: 'after'
7923 }, config );
7924 if ( config.type === 'search' ) {
7925 if ( config.icon === undefined ) {
7926 config.icon = 'search';
7927 }
7928 // indicator: 'clear' is set dynamically later, depending on value
7929 }
7930 if ( config.required ) {
7931 if ( config.indicator === undefined ) {
7932 config.indicator = 'required';
7933 }
7934 }
7935
7936 // Parent constructor
7937 OO.ui.TextInputWidget.parent.call( this, config );
7938
7939 // Mixin constructors
7940 OO.ui.mixin.IconElement.call( this, config );
7941 OO.ui.mixin.IndicatorElement.call( this, config );
7942 OO.ui.mixin.PendingElement.call( this, $.extend( {}, config, { $pending: this.$input } ) );
7943 OO.ui.mixin.LabelElement.call( this, config );
7944
7945 // Properties
7946 this.type = this.getSaneType( config );
7947 this.readOnly = false;
7948 this.multiline = !!config.multiline;
7949 this.autosize = !!config.autosize;
7950 this.minRows = config.rows !== undefined ? config.rows : '';
7951 this.maxRows = config.maxRows || Math.max( 2 * ( this.minRows || 0 ), 10 );
7952 this.validate = null;
7953 this.styleHeight = null;
7954 this.scrollWidth = null;
7955
7956 // Clone for resizing
7957 if ( this.autosize ) {
7958 this.$clone = this.$input
7959 .clone()
7960 .insertAfter( this.$input )
7961 .attr( 'aria-hidden', 'true' )
7962 .addClass( 'oo-ui-element-hidden' );
7963 }
7964
7965 this.setValidation( config.validate );
7966 this.setLabelPosition( config.labelPosition );
7967
7968 // Events
7969 this.$input.on( {
7970 keypress: this.onKeyPress.bind( this ),
7971 blur: this.onBlur.bind( this )
7972 } );
7973 this.$input.one( {
7974 focus: this.onElementAttach.bind( this )
7975 } );
7976 this.$icon.on( 'mousedown', this.onIconMouseDown.bind( this ) );
7977 this.$indicator.on( 'mousedown', this.onIndicatorMouseDown.bind( this ) );
7978 this.on( 'labelChange', this.updatePosition.bind( this ) );
7979 this.connect( this, {
7980 change: 'onChange',
7981 disable: 'onDisable'
7982 } );
7983
7984 // Initialization
7985 this.$element
7986 .addClass( 'oo-ui-textInputWidget oo-ui-textInputWidget-type-' + this.type )
7987 .append( this.$icon, this.$indicator );
7988 this.setReadOnly( !!config.readOnly );
7989 this.updateSearchIndicator();
7990 if ( config.placeholder !== undefined ) {
7991 this.$input.attr( 'placeholder', config.placeholder );
7992 }
7993 if ( config.maxLength !== undefined ) {
7994 this.$input.attr( 'maxlength', config.maxLength );
7995 }
7996 if ( config.autofocus ) {
7997 this.$input.attr( 'autofocus', 'autofocus' );
7998 }
7999 if ( config.required ) {
8000 this.$input.attr( 'required', 'required' );
8001 this.$input.attr( 'aria-required', 'true' );
8002 }
8003 if ( config.autocomplete === false ) {
8004 this.$input.attr( 'autocomplete', 'off' );
8005 // Turning off autocompletion also disables "form caching" when the user navigates to a
8006 // different page and then clicks "Back". Re-enable it when leaving. Borrowed from jQuery UI.
8007 $( window ).on( {
8008 beforeunload: function () {
8009 this.$input.removeAttr( 'autocomplete' );
8010 }.bind( this ),
8011 pageshow: function () {
8012 // Browsers don't seem to actually fire this event on "Back", they instead just reload the
8013 // whole page... it shouldn't hurt, though.
8014 this.$input.attr( 'autocomplete', 'off' );
8015 }.bind( this )
8016 } );
8017 }
8018 if ( this.multiline && config.rows ) {
8019 this.$input.attr( 'rows', config.rows );
8020 }
8021 if ( this.label || config.autosize ) {
8022 this.installParentChangeDetector();
8023 }
8024 };
8025
8026 /* Setup */
8027
8028 OO.inheritClass( OO.ui.TextInputWidget, OO.ui.InputWidget );
8029 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.IconElement );
8030 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.IndicatorElement );
8031 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.PendingElement );
8032 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.LabelElement );
8033
8034 /* Static Properties */
8035
8036 OO.ui.TextInputWidget.static.validationPatterns = {
8037 'non-empty': /.+/,
8038 integer: /^\d+$/
8039 };
8040
8041 /* Static Methods */
8042
8043 /**
8044 * @inheritdoc
8045 */
8046 OO.ui.TextInputWidget.static.gatherPreInfuseState = function ( node, config ) {
8047 var state = OO.ui.TextInputWidget.parent.static.gatherPreInfuseState( node, config );
8048 if ( config.multiline ) {
8049 state.scrollTop = config.$input.scrollTop();
8050 }
8051 return state;
8052 };
8053
8054 /* Events */
8055
8056 /**
8057 * An `enter` event is emitted when the user presses 'enter' inside the text box.
8058 *
8059 * Not emitted if the input is multiline.
8060 *
8061 * @event enter
8062 */
8063
8064 /**
8065 * A `resize` event is emitted when autosize is set and the widget resizes
8066 *
8067 * @event resize
8068 */
8069
8070 /* Methods */
8071
8072 /**
8073 * Handle icon mouse down events.
8074 *
8075 * @private
8076 * @param {jQuery.Event} e Mouse down event
8077 */
8078 OO.ui.TextInputWidget.prototype.onIconMouseDown = function ( e ) {
8079 if ( e.which === OO.ui.MouseButtons.LEFT ) {
8080 this.$input[ 0 ].focus();
8081 return false;
8082 }
8083 };
8084
8085 /**
8086 * Handle indicator mouse down events.
8087 *
8088 * @private
8089 * @param {jQuery.Event} e Mouse down event
8090 */
8091 OO.ui.TextInputWidget.prototype.onIndicatorMouseDown = function ( e ) {
8092 if ( e.which === OO.ui.MouseButtons.LEFT ) {
8093 if ( this.type === 'search' ) {
8094 // Clear the text field
8095 this.setValue( '' );
8096 }
8097 this.$input[ 0 ].focus();
8098 return false;
8099 }
8100 };
8101
8102 /**
8103 * Handle key press events.
8104 *
8105 * @private
8106 * @param {jQuery.Event} e Key press event
8107 * @fires enter If enter key is pressed and input is not multiline
8108 */
8109 OO.ui.TextInputWidget.prototype.onKeyPress = function ( e ) {
8110 if ( e.which === OO.ui.Keys.ENTER && !this.multiline ) {
8111 this.emit( 'enter', e );
8112 }
8113 };
8114
8115 /**
8116 * Handle blur events.
8117 *
8118 * @private
8119 * @param {jQuery.Event} e Blur event
8120 */
8121 OO.ui.TextInputWidget.prototype.onBlur = function () {
8122 this.setValidityFlag();
8123 };
8124
8125 /**
8126 * Handle element attach events.
8127 *
8128 * @private
8129 * @param {jQuery.Event} e Element attach event
8130 */
8131 OO.ui.TextInputWidget.prototype.onElementAttach = function () {
8132 // Any previously calculated size is now probably invalid if we reattached elsewhere
8133 this.valCache = null;
8134 this.adjustSize();
8135 this.positionLabel();
8136 };
8137
8138 /**
8139 * Handle change events.
8140 *
8141 * @param {string} value
8142 * @private
8143 */
8144 OO.ui.TextInputWidget.prototype.onChange = function () {
8145 this.updateSearchIndicator();
8146 this.setValidityFlag();
8147 this.adjustSize();
8148 };
8149
8150 /**
8151 * Handle disable events.
8152 *
8153 * @param {boolean} disabled Element is disabled
8154 * @private
8155 */
8156 OO.ui.TextInputWidget.prototype.onDisable = function () {
8157 this.updateSearchIndicator();
8158 };
8159
8160 /**
8161 * Check if the input is {@link #readOnly read-only}.
8162 *
8163 * @return {boolean}
8164 */
8165 OO.ui.TextInputWidget.prototype.isReadOnly = function () {
8166 return this.readOnly;
8167 };
8168
8169 /**
8170 * Set the {@link #readOnly read-only} state of the input.
8171 *
8172 * @param {boolean} state Make input read-only
8173 * @chainable
8174 */
8175 OO.ui.TextInputWidget.prototype.setReadOnly = function ( state ) {
8176 this.readOnly = !!state;
8177 this.$input.prop( 'readOnly', this.readOnly );
8178 this.updateSearchIndicator();
8179 return this;
8180 };
8181
8182 /**
8183 * Support function for making #onElementAttach work across browsers.
8184 *
8185 * This whole function could be replaced with one line of code using the DOMNodeInsertedIntoDocument
8186 * event, but it's not supported by Firefox and allegedly deprecated, so we only use it as fallback.
8187 *
8188 * Due to MutationObserver performance woes, #onElementAttach is only somewhat reliably called the
8189 * first time that the element gets attached to the documented.
8190 */
8191 OO.ui.TextInputWidget.prototype.installParentChangeDetector = function () {
8192 var mutationObserver, onRemove, topmostNode, fakeParentNode,
8193 MutationObserver = window.MutationObserver || window.WebKitMutationObserver || window.MozMutationObserver,
8194 widget = this;
8195
8196 if ( MutationObserver ) {
8197 // The new way. If only it wasn't so ugly.
8198
8199 if ( this.$element.closest( 'html' ).length ) {
8200 // Widget is attached already, do nothing. This breaks the functionality of this function when
8201 // the widget is detached and reattached. Alas, doing this correctly with MutationObserver
8202 // would require observation of the whole document, which would hurt performance of other,
8203 // more important code.
8204 return;
8205 }
8206
8207 // Find topmost node in the tree
8208 topmostNode = this.$element[ 0 ];
8209 while ( topmostNode.parentNode ) {
8210 topmostNode = topmostNode.parentNode;
8211 }
8212
8213 // We have no way to detect the $element being attached somewhere without observing the entire
8214 // DOM with subtree modifications, which would hurt performance. So we cheat: we hook to the
8215 // parent node of $element, and instead detect when $element is removed from it (and thus
8216 // probably attached somewhere else). If there is no parent, we create a "fake" one. If it
8217 // doesn't get attached, we end up back here and create the parent.
8218
8219 mutationObserver = new MutationObserver( function ( mutations ) {
8220 var i, j, removedNodes;
8221 for ( i = 0; i < mutations.length; i++ ) {
8222 removedNodes = mutations[ i ].removedNodes;
8223 for ( j = 0; j < removedNodes.length; j++ ) {
8224 if ( removedNodes[ j ] === topmostNode ) {
8225 setTimeout( onRemove, 0 );
8226 return;
8227 }
8228 }
8229 }
8230 } );
8231
8232 onRemove = function () {
8233 // If the node was attached somewhere else, report it
8234 if ( widget.$element.closest( 'html' ).length ) {
8235 widget.onElementAttach();
8236 }
8237 mutationObserver.disconnect();
8238 widget.installParentChangeDetector();
8239 };
8240
8241 // Create a fake parent and observe it
8242 fakeParentNode = $( '<div>' ).append( topmostNode )[ 0 ];
8243 mutationObserver.observe( fakeParentNode, { childList: true } );
8244 } else {
8245 // Using the DOMNodeInsertedIntoDocument event is much nicer and less magical, and works for
8246 // detachment and reattachment, but it's not supported by Firefox and allegedly deprecated.
8247 this.$element.on( 'DOMNodeInsertedIntoDocument', this.onElementAttach.bind( this ) );
8248 }
8249 };
8250
8251 /**
8252 * Automatically adjust the size of the text input.
8253 *
8254 * This only affects #multiline inputs that are {@link #autosize autosized}.
8255 *
8256 * @chainable
8257 * @fires resize
8258 */
8259 OO.ui.TextInputWidget.prototype.adjustSize = function () {
8260 var scrollHeight, innerHeight, outerHeight, maxInnerHeight, measurementError,
8261 idealHeight, newHeight, scrollWidth, property;
8262
8263 if ( this.multiline && this.$input.val() !== this.valCache ) {
8264 if ( this.autosize ) {
8265 this.$clone
8266 .val( this.$input.val() )
8267 .attr( 'rows', this.minRows )
8268 // Set inline height property to 0 to measure scroll height
8269 .css( 'height', 0 );
8270
8271 this.$clone.removeClass( 'oo-ui-element-hidden' );
8272
8273 this.valCache = this.$input.val();
8274
8275 scrollHeight = this.$clone[ 0 ].scrollHeight;
8276
8277 // Remove inline height property to measure natural heights
8278 this.$clone.css( 'height', '' );
8279 innerHeight = this.$clone.innerHeight();
8280 outerHeight = this.$clone.outerHeight();
8281
8282 // Measure max rows height
8283 this.$clone
8284 .attr( 'rows', this.maxRows )
8285 .css( 'height', 'auto' )
8286 .val( '' );
8287 maxInnerHeight = this.$clone.innerHeight();
8288
8289 // Difference between reported innerHeight and scrollHeight with no scrollbars present.
8290 // This is sometimes non-zero on Blink-based browsers, depending on zoom level.
8291 measurementError = maxInnerHeight - this.$clone[ 0 ].scrollHeight;
8292 idealHeight = Math.min( maxInnerHeight, scrollHeight + measurementError );
8293
8294 this.$clone.addClass( 'oo-ui-element-hidden' );
8295
8296 // Only apply inline height when expansion beyond natural height is needed
8297 // Use the difference between the inner and outer height as a buffer
8298 newHeight = idealHeight > innerHeight ? idealHeight + ( outerHeight - innerHeight ) : '';
8299 if ( newHeight !== this.styleHeight ) {
8300 this.$input.css( 'height', newHeight );
8301 this.styleHeight = newHeight;
8302 this.emit( 'resize' );
8303 }
8304 }
8305 scrollWidth = this.$input[ 0 ].offsetWidth - this.$input[ 0 ].clientWidth;
8306 if ( scrollWidth !== this.scrollWidth ) {
8307 property = this.$element.css( 'direction' ) === 'rtl' ? 'left' : 'right';
8308 // Reset
8309 this.$label.css( { right: '', left: '' } );
8310 this.$indicator.css( { right: '', left: '' } );
8311
8312 if ( scrollWidth ) {
8313 this.$indicator.css( property, scrollWidth );
8314 if ( this.labelPosition === 'after' ) {
8315 this.$label.css( property, scrollWidth );
8316 }
8317 }
8318
8319 this.scrollWidth = scrollWidth;
8320 this.positionLabel();
8321 }
8322 }
8323 return this;
8324 };
8325
8326 /**
8327 * @inheritdoc
8328 * @protected
8329 */
8330 OO.ui.TextInputWidget.prototype.getInputElement = function ( config ) {
8331 if ( config.multiline ) {
8332 return $( '<textarea>' );
8333 } else if ( this.getSaneType( config ) === 'number' ) {
8334 return $( '<input>' )
8335 .attr( 'step', 'any' )
8336 .attr( 'type', 'number' );
8337 } else {
8338 return $( '<input>' ).attr( 'type', this.getSaneType( config ) );
8339 }
8340 };
8341
8342 /**
8343 * Get sanitized value for 'type' for given config.
8344 *
8345 * @param {Object} config Configuration options
8346 * @return {string|null}
8347 * @private
8348 */
8349 OO.ui.TextInputWidget.prototype.getSaneType = function ( config ) {
8350 var allowedTypes = [
8351 'text',
8352 'password',
8353 'search',
8354 'email',
8355 'url',
8356 'date',
8357 'number'
8358 ];
8359 return allowedTypes.indexOf( config.type ) !== -1 ? config.type : 'text';
8360 };
8361
8362 /**
8363 * Check if the input supports multiple lines.
8364 *
8365 * @return {boolean}
8366 */
8367 OO.ui.TextInputWidget.prototype.isMultiline = function () {
8368 return !!this.multiline;
8369 };
8370
8371 /**
8372 * Check if the input automatically adjusts its size.
8373 *
8374 * @return {boolean}
8375 */
8376 OO.ui.TextInputWidget.prototype.isAutosizing = function () {
8377 return !!this.autosize;
8378 };
8379
8380 /**
8381 * Focus the input and select a specified range within the text.
8382 *
8383 * @param {number} from Select from offset
8384 * @param {number} [to] Select to offset, defaults to from
8385 * @chainable
8386 */
8387 OO.ui.TextInputWidget.prototype.selectRange = function ( from, to ) {
8388 var isBackwards, start, end,
8389 input = this.$input[ 0 ];
8390
8391 to = to || from;
8392
8393 isBackwards = to < from;
8394 start = isBackwards ? to : from;
8395 end = isBackwards ? from : to;
8396
8397 this.focus();
8398
8399 try {
8400 input.setSelectionRange( start, end, isBackwards ? 'backward' : 'forward' );
8401 } catch ( e ) {
8402 // IE throws an exception if you call setSelectionRange on a unattached DOM node.
8403 // Rather than expensively check if the input is attached every time, just check
8404 // if it was the cause of an error being thrown. If not, rethrow the error.
8405 if ( this.getElementDocument().body.contains( input ) ) {
8406 throw e;
8407 }
8408 }
8409 return this;
8410 };
8411
8412 /**
8413 * Get an object describing the current selection range in a directional manner
8414 *
8415 * @return {Object} Object containing 'from' and 'to' offsets
8416 */
8417 OO.ui.TextInputWidget.prototype.getRange = function () {
8418 var input = this.$input[ 0 ],
8419 start = input.selectionStart,
8420 end = input.selectionEnd,
8421 isBackwards = input.selectionDirection === 'backward';
8422
8423 return {
8424 from: isBackwards ? end : start,
8425 to: isBackwards ? start : end
8426 };
8427 };
8428
8429 /**
8430 * Get the length of the text input value.
8431 *
8432 * This could differ from the length of #getValue if the
8433 * value gets filtered
8434 *
8435 * @return {number} Input length
8436 */
8437 OO.ui.TextInputWidget.prototype.getInputLength = function () {
8438 return this.$input[ 0 ].value.length;
8439 };
8440
8441 /**
8442 * Focus the input and select the entire text.
8443 *
8444 * @chainable
8445 */
8446 OO.ui.TextInputWidget.prototype.select = function () {
8447 return this.selectRange( 0, this.getInputLength() );
8448 };
8449
8450 /**
8451 * Focus the input and move the cursor to the start.
8452 *
8453 * @chainable
8454 */
8455 OO.ui.TextInputWidget.prototype.moveCursorToStart = function () {
8456 return this.selectRange( 0 );
8457 };
8458
8459 /**
8460 * Focus the input and move the cursor to the end.
8461 *
8462 * @chainable
8463 */
8464 OO.ui.TextInputWidget.prototype.moveCursorToEnd = function () {
8465 return this.selectRange( this.getInputLength() );
8466 };
8467
8468 /**
8469 * Insert new content into the input.
8470 *
8471 * @param {string} content Content to be inserted
8472 * @chainable
8473 */
8474 OO.ui.TextInputWidget.prototype.insertContent = function ( content ) {
8475 var start, end,
8476 range = this.getRange(),
8477 value = this.getValue();
8478
8479 start = Math.min( range.from, range.to );
8480 end = Math.max( range.from, range.to );
8481
8482 this.setValue( value.slice( 0, start ) + content + value.slice( end ) );
8483 this.selectRange( start + content.length );
8484 return this;
8485 };
8486
8487 /**
8488 * Insert new content either side of a selection.
8489 *
8490 * @param {string} pre Content to be inserted before the selection
8491 * @param {string} post Content to be inserted after the selection
8492 * @chainable
8493 */
8494 OO.ui.TextInputWidget.prototype.encapsulateContent = function ( pre, post ) {
8495 var start, end,
8496 range = this.getRange(),
8497 offset = pre.length;
8498
8499 start = Math.min( range.from, range.to );
8500 end = Math.max( range.from, range.to );
8501
8502 this.selectRange( start ).insertContent( pre );
8503 this.selectRange( offset + end ).insertContent( post );
8504
8505 this.selectRange( offset + start, offset + end );
8506 return this;
8507 };
8508
8509 /**
8510 * Set the validation pattern.
8511 *
8512 * The validation pattern is either a regular expression, a function, or the symbolic name of a
8513 * pattern defined by the class: 'non-empty' (the value cannot be an empty string) or 'integer' (the
8514 * value must contain only numbers).
8515 *
8516 * @param {RegExp|Function|string|null} validate Regular expression, function, or the symbolic name
8517 * of a pattern (either ‘integer’ or ‘non-empty’) defined by the class.
8518 */
8519 OO.ui.TextInputWidget.prototype.setValidation = function ( validate ) {
8520 if ( validate instanceof RegExp || validate instanceof Function ) {
8521 this.validate = validate;
8522 } else {
8523 this.validate = this.constructor.static.validationPatterns[ validate ] || /.*/;
8524 }
8525 };
8526
8527 /**
8528 * Sets the 'invalid' flag appropriately.
8529 *
8530 * @param {boolean} [isValid] Optionally override validation result
8531 */
8532 OO.ui.TextInputWidget.prototype.setValidityFlag = function ( isValid ) {
8533 var widget = this,
8534 setFlag = function ( valid ) {
8535 if ( !valid ) {
8536 widget.$input.attr( 'aria-invalid', 'true' );
8537 } else {
8538 widget.$input.removeAttr( 'aria-invalid' );
8539 }
8540 widget.setFlags( { invalid: !valid } );
8541 };
8542
8543 if ( isValid !== undefined ) {
8544 setFlag( isValid );
8545 } else {
8546 this.getValidity().then( function () {
8547 setFlag( true );
8548 }, function () {
8549 setFlag( false );
8550 } );
8551 }
8552 };
8553
8554 /**
8555 * Check if a value is valid.
8556 *
8557 * This method returns a promise that resolves with a boolean `true` if the current value is
8558 * considered valid according to the supplied {@link #validate validation pattern}.
8559 *
8560 * @deprecated since v0.12.3
8561 * @return {jQuery.Promise} A promise that resolves to a boolean `true` if the value is valid.
8562 */
8563 OO.ui.TextInputWidget.prototype.isValid = function () {
8564 var result;
8565
8566 if ( this.validate instanceof Function ) {
8567 result = this.validate( this.getValue() );
8568 if ( result && $.isFunction( result.promise ) ) {
8569 return result.promise();
8570 } else {
8571 return $.Deferred().resolve( !!result ).promise();
8572 }
8573 } else {
8574 return $.Deferred().resolve( !!this.getValue().match( this.validate ) ).promise();
8575 }
8576 };
8577
8578 /**
8579 * Get the validity of current value.
8580 *
8581 * This method returns a promise that resolves if the value is valid and rejects if
8582 * it isn't. Uses the {@link #validate validation pattern} to check for validity.
8583 *
8584 * @return {jQuery.Promise} A promise that resolves if the value is valid, rejects if not.
8585 */
8586 OO.ui.TextInputWidget.prototype.getValidity = function () {
8587 var result;
8588
8589 function rejectOrResolve( valid ) {
8590 if ( valid ) {
8591 return $.Deferred().resolve().promise();
8592 } else {
8593 return $.Deferred().reject().promise();
8594 }
8595 }
8596
8597 if ( this.validate instanceof Function ) {
8598 result = this.validate( this.getValue() );
8599 if ( result && $.isFunction( result.promise ) ) {
8600 return result.promise().then( function ( valid ) {
8601 return rejectOrResolve( valid );
8602 } );
8603 } else {
8604 return rejectOrResolve( result );
8605 }
8606 } else {
8607 return rejectOrResolve( this.getValue().match( this.validate ) );
8608 }
8609 };
8610
8611 /**
8612 * Set the position of the inline label relative to that of the value: `‘before’` or `‘after’`.
8613 *
8614 * @param {string} labelPosition Label position, 'before' or 'after'
8615 * @chainable
8616 */
8617 OO.ui.TextInputWidget.prototype.setLabelPosition = function ( labelPosition ) {
8618 this.labelPosition = labelPosition;
8619 if ( this.label ) {
8620 // If there is no label and we only change the position, #updatePosition is a no-op,
8621 // but it takes really a lot of work to do nothing.
8622 this.updatePosition();
8623 }
8624 return this;
8625 };
8626
8627 /**
8628 * Update the position of the inline label.
8629 *
8630 * This method is called by #setLabelPosition, and can also be called on its own if
8631 * something causes the label to be mispositioned.
8632 *
8633 * @chainable
8634 */
8635 OO.ui.TextInputWidget.prototype.updatePosition = function () {
8636 var after = this.labelPosition === 'after';
8637
8638 this.$element
8639 .toggleClass( 'oo-ui-textInputWidget-labelPosition-after', !!this.label && after )
8640 .toggleClass( 'oo-ui-textInputWidget-labelPosition-before', !!this.label && !after );
8641
8642 this.valCache = null;
8643 this.scrollWidth = null;
8644 this.adjustSize();
8645 this.positionLabel();
8646
8647 return this;
8648 };
8649
8650 /**
8651 * Update the 'clear' indicator displayed on type: 'search' text fields, hiding it when the field is
8652 * already empty or when it's not editable.
8653 */
8654 OO.ui.TextInputWidget.prototype.updateSearchIndicator = function () {
8655 if ( this.type === 'search' ) {
8656 if ( this.getValue() === '' || this.isDisabled() || this.isReadOnly() ) {
8657 this.setIndicator( null );
8658 } else {
8659 this.setIndicator( 'clear' );
8660 }
8661 }
8662 };
8663
8664 /**
8665 * Position the label by setting the correct padding on the input.
8666 *
8667 * @private
8668 * @chainable
8669 */
8670 OO.ui.TextInputWidget.prototype.positionLabel = function () {
8671 var after, rtl, property;
8672 // Clear old values
8673 this.$input
8674 // Clear old values if present
8675 .css( {
8676 'padding-right': '',
8677 'padding-left': ''
8678 } );
8679
8680 if ( this.label ) {
8681 this.$element.append( this.$label );
8682 } else {
8683 this.$label.detach();
8684 return;
8685 }
8686
8687 after = this.labelPosition === 'after';
8688 rtl = this.$element.css( 'direction' ) === 'rtl';
8689 property = after === rtl ? 'padding-left' : 'padding-right';
8690
8691 this.$input.css( property, this.$label.outerWidth( true ) + ( after ? this.scrollWidth : 0 ) );
8692
8693 return this;
8694 };
8695
8696 /**
8697 * @inheritdoc
8698 */
8699 OO.ui.TextInputWidget.prototype.restorePreInfuseState = function ( state ) {
8700 OO.ui.TextInputWidget.parent.prototype.restorePreInfuseState.call( this, state );
8701 if ( state.scrollTop !== undefined ) {
8702 this.$input.scrollTop( state.scrollTop );
8703 }
8704 };
8705
8706 /**
8707 * ComboBoxInputWidgets combine a {@link OO.ui.TextInputWidget text input} (where a value
8708 * can be entered manually) and a {@link OO.ui.MenuSelectWidget menu of options} (from which
8709 * a value can be chosen instead). Users can choose options from the combo box in one of two ways:
8710 *
8711 * - by typing a value in the text input field. If the value exactly matches the value of a menu
8712 * option, that option will appear to be selected.
8713 * - by choosing a value from the menu. The value of the chosen option will then appear in the text
8714 * input field.
8715 *
8716 * This widget can be used inside a HTML form, such as a OO.ui.FormLayout.
8717 *
8718 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
8719 *
8720 * @example
8721 * // Example: A ComboBoxInputWidget.
8722 * var comboBox = new OO.ui.ComboBoxInputWidget( {
8723 * label: 'ComboBoxInputWidget',
8724 * value: 'Option 1',
8725 * menu: {
8726 * items: [
8727 * new OO.ui.MenuOptionWidget( {
8728 * data: 'Option 1',
8729 * label: 'Option One'
8730 * } ),
8731 * new OO.ui.MenuOptionWidget( {
8732 * data: 'Option 2',
8733 * label: 'Option Two'
8734 * } ),
8735 * new OO.ui.MenuOptionWidget( {
8736 * data: 'Option 3',
8737 * label: 'Option Three'
8738 * } ),
8739 * new OO.ui.MenuOptionWidget( {
8740 * data: 'Option 4',
8741 * label: 'Option Four'
8742 * } ),
8743 * new OO.ui.MenuOptionWidget( {
8744 * data: 'Option 5',
8745 * label: 'Option Five'
8746 * } )
8747 * ]
8748 * }
8749 * } );
8750 * $( 'body' ).append( comboBox.$element );
8751 *
8752 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
8753 *
8754 * @class
8755 * @extends OO.ui.TextInputWidget
8756 *
8757 * @constructor
8758 * @param {Object} [config] Configuration options
8759 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
8760 * @cfg {Object} [menu] Configuration options to pass to the {@link OO.ui.FloatingMenuSelectWidget menu select widget}.
8761 * @cfg {jQuery} [$overlay] Render the menu into a separate layer. This configuration is useful in cases where
8762 * the expanded menu is larger than its containing `<div>`. The specified overlay layer is usually on top of the
8763 * containing `<div>` and has a larger area. By default, the menu uses relative positioning.
8764 */
8765 OO.ui.ComboBoxInputWidget = function OoUiComboBoxInputWidget( config ) {
8766 // Configuration initialization
8767 config = $.extend( {
8768 indicator: 'down',
8769 autocomplete: false
8770 }, config );
8771 // For backwards-compatibility with ComboBoxWidget config
8772 $.extend( config, config.input );
8773
8774 // Parent constructor
8775 OO.ui.ComboBoxInputWidget.parent.call( this, config );
8776
8777 // Properties
8778 this.$overlay = config.$overlay || this.$element;
8779 this.menu = new OO.ui.FloatingMenuSelectWidget( $.extend(
8780 {
8781 widget: this,
8782 input: this,
8783 $container: this.$element,
8784 disabled: this.isDisabled()
8785 },
8786 config.menu
8787 ) );
8788 // For backwards-compatibility with ComboBoxWidget
8789 this.input = this;
8790
8791 // Events
8792 this.$indicator.on( {
8793 click: this.onIndicatorClick.bind( this ),
8794 keypress: this.onIndicatorKeyPress.bind( this )
8795 } );
8796 this.connect( this, {
8797 change: 'onInputChange',
8798 enter: 'onInputEnter'
8799 } );
8800 this.menu.connect( this, {
8801 choose: 'onMenuChoose',
8802 add: 'onMenuItemsChange',
8803 remove: 'onMenuItemsChange'
8804 } );
8805
8806 // Initialization
8807 this.$input.attr( {
8808 role: 'combobox',
8809 'aria-autocomplete': 'list'
8810 } );
8811 // Do not override options set via config.menu.items
8812 if ( config.options !== undefined ) {
8813 this.setOptions( config.options );
8814 }
8815 // Extra class for backwards-compatibility with ComboBoxWidget
8816 this.$element.addClass( 'oo-ui-comboBoxInputWidget oo-ui-comboBoxWidget' );
8817 this.$overlay.append( this.menu.$element );
8818 this.onMenuItemsChange();
8819 };
8820
8821 /* Setup */
8822
8823 OO.inheritClass( OO.ui.ComboBoxInputWidget, OO.ui.TextInputWidget );
8824
8825 /* Methods */
8826
8827 /**
8828 * Get the combobox's menu.
8829 *
8830 * @return {OO.ui.FloatingMenuSelectWidget} Menu widget
8831 */
8832 OO.ui.ComboBoxInputWidget.prototype.getMenu = function () {
8833 return this.menu;
8834 };
8835
8836 /**
8837 * Get the combobox's text input widget.
8838 *
8839 * @return {OO.ui.TextInputWidget} Text input widget
8840 */
8841 OO.ui.ComboBoxInputWidget.prototype.getInput = function () {
8842 return this;
8843 };
8844
8845 /**
8846 * Handle input change events.
8847 *
8848 * @private
8849 * @param {string} value New value
8850 */
8851 OO.ui.ComboBoxInputWidget.prototype.onInputChange = function ( value ) {
8852 var match = this.menu.getItemFromData( value );
8853
8854 this.menu.selectItem( match );
8855 if ( this.menu.getHighlightedItem() ) {
8856 this.menu.highlightItem( match );
8857 }
8858
8859 if ( !this.isDisabled() ) {
8860 this.menu.toggle( true );
8861 }
8862 };
8863
8864 /**
8865 * Handle mouse click events.
8866 *
8867 * @private
8868 * @param {jQuery.Event} e Mouse click event
8869 */
8870 OO.ui.ComboBoxInputWidget.prototype.onIndicatorClick = function ( e ) {
8871 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
8872 this.menu.toggle();
8873 this.$input[ 0 ].focus();
8874 }
8875 return false;
8876 };
8877
8878 /**
8879 * Handle key press events.
8880 *
8881 * @private
8882 * @param {jQuery.Event} e Key press event
8883 */
8884 OO.ui.ComboBoxInputWidget.prototype.onIndicatorKeyPress = function ( e ) {
8885 if ( !this.isDisabled() && ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER ) ) {
8886 this.menu.toggle();
8887 this.$input[ 0 ].focus();
8888 return false;
8889 }
8890 };
8891
8892 /**
8893 * Handle input enter events.
8894 *
8895 * @private
8896 */
8897 OO.ui.ComboBoxInputWidget.prototype.onInputEnter = function () {
8898 if ( !this.isDisabled() ) {
8899 this.menu.toggle( false );
8900 }
8901 };
8902
8903 /**
8904 * Handle menu choose events.
8905 *
8906 * @private
8907 * @param {OO.ui.OptionWidget} item Chosen item
8908 */
8909 OO.ui.ComboBoxInputWidget.prototype.onMenuChoose = function ( item ) {
8910 this.setValue( item.getData() );
8911 };
8912
8913 /**
8914 * Handle menu item change events.
8915 *
8916 * @private
8917 */
8918 OO.ui.ComboBoxInputWidget.prototype.onMenuItemsChange = function () {
8919 var match = this.menu.getItemFromData( this.getValue() );
8920 this.menu.selectItem( match );
8921 if ( this.menu.getHighlightedItem() ) {
8922 this.menu.highlightItem( match );
8923 }
8924 this.$element.toggleClass( 'oo-ui-comboBoxInputWidget-empty', this.menu.isEmpty() );
8925 };
8926
8927 /**
8928 * @inheritdoc
8929 */
8930 OO.ui.ComboBoxInputWidget.prototype.setDisabled = function ( disabled ) {
8931 // Parent method
8932 OO.ui.ComboBoxInputWidget.parent.prototype.setDisabled.call( this, disabled );
8933
8934 if ( this.menu ) {
8935 this.menu.setDisabled( this.isDisabled() );
8936 }
8937
8938 return this;
8939 };
8940
8941 /**
8942 * Set the options available for this input.
8943 *
8944 * @param {Object[]} options Array of menu options in the format `{ data: …, label: … }`
8945 * @chainable
8946 */
8947 OO.ui.ComboBoxInputWidget.prototype.setOptions = function ( options ) {
8948 this.getMenu()
8949 .clearItems()
8950 .addItems( options.map( function ( opt ) {
8951 return new OO.ui.MenuOptionWidget( {
8952 data: opt.data,
8953 label: opt.label !== undefined ? opt.label : opt.data
8954 } );
8955 } ) );
8956
8957 return this;
8958 };
8959
8960 /**
8961 * @class
8962 * @deprecated since 0.13.2; use OO.ui.ComboBoxInputWidget instead
8963 */
8964 OO.ui.ComboBoxWidget = OO.ui.ComboBoxInputWidget;
8965
8966 /**
8967 * FieldLayouts are used with OO.ui.FieldsetLayout. Each FieldLayout requires a field-widget,
8968 * which is a widget that is specified by reference before any optional configuration settings.
8969 *
8970 * Field layouts can be configured with help text and/or labels. Labels are aligned in one of four ways:
8971 *
8972 * - **left**: The label is placed before the field-widget and aligned with the left margin.
8973 * A left-alignment is used for forms with many fields.
8974 * - **right**: The label is placed before the field-widget and aligned to the right margin.
8975 * A right-alignment is used for long but familiar forms which users tab through,
8976 * verifying the current field with a quick glance at the label.
8977 * - **top**: The label is placed above the field-widget. A top-alignment is used for brief forms
8978 * that users fill out from top to bottom.
8979 * - **inline**: The label is placed after the field-widget and aligned to the left.
8980 * An inline-alignment is best used with checkboxes or radio buttons.
8981 *
8982 * Help text is accessed via a help icon that appears in the upper right corner of the rendered field layout.
8983 * Please see the [OOjs UI documentation on MediaWiki] [1] for examples and more information.
8984 *
8985 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Layouts/Fields_and_Fieldsets
8986 *
8987 * @class
8988 * @extends OO.ui.Layout
8989 * @mixins OO.ui.mixin.LabelElement
8990 * @mixins OO.ui.mixin.TitledElement
8991 *
8992 * @constructor
8993 * @param {OO.ui.Widget} fieldWidget Field widget
8994 * @param {Object} [config] Configuration options
8995 * @cfg {string} [align='left'] Alignment of the label: 'left', 'right', 'top' or 'inline'
8996 * @cfg {Array} [errors] Error messages about the widget, which will be displayed below the widget.
8997 * The array may contain strings or OO.ui.HtmlSnippet instances.
8998 * @cfg {Array} [notices] Notices about the widget, which will be displayed below the widget.
8999 * The array may contain strings or OO.ui.HtmlSnippet instances.
9000 * @cfg {string|OO.ui.HtmlSnippet} [help] Help text. When help text is specified, a "help" icon will appear
9001 * in the upper-right corner of the rendered field; clicking it will display the text in a popup.
9002 * For important messages, you are advised to use `notices`, as they are always shown.
9003 *
9004 * @throws {Error} An error is thrown if no widget is specified
9005 */
9006 OO.ui.FieldLayout = function OoUiFieldLayout( fieldWidget, config ) {
9007 var hasInputWidget, div;
9008
9009 // Allow passing positional parameters inside the config object
9010 if ( OO.isPlainObject( fieldWidget ) && config === undefined ) {
9011 config = fieldWidget;
9012 fieldWidget = config.fieldWidget;
9013 }
9014
9015 // Make sure we have required constructor arguments
9016 if ( fieldWidget === undefined ) {
9017 throw new Error( 'Widget not found' );
9018 }
9019
9020 hasInputWidget = fieldWidget.constructor.static.supportsSimpleLabel;
9021
9022 // Configuration initialization
9023 config = $.extend( { align: 'left' }, config );
9024
9025 // Parent constructor
9026 OO.ui.FieldLayout.parent.call( this, config );
9027
9028 // Mixin constructors
9029 OO.ui.mixin.LabelElement.call( this, config );
9030 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$label } ) );
9031
9032 // Properties
9033 this.fieldWidget = fieldWidget;
9034 this.errors = [];
9035 this.notices = [];
9036 this.$field = $( '<div>' );
9037 this.$messages = $( '<ul>' );
9038 this.$body = $( '<' + ( hasInputWidget ? 'label' : 'div' ) + '>' );
9039 this.align = null;
9040 if ( config.help ) {
9041 this.popupButtonWidget = new OO.ui.PopupButtonWidget( {
9042 classes: [ 'oo-ui-fieldLayout-help' ],
9043 framed: false,
9044 icon: 'info'
9045 } );
9046
9047 div = $( '<div>' );
9048 if ( config.help instanceof OO.ui.HtmlSnippet ) {
9049 div.html( config.help.toString() );
9050 } else {
9051 div.text( config.help );
9052 }
9053 this.popupButtonWidget.getPopup().$body.append(
9054 div.addClass( 'oo-ui-fieldLayout-help-content' )
9055 );
9056 this.$help = this.popupButtonWidget.$element;
9057 } else {
9058 this.$help = $( [] );
9059 }
9060
9061 // Events
9062 if ( hasInputWidget ) {
9063 this.$label.on( 'click', this.onLabelClick.bind( this ) );
9064 }
9065 this.fieldWidget.connect( this, { disable: 'onFieldDisable' } );
9066
9067 // Initialization
9068 this.$element
9069 .addClass( 'oo-ui-fieldLayout' )
9070 .append( this.$help, this.$body );
9071 this.$body.addClass( 'oo-ui-fieldLayout-body' );
9072 this.$messages.addClass( 'oo-ui-fieldLayout-messages' );
9073 this.$field
9074 .addClass( 'oo-ui-fieldLayout-field' )
9075 .toggleClass( 'oo-ui-fieldLayout-disable', this.fieldWidget.isDisabled() )
9076 .append( this.fieldWidget.$element );
9077
9078 this.setErrors( config.errors || [] );
9079 this.setNotices( config.notices || [] );
9080 this.setAlignment( config.align );
9081 };
9082
9083 /* Setup */
9084
9085 OO.inheritClass( OO.ui.FieldLayout, OO.ui.Layout );
9086 OO.mixinClass( OO.ui.FieldLayout, OO.ui.mixin.LabelElement );
9087 OO.mixinClass( OO.ui.FieldLayout, OO.ui.mixin.TitledElement );
9088
9089 /* Methods */
9090
9091 /**
9092 * Handle field disable events.
9093 *
9094 * @private
9095 * @param {boolean} value Field is disabled
9096 */
9097 OO.ui.FieldLayout.prototype.onFieldDisable = function ( value ) {
9098 this.$element.toggleClass( 'oo-ui-fieldLayout-disabled', value );
9099 };
9100
9101 /**
9102 * Handle label mouse click events.
9103 *
9104 * @private
9105 * @param {jQuery.Event} e Mouse click event
9106 */
9107 OO.ui.FieldLayout.prototype.onLabelClick = function () {
9108 this.fieldWidget.simulateLabelClick();
9109 return false;
9110 };
9111
9112 /**
9113 * Get the widget contained by the field.
9114 *
9115 * @return {OO.ui.Widget} Field widget
9116 */
9117 OO.ui.FieldLayout.prototype.getField = function () {
9118 return this.fieldWidget;
9119 };
9120
9121 /**
9122 * @protected
9123 * @param {string} kind 'error' or 'notice'
9124 * @param {string|OO.ui.HtmlSnippet} text
9125 * @return {jQuery}
9126 */
9127 OO.ui.FieldLayout.prototype.makeMessage = function ( kind, text ) {
9128 var $listItem, $icon, message;
9129 $listItem = $( '<li>' );
9130 if ( kind === 'error' ) {
9131 $icon = new OO.ui.IconWidget( { icon: 'alert', flags: [ 'warning' ] } ).$element;
9132 } else if ( kind === 'notice' ) {
9133 $icon = new OO.ui.IconWidget( { icon: 'info' } ).$element;
9134 } else {
9135 $icon = '';
9136 }
9137 message = new OO.ui.LabelWidget( { label: text } );
9138 $listItem
9139 .append( $icon, message.$element )
9140 .addClass( 'oo-ui-fieldLayout-messages-' + kind );
9141 return $listItem;
9142 };
9143
9144 /**
9145 * Set the field alignment mode.
9146 *
9147 * @private
9148 * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
9149 * @chainable
9150 */
9151 OO.ui.FieldLayout.prototype.setAlignment = function ( value ) {
9152 if ( value !== this.align ) {
9153 // Default to 'left'
9154 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value ) === -1 ) {
9155 value = 'left';
9156 }
9157 // Reorder elements
9158 if ( value === 'inline' ) {
9159 this.$body.append( this.$field, this.$label );
9160 } else {
9161 this.$body.append( this.$label, this.$field );
9162 }
9163 // Set classes. The following classes can be used here:
9164 // * oo-ui-fieldLayout-align-left
9165 // * oo-ui-fieldLayout-align-right
9166 // * oo-ui-fieldLayout-align-top
9167 // * oo-ui-fieldLayout-align-inline
9168 if ( this.align ) {
9169 this.$element.removeClass( 'oo-ui-fieldLayout-align-' + this.align );
9170 }
9171 this.$element.addClass( 'oo-ui-fieldLayout-align-' + value );
9172 this.align = value;
9173 }
9174
9175 return this;
9176 };
9177
9178 /**
9179 * Set the list of error messages.
9180 *
9181 * @param {Array} errors Error messages about the widget, which will be displayed below the widget.
9182 * The array may contain strings or OO.ui.HtmlSnippet instances.
9183 * @chainable
9184 */
9185 OO.ui.FieldLayout.prototype.setErrors = function ( errors ) {
9186 this.errors = errors.slice();
9187 this.updateMessages();
9188 return this;
9189 };
9190
9191 /**
9192 * Set the list of notice messages.
9193 *
9194 * @param {Array} notices Notices about the widget, which will be displayed below the widget.
9195 * The array may contain strings or OO.ui.HtmlSnippet instances.
9196 * @chainable
9197 */
9198 OO.ui.FieldLayout.prototype.setNotices = function ( notices ) {
9199 this.notices = notices.slice();
9200 this.updateMessages();
9201 return this;
9202 };
9203
9204 /**
9205 * Update the rendering of error and notice messages.
9206 *
9207 * @private
9208 */
9209 OO.ui.FieldLayout.prototype.updateMessages = function () {
9210 var i;
9211 this.$messages.empty();
9212
9213 if ( this.errors.length || this.notices.length ) {
9214 this.$body.after( this.$messages );
9215 } else {
9216 this.$messages.remove();
9217 return;
9218 }
9219
9220 for ( i = 0; i < this.notices.length; i++ ) {
9221 this.$messages.append( this.makeMessage( 'notice', this.notices[ i ] ) );
9222 }
9223 for ( i = 0; i < this.errors.length; i++ ) {
9224 this.$messages.append( this.makeMessage( 'error', this.errors[ i ] ) );
9225 }
9226 };
9227
9228 /**
9229 * ActionFieldLayouts are used with OO.ui.FieldsetLayout. The layout consists of a field-widget, a button,
9230 * and an optional label and/or help text. The field-widget (e.g., a {@link OO.ui.TextInputWidget TextInputWidget}),
9231 * is required and is specified before any optional configuration settings.
9232 *
9233 * Labels can be aligned in one of four ways:
9234 *
9235 * - **left**: The label is placed before the field-widget and aligned with the left margin.
9236 * A left-alignment is used for forms with many fields.
9237 * - **right**: The label is placed before the field-widget and aligned to the right margin.
9238 * A right-alignment is used for long but familiar forms which users tab through,
9239 * verifying the current field with a quick glance at the label.
9240 * - **top**: The label is placed above the field-widget. A top-alignment is used for brief forms
9241 * that users fill out from top to bottom.
9242 * - **inline**: The label is placed after the field-widget and aligned to the left.
9243 * An inline-alignment is best used with checkboxes or radio buttons.
9244 *
9245 * Help text is accessed via a help icon that appears in the upper right corner of the rendered field layout when help
9246 * text is specified.
9247 *
9248 * @example
9249 * // Example of an ActionFieldLayout
9250 * var actionFieldLayout = new OO.ui.ActionFieldLayout(
9251 * new OO.ui.TextInputWidget( {
9252 * placeholder: 'Field widget'
9253 * } ),
9254 * new OO.ui.ButtonWidget( {
9255 * label: 'Button'
9256 * } ),
9257 * {
9258 * label: 'An ActionFieldLayout. This label is aligned top',
9259 * align: 'top',
9260 * help: 'This is help text'
9261 * }
9262 * );
9263 *
9264 * $( 'body' ).append( actionFieldLayout.$element );
9265 *
9266 * @class
9267 * @extends OO.ui.FieldLayout
9268 *
9269 * @constructor
9270 * @param {OO.ui.Widget} fieldWidget Field widget
9271 * @param {OO.ui.ButtonWidget} buttonWidget Button widget
9272 */
9273 OO.ui.ActionFieldLayout = function OoUiActionFieldLayout( fieldWidget, buttonWidget, config ) {
9274 // Allow passing positional parameters inside the config object
9275 if ( OO.isPlainObject( fieldWidget ) && config === undefined ) {
9276 config = fieldWidget;
9277 fieldWidget = config.fieldWidget;
9278 buttonWidget = config.buttonWidget;
9279 }
9280
9281 // Parent constructor
9282 OO.ui.ActionFieldLayout.parent.call( this, fieldWidget, config );
9283
9284 // Properties
9285 this.buttonWidget = buttonWidget;
9286 this.$button = $( '<div>' );
9287 this.$input = $( '<div>' );
9288
9289 // Initialization
9290 this.$element
9291 .addClass( 'oo-ui-actionFieldLayout' );
9292 this.$button
9293 .addClass( 'oo-ui-actionFieldLayout-button' )
9294 .append( this.buttonWidget.$element );
9295 this.$input
9296 .addClass( 'oo-ui-actionFieldLayout-input' )
9297 .append( this.fieldWidget.$element );
9298 this.$field
9299 .append( this.$input, this.$button );
9300 };
9301
9302 /* Setup */
9303
9304 OO.inheritClass( OO.ui.ActionFieldLayout, OO.ui.FieldLayout );
9305
9306 /**
9307 * FieldsetLayouts are composed of one or more {@link OO.ui.FieldLayout FieldLayouts},
9308 * which each contain an individual widget and, optionally, a label. Each Fieldset can be
9309 * configured with a label as well. For more information and examples,
9310 * please see the [OOjs UI documentation on MediaWiki][1].
9311 *
9312 * @example
9313 * // Example of a fieldset layout
9314 * var input1 = new OO.ui.TextInputWidget( {
9315 * placeholder: 'A text input field'
9316 * } );
9317 *
9318 * var input2 = new OO.ui.TextInputWidget( {
9319 * placeholder: 'A text input field'
9320 * } );
9321 *
9322 * var fieldset = new OO.ui.FieldsetLayout( {
9323 * label: 'Example of a fieldset layout'
9324 * } );
9325 *
9326 * fieldset.addItems( [
9327 * new OO.ui.FieldLayout( input1, {
9328 * label: 'Field One'
9329 * } ),
9330 * new OO.ui.FieldLayout( input2, {
9331 * label: 'Field Two'
9332 * } )
9333 * ] );
9334 * $( 'body' ).append( fieldset.$element );
9335 *
9336 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Layouts/Fields_and_Fieldsets
9337 *
9338 * @class
9339 * @extends OO.ui.Layout
9340 * @mixins OO.ui.mixin.IconElement
9341 * @mixins OO.ui.mixin.LabelElement
9342 * @mixins OO.ui.mixin.GroupElement
9343 *
9344 * @constructor
9345 * @param {Object} [config] Configuration options
9346 * @cfg {OO.ui.FieldLayout[]} [items] An array of fields to add to the fieldset. See OO.ui.FieldLayout for more information about fields.
9347 */
9348 OO.ui.FieldsetLayout = function OoUiFieldsetLayout( config ) {
9349 // Configuration initialization
9350 config = config || {};
9351
9352 // Parent constructor
9353 OO.ui.FieldsetLayout.parent.call( this, config );
9354
9355 // Mixin constructors
9356 OO.ui.mixin.IconElement.call( this, config );
9357 OO.ui.mixin.LabelElement.call( this, config );
9358 OO.ui.mixin.GroupElement.call( this, config );
9359
9360 if ( config.help ) {
9361 this.popupButtonWidget = new OO.ui.PopupButtonWidget( {
9362 classes: [ 'oo-ui-fieldsetLayout-help' ],
9363 framed: false,
9364 icon: 'info'
9365 } );
9366
9367 this.popupButtonWidget.getPopup().$body.append(
9368 $( '<div>' )
9369 .text( config.help )
9370 .addClass( 'oo-ui-fieldsetLayout-help-content' )
9371 );
9372 this.$help = this.popupButtonWidget.$element;
9373 } else {
9374 this.$help = $( [] );
9375 }
9376
9377 // Initialization
9378 this.$element
9379 .addClass( 'oo-ui-fieldsetLayout' )
9380 .prepend( this.$help, this.$icon, this.$label, this.$group );
9381 if ( Array.isArray( config.items ) ) {
9382 this.addItems( config.items );
9383 }
9384 };
9385
9386 /* Setup */
9387
9388 OO.inheritClass( OO.ui.FieldsetLayout, OO.ui.Layout );
9389 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.mixin.IconElement );
9390 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.mixin.LabelElement );
9391 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.mixin.GroupElement );
9392
9393 /**
9394 * FormLayouts are used to wrap {@link OO.ui.FieldsetLayout FieldsetLayouts} when you intend to use browser-based
9395 * form submission for the fields instead of handling them in JavaScript. Form layouts can be configured with an
9396 * HTML form action, an encoding type, and a method using the #action, #enctype, and #method configs, respectively.
9397 * See the [OOjs UI documentation on MediaWiki] [1] for more information and examples.
9398 *
9399 * Only widgets from the {@link OO.ui.InputWidget InputWidget} family support form submission. It
9400 * includes standard form elements like {@link OO.ui.CheckboxInputWidget checkboxes}, {@link
9401 * OO.ui.RadioInputWidget radio buttons} and {@link OO.ui.TextInputWidget text fields}, as well as
9402 * some fancier controls. Some controls have both regular and InputWidget variants, for example
9403 * OO.ui.DropdownWidget and OO.ui.DropdownInputWidget – only the latter support form submission and
9404 * often have simplified APIs to match the capabilities of HTML forms.
9405 * See the [OOjs UI Inputs documentation on MediaWiki] [2] for more information about InputWidgets.
9406 *
9407 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Layouts/Forms
9408 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
9409 *
9410 * @example
9411 * // Example of a form layout that wraps a fieldset layout
9412 * var input1 = new OO.ui.TextInputWidget( {
9413 * placeholder: 'Username'
9414 * } );
9415 * var input2 = new OO.ui.TextInputWidget( {
9416 * placeholder: 'Password',
9417 * type: 'password'
9418 * } );
9419 * var submit = new OO.ui.ButtonInputWidget( {
9420 * label: 'Submit'
9421 * } );
9422 *
9423 * var fieldset = new OO.ui.FieldsetLayout( {
9424 * label: 'A form layout'
9425 * } );
9426 * fieldset.addItems( [
9427 * new OO.ui.FieldLayout( input1, {
9428 * label: 'Username',
9429 * align: 'top'
9430 * } ),
9431 * new OO.ui.FieldLayout( input2, {
9432 * label: 'Password',
9433 * align: 'top'
9434 * } ),
9435 * new OO.ui.FieldLayout( submit )
9436 * ] );
9437 * var form = new OO.ui.FormLayout( {
9438 * items: [ fieldset ],
9439 * action: '/api/formhandler',
9440 * method: 'get'
9441 * } )
9442 * $( 'body' ).append( form.$element );
9443 *
9444 * @class
9445 * @extends OO.ui.Layout
9446 * @mixins OO.ui.mixin.GroupElement
9447 *
9448 * @constructor
9449 * @param {Object} [config] Configuration options
9450 * @cfg {string} [method] HTML form `method` attribute
9451 * @cfg {string} [action] HTML form `action` attribute
9452 * @cfg {string} [enctype] HTML form `enctype` attribute
9453 * @cfg {OO.ui.FieldsetLayout[]} [items] Fieldset layouts to add to the form layout.
9454 */
9455 OO.ui.FormLayout = function OoUiFormLayout( config ) {
9456 var action;
9457
9458 // Configuration initialization
9459 config = config || {};
9460
9461 // Parent constructor
9462 OO.ui.FormLayout.parent.call( this, config );
9463
9464 // Mixin constructors
9465 OO.ui.mixin.GroupElement.call( this, $.extend( {}, config, { $group: this.$element } ) );
9466
9467 // Events
9468 this.$element.on( 'submit', this.onFormSubmit.bind( this ) );
9469
9470 // Make sure the action is safe
9471 action = config.action;
9472 if ( action !== undefined && !OO.ui.isSafeUrl( action ) ) {
9473 action = './' + action;
9474 }
9475
9476 // Initialization
9477 this.$element
9478 .addClass( 'oo-ui-formLayout' )
9479 .attr( {
9480 method: config.method,
9481 action: action,
9482 enctype: config.enctype
9483 } );
9484 if ( Array.isArray( config.items ) ) {
9485 this.addItems( config.items );
9486 }
9487 };
9488
9489 /* Setup */
9490
9491 OO.inheritClass( OO.ui.FormLayout, OO.ui.Layout );
9492 OO.mixinClass( OO.ui.FormLayout, OO.ui.mixin.GroupElement );
9493
9494 /* Events */
9495
9496 /**
9497 * A 'submit' event is emitted when the form is submitted.
9498 *
9499 * @event submit
9500 */
9501
9502 /* Static Properties */
9503
9504 OO.ui.FormLayout.static.tagName = 'form';
9505
9506 /* Methods */
9507
9508 /**
9509 * Handle form submit events.
9510 *
9511 * @private
9512 * @param {jQuery.Event} e Submit event
9513 * @fires submit
9514 */
9515 OO.ui.FormLayout.prototype.onFormSubmit = function () {
9516 if ( this.emit( 'submit' ) ) {
9517 return false;
9518 }
9519 };
9520
9521 /**
9522 * PanelLayouts expand to cover the entire area of their parent. They can be configured with scrolling, padding,
9523 * and a frame, and are often used together with {@link OO.ui.StackLayout StackLayouts}.
9524 *
9525 * @example
9526 * // Example of a panel layout
9527 * var panel = new OO.ui.PanelLayout( {
9528 * expanded: false,
9529 * framed: true,
9530 * padded: true,
9531 * $content: $( '<p>A panel layout with padding and a frame.</p>' )
9532 * } );
9533 * $( 'body' ).append( panel.$element );
9534 *
9535 * @class
9536 * @extends OO.ui.Layout
9537 *
9538 * @constructor
9539 * @param {Object} [config] Configuration options
9540 * @cfg {boolean} [scrollable=false] Allow vertical scrolling
9541 * @cfg {boolean} [padded=false] Add padding between the content and the edges of the panel.
9542 * @cfg {boolean} [expanded=true] Expand the panel to fill the entire parent element.
9543 * @cfg {boolean} [framed=false] Render the panel with a frame to visually separate it from outside content.
9544 */
9545 OO.ui.PanelLayout = function OoUiPanelLayout( config ) {
9546 // Configuration initialization
9547 config = $.extend( {
9548 scrollable: false,
9549 padded: false,
9550 expanded: true,
9551 framed: false
9552 }, config );
9553
9554 // Parent constructor
9555 OO.ui.PanelLayout.parent.call( this, config );
9556
9557 // Initialization
9558 this.$element.addClass( 'oo-ui-panelLayout' );
9559 if ( config.scrollable ) {
9560 this.$element.addClass( 'oo-ui-panelLayout-scrollable' );
9561 }
9562 if ( config.padded ) {
9563 this.$element.addClass( 'oo-ui-panelLayout-padded' );
9564 }
9565 if ( config.expanded ) {
9566 this.$element.addClass( 'oo-ui-panelLayout-expanded' );
9567 }
9568 if ( config.framed ) {
9569 this.$element.addClass( 'oo-ui-panelLayout-framed' );
9570 }
9571 };
9572
9573 /* Setup */
9574
9575 OO.inheritClass( OO.ui.PanelLayout, OO.ui.Layout );
9576
9577 /* Methods */
9578
9579 /**
9580 * Focus the panel layout
9581 *
9582 * The default implementation just focuses the first focusable element in the panel
9583 */
9584 OO.ui.PanelLayout.prototype.focus = function () {
9585 OO.ui.findFocusable( this.$element ).focus();
9586 };
9587
9588 /**
9589 * HorizontalLayout arranges its contents in a single line (using `display: inline-block` for its
9590 * items), with small margins between them. Convenient when you need to put a number of block-level
9591 * widgets on a single line next to each other.
9592 *
9593 * Note that inline elements, such as OO.ui.ButtonWidgets, do not need this wrapper.
9594 *
9595 * @example
9596 * // HorizontalLayout with a text input and a label
9597 * var layout = new OO.ui.HorizontalLayout( {
9598 * items: [
9599 * new OO.ui.LabelWidget( { label: 'Label' } ),
9600 * new OO.ui.TextInputWidget( { value: 'Text' } )
9601 * ]
9602 * } );
9603 * $( 'body' ).append( layout.$element );
9604 *
9605 * @class
9606 * @extends OO.ui.Layout
9607 * @mixins OO.ui.mixin.GroupElement
9608 *
9609 * @constructor
9610 * @param {Object} [config] Configuration options
9611 * @cfg {OO.ui.Widget[]|OO.ui.Layout[]} [items] Widgets or other layouts to add to the layout.
9612 */
9613 OO.ui.HorizontalLayout = function OoUiHorizontalLayout( config ) {
9614 // Configuration initialization
9615 config = config || {};
9616
9617 // Parent constructor
9618 OO.ui.HorizontalLayout.parent.call( this, config );
9619
9620 // Mixin constructors
9621 OO.ui.mixin.GroupElement.call( this, $.extend( {}, config, { $group: this.$element } ) );
9622
9623 // Initialization
9624 this.$element.addClass( 'oo-ui-horizontalLayout' );
9625 if ( Array.isArray( config.items ) ) {
9626 this.addItems( config.items );
9627 }
9628 };
9629
9630 /* Setup */
9631
9632 OO.inheritClass( OO.ui.HorizontalLayout, OO.ui.Layout );
9633 OO.mixinClass( OO.ui.HorizontalLayout, OO.ui.mixin.GroupElement );
9634
9635 }( OO ) );