3 * https://www.mediawiki.org/wiki/OOjs_UI
5 * Copyright 2011–2017 OOjs UI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
9 * Date: 2017-05-10T00:55:40Z
16 * DraggableElement is a mixin class used to create elements that can be clicked
17 * and dragged by a mouse to a new position within a group. This class must be used
18 * in conjunction with OO.ui.mixin.DraggableGroupElement, which provides a container for
19 * the draggable elements.
25 * @param {Object} [config] Configuration options
26 * @cfg {jQuery} [$handle] The part of the element which can be used for dragging, defaults to the whole element
27 * @cfg {boolean} [draggable] The items are draggable. This can change with #toggleDraggable
28 * but the draggable state should be called from the DraggableGroupElement, which updates
31 OO
.ui
.mixin
.DraggableElement
= function OoUiMixinDraggableElement( config
) {
32 config
= config
|| {};
36 this.$handle
= config
.$handle
|| this.$element
;
37 this.wasHandleUsed
= null;
38 this.draggable
= config
.draggable
=== undefined ? true : !!config
.draggable
;
40 // Initialize and events
41 this.$element
.addClass( 'oo-ui-draggableElement' )
42 // We make the entire element draggable, not just the handle, so that
43 // the whole element appears to move. wasHandleUsed prevents drags from
44 // starting outside the handle
45 .attr( 'draggable', true )
47 mousedown
: this.onDragMouseDown
.bind( this ),
48 dragstart
: this.onDragStart
.bind( this ),
49 dragover
: this.onDragOver
.bind( this ),
50 dragend
: this.onDragEnd
.bind( this ),
51 drop
: this.onDrop
.bind( this )
53 this.$handle
.addClass( 'oo-ui-draggableElement-handle' );
56 OO
.initClass( OO
.ui
.mixin
.DraggableElement
);
63 * A dragstart event is emitted when the user clicks and begins dragging an item.
64 * @param {OO.ui.mixin.DraggableElement} item The item the user has clicked and is dragging with the mouse.
69 * A dragend event is emitted when the user drags an item and releases the mouse,
70 * thus terminating the drag operation.
75 * A drop event is emitted when the user drags an item and then releases the mouse button
76 * over a valid target.
79 /* Static Properties */
82 * @inheritdoc OO.ui.mixin.ButtonElement
84 OO
.ui
.mixin
.DraggableElement
.static.cancelButtonMouseDownEvents
= false;
89 * Change the draggable state of this widget.
90 * This allows users to temporarily halt the dragging operations.
92 * @param {boolean} isDraggable Widget supports draggable operations
95 OO
.ui
.mixin
.DraggableElement
.prototype.toggleDraggable = function ( isDraggable
) {
96 isDraggable
= isDraggable
!== undefined ? !!isDraggable
: !this.draggable
;
98 if ( this.draggable
!== isDraggable
) {
99 this.draggable
= isDraggable
;
101 this.$handle
.toggleClass( 'oo-ui-draggableElement-undraggable', !this.draggable
);
106 * Check the draggable state of this widget
108 * @return {boolean} Widget supports draggable operations
110 OO
.ui
.mixin
.DraggableElement
.prototype.isDraggable = function () {
111 return this.draggable
;
115 * Respond to mousedown event.
118 * @param {jQuery.Event} e Drag event
120 OO
.ui
.mixin
.DraggableElement
.prototype.onDragMouseDown = function ( e
) {
121 if ( !this.isDraggable() ) {
126 // Optimization: if the handle is the whole element this is always true
127 this.$handle
[ 0 ] === this.$element
[ 0 ] ||
128 // Check the mousedown occurred inside the handle
129 OO
.ui
.contains( this.$handle
[ 0 ], e
.target
, true );
133 * Respond to dragstart event.
136 * @param {jQuery.Event} e Drag event
137 * @return {boolean} False if the event is cancelled
140 OO
.ui
.mixin
.DraggableElement
.prototype.onDragStart = function ( e
) {
142 dataTransfer
= e
.originalEvent
.dataTransfer
;
144 if ( !this.wasHandleUsed
|| !this.isDraggable() ) {
148 // Define drop effect
149 dataTransfer
.dropEffect
= 'none';
150 dataTransfer
.effectAllowed
= 'move';
152 // We must set up a dataTransfer data property or Firefox seems to
153 // ignore the fact the element is draggable.
155 dataTransfer
.setData( 'application-x/OOjs-UI-draggable', this.getIndex() );
157 // The above is only for Firefox. Move on if it fails.
159 // Briefly add a 'clone' class to style the browser's native drag image
160 this.$element
.addClass( 'oo-ui-draggableElement-clone' );
161 // Add placeholder class after the browser has rendered the clone
162 setTimeout( function () {
164 .removeClass( 'oo-ui-draggableElement-clone' )
165 .addClass( 'oo-ui-draggableElement-placeholder' );
168 this.emit( 'dragstart', this );
173 * Respond to dragend event.
178 OO
.ui
.mixin
.DraggableElement
.prototype.onDragEnd = function () {
179 this.$element
.removeClass( 'oo-ui-draggableElement-placeholder' );
180 this.emit( 'dragend' );
187 * @param {jQuery.Event} e Drop event
190 OO
.ui
.mixin
.DraggableElement
.prototype.onDrop = function ( e
) {
192 this.emit( 'drop', e
);
196 * In order for drag/drop to work, the dragover event must
197 * return false and stop propogation.
199 * @param {jQuery.Event} e Drag event
202 OO
.ui
.mixin
.DraggableElement
.prototype.onDragOver = function ( e
) {
208 * Store it in the DOM so we can access from the widget drag event
211 * @param {number} index Item index
213 OO
.ui
.mixin
.DraggableElement
.prototype.setIndex = function ( index
) {
214 if ( this.index
!== index
) {
216 this.$element
.data( 'index', index
);
224 * @return {number} Item index
226 OO
.ui
.mixin
.DraggableElement
.prototype.getIndex = function () {
231 * DraggableGroupElement is a mixin class used to create a group element to
232 * contain draggable elements, which are items that can be clicked and dragged by a mouse.
233 * The class is used with OO.ui.mixin.DraggableElement.
237 * @mixins OO.ui.mixin.GroupElement
240 * @param {Object} [config] Configuration options
241 * @cfg {string} [orientation] Item orientation: 'horizontal' or 'vertical'. The orientation
242 * should match the layout of the items. Items displayed in a single row
243 * or in several rows should use horizontal orientation. The vertical orientation should only be
244 * used when the items are displayed in a single column. Defaults to 'vertical'
245 * @cfg {boolean} [draggable] The items are draggable. This can change with #toggleDraggable
247 OO
.ui
.mixin
.DraggableGroupElement
= function OoUiMixinDraggableGroupElement( config
) {
248 // Configuration initialization
249 config
= config
|| {};
251 // Parent constructor
252 OO
.ui
.mixin
.GroupElement
.call( this, config
);
255 this.orientation
= config
.orientation
|| 'vertical';
256 this.dragItem
= null;
259 this.itemsOrder
= null;
260 this.draggable
= config
.draggable
=== undefined ? true : !!config
.draggable
;
264 dragstart
: 'itemDragStart',
265 dragend
: 'itemDragEnd',
268 this.connect( this, {
269 itemDragStart
: 'onItemDragStart',
270 itemDrop
: 'onItemDropOrDragEnd',
271 itemDragEnd
: 'onItemDropOrDragEnd'
275 if ( Array
.isArray( config
.items
) ) {
276 this.addItems( config
.items
);
279 .addClass( 'oo-ui-draggableGroupElement' )
280 .attr( 'role', 'listbox' )
281 .append( this.$status
)
282 .toggleClass( 'oo-ui-draggableGroupElement-horizontal', this.orientation
=== 'horizontal' );
286 OO
.mixinClass( OO
.ui
.mixin
.DraggableGroupElement
, OO
.ui
.mixin
.GroupElement
);
291 * An item has been dragged to a new position, but not yet dropped.
294 * @param {OO.ui.mixin.DraggableElement} item Dragged item
295 * @param {number} [newIndex] New index for the item
299 * An item has been dropped at a new position.
302 * @param {OO.ui.mixin.DraggableElement} item Reordered item
303 * @param {number} [newIndex] New index for the item
307 * Draggable state of this widget has changed.
310 * @param {boolean} [draggable] Widget is draggable
316 * Change the draggable state of this widget.
317 * This allows users to temporarily halt the dragging operations.
319 * @param {boolean} isDraggable Widget supports draggable operations
322 OO
.ui
.mixin
.DraggableGroupElement
.prototype.toggleDraggable = function ( isDraggable
) {
323 isDraggable
= isDraggable
!== undefined ? !!isDraggable
: !this.draggable
;
325 if ( this.draggable
!== isDraggable
) {
326 this.draggable
= isDraggable
;
328 // Tell the items their draggable state changed
329 this.getItems().forEach( function ( item
) {
330 item
.toggleDraggable( this.draggable
);
334 this.emit( 'draggable', this.draggable
);
339 * Check the draggable state of this widget
341 * @return {boolean} Widget supports draggable operations
343 OO
.ui
.mixin
.DraggableGroupElement
.prototype.isDraggable = function () {
344 return this.draggable
;
348 * Respond to item drag start event
351 * @param {OO.ui.mixin.DraggableElement} item Dragged item
353 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onItemDragStart = function ( item
) {
354 if ( !this.isDraggable() ) {
357 // Make a shallow copy of this.items so we can re-order it during previews
358 // without affecting the original array.
359 this.itemsOrder
= this.items
.slice();
360 this.updateIndexes();
361 if ( this.orientation
=== 'horizontal' ) {
362 // Calculate and cache directionality on drag start - it's a little
363 // expensive and it shouldn't change while dragging.
364 this.dir
= this.$element
.css( 'direction' );
366 this.setDragItem( item
);
370 * Update the index properties of the items
372 OO
.ui
.mixin
.DraggableGroupElement
.prototype.updateIndexes = function () {
375 // Map the index of each object
376 for ( i
= 0, len
= this.itemsOrder
.length
; i
< len
; i
++ ) {
377 this.itemsOrder
[ i
].setIndex( i
);
382 * Handle drop or dragend event and switch the order of the items accordingly
385 * @param {OO.ui.mixin.DraggableElement} item Dropped item
387 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onItemDropOrDragEnd = function () {
388 var targetIndex
, originalIndex
,
389 item
= this.getDragItem();
391 // TODO: Figure out a way to configure a list of legally droppable
392 // elements even if they are not yet in the list
394 originalIndex
= this.items
.indexOf( item
);
395 // If the item has moved forward, add one to the index to account for the left shift
396 targetIndex
= item
.getIndex() + ( item
.getIndex() > originalIndex
? 1 : 0 );
397 if ( targetIndex
!== originalIndex
) {
398 this.reorder( this.getDragItem(), targetIndex
);
399 this.emit( 'reorder', this.getDragItem(), targetIndex
);
401 this.updateIndexes();
403 this.unsetDragItem();
404 // Return false to prevent propogation
409 * Respond to dragover event
412 * @param {jQuery.Event} e Dragover event
415 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onDragOver = function ( e
) {
416 var overIndex
, targetIndex
,
417 item
= this.getDragItem(),
418 dragItemIndex
= item
.getIndex();
420 // Get the OptionWidget item we are dragging over
421 overIndex
= $( e
.target
).closest( '.oo-ui-draggableElement' ).data( 'index' );
423 if ( overIndex
!== undefined && overIndex
!== dragItemIndex
) {
424 targetIndex
= overIndex
+ ( overIndex
> dragItemIndex
? 1 : 0 );
426 if ( targetIndex
> 0 ) {
427 this.$group
.children().eq( targetIndex
- 1 ).after( item
.$element
);
429 this.$group
.prepend( item
.$element
);
431 // Move item in itemsOrder array
432 this.itemsOrder
.splice( overIndex
, 0,
433 this.itemsOrder
.splice( dragItemIndex
, 1 )[ 0 ]
435 this.updateIndexes();
436 this.emit( 'drag', item
, targetIndex
);
443 * Reorder the items in the group
445 * @param {OO.ui.mixin.DraggableElement} item Reordered item
446 * @param {number} newIndex New index
448 OO
.ui
.mixin
.DraggableGroupElement
.prototype.reorder = function ( item
, newIndex
) {
449 this.addItems( [ item
], newIndex
);
455 * @param {OO.ui.mixin.DraggableElement} item Dragged item
457 OO
.ui
.mixin
.DraggableGroupElement
.prototype.setDragItem = function ( item
) {
458 if ( this.dragItem
!== item
) {
459 this.dragItem
= item
;
460 this.$element
.on( 'dragover', this.onDragOver
.bind( this ) );
461 this.$element
.addClass( 'oo-ui-draggableGroupElement-dragging' );
466 * Unset the current dragged item
468 OO
.ui
.mixin
.DraggableGroupElement
.prototype.unsetDragItem = function () {
469 if ( this.dragItem
) {
470 this.dragItem
= null;
471 this.$element
.off( 'dragover' );
472 this.$element
.removeClass( 'oo-ui-draggableGroupElement-dragging' );
477 * Get the item that is currently being dragged.
479 * @return {OO.ui.mixin.DraggableElement|null} The currently dragged item, or `null` if no item is being dragged
481 OO
.ui
.mixin
.DraggableGroupElement
.prototype.getDragItem = function () {
482 return this.dragItem
;
486 * RequestManager is a mixin that manages the lifecycle of a promise-backed request for a widget, such as
487 * the {@link OO.ui.mixin.LookupElement}.
494 OO
.ui
.mixin
.RequestManager
= function OoUiMixinRequestManager() {
495 this.requestCache
= {};
496 this.requestQuery
= null;
497 this.requestRequest
= null;
502 OO
.initClass( OO
.ui
.mixin
.RequestManager
);
505 * Get request results for the current query.
507 * @return {jQuery.Promise} Promise object which will be passed response data as the first argument of
508 * the done event. If the request was aborted to make way for a subsequent request, this promise
509 * may not be rejected, depending on what jQuery feels like doing.
511 OO
.ui
.mixin
.RequestManager
.prototype.getRequestData = function () {
513 value
= this.getRequestQuery(),
514 deferred
= $.Deferred(),
518 if ( Object
.prototype.hasOwnProperty
.call( this.requestCache
, value
) ) {
519 deferred
.resolve( this.requestCache
[ value
] );
521 if ( this.pushPending
) {
524 this.requestQuery
= value
;
525 ourRequest
= this.requestRequest
= this.getRequest();
527 .always( function () {
528 // We need to pop pending even if this is an old request, otherwise
529 // the widget will remain pending forever.
530 // TODO: this assumes that an aborted request will fail or succeed soon after
531 // being aborted, or at least eventually. It would be nice if we could popPending()
532 // at abort time, but only if we knew that we hadn't already called popPending()
534 if ( widget
.popPending
) {
538 .done( function ( response
) {
539 // If this is an old request (and aborting it somehow caused it to still succeed),
540 // ignore its success completely
541 if ( ourRequest
=== widget
.requestRequest
) {
542 widget
.requestQuery
= null;
543 widget
.requestRequest
= null;
544 widget
.requestCache
[ value
] = widget
.getRequestCacheDataFromResponse( response
);
545 deferred
.resolve( widget
.requestCache
[ value
] );
549 // If this is an old request (or a request failing because it's being aborted),
550 // ignore its failure completely
551 if ( ourRequest
=== widget
.requestRequest
) {
552 widget
.requestQuery
= null;
553 widget
.requestRequest
= null;
558 return deferred
.promise();
562 * Abort the currently pending request, if any.
566 OO
.ui
.mixin
.RequestManager
.prototype.abortRequest = function () {
567 var oldRequest
= this.requestRequest
;
569 // First unset this.requestRequest to the fail handler will notice
570 // that the request is no longer current
571 this.requestRequest
= null;
572 this.requestQuery
= null;
578 * Get the query to be made.
583 * @return {string} query to be used
585 OO
.ui
.mixin
.RequestManager
.prototype.getRequestQuery
= null;
588 * Get a new request object of the current query value.
593 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
595 OO
.ui
.mixin
.RequestManager
.prototype.getRequest
= null;
598 * Pre-process data returned by the request from #getRequest.
600 * The return value of this function will be cached, and any further queries for the given value
601 * will use the cache rather than doing API requests.
606 * @param {Mixed} response Response from server
607 * @return {Mixed} Cached result data
609 OO
.ui
.mixin
.RequestManager
.prototype.getRequestCacheDataFromResponse
= null;
612 * LookupElement is a mixin that creates a {@link OO.ui.MenuSelectWidget menu} of suggested values for
613 * a {@link OO.ui.TextInputWidget text input widget}. Suggested values are based on the characters the user types
614 * into the text input field and, in general, the menu is only displayed when the user types. If a suggested value is chosen
615 * from the lookup menu, that value becomes the value of the input field.
617 * Note that a new menu of suggested items is displayed when a value is chosen from the lookup menu. If this is
618 * not the desired behavior, disable lookup menus with the #setLookupsDisabled method, then set the value, then
621 * See the [OOjs UI demos][1] for an example.
623 * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/index.html#widgets-apex-vector-ltr
627 * @mixins OO.ui.mixin.RequestManager
630 * @param {Object} [config] Configuration options
631 * @cfg {jQuery} [$overlay] Overlay for the lookup menu; defaults to relative positioning.
632 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
633 * @cfg {jQuery} [$container=this.$element] The container element. The lookup menu is rendered beneath the specified element.
634 * @cfg {boolean} [allowSuggestionsWhenEmpty=false] Request and display a lookup menu when the text input is empty.
635 * By default, the lookup menu is not generated and displayed until the user begins to type.
636 * @cfg {boolean} [highlightFirst=true] Whether the first lookup result should be highlighted (so, that the user can
637 * take it over into the input with simply pressing return) automatically or not.
639 OO
.ui
.mixin
.LookupElement
= function OoUiMixinLookupElement( config
) {
640 // Configuration initialization
641 config
= $.extend( { highlightFirst
: true }, config
);
643 // Mixin constructors
644 OO
.ui
.mixin
.RequestManager
.call( this, config
);
647 this.$overlay
= config
.$overlay
|| this.$element
;
648 this.lookupMenu
= new OO
.ui
.MenuSelectWidget( {
651 $floatableContainer
: config
.$container
|| this.$element
654 this.allowSuggestionsWhenEmpty
= config
.allowSuggestionsWhenEmpty
|| false;
656 this.lookupsDisabled
= false;
657 this.lookupInputFocused
= false;
658 this.lookupHighlightFirstItem
= config
.highlightFirst
;
662 focus
: this.onLookupInputFocus
.bind( this ),
663 blur
: this.onLookupInputBlur
.bind( this ),
664 mousedown
: this.onLookupInputMouseDown
.bind( this )
666 this.connect( this, { change
: 'onLookupInputChange' } );
667 this.lookupMenu
.connect( this, {
668 toggle
: 'onLookupMenuToggle',
669 choose
: 'onLookupMenuItemChoose'
675 'aria-owns': this.lookupMenu
.getElementId(),
676 'aria-autocomplete': 'list'
678 this.$element
.addClass( 'oo-ui-lookupElement' );
679 this.lookupMenu
.$element
.addClass( 'oo-ui-lookupElement-menu' );
680 this.$overlay
.append( this.lookupMenu
.$element
);
685 OO
.mixinClass( OO
.ui
.mixin
.LookupElement
, OO
.ui
.mixin
.RequestManager
);
690 * Handle input focus event.
693 * @param {jQuery.Event} e Input focus event
695 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputFocus = function () {
696 this.lookupInputFocused
= true;
697 this.populateLookupMenu();
701 * Handle input blur event.
704 * @param {jQuery.Event} e Input blur event
706 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputBlur = function () {
707 this.closeLookupMenu();
708 this.lookupInputFocused
= false;
712 * Handle input mouse down event.
715 * @param {jQuery.Event} e Input mouse down event
717 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputMouseDown = function () {
718 // Only open the menu if the input was already focused.
719 // This way we allow the user to open the menu again after closing it with Esc
720 // by clicking in the input. Opening (and populating) the menu when initially
721 // clicking into the input is handled by the focus handler.
722 if ( this.lookupInputFocused
&& !this.lookupMenu
.isVisible() ) {
723 this.populateLookupMenu();
728 * Handle input change event.
731 * @param {string} value New input value
733 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputChange = function () {
734 if ( this.lookupInputFocused
) {
735 this.populateLookupMenu();
740 * Handle the lookup menu being shown/hidden.
743 * @param {boolean} visible Whether the lookup menu is now visible.
745 OO
.ui
.mixin
.LookupElement
.prototype.onLookupMenuToggle = function ( visible
) {
747 // When the menu is hidden, abort any active request and clear the menu.
748 // This has to be done here in addition to closeLookupMenu(), because
749 // MenuSelectWidget will close itself when the user presses Esc.
750 this.abortLookupRequest();
751 this.lookupMenu
.clearItems();
756 * Handle menu item 'choose' event, updating the text input value to the value of the clicked item.
759 * @param {OO.ui.MenuOptionWidget} item Selected item
761 OO
.ui
.mixin
.LookupElement
.prototype.onLookupMenuItemChoose = function ( item
) {
762 this.setValue( item
.getData() );
769 * @return {OO.ui.MenuSelectWidget}
771 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenu = function () {
772 return this.lookupMenu
;
776 * Disable or re-enable lookups.
778 * When lookups are disabled, calls to #populateLookupMenu will be ignored.
780 * @param {boolean} disabled Disable lookups
782 OO
.ui
.mixin
.LookupElement
.prototype.setLookupsDisabled = function ( disabled
) {
783 this.lookupsDisabled
= !!disabled
;
787 * Open the menu. If there are no entries in the menu, this does nothing.
792 OO
.ui
.mixin
.LookupElement
.prototype.openLookupMenu = function () {
793 if ( !this.lookupMenu
.isEmpty() ) {
794 this.lookupMenu
.toggle( true );
800 * Close the menu, empty it, and abort any pending request.
805 OO
.ui
.mixin
.LookupElement
.prototype.closeLookupMenu = function () {
806 this.lookupMenu
.toggle( false );
807 this.abortLookupRequest();
808 this.lookupMenu
.clearItems();
813 * Request menu items based on the input's current value, and when they arrive,
814 * populate the menu with these items and show the menu.
816 * If lookups have been disabled with #setLookupsDisabled, this function does nothing.
821 OO
.ui
.mixin
.LookupElement
.prototype.populateLookupMenu = function () {
823 value
= this.getValue();
825 if ( this.lookupsDisabled
|| this.isReadOnly() ) {
829 // If the input is empty, clear the menu, unless suggestions when empty are allowed.
830 if ( !this.allowSuggestionsWhenEmpty
&& value
=== '' ) {
831 this.closeLookupMenu();
832 // Skip population if there is already a request pending for the current value
833 } else if ( value
!== this.lookupQuery
) {
834 this.getLookupMenuItems()
835 .done( function ( items
) {
836 widget
.lookupMenu
.clearItems();
837 if ( items
.length
) {
841 widget
.initializeLookupMenuSelection();
843 widget
.lookupMenu
.toggle( false );
847 widget
.lookupMenu
.clearItems();
855 * Highlight the first selectable item in the menu, if configured.
860 OO
.ui
.mixin
.LookupElement
.prototype.initializeLookupMenuSelection = function () {
861 if ( this.lookupHighlightFirstItem
&& !this.lookupMenu
.getSelectedItem() ) {
862 this.lookupMenu
.highlightItem( this.lookupMenu
.getFirstSelectableItem() );
867 * Get lookup menu items for the current query.
870 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument of
871 * the done event. If the request was aborted to make way for a subsequent request, this promise
872 * will not be rejected: it will remain pending forever.
874 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenuItems = function () {
875 return this.getRequestData().then( function ( data
) {
876 return this.getLookupMenuOptionsFromData( data
);
881 * Abort the currently pending lookup request, if any.
885 OO
.ui
.mixin
.LookupElement
.prototype.abortLookupRequest = function () {
890 * Get a new request object of the current lookup query value.
895 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
897 OO
.ui
.mixin
.LookupElement
.prototype.getLookupRequest
= null;
900 * Pre-process data returned by the request from #getLookupRequest.
902 * The return value of this function will be cached, and any further queries for the given value
903 * will use the cache rather than doing API requests.
908 * @param {Mixed} response Response from server
909 * @return {Mixed} Cached result data
911 OO
.ui
.mixin
.LookupElement
.prototype.getLookupCacheDataFromResponse
= null;
914 * Get a list of menu option widgets from the (possibly cached) data returned by
915 * #getLookupCacheDataFromResponse.
920 * @param {Mixed} data Cached result data, usually an array
921 * @return {OO.ui.MenuOptionWidget[]} Menu items
923 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenuOptionsFromData
= null;
926 * Set the read-only state of the widget.
928 * This will also disable/enable the lookups functionality.
930 * @param {boolean} readOnly Make input read-only
933 OO
.ui
.mixin
.LookupElement
.prototype.setReadOnly = function ( readOnly
) {
935 // Note: Calling #setReadOnly this way assumes this is mixed into an OO.ui.TextInputWidget
936 OO
.ui
.TextInputWidget
.prototype.setReadOnly
.call( this, readOnly
);
938 // During construction, #setReadOnly is called before the OO.ui.mixin.LookupElement constructor
939 if ( this.isReadOnly() && this.lookupMenu
) {
940 this.closeLookupMenu();
947 * @inheritdoc OO.ui.mixin.RequestManager
949 OO
.ui
.mixin
.LookupElement
.prototype.getRequestQuery = function () {
950 return this.getValue();
954 * @inheritdoc OO.ui.mixin.RequestManager
956 OO
.ui
.mixin
.LookupElement
.prototype.getRequest = function () {
957 return this.getLookupRequest();
961 * @inheritdoc OO.ui.mixin.RequestManager
963 OO
.ui
.mixin
.LookupElement
.prototype.getRequestCacheDataFromResponse = function ( response
) {
964 return this.getLookupCacheDataFromResponse( response
);
968 * TabPanelLayouts are used within {@link OO.ui.IndexLayout index layouts} to create tab panels that
969 * users can select and display from the index's optional {@link OO.ui.TabSelectWidget tab}
970 * navigation. TabPanels are usually not instantiated directly, rather extended to include the
971 * required content and functionality.
973 * Each tab panel must have a unique symbolic name, which is passed to the constructor. In addition,
974 * the tab panel's tab item is customized (with a label) using the #setupTabItem method. See
975 * {@link OO.ui.IndexLayout IndexLayout} for an example.
978 * @extends OO.ui.PanelLayout
981 * @param {string} name Unique symbolic name of tab panel
982 * @param {Object} [config] Configuration options
983 * @cfg {jQuery|string|Function|OO.ui.HtmlSnippet} [label] Label for tab panel's tab
985 OO
.ui
.TabPanelLayout
= function OoUiTabPanelLayout( name
, config
) {
986 // Allow passing positional parameters inside the config object
987 if ( OO
.isPlainObject( name
) && config
=== undefined ) {
992 // Configuration initialization
993 config
= $.extend( { scrollable
: true }, config
);
995 // Parent constructor
996 OO
.ui
.TabPanelLayout
.parent
.call( this, config
);
1000 this.label
= config
.label
;
1001 this.tabItem
= null;
1002 this.active
= false;
1005 this.$element
.addClass( 'oo-ui-tabPanelLayout' );
1010 OO
.inheritClass( OO
.ui
.TabPanelLayout
, OO
.ui
.PanelLayout
);
1015 * An 'active' event is emitted when the tab panel becomes active. Tab panels become active when they are
1016 * shown in a index layout that is configured to display only one tab panel at a time.
1019 * @param {boolean} active Tab panel is active
1025 * Get the symbolic name of the tab panel.
1027 * @return {string} Symbolic name of tab panel
1029 OO
.ui
.TabPanelLayout
.prototype.getName = function () {
1034 * Check if tab panel is active.
1036 * Tab panels become active when they are shown in a {@link OO.ui.IndexLayout index layout} that is configured to
1037 * display only one tab panel at a time. Additional CSS is applied to the tab panel's tab item to reflect the
1040 * @return {boolean} Tab panel is active
1042 OO
.ui
.TabPanelLayout
.prototype.isActive = function () {
1049 * The tab item allows users to access the tab panel from the index's tab
1050 * navigation. The tab item itself can be customized (with a label, level, etc.) using the #setupTabItem method.
1052 * @return {OO.ui.TabOptionWidget|null} Tab option widget
1054 OO
.ui
.TabPanelLayout
.prototype.getTabItem = function () {
1055 return this.tabItem
;
1059 * Set or unset the tab item.
1061 * Specify a {@link OO.ui.TabOptionWidget tab option} to set it,
1062 * or `null` to clear the tab item. To customize the tab item itself (e.g., to set a label or tab
1063 * level), use #setupTabItem instead of this method.
1065 * @param {OO.ui.TabOptionWidget|null} tabItem Tab option widget, null to clear
1068 OO
.ui
.TabPanelLayout
.prototype.setTabItem = function ( tabItem
) {
1069 this.tabItem
= tabItem
|| null;
1071 this.setupTabItem();
1077 * Set up the tab item.
1079 * Use this method to customize the tab item (e.g., to add a label or tab level). To set or unset
1080 * the tab item itself (with a {@link OO.ui.TabOptionWidget tab option} or `null`), use
1081 * the #setTabItem method instead.
1083 * @param {OO.ui.TabOptionWidget} tabItem Tab option widget to set up
1086 OO
.ui
.TabPanelLayout
.prototype.setupTabItem = function () {
1088 this.tabItem
.setLabel( this.label
);
1094 * Set the tab panel to its 'active' state.
1096 * Tab panels become active when they are shown in a index layout that is configured to display only
1097 * one tab panel at a time. Additional CSS is applied to the tab item to reflect the tab panel's
1098 * active state. Outside of the index context, setting the active state on a tab panel does nothing.
1100 * @param {boolean} active Tab panel is active
1103 OO
.ui
.TabPanelLayout
.prototype.setActive = function ( active
) {
1106 if ( active
!== this.active
) {
1107 this.active
= active
;
1108 this.$element
.toggleClass( 'oo-ui-tabPanelLayout-active', this.active
);
1109 this.emit( 'active', this.active
);
1114 * The deprecated name for the TabPanelLayout, provided for backwards-compatibility.
1117 * @extends OO.ui.TabPanelLayout
1120 * @deprecated since v0.22.0
1122 OO
.ui
.CardLayout
= function OoUiCardLayout() {
1123 OO
.ui
.warnDeprecation( 'CardLayout has been renamed to TabPanel layout. Use that instead. See T155152' );
1124 // Parent constructor
1125 OO
.ui
.CardLayout
.parent
.apply( this, arguments
);
1128 OO
.inheritClass( OO
.ui
.CardLayout
, OO
.ui
.TabPanelLayout
);
1131 * PageLayouts are used within {@link OO.ui.BookletLayout booklet layouts} to create pages that users can select and display
1132 * from the booklet's optional {@link OO.ui.OutlineSelectWidget outline} navigation. Pages are usually not instantiated directly,
1133 * rather extended to include the required content and functionality.
1135 * Each page must have a unique symbolic name, which is passed to the constructor. In addition, the page's outline
1136 * item is customized (with a label, outline level, etc.) using the #setupOutlineItem method. See
1137 * {@link OO.ui.BookletLayout BookletLayout} for an example.
1140 * @extends OO.ui.PanelLayout
1143 * @param {string} name Unique symbolic name of page
1144 * @param {Object} [config] Configuration options
1146 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
1147 // Allow passing positional parameters inside the config object
1148 if ( OO
.isPlainObject( name
) && config
=== undefined ) {
1153 // Configuration initialization
1154 config
= $.extend( { scrollable
: true }, config
);
1156 // Parent constructor
1157 OO
.ui
.PageLayout
.parent
.call( this, config
);
1161 this.outlineItem
= null;
1162 this.active
= false;
1165 this.$element
.addClass( 'oo-ui-pageLayout' );
1170 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
1175 * An 'active' event is emitted when the page becomes active. Pages become active when they are
1176 * shown in a booklet layout that is configured to display only one page at a time.
1179 * @param {boolean} active Page is active
1185 * Get the symbolic name of the page.
1187 * @return {string} Symbolic name of page
1189 OO
.ui
.PageLayout
.prototype.getName = function () {
1194 * Check if page is active.
1196 * Pages become active when they are shown in a {@link OO.ui.BookletLayout booklet layout} that is configured to display
1197 * only one page at a time. Additional CSS is applied to the page's outline item to reflect the active state.
1199 * @return {boolean} Page is active
1201 OO
.ui
.PageLayout
.prototype.isActive = function () {
1208 * The outline item allows users to access the page from the booklet's outline
1209 * navigation. The outline item itself can be customized (with a label, level, etc.) using the #setupOutlineItem method.
1211 * @return {OO.ui.OutlineOptionWidget|null} Outline option widget
1213 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
1214 return this.outlineItem
;
1218 * Set or unset the outline item.
1220 * Specify an {@link OO.ui.OutlineOptionWidget outline option} to set it,
1221 * or `null` to clear the outline item. To customize the outline item itself (e.g., to set a label or outline
1222 * level), use #setupOutlineItem instead of this method.
1224 * @param {OO.ui.OutlineOptionWidget|null} outlineItem Outline option widget, null to clear
1227 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
1228 this.outlineItem
= outlineItem
|| null;
1229 if ( outlineItem
) {
1230 this.setupOutlineItem();
1236 * Set up the outline item.
1238 * Use this method to customize the outline item (e.g., to add a label or outline level). To set or unset
1239 * the outline item itself (with an {@link OO.ui.OutlineOptionWidget outline option} or `null`), use
1240 * the #setOutlineItem method instead.
1242 * @param {OO.ui.OutlineOptionWidget} outlineItem Outline option widget to set up
1245 OO
.ui
.PageLayout
.prototype.setupOutlineItem = function () {
1250 * Set the page to its 'active' state.
1252 * Pages become active when they are shown in a booklet layout that is configured to display only one page at a time. Additional
1253 * CSS is applied to the outline item to reflect the page's active state. Outside of the booklet
1254 * context, setting the active state on a page does nothing.
1256 * @param {boolean} active Page is active
1259 OO
.ui
.PageLayout
.prototype.setActive = function ( active
) {
1262 if ( active
!== this.active
) {
1263 this.active
= active
;
1264 this.$element
.toggleClass( 'oo-ui-pageLayout-active', active
);
1265 this.emit( 'active', this.active
);
1270 * StackLayouts contain a series of {@link OO.ui.PanelLayout panel layouts}. By default, only one panel is displayed
1271 * at a time, though the stack layout can also be configured to show all contained panels, one after another,
1272 * by setting the #continuous option to 'true'.
1275 * // A stack layout with two panels, configured to be displayed continously
1276 * var myStack = new OO.ui.StackLayout( {
1278 * new OO.ui.PanelLayout( {
1279 * $content: $( '<p>Panel One</p>' ),
1283 * new OO.ui.PanelLayout( {
1284 * $content: $( '<p>Panel Two</p>' ),
1291 * $( 'body' ).append( myStack.$element );
1294 * @extends OO.ui.PanelLayout
1295 * @mixins OO.ui.mixin.GroupElement
1298 * @param {Object} [config] Configuration options
1299 * @cfg {boolean} [continuous=false] Show all panels, one after another. By default, only one panel is displayed at a time.
1300 * @cfg {OO.ui.Layout[]} [items] Panel layouts to add to the stack layout.
1302 OO
.ui
.StackLayout
= function OoUiStackLayout( config
) {
1303 // Configuration initialization
1304 config
= $.extend( { scrollable
: true }, config
);
1306 // Parent constructor
1307 OO
.ui
.StackLayout
.parent
.call( this, config
);
1309 // Mixin constructors
1310 OO
.ui
.mixin
.GroupElement
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
1313 this.currentItem
= null;
1314 this.continuous
= !!config
.continuous
;
1317 this.$element
.addClass( 'oo-ui-stackLayout' );
1318 if ( this.continuous
) {
1319 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
1320 this.$element
.on( 'scroll', OO
.ui
.debounce( this.onScroll
.bind( this ), 250 ) );
1322 if ( Array
.isArray( config
.items
) ) {
1323 this.addItems( config
.items
);
1329 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
1330 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.mixin
.GroupElement
);
1335 * A 'set' event is emitted when panels are {@link #addItems added}, {@link #removeItems removed},
1336 * {@link #clearItems cleared} or {@link #setItem displayed}.
1339 * @param {OO.ui.Layout|null} item Current panel or `null` if no panel is shown
1343 * When used in continuous mode, this event is emitted when the user scrolls down
1344 * far enough such that currentItem is no longer visible.
1346 * @event visibleItemChange
1347 * @param {OO.ui.PanelLayout} panel The next visible item in the layout
1353 * Handle scroll events from the layout element
1355 * @param {jQuery.Event} e
1356 * @fires visibleItemChange
1358 OO
.ui
.StackLayout
.prototype.onScroll = function () {
1360 len
= this.items
.length
,
1361 currentIndex
= this.items
.indexOf( this.currentItem
),
1362 newIndex
= currentIndex
,
1363 containerRect
= this.$element
[ 0 ].getBoundingClientRect();
1365 if ( !containerRect
|| ( !containerRect
.top
&& !containerRect
.bottom
) ) {
1366 // Can't get bounding rect, possibly not attached.
1370 function getRect( item
) {
1371 return item
.$element
[ 0 ].getBoundingClientRect();
1374 function isVisible( item
) {
1375 var rect
= getRect( item
);
1376 return rect
.bottom
> containerRect
.top
&& rect
.top
< containerRect
.bottom
;
1379 currentRect
= getRect( this.currentItem
);
1381 if ( currentRect
.bottom
< containerRect
.top
) {
1382 // Scrolled down past current item
1383 while ( ++newIndex
< len
) {
1384 if ( isVisible( this.items
[ newIndex
] ) ) {
1388 } else if ( currentRect
.top
> containerRect
.bottom
) {
1389 // Scrolled up past current item
1390 while ( --newIndex
>= 0 ) {
1391 if ( isVisible( this.items
[ newIndex
] ) ) {
1397 if ( newIndex
!== currentIndex
) {
1398 this.emit( 'visibleItemChange', this.items
[ newIndex
] );
1403 * Get the current panel.
1405 * @return {OO.ui.Layout|null}
1407 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
1408 return this.currentItem
;
1412 * Unset the current item.
1415 * @param {OO.ui.StackLayout} layout
1418 OO
.ui
.StackLayout
.prototype.unsetCurrentItem = function () {
1419 var prevItem
= this.currentItem
;
1420 if ( prevItem
=== null ) {
1424 this.currentItem
= null;
1425 this.emit( 'set', null );
1429 * Add panel layouts to the stack layout.
1431 * Panels will be added to the end of the stack layout array unless the optional index parameter specifies a different
1432 * insertion point. Adding a panel that is already in the stack will move it to the end of the array or the point specified
1435 * @param {OO.ui.Layout[]} items Panels to add
1436 * @param {number} [index] Index of the insertion point
1439 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
1440 // Update the visibility
1441 this.updateHiddenState( items
, this.currentItem
);
1444 OO
.ui
.mixin
.GroupElement
.prototype.addItems
.call( this, items
, index
);
1446 if ( !this.currentItem
&& items
.length
) {
1447 this.setItem( items
[ 0 ] );
1454 * Remove the specified panels from the stack layout.
1456 * Removed panels are detached from the DOM, not removed, so that they may be reused. To remove all panels,
1457 * you may wish to use the #clearItems method instead.
1459 * @param {OO.ui.Layout[]} items Panels to remove
1463 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
1465 OO
.ui
.mixin
.GroupElement
.prototype.removeItems
.call( this, items
);
1467 if ( items
.indexOf( this.currentItem
) !== -1 ) {
1468 if ( this.items
.length
) {
1469 this.setItem( this.items
[ 0 ] );
1471 this.unsetCurrentItem();
1479 * Clear all panels from the stack layout.
1481 * Cleared panels are detached from the DOM, not removed, so that they may be reused. To remove only
1482 * a subset of panels, use the #removeItems method.
1487 OO
.ui
.StackLayout
.prototype.clearItems = function () {
1488 this.unsetCurrentItem();
1489 OO
.ui
.mixin
.GroupElement
.prototype.clearItems
.call( this );
1495 * Show the specified panel.
1497 * If another panel is currently displayed, it will be hidden.
1499 * @param {OO.ui.Layout} item Panel to show
1503 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
1504 if ( item
!== this.currentItem
) {
1505 this.updateHiddenState( this.items
, item
);
1507 if ( this.items
.indexOf( item
) !== -1 ) {
1508 this.currentItem
= item
;
1509 this.emit( 'set', item
);
1511 this.unsetCurrentItem();
1519 * Update the visibility of all items in case of non-continuous view.
1521 * Ensure all items are hidden except for the selected one.
1522 * This method does nothing when the stack is continuous.
1525 * @param {OO.ui.Layout[]} items Item list iterate over
1526 * @param {OO.ui.Layout} [selectedItem] Selected item to show
1528 OO
.ui
.StackLayout
.prototype.updateHiddenState = function ( items
, selectedItem
) {
1531 if ( !this.continuous
) {
1532 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
1533 if ( !selectedItem
|| selectedItem
!== items
[ i
] ) {
1534 items
[ i
].$element
.addClass( 'oo-ui-element-hidden' );
1535 items
[ i
].$element
.attr( 'aria-hidden', 'true' );
1538 if ( selectedItem
) {
1539 selectedItem
.$element
.removeClass( 'oo-ui-element-hidden' );
1540 selectedItem
.$element
.removeAttr( 'aria-hidden' );
1546 * MenuLayouts combine a menu and a content {@link OO.ui.PanelLayout panel}. The menu is positioned relative to the content (after, before, top, or bottom)
1547 * and its size is customized with the #menuSize config. The content area will fill all remaining space.
1550 * var menuLayout = new OO.ui.MenuLayout( {
1553 * menuPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1554 * contentPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1555 * select = new OO.ui.SelectWidget( {
1557 * new OO.ui.OptionWidget( {
1561 * new OO.ui.OptionWidget( {
1565 * new OO.ui.OptionWidget( {
1569 * new OO.ui.OptionWidget( {
1574 * } ).on( 'select', function ( item ) {
1575 * menuLayout.setMenuPosition( item.getData() );
1578 * menuLayout.$menu.append(
1579 * menuPanel.$element.append( '<b>Menu panel</b>', select.$element )
1581 * menuLayout.$content.append(
1582 * contentPanel.$element.append( '<b>Content panel</b>', '<p>Note that the menu is positioned relative to the content panel: top, bottom, after, before.</p>')
1584 * $( 'body' ).append( menuLayout.$element );
1586 * If menu size needs to be overridden, it can be accomplished using CSS similar to the snippet
1587 * below. MenuLayout's CSS will override the appropriate values with 'auto' or '0' to display the
1588 * menu correctly. If `menuPosition` is known beforehand, CSS rules corresponding to other positions
1591 * .oo-ui-menuLayout-menu {
1595 * .oo-ui-menuLayout-content {
1603 * @extends OO.ui.Layout
1606 * @param {Object} [config] Configuration options
1607 * @cfg {boolean} [showMenu=true] Show menu
1608 * @cfg {string} [menuPosition='before'] Position of menu: `top`, `after`, `bottom` or `before`
1610 OO
.ui
.MenuLayout
= function OoUiMenuLayout( config
) {
1611 // Configuration initialization
1612 config
= $.extend( {
1614 menuPosition
: 'before'
1617 // Parent constructor
1618 OO
.ui
.MenuLayout
.parent
.call( this, config
);
1623 * @property {jQuery}
1625 this.$menu
= $( '<div>' );
1629 * @property {jQuery}
1631 this.$content
= $( '<div>' );
1635 .addClass( 'oo-ui-menuLayout-menu' );
1636 this.$content
.addClass( 'oo-ui-menuLayout-content' );
1638 .addClass( 'oo-ui-menuLayout' )
1639 .append( this.$content
, this.$menu
);
1640 this.setMenuPosition( config
.menuPosition
);
1641 this.toggleMenu( config
.showMenu
);
1646 OO
.inheritClass( OO
.ui
.MenuLayout
, OO
.ui
.Layout
);
1653 * @param {boolean} showMenu Show menu, omit to toggle
1656 OO
.ui
.MenuLayout
.prototype.toggleMenu = function ( showMenu
) {
1657 showMenu
= showMenu
=== undefined ? !this.showMenu
: !!showMenu
;
1659 if ( this.showMenu
!== showMenu
) {
1660 this.showMenu
= showMenu
;
1662 .toggleClass( 'oo-ui-menuLayout-showMenu', this.showMenu
)
1663 .toggleClass( 'oo-ui-menuLayout-hideMenu', !this.showMenu
);
1664 this.$menu
.attr( 'aria-hidden', this.showMenu
? 'false' : 'true' );
1671 * Check if menu is visible
1673 * @return {boolean} Menu is visible
1675 OO
.ui
.MenuLayout
.prototype.isMenuVisible = function () {
1676 return this.showMenu
;
1680 * Set menu position.
1682 * @param {string} position Position of menu, either `top`, `after`, `bottom` or `before`
1683 * @throws {Error} If position value is not supported
1686 OO
.ui
.MenuLayout
.prototype.setMenuPosition = function ( position
) {
1687 this.$element
.removeClass( 'oo-ui-menuLayout-' + this.menuPosition
);
1688 this.menuPosition
= position
;
1689 this.$element
.addClass( 'oo-ui-menuLayout-' + position
);
1695 * Get menu position.
1697 * @return {string} Menu position
1699 OO
.ui
.MenuLayout
.prototype.getMenuPosition = function () {
1700 return this.menuPosition
;
1704 * BookletLayouts contain {@link OO.ui.PageLayout page layouts} as well as
1705 * an {@link OO.ui.OutlineSelectWidget outline} that allows users to easily navigate
1706 * through the pages and select which one to display. By default, only one page is
1707 * displayed at a time and the outline is hidden. When a user navigates to a new page,
1708 * the booklet layout automatically focuses on the first focusable element, unless the
1709 * default setting is changed. Optionally, booklets can be configured to show
1710 * {@link OO.ui.OutlineControlsWidget controls} for adding, moving, and removing items.
1713 * // Example of a BookletLayout that contains two PageLayouts.
1715 * function PageOneLayout( name, config ) {
1716 * PageOneLayout.parent.call( this, name, config );
1717 * this.$element.append( '<p>First page</p><p>(This booklet has an outline, displayed on the left)</p>' );
1719 * OO.inheritClass( PageOneLayout, OO.ui.PageLayout );
1720 * PageOneLayout.prototype.setupOutlineItem = function () {
1721 * this.outlineItem.setLabel( 'Page One' );
1724 * function PageTwoLayout( name, config ) {
1725 * PageTwoLayout.parent.call( this, name, config );
1726 * this.$element.append( '<p>Second page</p>' );
1728 * OO.inheritClass( PageTwoLayout, OO.ui.PageLayout );
1729 * PageTwoLayout.prototype.setupOutlineItem = function () {
1730 * this.outlineItem.setLabel( 'Page Two' );
1733 * var page1 = new PageOneLayout( 'one' ),
1734 * page2 = new PageTwoLayout( 'two' );
1736 * var booklet = new OO.ui.BookletLayout( {
1740 * booklet.addPages ( [ page1, page2 ] );
1741 * $( 'body' ).append( booklet.$element );
1744 * @extends OO.ui.MenuLayout
1747 * @param {Object} [config] Configuration options
1748 * @cfg {boolean} [continuous=false] Show all pages, one after another
1749 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new page is displayed. Disabled on mobile.
1750 * @cfg {boolean} [outlined=false] Show the outline. The outline is used to navigate through the pages of the booklet.
1751 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
1753 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
1754 // Configuration initialization
1755 config
= config
|| {};
1757 // Parent constructor
1758 OO
.ui
.BookletLayout
.parent
.call( this, config
);
1761 this.currentPageName
= null;
1763 this.ignoreFocus
= false;
1764 this.stackLayout
= new OO
.ui
.StackLayout( { continuous
: !!config
.continuous
} );
1765 this.$content
.append( this.stackLayout
.$element
);
1766 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
1767 this.outlineVisible
= false;
1768 this.outlined
= !!config
.outlined
;
1769 if ( this.outlined
) {
1770 this.editable
= !!config
.editable
;
1771 this.outlineControlsWidget
= null;
1772 this.outlineSelectWidget
= new OO
.ui
.OutlineSelectWidget();
1773 this.outlinePanel
= new OO
.ui
.PanelLayout( { scrollable
: true } );
1774 this.$menu
.append( this.outlinePanel
.$element
);
1775 this.outlineVisible
= true;
1776 if ( this.editable
) {
1777 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
1778 this.outlineSelectWidget
1782 this.toggleMenu( this.outlined
);
1785 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
1786 if ( this.outlined
) {
1787 this.outlineSelectWidget
.connect( this, { select
: 'onOutlineSelectWidgetSelect' } );
1788 this.scrolling
= false;
1789 this.stackLayout
.connect( this, { visibleItemChange
: 'onStackLayoutVisibleItemChange' } );
1791 if ( this.autoFocus
) {
1792 // Event 'focus' does not bubble, but 'focusin' does
1793 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
1797 this.$element
.addClass( 'oo-ui-bookletLayout' );
1798 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
1799 if ( this.outlined
) {
1800 this.outlinePanel
.$element
1801 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
1802 .append( this.outlineSelectWidget
.$element
);
1803 if ( this.editable
) {
1804 this.outlinePanel
.$element
1805 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
1806 .append( this.outlineControlsWidget
.$element
);
1813 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.MenuLayout
);
1818 * A 'set' event is emitted when a page is {@link #setPage set} to be displayed by the booklet layout.
1820 * @param {OO.ui.PageLayout} page Current page
1824 * An 'add' event is emitted when pages are {@link #addPages added} to the booklet layout.
1827 * @param {OO.ui.PageLayout[]} page Added pages
1828 * @param {number} index Index pages were added at
1832 * A 'remove' event is emitted when pages are {@link #clearPages cleared} or
1833 * {@link #removePages removed} from the booklet.
1836 * @param {OO.ui.PageLayout[]} pages Removed pages
1842 * Handle stack layout focus.
1845 * @param {jQuery.Event} e Focusin event
1847 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
1850 // Find the page that an element was focused within
1851 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
1852 for ( name
in this.pages
) {
1853 // Check for page match, exclude current page to find only page changes
1854 if ( this.pages
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentPageName
) {
1855 this.setPage( name
);
1862 * Handle visibleItemChange events from the stackLayout
1864 * The next visible page is set as the current page by selecting it
1867 * @param {OO.ui.PageLayout} page The next visible page in the layout
1869 OO
.ui
.BookletLayout
.prototype.onStackLayoutVisibleItemChange = function ( page
) {
1870 // Set a flag to so that the resulting call to #onStackLayoutSet doesn't
1871 // try and scroll the item into view again.
1872 this.scrolling
= true;
1873 this.outlineSelectWidget
.selectItemByData( page
.getName() );
1874 this.scrolling
= false;
1878 * Handle stack layout set events.
1881 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
1883 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
1885 if ( !this.scrolling
&& page
) {
1886 page
.scrollElementIntoView().done( function () {
1887 if ( layout
.autoFocus
&& !OO
.ui
.isMobile() ) {
1895 * Focus the first input in the current page.
1897 * If no page is selected, the first selectable page will be selected.
1898 * If the focus is already in an element on the current page, nothing will happen.
1900 * @param {number} [itemIndex] A specific item to focus on
1902 OO
.ui
.BookletLayout
.prototype.focus = function ( itemIndex
) {
1904 items
= this.stackLayout
.getItems();
1906 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
1907 page
= items
[ itemIndex
];
1909 page
= this.stackLayout
.getCurrentItem();
1912 if ( !page
&& this.outlined
) {
1913 this.selectFirstSelectablePage();
1914 page
= this.stackLayout
.getCurrentItem();
1919 // Only change the focus if is not already in the current page
1920 if ( !OO
.ui
.contains( page
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
1926 * Find the first focusable input in the booklet layout and focus
1929 OO
.ui
.BookletLayout
.prototype.focusFirstFocusable = function () {
1930 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
1934 * Handle outline widget select events.
1937 * @param {OO.ui.OptionWidget|null} item Selected item
1939 OO
.ui
.BookletLayout
.prototype.onOutlineSelectWidgetSelect = function ( item
) {
1941 this.setPage( item
.getData() );
1946 * Check if booklet has an outline.
1948 * @return {boolean} Booklet has an outline
1950 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
1951 return this.outlined
;
1955 * Check if booklet has editing controls.
1957 * @return {boolean} Booklet is editable
1959 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
1960 return this.editable
;
1964 * Check if booklet has a visible outline.
1966 * @return {boolean} Outline is visible
1968 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
1969 return this.outlined
&& this.outlineVisible
;
1973 * Hide or show the outline.
1975 * @param {boolean} [show] Show outline, omit to invert current state
1978 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
1979 if ( this.outlined
) {
1980 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
1981 this.outlineVisible
= show
;
1982 this.toggleMenu( show
);
1989 * Get the page closest to the specified page.
1991 * @param {OO.ui.PageLayout} page Page to use as a reference point
1992 * @return {OO.ui.PageLayout|null} Page closest to the specified page
1994 OO
.ui
.BookletLayout
.prototype.getClosestPage = function ( page
) {
1995 var next
, prev
, level
,
1996 pages
= this.stackLayout
.getItems(),
1997 index
= pages
.indexOf( page
);
1999 if ( index
!== -1 ) {
2000 next
= pages
[ index
+ 1 ];
2001 prev
= pages
[ index
- 1 ];
2002 // Prefer adjacent pages at the same level
2003 if ( this.outlined
) {
2004 level
= this.outlineSelectWidget
.getItemFromData( page
.getName() ).getLevel();
2007 level
=== this.outlineSelectWidget
.getItemFromData( prev
.getName() ).getLevel()
2013 level
=== this.outlineSelectWidget
.getItemFromData( next
.getName() ).getLevel()
2019 return prev
|| next
|| null;
2023 * Get the outline widget.
2025 * If the booklet is not outlined, the method will return `null`.
2027 * @return {OO.ui.OutlineSelectWidget|null} Outline widget, or null if the booklet is not outlined
2029 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
2030 return this.outlineSelectWidget
;
2034 * Get the outline controls widget.
2036 * If the outline is not editable, the method will return `null`.
2038 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
2040 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
2041 return this.outlineControlsWidget
;
2045 * Get a page by its symbolic name.
2047 * @param {string} name Symbolic name of page
2048 * @return {OO.ui.PageLayout|undefined} Page, if found
2050 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
2051 return this.pages
[ name
];
2055 * Get the current page.
2057 * @return {OO.ui.PageLayout|undefined} Current page, if found
2059 OO
.ui
.BookletLayout
.prototype.getCurrentPage = function () {
2060 var name
= this.getCurrentPageName();
2061 return name
? this.getPage( name
) : undefined;
2065 * Get the symbolic name of the current page.
2067 * @return {string|null} Symbolic name of the current page
2069 OO
.ui
.BookletLayout
.prototype.getCurrentPageName = function () {
2070 return this.currentPageName
;
2074 * Add pages to the booklet layout
2076 * When pages are added with the same names as existing pages, the existing pages will be
2077 * automatically removed before the new pages are added.
2079 * @param {OO.ui.PageLayout[]} pages Pages to add
2080 * @param {number} index Index of the insertion point
2084 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
2085 var i
, len
, name
, page
, item
, currentIndex
,
2086 stackLayoutPages
= this.stackLayout
.getItems(),
2090 // Remove pages with same names
2091 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2093 name
= page
.getName();
2095 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
2096 // Correct the insertion index
2097 currentIndex
= stackLayoutPages
.indexOf( this.pages
[ name
] );
2098 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2101 remove
.push( this.pages
[ name
] );
2104 if ( remove
.length
) {
2105 this.removePages( remove
);
2109 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2111 name
= page
.getName();
2112 this.pages
[ page
.getName() ] = page
;
2113 if ( this.outlined
) {
2114 item
= new OO
.ui
.OutlineOptionWidget( { data
: name
} );
2115 page
.setOutlineItem( item
);
2120 if ( this.outlined
&& items
.length
) {
2121 this.outlineSelectWidget
.addItems( items
, index
);
2122 this.selectFirstSelectablePage();
2124 this.stackLayout
.addItems( pages
, index
);
2125 this.emit( 'add', pages
, index
);
2131 * Remove the specified pages from the booklet layout.
2133 * To remove all pages from the booklet, you may wish to use the #clearPages method instead.
2135 * @param {OO.ui.PageLayout[]} pages An array of pages to remove
2139 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
2140 var i
, len
, name
, page
,
2143 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2145 name
= page
.getName();
2146 delete this.pages
[ name
];
2147 if ( this.outlined
) {
2148 items
.push( this.outlineSelectWidget
.getItemFromData( name
) );
2149 page
.setOutlineItem( null );
2152 if ( this.outlined
&& items
.length
) {
2153 this.outlineSelectWidget
.removeItems( items
);
2154 this.selectFirstSelectablePage();
2156 this.stackLayout
.removeItems( pages
);
2157 this.emit( 'remove', pages
);
2163 * Clear all pages from the booklet layout.
2165 * To remove only a subset of pages from the booklet, use the #removePages method.
2170 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
2172 pages
= this.stackLayout
.getItems();
2175 this.currentPageName
= null;
2176 if ( this.outlined
) {
2177 this.outlineSelectWidget
.clearItems();
2178 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2179 pages
[ i
].setOutlineItem( null );
2182 this.stackLayout
.clearItems();
2184 this.emit( 'remove', pages
);
2190 * Set the current page by symbolic name.
2193 * @param {string} name Symbolic name of page
2195 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
2198 page
= this.pages
[ name
],
2199 previousPage
= this.currentPageName
&& this.pages
[ this.currentPageName
];
2201 if ( name
!== this.currentPageName
) {
2202 if ( this.outlined
) {
2203 selectedItem
= this.outlineSelectWidget
.getSelectedItem();
2204 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2205 this.outlineSelectWidget
.selectItemByData( name
);
2209 if ( previousPage
) {
2210 previousPage
.setActive( false );
2211 // Blur anything focused if the next page doesn't have anything focusable.
2212 // This is not needed if the next page has something focusable (because once it is focused
2213 // this blur happens automatically). If the layout is non-continuous, this check is
2214 // meaningless because the next page is not visible yet and thus can't hold focus.
2217 !OO
.ui
.isMobile() &&
2218 this.stackLayout
.continuous
&&
2219 OO
.ui
.findFocusable( page
.$element
).length
!== 0
2221 $focused
= previousPage
.$element
.find( ':focus' );
2222 if ( $focused
.length
) {
2223 $focused
[ 0 ].blur();
2227 this.currentPageName
= name
;
2228 page
.setActive( true );
2229 this.stackLayout
.setItem( page
);
2230 if ( !this.stackLayout
.continuous
&& previousPage
) {
2231 // This should not be necessary, since any inputs on the previous page should have been
2232 // blurred when it was hidden, but browsers are not very consistent about this.
2233 $focused
= previousPage
.$element
.find( ':focus' );
2234 if ( $focused
.length
) {
2235 $focused
[ 0 ].blur();
2238 this.emit( 'set', page
);
2244 * Select the first selectable page.
2248 OO
.ui
.BookletLayout
.prototype.selectFirstSelectablePage = function () {
2249 if ( !this.outlineSelectWidget
.getSelectedItem() ) {
2250 this.outlineSelectWidget
.selectItem( this.outlineSelectWidget
.getFirstSelectableItem() );
2257 * IndexLayouts contain {@link OO.ui.TabPanelLayout tab panel layouts} as well as
2258 * {@link OO.ui.TabSelectWidget tabs} that allow users to easily navigate through the tab panels and
2259 * select which one to display. By default, only one tab panel is displayed at a time. When a user
2260 * navigates to a new tab panel, the index layout automatically focuses on the first focusable element,
2261 * unless the default setting is changed.
2263 * TODO: This class is similar to BookletLayout, we may want to refactor to reduce duplication
2266 * // Example of a IndexLayout that contains two TabPanelLayouts.
2268 * function TabPanelOneLayout( name, config ) {
2269 * TabPanelOneLayout.parent.call( this, name, config );
2270 * this.$element.append( '<p>First tab panel</p>' );
2272 * OO.inheritClass( TabPanelOneLayout, OO.ui.TabPanelLayout );
2273 * TabPanelOneLayout.prototype.setupTabItem = function () {
2274 * this.tabItem.setLabel( 'Tab panel one' );
2277 * var tabPanel1 = new TabPanelOneLayout( 'one' ),
2278 * tabPanel2 = new OO.ui.TabPanelLayout( 'two', { label: 'Tab panel two' } );
2280 * tabPanel2.$element.append( '<p>Second tab panel</p>' );
2282 * var index = new OO.ui.IndexLayout();
2284 * index.addTabPanelss ( [ tabPanel1, tabPanel2 ] );
2285 * $( 'body' ).append( index.$element );
2288 * @extends OO.ui.MenuLayout
2291 * @param {Object} [config] Configuration options
2292 * @cfg {boolean} [continuous=false] Show all tab panels, one after another
2293 * @cfg {boolean} [expanded=true] Expand the content panel to fill the entire parent element.
2294 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new tab panel is displayed. Disabled on mobile.
2296 OO
.ui
.IndexLayout
= function OoUiIndexLayout( config
) {
2297 // Configuration initialization
2298 config
= $.extend( {}, config
, { menuPosition
: 'top' } );
2300 // Parent constructor
2301 OO
.ui
.IndexLayout
.parent
.call( this, config
);
2304 this.currentTabPanelName
= null;
2305 this.tabPanels
= {};
2307 Object
.defineProperty( this, 'currentCardName', {
2308 // TODO: read documentation
2312 OO
.ui
.warnDeprecation( 'IndexLayout\'s currentCardName property is deprecated. Use currentTabPanelName instead. See T155152' );
2313 return this.currentTabPanelName
;
2315 set: function ( value
) {
2316 OO
.ui
.warnDeprecation( 'IndexLayout\'s currentCardName property is deprecated. Use currentTabPanelName instead. See T155152' );
2317 this.currentTabPanelName
= value
;
2321 Object
.defineProperty( this, 'cards', {
2322 // TODO: read documentation
2326 OO
.ui
.warnDeprecation( 'IndexLayout\'s cards property is deprecated. Use tabPanels instead. See T155152' );
2327 return this.tabPanels
;
2329 set: function ( value
) {
2330 OO
.ui
.warnDeprecation( 'IndexLayout\'s cards property is deprecated. Use tabPanels instead. See T155152' );
2331 this.tabPanels
= value
;
2335 this.ignoreFocus
= false;
2336 this.stackLayout
= new OO
.ui
.StackLayout( {
2337 continuous
: !!config
.continuous
,
2338 expanded
: config
.expanded
2340 this.$content
.append( this.stackLayout
.$element
);
2341 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
2343 this.tabSelectWidget
= new OO
.ui
.TabSelectWidget();
2344 this.tabPanel
= new OO
.ui
.PanelLayout();
2345 this.$menu
.append( this.tabPanel
.$element
);
2347 this.toggleMenu( true );
2350 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
2351 this.tabSelectWidget
.connect( this, { select
: 'onTabSelectWidgetSelect' } );
2352 if ( this.autoFocus
) {
2353 // Event 'focus' does not bubble, but 'focusin' does
2354 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
2358 this.$element
.addClass( 'oo-ui-indexLayout' );
2359 this.stackLayout
.$element
.addClass( 'oo-ui-indexLayout-stackLayout' );
2360 this.tabPanel
.$element
2361 .addClass( 'oo-ui-indexLayout-tabPanel' )
2362 .append( this.tabSelectWidget
.$element
);
2367 OO
.inheritClass( OO
.ui
.IndexLayout
, OO
.ui
.MenuLayout
);
2372 * A 'set' event is emitted when a tab panel is {@link #setTabPanel set} to be displayed by the index layout.
2374 * @param {OO.ui.TabPanelLayout} tabPanel Current tab panel
2378 * An 'add' event is emitted when tab panels are {@link #addTabPanels added} to the index layout.
2381 * @param {OO.ui.TabPanelLayout[]} tabPanel Added tab panels
2382 * @param {number} index Index tab panels were added at
2386 * A 'remove' event is emitted when tab panels are {@link #clearTabPanels cleared} or
2387 * {@link #removeTabPanels removed} from the index.
2390 * @param {OO.ui.TabPanelLayout[]} tabPanel Removed tab panels
2396 * Handle stack layout focus.
2399 * @param {jQuery.Event} e Focusing event
2401 OO
.ui
.IndexLayout
.prototype.onStackLayoutFocus = function ( e
) {
2404 // Find the tab panel that an element was focused within
2405 $target
= $( e
.target
).closest( '.oo-ui-tabPanelLayout' );
2406 for ( name
in this.tabPanels
) {
2407 // Check for tab panel match, exclude current tab panel to find only tab panel changes
2408 if ( this.tabPanels
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentTabPanelName
) {
2409 this.setTabPanel( name
);
2416 * Handle stack layout set events.
2419 * @param {OO.ui.PanelLayout|null} tabPanel The tab panel that is now the current panel
2421 OO
.ui
.IndexLayout
.prototype.onStackLayoutSet = function ( tabPanel
) {
2424 tabPanel
.scrollElementIntoView().done( function () {
2425 if ( layout
.autoFocus
&& !OO
.ui
.isMobile() ) {
2433 * Focus the first input in the current tab panel.
2435 * If no tab panel is selected, the first selectable tab panel will be selected.
2436 * If the focus is already in an element on the current tab panel, nothing will happen.
2438 * @param {number} [itemIndex] A specific item to focus on
2440 OO
.ui
.IndexLayout
.prototype.focus = function ( itemIndex
) {
2442 items
= this.stackLayout
.getItems();
2444 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
2445 tabPanel
= items
[ itemIndex
];
2447 tabPanel
= this.stackLayout
.getCurrentItem();
2451 this.selectFirstSelectableTabPanel();
2452 tabPanel
= this.stackLayout
.getCurrentItem();
2457 // Only change the focus if is not already in the current page
2458 if ( !OO
.ui
.contains( tabPanel
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
2464 * Find the first focusable input in the index layout and focus
2467 OO
.ui
.IndexLayout
.prototype.focusFirstFocusable = function () {
2468 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
2472 * Handle tab widget select events.
2475 * @param {OO.ui.OptionWidget|null} item Selected item
2477 OO
.ui
.IndexLayout
.prototype.onTabSelectWidgetSelect = function ( item
) {
2479 this.setTabPanel( item
.getData() );
2484 * Get the tab panel closest to the specified tab panel.
2486 * @param {OO.ui.TabPanelLayout} tabPanel Tab panel to use as a reference point
2487 * @return {OO.ui.TabPanelLayout|null} Tab panel closest to the specified
2489 OO
.ui
.IndexLayout
.prototype.getClosestTabPanel = function ( tabPanel
) {
2490 var next
, prev
, level
,
2491 tabPanels
= this.stackLayout
.getItems(),
2492 index
= tabPanels
.indexOf( tabPanel
);
2494 if ( index
!== -1 ) {
2495 next
= tabPanels
[ index
+ 1 ];
2496 prev
= tabPanels
[ index
- 1 ];
2497 // Prefer adjacent tab panels at the same level
2498 level
= this.tabSelectWidget
.getItemFromData( tabPanel
.getName() ).getLevel();
2501 level
=== this.tabSelectWidget
.getItemFromData( prev
.getName() ).getLevel()
2507 level
=== this.tabSelectWidget
.getItemFromData( next
.getName() ).getLevel()
2512 return prev
|| next
|| null;
2516 * Get the tab panel closest to the specified tab panel.
2518 * @param {OO.ui.TabPanelLayout} tabPanel Tab panel to use as a reference point
2519 * @return {OO.ui.TabPanelLayout|null} Tab panel closest to the specified
2520 * @deprecated since v0.22.0, use `getClosestTabPanel` instead
2522 OO
.ui
.IndexLayout
.prototype.getClosestCard = function ( tabPanel
) {
2523 OO
.ui
.warnDeprecation( 'IndexLayout\'s getClosestCard method is deprecated. Use getClosestTabPanel instead. See T155152' );
2524 return this.getClosestTabPanel( tabPanel
);
2528 * Get the tabs widget.
2530 * @return {OO.ui.TabSelectWidget} Tabs widget
2532 OO
.ui
.IndexLayout
.prototype.getTabs = function () {
2533 return this.tabSelectWidget
;
2537 * Get a tab panel by its symbolic name.
2539 * @param {string} name Symbolic name of tab panel
2540 * @return {OO.ui.TabPanelLayout|undefined} Tab panel, if found
2542 OO
.ui
.IndexLayout
.prototype.getTabPanel = function ( name
) {
2543 return this.tabPanels
[ name
];
2547 * Get a tab panel by its symbolic name.
2549 * @param {string} name Symbolic name of tab panel
2550 * @return {OO.ui.TabPanelLayout|undefined} Tab panel, if found
2551 * @deprecated since v0.22.0, use `getTabPanel` instead
2553 OO
.ui
.IndexLayout
.prototype.getCard = function ( name
) {
2554 OO
.ui
.warnDeprecation( 'IndexLayout\'s getCard method is deprecated. Use getTabPanel instead. See T155152' );
2555 return this.getTabPanel( name
);
2559 * Get the current tab panel.
2561 * @return {OO.ui.TabPanelLayout|undefined} Current tab panel, if found
2563 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanel = function () {
2564 var name
= this.getCurrentTabPanelName();
2565 return name
? this.getTabPanel( name
) : undefined;
2569 * Get the current tab panel.
2571 * @return {OO.ui.TabPanelLayout|undefined} Current tab panel, if found
2572 * @deprecated since v0.22.0, use `getCurrentTabPanel` instead
2574 OO
.ui
.IndexLayout
.prototype.getCurrentCard = function () {
2575 OO
.ui
.warnDeprecation( 'IndexLayout\'s getCurrentCard method is deprecated. Use getCurrentTabPanel instead. See T155152' );
2576 return this.getCurrentTabPanel();
2580 * Get the symbolic name of the current tab panel.
2582 * @return {string|null} Symbolic name of the current tab panel
2584 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanelName = function () {
2585 return this.currentTabPanelName
;
2589 * Get the symbolic name of the current tab panel.
2591 * @return {string|null} Symbolic name of the current tab panel
2592 * @deprecated since v0.22.0, use `getCurrentTabPanelName` instead
2594 OO
.ui
.IndexLayout
.prototype.getCurrentCardName = function () {
2595 OO
.ui
.warnDeprecation( 'IndexLayout\'s getCurrentCardName method is deprecated. Use getCurrentTabPanelName instead. See T155152' );
2596 return this.getCurrentTabPanelName();
2600 * Add tab panels to the index layout
2602 * When tab panels are added with the same names as existing tab panels, the existing tab panels
2603 * will be automatically removed before the new tab panels are added.
2605 * @param {OO.ui.TabPanelLayout[]} tabPanels Tab panels to add
2606 * @param {number} index Index of the insertion point
2610 OO
.ui
.IndexLayout
.prototype.addTabPanels = function ( tabPanels
, index
) {
2611 var i
, len
, name
, tabPanel
, item
, currentIndex
,
2612 stackLayoutTabPanels
= this.stackLayout
.getItems(),
2616 // Remove tab panels with same names
2617 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2618 tabPanel
= tabPanels
[ i
];
2619 name
= tabPanel
.getName();
2621 if ( Object
.prototype.hasOwnProperty
.call( this.tabPanels
, name
) ) {
2622 // Correct the insertion index
2623 currentIndex
= stackLayoutTabPanels
.indexOf( this.tabPanels
[ name
] );
2624 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2627 remove
.push( this.tabPanels
[ name
] );
2630 if ( remove
.length
) {
2631 this.removeTabPanels( remove
);
2634 // Add new tab panels
2635 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2636 tabPanel
= tabPanels
[ i
];
2637 name
= tabPanel
.getName();
2638 this.tabPanels
[ tabPanel
.getName() ] = tabPanel
;
2639 item
= new OO
.ui
.TabOptionWidget( { data
: name
} );
2640 tabPanel
.setTabItem( item
);
2644 if ( items
.length
) {
2645 this.tabSelectWidget
.addItems( items
, index
);
2646 this.selectFirstSelectableTabPanel();
2648 this.stackLayout
.addItems( tabPanels
, index
);
2649 this.emit( 'add', tabPanels
, index
);
2655 * Add tab panels to the index layout
2657 * When tab panels are added with the same names as existing tab panels, the existing tab panels
2658 * will be automatically removed before the new tab panels are added.
2660 * @param {OO.ui.TabPanelLayout[]} tabPanels Tab panels to add
2661 * @param {number} index Index of the insertion point
2664 * @deprecated since v0.22.0, use `addTabPanels` instead
2666 OO
.ui
.IndexLayout
.prototype.addCards = function ( tabPanels
, index
) {
2667 OO
.ui
.warnDeprecation( 'IndexLayout\'s addCards method is deprecated. Use addTabPanels instead. See T155152' );
2668 return this.addTabPanels( tabPanels
, index
);
2672 * Remove the specified tab panels from the index layout.
2674 * To remove all tab panels from the index, you may wish to use the #clearTabPanels method instead.
2676 * @param {OO.ui.TabPanelLayout[]} tabPanels An array of tab panels to remove
2680 OO
.ui
.IndexLayout
.prototype.removeTabPanels = function ( tabPanels
) {
2681 var i
, len
, name
, tabPanel
,
2684 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2685 tabPanel
= tabPanels
[ i
];
2686 name
= tabPanel
.getName();
2687 delete this.tabPanels
[ name
];
2688 items
.push( this.tabSelectWidget
.getItemFromData( name
) );
2689 tabPanel
.setTabItem( null );
2691 if ( items
.length
) {
2692 this.tabSelectWidget
.removeItems( items
);
2693 this.selectFirstSelectableTabPanel();
2695 this.stackLayout
.removeItems( tabPanels
);
2696 this.emit( 'remove', tabPanels
);
2702 * Remove the specified tab panels from the index layout.
2704 * To remove all tab panels from the index, you may wish to use the #clearTabPanels method instead.
2706 * @param {OO.ui.TabPanelLayout[]} tabPanels An array of tab panels to remove
2709 * @deprecated since v0.22.0, use `removeTabPanels` instead
2711 OO
.ui
.IndexLayout
.prototype.removeCards = function ( tabPanels
) {
2712 OO
.ui
.warnDeprecation( 'IndexLayout\'s removeCards method is deprecated. Use removeTabPanels instead. See T155152.' );
2713 return this.removeTabPanels( tabPanels
);
2717 * Clear all tab panels from the index layout.
2719 * To remove only a subset of tab panels from the index, use the #removeTabPanels method.
2724 OO
.ui
.IndexLayout
.prototype.clearTabPanels = function () {
2726 tabPanels
= this.stackLayout
.getItems();
2728 this.tabPanels
= {};
2729 this.currentTabPanelName
= null;
2730 this.tabSelectWidget
.clearItems();
2731 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2732 tabPanels
[ i
].setTabItem( null );
2734 this.stackLayout
.clearItems();
2736 this.emit( 'remove', tabPanels
);
2742 * Clear all tab panels from the index layout.
2744 * To remove only a subset of tab panels from the index, use the #removeTabPanels method.
2748 * @deprecated since v0.22.0, use `clearTabPanels` instead
2750 OO
.ui
.IndexLayout
.prototype.clearCards = function () {
2751 OO
.ui
.warnDeprecation( 'IndexLayout\'s clearCards method is deprecated. Use clearTabPanels instead. See T155152.' );
2752 return this.clearTabPanels();
2756 * Set the current tab panel by symbolic name.
2759 * @param {string} name Symbolic name of tab panel
2761 OO
.ui
.IndexLayout
.prototype.setTabPanel = function ( name
) {
2764 tabPanel
= this.tabPanels
[ name
],
2765 previousTabPanel
= this.currentTabPanelName
&& this.tabPanels
[ this.currentTabPanelName
];
2767 if ( name
!== this.currentTabPanelName
) {
2768 selectedItem
= this.tabSelectWidget
.getSelectedItem();
2769 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2770 this.tabSelectWidget
.selectItemByData( name
);
2773 if ( previousTabPanel
) {
2774 previousTabPanel
.setActive( false );
2775 // Blur anything focused if the next tab panel doesn't have anything focusable.
2776 // This is not needed if the next tab panel has something focusable (because once it is focused
2777 // this blur happens automatically). If the layout is non-continuous, this check is
2778 // meaningless because the next tab panel is not visible yet and thus can't hold focus.
2781 !OO
.ui
.isMobile() &&
2782 this.stackLayout
.continuous
&&
2783 OO
.ui
.findFocusable( tabPanel
.$element
).length
!== 0
2785 $focused
= previousTabPanel
.$element
.find( ':focus' );
2786 if ( $focused
.length
) {
2787 $focused
[ 0 ].blur();
2791 this.currentTabPanelName
= name
;
2792 tabPanel
.setActive( true );
2793 this.stackLayout
.setItem( tabPanel
);
2794 if ( !this.stackLayout
.continuous
&& previousTabPanel
) {
2795 // This should not be necessary, since any inputs on the previous tab panel should have been
2796 // blurred when it was hidden, but browsers are not very consistent about this.
2797 $focused
= previousTabPanel
.$element
.find( ':focus' );
2798 if ( $focused
.length
) {
2799 $focused
[ 0 ].blur();
2802 this.emit( 'set', tabPanel
);
2808 * Set the current tab panel by symbolic name.
2811 * @param {string} name Symbolic name of tab panel
2812 * @deprecated since v0.22.0, use `setTabPanel` instead
2814 OO
.ui
.IndexLayout
.prototype.setCard = function ( name
) {
2815 OO
.ui
.warnDeprecation( 'IndexLayout\'s setCard method is deprecated. Use setTabPanel instead. See T155152.' );
2816 return this.setTabPanel( name
);
2820 * Select the first selectable tab panel.
2824 OO
.ui
.IndexLayout
.prototype.selectFirstSelectableTabPanel = function () {
2825 if ( !this.tabSelectWidget
.getSelectedItem() ) {
2826 this.tabSelectWidget
.selectItem( this.tabSelectWidget
.getFirstSelectableItem() );
2833 * Select the first selectable tab panel.
2836 * @deprecated since v0.22.0, use `selectFirstSelectableTabPanel` instead
2838 OO
.ui
.IndexLayout
.prototype.selectFirstSelectableCard = function () {
2839 OO
.ui
.warnDeprecation( 'IndexLayout\'s selectFirstSelectableCard method is deprecated. Use selectFirestSelectableTabPanel instead. See T155152.' );
2840 return this.selectFirstSelectableTabPanel();
2844 * ToggleWidget implements basic behavior of widgets with an on/off state.
2845 * Please see OO.ui.ToggleButtonWidget and OO.ui.ToggleSwitchWidget for examples.
2849 * @extends OO.ui.Widget
2852 * @param {Object} [config] Configuration options
2853 * @cfg {boolean} [value=false] The toggle’s initial on/off state.
2854 * By default, the toggle is in the 'off' state.
2856 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
2857 // Configuration initialization
2858 config
= config
|| {};
2860 // Parent constructor
2861 OO
.ui
.ToggleWidget
.parent
.call( this, config
);
2867 this.$element
.addClass( 'oo-ui-toggleWidget' );
2868 this.setValue( !!config
.value
);
2873 OO
.inheritClass( OO
.ui
.ToggleWidget
, OO
.ui
.Widget
);
2880 * A change event is emitted when the on/off state of the toggle changes.
2882 * @param {boolean} value Value representing the new state of the toggle
2888 * Get the value representing the toggle’s state.
2890 * @return {boolean} The on/off state of the toggle
2892 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
2897 * Set the state of the toggle: `true` for 'on', `false` for 'off'.
2899 * @param {boolean} value The state of the toggle
2903 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
2905 if ( this.value
!== value
) {
2907 this.emit( 'change', value
);
2908 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
2909 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
2915 * ToggleButtons are buttons that have a state (‘on’ or ‘off’) that is represented by a
2916 * Boolean value. Like other {@link OO.ui.ButtonWidget buttons}, toggle buttons can be
2917 * configured with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators},
2918 * {@link OO.ui.mixin.TitledElement titles}, {@link OO.ui.mixin.FlaggedElement styling flags},
2919 * and {@link OO.ui.mixin.LabelElement labels}. Please see
2920 * the [OOjs UI documentation][1] on MediaWiki for more information.
2923 * // Toggle buttons in the 'off' and 'on' state.
2924 * var toggleButton1 = new OO.ui.ToggleButtonWidget( {
2925 * label: 'Toggle Button off'
2927 * var toggleButton2 = new OO.ui.ToggleButtonWidget( {
2928 * label: 'Toggle Button on',
2931 * // Append the buttons to the DOM.
2932 * $( 'body' ).append( toggleButton1.$element, toggleButton2.$element );
2934 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches#Toggle_buttons
2937 * @extends OO.ui.ToggleWidget
2938 * @mixins OO.ui.mixin.ButtonElement
2939 * @mixins OO.ui.mixin.IconElement
2940 * @mixins OO.ui.mixin.IndicatorElement
2941 * @mixins OO.ui.mixin.LabelElement
2942 * @mixins OO.ui.mixin.TitledElement
2943 * @mixins OO.ui.mixin.FlaggedElement
2944 * @mixins OO.ui.mixin.TabIndexedElement
2947 * @param {Object} [config] Configuration options
2948 * @cfg {boolean} [value=false] The toggle button’s initial on/off
2949 * state. By default, the button is in the 'off' state.
2951 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
2952 // Configuration initialization
2953 config
= config
|| {};
2955 // Parent constructor
2956 OO
.ui
.ToggleButtonWidget
.parent
.call( this, config
);
2958 // Mixin constructors
2959 OO
.ui
.mixin
.ButtonElement
.call( this, $.extend( {}, config
, { active
: this.active
} ) );
2960 OO
.ui
.mixin
.IconElement
.call( this, config
);
2961 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
2962 OO
.ui
.mixin
.LabelElement
.call( this, config
);
2963 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
2964 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
2965 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$button
} ) );
2968 this.connect( this, { click
: 'onAction' } );
2971 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
2973 .addClass( 'oo-ui-toggleButtonWidget' )
2974 .append( this.$button
);
2979 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
2980 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.ButtonElement
);
2981 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IconElement
);
2982 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IndicatorElement
);
2983 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.LabelElement
);
2984 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TitledElement
);
2985 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.FlaggedElement
);
2986 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TabIndexedElement
);
2988 /* Static Properties */
2994 OO
.ui
.ToggleButtonWidget
.static.tagName
= 'span';
2999 * Handle the button action being triggered.
3003 OO
.ui
.ToggleButtonWidget
.prototype.onAction = function () {
3004 this.setValue( !this.value
);
3010 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
3012 if ( value
!== this.value
) {
3013 // Might be called from parent constructor before ButtonElement constructor
3014 if ( this.$button
) {
3015 this.$button
.attr( 'aria-pressed', value
.toString() );
3017 this.setActive( value
);
3021 OO
.ui
.ToggleButtonWidget
.parent
.prototype.setValue
.call( this, value
);
3029 OO
.ui
.ToggleButtonWidget
.prototype.setButtonElement = function ( $button
) {
3030 if ( this.$button
) {
3031 this.$button
.removeAttr( 'aria-pressed' );
3033 OO
.ui
.mixin
.ButtonElement
.prototype.setButtonElement
.call( this, $button
);
3034 this.$button
.attr( 'aria-pressed', this.value
.toString() );
3038 * ToggleSwitches are switches that slide on and off. Their state is represented by a Boolean
3039 * value (`true` for ‘on’, and `false` otherwise, the default). The ‘off’ state is represented
3040 * visually by a slider in the leftmost position.
3043 * // Toggle switches in the 'off' and 'on' position.
3044 * var toggleSwitch1 = new OO.ui.ToggleSwitchWidget();
3045 * var toggleSwitch2 = new OO.ui.ToggleSwitchWidget( {
3049 * // Create a FieldsetLayout to layout and label switches
3050 * var fieldset = new OO.ui.FieldsetLayout( {
3051 * label: 'Toggle switches'
3053 * fieldset.addItems( [
3054 * new OO.ui.FieldLayout( toggleSwitch1, { label: 'Off', align: 'top' } ),
3055 * new OO.ui.FieldLayout( toggleSwitch2, { label: 'On', align: 'top' } )
3057 * $( 'body' ).append( fieldset.$element );
3060 * @extends OO.ui.ToggleWidget
3061 * @mixins OO.ui.mixin.TabIndexedElement
3064 * @param {Object} [config] Configuration options
3065 * @cfg {boolean} [value=false] The toggle switch’s initial on/off state.
3066 * By default, the toggle switch is in the 'off' position.
3068 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
3069 // Parent constructor
3070 OO
.ui
.ToggleSwitchWidget
.parent
.call( this, config
);
3072 // Mixin constructors
3073 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3076 this.dragging
= false;
3077 this.dragStart
= null;
3078 this.sliding
= false;
3079 this.$glow
= $( '<span>' );
3080 this.$grip
= $( '<span>' );
3084 click
: this.onClick
.bind( this ),
3085 keypress
: this.onKeyPress
.bind( this )
3089 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
3090 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
3092 .addClass( 'oo-ui-toggleSwitchWidget' )
3093 .attr( 'role', 'checkbox' )
3094 .append( this.$glow
, this.$grip
);
3099 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
3100 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3105 * Handle mouse click events.
3108 * @param {jQuery.Event} e Mouse click event
3110 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
3111 if ( !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
3112 this.setValue( !this.value
);
3118 * Handle key press events.
3121 * @param {jQuery.Event} e Key press event
3123 OO
.ui
.ToggleSwitchWidget
.prototype.onKeyPress = function ( e
) {
3124 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
3125 this.setValue( !this.value
);
3133 OO
.ui
.ToggleSwitchWidget
.prototype.setValue = function ( value
) {
3134 OO
.ui
.ToggleSwitchWidget
.parent
.prototype.setValue
.call( this, value
);
3135 this.$element
.attr( 'aria-checked', this.value
.toString() );
3140 * OutlineControlsWidget is a set of controls for an {@link OO.ui.OutlineSelectWidget outline select widget}.
3141 * Controls include moving items up and down, removing items, and adding different kinds of items.
3143 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3146 * @extends OO.ui.Widget
3147 * @mixins OO.ui.mixin.GroupElement
3148 * @mixins OO.ui.mixin.IconElement
3151 * @param {OO.ui.OutlineSelectWidget} outline Outline to control
3152 * @param {Object} [config] Configuration options
3153 * @cfg {Object} [abilities] List of abilties
3154 * @cfg {boolean} [abilities.move=true] Allow moving movable items
3155 * @cfg {boolean} [abilities.remove=true] Allow removing removable items
3157 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
3158 // Allow passing positional parameters inside the config object
3159 if ( OO
.isPlainObject( outline
) && config
=== undefined ) {
3161 outline
= config
.outline
;
3164 // Configuration initialization
3165 config
= $.extend( { icon
: 'add' }, config
);
3167 // Parent constructor
3168 OO
.ui
.OutlineControlsWidget
.parent
.call( this, config
);
3170 // Mixin constructors
3171 OO
.ui
.mixin
.GroupElement
.call( this, config
);
3172 OO
.ui
.mixin
.IconElement
.call( this, config
);
3175 this.outline
= outline
;
3176 this.$movers
= $( '<div>' );
3177 this.upButton
= new OO
.ui
.ButtonWidget( {
3180 title
: OO
.ui
.msg( 'ooui-outline-control-move-up' )
3182 this.downButton
= new OO
.ui
.ButtonWidget( {
3185 title
: OO
.ui
.msg( 'ooui-outline-control-move-down' )
3187 this.removeButton
= new OO
.ui
.ButtonWidget( {
3190 title
: OO
.ui
.msg( 'ooui-outline-control-remove' )
3192 this.abilities
= { move: true, remove
: true };
3195 outline
.connect( this, {
3196 select
: 'onOutlineChange',
3197 add
: 'onOutlineChange',
3198 remove
: 'onOutlineChange'
3200 this.upButton
.connect( this, { click
: [ 'emit', 'move', -1 ] } );
3201 this.downButton
.connect( this, { click
: [ 'emit', 'move', 1 ] } );
3202 this.removeButton
.connect( this, { click
: [ 'emit', 'remove' ] } );
3205 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
3206 this.$group
.addClass( 'oo-ui-outlineControlsWidget-items' );
3208 .addClass( 'oo-ui-outlineControlsWidget-movers' )
3209 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
3210 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
3211 this.setAbilities( config
.abilities
|| {} );
3216 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
3217 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.GroupElement
);
3218 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.IconElement
);
3224 * @param {number} places Number of places to move
3236 * @param {Object} abilities List of abilties
3237 * @param {boolean} [abilities.move] Allow moving movable items
3238 * @param {boolean} [abilities.remove] Allow removing removable items
3240 OO
.ui
.OutlineControlsWidget
.prototype.setAbilities = function ( abilities
) {
3243 for ( ability
in this.abilities
) {
3244 if ( abilities
[ ability
] !== undefined ) {
3245 this.abilities
[ ability
] = !!abilities
[ ability
];
3249 this.onOutlineChange();
3253 * Handle outline change events.
3257 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
3258 var i
, len
, firstMovable
, lastMovable
,
3259 items
= this.outline
.getItems(),
3260 selectedItem
= this.outline
.getSelectedItem(),
3261 movable
= this.abilities
.move && selectedItem
&& selectedItem
.isMovable(),
3262 removable
= this.abilities
.remove
&& selectedItem
&& selectedItem
.isRemovable();
3267 while ( ++i
< len
) {
3268 if ( items
[ i
].isMovable() ) {
3269 firstMovable
= items
[ i
];
3275 if ( items
[ i
].isMovable() ) {
3276 lastMovable
= items
[ i
];
3281 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
3282 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
3283 this.removeButton
.setDisabled( !removable
);
3287 * OutlineOptionWidget is an item in an {@link OO.ui.OutlineSelectWidget OutlineSelectWidget}.
3289 * Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}, which contain
3290 * {@link OO.ui.PageLayout page layouts}. See {@link OO.ui.BookletLayout BookletLayout}
3294 * @extends OO.ui.DecoratedOptionWidget
3297 * @param {Object} [config] Configuration options
3298 * @cfg {number} [level] Indentation level
3299 * @cfg {boolean} [movable] Allow modification from {@link OO.ui.OutlineControlsWidget outline controls}.
3301 OO
.ui
.OutlineOptionWidget
= function OoUiOutlineOptionWidget( config
) {
3302 // Configuration initialization
3303 config
= config
|| {};
3305 // Parent constructor
3306 OO
.ui
.OutlineOptionWidget
.parent
.call( this, config
);
3310 this.movable
= !!config
.movable
;
3311 this.removable
= !!config
.removable
;
3314 this.$element
.addClass( 'oo-ui-outlineOptionWidget' );
3315 this.setLevel( config
.level
);
3320 OO
.inheritClass( OO
.ui
.OutlineOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
3322 /* Static Properties */
3328 OO
.ui
.OutlineOptionWidget
.static.highlightable
= true;
3334 OO
.ui
.OutlineOptionWidget
.static.scrollIntoViewOnSelect
= true;
3339 * @property {string}
3341 OO
.ui
.OutlineOptionWidget
.static.levelClass
= 'oo-ui-outlineOptionWidget-level-';
3346 * @property {number}
3348 OO
.ui
.OutlineOptionWidget
.static.levels
= 3;
3353 * Check if item is movable.
3355 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3357 * @return {boolean} Item is movable
3359 OO
.ui
.OutlineOptionWidget
.prototype.isMovable = function () {
3360 return this.movable
;
3364 * Check if item is removable.
3366 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3368 * @return {boolean} Item is removable
3370 OO
.ui
.OutlineOptionWidget
.prototype.isRemovable = function () {
3371 return this.removable
;
3375 * Get indentation level.
3377 * @return {number} Indentation level
3379 OO
.ui
.OutlineOptionWidget
.prototype.getLevel = function () {
3386 OO
.ui
.OutlineOptionWidget
.prototype.setPressed = function ( state
) {
3387 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setPressed
.call( this, state
);
3388 if ( this.pressed
) {
3389 this.setFlags( { progressive
: true } );
3390 } else if ( !this.selected
) {
3391 this.setFlags( { progressive
: false } );
3399 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3401 * @param {boolean} movable Item is movable
3404 OO
.ui
.OutlineOptionWidget
.prototype.setMovable = function ( movable
) {
3405 this.movable
= !!movable
;
3406 this.updateThemeClasses();
3413 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3415 * @param {boolean} removable Item is removable
3418 OO
.ui
.OutlineOptionWidget
.prototype.setRemovable = function ( removable
) {
3419 this.removable
= !!removable
;
3420 this.updateThemeClasses();
3427 OO
.ui
.OutlineOptionWidget
.prototype.setSelected = function ( state
) {
3428 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3429 if ( this.selected
) {
3430 this.setFlags( { progressive
: true } );
3432 this.setFlags( { progressive
: false } );
3438 * Set indentation level.
3440 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
3443 OO
.ui
.OutlineOptionWidget
.prototype.setLevel = function ( level
) {
3444 var levels
= this.constructor.static.levels
,
3445 levelClass
= this.constructor.static.levelClass
,
3448 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
3450 if ( this.level
=== i
) {
3451 this.$element
.addClass( levelClass
+ i
);
3453 this.$element
.removeClass( levelClass
+ i
);
3456 this.updateThemeClasses();
3462 * OutlineSelectWidget is a structured list that contains {@link OO.ui.OutlineOptionWidget outline options}
3463 * A set of controls can be provided with an {@link OO.ui.OutlineControlsWidget outline controls} widget.
3465 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3468 * @extends OO.ui.SelectWidget
3469 * @mixins OO.ui.mixin.TabIndexedElement
3472 * @param {Object} [config] Configuration options
3474 OO
.ui
.OutlineSelectWidget
= function OoUiOutlineSelectWidget( config
) {
3475 // Parent constructor
3476 OO
.ui
.OutlineSelectWidget
.parent
.call( this, config
);
3478 // Mixin constructors
3479 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3483 focus
: this.bindKeyDownListener
.bind( this ),
3484 blur
: this.unbindKeyDownListener
.bind( this )
3488 this.$element
.addClass( 'oo-ui-outlineSelectWidget' );
3493 OO
.inheritClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.SelectWidget
);
3494 OO
.mixinClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3497 * ButtonOptionWidget is a special type of {@link OO.ui.mixin.ButtonElement button element} that
3498 * can be selected and configured with data. The class is
3499 * used with OO.ui.ButtonSelectWidget to create a selection of button options. Please see the
3500 * [OOjs UI documentation on MediaWiki] [1] for more information.
3502 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Button_selects_and_options
3505 * @extends OO.ui.OptionWidget
3506 * @mixins OO.ui.mixin.ButtonElement
3507 * @mixins OO.ui.mixin.IconElement
3508 * @mixins OO.ui.mixin.IndicatorElement
3509 * @mixins OO.ui.mixin.TitledElement
3512 * @param {Object} [config] Configuration options
3514 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( config
) {
3515 // Configuration initialization
3516 config
= config
|| {};
3518 // Parent constructor
3519 OO
.ui
.ButtonOptionWidget
.parent
.call( this, config
);
3521 // Mixin constructors
3522 OO
.ui
.mixin
.ButtonElement
.call( this, config
);
3523 OO
.ui
.mixin
.IconElement
.call( this, config
);
3524 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3525 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
3528 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
3529 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
3530 this.$element
.append( this.$button
);
3535 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.OptionWidget
);
3536 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.ButtonElement
);
3537 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IconElement
);
3538 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IndicatorElement
);
3539 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.TitledElement
);
3541 /* Static Properties */
3544 * Allow button mouse down events to pass through so they can be handled by the parent select widget
3549 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
3555 OO
.ui
.ButtonOptionWidget
.static.highlightable
= false;
3562 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
3563 OO
.ui
.ButtonOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3565 if ( this.constructor.static.selectable
) {
3566 this.setActive( state
);
3573 * ButtonSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains
3574 * button options and is used together with
3575 * OO.ui.ButtonOptionWidget. The ButtonSelectWidget provides an interface for
3576 * highlighting, choosing, and selecting mutually exclusive options. Please see
3577 * the [OOjs UI documentation on MediaWiki] [1] for more information.
3580 * // Example: A ButtonSelectWidget that contains three ButtonOptionWidgets
3581 * var option1 = new OO.ui.ButtonOptionWidget( {
3583 * label: 'Option 1',
3584 * title: 'Button option 1'
3587 * var option2 = new OO.ui.ButtonOptionWidget( {
3589 * label: 'Option 2',
3590 * title: 'Button option 2'
3593 * var option3 = new OO.ui.ButtonOptionWidget( {
3595 * label: 'Option 3',
3596 * title: 'Button option 3'
3599 * var buttonSelect=new OO.ui.ButtonSelectWidget( {
3600 * items: [ option1, option2, option3 ]
3602 * $( 'body' ).append( buttonSelect.$element );
3604 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
3607 * @extends OO.ui.SelectWidget
3608 * @mixins OO.ui.mixin.TabIndexedElement
3611 * @param {Object} [config] Configuration options
3613 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
3614 // Parent constructor
3615 OO
.ui
.ButtonSelectWidget
.parent
.call( this, config
);
3617 // Mixin constructors
3618 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3622 focus
: this.bindKeyDownListener
.bind( this ),
3623 blur
: this.unbindKeyDownListener
.bind( this )
3627 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
3632 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
3633 OO
.mixinClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3636 * TabOptionWidget is an item in a {@link OO.ui.TabSelectWidget TabSelectWidget}.
3638 * Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}, which contain
3639 * {@link OO.ui.TabPanelLayout tab panel layouts}. See {@link OO.ui.IndexLayout IndexLayout}
3643 * @extends OO.ui.OptionWidget
3646 * @param {Object} [config] Configuration options
3648 OO
.ui
.TabOptionWidget
= function OoUiTabOptionWidget( config
) {
3649 // Configuration initialization
3650 config
= config
|| {};
3652 // Parent constructor
3653 OO
.ui
.TabOptionWidget
.parent
.call( this, config
);
3656 this.$element
.addClass( 'oo-ui-tabOptionWidget' );
3661 OO
.inheritClass( OO
.ui
.TabOptionWidget
, OO
.ui
.OptionWidget
);
3663 /* Static Properties */
3669 OO
.ui
.TabOptionWidget
.static.highlightable
= false;
3672 * TabSelectWidget is a list that contains {@link OO.ui.TabOptionWidget tab options}
3674 * **Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}.**
3677 * @extends OO.ui.SelectWidget
3678 * @mixins OO.ui.mixin.TabIndexedElement
3681 * @param {Object} [config] Configuration options
3683 OO
.ui
.TabSelectWidget
= function OoUiTabSelectWidget( config
) {
3684 // Parent constructor
3685 OO
.ui
.TabSelectWidget
.parent
.call( this, config
);
3687 // Mixin constructors
3688 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3692 focus
: this.bindKeyDownListener
.bind( this ),
3693 blur
: this.unbindKeyDownListener
.bind( this )
3697 this.$element
.addClass( 'oo-ui-tabSelectWidget' );
3702 OO
.inheritClass( OO
.ui
.TabSelectWidget
, OO
.ui
.SelectWidget
);
3703 OO
.mixinClass( OO
.ui
.TabSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3706 * CapsuleItemWidgets are used within a {@link OO.ui.CapsuleMultiselectWidget
3707 * CapsuleMultiselectWidget} to display the selected items.
3710 * @extends OO.ui.Widget
3711 * @mixins OO.ui.mixin.ItemWidget
3712 * @mixins OO.ui.mixin.LabelElement
3713 * @mixins OO.ui.mixin.FlaggedElement
3714 * @mixins OO.ui.mixin.TabIndexedElement
3717 * @param {Object} [config] Configuration options
3719 OO
.ui
.CapsuleItemWidget
= function OoUiCapsuleItemWidget( config
) {
3720 // Configuration initialization
3721 config
= config
|| {};
3723 // Parent constructor
3724 OO
.ui
.CapsuleItemWidget
.parent
.call( this, config
);
3726 // Mixin constructors
3727 OO
.ui
.mixin
.ItemWidget
.call( this );
3728 OO
.ui
.mixin
.LabelElement
.call( this, config
);
3729 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
3730 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3733 this.closeButton
= new OO
.ui
.ButtonWidget( {
3737 } ).on( 'click', this.onCloseClick
.bind( this ) );
3739 this.on( 'disable', function ( disabled
) {
3740 this.closeButton
.setDisabled( disabled
);
3746 click
: this.onClick
.bind( this ),
3747 keydown
: this.onKeyDown
.bind( this )
3749 .addClass( 'oo-ui-capsuleItemWidget' )
3750 .append( this.$label
, this.closeButton
.$element
);
3755 OO
.inheritClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.Widget
);
3756 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.ItemWidget
);
3757 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.LabelElement
);
3758 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.FlaggedElement
);
3759 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3764 * Handle close icon clicks
3766 OO
.ui
.CapsuleItemWidget
.prototype.onCloseClick = function () {
3767 var element
= this.getElementGroup();
3769 if ( element
&& $.isFunction( element
.removeItems
) ) {
3770 element
.removeItems( [ this ] );
3776 * Handle click event for the entire capsule
3778 OO
.ui
.CapsuleItemWidget
.prototype.onClick = function () {
3779 var element
= this.getElementGroup();
3781 if ( !this.isDisabled() && element
&& $.isFunction( element
.editItem
) ) {
3782 element
.editItem( this );
3787 * Handle keyDown event for the entire capsule
3789 * @param {jQuery.Event} e Key down event
3791 OO
.ui
.CapsuleItemWidget
.prototype.onKeyDown = function ( e
) {
3792 var element
= this.getElementGroup();
3794 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
|| e
.keyCode
=== OO
.ui
.Keys
.DELETE
) {
3795 element
.removeItems( [ this ] );
3798 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ENTER
) {
3799 element
.editItem( this );
3801 } else if ( e
.keyCode
=== OO
.ui
.Keys
.LEFT
) {
3802 element
.getPreviousItem( this ).focus();
3803 } else if ( e
.keyCode
=== OO
.ui
.Keys
.RIGHT
) {
3804 element
.getNextItem( this ).focus();
3809 * Focuses the capsule
3811 OO
.ui
.CapsuleItemWidget
.prototype.focus = function () {
3812 this.$element
.focus();
3816 * CapsuleMultiselectWidgets are something like a {@link OO.ui.ComboBoxInputWidget combo box widget}
3817 * that allows for selecting multiple values.
3819 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
3822 * // Example: A CapsuleMultiselectWidget.
3823 * var capsule = new OO.ui.CapsuleMultiselectWidget( {
3824 * label: 'CapsuleMultiselectWidget',
3825 * selected: [ 'Option 1', 'Option 3' ],
3828 * new OO.ui.MenuOptionWidget( {
3830 * label: 'Option One'
3832 * new OO.ui.MenuOptionWidget( {
3834 * label: 'Option Two'
3836 * new OO.ui.MenuOptionWidget( {
3838 * label: 'Option Three'
3840 * new OO.ui.MenuOptionWidget( {
3842 * label: 'Option Four'
3844 * new OO.ui.MenuOptionWidget( {
3846 * label: 'Option Five'
3851 * $( 'body' ).append( capsule.$element );
3853 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
3856 * @extends OO.ui.Widget
3857 * @mixins OO.ui.mixin.GroupElement
3858 * @mixins OO.ui.mixin.PopupElement
3859 * @mixins OO.ui.mixin.TabIndexedElement
3860 * @mixins OO.ui.mixin.IndicatorElement
3861 * @mixins OO.ui.mixin.IconElement
3862 * @uses OO.ui.CapsuleItemWidget
3863 * @uses OO.ui.MenuSelectWidget
3866 * @param {Object} [config] Configuration options
3867 * @cfg {string} [placeholder] Placeholder text
3868 * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if not present in the menu.
3869 * @cfg {boolean} [allowDuplicates=false] Allow duplicate items to be added.
3870 * @cfg {Object} [menu] (required) Configuration options to pass to the
3871 * {@link OO.ui.MenuSelectWidget menu select widget}.
3872 * @cfg {Object} [popup] Configuration options to pass to the {@link OO.ui.PopupWidget popup widget}.
3873 * If specified, this popup will be shown instead of the menu (but the menu
3874 * will still be used for item labels and allowArbitrary=false). The widgets
3875 * in the popup should use {@link #addItemsFromData} or {@link #addItems} as necessary.
3876 * @cfg {jQuery} [$overlay=this.$element] Render the menu or popup into a separate layer.
3877 * This configuration is useful in cases where the expanded menu is larger than
3878 * its containing `<div>`. The specified overlay layer is usually on top of
3879 * the containing `<div>` and has a larger area. By default, the menu uses
3880 * relative positioning.
3881 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
3883 OO
.ui
.CapsuleMultiselectWidget
= function OoUiCapsuleMultiselectWidget( config
) {
3886 // Parent constructor
3887 OO
.ui
.CapsuleMultiselectWidget
.parent
.call( this, config
);
3889 // Configuration initialization
3890 config
= $.extend( {
3891 allowArbitrary
: false,
3892 allowDuplicates
: false,
3893 $overlay
: this.$element
3896 // Properties (must be set before mixin constructor calls)
3897 this.$handle
= $( '<div>' );
3898 this.$input
= config
.popup
? null : $( '<input>' );
3899 if ( config
.placeholder
!== undefined && config
.placeholder
!== '' ) {
3900 this.$input
.attr( 'placeholder', config
.placeholder
);
3903 // Mixin constructors
3904 OO
.ui
.mixin
.GroupElement
.call( this, config
);
3905 if ( config
.popup
) {
3906 config
.popup
= $.extend( {}, config
.popup
, {
3910 OO
.ui
.mixin
.PopupElement
.call( this, config
);
3911 $tabFocus
= $( '<span>' );
3912 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: $tabFocus
} ) );
3916 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$input
} ) );
3918 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3919 OO
.ui
.mixin
.IconElement
.call( this, config
);
3922 this.$content
= $( '<div>' );
3923 this.allowArbitrary
= config
.allowArbitrary
;
3924 this.allowDuplicates
= config
.allowDuplicates
;
3925 this.$overlay
= config
.$overlay
;
3926 this.menu
= new OO
.ui
.MenuSelectWidget( $.extend(
3929 $input
: this.$input
,
3930 $floatableContainer
: this.$element
,
3931 filterFromInput
: true,
3932 disabled
: this.isDisabled()
3940 focus
: this.focus
.bind( this )
3942 this.popup
.$element
.on( 'focusout', this.onPopupFocusOut
.bind( this ) );
3943 if ( this.popup
.$autoCloseIgnore
) {
3944 this.popup
.$autoCloseIgnore
.on( 'focusout', this.onPopupFocusOut
.bind( this ) );
3946 this.popup
.connect( this, {
3947 toggle: function ( visible
) {
3948 $tabFocus
.toggle( !visible
);
3953 focus
: this.onInputFocus
.bind( this ),
3954 blur
: this.onInputBlur
.bind( this ),
3955 'propertychange change click mouseup keydown keyup input cut paste select focus':
3956 OO
.ui
.debounce( this.updateInputSize
.bind( this ) ),
3957 keydown
: this.onKeyDown
.bind( this ),
3958 keypress
: this.onKeyPress
.bind( this )
3961 this.menu
.connect( this, {
3962 choose
: 'onMenuChoose',
3963 toggle
: 'onMenuToggle',
3964 add
: 'onMenuItemsChange',
3965 remove
: 'onMenuItemsChange'
3968 mousedown
: this.onMouseDown
.bind( this )
3972 if ( this.$input
) {
3973 this.$input
.prop( 'disabled', this.isDisabled() );
3976 'aria-owns': this.menu
.getElementId(),
3977 'aria-autocomplete': 'list'
3980 if ( config
.data
) {
3981 this.setItemsFromData( config
.data
);
3983 this.$content
.addClass( 'oo-ui-capsuleMultiselectWidget-content' )
3984 .append( this.$group
);
3985 this.$group
.addClass( 'oo-ui-capsuleMultiselectWidget-group' );
3986 this.$handle
.addClass( 'oo-ui-capsuleMultiselectWidget-handle' )
3987 .append( this.$indicator
, this.$icon
, this.$content
);
3988 this.$element
.addClass( 'oo-ui-capsuleMultiselectWidget' )
3989 .append( this.$handle
);
3991 this.popup
.$element
.addClass( 'oo-ui-capsuleMultiselectWidget-popup' );
3992 this.$content
.append( $tabFocus
);
3993 this.$overlay
.append( this.popup
.$element
);
3995 this.$content
.append( this.$input
);
3996 this.$overlay
.append( this.menu
.$element
);
3999 $tabFocus
.addClass( 'oo-ui-capsuleMultiselectWidget-focusTrap' );
4002 // Input size needs to be calculated after everything else is rendered
4003 setTimeout( function () {
4004 if ( this.$input
) {
4005 this.updateInputSize();
4009 this.onMenuItemsChange();
4014 OO
.inheritClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.Widget
);
4015 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.GroupElement
);
4016 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.PopupElement
);
4017 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
4018 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.IndicatorElement
);
4019 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.IconElement
);
4021 /* Static Properties */
4023 OO
.ui
.CapsuleMultiselectWidget
.static.supportsSimpleLabel
= true;
4030 * A change event is emitted when the set of selected items changes.
4032 * @param {Mixed[]} datas Data of the now-selected items
4038 * A resize event is emitted when the widget's dimensions change to accomodate newly added items or
4039 * current user input.
4045 * Construct a OO.ui.CapsuleItemWidget (or a subclass thereof) from given label and data.
4046 * May return `null` if the given label and data are not valid.
4049 * @param {Mixed} data Custom data of any type.
4050 * @param {string} label The label text.
4051 * @return {OO.ui.CapsuleItemWidget|null}
4053 OO
.ui
.CapsuleMultiselectWidget
.prototype.createItemWidget = function ( data
, label
) {
4054 if ( label
=== '' ) {
4057 return new OO
.ui
.CapsuleItemWidget( { data
: data
, label
: label
} );
4061 * Get the widget's input's id, or generate one, if it has an input.
4065 OO
.ui
.CapsuleMultiselectWidget
.prototype.getInputId = function () {
4067 if ( !this.$input
) {
4071 id
= this.$input
.attr( 'id' );
4072 if ( id
=== undefined ) {
4073 id
= OO
.ui
.generateElementId();
4074 this.$input
.attr( 'id', id
);
4081 * Get the data of the items in the capsule
4085 OO
.ui
.CapsuleMultiselectWidget
.prototype.getItemsData = function () {
4086 return this.getItems().map( function ( item
) {
4092 * Set the items in the capsule by providing data
4095 * @param {Mixed[]} datas
4096 * @return {OO.ui.CapsuleMultiselectWidget}
4098 OO
.ui
.CapsuleMultiselectWidget
.prototype.setItemsFromData = function ( datas
) {
4101 items
= this.getItems();
4103 $.each( datas
, function ( i
, data
) {
4105 item
= menu
.getItemFromData( data
);
4109 } else if ( widget
.allowArbitrary
) {
4110 label
= String( data
);
4116 for ( j
= 0; j
< items
.length
; j
++ ) {
4117 if ( items
[ j
].data
=== data
&& items
[ j
].label
=== label
) {
4119 items
.splice( j
, 1 );
4124 item
= widget
.createItemWidget( data
, label
);
4127 widget
.addItems( [ item
], i
);
4131 if ( items
.length
) {
4132 widget
.removeItems( items
);
4139 * Add items to the capsule by providing their data
4142 * @param {Mixed[]} datas
4143 * @return {OO.ui.CapsuleMultiselectWidget}
4145 OO
.ui
.CapsuleMultiselectWidget
.prototype.addItemsFromData = function ( datas
) {
4150 $.each( datas
, function ( i
, data
) {
4153 if ( !widget
.getItemFromData( data
) || widget
.allowDuplicates
) {
4154 item
= menu
.getItemFromData( data
);
4156 item
= widget
.createItemWidget( data
, item
.label
);
4157 } else if ( widget
.allowArbitrary
) {
4158 item
= widget
.createItemWidget( data
, String( data
) );
4166 if ( items
.length
) {
4167 this.addItems( items
);
4174 * Add items to the capsule by providing a label
4176 * @param {string} label
4177 * @return {boolean} Whether the item was added or not
4179 OO
.ui
.CapsuleMultiselectWidget
.prototype.addItemFromLabel = function ( label
) {
4181 item
= this.menu
.getItemFromLabel( label
, true );
4183 this.addItemsFromData( [ item
.data
] );
4185 } else if ( this.allowArbitrary
) {
4186 items
= this.getItems();
4187 this.addItemsFromData( [ label
] );
4188 return !OO
.compare( this.getItems(), items
);
4194 * Remove items by data
4197 * @param {Mixed[]} datas
4198 * @return {OO.ui.CapsuleMultiselectWidget}
4200 OO
.ui
.CapsuleMultiselectWidget
.prototype.removeItemsFromData = function ( datas
) {
4204 $.each( datas
, function ( i
, data
) {
4205 var item
= widget
.getItemFromData( data
);
4211 if ( items
.length
) {
4212 this.removeItems( items
);
4221 OO
.ui
.CapsuleMultiselectWidget
.prototype.addItems = function ( items
) {
4223 oldItems
= this.items
.slice();
4225 OO
.ui
.mixin
.GroupElement
.prototype.addItems
.call( this, items
);
4227 if ( this.items
.length
!== oldItems
.length
) {
4231 for ( i
= 0, l
= oldItems
.length
; same
&& i
< l
; i
++ ) {
4232 same
= same
&& this.items
[ i
] === oldItems
[ i
];
4236 this.emit( 'change', this.getItemsData() );
4237 this.updateInputSize();
4244 * Removes the item from the list and copies its label to `this.$input`.
4246 * @param {Object} item
4248 OO
.ui
.CapsuleMultiselectWidget
.prototype.editItem = function ( item
) {
4249 this.addItemFromLabel( this.$input
.val() );
4251 this.$input
.val( item
.label
);
4252 this.updateInputSize();
4254 this.menu
.updateItemVisibility(); // Hack, we shouldn't be calling this method directly
4255 this.removeItems( [ item
] );
4261 OO
.ui
.CapsuleMultiselectWidget
.prototype.removeItems = function ( items
) {
4263 oldItems
= this.items
.slice();
4265 OO
.ui
.mixin
.GroupElement
.prototype.removeItems
.call( this, items
);
4267 if ( this.items
.length
!== oldItems
.length
) {
4271 for ( i
= 0, l
= oldItems
.length
; same
&& i
< l
; i
++ ) {
4272 same
= same
&& this.items
[ i
] === oldItems
[ i
];
4276 this.emit( 'change', this.getItemsData() );
4277 this.updateInputSize();
4286 OO
.ui
.CapsuleMultiselectWidget
.prototype.clearItems = function () {
4287 if ( this.items
.length
) {
4288 OO
.ui
.mixin
.GroupElement
.prototype.clearItems
.call( this );
4289 this.emit( 'change', this.getItemsData() );
4290 this.updateInputSize();
4296 * Given an item, returns the item after it. If its the last item,
4297 * returns `this.$input`. If no item is passed, returns the very first
4300 * @param {OO.ui.CapsuleItemWidget} [item]
4301 * @return {OO.ui.CapsuleItemWidget|jQuery|boolean}
4303 OO
.ui
.CapsuleMultiselectWidget
.prototype.getNextItem = function ( item
) {
4306 if ( item
=== undefined ) {
4307 return this.items
[ 0 ];
4310 itemIndex
= this.items
.indexOf( item
);
4311 if ( itemIndex
< 0 ) { // Item not in list
4313 } else if ( itemIndex
=== this.items
.length
- 1 ) { // Last item
4316 return this.items
[ itemIndex
+ 1 ];
4321 * Given an item, returns the item before it. If its the first item,
4322 * returns `this.$input`. If no item is passed, returns the very last
4325 * @param {OO.ui.CapsuleItemWidget} [item]
4326 * @return {OO.ui.CapsuleItemWidget|jQuery|boolean}
4328 OO
.ui
.CapsuleMultiselectWidget
.prototype.getPreviousItem = function ( item
) {
4331 if ( item
=== undefined ) {
4332 return this.items
[ this.items
.length
- 1 ];
4335 itemIndex
= this.items
.indexOf( item
);
4336 if ( itemIndex
< 0 ) { // Item not in list
4338 } else if ( itemIndex
=== 0 ) { // First item
4341 return this.items
[ itemIndex
- 1 ];
4346 * Get the capsule widget's menu.
4348 * @return {OO.ui.MenuSelectWidget} Menu widget
4350 OO
.ui
.CapsuleMultiselectWidget
.prototype.getMenu = function () {
4355 * Handle focus events
4358 * @param {jQuery.Event} event
4360 OO
.ui
.CapsuleMultiselectWidget
.prototype.onInputFocus = function () {
4361 if ( !this.isDisabled() ) {
4362 this.menu
.toggle( true );
4367 * Handle blur events
4370 * @param {jQuery.Event} event
4372 OO
.ui
.CapsuleMultiselectWidget
.prototype.onInputBlur = function () {
4373 this.addItemFromLabel( this.$input
.val() );
4378 * Handles popup focus out events.
4381 * @param {jQuery.Event} e Focus out event
4383 OO
.ui
.CapsuleMultiselectWidget
.prototype.onPopupFocusOut = function () {
4384 var widget
= this.popup
;
4386 setTimeout( function () {
4388 widget
.isVisible() &&
4389 !OO
.ui
.contains( widget
.$element
.add( widget
.$autoCloseIgnore
).get(), document
.activeElement
, true )
4391 widget
.toggle( false );
4397 * Handle mouse down events.
4400 * @param {jQuery.Event} e Mouse down event
4402 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMouseDown = function ( e
) {
4403 if ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
4407 this.updateInputSize();
4412 * Handle key press events.
4415 * @param {jQuery.Event} e Key press event
4417 OO
.ui
.CapsuleMultiselectWidget
.prototype.onKeyPress = function ( e
) {
4418 if ( !this.isDisabled() ) {
4419 if ( e
.which
=== OO
.ui
.Keys
.ESCAPE
) {
4424 if ( !this.popup
) {
4425 this.menu
.toggle( true );
4426 if ( e
.which
=== OO
.ui
.Keys
.ENTER
) {
4427 if ( this.addItemFromLabel( this.$input
.val() ) ) {
4433 // Make sure the input gets resized.
4434 setTimeout( this.updateInputSize
.bind( this ), 0 );
4440 * Handle key down events.
4443 * @param {jQuery.Event} e Key down event
4445 OO
.ui
.CapsuleMultiselectWidget
.prototype.onKeyDown = function ( e
) {
4447 !this.isDisabled() &&
4448 this.$input
.val() === '' &&
4451 // 'keypress' event is not triggered for Backspace
4452 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
) {
4453 if ( e
.metaKey
|| e
.ctrlKey
) {
4454 this.removeItems( this.items
.slice( -1 ) );
4456 this.editItem( this.items
[ this.items
.length
- 1 ] );
4459 } else if ( e
.keyCode
=== OO
.ui
.Keys
.LEFT
) {
4460 this.getPreviousItem().focus();
4461 } else if ( e
.keyCode
=== OO
.ui
.Keys
.RIGHT
) {
4462 this.getNextItem().focus();
4468 * Update the dimensions of the text input field to encompass all available area.
4471 * @param {jQuery.Event} e Event of some sort
4473 OO
.ui
.CapsuleMultiselectWidget
.prototype.updateInputSize = function () {
4474 var $lastItem
, direction
, contentWidth
, currentWidth
, bestWidth
;
4475 if ( this.$input
&& !this.isDisabled() ) {
4476 this.$input
.css( 'width', '1em' );
4477 $lastItem
= this.$group
.children().last();
4478 direction
= OO
.ui
.Element
.static.getDir( this.$handle
);
4480 // Get the width of the input with the placeholder text as
4481 // the value and save it so that we don't keep recalculating
4483 this.contentWidthWithPlaceholder
=== undefined &&
4484 this.$input
.val() === '' &&
4485 this.$input
.attr( 'placeholder' ) !== undefined
4487 this.$input
.val( this.$input
.attr( 'placeholder' ) );
4488 this.contentWidthWithPlaceholder
= this.$input
[ 0 ].scrollWidth
;
4489 this.$input
.val( '' );
4493 // Always keep the input wide enough for the placeholder text
4494 contentWidth
= Math
.max(
4495 this.$input
[ 0 ].scrollWidth
,
4496 // undefined arguments in Math.max lead to NaN
4497 ( this.contentWidthWithPlaceholder
=== undefined ) ?
4498 0 : this.contentWidthWithPlaceholder
4500 currentWidth
= this.$input
.width();
4502 if ( contentWidth
< currentWidth
) {
4503 this.updateIfHeightChanged();
4504 // All is fine, don't perform expensive calculations
4508 if ( $lastItem
.length
=== 0 ) {
4509 bestWidth
= this.$content
.innerWidth();
4511 bestWidth
= direction
=== 'ltr' ?
4512 this.$content
.innerWidth() - $lastItem
.position().left
- $lastItem
.outerWidth() :
4513 $lastItem
.position().left
;
4516 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
4517 // pixels this is off by are coming from.
4519 if ( contentWidth
> bestWidth
) {
4520 // This will result in the input getting shifted to the next line
4521 bestWidth
= this.$content
.innerWidth() - 10;
4523 this.$input
.width( Math
.floor( bestWidth
) );
4524 this.updateIfHeightChanged();
4526 this.updateIfHeightChanged();
4531 * Determine if widget height changed, and if so, update menu position and emit 'resize' event.
4535 OO
.ui
.CapsuleMultiselectWidget
.prototype.updateIfHeightChanged = function () {
4536 var height
= this.$element
.height();
4537 if ( height
!== this.height
) {
4538 this.height
= height
;
4539 this.menu
.position();
4541 this.popup
.updateDimensions();
4543 this.emit( 'resize' );
4548 * Handle menu choose events.
4551 * @param {OO.ui.OptionWidget} item Chosen item
4553 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMenuChoose = function ( item
) {
4554 if ( item
&& item
.isVisible() ) {
4555 this.addItemsFromData( [ item
.getData() ] );
4561 * Handle menu toggle events.
4564 * @param {boolean} isVisible Menu toggle event
4566 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
4567 this.$element
.toggleClass( 'oo-ui-capsuleMultiselectWidget-open', isVisible
);
4571 * Handle menu item change events.
4575 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMenuItemsChange = function () {
4576 this.setItemsFromData( this.getItemsData() );
4577 this.$element
.toggleClass( 'oo-ui-capsuleMultiselectWidget-empty', this.menu
.isEmpty() );
4581 * Clear the input field
4585 OO
.ui
.CapsuleMultiselectWidget
.prototype.clearInput = function () {
4586 if ( this.$input
) {
4587 this.$input
.val( '' );
4588 this.updateInputSize();
4591 this.popup
.toggle( false );
4593 this.menu
.toggle( false );
4594 this.menu
.selectItem();
4595 this.menu
.highlightItem();
4601 OO
.ui
.CapsuleMultiselectWidget
.prototype.setDisabled = function ( disabled
) {
4605 OO
.ui
.CapsuleMultiselectWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
4607 if ( this.$input
) {
4608 this.$input
.prop( 'disabled', this.isDisabled() );
4611 this.menu
.setDisabled( this.isDisabled() );
4614 this.popup
.setDisabled( this.isDisabled() );
4618 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
4619 this.items
[ i
].updateDisabled();
4630 * @return {OO.ui.CapsuleMultiselectWidget}
4632 OO
.ui
.CapsuleMultiselectWidget
.prototype.focus = function () {
4633 if ( !this.isDisabled() ) {
4635 this.popup
.setSize( this.$handle
.outerWidth() );
4636 this.popup
.toggle( true );
4637 OO
.ui
.findFocusable( this.popup
.$element
).focus();
4639 this.updateInputSize();
4640 this.menu
.toggle( true );
4641 this.$input
.focus();
4648 * TagItemWidgets are used within a {@link OO.ui.TagMultiselectWidget
4649 * TagMultiselectWidget} to display the selected items.
4652 * @extends OO.ui.Widget
4653 * @mixins OO.ui.mixin.ItemWidget
4654 * @mixins OO.ui.mixin.LabelElement
4655 * @mixins OO.ui.mixin.FlaggedElement
4656 * @mixins OO.ui.mixin.TabIndexedElement
4657 * @mixins OO.ui.mixin.DraggableElement
4660 * @param {Object} [config] Configuration object
4661 * @cfg {boolean} [valid=true] Item is valid
4663 OO
.ui
.TagItemWidget
= function OoUiTagItemWidget( config
) {
4664 config
= config
|| {};
4666 // Parent constructor
4667 OO
.ui
.TagItemWidget
.parent
.call( this, config
);
4669 // Mixin constructors
4670 OO
.ui
.mixin
.ItemWidget
.call( this );
4671 OO
.ui
.mixin
.LabelElement
.call( this, config
);
4672 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
4673 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
4674 OO
.ui
.mixin
.DraggableElement
.call( this, config
);
4676 this.valid
= config
.valid
=== undefined ? true : !!config
.valid
;
4678 this.closeButton
= new OO
.ui
.ButtonWidget( {
4683 this.closeButton
.setDisabled( this.isDisabled() );
4687 .connect( this, { click
: 'remove' } );
4689 .on( 'click', this.select
.bind( this ) )
4690 .on( 'keydown', this.onKeyDown
.bind( this ) )
4691 // Prevent propagation of mousedown; the tag item "lives" in the
4692 // clickable area of the TagMultiselectWidget, which listens to
4693 // mousedown to open the menu or popup. We want to prevent that
4694 // for clicks specifically on the tag itself, so the actions taken
4695 // are more deliberate. When the tag is clicked, it will emit the
4696 // selection event (similar to how #OO.ui.MultioptionWidget emits 'change')
4697 // and can be handled separately.
4698 .on( 'mousedown', function ( e
) { e
.stopPropagation(); } );
4702 .addClass( 'oo-ui-tagItemWidget' )
4703 .append( this.$label
, this.closeButton
.$element
);
4706 /* Initialization */
4708 OO
.inheritClass( OO
.ui
.TagItemWidget
, OO
.ui
.Widget
);
4709 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.ItemWidget
);
4710 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.LabelElement
);
4711 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.FlaggedElement
);
4712 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.TabIndexedElement
);
4713 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.DraggableElement
);
4720 * A remove action was performed on the item
4725 * @param {string} direction Direction of the movement, forward or backwards
4727 * A navigate action was performed on the item
4733 * The tag widget was selected. This can occur when the widget
4734 * is either clicked or enter was pressed on it.
4739 * @param {boolean} isValid Item is valid
4741 * Item validity has changed
4749 OO
.ui
.TagItemWidget
.prototype.setDisabled = function ( state
) {
4751 OO
.ui
.TagItemWidget
.parent
.prototype.setDisabled
.call( this, state
);
4753 if ( this.closeButton
) {
4754 this.closeButton
.setDisabled( state
);
4760 * Handle removal of the item
4762 * This is mainly for extensibility concerns, so other children
4763 * of this class can change the behavior if they need to. This
4764 * is called by both clicking the 'remove' button but also
4765 * on keypress, which is harder to override if needed.
4769 OO
.ui
.TagItemWidget
.prototype.remove = function () {
4770 if ( !this.isDisabled() ) {
4771 this.emit( 'remove' );
4776 * Handle a keydown event on the widget
4780 * @param {jQuery.Event} e Key down event
4781 * @return {boolean|undefined} false to stop the operation
4783 OO
.ui
.TagItemWidget
.prototype.onKeyDown = function ( e
) {
4786 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
|| e
.keyCode
=== OO
.ui
.Keys
.DELETE
) {
4789 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ENTER
) {
4793 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
4794 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
4796 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
4810 e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
4811 movement
.left
: movement
.right
4817 * Focuses the capsule
4819 OO
.ui
.TagItemWidget
.prototype.focus = function () {
4820 if ( !this.isDisabled() ) {
4821 this.$element
.focus();
4830 OO
.ui
.TagItemWidget
.prototype.select = function () {
4831 if ( !this.isDisabled() ) {
4832 this.emit( 'select' );
4837 * Set the valid state of this item
4839 * @param {boolean} [valid] Item is valid
4842 OO
.ui
.TagItemWidget
.prototype.toggleValid = function ( valid
) {
4843 valid
= valid
=== undefined ? !this.valid
: !!valid
;
4845 if ( this.valid
!== valid
) {
4848 this.setFlags( { invalid
: !this.valid
} );
4850 this.emit( 'valid', this.valid
);
4855 * Check whether the item is valid
4857 * @return {boolean} Item is valid
4859 OO
.ui
.TagItemWidget
.prototype.isValid = function () {
4864 * A basic tag multiselect widget, similar in concept to {@link OO.ui.ComboBoxInputWidget combo box widget}
4865 * that allows the user to add multiple values that are displayed in a tag area.
4867 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
4869 * This widget is a base widget; see {@link OO.ui.MenuTagMultiselectWidget MenuTagMultiselectWidget} and
4870 * {@link OO.ui.PopupTagMultiselectWidget PopupTagMultiselectWidget} for the implementations that use
4871 * a menu and a popup respectively.
4874 * // Example: A basic TagMultiselectWidget.
4875 * var widget = new OO.ui.TagMultiselectWidget( {
4876 * inputPosition: 'outline',
4877 * allowedValues: [ 'Option 1', 'Option 2', 'Option 3' ],
4878 * selected: [ 'Option 1' ]
4880 * $( 'body' ).append( widget.$element );
4882 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
4885 * @extends OO.ui.Widget
4886 * @mixins OO.ui.mixin.GroupWidget
4887 * @mixins OO.ui.mixin.DraggableGroupElement
4888 * @mixins OO.ui.mixin.IndicatorElement
4889 * @mixins OO.ui.mixin.IconElement
4890 * @mixins OO.ui.mixin.TabIndexedElement
4891 * @mixins OO.ui.mixin.FlaggedElement
4894 * @param {Object} config Configuration object
4895 * @cfg {Object} [input] Configuration options for the input widget
4896 * @cfg {OO.ui.InputWidget} [inputWidget] An optional input widget. If given, it will
4897 * replace the input widget used in the TagMultiselectWidget. If not given,
4898 * TagMultiselectWidget creates its own.
4899 * @cfg {boolean} [inputPosition='inline'] Position of the input. Options are:
4900 * - inline: The input is invisible, but exists inside the tag list, so
4901 * the user types into the tag groups to add tags.
4902 * - outline: The input is underneath the tag area.
4903 * - none: No input supplied
4904 * @cfg {boolean} [allowEditTags=true] Allow editing of the tags by clicking them
4905 * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if
4906 * not present in the menu.
4907 * @cfg {Object[]} [allowedValues] An array representing the allowed items
4909 * @cfg {boolean} [allowDuplicates=false] Allow duplicate items to be added
4910 * @cfg {boolean} [allowDisplayInvalidTags=false] Allow the display of
4911 * invalid tags. These tags will display with an invalid state, and
4912 * the widget as a whole will have an invalid state if any invalid tags
4914 * @cfg {boolean} [allowReordering=true] Allow reordering of the items
4915 * @cfg {Object[]|String[]} [selected] A set of selected tags. If given,
4916 * these will appear in the tag list on initialization, as long as they
4917 * pass the validity tests.
4919 OO
.ui
.TagMultiselectWidget
= function OoUiTagMultiselectWidget( config
) {
4921 rAF
= window
.requestAnimationFrame
|| setTimeout
,
4923 $tabFocus
= $( '<span>' )
4924 .addClass( 'oo-ui-tagMultiselectWidget-focusTrap' );
4926 config
= config
|| {};
4928 // Parent constructor
4929 OO
.ui
.TagMultiselectWidget
.parent
.call( this, config
);
4931 // Mixin constructors
4932 OO
.ui
.mixin
.GroupWidget
.call( this, config
);
4933 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
4934 OO
.ui
.mixin
.IconElement
.call( this, config
);
4935 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
4936 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
4937 OO
.ui
.mixin
.DraggableGroupElement
.call( this, config
);
4939 this.toggleDraggable(
4940 config
.allowReordering
=== undefined ?
4941 true : !!config
.allowReordering
4944 this.inputPosition
= this.constructor.static.allowedInputPositions
.indexOf( config
.inputPosition
) > -1 ?
4945 config
.inputPosition
: 'inline';
4946 this.allowEditTags
= config
.allowEditTags
=== undefined ? true : !!config
.allowEditTags
;
4947 this.allowArbitrary
= !!config
.allowArbitrary
;
4948 this.allowDuplicates
= !!config
.allowDuplicates
;
4949 this.allowedValues
= config
.allowedValues
|| [];
4950 this.allowDisplayInvalidTags
= config
.allowDisplayInvalidTags
;
4951 this.hasInput
= this.inputPosition
!== 'none';
4955 this.$content
= $( '<div>' )
4956 .addClass( 'oo-ui-tagMultiselectWidget-content' );
4957 this.$handle
= $( '<div>' )
4958 .addClass( 'oo-ui-tagMultiselectWidget-handle' )
4965 .addClass( 'oo-ui-tagMultiselectWidget-group' )
4971 remove
: 'itemRemove',
4972 navigate
: 'itemNavigate',
4973 select
: 'itemSelect'
4975 this.connect( this, {
4976 itemRemove
: 'onTagRemove',
4977 itemSelect
: 'onTagSelect',
4978 itemNavigate
: 'onTagNavigate',
4979 change
: 'onChangeTags'
4982 mousedown
: this.onMouseDown
.bind( this )
4987 .addClass( 'oo-ui-tagMultiselectWidget' )
4988 .append( this.$handle
);
4990 if ( this.hasInput
) {
4991 if ( config
.inputWidget
) {
4992 this.input
= config
.inputWidget
;
4994 this.input
= new OO
.ui
.TextInputWidget( $.extend( {
4995 placeholder
: config
.placeholder
,
4996 classes
: [ 'oo-ui-tagMultiselectWidget-input' ]
4997 }, config
.input
) );
4999 this.input
.setDisabled( this.isDisabled() );
5002 focus
: this.onInputFocus
.bind( this ),
5003 blur
: this.onInputBlur
.bind( this ),
5004 'propertychange change click mouseup keydown keyup input cut paste select focus':
5005 OO
.ui
.debounce( this.updateInputSize
.bind( this ) ),
5006 keydown
: this.onInputKeyDown
.bind( this ),
5007 keypress
: this.onInputKeyPress
.bind( this )
5010 this.input
.$input
.on( inputEvents
);
5012 if ( this.inputPosition
=== 'outline' ) {
5013 // Override max-height for the input widget
5014 // in the case the widget is outline so it can
5015 // stretch all the way if the widet is wide
5016 this.input
.$element
.css( 'max-width', 'inherit' );
5018 .addClass( 'oo-ui-tagMultiselectWidget-outlined' )
5019 .append( this.input
.$element
);
5021 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-inlined' );
5022 // HACK: When the widget is using 'inline' input, the
5023 // behavior needs to only use the $input itself
5024 // so we style and size it accordingly (otherwise
5025 // the styling and sizing can get very convoluted
5026 // when the wrapping divs and other elements)
5027 // We are taking advantage of still being able to
5028 // call the widget itself for operations like
5029 // .getValue() and setDisabled() and .focus() but
5030 // having only the $input attached to the DOM
5031 this.$content
.append( this.input
.$input
);
5034 this.$content
.append( $tabFocus
);
5037 this.setTabIndexedElement(
5043 if ( config
.selected
) {
5044 this.setValue( config
.selected
);
5047 // HACK: Input size needs to be calculated after everything
5050 if ( widget
.hasInput
) {
5051 widget
.updateInputSize();
5056 /* Initialization */
5058 OO
.inheritClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.Widget
);
5059 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.GroupWidget
);
5060 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.DraggableGroupElement
);
5061 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IndicatorElement
);
5062 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IconElement
);
5063 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
5064 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.FlaggedElement
);
5066 /* Static properties */
5069 * Allowed input positions.
5070 * - inline: The input is inside the tag list
5071 * - outline: The input is under the tag list
5072 * - none: There is no input
5076 OO
.ui
.TagMultiselectWidget
.static.allowedInputPositions
= [ 'inline', 'outline', 'none' ];
5081 * Handle mouse down events.
5084 * @param {jQuery.Event} e Mouse down event
5085 * @return {boolean} False to prevent defaults
5087 OO
.ui
.TagMultiselectWidget
.prototype.onMouseDown = function ( e
) {
5088 if ( !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
5095 * Handle key press events.
5098 * @param {jQuery.Event} e Key press event
5099 * @return {boolean} Whether to prevent defaults
5101 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyPress = function ( e
) {
5103 withMetaKey
= e
.metaKey
|| e
.ctrlKey
;
5105 if ( !this.isDisabled() ) {
5106 if ( e
.which
=== OO
.ui
.Keys
.ENTER
) {
5107 stopOrContinue
= this.doInputEnter( e
, withMetaKey
);
5110 // Make sure the input gets resized.
5111 setTimeout( this.updateInputSize
.bind( this ), 0 );
5112 return stopOrContinue
;
5117 * Handle key down events.
5120 * @param {jQuery.Event} e Key down event
5123 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyDown = function ( e
) {
5124 var movement
, direction
,
5125 withMetaKey
= e
.metaKey
|| e
.ctrlKey
;
5127 if ( !this.isDisabled() ) {
5128 // 'keypress' event is not triggered for Backspace
5129 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
) {
5130 return this.doInputBackspace( e
, withMetaKey
);
5131 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ESCAPE
) {
5132 return this.doInputEscape( e
);
5134 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
5135 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
5137 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
5148 direction
= e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
5149 movement
.left
: movement
.right
;
5151 return this.doInputArrow( e
, direction
, withMetaKey
);
5157 * Respond to input focus event
5159 OO
.ui
.TagMultiselectWidget
.prototype.onInputFocus = function () {
5160 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-focus' );
5164 * Respond to input blur event
5166 OO
.ui
.TagMultiselectWidget
.prototype.onInputBlur = function () {
5167 this.$element
.removeClass( 'oo-ui-tagMultiselectWidget-focus' );
5171 * Perform an action after the enter key on the input
5173 * @param {jQuery.Event} e Event data
5174 * @param {boolean} [withMetaKey] Whether this key was pressed with
5175 * a meta key like 'ctrl'
5176 * @return {boolean} Whether to prevent defaults
5178 OO
.ui
.TagMultiselectWidget
.prototype.doInputEnter = function () {
5179 this.addTagFromInput();
5184 * Perform an action responding to the enter key on the input
5186 * @param {jQuery.Event} e Event data
5187 * @param {boolean} [withMetaKey] Whether this key was pressed with
5188 * a meta key like 'ctrl'
5189 * @return {boolean} Whether to prevent defaults
5191 OO
.ui
.TagMultiselectWidget
.prototype.doInputBackspace = function () {
5195 this.inputPosition
=== 'inline' &&
5196 this.input
.getValue() === '' &&
5199 // Delete the last item
5200 items
= this.getItems();
5201 item
= items
[ items
.length
- 1 ];
5202 this.input
.setValue( item
.getData() );
5203 this.removeItems( [ item
] );
5210 * Perform an action after the escape key on the input
5212 * @param {jQuery.Event} e Event data
5214 OO
.ui
.TagMultiselectWidget
.prototype.doInputEscape = function () {
5219 * Perform an action after the arrow key on the input, select the previous
5220 * or next item from the input.
5221 * See #getPreviousItem and #getNextItem
5223 * @param {jQuery.Event} e Event data
5224 * @param {string} direction Direction of the movement; forwards or backwards
5225 * @param {boolean} [withMetaKey] Whether this key was pressed with
5226 * a meta key like 'ctrl'
5228 OO
.ui
.TagMultiselectWidget
.prototype.doInputArrow = function ( e
, direction
) {
5230 this.inputPosition
=== 'inline' &&
5233 if ( direction
=== 'backwards' ) {
5234 // Get previous item
5235 this.getPreviousItem().focus();
5238 this.getNextItem().focus();
5244 * Respond to item select event
5246 * @param {OO.ui.TagItemWidget} item Selected item
5248 OO
.ui
.TagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
5249 if ( this.hasInput
&& this.allowEditTags
) {
5250 if ( this.input
.getValue() ) {
5251 this.addTagFromInput();
5253 // 1. Get the label of the tag into the input
5254 this.input
.setValue( item
.getData() );
5255 // 2. Remove the tag
5256 this.removeItems( [ item
] );
5257 // 3. Focus the input
5263 * Respond to change event, where items were added, removed, or cleared.
5265 OO
.ui
.TagMultiselectWidget
.prototype.onChangeTags = function () {
5266 this.toggleValid( this.checkValidity() );
5267 if ( this.hasInput
) {
5268 this.updateInputSize();
5270 this.updateIfHeightChanged();
5276 OO
.ui
.TagMultiselectWidget
.prototype.setDisabled = function ( isDisabled
) {
5278 OO
.ui
.TagMultiselectWidget
.parent
.prototype.setDisabled
.call( this, isDisabled
);
5280 if ( this.hasInput
&& this.input
) {
5281 this.input
.setDisabled( !!isDisabled
);
5285 this.getItems().forEach( function ( item
) {
5286 item
.setDisabled( !!isDisabled
);
5292 * Respond to tag remove event
5293 * @param {OO.ui.TagItemWidget} item Removed tag
5295 OO
.ui
.TagMultiselectWidget
.prototype.onTagRemove = function ( item
) {
5296 this.removeTagByData( item
.getData() );
5300 * Respond to navigate event on the tag
5302 * @param {OO.ui.TagItemWidget} item Removed tag
5303 * @param {string} direction Direction of movement; 'forwards' or 'backwards'
5305 OO
.ui
.TagMultiselectWidget
.prototype.onTagNavigate = function ( item
, direction
) {
5306 if ( direction
=== 'forwards' ) {
5307 this.getNextItem( item
).focus();
5309 this.getPreviousItem( item
).focus();
5314 * Add tag from input value
5316 OO
.ui
.TagMultiselectWidget
.prototype.addTagFromInput = function () {
5317 var val
= this.input
.getValue(),
5318 isValid
= this.isAllowedData( val
);
5324 if ( isValid
|| this.allowDisplayInvalidTags
) {
5334 OO
.ui
.TagMultiselectWidget
.prototype.clearInput = function () {
5335 this.input
.setValue( '' );
5339 * Check whether the given value is a duplicate of an existing
5340 * tag already in the list.
5342 * @param {string|Object} data Requested value
5343 * @return {boolean} Value is duplicate
5345 OO
.ui
.TagMultiselectWidget
.prototype.isDuplicateData = function ( data
) {
5346 return !!this.getItemFromData( data
);
5350 * Check whether a given value is allowed to be added
5352 * @param {string|Object} data Requested value
5353 * @return {boolean} Value is allowed
5355 OO
.ui
.TagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
5356 if ( this.allowArbitrary
) {
5361 !this.allowDuplicates
&&
5362 this.isDuplicateData( data
)
5367 // Check with allowed values
5369 this.getAllowedValues().some( function ( value
) {
5370 return data
=== value
;
5380 * Get the allowed values list
5382 * @return {string[]} Allowed data values
5384 OO
.ui
.TagMultiselectWidget
.prototype.getAllowedValues = function () {
5385 return this.allowedValues
;
5389 * Add a value to the allowed values list
5391 * @param {string} value Allowed data value
5393 OO
.ui
.TagMultiselectWidget
.prototype.addAllowedValue = function ( value
) {
5394 if ( this.allowedValues
.indexOf( value
) === -1 ) {
5395 this.allowedValues
.push( value
);
5402 OO
.ui
.TagMultiselectWidget
.prototype.focus = function () {
5403 if ( this.hasInput
) {
5409 * Get the datas of the currently selected items
5411 * @return {string[]|Object[]} Datas of currently selected items
5413 OO
.ui
.TagMultiselectWidget
.prototype.getValue = function () {
5414 return this.getItems()
5415 .filter( function ( item
) {
5416 return item
.isValid();
5418 .map( function ( item
) {
5419 return item
.getData();
5424 * Set the value of this widget by datas.
5426 * @param {string|string[]|Object|Object[]} valueObject An object representing the data
5427 * and label of the value. If the widget allows arbitrary values,
5428 * the items will be added as-is. Otherwise, the data value will
5429 * be checked against allowedValues.
5430 * This object must contain at least a data key. Example:
5431 * { data: 'foo', label: 'Foo item' }
5432 * For multiple items, use an array of objects. For example:
5434 * { data: 'foo', label: 'Foo item' },
5435 * { data: 'bar', label: 'Bar item' }
5437 * Value can also be added with plaintext array, for example:
5438 * [ 'foo', 'bar', 'bla' ] or a single string, like 'foo'
5440 OO
.ui
.TagMultiselectWidget
.prototype.setValue = function ( valueObject
) {
5441 valueObject
= Array
.isArray( valueObject
) ? valueObject
: [ valueObject
];
5444 valueObject
.forEach( function ( obj
) {
5445 if ( typeof obj
=== 'string' ) {
5448 this.addTag( obj
.data
, obj
.label
);
5454 * Add tag to the display area
5456 * @param {string|Object} data Tag data
5457 * @param {string} [label] Tag label. If no label is provided, the
5458 * stringified version of the data will be used instead.
5459 * @return {boolean} Item was added successfully
5461 OO
.ui
.TagMultiselectWidget
.prototype.addTag = function ( data
, label
) {
5463 isValid
= this.isAllowedData( data
);
5465 if ( isValid
|| this.allowDisplayInvalidTags
) {
5466 newItemWidget
= this.createTagItemWidget( data
, label
);
5467 newItemWidget
.toggleValid( isValid
);
5468 this.addItems( [ newItemWidget
] );
5475 * Remove tag by its data property.
5477 * @param {string|Object} data Tag data
5479 OO
.ui
.TagMultiselectWidget
.prototype.removeTagByData = function ( data
) {
5480 var item
= this.getItemFromData( data
);
5482 this.removeItems( [ item
] );
5486 * Construct a OO.ui.TagItemWidget (or a subclass thereof) from given label and data.
5489 * @param {string} data Item data
5490 * @param {string} label The label text.
5491 * @return {OO.ui.TagItemWidget}
5493 OO
.ui
.TagMultiselectWidget
.prototype.createTagItemWidget = function ( data
, label
) {
5494 label
= label
|| data
;
5496 return new OO
.ui
.TagItemWidget( { data
: data
, label
: label
} );
5500 * Given an item, returns the item after it. If the item is already the
5501 * last item, return `this.input`. If no item is passed, returns the
5505 * @param {OO.ui.TagItemWidget} [item] Tag item
5506 * @return {OO.ui.Widget} The next widget available.
5508 OO
.ui
.TagMultiselectWidget
.prototype.getNextItem = function ( item
) {
5509 var itemIndex
= this.items
.indexOf( item
);
5511 if ( item
=== undefined || itemIndex
=== -1 ) {
5512 return this.items
[ 0 ];
5515 if ( itemIndex
=== this.items
.length
- 1 ) { // Last item
5516 if ( this.hasInput
) {
5519 // Return first item
5520 return this.items
[ 0 ];
5523 return this.items
[ itemIndex
+ 1 ];
5528 * Given an item, returns the item before it. If the item is already the
5529 * first item, return `this.input`. If no item is passed, returns the
5533 * @param {OO.ui.TagItemWidget} [item] Tag item
5534 * @return {OO.ui.Widget} The previous widget available.
5536 OO
.ui
.TagMultiselectWidget
.prototype.getPreviousItem = function ( item
) {
5537 var itemIndex
= this.items
.indexOf( item
);
5539 if ( item
=== undefined || itemIndex
=== -1 ) {
5540 return this.items
[ this.items
.length
- 1 ];
5543 if ( itemIndex
=== 0 ) {
5544 if ( this.hasInput
) {
5547 // Return the last item
5548 return this.items
[ this.items
.length
- 1 ];
5551 return this.items
[ itemIndex
- 1 ];
5556 * Update the dimensions of the text input field to encompass all available area.
5557 * This is especially relevant for when the input is at the edge of a line
5558 * and should get smaller. The usual operation (as an inline-block with min-width)
5559 * does not work in that case, pushing the input downwards to the next line.
5563 OO
.ui
.TagMultiselectWidget
.prototype.updateInputSize = function () {
5564 var $lastItem
, direction
, contentWidth
, currentWidth
, bestWidth
;
5565 if ( this.inputPosition
=== 'inline' && !this.isDisabled() ) {
5566 this.input
.$input
.css( 'width', '1em' );
5567 $lastItem
= this.$group
.children().last();
5568 direction
= OO
.ui
.Element
.static.getDir( this.$handle
);
5570 // Get the width of the input with the placeholder text as
5571 // the value and save it so that we don't keep recalculating
5573 this.contentWidthWithPlaceholder
=== undefined &&
5574 this.input
.getValue() === '' &&
5575 this.input
.$input
.attr( 'placeholder' ) !== undefined
5577 this.input
.setValue( this.input
.$input
.attr( 'placeholder' ) );
5578 this.contentWidthWithPlaceholder
= this.input
.$input
[ 0 ].scrollWidth
;
5579 this.input
.setValue( '' );
5583 // Always keep the input wide enough for the placeholder text
5584 contentWidth
= Math
.max(
5585 this.input
.$input
[ 0 ].scrollWidth
,
5586 // undefined arguments in Math.max lead to NaN
5587 ( this.contentWidthWithPlaceholder
=== undefined ) ?
5588 0 : this.contentWidthWithPlaceholder
5590 currentWidth
= this.input
.$input
.width();
5592 if ( contentWidth
< currentWidth
) {
5593 this.updateIfHeightChanged();
5594 // All is fine, don't perform expensive calculations
5598 if ( $lastItem
.length
=== 0 ) {
5599 bestWidth
= this.$content
.innerWidth();
5601 bestWidth
= direction
=== 'ltr' ?
5602 this.$content
.innerWidth() - $lastItem
.position().left
- $lastItem
.outerWidth() :
5603 $lastItem
.position().left
;
5606 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
5607 // pixels this is off by are coming from.
5609 if ( contentWidth
> bestWidth
) {
5610 // This will result in the input getting shifted to the next line
5611 bestWidth
= this.$content
.innerWidth() - 10;
5613 this.input
.$input
.width( Math
.floor( bestWidth
) );
5614 this.updateIfHeightChanged();
5616 this.updateIfHeightChanged();
5621 * Determine if widget height changed, and if so,
5622 * emit the resize event. This is useful for when there are either
5623 * menus or popups attached to the bottom of the widget, to allow
5624 * them to change their positioning in case the widget moved down
5629 OO
.ui
.TagMultiselectWidget
.prototype.updateIfHeightChanged = function () {
5630 var height
= this.$element
.height();
5631 if ( height
!== this.height
) {
5632 this.height
= height
;
5633 this.emit( 'resize' );
5638 * Check whether all items in the widget are valid
5640 * @return {boolean} Widget is valid
5642 OO
.ui
.TagMultiselectWidget
.prototype.checkValidity = function () {
5643 return this.getItems().every( function ( item
) {
5644 return item
.isValid();
5649 * Set the valid state of this item
5651 * @param {boolean} [valid] Item is valid
5654 OO
.ui
.TagMultiselectWidget
.prototype.toggleValid = function ( valid
) {
5655 valid
= valid
=== undefined ? !this.valid
: !!valid
;
5657 if ( this.valid
!== valid
) {
5660 this.setFlags( { invalid
: !this.valid
} );
5662 this.emit( 'valid', this.valid
);
5667 * Get the current valid state of the widget
5669 * @return {boolean} Widget is valid
5671 OO
.ui
.TagMultiselectWidget
.prototype.isValid = function () {
5676 * PopupTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
5677 * to use a popup. The popup can be configured to have a default input to insert values into the widget.
5679 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
5682 * // Example: A basic PopupTagMultiselectWidget.
5683 * var widget = new OO.ui.PopupTagMultiselectWidget();
5684 * $( 'body' ).append( widget.$element );
5686 * // Example: A PopupTagMultiselectWidget with an external popup.
5687 * var popupInput = new OO.ui.TextInputWidget(),
5688 * widget = new OO.ui.PopupTagMultiselectWidget( {
5689 * popupInput: popupInput,
5691 * $content: popupInput.$element
5694 * $( 'body' ).append( widget.$element );
5696 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
5699 * @extends OO.ui.TagMultiselectWidget
5700 * @mixins OO.ui.mixin.PopupElement
5702 * @param {Object} config Configuration object
5703 * @cfg {jQuery} [$overlay] An overlay for the popup.
5704 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
5705 * @cfg {Object} [popup] Configuration options for the popup
5706 * @cfg {OO.ui.InputWidget} [popupInput] An input widget inside the popup that will be
5707 * focused when the popup is opened and will be used as replacement for the
5708 * general input in the widget.
5710 OO
.ui
.PopupTagMultiselectWidget
= function OoUiPopupTagMultiselectWidget( config
) {
5712 defaultConfig
= { popup
: {} };
5714 config
= config
|| {};
5716 // Parent constructor
5717 OO
.ui
.PopupTagMultiselectWidget
.parent
.call( this, $.extend( { inputPosition
: 'none' }, config
) );
5719 this.$overlay
= config
.$overlay
|| this.$element
;
5721 if ( !config
.popup
) {
5722 // For the default base implementation, we give a popup
5723 // with an input widget inside it. For any other use cases
5724 // the popup needs to be populated externally and the
5725 // event handled to add tags separately and manually
5726 defaultInput
= new OO
.ui
.TextInputWidget();
5728 defaultConfig
.popupInput
= defaultInput
;
5729 defaultConfig
.popup
.$content
= defaultInput
.$element
;
5731 this.$element
.addClass( 'oo-ui-popupTagMultiselectWidget-defaultPopup' );
5734 // Add overlay, and add that to the autoCloseIgnore
5735 defaultConfig
.popup
.$overlay
= this.$overlay
;
5736 defaultConfig
.popup
.$autoCloseIgnore
= this.hasInput
?
5737 this.input
.$element
.add( this.$overlay
) : this.$overlay
;
5739 // Allow extending any of the above
5740 config
= $.extend( defaultConfig
, config
);
5742 // Mixin constructors
5743 OO
.ui
.mixin
.PopupElement
.call( this, config
);
5745 if ( this.hasInput
) {
5746 this.input
.$input
.on( 'focus', this.popup
.toggle
.bind( this.popup
, true ) );
5749 // Configuration options
5750 this.popupInput
= config
.popupInput
;
5751 if ( this.popupInput
) {
5752 this.popupInput
.connect( this, {
5753 enter
: 'onPopupInputEnter'
5758 this.on( 'resize', this.popup
.updateDimensions
.bind( this.popup
) );
5759 this.popup
.connect( this, { toggle
: 'onPopupToggle' } );
5761 .on( 'focus', this.focus
.bind( this ) );
5765 .append( this.popup
.$element
)
5766 .addClass( 'oo-ui-popupTagMultiselectWidget' );
5769 /* Initialization */
5771 OO
.inheritClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
5772 OO
.mixinClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.mixin
.PopupElement
);
5779 OO
.ui
.PopupTagMultiselectWidget
.prototype.focus = function () {
5780 // Since the parent deals with input focus, only
5781 // call the parent method if our input isn't in the
5783 if ( !this.popupInput
) {
5785 OO
.ui
.PopupTagMultiselectWidget
.parent
.prototype.focus
.call( this );
5788 this.popup
.toggle( true );
5792 * Respond to popup toggle event
5794 * @param {boolean} isVisible Popup is visible
5796 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupToggle = function ( isVisible
) {
5797 if ( isVisible
&& this.popupInput
) {
5798 this.popupInput
.focus();
5803 * Respond to popup input enter event
5805 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupInputEnter = function () {
5806 if ( this.popupInput
) {
5807 this.addTagByPopupValue( this.popupInput
.getValue() );
5808 this.popupInput
.setValue( '' );
5815 OO
.ui
.PopupTagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
5816 if ( this.popupInput
&& this.allowEditTags
) {
5817 this.popupInput
.setValue( item
.getData() );
5818 this.removeItems( [ item
] );
5820 this.popup
.toggle( true );
5821 this.popupInput
.focus();
5824 OO
.ui
.PopupTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, item
);
5829 * Add a tag by the popup value.
5830 * Whatever is responsible for setting the value in the popup should call
5831 * this method to add a tag, or use the regular methods like #addTag or
5832 * #setValue directly.
5834 * @param {string} data The value of item
5835 * @param {string} [label] The label of the tag. If not given, the data is used.
5837 OO
.ui
.PopupTagMultiselectWidget
.prototype.addTagByPopupValue = function ( data
, label
) {
5838 this.addTag( data
, label
);
5842 * MenuTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
5843 * to use a menu of selectable options.
5845 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
5848 * // Example: A basic MenuTagMultiselectWidget.
5849 * var widget = new OO.ui.MenuTagMultiselectWidget( {
5850 * inputPosition: 'outline',
5852 * { data: 'option1', label: 'Option 1' },
5853 * { data: 'option2', label: 'Option 2' },
5854 * { data: 'option3', label: 'Option 3' },
5856 * selected: [ 'option1', 'option2' ]
5858 * $( 'body' ).append( widget.$element );
5860 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
5863 * @extends OO.ui.TagMultiselectWidget
5866 * @param {Object} [config] Configuration object
5867 * @cfg {Object} [menu] Configuration object for the menu widget
5868 * @cfg {jQuery} [$overlay] An overlay for the menu.
5869 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
5870 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
5872 OO
.ui
.MenuTagMultiselectWidget
= function OoUiMenuTagMultiselectWidget( config
) {
5873 config
= config
|| {};
5875 // Parent constructor
5876 OO
.ui
.MenuTagMultiselectWidget
.parent
.call( this, config
);
5878 this.$overlay
= config
.$overlay
|| this.$element
;
5880 this.menu
= this.createMenuWidget( $.extend( {
5882 input
: this.hasInput
? this.input
: null,
5883 $input
: this.hasInput
? this.input
.$input
: null,
5884 filterFromInput
: !!this.hasInput
,
5885 $autoCloseIgnore
: this.hasInput
?
5886 this.input
.$element
.add( this.$overlay
) : this.$overlay
,
5887 $floatableContainer
: this.hasInput
&& this.inputPosition
=== 'outline' ?
5888 this.input
.$element
: this.$element
,
5889 $overlay
: this.$overlay
,
5890 disabled
: this.isDisabled()
5892 this.addOptions( config
.options
|| [] );
5895 this.menu
.connect( this, {
5896 choose
: 'onMenuChoose',
5897 toggle
: 'onMenuToggle'
5899 if ( this.hasInput
) {
5900 this.input
.connect( this, { change
: 'onInputChange' } );
5902 this.connect( this, { resize
: 'onResize' } );
5906 .append( this.menu
.$element
);
5908 .addClass( 'oo-ui-menuTagMultiselectWidget' );
5911 /* Initialization */
5913 OO
.inheritClass( OO
.ui
.MenuTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
5918 * Respond to resize event
5920 OO
.ui
.MenuTagMultiselectWidget
.prototype.onResize = function () {
5921 // Reposition the menu
5922 this.menu
.position();
5928 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputFocus = function () {
5930 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
5932 this.menu
.toggle( true );
5936 * Respond to input change event
5938 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputChange = function () {
5939 this.menu
.toggle( true );
5943 * Respond to menu choose event
5945 * @param {OO.ui.OptionWidget} menuItem Chosen menu item
5947 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuChoose = function ( menuItem
) {
5949 this.addTag( menuItem
.getData(), menuItem
.getLabel() );
5953 * Respond to menu toggle event. Reset item highlights on hide.
5955 * @param {boolean} isVisible The menu is visible
5957 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
5959 this.menu
.selectItem( null );
5960 this.menu
.highlightItem( null );
5967 OO
.ui
.MenuTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
5968 var menuItem
= this.menu
.getItemFromData( tagItem
.getData() );
5969 // Override the base behavior from TagMultiselectWidget; the base behavior
5970 // in TagMultiselectWidget is to remove the tag to edit it in the input,
5971 // but in our case, we want to utilize the menu selection behavior, and
5972 // definitely not remove the item.
5974 // Select the menu item
5975 this.menu
.selectItem( menuItem
);
5983 OO
.ui
.MenuTagMultiselectWidget
.prototype.addTagFromInput = function () {
5984 var inputValue
= this.input
.getValue(),
5985 highlightedItem
= this.menu
.getHighlightedItem(),
5986 item
= this.menu
.getItemFromData( inputValue
);
5988 // Override the parent method so we add from the menu
5989 // rather than directly from the input
5991 // Look for a highlighted item first
5992 if ( highlightedItem
) {
5993 this.addTag( highlightedItem
.getData(), highlightedItem
.getLabel() );
5994 } else if ( item
) {
5995 // Look for the element that fits the data
5996 this.addTag( item
.getData(), item
.getLabel() );
5998 // Otherwise, add the tag - the method will only add if the
5999 // tag is valid or if invalid tags are allowed
6000 this.addTag( inputValue
);
6005 * Return the visible items in the menu. This is mainly used for when
6006 * the menu is filtering results.
6008 * @return {OO.ui.MenuOptionWidget[]} Visible results
6010 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenuVisibleItems = function () {
6011 return this.menu
.getItems().filter( function ( menuItem
) {
6012 return menuItem
.isVisible();
6017 * Create the menu for this widget. This is in a separate method so that
6018 * child classes can override this without polluting the constructor with
6019 * unnecessary extra objects that will be overidden.
6021 * @param {Object} menuConfig Configuration options
6022 * @return {OO.ui.MenuSelectWidget} Menu widget
6024 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
6025 return new OO
.ui
.MenuSelectWidget( menuConfig
);
6029 * Add options to the menu
6031 * @param {Object[]} menuOptions Object defining options
6033 OO
.ui
.MenuTagMultiselectWidget
.prototype.addOptions = function ( menuOptions
) {
6035 items
= menuOptions
.map( function ( obj
) {
6036 return widget
.createMenuOptionWidget( obj
.data
, obj
.label
);
6039 this.menu
.addItems( items
);
6043 * Create a menu option widget.
6045 * @param {string} data Item data
6046 * @param {string} [label] Item label
6047 * @return {OO.ui.OptionWidget} Option widget
6049 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuOptionWidget = function ( data
, label
) {
6050 return new OO
.ui
.MenuOptionWidget( {
6052 label
: label
|| data
6059 * @return {OO.ui.MenuSelectWidget} Menu
6061 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenu = function () {
6066 * Get the allowed values list
6068 * @return {string[]} Allowed data values
6070 OO
.ui
.MenuTagMultiselectWidget
.prototype.getAllowedValues = function () {
6071 var menuDatas
= this.menu
.getItems().map( function ( menuItem
) {
6072 return menuItem
.getData();
6074 return this.allowedValues
.concat( menuDatas
);
6080 OO
.ui
.MenuTagMultiselectWidget
.prototype.focus = function () {
6082 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.focus
.call( this );
6084 if ( !this.isDisabled() ) {
6085 this.menu
.toggle( true );
6090 * SelectFileWidgets allow for selecting files, using the HTML5 File API. These
6091 * widgets can be configured with {@link OO.ui.mixin.IconElement icons} and {@link
6092 * OO.ui.mixin.IndicatorElement indicators}.
6093 * Please see the [OOjs UI documentation on MediaWiki] [1] for more information and examples.
6096 * // Example of a file select widget
6097 * var selectFile = new OO.ui.SelectFileWidget();
6098 * $( 'body' ).append( selectFile.$element );
6100 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets
6103 * @extends OO.ui.Widget
6104 * @mixins OO.ui.mixin.IconElement
6105 * @mixins OO.ui.mixin.IndicatorElement
6106 * @mixins OO.ui.mixin.PendingElement
6107 * @mixins OO.ui.mixin.LabelElement
6110 * @param {Object} [config] Configuration options
6111 * @cfg {string[]|null} [accept=null] MIME types to accept. null accepts all types.
6112 * @cfg {string} [placeholder] Text to display when no file is selected.
6113 * @cfg {string} [notsupported] Text to display when file support is missing in the browser.
6114 * @cfg {boolean} [droppable=true] Whether to accept files by drag and drop.
6115 * @cfg {boolean} [showDropTarget=false] Whether to show a drop target. Requires droppable to be true.
6116 * @cfg {number} [thumbnailSizeLimit=20] File size limit in MiB above which to not try and show a
6117 * preview (for performance)
6119 OO
.ui
.SelectFileWidget
= function OoUiSelectFileWidget( config
) {
6122 // Configuration initialization
6123 config
= $.extend( {
6125 placeholder
: OO
.ui
.msg( 'ooui-selectfile-placeholder' ),
6126 notsupported
: OO
.ui
.msg( 'ooui-selectfile-not-supported' ),
6128 showDropTarget
: false,
6129 thumbnailSizeLimit
: 20
6132 // Parent constructor
6133 OO
.ui
.SelectFileWidget
.parent
.call( this, config
);
6135 // Mixin constructors
6136 OO
.ui
.mixin
.IconElement
.call( this, config
);
6137 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
6138 OO
.ui
.mixin
.PendingElement
.call( this, $.extend( {}, config
, { $pending
: this.$info
} ) );
6139 OO
.ui
.mixin
.LabelElement
.call( this, config
);
6142 this.$info
= $( '<span>' );
6143 this.showDropTarget
= config
.showDropTarget
;
6144 this.thumbnailSizeLimit
= config
.thumbnailSizeLimit
;
6145 this.isSupported
= this.constructor.static.isSupported();
6146 this.currentFile
= null;
6147 if ( Array
.isArray( config
.accept
) ) {
6148 this.accept
= config
.accept
;
6152 this.placeholder
= config
.placeholder
;
6153 this.notsupported
= config
.notsupported
;
6154 this.onFileSelectedHandler
= this.onFileSelected
.bind( this );
6156 this.selectButton
= new OO
.ui
.ButtonWidget( {
6157 classes
: [ 'oo-ui-selectFileWidget-selectButton' ],
6158 label
: OO
.ui
.msg( 'ooui-selectfile-button-select' ),
6159 disabled
: this.disabled
|| !this.isSupported
6162 this.clearButton
= new OO
.ui
.ButtonWidget( {
6163 classes
: [ 'oo-ui-selectFileWidget-clearButton' ],
6166 disabled
: this.disabled
6170 this.selectButton
.$button
.on( {
6171 keypress
: this.onKeyPress
.bind( this )
6173 this.clearButton
.connect( this, {
6174 click
: 'onClearClick'
6176 if ( config
.droppable
) {
6177 dragHandler
= this.onDragEnterOrOver
.bind( this );
6179 dragenter
: dragHandler
,
6180 dragover
: dragHandler
,
6181 dragleave
: this.onDragLeave
.bind( this ),
6182 drop
: this.onDrop
.bind( this )
6188 this.$label
.addClass( 'oo-ui-selectFileWidget-label' );
6190 .addClass( 'oo-ui-selectFileWidget-info' )
6191 .append( this.$icon
, this.$label
, this.clearButton
.$element
, this.$indicator
);
6193 if ( config
.droppable
&& config
.showDropTarget
) {
6194 this.selectButton
.setIcon( 'upload' );
6195 this.$thumbnail
= $( '<div>' ).addClass( 'oo-ui-selectFileWidget-thumbnail' );
6196 this.setPendingElement( this.$thumbnail
);
6198 .addClass( 'oo-ui-selectFileWidget-dropTarget oo-ui-selectFileWidget' )
6200 click
: this.onDropTargetClick
.bind( this )
6205 this.selectButton
.$element
,
6207 .addClass( 'oo-ui-selectFileWidget-dropLabel' )
6208 .text( OO
.ui
.msg( 'ooui-selectfile-dragdrop-placeholder' ) )
6212 .addClass( 'oo-ui-selectFileWidget' )
6213 .append( this.$info
, this.selectButton
.$element
);
6220 OO
.inheritClass( OO
.ui
.SelectFileWidget
, OO
.ui
.Widget
);
6221 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IconElement
);
6222 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IndicatorElement
);
6223 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.PendingElement
);
6224 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.LabelElement
);
6226 /* Static Properties */
6229 * Check if this widget is supported
6234 OO
.ui
.SelectFileWidget
.static.isSupported = function () {
6236 if ( OO
.ui
.SelectFileWidget
.static.isSupportedCache
=== null ) {
6237 $input
= $( '<input>' ).attr( 'type', 'file' );
6238 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= $input
[ 0 ].files
!== undefined;
6240 return OO
.ui
.SelectFileWidget
.static.isSupportedCache
;
6243 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= null;
6250 * A change event is emitted when the on/off state of the toggle changes.
6252 * @param {File|null} value New value
6258 * Get the current value of the field
6260 * @return {File|null}
6262 OO
.ui
.SelectFileWidget
.prototype.getValue = function () {
6263 return this.currentFile
;
6267 * Set the current value of the field
6269 * @param {File|null} file File to select
6271 OO
.ui
.SelectFileWidget
.prototype.setValue = function ( file
) {
6272 if ( this.currentFile
!== file
) {
6273 this.currentFile
= file
;
6275 this.emit( 'change', this.currentFile
);
6282 * Focusses the select file button.
6286 OO
.ui
.SelectFileWidget
.prototype.focus = function () {
6287 this.selectButton
.$button
[ 0 ].focus();
6292 * Update the user interface when a file is selected or unselected
6296 OO
.ui
.SelectFileWidget
.prototype.updateUI = function () {
6298 if ( !this.isSupported
) {
6299 this.$element
.addClass( 'oo-ui-selectFileWidget-notsupported' );
6300 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
6301 this.setLabel( this.notsupported
);
6303 this.$element
.addClass( 'oo-ui-selectFileWidget-supported' );
6304 if ( this.currentFile
) {
6305 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
6307 $label
= $label
.add(
6309 .addClass( 'oo-ui-selectFileWidget-fileName' )
6310 .text( this.currentFile
.name
)
6312 this.setLabel( $label
);
6314 if ( this.showDropTarget
) {
6316 this.loadAndGetImageUrl().done( function ( url
) {
6317 this.$thumbnail
.css( 'background-image', 'url( ' + url
+ ' )' );
6318 }.bind( this ) ).fail( function () {
6319 this.$thumbnail
.append(
6320 new OO
.ui
.IconWidget( {
6322 classes
: [ 'oo-ui-selectFileWidget-noThumbnail-icon' ]
6325 }.bind( this ) ).always( function () {
6328 this.$element
.off( 'click' );
6331 if ( this.showDropTarget
) {
6332 this.$element
.off( 'click' );
6334 click
: this.onDropTargetClick
.bind( this )
6338 .css( 'background-image', '' );
6340 this.$element
.addClass( 'oo-ui-selectFileWidget-empty' );
6341 this.setLabel( this.placeholder
);
6347 * If the selected file is an image, get its URL and load it.
6349 * @return {jQuery.Promise} Promise resolves with the image URL after it has loaded
6351 OO
.ui
.SelectFileWidget
.prototype.loadAndGetImageUrl = function () {
6352 var deferred
= $.Deferred(),
6353 file
= this.currentFile
,
6354 reader
= new FileReader();
6358 ( OO
.getProp( file
, 'type' ) || '' ).indexOf( 'image/' ) === 0 &&
6359 file
.size
< this.thumbnailSizeLimit
* 1024 * 1024
6361 reader
.onload = function ( event
) {
6362 var img
= document
.createElement( 'img' );
6363 img
.addEventListener( 'load', function () {
6365 img
.naturalWidth
=== 0 ||
6366 img
.naturalHeight
=== 0 ||
6367 img
.complete
=== false
6371 deferred
.resolve( event
.target
.result
);
6374 img
.src
= event
.target
.result
;
6376 reader
.readAsDataURL( file
);
6381 return deferred
.promise();
6385 * Add the input to the widget
6389 OO
.ui
.SelectFileWidget
.prototype.addInput = function () {
6390 if ( this.$input
) {
6391 this.$input
.remove();
6394 if ( !this.isSupported
) {
6399 this.$input
= $( '<input>' ).attr( 'type', 'file' );
6400 this.$input
.on( 'change', this.onFileSelectedHandler
);
6401 this.$input
.on( 'click', function ( e
) {
6402 // Prevents dropTarget to get clicked which calls
6403 // a click on this input
6404 e
.stopPropagation();
6409 if ( this.accept
) {
6410 this.$input
.attr( 'accept', this.accept
.join( ', ' ) );
6412 this.selectButton
.$button
.append( this.$input
);
6416 * Determine if we should accept this file
6419 * @param {string} mimeType File MIME type
6422 OO
.ui
.SelectFileWidget
.prototype.isAllowedType = function ( mimeType
) {
6425 if ( !this.accept
|| !mimeType
) {
6429 for ( i
= 0; i
< this.accept
.length
; i
++ ) {
6430 mimeTest
= this.accept
[ i
];
6431 if ( mimeTest
=== mimeType
) {
6433 } else if ( mimeTest
.substr( -2 ) === '/*' ) {
6434 mimeTest
= mimeTest
.substr( 0, mimeTest
.length
- 1 );
6435 if ( mimeType
.substr( 0, mimeTest
.length
) === mimeTest
) {
6445 * Handle file selection from the input
6448 * @param {jQuery.Event} e
6450 OO
.ui
.SelectFileWidget
.prototype.onFileSelected = function ( e
) {
6451 var file
= OO
.getProp( e
.target
, 'files', 0 ) || null;
6453 if ( file
&& !this.isAllowedType( file
.type
) ) {
6457 this.setValue( file
);
6462 * Handle clear button click events.
6466 OO
.ui
.SelectFileWidget
.prototype.onClearClick = function () {
6467 this.setValue( null );
6472 * Handle key press events.
6475 * @param {jQuery.Event} e Key press event
6477 OO
.ui
.SelectFileWidget
.prototype.onKeyPress = function ( e
) {
6478 if ( this.isSupported
&& !this.isDisabled() && this.$input
&&
6479 ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
6481 this.$input
.click();
6487 * Handle drop target click events.
6490 * @param {jQuery.Event} e Key press event
6492 OO
.ui
.SelectFileWidget
.prototype.onDropTargetClick = function () {
6493 if ( this.isSupported
&& !this.isDisabled() && this.$input
) {
6494 this.$input
.click();
6500 * Handle drag enter and over events
6503 * @param {jQuery.Event} e Drag event
6505 OO
.ui
.SelectFileWidget
.prototype.onDragEnterOrOver = function ( e
) {
6507 droppableFile
= false,
6508 dt
= e
.originalEvent
.dataTransfer
;
6511 e
.stopPropagation();
6513 if ( this.isDisabled() || !this.isSupported
) {
6514 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
6515 dt
.dropEffect
= 'none';
6519 // DataTransferItem and File both have a type property, but in Chrome files
6520 // have no information at this point.
6521 itemOrFile
= OO
.getProp( dt
, 'items', 0 ) || OO
.getProp( dt
, 'files', 0 );
6523 if ( this.isAllowedType( itemOrFile
.type
) ) {
6524 droppableFile
= true;
6526 // dt.types is Array-like, but not an Array
6527 } else if ( Array
.prototype.indexOf
.call( OO
.getProp( dt
, 'types' ) || [], 'Files' ) !== -1 ) {
6528 // File information is not available at this point for security so just assume
6529 // it is acceptable for now.
6530 // https://bugzilla.mozilla.org/show_bug.cgi?id=640534
6531 droppableFile
= true;
6534 this.$element
.toggleClass( 'oo-ui-selectFileWidget-canDrop', droppableFile
);
6535 if ( !droppableFile
) {
6536 dt
.dropEffect
= 'none';
6543 * Handle drag leave events
6546 * @param {jQuery.Event} e Drag event
6548 OO
.ui
.SelectFileWidget
.prototype.onDragLeave = function () {
6549 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
6553 * Handle drop events
6556 * @param {jQuery.Event} e Drop event
6558 OO
.ui
.SelectFileWidget
.prototype.onDrop = function ( e
) {
6560 dt
= e
.originalEvent
.dataTransfer
;
6563 e
.stopPropagation();
6564 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
6566 if ( this.isDisabled() || !this.isSupported
) {
6570 file
= OO
.getProp( dt
, 'files', 0 );
6571 if ( file
&& !this.isAllowedType( file
.type
) ) {
6575 this.setValue( file
);
6584 OO
.ui
.SelectFileWidget
.prototype.setDisabled = function ( disabled
) {
6585 OO
.ui
.SelectFileWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
6586 if ( this.selectButton
) {
6587 this.selectButton
.setDisabled( disabled
);
6589 if ( this.clearButton
) {
6590 this.clearButton
.setDisabled( disabled
);
6596 * SearchWidgets combine a {@link OO.ui.TextInputWidget text input field}, where users can type a search query,
6597 * and a menu of search results, which is displayed beneath the query
6598 * field. Unlike {@link OO.ui.mixin.LookupElement lookup menus}, search result menus are always visible to the user.
6599 * Users can choose an item from the menu or type a query into the text field to search for a matching result item.
6600 * In general, search widgets are used inside a separate {@link OO.ui.Dialog dialog} window.
6602 * Each time the query is changed, the search result menu is cleared and repopulated. Please see
6603 * the [OOjs UI demos][1] for an example.
6605 * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/#dialogs-mediawiki-vector-ltr
6608 * @extends OO.ui.Widget
6611 * @param {Object} [config] Configuration options
6612 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
6613 * @cfg {string} [value] Initial query value
6615 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
6616 // Configuration initialization
6617 config
= config
|| {};
6619 // Parent constructor
6620 OO
.ui
.SearchWidget
.parent
.call( this, config
);
6623 this.query
= new OO
.ui
.TextInputWidget( {
6625 placeholder
: config
.placeholder
,
6628 this.results
= new OO
.ui
.SelectWidget();
6629 this.$query
= $( '<div>' );
6630 this.$results
= $( '<div>' );
6633 this.query
.connect( this, {
6634 change
: 'onQueryChange',
6635 enter
: 'onQueryEnter'
6637 this.query
.$input
.on( 'keydown', this.onQueryKeydown
.bind( this ) );
6641 .addClass( 'oo-ui-searchWidget-query' )
6642 .append( this.query
.$element
);
6644 .addClass( 'oo-ui-searchWidget-results' )
6645 .append( this.results
.$element
);
6647 .addClass( 'oo-ui-searchWidget' )
6648 .append( this.$results
, this.$query
);
6653 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
6658 * Handle query key down events.
6661 * @param {jQuery.Event} e Key down event
6663 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
6664 var highlightedItem
, nextItem
,
6665 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
6668 highlightedItem
= this.results
.getHighlightedItem();
6669 if ( !highlightedItem
) {
6670 highlightedItem
= this.results
.getSelectedItem();
6672 nextItem
= this.results
.getRelativeSelectableItem( highlightedItem
, dir
);
6673 this.results
.highlightItem( nextItem
);
6674 nextItem
.scrollElementIntoView();
6679 * Handle select widget select events.
6681 * Clears existing results. Subclasses should repopulate items according to new query.
6684 * @param {string} value New value
6686 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
6688 this.results
.clearItems();
6692 * Handle select widget enter key events.
6694 * Chooses highlighted item.
6697 * @param {string} value New value
6699 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
6700 var highlightedItem
= this.results
.getHighlightedItem();
6701 if ( highlightedItem
) {
6702 this.results
.chooseItem( highlightedItem
);
6707 * Get the query input.
6709 * @return {OO.ui.TextInputWidget} Query input
6711 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
6716 * Get the search results menu.
6718 * @return {OO.ui.SelectWidget} Menu of search results
6720 OO
.ui
.SearchWidget
.prototype.getResults = function () {
6721 return this.results
;
6725 * NumberInputWidgets combine a {@link OO.ui.TextInputWidget text input} (where a value
6726 * can be entered manually) and two {@link OO.ui.ButtonWidget button widgets}
6727 * (to adjust the value in increments) to allow the user to enter a number.
6730 * // Example: A NumberInputWidget.
6731 * var numberInput = new OO.ui.NumberInputWidget( {
6732 * label: 'NumberInputWidget',
6733 * input: { value: 5 },
6737 * $( 'body' ).append( numberInput.$element );
6740 * @extends OO.ui.TextInputWidget
6743 * @param {Object} [config] Configuration options
6744 * @cfg {Object} [minusButton] Configuration options to pass to the {@link OO.ui.ButtonWidget decrementing button widget}.
6745 * @cfg {Object} [plusButton] Configuration options to pass to the {@link OO.ui.ButtonWidget incrementing button widget}.
6746 * @cfg {boolean} [allowInteger=false] Whether the field accepts only integer values.
6747 * @cfg {number} [min=-Infinity] Minimum allowed value
6748 * @cfg {number} [max=Infinity] Maximum allowed value
6749 * @cfg {number} [step=1] Delta when using the buttons or up/down arrow keys
6750 * @cfg {number|null} [pageStep] Delta when using the page-up/page-down keys. Defaults to 10 times #step.
6751 * @cfg {boolean} [showButtons=true] Whether to show the plus and minus buttons.
6753 OO
.ui
.NumberInputWidget
= function OoUiNumberInputWidget( config
) {
6754 var $field
= $( '<div>' )
6755 .addClass( 'oo-ui-numberInputWidget-field' );
6757 // Configuration initialization
6758 config
= $.extend( {
6759 allowInteger
: false,
6767 // For backward compatibility
6768 $.extend( config
, config
.input
);
6771 // Parent constructor
6772 OO
.ui
.NumberInputWidget
.parent
.call( this, $.extend( config
, {
6776 if ( config
.showButtons
) {
6777 this.minusButton
= new OO
.ui
.ButtonWidget( $.extend(
6779 disabled
: this.isDisabled(),
6781 classes
: [ 'oo-ui-numberInputWidget-minusButton' ],
6786 this.plusButton
= new OO
.ui
.ButtonWidget( $.extend(
6788 disabled
: this.isDisabled(),
6790 classes
: [ 'oo-ui-numberInputWidget-plusButton' ],
6799 keydown
: this.onKeyDown
.bind( this ),
6800 'wheel mousewheel DOMMouseScroll': this.onWheel
.bind( this )
6802 if ( config
.showButtons
) {
6803 this.plusButton
.connect( this, {
6804 click
: [ 'onButtonClick', +1 ]
6806 this.minusButton
.connect( this, {
6807 click
: [ 'onButtonClick', -1 ]
6812 $field
.append( this.$input
);
6813 if ( config
.showButtons
) {
6815 .prepend( this.minusButton
.$element
)
6816 .append( this.plusButton
.$element
);
6820 this.setAllowInteger( config
.allowInteger
|| config
.isInteger
);
6821 this.setRange( config
.min
, config
.max
);
6822 this.setStep( config
.step
, config
.pageStep
);
6823 // Set the validation method after we set allowInteger and range
6824 // so that it doesn't immediately call setValidityFlag
6825 this.setValidation( this.validateNumber
.bind( this ) );
6828 .addClass( 'oo-ui-numberInputWidget' )
6829 .toggleClass( 'oo-ui-numberInputWidget-buttoned', config
.showButtons
)
6835 OO
.inheritClass( OO
.ui
.NumberInputWidget
, OO
.ui
.TextInputWidget
);
6840 * Set whether only integers are allowed
6842 * @param {boolean} flag
6844 OO
.ui
.NumberInputWidget
.prototype.setAllowInteger = function ( flag
) {
6845 this.allowInteger
= !!flag
;
6846 this.setValidityFlag();
6848 // Backward compatibility
6849 OO
.ui
.NumberInputWidget
.prototype.setIsInteger
= OO
.ui
.NumberInputWidget
.prototype.setAllowInteger
;
6852 * Get whether only integers are allowed
6854 * @return {boolean} Flag value
6856 OO
.ui
.NumberInputWidget
.prototype.getAllowInteger = function () {
6857 return this.allowInteger
;
6859 // Backward compatibility
6860 OO
.ui
.NumberInputWidget
.prototype.getIsInteger
= OO
.ui
.NumberInputWidget
.prototype.getAllowInteger
;
6863 * Set the range of allowed values
6865 * @param {number} min Minimum allowed value
6866 * @param {number} max Maximum allowed value
6868 OO
.ui
.NumberInputWidget
.prototype.setRange = function ( min
, max
) {
6870 throw new Error( 'Minimum (' + min
+ ') must not be greater than maximum (' + max
+ ')' );
6874 this.setValidityFlag();
6878 * Get the current range
6880 * @return {number[]} Minimum and maximum values
6882 OO
.ui
.NumberInputWidget
.prototype.getRange = function () {
6883 return [ this.min
, this.max
];
6887 * Set the stepping deltas
6889 * @param {number} step Normal step
6890 * @param {number|null} pageStep Page step. If null, 10 * step will be used.
6892 OO
.ui
.NumberInputWidget
.prototype.setStep = function ( step
, pageStep
) {
6894 throw new Error( 'Step value must be positive' );
6896 if ( pageStep
=== null ) {
6897 pageStep
= step
* 10;
6898 } else if ( pageStep
<= 0 ) {
6899 throw new Error( 'Page step value must be positive' );
6902 this.pageStep
= pageStep
;
6906 * Get the current stepping values
6908 * @return {number[]} Step and page step
6910 OO
.ui
.NumberInputWidget
.prototype.getStep = function () {
6911 return [ this.step
, this.pageStep
];
6915 * Get the current value of the widget as a number
6917 * @return {number} May be NaN, or an invalid number
6919 OO
.ui
.NumberInputWidget
.prototype.getNumericValue = function () {
6920 return +this.getValue();
6924 * Adjust the value of the widget
6926 * @param {number} delta Adjustment amount
6928 OO
.ui
.NumberInputWidget
.prototype.adjustValue = function ( delta
) {
6929 var n
, v
= this.getNumericValue();
6932 if ( isNaN( delta
) || !isFinite( delta
) ) {
6933 throw new Error( 'Delta must be a finite number' );
6940 n
= Math
.max( Math
.min( n
, this.max
), this.min
);
6941 if ( this.allowInteger
) {
6942 n
= Math
.round( n
);
6954 * @param {string} value Field value
6957 OO
.ui
.NumberInputWidget
.prototype.validateNumber = function ( value
) {
6959 if ( value
=== '' ) {
6960 return !this.isRequired();
6963 if ( isNaN( n
) || !isFinite( n
) ) {
6967 if ( this.allowInteger
&& Math
.floor( n
) !== n
) {
6971 if ( n
< this.min
|| n
> this.max
) {
6979 * Handle mouse click events.
6982 * @param {number} dir +1 or -1
6984 OO
.ui
.NumberInputWidget
.prototype.onButtonClick = function ( dir
) {
6985 this.adjustValue( dir
* this.step
);
6989 * Handle mouse wheel events.
6992 * @param {jQuery.Event} event
6994 OO
.ui
.NumberInputWidget
.prototype.onWheel = function ( event
) {
6997 if ( !this.isDisabled() && this.$input
.is( ':focus' ) ) {
6998 // Standard 'wheel' event
6999 if ( event
.originalEvent
.deltaMode
!== undefined ) {
7000 this.sawWheelEvent
= true;
7002 if ( event
.originalEvent
.deltaY
) {
7003 delta
= -event
.originalEvent
.deltaY
;
7004 } else if ( event
.originalEvent
.deltaX
) {
7005 delta
= event
.originalEvent
.deltaX
;
7008 // Non-standard events
7009 if ( !this.sawWheelEvent
) {
7010 if ( event
.originalEvent
.wheelDeltaX
) {
7011 delta
= -event
.originalEvent
.wheelDeltaX
;
7012 } else if ( event
.originalEvent
.wheelDeltaY
) {
7013 delta
= event
.originalEvent
.wheelDeltaY
;
7014 } else if ( event
.originalEvent
.wheelDelta
) {
7015 delta
= event
.originalEvent
.wheelDelta
;
7016 } else if ( event
.originalEvent
.detail
) {
7017 delta
= -event
.originalEvent
.detail
;
7022 delta
= delta
< 0 ? -1 : 1;
7023 this.adjustValue( delta
* this.step
);
7031 * Handle key down events.
7034 * @param {jQuery.Event} e Key down event
7036 OO
.ui
.NumberInputWidget
.prototype.onKeyDown = function ( e
) {
7037 if ( !this.isDisabled() ) {
7038 switch ( e
.which
) {
7040 this.adjustValue( this.step
);
7042 case OO
.ui
.Keys
.DOWN
:
7043 this.adjustValue( -this.step
);
7045 case OO
.ui
.Keys
.PAGEUP
:
7046 this.adjustValue( this.pageStep
);
7048 case OO
.ui
.Keys
.PAGEDOWN
:
7049 this.adjustValue( -this.pageStep
);
7058 OO
.ui
.NumberInputWidget
.prototype.setDisabled = function ( disabled
) {
7060 OO
.ui
.NumberInputWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
7062 if ( this.minusButton
) {
7063 this.minusButton
.setDisabled( this.isDisabled() );
7065 if ( this.plusButton
) {
7066 this.plusButton
.setDisabled( this.isDisabled() );
7074 //# sourceMappingURL=oojs-ui-widgets.js.map