3 * https://www.mediawiki.org/wiki/OOUI
5 * Copyright 2011–2019 OOUI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
9 * Date: 2019-02-21T10:57:07Z
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 * $( document.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 // Make the layout scrollable in continuous mode, otherwise each
1305 // panel is responsible for its own scrolling.
1306 config
= $.extend( { scrollable
: !!( config
&& config
.continuous
) }, config
);
1308 // Parent constructor
1309 OO
.ui
.StackLayout
.parent
.call( this, config
);
1311 // Mixin constructors
1312 OO
.ui
.mixin
.GroupElement
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
1315 this.currentItem
= null;
1316 this.continuous
= !!config
.continuous
;
1319 this.$element
.addClass( 'oo-ui-stackLayout' );
1320 if ( this.continuous
) {
1321 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
1322 this.$element
.on( 'scroll', OO
.ui
.debounce( this.onScroll
.bind( this ), 250 ) );
1324 if ( Array
.isArray( config
.items
) ) {
1325 this.addItems( config
.items
);
1331 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
1332 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.mixin
.GroupElement
);
1337 * A 'set' event is emitted when panels are {@link #addItems added}, {@link #removeItems removed},
1338 * {@link #clearItems cleared} or {@link #setItem displayed}.
1341 * @param {OO.ui.Layout|null} item Current panel or `null` if no panel is shown
1345 * When used in continuous mode, this event is emitted when the user scrolls down
1346 * far enough such that currentItem is no longer visible.
1348 * @event visibleItemChange
1349 * @param {OO.ui.PanelLayout} panel The next visible item in the layout
1355 * Handle scroll events from the layout element
1357 * @param {jQuery.Event} e
1358 * @fires visibleItemChange
1360 OO
.ui
.StackLayout
.prototype.onScroll = function () {
1362 len
= this.items
.length
,
1363 currentIndex
= this.items
.indexOf( this.currentItem
),
1364 newIndex
= currentIndex
,
1365 containerRect
= this.$element
[ 0 ].getBoundingClientRect();
1367 if ( !containerRect
|| ( !containerRect
.top
&& !containerRect
.bottom
) ) {
1368 // Can't get bounding rect, possibly not attached.
1372 function getRect( item
) {
1373 return item
.$element
[ 0 ].getBoundingClientRect();
1376 function isVisible( item
) {
1377 var rect
= getRect( item
);
1378 return rect
.bottom
> containerRect
.top
&& rect
.top
< containerRect
.bottom
;
1381 currentRect
= getRect( this.currentItem
);
1383 if ( currentRect
.bottom
< containerRect
.top
) {
1384 // Scrolled down past current item
1385 while ( ++newIndex
< len
) {
1386 if ( isVisible( this.items
[ newIndex
] ) ) {
1390 } else if ( currentRect
.top
> containerRect
.bottom
) {
1391 // Scrolled up past current item
1392 while ( --newIndex
>= 0 ) {
1393 if ( isVisible( this.items
[ newIndex
] ) ) {
1399 if ( newIndex
!== currentIndex
) {
1400 this.emit( 'visibleItemChange', this.items
[ newIndex
] );
1405 * Get the current panel.
1407 * @return {OO.ui.Layout|null}
1409 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
1410 return this.currentItem
;
1414 * Unset the current item.
1417 * @param {OO.ui.StackLayout} layout
1420 OO
.ui
.StackLayout
.prototype.unsetCurrentItem = function () {
1421 var prevItem
= this.currentItem
;
1422 if ( prevItem
=== null ) {
1426 this.currentItem
= null;
1427 this.emit( 'set', null );
1431 * Add panel layouts to the stack layout.
1433 * Panels will be added to the end of the stack layout array unless the optional index parameter specifies a different
1434 * insertion point. Adding a panel that is already in the stack will move it to the end of the array or the point specified
1437 * @param {OO.ui.Layout[]} items Panels to add
1438 * @param {number} [index] Index of the insertion point
1440 * @return {OO.ui.StackLayout} The layout, for chaining
1442 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
1443 // Update the visibility
1444 this.updateHiddenState( items
, this.currentItem
);
1447 OO
.ui
.mixin
.GroupElement
.prototype.addItems
.call( this, items
, index
);
1449 if ( !this.currentItem
&& items
.length
) {
1450 this.setItem( items
[ 0 ] );
1457 * Remove the specified panels from the stack layout.
1459 * Removed panels are detached from the DOM, not removed, so that they may be reused. To remove all panels,
1460 * you may wish to use the #clearItems method instead.
1462 * @param {OO.ui.Layout[]} items Panels to remove
1464 * @return {OO.ui.StackLayout} The layout, for chaining
1467 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
1469 OO
.ui
.mixin
.GroupElement
.prototype.removeItems
.call( this, items
);
1471 if ( items
.indexOf( this.currentItem
) !== -1 ) {
1472 if ( this.items
.length
) {
1473 this.setItem( this.items
[ 0 ] );
1475 this.unsetCurrentItem();
1483 * Clear all panels from the stack layout.
1485 * Cleared panels are detached from the DOM, not removed, so that they may be reused. To remove only
1486 * a subset of panels, use the #removeItems method.
1489 * @return {OO.ui.StackLayout} The layout, for chaining
1492 OO
.ui
.StackLayout
.prototype.clearItems = function () {
1493 this.unsetCurrentItem();
1494 OO
.ui
.mixin
.GroupElement
.prototype.clearItems
.call( this );
1500 * Show the specified panel.
1502 * If another panel is currently displayed, it will be hidden.
1504 * @param {OO.ui.Layout} item Panel to show
1506 * @return {OO.ui.StackLayout} The layout, for chaining
1509 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
1510 if ( item
!== this.currentItem
) {
1511 this.updateHiddenState( this.items
, item
);
1513 if ( this.items
.indexOf( item
) !== -1 ) {
1514 this.currentItem
= item
;
1515 this.emit( 'set', item
);
1517 this.unsetCurrentItem();
1525 * Reset the scroll offset of all panels, or the container if continuous
1529 OO
.ui
.StackLayout
.prototype.resetScroll = function () {
1530 if ( this.continuous
) {
1532 return OO
.ui
.StackLayout
.parent
.prototype.resetScroll
.call( this );
1535 this.getItems().forEach( function ( panel
) {
1536 var hidden
= panel
.$element
.hasClass( 'oo-ui-element-hidden' );
1537 // Scroll can only be reset when panel is visible
1538 panel
.$element
.removeClass( 'oo-ui-element-hidden' );
1539 panel
.resetScroll();
1541 panel
.$element
.addClass( 'oo-ui-element-hidden' );
1549 * Update the visibility of all items in case of non-continuous view.
1551 * Ensure all items are hidden except for the selected one.
1552 * This method does nothing when the stack is continuous.
1555 * @param {OO.ui.Layout[]} items Item list iterate over
1556 * @param {OO.ui.Layout} [selectedItem] Selected item to show
1558 OO
.ui
.StackLayout
.prototype.updateHiddenState = function ( items
, selectedItem
) {
1561 if ( !this.continuous
) {
1562 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
1563 if ( !selectedItem
|| selectedItem
!== items
[ i
] ) {
1564 items
[ i
].$element
.addClass( 'oo-ui-element-hidden' );
1565 items
[ i
].$element
.attr( 'aria-hidden', 'true' );
1568 if ( selectedItem
) {
1569 selectedItem
.$element
.removeClass( 'oo-ui-element-hidden' );
1570 selectedItem
.$element
.removeAttr( 'aria-hidden' );
1576 * 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)
1577 * and its size is customized with the #menuSize config. The content area will fill all remaining space.
1581 * menuPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1582 * contentPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1583 * select = new OO.ui.SelectWidget( {
1585 * new OO.ui.OptionWidget( {
1589 * new OO.ui.OptionWidget( {
1593 * new OO.ui.OptionWidget( {
1597 * new OO.ui.OptionWidget( {
1602 * } ).on( 'select', function ( item ) {
1603 * menuLayout.setMenuPosition( item.getData() );
1606 * menuLayout = new OO.ui.MenuLayout( {
1608 * menuPanel: menuPanel,
1609 * contentPanel: contentPanel
1611 * menuLayout.$menu.append(
1612 * menuPanel.$element.append( '<b>Menu panel</b>', select.$element )
1614 * menuLayout.$content.append(
1615 * contentPanel.$element.append( '<b>Content panel</b>', '<p>Note that the menu is positioned relative to the content panel: top, bottom, after, before.</p>')
1617 * $( document.body ).append( menuLayout.$element );
1619 * If menu size needs to be overridden, it can be accomplished using CSS similar to the snippet
1620 * below. MenuLayout's CSS will override the appropriate values with 'auto' or '0' to display the
1621 * menu correctly. If `menuPosition` is known beforehand, CSS rules corresponding to other positions
1624 * .oo-ui-menuLayout-menu {
1629 * .oo-ui-menuLayout-content {
1637 * @extends OO.ui.Layout
1640 * @param {Object} [config] Configuration options
1641 * @cfg {OO.ui.PanelLayout} [menuPanel] Menu panel
1642 * @cfg {OO.ui.PanelLayout} [contentPanel] Content panel
1643 * @cfg {boolean} [expanded=true] Expand the layout to fill the entire parent element.
1644 * @cfg {boolean} [showMenu=true] Show menu
1645 * @cfg {string} [menuPosition='before'] Position of menu: `top`, `after`, `bottom` or `before`
1647 OO
.ui
.MenuLayout
= function OoUiMenuLayout( config
) {
1648 // Configuration initialization
1649 config
= $.extend( {
1652 menuPosition
: 'before'
1655 // Parent constructor
1656 OO
.ui
.MenuLayout
.parent
.call( this, config
);
1658 this.menuPanel
= null;
1659 this.contentPanel
= null;
1660 this.expanded
= !!config
.expanded
;
1664 * @property {jQuery}
1666 this.$menu
= $( '<div>' );
1670 * @property {jQuery}
1672 this.$content
= $( '<div>' );
1676 .addClass( 'oo-ui-menuLayout-menu' );
1677 this.$content
.addClass( 'oo-ui-menuLayout-content' );
1679 .addClass( 'oo-ui-menuLayout' );
1680 if ( config
.expanded
) {
1681 this.$element
.addClass( 'oo-ui-menuLayout-expanded' );
1683 this.$element
.addClass( 'oo-ui-menuLayout-static' );
1685 if ( config
.menuPanel
) {
1686 this.setMenuPanel( config
.menuPanel
);
1688 if ( config
.contentPanel
) {
1689 this.setContentPanel( config
.contentPanel
);
1691 this.setMenuPosition( config
.menuPosition
);
1692 this.toggleMenu( config
.showMenu
);
1697 OO
.inheritClass( OO
.ui
.MenuLayout
, OO
.ui
.Layout
);
1704 * @param {boolean} showMenu Show menu, omit to toggle
1706 * @return {OO.ui.MenuLayout} The layout, for chaining
1708 OO
.ui
.MenuLayout
.prototype.toggleMenu = function ( showMenu
) {
1709 showMenu
= showMenu
=== undefined ? !this.showMenu
: !!showMenu
;
1711 if ( this.showMenu
!== showMenu
) {
1712 this.showMenu
= showMenu
;
1714 .toggleClass( 'oo-ui-menuLayout-showMenu', this.showMenu
)
1715 .toggleClass( 'oo-ui-menuLayout-hideMenu', !this.showMenu
);
1716 this.$menu
.attr( 'aria-hidden', this.showMenu
? 'false' : 'true' );
1723 * Check if menu is visible
1725 * @return {boolean} Menu is visible
1727 OO
.ui
.MenuLayout
.prototype.isMenuVisible = function () {
1728 return this.showMenu
;
1732 * Set menu position.
1734 * @param {string} position Position of menu, either `top`, `after`, `bottom` or `before`
1735 * @throws {Error} If position value is not supported
1737 * @return {OO.ui.MenuLayout} The layout, for chaining
1739 OO
.ui
.MenuLayout
.prototype.setMenuPosition = function ( position
) {
1740 this.$element
.removeClass( 'oo-ui-menuLayout-' + this.menuPosition
);
1741 this.menuPosition
= position
;
1742 if ( this.menuPosition
=== 'top' || this.menuPosition
=== 'before' ) {
1743 this.$element
.append( this.$menu
, this.$content
);
1745 this.$element
.append( this.$content
, this.$menu
);
1747 this.$element
.addClass( 'oo-ui-menuLayout-' + position
);
1753 * Get menu position.
1755 * @return {string} Menu position
1757 OO
.ui
.MenuLayout
.prototype.getMenuPosition = function () {
1758 return this.menuPosition
;
1762 * Set the menu panel.
1764 * @param {OO.ui.PanelLayout} menuPanel Menu panel
1766 OO
.ui
.MenuLayout
.prototype.setMenuPanel = function ( menuPanel
) {
1767 this.menuPanel
= menuPanel
;
1768 this.$menu
.append( this.menuPanel
.$element
);
1772 * Set the content panel.
1774 * @param {OO.ui.PanelLayout} contentPanel Content panel
1776 OO
.ui
.MenuLayout
.prototype.setContentPanel = function ( contentPanel
) {
1777 this.contentPanel
= contentPanel
;
1778 this.$content
.append( this.contentPanel
.$element
);
1782 * Clear the menu panel.
1784 OO
.ui
.MenuLayout
.prototype.clearMenuPanel = function () {
1785 this.menuPanel
= null;
1790 * Clear the content panel.
1792 OO
.ui
.MenuLayout
.prototype.clearContentPanel = function () {
1793 this.contentPanel
= null;
1794 this.$content
.empty();
1798 * Reset the scroll offset of all panels and the tab select widget
1802 OO
.ui
.MenuLayout
.prototype.resetScroll = function () {
1803 if ( this.menuPanel
) {
1804 this.menuPanel
.resetScroll();
1806 if ( this.contentPanel
) {
1807 this.contentPanel
.resetScroll();
1814 * BookletLayouts contain {@link OO.ui.PageLayout page layouts} as well as
1815 * an {@link OO.ui.OutlineSelectWidget outline} that allows users to easily navigate
1816 * through the pages and select which one to display. By default, only one page is
1817 * displayed at a time and the outline is hidden. When a user navigates to a new page,
1818 * the booklet layout automatically focuses on the first focusable element, unless the
1819 * default setting is changed. Optionally, booklets can be configured to show
1820 * {@link OO.ui.OutlineControlsWidget controls} for adding, moving, and removing items.
1823 * // Example of a BookletLayout that contains two PageLayouts.
1825 * function PageOneLayout( name, config ) {
1826 * PageOneLayout.parent.call( this, name, config );
1827 * this.$element.append( '<p>First page</p><p>(This booklet has an outline, displayed on the left)</p>' );
1829 * OO.inheritClass( PageOneLayout, OO.ui.PageLayout );
1830 * PageOneLayout.prototype.setupOutlineItem = function () {
1831 * this.outlineItem.setLabel( 'Page One' );
1834 * function PageTwoLayout( name, config ) {
1835 * PageTwoLayout.parent.call( this, name, config );
1836 * this.$element.append( '<p>Second page</p>' );
1838 * OO.inheritClass( PageTwoLayout, OO.ui.PageLayout );
1839 * PageTwoLayout.prototype.setupOutlineItem = function () {
1840 * this.outlineItem.setLabel( 'Page Two' );
1843 * var page1 = new PageOneLayout( 'one' ),
1844 * page2 = new PageTwoLayout( 'two' );
1846 * var booklet = new OO.ui.BookletLayout( {
1850 * booklet.addPages( [ page1, page2 ] );
1851 * $( document.body ).append( booklet.$element );
1854 * @extends OO.ui.MenuLayout
1857 * @param {Object} [config] Configuration options
1858 * @cfg {boolean} [continuous=false] Show all pages, one after another
1859 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new page is displayed. Disabled on mobile.
1860 * @cfg {boolean} [outlined=false] Show the outline. The outline is used to navigate through the pages of the booklet.
1861 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
1863 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
1864 // Configuration initialization
1865 config
= config
|| {};
1867 // Parent constructor
1868 OO
.ui
.BookletLayout
.parent
.call( this, config
);
1871 this.currentPageName
= null;
1873 this.ignoreFocus
= false;
1874 this.stackLayout
= new OO
.ui
.StackLayout( {
1875 continuous
: !!config
.continuous
,
1876 expanded
: this.expanded
1878 this.setContentPanel( this.stackLayout
);
1879 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
1880 this.outlineVisible
= false;
1881 this.outlined
= !!config
.outlined
;
1882 if ( this.outlined
) {
1883 this.editable
= !!config
.editable
;
1884 this.outlineControlsWidget
= null;
1885 this.outlineSelectWidget
= new OO
.ui
.OutlineSelectWidget();
1886 this.outlinePanel
= new OO
.ui
.PanelLayout( {
1887 expanded
: this.expanded
,
1890 this.setMenuPanel( this.outlinePanel
);
1891 this.outlineVisible
= true;
1892 if ( this.editable
) {
1893 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
1894 this.outlineSelectWidget
1898 this.toggleMenu( this.outlined
);
1901 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
1902 if ( this.outlined
) {
1903 this.outlineSelectWidget
.connect( this, { select
: 'onOutlineSelectWidgetSelect' } );
1904 this.scrolling
= false;
1905 this.stackLayout
.connect( this, { visibleItemChange
: 'onStackLayoutVisibleItemChange' } );
1907 if ( this.autoFocus
) {
1908 // Event 'focus' does not bubble, but 'focusin' does
1909 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
1913 this.$element
.addClass( 'oo-ui-bookletLayout' );
1914 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
1915 if ( this.outlined
) {
1916 this.outlinePanel
.$element
1917 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
1918 .append( this.outlineSelectWidget
.$element
);
1919 if ( this.editable
) {
1920 this.outlinePanel
.$element
1921 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
1922 .append( this.outlineControlsWidget
.$element
);
1929 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.MenuLayout
);
1934 * A 'set' event is emitted when a page is {@link #setPage set} to be displayed by the booklet layout.
1936 * @param {OO.ui.PageLayout} page Current page
1940 * An 'add' event is emitted when pages are {@link #addPages added} to the booklet layout.
1943 * @param {OO.ui.PageLayout[]} page Added pages
1944 * @param {number} index Index pages were added at
1948 * A 'remove' event is emitted when pages are {@link #clearPages cleared} or
1949 * {@link #removePages removed} from the booklet.
1952 * @param {OO.ui.PageLayout[]} pages Removed pages
1958 * Handle stack layout focus.
1961 * @param {jQuery.Event} e Focusin event
1963 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
1966 // Find the page that an element was focused within
1967 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
1968 for ( name
in this.pages
) {
1969 // Check for page match, exclude current page to find only page changes
1970 if ( this.pages
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentPageName
) {
1971 this.setPage( name
);
1978 * Handle visibleItemChange events from the stackLayout
1980 * The next visible page is set as the current page by selecting it
1983 * @param {OO.ui.PageLayout} page The next visible page in the layout
1985 OO
.ui
.BookletLayout
.prototype.onStackLayoutVisibleItemChange = function ( page
) {
1986 // Set a flag to so that the resulting call to #onStackLayoutSet doesn't
1987 // try and scroll the item into view again.
1988 this.scrolling
= true;
1989 this.outlineSelectWidget
.selectItemByData( page
.getName() );
1990 this.scrolling
= false;
1994 * Handle stack layout set events.
1997 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
1999 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
2000 var promise
, layout
= this;
2001 // If everything is unselected, do nothing
2005 // For continuous BookletLayouts, scroll the selected page into view first
2006 if ( this.stackLayout
.continuous
&& !this.scrolling
) {
2007 promise
= page
.scrollElementIntoView();
2009 promise
= $.Deferred().resolve();
2011 // Focus the first element on the newly selected panel.
2012 // Don't focus if the page was set by scrolling.
2013 if ( this.autoFocus
&& !OO
.ui
.isMobile() && !this.scrolling
) {
2014 promise
.done( function () {
2021 * Focus the first input in the current page.
2023 * If no page is selected, the first selectable page will be selected.
2024 * If the focus is already in an element on the current page, nothing will happen.
2026 * @param {number} [itemIndex] A specific item to focus on
2028 OO
.ui
.BookletLayout
.prototype.focus = function ( itemIndex
) {
2030 items
= this.stackLayout
.getItems();
2032 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
2033 page
= items
[ itemIndex
];
2035 page
= this.stackLayout
.getCurrentItem();
2038 if ( !page
&& this.outlined
) {
2039 this.selectFirstSelectablePage();
2040 page
= this.stackLayout
.getCurrentItem();
2045 // Only change the focus if is not already in the current page
2046 if ( !OO
.ui
.contains( page
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
2052 * Find the first focusable input in the booklet layout and focus
2055 OO
.ui
.BookletLayout
.prototype.focusFirstFocusable = function () {
2056 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
2060 * Handle outline widget select events.
2063 * @param {OO.ui.OptionWidget|null} item Selected item
2065 OO
.ui
.BookletLayout
.prototype.onOutlineSelectWidgetSelect = function ( item
) {
2067 this.setPage( item
.getData() );
2072 * Check if booklet has an outline.
2074 * @return {boolean} Booklet has an outline
2076 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
2077 return this.outlined
;
2081 * Check if booklet has editing controls.
2083 * @return {boolean} Booklet is editable
2085 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
2086 return this.editable
;
2090 * Check if booklet has a visible outline.
2092 * @return {boolean} Outline is visible
2094 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
2095 return this.outlined
&& this.outlineVisible
;
2099 * Hide or show the outline.
2101 * @param {boolean} [show] Show outline, omit to invert current state
2103 * @return {OO.ui.BookletLayout} The layout, for chaining
2105 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
2108 if ( this.outlined
) {
2109 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
2110 this.outlineVisible
= show
;
2111 this.toggleMenu( show
);
2112 if ( show
&& this.editable
) {
2113 // HACK: Kill dumb scrollbars when the sidebar stops animating, see T161798. Only necessary when
2114 // outline controls are present, delay matches transition on `.oo-ui-menuLayout-menu`.
2115 setTimeout( function () {
2116 OO
.ui
.Element
.static.reconsiderScrollbars( booklet
.outlinePanel
.$element
[ 0 ] );
2117 }, OO
.ui
.theme
.getDialogTransitionDuration() );
2125 * Find the page closest to the specified page.
2127 * @param {OO.ui.PageLayout} page Page to use as a reference point
2128 * @return {OO.ui.PageLayout|null} Page closest to the specified page
2130 OO
.ui
.BookletLayout
.prototype.findClosestPage = function ( page
) {
2131 var next
, prev
, level
,
2132 pages
= this.stackLayout
.getItems(),
2133 index
= pages
.indexOf( page
);
2135 if ( index
!== -1 ) {
2136 next
= pages
[ index
+ 1 ];
2137 prev
= pages
[ index
- 1 ];
2138 // Prefer adjacent pages at the same level
2139 if ( this.outlined
) {
2140 level
= this.outlineSelectWidget
.findItemFromData( page
.getName() ).getLevel();
2143 level
=== this.outlineSelectWidget
.findItemFromData( prev
.getName() ).getLevel()
2149 level
=== this.outlineSelectWidget
.findItemFromData( next
.getName() ).getLevel()
2155 return prev
|| next
|| null;
2159 * Get the outline widget.
2161 * If the booklet is not outlined, the method will return `null`.
2163 * @return {OO.ui.OutlineSelectWidget|null} Outline widget, or null if the booklet is not outlined
2165 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
2166 return this.outlineSelectWidget
;
2170 * Get the outline controls widget.
2172 * If the outline is not editable, the method will return `null`.
2174 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
2176 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
2177 return this.outlineControlsWidget
;
2181 * Get a page by its symbolic name.
2183 * @param {string} name Symbolic name of page
2184 * @return {OO.ui.PageLayout|undefined} Page, if found
2186 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
2187 return this.pages
[ name
];
2191 * Get the current page.
2193 * @return {OO.ui.PageLayout|undefined} Current page, if found
2195 OO
.ui
.BookletLayout
.prototype.getCurrentPage = function () {
2196 var name
= this.getCurrentPageName();
2197 return name
? this.getPage( name
) : undefined;
2201 * Get the symbolic name of the current page.
2203 * @return {string|null} Symbolic name of the current page
2205 OO
.ui
.BookletLayout
.prototype.getCurrentPageName = function () {
2206 return this.currentPageName
;
2210 * Add pages to the booklet layout
2212 * When pages are added with the same names as existing pages, the existing pages will be
2213 * automatically removed before the new pages are added.
2215 * @param {OO.ui.PageLayout[]} pages Pages to add
2216 * @param {number} index Index of the insertion point
2219 * @return {OO.ui.BookletLayout} The layout, for chaining
2221 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
2222 var i
, len
, name
, page
, item
, currentIndex
,
2223 stackLayoutPages
= this.stackLayout
.getItems(),
2227 // Remove pages with same names
2228 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2230 name
= page
.getName();
2232 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
2233 // Correct the insertion index
2234 currentIndex
= stackLayoutPages
.indexOf( this.pages
[ name
] );
2235 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2238 remove
.push( this.pages
[ name
] );
2241 if ( remove
.length
) {
2242 this.removePages( remove
);
2246 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2248 name
= page
.getName();
2249 this.pages
[ page
.getName() ] = page
;
2250 if ( this.outlined
) {
2251 item
= new OO
.ui
.OutlineOptionWidget( { data
: name
} );
2252 page
.setOutlineItem( item
);
2257 if ( this.outlined
&& items
.length
) {
2258 this.outlineSelectWidget
.addItems( items
, index
);
2259 this.selectFirstSelectablePage();
2261 this.stackLayout
.addItems( pages
, index
);
2262 this.emit( 'add', pages
, index
);
2268 * Remove the specified pages from the booklet layout.
2270 * To remove all pages from the booklet, you may wish to use the #clearPages method instead.
2272 * @param {OO.ui.PageLayout[]} pages An array of pages to remove
2275 * @return {OO.ui.BookletLayout} The layout, for chaining
2277 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
2278 var i
, len
, name
, page
,
2281 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2283 name
= page
.getName();
2284 delete this.pages
[ name
];
2285 if ( this.outlined
) {
2286 items
.push( this.outlineSelectWidget
.findItemFromData( name
) );
2287 page
.setOutlineItem( null );
2290 if ( this.outlined
&& items
.length
) {
2291 this.outlineSelectWidget
.removeItems( items
);
2292 this.selectFirstSelectablePage();
2294 this.stackLayout
.removeItems( pages
);
2295 this.emit( 'remove', pages
);
2301 * Clear all pages from the booklet layout.
2303 * To remove only a subset of pages from the booklet, use the #removePages method.
2307 * @return {OO.ui.BookletLayout} The layout, for chaining
2309 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
2311 pages
= this.stackLayout
.getItems();
2314 this.currentPageName
= null;
2315 if ( this.outlined
) {
2316 this.outlineSelectWidget
.clearItems();
2317 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2318 pages
[ i
].setOutlineItem( null );
2321 this.stackLayout
.clearItems();
2323 this.emit( 'remove', pages
);
2329 * Set the current page by symbolic name.
2332 * @param {string} name Symbolic name of page
2334 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
2337 page
= this.pages
[ name
],
2338 previousPage
= this.currentPageName
&& this.pages
[ this.currentPageName
];
2340 if ( name
!== this.currentPageName
) {
2341 if ( this.outlined
) {
2342 selectedItem
= this.outlineSelectWidget
.findSelectedItem();
2343 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2344 this.outlineSelectWidget
.selectItemByData( name
);
2348 if ( previousPage
) {
2349 previousPage
.setActive( false );
2350 // Blur anything focused if the next page doesn't have anything focusable.
2351 // This is not needed if the next page has something focusable (because once it is focused
2352 // this blur happens automatically). If the layout is non-continuous, this check is
2353 // meaningless because the next page is not visible yet and thus can't hold focus.
2356 !OO
.ui
.isMobile() &&
2357 this.stackLayout
.continuous
&&
2358 OO
.ui
.findFocusable( page
.$element
).length
!== 0
2360 $focused
= previousPage
.$element
.find( ':focus' );
2361 if ( $focused
.length
) {
2362 $focused
[ 0 ].blur();
2366 this.currentPageName
= name
;
2367 page
.setActive( true );
2368 this.stackLayout
.setItem( page
);
2369 if ( !this.stackLayout
.continuous
&& previousPage
) {
2370 // This should not be necessary, since any inputs on the previous page should have been
2371 // blurred when it was hidden, but browsers are not very consistent about this.
2372 $focused
= previousPage
.$element
.find( ':focus' );
2373 if ( $focused
.length
) {
2374 $focused
[ 0 ].blur();
2377 this.emit( 'set', page
);
2383 * For outlined-continuous booklets, also reset the outlineSelectWidget to the first item.
2387 OO
.ui
.BookletLayout
.prototype.resetScroll = function () {
2389 OO
.ui
.BookletLayout
.parent
.prototype.resetScroll
.call( this );
2391 if ( this.outlined
&& this.stackLayout
.continuous
&& this.outlineSelectWidget
.findFirstSelectableItem() ) {
2392 this.scrolling
= true;
2393 this.outlineSelectWidget
.selectItem( this.outlineSelectWidget
.findFirstSelectableItem() );
2394 this.scrolling
= false;
2400 * Select the first selectable page.
2403 * @return {OO.ui.BookletLayout} The layout, for chaining
2405 OO
.ui
.BookletLayout
.prototype.selectFirstSelectablePage = function () {
2406 if ( !this.outlineSelectWidget
.findSelectedItem() ) {
2407 this.outlineSelectWidget
.selectItem( this.outlineSelectWidget
.findFirstSelectableItem() );
2414 * IndexLayouts contain {@link OO.ui.TabPanelLayout tab panel layouts} as well as
2415 * {@link OO.ui.TabSelectWidget tabs} that allow users to easily navigate through the tab panels and
2416 * select which one to display. By default, only one tab panel is displayed at a time. When a user
2417 * navigates to a new tab panel, the index layout automatically focuses on the first focusable element,
2418 * unless the default setting is changed.
2420 * TODO: This class is similar to BookletLayout, we may want to refactor to reduce duplication
2423 * // Example of a IndexLayout that contains two TabPanelLayouts.
2425 * function TabPanelOneLayout( name, config ) {
2426 * TabPanelOneLayout.parent.call( this, name, config );
2427 * this.$element.append( '<p>First tab panel</p>' );
2429 * OO.inheritClass( TabPanelOneLayout, OO.ui.TabPanelLayout );
2430 * TabPanelOneLayout.prototype.setupTabItem = function () {
2431 * this.tabItem.setLabel( 'Tab panel one' );
2434 * var tabPanel1 = new TabPanelOneLayout( 'one' ),
2435 * tabPanel2 = new OO.ui.TabPanelLayout( 'two', { label: 'Tab panel two' } );
2437 * tabPanel2.$element.append( '<p>Second tab panel</p>' );
2439 * var index = new OO.ui.IndexLayout();
2441 * index.addTabPanels( [ tabPanel1, tabPanel2 ] );
2442 * $( document.body ).append( index.$element );
2445 * @extends OO.ui.MenuLayout
2448 * @param {Object} [config] Configuration options
2449 * @cfg {boolean} [continuous=false] Show all tab panels, one after another
2450 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new tab panel is displayed. Disabled on mobile.
2452 OO
.ui
.IndexLayout
= function OoUiIndexLayout( config
) {
2453 // Configuration initialization
2454 config
= $.extend( {}, config
, { menuPosition
: 'top' } );
2456 // Parent constructor
2457 OO
.ui
.IndexLayout
.parent
.call( this, config
);
2460 this.currentTabPanelName
= null;
2461 this.tabPanels
= {};
2463 this.ignoreFocus
= false;
2464 this.stackLayout
= new OO
.ui
.StackLayout( {
2465 continuous
: !!config
.continuous
,
2466 expanded
: this.expanded
2468 this.setContentPanel( this.stackLayout
);
2469 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
2471 this.tabSelectWidget
= new OO
.ui
.TabSelectWidget();
2472 this.tabPanel
= new OO
.ui
.PanelLayout( {
2473 expanded
: this.expanded
2475 this.setMenuPanel( this.tabPanel
);
2477 this.toggleMenu( true );
2480 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
2481 this.tabSelectWidget
.connect( this, { select
: 'onTabSelectWidgetSelect' } );
2482 if ( this.autoFocus
) {
2483 // Event 'focus' does not bubble, but 'focusin' does
2484 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
2488 this.$element
.addClass( 'oo-ui-indexLayout' );
2489 this.stackLayout
.$element
.addClass( 'oo-ui-indexLayout-stackLayout' );
2490 this.tabPanel
.$element
2491 .addClass( 'oo-ui-indexLayout-tabPanel' )
2492 .append( this.tabSelectWidget
.$element
);
2497 OO
.inheritClass( OO
.ui
.IndexLayout
, OO
.ui
.MenuLayout
);
2502 * A 'set' event is emitted when a tab panel is {@link #setTabPanel set} to be displayed by the index layout.
2504 * @param {OO.ui.TabPanelLayout} tabPanel Current tab panel
2508 * An 'add' event is emitted when tab panels are {@link #addTabPanels added} to the index layout.
2511 * @param {OO.ui.TabPanelLayout[]} tabPanel Added tab panels
2512 * @param {number} index Index tab panels were added at
2516 * A 'remove' event is emitted when tab panels are {@link #clearTabPanels cleared} or
2517 * {@link #removeTabPanels removed} from the index.
2520 * @param {OO.ui.TabPanelLayout[]} tabPanel Removed tab panels
2526 * Handle stack layout focus.
2529 * @param {jQuery.Event} e Focusing event
2531 OO
.ui
.IndexLayout
.prototype.onStackLayoutFocus = function ( e
) {
2534 // Find the tab panel that an element was focused within
2535 $target
= $( e
.target
).closest( '.oo-ui-tabPanelLayout' );
2536 for ( name
in this.tabPanels
) {
2537 // Check for tab panel match, exclude current tab panel to find only tab panel changes
2538 if ( this.tabPanels
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentTabPanelName
) {
2539 this.setTabPanel( name
);
2546 * Handle stack layout set events.
2549 * @param {OO.ui.PanelLayout|null} tabPanel The tab panel that is now the current panel
2551 OO
.ui
.IndexLayout
.prototype.onStackLayoutSet = function ( tabPanel
) {
2552 // If everything is unselected, do nothing
2556 // Focus the first element on the newly selected panel
2557 if ( this.autoFocus
&& !OO
.ui
.isMobile() ) {
2563 * Focus the first input in the current tab panel.
2565 * If no tab panel is selected, the first selectable tab panel will be selected.
2566 * If the focus is already in an element on the current tab panel, nothing will happen.
2568 * @param {number} [itemIndex] A specific item to focus on
2570 OO
.ui
.IndexLayout
.prototype.focus = function ( itemIndex
) {
2572 items
= this.stackLayout
.getItems();
2574 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
2575 tabPanel
= items
[ itemIndex
];
2577 tabPanel
= this.stackLayout
.getCurrentItem();
2581 this.selectFirstSelectableTabPanel();
2582 tabPanel
= this.stackLayout
.getCurrentItem();
2587 // Only change the focus if is not already in the current page
2588 if ( !OO
.ui
.contains( tabPanel
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
2594 * Find the first focusable input in the index layout and focus
2597 OO
.ui
.IndexLayout
.prototype.focusFirstFocusable = function () {
2598 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
2602 * Handle tab widget select events.
2605 * @param {OO.ui.OptionWidget|null} item Selected item
2607 OO
.ui
.IndexLayout
.prototype.onTabSelectWidgetSelect = function ( item
) {
2609 this.setTabPanel( item
.getData() );
2614 * Get the tab panel closest to the specified tab panel.
2616 * @param {OO.ui.TabPanelLayout} tabPanel Tab panel to use as a reference point
2617 * @return {OO.ui.TabPanelLayout|null} Tab panel closest to the specified
2619 OO
.ui
.IndexLayout
.prototype.getClosestTabPanel = function ( tabPanel
) {
2620 var next
, prev
, level
,
2621 tabPanels
= this.stackLayout
.getItems(),
2622 index
= tabPanels
.indexOf( tabPanel
);
2624 if ( index
!== -1 ) {
2625 next
= tabPanels
[ index
+ 1 ];
2626 prev
= tabPanels
[ index
- 1 ];
2627 // Prefer adjacent tab panels at the same level
2628 level
= this.tabSelectWidget
.findItemFromData( tabPanel
.getName() ).getLevel();
2631 level
=== this.tabSelectWidget
.findItemFromData( prev
.getName() ).getLevel()
2637 level
=== this.tabSelectWidget
.findItemFromData( next
.getName() ).getLevel()
2642 return prev
|| next
|| null;
2646 * Get the tabs widget.
2648 * @return {OO.ui.TabSelectWidget} Tabs widget
2650 OO
.ui
.IndexLayout
.prototype.getTabs = function () {
2651 return this.tabSelectWidget
;
2655 * Get a tab panel by its symbolic name.
2657 * @param {string} name Symbolic name of tab panel
2658 * @return {OO.ui.TabPanelLayout|undefined} Tab panel, if found
2660 OO
.ui
.IndexLayout
.prototype.getTabPanel = function ( name
) {
2661 return this.tabPanels
[ name
];
2665 * Get the current tab panel.
2667 * @return {OO.ui.TabPanelLayout|undefined} Current tab panel, if found
2669 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanel = function () {
2670 var name
= this.getCurrentTabPanelName();
2671 return name
? this.getTabPanel( name
) : undefined;
2675 * Get the symbolic name of the current tab panel.
2677 * @return {string|null} Symbolic name of the current tab panel
2679 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanelName = function () {
2680 return this.currentTabPanelName
;
2684 * Add tab panels to the index layout
2686 * When tab panels are added with the same names as existing tab panels, the existing tab panels
2687 * will be automatically removed before the new tab panels are added.
2689 * @param {OO.ui.TabPanelLayout[]} tabPanels Tab panels to add
2690 * @param {number} index Index of the insertion point
2693 * @return {OO.ui.BookletLayout} The layout, for chaining
2695 OO
.ui
.IndexLayout
.prototype.addTabPanels = function ( tabPanels
, index
) {
2696 var i
, len
, name
, tabPanel
, item
, currentIndex
,
2697 stackLayoutTabPanels
= this.stackLayout
.getItems(),
2701 // Remove tab panels with same names
2702 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2703 tabPanel
= tabPanels
[ i
];
2704 name
= tabPanel
.getName();
2706 if ( Object
.prototype.hasOwnProperty
.call( this.tabPanels
, name
) ) {
2707 // Correct the insertion index
2708 currentIndex
= stackLayoutTabPanels
.indexOf( this.tabPanels
[ name
] );
2709 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2712 remove
.push( this.tabPanels
[ name
] );
2715 if ( remove
.length
) {
2716 this.removeTabPanels( remove
);
2719 // Add new tab panels
2720 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2721 tabPanel
= tabPanels
[ i
];
2722 name
= tabPanel
.getName();
2723 this.tabPanels
[ tabPanel
.getName() ] = tabPanel
;
2724 item
= new OO
.ui
.TabOptionWidget( { data
: name
} );
2725 tabPanel
.setTabItem( item
);
2729 if ( items
.length
) {
2730 this.tabSelectWidget
.addItems( items
, index
);
2731 this.selectFirstSelectableTabPanel();
2733 this.stackLayout
.addItems( tabPanels
, index
);
2734 this.emit( 'add', tabPanels
, index
);
2740 * Remove the specified tab panels from the index layout.
2742 * To remove all tab panels from the index, you may wish to use the #clearTabPanels method instead.
2744 * @param {OO.ui.TabPanelLayout[]} tabPanels An array of tab panels to remove
2747 * @return {OO.ui.BookletLayout} The layout, for chaining
2749 OO
.ui
.IndexLayout
.prototype.removeTabPanels = function ( tabPanels
) {
2750 var i
, len
, name
, tabPanel
,
2753 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2754 tabPanel
= tabPanels
[ i
];
2755 name
= tabPanel
.getName();
2756 delete this.tabPanels
[ name
];
2757 items
.push( this.tabSelectWidget
.findItemFromData( name
) );
2758 tabPanel
.setTabItem( null );
2760 if ( items
.length
) {
2761 this.tabSelectWidget
.removeItems( items
);
2762 this.selectFirstSelectableTabPanel();
2764 this.stackLayout
.removeItems( tabPanels
);
2765 this.emit( 'remove', tabPanels
);
2771 * Clear all tab panels from the index layout.
2773 * To remove only a subset of tab panels from the index, use the #removeTabPanels method.
2777 * @return {OO.ui.BookletLayout} The layout, for chaining
2779 OO
.ui
.IndexLayout
.prototype.clearTabPanels = function () {
2781 tabPanels
= this.stackLayout
.getItems();
2783 this.tabPanels
= {};
2784 this.currentTabPanelName
= null;
2785 this.tabSelectWidget
.clearItems();
2786 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2787 tabPanels
[ i
].setTabItem( null );
2789 this.stackLayout
.clearItems();
2791 this.emit( 'remove', tabPanels
);
2797 * Set the current tab panel by symbolic name.
2800 * @param {string} name Symbolic name of tab panel
2802 OO
.ui
.IndexLayout
.prototype.setTabPanel = function ( name
) {
2806 tabPanel
= this.tabPanels
[ name
];
2808 if ( name
!== this.currentTabPanelName
) {
2809 previousTabPanel
= this.getCurrentTabPanel();
2810 selectedItem
= this.tabSelectWidget
.findSelectedItem();
2811 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2812 this.tabSelectWidget
.selectItemByData( name
);
2815 if ( previousTabPanel
) {
2816 previousTabPanel
.setActive( false );
2817 // Blur anything focused if the next tab panel doesn't have anything focusable.
2818 // This is not needed if the next tab panel has something focusable (because once it is focused
2819 // this blur happens automatically). If the layout is non-continuous, this check is
2820 // meaningless because the next tab panel is not visible yet and thus can't hold focus.
2823 !OO
.ui
.isMobile() &&
2824 this.stackLayout
.continuous
&&
2825 OO
.ui
.findFocusable( tabPanel
.$element
).length
!== 0
2827 $focused
= previousTabPanel
.$element
.find( ':focus' );
2828 if ( $focused
.length
) {
2829 $focused
[ 0 ].blur();
2833 this.currentTabPanelName
= name
;
2834 tabPanel
.setActive( true );
2835 this.stackLayout
.setItem( tabPanel
);
2836 if ( !this.stackLayout
.continuous
&& previousTabPanel
) {
2837 // This should not be necessary, since any inputs on the previous tab panel should have been
2838 // blurred when it was hidden, but browsers are not very consistent about this.
2839 $focused
= previousTabPanel
.$element
.find( ':focus' );
2840 if ( $focused
.length
) {
2841 $focused
[ 0 ].blur();
2844 this.emit( 'set', tabPanel
);
2850 * Select the first selectable tab panel.
2853 * @return {OO.ui.BookletLayout} The layout, for chaining
2855 OO
.ui
.IndexLayout
.prototype.selectFirstSelectableTabPanel = function () {
2856 if ( !this.tabSelectWidget
.findSelectedItem() ) {
2857 this.tabSelectWidget
.selectItem( this.tabSelectWidget
.findFirstSelectableItem() );
2864 * ToggleWidget implements basic behavior of widgets with an on/off state.
2865 * Please see OO.ui.ToggleButtonWidget and OO.ui.ToggleSwitchWidget for examples.
2869 * @extends OO.ui.Widget
2870 * @mixins OO.ui.mixin.TitledElement
2873 * @param {Object} [config] Configuration options
2874 * @cfg {boolean} [value=false] The toggle’s initial on/off state.
2875 * By default, the toggle is in the 'off' state.
2877 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
2878 // Configuration initialization
2879 config
= config
|| {};
2881 // Parent constructor
2882 OO
.ui
.ToggleWidget
.parent
.call( this, config
);
2884 // Mixin constructor
2885 OO
.ui
.mixin
.TitledElement
.call( this, config
);
2891 this.$element
.addClass( 'oo-ui-toggleWidget' );
2892 this.setValue( !!config
.value
);
2897 OO
.inheritClass( OO
.ui
.ToggleWidget
, OO
.ui
.Widget
);
2898 OO
.mixinClass( OO
.ui
.ToggleWidget
, OO
.ui
.mixin
.TitledElement
);
2905 * A change event is emitted when the on/off state of the toggle changes.
2907 * @param {boolean} value Value representing the new state of the toggle
2913 * Get the value representing the toggle’s state.
2915 * @return {boolean} The on/off state of the toggle
2917 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
2922 * Set the state of the toggle: `true` for 'on', `false` for 'off'.
2924 * @param {boolean} value The state of the toggle
2927 * @return {OO.ui.Widget} The widget, for chaining
2929 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
2931 if ( this.value
!== value
) {
2933 this.emit( 'change', value
);
2934 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
2935 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
2941 * ToggleButtons are buttons that have a state (‘on’ or ‘off’) that is represented by a
2942 * Boolean value. Like other {@link OO.ui.ButtonWidget buttons}, toggle buttons can be
2943 * configured with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators},
2944 * {@link OO.ui.mixin.TitledElement titles}, {@link OO.ui.mixin.FlaggedElement styling flags},
2945 * and {@link OO.ui.mixin.LabelElement labels}. Please see
2946 * the [OOUI documentation][1] on MediaWiki for more information.
2949 * // Toggle buttons in the 'off' and 'on' state.
2950 * var toggleButton1 = new OO.ui.ToggleButtonWidget( {
2951 * label: 'Toggle Button off'
2953 * toggleButton2 = new OO.ui.ToggleButtonWidget( {
2954 * label: 'Toggle Button on',
2957 * // Append the buttons to the DOM.
2958 * $( document.body ).append( toggleButton1.$element, toggleButton2.$element );
2960 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Buttons_and_Switches#Toggle_buttons
2963 * @extends OO.ui.ToggleWidget
2964 * @mixins OO.ui.mixin.ButtonElement
2965 * @mixins OO.ui.mixin.IconElement
2966 * @mixins OO.ui.mixin.IndicatorElement
2967 * @mixins OO.ui.mixin.LabelElement
2968 * @mixins OO.ui.mixin.FlaggedElement
2969 * @mixins OO.ui.mixin.TabIndexedElement
2972 * @param {Object} [config] Configuration options
2973 * @cfg {boolean} [value=false] The toggle button’s initial on/off
2974 * state. By default, the button is in the 'off' state.
2976 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
2977 // Configuration initialization
2978 config
= config
|| {};
2980 // Parent constructor
2981 OO
.ui
.ToggleButtonWidget
.parent
.call( this, config
);
2983 // Mixin constructors
2984 OO
.ui
.mixin
.ButtonElement
.call( this, $.extend( {}, config
, { active
: this.active
} ) );
2985 OO
.ui
.mixin
.IconElement
.call( this, config
);
2986 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
2987 OO
.ui
.mixin
.LabelElement
.call( this, config
);
2988 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
2989 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$button
} ) );
2992 this.connect( this, { click
: 'onAction' } );
2995 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
2997 .addClass( 'oo-ui-toggleButtonWidget' )
2998 .append( this.$button
);
2999 this.setTitledElement( this.$button
);
3004 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
3005 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.ButtonElement
);
3006 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IconElement
);
3007 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IndicatorElement
);
3008 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.LabelElement
);
3009 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.FlaggedElement
);
3010 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3012 /* Static Properties */
3018 OO
.ui
.ToggleButtonWidget
.static.tagName
= 'span';
3023 * Handle the button action being triggered.
3027 OO
.ui
.ToggleButtonWidget
.prototype.onAction = function () {
3028 this.setValue( !this.value
);
3034 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
3036 if ( value
!== this.value
) {
3037 // Might be called from parent constructor before ButtonElement constructor
3038 if ( this.$button
) {
3039 this.$button
.attr( 'aria-pressed', value
.toString() );
3041 this.setActive( value
);
3045 OO
.ui
.ToggleButtonWidget
.parent
.prototype.setValue
.call( this, value
);
3053 OO
.ui
.ToggleButtonWidget
.prototype.setButtonElement = function ( $button
) {
3054 if ( this.$button
) {
3055 this.$button
.removeAttr( 'aria-pressed' );
3057 OO
.ui
.mixin
.ButtonElement
.prototype.setButtonElement
.call( this, $button
);
3058 this.$button
.attr( 'aria-pressed', this.value
.toString() );
3062 * ToggleSwitches are switches that slide on and off. Their state is represented by a Boolean
3063 * value (`true` for ‘on’, and `false` otherwise, the default). The ‘off’ state is represented
3064 * visually by a slider in the leftmost position.
3067 * // Toggle switches in the 'off' and 'on' position.
3068 * var toggleSwitch1 = new OO.ui.ToggleSwitchWidget(),
3069 * toggleSwitch2 = new OO.ui.ToggleSwitchWidget( {
3072 * // Create a FieldsetLayout to layout and label switches.
3073 * fieldset = new OO.ui.FieldsetLayout( {
3074 * label: 'Toggle switches'
3076 * fieldset.addItems( [
3077 * new OO.ui.FieldLayout( toggleSwitch1, {
3081 * new OO.ui.FieldLayout( toggleSwitch2, {
3086 * $( document.body ).append( fieldset.$element );
3089 * @extends OO.ui.ToggleWidget
3090 * @mixins OO.ui.mixin.TabIndexedElement
3093 * @param {Object} [config] Configuration options
3094 * @cfg {boolean} [value=false] The toggle switch’s initial on/off state.
3095 * By default, the toggle switch is in the 'off' position.
3097 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
3098 // Parent constructor
3099 OO
.ui
.ToggleSwitchWidget
.parent
.call( this, config
);
3101 // Mixin constructors
3102 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3105 this.dragging
= false;
3106 this.dragStart
= null;
3107 this.sliding
= false;
3108 this.$glow
= $( '<span>' );
3109 this.$grip
= $( '<span>' );
3113 click
: this.onClick
.bind( this ),
3114 keypress
: this.onKeyPress
.bind( this )
3118 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
3119 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
3121 .addClass( 'oo-ui-toggleSwitchWidget' )
3122 .attr( 'role', 'checkbox' )
3123 .append( this.$glow
, this.$grip
);
3128 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
3129 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3134 * Handle mouse click events.
3137 * @param {jQuery.Event} e Mouse click event
3138 * @return {undefined/boolean} False to prevent default if event is handled
3140 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
3141 if ( !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
3142 this.setValue( !this.value
);
3148 * Handle key press events.
3151 * @param {jQuery.Event} e Key press event
3152 * @return {undefined/boolean} False to prevent default if event is handled
3154 OO
.ui
.ToggleSwitchWidget
.prototype.onKeyPress = function ( e
) {
3155 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
3156 this.setValue( !this.value
);
3164 OO
.ui
.ToggleSwitchWidget
.prototype.setValue = function ( value
) {
3165 OO
.ui
.ToggleSwitchWidget
.parent
.prototype.setValue
.call( this, value
);
3166 this.$element
.attr( 'aria-checked', this.value
.toString() );
3173 OO
.ui
.ToggleSwitchWidget
.prototype.simulateLabelClick = function () {
3174 if ( !this.isDisabled() ) {
3175 this.setValue( !this.value
);
3181 * OutlineControlsWidget is a set of controls for an {@link OO.ui.OutlineSelectWidget outline select widget}.
3182 * Controls include moving items up and down, removing items, and adding different kinds of items.
3184 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3187 * @extends OO.ui.Widget
3188 * @mixins OO.ui.mixin.GroupElement
3191 * @param {OO.ui.OutlineSelectWidget} outline Outline to control
3192 * @param {Object} [config] Configuration options
3193 * @cfg {Object} [abilities] List of abilties
3194 * @cfg {boolean} [abilities.move=true] Allow moving movable items
3195 * @cfg {boolean} [abilities.remove=true] Allow removing removable items
3197 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
3198 // Allow passing positional parameters inside the config object
3199 if ( OO
.isPlainObject( outline
) && config
=== undefined ) {
3201 outline
= config
.outline
;
3204 // Configuration initialization
3205 config
= config
|| {};
3207 // Parent constructor
3208 OO
.ui
.OutlineControlsWidget
.parent
.call( this, config
);
3210 // Mixin constructors
3211 OO
.ui
.mixin
.GroupElement
.call( this, config
);
3214 this.outline
= outline
;
3215 this.$movers
= $( '<div>' );
3216 this.upButton
= new OO
.ui
.ButtonWidget( {
3219 title
: OO
.ui
.msg( 'ooui-outline-control-move-up' )
3221 this.downButton
= new OO
.ui
.ButtonWidget( {
3224 title
: OO
.ui
.msg( 'ooui-outline-control-move-down' )
3226 this.removeButton
= new OO
.ui
.ButtonWidget( {
3229 title
: OO
.ui
.msg( 'ooui-outline-control-remove' )
3231 this.abilities
= { move: true, remove
: true };
3234 outline
.connect( this, {
3235 select
: 'onOutlineChange',
3236 add
: 'onOutlineChange',
3237 remove
: 'onOutlineChange'
3239 this.upButton
.connect( this, { click
: [ 'emit', 'move', -1 ] } );
3240 this.downButton
.connect( this, { click
: [ 'emit', 'move', 1 ] } );
3241 this.removeButton
.connect( this, { click
: [ 'emit', 'remove' ] } );
3244 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
3245 this.$group
.addClass( 'oo-ui-outlineControlsWidget-items' );
3247 .addClass( 'oo-ui-outlineControlsWidget-movers' )
3248 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
3249 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
3250 this.setAbilities( config
.abilities
|| {} );
3255 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
3256 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.GroupElement
);
3262 * @param {number} places Number of places to move
3274 * @param {Object} abilities List of abilties
3275 * @param {boolean} [abilities.move] Allow moving movable items
3276 * @param {boolean} [abilities.remove] Allow removing removable items
3278 OO
.ui
.OutlineControlsWidget
.prototype.setAbilities = function ( abilities
) {
3281 for ( ability
in this.abilities
) {
3282 if ( abilities
[ ability
] !== undefined ) {
3283 this.abilities
[ ability
] = !!abilities
[ ability
];
3287 this.onOutlineChange();
3291 * Handle outline change events.
3295 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
3296 var i
, len
, firstMovable
, lastMovable
,
3297 items
= this.outline
.getItems(),
3298 selectedItem
= this.outline
.findSelectedItem(),
3299 movable
= this.abilities
.move && selectedItem
&& selectedItem
.isMovable(),
3300 removable
= this.abilities
.remove
&& selectedItem
&& selectedItem
.isRemovable();
3305 while ( ++i
< len
) {
3306 if ( items
[ i
].isMovable() ) {
3307 firstMovable
= items
[ i
];
3313 if ( items
[ i
].isMovable() ) {
3314 lastMovable
= items
[ i
];
3319 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
3320 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
3321 this.removeButton
.setDisabled( !removable
);
3325 * OutlineOptionWidget is an item in an {@link OO.ui.OutlineSelectWidget OutlineSelectWidget}.
3327 * Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}, which contain
3328 * {@link OO.ui.PageLayout page layouts}. See {@link OO.ui.BookletLayout BookletLayout}
3332 * @extends OO.ui.DecoratedOptionWidget
3335 * @param {Object} [config] Configuration options
3336 * @cfg {number} [level] Indentation level
3337 * @cfg {boolean} [movable] Allow modification from {@link OO.ui.OutlineControlsWidget outline controls}.
3339 OO
.ui
.OutlineOptionWidget
= function OoUiOutlineOptionWidget( config
) {
3340 // Configuration initialization
3341 config
= config
|| {};
3343 // Parent constructor
3344 OO
.ui
.OutlineOptionWidget
.parent
.call( this, config
);
3348 this.movable
= !!config
.movable
;
3349 this.removable
= !!config
.removable
;
3352 this.$element
.addClass( 'oo-ui-outlineOptionWidget' );
3353 this.setLevel( config
.level
);
3358 OO
.inheritClass( OO
.ui
.OutlineOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
3360 /* Static Properties */
3366 OO
.ui
.OutlineOptionWidget
.static.highlightable
= true;
3372 OO
.ui
.OutlineOptionWidget
.static.scrollIntoViewOnSelect
= true;
3377 * @property {string}
3379 OO
.ui
.OutlineOptionWidget
.static.levelClass
= 'oo-ui-outlineOptionWidget-level-';
3384 * @property {number}
3386 OO
.ui
.OutlineOptionWidget
.static.levels
= 3;
3391 * Check if item is movable.
3393 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3395 * @return {boolean} Item is movable
3397 OO
.ui
.OutlineOptionWidget
.prototype.isMovable = function () {
3398 return this.movable
;
3402 * Check if item is removable.
3404 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3406 * @return {boolean} Item is removable
3408 OO
.ui
.OutlineOptionWidget
.prototype.isRemovable = function () {
3409 return this.removable
;
3413 * Get indentation level.
3415 * @return {number} Indentation level
3417 OO
.ui
.OutlineOptionWidget
.prototype.getLevel = function () {
3424 OO
.ui
.OutlineOptionWidget
.prototype.setPressed = function ( state
) {
3425 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setPressed
.call( this, state
);
3432 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3434 * @param {boolean} movable Item is movable
3436 * @return {OO.ui.Widget} The widget, for chaining
3438 OO
.ui
.OutlineOptionWidget
.prototype.setMovable = function ( movable
) {
3439 this.movable
= !!movable
;
3440 this.updateThemeClasses();
3447 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3449 * @param {boolean} removable Item is removable
3451 * @return {OO.ui.Widget} The widget, for chaining
3453 OO
.ui
.OutlineOptionWidget
.prototype.setRemovable = function ( removable
) {
3454 this.removable
= !!removable
;
3455 this.updateThemeClasses();
3462 OO
.ui
.OutlineOptionWidget
.prototype.setSelected = function ( state
) {
3463 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3468 * Set indentation level.
3470 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
3472 * @return {OO.ui.Widget} The widget, for chaining
3474 OO
.ui
.OutlineOptionWidget
.prototype.setLevel = function ( level
) {
3475 var levels
= this.constructor.static.levels
,
3476 levelClass
= this.constructor.static.levelClass
,
3479 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
3481 if ( this.level
=== i
) {
3482 this.$element
.addClass( levelClass
+ i
);
3484 this.$element
.removeClass( levelClass
+ i
);
3487 this.updateThemeClasses();
3493 * OutlineSelectWidget is a structured list that contains {@link OO.ui.OutlineOptionWidget outline options}
3494 * A set of controls can be provided with an {@link OO.ui.OutlineControlsWidget outline controls} widget.
3496 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3499 * @extends OO.ui.SelectWidget
3500 * @mixins OO.ui.mixin.TabIndexedElement
3503 * @param {Object} [config] Configuration options
3505 OO
.ui
.OutlineSelectWidget
= function OoUiOutlineSelectWidget( config
) {
3506 // Parent constructor
3507 OO
.ui
.OutlineSelectWidget
.parent
.call( this, config
);
3509 // Mixin constructors
3510 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3514 focus
: this.bindDocumentKeyDownListener
.bind( this ),
3515 blur
: this.unbindDocumentKeyDownListener
.bind( this )
3519 this.$element
.addClass( 'oo-ui-outlineSelectWidget' );
3524 OO
.inheritClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.SelectWidget
);
3525 OO
.mixinClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3528 * ButtonOptionWidget is a special type of {@link OO.ui.mixin.ButtonElement button element} that
3529 * can be selected and configured with data. The class is
3530 * used with OO.ui.ButtonSelectWidget to create a selection of button options. Please see the
3531 * [OOUI documentation on MediaWiki] [1] for more information.
3533 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Button_selects_and_options
3536 * @extends OO.ui.OptionWidget
3537 * @mixins OO.ui.mixin.ButtonElement
3538 * @mixins OO.ui.mixin.IconElement
3539 * @mixins OO.ui.mixin.IndicatorElement
3542 * @param {Object} [config] Configuration options
3544 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( config
) {
3545 // Configuration initialization
3546 config
= config
|| {};
3548 // Parent constructor
3549 OO
.ui
.ButtonOptionWidget
.parent
.call( this, config
);
3551 // Mixin constructors
3552 OO
.ui
.mixin
.ButtonElement
.call( this, config
);
3553 OO
.ui
.mixin
.IconElement
.call( this, config
);
3554 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3557 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
3558 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
3559 this.$element
.append( this.$button
);
3560 this.setTitledElement( this.$button
);
3565 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.OptionWidget
);
3566 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.ButtonElement
);
3567 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IconElement
);
3568 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IndicatorElement
);
3570 /* Static Properties */
3573 * Allow button mouse down events to pass through so they can be handled by the parent select widget
3578 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
3584 OO
.ui
.ButtonOptionWidget
.static.highlightable
= false;
3591 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
3592 OO
.ui
.ButtonOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3594 if ( this.constructor.static.selectable
) {
3595 this.setActive( state
);
3602 * ButtonSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains
3603 * button options and is used together with
3604 * OO.ui.ButtonOptionWidget. The ButtonSelectWidget provides an interface for
3605 * highlighting, choosing, and selecting mutually exclusive options. Please see
3606 * the [OOUI documentation on MediaWiki] [1] for more information.
3609 * // A ButtonSelectWidget that contains three ButtonOptionWidgets.
3610 * var option1 = new OO.ui.ButtonOptionWidget( {
3612 * label: 'Option 1',
3613 * title: 'Button option 1'
3615 * option2 = new OO.ui.ButtonOptionWidget( {
3617 * label: 'Option 2',
3618 * title: 'Button option 2'
3620 * option3 = new OO.ui.ButtonOptionWidget( {
3622 * label: 'Option 3',
3623 * title: 'Button option 3'
3625 * buttonSelect = new OO.ui.ButtonSelectWidget( {
3626 * items: [ option1, option2, option3 ]
3628 * $( document.body ).append( buttonSelect.$element );
3630 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
3633 * @extends OO.ui.SelectWidget
3634 * @mixins OO.ui.mixin.TabIndexedElement
3637 * @param {Object} [config] Configuration options
3639 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
3640 // Parent constructor
3641 OO
.ui
.ButtonSelectWidget
.parent
.call( this, config
);
3643 // Mixin constructors
3644 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3648 focus
: this.bindDocumentKeyDownListener
.bind( this ),
3649 blur
: this.unbindDocumentKeyDownListener
.bind( this )
3653 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
3658 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
3659 OO
.mixinClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3662 * TabOptionWidget is an item in a {@link OO.ui.TabSelectWidget TabSelectWidget}.
3664 * Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}, which contain
3665 * {@link OO.ui.TabPanelLayout tab panel layouts}. See {@link OO.ui.IndexLayout IndexLayout}
3669 * @extends OO.ui.OptionWidget
3672 * @param {Object} [config] Configuration options
3674 OO
.ui
.TabOptionWidget
= function OoUiTabOptionWidget( config
) {
3675 // Configuration initialization
3676 config
= config
|| {};
3678 // Parent constructor
3679 OO
.ui
.TabOptionWidget
.parent
.call( this, config
);
3683 .addClass( 'oo-ui-tabOptionWidget' )
3684 .attr( 'role', 'tab' );
3689 OO
.inheritClass( OO
.ui
.TabOptionWidget
, OO
.ui
.OptionWidget
);
3691 /* Static Properties */
3697 OO
.ui
.TabOptionWidget
.static.highlightable
= false;
3700 * TabSelectWidget is a list that contains {@link OO.ui.TabOptionWidget tab options}
3702 * **Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}.**
3705 * @extends OO.ui.SelectWidget
3706 * @mixins OO.ui.mixin.TabIndexedElement
3709 * @param {Object} [config] Configuration options
3711 OO
.ui
.TabSelectWidget
= function OoUiTabSelectWidget( config
) {
3712 // Parent constructor
3713 OO
.ui
.TabSelectWidget
.parent
.call( this, config
);
3715 // Mixin constructors
3716 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3720 focus
: this.bindDocumentKeyDownListener
.bind( this ),
3721 blur
: this.unbindDocumentKeyDownListener
.bind( this )
3726 .addClass( 'oo-ui-tabSelectWidget' )
3727 .attr( 'role', 'tablist' );
3732 OO
.inheritClass( OO
.ui
.TabSelectWidget
, OO
.ui
.SelectWidget
);
3733 OO
.mixinClass( OO
.ui
.TabSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3736 * TagItemWidgets are used within a {@link OO.ui.TagMultiselectWidget
3737 * TagMultiselectWidget} to display the selected items.
3740 * @extends OO.ui.Widget
3741 * @mixins OO.ui.mixin.ItemWidget
3742 * @mixins OO.ui.mixin.LabelElement
3743 * @mixins OO.ui.mixin.FlaggedElement
3744 * @mixins OO.ui.mixin.TabIndexedElement
3745 * @mixins OO.ui.mixin.DraggableElement
3748 * @param {Object} [config] Configuration object
3749 * @cfg {boolean} [valid=true] Item is valid
3750 * @cfg {boolean} [fixed] Item is fixed. This means the item is
3751 * always included in the values and cannot be removed.
3753 OO
.ui
.TagItemWidget
= function OoUiTagItemWidget( config
) {
3754 config
= config
|| {};
3756 // Parent constructor
3757 OO
.ui
.TagItemWidget
.parent
.call( this, config
);
3759 // Mixin constructors
3760 OO
.ui
.mixin
.ItemWidget
.call( this );
3761 OO
.ui
.mixin
.LabelElement
.call( this, config
);
3762 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
3763 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3764 OO
.ui
.mixin
.DraggableElement
.call( this, config
);
3766 this.valid
= config
.valid
=== undefined ? true : !!config
.valid
;
3767 this.fixed
= !!config
.fixed
;
3769 this.closeButton
= new OO
.ui
.ButtonWidget( {
3773 title
: OO
.ui
.msg( 'ooui-item-remove' )
3775 this.closeButton
.setDisabled( this.isDisabled() );
3779 .connect( this, { click
: 'remove' } );
3781 .on( 'click', this.select
.bind( this ) )
3782 .on( 'keydown', this.onKeyDown
.bind( this ) )
3783 // Prevent propagation of mousedown; the tag item "lives" in the
3784 // clickable area of the TagMultiselectWidget, which listens to
3785 // mousedown to open the menu or popup. We want to prevent that
3786 // for clicks specifically on the tag itself, so the actions taken
3787 // are more deliberate. When the tag is clicked, it will emit the
3788 // selection event (similar to how #OO.ui.MultioptionWidget emits 'change')
3789 // and can be handled separately.
3790 .on( 'mousedown', function ( e
) { e
.stopPropagation(); } );
3794 .addClass( 'oo-ui-tagItemWidget' )
3795 .append( this.$label
, this.closeButton
.$element
);
3798 /* Initialization */
3800 OO
.inheritClass( OO
.ui
.TagItemWidget
, OO
.ui
.Widget
);
3801 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.ItemWidget
);
3802 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.LabelElement
);
3803 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.FlaggedElement
);
3804 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3805 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.DraggableElement
);
3812 * A remove action was performed on the item
3817 * @param {string} direction Direction of the movement, forward or backwards
3819 * A navigate action was performed on the item
3825 * The tag widget was selected. This can occur when the widget
3826 * is either clicked or enter was pressed on it.
3831 * @param {boolean} isValid Item is valid
3833 * Item validity has changed
3838 * @param {boolean} isFixed Item is fixed
3840 * Item fixed state has changed
3846 * Set this item as fixed, meaning it cannot be removed
3848 * @param {string} [state] Item is fixed
3850 * @return {OO.ui.Widget} The widget, for chaining
3852 OO
.ui
.TagItemWidget
.prototype.setFixed = function ( state
) {
3853 state
= state
=== undefined ? !this.fixed
: !!state
;
3855 if ( this.fixed
!== state
) {
3857 if ( this.closeButton
) {
3858 this.closeButton
.toggle( !this.fixed
);
3861 if ( !this.fixed
&& this.elementGroup
&& !this.elementGroup
.isDraggable() ) {
3862 // Only enable the state of the item if the
3863 // entire group is draggable
3864 this.toggleDraggable( !this.fixed
);
3866 this.$element
.toggleClass( 'oo-ui-tagItemWidget-fixed', this.fixed
);
3868 this.emit( 'fixed', this.isFixed() );
3874 * Check whether the item is fixed
3877 OO
.ui
.TagItemWidget
.prototype.isFixed = function () {
3884 OO
.ui
.TagItemWidget
.prototype.setDisabled = function ( state
) {
3885 if ( state
&& this.elementGroup
&& !this.elementGroup
.isDisabled() ) {
3886 OO
.ui
.warnDeprecation( 'TagItemWidget#setDisabled: Disabling individual items is deprecated and will result in inconsistent behavior. Use #setFixed instead. See T193571.' );
3889 OO
.ui
.TagItemWidget
.parent
.prototype.setDisabled
.call( this, state
);
3892 // Verify we have a group, and that the widget is ready
3893 this.toggleDraggable
&& this.elementGroup
&&
3895 !this.elementGroup
.isDraggable()
3897 // Only enable the draggable state of the item if the
3898 // entire group is draggable to begin with, and if the
3899 // item is not fixed
3900 this.toggleDraggable( !state
);
3903 if ( this.closeButton
) {
3904 this.closeButton
.setDisabled( state
);
3911 * Handle removal of the item
3913 * This is mainly for extensibility concerns, so other children
3914 * of this class can change the behavior if they need to. This
3915 * is called by both clicking the 'remove' button but also
3916 * on keypress, which is harder to override if needed.
3920 OO
.ui
.TagItemWidget
.prototype.remove = function () {
3921 if ( !this.isDisabled() && !this.isFixed() ) {
3922 this.emit( 'remove' );
3927 * Handle a keydown event on the widget
3931 * @param {jQuery.Event} e Key down event
3932 * @return {boolean|undefined} false to stop the operation
3934 OO
.ui
.TagItemWidget
.prototype.onKeyDown = function ( e
) {
3937 if ( !this.isDisabled() && !this.isFixed() && ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
|| e
.keyCode
=== OO
.ui
.Keys
.DELETE
) ) {
3940 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ENTER
) {
3944 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
3945 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
3947 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
3961 e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
3962 movement
.left
: movement
.right
3973 OO
.ui
.TagItemWidget
.prototype.select = function () {
3974 if ( !this.isDisabled() ) {
3975 this.emit( 'select' );
3980 * Set the valid state of this item
3982 * @param {boolean} [valid] Item is valid
3985 OO
.ui
.TagItemWidget
.prototype.toggleValid = function ( valid
) {
3986 valid
= valid
=== undefined ? !this.valid
: !!valid
;
3988 if ( this.valid
!== valid
) {
3991 this.setFlags( { invalid
: !this.valid
} );
3993 this.emit( 'valid', this.valid
);
3998 * Check whether the item is valid
4000 * @return {boolean} Item is valid
4002 OO
.ui
.TagItemWidget
.prototype.isValid = function () {
4007 * A basic tag multiselect widget, similar in concept to {@link OO.ui.ComboBoxInputWidget combo box widget}
4008 * that allows the user to add multiple values that are displayed in a tag area.
4010 * This widget is a base widget; see {@link OO.ui.MenuTagMultiselectWidget MenuTagMultiselectWidget} and
4011 * {@link OO.ui.PopupTagMultiselectWidget PopupTagMultiselectWidget} for the implementations that use
4012 * a menu and a popup respectively.
4015 * // A TagMultiselectWidget.
4016 * var widget = new OO.ui.TagMultiselectWidget( {
4017 * inputPosition: 'outline',
4018 * allowedValues: [ 'Option 1', 'Option 2', 'Option 3' ],
4019 * selected: [ 'Option 1' ]
4021 * $( document.body ).append( widget.$element );
4024 * @extends OO.ui.Widget
4025 * @mixins OO.ui.mixin.GroupWidget
4026 * @mixins OO.ui.mixin.DraggableGroupElement
4027 * @mixins OO.ui.mixin.IndicatorElement
4028 * @mixins OO.ui.mixin.IconElement
4029 * @mixins OO.ui.mixin.TabIndexedElement
4030 * @mixins OO.ui.mixin.FlaggedElement
4031 * @mixins OO.ui.mixin.TitledElement
4034 * @param {Object} config Configuration object
4035 * @cfg {Object} [input] Configuration options for the input widget
4036 * @cfg {OO.ui.InputWidget} [inputWidget] An optional input widget. If given, it will
4037 * replace the input widget used in the TagMultiselectWidget. If not given,
4038 * TagMultiselectWidget creates its own.
4039 * @cfg {boolean} [inputPosition='inline'] Position of the input. Options are:
4040 * - inline: The input is invisible, but exists inside the tag list, so
4041 * the user types into the tag groups to add tags.
4042 * - outline: The input is underneath the tag area.
4043 * - none: No input supplied
4044 * @cfg {boolean} [allowEditTags=true] Allow editing of the tags by clicking them
4045 * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if
4046 * not present in the menu.
4047 * @cfg {Object[]} [allowedValues] An array representing the allowed items
4049 * @cfg {boolean} [allowDuplicates=false] Allow duplicate items to be added
4050 * @cfg {boolean} [allowDisplayInvalidTags=false] Allow the display of
4051 * invalid tags. These tags will display with an invalid state, and
4052 * the widget as a whole will have an invalid state if any invalid tags
4054 * @cfg {number} [tagLimit] An optional limit on the number of selected options.
4055 * If 'tagLimit' is set and is reached, the input is disabled, not allowing any
4056 * additions. If 'tagLimit' is unset or is 0, an unlimited number of items can be
4058 * @cfg {boolean} [allowReordering=true] Allow reordering of the items
4059 * @cfg {Object[]|String[]} [selected] A set of selected tags. If given,
4060 * these will appear in the tag list on initialization, as long as they
4061 * pass the validity tests.
4063 OO
.ui
.TagMultiselectWidget
= function OoUiTagMultiselectWidget( config
) {
4065 rAF
= window
.requestAnimationFrame
|| setTimeout
,
4067 $tabFocus
= $( '<span>' )
4068 .addClass( 'oo-ui-tagMultiselectWidget-focusTrap' );
4070 config
= config
|| {};
4072 // Parent constructor
4073 OO
.ui
.TagMultiselectWidget
.parent
.call( this, config
);
4075 // Mixin constructors
4076 OO
.ui
.mixin
.GroupWidget
.call( this, config
);
4077 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
4078 OO
.ui
.mixin
.IconElement
.call( this, config
);
4079 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
4080 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
4081 OO
.ui
.mixin
.DraggableGroupElement
.call( this, config
);
4082 OO
.ui
.mixin
.TitledElement
.call( this, config
);
4084 this.toggleDraggable(
4085 config
.allowReordering
=== undefined ?
4086 true : !!config
.allowReordering
4089 this.inputPosition
=
4090 this.constructor.static.allowedInputPositions
.indexOf( config
.inputPosition
) > -1 ?
4091 config
.inputPosition
: 'inline';
4092 this.allowEditTags
= config
.allowEditTags
=== undefined ? true : !!config
.allowEditTags
;
4093 this.allowArbitrary
= !!config
.allowArbitrary
;
4094 this.allowDuplicates
= !!config
.allowDuplicates
;
4095 this.allowedValues
= config
.allowedValues
|| [];
4096 this.allowDisplayInvalidTags
= config
.allowDisplayInvalidTags
;
4097 this.hasInput
= this.inputPosition
!== 'none';
4098 this.tagLimit
= config
.tagLimit
;
4102 this.$content
= $( '<div>' )
4103 .addClass( 'oo-ui-tagMultiselectWidget-content' );
4104 this.$handle
= $( '<div>' )
4105 .addClass( 'oo-ui-tagMultiselectWidget-handle' )
4112 .addClass( 'oo-ui-tagMultiselectWidget-group' )
4118 remove
: 'itemRemove',
4119 navigate
: 'itemNavigate',
4120 select
: 'itemSelect',
4123 this.connect( this, {
4124 itemRemove
: 'onTagRemove',
4125 itemSelect
: 'onTagSelect',
4126 itemFixed
: 'onTagFixed',
4127 itemNavigate
: 'onTagNavigate',
4128 change
: 'onChangeTags'
4131 mousedown
: this.onMouseDown
.bind( this )
4136 .addClass( 'oo-ui-tagMultiselectWidget' )
4137 .append( this.$handle
);
4139 if ( this.hasInput
) {
4140 if ( config
.inputWidget
) {
4141 this.input
= config
.inputWidget
;
4143 this.input
= new OO
.ui
.TextInputWidget( $.extend( {
4144 placeholder
: config
.placeholder
,
4145 classes
: [ 'oo-ui-tagMultiselectWidget-input' ]
4146 }, config
.input
) );
4148 this.input
.setDisabled( this.isDisabled() );
4151 focus
: this.onInputFocus
.bind( this ),
4152 blur
: this.onInputBlur
.bind( this ),
4153 'propertychange change click mouseup keydown keyup input cut paste select focus':
4154 OO
.ui
.debounce( this.updateInputSize
.bind( this ) ),
4155 keydown
: this.onInputKeyDown
.bind( this ),
4156 keypress
: this.onInputKeyPress
.bind( this )
4159 this.input
.$input
.on( inputEvents
);
4160 this.inputPlaceholder
= this.input
.$input
.attr( 'placeholder' );
4162 if ( this.inputPosition
=== 'outline' ) {
4163 // Override max-height for the input widget
4164 // in the case the widget is outline so it can
4165 // stretch all the way if the widget is wide
4166 this.input
.$element
.css( 'max-width', 'inherit' );
4168 .addClass( 'oo-ui-tagMultiselectWidget-outlined' )
4169 .append( this.input
.$element
);
4171 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-inlined' );
4172 // HACK: When the widget is using 'inline' input, the
4173 // behavior needs to only use the $input itself
4174 // so we style and size it accordingly (otherwise
4175 // the styling and sizing can get very convoluted
4176 // when the wrapping divs and other elements)
4177 // We are taking advantage of still being able to
4178 // call the widget itself for operations like
4179 // .getValue() and setDisabled() and .focus() but
4180 // having only the $input attached to the DOM
4181 this.$content
.append( this.input
.$input
);
4184 this.$content
.append( $tabFocus
);
4187 this.setTabIndexedElement(
4193 if ( config
.selected
) {
4194 this.setValue( config
.selected
);
4197 // HACK: Input size needs to be calculated after everything
4200 if ( widget
.hasInput
) {
4201 widget
.updateInputSize();
4206 /* Initialization */
4208 OO
.inheritClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.Widget
);
4209 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.GroupWidget
);
4210 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.DraggableGroupElement
);
4211 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IndicatorElement
);
4212 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IconElement
);
4213 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
4214 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.FlaggedElement
);
4215 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.TitledElement
);
4217 /* Static properties */
4220 * Allowed input positions.
4221 * - inline: The input is inside the tag list
4222 * - outline: The input is under the tag list
4223 * - none: There is no input
4227 OO
.ui
.TagMultiselectWidget
.static.allowedInputPositions
= [ 'inline', 'outline', 'none' ];
4232 * Handle mouse down events.
4235 * @param {jQuery.Event} e Mouse down event
4236 * @return {boolean} False to prevent defaults
4238 OO
.ui
.TagMultiselectWidget
.prototype.onMouseDown = function ( e
) {
4240 !this.isDisabled() &&
4241 ( !this.hasInput
|| e
.target
!== this.input
.$input
[ 0 ] ) &&
4242 e
.which
=== OO
.ui
.MouseButtons
.LEFT
4250 * Handle key press events.
4253 * @param {jQuery.Event} e Key press event
4254 * @return {boolean} Whether to prevent defaults
4256 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyPress = function ( e
) {
4258 withMetaKey
= e
.metaKey
|| e
.ctrlKey
;
4260 if ( !this.isDisabled() ) {
4261 if ( e
.which
=== OO
.ui
.Keys
.ENTER
) {
4262 stopOrContinue
= this.doInputEnter( e
, withMetaKey
);
4265 // Make sure the input gets resized.
4266 setTimeout( this.updateInputSize
.bind( this ), 0 );
4267 return stopOrContinue
;
4272 * Handle key down events.
4275 * @param {jQuery.Event} e Key down event
4278 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyDown = function ( e
) {
4279 var movement
, direction
,
4281 withMetaKey
= e
.metaKey
|| e
.ctrlKey
,
4282 isMovementInsideInput = function ( direction
) {
4283 var inputRange
= widget
.input
.getRange(),
4284 inputValue
= widget
.hasInput
&& widget
.input
.getValue();
4286 if ( direction
=== 'forwards' && inputRange
.to
> inputValue
.length
- 1 ) {
4290 if ( direction
=== 'backwards' && inputRange
.from <= 0 ) {
4297 if ( !this.isDisabled() ) {
4298 // 'keypress' event is not triggered for Backspace
4299 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
) {
4300 return this.doInputBackspace( e
, withMetaKey
);
4301 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ESCAPE
) {
4302 return this.doInputEscape( e
);
4304 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
4305 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
4307 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
4318 direction
= e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
4319 movement
.left
: movement
.right
;
4321 if ( !this.hasInput
|| !isMovementInsideInput( direction
) ) {
4322 return this.doInputArrow( e
, direction
, withMetaKey
);
4329 * Respond to input focus event
4331 OO
.ui
.TagMultiselectWidget
.prototype.onInputFocus = function () {
4332 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-focus' );
4334 this.toggleValid( true );
4338 * Respond to input blur event
4340 OO
.ui
.TagMultiselectWidget
.prototype.onInputBlur = function () {
4341 this.$element
.removeClass( 'oo-ui-tagMultiselectWidget-focus' );
4343 // Set the widget as invalid if there's text in the input
4344 this.addTagFromInput();
4345 this.toggleValid( this.checkValidity() && ( !this.hasInput
|| !this.input
.getValue() ) );
4349 * Perform an action after the enter key on the input
4351 * @param {jQuery.Event} e Event data
4352 * @param {boolean} [withMetaKey] Whether this key was pressed with
4353 * a meta key like 'ctrl'
4354 * @return {boolean} Whether to prevent defaults
4356 OO
.ui
.TagMultiselectWidget
.prototype.doInputEnter = function () {
4357 this.addTagFromInput();
4362 * Perform an action responding to the enter key on the input
4364 * @param {jQuery.Event} e Event data
4365 * @param {boolean} [withMetaKey] Whether this key was pressed with
4366 * a meta key like 'ctrl'
4367 * @return {boolean} Whether to prevent defaults
4369 OO
.ui
.TagMultiselectWidget
.prototype.doInputBackspace = function ( e
, withMetaKey
) {
4373 this.inputPosition
=== 'inline' &&
4374 this.input
.getValue() === '' &&
4377 // Delete the last item
4378 items
= this.getItems();
4379 item
= items
[ items
.length
- 1 ];
4381 if ( !item
.isDisabled() && !item
.isFixed() ) {
4382 this.removeItems( [ item
] );
4383 // If Ctrl/Cmd was pressed, delete item entirely.
4384 // Otherwise put it into the text field for editing.
4385 if ( !withMetaKey
) {
4386 this.input
.setValue( item
.getLabel() );
4395 * Perform an action after the escape key on the input
4397 * @param {jQuery.Event} e Event data
4399 OO
.ui
.TagMultiselectWidget
.prototype.doInputEscape = function () {
4404 * Perform an action after the arrow key on the input, select the previous
4405 * item from the input.
4406 * See #getPreviousItem
4408 * @param {jQuery.Event} e Event data
4409 * @param {string} direction Direction of the movement; forwards or backwards
4410 * @param {boolean} [withMetaKey] Whether this key was pressed with
4411 * a meta key like 'ctrl'
4413 OO
.ui
.TagMultiselectWidget
.prototype.doInputArrow = function ( e
, direction
) {
4415 this.inputPosition
=== 'inline' &&
4417 direction
=== 'backwards'
4419 // Get previous item
4420 this.getPreviousItem().focus();
4425 * Respond to item select event
4427 * @param {OO.ui.TagItemWidget} item Selected item
4429 OO
.ui
.TagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
4430 if ( this.hasInput
&& this.allowEditTags
&& !item
.isFixed() ) {
4431 if ( this.input
.getValue() ) {
4432 this.addTagFromInput();
4434 // 1. Get the label of the tag into the input
4435 this.input
.setValue( item
.getData() );
4436 // 2. Remove the tag
4437 this.removeItems( [ item
] );
4438 // 3. Focus the input
4444 * Respond to item fixed state change
4446 * @param {OO.ui.TagItemWidget} item Selected item
4448 OO
.ui
.TagMultiselectWidget
.prototype.onTagFixed = function ( item
) {
4450 items
= this.getItems();
4452 // Move item to the end of the static items
4453 for ( i
= 0; i
< items
.length
; i
++ ) {
4454 if ( items
[ i
] !== item
&& !items
[ i
].isFixed() ) {
4458 this.addItems( item
, i
);
4461 * Respond to change event, where items were added, removed, or cleared.
4463 OO
.ui
.TagMultiselectWidget
.prototype.onChangeTags = function () {
4464 var isUnderLimit
= this.isUnderLimit();
4468 this.checkValidity() &&
4469 !( this.hasInput
&& this.input
.getValue() )
4472 if ( this.hasInput
) {
4473 this.updateInputSize();
4474 if ( !isUnderLimit
) {
4476 this.input
.setValue( '' );
4478 if ( this.inputPosition
=== 'outline' ) {
4479 // Show/clear the placeholder and enable/disable the input
4480 // based on whether we are/aren't under the specified limit
4481 this.input
.$input
.attr( 'placeholder', isUnderLimit
? this.inputPlaceholder
: '' );
4482 this.input
.setDisabled( !isUnderLimit
);
4484 // Show/hide the input
4485 this.input
.$input
.toggleClass( 'oo-ui-element-hidden', !isUnderLimit
);
4488 this.updateIfHeightChanged();
4494 OO
.ui
.TagMultiselectWidget
.prototype.setDisabled = function ( isDisabled
) {
4496 OO
.ui
.TagMultiselectWidget
.parent
.prototype.setDisabled
.call( this, isDisabled
);
4498 if ( this.hasInput
&& this.input
) {
4499 if ( !isDisabled
) {
4500 this.updateInputSize();
4502 this.input
.setDisabled( !!isDisabled
&& !this.isUnderLimit() );
4506 this.getItems().forEach( function ( item
) {
4507 item
.setDisabled( !!isDisabled
);
4513 * Respond to tag remove event
4514 * @param {OO.ui.TagItemWidget} item Removed tag
4516 OO
.ui
.TagMultiselectWidget
.prototype.onTagRemove = function ( item
) {
4517 this.removeTagByData( item
.getData() );
4521 * Respond to navigate event on the tag
4523 * @param {OO.ui.TagItemWidget} item Removed tag
4524 * @param {string} direction Direction of movement; 'forwards' or 'backwards'
4526 OO
.ui
.TagMultiselectWidget
.prototype.onTagNavigate = function ( item
, direction
) {
4527 var firstItem
= this.getItems()[ 0 ];
4529 if ( direction
=== 'forwards' ) {
4530 this.getNextItem( item
).focus();
4531 } else if ( !this.inputPosition
=== 'inline' || item
!== firstItem
) {
4532 // If the widget has an inline input, we want to stop at the starting edge
4534 this.getPreviousItem( item
).focus();
4539 * Add tag from input value
4541 OO
.ui
.TagMultiselectWidget
.prototype.addTagFromInput = function () {
4542 var val
= this.input
.getValue(),
4543 isValid
= this.isAllowedData( val
);
4549 if ( isValid
|| this.allowDisplayInvalidTags
) {
4558 OO
.ui
.TagMultiselectWidget
.prototype.clearInput = function () {
4559 this.input
.setValue( '' );
4563 * Check whether the given value is a duplicate of an existing
4564 * tag already in the list.
4566 * @param {string|Object} data Requested value
4567 * @return {boolean} Value is duplicate
4569 OO
.ui
.TagMultiselectWidget
.prototype.isDuplicateData = function ( data
) {
4570 return !!this.findItemFromData( data
);
4574 * Check whether a given value is allowed to be added
4576 * @param {string|Object} data Requested value
4577 * @return {boolean} Value is allowed
4579 OO
.ui
.TagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
4581 !this.allowDuplicates
&&
4582 this.isDuplicateData( data
)
4587 if ( this.allowArbitrary
) {
4591 // Check with allowed values
4593 this.getAllowedValues().some( function ( value
) {
4594 return data
=== value
;
4604 * Get the allowed values list
4606 * @return {string[]} Allowed data values
4608 OO
.ui
.TagMultiselectWidget
.prototype.getAllowedValues = function () {
4609 return this.allowedValues
;
4613 * Add a value to the allowed values list
4615 * @param {string} value Allowed data value
4617 OO
.ui
.TagMultiselectWidget
.prototype.addAllowedValue = function ( value
) {
4618 if ( this.allowedValues
.indexOf( value
) === -1 ) {
4619 this.allowedValues
.push( value
);
4624 * Get the datas of the currently selected items
4626 * @return {string[]|Object[]} Datas of currently selected items
4628 OO
.ui
.TagMultiselectWidget
.prototype.getValue = function () {
4629 return this.getItems()
4630 .filter( function ( item
) {
4631 return item
.isValid();
4633 .map( function ( item
) {
4634 return item
.getData();
4639 * Set the value of this widget by datas.
4641 * @param {string|string[]|Object|Object[]} valueObject An object representing the data
4642 * and label of the value. If the widget allows arbitrary values,
4643 * the items will be added as-is. Otherwise, the data value will
4644 * be checked against allowedValues.
4645 * This object must contain at least a data key. Example:
4646 * { data: 'foo', label: 'Foo item' }
4647 * For multiple items, use an array of objects. For example:
4649 * { data: 'foo', label: 'Foo item' },
4650 * { data: 'bar', label: 'Bar item' }
4652 * Value can also be added with plaintext array, for example:
4653 * [ 'foo', 'bar', 'bla' ] or a single string, like 'foo'
4655 OO
.ui
.TagMultiselectWidget
.prototype.setValue = function ( valueObject
) {
4656 valueObject
= Array
.isArray( valueObject
) ? valueObject
: [ valueObject
];
4659 valueObject
.forEach( function ( obj
) {
4660 if ( typeof obj
=== 'string' ) {
4663 this.addTag( obj
.data
, obj
.label
);
4669 * Add tag to the display area
4671 * @param {string|Object} data Tag data
4672 * @param {string} [label] Tag label. If no label is provided, the
4673 * stringified version of the data will be used instead.
4674 * @return {boolean} Item was added successfully
4676 OO
.ui
.TagMultiselectWidget
.prototype.addTag = function ( data
, label
) {
4678 isValid
= this.isAllowedData( data
);
4680 if ( this.isUnderLimit() && ( isValid
|| this.allowDisplayInvalidTags
) ) {
4681 newItemWidget
= this.createTagItemWidget( data
, label
);
4682 newItemWidget
.toggleValid( isValid
);
4683 this.addItems( [ newItemWidget
] );
4691 * Check whether the number of current tags is within the limit.
4693 * @return {boolean} True if current tag count is within the limit or
4694 * if 'tagLimit' is not set
4696 OO
.ui
.TagMultiselectWidget
.prototype.isUnderLimit = function () {
4697 return !this.tagLimit
||
4698 this.getItemCount() < this.tagLimit
;
4702 * Remove tag by its data property.
4704 * @param {string|Object} data Tag data
4706 OO
.ui
.TagMultiselectWidget
.prototype.removeTagByData = function ( data
) {
4707 var item
= this.findItemFromData( data
);
4709 this.removeItems( [ item
] );
4713 * Construct a OO.ui.TagItemWidget (or a subclass thereof) from given label and data.
4716 * @param {string} data Item data
4717 * @param {string} label The label text.
4718 * @return {OO.ui.TagItemWidget}
4720 OO
.ui
.TagMultiselectWidget
.prototype.createTagItemWidget = function ( data
, label
) {
4721 label
= label
|| data
;
4723 return new OO
.ui
.TagItemWidget( { data
: data
, label
: label
} );
4727 * Given an item, returns the item after it. If the item is already the
4728 * last item, return `this.input`. If no item is passed, returns the
4732 * @param {OO.ui.TagItemWidget} [item] Tag item
4733 * @return {OO.ui.Widget} The next widget available.
4735 OO
.ui
.TagMultiselectWidget
.prototype.getNextItem = function ( item
) {
4736 var itemIndex
= this.items
.indexOf( item
);
4738 if ( item
=== undefined || itemIndex
=== -1 ) {
4739 return this.items
[ 0 ];
4742 if ( itemIndex
=== this.items
.length
- 1 ) { // Last item
4743 if ( this.hasInput
) {
4746 // Return first item
4747 return this.items
[ 0 ];
4750 return this.items
[ itemIndex
+ 1 ];
4755 * Given an item, returns the item before it. If the item is already the
4756 * first item, return `this.input`. If no item is passed, returns the
4760 * @param {OO.ui.TagItemWidget} [item] Tag item
4761 * @return {OO.ui.Widget} The previous widget available.
4763 OO
.ui
.TagMultiselectWidget
.prototype.getPreviousItem = function ( item
) {
4764 var itemIndex
= this.items
.indexOf( item
);
4766 if ( item
=== undefined || itemIndex
=== -1 ) {
4767 return this.items
[ this.items
.length
- 1 ];
4770 if ( itemIndex
=== 0 ) {
4771 if ( this.hasInput
) {
4774 // Return the last item
4775 return this.items
[ this.items
.length
- 1 ];
4778 return this.items
[ itemIndex
- 1 ];
4783 * Update the dimensions of the text input field to encompass all available area.
4784 * This is especially relevant for when the input is at the edge of a line
4785 * and should get smaller. The usual operation (as an inline-block with min-width)
4786 * does not work in that case, pushing the input downwards to the next line.
4790 OO
.ui
.TagMultiselectWidget
.prototype.updateInputSize = function () {
4791 var $lastItem
, direction
, contentWidth
, currentWidth
, bestWidth
;
4792 if ( this.inputPosition
=== 'inline' && !this.isDisabled() ) {
4793 if ( this.input
.$input
[ 0 ].scrollWidth
=== 0 ) {
4794 // Input appears to be attached but not visible.
4795 // Don't attempt to adjust its size, because our measurements
4796 // are going to fail anyway.
4799 this.input
.$input
.css( 'width', '1em' );
4800 $lastItem
= this.$group
.children().last();
4801 direction
= OO
.ui
.Element
.static.getDir( this.$handle
);
4803 // Get the width of the input with the placeholder text as
4804 // the value and save it so that we don't keep recalculating
4806 this.contentWidthWithPlaceholder
=== undefined &&
4807 this.input
.getValue() === '' &&
4808 this.input
.$input
.attr( 'placeholder' ) !== undefined
4810 this.input
.setValue( this.input
.$input
.attr( 'placeholder' ) );
4811 this.contentWidthWithPlaceholder
= this.input
.$input
[ 0 ].scrollWidth
;
4812 this.input
.setValue( '' );
4816 // Always keep the input wide enough for the placeholder text
4817 contentWidth
= Math
.max(
4818 this.input
.$input
[ 0 ].scrollWidth
,
4819 // undefined arguments in Math.max lead to NaN
4820 ( this.contentWidthWithPlaceholder
=== undefined ) ?
4821 0 : this.contentWidthWithPlaceholder
4823 currentWidth
= this.input
.$input
.width();
4825 if ( contentWidth
< currentWidth
) {
4826 this.updateIfHeightChanged();
4827 // All is fine, don't perform expensive calculations
4831 if ( $lastItem
.length
=== 0 ) {
4832 bestWidth
= this.$content
.innerWidth();
4834 bestWidth
= direction
=== 'ltr' ?
4835 this.$content
.innerWidth() - $lastItem
.position().left
- $lastItem
.outerWidth() :
4836 $lastItem
.position().left
;
4839 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
4840 // pixels this is off by are coming from.
4842 if ( contentWidth
> bestWidth
) {
4843 // This will result in the input getting shifted to the next line
4844 bestWidth
= this.$content
.innerWidth() - 13;
4846 this.input
.$input
.width( Math
.floor( bestWidth
) );
4847 this.updateIfHeightChanged();
4849 this.updateIfHeightChanged();
4854 * Determine if widget height changed, and if so,
4855 * emit the resize event. This is useful for when there are either
4856 * menus or popups attached to the bottom of the widget, to allow
4857 * them to change their positioning in case the widget moved down
4862 OO
.ui
.TagMultiselectWidget
.prototype.updateIfHeightChanged = function () {
4863 var height
= this.$element
.height();
4864 if ( height
!== this.height
) {
4865 this.height
= height
;
4866 this.emit( 'resize' );
4871 * Check whether all items in the widget are valid
4873 * @return {boolean} Widget is valid
4875 OO
.ui
.TagMultiselectWidget
.prototype.checkValidity = function () {
4876 return this.getItems().every( function ( item
) {
4877 return item
.isValid();
4882 * Set the valid state of this item
4884 * @param {boolean} [valid] Item is valid
4887 OO
.ui
.TagMultiselectWidget
.prototype.toggleValid = function ( valid
) {
4888 valid
= valid
=== undefined ? !this.valid
: !!valid
;
4890 if ( this.valid
!== valid
) {
4893 this.setFlags( { invalid
: !this.valid
} );
4895 this.emit( 'valid', this.valid
);
4900 * Get the current valid state of the widget
4902 * @return {boolean} Widget is valid
4904 OO
.ui
.TagMultiselectWidget
.prototype.isValid = function () {
4909 * PopupTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
4910 * to use a popup. The popup can be configured to have a default input to insert values into the widget.
4913 * // A PopupTagMultiselectWidget.
4914 * var widget = new OO.ui.PopupTagMultiselectWidget();
4915 * $( document.body ).append( widget.$element );
4917 * // Example: A PopupTagMultiselectWidget with an external popup.
4918 * var popupInput = new OO.ui.TextInputWidget(),
4919 * widget = new OO.ui.PopupTagMultiselectWidget( {
4920 * popupInput: popupInput,
4922 * $content: popupInput.$element
4925 * $( document.body ).append( widget.$element );
4928 * @extends OO.ui.TagMultiselectWidget
4929 * @mixins OO.ui.mixin.PopupElement
4931 * @param {Object} config Configuration object
4932 * @cfg {jQuery} [$overlay] An overlay for the popup.
4933 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
4934 * @cfg {Object} [popup] Configuration options for the popup
4935 * @cfg {OO.ui.InputWidget} [popupInput] An input widget inside the popup that will be
4936 * focused when the popup is opened and will be used as replacement for the
4937 * general input in the widget.
4940 OO
.ui
.PopupTagMultiselectWidget
= function OoUiPopupTagMultiselectWidget( config
) {
4942 defaultConfig
= { popup
: {} };
4944 config
= config
|| {};
4946 // Parent constructor
4947 OO
.ui
.PopupTagMultiselectWidget
.parent
.call( this, $.extend( { inputPosition
: 'none' }, config
) );
4949 this.$overlay
= ( config
.$overlay
=== true ? OO
.ui
.getDefaultOverlay() : config
.$overlay
) || this.$element
;
4951 if ( !config
.popup
) {
4952 // For the default base implementation, we give a popup
4953 // with an input widget inside it. For any other use cases
4954 // the popup needs to be populated externally and the
4955 // event handled to add tags separately and manually
4956 defaultInput
= new OO
.ui
.TextInputWidget();
4958 defaultConfig
.popupInput
= defaultInput
;
4959 defaultConfig
.popup
.$content
= defaultInput
.$element
;
4960 defaultConfig
.popup
.padded
= true;
4962 this.$element
.addClass( 'oo-ui-popupTagMultiselectWidget-defaultPopup' );
4965 // Add overlay, and add that to the autoCloseIgnore
4966 defaultConfig
.popup
.$overlay
= this.$overlay
;
4967 defaultConfig
.popup
.$autoCloseIgnore
= this.hasInput
?
4968 this.input
.$element
.add( this.$overlay
) : this.$overlay
;
4970 // Allow extending any of the above
4971 config
= $.extend( defaultConfig
, config
);
4973 // Mixin constructors
4974 OO
.ui
.mixin
.PopupElement
.call( this, config
);
4976 if ( this.hasInput
) {
4977 this.input
.$input
.on( 'focus', this.popup
.toggle
.bind( this.popup
, true ) );
4980 // Configuration options
4981 this.popupInput
= config
.popupInput
;
4982 if ( this.popupInput
) {
4983 this.popupInput
.connect( this, {
4984 enter
: 'onPopupInputEnter'
4989 this.on( 'resize', this.popup
.updateDimensions
.bind( this.popup
) );
4990 this.popup
.connect( this, { toggle
: 'onPopupToggle' } );
4992 .on( 'focus', this.onFocus
.bind( this ) );
4996 .append( this.popup
.$element
)
4997 .addClass( 'oo-ui-popupTagMultiselectWidget' );
4999 // Deprecation warning
5000 OO
.ui
.warnDeprecation( 'PopupTagMultiselectWidget: Deprecated widget. Use MenuTagMultiselectWidget instead. See T208821.' );
5003 /* Initialization */
5005 OO
.inheritClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
5006 OO
.mixinClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.mixin
.PopupElement
);
5011 * Focus event handler.
5015 OO
.ui
.PopupTagMultiselectWidget
.prototype.onFocus = function () {
5016 this.popup
.toggle( true );
5020 * Respond to popup toggle event
5022 * @param {boolean} isVisible Popup is visible
5024 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupToggle = function ( isVisible
) {
5025 if ( isVisible
&& this.popupInput
) {
5026 this.popupInput
.focus();
5031 * Respond to popup input enter event
5033 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupInputEnter = function () {
5034 if ( this.popupInput
) {
5035 this.addTagByPopupValue( this.popupInput
.getValue() );
5036 this.popupInput
.setValue( '' );
5043 OO
.ui
.PopupTagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
5044 if ( this.popupInput
&& this.allowEditTags
) {
5045 this.popupInput
.setValue( item
.getData() );
5046 this.removeItems( [ item
] );
5048 this.popup
.toggle( true );
5049 this.popupInput
.focus();
5052 OO
.ui
.PopupTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, item
);
5057 * Add a tag by the popup value.
5058 * Whatever is responsible for setting the value in the popup should call
5059 * this method to add a tag, or use the regular methods like #addTag or
5060 * #setValue directly.
5062 * @param {string} data The value of item
5063 * @param {string} [label] The label of the tag. If not given, the data is used.
5065 OO
.ui
.PopupTagMultiselectWidget
.prototype.addTagByPopupValue = function ( data
, label
) {
5066 this.addTag( data
, label
);
5070 * MenuTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
5071 * to use a menu of selectable options.
5074 * // A basic MenuTagMultiselectWidget.
5075 * var widget = new OO.ui.MenuTagMultiselectWidget( {
5076 * inputPosition: 'outline',
5078 * { data: 'option1', label: 'Option 1', icon: 'tag' },
5079 * { data: 'option2', label: 'Option 2' },
5080 * { data: 'option3', label: 'Option 3' },
5082 * selected: [ 'option1', 'option2' ]
5084 * $( document.body ).append( widget.$element );
5087 * @extends OO.ui.TagMultiselectWidget
5090 * @param {Object} [config] Configuration object
5091 * @cfg {boolean} [clearInputOnChoose=true] Clear the text input value when a menu option is chosen
5092 * @cfg {Object} [menu] Configuration object for the menu widget
5093 * @cfg {jQuery} [$overlay] An overlay for the menu.
5094 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
5095 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
5097 OO
.ui
.MenuTagMultiselectWidget
= function OoUiMenuTagMultiselectWidget( config
) {
5098 config
= config
|| {};
5100 // Parent constructor
5101 OO
.ui
.MenuTagMultiselectWidget
.parent
.call( this, config
);
5103 this.$overlay
= ( config
.$overlay
=== true ? OO
.ui
.getDefaultOverlay() : config
.$overlay
) || this.$element
;
5104 this.clearInputOnChoose
= config
.clearInputOnChoose
=== undefined || !!config
.clearInputOnChoose
;
5105 this.menu
= this.createMenuWidget( $.extend( {
5107 input
: this.hasInput
? this.input
: null,
5108 $input
: this.hasInput
? this.input
.$input
: null,
5109 filterFromInput
: !!this.hasInput
,
5110 $autoCloseIgnore
: this.hasInput
?
5111 this.input
.$element
: $( [] ),
5112 $floatableContainer
: this.hasInput
&& this.inputPosition
=== 'outline' ?
5113 this.input
.$element
: this.$element
,
5114 $overlay
: this.$overlay
,
5115 disabled
: this.isDisabled()
5117 this.addOptions( config
.options
|| [] );
5120 this.menu
.connect( this, {
5121 choose
: 'onMenuChoose',
5122 toggle
: 'onMenuToggle'
5124 if ( this.hasInput
) {
5125 this.input
.connect( this, { change
: 'onInputChange' } );
5127 this.connect( this, { resize
: 'onResize' } );
5131 .append( this.menu
.$element
);
5133 .addClass( 'oo-ui-menuTagMultiselectWidget' );
5134 // Remove MenuSelectWidget's generic focus owner ARIA attribute
5135 // TODO: Should this widget have a `role` that is compatible with this attribute?
5136 this.menu
.$focusOwner
.removeAttr( 'aria-expanded' );
5137 // TagMultiselectWidget already does this, but it doesn't work right because this.menu is not yet
5138 // set up while the parent constructor runs, and #getAllowedValues rejects everything.
5139 if ( config
.selected
) {
5140 this.setValue( config
.selected
);
5144 /* Initialization */
5146 OO
.inheritClass( OO
.ui
.MenuTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
5151 * Respond to resize event
5153 OO
.ui
.MenuTagMultiselectWidget
.prototype.onResize = function () {
5154 // Reposition the menu
5155 this.menu
.position();
5161 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputFocus = function () {
5163 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
5165 this.menu
.toggle( true );
5171 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputBlur = function () {
5173 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onInputBlur
.call( this );
5175 this.menu
.toggle( false );
5179 * Respond to input change event
5181 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputChange = function () {
5182 this.menu
.toggle( true );
5183 this.initializeMenuSelection();
5187 * Respond to menu choose event
5189 * @param {OO.ui.OptionWidget} menuItem Chosen menu item
5191 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuChoose = function ( menuItem
) {
5192 if ( this.hasInput
&& this.clearInputOnChoose
) {
5193 this.input
.setValue( '' );
5196 this.addTag( menuItem
.getData(), menuItem
.getLabel() );
5200 * Respond to menu toggle event. Reset item highlights on hide.
5202 * @param {boolean} isVisible The menu is visible
5204 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
5206 this.menu
.selectItem( null );
5207 this.menu
.highlightItem( null );
5209 this.initializeMenuSelection();
5211 setTimeout( function () {
5212 // Remove MenuSelectWidget's generic focus owner ARIA attribute
5213 // TODO: Should this widget have a `role` that is compatible with this attribute?
5214 this.menu
.$focusOwner
.removeAttr( 'aria-expanded' );
5221 OO
.ui
.MenuTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
5222 var menuItem
= this.menu
.findItemFromData( tagItem
.getData() );
5223 if ( !this.allowArbitrary
) {
5224 // Override the base behavior from TagMultiselectWidget; the base behavior
5225 // in TagMultiselectWidget is to remove the tag to edit it in the input,
5226 // but in our case, we want to utilize the menu selection behavior, and
5227 // definitely not remove the item.
5229 // If there is an input that is used for filtering, erase the value so we don't filter
5230 if ( this.hasInput
&& this.menu
.filterFromInput
) {
5231 this.input
.setValue( '' );
5234 // Select the menu item
5235 this.menu
.selectItem( menuItem
);
5240 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, tagItem
);
5247 OO
.ui
.MenuTagMultiselectWidget
.prototype.setDisabled = function ( isDisabled
) {
5249 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.setDisabled
.call( this, isDisabled
);
5252 // Protect against calling setDisabled() before the menu was initialized
5253 this.menu
.setDisabled( isDisabled
);
5258 * Highlight the first selectable item in the menu, if configured.
5263 OO
.ui
.MenuTagMultiselectWidget
.prototype.initializeMenuSelection = function () {
5264 if ( !this.menu
.findSelectedItem() ) {
5265 this.menu
.highlightItem(
5266 this.allowArbitrary
?
5268 this.menu
.findFirstSelectableItem()
5276 OO
.ui
.MenuTagMultiselectWidget
.prototype.addTagFromInput = function () {
5277 var val
= this.input
.getValue(),
5278 // Look for a highlighted item first
5279 // Then look for the element that fits the data
5280 item
= this.menu
.findHighlightedItem() || this.menu
.findItemFromData( val
),
5281 data
= item
? item
.getData() : val
,
5282 isValid
= this.isAllowedData( data
);
5284 // Override the parent method so we add from the menu
5285 // rather than directly from the input
5291 if ( isValid
|| this.allowDisplayInvalidTags
) {
5294 this.addTag( data
, item
.getLabel() );
5302 * Return the visible items in the menu. This is mainly used for when
5303 * the menu is filtering results.
5305 * @return {OO.ui.MenuOptionWidget[]} Visible results
5307 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenuVisibleItems = function () {
5308 return this.menu
.getItems().filter( function ( menuItem
) {
5309 return menuItem
.isVisible();
5314 * Create the menu for this widget. This is in a separate method so that
5315 * child classes can override this without polluting the constructor with
5316 * unnecessary extra objects that will be overidden.
5318 * @param {Object} menuConfig Configuration options
5319 * @return {OO.ui.MenuSelectWidget} Menu widget
5321 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
5322 return new OO
.ui
.MenuSelectWidget( menuConfig
);
5326 * Add options to the menu
5328 * @param {Object[]} menuOptions Object defining options
5330 OO
.ui
.MenuTagMultiselectWidget
.prototype.addOptions = function ( menuOptions
) {
5332 items
= menuOptions
.map( function ( obj
) {
5333 return widget
.createMenuOptionWidget( obj
.data
, obj
.label
, obj
.icon
);
5336 this.menu
.addItems( items
);
5340 * Create a menu option widget.
5342 * @param {string} data Item data
5343 * @param {string} [label] Item label
5344 * @param {string} [icon] Symbolic icon name
5345 * @return {OO.ui.OptionWidget} Option widget
5347 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuOptionWidget = function ( data
, label
, icon
) {
5348 return new OO
.ui
.MenuOptionWidget( {
5350 label
: label
|| data
,
5358 * @return {OO.ui.MenuSelectWidget} Menu
5360 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenu = function () {
5365 * Get the allowed values list
5367 * @return {string[]} Allowed data values
5369 OO
.ui
.MenuTagMultiselectWidget
.prototype.getAllowedValues = function () {
5372 // If the parent constructor is calling us, we're not ready yet, this.menu is not set up.
5373 menuDatas
= this.menu
.getItems().map( function ( menuItem
) {
5374 return menuItem
.getData();
5377 return this.allowedValues
.concat( menuDatas
);
5381 * SelectFileWidgets allow for selecting files, using the HTML5 File API. These
5382 * widgets can be configured with {@link OO.ui.mixin.IconElement icons}, {@link
5383 * OO.ui.mixin.IndicatorElement indicators} and {@link OO.ui.mixin.TitledElement titles}.
5384 * Please see the [OOUI documentation on MediaWiki] [1] for more information and examples.
5387 * // A file select widget.
5388 * var selectFile = new OO.ui.SelectFileWidget();
5389 * $( document.body ).append( selectFile.$element );
5391 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets
5394 * @extends OO.ui.Widget
5395 * @mixins OO.ui.mixin.IconElement
5396 * @mixins OO.ui.mixin.IndicatorElement
5397 * @mixins OO.ui.mixin.PendingElement
5398 * @mixins OO.ui.mixin.LabelElement
5399 * @mixins OO.ui.mixin.TitledElement
5402 * @param {Object} [config] Configuration options
5403 * @cfg {string[]|null} [accept=null] MIME types to accept. null accepts all types.
5404 * @cfg {string} [placeholder] Text to display when no file is selected.
5405 * @cfg {string} [notsupported] Text to display when file support is missing in the browser.
5406 * @cfg {boolean} [droppable=true] Whether to accept files by drag and drop.
5407 * @cfg {boolean} [showDropTarget=false] Whether to show a drop target. Requires droppable to be true.
5408 * @cfg {number} [thumbnailSizeLimit=20] File size limit in MiB above which to not try and show a
5409 * preview (for performance)
5411 OO
.ui
.SelectFileWidget
= function OoUiSelectFileWidget( config
) {
5414 // Configuration initialization
5415 config
= $.extend( {
5417 placeholder
: OO
.ui
.msg( 'ooui-selectfile-placeholder' ),
5418 notsupported
: OO
.ui
.msg( 'ooui-selectfile-not-supported' ),
5420 showDropTarget
: false,
5421 thumbnailSizeLimit
: 20
5424 // Parent constructor
5425 OO
.ui
.SelectFileWidget
.parent
.call( this, config
);
5427 // Mixin constructors
5428 OO
.ui
.mixin
.IconElement
.call( this, config
);
5429 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
5430 OO
.ui
.mixin
.PendingElement
.call( this, $.extend( {}, config
, { $pending
: this.$info
} ) );
5431 OO
.ui
.mixin
.LabelElement
.call( this, config
);
5432 OO
.ui
.mixin
.TitledElement
.call( this, config
);
5435 this.$info
= $( '<span>' );
5436 this.showDropTarget
= config
.showDropTarget
;
5437 this.thumbnailSizeLimit
= config
.thumbnailSizeLimit
;
5438 this.isSupported
= this.constructor.static.isSupported();
5439 this.currentFile
= null;
5440 if ( Array
.isArray( config
.accept
) ) {
5441 this.accept
= config
.accept
;
5445 this.placeholder
= config
.placeholder
;
5446 this.notsupported
= config
.notsupported
;
5447 this.onFileSelectedHandler
= this.onFileSelected
.bind( this );
5449 this.selectButton
= new OO
.ui
.ButtonWidget( {
5450 $element
: $( '<label>' ),
5451 classes
: [ 'oo-ui-selectFileWidget-selectButton' ],
5452 label
: OO
.ui
.msg( 'ooui-selectfile-button-select' ),
5453 disabled
: this.disabled
|| !this.isSupported
5456 this.clearButton
= new OO
.ui
.ButtonWidget( {
5457 classes
: [ 'oo-ui-selectFileWidget-clearButton' ],
5460 disabled
: this.disabled
5464 this.selectButton
.$button
.on( {
5465 keypress
: this.onKeyPress
.bind( this )
5467 this.clearButton
.connect( this, {
5468 click
: 'onClearClick'
5470 if ( config
.droppable
) {
5471 dragHandler
= this.onDragEnterOrOver
.bind( this );
5473 dragenter
: dragHandler
,
5474 dragover
: dragHandler
,
5475 dragleave
: this.onDragLeave
.bind( this ),
5476 drop
: this.onDrop
.bind( this )
5482 this.$label
.addClass( 'oo-ui-selectFileWidget-label' );
5484 .addClass( 'oo-ui-selectFileWidget-info' )
5485 .append( this.$icon
, this.$label
, this.clearButton
.$element
, this.$indicator
);
5487 if ( config
.droppable
&& config
.showDropTarget
) {
5488 this.selectButton
.setIcon( 'upload' );
5489 this.$thumbnail
= $( '<div>' ).addClass( 'oo-ui-selectFileWidget-thumbnail' );
5490 this.setPendingElement( this.$thumbnail
);
5492 .addClass( 'oo-ui-selectFileWidget-dropTarget oo-ui-selectFileWidget' )
5494 click
: this.onDropTargetClick
.bind( this )
5499 this.selectButton
.$element
,
5501 .addClass( 'oo-ui-selectFileWidget-dropLabel' )
5502 .text( OO
.ui
.msg( 'ooui-selectfile-dragdrop-placeholder' ) )
5506 .addClass( 'oo-ui-selectFileWidget' )
5507 .append( this.$info
, this.selectButton
.$element
);
5514 OO
.inheritClass( OO
.ui
.SelectFileWidget
, OO
.ui
.Widget
);
5515 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IconElement
);
5516 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IndicatorElement
);
5517 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.PendingElement
);
5518 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.LabelElement
);
5519 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.TitledElement
);
5521 /* Static Properties */
5524 * Check if this widget is supported
5529 OO
.ui
.SelectFileWidget
.static.isSupported = function () {
5531 if ( OO
.ui
.SelectFileWidget
.static.isSupportedCache
=== null ) {
5532 $input
= $( '<input>' ).attr( 'type', 'file' );
5533 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= $input
[ 0 ].files
!== undefined;
5535 return OO
.ui
.SelectFileWidget
.static.isSupportedCache
;
5538 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= null;
5545 * A change event is emitted when the on/off state of the toggle changes.
5547 * @param {File|null} value New value
5553 * Get the current value of the field
5555 * @return {File|null}
5557 OO
.ui
.SelectFileWidget
.prototype.getValue = function () {
5558 return this.currentFile
;
5562 * Set the current value of the field
5564 * @param {File|null} file File to select
5566 OO
.ui
.SelectFileWidget
.prototype.setValue = function ( file
) {
5567 if ( this.currentFile
!== file
) {
5568 this.currentFile
= file
;
5570 this.emit( 'change', this.currentFile
);
5577 * Focusses the select file button.
5580 * @return {OO.ui.Widget} The widget, for chaining
5582 OO
.ui
.SelectFileWidget
.prototype.focus = function () {
5583 this.selectButton
.focus();
5591 * @return {OO.ui.Widget} The widget, for chaining
5593 OO
.ui
.SelectFileWidget
.prototype.blur = function () {
5594 this.selectButton
.blur();
5601 OO
.ui
.SelectFileWidget
.prototype.simulateLabelClick = function () {
5606 * Update the user interface when a file is selected or unselected
5610 OO
.ui
.SelectFileWidget
.prototype.updateUI = function () {
5612 if ( !this.isSupported
) {
5613 this.$element
.addClass( 'oo-ui-selectFileWidget-notsupported' );
5614 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
5615 this.setLabel( this.notsupported
);
5617 this.$element
.addClass( 'oo-ui-selectFileWidget-supported' );
5618 if ( this.currentFile
) {
5619 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
5621 $label
= $label
.add(
5623 .addClass( 'oo-ui-selectFileWidget-fileName' )
5624 .text( this.currentFile
.name
)
5626 this.setLabel( $label
);
5628 if ( this.showDropTarget
) {
5630 this.loadAndGetImageUrl().done( function ( url
) {
5631 this.$thumbnail
.css( 'background-image', 'url( ' + url
+ ' )' );
5632 }.bind( this ) ).fail( function () {
5633 this.$thumbnail
.append(
5634 new OO
.ui
.IconWidget( {
5636 classes
: [ 'oo-ui-selectFileWidget-noThumbnail-icon' ]
5639 }.bind( this ) ).always( function () {
5642 this.$element
.off( 'click' );
5645 if ( this.showDropTarget
) {
5646 this.$element
.off( 'click' );
5648 click
: this.onDropTargetClick
.bind( this )
5652 .css( 'background-image', '' );
5654 this.$element
.addClass( 'oo-ui-selectFileWidget-empty' );
5655 this.setLabel( this.placeholder
);
5661 * If the selected file is an image, get its URL and load it.
5663 * @return {jQuery.Promise} Promise resolves with the image URL after it has loaded
5665 OO
.ui
.SelectFileWidget
.prototype.loadAndGetImageUrl = function () {
5666 var deferred
= $.Deferred(),
5667 file
= this.currentFile
,
5668 reader
= new FileReader();
5672 ( OO
.getProp( file
, 'type' ) || '' ).indexOf( 'image/' ) === 0 &&
5673 file
.size
< this.thumbnailSizeLimit
* 1024 * 1024
5675 reader
.onload = function ( event
) {
5676 var img
= document
.createElement( 'img' );
5677 img
.addEventListener( 'load', function () {
5679 img
.naturalWidth
=== 0 ||
5680 img
.naturalHeight
=== 0 ||
5681 img
.complete
=== false
5685 deferred
.resolve( event
.target
.result
);
5688 img
.src
= event
.target
.result
;
5690 reader
.readAsDataURL( file
);
5695 return deferred
.promise();
5699 * Add the input to the widget
5703 OO
.ui
.SelectFileWidget
.prototype.addInput = function () {
5704 if ( this.$input
) {
5705 this.$input
.remove();
5708 if ( !this.isSupported
) {
5713 this.$input
= $( '<input>' ).attr( 'type', 'file' );
5714 this.$input
.on( 'change', this.onFileSelectedHandler
);
5715 this.$input
.on( 'click', function ( e
) {
5716 // Prevents dropTarget to get clicked which calls
5717 // a click on this input
5718 e
.stopPropagation();
5723 if ( this.accept
) {
5724 this.$input
.attr( 'accept', this.accept
.join( ', ' ) );
5726 this.selectButton
.$button
.append( this.$input
);
5730 * Determine if we should accept this file
5733 * @param {string} mimeType File MIME type
5736 OO
.ui
.SelectFileWidget
.prototype.isAllowedType = function ( mimeType
) {
5739 if ( !this.accept
|| !mimeType
) {
5743 for ( i
= 0; i
< this.accept
.length
; i
++ ) {
5744 mimeTest
= this.accept
[ i
];
5745 if ( mimeTest
=== mimeType
) {
5747 } else if ( mimeTest
.substr( -2 ) === '/*' ) {
5748 mimeTest
= mimeTest
.substr( 0, mimeTest
.length
- 1 );
5749 if ( mimeType
.substr( 0, mimeTest
.length
) === mimeTest
) {
5759 * Handle file selection from the input
5762 * @param {jQuery.Event} e
5764 OO
.ui
.SelectFileWidget
.prototype.onFileSelected = function ( e
) {
5765 var file
= OO
.getProp( e
.target
, 'files', 0 ) || null;
5767 if ( file
&& !this.isAllowedType( file
.type
) ) {
5771 this.setValue( file
);
5776 * Handle clear button click events.
5779 * @return {undefined/boolean} False to prevent default if event is handled
5781 OO
.ui
.SelectFileWidget
.prototype.onClearClick = function () {
5782 this.setValue( null );
5787 * Handle key press events.
5790 * @param {jQuery.Event} e Key press event
5791 * @return {undefined/boolean} False to prevent default if event is handled
5793 OO
.ui
.SelectFileWidget
.prototype.onKeyPress = function ( e
) {
5794 if ( this.isSupported
&& !this.isDisabled() && this.$input
&&
5795 ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
5797 this.$input
.trigger( 'click' );
5803 * Handle drop target click events.
5806 * @param {jQuery.Event} e Key press event
5807 * @return {undefined/boolean} False to prevent default if event is handled
5809 OO
.ui
.SelectFileWidget
.prototype.onDropTargetClick = function () {
5810 if ( this.isSupported
&& !this.isDisabled() && this.$input
) {
5811 this.$input
.trigger( 'click' );
5817 * Handle drag enter and over events
5820 * @param {jQuery.Event} e Drag event
5821 * @return {undefined/boolean} False to prevent default if event is handled
5823 OO
.ui
.SelectFileWidget
.prototype.onDragEnterOrOver = function ( e
) {
5825 droppableFile
= false,
5826 dt
= e
.originalEvent
.dataTransfer
;
5829 e
.stopPropagation();
5831 if ( this.isDisabled() || !this.isSupported
) {
5832 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
5833 dt
.dropEffect
= 'none';
5837 // DataTransferItem and File both have a type property, but in Chrome files
5838 // have no information at this point.
5839 itemOrFile
= OO
.getProp( dt
, 'items', 0 ) || OO
.getProp( dt
, 'files', 0 );
5841 if ( this.isAllowedType( itemOrFile
.type
) ) {
5842 droppableFile
= true;
5844 // dt.types is Array-like, but not an Array
5845 } else if ( Array
.prototype.indexOf
.call( OO
.getProp( dt
, 'types' ) || [], 'Files' ) !== -1 ) {
5846 // File information is not available at this point for security so just assume
5847 // it is acceptable for now.
5848 // https://bugzilla.mozilla.org/show_bug.cgi?id=640534
5849 droppableFile
= true;
5852 this.$element
.toggleClass( 'oo-ui-selectFileWidget-canDrop', droppableFile
);
5853 if ( !droppableFile
) {
5854 dt
.dropEffect
= 'none';
5861 * Handle drag leave events
5864 * @param {jQuery.Event} e Drag event
5866 OO
.ui
.SelectFileWidget
.prototype.onDragLeave = function () {
5867 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
5871 * Handle drop events
5874 * @param {jQuery.Event} e Drop event
5875 * @return {undefined/boolean} False to prevent default if event is handled
5877 OO
.ui
.SelectFileWidget
.prototype.onDrop = function ( e
) {
5879 dt
= e
.originalEvent
.dataTransfer
;
5882 e
.stopPropagation();
5883 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
5885 if ( this.isDisabled() || !this.isSupported
) {
5889 file
= OO
.getProp( dt
, 'files', 0 );
5890 if ( file
&& !this.isAllowedType( file
.type
) ) {
5894 this.setValue( file
);
5903 OO
.ui
.SelectFileWidget
.prototype.setDisabled = function ( disabled
) {
5904 OO
.ui
.SelectFileWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
5905 if ( this.selectButton
) {
5906 this.selectButton
.setDisabled( disabled
);
5908 if ( this.clearButton
) {
5909 this.clearButton
.setDisabled( disabled
);
5915 * SearchWidgets combine a {@link OO.ui.TextInputWidget text input field}, where users can type a search query,
5916 * and a menu of search results, which is displayed beneath the query
5917 * field. Unlike {@link OO.ui.mixin.LookupElement lookup menus}, search result menus are always visible to the user.
5918 * Users can choose an item from the menu or type a query into the text field to search for a matching result item.
5919 * In general, search widgets are used inside a separate {@link OO.ui.Dialog dialog} window.
5921 * Each time the query is changed, the search result menu is cleared and repopulated. Please see
5922 * the [OOUI demos][1] for an example.
5924 * [1]: https://doc.wikimedia.org/oojs-ui/master/demos/#SearchInputWidget-type-search
5927 * @extends OO.ui.Widget
5930 * @param {Object} [config] Configuration options
5931 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
5932 * @cfg {string} [value] Initial query value
5934 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
5935 // Configuration initialization
5936 config
= config
|| {};
5938 // Parent constructor
5939 OO
.ui
.SearchWidget
.parent
.call( this, config
);
5942 this.query
= new OO
.ui
.TextInputWidget( {
5944 placeholder
: config
.placeholder
,
5947 this.results
= new OO
.ui
.SelectWidget();
5948 this.$query
= $( '<div>' );
5949 this.$results
= $( '<div>' );
5952 this.query
.connect( this, {
5953 change
: 'onQueryChange',
5954 enter
: 'onQueryEnter'
5956 this.query
.$input
.on( 'keydown', this.onQueryKeydown
.bind( this ) );
5960 .addClass( 'oo-ui-searchWidget-query' )
5961 .append( this.query
.$element
);
5963 .addClass( 'oo-ui-searchWidget-results' )
5964 .append( this.results
.$element
);
5966 .addClass( 'oo-ui-searchWidget' )
5967 .append( this.$results
, this.$query
);
5972 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
5977 * Handle query key down events.
5980 * @param {jQuery.Event} e Key down event
5982 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
5983 var highlightedItem
, nextItem
,
5984 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
5987 highlightedItem
= this.results
.findHighlightedItem();
5988 if ( !highlightedItem
) {
5989 highlightedItem
= this.results
.findSelectedItem();
5991 nextItem
= this.results
.findRelativeSelectableItem( highlightedItem
, dir
);
5992 this.results
.highlightItem( nextItem
);
5993 nextItem
.scrollElementIntoView();
5998 * Handle select widget select events.
6000 * Clears existing results. Subclasses should repopulate items according to new query.
6003 * @param {string} value New value
6005 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
6007 this.results
.clearItems();
6011 * Handle select widget enter key events.
6013 * Chooses highlighted item.
6016 * @param {string} value New value
6018 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
6019 var highlightedItem
= this.results
.findHighlightedItem();
6020 if ( highlightedItem
) {
6021 this.results
.chooseItem( highlightedItem
);
6026 * Get the query input.
6028 * @return {OO.ui.TextInputWidget} Query input
6030 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
6035 * Get the search results menu.
6037 * @return {OO.ui.SelectWidget} Menu of search results
6039 OO
.ui
.SearchWidget
.prototype.getResults = function () {
6040 return this.results
;
6045 //# sourceMappingURL=oojs-ui-widgets.js.map.json