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