Merge "Warn if stateful ParserOutput transforms are used"
[lhc/web/wiklou.git] / resources / lib / oojs-ui / oojs-ui-core.js
1 /*!
2 * OOUI v0.25.1
3 * https://www.mediawiki.org/wiki/OOUI
4 *
5 * Copyright 2011–2018 OOUI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
8 *
9 * Date: 2018-01-17T01:47:15Z
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, otherwise only match descendants
215 * @return {boolean} The node is in the list of target nodes
216 */
217 OO.ui.contains = function ( containers, contained, matchContainers ) {
218 var i;
219 if ( !Array.isArray( containers ) ) {
220 containers = [ containers ];
221 }
222 for ( i = containers.length - 1; i >= 0; i-- ) {
223 if ( ( matchContainers && contained === containers[ i ] ) || $.contains( containers[ i ], contained ) ) {
224 return true;
225 }
226 }
227 return false;
228 };
229
230 /**
231 * Return a function, that, as long as it continues to be invoked, will not
232 * be triggered. The function will be called after it stops being called for
233 * N milliseconds. If `immediate` is passed, trigger the function on the
234 * leading edge, instead of the trailing.
235 *
236 * Ported from: http://underscorejs.org/underscore.js
237 *
238 * @param {Function} func Function to debounce
239 * @param {number} [wait=0] Wait period in milliseconds
240 * @param {boolean} [immediate] Trigger on leading edge
241 * @return {Function} Debounced function
242 */
243 OO.ui.debounce = function ( func, wait, immediate ) {
244 var timeout;
245 return function () {
246 var context = this,
247 args = arguments,
248 later = function () {
249 timeout = null;
250 if ( !immediate ) {
251 func.apply( context, args );
252 }
253 };
254 if ( immediate && !timeout ) {
255 func.apply( context, args );
256 }
257 if ( !timeout || wait ) {
258 clearTimeout( timeout );
259 timeout = setTimeout( later, wait );
260 }
261 };
262 };
263
264 /**
265 * Puts a console warning with provided message.
266 *
267 * @param {string} message Message
268 */
269 OO.ui.warnDeprecation = function ( message ) {
270 if ( OO.getProp( window, 'console', 'warn' ) !== undefined ) {
271 // eslint-disable-next-line no-console
272 console.warn( message );
273 }
274 };
275
276 /**
277 * Returns a function, that, when invoked, will only be triggered at most once
278 * during a given window of time. If called again during that window, it will
279 * wait until the window ends and then trigger itself again.
280 *
281 * As it's not knowable to the caller whether the function will actually run
282 * when the wrapper is called, return values from the function are entirely
283 * discarded.
284 *
285 * @param {Function} func Function to throttle
286 * @param {number} wait Throttle window length, in milliseconds
287 * @return {Function} Throttled function
288 */
289 OO.ui.throttle = function ( func, wait ) {
290 var context, args, timeout,
291 previous = 0,
292 run = function () {
293 timeout = null;
294 previous = OO.ui.now();
295 func.apply( context, args );
296 };
297 return function () {
298 // Check how long it's been since the last time the function was
299 // called, and whether it's more or less than the requested throttle
300 // period. If it's less, run the function immediately. If it's more,
301 // set a timeout for the remaining time -- but don't replace an
302 // existing timeout, since that'd indefinitely prolong the wait.
303 var remaining = wait - ( OO.ui.now() - previous );
304 context = this;
305 args = arguments;
306 if ( remaining <= 0 ) {
307 // Note: unless wait was ridiculously large, this means we'll
308 // automatically run the first time the function was called in a
309 // given period. (If you provide a wait period larger than the
310 // current Unix timestamp, you *deserve* unexpected behavior.)
311 clearTimeout( timeout );
312 run();
313 } else if ( !timeout ) {
314 timeout = setTimeout( run, remaining );
315 }
316 };
317 };
318
319 /**
320 * A (possibly faster) way to get the current timestamp as an integer
321 *
322 * @return {number} Current timestamp, in milliseconds since the Unix epoch
323 */
324 OO.ui.now = Date.now || function () {
325 return new Date().getTime();
326 };
327
328 /**
329 * Reconstitute a JavaScript object corresponding to a widget created by
330 * the PHP implementation.
331 *
332 * This is an alias for `OO.ui.Element.static.infuse()`.
333 *
334 * @param {string|HTMLElement|jQuery} idOrNode
335 * A DOM id (if a string) or node for the widget to infuse.
336 * @return {OO.ui.Element}
337 * The `OO.ui.Element` corresponding to this (infusable) document node.
338 */
339 OO.ui.infuse = function ( idOrNode ) {
340 return OO.ui.Element.static.infuse( idOrNode );
341 };
342
343 ( function () {
344 /**
345 * Message store for the default implementation of OO.ui.msg
346 *
347 * Environments that provide a localization system should not use this, but should override
348 * OO.ui.msg altogether.
349 *
350 * @private
351 */
352 var messages = {
353 // Tool tip for a button that moves items in a list down one place
354 'ooui-outline-control-move-down': 'Move item down',
355 // Tool tip for a button that moves items in a list up one place
356 'ooui-outline-control-move-up': 'Move item up',
357 // Tool tip for a button that removes items from a list
358 'ooui-outline-control-remove': 'Remove item',
359 // Label for the toolbar group that contains a list of all other available tools
360 'ooui-toolbar-more': 'More',
361 // Label for the fake tool that expands the full list of tools in a toolbar group
362 'ooui-toolgroup-expand': 'More',
363 // Label for the fake tool that collapses the full list of tools in a toolbar group
364 'ooui-toolgroup-collapse': 'Fewer',
365 // Default label for the tooltip for the button that removes a tag item
366 'ooui-item-remove': 'Remove',
367 // Default label for the accept button of a confirmation dialog
368 'ooui-dialog-message-accept': 'OK',
369 // Default label for the reject button of a confirmation dialog
370 'ooui-dialog-message-reject': 'Cancel',
371 // Title for process dialog error description
372 'ooui-dialog-process-error': 'Something went wrong',
373 // Label for process dialog dismiss error button, visible when describing errors
374 'ooui-dialog-process-dismiss': 'Dismiss',
375 // Label for process dialog retry action button, visible when describing only recoverable errors
376 'ooui-dialog-process-retry': 'Try again',
377 // Label for process dialog retry action button, visible when describing only warnings
378 'ooui-dialog-process-continue': 'Continue',
379 // Label for the file selection widget's select file button
380 'ooui-selectfile-button-select': 'Select a file',
381 // Label for the file selection widget if file selection is not supported
382 'ooui-selectfile-not-supported': 'File selection is not supported',
383 // Label for the file selection widget when no file is currently selected
384 'ooui-selectfile-placeholder': 'No file is selected',
385 // Label for the file selection widget's drop target
386 'ooui-selectfile-dragdrop-placeholder': 'Drop file here'
387 };
388
389 /**
390 * Get a localized message.
391 *
392 * After the message key, message parameters may optionally be passed. In the default implementation,
393 * any occurrences of $1 are replaced with the first parameter, $2 with the second parameter, etc.
394 * Alternative implementations of OO.ui.msg may use any substitution system they like, as long as
395 * they support unnamed, ordered message parameters.
396 *
397 * In environments that provide a localization system, this function should be overridden to
398 * return the message translated in the user's language. The default implementation always returns
399 * English messages. An example of doing this with [jQuery.i18n](https://github.com/wikimedia/jquery.i18n)
400 * follows.
401 *
402 * @example
403 * var i, iLen, button,
404 * messagePath = 'oojs-ui/dist/i18n/',
405 * languages = [ $.i18n().locale, 'ur', 'en' ],
406 * languageMap = {};
407 *
408 * for ( i = 0, iLen = languages.length; i < iLen; i++ ) {
409 * languageMap[ languages[ i ] ] = messagePath + languages[ i ].toLowerCase() + '.json';
410 * }
411 *
412 * $.i18n().load( languageMap ).done( function() {
413 * // Replace the built-in `msg` only once we've loaded the internationalization.
414 * // OOUI uses `OO.ui.deferMsg` for all initially-loaded messages. So long as
415 * // you put off creating any widgets until this promise is complete, no English
416 * // will be displayed.
417 * OO.ui.msg = $.i18n;
418 *
419 * // A button displaying "OK" in the default locale
420 * button = new OO.ui.ButtonWidget( {
421 * label: OO.ui.msg( 'ooui-dialog-message-accept' ),
422 * icon: 'check'
423 * } );
424 * $( 'body' ).append( button.$element );
425 *
426 * // A button displaying "OK" in Urdu
427 * $.i18n().locale = 'ur';
428 * button = new OO.ui.ButtonWidget( {
429 * label: OO.ui.msg( 'ooui-dialog-message-accept' ),
430 * icon: 'check'
431 * } );
432 * $( 'body' ).append( button.$element );
433 * } );
434 *
435 * @param {string} key Message key
436 * @param {...Mixed} [params] Message parameters
437 * @return {string} Translated message with parameters substituted
438 */
439 OO.ui.msg = function ( key ) {
440 var message = messages[ key ],
441 params = Array.prototype.slice.call( arguments, 1 );
442 if ( typeof message === 'string' ) {
443 // Perform $1 substitution
444 message = message.replace( /\$(\d+)/g, function ( unused, n ) {
445 var i = parseInt( n, 10 );
446 return params[ i - 1 ] !== undefined ? params[ i - 1 ] : '$' + n;
447 } );
448 } else {
449 // Return placeholder if message not found
450 message = '[' + key + ']';
451 }
452 return message;
453 };
454 }() );
455
456 /**
457 * Package a message and arguments for deferred resolution.
458 *
459 * Use this when you are statically specifying a message and the message may not yet be present.
460 *
461 * @param {string} key Message key
462 * @param {...Mixed} [params] Message parameters
463 * @return {Function} Function that returns the resolved message when executed
464 */
465 OO.ui.deferMsg = function () {
466 var args = arguments;
467 return function () {
468 return OO.ui.msg.apply( OO.ui, args );
469 };
470 };
471
472 /**
473 * Resolve a message.
474 *
475 * If the message is a function it will be executed, otherwise it will pass through directly.
476 *
477 * @param {Function|string} msg Deferred message, or message text
478 * @return {string} Resolved message
479 */
480 OO.ui.resolveMsg = function ( msg ) {
481 if ( $.isFunction( msg ) ) {
482 return msg();
483 }
484 return msg;
485 };
486
487 /**
488 * @param {string} url
489 * @return {boolean}
490 */
491 OO.ui.isSafeUrl = function ( url ) {
492 // Keep this function in sync with php/Tag.php
493 var i, protocolWhitelist;
494
495 function stringStartsWith( haystack, needle ) {
496 return haystack.substr( 0, needle.length ) === needle;
497 }
498
499 protocolWhitelist = [
500 'bitcoin', 'ftp', 'ftps', 'geo', 'git', 'gopher', 'http', 'https', 'irc', 'ircs',
501 'magnet', 'mailto', 'mms', 'news', 'nntp', 'redis', 'sftp', 'sip', 'sips', 'sms', 'ssh',
502 'svn', 'tel', 'telnet', 'urn', 'worldwind', 'xmpp'
503 ];
504
505 if ( url === '' ) {
506 return true;
507 }
508
509 for ( i = 0; i < protocolWhitelist.length; i++ ) {
510 if ( stringStartsWith( url, protocolWhitelist[ i ] + ':' ) ) {
511 return true;
512 }
513 }
514
515 // This matches '//' too
516 if ( stringStartsWith( url, '/' ) || stringStartsWith( url, './' ) ) {
517 return true;
518 }
519 if ( stringStartsWith( url, '?' ) || stringStartsWith( url, '#' ) ) {
520 return true;
521 }
522
523 return false;
524 };
525
526 /**
527 * Check if the user has a 'mobile' device.
528 *
529 * For our purposes this means the user is primarily using an
530 * on-screen keyboard, touch input instead of a mouse and may
531 * have a physically small display.
532 *
533 * It is left up to implementors to decide how to compute this
534 * so the default implementation always returns false.
535 *
536 * @return {boolean} Use is on a mobile device
537 */
538 OO.ui.isMobile = function () {
539 return false;
540 };
541
542 /**
543 * Get the additional spacing that should be taken into account when displaying elements that are
544 * clipped to the viewport, e.g. dropdown menus and popups. This is meant to be overridden to avoid
545 * such menus overlapping any fixed headers/toolbars/navigation used by the site.
546 *
547 * @return {Object} Object with the properties 'top', 'right', 'bottom', 'left', each representing
548 * the extra spacing from that edge of viewport (in pixels)
549 */
550 OO.ui.getViewportSpacing = function () {
551 return {
552 top: 0,
553 right: 0,
554 bottom: 0,
555 left: 0
556 };
557 };
558
559 /**
560 * Get the default overlay, which is used by various widgets when they are passed `$overlay: true`.
561 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
562 *
563 * @return {jQuery} Default overlay node
564 */
565 OO.ui.getDefaultOverlay = function () {
566 if ( !OO.ui.$defaultOverlay ) {
567 OO.ui.$defaultOverlay = $( '<div>' ).addClass( 'oo-ui-defaultOverlay' );
568 $( 'body' ).append( OO.ui.$defaultOverlay );
569 }
570 return OO.ui.$defaultOverlay;
571 };
572
573 /*!
574 * Mixin namespace.
575 */
576
577 /**
578 * Namespace for OOUI mixins.
579 *
580 * Mixins are named according to the type of object they are intended to
581 * be mixed in to. For example, OO.ui.mixin.GroupElement is intended to be
582 * mixed in to an instance of OO.ui.Element, and OO.ui.mixin.GroupWidget
583 * is intended to be mixed in to an instance of OO.ui.Widget.
584 *
585 * @class
586 * @singleton
587 */
588 OO.ui.mixin = {};
589
590 /**
591 * Each Element represents a rendering in the DOM—a button or an icon, for example, or anything
592 * that is visible to a user. Unlike {@link OO.ui.Widget widgets}, plain elements usually do not have events
593 * connected to them and can't be interacted with.
594 *
595 * @abstract
596 * @class
597 *
598 * @constructor
599 * @param {Object} [config] Configuration options
600 * @cfg {string[]} [classes] The names of the CSS classes to apply to the element. CSS styles are added
601 * to the top level (e.g., the outermost div) of the element. See the [OOUI documentation on MediaWiki][2]
602 * for an example.
603 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Buttons_and_Switches#cssExample
604 * @cfg {string} [id] The HTML id attribute used in the rendered tag.
605 * @cfg {string} [text] Text to insert
606 * @cfg {Array} [content] An array of content elements to append (after #text).
607 * Strings will be html-escaped; use an OO.ui.HtmlSnippet to append raw HTML.
608 * Instances of OO.ui.Element will have their $element appended.
609 * @cfg {jQuery} [$content] Content elements to append (after #text).
610 * @cfg {jQuery} [$element] Wrapper element. Defaults to a new element with #getTagName.
611 * @cfg {Mixed} [data] Custom data of any type or combination of types (e.g., string, number, array, object).
612 * Data can also be specified with the #setData method.
613 */
614 OO.ui.Element = function OoUiElement( config ) {
615 if ( OO.ui.isDemo ) {
616 this.initialConfig = config;
617 }
618 // Configuration initialization
619 config = config || {};
620
621 // Properties
622 this.$ = $;
623 this.elementId = null;
624 this.visible = true;
625 this.data = config.data;
626 this.$element = config.$element ||
627 $( document.createElement( this.getTagName() ) );
628 this.elementGroup = null;
629
630 // Initialization
631 if ( Array.isArray( config.classes ) ) {
632 this.$element.addClass( config.classes.join( ' ' ) );
633 }
634 if ( config.id ) {
635 this.setElementId( config.id );
636 }
637 if ( config.text ) {
638 this.$element.text( config.text );
639 }
640 if ( config.content ) {
641 // The `content` property treats plain strings as text; use an
642 // HtmlSnippet to append HTML content. `OO.ui.Element`s get their
643 // appropriate $element appended.
644 this.$element.append( config.content.map( function ( v ) {
645 if ( typeof v === 'string' ) {
646 // Escape string so it is properly represented in HTML.
647 return document.createTextNode( v );
648 } else if ( v instanceof OO.ui.HtmlSnippet ) {
649 // Bypass escaping.
650 return v.toString();
651 } else if ( v instanceof OO.ui.Element ) {
652 return v.$element;
653 }
654 return v;
655 } ) );
656 }
657 if ( config.$content ) {
658 // The `$content` property treats plain strings as HTML.
659 this.$element.append( config.$content );
660 }
661 };
662
663 /* Setup */
664
665 OO.initClass( OO.ui.Element );
666
667 /* Static Properties */
668
669 /**
670 * The name of the HTML tag used by the element.
671 *
672 * The static value may be ignored if the #getTagName method is overridden.
673 *
674 * @static
675 * @inheritable
676 * @property {string}
677 */
678 OO.ui.Element.static.tagName = 'div';
679
680 /* Static Methods */
681
682 /**
683 * Reconstitute a JavaScript object corresponding to a widget created
684 * by the PHP implementation.
685 *
686 * @param {string|HTMLElement|jQuery} idOrNode
687 * A DOM id (if a string) or node for the widget to infuse.
688 * @return {OO.ui.Element}
689 * The `OO.ui.Element` corresponding to this (infusable) document node.
690 * For `Tag` objects emitted on the HTML side (used occasionally for content)
691 * the value returned is a newly-created Element wrapping around the existing
692 * DOM node.
693 */
694 OO.ui.Element.static.infuse = function ( idOrNode ) {
695 var obj = OO.ui.Element.static.unsafeInfuse( idOrNode, false );
696 // Verify that the type matches up.
697 // FIXME: uncomment after T89721 is fixed, see T90929.
698 /*
699 if ( !( obj instanceof this['class'] ) ) {
700 throw new Error( 'Infusion type mismatch!' );
701 }
702 */
703 return obj;
704 };
705
706 /**
707 * Implementation helper for `infuse`; skips the type check and has an
708 * extra property so that only the top-level invocation touches the DOM.
709 *
710 * @private
711 * @param {string|HTMLElement|jQuery} idOrNode
712 * @param {jQuery.Promise|boolean} domPromise A promise that will be resolved
713 * when the top-level widget of this infusion is inserted into DOM,
714 * replacing the original node; or false for top-level invocation.
715 * @return {OO.ui.Element}
716 */
717 OO.ui.Element.static.unsafeInfuse = function ( idOrNode, domPromise ) {
718 // look for a cached result of a previous infusion.
719 var id, $elem, error, data, cls, parts, parent, obj, top, state, infusedChildren;
720 if ( typeof idOrNode === 'string' ) {
721 id = idOrNode;
722 $elem = $( document.getElementById( id ) );
723 } else {
724 $elem = $( idOrNode );
725 id = $elem.attr( 'id' );
726 }
727 if ( !$elem.length ) {
728 if ( typeof idOrNode === 'string' ) {
729 error = 'Widget not found: ' + idOrNode;
730 } else if ( idOrNode && idOrNode.selector ) {
731 error = 'Widget not found: ' + idOrNode.selector;
732 } else {
733 error = 'Widget not found';
734 }
735 throw new Error( error );
736 }
737 if ( $elem[ 0 ].oouiInfused ) {
738 $elem = $elem[ 0 ].oouiInfused;
739 }
740 data = $elem.data( 'ooui-infused' );
741 if ( data ) {
742 // cached!
743 if ( data === true ) {
744 throw new Error( 'Circular dependency! ' + id );
745 }
746 if ( domPromise ) {
747 // pick up dynamic state, like focus, value of form inputs, scroll position, etc.
748 state = data.constructor.static.gatherPreInfuseState( $elem, data );
749 // restore dynamic state after the new element is re-inserted into DOM under infused parent
750 domPromise.done( data.restorePreInfuseState.bind( data, state ) );
751 infusedChildren = $elem.data( 'ooui-infused-children' );
752 if ( infusedChildren && infusedChildren.length ) {
753 infusedChildren.forEach( function ( data ) {
754 var state = data.constructor.static.gatherPreInfuseState( $elem, data );
755 domPromise.done( data.restorePreInfuseState.bind( data, state ) );
756 } );
757 }
758 }
759 return data;
760 }
761 data = $elem.attr( 'data-ooui' );
762 if ( !data ) {
763 throw new Error( 'No infusion data found: ' + id );
764 }
765 try {
766 data = JSON.parse( data );
767 } catch ( _ ) {
768 data = null;
769 }
770 if ( !( data && data._ ) ) {
771 throw new Error( 'No valid infusion data found: ' + id );
772 }
773 if ( data._ === 'Tag' ) {
774 // Special case: this is a raw Tag; wrap existing node, don't rebuild.
775 return new OO.ui.Element( { $element: $elem } );
776 }
777 parts = data._.split( '.' );
778 cls = OO.getProp.apply( OO, [ window ].concat( parts ) );
779 if ( cls === undefined ) {
780 throw new Error( 'Unknown widget type: id: ' + id + ', class: ' + data._ );
781 }
782
783 // Verify that we're creating an OO.ui.Element instance
784 parent = cls.parent;
785
786 while ( parent !== undefined ) {
787 if ( parent === OO.ui.Element ) {
788 // Safe
789 break;
790 }
791
792 parent = parent.parent;
793 }
794
795 if ( parent !== OO.ui.Element ) {
796 throw new Error( 'Unknown widget type: id: ' + id + ', class: ' + data._ );
797 }
798
799 if ( domPromise === false ) {
800 top = $.Deferred();
801 domPromise = top.promise();
802 }
803 $elem.data( 'ooui-infused', true ); // prevent loops
804 data.id = id; // implicit
805 infusedChildren = [];
806 data = OO.copy( data, null, function deserialize( value ) {
807 var infused;
808 if ( OO.isPlainObject( value ) ) {
809 if ( value.tag ) {
810 infused = OO.ui.Element.static.unsafeInfuse( value.tag, domPromise );
811 infusedChildren.push( infused );
812 // Flatten the structure
813 infusedChildren.push.apply( infusedChildren, infused.$element.data( 'ooui-infused-children' ) || [] );
814 infused.$element.removeData( 'ooui-infused-children' );
815 return infused;
816 }
817 if ( value.html !== undefined ) {
818 return new OO.ui.HtmlSnippet( value.html );
819 }
820 }
821 } );
822 // allow widgets to reuse parts of the DOM
823 data = cls.static.reusePreInfuseDOM( $elem[ 0 ], data );
824 // pick up dynamic state, like focus, value of form inputs, scroll position, etc.
825 state = cls.static.gatherPreInfuseState( $elem[ 0 ], data );
826 // rebuild widget
827 // eslint-disable-next-line new-cap
828 obj = new cls( data );
829 // now replace old DOM with this new DOM.
830 if ( top ) {
831 // An efficient constructor might be able to reuse the entire DOM tree of the original element,
832 // so only mutate the DOM if we need to.
833 if ( $elem[ 0 ] !== obj.$element[ 0 ] ) {
834 $elem.replaceWith( obj.$element );
835 // This element is now gone from the DOM, but if anyone is holding a reference to it,
836 // let's allow them to OO.ui.infuse() it and do what they expect, see T105828.
837 // Do not use jQuery.data(), as using it on detached nodes leaks memory in 1.x line by design.
838 $elem[ 0 ].oouiInfused = obj.$element;
839 }
840 top.resolve();
841 }
842 obj.$element.data( 'ooui-infused', obj );
843 obj.$element.data( 'ooui-infused-children', infusedChildren );
844 // set the 'data-ooui' attribute so we can identify infused widgets
845 obj.$element.attr( 'data-ooui', '' );
846 // restore dynamic state after the new element is inserted into DOM
847 domPromise.done( obj.restorePreInfuseState.bind( obj, state ) );
848 return obj;
849 };
850
851 /**
852 * Pick out parts of `node`'s DOM to be reused when infusing a widget.
853 *
854 * This method **must not** make any changes to the DOM, only find interesting pieces and add them
855 * to `config` (which should then be returned). Actual DOM juggling should then be done by the
856 * constructor, which will be given the enhanced config.
857 *
858 * @protected
859 * @param {HTMLElement} node
860 * @param {Object} config
861 * @return {Object}
862 */
863 OO.ui.Element.static.reusePreInfuseDOM = function ( node, config ) {
864 return config;
865 };
866
867 /**
868 * Gather the dynamic state (focus, value of form inputs, scroll position, etc.) of an HTML DOM node
869 * (and its children) that represent an Element of the same class and the given configuration,
870 * generated by the PHP implementation.
871 *
872 * This method is called just before `node` is detached from the DOM. The return value of this
873 * function will be passed to #restorePreInfuseState after the newly created widget's #$element
874 * is inserted into DOM to replace `node`.
875 *
876 * @protected
877 * @param {HTMLElement} node
878 * @param {Object} config
879 * @return {Object}
880 */
881 OO.ui.Element.static.gatherPreInfuseState = function () {
882 return {};
883 };
884
885 /**
886 * Get a jQuery function within a specific document.
887 *
888 * @static
889 * @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
890 * @param {jQuery} [$iframe] HTML iframe element that contains the document, omit if document is
891 * not in an iframe
892 * @return {Function} Bound jQuery function
893 */
894 OO.ui.Element.static.getJQuery = function ( context, $iframe ) {
895 function wrapper( selector ) {
896 return $( selector, wrapper.context );
897 }
898
899 wrapper.context = this.getDocument( context );
900
901 if ( $iframe ) {
902 wrapper.$iframe = $iframe;
903 }
904
905 return wrapper;
906 };
907
908 /**
909 * Get the document of an element.
910 *
911 * @static
912 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Object to get the document for
913 * @return {HTMLDocument|null} Document object
914 */
915 OO.ui.Element.static.getDocument = function ( obj ) {
916 // jQuery - selections created "offscreen" won't have a context, so .context isn't reliable
917 return ( obj[ 0 ] && obj[ 0 ].ownerDocument ) ||
918 // Empty jQuery selections might have a context
919 obj.context ||
920 // HTMLElement
921 obj.ownerDocument ||
922 // Window
923 obj.document ||
924 // HTMLDocument
925 ( obj.nodeType === Node.DOCUMENT_NODE && obj ) ||
926 null;
927 };
928
929 /**
930 * Get the window of an element or document.
931 *
932 * @static
933 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the window for
934 * @return {Window} Window object
935 */
936 OO.ui.Element.static.getWindow = function ( obj ) {
937 var doc = this.getDocument( obj );
938 return doc.defaultView;
939 };
940
941 /**
942 * Get the direction of an element or document.
943 *
944 * @static
945 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the direction for
946 * @return {string} Text direction, either 'ltr' or 'rtl'
947 */
948 OO.ui.Element.static.getDir = function ( obj ) {
949 var isDoc, isWin;
950
951 if ( obj instanceof jQuery ) {
952 obj = obj[ 0 ];
953 }
954 isDoc = obj.nodeType === Node.DOCUMENT_NODE;
955 isWin = obj.document !== undefined;
956 if ( isDoc || isWin ) {
957 if ( isWin ) {
958 obj = obj.document;
959 }
960 obj = obj.body;
961 }
962 return $( obj ).css( 'direction' );
963 };
964
965 /**
966 * Get the offset between two frames.
967 *
968 * TODO: Make this function not use recursion.
969 *
970 * @static
971 * @param {Window} from Window of the child frame
972 * @param {Window} [to=window] Window of the parent frame
973 * @param {Object} [offset] Offset to start with, used internally
974 * @return {Object} Offset object, containing left and top properties
975 */
976 OO.ui.Element.static.getFrameOffset = function ( from, to, offset ) {
977 var i, len, frames, frame, rect;
978
979 if ( !to ) {
980 to = window;
981 }
982 if ( !offset ) {
983 offset = { top: 0, left: 0 };
984 }
985 if ( from.parent === from ) {
986 return offset;
987 }
988
989 // Get iframe element
990 frames = from.parent.document.getElementsByTagName( 'iframe' );
991 for ( i = 0, len = frames.length; i < len; i++ ) {
992 if ( frames[ i ].contentWindow === from ) {
993 frame = frames[ i ];
994 break;
995 }
996 }
997
998 // Recursively accumulate offset values
999 if ( frame ) {
1000 rect = frame.getBoundingClientRect();
1001 offset.left += rect.left;
1002 offset.top += rect.top;
1003 if ( from !== to ) {
1004 this.getFrameOffset( from.parent, offset );
1005 }
1006 }
1007 return offset;
1008 };
1009
1010 /**
1011 * Get the offset between two elements.
1012 *
1013 * The two elements may be in a different frame, but in that case the frame $element is in must
1014 * be contained in the frame $anchor is in.
1015 *
1016 * @static
1017 * @param {jQuery} $element Element whose position to get
1018 * @param {jQuery} $anchor Element to get $element's position relative to
1019 * @return {Object} Translated position coordinates, containing top and left properties
1020 */
1021 OO.ui.Element.static.getRelativePosition = function ( $element, $anchor ) {
1022 var iframe, iframePos,
1023 pos = $element.offset(),
1024 anchorPos = $anchor.offset(),
1025 elementDocument = this.getDocument( $element ),
1026 anchorDocument = this.getDocument( $anchor );
1027
1028 // If $element isn't in the same document as $anchor, traverse up
1029 while ( elementDocument !== anchorDocument ) {
1030 iframe = elementDocument.defaultView.frameElement;
1031 if ( !iframe ) {
1032 throw new Error( '$element frame is not contained in $anchor frame' );
1033 }
1034 iframePos = $( iframe ).offset();
1035 pos.left += iframePos.left;
1036 pos.top += iframePos.top;
1037 elementDocument = iframe.ownerDocument;
1038 }
1039 pos.left -= anchorPos.left;
1040 pos.top -= anchorPos.top;
1041 return pos;
1042 };
1043
1044 /**
1045 * Get element border sizes.
1046 *
1047 * @static
1048 * @param {HTMLElement} el Element to measure
1049 * @return {Object} Dimensions object with `top`, `left`, `bottom` and `right` properties
1050 */
1051 OO.ui.Element.static.getBorders = function ( el ) {
1052 var doc = el.ownerDocument,
1053 win = doc.defaultView,
1054 style = win.getComputedStyle( el, null ),
1055 $el = $( el ),
1056 top = parseFloat( style ? style.borderTopWidth : $el.css( 'borderTopWidth' ) ) || 0,
1057 left = parseFloat( style ? style.borderLeftWidth : $el.css( 'borderLeftWidth' ) ) || 0,
1058 bottom = parseFloat( style ? style.borderBottomWidth : $el.css( 'borderBottomWidth' ) ) || 0,
1059 right = parseFloat( style ? style.borderRightWidth : $el.css( 'borderRightWidth' ) ) || 0;
1060
1061 return {
1062 top: top,
1063 left: left,
1064 bottom: bottom,
1065 right: right
1066 };
1067 };
1068
1069 /**
1070 * Get dimensions of an element or window.
1071 *
1072 * @static
1073 * @param {HTMLElement|Window} el Element to measure
1074 * @return {Object} Dimensions object with `borders`, `scroll`, `scrollbar` and `rect` properties
1075 */
1076 OO.ui.Element.static.getDimensions = function ( el ) {
1077 var $el, $win,
1078 doc = el.ownerDocument || el.document,
1079 win = doc.defaultView;
1080
1081 if ( win === el || el === doc.documentElement ) {
1082 $win = $( win );
1083 return {
1084 borders: { top: 0, left: 0, bottom: 0, right: 0 },
1085 scroll: {
1086 top: $win.scrollTop(),
1087 left: $win.scrollLeft()
1088 },
1089 scrollbar: { right: 0, bottom: 0 },
1090 rect: {
1091 top: 0,
1092 left: 0,
1093 bottom: $win.innerHeight(),
1094 right: $win.innerWidth()
1095 }
1096 };
1097 } else {
1098 $el = $( el );
1099 return {
1100 borders: this.getBorders( el ),
1101 scroll: {
1102 top: $el.scrollTop(),
1103 left: $el.scrollLeft()
1104 },
1105 scrollbar: {
1106 right: $el.innerWidth() - el.clientWidth,
1107 bottom: $el.innerHeight() - el.clientHeight
1108 },
1109 rect: el.getBoundingClientRect()
1110 };
1111 }
1112 };
1113
1114 /**
1115 * Get the number of pixels that an element's content is scrolled to the left.
1116 *
1117 * Adapted from <https://github.com/othree/jquery.rtl-scroll-type>.
1118 * Original code copyright 2012 Wei-Ko Kao, licensed under the MIT License.
1119 *
1120 * This function smooths out browser inconsistencies (nicely described in the README at
1121 * <https://github.com/othree/jquery.rtl-scroll-type>) and produces a result consistent
1122 * with Firefox's 'scrollLeft', which seems the sanest.
1123 *
1124 * @static
1125 * @method
1126 * @param {HTMLElement|Window} el Element to measure
1127 * @return {number} Scroll position from the left.
1128 * If the element's direction is LTR, this is a positive number between `0` (initial scroll position)
1129 * and `el.scrollWidth - el.clientWidth` (furthest possible scroll position).
1130 * If the element's direction is RTL, this is a negative number between `0` (initial scroll position)
1131 * and `-el.scrollWidth + el.clientWidth` (furthest possible scroll position).
1132 */
1133 OO.ui.Element.static.getScrollLeft = ( function () {
1134 var rtlScrollType = null;
1135
1136 function test() {
1137 var $definer = $( '<div dir="rtl" style="font-size: 14px; width: 1px; height: 1px; position: absolute; top: -1000px; overflow: scroll">A</div>' ),
1138 definer = $definer[ 0 ];
1139
1140 $definer.appendTo( 'body' );
1141 if ( definer.scrollLeft > 0 ) {
1142 // Safari, Chrome
1143 rtlScrollType = 'default';
1144 } else {
1145 definer.scrollLeft = 1;
1146 if ( definer.scrollLeft === 0 ) {
1147 // Firefox, old Opera
1148 rtlScrollType = 'negative';
1149 } else {
1150 // Internet Explorer, Edge
1151 rtlScrollType = 'reverse';
1152 }
1153 }
1154 $definer.remove();
1155 }
1156
1157 return function getScrollLeft( el ) {
1158 var isRoot = el.window === el ||
1159 el === el.ownerDocument.body ||
1160 el === el.ownerDocument.documentElement,
1161 scrollLeft = isRoot ? $( window ).scrollLeft() : el.scrollLeft,
1162 // All browsers use the correct scroll type ('negative') on the root, so don't
1163 // do any fixups when looking at the root element
1164 direction = isRoot ? 'ltr' : $( el ).css( 'direction' );
1165
1166 if ( direction === 'rtl' ) {
1167 if ( rtlScrollType === null ) {
1168 test();
1169 }
1170 if ( rtlScrollType === 'reverse' ) {
1171 scrollLeft = -scrollLeft;
1172 } else if ( rtlScrollType === 'default' ) {
1173 scrollLeft = scrollLeft - el.scrollWidth + el.clientWidth;
1174 }
1175 }
1176
1177 return scrollLeft;
1178 };
1179 }() );
1180
1181 /**
1182 * Get the root scrollable element of given element's document.
1183 *
1184 * On Blink-based browsers (Chrome etc.), `document.documentElement` can't be used to get or set
1185 * the scrollTop property; instead we have to use `document.body`. Changing and testing the value
1186 * lets us use 'body' or 'documentElement' based on what is working.
1187 *
1188 * https://code.google.com/p/chromium/issues/detail?id=303131
1189 *
1190 * @static
1191 * @param {HTMLElement} el Element to find root scrollable parent for
1192 * @return {HTMLElement} Scrollable parent, `document.body` or `document.documentElement`
1193 * depending on browser
1194 */
1195 OO.ui.Element.static.getRootScrollableElement = function ( el ) {
1196 var scrollTop, body;
1197
1198 if ( OO.ui.scrollableElement === undefined ) {
1199 body = el.ownerDocument.body;
1200 scrollTop = body.scrollTop;
1201 body.scrollTop = 1;
1202
1203 // In some browsers (observed in Chrome 56 on Linux Mint 18.1),
1204 // body.scrollTop doesn't become exactly 1, but a fractional value like 0.76
1205 if ( Math.round( body.scrollTop ) === 1 ) {
1206 body.scrollTop = scrollTop;
1207 OO.ui.scrollableElement = 'body';
1208 } else {
1209 OO.ui.scrollableElement = 'documentElement';
1210 }
1211 }
1212
1213 return el.ownerDocument[ OO.ui.scrollableElement ];
1214 };
1215
1216 /**
1217 * Get closest scrollable container.
1218 *
1219 * Traverses up until either a scrollable element or the root is reached, in which case the root
1220 * scrollable element will be returned (see #getRootScrollableElement).
1221 *
1222 * @static
1223 * @param {HTMLElement} el Element to find scrollable container for
1224 * @param {string} [dimension] Dimension of scrolling to look for; `x`, `y` or omit for either
1225 * @return {HTMLElement} Closest scrollable container
1226 */
1227 OO.ui.Element.static.getClosestScrollableContainer = function ( el, dimension ) {
1228 var i, val,
1229 // Browsers do not correctly return the computed value of 'overflow' when 'overflow-x' and
1230 // 'overflow-y' have different values, so we need to check the separate properties.
1231 props = [ 'overflow-x', 'overflow-y' ],
1232 $parent = $( el ).parent();
1233
1234 if ( dimension === 'x' || dimension === 'y' ) {
1235 props = [ 'overflow-' + dimension ];
1236 }
1237
1238 // Special case for the document root (which doesn't really have any scrollable container, since
1239 // it is the ultimate scrollable container, but this is probably saner than null or exception)
1240 if ( $( el ).is( 'html, body' ) ) {
1241 return this.getRootScrollableElement( el );
1242 }
1243
1244 while ( $parent.length ) {
1245 if ( $parent[ 0 ] === this.getRootScrollableElement( el ) ) {
1246 return $parent[ 0 ];
1247 }
1248 i = props.length;
1249 while ( i-- ) {
1250 val = $parent.css( props[ i ] );
1251 // We assume that elements with 'overflow' (in any direction) set to 'hidden' will never be
1252 // scrolled in that direction, but they can actually be scrolled programatically. The user can
1253 // unintentionally perform a scroll in such case even if the application doesn't scroll
1254 // programatically, e.g. when jumping to an anchor, or when using built-in find functionality.
1255 // This could cause funny issues...
1256 if ( val === 'auto' || val === 'scroll' ) {
1257 return $parent[ 0 ];
1258 }
1259 }
1260 $parent = $parent.parent();
1261 }
1262 // The element is unattached... return something mostly sane
1263 return this.getRootScrollableElement( el );
1264 };
1265
1266 /**
1267 * Scroll element into view.
1268 *
1269 * @static
1270 * @param {HTMLElement} el Element to scroll into view
1271 * @param {Object} [config] Configuration options
1272 * @param {string} [config.duration='fast'] jQuery animation duration value
1273 * @param {string} [config.direction] Scroll in only one direction, e.g. 'x' or 'y', omit
1274 * to scroll in both directions
1275 * @return {jQuery.Promise} Promise which resolves when the scroll is complete
1276 */
1277 OO.ui.Element.static.scrollIntoView = function ( el, config ) {
1278 var position, animations, container, $container, elementDimensions, containerDimensions, $window,
1279 deferred = $.Deferred();
1280
1281 // Configuration initialization
1282 config = config || {};
1283
1284 animations = {};
1285 container = this.getClosestScrollableContainer( el, config.direction );
1286 $container = $( container );
1287 elementDimensions = this.getDimensions( el );
1288 containerDimensions = this.getDimensions( container );
1289 $window = $( this.getWindow( el ) );
1290
1291 // Compute the element's position relative to the container
1292 if ( $container.is( 'html, body' ) ) {
1293 // If the scrollable container is the root, this is easy
1294 position = {
1295 top: elementDimensions.rect.top,
1296 bottom: $window.innerHeight() - elementDimensions.rect.bottom,
1297 left: elementDimensions.rect.left,
1298 right: $window.innerWidth() - elementDimensions.rect.right
1299 };
1300 } else {
1301 // Otherwise, we have to subtract el's coordinates from container's coordinates
1302 position = {
1303 top: elementDimensions.rect.top - ( containerDimensions.rect.top + containerDimensions.borders.top ),
1304 bottom: containerDimensions.rect.bottom - containerDimensions.borders.bottom - containerDimensions.scrollbar.bottom - elementDimensions.rect.bottom,
1305 left: elementDimensions.rect.left - ( containerDimensions.rect.left + containerDimensions.borders.left ),
1306 right: containerDimensions.rect.right - containerDimensions.borders.right - containerDimensions.scrollbar.right - elementDimensions.rect.right
1307 };
1308 }
1309
1310 if ( !config.direction || config.direction === 'y' ) {
1311 if ( position.top < 0 ) {
1312 animations.scrollTop = containerDimensions.scroll.top + position.top;
1313 } else if ( position.top > 0 && position.bottom < 0 ) {
1314 animations.scrollTop = containerDimensions.scroll.top + Math.min( position.top, -position.bottom );
1315 }
1316 }
1317 if ( !config.direction || config.direction === 'x' ) {
1318 if ( position.left < 0 ) {
1319 animations.scrollLeft = containerDimensions.scroll.left + position.left;
1320 } else if ( position.left > 0 && position.right < 0 ) {
1321 animations.scrollLeft = containerDimensions.scroll.left + Math.min( position.left, -position.right );
1322 }
1323 }
1324 if ( !$.isEmptyObject( animations ) ) {
1325 $container.stop( true ).animate( animations, config.duration === undefined ? 'fast' : config.duration );
1326 $container.queue( function ( next ) {
1327 deferred.resolve();
1328 next();
1329 } );
1330 } else {
1331 deferred.resolve();
1332 }
1333 return deferred.promise();
1334 };
1335
1336 /**
1337 * Force the browser to reconsider whether it really needs to render scrollbars inside the element
1338 * and reserve space for them, because it probably doesn't.
1339 *
1340 * Workaround primarily for <https://code.google.com/p/chromium/issues/detail?id=387290>, but also
1341 * similar bugs in other browsers. "Just" forcing a reflow is not sufficient in all cases, we need
1342 * to first actually detach (or hide, but detaching is simpler) all children, *then* force a reflow,
1343 * and then reattach (or show) them back.
1344 *
1345 * @static
1346 * @param {HTMLElement} el Element to reconsider the scrollbars on
1347 */
1348 OO.ui.Element.static.reconsiderScrollbars = function ( el ) {
1349 var i, len, scrollLeft, scrollTop, nodes = [];
1350 // Save scroll position
1351 scrollLeft = el.scrollLeft;
1352 scrollTop = el.scrollTop;
1353 // Detach all children
1354 while ( el.firstChild ) {
1355 nodes.push( el.firstChild );
1356 el.removeChild( el.firstChild );
1357 }
1358 // Force reflow
1359 void el.offsetHeight;
1360 // Reattach all children
1361 for ( i = 0, len = nodes.length; i < len; i++ ) {
1362 el.appendChild( nodes[ i ] );
1363 }
1364 // Restore scroll position (no-op if scrollbars disappeared)
1365 el.scrollLeft = scrollLeft;
1366 el.scrollTop = scrollTop;
1367 };
1368
1369 /* Methods */
1370
1371 /**
1372 * Toggle visibility of an element.
1373 *
1374 * @param {boolean} [show] Make element visible, omit to toggle visibility
1375 * @fires visible
1376 * @chainable
1377 */
1378 OO.ui.Element.prototype.toggle = function ( show ) {
1379 show = show === undefined ? !this.visible : !!show;
1380
1381 if ( show !== this.isVisible() ) {
1382 this.visible = show;
1383 this.$element.toggleClass( 'oo-ui-element-hidden', !this.visible );
1384 this.emit( 'toggle', show );
1385 }
1386
1387 return this;
1388 };
1389
1390 /**
1391 * Check if element is visible.
1392 *
1393 * @return {boolean} element is visible
1394 */
1395 OO.ui.Element.prototype.isVisible = function () {
1396 return this.visible;
1397 };
1398
1399 /**
1400 * Get element data.
1401 *
1402 * @return {Mixed} Element data
1403 */
1404 OO.ui.Element.prototype.getData = function () {
1405 return this.data;
1406 };
1407
1408 /**
1409 * Set element data.
1410 *
1411 * @param {Mixed} data Element data
1412 * @chainable
1413 */
1414 OO.ui.Element.prototype.setData = function ( data ) {
1415 this.data = data;
1416 return this;
1417 };
1418
1419 /**
1420 * Set the element has an 'id' attribute.
1421 *
1422 * @param {string} id
1423 * @chainable
1424 */
1425 OO.ui.Element.prototype.setElementId = function ( id ) {
1426 this.elementId = id;
1427 this.$element.attr( 'id', id );
1428 return this;
1429 };
1430
1431 /**
1432 * Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing,
1433 * and return its value.
1434 *
1435 * @return {string}
1436 */
1437 OO.ui.Element.prototype.getElementId = function () {
1438 if ( this.elementId === null ) {
1439 this.setElementId( OO.ui.generateElementId() );
1440 }
1441 return this.elementId;
1442 };
1443
1444 /**
1445 * Check if element supports one or more methods.
1446 *
1447 * @param {string|string[]} methods Method or list of methods to check
1448 * @return {boolean} All methods are supported
1449 */
1450 OO.ui.Element.prototype.supports = function ( methods ) {
1451 var i, len,
1452 support = 0;
1453
1454 methods = Array.isArray( methods ) ? methods : [ methods ];
1455 for ( i = 0, len = methods.length; i < len; i++ ) {
1456 if ( $.isFunction( this[ methods[ i ] ] ) ) {
1457 support++;
1458 }
1459 }
1460
1461 return methods.length === support;
1462 };
1463
1464 /**
1465 * Update the theme-provided classes.
1466 *
1467 * @localdoc This is called in element mixins and widget classes any time state changes.
1468 * Updating is debounced, minimizing overhead of changing multiple attributes and
1469 * guaranteeing that theme updates do not occur within an element's constructor
1470 */
1471 OO.ui.Element.prototype.updateThemeClasses = function () {
1472 OO.ui.theme.queueUpdateElementClasses( this );
1473 };
1474
1475 /**
1476 * Get the HTML tag name.
1477 *
1478 * Override this method to base the result on instance information.
1479 *
1480 * @return {string} HTML tag name
1481 */
1482 OO.ui.Element.prototype.getTagName = function () {
1483 return this.constructor.static.tagName;
1484 };
1485
1486 /**
1487 * Check if the element is attached to the DOM
1488 *
1489 * @return {boolean} The element is attached to the DOM
1490 */
1491 OO.ui.Element.prototype.isElementAttached = function () {
1492 return $.contains( this.getElementDocument(), this.$element[ 0 ] );
1493 };
1494
1495 /**
1496 * Get the DOM document.
1497 *
1498 * @return {HTMLDocument} Document object
1499 */
1500 OO.ui.Element.prototype.getElementDocument = function () {
1501 // Don't cache this in other ways either because subclasses could can change this.$element
1502 return OO.ui.Element.static.getDocument( this.$element );
1503 };
1504
1505 /**
1506 * Get the DOM window.
1507 *
1508 * @return {Window} Window object
1509 */
1510 OO.ui.Element.prototype.getElementWindow = function () {
1511 return OO.ui.Element.static.getWindow( this.$element );
1512 };
1513
1514 /**
1515 * Get closest scrollable container.
1516 *
1517 * @return {HTMLElement} Closest scrollable container
1518 */
1519 OO.ui.Element.prototype.getClosestScrollableElementContainer = function () {
1520 return OO.ui.Element.static.getClosestScrollableContainer( this.$element[ 0 ] );
1521 };
1522
1523 /**
1524 * Get group element is in.
1525 *
1526 * @return {OO.ui.mixin.GroupElement|null} Group element, null if none
1527 */
1528 OO.ui.Element.prototype.getElementGroup = function () {
1529 return this.elementGroup;
1530 };
1531
1532 /**
1533 * Set group element is in.
1534 *
1535 * @param {OO.ui.mixin.GroupElement|null} group Group element, null if none
1536 * @chainable
1537 */
1538 OO.ui.Element.prototype.setElementGroup = function ( group ) {
1539 this.elementGroup = group;
1540 return this;
1541 };
1542
1543 /**
1544 * Scroll element into view.
1545 *
1546 * @param {Object} [config] Configuration options
1547 * @return {jQuery.Promise} Promise which resolves when the scroll is complete
1548 */
1549 OO.ui.Element.prototype.scrollElementIntoView = function ( config ) {
1550 if (
1551 !this.isElementAttached() ||
1552 !this.isVisible() ||
1553 ( this.getElementGroup() && !this.getElementGroup().isVisible() )
1554 ) {
1555 return $.Deferred().resolve();
1556 }
1557 return OO.ui.Element.static.scrollIntoView( this.$element[ 0 ], config );
1558 };
1559
1560 /**
1561 * Restore the pre-infusion dynamic state for this widget.
1562 *
1563 * This method is called after #$element has been inserted into DOM. The parameter is the return
1564 * value of #gatherPreInfuseState.
1565 *
1566 * @protected
1567 * @param {Object} state
1568 */
1569 OO.ui.Element.prototype.restorePreInfuseState = function () {
1570 };
1571
1572 /**
1573 * Wraps an HTML snippet for use with configuration values which default
1574 * to strings. This bypasses the default html-escaping done to string
1575 * values.
1576 *
1577 * @class
1578 *
1579 * @constructor
1580 * @param {string} [content] HTML content
1581 */
1582 OO.ui.HtmlSnippet = function OoUiHtmlSnippet( content ) {
1583 // Properties
1584 this.content = content;
1585 };
1586
1587 /* Setup */
1588
1589 OO.initClass( OO.ui.HtmlSnippet );
1590
1591 /* Methods */
1592
1593 /**
1594 * Render into HTML.
1595 *
1596 * @return {string} Unchanged HTML snippet.
1597 */
1598 OO.ui.HtmlSnippet.prototype.toString = function () {
1599 return this.content;
1600 };
1601
1602 /**
1603 * Layouts are containers for elements and are used to arrange other widgets of arbitrary type in a way
1604 * that is centrally controlled and can be updated dynamically. Layouts can be, and usually are, combined.
1605 * See {@link OO.ui.FieldsetLayout FieldsetLayout}, {@link OO.ui.FieldLayout FieldLayout}, {@link OO.ui.FormLayout FormLayout},
1606 * {@link OO.ui.PanelLayout PanelLayout}, {@link OO.ui.StackLayout StackLayout}, {@link OO.ui.PageLayout PageLayout},
1607 * {@link OO.ui.HorizontalLayout HorizontalLayout}, and {@link OO.ui.BookletLayout BookletLayout} for more information and examples.
1608 *
1609 * @abstract
1610 * @class
1611 * @extends OO.ui.Element
1612 * @mixins OO.EventEmitter
1613 *
1614 * @constructor
1615 * @param {Object} [config] Configuration options
1616 */
1617 OO.ui.Layout = function OoUiLayout( config ) {
1618 // Configuration initialization
1619 config = config || {};
1620
1621 // Parent constructor
1622 OO.ui.Layout.parent.call( this, config );
1623
1624 // Mixin constructors
1625 OO.EventEmitter.call( this );
1626
1627 // Initialization
1628 this.$element.addClass( 'oo-ui-layout' );
1629 };
1630
1631 /* Setup */
1632
1633 OO.inheritClass( OO.ui.Layout, OO.ui.Element );
1634 OO.mixinClass( OO.ui.Layout, OO.EventEmitter );
1635
1636 /**
1637 * Widgets are compositions of one or more OOUI elements that users can both view
1638 * and interact with. All widgets can be configured and modified via a standard API,
1639 * and their state can change dynamically according to a model.
1640 *
1641 * @abstract
1642 * @class
1643 * @extends OO.ui.Element
1644 * @mixins OO.EventEmitter
1645 *
1646 * @constructor
1647 * @param {Object} [config] Configuration options
1648 * @cfg {boolean} [disabled=false] Disable the widget. Disabled widgets cannot be used and their
1649 * appearance reflects this state.
1650 */
1651 OO.ui.Widget = function OoUiWidget( config ) {
1652 // Initialize config
1653 config = $.extend( { disabled: false }, config );
1654
1655 // Parent constructor
1656 OO.ui.Widget.parent.call( this, config );
1657
1658 // Mixin constructors
1659 OO.EventEmitter.call( this );
1660
1661 // Properties
1662 this.disabled = null;
1663 this.wasDisabled = null;
1664
1665 // Initialization
1666 this.$element.addClass( 'oo-ui-widget' );
1667 this.setDisabled( !!config.disabled );
1668 };
1669
1670 /* Setup */
1671
1672 OO.inheritClass( OO.ui.Widget, OO.ui.Element );
1673 OO.mixinClass( OO.ui.Widget, OO.EventEmitter );
1674
1675 /* Events */
1676
1677 /**
1678 * @event disable
1679 *
1680 * A 'disable' event is emitted when the disabled state of the widget changes
1681 * (i.e. on disable **and** enable).
1682 *
1683 * @param {boolean} disabled Widget is disabled
1684 */
1685
1686 /**
1687 * @event toggle
1688 *
1689 * A 'toggle' event is emitted when the visibility of the widget changes.
1690 *
1691 * @param {boolean} visible Widget is visible
1692 */
1693
1694 /* Methods */
1695
1696 /**
1697 * Check if the widget is disabled.
1698 *
1699 * @return {boolean} Widget is disabled
1700 */
1701 OO.ui.Widget.prototype.isDisabled = function () {
1702 return this.disabled;
1703 };
1704
1705 /**
1706 * Set the 'disabled' state of the widget.
1707 *
1708 * When a widget is disabled, it cannot be used and its appearance is updated to reflect this state.
1709 *
1710 * @param {boolean} disabled Disable widget
1711 * @chainable
1712 */
1713 OO.ui.Widget.prototype.setDisabled = function ( disabled ) {
1714 var isDisabled;
1715
1716 this.disabled = !!disabled;
1717 isDisabled = this.isDisabled();
1718 if ( isDisabled !== this.wasDisabled ) {
1719 this.$element.toggleClass( 'oo-ui-widget-disabled', isDisabled );
1720 this.$element.toggleClass( 'oo-ui-widget-enabled', !isDisabled );
1721 this.$element.attr( 'aria-disabled', isDisabled.toString() );
1722 this.emit( 'disable', isDisabled );
1723 this.updateThemeClasses();
1724 }
1725 this.wasDisabled = isDisabled;
1726
1727 return this;
1728 };
1729
1730 /**
1731 * Update the disabled state, in case of changes in parent widget.
1732 *
1733 * @chainable
1734 */
1735 OO.ui.Widget.prototype.updateDisabled = function () {
1736 this.setDisabled( this.disabled );
1737 return this;
1738 };
1739
1740 /**
1741 * Get an ID of a labelable node which is part of this widget, if any, to be used for `<label for>`
1742 * value.
1743 *
1744 * If this function returns null, the widget should have a meaningful #simulateLabelClick method
1745 * instead.
1746 *
1747 * @return {string|null} The ID of the labelable element
1748 */
1749 OO.ui.Widget.prototype.getInputId = function () {
1750 return null;
1751 };
1752
1753 /**
1754 * Simulate the behavior of clicking on a label (a HTML `<label>` element) bound to this input.
1755 * HTML only allows `<label>` to act on specific "labelable" elements; complex widgets might need to
1756 * override this method to provide intuitive, accessible behavior.
1757 *
1758 * By default, this does nothing. OO.ui.mixin.TabIndexedElement overrides it for focusable widgets.
1759 * Individual widgets may override it too.
1760 *
1761 * This method is called by OO.ui.LabelWidget and OO.ui.FieldLayout. It should not be called
1762 * directly.
1763 */
1764 OO.ui.Widget.prototype.simulateLabelClick = function () {
1765 };
1766
1767 /**
1768 * Theme logic.
1769 *
1770 * @abstract
1771 * @class
1772 *
1773 * @constructor
1774 */
1775 OO.ui.Theme = function OoUiTheme() {
1776 this.elementClassesQueue = [];
1777 this.debouncedUpdateQueuedElementClasses = OO.ui.debounce( this.updateQueuedElementClasses );
1778 };
1779
1780 /* Setup */
1781
1782 OO.initClass( OO.ui.Theme );
1783
1784 /* Methods */
1785
1786 /**
1787 * Get a list of classes to be applied to a widget.
1788 *
1789 * The 'on' and 'off' lists combined MUST contain keys for all classes the theme adds or removes,
1790 * otherwise state transitions will not work properly.
1791 *
1792 * @param {OO.ui.Element} element Element for which to get classes
1793 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
1794 */
1795 OO.ui.Theme.prototype.getElementClasses = function () {
1796 return { on: [], off: [] };
1797 };
1798
1799 /**
1800 * Update CSS classes provided by the theme.
1801 *
1802 * For elements with theme logic hooks, this should be called any time there's a state change.
1803 *
1804 * @param {OO.ui.Element} element Element for which to update classes
1805 */
1806 OO.ui.Theme.prototype.updateElementClasses = function ( element ) {
1807 var $elements = $( [] ),
1808 classes = this.getElementClasses( element );
1809
1810 if ( element.$icon ) {
1811 $elements = $elements.add( element.$icon );
1812 }
1813 if ( element.$indicator ) {
1814 $elements = $elements.add( element.$indicator );
1815 }
1816
1817 $elements
1818 .removeClass( classes.off.join( ' ' ) )
1819 .addClass( classes.on.join( ' ' ) );
1820 };
1821
1822 /**
1823 * @private
1824 */
1825 OO.ui.Theme.prototype.updateQueuedElementClasses = function () {
1826 var i;
1827 for ( i = 0; i < this.elementClassesQueue.length; i++ ) {
1828 this.updateElementClasses( this.elementClassesQueue[ i ] );
1829 }
1830 // Clear the queue
1831 this.elementClassesQueue = [];
1832 };
1833
1834 /**
1835 * Queue #updateElementClasses to be called for this element.
1836 *
1837 * @localdoc QUnit tests override this method to directly call #queueUpdateElementClasses,
1838 * to make them synchronous.
1839 *
1840 * @param {OO.ui.Element} element Element for which to update classes
1841 */
1842 OO.ui.Theme.prototype.queueUpdateElementClasses = function ( element ) {
1843 // Keep items in the queue unique. Use lastIndexOf to start checking from the end because that's
1844 // the most common case (this method is often called repeatedly for the same element).
1845 if ( this.elementClassesQueue.lastIndexOf( element ) !== -1 ) {
1846 return;
1847 }
1848 this.elementClassesQueue.push( element );
1849 this.debouncedUpdateQueuedElementClasses();
1850 };
1851
1852 /**
1853 * Get the transition duration in milliseconds for dialogs opening/closing
1854 *
1855 * The dialog should be fully rendered this many milliseconds after the
1856 * ready process has executed.
1857 *
1858 * @return {number} Transition duration in milliseconds
1859 */
1860 OO.ui.Theme.prototype.getDialogTransitionDuration = function () {
1861 return 0;
1862 };
1863
1864 /**
1865 * The TabIndexedElement class is an attribute mixin used to add additional functionality to an
1866 * element created by another class. The mixin provides a ‘tabIndex’ property, which specifies the
1867 * order in which users will navigate through the focusable elements via the "tab" key.
1868 *
1869 * @example
1870 * // TabIndexedElement is mixed into the ButtonWidget class
1871 * // to provide a tabIndex property.
1872 * var button1 = new OO.ui.ButtonWidget( {
1873 * label: 'fourth',
1874 * tabIndex: 4
1875 * } );
1876 * var button2 = new OO.ui.ButtonWidget( {
1877 * label: 'second',
1878 * tabIndex: 2
1879 * } );
1880 * var button3 = new OO.ui.ButtonWidget( {
1881 * label: 'third',
1882 * tabIndex: 3
1883 * } );
1884 * var button4 = new OO.ui.ButtonWidget( {
1885 * label: 'first',
1886 * tabIndex: 1
1887 * } );
1888 * $( 'body' ).append( button1.$element, button2.$element, button3.$element, button4.$element );
1889 *
1890 * @abstract
1891 * @class
1892 *
1893 * @constructor
1894 * @param {Object} [config] Configuration options
1895 * @cfg {jQuery} [$tabIndexed] The element that should use the tabindex functionality. By default,
1896 * the functionality is applied to the element created by the class ($element). If a different element is specified, the tabindex
1897 * functionality will be applied to it instead.
1898 * @cfg {string|number|null} [tabIndex=0] Number that specifies the element’s position in the tab-navigation
1899 * order (e.g., 1 for the first focusable element). Use 0 to use the default navigation order; use -1
1900 * to remove the element from the tab-navigation flow.
1901 */
1902 OO.ui.mixin.TabIndexedElement = function OoUiMixinTabIndexedElement( config ) {
1903 // Configuration initialization
1904 config = $.extend( { tabIndex: 0 }, config );
1905
1906 // Properties
1907 this.$tabIndexed = null;
1908 this.tabIndex = null;
1909
1910 // Events
1911 this.connect( this, { disable: 'onTabIndexedElementDisable' } );
1912
1913 // Initialization
1914 this.setTabIndex( config.tabIndex );
1915 this.setTabIndexedElement( config.$tabIndexed || this.$element );
1916 };
1917
1918 /* Setup */
1919
1920 OO.initClass( OO.ui.mixin.TabIndexedElement );
1921
1922 /* Methods */
1923
1924 /**
1925 * Set the element that should use the tabindex functionality.
1926 *
1927 * This method is used to retarget a tabindex mixin so that its functionality applies
1928 * to the specified element. If an element is currently using the functionality, the mixin’s
1929 * effect on that element is removed before the new element is set up.
1930 *
1931 * @param {jQuery} $tabIndexed Element that should use the tabindex functionality
1932 * @chainable
1933 */
1934 OO.ui.mixin.TabIndexedElement.prototype.setTabIndexedElement = function ( $tabIndexed ) {
1935 var tabIndex = this.tabIndex;
1936 // Remove attributes from old $tabIndexed
1937 this.setTabIndex( null );
1938 // Force update of new $tabIndexed
1939 this.$tabIndexed = $tabIndexed;
1940 this.tabIndex = tabIndex;
1941 return this.updateTabIndex();
1942 };
1943
1944 /**
1945 * Set the value of the tabindex.
1946 *
1947 * @param {string|number|null} tabIndex Tabindex value, or `null` for no tabindex
1948 * @chainable
1949 */
1950 OO.ui.mixin.TabIndexedElement.prototype.setTabIndex = function ( tabIndex ) {
1951 tabIndex = /^-?\d+$/.test( tabIndex ) ? Number( tabIndex ) : null;
1952
1953 if ( this.tabIndex !== tabIndex ) {
1954 this.tabIndex = tabIndex;
1955 this.updateTabIndex();
1956 }
1957
1958 return this;
1959 };
1960
1961 /**
1962 * Update the `tabindex` attribute, in case of changes to tab index or
1963 * disabled state.
1964 *
1965 * @private
1966 * @chainable
1967 */
1968 OO.ui.mixin.TabIndexedElement.prototype.updateTabIndex = function () {
1969 if ( this.$tabIndexed ) {
1970 if ( this.tabIndex !== null ) {
1971 // Do not index over disabled elements
1972 this.$tabIndexed.attr( {
1973 tabindex: this.isDisabled() ? -1 : this.tabIndex,
1974 // Support: ChromeVox and NVDA
1975 // These do not seem to inherit aria-disabled from parent elements
1976 'aria-disabled': this.isDisabled().toString()
1977 } );
1978 } else {
1979 this.$tabIndexed.removeAttr( 'tabindex aria-disabled' );
1980 }
1981 }
1982 return this;
1983 };
1984
1985 /**
1986 * Handle disable events.
1987 *
1988 * @private
1989 * @param {boolean} disabled Element is disabled
1990 */
1991 OO.ui.mixin.TabIndexedElement.prototype.onTabIndexedElementDisable = function () {
1992 this.updateTabIndex();
1993 };
1994
1995 /**
1996 * Get the value of the tabindex.
1997 *
1998 * @return {number|null} Tabindex value
1999 */
2000 OO.ui.mixin.TabIndexedElement.prototype.getTabIndex = function () {
2001 return this.tabIndex;
2002 };
2003
2004 /**
2005 * Get an ID of a focusable element of this widget, if any, to be used for `<label for>` value.
2006 *
2007 * If the element already has an ID then that is returned, otherwise unique ID is
2008 * generated, set on the element, and returned.
2009 *
2010 * @return {string|null} The ID of the focusable element
2011 */
2012 OO.ui.mixin.TabIndexedElement.prototype.getInputId = function () {
2013 var id;
2014
2015 if ( !this.$tabIndexed ) {
2016 return null;
2017 }
2018 if ( !this.isLabelableNode( this.$tabIndexed ) ) {
2019 return null;
2020 }
2021
2022 id = this.$tabIndexed.attr( 'id' );
2023 if ( id === undefined ) {
2024 id = OO.ui.generateElementId();
2025 this.$tabIndexed.attr( 'id', id );
2026 }
2027
2028 return id;
2029 };
2030
2031 /**
2032 * Whether the node is 'labelable' according to the HTML spec
2033 * (i.e., whether it can be interacted with through a `<label for="…">`).
2034 * See: <https://html.spec.whatwg.org/multipage/forms.html#category-label>.
2035 *
2036 * @private
2037 * @param {jQuery} $node
2038 * @return {boolean}
2039 */
2040 OO.ui.mixin.TabIndexedElement.prototype.isLabelableNode = function ( $node ) {
2041 var
2042 labelableTags = [ 'button', 'meter', 'output', 'progress', 'select', 'textarea' ],
2043 tagName = $node.prop( 'tagName' ).toLowerCase();
2044
2045 if ( tagName === 'input' && $node.attr( 'type' ) !== 'hidden' ) {
2046 return true;
2047 }
2048 if ( labelableTags.indexOf( tagName ) !== -1 ) {
2049 return true;
2050 }
2051 return false;
2052 };
2053
2054 /**
2055 * Focus this element.
2056 *
2057 * @chainable
2058 */
2059 OO.ui.mixin.TabIndexedElement.prototype.focus = function () {
2060 if ( !this.isDisabled() ) {
2061 this.$tabIndexed.focus();
2062 }
2063 return this;
2064 };
2065
2066 /**
2067 * Blur this element.
2068 *
2069 * @chainable
2070 */
2071 OO.ui.mixin.TabIndexedElement.prototype.blur = function () {
2072 this.$tabIndexed.blur();
2073 return this;
2074 };
2075
2076 /**
2077 * @inheritdoc OO.ui.Widget
2078 */
2079 OO.ui.mixin.TabIndexedElement.prototype.simulateLabelClick = function () {
2080 this.focus();
2081 };
2082
2083 /**
2084 * ButtonElement is often mixed into other classes to generate a button, which is a clickable
2085 * interface element that can be configured with access keys for accessibility.
2086 * See the [OOUI documentation on MediaWiki] [1] for examples.
2087 *
2088 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Buttons_and_Switches#Buttons
2089 *
2090 * @abstract
2091 * @class
2092 *
2093 * @constructor
2094 * @param {Object} [config] Configuration options
2095 * @cfg {jQuery} [$button] The button element created by the class.
2096 * If this configuration is omitted, the button element will use a generated `<a>`.
2097 * @cfg {boolean} [framed=true] Render the button with a frame
2098 */
2099 OO.ui.mixin.ButtonElement = function OoUiMixinButtonElement( config ) {
2100 // Configuration initialization
2101 config = config || {};
2102
2103 // Properties
2104 this.$button = null;
2105 this.framed = null;
2106 this.active = config.active !== undefined && config.active;
2107 this.onMouseUpHandler = this.onMouseUp.bind( this );
2108 this.onMouseDownHandler = this.onMouseDown.bind( this );
2109 this.onKeyDownHandler = this.onKeyDown.bind( this );
2110 this.onKeyUpHandler = this.onKeyUp.bind( this );
2111 this.onClickHandler = this.onClick.bind( this );
2112 this.onKeyPressHandler = this.onKeyPress.bind( this );
2113
2114 // Initialization
2115 this.$element.addClass( 'oo-ui-buttonElement' );
2116 this.toggleFramed( config.framed === undefined || config.framed );
2117 this.setButtonElement( config.$button || $( '<a>' ) );
2118 };
2119
2120 /* Setup */
2121
2122 OO.initClass( OO.ui.mixin.ButtonElement );
2123
2124 /* Static Properties */
2125
2126 /**
2127 * Cancel mouse down events.
2128 *
2129 * This property is usually set to `true` to prevent the focus from changing when the button is clicked.
2130 * Classes such as {@link OO.ui.mixin.DraggableElement DraggableElement} and {@link OO.ui.ButtonOptionWidget ButtonOptionWidget}
2131 * use a value of `false` so that dragging behavior is possible and mousedown events can be handled by a
2132 * parent widget.
2133 *
2134 * @static
2135 * @inheritable
2136 * @property {boolean}
2137 */
2138 OO.ui.mixin.ButtonElement.static.cancelButtonMouseDownEvents = true;
2139
2140 /* Events */
2141
2142 /**
2143 * A 'click' event is emitted when the button element is clicked.
2144 *
2145 * @event click
2146 */
2147
2148 /* Methods */
2149
2150 /**
2151 * Set the button element.
2152 *
2153 * This method is used to retarget a button mixin so that its functionality applies to
2154 * the specified button element instead of the one created by the class. If a button element
2155 * is already set, the method will remove the mixin’s effect on that element.
2156 *
2157 * @param {jQuery} $button Element to use as button
2158 */
2159 OO.ui.mixin.ButtonElement.prototype.setButtonElement = function ( $button ) {
2160 if ( this.$button ) {
2161 this.$button
2162 .removeClass( 'oo-ui-buttonElement-button' )
2163 .removeAttr( 'role accesskey' )
2164 .off( {
2165 mousedown: this.onMouseDownHandler,
2166 keydown: this.onKeyDownHandler,
2167 click: this.onClickHandler,
2168 keypress: this.onKeyPressHandler
2169 } );
2170 }
2171
2172 this.$button = $button
2173 .addClass( 'oo-ui-buttonElement-button' )
2174 .on( {
2175 mousedown: this.onMouseDownHandler,
2176 keydown: this.onKeyDownHandler,
2177 click: this.onClickHandler,
2178 keypress: this.onKeyPressHandler
2179 } );
2180
2181 // Add `role="button"` on `<a>` elements, where it's needed
2182 // `toUppercase()` is added for XHTML documents
2183 if ( this.$button.prop( 'tagName' ).toUpperCase() === 'A' ) {
2184 this.$button.attr( 'role', 'button' );
2185 }
2186 };
2187
2188 /**
2189 * Handles mouse down events.
2190 *
2191 * @protected
2192 * @param {jQuery.Event} e Mouse down event
2193 */
2194 OO.ui.mixin.ButtonElement.prototype.onMouseDown = function ( e ) {
2195 if ( this.isDisabled() || e.which !== OO.ui.MouseButtons.LEFT ) {
2196 return;
2197 }
2198 this.$element.addClass( 'oo-ui-buttonElement-pressed' );
2199 // Run the mouseup handler no matter where the mouse is when the button is let go, so we can
2200 // reliably remove the pressed class
2201 this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler, true );
2202 // Prevent change of focus unless specifically configured otherwise
2203 if ( this.constructor.static.cancelButtonMouseDownEvents ) {
2204 return false;
2205 }
2206 };
2207
2208 /**
2209 * Handles mouse up events.
2210 *
2211 * @protected
2212 * @param {MouseEvent} e Mouse up event
2213 */
2214 OO.ui.mixin.ButtonElement.prototype.onMouseUp = function ( e ) {
2215 if ( this.isDisabled() || e.which !== OO.ui.MouseButtons.LEFT ) {
2216 return;
2217 }
2218 this.$element.removeClass( 'oo-ui-buttonElement-pressed' );
2219 // Stop listening for mouseup, since we only needed this once
2220 this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler, true );
2221 };
2222
2223 /**
2224 * Handles mouse click events.
2225 *
2226 * @protected
2227 * @param {jQuery.Event} e Mouse click event
2228 * @fires click
2229 */
2230 OO.ui.mixin.ButtonElement.prototype.onClick = function ( e ) {
2231 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
2232 if ( this.emit( 'click' ) ) {
2233 return false;
2234 }
2235 }
2236 };
2237
2238 /**
2239 * Handles key down events.
2240 *
2241 * @protected
2242 * @param {jQuery.Event} e Key down event
2243 */
2244 OO.ui.mixin.ButtonElement.prototype.onKeyDown = function ( e ) {
2245 if ( this.isDisabled() || ( e.which !== OO.ui.Keys.SPACE && e.which !== OO.ui.Keys.ENTER ) ) {
2246 return;
2247 }
2248 this.$element.addClass( 'oo-ui-buttonElement-pressed' );
2249 // Run the keyup handler no matter where the key is when the button is let go, so we can
2250 // reliably remove the pressed class
2251 this.getElementDocument().addEventListener( 'keyup', this.onKeyUpHandler, true );
2252 };
2253
2254 /**
2255 * Handles key up events.
2256 *
2257 * @protected
2258 * @param {KeyboardEvent} e Key up event
2259 */
2260 OO.ui.mixin.ButtonElement.prototype.onKeyUp = function ( e ) {
2261 if ( this.isDisabled() || ( e.which !== OO.ui.Keys.SPACE && e.which !== OO.ui.Keys.ENTER ) ) {
2262 return;
2263 }
2264 this.$element.removeClass( 'oo-ui-buttonElement-pressed' );
2265 // Stop listening for keyup, since we only needed this once
2266 this.getElementDocument().removeEventListener( 'keyup', this.onKeyUpHandler, true );
2267 };
2268
2269 /**
2270 * Handles key press events.
2271 *
2272 * @protected
2273 * @param {jQuery.Event} e Key press event
2274 * @fires click
2275 */
2276 OO.ui.mixin.ButtonElement.prototype.onKeyPress = function ( e ) {
2277 if ( !this.isDisabled() && ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER ) ) {
2278 if ( this.emit( 'click' ) ) {
2279 return false;
2280 }
2281 }
2282 };
2283
2284 /**
2285 * Check if button has a frame.
2286 *
2287 * @return {boolean} Button is framed
2288 */
2289 OO.ui.mixin.ButtonElement.prototype.isFramed = function () {
2290 return this.framed;
2291 };
2292
2293 /**
2294 * Render the button with or without a frame. Omit the `framed` parameter to toggle the button frame on and off.
2295 *
2296 * @param {boolean} [framed] Make button framed, omit to toggle
2297 * @chainable
2298 */
2299 OO.ui.mixin.ButtonElement.prototype.toggleFramed = function ( framed ) {
2300 framed = framed === undefined ? !this.framed : !!framed;
2301 if ( framed !== this.framed ) {
2302 this.framed = framed;
2303 this.$element
2304 .toggleClass( 'oo-ui-buttonElement-frameless', !framed )
2305 .toggleClass( 'oo-ui-buttonElement-framed', framed );
2306 this.updateThemeClasses();
2307 }
2308
2309 return this;
2310 };
2311
2312 /**
2313 * Set the button's active state.
2314 *
2315 * The active state can be set on:
2316 *
2317 * - {@link OO.ui.ButtonOptionWidget ButtonOptionWidget} when it is selected
2318 * - {@link OO.ui.ToggleButtonWidget ToggleButtonWidget} when it is toggle on
2319 * - {@link OO.ui.ButtonWidget ButtonWidget} when clicking the button would only refresh the page
2320 *
2321 * @protected
2322 * @param {boolean} value Make button active
2323 * @chainable
2324 */
2325 OO.ui.mixin.ButtonElement.prototype.setActive = function ( value ) {
2326 this.active = !!value;
2327 this.$element.toggleClass( 'oo-ui-buttonElement-active', this.active );
2328 this.updateThemeClasses();
2329 return this;
2330 };
2331
2332 /**
2333 * Check if the button is active
2334 *
2335 * @protected
2336 * @return {boolean} The button is active
2337 */
2338 OO.ui.mixin.ButtonElement.prototype.isActive = function () {
2339 return this.active;
2340 };
2341
2342 /**
2343 * Any OOUI widget that contains other widgets (such as {@link OO.ui.ButtonWidget buttons} or
2344 * {@link OO.ui.OptionWidget options}) mixes in GroupElement. Adding, removing, and clearing
2345 * items from the group is done through the interface the class provides.
2346 * For more information, please see the [OOUI documentation on MediaWiki] [1].
2347 *
2348 * [1]: https://www.mediawiki.org/wiki/OOUI/Elements/Groups
2349 *
2350 * @abstract
2351 * @mixins OO.EmitterList
2352 * @class
2353 *
2354 * @constructor
2355 * @param {Object} [config] Configuration options
2356 * @cfg {jQuery} [$group] The container element created by the class. If this configuration
2357 * is omitted, the group element will use a generated `<div>`.
2358 */
2359 OO.ui.mixin.GroupElement = function OoUiMixinGroupElement( config ) {
2360 // Configuration initialization
2361 config = config || {};
2362
2363 // Mixin constructors
2364 OO.EmitterList.call( this, config );
2365
2366 // Properties
2367 this.$group = null;
2368
2369 // Initialization
2370 this.setGroupElement( config.$group || $( '<div>' ) );
2371 };
2372
2373 /* Setup */
2374
2375 OO.mixinClass( OO.ui.mixin.GroupElement, OO.EmitterList );
2376
2377 /* Events */
2378
2379 /**
2380 * @event change
2381 *
2382 * A change event is emitted when the set of selected items changes.
2383 *
2384 * @param {OO.ui.Element[]} items Items currently in the group
2385 */
2386
2387 /* Methods */
2388
2389 /**
2390 * Set the group element.
2391 *
2392 * If an element is already set, items will be moved to the new element.
2393 *
2394 * @param {jQuery} $group Element to use as group
2395 */
2396 OO.ui.mixin.GroupElement.prototype.setGroupElement = function ( $group ) {
2397 var i, len;
2398
2399 this.$group = $group;
2400 for ( i = 0, len = this.items.length; i < len; i++ ) {
2401 this.$group.append( this.items[ i ].$element );
2402 }
2403 };
2404
2405 /**
2406 * Find an item by its data.
2407 *
2408 * Only the first item with matching data will be returned. To return all matching items,
2409 * use the #findItemsFromData method.
2410 *
2411 * @param {Object} data Item data to search for
2412 * @return {OO.ui.Element|null} Item with equivalent data, `null` if none exists
2413 */
2414 OO.ui.mixin.GroupElement.prototype.findItemFromData = function ( data ) {
2415 var i, len, item,
2416 hash = OO.getHash( data );
2417
2418 for ( i = 0, len = this.items.length; i < len; i++ ) {
2419 item = this.items[ i ];
2420 if ( hash === OO.getHash( item.getData() ) ) {
2421 return item;
2422 }
2423 }
2424
2425 return null;
2426 };
2427
2428 /**
2429 * Get an item by its data.
2430 *
2431 * @deprecated Since v0.25.0; use {@link #findItemFromData} instead.
2432 * @param {Object} data Item data to search for
2433 * @return {OO.ui.Element|null} Item with equivalent data, `null` if none exists
2434 */
2435 OO.ui.mixin.GroupElement.prototype.getItemFromData = function ( data ) {
2436 OO.ui.warnDeprecation( 'GroupElement#getItemFromData. Deprecated function. Use findItemFromData instead. See T76630' );
2437 return this.findItemFromData( data );
2438 };
2439
2440 /**
2441 * Find items by their data.
2442 *
2443 * All items with matching data will be returned. To return only the first match, use the #findItemFromData method instead.
2444 *
2445 * @param {Object} data Item data to search for
2446 * @return {OO.ui.Element[]} Items with equivalent data
2447 */
2448 OO.ui.mixin.GroupElement.prototype.findItemsFromData = function ( data ) {
2449 var i, len, item,
2450 hash = OO.getHash( data ),
2451 items = [];
2452
2453 for ( i = 0, len = this.items.length; i < len; i++ ) {
2454 item = this.items[ i ];
2455 if ( hash === OO.getHash( item.getData() ) ) {
2456 items.push( item );
2457 }
2458 }
2459
2460 return items;
2461 };
2462
2463 /**
2464 * Find items by their data.
2465 *
2466 * @deprecated Since v0.25.0; use {@link #findItemsFromData} instead.
2467 * @param {Object} data Item data to search for
2468 * @return {OO.ui.Element[]} Items with equivalent data
2469 */
2470 OO.ui.mixin.GroupElement.prototype.getItemsFromData = function ( data ) {
2471 OO.ui.warnDeprecation( 'GroupElement#getItemsFromData. Deprecated function. Use findItemsFromData instead. See T76630' );
2472 return this.findItemsFromData( data );
2473 };
2474
2475 /**
2476 * Add items to the group.
2477 *
2478 * Items will be added to the end of the group array unless the optional `index` parameter specifies
2479 * a different insertion point. Adding an existing item will move it to the end of the array or the point specified by the `index`.
2480 *
2481 * @param {OO.ui.Element[]} items An array of items to add to the group
2482 * @param {number} [index] Index of the insertion point
2483 * @chainable
2484 */
2485 OO.ui.mixin.GroupElement.prototype.addItems = function ( items, index ) {
2486 // Mixin method
2487 OO.EmitterList.prototype.addItems.call( this, items, index );
2488
2489 this.emit( 'change', this.getItems() );
2490 return this;
2491 };
2492
2493 /**
2494 * @inheritdoc
2495 */
2496 OO.ui.mixin.GroupElement.prototype.moveItem = function ( items, newIndex ) {
2497 // insertItemElements expects this.items to not have been modified yet, so call before the mixin
2498 this.insertItemElements( items, newIndex );
2499
2500 // Mixin method
2501 newIndex = OO.EmitterList.prototype.moveItem.call( this, items, newIndex );
2502
2503 return newIndex;
2504 };
2505
2506 /**
2507 * @inheritdoc
2508 */
2509 OO.ui.mixin.GroupElement.prototype.insertItem = function ( item, index ) {
2510 item.setElementGroup( this );
2511 this.insertItemElements( item, index );
2512
2513 // Mixin method
2514 index = OO.EmitterList.prototype.insertItem.call( this, item, index );
2515
2516 return index;
2517 };
2518
2519 /**
2520 * Insert elements into the group
2521 *
2522 * @private
2523 * @param {OO.ui.Element} itemWidget Item to insert
2524 * @param {number} index Insertion index
2525 */
2526 OO.ui.mixin.GroupElement.prototype.insertItemElements = function ( itemWidget, index ) {
2527 if ( index === undefined || index < 0 || index >= this.items.length ) {
2528 this.$group.append( itemWidget.$element );
2529 } else if ( index === 0 ) {
2530 this.$group.prepend( itemWidget.$element );
2531 } else {
2532 this.items[ index ].$element.before( itemWidget.$element );
2533 }
2534 };
2535
2536 /**
2537 * Remove the specified items from a group.
2538 *
2539 * Removed items are detached (not removed) from the DOM so that they may be reused.
2540 * To remove all items from a group, you may wish to use the #clearItems method instead.
2541 *
2542 * @param {OO.ui.Element[]} items An array of items to remove
2543 * @chainable
2544 */
2545 OO.ui.mixin.GroupElement.prototype.removeItems = function ( items ) {
2546 var i, len, item, index;
2547
2548 // Remove specific items elements
2549 for ( i = 0, len = items.length; i < len; i++ ) {
2550 item = items[ i ];
2551 index = this.items.indexOf( item );
2552 if ( index !== -1 ) {
2553 item.setElementGroup( null );
2554 item.$element.detach();
2555 }
2556 }
2557
2558 // Mixin method
2559 OO.EmitterList.prototype.removeItems.call( this, items );
2560
2561 this.emit( 'change', this.getItems() );
2562 return this;
2563 };
2564
2565 /**
2566 * Clear all items from the group.
2567 *
2568 * Cleared items are detached from the DOM, not removed, so that they may be reused.
2569 * To remove only a subset of items from a group, use the #removeItems method.
2570 *
2571 * @chainable
2572 */
2573 OO.ui.mixin.GroupElement.prototype.clearItems = function () {
2574 var i, len;
2575
2576 // Remove all item elements
2577 for ( i = 0, len = this.items.length; i < len; i++ ) {
2578 this.items[ i ].setElementGroup( null );
2579 this.items[ i ].$element.detach();
2580 }
2581
2582 // Mixin method
2583 OO.EmitterList.prototype.clearItems.call( this );
2584
2585 this.emit( 'change', this.getItems() );
2586 return this;
2587 };
2588
2589 /**
2590 * IconElement is often mixed into other classes to generate an icon.
2591 * Icons are graphics, about the size of normal text. They are used to aid the user
2592 * in locating a control or to convey information in a space-efficient way. See the
2593 * [OOUI documentation on MediaWiki] [1] for a list of icons
2594 * included in the library.
2595 *
2596 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Icons
2597 *
2598 * @abstract
2599 * @class
2600 *
2601 * @constructor
2602 * @param {Object} [config] Configuration options
2603 * @cfg {jQuery} [$icon] The icon element created by the class. If this configuration is omitted,
2604 * the icon element will use a generated `<span>`. To use a different HTML tag, or to specify that
2605 * the icon element be set to an existing icon instead of the one generated by this class, set a
2606 * value using a jQuery selection. For example:
2607 *
2608 * // Use a <div> tag instead of a <span>
2609 * $icon: $("<div>")
2610 * // Use an existing icon element instead of the one generated by the class
2611 * $icon: this.$element
2612 * // Use an icon element from a child widget
2613 * $icon: this.childwidget.$element
2614 * @cfg {Object|string} [icon=''] The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of
2615 * symbolic names. A map is used for i18n purposes and contains a `default` icon
2616 * name and additional names keyed by language code. The `default` name is used when no icon is keyed
2617 * by the user's language.
2618 *
2619 * Example of an i18n map:
2620 *
2621 * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
2622 * See the [OOUI documentation on MediaWiki] [2] for a list of icons included in the library.
2623 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Icons
2624 * @cfg {string|Function} [iconTitle] A text string used as the icon title, or a function that returns title
2625 * text. The icon title is displayed when users move the mouse over the icon.
2626 */
2627 OO.ui.mixin.IconElement = function OoUiMixinIconElement( config ) {
2628 // Configuration initialization
2629 config = config || {};
2630
2631 // Properties
2632 this.$icon = null;
2633 this.icon = null;
2634 this.iconTitle = null;
2635
2636 // Initialization
2637 this.setIcon( config.icon || this.constructor.static.icon );
2638 this.setIconTitle( config.iconTitle || this.constructor.static.iconTitle );
2639 this.setIconElement( config.$icon || $( '<span>' ) );
2640 };
2641
2642 /* Setup */
2643
2644 OO.initClass( OO.ui.mixin.IconElement );
2645
2646 /* Static Properties */
2647
2648 /**
2649 * The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of symbolic names. A map is used
2650 * for i18n purposes and contains a `default` icon name and additional names keyed by
2651 * language code. The `default` name is used when no icon is keyed by the user's language.
2652 *
2653 * Example of an i18n map:
2654 *
2655 * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
2656 *
2657 * Note: the static property will be overridden if the #icon configuration is used.
2658 *
2659 * @static
2660 * @inheritable
2661 * @property {Object|string}
2662 */
2663 OO.ui.mixin.IconElement.static.icon = null;
2664
2665 /**
2666 * The icon title, displayed when users move the mouse over the icon. The value can be text, a
2667 * function that returns title text, or `null` for no title.
2668 *
2669 * The static property will be overridden if the #iconTitle configuration is used.
2670 *
2671 * @static
2672 * @inheritable
2673 * @property {string|Function|null}
2674 */
2675 OO.ui.mixin.IconElement.static.iconTitle = null;
2676
2677 /* Methods */
2678
2679 /**
2680 * Set the icon element. This method is used to retarget an icon mixin so that its functionality
2681 * applies to the specified icon element instead of the one created by the class. If an icon
2682 * element is already set, the mixin’s effect on that element is removed. Generated CSS classes
2683 * and mixin methods will no longer affect the element.
2684 *
2685 * @param {jQuery} $icon Element to use as icon
2686 */
2687 OO.ui.mixin.IconElement.prototype.setIconElement = function ( $icon ) {
2688 if ( this.$icon ) {
2689 this.$icon
2690 .removeClass( 'oo-ui-iconElement-icon oo-ui-icon-' + this.icon )
2691 .removeAttr( 'title' );
2692 }
2693
2694 this.$icon = $icon
2695 .addClass( 'oo-ui-iconElement-icon' )
2696 .toggleClass( 'oo-ui-icon-' + this.icon, !!this.icon );
2697 if ( this.iconTitle !== null ) {
2698 this.$icon.attr( 'title', this.iconTitle );
2699 }
2700
2701 this.updateThemeClasses();
2702 };
2703
2704 /**
2705 * Set icon by symbolic name (e.g., ‘remove’ or ‘menu’). Use `null` to remove an icon.
2706 * The icon parameter can also be set to a map of icon names. See the #icon config setting
2707 * for an example.
2708 *
2709 * @param {Object|string|null} icon A symbolic icon name, a {@link #icon map of icon names} keyed
2710 * by language code, or `null` to remove the icon.
2711 * @chainable
2712 */
2713 OO.ui.mixin.IconElement.prototype.setIcon = function ( icon ) {
2714 icon = OO.isPlainObject( icon ) ? OO.ui.getLocalValue( icon, null, 'default' ) : icon;
2715 icon = typeof icon === 'string' && icon.trim().length ? icon.trim() : null;
2716
2717 if ( this.icon !== icon ) {
2718 if ( this.$icon ) {
2719 if ( this.icon !== null ) {
2720 this.$icon.removeClass( 'oo-ui-icon-' + this.icon );
2721 }
2722 if ( icon !== null ) {
2723 this.$icon.addClass( 'oo-ui-icon-' + icon );
2724 }
2725 }
2726 this.icon = icon;
2727 }
2728
2729 this.$element.toggleClass( 'oo-ui-iconElement', !!this.icon );
2730 this.updateThemeClasses();
2731
2732 return this;
2733 };
2734
2735 /**
2736 * Set the icon title. Use `null` to remove the title.
2737 *
2738 * @param {string|Function|null} iconTitle A text string used as the icon title,
2739 * a function that returns title text, or `null` for no title.
2740 * @chainable
2741 */
2742 OO.ui.mixin.IconElement.prototype.setIconTitle = function ( iconTitle ) {
2743 iconTitle =
2744 ( typeof iconTitle === 'function' || ( typeof iconTitle === 'string' && iconTitle.length ) ) ?
2745 OO.ui.resolveMsg( iconTitle ) : null;
2746
2747 if ( this.iconTitle !== iconTitle ) {
2748 this.iconTitle = iconTitle;
2749 if ( this.$icon ) {
2750 if ( this.iconTitle !== null ) {
2751 this.$icon.attr( 'title', iconTitle );
2752 } else {
2753 this.$icon.removeAttr( 'title' );
2754 }
2755 }
2756 }
2757
2758 return this;
2759 };
2760
2761 /**
2762 * Get the symbolic name of the icon.
2763 *
2764 * @return {string} Icon name
2765 */
2766 OO.ui.mixin.IconElement.prototype.getIcon = function () {
2767 return this.icon;
2768 };
2769
2770 /**
2771 * Get the icon title. The title text is displayed when a user moves the mouse over the icon.
2772 *
2773 * @return {string} Icon title text
2774 */
2775 OO.ui.mixin.IconElement.prototype.getIconTitle = function () {
2776 return this.iconTitle;
2777 };
2778
2779 /**
2780 * IndicatorElement is often mixed into other classes to generate an indicator.
2781 * Indicators are small graphics that are generally used in two ways:
2782 *
2783 * - To draw attention to the status of an item. For example, an indicator might be
2784 * used to show that an item in a list has errors that need to be resolved.
2785 * - To clarify the function of a control that acts in an exceptional way (a button
2786 * that opens a menu instead of performing an action directly, for example).
2787 *
2788 * For a list of indicators included in the library, please see the
2789 * [OOUI documentation on MediaWiki] [1].
2790 *
2791 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Indicators
2792 *
2793 * @abstract
2794 * @class
2795 *
2796 * @constructor
2797 * @param {Object} [config] Configuration options
2798 * @cfg {jQuery} [$indicator] The indicator element created by the class. If this
2799 * configuration is omitted, the indicator element will use a generated `<span>`.
2800 * @cfg {string} [indicator] Symbolic name of the indicator (e.g., ‘alert’ or ‘down’).
2801 * See the [OOUI documentation on MediaWiki][2] for a list of indicators included
2802 * in the library.
2803 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Indicators
2804 * @cfg {string|Function} [indicatorTitle] A text string used as the indicator title,
2805 * or a function that returns title text. The indicator title is displayed when users move
2806 * the mouse over the indicator.
2807 */
2808 OO.ui.mixin.IndicatorElement = function OoUiMixinIndicatorElement( config ) {
2809 // Configuration initialization
2810 config = config || {};
2811
2812 // Properties
2813 this.$indicator = null;
2814 this.indicator = null;
2815 this.indicatorTitle = null;
2816
2817 // Initialization
2818 this.setIndicator( config.indicator || this.constructor.static.indicator );
2819 this.setIndicatorTitle( config.indicatorTitle || this.constructor.static.indicatorTitle );
2820 this.setIndicatorElement( config.$indicator || $( '<span>' ) );
2821 };
2822
2823 /* Setup */
2824
2825 OO.initClass( OO.ui.mixin.IndicatorElement );
2826
2827 /* Static Properties */
2828
2829 /**
2830 * Symbolic name of the indicator (e.g., ‘alert’ or ‘down’).
2831 * The static property will be overridden if the #indicator configuration is used.
2832 *
2833 * @static
2834 * @inheritable
2835 * @property {string|null}
2836 */
2837 OO.ui.mixin.IndicatorElement.static.indicator = null;
2838
2839 /**
2840 * A text string used as the indicator title, a function that returns title text, or `null`
2841 * for no title. The static property will be overridden if the #indicatorTitle configuration is used.
2842 *
2843 * @static
2844 * @inheritable
2845 * @property {string|Function|null}
2846 */
2847 OO.ui.mixin.IndicatorElement.static.indicatorTitle = null;
2848
2849 /* Methods */
2850
2851 /**
2852 * Set the indicator element.
2853 *
2854 * If an element is already set, it will be cleaned up before setting up the new element.
2855 *
2856 * @param {jQuery} $indicator Element to use as indicator
2857 */
2858 OO.ui.mixin.IndicatorElement.prototype.setIndicatorElement = function ( $indicator ) {
2859 if ( this.$indicator ) {
2860 this.$indicator
2861 .removeClass( 'oo-ui-indicatorElement-indicator oo-ui-indicator-' + this.indicator )
2862 .removeAttr( 'title' );
2863 }
2864
2865 this.$indicator = $indicator
2866 .addClass( 'oo-ui-indicatorElement-indicator' )
2867 .toggleClass( 'oo-ui-indicator-' + this.indicator, !!this.indicator );
2868 if ( this.indicatorTitle !== null ) {
2869 this.$indicator.attr( 'title', this.indicatorTitle );
2870 }
2871
2872 this.updateThemeClasses();
2873 };
2874
2875 /**
2876 * Set the indicator by its symbolic name: ‘alert’, ‘down’, ‘next’, ‘previous’, ‘required’, ‘up’. Use `null` to remove the indicator.
2877 *
2878 * @param {string|null} indicator Symbolic name of indicator, or `null` for no indicator
2879 * @chainable
2880 */
2881 OO.ui.mixin.IndicatorElement.prototype.setIndicator = function ( indicator ) {
2882 indicator = typeof indicator === 'string' && indicator.length ? indicator.trim() : null;
2883
2884 if ( this.indicator !== indicator ) {
2885 if ( this.$indicator ) {
2886 if ( this.indicator !== null ) {
2887 this.$indicator.removeClass( 'oo-ui-indicator-' + this.indicator );
2888 }
2889 if ( indicator !== null ) {
2890 this.$indicator.addClass( 'oo-ui-indicator-' + indicator );
2891 }
2892 }
2893 this.indicator = indicator;
2894 }
2895
2896 this.$element.toggleClass( 'oo-ui-indicatorElement', !!this.indicator );
2897 this.updateThemeClasses();
2898
2899 return this;
2900 };
2901
2902 /**
2903 * Set the indicator title.
2904 *
2905 * The title is displayed when a user moves the mouse over the indicator.
2906 *
2907 * @param {string|Function|null} indicatorTitle Indicator title text, a function that returns text, or
2908 * `null` for no indicator title
2909 * @chainable
2910 */
2911 OO.ui.mixin.IndicatorElement.prototype.setIndicatorTitle = function ( indicatorTitle ) {
2912 indicatorTitle =
2913 ( typeof indicatorTitle === 'function' || ( typeof indicatorTitle === 'string' && indicatorTitle.length ) ) ?
2914 OO.ui.resolveMsg( indicatorTitle ) : null;
2915
2916 if ( this.indicatorTitle !== indicatorTitle ) {
2917 this.indicatorTitle = indicatorTitle;
2918 if ( this.$indicator ) {
2919 if ( this.indicatorTitle !== null ) {
2920 this.$indicator.attr( 'title', indicatorTitle );
2921 } else {
2922 this.$indicator.removeAttr( 'title' );
2923 }
2924 }
2925 }
2926
2927 return this;
2928 };
2929
2930 /**
2931 * Get the symbolic name of the indicator (e.g., ‘alert’ or ‘down’).
2932 *
2933 * @return {string} Symbolic name of indicator
2934 */
2935 OO.ui.mixin.IndicatorElement.prototype.getIndicator = function () {
2936 return this.indicator;
2937 };
2938
2939 /**
2940 * Get the indicator title.
2941 *
2942 * The title is displayed when a user moves the mouse over the indicator.
2943 *
2944 * @return {string} Indicator title text
2945 */
2946 OO.ui.mixin.IndicatorElement.prototype.getIndicatorTitle = function () {
2947 return this.indicatorTitle;
2948 };
2949
2950 /**
2951 * LabelElement is often mixed into other classes to generate a label, which
2952 * helps identify the function of an interface element.
2953 * See the [OOUI documentation on MediaWiki] [1] for more information.
2954 *
2955 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Labels
2956 *
2957 * @abstract
2958 * @class
2959 *
2960 * @constructor
2961 * @param {Object} [config] Configuration options
2962 * @cfg {jQuery} [$label] The label element created by the class. If this
2963 * configuration is omitted, the label element will use a generated `<span>`.
2964 * @cfg {jQuery|string|Function|OO.ui.HtmlSnippet} [label] The label text. The label can be specified
2965 * as a plaintext string, a jQuery selection of elements, or a function that will produce a string
2966 * in the future. See the [OOUI documentation on MediaWiki] [2] for examples.
2967 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Labels
2968 */
2969 OO.ui.mixin.LabelElement = function OoUiMixinLabelElement( config ) {
2970 // Configuration initialization
2971 config = config || {};
2972
2973 // Properties
2974 this.$label = null;
2975 this.label = null;
2976
2977 // Initialization
2978 this.setLabel( config.label || this.constructor.static.label );
2979 this.setLabelElement( config.$label || $( '<span>' ) );
2980 };
2981
2982 /* Setup */
2983
2984 OO.initClass( OO.ui.mixin.LabelElement );
2985
2986 /* Events */
2987
2988 /**
2989 * @event labelChange
2990 * @param {string} value
2991 */
2992
2993 /* Static Properties */
2994
2995 /**
2996 * The label text. The label can be specified as a plaintext string, a function that will
2997 * produce a string in the future, or `null` for no label. The static value will
2998 * be overridden if a label is specified with the #label config option.
2999 *
3000 * @static
3001 * @inheritable
3002 * @property {string|Function|null}
3003 */
3004 OO.ui.mixin.LabelElement.static.label = null;
3005
3006 /* Static methods */
3007
3008 /**
3009 * Highlight the first occurrence of the query in the given text
3010 *
3011 * @param {string} text Text
3012 * @param {string} query Query to find
3013 * @param {Function} [compare] Optional string comparator, e.g. Intl.Collator().compare
3014 * @return {jQuery} Text with the first match of the query
3015 * sub-string wrapped in highlighted span
3016 */
3017 OO.ui.mixin.LabelElement.static.highlightQuery = function ( text, query, compare ) {
3018 var i, tLen, qLen,
3019 offset = -1,
3020 $result = $( '<span>' );
3021
3022 if ( compare ) {
3023 tLen = text.length;
3024 qLen = query.length;
3025 for ( i = 0; offset === -1 && i <= tLen - qLen; i++ ) {
3026 if ( compare( query, text.slice( i, i + qLen ) ) === 0 ) {
3027 offset = i;
3028 }
3029 }
3030 } else {
3031 offset = text.toLowerCase().indexOf( query.toLowerCase() );
3032 }
3033
3034 if ( !query.length || offset === -1 ) {
3035 $result.text( text );
3036 } else {
3037 $result.append(
3038 document.createTextNode( text.slice( 0, offset ) ),
3039 $( '<span>' )
3040 .addClass( 'oo-ui-labelElement-label-highlight' )
3041 .text( text.slice( offset, offset + query.length ) ),
3042 document.createTextNode( text.slice( offset + query.length ) )
3043 );
3044 }
3045 return $result.contents();
3046 };
3047
3048 /* Methods */
3049
3050 /**
3051 * Set the label element.
3052 *
3053 * If an element is already set, it will be cleaned up before setting up the new element.
3054 *
3055 * @param {jQuery} $label Element to use as label
3056 */
3057 OO.ui.mixin.LabelElement.prototype.setLabelElement = function ( $label ) {
3058 if ( this.$label ) {
3059 this.$label.removeClass( 'oo-ui-labelElement-label' ).empty();
3060 }
3061
3062 this.$label = $label.addClass( 'oo-ui-labelElement-label' );
3063 this.setLabelContent( this.label );
3064 };
3065
3066 /**
3067 * Set the label.
3068 *
3069 * An empty string will result in the label being hidden. A string containing only whitespace will
3070 * be converted to a single `&nbsp;`.
3071 *
3072 * @param {jQuery|string|OO.ui.HtmlSnippet|Function|null} label Label nodes; text; a function that returns nodes or
3073 * text; or null for no label
3074 * @chainable
3075 */
3076 OO.ui.mixin.LabelElement.prototype.setLabel = function ( label ) {
3077 label = typeof label === 'function' ? OO.ui.resolveMsg( label ) : label;
3078 label = ( ( typeof label === 'string' || label instanceof jQuery ) && label.length ) || ( label instanceof OO.ui.HtmlSnippet && label.toString().length ) ? label : null;
3079
3080 if ( this.label !== label ) {
3081 if ( this.$label ) {
3082 this.setLabelContent( label );
3083 }
3084 this.label = label;
3085 this.emit( 'labelChange' );
3086 }
3087
3088 this.$element.toggleClass( 'oo-ui-labelElement', !!this.label );
3089
3090 return this;
3091 };
3092
3093 /**
3094 * Set the label as plain text with a highlighted query
3095 *
3096 * @param {string} text Text label to set
3097 * @param {string} query Substring of text to highlight
3098 * @param {Function} [compare] Optional string comparator, e.g. Intl.Collator().compare
3099 * @chainable
3100 */
3101 OO.ui.mixin.LabelElement.prototype.setHighlightedQuery = function ( text, query, compare ) {
3102 return this.setLabel( this.constructor.static.highlightQuery( text, query, compare ) );
3103 };
3104
3105 /**
3106 * Get the label.
3107 *
3108 * @return {jQuery|string|Function|null} Label nodes; text; a function that returns nodes or
3109 * text; or null for no label
3110 */
3111 OO.ui.mixin.LabelElement.prototype.getLabel = function () {
3112 return this.label;
3113 };
3114
3115 /**
3116 * Set the content of the label.
3117 *
3118 * Do not call this method until after the label element has been set by #setLabelElement.
3119 *
3120 * @private
3121 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
3122 * text; or null for no label
3123 */
3124 OO.ui.mixin.LabelElement.prototype.setLabelContent = function ( label ) {
3125 if ( typeof label === 'string' ) {
3126 if ( label.match( /^\s*$/ ) ) {
3127 // Convert whitespace only string to a single non-breaking space
3128 this.$label.html( '&nbsp;' );
3129 } else {
3130 this.$label.text( label );
3131 }
3132 } else if ( label instanceof OO.ui.HtmlSnippet ) {
3133 this.$label.html( label.toString() );
3134 } else if ( label instanceof jQuery ) {
3135 this.$label.empty().append( label );
3136 } else {
3137 this.$label.empty();
3138 }
3139 };
3140
3141 /**
3142 * The FlaggedElement class is an attribute mixin, meaning that it is used to add
3143 * additional functionality to an element created by another class. The class provides
3144 * a ‘flags’ property assigned the name (or an array of names) of styling flags,
3145 * which are used to customize the look and feel of a widget to better describe its
3146 * importance and functionality.
3147 *
3148 * The library currently contains the following styling flags for general use:
3149 *
3150 * - **progressive**: Progressive styling is applied to convey that the widget will move the user forward in a process.
3151 * - **destructive**: Destructive styling is applied to convey that the widget will remove something.
3152 *
3153 * The flags affect the appearance of the buttons:
3154 *
3155 * @example
3156 * // FlaggedElement is mixed into ButtonWidget to provide styling flags
3157 * var button1 = new OO.ui.ButtonWidget( {
3158 * label: 'Progressive',
3159 * flags: 'progressive'
3160 * } );
3161 * var button2 = new OO.ui.ButtonWidget( {
3162 * label: 'Destructive',
3163 * flags: 'destructive'
3164 * } );
3165 * $( 'body' ).append( button1.$element, button2.$element );
3166 *
3167 * {@link OO.ui.ActionWidget ActionWidgets}, which are a special kind of button that execute an action, use these flags: **primary** and **safe**.
3168 * Please see the [OOUI documentation on MediaWiki] [1] for more information.
3169 *
3170 * [1]: https://www.mediawiki.org/wiki/OOUI/Elements/Flagged
3171 *
3172 * @abstract
3173 * @class
3174 *
3175 * @constructor
3176 * @param {Object} [config] Configuration options
3177 * @cfg {string|string[]} [flags] The name or names of the flags (e.g., 'progressive' or 'primary') to apply.
3178 * Please see the [OOUI documentation on MediaWiki] [2] for more information about available flags.
3179 * [2]: https://www.mediawiki.org/wiki/OOUI/Elements/Flagged
3180 * @cfg {jQuery} [$flagged] The flagged element. By default,
3181 * the flagged functionality is applied to the element created by the class ($element).
3182 * If a different element is specified, the flagged functionality will be applied to it instead.
3183 */
3184 OO.ui.mixin.FlaggedElement = function OoUiMixinFlaggedElement( config ) {
3185 // Configuration initialization
3186 config = config || {};
3187
3188 // Properties
3189 this.flags = {};
3190 this.$flagged = null;
3191
3192 // Initialization
3193 this.setFlags( config.flags );
3194 this.setFlaggedElement( config.$flagged || this.$element );
3195 };
3196
3197 /* Events */
3198
3199 /**
3200 * @event flag
3201 * A flag event is emitted when the #clearFlags or #setFlags methods are used. The `changes`
3202 * parameter contains the name of each modified flag and indicates whether it was
3203 * added or removed.
3204 *
3205 * @param {Object.<string,boolean>} changes Object keyed by flag name. A Boolean `true` indicates
3206 * that the flag was added, `false` that the flag was removed.
3207 */
3208
3209 /* Methods */
3210
3211 /**
3212 * Set the flagged element.
3213 *
3214 * This method is used to retarget a flagged mixin so that its functionality applies to the specified element.
3215 * If an element is already set, the method will remove the mixin’s effect on that element.
3216 *
3217 * @param {jQuery} $flagged Element that should be flagged
3218 */
3219 OO.ui.mixin.FlaggedElement.prototype.setFlaggedElement = function ( $flagged ) {
3220 var classNames = Object.keys( this.flags ).map( function ( flag ) {
3221 return 'oo-ui-flaggedElement-' + flag;
3222 } ).join( ' ' );
3223
3224 if ( this.$flagged ) {
3225 this.$flagged.removeClass( classNames );
3226 }
3227
3228 this.$flagged = $flagged.addClass( classNames );
3229 };
3230
3231 /**
3232 * Check if the specified flag is set.
3233 *
3234 * @param {string} flag Name of flag
3235 * @return {boolean} The flag is set
3236 */
3237 OO.ui.mixin.FlaggedElement.prototype.hasFlag = function ( flag ) {
3238 // This may be called before the constructor, thus before this.flags is set
3239 return this.flags && ( flag in this.flags );
3240 };
3241
3242 /**
3243 * Get the names of all flags set.
3244 *
3245 * @return {string[]} Flag names
3246 */
3247 OO.ui.mixin.FlaggedElement.prototype.getFlags = function () {
3248 // This may be called before the constructor, thus before this.flags is set
3249 return Object.keys( this.flags || {} );
3250 };
3251
3252 /**
3253 * Clear all flags.
3254 *
3255 * @chainable
3256 * @fires flag
3257 */
3258 OO.ui.mixin.FlaggedElement.prototype.clearFlags = function () {
3259 var flag, className,
3260 changes = {},
3261 remove = [],
3262 classPrefix = 'oo-ui-flaggedElement-';
3263
3264 for ( flag in this.flags ) {
3265 className = classPrefix + flag;
3266 changes[ flag ] = false;
3267 delete this.flags[ flag ];
3268 remove.push( className );
3269 }
3270
3271 if ( this.$flagged ) {
3272 this.$flagged.removeClass( remove.join( ' ' ) );
3273 }
3274
3275 this.updateThemeClasses();
3276 this.emit( 'flag', changes );
3277
3278 return this;
3279 };
3280
3281 /**
3282 * Add one or more flags.
3283 *
3284 * @param {string|string[]|Object.<string, boolean>} flags A flag name, an array of flag names,
3285 * or an object keyed by flag name with a boolean value that indicates whether the flag should
3286 * be added (`true`) or removed (`false`).
3287 * @chainable
3288 * @fires flag
3289 */
3290 OO.ui.mixin.FlaggedElement.prototype.setFlags = function ( flags ) {
3291 var i, len, flag, className,
3292 changes = {},
3293 add = [],
3294 remove = [],
3295 classPrefix = 'oo-ui-flaggedElement-';
3296
3297 if ( typeof flags === 'string' ) {
3298 className = classPrefix + flags;
3299 // Set
3300 if ( !this.flags[ flags ] ) {
3301 this.flags[ flags ] = true;
3302 add.push( className );
3303 }
3304 } else if ( Array.isArray( flags ) ) {
3305 for ( i = 0, len = flags.length; i < len; i++ ) {
3306 flag = flags[ i ];
3307 className = classPrefix + flag;
3308 // Set
3309 if ( !this.flags[ flag ] ) {
3310 changes[ flag ] = true;
3311 this.flags[ flag ] = true;
3312 add.push( className );
3313 }
3314 }
3315 } else if ( OO.isPlainObject( flags ) ) {
3316 for ( flag in flags ) {
3317 className = classPrefix + flag;
3318 if ( flags[ flag ] ) {
3319 // Set
3320 if ( !this.flags[ flag ] ) {
3321 changes[ flag ] = true;
3322 this.flags[ flag ] = true;
3323 add.push( className );
3324 }
3325 } else {
3326 // Remove
3327 if ( this.flags[ flag ] ) {
3328 changes[ flag ] = false;
3329 delete this.flags[ flag ];
3330 remove.push( className );
3331 }
3332 }
3333 }
3334 }
3335
3336 if ( this.$flagged ) {
3337 this.$flagged
3338 .addClass( add.join( ' ' ) )
3339 .removeClass( remove.join( ' ' ) );
3340 }
3341
3342 this.updateThemeClasses();
3343 this.emit( 'flag', changes );
3344
3345 return this;
3346 };
3347
3348 /**
3349 * TitledElement is mixed into other classes to provide a `title` attribute.
3350 * Titles are rendered by the browser and are made visible when the user moves
3351 * the mouse over the element. Titles are not visible on touch devices.
3352 *
3353 * @example
3354 * // TitledElement provides a 'title' attribute to the
3355 * // ButtonWidget class
3356 * var button = new OO.ui.ButtonWidget( {
3357 * label: 'Button with Title',
3358 * title: 'I am a button'
3359 * } );
3360 * $( 'body' ).append( button.$element );
3361 *
3362 * @abstract
3363 * @class
3364 *
3365 * @constructor
3366 * @param {Object} [config] Configuration options
3367 * @cfg {jQuery} [$titled] The element to which the `title` attribute is applied.
3368 * If this config is omitted, the title functionality is applied to $element, the
3369 * element created by the class.
3370 * @cfg {string|Function} [title] The title text or a function that returns text. If
3371 * this config is omitted, the value of the {@link #static-title static title} property is used.
3372 */
3373 OO.ui.mixin.TitledElement = function OoUiMixinTitledElement( config ) {
3374 // Configuration initialization
3375 config = config || {};
3376
3377 // Properties
3378 this.$titled = null;
3379 this.title = null;
3380
3381 // Initialization
3382 this.setTitle( config.title !== undefined ? config.title : this.constructor.static.title );
3383 this.setTitledElement( config.$titled || this.$element );
3384 };
3385
3386 /* Setup */
3387
3388 OO.initClass( OO.ui.mixin.TitledElement );
3389
3390 /* Static Properties */
3391
3392 /**
3393 * The title text, a function that returns text, or `null` for no title. The value of the static property
3394 * is overridden if the #title config option is used.
3395 *
3396 * @static
3397 * @inheritable
3398 * @property {string|Function|null}
3399 */
3400 OO.ui.mixin.TitledElement.static.title = null;
3401
3402 /* Methods */
3403
3404 /**
3405 * Set the titled element.
3406 *
3407 * This method is used to retarget a titledElement mixin so that its functionality applies to the specified element.
3408 * If an element is already set, the mixin’s effect on that element is removed before the new element is set up.
3409 *
3410 * @param {jQuery} $titled Element that should use the 'titled' functionality
3411 */
3412 OO.ui.mixin.TitledElement.prototype.setTitledElement = function ( $titled ) {
3413 if ( this.$titled ) {
3414 this.$titled.removeAttr( 'title' );
3415 }
3416
3417 this.$titled = $titled;
3418 if ( this.title ) {
3419 this.updateTitle();
3420 }
3421 };
3422
3423 /**
3424 * Set title.
3425 *
3426 * @param {string|Function|null} title Title text, a function that returns text, or `null` for no title
3427 * @chainable
3428 */
3429 OO.ui.mixin.TitledElement.prototype.setTitle = function ( title ) {
3430 title = typeof title === 'function' ? OO.ui.resolveMsg( title ) : title;
3431 title = ( typeof title === 'string' && title.length ) ? title : null;
3432
3433 if ( this.title !== title ) {
3434 this.title = title;
3435 this.updateTitle();
3436 }
3437
3438 return this;
3439 };
3440
3441 /**
3442 * Update the title attribute, in case of changes to title or accessKey.
3443 *
3444 * @protected
3445 * @chainable
3446 */
3447 OO.ui.mixin.TitledElement.prototype.updateTitle = function () {
3448 var title = this.getTitle();
3449 if ( this.$titled ) {
3450 if ( title !== null ) {
3451 // Only if this is an AccessKeyedElement
3452 if ( this.formatTitleWithAccessKey ) {
3453 title = this.formatTitleWithAccessKey( title );
3454 }
3455 this.$titled.attr( 'title', title );
3456 } else {
3457 this.$titled.removeAttr( 'title' );
3458 }
3459 }
3460 return this;
3461 };
3462
3463 /**
3464 * Get title.
3465 *
3466 * @return {string} Title string
3467 */
3468 OO.ui.mixin.TitledElement.prototype.getTitle = function () {
3469 return this.title;
3470 };
3471
3472 /**
3473 * AccessKeyedElement is mixed into other classes to provide an `accesskey` attribute.
3474 * Accesskeys allow an user to go to a specific element by using
3475 * a shortcut combination of a browser specific keys + the key
3476 * set to the field.
3477 *
3478 * @example
3479 * // AccessKeyedElement provides an 'accesskey' attribute to the
3480 * // ButtonWidget class
3481 * var button = new OO.ui.ButtonWidget( {
3482 * label: 'Button with Accesskey',
3483 * accessKey: 'k'
3484 * } );
3485 * $( 'body' ).append( button.$element );
3486 *
3487 * @abstract
3488 * @class
3489 *
3490 * @constructor
3491 * @param {Object} [config] Configuration options
3492 * @cfg {jQuery} [$accessKeyed] The element to which the `accesskey` attribute is applied.
3493 * If this config is omitted, the accesskey functionality is applied to $element, the
3494 * element created by the class.
3495 * @cfg {string|Function} [accessKey] The key or a function that returns the key. If
3496 * this config is omitted, no accesskey will be added.
3497 */
3498 OO.ui.mixin.AccessKeyedElement = function OoUiMixinAccessKeyedElement( config ) {
3499 // Configuration initialization
3500 config = config || {};
3501
3502 // Properties
3503 this.$accessKeyed = null;
3504 this.accessKey = null;
3505
3506 // Initialization
3507 this.setAccessKey( config.accessKey || null );
3508 this.setAccessKeyedElement( config.$accessKeyed || this.$element );
3509
3510 // If this is also a TitledElement and it initialized before we did, we may have
3511 // to update the title with the access key
3512 if ( this.updateTitle ) {
3513 this.updateTitle();
3514 }
3515 };
3516
3517 /* Setup */
3518
3519 OO.initClass( OO.ui.mixin.AccessKeyedElement );
3520
3521 /* Static Properties */
3522
3523 /**
3524 * The access key, a function that returns a key, or `null` for no accesskey.
3525 *
3526 * @static
3527 * @inheritable
3528 * @property {string|Function|null}
3529 */
3530 OO.ui.mixin.AccessKeyedElement.static.accessKey = null;
3531
3532 /* Methods */
3533
3534 /**
3535 * Set the accesskeyed element.
3536 *
3537 * This method is used to retarget a AccessKeyedElement mixin so that its functionality applies to the specified element.
3538 * If an element is already set, the mixin's effect on that element is removed before the new element is set up.
3539 *
3540 * @param {jQuery} $accessKeyed Element that should use the 'accesskeyes' functionality
3541 */
3542 OO.ui.mixin.AccessKeyedElement.prototype.setAccessKeyedElement = function ( $accessKeyed ) {
3543 if ( this.$accessKeyed ) {
3544 this.$accessKeyed.removeAttr( 'accesskey' );
3545 }
3546
3547 this.$accessKeyed = $accessKeyed;
3548 if ( this.accessKey ) {
3549 this.$accessKeyed.attr( 'accesskey', this.accessKey );
3550 }
3551 };
3552
3553 /**
3554 * Set accesskey.
3555 *
3556 * @param {string|Function|null} accessKey Key, a function that returns a key, or `null` for no accesskey
3557 * @chainable
3558 */
3559 OO.ui.mixin.AccessKeyedElement.prototype.setAccessKey = function ( accessKey ) {
3560 accessKey = typeof accessKey === 'string' ? OO.ui.resolveMsg( accessKey ) : null;
3561
3562 if ( this.accessKey !== accessKey ) {
3563 if ( this.$accessKeyed ) {
3564 if ( accessKey !== null ) {
3565 this.$accessKeyed.attr( 'accesskey', accessKey );
3566 } else {
3567 this.$accessKeyed.removeAttr( 'accesskey' );
3568 }
3569 }
3570 this.accessKey = accessKey;
3571
3572 // Only if this is a TitledElement
3573 if ( this.updateTitle ) {
3574 this.updateTitle();
3575 }
3576 }
3577
3578 return this;
3579 };
3580
3581 /**
3582 * Get accesskey.
3583 *
3584 * @return {string} accessKey string
3585 */
3586 OO.ui.mixin.AccessKeyedElement.prototype.getAccessKey = function () {
3587 return this.accessKey;
3588 };
3589
3590 /**
3591 * Add information about the access key to the element's tooltip label.
3592 * (This is only public for hacky usage in FieldLayout.)
3593 *
3594 * @param {string} title Tooltip label for `title` attribute
3595 * @return {string}
3596 */
3597 OO.ui.mixin.AccessKeyedElement.prototype.formatTitleWithAccessKey = function ( title ) {
3598 var accessKey;
3599
3600 if ( !this.$accessKeyed ) {
3601 // Not initialized yet; the constructor will call updateTitle() which will rerun this function
3602 return title;
3603 }
3604 // Use jquery.accessKeyLabel if available to show modifiers, otherwise just display the single key
3605 if ( $.fn.updateTooltipAccessKeys && $.fn.updateTooltipAccessKeys.getAccessKeyLabel ) {
3606 accessKey = $.fn.updateTooltipAccessKeys.getAccessKeyLabel( this.$accessKeyed[ 0 ] );
3607 } else {
3608 accessKey = this.getAccessKey();
3609 }
3610 if ( accessKey ) {
3611 title += ' [' + accessKey + ']';
3612 }
3613 return title;
3614 };
3615
3616 /**
3617 * ButtonWidget is a generic widget for buttons. A wide variety of looks,
3618 * feels, and functionality can be customized via the class’s configuration options
3619 * and methods. Please see the [OOUI documentation on MediaWiki] [1] for more information
3620 * and examples.
3621 *
3622 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Buttons_and_Switches
3623 *
3624 * @example
3625 * // A button widget
3626 * var button = new OO.ui.ButtonWidget( {
3627 * label: 'Button with Icon',
3628 * icon: 'trash',
3629 * iconTitle: 'Remove'
3630 * } );
3631 * $( 'body' ).append( button.$element );
3632 *
3633 * NOTE: HTML form buttons should use the OO.ui.ButtonInputWidget class.
3634 *
3635 * @class
3636 * @extends OO.ui.Widget
3637 * @mixins OO.ui.mixin.ButtonElement
3638 * @mixins OO.ui.mixin.IconElement
3639 * @mixins OO.ui.mixin.IndicatorElement
3640 * @mixins OO.ui.mixin.LabelElement
3641 * @mixins OO.ui.mixin.TitledElement
3642 * @mixins OO.ui.mixin.FlaggedElement
3643 * @mixins OO.ui.mixin.TabIndexedElement
3644 * @mixins OO.ui.mixin.AccessKeyedElement
3645 *
3646 * @constructor
3647 * @param {Object} [config] Configuration options
3648 * @cfg {boolean} [active=false] Whether button should be shown as active
3649 * @cfg {string} [href] Hyperlink to visit when the button is clicked.
3650 * @cfg {string} [target] The frame or window in which to open the hyperlink.
3651 * @cfg {boolean} [noFollow] Search engine traversal hint (default: true)
3652 */
3653 OO.ui.ButtonWidget = function OoUiButtonWidget( config ) {
3654 // Configuration initialization
3655 config = config || {};
3656
3657 // Parent constructor
3658 OO.ui.ButtonWidget.parent.call( this, config );
3659
3660 // Mixin constructors
3661 OO.ui.mixin.ButtonElement.call( this, config );
3662 OO.ui.mixin.IconElement.call( this, config );
3663 OO.ui.mixin.IndicatorElement.call( this, config );
3664 OO.ui.mixin.LabelElement.call( this, config );
3665 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$button } ) );
3666 OO.ui.mixin.FlaggedElement.call( this, config );
3667 OO.ui.mixin.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$button } ) );
3668 OO.ui.mixin.AccessKeyedElement.call( this, $.extend( {}, config, { $accessKeyed: this.$button } ) );
3669
3670 // Properties
3671 this.href = null;
3672 this.target = null;
3673 this.noFollow = false;
3674
3675 // Events
3676 this.connect( this, { disable: 'onDisable' } );
3677
3678 // Initialization
3679 this.$button.append( this.$icon, this.$label, this.$indicator );
3680 this.$element
3681 .addClass( 'oo-ui-buttonWidget' )
3682 .append( this.$button );
3683 this.setActive( config.active );
3684 this.setHref( config.href );
3685 this.setTarget( config.target );
3686 this.setNoFollow( config.noFollow );
3687 };
3688
3689 /* Setup */
3690
3691 OO.inheritClass( OO.ui.ButtonWidget, OO.ui.Widget );
3692 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.ButtonElement );
3693 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.IconElement );
3694 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.IndicatorElement );
3695 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.LabelElement );
3696 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.TitledElement );
3697 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.FlaggedElement );
3698 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.TabIndexedElement );
3699 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.mixin.AccessKeyedElement );
3700
3701 /* Static Properties */
3702
3703 /**
3704 * @static
3705 * @inheritdoc
3706 */
3707 OO.ui.ButtonWidget.static.cancelButtonMouseDownEvents = false;
3708
3709 /**
3710 * @static
3711 * @inheritdoc
3712 */
3713 OO.ui.ButtonWidget.static.tagName = 'span';
3714
3715 /* Methods */
3716
3717 /**
3718 * Get hyperlink location.
3719 *
3720 * @return {string} Hyperlink location
3721 */
3722 OO.ui.ButtonWidget.prototype.getHref = function () {
3723 return this.href;
3724 };
3725
3726 /**
3727 * Get hyperlink target.
3728 *
3729 * @return {string} Hyperlink target
3730 */
3731 OO.ui.ButtonWidget.prototype.getTarget = function () {
3732 return this.target;
3733 };
3734
3735 /**
3736 * Get search engine traversal hint.
3737 *
3738 * @return {boolean} Whether search engines should avoid traversing this hyperlink
3739 */
3740 OO.ui.ButtonWidget.prototype.getNoFollow = function () {
3741 return this.noFollow;
3742 };
3743
3744 /**
3745 * Set hyperlink location.
3746 *
3747 * @param {string|null} href Hyperlink location, null to remove
3748 */
3749 OO.ui.ButtonWidget.prototype.setHref = function ( href ) {
3750 href = typeof href === 'string' ? href : null;
3751 if ( href !== null && !OO.ui.isSafeUrl( href ) ) {
3752 href = './' + href;
3753 }
3754
3755 if ( href !== this.href ) {
3756 this.href = href;
3757 this.updateHref();
3758 }
3759
3760 return this;
3761 };
3762
3763 /**
3764 * Update the `href` attribute, in case of changes to href or
3765 * disabled state.
3766 *
3767 * @private
3768 * @chainable
3769 */
3770 OO.ui.ButtonWidget.prototype.updateHref = function () {
3771 if ( this.href !== null && !this.isDisabled() ) {
3772 this.$button.attr( 'href', this.href );
3773 } else {
3774 this.$button.removeAttr( 'href' );
3775 }
3776
3777 return this;
3778 };
3779
3780 /**
3781 * Handle disable events.
3782 *
3783 * @private
3784 * @param {boolean} disabled Element is disabled
3785 */
3786 OO.ui.ButtonWidget.prototype.onDisable = function () {
3787 this.updateHref();
3788 };
3789
3790 /**
3791 * Set hyperlink target.
3792 *
3793 * @param {string|null} target Hyperlink target, null to remove
3794 */
3795 OO.ui.ButtonWidget.prototype.setTarget = function ( target ) {
3796 target = typeof target === 'string' ? target : null;
3797
3798 if ( target !== this.target ) {
3799 this.target = target;
3800 if ( target !== null ) {
3801 this.$button.attr( 'target', target );
3802 } else {
3803 this.$button.removeAttr( 'target' );
3804 }
3805 }
3806
3807 return this;
3808 };
3809
3810 /**
3811 * Set search engine traversal hint.
3812 *
3813 * @param {boolean} noFollow True if search engines should avoid traversing this hyperlink
3814 */
3815 OO.ui.ButtonWidget.prototype.setNoFollow = function ( noFollow ) {
3816 noFollow = typeof noFollow === 'boolean' ? noFollow : true;
3817
3818 if ( noFollow !== this.noFollow ) {
3819 this.noFollow = noFollow;
3820 if ( noFollow ) {
3821 this.$button.attr( 'rel', 'nofollow' );
3822 } else {
3823 this.$button.removeAttr( 'rel' );
3824 }
3825 }
3826
3827 return this;
3828 };
3829
3830 // Override method visibility hints from ButtonElement
3831 /**
3832 * @method setActive
3833 * @inheritdoc
3834 */
3835 /**
3836 * @method isActive
3837 * @inheritdoc
3838 */
3839
3840 /**
3841 * A ButtonGroupWidget groups related buttons and is used together with OO.ui.ButtonWidget and
3842 * its subclasses. Each button in a group is addressed by a unique reference. Buttons can be added,
3843 * removed, and cleared from the group.
3844 *
3845 * @example
3846 * // Example: A ButtonGroupWidget with two buttons
3847 * var button1 = new OO.ui.PopupButtonWidget( {
3848 * label: 'Select a category',
3849 * icon: 'menu',
3850 * popup: {
3851 * $content: $( '<p>List of categories...</p>' ),
3852 * padded: true,
3853 * align: 'left'
3854 * }
3855 * } );
3856 * var button2 = new OO.ui.ButtonWidget( {
3857 * label: 'Add item'
3858 * });
3859 * var buttonGroup = new OO.ui.ButtonGroupWidget( {
3860 * items: [button1, button2]
3861 * } );
3862 * $( 'body' ).append( buttonGroup.$element );
3863 *
3864 * @class
3865 * @extends OO.ui.Widget
3866 * @mixins OO.ui.mixin.GroupElement
3867 *
3868 * @constructor
3869 * @param {Object} [config] Configuration options
3870 * @cfg {OO.ui.ButtonWidget[]} [items] Buttons to add
3871 */
3872 OO.ui.ButtonGroupWidget = function OoUiButtonGroupWidget( config ) {
3873 // Configuration initialization
3874 config = config || {};
3875
3876 // Parent constructor
3877 OO.ui.ButtonGroupWidget.parent.call( this, config );
3878
3879 // Mixin constructors
3880 OO.ui.mixin.GroupElement.call( this, $.extend( {}, config, { $group: this.$element } ) );
3881
3882 // Initialization
3883 this.$element.addClass( 'oo-ui-buttonGroupWidget' );
3884 if ( Array.isArray( config.items ) ) {
3885 this.addItems( config.items );
3886 }
3887 };
3888
3889 /* Setup */
3890
3891 OO.inheritClass( OO.ui.ButtonGroupWidget, OO.ui.Widget );
3892 OO.mixinClass( OO.ui.ButtonGroupWidget, OO.ui.mixin.GroupElement );
3893
3894 /* Static Properties */
3895
3896 /**
3897 * @static
3898 * @inheritdoc
3899 */
3900 OO.ui.ButtonGroupWidget.static.tagName = 'span';
3901
3902 /* Methods */
3903
3904 /**
3905 * Focus the widget
3906 *
3907 * @chainable
3908 */
3909 OO.ui.ButtonGroupWidget.prototype.focus = function () {
3910 if ( !this.isDisabled() ) {
3911 if ( this.items[ 0 ] ) {
3912 this.items[ 0 ].focus();
3913 }
3914 }
3915 return this;
3916 };
3917
3918 /**
3919 * @inheritdoc
3920 */
3921 OO.ui.ButtonGroupWidget.prototype.simulateLabelClick = function () {
3922 this.focus();
3923 };
3924
3925 /**
3926 * IconWidget is a generic widget for {@link OO.ui.mixin.IconElement icons}. In general, IconWidgets should be used with OO.ui.LabelWidget,
3927 * which creates a label that identifies the icon’s function. See the [OOUI documentation on MediaWiki] [1]
3928 * for a list of icons included in the library.
3929 *
3930 * @example
3931 * // An icon widget with a label
3932 * var myIcon = new OO.ui.IconWidget( {
3933 * icon: 'help',
3934 * iconTitle: 'Help'
3935 * } );
3936 * // Create a label.
3937 * var iconLabel = new OO.ui.LabelWidget( {
3938 * label: 'Help'
3939 * } );
3940 * $( 'body' ).append( myIcon.$element, iconLabel.$element );
3941 *
3942 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Icons
3943 *
3944 * @class
3945 * @extends OO.ui.Widget
3946 * @mixins OO.ui.mixin.IconElement
3947 * @mixins OO.ui.mixin.TitledElement
3948 * @mixins OO.ui.mixin.FlaggedElement
3949 *
3950 * @constructor
3951 * @param {Object} [config] Configuration options
3952 */
3953 OO.ui.IconWidget = function OoUiIconWidget( config ) {
3954 // Configuration initialization
3955 config = config || {};
3956
3957 // Parent constructor
3958 OO.ui.IconWidget.parent.call( this, config );
3959
3960 // Mixin constructors
3961 OO.ui.mixin.IconElement.call( this, $.extend( {}, config, { $icon: this.$element } ) );
3962 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$element } ) );
3963 OO.ui.mixin.FlaggedElement.call( this, $.extend( {}, config, { $flagged: this.$element } ) );
3964
3965 // Initialization
3966 this.$element.addClass( 'oo-ui-iconWidget' );
3967 };
3968
3969 /* Setup */
3970
3971 OO.inheritClass( OO.ui.IconWidget, OO.ui.Widget );
3972 OO.mixinClass( OO.ui.IconWidget, OO.ui.mixin.IconElement );
3973 OO.mixinClass( OO.ui.IconWidget, OO.ui.mixin.TitledElement );
3974 OO.mixinClass( OO.ui.IconWidget, OO.ui.mixin.FlaggedElement );
3975
3976 /* Static Properties */
3977
3978 /**
3979 * @static
3980 * @inheritdoc
3981 */
3982 OO.ui.IconWidget.static.tagName = 'span';
3983
3984 /**
3985 * IndicatorWidgets create indicators, which are small graphics that are generally used to draw
3986 * attention to the status of an item or to clarify the function of a control. For a list of
3987 * indicators included in the library, please see the [OOUI documentation on MediaWiki][1].
3988 *
3989 * @example
3990 * // Example of an indicator widget
3991 * var indicator1 = new OO.ui.IndicatorWidget( {
3992 * indicator: 'alert'
3993 * } );
3994 *
3995 * // Create a fieldset layout to add a label
3996 * var fieldset = new OO.ui.FieldsetLayout();
3997 * fieldset.addItems( [
3998 * new OO.ui.FieldLayout( indicator1, { label: 'An alert indicator:' } )
3999 * ] );
4000 * $( 'body' ).append( fieldset.$element );
4001 *
4002 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Icons,_Indicators,_and_Labels#Indicators
4003 *
4004 * @class
4005 * @extends OO.ui.Widget
4006 * @mixins OO.ui.mixin.IndicatorElement
4007 * @mixins OO.ui.mixin.TitledElement
4008 *
4009 * @constructor
4010 * @param {Object} [config] Configuration options
4011 */
4012 OO.ui.IndicatorWidget = function OoUiIndicatorWidget( config ) {
4013 // Configuration initialization
4014 config = config || {};
4015
4016 // Parent constructor
4017 OO.ui.IndicatorWidget.parent.call( this, config );
4018
4019 // Mixin constructors
4020 OO.ui.mixin.IndicatorElement.call( this, $.extend( {}, config, { $indicator: this.$element } ) );
4021 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$element } ) );
4022
4023 // Initialization
4024 this.$element.addClass( 'oo-ui-indicatorWidget' );
4025 };
4026
4027 /* Setup */
4028
4029 OO.inheritClass( OO.ui.IndicatorWidget, OO.ui.Widget );
4030 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.mixin.IndicatorElement );
4031 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.mixin.TitledElement );
4032
4033 /* Static Properties */
4034
4035 /**
4036 * @static
4037 * @inheritdoc
4038 */
4039 OO.ui.IndicatorWidget.static.tagName = 'span';
4040
4041 /**
4042 * LabelWidgets help identify the function of interface elements. Each LabelWidget can
4043 * be configured with a `label` option that is set to a string, a label node, or a function:
4044 *
4045 * - String: a plaintext string
4046 * - jQuery selection: a jQuery selection, used for anything other than a plaintext label, e.g., a
4047 * label that includes a link or special styling, such as a gray color or additional graphical elements.
4048 * - Function: a function that will produce a string in the future. Functions are used
4049 * in cases where the value of the label is not currently defined.
4050 *
4051 * In addition, the LabelWidget can be associated with an {@link OO.ui.InputWidget input widget}, which
4052 * will come into focus when the label is clicked.
4053 *
4054 * @example
4055 * // Examples of LabelWidgets
4056 * var label1 = new OO.ui.LabelWidget( {
4057 * label: 'plaintext label'
4058 * } );
4059 * var label2 = new OO.ui.LabelWidget( {
4060 * label: $( '<a href="default.html">jQuery label</a>' )
4061 * } );
4062 * // Create a fieldset layout with fields for each example
4063 * var fieldset = new OO.ui.FieldsetLayout();
4064 * fieldset.addItems( [
4065 * new OO.ui.FieldLayout( label1 ),
4066 * new OO.ui.FieldLayout( label2 )
4067 * ] );
4068 * $( 'body' ).append( fieldset.$element );
4069 *
4070 * @class
4071 * @extends OO.ui.Widget
4072 * @mixins OO.ui.mixin.LabelElement
4073 * @mixins OO.ui.mixin.TitledElement
4074 *
4075 * @constructor
4076 * @param {Object} [config] Configuration options
4077 * @cfg {OO.ui.InputWidget} [input] {@link OO.ui.InputWidget Input widget} that uses the label.
4078 * Clicking the label will focus the specified input field.
4079 */
4080 OO.ui.LabelWidget = function OoUiLabelWidget( config ) {
4081 // Configuration initialization
4082 config = config || {};
4083
4084 // Parent constructor
4085 OO.ui.LabelWidget.parent.call( this, config );
4086
4087 // Mixin constructors
4088 OO.ui.mixin.LabelElement.call( this, $.extend( {}, config, { $label: this.$element } ) );
4089 OO.ui.mixin.TitledElement.call( this, config );
4090
4091 // Properties
4092 this.input = config.input;
4093
4094 // Initialization
4095 if ( this.input ) {
4096 if ( this.input.getInputId() ) {
4097 this.$element.attr( 'for', this.input.getInputId() );
4098 } else {
4099 this.$label.on( 'click', function () {
4100 this.input.simulateLabelClick();
4101 }.bind( this ) );
4102 }
4103 }
4104 this.$element.addClass( 'oo-ui-labelWidget' );
4105 };
4106
4107 /* Setup */
4108
4109 OO.inheritClass( OO.ui.LabelWidget, OO.ui.Widget );
4110 OO.mixinClass( OO.ui.LabelWidget, OO.ui.mixin.LabelElement );
4111 OO.mixinClass( OO.ui.LabelWidget, OO.ui.mixin.TitledElement );
4112
4113 /* Static Properties */
4114
4115 /**
4116 * @static
4117 * @inheritdoc
4118 */
4119 OO.ui.LabelWidget.static.tagName = 'label';
4120
4121 /**
4122 * PendingElement is a mixin that is used to create elements that notify users that something is happening
4123 * and that they should wait before proceeding. The pending state is visually represented with a pending
4124 * texture that appears in the head of a pending {@link OO.ui.ProcessDialog process dialog} or in the input
4125 * field of a {@link OO.ui.TextInputWidget text input widget}.
4126 *
4127 * Currently, {@link OO.ui.ActionWidget Action widgets}, which mix in this class, can also be marked as pending, but only when
4128 * used in {@link OO.ui.MessageDialog message dialogs}. The behavior is not currently supported for action widgets used
4129 * in process dialogs.
4130 *
4131 * @example
4132 * function MessageDialog( config ) {
4133 * MessageDialog.parent.call( this, config );
4134 * }
4135 * OO.inheritClass( MessageDialog, OO.ui.MessageDialog );
4136 *
4137 * MessageDialog.static.name = 'myMessageDialog';
4138 * MessageDialog.static.actions = [
4139 * { action: 'save', label: 'Done', flags: 'primary' },
4140 * { label: 'Cancel', flags: 'safe' }
4141 * ];
4142 *
4143 * MessageDialog.prototype.initialize = function () {
4144 * MessageDialog.parent.prototype.initialize.apply( this, arguments );
4145 * this.content = new OO.ui.PanelLayout( { $: this.$, padded: true } );
4146 * this.content.$element.append( '<p>Click the \'Done\' action widget to see its pending state. Note that action widgets can be marked pending in message dialogs but not process dialogs.</p>' );
4147 * this.$body.append( this.content.$element );
4148 * };
4149 * MessageDialog.prototype.getBodyHeight = function () {
4150 * return 100;
4151 * }
4152 * MessageDialog.prototype.getActionProcess = function ( action ) {
4153 * var dialog = this;
4154 * if ( action === 'save' ) {
4155 * dialog.getActions().get({actions: 'save'})[0].pushPending();
4156 * return new OO.ui.Process()
4157 * .next( 1000 )
4158 * .next( function () {
4159 * dialog.getActions().get({actions: 'save'})[0].popPending();
4160 * } );
4161 * }
4162 * return MessageDialog.parent.prototype.getActionProcess.call( this, action );
4163 * };
4164 *
4165 * var windowManager = new OO.ui.WindowManager();
4166 * $( 'body' ).append( windowManager.$element );
4167 *
4168 * var dialog = new MessageDialog();
4169 * windowManager.addWindows( [ dialog ] );
4170 * windowManager.openWindow( dialog );
4171 *
4172 * @abstract
4173 * @class
4174 *
4175 * @constructor
4176 * @param {Object} [config] Configuration options
4177 * @cfg {jQuery} [$pending] Element to mark as pending, defaults to this.$element
4178 */
4179 OO.ui.mixin.PendingElement = function OoUiMixinPendingElement( config ) {
4180 // Configuration initialization
4181 config = config || {};
4182
4183 // Properties
4184 this.pending = 0;
4185 this.$pending = null;
4186
4187 // Initialisation
4188 this.setPendingElement( config.$pending || this.$element );
4189 };
4190
4191 /* Setup */
4192
4193 OO.initClass( OO.ui.mixin.PendingElement );
4194
4195 /* Methods */
4196
4197 /**
4198 * Set the pending element (and clean up any existing one).
4199 *
4200 * @param {jQuery} $pending The element to set to pending.
4201 */
4202 OO.ui.mixin.PendingElement.prototype.setPendingElement = function ( $pending ) {
4203 if ( this.$pending ) {
4204 this.$pending.removeClass( 'oo-ui-pendingElement-pending' );
4205 }
4206
4207 this.$pending = $pending;
4208 if ( this.pending > 0 ) {
4209 this.$pending.addClass( 'oo-ui-pendingElement-pending' );
4210 }
4211 };
4212
4213 /**
4214 * Check if an element is pending.
4215 *
4216 * @return {boolean} Element is pending
4217 */
4218 OO.ui.mixin.PendingElement.prototype.isPending = function () {
4219 return !!this.pending;
4220 };
4221
4222 /**
4223 * Increase the pending counter. The pending state will remain active until the counter is zero
4224 * (i.e., the number of calls to #pushPending and #popPending is the same).
4225 *
4226 * @chainable
4227 */
4228 OO.ui.mixin.PendingElement.prototype.pushPending = function () {
4229 if ( this.pending === 0 ) {
4230 this.$pending.addClass( 'oo-ui-pendingElement-pending' );
4231 this.updateThemeClasses();
4232 }
4233 this.pending++;
4234
4235 return this;
4236 };
4237
4238 /**
4239 * Decrease the pending counter. The pending state will remain active until the counter is zero
4240 * (i.e., the number of calls to #pushPending and #popPending is the same).
4241 *
4242 * @chainable
4243 */
4244 OO.ui.mixin.PendingElement.prototype.popPending = function () {
4245 if ( this.pending === 1 ) {
4246 this.$pending.removeClass( 'oo-ui-pendingElement-pending' );
4247 this.updateThemeClasses();
4248 }
4249 this.pending = Math.max( 0, this.pending - 1 );
4250
4251 return this;
4252 };
4253
4254 /**
4255 * Element that will stick adjacent to a specified container, even when it is inserted elsewhere
4256 * in the document (for example, in an OO.ui.Window's $overlay).
4257 *
4258 * The elements's position is automatically calculated and maintained when window is resized or the
4259 * page is scrolled. If you reposition the container manually, you have to call #position to make
4260 * sure the element is still placed correctly.
4261 *
4262 * As positioning is only possible when both the element and the container are attached to the DOM
4263 * and visible, it's only done after you call #togglePositioning. You might want to do this inside
4264 * the #toggle method to display a floating popup, for example.
4265 *
4266 * @abstract
4267 * @class
4268 *
4269 * @constructor
4270 * @param {Object} [config] Configuration options
4271 * @cfg {jQuery} [$floatable] Node to position, assigned to #$floatable, omit to use #$element
4272 * @cfg {jQuery} [$floatableContainer] Node to position adjacent to
4273 * @cfg {string} [verticalPosition='below'] Where to position $floatable vertically:
4274 * 'below': Directly below $floatableContainer, aligning f's top edge with fC's bottom edge
4275 * 'above': Directly above $floatableContainer, aligning f's bottom edge with fC's top edge
4276 * 'top': Align the top edge with $floatableContainer's top edge
4277 * 'bottom': Align the bottom edge with $floatableContainer's bottom edge
4278 * 'center': Vertically align the center with $floatableContainer's center
4279 * @cfg {string} [horizontalPosition='start'] Where to position $floatable horizontally:
4280 * 'before': Directly before $floatableContainer, aligning f's end edge with fC's start edge
4281 * 'after': Directly after $floatableContainer, algining f's start edge with fC's end edge
4282 * 'start': Align the start (left in LTR, right in RTL) edge with $floatableContainer's start edge
4283 * 'end': Align the end (right in LTR, left in RTL) edge with $floatableContainer's end edge
4284 * 'center': Horizontally align the center with $floatableContainer's center
4285 * @cfg {boolean} [hideWhenOutOfView=true] Whether to hide the floatable element if the container
4286 * is out of view
4287 */
4288 OO.ui.mixin.FloatableElement = function OoUiMixinFloatableElement( config ) {
4289 // Configuration initialization
4290 config = config || {};
4291
4292 // Properties
4293 this.$floatable = null;
4294 this.$floatableContainer = null;
4295 this.$floatableWindow = null;
4296 this.$floatableClosestScrollable = null;
4297 this.floatableOutOfView = false;
4298 this.onFloatableScrollHandler = this.position.bind( this );
4299 this.onFloatableWindowResizeHandler = this.position.bind( this );
4300
4301 // Initialization
4302 this.setFloatableContainer( config.$floatableContainer );
4303 this.setFloatableElement( config.$floatable || this.$element );
4304 this.setVerticalPosition( config.verticalPosition || 'below' );
4305 this.setHorizontalPosition( config.horizontalPosition || 'start' );
4306 this.hideWhenOutOfView = config.hideWhenOutOfView === undefined ? true : !!config.hideWhenOutOfView;
4307 };
4308
4309 /* Methods */
4310
4311 /**
4312 * Set floatable element.
4313 *
4314 * If an element is already set, it will be cleaned up before setting up the new element.
4315 *
4316 * @param {jQuery} $floatable Element to make floatable
4317 */
4318 OO.ui.mixin.FloatableElement.prototype.setFloatableElement = function ( $floatable ) {
4319 if ( this.$floatable ) {
4320 this.$floatable.removeClass( 'oo-ui-floatableElement-floatable' );
4321 this.$floatable.css( { left: '', top: '' } );
4322 }
4323
4324 this.$floatable = $floatable.addClass( 'oo-ui-floatableElement-floatable' );
4325 this.position();
4326 };
4327
4328 /**
4329 * Set floatable container.
4330 *
4331 * The element will be positioned relative to the specified container.
4332 *
4333 * @param {jQuery|null} $floatableContainer Container to keep visible, or null to unset
4334 */
4335 OO.ui.mixin.FloatableElement.prototype.setFloatableContainer = function ( $floatableContainer ) {
4336 this.$floatableContainer = $floatableContainer;
4337 if ( this.$floatable ) {
4338 this.position();
4339 }
4340 };
4341
4342 /**
4343 * Change how the element is positioned vertically.
4344 *
4345 * @param {string} position 'below', 'above', 'top', 'bottom' or 'center'
4346 */
4347 OO.ui.mixin.FloatableElement.prototype.setVerticalPosition = function ( position ) {
4348 if ( [ 'below', 'above', 'top', 'bottom', 'center' ].indexOf( position ) === -1 ) {
4349 throw new Error( 'Invalid value for vertical position: ' + position );
4350 }
4351 if ( this.verticalPosition !== position ) {
4352 this.verticalPosition = position;
4353 if ( this.$floatable ) {
4354 this.position();
4355 }
4356 }
4357 };
4358
4359 /**
4360 * Change how the element is positioned horizontally.
4361 *
4362 * @param {string} position 'before', 'after', 'start', 'end' or 'center'
4363 */
4364 OO.ui.mixin.FloatableElement.prototype.setHorizontalPosition = function ( position ) {
4365 if ( [ 'before', 'after', 'start', 'end', 'center' ].indexOf( position ) === -1 ) {
4366 throw new Error( 'Invalid value for horizontal position: ' + position );
4367 }
4368 if ( this.horizontalPosition !== position ) {
4369 this.horizontalPosition = position;
4370 if ( this.$floatable ) {
4371 this.position();
4372 }
4373 }
4374 };
4375
4376 /**
4377 * Toggle positioning.
4378 *
4379 * Do not turn positioning on until after the element is attached to the DOM and visible.
4380 *
4381 * @param {boolean} [positioning] Enable positioning, omit to toggle
4382 * @chainable
4383 */
4384 OO.ui.mixin.FloatableElement.prototype.togglePositioning = function ( positioning ) {
4385 var closestScrollableOfContainer;
4386
4387 if ( !this.$floatable || !this.$floatableContainer ) {
4388 return this;
4389 }
4390
4391 positioning = positioning === undefined ? !this.positioning : !!positioning;
4392
4393 if ( positioning && !this.warnedUnattached && !this.isElementAttached() ) {
4394 OO.ui.warnDeprecation( 'FloatableElement#togglePositioning: Before calling this method, the element must be attached to the DOM.' );
4395 this.warnedUnattached = true;
4396 }
4397
4398 if ( this.positioning !== positioning ) {
4399 this.positioning = positioning;
4400
4401 this.needsCustomPosition =
4402 this.verticalPostion !== 'below' ||
4403 this.horizontalPosition !== 'start' ||
4404 !OO.ui.contains( this.$floatableContainer[ 0 ], this.$floatable[ 0 ] );
4405
4406 closestScrollableOfContainer = OO.ui.Element.static.getClosestScrollableContainer( this.$floatableContainer[ 0 ] );
4407 // If the scrollable is the root, we have to listen to scroll events
4408 // on the window because of browser inconsistencies.
4409 if ( $( closestScrollableOfContainer ).is( 'html, body' ) ) {
4410 closestScrollableOfContainer = OO.ui.Element.static.getWindow( closestScrollableOfContainer );
4411 }
4412
4413 if ( positioning ) {
4414 this.$floatableWindow = $( this.getElementWindow() );
4415 this.$floatableWindow.on( 'resize', this.onFloatableWindowResizeHandler );
4416
4417 this.$floatableClosestScrollable = $( closestScrollableOfContainer );
4418 this.$floatableClosestScrollable.on( 'scroll', this.onFloatableScrollHandler );
4419
4420 // Initial position after visible
4421 this.position();
4422 } else {
4423 if ( this.$floatableWindow ) {
4424 this.$floatableWindow.off( 'resize', this.onFloatableWindowResizeHandler );
4425 this.$floatableWindow = null;
4426 }
4427
4428 if ( this.$floatableClosestScrollable ) {
4429 this.$floatableClosestScrollable.off( 'scroll', this.onFloatableScrollHandler );
4430 this.$floatableClosestScrollable = null;
4431 }
4432
4433 this.$floatable.css( { left: '', right: '', top: '' } );
4434 }
4435 }
4436
4437 return this;
4438 };
4439
4440 /**
4441 * Check whether the bottom edge of the given element is within the viewport of the given container.
4442 *
4443 * @private
4444 * @param {jQuery} $element
4445 * @param {jQuery} $container
4446 * @return {boolean}
4447 */
4448 OO.ui.mixin.FloatableElement.prototype.isElementInViewport = function ( $element, $container ) {
4449 var elemRect, contRect, topEdgeInBounds, bottomEdgeInBounds, leftEdgeInBounds, rightEdgeInBounds,
4450 startEdgeInBounds, endEdgeInBounds, viewportSpacing,
4451 direction = $element.css( 'direction' );
4452
4453 elemRect = $element[ 0 ].getBoundingClientRect();
4454 if ( $container[ 0 ] === window ) {
4455 viewportSpacing = OO.ui.getViewportSpacing();
4456 contRect = {
4457 top: 0,
4458 left: 0,
4459 right: document.documentElement.clientWidth,
4460 bottom: document.documentElement.clientHeight
4461 };
4462 contRect.top += viewportSpacing.top;
4463 contRect.left += viewportSpacing.left;
4464 contRect.right -= viewportSpacing.right;
4465 contRect.bottom -= viewportSpacing.bottom;
4466 } else {
4467 contRect = $container[ 0 ].getBoundingClientRect();
4468 }
4469
4470 topEdgeInBounds = elemRect.top >= contRect.top && elemRect.top <= contRect.bottom;
4471 bottomEdgeInBounds = elemRect.bottom >= contRect.top && elemRect.bottom <= contRect.bottom;
4472 leftEdgeInBounds = elemRect.left >= contRect.left && elemRect.left <= contRect.right;
4473 rightEdgeInBounds = elemRect.right >= contRect.left && elemRect.right <= contRect.right;
4474 if ( direction === 'rtl' ) {
4475 startEdgeInBounds = rightEdgeInBounds;
4476 endEdgeInBounds = leftEdgeInBounds;
4477 } else {
4478 startEdgeInBounds = leftEdgeInBounds;
4479 endEdgeInBounds = rightEdgeInBounds;
4480 }
4481
4482 if ( this.verticalPosition === 'below' && !bottomEdgeInBounds ) {
4483 return false;
4484 }
4485 if ( this.verticalPosition === 'above' && !topEdgeInBounds ) {
4486 return false;
4487 }
4488 if ( this.horizontalPosition === 'before' && !startEdgeInBounds ) {
4489 return false;
4490 }
4491 if ( this.horizontalPosition === 'after' && !endEdgeInBounds ) {
4492 return false;
4493 }
4494
4495 // The other positioning values are all about being inside the container,
4496 // so in those cases all we care about is that any part of the container is visible.
4497 return elemRect.top <= contRect.bottom && elemRect.bottom >= contRect.top &&
4498 elemRect.left <= contRect.right && elemRect.right >= contRect.left;
4499 };
4500
4501 /**
4502 * Check if the floatable is hidden to the user because it was offscreen.
4503 *
4504 * @return {boolean} Floatable is out of view
4505 */
4506 OO.ui.mixin.FloatableElement.prototype.isFloatableOutOfView = function () {
4507 return this.floatableOutOfView;
4508 };
4509
4510 /**
4511 * Position the floatable below its container.
4512 *
4513 * This should only be done when both of them are attached to the DOM and visible.
4514 *
4515 * @chainable
4516 */
4517 OO.ui.mixin.FloatableElement.prototype.position = function () {
4518 if ( !this.positioning ) {
4519 return this;
4520 }
4521
4522 if ( !(
4523 // To continue, some things need to be true:
4524 // The element must actually be in the DOM
4525 this.isElementAttached() && (
4526 // The closest scrollable is the current window
4527 this.$floatableClosestScrollable[ 0 ] === this.getElementWindow() ||
4528 // OR is an element in the element's DOM
4529 $.contains( this.getElementDocument(), this.$floatableClosestScrollable[ 0 ] )
4530 )
4531 ) ) {
4532 // Abort early if important parts of the widget are no longer attached to the DOM
4533 return this;
4534 }
4535
4536 this.floatableOutOfView = this.hideWhenOutOfView && !this.isElementInViewport( this.$floatableContainer, this.$floatableClosestScrollable );
4537 if ( this.floatableOutOfView ) {
4538 this.$floatable.addClass( 'oo-ui-element-hidden' );
4539 return this;
4540 } else {
4541 this.$floatable.removeClass( 'oo-ui-element-hidden' );
4542 }
4543
4544 if ( !this.needsCustomPosition ) {
4545 return this;
4546 }
4547
4548 this.$floatable.css( this.computePosition() );
4549
4550 // We updated the position, so re-evaluate the clipping state.
4551 // (ClippableElement does not listen to 'scroll' events on $floatableContainer's parent, and so
4552 // will not notice the need to update itself.)
4553 // TODO: This is terrible, we shouldn't need to know about ClippableElement at all here. Why does
4554 // it not listen to the right events in the right places?
4555 if ( this.clip ) {
4556 this.clip();
4557 }
4558
4559 return this;
4560 };
4561
4562 /**
4563 * Compute how #$floatable should be positioned based on the position of #$floatableContainer
4564 * and the positioning settings. This is a helper for #position that shouldn't be called directly,
4565 * but may be overridden by subclasses if they want to change or add to the positioning logic.
4566 *
4567 * @return {Object} New position to apply with .css(). Keys are 'top', 'left', 'bottom' and 'right'.
4568 */
4569 OO.ui.mixin.FloatableElement.prototype.computePosition = function () {
4570 var isBody, scrollableX, scrollableY, containerPos,
4571 horizScrollbarHeight, vertScrollbarWidth, scrollTop, scrollLeft,
4572 newPos = { top: '', left: '', bottom: '', right: '' },
4573 direction = this.$floatableContainer.css( 'direction' ),
4574 $offsetParent = this.$floatable.offsetParent();
4575
4576 if ( $offsetParent.is( 'html' ) ) {
4577 // The innerHeight/Width and clientHeight/Width calculations don't work well on the
4578 // <html> element, but they do work on the <body>
4579 $offsetParent = $( $offsetParent[ 0 ].ownerDocument.body );
4580 }
4581 isBody = $offsetParent.is( 'body' );
4582 scrollableX = $offsetParent.css( 'overflow-x' ) === 'scroll' || $offsetParent.css( 'overflow-x' ) === 'auto';
4583 scrollableY = $offsetParent.css( 'overflow-y' ) === 'scroll' || $offsetParent.css( 'overflow-y' ) === 'auto';
4584
4585 vertScrollbarWidth = $offsetParent.innerWidth() - $offsetParent.prop( 'clientWidth' );
4586 horizScrollbarHeight = $offsetParent.innerHeight() - $offsetParent.prop( 'clientHeight' );
4587 // We don't need to compute and add scrollTop and scrollLeft if the scrollable container is the body,
4588 // or if it isn't scrollable
4589 scrollTop = scrollableY && !isBody ? $offsetParent.scrollTop() : 0;
4590 scrollLeft = scrollableX && !isBody ? OO.ui.Element.static.getScrollLeft( $offsetParent[ 0 ] ) : 0;
4591
4592 // Avoid passing the <body> to getRelativePosition(), because it won't return what we expect
4593 // if the <body> has a margin
4594 containerPos = isBody ?
4595 this.$floatableContainer.offset() :
4596 OO.ui.Element.static.getRelativePosition( this.$floatableContainer, $offsetParent );
4597 containerPos.bottom = containerPos.top + this.$floatableContainer.outerHeight();
4598 containerPos.right = containerPos.left + this.$floatableContainer.outerWidth();
4599 containerPos.start = direction === 'rtl' ? containerPos.right : containerPos.left;
4600 containerPos.end = direction === 'rtl' ? containerPos.left : containerPos.right;
4601
4602 if ( this.verticalPosition === 'below' ) {
4603 newPos.top = containerPos.bottom;
4604 } else if ( this.verticalPosition === 'above' ) {
4605 newPos.bottom = $offsetParent.outerHeight() - containerPos.top;
4606 } else if ( this.verticalPosition === 'top' ) {
4607 newPos.top = containerPos.top;
4608 } else if ( this.verticalPosition === 'bottom' ) {
4609 newPos.bottom = $offsetParent.outerHeight() - containerPos.bottom;
4610 } else if ( this.verticalPosition === 'center' ) {
4611 newPos.top = containerPos.top +
4612 ( this.$floatableContainer.height() - this.$floatable.height() ) / 2;
4613 }
4614
4615 if ( this.horizontalPosition === 'before' ) {
4616 newPos.end = containerPos.start;
4617 } else if ( this.horizontalPosition === 'after' ) {
4618 newPos.start = containerPos.end;
4619 } else if ( this.horizontalPosition === 'start' ) {
4620 newPos.start = containerPos.start;
4621 } else if ( this.horizontalPosition === 'end' ) {
4622 newPos.end = containerPos.end;
4623 } else if ( this.horizontalPosition === 'center' ) {
4624 newPos.left = containerPos.left +
4625 ( this.$floatableContainer.width() - this.$floatable.width() ) / 2;
4626 }
4627
4628 if ( newPos.start !== undefined ) {
4629 if ( direction === 'rtl' ) {
4630 newPos.right = ( isBody ? $( $offsetParent[ 0 ].ownerDocument.documentElement ) : $offsetParent ).outerWidth() - newPos.start;
4631 } else {
4632 newPos.left = newPos.start;
4633 }
4634 delete newPos.start;
4635 }
4636 if ( newPos.end !== undefined ) {
4637 if ( direction === 'rtl' ) {
4638 newPos.left = newPos.end;
4639 } else {
4640 newPos.right = ( isBody ? $( $offsetParent[ 0 ].ownerDocument.documentElement ) : $offsetParent ).outerWidth() - newPos.end;
4641 }
4642 delete newPos.end;
4643 }
4644
4645 // Account for scroll position
4646 if ( newPos.top !== '' ) {
4647 newPos.top += scrollTop;
4648 }
4649 if ( newPos.bottom !== '' ) {
4650 newPos.bottom -= scrollTop;
4651 }
4652 if ( newPos.left !== '' ) {
4653 newPos.left += scrollLeft;
4654 }
4655 if ( newPos.right !== '' ) {
4656 newPos.right -= scrollLeft;
4657 }
4658
4659 // Account for scrollbar gutter
4660 if ( newPos.bottom !== '' ) {
4661 newPos.bottom -= horizScrollbarHeight;
4662 }
4663 if ( direction === 'rtl' ) {
4664 if ( newPos.left !== '' ) {
4665 newPos.left -= vertScrollbarWidth;
4666 }
4667 } else {
4668 if ( newPos.right !== '' ) {
4669 newPos.right -= vertScrollbarWidth;
4670 }
4671 }
4672
4673 return newPos;
4674 };
4675
4676 /**
4677 * Element that can be automatically clipped to visible boundaries.
4678 *
4679 * Whenever the element's natural height changes, you have to call
4680 * {@link OO.ui.mixin.ClippableElement#clip} to make sure it's still
4681 * clipping correctly.
4682 *
4683 * The dimensions of #$clippableContainer will be compared to the boundaries of the
4684 * nearest scrollable container. If #$clippableContainer is too tall and/or too wide,
4685 * then #$clippable will be given a fixed reduced height and/or width and will be made
4686 * scrollable. By default, #$clippable and #$clippableContainer are the same element,
4687 * but you can build a static footer by setting #$clippableContainer to an element that contains
4688 * #$clippable and the footer.
4689 *
4690 * @abstract
4691 * @class
4692 *
4693 * @constructor
4694 * @param {Object} [config] Configuration options
4695 * @cfg {jQuery} [$clippable] Node to clip, assigned to #$clippable, omit to use #$element
4696 * @cfg {jQuery} [$clippableContainer] Node to keep visible, assigned to #$clippableContainer,
4697 * omit to use #$clippable
4698 */
4699 OO.ui.mixin.ClippableElement = function OoUiMixinClippableElement( config ) {
4700 // Configuration initialization
4701 config = config || {};
4702
4703 // Properties
4704 this.$clippable = null;
4705 this.$clippableContainer = null;
4706 this.clipping = false;
4707 this.clippedHorizontally = false;
4708 this.clippedVertically = false;
4709 this.$clippableScrollableContainer = null;
4710 this.$clippableScroller = null;
4711 this.$clippableWindow = null;
4712 this.idealWidth = null;
4713 this.idealHeight = null;
4714 this.onClippableScrollHandler = this.clip.bind( this );
4715 this.onClippableWindowResizeHandler = this.clip.bind( this );
4716
4717 // Initialization
4718 if ( config.$clippableContainer ) {
4719 this.setClippableContainer( config.$clippableContainer );
4720 }
4721 this.setClippableElement( config.$clippable || this.$element );
4722 };
4723
4724 /* Methods */
4725
4726 /**
4727 * Set clippable element.
4728 *
4729 * If an element is already set, it will be cleaned up before setting up the new element.
4730 *
4731 * @param {jQuery} $clippable Element to make clippable
4732 */
4733 OO.ui.mixin.ClippableElement.prototype.setClippableElement = function ( $clippable ) {
4734 if ( this.$clippable ) {
4735 this.$clippable.removeClass( 'oo-ui-clippableElement-clippable' );
4736 this.$clippable.css( { width: '', height: '', overflowX: '', overflowY: '' } );
4737 OO.ui.Element.static.reconsiderScrollbars( this.$clippable[ 0 ] );
4738 }
4739
4740 this.$clippable = $clippable.addClass( 'oo-ui-clippableElement-clippable' );
4741 this.clip();
4742 };
4743
4744 /**
4745 * Set clippable container.
4746 *
4747 * This is the container that will be measured when deciding whether to clip. When clipping,
4748 * #$clippable will be resized in order to keep the clippable container fully visible.
4749 *
4750 * If the clippable container is unset, #$clippable will be used.
4751 *
4752 * @param {jQuery|null} $clippableContainer Container to keep visible, or null to unset
4753 */
4754 OO.ui.mixin.ClippableElement.prototype.setClippableContainer = function ( $clippableContainer ) {
4755 this.$clippableContainer = $clippableContainer;
4756 if ( this.$clippable ) {
4757 this.clip();
4758 }
4759 };
4760
4761 /**
4762 * Toggle clipping.
4763 *
4764 * Do not turn clipping on until after the element is attached to the DOM and visible.
4765 *
4766 * @param {boolean} [clipping] Enable clipping, omit to toggle
4767 * @chainable
4768 */
4769 OO.ui.mixin.ClippableElement.prototype.toggleClipping = function ( clipping ) {
4770 clipping = clipping === undefined ? !this.clipping : !!clipping;
4771
4772 if ( clipping && !this.warnedUnattached && !this.isElementAttached() ) {
4773 OO.ui.warnDeprecation( 'ClippableElement#toggleClipping: Before calling this method, the element must be attached to the DOM.' );
4774 this.warnedUnattached = true;
4775 }
4776
4777 if ( this.clipping !== clipping ) {
4778 this.clipping = clipping;
4779 if ( clipping ) {
4780 this.$clippableScrollableContainer = $( this.getClosestScrollableElementContainer() );
4781 // If the clippable container is the root, we have to listen to scroll events and check
4782 // jQuery.scrollTop on the window because of browser inconsistencies
4783 this.$clippableScroller = this.$clippableScrollableContainer.is( 'html, body' ) ?
4784 $( OO.ui.Element.static.getWindow( this.$clippableScrollableContainer ) ) :
4785 this.$clippableScrollableContainer;
4786 this.$clippableScroller.on( 'scroll', this.onClippableScrollHandler );
4787 this.$clippableWindow = $( this.getElementWindow() )
4788 .on( 'resize', this.onClippableWindowResizeHandler );
4789 // Initial clip after visible
4790 this.clip();
4791 } else {
4792 this.$clippable.css( {
4793 width: '',
4794 height: '',
4795 maxWidth: '',
4796 maxHeight: '',
4797 overflowX: '',
4798 overflowY: ''
4799 } );
4800 OO.ui.Element.static.reconsiderScrollbars( this.$clippable[ 0 ] );
4801
4802 this.$clippableScrollableContainer = null;
4803 this.$clippableScroller.off( 'scroll', this.onClippableScrollHandler );
4804 this.$clippableScroller = null;
4805 this.$clippableWindow.off( 'resize', this.onClippableWindowResizeHandler );
4806 this.$clippableWindow = null;
4807 }
4808 }
4809
4810 return this;
4811 };
4812
4813 /**
4814 * Check if the element will be clipped to fit the visible area of the nearest scrollable container.
4815 *
4816 * @return {boolean} Element will be clipped to the visible area
4817 */
4818 OO.ui.mixin.ClippableElement.prototype.isClipping = function () {
4819 return this.clipping;
4820 };
4821
4822 /**
4823 * Check if the bottom or right of the element is being clipped by the nearest scrollable container.
4824 *
4825 * @return {boolean} Part of the element is being clipped
4826 */
4827 OO.ui.mixin.ClippableElement.prototype.isClipped = function () {
4828 return this.clippedHorizontally || this.clippedVertically;
4829 };
4830
4831 /**
4832 * Check if the right of the element is being clipped by the nearest scrollable container.
4833 *
4834 * @return {boolean} Part of the element is being clipped
4835 */
4836 OO.ui.mixin.ClippableElement.prototype.isClippedHorizontally = function () {
4837 return this.clippedHorizontally;
4838 };
4839
4840 /**
4841 * Check if the bottom of the element is being clipped by the nearest scrollable container.
4842 *
4843 * @return {boolean} Part of the element is being clipped
4844 */
4845 OO.ui.mixin.ClippableElement.prototype.isClippedVertically = function () {
4846 return this.clippedVertically;
4847 };
4848
4849 /**
4850 * Set the ideal size. These are the dimensions #$clippable will have when it's not being clipped.
4851 *
4852 * @param {number|string} [width] Width as a number of pixels or CSS string with unit suffix
4853 * @param {number|string} [height] Height as a number of pixels or CSS string with unit suffix
4854 */
4855 OO.ui.mixin.ClippableElement.prototype.setIdealSize = function ( width, height ) {
4856 this.idealWidth = width;
4857 this.idealHeight = height;
4858
4859 if ( !this.clipping ) {
4860 // Update dimensions
4861 this.$clippable.css( { width: width, height: height } );
4862 }
4863 // While clipping, idealWidth and idealHeight are not considered
4864 };
4865
4866 /**
4867 * Return the side of the clippable on which it is "anchored" (aligned to something else).
4868 * ClippableElement will clip the opposite side when reducing element's width.
4869 *
4870 * Classes that mix in ClippableElement should override this to return 'right' if their
4871 * clippable is absolutely positioned and using 'right: Npx' (and not using 'left').
4872 * If your class also mixes in FloatableElement, this is handled automatically.
4873 *
4874 * (This can't be guessed from the actual CSS because the computed values for 'left'/'right' are
4875 * always in pixels, even if they were unset or set to 'auto'.)
4876 *
4877 * When in doubt, 'left' (or 'right' in RTL) is a sane fallback.
4878 *
4879 * @return {string} 'left' or 'right'
4880 */
4881 OO.ui.mixin.ClippableElement.prototype.getHorizontalAnchorEdge = function () {
4882 if ( this.computePosition && this.positioning && this.computePosition().right !== '' ) {
4883 return 'right';
4884 }
4885 return 'left';
4886 };
4887
4888 /**
4889 * Return the side of the clippable on which it is "anchored" (aligned to something else).
4890 * ClippableElement will clip the opposite side when reducing element's width.
4891 *
4892 * Classes that mix in ClippableElement should override this to return 'bottom' if their
4893 * clippable is absolutely positioned and using 'bottom: Npx' (and not using 'top').
4894 * If your class also mixes in FloatableElement, this is handled automatically.
4895 *
4896 * (This can't be guessed from the actual CSS because the computed values for 'left'/'right' are
4897 * always in pixels, even if they were unset or set to 'auto'.)
4898 *
4899 * When in doubt, 'top' is a sane fallback.
4900 *
4901 * @return {string} 'top' or 'bottom'
4902 */
4903 OO.ui.mixin.ClippableElement.prototype.getVerticalAnchorEdge = function () {
4904 if ( this.computePosition && this.positioning && this.computePosition().bottom !== '' ) {
4905 return 'bottom';
4906 }
4907 return 'top';
4908 };
4909
4910 /**
4911 * Clip element to visible boundaries and allow scrolling when needed. You should call this method
4912 * when the element's natural height changes.
4913 *
4914 * Element will be clipped the bottom or right of the element is within 10px of the edge of, or
4915 * overlapped by, the visible area of the nearest scrollable container.
4916 *
4917 * Because calling clip() when the natural height changes isn't always possible, we also set
4918 * max-height when the element isn't being clipped. This means that if the element tries to grow
4919 * beyond the edge, something reasonable will happen before clip() is called.
4920 *
4921 * @chainable
4922 */
4923 OO.ui.mixin.ClippableElement.prototype.clip = function () {
4924 var extraHeight, extraWidth, viewportSpacing,
4925 desiredWidth, desiredHeight, allotedWidth, allotedHeight,
4926 naturalWidth, naturalHeight, clipWidth, clipHeight,
4927 $item, itemRect, $viewport, viewportRect, availableRect,
4928 direction, vertScrollbarWidth, horizScrollbarHeight,
4929 // Extra tolerance so that the sloppy code below doesn't result in results that are off
4930 // by one or two pixels. (And also so that we have space to display drop shadows.)
4931 // Chosen by fair dice roll.
4932 buffer = 7;
4933
4934 if ( !this.clipping ) {
4935 // this.$clippableScrollableContainer and this.$clippableWindow are null, so the below will fail
4936 return this;
4937 }
4938
4939 function rectIntersection( a, b ) {
4940 var out = {};
4941 out.top = Math.max( a.top, b.top );
4942 out.left = Math.max( a.left, b.left );
4943 out.bottom = Math.min( a.bottom, b.bottom );
4944 out.right = Math.min( a.right, b.right );
4945 return out;
4946 }
4947
4948 viewportSpacing = OO.ui.getViewportSpacing();
4949
4950 if ( this.$clippableScrollableContainer.is( 'html, body' ) ) {
4951 $viewport = $( this.$clippableScrollableContainer[ 0 ].ownerDocument.body );
4952 // Dimensions of the browser window, rather than the element!
4953 viewportRect = {
4954 top: 0,
4955 left: 0,
4956 right: document.documentElement.clientWidth,
4957 bottom: document.documentElement.clientHeight
4958 };
4959 viewportRect.top += viewportSpacing.top;
4960 viewportRect.left += viewportSpacing.left;
4961 viewportRect.right -= viewportSpacing.right;
4962 viewportRect.bottom -= viewportSpacing.bottom;
4963 } else {
4964 $viewport = this.$clippableScrollableContainer;
4965 viewportRect = $viewport[ 0 ].getBoundingClientRect();
4966 // Convert into a plain object
4967 viewportRect = $.extend( {}, viewportRect );
4968 }
4969
4970 // Account for scrollbar gutter
4971 direction = $viewport.css( 'direction' );
4972 vertScrollbarWidth = $viewport.innerWidth() - $viewport.prop( 'clientWidth' );
4973 horizScrollbarHeight = $viewport.innerHeight() - $viewport.prop( 'clientHeight' );
4974 viewportRect.bottom -= horizScrollbarHeight;
4975 if ( direction === 'rtl' ) {
4976 viewportRect.left += vertScrollbarWidth;
4977 } else {
4978 viewportRect.right -= vertScrollbarWidth;
4979 }
4980
4981 // Add arbitrary tolerance
4982 viewportRect.top += buffer;
4983 viewportRect.left += buffer;
4984 viewportRect.right -= buffer;
4985 viewportRect.bottom -= buffer;
4986
4987 $item = this.$clippableContainer || this.$clippable;
4988
4989 extraHeight = $item.outerHeight() - this.$clippable.outerHeight();
4990 extraWidth = $item.outerWidth() - this.$clippable.outerWidth();
4991
4992 itemRect = $item[ 0 ].getBoundingClientRect();
4993 // Convert into a plain object
4994 itemRect = $.extend( {}, itemRect );
4995
4996 // Item might already be clipped, so we can't just use its dimensions (in case we might need to
4997 // make it larger than before). Extend the rectangle to the maximum size we are allowed to take.
4998 if ( this.getHorizontalAnchorEdge() === 'right' ) {
4999 itemRect.left = viewportRect.left;
5000 } else {
5001 itemRect.right = viewportRect.right;
5002 }
5003 if ( this.getVerticalAnchorEdge() === 'bottom' ) {
5004 itemRect.top = viewportRect.top;
5005 } else {
5006 itemRect.bottom = viewportRect.bottom;
5007 }
5008
5009 availableRect = rectIntersection( viewportRect, itemRect );
5010
5011 desiredWidth = Math.max( 0, availableRect.right - availableRect.left );
5012 desiredHeight = Math.max( 0, availableRect.bottom - availableRect.top );
5013 // It should never be desirable to exceed the dimensions of the browser viewport... right?
5014 desiredWidth = Math.min( desiredWidth,
5015 document.documentElement.clientWidth - viewportSpacing.left - viewportSpacing.right );
5016 desiredHeight = Math.min( desiredHeight,
5017 document.documentElement.clientHeight - viewportSpacing.top - viewportSpacing.right );
5018 allotedWidth = Math.ceil( desiredWidth - extraWidth );
5019 allotedHeight = Math.ceil( desiredHeight - extraHeight );
5020 naturalWidth = this.$clippable.prop( 'scrollWidth' );
5021 naturalHeight = this.$clippable.prop( 'scrollHeight' );
5022 clipWidth = allotedWidth < naturalWidth;
5023 clipHeight = allotedHeight < naturalHeight;
5024
5025 if ( clipWidth ) {
5026 // The order matters here. If overflow is not set first, Chrome displays bogus scrollbars. See T157672.
5027 // Forcing a reflow is a smaller workaround than calling reconsiderScrollbars() for this case.
5028 this.$clippable.css( 'overflowX', 'scroll' );
5029 void this.$clippable[ 0 ].offsetHeight; // Force reflow
5030 this.$clippable.css( {
5031 width: Math.max( 0, allotedWidth ),
5032 maxWidth: ''
5033 } );
5034 } else {
5035 this.$clippable.css( {
5036 overflowX: '',
5037 width: this.idealWidth || '',
5038 maxWidth: Math.max( 0, allotedWidth )
5039 } );
5040 }
5041 if ( clipHeight ) {
5042 // The order matters here. If overflow is not set first, Chrome displays bogus scrollbars. See T157672.
5043 // Forcing a reflow is a smaller workaround than calling reconsiderScrollbars() for this case.
5044 this.$clippable.css( 'overflowY', 'scroll' );
5045 void this.$clippable[ 0 ].offsetHeight; // Force reflow
5046 this.$clippable.css( {
5047 height: Math.max( 0, allotedHeight ),
5048 maxHeight: ''
5049 } );
5050 } else {
5051 this.$clippable.css( {
5052 overflowY: '',
5053 height: this.idealHeight || '',
5054 maxHeight: Math.max( 0, allotedHeight )
5055 } );
5056 }
5057
5058 // If we stopped clipping in at least one of the dimensions
5059 if ( ( this.clippedHorizontally && !clipWidth ) || ( this.clippedVertically && !clipHeight ) ) {
5060 OO.ui.Element.static.reconsiderScrollbars( this.$clippable[ 0 ] );
5061 }
5062
5063 this.clippedHorizontally = clipWidth;
5064 this.clippedVertically = clipHeight;
5065
5066 return this;
5067 };
5068
5069 /**
5070 * PopupWidget is a container for content. The popup is overlaid and positioned absolutely.
5071 * By default, each popup has an anchor that points toward its origin.
5072 * Please see the [OOUI documentation on Mediawiki] [1] for more information and examples.
5073 *
5074 * Unlike most widgets, PopupWidget is initially hidden and must be shown by calling #toggle.
5075 *
5076 * @example
5077 * // A popup widget.
5078 * var popup = new OO.ui.PopupWidget( {
5079 * $content: $( '<p>Hi there!</p>' ),
5080 * padded: true,
5081 * width: 300
5082 * } );
5083 *
5084 * $( 'body' ).append( popup.$element );
5085 * // To display the popup, toggle the visibility to 'true'.
5086 * popup.toggle( true );
5087 *
5088 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Popups
5089 *
5090 * @class
5091 * @extends OO.ui.Widget
5092 * @mixins OO.ui.mixin.LabelElement
5093 * @mixins OO.ui.mixin.ClippableElement
5094 * @mixins OO.ui.mixin.FloatableElement
5095 *
5096 * @constructor
5097 * @param {Object} [config] Configuration options
5098 * @cfg {number} [width=320] Width of popup in pixels
5099 * @cfg {number} [height] Height of popup in pixels. Omit to use the automatic height.
5100 * @cfg {boolean} [anchor=true] Show anchor pointing to origin of popup
5101 * @cfg {string} [position='below'] Where to position the popup relative to $floatableContainer
5102 * 'above': Put popup above $floatableContainer; anchor points down to the horizontal center
5103 * of $floatableContainer
5104 * 'below': Put popup below $floatableContainer; anchor points up to the horizontal center
5105 * of $floatableContainer
5106 * 'before': Put popup to the left (LTR) / right (RTL) of $floatableContainer; anchor points
5107 * endwards (right/left) to the vertical center of $floatableContainer
5108 * 'after': Put popup to the right (LTR) / left (RTL) of $floatableContainer; anchor points
5109 * startwards (left/right) to the vertical center of $floatableContainer
5110 * @cfg {string} [align='center'] How to align the popup to $floatableContainer
5111 * 'forwards': If position is above/below, move the popup as far endwards (right in LTR, left in RTL)
5112 * as possible while still keeping the anchor within the popup;
5113 * if position is before/after, move the popup as far downwards as possible.
5114 * 'backwards': If position is above/below, move the popup as far startwards (left in LTR, right in RTL)
5115 * as possible while still keeping the anchor within the popup;
5116 * if position in before/after, move the popup as far upwards as possible.
5117 * 'center': Horizontally (if position is above/below) or vertically (before/after) align the center
5118 * of the popup with the center of $floatableContainer.
5119 * 'force-left': Alias for 'forwards' in LTR and 'backwards' in RTL
5120 * 'force-right': Alias for 'backwards' in RTL and 'forwards' in LTR
5121 * @cfg {boolean} [autoFlip=true] Whether to automatically switch the popup's position between
5122 * 'above' and 'below', or between 'before' and 'after', if there is not enough space in the
5123 * desired direction to display the popup without clipping
5124 * @cfg {jQuery} [$container] Constrain the popup to the boundaries of the specified container.
5125 * See the [OOUI docs on MediaWiki][3] for an example.
5126 * [3]: https://www.mediawiki.org/wiki/OOUI/Widgets/Popups#containerExample
5127 * @cfg {number} [containerPadding=10] Padding between the popup and its container, specified as a number of pixels.
5128 * @cfg {jQuery} [$content] Content to append to the popup's body
5129 * @cfg {jQuery} [$footer] Content to append to the popup's footer
5130 * @cfg {boolean} [autoClose=false] Automatically close the popup when it loses focus.
5131 * @cfg {jQuery} [$autoCloseIgnore] Elements that will not close the popup when clicked.
5132 * This config option is only relevant if #autoClose is set to `true`. See the [OOUI documentation on MediaWiki][2]
5133 * for an example.
5134 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Popups#autocloseExample
5135 * @cfg {boolean} [head=false] Show a popup header that contains a #label (if specified) and close
5136 * button.
5137 * @cfg {boolean} [padded=false] Add padding to the popup's body
5138 */
5139 OO.ui.PopupWidget = function OoUiPopupWidget( config ) {
5140 // Configuration initialization
5141 config = config || {};
5142
5143 // Parent constructor
5144 OO.ui.PopupWidget.parent.call( this, config );
5145
5146 // Properties (must be set before ClippableElement constructor call)
5147 this.$body = $( '<div>' );
5148 this.$popup = $( '<div>' );
5149
5150 // Mixin constructors
5151 OO.ui.mixin.LabelElement.call( this, config );
5152 OO.ui.mixin.ClippableElement.call( this, $.extend( {}, config, {
5153 $clippable: this.$body,
5154 $clippableContainer: this.$popup
5155 } ) );
5156 OO.ui.mixin.FloatableElement.call( this, config );
5157
5158 // Properties
5159 this.$anchor = $( '<div>' );
5160 // If undefined, will be computed lazily in computePosition()
5161 this.$container = config.$container;
5162 this.containerPadding = config.containerPadding !== undefined ? config.containerPadding : 10;
5163 this.autoClose = !!config.autoClose;
5164 this.$autoCloseIgnore = config.$autoCloseIgnore;
5165 this.transitionTimeout = null;
5166 this.anchored = false;
5167 this.width = config.width !== undefined ? config.width : 320;
5168 this.height = config.height !== undefined ? config.height : null;
5169 this.onMouseDownHandler = this.onMouseDown.bind( this );
5170 this.onDocumentKeyDownHandler = this.onDocumentKeyDown.bind( this );
5171
5172 // Initialization
5173 this.toggleAnchor( config.anchor === undefined || config.anchor );
5174 this.setAlignment( config.align || 'center' );
5175 this.setPosition( config.position || 'below' );
5176 this.setAutoFlip( config.autoFlip === undefined || config.autoFlip );
5177 this.$body.addClass( 'oo-ui-popupWidget-body' );
5178 this.$anchor.addClass( 'oo-ui-popupWidget-anchor' );
5179 this.$popup
5180 .addClass( 'oo-ui-popupWidget-popup' )
5181 .append( this.$body );
5182 this.$element
5183 .addClass( 'oo-ui-popupWidget' )
5184 .append( this.$popup, this.$anchor );
5185 // Move content, which was added to #$element by OO.ui.Widget, to the body
5186 // FIXME This is gross, we should use '$body' or something for the config
5187 if ( config.$content instanceof jQuery ) {
5188 this.$body.append( config.$content );
5189 }
5190
5191 if ( config.padded ) {
5192 this.$body.addClass( 'oo-ui-popupWidget-body-padded' );
5193 }
5194
5195 if ( config.head ) {
5196 this.closeButton = new OO.ui.ButtonWidget( { framed: false, icon: 'close' } );
5197 this.closeButton.connect( this, { click: 'onCloseButtonClick' } );
5198 this.$head = $( '<div>' )
5199 .addClass( 'oo-ui-popupWidget-head' )
5200 .append( this.$label, this.closeButton.$element );
5201 this.$popup.prepend( this.$head );
5202 }
5203
5204 if ( config.$footer ) {
5205 this.$footer = $( '<div>' )
5206 .addClass( 'oo-ui-popupWidget-footer' )
5207 .append( config.$footer );
5208 this.$popup.append( this.$footer );
5209 }
5210
5211 // Initially hidden - using #toggle may cause errors if subclasses override toggle with methods
5212 // that reference properties not initialized at that time of parent class construction
5213 // TODO: Find a better way to handle post-constructor setup
5214 this.visible = false;
5215 this.$element.addClass( 'oo-ui-element-hidden' );
5216 };
5217
5218 /* Setup */
5219
5220 OO.inheritClass( OO.ui.PopupWidget, OO.ui.Widget );
5221 OO.mixinClass( OO.ui.PopupWidget, OO.ui.mixin.LabelElement );
5222 OO.mixinClass( OO.ui.PopupWidget, OO.ui.mixin.ClippableElement );
5223 OO.mixinClass( OO.ui.PopupWidget, OO.ui.mixin.FloatableElement );
5224
5225 /* Events */
5226
5227 /**
5228 * @event ready
5229 *
5230 * The popup is ready: it is visible and has been positioned and clipped.
5231 */
5232
5233 /* Methods */
5234
5235 /**
5236 * Handles mouse down events.
5237 *
5238 * @private
5239 * @param {MouseEvent} e Mouse down event
5240 */
5241 OO.ui.PopupWidget.prototype.onMouseDown = function ( e ) {
5242 if (
5243 this.isVisible() &&
5244 !OO.ui.contains( this.$element.add( this.$autoCloseIgnore ).get(), e.target, true )
5245 ) {
5246 this.toggle( false );
5247 }
5248 };
5249
5250 /**
5251 * Bind mouse down listener.
5252 *
5253 * @private
5254 */
5255 OO.ui.PopupWidget.prototype.bindMouseDownListener = function () {
5256 // Capture clicks outside popup
5257 this.getElementWindow().addEventListener( 'mousedown', this.onMouseDownHandler, true );
5258 };
5259
5260 /**
5261 * Handles close button click events.
5262 *
5263 * @private
5264 */
5265 OO.ui.PopupWidget.prototype.onCloseButtonClick = function () {
5266 if ( this.isVisible() ) {
5267 this.toggle( false );
5268 }
5269 };
5270
5271 /**
5272 * Unbind mouse down listener.
5273 *
5274 * @private
5275 */
5276 OO.ui.PopupWidget.prototype.unbindMouseDownListener = function () {
5277 this.getElementWindow().removeEventListener( 'mousedown', this.onMouseDownHandler, true );
5278 };
5279
5280 /**
5281 * Handles key down events.
5282 *
5283 * @private
5284 * @param {KeyboardEvent} e Key down event
5285 */
5286 OO.ui.PopupWidget.prototype.onDocumentKeyDown = function ( e ) {
5287 if (
5288 e.which === OO.ui.Keys.ESCAPE &&
5289 this.isVisible()
5290 ) {
5291 this.toggle( false );
5292 e.preventDefault();
5293 e.stopPropagation();
5294 }
5295 };
5296
5297 /**
5298 * Bind key down listener.
5299 *
5300 * @private
5301 */
5302 OO.ui.PopupWidget.prototype.bindKeyDownListener = function () {
5303 this.getElementWindow().addEventListener( 'keydown', this.onDocumentKeyDownHandler, true );
5304 };
5305
5306 /**
5307 * Unbind key down listener.
5308 *
5309 * @private
5310 */
5311 OO.ui.PopupWidget.prototype.unbindKeyDownListener = function () {
5312 this.getElementWindow().removeEventListener( 'keydown', this.onDocumentKeyDownHandler, true );
5313 };
5314
5315 /**
5316 * Show, hide, or toggle the visibility of the anchor.
5317 *
5318 * @param {boolean} [show] Show anchor, omit to toggle
5319 */
5320 OO.ui.PopupWidget.prototype.toggleAnchor = function ( show ) {
5321 show = show === undefined ? !this.anchored : !!show;
5322
5323 if ( this.anchored !== show ) {
5324 if ( show ) {
5325 this.$element.addClass( 'oo-ui-popupWidget-anchored' );
5326 this.$element.addClass( 'oo-ui-popupWidget-anchored-' + this.anchorEdge );
5327 } else {
5328 this.$element.removeClass( 'oo-ui-popupWidget-anchored' );
5329 this.$element.removeClass( 'oo-ui-popupWidget-anchored-' + this.anchorEdge );
5330 }
5331 this.anchored = show;
5332 }
5333 };
5334
5335 /**
5336 * Change which edge the anchor appears on.
5337 *
5338 * @param {string} edge 'top', 'bottom', 'start' or 'end'
5339 */
5340 OO.ui.PopupWidget.prototype.setAnchorEdge = function ( edge ) {
5341 if ( [ 'top', 'bottom', 'start', 'end' ].indexOf( edge ) === -1 ) {
5342 throw new Error( 'Invalid value for edge: ' + edge );
5343 }
5344 if ( this.anchorEdge !== null ) {
5345 this.$element.removeClass( 'oo-ui-popupWidget-anchored-' + this.anchorEdge );
5346 }
5347 this.anchorEdge = edge;
5348 if ( this.anchored ) {
5349 this.$element.addClass( 'oo-ui-popupWidget-anchored-' + edge );
5350 }
5351 };
5352
5353 /**
5354 * Check if the anchor is visible.
5355 *
5356 * @return {boolean} Anchor is visible
5357 */
5358 OO.ui.PopupWidget.prototype.hasAnchor = function () {
5359 return this.anchored;
5360 };
5361
5362 /**
5363 * Toggle visibility of the popup. The popup is initially hidden and must be shown by calling
5364 * `.toggle( true )` after its #$element is attached to the DOM.
5365 *
5366 * Do not show the popup while it is not attached to the DOM. The calculations required to display
5367 * it in the right place and with the right dimensions only work correctly while it is attached.
5368 * Side-effects may include broken interface and exceptions being thrown. This wasn't always
5369 * strictly enforced, so currently it only generates a warning in the browser console.
5370 *
5371 * @fires ready
5372 * @inheritdoc
5373 */
5374 OO.ui.PopupWidget.prototype.toggle = function ( show ) {
5375 var change, normalHeight, oppositeHeight, normalWidth, oppositeWidth;
5376 show = show === undefined ? !this.isVisible() : !!show;
5377
5378 change = show !== this.isVisible();
5379
5380 if ( show && !this.warnedUnattached && !this.isElementAttached() ) {
5381 OO.ui.warnDeprecation( 'PopupWidget#toggle: Before calling this method, the popup must be attached to the DOM.' );
5382 this.warnedUnattached = true;
5383 }
5384 if ( show && !this.$floatableContainer && this.isElementAttached() ) {
5385 // Fall back to the parent node if the floatableContainer is not set
5386 this.setFloatableContainer( this.$element.parent() );
5387 }
5388
5389 if ( change && show && this.autoFlip ) {
5390 // Reset auto-flipping before showing the popup again. It's possible we no longer need to flip
5391 // (e.g. if the user scrolled).
5392 this.isAutoFlipped = false;
5393 }
5394
5395 // Parent method
5396 OO.ui.PopupWidget.parent.prototype.toggle.call( this, show );
5397
5398 if ( change ) {
5399 this.togglePositioning( show && !!this.$floatableContainer );
5400
5401 if ( show ) {
5402 if ( this.autoClose ) {
5403 this.bindMouseDownListener();
5404 this.bindKeyDownListener();
5405 }
5406 this.updateDimensions();
5407 this.toggleClipping( true );
5408
5409 if ( this.autoFlip ) {
5410 if ( this.popupPosition === 'above' || this.popupPosition === 'below' ) {
5411 if ( this.isClippedVertically() || this.isFloatableOutOfView() ) {
5412 // If opening the popup in the normal direction causes it to be clipped, open
5413 // in the opposite one instead
5414 normalHeight = this.$element.height();
5415 this.isAutoFlipped = !this.isAutoFlipped;
5416 this.position();
5417 if ( this.isClippedVertically() || this.isFloatableOutOfView() ) {
5418 // If that also causes it to be clipped, open in whichever direction
5419 // we have more space
5420 oppositeHeight = this.$element.height();
5421 if ( oppositeHeight < normalHeight ) {
5422 this.isAutoFlipped = !this.isAutoFlipped;
5423 this.position();
5424 }
5425 }
5426 }
5427 }
5428 if ( this.popupPosition === 'before' || this.popupPosition === 'after' ) {
5429 if ( this.isClippedHorizontally() || this.isFloatableOutOfView() ) {
5430 // If opening the popup in the normal direction causes it to be clipped, open
5431 // in the opposite one instead
5432 normalWidth = this.$element.width();
5433 this.isAutoFlipped = !this.isAutoFlipped;
5434 // Due to T180173 horizontally clipped PopupWidgets have messed up dimensions,
5435 // which causes positioning to be off. Toggle clipping back and fort to work around.
5436 this.toggleClipping( false );
5437 this.position();
5438 this.toggleClipping( true );
5439 if ( this.isClippedHorizontally() || this.isFloatableOutOfView() ) {
5440 // If that also causes it to be clipped, open in whichever direction
5441 // we have more space
5442 oppositeWidth = this.$element.width();
5443 if ( oppositeWidth < normalWidth ) {
5444 this.isAutoFlipped = !this.isAutoFlipped;
5445 // Due to T180173 horizontally clipped PopupWidgets have messed up dimensions,
5446 // which causes positioning to be off. Toggle clipping back and fort to work around.
5447 this.toggleClipping( false );
5448 this.position();
5449 this.toggleClipping( true );
5450 }
5451 }
5452 }
5453 }
5454 }
5455
5456 this.emit( 'ready' );
5457 } else {
5458 this.toggleClipping( false );
5459 if ( this.autoClose ) {
5460 this.unbindMouseDownListener();
5461 this.unbindKeyDownListener();
5462 }
5463 }
5464 }
5465
5466 return this;
5467 };
5468
5469 /**
5470 * Set the size of the popup.
5471 *
5472 * Changing the size may also change the popup's position depending on the alignment.
5473 *
5474 * @param {number} width Width in pixels
5475 * @param {number} height Height in pixels
5476 * @param {boolean} [transition=false] Use a smooth transition
5477 * @chainable
5478 */
5479 OO.ui.PopupWidget.prototype.setSize = function ( width, height, transition ) {
5480 this.width = width;
5481 this.height = height !== undefined ? height : null;
5482 if ( this.isVisible() ) {
5483 this.updateDimensions( transition );
5484 }
5485 };
5486
5487 /**
5488 * Update the size and position.
5489 *
5490 * Only use this to keep the popup properly anchored. Use #setSize to change the size, and this will
5491 * be called automatically.
5492 *
5493 * @param {boolean} [transition=false] Use a smooth transition
5494 * @chainable
5495 */
5496 OO.ui.PopupWidget.prototype.updateDimensions = function ( transition ) {
5497 var widget = this;
5498
5499 // Prevent transition from being interrupted
5500 clearTimeout( this.transitionTimeout );
5501 if ( transition ) {
5502 // Enable transition
5503 this.$element.addClass( 'oo-ui-popupWidget-transitioning' );
5504 }
5505
5506 this.position();
5507
5508 if ( transition ) {
5509 // Prevent transitioning after transition is complete
5510 this.transitionTimeout = setTimeout( function () {
5511 widget.$element.removeClass( 'oo-ui-popupWidget-transitioning' );
5512 }, 200 );
5513 } else {
5514 // Prevent transitioning immediately
5515 this.$element.removeClass( 'oo-ui-popupWidget-transitioning' );
5516 }
5517 };
5518
5519 /**
5520 * @inheritdoc
5521 */
5522 OO.ui.PopupWidget.prototype.computePosition = function () {
5523 var direction, align, vertical, start, end, near, far, sizeProp, popupSize, anchorSize, anchorPos,
5524 anchorOffset, anchorMargin, parentPosition, positionProp, positionAdjustment, floatablePos,
5525 offsetParentPos, containerPos, popupPosition, viewportSpacing,
5526 popupPos = {},
5527 anchorCss = { left: '', right: '', top: '', bottom: '' },
5528 popupPositionOppositeMap = {
5529 above: 'below',
5530 below: 'above',
5531 before: 'after',
5532 after: 'before'
5533 },
5534 alignMap = {
5535 ltr: {
5536 'force-left': 'backwards',
5537 'force-right': 'forwards'
5538 },
5539 rtl: {
5540 'force-left': 'forwards',
5541 'force-right': 'backwards'
5542 }
5543 },
5544 anchorEdgeMap = {
5545 above: 'bottom',
5546 below: 'top',
5547 before: 'end',
5548 after: 'start'
5549 },
5550 hPosMap = {
5551 forwards: 'start',
5552 center: 'center',
5553 backwards: this.anchored ? 'before' : 'end'
5554 },
5555 vPosMap = {
5556 forwards: 'top',
5557 center: 'center',
5558 backwards: 'bottom'
5559 };
5560
5561 if ( !this.$container ) {
5562 // Lazy-initialize $container if not specified in constructor
5563 this.$container = $( this.getClosestScrollableElementContainer() );
5564 }
5565 direction = this.$container.css( 'direction' );
5566
5567 // Set height and width before we do anything else, since it might cause our measurements
5568 // to change (e.g. due to scrollbars appearing or disappearing), and it also affects centering
5569 this.$popup.css( {
5570 width: this.width,
5571 height: this.height !== null ? this.height : 'auto'
5572 } );
5573
5574 align = alignMap[ direction ][ this.align ] || this.align;
5575 popupPosition = this.popupPosition;
5576 if ( this.isAutoFlipped ) {
5577 popupPosition = popupPositionOppositeMap[ popupPosition ];
5578 }
5579
5580 // If the popup is positioned before or after, then the anchor positioning is vertical, otherwise horizontal
5581 vertical = popupPosition === 'before' || popupPosition === 'after';
5582 start = vertical ? 'top' : ( direction === 'rtl' ? 'right' : 'left' );
5583 end = vertical ? 'bottom' : ( direction === 'rtl' ? 'left' : 'right' );
5584 near = vertical ? 'top' : 'left';
5585 far = vertical ? 'bottom' : 'right';
5586 sizeProp = vertical ? 'Height' : 'Width';
5587 popupSize = vertical ? ( this.height || this.$popup.height() ) : this.width;
5588
5589 this.setAnchorEdge( anchorEdgeMap[ popupPosition ] );
5590 this.horizontalPosition = vertical ? popupPosition : hPosMap[ align ];
5591 this.verticalPosition = vertical ? vPosMap[ align ] : popupPosition;
5592
5593 // Parent method
5594 parentPosition = OO.ui.mixin.FloatableElement.prototype.computePosition.call( this );
5595 // Find out which property FloatableElement used for positioning, and adjust that value
5596 positionProp = vertical ?
5597 ( parentPosition.top !== '' ? 'top' : 'bottom' ) :
5598 ( parentPosition.left !== '' ? 'left' : 'right' );
5599
5600 // Figure out where the near and far edges of the popup and $floatableContainer are
5601 floatablePos = this.$floatableContainer.offset();
5602 floatablePos[ far ] = floatablePos[ near ] + this.$floatableContainer[ 'outer' + sizeProp ]();
5603 // Measure where the offsetParent is and compute our position based on that and parentPosition
5604 offsetParentPos = this.$element.offsetParent()[ 0 ] === document.documentElement ?
5605 { top: 0, left: 0 } :
5606 this.$element.offsetParent().offset();
5607
5608 if ( positionProp === near ) {
5609 popupPos[ near ] = offsetParentPos[ near ] + parentPosition[ near ];
5610 popupPos[ far ] = popupPos[ near ] + popupSize;
5611 } else {
5612 popupPos[ far ] = offsetParentPos[ near ] +
5613 this.$element.offsetParent()[ 'inner' + sizeProp ]() - parentPosition[ far ];
5614 popupPos[ near ] = popupPos[ far ] - popupSize;
5615 }
5616
5617 if ( this.anchored ) {
5618 // Position the anchor (which is positioned relative to the popup) to point to $floatableContainer
5619 anchorPos = ( floatablePos[ start ] + floatablePos[ end ] ) / 2;
5620 anchorOffset = ( start === far ? -1 : 1 ) * ( anchorPos - popupPos[ start ] );
5621
5622 // If the anchor is less than 2*anchorSize from either edge, move the popup to make more space
5623 // this.$anchor.width()/height() returns 0 because of the CSS trickery we use, so use scrollWidth/Height
5624 anchorSize = this.$anchor[ 0 ][ 'scroll' + sizeProp ];
5625 anchorMargin = parseFloat( this.$anchor.css( 'margin-' + start ) );
5626 if ( anchorOffset + anchorMargin < 2 * anchorSize ) {
5627 // Not enough space for the anchor on the start side; pull the popup startwards
5628 positionAdjustment = ( positionProp === start ? -1 : 1 ) *
5629 ( 2 * anchorSize - ( anchorOffset + anchorMargin ) );
5630 } else if ( anchorOffset + anchorMargin > popupSize - 2 * anchorSize ) {
5631 // Not enough space for the anchor on the end side; pull the popup endwards
5632 positionAdjustment = ( positionProp === end ? -1 : 1 ) *
5633 ( anchorOffset + anchorMargin - ( popupSize - 2 * anchorSize ) );
5634 } else {
5635 positionAdjustment = 0;
5636 }
5637 } else {
5638 positionAdjustment = 0;
5639 }
5640
5641 // Check if the popup will go beyond the edge of this.$container
5642 containerPos = this.$container[ 0 ] === document.documentElement ?
5643 { top: 0, left: 0 } :
5644 this.$container.offset();
5645 containerPos[ far ] = containerPos[ near ] + this.$container[ 'inner' + sizeProp ]();
5646 if ( this.$container[ 0 ] === document.documentElement ) {
5647 viewportSpacing = OO.ui.getViewportSpacing();
5648 containerPos[ near ] += viewportSpacing[ near ];
5649 containerPos[ far ] -= viewportSpacing[ far ];
5650 }
5651 // Take into account how much the popup will move because of the adjustments we're going to make
5652 popupPos[ near ] += ( positionProp === near ? 1 : -1 ) * positionAdjustment;
5653 popupPos[ far ] += ( positionProp === near ? 1 : -1 ) * positionAdjustment;
5654 if ( containerPos[ near ] + this.containerPadding > popupPos[ near ] ) {
5655 // Popup goes beyond the near (left/top) edge, move it to the right/bottom
5656 positionAdjustment += ( positionProp === near ? 1 : -1 ) *
5657 ( containerPos[ near ] + this.containerPadding - popupPos[ near ] );
5658 } else if ( containerPos[ far ] - this.containerPadding < popupPos[ far ] ) {
5659 // Popup goes beyond the far (right/bottom) edge, move it to the left/top
5660 positionAdjustment += ( positionProp === far ? 1 : -1 ) *
5661 ( popupPos[ far ] - ( containerPos[ far ] - this.containerPadding ) );
5662 }
5663
5664 if ( this.anchored ) {
5665 // Adjust anchorOffset for positionAdjustment
5666 anchorOffset += ( positionProp === start ? -1 : 1 ) * positionAdjustment;
5667
5668 // Position the anchor
5669 anchorCss[ start ] = anchorOffset;
5670 this.$anchor.css( anchorCss );
5671 }
5672
5673 // Move the popup if needed
5674 parentPosition[ positionProp ] += positionAdjustment;
5675
5676 return parentPosition;
5677 };
5678
5679 /**
5680 * Set popup alignment
5681 *
5682 * @param {string} [align=center] Alignment of the popup, `center`, `force-left`, `force-right`,
5683 * `backwards` or `forwards`.
5684 */
5685 OO.ui.PopupWidget.prototype.setAlignment = function ( align ) {
5686 // Validate alignment
5687 if ( [ 'force-left', 'force-right', 'backwards', 'forwards', 'center' ].indexOf( align ) > -1 ) {
5688 this.align = align;
5689 } else {
5690 this.align = 'center';
5691 }
5692 this.position();
5693 };
5694
5695 /**
5696 * Get popup alignment
5697 *
5698 * @return {string} Alignment of the popup, `center`, `force-left`, `force-right`,
5699 * `backwards` or `forwards`.
5700 */
5701 OO.ui.PopupWidget.prototype.getAlignment = function () {
5702 return this.align;
5703 };
5704
5705 /**
5706 * Change the positioning of the popup.
5707 *
5708 * @param {string} position 'above', 'below', 'before' or 'after'
5709 */
5710 OO.ui.PopupWidget.prototype.setPosition = function ( position ) {
5711 if ( [ 'above', 'below', 'before', 'after' ].indexOf( position ) === -1 ) {
5712 position = 'below';
5713 }
5714 this.popupPosition = position;
5715 this.position();
5716 };
5717
5718 /**
5719 * Get popup positioning.
5720 *
5721 * @return {string} 'above', 'below', 'before' or 'after'
5722 */
5723 OO.ui.PopupWidget.prototype.getPosition = function () {
5724 return this.popupPosition;
5725 };
5726
5727 /**
5728 * Set popup auto-flipping.
5729 *
5730 * @param {boolean} autoFlip Whether to automatically switch the popup's position between
5731 * 'above' and 'below', or between 'before' and 'after', if there is not enough space in the
5732 * desired direction to display the popup without clipping
5733 */
5734 OO.ui.PopupWidget.prototype.setAutoFlip = function ( autoFlip ) {
5735 autoFlip = !!autoFlip;
5736
5737 if ( this.autoFlip !== autoFlip ) {
5738 this.autoFlip = autoFlip;
5739 }
5740 };
5741
5742 /**
5743 * Get an ID of the body element, this can be used as the
5744 * `aria-describedby` attribute for an input field.
5745 *
5746 * @return {string} The ID of the body element
5747 */
5748 OO.ui.PopupWidget.prototype.getBodyId = function () {
5749 var id = this.$body.attr( 'id' );
5750 if ( id === undefined ) {
5751 id = OO.ui.generateElementId();
5752 this.$body.attr( 'id', id );
5753 }
5754 return id;
5755 };
5756
5757 /**
5758 * PopupElement is mixed into other classes to generate a {@link OO.ui.PopupWidget popup widget}.
5759 * A popup is a container for content. It is overlaid and positioned absolutely. By default, each
5760 * popup has an anchor, which is an arrow-like protrusion that points toward the popup’s origin.
5761 * See {@link OO.ui.PopupWidget PopupWidget} for an example.
5762 *
5763 * @abstract
5764 * @class
5765 *
5766 * @constructor
5767 * @param {Object} [config] Configuration options
5768 * @cfg {Object} [popup] Configuration to pass to popup
5769 * @cfg {boolean} [popup.autoClose=true] Popup auto-closes when it loses focus
5770 */
5771 OO.ui.mixin.PopupElement = function OoUiMixinPopupElement( config ) {
5772 // Configuration initialization
5773 config = config || {};
5774
5775 // Properties
5776 this.popup = new OO.ui.PopupWidget( $.extend(
5777 {
5778 autoClose: true,
5779 $floatableContainer: this.$element
5780 },
5781 config.popup,
5782 {
5783 $autoCloseIgnore: this.$element.add( config.popup && config.popup.$autoCloseIgnore )
5784 }
5785 ) );
5786 };
5787
5788 /* Methods */
5789
5790 /**
5791 * Get popup.
5792 *
5793 * @return {OO.ui.PopupWidget} Popup widget
5794 */
5795 OO.ui.mixin.PopupElement.prototype.getPopup = function () {
5796 return this.popup;
5797 };
5798
5799 /**
5800 * PopupButtonWidgets toggle the visibility of a contained {@link OO.ui.PopupWidget PopupWidget},
5801 * which is used to display additional information or options.
5802 *
5803 * @example
5804 * // Example of a popup button.
5805 * var popupButton = new OO.ui.PopupButtonWidget( {
5806 * label: 'Popup button with options',
5807 * icon: 'menu',
5808 * popup: {
5809 * $content: $( '<p>Additional options here.</p>' ),
5810 * padded: true,
5811 * align: 'force-left'
5812 * }
5813 * } );
5814 * // Append the button to the DOM.
5815 * $( 'body' ).append( popupButton.$element );
5816 *
5817 * @class
5818 * @extends OO.ui.ButtonWidget
5819 * @mixins OO.ui.mixin.PopupElement
5820 *
5821 * @constructor
5822 * @param {Object} [config] Configuration options
5823 * @cfg {jQuery} [$overlay] Render the popup into a separate layer. This configuration is useful in cases where
5824 * the expanded popup is larger than its containing `<div>`. The specified overlay layer is usually on top of the
5825 * containing `<div>` and has a larger area. By default, the popup uses relative positioning.
5826 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
5827 */
5828 OO.ui.PopupButtonWidget = function OoUiPopupButtonWidget( config ) {
5829 // Configuration initialization
5830 config = config || {};
5831
5832 // Parent constructor
5833 OO.ui.PopupButtonWidget.parent.call( this, config );
5834
5835 // Mixin constructors
5836 OO.ui.mixin.PopupElement.call( this, config );
5837
5838 // Properties
5839 this.$overlay = ( config.$overlay === true ? OO.ui.getDefaultOverlay() : config.$overlay ) || this.$element;
5840
5841 // Events
5842 this.connect( this, { click: 'onAction' } );
5843
5844 // Initialization
5845 this.$element
5846 .addClass( 'oo-ui-popupButtonWidget' )
5847 .attr( 'aria-haspopup', 'true' );
5848 this.popup.$element
5849 .addClass( 'oo-ui-popupButtonWidget-popup' )
5850 .toggleClass( 'oo-ui-popupButtonWidget-framed-popup', this.isFramed() )
5851 .toggleClass( 'oo-ui-popupButtonWidget-frameless-popup', !this.isFramed() );
5852 this.$overlay.append( this.popup.$element );
5853 };
5854
5855 /* Setup */
5856
5857 OO.inheritClass( OO.ui.PopupButtonWidget, OO.ui.ButtonWidget );
5858 OO.mixinClass( OO.ui.PopupButtonWidget, OO.ui.mixin.PopupElement );
5859
5860 /* Methods */
5861
5862 /**
5863 * Handle the button action being triggered.
5864 *
5865 * @private
5866 */
5867 OO.ui.PopupButtonWidget.prototype.onAction = function () {
5868 this.popup.toggle();
5869 };
5870
5871 /**
5872 * Mixin for OO.ui.Widget subclasses to provide OO.ui.mixin.GroupElement.
5873 *
5874 * Use together with OO.ui.mixin.ItemWidget to make disabled state inheritable.
5875 *
5876 * @private
5877 * @abstract
5878 * @class
5879 * @mixins OO.ui.mixin.GroupElement
5880 *
5881 * @constructor
5882 * @param {Object} [config] Configuration options
5883 */
5884 OO.ui.mixin.GroupWidget = function OoUiMixinGroupWidget( config ) {
5885 // Mixin constructors
5886 OO.ui.mixin.GroupElement.call( this, config );
5887 };
5888
5889 /* Setup */
5890
5891 OO.mixinClass( OO.ui.mixin.GroupWidget, OO.ui.mixin.GroupElement );
5892
5893 /* Methods */
5894
5895 /**
5896 * Set the disabled state of the widget.
5897 *
5898 * This will also update the disabled state of child widgets.
5899 *
5900 * @param {boolean} disabled Disable widget
5901 * @chainable
5902 */
5903 OO.ui.mixin.GroupWidget.prototype.setDisabled = function ( disabled ) {
5904 var i, len;
5905
5906 // Parent method
5907 // Note: Calling #setDisabled this way assumes this is mixed into an OO.ui.Widget
5908 OO.ui.Widget.prototype.setDisabled.call( this, disabled );
5909
5910 // During construction, #setDisabled is called before the OO.ui.mixin.GroupElement constructor
5911 if ( this.items ) {
5912 for ( i = 0, len = this.items.length; i < len; i++ ) {
5913 this.items[ i ].updateDisabled();
5914 }
5915 }
5916
5917 return this;
5918 };
5919
5920 /**
5921 * Mixin for widgets used as items in widgets that mix in OO.ui.mixin.GroupWidget.
5922 *
5923 * Item widgets have a reference to a OO.ui.mixin.GroupWidget while they are attached to the group. This
5924 * allows bidirectional communication.
5925 *
5926 * Use together with OO.ui.mixin.GroupWidget to make disabled state inheritable.
5927 *
5928 * @private
5929 * @abstract
5930 * @class
5931 *
5932 * @constructor
5933 */
5934 OO.ui.mixin.ItemWidget = function OoUiMixinItemWidget() {
5935 //
5936 };
5937
5938 /* Methods */
5939
5940 /**
5941 * Check if widget is disabled.
5942 *
5943 * Checks parent if present, making disabled state inheritable.
5944 *
5945 * @return {boolean} Widget is disabled
5946 */
5947 OO.ui.mixin.ItemWidget.prototype.isDisabled = function () {
5948 return this.disabled ||
5949 ( this.elementGroup instanceof OO.ui.Widget && this.elementGroup.isDisabled() );
5950 };
5951
5952 /**
5953 * Set group element is in.
5954 *
5955 * @param {OO.ui.mixin.GroupElement|null} group Group element, null if none
5956 * @chainable
5957 */
5958 OO.ui.mixin.ItemWidget.prototype.setElementGroup = function ( group ) {
5959 // Parent method
5960 // Note: Calling #setElementGroup this way assumes this is mixed into an OO.ui.Element
5961 OO.ui.Element.prototype.setElementGroup.call( this, group );
5962
5963 // Initialize item disabled states
5964 this.updateDisabled();
5965
5966 return this;
5967 };
5968
5969 /**
5970 * OptionWidgets are special elements that can be selected and configured with data. The
5971 * data is often unique for each option, but it does not have to be. OptionWidgets are used
5972 * with OO.ui.SelectWidget to create a selection of mutually exclusive options. For more information
5973 * and examples, please see the [OOUI documentation on MediaWiki][1].
5974 *
5975 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
5976 *
5977 * @class
5978 * @extends OO.ui.Widget
5979 * @mixins OO.ui.mixin.ItemWidget
5980 * @mixins OO.ui.mixin.LabelElement
5981 * @mixins OO.ui.mixin.FlaggedElement
5982 * @mixins OO.ui.mixin.AccessKeyedElement
5983 *
5984 * @constructor
5985 * @param {Object} [config] Configuration options
5986 */
5987 OO.ui.OptionWidget = function OoUiOptionWidget( config ) {
5988 // Configuration initialization
5989 config = config || {};
5990
5991 // Parent constructor
5992 OO.ui.OptionWidget.parent.call( this, config );
5993
5994 // Mixin constructors
5995 OO.ui.mixin.ItemWidget.call( this );
5996 OO.ui.mixin.LabelElement.call( this, config );
5997 OO.ui.mixin.FlaggedElement.call( this, config );
5998 OO.ui.mixin.AccessKeyedElement.call( this, config );
5999
6000 // Properties
6001 this.selected = false;
6002 this.highlighted = false;
6003 this.pressed = false;
6004
6005 // Initialization
6006 this.$element
6007 .data( 'oo-ui-optionWidget', this )
6008 // Allow programmatic focussing (and by accesskey), but not tabbing
6009 .attr( 'tabindex', '-1' )
6010 .attr( 'role', 'option' )
6011 .attr( 'aria-selected', 'false' )
6012 .addClass( 'oo-ui-optionWidget' )
6013 .append( this.$label );
6014 };
6015
6016 /* Setup */
6017
6018 OO.inheritClass( OO.ui.OptionWidget, OO.ui.Widget );
6019 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.ItemWidget );
6020 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.LabelElement );
6021 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.FlaggedElement );
6022 OO.mixinClass( OO.ui.OptionWidget, OO.ui.mixin.AccessKeyedElement );
6023
6024 /* Static Properties */
6025
6026 /**
6027 * Whether this option can be selected. See #setSelected.
6028 *
6029 * @static
6030 * @inheritable
6031 * @property {boolean}
6032 */
6033 OO.ui.OptionWidget.static.selectable = true;
6034
6035 /**
6036 * Whether this option can be highlighted. See #setHighlighted.
6037 *
6038 * @static
6039 * @inheritable
6040 * @property {boolean}
6041 */
6042 OO.ui.OptionWidget.static.highlightable = true;
6043
6044 /**
6045 * Whether this option can be pressed. See #setPressed.
6046 *
6047 * @static
6048 * @inheritable
6049 * @property {boolean}
6050 */
6051 OO.ui.OptionWidget.static.pressable = true;
6052
6053 /**
6054 * Whether this option will be scrolled into view when it is selected.
6055 *
6056 * @static
6057 * @inheritable
6058 * @property {boolean}
6059 */
6060 OO.ui.OptionWidget.static.scrollIntoViewOnSelect = false;
6061
6062 /* Methods */
6063
6064 /**
6065 * Check if the option can be selected.
6066 *
6067 * @return {boolean} Item is selectable
6068 */
6069 OO.ui.OptionWidget.prototype.isSelectable = function () {
6070 return this.constructor.static.selectable && !this.isDisabled() && this.isVisible();
6071 };
6072
6073 /**
6074 * Check if the option can be highlighted. A highlight indicates that the option
6075 * may be selected when a user presses enter or clicks. Disabled items cannot
6076 * be highlighted.
6077 *
6078 * @return {boolean} Item is highlightable
6079 */
6080 OO.ui.OptionWidget.prototype.isHighlightable = function () {
6081 return this.constructor.static.highlightable && !this.isDisabled() && this.isVisible();
6082 };
6083
6084 /**
6085 * Check if the option can be pressed. The pressed state occurs when a user mouses
6086 * down on an item, but has not yet let go of the mouse.
6087 *
6088 * @return {boolean} Item is pressable
6089 */
6090 OO.ui.OptionWidget.prototype.isPressable = function () {
6091 return this.constructor.static.pressable && !this.isDisabled() && this.isVisible();
6092 };
6093
6094 /**
6095 * Check if the option is selected.
6096 *
6097 * @return {boolean} Item is selected
6098 */
6099 OO.ui.OptionWidget.prototype.isSelected = function () {
6100 return this.selected;
6101 };
6102
6103 /**
6104 * Check if the option is highlighted. A highlight indicates that the
6105 * item may be selected when a user presses enter or clicks.
6106 *
6107 * @return {boolean} Item is highlighted
6108 */
6109 OO.ui.OptionWidget.prototype.isHighlighted = function () {
6110 return this.highlighted;
6111 };
6112
6113 /**
6114 * Check if the option is pressed. The pressed state occurs when a user mouses
6115 * down on an item, but has not yet let go of the mouse. The item may appear
6116 * selected, but it will not be selected until the user releases the mouse.
6117 *
6118 * @return {boolean} Item is pressed
6119 */
6120 OO.ui.OptionWidget.prototype.isPressed = function () {
6121 return this.pressed;
6122 };
6123
6124 /**
6125 * Set the option’s selected state. In general, all modifications to the selection
6126 * should be handled by the SelectWidget’s {@link OO.ui.SelectWidget#selectItem selectItem( [item] )}
6127 * method instead of this method.
6128 *
6129 * @param {boolean} [state=false] Select option
6130 * @chainable
6131 */
6132 OO.ui.OptionWidget.prototype.setSelected = function ( state ) {
6133 if ( this.constructor.static.selectable ) {
6134 this.selected = !!state;
6135 this.$element
6136 .toggleClass( 'oo-ui-optionWidget-selected', state )
6137 .attr( 'aria-selected', state.toString() );
6138 if ( state && this.constructor.static.scrollIntoViewOnSelect ) {
6139 this.scrollElementIntoView();
6140 }
6141 this.updateThemeClasses();
6142 }
6143 return this;
6144 };
6145
6146 /**
6147 * Set the option’s highlighted state. In general, all programmatic
6148 * modifications to the highlight should be handled by the
6149 * SelectWidget’s {@link OO.ui.SelectWidget#highlightItem highlightItem( [item] )}
6150 * method instead of this method.
6151 *
6152 * @param {boolean} [state=false] Highlight option
6153 * @chainable
6154 */
6155 OO.ui.OptionWidget.prototype.setHighlighted = function ( state ) {
6156 if ( this.constructor.static.highlightable ) {
6157 this.highlighted = !!state;
6158 this.$element.toggleClass( 'oo-ui-optionWidget-highlighted', state );
6159 this.updateThemeClasses();
6160 }
6161 return this;
6162 };
6163
6164 /**
6165 * Set the option’s pressed state. In general, all
6166 * programmatic modifications to the pressed state should be handled by the
6167 * SelectWidget’s {@link OO.ui.SelectWidget#pressItem pressItem( [item] )}
6168 * method instead of this method.
6169 *
6170 * @param {boolean} [state=false] Press option
6171 * @chainable
6172 */
6173 OO.ui.OptionWidget.prototype.setPressed = function ( state ) {
6174 if ( this.constructor.static.pressable ) {
6175 this.pressed = !!state;
6176 this.$element.toggleClass( 'oo-ui-optionWidget-pressed', state );
6177 this.updateThemeClasses();
6178 }
6179 return this;
6180 };
6181
6182 /**
6183 * Get text to match search strings against.
6184 *
6185 * The default implementation returns the label text, but subclasses
6186 * can override this to provide more complex behavior.
6187 *
6188 * @return {string|boolean} String to match search string against
6189 */
6190 OO.ui.OptionWidget.prototype.getMatchText = function () {
6191 var label = this.getLabel();
6192 return typeof label === 'string' ? label : this.$label.text();
6193 };
6194
6195 /**
6196 * A SelectWidget is of a generic selection of options. The OOUI library contains several types of
6197 * select widgets, including {@link OO.ui.ButtonSelectWidget button selects},
6198 * {@link OO.ui.RadioSelectWidget radio selects}, and {@link OO.ui.MenuSelectWidget
6199 * menu selects}.
6200 *
6201 * This class should be used together with OO.ui.OptionWidget or OO.ui.DecoratedOptionWidget. For more
6202 * information, please see the [OOUI documentation on MediaWiki][1].
6203 *
6204 * @example
6205 * // Example of a select widget with three options
6206 * var select = new OO.ui.SelectWidget( {
6207 * items: [
6208 * new OO.ui.OptionWidget( {
6209 * data: 'a',
6210 * label: 'Option One',
6211 * } ),
6212 * new OO.ui.OptionWidget( {
6213 * data: 'b',
6214 * label: 'Option Two',
6215 * } ),
6216 * new OO.ui.OptionWidget( {
6217 * data: 'c',
6218 * label: 'Option Three',
6219 * } )
6220 * ]
6221 * } );
6222 * $( 'body' ).append( select.$element );
6223 *
6224 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
6225 *
6226 * @abstract
6227 * @class
6228 * @extends OO.ui.Widget
6229 * @mixins OO.ui.mixin.GroupWidget
6230 *
6231 * @constructor
6232 * @param {Object} [config] Configuration options
6233 * @cfg {OO.ui.OptionWidget[]} [items] An array of options to add to the select.
6234 * Options are created with {@link OO.ui.OptionWidget OptionWidget} classes. See
6235 * the [OOUI documentation on MediaWiki] [2] for examples.
6236 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
6237 */
6238 OO.ui.SelectWidget = function OoUiSelectWidget( config ) {
6239 // Configuration initialization
6240 config = config || {};
6241
6242 // Parent constructor
6243 OO.ui.SelectWidget.parent.call( this, config );
6244
6245 // Mixin constructors
6246 OO.ui.mixin.GroupWidget.call( this, $.extend( {}, config, { $group: this.$element } ) );
6247
6248 // Properties
6249 this.pressed = false;
6250 this.selecting = null;
6251 this.onMouseUpHandler = this.onMouseUp.bind( this );
6252 this.onMouseMoveHandler = this.onMouseMove.bind( this );
6253 this.onKeyDownHandler = this.onKeyDown.bind( this );
6254 this.onKeyPressHandler = this.onKeyPress.bind( this );
6255 this.keyPressBuffer = '';
6256 this.keyPressBufferTimer = null;
6257 this.blockMouseOverEvents = 0;
6258
6259 // Events
6260 this.connect( this, {
6261 toggle: 'onToggle'
6262 } );
6263 this.$element.on( {
6264 focusin: this.onFocus.bind( this ),
6265 mousedown: this.onMouseDown.bind( this ),
6266 mouseover: this.onMouseOver.bind( this ),
6267 mouseleave: this.onMouseLeave.bind( this )
6268 } );
6269
6270 // Initialization
6271 this.$element
6272 .addClass( 'oo-ui-selectWidget oo-ui-selectWidget-depressed' )
6273 .attr( 'role', 'listbox' );
6274 this.setFocusOwner( this.$element );
6275 if ( Array.isArray( config.items ) ) {
6276 this.addItems( config.items );
6277 }
6278 };
6279
6280 /* Setup */
6281
6282 OO.inheritClass( OO.ui.SelectWidget, OO.ui.Widget );
6283 OO.mixinClass( OO.ui.SelectWidget, OO.ui.mixin.GroupWidget );
6284
6285 /* Events */
6286
6287 /**
6288 * @event highlight
6289 *
6290 * A `highlight` event is emitted when the highlight is changed with the #highlightItem method.
6291 *
6292 * @param {OO.ui.OptionWidget|null} item Highlighted item
6293 */
6294
6295 /**
6296 * @event press
6297 *
6298 * A `press` event is emitted when the #pressItem method is used to programmatically modify the
6299 * pressed state of an option.
6300 *
6301 * @param {OO.ui.OptionWidget|null} item Pressed item
6302 */
6303
6304 /**
6305 * @event select
6306 *
6307 * A `select` event is emitted when the selection is modified programmatically with the #selectItem method.
6308 *
6309 * @param {OO.ui.OptionWidget|null} item Selected item
6310 */
6311
6312 /**
6313 * @event choose
6314 * A `choose` event is emitted when an item is chosen with the #chooseItem method.
6315 * @param {OO.ui.OptionWidget} item Chosen item
6316 */
6317
6318 /**
6319 * @event add
6320 *
6321 * An `add` event is emitted when options are added to the select with the #addItems method.
6322 *
6323 * @param {OO.ui.OptionWidget[]} items Added items
6324 * @param {number} index Index of insertion point
6325 */
6326
6327 /**
6328 * @event remove
6329 *
6330 * A `remove` event is emitted when options are removed from the select with the #clearItems
6331 * or #removeItems methods.
6332 *
6333 * @param {OO.ui.OptionWidget[]} items Removed items
6334 */
6335
6336 /* Methods */
6337
6338 /**
6339 * Handle focus events
6340 *
6341 * @private
6342 * @param {jQuery.Event} event
6343 */
6344 OO.ui.SelectWidget.prototype.onFocus = function ( event ) {
6345 var item;
6346 if ( event.target === this.$element[ 0 ] ) {
6347 // This widget was focussed, e.g. by the user tabbing to it.
6348 // The styles for focus state depend on one of the items being selected.
6349 if ( !this.findSelectedItem() ) {
6350 item = this.findFirstSelectableItem();
6351 }
6352 } else {
6353 if ( event.target.tabIndex === -1 ) {
6354 // One of the options got focussed (and the event bubbled up here).
6355 // They can't be tabbed to, but they can be activated using accesskeys.
6356 // OptionWidgets and focusable UI elements inside them have tabindex="-1" set.
6357 item = this.findTargetItem( event );
6358 } else {
6359 // There is something actually user-focusable in one of the labels of the options, and the
6360 // user focussed it (e.g. by tabbing to it). Do nothing (especially, don't change the focus).
6361 return;
6362 }
6363 }
6364
6365 if ( item ) {
6366 if ( item.constructor.static.highlightable ) {
6367 this.highlightItem( item );
6368 } else {
6369 this.selectItem( item );
6370 }
6371 }
6372
6373 if ( event.target !== this.$element[ 0 ] ) {
6374 this.$focusOwner.focus();
6375 }
6376 };
6377
6378 /**
6379 * Handle mouse down events.
6380 *
6381 * @private
6382 * @param {jQuery.Event} e Mouse down event
6383 */
6384 OO.ui.SelectWidget.prototype.onMouseDown = function ( e ) {
6385 var item;
6386
6387 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
6388 this.togglePressed( true );
6389 item = this.findTargetItem( e );
6390 if ( item && item.isSelectable() ) {
6391 this.pressItem( item );
6392 this.selecting = item;
6393 this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler, true );
6394 this.getElementDocument().addEventListener( 'mousemove', this.onMouseMoveHandler, true );
6395 }
6396 }
6397 return false;
6398 };
6399
6400 /**
6401 * Handle mouse up events.
6402 *
6403 * @private
6404 * @param {MouseEvent} e Mouse up event
6405 */
6406 OO.ui.SelectWidget.prototype.onMouseUp = function ( e ) {
6407 var item;
6408
6409 this.togglePressed( false );
6410 if ( !this.selecting ) {
6411 item = this.findTargetItem( e );
6412 if ( item && item.isSelectable() ) {
6413 this.selecting = item;
6414 }
6415 }
6416 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT && this.selecting ) {
6417 this.pressItem( null );
6418 this.chooseItem( this.selecting );
6419 this.selecting = null;
6420 }
6421
6422 this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler, true );
6423 this.getElementDocument().removeEventListener( 'mousemove', this.onMouseMoveHandler, true );
6424
6425 return false;
6426 };
6427
6428 /**
6429 * Handle mouse move events.
6430 *
6431 * @private
6432 * @param {MouseEvent} e Mouse move event
6433 */
6434 OO.ui.SelectWidget.prototype.onMouseMove = function ( e ) {
6435 var item;
6436
6437 if ( !this.isDisabled() && this.pressed ) {
6438 item = this.findTargetItem( e );
6439 if ( item && item !== this.selecting && item.isSelectable() ) {
6440 this.pressItem( item );
6441 this.selecting = item;
6442 }
6443 }
6444 };
6445
6446 /**
6447 * Handle mouse over events.
6448 *
6449 * @private
6450 * @param {jQuery.Event} e Mouse over event
6451 */
6452 OO.ui.SelectWidget.prototype.onMouseOver = function ( e ) {
6453 var item;
6454 if ( this.blockMouseOverEvents ) {
6455 return;
6456 }
6457 if ( !this.isDisabled() ) {
6458 item = this.findTargetItem( e );
6459 this.highlightItem( item && item.isHighlightable() ? item : null );
6460 }
6461 return false;
6462 };
6463
6464 /**
6465 * Handle mouse leave events.
6466 *
6467 * @private
6468 * @param {jQuery.Event} e Mouse over event
6469 */
6470 OO.ui.SelectWidget.prototype.onMouseLeave = function () {
6471 if ( !this.isDisabled() ) {
6472 this.highlightItem( null );
6473 }
6474 return false;
6475 };
6476
6477 /**
6478 * Handle key down events.
6479 *
6480 * @protected
6481 * @param {KeyboardEvent} e Key down event
6482 */
6483 OO.ui.SelectWidget.prototype.onKeyDown = function ( e ) {
6484 var nextItem,
6485 handled = false,
6486 currentItem = this.findHighlightedItem() || this.findSelectedItem();
6487
6488 if ( !this.isDisabled() && this.isVisible() ) {
6489 switch ( e.keyCode ) {
6490 case OO.ui.Keys.ENTER:
6491 if ( currentItem && currentItem.constructor.static.highlightable ) {
6492 // Was only highlighted, now let's select it. No-op if already selected.
6493 this.chooseItem( currentItem );
6494 handled = true;
6495 }
6496 break;
6497 case OO.ui.Keys.UP:
6498 case OO.ui.Keys.LEFT:
6499 this.clearKeyPressBuffer();
6500 nextItem = this.findRelativeSelectableItem( currentItem, -1 );
6501 handled = true;
6502 break;
6503 case OO.ui.Keys.DOWN:
6504 case OO.ui.Keys.RIGHT:
6505 this.clearKeyPressBuffer();
6506 nextItem = this.findRelativeSelectableItem( currentItem, 1 );
6507 handled = true;
6508 break;
6509 case OO.ui.Keys.ESCAPE:
6510 case OO.ui.Keys.TAB:
6511 if ( currentItem && currentItem.constructor.static.highlightable ) {
6512 currentItem.setHighlighted( false );
6513 }
6514 this.unbindKeyDownListener();
6515 this.unbindKeyPressListener();
6516 // Don't prevent tabbing away / defocusing
6517 handled = false;
6518 break;
6519 }
6520
6521 if ( nextItem ) {
6522 if ( nextItem.constructor.static.highlightable ) {
6523 this.highlightItem( nextItem );
6524 } else {
6525 this.chooseItem( nextItem );
6526 }
6527 this.scrollItemIntoView( nextItem );
6528 }
6529
6530 if ( handled ) {
6531 e.preventDefault();
6532 e.stopPropagation();
6533 }
6534 }
6535 };
6536
6537 /**
6538 * Bind key down listener.
6539 *
6540 * @protected
6541 */
6542 OO.ui.SelectWidget.prototype.bindKeyDownListener = function () {
6543 this.getElementWindow().addEventListener( 'keydown', this.onKeyDownHandler, true );
6544 };
6545
6546 /**
6547 * Unbind key down listener.
6548 *
6549 * @protected
6550 */
6551 OO.ui.SelectWidget.prototype.unbindKeyDownListener = function () {
6552 this.getElementWindow().removeEventListener( 'keydown', this.onKeyDownHandler, true );
6553 };
6554
6555 /**
6556 * Scroll item into view, preventing spurious mouse highlight actions from happening.
6557 *
6558 * @param {OO.ui.OptionWidget} item Item to scroll into view
6559 */
6560 OO.ui.SelectWidget.prototype.scrollItemIntoView = function ( item ) {
6561 var widget = this;
6562 // Chromium's Blink engine will generate spurious 'mouseover' events during programmatic scrolling
6563 // and around 100-150 ms after it is finished.
6564 this.blockMouseOverEvents++;
6565 item.scrollElementIntoView().done( function () {
6566 setTimeout( function () {
6567 widget.blockMouseOverEvents--;
6568 }, 200 );
6569 } );
6570 };
6571
6572 /**
6573 * Clear the key-press buffer
6574 *
6575 * @protected
6576 */
6577 OO.ui.SelectWidget.prototype.clearKeyPressBuffer = function () {
6578 if ( this.keyPressBufferTimer ) {
6579 clearTimeout( this.keyPressBufferTimer );
6580 this.keyPressBufferTimer = null;
6581 }
6582 this.keyPressBuffer = '';
6583 };
6584
6585 /**
6586 * Handle key press events.
6587 *
6588 * @protected
6589 * @param {KeyboardEvent} e Key press event
6590 */
6591 OO.ui.SelectWidget.prototype.onKeyPress = function ( e ) {
6592 var c, filter, item;
6593
6594 if ( !e.charCode ) {
6595 if ( e.keyCode === OO.ui.Keys.BACKSPACE && this.keyPressBuffer !== '' ) {
6596 this.keyPressBuffer = this.keyPressBuffer.substr( 0, this.keyPressBuffer.length - 1 );
6597 return false;
6598 }
6599 return;
6600 }
6601 if ( String.fromCodePoint ) {
6602 c = String.fromCodePoint( e.charCode );
6603 } else {
6604 c = String.fromCharCode( e.charCode );
6605 }
6606
6607 if ( this.keyPressBufferTimer ) {
6608 clearTimeout( this.keyPressBufferTimer );
6609 }
6610 this.keyPressBufferTimer = setTimeout( this.clearKeyPressBuffer.bind( this ), 1500 );
6611
6612 item = this.findHighlightedItem() || this.findSelectedItem();
6613
6614 if ( this.keyPressBuffer === c ) {
6615 // Common (if weird) special case: typing "xxxx" will cycle through all
6616 // the items beginning with "x".
6617 if ( item ) {
6618 item = this.findRelativeSelectableItem( item, 1 );
6619 }
6620 } else {
6621 this.keyPressBuffer += c;
6622 }
6623
6624 filter = this.getItemMatcher( this.keyPressBuffer, false );
6625 if ( !item || !filter( item ) ) {
6626 item = this.findRelativeSelectableItem( item, 1, filter );
6627 }
6628 if ( item ) {
6629 if ( this.isVisible() && item.constructor.static.highlightable ) {
6630 this.highlightItem( item );
6631 } else {
6632 this.chooseItem( item );
6633 }
6634 this.scrollItemIntoView( item );
6635 }
6636
6637 e.preventDefault();
6638 e.stopPropagation();
6639 };
6640
6641 /**
6642 * Get a matcher for the specific string
6643 *
6644 * @protected
6645 * @param {string} s String to match against items
6646 * @param {boolean} [exact=false] Only accept exact matches
6647 * @return {Function} function ( OO.ui.OptionWidget ) => boolean
6648 */
6649 OO.ui.SelectWidget.prototype.getItemMatcher = function ( s, exact ) {
6650 var re;
6651
6652 if ( s.normalize ) {
6653 s = s.normalize();
6654 }
6655 s = exact ? s.trim() : s.replace( /^\s+/, '' );
6656 re = '^\\s*' + s.replace( /([\\{}()|.?*+\-^$[\]])/g, '\\$1' ).replace( /\s+/g, '\\s+' );
6657 if ( exact ) {
6658 re += '\\s*$';
6659 }
6660 re = new RegExp( re, 'i' );
6661 return function ( item ) {
6662 var matchText = item.getMatchText();
6663 if ( matchText.normalize ) {
6664 matchText = matchText.normalize();
6665 }
6666 return re.test( matchText );
6667 };
6668 };
6669
6670 /**
6671 * Bind key press listener.
6672 *
6673 * @protected
6674 */
6675 OO.ui.SelectWidget.prototype.bindKeyPressListener = function () {
6676 this.getElementWindow().addEventListener( 'keypress', this.onKeyPressHandler, true );
6677 };
6678
6679 /**
6680 * Unbind key down listener.
6681 *
6682 * If you override this, be sure to call this.clearKeyPressBuffer() from your
6683 * implementation.
6684 *
6685 * @protected
6686 */
6687 OO.ui.SelectWidget.prototype.unbindKeyPressListener = function () {
6688 this.getElementWindow().removeEventListener( 'keypress', this.onKeyPressHandler, true );
6689 this.clearKeyPressBuffer();
6690 };
6691
6692 /**
6693 * Visibility change handler
6694 *
6695 * @protected
6696 * @param {boolean} visible
6697 */
6698 OO.ui.SelectWidget.prototype.onToggle = function ( visible ) {
6699 if ( !visible ) {
6700 this.clearKeyPressBuffer();
6701 }
6702 };
6703
6704 /**
6705 * Get the closest item to a jQuery.Event.
6706 *
6707 * @private
6708 * @param {jQuery.Event} e
6709 * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
6710 */
6711 OO.ui.SelectWidget.prototype.findTargetItem = function ( e ) {
6712 var $option = $( e.target ).closest( '.oo-ui-optionWidget' );
6713 if ( !$option.closest( '.oo-ui-selectWidget' ).is( this.$element ) ) {
6714 return null;
6715 }
6716 return $option.data( 'oo-ui-optionWidget' ) || null;
6717 };
6718
6719 /**
6720 * Find selected item.
6721 *
6722 * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
6723 */
6724 OO.ui.SelectWidget.prototype.findSelectedItem = function () {
6725 var i, len;
6726
6727 for ( i = 0, len = this.items.length; i < len; i++ ) {
6728 if ( this.items[ i ].isSelected() ) {
6729 return this.items[ i ];
6730 }
6731 }
6732 return null;
6733 };
6734
6735 /**
6736 * Get selected item.
6737 *
6738 * @deprecated Since v0.25.0; use {@link #findSelectedItem} instead.
6739 * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
6740 */
6741 OO.ui.SelectWidget.prototype.getSelectedItem = function () {
6742 OO.ui.warnDeprecation( 'SelectWidget#getSelectedItem: Deprecated function. Use findSelectedItem instead. See T76630.' );
6743 return this.findSelectedItem();
6744 };
6745
6746 /**
6747 * Find highlighted item.
6748 *
6749 * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
6750 */
6751 OO.ui.SelectWidget.prototype.findHighlightedItem = function () {
6752 var i, len;
6753
6754 for ( i = 0, len = this.items.length; i < len; i++ ) {
6755 if ( this.items[ i ].isHighlighted() ) {
6756 return this.items[ i ];
6757 }
6758 }
6759 return null;
6760 };
6761
6762 /**
6763 * Toggle pressed state.
6764 *
6765 * Press is a state that occurs when a user mouses down on an item, but
6766 * has not yet let go of the mouse. The item may appear selected, but it will not be selected
6767 * until the user releases the mouse.
6768 *
6769 * @param {boolean} pressed An option is being pressed
6770 */
6771 OO.ui.SelectWidget.prototype.togglePressed = function ( pressed ) {
6772 if ( pressed === undefined ) {
6773 pressed = !this.pressed;
6774 }
6775 if ( pressed !== this.pressed ) {
6776 this.$element
6777 .toggleClass( 'oo-ui-selectWidget-pressed', pressed )
6778 .toggleClass( 'oo-ui-selectWidget-depressed', !pressed );
6779 this.pressed = pressed;
6780 }
6781 };
6782
6783 /**
6784 * Highlight an option. If the `item` param is omitted, no options will be highlighted
6785 * and any existing highlight will be removed. The highlight is mutually exclusive.
6786 *
6787 * @param {OO.ui.OptionWidget} [item] Item to highlight, omit for no highlight
6788 * @fires highlight
6789 * @chainable
6790 */
6791 OO.ui.SelectWidget.prototype.highlightItem = function ( item ) {
6792 var i, len, highlighted,
6793 changed = false;
6794
6795 for ( i = 0, len = this.items.length; i < len; i++ ) {
6796 highlighted = this.items[ i ] === item;
6797 if ( this.items[ i ].isHighlighted() !== highlighted ) {
6798 this.items[ i ].setHighlighted( highlighted );
6799 changed = true;
6800 }
6801 }
6802 if ( changed ) {
6803 if ( item ) {
6804 this.$focusOwner.attr( 'aria-activedescendant', item.getElementId() );
6805 } else {
6806 this.$focusOwner.removeAttr( 'aria-activedescendant' );
6807 }
6808 this.emit( 'highlight', item );
6809 }
6810
6811 return this;
6812 };
6813
6814 /**
6815 * Fetch an item by its label.
6816 *
6817 * @param {string} label Label of the item to select.
6818 * @param {boolean} [prefix=false] Allow a prefix match, if only a single item matches
6819 * @return {OO.ui.Element|null} Item with equivalent label, `null` if none exists
6820 */
6821 OO.ui.SelectWidget.prototype.getItemFromLabel = function ( label, prefix ) {
6822 var i, item, found,
6823 len = this.items.length,
6824 filter = this.getItemMatcher( label, true );
6825
6826 for ( i = 0; i < len; i++ ) {
6827 item = this.items[ i ];
6828 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() && filter( item ) ) {
6829 return item;
6830 }
6831 }
6832
6833 if ( prefix ) {
6834 found = null;
6835 filter = this.getItemMatcher( label, false );
6836 for ( i = 0; i < len; i++ ) {
6837 item = this.items[ i ];
6838 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() && filter( item ) ) {
6839 if ( found ) {
6840 return null;
6841 }
6842 found = item;
6843 }
6844 }
6845 if ( found ) {
6846 return found;
6847 }
6848 }
6849
6850 return null;
6851 };
6852
6853 /**
6854 * Programmatically select an option by its label. If the item does not exist,
6855 * all options will be deselected.
6856 *
6857 * @param {string} [label] Label of the item to select.
6858 * @param {boolean} [prefix=false] Allow a prefix match, if only a single item matches
6859 * @fires select
6860 * @chainable
6861 */
6862 OO.ui.SelectWidget.prototype.selectItemByLabel = function ( label, prefix ) {
6863 var itemFromLabel = this.getItemFromLabel( label, !!prefix );
6864 if ( label === undefined || !itemFromLabel ) {
6865 return this.selectItem();
6866 }
6867 return this.selectItem( itemFromLabel );
6868 };
6869
6870 /**
6871 * Programmatically select an option by its data. If the `data` parameter is omitted,
6872 * or if the item does not exist, all options will be deselected.
6873 *
6874 * @param {Object|string} [data] Value of the item to select, omit to deselect all
6875 * @fires select
6876 * @chainable
6877 */
6878 OO.ui.SelectWidget.prototype.selectItemByData = function ( data ) {
6879 var itemFromData = this.findItemFromData( data );
6880 if ( data === undefined || !itemFromData ) {
6881 return this.selectItem();
6882 }
6883 return this.selectItem( itemFromData );
6884 };
6885
6886 /**
6887 * Programmatically select an option by its reference. If the `item` parameter is omitted,
6888 * all options will be deselected.
6889 *
6890 * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
6891 * @fires select
6892 * @chainable
6893 */
6894 OO.ui.SelectWidget.prototype.selectItem = function ( item ) {
6895 var i, len, selected,
6896 changed = false;
6897
6898 for ( i = 0, len = this.items.length; i < len; i++ ) {
6899 selected = this.items[ i ] === item;
6900 if ( this.items[ i ].isSelected() !== selected ) {
6901 this.items[ i ].setSelected( selected );
6902 changed = true;
6903 }
6904 }
6905 if ( changed ) {
6906 if ( item && !item.constructor.static.highlightable ) {
6907 if ( item ) {
6908 this.$focusOwner.attr( 'aria-activedescendant', item.getElementId() );
6909 } else {
6910 this.$focusOwner.removeAttr( 'aria-activedescendant' );
6911 }
6912 }
6913 this.emit( 'select', item );
6914 }
6915
6916 return this;
6917 };
6918
6919 /**
6920 * Press an item.
6921 *
6922 * Press is a state that occurs when a user mouses down on an item, but has not
6923 * yet let go of the mouse. The item may appear selected, but it will not be selected until the user
6924 * releases the mouse.
6925 *
6926 * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
6927 * @fires press
6928 * @chainable
6929 */
6930 OO.ui.SelectWidget.prototype.pressItem = function ( item ) {
6931 var i, len, pressed,
6932 changed = false;
6933
6934 for ( i = 0, len = this.items.length; i < len; i++ ) {
6935 pressed = this.items[ i ] === item;
6936 if ( this.items[ i ].isPressed() !== pressed ) {
6937 this.items[ i ].setPressed( pressed );
6938 changed = true;
6939 }
6940 }
6941 if ( changed ) {
6942 this.emit( 'press', item );
6943 }
6944
6945 return this;
6946 };
6947
6948 /**
6949 * Choose an item.
6950 *
6951 * Note that ‘choose’ should never be modified programmatically. A user can choose
6952 * an option with the keyboard or mouse and it becomes selected. To select an item programmatically,
6953 * use the #selectItem method.
6954 *
6955 * This method is identical to #selectItem, but may vary in subclasses that take additional action
6956 * when users choose an item with the keyboard or mouse.
6957 *
6958 * @param {OO.ui.OptionWidget} item Item to choose
6959 * @fires choose
6960 * @chainable
6961 */
6962 OO.ui.SelectWidget.prototype.chooseItem = function ( item ) {
6963 if ( item ) {
6964 this.selectItem( item );
6965 this.emit( 'choose', item );
6966 }
6967
6968 return this;
6969 };
6970
6971 /**
6972 * Find an option by its position relative to the specified item (or to the start of the option array,
6973 * if item is `null`). The direction in which to search through the option array is specified with a
6974 * number: -1 for reverse (the default) or 1 for forward. The method will return an option, or
6975 * `null` if there are no options in the array.
6976 *
6977 * @param {OO.ui.OptionWidget|null} item Item to describe the start position, or `null` to start at the beginning of the array.
6978 * @param {number} direction Direction to move in: -1 to move backward, 1 to move forward
6979 * @param {Function} [filter] Only consider items for which this function returns
6980 * true. Function takes an OO.ui.OptionWidget and returns a boolean.
6981 * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the select
6982 */
6983 OO.ui.SelectWidget.prototype.findRelativeSelectableItem = function ( item, direction, filter ) {
6984 var currentIndex, nextIndex, i,
6985 increase = direction > 0 ? 1 : -1,
6986 len = this.items.length;
6987
6988 if ( item instanceof OO.ui.OptionWidget ) {
6989 currentIndex = this.items.indexOf( item );
6990 nextIndex = ( currentIndex + increase + len ) % len;
6991 } else {
6992 // If no item is selected and moving forward, start at the beginning.
6993 // If moving backward, start at the end.
6994 nextIndex = direction > 0 ? 0 : len - 1;
6995 }
6996
6997 for ( i = 0; i < len; i++ ) {
6998 item = this.items[ nextIndex ];
6999 if (
7000 item instanceof OO.ui.OptionWidget && item.isSelectable() &&
7001 ( !filter || filter( item ) )
7002 ) {
7003 return item;
7004 }
7005 nextIndex = ( nextIndex + increase + len ) % len;
7006 }
7007 return null;
7008 };
7009
7010 /**
7011 * Find the next selectable item or `null` if there are no selectable items.
7012 * Disabled options and menu-section markers and breaks are not selectable.
7013 *
7014 * @return {OO.ui.OptionWidget|null} Item, `null` if there aren't any selectable items
7015 */
7016 OO.ui.SelectWidget.prototype.findFirstSelectableItem = function () {
7017 return this.findRelativeSelectableItem( null, 1 );
7018 };
7019
7020 /**
7021 * Add an array of options to the select. Optionally, an index number can be used to
7022 * specify an insertion point.
7023 *
7024 * @param {OO.ui.OptionWidget[]} items Items to add
7025 * @param {number} [index] Index to insert items after
7026 * @fires add
7027 * @chainable
7028 */
7029 OO.ui.SelectWidget.prototype.addItems = function ( items, index ) {
7030 // Mixin method
7031 OO.ui.mixin.GroupWidget.prototype.addItems.call( this, items, index );
7032
7033 // Always provide an index, even if it was omitted
7034 this.emit( 'add', items, index === undefined ? this.items.length - items.length - 1 : index );
7035
7036 return this;
7037 };
7038
7039 /**
7040 * Remove the specified array of options from the select. Options will be detached
7041 * from the DOM, not removed, so they can be reused later. To remove all options from
7042 * the select, you may wish to use the #clearItems method instead.
7043 *
7044 * @param {OO.ui.OptionWidget[]} items Items to remove
7045 * @fires remove
7046 * @chainable
7047 */
7048 OO.ui.SelectWidget.prototype.removeItems = function ( items ) {
7049 var i, len, item;
7050
7051 // Deselect items being removed
7052 for ( i = 0, len = items.length; i < len; i++ ) {
7053 item = items[ i ];
7054 if ( item.isSelected() ) {
7055 this.selectItem( null );
7056 }
7057 }
7058
7059 // Mixin method
7060 OO.ui.mixin.GroupWidget.prototype.removeItems.call( this, items );
7061
7062 this.emit( 'remove', items );
7063
7064 return this;
7065 };
7066
7067 /**
7068 * Clear all options from the select. Options will be detached from the DOM, not removed,
7069 * so that they can be reused later. To remove a subset of options from the select, use
7070 * the #removeItems method.
7071 *
7072 * @fires remove
7073 * @chainable
7074 */
7075 OO.ui.SelectWidget.prototype.clearItems = function () {
7076 var items = this.items.slice();
7077
7078 // Mixin method
7079 OO.ui.mixin.GroupWidget.prototype.clearItems.call( this );
7080
7081 // Clear selection
7082 this.selectItem( null );
7083
7084 this.emit( 'remove', items );
7085
7086 return this;
7087 };
7088
7089 /**
7090 * Set the DOM element which has focus while the user is interacting with this SelectWidget.
7091 *
7092 * Currently this is just used to set `aria-activedescendant` on it.
7093 *
7094 * @protected
7095 * @param {jQuery} $focusOwner
7096 */
7097 OO.ui.SelectWidget.prototype.setFocusOwner = function ( $focusOwner ) {
7098 this.$focusOwner = $focusOwner;
7099 };
7100
7101 /**
7102 * DecoratedOptionWidgets are {@link OO.ui.OptionWidget options} that can be configured
7103 * with an {@link OO.ui.mixin.IconElement icon} and/or {@link OO.ui.mixin.IndicatorElement indicator}.
7104 * This class is used with OO.ui.SelectWidget to create a selection of mutually exclusive
7105 * options. For more information about options and selects, please see the
7106 * [OOUI documentation on MediaWiki][1].
7107 *
7108 * @example
7109 * // Decorated options in a select widget
7110 * var select = new OO.ui.SelectWidget( {
7111 * items: [
7112 * new OO.ui.DecoratedOptionWidget( {
7113 * data: 'a',
7114 * label: 'Option with icon',
7115 * icon: 'help'
7116 * } ),
7117 * new OO.ui.DecoratedOptionWidget( {
7118 * data: 'b',
7119 * label: 'Option with indicator',
7120 * indicator: 'next'
7121 * } )
7122 * ]
7123 * } );
7124 * $( 'body' ).append( select.$element );
7125 *
7126 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
7127 *
7128 * @class
7129 * @extends OO.ui.OptionWidget
7130 * @mixins OO.ui.mixin.IconElement
7131 * @mixins OO.ui.mixin.IndicatorElement
7132 *
7133 * @constructor
7134 * @param {Object} [config] Configuration options
7135 */
7136 OO.ui.DecoratedOptionWidget = function OoUiDecoratedOptionWidget( config ) {
7137 // Parent constructor
7138 OO.ui.DecoratedOptionWidget.parent.call( this, config );
7139
7140 // Mixin constructors
7141 OO.ui.mixin.IconElement.call( this, config );
7142 OO.ui.mixin.IndicatorElement.call( this, config );
7143
7144 // Initialization
7145 this.$element
7146 .addClass( 'oo-ui-decoratedOptionWidget' )
7147 .prepend( this.$icon )
7148 .append( this.$indicator );
7149 };
7150
7151 /* Setup */
7152
7153 OO.inheritClass( OO.ui.DecoratedOptionWidget, OO.ui.OptionWidget );
7154 OO.mixinClass( OO.ui.DecoratedOptionWidget, OO.ui.mixin.IconElement );
7155 OO.mixinClass( OO.ui.DecoratedOptionWidget, OO.ui.mixin.IndicatorElement );
7156
7157 /**
7158 * MenuOptionWidget is an option widget that looks like a menu item. The class is used with
7159 * OO.ui.MenuSelectWidget to create a menu of mutually exclusive options. Please see
7160 * the [OOUI documentation on MediaWiki] [1] for more information.
7161 *
7162 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Menu_selects_and_options
7163 *
7164 * @class
7165 * @extends OO.ui.DecoratedOptionWidget
7166 *
7167 * @constructor
7168 * @param {Object} [config] Configuration options
7169 */
7170 OO.ui.MenuOptionWidget = function OoUiMenuOptionWidget( config ) {
7171 // Parent constructor
7172 OO.ui.MenuOptionWidget.parent.call( this, config );
7173
7174 // Initialization
7175 this.$element.addClass( 'oo-ui-menuOptionWidget' );
7176 };
7177
7178 /* Setup */
7179
7180 OO.inheritClass( OO.ui.MenuOptionWidget, OO.ui.DecoratedOptionWidget );
7181
7182 /* Static Properties */
7183
7184 /**
7185 * @static
7186 * @inheritdoc
7187 */
7188 OO.ui.MenuOptionWidget.static.scrollIntoViewOnSelect = true;
7189
7190 /**
7191 * MenuSectionOptionWidgets are used inside {@link OO.ui.MenuSelectWidget menu select widgets} to group one or more related
7192 * {@link OO.ui.MenuOptionWidget menu options}. MenuSectionOptionWidgets cannot be highlighted or selected.
7193 *
7194 * @example
7195 * var myDropdown = new OO.ui.DropdownWidget( {
7196 * menu: {
7197 * items: [
7198 * new OO.ui.MenuSectionOptionWidget( {
7199 * label: 'Dogs'
7200 * } ),
7201 * new OO.ui.MenuOptionWidget( {
7202 * data: 'corgi',
7203 * label: 'Welsh Corgi'
7204 * } ),
7205 * new OO.ui.MenuOptionWidget( {
7206 * data: 'poodle',
7207 * label: 'Standard Poodle'
7208 * } ),
7209 * new OO.ui.MenuSectionOptionWidget( {
7210 * label: 'Cats'
7211 * } ),
7212 * new OO.ui.MenuOptionWidget( {
7213 * data: 'lion',
7214 * label: 'Lion'
7215 * } )
7216 * ]
7217 * }
7218 * } );
7219 * $( 'body' ).append( myDropdown.$element );
7220 *
7221 * @class
7222 * @extends OO.ui.DecoratedOptionWidget
7223 *
7224 * @constructor
7225 * @param {Object} [config] Configuration options
7226 */
7227 OO.ui.MenuSectionOptionWidget = function OoUiMenuSectionOptionWidget( config ) {
7228 // Parent constructor
7229 OO.ui.MenuSectionOptionWidget.parent.call( this, config );
7230
7231 // Initialization
7232 this.$element.addClass( 'oo-ui-menuSectionOptionWidget' )
7233 .removeAttr( 'role aria-selected' );
7234 };
7235
7236 /* Setup */
7237
7238 OO.inheritClass( OO.ui.MenuSectionOptionWidget, OO.ui.DecoratedOptionWidget );
7239
7240 /* Static Properties */
7241
7242 /**
7243 * @static
7244 * @inheritdoc
7245 */
7246 OO.ui.MenuSectionOptionWidget.static.selectable = false;
7247
7248 /**
7249 * @static
7250 * @inheritdoc
7251 */
7252 OO.ui.MenuSectionOptionWidget.static.highlightable = false;
7253
7254 /**
7255 * MenuSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains options and
7256 * is used together with OO.ui.MenuOptionWidget. It is designed be used as part of another widget.
7257 * See {@link OO.ui.DropdownWidget DropdownWidget}, {@link OO.ui.ComboBoxInputWidget ComboBoxInputWidget},
7258 * and {@link OO.ui.mixin.LookupElement LookupElement} for examples of widgets that contain menus.
7259 * MenuSelectWidgets themselves are not instantiated directly, rather subclassed
7260 * and customized to be opened, closed, and displayed as needed.
7261 *
7262 * By default, menus are clipped to the visible viewport and are not visible when a user presses the
7263 * mouse outside the menu.
7264 *
7265 * Menus also have support for keyboard interaction:
7266 *
7267 * - Enter/Return key: choose and select a menu option
7268 * - Up-arrow key: highlight the previous menu option
7269 * - Down-arrow key: highlight the next menu option
7270 * - Esc key: hide the menu
7271 *
7272 * Unlike most widgets, MenuSelectWidget is initially hidden and must be shown by calling #toggle.
7273 *
7274 * Please see the [OOUI documentation on MediaWiki][1] for more information.
7275 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
7276 *
7277 * @class
7278 * @extends OO.ui.SelectWidget
7279 * @mixins OO.ui.mixin.ClippableElement
7280 * @mixins OO.ui.mixin.FloatableElement
7281 *
7282 * @constructor
7283 * @param {Object} [config] Configuration options
7284 * @cfg {OO.ui.TextInputWidget} [input] Text input used to implement option highlighting for menu items that match
7285 * the text the user types. This config is used by {@link OO.ui.ComboBoxInputWidget ComboBoxInputWidget}
7286 * and {@link OO.ui.mixin.LookupElement LookupElement}
7287 * @cfg {jQuery} [$input] Text input used to implement option highlighting for menu items that match
7288 * the text the user types. This config is used by {@link OO.ui.CapsuleMultiselectWidget CapsuleMultiselectWidget}
7289 * @cfg {OO.ui.Widget} [widget] Widget associated with the menu's active state. If the user clicks the mouse
7290 * anywhere on the page outside of this widget, the menu is hidden. For example, if there is a button
7291 * that toggles the menu's visibility on click, the menu will be hidden then re-shown when the user clicks
7292 * that button, unless the button (or its parent widget) is passed in here.
7293 * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu.
7294 * @cfg {jQuery} [$autoCloseIgnore] If these elements are clicked, don't auto-hide the menu.
7295 * @cfg {boolean} [hideOnChoose=true] Hide the menu when the user chooses an option.
7296 * @cfg {boolean} [filterFromInput=false] Filter the displayed options from the input
7297 * @cfg {boolean} [highlightOnFilter] Highlight the first result when filtering
7298 * @cfg {number} [width] Width of the menu
7299 */
7300 OO.ui.MenuSelectWidget = function OoUiMenuSelectWidget( config ) {
7301 // Configuration initialization
7302 config = config || {};
7303
7304 // Parent constructor
7305 OO.ui.MenuSelectWidget.parent.call( this, config );
7306
7307 // Mixin constructors
7308 OO.ui.mixin.ClippableElement.call( this, $.extend( {}, config, { $clippable: this.$group } ) );
7309 OO.ui.mixin.FloatableElement.call( this, config );
7310
7311 // Properties
7312 this.autoHide = config.autoHide === undefined || !!config.autoHide;
7313 this.hideOnChoose = config.hideOnChoose === undefined || !!config.hideOnChoose;
7314 this.filterFromInput = !!config.filterFromInput;
7315 this.$input = config.$input ? config.$input : config.input ? config.input.$input : null;
7316 this.$widget = config.widget ? config.widget.$element : null;
7317 this.$autoCloseIgnore = config.$autoCloseIgnore || $( [] );
7318 this.onDocumentMouseDownHandler = this.onDocumentMouseDown.bind( this );
7319 this.onInputEditHandler = OO.ui.debounce( this.updateItemVisibility.bind( this ), 100 );
7320 this.highlightOnFilter = !!config.highlightOnFilter;
7321 this.width = config.width;
7322
7323 // Initialization
7324 this.$element.addClass( 'oo-ui-menuSelectWidget' );
7325 if ( config.widget ) {
7326 this.setFocusOwner( config.widget.$tabIndexed );
7327 }
7328
7329 // Initially hidden - using #toggle may cause errors if subclasses override toggle with methods
7330 // that reference properties not initialized at that time of parent class construction
7331 // TODO: Find a better way to handle post-constructor setup
7332 this.visible = false;
7333 this.$element.addClass( 'oo-ui-element-hidden' );
7334 };
7335
7336 /* Setup */
7337
7338 OO.inheritClass( OO.ui.MenuSelectWidget, OO.ui.SelectWidget );
7339 OO.mixinClass( OO.ui.MenuSelectWidget, OO.ui.mixin.ClippableElement );
7340 OO.mixinClass( OO.ui.MenuSelectWidget, OO.ui.mixin.FloatableElement );
7341
7342 /* Events */
7343
7344 /**
7345 * @event ready
7346 *
7347 * The menu is ready: it is visible and has been positioned and clipped.
7348 */
7349
7350 /* Methods */
7351
7352 /**
7353 * Handles document mouse down events.
7354 *
7355 * @protected
7356 * @param {MouseEvent} e Mouse down event
7357 */
7358 OO.ui.MenuSelectWidget.prototype.onDocumentMouseDown = function ( e ) {
7359 if (
7360 this.isVisible() &&
7361 !OO.ui.contains(
7362 this.$element.add( this.$widget ).add( this.$autoCloseIgnore ).get(),
7363 e.target,
7364 true
7365 )
7366 ) {
7367 this.toggle( false );
7368 }
7369 };
7370
7371 /**
7372 * @inheritdoc
7373 */
7374 OO.ui.MenuSelectWidget.prototype.onKeyDown = function ( e ) {
7375 var currentItem = this.findHighlightedItem() || this.findSelectedItem();
7376
7377 if ( !this.isDisabled() && this.isVisible() ) {
7378 switch ( e.keyCode ) {
7379 case OO.ui.Keys.LEFT:
7380 case OO.ui.Keys.RIGHT:
7381 // Do nothing if a text field is associated, arrow keys will be handled natively
7382 if ( !this.$input ) {
7383 OO.ui.MenuSelectWidget.parent.prototype.onKeyDown.call( this, e );
7384 }
7385 break;
7386 case OO.ui.Keys.ESCAPE:
7387 case OO.ui.Keys.TAB:
7388 if ( currentItem ) {
7389 currentItem.setHighlighted( false );
7390 }
7391 this.toggle( false );
7392 // Don't prevent tabbing away, prevent defocusing
7393 if ( e.keyCode === OO.ui.Keys.ESCAPE ) {
7394 e.preventDefault();
7395 e.stopPropagation();
7396 }
7397 break;
7398 default:
7399 OO.ui.MenuSelectWidget.parent.prototype.onKeyDown.call( this, e );
7400 return;
7401 }
7402 }
7403 };
7404
7405 /**
7406 * Update menu item visibility and clipping after input changes (if filterFromInput is enabled)
7407 * or after items were added/removed (always).
7408 *
7409 * @protected
7410 */
7411 OO.ui.MenuSelectWidget.prototype.updateItemVisibility = function () {
7412 var i, item, visible, section, sectionEmpty, filter, exactFilter,
7413 firstItemFound = false,
7414 anyVisible = false,
7415 len = this.items.length,
7416 showAll = !this.isVisible(),
7417 exactMatch = false;
7418
7419 if ( this.$input && this.filterFromInput ) {
7420 filter = showAll ? null : this.getItemMatcher( this.$input.val() );
7421 exactFilter = this.getItemMatcher( this.$input.val(), true );
7422
7423 // Hide non-matching options, and also hide section headers if all options
7424 // in their section are hidden.
7425 for ( i = 0; i < len; i++ ) {
7426 item = this.items[ i ];
7427 if ( item instanceof OO.ui.MenuSectionOptionWidget ) {
7428 if ( section ) {
7429 // If the previous section was empty, hide its header
7430 section.toggle( showAll || !sectionEmpty );
7431 }
7432 section = item;
7433 sectionEmpty = true;
7434 } else if ( item instanceof OO.ui.OptionWidget ) {
7435 visible = showAll || filter( item );
7436 exactMatch = exactMatch || exactFilter( item );
7437 anyVisible = anyVisible || visible;
7438 sectionEmpty = sectionEmpty && !visible;
7439 item.toggle( visible );
7440 if ( this.highlightOnFilter && visible && !firstItemFound ) {
7441 // Highlight the first item in the list
7442 this.highlightItem( item );
7443 firstItemFound = true;
7444 }
7445 }
7446 }
7447 // Process the final section
7448 if ( section ) {
7449 section.toggle( showAll || !sectionEmpty );
7450 }
7451
7452 if ( anyVisible && this.items.length && !exactMatch ) {
7453 this.scrollItemIntoView( this.items[ 0 ] );
7454 }
7455
7456 this.$element.toggleClass( 'oo-ui-menuSelectWidget-invisible', !anyVisible );
7457 }
7458
7459 // Reevaluate clipping
7460 this.clip();
7461 };
7462
7463 /**
7464 * @inheritdoc
7465 */
7466 OO.ui.MenuSelectWidget.prototype.bindKeyDownListener = function () {
7467 if ( this.$input ) {
7468 this.$input.on( 'keydown', this.onKeyDownHandler );
7469 } else {
7470 OO.ui.MenuSelectWidget.parent.prototype.bindKeyDownListener.call( this );
7471 }
7472 };
7473
7474 /**
7475 * @inheritdoc
7476 */
7477 OO.ui.MenuSelectWidget.prototype.unbindKeyDownListener = function () {
7478 if ( this.$input ) {
7479 this.$input.off( 'keydown', this.onKeyDownHandler );
7480 } else {
7481 OO.ui.MenuSelectWidget.parent.prototype.unbindKeyDownListener.call( this );
7482 }
7483 };
7484
7485 /**
7486 * @inheritdoc
7487 */
7488 OO.ui.MenuSelectWidget.prototype.bindKeyPressListener = function () {
7489 if ( this.$input ) {
7490 if ( this.filterFromInput ) {
7491 this.$input.on( 'keydown mouseup cut paste change input select', this.onInputEditHandler );
7492 this.updateItemVisibility();
7493 }
7494 } else {
7495 OO.ui.MenuSelectWidget.parent.prototype.bindKeyPressListener.call( this );
7496 }
7497 };
7498
7499 /**
7500 * @inheritdoc
7501 */
7502 OO.ui.MenuSelectWidget.prototype.unbindKeyPressListener = function () {
7503 if ( this.$input ) {
7504 if ( this.filterFromInput ) {
7505 this.$input.off( 'keydown mouseup cut paste change input select', this.onInputEditHandler );
7506 this.updateItemVisibility();
7507 }
7508 } else {
7509 OO.ui.MenuSelectWidget.parent.prototype.unbindKeyPressListener.call( this );
7510 }
7511 };
7512
7513 /**
7514 * Choose an item.
7515 *
7516 * When a user chooses an item, the menu is closed, unless the hideOnChoose config option is set to false.
7517 *
7518 * Note that ‘choose’ should never be modified programmatically. A user can choose an option with the keyboard
7519 * or mouse and it becomes selected. To select an item programmatically, use the #selectItem method.
7520 *
7521 * @param {OO.ui.OptionWidget} item Item to choose
7522 * @chainable
7523 */
7524 OO.ui.MenuSelectWidget.prototype.chooseItem = function ( item ) {
7525 OO.ui.MenuSelectWidget.parent.prototype.chooseItem.call( this, item );
7526 if ( this.hideOnChoose ) {
7527 this.toggle( false );
7528 }
7529 return this;
7530 };
7531
7532 /**
7533 * @inheritdoc
7534 */
7535 OO.ui.MenuSelectWidget.prototype.addItems = function ( items, index ) {
7536 // Parent method
7537 OO.ui.MenuSelectWidget.parent.prototype.addItems.call( this, items, index );
7538
7539 this.updateItemVisibility();
7540
7541 return this;
7542 };
7543
7544 /**
7545 * @inheritdoc
7546 */
7547 OO.ui.MenuSelectWidget.prototype.removeItems = function ( items ) {
7548 // Parent method
7549 OO.ui.MenuSelectWidget.parent.prototype.removeItems.call( this, items );
7550
7551 this.updateItemVisibility();
7552
7553 return this;
7554 };
7555
7556 /**
7557 * @inheritdoc
7558 */
7559 OO.ui.MenuSelectWidget.prototype.clearItems = function () {
7560 // Parent method
7561 OO.ui.MenuSelectWidget.parent.prototype.clearItems.call( this );
7562
7563 this.updateItemVisibility();
7564
7565 return this;
7566 };
7567
7568 /**
7569 * Toggle visibility of the menu. The menu is initially hidden and must be shown by calling
7570 * `.toggle( true )` after its #$element is attached to the DOM.
7571 *
7572 * Do not show the menu while it is not attached to the DOM. The calculations required to display
7573 * it in the right place and with the right dimensions only work correctly while it is attached.
7574 * Side-effects may include broken interface and exceptions being thrown. This wasn't always
7575 * strictly enforced, so currently it only generates a warning in the browser console.
7576 *
7577 * @fires ready
7578 * @inheritdoc
7579 */
7580 OO.ui.MenuSelectWidget.prototype.toggle = function ( visible ) {
7581 var change, belowHeight, aboveHeight;
7582
7583 visible = ( visible === undefined ? !this.visible : !!visible ) && !!this.items.length;
7584 change = visible !== this.isVisible();
7585
7586 if ( visible && !this.warnedUnattached && !this.isElementAttached() ) {
7587 OO.ui.warnDeprecation( 'MenuSelectWidget#toggle: Before calling this method, the menu must be attached to the DOM.' );
7588 this.warnedUnattached = true;
7589 }
7590
7591 if ( change ) {
7592 if ( visible && ( this.width || this.$floatableContainer ) ) {
7593 this.setIdealSize( this.width || this.$floatableContainer.width() );
7594 }
7595 if ( visible ) {
7596 // Reset position before showing the popup again. It's possible we no longer need to flip
7597 // (e.g. if the user scrolled).
7598 this.setVerticalPosition( 'below' );
7599 }
7600 }
7601
7602 // Parent method
7603 OO.ui.MenuSelectWidget.parent.prototype.toggle.call( this, visible );
7604
7605 if ( change ) {
7606 if ( visible ) {
7607 this.bindKeyDownListener();
7608 this.bindKeyPressListener();
7609
7610 this.togglePositioning( !!this.$floatableContainer );
7611 this.toggleClipping( true );
7612
7613 if ( this.isClippedVertically() || this.isFloatableOutOfView() ) {
7614 // If opening the menu downwards causes it to be clipped, flip it to open upwards instead
7615 belowHeight = this.$element.height();
7616 this.setVerticalPosition( 'above' );
7617 if ( this.isClippedVertically() || this.isFloatableOutOfView() ) {
7618 // If opening upwards also causes it to be clipped, flip it to open in whichever direction
7619 // we have more space
7620 aboveHeight = this.$element.height();
7621 if ( aboveHeight < belowHeight ) {
7622 this.setVerticalPosition( 'below' );
7623 }
7624 }
7625 }
7626 // Note that we do not flip the menu's opening direction if the clipping changes
7627 // later (e.g. after the user scrolls), that seems like it would be annoying
7628
7629 this.$focusOwner.attr( 'aria-expanded', 'true' );
7630
7631 if ( this.findSelectedItem() ) {
7632 this.$focusOwner.attr( 'aria-activedescendant', this.findSelectedItem().getElementId() );
7633 this.findSelectedItem().scrollElementIntoView( { duration: 0 } );
7634 }
7635
7636 // Auto-hide
7637 if ( this.autoHide ) {
7638 this.getElementDocument().addEventListener( 'mousedown', this.onDocumentMouseDownHandler, true );
7639 }
7640
7641 this.emit( 'ready' );
7642 } else {
7643 this.$focusOwner.removeAttr( 'aria-activedescendant' );
7644 this.unbindKeyDownListener();
7645 this.unbindKeyPressListener();
7646 this.$focusOwner.attr( 'aria-expanded', 'false' );
7647 this.getElementDocument().removeEventListener( 'mousedown', this.onDocumentMouseDownHandler, true );
7648 this.togglePositioning( false );
7649 this.toggleClipping( false );
7650 }
7651 }
7652
7653 return this;
7654 };
7655
7656 /**
7657 * DropdownWidgets are not menus themselves, rather they contain a menu of options created with
7658 * OO.ui.MenuOptionWidget. The DropdownWidget takes care of opening and displaying the menu so that
7659 * users can interact with it.
7660 *
7661 * If you want to use this within an HTML form, such as a OO.ui.FormLayout, use
7662 * OO.ui.DropdownInputWidget instead.
7663 *
7664 * @example
7665 * // Example: A DropdownWidget with a menu that contains three options
7666 * var dropDown = new OO.ui.DropdownWidget( {
7667 * label: 'Dropdown menu: Select a menu option',
7668 * menu: {
7669 * items: [
7670 * new OO.ui.MenuOptionWidget( {
7671 * data: 'a',
7672 * label: 'First'
7673 * } ),
7674 * new OO.ui.MenuOptionWidget( {
7675 * data: 'b',
7676 * label: 'Second'
7677 * } ),
7678 * new OO.ui.MenuOptionWidget( {
7679 * data: 'c',
7680 * label: 'Third'
7681 * } )
7682 * ]
7683 * }
7684 * } );
7685 *
7686 * $( 'body' ).append( dropDown.$element );
7687 *
7688 * dropDown.getMenu().selectItemByData( 'b' );
7689 *
7690 * dropDown.getMenu().findSelectedItem().getData(); // returns 'b'
7691 *
7692 * For more information, please see the [OOUI documentation on MediaWiki] [1].
7693 *
7694 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Menu_selects_and_options
7695 *
7696 * @class
7697 * @extends OO.ui.Widget
7698 * @mixins OO.ui.mixin.IconElement
7699 * @mixins OO.ui.mixin.IndicatorElement
7700 * @mixins OO.ui.mixin.LabelElement
7701 * @mixins OO.ui.mixin.TitledElement
7702 * @mixins OO.ui.mixin.TabIndexedElement
7703 *
7704 * @constructor
7705 * @param {Object} [config] Configuration options
7706 * @cfg {Object} [menu] Configuration options to pass to {@link OO.ui.MenuSelectWidget menu select widget}
7707 * @cfg {jQuery} [$overlay] Render the menu into a separate layer. This configuration is useful in cases where
7708 * the expanded menu is larger than its containing `<div>`. The specified overlay layer is usually on top of the
7709 * containing `<div>` and has a larger area. By default, the menu uses relative positioning.
7710 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
7711 */
7712 OO.ui.DropdownWidget = function OoUiDropdownWidget( config ) {
7713 // Configuration initialization
7714 config = $.extend( { indicator: 'down' }, config );
7715
7716 // Parent constructor
7717 OO.ui.DropdownWidget.parent.call( this, config );
7718
7719 // Properties (must be set before TabIndexedElement constructor call)
7720 this.$handle = $( '<span>' );
7721 this.$overlay = ( config.$overlay === true ? OO.ui.getDefaultOverlay() : config.$overlay ) || this.$element;
7722
7723 // Mixin constructors
7724 OO.ui.mixin.IconElement.call( this, config );
7725 OO.ui.mixin.IndicatorElement.call( this, config );
7726 OO.ui.mixin.LabelElement.call( this, config );
7727 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$label } ) );
7728 OO.ui.mixin.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$handle } ) );
7729
7730 // Properties
7731 this.menu = new OO.ui.MenuSelectWidget( $.extend( {
7732 widget: this,
7733 $floatableContainer: this.$element
7734 }, config.menu ) );
7735
7736 // Events
7737 this.$handle.on( {
7738 click: this.onClick.bind( this ),
7739 keydown: this.onKeyDown.bind( this ),
7740 // Hack? Handle type-to-search when menu is not expanded and not handling its own events
7741 keypress: this.menu.onKeyPressHandler,
7742 blur: this.menu.clearKeyPressBuffer.bind( this.menu )
7743 } );
7744 this.menu.connect( this, {
7745 select: 'onMenuSelect',
7746 toggle: 'onMenuToggle'
7747 } );
7748
7749 // Initialization
7750 this.$handle
7751 .addClass( 'oo-ui-dropdownWidget-handle' )
7752 .attr( {
7753 role: 'combobox',
7754 'aria-owns': this.menu.getElementId(),
7755 'aria-autocomplete': 'list'
7756 } )
7757 .append( this.$icon, this.$label, this.$indicator );
7758 this.$element
7759 .addClass( 'oo-ui-dropdownWidget' )
7760 .append( this.$handle );
7761 this.$overlay.append( this.menu.$element );
7762 };
7763
7764 /* Setup */
7765
7766 OO.inheritClass( OO.ui.DropdownWidget, OO.ui.Widget );
7767 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.IconElement );
7768 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.IndicatorElement );
7769 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.LabelElement );
7770 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.TitledElement );
7771 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.TabIndexedElement );
7772
7773 /* Methods */
7774
7775 /**
7776 * Get the menu.
7777 *
7778 * @return {OO.ui.MenuSelectWidget} Menu of widget
7779 */
7780 OO.ui.DropdownWidget.prototype.getMenu = function () {
7781 return this.menu;
7782 };
7783
7784 /**
7785 * Handles menu select events.
7786 *
7787 * @private
7788 * @param {OO.ui.MenuOptionWidget} item Selected menu item
7789 */
7790 OO.ui.DropdownWidget.prototype.onMenuSelect = function ( item ) {
7791 var selectedLabel;
7792
7793 if ( !item ) {
7794 this.setLabel( null );
7795 return;
7796 }
7797
7798 selectedLabel = item.getLabel();
7799
7800 // If the label is a DOM element, clone it, because setLabel will append() it
7801 if ( selectedLabel instanceof jQuery ) {
7802 selectedLabel = selectedLabel.clone();
7803 }
7804
7805 this.setLabel( selectedLabel );
7806 };
7807
7808 /**
7809 * Handle menu toggle events.
7810 *
7811 * @private
7812 * @param {boolean} isVisible Open state of the menu
7813 */
7814 OO.ui.DropdownWidget.prototype.onMenuToggle = function ( isVisible ) {
7815 this.$element.toggleClass( 'oo-ui-dropdownWidget-open', isVisible );
7816 this.$handle.attr(
7817 'aria-expanded',
7818 this.$element.hasClass( 'oo-ui-dropdownWidget-open' ).toString()
7819 );
7820 };
7821
7822 /**
7823 * Handle mouse click events.
7824 *
7825 * @private
7826 * @param {jQuery.Event} e Mouse click event
7827 */
7828 OO.ui.DropdownWidget.prototype.onClick = function ( e ) {
7829 if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
7830 this.menu.toggle();
7831 }
7832 return false;
7833 };
7834
7835 /**
7836 * Handle key down events.
7837 *
7838 * @private
7839 * @param {jQuery.Event} e Key down event
7840 */
7841 OO.ui.DropdownWidget.prototype.onKeyDown = function ( e ) {
7842 if (
7843 !this.isDisabled() &&
7844 (
7845 e.which === OO.ui.Keys.ENTER ||
7846 (
7847 e.which === OO.ui.Keys.SPACE &&
7848 // Avoid conflicts with type-to-search, see SelectWidget#onKeyPress.
7849 // Space only closes the menu is the user is not typing to search.
7850 this.menu.keyPressBuffer === ''
7851 ) ||
7852 (
7853 !this.menu.isVisible() &&
7854 (
7855 e.which === OO.ui.Keys.UP ||
7856 e.which === OO.ui.Keys.DOWN
7857 )
7858 )
7859 )
7860 ) {
7861 this.menu.toggle();
7862 return false;
7863 }
7864 };
7865
7866 /**
7867 * RadioOptionWidget is an option widget that looks like a radio button.
7868 * The class is used with OO.ui.RadioSelectWidget to create a selection of radio options.
7869 * Please see the [OOUI documentation on MediaWiki] [1] for more information.
7870 *
7871 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Button_selects_and_option
7872 *
7873 * @class
7874 * @extends OO.ui.OptionWidget
7875 *
7876 * @constructor
7877 * @param {Object} [config] Configuration options
7878 */
7879 OO.ui.RadioOptionWidget = function OoUiRadioOptionWidget( config ) {
7880 // Configuration initialization
7881 config = config || {};
7882
7883 // Properties (must be done before parent constructor which calls #setDisabled)
7884 this.radio = new OO.ui.RadioInputWidget( { value: config.data, tabIndex: -1 } );
7885
7886 // Parent constructor
7887 OO.ui.RadioOptionWidget.parent.call( this, config );
7888
7889 // Initialization
7890 // Remove implicit role, we're handling it ourselves
7891 this.radio.$input.attr( 'role', 'presentation' );
7892 this.$element
7893 .addClass( 'oo-ui-radioOptionWidget' )
7894 .attr( 'role', 'radio' )
7895 .attr( 'aria-checked', 'false' )
7896 .removeAttr( 'aria-selected' )
7897 .prepend( this.radio.$element );
7898 };
7899
7900 /* Setup */
7901
7902 OO.inheritClass( OO.ui.RadioOptionWidget, OO.ui.OptionWidget );
7903
7904 /* Static Properties */
7905
7906 /**
7907 * @static
7908 * @inheritdoc
7909 */
7910 OO.ui.RadioOptionWidget.static.highlightable = false;
7911
7912 /**
7913 * @static
7914 * @inheritdoc
7915 */
7916 OO.ui.RadioOptionWidget.static.scrollIntoViewOnSelect = true;
7917
7918 /**
7919 * @static
7920 * @inheritdoc
7921 */
7922 OO.ui.RadioOptionWidget.static.pressable = false;
7923
7924 /**
7925 * @static
7926 * @inheritdoc
7927 */
7928 OO.ui.RadioOptionWidget.static.tagName = 'label';
7929
7930 /* Methods */
7931
7932 /**
7933 * @inheritdoc
7934 */
7935 OO.ui.RadioOptionWidget.prototype.setSelected = function ( state ) {
7936 OO.ui.RadioOptionWidget.parent.prototype.setSelected.call( this, state );
7937
7938 this.radio.setSelected( state );
7939 this.$element
7940 .attr( 'aria-checked', state.toString() )
7941 .removeAttr( 'aria-selected' );
7942
7943 return this;
7944 };
7945
7946 /**
7947 * @inheritdoc
7948 */
7949 OO.ui.RadioOptionWidget.prototype.setDisabled = function ( disabled ) {
7950 OO.ui.RadioOptionWidget.parent.prototype.setDisabled.call( this, disabled );
7951
7952 this.radio.setDisabled( this.isDisabled() );
7953
7954 return this;
7955 };
7956
7957 /**
7958 * RadioSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains radio
7959 * options and is used together with OO.ui.RadioOptionWidget. The RadioSelectWidget provides
7960 * an interface for adding, removing and selecting options.
7961 * Please see the [OOUI documentation on MediaWiki][1] for more information.
7962 *
7963 * If you want to use this within an HTML form, such as a OO.ui.FormLayout, use
7964 * OO.ui.RadioSelectInputWidget instead.
7965 *
7966 * @example
7967 * // A RadioSelectWidget with RadioOptions.
7968 * var option1 = new OO.ui.RadioOptionWidget( {
7969 * data: 'a',
7970 * label: 'Selected radio option'
7971 * } );
7972 *
7973 * var option2 = new OO.ui.RadioOptionWidget( {
7974 * data: 'b',
7975 * label: 'Unselected radio option'
7976 * } );
7977 *
7978 * var radioSelect=new OO.ui.RadioSelectWidget( {
7979 * items: [ option1, option2 ]
7980 * } );
7981 *
7982 * // Select 'option 1' using the RadioSelectWidget's selectItem() method.
7983 * radioSelect.selectItem( option1 );
7984 *
7985 * $( 'body' ).append( radioSelect.$element );
7986 *
7987 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
7988
7989 *
7990 * @class
7991 * @extends OO.ui.SelectWidget
7992 * @mixins OO.ui.mixin.TabIndexedElement
7993 *
7994 * @constructor
7995 * @param {Object} [config] Configuration options
7996 */
7997 OO.ui.RadioSelectWidget = function OoUiRadioSelectWidget( config ) {
7998 // Parent constructor
7999 OO.ui.RadioSelectWidget.parent.call( this, config );
8000
8001 // Mixin constructors
8002 OO.ui.mixin.TabIndexedElement.call( this, config );
8003
8004 // Events
8005 this.$element.on( {
8006 focus: this.bindKeyDownListener.bind( this ),
8007 blur: this.unbindKeyDownListener.bind( this )
8008 } );
8009
8010 // Initialization
8011 this.$element
8012 .addClass( 'oo-ui-radioSelectWidget' )
8013 .attr( 'role', 'radiogroup' );
8014 };
8015
8016 /* Setup */
8017
8018 OO.inheritClass( OO.ui.RadioSelectWidget, OO.ui.SelectWidget );
8019 OO.mixinClass( OO.ui.RadioSelectWidget, OO.ui.mixin.TabIndexedElement );
8020
8021 /**
8022 * MultioptionWidgets are special elements that can be selected and configured with data. The
8023 * data is often unique for each option, but it does not have to be. MultioptionWidgets are used
8024 * with OO.ui.SelectWidget to create a selection of mutually exclusive options. For more information
8025 * and examples, please see the [OOUI documentation on MediaWiki][1].
8026 *
8027 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Multioptions
8028 *
8029 * @class
8030 * @extends OO.ui.Widget
8031 * @mixins OO.ui.mixin.ItemWidget
8032 * @mixins OO.ui.mixin.LabelElement
8033 *
8034 * @constructor
8035 * @param {Object} [config] Configuration options
8036 * @cfg {boolean} [selected=false] Whether the option is initially selected
8037 */
8038 OO.ui.MultioptionWidget = function OoUiMultioptionWidget( config ) {
8039 // Configuration initialization
8040 config = config || {};
8041
8042 // Parent constructor
8043 OO.ui.MultioptionWidget.parent.call( this, config );
8044
8045 // Mixin constructors
8046 OO.ui.mixin.ItemWidget.call( this );
8047 OO.ui.mixin.LabelElement.call( this, config );
8048
8049 // Properties
8050 this.selected = null;
8051
8052 // Initialization
8053 this.$element
8054 .addClass( 'oo-ui-multioptionWidget' )
8055 .append( this.$label );
8056 this.setSelected( config.selected );
8057 };
8058
8059 /* Setup */
8060
8061 OO.inheritClass( OO.ui.MultioptionWidget, OO.ui.Widget );
8062 OO.mixinClass( OO.ui.MultioptionWidget, OO.ui.mixin.ItemWidget );
8063 OO.mixinClass( OO.ui.MultioptionWidget, OO.ui.mixin.LabelElement );
8064
8065 /* Events */
8066
8067 /**
8068 * @event change
8069 *
8070 * A change event is emitted when the selected state of the option changes.
8071 *
8072 * @param {boolean} selected Whether the option is now selected
8073 */
8074
8075 /* Methods */
8076
8077 /**
8078 * Check if the option is selected.
8079 *
8080 * @return {boolean} Item is selected
8081 */
8082 OO.ui.MultioptionWidget.prototype.isSelected = function () {
8083 return this.selected;
8084 };
8085
8086 /**
8087 * Set the option’s selected state. In general, all modifications to the selection
8088 * should be handled by the SelectWidget’s {@link OO.ui.SelectWidget#selectItem selectItem( [item] )}
8089 * method instead of this method.
8090 *
8091 * @param {boolean} [state=false] Select option
8092 * @chainable
8093 */
8094 OO.ui.MultioptionWidget.prototype.setSelected = function ( state ) {
8095 state = !!state;
8096 if ( this.selected !== state ) {
8097 this.selected = state;
8098 this.emit( 'change', state );
8099 this.$element.toggleClass( 'oo-ui-multioptionWidget-selected', state );
8100 }
8101 return this;
8102 };
8103
8104 /**
8105 * MultiselectWidget allows selecting multiple options from a list.
8106 *
8107 * For more information about menus and options, please see the [OOUI documentation on MediaWiki][1].
8108 *
8109 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Menu_selects_and_options
8110 *
8111 * @class
8112 * @abstract
8113 * @extends OO.ui.Widget
8114 * @mixins OO.ui.mixin.GroupWidget
8115 *
8116 * @constructor
8117 * @param {Object} [config] Configuration options
8118 * @cfg {OO.ui.MultioptionWidget[]} [items] An array of options to add to the multiselect.
8119 */
8120 OO.ui.MultiselectWidget = function OoUiMultiselectWidget( config ) {
8121 // Parent constructor
8122 OO.ui.MultiselectWidget.parent.call( this, config );
8123
8124 // Configuration initialization
8125 config = config || {};
8126
8127 // Mixin constructors
8128 OO.ui.mixin.GroupWidget.call( this, config );
8129
8130 // Events
8131 this.aggregate( { change: 'select' } );
8132 // This is mostly for compatibility with CapsuleMultiselectWidget... normally, 'change' is emitted
8133 // by GroupElement only when items are added/removed
8134 this.connect( this, { select: [ 'emit', 'change' ] } );
8135
8136 // Initialization
8137 if ( config.items ) {
8138 this.addItems( config.items );
8139 }
8140 this.$group.addClass( 'oo-ui-multiselectWidget-group' );
8141 this.$element.addClass( 'oo-ui-multiselectWidget' )
8142 .append( this.$group );
8143 };
8144
8145 /* Setup */
8146
8147 OO.inheritClass( OO.ui.MultiselectWidget, OO.ui.Widget );
8148 OO.mixinClass( OO.ui.MultiselectWidget, OO.ui.mixin.GroupWidget );
8149
8150 /* Events */
8151
8152 /**
8153 * @event change
8154 *
8155 * A change event is emitted when the set of items changes, or an item is selected or deselected.
8156 */
8157
8158 /**
8159 * @event select
8160 *
8161 * A select event is emitted when an item is selected or deselected.
8162 */
8163
8164 /* Methods */
8165
8166 /**
8167 * Find options that are selected.
8168 *
8169 * @return {OO.ui.MultioptionWidget[]} Selected options
8170 */
8171 OO.ui.MultiselectWidget.prototype.findSelectedItems = function () {
8172 return this.items.filter( function ( item ) {
8173 return item.isSelected();
8174 } );
8175 };
8176
8177 /**
8178 * Get options that are selected.
8179 *
8180 * @deprecated Since v0.25.0; use {@link #findSelectedItems} instead.
8181 * @return {OO.ui.MultioptionWidget[]} Selected options
8182 */
8183 OO.ui.MultiselectWidget.prototype.getSelectedItems = function () {
8184 OO.ui.warnDeprecation( 'MultiselectWidget#getSelectedItems: Deprecated function. Use findSelectedItems instead. See T76630.' );
8185 return this.findSelectedItems();
8186 };
8187
8188 /**
8189 * Find the data of options that are selected.
8190 *
8191 * @return {Object[]|string[]} Values of selected options
8192 */
8193 OO.ui.MultiselectWidget.prototype.findSelectedItemsData = function () {
8194 return this.findSelectedItems().map( function ( item ) {
8195 return item.data;
8196 } );
8197 };
8198
8199 /**
8200 * Get the data of options that are selected.
8201 *
8202 * @deprecated Since v0.25.0; use {@link #findSelectedItemsData} instead.
8203 * @return {Object[]|string[]} Values of selected options
8204 */
8205 OO.ui.MultiselectWidget.prototype.getSelectedItemsData = function () {
8206 OO.ui.warnDeprecation( 'MultiselectWidget#getSelectedItemsData: Deprecated function. Use findSelectedItemsData instead. See T76630.' );
8207 return this.findSelectedItemsData();
8208 };
8209
8210 /**
8211 * Select options by reference. Options not mentioned in the `items` array will be deselected.
8212 *
8213 * @param {OO.ui.MultioptionWidget[]} items Items to select
8214 * @chainable
8215 */
8216 OO.ui.MultiselectWidget.prototype.selectItems = function ( items ) {
8217 this.items.forEach( function ( item ) {
8218 var selected = items.indexOf( item ) !== -1;
8219 item.setSelected( selected );
8220 } );
8221 return this;
8222 };
8223
8224 /**
8225 * Select items by their data. Options not mentioned in the `datas` array will be deselected.
8226 *
8227 * @param {Object[]|string[]} datas Values of items to select
8228 * @chainable
8229 */
8230 OO.ui.MultiselectWidget.prototype.selectItemsByData = function ( datas ) {
8231 var items,
8232 widget = this;
8233 items = datas.map( function ( data ) {
8234 return widget.findItemFromData( data );
8235 } );
8236 this.selectItems( items );
8237 return this;
8238 };
8239
8240 /**
8241 * CheckboxMultioptionWidget is an option widget that looks like a checkbox.
8242 * The class is used with OO.ui.CheckboxMultiselectWidget to create a selection of checkbox options.
8243 * Please see the [OOUI documentation on MediaWiki] [1] for more information.
8244 *
8245 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Button_selects_and_option
8246 *
8247 * @class
8248 * @extends OO.ui.MultioptionWidget
8249 *
8250 * @constructor
8251 * @param {Object} [config] Configuration options
8252 */
8253 OO.ui.CheckboxMultioptionWidget = function OoUiCheckboxMultioptionWidget( config ) {
8254 // Configuration initialization
8255 config = config || {};
8256
8257 // Properties (must be done before parent constructor which calls #setDisabled)
8258 this.checkbox = new OO.ui.CheckboxInputWidget();
8259
8260 // Parent constructor
8261 OO.ui.CheckboxMultioptionWidget.parent.call( this, config );
8262
8263 // Events
8264 this.checkbox.on( 'change', this.onCheckboxChange.bind( this ) );
8265 this.$element.on( 'keydown', this.onKeyDown.bind( this ) );
8266
8267 // Initialization
8268 this.$element
8269 .addClass( 'oo-ui-checkboxMultioptionWidget' )
8270 .prepend( this.checkbox.$element );
8271 };
8272
8273 /* Setup */
8274
8275 OO.inheritClass( OO.ui.CheckboxMultioptionWidget, OO.ui.MultioptionWidget );
8276
8277 /* Static Properties */
8278
8279 /**
8280 * @static
8281 * @inheritdoc
8282 */
8283 OO.ui.CheckboxMultioptionWidget.static.tagName = 'label';
8284
8285 /* Methods */
8286
8287 /**
8288 * Handle checkbox selected state change.
8289 *
8290 * @private
8291 */
8292 OO.ui.CheckboxMultioptionWidget.prototype.onCheckboxChange = function () {
8293 this.setSelected( this.checkbox.isSelected() );
8294 };
8295
8296 /**
8297 * @inheritdoc
8298 */
8299 OO.ui.CheckboxMultioptionWidget.prototype.setSelected = function ( state ) {
8300 OO.ui.CheckboxMultioptionWidget.parent.prototype.setSelected.call( this, state );
8301 this.checkbox.setSelected( state );
8302 return this;
8303 };
8304
8305 /**
8306 * @inheritdoc
8307 */
8308 OO.ui.CheckboxMultioptionWidget.prototype.setDisabled = function ( disabled ) {
8309 OO.ui.CheckboxMultioptionWidget.parent.prototype.setDisabled.call( this, disabled );
8310 this.checkbox.setDisabled( this.isDisabled() );
8311 return this;
8312 };
8313
8314 /**
8315 * Focus the widget.
8316 */
8317 OO.ui.CheckboxMultioptionWidget.prototype.focus = function () {
8318 this.checkbox.focus();
8319 };
8320
8321 /**
8322 * Handle key down events.
8323 *
8324 * @protected
8325 * @param {jQuery.Event} e
8326 */
8327 OO.ui.CheckboxMultioptionWidget.prototype.onKeyDown = function ( e ) {
8328 var
8329 element = this.getElementGroup(),
8330 nextItem;
8331
8332 if ( e.keyCode === OO.ui.Keys.LEFT || e.keyCode === OO.ui.Keys.UP ) {
8333 nextItem = element.getRelativeFocusableItem( this, -1 );
8334 } else if ( e.keyCode === OO.ui.Keys.RIGHT || e.keyCode === OO.ui.Keys.DOWN ) {
8335 nextItem = element.getRelativeFocusableItem( this, 1 );
8336 }
8337
8338 if ( nextItem ) {
8339 e.preventDefault();
8340 nextItem.focus();
8341 }
8342 };
8343
8344 /**
8345 * CheckboxMultiselectWidget is a {@link OO.ui.MultiselectWidget multiselect widget} that contains
8346 * checkboxes and is used together with OO.ui.CheckboxMultioptionWidget. The
8347 * CheckboxMultiselectWidget provides an interface for adding, removing and selecting options.
8348 * Please see the [OOUI documentation on MediaWiki][1] for more information.
8349 *
8350 * If you want to use this within an HTML form, such as a OO.ui.FormLayout, use
8351 * OO.ui.CheckboxMultiselectInputWidget instead.
8352 *
8353 * @example
8354 * // A CheckboxMultiselectWidget with CheckboxMultioptions.
8355 * var option1 = new OO.ui.CheckboxMultioptionWidget( {
8356 * data: 'a',
8357 * selected: true,
8358 * label: 'Selected checkbox'
8359 * } );
8360 *
8361 * var option2 = new OO.ui.CheckboxMultioptionWidget( {
8362 * data: 'b',
8363 * label: 'Unselected checkbox'
8364 * } );
8365 *
8366 * var multiselect=new OO.ui.CheckboxMultiselectWidget( {
8367 * items: [ option1, option2 ]
8368 * } );
8369 *
8370 * $( 'body' ).append( multiselect.$element );
8371 *
8372 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
8373 *
8374 * @class
8375 * @extends OO.ui.MultiselectWidget
8376 *
8377 * @constructor
8378 * @param {Object} [config] Configuration options
8379 */
8380 OO.ui.CheckboxMultiselectWidget = function OoUiCheckboxMultiselectWidget( config ) {
8381 // Parent constructor
8382 OO.ui.CheckboxMultiselectWidget.parent.call( this, config );
8383
8384 // Properties
8385 this.$lastClicked = null;
8386
8387 // Events
8388 this.$group.on( 'click', this.onClick.bind( this ) );
8389
8390 // Initialization
8391 this.$element
8392 .addClass( 'oo-ui-checkboxMultiselectWidget' );
8393 };
8394
8395 /* Setup */
8396
8397 OO.inheritClass( OO.ui.CheckboxMultiselectWidget, OO.ui.MultiselectWidget );
8398
8399 /* Methods */
8400
8401 /**
8402 * Get an option by its position relative to the specified item (or to the start of the option array,
8403 * if item is `null`). The direction in which to search through the option array is specified with a
8404 * number: -1 for reverse (the default) or 1 for forward. The method will return an option, or
8405 * `null` if there are no options in the array.
8406 *
8407 * @param {OO.ui.CheckboxMultioptionWidget|null} item Item to describe the start position, or `null` to start at the beginning of the array.
8408 * @param {number} direction Direction to move in: -1 to move backward, 1 to move forward
8409 * @return {OO.ui.CheckboxMultioptionWidget|null} Item at position, `null` if there are no items in the select
8410 */
8411 OO.ui.CheckboxMultiselectWidget.prototype.getRelativeFocusableItem = function ( item, direction ) {
8412 var currentIndex, nextIndex, i,
8413 increase = direction > 0 ? 1 : -1,
8414 len = this.items.length;
8415
8416 if ( item ) {
8417 currentIndex = this.items.indexOf( item );
8418 nextIndex = ( currentIndex + increase + len ) % len;
8419 } else {
8420 // If no item is selected and moving forward, start at the beginning.
8421 // If moving backward, start at the end.
8422 nextIndex = direction > 0 ? 0 : len - 1;
8423 }
8424
8425 for ( i = 0; i < len; i++ ) {
8426 item = this.items[ nextIndex ];
8427 if ( item && !item.isDisabled() ) {
8428 return item;
8429 }
8430 nextIndex = ( nextIndex + increase + len ) % len;
8431 }
8432 return null;
8433 };
8434
8435 /**
8436 * Handle click events on checkboxes.
8437 *
8438 * @param {jQuery.Event} e
8439 */
8440 OO.ui.CheckboxMultiselectWidget.prototype.onClick = function ( e ) {
8441 var $options, lastClickedIndex, nowClickedIndex, i, direction, wasSelected, items,
8442 $lastClicked = this.$lastClicked,
8443 $nowClicked = $( e.target ).closest( '.oo-ui-checkboxMultioptionWidget' )
8444 .not( '.oo-ui-widget-disabled' );
8445
8446 // Allow selecting multiple options at once by Shift-clicking them
8447 if ( $lastClicked && $nowClicked.length && e.shiftKey ) {
8448 $options = this.$group.find( '.oo-ui-checkboxMultioptionWidget' );
8449 lastClickedIndex = $options.index( $lastClicked );
8450 nowClickedIndex = $options.index( $nowClicked );
8451 // If it's the same item, either the user is being silly, or it's a fake event generated by the
8452 // browser. In either case we don't need custom handling.
8453 if ( nowClickedIndex !== lastClickedIndex ) {
8454 items = this.items;
8455 wasSelected = items[ nowClickedIndex ].isSelected();
8456 direction = nowClickedIndex > lastClickedIndex ? 1 : -1;
8457
8458 // This depends on the DOM order of the items and the order of the .items array being the same.
8459 for ( i = lastClickedIndex; i !== nowClickedIndex; i += direction ) {
8460 if ( !items[ i ].isDisabled() ) {
8461 items[ i ].setSelected( !wasSelected );
8462 }
8463 }
8464 // For the now-clicked element, use immediate timeout to allow the browser to do its own
8465 // handling first, then set our value. The order in which events happen is different for
8466 // clicks on the <input> and on the <label> and there are additional fake clicks fired for
8467 // non-click actions that change the checkboxes.
8468 e.preventDefault();
8469 setTimeout( function () {
8470 if ( !items[ nowClickedIndex ].isDisabled() ) {
8471 items[ nowClickedIndex ].setSelected( !wasSelected );
8472 }
8473 } );
8474 }
8475 }
8476
8477 if ( $nowClicked.length ) {
8478 this.$lastClicked = $nowClicked;
8479 }
8480 };
8481
8482 /**
8483 * Focus the widget
8484 *
8485 * @chainable
8486 */
8487 OO.ui.CheckboxMultiselectWidget.prototype.focus = function () {
8488 var item;
8489 if ( !this.isDisabled() ) {
8490 item = this.getRelativeFocusableItem( null, 1 );
8491 if ( item ) {
8492 item.focus();
8493 }
8494 }
8495 return this;
8496 };
8497
8498 /**
8499 * @inheritdoc
8500 */
8501 OO.ui.CheckboxMultiselectWidget.prototype.simulateLabelClick = function () {
8502 this.focus();
8503 };
8504
8505 /**
8506 * Progress bars visually display the status of an operation, such as a download,
8507 * and can be either determinate or indeterminate:
8508 *
8509 * - **determinate** process bars show the percent of an operation that is complete.
8510 *
8511 * - **indeterminate** process bars use a visual display of motion to indicate that an operation
8512 * is taking place. Because the extent of an indeterminate operation is unknown, the bar does
8513 * not use percentages.
8514 *
8515 * The value of the `progress` configuration determines whether the bar is determinate or indeterminate.
8516 *
8517 * @example
8518 * // Examples of determinate and indeterminate progress bars.
8519 * var progressBar1 = new OO.ui.ProgressBarWidget( {
8520 * progress: 33
8521 * } );
8522 * var progressBar2 = new OO.ui.ProgressBarWidget();
8523 *
8524 * // Create a FieldsetLayout to layout progress bars
8525 * var fieldset = new OO.ui.FieldsetLayout;
8526 * fieldset.addItems( [
8527 * new OO.ui.FieldLayout( progressBar1, {label: 'Determinate', align: 'top'}),
8528 * new OO.ui.FieldLayout( progressBar2, {label: 'Indeterminate', align: 'top'})
8529 * ] );
8530 * $( 'body' ).append( fieldset.$element );
8531 *
8532 * @class
8533 * @extends OO.ui.Widget
8534 *
8535 * @constructor
8536 * @param {Object} [config] Configuration options
8537 * @cfg {number|boolean} [progress=false] The type of progress bar (determinate or indeterminate).
8538 * To create a determinate progress bar, specify a number that reflects the initial percent complete.
8539 * By default, the progress bar is indeterminate.
8540 */
8541 OO.ui.ProgressBarWidget = function OoUiProgressBarWidget( config ) {
8542 // Configuration initialization
8543 config = config || {};
8544
8545 // Parent constructor
8546 OO.ui.ProgressBarWidget.parent.call( this, config );
8547
8548 // Properties
8549 this.$bar = $( '<div>' );
8550 this.progress = null;
8551
8552 // Initialization
8553 this.setProgress( config.progress !== undefined ? config.progress : false );
8554 this.$bar.addClass( 'oo-ui-progressBarWidget-bar' );
8555 this.$element
8556 .attr( {
8557 role: 'progressbar',
8558 'aria-valuemin': 0,
8559 'aria-valuemax': 100
8560 } )
8561 .addClass( 'oo-ui-progressBarWidget' )
8562 .append( this.$bar );
8563 };
8564
8565 /* Setup */
8566
8567 OO.inheritClass( OO.ui.ProgressBarWidget, OO.ui.Widget );
8568
8569 /* Static Properties */
8570
8571 /**
8572 * @static
8573 * @inheritdoc
8574 */
8575 OO.ui.ProgressBarWidget.static.tagName = 'div';
8576
8577 /* Methods */
8578
8579 /**
8580 * Get the percent of the progress that has been completed. Indeterminate progresses will return `false`.
8581 *
8582 * @return {number|boolean} Progress percent
8583 */
8584 OO.ui.ProgressBarWidget.prototype.getProgress = function () {
8585 return this.progress;
8586 };
8587
8588 /**
8589 * Set the percent of the process completed or `false` for an indeterminate process.
8590 *
8591 * @param {number|boolean} progress Progress percent or `false` for indeterminate
8592 */
8593 OO.ui.ProgressBarWidget.prototype.setProgress = function ( progress ) {
8594 this.progress = progress;
8595
8596 if ( progress !== false ) {
8597 this.$bar.css( 'width', this.progress + '%' );
8598 this.$element.attr( 'aria-valuenow', this.progress );
8599 } else {
8600 this.$bar.css( 'width', '' );
8601 this.$element.removeAttr( 'aria-valuenow' );
8602 }
8603 this.$element.toggleClass( 'oo-ui-progressBarWidget-indeterminate', progress === false );
8604 };
8605
8606 /**
8607 * InputWidget is the base class for all input widgets, which
8608 * include {@link OO.ui.TextInputWidget text inputs}, {@link OO.ui.CheckboxInputWidget checkbox inputs},
8609 * {@link OO.ui.RadioInputWidget radio inputs}, and {@link OO.ui.ButtonInputWidget button inputs}.
8610 * See the [OOUI documentation on MediaWiki] [1] for more information and examples.
8611 *
8612 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
8613 *
8614 * @abstract
8615 * @class
8616 * @extends OO.ui.Widget
8617 * @mixins OO.ui.mixin.FlaggedElement
8618 * @mixins OO.ui.mixin.TabIndexedElement
8619 * @mixins OO.ui.mixin.TitledElement
8620 * @mixins OO.ui.mixin.AccessKeyedElement
8621 *
8622 * @constructor
8623 * @param {Object} [config] Configuration options
8624 * @cfg {string} [name=''] The value of the input’s HTML `name` attribute.
8625 * @cfg {string} [value=''] The value of the input.
8626 * @cfg {string} [dir] The directionality of the input (ltr/rtl).
8627 * @cfg {string} [inputId] The value of the input’s HTML `id` attribute.
8628 * @cfg {Function} [inputFilter] The name of an input filter function. Input filters modify the value of an input
8629 * before it is accepted.
8630 */
8631 OO.ui.InputWidget = function OoUiInputWidget( config ) {
8632 // Configuration initialization
8633 config = config || {};
8634
8635 // Parent constructor
8636 OO.ui.InputWidget.parent.call( this, config );
8637
8638 // Properties
8639 // See #reusePreInfuseDOM about config.$input
8640 this.$input = config.$input || this.getInputElement( config );
8641 this.value = '';
8642 this.inputFilter = config.inputFilter;
8643
8644 // Mixin constructors
8645 OO.ui.mixin.FlaggedElement.call( this, config );
8646 OO.ui.mixin.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$input } ) );
8647 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$input } ) );
8648 OO.ui.mixin.AccessKeyedElement.call( this, $.extend( {}, config, { $accessKeyed: this.$input } ) );
8649
8650 // Events
8651 this.$input.on( 'keydown mouseup cut paste change input select', this.onEdit.bind( this ) );
8652
8653 // Initialization
8654 this.$input
8655 .addClass( 'oo-ui-inputWidget-input' )
8656 .attr( 'name', config.name )
8657 .prop( 'disabled', this.isDisabled() );
8658 this.$element
8659 .addClass( 'oo-ui-inputWidget' )
8660 .append( this.$input );
8661 this.setValue( config.value );
8662 if ( config.dir ) {
8663 this.setDir( config.dir );
8664 }
8665 if ( config.inputId !== undefined ) {
8666 this.setInputId( config.inputId );
8667 }
8668 };
8669
8670 /* Setup */
8671
8672 OO.inheritClass( OO.ui.InputWidget, OO.ui.Widget );
8673 OO.mixinClass( OO.ui.InputWidget, OO.ui.mixin.FlaggedElement );
8674 OO.mixinClass( OO.ui.InputWidget, OO.ui.mixin.TabIndexedElement );
8675 OO.mixinClass( OO.ui.InputWidget, OO.ui.mixin.TitledElement );
8676 OO.mixinClass( OO.ui.InputWidget, OO.ui.mixin.AccessKeyedElement );
8677
8678 /* Static Methods */
8679
8680 /**
8681 * @inheritdoc
8682 */
8683 OO.ui.InputWidget.static.reusePreInfuseDOM = function ( node, config ) {
8684 config = OO.ui.InputWidget.parent.static.reusePreInfuseDOM( node, config );
8685 // Reusing `$input` lets browsers preserve inputted values across page reloads, see T114134.
8686 config.$input = $( node ).find( '.oo-ui-inputWidget-input' );
8687 return config;
8688 };
8689
8690 /**
8691 * @inheritdoc
8692 */
8693 OO.ui.InputWidget.static.gatherPreInfuseState = function ( node, config ) {
8694 var state = OO.ui.InputWidget.parent.static.gatherPreInfuseState( node, config );
8695 if ( config.$input && config.$input.length ) {
8696 state.value = config.$input.val();
8697 // Might be better in TabIndexedElement, but it's awkward to do there because mixins are awkward
8698 state.focus = config.$input.is( ':focus' );
8699 }
8700 return state;
8701 };
8702
8703 /* Events */
8704
8705 /**
8706 * @event change
8707 *
8708 * A change event is emitted when the value of the input changes.
8709 *
8710 * @param {string} value
8711 */
8712
8713 /* Methods */
8714
8715 /**
8716 * Get input element.
8717 *
8718 * Subclasses of OO.ui.InputWidget use the `config` parameter to produce different elements in
8719 * different circumstances. The element must have a `value` property (like form elements).
8720 *
8721 * @protected
8722 * @param {Object} config Configuration options
8723 * @return {jQuery} Input element
8724 */
8725 OO.ui.InputWidget.prototype.getInputElement = function () {
8726 return $( '<input>' );
8727 };
8728
8729 /**
8730 * Handle potentially value-changing events.
8731 *
8732 * @private
8733 * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
8734 */
8735 OO.ui.InputWidget.prototype.onEdit = function () {
8736 var widget = this;
8737 if ( !this.isDisabled() ) {
8738 // Allow the stack to clear so the value will be updated
8739 setTimeout( function () {
8740 widget.setValue( widget.$input.val() );
8741 } );
8742 }
8743 };
8744
8745 /**
8746 * Get the value of the input.
8747 *
8748 * @return {string} Input value
8749 */
8750 OO.ui.InputWidget.prototype.getValue = function () {
8751 // Resynchronize our internal data with DOM data. Other scripts executing on the page can modify
8752 // it, and we won't know unless they're kind enough to trigger a 'change' event.
8753 var value = this.$input.val();
8754 if ( this.value !== value ) {
8755 this.setValue( value );
8756 }
8757 return this.value;
8758 };
8759
8760 /**
8761 * Set the directionality of the input.
8762 *
8763 * @param {string} dir Text directionality: 'ltr', 'rtl' or 'auto'
8764 * @chainable
8765 */
8766 OO.ui.InputWidget.prototype.setDir = function ( dir ) {
8767 this.$input.prop( 'dir', dir );
8768 return this;
8769 };
8770
8771 /**
8772 * Set the value of the input.
8773 *
8774 * @param {string} value New value
8775 * @fires change
8776 * @chainable
8777 */
8778 OO.ui.InputWidget.prototype.setValue = function ( value ) {
8779 value = this.cleanUpValue( value );
8780 // Update the DOM if it has changed. Note that with cleanUpValue, it
8781 // is possible for the DOM value to change without this.value changing.
8782 if ( this.$input.val() !== value ) {
8783 this.$input.val( value );
8784 }
8785 if ( this.value !== value ) {
8786 this.value = value;
8787 this.emit( 'change', this.value );
8788 }
8789 return this;
8790 };
8791
8792 /**
8793 * Clean up incoming value.
8794 *
8795 * Ensures value is a string, and converts undefined and null to empty string.
8796 *
8797 * @private
8798 * @param {string} value Original value
8799 * @return {string} Cleaned up value
8800 */
8801 OO.ui.InputWidget.prototype.cleanUpValue = function ( value ) {
8802 if ( value === undefined || value === null ) {
8803 return '';
8804 } else if ( this.inputFilter ) {
8805 return this.inputFilter( String( value ) );
8806 } else {
8807 return String( value );
8808 }
8809 };
8810
8811 /**
8812 * @inheritdoc
8813 */
8814 OO.ui.InputWidget.prototype.setDisabled = function ( state ) {
8815 OO.ui.InputWidget.parent.prototype.setDisabled.call( this, state );
8816 if ( this.$input ) {
8817 this.$input.prop( 'disabled', this.isDisabled() );
8818 }
8819 return this;
8820 };
8821
8822 /**
8823 * Set the 'id' attribute of the `<input>` element.
8824 *
8825 * @param {string} id
8826 * @chainable
8827 */
8828 OO.ui.InputWidget.prototype.setInputId = function ( id ) {
8829 this.$input.attr( 'id', id );
8830 return this;
8831 };
8832
8833 /**
8834 * @inheritdoc
8835 */
8836 OO.ui.InputWidget.prototype.restorePreInfuseState = function ( state ) {
8837 OO.ui.InputWidget.parent.prototype.restorePreInfuseState.call( this, state );
8838 if ( state.value !== undefined && state.value !== this.getValue() ) {
8839 this.setValue( state.value );
8840 }
8841 if ( state.focus ) {
8842 this.focus();
8843 }
8844 };
8845
8846 /**
8847 * Data widget intended for creating 'hidden'-type inputs.
8848 *
8849 * @class
8850 * @extends OO.ui.Widget
8851 *
8852 * @constructor
8853 * @param {Object} [config] Configuration options
8854 * @cfg {string} [value=''] The value of the input.
8855 * @cfg {string} [name=''] The value of the input’s HTML `name` attribute.
8856 */
8857 OO.ui.HiddenInputWidget = function OoUiHiddenInputWidget( config ) {
8858 // Configuration initialization
8859 config = $.extend( { value: '', name: '' }, config );
8860
8861 // Parent constructor
8862 OO.ui.HiddenInputWidget.parent.call( this, config );
8863
8864 // Initialization
8865 this.$element.attr( {
8866 type: 'hidden',
8867 value: config.value,
8868 name: config.name
8869 } );
8870 this.$element.removeAttr( 'aria-disabled' );
8871 };
8872
8873 /* Setup */
8874
8875 OO.inheritClass( OO.ui.HiddenInputWidget, OO.ui.Widget );
8876
8877 /* Static Properties */
8878
8879 /**
8880 * @static
8881 * @inheritdoc
8882 */
8883 OO.ui.HiddenInputWidget.static.tagName = 'input';
8884
8885 /**
8886 * ButtonInputWidget is used to submit HTML forms and is intended to be used within
8887 * a OO.ui.FormLayout. If you do not need the button to work with HTML forms, you probably
8888 * want to use OO.ui.ButtonWidget instead. Button input widgets can be rendered as either an
8889 * HTML `<button>` (the default) or an HTML `<input>` tags. See the
8890 * [OOUI documentation on MediaWiki] [1] for more information.
8891 *
8892 * @example
8893 * // A ButtonInputWidget rendered as an HTML button, the default.
8894 * var button = new OO.ui.ButtonInputWidget( {
8895 * label: 'Input button',
8896 * icon: 'check',
8897 * value: 'check'
8898 * } );
8899 * $( 'body' ).append( button.$element );
8900 *
8901 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs#Button_inputs
8902 *
8903 * @class
8904 * @extends OO.ui.InputWidget
8905 * @mixins OO.ui.mixin.ButtonElement
8906 * @mixins OO.ui.mixin.IconElement
8907 * @mixins OO.ui.mixin.IndicatorElement
8908 * @mixins OO.ui.mixin.LabelElement
8909 * @mixins OO.ui.mixin.TitledElement
8910 *
8911 * @constructor
8912 * @param {Object} [config] Configuration options
8913 * @cfg {string} [type='button'] The value of the HTML `'type'` attribute: 'button', 'submit' or 'reset'.
8914 * @cfg {boolean} [useInputTag=false] Use an `<input>` tag instead of a `<button>` tag, the default.
8915 * Widgets configured to be an `<input>` do not support {@link #icon icons} and {@link #indicator indicators},
8916 * non-plaintext {@link #label labels}, or {@link #value values}. In general, useInputTag should only
8917 * be set to `true` when there’s need to support IE 6 in a form with multiple buttons.
8918 */
8919 OO.ui.ButtonInputWidget = function OoUiButtonInputWidget( config ) {
8920 // Configuration initialization
8921 config = $.extend( { type: 'button', useInputTag: false }, config );
8922
8923 // See InputWidget#reusePreInfuseDOM about config.$input
8924 if ( config.$input ) {
8925 config.$input.empty();
8926 }
8927
8928 // Properties (must be set before parent constructor, which calls #setValue)
8929 this.useInputTag = config.useInputTag;
8930
8931 // Parent constructor
8932 OO.ui.ButtonInputWidget.parent.call( this, config );
8933
8934 // Mixin constructors
8935 OO.ui.mixin.ButtonElement.call( this, $.extend( {}, config, { $button: this.$input } ) );
8936 OO.ui.mixin.IconElement.call( this, config );
8937 OO.ui.mixin.IndicatorElement.call( this, config );
8938 OO.ui.mixin.LabelElement.call( this, config );
8939 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$input } ) );
8940
8941 // Initialization
8942 if ( !config.useInputTag ) {
8943 this.$input.append( this.$icon, this.$label, this.$indicator );
8944 }
8945 this.$element.addClass( 'oo-ui-buttonInputWidget' );
8946 };
8947
8948 /* Setup */
8949
8950 OO.inheritClass( OO.ui.ButtonInputWidget, OO.ui.InputWidget );
8951 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.ButtonElement );
8952 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.IconElement );
8953 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.IndicatorElement );
8954 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.LabelElement );
8955 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.mixin.TitledElement );
8956
8957 /* Static Properties */
8958
8959 /**
8960 * @static
8961 * @inheritdoc
8962 */
8963 OO.ui.ButtonInputWidget.static.tagName = 'span';
8964
8965 /* Methods */
8966
8967 /**
8968 * @inheritdoc
8969 * @protected
8970 */
8971 OO.ui.ButtonInputWidget.prototype.getInputElement = function ( config ) {
8972 var type;
8973 type = [ 'button', 'submit', 'reset' ].indexOf( config.type ) !== -1 ? config.type : 'button';
8974 return $( '<' + ( config.useInputTag ? 'input' : 'button' ) + ' type="' + type + '">' );
8975 };
8976
8977 /**
8978 * Set label value.
8979 *
8980 * If #useInputTag is `true`, the label is set as the `value` of the `<input>` tag.
8981 *
8982 * @param {jQuery|string|Function|null} label Label nodes, text, a function that returns nodes or
8983 * text, or `null` for no label
8984 * @chainable
8985 */
8986 OO.ui.ButtonInputWidget.prototype.setLabel = function ( label ) {
8987 if ( typeof label === 'function' ) {
8988 label = OO.ui.resolveMsg( label );
8989 }
8990
8991 if ( this.useInputTag ) {
8992 // Discard non-plaintext labels
8993 if ( typeof label !== 'string' ) {
8994 label = '';
8995 }
8996
8997 this.$input.val( label );
8998 }
8999
9000 return OO.ui.mixin.LabelElement.prototype.setLabel.call( this, label );
9001 };
9002
9003 /**
9004 * Set the value of the input.
9005 *
9006 * This method is disabled for button inputs configured as {@link #useInputTag <input> tags}, as
9007 * they do not support {@link #value values}.
9008 *
9009 * @param {string} value New value
9010 * @chainable
9011 */
9012 OO.ui.ButtonInputWidget.prototype.setValue = function ( value ) {
9013 if ( !this.useInputTag ) {
9014 OO.ui.ButtonInputWidget.parent.prototype.setValue.call( this, value );
9015 }
9016 return this;
9017 };
9018
9019 /**
9020 * @inheritdoc
9021 */
9022 OO.ui.ButtonInputWidget.prototype.getInputId = function () {
9023 // Disable generating `<label>` elements for buttons. One would very rarely need additional label
9024 // for a button, and it's already a big clickable target, and it causes unexpected rendering.
9025 return null;
9026 };
9027
9028 /**
9029 * CheckboxInputWidgets, like HTML checkboxes, can be selected and/or configured with a value.
9030 * Note that these {@link OO.ui.InputWidget input widgets} are best laid out
9031 * in {@link OO.ui.FieldLayout field layouts} that use the {@link OO.ui.FieldLayout#align inline}
9032 * alignment. For more information, please see the [OOUI documentation on MediaWiki][1].
9033 *
9034 * This widget can be used inside an HTML form, such as a OO.ui.FormLayout.
9035 *
9036 * @example
9037 * // An example of selected, unselected, and disabled checkbox inputs
9038 * var checkbox1=new OO.ui.CheckboxInputWidget( {
9039 * value: 'a',
9040 * selected: true
9041 * } );
9042 * var checkbox2=new OO.ui.CheckboxInputWidget( {
9043 * value: 'b'
9044 * } );
9045 * var checkbox3=new OO.ui.CheckboxInputWidget( {
9046 * value:'c',
9047 * disabled: true
9048 * } );
9049 * // Create a fieldset layout with fields for each checkbox.
9050 * var fieldset = new OO.ui.FieldsetLayout( {
9051 * label: 'Checkboxes'
9052 * } );
9053 * fieldset.addItems( [
9054 * new OO.ui.FieldLayout( checkbox1, { label: 'Selected checkbox', align: 'inline' } ),
9055 * new OO.ui.FieldLayout( checkbox2, { label: 'Unselected checkbox', align: 'inline' } ),
9056 * new OO.ui.FieldLayout( checkbox3, { label: 'Disabled checkbox', align: 'inline' } ),
9057 * ] );
9058 * $( 'body' ).append( fieldset.$element );
9059 *
9060 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
9061 *
9062 * @class
9063 * @extends OO.ui.InputWidget
9064 *
9065 * @constructor
9066 * @param {Object} [config] Configuration options
9067 * @cfg {boolean} [selected=false] Select the checkbox initially. By default, the checkbox is not selected.
9068 */
9069 OO.ui.CheckboxInputWidget = function OoUiCheckboxInputWidget( config ) {
9070 // Configuration initialization
9071 config = config || {};
9072
9073 // Parent constructor
9074 OO.ui.CheckboxInputWidget.parent.call( this, config );
9075
9076 // Initialization
9077 this.$element
9078 .addClass( 'oo-ui-checkboxInputWidget' )
9079 // Required for pretty styling in WikimediaUI theme
9080 .append( $( '<span>' ) );
9081 this.setSelected( config.selected !== undefined ? config.selected : false );
9082 };
9083
9084 /* Setup */
9085
9086 OO.inheritClass( OO.ui.CheckboxInputWidget, OO.ui.InputWidget );
9087
9088 /* Static Properties */
9089
9090 /**
9091 * @static
9092 * @inheritdoc
9093 */
9094 OO.ui.CheckboxInputWidget.static.tagName = 'span';
9095
9096 /* Static Methods */
9097
9098 /**
9099 * @inheritdoc
9100 */
9101 OO.ui.CheckboxInputWidget.static.gatherPreInfuseState = function ( node, config ) {
9102 var state = OO.ui.CheckboxInputWidget.parent.static.gatherPreInfuseState( node, config );
9103 state.checked = config.$input.prop( 'checked' );
9104 return state;
9105 };
9106
9107 /* Methods */
9108
9109 /**
9110 * @inheritdoc
9111 * @protected
9112 */
9113 OO.ui.CheckboxInputWidget.prototype.getInputElement = function () {
9114 return $( '<input>' ).attr( 'type', 'checkbox' );
9115 };
9116
9117 /**
9118 * @inheritdoc
9119 */
9120 OO.ui.CheckboxInputWidget.prototype.onEdit = function () {
9121 var widget = this;
9122 if ( !this.isDisabled() ) {
9123 // Allow the stack to clear so the value will be updated
9124 setTimeout( function () {
9125 widget.setSelected( widget.$input.prop( 'checked' ) );
9126 } );
9127 }
9128 };
9129
9130 /**
9131 * Set selection state of this checkbox.
9132 *
9133 * @param {boolean} state `true` for selected
9134 * @chainable
9135 */
9136 OO.ui.CheckboxInputWidget.prototype.setSelected = function ( state ) {
9137 state = !!state;
9138 if ( this.selected !== state ) {
9139 this.selected = state;
9140 this.$input.prop( 'checked', this.selected );
9141 this.emit( 'change', this.selected );
9142 }
9143 return this;
9144 };
9145
9146 /**
9147 * Check if this checkbox is selected.
9148 *
9149 * @return {boolean} Checkbox is selected
9150 */
9151 OO.ui.CheckboxInputWidget.prototype.isSelected = function () {
9152 // Resynchronize our internal data with DOM data. Other scripts executing on the page can modify
9153 // it, and we won't know unless they're kind enough to trigger a 'change' event.
9154 var selected = this.$input.prop( 'checked' );
9155 if ( this.selected !== selected ) {
9156 this.setSelected( selected );
9157 }
9158 return this.selected;
9159 };
9160
9161 /**
9162 * @inheritdoc
9163 */
9164 OO.ui.CheckboxInputWidget.prototype.simulateLabelClick = function () {
9165 if ( !this.isDisabled() ) {
9166 this.$input.click();
9167 }
9168 this.focus();
9169 };
9170
9171 /**
9172 * @inheritdoc
9173 */
9174 OO.ui.CheckboxInputWidget.prototype.restorePreInfuseState = function ( state ) {
9175 OO.ui.CheckboxInputWidget.parent.prototype.restorePreInfuseState.call( this, state );
9176 if ( state.checked !== undefined && state.checked !== this.isSelected() ) {
9177 this.setSelected( state.checked );
9178 }
9179 };
9180
9181 /**
9182 * DropdownInputWidget is a {@link OO.ui.DropdownWidget DropdownWidget} intended to be used
9183 * within an HTML form, such as a OO.ui.FormLayout. The selected value is synchronized with the value
9184 * of a hidden HTML `input` tag. Please see the [OOUI documentation on MediaWiki][1] for
9185 * more information about input widgets.
9186 *
9187 * A DropdownInputWidget always has a value (one of the options is always selected), unless there
9188 * are no options. If no `value` configuration option is provided, the first option is selected.
9189 * If you need a state representing no value (no option being selected), use a DropdownWidget.
9190 *
9191 * This and OO.ui.RadioSelectInputWidget support the same configuration options.
9192 *
9193 * @example
9194 * // Example: A DropdownInputWidget with three options
9195 * var dropdownInput = new OO.ui.DropdownInputWidget( {
9196 * options: [
9197 * { data: 'a', label: 'First' },
9198 * { data: 'b', label: 'Second'},
9199 * { data: 'c', label: 'Third' }
9200 * ]
9201 * } );
9202 * $( 'body' ).append( dropdownInput.$element );
9203 *
9204 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
9205 *
9206 * @class
9207 * @extends OO.ui.InputWidget
9208 *
9209 * @constructor
9210 * @param {Object} [config] Configuration options
9211 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
9212 * @cfg {Object} [dropdown] Configuration options for {@link OO.ui.DropdownWidget DropdownWidget}
9213 */
9214 OO.ui.DropdownInputWidget = function OoUiDropdownInputWidget( config ) {
9215 // Configuration initialization
9216 config = config || {};
9217
9218 // Properties (must be done before parent constructor which calls #setDisabled)
9219 this.dropdownWidget = new OO.ui.DropdownWidget( config.dropdown );
9220
9221 // Parent constructor
9222 OO.ui.DropdownInputWidget.parent.call( this, config );
9223
9224 // Events
9225 this.dropdownWidget.getMenu().connect( this, { select: 'onMenuSelect' } );
9226
9227 // Initialization
9228 this.setOptions( config.options || [] );
9229 // Set the value again, after we did setOptions(). The call from parent doesn't work because the
9230 // widget has no valid options when it happens.
9231 this.setValue( config.value );
9232 this.$element
9233 .addClass( 'oo-ui-dropdownInputWidget' )
9234 .append( this.dropdownWidget.$element );
9235 this.setTabIndexedElement( null );
9236 };
9237
9238 /* Setup */
9239
9240 OO.inheritClass( OO.ui.DropdownInputWidget, OO.ui.InputWidget );
9241
9242 /* Methods */
9243
9244 /**
9245 * @inheritdoc
9246 * @protected
9247 */
9248 OO.ui.DropdownInputWidget.prototype.getInputElement = function () {
9249 return $( '<select>' );
9250 };
9251
9252 /**
9253 * Handles menu select events.
9254 *
9255 * @private
9256 * @param {OO.ui.MenuOptionWidget|null} item Selected menu item
9257 */
9258 OO.ui.DropdownInputWidget.prototype.onMenuSelect = function ( item ) {
9259 this.setValue( item ? item.getData() : '' );
9260 };
9261
9262 /**
9263 * @inheritdoc
9264 */
9265 OO.ui.DropdownInputWidget.prototype.setValue = function ( value ) {
9266 var selected;
9267 value = this.cleanUpValue( value );
9268 // Only allow setting values that are actually present in the dropdown
9269 selected = this.dropdownWidget.getMenu().findItemFromData( value ) ||
9270 this.dropdownWidget.getMenu().findFirstSelectableItem();
9271 this.dropdownWidget.getMenu().selectItem( selected );
9272 value = selected ? selected.getData() : '';
9273 OO.ui.DropdownInputWidget.parent.prototype.setValue.call( this, value );
9274 return this;
9275 };
9276
9277 /**
9278 * @inheritdoc
9279 */
9280 OO.ui.DropdownInputWidget.prototype.setDisabled = function ( state ) {
9281 this.dropdownWidget.setDisabled( state );
9282 OO.ui.DropdownInputWidget.parent.prototype.setDisabled.call( this, state );
9283 return this;
9284 };
9285
9286 /**
9287 * Set the options available for this input.
9288 *
9289 * @param {Object[]} options Array of menu options in the format `{ data: …, label: … }`
9290 * @chainable
9291 */
9292 OO.ui.DropdownInputWidget.prototype.setOptions = function ( options ) {
9293 var
9294 optionWidgets = [],
9295 value = this.getValue(),
9296 $optionsContainer = this.$input,
9297 widget = this;
9298
9299 this.dropdownWidget.getMenu().clearItems();
9300 this.$input.empty();
9301
9302 // Rebuild the dropdown menu: our visible one and the hidden `<select>`
9303 options.forEach( function ( opt ) {
9304 var optValue, $optionNode, optionWidget;
9305
9306 if ( opt.optgroup === undefined ) {
9307 optValue = widget.cleanUpValue( opt.data );
9308
9309 $optionNode = $( '<option>' )
9310 .attr( 'value', optValue )
9311 .text( opt.label !== undefined ? opt.label : optValue );
9312 optionWidget = new OO.ui.MenuOptionWidget( {
9313 data: optValue,
9314 label: opt.label !== undefined ? opt.label : optValue
9315 } );
9316
9317 $optionsContainer.append( $optionNode );
9318 optionWidgets.push( optionWidget );
9319 } else {
9320 $optionNode = $( '<optgroup>' )
9321 .attr( 'label', opt.optgroup );
9322 optionWidget = new OO.ui.MenuSectionOptionWidget( {
9323 label: opt.optgroup
9324 } );
9325
9326 widget.$input.append( $optionNode );
9327 $optionsContainer = $optionNode;
9328 optionWidgets.push( optionWidget );
9329 }
9330 } );
9331 this.dropdownWidget.getMenu().addItems( optionWidgets );
9332
9333 // Restore the previous value, or reset to something sensible
9334 if ( this.dropdownWidget.getMenu().findItemFromData( value ) ) {
9335 // Previous value is still available, ensure consistency with the dropdown
9336 this.setValue( value );
9337 } else {
9338 // No longer valid, reset
9339 if ( options.length ) {
9340 this.setValue( options[ 0 ].data );
9341 }
9342 }
9343
9344 return this;
9345 };
9346
9347 /**
9348 * @inheritdoc
9349 */
9350 OO.ui.DropdownInputWidget.prototype.focus = function () {
9351 this.dropdownWidget.focus();
9352 return this;
9353 };
9354
9355 /**
9356 * @inheritdoc
9357 */
9358 OO.ui.DropdownInputWidget.prototype.blur = function () {
9359 this.dropdownWidget.blur();
9360 return this;
9361 };
9362
9363 /**
9364 * RadioInputWidget creates a single radio button. Because radio buttons are usually used as a set,
9365 * in most cases you will want to use a {@link OO.ui.RadioSelectWidget radio select}
9366 * with {@link OO.ui.RadioOptionWidget radio options} instead of this class. For more information,
9367 * please see the [OOUI documentation on MediaWiki][1].
9368 *
9369 * This widget can be used inside an HTML form, such as a OO.ui.FormLayout.
9370 *
9371 * @example
9372 * // An example of selected, unselected, and disabled radio inputs
9373 * var radio1 = new OO.ui.RadioInputWidget( {
9374 * value: 'a',
9375 * selected: true
9376 * } );
9377 * var radio2 = new OO.ui.RadioInputWidget( {
9378 * value: 'b'
9379 * } );
9380 * var radio3 = new OO.ui.RadioInputWidget( {
9381 * value: 'c',
9382 * disabled: true
9383 * } );
9384 * // Create a fieldset layout with fields for each radio button.
9385 * var fieldset = new OO.ui.FieldsetLayout( {
9386 * label: 'Radio inputs'
9387 * } );
9388 * fieldset.addItems( [
9389 * new OO.ui.FieldLayout( radio1, { label: 'Selected', align: 'inline' } ),
9390 * new OO.ui.FieldLayout( radio2, { label: 'Unselected', align: 'inline' } ),
9391 * new OO.ui.FieldLayout( radio3, { label: 'Disabled', align: 'inline' } ),
9392 * ] );
9393 * $( 'body' ).append( fieldset.$element );
9394 *
9395 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
9396 *
9397 * @class
9398 * @extends OO.ui.InputWidget
9399 *
9400 * @constructor
9401 * @param {Object} [config] Configuration options
9402 * @cfg {boolean} [selected=false] Select the radio button initially. By default, the radio button is not selected.
9403 */
9404 OO.ui.RadioInputWidget = function OoUiRadioInputWidget( config ) {
9405 // Configuration initialization
9406 config = config || {};
9407
9408 // Parent constructor
9409 OO.ui.RadioInputWidget.parent.call( this, config );
9410
9411 // Initialization
9412 this.$element
9413 .addClass( 'oo-ui-radioInputWidget' )
9414 // Required for pretty styling in WikimediaUI theme
9415 .append( $( '<span>' ) );
9416 this.setSelected( config.selected !== undefined ? config.selected : false );
9417 };
9418
9419 /* Setup */
9420
9421 OO.inheritClass( OO.ui.RadioInputWidget, OO.ui.InputWidget );
9422
9423 /* Static Properties */
9424
9425 /**
9426 * @static
9427 * @inheritdoc
9428 */
9429 OO.ui.RadioInputWidget.static.tagName = 'span';
9430
9431 /* Static Methods */
9432
9433 /**
9434 * @inheritdoc
9435 */
9436 OO.ui.RadioInputWidget.static.gatherPreInfuseState = function ( node, config ) {
9437 var state = OO.ui.RadioInputWidget.parent.static.gatherPreInfuseState( node, config );
9438 state.checked = config.$input.prop( 'checked' );
9439 return state;
9440 };
9441
9442 /* Methods */
9443
9444 /**
9445 * @inheritdoc
9446 * @protected
9447 */
9448 OO.ui.RadioInputWidget.prototype.getInputElement = function () {
9449 return $( '<input>' ).attr( 'type', 'radio' );
9450 };
9451
9452 /**
9453 * @inheritdoc
9454 */
9455 OO.ui.RadioInputWidget.prototype.onEdit = function () {
9456 // RadioInputWidget doesn't track its state.
9457 };
9458
9459 /**
9460 * Set selection state of this radio button.
9461 *
9462 * @param {boolean} state `true` for selected
9463 * @chainable
9464 */
9465 OO.ui.RadioInputWidget.prototype.setSelected = function ( state ) {
9466 // RadioInputWidget doesn't track its state.
9467 this.$input.prop( 'checked', state );
9468 return this;
9469 };
9470
9471 /**
9472 * Check if this radio button is selected.
9473 *
9474 * @return {boolean} Radio is selected
9475 */
9476 OO.ui.RadioInputWidget.prototype.isSelected = function () {
9477 return this.$input.prop( 'checked' );
9478 };
9479
9480 /**
9481 * @inheritdoc
9482 */
9483 OO.ui.RadioInputWidget.prototype.simulateLabelClick = function () {
9484 if ( !this.isDisabled() ) {
9485 this.$input.click();
9486 }
9487 this.focus();
9488 };
9489
9490 /**
9491 * @inheritdoc
9492 */
9493 OO.ui.RadioInputWidget.prototype.restorePreInfuseState = function ( state ) {
9494 OO.ui.RadioInputWidget.parent.prototype.restorePreInfuseState.call( this, state );
9495 if ( state.checked !== undefined && state.checked !== this.isSelected() ) {
9496 this.setSelected( state.checked );
9497 }
9498 };
9499
9500 /**
9501 * RadioSelectInputWidget is a {@link OO.ui.RadioSelectWidget RadioSelectWidget} intended to be used
9502 * within an HTML form, such as a OO.ui.FormLayout. The selected value is synchronized with the value
9503 * of a hidden HTML `input` tag. Please see the [OOUI documentation on MediaWiki][1] for
9504 * more information about input widgets.
9505 *
9506 * This and OO.ui.DropdownInputWidget support the same configuration options.
9507 *
9508 * @example
9509 * // Example: A RadioSelectInputWidget with three options
9510 * var radioSelectInput = new OO.ui.RadioSelectInputWidget( {
9511 * options: [
9512 * { data: 'a', label: 'First' },
9513 * { data: 'b', label: 'Second'},
9514 * { data: 'c', label: 'Third' }
9515 * ]
9516 * } );
9517 * $( 'body' ).append( radioSelectInput.$element );
9518 *
9519 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
9520 *
9521 * @class
9522 * @extends OO.ui.InputWidget
9523 *
9524 * @constructor
9525 * @param {Object} [config] Configuration options
9526 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
9527 */
9528 OO.ui.RadioSelectInputWidget = function OoUiRadioSelectInputWidget( config ) {
9529 // Configuration initialization
9530 config = config || {};
9531
9532 // Properties (must be done before parent constructor which calls #setDisabled)
9533 this.radioSelectWidget = new OO.ui.RadioSelectWidget();
9534
9535 // Parent constructor
9536 OO.ui.RadioSelectInputWidget.parent.call( this, config );
9537
9538 // Events
9539 this.radioSelectWidget.connect( this, { select: 'onMenuSelect' } );
9540
9541 // Initialization
9542 this.setOptions( config.options || [] );
9543 this.$element
9544 .addClass( 'oo-ui-radioSelectInputWidget' )
9545 .append( this.radioSelectWidget.$element );
9546 this.setTabIndexedElement( null );
9547 };
9548
9549 /* Setup */
9550
9551 OO.inheritClass( OO.ui.RadioSelectInputWidget, OO.ui.InputWidget );
9552
9553 /* Static Methods */
9554
9555 /**
9556 * @inheritdoc
9557 */
9558 OO.ui.RadioSelectInputWidget.static.gatherPreInfuseState = function ( node, config ) {
9559 var state = OO.ui.RadioSelectInputWidget.parent.static.gatherPreInfuseState( node, config );
9560 state.value = $( node ).find( '.oo-ui-radioInputWidget .oo-ui-inputWidget-input:checked' ).val();
9561 return state;
9562 };
9563
9564 /**
9565 * @inheritdoc
9566 */
9567 OO.ui.RadioSelectInputWidget.static.reusePreInfuseDOM = function ( node, config ) {
9568 config = OO.ui.RadioSelectInputWidget.parent.static.reusePreInfuseDOM( node, config );
9569 // Cannot reuse the `<input type=radio>` set
9570 delete config.$input;
9571 return config;
9572 };
9573
9574 /* Methods */
9575
9576 /**
9577 * @inheritdoc
9578 * @protected
9579 */
9580 OO.ui.RadioSelectInputWidget.prototype.getInputElement = function () {
9581 return $( '<input>' ).attr( 'type', 'hidden' );
9582 };
9583
9584 /**
9585 * Handles menu select events.
9586 *
9587 * @private
9588 * @param {OO.ui.RadioOptionWidget} item Selected menu item
9589 */
9590 OO.ui.RadioSelectInputWidget.prototype.onMenuSelect = function ( item ) {
9591 this.setValue( item.getData() );
9592 };
9593
9594 /**
9595 * @inheritdoc
9596 */
9597 OO.ui.RadioSelectInputWidget.prototype.setValue = function ( value ) {
9598 value = this.cleanUpValue( value );
9599 this.radioSelectWidget.selectItemByData( value );
9600 OO.ui.RadioSelectInputWidget.parent.prototype.setValue.call( this, value );
9601 return this;
9602 };
9603
9604 /**
9605 * @inheritdoc
9606 */
9607 OO.ui.RadioSelectInputWidget.prototype.setDisabled = function ( state ) {
9608 this.radioSelectWidget.setDisabled( state );
9609 OO.ui.RadioSelectInputWidget.parent.prototype.setDisabled.call( this, state );
9610 return this;
9611 };
9612
9613 /**
9614 * Set the options available for this input.
9615 *
9616 * @param {Object[]} options Array of menu options in the format `{ data: …, label: … }`
9617 * @chainable
9618 */
9619 OO.ui.RadioSelectInputWidget.prototype.setOptions = function ( options ) {
9620 var
9621 value = this.getValue(),
9622 widget = this;
9623
9624 // Rebuild the radioSelect menu
9625 this.radioSelectWidget
9626 .clearItems()
9627 .addItems( options.map( function ( opt ) {
9628 var optValue = widget.cleanUpValue( opt.data );
9629 return new OO.ui.RadioOptionWidget( {
9630 data: optValue,
9631 label: opt.label !== undefined ? opt.label : optValue
9632 } );
9633 } ) );
9634
9635 // Restore the previous value, or reset to something sensible
9636 if ( this.radioSelectWidget.findItemFromData( value ) ) {
9637 // Previous value is still available, ensure consistency with the radioSelect
9638 this.setValue( value );
9639 } else {
9640 // No longer valid, reset
9641 if ( options.length ) {
9642 this.setValue( options[ 0 ].data );
9643 }
9644 }
9645
9646 return this;
9647 };
9648
9649 /**
9650 * @inheritdoc
9651 */
9652 OO.ui.RadioSelectInputWidget.prototype.focus = function () {
9653 this.radioSelectWidget.focus();
9654 return this;
9655 };
9656
9657 /**
9658 * @inheritdoc
9659 */
9660 OO.ui.RadioSelectInputWidget.prototype.blur = function () {
9661 this.radioSelectWidget.blur();
9662 return this;
9663 };
9664
9665 /**
9666 * CheckboxMultiselectInputWidget is a
9667 * {@link OO.ui.CheckboxMultiselectWidget CheckboxMultiselectWidget} intended to be used within a
9668 * HTML form, such as a OO.ui.FormLayout. The selected values are synchronized with the value of
9669 * HTML `<input type=checkbox>` tags. Please see the [OOUI documentation on MediaWiki][1] for
9670 * more information about input widgets.
9671 *
9672 * @example
9673 * // Example: A CheckboxMultiselectInputWidget with three options
9674 * var multiselectInput = new OO.ui.CheckboxMultiselectInputWidget( {
9675 * options: [
9676 * { data: 'a', label: 'First' },
9677 * { data: 'b', label: 'Second'},
9678 * { data: 'c', label: 'Third' }
9679 * ]
9680 * } );
9681 * $( 'body' ).append( multiselectInput.$element );
9682 *
9683 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
9684 *
9685 * @class
9686 * @extends OO.ui.InputWidget
9687 *
9688 * @constructor
9689 * @param {Object} [config] Configuration options
9690 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: …, disabled: … }`
9691 */
9692 OO.ui.CheckboxMultiselectInputWidget = function OoUiCheckboxMultiselectInputWidget( config ) {
9693 // Configuration initialization
9694 config = config || {};
9695
9696 // Properties (must be done before parent constructor which calls #setDisabled)
9697 this.checkboxMultiselectWidget = new OO.ui.CheckboxMultiselectWidget();
9698
9699 // Parent constructor
9700 OO.ui.CheckboxMultiselectInputWidget.parent.call( this, config );
9701
9702 // Properties
9703 this.inputName = config.name;
9704
9705 // Initialization
9706 this.$element
9707 .addClass( 'oo-ui-checkboxMultiselectInputWidget' )
9708 .append( this.checkboxMultiselectWidget.$element );
9709 // We don't use this.$input, but rather the CheckboxInputWidgets inside each option
9710 this.$input.detach();
9711 this.setOptions( config.options || [] );
9712 // Have to repeat this from parent, as we need options to be set up for this to make sense
9713 this.setValue( config.value );
9714
9715 // setValue when checkboxMultiselectWidget changes
9716 this.checkboxMultiselectWidget.on( 'change', function () {
9717 this.setValue( this.checkboxMultiselectWidget.findSelectedItemsData() );
9718 }.bind( this ) );
9719 };
9720
9721 /* Setup */
9722
9723 OO.inheritClass( OO.ui.CheckboxMultiselectInputWidget, OO.ui.InputWidget );
9724
9725 /* Static Methods */
9726
9727 /**
9728 * @inheritdoc
9729 */
9730 OO.ui.CheckboxMultiselectInputWidget.static.gatherPreInfuseState = function ( node, config ) {
9731 var state = OO.ui.CheckboxMultiselectInputWidget.parent.static.gatherPreInfuseState( node, config );
9732 state.value = $( node ).find( '.oo-ui-checkboxInputWidget .oo-ui-inputWidget-input:checked' )
9733 .toArray().map( function ( el ) { return el.value; } );
9734 return state;
9735 };
9736
9737 /**
9738 * @inheritdoc
9739 */
9740 OO.ui.CheckboxMultiselectInputWidget.static.reusePreInfuseDOM = function ( node, config ) {
9741 config = OO.ui.CheckboxMultiselectInputWidget.parent.static.reusePreInfuseDOM( node, config );
9742 // Cannot reuse the `<input type=checkbox>` set
9743 delete config.$input;
9744 return config;
9745 };
9746
9747 /* Methods */
9748
9749 /**
9750 * @inheritdoc
9751 * @protected
9752 */
9753 OO.ui.CheckboxMultiselectInputWidget.prototype.getInputElement = function () {
9754 // Actually unused
9755 return $( '<unused>' );
9756 };
9757
9758 /**
9759 * @inheritdoc
9760 */
9761 OO.ui.CheckboxMultiselectInputWidget.prototype.getValue = function () {
9762 var value = this.$element.find( '.oo-ui-checkboxInputWidget .oo-ui-inputWidget-input:checked' )
9763 .toArray().map( function ( el ) { return el.value; } );
9764 if ( this.value !== value ) {
9765 this.setValue( value );
9766 }
9767 return this.value;
9768 };
9769
9770 /**
9771 * @inheritdoc
9772 */
9773 OO.ui.CheckboxMultiselectInputWidget.prototype.setValue = function ( value ) {
9774 value = this.cleanUpValue( value );
9775 this.checkboxMultiselectWidget.selectItemsByData( value );
9776 OO.ui.CheckboxMultiselectInputWidget.parent.prototype.setValue.call( this, value );
9777 return this;
9778 };
9779
9780 /**
9781 * Clean up incoming value.
9782 *
9783 * @param {string[]} value Original value
9784 * @return {string[]} Cleaned up value
9785 */
9786 OO.ui.CheckboxMultiselectInputWidget.prototype.cleanUpValue = function ( value ) {
9787 var i, singleValue,
9788 cleanValue = [];
9789 if ( !Array.isArray( value ) ) {
9790 return cleanValue;
9791 }
9792 for ( i = 0; i < value.length; i++ ) {
9793 singleValue =
9794 OO.ui.CheckboxMultiselectInputWidget.parent.prototype.cleanUpValue.call( this, value[ i ] );
9795 // Remove options that we don't have here
9796 if ( !this.checkboxMultiselectWidget.findItemFromData( singleValue ) ) {
9797 continue;
9798 }
9799 cleanValue.push( singleValue );
9800 }
9801 return cleanValue;
9802 };
9803
9804 /**
9805 * @inheritdoc
9806 */
9807 OO.ui.CheckboxMultiselectInputWidget.prototype.setDisabled = function ( state ) {
9808 this.checkboxMultiselectWidget.setDisabled( state );
9809 OO.ui.CheckboxMultiselectInputWidget.parent.prototype.setDisabled.call( this, state );
9810 return this;
9811 };
9812
9813 /**
9814 * Set the options available for this input.
9815 *
9816 * @param {Object[]} options Array of menu options in the format `{ data: …, label: …, disabled: … }`
9817 * @chainable
9818 */
9819 OO.ui.CheckboxMultiselectInputWidget.prototype.setOptions = function ( options ) {
9820 var widget = this;
9821
9822 // Rebuild the checkboxMultiselectWidget menu
9823 this.checkboxMultiselectWidget
9824 .clearItems()
9825 .addItems( options.map( function ( opt ) {
9826 var optValue, item, optDisabled;
9827 optValue =
9828 OO.ui.CheckboxMultiselectInputWidget.parent.prototype.cleanUpValue.call( widget, opt.data );
9829 optDisabled = opt.disabled !== undefined ? opt.disabled : false;
9830 item = new OO.ui.CheckboxMultioptionWidget( {
9831 data: optValue,
9832 label: opt.label !== undefined ? opt.label : optValue,
9833 disabled: optDisabled
9834 } );
9835 // Set the 'name' and 'value' for form submission
9836 item.checkbox.$input.attr( 'name', widget.inputName );
9837 item.checkbox.setValue( optValue );
9838 return item;
9839 } ) );
9840
9841 // Re-set the value, checking the checkboxes as needed.
9842 // This will also get rid of any stale options that we just removed.
9843 this.setValue( this.getValue() );
9844
9845 return this;
9846 };
9847
9848 /**
9849 * @inheritdoc
9850 */
9851 OO.ui.CheckboxMultiselectInputWidget.prototype.focus = function () {
9852 this.checkboxMultiselectWidget.focus();
9853 return this;
9854 };
9855
9856 /**
9857 * TextInputWidgets, like HTML text inputs, can be configured with options that customize the
9858 * size of the field as well as its presentation. In addition, these widgets can be configured
9859 * with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators}, an optional
9860 * validation-pattern (used to determine if an input value is valid or not) and an input filter,
9861 * which modifies incoming values rather than validating them.
9862 * Please see the [OOUI documentation on MediaWiki] [1] for more information and examples.
9863 *
9864 * This widget can be used inside an HTML form, such as a OO.ui.FormLayout.
9865 *
9866 * @example
9867 * // Example of a text input widget
9868 * var textInput = new OO.ui.TextInputWidget( {
9869 * value: 'Text input'
9870 * } )
9871 * $( 'body' ).append( textInput.$element );
9872 *
9873 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
9874 *
9875 * @class
9876 * @extends OO.ui.InputWidget
9877 * @mixins OO.ui.mixin.IconElement
9878 * @mixins OO.ui.mixin.IndicatorElement
9879 * @mixins OO.ui.mixin.PendingElement
9880 * @mixins OO.ui.mixin.LabelElement
9881 *
9882 * @constructor
9883 * @param {Object} [config] Configuration options
9884 * @cfg {string} [type='text'] The value of the HTML `type` attribute: 'text', 'password'
9885 * 'email', 'url' or 'number'.
9886 * @cfg {string} [placeholder] Placeholder text
9887 * @cfg {boolean} [autofocus=false] Use an HTML `autofocus` attribute to
9888 * instruct the browser to focus this widget.
9889 * @cfg {boolean} [readOnly=false] Prevent changes to the value of the text input.
9890 * @cfg {number} [maxLength] Maximum number of characters allowed in the input.
9891 * @cfg {string} [labelPosition='after'] The position of the inline label relative to that of
9892 * the value or placeholder text: `'before'` or `'after'`
9893 * @cfg {boolean} [required=false] Mark the field as required with `true`. Implies `indicator: 'required'`.
9894 * Note that `false` & setting `indicator: 'required' will result in no indicator shown.
9895 * @cfg {boolean} [autocomplete=true] Should the browser support autocomplete for this field
9896 * @cfg {boolean} [spellcheck] Should the browser support spellcheck for this field (`undefined` means
9897 * leaving it up to the browser).
9898 * @cfg {RegExp|Function|string} [validate] Validation pattern: when string, a symbolic name of a
9899 * pattern defined by the class: 'non-empty' (the value cannot be an empty string) or 'integer'
9900 * (the value must contain only numbers); when RegExp, a regular expression that must match the
9901 * value for it to be considered valid; when Function, a function receiving the value as parameter
9902 * that must return true, or promise resolving to true, for it to be considered valid.
9903 */
9904 OO.ui.TextInputWidget = function OoUiTextInputWidget( config ) {
9905 // Configuration initialization
9906 config = $.extend( {
9907 type: 'text',
9908 labelPosition: 'after'
9909 }, config );
9910
9911 if ( config.multiline ) {
9912 OO.ui.warnDeprecation( 'TextInputWidget: config.multiline is deprecated. Use the MultilineTextInputWidget instead. See T130434.' );
9913 return new OO.ui.MultilineTextInputWidget( config );
9914 }
9915
9916 // Parent constructor
9917 OO.ui.TextInputWidget.parent.call( this, config );
9918
9919 // Mixin constructors
9920 OO.ui.mixin.IconElement.call( this, config );
9921 OO.ui.mixin.IndicatorElement.call( this, config );
9922 OO.ui.mixin.PendingElement.call( this, $.extend( {}, config, { $pending: this.$input } ) );
9923 OO.ui.mixin.LabelElement.call( this, config );
9924
9925 // Properties
9926 this.type = this.getSaneType( config );
9927 this.readOnly = false;
9928 this.required = false;
9929 this.validate = null;
9930 this.styleHeight = null;
9931 this.scrollWidth = null;
9932
9933 this.setValidation( config.validate );
9934 this.setLabelPosition( config.labelPosition );
9935
9936 // Events
9937 this.$input.on( {
9938 keypress: this.onKeyPress.bind( this ),
9939 blur: this.onBlur.bind( this ),
9940 focus: this.onFocus.bind( this )
9941 } );
9942 this.$icon.on( 'mousedown', this.onIconMouseDown.bind( this ) );
9943 this.$indicator.on( 'mousedown', this.onIndicatorMouseDown.bind( this ) );
9944 this.on( 'labelChange', this.updatePosition.bind( this ) );
9945 this.on( 'change', OO.ui.debounce( this.onDebouncedChange.bind( this ), 250 ) );
9946
9947 // Initialization
9948 this.$element
9949 .addClass( 'oo-ui-textInputWidget oo-ui-textInputWidget-type-' + this.type )
9950 .append( this.$icon, this.$indicator );
9951 this.setReadOnly( !!config.readOnly );
9952 this.setRequired( !!config.required );
9953 if ( config.placeholder !== undefined ) {
9954 this.$input.attr( 'placeholder', config.placeholder );
9955 }
9956 if ( config.maxLength !== undefined ) {
9957 this.$input.attr( 'maxlength', config.maxLength );
9958 }
9959 if ( config.autofocus ) {
9960 this.$input.attr( 'autofocus', 'autofocus' );
9961 }
9962 if ( config.autocomplete === false ) {
9963 this.$input.attr( 'autocomplete', 'off' );
9964 // Turning off autocompletion also disables "form caching" when the user navigates to a
9965 // different page and then clicks "Back". Re-enable it when leaving. Borrowed from jQuery UI.
9966 $( window ).on( {
9967 beforeunload: function () {
9968 this.$input.removeAttr( 'autocomplete' );
9969 }.bind( this ),
9970 pageshow: function () {
9971 // Browsers don't seem to actually fire this event on "Back", they instead just reload the
9972 // whole page... it shouldn't hurt, though.
9973 this.$input.attr( 'autocomplete', 'off' );
9974 }.bind( this )
9975 } );
9976 }
9977 if ( config.spellcheck !== undefined ) {
9978 this.$input.attr( 'spellcheck', config.spellcheck ? 'true' : 'false' );
9979 }
9980 if ( this.label ) {
9981 this.isWaitingToBeAttached = true;
9982 this.installParentChangeDetector();
9983 }
9984 };
9985
9986 /* Setup */
9987
9988 OO.inheritClass( OO.ui.TextInputWidget, OO.ui.InputWidget );
9989 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.IconElement );
9990 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.IndicatorElement );
9991 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.PendingElement );
9992 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.mixin.LabelElement );
9993
9994 /* Static Properties */
9995
9996 OO.ui.TextInputWidget.static.validationPatterns = {
9997 'non-empty': /.+/,
9998 integer: /^\d+$/
9999 };
10000
10001 /* Static Methods */
10002
10003 /**
10004 * @inheritdoc
10005 */
10006 OO.ui.TextInputWidget.static.gatherPreInfuseState = function ( node, config ) {
10007 var state = OO.ui.TextInputWidget.parent.static.gatherPreInfuseState( node, config );
10008 return state;
10009 };
10010
10011 /* Events */
10012
10013 /**
10014 * An `enter` event is emitted when the user presses 'enter' inside the text box.
10015 *
10016 * @event enter
10017 */
10018
10019 /* Methods */
10020
10021 /**
10022 * Handle icon mouse down events.
10023 *
10024 * @private
10025 * @param {jQuery.Event} e Mouse down event
10026 */
10027 OO.ui.TextInputWidget.prototype.onIconMouseDown = function ( e ) {
10028 if ( e.which === OO.ui.MouseButtons.LEFT ) {
10029 this.focus();
10030 return false;
10031 }
10032 };
10033
10034 /**
10035 * Handle indicator mouse down events.
10036 *
10037 * @private
10038 * @param {jQuery.Event} e Mouse down event
10039 */
10040 OO.ui.TextInputWidget.prototype.onIndicatorMouseDown = function ( e ) {
10041 if ( e.which === OO.ui.MouseButtons.LEFT ) {
10042 this.focus();
10043 return false;
10044 }
10045 };
10046
10047 /**
10048 * Handle key press events.
10049 *
10050 * @private
10051 * @param {jQuery.Event} e Key press event
10052 * @fires enter If enter key is pressed
10053 */
10054 OO.ui.TextInputWidget.prototype.onKeyPress = function ( e ) {
10055 if ( e.which === OO.ui.Keys.ENTER ) {
10056 this.emit( 'enter', e );
10057 }
10058 };
10059
10060 /**
10061 * Handle blur events.
10062 *
10063 * @private
10064 * @param {jQuery.Event} e Blur event
10065 */
10066 OO.ui.TextInputWidget.prototype.onBlur = function () {
10067 this.setValidityFlag();
10068 };
10069
10070 /**
10071 * Handle focus events.
10072 *
10073 * @private
10074 * @param {jQuery.Event} e Focus event
10075 */
10076 OO.ui.TextInputWidget.prototype.onFocus = function () {
10077 if ( this.isWaitingToBeAttached ) {
10078 // If we've received focus, then we must be attached to the document, and if
10079 // isWaitingToBeAttached is still true, that means the handler never fired. Fire it now.
10080 this.onElementAttach();
10081 }
10082 this.setValidityFlag( true );
10083 };
10084
10085 /**
10086 * Handle element attach events.
10087 *
10088 * @private
10089 * @param {jQuery.Event} e Element attach event
10090 */
10091 OO.ui.TextInputWidget.prototype.onElementAttach = function () {
10092 this.isWaitingToBeAttached = false;
10093 // Any previously calculated size is now probably invalid if we reattached elsewhere
10094 this.valCache = null;
10095 this.positionLabel();
10096 };
10097
10098 /**
10099 * Handle debounced change events.
10100 *
10101 * @param {string} value
10102 * @private
10103 */
10104 OO.ui.TextInputWidget.prototype.onDebouncedChange = function () {
10105 this.setValidityFlag();
10106 };
10107
10108 /**
10109 * Check if the input is {@link #readOnly read-only}.
10110 *
10111 * @return {boolean}
10112 */
10113 OO.ui.TextInputWidget.prototype.isReadOnly = function () {
10114 return this.readOnly;
10115 };
10116
10117 /**
10118 * Set the {@link #readOnly read-only} state of the input.
10119 *
10120 * @param {boolean} state Make input read-only
10121 * @chainable
10122 */
10123 OO.ui.TextInputWidget.prototype.setReadOnly = function ( state ) {
10124 this.readOnly = !!state;
10125 this.$input.prop( 'readOnly', this.readOnly );
10126 return this;
10127 };
10128
10129 /**
10130 * Check if the input is {@link #required required}.
10131 *
10132 * @return {boolean}
10133 */
10134 OO.ui.TextInputWidget.prototype.isRequired = function () {
10135 return this.required;
10136 };
10137
10138 /**
10139 * Set the {@link #required required} state of the input.
10140 *
10141 * @param {boolean} state Make input required
10142 * @chainable
10143 */
10144 OO.ui.TextInputWidget.prototype.setRequired = function ( state ) {
10145 this.required = !!state;
10146 if ( this.required ) {
10147 this.$input
10148 .prop( 'required', true )
10149 .attr( 'aria-required', 'true' );
10150 if ( this.getIndicator() === null ) {
10151 this.setIndicator( 'required' );
10152 }
10153 } else {
10154 this.$input
10155 .prop( 'required', false )
10156 .removeAttr( 'aria-required' );
10157 if ( this.getIndicator() === 'required' ) {
10158 this.setIndicator( null );
10159 }
10160 }
10161 return this;
10162 };
10163
10164 /**
10165 * Support function for making #onElementAttach work across browsers.
10166 *
10167 * This whole function could be replaced with one line of code using the DOMNodeInsertedIntoDocument
10168 * event, but it's not supported by Firefox and allegedly deprecated, so we only use it as fallback.
10169 *
10170 * Due to MutationObserver performance woes, #onElementAttach is only somewhat reliably called the
10171 * first time that the element gets attached to the documented.
10172 */
10173 OO.ui.TextInputWidget.prototype.installParentChangeDetector = function () {
10174 var mutationObserver, onRemove, topmostNode, fakeParentNode,
10175 MutationObserver = window.MutationObserver || window.WebKitMutationObserver || window.MozMutationObserver,
10176 widget = this;
10177
10178 if ( MutationObserver ) {
10179 // The new way. If only it wasn't so ugly.
10180
10181 if ( this.isElementAttached() ) {
10182 // Widget is attached already, do nothing. This breaks the functionality of this function when
10183 // the widget is detached and reattached. Alas, doing this correctly with MutationObserver
10184 // would require observation of the whole document, which would hurt performance of other,
10185 // more important code.
10186 return;
10187 }
10188
10189 // Find topmost node in the tree
10190 topmostNode = this.$element[ 0 ];
10191 while ( topmostNode.parentNode ) {
10192 topmostNode = topmostNode.parentNode;
10193 }
10194
10195 // We have no way to detect the $element being attached somewhere without observing the entire
10196 // DOM with subtree modifications, which would hurt performance. So we cheat: we hook to the
10197 // parent node of $element, and instead detect when $element is removed from it (and thus
10198 // probably attached somewhere else). If there is no parent, we create a "fake" one. If it
10199 // doesn't get attached, we end up back here and create the parent.
10200
10201 mutationObserver = new MutationObserver( function ( mutations ) {
10202 var i, j, removedNodes;
10203 for ( i = 0; i < mutations.length; i++ ) {
10204 removedNodes = mutations[ i ].removedNodes;
10205 for ( j = 0; j < removedNodes.length; j++ ) {
10206 if ( removedNodes[ j ] === topmostNode ) {
10207 setTimeout( onRemove, 0 );
10208 return;
10209 }
10210 }
10211 }
10212 } );
10213
10214 onRemove = function () {
10215 // If the node was attached somewhere else, report it
10216 if ( widget.isElementAttached() ) {
10217 widget.onElementAttach();
10218 }
10219 mutationObserver.disconnect();
10220 widget.installParentChangeDetector();
10221 };
10222
10223 // Create a fake parent and observe it
10224 fakeParentNode = $( '<div>' ).append( topmostNode )[ 0 ];
10225 mutationObserver.observe( fakeParentNode, { childList: true } );
10226 } else {
10227 // Using the DOMNodeInsertedIntoDocument event is much nicer and less magical, and works for
10228 // detachment and reattachment, but it's not supported by Firefox and allegedly deprecated.
10229 this.$element.on( 'DOMNodeInsertedIntoDocument', this.onElementAttach.bind( this ) );
10230 }
10231 };
10232
10233 /**
10234 * @inheritdoc
10235 * @protected
10236 */
10237 OO.ui.TextInputWidget.prototype.getInputElement = function ( config ) {
10238 if ( this.getSaneType( config ) === 'number' ) {
10239 return $( '<input>' )
10240 .attr( 'step', 'any' )
10241 .attr( 'type', 'number' );
10242 } else {
10243 return $( '<input>' ).attr( 'type', this.getSaneType( config ) );
10244 }
10245 };
10246
10247 /**
10248 * Get sanitized value for 'type' for given config.
10249 *
10250 * @param {Object} config Configuration options
10251 * @return {string|null}
10252 * @protected
10253 */
10254 OO.ui.TextInputWidget.prototype.getSaneType = function ( config ) {
10255 var allowedTypes = [
10256 'text',
10257 'password',
10258 'email',
10259 'url',
10260 'number'
10261 ];
10262 return allowedTypes.indexOf( config.type ) !== -1 ? config.type : 'text';
10263 };
10264
10265 /**
10266 * Focus the input and select a specified range within the text.
10267 *
10268 * @param {number} from Select from offset
10269 * @param {number} [to] Select to offset, defaults to from
10270 * @chainable
10271 */
10272 OO.ui.TextInputWidget.prototype.selectRange = function ( from, to ) {
10273 var isBackwards, start, end,
10274 input = this.$input[ 0 ];
10275
10276 to = to || from;
10277
10278 isBackwards = to < from;
10279 start = isBackwards ? to : from;
10280 end = isBackwards ? from : to;
10281
10282 this.focus();
10283
10284 try {
10285 input.setSelectionRange( start, end, isBackwards ? 'backward' : 'forward' );
10286 } catch ( e ) {
10287 // IE throws an exception if you call setSelectionRange on a unattached DOM node.
10288 // Rather than expensively check if the input is attached every time, just check
10289 // if it was the cause of an error being thrown. If not, rethrow the error.
10290 if ( this.getElementDocument().body.contains( input ) ) {
10291 throw e;
10292 }
10293 }
10294 return this;
10295 };
10296
10297 /**
10298 * Get an object describing the current selection range in a directional manner
10299 *
10300 * @return {Object} Object containing 'from' and 'to' offsets
10301 */
10302 OO.ui.TextInputWidget.prototype.getRange = function () {
10303 var input = this.$input[ 0 ],
10304 start = input.selectionStart,
10305 end = input.selectionEnd,
10306 isBackwards = input.selectionDirection === 'backward';
10307
10308 return {
10309 from: isBackwards ? end : start,
10310 to: isBackwards ? start : end
10311 };
10312 };
10313
10314 /**
10315 * Get the length of the text input value.
10316 *
10317 * This could differ from the length of #getValue if the
10318 * value gets filtered
10319 *
10320 * @return {number} Input length
10321 */
10322 OO.ui.TextInputWidget.prototype.getInputLength = function () {
10323 return this.$input[ 0 ].value.length;
10324 };
10325
10326 /**
10327 * Focus the input and select the entire text.
10328 *
10329 * @chainable
10330 */
10331 OO.ui.TextInputWidget.prototype.select = function () {
10332 return this.selectRange( 0, this.getInputLength() );
10333 };
10334
10335 /**
10336 * Focus the input and move the cursor to the start.
10337 *
10338 * @chainable
10339 */
10340 OO.ui.TextInputWidget.prototype.moveCursorToStart = function () {
10341 return this.selectRange( 0 );
10342 };
10343
10344 /**
10345 * Focus the input and move the cursor to the end.
10346 *
10347 * @chainable
10348 */
10349 OO.ui.TextInputWidget.prototype.moveCursorToEnd = function () {
10350 return this.selectRange( this.getInputLength() );
10351 };
10352
10353 /**
10354 * Insert new content into the input.
10355 *
10356 * @param {string} content Content to be inserted
10357 * @chainable
10358 */
10359 OO.ui.TextInputWidget.prototype.insertContent = function ( content ) {
10360 var start, end,
10361 range = this.getRange(),
10362 value = this.getValue();
10363
10364 start = Math.min( range.from, range.to );
10365 end = Math.max( range.from, range.to );
10366
10367 this.setValue( value.slice( 0, start ) + content + value.slice( end ) );
10368 this.selectRange( start + content.length );
10369 return this;
10370 };
10371
10372 /**
10373 * Insert new content either side of a selection.
10374 *
10375 * @param {string} pre Content to be inserted before the selection
10376 * @param {string} post Content to be inserted after the selection
10377 * @chainable
10378 */
10379 OO.ui.TextInputWidget.prototype.encapsulateContent = function ( pre, post ) {
10380 var start, end,
10381 range = this.getRange(),
10382 offset = pre.length;
10383
10384 start = Math.min( range.from, range.to );
10385 end = Math.max( range.from, range.to );
10386
10387 this.selectRange( start ).insertContent( pre );
10388 this.selectRange( offset + end ).insertContent( post );
10389
10390 this.selectRange( offset + start, offset + end );
10391 return this;
10392 };
10393
10394 /**
10395 * Set the validation pattern.
10396 *
10397 * The validation pattern is either a regular expression, a function, or the symbolic name of a
10398 * pattern defined by the class: 'non-empty' (the value cannot be an empty string) or 'integer' (the
10399 * value must contain only numbers).
10400 *
10401 * @param {RegExp|Function|string|null} validate Regular expression, function, or the symbolic name
10402 * of a pattern (either ‘integer’ or ‘non-empty’) defined by the class.
10403 */
10404 OO.ui.TextInputWidget.prototype.setValidation = function ( validate ) {
10405 if ( validate instanceof RegExp || validate instanceof Function ) {
10406 this.validate = validate;
10407 } else {
10408 this.validate = this.constructor.static.validationPatterns[ validate ] || /.*/;
10409 }
10410 };
10411
10412 /**
10413 * Sets the 'invalid' flag appropriately.
10414 *
10415 * @param {boolean} [isValid] Optionally override validation result
10416 */
10417 OO.ui.TextInputWidget.prototype.setValidityFlag = function ( isValid ) {
10418 var widget = this,
10419 setFlag = function ( valid ) {
10420 if ( !valid ) {
10421 widget.$input.attr( 'aria-invalid', 'true' );
10422 } else {
10423 widget.$input.removeAttr( 'aria-invalid' );
10424 }
10425 widget.setFlags( { invalid: !valid } );
10426 };
10427
10428 if ( isValid !== undefined ) {
10429 setFlag( isValid );
10430 } else {
10431 this.getValidity().then( function () {
10432 setFlag( true );
10433 }, function () {
10434 setFlag( false );
10435 } );
10436 }
10437 };
10438
10439 /**
10440 * Get the validity of current value.
10441 *
10442 * This method returns a promise that resolves if the value is valid and rejects if
10443 * it isn't. Uses the {@link #validate validation pattern} to check for validity.
10444 *
10445 * @return {jQuery.Promise} A promise that resolves if the value is valid, rejects if not.
10446 */
10447 OO.ui.TextInputWidget.prototype.getValidity = function () {
10448 var result;
10449
10450 function rejectOrResolve( valid ) {
10451 if ( valid ) {
10452 return $.Deferred().resolve().promise();
10453 } else {
10454 return $.Deferred().reject().promise();
10455 }
10456 }
10457
10458 // Check browser validity and reject if it is invalid
10459 if (
10460 this.$input[ 0 ].checkValidity !== undefined &&
10461 this.$input[ 0 ].checkValidity() === false
10462 ) {
10463 return rejectOrResolve( false );
10464 }
10465
10466 // Run our checks if the browser thinks the field is valid
10467 if ( this.validate instanceof Function ) {
10468 result = this.validate( this.getValue() );
10469 if ( result && $.isFunction( result.promise ) ) {
10470 return result.promise().then( function ( valid ) {
10471 return rejectOrResolve( valid );
10472 } );
10473 } else {
10474 return rejectOrResolve( result );
10475 }
10476 } else {
10477 return rejectOrResolve( this.getValue().match( this.validate ) );
10478 }
10479 };
10480
10481 /**
10482 * Set the position of the inline label relative to that of the value: `‘before’` or `‘after’`.
10483 *
10484 * @param {string} labelPosition Label position, 'before' or 'after'
10485 * @chainable
10486 */
10487 OO.ui.TextInputWidget.prototype.setLabelPosition = function ( labelPosition ) {
10488 this.labelPosition = labelPosition;
10489 if ( this.label ) {
10490 // If there is no label and we only change the position, #updatePosition is a no-op,
10491 // but it takes really a lot of work to do nothing.
10492 this.updatePosition();
10493 }
10494 return this;
10495 };
10496
10497 /**
10498 * Update the position of the inline label.
10499 *
10500 * This method is called by #setLabelPosition, and can also be called on its own if
10501 * something causes the label to be mispositioned.
10502 *
10503 * @chainable
10504 */
10505 OO.ui.TextInputWidget.prototype.updatePosition = function () {
10506 var after = this.labelPosition === 'after';
10507
10508 this.$element
10509 .toggleClass( 'oo-ui-textInputWidget-labelPosition-after', !!this.label && after )
10510 .toggleClass( 'oo-ui-textInputWidget-labelPosition-before', !!this.label && !after );
10511
10512 this.valCache = null;
10513 this.scrollWidth = null;
10514 this.positionLabel();
10515
10516 return this;
10517 };
10518
10519 /**
10520 * Position the label by setting the correct padding on the input.
10521 *
10522 * @private
10523 * @chainable
10524 */
10525 OO.ui.TextInputWidget.prototype.positionLabel = function () {
10526 var after, rtl, property, newCss;
10527
10528 if ( this.isWaitingToBeAttached ) {
10529 // #onElementAttach will be called soon, which calls this method
10530 return this;
10531 }
10532
10533 newCss = {
10534 'padding-right': '',
10535 'padding-left': ''
10536 };
10537
10538 if ( this.label ) {
10539 this.$element.append( this.$label );
10540 } else {
10541 this.$label.detach();
10542 // Clear old values if present
10543 this.$input.css( newCss );
10544 return;
10545 }
10546
10547 after = this.labelPosition === 'after';
10548 rtl = this.$element.css( 'direction' ) === 'rtl';
10549 property = after === rtl ? 'padding-left' : 'padding-right';
10550
10551 newCss[ property ] = this.$label.outerWidth( true ) + ( after ? this.scrollWidth : 0 );
10552 // We have to clear the padding on the other side, in case the element direction changed
10553 this.$input.css( newCss );
10554
10555 return this;
10556 };
10557
10558 /**
10559 * @inheritdoc
10560 */
10561 OO.ui.TextInputWidget.prototype.restorePreInfuseState = function ( state ) {
10562 OO.ui.TextInputWidget.parent.prototype.restorePreInfuseState.call( this, state );
10563 if ( state.scrollTop !== undefined ) {
10564 this.$input.scrollTop( state.scrollTop );
10565 }
10566 };
10567
10568 /**
10569 * @class
10570 * @extends OO.ui.TextInputWidget
10571 *
10572 * @constructor
10573 * @param {Object} [config] Configuration options
10574 */
10575 OO.ui.SearchInputWidget = function OoUiSearchInputWidget( config ) {
10576 config = $.extend( {
10577 icon: 'search'
10578 }, config );
10579
10580 // Parent constructor
10581 OO.ui.SearchInputWidget.parent.call( this, config );
10582
10583 // Events
10584 this.connect( this, {
10585 change: 'onChange'
10586 } );
10587
10588 // Initialization
10589 this.updateSearchIndicator();
10590 this.connect( this, {
10591 disable: 'onDisable'
10592 } );
10593 };
10594
10595 /* Setup */
10596
10597 OO.inheritClass( OO.ui.SearchInputWidget, OO.ui.TextInputWidget );
10598
10599 /* Methods */
10600
10601 /**
10602 * @inheritdoc
10603 * @protected
10604 */
10605 OO.ui.SearchInputWidget.prototype.getSaneType = function () {
10606 return 'search';
10607 };
10608
10609 /**
10610 * @inheritdoc
10611 */
10612 OO.ui.SearchInputWidget.prototype.onIndicatorMouseDown = function ( e ) {
10613 if ( e.which === OO.ui.MouseButtons.LEFT ) {
10614 // Clear the text field
10615 this.setValue( '' );
10616 this.focus();
10617 return false;
10618 }
10619 };
10620
10621 /**
10622 * Update the 'clear' indicator displayed on type: 'search' text
10623 * fields, hiding it when the field is already empty or when it's not
10624 * editable.
10625 */
10626 OO.ui.SearchInputWidget.prototype.updateSearchIndicator = function () {
10627 if ( this.getValue() === '' || this.isDisabled() || this.isReadOnly() ) {
10628 this.setIndicator( null );
10629 } else {
10630 this.setIndicator( 'clear' );
10631 }
10632 };
10633
10634 /**
10635 * Handle change events.
10636 *
10637 * @private
10638 */
10639 OO.ui.SearchInputWidget.prototype.onChange = function () {
10640 this.updateSearchIndicator();
10641 };
10642
10643 /**
10644 * Handle disable events.
10645 *
10646 * @param {boolean} disabled Element is disabled
10647 * @private
10648 */
10649 OO.ui.SearchInputWidget.prototype.onDisable = function () {
10650 this.updateSearchIndicator();
10651 };
10652
10653 /**
10654 * @inheritdoc
10655 */
10656 OO.ui.SearchInputWidget.prototype.setReadOnly = function ( state ) {
10657 OO.ui.SearchInputWidget.parent.prototype.setReadOnly.call( this, state );
10658 this.updateSearchIndicator();
10659 return this;
10660 };
10661
10662 /**
10663 * @class
10664 * @extends OO.ui.TextInputWidget
10665 *
10666 * @constructor
10667 * @param {Object} [config] Configuration options
10668 * @cfg {number} [rows] Number of visible lines in textarea. If used with `autosize`,
10669 * specifies minimum number of rows to display.
10670 * @cfg {string} [labelPosition='after'] The position of the inline label relative to that of
10671 * @cfg {boolean} [autosize=false] Automatically resize the text input to fit its content.
10672 * Use the #maxRows config to specify a maximum number of displayed rows.
10673 * @cfg {number} [maxRows] Maximum number of rows to display when #autosize is set to true.
10674 * Defaults to the maximum of `10` and `2 * rows`, or `10` if `rows` isn't provided.
10675 */
10676 OO.ui.MultilineTextInputWidget = function OoUiMultilineTextInputWidget( config ) {
10677 config = $.extend( {
10678 type: 'text'
10679 }, config );
10680 config.multiline = false;
10681 // Parent constructor
10682 OO.ui.MultilineTextInputWidget.parent.call( this, config );
10683
10684 // Properties
10685 this.multiline = true;
10686 this.autosize = !!config.autosize;
10687 this.minRows = config.rows !== undefined ? config.rows : '';
10688 this.maxRows = config.maxRows || Math.max( 2 * ( this.minRows || 0 ), 10 );
10689
10690 // Clone for resizing
10691 if ( this.autosize ) {
10692 this.$clone = this.$input
10693 .clone()
10694 .insertAfter( this.$input )
10695 .attr( 'aria-hidden', 'true' )
10696 .addClass( 'oo-ui-element-hidden' );
10697 }
10698
10699 // Events
10700 this.connect( this, {
10701 change: 'onChange'
10702 } );
10703
10704 // Initialization
10705 if ( this.multiline && config.rows ) {
10706 this.$input.attr( 'rows', config.rows );
10707 }
10708 if ( this.autosize ) {
10709 this.isWaitingToBeAttached = true;
10710 this.installParentChangeDetector();
10711 }
10712 };
10713
10714 /* Setup */
10715
10716 OO.inheritClass( OO.ui.MultilineTextInputWidget, OO.ui.TextInputWidget );
10717
10718 /* Static Methods */
10719
10720 /**
10721 * @inheritdoc
10722 */
10723 OO.ui.MultilineTextInputWidget.static.gatherPreInfuseState = function ( node, config ) {
10724 var state = OO.ui.MultilineTextInputWidget.parent.static.gatherPreInfuseState( node, config );
10725 state.scrollTop = config.$input.scrollTop();
10726 return state;
10727 };
10728
10729 /* Methods */
10730
10731 /**
10732 * @inheritdoc
10733 */
10734 OO.ui.MultilineTextInputWidget.prototype.onElementAttach = function () {
10735 OO.ui.MultilineTextInputWidget.parent.prototype.onElementAttach.call( this );
10736 this.adjustSize();
10737 };
10738
10739 /**
10740 * Handle change events.
10741 *
10742 * @private
10743 */
10744 OO.ui.MultilineTextInputWidget.prototype.onChange = function () {
10745 this.adjustSize();
10746 };
10747
10748 /**
10749 * @inheritdoc
10750 */
10751 OO.ui.MultilineTextInputWidget.prototype.updatePosition = function () {
10752 OO.ui.MultilineTextInputWidget.parent.prototype.updatePosition.call( this );
10753 this.adjustSize();
10754 };
10755
10756 /**
10757 * Override TextInputWidget so it doesn't emit the 'enter' event.
10758 *
10759 * @private
10760 * @param {jQuery.Event} e Key press event
10761 */
10762 OO.ui.MultilineTextInputWidget.prototype.onKeyPress = function () {
10763 return;
10764 };
10765
10766 /**
10767 * Automatically adjust the size of the text input.
10768 *
10769 * This only affects multiline inputs that are {@link #autosize autosized}.
10770 *
10771 * @chainable
10772 * @fires resize
10773 */
10774 OO.ui.MultilineTextInputWidget.prototype.adjustSize = function () {
10775 var scrollHeight, innerHeight, outerHeight, maxInnerHeight, measurementError,
10776 idealHeight, newHeight, scrollWidth, property;
10777
10778 if ( this.$input.val() !== this.valCache ) {
10779 if ( this.autosize ) {
10780 this.$clone
10781 .val( this.$input.val() )
10782 .attr( 'rows', this.minRows )
10783 // Set inline height property to 0 to measure scroll height
10784 .css( 'height', 0 );
10785
10786 this.$clone.removeClass( 'oo-ui-element-hidden' );
10787
10788 this.valCache = this.$input.val();
10789
10790 scrollHeight = this.$clone[ 0 ].scrollHeight;
10791
10792 // Remove inline height property to measure natural heights
10793 this.$clone.css( 'height', '' );
10794 innerHeight = this.$clone.innerHeight();
10795 outerHeight = this.$clone.outerHeight();
10796
10797 // Measure max rows height
10798 this.$clone
10799 .attr( 'rows', this.maxRows )
10800 .css( 'height', 'auto' )
10801 .val( '' );
10802 maxInnerHeight = this.$clone.innerHeight();
10803
10804 // Difference between reported innerHeight and scrollHeight with no scrollbars present.
10805 // This is sometimes non-zero on Blink-based browsers, depending on zoom level.
10806 measurementError = maxInnerHeight - this.$clone[ 0 ].scrollHeight;
10807 idealHeight = Math.min( maxInnerHeight, scrollHeight + measurementError );
10808
10809 this.$clone.addClass( 'oo-ui-element-hidden' );
10810
10811 // Only apply inline height when expansion beyond natural height is needed
10812 // Use the difference between the inner and outer height as a buffer
10813 newHeight = idealHeight > innerHeight ? idealHeight + ( outerHeight - innerHeight ) : '';
10814 if ( newHeight !== this.styleHeight ) {
10815 this.$input.css( 'height', newHeight );
10816 this.styleHeight = newHeight;
10817 this.emit( 'resize' );
10818 }
10819 }
10820 scrollWidth = this.$input[ 0 ].offsetWidth - this.$input[ 0 ].clientWidth;
10821 if ( scrollWidth !== this.scrollWidth ) {
10822 property = this.$element.css( 'direction' ) === 'rtl' ? 'left' : 'right';
10823 // Reset
10824 this.$label.css( { right: '', left: '' } );
10825 this.$indicator.css( { right: '', left: '' } );
10826
10827 if ( scrollWidth ) {
10828 this.$indicator.css( property, scrollWidth );
10829 if ( this.labelPosition === 'after' ) {
10830 this.$label.css( property, scrollWidth );
10831 }
10832 }
10833
10834 this.scrollWidth = scrollWidth;
10835 this.positionLabel();
10836 }
10837 }
10838 return this;
10839 };
10840
10841 /**
10842 * @inheritdoc
10843 * @protected
10844 */
10845 OO.ui.MultilineTextInputWidget.prototype.getInputElement = function () {
10846 return $( '<textarea>' );
10847 };
10848
10849 /**
10850 * Check if the input supports multiple lines.
10851 *
10852 * @return {boolean}
10853 */
10854 OO.ui.MultilineTextInputWidget.prototype.isMultiline = function () {
10855 return !!this.multiline;
10856 };
10857
10858 /**
10859 * Check if the input automatically adjusts its size.
10860 *
10861 * @return {boolean}
10862 */
10863 OO.ui.MultilineTextInputWidget.prototype.isAutosizing = function () {
10864 return !!this.autosize;
10865 };
10866
10867 /**
10868 * ComboBoxInputWidgets combine a {@link OO.ui.TextInputWidget text input} (where a value
10869 * can be entered manually) and a {@link OO.ui.MenuSelectWidget menu of options} (from which
10870 * a value can be chosen instead). Users can choose options from the combo box in one of two ways:
10871 *
10872 * - by typing a value in the text input field. If the value exactly matches the value of a menu
10873 * option, that option will appear to be selected.
10874 * - by choosing a value from the menu. The value of the chosen option will then appear in the text
10875 * input field.
10876 *
10877 * After the user chooses an option, its `data` will be used as a new value for the widget.
10878 * A `label` also can be specified for each option: if given, it will be shown instead of the
10879 * `data` in the dropdown menu.
10880 *
10881 * This widget can be used inside an HTML form, such as a OO.ui.FormLayout.
10882 *
10883 * For more information about menus and options, please see the [OOUI documentation on MediaWiki][1].
10884 *
10885 * @example
10886 * // Example: A ComboBoxInputWidget.
10887 * var comboBox = new OO.ui.ComboBoxInputWidget( {
10888 * value: 'Option 1',
10889 * options: [
10890 * { data: 'Option 1' },
10891 * { data: 'Option 2' },
10892 * { data: 'Option 3' }
10893 * ]
10894 * } );
10895 * $( 'body' ).append( comboBox.$element );
10896 *
10897 * @example
10898 * // Example: A ComboBoxInputWidget with additional option labels.
10899 * var comboBox = new OO.ui.ComboBoxInputWidget( {
10900 * value: 'Option 1',
10901 * options: [
10902 * {
10903 * data: 'Option 1',
10904 * label: 'Option One'
10905 * },
10906 * {
10907 * data: 'Option 2',
10908 * label: 'Option Two'
10909 * },
10910 * {
10911 * data: 'Option 3',
10912 * label: 'Option Three'
10913 * }
10914 * ]
10915 * } );
10916 * $( 'body' ).append( comboBox.$element );
10917 *
10918 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Menu_selects_and_options
10919 *
10920 * @class
10921 * @extends OO.ui.TextInputWidget
10922 *
10923 * @constructor
10924 * @param {Object} [config] Configuration options
10925 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
10926 * @cfg {Object} [menu] Configuration options to pass to the {@link OO.ui.MenuSelectWidget menu select widget}.
10927 * @cfg {jQuery} [$overlay] Render the menu into a separate layer. This configuration is useful in cases where
10928 * the expanded menu is larger than its containing `<div>`. The specified overlay layer is usually on top of the
10929 * containing `<div>` and has a larger area. By default, the menu uses relative positioning.
10930 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
10931 */
10932 OO.ui.ComboBoxInputWidget = function OoUiComboBoxInputWidget( config ) {
10933 // Configuration initialization
10934 config = $.extend( {
10935 autocomplete: false
10936 }, config );
10937
10938 // ComboBoxInputWidget shouldn't support `multiline`
10939 config.multiline = false;
10940
10941 // See InputWidget#reusePreInfuseDOM about `config.$input`
10942 if ( config.$input ) {
10943 config.$input.removeAttr( 'list' );
10944 }
10945
10946 // Parent constructor
10947 OO.ui.ComboBoxInputWidget.parent.call( this, config );
10948
10949 // Properties
10950 this.$overlay = ( config.$overlay === true ? OO.ui.getDefaultOverlay() : config.$overlay ) || this.$element;
10951 this.dropdownButton = new OO.ui.ButtonWidget( {
10952 classes: [ 'oo-ui-comboBoxInputWidget-dropdownButton' ],
10953 indicator: 'down',
10954 disabled: this.disabled
10955 } );
10956 this.menu = new OO.ui.MenuSelectWidget( $.extend(
10957 {
10958 widget: this,
10959 input: this,
10960 $floatableContainer: this.$element,
10961 disabled: this.isDisabled()
10962 },
10963 config.menu
10964 ) );
10965
10966 // Events
10967 this.connect( this, {
10968 change: 'onInputChange',
10969 enter: 'onInputEnter'
10970 } );
10971 this.dropdownButton.connect( this, {
10972 click: 'onDropdownButtonClick'
10973 } );
10974 this.menu.connect( this, {
10975 choose: 'onMenuChoose',
10976 add: 'onMenuItemsChange',
10977 remove: 'onMenuItemsChange',
10978 toggle: 'onMenuToggle'
10979 } );
10980
10981 // Initialization
10982 this.$input.attr( {
10983 role: 'combobox',
10984 'aria-owns': this.menu.getElementId(),
10985 'aria-autocomplete': 'list'
10986 } );
10987 // Do not override options set via config.menu.items
10988 if ( config.options !== undefined ) {
10989 this.setOptions( config.options );
10990 }
10991 this.$field = $( '<div>' )
10992 .addClass( 'oo-ui-comboBoxInputWidget-field' )
10993 .append( this.$input, this.dropdownButton.$element );
10994 this.$element
10995 .addClass( 'oo-ui-comboBoxInputWidget' )
10996 .append( this.$field );
10997 this.$overlay.append( this.menu.$element );
10998 this.onMenuItemsChange();
10999 };
11000
11001 /* Setup */
11002
11003 OO.inheritClass( OO.ui.ComboBoxInputWidget, OO.ui.TextInputWidget );
11004
11005 /* Methods */
11006
11007 /**
11008 * Get the combobox's menu.
11009 *
11010 * @return {OO.ui.MenuSelectWidget} Menu widget
11011 */
11012 OO.ui.ComboBoxInputWidget.prototype.getMenu = function () {
11013 return this.menu;
11014 };
11015
11016 /**
11017 * Get the combobox's text input widget.
11018 *
11019 * @return {OO.ui.TextInputWidget} Text input widget
11020 */
11021 OO.ui.ComboBoxInputWidget.prototype.getInput = function () {
11022 return this;
11023 };
11024
11025 /**
11026 * Handle input change events.
11027 *
11028 * @private
11029 * @param {string} value New value
11030 */
11031 OO.ui.ComboBoxInputWidget.prototype.onInputChange = function ( value ) {
11032 var match = this.menu.findItemFromData( value );
11033
11034 this.menu.selectItem( match );
11035 if ( this.menu.findHighlightedItem() ) {
11036 this.menu.highlightItem( match );
11037 }
11038
11039 if ( !this.isDisabled() ) {
11040 this.menu.toggle( true );
11041 }
11042 };
11043
11044 /**
11045 * Handle input enter events.
11046 *
11047 * @private
11048 */
11049 OO.ui.ComboBoxInputWidget.prototype.onInputEnter = function () {
11050 if ( !this.isDisabled() ) {
11051 this.menu.toggle( false );
11052 }
11053 };
11054
11055 /**
11056 * Handle button click events.
11057 *
11058 * @private
11059 */
11060 OO.ui.ComboBoxInputWidget.prototype.onDropdownButtonClick = function () {
11061 this.menu.toggle();
11062 this.focus();
11063 };
11064
11065 /**
11066 * Handle menu choose events.
11067 *
11068 * @private
11069 * @param {OO.ui.OptionWidget} item Chosen item
11070 */
11071 OO.ui.ComboBoxInputWidget.prototype.onMenuChoose = function ( item ) {
11072 this.setValue( item.getData() );
11073 };
11074
11075 /**
11076 * Handle menu item change events.
11077 *
11078 * @private
11079 */
11080 OO.ui.ComboBoxInputWidget.prototype.onMenuItemsChange = function () {
11081 var match = this.menu.findItemFromData( this.getValue() );
11082 this.menu.selectItem( match );
11083 if ( this.menu.findHighlightedItem() ) {
11084 this.menu.highlightItem( match );
11085 }
11086 this.$element.toggleClass( 'oo-ui-comboBoxInputWidget-empty', this.menu.isEmpty() );
11087 };
11088
11089 /**
11090 * Handle menu toggle events.
11091 *
11092 * @private
11093 * @param {boolean} isVisible Open state of the menu
11094 */
11095 OO.ui.ComboBoxInputWidget.prototype.onMenuToggle = function ( isVisible ) {
11096 this.$element.toggleClass( 'oo-ui-comboBoxInputWidget-open', isVisible );
11097 };
11098
11099 /**
11100 * @inheritdoc
11101 */
11102 OO.ui.ComboBoxInputWidget.prototype.setDisabled = function ( disabled ) {
11103 // Parent method
11104 OO.ui.ComboBoxInputWidget.parent.prototype.setDisabled.call( this, disabled );
11105
11106 if ( this.dropdownButton ) {
11107 this.dropdownButton.setDisabled( this.isDisabled() );
11108 }
11109 if ( this.menu ) {
11110 this.menu.setDisabled( this.isDisabled() );
11111 }
11112
11113 return this;
11114 };
11115
11116 /**
11117 * Set the options available for this input.
11118 *
11119 * @param {Object[]} options Array of menu options in the format `{ data: …, label: … }`
11120 * @chainable
11121 */
11122 OO.ui.ComboBoxInputWidget.prototype.setOptions = function ( options ) {
11123 this.getMenu()
11124 .clearItems()
11125 .addItems( options.map( function ( opt ) {
11126 return new OO.ui.MenuOptionWidget( {
11127 data: opt.data,
11128 label: opt.label !== undefined ? opt.label : opt.data
11129 } );
11130 } ) );
11131
11132 return this;
11133 };
11134
11135 /**
11136 * FieldLayouts are used with OO.ui.FieldsetLayout. Each FieldLayout requires a field-widget,
11137 * which is a widget that is specified by reference before any optional configuration settings.
11138 *
11139 * Field layouts can be configured with help text and/or labels. Labels are aligned in one of four ways:
11140 *
11141 * - **left**: The label is placed before the field-widget and aligned with the left margin.
11142 * A left-alignment is used for forms with many fields.
11143 * - **right**: The label is placed before the field-widget and aligned to the right margin.
11144 * A right-alignment is used for long but familiar forms which users tab through,
11145 * verifying the current field with a quick glance at the label.
11146 * - **top**: The label is placed above the field-widget. A top-alignment is used for brief forms
11147 * that users fill out from top to bottom.
11148 * - **inline**: The label is placed after the field-widget and aligned to the left.
11149 * An inline-alignment is best used with checkboxes or radio buttons.
11150 *
11151 * Help text is accessed via a help icon that appears in the upper right corner of the rendered field layout.
11152 * Please see the [OOUI documentation on MediaWiki] [1] for examples and more information.
11153 *
11154 * [1]: https://www.mediawiki.org/wiki/OOUI/Layouts/Fields_and_Fieldsets
11155 *
11156 * @class
11157 * @extends OO.ui.Layout
11158 * @mixins OO.ui.mixin.LabelElement
11159 * @mixins OO.ui.mixin.TitledElement
11160 *
11161 * @constructor
11162 * @param {OO.ui.Widget} fieldWidget Field widget
11163 * @param {Object} [config] Configuration options
11164 * @cfg {string} [align='left'] Alignment of the label: 'left', 'right', 'top' or 'inline'
11165 * @cfg {Array} [errors] Error messages about the widget, which will be displayed below the widget.
11166 * The array may contain strings or OO.ui.HtmlSnippet instances.
11167 * @cfg {Array} [notices] Notices about the widget, which will be displayed below the widget.
11168 * The array may contain strings or OO.ui.HtmlSnippet instances.
11169 * @cfg {string|OO.ui.HtmlSnippet} [help] Help text. When help text is specified, a "help" icon will appear
11170 * in the upper-right corner of the rendered field; clicking it will display the text in a popup.
11171 * For important messages, you are advised to use `notices`, as they are always shown.
11172 * @cfg {jQuery} [$overlay] Passed to OO.ui.PopupButtonWidget for help popup, if `help` is given.
11173 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
11174 *
11175 * @throws {Error} An error is thrown if no widget is specified
11176 */
11177 OO.ui.FieldLayout = function OoUiFieldLayout( fieldWidget, config ) {
11178 // Allow passing positional parameters inside the config object
11179 if ( OO.isPlainObject( fieldWidget ) && config === undefined ) {
11180 config = fieldWidget;
11181 fieldWidget = config.fieldWidget;
11182 }
11183
11184 // Make sure we have required constructor arguments
11185 if ( fieldWidget === undefined ) {
11186 throw new Error( 'Widget not found' );
11187 }
11188
11189 // Configuration initialization
11190 config = $.extend( { align: 'left' }, config );
11191
11192 // Parent constructor
11193 OO.ui.FieldLayout.parent.call( this, config );
11194
11195 // Mixin constructors
11196 OO.ui.mixin.LabelElement.call( this, $.extend( {}, config, {
11197 $label: $( '<label>' )
11198 } ) );
11199 OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$label } ) );
11200
11201 // Properties
11202 this.fieldWidget = fieldWidget;
11203 this.errors = [];
11204 this.notices = [];
11205 this.$field = this.isFieldInline() ? $( '<span>' ) : $( '<div>' );
11206 this.$messages = $( '<ul>' );
11207 this.$header = $( '<span>' );
11208 this.$body = $( '<div>' );
11209 this.align = null;
11210 if ( config.help ) {
11211 this.popupButtonWidget = new OO.ui.PopupButtonWidget( {
11212 $overlay: config.$overlay,
11213 popup: {
11214 padded: true
11215 },
11216 classes: [ 'oo-ui-fieldLayout-help' ],
11217 framed: false,
11218 icon: 'info'
11219 } );
11220 if ( config.help instanceof OO.ui.HtmlSnippet ) {
11221 this.popupButtonWidget.getPopup().$body.html( config.help.toString() );
11222 } else {
11223 this.popupButtonWidget.getPopup().$body.text( config.help );
11224 }
11225 this.$help = this.popupButtonWidget.$element;
11226 } else {
11227 this.$help = $( [] );
11228 }
11229
11230 // Events
11231 this.fieldWidget.connect( this, { disable: 'onFieldDisable' } );
11232
11233 // Initialization
11234 if ( config.help ) {
11235 // Set the 'aria-describedby' attribute on the fieldWidget
11236 // Preference given to an input or a button
11237 (
11238 this.fieldWidget.$input ||
11239 this.fieldWidget.$button ||
11240 this.fieldWidget.$element
11241 ).attr(
11242 'aria-describedby',
11243 this.popupButtonWidget.getPopup().getBodyId()
11244 );
11245 }
11246 if ( this.fieldWidget.getInputId() ) {
11247 this.$label.attr( 'for', this.fieldWidget.getInputId() );
11248 } else {
11249 this.$label.on( 'click', function () {
11250 this.fieldWidget.simulateLabelClick();
11251 }.bind( this ) );
11252 }
11253 this.$element
11254 .addClass( 'oo-ui-fieldLayout' )
11255 .toggleClass( 'oo-ui-fieldLayout-disabled', this.fieldWidget.isDisabled() )
11256 .append( this.$body );
11257 this.$body.addClass( 'oo-ui-fieldLayout-body' );
11258 this.$header.addClass( 'oo-ui-fieldLayout-header' );
11259 this.$messages.addClass( 'oo-ui-fieldLayout-messages' );
11260 this.$field
11261 .addClass( 'oo-ui-fieldLayout-field' )
11262 .append( this.fieldWidget.$element );
11263
11264 this.setErrors( config.errors || [] );
11265 this.setNotices( config.notices || [] );
11266 this.setAlignment( config.align );
11267 // Call this again to take into account the widget's accessKey
11268 this.updateTitle();
11269 };
11270
11271 /* Setup */
11272
11273 OO.inheritClass( OO.ui.FieldLayout, OO.ui.Layout );
11274 OO.mixinClass( OO.ui.FieldLayout, OO.ui.mixin.LabelElement );
11275 OO.mixinClass( OO.ui.FieldLayout, OO.ui.mixin.TitledElement );
11276
11277 /* Methods */
11278
11279 /**
11280 * Handle field disable events.
11281 *
11282 * @private
11283 * @param {boolean} value Field is disabled
11284 */
11285 OO.ui.FieldLayout.prototype.onFieldDisable = function ( value ) {
11286 this.$element.toggleClass( 'oo-ui-fieldLayout-disabled', value );
11287 };
11288
11289 /**
11290 * Get the widget contained by the field.
11291 *
11292 * @return {OO.ui.Widget} Field widget
11293 */
11294 OO.ui.FieldLayout.prototype.getField = function () {
11295 return this.fieldWidget;
11296 };
11297
11298 /**
11299 * Return `true` if the given field widget can be used with `'inline'` alignment (see
11300 * #setAlignment). Return `false` if it can't or if this can't be determined.
11301 *
11302 * @return {boolean}
11303 */
11304 OO.ui.FieldLayout.prototype.isFieldInline = function () {
11305 // This is very simplistic, but should be good enough.
11306 return this.getField().$element.prop( 'tagName' ).toLowerCase() === 'span';
11307 };
11308
11309 /**
11310 * @protected
11311 * @param {string} kind 'error' or 'notice'
11312 * @param {string|OO.ui.HtmlSnippet} text
11313 * @return {jQuery}
11314 */
11315 OO.ui.FieldLayout.prototype.makeMessage = function ( kind, text ) {
11316 var $listItem, $icon, message;
11317 $listItem = $( '<li>' );
11318 if ( kind === 'error' ) {
11319 $icon = new OO.ui.IconWidget( { icon: 'alert', flags: [ 'warning' ] } ).$element;
11320 $listItem.attr( 'role', 'alert' );
11321 } else if ( kind === 'notice' ) {
11322 $icon = new OO.ui.IconWidget( { icon: 'info' } ).$element;
11323 } else {
11324 $icon = '';
11325 }
11326 message = new OO.ui.LabelWidget( { label: text } );
11327 $listItem
11328 .append( $icon, message.$element )
11329 .addClass( 'oo-ui-fieldLayout-messages-' + kind );
11330 return $listItem;
11331 };
11332
11333 /**
11334 * Set the field alignment mode.
11335 *
11336 * @private
11337 * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
11338 * @chainable
11339 */
11340 OO.ui.FieldLayout.prototype.setAlignment = function ( value ) {
11341 if ( value !== this.align ) {
11342 // Default to 'left'
11343 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value ) === -1 ) {
11344 value = 'left';
11345 }
11346 // Validate
11347 if ( value === 'inline' && !this.isFieldInline() ) {
11348 value = 'top';
11349 }
11350 // Reorder elements
11351 if ( value === 'top' ) {
11352 this.$header.append( this.$help, this.$label );
11353 this.$body.append( this.$header, this.$field );
11354 } else if ( value === 'inline' ) {
11355 this.$header.append( this.$help, this.$label );
11356 this.$body.append( this.$field, this.$header );
11357 } else {
11358 this.$header.append( this.$label );
11359 this.$body.append( this.$header, this.$help, this.$field );
11360 }
11361 // Set classes. The following classes can be used here:
11362 // * oo-ui-fieldLayout-align-left
11363 // * oo-ui-fieldLayout-align-right
11364 // * oo-ui-fieldLayout-align-top
11365 // * oo-ui-fieldLayout-align-inline
11366 if ( this.align ) {
11367 this.$element.removeClass( 'oo-ui-fieldLayout-align-' + this.align );
11368 }
11369 this.$element.addClass( 'oo-ui-fieldLayout-align-' + value );
11370 this.align = value;
11371 }
11372
11373 return this;
11374 };
11375
11376 /**
11377 * Set the list of error messages.
11378 *
11379 * @param {Array} errors Error messages about the widget, which will be displayed below the widget.
11380 * The array may contain strings or OO.ui.HtmlSnippet instances.
11381 * @chainable
11382 */
11383 OO.ui.FieldLayout.prototype.setErrors = function ( errors ) {
11384 this.errors = errors.slice();
11385 this.updateMessages();
11386 return this;
11387 };
11388
11389 /**
11390 * Set the list of notice messages.
11391 *
11392 * @param {Array} notices Notices about the widget, which will be displayed below the widget.
11393 * The array may contain strings or OO.ui.HtmlSnippet instances.
11394 * @chainable
11395 */
11396 OO.ui.FieldLayout.prototype.setNotices = function ( notices ) {
11397 this.notices = notices.slice();
11398 this.updateMessages();
11399 return this;
11400 };
11401
11402 /**
11403 * Update the rendering of error and notice messages.
11404 *
11405 * @private
11406 */
11407 OO.ui.FieldLayout.prototype.updateMessages = function () {
11408 var i;
11409 this.$messages.empty();
11410
11411 if ( this.errors.length || this.notices.length ) {
11412 this.$body.after( this.$messages );
11413 } else {
11414 this.$messages.remove();
11415 return;
11416 }
11417
11418 for ( i = 0; i < this.notices.length; i++ ) {
11419 this.$messages.append( this.makeMessage( 'notice', this.notices[ i ] ) );
11420 }
11421 for ( i = 0; i < this.errors.length; i++ ) {
11422 this.$messages.append( this.makeMessage( 'error', this.errors[ i ] ) );
11423 }
11424 };
11425
11426 /**
11427 * Include information about the widget's accessKey in our title. TitledElement calls this method.
11428 * (This is a bit of a hack.)
11429 *
11430 * @protected
11431 * @param {string} title Tooltip label for 'title' attribute
11432 * @return {string}
11433 */
11434 OO.ui.FieldLayout.prototype.formatTitleWithAccessKey = function ( title ) {
11435 if ( this.fieldWidget && this.fieldWidget.formatTitleWithAccessKey ) {
11436 return this.fieldWidget.formatTitleWithAccessKey( title );
11437 }
11438 return title;
11439 };
11440
11441 /**
11442 * ActionFieldLayouts are used with OO.ui.FieldsetLayout. The layout consists of a field-widget, a button,
11443 * and an optional label and/or help text. The field-widget (e.g., a {@link OO.ui.TextInputWidget TextInputWidget}),
11444 * is required and is specified before any optional configuration settings.
11445 *
11446 * Labels can be aligned in one of four ways:
11447 *
11448 * - **left**: The label is placed before the field-widget and aligned with the left margin.
11449 * A left-alignment is used for forms with many fields.
11450 * - **right**: The label is placed before the field-widget and aligned to the right margin.
11451 * A right-alignment is used for long but familiar forms which users tab through,
11452 * verifying the current field with a quick glance at the label.
11453 * - **top**: The label is placed above the field-widget. A top-alignment is used for brief forms
11454 * that users fill out from top to bottom.
11455 * - **inline**: The label is placed after the field-widget and aligned to the left.
11456 * An inline-alignment is best used with checkboxes or radio buttons.
11457 *
11458 * Help text is accessed via a help icon that appears in the upper right corner of the rendered field layout when help
11459 * text is specified.
11460 *
11461 * @example
11462 * // Example of an ActionFieldLayout
11463 * var actionFieldLayout = new OO.ui.ActionFieldLayout(
11464 * new OO.ui.TextInputWidget( {
11465 * placeholder: 'Field widget'
11466 * } ),
11467 * new OO.ui.ButtonWidget( {
11468 * label: 'Button'
11469 * } ),
11470 * {
11471 * label: 'An ActionFieldLayout. This label is aligned top',
11472 * align: 'top',
11473 * help: 'This is help text'
11474 * }
11475 * );
11476 *
11477 * $( 'body' ).append( actionFieldLayout.$element );
11478 *
11479 * @class
11480 * @extends OO.ui.FieldLayout
11481 *
11482 * @constructor
11483 * @param {OO.ui.Widget} fieldWidget Field widget
11484 * @param {OO.ui.ButtonWidget} buttonWidget Button widget
11485 * @param {Object} config
11486 */
11487 OO.ui.ActionFieldLayout = function OoUiActionFieldLayout( fieldWidget, buttonWidget, config ) {
11488 // Allow passing positional parameters inside the config object
11489 if ( OO.isPlainObject( fieldWidget ) && config === undefined ) {
11490 config = fieldWidget;
11491 fieldWidget = config.fieldWidget;
11492 buttonWidget = config.buttonWidget;
11493 }
11494
11495 // Parent constructor
11496 OO.ui.ActionFieldLayout.parent.call( this, fieldWidget, config );
11497
11498 // Properties
11499 this.buttonWidget = buttonWidget;
11500 this.$button = $( '<span>' );
11501 this.$input = this.isFieldInline() ? $( '<span>' ) : $( '<div>' );
11502
11503 // Initialization
11504 this.$element
11505 .addClass( 'oo-ui-actionFieldLayout' );
11506 this.$button
11507 .addClass( 'oo-ui-actionFieldLayout-button' )
11508 .append( this.buttonWidget.$element );
11509 this.$input
11510 .addClass( 'oo-ui-actionFieldLayout-input' )
11511 .append( this.fieldWidget.$element );
11512 this.$field
11513 .append( this.$input, this.$button );
11514 };
11515
11516 /* Setup */
11517
11518 OO.inheritClass( OO.ui.ActionFieldLayout, OO.ui.FieldLayout );
11519
11520 /**
11521 * FieldsetLayouts are composed of one or more {@link OO.ui.FieldLayout FieldLayouts},
11522 * which each contain an individual widget and, optionally, a label. Each Fieldset can be
11523 * configured with a label as well. For more information and examples,
11524 * please see the [OOUI documentation on MediaWiki][1].
11525 *
11526 * @example
11527 * // Example of a fieldset layout
11528 * var input1 = new OO.ui.TextInputWidget( {
11529 * placeholder: 'A text input field'
11530 * } );
11531 *
11532 * var input2 = new OO.ui.TextInputWidget( {
11533 * placeholder: 'A text input field'
11534 * } );
11535 *
11536 * var fieldset = new OO.ui.FieldsetLayout( {
11537 * label: 'Example of a fieldset layout'
11538 * } );
11539 *
11540 * fieldset.addItems( [
11541 * new OO.ui.FieldLayout( input1, {
11542 * label: 'Field One'
11543 * } ),
11544 * new OO.ui.FieldLayout( input2, {
11545 * label: 'Field Two'
11546 * } )
11547 * ] );
11548 * $( 'body' ).append( fieldset.$element );
11549 *
11550 * [1]: https://www.mediawiki.org/wiki/OOUI/Layouts/Fields_and_Fieldsets
11551 *
11552 * @class
11553 * @extends OO.ui.Layout
11554 * @mixins OO.ui.mixin.IconElement
11555 * @mixins OO.ui.mixin.LabelElement
11556 * @mixins OO.ui.mixin.GroupElement
11557 *
11558 * @constructor
11559 * @param {Object} [config] Configuration options
11560 * @cfg {OO.ui.FieldLayout[]} [items] An array of fields to add to the fieldset. See OO.ui.FieldLayout for more information about fields.
11561 * @cfg {string|OO.ui.HtmlSnippet} [help] Help text. When help text is specified, a "help" icon will appear
11562 * in the upper-right corner of the rendered field; clicking it will display the text in a popup.
11563 * For important messages, you are advised to use `notices`, as they are always shown.
11564 * @cfg {jQuery} [$overlay] Passed to OO.ui.PopupButtonWidget for help popup, if `help` is given.
11565 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
11566 */
11567 OO.ui.FieldsetLayout = function OoUiFieldsetLayout( config ) {
11568 // Configuration initialization
11569 config = config || {};
11570
11571 // Parent constructor
11572 OO.ui.FieldsetLayout.parent.call( this, config );
11573
11574 // Mixin constructors
11575 OO.ui.mixin.IconElement.call( this, config );
11576 OO.ui.mixin.LabelElement.call( this, config );
11577 OO.ui.mixin.GroupElement.call( this, config );
11578
11579 // Properties
11580 this.$header = $( '<legend>' );
11581 if ( config.help ) {
11582 this.popupButtonWidget = new OO.ui.PopupButtonWidget( {
11583 $overlay: config.$overlay,
11584 popup: {
11585 padded: true
11586 },
11587 classes: [ 'oo-ui-fieldsetLayout-help' ],
11588 framed: false,
11589 icon: 'info'
11590 } );
11591 if ( config.help instanceof OO.ui.HtmlSnippet ) {
11592 this.popupButtonWidget.getPopup().$body.html( config.help.toString() );
11593 } else {
11594 this.popupButtonWidget.getPopup().$body.text( config.help );
11595 }
11596 this.$help = this.popupButtonWidget.$element;
11597 } else {
11598 this.$help = $( [] );
11599 }
11600
11601 // Initialization
11602 this.$header
11603 .addClass( 'oo-ui-fieldsetLayout-header' )
11604 .append( this.$icon, this.$label, this.$help );
11605 this.$group.addClass( 'oo-ui-fieldsetLayout-group' );
11606 this.$element
11607 .addClass( 'oo-ui-fieldsetLayout' )
11608 .prepend( this.$header, this.$group );
11609 if ( Array.isArray( config.items ) ) {
11610 this.addItems( config.items );
11611 }
11612 };
11613
11614 /* Setup */
11615
11616 OO.inheritClass( OO.ui.FieldsetLayout, OO.ui.Layout );
11617 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.mixin.IconElement );
11618 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.mixin.LabelElement );
11619 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.mixin.GroupElement );
11620
11621 /* Static Properties */
11622
11623 /**
11624 * @static
11625 * @inheritdoc
11626 */
11627 OO.ui.FieldsetLayout.static.tagName = 'fieldset';
11628
11629 /**
11630 * FormLayouts are used to wrap {@link OO.ui.FieldsetLayout FieldsetLayouts} when you intend to use browser-based
11631 * form submission for the fields instead of handling them in JavaScript. Form layouts can be configured with an
11632 * HTML form action, an encoding type, and a method using the #action, #enctype, and #method configs, respectively.
11633 * See the [OOUI documentation on MediaWiki] [1] for more information and examples.
11634 *
11635 * Only widgets from the {@link OO.ui.InputWidget InputWidget} family support form submission. It
11636 * includes standard form elements like {@link OO.ui.CheckboxInputWidget checkboxes}, {@link
11637 * OO.ui.RadioInputWidget radio buttons} and {@link OO.ui.TextInputWidget text fields}, as well as
11638 * some fancier controls. Some controls have both regular and InputWidget variants, for example
11639 * OO.ui.DropdownWidget and OO.ui.DropdownInputWidget – only the latter support form submission and
11640 * often have simplified APIs to match the capabilities of HTML forms.
11641 * See the [OOUI documentation on MediaWiki] [2] for more information about InputWidgets.
11642 *
11643 * [1]: https://www.mediawiki.org/wiki/OOUI/Layouts/Forms
11644 * [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Inputs
11645 *
11646 * @example
11647 * // Example of a form layout that wraps a fieldset layout
11648 * var input1 = new OO.ui.TextInputWidget( {
11649 * placeholder: 'Username'
11650 * } );
11651 * var input2 = new OO.ui.TextInputWidget( {
11652 * placeholder: 'Password',
11653 * type: 'password'
11654 * } );
11655 * var submit = new OO.ui.ButtonInputWidget( {
11656 * label: 'Submit'
11657 * } );
11658 *
11659 * var fieldset = new OO.ui.FieldsetLayout( {
11660 * label: 'A form layout'
11661 * } );
11662 * fieldset.addItems( [
11663 * new OO.ui.FieldLayout( input1, {
11664 * label: 'Username',
11665 * align: 'top'
11666 * } ),
11667 * new OO.ui.FieldLayout( input2, {
11668 * label: 'Password',
11669 * align: 'top'
11670 * } ),
11671 * new OO.ui.FieldLayout( submit )
11672 * ] );
11673 * var form = new OO.ui.FormLayout( {
11674 * items: [ fieldset ],
11675 * action: '/api/formhandler',
11676 * method: 'get'
11677 * } )
11678 * $( 'body' ).append( form.$element );
11679 *
11680 * @class
11681 * @extends OO.ui.Layout
11682 * @mixins OO.ui.mixin.GroupElement
11683 *
11684 * @constructor
11685 * @param {Object} [config] Configuration options
11686 * @cfg {string} [method] HTML form `method` attribute
11687 * @cfg {string} [action] HTML form `action` attribute
11688 * @cfg {string} [enctype] HTML form `enctype` attribute
11689 * @cfg {OO.ui.FieldsetLayout[]} [items] Fieldset layouts to add to the form layout.
11690 */
11691 OO.ui.FormLayout = function OoUiFormLayout( config ) {
11692 var action;
11693
11694 // Configuration initialization
11695 config = config || {};
11696
11697 // Parent constructor
11698 OO.ui.FormLayout.parent.call( this, config );
11699
11700 // Mixin constructors
11701 OO.ui.mixin.GroupElement.call( this, $.extend( {}, config, { $group: this.$element } ) );
11702
11703 // Events
11704 this.$element.on( 'submit', this.onFormSubmit.bind( this ) );
11705
11706 // Make sure the action is safe
11707 action = config.action;
11708 if ( action !== undefined && !OO.ui.isSafeUrl( action ) ) {
11709 action = './' + action;
11710 }
11711
11712 // Initialization
11713 this.$element
11714 .addClass( 'oo-ui-formLayout' )
11715 .attr( {
11716 method: config.method,
11717 action: action,
11718 enctype: config.enctype
11719 } );
11720 if ( Array.isArray( config.items ) ) {
11721 this.addItems( config.items );
11722 }
11723 };
11724
11725 /* Setup */
11726
11727 OO.inheritClass( OO.ui.FormLayout, OO.ui.Layout );
11728 OO.mixinClass( OO.ui.FormLayout, OO.ui.mixin.GroupElement );
11729
11730 /* Events */
11731
11732 /**
11733 * A 'submit' event is emitted when the form is submitted.
11734 *
11735 * @event submit
11736 */
11737
11738 /* Static Properties */
11739
11740 /**
11741 * @static
11742 * @inheritdoc
11743 */
11744 OO.ui.FormLayout.static.tagName = 'form';
11745
11746 /* Methods */
11747
11748 /**
11749 * Handle form submit events.
11750 *
11751 * @private
11752 * @param {jQuery.Event} e Submit event
11753 * @fires submit
11754 */
11755 OO.ui.FormLayout.prototype.onFormSubmit = function () {
11756 if ( this.emit( 'submit' ) ) {
11757 return false;
11758 }
11759 };
11760
11761 /**
11762 * PanelLayouts expand to cover the entire area of their parent. They can be configured with scrolling, padding,
11763 * and a frame, and are often used together with {@link OO.ui.StackLayout StackLayouts}.
11764 *
11765 * @example
11766 * // Example of a panel layout
11767 * var panel = new OO.ui.PanelLayout( {
11768 * expanded: false,
11769 * framed: true,
11770 * padded: true,
11771 * $content: $( '<p>A panel layout with padding and a frame.</p>' )
11772 * } );
11773 * $( 'body' ).append( panel.$element );
11774 *
11775 * @class
11776 * @extends OO.ui.Layout
11777 *
11778 * @constructor
11779 * @param {Object} [config] Configuration options
11780 * @cfg {boolean} [scrollable=false] Allow vertical scrolling
11781 * @cfg {boolean} [padded=false] Add padding between the content and the edges of the panel.
11782 * @cfg {boolean} [expanded=true] Expand the panel to fill the entire parent element.
11783 * @cfg {boolean} [framed=false] Render the panel with a frame to visually separate it from outside content.
11784 */
11785 OO.ui.PanelLayout = function OoUiPanelLayout( config ) {
11786 // Configuration initialization
11787 config = $.extend( {
11788 scrollable: false,
11789 padded: false,
11790 expanded: true,
11791 framed: false
11792 }, config );
11793
11794 // Parent constructor
11795 OO.ui.PanelLayout.parent.call( this, config );
11796
11797 // Initialization
11798 this.$element.addClass( 'oo-ui-panelLayout' );
11799 if ( config.scrollable ) {
11800 this.$element.addClass( 'oo-ui-panelLayout-scrollable' );
11801 }
11802 if ( config.padded ) {
11803 this.$element.addClass( 'oo-ui-panelLayout-padded' );
11804 }
11805 if ( config.expanded ) {
11806 this.$element.addClass( 'oo-ui-panelLayout-expanded' );
11807 }
11808 if ( config.framed ) {
11809 this.$element.addClass( 'oo-ui-panelLayout-framed' );
11810 }
11811 };
11812
11813 /* Setup */
11814
11815 OO.inheritClass( OO.ui.PanelLayout, OO.ui.Layout );
11816
11817 /* Methods */
11818
11819 /**
11820 * Focus the panel layout
11821 *
11822 * The default implementation just focuses the first focusable element in the panel
11823 */
11824 OO.ui.PanelLayout.prototype.focus = function () {
11825 OO.ui.findFocusable( this.$element ).focus();
11826 };
11827
11828 /**
11829 * HorizontalLayout arranges its contents in a single line (using `display: inline-block` for its
11830 * items), with small margins between them. Convenient when you need to put a number of block-level
11831 * widgets on a single line next to each other.
11832 *
11833 * Note that inline elements, such as OO.ui.ButtonWidgets, do not need this wrapper.
11834 *
11835 * @example
11836 * // HorizontalLayout with a text input and a label
11837 * var layout = new OO.ui.HorizontalLayout( {
11838 * items: [
11839 * new OO.ui.LabelWidget( { label: 'Label' } ),
11840 * new OO.ui.TextInputWidget( { value: 'Text' } )
11841 * ]
11842 * } );
11843 * $( 'body' ).append( layout.$element );
11844 *
11845 * @class
11846 * @extends OO.ui.Layout
11847 * @mixins OO.ui.mixin.GroupElement
11848 *
11849 * @constructor
11850 * @param {Object} [config] Configuration options
11851 * @cfg {OO.ui.Widget[]|OO.ui.Layout[]} [items] Widgets or other layouts to add to the layout.
11852 */
11853 OO.ui.HorizontalLayout = function OoUiHorizontalLayout( config ) {
11854 // Configuration initialization
11855 config = config || {};
11856
11857 // Parent constructor
11858 OO.ui.HorizontalLayout.parent.call( this, config );
11859
11860 // Mixin constructors
11861 OO.ui.mixin.GroupElement.call( this, $.extend( {}, config, { $group: this.$element } ) );
11862
11863 // Initialization
11864 this.$element.addClass( 'oo-ui-horizontalLayout' );
11865 if ( Array.isArray( config.items ) ) {
11866 this.addItems( config.items );
11867 }
11868 };
11869
11870 /* Setup */
11871
11872 OO.inheritClass( OO.ui.HorizontalLayout, OO.ui.Layout );
11873 OO.mixinClass( OO.ui.HorizontalLayout, OO.ui.mixin.GroupElement );
11874
11875 }( OO ) );
11876
11877 //# sourceMappingURL=oojs-ui-core.js.map