Merge "HTML escape parameter 'text' of hook 'SkinEditSectionLinks'"
[lhc/web/wiklou.git] / resources / lib / ooui / oojs-ui-core.js
1 /*!
2 * OOUI v0.31.6
3 * https://www.mediawiki.org/wiki/OOUI
4 *
5 * Copyright 2011–2019 OOUI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
8 *
9 * Date: 2019-05-08T10:08:36Z
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 * @private
61 */
62 OO.ui.elementId = 0;
63
64 /**
65 * Generate a unique ID for element
66 *
67 * @return {string} ID
68 */
69 OO.ui.generateElementId = function () {
70 OO.ui.elementId++;
71 return 'ooui-' + OO.ui.elementId;
72 };
73
74 /**
75 * Check if an element is focusable.
76 * Inspired by :focusable in jQueryUI v1.11.4 - 2015-04-14
77 *
78 * @param {jQuery} $element Element to test
79 * @return {boolean} Element is focusable
80 */
81 OO.ui.isFocusableElement = function ( $element ) {
82 var nodeName,
83 element = $element[ 0 ];
84
85 // Anything disabled is not focusable
86 if ( element.disabled ) {
87 return false;
88 }
89
90 // Check if the element is visible
91 if ( !(
92 // This is quicker than calling $element.is( ':visible' )
93 $.expr.pseudos.visible( element ) &&
94 // Check that all parents are visible
95 !$element.parents().addBack().filter( function () {
96 return $.css( this, 'visibility' ) === 'hidden';
97 } ).length
98 ) ) {
99 return false;
100 }
101
102 // Check if the element is ContentEditable, which is the string 'true'
103 if ( element.contentEditable === 'true' ) {
104 return true;
105 }
106
107 // Anything with a non-negative numeric tabIndex is focusable.
108 // Use .prop to avoid browser bugs
109 if ( $element.prop( 'tabIndex' ) >= 0 ) {
110 return true;
111 }
112
113 // Some element types are naturally focusable
114 // (indexOf is much faster than regex in Chrome and about the
115 // same in FF: https://jsperf.com/regex-vs-indexof-array2)
116 nodeName = element.nodeName.toLowerCase();
117 if ( [ 'input', 'select', 'textarea', 'button', 'object' ].indexOf( nodeName ) !== -1 ) {
118 return true;
119 }
120
121 // Links and areas are focusable if they have an href
122 if ( ( nodeName === 'a' || nodeName === 'area' ) && $element.attr( 'href' ) !== undefined ) {
123 return true;
124 }
125
126 return false;
127 };
128
129 /**
130 * Find a focusable child.
131 *
132 * @param {jQuery} $container Container to search in
133 * @param {boolean} [backwards] Search backwards
134 * @return {jQuery} Focusable child, or an empty jQuery object if none found
135 */
136 OO.ui.findFocusable = function ( $container, backwards ) {
137 var $focusable = $( [] ),
138 // $focusableCandidates is a superset of things that
139 // could get matched by isFocusableElement
140 $focusableCandidates = $container
141 .find( 'input, select, textarea, button, object, a, area, [contenteditable], [tabindex]' );
142
143 if ( backwards ) {
144 $focusableCandidates = Array.prototype.reverse.call( $focusableCandidates );
145 }
146
147 $focusableCandidates.each( function () {
148 var $this = $( this );
149 if ( OO.ui.isFocusableElement( $this ) ) {
150 $focusable = $this;
151 return false;
152 }
153 } );
154 return $focusable;
155 };
156
157 /**
158 * Get the user's language and any fallback languages.
159 *
160 * These language codes are used to localize user interface elements in the user's language.
161 *
162 * In environments that provide a localization system, this function should be overridden to
163 * return the user's language(s). The default implementation returns English (en) only.
164 *
165 * @return {string[]} Language codes, in descending order of priority
166 */
167 OO.ui.getUserLanguages = function () {
168 return [ 'en' ];
169 };
170
171 /**
172 * Get a value in an object keyed by language code.
173 *
174 * @param {Object.<string,Mixed>} obj Object keyed by language code
175 * @param {string|null} [lang] Language code, if omitted or null defaults to any user language
176 * @param {string} [fallback] Fallback code, used if no matching language can be found
177 * @return {Mixed} Local value
178 */
179 OO.ui.getLocalValue = function ( obj, lang, fallback ) {
180 var i, len, langs;
181
182 // Requested language
183 if ( obj[ lang ] ) {
184 return obj[ lang ];
185 }
186 // Known user language
187 langs = OO.ui.getUserLanguages();
188 for ( i = 0, len = langs.length; i < len; i++ ) {
189 lang = langs[ i ];
190 if ( obj[ lang ] ) {
191 return obj[ lang ];
192 }
193 }
194 // Fallback language
195 if ( obj[ fallback ] ) {
196 return obj[ fallback ];
197 }
198 // First existing language
199 for ( lang in obj ) {
200 return obj[ lang ];
201 }
202
203 return undefined;
204 };
205
206 /**
207 * Check if a node is contained within another node.
208 *
209 * Similar to jQuery#contains except a list of containers can be supplied
210 * and a boolean argument allows you to include the container in the match list
211 *
212 * @param {HTMLElement|HTMLElement[]} containers Container node(s) to search in
213 * @param {HTMLElement} contained Node to find
214 * @param {boolean} [matchContainers] Include the container(s) in the list of nodes to match,
215 * otherwise only match descendants
216 * @return {boolean} The node is in the list of target nodes
217 */
218 OO.ui.contains = function ( containers, contained, matchContainers ) {
219 var i;
220 if ( !Array.isArray( containers ) ) {
221 containers = [ containers ];
222 }
223 for ( i = containers.length - 1; i >= 0; i-- ) {
224 if (
225 ( matchContainers && contained === containers[ i ] ) ||
226 $.contains( containers[ i ], contained )
227 ) {
228 return true;
229 }
230 }
231 return false;
232 };
233
234 /**
235 * Return a function, that, as long as it continues to be invoked, will not
236 * be triggered. The function will be called after it stops being called for
237 * N milliseconds. If `immediate` is passed, trigger the function on the
238 * leading edge, instead of the trailing.
239 *
240 * Ported from: http://underscorejs.org/underscore.js
241 *
242 * @param {Function} func Function to debounce
243 * @param {number} [wait=0] Wait period in milliseconds
244 * @param {boolean} [immediate] Trigger on leading edge
245 * @return {Function} Debounced function
246 */
247 OO.ui.debounce = function ( func, wait, immediate ) {
248 var timeout;
249 return function () {
250 var context = this,
251 args = arguments,
252 later = function () {
253 timeout = null;
254 if ( !immediate ) {
255 func.apply( context, args );
256 }
257 };
258 if ( immediate && !timeout ) {
259 func.apply( context, args );
260 }
261 if ( !timeout || wait ) {
262 clearTimeout( timeout );
263 timeout = setTimeout( later, wait );
264 }
265 };
266 };
267
268 /**
269 * Puts a console warning with provided message.
270 *
271 * @param {string} message Message
272 */
273 OO.ui.warnDeprecation = function ( message ) {
274 if ( OO.getProp( window, 'console', 'warn' ) !== undefined ) {
275 // eslint-disable-next-line no-console
276 console.warn( message );
277 }
278 };
279
280 /**
281 * Returns a function, that, when invoked, will only be triggered at most once
282 * during a given window of time. If called again during that window, it will
283 * wait until the window ends and then trigger itself again.
284 *
285 * As it's not knowable to the caller whether the function will actually run
286 * when the wrapper is called, return values from the function are entirely
287 * discarded.
288 *
289 * @param {Function} func Function to throttle
290 * @param {number} wait Throttle window length, in milliseconds
291 * @return {Function} Throttled function
292 */
293 OO.ui.throttle = function ( func, wait ) {
294 var context, args, timeout,
295 previous = 0,
296 run = function () {
297 timeout = null;
298 previous = Date.now();
299 func.apply( context, args );
300 };
301 return function () {
302 // Check how long it's been since the last time the function was
303 // called, and whether it's more or less than the requested throttle
304 // period. If it's less, run the function immediately. If it's more,
305 // set a timeout for the remaining time -- but don't replace an
306 // existing timeout, since that'd indefinitely prolong the wait.
307 var remaining = wait - ( Date.now() - previous );
308 context = this;
309 args = arguments;
310 if ( remaining <= 0 ) {
311 // Note: unless wait was ridiculously large, this means we'll
312 // automatically run the first time the function was called in a
313 // given period. (If you provide a wait period larger than the
314 // current Unix timestamp, you *deserve* unexpected behavior.)
315 clearTimeout( timeout );
316 run();
317 } else if ( !timeout ) {
318 timeout = setTimeout( run, remaining );
319 }
320 };
321 };
322
323 /**
324 * A (possibly faster) way to get the current timestamp as an integer.
325 *
326 * @deprecated Since 0.31.1; use `Date.now()` instead.
327 * @return {number} Current timestamp, in milliseconds since the Unix epoch
328 */
329 OO.ui.now = function () {
330 OO.ui.warnDeprecation( 'OO.ui.now() is deprecated, use Date.now() instead' );
331 return Date.now();
332 };
333
334 /**
335 * Reconstitute a JavaScript object corresponding to a widget created by
336 * the PHP implementation.
337 *
338 * This is an alias for `OO.ui.Element.static.infuse()`.
339 *
340 * @param {string|HTMLElement|jQuery} idOrNode
341 * A DOM id (if a string) or node for the widget to infuse.
342 * @param {Object} [config] Configuration options
343 * @return {OO.ui.Element}
344 * The `OO.ui.Element` corresponding to this (infusable) document node.
345 */
346 OO.ui.infuse = function ( idOrNode, config ) {
347 return OO.ui.Element.static.infuse( idOrNode, config );
348 };
349
350 /**
351 * Get a localized message.
352 *
353 * After the message key, message parameters may optionally be passed. In the default
354 * implementation, any occurrences of $1 are replaced with the first parameter, $2 with the
355 * second parameter, etc.
356 * Alternative implementations of OO.ui.msg may use any substitution system they like, as long
357 * as they support unnamed, ordered message parameters.
358 *
359 * In environments that provide a localization system, this function should be overridden to
360 * return the message translated in the user's language. The default implementation always
361 * returns English messages. An example of doing this with
362 * [jQuery.i18n](https://github.com/wikimedia/jquery.i18n) follows.
363 *
364 * @example
365 * var i, iLen, button,
366 * messagePath = 'oojs-ui/dist/i18n/',
367 * languages = [ $.i18n().locale, 'ur', 'en' ],
368 * languageMap = {};
369 *
370 * for ( i = 0, iLen = languages.length; i < iLen; i++ ) {
371 * languageMap[ languages[ i ] ] = messagePath + languages[ i ].toLowerCase() + '.json';
372 * }
373 *
374 * $.i18n().load( languageMap ).done( function() {
375 * // Replace the built-in `msg` only once we've loaded the internationalization.
376 * // OOUI uses `OO.ui.deferMsg` for all initially-loaded messages. So long as
377 * // you put off creating any widgets until this promise is complete, no English
378 * // will be displayed.
379 * OO.ui.msg = $.i18n;
380 *
381 * // A button displaying "OK" in the default locale
382 * button = new OO.ui.ButtonWidget( {
383 * label: OO.ui.msg( 'ooui-dialog-message-accept' ),
384 * icon: 'check'
385 * } );
386 * $( document.body ).append( button.$element );
387 *
388 * // A button displaying "OK" in Urdu
389 * $.i18n().locale = 'ur';
390 * button = new OO.ui.ButtonWidget( {
391 * label: OO.ui.msg( 'ooui-dialog-message-accept' ),
392 * icon: 'check'
393 * } );
394 * $( document.body ).append( button.$element );
395 * } );
396 *
397 * @param {string} key Message key
398 * @param {...Mixed} [params] Message parameters
399 * @return {string} Translated message with parameters substituted
400 */
401 OO.ui.msg = function ( key ) {
402 // `OO.ui.msg.messages` is defined in code generated during the build process
403 var messages = OO.ui.msg.messages,
404 message = messages[ key ],
405 params = Array.prototype.slice.call( arguments, 1 );
406 if ( typeof message === 'string' ) {
407 // Perform $1 substitution
408 message = message.replace( /\$(\d+)/g, function ( unused, n ) {
409 var i = parseInt( n, 10 );
410 return params[ i - 1 ] !== undefined ? params[ i - 1 ] : '$' + n;
411 } );
412 } else {
413 // Return placeholder if message not found
414 message = '[' + key + ']';
415 }
416 return message;
417 };
418
419 /**
420 * Package a message and arguments for deferred resolution.
421 *
422 * Use this when you are statically specifying a message and the message may not yet be present.
423 *
424 * @param {string} key Message key
425 * @param {...Mixed} [params] Message parameters
426 * @return {Function} Function that returns the resolved message when executed
427 */
428 OO.ui.deferMsg = function () {
429 var args = arguments;
430 return function () {
431 return OO.ui.msg.apply( OO.ui, args );
432 };
433 };
434
435 /**
436 * Resolve a message.
437 *
438 * If the message is a function it will be executed, otherwise it will pass through directly.
439 *
440 * @param {Function|string} msg Deferred message, or message text
441 * @return {string} Resolved message
442 */
443 OO.ui.resolveMsg = function ( msg ) {
444 if ( typeof msg === 'function' ) {
445 return msg();
446 }
447 return msg;
448 };
449
450 /**
451 * @param {string} url
452 * @return {boolean}
453 */
454 OO.ui.isSafeUrl = function ( url ) {
455 // Keep this function in sync with php/Tag.php
456 var i, protocolWhitelist;
457
458 function stringStartsWith( haystack, needle ) {
459 return haystack.substr( 0, needle.length ) === needle;
460 }
461
462 protocolWhitelist = [
463 'bitcoin', 'ftp', 'ftps', 'geo', 'git', 'gopher', 'http', 'https', 'irc', 'ircs',
464 'magnet', 'mailto', 'mms', 'news', 'nntp', 'redis', 'sftp', 'sip', 'sips', 'sms', 'ssh',
465 'svn', 'tel', 'telnet', 'urn', 'worldwind', 'xmpp'
466 ];
467
468 if ( url === '' ) {
469 return true;
470 }
471
472 for ( i = 0; i < protocolWhitelist.length; i++ ) {
473 if ( stringStartsWith( url, protocolWhitelist[ i ] + ':' ) ) {
474 return true;
475 }
476 }
477
478 // This matches '//' too
479 if ( stringStartsWith( url, '/' ) || stringStartsWith( url, './' ) ) {
480 return true;
481 }
482 if ( stringStartsWith( url, '?' ) || stringStartsWith( url, '#' ) ) {
483 return true;
484 }
485
486 return false;
487 };
488
489 /**
490 * Check if the user has a 'mobile' device.
491 *
492 * For our purposes this means the user is primarily using an
493 * on-screen keyboard, touch input instead of a mouse and may
494 * have a physically small display.
495 *
496 * It is left up to implementors to decide how to compute this
497 * so the default implementation always returns false.
498 *
499 * @return {boolean} User is on a mobile device
500 */
501 OO.ui.isMobile = function () {
502 return false;
503 };
504
505 /**
506 * Get the additional spacing that should be taken into account when displaying elements that are
507 * clipped to the viewport, e.g. dropdown menus and popups. This is meant to be overridden to avoid
508 * such menus overlapping any fixed headers/toolbars/navigation used by the site.
509 *
510 * @return {Object} Object with the properties 'top', 'right', 'bottom', 'left', each representing
511 * the extra spacing from that edge of viewport (in pixels)
512 */
513 OO.ui.getViewportSpacing = function () {
514 return {
515 top: 0,
516 right: 0,
517 bottom: 0,
518 left: 0
519 };
520 };
521
522 /**
523 * Get the default overlay, which is used by various widgets when they are passed `$overlay: true`.
524 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
525 *
526 * @return {jQuery} Default overlay node
527 */
528 OO.ui.getDefaultOverlay = function () {
529 if ( !OO.ui.$defaultOverlay ) {
530 OO.ui.$defaultOverlay = $( '<div>' ).addClass( 'oo-ui-defaultOverlay' );
531 $( document.body ).append( OO.ui.$defaultOverlay );
532 }
533 return OO.ui.$defaultOverlay;
534 };
535
536 /**
537 * Message store for the default implementation of OO.ui.msg.
538 *
539 * Environments that provide a localization system should not use this, but should override
540 * OO.ui.msg altogether.
541 *
542 * @private
543 */
544 OO.ui.msg.messages = {
545 "ooui-outline-control-move-down": "Move item down",
546 "ooui-outline-control-move-up": "Move item up",
547 "ooui-outline-control-remove": "Remove item",
548 "ooui-toolbar-more": "More",
549 "ooui-toolgroup-expand": "More",
550 "ooui-toolgroup-collapse": "Fewer",
551 "ooui-item-remove": "Remove",
552 "ooui-dialog-message-accept": "OK",
553 "ooui-dialog-message-reject": "Cancel",
554 "ooui-dialog-process-error": "Something went wrong",
555 "ooui-dialog-process-dismiss": "Dismiss",
556 "ooui-dialog-process-retry": "Try again",
557 "ooui-dialog-process-continue": "Continue",
558 "ooui-combobox-button-label": "Dropdown for combobox",
559 "ooui-selectfile-button-select": "Select a file",
560 "ooui-selectfile-not-supported": "File selection is not supported",
561 "ooui-selectfile-placeholder": "No file is selected",
562 "ooui-selectfile-dragdrop-placeholder": "Drop file here",
563 "ooui-field-help": "Help"
564 };
565
566 /*!
567 * Mixin namespace.
568 */
569
570 /**
571 * Namespace for OOUI mixins.
572 *
573 * Mixins are named according to the type of object they are intended to
574 * be mixed in to. For example, OO.ui.mixin.GroupElement is intended to be
575 * mixed in to an instance of OO.ui.Element, and OO.ui.mixin.GroupWidget
576 * is intended to be mixed in to an instance of OO.ui.Widget.
577 *
578 * @class
579 * @singleton
580 */
581 OO.ui.mixin = {};
582
583 /**
584 * Each Element represents a rendering in the DOM—a button or an icon, for example, or anything
585 * that is visible to a user. Unlike {@link OO.ui.Widget widgets}, plain elements usually do not
586 * have events connected to them and can't be interacted with.
587 *
588 * @abstract
589 * @class
590 *
591 * @constructor
592 * @param {Object} [config] Configuration options
593 * @cfg {string[]} [classes] The names of the CSS classes to apply to the element. CSS styles are
594 * added to the top level (e.g., the outermost div) of the element. See the
595 * [OOUI documentation on MediaWiki][2] for an example.
596 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Buttons_and_Switches#cssExample
597 * @cfg {string} [id] The HTML id attribute used in the rendered tag.
598 * @cfg {string} [text] Text to insert
599 * @cfg {Array} [content] An array of content elements to append (after #text).
600 * Strings will be html-escaped; use an OO.ui.HtmlSnippet to append raw HTML.
601 * Instances of OO.ui.Element will have their $element appended.
602 * @cfg {jQuery} [$content] Content elements to append (after #text).
603 * @cfg {jQuery} [$element] Wrapper element. Defaults to a new element with #getTagName.
604 * @cfg {Mixed} [data] Custom data of any type or combination of types (e.g., string, number,
605 * array, object).
606 * Data can also be specified with the #setData method.
607 */
608 OO.ui.Element = function OoUiElement( config ) {
609 if ( OO.ui.isDemo ) {
610 this.initialConfig = config;
611 }
612 // Configuration initialization
613 config = config || {};
614
615 // Properties
616 this.$ = function () {
617 OO.ui.warnDeprecation( 'this.$ is deprecated, use global $ instead' );
618 return $.apply( this, arguments );
619 };
620 this.elementId = null;
621 this.visible = true;
622 this.data = config.data;
623 this.$element = config.$element ||
624 $( document.createElement( this.getTagName() ) );
625 this.elementGroup = null;
626
627 // Initialization
628 if ( Array.isArray( config.classes ) ) {
629 this.$element.addClass( config.classes );
630 }
631 if ( config.id ) {
632 this.setElementId( config.id );
633 }
634 if ( config.text ) {
635 this.$element.text( config.text );
636 }
637 if ( config.content ) {
638 // The `content` property treats plain strings as text; use an
639 // HtmlSnippet to append HTML content. `OO.ui.Element`s get their
640 // appropriate $element appended.
641 this.$element.append( config.content.map( function ( v ) {
642 if ( typeof v === 'string' ) {
643 // Escape string so it is properly represented in HTML.
644 // Don't create empty text nodes for empty strings.
645 return v ? document.createTextNode( v ) : undefined;
646 } else if ( v instanceof OO.ui.HtmlSnippet ) {
647 // Bypass escaping.
648 return v.toString();
649 } else if ( v instanceof OO.ui.Element ) {
650 return v.$element;
651 }
652 return v;
653 } ) );
654 }
655 if ( config.$content ) {
656 // The `$content` property treats plain strings as HTML.
657 this.$element.append( config.$content );
658 }
659 };
660
661 /* Setup */
662
663 OO.initClass( OO.ui.Element );
664
665 /* Static Properties */
666
667 /**
668 * The name of the HTML tag used by the element.
669 *
670 * The static value may be ignored if the #getTagName method is overridden.
671 *
672 * @static
673 * @inheritable
674 * @property {string}
675 */
676 OO.ui.Element.static.tagName = 'div';
677
678 /* Static Methods */
679
680 /**
681 * Reconstitute a JavaScript object corresponding to a widget created
682 * by the PHP implementation.
683 *
684 * @param {string|HTMLElement|jQuery} idOrNode
685 * A DOM id (if a string) or node for the widget to infuse.
686 * @param {Object} [config] Configuration options
687 * @return {OO.ui.Element}
688 * The `OO.ui.Element` corresponding to this (infusable) document node.
689 * For `Tag` objects emitted on the HTML side (used occasionally for content)
690 * the value returned is a newly-created Element wrapping around the existing
691 * DOM node.
692 */
693 OO.ui.Element.static.infuse = function ( idOrNode, config ) {
694 var obj = OO.ui.Element.static.unsafeInfuse( idOrNode, config, false );
695
696 if ( typeof idOrNode === 'string' ) {
697 // IDs deprecated since 0.29.7
698 OO.ui.warnDeprecation(
699 'Passing a string ID to infuse is deprecated. Use an HTMLElement or jQuery collection instead.'
700 );
701 }
702 // Verify that the type matches up.
703 // FIXME: uncomment after T89721 is fixed, see T90929.
704 /*
705 if ( !( obj instanceof this['class'] ) ) {
706 throw new Error( 'Infusion type mismatch!' );
707 }
708 */
709 return obj;
710 };
711
712 /**
713 * Implementation helper for `infuse`; skips the type check and has an
714 * extra property so that only the top-level invocation touches the DOM.
715 *
716 * @private
717 * @param {string|HTMLElement|jQuery} idOrNode
718 * @param {Object} [config] Configuration options
719 * @param {jQuery.Promise} [domPromise] A promise that will be resolved
720 * when the top-level widget of this infusion is inserted into DOM,
721 * replacing the original node; only used internally.
722 * @return {OO.ui.Element}
723 */
724 OO.ui.Element.static.unsafeInfuse = function ( idOrNode, config, domPromise ) {
725 // look for a cached result of a previous infusion.
726 var id, $elem, error, data, cls, parts, parent, obj, top, state, infusedChildren;
727 if ( typeof idOrNode === 'string' ) {
728 id = idOrNode;
729 $elem = $( document.getElementById( id ) );
730 } else {
731 $elem = $( idOrNode );
732 id = $elem.attr( 'id' );
733 }
734 if ( !$elem.length ) {
735 if ( typeof idOrNode === 'string' ) {
736 error = 'Widget not found: ' + idOrNode;
737 } else if ( idOrNode && idOrNode.selector ) {
738 error = 'Widget not found: ' + idOrNode.selector;
739 } else {
740 error = 'Widget not found';
741 }
742 throw new Error( error );
743 }
744 if ( $elem[ 0 ].oouiInfused ) {
745 $elem = $elem[ 0 ].oouiInfused;
746 }
747 data = $elem.data( 'ooui-infused' );
748 if ( data ) {
749 // cached!
750 if ( data === true ) {
751 throw new Error( 'Circular dependency! ' + id );
752 }
753 if ( domPromise ) {
754 // Pick up dynamic state, like focus, value of form inputs, scroll position, etc.
755 state = data.constructor.static.gatherPreInfuseState( $elem, data );
756 // Restore dynamic state after the new element is re-inserted into DOM under
757 // infused parent.
758 domPromise.done( data.restorePreInfuseState.bind( data, state ) );
759 infusedChildren = $elem.data( 'ooui-infused-children' );
760 if ( infusedChildren && infusedChildren.length ) {
761 infusedChildren.forEach( function ( data ) {
762 var state = data.constructor.static.gatherPreInfuseState( $elem, data );
763 domPromise.done( data.restorePreInfuseState.bind( data, state ) );
764 } );
765 }
766 }
767 return data;
768 }
769 data = $elem.attr( 'data-ooui' );
770 if ( !data ) {
771 throw new Error( 'No infusion data found: ' + id );
772 }
773 try {
774 data = JSON.parse( data );
775 } catch ( _ ) {
776 data = null;
777 }
778 if ( !( data && data._ ) ) {
779 throw new Error( 'No valid infusion data found: ' + id );
780 }
781 if ( data._ === 'Tag' ) {
782 // Special case: this is a raw Tag; wrap existing node, don't rebuild.
783 return new OO.ui.Element( $.extend( {}, config, { $element: $elem } ) );
784 }
785 parts = data._.split( '.' );
786 cls = OO.getProp.apply( OO, [ window ].concat( parts ) );
787 if ( cls === undefined ) {
788 throw new Error( 'Unknown widget type: id: ' + id + ', class: ' + data._ );
789 }
790
791 // Verify that we're creating an OO.ui.Element instance
792 parent = cls.parent;
793
794 while ( parent !== undefined ) {
795 if ( parent === OO.ui.Element ) {
796 // Safe
797 break;
798 }
799
800 parent = parent.parent;
801 }
802
803 if ( parent !== OO.ui.Element ) {
804 throw new Error( 'Unknown widget type: id: ' + id + ', class: ' + data._ );
805 }
806
807 if ( !domPromise ) {
808 top = $.Deferred();
809 domPromise = top.promise();
810 }
811 $elem.data( 'ooui-infused', true ); // prevent loops
812 data.id = id; // implicit
813 infusedChildren = [];
814 data = OO.copy( data, null, function deserialize( value ) {
815 var infused;
816 if ( OO.isPlainObject( value ) ) {
817 if ( value.tag ) {
818 infused = OO.ui.Element.static.unsafeInfuse( value.tag, config, domPromise );
819 infusedChildren.push( infused );
820 // Flatten the structure
821 infusedChildren.push.apply(
822 infusedChildren,
823 infused.$element.data( 'ooui-infused-children' ) || []
824 );
825 infused.$element.removeData( 'ooui-infused-children' );
826 return infused;
827 }
828 if ( value.html !== undefined ) {
829 return new OO.ui.HtmlSnippet( value.html );
830 }
831 }
832 } );
833 // allow widgets to reuse parts of the DOM
834 data = cls.static.reusePreInfuseDOM( $elem[ 0 ], data );
835 // pick up dynamic state, like focus, value of form inputs, scroll position, etc.
836 state = cls.static.gatherPreInfuseState( $elem[ 0 ], data );
837 // rebuild widget
838 // eslint-disable-next-line new-cap
839 obj = new cls( $.extend( {}, config, data ) );
840 // If anyone is holding a reference to the old DOM element,
841 // let's allow them to OO.ui.infuse() it and do what they expect, see T105828.
842 // Do not use jQuery.data(), as using it on detached nodes leaks memory in 1.x line by design.
843 $elem[ 0 ].oouiInfused = obj.$element;
844 // now replace old DOM with this new DOM.
845 if ( top ) {
846 // An efficient constructor might be able to reuse the entire DOM tree of the original
847 // element, so only mutate the DOM if we need to.
848 if ( $elem[ 0 ] !== obj.$element[ 0 ] ) {
849 $elem.replaceWith( obj.$element );
850 }
851 top.resolve();
852 }
853 obj.$element.data( 'ooui-infused', obj );
854 obj.$element.data( 'ooui-infused-children', infusedChildren );
855 // set the 'data-ooui' attribute so we can identify infused widgets
856 obj.$element.attr( 'data-ooui', '' );
857 // restore dynamic state after the new element is inserted into DOM
858 domPromise.done( obj.restorePreInfuseState.bind( obj, state ) );
859 return obj;
860 };
861
862 /**
863 * Pick out parts of `node`'s DOM to be reused when infusing a widget.
864 *
865 * This method **must not** make any changes to the DOM, only find interesting pieces and add them
866 * to `config` (which should then be returned). Actual DOM juggling should then be done by the
867 * constructor, which will be given the enhanced config.
868 *
869 * @protected
870 * @param {HTMLElement} node
871 * @param {Object} config
872 * @return {Object}
873 */
874 OO.ui.Element.static.reusePreInfuseDOM = function ( node, config ) {
875 return config;
876 };
877
878 /**
879 * Gather the dynamic state (focus, value of form inputs, scroll position, etc.) of an HTML DOM
880 * node (and its children) that represent an Element of the same class and the given configuration,
881 * generated by the PHP implementation.
882 *
883 * This method is called just before `node` is detached from the DOM. The return value of this
884 * function will be passed to #restorePreInfuseState after the newly created widget's #$element
885 * is inserted into DOM to replace `node`.
886 *
887 * @protected
888 * @param {HTMLElement} node
889 * @param {Object} config
890 * @return {Object}
891 */
892 OO.ui.Element.static.gatherPreInfuseState = function () {
893 return {};
894 };
895
896 /**
897 * Get a jQuery function within a specific document.
898 *
899 * @static
900 * @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
901 * @param {jQuery} [$iframe] HTML iframe element that contains the document, omit if document is
902 * not in an iframe
903 * @return {Function} Bound jQuery function
904 */
905 OO.ui.Element.static.getJQuery = function ( context, $iframe ) {
906 function wrapper( selector ) {
907 return $( selector, wrapper.context );
908 }
909
910 wrapper.context = this.getDocument( context );
911
912 if ( $iframe ) {
913 wrapper.$iframe = $iframe;
914 }
915
916 return wrapper;
917 };
918
919 /**
920 * Get the document of an element.
921 *
922 * @static
923 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Object to get the document for
924 * @return {HTMLDocument|null} Document object
925 */
926 OO.ui.Element.static.getDocument = function ( obj ) {
927 // jQuery - selections created "offscreen" won't have a context, so .context isn't reliable
928 return ( obj[ 0 ] && obj[ 0 ].ownerDocument ) ||
929 // Empty jQuery selections might have a context
930 obj.context ||
931 // HTMLElement
932 obj.ownerDocument ||
933 // Window
934 obj.document ||
935 // HTMLDocument
936 ( obj.nodeType === Node.DOCUMENT_NODE && obj ) ||
937 null;
938 };
939
940 /**
941 * Get the window of an element or document.
942 *
943 * @static
944 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the window for
945 * @return {Window} Window object
946 */
947 OO.ui.Element.static.getWindow = function ( obj ) {
948 var doc = this.getDocument( obj );
949 return doc.defaultView;
950 };
951
952 /**
953 * Get the direction of an element or document.
954 *
955 * @static
956 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the direction for
957 * @return {string} Text direction, either 'ltr' or 'rtl'
958 */
959 OO.ui.Element.static.getDir = function ( obj ) {
960 var isDoc, isWin;
961
962 if ( obj instanceof $ ) {
963 obj = obj[ 0 ];
964 }
965 isDoc = obj.nodeType === Node.DOCUMENT_NODE;
966 isWin = obj.document !== undefined;
967 if ( isDoc || isWin ) {
968 if ( isWin ) {
969 obj = obj.document;
970 }
971 obj = obj.body;
972 }
973 return $( obj ).css( 'direction' );
974 };
975
976 /**
977 * Get the offset between two frames.
978 *
979 * TODO: Make this function not use recursion.
980 *
981 * @static
982 * @param {Window} from Window of the child frame
983 * @param {Window} [to=window] Window of the parent frame
984 * @param {Object} [offset] Offset to start with, used internally
985 * @return {Object} Offset object, containing left and top properties
986 */
987 OO.ui.Element.static.getFrameOffset = function ( from, to, offset ) {
988 var i, len, frames, frame, rect;
989
990 if ( !to ) {
991 to = window;
992 }
993 if ( !offset ) {
994 offset = { top: 0, left: 0 };
995 }
996 if ( from.parent === from ) {
997 return offset;
998 }
999
1000 // Get iframe element
1001 frames = from.parent.document.getElementsByTagName( 'iframe' );
1002 for ( i = 0, len = frames.length; i < len; i++ ) {
1003 if ( frames[ i ].contentWindow === from ) {
1004 frame = frames[ i ];
1005 break;
1006 }
1007 }
1008
1009 // Recursively accumulate offset values
1010 if ( frame ) {
1011 rect = frame.getBoundingClientRect();
1012 offset.left += rect.left;
1013 offset.top += rect.top;
1014 if ( from !== to ) {
1015 this.getFrameOffset( from.parent, offset );
1016 }
1017 }
1018 return offset;
1019 };
1020
1021 /**
1022 * Get the offset between two elements.
1023 *
1024 * The two elements may be in a different frame, but in that case the frame $element is in must
1025 * be contained in the frame $anchor is in.
1026 *
1027 * @static
1028 * @param {jQuery} $element Element whose position to get
1029 * @param {jQuery} $anchor Element to get $element's position relative to
1030 * @return {Object} Translated position coordinates, containing top and left properties
1031 */
1032 OO.ui.Element.static.getRelativePosition = function ( $element, $anchor ) {
1033 var iframe, iframePos,
1034 pos = $element.offset(),
1035 anchorPos = $anchor.offset(),
1036 elementDocument = this.getDocument( $element ),
1037 anchorDocument = this.getDocument( $anchor );
1038
1039 // If $element isn't in the same document as $anchor, traverse up
1040 while ( elementDocument !== anchorDocument ) {
1041 iframe = elementDocument.defaultView.frameElement;
1042 if ( !iframe ) {
1043 throw new Error( '$element frame is not contained in $anchor frame' );
1044 }
1045 iframePos = $( iframe ).offset();
1046 pos.left += iframePos.left;
1047 pos.top += iframePos.top;
1048 elementDocument = iframe.ownerDocument;
1049 }
1050 pos.left -= anchorPos.left;
1051 pos.top -= anchorPos.top;
1052 return pos;
1053 };
1054
1055 /**
1056 * Get element border sizes.
1057 *
1058 * @static
1059 * @param {HTMLElement} el Element to measure
1060 * @return {Object} Dimensions object with `top`, `left`, `bottom` and `right` properties
1061 */
1062 OO.ui.Element.static.getBorders = function ( el ) {
1063 var doc = el.ownerDocument,
1064 win = doc.defaultView,
1065 style = win.getComputedStyle( el, null ),
1066 $el = $( el ),
1067 top = parseFloat( style ? style.borderTopWidth : $el.css( 'borderTopWidth' ) ) || 0,
1068 left = parseFloat( style ? style.borderLeftWidth : $el.css( 'borderLeftWidth' ) ) || 0,
1069 bottom = parseFloat( style ? style.borderBottomWidth : $el.css( 'borderBottomWidth' ) ) || 0,
1070 right = parseFloat( style ? style.borderRightWidth : $el.css( 'borderRightWidth' ) ) || 0;
1071
1072 return {
1073 top: top,
1074 left: left,
1075 bottom: bottom,
1076 right: right
1077 };
1078 };
1079
1080 /**
1081 * Get dimensions of an element or window.
1082 *
1083 * @static
1084 * @param {HTMLElement|Window} el Element to measure
1085 * @return {Object} Dimensions object with `borders`, `scroll`, `scrollbar` and `rect` properties
1086 */
1087 OO.ui.Element.static.getDimensions = function ( el ) {
1088 var $el, $win,
1089 doc = el.ownerDocument || el.document,
1090 win = doc.defaultView;
1091
1092 if ( win === el || el === doc.documentElement ) {
1093 $win = $( win );
1094 return {
1095 borders: { top: 0, left: 0, bottom: 0, right: 0 },
1096 scroll: {
1097 top: $win.scrollTop(),
1098 left: $win.scrollLeft()
1099 },
1100 scrollbar: { right: 0, bottom: 0 },
1101 rect: {
1102 top: 0,
1103 left: 0,
1104 bottom: $win.innerHeight(),
1105 right: $win.innerWidth()
1106 }
1107 };
1108 } else {
1109 $el = $( el );
1110 return {
1111 borders: this.getBorders( el ),
1112 scroll: {
1113 top: $el.scrollTop(),
1114 left: $el.scrollLeft()
1115 },
1116 scrollbar: {
1117 right: $el.innerWidth() - el.clientWidth,
1118 bottom: $el.innerHeight() - el.clientHeight
1119 },
1120 rect: el.getBoundingClientRect()
1121 };
1122 }
1123 };
1124
1125 /**
1126 * Get the number of pixels that an element's content is scrolled to the left.
1127 *
1128 * Adapted from <https://github.com/othree/jquery.rtl-scroll-type>.
1129 * Original code copyright 2012 Wei-Ko Kao, licensed under the MIT License.
1130 *
1131 * This function smooths out browser inconsistencies (nicely described in the README at
1132 * <https://github.com/othree/jquery.rtl-scroll-type>) and produces a result consistent
1133 * with Firefox's 'scrollLeft', which seems the sanest.
1134 *
1135 * @static
1136 * @method
1137 * @param {HTMLElement|Window} el Element to measure
1138 * @return {number} Scroll position from the left.
1139 * If the element's direction is LTR, this is a positive number between `0` (initial scroll
1140 * position) and `el.scrollWidth - el.clientWidth` (furthest possible scroll position).
1141 * If the element's direction is RTL, this is a negative number between `0` (initial scroll
1142 * position) and `-el.scrollWidth + el.clientWidth` (furthest possible scroll position).
1143 */
1144 OO.ui.Element.static.getScrollLeft = ( function () {
1145 var rtlScrollType = null;
1146
1147 function test() {
1148 var $definer = $( '<div>' ).attr( {
1149 dir: 'rtl',
1150 style: 'font-size: 14px; width: 4px; height: 1px; position: absolute; top: -1000px; overflow: scroll;'
1151 } ).text( 'ABCD' ),
1152 definer = $definer[ 0 ];
1153
1154 $definer.appendTo( 'body' );
1155 if ( definer.scrollLeft > 0 ) {
1156 // Safari, Chrome
1157 rtlScrollType = 'default';
1158 } else {
1159 definer.scrollLeft = 1;
1160 if ( definer.scrollLeft === 0 ) {
1161 // Firefox, old Opera
1162 rtlScrollType = 'negative';
1163 } else {
1164 // Internet Explorer, Edge
1165 rtlScrollType = 'reverse';
1166 }
1167 }
1168 $definer.remove();
1169 }
1170
1171 return function getScrollLeft( el ) {
1172 var isRoot = el.window === el ||
1173 el === el.ownerDocument.body ||
1174 el === el.ownerDocument.documentElement,
1175 scrollLeft = isRoot ? $( window ).scrollLeft() : el.scrollLeft,
1176 // All browsers use the correct scroll type ('negative') on the root, so don't
1177 // do any fixups when looking at the root element
1178 direction = isRoot ? 'ltr' : $( el ).css( 'direction' );
1179
1180 if ( direction === 'rtl' ) {
1181 if ( rtlScrollType === null ) {
1182 test();
1183 }
1184 if ( rtlScrollType === 'reverse' ) {
1185 scrollLeft = -scrollLeft;
1186 } else if ( rtlScrollType === 'default' ) {
1187 scrollLeft = scrollLeft - el.scrollWidth + el.clientWidth;
1188 }
1189 }
1190
1191 return scrollLeft;
1192 };
1193 }() );
1194
1195 /**
1196 * Get the root scrollable element of given element's document.
1197 *
1198 * On Blink-based browsers (Chrome etc.), `document.documentElement` can't be used to get or set
1199 * the scrollTop property; instead we have to use `document.body`. Changing and testing the value
1200 * lets us use 'body' or 'documentElement' based on what is working.
1201 *
1202 * https://code.google.com/p/chromium/issues/detail?id=303131
1203 *
1204 * @static
1205 * @param {HTMLElement} el Element to find root scrollable parent for
1206 * @return {HTMLElement} Scrollable parent, `document.body` or `document.documentElement`
1207 * depending on browser
1208 */
1209 OO.ui.Element.static.getRootScrollableElement = function ( el ) {
1210 var scrollTop, body;
1211
1212 if ( OO.ui.scrollableElement === undefined ) {
1213 body = el.ownerDocument.body;
1214 scrollTop = body.scrollTop;
1215 body.scrollTop = 1;
1216
1217 // In some browsers (observed in Chrome 56 on Linux Mint 18.1),
1218 // body.scrollTop doesn't become exactly 1, but a fractional value like 0.76
1219 if ( Math.round( body.scrollTop ) === 1 ) {
1220 body.scrollTop = scrollTop;
1221 OO.ui.scrollableElement = 'body';
1222 } else {
1223 OO.ui.scrollableElement = 'documentElement';
1224 }
1225 }
1226
1227 return el.ownerDocument[ OO.ui.scrollableElement ];
1228 };
1229
1230 /**
1231 * Get closest scrollable container.
1232 *
1233 * Traverses up until either a scrollable element or the root is reached, in which case the root
1234 * scrollable element will be returned (see #getRootScrollableElement).
1235 *
1236 * @static
1237 * @param {HTMLElement} el Element to find scrollable container for
1238 * @param {string} [dimension] Dimension of scrolling to look for; `x`, `y` or omit for either
1239 * @return {HTMLElement} Closest scrollable container
1240 */
1241 OO.ui.Element.static.getClosestScrollableContainer = function ( el, dimension ) {
1242 var i, val,
1243 // Browsers do not correctly return the computed value of 'overflow' when 'overflow-x' and
1244 // 'overflow-y' have different values, so we need to check the separate properties.
1245 props = [ 'overflow-x', 'overflow-y' ],
1246 $parent = $( el ).parent();
1247
1248 if ( dimension === 'x' || dimension === 'y' ) {
1249 props = [ 'overflow-' + dimension ];
1250 }
1251
1252 // Special case for the document root (which doesn't really have any scrollable container,
1253 // since it is the ultimate scrollable container, but this is probably saner than null or
1254 // exception).
1255 if ( $( el ).is( 'html, body' ) ) {
1256 return this.getRootScrollableElement( el );
1257 }
1258
1259 while ( $parent.length ) {
1260 if ( $parent[ 0 ] === this.getRootScrollableElement( el ) ) {
1261 return $parent[ 0 ];
1262 }
1263 i = props.length;
1264 while ( i-- ) {
1265 val = $parent.css( props[ i ] );
1266 // We assume that elements with 'overflow' (in any direction) set to 'hidden' will
1267 // never be scrolled in that direction, but they can actually be scrolled
1268 // programatically. The user can unintentionally perform a scroll in such case even if
1269 // the application doesn't scroll programatically, e.g. when jumping to an anchor, or
1270 // when using built-in find functionality.
1271 // This could cause funny issues...
1272 if ( val === 'auto' || val === 'scroll' ) {
1273 return $parent[ 0 ];
1274 }
1275 }
1276 $parent = $parent.parent();
1277 }
1278 // The element is unattached... return something mostly sane
1279 return this.getRootScrollableElement( el );
1280 };
1281
1282 /**
1283 * Scroll element into view.
1284 *
1285 * @static
1286 * @param {HTMLElement|Object} elOrPosition Element to scroll into view
1287 * @param {Object} [config] Configuration options
1288 * @param {string} [config.animate=true] Animate to the new scroll offset.
1289 * @param {string} [config.duration='fast'] jQuery animation duration value
1290 * @param {string} [config.direction] Scroll in only one direction, e.g. 'x' or 'y', omit
1291 * to scroll in both directions
1292 * @param {Object} [config.padding] Additional padding on the container to scroll past.
1293 * Object containing any of 'top', 'bottom', 'left', or 'right' as numbers.
1294 * @param {Object} [config.scrollContainer] Scroll container. Defaults to
1295 * getClosestScrollableContainer of the element.
1296 * @return {jQuery.Promise} Promise which resolves when the scroll is complete
1297 */
1298 OO.ui.Element.static.scrollIntoView = function ( elOrPosition, config ) {
1299 var position, animations, container, $container, elementPosition, containerDimensions,
1300 $window, padding, animate, method,
1301 deferred = $.Deferred();
1302
1303 // Configuration initialization
1304 config = config || {};
1305
1306 padding = $.extend( {
1307 top: 0,
1308 bottom: 0,
1309 left: 0,
1310 right: 0
1311 }, config.padding );
1312
1313 animate = config.animate !== false;
1314
1315 animations = {};
1316 elementPosition = elOrPosition instanceof HTMLElement ?
1317 this.getDimensions( elOrPosition ).rect :
1318 elOrPosition;
1319 container = config.scrollContainer || (
1320 elOrPosition instanceof HTMLElement ?
1321 this.getClosestScrollableContainer( elOrPosition, config.direction ) :
1322 // No scrollContainer or element
1323 this.getClosestScrollableContainer( document.body )
1324 );
1325 $container = $( container );
1326 containerDimensions = this.getDimensions( container );
1327 $window = $( this.getWindow( container ) );
1328
1329 // Compute the element's position relative to the container
1330 if ( $container.is( 'html, body' ) ) {
1331 // If the scrollable container is the root, this is easy
1332 position = {
1333 top: elementPosition.top,
1334 bottom: $window.innerHeight() - elementPosition.bottom,
1335 left: elementPosition.left,
1336 right: $window.innerWidth() - elementPosition.right
1337 };
1338 } else {
1339 // Otherwise, we have to subtract el's coordinates from container's coordinates
1340 position = {
1341 top: elementPosition.top -
1342 ( containerDimensions.rect.top + containerDimensions.borders.top ),
1343 bottom: containerDimensions.rect.bottom - containerDimensions.borders.bottom -
1344 containerDimensions.scrollbar.bottom - elementPosition.bottom,
1345 left: elementPosition.left -
1346 ( containerDimensions.rect.left + containerDimensions.borders.left ),
1347 right: containerDimensions.rect.right - containerDimensions.borders.right -
1348 containerDimensions.scrollbar.right - elementPosition.right
1349 };
1350 }
1351
1352 if ( !config.direction || config.direction === 'y' ) {
1353 if ( position.top < padding.top ) {
1354 animations.scrollTop = containerDimensions.scroll.top + position.top - padding.top;
1355 } else if ( position.bottom < padding.bottom ) {
1356 animations.scrollTop = containerDimensions.scroll.top +
1357 // Scroll the bottom into view, but not at the expense
1358 // of scrolling the top out of view
1359 Math.min( position.top - padding.top, -position.bottom + padding.bottom );
1360 }
1361 }
1362 if ( !config.direction || config.direction === 'x' ) {
1363 if ( position.left < padding.left ) {
1364 animations.scrollLeft = containerDimensions.scroll.left + position.left - padding.left;
1365 } else if ( position.right < padding.right ) {
1366 animations.scrollLeft = containerDimensions.scroll.left +
1367 // Scroll the right into view, but not at the expense
1368 // of scrolling the left out of view
1369 Math.min( position.left - padding.left, -position.right + padding.right );
1370 }
1371 }
1372 if ( !$.isEmptyObject( animations ) ) {
1373 if ( animate ) {
1374 // eslint-disable-next-line no-jquery/no-animate
1375 $container.stop( true ).animate( animations, config.duration === undefined ? 'fast' : config.duration );
1376 $container.queue( function ( next ) {
1377 deferred.resolve();
1378 next();
1379 } );
1380 } else {
1381 $container.stop( true );
1382 for ( method in animations ) {
1383 $container[ method ]( animations[ method ] );
1384 }
1385 deferred.resolve();
1386 }
1387 } else {
1388 deferred.resolve();
1389 }
1390 return deferred.promise();
1391 };
1392
1393 /**
1394 * Force the browser to reconsider whether it really needs to render scrollbars inside the element
1395 * and reserve space for them, because it probably doesn't.
1396 *
1397 * Workaround primarily for <https://code.google.com/p/chromium/issues/detail?id=387290>, but also
1398 * similar bugs in other browsers. "Just" forcing a reflow is not sufficient in all cases, we need
1399 * to first actually detach (or hide, but detaching is simpler) all children, *then* force a
1400 * reflow, and then reattach (or show) them back.
1401 *
1402 * @static
1403 * @param {HTMLElement} el Element to reconsider the scrollbars on
1404 */
1405 OO.ui.Element.static.reconsiderScrollbars = function ( el ) {
1406 var i, len, scrollLeft, scrollTop, nodes = [];
1407 // Save scroll position
1408 scrollLeft = el.scrollLeft;
1409 scrollTop = el.scrollTop;
1410 // Detach all children
1411 while ( el.firstChild ) {
1412 nodes.push( el.firstChild );
1413 el.removeChild( el.firstChild );
1414 }
1415 // Force reflow
1416 // eslint-disable-next-line no-void
1417 void el.offsetHeight;
1418 // Reattach all children
1419 for ( i = 0, len = nodes.length; i < len; i++ ) {
1420 el.appendChild( nodes[ i ] );
1421 }
1422 // Restore scroll position (no-op if scrollbars disappeared)
1423 el.scrollLeft = scrollLeft;
1424 el.scrollTop = scrollTop;
1425 };
1426
1427 /* Methods */
1428
1429 /**
1430 * Toggle visibility of an element.
1431 *
1432 * @param {boolean} [show] Make element visible, omit to toggle visibility
1433 * @fires visible
1434 * @chainable
1435 * @return {OO.ui.Element} The element, for chaining
1436 */
1437 OO.ui.Element.prototype.toggle = function ( show ) {
1438 show = show === undefined ? !this.visible : !!show;
1439
1440 if ( show !== this.isVisible() ) {
1441 this.visible = show;
1442 this.$element.toggleClass( 'oo-ui-element-hidden', !this.visible );
1443 this.emit( 'toggle', show );
1444 }
1445
1446 return this;
1447 };
1448
1449 /**
1450 * Check if element is visible.
1451 *
1452 * @return {boolean} element is visible
1453 */
1454 OO.ui.Element.prototype.isVisible = function () {
1455 return this.visible;
1456 };
1457
1458 /**
1459 * Get element data.
1460 *
1461 * @return {Mixed} Element data
1462 */
1463 OO.ui.Element.prototype.getData = function () {
1464 return this.data;
1465 };
1466
1467 /**
1468 * Set element data.
1469 *
1470 * @param {Mixed} data Element data
1471 * @chainable
1472 * @return {OO.ui.Element} The element, for chaining
1473 */
1474 OO.ui.Element.prototype.setData = function ( data ) {
1475 this.data = data;
1476 return this;
1477 };
1478
1479 /**
1480 * Set the element has an 'id' attribute.
1481 *
1482 * @param {string} id
1483 * @chainable
1484 * @return {OO.ui.Element} The element, for chaining
1485 */
1486 OO.ui.Element.prototype.setElementId = function ( id ) {
1487 this.elementId = id;
1488 this.$element.attr( 'id', id );
1489 return this;
1490 };
1491
1492 /**
1493 * Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing,
1494 * and return its value.
1495 *
1496 * @return {string}
1497 */
1498 OO.ui.Element.prototype.getElementId = function () {
1499 if ( this.elementId === null ) {
1500 this.setElementId( OO.ui.generateElementId() );
1501 }
1502 return this.elementId;
1503 };
1504
1505 /**
1506 * Check if element supports one or more methods.
1507 *
1508 * @param {string|string[]} methods Method or list of methods to check
1509 * @return {boolean} All methods are supported
1510 */
1511 OO.ui.Element.prototype.supports = function ( methods ) {
1512 var i, len,
1513 support = 0;
1514
1515 methods = Array.isArray( methods ) ? methods : [ methods ];
1516 for ( i = 0, len = methods.length; i < len; i++ ) {
1517 if ( typeof this[ methods[ i ] ] === 'function' ) {
1518 support++;
1519 }
1520 }
1521
1522 return methods.length === support;
1523 };
1524
1525 /**
1526 * Update the theme-provided classes.
1527 *
1528 * @localdoc This is called in element mixins and widget classes any time state changes.
1529 * Updating is debounced, minimizing overhead of changing multiple attributes and
1530 * guaranteeing that theme updates do not occur within an element's constructor
1531 */
1532 OO.ui.Element.prototype.updateThemeClasses = function () {
1533 OO.ui.theme.queueUpdateElementClasses( this );
1534 };
1535
1536 /**
1537 * Get the HTML tag name.
1538 *
1539 * Override this method to base the result on instance information.
1540 *
1541 * @return {string} HTML tag name
1542 */
1543 OO.ui.Element.prototype.getTagName = function () {
1544 return this.constructor.static.tagName;
1545 };
1546
1547 /**
1548 * Check if the element is attached to the DOM
1549 *
1550 * @return {boolean} The element is attached to the DOM
1551 */
1552 OO.ui.Element.prototype.isElementAttached = function () {
1553 return $.contains( this.getElementDocument(), this.$element[ 0 ] );
1554 };
1555
1556 /**
1557 * Get the DOM document.
1558 *
1559 * @return {HTMLDocument} Document object
1560 */
1561 OO.ui.Element.prototype.getElementDocument = function () {
1562 // Don't cache this in other ways either because subclasses could can change this.$element
1563 return OO.ui.Element.static.getDocument( this.$element );
1564 };
1565
1566 /**
1567 * Get the DOM window.
1568 *
1569 * @return {Window} Window object
1570 */
1571 OO.ui.Element.prototype.getElementWindow = function () {
1572 return OO.ui.Element.static.getWindow( this.$element );
1573 };
1574
1575 /**
1576 * Get closest scrollable container.
1577 *
1578 * @return {HTMLElement} Closest scrollable container
1579 */
1580 OO.ui.Element.prototype.getClosestScrollableElementContainer = function () {
1581 return OO.ui.Element.static.getClosestScrollableContainer( this.$element[ 0 ] );
1582 };
1583
1584 /**
1585 * Get group element is in.
1586 *
1587 * @return {OO.ui.mixin.GroupElement|null} Group element, null if none
1588 */
1589 OO.ui.Element.prototype.getElementGroup = function () {
1590 return this.elementGroup;
1591 };
1592
1593 /**
1594 * Set group element is in.
1595 *
1596 * @param {OO.ui.mixin.GroupElement|null} group Group element, null if none
1597 * @chainable
1598 * @return {OO.ui.Element} The element, for chaining
1599 */
1600 OO.ui.Element.prototype.setElementGroup = function ( group ) {
1601 this.elementGroup = group;
1602 return this;
1603 };
1604
1605 /**
1606 * Scroll element into view.
1607 *
1608 * @param {Object} [config] Configuration options
1609 * @return {jQuery.Promise} Promise which resolves when the scroll is complete
1610 */
1611 OO.ui.Element.prototype.scrollElementIntoView = function ( config ) {
1612 if (
1613 !this.isElementAttached() ||
1614 !this.isVisible() ||
1615 ( this.getElementGroup() && !this.getElementGroup().isVisible() )
1616 ) {
1617 return $.Deferred().resolve();
1618 }
1619 return OO.ui.Element.static.scrollIntoView( this.$element[ 0 ], config );
1620 };
1621
1622 /**
1623 * Restore the pre-infusion dynamic state for this widget.
1624 *
1625 * This method is called after #$element has been inserted into DOM. The parameter is the return
1626 * value of #gatherPreInfuseState.
1627 *
1628 * @protected
1629 * @param {Object} state
1630 */
1631 OO.ui.Element.prototype.restorePreInfuseState = function () {
1632 };
1633
1634 /**
1635 * Wraps an HTML snippet for use with configuration values which default
1636 * to strings. This bypasses the default html-escaping done to string
1637 * values.
1638 *
1639 * @class
1640 *
1641 * @constructor
1642 * @param {string} [content] HTML content
1643 */
1644 OO.ui.HtmlSnippet = function OoUiHtmlSnippet( content ) {
1645 // Properties
1646 this.content = content;
1647 };
1648
1649 /* Setup */
1650
1651 OO.initClass( OO.ui.HtmlSnippet );
1652
1653 /* Methods */
1654
1655 /**
1656 * Render into HTML.
1657 *
1658 * @return {string} Unchanged HTML snippet.
1659 */
1660 OO.ui.HtmlSnippet.prototype.toString = function () {
1661 return this.content;
1662 };
1663
1664 /**
1665 * Layouts are containers for elements and are used to arrange other widgets of arbitrary type in
1666 * a way that is centrally controlled and can be updated dynamically. Layouts can be, and usually
1667 * are, combined.
1668 * See {@link OO.ui.FieldsetLayout FieldsetLayout}, {@link OO.ui.FieldLayout FieldLayout},
1669 * {@link OO.ui.FormLayout FormLayout}, {@link OO.ui.PanelLayout PanelLayout},
1670 * {@link OO.ui.StackLayout StackLayout}, {@link OO.ui.PageLayout PageLayout},
1671 * {@link OO.ui.HorizontalLayout HorizontalLayout}, and {@link OO.ui.BookletLayout BookletLayout}
1672 * for more information and examples.
1673 *
1674 * @abstract
1675 * @class
1676 * @extends OO.ui.Element
1677 * @mixins OO.EventEmitter
1678 *
1679 * @constructor
1680 * @param {Object} [config] Configuration options
1681 */
1682 OO.ui.Layout = function OoUiLayout( config ) {
1683 // Configuration initialization
1684 config = config || {};
1685
1686 // Parent constructor
1687 OO.ui.Layout.parent.call( this, config );
1688
1689 // Mixin constructors
1690 OO.EventEmitter.call( this );
1691
1692 // Initialization
1693 this.$element.addClass( 'oo-ui-layout' );
1694 };
1695
1696 /* Setup */
1697
1698 OO.inheritClass( OO.ui.Layout, OO.ui.Element );
1699 OO.mixinClass( OO.ui.Layout, OO.EventEmitter );
1700
1701 /* Methods */
1702
1703 /**
1704 * Reset scroll offsets
1705 *
1706 * @chainable
1707 * @return {OO.ui.Layout} The layout, for chaining
1708 */
1709 OO.ui.Layout.prototype.resetScroll = function () {
1710 this.$element[ 0 ].scrollTop = 0;
1711 // TODO: Reset scrollLeft in an RTL-aware manner, see OO.ui.Element.static.getScrollLeft.
1712
1713 return this;
1714 };
1715
1716 /**
1717 * Widgets are compositions of one or more OOUI elements that users can both view
1718 * and interact with. All widgets can be configured and modified via a standard API,
1719 * and their state can change dynamically according to a model.
1720 *
1721 * @abstract
1722 * @class
1723 * @extends OO.ui.Element
1724 * @mixins OO.EventEmitter
1725 *
1726 * @constructor
1727 * @param {Object} [config] Configuration options
1728 * @cfg {boolean} [disabled=false] Disable the widget. Disabled widgets cannot be used and their
1729 * appearance reflects this state.
1730 */
1731 OO.ui.Widget = function OoUiWidget( config ) {
1732 // Initialize config
1733 config = $.extend( { disabled: false }, config );
1734
1735 // Parent constructor
1736 OO.ui.Widget.parent.call( this, config );
1737
1738 // Mixin constructors
1739 OO.EventEmitter.call( this );
1740
1741 // Properties
1742 this.disabled = null;
1743 this.wasDisabled = null;
1744
1745 // Initialization
1746 this.$element.addClass( 'oo-ui-widget' );
1747 this.setDisabled( !!config.disabled );
1748 };
1749
1750 /* Setup */
1751
1752 OO.inheritClass( OO.ui.Widget, OO.ui.Element );
1753 OO.mixinClass( OO.ui.Widget, OO.EventEmitter );
1754
1755 /* Events */
1756
1757 /**
1758 * @event disable
1759 *
1760 * A 'disable' event is emitted when the disabled state of the widget changes
1761 * (i.e. on disable **and** enable).
1762 *
1763 * @param {boolean} disabled Widget is disabled
1764 */
1765
1766 /**
1767 * @event toggle
1768 *
1769 * A 'toggle' event is emitted when the visibility of the widget changes.
1770 *
1771 * @param {boolean} visible Widget is visible
1772 */
1773
1774 /* Methods */
1775
1776 /**
1777 * Check if the widget is disabled.
1778 *
1779 * @return {boolean} Widget is disabled
1780 */
1781 OO.ui.Widget.prototype.isDisabled = function () {
1782 return this.disabled;
1783 };
1784
1785 /**
1786 * Set the 'disabled' state of the widget.
1787 *
1788 * When a widget is disabled, it cannot be used and its appearance is updated to reflect this state.
1789 *
1790 * @param {boolean} disabled Disable widget
1791 * @chainable
1792 * @return {OO.ui.Widget} The widget, for chaining
1793 */
1794 OO.ui.Widget.prototype.setDisabled = function ( disabled ) {
1795 var isDisabled;
1796
1797 this.disabled = !!disabled;
1798 isDisabled = this.isDisabled();
1799 if ( isDisabled !== this.wasDisabled ) {
1800 this.$element.toggleClass( 'oo-ui-widget-disabled', isDisabled );
1801 this.$element.toggleClass( 'oo-ui-widget-enabled', !isDisabled );
1802 this.$element.attr( 'aria-disabled', isDisabled.toString() );
1803 this.emit( 'disable', isDisabled );
1804 this.updateThemeClasses();
1805 }
1806 this.wasDisabled = isDisabled;
1807
1808 return this;
1809 };
1810
1811 /**
1812 * Update the disabled state, in case of changes in parent widget.
1813 *
1814 * @chainable
1815 * @return {OO.ui.Widget} The widget, for chaining
1816 */
1817 OO.ui.Widget.prototype.updateDisabled = function () {
1818 this.setDisabled( this.disabled );
1819 return this;
1820 };
1821
1822 /**
1823 * Get an ID of a labelable node which is part of this widget, if any, to be used for `<label for>`
1824 * value.
1825 *
1826 * If this function returns null, the widget should have a meaningful #simulateLabelClick method
1827 * instead.
1828 *
1829 * @return {string|null} The ID of the labelable element
1830 */
1831 OO.ui.Widget.prototype.getInputId = function () {
1832 return null;
1833 };
1834
1835 /**
1836 * Simulate the behavior of clicking on a label (a HTML `<label>` element) bound to this input.
1837 * HTML only allows `<label>` to act on specific "labelable" elements; complex widgets might need to
1838 * override this method to provide intuitive, accessible behavior.
1839 *
1840 * By default, this does nothing. OO.ui.mixin.TabIndexedElement overrides it for focusable widgets.
1841 * Individual widgets may override it too.
1842 *
1843 * This method is called by OO.ui.LabelWidget and OO.ui.FieldLayout. It should not be called
1844 * directly.
1845 */
1846 OO.ui.Widget.prototype.simulateLabelClick = function () {
1847 };
1848
1849 /**
1850 * Theme logic.
1851 *
1852 * @abstract
1853 * @class
1854 *
1855 * @constructor
1856 */
1857 OO.ui.Theme = function OoUiTheme() {
1858 this.elementClassesQueue = [];
1859 this.debouncedUpdateQueuedElementClasses = OO.ui.debounce( this.updateQueuedElementClasses );
1860 };
1861
1862 /* Setup */
1863
1864 OO.initClass( OO.ui.Theme );
1865
1866 /* Methods */
1867
1868 /**
1869 * Get a list of classes to be applied to a widget.
1870 *
1871 * The 'on' and 'off' lists combined MUST contain keys for all classes the theme adds or removes,
1872 * otherwise state transitions will not work properly.
1873 *
1874 * @param {OO.ui.Element} element Element for which to get classes
1875 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
1876 */
1877 OO.ui.Theme.prototype.getElementClasses = function () {
1878 return { on: [], off: [] };
1879 };
1880
1881 /**
1882 * Update CSS classes provided by the theme.
1883 *
1884 * For elements with theme logic hooks, this should be called any time there's a state change.
1885 *
1886 * @param {OO.ui.Element} element Element for which to update classes
1887 */
1888 OO.ui.Theme.prototype.updateElementClasses = function ( element ) {
1889 var $elements = $( [] ),
1890 classes = this.getElementClasses( element );
1891
1892 if ( element.$icon ) {
1893 $elements = $elements.add( element.$icon );
1894 }
1895 if ( element.$indicator ) {
1896 $elements = $elements.add( element.$indicator );
1897 }
1898
1899 $elements
1900 .removeClass( classes.off )
1901 .addClass( classes.on );
1902 };
1903
1904 /**
1905 * @private
1906 */
1907 OO.ui.Theme.prototype.updateQueuedElementClasses = function () {
1908 var i;
1909 for ( i = 0; i < this.elementClassesQueue.length; i++ ) {
1910 this.updateElementClasses( this.elementClassesQueue[ i ] );
1911 }
1912 // Clear the queue
1913 this.elementClassesQueue = [];
1914 };
1915
1916 /**
1917 * Queue #updateElementClasses to be called for this element.
1918 *
1919 * @localdoc QUnit tests override this method to directly call #queueUpdateElementClasses,
1920 * to make them synchronous.
1921 *
1922 * @param {OO.ui.Element} element Element for which to update classes
1923 */
1924 OO.ui.Theme.prototype.queueUpdateElementClasses = function ( element ) {
1925 // Keep items in the queue unique. Use lastIndexOf to start checking from the end because that's
1926 // the most common case (this method is often called repeatedly for the same element).
1927 if ( this.elementClassesQueue.lastIndexOf( element ) !== -1 ) {
1928 return;
1929 }
1930 this.elementClassesQueue.push( element );
1931 this.debouncedUpdateQueuedElementClasses();
1932 };
1933
1934 /**
1935 * Get the transition duration in milliseconds for dialogs opening/closing
1936 *
1937 * The dialog should be fully rendered this many milliseconds after the
1938 * ready process has executed.
1939 *
1940 * @return {number} Transition duration in milliseconds
1941 */
1942 OO.ui.Theme.prototype.getDialogTransitionDuration = function () {
1943 return 0;
1944 };
1945
1946 /**
1947 * The TabIndexedElement class is an attribute mixin used to add additional functionality to an
1948 * element created by another class. The mixin provides a ‘tabIndex’ property, which specifies the
1949 * order in which users will navigate through the focusable elements via the Tab key.
1950 *
1951 * @example
1952 * // TabIndexedElement is mixed into the ButtonWidget class
1953 * // to provide a tabIndex property.
1954 * var button1 = new OO.ui.ButtonWidget( {
1955 * label: 'fourth',
1956 * tabIndex: 4
1957 * } ),
1958 * button2 = new OO.ui.ButtonWidget( {
1959 * label: 'second',
1960 * tabIndex: 2
1961 * } ),
1962 * button3 = new OO.ui.ButtonWidget( {
1963 * label: 'third',
1964 * tabIndex: 3
1965 * } ),
1966 * button4 = new OO.ui.ButtonWidget( {
1967 * label: 'first',
1968 * tabIndex: 1
1969 * } );
1970 * $( document.body ).append(
1971 * button1.$element,
1972 * button2.$element,
1973 * button3.$element,
1974 * button4.$element
1975 * );
1976 *
1977 * @abstract
1978 * @class
1979 *
1980 * @constructor
1981 * @param {Object} [config] Configuration options
1982 * @cfg {jQuery} [$tabIndexed] The element that should use the tabindex functionality. By default,
1983 * the functionality is applied to the element created by the class ($element). If a different
1984 * element is specified, the tabindex functionality will be applied to it instead.
1985 * @cfg {string|number|null} [tabIndex=0] Number that specifies the element’s position in the
1986 * tab-navigation order (e.g., 1 for the first focusable element). Use 0 to use the default
1987 * navigation order; use -1 to remove the element from the tab-navigation flow.
1988 */
1989 OO.ui.mixin.TabIndexedElement = function OoUiMixinTabIndexedElement( config ) {
1990 // Configuration initialization
1991 config = $.extend( { tabIndex: 0 }, config );
1992
1993 // Properties
1994 this.$tabIndexed = null;
1995 this.tabIndex = null;
1996
1997 // Events
1998 this.connect( this, {
1999 disable: 'onTabIndexedElementDisable'
2000 } );
2001
2002 // Initialization
2003 this.setTabIndex( config.tabIndex );
2004 this.setTabIndexedElement( config.$tabIndexed || this.$element );
2005 };
2006
2007 /* Setup */
2008
2009 OO.initClass( OO.ui.mixin.TabIndexedElement );
2010
2011 /* Methods */
2012
2013 /**
2014 * Set the element that should use the tabindex functionality.
2015 *
2016 * This method is used to retarget a tabindex mixin so that its functionality applies
2017 * to the specified element. If an element is currently using the functionality, the mixin’s
2018 * effect on that element is removed before the new element is set up.
2019 *
2020 * @param {jQuery} $tabIndexed Element that should use the tabindex functionality
2021 * @chainable
2022 * @return {OO.ui.Element} The element, for chaining
2023 */
2024 OO.ui.mixin.TabIndexedElement.prototype.setTabIndexedElement = function ( $tabIndexed ) {
2025 var tabIndex = this.tabIndex;
2026 // Remove attributes from old $tabIndexed
2027 this.setTabIndex( null );
2028 // Force update of new $tabIndexed
2029 this.$tabIndexed = $tabIndexed;
2030 this.tabIndex = tabIndex;
2031 return this.updateTabIndex();
2032 };
2033
2034 /**
2035 * Set the value of the tabindex.
2036 *
2037 * @param {string|number|null} tabIndex Tabindex value, or `null` for no tabindex
2038 * @chainable
2039 * @return {OO.ui.Element} The element, for chaining
2040 */
2041 OO.ui.mixin.TabIndexedElement.prototype.setTabIndex = function ( tabIndex ) {
2042 tabIndex = /^-?\d+$/.test( tabIndex ) ? Number( tabIndex ) : null;
2043
2044 if ( this.tabIndex !== tabIndex ) {
2045 this.tabIndex = tabIndex;
2046 this.updateTabIndex();
2047 }
2048
2049 return this;
2050 };
2051
2052 /**
2053 * Update the `tabindex` attribute, in case of changes to tab index or
2054 * disabled state.
2055 *
2056 * @private
2057 * @chainable
2058 * @return {OO.ui.Element} The element, for chaining
2059 */
2060 OO.ui.mixin.TabIndexedElement.prototype.updateTabIndex = function () {
2061 if ( this.$tabIndexed ) {
2062 if ( this.tabIndex !== null ) {
2063 // Do not index over disabled elements
2064 this.$tabIndexed.attr( {
2065 tabindex: this.isDisabled() ? -1 : this.tabIndex,
2066 // Support: ChromeVox and NVDA
2067 // These do not seem to inherit aria-disabled from parent elements
2068 'aria-disabled': this.isDisabled().toString()
2069 } );
2070 } else {
2071 this.$tabIndexed.removeAttr( 'tabindex aria-disabled' );
2072 }
2073 }
2074 return this;
2075 };
2076
2077 /**
2078 * Handle disable events.
2079 *
2080 * @private
2081 * @param {boolean} disabled Element is disabled
2082 */
2083 OO.ui.mixin.TabIndexedElement.prototype.onTabIndexedElementDisable = function () {
2084 this.updateTabIndex();
2085 };
2086
2087 /**
2088 * Get the value of the tabindex.
2089 *
2090 * @return {number|null} Tabindex value
2091 */
2092 OO.ui.mixin.TabIndexedElement.prototype.getTabIndex = function () {
2093 return this.tabIndex;
2094 };
2095
2096 /**
2097 * Get an ID of a focusable element of this widget, if any, to be used for `<label for>` value.
2098 *
2099 * If the element already has an ID then that is returned, otherwise unique ID is
2100 * generated, set on the element, and returned.
2101 *
2102 * @return {string|null} The ID of the focusable element
2103 */
2104 OO.ui.mixin.TabIndexedElement.prototype.getInputId = function () {
2105 var id;
2106
2107 if ( !this.$tabIndexed ) {
2108 return null;
2109 }
2110 if ( !this.isLabelableNode( this.$tabIndexed ) ) {
2111 return null;
2112 }
2113
2114 id = this.$tabIndexed.attr( 'id' );
2115 if ( id === undefined ) {
2116 id = OO.ui.generateElementId();
2117 this.$tabIndexed.attr( 'id', id );
2118 }
2119
2120 return id;
2121 };
2122
2123 /**
2124 * Whether the node is 'labelable' according to the HTML spec
2125 * (i.e., whether it can be interacted with through a `<label for="…">`).
2126 * See: <https://html.spec.whatwg.org/multipage/forms.html#category-label>.
2127 *
2128 * @private
2129 * @param {jQuery} $node
2130 * @return {boolean}
2131 */
2132 OO.ui.mixin.TabIndexedElement.prototype.isLabelableNode = function ( $node ) {
2133 var
2134 labelableTags = [ 'button', 'meter', 'output', 'progress', 'select', 'textarea' ],
2135 tagName = ( $node.prop( 'tagName' ) || '' ).toLowerCase();
2136
2137 if ( tagName === 'input' && $node.attr( 'type' ) !== 'hidden' ) {
2138 return true;
2139 }
2140 if ( labelableTags.indexOf( tagName ) !== -1 ) {
2141 return true;
2142 }
2143 return false;
2144 };
2145
2146 /**
2147 * Focus this element.
2148 *
2149 * @chainable
2150 * @return {OO.ui.Element} The element, for chaining
2151 */
2152 OO.ui.mixin.TabIndexedElement.prototype.focus = function () {
2153 if ( !this.isDisabled() ) {
2154 this.$tabIndexed.trigger( 'focus' );
2155 }
2156 return this;
2157 };
2158
2159 /**
2160 * Blur this element.
2161 *
2162 * @chainable
2163 * @return {OO.ui.Element} The element, for chaining
2164 */
2165 OO.ui.mixin.TabIndexedElement.prototype.blur = function () {
2166 this.$tabIndexed.trigger( 'blur' );
2167 return this;
2168 };
2169
2170 /**
2171 * @inheritdoc OO.ui.Widget
2172 */
2173 OO.ui.mixin.TabIndexedElement.prototype.simulateLabelClick = function () {
2174 this.focus();
2175 };
2176
2177 /**
2178 * ButtonElement is often mixed into other classes to generate a button, which is a clickable
2179 * interface element that can be configured with access keys for keyboard interaction.
2180 * See the [OOUI documentation on MediaWiki] [1] for examples.
2181 *
2182 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Buttons_and_Switches#Buttons
2183 *
2184 * @abstract
2185 * @class
2186 *
2187 * @constructor
2188 * @param {Object} [config] Configuration options
2189 * @cfg {jQuery} [$button] The button element created by the class.
2190 * If this configuration is omitted, the button element will use a generated `<a>`.
2191 * @cfg {boolean} [framed=true] Render the button with a frame
2192 */
2193 OO.ui.mixin.ButtonElement = function OoUiMixinButtonElement( config ) {
2194 // Configuration initialization
2195 config = config || {};
2196
2197 // Properties
2198 this.$button = null;
2199 this.framed = null;
2200 this.active = config.active !== undefined && config.active;
2201 this.onDocumentMouseUpHandler = this.onDocumentMouseUp.bind( this );
2202 this.onMouseDownHandler = this.onMouseDown.bind( this );
2203 this.onDocumentKeyUpHandler = this.onDocumentKeyUp.bind( this );
2204 this.onKeyDownHandler = this.onKeyDown.bind( this );
2205 this.onClickHandler = this.onClick.bind( this );
2206 this.onKeyPressHandler = this.onKeyPress.bind( this );
2207
2208 // Initialization
2209 this.$element.addClass( 'oo-ui-buttonElement' );
2210 this.toggleFramed( config.framed === undefined || config.framed );
2211 this.setButtonElement( config.$button || $( '<a>' ) );
2212 };
2213
2214 /* Setup */
2215
2216 OO.initClass( OO.ui.mixin.ButtonElement );
2217
2218 /* Static Properties */
2219
2220 /**
2221 * Cancel mouse down events.
2222 *
2223 * This property is usually set to `true` to prevent the focus from changing when the button is
2224 * clicked.
2225 * Classes such as {@link OO.ui.mixin.DraggableElement DraggableElement} and
2226 * {@link OO.ui.ButtonOptionWidget ButtonOptionWidget} use a value of `false` so that dragging
2227 * behavior is possible and mousedown events can be handled by a parent widget.
2228 *
2229 * @static
2230 * @inheritable
2231 * @property {boolean}
2232 */
2233 OO.ui.mixin.ButtonElement.static.cancelButtonMouseDownEvents = true;
2234
2235 /* Events */
2236
2237 /**
2238 * A 'click' event is emitted when the button element is clicked.
2239 *
2240 * @event click
2241 */
2242
2243 /* Methods */
2244
2245 /**
2246 * Set the button element.
2247 *
2248 * This method is used to retarget a button mixin so that its functionality applies to
2249 * the specified button element instead of the one created by the class. If a button element
2250 * is already set, the method will remove the mixin’s effect on that element.
2251 *
2252 * @param {jQuery} $button Element to use as button
2253 */
2254 OO.ui.mixin.ButtonElement.prototype.setButtonElement = function ( $button ) {
2255 if ( this.$button ) {
2256 this.$button
2257 .removeClass( 'oo-ui-buttonElement-button' )
2258 .removeAttr( 'role accesskey' )
2259 .off( {
2260 mousedown: this.onMouseDownHandler,
2261 keydown: this.onKeyDownHandler,
2262 click: this.onClickHandler,
2263 keypress: this.onKeyPressHandler
2264 } );
2265 }
2266
2267 this.$button = $button
2268 .addClass( 'oo-ui-buttonElement-button' )
2269 .on( {
2270 mousedown: this.onMouseDownHandler,
2271 keydown: this.onKeyDownHandler,
2272 click: this.onClickHandler,
2273 keypress: this.onKeyPressHandler
2274 } );
2275
2276 // Add `role="button"` on `<a>` elements, where it's needed
2277 // `toUpperCase()` is added for XHTML documents
2278 if ( this.$button.prop( 'tagName' ).toUpperCase() === 'A' ) {
2279 this.$button.attr( 'role', 'button' );
2280 }
2281 };
2282
2283 /**
2284 * Handles mouse down events.
2285 *
2286 * @protected
2287 * @param {jQuery.Event} e Mouse down event
2288 * @return {undefined|boolean} False to prevent default if event is handled
2289 */
2290 OO.ui.mixin.ButtonElement.prototype.onMouseDown = function ( e ) {
2291 if ( this.isDisabled() || e.which !== OO.ui.MouseButtons.LEFT ) {
2292 return;
2293 }
2294 this.$element.addClass( 'oo-ui-buttonElement-pressed' );
2295 // Run the mouseup handler no matter where the mouse is when the button is let go, so we can
2296 // reliably remove the pressed class
2297 this.getElementDocument().addEventListener( 'mouseup', this.onDocumentMouseUpHandler, true );
2298 // Prevent change of focus unless specifically configured otherwise
2299 if ( this.constructor.static.cancelButtonMouseDownEvents ) {
2300 return false;
2301 }
2302 };
2303
2304 /**
2305 * Handles document mouse up events.
2306 *
2307 * @protected
2308 * @param {MouseEvent} e Mouse up event
2309 */
2310 OO.ui.mixin.ButtonElement.prototype.onDocumentMouseUp = function ( e ) {
2311 if ( this.isDisabled() || e.which !== OO.ui.MouseButtons.LEFT ) {
2312 return;
2313 }
2314 this.$element.removeClass( 'oo-ui-buttonElement-pressed' );
2315 // Stop listening for mouseup, since we only needed this once
2316 this.getElementDocument().removeEventListener( 'mouseup', this.onDocumentMouseUpHandler, true );
2317 };
2318
2319 /**
2320 * Handles mouse click events.
2321 *
2322 * @protected
2323 * @param {jQuery.Event} e Mouse click event
2324 * @fires click
2325 * @return {undefined|boolean} False to prevent default if event is handled
2326 */
2327 OO.ui.mixin.ButtonElement.prototype.onClick = function ( e ) {
2328 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
2329 if ( this.emit( 'click' ) ) {
2330 return false;
2331 }
2332 }
2333 };
2334
2335 /**
2336 * Handles key down events.
2337 *
2338 * @protected
2339 * @param {jQuery.Event} e Key down event
2340 */
2341 OO.ui.mixin.ButtonElement.prototype.onKeyDown = function ( e ) {
2342 if ( this.isDisabled() || ( e.which !== OO.ui.Keys.SPACE && e.which !== OO.ui.Keys.ENTER ) ) {
2343 return;
2344 }
2345 this.$element.addClass( 'oo-ui-buttonElement-pressed' );
2346 // Run the keyup handler no matter where the key is when the button is let go, so we can
2347 // reliably remove the pressed class
2348 this.getElementDocument().addEventListener( 'keyup', this.onDocumentKeyUpHandler, true );
2349 };
2350
2351 /**
2352 * Handles document key up events.
2353 *
2354 * @protected
2355 * @param {KeyboardEvent} e Key up event
2356 */
2357 OO.ui.mixin.ButtonElement.prototype.onDocumentKeyUp = function ( e ) {
2358 if ( this.isDisabled() || ( e.which !== OO.ui.Keys.SPACE && e.which !== OO.ui.Keys.ENTER ) ) {
2359 return;
2360 }
2361 this.$element.removeClass( 'oo-ui-buttonElement-pressed' );
2362 // Stop listening for keyup, since we only needed this once
2363 this.getElementDocument().removeEventListener( 'keyup', this.onDocumentKeyUpHandler, true );
2364 };
2365
2366 /**
2367 * Handles key press events.
2368 *
2369 * @protected
2370 * @param {jQuery.Event} e Key press event
2371 * @fires click
2372 * @return {undefined|boolean} False to prevent default if event is handled
2373 */
2374 OO.ui.mixin.ButtonElement.prototype.onKeyPress = function ( e ) {
2375 if ( !this.isDisabled() && ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER ) ) {
2376 if ( this.emit( 'click' ) ) {
2377 return false;
2378 }
2379 }
2380 };
2381
2382 /**
2383 * Check if button has a frame.
2384 *
2385 * @return {boolean} Button is framed
2386 */
2387 OO.ui.mixin.ButtonElement.prototype.isFramed = function () {
2388 return this.framed;
2389 };
2390
2391 /**
2392 * Render the button with or without a frame. Omit the `framed` parameter to toggle the button frame
2393 * on and off.
2394 *
2395 * @param {boolean} [framed] Make button framed, omit to toggle
2396 * @chainable
2397 * @return {OO.ui.Element} The element, for chaining
2398 */
2399 OO.ui.mixin.ButtonElement.prototype.toggleFramed = function ( framed ) {
2400 framed = framed === undefined ? !this.framed : !!framed;
2401 if ( framed !== this.framed ) {
2402 this.framed = framed;
2403 this.$element
2404 .toggleClass( 'oo-ui-buttonElement-frameless', !framed )
2405 .toggleClass( 'oo-ui-buttonElement-framed', framed );
2406 this.updateThemeClasses();
2407 }
2408
2409 return this;
2410 };
2411
2412 /**
2413 * Set the button's active state.
2414 *
2415 * The active state can be set on:
2416 *
2417 * - {@link OO.ui.ButtonOptionWidget ButtonOptionWidget} when it is selected
2418 * - {@link OO.ui.ToggleButtonWidget ToggleButtonWidget} when it is toggle on
2419 * - {@link OO.ui.ButtonWidget ButtonWidget} when clicking the button would only refresh the page
2420 *
2421 * @protected
2422 * @param {boolean} value Make button active
2423 * @chainable
2424 * @return {OO.ui.Element} The element, for chaining
2425 */
2426 OO.ui.mixin.ButtonElement.prototype.setActive = function ( value ) {
2427 this.active = !!value;
2428 this.$element.toggleClass( 'oo-ui-buttonElement-active', this.active );
2429 this.updateThemeClasses();
2430 return this;
2431 };
2432
2433 /**
2434 * Check if the button is active
2435 *
2436 * @protected
2437 * @return {boolean} The button is active
2438 */
2439 OO.ui.mixin.ButtonElement.prototype.isActive = function () {
2440 return this.active;
2441 };
2442
2443 /**
2444 * Any OOUI widget that contains other widgets (such as {@link OO.ui.ButtonWidget buttons} or
2445 * {@link OO.ui.OptionWidget options}) mixes in GroupElement. Adding, removing, and clearing
2446 * items from the group is done through the interface the class provides.
2447 * For more information, please see the [OOUI documentation on MediaWiki] [1].
2448 *
2449 * [1]: https://www.mediawiki.org/wiki/OOUI/Elements/Groups
2450 *
2451 * @abstract
2452 * @mixins OO.EmitterList
2453 * @class
2454 *
2455 * @constructor
2456 * @param {Object} [config] Configuration options
2457 * @cfg {jQuery} [$group] The container element created by the class. If this configuration
2458 * is omitted, the group element will use a generated `<div>`.
2459 */
2460 OO.ui.mixin.GroupElement = function OoUiMixinGroupElement( config ) {
2461 // Configuration initialization
2462 config = config || {};
2463
2464 // Mixin constructors
2465 OO.EmitterList.call( this, config );
2466
2467 // Properties
2468 this.$group = null;
2469
2470 // Initialization
2471 this.setGroupElement( config.$group || $( '<div>' ) );
2472 };
2473
2474 /* Setup */
2475
2476 OO.mixinClass( OO.ui.mixin.GroupElement, OO.EmitterList );
2477
2478 /* Events */
2479
2480 /**
2481 * @event change
2482 *
2483 * A change event is emitted when the set of selected items changes.
2484 *
2485 * @param {OO.ui.Element[]} items Items currently in the group
2486 */
2487
2488 /* Methods */
2489
2490 /**
2491 * Set the group element.
2492 *
2493 * If an element is already set, items will be moved to the new element.
2494 *
2495 * @param {jQuery} $group Element to use as group
2496 */
2497 OO.ui.mixin.GroupElement.prototype.setGroupElement = function ( $group ) {
2498 var i, len;
2499
2500 this.$group = $group;
2501 for ( i = 0, len = this.items.length; i < len; i++ ) {
2502 this.$group.append( this.items[ i ].$element );
2503 }
2504 };
2505
2506 /**
2507 * Find an item by its data.
2508 *
2509 * Only the first item with matching data will be returned. To return all matching items,
2510 * use the #findItemsFromData method.
2511 *
2512 * @param {Object} data Item data to search for
2513 * @return {OO.ui.Element|null} Item with equivalent data, `null` if none exists
2514 */
2515 OO.ui.mixin.GroupElement.prototype.findItemFromData = function ( data ) {
2516 var i, len, item,
2517 hash = OO.getHash( data );
2518
2519 for ( i = 0, len = this.items.length; i < len; i++ ) {
2520 item = this.items[ i ];
2521 if ( hash === OO.getHash( item.getData() ) ) {
2522 return item;
2523 }
2524 }
2525
2526 return null;
2527 };
2528
2529 /**
2530 * Find items by their data.
2531 *
2532 * All items with matching data will be returned. To return only the first match, use the
2533 * #findItemFromData method instead.
2534 *
2535 * @param {Object} data Item data to search for
2536 * @return {OO.ui.Element[]} Items with equivalent data
2537 */
2538 OO.ui.mixin.GroupElement.prototype.findItemsFromData = function ( data ) {
2539 var i, len, item,
2540 hash = OO.getHash( data ),
2541 items = [];
2542
2543 for ( i = 0, len = this.items.length; i < len; i++ ) {
2544 item = this.items[ i ];
2545 if ( hash === OO.getHash( item.getData() ) ) {
2546 items.push( item );
2547 }
2548 }
2549
2550 return items;
2551 };
2552
2553 /**
2554 * Add items to the group.
2555 *
2556 * Items will be added to the end of the group array unless the optional `index` parameter
2557 * specifies a different insertion point. Adding an existing item will move it to the end of the
2558 * array or the point specified by the `index`.
2559 *
2560 * @param {OO.ui.Element[]} items An array of items to add to the group
2561 * @param {number} [index] Index of the insertion point
2562 * @chainable
2563 * @return {OO.ui.Element} The element, for chaining
2564 */
2565 OO.ui.mixin.GroupElement.prototype.addItems = function ( items, index ) {
2566
2567 if ( items.length === 0 ) {
2568 return this;
2569 }
2570
2571 // Mixin method
2572 OO.EmitterList.prototype.addItems.call( this, items, index );
2573
2574 this.emit( 'change', this.getItems() );
2575 return this;
2576 };
2577
2578 /**
2579 * @inheritdoc
2580 */
2581 OO.ui.mixin.GroupElement.prototype.moveItem = function ( items, newIndex ) {
2582 // insertItemElements expects this.items to not have been modified yet, so call before the mixin
2583 this.insertItemElements( items, newIndex );
2584
2585 // Mixin method
2586 newIndex = OO.EmitterList.prototype.moveItem.call( this, items, newIndex );
2587
2588 return newIndex;
2589 };
2590
2591 /**
2592 * @inheritdoc
2593 */
2594 OO.ui.mixin.GroupElement.prototype.insertItem = function ( item, index ) {
2595 item.setElementGroup( this );
2596 this.insertItemElements( item, index );
2597
2598 // Mixin method
2599 index = OO.EmitterList.prototype.insertItem.call( this, item, index );
2600
2601 return index;
2602 };
2603
2604 /**
2605 * Insert elements into the group
2606 *
2607 * @private
2608 * @param {OO.ui.Element} itemWidget Item to insert
2609 * @param {number} index Insertion index
2610 */
2611 OO.ui.mixin.GroupElement.prototype.insertItemElements = function ( itemWidget, index ) {
2612 if ( index === undefined || index < 0 || index >= this.items.length ) {
2613 this.$group.append( itemWidget.$element );
2614 } else if ( index === 0 ) {
2615 this.$group.prepend( itemWidget.$element );
2616 } else {
2617 this.items[ index ].$element.before( itemWidget.$element );
2618 }
2619 };
2620
2621 /**
2622 * Remove the specified items from a group.
2623 *
2624 * Removed items are detached (not removed) from the DOM so that they may be reused.
2625 * To remove all items from a group, you may wish to use the #clearItems method instead.
2626 *
2627 * @param {OO.ui.Element[]} items An array of items to remove
2628 * @chainable
2629 * @return {OO.ui.Element} The element, for chaining
2630 */
2631 OO.ui.mixin.GroupElement.prototype.removeItems = function ( items ) {
2632 var i, len, item, index;
2633
2634 if ( items.length === 0 ) {
2635 return this;
2636 }
2637
2638 // Remove specific items elements
2639 for ( i = 0, len = items.length; i < len; i++ ) {
2640 item = items[ i ];
2641 index = this.items.indexOf( item );
2642 if ( index !== -1 ) {
2643 item.setElementGroup( null );
2644 item.$element.detach();
2645 }
2646 }
2647
2648 // Mixin method
2649 OO.EmitterList.prototype.removeItems.call( this, items );
2650
2651 this.emit( 'change', this.getItems() );
2652 return this;
2653 };
2654
2655 /**
2656 * Clear all items from the group.
2657 *
2658 * Cleared items are detached from the DOM, not removed, so that they may be reused.
2659 * To remove only a subset of items from a group, use the #removeItems method.
2660 *
2661 * @chainable
2662 * @return {OO.ui.Element} The element, for chaining
2663 */
2664 OO.ui.mixin.GroupElement.prototype.clearItems = function () {
2665 var i, len;
2666
2667 // Remove all item elements
2668 for ( i = 0, len = this.items.length; i < len; i++ ) {
2669 this.items[ i ].setElementGroup( null );
2670 this.items[ i ].$element.detach();
2671 }
2672
2673 // Mixin method
2674 OO.EmitterList.prototype.clearItems.call( this );
2675
2676 this.emit( 'change', this.getItems() );
2677 return this;
2678 };
2679
2680 /**
2681 * LabelElement is often mixed into other classes to generate a label, which
2682 * helps identify the function of an interface element.
2683 * See the [OOUI documentation on MediaWiki] [1] for more information.
2684 *
2685 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Labels
2686 *
2687 * @abstract
2688 * @class
2689 *
2690 * @constructor
2691 * @param {Object} [config] Configuration options
2692 * @cfg {jQuery} [$label] The label element created by the class. If this
2693 * configuration is omitted, the label element will use a generated `<span>`.
2694 * @cfg {jQuery|string|Function|OO.ui.HtmlSnippet} [label] The label text. The label can be
2695 * specified as a plaintext string, a jQuery selection of elements, or a function that will
2696 * produce a string in the future. See the [OOUI documentation on MediaWiki] [2] for examples.
2697 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Labels
2698 * @cfg {boolean} [invisibleLabel] Whether the label should be visually hidden (but still
2699 * accessible to screen-readers).
2700 */
2701 OO.ui.mixin.LabelElement = function OoUiMixinLabelElement( config ) {
2702 // Configuration initialization
2703 config = config || {};
2704
2705 // Properties
2706 this.$label = null;
2707 this.label = null;
2708 this.invisibleLabel = null;
2709
2710 // Initialization
2711 this.setLabel( config.label || this.constructor.static.label );
2712 this.setLabelElement( config.$label || $( '<span>' ) );
2713 this.setInvisibleLabel( config.invisibleLabel );
2714 };
2715
2716 /* Setup */
2717
2718 OO.initClass( OO.ui.mixin.LabelElement );
2719
2720 /* Events */
2721
2722 /**
2723 * @event labelChange
2724 * @param {string} value
2725 */
2726
2727 /* Static Properties */
2728
2729 /**
2730 * The label text. The label can be specified as a plaintext string, a function that will
2731 * produce a string in the future, or `null` for no label. The static value will
2732 * be overridden if a label is specified with the #label config option.
2733 *
2734 * @static
2735 * @inheritable
2736 * @property {string|Function|null}
2737 */
2738 OO.ui.mixin.LabelElement.static.label = null;
2739
2740 /* Static methods */
2741
2742 /**
2743 * Highlight the first occurrence of the query in the given text
2744 *
2745 * @param {string} text Text
2746 * @param {string} query Query to find
2747 * @param {Function} [compare] Optional string comparator, e.g. Intl.Collator().compare
2748 * @return {jQuery} Text with the first match of the query
2749 * sub-string wrapped in highlighted span
2750 */
2751 OO.ui.mixin.LabelElement.static.highlightQuery = function ( text, query, compare ) {
2752 var i, tLen, qLen,
2753 offset = -1,
2754 $result = $( '<span>' );
2755
2756 if ( compare ) {
2757 tLen = text.length;
2758 qLen = query.length;
2759 for ( i = 0; offset === -1 && i <= tLen - qLen; i++ ) {
2760 if ( compare( query, text.slice( i, i + qLen ) ) === 0 ) {
2761 offset = i;
2762 }
2763 }
2764 } else {
2765 offset = text.toLowerCase().indexOf( query.toLowerCase() );
2766 }
2767
2768 if ( !query.length || offset === -1 ) {
2769 $result.text( text );
2770 } else {
2771 $result.append(
2772 document.createTextNode( text.slice( 0, offset ) ),
2773 $( '<span>' )
2774 .addClass( 'oo-ui-labelElement-label-highlight' )
2775 .text( text.slice( offset, offset + query.length ) ),
2776 document.createTextNode( text.slice( offset + query.length ) )
2777 );
2778 }
2779 return $result.contents();
2780 };
2781
2782 /* Methods */
2783
2784 /**
2785 * Set the label element.
2786 *
2787 * If an element is already set, it will be cleaned up before setting up the new element.
2788 *
2789 * @param {jQuery} $label Element to use as label
2790 */
2791 OO.ui.mixin.LabelElement.prototype.setLabelElement = function ( $label ) {
2792 if ( this.$label ) {
2793 this.$label.removeClass( 'oo-ui-labelElement-label' ).empty();
2794 }
2795
2796 this.$label = $label.addClass( 'oo-ui-labelElement-label' );
2797 this.setLabelContent( this.label );
2798 };
2799
2800 /**
2801 * Set the label.
2802 *
2803 * An empty string will result in the label being hidden. A string containing only whitespace will
2804 * be converted to a single `&nbsp;`.
2805 *
2806 * @param {jQuery|string|OO.ui.HtmlSnippet|Function|null} label Label nodes; text; a function that
2807 * returns nodes or text; or null for no label
2808 * @chainable
2809 * @return {OO.ui.Element} The element, for chaining
2810 */
2811 OO.ui.mixin.LabelElement.prototype.setLabel = function ( label ) {
2812 label = typeof label === 'function' ? OO.ui.resolveMsg( label ) : label;
2813 label = ( ( typeof label === 'string' || label instanceof $ ) && label.length ) || ( label instanceof OO.ui.HtmlSnippet && label.toString().length ) ? label : null;
2814
2815 if ( this.label !== label ) {
2816 if ( this.$label ) {
2817 this.setLabelContent( label );
2818 }
2819 this.label = label;
2820 this.emit( 'labelChange' );
2821 }
2822
2823 this.$element.toggleClass( 'oo-ui-labelElement', !!this.label && !this.invisibleLabel );
2824
2825 return this;
2826 };
2827
2828 /**
2829 * Set whether the label should be visually hidden (but still accessible to screen-readers).
2830 *
2831 * @param {boolean} invisibleLabel
2832 * @chainable
2833 * @return {OO.ui.Element} The element, for chaining
2834 */
2835 OO.ui.mixin.LabelElement.prototype.setInvisibleLabel = function ( invisibleLabel ) {
2836 invisibleLabel = !!invisibleLabel;
2837
2838 if ( this.invisibleLabel !== invisibleLabel ) {
2839 this.invisibleLabel = invisibleLabel;
2840 this.emit( 'labelChange' );
2841 }
2842
2843 this.$label.toggleClass( 'oo-ui-labelElement-invisible', this.invisibleLabel );
2844 // Pretend that there is no label, a lot of CSS has been written with this assumption
2845 this.$element.toggleClass( 'oo-ui-labelElement', !!this.label && !this.invisibleLabel );
2846
2847 return this;
2848 };
2849
2850 /**
2851 * Set the label as plain text with a highlighted query
2852 *
2853 * @param {string} text Text label to set
2854 * @param {string} query Substring of text to highlight
2855 * @param {Function} [compare] Optional string comparator, e.g. Intl.Collator().compare
2856 * @chainable
2857 * @return {OO.ui.Element} The element, for chaining
2858 */
2859 OO.ui.mixin.LabelElement.prototype.setHighlightedQuery = function ( text, query, compare ) {
2860 return this.setLabel( this.constructor.static.highlightQuery( text, query, compare ) );
2861 };
2862
2863 /**
2864 * Get the label.
2865 *
2866 * @return {jQuery|string|Function|null} Label nodes; text; a function that returns nodes or
2867 * text; or null for no label
2868 */
2869 OO.ui.mixin.LabelElement.prototype.getLabel = function () {
2870 return this.label;
2871 };
2872
2873 /**
2874 * Set the content of the label.
2875 *
2876 * Do not call this method until after the label element has been set by #setLabelElement.
2877 *
2878 * @private
2879 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
2880 * text; or null for no label
2881 */
2882 OO.ui.mixin.LabelElement.prototype.setLabelContent = function ( label ) {
2883 if ( typeof label === 'string' ) {
2884 if ( label.match( /^\s*$/ ) ) {
2885 // Convert whitespace only string to a single non-breaking space
2886 this.$label.html( '&nbsp;' );
2887 } else {
2888 this.$label.text( label );
2889 }
2890 } else if ( label instanceof OO.ui.HtmlSnippet ) {
2891 this.$label.html( label.toString() );
2892 } else if ( label instanceof $ ) {
2893 this.$label.empty().append( label );
2894 } else {
2895 this.$label.empty();
2896 }
2897 };
2898
2899 /**
2900 * IconElement is often mixed into other classes to generate an icon.
2901 * Icons are graphics, about the size of normal text. They are used to aid the user
2902 * in locating a control or to convey information in a space-efficient way. See the
2903 * [OOUI documentation on MediaWiki] [1] for a list of icons
2904 * included in the library.
2905 *
2906 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Icons
2907 *
2908 * @abstract
2909 * @class
2910 *
2911 * @constructor
2912 * @param {Object} [config] Configuration options
2913 * @cfg {jQuery} [$icon] The icon element created by the class. If this configuration is omitted,
2914 * the icon element will use a generated `<span>`. To use a different HTML tag, or to specify that
2915 * the icon element be set to an existing icon instead of the one generated by this class, set a
2916 * value using a jQuery selection. For example:
2917 *
2918 * // Use a <div> tag instead of a <span>
2919 * $icon: $( '<div>' )
2920 * // Use an existing icon element instead of the one generated by the class
2921 * $icon: this.$element
2922 * // Use an icon element from a child widget
2923 * $icon: this.childwidget.$element
2924 * @cfg {Object|string} [icon=''] The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a
2925 * map of symbolic names. A map is used for i18n purposes and contains a `default` icon
2926 * name and additional names keyed by language code. The `default` name is used when no icon is
2927 * keyed by the user's language.
2928 *
2929 * Example of an i18n map:
2930 *
2931 * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
2932 * See the [OOUI documentation on MediaWiki] [2] for a list of icons included in the library.
2933 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Icons
2934 */
2935 OO.ui.mixin.IconElement = function OoUiMixinIconElement( config ) {
2936 // Configuration initialization
2937 config = config || {};
2938
2939 // Properties
2940 this.$icon = null;
2941 this.icon = null;
2942
2943 // Initialization
2944 this.setIcon( config.icon || this.constructor.static.icon );
2945 this.setIconElement( config.$icon || $( '<span>' ) );
2946 };
2947
2948 /* Setup */
2949
2950 OO.initClass( OO.ui.mixin.IconElement );
2951
2952 /* Static Properties */
2953
2954 /**
2955 * The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of symbolic names. A map
2956 * is used for i18n purposes and contains a `default` icon name and additional names keyed by
2957 * language code. The `default` name is used when no icon is keyed by the user's language.
2958 *
2959 * Example of an i18n map:
2960 *
2961 * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
2962 *
2963 * Note: the static property will be overridden if the #icon configuration is used.
2964 *
2965 * @static
2966 * @inheritable
2967 * @property {Object|string}
2968 */
2969 OO.ui.mixin.IconElement.static.icon = null;
2970
2971 /**
2972 * The icon title, displayed when users move the mouse over the icon. The value can be text, a
2973 * function that returns title text, or `null` for no title.
2974 *
2975 * The static property will be overridden if the #iconTitle configuration is used.
2976 *
2977 * @static
2978 * @inheritable
2979 * @property {string|Function|null}
2980 */
2981 OO.ui.mixin.IconElement.static.iconTitle = null;
2982
2983 /* Methods */
2984
2985 /**
2986 * Set the icon element. This method is used to retarget an icon mixin so that its functionality
2987 * applies to the specified icon element instead of the one created by the class. If an icon
2988 * element is already set, the mixin’s effect on that element is removed. Generated CSS classes
2989 * and mixin methods will no longer affect the element.
2990 *
2991 * @param {jQuery} $icon Element to use as icon
2992 */
2993 OO.ui.mixin.IconElement.prototype.setIconElement = function ( $icon ) {
2994 if ( this.$icon ) {
2995 this.$icon
2996 .removeClass( 'oo-ui-iconElement-icon oo-ui-icon-' + this.icon )
2997 .removeAttr( 'title' );
2998 }
2999
3000 this.$icon = $icon
3001 .addClass( 'oo-ui-iconElement-icon' )
3002 .toggleClass( 'oo-ui-iconElement-noIcon', !this.icon )
3003 .toggleClass( 'oo-ui-icon-' + this.icon, !!this.icon );
3004 if ( this.iconTitle !== null ) {
3005 this.$icon.attr( 'title', this.iconTitle );
3006 }
3007
3008 this.updateThemeClasses();
3009 };
3010
3011 /**
3012 * Set icon by symbolic name (e.g., ‘remove’ or ‘menu’). Use `null` to remove an icon.
3013 * The icon parameter can also be set to a map of icon names. See the #icon config setting
3014 * for an example.
3015 *
3016 * @param {Object|string|null} icon A symbolic icon name, a {@link #icon map of icon names} keyed
3017 * by language code, or `null` to remove the icon.
3018 * @chainable
3019 * @return {OO.ui.Element} The element, for chaining
3020 */
3021 OO.ui.mixin.IconElement.prototype.setIcon = function ( icon ) {
3022 icon = OO.isPlainObject( icon ) ? OO.ui.getLocalValue( icon, null, 'default' ) : icon;
3023 icon = typeof icon === 'string' && icon.trim().length ? icon.trim() : null;
3024
3025 if ( this.icon !== icon ) {
3026 if ( this.$icon ) {
3027 if ( this.icon !== null ) {
3028 this.$icon.removeClass( 'oo-ui-icon-' + this.icon );
3029 }
3030 if ( icon !== null ) {
3031 this.$icon.addClass( 'oo-ui-icon-' + icon );
3032 }
3033 }
3034 this.icon = icon;
3035 }
3036
3037 this.$element.toggleClass( 'oo-ui-iconElement', !!this.icon );
3038 if ( this.$icon ) {
3039 this.$icon.toggleClass( 'oo-ui-iconElement-noIcon', !this.icon );
3040 }
3041 this.updateThemeClasses();
3042
3043 return this;
3044 };
3045
3046 /**
3047 * Get the symbolic name of the icon.
3048 *
3049 * @return {string} Icon name
3050 */
3051 OO.ui.mixin.IconElement.prototype.getIcon = function () {
3052 return this.icon;
3053 };
3054
3055 /**
3056 * Get the icon title. The title text is displayed when a user moves the mouse over the icon.
3057 *
3058 * @return {string} Icon title text
3059 * @deprecated
3060 */
3061 OO.ui.mixin.IconElement.prototype.getIconTitle = function () {
3062 return this.iconTitle;
3063 };
3064
3065 /**
3066 * IndicatorElement is often mixed into other classes to generate an indicator.
3067 * Indicators are small graphics that are generally used in two ways:
3068 *
3069 * - To draw attention to the status of an item. For example, an indicator might be
3070 * used to show that an item in a list has errors that need to be resolved.
3071 * - To clarify the function of a control that acts in an exceptional way (a button
3072 * that opens a menu instead of performing an action directly, for example).
3073 *
3074 * For a list of indicators included in the library, please see the
3075 * [OOUI documentation on MediaWiki] [1].
3076 *
3077 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Indicators
3078 *
3079 * @abstract
3080 * @class
3081 *
3082 * @constructor
3083 * @param {Object} [config] Configuration options
3084 * @cfg {jQuery} [$indicator] The indicator element created by the class. If this
3085 * configuration is omitted, the indicator element will use a generated `<span>`.
3086 * @cfg {string} [indicator] Symbolic name of the indicator (e.g., ‘clear’ or ‘down’).
3087 * See the [OOUI documentation on MediaWiki][2] for a list of indicators included
3088 * in the library.
3089 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Indicators
3090 */
3091 OO.ui.mixin.IndicatorElement = function OoUiMixinIndicatorElement( config ) {
3092 // Configuration initialization
3093 config = config || {};
3094
3095 // Properties
3096 this.$indicator = null;
3097 this.indicator = null;
3098
3099 // Initialization
3100 this.setIndicator( config.indicator || this.constructor.static.indicator );
3101 this.setIndicatorElement( config.$indicator || $( '<span>' ) );
3102 };
3103
3104 /* Setup */
3105
3106 OO.initClass( OO.ui.mixin.IndicatorElement );
3107
3108 /* Static Properties */
3109
3110 /**
3111 * Symbolic name of the indicator (e.g., ‘clear’ or ‘down’).
3112 * The static property will be overridden if the #indicator configuration is used.
3113 *
3114 * @static
3115 * @inheritable
3116 * @property {string|null}
3117 */
3118 OO.ui.mixin.IndicatorElement.static.indicator = null;
3119
3120 /**
3121 * A text string used as the indicator title, a function that returns title text, or `null`
3122 * for no title. The static property will be overridden if the #indicatorTitle configuration is
3123 * used.
3124 *
3125 * @static
3126 * @inheritable
3127 * @property {string|Function|null}
3128 */
3129 OO.ui.mixin.IndicatorElement.static.indicatorTitle = null;
3130
3131 /* Methods */
3132
3133 /**
3134 * Set the indicator element.
3135 *
3136 * If an element is already set, it will be cleaned up before setting up the new element.
3137 *
3138 * @param {jQuery} $indicator Element to use as indicator
3139 */
3140 OO.ui.mixin.IndicatorElement.prototype.setIndicatorElement = function ( $indicator ) {
3141 if ( this.$indicator ) {
3142 this.$indicator
3143 .removeClass( 'oo-ui-indicatorElement-indicator oo-ui-indicator-' + this.indicator )
3144 .removeAttr( 'title' );
3145 }
3146
3147 this.$indicator = $indicator
3148 .addClass( 'oo-ui-indicatorElement-indicator' )
3149 .toggleClass( 'oo-ui-indicatorElement-noIndicator', !this.indicator )
3150 .toggleClass( 'oo-ui-indicator-' + this.indicator, !!this.indicator );
3151 if ( this.indicatorTitle !== null ) {
3152 this.$indicator.attr( 'title', this.indicatorTitle );
3153 }
3154
3155 this.updateThemeClasses();
3156 };
3157
3158 /**
3159 * Set the indicator by its symbolic name: ‘clear’, ‘down’, ‘required’, ‘search’, ‘up’. Use `null`
3160 * to remove the indicator.
3161 *
3162 * @param {string|null} indicator Symbolic name of indicator, or `null` for no indicator
3163 * @chainable
3164 * @return {OO.ui.Element} The element, for chaining
3165 */
3166 OO.ui.mixin.IndicatorElement.prototype.setIndicator = function ( indicator ) {
3167 indicator = typeof indicator === 'string' && indicator.length ? indicator.trim() : null;
3168
3169 if ( this.indicator !== indicator ) {
3170 if ( this.$indicator ) {
3171 if ( this.indicator !== null ) {
3172 this.$indicator.removeClass( 'oo-ui-indicator-' + this.indicator );
3173 }
3174 if ( indicator !== null ) {
3175 this.$indicator.addClass( 'oo-ui-indicator-' + indicator );
3176 }
3177 }
3178 this.indicator = indicator;
3179 }
3180
3181 this.$element.toggleClass( 'oo-ui-indicatorElement', !!this.indicator );
3182 if ( this.$indicator ) {
3183 this.$indicator.toggleClass( 'oo-ui-indicatorElement-noIndicator', !this.indicator );
3184 }
3185 this.updateThemeClasses();
3186
3187 return this;
3188 };
3189
3190 /**
3191 * Get the symbolic name of the indicator (e.g., ‘clear’ or ‘down’).
3192 *
3193 * @return {string} Symbolic name of indicator
3194 */
3195 OO.ui.mixin.IndicatorElement.prototype.getIndicator = function () {
3196 return this.indicator;
3197 };
3198
3199 /**
3200 * Get the indicator title.
3201 *
3202 * The title is displayed when a user moves the mouse over the indicator.
3203 *
3204 * @return {string} Indicator title text
3205 * @deprecated
3206 */
3207 OO.ui.mixin.IndicatorElement.prototype.getIndicatorTitle = function () {
3208 return this.indicatorTitle;
3209 };
3210
3211 /**
3212 * The FlaggedElement class is an attribute mixin, meaning that it is used to add
3213 * additional functionality to an element created by another class. The class provides
3214 * a ‘flags’ property assigned the name (or an array of names) of styling flags,
3215 * which are used to customize the look and feel of a widget to better describe its
3216 * importance and functionality.
3217 *
3218 * The library currently contains the following styling flags for general use:
3219 *
3220 * - **progressive**: Progressive styling is applied to convey that the widget will move the user
3221 * forward in a process.
3222 * - **destructive**: Destructive styling is applied to convey that the widget will remove
3223 * something.
3224 *
3225 * The flags affect the appearance of the buttons:
3226 *
3227 * @example
3228 * // FlaggedElement is mixed into ButtonWidget to provide styling flags
3229 * var button1 = new OO.ui.ButtonWidget( {
3230 * label: 'Progressive',
3231 * flags: 'progressive'
3232 * } ),
3233 * button2 = new OO.ui.ButtonWidget( {
3234 * label: 'Destructive',
3235 * flags: 'destructive'
3236 * } );
3237 * $( document.body ).append( button1.$element, button2.$element );
3238 *
3239 * {@link OO.ui.ActionWidget ActionWidgets}, which are a special kind of button that execute an
3240 * action, use these flags: **primary** and **safe**.
3241 * Please see the [OOUI documentation on MediaWiki] [1] for more information.
3242 *
3243 * [1]: https://www.mediawiki.org/wiki/OOUI/Elements/Flagged
3244 *
3245 * @abstract
3246 * @class
3247 *
3248 * @constructor
3249 * @param {Object} [config] Configuration options
3250 * @cfg {string|string[]} [flags] The name or names of the flags (e.g., 'progressive' or 'primary')
3251 * to apply.
3252 * Please see the [OOUI documentation on MediaWiki] [2] for more information about available flags.
3253 * [2]: https://www.mediawiki.org/wiki/OOUI/Elements/Flagged
3254 * @cfg {jQuery} [$flagged] The flagged element. By default,
3255 * the flagged functionality is applied to the element created by the class ($element).
3256 * If a different element is specified, the flagged functionality will be applied to it instead.
3257 */
3258 OO.ui.mixin.FlaggedElement = function OoUiMixinFlaggedElement( config ) {
3259 // Configuration initialization
3260 config = config || {};
3261
3262 // Properties
3263 this.flags = {};
3264 this.$flagged = null;
3265
3266 // Initialization
3267 this.setFlags( config.flags || this.constructor.static.flags );
3268 this.setFlaggedElement( config.$flagged || this.$element );
3269 };
3270
3271 /* Setup */
3272
3273 OO.initClass( OO.ui.mixin.FlaggedElement );
3274
3275 /* Events */
3276
3277 /**
3278 * @event flag
3279 * A flag event is emitted when the #clearFlags or #setFlags methods are used. The `changes`
3280 * parameter contains the name of each modified flag and indicates whether it was
3281 * added or removed.
3282 *
3283 * @param {Object.<string,boolean>} changes Object keyed by flag name. A Boolean `true` indicates
3284 * that the flag was added, `false` that the flag was removed.
3285 */
3286
3287 /* Static Properties */
3288
3289 /**
3290 * Initial value to pass to setFlags if no value is provided in config.
3291 *
3292 * @static
3293 * @inheritable
3294 * @property {string|string[]|Object.<string, boolean>}
3295 */
3296 OO.ui.mixin.FlaggedElement.static.flags = null;
3297
3298 /* Methods */
3299
3300 /**
3301 * Set the flagged element.
3302 *
3303 * This method is used to retarget a flagged mixin so that its functionality applies to the
3304 * specified element.
3305 * If an element is already set, the method will remove the mixin’s effect on that element.
3306 *
3307 * @param {jQuery} $flagged Element that should be flagged
3308 */
3309 OO.ui.mixin.FlaggedElement.prototype.setFlaggedElement = function ( $flagged ) {
3310 var classNames = Object.keys( this.flags ).map( function ( flag ) {
3311 return 'oo-ui-flaggedElement-' + flag;
3312 } );
3313
3314 if ( this.$flagged ) {
3315 this.$flagged.removeClass( classNames );
3316 }
3317
3318 this.$flagged = $flagged.addClass( classNames );
3319 };
3320
3321 /**
3322 * Check if the specified flag is set.
3323 *
3324 * @param {string} flag Name of flag
3325 * @return {boolean} The flag is set
3326 */
3327 OO.ui.mixin.FlaggedElement.prototype.hasFlag = function ( flag ) {
3328 // This may be called before the constructor, thus before this.flags is set
3329 return this.flags && ( flag in this.flags );
3330 };
3331
3332 /**
3333 * Get the names of all flags set.
3334 *
3335 * @return {string[]} Flag names
3336 */
3337 OO.ui.mixin.FlaggedElement.prototype.getFlags = function () {
3338 // This may be called before the constructor, thus before this.flags is set
3339 return Object.keys( this.flags || {} );
3340 };
3341
3342 /**
3343 * Clear all flags.
3344 *
3345 * @chainable
3346 * @return {OO.ui.Element} The element, for chaining
3347 * @fires flag
3348 */
3349 OO.ui.mixin.FlaggedElement.prototype.clearFlags = function () {
3350 var flag, className,
3351 changes = {},
3352 remove = [],
3353 classPrefix = 'oo-ui-flaggedElement-';
3354
3355 for ( flag in this.flags ) {
3356 className = classPrefix + flag;
3357 changes[ flag ] = false;
3358 delete this.flags[ flag ];
3359 remove.push( className );
3360 }
3361
3362 if ( this.$flagged ) {
3363 this.$flagged.removeClass( remove );
3364 }
3365
3366 this.updateThemeClasses();
3367 this.emit( 'flag', changes );
3368
3369 return this;
3370 };
3371
3372 /**
3373 * Add one or more flags.
3374 *
3375 * @param {string|string[]|Object.<string, boolean>} flags A flag name, an array of flag names,
3376 * or an object keyed by flag name with a boolean value that indicates whether the flag should
3377 * be added (`true`) or removed (`false`).
3378 * @chainable
3379 * @return {OO.ui.Element} The element, for chaining
3380 * @fires flag
3381 */
3382 OO.ui.mixin.FlaggedElement.prototype.setFlags = function ( flags ) {
3383 var i, len, flag, className,
3384 changes = {},
3385 add = [],
3386 remove = [],
3387 classPrefix = 'oo-ui-flaggedElement-';
3388
3389 if ( typeof flags === 'string' ) {
3390 className = classPrefix + flags;
3391 // Set
3392 if ( !this.flags[ flags ] ) {
3393 this.flags[ flags ] = true;
3394 add.push( className );
3395 }
3396 } else if ( Array.isArray( flags ) ) {
3397 for ( i = 0, len = flags.length; i < len; i++ ) {
3398 flag = flags[ i ];
3399 className = classPrefix + flag;
3400 // Set
3401 if ( !this.flags[ flag ] ) {
3402 changes[ flag ] = true;
3403 this.flags[ flag ] = true;
3404 add.push( className );
3405 }
3406 }
3407 } else if ( OO.isPlainObject( flags ) ) {
3408 for ( flag in flags ) {
3409 className = classPrefix + flag;
3410 if ( flags[ flag ] ) {
3411 // Set
3412 if ( !this.flags[ flag ] ) {
3413 changes[ flag ] = true;
3414 this.flags[ flag ] = true;
3415 add.push( className );
3416 }
3417 } else {
3418 // Remove
3419 if ( this.flags[ flag ] ) {
3420 changes[ flag ] = false;
3421 delete this.flags[ flag ];
3422 remove.push( className );
3423 }
3424 }
3425 }
3426 }
3427
3428 if ( this.$flagged ) {
3429 this.$flagged
3430 .addClass( add )
3431 .removeClass( remove );
3432 }
3433
3434 this.updateThemeClasses();
3435 this.emit( 'flag', changes );
3436
3437 return this;
3438 };
3439
3440 /**
3441 * TitledElement is mixed into other classes to provide a `title` attribute.
3442 * Titles are rendered by the browser and are made visible when the user moves
3443 * the mouse over the element. Titles are not visible on touch devices.
3444 *
3445 * @example
3446 * // TitledElement provides a `title` attribute to the
3447 * // ButtonWidget class.
3448 * var button = new OO.ui.ButtonWidget( {
3449 * label: 'Button with Title',
3450 * title: 'I am a button'
3451 * } );
3452 * $( document.body ).append( button.$element );
3453 *
3454 * @abstract
3455 * @class
3456 *
3457 * @constructor
3458 * @param {Object} [config] Configuration options
3459 * @cfg {jQuery} [$titled] The element to which the `title` attribute is applied.
3460 * If this config is omitted, the title functionality is applied to $element, the
3461 * element created by the class.
3462 * @cfg {string|Function} [title] The title text or a function that returns text. If
3463 * this config is omitted, the value of the {@link #static-title static title} property is used.
3464 */
3465 OO.ui.mixin.TitledElement = function OoUiMixinTitledElement( config ) {
3466 // Configuration initialization
3467 config = config || {};
3468
3469 // Properties
3470 this.$titled = null;
3471 this.title = null;
3472
3473 // Initialization
3474 this.setTitle( config.title !== undefined ? config.title : this.constructor.static.title );
3475 this.setTitledElement( config.$titled || this.$element );
3476 };
3477
3478 /* Setup */
3479
3480 OO.initClass( OO.ui.mixin.TitledElement );
3481
3482 /* Static Properties */
3483
3484 /**
3485 * The title text, a function that returns text, or `null` for no title. The value of the static
3486 * property is overridden if the #title config option is used.
3487 *
3488 * If the element has a default title (e.g. `<input type=file>`), `null` will allow that title to be
3489 * shown. Use empty string to suppress it.
3490 *
3491 * @static
3492 * @inheritable
3493 * @property {string|Function|null}
3494 */
3495 OO.ui.mixin.TitledElement.static.title = null;
3496
3497 /* Methods */
3498
3499 /**
3500 * Set the titled element.
3501 *
3502 * This method is used to retarget a TitledElement mixin so that its functionality applies to the
3503 * specified element.
3504 * If an element is already set, the mixin’s effect on that element is removed before the new
3505 * element is set up.
3506 *
3507 * @param {jQuery} $titled Element that should use the 'titled' functionality
3508 */
3509 OO.ui.mixin.TitledElement.prototype.setTitledElement = function ( $titled ) {
3510 if ( this.$titled ) {
3511 this.$titled.removeAttr( 'title' );
3512 }
3513
3514 this.$titled = $titled;
3515 this.updateTitle();
3516 };
3517
3518 /**
3519 * Set title.
3520 *
3521 * @param {string|Function|null} title Title text, a function that returns text, or `null`
3522 * for no title
3523 * @chainable
3524 * @return {OO.ui.Element} The element, for chaining
3525 */
3526 OO.ui.mixin.TitledElement.prototype.setTitle = function ( title ) {
3527 title = typeof title === 'function' ? OO.ui.resolveMsg( title ) : title;
3528 title = typeof title === 'string' ? title : null;
3529
3530 if ( this.title !== title ) {
3531 this.title = title;
3532 this.updateTitle();
3533 }
3534
3535 return this;
3536 };
3537
3538 /**
3539 * Update the title attribute, in case of changes to title or accessKey.
3540 *
3541 * @protected
3542 * @chainable
3543 * @return {OO.ui.Element} The element, for chaining
3544 */
3545 OO.ui.mixin.TitledElement.prototype.updateTitle = function () {
3546 var title = this.getTitle();
3547 if ( this.$titled ) {
3548 if ( title !== null ) {
3549 // Only if this is an AccessKeyedElement
3550 if ( this.formatTitleWithAccessKey ) {
3551 title = this.formatTitleWithAccessKey( title );
3552 }
3553 this.$titled.attr( 'title', title );
3554 } else {
3555 this.$titled.removeAttr( 'title' );
3556 }
3557 }
3558 return this;
3559 };
3560
3561 /**
3562 * Get title.
3563 *
3564 * @return {string} Title string
3565 */
3566 OO.ui.mixin.TitledElement.prototype.getTitle = function () {
3567 return this.title;
3568 };
3569
3570 /**
3571 * AccessKeyedElement is mixed into other classes to provide an `accesskey` HTML attribute.
3572 * Access keys allow an user to go to a specific element by using
3573 * a shortcut combination of a browser specific keys + the key
3574 * set to the field.
3575 *
3576 * @example
3577 * // AccessKeyedElement provides an `accesskey` attribute to the
3578 * // ButtonWidget class.
3579 * var button = new OO.ui.ButtonWidget( {
3580 * label: 'Button with access key',
3581 * accessKey: 'k'
3582 * } );
3583 * $( document.body ).append( button.$element );
3584 *
3585 * @abstract
3586 * @class
3587 *
3588 * @constructor
3589 * @param {Object} [config] Configuration options
3590 * @cfg {jQuery} [$accessKeyed] The element to which the `accesskey` attribute is applied.
3591 * If this config is omitted, the access key functionality is applied to $element, the
3592 * element created by the class.
3593 * @cfg {string|Function} [accessKey] The key or a function that returns the key. If
3594 * this config is omitted, no access key will be added.
3595 */
3596 OO.ui.mixin.AccessKeyedElement = function OoUiMixinAccessKeyedElement( config ) {
3597 // Configuration initialization
3598 config = config || {};
3599
3600 // Properties
3601 this.$accessKeyed = null;
3602 this.accessKey = null;
3603
3604 // Initialization
3605 this.setAccessKey( config.accessKey || null );
3606 this.setAccessKeyedElement( config.$accessKeyed || this.$element );
3607
3608 // If this is also a TitledElement and it initialized before we did, we may have
3609 // to update the title with the access key
3610 if ( this.updateTitle ) {
3611 this.updateTitle();
3612 }
3613 };
3614
3615 /* Setup */
3616
3617 OO.initClass( OO.ui.mixin.AccessKeyedElement );
3618
3619 /* Static Properties */
3620
3621 /**
3622 * The access key, a function that returns a key, or `null` for no access key.
3623 *
3624 * @static
3625 * @inheritable
3626 * @property {string|Function|null}
3627 */
3628 OO.ui.mixin.AccessKeyedElement.static.accessKey = null;
3629
3630 /* Methods */
3631
3632 /**
3633 * Set the access keyed element.
3634 *
3635 * This method is used to retarget a AccessKeyedElement mixin so that its functionality applies to
3636 * the specified element.
3637 * If an element is already set, the mixin's effect on that element is removed before the new
3638 * element is set up.
3639 *
3640 * @param {jQuery} $accessKeyed Element that should use the 'access keyed' functionality
3641 */
3642 OO.ui.mixin.AccessKeyedElement.prototype.setAccessKeyedElement = function ( $accessKeyed ) {
3643 if ( this.$accessKeyed ) {
3644 this.$accessKeyed.removeAttr( 'accesskey' );
3645 }
3646
3647 this.$accessKeyed = $accessKeyed;
3648 if ( this.accessKey ) {
3649 this.$accessKeyed.attr( 'accesskey', this.accessKey );
3650 }
3651 };
3652
3653 /**
3654 * Set access key.
3655 *
3656 * @param {string|Function|null} accessKey Key, a function that returns a key, or `null` for no
3657 * access key
3658 * @chainable
3659 * @return {OO.ui.Element} The element, for chaining
3660 */
3661 OO.ui.mixin.AccessKeyedElement.prototype.setAccessKey = function ( accessKey ) {
3662 accessKey = typeof accessKey === 'string' ? OO.ui.resolveMsg( accessKey ) : null;
3663
3664 if ( this.accessKey !== accessKey ) {
3665 if ( this.$accessKeyed ) {
3666 if ( accessKey !== null ) {
3667 this.$accessKeyed.attr( 'accesskey', accessKey );
3668 } else {
3669 this.$accessKeyed.removeAttr( 'accesskey' );
3670 }
3671 }
3672 this.accessKey = accessKey;
3673
3674 // Only if this is a TitledElement
3675 if ( this.updateTitle ) {
3676 this.updateTitle();
3677 }
3678 }
3679
3680 return this;
3681 };
3682
3683 /**
3684 * Get access key.
3685 *
3686 * @return {string} accessKey string
3687 */
3688 OO.ui.mixin.AccessKeyedElement.prototype.getAccessKey = function () {
3689 return this.accessKey;
3690 };
3691
3692 /**
3693 * Add information about the access key to the element's tooltip label.
3694 * (This is only public for hacky usage in FieldLayout.)
3695 *
3696 * @param {string} title Tooltip label for `title` attribute
3697 * @return {string}
3698 */
3699 OO.ui.mixin.AccessKeyedElement.prototype.formatTitleWithAccessKey = function ( title ) {
3700 var accessKey;
3701
3702 if ( !this.$accessKeyed ) {
3703 // Not initialized yet; the constructor will call updateTitle() which will rerun this
3704 // function.
3705 return title;
3706 }
3707 // Use jquery.accessKeyLabel if available to show modifiers, otherwise just display the
3708 // single key.
3709 if ( $.fn.updateTooltipAccessKeys && $.fn.updateTooltipAccessKeys.getAccessKeyLabel ) {
3710 accessKey = $.fn.updateTooltipAccessKeys.getAccessKeyLabel( this.$accessKeyed[ 0 ] );
3711 } else {
3712 accessKey = this.getAccessKey();
3713 }
3714 if ( accessKey ) {
3715 title += ' [' + accessKey + ']';
3716 }
3717 return title;
3718 };
3719
3720 /**
3721 * ButtonWidget is a generic widget for buttons. A wide variety of looks,
3722 * feels, and functionality can be customized via the class’s configuration options
3723 * and methods. Please see the [OOUI documentation on MediaWiki] [1] for more information
3724 * and examples.
3725 *
3726 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Buttons_and_Switches
3727 *
3728 * @example
3729 * // A button widget.
3730 * var button = new OO.ui.ButtonWidget( {
3731 * label: 'Button with Icon',
3732 * icon: 'trash',
3733 * title: 'Remove'
3734 * } );
3735 * $( document.body ).append( button.$element );
3736 *
3737 * NOTE: HTML form buttons should use the OO.ui.ButtonInputWidget class.
3738 *
3739 * @class
3740 * @extends OO.ui.Widget
3741 * @mixins OO.ui.mixin.ButtonElement
3742 * @mixins OO.ui.mixin.IconElement
3743 * @mixins OO.ui.mixin.IndicatorElement
3744 * @mixins OO.ui.mixin.LabelElement
3745 * @mixins OO.ui.mixin.TitledElement
3746 * @mixins OO.ui.mixin.FlaggedElement
3747 * @mixins OO.ui.mixin.TabIndexedElement
3748 * @mixins OO.ui.mixin.AccessKeyedElement
3749 *
3750 * @constructor
3751 * @param {Object} [config] Configuration options
3752 * @cfg {boolean} [active=false] Whether button should be shown as active
3753 * @cfg {string} [href] Hyperlink to visit when the button is clicked.
3754 * @cfg {string} [target] The frame or window in which to open the hyperlink.
3755 * @cfg {boolean} [noFollow] Search engine traversal hint (default: true)
3756 */
3757 OO.ui.ButtonWidget = function OoUiButtonWidget( config ) {
3758 // Configuration initialization
3759 config = config || {};
3760
3761 // Parent constructor
3762 OO.ui.ButtonWidget.parent.call( this, config );
3763
3764 // Mixin constructors
3765 OO.ui.mixin.ButtonElement.call( this, config );
3766 OO.ui.mixin.IconElement.call( this, config );
3767 OO.ui.mixin.IndicatorElement.call( this, config );
3768 OO.ui.mixin.LabelElement.call( this, config );
3769 OO.ui.mixin.TitledElement.call( this, $.extend( {
3770 $titled: this.$button
3771 }, config ) );
3772 OO.ui.mixin.FlaggedElement.call( this, config );
3773 OO.ui.mixin.TabIndexedElement.call( this, $.extend( {
3774 $tabIndexed: this.$button
3775 }, config ) );
3776 OO.ui.mixin.AccessKeyedElement.call( this, $.extend( {
3777 $accessKeyed: this.$button
3778 }, config ) );
3779
3780 // Properties
3781 this.href = null;
3782 this.target = null;
3783 this.noFollow = false;
3784
3785 // Events
3786 this.connect( this, {
3787 disable: 'onDisable'
3788 } );
3789
3790 // Initialization
3791 this.$button.append( this.$icon, this.$label, this.$indicator );
3792 this.$element
3793 .addClass( 'oo-ui-buttonWidget' )
3794 .append( this.$button );
3795 this.setActive( config.active );
3796 this.setHref( config.href );
3797 this.setTarget( config.target );
3798 this.setNoFollow( config.noFollow );
3799 };
3800
3801 /* Setup */
3802
3803 OO.inheritClass( OO.ui.ButtonWidget, OO.ui.Widget );
3804 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.ButtonElement );
3805 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.IconElement );
3806 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.IndicatorElement );
3807 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.LabelElement );
3808 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.TitledElement );
3809 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.FlaggedElement );
3810 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.TabIndexedElement );
3811 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.AccessKeyedElement );
3812
3813 /* Static Properties */
3814
3815 /**
3816 * @static
3817 * @inheritdoc
3818 */
3819 OO.ui.ButtonWidget.static.cancelButtonMouseDownEvents = false;
3820
3821 /**
3822 * @static
3823 * @inheritdoc
3824 */
3825 OO.ui.ButtonWidget.static.tagName = 'span';
3826
3827 /* Methods */
3828
3829 /**
3830 * Get hyperlink location.
3831 *
3832 * @return {string} Hyperlink location
3833 */
3834 OO.ui.ButtonWidget.prototype.getHref = function () {
3835 return this.href;
3836 };
3837
3838 /**
3839 * Get hyperlink target.
3840 *
3841 * @return {string} Hyperlink target
3842 */
3843 OO.ui.ButtonWidget.prototype.getTarget = function () {
3844 return this.target;
3845 };
3846
3847 /**
3848 * Get search engine traversal hint.
3849 *
3850 * @return {boolean} Whether search engines should avoid traversing this hyperlink
3851 */
3852 OO.ui.ButtonWidget.prototype.getNoFollow = function () {
3853 return this.noFollow;
3854 };
3855
3856 /**
3857 * Set hyperlink location.
3858 *
3859 * @param {string|null} href Hyperlink location, null to remove
3860 * @chainable
3861 * @return {OO.ui.Widget} The widget, for chaining
3862 */
3863 OO.ui.ButtonWidget.prototype.setHref = function ( href ) {
3864 href = typeof href === 'string' ? href : null;
3865 if ( href !== null && !OO.ui.isSafeUrl( href ) ) {
3866 href = './' + href;
3867 }
3868
3869 if ( href !== this.href ) {
3870 this.href = href;
3871 this.updateHref();
3872 }
3873
3874 return this;
3875 };
3876
3877 /**
3878 * Update the `href` attribute, in case of changes to href or
3879 * disabled state.
3880 *
3881 * @private
3882 * @chainable
3883 * @return {OO.ui.Widget} The widget, for chaining
3884 */
3885 OO.ui.ButtonWidget.prototype.updateHref = function () {
3886 if ( this.href !== null && !this.isDisabled() ) {
3887 this.$button.attr( 'href', this.href );
3888 } else {
3889 this.$button.removeAttr( 'href' );
3890 }
3891
3892 return this;
3893 };
3894
3895 /**
3896 * Handle disable events.
3897 *
3898 * @private
3899 * @param {boolean} disabled Element is disabled
3900 */
3901 OO.ui.ButtonWidget.prototype.onDisable = function () {
3902 this.updateHref();
3903 };
3904
3905 /**
3906 * Set hyperlink target.
3907 *
3908 * @param {string|null} target Hyperlink target, null to remove
3909 * @return {OO.ui.Widget} The widget, for chaining
3910 */
3911 OO.ui.ButtonWidget.prototype.setTarget = function ( target ) {
3912 target = typeof target === 'string' ? target : null;
3913
3914 if ( target !== this.target ) {
3915 this.target = target;
3916 if ( target !== null ) {
3917 this.$button.attr( 'target', target );
3918 } else {
3919 this.$button.removeAttr( 'target' );
3920 }
3921 }
3922
3923 return this;
3924 };
3925
3926 /**
3927 * Set search engine traversal hint.
3928 *
3929 * @param {boolean} noFollow True if search engines should avoid traversing this hyperlink
3930 * @return {OO.ui.Widget} The widget, for chaining
3931 */
3932 OO.ui.ButtonWidget.prototype.setNoFollow = function ( noFollow ) {
3933 noFollow = typeof noFollow === 'boolean' ? noFollow : true;
3934
3935 if ( noFollow !== this.noFollow ) {
3936 this.noFollow = noFollow;
3937 if ( noFollow ) {
3938 this.$button.attr( 'rel', 'nofollow' );
3939 } else {
3940 this.$button.removeAttr( 'rel' );
3941 }
3942 }
3943
3944 return this;
3945 };
3946
3947 // Override method visibility hints from ButtonElement
3948 /**
3949 * @method setActive
3950 * @inheritdoc
3951 */
3952 /**
3953 * @method isActive
3954 * @inheritdoc
3955 */
3956
3957 /**
3958 * A ButtonGroupWidget groups related buttons and is used together with OO.ui.ButtonWidget and
3959 * its subclasses. Each button in a group is addressed by a unique reference. Buttons can be added,
3960 * removed, and cleared from the group.
3961 *
3962 * @example
3963 * // A ButtonGroupWidget with two buttons.
3964 * var button1 = new OO.ui.PopupButtonWidget( {
3965 * label: 'Select a category',
3966 * icon: 'menu',
3967 * popup: {
3968 * $content: $( '<p>List of categories…</p>' ),
3969 * padded: true,
3970 * align: 'left'
3971 * }
3972 * } ),
3973 * button2 = new OO.ui.ButtonWidget( {
3974 * label: 'Add item'
3975 * } ),
3976 * buttonGroup = new OO.ui.ButtonGroupWidget( {
3977 * items: [ button1, button2 ]
3978 * } );
3979 * $( document.body ).append( buttonGroup.$element );
3980 *
3981 * @class
3982 * @extends OO.ui.Widget
3983 * @mixins OO.ui.mixin.GroupElement
3984 * @mixins OO.ui.mixin.TitledElement
3985 *
3986 * @constructor
3987 * @param {Object} [config] Configuration options
3988 * @cfg {OO.ui.ButtonWidget[]} [items] Buttons to add
3989 */
3990 OO.ui.ButtonGroupWidget = function OoUiButtonGroupWidget( config ) {
3991 // Configuration initialization
3992 config = config || {};
3993
3994 // Parent constructor
3995 OO.ui.ButtonGroupWidget.parent.call( this, config );
3996
3997 // Mixin constructors
3998 OO.ui.mixin.GroupElement.call( this, $.extend( {
3999 $group: this.$element
4000 }, config ) );
4001 OO.ui.mixin.TitledElement.call( this, config );
4002
4003 // Initialization
4004 this.$element.addClass( 'oo-ui-buttonGroupWidget' );
4005 if ( Array.isArray( config.items ) ) {
4006 this.addItems( config.items );
4007 }
4008 };
4009
4010 /* Setup */
4011
4012 OO.inheritClass( OO.ui.ButtonGroupWidget, OO.ui.Widget );
4013 OO.mixinClass( OO.ui.ButtonGroupWidget, OO.ui.mixin.GroupElement );
4014 OO.mixinClass( OO.ui.ButtonGroupWidget, OO.ui.mixin.TitledElement );
4015
4016 /* Static Properties */
4017
4018 /**
4019 * @static
4020 * @inheritdoc
4021 */
4022 OO.ui.ButtonGroupWidget.static.tagName = 'span';
4023
4024 /* Methods */
4025
4026 /**
4027 * Focus the widget
4028 *
4029 * @chainable
4030 * @return {OO.ui.Widget} The widget, for chaining
4031 */
4032 OO.ui.ButtonGroupWidget.prototype.focus = function () {
4033 if ( !this.isDisabled() ) {
4034 if ( this.items[ 0 ] ) {
4035 this.items[ 0 ].focus();
4036 }
4037 }
4038 return this;
4039 };
4040
4041 /**
4042 * @inheritdoc
4043 */
4044 OO.ui.ButtonGroupWidget.prototype.simulateLabelClick = function () {
4045 this.focus();
4046 };
4047
4048 /**
4049 * IconWidget is a generic widget for {@link OO.ui.mixin.IconElement icons}.
4050 * In general, IconWidgets should be used with OO.ui.LabelWidget, which creates a label that
4051 * identifies the icon’s function. See the [OOUI documentation on MediaWiki] [1]
4052 * for a list of icons included in the library.
4053 *
4054 * @example
4055 * // An IconWidget with a label via LabelWidget.
4056 * var myIcon = new OO.ui.IconWidget( {
4057 * icon: 'help',
4058 * title: 'Help'
4059 * } ),
4060 * // Create a label.
4061 * iconLabel = new OO.ui.LabelWidget( {
4062 * label: 'Help'
4063 * } );
4064 * $( document.body ).append( myIcon.$element, iconLabel.$element );
4065 *
4066 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Icons
4067 *
4068 * @class
4069 * @extends OO.ui.Widget
4070 * @mixins OO.ui.mixin.IconElement
4071 * @mixins OO.ui.mixin.TitledElement
4072 * @mixins OO.ui.mixin.LabelElement
4073 * @mixins OO.ui.mixin.FlaggedElement
4074 *
4075 * @constructor
4076 * @param {Object} [config] Configuration options
4077 */
4078 OO.ui.IconWidget = function OoUiIconWidget( config ) {
4079 // Configuration initialization
4080 config = config || {};
4081
4082 // Parent constructor
4083 OO.ui.IconWidget.parent.call( this, config );
4084
4085 // Mixin constructors
4086 OO.ui.mixin.IconElement.call( this, $.extend( {
4087 $icon: this.$element
4088 }, config ) );
4089 OO.ui.mixin.TitledElement.call( this, $.extend( {
4090 $titled: this.$element
4091 }, config ) );
4092 OO.ui.mixin.LabelElement.call( this, $.extend( {
4093 $label: this.$element,
4094 invisibleLabel: true
4095 }, config ) );
4096 OO.ui.mixin.FlaggedElement.call( this, $.extend( {
4097 $flagged: this.$element
4098 }, config ) );
4099
4100 // Initialization
4101 this.$element.addClass( 'oo-ui-iconWidget' );
4102 // Remove class added by LabelElement initialization. It causes unexpected CSS to apply when
4103 // nested in other widgets, because this widget used to not mix in LabelElement.
4104 this.$element.removeClass( 'oo-ui-labelElement-label' );
4105 };
4106
4107 /* Setup */
4108
4109 OO.inheritClass( OO.ui.IconWidget, OO.ui.Widget );
4110 OO.mixinClass( OO.ui.IconWidget, OO.ui.mixin.IconElement );
4111 OO.mixinClass( OO.ui.IconWidget, OO.ui.mixin.TitledElement );
4112 OO.mixinClass( OO.ui.IconWidget, OO.ui.mixin.LabelElement );
4113 OO.mixinClass( OO.ui.IconWidget, OO.ui.mixin.FlaggedElement );
4114
4115 /* Static Properties */
4116
4117 /**
4118 * @static
4119 * @inheritdoc
4120 */
4121 OO.ui.IconWidget.static.tagName = 'span';
4122
4123 /**
4124 * IndicatorWidgets create indicators, which are small graphics that are generally used to draw
4125 * attention to the status of an item or to clarify the function within a control. For a list of
4126 * indicators included in the library, please see the [OOUI documentation on MediaWiki][1].
4127 *
4128 * @example
4129 * // An indicator widget.
4130 * var indicator1 = new OO.ui.IndicatorWidget( {
4131 * indicator: 'required'
4132 * } ),
4133 * // Create a fieldset layout to add a label.
4134 * fieldset = new OO.ui.FieldsetLayout();
4135 * fieldset.addItems( [
4136 * new OO.ui.FieldLayout( indicator1, {
4137 * label: 'A required indicator:'
4138 * } )
4139 * ] );
4140 * $( document.body ).append( fieldset.$element );
4141 *
4142 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Indicators
4143 *
4144 * @class
4145 * @extends OO.ui.Widget
4146 * @mixins OO.ui.mixin.IndicatorElement
4147 * @mixins OO.ui.mixin.TitledElement
4148 * @mixins OO.ui.mixin.LabelElement
4149 *
4150 * @constructor
4151 * @param {Object} [config] Configuration options
4152 */
4153 OO.ui.IndicatorWidget = function OoUiIndicatorWidget( config ) {
4154 // Configuration initialization
4155 config = config || {};
4156
4157 // Parent constructor
4158 OO.ui.IndicatorWidget.parent.call( this, config );
4159
4160 // Mixin constructors
4161 OO.ui.mixin.IndicatorElement.call( this, $.extend( {
4162 $indicator: this.$element
4163 }, config ) );
4164 OO.ui.mixin.TitledElement.call( this, $.extend( {
4165 $titled: this.$element
4166 }, config ) );
4167 OO.ui.mixin.LabelElement.call( this, $.extend( {
4168 $label: this.$element,
4169 invisibleLabel: true
4170 }, config ) );
4171
4172 // Initialization
4173 this.$element.addClass( 'oo-ui-indicatorWidget' );
4174 // Remove class added by LabelElement initialization. It causes unexpected CSS to apply when
4175 // nested in other widgets, because this widget used to not mix in LabelElement.
4176 this.$element.removeClass( 'oo-ui-labelElement-label' );
4177 };
4178
4179 /* Setup */
4180
4181 OO.inheritClass( OO.ui.IndicatorWidget, OO.ui.Widget );
4182 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.mixin.IndicatorElement );
4183 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.mixin.TitledElement );
4184 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.mixin.LabelElement );
4185
4186 /* Static Properties */
4187
4188 /**
4189 * @static
4190 * @inheritdoc
4191 */
4192 OO.ui.IndicatorWidget.static.tagName = 'span';
4193
4194 /**
4195 * LabelWidgets help identify the function of interface elements. Each LabelWidget can
4196 * be configured with a `label` option that is set to a string, a label node, or a function:
4197 *
4198 * - String: a plaintext string
4199 * - jQuery selection: a jQuery selection, used for anything other than a plaintext label, e.g., a
4200 * label that includes a link or special styling, such as a gray color or additional
4201 * graphical elements.
4202 * - Function: a function that will produce a string in the future. Functions are used
4203 * in cases where the value of the label is not currently defined.
4204 *
4205 * In addition, the LabelWidget can be associated with an {@link OO.ui.InputWidget input widget},
4206 * which will come into focus when the label is clicked.
4207 *
4208 * @example
4209 * // Two LabelWidgets.
4210 * var label1 = new OO.ui.LabelWidget( {
4211 * label: 'plaintext label'
4212 * } ),
4213 * label2 = new OO.ui.LabelWidget( {
4214 * label: $( '<a>' ).attr( 'href', 'default.html' ).text( 'jQuery label' )
4215 * } ),
4216 * // Create a fieldset layout with fields for each example.
4217 * fieldset = new OO.ui.FieldsetLayout();
4218 * fieldset.addItems( [
4219 * new OO.ui.FieldLayout( label1 ),
4220 * new OO.ui.FieldLayout( label2 )
4221 * ] );
4222 * $( document.body ).append( fieldset.$element );
4223 *
4224 * @class
4225 * @extends OO.ui.Widget
4226 * @mixins OO.ui.mixin.LabelElement
4227 * @mixins OO.ui.mixin.TitledElement
4228 *
4229 * @constructor
4230 * @param {Object} [config] Configuration options
4231 * @cfg {OO.ui.InputWidget} [input] {@link OO.ui.InputWidget Input widget} that uses the label.
4232 * Clicking the label will focus the specified input field.
4233 */
4234 OO.ui.LabelWidget = function OoUiLabelWidget( config ) {
4235 // Configuration initialization
4236 config = config || {};
4237
4238 // Parent constructor
4239 OO.ui.LabelWidget.parent.call( this, config );
4240
4241 // Mixin constructors
4242 OO.ui.mixin.LabelElement.call( this, $.extend( {
4243 $label: this.$element
4244 }, config ) );
4245 OO.ui.mixin.TitledElement.call( this, config );
4246
4247 // Properties
4248 this.input = config.input;
4249
4250 // Initialization
4251 if ( this.input ) {
4252 if ( this.input.getInputId() ) {
4253 this.$element.attr( 'for', this.input.getInputId() );
4254 } else {
4255 this.$label.on( 'click', function () {
4256 this.input.simulateLabelClick();
4257 }.bind( this ) );
4258 }
4259 }
4260 this.$element.addClass( 'oo-ui-labelWidget' );
4261 };
4262
4263 /* Setup */
4264
4265 OO.inheritClass( OO.ui.LabelWidget, OO.ui.Widget );
4266 OO.mixinClass( OO.ui.LabelWidget, OO.ui.mixin.LabelElement );
4267 OO.mixinClass( OO.ui.LabelWidget, OO.ui.mixin.TitledElement );
4268
4269 /* Static Properties */
4270
4271 /**
4272 * @static
4273 * @inheritdoc
4274 */
4275 OO.ui.LabelWidget.static.tagName = 'label';
4276
4277 /**
4278 * PendingElement is a mixin that is used to create elements that notify users that something is
4279 * happening and that they should wait before proceeding. The pending state is visually represented
4280 * with a pending texture that appears in the head of a pending
4281 * {@link OO.ui.ProcessDialog process dialog} or in the input field of a
4282 * {@link OO.ui.TextInputWidget text input widget}.
4283 *
4284 * Currently, {@link OO.ui.ActionWidget Action widgets}, which mix in this class, can also be marked
4285 * as pending, but only when used in {@link OO.ui.MessageDialog message dialogs}. The behavior is
4286 * not currently supported for action widgets used in process dialogs.
4287 *
4288 * @example
4289 * function MessageDialog( config ) {
4290 * MessageDialog.parent.call( this, config );
4291 * }
4292 * OO.inheritClass( MessageDialog, OO.ui.MessageDialog );
4293 *
4294 * MessageDialog.static.name = 'myMessageDialog';
4295 * MessageDialog.static.actions = [
4296 * { action: 'save', label: 'Done', flags: 'primary' },
4297 * { label: 'Cancel', flags: 'safe' }
4298 * ];
4299 *
4300 * MessageDialog.prototype.initialize = function () {
4301 * MessageDialog.parent.prototype.initialize.apply( this, arguments );
4302 * this.content = new OO.ui.PanelLayout( { padded: true } );
4303 * this.content.$element.append( '<p>Click the \'Done\' action widget to see its pending ' +
4304 * 'state. Note that action widgets can be marked pending in message dialogs but not ' +
4305 * 'process dialogs.</p>' );
4306 * this.$body.append( this.content.$element );
4307 * };
4308 * MessageDialog.prototype.getBodyHeight = function () {
4309 * return 100;
4310 * }
4311 * MessageDialog.prototype.getActionProcess = function ( action ) {
4312 * var dialog = this;
4313 * if ( action === 'save' ) {
4314 * dialog.getActions().get({actions: 'save'})[0].pushPending();
4315 * return new OO.ui.Process()
4316 * .next( 1000 )
4317 * .next( function () {
4318 * dialog.getActions().get({actions: 'save'})[0].popPending();
4319 * } );
4320 * }
4321 * return MessageDialog.parent.prototype.getActionProcess.call( this, action );
4322 * };
4323 *
4324 * var windowManager = new OO.ui.WindowManager();
4325 * $( document.body ).append( windowManager.$element );
4326 *
4327 * var dialog = new MessageDialog();
4328 * windowManager.addWindows( [ dialog ] );
4329 * windowManager.openWindow( dialog );
4330 *
4331 * @abstract
4332 * @class
4333 *
4334 * @constructor
4335 * @param {Object} [config] Configuration options
4336 * @cfg {jQuery} [$pending] Element to mark as pending, defaults to this.$element
4337 */
4338 OO.ui.mixin.PendingElement = function OoUiMixinPendingElement( config ) {
4339 // Configuration initialization
4340 config = config || {};
4341
4342 // Properties
4343 this.pending = 0;
4344 this.$pending = null;
4345
4346 // Initialisation
4347 this.setPendingElement( config.$pending || this.$element );
4348 };
4349
4350 /* Setup */
4351
4352 OO.initClass( OO.ui.mixin.PendingElement );
4353
4354 /* Methods */
4355
4356 /**
4357 * Set the pending element (and clean up any existing one).
4358 *
4359 * @param {jQuery} $pending The element to set to pending.
4360 */
4361 OO.ui.mixin.PendingElement.prototype.setPendingElement = function ( $pending ) {
4362 if ( this.$pending ) {
4363 this.$pending.removeClass( 'oo-ui-pendingElement-pending' );
4364 }
4365
4366 this.$pending = $pending;
4367 if ( this.pending > 0 ) {
4368 this.$pending.addClass( 'oo-ui-pendingElement-pending' );
4369 }
4370 };
4371
4372 /**
4373 * Check if an element is pending.
4374 *
4375 * @return {boolean} Element is pending
4376 */
4377 OO.ui.mixin.PendingElement.prototype.isPending = function () {
4378 return !!this.pending;
4379 };
4380
4381 /**
4382 * Increase the pending counter. The pending state will remain active until the counter is zero
4383 * (i.e., the number of calls to #pushPending and #popPending is the same).
4384 *
4385 * @chainable
4386 * @return {OO.ui.Element} The element, for chaining
4387 */
4388 OO.ui.mixin.PendingElement.prototype.pushPending = function () {
4389 if ( this.pending === 0 ) {
4390 this.$pending.addClass( 'oo-ui-pendingElement-pending' );
4391 this.updateThemeClasses();
4392 }
4393 this.pending++;
4394
4395 return this;
4396 };
4397
4398 /**
4399 * Decrease the pending counter. The pending state will remain active until the counter is zero
4400 * (i.e., the number of calls to #pushPending and #popPending is the same).
4401 *
4402 * @chainable
4403 * @return {OO.ui.Element} The element, for chaining
4404 */
4405 OO.ui.mixin.PendingElement.prototype.popPending = function () {
4406 if ( this.pending === 1 ) {
4407 this.$pending.removeClass( 'oo-ui-pendingElement-pending' );
4408 this.updateThemeClasses();
4409 }
4410 this.pending = Math.max( 0, this.pending - 1 );
4411
4412 return this;
4413 };
4414
4415 /**
4416 * Element that will stick adjacent to a specified container, even when it is inserted elsewhere
4417 * in the document (for example, in an OO.ui.Window's $overlay).
4418 *
4419 * The elements's position is automatically calculated and maintained when window is resized or the
4420 * page is scrolled. If you reposition the container manually, you have to call #position to make
4421 * sure the element is still placed correctly.
4422 *
4423 * As positioning is only possible when both the element and the container are attached to the DOM
4424 * and visible, it's only done after you call #togglePositioning. You might want to do this inside
4425 * the #toggle method to display a floating popup, for example.
4426 *
4427 * @abstract
4428 * @class
4429 *
4430 * @constructor
4431 * @param {Object} [config] Configuration options
4432 * @cfg {jQuery} [$floatable] Node to position, assigned to #$floatable, omit to use #$element
4433 * @cfg {jQuery} [$floatableContainer] Node to position adjacent to
4434 * @cfg {string} [verticalPosition='below'] Where to position $floatable vertically:
4435 * 'below': Directly below $floatableContainer, aligning f's top edge with fC's bottom edge
4436 * 'above': Directly above $floatableContainer, aligning f's bottom edge with fC's top edge
4437 * 'top': Align the top edge with $floatableContainer's top edge
4438 * 'bottom': Align the bottom edge with $floatableContainer's bottom edge
4439 * 'center': Vertically align the center with $floatableContainer's center
4440 * @cfg {string} [horizontalPosition='start'] Where to position $floatable horizontally:
4441 * 'before': Directly before $floatableContainer, aligning f's end edge with fC's start edge
4442 * 'after': Directly after $floatableContainer, aligning f's start edge with fC's end edge
4443 * 'start': Align the start (left in LTR, right in RTL) edge with $floatableContainer's start edge
4444 * 'end': Align the end (right in LTR, left in RTL) edge with $floatableContainer's end edge
4445 * 'center': Horizontally align the center with $floatableContainer's center
4446 * @cfg {boolean} [hideWhenOutOfView=true] Whether to hide the floatable element if the container
4447 * is out of view
4448 */
4449 OO.ui.mixin.FloatableElement = function OoUiMixinFloatableElement( config ) {
4450 // Configuration initialization
4451 config = config || {};
4452
4453 // Properties
4454 this.$floatable = null;
4455 this.$floatableContainer = null;
4456 this.$floatableWindow = null;
4457 this.$floatableClosestScrollable = null;
4458 this.floatableOutOfView = false;
4459 this.onFloatableScrollHandler = this.position.bind( this );
4460 this.onFloatableWindowResizeHandler = this.position.bind( this );
4461
4462 // Initialization
4463 this.setFloatableContainer( config.$floatableContainer );
4464 this.setFloatableElement( config.$floatable || this.$element );
4465 this.setVerticalPosition( config.verticalPosition || 'below' );
4466 this.setHorizontalPosition( config.horizontalPosition || 'start' );
4467 this.hideWhenOutOfView = config.hideWhenOutOfView === undefined ?
4468 true : !!config.hideWhenOutOfView;
4469 };
4470
4471 /* Methods */
4472
4473 /**
4474 * Set floatable element.
4475 *
4476 * If an element is already set, it will be cleaned up before setting up the new element.
4477 *
4478 * @param {jQuery} $floatable Element to make floatable
4479 */
4480 OO.ui.mixin.FloatableElement.prototype.setFloatableElement = function ( $floatable ) {
4481 if ( this.$floatable ) {
4482 this.$floatable.removeClass( 'oo-ui-floatableElement-floatable' );
4483 this.$floatable.css( { left: '', top: '' } );
4484 }
4485
4486 this.$floatable = $floatable.addClass( 'oo-ui-floatableElement-floatable' );
4487 this.position();
4488 };
4489
4490 /**
4491 * Set floatable container.
4492 *
4493 * The element will be positioned relative to the specified container.
4494 *
4495 * @param {jQuery|null} $floatableContainer Container to keep visible, or null to unset
4496 */
4497 OO.ui.mixin.FloatableElement.prototype.setFloatableContainer = function ( $floatableContainer ) {
4498 this.$floatableContainer = $floatableContainer;
4499 if ( this.$floatable ) {
4500 this.position();
4501 }
4502 };
4503
4504 /**
4505 * Change how the element is positioned vertically.
4506 *
4507 * @param {string} position 'below', 'above', 'top', 'bottom' or 'center'
4508 */
4509 OO.ui.mixin.FloatableElement.prototype.setVerticalPosition = function ( position ) {
4510 if ( [ 'below', 'above', 'top', 'bottom', 'center' ].indexOf( position ) === -1 ) {
4511 throw new Error( 'Invalid value for vertical position: ' + position );
4512 }
4513 if ( this.verticalPosition !== position ) {
4514 this.verticalPosition = position;
4515 if ( this.$floatable ) {
4516 this.position();
4517 }
4518 }
4519 };
4520
4521 /**
4522 * Change how the element is positioned horizontally.
4523 *
4524 * @param {string} position 'before', 'after', 'start', 'end' or 'center'
4525 */
4526 OO.ui.mixin.FloatableElement.prototype.setHorizontalPosition = function ( position ) {
4527 if ( [ 'before', 'after', 'start', 'end', 'center' ].indexOf( position ) === -1 ) {
4528 throw new Error( 'Invalid value for horizontal position: ' + position );
4529 }
4530 if ( this.horizontalPosition !== position ) {
4531 this.horizontalPosition = position;
4532 if ( this.$floatable ) {
4533 this.position();
4534 }
4535 }
4536 };
4537
4538 /**
4539 * Toggle positioning.
4540 *
4541 * Do not turn positioning on until after the element is attached to the DOM and visible.
4542 *
4543 * @param {boolean} [positioning] Enable positioning, omit to toggle
4544 * @chainable
4545 * @return {OO.ui.Element} The element, for chaining
4546 */
4547 OO.ui.mixin.FloatableElement.prototype.togglePositioning = function ( positioning ) {
4548 var closestScrollableOfContainer;
4549
4550 if ( !this.$floatable || !this.$floatableContainer ) {
4551 return this;
4552 }
4553
4554 positioning = positioning === undefined ? !this.positioning : !!positioning;
4555
4556 if ( positioning && !this.warnedUnattached && !this.isElementAttached() ) {
4557 OO.ui.warnDeprecation( 'FloatableElement#togglePositioning: Before calling this method, the element must be attached to the DOM.' );
4558 this.warnedUnattached = true;
4559 }
4560
4561 if ( this.positioning !== positioning ) {
4562 this.positioning = positioning;
4563
4564 closestScrollableOfContainer = OO.ui.Element.static.getClosestScrollableContainer(
4565 this.$floatableContainer[ 0 ]
4566 );
4567 // If the scrollable is the root, we have to listen to scroll events
4568 // on the window because of browser inconsistencies.
4569 if ( $( closestScrollableOfContainer ).is( 'html, body' ) ) {
4570 closestScrollableOfContainer = OO.ui.Element.static.getWindow(
4571 closestScrollableOfContainer
4572 );
4573 }
4574
4575 if ( positioning ) {
4576 this.$floatableWindow = $( this.getElementWindow() );
4577 this.$floatableWindow.on( 'resize', this.onFloatableWindowResizeHandler );
4578
4579 this.$floatableClosestScrollable = $( closestScrollableOfContainer );
4580 this.$floatableClosestScrollable.on( 'scroll', this.onFloatableScrollHandler );
4581
4582 // Initial position after visible
4583 this.position();
4584 } else {
4585 if ( this.$floatableWindow ) {
4586 this.$floatableWindow.off( 'resize', this.onFloatableWindowResizeHandler );
4587 this.$floatableWindow = null;
4588 }
4589
4590 if ( this.$floatableClosestScrollable ) {
4591 this.$floatableClosestScrollable.off( 'scroll', this.onFloatableScrollHandler );
4592 this.$floatableClosestScrollable = null;
4593 }
4594
4595 this.$floatable.css( { left: '', right: '', top: '' } );
4596 }
4597 }
4598
4599 return this;
4600 };
4601
4602 /**
4603 * Check whether the bottom edge of the given element is within the viewport of the given
4604 * container.
4605 *
4606 * @private
4607 * @param {jQuery} $element
4608 * @param {jQuery} $container
4609 * @return {boolean}
4610 */
4611 OO.ui.mixin.FloatableElement.prototype.isElementInViewport = function ( $element, $container ) {
4612 var elemRect, contRect, topEdgeInBounds, bottomEdgeInBounds, leftEdgeInBounds,
4613 rightEdgeInBounds, startEdgeInBounds, endEdgeInBounds, viewportSpacing,
4614 direction = $element.css( 'direction' );
4615
4616 elemRect = $element[ 0 ].getBoundingClientRect();
4617 if ( $container[ 0 ] === window ) {
4618 viewportSpacing = OO.ui.getViewportSpacing();
4619 contRect = {
4620 top: 0,
4621 left: 0,
4622 right: document.documentElement.clientWidth,
4623 bottom: document.documentElement.clientHeight
4624 };
4625 contRect.top += viewportSpacing.top;
4626 contRect.left += viewportSpacing.left;
4627 contRect.right -= viewportSpacing.right;
4628 contRect.bottom -= viewportSpacing.bottom;
4629 } else {
4630 contRect = $container[ 0 ].getBoundingClientRect();
4631 }
4632
4633 topEdgeInBounds = elemRect.top >= contRect.top && elemRect.top <= contRect.bottom;
4634 bottomEdgeInBounds = elemRect.bottom >= contRect.top && elemRect.bottom <= contRect.bottom;
4635 leftEdgeInBounds = elemRect.left >= contRect.left && elemRect.left <= contRect.right;
4636 rightEdgeInBounds = elemRect.right >= contRect.left && elemRect.right <= contRect.right;
4637 if ( direction === 'rtl' ) {
4638 startEdgeInBounds = rightEdgeInBounds;
4639 endEdgeInBounds = leftEdgeInBounds;
4640 } else {
4641 startEdgeInBounds = leftEdgeInBounds;
4642 endEdgeInBounds = rightEdgeInBounds;
4643 }
4644
4645 if ( this.verticalPosition === 'below' && !bottomEdgeInBounds ) {
4646 return false;
4647 }
4648 if ( this.verticalPosition === 'above' && !topEdgeInBounds ) {
4649 return false;
4650 }
4651 if ( this.horizontalPosition === 'before' && !startEdgeInBounds ) {
4652 return false;
4653 }
4654 if ( this.horizontalPosition === 'after' && !endEdgeInBounds ) {
4655 return false;
4656 }
4657
4658 // The other positioning values are all about being inside the container,
4659 // so in those cases all we care about is that any part of the container is visible.
4660 return elemRect.top <= contRect.bottom && elemRect.bottom >= contRect.top &&
4661 elemRect.left <= contRect.right && elemRect.right >= contRect.left;
4662 };
4663
4664 /**
4665 * Check if the floatable is hidden to the user because it was offscreen.
4666 *
4667 * @return {boolean} Floatable is out of view
4668 */
4669 OO.ui.mixin.FloatableElement.prototype.isFloatableOutOfView = function () {
4670 return this.floatableOutOfView;
4671 };
4672
4673 /**
4674 * Position the floatable below its container.
4675 *
4676 * This should only be done when both of them are attached to the DOM and visible.
4677 *
4678 * @chainable
4679 * @return {OO.ui.Element} The element, for chaining
4680 */
4681 OO.ui.mixin.FloatableElement.prototype.position = function () {
4682 if ( !this.positioning ) {
4683 return this;
4684 }
4685
4686 if ( !(
4687 // To continue, some things need to be true:
4688 // The element must actually be in the DOM
4689 this.isElementAttached() && (
4690 // The closest scrollable is the current window
4691 this.$floatableClosestScrollable[ 0 ] === this.getElementWindow() ||
4692 // OR is an element in the element's DOM
4693 $.contains( this.getElementDocument(), this.$floatableClosestScrollable[ 0 ] )
4694 )
4695 ) ) {
4696 // Abort early if important parts of the widget are no longer attached to the DOM
4697 return this;
4698 }
4699
4700 this.floatableOutOfView = this.hideWhenOutOfView &&
4701 !this.isElementInViewport( this.$floatableContainer, this.$floatableClosestScrollable );
4702 if ( this.floatableOutOfView ) {
4703 this.$floatable.addClass( 'oo-ui-element-hidden' );
4704 return this;
4705 } else {
4706 this.$floatable.removeClass( 'oo-ui-element-hidden' );
4707 }
4708
4709 this.$floatable.css( this.computePosition() );
4710
4711 // We updated the position, so re-evaluate the clipping state.
4712 // (ClippableElement does not listen to 'scroll' events on $floatableContainer's parent, and so
4713 // will not notice the need to update itself.)
4714 // TODO: This is terrible, we shouldn't need to know about ClippableElement at all here.
4715 // Why does it not listen to the right events in the right places?
4716 if ( this.clip ) {
4717 this.clip();
4718 }
4719
4720 return this;
4721 };
4722
4723 /**
4724 * Compute how #$floatable should be positioned based on the position of #$floatableContainer
4725 * and the positioning settings. This is a helper for #position that shouldn't be called directly,
4726 * but may be overridden by subclasses if they want to change or add to the positioning logic.
4727 *
4728 * @return {Object} New position to apply with .css(). Keys are 'top', 'left', 'bottom' and 'right'.
4729 */
4730 OO.ui.mixin.FloatableElement.prototype.computePosition = function () {
4731 var isBody, scrollableX, scrollableY, containerPos,
4732 horizScrollbarHeight, vertScrollbarWidth, scrollTop, scrollLeft,
4733 newPos = { top: '', left: '', bottom: '', right: '' },
4734 direction = this.$floatableContainer.css( 'direction' ),
4735 $offsetParent = this.$floatable.offsetParent();
4736
4737 if ( $offsetParent.is( 'html' ) ) {
4738 // The innerHeight/Width and clientHeight/Width calculations don't work well on the
4739 // <html> element, but they do work on the <body>
4740 $offsetParent = $( $offsetParent[ 0 ].ownerDocument.body );
4741 }
4742 isBody = $offsetParent.is( 'body' );
4743 scrollableX = $offsetParent.css( 'overflow-x' ) === 'scroll' ||
4744 $offsetParent.css( 'overflow-x' ) === 'auto';
4745 scrollableY = $offsetParent.css( 'overflow-y' ) === 'scroll' ||
4746 $offsetParent.css( 'overflow-y' ) === 'auto';
4747
4748 vertScrollbarWidth = $offsetParent.innerWidth() - $offsetParent.prop( 'clientWidth' );
4749 horizScrollbarHeight = $offsetParent.innerHeight() - $offsetParent.prop( 'clientHeight' );
4750 // We don't need to compute and add scrollTop and scrollLeft if the scrollable container
4751 // is the body, or if it isn't scrollable
4752 scrollTop = scrollableY && !isBody ?
4753 $offsetParent.scrollTop() : 0;
4754 scrollLeft = scrollableX && !isBody ?
4755 OO.ui.Element.static.getScrollLeft( $offsetParent[ 0 ] ) : 0;
4756
4757 // Avoid passing the <body> to getRelativePosition(), because it won't return what we expect
4758 // if the <body> has a margin
4759 containerPos = isBody ?
4760 this.$floatableContainer.offset() :
4761 OO.ui.Element.static.getRelativePosition( this.$floatableContainer, $offsetParent );
4762 containerPos.bottom = containerPos.top + this.$floatableContainer.outerHeight();
4763 containerPos.right = containerPos.left + this.$floatableContainer.outerWidth();
4764 containerPos.start = direction === 'rtl' ? containerPos.right : containerPos.left;
4765 containerPos.end = direction === 'rtl' ? containerPos.left : containerPos.right;
4766
4767 if ( this.verticalPosition === 'below' ) {
4768 newPos.top = containerPos.bottom;
4769 } else if ( this.verticalPosition === 'above' ) {
4770 newPos.bottom = $offsetParent.outerHeight() - containerPos.top;
4771 } else if ( this.verticalPosition === 'top' ) {
4772 newPos.top = containerPos.top;
4773 } else if ( this.verticalPosition === 'bottom' ) {
4774 newPos.bottom = $offsetParent.outerHeight() - containerPos.bottom;
4775 } else if ( this.verticalPosition === 'center' ) {
4776 newPos.top = containerPos.top +
4777 ( this.$floatableContainer.height() - this.$floatable.height() ) / 2;
4778 }
4779
4780 if ( this.horizontalPosition === 'before' ) {
4781 newPos.end = containerPos.start;
4782 } else if ( this.horizontalPosition === 'after' ) {
4783 newPos.start = containerPos.end;
4784 } else if ( this.horizontalPosition === 'start' ) {
4785 newPos.start = containerPos.start;
4786 } else if ( this.horizontalPosition === 'end' ) {
4787 newPos.end = containerPos.end;
4788 } else if ( this.horizontalPosition === 'center' ) {
4789 newPos.left = containerPos.left +
4790 ( this.$floatableContainer.width() - this.$floatable.width() ) / 2;
4791 }
4792
4793 if ( newPos.start !== undefined ) {
4794 if ( direction === 'rtl' ) {
4795 newPos.right = ( isBody ? $( $offsetParent[ 0 ].ownerDocument.documentElement ) :
4796 $offsetParent ).outerWidth() - newPos.start;
4797 } else {
4798 newPos.left = newPos.start;
4799 }
4800 delete newPos.start;
4801 }
4802 if ( newPos.end !== undefined ) {
4803 if ( direction === 'rtl' ) {
4804 newPos.left = newPos.end;
4805 } else {
4806 newPos.right = ( isBody ? $( $offsetParent[ 0 ].ownerDocument.documentElement ) :
4807 $offsetParent ).outerWidth() - newPos.end;
4808 }
4809 delete newPos.end;
4810 }
4811
4812 // Account for scroll position
4813 if ( newPos.top !== '' ) {
4814 newPos.top += scrollTop;
4815 }
4816 if ( newPos.bottom !== '' ) {
4817 newPos.bottom -= scrollTop;
4818 }
4819 if ( newPos.left !== '' ) {
4820 newPos.left += scrollLeft;
4821 }
4822 if ( newPos.right !== '' ) {
4823 newPos.right -= scrollLeft;
4824 }
4825
4826 // Account for scrollbar gutter
4827 if ( newPos.bottom !== '' ) {
4828 newPos.bottom -= horizScrollbarHeight;
4829 }
4830 if ( direction === 'rtl' ) {
4831 if ( newPos.left !== '' ) {
4832 newPos.left -= vertScrollbarWidth;
4833 }
4834 } else {
4835 if ( newPos.right !== '' ) {
4836 newPos.right -= vertScrollbarWidth;
4837 }
4838 }
4839
4840 return newPos;
4841 };
4842
4843 /**
4844 * Element that can be automatically clipped to visible boundaries.
4845 *
4846 * Whenever the element's natural height changes, you have to call
4847 * {@link OO.ui.mixin.ClippableElement#clip} to make sure it's still
4848 * clipping correctly.
4849 *
4850 * The dimensions of #$clippableContainer will be compared to the boundaries of the
4851 * nearest scrollable container. If #$clippableContainer is too tall and/or too wide,
4852 * then #$clippable will be given a fixed reduced height and/or width and will be made
4853 * scrollable. By default, #$clippable and #$clippableContainer are the same element,
4854 * but you can build a static footer by setting #$clippableContainer to an element that contains
4855 * #$clippable and the footer.
4856 *
4857 * @abstract
4858 * @class
4859 *
4860 * @constructor
4861 * @param {Object} [config] Configuration options
4862 * @cfg {jQuery} [$clippable] Node to clip, assigned to #$clippable, omit to use #$element
4863 * @cfg {jQuery} [$clippableContainer] Node to keep visible, assigned to #$clippableContainer,
4864 * omit to use #$clippable
4865 */
4866 OO.ui.mixin.ClippableElement = function OoUiMixinClippableElement( config ) {
4867 // Configuration initialization
4868 config = config || {};
4869
4870 // Properties
4871 this.$clippable = null;
4872 this.$clippableContainer = null;
4873 this.clipping = false;
4874 this.clippedHorizontally = false;
4875 this.clippedVertically = false;
4876 this.$clippableScrollableContainer = null;
4877 this.$clippableScroller = null;
4878 this.$clippableWindow = null;
4879 this.idealWidth = null;
4880 this.idealHeight = null;
4881 this.onClippableScrollHandler = this.clip.bind( this );
4882 this.onClippableWindowResizeHandler = this.clip.bind( this );
4883
4884 // Initialization
4885 if ( config.$clippableContainer ) {
4886 this.setClippableContainer( config.$clippableContainer );
4887 }
4888 this.setClippableElement( config.$clippable || this.$element );
4889 };
4890
4891 /* Methods */
4892
4893 /**
4894 * Set clippable element.
4895 *
4896 * If an element is already set, it will be cleaned up before setting up the new element.
4897 *
4898 * @param {jQuery} $clippable Element to make clippable
4899 */
4900 OO.ui.mixin.ClippableElement.prototype.setClippableElement = function ( $clippable ) {
4901 if ( this.$clippable ) {
4902 this.$clippable.removeClass( 'oo-ui-clippableElement-clippable' );
4903 this.$clippable.css( { width: '', height: '', overflowX: '', overflowY: '' } );
4904 OO.ui.Element.static.reconsiderScrollbars( this.$clippable[ 0 ] );
4905 }
4906
4907 this.$clippable = $clippable.addClass( 'oo-ui-clippableElement-clippable' );
4908 this.clip();
4909 };
4910
4911 /**
4912 * Set clippable container.
4913 *
4914 * This is the container that will be measured when deciding whether to clip. When clipping,
4915 * #$clippable will be resized in order to keep the clippable container fully visible.
4916 *
4917 * If the clippable container is unset, #$clippable will be used.
4918 *
4919 * @param {jQuery|null} $clippableContainer Container to keep visible, or null to unset
4920 */
4921 OO.ui.mixin.ClippableElement.prototype.setClippableContainer = function ( $clippableContainer ) {
4922 this.$clippableContainer = $clippableContainer;
4923 if ( this.$clippable ) {
4924 this.clip();
4925 }
4926 };
4927
4928 /**
4929 * Toggle clipping.
4930 *
4931 * Do not turn clipping on until after the element is attached to the DOM and visible.
4932 *
4933 * @param {boolean} [clipping] Enable clipping, omit to toggle
4934 * @chainable
4935 * @return {OO.ui.Element} The element, for chaining
4936 */
4937 OO.ui.mixin.ClippableElement.prototype.toggleClipping = function ( clipping ) {
4938 clipping = clipping === undefined ? !this.clipping : !!clipping;
4939
4940 if ( clipping && !this.warnedUnattached && !this.isElementAttached() ) {
4941 OO.ui.warnDeprecation( 'ClippableElement#toggleClipping: Before calling this method, the element must be attached to the DOM.' );
4942 this.warnedUnattached = true;
4943 }
4944
4945 if ( this.clipping !== clipping ) {
4946 this.clipping = clipping;
4947 if ( clipping ) {
4948 this.$clippableScrollableContainer = $( this.getClosestScrollableElementContainer() );
4949 // If the clippable container is the root, we have to listen to scroll events and check
4950 // jQuery.scrollTop on the window because of browser inconsistencies
4951 this.$clippableScroller = this.$clippableScrollableContainer.is( 'html, body' ) ?
4952 $( OO.ui.Element.static.getWindow( this.$clippableScrollableContainer ) ) :
4953 this.$clippableScrollableContainer;
4954 this.$clippableScroller.on( 'scroll', this.onClippableScrollHandler );
4955 this.$clippableWindow = $( this.getElementWindow() )
4956 .on( 'resize', this.onClippableWindowResizeHandler );
4957 // Initial clip after visible
4958 this.clip();
4959 } else {
4960 this.$clippable.css( {
4961 width: '',
4962 height: '',
4963 maxWidth: '',
4964 maxHeight: '',
4965 overflowX: '',
4966 overflowY: ''
4967 } );
4968 OO.ui.Element.static.reconsiderScrollbars( this.$clippable[ 0 ] );
4969
4970 this.$clippableScrollableContainer = null;
4971 this.$clippableScroller.off( 'scroll', this.onClippableScrollHandler );
4972 this.$clippableScroller = null;
4973 this.$clippableWindow.off( 'resize', this.onClippableWindowResizeHandler );
4974 this.$clippableWindow = null;
4975 }
4976 }
4977
4978 return this;
4979 };
4980
4981 /**
4982 * Check if the element will be clipped to fit the visible area of the nearest scrollable container.
4983 *
4984 * @return {boolean} Element will be clipped to the visible area
4985 */
4986 OO.ui.mixin.ClippableElement.prototype.isClipping = function () {
4987 return this.clipping;
4988 };
4989
4990 /**
4991 * Check if the bottom or right of the element is being clipped by the nearest scrollable container.
4992 *
4993 * @return {boolean} Part of the element is being clipped
4994 */
4995 OO.ui.mixin.ClippableElement.prototype.isClipped = function () {
4996 return this.clippedHorizontally || this.clippedVertically;
4997 };
4998
4999 /**
5000 * Check if the right of the element is being clipped by the nearest scrollable container.
5001 *
5002 * @return {boolean} Part of the element is being clipped
5003 */
5004 OO.ui.mixin.ClippableElement.prototype.isClippedHorizontally = function () {
5005 return this.clippedHorizontally;
5006 };
5007
5008 /**
5009 * Check if the bottom of the element is being clipped by the nearest scrollable container.
5010 *
5011 * @return {boolean} Part of the element is being clipped
5012 */
5013 OO.ui.mixin.ClippableElement.prototype.isClippedVertically = function () {
5014 return this.clippedVertically;
5015 };
5016
5017 /**
5018 * Set the ideal size. These are the dimensions #$clippable will have when it's not being clipped.
5019 *
5020 * @param {number|string} [width] Width as a number of pixels or CSS string with unit suffix
5021 * @param {number|string} [height] Height as a number of pixels or CSS string with unit suffix
5022 */
5023 OO.ui.mixin.ClippableElement.prototype.setIdealSize = function ( width, height ) {
5024 this.idealWidth = width;
5025 this.idealHeight = height;
5026
5027 if ( !this.clipping ) {
5028 // Update dimensions
5029 this.$clippable.css( { width: width, height: height } );
5030 }
5031 // While clipping, idealWidth and idealHeight are not considered
5032 };
5033
5034 /**
5035 * Return the side of the clippable on which it is "anchored" (aligned to something else).
5036 * ClippableElement will clip the opposite side when reducing element's width.
5037 *
5038 * Classes that mix in ClippableElement should override this to return 'right' if their
5039 * clippable is absolutely positioned and using 'right: Npx' (and not using 'left').
5040 * If your class also mixes in FloatableElement, this is handled automatically.
5041 *
5042 * (This can't be guessed from the actual CSS because the computed values for 'left'/'right' are
5043 * always in pixels, even if they were unset or set to 'auto'.)
5044 *
5045 * When in doubt, 'left' (or 'right' in RTL) is a sane fallback.
5046 *
5047 * @return {string} 'left' or 'right'
5048 */
5049 OO.ui.mixin.ClippableElement.prototype.getHorizontalAnchorEdge = function () {
5050 if ( this.computePosition && this.positioning && this.computePosition().right !== '' ) {
5051 return 'right';
5052 }
5053 return 'left';
5054 };
5055
5056 /**
5057 * Return the side of the clippable on which it is "anchored" (aligned to something else).
5058 * ClippableElement will clip the opposite side when reducing element's width.
5059 *
5060 * Classes that mix in ClippableElement should override this to return 'bottom' if their
5061 * clippable is absolutely positioned and using 'bottom: Npx' (and not using 'top').
5062 * If your class also mixes in FloatableElement, this is handled automatically.
5063 *
5064 * (This can't be guessed from the actual CSS because the computed values for 'left'/'right' are
5065 * always in pixels, even if they were unset or set to 'auto'.)
5066 *
5067 * When in doubt, 'top' is a sane fallback.
5068 *
5069 * @return {string} 'top' or 'bottom'
5070 */
5071 OO.ui.mixin.ClippableElement.prototype.getVerticalAnchorEdge = function () {
5072 if ( this.computePosition && this.positioning && this.computePosition().bottom !== '' ) {
5073 return 'bottom';
5074 }
5075 return 'top';
5076 };
5077
5078 /**
5079 * Clip element to visible boundaries and allow scrolling when needed. You should call this method
5080 * when the element's natural height changes.
5081 *
5082 * Element will be clipped the bottom or right of the element is within 10px of the edge of, or
5083 * overlapped by, the visible area of the nearest scrollable container.
5084 *
5085 * Because calling clip() when the natural height changes isn't always possible, we also set
5086 * max-height when the element isn't being clipped. This means that if the element tries to grow
5087 * beyond the edge, something reasonable will happen before clip() is called.
5088 *
5089 * @chainable
5090 * @return {OO.ui.Element} The element, for chaining
5091 */
5092 OO.ui.mixin.ClippableElement.prototype.clip = function () {
5093 var extraHeight, extraWidth, viewportSpacing,
5094 desiredWidth, desiredHeight, allotedWidth, allotedHeight,
5095 naturalWidth, naturalHeight, clipWidth, clipHeight,
5096 $item, itemRect, $viewport, viewportRect, availableRect,
5097 direction, vertScrollbarWidth, horizScrollbarHeight,
5098 // Extra tolerance so that the sloppy code below doesn't result in results that are off
5099 // by one or two pixels. (And also so that we have space to display drop shadows.)
5100 // Chosen by fair dice roll.
5101 buffer = 7;
5102
5103 if ( !this.clipping ) {
5104 // this.$clippableScrollableContainer and this.$clippableWindow are null, so the below
5105 // will fail
5106 return this;
5107 }
5108
5109 function rectIntersection( a, b ) {
5110 var out = {};
5111 out.top = Math.max( a.top, b.top );
5112 out.left = Math.max( a.left, b.left );
5113 out.bottom = Math.min( a.bottom, b.bottom );
5114 out.right = Math.min( a.right, b.right );
5115 return out;
5116 }
5117
5118 viewportSpacing = OO.ui.getViewportSpacing();
5119
5120 if ( this.$clippableScrollableContainer.is( 'html, body' ) ) {
5121 $viewport = $( this.$clippableScrollableContainer[ 0 ].ownerDocument.body );
5122 // Dimensions of the browser window, rather than the element!
5123 viewportRect = {
5124 top: 0,
5125 left: 0,
5126 right: document.documentElement.clientWidth,
5127 bottom: document.documentElement.clientHeight
5128 };
5129 viewportRect.top += viewportSpacing.top;
5130 viewportRect.left += viewportSpacing.left;
5131 viewportRect.right -= viewportSpacing.right;
5132 viewportRect.bottom -= viewportSpacing.bottom;
5133 } else {
5134 $viewport = this.$clippableScrollableContainer;
5135 viewportRect = $viewport[ 0 ].getBoundingClientRect();
5136 // Convert into a plain object
5137 viewportRect = $.extend( {}, viewportRect );
5138 }
5139
5140 // Account for scrollbar gutter
5141 direction = $viewport.css( 'direction' );
5142 vertScrollbarWidth = $viewport.innerWidth() - $viewport.prop( 'clientWidth' );
5143 horizScrollbarHeight = $viewport.innerHeight() - $viewport.prop( 'clientHeight' );
5144 viewportRect.bottom -= horizScrollbarHeight;
5145 if ( direction === 'rtl' ) {
5146 viewportRect.left += vertScrollbarWidth;
5147 } else {
5148 viewportRect.right -= vertScrollbarWidth;
5149 }
5150
5151 // Add arbitrary tolerance
5152 viewportRect.top += buffer;
5153 viewportRect.left += buffer;
5154 viewportRect.right -= buffer;
5155 viewportRect.bottom -= buffer;
5156
5157 $item = this.$clippableContainer || this.$clippable;
5158
5159 extraHeight = $item.outerHeight() - this.$clippable.outerHeight();
5160 extraWidth = $item.outerWidth() - this.$clippable.outerWidth();
5161
5162 itemRect = $item[ 0 ].getBoundingClientRect();
5163 // Convert into a plain object
5164 itemRect = $.extend( {}, itemRect );
5165
5166 // Item might already be clipped, so we can't just use its dimensions (in case we might need to
5167 // make it larger than before). Extend the rectangle to the maximum size we are allowed to take.
5168 if ( this.getHorizontalAnchorEdge() === 'right' ) {
5169 itemRect.left = viewportRect.left;
5170 } else {
5171 itemRect.right = viewportRect.right;
5172 }
5173 if ( this.getVerticalAnchorEdge() === 'bottom' ) {
5174 itemRect.top = viewportRect.top;
5175 } else {
5176 itemRect.bottom = viewportRect.bottom;
5177 }
5178
5179 availableRect = rectIntersection( viewportRect, itemRect );
5180
5181 desiredWidth = Math.max( 0, availableRect.right - availableRect.left );
5182 desiredHeight = Math.max( 0, availableRect.bottom - availableRect.top );
5183 // It should never be desirable to exceed the dimensions of the browser viewport... right?
5184 desiredWidth = Math.min( desiredWidth,
5185 document.documentElement.clientWidth - viewportSpacing.left - viewportSpacing.right );
5186 desiredHeight = Math.min( desiredHeight,
5187 document.documentElement.clientHeight - viewportSpacing.top - viewportSpacing.right );
5188 allotedWidth = Math.ceil( desiredWidth - extraWidth );
5189 allotedHeight = Math.ceil( desiredHeight - extraHeight );
5190 naturalWidth = this.$clippable.prop( 'scrollWidth' );
5191 naturalHeight = this.$clippable.prop( 'scrollHeight' );
5192 clipWidth = allotedWidth < naturalWidth;
5193 clipHeight = allotedHeight < naturalHeight;
5194
5195 if ( clipWidth ) {
5196 // The order matters here. If overflow is not set first, Chrome displays bogus scrollbars.
5197 // See T157672.
5198 // Forcing a reflow is a smaller workaround than calling reconsiderScrollbars() for
5199 // this case.
5200 this.$clippable.css( 'overflowX', 'scroll' );
5201 // eslint-disable-next-line no-void
5202 void this.$clippable[ 0 ].offsetHeight; // Force reflow
5203 this.$clippable.css( {
5204 width: Math.max( 0, allotedWidth ),
5205 maxWidth: ''
5206 } );
5207 } else {
5208 this.$clippable.css( {
5209 overflowX: '',
5210 width: this.idealWidth || '',
5211 maxWidth: Math.max( 0, allotedWidth )
5212 } );
5213 }
5214 if ( clipHeight ) {
5215 // The order matters here. If overflow is not set first, Chrome displays bogus scrollbars.
5216 // See T157672.
5217 // Forcing a reflow is a smaller workaround than calling reconsiderScrollbars() for
5218 // this case.
5219 this.$clippable.css( 'overflowY', 'scroll' );
5220 // eslint-disable-next-line no-void
5221 void this.$clippable[ 0 ].offsetHeight; // Force reflow
5222 this.$clippable.css( {
5223 height: Math.max( 0, allotedHeight ),
5224 maxHeight: ''
5225 } );
5226 } else {
5227 this.$clippable.css( {
5228 overflowY: '',
5229 height: this.idealHeight || '',
5230 maxHeight: Math.max( 0, allotedHeight )
5231 } );
5232 }
5233
5234 // If we stopped clipping in at least one of the dimensions
5235 if ( ( this.clippedHorizontally && !clipWidth ) || ( this.clippedVertically && !clipHeight ) ) {
5236 OO.ui.Element.static.reconsiderScrollbars( this.$clippable[ 0 ] );
5237 }
5238
5239 this.clippedHorizontally = clipWidth;
5240 this.clippedVertically = clipHeight;
5241
5242 return this;
5243 };
5244
5245 /**
5246 * PopupWidget is a container for content. The popup is overlaid and positioned absolutely.
5247 * By default, each popup has an anchor that points toward its origin.
5248 * Please see the [OOUI documentation on MediaWiki.org] [1] for more information and examples.
5249 *
5250 * Unlike most widgets, PopupWidget is initially hidden and must be shown by calling #toggle.
5251 *
5252 * @example
5253 * // A PopupWidget.
5254 * var popup = new OO.ui.PopupWidget( {
5255 * $content: $( '<p>Hi there!</p>' ),
5256 * padded: true,
5257 * width: 300
5258 * } );
5259 *
5260 * $( document.body ).append( popup.$element );
5261 * // To display the popup, toggle the visibility to 'true'.
5262 * popup.toggle( true );
5263 *
5264 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Popups
5265 *
5266 * @class
5267 * @extends OO.ui.Widget
5268 * @mixins OO.ui.mixin.LabelElement
5269 * @mixins OO.ui.mixin.ClippableElement
5270 * @mixins OO.ui.mixin.FloatableElement
5271 *
5272 * @constructor
5273 * @param {Object} [config] Configuration options
5274 * @cfg {number|null} [width=320] Width of popup in pixels. Pass `null` to use automatic width.
5275 * @cfg {number|null} [height=null] Height of popup in pixels. Pass `null` to use automatic height.
5276 * @cfg {boolean} [anchor=true] Show anchor pointing to origin of popup
5277 * @cfg {string} [position='below'] Where to position the popup relative to $floatableContainer
5278 * 'above': Put popup above $floatableContainer; anchor points down to the horizontal center
5279 * of $floatableContainer
5280 * 'below': Put popup below $floatableContainer; anchor points up to the horizontal center
5281 * of $floatableContainer
5282 * 'before': Put popup to the left (LTR) / right (RTL) of $floatableContainer; anchor points
5283 * endwards (right/left) to the vertical center of $floatableContainer
5284 * 'after': Put popup to the right (LTR) / left (RTL) of $floatableContainer; anchor points
5285 * startwards (left/right) to the vertical center of $floatableContainer
5286 * @cfg {string} [align='center'] How to align the popup to $floatableContainer
5287 * 'forwards': If position is above/below, move the popup as far endwards (right in LTR, left in
5288 * RTL) as possible while still keeping the anchor within the popup; if position is before/after,
5289 * move the popup as far downwards as possible.
5290 * 'backwards': If position is above/below, move the popup as far startwards (left in LTR, right in
5291 * RTL) as possible while still keeping the anchor within the popup; if position is before/after,
5292 * move the popup as far upwards as possible.
5293 * 'center': Horizontally (if position is above/below) or vertically (before/after) align the
5294 * center of the popup with the center of $floatableContainer.
5295 * 'force-left': Alias for 'forwards' in LTR and 'backwards' in RTL
5296 * 'force-right': Alias for 'backwards' in RTL and 'forwards' in LTR
5297 * @cfg {boolean} [autoFlip=true] Whether to automatically switch the popup's position between
5298 * 'above' and 'below', or between 'before' and 'after', if there is not enough space in the
5299 * desired direction to display the popup without clipping
5300 * @cfg {jQuery} [$container] Constrain the popup to the boundaries of the specified container.
5301 * See the [OOUI docs on MediaWiki][3] for an example.
5302 * [3]: https://www.mediawiki.org/wiki/OOUI/Widgets/Popups#containerExample
5303 * @cfg {number} [containerPadding=10] Padding between the popup and its container, specified as a
5304 * number of pixels.
5305 * @cfg {jQuery} [$content] Content to append to the popup's body
5306 * @cfg {jQuery} [$footer] Content to append to the popup's footer
5307 * @cfg {boolean} [autoClose=false] Automatically close the popup when it loses focus.
5308 * @cfg {jQuery} [$autoCloseIgnore] Elements that will not close the popup when clicked.
5309 * This config option is only relevant if #autoClose is set to `true`. See the
5310 * [OOUI documentation on MediaWiki][2] for an example.
5311 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Popups#autocloseExample
5312 * @cfg {boolean} [head=false] Show a popup header that contains a #label (if specified) and close
5313 * button.
5314 * @cfg {boolean} [padded=false] Add padding to the popup's body
5315 */
5316 OO.ui.PopupWidget = function OoUiPopupWidget( config ) {
5317 // Configuration initialization
5318 config = config || {};
5319
5320 // Parent constructor
5321 OO.ui.PopupWidget.parent.call( this, config );
5322
5323 // Properties (must be set before ClippableElement constructor call)
5324 this.$body = $( '<div>' );
5325 this.$popup = $( '<div>' );
5326
5327 // Mixin constructors
5328 OO.ui.mixin.LabelElement.call( this, config );
5329 OO.ui.mixin.ClippableElement.call( this, $.extend( {
5330 $clippable: this.$body,
5331 $clippableContainer: this.$popup
5332 }, config ) );
5333 OO.ui.mixin.FloatableElement.call( this, config );
5334
5335 // Properties
5336 this.$anchor = $( '<div>' );
5337 // If undefined, will be computed lazily in computePosition()
5338 this.$container = config.$container;
5339 this.containerPadding = config.containerPadding !== undefined ? config.containerPadding : 10;
5340 this.autoClose = !!config.autoClose;
5341 this.transitionTimeout = null;
5342 this.anchored = false;
5343 this.onDocumentMouseDownHandler = this.onDocumentMouseDown.bind( this );
5344 this.onDocumentKeyDownHandler = this.onDocumentKeyDown.bind( this );
5345
5346 // Initialization
5347 this.setSize( config.width, config.height );
5348 this.toggleAnchor( config.anchor === undefined || config.anchor );
5349 this.setAlignment( config.align || 'center' );
5350 this.setPosition( config.position || 'below' );
5351 this.setAutoFlip( config.autoFlip === undefined || config.autoFlip );
5352 this.setAutoCloseIgnore( config.$autoCloseIgnore );
5353 this.$body.addClass( 'oo-ui-popupWidget-body' );
5354 this.$anchor.addClass( 'oo-ui-popupWidget-anchor' );
5355 this.$popup
5356 .addClass( 'oo-ui-popupWidget-popup' )
5357 .append( this.$body );
5358 this.$element
5359 .addClass( 'oo-ui-popupWidget' )
5360 .append( this.$popup, this.$anchor );
5361 // Move content, which was added to #$element by OO.ui.Widget, to the body
5362 // FIXME This is gross, we should use '$body' or something for the config
5363 if ( config.$content instanceof $ ) {
5364 this.$body.append( config.$content );
5365 }
5366
5367 if ( config.padded ) {
5368 this.$body.addClass( 'oo-ui-popupWidget-body-padded' );
5369 }
5370
5371 if ( config.head ) {
5372 this.closeButton = new OO.ui.ButtonWidget( {
5373 framed: false,
5374 icon: 'close'
5375 } );
5376 this.closeButton.connect( this, {
5377 click: 'onCloseButtonClick'
5378 } );
5379 this.$head = $( '<div>' )
5380 .addClass( 'oo-ui-popupWidget-head' )
5381 .append( this.$label, this.closeButton.$element );
5382 this.$popup.prepend( this.$head );
5383 }
5384
5385 if ( config.$footer ) {
5386 this.$footer = $( '<div>' )
5387 .addClass( 'oo-ui-popupWidget-footer' )
5388 .append( config.$footer );
5389 this.$popup.append( this.$footer );
5390 }
5391
5392 // Initially hidden - using #toggle may cause errors if subclasses override toggle with methods
5393 // that reference properties not initialized at that time of parent class construction
5394 // TODO: Find a better way to handle post-constructor setup
5395 this.visible = false;
5396 this.$element.addClass( 'oo-ui-element-hidden' );
5397 };
5398
5399 /* Setup */
5400
5401 OO.inheritClass( OO.ui.PopupWidget, OO.ui.Widget );
5402 OO.mixinClass( OO.ui.PopupWidget, OO.ui.mixin.LabelElement );
5403 OO.mixinClass( OO.ui.PopupWidget, OO.ui.mixin.ClippableElement );
5404 OO.mixinClass( OO.ui.PopupWidget, OO.ui.mixin.FloatableElement );
5405
5406 /* Events */
5407
5408 /**
5409 * @event ready
5410 *
5411 * The popup is ready: it is visible and has been positioned and clipped.
5412 */
5413
5414 /* Methods */
5415
5416 /**
5417 * Handles document mouse down events.
5418 *
5419 * @private
5420 * @param {MouseEvent} e Mouse down event
5421 */
5422 OO.ui.PopupWidget.prototype.onDocumentMouseDown = function ( e ) {
5423 if (
5424 this.isVisible() &&
5425 !OO.ui.contains( this.$element.add( this.$autoCloseIgnore ).get(), e.target, true )
5426 ) {
5427 this.toggle( false );
5428 }
5429 };
5430
5431 /**
5432 * Bind document mouse down listener.
5433 *
5434 * @private
5435 */
5436 OO.ui.PopupWidget.prototype.bindDocumentMouseDownListener = function () {
5437 // Capture clicks outside popup
5438 this.getElementDocument().addEventListener( 'mousedown', this.onDocumentMouseDownHandler, true );
5439 // We add 'click' event because iOS safari needs to respond to this event.
5440 // We can't use 'touchstart' (as is usually the equivalent to 'mousedown') because
5441 // then it will trigger when scrolling. While iOS Safari has some reported behavior
5442 // of occasionally not emitting 'click' properly, that event seems to be the standard
5443 // that it should be emitting, so we add it to this and will operate the event handler
5444 // on whichever of these events was triggered first
5445 this.getElementDocument().addEventListener( 'click', this.onDocumentMouseDownHandler, true );
5446 };
5447
5448 /**
5449 * Handles close button click events.
5450 *
5451 * @private
5452 */
5453 OO.ui.PopupWidget.prototype.onCloseButtonClick = function () {
5454 if ( this.isVisible() ) {
5455 this.toggle( false );
5456 }
5457 };
5458
5459 /**
5460 * Unbind document mouse down listener.
5461 *
5462 * @private
5463 */
5464 OO.ui.PopupWidget.prototype.unbindDocumentMouseDownListener = function () {
5465 this.getElementDocument().removeEventListener( 'mousedown', this.onDocumentMouseDownHandler, true );
5466 this.getElementDocument().removeEventListener( 'click', this.onDocumentMouseDownHandler, true );
5467 };
5468
5469 /**
5470 * Handles document key down events.
5471 *
5472 * @private
5473 * @param {KeyboardEvent} e Key down event
5474 */
5475 OO.ui.PopupWidget.prototype.onDocumentKeyDown = function ( e ) {
5476 if (
5477 e.which === OO.ui.Keys.ESCAPE &&
5478 this.isVisible()
5479 ) {
5480 this.toggle( false );
5481 e.preventDefault();
5482 e.stopPropagation();
5483 }
5484 };
5485
5486 /**
5487 * Bind document key down listener.
5488 *
5489 * @private
5490 */
5491 OO.ui.PopupWidget.prototype.bindDocumentKeyDownListener = function () {
5492 this.getElementDocument().addEventListener( 'keydown', this.onDocumentKeyDownHandler, true );
5493 };
5494
5495 /**
5496 * Unbind document key down listener.
5497 *
5498 * @private
5499 */
5500 OO.ui.PopupWidget.prototype.unbindDocumentKeyDownListener = function () {
5501 this.getElementDocument().removeEventListener( 'keydown', this.onDocumentKeyDownHandler, true );
5502 };
5503
5504 /**
5505 * Show, hide, or toggle the visibility of the anchor.
5506 *
5507 * @param {boolean} [show] Show anchor, omit to toggle
5508 */
5509 OO.ui.PopupWidget.prototype.toggleAnchor = function ( show ) {
5510 show = show === undefined ? !this.anchored : !!show;
5511
5512 if ( this.anchored !== show ) {
5513 if ( show ) {
5514 this.$element.addClass( 'oo-ui-popupWidget-anchored' );
5515 this.$element.addClass( 'oo-ui-popupWidget-anchored-' + this.anchorEdge );
5516 } else {
5517 this.$element.removeClass( 'oo-ui-popupWidget-anchored' );
5518 this.$element.removeClass( 'oo-ui-popupWidget-anchored-' + this.anchorEdge );
5519 }
5520 this.anchored = show;
5521 }
5522 };
5523
5524 /**
5525 * Change which edge the anchor appears on.
5526 *
5527 * @param {string} edge 'top', 'bottom', 'start' or 'end'
5528 */
5529 OO.ui.PopupWidget.prototype.setAnchorEdge = function ( edge ) {
5530 if ( [ 'top', 'bottom', 'start', 'end' ].indexOf( edge ) === -1 ) {
5531 throw new Error( 'Invalid value for edge: ' + edge );
5532 }
5533 if ( this.anchorEdge !== null ) {
5534 this.$element.removeClass( 'oo-ui-popupWidget-anchored-' + this.anchorEdge );
5535 }
5536 this.anchorEdge = edge;
5537 if ( this.anchored ) {
5538 this.$element.addClass( 'oo-ui-popupWidget-anchored-' + edge );
5539 }
5540 };
5541
5542 /**
5543 * Check if the anchor is visible.
5544 *
5545 * @return {boolean} Anchor is visible
5546 */
5547 OO.ui.PopupWidget.prototype.hasAnchor = function () {
5548 return this.anchored;
5549 };
5550
5551 /**
5552 * Toggle visibility of the popup. The popup is initially hidden and must be shown by calling
5553 * `.toggle( true )` after its #$element is attached to the DOM.
5554 *
5555 * Do not show the popup while it is not attached to the DOM. The calculations required to display
5556 * it in the right place and with the right dimensions only work correctly while it is attached.
5557 * Side-effects may include broken interface and exceptions being thrown. This wasn't always
5558 * strictly enforced, so currently it only generates a warning in the browser console.
5559 *
5560 * @fires ready
5561 * @inheritdoc
5562 */
5563 OO.ui.PopupWidget.prototype.toggle = function ( show ) {
5564 var change, normalHeight, oppositeHeight, normalWidth, oppositeWidth;
5565 show = show === undefined ? !this.isVisible() : !!show;
5566
5567 change = show !== this.isVisible();
5568
5569 if ( show && !this.warnedUnattached && !this.isElementAttached() ) {
5570 OO.ui.warnDeprecation( 'PopupWidget#toggle: Before calling this method, the popup must be attached to the DOM.' );
5571 this.warnedUnattached = true;
5572 }
5573 if ( show && !this.$floatableContainer && this.isElementAttached() ) {
5574 // Fall back to the parent node if the floatableContainer is not set
5575 this.setFloatableContainer( this.$element.parent() );
5576 }
5577
5578 if ( change && show && this.autoFlip ) {
5579 // Reset auto-flipping before showing the popup again. It's possible we no longer need to
5580 // flip (e.g. if the user scrolled).
5581 this.isAutoFlipped = false;
5582 }
5583
5584 // Parent method
5585 OO.ui.PopupWidget.parent.prototype.toggle.call( this, show );
5586
5587 if ( change ) {
5588 this.togglePositioning( show && !!this.$floatableContainer );
5589
5590 if ( show ) {
5591 if ( this.autoClose ) {
5592 this.bindDocumentMouseDownListener();
5593 this.bindDocumentKeyDownListener();
5594 }
5595 this.updateDimensions();
5596 this.toggleClipping( true );
5597
5598 if ( this.autoFlip ) {
5599 if ( this.popupPosition === 'above' || this.popupPosition === 'below' ) {
5600 if ( this.isClippedVertically() || this.isFloatableOutOfView() ) {
5601 // If opening the popup in the normal direction causes it to be clipped,
5602 // open in the opposite one instead
5603 normalHeight = this.$element.height();
5604 this.isAutoFlipped = !this.isAutoFlipped;
5605 this.position();
5606 if ( this.isClippedVertically() || this.isFloatableOutOfView() ) {
5607 // If that also causes it to be clipped, open in whichever direction
5608 // we have more space
5609 oppositeHeight = this.$element.height();
5610 if ( oppositeHeight < normalHeight ) {
5611 this.isAutoFlipped = !this.isAutoFlipped;
5612 this.position();
5613 }
5614 }
5615 }
5616 }
5617 if ( this.popupPosition === 'before' || this.popupPosition === 'after' ) {
5618 if ( this.isClippedHorizontally() || this.isFloatableOutOfView() ) {
5619 // If opening the popup in the normal direction causes it to be clipped,
5620 // open in the opposite one instead
5621 normalWidth = this.$element.width();
5622 this.isAutoFlipped = !this.isAutoFlipped;
5623 // Due to T180173 horizontally clipped PopupWidgets have messed up
5624 // dimensions, which causes positioning to be off. Toggle clipping back and
5625 // forth to work around.
5626 this.toggleClipping( false );
5627 this.position();
5628 this.toggleClipping( true );
5629 if ( this.isClippedHorizontally() || this.isFloatableOutOfView() ) {
5630 // If that also causes it to be clipped, open in whichever direction
5631 // we have more space
5632 oppositeWidth = this.$element.width();
5633 if ( oppositeWidth < normalWidth ) {
5634 this.isAutoFlipped = !this.isAutoFlipped;
5635 // Due to T180173, horizontally clipped PopupWidgets have messed up
5636 // dimensions, which causes positioning to be off. Toggle clipping
5637 // back and forth to work around.
5638 this.toggleClipping( false );
5639 this.position();
5640 this.toggleClipping( true );
5641 }
5642 }
5643 }
5644 }
5645 }
5646
5647 this.emit( 'ready' );
5648 } else {
5649 this.toggleClipping( false );
5650 if ( this.autoClose ) {
5651 this.unbindDocumentMouseDownListener();
5652 this.unbindDocumentKeyDownListener();
5653 }
5654 }
5655 }
5656
5657 return this;
5658 };
5659
5660 /**
5661 * Set the size of the popup.
5662 *
5663 * Changing the size may also change the popup's position depending on the alignment.
5664 *
5665 * @param {number|null} [width=320] Width in pixels. Pass `null` to use automatic width.
5666 * @param {number|null} [height=null] Height in pixels. Pass `null` to use automatic height.
5667 * @param {boolean} [transition=false] Use a smooth transition
5668 * @chainable
5669 */
5670 OO.ui.PopupWidget.prototype.setSize = function ( width, height, transition ) {
5671 this.width = width !== undefined ? width : 320;
5672 this.height = height !== undefined ? height : null;
5673 if ( this.isVisible() ) {
5674 this.updateDimensions( transition );
5675 }
5676 };
5677
5678 /**
5679 * Update the size and position.
5680 *
5681 * Only use this to keep the popup properly anchored. Use #setSize to change the size, and this will
5682 * be called automatically.
5683 *
5684 * @param {boolean} [transition=false] Use a smooth transition
5685 * @chainable
5686 */
5687 OO.ui.PopupWidget.prototype.updateDimensions = function ( transition ) {
5688 var widget = this;
5689
5690 // Prevent transition from being interrupted
5691 clearTimeout( this.transitionTimeout );
5692 if ( transition ) {
5693 // Enable transition
5694 this.$element.addClass( 'oo-ui-popupWidget-transitioning' );
5695 }
5696
5697 this.position();
5698
5699 if ( transition ) {
5700 // Prevent transitioning after transition is complete
5701 this.transitionTimeout = setTimeout( function () {
5702 widget.$element.removeClass( 'oo-ui-popupWidget-transitioning' );
5703 }, 200 );
5704 } else {
5705 // Prevent transitioning immediately
5706 this.$element.removeClass( 'oo-ui-popupWidget-transitioning' );
5707 }
5708 };
5709
5710 /**
5711 * @inheritdoc
5712 */
5713 OO.ui.PopupWidget.prototype.computePosition = function () {
5714 var direction, align, vertical, start, end, near, far, sizeProp, popupSize, anchorSize,
5715 anchorPos, anchorOffset, anchorMargin, parentPosition, positionProp, positionAdjustment,
5716 floatablePos, offsetParentPos, containerPos, popupPosition, viewportSpacing,
5717 popupPos = {},
5718 anchorCss = { left: '', right: '', top: '', bottom: '' },
5719 popupPositionOppositeMap = {
5720 above: 'below',
5721 below: 'above',
5722 before: 'after',
5723 after: 'before'
5724 },
5725 alignMap = {
5726 ltr: {
5727 'force-left': 'backwards',
5728 'force-right': 'forwards'
5729 },
5730 rtl: {
5731 'force-left': 'forwards',
5732 'force-right': 'backwards'
5733 }
5734 },
5735 anchorEdgeMap = {
5736 above: 'bottom',
5737 below: 'top',
5738 before: 'end',
5739 after: 'start'
5740 },
5741 hPosMap = {
5742 forwards: 'start',
5743 center: 'center',
5744 backwards: this.anchored ? 'before' : 'end'
5745 },
5746 vPosMap = {
5747 forwards: 'top',
5748 center: 'center',
5749 backwards: 'bottom'
5750 };
5751
5752 if ( !this.$container ) {
5753 // Lazy-initialize $container if not specified in constructor
5754 this.$container = $( this.getClosestScrollableElementContainer() );
5755 }
5756 direction = this.$container.css( 'direction' );
5757
5758 // Set height and width before we do anything else, since it might cause our measurements
5759 // to change (e.g. due to scrollbars appearing or disappearing), and it also affects centering
5760 this.$popup.css( {
5761 width: this.width !== null ? this.width : 'auto',
5762 height: this.height !== null ? this.height : 'auto'
5763 } );
5764
5765 align = alignMap[ direction ][ this.align ] || this.align;
5766 popupPosition = this.popupPosition;
5767 if ( this.isAutoFlipped ) {
5768 popupPosition = popupPositionOppositeMap[ popupPosition ];
5769 }
5770
5771 // If the popup is positioned before or after, then the anchor positioning is vertical,
5772 // otherwise horizontal
5773 vertical = popupPosition === 'before' || popupPosition === 'after';
5774 start = vertical ? 'top' : ( direction === 'rtl' ? 'right' : 'left' );
5775 end = vertical ? 'bottom' : ( direction === 'rtl' ? 'left' : 'right' );
5776 near = vertical ? 'top' : 'left';
5777 far = vertical ? 'bottom' : 'right';
5778 sizeProp = vertical ? 'Height' : 'Width';
5779 popupSize = vertical ?
5780 ( this.height || this.$popup.height() ) :
5781 ( this.width || this.$popup.width() );
5782
5783 this.setAnchorEdge( anchorEdgeMap[ popupPosition ] );
5784 this.horizontalPosition = vertical ? popupPosition : hPosMap[ align ];
5785 this.verticalPosition = vertical ? vPosMap[ align ] : popupPosition;
5786
5787 // Parent method
5788 parentPosition = OO.ui.mixin.FloatableElement.prototype.computePosition.call( this );
5789 // Find out which property FloatableElement used for positioning, and adjust that value
5790 positionProp = vertical ?
5791 ( parentPosition.top !== '' ? 'top' : 'bottom' ) :
5792 ( parentPosition.left !== '' ? 'left' : 'right' );
5793
5794 // Figure out where the near and far edges of the popup and $floatableContainer are
5795 floatablePos = this.$floatableContainer.offset();
5796 floatablePos[ far ] = floatablePos[ near ] + this.$floatableContainer[ 'outer' + sizeProp ]();
5797 // Measure where the offsetParent is and compute our position based on that and parentPosition
5798 offsetParentPos = this.$element.offsetParent()[ 0 ] === document.documentElement ?
5799 { top: 0, left: 0 } :
5800 this.$element.offsetParent().offset();
5801
5802 if ( positionProp === near ) {
5803 popupPos[ near ] = offsetParentPos[ near ] + parentPosition[ near ];
5804 popupPos[ far ] = popupPos[ near ] + popupSize;
5805 } else {
5806 popupPos[ far ] = offsetParentPos[ near ] +
5807 this.$element.offsetParent()[ 'inner' + sizeProp ]() - parentPosition[ far ];
5808 popupPos[ near ] = popupPos[ far ] - popupSize;
5809 }
5810
5811 if ( this.anchored ) {
5812 // Position the anchor (which is positioned relative to the popup) to point to
5813 // $floatableContainer
5814 anchorPos = ( floatablePos[ start ] + floatablePos[ end ] ) / 2;
5815 anchorOffset = ( start === far ? -1 : 1 ) * ( anchorPos - popupPos[ start ] );
5816
5817 // If the anchor is less than 2*anchorSize from either edge, move the popup to make more
5818 // space this.$anchor.width()/height() returns 0 because of the CSS trickery we use, so use
5819 // scrollWidth/Height
5820 anchorSize = this.$anchor[ 0 ][ 'scroll' + sizeProp ];
5821 anchorMargin = parseFloat( this.$anchor.css( 'margin-' + start ) );
5822 if ( anchorOffset + anchorMargin < 2 * anchorSize ) {
5823 // Not enough space for the anchor on the start side; pull the popup startwards
5824 positionAdjustment = ( positionProp === start ? -1 : 1 ) *
5825 ( 2 * anchorSize - ( anchorOffset + anchorMargin ) );
5826 } else if ( anchorOffset + anchorMargin > popupSize - 2 * anchorSize ) {
5827 // Not enough space for the anchor on the end side; pull the popup endwards
5828 positionAdjustment = ( positionProp === end ? -1 : 1 ) *
5829 ( anchorOffset + anchorMargin - ( popupSize - 2 * anchorSize ) );
5830 } else {
5831 positionAdjustment = 0;
5832 }
5833 } else {
5834 positionAdjustment = 0;
5835 }
5836
5837 // Check if the popup will go beyond the edge of this.$container
5838 containerPos = this.$container[ 0 ] === document.documentElement ?
5839 { top: 0, left: 0 } :
5840 this.$container.offset();
5841 containerPos[ far ] = containerPos[ near ] + this.$container[ 'inner' + sizeProp ]();
5842 if ( this.$container[ 0 ] === document.documentElement ) {
5843 viewportSpacing = OO.ui.getViewportSpacing();
5844 containerPos[ near ] += viewportSpacing[ near ];
5845 containerPos[ far ] -= viewportSpacing[ far ];
5846 }
5847 // Take into account how much the popup will move because of the adjustments we're going to make
5848 popupPos[ near ] += ( positionProp === near ? 1 : -1 ) * positionAdjustment;
5849 popupPos[ far ] += ( positionProp === near ? 1 : -1 ) * positionAdjustment;
5850 if ( containerPos[ near ] + this.containerPadding > popupPos[ near ] ) {
5851 // Popup goes beyond the near (left/top) edge, move it to the right/bottom
5852 positionAdjustment += ( positionProp === near ? 1 : -1 ) *
5853 ( containerPos[ near ] + this.containerPadding - popupPos[ near ] );
5854 } else if ( containerPos[ far ] - this.containerPadding < popupPos[ far ] ) {
5855 // Popup goes beyond the far (right/bottom) edge, move it to the left/top
5856 positionAdjustment += ( positionProp === far ? 1 : -1 ) *
5857 ( popupPos[ far ] - ( containerPos[ far ] - this.containerPadding ) );
5858 }
5859
5860 if ( this.anchored ) {
5861 // Adjust anchorOffset for positionAdjustment
5862 anchorOffset += ( positionProp === start ? -1 : 1 ) * positionAdjustment;
5863
5864 // Position the anchor
5865 anchorCss[ start ] = anchorOffset;
5866 this.$anchor.css( anchorCss );
5867 }
5868
5869 // Move the popup if needed
5870 parentPosition[ positionProp ] += positionAdjustment;
5871
5872 return parentPosition;
5873 };
5874
5875 /**
5876 * Set popup alignment
5877 *
5878 * @param {string} [align=center] Alignment of the popup, `center`, `force-left`, `force-right`,
5879 * `backwards` or `forwards`.
5880 */
5881 OO.ui.PopupWidget.prototype.setAlignment = function ( align ) {
5882 // Validate alignment
5883 if ( [ 'force-left', 'force-right', 'backwards', 'forwards', 'center' ].indexOf( align ) > -1 ) {
5884 this.align = align;
5885 } else {
5886 this.align = 'center';
5887 }
5888 this.position();
5889 };
5890
5891 /**
5892 * Get popup alignment
5893 *
5894 * @return {string} Alignment of the popup, `center`, `force-left`, `force-right`,
5895 * `backwards` or `forwards`.
5896 */
5897 OO.ui.PopupWidget.prototype.getAlignment = function () {
5898 return this.align;
5899 };
5900
5901 /**
5902 * Change the positioning of the popup.
5903 *
5904 * @param {string} position 'above', 'below', 'before' or 'after'
5905 */
5906 OO.ui.PopupWidget.prototype.setPosition = function ( position ) {
5907 if ( [ 'above', 'below', 'before', 'after' ].indexOf( position ) === -1 ) {
5908 position = 'below';
5909 }
5910 this.popupPosition = position;
5911 this.position();
5912 };
5913
5914 /**
5915 * Get popup positioning.
5916 *
5917 * @return {string} 'above', 'below', 'before' or 'after'
5918 */
5919 OO.ui.PopupWidget.prototype.getPosition = function () {
5920 return this.popupPosition;
5921 };
5922
5923 /**
5924 * Set popup auto-flipping.
5925 *
5926 * @param {boolean} autoFlip Whether to automatically switch the popup's position between
5927 * 'above' and 'below', or between 'before' and 'after', if there is not enough space in the
5928 * desired direction to display the popup without clipping
5929 */
5930 OO.ui.PopupWidget.prototype.setAutoFlip = function ( autoFlip ) {
5931 autoFlip = !!autoFlip;
5932
5933 if ( this.autoFlip !== autoFlip ) {
5934 this.autoFlip = autoFlip;
5935 }
5936 };
5937
5938 /**
5939 * Set which elements will not close the popup when clicked.
5940 *
5941 * For auto-closing popups, clicks on these elements will not cause the popup to auto-close.
5942 *
5943 * @param {jQuery} $autoCloseIgnore Elements to ignore for auto-closing
5944 */
5945 OO.ui.PopupWidget.prototype.setAutoCloseIgnore = function ( $autoCloseIgnore ) {
5946 this.$autoCloseIgnore = $autoCloseIgnore;
5947 };
5948
5949 /**
5950 * Get an ID of the body element, this can be used as the
5951 * `aria-describedby` attribute for an input field.
5952 *
5953 * @return {string} The ID of the body element
5954 */
5955 OO.ui.PopupWidget.prototype.getBodyId = function () {
5956 var id = this.$body.attr( 'id' );
5957 if ( id === undefined ) {
5958 id = OO.ui.generateElementId();
5959 this.$body.attr( 'id', id );
5960 }
5961 return id;
5962 };
5963
5964 /**
5965 * PopupElement is mixed into other classes to generate a {@link OO.ui.PopupWidget popup widget}.
5966 * A popup is a container for content. It is overlaid and positioned absolutely. By default, each
5967 * popup has an anchor, which is an arrow-like protrusion that points toward the popup’s origin.
5968 * See {@link OO.ui.PopupWidget PopupWidget} for an example.
5969 *
5970 * @abstract
5971 * @class
5972 *
5973 * @constructor
5974 * @param {Object} [config] Configuration options
5975 * @cfg {Object} [popup] Configuration to pass to popup
5976 * @cfg {boolean} [popup.autoClose=true] Popup auto-closes when it loses focus
5977 */
5978 OO.ui.mixin.PopupElement = function OoUiMixinPopupElement( config ) {
5979 // Configuration initialization
5980 config = config || {};
5981
5982 // Properties
5983 this.popup = new OO.ui.PopupWidget( $.extend(
5984 {
5985 autoClose: true,
5986 $floatableContainer: this.$element
5987 },
5988 config.popup,
5989 {
5990 $autoCloseIgnore: this.$element.add( config.popup && config.popup.$autoCloseIgnore )
5991 }
5992 ) );
5993 };
5994
5995 /* Methods */
5996
5997 /**
5998 * Get popup.
5999 *
6000 * @return {OO.ui.PopupWidget} Popup widget
6001 */
6002 OO.ui.mixin.PopupElement.prototype.getPopup = function () {
6003 return this.popup;
6004 };
6005
6006 /**
6007 * PopupButtonWidgets toggle the visibility of a contained {@link OO.ui.PopupWidget PopupWidget},
6008 * which is used to display additional information or options.
6009 *
6010 * @example
6011 * // A PopupButtonWidget.
6012 * var popupButton = new OO.ui.PopupButtonWidget( {
6013 * label: 'Popup button with options',
6014 * icon: 'menu',
6015 * popup: {
6016 * $content: $( '<p>Additional options here.</p>' ),
6017 * padded: true,
6018 * align: 'force-left'
6019 * }
6020 * } );
6021 * // Append the button to the DOM.
6022 * $( document.body ).append( popupButton.$element );
6023 *
6024 * @class
6025 * @extends OO.ui.ButtonWidget
6026 * @mixins OO.ui.mixin.PopupElement
6027 *
6028 * @constructor
6029 * @param {Object} [config] Configuration options
6030 * @cfg {jQuery} [$overlay] Render the popup into a separate layer. This configuration is useful
6031 * in cases where the expanded popup is larger than its containing `<div>`. The specified overlay
6032 * layer is usually on top of the containing `<div>` and has a larger area. By default, the popup
6033 * uses relative positioning.
6034 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
6035 */
6036 OO.ui.PopupButtonWidget = function OoUiPopupButtonWidget( config ) {
6037 // Configuration initialization
6038 config = config || {};
6039
6040 // Parent constructor
6041 OO.ui.PopupButtonWidget.parent.call( this, config );
6042
6043 // Mixin constructors
6044 OO.ui.mixin.PopupElement.call( this, config );
6045
6046 // Properties
6047 this.$overlay = ( config.$overlay === true ?
6048 OO.ui.getDefaultOverlay() : config.$overlay ) || this.$element;
6049
6050 // Events
6051 this.connect( this, {
6052 click: 'onAction'
6053 } );
6054
6055 // Initialization
6056 this.$element.addClass( 'oo-ui-popupButtonWidget' );
6057 this.popup.$element
6058 .addClass( 'oo-ui-popupButtonWidget-popup' )
6059 .toggleClass( 'oo-ui-popupButtonWidget-framed-popup', this.isFramed() )
6060 .toggleClass( 'oo-ui-popupButtonWidget-frameless-popup', !this.isFramed() );
6061 this.$overlay.append( this.popup.$element );
6062 };
6063
6064 /* Setup */
6065
6066 OO.inheritClass( OO.ui.PopupButtonWidget, OO.ui.ButtonWidget );
6067 OO.mixinClass( OO.ui.PopupButtonWidget, OO.ui.mixin.PopupElement );
6068
6069 /* Methods */
6070
6071 /**
6072 * Handle the button action being triggered.
6073 *
6074 * @private
6075 */
6076 OO.ui.PopupButtonWidget.prototype.onAction = function () {
6077 this.popup.toggle();
6078 };
6079
6080 /**
6081 * Mixin for OO.ui.Widget subclasses to provide OO.ui.mixin.GroupElement.
6082 *
6083 * Use together with OO.ui.mixin.ItemWidget to make disabled state inheritable.
6084 *
6085 * @private
6086 * @abstract
6087 * @class
6088 * @mixins OO.ui.mixin.GroupElement
6089 *
6090 * @constructor
6091 * @param {Object} [config] Configuration options
6092 */
6093 OO.ui.mixin.GroupWidget = function OoUiMixinGroupWidget( config ) {
6094 // Mixin constructors
6095 OO.ui.mixin.GroupElement.call( this, config );
6096 };
6097
6098 /* Setup */
6099
6100 OO.mixinClass( OO.ui.mixin.GroupWidget, OO.ui.mixin.GroupElement );
6101
6102 /* Methods */
6103
6104 /**
6105 * Set the disabled state of the widget.
6106 *
6107 * This will also update the disabled state of child widgets.
6108 *
6109 * @param {boolean} disabled Disable widget
6110 * @chainable
6111 * @return {OO.ui.Widget} The widget, for chaining
6112 */
6113 OO.ui.mixin.GroupWidget.prototype.setDisabled = function ( disabled ) {
6114 var i, len;
6115
6116 // Parent method
6117 // Note: Calling #setDisabled this way assumes this is mixed into an OO.ui.Widget
6118 OO.ui.Widget.prototype.setDisabled.call( this, disabled );
6119
6120 // During construction, #setDisabled is called before the OO.ui.mixin.GroupElement constructor
6121 if ( this.items ) {
6122 for ( i = 0, len = this.items.length; i < len; i++ ) {
6123 this.items[ i ].updateDisabled();
6124 }
6125 }
6126
6127 return this;
6128 };
6129
6130 /**
6131 * Mixin for widgets used as items in widgets that mix in OO.ui.mixin.GroupWidget.
6132 *
6133 * Item widgets have a reference to a OO.ui.mixin.GroupWidget while they are attached to the group.
6134 * This allows bidirectional communication.
6135 *
6136 * Use together with OO.ui.mixin.GroupWidget to make disabled state inheritable.
6137 *
6138 * @private
6139 * @abstract
6140 * @class
6141 *
6142 * @constructor
6143 */
6144 OO.ui.mixin.ItemWidget = function OoUiMixinItemWidget() {
6145 //
6146 };
6147
6148 /* Methods */
6149
6150 /**
6151 * Check if widget is disabled.
6152 *
6153 * Checks parent if present, making disabled state inheritable.
6154 *
6155 * @return {boolean} Widget is disabled
6156 */
6157 OO.ui.mixin.ItemWidget.prototype.isDisabled = function () {
6158 return this.disabled ||
6159 ( this.elementGroup instanceof OO.ui.Widget && this.elementGroup.isDisabled() );
6160 };
6161
6162 /**
6163 * Set group element is in.
6164 *
6165 * @param {OO.ui.mixin.GroupElement|null} group Group element, null if none
6166 * @chainable
6167 * @return {OO.ui.Widget} The widget, for chaining
6168 */
6169 OO.ui.mixin.ItemWidget.prototype.setElementGroup = function ( group ) {
6170 // Parent method
6171 // Note: Calling #setElementGroup this way assumes this is mixed into an OO.ui.Element
6172 OO.ui.Element.prototype.setElementGroup.call( this, group );
6173
6174 // Initialize item disabled states
6175 this.updateDisabled();
6176
6177 return this;
6178 };
6179
6180 /**
6181 * OptionWidgets are special elements that can be selected and configured with data. The
6182 * data is often unique for each option, but it does not have to be. OptionWidgets are used
6183 * with OO.ui.SelectWidget to create a selection of mutually exclusive options. For more information
6184 * and examples, please see the [OOUI documentation on MediaWiki][1].
6185 *
6186 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
6187 *
6188 * @class
6189 * @extends OO.ui.Widget
6190 * @mixins OO.ui.mixin.ItemWidget
6191 * @mixins OO.ui.mixin.LabelElement
6192 * @mixins OO.ui.mixin.FlaggedElement
6193 * @mixins OO.ui.mixin.AccessKeyedElement
6194 * @mixins OO.ui.mixin.TitledElement
6195 *
6196 * @constructor
6197 * @param {Object} [config] Configuration options
6198 */
6199 OO.ui.OptionWidget = function OoUiOptionWidget( config ) {
6200 // Configuration initialization
6201 config = config || {};
6202
6203 // Parent constructor
6204 OO.ui.OptionWidget.parent.call( this, config );
6205
6206 // Mixin constructors
6207 OO.ui.mixin.ItemWidget.call( this );
6208 OO.ui.mixin.LabelElement.call( this, config );
6209 OO.ui.mixin.FlaggedElement.call( this, config );
6210 OO.ui.mixin.AccessKeyedElement.call( this, config );
6211 OO.ui.mixin.TitledElement.call( this, config );
6212
6213 // Properties
6214 this.highlighted = false;
6215 this.pressed = false;
6216 this.setSelected( !!config.selected );
6217
6218 // Initialization
6219 this.$element
6220 .data( 'oo-ui-optionWidget', this )
6221 // Allow programmatic focussing (and by access key), but not tabbing
6222 .attr( 'tabindex', '-1' )
6223 .attr( 'role', 'option' )
6224 .addClass( 'oo-ui-optionWidget' )
6225 .append( this.$label );
6226 };
6227
6228 /* Setup */
6229
6230 OO.inheritClass( OO.ui.OptionWidget, OO.ui.Widget );
6231 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.ItemWidget );
6232 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.LabelElement );
6233 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.FlaggedElement );
6234 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.AccessKeyedElement );
6235 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.TitledElement );
6236
6237 /* Static Properties */
6238
6239 /**
6240 * Whether this option can be selected. See #setSelected.
6241 *
6242 * @static
6243 * @inheritable
6244 * @property {boolean}
6245 */
6246 OO.ui.OptionWidget.static.selectable = true;
6247
6248 /**
6249 * Whether this option can be highlighted. See #setHighlighted.
6250 *
6251 * @static
6252 * @inheritable
6253 * @property {boolean}
6254 */
6255 OO.ui.OptionWidget.static.highlightable = true;
6256
6257 /**
6258 * Whether this option can be pressed. See #setPressed.
6259 *
6260 * @static
6261 * @inheritable
6262 * @property {boolean}
6263 */
6264 OO.ui.OptionWidget.static.pressable = true;
6265
6266 /**
6267 * Whether this option will be scrolled into view when it is selected.
6268 *
6269 * @static
6270 * @inheritable
6271 * @property {boolean}
6272 */
6273 OO.ui.OptionWidget.static.scrollIntoViewOnSelect = false;
6274
6275 /* Methods */
6276
6277 /**
6278 * Check if the option can be selected.
6279 *
6280 * @return {boolean} Item is selectable
6281 */
6282 OO.ui.OptionWidget.prototype.isSelectable = function () {
6283 return this.constructor.static.selectable && !this.disabled && this.isVisible();
6284 };
6285
6286 /**
6287 * Check if the option can be highlighted. A highlight indicates that the option
6288 * may be selected when a user presses Enter key or clicks. Disabled items cannot
6289 * be highlighted.
6290 *
6291 * @return {boolean} Item is highlightable
6292 */
6293 OO.ui.OptionWidget.prototype.isHighlightable = function () {
6294 return this.constructor.static.highlightable && !this.disabled && this.isVisible();
6295 };
6296
6297 /**
6298 * Check if the option can be pressed. The pressed state occurs when a user mouses
6299 * down on an item, but has not yet let go of the mouse.
6300 *
6301 * @return {boolean} Item is pressable
6302 */
6303 OO.ui.OptionWidget.prototype.isPressable = function () {
6304 return this.constructor.static.pressable && !this.disabled && this.isVisible();
6305 };
6306
6307 /**
6308 * Check if the option is selected.
6309 *
6310 * @return {boolean} Item is selected
6311 */
6312 OO.ui.OptionWidget.prototype.isSelected = function () {
6313 return this.selected;
6314 };
6315
6316 /**
6317 * Check if the option is highlighted. A highlight indicates that the
6318 * item may be selected when a user presses Enter key or clicks.
6319 *
6320 * @return {boolean} Item is highlighted
6321 */
6322 OO.ui.OptionWidget.prototype.isHighlighted = function () {
6323 return this.highlighted;
6324 };
6325
6326 /**
6327 * Check if the option is pressed. The pressed state occurs when a user mouses
6328 * down on an item, but has not yet let go of the mouse. The item may appear
6329 * selected, but it will not be selected until the user releases the mouse.
6330 *
6331 * @return {boolean} Item is pressed
6332 */
6333 OO.ui.OptionWidget.prototype.isPressed = function () {
6334 return this.pressed;
6335 };
6336
6337 /**
6338 * Set the option’s selected state. In general, all modifications to the selection
6339 * should be handled by the SelectWidget’s
6340 * {@link OO.ui.SelectWidget#selectItem selectItem( [item] )} method instead of this method.
6341 *
6342 * @param {boolean} [state=false] Select option
6343 * @chainable
6344 * @return {OO.ui.Widget} The widget, for chaining
6345 */
6346 OO.ui.OptionWidget.prototype.setSelected = function ( state ) {
6347 if ( this.constructor.static.selectable ) {
6348 this.selected = !!state;
6349 this.$element
6350 .toggleClass( 'oo-ui-optionWidget-selected', state )
6351 .attr( 'aria-selected', state.toString() );
6352 if ( state && this.constructor.static.scrollIntoViewOnSelect ) {
6353 this.scrollElementIntoView();
6354 }
6355 this.updateThemeClasses();
6356 }
6357 return this;
6358 };
6359
6360 /**
6361 * Set the option’s highlighted state. In general, all programmatic
6362 * modifications to the highlight should be handled by the
6363 * SelectWidget’s {@link OO.ui.SelectWidget#highlightItem highlightItem( [item] )}
6364 * method instead of this method.
6365 *
6366 * @param {boolean} [state=false] Highlight option
6367 * @chainable
6368 * @return {OO.ui.Widget} The widget, for chaining
6369 */
6370 OO.ui.OptionWidget.prototype.setHighlighted = function ( state ) {
6371 if ( this.constructor.static.highlightable ) {
6372 this.highlighted = !!state;
6373 this.$element.toggleClass( 'oo-ui-optionWidget-highlighted', state );
6374 this.updateThemeClasses();
6375 }
6376 return this;
6377 };
6378
6379 /**
6380 * Set the option’s pressed state. In general, all
6381 * programmatic modifications to the pressed state should be handled by the
6382 * SelectWidget’s {@link OO.ui.SelectWidget#pressItem pressItem( [item] )}
6383 * method instead of this method.
6384 *
6385 * @param {boolean} [state=false] Press option
6386 * @chainable
6387 * @return {OO.ui.Widget} The widget, for chaining
6388 */
6389 OO.ui.OptionWidget.prototype.setPressed = function ( state ) {
6390 if ( this.constructor.static.pressable ) {
6391 this.pressed = !!state;
6392 this.$element.toggleClass( 'oo-ui-optionWidget-pressed', state );
6393 this.updateThemeClasses();
6394 }
6395 return this;
6396 };
6397
6398 /**
6399 * Get text to match search strings against.
6400 *
6401 * The default implementation returns the label text, but subclasses
6402 * can override this to provide more complex behavior.
6403 *
6404 * @return {string|boolean} String to match search string against
6405 */
6406 OO.ui.OptionWidget.prototype.getMatchText = function () {
6407 var label = this.getLabel();
6408 return typeof label === 'string' ? label : this.$label.text();
6409 };
6410
6411 /**
6412 * A SelectWidget is of a generic selection of options. The OOUI library contains several types of
6413 * select widgets, including {@link OO.ui.ButtonSelectWidget button selects},
6414 * {@link OO.ui.RadioSelectWidget radio selects}, and {@link OO.ui.MenuSelectWidget
6415 * menu selects}.
6416 *
6417 * This class should be used together with OO.ui.OptionWidget or OO.ui.DecoratedOptionWidget. For
6418 * more information, please see the [OOUI documentation on MediaWiki][1].
6419 *
6420 * @example
6421 * // A select widget with three options.
6422 * var select = new OO.ui.SelectWidget( {
6423 * items: [
6424 * new OO.ui.OptionWidget( {
6425 * data: 'a',
6426 * label: 'Option One',
6427 * } ),
6428 * new OO.ui.OptionWidget( {
6429 * data: 'b',
6430 * label: 'Option Two',
6431 * } ),
6432 * new OO.ui.OptionWidget( {
6433 * data: 'c',
6434 * label: 'Option Three',
6435 * } )
6436 * ]
6437 * } );
6438 * $( document.body ).append( select.$element );
6439 *
6440 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
6441 *
6442 * @abstract
6443 * @class
6444 * @extends OO.ui.Widget
6445 * @mixins OO.ui.mixin.GroupWidget
6446 *
6447 * @constructor
6448 * @param {Object} [config] Configuration options
6449 * @cfg {OO.ui.OptionWidget[]} [items] An array of options to add to the select.
6450 * Options are created with {@link OO.ui.OptionWidget OptionWidget} classes. See
6451 * the [OOUI documentation on MediaWiki] [2] for examples.
6452 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
6453 * @cfg {boolean} [multiselect] Allow for multiple selections
6454 */
6455 OO.ui.SelectWidget = function OoUiSelectWidget( config ) {
6456 // Configuration initialization
6457 config = config || {};
6458
6459 // Parent constructor
6460 OO.ui.SelectWidget.parent.call( this, config );
6461
6462 // Mixin constructors
6463 OO.ui.mixin.GroupWidget.call( this, $.extend( {
6464 $group: this.$element
6465 }, config ) );
6466
6467 // Properties
6468 this.pressed = false;
6469 this.selecting = null;
6470 this.multiselect = !!config.multiselect;
6471 this.onDocumentMouseUpHandler = this.onDocumentMouseUp.bind( this );
6472 this.onDocumentMouseMoveHandler = this.onDocumentMouseMove.bind( this );
6473 this.onDocumentKeyDownHandler = this.onDocumentKeyDown.bind( this );
6474 this.onDocumentKeyPressHandler = this.onDocumentKeyPress.bind( this );
6475 this.keyPressBuffer = '';
6476 this.keyPressBufferTimer = null;
6477 this.blockMouseOverEvents = 0;
6478
6479 // Events
6480 this.connect( this, {
6481 toggle: 'onToggle'
6482 } );
6483 this.$element.on( {
6484 focusin: this.onFocus.bind( this ),
6485 mousedown: this.onMouseDown.bind( this ),
6486 mouseover: this.onMouseOver.bind( this ),
6487 mouseleave: this.onMouseLeave.bind( this )
6488 } );
6489
6490 // Initialization
6491 this.$element
6492 // -depressed is a deprecated alias of -unpressed
6493 .addClass( 'oo-ui-selectWidget oo-ui-selectWidget-unpressed oo-ui-selectWidget-depressed' )
6494 .attr( 'role', 'listbox' );
6495 this.setFocusOwner( this.$element );
6496 if ( Array.isArray( config.items ) ) {
6497 this.addItems( config.items );
6498 }
6499 };
6500
6501 /* Setup */
6502
6503 OO.inheritClass( OO.ui.SelectWidget, OO.ui.Widget );
6504 OO.mixinClass( OO.ui.SelectWidget, OO.ui.mixin.GroupWidget );
6505
6506 /* Events */
6507
6508 /**
6509 * @event highlight
6510 *
6511 * A `highlight` event is emitted when the highlight is changed with the #highlightItem method.
6512 *
6513 * @param {OO.ui.OptionWidget|null} item Highlighted item
6514 */
6515
6516 /**
6517 * @event press
6518 *
6519 * A `press` event is emitted when the #pressItem method is used to programmatically modify the
6520 * pressed state of an option.
6521 *
6522 * @param {OO.ui.OptionWidget|null} item Pressed item
6523 */
6524
6525 /**
6526 * @event select
6527 *
6528 * A `select` event is emitted when the selection is modified programmatically with the #selectItem
6529 * method.
6530 *
6531 * @param {OO.ui.OptionWidget[]|OO.ui.OptionWidget|null} items Currently selected items
6532 */
6533
6534 /**
6535 * @event choose
6536 *
6537 * A `choose` event is emitted when an item is chosen with the #chooseItem method.
6538 *
6539 * @param {OO.ui.OptionWidget} item Chosen item
6540 * @param {boolean} selected Item is selected
6541 */
6542
6543 /**
6544 * @event add
6545 *
6546 * An `add` event is emitted when options are added to the select with the #addItems method.
6547 *
6548 * @param {OO.ui.OptionWidget[]} items Added items
6549 * @param {number} index Index of insertion point
6550 */
6551
6552 /**
6553 * @event remove
6554 *
6555 * A `remove` event is emitted when options are removed from the select with the #clearItems
6556 * or #removeItems methods.
6557 *
6558 * @param {OO.ui.OptionWidget[]} items Removed items
6559 */
6560
6561 /* Static methods */
6562
6563 /**
6564 * Normalize text for filter matching
6565 *
6566 * @param {string} text Text
6567 * @return {string} Normalized text
6568 */
6569 OO.ui.SelectWidget.static.normalizeForMatching = function ( text ) {
6570 // Replace trailing whitespace, normalize multiple spaces and make case insensitive
6571 var normalized = text.trim().replace( /\s+/, ' ' ).toLowerCase();
6572
6573 // Normalize Unicode
6574 // eslint-disable-next-line no-restricted-properties
6575 if ( normalized.normalize ) {
6576 // eslint-disable-next-line no-restricted-properties
6577 normalized = normalized.normalize();
6578 }
6579 return normalized;
6580 };
6581
6582 /* Methods */
6583
6584 /**
6585 * Handle focus events
6586 *
6587 * @private
6588 * @param {jQuery.Event} event
6589 */
6590 OO.ui.SelectWidget.prototype.onFocus = function ( event ) {
6591 var item;
6592 if ( event.target === this.$element[ 0 ] ) {
6593 // This widget was focussed, e.g. by the user tabbing to it.
6594 // The styles for focus state depend on one of the items being selected.
6595 if ( !this.findSelectedItem() ) {
6596 item = this.findFirstSelectableItem();
6597 }
6598 } else {
6599 if ( event.target.tabIndex === -1 ) {
6600 // One of the options got focussed (and the event bubbled up here).
6601 // They can't be tabbed to, but they can be activated using access keys.
6602 // OptionWidgets and focusable UI elements inside them have tabindex="-1" set.
6603 item = this.findTargetItem( event );
6604 } else {
6605 // There is something actually user-focusable in one of the labels of the options, and
6606 // the user focussed it (e.g. by tabbing to it). Do nothing (especially, don't change
6607 // the focus).
6608 return;
6609 }
6610 }
6611
6612 if ( item ) {
6613 if ( item.constructor.static.highlightable ) {
6614 this.highlightItem( item );
6615 } else {
6616 this.selectItem( item );
6617 }
6618 }
6619
6620 if ( event.target !== this.$element[ 0 ] ) {
6621 this.$focusOwner.trigger( 'focus' );
6622 }
6623 };
6624
6625 /**
6626 * Handle mouse down events.
6627 *
6628 * @private
6629 * @param {jQuery.Event} e Mouse down event
6630 * @return {undefined|boolean} False to prevent default if event is handled
6631 */
6632 OO.ui.SelectWidget.prototype.onMouseDown = function ( e ) {
6633 var item;
6634
6635 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
6636 this.togglePressed( true );
6637 item = this.findTargetItem( e );
6638 if ( item && item.isSelectable() ) {
6639 this.pressItem( item );
6640 this.selecting = item;
6641 this.getElementDocument().addEventListener( 'mouseup', this.onDocumentMouseUpHandler, true );
6642 this.getElementDocument().addEventListener( 'mousemove', this.onDocumentMouseMoveHandler, true );
6643 }
6644 }
6645 return false;
6646 };
6647
6648 /**
6649 * Handle document mouse up events.
6650 *
6651 * @private
6652 * @param {MouseEvent} e Mouse up event
6653 * @return {undefined|boolean} False to prevent default if event is handled
6654 */
6655 OO.ui.SelectWidget.prototype.onDocumentMouseUp = function ( e ) {
6656 var item;
6657
6658 this.togglePressed( false );
6659 if ( !this.selecting ) {
6660 item = this.findTargetItem( e );
6661 if ( item && item.isSelectable() ) {
6662 this.selecting = item;
6663 }
6664 }
6665 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT && this.selecting ) {
6666 this.pressItem( null );
6667 this.chooseItem( this.selecting );
6668 this.selecting = null;
6669 }
6670
6671 this.getElementDocument().removeEventListener( 'mouseup', this.onDocumentMouseUpHandler, true );
6672 this.getElementDocument().removeEventListener( 'mousemove', this.onDocumentMouseMoveHandler, true );
6673
6674 return false;
6675 };
6676
6677 /**
6678 * Handle document mouse move events.
6679 *
6680 * @private
6681 * @param {MouseEvent} e Mouse move event
6682 */
6683 OO.ui.SelectWidget.prototype.onDocumentMouseMove = function ( e ) {
6684 var item;
6685
6686 if ( !this.isDisabled() && this.pressed ) {
6687 item = this.findTargetItem( e );
6688 if ( item && item !== this.selecting && item.isSelectable() ) {
6689 this.pressItem( item );
6690 this.selecting = item;
6691 }
6692 }
6693 };
6694
6695 /**
6696 * Handle mouse over events.
6697 *
6698 * @private
6699 * @param {jQuery.Event} e Mouse over event
6700 * @return {undefined|boolean} False to prevent default if event is handled
6701 */
6702 OO.ui.SelectWidget.prototype.onMouseOver = function ( e ) {
6703 var item;
6704 if ( this.blockMouseOverEvents ) {
6705 return;
6706 }
6707 if ( !this.isDisabled() ) {
6708 item = this.findTargetItem( e );
6709 this.highlightItem( item && item.isHighlightable() ? item : null );
6710 }
6711 return false;
6712 };
6713
6714 /**
6715 * Handle mouse leave events.
6716 *
6717 * @private
6718 * @param {jQuery.Event} e Mouse over event
6719 * @return {undefined|boolean} False to prevent default if event is handled
6720 */
6721 OO.ui.SelectWidget.prototype.onMouseLeave = function () {
6722 if ( !this.isDisabled() ) {
6723 this.highlightItem( null );
6724 }
6725 return false;
6726 };
6727
6728 /**
6729 * Handle document key down events.
6730 *
6731 * @protected
6732 * @param {KeyboardEvent} e Key down event
6733 */
6734 OO.ui.SelectWidget.prototype.onDocumentKeyDown = function ( e ) {
6735 var nextItem,
6736 handled = false,
6737 currentItem = this.findHighlightedItem(),
6738 firstItem = this.getItems()[ 0 ];
6739
6740 if ( !this.isDisabled() && this.isVisible() ) {
6741 switch ( e.keyCode ) {
6742 case OO.ui.Keys.ENTER:
6743 if ( currentItem ) {
6744 // Was only highlighted, now let's select it. No-op if already selected.
6745 this.chooseItem( currentItem );
6746 handled = true;
6747 }
6748 break;
6749 case OO.ui.Keys.UP:
6750 case OO.ui.Keys.LEFT:
6751 this.clearKeyPressBuffer();
6752 nextItem = currentItem ?
6753 this.findRelativeSelectableItem( currentItem, -1 ) : firstItem;
6754 handled = true;
6755 break;
6756 case OO.ui.Keys.DOWN:
6757 case OO.ui.Keys.RIGHT:
6758 this.clearKeyPressBuffer();
6759 nextItem = currentItem ?
6760 this.findRelativeSelectableItem( currentItem, 1 ) : firstItem;
6761 handled = true;
6762 break;
6763 case OO.ui.Keys.ESCAPE:
6764 case OO.ui.Keys.TAB:
6765 if ( currentItem ) {
6766 currentItem.setHighlighted( false );
6767 }
6768 this.unbindDocumentKeyDownListener();
6769 this.unbindDocumentKeyPressListener();
6770 // Don't prevent tabbing away / defocusing
6771 handled = false;
6772 break;
6773 }
6774
6775 if ( nextItem ) {
6776 if ( nextItem.constructor.static.highlightable ) {
6777 this.highlightItem( nextItem );
6778 } else {
6779 this.chooseItem( nextItem );
6780 }
6781 this.scrollItemIntoView( nextItem );
6782 }
6783
6784 if ( handled ) {
6785 e.preventDefault();
6786 e.stopPropagation();
6787 }
6788 }
6789 };
6790
6791 /**
6792 * Bind document key down listener.
6793 *
6794 * @protected
6795 */
6796 OO.ui.SelectWidget.prototype.bindDocumentKeyDownListener = function () {
6797 this.getElementDocument().addEventListener( 'keydown', this.onDocumentKeyDownHandler, true );
6798 };
6799
6800 /**
6801 * Unbind document key down listener.
6802 *
6803 * @protected
6804 */
6805 OO.ui.SelectWidget.prototype.unbindDocumentKeyDownListener = function () {
6806 this.getElementDocument().removeEventListener( 'keydown', this.onDocumentKeyDownHandler, true );
6807 };
6808
6809 /**
6810 * Scroll item into view, preventing spurious mouse highlight actions from happening.
6811 *
6812 * @param {OO.ui.OptionWidget} item Item to scroll into view
6813 */
6814 OO.ui.SelectWidget.prototype.scrollItemIntoView = function ( item ) {
6815 var widget = this;
6816 // Chromium's Blink engine will generate spurious 'mouseover' events during programmatic
6817 // scrolling and around 100-150 ms after it is finished.
6818 this.blockMouseOverEvents++;
6819 item.scrollElementIntoView().done( function () {
6820 setTimeout( function () {
6821 widget.blockMouseOverEvents--;
6822 }, 200 );
6823 } );
6824 };
6825
6826 /**
6827 * Clear the key-press buffer
6828 *
6829 * @protected
6830 */
6831 OO.ui.SelectWidget.prototype.clearKeyPressBuffer = function () {
6832 if ( this.keyPressBufferTimer ) {
6833 clearTimeout( this.keyPressBufferTimer );
6834 this.keyPressBufferTimer = null;
6835 }
6836 this.keyPressBuffer = '';
6837 };
6838
6839 /**
6840 * Handle key press events.
6841 *
6842 * @protected
6843 * @param {KeyboardEvent} e Key press event
6844 * @return {undefined|boolean} False to prevent default if event is handled
6845 */
6846 OO.ui.SelectWidget.prototype.onDocumentKeyPress = function ( e ) {
6847 var c, filter, item;
6848
6849 if ( !e.charCode ) {
6850 if ( e.keyCode === OO.ui.Keys.BACKSPACE && this.keyPressBuffer !== '' ) {
6851 this.keyPressBuffer = this.keyPressBuffer.substr( 0, this.keyPressBuffer.length - 1 );
6852 return false;
6853 }
6854 return;
6855 }
6856 // eslint-disable-next-line no-restricted-properties
6857 if ( String.fromCodePoint ) {
6858 // eslint-disable-next-line no-restricted-properties
6859 c = String.fromCodePoint( e.charCode );
6860 } else {
6861 c = String.fromCharCode( e.charCode );
6862 }
6863
6864 if ( this.keyPressBufferTimer ) {
6865 clearTimeout( this.keyPressBufferTimer );
6866 }
6867 this.keyPressBufferTimer = setTimeout( this.clearKeyPressBuffer.bind( this ), 1500 );
6868
6869 item = this.findHighlightedItem() || this.findSelectedItem();
6870
6871 if ( this.keyPressBuffer === c ) {
6872 // Common (if weird) special case: typing "xxxx" will cycle through all
6873 // the items beginning with "x".
6874 if ( item ) {
6875 item = this.findRelativeSelectableItem( item, 1 );
6876 }
6877 } else {
6878 this.keyPressBuffer += c;
6879 }
6880
6881 filter = this.getItemMatcher( this.keyPressBuffer, false );
6882 if ( !item || !filter( item ) ) {
6883 item = this.findRelativeSelectableItem( item, 1, filter );
6884 }
6885 if ( item ) {
6886 if ( this.isVisible() && item.constructor.static.highlightable ) {
6887 this.highlightItem( item );
6888 } else {
6889 this.chooseItem( item );
6890 }
6891 this.scrollItemIntoView( item );
6892 }
6893
6894 e.preventDefault();
6895 e.stopPropagation();
6896 };
6897
6898 /**
6899 * Get a matcher for the specific string
6900 *
6901 * @protected
6902 * @param {string} query String to match against items
6903 * @param {string} [mode='prefix'] Matching mode: 'substring', 'prefix', or 'exact'
6904 * @return {Function} function ( OO.ui.OptionWidget ) => boolean
6905 */
6906 OO.ui.SelectWidget.prototype.getItemMatcher = function ( query, mode ) {
6907 var normalizeForMatching = this.constructor.static.normalizeForMatching,
6908 normalizedQuery = normalizeForMatching( query );
6909
6910 // Support deprecated exact=true argument
6911 if ( mode === true ) {
6912 mode = 'exact';
6913 }
6914
6915 return function ( item ) {
6916 var matchText = normalizeForMatching( item.getMatchText() );
6917
6918 if ( normalizedQuery === '' ) {
6919 // Empty string matches all, except if we are in 'exact'
6920 // mode, where it doesn't match at all
6921 return mode !== 'exact';
6922 }
6923
6924 switch ( mode ) {
6925 case 'exact':
6926 return matchText === normalizedQuery;
6927 case 'substring':
6928 return matchText.indexOf( normalizedQuery ) !== -1;
6929 // 'prefix'
6930 default:
6931 return matchText.indexOf( normalizedQuery ) === 0;
6932 }
6933 };
6934 };
6935
6936 /**
6937 * Bind document key press listener.
6938 *
6939 * @protected
6940 */
6941 OO.ui.SelectWidget.prototype.bindDocumentKeyPressListener = function () {
6942 this.getElementDocument().addEventListener( 'keypress', this.onDocumentKeyPressHandler, true );
6943 };
6944
6945 /**
6946 * Unbind document key down listener.
6947 *
6948 * If you override this, be sure to call this.clearKeyPressBuffer() from your
6949 * implementation.
6950 *
6951 * @protected
6952 */
6953 OO.ui.SelectWidget.prototype.unbindDocumentKeyPressListener = function () {
6954 this.getElementDocument().removeEventListener( 'keypress', this.onDocumentKeyPressHandler, true );
6955 this.clearKeyPressBuffer();
6956 };
6957
6958 /**
6959 * Visibility change handler
6960 *
6961 * @protected
6962 * @param {boolean} visible
6963 */
6964 OO.ui.SelectWidget.prototype.onToggle = function ( visible ) {
6965 if ( !visible ) {
6966 this.clearKeyPressBuffer();
6967 }
6968 };
6969
6970 /**
6971 * Get the closest item to a jQuery.Event.
6972 *
6973 * @private
6974 * @param {jQuery.Event} e
6975 * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
6976 */
6977 OO.ui.SelectWidget.prototype.findTargetItem = function ( e ) {
6978 var $option = $( e.target ).closest( '.oo-ui-optionWidget' );
6979 if ( !$option.closest( '.oo-ui-selectWidget' ).is( this.$element ) ) {
6980 return null;
6981 }
6982 return $option.data( 'oo-ui-optionWidget' ) || null;
6983 };
6984
6985 /**
6986 * Find all selected items, if there are any. If the widget allows for multiselect
6987 * it will return an array of selected options. If the widget doesn't allow for
6988 * multiselect, it will return the selected option or null if no item is selected.
6989 *
6990 * @return {OO.ui.OptionWidget[]|OO.ui.OptionWidget|null} If the widget is multiselect
6991 * then return an array of selected items (or empty array),
6992 * if the widget is not multiselect, return a single selected item, or `null`
6993 * if no item is selected
6994 */
6995 OO.ui.SelectWidget.prototype.findSelectedItems = function () {
6996 var selected = this.items.filter( function ( item ) {
6997 return item.isSelected();
6998 } );
6999
7000 return this.multiselect ?
7001 selected :
7002 selected[ 0 ] || null;
7003 };
7004
7005 /**
7006 * Find selected item.
7007 *
7008 * @return {OO.ui.OptionWidget[]|OO.ui.OptionWidget|null} If the widget is multiselect
7009 * then return an array of selected items (or empty array),
7010 * if the widget is not multiselect, return a single selected item, or `null`
7011 * if no item is selected
7012 */
7013 OO.ui.SelectWidget.prototype.findSelectedItem = function () {
7014 return this.findSelectedItems();
7015 };
7016
7017 /**
7018 * Find highlighted item.
7019 *
7020 * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
7021 */
7022 OO.ui.SelectWidget.prototype.findHighlightedItem = function () {
7023 var i, len;
7024
7025 for ( i = 0, len = this.items.length; i < len; i++ ) {
7026 if ( this.items[ i ].isHighlighted() ) {
7027 return this.items[ i ];
7028 }
7029 }
7030 return null;
7031 };
7032
7033 /**
7034 * Toggle pressed state.
7035 *
7036 * Press is a state that occurs when a user mouses down on an item, but
7037 * has not yet let go of the mouse. The item may appear selected, but it will not be selected
7038 * until the user releases the mouse.
7039 *
7040 * @param {boolean} pressed An option is being pressed
7041 */
7042 OO.ui.SelectWidget.prototype.togglePressed = function ( pressed ) {
7043 if ( pressed === undefined ) {
7044 pressed = !this.pressed;
7045 }
7046 if ( pressed !== this.pressed ) {
7047 this.$element
7048 .toggleClass( 'oo-ui-selectWidget-pressed', pressed )
7049 // -depressed is a deprecated alias of -unpressed
7050 .toggleClass( 'oo-ui-selectWidget-unpressed oo-ui-selectWidget-depressed', !pressed );
7051 this.pressed = pressed;
7052 }
7053 };
7054
7055 /**
7056 * Highlight an option. If the `item` param is omitted, no options will be highlighted
7057 * and any existing highlight will be removed. The highlight is mutually exclusive.
7058 *
7059 * @param {OO.ui.OptionWidget} [item] Item to highlight, omit for no highlight
7060 * @fires highlight
7061 * @chainable
7062 * @return {OO.ui.Widget} The widget, for chaining
7063 */
7064 OO.ui.SelectWidget.prototype.highlightItem = function ( item ) {
7065 var i, len, highlighted,
7066 changed = false;
7067
7068 for ( i = 0, len = this.items.length; i < len; i++ ) {
7069 highlighted = this.items[ i ] === item;
7070 if ( this.items[ i ].isHighlighted() !== highlighted ) {
7071 this.items[ i ].setHighlighted( highlighted );
7072 changed = true;
7073 }
7074 }
7075 if ( changed ) {
7076 if ( item ) {
7077 this.$focusOwner.attr( 'aria-activedescendant', item.getElementId() );
7078 } else {
7079 this.$focusOwner.removeAttr( 'aria-activedescendant' );
7080 }
7081 this.emit( 'highlight', item );
7082 }
7083
7084 return this;
7085 };
7086
7087 /**
7088 * Fetch an item by its label.
7089 *
7090 * @param {string} label Label of the item to select.
7091 * @param {boolean} [prefix=false] Allow a prefix match, if only a single item matches
7092 * @return {OO.ui.Element|null} Item with equivalent label, `null` if none exists
7093 */
7094 OO.ui.SelectWidget.prototype.getItemFromLabel = function ( label, prefix ) {
7095 var i, item, found,
7096 len = this.items.length,
7097 filter = this.getItemMatcher( label, 'exact' );
7098
7099 for ( i = 0; i < len; i++ ) {
7100 item = this.items[ i ];
7101 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() && filter( item ) ) {
7102 return item;
7103 }
7104 }
7105
7106 if ( prefix ) {
7107 found = null;
7108 filter = this.getItemMatcher( label, 'prefix' );
7109 for ( i = 0; i < len; i++ ) {
7110 item = this.items[ i ];
7111 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() && filter( item ) ) {
7112 if ( found ) {
7113 return null;
7114 }
7115 found = item;
7116 }
7117 }
7118 if ( found ) {
7119 return found;
7120 }
7121 }
7122
7123 return null;
7124 };
7125
7126 /**
7127 * Programmatically select an option by its label. If the item does not exist,
7128 * all options will be deselected.
7129 *
7130 * @param {string} [label] Label of the item to select.
7131 * @param {boolean} [prefix=false] Allow a prefix match, if only a single item matches
7132 * @fires select
7133 * @chainable
7134 * @return {OO.ui.Widget} The widget, for chaining
7135 */
7136 OO.ui.SelectWidget.prototype.selectItemByLabel = function ( label, prefix ) {
7137 var itemFromLabel = this.getItemFromLabel( label, !!prefix );
7138 if ( label === undefined || !itemFromLabel ) {
7139 return this.selectItem();
7140 }
7141 return this.selectItem( itemFromLabel );
7142 };
7143
7144 /**
7145 * Programmatically select an option by its data. If the `data` parameter is omitted,
7146 * or if the item does not exist, all options will be deselected.
7147 *
7148 * @param {Object|string} [data] Value of the item to select, omit to deselect all
7149 * @fires select
7150 * @chainable
7151 * @return {OO.ui.Widget} The widget, for chaining
7152 */
7153 OO.ui.SelectWidget.prototype.selectItemByData = function ( data ) {
7154 var itemFromData = this.findItemFromData( data );
7155 if ( data === undefined || !itemFromData ) {
7156 return this.selectItem();
7157 }
7158 return this.selectItem( itemFromData );
7159 };
7160
7161 /**
7162 * Programmatically unselect an option by its reference. If the widget
7163 * allows for multiple selections, there may be other items still selected;
7164 * otherwise, no items will be selected.
7165 * If no item is given, all selected items will be unselected.
7166 *
7167 * @param {OO.ui.OptionWidget} [item] Item to unselect
7168 * @fires select
7169 * @chainable
7170 * @return {OO.ui.Widget} The widget, for chaining
7171 */
7172 OO.ui.SelectWidget.prototype.unselectItem = function ( item ) {
7173 if ( item ) {
7174 item.setSelected( false );
7175 } else {
7176 this.items.forEach( function ( item ) {
7177 item.setSelected( false );
7178 } );
7179 }
7180
7181 this.emit( 'select', this.findSelectedItems() );
7182 return this;
7183 };
7184
7185 /**
7186 * Programmatically select an option by its reference. If the `item` parameter is omitted,
7187 * all options will be deselected.
7188 *
7189 * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
7190 * @fires select
7191 * @chainable
7192 * @return {OO.ui.Widget} The widget, for chaining
7193 */
7194 OO.ui.SelectWidget.prototype.selectItem = function ( item ) {
7195 var i, len, selected,
7196 changed = false;
7197
7198 if ( this.multiselect && item ) {
7199 // Select the item directly
7200 item.setSelected( true );
7201 } else {
7202 for ( i = 0, len = this.items.length; i < len; i++ ) {
7203 selected = this.items[ i ] === item;
7204 if ( this.items[ i ].isSelected() !== selected ) {
7205 this.items[ i ].setSelected( selected );
7206 changed = true;
7207 }
7208 }
7209 }
7210 if ( changed ) {
7211 // TODO: When should a non-highlightable element be selected?
7212 if ( item && !item.constructor.static.highlightable ) {
7213 if ( item ) {
7214 this.$focusOwner.attr( 'aria-activedescendant', item.getElementId() );
7215 } else {
7216 this.$focusOwner.removeAttr( 'aria-activedescendant' );
7217 }
7218 }
7219 this.emit( 'select', this.findSelectedItems() );
7220 }
7221
7222 return this;
7223 };
7224
7225 /**
7226 * Press an item.
7227 *
7228 * Press is a state that occurs when a user mouses down on an item, but has not
7229 * yet let go of the mouse. The item may appear selected, but it will not be selected until the user
7230 * releases the mouse.
7231 *
7232 * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
7233 * @fires press
7234 * @chainable
7235 * @return {OO.ui.Widget} The widget, for chaining
7236 */
7237 OO.ui.SelectWidget.prototype.pressItem = function ( item ) {
7238 var i, len, pressed,
7239 changed = false;
7240
7241 for ( i = 0, len = this.items.length; i < len; i++ ) {
7242 pressed = this.items[ i ] === item;
7243 if ( this.items[ i ].isPressed() !== pressed ) {
7244 this.items[ i ].setPressed( pressed );
7245 changed = true;
7246 }
7247 }
7248 if ( changed ) {
7249 this.emit( 'press', item );
7250 }
7251
7252 return this;
7253 };
7254
7255 /**
7256 * Choose an item.
7257 *
7258 * Note that ‘choose’ should never be modified programmatically. A user can choose
7259 * an option with the keyboard or mouse and it becomes selected. To select an item programmatically,
7260 * use the #selectItem method.
7261 *
7262 * This method is identical to #selectItem, but may vary in subclasses that take additional action
7263 * when users choose an item with the keyboard or mouse.
7264 *
7265 * @param {OO.ui.OptionWidget} item Item to choose
7266 * @fires choose
7267 * @chainable
7268 * @return {OO.ui.Widget} The widget, for chaining
7269 */
7270 OO.ui.SelectWidget.prototype.chooseItem = function ( item ) {
7271 if ( item ) {
7272 if ( this.multiselect && item.isSelected() ) {
7273 this.unselectItem( item );
7274 } else {
7275 this.selectItem( item );
7276 }
7277
7278 this.emit( 'choose', item, item.isSelected() );
7279 }
7280
7281 return this;
7282 };
7283
7284 /**
7285 * Find an option by its position relative to the specified item (or to the start of the option
7286 * array, if item is `null`). The direction in which to search through the option array is specified
7287 * with a number: -1 for reverse (the default) or 1 for forward. The method will return an option,
7288 * or `null` if there are no options in the array.
7289 *
7290 * @param {OO.ui.OptionWidget|null} item Item to describe the start position, or `null` to start at
7291 * the beginning of the array.
7292 * @param {number} direction Direction to move in: -1 to move backward, 1 to move forward
7293 * @param {Function} [filter] Only consider items for which this function returns
7294 * true. Function takes an OO.ui.OptionWidget and returns a boolean.
7295 * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the select
7296 */
7297 OO.ui.SelectWidget.prototype.findRelativeSelectableItem = function ( item, direction, filter ) {
7298 var currentIndex, nextIndex, i,
7299 increase = direction > 0 ? 1 : -1,
7300 len = this.items.length;
7301
7302 if ( item instanceof OO.ui.OptionWidget ) {
7303 currentIndex = this.items.indexOf( item );
7304 nextIndex = ( currentIndex + increase + len ) % len;
7305 } else {
7306 // If no item is selected and moving forward, start at the beginning.
7307 // If moving backward, start at the end.
7308 nextIndex = direction > 0 ? 0 : len - 1;
7309 }
7310
7311 for ( i = 0; i < len; i++ ) {
7312 item = this.items[ nextIndex ];
7313 if (
7314 item instanceof OO.ui.OptionWidget && item.isSelectable() &&
7315 ( !filter || filter( item ) )
7316 ) {
7317 return item;
7318 }
7319 nextIndex = ( nextIndex + increase + len ) % len;
7320 }
7321 return null;
7322 };
7323
7324 /**
7325 * Find the next selectable item or `null` if there are no selectable items.
7326 * Disabled options and menu-section markers and breaks are not selectable.
7327 *
7328 * @return {OO.ui.OptionWidget|null} Item, `null` if there aren't any selectable items
7329 */
7330 OO.ui.SelectWidget.prototype.findFirstSelectableItem = function () {
7331 return this.findRelativeSelectableItem( null, 1 );
7332 };
7333
7334 /**
7335 * Add an array of options to the select. Optionally, an index number can be used to
7336 * specify an insertion point.
7337 *
7338 * @param {OO.ui.OptionWidget[]} items Items to add
7339 * @param {number} [index] Index to insert items after
7340 * @fires add
7341 * @chainable
7342 * @return {OO.ui.Widget} The widget, for chaining
7343 */
7344 OO.ui.SelectWidget.prototype.addItems = function ( items, index ) {
7345 // Mixin method
7346 OO.ui.mixin.GroupWidget.prototype.addItems.call( this, items, index );
7347
7348 // Always provide an index, even if it was omitted
7349 this.emit( 'add', items, index === undefined ? this.items.length - items.length - 1 : index );
7350
7351 return this;
7352 };
7353
7354 /**
7355 * Remove the specified array of options from the select. Options will be detached
7356 * from the DOM, not removed, so they can be reused later. To remove all options from
7357 * the select, you may wish to use the #clearItems method instead.
7358 *
7359 * @param {OO.ui.OptionWidget[]} items Items to remove
7360 * @fires remove
7361 * @chainable
7362 * @return {OO.ui.Widget} The widget, for chaining
7363 */
7364 OO.ui.SelectWidget.prototype.removeItems = function ( items ) {
7365 var i, len, item;
7366
7367 // Deselect items being removed
7368 for ( i = 0, len = items.length; i < len; i++ ) {
7369 item = items[ i ];
7370 if ( item.isSelected() ) {
7371 this.selectItem( null );
7372 }
7373 }
7374
7375 // Mixin method
7376 OO.ui.mixin.GroupWidget.prototype.removeItems.call( this, items );
7377
7378 this.emit( 'remove', items );
7379
7380 return this;
7381 };
7382
7383 /**
7384 * Clear all options from the select. Options will be detached from the DOM, not removed,
7385 * so that they can be reused later. To remove a subset of options from the select, use
7386 * the #removeItems method.
7387 *
7388 * @fires remove
7389 * @chainable
7390 * @return {OO.ui.Widget} The widget, for chaining
7391 */
7392 OO.ui.SelectWidget.prototype.clearItems = function () {
7393 var items = this.items.slice();
7394
7395 // Mixin method
7396 OO.ui.mixin.GroupWidget.prototype.clearItems.call( this );
7397
7398 // Clear selection
7399 this.selectItem( null );
7400
7401 this.emit( 'remove', items );
7402
7403 return this;
7404 };
7405
7406 /**
7407 * Set the DOM element which has focus while the user is interacting with this SelectWidget.
7408 *
7409 * This is used to set `aria-activedescendant` and `aria-expanded` on it.
7410 *
7411 * @protected
7412 * @param {jQuery} $focusOwner
7413 */
7414 OO.ui.SelectWidget.prototype.setFocusOwner = function ( $focusOwner ) {
7415 this.$focusOwner = $focusOwner;
7416 };
7417
7418 /**
7419 * DecoratedOptionWidgets are {@link OO.ui.OptionWidget options} that can be configured
7420 * with an {@link OO.ui.mixin.IconElement icon} and/or
7421 * {@link OO.ui.mixin.IndicatorElement indicator}.
7422 * This class is used with OO.ui.SelectWidget to create a selection of mutually exclusive
7423 * options. For more information about options and selects, please see the
7424 * [OOUI documentation on MediaWiki][1].
7425 *
7426 * @example
7427 * // Decorated options in a select widget.
7428 * var select = new OO.ui.SelectWidget( {
7429 * items: [
7430 * new OO.ui.DecoratedOptionWidget( {
7431 * data: 'a',
7432 * label: 'Option with icon',
7433 * icon: 'help'
7434 * } ),
7435 * new OO.ui.DecoratedOptionWidget( {
7436 * data: 'b',
7437 * label: 'Option with indicator',
7438 * indicator: 'next'
7439 * } )
7440 * ]
7441 * } );
7442 * $( document.body ).append( select.$element );
7443 *
7444 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
7445 *
7446 * @class
7447 * @extends OO.ui.OptionWidget
7448 * @mixins OO.ui.mixin.IconElement
7449 * @mixins OO.ui.mixin.IndicatorElement
7450 *
7451 * @constructor
7452 * @param {Object} [config] Configuration options
7453 */
7454 OO.ui.DecoratedOptionWidget = function OoUiDecoratedOptionWidget( config ) {
7455 // Parent constructor
7456 OO.ui.DecoratedOptionWidget.parent.call( this, config );
7457
7458 // Mixin constructors
7459 OO.ui.mixin.IconElement.call( this, config );
7460 OO.ui.mixin.IndicatorElement.call( this, config );
7461
7462 // Initialization
7463 this.$element
7464 .addClass( 'oo-ui-decoratedOptionWidget' )
7465 .prepend( this.$icon )
7466 .append( this.$indicator );
7467 };
7468
7469 /* Setup */
7470
7471 OO.inheritClass( OO.ui.DecoratedOptionWidget, OO.ui.OptionWidget );
7472 OO.mixinClass( OO.ui.DecoratedOptionWidget, OO.ui.mixin.IconElement );
7473 OO.mixinClass( OO.ui.DecoratedOptionWidget, OO.ui.mixin.IndicatorElement );
7474
7475 /**
7476 * MenuOptionWidget is an option widget that looks like a menu item. The class is used with
7477 * OO.ui.MenuSelectWidget to create a menu of mutually exclusive options. Please see
7478 * the [OOUI documentation on MediaWiki] [1] for more information.
7479 *
7480 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Menu_selects_and_options
7481 *
7482 * @class
7483 * @extends OO.ui.DecoratedOptionWidget
7484 *
7485 * @constructor
7486 * @param {Object} [config] Configuration options
7487 */
7488 OO.ui.MenuOptionWidget = function OoUiMenuOptionWidget( config ) {
7489 // Parent constructor
7490 OO.ui.MenuOptionWidget.parent.call( this, config );
7491
7492 // Properties
7493 this.checkIcon = new OO.ui.IconWidget( {
7494 icon: 'check',
7495 classes: [ 'oo-ui-menuOptionWidget-checkIcon' ]
7496 } );
7497
7498 // Initialization
7499 this.$element
7500 .prepend( this.checkIcon.$element )
7501 .addClass( 'oo-ui-menuOptionWidget' );
7502 };
7503
7504 /* Setup */
7505
7506 OO.inheritClass( OO.ui.MenuOptionWidget, OO.ui.DecoratedOptionWidget );
7507
7508 /* Static Properties */
7509
7510 /**
7511 * @static
7512 * @inheritdoc
7513 */
7514 OO.ui.MenuOptionWidget.static.scrollIntoViewOnSelect = true;
7515
7516 /**
7517 * MenuSectionOptionWidgets are used inside {@link OO.ui.MenuSelectWidget menu select widgets} to
7518 * group one or more related {@link OO.ui.MenuOptionWidget menu options}. MenuSectionOptionWidgets
7519 * cannot be highlighted or selected.
7520 *
7521 * @example
7522 * var dropdown = new OO.ui.DropdownWidget( {
7523 * menu: {
7524 * items: [
7525 * new OO.ui.MenuSectionOptionWidget( {
7526 * label: 'Dogs'
7527 * } ),
7528 * new OO.ui.MenuOptionWidget( {
7529 * data: 'corgi',
7530 * label: 'Welsh Corgi'
7531 * } ),
7532 * new OO.ui.MenuOptionWidget( {
7533 * data: 'poodle',
7534 * label: 'Standard Poodle'
7535 * } ),
7536 * new OO.ui.MenuSectionOptionWidget( {
7537 * label: 'Cats'
7538 * } ),
7539 * new OO.ui.MenuOptionWidget( {
7540 * data: 'lion',
7541 * label: 'Lion'
7542 * } )
7543 * ]
7544 * }
7545 * } );
7546 * $( document.body ).append( dropdown.$element );
7547 *
7548 * @class
7549 * @extends OO.ui.DecoratedOptionWidget
7550 *
7551 * @constructor
7552 * @param {Object} [config] Configuration options
7553 */
7554 OO.ui.MenuSectionOptionWidget = function OoUiMenuSectionOptionWidget( config ) {
7555 // Parent constructor
7556 OO.ui.MenuSectionOptionWidget.parent.call( this, config );
7557
7558 // Initialization
7559 this.$element
7560 .addClass( 'oo-ui-menuSectionOptionWidget' )
7561 .removeAttr( 'role aria-selected' );
7562 this.selected = false;
7563 };
7564
7565 /* Setup */
7566
7567 OO.inheritClass( OO.ui.MenuSectionOptionWidget, OO.ui.DecoratedOptionWidget );
7568
7569 /* Static Properties */
7570
7571 /**
7572 * @static
7573 * @inheritdoc
7574 */
7575 OO.ui.MenuSectionOptionWidget.static.selectable = false;
7576
7577 /**
7578 * @static
7579 * @inheritdoc
7580 */
7581 OO.ui.MenuSectionOptionWidget.static.highlightable = false;
7582
7583 /**
7584 * MenuSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains options and
7585 * is used together with OO.ui.MenuOptionWidget. It is designed be used as part of another widget.
7586 * See {@link OO.ui.DropdownWidget DropdownWidget},
7587 * {@link OO.ui.ComboBoxInputWidget ComboBoxInputWidget}, and
7588 * {@link OO.ui.mixin.LookupElement LookupElement} for examples of widgets that contain menus.
7589 * MenuSelectWidgets themselves are not instantiated directly, rather subclassed
7590 * and customized to be opened, closed, and displayed as needed.
7591 *
7592 * By default, menus are clipped to the visible viewport and are not visible when a user presses the
7593 * mouse outside the menu.
7594 *
7595 * Menus also have support for keyboard interaction:
7596 *
7597 * - Enter/Return key: choose and select a menu option
7598 * - Up-arrow key: highlight the previous menu option
7599 * - Down-arrow key: highlight the next menu option
7600 * - Escape key: hide the menu
7601 *
7602 * Unlike most widgets, MenuSelectWidget is initially hidden and must be shown by calling #toggle.
7603 *
7604 * Please see the [OOUI documentation on MediaWiki][1] for more information.
7605 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
7606 *
7607 * @class
7608 * @extends OO.ui.SelectWidget
7609 * @mixins OO.ui.mixin.ClippableElement
7610 * @mixins OO.ui.mixin.FloatableElement
7611 *
7612 * @constructor
7613 * @param {Object} [config] Configuration options
7614 * @cfg {OO.ui.TextInputWidget} [input] Text input used to implement option highlighting for menu
7615 * items that match the text the user types. This config is used by
7616 * {@link OO.ui.ComboBoxInputWidget ComboBoxInputWidget} and
7617 * {@link OO.ui.mixin.LookupElement LookupElement}
7618 * @cfg {jQuery} [$input] Text input used to implement option highlighting for menu items that match
7619 * the text the user types. This config is used by
7620 * {@link OO.ui.TagMultiselectWidget TagMultiselectWidget}
7621 * @cfg {OO.ui.Widget} [widget] Widget associated with the menu's active state. If the user clicks
7622 * the mouse anywhere on the page outside of this widget, the menu is hidden. For example, if
7623 * there is a button that toggles the menu's visibility on click, the menu will be hidden then
7624 * re-shown when the user clicks that button, unless the button (or its parent widget) is passed
7625 * in here.
7626 * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu.
7627 * @cfg {jQuery} [$autoCloseIgnore] If these elements are clicked, don't auto-hide the menu.
7628 * @cfg {boolean} [hideOnChoose=true] Hide the menu when the user chooses an option.
7629 * @cfg {boolean} [filterFromInput=false] Filter the displayed options from the input
7630 * @cfg {boolean} [highlightOnFilter] Highlight the first result when filtering
7631 * @cfg {string} [filterMode='prefix'] The mode by which the menu filters the results.
7632 * Options are 'exact', 'prefix' or 'substring'. See `OO.ui.SelectWidget#getItemMatcher`
7633 * @param {number|string} [width] Width of the menu as a number of pixels or CSS string with unit
7634 * suffix, used by {@link OO.ui.mixin.ClippableElement ClippableElement}
7635 */
7636 OO.ui.MenuSelectWidget = function OoUiMenuSelectWidget( config ) {
7637 // Configuration initialization
7638 config = config || {};
7639
7640 // Parent constructor
7641 OO.ui.MenuSelectWidget.parent.call( this, config );
7642
7643 // Mixin constructors
7644 OO.ui.mixin.ClippableElement.call( this, $.extend( { $clippable: this.$group }, config ) );
7645 OO.ui.mixin.FloatableElement.call( this, config );
7646
7647 // Initial vertical positions other than 'center' will result in
7648 // the menu being flipped if there is not enough space in the container.
7649 // Store the original position so we know what to reset to.
7650 this.originalVerticalPosition = this.verticalPosition;
7651
7652 // Properties
7653 this.autoHide = config.autoHide === undefined || !!config.autoHide;
7654 this.hideOnChoose = config.hideOnChoose === undefined || !!config.hideOnChoose;
7655 this.filterFromInput = !!config.filterFromInput;
7656 this.$input = config.$input ? config.$input : config.input ? config.input.$input : null;
7657 this.$widget = config.widget ? config.widget.$element : null;
7658 this.$autoCloseIgnore = config.$autoCloseIgnore || $( [] );
7659 this.onDocumentMouseDownHandler = this.onDocumentMouseDown.bind( this );
7660 this.onInputEditHandler = OO.ui.debounce( this.updateItemVisibility.bind( this ), 100 );
7661 this.highlightOnFilter = !!config.highlightOnFilter;
7662 this.lastHighlightedItem = null;
7663 this.width = config.width;
7664 this.filterMode = config.filterMode;
7665
7666 // Initialization
7667 this.$element.addClass( 'oo-ui-menuSelectWidget' );
7668 if ( config.widget ) {
7669 this.setFocusOwner( config.widget.$tabIndexed );
7670 }
7671
7672 // Initially hidden - using #toggle may cause errors if subclasses override toggle with methods
7673 // that reference properties not initialized at that time of parent class construction
7674 // TODO: Find a better way to handle post-constructor setup
7675 this.visible = false;
7676 this.$element.addClass( 'oo-ui-element-hidden' );
7677 this.$focusOwner.attr( 'aria-expanded', 'false' );
7678 };
7679
7680 /* Setup */
7681
7682 OO.inheritClass( OO.ui.MenuSelectWidget, OO.ui.SelectWidget );
7683 OO.mixinClass( OO.ui.MenuSelectWidget, OO.ui.mixin.ClippableElement );
7684 OO.mixinClass( OO.ui.MenuSelectWidget, OO.ui.mixin.FloatableElement );
7685
7686 /* Events */
7687
7688 /**
7689 * @event ready
7690 *
7691 * The menu is ready: it is visible and has been positioned and clipped.
7692 */
7693
7694 /* Static properties */
7695
7696 /**
7697 * Positions to flip to if there isn't room in the container for the
7698 * menu in a specific direction.
7699 *
7700 * @property {Object.<string,string>}
7701 */
7702 OO.ui.MenuSelectWidget.static.flippedPositions = {
7703 below: 'above',
7704 above: 'below',
7705 top: 'bottom',
7706 bottom: 'top'
7707 };
7708
7709 /* Methods */
7710
7711 /**
7712 * Handles document mouse down events.
7713 *
7714 * @protected
7715 * @param {MouseEvent} e Mouse down event
7716 */
7717 OO.ui.MenuSelectWidget.prototype.onDocumentMouseDown = function ( e ) {
7718 if (
7719 this.isVisible() &&
7720 !OO.ui.contains(
7721 this.$element.add( this.$widget ).add( this.$autoCloseIgnore ).get(),
7722 e.target,
7723 true
7724 )
7725 ) {
7726 this.toggle( false );
7727 }
7728 };
7729
7730 /**
7731 * @inheritdoc
7732 */
7733 OO.ui.MenuSelectWidget.prototype.onDocumentKeyDown = function ( e ) {
7734 var currentItem = this.findHighlightedItem() || this.findSelectedItem();
7735
7736 if ( !this.isDisabled() && this.isVisible() ) {
7737 switch ( e.keyCode ) {
7738 case OO.ui.Keys.LEFT:
7739 case OO.ui.Keys.RIGHT:
7740 // Do nothing if a text field is associated, arrow keys will be handled natively
7741 if ( !this.$input ) {
7742 OO.ui.MenuSelectWidget.parent.prototype.onDocumentKeyDown.call( this, e );
7743 }
7744 break;
7745 case OO.ui.Keys.ESCAPE:
7746 case OO.ui.Keys.TAB:
7747 if ( currentItem && !this.multiselect ) {
7748 currentItem.setHighlighted( false );
7749 }
7750 this.toggle( false );
7751 // Don't prevent tabbing away, prevent defocusing
7752 if ( e.keyCode === OO.ui.Keys.ESCAPE ) {
7753 e.preventDefault();
7754 e.stopPropagation();
7755 }
7756 break;
7757 default:
7758 OO.ui.MenuSelectWidget.parent.prototype.onDocumentKeyDown.call( this, e );
7759 return;
7760 }
7761 }
7762 };
7763
7764 /**
7765 * Update menu item visibility and clipping after input changes (if filterFromInput is enabled)
7766 * or after items were added/removed (always).
7767 *
7768 * @protected
7769 */
7770 OO.ui.MenuSelectWidget.prototype.updateItemVisibility = function () {
7771 var i, item, items, visible, section, sectionEmpty, filter, exactFilter,
7772 anyVisible = false,
7773 len = this.items.length,
7774 showAll = !this.isVisible(),
7775 exactMatch = false;
7776
7777 if ( this.$input && this.filterFromInput ) {
7778 filter = showAll ? null : this.getItemMatcher( this.$input.val(), this.filterMode );
7779 exactFilter = this.getItemMatcher( this.$input.val(), 'exact' );
7780 // Hide non-matching options, and also hide section headers if all options
7781 // in their section are hidden.
7782 for ( i = 0; i < len; i++ ) {
7783 item = this.items[ i ];
7784 if ( item instanceof OO.ui.MenuSectionOptionWidget ) {
7785 if ( section ) {
7786 // If the previous section was empty, hide its header
7787 section.toggle( showAll || !sectionEmpty );
7788 }
7789 section = item;
7790 sectionEmpty = true;
7791 } else if ( item instanceof OO.ui.OptionWidget ) {
7792 visible = showAll || filter( item );
7793 exactMatch = exactMatch || exactFilter( item );
7794 anyVisible = anyVisible || visible;
7795 sectionEmpty = sectionEmpty && !visible;
7796 item.toggle( visible );
7797 }
7798 }
7799 // Process the final section
7800 if ( section ) {
7801 section.toggle( showAll || !sectionEmpty );
7802 }
7803
7804 if ( !anyVisible ) {
7805 this.highlightItem( null );
7806 }
7807
7808 this.$element.toggleClass( 'oo-ui-menuSelectWidget-invisible', !anyVisible );
7809
7810 if (
7811 this.highlightOnFilter &&
7812 !( this.lastHighlightedItem && this.lastHighlightedItem.isVisible() )
7813 ) {
7814 // Highlight the first item on the list
7815 item = null;
7816 items = this.getItems();
7817 for ( i = 0; i < items.length; i++ ) {
7818 if ( items[ i ].isVisible() ) {
7819 item = items[ i ];
7820 break;
7821 }
7822 }
7823 this.highlightItem( item );
7824 this.lastHighlightedItem = item;
7825 }
7826
7827 }
7828
7829 // Reevaluate clipping
7830 this.clip();
7831 };
7832
7833 /**
7834 * @inheritdoc
7835 */
7836 OO.ui.MenuSelectWidget.prototype.bindDocumentKeyDownListener = function () {
7837 if ( this.$input ) {
7838 this.$input.on( 'keydown', this.onDocumentKeyDownHandler );
7839 } else {
7840 OO.ui.MenuSelectWidget.parent.prototype.bindDocumentKeyDownListener.call( this );
7841 }
7842 };
7843
7844 /**
7845 * @inheritdoc
7846 */
7847 OO.ui.MenuSelectWidget.prototype.unbindDocumentKeyDownListener = function () {
7848 if ( this.$input ) {
7849 this.$input.off( 'keydown', this.onDocumentKeyDownHandler );
7850 } else {
7851 OO.ui.MenuSelectWidget.parent.prototype.unbindDocumentKeyDownListener.call( this );
7852 }
7853 };
7854
7855 /**
7856 * @inheritdoc
7857 */
7858 OO.ui.MenuSelectWidget.prototype.bindDocumentKeyPressListener = function () {
7859 if ( this.$input ) {
7860 if ( this.filterFromInput ) {
7861 this.$input.on(
7862 'keydown mouseup cut paste change input select',
7863 this.onInputEditHandler
7864 );
7865 this.updateItemVisibility();
7866 }
7867 } else {
7868 OO.ui.MenuSelectWidget.parent.prototype.bindDocumentKeyPressListener.call( this );
7869 }
7870 };
7871
7872 /**
7873 * @inheritdoc
7874 */
7875 OO.ui.MenuSelectWidget.prototype.unbindDocumentKeyPressListener = function () {
7876 if ( this.$input ) {
7877 if ( this.filterFromInput ) {
7878 this.$input.off(
7879 'keydown mouseup cut paste change input select',
7880 this.onInputEditHandler
7881 );
7882 this.updateItemVisibility();
7883 }
7884 } else {
7885 OO.ui.MenuSelectWidget.parent.prototype.unbindDocumentKeyPressListener.call( this );
7886 }
7887 };
7888
7889 /**
7890 * Choose an item.
7891 *
7892 * When a user chooses an item, the menu is closed, unless the hideOnChoose config option is
7893 * set to false.
7894 *
7895 * Note that ‘choose’ should never be modified programmatically. A user can choose an option with
7896 * the keyboard or mouse and it becomes selected. To select an item programmatically,
7897 * use the #selectItem method.
7898 *
7899 * @param {OO.ui.OptionWidget} item Item to choose
7900 * @chainable
7901 * @return {OO.ui.Widget} The widget, for chaining
7902 */
7903 OO.ui.MenuSelectWidget.prototype.chooseItem = function ( item ) {
7904 OO.ui.MenuSelectWidget.parent.prototype.chooseItem.call( this, item );
7905 if ( this.hideOnChoose ) {
7906 this.toggle( false );
7907 }
7908 return this;
7909 };
7910
7911 /**
7912 * @inheritdoc
7913 */
7914 OO.ui.MenuSelectWidget.prototype.addItems = function ( items, index ) {
7915 // Parent method
7916 OO.ui.MenuSelectWidget.parent.prototype.addItems.call( this, items, index );
7917
7918 this.updateItemVisibility();
7919
7920 return this;
7921 };
7922
7923 /**
7924 * @inheritdoc
7925 */
7926 OO.ui.MenuSelectWidget.prototype.removeItems = function ( items ) {
7927 // Parent method
7928 OO.ui.MenuSelectWidget.parent.prototype.removeItems.call( this, items );
7929
7930 this.updateItemVisibility();
7931
7932 return this;
7933 };
7934
7935 /**
7936 * @inheritdoc
7937 */
7938 OO.ui.MenuSelectWidget.prototype.clearItems = function () {
7939 // Parent method
7940 OO.ui.MenuSelectWidget.parent.prototype.clearItems.call( this );
7941
7942 this.updateItemVisibility();
7943
7944 return this;
7945 };
7946
7947 /**
7948 * Toggle visibility of the menu. The menu is initially hidden and must be shown by calling
7949 * `.toggle( true )` after its #$element is attached to the DOM.
7950 *
7951 * Do not show the menu while it is not attached to the DOM. The calculations required to display
7952 * it in the right place and with the right dimensions only work correctly while it is attached.
7953 * Side-effects may include broken interface and exceptions being thrown. This wasn't always
7954 * strictly enforced, so currently it only generates a warning in the browser console.
7955 *
7956 * @fires ready
7957 * @inheritdoc
7958 */
7959 OO.ui.MenuSelectWidget.prototype.toggle = function ( visible ) {
7960 var change, originalHeight, flippedHeight, selectedItem;
7961
7962 visible = ( visible === undefined ? !this.visible : !!visible ) && !!this.items.length;
7963 change = visible !== this.isVisible();
7964
7965 if ( visible && !this.warnedUnattached && !this.isElementAttached() ) {
7966 OO.ui.warnDeprecation( 'MenuSelectWidget#toggle: Before calling this method, the menu must be attached to the DOM.' );
7967 this.warnedUnattached = true;
7968 }
7969
7970 if ( change && visible ) {
7971 // Reset position before showing the popup again. It's possible we no longer need to flip
7972 // (e.g. if the user scrolled).
7973 this.setVerticalPosition( this.originalVerticalPosition );
7974 }
7975
7976 // Parent method
7977 OO.ui.MenuSelectWidget.parent.prototype.toggle.call( this, visible );
7978
7979 if ( change ) {
7980 if ( visible ) {
7981
7982 if ( this.width ) {
7983 this.setIdealSize( this.width );
7984 } else if ( this.$floatableContainer ) {
7985 this.$clippable.css( 'width', 'auto' );
7986 this.setIdealSize(
7987 this.$floatableContainer[ 0 ].offsetWidth > this.$clippable[ 0 ].offsetWidth ?
7988 // Dropdown is smaller than handle so expand to width
7989 this.$floatableContainer[ 0 ].offsetWidth :
7990 // Dropdown is larger than handle so auto size
7991 'auto'
7992 );
7993 this.$clippable.css( 'width', '' );
7994 }
7995
7996 this.togglePositioning( !!this.$floatableContainer );
7997 this.toggleClipping( true );
7998
7999 this.bindDocumentKeyDownListener();
8000 this.bindDocumentKeyPressListener();
8001
8002 if (
8003 ( this.isClippedVertically() || this.isFloatableOutOfView() ) &&
8004 this.originalVerticalPosition !== 'center'
8005 ) {
8006 // If opening the menu in one direction causes it to be clipped, flip it
8007 originalHeight = this.$element.height();
8008 this.setVerticalPosition(
8009 this.constructor.static.flippedPositions[ this.originalVerticalPosition ]
8010 );
8011 if ( this.isClippedVertically() || this.isFloatableOutOfView() ) {
8012 // If flipping also causes it to be clipped, open in whichever direction
8013 // we have more space
8014 flippedHeight = this.$element.height();
8015 if ( originalHeight > flippedHeight ) {
8016 this.setVerticalPosition( this.originalVerticalPosition );
8017 }
8018 }
8019 }
8020 // Note that we do not flip the menu's opening direction if the clipping changes
8021 // later (e.g. after the user scrolls), that seems like it would be annoying
8022
8023 this.$focusOwner.attr( 'aria-expanded', 'true' );
8024
8025 selectedItem = this.findSelectedItem();
8026 if ( !this.multiselect && selectedItem ) {
8027 // TODO: Verify if this is even needed; This is already done on highlight changes
8028 // in SelectWidget#highlightItem, so we should just need to highlight the item
8029 // we need to highlight here and not bother with attr or checking selections.
8030 this.$focusOwner.attr( 'aria-activedescendant', selectedItem.getElementId() );
8031 selectedItem.scrollElementIntoView( { duration: 0 } );
8032 }
8033
8034 // Auto-hide
8035 if ( this.autoHide ) {
8036 this.getElementDocument().addEventListener( 'mousedown', this.onDocumentMouseDownHandler, true );
8037 }
8038
8039 this.emit( 'ready' );
8040 } else {
8041 this.$focusOwner.removeAttr( 'aria-activedescendant' );
8042 this.unbindDocumentKeyDownListener();
8043 this.unbindDocumentKeyPressListener();
8044 this.$focusOwner.attr( 'aria-expanded', 'false' );
8045 this.getElementDocument().removeEventListener( 'mousedown', this.onDocumentMouseDownHandler, true );
8046 this.togglePositioning( false );
8047 this.toggleClipping( false );
8048 this.lastHighlightedItem = null;
8049 }
8050 }
8051
8052 return this;
8053 };
8054
8055 /**
8056 * Scroll to the top of the menu
8057 */
8058 OO.ui.MenuSelectWidget.prototype.scrollToTop = function () {
8059 this.$element.scrollTop( 0 );
8060 };
8061
8062 /**
8063 * DropdownWidgets are not menus themselves, rather they contain a menu of options created with
8064 * OO.ui.MenuOptionWidget. The DropdownWidget takes care of opening and displaying the menu so that
8065 * users can interact with it.
8066 *
8067 * If you want to use this within an HTML form, such as a OO.ui.FormLayout, use
8068 * OO.ui.DropdownInputWidget instead.
8069 *
8070 * @example
8071 * // A DropdownWidget with a menu that contains three options.
8072 * var dropDown = new OO.ui.DropdownWidget( {
8073 * label: 'Dropdown menu: Select a menu option',
8074 * menu: {
8075 * items: [
8076 * new OO.ui.MenuOptionWidget( {
8077 * data: 'a',
8078 * label: 'First'
8079 * } ),
8080 * new OO.ui.MenuOptionWidget( {
8081 * data: 'b',
8082 * label: 'Second'
8083 * } ),
8084 * new OO.ui.MenuOptionWidget( {
8085 * data: 'c',
8086 * label: 'Third'
8087 * } )
8088 * ]
8089 * }
8090 * } );
8091 *
8092 * $( document.body ).append( dropDown.$element );
8093 *
8094 * dropDown.getMenu().selectItemByData( 'b' );
8095 *
8096 * dropDown.getMenu().findSelectedItem().getData(); // Returns 'b'.
8097 *
8098 * For more information, please see the [OOUI documentation on MediaWiki] [1].
8099 *
8100 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Menu_selects_and_options
8101 *
8102 * @class
8103 * @extends OO.ui.Widget
8104 * @mixins OO.ui.mixin.IconElement
8105 * @mixins OO.ui.mixin.IndicatorElement
8106 * @mixins OO.ui.mixin.LabelElement
8107 * @mixins OO.ui.mixin.TitledElement
8108 * @mixins OO.ui.mixin.TabIndexedElement
8109 *
8110 * @constructor
8111 * @param {Object} [config] Configuration options
8112 * @cfg {Object} [menu] Configuration options to pass to
8113 * {@link OO.ui.MenuSelectWidget menu select widget}.
8114 * @cfg {jQuery} [$overlay] Render the menu into a separate layer. This configuration is useful
8115 * in cases where the expanded menu is larger than its containing `<div>`. The specified overlay
8116 * layer is usually on top of the containing `<div>` and has a larger area. By default, the menu
8117 * uses relative positioning.
8118 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
8119 */
8120 OO.ui.DropdownWidget = function OoUiDropdownWidget( config ) {
8121 // Configuration initialization
8122 config = $.extend( { indicator: 'down' }, config );
8123
8124 // Parent constructor
8125 OO.ui.DropdownWidget.parent.call( this, config );
8126
8127 // Properties (must be set before TabIndexedElement constructor call)
8128 this.$handle = $( '<button>' );
8129 this.$overlay = ( config.$overlay === true ?
8130 OO.ui.getDefaultOverlay() : config.$overlay ) || this.$element;
8131
8132 // Mixin constructors
8133 OO.ui.mixin.IconElement.call( this, config );
8134 OO.ui.mixin.IndicatorElement.call( this, config );
8135 OO.ui.mixin.LabelElement.call( this, config );
8136 OO.ui.mixin.TitledElement.call( this, $.extend( {
8137 $titled: this.$label
8138 }, config ) );
8139 OO.ui.mixin.TabIndexedElement.call( this, $.extend( {
8140 $tabIndexed: this.$handle
8141 }, config ) );
8142
8143 // Properties
8144 this.menu = new OO.ui.MenuSelectWidget( $.extend( {
8145 widget: this,
8146 $floatableContainer: this.$element
8147 }, config.menu ) );
8148
8149 // Events
8150 this.$handle.on( {
8151 click: this.onClick.bind( this ),
8152 keydown: this.onKeyDown.bind( this ),
8153 // Hack? Handle type-to-search when menu is not expanded and not handling its own events.
8154 keypress: this.menu.onDocumentKeyPressHandler,
8155 blur: this.menu.clearKeyPressBuffer.bind( this.menu )
8156 } );
8157 this.menu.connect( this, {
8158 select: 'onMenuSelect',
8159 toggle: 'onMenuToggle'
8160 } );
8161
8162 // Initialization
8163 this.$handle
8164 .addClass( 'oo-ui-dropdownWidget-handle' )
8165 .attr( {
8166 type: 'button',
8167 'aria-owns': this.menu.getElementId(),
8168 'aria-haspopup': 'listbox'
8169 } )
8170 .append( this.$icon, this.$label, this.$indicator );
8171 this.$element
8172 .addClass( 'oo-ui-dropdownWidget' )
8173 .append( this.$handle );
8174 this.$overlay.append( this.menu.$element );
8175 };
8176
8177 /* Setup */
8178
8179 OO.inheritClass( OO.ui.DropdownWidget, OO.ui.Widget );
8180 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.IconElement );
8181 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.IndicatorElement );
8182 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.LabelElement );
8183 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.TitledElement );
8184 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.TabIndexedElement );
8185
8186 /* Methods */
8187
8188 /**
8189 * Get the menu.
8190 *
8191 * @return {OO.ui.MenuSelectWidget} Menu of widget
8192 */
8193 OO.ui.DropdownWidget.prototype.getMenu = function () {
8194 return this.menu;
8195 };
8196
8197 /**
8198 * Handles menu select events.
8199 *
8200 * @private
8201 * @param {OO.ui.MenuOptionWidget} item Selected menu item
8202 */
8203 OO.ui.DropdownWidget.prototype.onMenuSelect = function ( item ) {
8204 var selectedLabel;
8205
8206 if ( !item ) {
8207 this.setLabel( null );
8208 return;
8209 }
8210
8211 selectedLabel = item.getLabel();
8212
8213 // If the label is a DOM element, clone it, because setLabel will append() it
8214 if ( selectedLabel instanceof $ ) {
8215 selectedLabel = selectedLabel.clone();
8216 }
8217
8218 this.setLabel( selectedLabel );
8219 };
8220
8221 /**
8222 * Handle menu toggle events.
8223 *
8224 * @private
8225 * @param {boolean} isVisible Open state of the menu
8226 */
8227 OO.ui.DropdownWidget.prototype.onMenuToggle = function ( isVisible ) {
8228 this.$element.toggleClass( 'oo-ui-dropdownWidget-open', isVisible );
8229 };
8230
8231 /**
8232 * Handle mouse click events.
8233 *
8234 * @private
8235 * @param {jQuery.Event} e Mouse click event
8236 * @return {undefined|boolean} False to prevent default if event is handled
8237 */
8238 OO.ui.DropdownWidget.prototype.onClick = function ( e ) {
8239 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
8240 this.menu.toggle();
8241 }
8242 return false;
8243 };
8244
8245 /**
8246 * Handle key down events.
8247 *
8248 * @private
8249 * @param {jQuery.Event} e Key down event
8250 * @return {undefined|boolean} False to prevent default if event is handled
8251 */
8252 OO.ui.DropdownWidget.prototype.onKeyDown = function ( e ) {
8253 if (
8254 !this.isDisabled() &&
8255 (
8256 e.which === OO.ui.Keys.ENTER ||
8257 (
8258 e.which === OO.ui.Keys.SPACE &&
8259 // Avoid conflicts with type-to-search, see SelectWidget#onKeyPress.
8260 // Space only closes the menu is the user is not typing to search.
8261 this.menu.keyPressBuffer === ''
8262 ) ||
8263 (
8264 !this.menu.isVisible() &&
8265 (
8266 e.which === OO.ui.Keys.UP ||
8267 e.which === OO.ui.Keys.DOWN
8268 )
8269 )
8270 )
8271 ) {
8272 this.menu.toggle();
8273 return false;
8274 }
8275 };
8276
8277 /**
8278 * RadioOptionWidget is an option widget that looks like a radio button.
8279 * The class is used with OO.ui.RadioSelectWidget to create a selection of radio options.
8280 * Please see the [OOUI documentation on MediaWiki] [1] for more information.
8281 *
8282 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Button_selects_and_option
8283 *
8284 * @class
8285 * @extends OO.ui.OptionWidget
8286 *
8287 * @constructor
8288 * @param {Object} [config] Configuration options
8289 */
8290 OO.ui.RadioOptionWidget = function OoUiRadioOptionWidget( config ) {
8291 // Configuration initialization
8292 config = config || {};
8293
8294 // Properties (must be done before parent constructor which calls #setDisabled)
8295 this.radio = new OO.ui.RadioInputWidget( { value: config.data, tabIndex: -1 } );
8296
8297 // Parent constructor
8298 OO.ui.RadioOptionWidget.parent.call( this, config );
8299
8300 // Initialization
8301 // Remove implicit role, we're handling it ourselves
8302 this.radio.$input.attr( 'role', 'presentation' );
8303 this.$element
8304 .addClass( 'oo-ui-radioOptionWidget' )
8305 .attr( 'role', 'radio' )
8306 .attr( 'aria-checked', 'false' )
8307 .removeAttr( 'aria-selected' )
8308 .prepend( this.radio.$element );
8309 };
8310
8311 /* Setup */
8312
8313 OO.inheritClass( OO.ui.RadioOptionWidget, OO.ui.OptionWidget );
8314
8315 /* Static Properties */
8316
8317 /**
8318 * @static
8319 * @inheritdoc
8320 */
8321 OO.ui.RadioOptionWidget.static.highlightable = false;
8322
8323 /**
8324 * @static
8325 * @inheritdoc
8326 */
8327 OO.ui.RadioOptionWidget.static.scrollIntoViewOnSelect = true;
8328
8329 /**
8330 * @static
8331 * @inheritdoc
8332 */
8333 OO.ui.RadioOptionWidget.static.pressable = false;
8334
8335 /**
8336 * @static
8337 * @inheritdoc
8338 */
8339 OO.ui.RadioOptionWidget.static.tagName = 'label';
8340
8341 /* Methods */
8342
8343 /**
8344 * @inheritdoc
8345 */
8346 OO.ui.RadioOptionWidget.prototype.setSelected = function ( state ) {
8347 OO.ui.RadioOptionWidget.parent.prototype.setSelected.call( this, state );
8348
8349 this.radio.setSelected( state );
8350 this.$element
8351 .attr( 'aria-checked', state.toString() )
8352 .removeAttr( 'aria-selected' );
8353
8354 return this;
8355 };
8356
8357 /**
8358 * @inheritdoc
8359 */
8360 OO.ui.RadioOptionWidget.prototype.setDisabled = function ( disabled ) {
8361 OO.ui.RadioOptionWidget.parent.prototype.setDisabled.call( this, disabled );
8362
8363 this.radio.setDisabled( this.isDisabled() );
8364
8365 return this;
8366 };
8367
8368 /**
8369 * RadioSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains radio
8370 * options and is used together with OO.ui.RadioOptionWidget. The RadioSelectWidget provides
8371 * an interface for adding, removing and selecting options.
8372 * Please see the [OOUI documentation on MediaWiki][1] for more information.
8373 *
8374 * If you want to use this within an HTML form, such as a OO.ui.FormLayout, use
8375 * OO.ui.RadioSelectInputWidget instead.
8376 *
8377 * @example
8378 * // A RadioSelectWidget with RadioOptions.
8379 * var option1 = new OO.ui.RadioOptionWidget( {
8380 * data: 'a',
8381 * label: 'Selected radio option'
8382 * } ),
8383 * option2 = new OO.ui.RadioOptionWidget( {
8384 * data: 'b',
8385 * label: 'Unselected radio option'
8386 * } );
8387 * radioSelect = new OO.ui.RadioSelectWidget( {
8388 * items: [ option1, option2 ]
8389 * } );
8390 *
8391 * // Select 'option 1' using the RadioSelectWidget's selectItem() method.
8392 * radioSelect.selectItem( option1 );
8393 *
8394 * $( document.body ).append( radioSelect.$element );
8395 *
8396 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
8397
8398 *
8399 * @class
8400 * @extends OO.ui.SelectWidget
8401 * @mixins OO.ui.mixin.TabIndexedElement
8402 *
8403 * @constructor
8404 * @param {Object} [config] Configuration options
8405 */
8406 OO.ui.RadioSelectWidget = function OoUiRadioSelectWidget( config ) {
8407 // Parent constructor
8408 OO.ui.RadioSelectWidget.parent.call( this, config );
8409
8410 // Mixin constructors
8411 OO.ui.mixin.TabIndexedElement.call( this, config );
8412
8413 // Events
8414 this.$element.on( {
8415 focus: this.bindDocumentKeyDownListener.bind( this ),
8416 blur: this.unbindDocumentKeyDownListener.bind( this )
8417 } );
8418
8419 // Initialization
8420 this.$element
8421 .addClass( 'oo-ui-radioSelectWidget' )
8422 .attr( 'role', 'radiogroup' );
8423 };
8424
8425 /* Setup */
8426
8427 OO.inheritClass( OO.ui.RadioSelectWidget, OO.ui.SelectWidget );
8428 OO.mixinClass( OO.ui.RadioSelectWidget, OO.ui.mixin.TabIndexedElement );
8429
8430 /**
8431 * MultioptionWidgets are special elements that can be selected and configured with data. The
8432 * data is often unique for each option, but it does not have to be. MultioptionWidgets are used
8433 * with OO.ui.SelectWidget to create a selection of mutually exclusive options. For more information
8434 * and examples, please see the [OOUI documentation on MediaWiki][1].
8435 *
8436 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
8437 *
8438 * @class
8439 * @extends OO.ui.Widget
8440 * @mixins OO.ui.mixin.ItemWidget
8441 * @mixins OO.ui.mixin.LabelElement
8442 * @mixins OO.ui.mixin.TitledElement
8443 *
8444 * @constructor
8445 * @param {Object} [config] Configuration options
8446 * @cfg {boolean} [selected=false] Whether the option is initially selected
8447 */
8448 OO.ui.MultioptionWidget = function OoUiMultioptionWidget( config ) {
8449 // Configuration initialization
8450 config = config || {};
8451
8452 // Parent constructor
8453 OO.ui.MultioptionWidget.parent.call( this, config );
8454
8455 // Mixin constructors
8456 OO.ui.mixin.ItemWidget.call( this );
8457 OO.ui.mixin.LabelElement.call( this, config );
8458 OO.ui.mixin.TitledElement.call( this, config );
8459
8460 // Properties
8461 this.selected = null;
8462
8463 // Initialization
8464 this.$element
8465 .addClass( 'oo-ui-multioptionWidget' )
8466 .append( this.$label );
8467 this.setSelected( config.selected );
8468 };
8469
8470 /* Setup */
8471
8472 OO.inheritClass( OO.ui.MultioptionWidget, OO.ui.Widget );
8473 OO.mixinClass( OO.ui.MultioptionWidget, OO.ui.mixin.ItemWidget );
8474 OO.mixinClass( OO.ui.MultioptionWidget, OO.ui.mixin.LabelElement );
8475 OO.mixinClass( OO.ui.MultioptionWidget, OO.ui.mixin.TitledElement );
8476
8477 /* Events */
8478
8479 /**
8480 * @event change
8481 *
8482 * A change event is emitted when the selected state of the option changes.
8483 *
8484 * @param {boolean} selected Whether the option is now selected
8485 */
8486
8487 /* Methods */
8488
8489 /**
8490 * Check if the option is selected.
8491 *
8492 * @return {boolean} Item is selected
8493 */
8494 OO.ui.MultioptionWidget.prototype.isSelected = function () {
8495 return this.selected;
8496 };
8497
8498 /**
8499 * Set the option’s selected state. In general, all modifications to the selection
8500 * should be handled by the SelectWidget’s
8501 * {@link OO.ui.SelectWidget#selectItem selectItem( [item] )} method instead of this method.
8502 *
8503 * @param {boolean} [state=false] Select option
8504 * @chainable
8505 * @return {OO.ui.Widget} The widget, for chaining
8506 */
8507 OO.ui.MultioptionWidget.prototype.setSelected = function ( state ) {
8508 state = !!state;
8509 if ( this.selected !== state ) {
8510 this.selected = state;
8511 this.emit( 'change', state );
8512 this.$element.toggleClass( 'oo-ui-multioptionWidget-selected', state );
8513 }
8514 return this;
8515 };
8516
8517 /**
8518 * MultiselectWidget allows selecting multiple options from a list.
8519 *
8520 * For more information about menus and options, please see the [OOUI documentation
8521 * on MediaWiki][1].
8522 *
8523 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Menu_selects_and_options
8524 *
8525 * @class
8526 * @abstract
8527 * @extends OO.ui.Widget
8528 * @mixins OO.ui.mixin.GroupWidget
8529 * @mixins OO.ui.mixin.TitledElement
8530 *
8531 * @constructor
8532 * @param {Object} [config] Configuration options
8533 * @cfg {OO.ui.MultioptionWidget[]} [items] An array of options to add to the multiselect.
8534 */
8535 OO.ui.MultiselectWidget = function OoUiMultiselectWidget( config ) {
8536 // Parent constructor
8537 OO.ui.MultiselectWidget.parent.call( this, config );
8538
8539 // Configuration initialization
8540 config = config || {};
8541
8542 // Mixin constructors
8543 OO.ui.mixin.GroupWidget.call( this, config );
8544 OO.ui.mixin.TitledElement.call( this, config );
8545
8546 // Events
8547 this.aggregate( {
8548 change: 'select'
8549 } );
8550 // This is mostly for compatibility with TagMultiselectWidget... normally, 'change' is emitted
8551 // by GroupElement only when items are added/removed
8552 this.connect( this, {
8553 select: [ 'emit', 'change' ]
8554 } );
8555
8556 // Initialization
8557 if ( config.items ) {
8558 this.addItems( config.items );
8559 }
8560 this.$group.addClass( 'oo-ui-multiselectWidget-group' );
8561 this.$element.addClass( 'oo-ui-multiselectWidget' )
8562 .append( this.$group );
8563 };
8564
8565 /* Setup */
8566
8567 OO.inheritClass( OO.ui.MultiselectWidget, OO.ui.Widget );
8568 OO.mixinClass( OO.ui.MultiselectWidget, OO.ui.mixin.GroupWidget );
8569 OO.mixinClass( OO.ui.MultiselectWidget, OO.ui.mixin.TitledElement );
8570
8571 /* Events */
8572
8573 /**
8574 * @event change
8575 *
8576 * A change event is emitted when the set of items changes, or an item is selected or deselected.
8577 */
8578
8579 /**
8580 * @event select
8581 *
8582 * A select event is emitted when an item is selected or deselected.
8583 */
8584
8585 /* Methods */
8586
8587 /**
8588 * Find options that are selected.
8589 *
8590 * @return {OO.ui.MultioptionWidget[]} Selected options
8591 */
8592 OO.ui.MultiselectWidget.prototype.findSelectedItems = function () {
8593 return this.items.filter( function ( item ) {
8594 return item.isSelected();
8595 } );
8596 };
8597
8598 /**
8599 * Find the data of options that are selected.
8600 *
8601 * @return {Object[]|string[]} Values of selected options
8602 */
8603 OO.ui.MultiselectWidget.prototype.findSelectedItemsData = function () {
8604 return this.findSelectedItems().map( function ( item ) {
8605 return item.data;
8606 } );
8607 };
8608
8609 /**
8610 * Select options by reference. Options not mentioned in the `items` array will be deselected.
8611 *
8612 * @param {OO.ui.MultioptionWidget[]} items Items to select
8613 * @chainable
8614 * @return {OO.ui.Widget} The widget, for chaining
8615 */
8616 OO.ui.MultiselectWidget.prototype.selectItems = function ( items ) {
8617 this.items.forEach( function ( item ) {
8618 var selected = items.indexOf( item ) !== -1;
8619 item.setSelected( selected );
8620 } );
8621 return this;
8622 };
8623
8624 /**
8625 * Select items by their data. Options not mentioned in the `datas` array will be deselected.
8626 *
8627 * @param {Object[]|string[]} datas Values of items to select
8628 * @chainable
8629 * @return {OO.ui.Widget} The widget, for chaining
8630 */
8631 OO.ui.MultiselectWidget.prototype.selectItemsByData = function ( datas ) {
8632 var items,
8633 widget = this;
8634 items = datas.map( function ( data ) {
8635 return widget.findItemFromData( data );
8636 } );
8637 this.selectItems( items );
8638 return this;
8639 };
8640
8641 /**
8642 * CheckboxMultioptionWidget is an option widget that looks like a checkbox.
8643 * The class is used with OO.ui.CheckboxMultiselectWidget to create a selection of checkbox options.
8644 * Please see the [OOUI documentation on MediaWiki] [1] for more information.
8645 *
8646 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Button_selects_and_option
8647 *
8648 * @class
8649 * @extends OO.ui.MultioptionWidget
8650 *
8651 * @constructor
8652 * @param {Object} [config] Configuration options
8653 */
8654 OO.ui.CheckboxMultioptionWidget = function OoUiCheckboxMultioptionWidget( config ) {
8655 // Configuration initialization
8656 config = config || {};
8657
8658 // Properties (must be done before parent constructor which calls #setDisabled)
8659 this.checkbox = new OO.ui.CheckboxInputWidget();
8660
8661 // Parent constructor
8662 OO.ui.CheckboxMultioptionWidget.parent.call( this, config );
8663
8664 // Events
8665 this.checkbox.on( 'change', this.onCheckboxChange.bind( this ) );
8666 this.$element.on( 'keydown', this.onKeyDown.bind( this ) );
8667
8668 // Initialization
8669 this.$element
8670 .addClass( 'oo-ui-checkboxMultioptionWidget' )
8671 .prepend( this.checkbox.$element );
8672 };
8673
8674 /* Setup */
8675
8676 OO.inheritClass( OO.ui.CheckboxMultioptionWidget, OO.ui.MultioptionWidget );
8677
8678 /* Static Properties */
8679
8680 /**
8681 * @static
8682 * @inheritdoc
8683 */
8684 OO.ui.CheckboxMultioptionWidget.static.tagName = 'label';
8685
8686 /* Methods */
8687
8688 /**
8689 * Handle checkbox selected state change.
8690 *
8691 * @private
8692 */
8693 OO.ui.CheckboxMultioptionWidget.prototype.onCheckboxChange = function () {
8694 this.setSelected( this.checkbox.isSelected() );
8695 };
8696
8697 /**
8698 * @inheritdoc
8699 */
8700 OO.ui.CheckboxMultioptionWidget.prototype.setSelected = function ( state ) {
8701 OO.ui.CheckboxMultioptionWidget.parent.prototype.setSelected.call( this, state );
8702 this.checkbox.setSelected( state );
8703 return this;
8704 };
8705
8706 /**
8707 * @inheritdoc
8708 */
8709 OO.ui.CheckboxMultioptionWidget.prototype.setDisabled = function ( disabled ) {
8710 OO.ui.CheckboxMultioptionWidget.parent.prototype.setDisabled.call( this, disabled );
8711 this.checkbox.setDisabled( this.isDisabled() );
8712 return this;
8713 };
8714
8715 /**
8716 * Focus the widget.
8717 */
8718 OO.ui.CheckboxMultioptionWidget.prototype.focus = function () {
8719 this.checkbox.focus();
8720 };
8721
8722 /**
8723 * Handle key down events.
8724 *
8725 * @protected
8726 * @param {jQuery.Event} e
8727 */
8728 OO.ui.CheckboxMultioptionWidget.prototype.onKeyDown = function ( e ) {
8729 var
8730 element = this.getElementGroup(),
8731 nextItem;
8732
8733 if ( e.keyCode === OO.ui.Keys.LEFT || e.keyCode === OO.ui.Keys.UP ) {
8734 nextItem = element.getRelativeFocusableItem( this, -1 );
8735 } else if ( e.keyCode === OO.ui.Keys.RIGHT || e.keyCode === OO.ui.Keys.DOWN ) {
8736 nextItem = element.getRelativeFocusableItem( this, 1 );
8737 }
8738
8739 if ( nextItem ) {
8740 e.preventDefault();
8741 nextItem.focus();
8742 }
8743 };
8744
8745 /**
8746 * CheckboxMultiselectWidget is a {@link OO.ui.MultiselectWidget multiselect widget} that contains
8747 * checkboxes and is used together with OO.ui.CheckboxMultioptionWidget. The
8748 * CheckboxMultiselectWidget provides an interface for adding, removing and selecting options.
8749 * Please see the [OOUI documentation on MediaWiki][1] for more information.
8750 *
8751 * If you want to use this within an HTML form, such as a OO.ui.FormLayout, use
8752 * OO.ui.CheckboxMultiselectInputWidget instead.
8753 *
8754 * @example
8755 * // A CheckboxMultiselectWidget with CheckboxMultioptions.
8756 * var option1 = new OO.ui.CheckboxMultioptionWidget( {
8757 * data: 'a',
8758 * selected: true,
8759 * label: 'Selected checkbox'
8760 * } ),
8761 * option2 = new OO.ui.CheckboxMultioptionWidget( {
8762 * data: 'b',
8763 * label: 'Unselected checkbox'
8764 * } ),
8765 * multiselect = new OO.ui.CheckboxMultiselectWidget( {
8766 * items: [ option1, option2 ]
8767 * } );
8768 * $( document.body ).append( multiselect.$element );
8769 *
8770 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
8771 *
8772 * @class
8773 * @extends OO.ui.MultiselectWidget
8774 *
8775 * @constructor
8776 * @param {Object} [config] Configuration options
8777 */
8778 OO.ui.CheckboxMultiselectWidget = function OoUiCheckboxMultiselectWidget( config ) {
8779 // Parent constructor
8780 OO.ui.CheckboxMultiselectWidget.parent.call( this, config );
8781
8782 // Properties
8783 this.$lastClicked = null;
8784
8785 // Events
8786 this.$group.on( 'click', this.onClick.bind( this ) );
8787
8788 // Initialization
8789 this.$element.addClass( 'oo-ui-checkboxMultiselectWidget' );
8790 };
8791
8792 /* Setup */
8793
8794 OO.inheritClass( OO.ui.CheckboxMultiselectWidget, OO.ui.MultiselectWidget );
8795
8796 /* Methods */
8797
8798 /**
8799 * Get an option by its position relative to the specified item (or to the start of the
8800 * option array, if item is `null`). The direction in which to search through the option array
8801 * is specified with a number: -1 for reverse (the default) or 1 for forward. The method will
8802 * return an option, or `null` if there are no options in the array.
8803 *
8804 * @param {OO.ui.CheckboxMultioptionWidget|null} item Item to describe the start position, or
8805 * `null` to start at the beginning of the array.
8806 * @param {number} direction Direction to move in: -1 to move backward, 1 to move forward
8807 * @return {OO.ui.CheckboxMultioptionWidget|null} Item at position, `null` if there are no items
8808 * in the select.
8809 */
8810 OO.ui.CheckboxMultiselectWidget.prototype.getRelativeFocusableItem = function ( item, direction ) {
8811 var currentIndex, nextIndex, i,
8812 increase = direction > 0 ? 1 : -1,
8813 len = this.items.length;
8814
8815 if ( item ) {
8816 currentIndex = this.items.indexOf( item );
8817 nextIndex = ( currentIndex + increase + len ) % len;
8818 } else {
8819 // If no item is selected and moving forward, start at the beginning.
8820 // If moving backward, start at the end.
8821 nextIndex = direction > 0 ? 0 : len - 1;
8822 }
8823
8824 for ( i = 0; i < len; i++ ) {
8825 item = this.items[ nextIndex ];
8826 if ( item && !item.isDisabled() ) {
8827 return item;
8828 }
8829 nextIndex = ( nextIndex + increase + len ) % len;
8830 }
8831 return null;
8832 };
8833
8834 /**
8835 * Handle click events on checkboxes.
8836 *
8837 * @param {jQuery.Event} e
8838 */
8839 OO.ui.CheckboxMultiselectWidget.prototype.onClick = function ( e ) {
8840 var $options, lastClickedIndex, nowClickedIndex, i, direction, wasSelected, items,
8841 $lastClicked = this.$lastClicked,
8842 $nowClicked = $( e.target ).closest( '.oo-ui-checkboxMultioptionWidget' )
8843 .not( '.oo-ui-widget-disabled' );
8844
8845 // Allow selecting multiple options at once by Shift-clicking them
8846 if ( $lastClicked && $nowClicked.length && e.shiftKey ) {
8847 $options = this.$group.find( '.oo-ui-checkboxMultioptionWidget' );
8848 lastClickedIndex = $options.index( $lastClicked );
8849 nowClickedIndex = $options.index( $nowClicked );
8850 // If it's the same item, either the user is being silly, or it's a fake event generated
8851 // by the browser. In either case we don't need custom handling.
8852 if ( nowClickedIndex !== lastClickedIndex ) {
8853 items = this.items;
8854 wasSelected = items[ nowClickedIndex ].isSelected();
8855 direction = nowClickedIndex > lastClickedIndex ? 1 : -1;
8856
8857 // This depends on the DOM order of the items and the order of the .items array being
8858 // the same.
8859 for ( i = lastClickedIndex; i !== nowClickedIndex; i += direction ) {
8860 if ( !items[ i ].isDisabled() ) {
8861 items[ i ].setSelected( !wasSelected );
8862 }
8863 }
8864 // For the now-clicked element, use immediate timeout to allow the browser to do its own
8865 // handling first, then set our value. The order in which events happen is different for
8866 // clicks on the <input> and on the <label> and there are additional fake clicks fired
8867 // for non-click actions that change the checkboxes.
8868 e.preventDefault();
8869 setTimeout( function () {
8870 if ( !items[ nowClickedIndex ].isDisabled() ) {
8871 items[ nowClickedIndex ].setSelected( !wasSelected );
8872 }
8873 } );
8874 }
8875 }
8876
8877 if ( $nowClicked.length ) {
8878 this.$lastClicked = $nowClicked;
8879 }
8880 };
8881
8882 /**
8883 * Focus the widget
8884 *
8885 * @chainable
8886 * @return {OO.ui.Widget} The widget, for chaining
8887 */
8888 OO.ui.CheckboxMultiselectWidget.prototype.focus = function () {
8889 var item;
8890 if ( !this.isDisabled() ) {
8891 item = this.getRelativeFocusableItem( null, 1 );
8892 if ( item ) {
8893 item.focus();
8894 }
8895 }
8896 return this;
8897 };
8898
8899 /**
8900 * @inheritdoc
8901 */
8902 OO.ui.CheckboxMultiselectWidget.prototype.simulateLabelClick = function () {
8903 this.focus();
8904 };
8905
8906 /**
8907 * Progress bars visually display the status of an operation, such as a download,
8908 * and can be either determinate or indeterminate:
8909 *
8910 * - **determinate** process bars show the percent of an operation that is complete.
8911 *
8912 * - **indeterminate** process bars use a visual display of motion to indicate that an operation
8913 * is taking place. Because the extent of an indeterminate operation is unknown, the bar does
8914 * not use percentages.
8915 *
8916 * The value of the `progress` configuration determines whether the bar is determinate
8917 * or indeterminate.
8918 *
8919 * @example
8920 * // Examples of determinate and indeterminate progress bars.
8921 * var progressBar1 = new OO.ui.ProgressBarWidget( {
8922 * progress: 33
8923 * } );
8924 * var progressBar2 = new OO.ui.ProgressBarWidget();
8925 *
8926 * // Create a FieldsetLayout to layout progress bars.
8927 * var fieldset = new OO.ui.FieldsetLayout;
8928 * fieldset.addItems( [
8929 * new OO.ui.FieldLayout( progressBar1, {
8930 * label: 'Determinate',
8931 * align: 'top'
8932 * } ),
8933 * new OO.ui.FieldLayout( progressBar2, {
8934 * label: 'Indeterminate',
8935 * align: 'top'
8936 * } )
8937 * ] );
8938 * $( document.body ).append( fieldset.$element );
8939 *
8940 * @class
8941 * @extends OO.ui.Widget
8942 *
8943 * @constructor
8944 * @param {Object} [config] Configuration options
8945 * @cfg {number|boolean} [progress=false] The type of progress bar (determinate or indeterminate).
8946 * To create a determinate progress bar, specify a number that reflects the initial
8947 * percent complete.
8948 * By default, the progress bar is indeterminate.
8949 */
8950 OO.ui.ProgressBarWidget = function OoUiProgressBarWidget( config ) {
8951 // Configuration initialization
8952 config = config || {};
8953
8954 // Parent constructor
8955 OO.ui.ProgressBarWidget.parent.call( this, config );
8956
8957 // Properties
8958 this.$bar = $( '<div>' );
8959 this.progress = null;
8960
8961 // Initialization
8962 this.setProgress( config.progress !== undefined ? config.progress : false );
8963 this.$bar.addClass( 'oo-ui-progressBarWidget-bar' );
8964 this.$element
8965 .attr( {
8966 role: 'progressbar',
8967 'aria-valuemin': 0,
8968 'aria-valuemax': 100
8969 } )
8970 .addClass( 'oo-ui-progressBarWidget' )
8971 .append( this.$bar );
8972 };
8973
8974 /* Setup */
8975
8976 OO.inheritClass( OO.ui.ProgressBarWidget, OO.ui.Widget );
8977
8978 /* Static Properties */
8979
8980 /**
8981 * @static
8982 * @inheritdoc
8983 */
8984 OO.ui.ProgressBarWidget.static.tagName = 'div';
8985
8986 /* Methods */
8987
8988 /**
8989 * Get the percent of the progress that has been completed. Indeterminate progresses will
8990 * return `false`.
8991 *
8992 * @return {number|boolean} Progress percent
8993 */
8994 OO.ui.ProgressBarWidget.prototype.getProgress = function () {
8995 return this.progress;
8996 };
8997
8998 /**
8999 * Set the percent of the process completed or `false` for an indeterminate process.
9000 *
9001 * @param {number|boolean} progress Progress percent or `false` for indeterminate
9002 */
9003 OO.ui.ProgressBarWidget.prototype.setProgress = function ( progress ) {
9004 this.progress = progress;
9005
9006 if ( progress !== false ) {
9007 this.$bar.css( 'width', this.progress + '%' );
9008 this.$element.attr( 'aria-valuenow', this.progress );
9009 } else {
9010 this.$bar.css( 'width', '' );
9011 this.$element.removeAttr( 'aria-valuenow' );
9012 }
9013 this.$element.toggleClass( 'oo-ui-progressBarWidget-indeterminate', progress === false );
9014 };
9015
9016 /**
9017 * InputWidget is the base class for all input widgets, which
9018 * include {@link OO.ui.TextInputWidget text inputs}, {@link OO.ui.CheckboxInputWidget checkbox
9019 * inputs}, {@link OO.ui.RadioInputWidget radio inputs}, and
9020 * {@link OO.ui.ButtonInputWidget button inputs}.
9021 * See the [OOUI documentation on MediaWiki] [1] for more information and examples.
9022 *
9023 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
9024 *
9025 * @abstract
9026 * @class
9027 * @extends OO.ui.Widget
9028 * @mixins OO.ui.mixin.TabIndexedElement
9029 * @mixins OO.ui.mixin.TitledElement
9030 * @mixins OO.ui.mixin.AccessKeyedElement
9031 *
9032 * @constructor
9033 * @param {Object} [config] Configuration options
9034 * @cfg {string} [name=''] The value of the input’s HTML `name` attribute.
9035 * @cfg {string} [value=''] The value of the input.
9036 * @cfg {string} [dir] The directionality of the input (ltr/rtl).
9037 * @cfg {string} [inputId] The value of the input’s HTML `id` attribute.
9038 * @cfg {Function} [inputFilter] The name of an input filter function. Input filters modify the
9039 * value of an input before it is accepted.
9040 */
9041 OO.ui.InputWidget = function OoUiInputWidget( config ) {
9042 // Configuration initialization
9043 config = config || {};
9044
9045 // Parent constructor
9046 OO.ui.InputWidget.parent.call( this, config );
9047
9048 // Properties
9049 // See #reusePreInfuseDOM about config.$input
9050 this.$input = config.$input || this.getInputElement( config );
9051 this.value = '';
9052 this.inputFilter = config.inputFilter;
9053
9054 // Mixin constructors
9055 OO.ui.mixin.TabIndexedElement.call( this, $.extend( {
9056 $tabIndexed: this.$input
9057 }, config ) );
9058 OO.ui.mixin.TitledElement.call( this, $.extend( {
9059 $titled: this.$input
9060 }, config ) );
9061 OO.ui.mixin.AccessKeyedElement.call( this, $.extend( {
9062 $accessKeyed: this.$input
9063 }, config ) );
9064
9065 // Events
9066 this.$input.on( 'keydown mouseup cut paste change input select', this.onEdit.bind( this ) );
9067
9068 // Initialization
9069 this.$input
9070 .addClass( 'oo-ui-inputWidget-input' )
9071 .attr( 'name', config.name )
9072 .prop( 'disabled', this.isDisabled() );
9073 this.$element
9074 .addClass( 'oo-ui-inputWidget' )
9075 .append( this.$input );
9076 this.setValue( config.value );
9077 if ( config.dir ) {
9078 this.setDir( config.dir );
9079 }
9080 if ( config.inputId !== undefined ) {
9081 this.setInputId( config.inputId );
9082 }
9083 };
9084
9085 /* Setup */
9086
9087 OO.inheritClass( OO.ui.InputWidget, OO.ui.Widget );
9088 OO.mixinClass( OO.ui.InputWidget, OO.ui.mixin.TabIndexedElement );
9089 OO.mixinClass( OO.ui.InputWidget, OO.ui.mixin.TitledElement );
9090 OO.mixinClass( OO.ui.InputWidget, OO.ui.mixin.AccessKeyedElement );
9091
9092 /* Static Methods */
9093
9094 /**
9095 * @inheritdoc
9096 */
9097 OO.ui.InputWidget.static.reusePreInfuseDOM = function ( node, config ) {
9098 config = OO.ui.InputWidget.parent.static.reusePreInfuseDOM( node, config );
9099 // Reusing `$input` lets browsers preserve inputted values across page reloads, see T114134.
9100 config.$input = $( node ).find( '.oo-ui-inputWidget-input' );
9101 return config;
9102 };
9103
9104 /**
9105 * @inheritdoc
9106 */
9107 OO.ui.InputWidget.static.gatherPreInfuseState = function ( node, config ) {
9108 var state = OO.ui.InputWidget.parent.static.gatherPreInfuseState( node, config );
9109 if ( config.$input && config.$input.length ) {
9110 state.value = config.$input.val();
9111 // Might be better in TabIndexedElement, but it's awkward to do there because
9112 // mixins are awkward
9113 state.focus = config.$input.is( ':focus' );
9114 }
9115 return state;
9116 };
9117
9118 /* Events */
9119
9120 /**
9121 * @event change
9122 *
9123 * A change event is emitted when the value of the input changes.
9124 *
9125 * @param {string} value
9126 */
9127
9128 /* Methods */
9129
9130 /**
9131 * Get input element.
9132 *
9133 * Subclasses of OO.ui.InputWidget use the `config` parameter to produce different elements in
9134 * different circumstances. The element must have a `value` property (like form elements).
9135 *
9136 * @protected
9137 * @param {Object} config Configuration options
9138 * @return {jQuery} Input element
9139 */
9140 OO.ui.InputWidget.prototype.getInputElement = function () {
9141 return $( '<input>' );
9142 };
9143
9144 /**
9145 * Handle potentially value-changing events.
9146 *
9147 * @private
9148 * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
9149 */
9150 OO.ui.InputWidget.prototype.onEdit = function () {
9151 var widget = this;
9152 if ( !this.isDisabled() ) {
9153 // Allow the stack to clear so the value will be updated
9154 setTimeout( function () {
9155 widget.setValue( widget.$input.val() );
9156 } );
9157 }
9158 };
9159
9160 /**
9161 * Get the value of the input.
9162 *
9163 * @return {string} Input value
9164 */
9165 OO.ui.InputWidget.prototype.getValue = function () {
9166 // Resynchronize our internal data with DOM data. Other scripts executing on the page can modify
9167 // it, and we won't know unless they're kind enough to trigger a 'change' event.
9168 var value = this.$input.val();
9169 if ( this.value !== value ) {
9170 this.setValue( value );
9171 }
9172 return this.value;
9173 };
9174
9175 /**
9176 * Set the directionality of the input.
9177 *
9178 * @param {string} dir Text directionality: 'ltr', 'rtl' or 'auto'
9179 * @chainable
9180 * @return {OO.ui.Widget} The widget, for chaining
9181 */
9182 OO.ui.InputWidget.prototype.setDir = function ( dir ) {
9183 this.$input.prop( 'dir', dir );
9184 return this;
9185 };
9186
9187 /**
9188 * Set the value of the input.
9189 *
9190 * @param {string} value New value
9191 * @fires change
9192 * @chainable
9193 * @return {OO.ui.Widget} The widget, for chaining
9194 */
9195 OO.ui.InputWidget.prototype.setValue = function ( value ) {
9196 value = this.cleanUpValue( value );
9197 // Update the DOM if it has changed. Note that with cleanUpValue, it
9198 // is possible for the DOM value to change without this.value changing.
9199 if ( this.$input.val() !== value ) {
9200 this.$input.val( value );
9201 }
9202 if ( this.value !== value ) {
9203 this.value = value;
9204 this.emit( 'change', this.value );
9205 }
9206 // The first time that the value is set (probably while constructing the widget),
9207 // remember it in defaultValue. This property can be later used to check whether
9208 // the value of the input has been changed since it was created.
9209 if ( this.defaultValue === undefined ) {
9210 this.defaultValue = this.value;
9211 this.$input[ 0 ].defaultValue = this.defaultValue;
9212 }
9213 return this;
9214 };
9215
9216 /**
9217 * Clean up incoming value.
9218 *
9219 * Ensures value is a string, and converts undefined and null to empty string.
9220 *
9221 * @private
9222 * @param {string} value Original value
9223 * @return {string} Cleaned up value
9224 */
9225 OO.ui.InputWidget.prototype.cleanUpValue = function ( value ) {
9226 if ( value === undefined || value === null ) {
9227 return '';
9228 } else if ( this.inputFilter ) {
9229 return this.inputFilter( String( value ) );
9230 } else {
9231 return String( value );
9232 }
9233 };
9234
9235 /**
9236 * @inheritdoc
9237 */
9238 OO.ui.InputWidget.prototype.setDisabled = function ( state ) {
9239 OO.ui.InputWidget.parent.prototype.setDisabled.call( this, state );
9240 if ( this.$input ) {
9241 this.$input.prop( 'disabled', this.isDisabled() );
9242 }
9243 return this;
9244 };
9245
9246 /**
9247 * Set the 'id' attribute of the `<input>` element.
9248 *
9249 * @param {string} id
9250 * @chainable
9251 * @return {OO.ui.Widget} The widget, for chaining
9252 */
9253 OO.ui.InputWidget.prototype.setInputId = function ( id ) {
9254 this.$input.attr( 'id', id );
9255 return this;
9256 };
9257
9258 /**
9259 * @inheritdoc
9260 */
9261 OO.ui.InputWidget.prototype.restorePreInfuseState = function ( state ) {
9262 OO.ui.InputWidget.parent.prototype.restorePreInfuseState.call( this, state );
9263 if ( state.value !== undefined && state.value !== this.getValue() ) {
9264 this.setValue( state.value );
9265 }
9266 if ( state.focus ) {
9267 this.focus();
9268 }
9269 };
9270
9271 /**
9272 * Data widget intended for creating `<input type="hidden">` inputs.
9273 *
9274 * @class
9275 * @extends OO.ui.Widget
9276 *
9277 * @constructor
9278 * @param {Object} [config] Configuration options
9279 * @cfg {string} [value=''] The value of the input.
9280 * @cfg {string} [name=''] The value of the input’s HTML `name` attribute.
9281 */
9282 OO.ui.HiddenInputWidget = function OoUiHiddenInputWidget( config ) {
9283 // Configuration initialization
9284 config = $.extend( { value: '', name: '' }, config );
9285
9286 // Parent constructor
9287 OO.ui.HiddenInputWidget.parent.call( this, config );
9288
9289 // Initialization
9290 this.$element.attr( {
9291 type: 'hidden',
9292 value: config.value,
9293 name: config.name
9294 } );
9295 this.$element.removeAttr( 'aria-disabled' );
9296 };
9297
9298 /* Setup */
9299
9300 OO.inheritClass( OO.ui.HiddenInputWidget, OO.ui.Widget );
9301
9302 /* Static Properties */
9303
9304 /**
9305 * @static
9306 * @inheritdoc
9307 */
9308 OO.ui.HiddenInputWidget.static.tagName = 'input';
9309
9310 /**
9311 * ButtonInputWidget is used to submit HTML forms and is intended to be used within
9312 * a OO.ui.FormLayout. If you do not need the button to work with HTML forms, you probably
9313 * want to use OO.ui.ButtonWidget instead. Button input widgets can be rendered as either an
9314 * HTML `<button>` (the default) or an HTML `<input>` tags. See the
9315 * [OOUI documentation on MediaWiki] [1] for more information.
9316 *
9317 * @example
9318 * // A ButtonInputWidget rendered as an HTML button, the default.
9319 * var button = new OO.ui.ButtonInputWidget( {
9320 * label: 'Input button',
9321 * icon: 'check',
9322 * value: 'check'
9323 * } );
9324 * $( document.body ).append( button.$element );
9325 *
9326 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs#Button_inputs
9327 *
9328 * @class
9329 * @extends OO.ui.InputWidget
9330 * @mixins OO.ui.mixin.ButtonElement
9331 * @mixins OO.ui.mixin.IconElement
9332 * @mixins OO.ui.mixin.IndicatorElement
9333 * @mixins OO.ui.mixin.LabelElement
9334 * @mixins OO.ui.mixin.FlaggedElement
9335 *
9336 * @constructor
9337 * @param {Object} [config] Configuration options
9338 * @cfg {string} [type='button'] The value of the HTML `'type'` attribute:
9339 * 'button', 'submit' or 'reset'.
9340 * @cfg {boolean} [useInputTag=false] Use an `<input>` tag instead of a `<button>` tag, the default.
9341 * Widgets configured to be an `<input>` do not support {@link #icon icons} and
9342 * {@link #indicator indicators},
9343 * non-plaintext {@link #label labels}, or {@link #value values}. In general, useInputTag should
9344 * only be set to `true` when there’s need to support IE 6 in a form with multiple buttons.
9345 */
9346 OO.ui.ButtonInputWidget = function OoUiButtonInputWidget( config ) {
9347 // Configuration initialization
9348 config = $.extend( { type: 'button', useInputTag: false }, config );
9349
9350 // See InputWidget#reusePreInfuseDOM about config.$input
9351 if ( config.$input ) {
9352 config.$input.empty();
9353 }
9354
9355 // Properties (must be set before parent constructor, which calls #setValue)
9356 this.useInputTag = config.useInputTag;
9357
9358 // Parent constructor
9359 OO.ui.ButtonInputWidget.parent.call( this, config );
9360
9361 // Mixin constructors
9362 OO.ui.mixin.ButtonElement.call( this, $.extend( {
9363 $button: this.$input
9364 }, config ) );
9365 OO.ui.mixin.IconElement.call( this, config );
9366 OO.ui.mixin.IndicatorElement.call( this, config );
9367 OO.ui.mixin.LabelElement.call( this, config );
9368 OO.ui.mixin.FlaggedElement.call( this, config );
9369
9370 // Initialization
9371 if ( !config.useInputTag ) {
9372 this.$input.append( this.$icon, this.$label, this.$indicator );
9373 }
9374 this.$element.addClass( 'oo-ui-buttonInputWidget' );
9375 };
9376
9377 /* Setup */
9378
9379 OO.inheritClass( OO.ui.ButtonInputWidget, OO.ui.InputWidget );
9380 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.ButtonElement );
9381 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.IconElement );
9382 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.IndicatorElement );
9383 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.LabelElement );
9384 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.FlaggedElement );
9385
9386 /* Static Properties */
9387
9388 /**
9389 * @static
9390 * @inheritdoc
9391 */
9392 OO.ui.ButtonInputWidget.static.tagName = 'span';
9393
9394 /* Methods */
9395
9396 /**
9397 * @inheritdoc
9398 * @protected
9399 */
9400 OO.ui.ButtonInputWidget.prototype.getInputElement = function ( config ) {
9401 var type;
9402 type = [ 'button', 'submit', 'reset' ].indexOf( config.type ) !== -1 ? config.type : 'button';
9403 return $( '<' + ( config.useInputTag ? 'input' : 'button' ) + ' type="' + type + '">' );
9404 };
9405
9406 /**
9407 * Set label value.
9408 *
9409 * If #useInputTag is `true`, the label is set as the `value` of the `<input>` tag.
9410 *
9411 * @param {jQuery|string|Function|null} label Label nodes, text, a function that returns nodes or
9412 * text, or `null` for no label
9413 * @chainable
9414 * @return {OO.ui.Widget} The widget, for chaining
9415 */
9416 OO.ui.ButtonInputWidget.prototype.setLabel = function ( label ) {
9417 if ( typeof label === 'function' ) {
9418 label = OO.ui.resolveMsg( label );
9419 }
9420
9421 if ( this.useInputTag ) {
9422 // Discard non-plaintext labels
9423 if ( typeof label !== 'string' ) {
9424 label = '';
9425 }
9426
9427 this.$input.val( label );
9428 }
9429
9430 return OO.ui.mixin.LabelElement.prototype.setLabel.call( this, label );
9431 };
9432
9433 /**
9434 * Set the value of the input.
9435 *
9436 * This method is disabled for button inputs configured as {@link #useInputTag <input> tags}, as
9437 * they do not support {@link #value values}.
9438 *
9439 * @param {string} value New value
9440 * @chainable
9441 * @return {OO.ui.Widget} The widget, for chaining
9442 */
9443 OO.ui.ButtonInputWidget.prototype.setValue = function ( value ) {
9444 if ( !this.useInputTag ) {
9445 OO.ui.ButtonInputWidget.parent.prototype.setValue.call( this, value );
9446 }
9447 return this;
9448 };
9449
9450 /**
9451 * @inheritdoc
9452 */
9453 OO.ui.ButtonInputWidget.prototype.getInputId = function () {
9454 // Disable generating `<label>` elements for buttons. One would very rarely need additional
9455 // label for a button, and it's already a big clickable target, and it causes
9456 // unexpected rendering.
9457 return null;
9458 };
9459
9460 /**
9461 * CheckboxInputWidgets, like HTML checkboxes, can be selected and/or configured with a value.
9462 * Note that these {@link OO.ui.InputWidget input widgets} are best laid out
9463 * in {@link OO.ui.FieldLayout field layouts} that use the {@link OO.ui.FieldLayout#align inline}
9464 * alignment. For more information, please see the [OOUI documentation on MediaWiki][1].
9465 *
9466 * This widget can be used inside an HTML form, such as a OO.ui.FormLayout.
9467 *
9468 * @example
9469 * // An example of selected, unselected, and disabled checkbox inputs.
9470 * var checkbox1 = new OO.ui.CheckboxInputWidget( {
9471 * value: 'a',
9472 * selected: true
9473 * } ),
9474 * checkbox2 = new OO.ui.CheckboxInputWidget( {
9475 * value: 'b'
9476 * } ),
9477 * checkbox3 = new OO.ui.CheckboxInputWidget( {
9478 * value:'c',
9479 * disabled: true
9480 * } ),
9481 * // Create a fieldset layout with fields for each checkbox.
9482 * fieldset = new OO.ui.FieldsetLayout( {
9483 * label: 'Checkboxes'
9484 * } );
9485 * fieldset.addItems( [
9486 * new OO.ui.FieldLayout( checkbox1, { label: 'Selected checkbox', align: 'inline' } ),
9487 * new OO.ui.FieldLayout( checkbox2, { label: 'Unselected checkbox', align: 'inline' } ),
9488 * new OO.ui.FieldLayout( checkbox3, { label: 'Disabled checkbox', align: 'inline' } ),
9489 * ] );
9490 * $( document.body ).append( fieldset.$element );
9491 *
9492 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
9493 *
9494 * @class
9495 * @extends OO.ui.InputWidget
9496 *
9497 * @constructor
9498 * @param {Object} [config] Configuration options
9499 * @cfg {boolean} [selected=false] Select the checkbox initially. By default, the checkbox is
9500 * not selected.
9501 * @cfg {boolean} [indeterminate=false] Whether the checkbox is in the indeterminate state.
9502 */
9503 OO.ui.CheckboxInputWidget = function OoUiCheckboxInputWidget( config ) {
9504 // Configuration initialization
9505 config = config || {};
9506
9507 // Parent constructor
9508 OO.ui.CheckboxInputWidget.parent.call( this, config );
9509
9510 // Properties
9511 this.checkIcon = new OO.ui.IconWidget( {
9512 icon: 'check',
9513 classes: [ 'oo-ui-checkboxInputWidget-checkIcon' ]
9514 } );
9515
9516 // Initialization
9517 this.$element
9518 .addClass( 'oo-ui-checkboxInputWidget' )
9519 // Required for pretty styling in WikimediaUI theme
9520 .append( this.checkIcon.$element );
9521 this.setSelected( config.selected !== undefined ? config.selected : false );
9522 this.setIndeterminate( config.indeterminate !== undefined ? config.indeterminate : false );
9523 };
9524
9525 /* Setup */
9526
9527 OO.inheritClass( OO.ui.CheckboxInputWidget, OO.ui.InputWidget );
9528
9529 /* Events */
9530
9531 /**
9532 * @event change
9533 *
9534 * A change event is emitted when the state of the input changes.
9535 *
9536 * @param {boolean} selected
9537 * @param {boolean} indeterminate
9538 */
9539
9540 /* Static Properties */
9541
9542 /**
9543 * @static
9544 * @inheritdoc
9545 */
9546 OO.ui.CheckboxInputWidget.static.tagName = 'span';
9547
9548 /* Static Methods */
9549
9550 /**
9551 * @inheritdoc
9552 */
9553 OO.ui.CheckboxInputWidget.static.gatherPreInfuseState = function ( node, config ) {
9554 var state = OO.ui.CheckboxInputWidget.parent.static.gatherPreInfuseState( node, config );
9555 state.checked = config.$input.prop( 'checked' );
9556 return state;
9557 };
9558
9559 /* Methods */
9560
9561 /**
9562 * @inheritdoc
9563 * @protected
9564 */
9565 OO.ui.CheckboxInputWidget.prototype.getInputElement = function () {
9566 return $( '<input>' ).attr( 'type', 'checkbox' );
9567 };
9568
9569 /**
9570 * @inheritdoc
9571 */
9572 OO.ui.CheckboxInputWidget.prototype.onEdit = function () {
9573 var widget = this;
9574 if ( !this.isDisabled() ) {
9575 // Allow the stack to clear so the value will be updated
9576 setTimeout( function () {
9577 widget.setSelected( widget.$input.prop( 'checked' ) );
9578 widget.setIndeterminate( widget.$input.prop( 'indeterminate' ) );
9579 } );
9580 }
9581 };
9582
9583 /**
9584 * Set selection state of this checkbox.
9585 *
9586 * @param {boolean} state Selected state
9587 * @param {boolean} internal Used for internal calls to suppress events
9588 * @chainable
9589 * @return {OO.ui.CheckboxInputWidget} The widget, for chaining
9590 */
9591 OO.ui.CheckboxInputWidget.prototype.setSelected = function ( state, internal ) {
9592 state = !!state;
9593 if ( this.selected !== state ) {
9594 this.selected = state;
9595 this.$input.prop( 'checked', this.selected );
9596 if ( !internal ) {
9597 this.setIndeterminate( false, true );
9598 this.emit( 'change', this.selected, this.indeterminate );
9599 }
9600 }
9601 // The first time that the selection state is set (probably while constructing the widget),
9602 // remember it in defaultSelected. This property can be later used to check whether
9603 // the selection state of the input has been changed since it was created.
9604 if ( this.defaultSelected === undefined ) {
9605 this.defaultSelected = this.selected;
9606 this.$input[ 0 ].defaultChecked = this.defaultSelected;
9607 }
9608 return this;
9609 };
9610
9611 /**
9612 * Check if this checkbox is selected.
9613 *
9614 * @return {boolean} Checkbox is selected
9615 */
9616 OO.ui.CheckboxInputWidget.prototype.isSelected = function () {
9617 // Resynchronize our internal data with DOM data. Other scripts executing on the page can modify
9618 // it, and we won't know unless they're kind enough to trigger a 'change' event.
9619 var selected = this.$input.prop( 'checked' );
9620 if ( this.selected !== selected ) {
9621 this.setSelected( selected );
9622 }
9623 return this.selected;
9624 };
9625
9626 /**
9627 * Set indeterminate state of this checkbox.
9628 *
9629 * @param {boolean} state Indeterminate state
9630 * @param {boolean} internal Used for internal calls to suppress events
9631 * @chainable
9632 * @return {OO.ui.CheckboxInputWidget} The widget, for chaining
9633 */
9634 OO.ui.CheckboxInputWidget.prototype.setIndeterminate = function ( state, internal ) {
9635 state = !!state;
9636 if ( this.indeterminate !== state ) {
9637 this.indeterminate = state;
9638 this.$input.prop( 'indeterminate', this.indeterminate );
9639 if ( !internal ) {
9640 this.setSelected( false, true );
9641 this.emit( 'change', this.selected, this.indeterminate );
9642 }
9643 }
9644 return this;
9645 };
9646
9647 /**
9648 * Check if this checkbox is selected.
9649 *
9650 * @return {boolean} Checkbox is selected
9651 */
9652 OO.ui.CheckboxInputWidget.prototype.isIndeterminate = function () {
9653 // Resynchronize our internal data with DOM data. Other scripts executing on the page can modify
9654 // it, and we won't know unless they're kind enough to trigger a 'change' event.
9655 var indeterminate = this.$input.prop( 'indeterminate' );
9656 if ( this.indeterminate !== indeterminate ) {
9657 this.setIndeterminate( indeterminate );
9658 }
9659 return this.indeterminate;
9660 };
9661
9662 /**
9663 * @inheritdoc
9664 */
9665 OO.ui.CheckboxInputWidget.prototype.simulateLabelClick = function () {
9666 if ( !this.isDisabled() ) {
9667 this.$handle.trigger( 'click' );
9668 }
9669 this.focus();
9670 };
9671
9672 /**
9673 * @inheritdoc
9674 */
9675 OO.ui.CheckboxInputWidget.prototype.restorePreInfuseState = function ( state ) {
9676 OO.ui.CheckboxInputWidget.parent.prototype.restorePreInfuseState.call( this, state );
9677 if ( state.checked !== undefined && state.checked !== this.isSelected() ) {
9678 this.setSelected( state.checked );
9679 }
9680 };
9681
9682 /**
9683 * DropdownInputWidget is a {@link OO.ui.DropdownWidget DropdownWidget} intended to be used
9684 * within an HTML form, such as a OO.ui.FormLayout. The selected value is synchronized with the
9685 * value of a hidden HTML `input` tag. Please see the [OOUI documentation on MediaWiki][1] for
9686 * more information about input widgets.
9687 *
9688 * A DropdownInputWidget always has a value (one of the options is always selected), unless there
9689 * are no options. If no `value` configuration option is provided, the first option is selected.
9690 * If you need a state representing no value (no option being selected), use a DropdownWidget.
9691 *
9692 * This and OO.ui.RadioSelectInputWidget support similar configuration options.
9693 *
9694 * @example
9695 * // A DropdownInputWidget with three options.
9696 * var dropdownInput = new OO.ui.DropdownInputWidget( {
9697 * options: [
9698 * { data: 'a', label: 'First' },
9699 * { data: 'b', label: 'Second', disabled: true },
9700 * { optgroup: 'Group label' },
9701 * { data: 'c', label: 'First sub-item)' }
9702 * ]
9703 * } );
9704 * $( document.body ).append( dropdownInput.$element );
9705 *
9706 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
9707 *
9708 * @class
9709 * @extends OO.ui.InputWidget
9710 *
9711 * @constructor
9712 * @param {Object} [config] Configuration options
9713 * @cfg {Object[]} [options=[]] Array of menu options in the format described above.
9714 * @cfg {Object} [dropdown] Configuration options for {@link OO.ui.DropdownWidget DropdownWidget}
9715 * @cfg {jQuery} [$overlay] Render the menu into a separate layer. This configuration is useful
9716 * in cases where the expanded menu is larger than its containing `<div>`. The specified overlay
9717 * layer is usually on top of the containing `<div>` and has a larger area. By default, the menu
9718 * uses relative positioning.
9719 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
9720 */
9721 OO.ui.DropdownInputWidget = function OoUiDropdownInputWidget( config ) {
9722 // Configuration initialization
9723 config = config || {};
9724
9725 // Properties (must be done before parent constructor which calls #setDisabled)
9726 this.dropdownWidget = new OO.ui.DropdownWidget( $.extend(
9727 {
9728 $overlay: config.$overlay
9729 },
9730 config.dropdown
9731 ) );
9732 // Set up the options before parent constructor, which uses them to validate config.value.
9733 // Use this instead of setOptions() because this.$input is not set up yet.
9734 this.setOptionsData( config.options || [] );
9735
9736 // Parent constructor
9737 OO.ui.DropdownInputWidget.parent.call( this, config );
9738
9739 // Events
9740 this.dropdownWidget.getMenu().connect( this, {
9741 select: 'onMenuSelect'
9742 } );
9743
9744 // Initialization
9745 this.$element
9746 .addClass( 'oo-ui-dropdownInputWidget' )
9747 .append( this.dropdownWidget.$element );
9748 this.setTabIndexedElement( this.dropdownWidget.$tabIndexed );
9749 this.setTitledElement( this.dropdownWidget.$handle );
9750 };
9751
9752 /* Setup */
9753
9754 OO.inheritClass( OO.ui.DropdownInputWidget, OO.ui.InputWidget );
9755
9756 /* Methods */
9757
9758 /**
9759 * @inheritdoc
9760 * @protected
9761 */
9762 OO.ui.DropdownInputWidget.prototype.getInputElement = function () {
9763 return $( '<select>' );
9764 };
9765
9766 /**
9767 * Handles menu select events.
9768 *
9769 * @private
9770 * @param {OO.ui.MenuOptionWidget|null} item Selected menu item
9771 */
9772 OO.ui.DropdownInputWidget.prototype.onMenuSelect = function ( item ) {
9773 this.setValue( item ? item.getData() : '' );
9774 };
9775
9776 /**
9777 * @inheritdoc
9778 */
9779 OO.ui.DropdownInputWidget.prototype.setValue = function ( value ) {
9780 var selected;
9781 value = this.cleanUpValue( value );
9782 // Only allow setting values that are actually present in the dropdown
9783 selected = this.dropdownWidget.getMenu().findItemFromData( value ) ||
9784 this.dropdownWidget.getMenu().findFirstSelectableItem();
9785 this.dropdownWidget.getMenu().selectItem( selected );
9786 value = selected ? selected.getData() : '';
9787 OO.ui.DropdownInputWidget.parent.prototype.setValue.call( this, value );
9788 if ( this.optionsDirty ) {
9789 // We reached this from the constructor or from #setOptions.
9790 // We have to update the <select> element.
9791 this.updateOptionsInterface();
9792 }
9793 return this;
9794 };
9795
9796 /**
9797 * @inheritdoc
9798 */
9799 OO.ui.DropdownInputWidget.prototype.setDisabled = function ( state ) {
9800 this.dropdownWidget.setDisabled( state );
9801 OO.ui.DropdownInputWidget.parent.prototype.setDisabled.call( this, state );
9802 return this;
9803 };
9804
9805 /**
9806 * Set the options available for this input.
9807 *
9808 * @param {Object[]} options Array of menu options in the format `{ data: …, label: … }`
9809 * @chainable
9810 * @return {OO.ui.Widget} The widget, for chaining
9811 */
9812 OO.ui.DropdownInputWidget.prototype.setOptions = function ( options ) {
9813 var value = this.getValue();
9814
9815 this.setOptionsData( options );
9816
9817 // Re-set the value to update the visible interface (DropdownWidget and <select>).
9818 // In case the previous value is no longer an available option, select the first valid one.
9819 this.setValue( value );
9820
9821 return this;
9822 };
9823
9824 /**
9825 * Set the internal list of options, used e.g. by setValue() to see which options are allowed.
9826 *
9827 * This method may be called before the parent constructor, so various properties may not be
9828 * initialized yet.
9829 *
9830 * @param {Object[]} options Array of menu options (see #constructor for details).
9831 * @private
9832 */
9833 OO.ui.DropdownInputWidget.prototype.setOptionsData = function ( options ) {
9834 var optionWidgets, optIndex, opt, previousOptgroup, optionWidget, optValue,
9835 widget = this;
9836
9837 this.optionsDirty = true;
9838
9839 // Go through all the supplied option configs and create either
9840 // MenuSectionOption or MenuOption widgets from each.
9841 optionWidgets = [];
9842 for ( optIndex = 0; optIndex < options.length; optIndex++ ) {
9843 opt = options[ optIndex ];
9844
9845 if ( opt.optgroup !== undefined ) {
9846 // Create a <optgroup> menu item.
9847 optionWidget = widget.createMenuSectionOptionWidget( opt.optgroup );
9848 previousOptgroup = optionWidget;
9849
9850 } else {
9851 // Create a normal <option> menu item.
9852 optValue = widget.cleanUpValue( opt.data );
9853 optionWidget = widget.createMenuOptionWidget(
9854 optValue,
9855 opt.label !== undefined ? opt.label : optValue
9856 );
9857 }
9858
9859 // Disable the menu option if it is itself disabled or if its parent optgroup is disabled.
9860 if (
9861 opt.disabled !== undefined ||
9862 previousOptgroup instanceof OO.ui.MenuSectionOptionWidget &&
9863 previousOptgroup.isDisabled()
9864 ) {
9865 optionWidget.setDisabled( true );
9866 }
9867
9868 optionWidgets.push( optionWidget );
9869 }
9870
9871 this.dropdownWidget.getMenu().clearItems().addItems( optionWidgets );
9872 };
9873
9874 /**
9875 * Create a menu option widget.
9876 *
9877 * @protected
9878 * @param {string} data Item data
9879 * @param {string} label Item label
9880 * @return {OO.ui.MenuOptionWidget} Option widget
9881 */
9882 OO.ui.DropdownInputWidget.prototype.createMenuOptionWidget = function ( data, label ) {
9883 return new OO.ui.MenuOptionWidget( {
9884 data: data,
9885 label: label
9886 } );
9887 };
9888
9889 /**
9890 * Create a menu section option widget.
9891 *
9892 * @protected
9893 * @param {string} label Section item label
9894 * @return {OO.ui.MenuSectionOptionWidget} Menu section option widget
9895 */
9896 OO.ui.DropdownInputWidget.prototype.createMenuSectionOptionWidget = function ( label ) {
9897 return new OO.ui.MenuSectionOptionWidget( {
9898 label: label
9899 } );
9900 };
9901
9902 /**
9903 * Update the user-visible interface to match the internal list of options and value.
9904 *
9905 * This method must only be called after the parent constructor.
9906 *
9907 * @private
9908 */
9909 OO.ui.DropdownInputWidget.prototype.updateOptionsInterface = function () {
9910 var
9911 $optionsContainer = this.$input,
9912 defaultValue = this.defaultValue,
9913 widget = this;
9914
9915 this.$input.empty();
9916
9917 this.dropdownWidget.getMenu().getItems().forEach( function ( optionWidget ) {
9918 var $optionNode;
9919
9920 if ( !( optionWidget instanceof OO.ui.MenuSectionOptionWidget ) ) {
9921 $optionNode = $( '<option>' )
9922 .attr( 'value', optionWidget.getData() )
9923 .text( optionWidget.getLabel() );
9924
9925 // Remember original selection state. This property can be later used to check whether
9926 // the selection state of the input has been changed since it was created.
9927 $optionNode[ 0 ].defaultSelected = ( optionWidget.getData() === defaultValue );
9928
9929 $optionsContainer.append( $optionNode );
9930 } else {
9931 $optionNode = $( '<optgroup>' )
9932 .attr( 'label', optionWidget.getLabel() );
9933 widget.$input.append( $optionNode );
9934 $optionsContainer = $optionNode;
9935 }
9936
9937 // Disable the option or optgroup if required.
9938 if ( optionWidget.isDisabled() ) {
9939 $optionNode.prop( 'disabled', true );
9940 }
9941 } );
9942
9943 this.optionsDirty = false;
9944 };
9945
9946 /**
9947 * @inheritdoc
9948 */
9949 OO.ui.DropdownInputWidget.prototype.focus = function () {
9950 this.dropdownWidget.focus();
9951 return this;
9952 };
9953
9954 /**
9955 * @inheritdoc
9956 */
9957 OO.ui.DropdownInputWidget.prototype.blur = function () {
9958 this.dropdownWidget.blur();
9959 return this;
9960 };
9961
9962 /**
9963 * RadioInputWidget creates a single radio button. Because radio buttons are usually used as a set,
9964 * in most cases you will want to use a {@link OO.ui.RadioSelectWidget radio select}
9965 * with {@link OO.ui.RadioOptionWidget radio options} instead of this class. For more information,
9966 * please see the [OOUI documentation on MediaWiki][1].
9967 *
9968 * This widget can be used inside an HTML form, such as a OO.ui.FormLayout.
9969 *
9970 * @example
9971 * // An example of selected, unselected, and disabled radio inputs
9972 * var radio1 = new OO.ui.RadioInputWidget( {
9973 * value: 'a',
9974 * selected: true
9975 * } );
9976 * var radio2 = new OO.ui.RadioInputWidget( {
9977 * value: 'b'
9978 * } );
9979 * var radio3 = new OO.ui.RadioInputWidget( {
9980 * value: 'c',
9981 * disabled: true
9982 * } );
9983 * // Create a fieldset layout with fields for each radio button.
9984 * var fieldset = new OO.ui.FieldsetLayout( {
9985 * label: 'Radio inputs'
9986 * } );
9987 * fieldset.addItems( [
9988 * new OO.ui.FieldLayout( radio1, { label: 'Selected', align: 'inline' } ),
9989 * new OO.ui.FieldLayout( radio2, { label: 'Unselected', align: 'inline' } ),
9990 * new OO.ui.FieldLayout( radio3, { label: 'Disabled', align: 'inline' } ),
9991 * ] );
9992 * $( document.body ).append( fieldset.$element );
9993 *
9994 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
9995 *
9996 * @class
9997 * @extends OO.ui.InputWidget
9998 *
9999 * @constructor
10000 * @param {Object} [config] Configuration options
10001 * @cfg {boolean} [selected=false] Select the radio button initially. By default, the radio button
10002 * is not selected.
10003 */
10004 OO.ui.RadioInputWidget = function OoUiRadioInputWidget( config ) {
10005 // Configuration initialization
10006 config = config || {};
10007
10008 // Parent constructor
10009 OO.ui.RadioInputWidget.parent.call( this, config );
10010
10011 // Initialization
10012 this.$element
10013 .addClass( 'oo-ui-radioInputWidget' )
10014 // Required for pretty styling in WikimediaUI theme
10015 .append( $( '<span>' ) );
10016 this.setSelected( config.selected !== undefined ? config.selected : false );
10017 };
10018
10019 /* Setup */
10020
10021 OO.inheritClass( OO.ui.RadioInputWidget, OO.ui.InputWidget );
10022
10023 /* Static Properties */
10024
10025 /**
10026 * @static
10027 * @inheritdoc
10028 */
10029 OO.ui.RadioInputWidget.static.tagName = 'span';
10030
10031 /* Static Methods */
10032
10033 /**
10034 * @inheritdoc
10035 */
10036 OO.ui.RadioInputWidget.static.gatherPreInfuseState = function ( node, config ) {
10037 var state = OO.ui.RadioInputWidget.parent.static.gatherPreInfuseState( node, config );
10038 state.checked = config.$input.prop( 'checked' );
10039 return state;
10040 };
10041
10042 /* Methods */
10043
10044 /**
10045 * @inheritdoc
10046 * @protected
10047 */
10048 OO.ui.RadioInputWidget.prototype.getInputElement = function () {
10049 return $( '<input>' ).attr( 'type', 'radio' );
10050 };
10051
10052 /**
10053 * @inheritdoc
10054 */
10055 OO.ui.RadioInputWidget.prototype.onEdit = function () {
10056 // RadioInputWidget doesn't track its state.
10057 };
10058
10059 /**
10060 * Set selection state of this radio button.
10061 *
10062 * @param {boolean} state `true` for selected
10063 * @chainable
10064 * @return {OO.ui.Widget} The widget, for chaining
10065 */
10066 OO.ui.RadioInputWidget.prototype.setSelected = function ( state ) {
10067 // RadioInputWidget doesn't track its state.
10068 this.$input.prop( 'checked', state );
10069 // The first time that the selection state is set (probably while constructing the widget),
10070 // remember it in defaultSelected. This property can be later used to check whether
10071 // the selection state of the input has been changed since it was created.
10072 if ( this.defaultSelected === undefined ) {
10073 this.defaultSelected = state;
10074 this.$input[ 0 ].defaultChecked = this.defaultSelected;
10075 }
10076 return this;
10077 };
10078
10079 /**
10080 * Check if this radio button is selected.
10081 *
10082 * @return {boolean} Radio is selected
10083 */
10084 OO.ui.RadioInputWidget.prototype.isSelected = function () {
10085 return this.$input.prop( 'checked' );
10086 };
10087
10088 /**
10089 * @inheritdoc
10090 */
10091 OO.ui.RadioInputWidget.prototype.simulateLabelClick = function () {
10092 if ( !this.isDisabled() ) {
10093 this.$input.trigger( 'click' );
10094 }
10095 this.focus();
10096 };
10097
10098 /**
10099 * @inheritdoc
10100 */
10101 OO.ui.RadioInputWidget.prototype.restorePreInfuseState = function ( state ) {
10102 OO.ui.RadioInputWidget.parent.prototype.restorePreInfuseState.call( this, state );
10103 if ( state.checked !== undefined && state.checked !== this.isSelected() ) {
10104 this.setSelected( state.checked );
10105 }
10106 };
10107
10108 /**
10109 * RadioSelectInputWidget is a {@link OO.ui.RadioSelectWidget RadioSelectWidget} intended to be
10110 * used within an HTML form, such as a OO.ui.FormLayout. The selected value is synchronized with
10111 * the value of a hidden HTML `input` tag. Please see the [OOUI documentation on MediaWiki][1] for
10112 * more information about input widgets.
10113 *
10114 * This and OO.ui.DropdownInputWidget support similar configuration options.
10115 *
10116 * @example
10117 * // A RadioSelectInputWidget with three options
10118 * var radioSelectInput = new OO.ui.RadioSelectInputWidget( {
10119 * options: [
10120 * { data: 'a', label: 'First' },
10121 * { data: 'b', label: 'Second'},
10122 * { data: 'c', label: 'Third' }
10123 * ]
10124 * } );
10125 * $( document.body ).append( radioSelectInput.$element );
10126 *
10127 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
10128 *
10129 * @class
10130 * @extends OO.ui.InputWidget
10131 *
10132 * @constructor
10133 * @param {Object} [config] Configuration options
10134 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
10135 */
10136 OO.ui.RadioSelectInputWidget = function OoUiRadioSelectInputWidget( config ) {
10137 // Configuration initialization
10138 config = config || {};
10139
10140 // Properties (must be done before parent constructor which calls #setDisabled)
10141 this.radioSelectWidget = new OO.ui.RadioSelectWidget();
10142 // Set up the options before parent constructor, which uses them to validate config.value.
10143 // Use this instead of setOptions() because this.$input is not set up yet
10144 this.setOptionsData( config.options || [] );
10145
10146 // Parent constructor
10147 OO.ui.RadioSelectInputWidget.parent.call( this, config );
10148
10149 // Events
10150 this.radioSelectWidget.connect( this, {
10151 select: 'onMenuSelect'
10152 } );
10153
10154 // Initialization
10155 this.$element
10156 .addClass( 'oo-ui-radioSelectInputWidget' )
10157 .append( this.radioSelectWidget.$element );
10158 this.setTabIndexedElement( this.radioSelectWidget.$tabIndexed );
10159 };
10160
10161 /* Setup */
10162
10163 OO.inheritClass( OO.ui.RadioSelectInputWidget, OO.ui.InputWidget );
10164
10165 /* Static Methods */
10166
10167 /**
10168 * @inheritdoc
10169 */
10170 OO.ui.RadioSelectInputWidget.static.gatherPreInfuseState = function ( node, config ) {
10171 var state = OO.ui.RadioSelectInputWidget.parent.static.gatherPreInfuseState( node, config );
10172 state.value = $( node ).find( '.oo-ui-radioInputWidget .oo-ui-inputWidget-input:checked' ).val();
10173 return state;
10174 };
10175
10176 /**
10177 * @inheritdoc
10178 */
10179 OO.ui.RadioSelectInputWidget.static.reusePreInfuseDOM = function ( node, config ) {
10180 config = OO.ui.RadioSelectInputWidget.parent.static.reusePreInfuseDOM( node, config );
10181 // Cannot reuse the `<input type=radio>` set
10182 delete config.$input;
10183 return config;
10184 };
10185
10186 /* Methods */
10187
10188 /**
10189 * @inheritdoc
10190 * @protected
10191 */
10192 OO.ui.RadioSelectInputWidget.prototype.getInputElement = function () {
10193 // Use this instead of <input type="hidden">, because hidden inputs do not have separate
10194 // 'value' and 'defaultValue' properties, and InputWidget wants to handle 'defaultValue'.
10195 return $( '<input>' ).addClass( 'oo-ui-element-hidden' );
10196 };
10197
10198 /**
10199 * Handles menu select events.
10200 *
10201 * @private
10202 * @param {OO.ui.RadioOptionWidget} item Selected menu item
10203 */
10204 OO.ui.RadioSelectInputWidget.prototype.onMenuSelect = function ( item ) {
10205 this.setValue( item.getData() );
10206 };
10207
10208 /**
10209 * @inheritdoc
10210 */
10211 OO.ui.RadioSelectInputWidget.prototype.setValue = function ( value ) {
10212 var selected;
10213 value = this.cleanUpValue( value );
10214 // Only allow setting values that are actually present in the dropdown
10215 selected = this.radioSelectWidget.findItemFromData( value ) ||
10216 this.radioSelectWidget.findFirstSelectableItem();
10217 this.radioSelectWidget.selectItem( selected );
10218 value = selected ? selected.getData() : '';
10219 OO.ui.RadioSelectInputWidget.parent.prototype.setValue.call( this, value );
10220 return this;
10221 };
10222
10223 /**
10224 * @inheritdoc
10225 */
10226 OO.ui.RadioSelectInputWidget.prototype.setDisabled = function ( state ) {
10227 this.radioSelectWidget.setDisabled( state );
10228 OO.ui.RadioSelectInputWidget.parent.prototype.setDisabled.call( this, state );
10229 return this;
10230 };
10231
10232 /**
10233 * Set the options available for this input.
10234 *
10235 * @param {Object[]} options Array of menu options in the format `{ data: …, label: … }`
10236 * @chainable
10237 * @return {OO.ui.Widget} The widget, for chaining
10238 */
10239 OO.ui.RadioSelectInputWidget.prototype.setOptions = function ( options ) {
10240 var value = this.getValue();
10241
10242 this.setOptionsData( options );
10243
10244 // Re-set the value to update the visible interface (RadioSelectWidget).
10245 // In case the previous value is no longer an available option, select the first valid one.
10246 this.setValue( value );
10247
10248 return this;
10249 };
10250
10251 /**
10252 * Set the internal list of options, used e.g. by setValue() to see which options are allowed.
10253 *
10254 * This method may be called before the parent constructor, so various properties may not be
10255 * intialized yet.
10256 *
10257 * @param {Object[]} options Array of menu options in the format `{ data: …, label: … }`
10258 * @private
10259 */
10260 OO.ui.RadioSelectInputWidget.prototype.setOptionsData = function ( options ) {
10261 var widget = this;
10262
10263 this.radioSelectWidget
10264 .clearItems()
10265 .addItems( options.map( function ( opt ) {
10266 var optValue = widget.cleanUpValue( opt.data );
10267 return new OO.ui.RadioOptionWidget( {
10268 data: optValue,
10269 label: opt.label !== undefined ? opt.label : optValue
10270 } );
10271 } ) );
10272 };
10273
10274 /**
10275 * @inheritdoc
10276 */
10277 OO.ui.RadioSelectInputWidget.prototype.focus = function () {
10278 this.radioSelectWidget.focus();
10279 return this;
10280 };
10281
10282 /**
10283 * @inheritdoc
10284 */
10285 OO.ui.RadioSelectInputWidget.prototype.blur = function () {
10286 this.radioSelectWidget.blur();
10287 return this;
10288 };
10289
10290 /**
10291 * CheckboxMultiselectInputWidget is a
10292 * {@link OO.ui.CheckboxMultiselectWidget CheckboxMultiselectWidget} intended to be used within a
10293 * HTML form, such as a OO.ui.FormLayout. The selected values are synchronized with the value of
10294 * HTML `<input type=checkbox>` tags. Please see the [OOUI documentation on MediaWiki][1] for
10295 * more information about input widgets.
10296 *
10297 * @example
10298 * // A CheckboxMultiselectInputWidget with three options.
10299 * var multiselectInput = new OO.ui.CheckboxMultiselectInputWidget( {
10300 * options: [
10301 * { data: 'a', label: 'First' },
10302 * { data: 'b', label: 'Second' },
10303 * { data: 'c', label: 'Third' }
10304 * ]
10305 * } );
10306 * $( document.body ).append( multiselectInput.$element );
10307 *
10308 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
10309 *
10310 * @class
10311 * @extends OO.ui.InputWidget
10312 *
10313 * @constructor
10314 * @param {Object} [config] Configuration options
10315 * @cfg {Object[]} [options=[]] Array of menu options in the format
10316 * `{ data: …, label: …, disabled: … }`
10317 */
10318 OO.ui.CheckboxMultiselectInputWidget = function OoUiCheckboxMultiselectInputWidget( config ) {
10319 // Configuration initialization
10320 config = config || {};
10321
10322 // Properties (must be done before parent constructor which calls #setDisabled)
10323 this.checkboxMultiselectWidget = new OO.ui.CheckboxMultiselectWidget();
10324 // Must be set before the #setOptionsData call below
10325 this.inputName = config.name;
10326 // Set up the options before parent constructor, which uses them to validate config.value.
10327 // Use this instead of setOptions() because this.$input is not set up yet
10328 this.setOptionsData( config.options || [] );
10329
10330 // Parent constructor
10331 OO.ui.CheckboxMultiselectInputWidget.parent.call( this, config );
10332
10333 // Events
10334 this.checkboxMultiselectWidget.connect( this, {
10335 select: 'onCheckboxesSelect'
10336 } );
10337
10338 // Initialization
10339 this.$element
10340 .addClass( 'oo-ui-checkboxMultiselectInputWidget' )
10341 .append( this.checkboxMultiselectWidget.$element );
10342 // We don't use this.$input, but rather the CheckboxInputWidgets inside each option
10343 this.$input.detach();
10344 };
10345
10346 /* Setup */
10347
10348 OO.inheritClass( OO.ui.CheckboxMultiselectInputWidget, OO.ui.InputWidget );
10349
10350 /* Static Methods */
10351
10352 /**
10353 * @inheritdoc
10354 */
10355 OO.ui.CheckboxMultiselectInputWidget.static.gatherPreInfuseState = function ( node, config ) {
10356 var state = OO.ui.CheckboxMultiselectInputWidget.parent.static.gatherPreInfuseState(
10357 node, config
10358 );
10359 state.value = $( node ).find( '.oo-ui-checkboxInputWidget .oo-ui-inputWidget-input:checked' )
10360 .toArray().map( function ( el ) { return el.value; } );
10361 return state;
10362 };
10363
10364 /**
10365 * @inheritdoc
10366 */
10367 OO.ui.CheckboxMultiselectInputWidget.static.reusePreInfuseDOM = function ( node, config ) {
10368 config = OO.ui.CheckboxMultiselectInputWidget.parent.static.reusePreInfuseDOM( node, config );
10369 // Cannot reuse the `<input type=checkbox>` set
10370 delete config.$input;
10371 return config;
10372 };
10373
10374 /* Methods */
10375
10376 /**
10377 * @inheritdoc
10378 * @protected
10379 */
10380 OO.ui.CheckboxMultiselectInputWidget.prototype.getInputElement = function () {
10381 // Actually unused
10382 return $( '<unused>' );
10383 };
10384
10385 /**
10386 * Handles CheckboxMultiselectWidget select events.
10387 *
10388 * @private
10389 */
10390 OO.ui.CheckboxMultiselectInputWidget.prototype.onCheckboxesSelect = function () {
10391 this.setValue( this.checkboxMultiselectWidget.findSelectedItemsData() );
10392 };
10393
10394 /**
10395 * @inheritdoc
10396 */
10397 OO.ui.CheckboxMultiselectInputWidget.prototype.getValue = function () {
10398 var value = this.$element.find( '.oo-ui-checkboxInputWidget .oo-ui-inputWidget-input:checked' )
10399 .toArray().map( function ( el ) { return el.value; } );
10400 if ( this.value !== value ) {
10401 this.setValue( value );
10402 }
10403 return this.value;
10404 };
10405
10406 /**
10407 * @inheritdoc
10408 */
10409 OO.ui.CheckboxMultiselectInputWidget.prototype.setValue = function ( value ) {
10410 value = this.cleanUpValue( value );
10411 this.checkboxMultiselectWidget.selectItemsByData( value );
10412 OO.ui.CheckboxMultiselectInputWidget.parent.prototype.setValue.call( this, value );
10413 if ( this.optionsDirty ) {
10414 // We reached this from the constructor or from #setOptions.
10415 // We have to update the <select> element.
10416 this.updateOptionsInterface();
10417 }
10418 return this;
10419 };
10420
10421 /**
10422 * Clean up incoming value.
10423 *
10424 * @param {string[]} value Original value
10425 * @return {string[]} Cleaned up value
10426 */
10427 OO.ui.CheckboxMultiselectInputWidget.prototype.cleanUpValue = function ( value ) {
10428 var i, singleValue,
10429 cleanValue = [];
10430 if ( !Array.isArray( value ) ) {
10431 return cleanValue;
10432 }
10433 for ( i = 0; i < value.length; i++ ) {
10434 singleValue = OO.ui.CheckboxMultiselectInputWidget.parent.prototype.cleanUpValue
10435 .call( this, value[ i ] );
10436 // Remove options that we don't have here
10437 if ( !this.checkboxMultiselectWidget.findItemFromData( singleValue ) ) {
10438 continue;
10439 }
10440 cleanValue.push( singleValue );
10441 }
10442 return cleanValue;
10443 };
10444
10445 /**
10446 * @inheritdoc
10447 */
10448 OO.ui.CheckboxMultiselectInputWidget.prototype.setDisabled = function ( state ) {
10449 this.checkboxMultiselectWidget.setDisabled( state );
10450 OO.ui.CheckboxMultiselectInputWidget.parent.prototype.setDisabled.call( this, state );
10451 return this;
10452 };
10453
10454 /**
10455 * Set the options available for this input.
10456 *
10457 * @param {Object[]} options Array of menu options in the format
10458 * `{ data: …, label: …, disabled: … }`
10459 * @chainable
10460 * @return {OO.ui.Widget} The widget, for chaining
10461 */
10462 OO.ui.CheckboxMultiselectInputWidget.prototype.setOptions = function ( options ) {
10463 var value = this.getValue();
10464
10465 this.setOptionsData( options );
10466
10467 // Re-set the value to update the visible interface (CheckboxMultiselectWidget).
10468 // This will also get rid of any stale options that we just removed.
10469 this.setValue( value );
10470
10471 return this;
10472 };
10473
10474 /**
10475 * Set the internal list of options, used e.g. by setValue() to see which options are allowed.
10476 *
10477 * This method may be called before the parent constructor, so various properties may not be
10478 * intialized yet.
10479 *
10480 * @param {Object[]} options Array of menu options in the format
10481 * `{ data: …, label: … }`
10482 * @private
10483 */
10484 OO.ui.CheckboxMultiselectInputWidget.prototype.setOptionsData = function ( options ) {
10485 var widget = this;
10486
10487 this.optionsDirty = true;
10488
10489 this.checkboxMultiselectWidget
10490 .clearItems()
10491 .addItems( options.map( function ( opt ) {
10492 var optValue, item, optDisabled;
10493 optValue = OO.ui.CheckboxMultiselectInputWidget.parent.prototype.cleanUpValue
10494 .call( widget, opt.data );
10495 optDisabled = opt.disabled !== undefined ? opt.disabled : false;
10496 item = new OO.ui.CheckboxMultioptionWidget( {
10497 data: optValue,
10498 label: opt.label !== undefined ? opt.label : optValue,
10499 disabled: optDisabled
10500 } );
10501 // Set the 'name' and 'value' for form submission
10502 item.checkbox.$input.attr( 'name', widget.inputName );
10503 item.checkbox.setValue( optValue );
10504 return item;
10505 } ) );
10506 };
10507
10508 /**
10509 * Update the user-visible interface to match the internal list of options and value.
10510 *
10511 * This method must only be called after the parent constructor.
10512 *
10513 * @private
10514 */
10515 OO.ui.CheckboxMultiselectInputWidget.prototype.updateOptionsInterface = function () {
10516 var defaultValue = this.defaultValue;
10517
10518 this.checkboxMultiselectWidget.getItems().forEach( function ( item ) {
10519 // Remember original selection state. This property can be later used to check whether
10520 // the selection state of the input has been changed since it was created.
10521 var isDefault = defaultValue.indexOf( item.getData() ) !== -1;
10522 item.checkbox.defaultSelected = isDefault;
10523 item.checkbox.$input[ 0 ].defaultChecked = isDefault;
10524 } );
10525
10526 this.optionsDirty = false;
10527 };
10528
10529 /**
10530 * @inheritdoc
10531 */
10532 OO.ui.CheckboxMultiselectInputWidget.prototype.focus = function () {
10533 this.checkboxMultiselectWidget.focus();
10534 return this;
10535 };
10536
10537 /**
10538 * TextInputWidgets, like HTML text inputs, can be configured with options that customize the
10539 * size of the field as well as its presentation. In addition, these widgets can be configured
10540 * with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators}, an
10541 * optional validation-pattern (used to determine if an input value is valid or not) and an input
10542 * filter, which modifies incoming values rather than validating them.
10543 * Please see the [OOUI documentation on MediaWiki] [1] for more information and examples.
10544 *
10545 * This widget can be used inside an HTML form, such as a OO.ui.FormLayout.
10546 *
10547 * @example
10548 * // A TextInputWidget.
10549 * var textInput = new OO.ui.TextInputWidget( {
10550 * value: 'Text input'
10551 * } );
10552 * $( document.body ).append( textInput.$element );
10553 *
10554 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
10555 *
10556 * @class
10557 * @extends OO.ui.InputWidget
10558 * @mixins OO.ui.mixin.IconElement
10559 * @mixins OO.ui.mixin.IndicatorElement
10560 * @mixins OO.ui.mixin.PendingElement
10561 * @mixins OO.ui.mixin.LabelElement
10562 * @mixins OO.ui.mixin.FlaggedElement
10563 *
10564 * @constructor
10565 * @param {Object} [config] Configuration options
10566 * @cfg {string} [type='text'] The value of the HTML `type` attribute: 'text', 'password'
10567 * 'email', 'url' or 'number'.
10568 * @cfg {string} [placeholder] Placeholder text
10569 * @cfg {boolean} [autofocus=false] Use an HTML `autofocus` attribute to
10570 * instruct the browser to focus this widget.
10571 * @cfg {boolean} [readOnly=false] Prevent changes to the value of the text input.
10572 * @cfg {number} [maxLength] Maximum number of characters allowed in the input.
10573 *
10574 * For unfortunate historical reasons, this counts the number of UTF-16 code units rather than
10575 * Unicode codepoints, which means that codepoints outside the Basic Multilingual Plane (e.g.
10576 * many emojis) count as 2 characters each.
10577 * @cfg {string} [labelPosition='after'] The position of the inline label relative to that of
10578 * the value or placeholder text: `'before'` or `'after'`
10579 * @cfg {boolean} [required=false] Mark the field as required with `true`. Implies `indicator:
10580 * 'required'`. Note that `false` & setting `indicator: 'required' will result in no indicator
10581 * shown.
10582 * @cfg {boolean} [autocomplete=true] Should the browser support autocomplete for this field
10583 * @cfg {boolean} [spellcheck] Should the browser support spellcheck for this field (`undefined`
10584 * means leaving it up to the browser).
10585 * @cfg {RegExp|Function|string} [validate] Validation pattern: when string, a symbolic name of a
10586 * pattern defined by the class: 'non-empty' (the value cannot be an empty string) or 'integer'
10587 * (the value must contain only numbers); when RegExp, a regular expression that must match the
10588 * value for it to be considered valid; when Function, a function receiving the value as parameter
10589 * that must return true, or promise resolving to true, for it to be considered valid.
10590 */
10591 OO.ui.TextInputWidget = function OoUiTextInputWidget( config ) {
10592 // Configuration initialization
10593 config = $.extend( {
10594 type: 'text',
10595 labelPosition: 'after'
10596 }, config );
10597
10598 // Parent constructor
10599 OO.ui.TextInputWidget.parent.call( this, config );
10600
10601 // Mixin constructors
10602 OO.ui.mixin.IconElement.call( this, config );
10603 OO.ui.mixin.IndicatorElement.call( this, config );
10604 OO.ui.mixin.PendingElement.call( this, $.extend( { $pending: this.$input }, config ) );
10605 OO.ui.mixin.LabelElement.call( this, config );
10606 OO.ui.mixin.FlaggedElement.call( this, config );
10607
10608 // Properties
10609 this.type = this.getSaneType( config );
10610 this.readOnly = false;
10611 this.required = false;
10612 this.validate = null;
10613 this.scrollWidth = null;
10614
10615 this.setValidation( config.validate );
10616 this.setLabelPosition( config.labelPosition );
10617
10618 // Events
10619 this.$input.on( {
10620 keypress: this.onKeyPress.bind( this ),
10621 blur: this.onBlur.bind( this ),
10622 focus: this.onFocus.bind( this )
10623 } );
10624 this.$icon.on( 'mousedown', this.onIconMouseDown.bind( this ) );
10625 this.$indicator.on( 'mousedown', this.onIndicatorMouseDown.bind( this ) );
10626 this.on( 'labelChange', this.updatePosition.bind( this ) );
10627 this.on( 'change', OO.ui.debounce( this.onDebouncedChange.bind( this ), 250 ) );
10628
10629 // Initialization
10630 this.$element
10631 .addClass( 'oo-ui-textInputWidget oo-ui-textInputWidget-type-' + this.type )
10632 .append( this.$icon, this.$indicator );
10633 this.setReadOnly( !!config.readOnly );
10634 this.setRequired( !!config.required );
10635 if ( config.placeholder !== undefined ) {
10636 this.$input.attr( 'placeholder', config.placeholder );
10637 }
10638 if ( config.maxLength !== undefined ) {
10639 this.$input.attr( 'maxlength', config.maxLength );
10640 }
10641 if ( config.autofocus ) {
10642 this.$input.attr( 'autofocus', 'autofocus' );
10643 }
10644 if ( config.autocomplete === false ) {
10645 this.$input.attr( 'autocomplete', 'off' );
10646 // Turning off autocompletion also disables "form caching" when the user navigates to a
10647 // different page and then clicks "Back". Re-enable it when leaving.
10648 // Borrowed from jQuery UI.
10649 $( window ).on( {
10650 beforeunload: function () {
10651 this.$input.removeAttr( 'autocomplete' );
10652 }.bind( this ),
10653 pageshow: function () {
10654 // Browsers don't seem to actually fire this event on "Back", they instead just
10655 // reload the whole page... it shouldn't hurt, though.
10656 this.$input.attr( 'autocomplete', 'off' );
10657 }.bind( this )
10658 } );
10659 }
10660 if ( config.spellcheck !== undefined ) {
10661 this.$input.attr( 'spellcheck', config.spellcheck ? 'true' : 'false' );
10662 }
10663 if ( this.label ) {
10664 this.isWaitingToBeAttached = true;
10665 this.installParentChangeDetector();
10666 }
10667 };
10668
10669 /* Setup */
10670
10671 OO.inheritClass( OO.ui.TextInputWidget, OO.ui.InputWidget );
10672 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.IconElement );
10673 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.IndicatorElement );
10674 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.PendingElement );
10675 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.LabelElement );
10676 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.FlaggedElement );
10677
10678 /* Static Properties */
10679
10680 OO.ui.TextInputWidget.static.validationPatterns = {
10681 'non-empty': /.+/,
10682 integer: /^\d+$/
10683 };
10684
10685 /* Events */
10686
10687 /**
10688 * An `enter` event is emitted when the user presses Enter key inside the text box.
10689 *
10690 * @event enter
10691 */
10692
10693 /* Methods */
10694
10695 /**
10696 * Handle icon mouse down events.
10697 *
10698 * @private
10699 * @param {jQuery.Event} e Mouse down event
10700 * @return {undefined|boolean} False to prevent default if event is handled
10701 */
10702 OO.ui.TextInputWidget.prototype.onIconMouseDown = function ( e ) {
10703 if ( e.which === OO.ui.MouseButtons.LEFT ) {
10704 this.focus();
10705 return false;
10706 }
10707 };
10708
10709 /**
10710 * Handle indicator mouse down events.
10711 *
10712 * @private
10713 * @param {jQuery.Event} e Mouse down event
10714 * @return {undefined|boolean} False to prevent default if event is handled
10715 */
10716 OO.ui.TextInputWidget.prototype.onIndicatorMouseDown = function ( e ) {
10717 if ( e.which === OO.ui.MouseButtons.LEFT ) {
10718 this.focus();
10719 return false;
10720 }
10721 };
10722
10723 /**
10724 * Handle key press events.
10725 *
10726 * @private
10727 * @param {jQuery.Event} e Key press event
10728 * @fires enter If Enter key is pressed
10729 */
10730 OO.ui.TextInputWidget.prototype.onKeyPress = function ( e ) {
10731 if ( e.which === OO.ui.Keys.ENTER ) {
10732 this.emit( 'enter', e );
10733 }
10734 };
10735
10736 /**
10737 * Handle blur events.
10738 *
10739 * @private
10740 * @param {jQuery.Event} e Blur event
10741 */
10742 OO.ui.TextInputWidget.prototype.onBlur = function () {
10743 this.setValidityFlag();
10744 };
10745
10746 /**
10747 * Handle focus events.
10748 *
10749 * @private
10750 * @param {jQuery.Event} e Focus event
10751 */
10752 OO.ui.TextInputWidget.prototype.onFocus = function () {
10753 if ( this.isWaitingToBeAttached ) {
10754 // If we've received focus, then we must be attached to the document, and if
10755 // isWaitingToBeAttached is still true, that means the handler never fired. Fire it now.
10756 this.onElementAttach();
10757 }
10758 this.setValidityFlag( true );
10759 };
10760
10761 /**
10762 * Handle element attach events.
10763 *
10764 * @private
10765 * @param {jQuery.Event} e Element attach event
10766 */
10767 OO.ui.TextInputWidget.prototype.onElementAttach = function () {
10768 this.isWaitingToBeAttached = false;
10769 // Any previously calculated size is now probably invalid if we reattached elsewhere
10770 this.valCache = null;
10771 this.positionLabel();
10772 };
10773
10774 /**
10775 * Handle debounced change events.
10776 *
10777 * @param {string} value
10778 * @private
10779 */
10780 OO.ui.TextInputWidget.prototype.onDebouncedChange = function () {
10781 this.setValidityFlag();
10782 };
10783
10784 /**
10785 * Check if the input is {@link #readOnly read-only}.
10786 *
10787 * @return {boolean}
10788 */
10789 OO.ui.TextInputWidget.prototype.isReadOnly = function () {
10790 return this.readOnly;
10791 };
10792
10793 /**
10794 * Set the {@link #readOnly read-only} state of the input.
10795 *
10796 * @param {boolean} state Make input read-only
10797 * @chainable
10798 * @return {OO.ui.Widget} The widget, for chaining
10799 */
10800 OO.ui.TextInputWidget.prototype.setReadOnly = function ( state ) {
10801 this.readOnly = !!state;
10802 this.$input.prop( 'readOnly', this.readOnly );
10803 return this;
10804 };
10805
10806 /**
10807 * Check if the input is {@link #required required}.
10808 *
10809 * @return {boolean}
10810 */
10811 OO.ui.TextInputWidget.prototype.isRequired = function () {
10812 return this.required;
10813 };
10814
10815 /**
10816 * Set the {@link #required required} state of the input.
10817 *
10818 * @param {boolean} state Make input required
10819 * @chainable
10820 * @return {OO.ui.Widget} The widget, for chaining
10821 */
10822 OO.ui.TextInputWidget.prototype.setRequired = function ( state ) {
10823 this.required = !!state;
10824 if ( this.required ) {
10825 this.$input
10826 .prop( 'required', true )
10827 .attr( 'aria-required', 'true' );
10828 if ( this.getIndicator() === null ) {
10829 this.setIndicator( 'required' );
10830 }
10831 } else {
10832 this.$input
10833 .prop( 'required', false )
10834 .removeAttr( 'aria-required' );
10835 if ( this.getIndicator() === 'required' ) {
10836 this.setIndicator( null );
10837 }
10838 }
10839 return this;
10840 };
10841
10842 /**
10843 * Support function for making #onElementAttach work across browsers.
10844 *
10845 * This whole function could be replaced with one line of code using the DOMNodeInsertedIntoDocument
10846 * event, but it's not supported by Firefox and allegedly deprecated, so we only use it as fallback.
10847 *
10848 * Due to MutationObserver performance woes, #onElementAttach is only somewhat reliably called the
10849 * first time that the element gets attached to the documented.
10850 */
10851 OO.ui.TextInputWidget.prototype.installParentChangeDetector = function () {
10852 var mutationObserver, onRemove, topmostNode, fakeParentNode,
10853 MutationObserver = window.MutationObserver ||
10854 window.WebKitMutationObserver ||
10855 window.MozMutationObserver,
10856 widget = this;
10857
10858 if ( MutationObserver ) {
10859 // The new way. If only it wasn't so ugly.
10860
10861 if ( this.isElementAttached() ) {
10862 // Widget is attached already, do nothing. This breaks the functionality of this
10863 // function when the widget is detached and reattached. Alas, doing this correctly with
10864 // MutationObserver would require observation of the whole document, which would hurt
10865 // performance of other, more important code.
10866 return;
10867 }
10868
10869 // Find topmost node in the tree
10870 topmostNode = this.$element[ 0 ];
10871 while ( topmostNode.parentNode ) {
10872 topmostNode = topmostNode.parentNode;
10873 }
10874
10875 // We have no way to detect the $element being attached somewhere without observing the
10876 // entire DOM with subtree modifications, which would hurt performance. So we cheat: we hook
10877 // to the parent node of $element, and instead detect when $element is removed from it (and
10878 // thus probably attached somewhere else). If there is no parent, we create a "fake" one. If
10879 // it doesn't get attached, we end up back here and create the parent.
10880 mutationObserver = new MutationObserver( function ( mutations ) {
10881 var i, j, removedNodes;
10882 for ( i = 0; i < mutations.length; i++ ) {
10883 removedNodes = mutations[ i ].removedNodes;
10884 for ( j = 0; j < removedNodes.length; j++ ) {
10885 if ( removedNodes[ j ] === topmostNode ) {
10886 setTimeout( onRemove, 0 );
10887 return;
10888 }
10889 }
10890 }
10891 } );
10892
10893 onRemove = function () {
10894 // If the node was attached somewhere else, report it
10895 if ( widget.isElementAttached() ) {
10896 widget.onElementAttach();
10897 }
10898 mutationObserver.disconnect();
10899 widget.installParentChangeDetector();
10900 };
10901
10902 // Create a fake parent and observe it
10903 fakeParentNode = $( '<div>' ).append( topmostNode )[ 0 ];
10904 mutationObserver.observe( fakeParentNode, { childList: true } );
10905 } else {
10906 // Using the DOMNodeInsertedIntoDocument event is much nicer and less magical, and works for
10907 // detachment and reattachment, but it's not supported by Firefox and allegedly deprecated.
10908 this.$element.on( 'DOMNodeInsertedIntoDocument', this.onElementAttach.bind( this ) );
10909 }
10910 };
10911
10912 /**
10913 * @inheritdoc
10914 * @protected
10915 */
10916 OO.ui.TextInputWidget.prototype.getInputElement = function ( config ) {
10917 if ( this.getSaneType( config ) === 'number' ) {
10918 return $( '<input>' )
10919 .attr( 'step', 'any' )
10920 .attr( 'type', 'number' );
10921 } else {
10922 return $( '<input>' ).attr( 'type', this.getSaneType( config ) );
10923 }
10924 };
10925
10926 /**
10927 * Get sanitized value for 'type' for given config.
10928 *
10929 * @param {Object} config Configuration options
10930 * @return {string|null}
10931 * @protected
10932 */
10933 OO.ui.TextInputWidget.prototype.getSaneType = function ( config ) {
10934 var allowedTypes = [
10935 'text',
10936 'password',
10937 'email',
10938 'url',
10939 'number'
10940 ];
10941 return allowedTypes.indexOf( config.type ) !== -1 ? config.type : 'text';
10942 };
10943
10944 /**
10945 * Focus the input and select a specified range within the text.
10946 *
10947 * @param {number} from Select from offset
10948 * @param {number} [to] Select to offset, defaults to from
10949 * @chainable
10950 * @return {OO.ui.Widget} The widget, for chaining
10951 */
10952 OO.ui.TextInputWidget.prototype.selectRange = function ( from, to ) {
10953 var isBackwards, start, end,
10954 input = this.$input[ 0 ];
10955
10956 to = to || from;
10957
10958 isBackwards = to < from;
10959 start = isBackwards ? to : from;
10960 end = isBackwards ? from : to;
10961
10962 this.focus();
10963
10964 try {
10965 input.setSelectionRange( start, end, isBackwards ? 'backward' : 'forward' );
10966 } catch ( e ) {
10967 // IE throws an exception if you call setSelectionRange on a unattached DOM node.
10968 // Rather than expensively check if the input is attached every time, just check
10969 // if it was the cause of an error being thrown. If not, rethrow the error.
10970 if ( this.getElementDocument().body.contains( input ) ) {
10971 throw e;
10972 }
10973 }
10974 return this;
10975 };
10976
10977 /**
10978 * Get an object describing the current selection range in a directional manner
10979 *
10980 * @return {Object} Object containing 'from' and 'to' offsets
10981 */
10982 OO.ui.TextInputWidget.prototype.getRange = function () {
10983 var input = this.$input[ 0 ],
10984 start = input.selectionStart,
10985 end = input.selectionEnd,
10986 isBackwards = input.selectionDirection === 'backward';
10987
10988 return {
10989 from: isBackwards ? end : start,
10990 to: isBackwards ? start : end
10991 };
10992 };
10993
10994 /**
10995 * Get the length of the text input value.
10996 *
10997 * This could differ from the length of #getValue if the
10998 * value gets filtered
10999 *
11000 * @return {number} Input length
11001 */
11002 OO.ui.TextInputWidget.prototype.getInputLength = function () {
11003 return this.$input[ 0 ].value.length;
11004 };
11005
11006 /**
11007 * Focus the input and select the entire text.
11008 *
11009 * @chainable
11010 * @return {OO.ui.Widget} The widget, for chaining
11011 */
11012 OO.ui.TextInputWidget.prototype.select = function () {
11013 return this.selectRange( 0, this.getInputLength() );
11014 };
11015
11016 /**
11017 * Focus the input and move the cursor to the start.
11018 *
11019 * @chainable
11020 * @return {OO.ui.Widget} The widget, for chaining
11021 */
11022 OO.ui.TextInputWidget.prototype.moveCursorToStart = function () {
11023 return this.selectRange( 0 );
11024 };
11025
11026 /**
11027 * Focus the input and move the cursor to the end.
11028 *
11029 * @chainable
11030 * @return {OO.ui.Widget} The widget, for chaining
11031 */
11032 OO.ui.TextInputWidget.prototype.moveCursorToEnd = function () {
11033 return this.selectRange( this.getInputLength() );
11034 };
11035
11036 /**
11037 * Insert new content into the input.
11038 *
11039 * @param {string} content Content to be inserted
11040 * @chainable
11041 * @return {OO.ui.Widget} The widget, for chaining
11042 */
11043 OO.ui.TextInputWidget.prototype.insertContent = function ( content ) {
11044 var start, end,
11045 range = this.getRange(),
11046 value = this.getValue();
11047
11048 start = Math.min( range.from, range.to );
11049 end = Math.max( range.from, range.to );
11050
11051 this.setValue( value.slice( 0, start ) + content + value.slice( end ) );
11052 this.selectRange( start + content.length );
11053 return this;
11054 };
11055
11056 /**
11057 * Insert new content either side of a selection.
11058 *
11059 * @param {string} pre Content to be inserted before the selection
11060 * @param {string} post Content to be inserted after the selection
11061 * @chainable
11062 * @return {OO.ui.Widget} The widget, for chaining
11063 */
11064 OO.ui.TextInputWidget.prototype.encapsulateContent = function ( pre, post ) {
11065 var start, end,
11066 range = this.getRange(),
11067 offset = pre.length;
11068
11069 start = Math.min( range.from, range.to );
11070 end = Math.max( range.from, range.to );
11071
11072 this.selectRange( start ).insertContent( pre );
11073 this.selectRange( offset + end ).insertContent( post );
11074
11075 this.selectRange( offset + start, offset + end );
11076 return this;
11077 };
11078
11079 /**
11080 * Set the validation pattern.
11081 *
11082 * The validation pattern is either a regular expression, a function, or the symbolic name of a
11083 * pattern defined by the class: 'non-empty' (the value cannot be an empty string) or 'integer' (the
11084 * value must contain only numbers).
11085 *
11086 * @param {RegExp|Function|string|null} validate Regular expression, function, or the symbolic name
11087 * of a pattern (either ‘integer’ or ‘non-empty’) defined by the class.
11088 */
11089 OO.ui.TextInputWidget.prototype.setValidation = function ( validate ) {
11090 if ( validate instanceof RegExp || validate instanceof Function ) {
11091 this.validate = validate;
11092 } else {
11093 this.validate = this.constructor.static.validationPatterns[ validate ] || /.*/;
11094 }
11095 };
11096
11097 /**
11098 * Sets the 'invalid' flag appropriately.
11099 *
11100 * @param {boolean} [isValid] Optionally override validation result
11101 */
11102 OO.ui.TextInputWidget.prototype.setValidityFlag = function ( isValid ) {
11103 var widget = this,
11104 setFlag = function ( valid ) {
11105 if ( !valid ) {
11106 widget.$input.attr( 'aria-invalid', 'true' );
11107 } else {
11108 widget.$input.removeAttr( 'aria-invalid' );
11109 }
11110 widget.setFlags( { invalid: !valid } );
11111 };
11112
11113 if ( isValid !== undefined ) {
11114 setFlag( isValid );
11115 } else {
11116 this.getValidity().then( function () {
11117 setFlag( true );
11118 }, function () {
11119 setFlag( false );
11120 } );
11121 }
11122 };
11123
11124 /**
11125 * Get the validity of current value.
11126 *
11127 * This method returns a promise that resolves if the value is valid and rejects if
11128 * it isn't. Uses the {@link #validate validation pattern} to check for validity.
11129 *
11130 * @return {jQuery.Promise} A promise that resolves if the value is valid, rejects if not.
11131 */
11132 OO.ui.TextInputWidget.prototype.getValidity = function () {
11133 var result;
11134
11135 function rejectOrResolve( valid ) {
11136 if ( valid ) {
11137 return $.Deferred().resolve().promise();
11138 } else {
11139 return $.Deferred().reject().promise();
11140 }
11141 }
11142
11143 // Check browser validity and reject if it is invalid
11144 if (
11145 this.$input[ 0 ].checkValidity !== undefined &&
11146 this.$input[ 0 ].checkValidity() === false
11147 ) {
11148 return rejectOrResolve( false );
11149 }
11150
11151 // Run our checks if the browser thinks the field is valid
11152 if ( this.validate instanceof Function ) {
11153 result = this.validate( this.getValue() );
11154 if ( result && typeof result.promise === 'function' ) {
11155 return result.promise().then( function ( valid ) {
11156 return rejectOrResolve( valid );
11157 } );
11158 } else {
11159 return rejectOrResolve( result );
11160 }
11161 } else {
11162 return rejectOrResolve( this.getValue().match( this.validate ) );
11163 }
11164 };
11165
11166 /**
11167 * Set the position of the inline label relative to that of the value: `‘before’` or `‘after’`.
11168 *
11169 * @param {string} labelPosition Label position, 'before' or 'after'
11170 * @chainable
11171 * @return {OO.ui.Widget} The widget, for chaining
11172 */
11173 OO.ui.TextInputWidget.prototype.setLabelPosition = function ( labelPosition ) {
11174 this.labelPosition = labelPosition;
11175 if ( this.label ) {
11176 // If there is no label and we only change the position, #updatePosition is a no-op,
11177 // but it takes really a lot of work to do nothing.
11178 this.updatePosition();
11179 }
11180 return this;
11181 };
11182
11183 /**
11184 * Update the position of the inline label.
11185 *
11186 * This method is called by #setLabelPosition, and can also be called on its own if
11187 * something causes the label to be mispositioned.
11188 *
11189 * @chainable
11190 * @return {OO.ui.Widget} The widget, for chaining
11191 */
11192 OO.ui.TextInputWidget.prototype.updatePosition = function () {
11193 var after = this.labelPosition === 'after';
11194
11195 this.$element
11196 .toggleClass( 'oo-ui-textInputWidget-labelPosition-after', !!this.label && after )
11197 .toggleClass( 'oo-ui-textInputWidget-labelPosition-before', !!this.label && !after );
11198
11199 this.valCache = null;
11200 this.scrollWidth = null;
11201 this.positionLabel();
11202
11203 return this;
11204 };
11205
11206 /**
11207 * Position the label by setting the correct padding on the input.
11208 *
11209 * @private
11210 * @chainable
11211 * @return {OO.ui.Widget} The widget, for chaining
11212 */
11213 OO.ui.TextInputWidget.prototype.positionLabel = function () {
11214 var after, rtl, property, newCss;
11215
11216 if ( this.isWaitingToBeAttached ) {
11217 // #onElementAttach will be called soon, which calls this method
11218 return this;
11219 }
11220
11221 newCss = {
11222 'padding-right': '',
11223 'padding-left': ''
11224 };
11225
11226 if ( this.label ) {
11227 this.$element.append( this.$label );
11228 } else {
11229 this.$label.detach();
11230 // Clear old values if present
11231 this.$input.css( newCss );
11232 return;
11233 }
11234
11235 after = this.labelPosition === 'after';
11236 rtl = this.$element.css( 'direction' ) === 'rtl';
11237 property = after === rtl ? 'padding-left' : 'padding-right';
11238
11239 newCss[ property ] = this.$label.outerWidth( true ) + ( after ? this.scrollWidth : 0 );
11240 // We have to clear the padding on the other side, in case the element direction changed
11241 this.$input.css( newCss );
11242
11243 return this;
11244 };
11245
11246 /**
11247 * SearchInputWidgets are TextInputWidgets with `type="search"` assigned and feature a
11248 * {@link OO.ui.mixin.IconElement search icon} by default.
11249 * Please see the [OOUI documentation on MediaWiki] [1] for more information and examples.
11250 *
11251 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs#SearchInputWidget
11252 *
11253 * @class
11254 * @extends OO.ui.TextInputWidget
11255 *
11256 * @constructor
11257 * @param {Object} [config] Configuration options
11258 */
11259 OO.ui.SearchInputWidget = function OoUiSearchInputWidget( config ) {
11260 config = $.extend( {
11261 icon: 'search'
11262 }, config );
11263
11264 // Parent constructor
11265 OO.ui.SearchInputWidget.parent.call( this, config );
11266
11267 // Events
11268 this.connect( this, {
11269 change: 'onChange'
11270 } );
11271 this.$indicator.on( 'click', this.onIndicatorClick.bind( this ) );
11272
11273 // Initialization
11274 this.updateSearchIndicator();
11275 this.connect( this, {
11276 disable: 'onDisable'
11277 } );
11278 };
11279
11280 /* Setup */
11281
11282 OO.inheritClass( OO.ui.SearchInputWidget, OO.ui.TextInputWidget );
11283
11284 /* Methods */
11285
11286 /**
11287 * @inheritdoc
11288 * @protected
11289 */
11290 OO.ui.SearchInputWidget.prototype.getSaneType = function () {
11291 return 'search';
11292 };
11293
11294 /**
11295 * Handle click events on the indicator
11296 *
11297 * @param {jQuery.Event} e Click event
11298 * @return {boolean}
11299 */
11300 OO.ui.SearchInputWidget.prototype.onIndicatorClick = function ( e ) {
11301 if ( e.which === OO.ui.MouseButtons.LEFT ) {
11302 // Clear the text field
11303 this.setValue( '' );
11304 this.focus();
11305 return false;
11306 }
11307 };
11308
11309 /**
11310 * Update the 'clear' indicator displayed on type: 'search' text
11311 * fields, hiding it when the field is already empty or when it's not
11312 * editable.
11313 */
11314 OO.ui.SearchInputWidget.prototype.updateSearchIndicator = function () {
11315 if ( this.getValue() === '' || this.isDisabled() || this.isReadOnly() ) {
11316 this.setIndicator( null );
11317 } else {
11318 this.setIndicator( 'clear' );
11319 }
11320 };
11321
11322 /**
11323 * Handle change events.
11324 *
11325 * @private
11326 */
11327 OO.ui.SearchInputWidget.prototype.onChange = function () {
11328 this.updateSearchIndicator();
11329 };
11330
11331 /**
11332 * Handle disable events.
11333 *
11334 * @param {boolean} disabled Element is disabled
11335 * @private
11336 */
11337 OO.ui.SearchInputWidget.prototype.onDisable = function () {
11338 this.updateSearchIndicator();
11339 };
11340
11341 /**
11342 * @inheritdoc
11343 */
11344 OO.ui.SearchInputWidget.prototype.setReadOnly = function ( state ) {
11345 OO.ui.SearchInputWidget.parent.prototype.setReadOnly.call( this, state );
11346 this.updateSearchIndicator();
11347 return this;
11348 };
11349
11350 /**
11351 * MultilineTextInputWidgets, like HTML textareas, are featuring customization options to
11352 * configure number of rows visible. In addition, these widgets can be autosized to fit user
11353 * inputs and can show {@link OO.ui.mixin.IconElement icons} and
11354 * {@link OO.ui.mixin.IndicatorElement indicators}.
11355 * Please see the [OOUI documentation on MediaWiki] [1] for more information and examples.
11356 *
11357 * This widget can be used inside an HTML form, such as a OO.ui.FormLayout.
11358 *
11359 * @example
11360 * // A MultilineTextInputWidget.
11361 * var multilineTextInput = new OO.ui.MultilineTextInputWidget( {
11362 * value: 'Text input on multiple lines'
11363 * } );
11364 * $( document.body ).append( multilineTextInput.$element );
11365 *
11366 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs#MultilineTextInputWidget
11367 *
11368 * @class
11369 * @extends OO.ui.TextInputWidget
11370 *
11371 * @constructor
11372 * @param {Object} [config] Configuration options
11373 * @cfg {number} [rows] Number of visible lines in textarea. If used with `autosize`,
11374 * specifies minimum number of rows to display.
11375 * @cfg {boolean} [autosize=false] Automatically resize the text input to fit its content.
11376 * Use the #maxRows config to specify a maximum number of displayed rows.
11377 * @cfg {number} [maxRows] Maximum number of rows to display when #autosize is set to true.
11378 * Defaults to the maximum of `10` and `2 * rows`, or `10` if `rows` isn't provided.
11379 */
11380 OO.ui.MultilineTextInputWidget = function OoUiMultilineTextInputWidget( config ) {
11381 config = $.extend( {
11382 type: 'text'
11383 }, config );
11384 // Parent constructor
11385 OO.ui.MultilineTextInputWidget.parent.call( this, config );
11386
11387 // Properties
11388 this.autosize = !!config.autosize;
11389 this.styleHeight = null;
11390 this.minRows = config.rows !== undefined ? config.rows : '';
11391 this.maxRows = config.maxRows || Math.max( 2 * ( this.minRows || 0 ), 10 );
11392
11393 // Clone for resizing
11394 if ( this.autosize ) {
11395 this.$clone = this.$input
11396 .clone()
11397 .removeAttr( 'id' )
11398 .removeAttr( 'name' )
11399 .insertAfter( this.$input )
11400 .attr( 'aria-hidden', 'true' )
11401 .addClass( 'oo-ui-element-hidden' );
11402 }
11403
11404 // Events
11405 this.connect( this, {
11406 change: 'onChange'
11407 } );
11408
11409 // Initialization
11410 if ( config.rows ) {
11411 this.$input.attr( 'rows', config.rows );
11412 }
11413 if ( this.autosize ) {
11414 this.$input.addClass( 'oo-ui-textInputWidget-autosized' );
11415 this.isWaitingToBeAttached = true;
11416 this.installParentChangeDetector();
11417 }
11418 };
11419
11420 /* Setup */
11421
11422 OO.inheritClass( OO.ui.MultilineTextInputWidget, OO.ui.TextInputWidget );
11423
11424 /* Static Methods */
11425
11426 /**
11427 * @inheritdoc
11428 */
11429 OO.ui.MultilineTextInputWidget.static.gatherPreInfuseState = function ( node, config ) {
11430 var state = OO.ui.MultilineTextInputWidget.parent.static.gatherPreInfuseState( node, config );
11431 state.scrollTop = config.$input.scrollTop();
11432 return state;
11433 };
11434
11435 /* Methods */
11436
11437 /**
11438 * @inheritdoc
11439 */
11440 OO.ui.MultilineTextInputWidget.prototype.onElementAttach = function () {
11441 OO.ui.MultilineTextInputWidget.parent.prototype.onElementAttach.call( this );
11442 this.adjustSize();
11443 };
11444
11445 /**
11446 * Handle change events.
11447 *
11448 * @private
11449 */
11450 OO.ui.MultilineTextInputWidget.prototype.onChange = function () {
11451 this.adjustSize();
11452 };
11453
11454 /**
11455 * @inheritdoc
11456 */
11457 OO.ui.MultilineTextInputWidget.prototype.updatePosition = function () {
11458 OO.ui.MultilineTextInputWidget.parent.prototype.updatePosition.call( this );
11459 this.adjustSize();
11460 };
11461
11462 /**
11463 * @inheritdoc
11464 *
11465 * Modify to emit 'enter' on Ctrl/Meta+Enter, instead of plain Enter
11466 */
11467 OO.ui.MultilineTextInputWidget.prototype.onKeyPress = function ( e ) {
11468 if (
11469 ( e.which === OO.ui.Keys.ENTER && ( e.ctrlKey || e.metaKey ) ) ||
11470 // Some platforms emit keycode 10 for Control+Enter keypress in a textarea
11471 e.which === 10
11472 ) {
11473 this.emit( 'enter', e );
11474 }
11475 };
11476
11477 /**
11478 * Automatically adjust the size of the text input.
11479 *
11480 * This only affects multiline inputs that are {@link #autosize autosized}.
11481 *
11482 * @chainable
11483 * @return {OO.ui.Widget} The widget, for chaining
11484 * @fires resize
11485 */
11486 OO.ui.MultilineTextInputWidget.prototype.adjustSize = function () {
11487 var scrollHeight, innerHeight, outerHeight, maxInnerHeight, measurementError,
11488 idealHeight, newHeight, scrollWidth, property;
11489
11490 if ( this.$input.val() !== this.valCache ) {
11491 if ( this.autosize ) {
11492 this.$clone
11493 .val( this.$input.val() )
11494 .attr( 'rows', this.minRows )
11495 // Set inline height property to 0 to measure scroll height
11496 .css( 'height', 0 );
11497
11498 this.$clone.removeClass( 'oo-ui-element-hidden' );
11499
11500 this.valCache = this.$input.val();
11501
11502 scrollHeight = this.$clone[ 0 ].scrollHeight;
11503
11504 // Remove inline height property to measure natural heights
11505 this.$clone.css( 'height', '' );
11506 innerHeight = this.$clone.innerHeight();
11507 outerHeight = this.$clone.outerHeight();
11508
11509 // Measure max rows height
11510 this.$clone
11511 .attr( 'rows', this.maxRows )
11512 .css( 'height', 'auto' )
11513 .val( '' );
11514 maxInnerHeight = this.$clone.innerHeight();
11515
11516 // Difference between reported innerHeight and scrollHeight with no scrollbars present.
11517 // This is sometimes non-zero on Blink-based browsers, depending on zoom level.
11518 measurementError = maxInnerHeight - this.$clone[ 0 ].scrollHeight;
11519 idealHeight = Math.min( maxInnerHeight, scrollHeight + measurementError );
11520
11521 this.$clone.addClass( 'oo-ui-element-hidden' );
11522
11523 // Only apply inline height when expansion beyond natural height is needed
11524 // Use the difference between the inner and outer height as a buffer
11525 newHeight = idealHeight > innerHeight ? idealHeight + ( outerHeight - innerHeight ) : '';
11526 if ( newHeight !== this.styleHeight ) {
11527 this.$input.css( 'height', newHeight );
11528 this.styleHeight = newHeight;
11529 this.emit( 'resize' );
11530 }
11531 }
11532 scrollWidth = this.$input[ 0 ].offsetWidth - this.$input[ 0 ].clientWidth;
11533 if ( scrollWidth !== this.scrollWidth ) {
11534 property = this.$element.css( 'direction' ) === 'rtl' ? 'left' : 'right';
11535 // Reset
11536 this.$label.css( { right: '', left: '' } );
11537 this.$indicator.css( { right: '', left: '' } );
11538
11539 if ( scrollWidth ) {
11540 this.$indicator.css( property, scrollWidth );
11541 if ( this.labelPosition === 'after' ) {
11542 this.$label.css( property, scrollWidth );
11543 }
11544 }
11545
11546 this.scrollWidth = scrollWidth;
11547 this.positionLabel();
11548 }
11549 }
11550 return this;
11551 };
11552
11553 /**
11554 * @inheritdoc
11555 * @protected
11556 */
11557 OO.ui.MultilineTextInputWidget.prototype.getInputElement = function () {
11558 return $( '<textarea>' );
11559 };
11560
11561 /**
11562 * Check if the input automatically adjusts its size.
11563 *
11564 * @return {boolean}
11565 */
11566 OO.ui.MultilineTextInputWidget.prototype.isAutosizing = function () {
11567 return !!this.autosize;
11568 };
11569
11570 /**
11571 * @inheritdoc
11572 */
11573 OO.ui.MultilineTextInputWidget.prototype.restorePreInfuseState = function ( state ) {
11574 OO.ui.MultilineTextInputWidget.parent.prototype.restorePreInfuseState.call( this, state );
11575 if ( state.scrollTop !== undefined ) {
11576 this.$input.scrollTop( state.scrollTop );
11577 }
11578 };
11579
11580 /**
11581 * ComboBoxInputWidgets combine a {@link OO.ui.TextInputWidget text input} (where a value
11582 * can be entered manually) and a {@link OO.ui.MenuSelectWidget menu of options} (from which
11583 * a value can be chosen instead). Users can choose options from the combo box in one of two ways:
11584 *
11585 * - by typing a value in the text input field. If the value exactly matches the value of a menu
11586 * option, that option will appear to be selected.
11587 * - by choosing a value from the menu. The value of the chosen option will then appear in the text
11588 * input field.
11589 *
11590 * After the user chooses an option, its `data` will be used as a new value for the widget.
11591 * A `label` also can be specified for each option: if given, it will be shown instead of the
11592 * `data` in the dropdown menu.
11593 *
11594 * This widget can be used inside an HTML form, such as a OO.ui.FormLayout.
11595 *
11596 * For more information about menus and options, please see the
11597 * [OOUI documentation on MediaWiki][1].
11598 *
11599 * @example
11600 * // A ComboBoxInputWidget.
11601 * var comboBox = new OO.ui.ComboBoxInputWidget( {
11602 * value: 'Option 1',
11603 * options: [
11604 * { data: 'Option 1' },
11605 * { data: 'Option 2' },
11606 * { data: 'Option 3' }
11607 * ]
11608 * } );
11609 * $( document.body ).append( comboBox.$element );
11610 *
11611 * @example
11612 * // Example: A ComboBoxInputWidget with additional option labels.
11613 * var comboBox = new OO.ui.ComboBoxInputWidget( {
11614 * value: 'Option 1',
11615 * options: [
11616 * {
11617 * data: 'Option 1',
11618 * label: 'Option One'
11619 * },
11620 * {
11621 * data: 'Option 2',
11622 * label: 'Option Two'
11623 * },
11624 * {
11625 * data: 'Option 3',
11626 * label: 'Option Three'
11627 * }
11628 * ]
11629 * } );
11630 * $( document.body ).append( comboBox.$element );
11631 *
11632 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Menu_selects_and_options
11633 *
11634 * @class
11635 * @extends OO.ui.TextInputWidget
11636 *
11637 * @constructor
11638 * @param {Object} [config] Configuration options
11639 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
11640 * @cfg {Object} [menu] Configuration options to pass to the {@link OO.ui.MenuSelectWidget menu
11641 * select widget}.
11642 * @cfg {jQuery} [$overlay] Render the menu into a separate layer. This configuration is useful
11643 * in cases where the expanded menu is larger than its containing `<div>`. The specified overlay
11644 * layer is usually on top of the containing `<div>` and has a larger area. By default, the menu
11645 * uses relative positioning.
11646 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
11647 */
11648 OO.ui.ComboBoxInputWidget = function OoUiComboBoxInputWidget( config ) {
11649 // Configuration initialization
11650 config = $.extend( {
11651 autocomplete: false
11652 }, config );
11653
11654 // ComboBoxInputWidget shouldn't support `multiline`
11655 config.multiline = false;
11656
11657 // See InputWidget#reusePreInfuseDOM about `config.$input`
11658 if ( config.$input ) {
11659 config.$input.removeAttr( 'list' );
11660 }
11661
11662 // Parent constructor
11663 OO.ui.ComboBoxInputWidget.parent.call( this, config );
11664
11665 // Properties
11666 this.$overlay = ( config.$overlay === true ?
11667 OO.ui.getDefaultOverlay() : config.$overlay ) || this.$element;
11668 this.dropdownButton = new OO.ui.ButtonWidget( {
11669 classes: [ 'oo-ui-comboBoxInputWidget-dropdownButton' ],
11670 label: OO.ui.msg( 'ooui-combobox-button-label' ),
11671 indicator: 'down',
11672 invisibleLabel: true,
11673 disabled: this.disabled
11674 } );
11675 this.menu = new OO.ui.MenuSelectWidget( $.extend(
11676 {
11677 widget: this,
11678 input: this,
11679 $floatableContainer: this.$element,
11680 disabled: this.isDisabled()
11681 },
11682 config.menu
11683 ) );
11684
11685 // Events
11686 this.connect( this, {
11687 change: 'onInputChange',
11688 enter: 'onInputEnter'
11689 } );
11690 this.dropdownButton.connect( this, {
11691 click: 'onDropdownButtonClick'
11692 } );
11693 this.menu.connect( this, {
11694 choose: 'onMenuChoose',
11695 add: 'onMenuItemsChange',
11696 remove: 'onMenuItemsChange',
11697 toggle: 'onMenuToggle'
11698 } );
11699
11700 // Initialization
11701 this.$input.attr( {
11702 role: 'combobox',
11703 'aria-owns': this.menu.getElementId(),
11704 'aria-autocomplete': 'list'
11705 } );
11706 this.dropdownButton.$button.attr( {
11707 'aria-controls': this.menu.getElementId()
11708 } );
11709 // Do not override options set via config.menu.items
11710 if ( config.options !== undefined ) {
11711 this.setOptions( config.options );
11712 }
11713 this.$field = $( '<div>' )
11714 .addClass( 'oo-ui-comboBoxInputWidget-field' )
11715 .append( this.$input, this.dropdownButton.$element );
11716 this.$element
11717 .addClass( 'oo-ui-comboBoxInputWidget' )
11718 .append( this.$field );
11719 this.$overlay.append( this.menu.$element );
11720 this.onMenuItemsChange();
11721 };
11722
11723 /* Setup */
11724
11725 OO.inheritClass( OO.ui.ComboBoxInputWidget, OO.ui.TextInputWidget );
11726
11727 /* Methods */
11728
11729 /**
11730 * Get the combobox's menu.
11731 *
11732 * @return {OO.ui.MenuSelectWidget} Menu widget
11733 */
11734 OO.ui.ComboBoxInputWidget.prototype.getMenu = function () {
11735 return this.menu;
11736 };
11737
11738 /**
11739 * Get the combobox's text input widget.
11740 *
11741 * @return {OO.ui.TextInputWidget} Text input widget
11742 */
11743 OO.ui.ComboBoxInputWidget.prototype.getInput = function () {
11744 return this;
11745 };
11746
11747 /**
11748 * Handle input change events.
11749 *
11750 * @private
11751 * @param {string} value New value
11752 */
11753 OO.ui.ComboBoxInputWidget.prototype.onInputChange = function ( value ) {
11754 var match = this.menu.findItemFromData( value );
11755
11756 this.menu.selectItem( match );
11757 if ( this.menu.findHighlightedItem() ) {
11758 this.menu.highlightItem( match );
11759 }
11760
11761 if ( !this.isDisabled() ) {
11762 this.menu.toggle( true );
11763 }
11764 };
11765
11766 /**
11767 * Handle input enter events.
11768 *
11769 * @private
11770 */
11771 OO.ui.ComboBoxInputWidget.prototype.onInputEnter = function () {
11772 if ( !this.isDisabled() ) {
11773 this.menu.toggle( false );
11774 }
11775 };
11776
11777 /**
11778 * Handle button click events.
11779 *
11780 * @private
11781 */
11782 OO.ui.ComboBoxInputWidget.prototype.onDropdownButtonClick = function () {
11783 this.menu.toggle();
11784 this.focus();
11785 };
11786
11787 /**
11788 * Handle menu choose events.
11789 *
11790 * @private
11791 * @param {OO.ui.OptionWidget} item Chosen item
11792 */
11793 OO.ui.ComboBoxInputWidget.prototype.onMenuChoose = function ( item ) {
11794 this.setValue( item.getData() );
11795 };
11796
11797 /**
11798 * Handle menu item change events.
11799 *
11800 * @private
11801 */
11802 OO.ui.ComboBoxInputWidget.prototype.onMenuItemsChange = function () {
11803 var match = this.menu.findItemFromData( this.getValue() );
11804 this.menu.selectItem( match );
11805 if ( this.menu.findHighlightedItem() ) {
11806 this.menu.highlightItem( match );
11807 }
11808 this.$element.toggleClass( 'oo-ui-comboBoxInputWidget-empty', this.menu.isEmpty() );
11809 };
11810
11811 /**
11812 * Handle menu toggle events.
11813 *
11814 * @private
11815 * @param {boolean} isVisible Open state of the menu
11816 */
11817 OO.ui.ComboBoxInputWidget.prototype.onMenuToggle = function ( isVisible ) {
11818 this.$element.toggleClass( 'oo-ui-comboBoxInputWidget-open', isVisible );
11819 };
11820
11821 /**
11822 * Update the disabled state of the controls
11823 *
11824 * @chainable
11825 * @protected
11826 * @return {OO.ui.ComboBoxInputWidget} The widget, for chaining
11827 */
11828 OO.ui.ComboBoxInputWidget.prototype.updateControlsDisabled = function () {
11829 var disabled = this.isDisabled() || this.isReadOnly();
11830 if ( this.dropdownButton ) {
11831 this.dropdownButton.setDisabled( disabled );
11832 }
11833 if ( this.menu ) {
11834 this.menu.setDisabled( disabled );
11835 }
11836 return this;
11837 };
11838
11839 /**
11840 * @inheritdoc
11841 */
11842 OO.ui.ComboBoxInputWidget.prototype.setDisabled = function () {
11843 // Parent method
11844 OO.ui.ComboBoxInputWidget.parent.prototype.setDisabled.apply( this, arguments );
11845 this.updateControlsDisabled();
11846 return this;
11847 };
11848
11849 /**
11850 * @inheritdoc
11851 */
11852 OO.ui.ComboBoxInputWidget.prototype.setReadOnly = function () {
11853 // Parent method
11854 OO.ui.ComboBoxInputWidget.parent.prototype.setReadOnly.apply( this, arguments );
11855 this.updateControlsDisabled();
11856 return this;
11857 };
11858
11859 /**
11860 * Set the options available for this input.
11861 *
11862 * @param {Object[]} options Array of menu options in the format `{ data: …, label: … }`
11863 * @chainable
11864 * @return {OO.ui.Widget} The widget, for chaining
11865 */
11866 OO.ui.ComboBoxInputWidget.prototype.setOptions = function ( options ) {
11867 this.getMenu()
11868 .clearItems()
11869 .addItems( options.map( function ( opt ) {
11870 return new OO.ui.MenuOptionWidget( {
11871 data: opt.data,
11872 label: opt.label !== undefined ? opt.label : opt.data
11873 } );
11874 } ) );
11875
11876 return this;
11877 };
11878
11879 /**
11880 * FieldLayouts are used with OO.ui.FieldsetLayout. Each FieldLayout requires a field-widget,
11881 * which is a widget that is specified by reference before any optional configuration settings.
11882 *
11883 * Field layouts can be configured with help text and/or labels. Labels are aligned in one of
11884 * four ways:
11885 *
11886 * - **left**: The label is placed before the field-widget and aligned with the left margin.
11887 * A left-alignment is used for forms with many fields.
11888 * - **right**: The label is placed before the field-widget and aligned to the right margin.
11889 * A right-alignment is used for long but familiar forms which users tab through,
11890 * verifying the current field with a quick glance at the label.
11891 * - **top**: The label is placed above the field-widget. A top-alignment is used for brief forms
11892 * that users fill out from top to bottom.
11893 * - **inline**: The label is placed after the field-widget and aligned to the left.
11894 * An inline-alignment is best used with checkboxes or radio buttons.
11895 *
11896 * Help text can either be:
11897 *
11898 * - accessed via a help icon that appears in the upper right corner of the rendered field layout,
11899 * or
11900 * - shown as a subtle explanation below the label.
11901 *
11902 * If the help text is brief, or is essential to always expose it, set `helpInline` to `true`.
11903 * If it is long or not essential, leave `helpInline` to its default, `false`.
11904 *
11905 * Please see the [OOUI documentation on MediaWiki] [1] for examples and more information.
11906 *
11907 * [1]: https://www.mediawiki.org/wiki/OOUI/Layouts/Fields_and_Fieldsets
11908 *
11909 * @class
11910 * @extends OO.ui.Layout
11911 * @mixins OO.ui.mixin.LabelElement
11912 * @mixins OO.ui.mixin.TitledElement
11913 *
11914 * @constructor
11915 * @param {OO.ui.Widget} fieldWidget Field widget
11916 * @param {Object} [config] Configuration options
11917 * @cfg {string} [align='left'] Alignment of the label: 'left', 'right', 'top'
11918 * or 'inline'
11919 * @cfg {Array} [errors] Error messages about the widget, which will be
11920 * displayed below the widget.
11921 * @cfg {Array} [warnings] Warning messages about the widget, which will be
11922 * displayed below the widget.
11923 * @cfg {Array} [successMessages] Success messages on user interactions with the widget,
11924 * which will be displayed below the widget.
11925 * The array may contain strings or OO.ui.HtmlSnippet instances.
11926 * @cfg {Array} [notices] Notices about the widget, which will be displayed
11927 * below the widget.
11928 * The array may contain strings or OO.ui.HtmlSnippet instances.
11929 * These are more visible than `help` messages when `helpInline` is set, and so
11930 * might be good for transient messages.
11931 * @cfg {string|OO.ui.HtmlSnippet} [help] Help text. When help text is specified
11932 * and `helpInline` is `false`, a "help" icon will appear in the upper-right
11933 * corner of the rendered field; clicking it will display the text in a popup.
11934 * If `helpInline` is `true`, then a subtle description will be shown after the
11935 * label.
11936 * @cfg {boolean} [helpInline=false] Whether or not the help should be inline,
11937 * or shown when the "help" icon is clicked.
11938 * @cfg {jQuery} [$overlay] Passed to OO.ui.PopupButtonWidget for help popup, if
11939 * `help` is given.
11940 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
11941 *
11942 * @throws {Error} An error is thrown if no widget is specified
11943 */
11944 OO.ui.FieldLayout = function OoUiFieldLayout( fieldWidget, config ) {
11945 // Allow passing positional parameters inside the config object
11946 if ( OO.isPlainObject( fieldWidget ) && config === undefined ) {
11947 config = fieldWidget;
11948 fieldWidget = config.fieldWidget;
11949 }
11950
11951 // Make sure we have required constructor arguments
11952 if ( fieldWidget === undefined ) {
11953 throw new Error( 'Widget not found' );
11954 }
11955
11956 // Configuration initialization
11957 config = $.extend( { align: 'left', helpInline: false }, config );
11958
11959 // Parent constructor
11960 OO.ui.FieldLayout.parent.call( this, config );
11961
11962 // Mixin constructors
11963 OO.ui.mixin.LabelElement.call( this, $.extend( {
11964 $label: $( '<label>' )
11965 }, config ) );
11966 OO.ui.mixin.TitledElement.call( this, $.extend( { $titled: this.$label }, config ) );
11967
11968 // Properties
11969 this.fieldWidget = fieldWidget;
11970 this.errors = [];
11971 this.warnings = [];
11972 this.successMessages = [];
11973 this.notices = [];
11974 this.$field = this.isFieldInline() ? $( '<span>' ) : $( '<div>' );
11975 this.$messages = $( '<ul>' );
11976 this.$header = $( '<span>' );
11977 this.$body = $( '<div>' );
11978 this.align = null;
11979 this.helpInline = config.helpInline;
11980
11981 // Events
11982 this.fieldWidget.connect( this, {
11983 disable: 'onFieldDisable'
11984 } );
11985
11986 // Initialization
11987 this.$help = config.help ?
11988 this.createHelpElement( config.help, config.$overlay ) :
11989 $( [] );
11990 if ( this.fieldWidget.getInputId() ) {
11991 this.$label.attr( 'for', this.fieldWidget.getInputId() );
11992 if ( this.helpInline ) {
11993 this.$help.attr( 'for', this.fieldWidget.getInputId() );
11994 }
11995 } else {
11996 this.$label.on( 'click', function () {
11997 this.fieldWidget.simulateLabelClick();
11998 }.bind( this ) );
11999 if ( this.helpInline ) {
12000 this.$help.on( 'click', function () {
12001 this.fieldWidget.simulateLabelClick();
12002 }.bind( this ) );
12003 }
12004 }
12005 this.$element
12006 .addClass( 'oo-ui-fieldLayout' )
12007 .toggleClass( 'oo-ui-fieldLayout-disabled', this.fieldWidget.isDisabled() )
12008 .append( this.$body );
12009 this.$body.addClass( 'oo-ui-fieldLayout-body' );
12010 this.$header.addClass( 'oo-ui-fieldLayout-header' );
12011 this.$messages.addClass( 'oo-ui-fieldLayout-messages' );
12012 this.$field
12013 .addClass( 'oo-ui-fieldLayout-field' )
12014 .append( this.fieldWidget.$element );
12015
12016 this.setErrors( config.errors || [] );
12017 this.setWarnings( config.warnings || [] );
12018 this.setSuccess( config.successMessages || [] );
12019 this.setNotices( config.notices || [] );
12020 this.setAlignment( config.align );
12021 // Call this again to take into account the widget's accessKey
12022 this.updateTitle();
12023 };
12024
12025 /* Setup */
12026
12027 OO.inheritClass( OO.ui.FieldLayout, OO.ui.Layout );
12028 OO.mixinClass( OO.ui.FieldLayout, OO.ui.mixin.LabelElement );
12029 OO.mixinClass( OO.ui.FieldLayout, OO.ui.mixin.TitledElement );
12030
12031 /* Methods */
12032
12033 /**
12034 * Handle field disable events.
12035 *
12036 * @private
12037 * @param {boolean} value Field is disabled
12038 */
12039 OO.ui.FieldLayout.prototype.onFieldDisable = function ( value ) {
12040 this.$element.toggleClass( 'oo-ui-fieldLayout-disabled', value );
12041 };
12042
12043 /**
12044 * Get the widget contained by the field.
12045 *
12046 * @return {OO.ui.Widget} Field widget
12047 */
12048 OO.ui.FieldLayout.prototype.getField = function () {
12049 return this.fieldWidget;
12050 };
12051
12052 /**
12053 * Return `true` if the given field widget can be used with `'inline'` alignment (see
12054 * #setAlignment). Return `false` if it can't or if this can't be determined.
12055 *
12056 * @return {boolean}
12057 */
12058 OO.ui.FieldLayout.prototype.isFieldInline = function () {
12059 // This is very simplistic, but should be good enough.
12060 return this.getField().$element.prop( 'tagName' ).toLowerCase() === 'span';
12061 };
12062
12063 /**
12064 * @protected
12065 * @param {string} kind 'error' or 'notice'
12066 * @param {string|OO.ui.HtmlSnippet} text
12067 * @return {jQuery}
12068 */
12069 OO.ui.FieldLayout.prototype.makeMessage = function ( kind, text ) {
12070 var $listItem, $icon, message;
12071 $listItem = $( '<li>' );
12072 if ( kind === 'error' ) {
12073 $icon = new OO.ui.IconWidget( { icon: 'error', flags: [ 'error' ] } ).$element;
12074 $listItem.attr( 'role', 'alert' );
12075 } else if ( kind === 'warning' ) {
12076 $icon = new OO.ui.IconWidget( { icon: 'alert', flags: [ 'warning' ] } ).$element;
12077 $listItem.attr( 'role', 'alert' );
12078 } else if ( kind === 'success' ) {
12079 $icon = new OO.ui.IconWidget( { icon: 'check', flags: [ 'success' ] } ).$element;
12080 } else if ( kind === 'notice' ) {
12081 $icon = new OO.ui.IconWidget( { icon: 'notice' } ).$element;
12082 } else {
12083 $icon = '';
12084 }
12085 message = new OO.ui.LabelWidget( { label: text } );
12086 $listItem
12087 .append( $icon, message.$element )
12088 .addClass( 'oo-ui-fieldLayout-messages-' + kind );
12089 return $listItem;
12090 };
12091
12092 /**
12093 * Set the field alignment mode.
12094 *
12095 * @private
12096 * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
12097 * @chainable
12098 * @return {OO.ui.BookletLayout} The layout, for chaining
12099 */
12100 OO.ui.FieldLayout.prototype.setAlignment = function ( value ) {
12101 if ( value !== this.align ) {
12102 // Default to 'left'
12103 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value ) === -1 ) {
12104 value = 'left';
12105 }
12106 // Validate
12107 if ( value === 'inline' && !this.isFieldInline() ) {
12108 value = 'top';
12109 }
12110 // Reorder elements
12111
12112 if ( this.helpInline ) {
12113 if ( value === 'top' ) {
12114 this.$header.append( this.$label );
12115 this.$body.append( this.$header, this.$field, this.$help );
12116 } else if ( value === 'inline' ) {
12117 this.$header.append( this.$label, this.$help );
12118 this.$body.append( this.$field, this.$header );
12119 } else {
12120 this.$header.append( this.$label, this.$help );
12121 this.$body.append( this.$header, this.$field );
12122 }
12123 } else {
12124 if ( value === 'top' ) {
12125 this.$header.append( this.$help, this.$label );
12126 this.$body.append( this.$header, this.$field );
12127 } else if ( value === 'inline' ) {
12128 this.$header.append( this.$help, this.$label );
12129 this.$body.append( this.$field, this.$header );
12130 } else {
12131 this.$header.append( this.$label );
12132 this.$body.append( this.$header, this.$help, this.$field );
12133 }
12134 }
12135 // Set classes. The following classes can be used here:
12136 // * oo-ui-fieldLayout-align-left
12137 // * oo-ui-fieldLayout-align-right
12138 // * oo-ui-fieldLayout-align-top
12139 // * oo-ui-fieldLayout-align-inline
12140 if ( this.align ) {
12141 this.$element.removeClass( 'oo-ui-fieldLayout-align-' + this.align );
12142 }
12143 this.$element.addClass( 'oo-ui-fieldLayout-align-' + value );
12144 this.align = value;
12145 }
12146
12147 return this;
12148 };
12149
12150 /**
12151 * Set the list of error messages.
12152 *
12153 * @param {Array} errors Error messages about the widget, which will be displayed below the widget.
12154 * The array may contain strings or OO.ui.HtmlSnippet instances.
12155 * @chainable
12156 * @return {OO.ui.BookletLayout} The layout, for chaining
12157 */
12158 OO.ui.FieldLayout.prototype.setErrors = function ( errors ) {
12159 this.errors = errors.slice();
12160 this.updateMessages();
12161 return this;
12162 };
12163
12164 /**
12165 * Set the list of warning messages.
12166 *
12167 * @param {Array} warnings Warning messages about the widget, which will be displayed below
12168 * the widget.
12169 * The array may contain strings or OO.ui.HtmlSnippet instances.
12170 * @chainable
12171 * @return {OO.ui.BookletLayout} The layout, for chaining
12172 */
12173 OO.ui.FieldLayout.prototype.setWarnings = function ( warnings ) {
12174 this.warnings = warnings.slice();
12175 this.updateMessages();
12176 return this;
12177 };
12178
12179 /**
12180 * Set the list of success messages.
12181 *
12182 * @param {Array} successMessages Success messages about the widget, which will be displayed below
12183 * the widget.
12184 * The array may contain strings or OO.ui.HtmlSnippet instances.
12185 * @chainable
12186 * @return {OO.ui.BookletLayout} The layout, for chaining
12187 */
12188 OO.ui.FieldLayout.prototype.setSuccess = function ( successMessages ) {
12189 this.successMessages = successMessages.slice();
12190 this.updateMessages();
12191 return this;
12192 };
12193
12194 /**
12195 * Set the list of notice messages.
12196 *
12197 * @param {Array} notices Notices about the widget, which will be displayed below the widget.
12198 * The array may contain strings or OO.ui.HtmlSnippet instances.
12199 * @chainable
12200 * @return {OO.ui.BookletLayout} The layout, for chaining
12201 */
12202 OO.ui.FieldLayout.prototype.setNotices = function ( notices ) {
12203 this.notices = notices.slice();
12204 this.updateMessages();
12205 return this;
12206 };
12207
12208 /**
12209 * Update the rendering of error, warning, success and notice messages.
12210 *
12211 * @private
12212 */
12213 OO.ui.FieldLayout.prototype.updateMessages = function () {
12214 var i;
12215 this.$messages.empty();
12216
12217 if (
12218 this.errors.length ||
12219 this.warnings.length ||
12220 this.successMessages.length ||
12221 this.notices.length
12222 ) {
12223 this.$body.after( this.$messages );
12224 } else {
12225 this.$messages.remove();
12226 return;
12227 }
12228
12229 for ( i = 0; i < this.errors.length; i++ ) {
12230 this.$messages.append( this.makeMessage( 'error', this.errors[ i ] ) );
12231 }
12232 for ( i = 0; i < this.warnings.length; i++ ) {
12233 this.$messages.append( this.makeMessage( 'warning', this.warnings[ i ] ) );
12234 }
12235 for ( i = 0; i < this.successMessages.length; i++ ) {
12236 this.$messages.append( this.makeMessage( 'success', this.successMessages[ i ] ) );
12237 }
12238 for ( i = 0; i < this.notices.length; i++ ) {
12239 this.$messages.append( this.makeMessage( 'notice', this.notices[ i ] ) );
12240 }
12241 };
12242
12243 /**
12244 * Include information about the widget's accessKey in our title. TitledElement calls this method.
12245 * (This is a bit of a hack.)
12246 *
12247 * @protected
12248 * @param {string} title Tooltip label for 'title' attribute
12249 * @return {string}
12250 */
12251 OO.ui.FieldLayout.prototype.formatTitleWithAccessKey = function ( title ) {
12252 if ( this.fieldWidget && this.fieldWidget.formatTitleWithAccessKey ) {
12253 return this.fieldWidget.formatTitleWithAccessKey( title );
12254 }
12255 return title;
12256 };
12257
12258 /**
12259 * Creates and returns the help element. Also sets the `aria-describedby`
12260 * attribute on the main element of the `fieldWidget`.
12261 *
12262 * @private
12263 * @param {string|OO.ui.HtmlSnippet} [help] Help text.
12264 * @param {jQuery} [$overlay] Passed to OO.ui.PopupButtonWidget for help popup.
12265 * @return {jQuery} The element that should become `this.$help`.
12266 */
12267 OO.ui.FieldLayout.prototype.createHelpElement = function ( help, $overlay ) {
12268 var helpId, helpWidget;
12269
12270 if ( this.helpInline ) {
12271 helpWidget = new OO.ui.LabelWidget( {
12272 label: help,
12273 classes: [ 'oo-ui-inline-help' ]
12274 } );
12275
12276 helpId = helpWidget.getElementId();
12277 } else {
12278 helpWidget = new OO.ui.PopupButtonWidget( {
12279 $overlay: $overlay,
12280 popup: {
12281 padded: true
12282 },
12283 classes: [ 'oo-ui-fieldLayout-help' ],
12284 framed: false,
12285 icon: 'info',
12286 label: OO.ui.msg( 'ooui-field-help' ),
12287 invisibleLabel: true
12288 } );
12289 if ( help instanceof OO.ui.HtmlSnippet ) {
12290 helpWidget.getPopup().$body.html( help.toString() );
12291 } else {
12292 helpWidget.getPopup().$body.text( help );
12293 }
12294
12295 helpId = helpWidget.getPopup().getBodyId();
12296 }
12297
12298 // Set the 'aria-describedby' attribute on the fieldWidget
12299 // Preference given to an input or a button
12300 (
12301 this.fieldWidget.$input ||
12302 this.fieldWidget.$button ||
12303 this.fieldWidget.$element
12304 ).attr( 'aria-describedby', helpId );
12305
12306 return helpWidget.$element;
12307 };
12308
12309 /**
12310 * ActionFieldLayouts are used with OO.ui.FieldsetLayout. The layout consists of a field-widget,
12311 * a button, and an optional label and/or help text. The field-widget (e.g., a
12312 * {@link OO.ui.TextInputWidget TextInputWidget}), is required and is specified before any optional
12313 * configuration settings.
12314 *
12315 * Labels can be aligned in one of four ways:
12316 *
12317 * - **left**: The label is placed before the field-widget and aligned with the left margin.
12318 * A left-alignment is used for forms with many fields.
12319 * - **right**: The label is placed before the field-widget and aligned to the right margin.
12320 * A right-alignment is used for long but familiar forms which users tab through,
12321 * verifying the current field with a quick glance at the label.
12322 * - **top**: The label is placed above the field-widget. A top-alignment is used for brief forms
12323 * that users fill out from top to bottom.
12324 * - **inline**: The label is placed after the field-widget and aligned to the left.
12325 * An inline-alignment is best used with checkboxes or radio buttons.
12326 *
12327 * Help text is accessed via a help icon that appears in the upper right corner of the rendered
12328 * field layout when help text is specified.
12329 *
12330 * @example
12331 * // Example of an ActionFieldLayout
12332 * var actionFieldLayout = new OO.ui.ActionFieldLayout(
12333 * new OO.ui.TextInputWidget( {
12334 * placeholder: 'Field widget'
12335 * } ),
12336 * new OO.ui.ButtonWidget( {
12337 * label: 'Button'
12338 * } ),
12339 * {
12340 * label: 'An ActionFieldLayout. This label is aligned top',
12341 * align: 'top',
12342 * help: 'This is help text'
12343 * }
12344 * );
12345 *
12346 * $( document.body ).append( actionFieldLayout.$element );
12347 *
12348 * @class
12349 * @extends OO.ui.FieldLayout
12350 *
12351 * @constructor
12352 * @param {OO.ui.Widget} fieldWidget Field widget
12353 * @param {OO.ui.ButtonWidget} buttonWidget Button widget
12354 * @param {Object} config
12355 */
12356 OO.ui.ActionFieldLayout = function OoUiActionFieldLayout( fieldWidget, buttonWidget, config ) {
12357 // Allow passing positional parameters inside the config object
12358 if ( OO.isPlainObject( fieldWidget ) && config === undefined ) {
12359 config = fieldWidget;
12360 fieldWidget = config.fieldWidget;
12361 buttonWidget = config.buttonWidget;
12362 }
12363
12364 // Parent constructor
12365 OO.ui.ActionFieldLayout.parent.call( this, fieldWidget, config );
12366
12367 // Properties
12368 this.buttonWidget = buttonWidget;
12369 this.$button = $( '<span>' );
12370 this.$input = this.isFieldInline() ? $( '<span>' ) : $( '<div>' );
12371
12372 // Initialization
12373 this.$element.addClass( 'oo-ui-actionFieldLayout' );
12374 this.$button
12375 .addClass( 'oo-ui-actionFieldLayout-button' )
12376 .append( this.buttonWidget.$element );
12377 this.$input
12378 .addClass( 'oo-ui-actionFieldLayout-input' )
12379 .append( this.fieldWidget.$element );
12380 this.$field.append( this.$input, this.$button );
12381 };
12382
12383 /* Setup */
12384
12385 OO.inheritClass( OO.ui.ActionFieldLayout, OO.ui.FieldLayout );
12386
12387 /**
12388 * FieldsetLayouts are composed of one or more {@link OO.ui.FieldLayout FieldLayouts},
12389 * which each contain an individual widget and, optionally, a label. Each Fieldset can be
12390 * configured with a label as well. For more information and examples,
12391 * please see the [OOUI documentation on MediaWiki][1].
12392 *
12393 * @example
12394 * // Example of a fieldset layout
12395 * var input1 = new OO.ui.TextInputWidget( {
12396 * placeholder: 'A text input field'
12397 * } );
12398 *
12399 * var input2 = new OO.ui.TextInputWidget( {
12400 * placeholder: 'A text input field'
12401 * } );
12402 *
12403 * var fieldset = new OO.ui.FieldsetLayout( {
12404 * label: 'Example of a fieldset layout'
12405 * } );
12406 *
12407 * fieldset.addItems( [
12408 * new OO.ui.FieldLayout( input1, {
12409 * label: 'Field One'
12410 * } ),
12411 * new OO.ui.FieldLayout( input2, {
12412 * label: 'Field Two'
12413 * } )
12414 * ] );
12415 * $( document.body ).append( fieldset.$element );
12416 *
12417 * [1]: https://www.mediawiki.org/wiki/OOUI/Layouts/Fields_and_Fieldsets
12418 *
12419 * @class
12420 * @extends OO.ui.Layout
12421 * @mixins OO.ui.mixin.IconElement
12422 * @mixins OO.ui.mixin.LabelElement
12423 * @mixins OO.ui.mixin.GroupElement
12424 *
12425 * @constructor
12426 * @param {Object} [config] Configuration options
12427 * @cfg {OO.ui.FieldLayout[]} [items] An array of fields to add to the fieldset.
12428 * See OO.ui.FieldLayout for more information about fields.
12429 * @cfg {string|OO.ui.HtmlSnippet} [help] Help text. When help text is specified, a "help" icon
12430 * will appear in the upper-right corner of the rendered field; clicking it will display the text
12431 * in a popup. For important messages, you are advised to use `notices`, as they are always shown.
12432 * @cfg {jQuery} [$overlay] Passed to OO.ui.PopupButtonWidget for help popup, if `help` is given.
12433 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
12434 */
12435 OO.ui.FieldsetLayout = function OoUiFieldsetLayout( config ) {
12436 // Configuration initialization
12437 config = config || {};
12438
12439 // Parent constructor
12440 OO.ui.FieldsetLayout.parent.call( this, config );
12441
12442 // Mixin constructors
12443 OO.ui.mixin.IconElement.call( this, config );
12444 OO.ui.mixin.LabelElement.call( this, config );
12445 OO.ui.mixin.GroupElement.call( this, config );
12446
12447 // Properties
12448 this.$header = $( '<legend>' );
12449 if ( config.help ) {
12450 this.popupButtonWidget = new OO.ui.PopupButtonWidget( {
12451 $overlay: config.$overlay,
12452 popup: {
12453 padded: true
12454 },
12455 classes: [ 'oo-ui-fieldsetLayout-help' ],
12456 framed: false,
12457 icon: 'info',
12458 label: OO.ui.msg( 'ooui-field-help' ),
12459 invisibleLabel: true
12460 } );
12461 if ( config.help instanceof OO.ui.HtmlSnippet ) {
12462 this.popupButtonWidget.getPopup().$body.html( config.help.toString() );
12463 } else {
12464 this.popupButtonWidget.getPopup().$body.text( config.help );
12465 }
12466 this.$help = this.popupButtonWidget.$element;
12467 } else {
12468 this.$help = $( [] );
12469 }
12470
12471 // Initialization
12472 this.$header
12473 .addClass( 'oo-ui-fieldsetLayout-header' )
12474 .append( this.$icon, this.$label, this.$help );
12475 this.$group.addClass( 'oo-ui-fieldsetLayout-group' );
12476 this.$element
12477 .addClass( 'oo-ui-fieldsetLayout' )
12478 .prepend( this.$header, this.$group );
12479 if ( Array.isArray( config.items ) ) {
12480 this.addItems( config.items );
12481 }
12482 };
12483
12484 /* Setup */
12485
12486 OO.inheritClass( OO.ui.FieldsetLayout, OO.ui.Layout );
12487 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.mixin.IconElement );
12488 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.mixin.LabelElement );
12489 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.mixin.GroupElement );
12490
12491 /* Static Properties */
12492
12493 /**
12494 * @static
12495 * @inheritdoc
12496 */
12497 OO.ui.FieldsetLayout.static.tagName = 'fieldset';
12498
12499 /**
12500 * FormLayouts are used to wrap {@link OO.ui.FieldsetLayout FieldsetLayouts} when you intend to use
12501 * browser-based form submission for the fields instead of handling them in JavaScript. Form layouts
12502 * can be configured with an HTML form action, an encoding type, and a method using the #action,
12503 * #enctype, and #method configs, respectively.
12504 * See the [OOUI documentation on MediaWiki] [1] for more information and examples.
12505 *
12506 * Only widgets from the {@link OO.ui.InputWidget InputWidget} family support form submission. It
12507 * includes standard form elements like {@link OO.ui.CheckboxInputWidget checkboxes}, {@link
12508 * OO.ui.RadioInputWidget radio buttons} and {@link OO.ui.TextInputWidget text fields}, as well as
12509 * some fancier controls. Some controls have both regular and InputWidget variants, for example
12510 * OO.ui.DropdownWidget and OO.ui.DropdownInputWidget – only the latter support form submission and
12511 * often have simplified APIs to match the capabilities of HTML forms.
12512 * See the [OOUI documentation on MediaWiki] [2] for more information about InputWidgets.
12513 *
12514 * [1]: https://www.mediawiki.org/wiki/OOUI/Layouts/Forms
12515 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
12516 *
12517 * @example
12518 * // Example of a form layout that wraps a fieldset layout.
12519 * var input1 = new OO.ui.TextInputWidget( {
12520 * placeholder: 'Username'
12521 * } ),
12522 * input2 = new OO.ui.TextInputWidget( {
12523 * placeholder: 'Password',
12524 * type: 'password'
12525 * } ),
12526 * submit = new OO.ui.ButtonInputWidget( {
12527 * label: 'Submit'
12528 * } ),
12529 * fieldset = new OO.ui.FieldsetLayout( {
12530 * label: 'A form layout'
12531 * } );
12532 *
12533 * fieldset.addItems( [
12534 * new OO.ui.FieldLayout( input1, {
12535 * label: 'Username',
12536 * align: 'top'
12537 * } ),
12538 * new OO.ui.FieldLayout( input2, {
12539 * label: 'Password',
12540 * align: 'top'
12541 * } ),
12542 * new OO.ui.FieldLayout( submit )
12543 * ] );
12544 * var form = new OO.ui.FormLayout( {
12545 * items: [ fieldset ],
12546 * action: '/api/formhandler',
12547 * method: 'get'
12548 * } )
12549 * $( document.body ).append( form.$element );
12550 *
12551 * @class
12552 * @extends OO.ui.Layout
12553 * @mixins OO.ui.mixin.GroupElement
12554 *
12555 * @constructor
12556 * @param {Object} [config] Configuration options
12557 * @cfg {string} [method] HTML form `method` attribute
12558 * @cfg {string} [action] HTML form `action` attribute
12559 * @cfg {string} [enctype] HTML form `enctype` attribute
12560 * @cfg {OO.ui.FieldsetLayout[]} [items] Fieldset layouts to add to the form layout.
12561 */
12562 OO.ui.FormLayout = function OoUiFormLayout( config ) {
12563 var action;
12564
12565 // Configuration initialization
12566 config = config || {};
12567
12568 // Parent constructor
12569 OO.ui.FormLayout.parent.call( this, config );
12570
12571 // Mixin constructors
12572 OO.ui.mixin.GroupElement.call( this, $.extend( { $group: this.$element }, config ) );
12573
12574 // Events
12575 this.$element.on( 'submit', this.onFormSubmit.bind( this ) );
12576
12577 // Make sure the action is safe
12578 action = config.action;
12579 if ( action !== undefined && !OO.ui.isSafeUrl( action ) ) {
12580 action = './' + action;
12581 }
12582
12583 // Initialization
12584 this.$element
12585 .addClass( 'oo-ui-formLayout' )
12586 .attr( {
12587 method: config.method,
12588 action: action,
12589 enctype: config.enctype
12590 } );
12591 if ( Array.isArray( config.items ) ) {
12592 this.addItems( config.items );
12593 }
12594 };
12595
12596 /* Setup */
12597
12598 OO.inheritClass( OO.ui.FormLayout, OO.ui.Layout );
12599 OO.mixinClass( OO.ui.FormLayout, OO.ui.mixin.GroupElement );
12600
12601 /* Events */
12602
12603 /**
12604 * A 'submit' event is emitted when the form is submitted.
12605 *
12606 * @event submit
12607 */
12608
12609 /* Static Properties */
12610
12611 /**
12612 * @static
12613 * @inheritdoc
12614 */
12615 OO.ui.FormLayout.static.tagName = 'form';
12616
12617 /* Methods */
12618
12619 /**
12620 * Handle form submit events.
12621 *
12622 * @private
12623 * @param {jQuery.Event} e Submit event
12624 * @fires submit
12625 * @return {OO.ui.FormLayout} The layout, for chaining
12626 */
12627 OO.ui.FormLayout.prototype.onFormSubmit = function () {
12628 if ( this.emit( 'submit' ) ) {
12629 return false;
12630 }
12631 };
12632
12633 /**
12634 * PanelLayouts expand to cover the entire area of their parent. They can be configured with
12635 * scrolling, padding, and a frame, and are often used together with
12636 * {@link OO.ui.StackLayout StackLayouts}.
12637 *
12638 * @example
12639 * // Example of a panel layout
12640 * var panel = new OO.ui.PanelLayout( {
12641 * expanded: false,
12642 * framed: true,
12643 * padded: true,
12644 * $content: $( '<p>A panel layout with padding and a frame.</p>' )
12645 * } );
12646 * $( document.body ).append( panel.$element );
12647 *
12648 * @class
12649 * @extends OO.ui.Layout
12650 *
12651 * @constructor
12652 * @param {Object} [config] Configuration options
12653 * @cfg {boolean} [scrollable=false] Allow vertical scrolling
12654 * @cfg {boolean} [padded=false] Add padding between the content and the edges of the panel.
12655 * @cfg {boolean} [expanded=true] Expand the panel to fill the entire parent element.
12656 * @cfg {boolean} [framed=false] Render the panel with a frame to visually separate it from outside
12657 * content.
12658 */
12659 OO.ui.PanelLayout = function OoUiPanelLayout( config ) {
12660 // Configuration initialization
12661 config = $.extend( {
12662 scrollable: false,
12663 padded: false,
12664 expanded: true,
12665 framed: false
12666 }, config );
12667
12668 // Parent constructor
12669 OO.ui.PanelLayout.parent.call( this, config );
12670
12671 // Initialization
12672 this.$element.addClass( 'oo-ui-panelLayout' );
12673 if ( config.scrollable ) {
12674 this.$element.addClass( 'oo-ui-panelLayout-scrollable' );
12675 }
12676 if ( config.padded ) {
12677 this.$element.addClass( 'oo-ui-panelLayout-padded' );
12678 }
12679 if ( config.expanded ) {
12680 this.$element.addClass( 'oo-ui-panelLayout-expanded' );
12681 }
12682 if ( config.framed ) {
12683 this.$element.addClass( 'oo-ui-panelLayout-framed' );
12684 }
12685 };
12686
12687 /* Setup */
12688
12689 OO.inheritClass( OO.ui.PanelLayout, OO.ui.Layout );
12690
12691 /* Static Methods */
12692
12693 /**
12694 * @inheritdoc
12695 */
12696 OO.ui.PanelLayout.static.reusePreInfuseDOM = function ( node, config ) {
12697 config = OO.ui.PanelLayout.parent.static.reusePreInfuseDOM( node, config );
12698 if ( config.preserveContent !== false ) {
12699 config.$content = $( node ).contents();
12700 }
12701 return config;
12702 };
12703
12704 /* Methods */
12705
12706 /**
12707 * Focus the panel layout
12708 *
12709 * The default implementation just focuses the first focusable element in the panel
12710 */
12711 OO.ui.PanelLayout.prototype.focus = function () {
12712 OO.ui.findFocusable( this.$element ).focus();
12713 };
12714
12715 /**
12716 * HorizontalLayout arranges its contents in a single line (using `display: inline-block` for its
12717 * items), with small margins between them. Convenient when you need to put a number of block-level
12718 * widgets on a single line next to each other.
12719 *
12720 * Note that inline elements, such as OO.ui.ButtonWidgets, do not need this wrapper.
12721 *
12722 * @example
12723 * // HorizontalLayout with a text input and a label.
12724 * var layout = new OO.ui.HorizontalLayout( {
12725 * items: [
12726 * new OO.ui.LabelWidget( { label: 'Label' } ),
12727 * new OO.ui.TextInputWidget( { value: 'Text' } )
12728 * ]
12729 * } );
12730 * $( document.body ).append( layout.$element );
12731 *
12732 * @class
12733 * @extends OO.ui.Layout
12734 * @mixins OO.ui.mixin.GroupElement
12735 *
12736 * @constructor
12737 * @param {Object} [config] Configuration options
12738 * @cfg {OO.ui.Widget[]|OO.ui.Layout[]} [items] Widgets or other layouts to add to the layout.
12739 */
12740 OO.ui.HorizontalLayout = function OoUiHorizontalLayout( config ) {
12741 // Configuration initialization
12742 config = config || {};
12743
12744 // Parent constructor
12745 OO.ui.HorizontalLayout.parent.call( this, config );
12746
12747 // Mixin constructors
12748 OO.ui.mixin.GroupElement.call( this, $.extend( { $group: this.$element }, config ) );
12749
12750 // Initialization
12751 this.$element.addClass( 'oo-ui-horizontalLayout' );
12752 if ( Array.isArray( config.items ) ) {
12753 this.addItems( config.items );
12754 }
12755 };
12756
12757 /* Setup */
12758
12759 OO.inheritClass( OO.ui.HorizontalLayout, OO.ui.Layout );
12760 OO.mixinClass( OO.ui.HorizontalLayout, OO.ui.mixin.GroupElement );
12761
12762 /**
12763 * NumberInputWidgets combine a {@link OO.ui.TextInputWidget text input} (where a value
12764 * can be entered manually) and two {@link OO.ui.ButtonWidget button widgets}
12765 * (to adjust the value in increments) to allow the user to enter a number.
12766 *
12767 * @example
12768 * // A NumberInputWidget.
12769 * var numberInput = new OO.ui.NumberInputWidget( {
12770 * label: 'NumberInputWidget',
12771 * input: { value: 5 },
12772 * min: 1,
12773 * max: 10
12774 * } );
12775 * $( document.body ).append( numberInput.$element );
12776 *
12777 * @class
12778 * @extends OO.ui.TextInputWidget
12779 *
12780 * @constructor
12781 * @param {Object} [config] Configuration options
12782 * @cfg {Object} [minusButton] Configuration options to pass to the
12783 * {@link OO.ui.ButtonWidget decrementing button widget}.
12784 * @cfg {Object} [plusButton] Configuration options to pass to the
12785 * {@link OO.ui.ButtonWidget incrementing button widget}.
12786 * @cfg {number} [min=-Infinity] Minimum allowed value
12787 * @cfg {number} [max=Infinity] Maximum allowed value
12788 * @cfg {number|null} [step] If specified, the field only accepts values that are multiples of this.
12789 * @cfg {number} [buttonStep=step||1] Delta when using the buttons or Up/Down arrow keys.
12790 * Defaults to `step` if specified, otherwise `1`.
12791 * @cfg {number} [pageStep=10*buttonStep] Delta when using the Page-up/Page-down keys.
12792 * Defaults to 10 times `buttonStep`.
12793 * @cfg {boolean} [showButtons=true] Whether to show the plus and minus buttons.
12794 */
12795 OO.ui.NumberInputWidget = function OoUiNumberInputWidget( config ) {
12796 var $field = $( '<div>' ).addClass( 'oo-ui-numberInputWidget-field' );
12797
12798 // Configuration initialization
12799 config = $.extend( {
12800 min: -Infinity,
12801 max: Infinity,
12802 showButtons: true
12803 }, config );
12804
12805 // For backward compatibility
12806 $.extend( config, config.input );
12807 this.input = this;
12808
12809 // Parent constructor
12810 OO.ui.NumberInputWidget.parent.call( this, $.extend( config, {
12811 type: 'number'
12812 } ) );
12813
12814 if ( config.showButtons ) {
12815 this.minusButton = new OO.ui.ButtonWidget( $.extend(
12816 {
12817 disabled: this.isDisabled(),
12818 tabIndex: -1,
12819 classes: [ 'oo-ui-numberInputWidget-minusButton' ],
12820 icon: 'subtract'
12821 },
12822 config.minusButton
12823 ) );
12824 this.minusButton.$element.attr( 'aria-hidden', 'true' );
12825 this.plusButton = new OO.ui.ButtonWidget( $.extend(
12826 {
12827 disabled: this.isDisabled(),
12828 tabIndex: -1,
12829 classes: [ 'oo-ui-numberInputWidget-plusButton' ],
12830 icon: 'add'
12831 },
12832 config.plusButton
12833 ) );
12834 this.plusButton.$element.attr( 'aria-hidden', 'true' );
12835 }
12836
12837 // Events
12838 this.$input.on( {
12839 keydown: this.onKeyDown.bind( this ),
12840 'wheel mousewheel DOMMouseScroll': this.onWheel.bind( this )
12841 } );
12842 if ( config.showButtons ) {
12843 this.plusButton.connect( this, {
12844 click: [ 'onButtonClick', +1 ]
12845 } );
12846 this.minusButton.connect( this, {
12847 click: [ 'onButtonClick', -1 ]
12848 } );
12849 }
12850
12851 // Build the field
12852 $field.append( this.$input );
12853 if ( config.showButtons ) {
12854 $field
12855 .prepend( this.minusButton.$element )
12856 .append( this.plusButton.$element );
12857 }
12858
12859 // Initialization
12860 if ( config.allowInteger || config.isInteger ) {
12861 // Backward compatibility
12862 config.step = 1;
12863 }
12864 this.setRange( config.min, config.max );
12865 this.setStep( config.buttonStep, config.pageStep, config.step );
12866 // Set the validation method after we set step and range
12867 // so that it doesn't immediately call setValidityFlag
12868 this.setValidation( this.validateNumber.bind( this ) );
12869
12870 this.$element
12871 .addClass( 'oo-ui-numberInputWidget' )
12872 .toggleClass( 'oo-ui-numberInputWidget-buttoned', config.showButtons )
12873 .append( $field );
12874 };
12875
12876 /* Setup */
12877
12878 OO.inheritClass( OO.ui.NumberInputWidget, OO.ui.TextInputWidget );
12879
12880 /* Methods */
12881
12882 // Backward compatibility
12883 OO.ui.NumberInputWidget.prototype.setAllowInteger = function ( flag ) {
12884 this.setStep( flag ? 1 : null );
12885 };
12886 // Backward compatibility
12887 OO.ui.NumberInputWidget.prototype.setIsInteger = OO.ui.NumberInputWidget.prototype.setAllowInteger;
12888
12889 // Backward compatibility
12890 OO.ui.NumberInputWidget.prototype.getAllowInteger = function () {
12891 return this.step === 1;
12892 };
12893 // Backward compatibility
12894 OO.ui.NumberInputWidget.prototype.getIsInteger = OO.ui.NumberInputWidget.prototype.getAllowInteger;
12895
12896 /**
12897 * Set the range of allowed values
12898 *
12899 * @param {number} min Minimum allowed value
12900 * @param {number} max Maximum allowed value
12901 */
12902 OO.ui.NumberInputWidget.prototype.setRange = function ( min, max ) {
12903 if ( min > max ) {
12904 throw new Error( 'Minimum (' + min + ') must not be greater than maximum (' + max + ')' );
12905 }
12906 this.min = min;
12907 this.max = max;
12908 this.$input.attr( 'min', this.min );
12909 this.$input.attr( 'max', this.max );
12910 this.setValidityFlag();
12911 };
12912
12913 /**
12914 * Get the current range
12915 *
12916 * @return {number[]} Minimum and maximum values
12917 */
12918 OO.ui.NumberInputWidget.prototype.getRange = function () {
12919 return [ this.min, this.max ];
12920 };
12921
12922 /**
12923 * Set the stepping deltas
12924 *
12925 * @param {number} [buttonStep=step||1] Delta when using the buttons or up/down arrow keys.
12926 * Defaults to `step` if specified, otherwise `1`.
12927 * @param {number} [pageStep=10*buttonStep] Delta when using the page-up/page-down keys.
12928 * Defaults to 10 times `buttonStep`.
12929 * @param {number|null} [step] If specified, the field only accepts values that are multiples
12930 * of this.
12931 */
12932 OO.ui.NumberInputWidget.prototype.setStep = function ( buttonStep, pageStep, step ) {
12933 if ( buttonStep === undefined ) {
12934 buttonStep = step || 1;
12935 }
12936 if ( pageStep === undefined ) {
12937 pageStep = 10 * buttonStep;
12938 }
12939 if ( step !== null && step <= 0 ) {
12940 throw new Error( 'Step value, if given, must be positive' );
12941 }
12942 if ( buttonStep <= 0 ) {
12943 throw new Error( 'Button step value must be positive' );
12944 }
12945 if ( pageStep <= 0 ) {
12946 throw new Error( 'Page step value must be positive' );
12947 }
12948 this.step = step;
12949 this.buttonStep = buttonStep;
12950 this.pageStep = pageStep;
12951 this.$input.attr( 'step', this.step || 'any' );
12952 this.setValidityFlag();
12953 };
12954
12955 /**
12956 * @inheritdoc
12957 */
12958 OO.ui.NumberInputWidget.prototype.setValue = function ( value ) {
12959 if ( value === '' ) {
12960 // Some browsers allow a value in the input even if there isn't one reported by $input.val()
12961 // so here we make sure an 'empty' value is actually displayed as such.
12962 this.$input.val( '' );
12963 }
12964 return OO.ui.NumberInputWidget.parent.prototype.setValue.call( this, value );
12965 };
12966
12967 /**
12968 * Get the current stepping values
12969 *
12970 * @return {number[]} Button step, page step, and validity step
12971 */
12972 OO.ui.NumberInputWidget.prototype.getStep = function () {
12973 return [ this.buttonStep, this.pageStep, this.step ];
12974 };
12975
12976 /**
12977 * Get the current value of the widget as a number
12978 *
12979 * @return {number} May be NaN, or an invalid number
12980 */
12981 OO.ui.NumberInputWidget.prototype.getNumericValue = function () {
12982 return +this.getValue();
12983 };
12984
12985 /**
12986 * Adjust the value of the widget
12987 *
12988 * @param {number} delta Adjustment amount
12989 */
12990 OO.ui.NumberInputWidget.prototype.adjustValue = function ( delta ) {
12991 var n, v = this.getNumericValue();
12992
12993 delta = +delta;
12994 if ( isNaN( delta ) || !isFinite( delta ) ) {
12995 throw new Error( 'Delta must be a finite number' );
12996 }
12997
12998 if ( isNaN( v ) ) {
12999 n = 0;
13000 } else {
13001 n = v + delta;
13002 n = Math.max( Math.min( n, this.max ), this.min );
13003 if ( this.step ) {
13004 n = Math.round( n / this.step ) * this.step;
13005 }
13006 }
13007
13008 if ( n !== v ) {
13009 this.setValue( n );
13010 }
13011 };
13012 /**
13013 * Validate input
13014 *
13015 * @private
13016 * @param {string} value Field value
13017 * @return {boolean}
13018 */
13019 OO.ui.NumberInputWidget.prototype.validateNumber = function ( value ) {
13020 var n = +value;
13021 if ( value === '' ) {
13022 return !this.isRequired();
13023 }
13024
13025 if ( isNaN( n ) || !isFinite( n ) ) {
13026 return false;
13027 }
13028
13029 if ( this.step && Math.floor( n / this.step ) !== n / this.step ) {
13030 return false;
13031 }
13032
13033 if ( n < this.min || n > this.max ) {
13034 return false;
13035 }
13036
13037 return true;
13038 };
13039
13040 /**
13041 * Handle mouse click events.
13042 *
13043 * @private
13044 * @param {number} dir +1 or -1
13045 */
13046 OO.ui.NumberInputWidget.prototype.onButtonClick = function ( dir ) {
13047 this.adjustValue( dir * this.buttonStep );
13048 };
13049
13050 /**
13051 * Handle mouse wheel events.
13052 *
13053 * @private
13054 * @param {jQuery.Event} event
13055 * @return {undefined|boolean} False to prevent default if event is handled
13056 */
13057 OO.ui.NumberInputWidget.prototype.onWheel = function ( event ) {
13058 var delta = 0;
13059
13060 if ( this.isDisabled() || this.isReadOnly() ) {
13061 return;
13062 }
13063
13064 if ( this.$input.is( ':focus' ) ) {
13065 // Standard 'wheel' event
13066 if ( event.originalEvent.deltaMode !== undefined ) {
13067 this.sawWheelEvent = true;
13068 }
13069 if ( event.originalEvent.deltaY ) {
13070 delta = -event.originalEvent.deltaY;
13071 } else if ( event.originalEvent.deltaX ) {
13072 delta = event.originalEvent.deltaX;
13073 }
13074
13075 // Non-standard events
13076 if ( !this.sawWheelEvent ) {
13077 if ( event.originalEvent.wheelDeltaX ) {
13078 delta = -event.originalEvent.wheelDeltaX;
13079 } else if ( event.originalEvent.wheelDeltaY ) {
13080 delta = event.originalEvent.wheelDeltaY;
13081 } else if ( event.originalEvent.wheelDelta ) {
13082 delta = event.originalEvent.wheelDelta;
13083 } else if ( event.originalEvent.detail ) {
13084 delta = -event.originalEvent.detail;
13085 }
13086 }
13087
13088 if ( delta ) {
13089 delta = delta < 0 ? -1 : 1;
13090 this.adjustValue( delta * this.buttonStep );
13091 }
13092
13093 return false;
13094 }
13095 };
13096
13097 /**
13098 * Handle key down events.
13099 *
13100 * @private
13101 * @param {jQuery.Event} e Key down event
13102 * @return {undefined|boolean} False to prevent default if event is handled
13103 */
13104 OO.ui.NumberInputWidget.prototype.onKeyDown = function ( e ) {
13105 if ( this.isDisabled() || this.isReadOnly() ) {
13106 return;
13107 }
13108
13109 switch ( e.which ) {
13110 case OO.ui.Keys.UP:
13111 this.adjustValue( this.buttonStep );
13112 return false;
13113 case OO.ui.Keys.DOWN:
13114 this.adjustValue( -this.buttonStep );
13115 return false;
13116 case OO.ui.Keys.PAGEUP:
13117 this.adjustValue( this.pageStep );
13118 return false;
13119 case OO.ui.Keys.PAGEDOWN:
13120 this.adjustValue( -this.pageStep );
13121 return false;
13122 }
13123 };
13124
13125 /**
13126 * Update the disabled state of the controls
13127 *
13128 * @chainable
13129 * @protected
13130 * @return {OO.ui.NumberInputWidget} The widget, for chaining
13131 */
13132 OO.ui.NumberInputWidget.prototype.updateControlsDisabled = function () {
13133 var disabled = this.isDisabled() || this.isReadOnly();
13134 if ( this.minusButton ) {
13135 this.minusButton.setDisabled( disabled );
13136 }
13137 if ( this.plusButton ) {
13138 this.plusButton.setDisabled( disabled );
13139 }
13140 return this;
13141 };
13142
13143 /**
13144 * @inheritdoc
13145 */
13146 OO.ui.NumberInputWidget.prototype.setDisabled = function ( disabled ) {
13147 // Parent method
13148 OO.ui.NumberInputWidget.parent.prototype.setDisabled.call( this, disabled );
13149 this.updateControlsDisabled();
13150 return this;
13151 };
13152
13153 /**
13154 * @inheritdoc
13155 */
13156 OO.ui.NumberInputWidget.prototype.setReadOnly = function () {
13157 // Parent method
13158 OO.ui.NumberInputWidget.parent.prototype.setReadOnly.apply( this, arguments );
13159 this.updateControlsDisabled();
13160 return this;
13161 };
13162
13163 /**
13164 * SelectFileInputWidgets allow for selecting files, using <input type="file">. These
13165 * widgets can be configured with {@link OO.ui.mixin.IconElement icons}, {@link
13166 * OO.ui.mixin.IndicatorElement indicators} and {@link OO.ui.mixin.TitledElement titles}.
13167 * Please see the [OOUI documentation on MediaWiki] [1] for more information and examples.
13168 *
13169 * SelectFileInputWidgets must be used in HTML forms, as getValue only returns the filename.
13170 *
13171 * @example
13172 * // A file select input widget.
13173 * var selectFile = new OO.ui.SelectFileInputWidget();
13174 * $( document.body ).append( selectFile.$element );
13175 *
13176 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets
13177 *
13178 * @class
13179 * @extends OO.ui.InputWidget
13180 *
13181 * @constructor
13182 * @param {Object} [config] Configuration options
13183 * @cfg {string[]|null} [accept=null] MIME types to accept. null accepts all types.
13184 * @cfg {boolean} [multiple=false] Allow multiple files to be selected.
13185 * @cfg {string} [placeholder] Text to display when no file is selected.
13186 * @cfg {Object} [button] Config to pass to select file button.
13187 * @cfg {string} [icon] Icon to show next to file info
13188 */
13189 OO.ui.SelectFileInputWidget = function OoUiSelectFileInputWidget( config ) {
13190 var widget = this;
13191
13192 config = config || {};
13193
13194 // Construct buttons before parent method is called (calling setDisabled)
13195 this.selectButton = new OO.ui.ButtonWidget( $.extend( {
13196 $element: $( '<label>' ),
13197 classes: [ 'oo-ui-selectFileInputWidget-selectButton' ],
13198 label: OO.ui.msg( 'ooui-selectfile-button-select' )
13199 }, config.button ) );
13200
13201 // Configuration initialization
13202 config = $.extend( {
13203 accept: null,
13204 placeholder: OO.ui.msg( 'ooui-selectfile-placeholder' ),
13205 $tabIndexed: this.selectButton.$tabIndexed
13206 }, config );
13207
13208 this.info = new OO.ui.SearchInputWidget( {
13209 classes: [ 'oo-ui-selectFileInputWidget-info' ],
13210 placeholder: config.placeholder,
13211 // Pass an empty collection so that .focus() always does nothing
13212 $tabIndexed: $( [] )
13213 } ).setIcon( config.icon );
13214 // Set tabindex manually on $input as $tabIndexed has been overridden
13215 this.info.$input.attr( 'tabindex', -1 );
13216
13217 // Parent constructor
13218 OO.ui.SelectFileInputWidget.parent.call( this, config );
13219
13220 // Properties
13221 this.currentFiles = this.filterFiles( this.$input[ 0 ].files || [] );
13222 if ( Array.isArray( config.accept ) ) {
13223 this.accept = config.accept;
13224 } else {
13225 this.accept = null;
13226 }
13227 this.multiple = !!config.multiple;
13228
13229 // Events
13230 this.info.connect( this, { change: 'onInfoChange' } );
13231 this.selectButton.$button.on( {
13232 keypress: this.onKeyPress.bind( this )
13233 } );
13234 this.$input.on( {
13235 change: this.onFileSelected.bind( this ),
13236 // Support: IE11
13237 // In IE 11, focussing a file input (by clicking on it) displays a text cursor and scrolls
13238 // the cursor into view (in this case, it scrolls the button, which has 'overflow: hidden').
13239 // Since this messes with our custom styling (the file input has large dimensions and this
13240 // causes the label to scroll out of view), scroll the button back to top. (T192131)
13241 focus: function () {
13242 widget.$input.parent().prop( 'scrollTop', 0 );
13243 }
13244 } );
13245 this.connect( this, { change: 'updateUI' } );
13246
13247 this.fieldLayout = new OO.ui.ActionFieldLayout( this.info, this.selectButton, { align: 'top' } );
13248
13249 this.$input
13250 .attr( {
13251 type: 'file',
13252 // this.selectButton is tabindexed
13253 tabindex: -1,
13254 // Infused input may have previously by
13255 // TabIndexed, so remove aria-disabled attr.
13256 'aria-disabled': null
13257 } );
13258
13259 if ( this.accept ) {
13260 this.$input.attr( 'accept', this.accept.join( ', ' ) );
13261 }
13262 if ( this.multiple ) {
13263 this.$input.attr( 'multiple', '' );
13264 }
13265 this.selectButton.$button.append( this.$input );
13266
13267 this.$element
13268 .addClass( 'oo-ui-selectFileInputWidget' )
13269 .append( this.fieldLayout.$element );
13270
13271 this.updateUI();
13272 };
13273
13274 /* Setup */
13275
13276 OO.inheritClass( OO.ui.SelectFileInputWidget, OO.ui.InputWidget );
13277
13278 /* Static properties */
13279
13280 // Set empty title so that browser default tooltips like "No file chosen" don't appear.
13281 // On SelectFileWidget this tooltip will often be incorrect, so create a consistent
13282 // experience on SelectFileInputWidget.
13283 OO.ui.SelectFileInputWidget.static.title = '';
13284
13285 /* Methods */
13286
13287 /**
13288 * Get the filename of the currently selected file.
13289 *
13290 * @return {string} Filename
13291 */
13292 OO.ui.SelectFileInputWidget.prototype.getFilename = function () {
13293 if ( this.currentFiles.length ) {
13294 return this.currentFiles.map( function ( file ) {
13295 return file.name;
13296 } ).join( ', ' );
13297 } else {
13298 // Try to strip leading fakepath.
13299 return this.getValue().split( '\\' ).pop();
13300 }
13301 };
13302
13303 /**
13304 * @inheritdoc
13305 */
13306 OO.ui.SelectFileInputWidget.prototype.setValue = function ( value ) {
13307 if ( value === undefined ) {
13308 // Called during init, don't replace value if just infusing.
13309 return;
13310 }
13311 if ( value ) {
13312 // We need to update this.value, but without trying to modify
13313 // the DOM value, which would throw an exception.
13314 if ( this.value !== value ) {
13315 this.value = value;
13316 this.emit( 'change', this.value );
13317 }
13318 } else {
13319 this.currentFiles = [];
13320 // Parent method
13321 OO.ui.SelectFileInputWidget.super.prototype.setValue.call( this, '' );
13322 }
13323 };
13324
13325 /**
13326 * Handle file selection from the input.
13327 *
13328 * @protected
13329 * @param {jQuery.Event} e
13330 */
13331 OO.ui.SelectFileInputWidget.prototype.onFileSelected = function ( e ) {
13332 this.currentFiles = this.filterFiles( e.target.files || [] );
13333 };
13334
13335 /**
13336 * Update the user interface when a file is selected or unselected.
13337 *
13338 * @protected
13339 */
13340 OO.ui.SelectFileInputWidget.prototype.updateUI = function () {
13341 this.info.setValue( this.getFilename() );
13342 };
13343
13344 /**
13345 * Determine if we should accept this file.
13346 *
13347 * @private
13348 * @param {FileList|File[]} files Files to filter
13349 * @return {File[]} Filter files
13350 */
13351 OO.ui.SelectFileInputWidget.prototype.filterFiles = function ( files ) {
13352 var accept = this.accept;
13353
13354 function mimeAllowed( file ) {
13355 var i, mimeTest,
13356 mimeType = file.type;
13357
13358 if ( !accept || !mimeType ) {
13359 return true;
13360 }
13361
13362 for ( i = 0; i < accept.length; i++ ) {
13363 mimeTest = accept[ i ];
13364 if ( mimeTest === mimeType ) {
13365 return true;
13366 } else if ( mimeTest.substr( -2 ) === '/*' ) {
13367 mimeTest = mimeTest.substr( 0, mimeTest.length - 1 );
13368 if ( mimeType.substr( 0, mimeTest.length ) === mimeTest ) {
13369 return true;
13370 }
13371 }
13372 }
13373 return false;
13374 }
13375
13376 return Array.prototype.filter.call( files, mimeAllowed );
13377 };
13378
13379 /**
13380 * Handle info input change events
13381 *
13382 * The info widget can only be changed by the user
13383 * with the clear button.
13384 *
13385 * @private
13386 * @param {string} value
13387 */
13388 OO.ui.SelectFileInputWidget.prototype.onInfoChange = function ( value ) {
13389 if ( value === '' ) {
13390 this.setValue( null );
13391 }
13392 };
13393
13394 /**
13395 * Handle key press events.
13396 *
13397 * @private
13398 * @param {jQuery.Event} e Key press event
13399 * @return {undefined|boolean} False to prevent default if event is handled
13400 */
13401 OO.ui.SelectFileInputWidget.prototype.onKeyPress = function ( e ) {
13402 if ( !this.isDisabled() && this.$input &&
13403 ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
13404 ) {
13405 // Emit a click to open the file selector.
13406 this.$input.trigger( 'click' );
13407 // Taking focus from the selectButton means keyUp isn't fired, so fire it manually.
13408 this.selectButton.onDocumentKeyUp( e );
13409 return false;
13410 }
13411 };
13412
13413 /**
13414 * @inheritdoc
13415 */
13416 OO.ui.SelectFileInputWidget.prototype.setDisabled = function ( disabled ) {
13417 // Parent method
13418 OO.ui.SelectFileInputWidget.parent.prototype.setDisabled.call( this, disabled );
13419
13420 this.selectButton.setDisabled( disabled );
13421 this.info.setDisabled( disabled );
13422
13423 return this;
13424 };
13425
13426 }( OO ) );
13427
13428 //# sourceMappingURL=oojs-ui-core.js.map.json