3 * https://www.mediawiki.org/wiki/OOUI
5 * Copyright 2011–2018 OOUI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
9 * Date: 2018-10-08T22:42:55Z
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
387 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onItemDropOrDragEnd = function () {
388 var targetIndex
, originalIndex
,
389 item
= this.getDragItem();
391 // TODO: Figure out a way to configure a list of legally droppable
392 // elements even if they are not yet in the list
394 originalIndex
= this.items
.indexOf( item
);
395 // If the item has moved forward, add one to the index to account for the left shift
396 targetIndex
= item
.getIndex() + ( item
.getIndex() > originalIndex
? 1 : 0 );
397 if ( targetIndex
!== originalIndex
) {
398 this.reorder( this.getDragItem(), targetIndex
);
399 this.emit( 'reorder', this.getDragItem(), targetIndex
);
401 this.updateIndexes();
403 this.unsetDragItem();
404 // Return false to prevent propogation
409 * Respond to dragover event
412 * @param {jQuery.Event} e Dragover event
415 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onDragOver = function ( e
) {
416 var overIndex
, targetIndex
,
417 item
= this.getDragItem(),
418 dragItemIndex
= item
.getIndex();
420 // Get the OptionWidget item we are dragging over
421 overIndex
= $( e
.target
).closest( '.oo-ui-draggableElement' ).data( 'index' );
423 if ( overIndex
!== undefined && overIndex
!== dragItemIndex
) {
424 targetIndex
= overIndex
+ ( overIndex
> dragItemIndex
? 1 : 0 );
426 if ( targetIndex
> 0 ) {
427 this.$group
.children().eq( targetIndex
- 1 ).after( item
.$element
);
429 this.$group
.prepend( item
.$element
);
431 // Move item in itemsOrder array
432 this.itemsOrder
.splice( overIndex
, 0,
433 this.itemsOrder
.splice( dragItemIndex
, 1 )[ 0 ]
435 this.updateIndexes();
436 this.emit( 'drag', item
, targetIndex
);
443 * Reorder the items in the group
445 * @param {OO.ui.mixin.DraggableElement} item Reordered item
446 * @param {number} newIndex New index
448 OO
.ui
.mixin
.DraggableGroupElement
.prototype.reorder = function ( item
, newIndex
) {
449 this.addItems( [ item
], newIndex
);
455 * @param {OO.ui.mixin.DraggableElement} item Dragged item
457 OO
.ui
.mixin
.DraggableGroupElement
.prototype.setDragItem = function ( item
) {
458 if ( this.dragItem
!== item
) {
459 this.dragItem
= item
;
460 this.$element
.on( 'dragover', this.onDragOver
.bind( this ) );
461 this.$element
.addClass( 'oo-ui-draggableGroupElement-dragging' );
466 * Unset the current dragged item
468 OO
.ui
.mixin
.DraggableGroupElement
.prototype.unsetDragItem = function () {
469 if ( this.dragItem
) {
470 this.dragItem
= null;
471 this.$element
.off( 'dragover' );
472 this.$element
.removeClass( 'oo-ui-draggableGroupElement-dragging' );
477 * Get the item that is currently being dragged.
479 * @return {OO.ui.mixin.DraggableElement|null} The currently dragged item, or `null` if no item is being dragged
481 OO
.ui
.mixin
.DraggableGroupElement
.prototype.getDragItem = function () {
482 return this.dragItem
;
486 * RequestManager is a mixin that manages the lifecycle of a promise-backed request for a widget, such as
487 * the {@link OO.ui.mixin.LookupElement}.
494 OO
.ui
.mixin
.RequestManager
= function OoUiMixinRequestManager() {
495 this.requestCache
= {};
496 this.requestQuery
= null;
497 this.requestRequest
= null;
502 OO
.initClass( OO
.ui
.mixin
.RequestManager
);
505 * Get request results for the current query.
507 * @return {jQuery.Promise} Promise object which will be passed response data as the first argument of
508 * the done event. If the request was aborted to make way for a subsequent request, this promise
509 * may not be rejected, depending on what jQuery feels like doing.
511 OO
.ui
.mixin
.RequestManager
.prototype.getRequestData = function () {
513 value
= this.getRequestQuery(),
514 deferred
= $.Deferred(),
518 if ( Object
.prototype.hasOwnProperty
.call( this.requestCache
, value
) ) {
519 deferred
.resolve( this.requestCache
[ value
] );
521 if ( this.pushPending
) {
524 this.requestQuery
= value
;
525 ourRequest
= this.requestRequest
= this.getRequest();
527 .always( function () {
528 // We need to pop pending even if this is an old request, otherwise
529 // the widget will remain pending forever.
530 // TODO: this assumes that an aborted request will fail or succeed soon after
531 // being aborted, or at least eventually. It would be nice if we could popPending()
532 // at abort time, but only if we knew that we hadn't already called popPending()
534 if ( widget
.popPending
) {
538 .done( function ( response
) {
539 // If this is an old request (and aborting it somehow caused it to still succeed),
540 // ignore its success completely
541 if ( ourRequest
=== widget
.requestRequest
) {
542 widget
.requestQuery
= null;
543 widget
.requestRequest
= null;
544 widget
.requestCache
[ value
] = widget
.getRequestCacheDataFromResponse( response
);
545 deferred
.resolve( widget
.requestCache
[ value
] );
549 // If this is an old request (or a request failing because it's being aborted),
550 // ignore its failure completely
551 if ( ourRequest
=== widget
.requestRequest
) {
552 widget
.requestQuery
= null;
553 widget
.requestRequest
= null;
558 return deferred
.promise();
562 * Abort the currently pending request, if any.
566 OO
.ui
.mixin
.RequestManager
.prototype.abortRequest = function () {
567 var oldRequest
= this.requestRequest
;
569 // First unset this.requestRequest to the fail handler will notice
570 // that the request is no longer current
571 this.requestRequest
= null;
572 this.requestQuery
= null;
578 * Get the query to be made.
583 * @return {string} query to be used
585 OO
.ui
.mixin
.RequestManager
.prototype.getRequestQuery
= null;
588 * Get a new request object of the current query value.
593 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
595 OO
.ui
.mixin
.RequestManager
.prototype.getRequest
= null;
598 * Pre-process data returned by the request from #getRequest.
600 * The return value of this function will be cached, and any further queries for the given value
601 * will use the cache rather than doing API requests.
606 * @param {Mixed} response Response from server
607 * @return {Mixed} Cached result data
609 OO
.ui
.mixin
.RequestManager
.prototype.getRequestCacheDataFromResponse
= null;
612 * LookupElement is a mixin that creates a {@link OO.ui.MenuSelectWidget menu} of suggested values for
613 * a {@link OO.ui.TextInputWidget text input widget}. Suggested values are based on the characters the user types
614 * into the text input field and, in general, the menu is only displayed when the user types. If a suggested value is chosen
615 * from the lookup menu, that value becomes the value of the input field.
617 * Note that a new menu of suggested items is displayed when a value is chosen from the lookup menu. If this is
618 * not the desired behavior, disable lookup menus with the #setLookupsDisabled method, then set the value, then
621 * See the [OOUI demos][1] for an example.
623 * [1]: https://doc.wikimedia.org/oojs-ui/master/demos/#LookupElement-try-inputting-an-integer
627 * @mixins OO.ui.mixin.RequestManager
630 * @param {Object} [config] Configuration options
631 * @cfg {jQuery} [$overlay] Overlay for the lookup menu; defaults to relative positioning.
632 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
633 * @cfg {jQuery} [$container=this.$element] The container element. The lookup menu is rendered beneath the specified element.
634 * @cfg {Object} [menu] Configuration options to pass to {@link OO.ui.MenuSelectWidget menu select widget}
635 * @cfg {boolean} [allowSuggestionsWhenEmpty=false] Request and display a lookup menu when the text input is empty.
636 * By default, the lookup menu is not generated and displayed until the user begins to type.
637 * @cfg {boolean} [highlightFirst=true] Whether the first lookup result should be highlighted (so, that the user can
638 * take it over into the input with simply pressing return) automatically or not.
640 OO
.ui
.mixin
.LookupElement
= function OoUiMixinLookupElement( config
) {
641 // Configuration initialization
642 config
= $.extend( { highlightFirst
: true }, config
);
644 // Mixin constructors
645 OO
.ui
.mixin
.RequestManager
.call( this, config
);
648 this.$overlay
= ( config
.$overlay
=== true ? OO
.ui
.getDefaultOverlay() : config
.$overlay
) || this.$element
;
649 this.lookupMenu
= new OO
.ui
.MenuSelectWidget( $.extend( {
652 $floatableContainer
: config
.$container
|| this.$element
655 this.allowSuggestionsWhenEmpty
= config
.allowSuggestionsWhenEmpty
|| false;
657 this.lookupsDisabled
= false;
658 this.lookupInputFocused
= false;
659 this.lookupHighlightFirstItem
= config
.highlightFirst
;
663 focus
: this.onLookupInputFocus
.bind( this ),
664 blur
: this.onLookupInputBlur
.bind( this ),
665 mousedown
: this.onLookupInputMouseDown
.bind( this )
667 this.connect( this, { change
: 'onLookupInputChange' } );
668 this.lookupMenu
.connect( this, {
669 toggle
: 'onLookupMenuToggle',
670 choose
: 'onLookupMenuItemChoose'
676 'aria-owns': this.lookupMenu
.getElementId(),
677 'aria-autocomplete': 'list'
679 this.$element
.addClass( 'oo-ui-lookupElement' );
680 this.lookupMenu
.$element
.addClass( 'oo-ui-lookupElement-menu' );
681 this.$overlay
.append( this.lookupMenu
.$element
);
686 OO
.mixinClass( OO
.ui
.mixin
.LookupElement
, OO
.ui
.mixin
.RequestManager
);
691 * Handle input focus event.
694 * @param {jQuery.Event} e Input focus event
696 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputFocus = function () {
697 this.lookupInputFocused
= true;
698 this.populateLookupMenu();
702 * Handle input blur event.
705 * @param {jQuery.Event} e Input blur event
707 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputBlur = function () {
708 this.closeLookupMenu();
709 this.lookupInputFocused
= false;
713 * Handle input mouse down event.
716 * @param {jQuery.Event} e Input mouse down event
718 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputMouseDown = function () {
719 // Only open the menu if the input was already focused.
720 // This way we allow the user to open the menu again after closing it with Esc
721 // by clicking in the input. Opening (and populating) the menu when initially
722 // clicking into the input is handled by the focus handler.
723 if ( this.lookupInputFocused
&& !this.lookupMenu
.isVisible() ) {
724 this.populateLookupMenu();
729 * Handle input change event.
732 * @param {string} value New input value
734 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputChange = function () {
735 if ( this.lookupInputFocused
) {
736 this.populateLookupMenu();
741 * Handle the lookup menu being shown/hidden.
744 * @param {boolean} visible Whether the lookup menu is now visible.
746 OO
.ui
.mixin
.LookupElement
.prototype.onLookupMenuToggle = function ( visible
) {
748 // When the menu is hidden, abort any active request and clear the menu.
749 // This has to be done here in addition to closeLookupMenu(), because
750 // MenuSelectWidget will close itself when the user presses Esc.
751 this.abortLookupRequest();
752 this.lookupMenu
.clearItems();
757 * Handle menu item 'choose' event, updating the text input value to the value of the clicked item.
760 * @param {OO.ui.MenuOptionWidget} item Selected item
762 OO
.ui
.mixin
.LookupElement
.prototype.onLookupMenuItemChoose = function ( item
) {
763 this.setValue( item
.getData() );
770 * @return {OO.ui.MenuSelectWidget}
772 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenu = function () {
773 return this.lookupMenu
;
777 * Disable or re-enable lookups.
779 * When lookups are disabled, calls to #populateLookupMenu will be ignored.
781 * @param {boolean} disabled Disable lookups
783 OO
.ui
.mixin
.LookupElement
.prototype.setLookupsDisabled = function ( disabled
) {
784 this.lookupsDisabled
= !!disabled
;
788 * Open the menu. If there are no entries in the menu, this does nothing.
793 OO
.ui
.mixin
.LookupElement
.prototype.openLookupMenu = function () {
794 if ( !this.lookupMenu
.isEmpty() ) {
795 this.lookupMenu
.toggle( true );
801 * Close the menu, empty it, and abort any pending request.
806 OO
.ui
.mixin
.LookupElement
.prototype.closeLookupMenu = function () {
807 this.lookupMenu
.toggle( false );
808 this.abortLookupRequest();
809 this.lookupMenu
.clearItems();
814 * Request menu items based on the input's current value, and when they arrive,
815 * populate the menu with these items and show the menu.
817 * If lookups have been disabled with #setLookupsDisabled, this function does nothing.
822 OO
.ui
.mixin
.LookupElement
.prototype.populateLookupMenu = function () {
824 value
= this.getValue();
826 if ( this.lookupsDisabled
|| this.isReadOnly() ) {
830 // If the input is empty, clear the menu, unless suggestions when empty are allowed.
831 if ( !this.allowSuggestionsWhenEmpty
&& value
=== '' ) {
832 this.closeLookupMenu();
833 // Skip population if there is already a request pending for the current value
834 } else if ( value
!== this.lookupQuery
) {
835 this.getLookupMenuItems()
836 .done( function ( items
) {
837 widget
.lookupMenu
.clearItems();
838 if ( items
.length
) {
842 widget
.initializeLookupMenuSelection();
844 widget
.lookupMenu
.toggle( false );
848 widget
.lookupMenu
.clearItems();
849 widget
.lookupMenu
.toggle( false );
857 * Highlight the first selectable item in the menu, if configured.
862 OO
.ui
.mixin
.LookupElement
.prototype.initializeLookupMenuSelection = function () {
863 if ( this.lookupHighlightFirstItem
&& !this.lookupMenu
.findSelectedItem() ) {
864 this.lookupMenu
.highlightItem( this.lookupMenu
.findFirstSelectableItem() );
869 * Get lookup menu items for the current query.
872 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument of
873 * the done event. If the request was aborted to make way for a subsequent request, this promise
874 * will not be rejected: it will remain pending forever.
876 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenuItems = function () {
877 return this.getRequestData().then( function ( data
) {
878 return this.getLookupMenuOptionsFromData( data
);
883 * Abort the currently pending lookup request, if any.
887 OO
.ui
.mixin
.LookupElement
.prototype.abortLookupRequest = function () {
892 * Get a new request object of the current lookup query value.
897 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
899 OO
.ui
.mixin
.LookupElement
.prototype.getLookupRequest
= null;
902 * Pre-process data returned by the request from #getLookupRequest.
904 * The return value of this function will be cached, and any further queries for the given value
905 * will use the cache rather than doing API requests.
910 * @param {Mixed} response Response from server
911 * @return {Mixed} Cached result data
913 OO
.ui
.mixin
.LookupElement
.prototype.getLookupCacheDataFromResponse
= null;
916 * Get a list of menu option widgets from the (possibly cached) data returned by
917 * #getLookupCacheDataFromResponse.
922 * @param {Mixed} data Cached result data, usually an array
923 * @return {OO.ui.MenuOptionWidget[]} Menu items
925 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenuOptionsFromData
= null;
928 * Set the read-only state of the widget.
930 * This will also disable/enable the lookups functionality.
932 * @param {boolean} readOnly Make input read-only
935 OO
.ui
.mixin
.LookupElement
.prototype.setReadOnly = function ( readOnly
) {
937 // Note: Calling #setReadOnly this way assumes this is mixed into an OO.ui.TextInputWidget
938 OO
.ui
.TextInputWidget
.prototype.setReadOnly
.call( this, readOnly
);
940 // During construction, #setReadOnly is called before the OO.ui.mixin.LookupElement constructor
941 if ( this.isReadOnly() && this.lookupMenu
) {
942 this.closeLookupMenu();
949 * @inheritdoc OO.ui.mixin.RequestManager
951 OO
.ui
.mixin
.LookupElement
.prototype.getRequestQuery = function () {
952 return this.getValue();
956 * @inheritdoc OO.ui.mixin.RequestManager
958 OO
.ui
.mixin
.LookupElement
.prototype.getRequest = function () {
959 return this.getLookupRequest();
963 * @inheritdoc OO.ui.mixin.RequestManager
965 OO
.ui
.mixin
.LookupElement
.prototype.getRequestCacheDataFromResponse = function ( response
) {
966 return this.getLookupCacheDataFromResponse( response
);
970 * TabPanelLayouts are used within {@link OO.ui.IndexLayout index layouts} to create tab panels that
971 * users can select and display from the index's optional {@link OO.ui.TabSelectWidget tab}
972 * navigation. TabPanels are usually not instantiated directly, rather extended to include the
973 * required content and functionality.
975 * Each tab panel must have a unique symbolic name, which is passed to the constructor. In addition,
976 * the tab panel's tab item is customized (with a label) using the #setupTabItem method. See
977 * {@link OO.ui.IndexLayout IndexLayout} for an example.
980 * @extends OO.ui.PanelLayout
983 * @param {string} name Unique symbolic name of tab panel
984 * @param {Object} [config] Configuration options
985 * @cfg {jQuery|string|Function|OO.ui.HtmlSnippet} [label] Label for tab panel's tab
987 OO
.ui
.TabPanelLayout
= function OoUiTabPanelLayout( name
, config
) {
988 // Allow passing positional parameters inside the config object
989 if ( OO
.isPlainObject( name
) && config
=== undefined ) {
994 // Configuration initialization
995 config
= $.extend( { scrollable
: true }, config
);
997 // Parent constructor
998 OO
.ui
.TabPanelLayout
.parent
.call( this, config
);
1002 this.label
= config
.label
;
1003 this.tabItem
= null;
1004 this.active
= false;
1008 .addClass( 'oo-ui-tabPanelLayout' )
1009 .attr( 'role', 'tabpanel' );
1014 OO
.inheritClass( OO
.ui
.TabPanelLayout
, OO
.ui
.PanelLayout
);
1019 * An 'active' event is emitted when the tab panel becomes active. Tab panels become active when they are
1020 * shown in a index layout that is configured to display only one tab panel at a time.
1023 * @param {boolean} active Tab panel is active
1029 * Get the symbolic name of the tab panel.
1031 * @return {string} Symbolic name of tab panel
1033 OO
.ui
.TabPanelLayout
.prototype.getName = function () {
1038 * Check if tab panel is active.
1040 * Tab panels become active when they are shown in a {@link OO.ui.IndexLayout index layout} that is configured to
1041 * display only one tab panel at a time. Additional CSS is applied to the tab panel's tab item to reflect the
1044 * @return {boolean} Tab panel is active
1046 OO
.ui
.TabPanelLayout
.prototype.isActive = function () {
1053 * The tab item allows users to access the tab panel from the index's tab
1054 * navigation. The tab item itself can be customized (with a label, level, etc.) using the #setupTabItem method.
1056 * @return {OO.ui.TabOptionWidget|null} Tab option widget
1058 OO
.ui
.TabPanelLayout
.prototype.getTabItem = function () {
1059 return this.tabItem
;
1063 * Set or unset the tab item.
1065 * Specify a {@link OO.ui.TabOptionWidget tab option} to set it,
1066 * or `null` to clear the tab item. To customize the tab item itself (e.g., to set a label or tab
1067 * level), use #setupTabItem instead of this method.
1069 * @param {OO.ui.TabOptionWidget|null} tabItem Tab option widget, null to clear
1072 OO
.ui
.TabPanelLayout
.prototype.setTabItem = function ( tabItem
) {
1073 this.tabItem
= tabItem
|| null;
1075 this.setupTabItem();
1081 * Set up the tab item.
1083 * Use this method to customize the tab item (e.g., to add a label or tab level). To set or unset
1084 * the tab item itself (with a {@link OO.ui.TabOptionWidget tab option} or `null`), use
1085 * the #setTabItem method instead.
1087 * @param {OO.ui.TabOptionWidget} tabItem Tab option widget to set up
1090 OO
.ui
.TabPanelLayout
.prototype.setupTabItem = function () {
1091 this.$element
.attr( 'aria-labelledby', this.tabItem
.getElementId() );
1093 this.tabItem
.$element
.attr( 'aria-controls', this.getElementId() );
1096 this.tabItem
.setLabel( this.label
);
1102 * Set the tab panel to its 'active' state.
1104 * Tab panels become active when they are shown in a index layout that is configured to display only
1105 * one tab panel at a time. Additional CSS is applied to the tab item to reflect the tab panel's
1106 * active state. Outside of the index context, setting the active state on a tab panel does nothing.
1108 * @param {boolean} active Tab panel is active
1111 OO
.ui
.TabPanelLayout
.prototype.setActive = function ( active
) {
1114 if ( active
!== this.active
) {
1115 this.active
= active
;
1116 this.$element
.toggleClass( 'oo-ui-tabPanelLayout-active', this.active
);
1117 this.emit( 'active', this.active
);
1122 * PageLayouts are used within {@link OO.ui.BookletLayout booklet layouts} to create pages that users can select and display
1123 * from the booklet's optional {@link OO.ui.OutlineSelectWidget outline} navigation. Pages are usually not instantiated directly,
1124 * rather extended to include the required content and functionality.
1126 * Each page must have a unique symbolic name, which is passed to the constructor. In addition, the page's outline
1127 * item is customized (with a label, outline level, etc.) using the #setupOutlineItem method. See
1128 * {@link OO.ui.BookletLayout BookletLayout} for an example.
1131 * @extends OO.ui.PanelLayout
1134 * @param {string} name Unique symbolic name of page
1135 * @param {Object} [config] Configuration options
1137 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
1138 // Allow passing positional parameters inside the config object
1139 if ( OO
.isPlainObject( name
) && config
=== undefined ) {
1144 // Configuration initialization
1145 config
= $.extend( { scrollable
: true }, config
);
1147 // Parent constructor
1148 OO
.ui
.PageLayout
.parent
.call( this, config
);
1152 this.outlineItem
= null;
1153 this.active
= false;
1156 this.$element
.addClass( 'oo-ui-pageLayout' );
1161 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
1166 * An 'active' event is emitted when the page becomes active. Pages become active when they are
1167 * shown in a booklet layout that is configured to display only one page at a time.
1170 * @param {boolean} active Page is active
1176 * Get the symbolic name of the page.
1178 * @return {string} Symbolic name of page
1180 OO
.ui
.PageLayout
.prototype.getName = function () {
1185 * Check if page is active.
1187 * Pages become active when they are shown in a {@link OO.ui.BookletLayout booklet layout} that is configured to display
1188 * only one page at a time. Additional CSS is applied to the page's outline item to reflect the active state.
1190 * @return {boolean} Page is active
1192 OO
.ui
.PageLayout
.prototype.isActive = function () {
1199 * The outline item allows users to access the page from the booklet's outline
1200 * navigation. The outline item itself can be customized (with a label, level, etc.) using the #setupOutlineItem method.
1202 * @return {OO.ui.OutlineOptionWidget|null} Outline option widget
1204 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
1205 return this.outlineItem
;
1209 * Set or unset the outline item.
1211 * Specify an {@link OO.ui.OutlineOptionWidget outline option} to set it,
1212 * or `null` to clear the outline item. To customize the outline item itself (e.g., to set a label or outline
1213 * level), use #setupOutlineItem instead of this method.
1215 * @param {OO.ui.OutlineOptionWidget|null} outlineItem Outline option widget, null to clear
1218 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
1219 this.outlineItem
= outlineItem
|| null;
1220 if ( outlineItem
) {
1221 this.setupOutlineItem();
1227 * Set up the outline item.
1229 * Use this method to customize the outline item (e.g., to add a label or outline level). To set or unset
1230 * the outline item itself (with an {@link OO.ui.OutlineOptionWidget outline option} or `null`), use
1231 * the #setOutlineItem method instead.
1233 * @param {OO.ui.OutlineOptionWidget} outlineItem Outline option widget to set up
1236 OO
.ui
.PageLayout
.prototype.setupOutlineItem = function () {
1241 * Set the page to its 'active' state.
1243 * Pages become active when they are shown in a booklet layout that is configured to display only one page at a time. Additional
1244 * CSS is applied to the outline item to reflect the page's active state. Outside of the booklet
1245 * context, setting the active state on a page does nothing.
1247 * @param {boolean} active Page is active
1250 OO
.ui
.PageLayout
.prototype.setActive = function ( active
) {
1253 if ( active
!== this.active
) {
1254 this.active
= active
;
1255 this.$element
.toggleClass( 'oo-ui-pageLayout-active', active
);
1256 this.emit( 'active', this.active
);
1261 * StackLayouts contain a series of {@link OO.ui.PanelLayout panel layouts}. By default, only one panel is displayed
1262 * at a time, though the stack layout can also be configured to show all contained panels, one after another,
1263 * by setting the #continuous option to 'true'.
1266 * // A stack layout with two panels, configured to be displayed continously
1267 * var myStack = new OO.ui.StackLayout( {
1269 * new OO.ui.PanelLayout( {
1270 * $content: $( '<p>Panel One</p>' ),
1274 * new OO.ui.PanelLayout( {
1275 * $content: $( '<p>Panel Two</p>' ),
1282 * $( 'body' ).append( myStack.$element );
1285 * @extends OO.ui.PanelLayout
1286 * @mixins OO.ui.mixin.GroupElement
1289 * @param {Object} [config] Configuration options
1290 * @cfg {boolean} [continuous=false] Show all panels, one after another. By default, only one panel is displayed at a time.
1291 * @cfg {OO.ui.Layout[]} [items] Panel layouts to add to the stack layout.
1293 OO
.ui
.StackLayout
= function OoUiStackLayout( config
) {
1294 // Configuration initialization
1295 config
= $.extend( { scrollable
: true }, config
);
1297 // Parent constructor
1298 OO
.ui
.StackLayout
.parent
.call( this, config
);
1300 // Mixin constructors
1301 OO
.ui
.mixin
.GroupElement
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
1304 this.currentItem
= null;
1305 this.continuous
= !!config
.continuous
;
1308 this.$element
.addClass( 'oo-ui-stackLayout' );
1309 if ( this.continuous
) {
1310 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
1311 this.$element
.on( 'scroll', OO
.ui
.debounce( this.onScroll
.bind( this ), 250 ) );
1313 if ( Array
.isArray( config
.items
) ) {
1314 this.addItems( config
.items
);
1320 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
1321 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.mixin
.GroupElement
);
1326 * A 'set' event is emitted when panels are {@link #addItems added}, {@link #removeItems removed},
1327 * {@link #clearItems cleared} or {@link #setItem displayed}.
1330 * @param {OO.ui.Layout|null} item Current panel or `null` if no panel is shown
1334 * When used in continuous mode, this event is emitted when the user scrolls down
1335 * far enough such that currentItem is no longer visible.
1337 * @event visibleItemChange
1338 * @param {OO.ui.PanelLayout} panel The next visible item in the layout
1344 * Handle scroll events from the layout element
1346 * @param {jQuery.Event} e
1347 * @fires visibleItemChange
1349 OO
.ui
.StackLayout
.prototype.onScroll = function () {
1351 len
= this.items
.length
,
1352 currentIndex
= this.items
.indexOf( this.currentItem
),
1353 newIndex
= currentIndex
,
1354 containerRect
= this.$element
[ 0 ].getBoundingClientRect();
1356 if ( !containerRect
|| ( !containerRect
.top
&& !containerRect
.bottom
) ) {
1357 // Can't get bounding rect, possibly not attached.
1361 function getRect( item
) {
1362 return item
.$element
[ 0 ].getBoundingClientRect();
1365 function isVisible( item
) {
1366 var rect
= getRect( item
);
1367 return rect
.bottom
> containerRect
.top
&& rect
.top
< containerRect
.bottom
;
1370 currentRect
= getRect( this.currentItem
);
1372 if ( currentRect
.bottom
< containerRect
.top
) {
1373 // Scrolled down past current item
1374 while ( ++newIndex
< len
) {
1375 if ( isVisible( this.items
[ newIndex
] ) ) {
1379 } else if ( currentRect
.top
> containerRect
.bottom
) {
1380 // Scrolled up past current item
1381 while ( --newIndex
>= 0 ) {
1382 if ( isVisible( this.items
[ newIndex
] ) ) {
1388 if ( newIndex
!== currentIndex
) {
1389 this.emit( 'visibleItemChange', this.items
[ newIndex
] );
1394 * Get the current panel.
1396 * @return {OO.ui.Layout|null}
1398 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
1399 return this.currentItem
;
1403 * Unset the current item.
1406 * @param {OO.ui.StackLayout} layout
1409 OO
.ui
.StackLayout
.prototype.unsetCurrentItem = function () {
1410 var prevItem
= this.currentItem
;
1411 if ( prevItem
=== null ) {
1415 this.currentItem
= null;
1416 this.emit( 'set', null );
1420 * Add panel layouts to the stack layout.
1422 * Panels will be added to the end of the stack layout array unless the optional index parameter specifies a different
1423 * insertion point. Adding a panel that is already in the stack will move it to the end of the array or the point specified
1426 * @param {OO.ui.Layout[]} items Panels to add
1427 * @param {number} [index] Index of the insertion point
1430 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
1431 // Update the visibility
1432 this.updateHiddenState( items
, this.currentItem
);
1435 OO
.ui
.mixin
.GroupElement
.prototype.addItems
.call( this, items
, index
);
1437 if ( !this.currentItem
&& items
.length
) {
1438 this.setItem( items
[ 0 ] );
1445 * Remove the specified panels from the stack layout.
1447 * Removed panels are detached from the DOM, not removed, so that they may be reused. To remove all panels,
1448 * you may wish to use the #clearItems method instead.
1450 * @param {OO.ui.Layout[]} items Panels to remove
1454 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
1456 OO
.ui
.mixin
.GroupElement
.prototype.removeItems
.call( this, items
);
1458 if ( items
.indexOf( this.currentItem
) !== -1 ) {
1459 if ( this.items
.length
) {
1460 this.setItem( this.items
[ 0 ] );
1462 this.unsetCurrentItem();
1470 * Clear all panels from the stack layout.
1472 * Cleared panels are detached from the DOM, not removed, so that they may be reused. To remove only
1473 * a subset of panels, use the #removeItems method.
1478 OO
.ui
.StackLayout
.prototype.clearItems = function () {
1479 this.unsetCurrentItem();
1480 OO
.ui
.mixin
.GroupElement
.prototype.clearItems
.call( this );
1486 * Show the specified panel.
1488 * If another panel is currently displayed, it will be hidden.
1490 * @param {OO.ui.Layout} item Panel to show
1494 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
1495 if ( item
!== this.currentItem
) {
1496 this.updateHiddenState( this.items
, item
);
1498 if ( this.items
.indexOf( item
) !== -1 ) {
1499 this.currentItem
= item
;
1500 this.emit( 'set', item
);
1502 this.unsetCurrentItem();
1510 * Update the visibility of all items in case of non-continuous view.
1512 * Ensure all items are hidden except for the selected one.
1513 * This method does nothing when the stack is continuous.
1516 * @param {OO.ui.Layout[]} items Item list iterate over
1517 * @param {OO.ui.Layout} [selectedItem] Selected item to show
1519 OO
.ui
.StackLayout
.prototype.updateHiddenState = function ( items
, selectedItem
) {
1522 if ( !this.continuous
) {
1523 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
1524 if ( !selectedItem
|| selectedItem
!== items
[ i
] ) {
1525 items
[ i
].$element
.addClass( 'oo-ui-element-hidden' );
1526 items
[ i
].$element
.attr( 'aria-hidden', 'true' );
1529 if ( selectedItem
) {
1530 selectedItem
.$element
.removeClass( 'oo-ui-element-hidden' );
1531 selectedItem
.$element
.removeAttr( 'aria-hidden' );
1537 * 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)
1538 * and its size is customized with the #menuSize config. The content area will fill all remaining space.
1542 * menuPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1543 * contentPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1544 * select = new OO.ui.SelectWidget( {
1546 * new OO.ui.OptionWidget( {
1550 * new OO.ui.OptionWidget( {
1554 * new OO.ui.OptionWidget( {
1558 * new OO.ui.OptionWidget( {
1563 * } ).on( 'select', function ( item ) {
1564 * menuLayout.setMenuPosition( item.getData() );
1567 * menuLayout = new OO.ui.MenuLayout( {
1569 * menuPanel: menuPanel,
1570 * contentPanel: contentPanel
1572 * menuLayout.$menu.append(
1573 * menuPanel.$element.append( '<b>Menu panel</b>', select.$element )
1575 * menuLayout.$content.append(
1576 * contentPanel.$element.append( '<b>Content panel</b>', '<p>Note that the menu is positioned relative to the content panel: top, bottom, after, before.</p>')
1578 * $( 'body' ).append( menuLayout.$element );
1580 * If menu size needs to be overridden, it can be accomplished using CSS similar to the snippet
1581 * below. MenuLayout's CSS will override the appropriate values with 'auto' or '0' to display the
1582 * menu correctly. If `menuPosition` is known beforehand, CSS rules corresponding to other positions
1585 * .oo-ui-menuLayout-menu {
1590 * .oo-ui-menuLayout-content {
1598 * @extends OO.ui.Layout
1601 * @param {Object} [config] Configuration options
1602 * @cfg {OO.ui.PanelLayout} [menuPanel] Menu panel
1603 * @cfg {OO.ui.PanelLayout} [contentPanel] Content panel
1604 * @cfg {boolean} [expanded=true] Expand the layout to fill the entire parent element.
1605 * @cfg {boolean} [showMenu=true] Show menu
1606 * @cfg {string} [menuPosition='before'] Position of menu: `top`, `after`, `bottom` or `before`
1608 OO
.ui
.MenuLayout
= function OoUiMenuLayout( config
) {
1609 // Configuration initialization
1610 config
= $.extend( {
1613 menuPosition
: 'before'
1616 // Parent constructor
1617 OO
.ui
.MenuLayout
.parent
.call( this, config
);
1619 this.menuPanel
= null;
1620 this.contentPanel
= null;
1621 this.expanded
= !!config
.expanded
;
1625 * @property {jQuery}
1627 this.$menu
= $( '<div>' );
1631 * @property {jQuery}
1633 this.$content
= $( '<div>' );
1637 .addClass( 'oo-ui-menuLayout-menu' );
1638 this.$content
.addClass( 'oo-ui-menuLayout-content' );
1640 .addClass( 'oo-ui-menuLayout' );
1641 if ( config
.expanded
) {
1642 this.$element
.addClass( 'oo-ui-menuLayout-expanded' );
1644 this.$element
.addClass( 'oo-ui-menuLayout-static' );
1646 if ( config
.menuPanel
) {
1647 this.setMenuPanel( config
.menuPanel
);
1649 if ( config
.contentPanel
) {
1650 this.setContentPanel( config
.contentPanel
);
1652 this.setMenuPosition( config
.menuPosition
);
1653 this.toggleMenu( config
.showMenu
);
1658 OO
.inheritClass( OO
.ui
.MenuLayout
, OO
.ui
.Layout
);
1665 * @param {boolean} showMenu Show menu, omit to toggle
1668 OO
.ui
.MenuLayout
.prototype.toggleMenu = function ( showMenu
) {
1669 showMenu
= showMenu
=== undefined ? !this.showMenu
: !!showMenu
;
1671 if ( this.showMenu
!== showMenu
) {
1672 this.showMenu
= showMenu
;
1674 .toggleClass( 'oo-ui-menuLayout-showMenu', this.showMenu
)
1675 .toggleClass( 'oo-ui-menuLayout-hideMenu', !this.showMenu
);
1676 this.$menu
.attr( 'aria-hidden', this.showMenu
? 'false' : 'true' );
1683 * Check if menu is visible
1685 * @return {boolean} Menu is visible
1687 OO
.ui
.MenuLayout
.prototype.isMenuVisible = function () {
1688 return this.showMenu
;
1692 * Set menu position.
1694 * @param {string} position Position of menu, either `top`, `after`, `bottom` or `before`
1695 * @throws {Error} If position value is not supported
1698 OO
.ui
.MenuLayout
.prototype.setMenuPosition = function ( position
) {
1699 this.$element
.removeClass( 'oo-ui-menuLayout-' + this.menuPosition
);
1700 this.menuPosition
= position
;
1701 if ( this.menuPosition
=== 'top' || this.menuPosition
=== 'before' ) {
1702 this.$element
.append( this.$menu
, this.$content
);
1704 this.$element
.append( this.$content
, this.$menu
);
1706 this.$element
.addClass( 'oo-ui-menuLayout-' + position
);
1712 * Get menu position.
1714 * @return {string} Menu position
1716 OO
.ui
.MenuLayout
.prototype.getMenuPosition = function () {
1717 return this.menuPosition
;
1721 * Set the menu panel.
1723 * @param {OO.ui.PanelLayout} menuPanel Menu panel
1725 OO
.ui
.MenuLayout
.prototype.setMenuPanel = function ( menuPanel
) {
1726 this.menuPanel
= menuPanel
;
1727 this.$menu
.append( this.menuPanel
.$element
);
1731 * Set the content panel.
1733 * @param {OO.ui.PanelLayout} menuPanel Content panel
1735 OO
.ui
.MenuLayout
.prototype.setContentPanel = function ( contentPanel
) {
1736 this.contentPanel
= contentPanel
;
1737 this.$content
.append( this.contentPanel
.$element
);
1741 * Clear the menu panel.
1743 OO
.ui
.MenuLayout
.prototype.clearMenuPanel = function () {
1744 this.menuPanel
= null;
1749 * Clear the content panel.
1751 OO
.ui
.MenuLayout
.prototype.clearContentPanel = function () {
1752 this.contentPanel
= null;
1753 this.$content
.empty();
1757 * BookletLayouts contain {@link OO.ui.PageLayout page layouts} as well as
1758 * an {@link OO.ui.OutlineSelectWidget outline} that allows users to easily navigate
1759 * through the pages and select which one to display. By default, only one page is
1760 * displayed at a time and the outline is hidden. When a user navigates to a new page,
1761 * the booklet layout automatically focuses on the first focusable element, unless the
1762 * default setting is changed. Optionally, booklets can be configured to show
1763 * {@link OO.ui.OutlineControlsWidget controls} for adding, moving, and removing items.
1766 * // Example of a BookletLayout that contains two PageLayouts.
1768 * function PageOneLayout( name, config ) {
1769 * PageOneLayout.parent.call( this, name, config );
1770 * this.$element.append( '<p>First page</p><p>(This booklet has an outline, displayed on the left)</p>' );
1772 * OO.inheritClass( PageOneLayout, OO.ui.PageLayout );
1773 * PageOneLayout.prototype.setupOutlineItem = function () {
1774 * this.outlineItem.setLabel( 'Page One' );
1777 * function PageTwoLayout( name, config ) {
1778 * PageTwoLayout.parent.call( this, name, config );
1779 * this.$element.append( '<p>Second page</p>' );
1781 * OO.inheritClass( PageTwoLayout, OO.ui.PageLayout );
1782 * PageTwoLayout.prototype.setupOutlineItem = function () {
1783 * this.outlineItem.setLabel( 'Page Two' );
1786 * var page1 = new PageOneLayout( 'one' ),
1787 * page2 = new PageTwoLayout( 'two' );
1789 * var booklet = new OO.ui.BookletLayout( {
1793 * booklet.addPages ( [ page1, page2 ] );
1794 * $( 'body' ).append( booklet.$element );
1797 * @extends OO.ui.MenuLayout
1800 * @param {Object} [config] Configuration options
1801 * @cfg {boolean} [continuous=false] Show all pages, one after another
1802 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new page is displayed. Disabled on mobile.
1803 * @cfg {boolean} [outlined=false] Show the outline. The outline is used to navigate through the pages of the booklet.
1804 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
1806 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
1807 // Configuration initialization
1808 config
= config
|| {};
1810 // Parent constructor
1811 OO
.ui
.BookletLayout
.parent
.call( this, config
);
1814 this.currentPageName
= null;
1816 this.ignoreFocus
= false;
1817 this.stackLayout
= new OO
.ui
.StackLayout( {
1818 continuous
: !!config
.continuous
,
1819 expanded
: this.expanded
1821 this.setContentPanel( this.stackLayout
);
1822 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
1823 this.outlineVisible
= false;
1824 this.outlined
= !!config
.outlined
;
1825 if ( this.outlined
) {
1826 this.editable
= !!config
.editable
;
1827 this.outlineControlsWidget
= null;
1828 this.outlineSelectWidget
= new OO
.ui
.OutlineSelectWidget();
1829 this.outlinePanel
= new OO
.ui
.PanelLayout( {
1830 expanded
: this.expanded
,
1833 this.setMenuPanel( this.outlinePanel
);
1834 this.outlineVisible
= true;
1835 if ( this.editable
) {
1836 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
1837 this.outlineSelectWidget
1841 this.toggleMenu( this.outlined
);
1844 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
1845 if ( this.outlined
) {
1846 this.outlineSelectWidget
.connect( this, { select
: 'onOutlineSelectWidgetSelect' } );
1847 this.scrolling
= false;
1848 this.stackLayout
.connect( this, { visibleItemChange
: 'onStackLayoutVisibleItemChange' } );
1850 if ( this.autoFocus
) {
1851 // Event 'focus' does not bubble, but 'focusin' does
1852 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
1856 this.$element
.addClass( 'oo-ui-bookletLayout' );
1857 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
1858 if ( this.outlined
) {
1859 this.outlinePanel
.$element
1860 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
1861 .append( this.outlineSelectWidget
.$element
);
1862 if ( this.editable
) {
1863 this.outlinePanel
.$element
1864 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
1865 .append( this.outlineControlsWidget
.$element
);
1872 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.MenuLayout
);
1877 * A 'set' event is emitted when a page is {@link #setPage set} to be displayed by the booklet layout.
1879 * @param {OO.ui.PageLayout} page Current page
1883 * An 'add' event is emitted when pages are {@link #addPages added} to the booklet layout.
1886 * @param {OO.ui.PageLayout[]} page Added pages
1887 * @param {number} index Index pages were added at
1891 * A 'remove' event is emitted when pages are {@link #clearPages cleared} or
1892 * {@link #removePages removed} from the booklet.
1895 * @param {OO.ui.PageLayout[]} pages Removed pages
1901 * Handle stack layout focus.
1904 * @param {jQuery.Event} e Focusin event
1906 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
1909 // Find the page that an element was focused within
1910 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
1911 for ( name
in this.pages
) {
1912 // Check for page match, exclude current page to find only page changes
1913 if ( this.pages
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentPageName
) {
1914 this.setPage( name
);
1921 * Handle visibleItemChange events from the stackLayout
1923 * The next visible page is set as the current page by selecting it
1926 * @param {OO.ui.PageLayout} page The next visible page in the layout
1928 OO
.ui
.BookletLayout
.prototype.onStackLayoutVisibleItemChange = function ( page
) {
1929 // Set a flag to so that the resulting call to #onStackLayoutSet doesn't
1930 // try and scroll the item into view again.
1931 this.scrolling
= true;
1932 this.outlineSelectWidget
.selectItemByData( page
.getName() );
1933 this.scrolling
= false;
1937 * Handle stack layout set events.
1940 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
1942 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
1943 var promise
, layout
= this;
1944 // If everything is unselected, do nothing
1948 // For continuous BookletLayouts, scroll the selected page into view first
1949 if ( this.stackLayout
.continuous
&& !this.scrolling
) {
1950 promise
= page
.scrollElementIntoView();
1952 promise
= $.Deferred().resolve();
1954 // Focus the first element on the newly selected panel.
1955 // Don't focus if the page was set by scrolling.
1956 if ( this.autoFocus
&& !OO
.ui
.isMobile() && !this.scrolling
) {
1957 promise
.done( function () {
1964 * Focus the first input in the current page.
1966 * If no page is selected, the first selectable page will be selected.
1967 * If the focus is already in an element on the current page, nothing will happen.
1969 * @param {number} [itemIndex] A specific item to focus on
1971 OO
.ui
.BookletLayout
.prototype.focus = function ( itemIndex
) {
1973 items
= this.stackLayout
.getItems();
1975 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
1976 page
= items
[ itemIndex
];
1978 page
= this.stackLayout
.getCurrentItem();
1981 if ( !page
&& this.outlined
) {
1982 this.selectFirstSelectablePage();
1983 page
= this.stackLayout
.getCurrentItem();
1988 // Only change the focus if is not already in the current page
1989 if ( !OO
.ui
.contains( page
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
1995 * Find the first focusable input in the booklet layout and focus
1998 OO
.ui
.BookletLayout
.prototype.focusFirstFocusable = function () {
1999 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
2003 * Handle outline widget select events.
2006 * @param {OO.ui.OptionWidget|null} item Selected item
2008 OO
.ui
.BookletLayout
.prototype.onOutlineSelectWidgetSelect = function ( item
) {
2010 this.setPage( item
.getData() );
2015 * Check if booklet has an outline.
2017 * @return {boolean} Booklet has an outline
2019 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
2020 return this.outlined
;
2024 * Check if booklet has editing controls.
2026 * @return {boolean} Booklet is editable
2028 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
2029 return this.editable
;
2033 * Check if booklet has a visible outline.
2035 * @return {boolean} Outline is visible
2037 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
2038 return this.outlined
&& this.outlineVisible
;
2042 * Hide or show the outline.
2044 * @param {boolean} [show] Show outline, omit to invert current state
2047 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
2050 if ( this.outlined
) {
2051 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
2052 this.outlineVisible
= show
;
2053 this.toggleMenu( show
);
2054 if ( show
&& this.editable
) {
2055 // HACK: Kill dumb scrollbars when the sidebar stops animating, see T161798. Only necessary when
2056 // outline controls are present, delay matches transition on `.oo-ui-menuLayout-menu`.
2057 setTimeout( function () {
2058 OO
.ui
.Element
.static.reconsiderScrollbars( booklet
.outlinePanel
.$element
[ 0 ] );
2067 * Find the page closest to the specified page.
2069 * @param {OO.ui.PageLayout} page Page to use as a reference point
2070 * @return {OO.ui.PageLayout|null} Page closest to the specified page
2072 OO
.ui
.BookletLayout
.prototype.findClosestPage = function ( page
) {
2073 var next
, prev
, level
,
2074 pages
= this.stackLayout
.getItems(),
2075 index
= pages
.indexOf( page
);
2077 if ( index
!== -1 ) {
2078 next
= pages
[ index
+ 1 ];
2079 prev
= pages
[ index
- 1 ];
2080 // Prefer adjacent pages at the same level
2081 if ( this.outlined
) {
2082 level
= this.outlineSelectWidget
.findItemFromData( page
.getName() ).getLevel();
2085 level
=== this.outlineSelectWidget
.findItemFromData( prev
.getName() ).getLevel()
2091 level
=== this.outlineSelectWidget
.findItemFromData( next
.getName() ).getLevel()
2097 return prev
|| next
|| null;
2101 * Get the outline widget.
2103 * If the booklet is not outlined, the method will return `null`.
2105 * @return {OO.ui.OutlineSelectWidget|null} Outline widget, or null if the booklet is not outlined
2107 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
2108 return this.outlineSelectWidget
;
2112 * Get the outline controls widget.
2114 * If the outline is not editable, the method will return `null`.
2116 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
2118 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
2119 return this.outlineControlsWidget
;
2123 * Get a page by its symbolic name.
2125 * @param {string} name Symbolic name of page
2126 * @return {OO.ui.PageLayout|undefined} Page, if found
2128 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
2129 return this.pages
[ name
];
2133 * Get the current page.
2135 * @return {OO.ui.PageLayout|undefined} Current page, if found
2137 OO
.ui
.BookletLayout
.prototype.getCurrentPage = function () {
2138 var name
= this.getCurrentPageName();
2139 return name
? this.getPage( name
) : undefined;
2143 * Get the symbolic name of the current page.
2145 * @return {string|null} Symbolic name of the current page
2147 OO
.ui
.BookletLayout
.prototype.getCurrentPageName = function () {
2148 return this.currentPageName
;
2152 * Add pages to the booklet layout
2154 * When pages are added with the same names as existing pages, the existing pages will be
2155 * automatically removed before the new pages are added.
2157 * @param {OO.ui.PageLayout[]} pages Pages to add
2158 * @param {number} index Index of the insertion point
2162 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
2163 var i
, len
, name
, page
, item
, currentIndex
,
2164 stackLayoutPages
= this.stackLayout
.getItems(),
2168 // Remove pages with same names
2169 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2171 name
= page
.getName();
2173 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
2174 // Correct the insertion index
2175 currentIndex
= stackLayoutPages
.indexOf( this.pages
[ name
] );
2176 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2179 remove
.push( this.pages
[ name
] );
2182 if ( remove
.length
) {
2183 this.removePages( remove
);
2187 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2189 name
= page
.getName();
2190 this.pages
[ page
.getName() ] = page
;
2191 if ( this.outlined
) {
2192 item
= new OO
.ui
.OutlineOptionWidget( { data
: name
} );
2193 page
.setOutlineItem( item
);
2198 if ( this.outlined
&& items
.length
) {
2199 this.outlineSelectWidget
.addItems( items
, index
);
2200 this.selectFirstSelectablePage();
2202 this.stackLayout
.addItems( pages
, index
);
2203 this.emit( 'add', pages
, index
);
2209 * Remove the specified pages from the booklet layout.
2211 * To remove all pages from the booklet, you may wish to use the #clearPages method instead.
2213 * @param {OO.ui.PageLayout[]} pages An array of pages to remove
2217 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
2218 var i
, len
, name
, page
,
2221 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2223 name
= page
.getName();
2224 delete this.pages
[ name
];
2225 if ( this.outlined
) {
2226 items
.push( this.outlineSelectWidget
.findItemFromData( name
) );
2227 page
.setOutlineItem( null );
2230 if ( this.outlined
&& items
.length
) {
2231 this.outlineSelectWidget
.removeItems( items
);
2232 this.selectFirstSelectablePage();
2234 this.stackLayout
.removeItems( pages
);
2235 this.emit( 'remove', pages
);
2241 * Clear all pages from the booklet layout.
2243 * To remove only a subset of pages from the booklet, use the #removePages method.
2248 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
2250 pages
= this.stackLayout
.getItems();
2253 this.currentPageName
= null;
2254 if ( this.outlined
) {
2255 this.outlineSelectWidget
.clearItems();
2256 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2257 pages
[ i
].setOutlineItem( null );
2260 this.stackLayout
.clearItems();
2262 this.emit( 'remove', pages
);
2268 * Set the current page by symbolic name.
2271 * @param {string} name Symbolic name of page
2273 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
2276 page
= this.pages
[ name
],
2277 previousPage
= this.currentPageName
&& this.pages
[ this.currentPageName
];
2279 if ( name
!== this.currentPageName
) {
2280 if ( this.outlined
) {
2281 selectedItem
= this.outlineSelectWidget
.findSelectedItem();
2282 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2283 this.outlineSelectWidget
.selectItemByData( name
);
2287 if ( previousPage
) {
2288 previousPage
.setActive( false );
2289 // Blur anything focused if the next page doesn't have anything focusable.
2290 // This is not needed if the next page has something focusable (because once it is focused
2291 // this blur happens automatically). If the layout is non-continuous, this check is
2292 // meaningless because the next page is not visible yet and thus can't hold focus.
2295 !OO
.ui
.isMobile() &&
2296 this.stackLayout
.continuous
&&
2297 OO
.ui
.findFocusable( page
.$element
).length
!== 0
2299 $focused
= previousPage
.$element
.find( ':focus' );
2300 if ( $focused
.length
) {
2301 $focused
[ 0 ].blur();
2305 this.currentPageName
= name
;
2306 page
.setActive( true );
2307 this.stackLayout
.setItem( page
);
2308 if ( !this.stackLayout
.continuous
&& previousPage
) {
2309 // This should not be necessary, since any inputs on the previous page should have been
2310 // blurred when it was hidden, but browsers are not very consistent about this.
2311 $focused
= previousPage
.$element
.find( ':focus' );
2312 if ( $focused
.length
) {
2313 $focused
[ 0 ].blur();
2316 this.emit( 'set', page
);
2322 * Select the first selectable page.
2326 OO
.ui
.BookletLayout
.prototype.selectFirstSelectablePage = function () {
2327 if ( !this.outlineSelectWidget
.findSelectedItem() ) {
2328 this.outlineSelectWidget
.selectItem( this.outlineSelectWidget
.findFirstSelectableItem() );
2335 * IndexLayouts contain {@link OO.ui.TabPanelLayout tab panel layouts} as well as
2336 * {@link OO.ui.TabSelectWidget tabs} that allow users to easily navigate through the tab panels and
2337 * select which one to display. By default, only one tab panel is displayed at a time. When a user
2338 * navigates to a new tab panel, the index layout automatically focuses on the first focusable element,
2339 * unless the default setting is changed.
2341 * TODO: This class is similar to BookletLayout, we may want to refactor to reduce duplication
2344 * // Example of a IndexLayout that contains two TabPanelLayouts.
2346 * function TabPanelOneLayout( name, config ) {
2347 * TabPanelOneLayout.parent.call( this, name, config );
2348 * this.$element.append( '<p>First tab panel</p>' );
2350 * OO.inheritClass( TabPanelOneLayout, OO.ui.TabPanelLayout );
2351 * TabPanelOneLayout.prototype.setupTabItem = function () {
2352 * this.tabItem.setLabel( 'Tab panel one' );
2355 * var tabPanel1 = new TabPanelOneLayout( 'one' ),
2356 * tabPanel2 = new OO.ui.TabPanelLayout( 'two', { label: 'Tab panel two' } );
2358 * tabPanel2.$element.append( '<p>Second tab panel</p>' );
2360 * var index = new OO.ui.IndexLayout();
2362 * index.addTabPanels( [ tabPanel1, tabPanel2 ] );
2363 * $( 'body' ).append( index.$element );
2366 * @extends OO.ui.MenuLayout
2369 * @param {Object} [config] Configuration options
2370 * @cfg {boolean} [continuous=false] Show all tab panels, one after another
2371 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new tab panel is displayed. Disabled on mobile.
2373 OO
.ui
.IndexLayout
= function OoUiIndexLayout( config
) {
2374 // Configuration initialization
2375 config
= $.extend( {}, config
, { menuPosition
: 'top' } );
2377 // Parent constructor
2378 OO
.ui
.IndexLayout
.parent
.call( this, config
);
2381 this.currentTabPanelName
= null;
2382 this.tabPanels
= {};
2384 this.ignoreFocus
= false;
2385 this.stackLayout
= new OO
.ui
.StackLayout( {
2386 continuous
: !!config
.continuous
,
2387 expanded
: this.expanded
2389 this.setContentPanel( this.stackLayout
);
2390 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
2392 this.tabSelectWidget
= new OO
.ui
.TabSelectWidget();
2393 this.tabPanel
= new OO
.ui
.PanelLayout( {
2394 expanded
: this.expanded
2396 this.setMenuPanel( this.tabPanel
);
2398 this.toggleMenu( true );
2401 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
2402 this.tabSelectWidget
.connect( this, { select
: 'onTabSelectWidgetSelect' } );
2403 if ( this.autoFocus
) {
2404 // Event 'focus' does not bubble, but 'focusin' does
2405 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
2409 this.$element
.addClass( 'oo-ui-indexLayout' );
2410 this.stackLayout
.$element
.addClass( 'oo-ui-indexLayout-stackLayout' );
2411 this.tabPanel
.$element
2412 .addClass( 'oo-ui-indexLayout-tabPanel' )
2413 .append( this.tabSelectWidget
.$element
);
2418 OO
.inheritClass( OO
.ui
.IndexLayout
, OO
.ui
.MenuLayout
);
2423 * A 'set' event is emitted when a tab panel is {@link #setTabPanel set} to be displayed by the index layout.
2425 * @param {OO.ui.TabPanelLayout} tabPanel Current tab panel
2429 * An 'add' event is emitted when tab panels are {@link #addTabPanels added} to the index layout.
2432 * @param {OO.ui.TabPanelLayout[]} tabPanel Added tab panels
2433 * @param {number} index Index tab panels were added at
2437 * A 'remove' event is emitted when tab panels are {@link #clearTabPanels cleared} or
2438 * {@link #removeTabPanels removed} from the index.
2441 * @param {OO.ui.TabPanelLayout[]} tabPanel Removed tab panels
2447 * Handle stack layout focus.
2450 * @param {jQuery.Event} e Focusing event
2452 OO
.ui
.IndexLayout
.prototype.onStackLayoutFocus = function ( e
) {
2455 // Find the tab panel that an element was focused within
2456 $target
= $( e
.target
).closest( '.oo-ui-tabPanelLayout' );
2457 for ( name
in this.tabPanels
) {
2458 // Check for tab panel match, exclude current tab panel to find only tab panel changes
2459 if ( this.tabPanels
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentTabPanelName
) {
2460 this.setTabPanel( name
);
2467 * Handle stack layout set events.
2470 * @param {OO.ui.PanelLayout|null} tabPanel The tab panel that is now the current panel
2472 OO
.ui
.IndexLayout
.prototype.onStackLayoutSet = function ( tabPanel
) {
2473 // If everything is unselected, do nothing
2477 // Focus the first element on the newly selected panel
2478 if ( this.autoFocus
&& !OO
.ui
.isMobile() ) {
2484 * Focus the first input in the current tab panel.
2486 * If no tab panel is selected, the first selectable tab panel will be selected.
2487 * If the focus is already in an element on the current tab panel, nothing will happen.
2489 * @param {number} [itemIndex] A specific item to focus on
2491 OO
.ui
.IndexLayout
.prototype.focus = function ( itemIndex
) {
2493 items
= this.stackLayout
.getItems();
2495 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
2496 tabPanel
= items
[ itemIndex
];
2498 tabPanel
= this.stackLayout
.getCurrentItem();
2502 this.selectFirstSelectableTabPanel();
2503 tabPanel
= this.stackLayout
.getCurrentItem();
2508 // Only change the focus if is not already in the current page
2509 if ( !OO
.ui
.contains( tabPanel
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
2515 * Find the first focusable input in the index layout and focus
2518 OO
.ui
.IndexLayout
.prototype.focusFirstFocusable = function () {
2519 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
2523 * Handle tab widget select events.
2526 * @param {OO.ui.OptionWidget|null} item Selected item
2528 OO
.ui
.IndexLayout
.prototype.onTabSelectWidgetSelect = function ( item
) {
2530 this.setTabPanel( item
.getData() );
2535 * Get the tab panel closest to the specified tab panel.
2537 * @param {OO.ui.TabPanelLayout} tabPanel Tab panel to use as a reference point
2538 * @return {OO.ui.TabPanelLayout|null} Tab panel closest to the specified
2540 OO
.ui
.IndexLayout
.prototype.getClosestTabPanel = function ( tabPanel
) {
2541 var next
, prev
, level
,
2542 tabPanels
= this.stackLayout
.getItems(),
2543 index
= tabPanels
.indexOf( tabPanel
);
2545 if ( index
!== -1 ) {
2546 next
= tabPanels
[ index
+ 1 ];
2547 prev
= tabPanels
[ index
- 1 ];
2548 // Prefer adjacent tab panels at the same level
2549 level
= this.tabSelectWidget
.findItemFromData( tabPanel
.getName() ).getLevel();
2552 level
=== this.tabSelectWidget
.findItemFromData( prev
.getName() ).getLevel()
2558 level
=== this.tabSelectWidget
.findItemFromData( next
.getName() ).getLevel()
2563 return prev
|| next
|| null;
2567 * Get the tabs widget.
2569 * @return {OO.ui.TabSelectWidget} Tabs widget
2571 OO
.ui
.IndexLayout
.prototype.getTabs = function () {
2572 return this.tabSelectWidget
;
2576 * Get a tab panel by its symbolic name.
2578 * @param {string} name Symbolic name of tab panel
2579 * @return {OO.ui.TabPanelLayout|undefined} Tab panel, if found
2581 OO
.ui
.IndexLayout
.prototype.getTabPanel = function ( name
) {
2582 return this.tabPanels
[ name
];
2586 * Get the current tab panel.
2588 * @return {OO.ui.TabPanelLayout|undefined} Current tab panel, if found
2590 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanel = function () {
2591 var name
= this.getCurrentTabPanelName();
2592 return name
? this.getTabPanel( name
) : undefined;
2596 * Get the symbolic name of the current tab panel.
2598 * @return {string|null} Symbolic name of the current tab panel
2600 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanelName = function () {
2601 return this.currentTabPanelName
;
2605 * Add tab panels to the index layout
2607 * When tab panels are added with the same names as existing tab panels, the existing tab panels
2608 * will be automatically removed before the new tab panels are added.
2610 * @param {OO.ui.TabPanelLayout[]} tabPanels Tab panels to add
2611 * @param {number} index Index of the insertion point
2615 OO
.ui
.IndexLayout
.prototype.addTabPanels = function ( tabPanels
, index
) {
2616 var i
, len
, name
, tabPanel
, item
, currentIndex
,
2617 stackLayoutTabPanels
= this.stackLayout
.getItems(),
2621 // Remove tab panels with same names
2622 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2623 tabPanel
= tabPanels
[ i
];
2624 name
= tabPanel
.getName();
2626 if ( Object
.prototype.hasOwnProperty
.call( this.tabPanels
, name
) ) {
2627 // Correct the insertion index
2628 currentIndex
= stackLayoutTabPanels
.indexOf( this.tabPanels
[ name
] );
2629 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2632 remove
.push( this.tabPanels
[ name
] );
2635 if ( remove
.length
) {
2636 this.removeTabPanels( remove
);
2639 // Add new tab panels
2640 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2641 tabPanel
= tabPanels
[ i
];
2642 name
= tabPanel
.getName();
2643 this.tabPanels
[ tabPanel
.getName() ] = tabPanel
;
2644 item
= new OO
.ui
.TabOptionWidget( { data
: name
} );
2645 tabPanel
.setTabItem( item
);
2649 if ( items
.length
) {
2650 this.tabSelectWidget
.addItems( items
, index
);
2651 this.selectFirstSelectableTabPanel();
2653 this.stackLayout
.addItems( tabPanels
, index
);
2654 this.emit( 'add', tabPanels
, index
);
2660 * Remove the specified tab panels from the index layout.
2662 * To remove all tab panels from the index, you may wish to use the #clearTabPanels method instead.
2664 * @param {OO.ui.TabPanelLayout[]} tabPanels An array of tab panels to remove
2668 OO
.ui
.IndexLayout
.prototype.removeTabPanels = function ( tabPanels
) {
2669 var i
, len
, name
, tabPanel
,
2672 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2673 tabPanel
= tabPanels
[ i
];
2674 name
= tabPanel
.getName();
2675 delete this.tabPanels
[ name
];
2676 items
.push( this.tabSelectWidget
.findItemFromData( name
) );
2677 tabPanel
.setTabItem( null );
2679 if ( items
.length
) {
2680 this.tabSelectWidget
.removeItems( items
);
2681 this.selectFirstSelectableTabPanel();
2683 this.stackLayout
.removeItems( tabPanels
);
2684 this.emit( 'remove', tabPanels
);
2690 * Clear all tab panels from the index layout.
2692 * To remove only a subset of tab panels from the index, use the #removeTabPanels method.
2697 OO
.ui
.IndexLayout
.prototype.clearTabPanels = function () {
2699 tabPanels
= this.stackLayout
.getItems();
2701 this.tabPanels
= {};
2702 this.currentTabPanelName
= null;
2703 this.tabSelectWidget
.clearItems();
2704 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2705 tabPanels
[ i
].setTabItem( null );
2707 this.stackLayout
.clearItems();
2709 this.emit( 'remove', tabPanels
);
2715 * Set the current tab panel by symbolic name.
2718 * @param {string} name Symbolic name of tab panel
2720 OO
.ui
.IndexLayout
.prototype.setTabPanel = function ( name
) {
2723 tabPanel
= this.tabPanels
[ name
],
2724 previousTabPanel
= this.currentTabPanelName
&& this.tabPanels
[ this.currentTabPanelName
];
2726 if ( name
!== this.currentTabPanelName
) {
2727 selectedItem
= this.tabSelectWidget
.findSelectedItem();
2728 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2729 this.tabSelectWidget
.selectItemByData( name
);
2732 if ( previousTabPanel
) {
2733 previousTabPanel
.setActive( false );
2734 // Blur anything focused if the next tab panel doesn't have anything focusable.
2735 // This is not needed if the next tab panel has something focusable (because once it is focused
2736 // this blur happens automatically). If the layout is non-continuous, this check is
2737 // meaningless because the next tab panel is not visible yet and thus can't hold focus.
2740 !OO
.ui
.isMobile() &&
2741 this.stackLayout
.continuous
&&
2742 OO
.ui
.findFocusable( tabPanel
.$element
).length
!== 0
2744 $focused
= previousTabPanel
.$element
.find( ':focus' );
2745 if ( $focused
.length
) {
2746 $focused
[ 0 ].blur();
2750 this.currentTabPanelName
= name
;
2751 tabPanel
.setActive( true );
2752 this.stackLayout
.setItem( tabPanel
);
2753 if ( !this.stackLayout
.continuous
&& previousTabPanel
) {
2754 // This should not be necessary, since any inputs on the previous tab panel should have been
2755 // blurred when it was hidden, but browsers are not very consistent about this.
2756 $focused
= previousTabPanel
.$element
.find( ':focus' );
2757 if ( $focused
.length
) {
2758 $focused
[ 0 ].blur();
2761 this.emit( 'set', tabPanel
);
2767 * Select the first selectable tab panel.
2771 OO
.ui
.IndexLayout
.prototype.selectFirstSelectableTabPanel = function () {
2772 if ( !this.tabSelectWidget
.findSelectedItem() ) {
2773 this.tabSelectWidget
.selectItem( this.tabSelectWidget
.findFirstSelectableItem() );
2780 * ToggleWidget implements basic behavior of widgets with an on/off state.
2781 * Please see OO.ui.ToggleButtonWidget and OO.ui.ToggleSwitchWidget for examples.
2785 * @extends OO.ui.Widget
2788 * @param {Object} [config] Configuration options
2789 * @cfg {boolean} [value=false] The toggle’s initial on/off state.
2790 * By default, the toggle is in the 'off' state.
2792 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
2793 // Configuration initialization
2794 config
= config
|| {};
2796 // Parent constructor
2797 OO
.ui
.ToggleWidget
.parent
.call( this, config
);
2803 this.$element
.addClass( 'oo-ui-toggleWidget' );
2804 this.setValue( !!config
.value
);
2809 OO
.inheritClass( OO
.ui
.ToggleWidget
, OO
.ui
.Widget
);
2816 * A change event is emitted when the on/off state of the toggle changes.
2818 * @param {boolean} value Value representing the new state of the toggle
2824 * Get the value representing the toggle’s state.
2826 * @return {boolean} The on/off state of the toggle
2828 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
2833 * Set the state of the toggle: `true` for 'on', `false` for 'off'.
2835 * @param {boolean} value The state of the toggle
2839 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
2841 if ( this.value
!== value
) {
2843 this.emit( 'change', value
);
2844 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
2845 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
2851 * ToggleButtons are buttons that have a state (‘on’ or ‘off’) that is represented by a
2852 * Boolean value. Like other {@link OO.ui.ButtonWidget buttons}, toggle buttons can be
2853 * configured with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators},
2854 * {@link OO.ui.mixin.TitledElement titles}, {@link OO.ui.mixin.FlaggedElement styling flags},
2855 * and {@link OO.ui.mixin.LabelElement labels}. Please see
2856 * the [OOUI documentation][1] on MediaWiki for more information.
2859 * // Toggle buttons in the 'off' and 'on' state.
2860 * var toggleButton1 = new OO.ui.ToggleButtonWidget( {
2861 * label: 'Toggle Button off'
2863 * var toggleButton2 = new OO.ui.ToggleButtonWidget( {
2864 * label: 'Toggle Button on',
2867 * // Append the buttons to the DOM.
2868 * $( 'body' ).append( toggleButton1.$element, toggleButton2.$element );
2870 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Buttons_and_Switches#Toggle_buttons
2873 * @extends OO.ui.ToggleWidget
2874 * @mixins OO.ui.mixin.ButtonElement
2875 * @mixins OO.ui.mixin.IconElement
2876 * @mixins OO.ui.mixin.IndicatorElement
2877 * @mixins OO.ui.mixin.LabelElement
2878 * @mixins OO.ui.mixin.TitledElement
2879 * @mixins OO.ui.mixin.FlaggedElement
2880 * @mixins OO.ui.mixin.TabIndexedElement
2883 * @param {Object} [config] Configuration options
2884 * @cfg {boolean} [value=false] The toggle button’s initial on/off
2885 * state. By default, the button is in the 'off' state.
2887 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
2888 // Configuration initialization
2889 config
= config
|| {};
2891 // Parent constructor
2892 OO
.ui
.ToggleButtonWidget
.parent
.call( this, config
);
2894 // Mixin constructors
2895 OO
.ui
.mixin
.ButtonElement
.call( this, $.extend( {}, config
, { active
: this.active
} ) );
2896 OO
.ui
.mixin
.IconElement
.call( this, config
);
2897 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
2898 OO
.ui
.mixin
.LabelElement
.call( this, config
);
2899 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
2900 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
2901 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$button
} ) );
2904 this.connect( this, { click
: 'onAction' } );
2907 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
2909 .addClass( 'oo-ui-toggleButtonWidget' )
2910 .append( this.$button
);
2915 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
2916 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.ButtonElement
);
2917 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IconElement
);
2918 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IndicatorElement
);
2919 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.LabelElement
);
2920 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TitledElement
);
2921 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.FlaggedElement
);
2922 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TabIndexedElement
);
2924 /* Static Properties */
2930 OO
.ui
.ToggleButtonWidget
.static.tagName
= 'span';
2935 * Handle the button action being triggered.
2939 OO
.ui
.ToggleButtonWidget
.prototype.onAction = function () {
2940 this.setValue( !this.value
);
2946 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
2948 if ( value
!== this.value
) {
2949 // Might be called from parent constructor before ButtonElement constructor
2950 if ( this.$button
) {
2951 this.$button
.attr( 'aria-pressed', value
.toString() );
2953 this.setActive( value
);
2957 OO
.ui
.ToggleButtonWidget
.parent
.prototype.setValue
.call( this, value
);
2965 OO
.ui
.ToggleButtonWidget
.prototype.setButtonElement = function ( $button
) {
2966 if ( this.$button
) {
2967 this.$button
.removeAttr( 'aria-pressed' );
2969 OO
.ui
.mixin
.ButtonElement
.prototype.setButtonElement
.call( this, $button
);
2970 this.$button
.attr( 'aria-pressed', this.value
.toString() );
2974 * ToggleSwitches are switches that slide on and off. Their state is represented by a Boolean
2975 * value (`true` for ‘on’, and `false` otherwise, the default). The ‘off’ state is represented
2976 * visually by a slider in the leftmost position.
2979 * // Toggle switches in the 'off' and 'on' position.
2980 * var toggleSwitch1 = new OO.ui.ToggleSwitchWidget();
2981 * var toggleSwitch2 = new OO.ui.ToggleSwitchWidget( {
2985 * // Create a FieldsetLayout to layout and label switches
2986 * var fieldset = new OO.ui.FieldsetLayout( {
2987 * label: 'Toggle switches'
2989 * fieldset.addItems( [
2990 * new OO.ui.FieldLayout( toggleSwitch1, { label: 'Off', align: 'top' } ),
2991 * new OO.ui.FieldLayout( toggleSwitch2, { label: 'On', align: 'top' } )
2993 * $( 'body' ).append( fieldset.$element );
2996 * @extends OO.ui.ToggleWidget
2997 * @mixins OO.ui.mixin.TabIndexedElement
3000 * @param {Object} [config] Configuration options
3001 * @cfg {boolean} [value=false] The toggle switch’s initial on/off state.
3002 * By default, the toggle switch is in the 'off' position.
3004 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
3005 // Parent constructor
3006 OO
.ui
.ToggleSwitchWidget
.parent
.call( this, config
);
3008 // Mixin constructors
3009 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3012 this.dragging
= false;
3013 this.dragStart
= null;
3014 this.sliding
= false;
3015 this.$glow
= $( '<span>' );
3016 this.$grip
= $( '<span>' );
3020 click
: this.onClick
.bind( this ),
3021 keypress
: this.onKeyPress
.bind( this )
3025 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
3026 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
3028 .addClass( 'oo-ui-toggleSwitchWidget' )
3029 .attr( 'role', 'checkbox' )
3030 .append( this.$glow
, this.$grip
);
3035 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
3036 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3041 * Handle mouse click events.
3044 * @param {jQuery.Event} e Mouse click event
3046 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
3047 if ( !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
3048 this.setValue( !this.value
);
3054 * Handle key press events.
3057 * @param {jQuery.Event} e Key press event
3059 OO
.ui
.ToggleSwitchWidget
.prototype.onKeyPress = function ( e
) {
3060 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
3061 this.setValue( !this.value
);
3069 OO
.ui
.ToggleSwitchWidget
.prototype.setValue = function ( value
) {
3070 OO
.ui
.ToggleSwitchWidget
.parent
.prototype.setValue
.call( this, value
);
3071 this.$element
.attr( 'aria-checked', this.value
.toString() );
3078 OO
.ui
.ToggleSwitchWidget
.prototype.simulateLabelClick = function () {
3079 if ( !this.isDisabled() ) {
3080 this.setValue( !this.value
);
3086 * OutlineControlsWidget is a set of controls for an {@link OO.ui.OutlineSelectWidget outline select widget}.
3087 * Controls include moving items up and down, removing items, and adding different kinds of items.
3089 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3092 * @extends OO.ui.Widget
3093 * @mixins OO.ui.mixin.GroupElement
3096 * @param {OO.ui.OutlineSelectWidget} outline Outline to control
3097 * @param {Object} [config] Configuration options
3098 * @cfg {Object} [abilities] List of abilties
3099 * @cfg {boolean} [abilities.move=true] Allow moving movable items
3100 * @cfg {boolean} [abilities.remove=true] Allow removing removable items
3102 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
3103 // Allow passing positional parameters inside the config object
3104 if ( OO
.isPlainObject( outline
) && config
=== undefined ) {
3106 outline
= config
.outline
;
3109 // Configuration initialization
3110 config
= config
|| {};
3112 // Parent constructor
3113 OO
.ui
.OutlineControlsWidget
.parent
.call( this, config
);
3115 // Mixin constructors
3116 OO
.ui
.mixin
.GroupElement
.call( this, config
);
3119 this.outline
= outline
;
3120 this.$movers
= $( '<div>' );
3121 this.upButton
= new OO
.ui
.ButtonWidget( {
3124 title
: OO
.ui
.msg( 'ooui-outline-control-move-up' )
3126 this.downButton
= new OO
.ui
.ButtonWidget( {
3129 title
: OO
.ui
.msg( 'ooui-outline-control-move-down' )
3131 this.removeButton
= new OO
.ui
.ButtonWidget( {
3134 title
: OO
.ui
.msg( 'ooui-outline-control-remove' )
3136 this.abilities
= { move: true, remove
: true };
3139 outline
.connect( this, {
3140 select
: 'onOutlineChange',
3141 add
: 'onOutlineChange',
3142 remove
: 'onOutlineChange'
3144 this.upButton
.connect( this, { click
: [ 'emit', 'move', -1 ] } );
3145 this.downButton
.connect( this, { click
: [ 'emit', 'move', 1 ] } );
3146 this.removeButton
.connect( this, { click
: [ 'emit', 'remove' ] } );
3149 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
3150 this.$group
.addClass( 'oo-ui-outlineControlsWidget-items' );
3152 .addClass( 'oo-ui-outlineControlsWidget-movers' )
3153 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
3154 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
3155 this.setAbilities( config
.abilities
|| {} );
3160 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
3161 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.GroupElement
);
3167 * @param {number} places Number of places to move
3179 * @param {Object} abilities List of abilties
3180 * @param {boolean} [abilities.move] Allow moving movable items
3181 * @param {boolean} [abilities.remove] Allow removing removable items
3183 OO
.ui
.OutlineControlsWidget
.prototype.setAbilities = function ( abilities
) {
3186 for ( ability
in this.abilities
) {
3187 if ( abilities
[ ability
] !== undefined ) {
3188 this.abilities
[ ability
] = !!abilities
[ ability
];
3192 this.onOutlineChange();
3196 * Handle outline change events.
3200 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
3201 var i
, len
, firstMovable
, lastMovable
,
3202 items
= this.outline
.getItems(),
3203 selectedItem
= this.outline
.findSelectedItem(),
3204 movable
= this.abilities
.move && selectedItem
&& selectedItem
.isMovable(),
3205 removable
= this.abilities
.remove
&& selectedItem
&& selectedItem
.isRemovable();
3210 while ( ++i
< len
) {
3211 if ( items
[ i
].isMovable() ) {
3212 firstMovable
= items
[ i
];
3218 if ( items
[ i
].isMovable() ) {
3219 lastMovable
= items
[ i
];
3224 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
3225 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
3226 this.removeButton
.setDisabled( !removable
);
3230 * OutlineOptionWidget is an item in an {@link OO.ui.OutlineSelectWidget OutlineSelectWidget}.
3232 * Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}, which contain
3233 * {@link OO.ui.PageLayout page layouts}. See {@link OO.ui.BookletLayout BookletLayout}
3237 * @extends OO.ui.DecoratedOptionWidget
3240 * @param {Object} [config] Configuration options
3241 * @cfg {number} [level] Indentation level
3242 * @cfg {boolean} [movable] Allow modification from {@link OO.ui.OutlineControlsWidget outline controls}.
3244 OO
.ui
.OutlineOptionWidget
= function OoUiOutlineOptionWidget( config
) {
3245 // Configuration initialization
3246 config
= config
|| {};
3248 // Parent constructor
3249 OO
.ui
.OutlineOptionWidget
.parent
.call( this, config
);
3253 this.movable
= !!config
.movable
;
3254 this.removable
= !!config
.removable
;
3257 this.$element
.addClass( 'oo-ui-outlineOptionWidget' );
3258 this.setLevel( config
.level
);
3263 OO
.inheritClass( OO
.ui
.OutlineOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
3265 /* Static Properties */
3271 OO
.ui
.OutlineOptionWidget
.static.highlightable
= true;
3277 OO
.ui
.OutlineOptionWidget
.static.scrollIntoViewOnSelect
= true;
3282 * @property {string}
3284 OO
.ui
.OutlineOptionWidget
.static.levelClass
= 'oo-ui-outlineOptionWidget-level-';
3289 * @property {number}
3291 OO
.ui
.OutlineOptionWidget
.static.levels
= 3;
3296 * Check if item is movable.
3298 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3300 * @return {boolean} Item is movable
3302 OO
.ui
.OutlineOptionWidget
.prototype.isMovable = function () {
3303 return this.movable
;
3307 * Check if item is removable.
3309 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3311 * @return {boolean} Item is removable
3313 OO
.ui
.OutlineOptionWidget
.prototype.isRemovable = function () {
3314 return this.removable
;
3318 * Get indentation level.
3320 * @return {number} Indentation level
3322 OO
.ui
.OutlineOptionWidget
.prototype.getLevel = function () {
3329 OO
.ui
.OutlineOptionWidget
.prototype.setPressed = function ( state
) {
3330 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setPressed
.call( this, state
);
3337 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3339 * @param {boolean} movable Item is movable
3342 OO
.ui
.OutlineOptionWidget
.prototype.setMovable = function ( movable
) {
3343 this.movable
= !!movable
;
3344 this.updateThemeClasses();
3351 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3353 * @param {boolean} removable Item is removable
3356 OO
.ui
.OutlineOptionWidget
.prototype.setRemovable = function ( removable
) {
3357 this.removable
= !!removable
;
3358 this.updateThemeClasses();
3365 OO
.ui
.OutlineOptionWidget
.prototype.setSelected = function ( state
) {
3366 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3371 * Set indentation level.
3373 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
3376 OO
.ui
.OutlineOptionWidget
.prototype.setLevel = function ( level
) {
3377 var levels
= this.constructor.static.levels
,
3378 levelClass
= this.constructor.static.levelClass
,
3381 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
3383 if ( this.level
=== i
) {
3384 this.$element
.addClass( levelClass
+ i
);
3386 this.$element
.removeClass( levelClass
+ i
);
3389 this.updateThemeClasses();
3395 * OutlineSelectWidget is a structured list that contains {@link OO.ui.OutlineOptionWidget outline options}
3396 * A set of controls can be provided with an {@link OO.ui.OutlineControlsWidget outline controls} widget.
3398 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3401 * @extends OO.ui.SelectWidget
3402 * @mixins OO.ui.mixin.TabIndexedElement
3405 * @param {Object} [config] Configuration options
3407 OO
.ui
.OutlineSelectWidget
= function OoUiOutlineSelectWidget( config
) {
3408 // Parent constructor
3409 OO
.ui
.OutlineSelectWidget
.parent
.call( this, config
);
3411 // Mixin constructors
3412 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3416 focus
: this.bindDocumentKeyDownListener
.bind( this ),
3417 blur
: this.unbindDocumentKeyDownListener
.bind( this )
3421 this.$element
.addClass( 'oo-ui-outlineSelectWidget' );
3426 OO
.inheritClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.SelectWidget
);
3427 OO
.mixinClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3430 * ButtonOptionWidget is a special type of {@link OO.ui.mixin.ButtonElement button element} that
3431 * can be selected and configured with data. The class is
3432 * used with OO.ui.ButtonSelectWidget to create a selection of button options. Please see the
3433 * [OOUI documentation on MediaWiki] [1] for more information.
3435 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Button_selects_and_options
3438 * @extends OO.ui.OptionWidget
3439 * @mixins OO.ui.mixin.ButtonElement
3440 * @mixins OO.ui.mixin.IconElement
3441 * @mixins OO.ui.mixin.IndicatorElement
3442 * @mixins OO.ui.mixin.TitledElement
3445 * @param {Object} [config] Configuration options
3447 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( config
) {
3448 // Configuration initialization
3449 config
= config
|| {};
3451 // Parent constructor
3452 OO
.ui
.ButtonOptionWidget
.parent
.call( this, config
);
3454 // Mixin constructors
3455 OO
.ui
.mixin
.ButtonElement
.call( this, config
);
3456 OO
.ui
.mixin
.IconElement
.call( this, config
);
3457 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3458 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
3461 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
3462 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
3463 this.$element
.append( this.$button
);
3468 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.OptionWidget
);
3469 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.ButtonElement
);
3470 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IconElement
);
3471 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IndicatorElement
);
3472 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.TitledElement
);
3474 /* Static Properties */
3477 * Allow button mouse down events to pass through so they can be handled by the parent select widget
3482 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
3488 OO
.ui
.ButtonOptionWidget
.static.highlightable
= false;
3495 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
3496 OO
.ui
.ButtonOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3498 if ( this.constructor.static.selectable
) {
3499 this.setActive( state
);
3506 * ButtonSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains
3507 * button options and is used together with
3508 * OO.ui.ButtonOptionWidget. The ButtonSelectWidget provides an interface for
3509 * highlighting, choosing, and selecting mutually exclusive options. Please see
3510 * the [OOUI documentation on MediaWiki] [1] for more information.
3513 * // Example: A ButtonSelectWidget that contains three ButtonOptionWidgets
3514 * var option1 = new OO.ui.ButtonOptionWidget( {
3516 * label: 'Option 1',
3517 * title: 'Button option 1'
3520 * var option2 = new OO.ui.ButtonOptionWidget( {
3522 * label: 'Option 2',
3523 * title: 'Button option 2'
3526 * var option3 = new OO.ui.ButtonOptionWidget( {
3528 * label: 'Option 3',
3529 * title: 'Button option 3'
3532 * var buttonSelect=new OO.ui.ButtonSelectWidget( {
3533 * items: [ option1, option2, option3 ]
3535 * $( 'body' ).append( buttonSelect.$element );
3537 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
3540 * @extends OO.ui.SelectWidget
3541 * @mixins OO.ui.mixin.TabIndexedElement
3544 * @param {Object} [config] Configuration options
3546 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
3547 // Parent constructor
3548 OO
.ui
.ButtonSelectWidget
.parent
.call( this, config
);
3550 // Mixin constructors
3551 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3555 focus
: this.bindDocumentKeyDownListener
.bind( this ),
3556 blur
: this.unbindDocumentKeyDownListener
.bind( this )
3560 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
3565 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
3566 OO
.mixinClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3569 * TabOptionWidget is an item in a {@link OO.ui.TabSelectWidget TabSelectWidget}.
3571 * Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}, which contain
3572 * {@link OO.ui.TabPanelLayout tab panel layouts}. See {@link OO.ui.IndexLayout IndexLayout}
3576 * @extends OO.ui.OptionWidget
3579 * @param {Object} [config] Configuration options
3581 OO
.ui
.TabOptionWidget
= function OoUiTabOptionWidget( config
) {
3582 // Configuration initialization
3583 config
= config
|| {};
3585 // Parent constructor
3586 OO
.ui
.TabOptionWidget
.parent
.call( this, config
);
3590 .addClass( 'oo-ui-tabOptionWidget' )
3591 .attr( 'role', 'tab' );
3596 OO
.inheritClass( OO
.ui
.TabOptionWidget
, OO
.ui
.OptionWidget
);
3598 /* Static Properties */
3604 OO
.ui
.TabOptionWidget
.static.highlightable
= false;
3607 * TabSelectWidget is a list that contains {@link OO.ui.TabOptionWidget tab options}
3609 * **Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}.**
3612 * @extends OO.ui.SelectWidget
3613 * @mixins OO.ui.mixin.TabIndexedElement
3616 * @param {Object} [config] Configuration options
3618 OO
.ui
.TabSelectWidget
= function OoUiTabSelectWidget( config
) {
3619 // Parent constructor
3620 OO
.ui
.TabSelectWidget
.parent
.call( this, config
);
3622 // Mixin constructors
3623 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3627 focus
: this.bindDocumentKeyDownListener
.bind( this ),
3628 blur
: this.unbindDocumentKeyDownListener
.bind( this )
3633 .addClass( 'oo-ui-tabSelectWidget' )
3634 .attr( 'role', 'tablist' );
3639 OO
.inheritClass( OO
.ui
.TabSelectWidget
, OO
.ui
.SelectWidget
);
3640 OO
.mixinClass( OO
.ui
.TabSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3643 * TagItemWidgets are used within a {@link OO.ui.TagMultiselectWidget
3644 * TagMultiselectWidget} to display the selected items.
3647 * @extends OO.ui.Widget
3648 * @mixins OO.ui.mixin.ItemWidget
3649 * @mixins OO.ui.mixin.LabelElement
3650 * @mixins OO.ui.mixin.FlaggedElement
3651 * @mixins OO.ui.mixin.TabIndexedElement
3652 * @mixins OO.ui.mixin.DraggableElement
3655 * @param {Object} [config] Configuration object
3656 * @cfg {boolean} [valid=true] Item is valid
3657 * @cfg {boolean} [fixed] Item is fixed. This means the item is
3658 * always included in the values and cannot be removed.
3660 OO
.ui
.TagItemWidget
= function OoUiTagItemWidget( config
) {
3661 config
= config
|| {};
3663 // Parent constructor
3664 OO
.ui
.TagItemWidget
.parent
.call( this, config
);
3666 // Mixin constructors
3667 OO
.ui
.mixin
.ItemWidget
.call( this );
3668 OO
.ui
.mixin
.LabelElement
.call( this, config
);
3669 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
3670 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3671 OO
.ui
.mixin
.DraggableElement
.call( this, config
);
3673 this.valid
= config
.valid
=== undefined ? true : !!config
.valid
;
3674 this.fixed
= !!config
.fixed
;
3676 this.closeButton
= new OO
.ui
.ButtonWidget( {
3680 title
: OO
.ui
.msg( 'ooui-item-remove' )
3682 this.closeButton
.setDisabled( this.isDisabled() );
3686 .connect( this, { click
: 'remove' } );
3688 .on( 'click', this.select
.bind( this ) )
3689 .on( 'keydown', this.onKeyDown
.bind( this ) )
3690 // Prevent propagation of mousedown; the tag item "lives" in the
3691 // clickable area of the TagMultiselectWidget, which listens to
3692 // mousedown to open the menu or popup. We want to prevent that
3693 // for clicks specifically on the tag itself, so the actions taken
3694 // are more deliberate. When the tag is clicked, it will emit the
3695 // selection event (similar to how #OO.ui.MultioptionWidget emits 'change')
3696 // and can be handled separately.
3697 .on( 'mousedown', function ( e
) { e
.stopPropagation(); } );
3701 .addClass( 'oo-ui-tagItemWidget' )
3702 .append( this.$label
, this.closeButton
.$element
);
3705 /* Initialization */
3707 OO
.inheritClass( OO
.ui
.TagItemWidget
, OO
.ui
.Widget
);
3708 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.ItemWidget
);
3709 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.LabelElement
);
3710 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.FlaggedElement
);
3711 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3712 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.DraggableElement
);
3719 * A remove action was performed on the item
3724 * @param {string} direction Direction of the movement, forward or backwards
3726 * A navigate action was performed on the item
3732 * The tag widget was selected. This can occur when the widget
3733 * is either clicked or enter was pressed on it.
3738 * @param {boolean} isValid Item is valid
3740 * Item validity has changed
3745 * @param {boolean} isFixed Item is fixed
3747 * Item fixed state has changed
3753 * Set this item as fixed, meaning it cannot be removed
3755 * @param {string} [state] Item is fixed
3758 OO
.ui
.TagItemWidget
.prototype.setFixed = function ( state
) {
3759 state
= state
=== undefined ? !this.fixed
: !!state
;
3761 if ( this.fixed
!== state
) {
3763 if ( this.closeButton
) {
3764 this.closeButton
.toggle( !this.fixed
);
3767 if ( !this.fixed
&& this.elementGroup
&& !this.elementGroup
.isDraggable() ) {
3768 // Only enable the state of the item if the
3769 // entire group is draggable
3770 this.toggleDraggable( !this.fixed
);
3772 this.$element
.toggleClass( 'oo-ui-tagItemWidget-fixed', this.fixed
);
3774 this.emit( 'fixed', this.isFixed() );
3780 * Check whether the item is fixed
3782 OO
.ui
.TagItemWidget
.prototype.isFixed = function () {
3789 OO
.ui
.TagItemWidget
.prototype.setDisabled = function ( state
) {
3790 if ( state
&& this.elementGroup
&& !this.elementGroup
.isDisabled() ) {
3791 OO
.ui
.warnDeprecation( 'TagItemWidget#setDisabled: Disabling individual items is deprecated and will result in inconsistent behavior. Use #setFixed instead. See T193571.' );
3794 OO
.ui
.TagItemWidget
.parent
.prototype.setDisabled
.call( this, state
);
3797 // Verify we have a group, and that the widget is ready
3798 this.toggleDraggable
&& this.elementGroup
&&
3800 !this.elementGroup
.isDraggable()
3802 // Only enable the draggable state of the item if the
3803 // entire group is draggable to begin with, and if the
3804 // item is not fixed
3805 this.toggleDraggable( !state
);
3808 if ( this.closeButton
) {
3809 this.closeButton
.setDisabled( state
);
3816 * Handle removal of the item
3818 * This is mainly for extensibility concerns, so other children
3819 * of this class can change the behavior if they need to. This
3820 * is called by both clicking the 'remove' button but also
3821 * on keypress, which is harder to override if needed.
3825 OO
.ui
.TagItemWidget
.prototype.remove = function () {
3826 if ( !this.isDisabled() && !this.isFixed() ) {
3827 this.emit( 'remove' );
3832 * Handle a keydown event on the widget
3836 * @param {jQuery.Event} e Key down event
3837 * @return {boolean|undefined} false to stop the operation
3839 OO
.ui
.TagItemWidget
.prototype.onKeyDown = function ( e
) {
3842 if ( !this.isDisabled() && !this.isFixed() && e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
|| e
.keyCode
=== OO
.ui
.Keys
.DELETE
) {
3845 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ENTER
) {
3849 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
3850 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
3852 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
3866 e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
3867 movement
.left
: movement
.right
3878 OO
.ui
.TagItemWidget
.prototype.select = function () {
3879 if ( !this.isDisabled() ) {
3880 this.emit( 'select' );
3885 * Set the valid state of this item
3887 * @param {boolean} [valid] Item is valid
3890 OO
.ui
.TagItemWidget
.prototype.toggleValid = function ( valid
) {
3891 valid
= valid
=== undefined ? !this.valid
: !!valid
;
3893 if ( this.valid
!== valid
) {
3896 this.setFlags( { invalid
: !this.valid
} );
3898 this.emit( 'valid', this.valid
);
3903 * Check whether the item is valid
3905 * @return {boolean} Item is valid
3907 OO
.ui
.TagItemWidget
.prototype.isValid = function () {
3912 * A basic tag multiselect widget, similar in concept to {@link OO.ui.ComboBoxInputWidget combo box widget}
3913 * that allows the user to add multiple values that are displayed in a tag area.
3915 * This widget is a base widget; see {@link OO.ui.MenuTagMultiselectWidget MenuTagMultiselectWidget} and
3916 * {@link OO.ui.PopupTagMultiselectWidget PopupTagMultiselectWidget} for the implementations that use
3917 * a menu and a popup respectively.
3920 * // Example: A basic TagMultiselectWidget.
3921 * var widget = new OO.ui.TagMultiselectWidget( {
3922 * inputPosition: 'outline',
3923 * allowedValues: [ 'Option 1', 'Option 2', 'Option 3' ],
3924 * selected: [ 'Option 1' ]
3926 * $( 'body' ).append( widget.$element );
3929 * @extends OO.ui.Widget
3930 * @mixins OO.ui.mixin.GroupWidget
3931 * @mixins OO.ui.mixin.DraggableGroupElement
3932 * @mixins OO.ui.mixin.IndicatorElement
3933 * @mixins OO.ui.mixin.IconElement
3934 * @mixins OO.ui.mixin.TabIndexedElement
3935 * @mixins OO.ui.mixin.FlaggedElement
3938 * @param {Object} config Configuration object
3939 * @cfg {Object} [input] Configuration options for the input widget
3940 * @cfg {OO.ui.InputWidget} [inputWidget] An optional input widget. If given, it will
3941 * replace the input widget used in the TagMultiselectWidget. If not given,
3942 * TagMultiselectWidget creates its own.
3943 * @cfg {boolean} [inputPosition='inline'] Position of the input. Options are:
3944 * - inline: The input is invisible, but exists inside the tag list, so
3945 * the user types into the tag groups to add tags.
3946 * - outline: The input is underneath the tag area.
3947 * - none: No input supplied
3948 * @cfg {boolean} [allowEditTags=true] Allow editing of the tags by clicking them
3949 * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if
3950 * not present in the menu.
3951 * @cfg {Object[]} [allowedValues] An array representing the allowed items
3953 * @cfg {boolean} [allowDuplicates=false] Allow duplicate items to be added
3954 * @cfg {boolean} [allowDisplayInvalidTags=false] Allow the display of
3955 * invalid tags. These tags will display with an invalid state, and
3956 * the widget as a whole will have an invalid state if any invalid tags
3958 * @cfg {boolean} [allowReordering=true] Allow reordering of the items
3959 * @cfg {Object[]|String[]} [selected] A set of selected tags. If given,
3960 * these will appear in the tag list on initialization, as long as they
3961 * pass the validity tests.
3963 OO
.ui
.TagMultiselectWidget
= function OoUiTagMultiselectWidget( config
) {
3965 rAF
= window
.requestAnimationFrame
|| setTimeout
,
3967 $tabFocus
= $( '<span>' )
3968 .addClass( 'oo-ui-tagMultiselectWidget-focusTrap' );
3970 config
= config
|| {};
3972 // Parent constructor
3973 OO
.ui
.TagMultiselectWidget
.parent
.call( this, config
);
3975 // Mixin constructors
3976 OO
.ui
.mixin
.GroupWidget
.call( this, config
);
3977 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3978 OO
.ui
.mixin
.IconElement
.call( this, config
);
3979 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3980 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
3981 OO
.ui
.mixin
.DraggableGroupElement
.call( this, config
);
3983 this.toggleDraggable(
3984 config
.allowReordering
=== undefined ?
3985 true : !!config
.allowReordering
3988 this.inputPosition
=
3989 this.constructor.static.allowedInputPositions
.indexOf( config
.inputPosition
) > -1 ?
3990 config
.inputPosition
: 'inline';
3991 this.allowEditTags
= config
.allowEditTags
=== undefined ? true : !!config
.allowEditTags
;
3992 this.allowArbitrary
= !!config
.allowArbitrary
;
3993 this.allowDuplicates
= !!config
.allowDuplicates
;
3994 this.allowedValues
= config
.allowedValues
|| [];
3995 this.allowDisplayInvalidTags
= config
.allowDisplayInvalidTags
;
3996 this.hasInput
= this.inputPosition
!== 'none';
4000 this.$content
= $( '<div>' )
4001 .addClass( 'oo-ui-tagMultiselectWidget-content' );
4002 this.$handle
= $( '<div>' )
4003 .addClass( 'oo-ui-tagMultiselectWidget-handle' )
4010 .addClass( 'oo-ui-tagMultiselectWidget-group' )
4016 remove
: 'itemRemove',
4017 navigate
: 'itemNavigate',
4018 select
: 'itemSelect',
4021 this.connect( this, {
4022 itemRemove
: 'onTagRemove',
4023 itemSelect
: 'onTagSelect',
4024 itemFixed
: 'onTagFixed',
4025 itemNavigate
: 'onTagNavigate',
4026 change
: 'onChangeTags'
4029 mousedown
: this.onMouseDown
.bind( this )
4034 .addClass( 'oo-ui-tagMultiselectWidget' )
4035 .append( this.$handle
);
4037 if ( this.hasInput
) {
4038 if ( config
.inputWidget
) {
4039 this.input
= config
.inputWidget
;
4041 this.input
= new OO
.ui
.TextInputWidget( $.extend( {
4042 placeholder
: config
.placeholder
,
4043 classes
: [ 'oo-ui-tagMultiselectWidget-input' ]
4044 }, config
.input
) );
4046 this.input
.setDisabled( this.isDisabled() );
4049 focus
: this.onInputFocus
.bind( this ),
4050 blur
: this.onInputBlur
.bind( this ),
4051 'propertychange change click mouseup keydown keyup input cut paste select focus':
4052 OO
.ui
.debounce( this.updateInputSize
.bind( this ) ),
4053 keydown
: this.onInputKeyDown
.bind( this ),
4054 keypress
: this.onInputKeyPress
.bind( this )
4057 this.input
.$input
.on( inputEvents
);
4059 if ( this.inputPosition
=== 'outline' ) {
4060 // Override max-height for the input widget
4061 // in the case the widget is outline so it can
4062 // stretch all the way if the widet is wide
4063 this.input
.$element
.css( 'max-width', 'inherit' );
4065 .addClass( 'oo-ui-tagMultiselectWidget-outlined' )
4066 .append( this.input
.$element
);
4068 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-inlined' );
4069 // HACK: When the widget is using 'inline' input, the
4070 // behavior needs to only use the $input itself
4071 // so we style and size it accordingly (otherwise
4072 // the styling and sizing can get very convoluted
4073 // when the wrapping divs and other elements)
4074 // We are taking advantage of still being able to
4075 // call the widget itself for operations like
4076 // .getValue() and setDisabled() and .focus() but
4077 // having only the $input attached to the DOM
4078 this.$content
.append( this.input
.$input
);
4081 this.$content
.append( $tabFocus
);
4084 this.setTabIndexedElement(
4090 if ( config
.selected
) {
4091 this.setValue( config
.selected
);
4094 // HACK: Input size needs to be calculated after everything
4097 if ( widget
.hasInput
) {
4098 widget
.updateInputSize();
4103 /* Initialization */
4105 OO
.inheritClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.Widget
);
4106 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.GroupWidget
);
4107 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.DraggableGroupElement
);
4108 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IndicatorElement
);
4109 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IconElement
);
4110 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
4111 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.FlaggedElement
);
4113 /* Static properties */
4116 * Allowed input positions.
4117 * - inline: The input is inside the tag list
4118 * - outline: The input is under the tag list
4119 * - none: There is no input
4123 OO
.ui
.TagMultiselectWidget
.static.allowedInputPositions
= [ 'inline', 'outline', 'none' ];
4128 * Handle mouse down events.
4131 * @param {jQuery.Event} e Mouse down event
4132 * @return {boolean} False to prevent defaults
4134 OO
.ui
.TagMultiselectWidget
.prototype.onMouseDown = function ( e
) {
4136 !this.isDisabled() &&
4137 ( !this.hasInput
|| e
.target
!== this.input
.$input
[ 0 ] ) &&
4138 e
.which
=== OO
.ui
.MouseButtons
.LEFT
4146 * Handle key press events.
4149 * @param {jQuery.Event} e Key press event
4150 * @return {boolean} Whether to prevent defaults
4152 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyPress = function ( e
) {
4154 withMetaKey
= e
.metaKey
|| e
.ctrlKey
;
4156 if ( !this.isDisabled() ) {
4157 if ( e
.which
=== OO
.ui
.Keys
.ENTER
) {
4158 stopOrContinue
= this.doInputEnter( e
, withMetaKey
);
4161 // Make sure the input gets resized.
4162 setTimeout( this.updateInputSize
.bind( this ), 0 );
4163 return stopOrContinue
;
4168 * Handle key down events.
4171 * @param {jQuery.Event} e Key down event
4174 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyDown = function ( e
) {
4175 var movement
, direction
,
4177 withMetaKey
= e
.metaKey
|| e
.ctrlKey
,
4178 isMovementInsideInput = function ( direction
) {
4179 var inputRange
= widget
.input
.getRange(),
4180 inputValue
= widget
.hasInput
&& widget
.input
.getValue();
4182 if ( direction
=== 'forwards' && inputRange
.to
> inputValue
.length
- 1 ) {
4186 if ( direction
=== 'backwards' && inputRange
.from <= 0 ) {
4193 if ( !this.isDisabled() ) {
4194 // 'keypress' event is not triggered for Backspace
4195 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
) {
4196 return this.doInputBackspace( e
, withMetaKey
);
4197 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ESCAPE
) {
4198 return this.doInputEscape( e
);
4200 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
4201 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
4203 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
4214 direction
= e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
4215 movement
.left
: movement
.right
;
4217 if ( !this.hasInput
|| !isMovementInsideInput( direction
) ) {
4218 return this.doInputArrow( e
, direction
, withMetaKey
);
4225 * Respond to input focus event
4227 OO
.ui
.TagMultiselectWidget
.prototype.onInputFocus = function () {
4228 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-focus' );
4232 * Respond to input blur event
4234 OO
.ui
.TagMultiselectWidget
.prototype.onInputBlur = function () {
4235 this.$element
.removeClass( 'oo-ui-tagMultiselectWidget-focus' );
4239 * Perform an action after the enter key on the input
4241 * @param {jQuery.Event} e Event data
4242 * @param {boolean} [withMetaKey] Whether this key was pressed with
4243 * a meta key like 'ctrl'
4244 * @return {boolean} Whether to prevent defaults
4246 OO
.ui
.TagMultiselectWidget
.prototype.doInputEnter = function () {
4247 this.addTagFromInput();
4252 * Perform an action responding to the enter key on the input
4254 * @param {jQuery.Event} e Event data
4255 * @param {boolean} [withMetaKey] Whether this key was pressed with
4256 * a meta key like 'ctrl'
4257 * @return {boolean} Whether to prevent defaults
4259 OO
.ui
.TagMultiselectWidget
.prototype.doInputBackspace = function ( e
, withMetaKey
) {
4263 this.inputPosition
=== 'inline' &&
4264 this.input
.getValue() === '' &&
4267 // Delete the last item
4268 items
= this.getItems();
4269 item
= items
[ items
.length
- 1 ];
4271 if ( !item
.isDisabled() && !item
.isFixed() ) {
4272 this.removeItems( [ item
] );
4273 // If Ctrl/Cmd was pressed, delete item entirely.
4274 // Otherwise put it into the text field for editing.
4275 if ( !withMetaKey
) {
4276 this.input
.setValue( item
.getData() );
4285 * Perform an action after the escape key on the input
4287 * @param {jQuery.Event} e Event data
4289 OO
.ui
.TagMultiselectWidget
.prototype.doInputEscape = function () {
4294 * Perform an action after the arrow key on the input, select the previous
4295 * item from the input.
4296 * See #getPreviousItem
4298 * @param {jQuery.Event} e Event data
4299 * @param {string} direction Direction of the movement; forwards or backwards
4300 * @param {boolean} [withMetaKey] Whether this key was pressed with
4301 * a meta key like 'ctrl'
4303 OO
.ui
.TagMultiselectWidget
.prototype.doInputArrow = function ( e
, direction
) {
4305 this.inputPosition
=== 'inline' &&
4307 direction
=== 'backwards'
4309 // Get previous item
4310 this.getPreviousItem().focus();
4315 * Respond to item select event
4317 * @param {OO.ui.TagItemWidget} item Selected item
4319 OO
.ui
.TagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
4320 if ( this.hasInput
&& this.allowEditTags
&& !item
.isFixed() ) {
4321 if ( this.input
.getValue() ) {
4322 this.addTagFromInput();
4324 // 1. Get the label of the tag into the input
4325 this.input
.setValue( item
.getData() );
4326 // 2. Remove the tag
4327 this.removeItems( [ item
] );
4328 // 3. Focus the input
4334 * Respond to item fixed state change
4336 * @param {OO.ui.TagItemWidget} item Selected item
4338 OO
.ui
.TagMultiselectWidget
.prototype.onTagFixed = function ( item
) {
4340 items
= this.getItems();
4342 // Move item to the end of the static items
4343 for ( i
= 0; i
< items
.length
; i
++ ) {
4344 if ( items
[ i
] !== item
&& !items
[ i
].isFixed() ) {
4348 this.addItems( item
, i
);
4351 * Respond to change event, where items were added, removed, or cleared.
4353 OO
.ui
.TagMultiselectWidget
.prototype.onChangeTags = function () {
4354 this.toggleValid( this.checkValidity() );
4355 if ( this.hasInput
) {
4356 this.updateInputSize();
4358 this.updateIfHeightChanged();
4364 OO
.ui
.TagMultiselectWidget
.prototype.setDisabled = function ( isDisabled
) {
4366 OO
.ui
.TagMultiselectWidget
.parent
.prototype.setDisabled
.call( this, isDisabled
);
4368 if ( this.hasInput
&& this.input
) {
4369 this.input
.setDisabled( !!isDisabled
);
4373 this.getItems().forEach( function ( item
) {
4374 item
.setDisabled( !!isDisabled
);
4380 * Respond to tag remove event
4381 * @param {OO.ui.TagItemWidget} item Removed tag
4383 OO
.ui
.TagMultiselectWidget
.prototype.onTagRemove = function ( item
) {
4384 this.removeTagByData( item
.getData() );
4388 * Respond to navigate event on the tag
4390 * @param {OO.ui.TagItemWidget} item Removed tag
4391 * @param {string} direction Direction of movement; 'forwards' or 'backwards'
4393 OO
.ui
.TagMultiselectWidget
.prototype.onTagNavigate = function ( item
, direction
) {
4394 var firstItem
= this.getItems()[ 0 ];
4396 if ( direction
=== 'forwards' ) {
4397 this.getNextItem( item
).focus();
4398 } else if ( !this.inputPosition
=== 'inline' || item
!== firstItem
) {
4399 // If the widget has an inline input, we want to stop at the starting edge
4401 this.getPreviousItem( item
).focus();
4406 * Add tag from input value
4408 OO
.ui
.TagMultiselectWidget
.prototype.addTagFromInput = function () {
4409 var val
= this.input
.getValue(),
4410 isValid
= this.isAllowedData( val
);
4416 if ( isValid
|| this.allowDisplayInvalidTags
) {
4426 OO
.ui
.TagMultiselectWidget
.prototype.clearInput = function () {
4427 this.input
.setValue( '' );
4431 * Check whether the given value is a duplicate of an existing
4432 * tag already in the list.
4434 * @param {string|Object} data Requested value
4435 * @return {boolean} Value is duplicate
4437 OO
.ui
.TagMultiselectWidget
.prototype.isDuplicateData = function ( data
) {
4438 return !!this.findItemFromData( data
);
4442 * Check whether a given value is allowed to be added
4444 * @param {string|Object} data Requested value
4445 * @return {boolean} Value is allowed
4447 OO
.ui
.TagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
4449 !this.allowDuplicates
&&
4450 this.isDuplicateData( data
)
4455 if ( this.allowArbitrary
) {
4459 // Check with allowed values
4461 this.getAllowedValues().some( function ( value
) {
4462 return data
=== value
;
4472 * Get the allowed values list
4474 * @return {string[]} Allowed data values
4476 OO
.ui
.TagMultiselectWidget
.prototype.getAllowedValues = function () {
4477 return this.allowedValues
;
4481 * Add a value to the allowed values list
4483 * @param {string} value Allowed data value
4485 OO
.ui
.TagMultiselectWidget
.prototype.addAllowedValue = function ( value
) {
4486 if ( this.allowedValues
.indexOf( value
) === -1 ) {
4487 this.allowedValues
.push( value
);
4492 * Get the datas of the currently selected items
4494 * @return {string[]|Object[]} Datas of currently selected items
4496 OO
.ui
.TagMultiselectWidget
.prototype.getValue = function () {
4497 return this.getItems()
4498 .filter( function ( item
) {
4499 return item
.isValid();
4501 .map( function ( item
) {
4502 return item
.getData();
4507 * Set the value of this widget by datas.
4509 * @param {string|string[]|Object|Object[]} valueObject An object representing the data
4510 * and label of the value. If the widget allows arbitrary values,
4511 * the items will be added as-is. Otherwise, the data value will
4512 * be checked against allowedValues.
4513 * This object must contain at least a data key. Example:
4514 * { data: 'foo', label: 'Foo item' }
4515 * For multiple items, use an array of objects. For example:
4517 * { data: 'foo', label: 'Foo item' },
4518 * { data: 'bar', label: 'Bar item' }
4520 * Value can also be added with plaintext array, for example:
4521 * [ 'foo', 'bar', 'bla' ] or a single string, like 'foo'
4523 OO
.ui
.TagMultiselectWidget
.prototype.setValue = function ( valueObject
) {
4524 valueObject
= Array
.isArray( valueObject
) ? valueObject
: [ valueObject
];
4527 valueObject
.forEach( function ( obj
) {
4528 if ( typeof obj
=== 'string' ) {
4531 this.addTag( obj
.data
, obj
.label
);
4537 * Add tag to the display area
4539 * @param {string|Object} data Tag data
4540 * @param {string} [label] Tag label. If no label is provided, the
4541 * stringified version of the data will be used instead.
4542 * @return {boolean} Item was added successfully
4544 OO
.ui
.TagMultiselectWidget
.prototype.addTag = function ( data
, label
) {
4546 isValid
= this.isAllowedData( data
);
4548 if ( isValid
|| this.allowDisplayInvalidTags
) {
4549 newItemWidget
= this.createTagItemWidget( data
, label
);
4550 newItemWidget
.toggleValid( isValid
);
4551 this.addItems( [ newItemWidget
] );
4558 * Remove tag by its data property.
4560 * @param {string|Object} data Tag data
4562 OO
.ui
.TagMultiselectWidget
.prototype.removeTagByData = function ( data
) {
4563 var item
= this.findItemFromData( data
);
4565 this.removeItems( [ item
] );
4569 * Construct a OO.ui.TagItemWidget (or a subclass thereof) from given label and data.
4572 * @param {string} data Item data
4573 * @param {string} label The label text.
4574 * @return {OO.ui.TagItemWidget}
4576 OO
.ui
.TagMultiselectWidget
.prototype.createTagItemWidget = function ( data
, label
) {
4577 label
= label
|| data
;
4579 return new OO
.ui
.TagItemWidget( { data
: data
, label
: label
} );
4583 * Given an item, returns the item after it. If the item is already the
4584 * last item, return `this.input`. If no item is passed, returns the
4588 * @param {OO.ui.TagItemWidget} [item] Tag item
4589 * @return {OO.ui.Widget} The next widget available.
4591 OO
.ui
.TagMultiselectWidget
.prototype.getNextItem = function ( item
) {
4592 var itemIndex
= this.items
.indexOf( item
);
4594 if ( item
=== undefined || itemIndex
=== -1 ) {
4595 return this.items
[ 0 ];
4598 if ( itemIndex
=== this.items
.length
- 1 ) { // Last item
4599 if ( this.hasInput
) {
4602 // Return first item
4603 return this.items
[ 0 ];
4606 return this.items
[ itemIndex
+ 1 ];
4611 * Given an item, returns the item before it. If the item is already the
4612 * first item, return `this.input`. If no item is passed, returns the
4616 * @param {OO.ui.TagItemWidget} [item] Tag item
4617 * @return {OO.ui.Widget} The previous widget available.
4619 OO
.ui
.TagMultiselectWidget
.prototype.getPreviousItem = function ( item
) {
4620 var itemIndex
= this.items
.indexOf( item
);
4622 if ( item
=== undefined || itemIndex
=== -1 ) {
4623 return this.items
[ this.items
.length
- 1 ];
4626 if ( itemIndex
=== 0 ) {
4627 if ( this.hasInput
) {
4630 // Return the last item
4631 return this.items
[ this.items
.length
- 1 ];
4634 return this.items
[ itemIndex
- 1 ];
4639 * Update the dimensions of the text input field to encompass all available area.
4640 * This is especially relevant for when the input is at the edge of a line
4641 * and should get smaller. The usual operation (as an inline-block with min-width)
4642 * does not work in that case, pushing the input downwards to the next line.
4646 OO
.ui
.TagMultiselectWidget
.prototype.updateInputSize = function () {
4647 var $lastItem
, direction
, contentWidth
, currentWidth
, bestWidth
;
4648 if ( this.inputPosition
=== 'inline' && !this.isDisabled() ) {
4649 if ( this.input
.$input
[ 0 ].scrollWidth
=== 0 ) {
4650 // Input appears to be attached but not visible.
4651 // Don't attempt to adjust its size, because our measurements
4652 // are going to fail anyway.
4655 this.input
.$input
.css( 'width', '1em' );
4656 $lastItem
= this.$group
.children().last();
4657 direction
= OO
.ui
.Element
.static.getDir( this.$handle
);
4659 // Get the width of the input with the placeholder text as
4660 // the value and save it so that we don't keep recalculating
4662 this.contentWidthWithPlaceholder
=== undefined &&
4663 this.input
.getValue() === '' &&
4664 this.input
.$input
.attr( 'placeholder' ) !== undefined
4666 this.input
.setValue( this.input
.$input
.attr( 'placeholder' ) );
4667 this.contentWidthWithPlaceholder
= this.input
.$input
[ 0 ].scrollWidth
;
4668 this.input
.setValue( '' );
4672 // Always keep the input wide enough for the placeholder text
4673 contentWidth
= Math
.max(
4674 this.input
.$input
[ 0 ].scrollWidth
,
4675 // undefined arguments in Math.max lead to NaN
4676 ( this.contentWidthWithPlaceholder
=== undefined ) ?
4677 0 : this.contentWidthWithPlaceholder
4679 currentWidth
= this.input
.$input
.width();
4681 if ( contentWidth
< currentWidth
) {
4682 this.updateIfHeightChanged();
4683 // All is fine, don't perform expensive calculations
4687 if ( $lastItem
.length
=== 0 ) {
4688 bestWidth
= this.$content
.innerWidth();
4690 bestWidth
= direction
=== 'ltr' ?
4691 this.$content
.innerWidth() - $lastItem
.position().left
- $lastItem
.outerWidth() :
4692 $lastItem
.position().left
;
4695 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
4696 // pixels this is off by are coming from.
4698 if ( contentWidth
> bestWidth
) {
4699 // This will result in the input getting shifted to the next line
4700 bestWidth
= this.$content
.innerWidth() - 10;
4702 this.input
.$input
.width( Math
.floor( bestWidth
) );
4703 this.updateIfHeightChanged();
4705 this.updateIfHeightChanged();
4710 * Determine if widget height changed, and if so,
4711 * emit the resize event. This is useful for when there are either
4712 * menus or popups attached to the bottom of the widget, to allow
4713 * them to change their positioning in case the widget moved down
4718 OO
.ui
.TagMultiselectWidget
.prototype.updateIfHeightChanged = function () {
4719 var height
= this.$element
.height();
4720 if ( height
!== this.height
) {
4721 this.height
= height
;
4722 this.emit( 'resize' );
4727 * Check whether all items in the widget are valid
4729 * @return {boolean} Widget is valid
4731 OO
.ui
.TagMultiselectWidget
.prototype.checkValidity = function () {
4732 return this.getItems().every( function ( item
) {
4733 return item
.isValid();
4738 * Set the valid state of this item
4740 * @param {boolean} [valid] Item is valid
4743 OO
.ui
.TagMultiselectWidget
.prototype.toggleValid = function ( valid
) {
4744 valid
= valid
=== undefined ? !this.valid
: !!valid
;
4746 if ( this.valid
!== valid
) {
4749 this.setFlags( { invalid
: !this.valid
} );
4751 this.emit( 'valid', this.valid
);
4756 * Get the current valid state of the widget
4758 * @return {boolean} Widget is valid
4760 OO
.ui
.TagMultiselectWidget
.prototype.isValid = function () {
4765 * PopupTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
4766 * to use a popup. The popup can be configured to have a default input to insert values into the widget.
4769 * // Example: A basic PopupTagMultiselectWidget.
4770 * var widget = new OO.ui.PopupTagMultiselectWidget();
4771 * $( 'body' ).append( widget.$element );
4773 * // Example: A PopupTagMultiselectWidget with an external popup.
4774 * var popupInput = new OO.ui.TextInputWidget(),
4775 * widget = new OO.ui.PopupTagMultiselectWidget( {
4776 * popupInput: popupInput,
4778 * $content: popupInput.$element
4781 * $( 'body' ).append( widget.$element );
4784 * @extends OO.ui.TagMultiselectWidget
4785 * @mixins OO.ui.mixin.PopupElement
4787 * @param {Object} config Configuration object
4788 * @cfg {jQuery} [$overlay] An overlay for the popup.
4789 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
4790 * @cfg {Object} [popup] Configuration options for the popup
4791 * @cfg {OO.ui.InputWidget} [popupInput] An input widget inside the popup that will be
4792 * focused when the popup is opened and will be used as replacement for the
4793 * general input in the widget.
4795 OO
.ui
.PopupTagMultiselectWidget
= function OoUiPopupTagMultiselectWidget( config
) {
4797 defaultConfig
= { popup
: {} };
4799 config
= config
|| {};
4801 // Parent constructor
4802 OO
.ui
.PopupTagMultiselectWidget
.parent
.call( this, $.extend( { inputPosition
: 'none' }, config
) );
4804 this.$overlay
= ( config
.$overlay
=== true ? OO
.ui
.getDefaultOverlay() : config
.$overlay
) || this.$element
;
4806 if ( !config
.popup
) {
4807 // For the default base implementation, we give a popup
4808 // with an input widget inside it. For any other use cases
4809 // the popup needs to be populated externally and the
4810 // event handled to add tags separately and manually
4811 defaultInput
= new OO
.ui
.TextInputWidget();
4813 defaultConfig
.popupInput
= defaultInput
;
4814 defaultConfig
.popup
.$content
= defaultInput
.$element
;
4815 defaultConfig
.popup
.padded
= true;
4817 this.$element
.addClass( 'oo-ui-popupTagMultiselectWidget-defaultPopup' );
4820 // Add overlay, and add that to the autoCloseIgnore
4821 defaultConfig
.popup
.$overlay
= this.$overlay
;
4822 defaultConfig
.popup
.$autoCloseIgnore
= this.hasInput
?
4823 this.input
.$element
.add( this.$overlay
) : this.$overlay
;
4825 // Allow extending any of the above
4826 config
= $.extend( defaultConfig
, config
);
4828 // Mixin constructors
4829 OO
.ui
.mixin
.PopupElement
.call( this, config
);
4831 if ( this.hasInput
) {
4832 this.input
.$input
.on( 'focus', this.popup
.toggle
.bind( this.popup
, true ) );
4835 // Configuration options
4836 this.popupInput
= config
.popupInput
;
4837 if ( this.popupInput
) {
4838 this.popupInput
.connect( this, {
4839 enter
: 'onPopupInputEnter'
4844 this.on( 'resize', this.popup
.updateDimensions
.bind( this.popup
) );
4845 this.popup
.connect( this, { toggle
: 'onPopupToggle' } );
4847 .on( 'focus', this.onFocus
.bind( this ) );
4851 .append( this.popup
.$element
)
4852 .addClass( 'oo-ui-popupTagMultiselectWidget' );
4855 /* Initialization */
4857 OO
.inheritClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
4858 OO
.mixinClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.mixin
.PopupElement
);
4863 * Focus event handler.
4867 OO
.ui
.PopupTagMultiselectWidget
.prototype.onFocus = function () {
4868 this.popup
.toggle( true );
4872 * Respond to popup toggle event
4874 * @param {boolean} isVisible Popup is visible
4876 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupToggle = function ( isVisible
) {
4877 if ( isVisible
&& this.popupInput
) {
4878 this.popupInput
.focus();
4883 * Respond to popup input enter event
4885 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupInputEnter = function () {
4886 if ( this.popupInput
) {
4887 this.addTagByPopupValue( this.popupInput
.getValue() );
4888 this.popupInput
.setValue( '' );
4895 OO
.ui
.PopupTagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
4896 if ( this.popupInput
&& this.allowEditTags
) {
4897 this.popupInput
.setValue( item
.getData() );
4898 this.removeItems( [ item
] );
4900 this.popup
.toggle( true );
4901 this.popupInput
.focus();
4904 OO
.ui
.PopupTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, item
);
4909 * Add a tag by the popup value.
4910 * Whatever is responsible for setting the value in the popup should call
4911 * this method to add a tag, or use the regular methods like #addTag or
4912 * #setValue directly.
4914 * @param {string} data The value of item
4915 * @param {string} [label] The label of the tag. If not given, the data is used.
4917 OO
.ui
.PopupTagMultiselectWidget
.prototype.addTagByPopupValue = function ( data
, label
) {
4918 this.addTag( data
, label
);
4922 * MenuTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
4923 * to use a menu of selectable options.
4926 * // Example: A basic MenuTagMultiselectWidget.
4927 * var widget = new OO.ui.MenuTagMultiselectWidget( {
4928 * inputPosition: 'outline',
4930 * { data: 'option1', label: 'Option 1', icon: 'tag' },
4931 * { data: 'option2', label: 'Option 2' },
4932 * { data: 'option3', label: 'Option 3' },
4934 * selected: [ 'option1', 'option2' ]
4936 * $( 'body' ).append( widget.$element );
4939 * @extends OO.ui.TagMultiselectWidget
4942 * @param {Object} [config] Configuration object
4943 * @cfg {boolean} [clearInputOnChoose=true] Clear the text input value when a menu option is chosen
4944 * @cfg {Object} [menu] Configuration object for the menu widget
4945 * @cfg {jQuery} [$overlay] An overlay for the menu.
4946 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
4947 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
4949 OO
.ui
.MenuTagMultiselectWidget
= function OoUiMenuTagMultiselectWidget( config
) {
4950 config
= config
|| {};
4952 // Parent constructor
4953 OO
.ui
.MenuTagMultiselectWidget
.parent
.call( this, config
);
4955 this.$overlay
= ( config
.$overlay
=== true ? OO
.ui
.getDefaultOverlay() : config
.$overlay
) || this.$element
;
4956 this.clearInputOnChoose
= config
.clearInputOnChoose
=== undefined || !!config
.clearInputOnChoose
;
4957 this.menu
= this.createMenuWidget( $.extend( {
4959 input
: this.hasInput
? this.input
: null,
4960 $input
: this.hasInput
? this.input
.$input
: null,
4961 filterFromInput
: !!this.hasInput
,
4962 $autoCloseIgnore
: this.hasInput
?
4963 this.input
.$element
: $( [] ),
4964 $floatableContainer
: this.hasInput
&& this.inputPosition
=== 'outline' ?
4965 this.input
.$element
: this.$element
,
4966 $overlay
: this.$overlay
,
4967 disabled
: this.isDisabled()
4969 this.addOptions( config
.options
|| [] );
4972 this.menu
.connect( this, {
4973 choose
: 'onMenuChoose',
4974 toggle
: 'onMenuToggle'
4976 if ( this.hasInput
) {
4977 this.input
.connect( this, { change
: 'onInputChange' } );
4979 this.connect( this, { resize
: 'onResize' } );
4983 .append( this.menu
.$element
);
4985 .addClass( 'oo-ui-menuTagMultiselectWidget' );
4986 // TagMultiselectWidget already does this, but it doesn't work right because this.menu is not yet
4987 // set up while the parent constructor runs, and #getAllowedValues rejects everything.
4988 if ( config
.selected
) {
4989 this.setValue( config
.selected
);
4993 /* Initialization */
4995 OO
.inheritClass( OO
.ui
.MenuTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
5000 * Respond to resize event
5002 OO
.ui
.MenuTagMultiselectWidget
.prototype.onResize = function () {
5003 // Reposition the menu
5004 this.menu
.position();
5010 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputFocus = function () {
5012 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
5014 this.menu
.toggle( true );
5018 * Respond to input change event
5020 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputChange = function () {
5021 this.menu
.toggle( true );
5022 this.initializeMenuSelection();
5026 * Respond to menu choose event
5028 * @param {OO.ui.OptionWidget} menuItem Chosen menu item
5030 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuChoose = function ( menuItem
) {
5032 this.addTag( menuItem
.getData(), menuItem
.getLabel() );
5033 if ( this.hasInput
&& this.clearInputOnChoose
) {
5034 this.input
.setValue( '' );
5039 * Respond to menu toggle event. Reset item highlights on hide.
5041 * @param {boolean} isVisible The menu is visible
5043 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
5045 this.menu
.selectItem( null );
5046 this.menu
.highlightItem( null );
5048 this.initializeMenuSelection();
5055 OO
.ui
.MenuTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
5056 var menuItem
= this.menu
.findItemFromData( tagItem
.getData() );
5057 if ( !this.allowArbitrary
) {
5058 // Override the base behavior from TagMultiselectWidget; the base behavior
5059 // in TagMultiselectWidget is to remove the tag to edit it in the input,
5060 // but in our case, we want to utilize the menu selection behavior, and
5061 // definitely not remove the item.
5063 // If there is an input that is used for filtering, erase the value so we don't filter
5064 if ( this.hasInput
&& this.menu
.filterFromInput
) {
5065 this.input
.setValue( '' );
5068 // Select the menu item
5069 this.menu
.selectItem( menuItem
);
5074 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, tagItem
);
5081 OO
.ui
.MenuTagMultiselectWidget
.prototype.setDisabled = function ( isDisabled
) {
5083 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.setDisabled
.call( this, isDisabled
);
5086 // Protect against calling setDisabled() before the menu was initialized
5087 this.menu
.setDisabled( isDisabled
);
5092 * Highlight the first selectable item in the menu, if configured.
5097 OO
.ui
.MenuTagMultiselectWidget
.prototype.initializeMenuSelection = function () {
5098 if ( !this.menu
.findSelectedItem() ) {
5099 this.menu
.highlightItem( this.menu
.findFirstSelectableItem() );
5106 OO
.ui
.MenuTagMultiselectWidget
.prototype.addTagFromInput = function () {
5107 var inputValue
= this.input
.getValue(),
5109 highlightedItem
= this.menu
.findHighlightedItem(),
5110 item
= this.menu
.findItemFromData( inputValue
);
5112 if ( !inputValue
) {
5116 // Override the parent method so we add from the menu
5117 // rather than directly from the input
5119 // Look for a highlighted item first
5120 if ( highlightedItem
) {
5121 validated
= this.addTag( highlightedItem
.getData(), highlightedItem
.getLabel() );
5122 } else if ( item
) {
5123 // Look for the element that fits the data
5124 validated
= this.addTag( item
.getData(), item
.getLabel() );
5126 // Otherwise, add the tag - the method will only add if the
5127 // tag is valid or if invalid tags are allowed
5128 validated
= this.addTag( inputValue
);
5138 * Return the visible items in the menu. This is mainly used for when
5139 * the menu is filtering results.
5141 * @return {OO.ui.MenuOptionWidget[]} Visible results
5143 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenuVisibleItems = function () {
5144 return this.menu
.getItems().filter( function ( menuItem
) {
5145 return menuItem
.isVisible();
5150 * Create the menu for this widget. This is in a separate method so that
5151 * child classes can override this without polluting the constructor with
5152 * unnecessary extra objects that will be overidden.
5154 * @param {Object} menuConfig Configuration options
5155 * @return {OO.ui.MenuSelectWidget} Menu widget
5157 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
5158 return new OO
.ui
.MenuSelectWidget( menuConfig
);
5162 * Add options to the menu
5164 * @param {Object[]} menuOptions Object defining options
5166 OO
.ui
.MenuTagMultiselectWidget
.prototype.addOptions = function ( menuOptions
) {
5168 items
= menuOptions
.map( function ( obj
) {
5169 return widget
.createMenuOptionWidget( obj
.data
, obj
.label
, obj
.icon
);
5172 this.menu
.addItems( items
);
5176 * Create a menu option widget.
5178 * @param {string} data Item data
5179 * @param {string} [label] Item label
5180 * @param {string} [icon] Symbolic icon name
5181 * @return {OO.ui.OptionWidget} Option widget
5183 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuOptionWidget = function ( data
, label
, icon
) {
5184 return new OO
.ui
.MenuOptionWidget( {
5186 label
: label
|| data
,
5194 * @return {OO.ui.MenuSelectWidget} Menu
5196 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenu = function () {
5201 * Get the allowed values list
5203 * @return {string[]} Allowed data values
5205 OO
.ui
.MenuTagMultiselectWidget
.prototype.getAllowedValues = function () {
5208 // If the parent constructor is calling us, we're not ready yet, this.menu is not set up.
5209 menuDatas
= this.menu
.getItems().map( function ( menuItem
) {
5210 return menuItem
.getData();
5213 return this.allowedValues
.concat( menuDatas
);
5217 * SelectFileWidgets allow for selecting files, using the HTML5 File API. These
5218 * widgets can be configured with {@link OO.ui.mixin.IconElement icons} and {@link
5219 * OO.ui.mixin.IndicatorElement indicators}.
5220 * Please see the [OOUI documentation on MediaWiki] [1] for more information and examples.
5223 * // Example of a file select widget
5224 * var selectFile = new OO.ui.SelectFileWidget();
5225 * $( 'body' ).append( selectFile.$element );
5227 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets
5230 * @extends OO.ui.Widget
5231 * @mixins OO.ui.mixin.IconElement
5232 * @mixins OO.ui.mixin.IndicatorElement
5233 * @mixins OO.ui.mixin.PendingElement
5234 * @mixins OO.ui.mixin.LabelElement
5237 * @param {Object} [config] Configuration options
5238 * @cfg {string[]|null} [accept=null] MIME types to accept. null accepts all types.
5239 * @cfg {string} [placeholder] Text to display when no file is selected.
5240 * @cfg {string} [notsupported] Text to display when file support is missing in the browser.
5241 * @cfg {boolean} [droppable=true] Whether to accept files by drag and drop.
5242 * @cfg {boolean} [showDropTarget=false] Whether to show a drop target. Requires droppable to be true.
5243 * @cfg {number} [thumbnailSizeLimit=20] File size limit in MiB above which to not try and show a
5244 * preview (for performance)
5246 OO
.ui
.SelectFileWidget
= function OoUiSelectFileWidget( config
) {
5249 // Configuration initialization
5250 config
= $.extend( {
5252 placeholder
: OO
.ui
.msg( 'ooui-selectfile-placeholder' ),
5253 notsupported
: OO
.ui
.msg( 'ooui-selectfile-not-supported' ),
5255 showDropTarget
: false,
5256 thumbnailSizeLimit
: 20
5259 // Parent constructor
5260 OO
.ui
.SelectFileWidget
.parent
.call( this, config
);
5262 // Mixin constructors
5263 OO
.ui
.mixin
.IconElement
.call( this, config
);
5264 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
5265 OO
.ui
.mixin
.PendingElement
.call( this, $.extend( {}, config
, { $pending
: this.$info
} ) );
5266 OO
.ui
.mixin
.LabelElement
.call( this, config
);
5269 this.$info
= $( '<span>' );
5270 this.showDropTarget
= config
.showDropTarget
;
5271 this.thumbnailSizeLimit
= config
.thumbnailSizeLimit
;
5272 this.isSupported
= this.constructor.static.isSupported();
5273 this.currentFile
= null;
5274 if ( Array
.isArray( config
.accept
) ) {
5275 this.accept
= config
.accept
;
5279 this.placeholder
= config
.placeholder
;
5280 this.notsupported
= config
.notsupported
;
5281 this.onFileSelectedHandler
= this.onFileSelected
.bind( this );
5283 this.selectButton
= new OO
.ui
.ButtonWidget( {
5284 $element
: $( '<label>' ),
5285 classes
: [ 'oo-ui-selectFileWidget-selectButton' ],
5286 label
: OO
.ui
.msg( 'ooui-selectfile-button-select' ),
5287 disabled
: this.disabled
|| !this.isSupported
5290 this.clearButton
= new OO
.ui
.ButtonWidget( {
5291 classes
: [ 'oo-ui-selectFileWidget-clearButton' ],
5294 disabled
: this.disabled
5298 this.selectButton
.$button
.on( {
5299 keypress
: this.onKeyPress
.bind( this )
5301 this.clearButton
.connect( this, {
5302 click
: 'onClearClick'
5304 if ( config
.droppable
) {
5305 dragHandler
= this.onDragEnterOrOver
.bind( this );
5307 dragenter
: dragHandler
,
5308 dragover
: dragHandler
,
5309 dragleave
: this.onDragLeave
.bind( this ),
5310 drop
: this.onDrop
.bind( this )
5316 this.$label
.addClass( 'oo-ui-selectFileWidget-label' );
5318 .addClass( 'oo-ui-selectFileWidget-info' )
5319 .append( this.$icon
, this.$label
, this.clearButton
.$element
, this.$indicator
);
5321 if ( config
.droppable
&& config
.showDropTarget
) {
5322 this.selectButton
.setIcon( 'upload' );
5323 this.$thumbnail
= $( '<div>' ).addClass( 'oo-ui-selectFileWidget-thumbnail' );
5324 this.setPendingElement( this.$thumbnail
);
5326 .addClass( 'oo-ui-selectFileWidget-dropTarget oo-ui-selectFileWidget' )
5328 click
: this.onDropTargetClick
.bind( this )
5333 this.selectButton
.$element
,
5335 .addClass( 'oo-ui-selectFileWidget-dropLabel' )
5336 .text( OO
.ui
.msg( 'ooui-selectfile-dragdrop-placeholder' ) )
5340 .addClass( 'oo-ui-selectFileWidget' )
5341 .append( this.$info
, this.selectButton
.$element
);
5348 OO
.inheritClass( OO
.ui
.SelectFileWidget
, OO
.ui
.Widget
);
5349 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IconElement
);
5350 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IndicatorElement
);
5351 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.PendingElement
);
5352 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.LabelElement
);
5354 /* Static Properties */
5357 * Check if this widget is supported
5362 OO
.ui
.SelectFileWidget
.static.isSupported = function () {
5364 if ( OO
.ui
.SelectFileWidget
.static.isSupportedCache
=== null ) {
5365 $input
= $( '<input>' ).attr( 'type', 'file' );
5366 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= $input
[ 0 ].files
!== undefined;
5368 return OO
.ui
.SelectFileWidget
.static.isSupportedCache
;
5371 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= null;
5378 * A change event is emitted when the on/off state of the toggle changes.
5380 * @param {File|null} value New value
5386 * Get the current value of the field
5388 * @return {File|null}
5390 OO
.ui
.SelectFileWidget
.prototype.getValue = function () {
5391 return this.currentFile
;
5395 * Set the current value of the field
5397 * @param {File|null} file File to select
5399 OO
.ui
.SelectFileWidget
.prototype.setValue = function ( file
) {
5400 if ( this.currentFile
!== file
) {
5401 this.currentFile
= file
;
5403 this.emit( 'change', this.currentFile
);
5410 * Focusses the select file button.
5414 OO
.ui
.SelectFileWidget
.prototype.focus = function () {
5415 this.selectButton
.focus();
5424 OO
.ui
.SelectFileWidget
.prototype.blur = function () {
5425 this.selectButton
.blur();
5432 OO
.ui
.SelectFileWidget
.prototype.simulateLabelClick = function () {
5437 * Update the user interface when a file is selected or unselected
5441 OO
.ui
.SelectFileWidget
.prototype.updateUI = function () {
5443 if ( !this.isSupported
) {
5444 this.$element
.addClass( 'oo-ui-selectFileWidget-notsupported' );
5445 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
5446 this.setLabel( this.notsupported
);
5448 this.$element
.addClass( 'oo-ui-selectFileWidget-supported' );
5449 if ( this.currentFile
) {
5450 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
5452 $label
= $label
.add(
5454 .addClass( 'oo-ui-selectFileWidget-fileName' )
5455 .text( this.currentFile
.name
)
5457 this.setLabel( $label
);
5459 if ( this.showDropTarget
) {
5461 this.loadAndGetImageUrl().done( function ( url
) {
5462 this.$thumbnail
.css( 'background-image', 'url( ' + url
+ ' )' );
5463 }.bind( this ) ).fail( function () {
5464 this.$thumbnail
.append(
5465 new OO
.ui
.IconWidget( {
5467 classes
: [ 'oo-ui-selectFileWidget-noThumbnail-icon' ]
5470 }.bind( this ) ).always( function () {
5473 this.$element
.off( 'click' );
5476 if ( this.showDropTarget
) {
5477 this.$element
.off( 'click' );
5479 click
: this.onDropTargetClick
.bind( this )
5483 .css( 'background-image', '' );
5485 this.$element
.addClass( 'oo-ui-selectFileWidget-empty' );
5486 this.setLabel( this.placeholder
);
5492 * If the selected file is an image, get its URL and load it.
5494 * @return {jQuery.Promise} Promise resolves with the image URL after it has loaded
5496 OO
.ui
.SelectFileWidget
.prototype.loadAndGetImageUrl = function () {
5497 var deferred
= $.Deferred(),
5498 file
= this.currentFile
,
5499 reader
= new FileReader();
5503 ( OO
.getProp( file
, 'type' ) || '' ).indexOf( 'image/' ) === 0 &&
5504 file
.size
< this.thumbnailSizeLimit
* 1024 * 1024
5506 reader
.onload = function ( event
) {
5507 var img
= document
.createElement( 'img' );
5508 img
.addEventListener( 'load', function () {
5510 img
.naturalWidth
=== 0 ||
5511 img
.naturalHeight
=== 0 ||
5512 img
.complete
=== false
5516 deferred
.resolve( event
.target
.result
);
5519 img
.src
= event
.target
.result
;
5521 reader
.readAsDataURL( file
);
5526 return deferred
.promise();
5530 * Add the input to the widget
5534 OO
.ui
.SelectFileWidget
.prototype.addInput = function () {
5535 if ( this.$input
) {
5536 this.$input
.remove();
5539 if ( !this.isSupported
) {
5544 this.$input
= $( '<input>' ).attr( 'type', 'file' );
5545 this.$input
.on( 'change', this.onFileSelectedHandler
);
5546 this.$input
.on( 'click', function ( e
) {
5547 // Prevents dropTarget to get clicked which calls
5548 // a click on this input
5549 e
.stopPropagation();
5554 if ( this.accept
) {
5555 this.$input
.attr( 'accept', this.accept
.join( ', ' ) );
5557 this.selectButton
.$button
.append( this.$input
);
5561 * Determine if we should accept this file
5564 * @param {string} mimeType File MIME type
5567 OO
.ui
.SelectFileWidget
.prototype.isAllowedType = function ( mimeType
) {
5570 if ( !this.accept
|| !mimeType
) {
5574 for ( i
= 0; i
< this.accept
.length
; i
++ ) {
5575 mimeTest
= this.accept
[ i
];
5576 if ( mimeTest
=== mimeType
) {
5578 } else if ( mimeTest
.substr( -2 ) === '/*' ) {
5579 mimeTest
= mimeTest
.substr( 0, mimeTest
.length
- 1 );
5580 if ( mimeType
.substr( 0, mimeTest
.length
) === mimeTest
) {
5590 * Handle file selection from the input
5593 * @param {jQuery.Event} e
5595 OO
.ui
.SelectFileWidget
.prototype.onFileSelected = function ( e
) {
5596 var file
= OO
.getProp( e
.target
, 'files', 0 ) || null;
5598 if ( file
&& !this.isAllowedType( file
.type
) ) {
5602 this.setValue( file
);
5607 * Handle clear button click events.
5611 OO
.ui
.SelectFileWidget
.prototype.onClearClick = function () {
5612 this.setValue( null );
5617 * Handle key press events.
5620 * @param {jQuery.Event} e Key press event
5622 OO
.ui
.SelectFileWidget
.prototype.onKeyPress = function ( e
) {
5623 if ( this.isSupported
&& !this.isDisabled() && this.$input
&&
5624 ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
5626 this.$input
.click();
5632 * Handle drop target click events.
5635 * @param {jQuery.Event} e Key press event
5637 OO
.ui
.SelectFileWidget
.prototype.onDropTargetClick = function () {
5638 if ( this.isSupported
&& !this.isDisabled() && this.$input
) {
5639 this.$input
.click();
5645 * Handle drag enter and over events
5648 * @param {jQuery.Event} e Drag event
5650 OO
.ui
.SelectFileWidget
.prototype.onDragEnterOrOver = function ( e
) {
5652 droppableFile
= false,
5653 dt
= e
.originalEvent
.dataTransfer
;
5656 e
.stopPropagation();
5658 if ( this.isDisabled() || !this.isSupported
) {
5659 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
5660 dt
.dropEffect
= 'none';
5664 // DataTransferItem and File both have a type property, but in Chrome files
5665 // have no information at this point.
5666 itemOrFile
= OO
.getProp( dt
, 'items', 0 ) || OO
.getProp( dt
, 'files', 0 );
5668 if ( this.isAllowedType( itemOrFile
.type
) ) {
5669 droppableFile
= true;
5671 // dt.types is Array-like, but not an Array
5672 } else if ( Array
.prototype.indexOf
.call( OO
.getProp( dt
, 'types' ) || [], 'Files' ) !== -1 ) {
5673 // File information is not available at this point for security so just assume
5674 // it is acceptable for now.
5675 // https://bugzilla.mozilla.org/show_bug.cgi?id=640534
5676 droppableFile
= true;
5679 this.$element
.toggleClass( 'oo-ui-selectFileWidget-canDrop', droppableFile
);
5680 if ( !droppableFile
) {
5681 dt
.dropEffect
= 'none';
5688 * Handle drag leave events
5691 * @param {jQuery.Event} e Drag event
5693 OO
.ui
.SelectFileWidget
.prototype.onDragLeave = function () {
5694 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
5698 * Handle drop events
5701 * @param {jQuery.Event} e Drop event
5703 OO
.ui
.SelectFileWidget
.prototype.onDrop = function ( e
) {
5705 dt
= e
.originalEvent
.dataTransfer
;
5708 e
.stopPropagation();
5709 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
5711 if ( this.isDisabled() || !this.isSupported
) {
5715 file
= OO
.getProp( dt
, 'files', 0 );
5716 if ( file
&& !this.isAllowedType( file
.type
) ) {
5720 this.setValue( file
);
5729 OO
.ui
.SelectFileWidget
.prototype.setDisabled = function ( disabled
) {
5730 OO
.ui
.SelectFileWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
5731 if ( this.selectButton
) {
5732 this.selectButton
.setDisabled( disabled
);
5734 if ( this.clearButton
) {
5735 this.clearButton
.setDisabled( disabled
);
5741 * SearchWidgets combine a {@link OO.ui.TextInputWidget text input field}, where users can type a search query,
5742 * and a menu of search results, which is displayed beneath the query
5743 * field. Unlike {@link OO.ui.mixin.LookupElement lookup menus}, search result menus are always visible to the user.
5744 * Users can choose an item from the menu or type a query into the text field to search for a matching result item.
5745 * In general, search widgets are used inside a separate {@link OO.ui.Dialog dialog} window.
5747 * Each time the query is changed, the search result menu is cleared and repopulated. Please see
5748 * the [OOUI demos][1] for an example.
5750 * [1]: https://doc.wikimedia.org/oojs-ui/master/demos/#SearchInputWidget-type-search
5753 * @extends OO.ui.Widget
5756 * @param {Object} [config] Configuration options
5757 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
5758 * @cfg {string} [value] Initial query value
5760 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
5761 // Configuration initialization
5762 config
= config
|| {};
5764 // Parent constructor
5765 OO
.ui
.SearchWidget
.parent
.call( this, config
);
5768 this.query
= new OO
.ui
.TextInputWidget( {
5770 placeholder
: config
.placeholder
,
5773 this.results
= new OO
.ui
.SelectWidget();
5774 this.$query
= $( '<div>' );
5775 this.$results
= $( '<div>' );
5778 this.query
.connect( this, {
5779 change
: 'onQueryChange',
5780 enter
: 'onQueryEnter'
5782 this.query
.$input
.on( 'keydown', this.onQueryKeydown
.bind( this ) );
5786 .addClass( 'oo-ui-searchWidget-query' )
5787 .append( this.query
.$element
);
5789 .addClass( 'oo-ui-searchWidget-results' )
5790 .append( this.results
.$element
);
5792 .addClass( 'oo-ui-searchWidget' )
5793 .append( this.$results
, this.$query
);
5798 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
5803 * Handle query key down events.
5806 * @param {jQuery.Event} e Key down event
5808 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
5809 var highlightedItem
, nextItem
,
5810 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
5813 highlightedItem
= this.results
.findHighlightedItem();
5814 if ( !highlightedItem
) {
5815 highlightedItem
= this.results
.findSelectedItem();
5817 nextItem
= this.results
.findRelativeSelectableItem( highlightedItem
, dir
);
5818 this.results
.highlightItem( nextItem
);
5819 nextItem
.scrollElementIntoView();
5824 * Handle select widget select events.
5826 * Clears existing results. Subclasses should repopulate items according to new query.
5829 * @param {string} value New value
5831 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
5833 this.results
.clearItems();
5837 * Handle select widget enter key events.
5839 * Chooses highlighted item.
5842 * @param {string} value New value
5844 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
5845 var highlightedItem
= this.results
.findHighlightedItem();
5846 if ( highlightedItem
) {
5847 this.results
.chooseItem( highlightedItem
);
5852 * Get the query input.
5854 * @return {OO.ui.TextInputWidget} Query input
5856 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
5861 * Get the search results menu.
5863 * @return {OO.ui.SelectWidget} Menu of search results
5865 OO
.ui
.SearchWidget
.prototype.getResults = function () {
5866 return this.results
;
5871 //# sourceMappingURL=oojs-ui-widgets.js.map.json