3 * https://www.mediawiki.org/wiki/OOUI
5 * Copyright 2011–2018 OOUI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
9 * Date: 2018-11-07T00:58:30Z
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;
39 // Initialize and events
41 .addClass( 'oo-ui-draggableElement' )
43 mousedown
: this.onDragMouseDown
.bind( this ),
44 dragstart
: this.onDragStart
.bind( this ),
45 dragover
: this.onDragOver
.bind( this ),
46 dragend
: this.onDragEnd
.bind( this ),
47 drop
: this.onDrop
.bind( this )
49 this.$handle
.addClass( 'oo-ui-draggableElement-handle' );
50 this.toggleDraggable( config
.draggable
=== undefined ? true : !!config
.draggable
);
53 OO
.initClass( OO
.ui
.mixin
.DraggableElement
);
60 * A dragstart event is emitted when the user clicks and begins dragging an item.
61 * @param {OO.ui.mixin.DraggableElement} item The item the user has clicked and is dragging with the mouse.
66 * A dragend event is emitted when the user drags an item and releases the mouse,
67 * thus terminating the drag operation.
72 * A drop event is emitted when the user drags an item and then releases the mouse button
73 * over a valid target.
76 /* Static Properties */
79 * @inheritdoc OO.ui.mixin.ButtonElement
81 OO
.ui
.mixin
.DraggableElement
.static.cancelButtonMouseDownEvents
= false;
86 * Change the draggable state of this widget.
87 * This allows users to temporarily halt the dragging operations.
89 * @param {boolean} isDraggable Widget supports draggable operations
92 OO
.ui
.mixin
.DraggableElement
.prototype.toggleDraggable = function ( isDraggable
) {
93 isDraggable
= isDraggable
!== undefined ? !!isDraggable
: !this.draggable
;
95 if ( this.draggable
!== isDraggable
) {
96 this.draggable
= isDraggable
;
98 this.$handle
.toggleClass( 'oo-ui-draggableElement-undraggable', !this.draggable
);
100 // We make the entire element draggable, not just the handle, so that
101 // the whole element appears to move. wasHandleUsed prevents drags from
102 // starting outside the handle
103 this.$element
.prop( 'draggable', this.draggable
);
108 * Check the draggable state of this widget
110 * @return {boolean} Widget supports draggable operations
112 OO
.ui
.mixin
.DraggableElement
.prototype.isDraggable = function () {
113 return this.draggable
;
117 * Respond to mousedown event.
120 * @param {jQuery.Event} e Drag event
122 OO
.ui
.mixin
.DraggableElement
.prototype.onDragMouseDown = function ( e
) {
123 if ( !this.isDraggable() ) {
128 // Optimization: if the handle is the whole element this is always true
129 this.$handle
[ 0 ] === this.$element
[ 0 ] ||
130 // Check the mousedown occurred inside the handle
131 OO
.ui
.contains( this.$handle
[ 0 ], e
.target
, true );
135 * Respond to dragstart event.
138 * @param {jQuery.Event} e Drag event
139 * @return {boolean} False if the event is cancelled
142 OO
.ui
.mixin
.DraggableElement
.prototype.onDragStart = function ( e
) {
144 dataTransfer
= e
.originalEvent
.dataTransfer
;
146 if ( !this.wasHandleUsed
|| !this.isDraggable() ) {
150 // Define drop effect
151 dataTransfer
.dropEffect
= 'none';
152 dataTransfer
.effectAllowed
= 'move';
154 // We must set up a dataTransfer data property or Firefox seems to
155 // ignore the fact the element is draggable.
157 dataTransfer
.setData( 'application-x/OOUI-draggable', this.getIndex() );
159 // The above is only for Firefox. Move on if it fails.
161 // Briefly add a 'clone' class to style the browser's native drag image
162 this.$element
.addClass( 'oo-ui-draggableElement-clone' );
163 // Add placeholder class after the browser has rendered the clone
164 setTimeout( function () {
166 .removeClass( 'oo-ui-draggableElement-clone' )
167 .addClass( 'oo-ui-draggableElement-placeholder' );
170 this.emit( 'dragstart', this );
175 * Respond to dragend event.
180 OO
.ui
.mixin
.DraggableElement
.prototype.onDragEnd = function () {
181 this.$element
.removeClass( 'oo-ui-draggableElement-placeholder' );
182 this.emit( 'dragend' );
189 * @param {jQuery.Event} e Drop event
192 OO
.ui
.mixin
.DraggableElement
.prototype.onDrop = function ( e
) {
194 this.emit( 'drop', e
);
198 * In order for drag/drop to work, the dragover event must
199 * return false and stop propogation.
201 * @param {jQuery.Event} e Drag event
204 OO
.ui
.mixin
.DraggableElement
.prototype.onDragOver = function ( e
) {
210 * Store it in the DOM so we can access from the widget drag event
213 * @param {number} index Item index
215 OO
.ui
.mixin
.DraggableElement
.prototype.setIndex = function ( index
) {
216 if ( this.index
!== index
) {
218 this.$element
.data( 'index', index
);
226 * @return {number} Item index
228 OO
.ui
.mixin
.DraggableElement
.prototype.getIndex = function () {
233 * DraggableGroupElement is a mixin class used to create a group element to
234 * contain draggable elements, which are items that can be clicked and dragged by a mouse.
235 * The class is used with OO.ui.mixin.DraggableElement.
239 * @mixins OO.ui.mixin.GroupElement
242 * @param {Object} [config] Configuration options
243 * @cfg {string} [orientation] Item orientation: 'horizontal' or 'vertical'. The orientation
244 * should match the layout of the items. Items displayed in a single row
245 * or in several rows should use horizontal orientation. The vertical orientation should only be
246 * used when the items are displayed in a single column. Defaults to 'vertical'
247 * @cfg {boolean} [draggable] The items are draggable. This can change with #toggleDraggable
249 OO
.ui
.mixin
.DraggableGroupElement
= function OoUiMixinDraggableGroupElement( config
) {
250 // Configuration initialization
251 config
= config
|| {};
253 // Parent constructor
254 OO
.ui
.mixin
.GroupElement
.call( this, config
);
257 this.orientation
= config
.orientation
|| 'vertical';
258 this.dragItem
= null;
261 this.itemsOrder
= null;
262 this.draggable
= config
.draggable
=== undefined ? true : !!config
.draggable
;
266 dragstart
: 'itemDragStart',
267 dragend
: 'itemDragEnd',
270 this.connect( this, {
271 itemDragStart
: 'onItemDragStart',
272 itemDrop
: 'onItemDropOrDragEnd',
273 itemDragEnd
: 'onItemDropOrDragEnd'
277 if ( Array
.isArray( config
.items
) ) {
278 this.addItems( config
.items
);
281 .addClass( 'oo-ui-draggableGroupElement' )
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
386 * @return {OO.ui.Element} The element, for chaining
388 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onItemDropOrDragEnd = function () {
389 var targetIndex
, originalIndex
,
390 item
= this.getDragItem();
392 // TODO: Figure out a way to configure a list of legally droppable
393 // elements even if they are not yet in the list
395 originalIndex
= this.items
.indexOf( item
);
396 // If the item has moved forward, add one to the index to account for the left shift
397 targetIndex
= item
.getIndex() + ( item
.getIndex() > originalIndex
? 1 : 0 );
398 if ( targetIndex
!== originalIndex
) {
399 this.reorder( this.getDragItem(), targetIndex
);
400 this.emit( 'reorder', this.getDragItem(), targetIndex
);
402 this.updateIndexes();
404 this.unsetDragItem();
405 // Return false to prevent propogation
410 * Respond to dragover event
413 * @param {jQuery.Event} e Dragover event
416 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onDragOver = function ( e
) {
417 var overIndex
, targetIndex
,
418 item
= this.getDragItem(),
419 dragItemIndex
= item
.getIndex();
421 // Get the OptionWidget item we are dragging over
422 overIndex
= $( e
.target
).closest( '.oo-ui-draggableElement' ).data( 'index' );
424 if ( overIndex
!== undefined && overIndex
!== dragItemIndex
) {
425 targetIndex
= overIndex
+ ( overIndex
> dragItemIndex
? 1 : 0 );
427 if ( targetIndex
> 0 ) {
428 this.$group
.children().eq( targetIndex
- 1 ).after( item
.$element
);
430 this.$group
.prepend( item
.$element
);
432 // Move item in itemsOrder array
433 this.itemsOrder
.splice( overIndex
, 0,
434 this.itemsOrder
.splice( dragItemIndex
, 1 )[ 0 ]
436 this.updateIndexes();
437 this.emit( 'drag', item
, targetIndex
);
444 * Reorder the items in the group
446 * @param {OO.ui.mixin.DraggableElement} item Reordered item
447 * @param {number} newIndex New index
449 OO
.ui
.mixin
.DraggableGroupElement
.prototype.reorder = function ( item
, newIndex
) {
450 this.addItems( [ item
], newIndex
);
456 * @param {OO.ui.mixin.DraggableElement} item Dragged item
458 OO
.ui
.mixin
.DraggableGroupElement
.prototype.setDragItem = function ( item
) {
459 if ( this.dragItem
!== item
) {
460 this.dragItem
= item
;
461 this.$element
.on( 'dragover', this.onDragOver
.bind( this ) );
462 this.$element
.addClass( 'oo-ui-draggableGroupElement-dragging' );
467 * Unset the current dragged item
469 OO
.ui
.mixin
.DraggableGroupElement
.prototype.unsetDragItem = function () {
470 if ( this.dragItem
) {
471 this.dragItem
= null;
472 this.$element
.off( 'dragover' );
473 this.$element
.removeClass( 'oo-ui-draggableGroupElement-dragging' );
478 * Get the item that is currently being dragged.
480 * @return {OO.ui.mixin.DraggableElement|null} The currently dragged item, or `null` if no item is being dragged
482 OO
.ui
.mixin
.DraggableGroupElement
.prototype.getDragItem = function () {
483 return this.dragItem
;
487 * RequestManager is a mixin that manages the lifecycle of a promise-backed request for a widget, such as
488 * the {@link OO.ui.mixin.LookupElement}.
495 OO
.ui
.mixin
.RequestManager
= function OoUiMixinRequestManager() {
496 this.requestCache
= {};
497 this.requestQuery
= null;
498 this.requestRequest
= null;
503 OO
.initClass( OO
.ui
.mixin
.RequestManager
);
506 * Get request results for the current query.
508 * @return {jQuery.Promise} Promise object which will be passed response data as the first argument of
509 * the done event. If the request was aborted to make way for a subsequent request, this promise
510 * may not be rejected, depending on what jQuery feels like doing.
512 OO
.ui
.mixin
.RequestManager
.prototype.getRequestData = function () {
514 value
= this.getRequestQuery(),
515 deferred
= $.Deferred(),
519 if ( Object
.prototype.hasOwnProperty
.call( this.requestCache
, value
) ) {
520 deferred
.resolve( this.requestCache
[ value
] );
522 if ( this.pushPending
) {
525 this.requestQuery
= value
;
526 ourRequest
= this.requestRequest
= this.getRequest();
528 .always( function () {
529 // We need to pop pending even if this is an old request, otherwise
530 // the widget will remain pending forever.
531 // TODO: this assumes that an aborted request will fail or succeed soon after
532 // being aborted, or at least eventually. It would be nice if we could popPending()
533 // at abort time, but only if we knew that we hadn't already called popPending()
535 if ( widget
.popPending
) {
539 .done( function ( response
) {
540 // If this is an old request (and aborting it somehow caused it to still succeed),
541 // ignore its success completely
542 if ( ourRequest
=== widget
.requestRequest
) {
543 widget
.requestQuery
= null;
544 widget
.requestRequest
= null;
545 widget
.requestCache
[ value
] = widget
.getRequestCacheDataFromResponse( response
);
546 deferred
.resolve( widget
.requestCache
[ value
] );
550 // If this is an old request (or a request failing because it's being aborted),
551 // ignore its failure completely
552 if ( ourRequest
=== widget
.requestRequest
) {
553 widget
.requestQuery
= null;
554 widget
.requestRequest
= null;
559 return deferred
.promise();
563 * Abort the currently pending request, if any.
567 OO
.ui
.mixin
.RequestManager
.prototype.abortRequest = function () {
568 var oldRequest
= this.requestRequest
;
570 // First unset this.requestRequest to the fail handler will notice
571 // that the request is no longer current
572 this.requestRequest
= null;
573 this.requestQuery
= null;
579 * Get the query to be made.
584 * @return {string} query to be used
586 OO
.ui
.mixin
.RequestManager
.prototype.getRequestQuery
= null;
589 * Get a new request object of the current query value.
594 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
596 OO
.ui
.mixin
.RequestManager
.prototype.getRequest
= null;
599 * Pre-process data returned by the request from #getRequest.
601 * The return value of this function will be cached, and any further queries for the given value
602 * will use the cache rather than doing API requests.
607 * @param {Mixed} response Response from server
608 * @return {Mixed} Cached result data
610 OO
.ui
.mixin
.RequestManager
.prototype.getRequestCacheDataFromResponse
= null;
613 * LookupElement is a mixin that creates a {@link OO.ui.MenuSelectWidget menu} of suggested values for
614 * a {@link OO.ui.TextInputWidget text input widget}. Suggested values are based on the characters the user types
615 * into the text input field and, in general, the menu is only displayed when the user types. If a suggested value is chosen
616 * from the lookup menu, that value becomes the value of the input field.
618 * Note that a new menu of suggested items is displayed when a value is chosen from the lookup menu. If this is
619 * not the desired behavior, disable lookup menus with the #setLookupsDisabled method, then set the value, then
622 * See the [OOUI demos][1] for an example.
624 * [1]: https://doc.wikimedia.org/oojs-ui/master/demos/#LookupElement-try-inputting-an-integer
628 * @mixins OO.ui.mixin.RequestManager
631 * @param {Object} [config] Configuration options
632 * @cfg {jQuery} [$overlay] Overlay for the lookup menu; defaults to relative positioning.
633 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
634 * @cfg {jQuery} [$container=this.$element] The container element. The lookup menu is rendered beneath the specified element.
635 * @cfg {Object} [menu] Configuration options to pass to {@link OO.ui.MenuSelectWidget menu select widget}
636 * @cfg {boolean} [allowSuggestionsWhenEmpty=false] Request and display a lookup menu when the text input is empty.
637 * By default, the lookup menu is not generated and displayed until the user begins to type.
638 * @cfg {boolean} [highlightFirst=true] Whether the first lookup result should be highlighted (so, that the user can
639 * take it over into the input with simply pressing return) automatically or not.
641 OO
.ui
.mixin
.LookupElement
= function OoUiMixinLookupElement( config
) {
642 // Configuration initialization
643 config
= $.extend( { highlightFirst
: true }, config
);
645 // Mixin constructors
646 OO
.ui
.mixin
.RequestManager
.call( this, config
);
649 this.$overlay
= ( config
.$overlay
=== true ? OO
.ui
.getDefaultOverlay() : config
.$overlay
) || this.$element
;
650 this.lookupMenu
= new OO
.ui
.MenuSelectWidget( $.extend( {
653 $floatableContainer
: config
.$container
|| this.$element
656 this.allowSuggestionsWhenEmpty
= config
.allowSuggestionsWhenEmpty
|| false;
658 this.lookupsDisabled
= false;
659 this.lookupInputFocused
= false;
660 this.lookupHighlightFirstItem
= config
.highlightFirst
;
664 focus
: this.onLookupInputFocus
.bind( this ),
665 blur
: this.onLookupInputBlur
.bind( this ),
666 mousedown
: this.onLookupInputMouseDown
.bind( this )
668 this.connect( this, { change
: 'onLookupInputChange' } );
669 this.lookupMenu
.connect( this, {
670 toggle
: 'onLookupMenuToggle',
671 choose
: 'onLookupMenuItemChoose'
677 'aria-owns': this.lookupMenu
.getElementId(),
678 'aria-autocomplete': 'list'
680 this.$element
.addClass( 'oo-ui-lookupElement' );
681 this.lookupMenu
.$element
.addClass( 'oo-ui-lookupElement-menu' );
682 this.$overlay
.append( this.lookupMenu
.$element
);
687 OO
.mixinClass( OO
.ui
.mixin
.LookupElement
, OO
.ui
.mixin
.RequestManager
);
692 * Handle input focus event.
695 * @param {jQuery.Event} e Input focus event
697 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputFocus = function () {
698 this.lookupInputFocused
= true;
699 this.populateLookupMenu();
703 * Handle input blur event.
706 * @param {jQuery.Event} e Input blur event
708 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputBlur = function () {
709 this.closeLookupMenu();
710 this.lookupInputFocused
= false;
714 * Handle input mouse down event.
717 * @param {jQuery.Event} e Input mouse down event
719 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputMouseDown = function () {
720 // Only open the menu if the input was already focused.
721 // This way we allow the user to open the menu again after closing it with Esc
722 // by clicking in the input. Opening (and populating) the menu when initially
723 // clicking into the input is handled by the focus handler.
724 if ( this.lookupInputFocused
&& !this.lookupMenu
.isVisible() ) {
725 this.populateLookupMenu();
730 * Handle input change event.
733 * @param {string} value New input value
735 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputChange = function () {
736 if ( this.lookupInputFocused
) {
737 this.populateLookupMenu();
742 * Handle the lookup menu being shown/hidden.
745 * @param {boolean} visible Whether the lookup menu is now visible.
747 OO
.ui
.mixin
.LookupElement
.prototype.onLookupMenuToggle = function ( visible
) {
749 // When the menu is hidden, abort any active request and clear the menu.
750 // This has to be done here in addition to closeLookupMenu(), because
751 // MenuSelectWidget will close itself when the user presses Esc.
752 this.abortLookupRequest();
753 this.lookupMenu
.clearItems();
758 * Handle menu item 'choose' event, updating the text input value to the value of the clicked item.
761 * @param {OO.ui.MenuOptionWidget} item Selected item
763 OO
.ui
.mixin
.LookupElement
.prototype.onLookupMenuItemChoose = function ( item
) {
764 this.setValue( item
.getData() );
771 * @return {OO.ui.MenuSelectWidget}
773 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenu = function () {
774 return this.lookupMenu
;
778 * Disable or re-enable lookups.
780 * When lookups are disabled, calls to #populateLookupMenu will be ignored.
782 * @param {boolean} disabled Disable lookups
784 OO
.ui
.mixin
.LookupElement
.prototype.setLookupsDisabled = function ( disabled
) {
785 this.lookupsDisabled
= !!disabled
;
789 * Open the menu. If there are no entries in the menu, this does nothing.
793 * @return {OO.ui.Element} The element, for chaining
795 OO
.ui
.mixin
.LookupElement
.prototype.openLookupMenu = function () {
796 if ( !this.lookupMenu
.isEmpty() ) {
797 this.lookupMenu
.toggle( true );
803 * Close the menu, empty it, and abort any pending request.
807 * @return {OO.ui.Element} The element, for chaining
809 OO
.ui
.mixin
.LookupElement
.prototype.closeLookupMenu = function () {
810 this.lookupMenu
.toggle( false );
811 this.abortLookupRequest();
812 this.lookupMenu
.clearItems();
817 * Request menu items based on the input's current value, and when they arrive,
818 * populate the menu with these items and show the menu.
820 * If lookups have been disabled with #setLookupsDisabled, this function does nothing.
824 * @return {OO.ui.Element} The element, for chaining
826 OO
.ui
.mixin
.LookupElement
.prototype.populateLookupMenu = function () {
828 value
= this.getValue();
830 if ( this.lookupsDisabled
|| this.isReadOnly() ) {
834 // If the input is empty, clear the menu, unless suggestions when empty are allowed.
835 if ( !this.allowSuggestionsWhenEmpty
&& value
=== '' ) {
836 this.closeLookupMenu();
837 // Skip population if there is already a request pending for the current value
838 } else if ( value
!== this.lookupQuery
) {
839 this.getLookupMenuItems()
840 .done( function ( items
) {
841 widget
.lookupMenu
.clearItems();
842 if ( items
.length
) {
846 widget
.initializeLookupMenuSelection();
848 widget
.lookupMenu
.toggle( false );
852 widget
.lookupMenu
.clearItems();
853 widget
.lookupMenu
.toggle( false );
861 * Highlight the first selectable item in the menu, if configured.
866 OO
.ui
.mixin
.LookupElement
.prototype.initializeLookupMenuSelection = function () {
867 if ( this.lookupHighlightFirstItem
&& !this.lookupMenu
.findSelectedItem() ) {
868 this.lookupMenu
.highlightItem( this.lookupMenu
.findFirstSelectableItem() );
873 * Get lookup menu items for the current query.
876 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument of
877 * the done event. If the request was aborted to make way for a subsequent request, this promise
878 * will not be rejected: it will remain pending forever.
880 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenuItems = function () {
881 return this.getRequestData().then( function ( data
) {
882 return this.getLookupMenuOptionsFromData( data
);
887 * Abort the currently pending lookup request, if any.
891 OO
.ui
.mixin
.LookupElement
.prototype.abortLookupRequest = function () {
896 * Get a new request object of the current lookup query value.
901 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
903 OO
.ui
.mixin
.LookupElement
.prototype.getLookupRequest
= null;
906 * Pre-process data returned by the request from #getLookupRequest.
908 * The return value of this function will be cached, and any further queries for the given value
909 * will use the cache rather than doing API requests.
914 * @param {Mixed} response Response from server
915 * @return {Mixed} Cached result data
917 OO
.ui
.mixin
.LookupElement
.prototype.getLookupCacheDataFromResponse
= null;
920 * Get a list of menu option widgets from the (possibly cached) data returned by
921 * #getLookupCacheDataFromResponse.
926 * @param {Mixed} data Cached result data, usually an array
927 * @return {OO.ui.MenuOptionWidget[]} Menu items
929 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenuOptionsFromData
= null;
932 * Set the read-only state of the widget.
934 * This will also disable/enable the lookups functionality.
936 * @param {boolean} readOnly Make input read-only
938 * @return {OO.ui.Element} The element, for chaining
940 OO
.ui
.mixin
.LookupElement
.prototype.setReadOnly = function ( readOnly
) {
942 // Note: Calling #setReadOnly this way assumes this is mixed into an OO.ui.TextInputWidget
943 OO
.ui
.TextInputWidget
.prototype.setReadOnly
.call( this, readOnly
);
945 // During construction, #setReadOnly is called before the OO.ui.mixin.LookupElement constructor
946 if ( this.isReadOnly() && this.lookupMenu
) {
947 this.closeLookupMenu();
954 * @inheritdoc OO.ui.mixin.RequestManager
956 OO
.ui
.mixin
.LookupElement
.prototype.getRequestQuery = function () {
957 return this.getValue();
961 * @inheritdoc OO.ui.mixin.RequestManager
963 OO
.ui
.mixin
.LookupElement
.prototype.getRequest = function () {
964 return this.getLookupRequest();
968 * @inheritdoc OO.ui.mixin.RequestManager
970 OO
.ui
.mixin
.LookupElement
.prototype.getRequestCacheDataFromResponse = function ( response
) {
971 return this.getLookupCacheDataFromResponse( response
);
975 * TabPanelLayouts are used within {@link OO.ui.IndexLayout index layouts} to create tab panels that
976 * users can select and display from the index's optional {@link OO.ui.TabSelectWidget tab}
977 * navigation. TabPanels are usually not instantiated directly, rather extended to include the
978 * required content and functionality.
980 * Each tab panel must have a unique symbolic name, which is passed to the constructor. In addition,
981 * the tab panel's tab item is customized (with a label) using the #setupTabItem method. See
982 * {@link OO.ui.IndexLayout IndexLayout} for an example.
985 * @extends OO.ui.PanelLayout
988 * @param {string} name Unique symbolic name of tab panel
989 * @param {Object} [config] Configuration options
990 * @cfg {jQuery|string|Function|OO.ui.HtmlSnippet} [label] Label for tab panel's tab
992 OO
.ui
.TabPanelLayout
= function OoUiTabPanelLayout( name
, config
) {
993 // Allow passing positional parameters inside the config object
994 if ( OO
.isPlainObject( name
) && config
=== undefined ) {
999 // Configuration initialization
1000 config
= $.extend( { scrollable
: true }, config
);
1002 // Parent constructor
1003 OO
.ui
.TabPanelLayout
.parent
.call( this, config
);
1007 this.label
= config
.label
;
1008 this.tabItem
= null;
1009 this.active
= false;
1013 .addClass( 'oo-ui-tabPanelLayout' )
1014 .attr( 'role', 'tabpanel' );
1019 OO
.inheritClass( OO
.ui
.TabPanelLayout
, OO
.ui
.PanelLayout
);
1024 * An 'active' event is emitted when the tab panel becomes active. Tab panels become active when they are
1025 * shown in a index layout that is configured to display only one tab panel at a time.
1028 * @param {boolean} active Tab panel is active
1034 * Get the symbolic name of the tab panel.
1036 * @return {string} Symbolic name of tab panel
1038 OO
.ui
.TabPanelLayout
.prototype.getName = function () {
1043 * Check if tab panel is active.
1045 * Tab panels become active when they are shown in a {@link OO.ui.IndexLayout index layout} that is configured to
1046 * display only one tab panel at a time. Additional CSS is applied to the tab panel's tab item to reflect the
1049 * @return {boolean} Tab panel is active
1051 OO
.ui
.TabPanelLayout
.prototype.isActive = function () {
1058 * The tab item allows users to access the tab panel from the index's tab
1059 * navigation. The tab item itself can be customized (with a label, level, etc.) using the #setupTabItem method.
1061 * @return {OO.ui.TabOptionWidget|null} Tab option widget
1063 OO
.ui
.TabPanelLayout
.prototype.getTabItem = function () {
1064 return this.tabItem
;
1068 * Set or unset the tab item.
1070 * Specify a {@link OO.ui.TabOptionWidget tab option} to set it,
1071 * or `null` to clear the tab item. To customize the tab item itself (e.g., to set a label or tab
1072 * level), use #setupTabItem instead of this method.
1074 * @param {OO.ui.TabOptionWidget|null} tabItem Tab option widget, null to clear
1076 * @return {OO.ui.TabPanelLayout} The layout, for chaining
1078 OO
.ui
.TabPanelLayout
.prototype.setTabItem = function ( tabItem
) {
1079 this.tabItem
= tabItem
|| null;
1081 this.setupTabItem();
1087 * Set up the tab item.
1089 * Use this method to customize the tab item (e.g., to add a label or tab level). To set or unset
1090 * the tab item itself (with a {@link OO.ui.TabOptionWidget tab option} or `null`), use
1091 * the #setTabItem method instead.
1093 * @param {OO.ui.TabOptionWidget} tabItem Tab option widget to set up
1095 * @return {OO.ui.TabPanelLayout} The layout, for chaining
1097 OO
.ui
.TabPanelLayout
.prototype.setupTabItem = function () {
1098 this.$element
.attr( 'aria-labelledby', this.tabItem
.getElementId() );
1100 this.tabItem
.$element
.attr( 'aria-controls', this.getElementId() );
1103 this.tabItem
.setLabel( this.label
);
1109 * Set the tab panel to its 'active' state.
1111 * Tab panels become active when they are shown in a index layout that is configured to display only
1112 * one tab panel at a time. Additional CSS is applied to the tab item to reflect the tab panel's
1113 * active state. Outside of the index context, setting the active state on a tab panel does nothing.
1115 * @param {boolean} active Tab panel is active
1118 OO
.ui
.TabPanelLayout
.prototype.setActive = function ( active
) {
1121 if ( active
!== this.active
) {
1122 this.active
= active
;
1123 this.$element
.toggleClass( 'oo-ui-tabPanelLayout-active', this.active
);
1124 this.emit( 'active', this.active
);
1129 * PageLayouts are used within {@link OO.ui.BookletLayout booklet layouts} to create pages that users can select and display
1130 * from the booklet's optional {@link OO.ui.OutlineSelectWidget outline} navigation. Pages are usually not instantiated directly,
1131 * rather extended to include the required content and functionality.
1133 * Each page must have a unique symbolic name, which is passed to the constructor. In addition, the page's outline
1134 * item is customized (with a label, outline level, etc.) using the #setupOutlineItem method. See
1135 * {@link OO.ui.BookletLayout BookletLayout} for an example.
1138 * @extends OO.ui.PanelLayout
1141 * @param {string} name Unique symbolic name of page
1142 * @param {Object} [config] Configuration options
1144 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
1145 // Allow passing positional parameters inside the config object
1146 if ( OO
.isPlainObject( name
) && config
=== undefined ) {
1151 // Configuration initialization
1152 config
= $.extend( { scrollable
: true }, config
);
1154 // Parent constructor
1155 OO
.ui
.PageLayout
.parent
.call( this, config
);
1159 this.outlineItem
= null;
1160 this.active
= false;
1163 this.$element
.addClass( 'oo-ui-pageLayout' );
1168 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
1173 * An 'active' event is emitted when the page becomes active. Pages become active when they are
1174 * shown in a booklet layout that is configured to display only one page at a time.
1177 * @param {boolean} active Page is active
1183 * Get the symbolic name of the page.
1185 * @return {string} Symbolic name of page
1187 OO
.ui
.PageLayout
.prototype.getName = function () {
1192 * Check if page is active.
1194 * Pages become active when they are shown in a {@link OO.ui.BookletLayout booklet layout} that is configured to display
1195 * only one page at a time. Additional CSS is applied to the page's outline item to reflect the active state.
1197 * @return {boolean} Page is active
1199 OO
.ui
.PageLayout
.prototype.isActive = function () {
1206 * The outline item allows users to access the page from the booklet's outline
1207 * navigation. The outline item itself can be customized (with a label, level, etc.) using the #setupOutlineItem method.
1209 * @return {OO.ui.OutlineOptionWidget|null} Outline option widget
1211 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
1212 return this.outlineItem
;
1216 * Set or unset the outline item.
1218 * Specify an {@link OO.ui.OutlineOptionWidget outline option} to set it,
1219 * or `null` to clear the outline item. To customize the outline item itself (e.g., to set a label or outline
1220 * level), use #setupOutlineItem instead of this method.
1222 * @param {OO.ui.OutlineOptionWidget|null} outlineItem Outline option widget, null to clear
1224 * @return {OO.ui.PageLayout} The layout, for chaining
1226 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
1227 this.outlineItem
= outlineItem
|| null;
1228 if ( outlineItem
) {
1229 this.setupOutlineItem();
1235 * Set up the outline item.
1237 * Use this method to customize the outline item (e.g., to add a label or outline level). To set or unset
1238 * the outline item itself (with an {@link OO.ui.OutlineOptionWidget outline option} or `null`), use
1239 * the #setOutlineItem method instead.
1241 * @param {OO.ui.OutlineOptionWidget} outlineItem Outline option widget to set up
1243 * @return {OO.ui.PageLayout} The layout, for chaining
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 continuously
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
1438 * @return {OO.ui.StackLayout} The layout, for chaining
1440 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
1441 // Update the visibility
1442 this.updateHiddenState( items
, this.currentItem
);
1445 OO
.ui
.mixin
.GroupElement
.prototype.addItems
.call( this, items
, index
);
1447 if ( !this.currentItem
&& items
.length
) {
1448 this.setItem( items
[ 0 ] );
1455 * Remove the specified panels from the stack layout.
1457 * Removed panels are detached from the DOM, not removed, so that they may be reused. To remove all panels,
1458 * you may wish to use the #clearItems method instead.
1460 * @param {OO.ui.Layout[]} items Panels to remove
1462 * @return {OO.ui.StackLayout} The layout, for chaining
1465 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
1467 OO
.ui
.mixin
.GroupElement
.prototype.removeItems
.call( this, items
);
1469 if ( items
.indexOf( this.currentItem
) !== -1 ) {
1470 if ( this.items
.length
) {
1471 this.setItem( this.items
[ 0 ] );
1473 this.unsetCurrentItem();
1481 * Clear all panels from the stack layout.
1483 * Cleared panels are detached from the DOM, not removed, so that they may be reused. To remove only
1484 * a subset of panels, use the #removeItems method.
1487 * @return {OO.ui.StackLayout} The layout, for chaining
1490 OO
.ui
.StackLayout
.prototype.clearItems = function () {
1491 this.unsetCurrentItem();
1492 OO
.ui
.mixin
.GroupElement
.prototype.clearItems
.call( this );
1498 * Show the specified panel.
1500 * If another panel is currently displayed, it will be hidden.
1502 * @param {OO.ui.Layout} item Panel to show
1504 * @return {OO.ui.StackLayout} The layout, for chaining
1507 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
1508 if ( item
!== this.currentItem
) {
1509 this.updateHiddenState( this.items
, item
);
1511 if ( this.items
.indexOf( item
) !== -1 ) {
1512 this.currentItem
= item
;
1513 this.emit( 'set', item
);
1515 this.unsetCurrentItem();
1523 * Reset the scroll offset of all panels, or the container if continuous
1527 OO
.ui
.StackLayout
.prototype.resetScroll = function () {
1528 if ( this.continuous
) {
1530 return OO
.ui
.StackLayout
.parent
.prototype.resetScroll
.call( this );
1533 this.getItems().forEach( function ( panel
) {
1534 var hidden
= panel
.$element
.hasClass( 'oo-ui-element-hidden' );
1535 // Scroll can only be reset when panel is visible
1536 panel
.$element
.removeClass( 'oo-ui-element-hidden' );
1537 panel
.resetScroll();
1539 panel
.$element
.addClass( 'oo-ui-element-hidden' );
1547 * Update the visibility of all items in case of non-continuous view.
1549 * Ensure all items are hidden except for the selected one.
1550 * This method does nothing when the stack is continuous.
1553 * @param {OO.ui.Layout[]} items Item list iterate over
1554 * @param {OO.ui.Layout} [selectedItem] Selected item to show
1556 OO
.ui
.StackLayout
.prototype.updateHiddenState = function ( items
, selectedItem
) {
1559 if ( !this.continuous
) {
1560 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
1561 if ( !selectedItem
|| selectedItem
!== items
[ i
] ) {
1562 items
[ i
].$element
.addClass( 'oo-ui-element-hidden' );
1563 items
[ i
].$element
.attr( 'aria-hidden', 'true' );
1566 if ( selectedItem
) {
1567 selectedItem
.$element
.removeClass( 'oo-ui-element-hidden' );
1568 selectedItem
.$element
.removeAttr( 'aria-hidden' );
1574 * 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)
1575 * and its size is customized with the #menuSize config. The content area will fill all remaining space.
1579 * menuPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1580 * contentPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1581 * select = new OO.ui.SelectWidget( {
1583 * new OO.ui.OptionWidget( {
1587 * new OO.ui.OptionWidget( {
1591 * new OO.ui.OptionWidget( {
1595 * new OO.ui.OptionWidget( {
1600 * } ).on( 'select', function ( item ) {
1601 * menuLayout.setMenuPosition( item.getData() );
1604 * menuLayout = new OO.ui.MenuLayout( {
1606 * menuPanel: menuPanel,
1607 * contentPanel: contentPanel
1609 * menuLayout.$menu.append(
1610 * menuPanel.$element.append( '<b>Menu panel</b>', select.$element )
1612 * menuLayout.$content.append(
1613 * contentPanel.$element.append( '<b>Content panel</b>', '<p>Note that the menu is positioned relative to the content panel: top, bottom, after, before.</p>')
1615 * $( 'body' ).append( menuLayout.$element );
1617 * If menu size needs to be overridden, it can be accomplished using CSS similar to the snippet
1618 * below. MenuLayout's CSS will override the appropriate values with 'auto' or '0' to display the
1619 * menu correctly. If `menuPosition` is known beforehand, CSS rules corresponding to other positions
1622 * .oo-ui-menuLayout-menu {
1627 * .oo-ui-menuLayout-content {
1635 * @extends OO.ui.Layout
1638 * @param {Object} [config] Configuration options
1639 * @cfg {OO.ui.PanelLayout} [menuPanel] Menu panel
1640 * @cfg {OO.ui.PanelLayout} [contentPanel] Content panel
1641 * @cfg {boolean} [expanded=true] Expand the layout to fill the entire parent element.
1642 * @cfg {boolean} [showMenu=true] Show menu
1643 * @cfg {string} [menuPosition='before'] Position of menu: `top`, `after`, `bottom` or `before`
1645 OO
.ui
.MenuLayout
= function OoUiMenuLayout( config
) {
1646 // Configuration initialization
1647 config
= $.extend( {
1650 menuPosition
: 'before'
1653 // Parent constructor
1654 OO
.ui
.MenuLayout
.parent
.call( this, config
);
1656 this.menuPanel
= null;
1657 this.contentPanel
= null;
1658 this.expanded
= !!config
.expanded
;
1662 * @property {jQuery}
1664 this.$menu
= $( '<div>' );
1668 * @property {jQuery}
1670 this.$content
= $( '<div>' );
1674 .addClass( 'oo-ui-menuLayout-menu' );
1675 this.$content
.addClass( 'oo-ui-menuLayout-content' );
1677 .addClass( 'oo-ui-menuLayout' );
1678 if ( config
.expanded
) {
1679 this.$element
.addClass( 'oo-ui-menuLayout-expanded' );
1681 this.$element
.addClass( 'oo-ui-menuLayout-static' );
1683 if ( config
.menuPanel
) {
1684 this.setMenuPanel( config
.menuPanel
);
1686 if ( config
.contentPanel
) {
1687 this.setContentPanel( config
.contentPanel
);
1689 this.setMenuPosition( config
.menuPosition
);
1690 this.toggleMenu( config
.showMenu
);
1695 OO
.inheritClass( OO
.ui
.MenuLayout
, OO
.ui
.Layout
);
1702 * @param {boolean} showMenu Show menu, omit to toggle
1704 * @return {OO.ui.MenuLayout} The layout, for chaining
1706 OO
.ui
.MenuLayout
.prototype.toggleMenu = function ( showMenu
) {
1707 showMenu
= showMenu
=== undefined ? !this.showMenu
: !!showMenu
;
1709 if ( this.showMenu
!== showMenu
) {
1710 this.showMenu
= showMenu
;
1712 .toggleClass( 'oo-ui-menuLayout-showMenu', this.showMenu
)
1713 .toggleClass( 'oo-ui-menuLayout-hideMenu', !this.showMenu
);
1714 this.$menu
.attr( 'aria-hidden', this.showMenu
? 'false' : 'true' );
1721 * Check if menu is visible
1723 * @return {boolean} Menu is visible
1725 OO
.ui
.MenuLayout
.prototype.isMenuVisible = function () {
1726 return this.showMenu
;
1730 * Set menu position.
1732 * @param {string} position Position of menu, either `top`, `after`, `bottom` or `before`
1733 * @throws {Error} If position value is not supported
1735 * @return {OO.ui.MenuLayout} The layout, for chaining
1737 OO
.ui
.MenuLayout
.prototype.setMenuPosition = function ( position
) {
1738 this.$element
.removeClass( 'oo-ui-menuLayout-' + this.menuPosition
);
1739 this.menuPosition
= position
;
1740 if ( this.menuPosition
=== 'top' || this.menuPosition
=== 'before' ) {
1741 this.$element
.append( this.$menu
, this.$content
);
1743 this.$element
.append( this.$content
, this.$menu
);
1745 this.$element
.addClass( 'oo-ui-menuLayout-' + position
);
1751 * Get menu position.
1753 * @return {string} Menu position
1755 OO
.ui
.MenuLayout
.prototype.getMenuPosition = function () {
1756 return this.menuPosition
;
1760 * Set the menu panel.
1762 * @param {OO.ui.PanelLayout} menuPanel Menu panel
1764 OO
.ui
.MenuLayout
.prototype.setMenuPanel = function ( menuPanel
) {
1765 this.menuPanel
= menuPanel
;
1766 this.$menu
.append( this.menuPanel
.$element
);
1770 * Set the content panel.
1772 * @param {OO.ui.PanelLayout} contentPanel Content panel
1774 OO
.ui
.MenuLayout
.prototype.setContentPanel = function ( contentPanel
) {
1775 this.contentPanel
= contentPanel
;
1776 this.$content
.append( this.contentPanel
.$element
);
1780 * Clear the menu panel.
1782 OO
.ui
.MenuLayout
.prototype.clearMenuPanel = function () {
1783 this.menuPanel
= null;
1788 * Clear the content panel.
1790 OO
.ui
.MenuLayout
.prototype.clearContentPanel = function () {
1791 this.contentPanel
= null;
1792 this.$content
.empty();
1796 * Reset the scroll offset of all panels and the tab select widget
1800 OO
.ui
.MenuLayout
.prototype.resetScroll = function () {
1801 if ( this.menuPanel
) {
1802 this.menuPanel
.resetScroll();
1804 if ( this.contentPanel
) {
1805 this.contentPanel
.resetScroll();
1812 * BookletLayouts contain {@link OO.ui.PageLayout page layouts} as well as
1813 * an {@link OO.ui.OutlineSelectWidget outline} that allows users to easily navigate
1814 * through the pages and select which one to display. By default, only one page is
1815 * displayed at a time and the outline is hidden. When a user navigates to a new page,
1816 * the booklet layout automatically focuses on the first focusable element, unless the
1817 * default setting is changed. Optionally, booklets can be configured to show
1818 * {@link OO.ui.OutlineControlsWidget controls} for adding, moving, and removing items.
1821 * // Example of a BookletLayout that contains two PageLayouts.
1823 * function PageOneLayout( name, config ) {
1824 * PageOneLayout.parent.call( this, name, config );
1825 * this.$element.append( '<p>First page</p><p>(This booklet has an outline, displayed on the left)</p>' );
1827 * OO.inheritClass( PageOneLayout, OO.ui.PageLayout );
1828 * PageOneLayout.prototype.setupOutlineItem = function () {
1829 * this.outlineItem.setLabel( 'Page One' );
1832 * function PageTwoLayout( name, config ) {
1833 * PageTwoLayout.parent.call( this, name, config );
1834 * this.$element.append( '<p>Second page</p>' );
1836 * OO.inheritClass( PageTwoLayout, OO.ui.PageLayout );
1837 * PageTwoLayout.prototype.setupOutlineItem = function () {
1838 * this.outlineItem.setLabel( 'Page Two' );
1841 * var page1 = new PageOneLayout( 'one' ),
1842 * page2 = new PageTwoLayout( 'two' );
1844 * var booklet = new OO.ui.BookletLayout( {
1848 * booklet.addPages( [ page1, page2 ] );
1849 * $( 'body' ).append( booklet.$element );
1852 * @extends OO.ui.MenuLayout
1855 * @param {Object} [config] Configuration options
1856 * @cfg {boolean} [continuous=false] Show all pages, one after another
1857 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new page is displayed. Disabled on mobile.
1858 * @cfg {boolean} [outlined=false] Show the outline. The outline is used to navigate through the pages of the booklet.
1859 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
1861 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
1862 // Configuration initialization
1863 config
= config
|| {};
1865 // Parent constructor
1866 OO
.ui
.BookletLayout
.parent
.call( this, config
);
1869 this.currentPageName
= null;
1871 this.ignoreFocus
= false;
1872 this.stackLayout
= new OO
.ui
.StackLayout( {
1873 continuous
: !!config
.continuous
,
1874 expanded
: this.expanded
1876 this.setContentPanel( this.stackLayout
);
1877 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
1878 this.outlineVisible
= false;
1879 this.outlined
= !!config
.outlined
;
1880 if ( this.outlined
) {
1881 this.editable
= !!config
.editable
;
1882 this.outlineControlsWidget
= null;
1883 this.outlineSelectWidget
= new OO
.ui
.OutlineSelectWidget();
1884 this.outlinePanel
= new OO
.ui
.PanelLayout( {
1885 expanded
: this.expanded
,
1888 this.setMenuPanel( this.outlinePanel
);
1889 this.outlineVisible
= true;
1890 if ( this.editable
) {
1891 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
1892 this.outlineSelectWidget
1896 this.toggleMenu( this.outlined
);
1899 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
1900 if ( this.outlined
) {
1901 this.outlineSelectWidget
.connect( this, { select
: 'onOutlineSelectWidgetSelect' } );
1902 this.scrolling
= false;
1903 this.stackLayout
.connect( this, { visibleItemChange
: 'onStackLayoutVisibleItemChange' } );
1905 if ( this.autoFocus
) {
1906 // Event 'focus' does not bubble, but 'focusin' does
1907 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
1911 this.$element
.addClass( 'oo-ui-bookletLayout' );
1912 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
1913 if ( this.outlined
) {
1914 this.outlinePanel
.$element
1915 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
1916 .append( this.outlineSelectWidget
.$element
);
1917 if ( this.editable
) {
1918 this.outlinePanel
.$element
1919 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
1920 .append( this.outlineControlsWidget
.$element
);
1927 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.MenuLayout
);
1932 * A 'set' event is emitted when a page is {@link #setPage set} to be displayed by the booklet layout.
1934 * @param {OO.ui.PageLayout} page Current page
1938 * An 'add' event is emitted when pages are {@link #addPages added} to the booklet layout.
1941 * @param {OO.ui.PageLayout[]} page Added pages
1942 * @param {number} index Index pages were added at
1946 * A 'remove' event is emitted when pages are {@link #clearPages cleared} or
1947 * {@link #removePages removed} from the booklet.
1950 * @param {OO.ui.PageLayout[]} pages Removed pages
1956 * Handle stack layout focus.
1959 * @param {jQuery.Event} e Focusin event
1961 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
1964 // Find the page that an element was focused within
1965 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
1966 for ( name
in this.pages
) {
1967 // Check for page match, exclude current page to find only page changes
1968 if ( this.pages
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentPageName
) {
1969 this.setPage( name
);
1976 * Handle visibleItemChange events from the stackLayout
1978 * The next visible page is set as the current page by selecting it
1981 * @param {OO.ui.PageLayout} page The next visible page in the layout
1983 OO
.ui
.BookletLayout
.prototype.onStackLayoutVisibleItemChange = function ( page
) {
1984 // Set a flag to so that the resulting call to #onStackLayoutSet doesn't
1985 // try and scroll the item into view again.
1986 this.scrolling
= true;
1987 this.outlineSelectWidget
.selectItemByData( page
.getName() );
1988 this.scrolling
= false;
1992 * Handle stack layout set events.
1995 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
1997 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
1998 var promise
, layout
= this;
1999 // If everything is unselected, do nothing
2003 // For continuous BookletLayouts, scroll the selected page into view first
2004 if ( this.stackLayout
.continuous
&& !this.scrolling
) {
2005 promise
= page
.scrollElementIntoView();
2007 promise
= $.Deferred().resolve();
2009 // Focus the first element on the newly selected panel.
2010 // Don't focus if the page was set by scrolling.
2011 if ( this.autoFocus
&& !OO
.ui
.isMobile() && !this.scrolling
) {
2012 promise
.done( function () {
2019 * Focus the first input in the current page.
2021 * If no page is selected, the first selectable page will be selected.
2022 * If the focus is already in an element on the current page, nothing will happen.
2024 * @param {number} [itemIndex] A specific item to focus on
2026 OO
.ui
.BookletLayout
.prototype.focus = function ( itemIndex
) {
2028 items
= this.stackLayout
.getItems();
2030 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
2031 page
= items
[ itemIndex
];
2033 page
= this.stackLayout
.getCurrentItem();
2036 if ( !page
&& this.outlined
) {
2037 this.selectFirstSelectablePage();
2038 page
= this.stackLayout
.getCurrentItem();
2043 // Only change the focus if is not already in the current page
2044 if ( !OO
.ui
.contains( page
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
2050 * Find the first focusable input in the booklet layout and focus
2053 OO
.ui
.BookletLayout
.prototype.focusFirstFocusable = function () {
2054 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
2058 * Handle outline widget select events.
2061 * @param {OO.ui.OptionWidget|null} item Selected item
2063 OO
.ui
.BookletLayout
.prototype.onOutlineSelectWidgetSelect = function ( item
) {
2065 this.setPage( item
.getData() );
2070 * Check if booklet has an outline.
2072 * @return {boolean} Booklet has an outline
2074 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
2075 return this.outlined
;
2079 * Check if booklet has editing controls.
2081 * @return {boolean} Booklet is editable
2083 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
2084 return this.editable
;
2088 * Check if booklet has a visible outline.
2090 * @return {boolean} Outline is visible
2092 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
2093 return this.outlined
&& this.outlineVisible
;
2097 * Hide or show the outline.
2099 * @param {boolean} [show] Show outline, omit to invert current state
2101 * @return {OO.ui.BookletLayout} The layout, for chaining
2103 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
2106 if ( this.outlined
) {
2107 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
2108 this.outlineVisible
= show
;
2109 this.toggleMenu( show
);
2110 if ( show
&& this.editable
) {
2111 // HACK: Kill dumb scrollbars when the sidebar stops animating, see T161798. Only necessary when
2112 // outline controls are present, delay matches transition on `.oo-ui-menuLayout-menu`.
2113 setTimeout( function () {
2114 OO
.ui
.Element
.static.reconsiderScrollbars( booklet
.outlinePanel
.$element
[ 0 ] );
2123 * Find the page closest to the specified page.
2125 * @param {OO.ui.PageLayout} page Page to use as a reference point
2126 * @return {OO.ui.PageLayout|null} Page closest to the specified page
2128 OO
.ui
.BookletLayout
.prototype.findClosestPage = function ( page
) {
2129 var next
, prev
, level
,
2130 pages
= this.stackLayout
.getItems(),
2131 index
= pages
.indexOf( page
);
2133 if ( index
!== -1 ) {
2134 next
= pages
[ index
+ 1 ];
2135 prev
= pages
[ index
- 1 ];
2136 // Prefer adjacent pages at the same level
2137 if ( this.outlined
) {
2138 level
= this.outlineSelectWidget
.findItemFromData( page
.getName() ).getLevel();
2141 level
=== this.outlineSelectWidget
.findItemFromData( prev
.getName() ).getLevel()
2147 level
=== this.outlineSelectWidget
.findItemFromData( next
.getName() ).getLevel()
2153 return prev
|| next
|| null;
2157 * Get the outline widget.
2159 * If the booklet is not outlined, the method will return `null`.
2161 * @return {OO.ui.OutlineSelectWidget|null} Outline widget, or null if the booklet is not outlined
2163 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
2164 return this.outlineSelectWidget
;
2168 * Get the outline controls widget.
2170 * If the outline is not editable, the method will return `null`.
2172 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
2174 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
2175 return this.outlineControlsWidget
;
2179 * Get a page by its symbolic name.
2181 * @param {string} name Symbolic name of page
2182 * @return {OO.ui.PageLayout|undefined} Page, if found
2184 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
2185 return this.pages
[ name
];
2189 * Get the current page.
2191 * @return {OO.ui.PageLayout|undefined} Current page, if found
2193 OO
.ui
.BookletLayout
.prototype.getCurrentPage = function () {
2194 var name
= this.getCurrentPageName();
2195 return name
? this.getPage( name
) : undefined;
2199 * Get the symbolic name of the current page.
2201 * @return {string|null} Symbolic name of the current page
2203 OO
.ui
.BookletLayout
.prototype.getCurrentPageName = function () {
2204 return this.currentPageName
;
2208 * Add pages to the booklet layout
2210 * When pages are added with the same names as existing pages, the existing pages will be
2211 * automatically removed before the new pages are added.
2213 * @param {OO.ui.PageLayout[]} pages Pages to add
2214 * @param {number} index Index of the insertion point
2217 * @return {OO.ui.BookletLayout} The layout, for chaining
2219 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
2220 var i
, len
, name
, page
, item
, currentIndex
,
2221 stackLayoutPages
= this.stackLayout
.getItems(),
2225 // Remove pages with same names
2226 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2228 name
= page
.getName();
2230 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
2231 // Correct the insertion index
2232 currentIndex
= stackLayoutPages
.indexOf( this.pages
[ name
] );
2233 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2236 remove
.push( this.pages
[ name
] );
2239 if ( remove
.length
) {
2240 this.removePages( remove
);
2244 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2246 name
= page
.getName();
2247 this.pages
[ page
.getName() ] = page
;
2248 if ( this.outlined
) {
2249 item
= new OO
.ui
.OutlineOptionWidget( { data
: name
} );
2250 page
.setOutlineItem( item
);
2255 if ( this.outlined
&& items
.length
) {
2256 this.outlineSelectWidget
.addItems( items
, index
);
2257 this.selectFirstSelectablePage();
2259 this.stackLayout
.addItems( pages
, index
);
2260 this.emit( 'add', pages
, index
);
2266 * Remove the specified pages from the booklet layout.
2268 * To remove all pages from the booklet, you may wish to use the #clearPages method instead.
2270 * @param {OO.ui.PageLayout[]} pages An array of pages to remove
2273 * @return {OO.ui.BookletLayout} The layout, for chaining
2275 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
2276 var i
, len
, name
, page
,
2279 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2281 name
= page
.getName();
2282 delete this.pages
[ name
];
2283 if ( this.outlined
) {
2284 items
.push( this.outlineSelectWidget
.findItemFromData( name
) );
2285 page
.setOutlineItem( null );
2288 if ( this.outlined
&& items
.length
) {
2289 this.outlineSelectWidget
.removeItems( items
);
2290 this.selectFirstSelectablePage();
2292 this.stackLayout
.removeItems( pages
);
2293 this.emit( 'remove', pages
);
2299 * Clear all pages from the booklet layout.
2301 * To remove only a subset of pages from the booklet, use the #removePages method.
2305 * @return {OO.ui.BookletLayout} The layout, for chaining
2307 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
2309 pages
= this.stackLayout
.getItems();
2312 this.currentPageName
= null;
2313 if ( this.outlined
) {
2314 this.outlineSelectWidget
.clearItems();
2315 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2316 pages
[ i
].setOutlineItem( null );
2319 this.stackLayout
.clearItems();
2321 this.emit( 'remove', pages
);
2327 * Set the current page by symbolic name.
2330 * @param {string} name Symbolic name of page
2332 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
2335 page
= this.pages
[ name
],
2336 previousPage
= this.currentPageName
&& this.pages
[ this.currentPageName
];
2338 if ( name
!== this.currentPageName
) {
2339 if ( this.outlined
) {
2340 selectedItem
= this.outlineSelectWidget
.findSelectedItem();
2341 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2342 this.outlineSelectWidget
.selectItemByData( name
);
2346 if ( previousPage
) {
2347 previousPage
.setActive( false );
2348 // Blur anything focused if the next page doesn't have anything focusable.
2349 // This is not needed if the next page has something focusable (because once it is focused
2350 // this blur happens automatically). If the layout is non-continuous, this check is
2351 // meaningless because the next page is not visible yet and thus can't hold focus.
2354 !OO
.ui
.isMobile() &&
2355 this.stackLayout
.continuous
&&
2356 OO
.ui
.findFocusable( page
.$element
).length
!== 0
2358 $focused
= previousPage
.$element
.find( ':focus' );
2359 if ( $focused
.length
) {
2360 $focused
[ 0 ].blur();
2364 this.currentPageName
= name
;
2365 page
.setActive( true );
2366 this.stackLayout
.setItem( page
);
2367 if ( !this.stackLayout
.continuous
&& previousPage
) {
2368 // This should not be necessary, since any inputs on the previous page should have been
2369 // blurred when it was hidden, but browsers are not very consistent about this.
2370 $focused
= previousPage
.$element
.find( ':focus' );
2371 if ( $focused
.length
) {
2372 $focused
[ 0 ].blur();
2375 this.emit( 'set', page
);
2381 * For outlined-continuous booklets, also reset the outlineSelectWidget to the first item.
2385 OO
.ui
.BookletLayout
.prototype.resetScroll = function () {
2387 OO
.ui
.BookletLayout
.parent
.prototype.resetScroll
.call( this );
2389 if ( this.outlined
&& this.stackLayout
.continuous
&& this.outlineSelectWidget
.findFirstSelectableItem() ) {
2390 this.scrolling
= true;
2391 this.outlineSelectWidget
.selectItem( this.outlineSelectWidget
.findFirstSelectableItem() );
2392 this.scrolling
= false;
2398 * Select the first selectable page.
2401 * @return {OO.ui.BookletLayout} The layout, for chaining
2403 OO
.ui
.BookletLayout
.prototype.selectFirstSelectablePage = function () {
2404 if ( !this.outlineSelectWidget
.findSelectedItem() ) {
2405 this.outlineSelectWidget
.selectItem( this.outlineSelectWidget
.findFirstSelectableItem() );
2412 * IndexLayouts contain {@link OO.ui.TabPanelLayout tab panel layouts} as well as
2413 * {@link OO.ui.TabSelectWidget tabs} that allow users to easily navigate through the tab panels and
2414 * select which one to display. By default, only one tab panel is displayed at a time. When a user
2415 * navigates to a new tab panel, the index layout automatically focuses on the first focusable element,
2416 * unless the default setting is changed.
2418 * TODO: This class is similar to BookletLayout, we may want to refactor to reduce duplication
2421 * // Example of a IndexLayout that contains two TabPanelLayouts.
2423 * function TabPanelOneLayout( name, config ) {
2424 * TabPanelOneLayout.parent.call( this, name, config );
2425 * this.$element.append( '<p>First tab panel</p>' );
2427 * OO.inheritClass( TabPanelOneLayout, OO.ui.TabPanelLayout );
2428 * TabPanelOneLayout.prototype.setupTabItem = function () {
2429 * this.tabItem.setLabel( 'Tab panel one' );
2432 * var tabPanel1 = new TabPanelOneLayout( 'one' ),
2433 * tabPanel2 = new OO.ui.TabPanelLayout( 'two', { label: 'Tab panel two' } );
2435 * tabPanel2.$element.append( '<p>Second tab panel</p>' );
2437 * var index = new OO.ui.IndexLayout();
2439 * index.addTabPanels( [ tabPanel1, tabPanel2 ] );
2440 * $( 'body' ).append( index.$element );
2443 * @extends OO.ui.MenuLayout
2446 * @param {Object} [config] Configuration options
2447 * @cfg {boolean} [continuous=false] Show all tab panels, one after another
2448 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new tab panel is displayed. Disabled on mobile.
2450 OO
.ui
.IndexLayout
= function OoUiIndexLayout( config
) {
2451 // Configuration initialization
2452 config
= $.extend( {}, config
, { menuPosition
: 'top' } );
2454 // Parent constructor
2455 OO
.ui
.IndexLayout
.parent
.call( this, config
);
2458 this.currentTabPanelName
= null;
2459 this.tabPanels
= {};
2461 this.ignoreFocus
= false;
2462 this.stackLayout
= new OO
.ui
.StackLayout( {
2463 continuous
: !!config
.continuous
,
2464 expanded
: this.expanded
2466 this.setContentPanel( this.stackLayout
);
2467 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
2469 this.tabSelectWidget
= new OO
.ui
.TabSelectWidget();
2470 this.tabPanel
= new OO
.ui
.PanelLayout( {
2471 expanded
: this.expanded
2473 this.setMenuPanel( this.tabPanel
);
2475 this.toggleMenu( true );
2478 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
2479 this.tabSelectWidget
.connect( this, { select
: 'onTabSelectWidgetSelect' } );
2480 if ( this.autoFocus
) {
2481 // Event 'focus' does not bubble, but 'focusin' does
2482 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
2486 this.$element
.addClass( 'oo-ui-indexLayout' );
2487 this.stackLayout
.$element
.addClass( 'oo-ui-indexLayout-stackLayout' );
2488 this.tabPanel
.$element
2489 .addClass( 'oo-ui-indexLayout-tabPanel' )
2490 .append( this.tabSelectWidget
.$element
);
2495 OO
.inheritClass( OO
.ui
.IndexLayout
, OO
.ui
.MenuLayout
);
2500 * A 'set' event is emitted when a tab panel is {@link #setTabPanel set} to be displayed by the index layout.
2502 * @param {OO.ui.TabPanelLayout} tabPanel Current tab panel
2506 * An 'add' event is emitted when tab panels are {@link #addTabPanels added} to the index layout.
2509 * @param {OO.ui.TabPanelLayout[]} tabPanel Added tab panels
2510 * @param {number} index Index tab panels were added at
2514 * A 'remove' event is emitted when tab panels are {@link #clearTabPanels cleared} or
2515 * {@link #removeTabPanels removed} from the index.
2518 * @param {OO.ui.TabPanelLayout[]} tabPanel Removed tab panels
2524 * Handle stack layout focus.
2527 * @param {jQuery.Event} e Focusing event
2529 OO
.ui
.IndexLayout
.prototype.onStackLayoutFocus = function ( e
) {
2532 // Find the tab panel that an element was focused within
2533 $target
= $( e
.target
).closest( '.oo-ui-tabPanelLayout' );
2534 for ( name
in this.tabPanels
) {
2535 // Check for tab panel match, exclude current tab panel to find only tab panel changes
2536 if ( this.tabPanels
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentTabPanelName
) {
2537 this.setTabPanel( name
);
2544 * Handle stack layout set events.
2547 * @param {OO.ui.PanelLayout|null} tabPanel The tab panel that is now the current panel
2549 OO
.ui
.IndexLayout
.prototype.onStackLayoutSet = function ( tabPanel
) {
2550 // If everything is unselected, do nothing
2554 // Focus the first element on the newly selected panel
2555 if ( this.autoFocus
&& !OO
.ui
.isMobile() ) {
2561 * Focus the first input in the current tab panel.
2563 * If no tab panel is selected, the first selectable tab panel will be selected.
2564 * If the focus is already in an element on the current tab panel, nothing will happen.
2566 * @param {number} [itemIndex] A specific item to focus on
2568 OO
.ui
.IndexLayout
.prototype.focus = function ( itemIndex
) {
2570 items
= this.stackLayout
.getItems();
2572 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
2573 tabPanel
= items
[ itemIndex
];
2575 tabPanel
= this.stackLayout
.getCurrentItem();
2579 this.selectFirstSelectableTabPanel();
2580 tabPanel
= this.stackLayout
.getCurrentItem();
2585 // Only change the focus if is not already in the current page
2586 if ( !OO
.ui
.contains( tabPanel
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
2592 * Find the first focusable input in the index layout and focus
2595 OO
.ui
.IndexLayout
.prototype.focusFirstFocusable = function () {
2596 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
2600 * Handle tab widget select events.
2603 * @param {OO.ui.OptionWidget|null} item Selected item
2605 OO
.ui
.IndexLayout
.prototype.onTabSelectWidgetSelect = function ( item
) {
2607 this.setTabPanel( item
.getData() );
2612 * Get the tab panel closest to the specified tab panel.
2614 * @param {OO.ui.TabPanelLayout} tabPanel Tab panel to use as a reference point
2615 * @return {OO.ui.TabPanelLayout|null} Tab panel closest to the specified
2617 OO
.ui
.IndexLayout
.prototype.getClosestTabPanel = function ( tabPanel
) {
2618 var next
, prev
, level
,
2619 tabPanels
= this.stackLayout
.getItems(),
2620 index
= tabPanels
.indexOf( tabPanel
);
2622 if ( index
!== -1 ) {
2623 next
= tabPanels
[ index
+ 1 ];
2624 prev
= tabPanels
[ index
- 1 ];
2625 // Prefer adjacent tab panels at the same level
2626 level
= this.tabSelectWidget
.findItemFromData( tabPanel
.getName() ).getLevel();
2629 level
=== this.tabSelectWidget
.findItemFromData( prev
.getName() ).getLevel()
2635 level
=== this.tabSelectWidget
.findItemFromData( next
.getName() ).getLevel()
2640 return prev
|| next
|| null;
2644 * Get the tabs widget.
2646 * @return {OO.ui.TabSelectWidget} Tabs widget
2648 OO
.ui
.IndexLayout
.prototype.getTabs = function () {
2649 return this.tabSelectWidget
;
2653 * Get a tab panel by its symbolic name.
2655 * @param {string} name Symbolic name of tab panel
2656 * @return {OO.ui.TabPanelLayout|undefined} Tab panel, if found
2658 OO
.ui
.IndexLayout
.prototype.getTabPanel = function ( name
) {
2659 return this.tabPanels
[ name
];
2663 * Get the current tab panel.
2665 * @return {OO.ui.TabPanelLayout|undefined} Current tab panel, if found
2667 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanel = function () {
2668 var name
= this.getCurrentTabPanelName();
2669 return name
? this.getTabPanel( name
) : undefined;
2673 * Get the symbolic name of the current tab panel.
2675 * @return {string|null} Symbolic name of the current tab panel
2677 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanelName = function () {
2678 return this.currentTabPanelName
;
2682 * Add tab panels to the index layout
2684 * When tab panels are added with the same names as existing tab panels, the existing tab panels
2685 * will be automatically removed before the new tab panels are added.
2687 * @param {OO.ui.TabPanelLayout[]} tabPanels Tab panels to add
2688 * @param {number} index Index of the insertion point
2691 * @return {OO.ui.BookletLayout} The layout, for chaining
2693 OO
.ui
.IndexLayout
.prototype.addTabPanels = function ( tabPanels
, index
) {
2694 var i
, len
, name
, tabPanel
, item
, currentIndex
,
2695 stackLayoutTabPanels
= this.stackLayout
.getItems(),
2699 // Remove tab panels with same names
2700 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2701 tabPanel
= tabPanels
[ i
];
2702 name
= tabPanel
.getName();
2704 if ( Object
.prototype.hasOwnProperty
.call( this.tabPanels
, name
) ) {
2705 // Correct the insertion index
2706 currentIndex
= stackLayoutTabPanels
.indexOf( this.tabPanels
[ name
] );
2707 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2710 remove
.push( this.tabPanels
[ name
] );
2713 if ( remove
.length
) {
2714 this.removeTabPanels( remove
);
2717 // Add new tab panels
2718 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2719 tabPanel
= tabPanels
[ i
];
2720 name
= tabPanel
.getName();
2721 this.tabPanels
[ tabPanel
.getName() ] = tabPanel
;
2722 item
= new OO
.ui
.TabOptionWidget( { data
: name
} );
2723 tabPanel
.setTabItem( item
);
2727 if ( items
.length
) {
2728 this.tabSelectWidget
.addItems( items
, index
);
2729 this.selectFirstSelectableTabPanel();
2731 this.stackLayout
.addItems( tabPanels
, index
);
2732 this.emit( 'add', tabPanels
, index
);
2738 * Remove the specified tab panels from the index layout.
2740 * To remove all tab panels from the index, you may wish to use the #clearTabPanels method instead.
2742 * @param {OO.ui.TabPanelLayout[]} tabPanels An array of tab panels to remove
2745 * @return {OO.ui.BookletLayout} The layout, for chaining
2747 OO
.ui
.IndexLayout
.prototype.removeTabPanels = function ( tabPanels
) {
2748 var i
, len
, name
, tabPanel
,
2751 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2752 tabPanel
= tabPanels
[ i
];
2753 name
= tabPanel
.getName();
2754 delete this.tabPanels
[ name
];
2755 items
.push( this.tabSelectWidget
.findItemFromData( name
) );
2756 tabPanel
.setTabItem( null );
2758 if ( items
.length
) {
2759 this.tabSelectWidget
.removeItems( items
);
2760 this.selectFirstSelectableTabPanel();
2762 this.stackLayout
.removeItems( tabPanels
);
2763 this.emit( 'remove', tabPanels
);
2769 * Clear all tab panels from the index layout.
2771 * To remove only a subset of tab panels from the index, use the #removeTabPanels method.
2775 * @return {OO.ui.BookletLayout} The layout, for chaining
2777 OO
.ui
.IndexLayout
.prototype.clearTabPanels = function () {
2779 tabPanels
= this.stackLayout
.getItems();
2781 this.tabPanels
= {};
2782 this.currentTabPanelName
= null;
2783 this.tabSelectWidget
.clearItems();
2784 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2785 tabPanels
[ i
].setTabItem( null );
2787 this.stackLayout
.clearItems();
2789 this.emit( 'remove', tabPanels
);
2795 * Set the current tab panel by symbolic name.
2798 * @param {string} name Symbolic name of tab panel
2800 OO
.ui
.IndexLayout
.prototype.setTabPanel = function ( name
) {
2804 tabPanel
= this.tabPanels
[ name
];
2806 if ( name
!== this.currentTabPanelName
) {
2807 previousTabPanel
= this.getCurrentTabPanel();
2808 selectedItem
= this.tabSelectWidget
.findSelectedItem();
2809 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2810 this.tabSelectWidget
.selectItemByData( name
);
2813 if ( previousTabPanel
) {
2814 previousTabPanel
.setActive( false );
2815 // Blur anything focused if the next tab panel doesn't have anything focusable.
2816 // This is not needed if the next tab panel has something focusable (because once it is focused
2817 // this blur happens automatically). If the layout is non-continuous, this check is
2818 // meaningless because the next tab panel is not visible yet and thus can't hold focus.
2821 !OO
.ui
.isMobile() &&
2822 this.stackLayout
.continuous
&&
2823 OO
.ui
.findFocusable( tabPanel
.$element
).length
!== 0
2825 $focused
= previousTabPanel
.$element
.find( ':focus' );
2826 if ( $focused
.length
) {
2827 $focused
[ 0 ].blur();
2831 this.currentTabPanelName
= name
;
2832 tabPanel
.setActive( true );
2833 this.stackLayout
.setItem( tabPanel
);
2834 if ( !this.stackLayout
.continuous
&& previousTabPanel
) {
2835 // This should not be necessary, since any inputs on the previous tab panel should have been
2836 // blurred when it was hidden, but browsers are not very consistent about this.
2837 $focused
= previousTabPanel
.$element
.find( ':focus' );
2838 if ( $focused
.length
) {
2839 $focused
[ 0 ].blur();
2842 this.emit( 'set', tabPanel
);
2848 * Select the first selectable tab panel.
2851 * @return {OO.ui.BookletLayout} The layout, for chaining
2853 OO
.ui
.IndexLayout
.prototype.selectFirstSelectableTabPanel = function () {
2854 if ( !this.tabSelectWidget
.findSelectedItem() ) {
2855 this.tabSelectWidget
.selectItem( this.tabSelectWidget
.findFirstSelectableItem() );
2862 * ToggleWidget implements basic behavior of widgets with an on/off state.
2863 * Please see OO.ui.ToggleButtonWidget and OO.ui.ToggleSwitchWidget for examples.
2867 * @extends OO.ui.Widget
2870 * @param {Object} [config] Configuration options
2871 * @cfg {boolean} [value=false] The toggle’s initial on/off state.
2872 * By default, the toggle is in the 'off' state.
2874 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
2875 // Configuration initialization
2876 config
= config
|| {};
2878 // Parent constructor
2879 OO
.ui
.ToggleWidget
.parent
.call( this, config
);
2885 this.$element
.addClass( 'oo-ui-toggleWidget' );
2886 this.setValue( !!config
.value
);
2891 OO
.inheritClass( OO
.ui
.ToggleWidget
, OO
.ui
.Widget
);
2898 * A change event is emitted when the on/off state of the toggle changes.
2900 * @param {boolean} value Value representing the new state of the toggle
2906 * Get the value representing the toggle’s state.
2908 * @return {boolean} The on/off state of the toggle
2910 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
2915 * Set the state of the toggle: `true` for 'on', `false` for 'off'.
2917 * @param {boolean} value The state of the toggle
2920 * @return {OO.ui.Widget} The widget, for chaining
2922 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
2924 if ( this.value
!== value
) {
2926 this.emit( 'change', value
);
2927 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
2928 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
2934 * ToggleButtons are buttons that have a state (‘on’ or ‘off’) that is represented by a
2935 * Boolean value. Like other {@link OO.ui.ButtonWidget buttons}, toggle buttons can be
2936 * configured with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators},
2937 * {@link OO.ui.mixin.TitledElement titles}, {@link OO.ui.mixin.FlaggedElement styling flags},
2938 * and {@link OO.ui.mixin.LabelElement labels}. Please see
2939 * the [OOUI documentation][1] on MediaWiki for more information.
2942 * // Toggle buttons in the 'off' and 'on' state.
2943 * var toggleButton1 = new OO.ui.ToggleButtonWidget( {
2944 * label: 'Toggle Button off'
2946 * var toggleButton2 = new OO.ui.ToggleButtonWidget( {
2947 * label: 'Toggle Button on',
2950 * // Append the buttons to the DOM.
2951 * $( 'body' ).append( toggleButton1.$element, toggleButton2.$element );
2953 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Buttons_and_Switches#Toggle_buttons
2956 * @extends OO.ui.ToggleWidget
2957 * @mixins OO.ui.mixin.ButtonElement
2958 * @mixins OO.ui.mixin.IconElement
2959 * @mixins OO.ui.mixin.IndicatorElement
2960 * @mixins OO.ui.mixin.LabelElement
2961 * @mixins OO.ui.mixin.TitledElement
2962 * @mixins OO.ui.mixin.FlaggedElement
2963 * @mixins OO.ui.mixin.TabIndexedElement
2966 * @param {Object} [config] Configuration options
2967 * @cfg {boolean} [value=false] The toggle button’s initial on/off
2968 * state. By default, the button is in the 'off' state.
2970 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
2971 // Configuration initialization
2972 config
= config
|| {};
2974 // Parent constructor
2975 OO
.ui
.ToggleButtonWidget
.parent
.call( this, config
);
2977 // Mixin constructors
2978 OO
.ui
.mixin
.ButtonElement
.call( this, $.extend( {}, config
, { active
: this.active
} ) );
2979 OO
.ui
.mixin
.IconElement
.call( this, config
);
2980 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
2981 OO
.ui
.mixin
.LabelElement
.call( this, config
);
2982 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
2983 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
2984 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$button
} ) );
2987 this.connect( this, { click
: 'onAction' } );
2990 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
2992 .addClass( 'oo-ui-toggleButtonWidget' )
2993 .append( this.$button
);
2998 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
2999 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.ButtonElement
);
3000 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IconElement
);
3001 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IndicatorElement
);
3002 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.LabelElement
);
3003 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TitledElement
);
3004 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.FlaggedElement
);
3005 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3007 /* Static Properties */
3013 OO
.ui
.ToggleButtonWidget
.static.tagName
= 'span';
3018 * Handle the button action being triggered.
3022 OO
.ui
.ToggleButtonWidget
.prototype.onAction = function () {
3023 this.setValue( !this.value
);
3029 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
3031 if ( value
!== this.value
) {
3032 // Might be called from parent constructor before ButtonElement constructor
3033 if ( this.$button
) {
3034 this.$button
.attr( 'aria-pressed', value
.toString() );
3036 this.setActive( value
);
3040 OO
.ui
.ToggleButtonWidget
.parent
.prototype.setValue
.call( this, value
);
3048 OO
.ui
.ToggleButtonWidget
.prototype.setButtonElement = function ( $button
) {
3049 if ( this.$button
) {
3050 this.$button
.removeAttr( 'aria-pressed' );
3052 OO
.ui
.mixin
.ButtonElement
.prototype.setButtonElement
.call( this, $button
);
3053 this.$button
.attr( 'aria-pressed', this.value
.toString() );
3057 * ToggleSwitches are switches that slide on and off. Their state is represented by a Boolean
3058 * value (`true` for ‘on’, and `false` otherwise, the default). The ‘off’ state is represented
3059 * visually by a slider in the leftmost position.
3062 * // Toggle switches in the 'off' and 'on' position.
3063 * var toggleSwitch1 = new OO.ui.ToggleSwitchWidget();
3064 * var toggleSwitch2 = new OO.ui.ToggleSwitchWidget( {
3068 * // Create a FieldsetLayout to layout and label switches
3069 * var fieldset = new OO.ui.FieldsetLayout( {
3070 * label: 'Toggle switches'
3072 * fieldset.addItems( [
3073 * new OO.ui.FieldLayout( toggleSwitch1, { label: 'Off', align: 'top' } ),
3074 * new OO.ui.FieldLayout( toggleSwitch2, { label: 'On', align: 'top' } )
3076 * $( 'body' ).append( fieldset.$element );
3079 * @extends OO.ui.ToggleWidget
3080 * @mixins OO.ui.mixin.TabIndexedElement
3083 * @param {Object} [config] Configuration options
3084 * @cfg {boolean} [value=false] The toggle switch’s initial on/off state.
3085 * By default, the toggle switch is in the 'off' position.
3087 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
3088 // Parent constructor
3089 OO
.ui
.ToggleSwitchWidget
.parent
.call( this, config
);
3091 // Mixin constructors
3092 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3095 this.dragging
= false;
3096 this.dragStart
= null;
3097 this.sliding
= false;
3098 this.$glow
= $( '<span>' );
3099 this.$grip
= $( '<span>' );
3103 click
: this.onClick
.bind( this ),
3104 keypress
: this.onKeyPress
.bind( this )
3108 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
3109 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
3111 .addClass( 'oo-ui-toggleSwitchWidget' )
3112 .attr( 'role', 'checkbox' )
3113 .append( this.$glow
, this.$grip
);
3118 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
3119 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3124 * Handle mouse click events.
3127 * @param {jQuery.Event} e Mouse click event
3128 * @return {undefined/boolean} False to prevent default if event is handled
3130 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
3131 if ( !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
3132 this.setValue( !this.value
);
3138 * Handle key press events.
3141 * @param {jQuery.Event} e Key press event
3142 * @return {undefined/boolean} False to prevent default if event is handled
3144 OO
.ui
.ToggleSwitchWidget
.prototype.onKeyPress = function ( e
) {
3145 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
3146 this.setValue( !this.value
);
3154 OO
.ui
.ToggleSwitchWidget
.prototype.setValue = function ( value
) {
3155 OO
.ui
.ToggleSwitchWidget
.parent
.prototype.setValue
.call( this, value
);
3156 this.$element
.attr( 'aria-checked', this.value
.toString() );
3163 OO
.ui
.ToggleSwitchWidget
.prototype.simulateLabelClick = function () {
3164 if ( !this.isDisabled() ) {
3165 this.setValue( !this.value
);
3171 * OutlineControlsWidget is a set of controls for an {@link OO.ui.OutlineSelectWidget outline select widget}.
3172 * Controls include moving items up and down, removing items, and adding different kinds of items.
3174 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3177 * @extends OO.ui.Widget
3178 * @mixins OO.ui.mixin.GroupElement
3181 * @param {OO.ui.OutlineSelectWidget} outline Outline to control
3182 * @param {Object} [config] Configuration options
3183 * @cfg {Object} [abilities] List of abilties
3184 * @cfg {boolean} [abilities.move=true] Allow moving movable items
3185 * @cfg {boolean} [abilities.remove=true] Allow removing removable items
3187 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
3188 // Allow passing positional parameters inside the config object
3189 if ( OO
.isPlainObject( outline
) && config
=== undefined ) {
3191 outline
= config
.outline
;
3194 // Configuration initialization
3195 config
= config
|| {};
3197 // Parent constructor
3198 OO
.ui
.OutlineControlsWidget
.parent
.call( this, config
);
3200 // Mixin constructors
3201 OO
.ui
.mixin
.GroupElement
.call( this, config
);
3204 this.outline
= outline
;
3205 this.$movers
= $( '<div>' );
3206 this.upButton
= new OO
.ui
.ButtonWidget( {
3209 title
: OO
.ui
.msg( 'ooui-outline-control-move-up' )
3211 this.downButton
= new OO
.ui
.ButtonWidget( {
3214 title
: OO
.ui
.msg( 'ooui-outline-control-move-down' )
3216 this.removeButton
= new OO
.ui
.ButtonWidget( {
3219 title
: OO
.ui
.msg( 'ooui-outline-control-remove' )
3221 this.abilities
= { move: true, remove
: true };
3224 outline
.connect( this, {
3225 select
: 'onOutlineChange',
3226 add
: 'onOutlineChange',
3227 remove
: 'onOutlineChange'
3229 this.upButton
.connect( this, { click
: [ 'emit', 'move', -1 ] } );
3230 this.downButton
.connect( this, { click
: [ 'emit', 'move', 1 ] } );
3231 this.removeButton
.connect( this, { click
: [ 'emit', 'remove' ] } );
3234 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
3235 this.$group
.addClass( 'oo-ui-outlineControlsWidget-items' );
3237 .addClass( 'oo-ui-outlineControlsWidget-movers' )
3238 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
3239 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
3240 this.setAbilities( config
.abilities
|| {} );
3245 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
3246 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.GroupElement
);
3252 * @param {number} places Number of places to move
3264 * @param {Object} abilities List of abilties
3265 * @param {boolean} [abilities.move] Allow moving movable items
3266 * @param {boolean} [abilities.remove] Allow removing removable items
3268 OO
.ui
.OutlineControlsWidget
.prototype.setAbilities = function ( abilities
) {
3271 for ( ability
in this.abilities
) {
3272 if ( abilities
[ ability
] !== undefined ) {
3273 this.abilities
[ ability
] = !!abilities
[ ability
];
3277 this.onOutlineChange();
3281 * Handle outline change events.
3285 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
3286 var i
, len
, firstMovable
, lastMovable
,
3287 items
= this.outline
.getItems(),
3288 selectedItem
= this.outline
.findSelectedItem(),
3289 movable
= this.abilities
.move && selectedItem
&& selectedItem
.isMovable(),
3290 removable
= this.abilities
.remove
&& selectedItem
&& selectedItem
.isRemovable();
3295 while ( ++i
< len
) {
3296 if ( items
[ i
].isMovable() ) {
3297 firstMovable
= items
[ i
];
3303 if ( items
[ i
].isMovable() ) {
3304 lastMovable
= items
[ i
];
3309 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
3310 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
3311 this.removeButton
.setDisabled( !removable
);
3315 * OutlineOptionWidget is an item in an {@link OO.ui.OutlineSelectWidget OutlineSelectWidget}.
3317 * Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}, which contain
3318 * {@link OO.ui.PageLayout page layouts}. See {@link OO.ui.BookletLayout BookletLayout}
3322 * @extends OO.ui.DecoratedOptionWidget
3325 * @param {Object} [config] Configuration options
3326 * @cfg {number} [level] Indentation level
3327 * @cfg {boolean} [movable] Allow modification from {@link OO.ui.OutlineControlsWidget outline controls}.
3329 OO
.ui
.OutlineOptionWidget
= function OoUiOutlineOptionWidget( config
) {
3330 // Configuration initialization
3331 config
= config
|| {};
3333 // Parent constructor
3334 OO
.ui
.OutlineOptionWidget
.parent
.call( this, config
);
3338 this.movable
= !!config
.movable
;
3339 this.removable
= !!config
.removable
;
3342 this.$element
.addClass( 'oo-ui-outlineOptionWidget' );
3343 this.setLevel( config
.level
);
3348 OO
.inheritClass( OO
.ui
.OutlineOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
3350 /* Static Properties */
3356 OO
.ui
.OutlineOptionWidget
.static.highlightable
= true;
3362 OO
.ui
.OutlineOptionWidget
.static.scrollIntoViewOnSelect
= true;
3367 * @property {string}
3369 OO
.ui
.OutlineOptionWidget
.static.levelClass
= 'oo-ui-outlineOptionWidget-level-';
3374 * @property {number}
3376 OO
.ui
.OutlineOptionWidget
.static.levels
= 3;
3381 * Check if item is movable.
3383 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3385 * @return {boolean} Item is movable
3387 OO
.ui
.OutlineOptionWidget
.prototype.isMovable = function () {
3388 return this.movable
;
3392 * Check if item is removable.
3394 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3396 * @return {boolean} Item is removable
3398 OO
.ui
.OutlineOptionWidget
.prototype.isRemovable = function () {
3399 return this.removable
;
3403 * Get indentation level.
3405 * @return {number} Indentation level
3407 OO
.ui
.OutlineOptionWidget
.prototype.getLevel = function () {
3414 OO
.ui
.OutlineOptionWidget
.prototype.setPressed = function ( state
) {
3415 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setPressed
.call( this, state
);
3422 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3424 * @param {boolean} movable Item is movable
3426 * @return {OO.ui.Widget} The widget, for chaining
3428 OO
.ui
.OutlineOptionWidget
.prototype.setMovable = function ( movable
) {
3429 this.movable
= !!movable
;
3430 this.updateThemeClasses();
3437 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3439 * @param {boolean} removable Item is removable
3441 * @return {OO.ui.Widget} The widget, for chaining
3443 OO
.ui
.OutlineOptionWidget
.prototype.setRemovable = function ( removable
) {
3444 this.removable
= !!removable
;
3445 this.updateThemeClasses();
3452 OO
.ui
.OutlineOptionWidget
.prototype.setSelected = function ( state
) {
3453 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3458 * Set indentation level.
3460 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
3462 * @return {OO.ui.Widget} The widget, for chaining
3464 OO
.ui
.OutlineOptionWidget
.prototype.setLevel = function ( level
) {
3465 var levels
= this.constructor.static.levels
,
3466 levelClass
= this.constructor.static.levelClass
,
3469 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
3471 if ( this.level
=== i
) {
3472 this.$element
.addClass( levelClass
+ i
);
3474 this.$element
.removeClass( levelClass
+ i
);
3477 this.updateThemeClasses();
3483 * OutlineSelectWidget is a structured list that contains {@link OO.ui.OutlineOptionWidget outline options}
3484 * A set of controls can be provided with an {@link OO.ui.OutlineControlsWidget outline controls} widget.
3486 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3489 * @extends OO.ui.SelectWidget
3490 * @mixins OO.ui.mixin.TabIndexedElement
3493 * @param {Object} [config] Configuration options
3495 OO
.ui
.OutlineSelectWidget
= function OoUiOutlineSelectWidget( config
) {
3496 // Parent constructor
3497 OO
.ui
.OutlineSelectWidget
.parent
.call( this, config
);
3499 // Mixin constructors
3500 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3504 focus
: this.bindDocumentKeyDownListener
.bind( this ),
3505 blur
: this.unbindDocumentKeyDownListener
.bind( this )
3509 this.$element
.addClass( 'oo-ui-outlineSelectWidget' );
3514 OO
.inheritClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.SelectWidget
);
3515 OO
.mixinClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3518 * ButtonOptionWidget is a special type of {@link OO.ui.mixin.ButtonElement button element} that
3519 * can be selected and configured with data. The class is
3520 * used with OO.ui.ButtonSelectWidget to create a selection of button options. Please see the
3521 * [OOUI documentation on MediaWiki] [1] for more information.
3523 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Button_selects_and_options
3526 * @extends OO.ui.OptionWidget
3527 * @mixins OO.ui.mixin.ButtonElement
3528 * @mixins OO.ui.mixin.IconElement
3529 * @mixins OO.ui.mixin.IndicatorElement
3530 * @mixins OO.ui.mixin.TitledElement
3533 * @param {Object} [config] Configuration options
3535 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( config
) {
3536 // Configuration initialization
3537 config
= config
|| {};
3539 // Parent constructor
3540 OO
.ui
.ButtonOptionWidget
.parent
.call( this, config
);
3542 // Mixin constructors
3543 OO
.ui
.mixin
.ButtonElement
.call( this, config
);
3544 OO
.ui
.mixin
.IconElement
.call( this, config
);
3545 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3546 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
3549 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
3550 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
3551 this.$element
.append( this.$button
);
3556 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.OptionWidget
);
3557 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.ButtonElement
);
3558 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IconElement
);
3559 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IndicatorElement
);
3560 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.TitledElement
);
3562 /* Static Properties */
3565 * Allow button mouse down events to pass through so they can be handled by the parent select widget
3570 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
3576 OO
.ui
.ButtonOptionWidget
.static.highlightable
= false;
3583 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
3584 OO
.ui
.ButtonOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3586 if ( this.constructor.static.selectable
) {
3587 this.setActive( state
);
3594 * ButtonSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains
3595 * button options and is used together with
3596 * OO.ui.ButtonOptionWidget. The ButtonSelectWidget provides an interface for
3597 * highlighting, choosing, and selecting mutually exclusive options. Please see
3598 * the [OOUI documentation on MediaWiki] [1] for more information.
3601 * // Example: A ButtonSelectWidget that contains three ButtonOptionWidgets
3602 * var option1 = new OO.ui.ButtonOptionWidget( {
3604 * label: 'Option 1',
3605 * title: 'Button option 1'
3608 * var option2 = new OO.ui.ButtonOptionWidget( {
3610 * label: 'Option 2',
3611 * title: 'Button option 2'
3614 * var option3 = new OO.ui.ButtonOptionWidget( {
3616 * label: 'Option 3',
3617 * title: 'Button option 3'
3620 * var buttonSelect=new OO.ui.ButtonSelectWidget( {
3621 * items: [ option1, option2, option3 ]
3623 * $( 'body' ).append( buttonSelect.$element );
3625 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
3628 * @extends OO.ui.SelectWidget
3629 * @mixins OO.ui.mixin.TabIndexedElement
3632 * @param {Object} [config] Configuration options
3634 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
3635 // Parent constructor
3636 OO
.ui
.ButtonSelectWidget
.parent
.call( this, config
);
3638 // Mixin constructors
3639 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3643 focus
: this.bindDocumentKeyDownListener
.bind( this ),
3644 blur
: this.unbindDocumentKeyDownListener
.bind( this )
3648 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
3653 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
3654 OO
.mixinClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3657 * TabOptionWidget is an item in a {@link OO.ui.TabSelectWidget TabSelectWidget}.
3659 * Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}, which contain
3660 * {@link OO.ui.TabPanelLayout tab panel layouts}. See {@link OO.ui.IndexLayout IndexLayout}
3664 * @extends OO.ui.OptionWidget
3667 * @param {Object} [config] Configuration options
3669 OO
.ui
.TabOptionWidget
= function OoUiTabOptionWidget( config
) {
3670 // Configuration initialization
3671 config
= config
|| {};
3673 // Parent constructor
3674 OO
.ui
.TabOptionWidget
.parent
.call( this, config
);
3678 .addClass( 'oo-ui-tabOptionWidget' )
3679 .attr( 'role', 'tab' );
3684 OO
.inheritClass( OO
.ui
.TabOptionWidget
, OO
.ui
.OptionWidget
);
3686 /* Static Properties */
3692 OO
.ui
.TabOptionWidget
.static.highlightable
= false;
3695 * TabSelectWidget is a list that contains {@link OO.ui.TabOptionWidget tab options}
3697 * **Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}.**
3700 * @extends OO.ui.SelectWidget
3701 * @mixins OO.ui.mixin.TabIndexedElement
3704 * @param {Object} [config] Configuration options
3706 OO
.ui
.TabSelectWidget
= function OoUiTabSelectWidget( config
) {
3707 // Parent constructor
3708 OO
.ui
.TabSelectWidget
.parent
.call( this, config
);
3710 // Mixin constructors
3711 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3715 focus
: this.bindDocumentKeyDownListener
.bind( this ),
3716 blur
: this.unbindDocumentKeyDownListener
.bind( this )
3721 .addClass( 'oo-ui-tabSelectWidget' )
3722 .attr( 'role', 'tablist' );
3727 OO
.inheritClass( OO
.ui
.TabSelectWidget
, OO
.ui
.SelectWidget
);
3728 OO
.mixinClass( OO
.ui
.TabSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3731 * TagItemWidgets are used within a {@link OO.ui.TagMultiselectWidget
3732 * TagMultiselectWidget} to display the selected items.
3735 * @extends OO.ui.Widget
3736 * @mixins OO.ui.mixin.ItemWidget
3737 * @mixins OO.ui.mixin.LabelElement
3738 * @mixins OO.ui.mixin.FlaggedElement
3739 * @mixins OO.ui.mixin.TabIndexedElement
3740 * @mixins OO.ui.mixin.DraggableElement
3743 * @param {Object} [config] Configuration object
3744 * @cfg {boolean} [valid=true] Item is valid
3745 * @cfg {boolean} [fixed] Item is fixed. This means the item is
3746 * always included in the values and cannot be removed.
3748 OO
.ui
.TagItemWidget
= function OoUiTagItemWidget( config
) {
3749 config
= config
|| {};
3751 // Parent constructor
3752 OO
.ui
.TagItemWidget
.parent
.call( this, config
);
3754 // Mixin constructors
3755 OO
.ui
.mixin
.ItemWidget
.call( this );
3756 OO
.ui
.mixin
.LabelElement
.call( this, config
);
3757 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
3758 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3759 OO
.ui
.mixin
.DraggableElement
.call( this, config
);
3761 this.valid
= config
.valid
=== undefined ? true : !!config
.valid
;
3762 this.fixed
= !!config
.fixed
;
3764 this.closeButton
= new OO
.ui
.ButtonWidget( {
3768 title
: OO
.ui
.msg( 'ooui-item-remove' )
3770 this.closeButton
.setDisabled( this.isDisabled() );
3774 .connect( this, { click
: 'remove' } );
3776 .on( 'click', this.select
.bind( this ) )
3777 .on( 'keydown', this.onKeyDown
.bind( this ) )
3778 // Prevent propagation of mousedown; the tag item "lives" in the
3779 // clickable area of the TagMultiselectWidget, which listens to
3780 // mousedown to open the menu or popup. We want to prevent that
3781 // for clicks specifically on the tag itself, so the actions taken
3782 // are more deliberate. When the tag is clicked, it will emit the
3783 // selection event (similar to how #OO.ui.MultioptionWidget emits 'change')
3784 // and can be handled separately.
3785 .on( 'mousedown', function ( e
) { e
.stopPropagation(); } );
3789 .addClass( 'oo-ui-tagItemWidget' )
3790 .append( this.$label
, this.closeButton
.$element
);
3793 /* Initialization */
3795 OO
.inheritClass( OO
.ui
.TagItemWidget
, OO
.ui
.Widget
);
3796 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.ItemWidget
);
3797 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.LabelElement
);
3798 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.FlaggedElement
);
3799 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3800 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.DraggableElement
);
3807 * A remove action was performed on the item
3812 * @param {string} direction Direction of the movement, forward or backwards
3814 * A navigate action was performed on the item
3820 * The tag widget was selected. This can occur when the widget
3821 * is either clicked or enter was pressed on it.
3826 * @param {boolean} isValid Item is valid
3828 * Item validity has changed
3833 * @param {boolean} isFixed Item is fixed
3835 * Item fixed state has changed
3841 * Set this item as fixed, meaning it cannot be removed
3843 * @param {string} [state] Item is fixed
3845 * @return {OO.ui.Widget} The widget, for chaining
3847 OO
.ui
.TagItemWidget
.prototype.setFixed = function ( state
) {
3848 state
= state
=== undefined ? !this.fixed
: !!state
;
3850 if ( this.fixed
!== state
) {
3852 if ( this.closeButton
) {
3853 this.closeButton
.toggle( !this.fixed
);
3856 if ( !this.fixed
&& this.elementGroup
&& !this.elementGroup
.isDraggable() ) {
3857 // Only enable the state of the item if the
3858 // entire group is draggable
3859 this.toggleDraggable( !this.fixed
);
3861 this.$element
.toggleClass( 'oo-ui-tagItemWidget-fixed', this.fixed
);
3863 this.emit( 'fixed', this.isFixed() );
3869 * Check whether the item is fixed
3872 OO
.ui
.TagItemWidget
.prototype.isFixed = function () {
3879 OO
.ui
.TagItemWidget
.prototype.setDisabled = function ( state
) {
3880 if ( state
&& this.elementGroup
&& !this.elementGroup
.isDisabled() ) {
3881 OO
.ui
.warnDeprecation( 'TagItemWidget#setDisabled: Disabling individual items is deprecated and will result in inconsistent behavior. Use #setFixed instead. See T193571.' );
3884 OO
.ui
.TagItemWidget
.parent
.prototype.setDisabled
.call( this, state
);
3887 // Verify we have a group, and that the widget is ready
3888 this.toggleDraggable
&& this.elementGroup
&&
3890 !this.elementGroup
.isDraggable()
3892 // Only enable the draggable state of the item if the
3893 // entire group is draggable to begin with, and if the
3894 // item is not fixed
3895 this.toggleDraggable( !state
);
3898 if ( this.closeButton
) {
3899 this.closeButton
.setDisabled( state
);
3906 * Handle removal of the item
3908 * This is mainly for extensibility concerns, so other children
3909 * of this class can change the behavior if they need to. This
3910 * is called by both clicking the 'remove' button but also
3911 * on keypress, which is harder to override if needed.
3915 OO
.ui
.TagItemWidget
.prototype.remove = function () {
3916 if ( !this.isDisabled() && !this.isFixed() ) {
3917 this.emit( 'remove' );
3922 * Handle a keydown event on the widget
3926 * @param {jQuery.Event} e Key down event
3927 * @return {boolean|undefined} false to stop the operation
3929 OO
.ui
.TagItemWidget
.prototype.onKeyDown = function ( e
) {
3932 if ( !this.isDisabled() && !this.isFixed() && e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
|| e
.keyCode
=== OO
.ui
.Keys
.DELETE
) {
3935 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ENTER
) {
3939 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
3940 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
3942 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
3956 e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
3957 movement
.left
: movement
.right
3968 OO
.ui
.TagItemWidget
.prototype.select = function () {
3969 if ( !this.isDisabled() ) {
3970 this.emit( 'select' );
3975 * Set the valid state of this item
3977 * @param {boolean} [valid] Item is valid
3980 OO
.ui
.TagItemWidget
.prototype.toggleValid = function ( valid
) {
3981 valid
= valid
=== undefined ? !this.valid
: !!valid
;
3983 if ( this.valid
!== valid
) {
3986 this.setFlags( { invalid
: !this.valid
} );
3988 this.emit( 'valid', this.valid
);
3993 * Check whether the item is valid
3995 * @return {boolean} Item is valid
3997 OO
.ui
.TagItemWidget
.prototype.isValid = function () {
4002 * A basic tag multiselect widget, similar in concept to {@link OO.ui.ComboBoxInputWidget combo box widget}
4003 * that allows the user to add multiple values that are displayed in a tag area.
4005 * This widget is a base widget; see {@link OO.ui.MenuTagMultiselectWidget MenuTagMultiselectWidget} and
4006 * {@link OO.ui.PopupTagMultiselectWidget PopupTagMultiselectWidget} for the implementations that use
4007 * a menu and a popup respectively.
4010 * // Example: A basic TagMultiselectWidget.
4011 * var widget = new OO.ui.TagMultiselectWidget( {
4012 * inputPosition: 'outline',
4013 * allowedValues: [ 'Option 1', 'Option 2', 'Option 3' ],
4014 * selected: [ 'Option 1' ]
4016 * $( 'body' ).append( widget.$element );
4019 * @extends OO.ui.Widget
4020 * @mixins OO.ui.mixin.GroupWidget
4021 * @mixins OO.ui.mixin.DraggableGroupElement
4022 * @mixins OO.ui.mixin.IndicatorElement
4023 * @mixins OO.ui.mixin.IconElement
4024 * @mixins OO.ui.mixin.TabIndexedElement
4025 * @mixins OO.ui.mixin.FlaggedElement
4028 * @param {Object} config Configuration object
4029 * @cfg {Object} [input] Configuration options for the input widget
4030 * @cfg {OO.ui.InputWidget} [inputWidget] An optional input widget. If given, it will
4031 * replace the input widget used in the TagMultiselectWidget. If not given,
4032 * TagMultiselectWidget creates its own.
4033 * @cfg {boolean} [inputPosition='inline'] Position of the input. Options are:
4034 * - inline: The input is invisible, but exists inside the tag list, so
4035 * the user types into the tag groups to add tags.
4036 * - outline: The input is underneath the tag area.
4037 * - none: No input supplied
4038 * @cfg {boolean} [allowEditTags=true] Allow editing of the tags by clicking them
4039 * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if
4040 * not present in the menu.
4041 * @cfg {Object[]} [allowedValues] An array representing the allowed items
4043 * @cfg {boolean} [allowDuplicates=false] Allow duplicate items to be added
4044 * @cfg {boolean} [allowDisplayInvalidTags=false] Allow the display of
4045 * invalid tags. These tags will display with an invalid state, and
4046 * the widget as a whole will have an invalid state if any invalid tags
4048 * @cfg {number} [limit] An optional limit on the number of selected options.
4049 * If the limit exists and is reached, the input is disabled, not allowing
4050 * for any additions. If the limit is unset or is 0, an unlimited number
4051 * of items can be added.
4052 * @cfg {boolean} [allowReordering=true] Allow reordering of the items
4053 * @cfg {Object[]|String[]} [selected] A set of selected tags. If given,
4054 * these will appear in the tag list on initialization, as long as they
4055 * pass the validity tests.
4057 OO
.ui
.TagMultiselectWidget
= function OoUiTagMultiselectWidget( config
) {
4059 rAF
= window
.requestAnimationFrame
|| setTimeout
,
4061 $tabFocus
= $( '<span>' )
4062 .addClass( 'oo-ui-tagMultiselectWidget-focusTrap' );
4064 config
= config
|| {};
4066 // Parent constructor
4067 OO
.ui
.TagMultiselectWidget
.parent
.call( this, config
);
4069 // Mixin constructors
4070 OO
.ui
.mixin
.GroupWidget
.call( this, config
);
4071 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
4072 OO
.ui
.mixin
.IconElement
.call( this, config
);
4073 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
4074 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
4075 OO
.ui
.mixin
.DraggableGroupElement
.call( this, config
);
4077 this.toggleDraggable(
4078 config
.allowReordering
=== undefined ?
4079 true : !!config
.allowReordering
4082 this.inputPosition
=
4083 this.constructor.static.allowedInputPositions
.indexOf( config
.inputPosition
) > -1 ?
4084 config
.inputPosition
: 'inline';
4085 this.allowEditTags
= config
.allowEditTags
=== undefined ? true : !!config
.allowEditTags
;
4086 this.allowArbitrary
= !!config
.allowArbitrary
;
4087 this.allowDuplicates
= !!config
.allowDuplicates
;
4088 this.allowedValues
= config
.allowedValues
|| [];
4089 this.allowDisplayInvalidTags
= config
.allowDisplayInvalidTags
;
4090 this.hasInput
= this.inputPosition
!== 'none';
4091 this.limit
= config
.limit
;
4095 this.$content
= $( '<div>' )
4096 .addClass( 'oo-ui-tagMultiselectWidget-content' );
4097 this.$handle
= $( '<div>' )
4098 .addClass( 'oo-ui-tagMultiselectWidget-handle' )
4105 .addClass( 'oo-ui-tagMultiselectWidget-group' )
4111 remove
: 'itemRemove',
4112 navigate
: 'itemNavigate',
4113 select
: 'itemSelect',
4116 this.connect( this, {
4117 itemRemove
: 'onTagRemove',
4118 itemSelect
: 'onTagSelect',
4119 itemFixed
: 'onTagFixed',
4120 itemNavigate
: 'onTagNavigate',
4121 change
: 'onChangeTags'
4124 mousedown
: this.onMouseDown
.bind( this )
4129 .addClass( 'oo-ui-tagMultiselectWidget' )
4130 .append( this.$handle
);
4132 if ( this.hasInput
) {
4133 if ( config
.inputWidget
) {
4134 this.input
= config
.inputWidget
;
4136 this.input
= new OO
.ui
.TextInputWidget( $.extend( {
4137 placeholder
: config
.placeholder
,
4138 classes
: [ 'oo-ui-tagMultiselectWidget-input' ]
4139 }, config
.input
) );
4141 this.input
.setDisabled( this.isDisabled() );
4144 focus
: this.onInputFocus
.bind( this ),
4145 blur
: this.onInputBlur
.bind( this ),
4146 'propertychange change click mouseup keydown keyup input cut paste select focus':
4147 OO
.ui
.debounce( this.updateInputSize
.bind( this ) ),
4148 keydown
: this.onInputKeyDown
.bind( this ),
4149 keypress
: this.onInputKeyPress
.bind( this )
4152 this.input
.$input
.on( inputEvents
);
4153 this.inputPlaceholder
= this.input
.$input
.attr( 'placeholder' );
4155 if ( this.inputPosition
=== 'outline' ) {
4156 // Override max-height for the input widget
4157 // in the case the widget is outline so it can
4158 // stretch all the way if the widget is wide
4159 this.input
.$element
.css( 'max-width', 'inherit' );
4161 .addClass( 'oo-ui-tagMultiselectWidget-outlined' )
4162 .append( this.input
.$element
);
4164 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-inlined' );
4165 // HACK: When the widget is using 'inline' input, the
4166 // behavior needs to only use the $input itself
4167 // so we style and size it accordingly (otherwise
4168 // the styling and sizing can get very convoluted
4169 // when the wrapping divs and other elements)
4170 // We are taking advantage of still being able to
4171 // call the widget itself for operations like
4172 // .getValue() and setDisabled() and .focus() but
4173 // having only the $input attached to the DOM
4174 this.$content
.append( this.input
.$input
);
4177 this.$content
.append( $tabFocus
);
4180 this.setTabIndexedElement(
4186 if ( config
.selected
) {
4187 this.setValue( config
.selected
);
4190 // HACK: Input size needs to be calculated after everything
4193 if ( widget
.hasInput
) {
4194 widget
.updateInputSize();
4199 /* Initialization */
4201 OO
.inheritClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.Widget
);
4202 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.GroupWidget
);
4203 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.DraggableGroupElement
);
4204 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IndicatorElement
);
4205 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IconElement
);
4206 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
4207 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.FlaggedElement
);
4209 /* Static properties */
4212 * Allowed input positions.
4213 * - inline: The input is inside the tag list
4214 * - outline: The input is under the tag list
4215 * - none: There is no input
4219 OO
.ui
.TagMultiselectWidget
.static.allowedInputPositions
= [ 'inline', 'outline', 'none' ];
4224 * Handle mouse down events.
4227 * @param {jQuery.Event} e Mouse down event
4228 * @return {boolean} False to prevent defaults
4230 OO
.ui
.TagMultiselectWidget
.prototype.onMouseDown = function ( e
) {
4232 !this.isDisabled() &&
4233 ( !this.hasInput
|| e
.target
!== this.input
.$input
[ 0 ] ) &&
4234 e
.which
=== OO
.ui
.MouseButtons
.LEFT
4242 * Handle key press events.
4245 * @param {jQuery.Event} e Key press event
4246 * @return {boolean} Whether to prevent defaults
4248 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyPress = function ( e
) {
4250 withMetaKey
= e
.metaKey
|| e
.ctrlKey
;
4252 if ( !this.isDisabled() ) {
4253 if ( e
.which
=== OO
.ui
.Keys
.ENTER
) {
4254 stopOrContinue
= this.doInputEnter( e
, withMetaKey
);
4257 // Make sure the input gets resized.
4258 setTimeout( this.updateInputSize
.bind( this ), 0 );
4259 return stopOrContinue
;
4264 * Handle key down events.
4267 * @param {jQuery.Event} e Key down event
4270 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyDown = function ( e
) {
4271 var movement
, direction
,
4273 withMetaKey
= e
.metaKey
|| e
.ctrlKey
,
4274 isMovementInsideInput = function ( direction
) {
4275 var inputRange
= widget
.input
.getRange(),
4276 inputValue
= widget
.hasInput
&& widget
.input
.getValue();
4278 if ( direction
=== 'forwards' && inputRange
.to
> inputValue
.length
- 1 ) {
4282 if ( direction
=== 'backwards' && inputRange
.from <= 0 ) {
4289 if ( !this.isDisabled() ) {
4290 // 'keypress' event is not triggered for Backspace
4291 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
) {
4292 return this.doInputBackspace( e
, withMetaKey
);
4293 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ESCAPE
) {
4294 return this.doInputEscape( e
);
4296 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
4297 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
4299 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
4310 direction
= e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
4311 movement
.left
: movement
.right
;
4313 if ( !this.hasInput
|| !isMovementInsideInput( direction
) ) {
4314 return this.doInputArrow( e
, direction
, withMetaKey
);
4321 * Respond to input focus event
4323 OO
.ui
.TagMultiselectWidget
.prototype.onInputFocus = function () {
4324 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-focus' );
4326 this.toggleValid( true );
4330 * Respond to input blur event
4332 OO
.ui
.TagMultiselectWidget
.prototype.onInputBlur = function () {
4333 this.$element
.removeClass( 'oo-ui-tagMultiselectWidget-focus' );
4335 // Set the widget as invalid if there's text in the input
4336 this.addTagFromInput();
4337 this.toggleValid( this.checkValidity() && ( !this.hasInput
|| !this.input
.getValue() ) );
4341 * Perform an action after the enter key on the input
4343 * @param {jQuery.Event} e Event data
4344 * @param {boolean} [withMetaKey] Whether this key was pressed with
4345 * a meta key like 'ctrl'
4346 * @return {boolean} Whether to prevent defaults
4348 OO
.ui
.TagMultiselectWidget
.prototype.doInputEnter = function () {
4349 this.addTagFromInput();
4354 * Perform an action responding to the enter key on the input
4356 * @param {jQuery.Event} e Event data
4357 * @param {boolean} [withMetaKey] Whether this key was pressed with
4358 * a meta key like 'ctrl'
4359 * @return {boolean} Whether to prevent defaults
4361 OO
.ui
.TagMultiselectWidget
.prototype.doInputBackspace = function ( e
, withMetaKey
) {
4365 this.inputPosition
=== 'inline' &&
4366 this.input
.getValue() === '' &&
4369 // Delete the last item
4370 items
= this.getItems();
4371 item
= items
[ items
.length
- 1 ];
4373 if ( !item
.isDisabled() && !item
.isFixed() ) {
4374 this.removeItems( [ item
] );
4375 // If Ctrl/Cmd was pressed, delete item entirely.
4376 // Otherwise put it into the text field for editing.
4377 if ( !withMetaKey
) {
4378 this.input
.setValue( item
.getData() );
4387 * Perform an action after the escape key on the input
4389 * @param {jQuery.Event} e Event data
4391 OO
.ui
.TagMultiselectWidget
.prototype.doInputEscape = function () {
4396 * Perform an action after the arrow key on the input, select the previous
4397 * item from the input.
4398 * See #getPreviousItem
4400 * @param {jQuery.Event} e Event data
4401 * @param {string} direction Direction of the movement; forwards or backwards
4402 * @param {boolean} [withMetaKey] Whether this key was pressed with
4403 * a meta key like 'ctrl'
4405 OO
.ui
.TagMultiselectWidget
.prototype.doInputArrow = function ( e
, direction
) {
4407 this.inputPosition
=== 'inline' &&
4409 direction
=== 'backwards'
4411 // Get previous item
4412 this.getPreviousItem().focus();
4417 * Respond to item select event
4419 * @param {OO.ui.TagItemWidget} item Selected item
4421 OO
.ui
.TagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
4422 if ( this.hasInput
&& this.allowEditTags
&& !item
.isFixed() ) {
4423 if ( this.input
.getValue() ) {
4424 this.addTagFromInput();
4426 // 1. Get the label of the tag into the input
4427 this.input
.setValue( item
.getData() );
4428 // 2. Remove the tag
4429 this.removeItems( [ item
] );
4430 // 3. Focus the input
4436 * Respond to item fixed state change
4438 * @param {OO.ui.TagItemWidget} item Selected item
4440 OO
.ui
.TagMultiselectWidget
.prototype.onTagFixed = function ( item
) {
4442 items
= this.getItems();
4444 // Move item to the end of the static items
4445 for ( i
= 0; i
< items
.length
; i
++ ) {
4446 if ( items
[ i
] !== item
&& !items
[ i
].isFixed() ) {
4450 this.addItems( item
, i
);
4453 * Respond to change event, where items were added, removed, or cleared.
4455 OO
.ui
.TagMultiselectWidget
.prototype.onChangeTags = function () {
4456 var isUnderLimit
= this.isUnderLimit();
4460 this.checkValidity() &&
4461 ( !this.hasInput
|| !this.input
.getValue() )
4464 if ( this.hasInput
) {
4465 this.updateInputSize();
4466 if ( !isUnderLimit
) {
4468 this.input
.setValue( '' );
4470 if ( this.inputPosition
=== 'outline' ) {
4471 // Show/clear the placeholder and enable/disable the input
4472 // based on whether we are/aren't under the specified limit
4473 this.input
.$input
.attr( 'placeholder', isUnderLimit
? this.inputPlaceholder
: '' );
4474 this.input
.setDisabled( !isUnderLimit
);
4476 // Show/hide the input
4477 this.input
.$input
.toggleClass( 'oo-ui-element-hidden', !isUnderLimit
);
4480 this.updateIfHeightChanged();
4486 OO
.ui
.TagMultiselectWidget
.prototype.setDisabled = function ( isDisabled
) {
4488 OO
.ui
.TagMultiselectWidget
.parent
.prototype.setDisabled
.call( this, isDisabled
);
4490 if ( this.hasInput
&& this.input
) {
4491 this.input
.setDisabled( !!isDisabled
&& !this.isUnderLimit() );
4495 this.getItems().forEach( function ( item
) {
4496 item
.setDisabled( !!isDisabled
);
4502 * Respond to tag remove event
4503 * @param {OO.ui.TagItemWidget} item Removed tag
4505 OO
.ui
.TagMultiselectWidget
.prototype.onTagRemove = function ( item
) {
4506 this.removeTagByData( item
.getData() );
4510 * Respond to navigate event on the tag
4512 * @param {OO.ui.TagItemWidget} item Removed tag
4513 * @param {string} direction Direction of movement; 'forwards' or 'backwards'
4515 OO
.ui
.TagMultiselectWidget
.prototype.onTagNavigate = function ( item
, direction
) {
4516 var firstItem
= this.getItems()[ 0 ];
4518 if ( direction
=== 'forwards' ) {
4519 this.getNextItem( item
).focus();
4520 } else if ( !this.inputPosition
=== 'inline' || item
!== firstItem
) {
4521 // If the widget has an inline input, we want to stop at the starting edge
4523 this.getPreviousItem( item
).focus();
4528 * Add tag from input value
4530 OO
.ui
.TagMultiselectWidget
.prototype.addTagFromInput = function () {
4531 var val
= this.input
.getValue(),
4532 isValid
= this.isAllowedData( val
);
4538 if ( isValid
|| this.allowDisplayInvalidTags
) {
4547 OO
.ui
.TagMultiselectWidget
.prototype.clearInput = function () {
4548 this.input
.setValue( '' );
4552 * Check whether the given value is a duplicate of an existing
4553 * tag already in the list.
4555 * @param {string|Object} data Requested value
4556 * @return {boolean} Value is duplicate
4558 OO
.ui
.TagMultiselectWidget
.prototype.isDuplicateData = function ( data
) {
4559 return !!this.findItemFromData( data
);
4563 * Check whether a given value is allowed to be added
4565 * @param {string|Object} data Requested value
4566 * @return {boolean} Value is allowed
4568 OO
.ui
.TagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
4570 !this.allowDuplicates
&&
4571 this.isDuplicateData( data
)
4576 if ( this.allowArbitrary
) {
4580 // Check with allowed values
4582 this.getAllowedValues().some( function ( value
) {
4583 return data
=== value
;
4593 * Get the allowed values list
4595 * @return {string[]} Allowed data values
4597 OO
.ui
.TagMultiselectWidget
.prototype.getAllowedValues = function () {
4598 return this.allowedValues
;
4602 * Add a value to the allowed values list
4604 * @param {string} value Allowed data value
4606 OO
.ui
.TagMultiselectWidget
.prototype.addAllowedValue = function ( value
) {
4607 if ( this.allowedValues
.indexOf( value
) === -1 ) {
4608 this.allowedValues
.push( value
);
4613 * Get the datas of the currently selected items
4615 * @return {string[]|Object[]} Datas of currently selected items
4617 OO
.ui
.TagMultiselectWidget
.prototype.getValue = function () {
4618 return this.getItems()
4619 .filter( function ( item
) {
4620 return item
.isValid();
4622 .map( function ( item
) {
4623 return item
.getData();
4628 * Set the value of this widget by datas.
4630 * @param {string|string[]|Object|Object[]} valueObject An object representing the data
4631 * and label of the value. If the widget allows arbitrary values,
4632 * the items will be added as-is. Otherwise, the data value will
4633 * be checked against allowedValues.
4634 * This object must contain at least a data key. Example:
4635 * { data: 'foo', label: 'Foo item' }
4636 * For multiple items, use an array of objects. For example:
4638 * { data: 'foo', label: 'Foo item' },
4639 * { data: 'bar', label: 'Bar item' }
4641 * Value can also be added with plaintext array, for example:
4642 * [ 'foo', 'bar', 'bla' ] or a single string, like 'foo'
4644 OO
.ui
.TagMultiselectWidget
.prototype.setValue = function ( valueObject
) {
4645 valueObject
= Array
.isArray( valueObject
) ? valueObject
: [ valueObject
];
4648 valueObject
.forEach( function ( obj
) {
4649 if ( typeof obj
=== 'string' ) {
4652 this.addTag( obj
.data
, obj
.label
);
4658 * Add tag to the display area
4660 * @param {string|Object} data Tag data
4661 * @param {string} [label] Tag label. If no label is provided, the
4662 * stringified version of the data will be used instead.
4663 * @return {boolean} Item was added successfully
4665 OO
.ui
.TagMultiselectWidget
.prototype.addTag = function ( data
, label
) {
4667 isValid
= this.isAllowedData( data
);
4669 if ( this.isUnderLimit() && ( isValid
|| this.allowDisplayInvalidTags
) ) {
4670 newItemWidget
= this.createTagItemWidget( data
, label
);
4671 newItemWidget
.toggleValid( isValid
);
4672 this.addItems( [ newItemWidget
] );
4680 * Check whether the current tags are under the limit. Returns true
4681 * if there is no limit set.
4683 * @return {boolean} True if current tag count is under the limit
4684 * or if there is no limit set
4686 OO
.ui
.TagMultiselectWidget
.prototype.isUnderLimit = function () {
4687 return !this.limit
||
4688 this.getItemCount() < this.limit
;
4692 * Remove tag by its data property.
4694 * @param {string|Object} data Tag data
4696 OO
.ui
.TagMultiselectWidget
.prototype.removeTagByData = function ( data
) {
4697 var item
= this.findItemFromData( data
);
4699 this.removeItems( [ item
] );
4703 * Construct a OO.ui.TagItemWidget (or a subclass thereof) from given label and data.
4706 * @param {string} data Item data
4707 * @param {string} label The label text.
4708 * @return {OO.ui.TagItemWidget}
4710 OO
.ui
.TagMultiselectWidget
.prototype.createTagItemWidget = function ( data
, label
) {
4711 label
= label
|| data
;
4713 return new OO
.ui
.TagItemWidget( { data
: data
, label
: label
} );
4717 * Given an item, returns the item after it. If the item is already the
4718 * last item, return `this.input`. If no item is passed, returns the
4722 * @param {OO.ui.TagItemWidget} [item] Tag item
4723 * @return {OO.ui.Widget} The next widget available.
4725 OO
.ui
.TagMultiselectWidget
.prototype.getNextItem = function ( item
) {
4726 var itemIndex
= this.items
.indexOf( item
);
4728 if ( item
=== undefined || itemIndex
=== -1 ) {
4729 return this.items
[ 0 ];
4732 if ( itemIndex
=== this.items
.length
- 1 ) { // Last item
4733 if ( this.hasInput
) {
4736 // Return first item
4737 return this.items
[ 0 ];
4740 return this.items
[ itemIndex
+ 1 ];
4745 * Given an item, returns the item before it. If the item is already the
4746 * first item, return `this.input`. If no item is passed, returns the
4750 * @param {OO.ui.TagItemWidget} [item] Tag item
4751 * @return {OO.ui.Widget} The previous widget available.
4753 OO
.ui
.TagMultiselectWidget
.prototype.getPreviousItem = function ( item
) {
4754 var itemIndex
= this.items
.indexOf( item
);
4756 if ( item
=== undefined || itemIndex
=== -1 ) {
4757 return this.items
[ this.items
.length
- 1 ];
4760 if ( itemIndex
=== 0 ) {
4761 if ( this.hasInput
) {
4764 // Return the last item
4765 return this.items
[ this.items
.length
- 1 ];
4768 return this.items
[ itemIndex
- 1 ];
4773 * Update the dimensions of the text input field to encompass all available area.
4774 * This is especially relevant for when the input is at the edge of a line
4775 * and should get smaller. The usual operation (as an inline-block with min-width)
4776 * does not work in that case, pushing the input downwards to the next line.
4780 OO
.ui
.TagMultiselectWidget
.prototype.updateInputSize = function () {
4781 var $lastItem
, direction
, contentWidth
, currentWidth
, bestWidth
;
4782 if ( this.inputPosition
=== 'inline' && !this.isDisabled() ) {
4783 if ( this.input
.$input
[ 0 ].scrollWidth
=== 0 ) {
4784 // Input appears to be attached but not visible.
4785 // Don't attempt to adjust its size, because our measurements
4786 // are going to fail anyway.
4789 this.input
.$input
.css( 'width', '1em' );
4790 $lastItem
= this.$group
.children().last();
4791 direction
= OO
.ui
.Element
.static.getDir( this.$handle
);
4793 // Get the width of the input with the placeholder text as
4794 // the value and save it so that we don't keep recalculating
4796 this.contentWidthWithPlaceholder
=== undefined &&
4797 this.input
.getValue() === '' &&
4798 this.input
.$input
.attr( 'placeholder' ) !== undefined
4800 this.input
.setValue( this.input
.$input
.attr( 'placeholder' ) );
4801 this.contentWidthWithPlaceholder
= this.input
.$input
[ 0 ].scrollWidth
;
4802 this.input
.setValue( '' );
4806 // Always keep the input wide enough for the placeholder text
4807 contentWidth
= Math
.max(
4808 this.input
.$input
[ 0 ].scrollWidth
,
4809 // undefined arguments in Math.max lead to NaN
4810 ( this.contentWidthWithPlaceholder
=== undefined ) ?
4811 0 : this.contentWidthWithPlaceholder
4813 currentWidth
= this.input
.$input
.width();
4815 if ( contentWidth
< currentWidth
) {
4816 this.updateIfHeightChanged();
4817 // All is fine, don't perform expensive calculations
4821 if ( $lastItem
.length
=== 0 ) {
4822 bestWidth
= this.$content
.innerWidth();
4824 bestWidth
= direction
=== 'ltr' ?
4825 this.$content
.innerWidth() - $lastItem
.position().left
- $lastItem
.outerWidth() :
4826 $lastItem
.position().left
;
4829 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
4830 // pixels this is off by are coming from.
4832 if ( contentWidth
> bestWidth
) {
4833 // This will result in the input getting shifted to the next line
4834 bestWidth
= this.$content
.innerWidth() - 13;
4836 this.input
.$input
.width( Math
.floor( bestWidth
) );
4837 this.updateIfHeightChanged();
4839 this.updateIfHeightChanged();
4844 * Determine if widget height changed, and if so,
4845 * emit the resize event. This is useful for when there are either
4846 * menus or popups attached to the bottom of the widget, to allow
4847 * them to change their positioning in case the widget moved down
4852 OO
.ui
.TagMultiselectWidget
.prototype.updateIfHeightChanged = function () {
4853 var height
= this.$element
.height();
4854 if ( height
!== this.height
) {
4855 this.height
= height
;
4856 this.emit( 'resize' );
4861 * Check whether all items in the widget are valid
4863 * @return {boolean} Widget is valid
4865 OO
.ui
.TagMultiselectWidget
.prototype.checkValidity = function () {
4866 return this.getItems().every( function ( item
) {
4867 return item
.isValid();
4872 * Set the valid state of this item
4874 * @param {boolean} [valid] Item is valid
4877 OO
.ui
.TagMultiselectWidget
.prototype.toggleValid = function ( valid
) {
4878 valid
= valid
=== undefined ? !this.valid
: !!valid
;
4880 if ( this.valid
!== valid
) {
4883 this.setFlags( { invalid
: !this.valid
} );
4885 this.emit( 'valid', this.valid
);
4890 * Get the current valid state of the widget
4892 * @return {boolean} Widget is valid
4894 OO
.ui
.TagMultiselectWidget
.prototype.isValid = function () {
4899 * PopupTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
4900 * to use a popup. The popup can be configured to have a default input to insert values into the widget.
4903 * // Example: A basic PopupTagMultiselectWidget.
4904 * var widget = new OO.ui.PopupTagMultiselectWidget();
4905 * $( 'body' ).append( widget.$element );
4907 * // Example: A PopupTagMultiselectWidget with an external popup.
4908 * var popupInput = new OO.ui.TextInputWidget(),
4909 * widget = new OO.ui.PopupTagMultiselectWidget( {
4910 * popupInput: popupInput,
4912 * $content: popupInput.$element
4915 * $( 'body' ).append( widget.$element );
4918 * @extends OO.ui.TagMultiselectWidget
4919 * @mixins OO.ui.mixin.PopupElement
4921 * @param {Object} config Configuration object
4922 * @cfg {jQuery} [$overlay] An overlay for the popup.
4923 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
4924 * @cfg {Object} [popup] Configuration options for the popup
4925 * @cfg {OO.ui.InputWidget} [popupInput] An input widget inside the popup that will be
4926 * focused when the popup is opened and will be used as replacement for the
4927 * general input in the widget.
4929 OO
.ui
.PopupTagMultiselectWidget
= function OoUiPopupTagMultiselectWidget( config
) {
4931 defaultConfig
= { popup
: {} };
4933 config
= config
|| {};
4935 // Parent constructor
4936 OO
.ui
.PopupTagMultiselectWidget
.parent
.call( this, $.extend( { inputPosition
: 'none' }, config
) );
4938 this.$overlay
= ( config
.$overlay
=== true ? OO
.ui
.getDefaultOverlay() : config
.$overlay
) || this.$element
;
4940 if ( !config
.popup
) {
4941 // For the default base implementation, we give a popup
4942 // with an input widget inside it. For any other use cases
4943 // the popup needs to be populated externally and the
4944 // event handled to add tags separately and manually
4945 defaultInput
= new OO
.ui
.TextInputWidget();
4947 defaultConfig
.popupInput
= defaultInput
;
4948 defaultConfig
.popup
.$content
= defaultInput
.$element
;
4949 defaultConfig
.popup
.padded
= true;
4951 this.$element
.addClass( 'oo-ui-popupTagMultiselectWidget-defaultPopup' );
4954 // Add overlay, and add that to the autoCloseIgnore
4955 defaultConfig
.popup
.$overlay
= this.$overlay
;
4956 defaultConfig
.popup
.$autoCloseIgnore
= this.hasInput
?
4957 this.input
.$element
.add( this.$overlay
) : this.$overlay
;
4959 // Allow extending any of the above
4960 config
= $.extend( defaultConfig
, config
);
4962 // Mixin constructors
4963 OO
.ui
.mixin
.PopupElement
.call( this, config
);
4965 if ( this.hasInput
) {
4966 this.input
.$input
.on( 'focus', this.popup
.toggle
.bind( this.popup
, true ) );
4969 // Configuration options
4970 this.popupInput
= config
.popupInput
;
4971 if ( this.popupInput
) {
4972 this.popupInput
.connect( this, {
4973 enter
: 'onPopupInputEnter'
4978 this.on( 'resize', this.popup
.updateDimensions
.bind( this.popup
) );
4979 this.popup
.connect( this, { toggle
: 'onPopupToggle' } );
4981 .on( 'focus', this.onFocus
.bind( this ) );
4985 .append( this.popup
.$element
)
4986 .addClass( 'oo-ui-popupTagMultiselectWidget' );
4989 /* Initialization */
4991 OO
.inheritClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
4992 OO
.mixinClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.mixin
.PopupElement
);
4997 * Focus event handler.
5001 OO
.ui
.PopupTagMultiselectWidget
.prototype.onFocus = function () {
5002 this.popup
.toggle( true );
5006 * Respond to popup toggle event
5008 * @param {boolean} isVisible Popup is visible
5010 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupToggle = function ( isVisible
) {
5011 if ( isVisible
&& this.popupInput
) {
5012 this.popupInput
.focus();
5017 * Respond to popup input enter event
5019 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupInputEnter = function () {
5020 if ( this.popupInput
) {
5021 this.addTagByPopupValue( this.popupInput
.getValue() );
5022 this.popupInput
.setValue( '' );
5029 OO
.ui
.PopupTagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
5030 if ( this.popupInput
&& this.allowEditTags
) {
5031 this.popupInput
.setValue( item
.getData() );
5032 this.removeItems( [ item
] );
5034 this.popup
.toggle( true );
5035 this.popupInput
.focus();
5038 OO
.ui
.PopupTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, item
);
5043 * Add a tag by the popup value.
5044 * Whatever is responsible for setting the value in the popup should call
5045 * this method to add a tag, or use the regular methods like #addTag or
5046 * #setValue directly.
5048 * @param {string} data The value of item
5049 * @param {string} [label] The label of the tag. If not given, the data is used.
5051 OO
.ui
.PopupTagMultiselectWidget
.prototype.addTagByPopupValue = function ( data
, label
) {
5052 this.addTag( data
, label
);
5056 * MenuTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
5057 * to use a menu of selectable options.
5060 * // Example: A basic MenuTagMultiselectWidget.
5061 * var widget = new OO.ui.MenuTagMultiselectWidget( {
5062 * inputPosition: 'outline',
5064 * { data: 'option1', label: 'Option 1', icon: 'tag' },
5065 * { data: 'option2', label: 'Option 2' },
5066 * { data: 'option3', label: 'Option 3' },
5068 * selected: [ 'option1', 'option2' ]
5070 * $( 'body' ).append( widget.$element );
5073 * @extends OO.ui.TagMultiselectWidget
5076 * @param {Object} [config] Configuration object
5077 * @cfg {boolean} [clearInputOnChoose=true] Clear the text input value when a menu option is chosen
5078 * @cfg {Object} [menu] Configuration object for the menu widget
5079 * @cfg {jQuery} [$overlay] An overlay for the menu.
5080 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
5081 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
5083 OO
.ui
.MenuTagMultiselectWidget
= function OoUiMenuTagMultiselectWidget( config
) {
5084 config
= config
|| {};
5086 // Parent constructor
5087 OO
.ui
.MenuTagMultiselectWidget
.parent
.call( this, config
);
5089 this.$overlay
= ( config
.$overlay
=== true ? OO
.ui
.getDefaultOverlay() : config
.$overlay
) || this.$element
;
5090 this.clearInputOnChoose
= config
.clearInputOnChoose
=== undefined || !!config
.clearInputOnChoose
;
5091 this.menu
= this.createMenuWidget( $.extend( {
5093 input
: this.hasInput
? this.input
: null,
5094 $input
: this.hasInput
? this.input
.$input
: null,
5095 filterFromInput
: !!this.hasInput
,
5096 $autoCloseIgnore
: this.hasInput
?
5097 this.input
.$element
: $( [] ),
5098 $floatableContainer
: this.hasInput
&& this.inputPosition
=== 'outline' ?
5099 this.input
.$element
: this.$element
,
5100 $overlay
: this.$overlay
,
5101 disabled
: this.isDisabled()
5103 this.addOptions( config
.options
|| [] );
5106 this.menu
.connect( this, {
5107 choose
: 'onMenuChoose',
5108 toggle
: 'onMenuToggle'
5110 if ( this.hasInput
) {
5111 this.input
.connect( this, { change
: 'onInputChange' } );
5113 this.connect( this, { resize
: 'onResize' } );
5117 .append( this.menu
.$element
);
5119 .addClass( 'oo-ui-menuTagMultiselectWidget' );
5120 // TagMultiselectWidget already does this, but it doesn't work right because this.menu is not yet
5121 // set up while the parent constructor runs, and #getAllowedValues rejects everything.
5122 if ( config
.selected
) {
5123 this.setValue( config
.selected
);
5127 /* Initialization */
5129 OO
.inheritClass( OO
.ui
.MenuTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
5134 * Respond to resize event
5136 OO
.ui
.MenuTagMultiselectWidget
.prototype.onResize = function () {
5137 // Reposition the menu
5138 this.menu
.position();
5144 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputFocus = function () {
5146 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
5148 this.menu
.toggle( true );
5154 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputBlur = function () {
5156 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onInputBlur
.call( this );
5158 this.menu
.toggle( false );
5162 * Respond to input change event
5164 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputChange = function () {
5165 this.menu
.toggle( true );
5166 this.initializeMenuSelection();
5170 * Respond to menu choose event
5172 * @param {OO.ui.OptionWidget} menuItem Chosen menu item
5174 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuChoose = function ( menuItem
) {
5176 this.addTag( menuItem
.getData(), menuItem
.getLabel() );
5177 if ( this.hasInput
&& this.clearInputOnChoose
) {
5178 this.input
.setValue( '' );
5183 * Respond to menu toggle event. Reset item highlights on hide.
5185 * @param {boolean} isVisible The menu is visible
5187 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
5189 this.menu
.selectItem( null );
5190 this.menu
.highlightItem( null );
5192 this.initializeMenuSelection();
5199 OO
.ui
.MenuTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
5200 var menuItem
= this.menu
.findItemFromData( tagItem
.getData() );
5201 if ( !this.allowArbitrary
) {
5202 // Override the base behavior from TagMultiselectWidget; the base behavior
5203 // in TagMultiselectWidget is to remove the tag to edit it in the input,
5204 // but in our case, we want to utilize the menu selection behavior, and
5205 // definitely not remove the item.
5207 // If there is an input that is used for filtering, erase the value so we don't filter
5208 if ( this.hasInput
&& this.menu
.filterFromInput
) {
5209 this.input
.setValue( '' );
5212 // Select the menu item
5213 this.menu
.selectItem( menuItem
);
5218 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, tagItem
);
5225 OO
.ui
.MenuTagMultiselectWidget
.prototype.setDisabled = function ( isDisabled
) {
5227 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.setDisabled
.call( this, isDisabled
);
5230 // Protect against calling setDisabled() before the menu was initialized
5231 this.menu
.setDisabled( isDisabled
);
5236 * Highlight the first selectable item in the menu, if configured.
5241 OO
.ui
.MenuTagMultiselectWidget
.prototype.initializeMenuSelection = function () {
5242 if ( !this.menu
.findSelectedItem() ) {
5243 this.menu
.highlightItem( this.menu
.findFirstSelectableItem() );
5250 OO
.ui
.MenuTagMultiselectWidget
.prototype.addTagFromInput = function () {
5251 var inputValue
= this.input
.getValue(),
5253 highlightedItem
= this.menu
.findHighlightedItem(),
5254 item
= this.menu
.findItemFromData( inputValue
);
5256 if ( !inputValue
) {
5260 // Override the parent method so we add from the menu
5261 // rather than directly from the input
5263 // Look for a highlighted item first
5264 if ( highlightedItem
) {
5265 validated
= this.addTag( highlightedItem
.getData(), highlightedItem
.getLabel() );
5266 } else if ( item
) {
5267 // Look for the element that fits the data
5268 validated
= this.addTag( item
.getData(), item
.getLabel() );
5270 // Otherwise, add the tag - the method will only add if the
5271 // tag is valid or if invalid tags are allowed
5272 validated
= this.addTag( inputValue
);
5281 * Return the visible items in the menu. This is mainly used for when
5282 * the menu is filtering results.
5284 * @return {OO.ui.MenuOptionWidget[]} Visible results
5286 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenuVisibleItems = function () {
5287 return this.menu
.getItems().filter( function ( menuItem
) {
5288 return menuItem
.isVisible();
5293 * Create the menu for this widget. This is in a separate method so that
5294 * child classes can override this without polluting the constructor with
5295 * unnecessary extra objects that will be overidden.
5297 * @param {Object} menuConfig Configuration options
5298 * @return {OO.ui.MenuSelectWidget} Menu widget
5300 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
5301 return new OO
.ui
.MenuSelectWidget( menuConfig
);
5305 * Add options to the menu
5307 * @param {Object[]} menuOptions Object defining options
5309 OO
.ui
.MenuTagMultiselectWidget
.prototype.addOptions = function ( menuOptions
) {
5311 items
= menuOptions
.map( function ( obj
) {
5312 return widget
.createMenuOptionWidget( obj
.data
, obj
.label
, obj
.icon
);
5315 this.menu
.addItems( items
);
5319 * Create a menu option widget.
5321 * @param {string} data Item data
5322 * @param {string} [label] Item label
5323 * @param {string} [icon] Symbolic icon name
5324 * @return {OO.ui.OptionWidget} Option widget
5326 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuOptionWidget = function ( data
, label
, icon
) {
5327 return new OO
.ui
.MenuOptionWidget( {
5329 label
: label
|| data
,
5337 * @return {OO.ui.MenuSelectWidget} Menu
5339 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenu = function () {
5344 * Get the allowed values list
5346 * @return {string[]} Allowed data values
5348 OO
.ui
.MenuTagMultiselectWidget
.prototype.getAllowedValues = function () {
5351 // If the parent constructor is calling us, we're not ready yet, this.menu is not set up.
5352 menuDatas
= this.menu
.getItems().map( function ( menuItem
) {
5353 return menuItem
.getData();
5356 return this.allowedValues
.concat( menuDatas
);
5360 * SelectFileWidgets allow for selecting files, using the HTML5 File API. These
5361 * widgets can be configured with {@link OO.ui.mixin.IconElement icons} and {@link
5362 * OO.ui.mixin.IndicatorElement indicators}.
5363 * Please see the [OOUI documentation on MediaWiki] [1] for more information and examples.
5366 * // Example of a file select widget
5367 * var selectFile = new OO.ui.SelectFileWidget();
5368 * $( 'body' ).append( selectFile.$element );
5370 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets
5373 * @extends OO.ui.Widget
5374 * @mixins OO.ui.mixin.IconElement
5375 * @mixins OO.ui.mixin.IndicatorElement
5376 * @mixins OO.ui.mixin.PendingElement
5377 * @mixins OO.ui.mixin.LabelElement
5380 * @param {Object} [config] Configuration options
5381 * @cfg {string[]|null} [accept=null] MIME types to accept. null accepts all types.
5382 * @cfg {string} [placeholder] Text to display when no file is selected.
5383 * @cfg {string} [notsupported] Text to display when file support is missing in the browser.
5384 * @cfg {boolean} [droppable=true] Whether to accept files by drag and drop.
5385 * @cfg {boolean} [showDropTarget=false] Whether to show a drop target. Requires droppable to be true.
5386 * @cfg {number} [thumbnailSizeLimit=20] File size limit in MiB above which to not try and show a
5387 * preview (for performance)
5389 OO
.ui
.SelectFileWidget
= function OoUiSelectFileWidget( config
) {
5392 // Configuration initialization
5393 config
= $.extend( {
5395 placeholder
: OO
.ui
.msg( 'ooui-selectfile-placeholder' ),
5396 notsupported
: OO
.ui
.msg( 'ooui-selectfile-not-supported' ),
5398 showDropTarget
: false,
5399 thumbnailSizeLimit
: 20
5402 // Parent constructor
5403 OO
.ui
.SelectFileWidget
.parent
.call( this, config
);
5405 // Mixin constructors
5406 OO
.ui
.mixin
.IconElement
.call( this, config
);
5407 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
5408 OO
.ui
.mixin
.PendingElement
.call( this, $.extend( {}, config
, { $pending
: this.$info
} ) );
5409 OO
.ui
.mixin
.LabelElement
.call( this, config
);
5412 this.$info
= $( '<span>' );
5413 this.showDropTarget
= config
.showDropTarget
;
5414 this.thumbnailSizeLimit
= config
.thumbnailSizeLimit
;
5415 this.isSupported
= this.constructor.static.isSupported();
5416 this.currentFile
= null;
5417 if ( Array
.isArray( config
.accept
) ) {
5418 this.accept
= config
.accept
;
5422 this.placeholder
= config
.placeholder
;
5423 this.notsupported
= config
.notsupported
;
5424 this.onFileSelectedHandler
= this.onFileSelected
.bind( this );
5426 this.selectButton
= new OO
.ui
.ButtonWidget( {
5427 $element
: $( '<label>' ),
5428 classes
: [ 'oo-ui-selectFileWidget-selectButton' ],
5429 label
: OO
.ui
.msg( 'ooui-selectfile-button-select' ),
5430 disabled
: this.disabled
|| !this.isSupported
5433 this.clearButton
= new OO
.ui
.ButtonWidget( {
5434 classes
: [ 'oo-ui-selectFileWidget-clearButton' ],
5437 disabled
: this.disabled
5441 this.selectButton
.$button
.on( {
5442 keypress
: this.onKeyPress
.bind( this )
5444 this.clearButton
.connect( this, {
5445 click
: 'onClearClick'
5447 if ( config
.droppable
) {
5448 dragHandler
= this.onDragEnterOrOver
.bind( this );
5450 dragenter
: dragHandler
,
5451 dragover
: dragHandler
,
5452 dragleave
: this.onDragLeave
.bind( this ),
5453 drop
: this.onDrop
.bind( this )
5459 this.$label
.addClass( 'oo-ui-selectFileWidget-label' );
5461 .addClass( 'oo-ui-selectFileWidget-info' )
5462 .append( this.$icon
, this.$label
, this.clearButton
.$element
, this.$indicator
);
5464 if ( config
.droppable
&& config
.showDropTarget
) {
5465 this.selectButton
.setIcon( 'upload' );
5466 this.$thumbnail
= $( '<div>' ).addClass( 'oo-ui-selectFileWidget-thumbnail' );
5467 this.setPendingElement( this.$thumbnail
);
5469 .addClass( 'oo-ui-selectFileWidget-dropTarget oo-ui-selectFileWidget' )
5471 click
: this.onDropTargetClick
.bind( this )
5476 this.selectButton
.$element
,
5478 .addClass( 'oo-ui-selectFileWidget-dropLabel' )
5479 .text( OO
.ui
.msg( 'ooui-selectfile-dragdrop-placeholder' ) )
5483 .addClass( 'oo-ui-selectFileWidget' )
5484 .append( this.$info
, this.selectButton
.$element
);
5491 OO
.inheritClass( OO
.ui
.SelectFileWidget
, OO
.ui
.Widget
);
5492 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IconElement
);
5493 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IndicatorElement
);
5494 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.PendingElement
);
5495 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.LabelElement
);
5497 /* Static Properties */
5500 * Check if this widget is supported
5505 OO
.ui
.SelectFileWidget
.static.isSupported = function () {
5507 if ( OO
.ui
.SelectFileWidget
.static.isSupportedCache
=== null ) {
5508 $input
= $( '<input>' ).attr( 'type', 'file' );
5509 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= $input
[ 0 ].files
!== undefined;
5511 return OO
.ui
.SelectFileWidget
.static.isSupportedCache
;
5514 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= null;
5521 * A change event is emitted when the on/off state of the toggle changes.
5523 * @param {File|null} value New value
5529 * Get the current value of the field
5531 * @return {File|null}
5533 OO
.ui
.SelectFileWidget
.prototype.getValue = function () {
5534 return this.currentFile
;
5538 * Set the current value of the field
5540 * @param {File|null} file File to select
5542 OO
.ui
.SelectFileWidget
.prototype.setValue = function ( file
) {
5543 if ( this.currentFile
!== file
) {
5544 this.currentFile
= file
;
5546 this.emit( 'change', this.currentFile
);
5553 * Focusses the select file button.
5556 * @return {OO.ui.Widget} The widget, for chaining
5558 OO
.ui
.SelectFileWidget
.prototype.focus = function () {
5559 this.selectButton
.focus();
5567 * @return {OO.ui.Widget} The widget, for chaining
5569 OO
.ui
.SelectFileWidget
.prototype.blur = function () {
5570 this.selectButton
.blur();
5577 OO
.ui
.SelectFileWidget
.prototype.simulateLabelClick = function () {
5582 * Update the user interface when a file is selected or unselected
5586 OO
.ui
.SelectFileWidget
.prototype.updateUI = function () {
5588 if ( !this.isSupported
) {
5589 this.$element
.addClass( 'oo-ui-selectFileWidget-notsupported' );
5590 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
5591 this.setLabel( this.notsupported
);
5593 this.$element
.addClass( 'oo-ui-selectFileWidget-supported' );
5594 if ( this.currentFile
) {
5595 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
5597 $label
= $label
.add(
5599 .addClass( 'oo-ui-selectFileWidget-fileName' )
5600 .text( this.currentFile
.name
)
5602 this.setLabel( $label
);
5604 if ( this.showDropTarget
) {
5606 this.loadAndGetImageUrl().done( function ( url
) {
5607 this.$thumbnail
.css( 'background-image', 'url( ' + url
+ ' )' );
5608 }.bind( this ) ).fail( function () {
5609 this.$thumbnail
.append(
5610 new OO
.ui
.IconWidget( {
5612 classes
: [ 'oo-ui-selectFileWidget-noThumbnail-icon' ]
5615 }.bind( this ) ).always( function () {
5618 this.$element
.off( 'click' );
5621 if ( this.showDropTarget
) {
5622 this.$element
.off( 'click' );
5624 click
: this.onDropTargetClick
.bind( this )
5628 .css( 'background-image', '' );
5630 this.$element
.addClass( 'oo-ui-selectFileWidget-empty' );
5631 this.setLabel( this.placeholder
);
5637 * If the selected file is an image, get its URL and load it.
5639 * @return {jQuery.Promise} Promise resolves with the image URL after it has loaded
5641 OO
.ui
.SelectFileWidget
.prototype.loadAndGetImageUrl = function () {
5642 var deferred
= $.Deferred(),
5643 file
= this.currentFile
,
5644 reader
= new FileReader();
5648 ( OO
.getProp( file
, 'type' ) || '' ).indexOf( 'image/' ) === 0 &&
5649 file
.size
< this.thumbnailSizeLimit
* 1024 * 1024
5651 reader
.onload = function ( event
) {
5652 var img
= document
.createElement( 'img' );
5653 img
.addEventListener( 'load', function () {
5655 img
.naturalWidth
=== 0 ||
5656 img
.naturalHeight
=== 0 ||
5657 img
.complete
=== false
5661 deferred
.resolve( event
.target
.result
);
5664 img
.src
= event
.target
.result
;
5666 reader
.readAsDataURL( file
);
5671 return deferred
.promise();
5675 * Add the input to the widget
5679 OO
.ui
.SelectFileWidget
.prototype.addInput = function () {
5680 if ( this.$input
) {
5681 this.$input
.remove();
5684 if ( !this.isSupported
) {
5689 this.$input
= $( '<input>' ).attr( 'type', 'file' );
5690 this.$input
.on( 'change', this.onFileSelectedHandler
);
5691 this.$input
.on( 'click', function ( e
) {
5692 // Prevents dropTarget to get clicked which calls
5693 // a click on this input
5694 e
.stopPropagation();
5699 if ( this.accept
) {
5700 this.$input
.attr( 'accept', this.accept
.join( ', ' ) );
5702 this.selectButton
.$button
.append( this.$input
);
5706 * Determine if we should accept this file
5709 * @param {string} mimeType File MIME type
5712 OO
.ui
.SelectFileWidget
.prototype.isAllowedType = function ( mimeType
) {
5715 if ( !this.accept
|| !mimeType
) {
5719 for ( i
= 0; i
< this.accept
.length
; i
++ ) {
5720 mimeTest
= this.accept
[ i
];
5721 if ( mimeTest
=== mimeType
) {
5723 } else if ( mimeTest
.substr( -2 ) === '/*' ) {
5724 mimeTest
= mimeTest
.substr( 0, mimeTest
.length
- 1 );
5725 if ( mimeType
.substr( 0, mimeTest
.length
) === mimeTest
) {
5735 * Handle file selection from the input
5738 * @param {jQuery.Event} e
5740 OO
.ui
.SelectFileWidget
.prototype.onFileSelected = function ( e
) {
5741 var file
= OO
.getProp( e
.target
, 'files', 0 ) || null;
5743 if ( file
&& !this.isAllowedType( file
.type
) ) {
5747 this.setValue( file
);
5752 * Handle clear button click events.
5755 * @return {undefined/boolean} False to prevent default if event is handled
5757 OO
.ui
.SelectFileWidget
.prototype.onClearClick = function () {
5758 this.setValue( null );
5763 * Handle key press events.
5766 * @param {jQuery.Event} e Key press event
5767 * @return {undefined/boolean} False to prevent default if event is handled
5769 OO
.ui
.SelectFileWidget
.prototype.onKeyPress = function ( e
) {
5770 if ( this.isSupported
&& !this.isDisabled() && this.$input
&&
5771 ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
5773 this.$input
.click();
5779 * Handle drop target click events.
5782 * @param {jQuery.Event} e Key press event
5783 * @return {undefined/boolean} False to prevent default if event is handled
5785 OO
.ui
.SelectFileWidget
.prototype.onDropTargetClick = function () {
5786 if ( this.isSupported
&& !this.isDisabled() && this.$input
) {
5787 this.$input
.click();
5793 * Handle drag enter and over events
5796 * @param {jQuery.Event} e Drag event
5797 * @return {undefined/boolean} False to prevent default if event is handled
5799 OO
.ui
.SelectFileWidget
.prototype.onDragEnterOrOver = function ( e
) {
5801 droppableFile
= false,
5802 dt
= e
.originalEvent
.dataTransfer
;
5805 e
.stopPropagation();
5807 if ( this.isDisabled() || !this.isSupported
) {
5808 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
5809 dt
.dropEffect
= 'none';
5813 // DataTransferItem and File both have a type property, but in Chrome files
5814 // have no information at this point.
5815 itemOrFile
= OO
.getProp( dt
, 'items', 0 ) || OO
.getProp( dt
, 'files', 0 );
5817 if ( this.isAllowedType( itemOrFile
.type
) ) {
5818 droppableFile
= true;
5820 // dt.types is Array-like, but not an Array
5821 } else if ( Array
.prototype.indexOf
.call( OO
.getProp( dt
, 'types' ) || [], 'Files' ) !== -1 ) {
5822 // File information is not available at this point for security so just assume
5823 // it is acceptable for now.
5824 // https://bugzilla.mozilla.org/show_bug.cgi?id=640534
5825 droppableFile
= true;
5828 this.$element
.toggleClass( 'oo-ui-selectFileWidget-canDrop', droppableFile
);
5829 if ( !droppableFile
) {
5830 dt
.dropEffect
= 'none';
5837 * Handle drag leave events
5840 * @param {jQuery.Event} e Drag event
5842 OO
.ui
.SelectFileWidget
.prototype.onDragLeave = function () {
5843 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
5847 * Handle drop events
5850 * @param {jQuery.Event} e Drop event
5851 * @return {undefined/boolean} False to prevent default if event is handled
5853 OO
.ui
.SelectFileWidget
.prototype.onDrop = function ( e
) {
5855 dt
= e
.originalEvent
.dataTransfer
;
5858 e
.stopPropagation();
5859 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
5861 if ( this.isDisabled() || !this.isSupported
) {
5865 file
= OO
.getProp( dt
, 'files', 0 );
5866 if ( file
&& !this.isAllowedType( file
.type
) ) {
5870 this.setValue( file
);
5879 OO
.ui
.SelectFileWidget
.prototype.setDisabled = function ( disabled
) {
5880 OO
.ui
.SelectFileWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
5881 if ( this.selectButton
) {
5882 this.selectButton
.setDisabled( disabled
);
5884 if ( this.clearButton
) {
5885 this.clearButton
.setDisabled( disabled
);
5891 * SearchWidgets combine a {@link OO.ui.TextInputWidget text input field}, where users can type a search query,
5892 * and a menu of search results, which is displayed beneath the query
5893 * field. Unlike {@link OO.ui.mixin.LookupElement lookup menus}, search result menus are always visible to the user.
5894 * Users can choose an item from the menu or type a query into the text field to search for a matching result item.
5895 * In general, search widgets are used inside a separate {@link OO.ui.Dialog dialog} window.
5897 * Each time the query is changed, the search result menu is cleared and repopulated. Please see
5898 * the [OOUI demos][1] for an example.
5900 * [1]: https://doc.wikimedia.org/oojs-ui/master/demos/#SearchInputWidget-type-search
5903 * @extends OO.ui.Widget
5906 * @param {Object} [config] Configuration options
5907 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
5908 * @cfg {string} [value] Initial query value
5910 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
5911 // Configuration initialization
5912 config
= config
|| {};
5914 // Parent constructor
5915 OO
.ui
.SearchWidget
.parent
.call( this, config
);
5918 this.query
= new OO
.ui
.TextInputWidget( {
5920 placeholder
: config
.placeholder
,
5923 this.results
= new OO
.ui
.SelectWidget();
5924 this.$query
= $( '<div>' );
5925 this.$results
= $( '<div>' );
5928 this.query
.connect( this, {
5929 change
: 'onQueryChange',
5930 enter
: 'onQueryEnter'
5932 this.query
.$input
.on( 'keydown', this.onQueryKeydown
.bind( this ) );
5936 .addClass( 'oo-ui-searchWidget-query' )
5937 .append( this.query
.$element
);
5939 .addClass( 'oo-ui-searchWidget-results' )
5940 .append( this.results
.$element
);
5942 .addClass( 'oo-ui-searchWidget' )
5943 .append( this.$results
, this.$query
);
5948 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
5953 * Handle query key down events.
5956 * @param {jQuery.Event} e Key down event
5958 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
5959 var highlightedItem
, nextItem
,
5960 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
5963 highlightedItem
= this.results
.findHighlightedItem();
5964 if ( !highlightedItem
) {
5965 highlightedItem
= this.results
.findSelectedItem();
5967 nextItem
= this.results
.findRelativeSelectableItem( highlightedItem
, dir
);
5968 this.results
.highlightItem( nextItem
);
5969 nextItem
.scrollElementIntoView();
5974 * Handle select widget select events.
5976 * Clears existing results. Subclasses should repopulate items according to new query.
5979 * @param {string} value New value
5981 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
5983 this.results
.clearItems();
5987 * Handle select widget enter key events.
5989 * Chooses highlighted item.
5992 * @param {string} value New value
5994 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
5995 var highlightedItem
= this.results
.findHighlightedItem();
5996 if ( highlightedItem
) {
5997 this.results
.chooseItem( highlightedItem
);
6002 * Get the query input.
6004 * @return {OO.ui.TextInputWidget} Query input
6006 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
6011 * Get the search results menu.
6013 * @return {OO.ui.SelectWidget} Menu of search results
6015 OO
.ui
.SearchWidget
.prototype.getResults = function () {
6016 return this.results
;
6021 //# sourceMappingURL=oojs-ui-widgets.js.map.json