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