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-04T00:42:40Z
16 * DraggableElement is a mixin class used to create elements that can be clicked
17 * and dragged by a mouse to a new position within a group. This class must be used
18 * in conjunction with OO.ui.mixin.DraggableGroupElement, which provides a container for
19 * the draggable elements.
25 * @param {Object} [config] Configuration options
26 * @cfg {jQuery} [$handle] The part of the element which can be used for dragging, defaults to the whole element
27 * @cfg {boolean} [draggable] The items are draggable. This can change with #toggleDraggable
28 * but the draggable state should be called from the DraggableGroupElement, which updates
31 OO
.ui
.mixin
.DraggableElement
= function OoUiMixinDraggableElement( config
) {
32 config
= config
|| {};
36 this.$handle
= config
.$handle
|| this.$element
;
37 this.wasHandleUsed
= null;
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.
1541 * var menuLayout = new OO.ui.MenuLayout( {
1544 * menuPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1545 * contentPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1546 * select = new OO.ui.SelectWidget( {
1548 * new OO.ui.OptionWidget( {
1552 * new OO.ui.OptionWidget( {
1556 * new OO.ui.OptionWidget( {
1560 * new OO.ui.OptionWidget( {
1565 * } ).on( 'select', function ( item ) {
1566 * menuLayout.setMenuPosition( item.getData() );
1569 * menuLayout.$menu.append(
1570 * menuPanel.$element.append( '<b>Menu panel</b>', select.$element )
1572 * menuLayout.$content.append(
1573 * contentPanel.$element.append( '<b>Content panel</b>', '<p>Note that the menu is positioned relative to the content panel: top, bottom, after, before.</p>')
1575 * $( 'body' ).append( menuLayout.$element );
1577 * If menu size needs to be overridden, it can be accomplished using CSS similar to the snippet
1578 * below. MenuLayout's CSS will override the appropriate values with 'auto' or '0' to display the
1579 * menu correctly. If `menuPosition` is known beforehand, CSS rules corresponding to other positions
1582 * .oo-ui-menuLayout-menu {
1586 * .oo-ui-menuLayout-content {
1594 * @extends OO.ui.Layout
1597 * @param {Object} [config] Configuration options
1598 * @cfg {boolean} [expanded=true] Expand the layout to fill the entire parent element.
1599 * @cfg {boolean} [showMenu=true] Show menu
1600 * @cfg {string} [menuPosition='before'] Position of menu: `top`, `after`, `bottom` or `before`
1602 OO
.ui
.MenuLayout
= function OoUiMenuLayout( config
) {
1603 // Configuration initialization
1604 config
= $.extend( {
1607 menuPosition
: 'before'
1610 // Parent constructor
1611 OO
.ui
.MenuLayout
.parent
.call( this, config
);
1613 this.expanded
= !!config
.expanded
;
1617 * @property {jQuery}
1619 this.$menu
= $( '<div>' );
1623 * @property {jQuery}
1625 this.$content
= $( '<div>' );
1629 .addClass( 'oo-ui-menuLayout-menu' );
1630 this.$content
.addClass( 'oo-ui-menuLayout-content' );
1632 .addClass( 'oo-ui-menuLayout' );
1633 if ( config
.expanded
) {
1634 this.$element
.addClass( 'oo-ui-menuLayout-expanded' );
1636 this.$element
.addClass( 'oo-ui-menuLayout-static' );
1638 this.setMenuPosition( config
.menuPosition
);
1639 this.toggleMenu( config
.showMenu
);
1644 OO
.inheritClass( OO
.ui
.MenuLayout
, OO
.ui
.Layout
);
1651 * @param {boolean} showMenu Show menu, omit to toggle
1654 OO
.ui
.MenuLayout
.prototype.toggleMenu = function ( showMenu
) {
1655 showMenu
= showMenu
=== undefined ? !this.showMenu
: !!showMenu
;
1657 if ( this.showMenu
!== showMenu
) {
1658 this.showMenu
= showMenu
;
1660 .toggleClass( 'oo-ui-menuLayout-showMenu', this.showMenu
)
1661 .toggleClass( 'oo-ui-menuLayout-hideMenu', !this.showMenu
);
1662 this.$menu
.attr( 'aria-hidden', this.showMenu
? 'false' : 'true' );
1669 * Check if menu is visible
1671 * @return {boolean} Menu is visible
1673 OO
.ui
.MenuLayout
.prototype.isMenuVisible = function () {
1674 return this.showMenu
;
1678 * Set menu position.
1680 * @param {string} position Position of menu, either `top`, `after`, `bottom` or `before`
1681 * @throws {Error} If position value is not supported
1684 OO
.ui
.MenuLayout
.prototype.setMenuPosition = function ( position
) {
1685 this.$element
.removeClass( 'oo-ui-menuLayout-' + this.menuPosition
);
1686 this.menuPosition
= position
;
1687 if ( this.menuPosition
=== 'top' || this.menuPosition
=== 'before' ) {
1688 this.$element
.append( this.$menu
, this.$content
);
1690 this.$element
.append( this.$content
, this.$menu
);
1692 this.$element
.addClass( 'oo-ui-menuLayout-' + position
);
1698 * Get menu position.
1700 * @return {string} Menu position
1702 OO
.ui
.MenuLayout
.prototype.getMenuPosition = function () {
1703 return this.menuPosition
;
1707 * BookletLayouts contain {@link OO.ui.PageLayout page layouts} as well as
1708 * an {@link OO.ui.OutlineSelectWidget outline} that allows users to easily navigate
1709 * through the pages and select which one to display. By default, only one page is
1710 * displayed at a time and the outline is hidden. When a user navigates to a new page,
1711 * the booklet layout automatically focuses on the first focusable element, unless the
1712 * default setting is changed. Optionally, booklets can be configured to show
1713 * {@link OO.ui.OutlineControlsWidget controls} for adding, moving, and removing items.
1716 * // Example of a BookletLayout that contains two PageLayouts.
1718 * function PageOneLayout( name, config ) {
1719 * PageOneLayout.parent.call( this, name, config );
1720 * this.$element.append( '<p>First page</p><p>(This booklet has an outline, displayed on the left)</p>' );
1722 * OO.inheritClass( PageOneLayout, OO.ui.PageLayout );
1723 * PageOneLayout.prototype.setupOutlineItem = function () {
1724 * this.outlineItem.setLabel( 'Page One' );
1727 * function PageTwoLayout( name, config ) {
1728 * PageTwoLayout.parent.call( this, name, config );
1729 * this.$element.append( '<p>Second page</p>' );
1731 * OO.inheritClass( PageTwoLayout, OO.ui.PageLayout );
1732 * PageTwoLayout.prototype.setupOutlineItem = function () {
1733 * this.outlineItem.setLabel( 'Page Two' );
1736 * var page1 = new PageOneLayout( 'one' ),
1737 * page2 = new PageTwoLayout( 'two' );
1739 * var booklet = new OO.ui.BookletLayout( {
1743 * booklet.addPages ( [ page1, page2 ] );
1744 * $( 'body' ).append( booklet.$element );
1747 * @extends OO.ui.MenuLayout
1750 * @param {Object} [config] Configuration options
1751 * @cfg {boolean} [continuous=false] Show all pages, one after another
1752 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new page is displayed. Disabled on mobile.
1753 * @cfg {boolean} [outlined=false] Show the outline. The outline is used to navigate through the pages of the booklet.
1754 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
1756 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
1757 // Configuration initialization
1758 config
= config
|| {};
1760 // Parent constructor
1761 OO
.ui
.BookletLayout
.parent
.call( this, config
);
1764 this.currentPageName
= null;
1766 this.ignoreFocus
= false;
1767 this.stackLayout
= new OO
.ui
.StackLayout( {
1768 continuous
: !!config
.continuous
,
1769 expanded
: this.expanded
1771 this.$content
.append( this.stackLayout
.$element
);
1772 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
1773 this.outlineVisible
= false;
1774 this.outlined
= !!config
.outlined
;
1775 if ( this.outlined
) {
1776 this.editable
= !!config
.editable
;
1777 this.outlineControlsWidget
= null;
1778 this.outlineSelectWidget
= new OO
.ui
.OutlineSelectWidget();
1779 this.outlinePanel
= new OO
.ui
.PanelLayout( {
1780 expanded
: this.expanded
,
1783 this.$menu
.append( this.outlinePanel
.$element
);
1784 this.outlineVisible
= true;
1785 if ( this.editable
) {
1786 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
1787 this.outlineSelectWidget
1791 this.toggleMenu( this.outlined
);
1794 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
1795 if ( this.outlined
) {
1796 this.outlineSelectWidget
.connect( this, { select
: 'onOutlineSelectWidgetSelect' } );
1797 this.scrolling
= false;
1798 this.stackLayout
.connect( this, { visibleItemChange
: 'onStackLayoutVisibleItemChange' } );
1800 if ( this.autoFocus
) {
1801 // Event 'focus' does not bubble, but 'focusin' does
1802 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
1806 this.$element
.addClass( 'oo-ui-bookletLayout' );
1807 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
1808 if ( this.outlined
) {
1809 this.outlinePanel
.$element
1810 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
1811 .append( this.outlineSelectWidget
.$element
);
1812 if ( this.editable
) {
1813 this.outlinePanel
.$element
1814 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
1815 .append( this.outlineControlsWidget
.$element
);
1822 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.MenuLayout
);
1827 * A 'set' event is emitted when a page is {@link #setPage set} to be displayed by the booklet layout.
1829 * @param {OO.ui.PageLayout} page Current page
1833 * An 'add' event is emitted when pages are {@link #addPages added} to the booklet layout.
1836 * @param {OO.ui.PageLayout[]} page Added pages
1837 * @param {number} index Index pages were added at
1841 * A 'remove' event is emitted when pages are {@link #clearPages cleared} or
1842 * {@link #removePages removed} from the booklet.
1845 * @param {OO.ui.PageLayout[]} pages Removed pages
1851 * Handle stack layout focus.
1854 * @param {jQuery.Event} e Focusin event
1856 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
1859 // Find the page that an element was focused within
1860 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
1861 for ( name
in this.pages
) {
1862 // Check for page match, exclude current page to find only page changes
1863 if ( this.pages
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentPageName
) {
1864 this.setPage( name
);
1871 * Handle visibleItemChange events from the stackLayout
1873 * The next visible page is set as the current page by selecting it
1876 * @param {OO.ui.PageLayout} page The next visible page in the layout
1878 OO
.ui
.BookletLayout
.prototype.onStackLayoutVisibleItemChange = function ( page
) {
1879 // Set a flag to so that the resulting call to #onStackLayoutSet doesn't
1880 // try and scroll the item into view again.
1881 this.scrolling
= true;
1882 this.outlineSelectWidget
.selectItemByData( page
.getName() );
1883 this.scrolling
= false;
1887 * Handle stack layout set events.
1890 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
1892 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
1893 var promise
, layout
= this;
1894 // If everything is unselected, do nothing
1898 // For continuous BookletLayouts, scroll the selected page into view first
1899 if ( this.stackLayout
.continuous
&& !this.scrolling
) {
1900 promise
= page
.scrollElementIntoView();
1902 promise
= $.Deferred().resolve();
1904 // Focus the first element on the newly selected panel.
1905 // Don't focus if the page was set by scrolling.
1906 if ( this.autoFocus
&& !OO
.ui
.isMobile() && !this.scrolling
) {
1907 promise
.done( function () {
1914 * Focus the first input in the current page.
1916 * If no page is selected, the first selectable page will be selected.
1917 * If the focus is already in an element on the current page, nothing will happen.
1919 * @param {number} [itemIndex] A specific item to focus on
1921 OO
.ui
.BookletLayout
.prototype.focus = function ( itemIndex
) {
1923 items
= this.stackLayout
.getItems();
1925 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
1926 page
= items
[ itemIndex
];
1928 page
= this.stackLayout
.getCurrentItem();
1931 if ( !page
&& this.outlined
) {
1932 this.selectFirstSelectablePage();
1933 page
= this.stackLayout
.getCurrentItem();
1938 // Only change the focus if is not already in the current page
1939 if ( !OO
.ui
.contains( page
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
1945 * Find the first focusable input in the booklet layout and focus
1948 OO
.ui
.BookletLayout
.prototype.focusFirstFocusable = function () {
1949 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
1953 * Handle outline widget select events.
1956 * @param {OO.ui.OptionWidget|null} item Selected item
1958 OO
.ui
.BookletLayout
.prototype.onOutlineSelectWidgetSelect = function ( item
) {
1960 this.setPage( item
.getData() );
1965 * Check if booklet has an outline.
1967 * @return {boolean} Booklet has an outline
1969 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
1970 return this.outlined
;
1974 * Check if booklet has editing controls.
1976 * @return {boolean} Booklet is editable
1978 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
1979 return this.editable
;
1983 * Check if booklet has a visible outline.
1985 * @return {boolean} Outline is visible
1987 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
1988 return this.outlined
&& this.outlineVisible
;
1992 * Hide or show the outline.
1994 * @param {boolean} [show] Show outline, omit to invert current state
1997 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
2000 if ( this.outlined
) {
2001 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
2002 this.outlineVisible
= show
;
2003 this.toggleMenu( show
);
2004 if ( show
&& this.editable
) {
2005 // HACK: Kill dumb scrollbars when the sidebar stops animating, see T161798. Only necessary when
2006 // outline controls are present, delay matches transition on `.oo-ui-menuLayout-menu`.
2007 setTimeout( function () {
2008 OO
.ui
.Element
.static.reconsiderScrollbars( booklet
.outlinePanel
.$element
[ 0 ] );
2017 * Find the page closest to the specified page.
2019 * @param {OO.ui.PageLayout} page Page to use as a reference point
2020 * @return {OO.ui.PageLayout|null} Page closest to the specified page
2022 OO
.ui
.BookletLayout
.prototype.findClosestPage = function ( page
) {
2023 var next
, prev
, level
,
2024 pages
= this.stackLayout
.getItems(),
2025 index
= pages
.indexOf( page
);
2027 if ( index
!== -1 ) {
2028 next
= pages
[ index
+ 1 ];
2029 prev
= pages
[ index
- 1 ];
2030 // Prefer adjacent pages at the same level
2031 if ( this.outlined
) {
2032 level
= this.outlineSelectWidget
.findItemFromData( page
.getName() ).getLevel();
2035 level
=== this.outlineSelectWidget
.findItemFromData( prev
.getName() ).getLevel()
2041 level
=== this.outlineSelectWidget
.findItemFromData( next
.getName() ).getLevel()
2047 return prev
|| next
|| null;
2051 * Get the outline widget.
2053 * If the booklet is not outlined, the method will return `null`.
2055 * @return {OO.ui.OutlineSelectWidget|null} Outline widget, or null if the booklet is not outlined
2057 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
2058 return this.outlineSelectWidget
;
2062 * Get the outline controls widget.
2064 * If the outline is not editable, the method will return `null`.
2066 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
2068 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
2069 return this.outlineControlsWidget
;
2073 * Get a page by its symbolic name.
2075 * @param {string} name Symbolic name of page
2076 * @return {OO.ui.PageLayout|undefined} Page, if found
2078 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
2079 return this.pages
[ name
];
2083 * Get the current page.
2085 * @return {OO.ui.PageLayout|undefined} Current page, if found
2087 OO
.ui
.BookletLayout
.prototype.getCurrentPage = function () {
2088 var name
= this.getCurrentPageName();
2089 return name
? this.getPage( name
) : undefined;
2093 * Get the symbolic name of the current page.
2095 * @return {string|null} Symbolic name of the current page
2097 OO
.ui
.BookletLayout
.prototype.getCurrentPageName = function () {
2098 return this.currentPageName
;
2102 * Add pages to the booklet layout
2104 * When pages are added with the same names as existing pages, the existing pages will be
2105 * automatically removed before the new pages are added.
2107 * @param {OO.ui.PageLayout[]} pages Pages to add
2108 * @param {number} index Index of the insertion point
2112 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
2113 var i
, len
, name
, page
, item
, currentIndex
,
2114 stackLayoutPages
= this.stackLayout
.getItems(),
2118 // Remove pages with same names
2119 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2121 name
= page
.getName();
2123 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
2124 // Correct the insertion index
2125 currentIndex
= stackLayoutPages
.indexOf( this.pages
[ name
] );
2126 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2129 remove
.push( this.pages
[ name
] );
2132 if ( remove
.length
) {
2133 this.removePages( remove
);
2137 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2139 name
= page
.getName();
2140 this.pages
[ page
.getName() ] = page
;
2141 if ( this.outlined
) {
2142 item
= new OO
.ui
.OutlineOptionWidget( { data
: name
} );
2143 page
.setOutlineItem( item
);
2148 if ( this.outlined
&& items
.length
) {
2149 this.outlineSelectWidget
.addItems( items
, index
);
2150 this.selectFirstSelectablePage();
2152 this.stackLayout
.addItems( pages
, index
);
2153 this.emit( 'add', pages
, index
);
2159 * Remove the specified pages from the booklet layout.
2161 * To remove all pages from the booklet, you may wish to use the #clearPages method instead.
2163 * @param {OO.ui.PageLayout[]} pages An array of pages to remove
2167 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
2168 var i
, len
, name
, page
,
2171 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2173 name
= page
.getName();
2174 delete this.pages
[ name
];
2175 if ( this.outlined
) {
2176 items
.push( this.outlineSelectWidget
.findItemFromData( name
) );
2177 page
.setOutlineItem( null );
2180 if ( this.outlined
&& items
.length
) {
2181 this.outlineSelectWidget
.removeItems( items
);
2182 this.selectFirstSelectablePage();
2184 this.stackLayout
.removeItems( pages
);
2185 this.emit( 'remove', pages
);
2191 * Clear all pages from the booklet layout.
2193 * To remove only a subset of pages from the booklet, use the #removePages method.
2198 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
2200 pages
= this.stackLayout
.getItems();
2203 this.currentPageName
= null;
2204 if ( this.outlined
) {
2205 this.outlineSelectWidget
.clearItems();
2206 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2207 pages
[ i
].setOutlineItem( null );
2210 this.stackLayout
.clearItems();
2212 this.emit( 'remove', pages
);
2218 * Set the current page by symbolic name.
2221 * @param {string} name Symbolic name of page
2223 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
2226 page
= this.pages
[ name
],
2227 previousPage
= this.currentPageName
&& this.pages
[ this.currentPageName
];
2229 if ( name
!== this.currentPageName
) {
2230 if ( this.outlined
) {
2231 selectedItem
= this.outlineSelectWidget
.findSelectedItem();
2232 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2233 this.outlineSelectWidget
.selectItemByData( name
);
2237 if ( previousPage
) {
2238 previousPage
.setActive( false );
2239 // Blur anything focused if the next page doesn't have anything focusable.
2240 // This is not needed if the next page has something focusable (because once it is focused
2241 // this blur happens automatically). If the layout is non-continuous, this check is
2242 // meaningless because the next page is not visible yet and thus can't hold focus.
2245 !OO
.ui
.isMobile() &&
2246 this.stackLayout
.continuous
&&
2247 OO
.ui
.findFocusable( page
.$element
).length
!== 0
2249 $focused
= previousPage
.$element
.find( ':focus' );
2250 if ( $focused
.length
) {
2251 $focused
[ 0 ].blur();
2255 this.currentPageName
= name
;
2256 page
.setActive( true );
2257 this.stackLayout
.setItem( page
);
2258 if ( !this.stackLayout
.continuous
&& previousPage
) {
2259 // This should not be necessary, since any inputs on the previous page should have been
2260 // blurred when it was hidden, but browsers are not very consistent about this.
2261 $focused
= previousPage
.$element
.find( ':focus' );
2262 if ( $focused
.length
) {
2263 $focused
[ 0 ].blur();
2266 this.emit( 'set', page
);
2272 * Select the first selectable page.
2276 OO
.ui
.BookletLayout
.prototype.selectFirstSelectablePage = function () {
2277 if ( !this.outlineSelectWidget
.findSelectedItem() ) {
2278 this.outlineSelectWidget
.selectItem( this.outlineSelectWidget
.findFirstSelectableItem() );
2285 * IndexLayouts contain {@link OO.ui.TabPanelLayout tab panel layouts} as well as
2286 * {@link OO.ui.TabSelectWidget tabs} that allow users to easily navigate through the tab panels and
2287 * select which one to display. By default, only one tab panel is displayed at a time. When a user
2288 * navigates to a new tab panel, the index layout automatically focuses on the first focusable element,
2289 * unless the default setting is changed.
2291 * TODO: This class is similar to BookletLayout, we may want to refactor to reduce duplication
2294 * // Example of a IndexLayout that contains two TabPanelLayouts.
2296 * function TabPanelOneLayout( name, config ) {
2297 * TabPanelOneLayout.parent.call( this, name, config );
2298 * this.$element.append( '<p>First tab panel</p>' );
2300 * OO.inheritClass( TabPanelOneLayout, OO.ui.TabPanelLayout );
2301 * TabPanelOneLayout.prototype.setupTabItem = function () {
2302 * this.tabItem.setLabel( 'Tab panel one' );
2305 * var tabPanel1 = new TabPanelOneLayout( 'one' ),
2306 * tabPanel2 = new OO.ui.TabPanelLayout( 'two', { label: 'Tab panel two' } );
2308 * tabPanel2.$element.append( '<p>Second tab panel</p>' );
2310 * var index = new OO.ui.IndexLayout();
2312 * index.addTabPanels ( [ tabPanel1, tabPanel2 ] );
2313 * $( 'body' ).append( index.$element );
2316 * @extends OO.ui.MenuLayout
2319 * @param {Object} [config] Configuration options
2320 * @cfg {boolean} [continuous=false] Show all tab panels, one after another
2321 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new tab panel is displayed. Disabled on mobile.
2323 OO
.ui
.IndexLayout
= function OoUiIndexLayout( config
) {
2324 // Configuration initialization
2325 config
= $.extend( {}, config
, { menuPosition
: 'top' } );
2327 // Parent constructor
2328 OO
.ui
.IndexLayout
.parent
.call( this, config
);
2331 this.currentTabPanelName
= null;
2332 this.tabPanels
= {};
2334 this.ignoreFocus
= false;
2335 this.stackLayout
= new OO
.ui
.StackLayout( {
2336 continuous
: !!config
.continuous
,
2337 expanded
: this.expanded
2339 this.$content
.append( this.stackLayout
.$element
);
2340 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
2342 this.tabSelectWidget
= new OO
.ui
.TabSelectWidget();
2343 this.tabPanel
= new OO
.ui
.PanelLayout( {
2344 expanded
: this.expanded
2346 this.$menu
.append( this.tabPanel
.$element
);
2348 this.toggleMenu( true );
2351 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
2352 this.tabSelectWidget
.connect( this, { select
: 'onTabSelectWidgetSelect' } );
2353 if ( this.autoFocus
) {
2354 // Event 'focus' does not bubble, but 'focusin' does
2355 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
2359 this.$element
.addClass( 'oo-ui-indexLayout' );
2360 this.stackLayout
.$element
.addClass( 'oo-ui-indexLayout-stackLayout' );
2361 this.tabPanel
.$element
2362 .addClass( 'oo-ui-indexLayout-tabPanel' )
2363 .append( this.tabSelectWidget
.$element
);
2368 OO
.inheritClass( OO
.ui
.IndexLayout
, OO
.ui
.MenuLayout
);
2373 * A 'set' event is emitted when a tab panel is {@link #setTabPanel set} to be displayed by the index layout.
2375 * @param {OO.ui.TabPanelLayout} tabPanel Current tab panel
2379 * An 'add' event is emitted when tab panels are {@link #addTabPanels added} to the index layout.
2382 * @param {OO.ui.TabPanelLayout[]} tabPanel Added tab panels
2383 * @param {number} index Index tab panels were added at
2387 * A 'remove' event is emitted when tab panels are {@link #clearTabPanels cleared} or
2388 * {@link #removeTabPanels removed} from the index.
2391 * @param {OO.ui.TabPanelLayout[]} tabPanel Removed tab panels
2397 * Handle stack layout focus.
2400 * @param {jQuery.Event} e Focusing event
2402 OO
.ui
.IndexLayout
.prototype.onStackLayoutFocus = function ( e
) {
2405 // Find the tab panel that an element was focused within
2406 $target
= $( e
.target
).closest( '.oo-ui-tabPanelLayout' );
2407 for ( name
in this.tabPanels
) {
2408 // Check for tab panel match, exclude current tab panel to find only tab panel changes
2409 if ( this.tabPanels
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentTabPanelName
) {
2410 this.setTabPanel( name
);
2417 * Handle stack layout set events.
2420 * @param {OO.ui.PanelLayout|null} tabPanel The tab panel that is now the current panel
2422 OO
.ui
.IndexLayout
.prototype.onStackLayoutSet = function ( tabPanel
) {
2423 // If everything is unselected, do nothing
2427 // Focus the first element on the newly selected panel
2428 if ( this.autoFocus
&& !OO
.ui
.isMobile() ) {
2434 * Focus the first input in the current tab panel.
2436 * If no tab panel is selected, the first selectable tab panel will be selected.
2437 * If the focus is already in an element on the current tab panel, nothing will happen.
2439 * @param {number} [itemIndex] A specific item to focus on
2441 OO
.ui
.IndexLayout
.prototype.focus = function ( itemIndex
) {
2443 items
= this.stackLayout
.getItems();
2445 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
2446 tabPanel
= items
[ itemIndex
];
2448 tabPanel
= this.stackLayout
.getCurrentItem();
2452 this.selectFirstSelectableTabPanel();
2453 tabPanel
= this.stackLayout
.getCurrentItem();
2458 // Only change the focus if is not already in the current page
2459 if ( !OO
.ui
.contains( tabPanel
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
2465 * Find the first focusable input in the index layout and focus
2468 OO
.ui
.IndexLayout
.prototype.focusFirstFocusable = function () {
2469 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
2473 * Handle tab widget select events.
2476 * @param {OO.ui.OptionWidget|null} item Selected item
2478 OO
.ui
.IndexLayout
.prototype.onTabSelectWidgetSelect = function ( item
) {
2480 this.setTabPanel( item
.getData() );
2485 * Get the tab panel closest to the specified tab panel.
2487 * @param {OO.ui.TabPanelLayout} tabPanel Tab panel to use as a reference point
2488 * @return {OO.ui.TabPanelLayout|null} Tab panel closest to the specified
2490 OO
.ui
.IndexLayout
.prototype.getClosestTabPanel = function ( tabPanel
) {
2491 var next
, prev
, level
,
2492 tabPanels
= this.stackLayout
.getItems(),
2493 index
= tabPanels
.indexOf( tabPanel
);
2495 if ( index
!== -1 ) {
2496 next
= tabPanels
[ index
+ 1 ];
2497 prev
= tabPanels
[ index
- 1 ];
2498 // Prefer adjacent tab panels at the same level
2499 level
= this.tabSelectWidget
.findItemFromData( tabPanel
.getName() ).getLevel();
2502 level
=== this.tabSelectWidget
.findItemFromData( prev
.getName() ).getLevel()
2508 level
=== this.tabSelectWidget
.findItemFromData( next
.getName() ).getLevel()
2513 return prev
|| next
|| null;
2517 * Get the tabs widget.
2519 * @return {OO.ui.TabSelectWidget} Tabs widget
2521 OO
.ui
.IndexLayout
.prototype.getTabs = function () {
2522 return this.tabSelectWidget
;
2526 * Get a tab panel by its symbolic name.
2528 * @param {string} name Symbolic name of tab panel
2529 * @return {OO.ui.TabPanelLayout|undefined} Tab panel, if found
2531 OO
.ui
.IndexLayout
.prototype.getTabPanel = function ( name
) {
2532 return this.tabPanels
[ name
];
2536 * Get the current tab panel.
2538 * @return {OO.ui.TabPanelLayout|undefined} Current tab panel, if found
2540 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanel = function () {
2541 var name
= this.getCurrentTabPanelName();
2542 return name
? this.getTabPanel( name
) : undefined;
2546 * Get the symbolic name of the current tab panel.
2548 * @return {string|null} Symbolic name of the current tab panel
2550 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanelName = function () {
2551 return this.currentTabPanelName
;
2555 * Add tab panels to the index layout
2557 * When tab panels are added with the same names as existing tab panels, the existing tab panels
2558 * will be automatically removed before the new tab panels are added.
2560 * @param {OO.ui.TabPanelLayout[]} tabPanels Tab panels to add
2561 * @param {number} index Index of the insertion point
2565 OO
.ui
.IndexLayout
.prototype.addTabPanels = function ( tabPanels
, index
) {
2566 var i
, len
, name
, tabPanel
, item
, currentIndex
,
2567 stackLayoutTabPanels
= this.stackLayout
.getItems(),
2571 // Remove tab panels with same names
2572 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2573 tabPanel
= tabPanels
[ i
];
2574 name
= tabPanel
.getName();
2576 if ( Object
.prototype.hasOwnProperty
.call( this.tabPanels
, name
) ) {
2577 // Correct the insertion index
2578 currentIndex
= stackLayoutTabPanels
.indexOf( this.tabPanels
[ name
] );
2579 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2582 remove
.push( this.tabPanels
[ name
] );
2585 if ( remove
.length
) {
2586 this.removeTabPanels( remove
);
2589 // Add new tab panels
2590 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2591 tabPanel
= tabPanels
[ i
];
2592 name
= tabPanel
.getName();
2593 this.tabPanels
[ tabPanel
.getName() ] = tabPanel
;
2594 item
= new OO
.ui
.TabOptionWidget( { data
: name
} );
2595 tabPanel
.setTabItem( item
);
2599 if ( items
.length
) {
2600 this.tabSelectWidget
.addItems( items
, index
);
2601 this.selectFirstSelectableTabPanel();
2603 this.stackLayout
.addItems( tabPanels
, index
);
2604 this.emit( 'add', tabPanels
, index
);
2610 * Remove the specified tab panels from the index layout.
2612 * To remove all tab panels from the index, you may wish to use the #clearTabPanels method instead.
2614 * @param {OO.ui.TabPanelLayout[]} tabPanels An array of tab panels to remove
2618 OO
.ui
.IndexLayout
.prototype.removeTabPanels = function ( tabPanels
) {
2619 var i
, len
, name
, tabPanel
,
2622 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2623 tabPanel
= tabPanels
[ i
];
2624 name
= tabPanel
.getName();
2625 delete this.tabPanels
[ name
];
2626 items
.push( this.tabSelectWidget
.findItemFromData( name
) );
2627 tabPanel
.setTabItem( null );
2629 if ( items
.length
) {
2630 this.tabSelectWidget
.removeItems( items
);
2631 this.selectFirstSelectableTabPanel();
2633 this.stackLayout
.removeItems( tabPanels
);
2634 this.emit( 'remove', tabPanels
);
2640 * Clear all tab panels from the index layout.
2642 * To remove only a subset of tab panels from the index, use the #removeTabPanels method.
2647 OO
.ui
.IndexLayout
.prototype.clearTabPanels = function () {
2649 tabPanels
= this.stackLayout
.getItems();
2651 this.tabPanels
= {};
2652 this.currentTabPanelName
= null;
2653 this.tabSelectWidget
.clearItems();
2654 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2655 tabPanels
[ i
].setTabItem( null );
2657 this.stackLayout
.clearItems();
2659 this.emit( 'remove', tabPanels
);
2665 * Set the current tab panel by symbolic name.
2668 * @param {string} name Symbolic name of tab panel
2670 OO
.ui
.IndexLayout
.prototype.setTabPanel = function ( name
) {
2673 tabPanel
= this.tabPanels
[ name
],
2674 previousTabPanel
= this.currentTabPanelName
&& this.tabPanels
[ this.currentTabPanelName
];
2676 if ( name
!== this.currentTabPanelName
) {
2677 selectedItem
= this.tabSelectWidget
.findSelectedItem();
2678 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2679 this.tabSelectWidget
.selectItemByData( name
);
2682 if ( previousTabPanel
) {
2683 previousTabPanel
.setActive( false );
2684 // Blur anything focused if the next tab panel doesn't have anything focusable.
2685 // This is not needed if the next tab panel has something focusable (because once it is focused
2686 // this blur happens automatically). If the layout is non-continuous, this check is
2687 // meaningless because the next tab panel is not visible yet and thus can't hold focus.
2690 !OO
.ui
.isMobile() &&
2691 this.stackLayout
.continuous
&&
2692 OO
.ui
.findFocusable( tabPanel
.$element
).length
!== 0
2694 $focused
= previousTabPanel
.$element
.find( ':focus' );
2695 if ( $focused
.length
) {
2696 $focused
[ 0 ].blur();
2700 this.currentTabPanelName
= name
;
2701 tabPanel
.setActive( true );
2702 this.stackLayout
.setItem( tabPanel
);
2703 if ( !this.stackLayout
.continuous
&& previousTabPanel
) {
2704 // This should not be necessary, since any inputs on the previous tab panel should have been
2705 // blurred when it was hidden, but browsers are not very consistent about this.
2706 $focused
= previousTabPanel
.$element
.find( ':focus' );
2707 if ( $focused
.length
) {
2708 $focused
[ 0 ].blur();
2711 this.emit( 'set', tabPanel
);
2717 * Select the first selectable tab panel.
2721 OO
.ui
.IndexLayout
.prototype.selectFirstSelectableTabPanel = function () {
2722 if ( !this.tabSelectWidget
.findSelectedItem() ) {
2723 this.tabSelectWidget
.selectItem( this.tabSelectWidget
.findFirstSelectableItem() );
2730 * ToggleWidget implements basic behavior of widgets with an on/off state.
2731 * Please see OO.ui.ToggleButtonWidget and OO.ui.ToggleSwitchWidget for examples.
2735 * @extends OO.ui.Widget
2738 * @param {Object} [config] Configuration options
2739 * @cfg {boolean} [value=false] The toggle’s initial on/off state.
2740 * By default, the toggle is in the 'off' state.
2742 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
2743 // Configuration initialization
2744 config
= config
|| {};
2746 // Parent constructor
2747 OO
.ui
.ToggleWidget
.parent
.call( this, config
);
2753 this.$element
.addClass( 'oo-ui-toggleWidget' );
2754 this.setValue( !!config
.value
);
2759 OO
.inheritClass( OO
.ui
.ToggleWidget
, OO
.ui
.Widget
);
2766 * A change event is emitted when the on/off state of the toggle changes.
2768 * @param {boolean} value Value representing the new state of the toggle
2774 * Get the value representing the toggle’s state.
2776 * @return {boolean} The on/off state of the toggle
2778 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
2783 * Set the state of the toggle: `true` for 'on', `false` for 'off'.
2785 * @param {boolean} value The state of the toggle
2789 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
2791 if ( this.value
!== value
) {
2793 this.emit( 'change', value
);
2794 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
2795 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
2801 * ToggleButtons are buttons that have a state (‘on’ or ‘off’) that is represented by a
2802 * Boolean value. Like other {@link OO.ui.ButtonWidget buttons}, toggle buttons can be
2803 * configured with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators},
2804 * {@link OO.ui.mixin.TitledElement titles}, {@link OO.ui.mixin.FlaggedElement styling flags},
2805 * and {@link OO.ui.mixin.LabelElement labels}. Please see
2806 * the [OOUI documentation][1] on MediaWiki for more information.
2809 * // Toggle buttons in the 'off' and 'on' state.
2810 * var toggleButton1 = new OO.ui.ToggleButtonWidget( {
2811 * label: 'Toggle Button off'
2813 * var toggleButton2 = new OO.ui.ToggleButtonWidget( {
2814 * label: 'Toggle Button on',
2817 * // Append the buttons to the DOM.
2818 * $( 'body' ).append( toggleButton1.$element, toggleButton2.$element );
2820 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Buttons_and_Switches#Toggle_buttons
2823 * @extends OO.ui.ToggleWidget
2824 * @mixins OO.ui.mixin.ButtonElement
2825 * @mixins OO.ui.mixin.IconElement
2826 * @mixins OO.ui.mixin.IndicatorElement
2827 * @mixins OO.ui.mixin.LabelElement
2828 * @mixins OO.ui.mixin.TitledElement
2829 * @mixins OO.ui.mixin.FlaggedElement
2830 * @mixins OO.ui.mixin.TabIndexedElement
2833 * @param {Object} [config] Configuration options
2834 * @cfg {boolean} [value=false] The toggle button’s initial on/off
2835 * state. By default, the button is in the 'off' state.
2837 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
2838 // Configuration initialization
2839 config
= config
|| {};
2841 // Parent constructor
2842 OO
.ui
.ToggleButtonWidget
.parent
.call( this, config
);
2844 // Mixin constructors
2845 OO
.ui
.mixin
.ButtonElement
.call( this, $.extend( {}, config
, { active
: this.active
} ) );
2846 OO
.ui
.mixin
.IconElement
.call( this, config
);
2847 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
2848 OO
.ui
.mixin
.LabelElement
.call( this, config
);
2849 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
2850 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
2851 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$button
} ) );
2854 this.connect( this, { click
: 'onAction' } );
2857 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
2859 .addClass( 'oo-ui-toggleButtonWidget' )
2860 .append( this.$button
);
2865 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
2866 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.ButtonElement
);
2867 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IconElement
);
2868 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IndicatorElement
);
2869 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.LabelElement
);
2870 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TitledElement
);
2871 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.FlaggedElement
);
2872 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TabIndexedElement
);
2874 /* Static Properties */
2880 OO
.ui
.ToggleButtonWidget
.static.tagName
= 'span';
2885 * Handle the button action being triggered.
2889 OO
.ui
.ToggleButtonWidget
.prototype.onAction = function () {
2890 this.setValue( !this.value
);
2896 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
2898 if ( value
!== this.value
) {
2899 // Might be called from parent constructor before ButtonElement constructor
2900 if ( this.$button
) {
2901 this.$button
.attr( 'aria-pressed', value
.toString() );
2903 this.setActive( value
);
2907 OO
.ui
.ToggleButtonWidget
.parent
.prototype.setValue
.call( this, value
);
2915 OO
.ui
.ToggleButtonWidget
.prototype.setButtonElement = function ( $button
) {
2916 if ( this.$button
) {
2917 this.$button
.removeAttr( 'aria-pressed' );
2919 OO
.ui
.mixin
.ButtonElement
.prototype.setButtonElement
.call( this, $button
);
2920 this.$button
.attr( 'aria-pressed', this.value
.toString() );
2924 * ToggleSwitches are switches that slide on and off. Their state is represented by a Boolean
2925 * value (`true` for ‘on’, and `false` otherwise, the default). The ‘off’ state is represented
2926 * visually by a slider in the leftmost position.
2929 * // Toggle switches in the 'off' and 'on' position.
2930 * var toggleSwitch1 = new OO.ui.ToggleSwitchWidget();
2931 * var toggleSwitch2 = new OO.ui.ToggleSwitchWidget( {
2935 * // Create a FieldsetLayout to layout and label switches
2936 * var fieldset = new OO.ui.FieldsetLayout( {
2937 * label: 'Toggle switches'
2939 * fieldset.addItems( [
2940 * new OO.ui.FieldLayout( toggleSwitch1, { label: 'Off', align: 'top' } ),
2941 * new OO.ui.FieldLayout( toggleSwitch2, { label: 'On', align: 'top' } )
2943 * $( 'body' ).append( fieldset.$element );
2946 * @extends OO.ui.ToggleWidget
2947 * @mixins OO.ui.mixin.TabIndexedElement
2950 * @param {Object} [config] Configuration options
2951 * @cfg {boolean} [value=false] The toggle switch’s initial on/off state.
2952 * By default, the toggle switch is in the 'off' position.
2954 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
2955 // Parent constructor
2956 OO
.ui
.ToggleSwitchWidget
.parent
.call( this, config
);
2958 // Mixin constructors
2959 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
2962 this.dragging
= false;
2963 this.dragStart
= null;
2964 this.sliding
= false;
2965 this.$glow
= $( '<span>' );
2966 this.$grip
= $( '<span>' );
2970 click
: this.onClick
.bind( this ),
2971 keypress
: this.onKeyPress
.bind( this )
2975 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
2976 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
2978 .addClass( 'oo-ui-toggleSwitchWidget' )
2979 .attr( 'role', 'checkbox' )
2980 .append( this.$glow
, this.$grip
);
2985 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
2986 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.mixin
.TabIndexedElement
);
2991 * Handle mouse click events.
2994 * @param {jQuery.Event} e Mouse click event
2996 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
2997 if ( !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
2998 this.setValue( !this.value
);
3004 * Handle key press events.
3007 * @param {jQuery.Event} e Key press event
3009 OO
.ui
.ToggleSwitchWidget
.prototype.onKeyPress = function ( e
) {
3010 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
3011 this.setValue( !this.value
);
3019 OO
.ui
.ToggleSwitchWidget
.prototype.setValue = function ( value
) {
3020 OO
.ui
.ToggleSwitchWidget
.parent
.prototype.setValue
.call( this, value
);
3021 this.$element
.attr( 'aria-checked', this.value
.toString() );
3028 OO
.ui
.ToggleSwitchWidget
.prototype.simulateLabelClick = function () {
3029 if ( !this.isDisabled() ) {
3030 this.setValue( !this.value
);
3036 * OutlineControlsWidget is a set of controls for an {@link OO.ui.OutlineSelectWidget outline select widget}.
3037 * Controls include moving items up and down, removing items, and adding different kinds of items.
3039 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3042 * @extends OO.ui.Widget
3043 * @mixins OO.ui.mixin.GroupElement
3046 * @param {OO.ui.OutlineSelectWidget} outline Outline to control
3047 * @param {Object} [config] Configuration options
3048 * @cfg {Object} [abilities] List of abilties
3049 * @cfg {boolean} [abilities.move=true] Allow moving movable items
3050 * @cfg {boolean} [abilities.remove=true] Allow removing removable items
3052 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
3053 // Allow passing positional parameters inside the config object
3054 if ( OO
.isPlainObject( outline
) && config
=== undefined ) {
3056 outline
= config
.outline
;
3059 // Configuration initialization
3060 config
= config
|| {};
3062 // Parent constructor
3063 OO
.ui
.OutlineControlsWidget
.parent
.call( this, config
);
3065 // Mixin constructors
3066 OO
.ui
.mixin
.GroupElement
.call( this, config
);
3069 this.outline
= outline
;
3070 this.$movers
= $( '<div>' );
3071 this.upButton
= new OO
.ui
.ButtonWidget( {
3074 title
: OO
.ui
.msg( 'ooui-outline-control-move-up' )
3076 this.downButton
= new OO
.ui
.ButtonWidget( {
3079 title
: OO
.ui
.msg( 'ooui-outline-control-move-down' )
3081 this.removeButton
= new OO
.ui
.ButtonWidget( {
3084 title
: OO
.ui
.msg( 'ooui-outline-control-remove' )
3086 this.abilities
= { move: true, remove
: true };
3089 outline
.connect( this, {
3090 select
: 'onOutlineChange',
3091 add
: 'onOutlineChange',
3092 remove
: 'onOutlineChange'
3094 this.upButton
.connect( this, { click
: [ 'emit', 'move', -1 ] } );
3095 this.downButton
.connect( this, { click
: [ 'emit', 'move', 1 ] } );
3096 this.removeButton
.connect( this, { click
: [ 'emit', 'remove' ] } );
3099 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
3100 this.$group
.addClass( 'oo-ui-outlineControlsWidget-items' );
3102 .addClass( 'oo-ui-outlineControlsWidget-movers' )
3103 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
3104 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
3105 this.setAbilities( config
.abilities
|| {} );
3110 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
3111 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.GroupElement
);
3117 * @param {number} places Number of places to move
3129 * @param {Object} abilities List of abilties
3130 * @param {boolean} [abilities.move] Allow moving movable items
3131 * @param {boolean} [abilities.remove] Allow removing removable items
3133 OO
.ui
.OutlineControlsWidget
.prototype.setAbilities = function ( abilities
) {
3136 for ( ability
in this.abilities
) {
3137 if ( abilities
[ ability
] !== undefined ) {
3138 this.abilities
[ ability
] = !!abilities
[ ability
];
3142 this.onOutlineChange();
3146 * Handle outline change events.
3150 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
3151 var i
, len
, firstMovable
, lastMovable
,
3152 items
= this.outline
.getItems(),
3153 selectedItem
= this.outline
.findSelectedItem(),
3154 movable
= this.abilities
.move && selectedItem
&& selectedItem
.isMovable(),
3155 removable
= this.abilities
.remove
&& selectedItem
&& selectedItem
.isRemovable();
3160 while ( ++i
< len
) {
3161 if ( items
[ i
].isMovable() ) {
3162 firstMovable
= items
[ i
];
3168 if ( items
[ i
].isMovable() ) {
3169 lastMovable
= items
[ i
];
3174 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
3175 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
3176 this.removeButton
.setDisabled( !removable
);
3180 * OutlineOptionWidget is an item in an {@link OO.ui.OutlineSelectWidget OutlineSelectWidget}.
3182 * Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}, which contain
3183 * {@link OO.ui.PageLayout page layouts}. See {@link OO.ui.BookletLayout BookletLayout}
3187 * @extends OO.ui.DecoratedOptionWidget
3190 * @param {Object} [config] Configuration options
3191 * @cfg {number} [level] Indentation level
3192 * @cfg {boolean} [movable] Allow modification from {@link OO.ui.OutlineControlsWidget outline controls}.
3194 OO
.ui
.OutlineOptionWidget
= function OoUiOutlineOptionWidget( config
) {
3195 // Configuration initialization
3196 config
= config
|| {};
3198 // Parent constructor
3199 OO
.ui
.OutlineOptionWidget
.parent
.call( this, config
);
3203 this.movable
= !!config
.movable
;
3204 this.removable
= !!config
.removable
;
3207 this.$element
.addClass( 'oo-ui-outlineOptionWidget' );
3208 this.setLevel( config
.level
);
3213 OO
.inheritClass( OO
.ui
.OutlineOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
3215 /* Static Properties */
3221 OO
.ui
.OutlineOptionWidget
.static.highlightable
= true;
3227 OO
.ui
.OutlineOptionWidget
.static.scrollIntoViewOnSelect
= true;
3232 * @property {string}
3234 OO
.ui
.OutlineOptionWidget
.static.levelClass
= 'oo-ui-outlineOptionWidget-level-';
3239 * @property {number}
3241 OO
.ui
.OutlineOptionWidget
.static.levels
= 3;
3246 * Check if item is movable.
3248 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3250 * @return {boolean} Item is movable
3252 OO
.ui
.OutlineOptionWidget
.prototype.isMovable = function () {
3253 return this.movable
;
3257 * Check if item is removable.
3259 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3261 * @return {boolean} Item is removable
3263 OO
.ui
.OutlineOptionWidget
.prototype.isRemovable = function () {
3264 return this.removable
;
3268 * Get indentation level.
3270 * @return {number} Indentation level
3272 OO
.ui
.OutlineOptionWidget
.prototype.getLevel = function () {
3279 OO
.ui
.OutlineOptionWidget
.prototype.setPressed = function ( state
) {
3280 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setPressed
.call( this, state
);
3287 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3289 * @param {boolean} movable Item is movable
3292 OO
.ui
.OutlineOptionWidget
.prototype.setMovable = function ( movable
) {
3293 this.movable
= !!movable
;
3294 this.updateThemeClasses();
3301 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3303 * @param {boolean} removable Item is removable
3306 OO
.ui
.OutlineOptionWidget
.prototype.setRemovable = function ( removable
) {
3307 this.removable
= !!removable
;
3308 this.updateThemeClasses();
3315 OO
.ui
.OutlineOptionWidget
.prototype.setSelected = function ( state
) {
3316 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3321 * Set indentation level.
3323 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
3326 OO
.ui
.OutlineOptionWidget
.prototype.setLevel = function ( level
) {
3327 var levels
= this.constructor.static.levels
,
3328 levelClass
= this.constructor.static.levelClass
,
3331 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
3333 if ( this.level
=== i
) {
3334 this.$element
.addClass( levelClass
+ i
);
3336 this.$element
.removeClass( levelClass
+ i
);
3339 this.updateThemeClasses();
3345 * OutlineSelectWidget is a structured list that contains {@link OO.ui.OutlineOptionWidget outline options}
3346 * A set of controls can be provided with an {@link OO.ui.OutlineControlsWidget outline controls} widget.
3348 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3351 * @extends OO.ui.SelectWidget
3352 * @mixins OO.ui.mixin.TabIndexedElement
3355 * @param {Object} [config] Configuration options
3357 OO
.ui
.OutlineSelectWidget
= function OoUiOutlineSelectWidget( config
) {
3358 // Parent constructor
3359 OO
.ui
.OutlineSelectWidget
.parent
.call( this, config
);
3361 // Mixin constructors
3362 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3366 focus
: this.bindDocumentKeyDownListener
.bind( this ),
3367 blur
: this.unbindDocumentKeyDownListener
.bind( this )
3371 this.$element
.addClass( 'oo-ui-outlineSelectWidget' );
3376 OO
.inheritClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.SelectWidget
);
3377 OO
.mixinClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3380 * ButtonOptionWidget is a special type of {@link OO.ui.mixin.ButtonElement button element} that
3381 * can be selected and configured with data. The class is
3382 * used with OO.ui.ButtonSelectWidget to create a selection of button options. Please see the
3383 * [OOUI documentation on MediaWiki] [1] for more information.
3385 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options#Button_selects_and_options
3388 * @extends OO.ui.OptionWidget
3389 * @mixins OO.ui.mixin.ButtonElement
3390 * @mixins OO.ui.mixin.IconElement
3391 * @mixins OO.ui.mixin.IndicatorElement
3392 * @mixins OO.ui.mixin.TitledElement
3395 * @param {Object} [config] Configuration options
3397 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( config
) {
3398 // Configuration initialization
3399 config
= config
|| {};
3401 // Parent constructor
3402 OO
.ui
.ButtonOptionWidget
.parent
.call( this, config
);
3404 // Mixin constructors
3405 OO
.ui
.mixin
.ButtonElement
.call( this, config
);
3406 OO
.ui
.mixin
.IconElement
.call( this, config
);
3407 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3408 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
3411 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
3412 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
3413 this.$element
.append( this.$button
);
3418 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.OptionWidget
);
3419 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.ButtonElement
);
3420 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IconElement
);
3421 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IndicatorElement
);
3422 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.TitledElement
);
3424 /* Static Properties */
3427 * Allow button mouse down events to pass through so they can be handled by the parent select widget
3432 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
3438 OO
.ui
.ButtonOptionWidget
.static.highlightable
= false;
3445 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
3446 OO
.ui
.ButtonOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3448 if ( this.constructor.static.selectable
) {
3449 this.setActive( state
);
3456 * ButtonSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains
3457 * button options and is used together with
3458 * OO.ui.ButtonOptionWidget. The ButtonSelectWidget provides an interface for
3459 * highlighting, choosing, and selecting mutually exclusive options. Please see
3460 * the [OOUI documentation on MediaWiki] [1] for more information.
3463 * // Example: A ButtonSelectWidget that contains three ButtonOptionWidgets
3464 * var option1 = new OO.ui.ButtonOptionWidget( {
3466 * label: 'Option 1',
3467 * title: 'Button option 1'
3470 * var option2 = new OO.ui.ButtonOptionWidget( {
3472 * label: 'Option 2',
3473 * title: 'Button option 2'
3476 * var option3 = new OO.ui.ButtonOptionWidget( {
3478 * label: 'Option 3',
3479 * title: 'Button option 3'
3482 * var buttonSelect=new OO.ui.ButtonSelectWidget( {
3483 * items: [ option1, option2, option3 ]
3485 * $( 'body' ).append( buttonSelect.$element );
3487 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets/Selects_and_Options
3490 * @extends OO.ui.SelectWidget
3491 * @mixins OO.ui.mixin.TabIndexedElement
3494 * @param {Object} [config] Configuration options
3496 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
3497 // Parent constructor
3498 OO
.ui
.ButtonSelectWidget
.parent
.call( this, config
);
3500 // Mixin constructors
3501 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3505 focus
: this.bindDocumentKeyDownListener
.bind( this ),
3506 blur
: this.unbindDocumentKeyDownListener
.bind( this )
3510 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
3515 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
3516 OO
.mixinClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3519 * TabOptionWidget is an item in a {@link OO.ui.TabSelectWidget TabSelectWidget}.
3521 * Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}, which contain
3522 * {@link OO.ui.TabPanelLayout tab panel layouts}. See {@link OO.ui.IndexLayout IndexLayout}
3526 * @extends OO.ui.OptionWidget
3529 * @param {Object} [config] Configuration options
3531 OO
.ui
.TabOptionWidget
= function OoUiTabOptionWidget( config
) {
3532 // Configuration initialization
3533 config
= config
|| {};
3535 // Parent constructor
3536 OO
.ui
.TabOptionWidget
.parent
.call( this, config
);
3540 .addClass( 'oo-ui-tabOptionWidget' )
3541 .attr( 'role', 'tab' );
3546 OO
.inheritClass( OO
.ui
.TabOptionWidget
, OO
.ui
.OptionWidget
);
3548 /* Static Properties */
3554 OO
.ui
.TabOptionWidget
.static.highlightable
= false;
3557 * TabSelectWidget is a list that contains {@link OO.ui.TabOptionWidget tab options}
3559 * **Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}.**
3562 * @extends OO.ui.SelectWidget
3563 * @mixins OO.ui.mixin.TabIndexedElement
3566 * @param {Object} [config] Configuration options
3568 OO
.ui
.TabSelectWidget
= function OoUiTabSelectWidget( config
) {
3569 // Parent constructor
3570 OO
.ui
.TabSelectWidget
.parent
.call( this, config
);
3572 // Mixin constructors
3573 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3577 focus
: this.bindDocumentKeyDownListener
.bind( this ),
3578 blur
: this.unbindDocumentKeyDownListener
.bind( this )
3583 .addClass( 'oo-ui-tabSelectWidget' )
3584 .attr( 'role', 'tablist' );
3589 OO
.inheritClass( OO
.ui
.TabSelectWidget
, OO
.ui
.SelectWidget
);
3590 OO
.mixinClass( OO
.ui
.TabSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3593 * TagItemWidgets are used within a {@link OO.ui.TagMultiselectWidget
3594 * TagMultiselectWidget} to display the selected items.
3597 * @extends OO.ui.Widget
3598 * @mixins OO.ui.mixin.ItemWidget
3599 * @mixins OO.ui.mixin.LabelElement
3600 * @mixins OO.ui.mixin.FlaggedElement
3601 * @mixins OO.ui.mixin.TabIndexedElement
3602 * @mixins OO.ui.mixin.DraggableElement
3605 * @param {Object} [config] Configuration object
3606 * @cfg {boolean} [valid=true] Item is valid
3607 * @cfg {boolean} [fixed] Item is fixed. This means the item is
3608 * always included in the values and cannot be removed.
3610 OO
.ui
.TagItemWidget
= function OoUiTagItemWidget( config
) {
3611 config
= config
|| {};
3613 // Parent constructor
3614 OO
.ui
.TagItemWidget
.parent
.call( this, config
);
3616 // Mixin constructors
3617 OO
.ui
.mixin
.ItemWidget
.call( this );
3618 OO
.ui
.mixin
.LabelElement
.call( this, config
);
3619 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
3620 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3621 OO
.ui
.mixin
.DraggableElement
.call( this, config
);
3623 this.valid
= config
.valid
=== undefined ? true : !!config
.valid
;
3624 this.fixed
= !!config
.fixed
;
3626 this.closeButton
= new OO
.ui
.ButtonWidget( {
3630 title
: OO
.ui
.msg( 'ooui-item-remove' )
3632 this.closeButton
.setDisabled( this.isDisabled() );
3636 .connect( this, { click
: 'remove' } );
3638 .on( 'click', this.select
.bind( this ) )
3639 .on( 'keydown', this.onKeyDown
.bind( this ) )
3640 // Prevent propagation of mousedown; the tag item "lives" in the
3641 // clickable area of the TagMultiselectWidget, which listens to
3642 // mousedown to open the menu or popup. We want to prevent that
3643 // for clicks specifically on the tag itself, so the actions taken
3644 // are more deliberate. When the tag is clicked, it will emit the
3645 // selection event (similar to how #OO.ui.MultioptionWidget emits 'change')
3646 // and can be handled separately.
3647 .on( 'mousedown', function ( e
) { e
.stopPropagation(); } );
3651 .addClass( 'oo-ui-tagItemWidget' )
3652 .append( this.$label
, this.closeButton
.$element
);
3655 /* Initialization */
3657 OO
.inheritClass( OO
.ui
.TagItemWidget
, OO
.ui
.Widget
);
3658 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.ItemWidget
);
3659 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.LabelElement
);
3660 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.FlaggedElement
);
3661 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3662 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.DraggableElement
);
3669 * A remove action was performed on the item
3674 * @param {string} direction Direction of the movement, forward or backwards
3676 * A navigate action was performed on the item
3682 * The tag widget was selected. This can occur when the widget
3683 * is either clicked or enter was pressed on it.
3688 * @param {boolean} isValid Item is valid
3690 * Item validity has changed
3695 * @param {boolean} isFixed Item is fixed
3697 * Item fixed state has changed
3703 * Set this item as fixed, meaning it cannot be removed
3705 * @param {string} [state] Item is fixed
3708 OO
.ui
.TagItemWidget
.prototype.setFixed = function ( state
) {
3709 state
= state
=== undefined ? !this.fixed
: !!state
;
3711 if ( this.fixed
!== state
) {
3713 if ( this.closeButton
) {
3714 this.closeButton
.toggle( !this.fixed
);
3717 if ( !this.fixed
&& this.elementGroup
&& !this.elementGroup
.isDraggable() ) {
3718 // Only enable the state of the item if the
3719 // entire group is draggable
3720 this.toggleDraggable( !this.fixed
);
3722 this.$element
.toggleClass( 'oo-ui-tagItemWidget-fixed', this.fixed
);
3724 this.emit( 'fixed', this.isFixed() );
3730 * Check whether the item is fixed
3732 OO
.ui
.TagItemWidget
.prototype.isFixed = function () {
3739 OO
.ui
.TagItemWidget
.prototype.setDisabled = function ( state
) {
3740 if ( state
&& this.elementGroup
&& !this.elementGroup
.isDisabled() ) {
3741 OO
.ui
.warnDeprecation( 'TagItemWidget#setDisabled: Disabling individual items is deprecated and will result in inconsistent behavior. Use #setFixed instead. See T193571.' );
3744 OO
.ui
.TagItemWidget
.parent
.prototype.setDisabled
.call( this, state
);
3747 // Verify we have a group, and that the widget is ready
3748 this.toggleDraggable
&& this.elementGroup
&&
3750 !this.elementGroup
.isDraggable()
3752 // Only enable the draggable state of the item if the
3753 // entire group is draggable to begin with, and if the
3754 // item is not fixed
3755 this.toggleDraggable( !state
);
3758 if ( this.closeButton
) {
3759 this.closeButton
.setDisabled( state
);
3766 * Handle removal of the item
3768 * This is mainly for extensibility concerns, so other children
3769 * of this class can change the behavior if they need to. This
3770 * is called by both clicking the 'remove' button but also
3771 * on keypress, which is harder to override if needed.
3775 OO
.ui
.TagItemWidget
.prototype.remove = function () {
3776 if ( !this.isDisabled() && !this.isFixed() ) {
3777 this.emit( 'remove' );
3782 * Handle a keydown event on the widget
3786 * @param {jQuery.Event} e Key down event
3787 * @return {boolean|undefined} false to stop the operation
3789 OO
.ui
.TagItemWidget
.prototype.onKeyDown = function ( e
) {
3792 if ( !this.isDisabled() && !this.isFixed() && e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
|| e
.keyCode
=== OO
.ui
.Keys
.DELETE
) {
3795 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ENTER
) {
3799 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
3800 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
3802 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
3816 e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
3817 movement
.left
: movement
.right
3828 OO
.ui
.TagItemWidget
.prototype.select = function () {
3829 if ( !this.isDisabled() ) {
3830 this.emit( 'select' );
3835 * Set the valid state of this item
3837 * @param {boolean} [valid] Item is valid
3840 OO
.ui
.TagItemWidget
.prototype.toggleValid = function ( valid
) {
3841 valid
= valid
=== undefined ? !this.valid
: !!valid
;
3843 if ( this.valid
!== valid
) {
3846 this.setFlags( { invalid
: !this.valid
} );
3848 this.emit( 'valid', this.valid
);
3853 * Check whether the item is valid
3855 * @return {boolean} Item is valid
3857 OO
.ui
.TagItemWidget
.prototype.isValid = function () {
3862 * A basic tag multiselect widget, similar in concept to {@link OO.ui.ComboBoxInputWidget combo box widget}
3863 * that allows the user to add multiple values that are displayed in a tag area.
3865 * This widget is a base widget; see {@link OO.ui.MenuTagMultiselectWidget MenuTagMultiselectWidget} and
3866 * {@link OO.ui.PopupTagMultiselectWidget PopupTagMultiselectWidget} for the implementations that use
3867 * a menu and a popup respectively.
3870 * // Example: A basic TagMultiselectWidget.
3871 * var widget = new OO.ui.TagMultiselectWidget( {
3872 * inputPosition: 'outline',
3873 * allowedValues: [ 'Option 1', 'Option 2', 'Option 3' ],
3874 * selected: [ 'Option 1' ]
3876 * $( 'body' ).append( widget.$element );
3879 * @extends OO.ui.Widget
3880 * @mixins OO.ui.mixin.GroupWidget
3881 * @mixins OO.ui.mixin.DraggableGroupElement
3882 * @mixins OO.ui.mixin.IndicatorElement
3883 * @mixins OO.ui.mixin.IconElement
3884 * @mixins OO.ui.mixin.TabIndexedElement
3885 * @mixins OO.ui.mixin.FlaggedElement
3888 * @param {Object} config Configuration object
3889 * @cfg {Object} [input] Configuration options for the input widget
3890 * @cfg {OO.ui.InputWidget} [inputWidget] An optional input widget. If given, it will
3891 * replace the input widget used in the TagMultiselectWidget. If not given,
3892 * TagMultiselectWidget creates its own.
3893 * @cfg {boolean} [inputPosition='inline'] Position of the input. Options are:
3894 * - inline: The input is invisible, but exists inside the tag list, so
3895 * the user types into the tag groups to add tags.
3896 * - outline: The input is underneath the tag area.
3897 * - none: No input supplied
3898 * @cfg {boolean} [allowEditTags=true] Allow editing of the tags by clicking them
3899 * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if
3900 * not present in the menu.
3901 * @cfg {Object[]} [allowedValues] An array representing the allowed items
3903 * @cfg {boolean} [allowDuplicates=false] Allow duplicate items to be added
3904 * @cfg {boolean} [allowDisplayInvalidTags=false] Allow the display of
3905 * invalid tags. These tags will display with an invalid state, and
3906 * the widget as a whole will have an invalid state if any invalid tags
3908 * @cfg {boolean} [allowReordering=true] Allow reordering of the items
3909 * @cfg {Object[]|String[]} [selected] A set of selected tags. If given,
3910 * these will appear in the tag list on initialization, as long as they
3911 * pass the validity tests.
3913 OO
.ui
.TagMultiselectWidget
= function OoUiTagMultiselectWidget( config
) {
3915 rAF
= window
.requestAnimationFrame
|| setTimeout
,
3917 $tabFocus
= $( '<span>' )
3918 .addClass( 'oo-ui-tagMultiselectWidget-focusTrap' );
3920 config
= config
|| {};
3922 // Parent constructor
3923 OO
.ui
.TagMultiselectWidget
.parent
.call( this, config
);
3925 // Mixin constructors
3926 OO
.ui
.mixin
.GroupWidget
.call( this, config
);
3927 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3928 OO
.ui
.mixin
.IconElement
.call( this, config
);
3929 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3930 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
3931 OO
.ui
.mixin
.DraggableGroupElement
.call( this, config
);
3933 this.toggleDraggable(
3934 config
.allowReordering
=== undefined ?
3935 true : !!config
.allowReordering
3938 this.inputPosition
=
3939 this.constructor.static.allowedInputPositions
.indexOf( config
.inputPosition
) > -1 ?
3940 config
.inputPosition
: 'inline';
3941 this.allowEditTags
= config
.allowEditTags
=== undefined ? true : !!config
.allowEditTags
;
3942 this.allowArbitrary
= !!config
.allowArbitrary
;
3943 this.allowDuplicates
= !!config
.allowDuplicates
;
3944 this.allowedValues
= config
.allowedValues
|| [];
3945 this.allowDisplayInvalidTags
= config
.allowDisplayInvalidTags
;
3946 this.hasInput
= this.inputPosition
!== 'none';
3950 this.$content
= $( '<div>' )
3951 .addClass( 'oo-ui-tagMultiselectWidget-content' );
3952 this.$handle
= $( '<div>' )
3953 .addClass( 'oo-ui-tagMultiselectWidget-handle' )
3960 .addClass( 'oo-ui-tagMultiselectWidget-group' )
3966 remove
: 'itemRemove',
3967 navigate
: 'itemNavigate',
3968 select
: 'itemSelect',
3971 this.connect( this, {
3972 itemRemove
: 'onTagRemove',
3973 itemSelect
: 'onTagSelect',
3974 itemFixed
: 'onTagFixed',
3975 itemNavigate
: 'onTagNavigate',
3976 change
: 'onChangeTags'
3979 mousedown
: this.onMouseDown
.bind( this )
3984 .addClass( 'oo-ui-tagMultiselectWidget' )
3985 .append( this.$handle
);
3987 if ( this.hasInput
) {
3988 if ( config
.inputWidget
) {
3989 this.input
= config
.inputWidget
;
3991 this.input
= new OO
.ui
.TextInputWidget( $.extend( {
3992 placeholder
: config
.placeholder
,
3993 classes
: [ 'oo-ui-tagMultiselectWidget-input' ]
3994 }, config
.input
) );
3996 this.input
.setDisabled( this.isDisabled() );
3999 focus
: this.onInputFocus
.bind( this ),
4000 blur
: this.onInputBlur
.bind( this ),
4001 'propertychange change click mouseup keydown keyup input cut paste select focus':
4002 OO
.ui
.debounce( this.updateInputSize
.bind( this ) ),
4003 keydown
: this.onInputKeyDown
.bind( this ),
4004 keypress
: this.onInputKeyPress
.bind( this )
4007 this.input
.$input
.on( inputEvents
);
4009 if ( this.inputPosition
=== 'outline' ) {
4010 // Override max-height for the input widget
4011 // in the case the widget is outline so it can
4012 // stretch all the way if the widet is wide
4013 this.input
.$element
.css( 'max-width', 'inherit' );
4015 .addClass( 'oo-ui-tagMultiselectWidget-outlined' )
4016 .append( this.input
.$element
);
4018 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-inlined' );
4019 // HACK: When the widget is using 'inline' input, the
4020 // behavior needs to only use the $input itself
4021 // so we style and size it accordingly (otherwise
4022 // the styling and sizing can get very convoluted
4023 // when the wrapping divs and other elements)
4024 // We are taking advantage of still being able to
4025 // call the widget itself for operations like
4026 // .getValue() and setDisabled() and .focus() but
4027 // having only the $input attached to the DOM
4028 this.$content
.append( this.input
.$input
);
4031 this.$content
.append( $tabFocus
);
4034 this.setTabIndexedElement(
4040 if ( config
.selected
) {
4041 this.setValue( config
.selected
);
4044 // HACK: Input size needs to be calculated after everything
4047 if ( widget
.hasInput
) {
4048 widget
.updateInputSize();
4053 /* Initialization */
4055 OO
.inheritClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.Widget
);
4056 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.GroupWidget
);
4057 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.DraggableGroupElement
);
4058 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IndicatorElement
);
4059 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IconElement
);
4060 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
4061 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.FlaggedElement
);
4063 /* Static properties */
4066 * Allowed input positions.
4067 * - inline: The input is inside the tag list
4068 * - outline: The input is under the tag list
4069 * - none: There is no input
4073 OO
.ui
.TagMultiselectWidget
.static.allowedInputPositions
= [ 'inline', 'outline', 'none' ];
4078 * Handle mouse down events.
4081 * @param {jQuery.Event} e Mouse down event
4082 * @return {boolean} False to prevent defaults
4084 OO
.ui
.TagMultiselectWidget
.prototype.onMouseDown = function ( e
) {
4086 !this.isDisabled() &&
4087 ( !this.hasInput
|| e
.target
!== this.input
.$input
[ 0 ] ) &&
4088 e
.which
=== OO
.ui
.MouseButtons
.LEFT
4096 * Handle key press events.
4099 * @param {jQuery.Event} e Key press event
4100 * @return {boolean} Whether to prevent defaults
4102 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyPress = function ( e
) {
4104 withMetaKey
= e
.metaKey
|| e
.ctrlKey
;
4106 if ( !this.isDisabled() ) {
4107 if ( e
.which
=== OO
.ui
.Keys
.ENTER
) {
4108 stopOrContinue
= this.doInputEnter( e
, withMetaKey
);
4111 // Make sure the input gets resized.
4112 setTimeout( this.updateInputSize
.bind( this ), 0 );
4113 return stopOrContinue
;
4118 * Handle key down events.
4121 * @param {jQuery.Event} e Key down event
4124 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyDown = function ( e
) {
4125 var movement
, direction
,
4127 withMetaKey
= e
.metaKey
|| e
.ctrlKey
,
4128 isMovementInsideInput = function ( direction
) {
4129 var inputRange
= widget
.input
.getRange(),
4130 inputValue
= widget
.hasInput
&& widget
.input
.getValue();
4132 if ( direction
=== 'forwards' && inputRange
.to
> inputValue
.length
- 1 ) {
4136 if ( direction
=== 'backwards' && inputRange
.from <= 0 ) {
4143 if ( !this.isDisabled() ) {
4144 // 'keypress' event is not triggered for Backspace
4145 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
) {
4146 return this.doInputBackspace( e
, withMetaKey
);
4147 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ESCAPE
) {
4148 return this.doInputEscape( e
);
4150 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
4151 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
4153 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
4164 direction
= e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
4165 movement
.left
: movement
.right
;
4167 if ( !this.hasInput
|| !isMovementInsideInput( direction
) ) {
4168 return this.doInputArrow( e
, direction
, withMetaKey
);
4175 * Respond to input focus event
4177 OO
.ui
.TagMultiselectWidget
.prototype.onInputFocus = function () {
4178 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-focus' );
4182 * Respond to input blur event
4184 OO
.ui
.TagMultiselectWidget
.prototype.onInputBlur = function () {
4185 this.$element
.removeClass( 'oo-ui-tagMultiselectWidget-focus' );
4189 * Perform an action after the enter key on the input
4191 * @param {jQuery.Event} e Event data
4192 * @param {boolean} [withMetaKey] Whether this key was pressed with
4193 * a meta key like 'ctrl'
4194 * @return {boolean} Whether to prevent defaults
4196 OO
.ui
.TagMultiselectWidget
.prototype.doInputEnter = function () {
4197 this.addTagFromInput();
4202 * Perform an action responding to the enter key on the input
4204 * @param {jQuery.Event} e Event data
4205 * @param {boolean} [withMetaKey] Whether this key was pressed with
4206 * a meta key like 'ctrl'
4207 * @return {boolean} Whether to prevent defaults
4209 OO
.ui
.TagMultiselectWidget
.prototype.doInputBackspace = function ( e
, withMetaKey
) {
4213 this.inputPosition
=== 'inline' &&
4214 this.input
.getValue() === '' &&
4217 // Delete the last item
4218 items
= this.getItems();
4219 item
= items
[ items
.length
- 1 ];
4221 if ( !item
.isDisabled() && !item
.isFixed() ) {
4222 this.removeItems( [ item
] );
4223 // If Ctrl/Cmd was pressed, delete item entirely.
4224 // Otherwise put it into the text field for editing.
4225 if ( !withMetaKey
) {
4226 this.input
.setValue( item
.getData() );
4235 * Perform an action after the escape key on the input
4237 * @param {jQuery.Event} e Event data
4239 OO
.ui
.TagMultiselectWidget
.prototype.doInputEscape = function () {
4244 * Perform an action after the arrow key on the input, select the previous
4245 * item from the input.
4246 * See #getPreviousItem
4248 * @param {jQuery.Event} e Event data
4249 * @param {string} direction Direction of the movement; forwards or backwards
4250 * @param {boolean} [withMetaKey] Whether this key was pressed with
4251 * a meta key like 'ctrl'
4253 OO
.ui
.TagMultiselectWidget
.prototype.doInputArrow = function ( e
, direction
) {
4255 this.inputPosition
=== 'inline' &&
4257 direction
=== 'backwards'
4259 // Get previous item
4260 this.getPreviousItem().focus();
4265 * Respond to item select event
4267 * @param {OO.ui.TagItemWidget} item Selected item
4269 OO
.ui
.TagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
4270 if ( this.hasInput
&& this.allowEditTags
&& !item
.isFixed() ) {
4271 if ( this.input
.getValue() ) {
4272 this.addTagFromInput();
4274 // 1. Get the label of the tag into the input
4275 this.input
.setValue( item
.getData() );
4276 // 2. Remove the tag
4277 this.removeItems( [ item
] );
4278 // 3. Focus the input
4284 * Respond to item fixed state change
4286 * @param {OO.ui.TagItemWidget} item Selected item
4288 OO
.ui
.TagMultiselectWidget
.prototype.onTagFixed = function ( item
) {
4290 items
= this.getItems();
4292 // Move item to the end of the static items
4293 for ( i
= 0; i
< items
.length
; i
++ ) {
4294 if ( items
[ i
] !== item
&& !items
[ i
].isFixed() ) {
4298 this.addItems( item
, i
);
4301 * Respond to change event, where items were added, removed, or cleared.
4303 OO
.ui
.TagMultiselectWidget
.prototype.onChangeTags = function () {
4304 this.toggleValid( this.checkValidity() );
4305 if ( this.hasInput
) {
4306 this.updateInputSize();
4308 this.updateIfHeightChanged();
4314 OO
.ui
.TagMultiselectWidget
.prototype.setDisabled = function ( isDisabled
) {
4316 OO
.ui
.TagMultiselectWidget
.parent
.prototype.setDisabled
.call( this, isDisabled
);
4318 if ( this.hasInput
&& this.input
) {
4319 this.input
.setDisabled( !!isDisabled
);
4323 this.getItems().forEach( function ( item
) {
4324 item
.setDisabled( !!isDisabled
);
4330 * Respond to tag remove event
4331 * @param {OO.ui.TagItemWidget} item Removed tag
4333 OO
.ui
.TagMultiselectWidget
.prototype.onTagRemove = function ( item
) {
4334 this.removeTagByData( item
.getData() );
4338 * Respond to navigate event on the tag
4340 * @param {OO.ui.TagItemWidget} item Removed tag
4341 * @param {string} direction Direction of movement; 'forwards' or 'backwards'
4343 OO
.ui
.TagMultiselectWidget
.prototype.onTagNavigate = function ( item
, direction
) {
4344 var firstItem
= this.getItems()[ 0 ];
4346 if ( direction
=== 'forwards' ) {
4347 this.getNextItem( item
).focus();
4348 } else if ( !this.inputPosition
=== 'inline' || item
!== firstItem
) {
4349 // If the widget has an inline input, we want to stop at the starting edge
4351 this.getPreviousItem( item
).focus();
4356 * Add tag from input value
4358 OO
.ui
.TagMultiselectWidget
.prototype.addTagFromInput = function () {
4359 var val
= this.input
.getValue(),
4360 isValid
= this.isAllowedData( val
);
4366 if ( isValid
|| this.allowDisplayInvalidTags
) {
4376 OO
.ui
.TagMultiselectWidget
.prototype.clearInput = function () {
4377 this.input
.setValue( '' );
4381 * Check whether the given value is a duplicate of an existing
4382 * tag already in the list.
4384 * @param {string|Object} data Requested value
4385 * @return {boolean} Value is duplicate
4387 OO
.ui
.TagMultiselectWidget
.prototype.isDuplicateData = function ( data
) {
4388 return !!this.findItemFromData( data
);
4392 * Check whether a given value is allowed to be added
4394 * @param {string|Object} data Requested value
4395 * @return {boolean} Value is allowed
4397 OO
.ui
.TagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
4399 !this.allowDuplicates
&&
4400 this.isDuplicateData( data
)
4405 if ( this.allowArbitrary
) {
4409 // Check with allowed values
4411 this.getAllowedValues().some( function ( value
) {
4412 return data
=== value
;
4422 * Get the allowed values list
4424 * @return {string[]} Allowed data values
4426 OO
.ui
.TagMultiselectWidget
.prototype.getAllowedValues = function () {
4427 return this.allowedValues
;
4431 * Add a value to the allowed values list
4433 * @param {string} value Allowed data value
4435 OO
.ui
.TagMultiselectWidget
.prototype.addAllowedValue = function ( value
) {
4436 if ( this.allowedValues
.indexOf( value
) === -1 ) {
4437 this.allowedValues
.push( value
);
4442 * Get the datas of the currently selected items
4444 * @return {string[]|Object[]} Datas of currently selected items
4446 OO
.ui
.TagMultiselectWidget
.prototype.getValue = function () {
4447 return this.getItems()
4448 .filter( function ( item
) {
4449 return item
.isValid();
4451 .map( function ( item
) {
4452 return item
.getData();
4457 * Set the value of this widget by datas.
4459 * @param {string|string[]|Object|Object[]} valueObject An object representing the data
4460 * and label of the value. If the widget allows arbitrary values,
4461 * the items will be added as-is. Otherwise, the data value will
4462 * be checked against allowedValues.
4463 * This object must contain at least a data key. Example:
4464 * { data: 'foo', label: 'Foo item' }
4465 * For multiple items, use an array of objects. For example:
4467 * { data: 'foo', label: 'Foo item' },
4468 * { data: 'bar', label: 'Bar item' }
4470 * Value can also be added with plaintext array, for example:
4471 * [ 'foo', 'bar', 'bla' ] or a single string, like 'foo'
4473 OO
.ui
.TagMultiselectWidget
.prototype.setValue = function ( valueObject
) {
4474 valueObject
= Array
.isArray( valueObject
) ? valueObject
: [ valueObject
];
4477 valueObject
.forEach( function ( obj
) {
4478 if ( typeof obj
=== 'string' ) {
4481 this.addTag( obj
.data
, obj
.label
);
4487 * Add tag to the display area
4489 * @param {string|Object} data Tag data
4490 * @param {string} [label] Tag label. If no label is provided, the
4491 * stringified version of the data will be used instead.
4492 * @return {boolean} Item was added successfully
4494 OO
.ui
.TagMultiselectWidget
.prototype.addTag = function ( data
, label
) {
4496 isValid
= this.isAllowedData( data
);
4498 if ( isValid
|| this.allowDisplayInvalidTags
) {
4499 newItemWidget
= this.createTagItemWidget( data
, label
);
4500 newItemWidget
.toggleValid( isValid
);
4501 this.addItems( [ newItemWidget
] );
4508 * Remove tag by its data property.
4510 * @param {string|Object} data Tag data
4512 OO
.ui
.TagMultiselectWidget
.prototype.removeTagByData = function ( data
) {
4513 var item
= this.findItemFromData( data
);
4515 this.removeItems( [ item
] );
4519 * Construct a OO.ui.TagItemWidget (or a subclass thereof) from given label and data.
4522 * @param {string} data Item data
4523 * @param {string} label The label text.
4524 * @return {OO.ui.TagItemWidget}
4526 OO
.ui
.TagMultiselectWidget
.prototype.createTagItemWidget = function ( data
, label
) {
4527 label
= label
|| data
;
4529 return new OO
.ui
.TagItemWidget( { data
: data
, label
: label
} );
4533 * Given an item, returns the item after it. If the item is already the
4534 * last item, return `this.input`. If no item is passed, returns the
4538 * @param {OO.ui.TagItemWidget} [item] Tag item
4539 * @return {OO.ui.Widget} The next widget available.
4541 OO
.ui
.TagMultiselectWidget
.prototype.getNextItem = function ( item
) {
4542 var itemIndex
= this.items
.indexOf( item
);
4544 if ( item
=== undefined || itemIndex
=== -1 ) {
4545 return this.items
[ 0 ];
4548 if ( itemIndex
=== this.items
.length
- 1 ) { // Last item
4549 if ( this.hasInput
) {
4552 // Return first item
4553 return this.items
[ 0 ];
4556 return this.items
[ itemIndex
+ 1 ];
4561 * Given an item, returns the item before it. If the item is already the
4562 * first item, return `this.input`. If no item is passed, returns the
4566 * @param {OO.ui.TagItemWidget} [item] Tag item
4567 * @return {OO.ui.Widget} The previous widget available.
4569 OO
.ui
.TagMultiselectWidget
.prototype.getPreviousItem = function ( item
) {
4570 var itemIndex
= this.items
.indexOf( item
);
4572 if ( item
=== undefined || itemIndex
=== -1 ) {
4573 return this.items
[ this.items
.length
- 1 ];
4576 if ( itemIndex
=== 0 ) {
4577 if ( this.hasInput
) {
4580 // Return the last item
4581 return this.items
[ this.items
.length
- 1 ];
4584 return this.items
[ itemIndex
- 1 ];
4589 * Update the dimensions of the text input field to encompass all available area.
4590 * This is especially relevant for when the input is at the edge of a line
4591 * and should get smaller. The usual operation (as an inline-block with min-width)
4592 * does not work in that case, pushing the input downwards to the next line.
4596 OO
.ui
.TagMultiselectWidget
.prototype.updateInputSize = function () {
4597 var $lastItem
, direction
, contentWidth
, currentWidth
, bestWidth
;
4598 if ( this.inputPosition
=== 'inline' && !this.isDisabled() ) {
4599 if ( this.input
.$input
[ 0 ].scrollWidth
=== 0 ) {
4600 // Input appears to be attached but not visible.
4601 // Don't attempt to adjust its size, because our measurements
4602 // are going to fail anyway.
4605 this.input
.$input
.css( 'width', '1em' );
4606 $lastItem
= this.$group
.children().last();
4607 direction
= OO
.ui
.Element
.static.getDir( this.$handle
);
4609 // Get the width of the input with the placeholder text as
4610 // the value and save it so that we don't keep recalculating
4612 this.contentWidthWithPlaceholder
=== undefined &&
4613 this.input
.getValue() === '' &&
4614 this.input
.$input
.attr( 'placeholder' ) !== undefined
4616 this.input
.setValue( this.input
.$input
.attr( 'placeholder' ) );
4617 this.contentWidthWithPlaceholder
= this.input
.$input
[ 0 ].scrollWidth
;
4618 this.input
.setValue( '' );
4622 // Always keep the input wide enough for the placeholder text
4623 contentWidth
= Math
.max(
4624 this.input
.$input
[ 0 ].scrollWidth
,
4625 // undefined arguments in Math.max lead to NaN
4626 ( this.contentWidthWithPlaceholder
=== undefined ) ?
4627 0 : this.contentWidthWithPlaceholder
4629 currentWidth
= this.input
.$input
.width();
4631 if ( contentWidth
< currentWidth
) {
4632 this.updateIfHeightChanged();
4633 // All is fine, don't perform expensive calculations
4637 if ( $lastItem
.length
=== 0 ) {
4638 bestWidth
= this.$content
.innerWidth();
4640 bestWidth
= direction
=== 'ltr' ?
4641 this.$content
.innerWidth() - $lastItem
.position().left
- $lastItem
.outerWidth() :
4642 $lastItem
.position().left
;
4645 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
4646 // pixels this is off by are coming from.
4648 if ( contentWidth
> bestWidth
) {
4649 // This will result in the input getting shifted to the next line
4650 bestWidth
= this.$content
.innerWidth() - 10;
4652 this.input
.$input
.width( Math
.floor( bestWidth
) );
4653 this.updateIfHeightChanged();
4655 this.updateIfHeightChanged();
4660 * Determine if widget height changed, and if so,
4661 * emit the resize event. This is useful for when there are either
4662 * menus or popups attached to the bottom of the widget, to allow
4663 * them to change their positioning in case the widget moved down
4668 OO
.ui
.TagMultiselectWidget
.prototype.updateIfHeightChanged = function () {
4669 var height
= this.$element
.height();
4670 if ( height
!== this.height
) {
4671 this.height
= height
;
4672 this.emit( 'resize' );
4677 * Check whether all items in the widget are valid
4679 * @return {boolean} Widget is valid
4681 OO
.ui
.TagMultiselectWidget
.prototype.checkValidity = function () {
4682 return this.getItems().every( function ( item
) {
4683 return item
.isValid();
4688 * Set the valid state of this item
4690 * @param {boolean} [valid] Item is valid
4693 OO
.ui
.TagMultiselectWidget
.prototype.toggleValid = function ( valid
) {
4694 valid
= valid
=== undefined ? !this.valid
: !!valid
;
4696 if ( this.valid
!== valid
) {
4699 this.setFlags( { invalid
: !this.valid
} );
4701 this.emit( 'valid', this.valid
);
4706 * Get the current valid state of the widget
4708 * @return {boolean} Widget is valid
4710 OO
.ui
.TagMultiselectWidget
.prototype.isValid = function () {
4715 * PopupTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
4716 * to use a popup. The popup can be configured to have a default input to insert values into the widget.
4719 * // Example: A basic PopupTagMultiselectWidget.
4720 * var widget = new OO.ui.PopupTagMultiselectWidget();
4721 * $( 'body' ).append( widget.$element );
4723 * // Example: A PopupTagMultiselectWidget with an external popup.
4724 * var popupInput = new OO.ui.TextInputWidget(),
4725 * widget = new OO.ui.PopupTagMultiselectWidget( {
4726 * popupInput: popupInput,
4728 * $content: popupInput.$element
4731 * $( 'body' ).append( widget.$element );
4734 * @extends OO.ui.TagMultiselectWidget
4735 * @mixins OO.ui.mixin.PopupElement
4737 * @param {Object} config Configuration object
4738 * @cfg {jQuery} [$overlay] An overlay for the popup.
4739 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
4740 * @cfg {Object} [popup] Configuration options for the popup
4741 * @cfg {OO.ui.InputWidget} [popupInput] An input widget inside the popup that will be
4742 * focused when the popup is opened and will be used as replacement for the
4743 * general input in the widget.
4745 OO
.ui
.PopupTagMultiselectWidget
= function OoUiPopupTagMultiselectWidget( config
) {
4747 defaultConfig
= { popup
: {} };
4749 config
= config
|| {};
4751 // Parent constructor
4752 OO
.ui
.PopupTagMultiselectWidget
.parent
.call( this, $.extend( { inputPosition
: 'none' }, config
) );
4754 this.$overlay
= ( config
.$overlay
=== true ? OO
.ui
.getDefaultOverlay() : config
.$overlay
) || this.$element
;
4756 if ( !config
.popup
) {
4757 // For the default base implementation, we give a popup
4758 // with an input widget inside it. For any other use cases
4759 // the popup needs to be populated externally and the
4760 // event handled to add tags separately and manually
4761 defaultInput
= new OO
.ui
.TextInputWidget();
4763 defaultConfig
.popupInput
= defaultInput
;
4764 defaultConfig
.popup
.$content
= defaultInput
.$element
;
4765 defaultConfig
.popup
.padded
= true;
4767 this.$element
.addClass( 'oo-ui-popupTagMultiselectWidget-defaultPopup' );
4770 // Add overlay, and add that to the autoCloseIgnore
4771 defaultConfig
.popup
.$overlay
= this.$overlay
;
4772 defaultConfig
.popup
.$autoCloseIgnore
= this.hasInput
?
4773 this.input
.$element
.add( this.$overlay
) : this.$overlay
;
4775 // Allow extending any of the above
4776 config
= $.extend( defaultConfig
, config
);
4778 // Mixin constructors
4779 OO
.ui
.mixin
.PopupElement
.call( this, config
);
4781 if ( this.hasInput
) {
4782 this.input
.$input
.on( 'focus', this.popup
.toggle
.bind( this.popup
, true ) );
4785 // Configuration options
4786 this.popupInput
= config
.popupInput
;
4787 if ( this.popupInput
) {
4788 this.popupInput
.connect( this, {
4789 enter
: 'onPopupInputEnter'
4794 this.on( 'resize', this.popup
.updateDimensions
.bind( this.popup
) );
4795 this.popup
.connect( this, { toggle
: 'onPopupToggle' } );
4797 .on( 'focus', this.onFocus
.bind( this ) );
4801 .append( this.popup
.$element
)
4802 .addClass( 'oo-ui-popupTagMultiselectWidget' );
4805 /* Initialization */
4807 OO
.inheritClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
4808 OO
.mixinClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.mixin
.PopupElement
);
4813 * Focus event handler.
4817 OO
.ui
.PopupTagMultiselectWidget
.prototype.onFocus = function () {
4818 this.popup
.toggle( true );
4822 * Respond to popup toggle event
4824 * @param {boolean} isVisible Popup is visible
4826 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupToggle = function ( isVisible
) {
4827 if ( isVisible
&& this.popupInput
) {
4828 this.popupInput
.focus();
4833 * Respond to popup input enter event
4835 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupInputEnter = function () {
4836 if ( this.popupInput
) {
4837 this.addTagByPopupValue( this.popupInput
.getValue() );
4838 this.popupInput
.setValue( '' );
4845 OO
.ui
.PopupTagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
4846 if ( this.popupInput
&& this.allowEditTags
) {
4847 this.popupInput
.setValue( item
.getData() );
4848 this.removeItems( [ item
] );
4850 this.popup
.toggle( true );
4851 this.popupInput
.focus();
4854 OO
.ui
.PopupTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, item
);
4859 * Add a tag by the popup value.
4860 * Whatever is responsible for setting the value in the popup should call
4861 * this method to add a tag, or use the regular methods like #addTag or
4862 * #setValue directly.
4864 * @param {string} data The value of item
4865 * @param {string} [label] The label of the tag. If not given, the data is used.
4867 OO
.ui
.PopupTagMultiselectWidget
.prototype.addTagByPopupValue = function ( data
, label
) {
4868 this.addTag( data
, label
);
4872 * MenuTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
4873 * to use a menu of selectable options.
4876 * // Example: A basic MenuTagMultiselectWidget.
4877 * var widget = new OO.ui.MenuTagMultiselectWidget( {
4878 * inputPosition: 'outline',
4880 * { data: 'option1', label: 'Option 1', icon: 'tag' },
4881 * { data: 'option2', label: 'Option 2' },
4882 * { data: 'option3', label: 'Option 3' },
4884 * selected: [ 'option1', 'option2' ]
4886 * $( 'body' ).append( widget.$element );
4889 * @extends OO.ui.TagMultiselectWidget
4892 * @param {Object} [config] Configuration object
4893 * @cfg {boolean} [clearInputOnChoose=true] Clear the text input value when a menu option is chosen
4894 * @cfg {Object} [menu] Configuration object for the menu widget
4895 * @cfg {jQuery} [$overlay] An overlay for the menu.
4896 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
4897 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
4899 OO
.ui
.MenuTagMultiselectWidget
= function OoUiMenuTagMultiselectWidget( config
) {
4900 config
= config
|| {};
4902 // Parent constructor
4903 OO
.ui
.MenuTagMultiselectWidget
.parent
.call( this, config
);
4905 this.$overlay
= ( config
.$overlay
=== true ? OO
.ui
.getDefaultOverlay() : config
.$overlay
) || this.$element
;
4906 this.clearInputOnChoose
= config
.clearInputOnChoose
=== undefined || !!config
.clearInputOnChoose
;
4907 this.menu
= this.createMenuWidget( $.extend( {
4909 input
: this.hasInput
? this.input
: null,
4910 $input
: this.hasInput
? this.input
.$input
: null,
4911 filterFromInput
: !!this.hasInput
,
4912 $autoCloseIgnore
: this.hasInput
?
4913 this.input
.$element
: $( [] ),
4914 $floatableContainer
: this.hasInput
&& this.inputPosition
=== 'outline' ?
4915 this.input
.$element
: this.$element
,
4916 $overlay
: this.$overlay
,
4917 disabled
: this.isDisabled()
4919 this.addOptions( config
.options
|| [] );
4922 this.menu
.connect( this, {
4923 choose
: 'onMenuChoose',
4924 toggle
: 'onMenuToggle'
4926 if ( this.hasInput
) {
4927 this.input
.connect( this, { change
: 'onInputChange' } );
4929 this.connect( this, { resize
: 'onResize' } );
4933 .append( this.menu
.$element
);
4935 .addClass( 'oo-ui-menuTagMultiselectWidget' );
4936 // TagMultiselectWidget already does this, but it doesn't work right because this.menu is not yet
4937 // set up while the parent constructor runs, and #getAllowedValues rejects everything.
4938 if ( config
.selected
) {
4939 this.setValue( config
.selected
);
4943 /* Initialization */
4945 OO
.inheritClass( OO
.ui
.MenuTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
4950 * Respond to resize event
4952 OO
.ui
.MenuTagMultiselectWidget
.prototype.onResize = function () {
4953 // Reposition the menu
4954 this.menu
.position();
4960 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputFocus = function () {
4962 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
4964 this.menu
.toggle( true );
4968 * Respond to input change event
4970 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputChange = function () {
4971 this.menu
.toggle( true );
4972 this.initializeMenuSelection();
4976 * Respond to menu choose event
4978 * @param {OO.ui.OptionWidget} menuItem Chosen menu item
4980 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuChoose = function ( menuItem
) {
4982 this.addTag( menuItem
.getData(), menuItem
.getLabel() );
4983 if ( this.hasInput
&& this.clearInputOnChoose
) {
4984 this.input
.setValue( '' );
4989 * Respond to menu toggle event. Reset item highlights on hide.
4991 * @param {boolean} isVisible The menu is visible
4993 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
4995 this.menu
.selectItem( null );
4996 this.menu
.highlightItem( null );
4998 this.initializeMenuSelection();
5005 OO
.ui
.MenuTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
5006 var menuItem
= this.menu
.findItemFromData( tagItem
.getData() );
5007 if ( !this.allowArbitrary
) {
5008 // Override the base behavior from TagMultiselectWidget; the base behavior
5009 // in TagMultiselectWidget is to remove the tag to edit it in the input,
5010 // but in our case, we want to utilize the menu selection behavior, and
5011 // definitely not remove the item.
5013 // If there is an input that is used for filtering, erase the value so we don't filter
5014 if ( this.hasInput
&& this.menu
.filterFromInput
) {
5015 this.input
.setValue( '' );
5018 // Select the menu item
5019 this.menu
.selectItem( menuItem
);
5024 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, tagItem
);
5031 OO
.ui
.MenuTagMultiselectWidget
.prototype.setDisabled = function ( isDisabled
) {
5033 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.setDisabled
.call( this, isDisabled
);
5036 // Protect against calling setDisabled() before the menu was initialized
5037 this.menu
.setDisabled( isDisabled
);
5042 * Highlight the first selectable item in the menu, if configured.
5047 OO
.ui
.MenuTagMultiselectWidget
.prototype.initializeMenuSelection = function () {
5048 if ( !this.menu
.findSelectedItem() ) {
5049 this.menu
.highlightItem( this.menu
.findFirstSelectableItem() );
5056 OO
.ui
.MenuTagMultiselectWidget
.prototype.addTagFromInput = function () {
5057 var inputValue
= this.input
.getValue(),
5059 highlightedItem
= this.menu
.findHighlightedItem(),
5060 item
= this.menu
.findItemFromData( inputValue
);
5062 if ( !inputValue
) {
5066 // Override the parent method so we add from the menu
5067 // rather than directly from the input
5069 // Look for a highlighted item first
5070 if ( highlightedItem
) {
5071 validated
= this.addTag( highlightedItem
.getData(), highlightedItem
.getLabel() );
5072 } else if ( item
) {
5073 // Look for the element that fits the data
5074 validated
= this.addTag( item
.getData(), item
.getLabel() );
5076 // Otherwise, add the tag - the method will only add if the
5077 // tag is valid or if invalid tags are allowed
5078 validated
= this.addTag( inputValue
);
5088 * Return the visible items in the menu. This is mainly used for when
5089 * the menu is filtering results.
5091 * @return {OO.ui.MenuOptionWidget[]} Visible results
5093 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenuVisibleItems = function () {
5094 return this.menu
.getItems().filter( function ( menuItem
) {
5095 return menuItem
.isVisible();
5100 * Create the menu for this widget. This is in a separate method so that
5101 * child classes can override this without polluting the constructor with
5102 * unnecessary extra objects that will be overidden.
5104 * @param {Object} menuConfig Configuration options
5105 * @return {OO.ui.MenuSelectWidget} Menu widget
5107 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
5108 return new OO
.ui
.MenuSelectWidget( menuConfig
);
5112 * Add options to the menu
5114 * @param {Object[]} menuOptions Object defining options
5116 OO
.ui
.MenuTagMultiselectWidget
.prototype.addOptions = function ( menuOptions
) {
5118 items
= menuOptions
.map( function ( obj
) {
5119 return widget
.createMenuOptionWidget( obj
.data
, obj
.label
, obj
.icon
);
5122 this.menu
.addItems( items
);
5126 * Create a menu option widget.
5128 * @param {string} data Item data
5129 * @param {string} [label] Item label
5130 * @param {string} [icon] Symbolic icon name
5131 * @return {OO.ui.OptionWidget} Option widget
5133 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuOptionWidget = function ( data
, label
, icon
) {
5134 return new OO
.ui
.MenuOptionWidget( {
5136 label
: label
|| data
,
5144 * @return {OO.ui.MenuSelectWidget} Menu
5146 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenu = function () {
5151 * Get the allowed values list
5153 * @return {string[]} Allowed data values
5155 OO
.ui
.MenuTagMultiselectWidget
.prototype.getAllowedValues = function () {
5158 // If the parent constructor is calling us, we're not ready yet, this.menu is not set up.
5159 menuDatas
= this.menu
.getItems().map( function ( menuItem
) {
5160 return menuItem
.getData();
5163 return this.allowedValues
.concat( menuDatas
);
5167 * SelectFileWidgets allow for selecting files, using the HTML5 File API. These
5168 * widgets can be configured with {@link OO.ui.mixin.IconElement icons} and {@link
5169 * OO.ui.mixin.IndicatorElement indicators}.
5170 * Please see the [OOUI documentation on MediaWiki] [1] for more information and examples.
5173 * // Example of a file select widget
5174 * var selectFile = new OO.ui.SelectFileWidget();
5175 * $( 'body' ).append( selectFile.$element );
5177 * [1]: https://www.mediawiki.org/wiki/OOUI/Widgets
5180 * @extends OO.ui.Widget
5181 * @mixins OO.ui.mixin.IconElement
5182 * @mixins OO.ui.mixin.IndicatorElement
5183 * @mixins OO.ui.mixin.PendingElement
5184 * @mixins OO.ui.mixin.LabelElement
5187 * @param {Object} [config] Configuration options
5188 * @cfg {string[]|null} [accept=null] MIME types to accept. null accepts all types.
5189 * @cfg {string} [placeholder] Text to display when no file is selected.
5190 * @cfg {string} [notsupported] Text to display when file support is missing in the browser.
5191 * @cfg {boolean} [droppable=true] Whether to accept files by drag and drop.
5192 * @cfg {boolean} [showDropTarget=false] Whether to show a drop target. Requires droppable to be true.
5193 * @cfg {number} [thumbnailSizeLimit=20] File size limit in MiB above which to not try and show a
5194 * preview (for performance)
5196 OO
.ui
.SelectFileWidget
= function OoUiSelectFileWidget( config
) {
5199 // Configuration initialization
5200 config
= $.extend( {
5202 placeholder
: OO
.ui
.msg( 'ooui-selectfile-placeholder' ),
5203 notsupported
: OO
.ui
.msg( 'ooui-selectfile-not-supported' ),
5205 showDropTarget
: false,
5206 thumbnailSizeLimit
: 20
5209 // Parent constructor
5210 OO
.ui
.SelectFileWidget
.parent
.call( this, config
);
5212 // Mixin constructors
5213 OO
.ui
.mixin
.IconElement
.call( this, config
);
5214 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
5215 OO
.ui
.mixin
.PendingElement
.call( this, $.extend( {}, config
, { $pending
: this.$info
} ) );
5216 OO
.ui
.mixin
.LabelElement
.call( this, config
);
5219 this.$info
= $( '<span>' );
5220 this.showDropTarget
= config
.showDropTarget
;
5221 this.thumbnailSizeLimit
= config
.thumbnailSizeLimit
;
5222 this.isSupported
= this.constructor.static.isSupported();
5223 this.currentFile
= null;
5224 if ( Array
.isArray( config
.accept
) ) {
5225 this.accept
= config
.accept
;
5229 this.placeholder
= config
.placeholder
;
5230 this.notsupported
= config
.notsupported
;
5231 this.onFileSelectedHandler
= this.onFileSelected
.bind( this );
5233 this.selectButton
= new OO
.ui
.ButtonWidget( {
5234 $element
: $( '<label>' ),
5235 classes
: [ 'oo-ui-selectFileWidget-selectButton' ],
5236 label
: OO
.ui
.msg( 'ooui-selectfile-button-select' ),
5237 disabled
: this.disabled
|| !this.isSupported
5240 this.clearButton
= new OO
.ui
.ButtonWidget( {
5241 classes
: [ 'oo-ui-selectFileWidget-clearButton' ],
5244 disabled
: this.disabled
5248 this.selectButton
.$button
.on( {
5249 keypress
: this.onKeyPress
.bind( this )
5251 this.clearButton
.connect( this, {
5252 click
: 'onClearClick'
5254 if ( config
.droppable
) {
5255 dragHandler
= this.onDragEnterOrOver
.bind( this );
5257 dragenter
: dragHandler
,
5258 dragover
: dragHandler
,
5259 dragleave
: this.onDragLeave
.bind( this ),
5260 drop
: this.onDrop
.bind( this )
5266 this.$label
.addClass( 'oo-ui-selectFileWidget-label' );
5268 .addClass( 'oo-ui-selectFileWidget-info' )
5269 .append( this.$icon
, this.$label
, this.clearButton
.$element
, this.$indicator
);
5271 if ( config
.droppable
&& config
.showDropTarget
) {
5272 this.selectButton
.setIcon( 'upload' );
5273 this.$thumbnail
= $( '<div>' ).addClass( 'oo-ui-selectFileWidget-thumbnail' );
5274 this.setPendingElement( this.$thumbnail
);
5276 .addClass( 'oo-ui-selectFileWidget-dropTarget oo-ui-selectFileWidget' )
5278 click
: this.onDropTargetClick
.bind( this )
5283 this.selectButton
.$element
,
5285 .addClass( 'oo-ui-selectFileWidget-dropLabel' )
5286 .text( OO
.ui
.msg( 'ooui-selectfile-dragdrop-placeholder' ) )
5290 .addClass( 'oo-ui-selectFileWidget' )
5291 .append( this.$info
, this.selectButton
.$element
);
5298 OO
.inheritClass( OO
.ui
.SelectFileWidget
, OO
.ui
.Widget
);
5299 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IconElement
);
5300 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IndicatorElement
);
5301 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.PendingElement
);
5302 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.LabelElement
);
5304 /* Static Properties */
5307 * Check if this widget is supported
5312 OO
.ui
.SelectFileWidget
.static.isSupported = function () {
5314 if ( OO
.ui
.SelectFileWidget
.static.isSupportedCache
=== null ) {
5315 $input
= $( '<input>' ).attr( 'type', 'file' );
5316 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= $input
[ 0 ].files
!== undefined;
5318 return OO
.ui
.SelectFileWidget
.static.isSupportedCache
;
5321 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= null;
5328 * A change event is emitted when the on/off state of the toggle changes.
5330 * @param {File|null} value New value
5336 * Get the current value of the field
5338 * @return {File|null}
5340 OO
.ui
.SelectFileWidget
.prototype.getValue = function () {
5341 return this.currentFile
;
5345 * Set the current value of the field
5347 * @param {File|null} file File to select
5349 OO
.ui
.SelectFileWidget
.prototype.setValue = function ( file
) {
5350 if ( this.currentFile
!== file
) {
5351 this.currentFile
= file
;
5353 this.emit( 'change', this.currentFile
);
5360 * Focusses the select file button.
5364 OO
.ui
.SelectFileWidget
.prototype.focus = function () {
5365 this.selectButton
.focus();
5374 OO
.ui
.SelectFileWidget
.prototype.blur = function () {
5375 this.selectButton
.blur();
5382 OO
.ui
.SelectFileWidget
.prototype.simulateLabelClick = function () {
5387 * Update the user interface when a file is selected or unselected
5391 OO
.ui
.SelectFileWidget
.prototype.updateUI = function () {
5393 if ( !this.isSupported
) {
5394 this.$element
.addClass( 'oo-ui-selectFileWidget-notsupported' );
5395 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
5396 this.setLabel( this.notsupported
);
5398 this.$element
.addClass( 'oo-ui-selectFileWidget-supported' );
5399 if ( this.currentFile
) {
5400 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
5402 $label
= $label
.add(
5404 .addClass( 'oo-ui-selectFileWidget-fileName' )
5405 .text( this.currentFile
.name
)
5407 this.setLabel( $label
);
5409 if ( this.showDropTarget
) {
5411 this.loadAndGetImageUrl().done( function ( url
) {
5412 this.$thumbnail
.css( 'background-image', 'url( ' + url
+ ' )' );
5413 }.bind( this ) ).fail( function () {
5414 this.$thumbnail
.append(
5415 new OO
.ui
.IconWidget( {
5417 classes
: [ 'oo-ui-selectFileWidget-noThumbnail-icon' ]
5420 }.bind( this ) ).always( function () {
5423 this.$element
.off( 'click' );
5426 if ( this.showDropTarget
) {
5427 this.$element
.off( 'click' );
5429 click
: this.onDropTargetClick
.bind( this )
5433 .css( 'background-image', '' );
5435 this.$element
.addClass( 'oo-ui-selectFileWidget-empty' );
5436 this.setLabel( this.placeholder
);
5442 * If the selected file is an image, get its URL and load it.
5444 * @return {jQuery.Promise} Promise resolves with the image URL after it has loaded
5446 OO
.ui
.SelectFileWidget
.prototype.loadAndGetImageUrl = function () {
5447 var deferred
= $.Deferred(),
5448 file
= this.currentFile
,
5449 reader
= new FileReader();
5453 ( OO
.getProp( file
, 'type' ) || '' ).indexOf( 'image/' ) === 0 &&
5454 file
.size
< this.thumbnailSizeLimit
* 1024 * 1024
5456 reader
.onload = function ( event
) {
5457 var img
= document
.createElement( 'img' );
5458 img
.addEventListener( 'load', function () {
5460 img
.naturalWidth
=== 0 ||
5461 img
.naturalHeight
=== 0 ||
5462 img
.complete
=== false
5466 deferred
.resolve( event
.target
.result
);
5469 img
.src
= event
.target
.result
;
5471 reader
.readAsDataURL( file
);
5476 return deferred
.promise();
5480 * Add the input to the widget
5484 OO
.ui
.SelectFileWidget
.prototype.addInput = function () {
5485 if ( this.$input
) {
5486 this.$input
.remove();
5489 if ( !this.isSupported
) {
5494 this.$input
= $( '<input>' ).attr( 'type', 'file' );
5495 this.$input
.on( 'change', this.onFileSelectedHandler
);
5496 this.$input
.on( 'click', function ( e
) {
5497 // Prevents dropTarget to get clicked which calls
5498 // a click on this input
5499 e
.stopPropagation();
5504 if ( this.accept
) {
5505 this.$input
.attr( 'accept', this.accept
.join( ', ' ) );
5507 this.selectButton
.$button
.append( this.$input
);
5511 * Determine if we should accept this file
5514 * @param {string} mimeType File MIME type
5517 OO
.ui
.SelectFileWidget
.prototype.isAllowedType = function ( mimeType
) {
5520 if ( !this.accept
|| !mimeType
) {
5524 for ( i
= 0; i
< this.accept
.length
; i
++ ) {
5525 mimeTest
= this.accept
[ i
];
5526 if ( mimeTest
=== mimeType
) {
5528 } else if ( mimeTest
.substr( -2 ) === '/*' ) {
5529 mimeTest
= mimeTest
.substr( 0, mimeTest
.length
- 1 );
5530 if ( mimeType
.substr( 0, mimeTest
.length
) === mimeTest
) {
5540 * Handle file selection from the input
5543 * @param {jQuery.Event} e
5545 OO
.ui
.SelectFileWidget
.prototype.onFileSelected = function ( e
) {
5546 var file
= OO
.getProp( e
.target
, 'files', 0 ) || null;
5548 if ( file
&& !this.isAllowedType( file
.type
) ) {
5552 this.setValue( file
);
5557 * Handle clear button click events.
5561 OO
.ui
.SelectFileWidget
.prototype.onClearClick = function () {
5562 this.setValue( null );
5567 * Handle key press events.
5570 * @param {jQuery.Event} e Key press event
5572 OO
.ui
.SelectFileWidget
.prototype.onKeyPress = function ( e
) {
5573 if ( this.isSupported
&& !this.isDisabled() && this.$input
&&
5574 ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
5576 this.$input
.click();
5582 * Handle drop target click events.
5585 * @param {jQuery.Event} e Key press event
5587 OO
.ui
.SelectFileWidget
.prototype.onDropTargetClick = function () {
5588 if ( this.isSupported
&& !this.isDisabled() && this.$input
) {
5589 this.$input
.click();
5595 * Handle drag enter and over events
5598 * @param {jQuery.Event} e Drag event
5600 OO
.ui
.SelectFileWidget
.prototype.onDragEnterOrOver = function ( e
) {
5602 droppableFile
= false,
5603 dt
= e
.originalEvent
.dataTransfer
;
5606 e
.stopPropagation();
5608 if ( this.isDisabled() || !this.isSupported
) {
5609 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
5610 dt
.dropEffect
= 'none';
5614 // DataTransferItem and File both have a type property, but in Chrome files
5615 // have no information at this point.
5616 itemOrFile
= OO
.getProp( dt
, 'items', 0 ) || OO
.getProp( dt
, 'files', 0 );
5618 if ( this.isAllowedType( itemOrFile
.type
) ) {
5619 droppableFile
= true;
5621 // dt.types is Array-like, but not an Array
5622 } else if ( Array
.prototype.indexOf
.call( OO
.getProp( dt
, 'types' ) || [], 'Files' ) !== -1 ) {
5623 // File information is not available at this point for security so just assume
5624 // it is acceptable for now.
5625 // https://bugzilla.mozilla.org/show_bug.cgi?id=640534
5626 droppableFile
= true;
5629 this.$element
.toggleClass( 'oo-ui-selectFileWidget-canDrop', droppableFile
);
5630 if ( !droppableFile
) {
5631 dt
.dropEffect
= 'none';
5638 * Handle drag leave events
5641 * @param {jQuery.Event} e Drag event
5643 OO
.ui
.SelectFileWidget
.prototype.onDragLeave = function () {
5644 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
5648 * Handle drop events
5651 * @param {jQuery.Event} e Drop event
5653 OO
.ui
.SelectFileWidget
.prototype.onDrop = function ( e
) {
5655 dt
= e
.originalEvent
.dataTransfer
;
5658 e
.stopPropagation();
5659 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
5661 if ( this.isDisabled() || !this.isSupported
) {
5665 file
= OO
.getProp( dt
, 'files', 0 );
5666 if ( file
&& !this.isAllowedType( file
.type
) ) {
5670 this.setValue( file
);
5679 OO
.ui
.SelectFileWidget
.prototype.setDisabled = function ( disabled
) {
5680 OO
.ui
.SelectFileWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
5681 if ( this.selectButton
) {
5682 this.selectButton
.setDisabled( disabled
);
5684 if ( this.clearButton
) {
5685 this.clearButton
.setDisabled( disabled
);
5691 * SearchWidgets combine a {@link OO.ui.TextInputWidget text input field}, where users can type a search query,
5692 * and a menu of search results, which is displayed beneath the query
5693 * field. Unlike {@link OO.ui.mixin.LookupElement lookup menus}, search result menus are always visible to the user.
5694 * Users can choose an item from the menu or type a query into the text field to search for a matching result item.
5695 * In general, search widgets are used inside a separate {@link OO.ui.Dialog dialog} window.
5697 * Each time the query is changed, the search result menu is cleared and repopulated. Please see
5698 * the [OOUI demos][1] for an example.
5700 * [1]: https://doc.wikimedia.org/oojs-ui/master/demos/#SearchInputWidget-type-search
5703 * @extends OO.ui.Widget
5706 * @param {Object} [config] Configuration options
5707 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
5708 * @cfg {string} [value] Initial query value
5710 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
5711 // Configuration initialization
5712 config
= config
|| {};
5714 // Parent constructor
5715 OO
.ui
.SearchWidget
.parent
.call( this, config
);
5718 this.query
= new OO
.ui
.TextInputWidget( {
5720 placeholder
: config
.placeholder
,
5723 this.results
= new OO
.ui
.SelectWidget();
5724 this.$query
= $( '<div>' );
5725 this.$results
= $( '<div>' );
5728 this.query
.connect( this, {
5729 change
: 'onQueryChange',
5730 enter
: 'onQueryEnter'
5732 this.query
.$input
.on( 'keydown', this.onQueryKeydown
.bind( this ) );
5736 .addClass( 'oo-ui-searchWidget-query' )
5737 .append( this.query
.$element
);
5739 .addClass( 'oo-ui-searchWidget-results' )
5740 .append( this.results
.$element
);
5742 .addClass( 'oo-ui-searchWidget' )
5743 .append( this.$results
, this.$query
);
5748 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
5753 * Handle query key down events.
5756 * @param {jQuery.Event} e Key down event
5758 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
5759 var highlightedItem
, nextItem
,
5760 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
5763 highlightedItem
= this.results
.findHighlightedItem();
5764 if ( !highlightedItem
) {
5765 highlightedItem
= this.results
.findSelectedItem();
5767 nextItem
= this.results
.findRelativeSelectableItem( highlightedItem
, dir
);
5768 this.results
.highlightItem( nextItem
);
5769 nextItem
.scrollElementIntoView();
5774 * Handle select widget select events.
5776 * Clears existing results. Subclasses should repopulate items according to new query.
5779 * @param {string} value New value
5781 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
5783 this.results
.clearItems();
5787 * Handle select widget enter key events.
5789 * Chooses highlighted item.
5792 * @param {string} value New value
5794 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
5795 var highlightedItem
= this.results
.findHighlightedItem();
5796 if ( highlightedItem
) {
5797 this.results
.chooseItem( highlightedItem
);
5802 * Get the query input.
5804 * @return {OO.ui.TextInputWidget} Query input
5806 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
5811 * Get the search results menu.
5813 * @return {OO.ui.SelectWidget} Menu of search results
5815 OO
.ui
.SearchWidget
.prototype.getResults = function () {
5816 return this.results
;
5821 //# sourceMappingURL=oojs-ui-widgets.js.map.json