3 * https://www.mediawiki.org/wiki/OOjs_UI
5 * Copyright 2011–2017 OOjs UI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
9 * Date: 2017-09-20T00:31:56Z
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/OOjs-UI-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 .append( this.$status
)
283 .toggleClass( 'oo-ui-draggableGroupElement-horizontal', this.orientation
=== 'horizontal' );
287 OO
.mixinClass( OO
.ui
.mixin
.DraggableGroupElement
, OO
.ui
.mixin
.GroupElement
);
292 * An item has been dragged to a new position, but not yet dropped.
295 * @param {OO.ui.mixin.DraggableElement} item Dragged item
296 * @param {number} [newIndex] New index for the item
300 * An item has been dropped at a new position.
303 * @param {OO.ui.mixin.DraggableElement} item Reordered item
304 * @param {number} [newIndex] New index for the item
308 * Draggable state of this widget has changed.
311 * @param {boolean} [draggable] Widget is draggable
317 * Change the draggable state of this widget.
318 * This allows users to temporarily halt the dragging operations.
320 * @param {boolean} isDraggable Widget supports draggable operations
323 OO
.ui
.mixin
.DraggableGroupElement
.prototype.toggleDraggable = function ( isDraggable
) {
324 isDraggable
= isDraggable
!== undefined ? !!isDraggable
: !this.draggable
;
326 if ( this.draggable
!== isDraggable
) {
327 this.draggable
= isDraggable
;
329 // Tell the items their draggable state changed
330 this.getItems().forEach( function ( item
) {
331 item
.toggleDraggable( this.draggable
);
335 this.emit( 'draggable', this.draggable
);
340 * Check the draggable state of this widget
342 * @return {boolean} Widget supports draggable operations
344 OO
.ui
.mixin
.DraggableGroupElement
.prototype.isDraggable = function () {
345 return this.draggable
;
349 * Respond to item drag start event
352 * @param {OO.ui.mixin.DraggableElement} item Dragged item
354 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onItemDragStart = function ( item
) {
355 if ( !this.isDraggable() ) {
358 // Make a shallow copy of this.items so we can re-order it during previews
359 // without affecting the original array.
360 this.itemsOrder
= this.items
.slice();
361 this.updateIndexes();
362 if ( this.orientation
=== 'horizontal' ) {
363 // Calculate and cache directionality on drag start - it's a little
364 // expensive and it shouldn't change while dragging.
365 this.dir
= this.$element
.css( 'direction' );
367 this.setDragItem( item
);
371 * Update the index properties of the items
373 OO
.ui
.mixin
.DraggableGroupElement
.prototype.updateIndexes = function () {
376 // Map the index of each object
377 for ( i
= 0, len
= this.itemsOrder
.length
; i
< len
; i
++ ) {
378 this.itemsOrder
[ i
].setIndex( i
);
383 * Handle drop or dragend event and switch the order of the items accordingly
386 * @param {OO.ui.mixin.DraggableElement} item Dropped item
388 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onItemDropOrDragEnd = function () {
389 var targetIndex
, originalIndex
,
390 item
= this.getDragItem();
392 // TODO: Figure out a way to configure a list of legally droppable
393 // elements even if they are not yet in the list
395 originalIndex
= this.items
.indexOf( item
);
396 // If the item has moved forward, add one to the index to account for the left shift
397 targetIndex
= item
.getIndex() + ( item
.getIndex() > originalIndex
? 1 : 0 );
398 if ( targetIndex
!== originalIndex
) {
399 this.reorder( this.getDragItem(), targetIndex
);
400 this.emit( 'reorder', this.getDragItem(), targetIndex
);
402 this.updateIndexes();
404 this.unsetDragItem();
405 // Return false to prevent propogation
410 * Respond to dragover event
413 * @param {jQuery.Event} e Dragover event
416 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onDragOver = function ( e
) {
417 var overIndex
, targetIndex
,
418 item
= this.getDragItem(),
419 dragItemIndex
= item
.getIndex();
421 // Get the OptionWidget item we are dragging over
422 overIndex
= $( e
.target
).closest( '.oo-ui-draggableElement' ).data( 'index' );
424 if ( overIndex
!== undefined && overIndex
!== dragItemIndex
) {
425 targetIndex
= overIndex
+ ( overIndex
> dragItemIndex
? 1 : 0 );
427 if ( targetIndex
> 0 ) {
428 this.$group
.children().eq( targetIndex
- 1 ).after( item
.$element
);
430 this.$group
.prepend( item
.$element
);
432 // Move item in itemsOrder array
433 this.itemsOrder
.splice( overIndex
, 0,
434 this.itemsOrder
.splice( dragItemIndex
, 1 )[ 0 ]
436 this.updateIndexes();
437 this.emit( 'drag', item
, targetIndex
);
444 * Reorder the items in the group
446 * @param {OO.ui.mixin.DraggableElement} item Reordered item
447 * @param {number} newIndex New index
449 OO
.ui
.mixin
.DraggableGroupElement
.prototype.reorder = function ( item
, newIndex
) {
450 this.addItems( [ item
], newIndex
);
456 * @param {OO.ui.mixin.DraggableElement} item Dragged item
458 OO
.ui
.mixin
.DraggableGroupElement
.prototype.setDragItem = function ( item
) {
459 if ( this.dragItem
!== item
) {
460 this.dragItem
= item
;
461 this.$element
.on( 'dragover', this.onDragOver
.bind( this ) );
462 this.$element
.addClass( 'oo-ui-draggableGroupElement-dragging' );
467 * Unset the current dragged item
469 OO
.ui
.mixin
.DraggableGroupElement
.prototype.unsetDragItem = function () {
470 if ( this.dragItem
) {
471 this.dragItem
= null;
472 this.$element
.off( 'dragover' );
473 this.$element
.removeClass( 'oo-ui-draggableGroupElement-dragging' );
478 * Get the item that is currently being dragged.
480 * @return {OO.ui.mixin.DraggableElement|null} The currently dragged item, or `null` if no item is being dragged
482 OO
.ui
.mixin
.DraggableGroupElement
.prototype.getDragItem = function () {
483 return this.dragItem
;
487 * RequestManager is a mixin that manages the lifecycle of a promise-backed request for a widget, such as
488 * the {@link OO.ui.mixin.LookupElement}.
495 OO
.ui
.mixin
.RequestManager
= function OoUiMixinRequestManager() {
496 this.requestCache
= {};
497 this.requestQuery
= null;
498 this.requestRequest
= null;
503 OO
.initClass( OO
.ui
.mixin
.RequestManager
);
506 * Get request results for the current query.
508 * @return {jQuery.Promise} Promise object which will be passed response data as the first argument of
509 * the done event. If the request was aborted to make way for a subsequent request, this promise
510 * may not be rejected, depending on what jQuery feels like doing.
512 OO
.ui
.mixin
.RequestManager
.prototype.getRequestData = function () {
514 value
= this.getRequestQuery(),
515 deferred
= $.Deferred(),
519 if ( Object
.prototype.hasOwnProperty
.call( this.requestCache
, value
) ) {
520 deferred
.resolve( this.requestCache
[ value
] );
522 if ( this.pushPending
) {
525 this.requestQuery
= value
;
526 ourRequest
= this.requestRequest
= this.getRequest();
528 .always( function () {
529 // We need to pop pending even if this is an old request, otherwise
530 // the widget will remain pending forever.
531 // TODO: this assumes that an aborted request will fail or succeed soon after
532 // being aborted, or at least eventually. It would be nice if we could popPending()
533 // at abort time, but only if we knew that we hadn't already called popPending()
535 if ( widget
.popPending
) {
539 .done( function ( response
) {
540 // If this is an old request (and aborting it somehow caused it to still succeed),
541 // ignore its success completely
542 if ( ourRequest
=== widget
.requestRequest
) {
543 widget
.requestQuery
= null;
544 widget
.requestRequest
= null;
545 widget
.requestCache
[ value
] = widget
.getRequestCacheDataFromResponse( response
);
546 deferred
.resolve( widget
.requestCache
[ value
] );
550 // If this is an old request (or a request failing because it's being aborted),
551 // ignore its failure completely
552 if ( ourRequest
=== widget
.requestRequest
) {
553 widget
.requestQuery
= null;
554 widget
.requestRequest
= null;
559 return deferred
.promise();
563 * Abort the currently pending request, if any.
567 OO
.ui
.mixin
.RequestManager
.prototype.abortRequest = function () {
568 var oldRequest
= this.requestRequest
;
570 // First unset this.requestRequest to the fail handler will notice
571 // that the request is no longer current
572 this.requestRequest
= null;
573 this.requestQuery
= null;
579 * Get the query to be made.
584 * @return {string} query to be used
586 OO
.ui
.mixin
.RequestManager
.prototype.getRequestQuery
= null;
589 * Get a new request object of the current query value.
594 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
596 OO
.ui
.mixin
.RequestManager
.prototype.getRequest
= null;
599 * Pre-process data returned by the request from #getRequest.
601 * The return value of this function will be cached, and any further queries for the given value
602 * will use the cache rather than doing API requests.
607 * @param {Mixed} response Response from server
608 * @return {Mixed} Cached result data
610 OO
.ui
.mixin
.RequestManager
.prototype.getRequestCacheDataFromResponse
= null;
613 * LookupElement is a mixin that creates a {@link OO.ui.MenuSelectWidget menu} of suggested values for
614 * a {@link OO.ui.TextInputWidget text input widget}. Suggested values are based on the characters the user types
615 * into the text input field and, in general, the menu is only displayed when the user types. If a suggested value is chosen
616 * from the lookup menu, that value becomes the value of the input field.
618 * Note that a new menu of suggested items is displayed when a value is chosen from the lookup menu. If this is
619 * not the desired behavior, disable lookup menus with the #setLookupsDisabled method, then set the value, then
622 * See the [OOjs UI demos][1] for an example.
624 * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/index.html#widgets-apex-vector-ltr
628 * @mixins OO.ui.mixin.RequestManager
631 * @param {Object} [config] Configuration options
632 * @cfg {jQuery} [$overlay] Overlay for the lookup menu; defaults to relative positioning.
633 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
634 * @cfg {jQuery} [$container=this.$element] The container element. The lookup menu is rendered beneath the specified element.
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
|| this.$element
;
649 this.lookupMenu
= new OO
.ui
.MenuSelectWidget( {
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();
856 * Highlight the first selectable item in the menu, if configured.
861 OO
.ui
.mixin
.LookupElement
.prototype.initializeLookupMenuSelection = function () {
862 if ( this.lookupHighlightFirstItem
&& !this.lookupMenu
.getSelectedItem() ) {
863 this.lookupMenu
.highlightItem( this.lookupMenu
.findFirstSelectableItem() );
868 * Get lookup menu items for the current query.
871 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument of
872 * the done event. If the request was aborted to make way for a subsequent request, this promise
873 * will not be rejected: it will remain pending forever.
875 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenuItems = function () {
876 return this.getRequestData().then( function ( data
) {
877 return this.getLookupMenuOptionsFromData( data
);
882 * Abort the currently pending lookup request, if any.
886 OO
.ui
.mixin
.LookupElement
.prototype.abortLookupRequest = function () {
891 * Get a new request object of the current lookup query value.
896 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
898 OO
.ui
.mixin
.LookupElement
.prototype.getLookupRequest
= null;
901 * Pre-process data returned by the request from #getLookupRequest.
903 * The return value of this function will be cached, and any further queries for the given value
904 * will use the cache rather than doing API requests.
909 * @param {Mixed} response Response from server
910 * @return {Mixed} Cached result data
912 OO
.ui
.mixin
.LookupElement
.prototype.getLookupCacheDataFromResponse
= null;
915 * Get a list of menu option widgets from the (possibly cached) data returned by
916 * #getLookupCacheDataFromResponse.
921 * @param {Mixed} data Cached result data, usually an array
922 * @return {OO.ui.MenuOptionWidget[]} Menu items
924 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenuOptionsFromData
= null;
927 * Set the read-only state of the widget.
929 * This will also disable/enable the lookups functionality.
931 * @param {boolean} readOnly Make input read-only
934 OO
.ui
.mixin
.LookupElement
.prototype.setReadOnly = function ( readOnly
) {
936 // Note: Calling #setReadOnly this way assumes this is mixed into an OO.ui.TextInputWidget
937 OO
.ui
.TextInputWidget
.prototype.setReadOnly
.call( this, readOnly
);
939 // During construction, #setReadOnly is called before the OO.ui.mixin.LookupElement constructor
940 if ( this.isReadOnly() && this.lookupMenu
) {
941 this.closeLookupMenu();
948 * @inheritdoc OO.ui.mixin.RequestManager
950 OO
.ui
.mixin
.LookupElement
.prototype.getRequestQuery = function () {
951 return this.getValue();
955 * @inheritdoc OO.ui.mixin.RequestManager
957 OO
.ui
.mixin
.LookupElement
.prototype.getRequest = function () {
958 return this.getLookupRequest();
962 * @inheritdoc OO.ui.mixin.RequestManager
964 OO
.ui
.mixin
.LookupElement
.prototype.getRequestCacheDataFromResponse = function ( response
) {
965 return this.getLookupCacheDataFromResponse( response
);
969 * TabPanelLayouts are used within {@link OO.ui.IndexLayout index layouts} to create tab panels that
970 * users can select and display from the index's optional {@link OO.ui.TabSelectWidget tab}
971 * navigation. TabPanels are usually not instantiated directly, rather extended to include the
972 * required content and functionality.
974 * Each tab panel must have a unique symbolic name, which is passed to the constructor. In addition,
975 * the tab panel's tab item is customized (with a label) using the #setupTabItem method. See
976 * {@link OO.ui.IndexLayout IndexLayout} for an example.
979 * @extends OO.ui.PanelLayout
982 * @param {string} name Unique symbolic name of tab panel
983 * @param {Object} [config] Configuration options
984 * @cfg {jQuery|string|Function|OO.ui.HtmlSnippet} [label] Label for tab panel's tab
986 OO
.ui
.TabPanelLayout
= function OoUiTabPanelLayout( name
, config
) {
987 // Allow passing positional parameters inside the config object
988 if ( OO
.isPlainObject( name
) && config
=== undefined ) {
993 // Configuration initialization
994 config
= $.extend( { scrollable
: true }, config
);
996 // Parent constructor
997 OO
.ui
.TabPanelLayout
.parent
.call( this, config
);
1001 this.label
= config
.label
;
1002 this.tabItem
= null;
1003 this.active
= false;
1006 this.$element
.addClass( 'oo-ui-tabPanelLayout' );
1011 OO
.inheritClass( OO
.ui
.TabPanelLayout
, OO
.ui
.PanelLayout
);
1016 * An 'active' event is emitted when the tab panel becomes active. Tab panels become active when they are
1017 * shown in a index layout that is configured to display only one tab panel at a time.
1020 * @param {boolean} active Tab panel is active
1026 * Get the symbolic name of the tab panel.
1028 * @return {string} Symbolic name of tab panel
1030 OO
.ui
.TabPanelLayout
.prototype.getName = function () {
1035 * Check if tab panel is active.
1037 * Tab panels become active when they are shown in a {@link OO.ui.IndexLayout index layout} that is configured to
1038 * display only one tab panel at a time. Additional CSS is applied to the tab panel's tab item to reflect the
1041 * @return {boolean} Tab panel is active
1043 OO
.ui
.TabPanelLayout
.prototype.isActive = function () {
1050 * The tab item allows users to access the tab panel from the index's tab
1051 * navigation. The tab item itself can be customized (with a label, level, etc.) using the #setupTabItem method.
1053 * @return {OO.ui.TabOptionWidget|null} Tab option widget
1055 OO
.ui
.TabPanelLayout
.prototype.getTabItem = function () {
1056 return this.tabItem
;
1060 * Set or unset the tab item.
1062 * Specify a {@link OO.ui.TabOptionWidget tab option} to set it,
1063 * or `null` to clear the tab item. To customize the tab item itself (e.g., to set a label or tab
1064 * level), use #setupTabItem instead of this method.
1066 * @param {OO.ui.TabOptionWidget|null} tabItem Tab option widget, null to clear
1069 OO
.ui
.TabPanelLayout
.prototype.setTabItem = function ( tabItem
) {
1070 this.tabItem
= tabItem
|| null;
1072 this.setupTabItem();
1078 * Set up the tab item.
1080 * Use this method to customize the tab item (e.g., to add a label or tab level). To set or unset
1081 * the tab item itself (with a {@link OO.ui.TabOptionWidget tab option} or `null`), use
1082 * the #setTabItem method instead.
1084 * @param {OO.ui.TabOptionWidget} tabItem Tab option widget to set up
1087 OO
.ui
.TabPanelLayout
.prototype.setupTabItem = function () {
1089 this.tabItem
.setLabel( this.label
);
1095 * Set the tab panel to its 'active' state.
1097 * Tab panels become active when they are shown in a index layout that is configured to display only
1098 * one tab panel at a time. Additional CSS is applied to the tab item to reflect the tab panel's
1099 * active state. Outside of the index context, setting the active state on a tab panel does nothing.
1101 * @param {boolean} active Tab panel is active
1104 OO
.ui
.TabPanelLayout
.prototype.setActive = function ( active
) {
1107 if ( active
!== this.active
) {
1108 this.active
= active
;
1109 this.$element
.toggleClass( 'oo-ui-tabPanelLayout-active', this.active
);
1110 this.emit( 'active', this.active
);
1115 * PageLayouts are used within {@link OO.ui.BookletLayout booklet layouts} to create pages that users can select and display
1116 * from the booklet's optional {@link OO.ui.OutlineSelectWidget outline} navigation. Pages are usually not instantiated directly,
1117 * rather extended to include the required content and functionality.
1119 * Each page must have a unique symbolic name, which is passed to the constructor. In addition, the page's outline
1120 * item is customized (with a label, outline level, etc.) using the #setupOutlineItem method. See
1121 * {@link OO.ui.BookletLayout BookletLayout} for an example.
1124 * @extends OO.ui.PanelLayout
1127 * @param {string} name Unique symbolic name of page
1128 * @param {Object} [config] Configuration options
1130 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
1131 // Allow passing positional parameters inside the config object
1132 if ( OO
.isPlainObject( name
) && config
=== undefined ) {
1137 // Configuration initialization
1138 config
= $.extend( { scrollable
: true }, config
);
1140 // Parent constructor
1141 OO
.ui
.PageLayout
.parent
.call( this, config
);
1145 this.outlineItem
= null;
1146 this.active
= false;
1149 this.$element
.addClass( 'oo-ui-pageLayout' );
1154 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
1159 * An 'active' event is emitted when the page becomes active. Pages become active when they are
1160 * shown in a booklet layout that is configured to display only one page at a time.
1163 * @param {boolean} active Page is active
1169 * Get the symbolic name of the page.
1171 * @return {string} Symbolic name of page
1173 OO
.ui
.PageLayout
.prototype.getName = function () {
1178 * Check if page is active.
1180 * Pages become active when they are shown in a {@link OO.ui.BookletLayout booklet layout} that is configured to display
1181 * only one page at a time. Additional CSS is applied to the page's outline item to reflect the active state.
1183 * @return {boolean} Page is active
1185 OO
.ui
.PageLayout
.prototype.isActive = function () {
1192 * The outline item allows users to access the page from the booklet's outline
1193 * navigation. The outline item itself can be customized (with a label, level, etc.) using the #setupOutlineItem method.
1195 * @return {OO.ui.OutlineOptionWidget|null} Outline option widget
1197 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
1198 return this.outlineItem
;
1202 * Set or unset the outline item.
1204 * Specify an {@link OO.ui.OutlineOptionWidget outline option} to set it,
1205 * or `null` to clear the outline item. To customize the outline item itself (e.g., to set a label or outline
1206 * level), use #setupOutlineItem instead of this method.
1208 * @param {OO.ui.OutlineOptionWidget|null} outlineItem Outline option widget, null to clear
1211 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
1212 this.outlineItem
= outlineItem
|| null;
1213 if ( outlineItem
) {
1214 this.setupOutlineItem();
1220 * Set up the outline item.
1222 * Use this method to customize the outline item (e.g., to add a label or outline level). To set or unset
1223 * the outline item itself (with an {@link OO.ui.OutlineOptionWidget outline option} or `null`), use
1224 * the #setOutlineItem method instead.
1226 * @param {OO.ui.OutlineOptionWidget} outlineItem Outline option widget to set up
1229 OO
.ui
.PageLayout
.prototype.setupOutlineItem = function () {
1234 * Set the page to its 'active' state.
1236 * Pages become active when they are shown in a booklet layout that is configured to display only one page at a time. Additional
1237 * CSS is applied to the outline item to reflect the page's active state. Outside of the booklet
1238 * context, setting the active state on a page does nothing.
1240 * @param {boolean} active Page is active
1243 OO
.ui
.PageLayout
.prototype.setActive = function ( active
) {
1246 if ( active
!== this.active
) {
1247 this.active
= active
;
1248 this.$element
.toggleClass( 'oo-ui-pageLayout-active', active
);
1249 this.emit( 'active', this.active
);
1254 * StackLayouts contain a series of {@link OO.ui.PanelLayout panel layouts}. By default, only one panel is displayed
1255 * at a time, though the stack layout can also be configured to show all contained panels, one after another,
1256 * by setting the #continuous option to 'true'.
1259 * // A stack layout with two panels, configured to be displayed continously
1260 * var myStack = new OO.ui.StackLayout( {
1262 * new OO.ui.PanelLayout( {
1263 * $content: $( '<p>Panel One</p>' ),
1267 * new OO.ui.PanelLayout( {
1268 * $content: $( '<p>Panel Two</p>' ),
1275 * $( 'body' ).append( myStack.$element );
1278 * @extends OO.ui.PanelLayout
1279 * @mixins OO.ui.mixin.GroupElement
1282 * @param {Object} [config] Configuration options
1283 * @cfg {boolean} [continuous=false] Show all panels, one after another. By default, only one panel is displayed at a time.
1284 * @cfg {OO.ui.Layout[]} [items] Panel layouts to add to the stack layout.
1286 OO
.ui
.StackLayout
= function OoUiStackLayout( config
) {
1287 // Configuration initialization
1288 config
= $.extend( { scrollable
: true }, config
);
1290 // Parent constructor
1291 OO
.ui
.StackLayout
.parent
.call( this, config
);
1293 // Mixin constructors
1294 OO
.ui
.mixin
.GroupElement
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
1297 this.currentItem
= null;
1298 this.continuous
= !!config
.continuous
;
1301 this.$element
.addClass( 'oo-ui-stackLayout' );
1302 if ( this.continuous
) {
1303 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
1304 this.$element
.on( 'scroll', OO
.ui
.debounce( this.onScroll
.bind( this ), 250 ) );
1306 if ( Array
.isArray( config
.items
) ) {
1307 this.addItems( config
.items
);
1313 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
1314 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.mixin
.GroupElement
);
1319 * A 'set' event is emitted when panels are {@link #addItems added}, {@link #removeItems removed},
1320 * {@link #clearItems cleared} or {@link #setItem displayed}.
1323 * @param {OO.ui.Layout|null} item Current panel or `null` if no panel is shown
1327 * When used in continuous mode, this event is emitted when the user scrolls down
1328 * far enough such that currentItem is no longer visible.
1330 * @event visibleItemChange
1331 * @param {OO.ui.PanelLayout} panel The next visible item in the layout
1337 * Handle scroll events from the layout element
1339 * @param {jQuery.Event} e
1340 * @fires visibleItemChange
1342 OO
.ui
.StackLayout
.prototype.onScroll = function () {
1344 len
= this.items
.length
,
1345 currentIndex
= this.items
.indexOf( this.currentItem
),
1346 newIndex
= currentIndex
,
1347 containerRect
= this.$element
[ 0 ].getBoundingClientRect();
1349 if ( !containerRect
|| ( !containerRect
.top
&& !containerRect
.bottom
) ) {
1350 // Can't get bounding rect, possibly not attached.
1354 function getRect( item
) {
1355 return item
.$element
[ 0 ].getBoundingClientRect();
1358 function isVisible( item
) {
1359 var rect
= getRect( item
);
1360 return rect
.bottom
> containerRect
.top
&& rect
.top
< containerRect
.bottom
;
1363 currentRect
= getRect( this.currentItem
);
1365 if ( currentRect
.bottom
< containerRect
.top
) {
1366 // Scrolled down past current item
1367 while ( ++newIndex
< len
) {
1368 if ( isVisible( this.items
[ newIndex
] ) ) {
1372 } else if ( currentRect
.top
> containerRect
.bottom
) {
1373 // Scrolled up past current item
1374 while ( --newIndex
>= 0 ) {
1375 if ( isVisible( this.items
[ newIndex
] ) ) {
1381 if ( newIndex
!== currentIndex
) {
1382 this.emit( 'visibleItemChange', this.items
[ newIndex
] );
1387 * Get the current panel.
1389 * @return {OO.ui.Layout|null}
1391 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
1392 return this.currentItem
;
1396 * Unset the current item.
1399 * @param {OO.ui.StackLayout} layout
1402 OO
.ui
.StackLayout
.prototype.unsetCurrentItem = function () {
1403 var prevItem
= this.currentItem
;
1404 if ( prevItem
=== null ) {
1408 this.currentItem
= null;
1409 this.emit( 'set', null );
1413 * Add panel layouts to the stack layout.
1415 * Panels will be added to the end of the stack layout array unless the optional index parameter specifies a different
1416 * insertion point. Adding a panel that is already in the stack will move it to the end of the array or the point specified
1419 * @param {OO.ui.Layout[]} items Panels to add
1420 * @param {number} [index] Index of the insertion point
1423 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
1424 // Update the visibility
1425 this.updateHiddenState( items
, this.currentItem
);
1428 OO
.ui
.mixin
.GroupElement
.prototype.addItems
.call( this, items
, index
);
1430 if ( !this.currentItem
&& items
.length
) {
1431 this.setItem( items
[ 0 ] );
1438 * Remove the specified panels from the stack layout.
1440 * Removed panels are detached from the DOM, not removed, so that they may be reused. To remove all panels,
1441 * you may wish to use the #clearItems method instead.
1443 * @param {OO.ui.Layout[]} items Panels to remove
1447 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
1449 OO
.ui
.mixin
.GroupElement
.prototype.removeItems
.call( this, items
);
1451 if ( items
.indexOf( this.currentItem
) !== -1 ) {
1452 if ( this.items
.length
) {
1453 this.setItem( this.items
[ 0 ] );
1455 this.unsetCurrentItem();
1463 * Clear all panels from the stack layout.
1465 * Cleared panels are detached from the DOM, not removed, so that they may be reused. To remove only
1466 * a subset of panels, use the #removeItems method.
1471 OO
.ui
.StackLayout
.prototype.clearItems = function () {
1472 this.unsetCurrentItem();
1473 OO
.ui
.mixin
.GroupElement
.prototype.clearItems
.call( this );
1479 * Show the specified panel.
1481 * If another panel is currently displayed, it will be hidden.
1483 * @param {OO.ui.Layout} item Panel to show
1487 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
1488 if ( item
!== this.currentItem
) {
1489 this.updateHiddenState( this.items
, item
);
1491 if ( this.items
.indexOf( item
) !== -1 ) {
1492 this.currentItem
= item
;
1493 this.emit( 'set', item
);
1495 this.unsetCurrentItem();
1503 * Update the visibility of all items in case of non-continuous view.
1505 * Ensure all items are hidden except for the selected one.
1506 * This method does nothing when the stack is continuous.
1509 * @param {OO.ui.Layout[]} items Item list iterate over
1510 * @param {OO.ui.Layout} [selectedItem] Selected item to show
1512 OO
.ui
.StackLayout
.prototype.updateHiddenState = function ( items
, selectedItem
) {
1515 if ( !this.continuous
) {
1516 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
1517 if ( !selectedItem
|| selectedItem
!== items
[ i
] ) {
1518 items
[ i
].$element
.addClass( 'oo-ui-element-hidden' );
1519 items
[ i
].$element
.attr( 'aria-hidden', 'true' );
1522 if ( selectedItem
) {
1523 selectedItem
.$element
.removeClass( 'oo-ui-element-hidden' );
1524 selectedItem
.$element
.removeAttr( 'aria-hidden' );
1530 * 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)
1531 * and its size is customized with the #menuSize config. The content area will fill all remaining space.
1534 * var menuLayout = new OO.ui.MenuLayout( {
1537 * menuPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1538 * contentPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1539 * select = new OO.ui.SelectWidget( {
1541 * new OO.ui.OptionWidget( {
1545 * new OO.ui.OptionWidget( {
1549 * new OO.ui.OptionWidget( {
1553 * new OO.ui.OptionWidget( {
1558 * } ).on( 'select', function ( item ) {
1559 * menuLayout.setMenuPosition( item.getData() );
1562 * menuLayout.$menu.append(
1563 * menuPanel.$element.append( '<b>Menu panel</b>', select.$element )
1565 * menuLayout.$content.append(
1566 * contentPanel.$element.append( '<b>Content panel</b>', '<p>Note that the menu is positioned relative to the content panel: top, bottom, after, before.</p>')
1568 * $( 'body' ).append( menuLayout.$element );
1570 * If menu size needs to be overridden, it can be accomplished using CSS similar to the snippet
1571 * below. MenuLayout's CSS will override the appropriate values with 'auto' or '0' to display the
1572 * menu correctly. If `menuPosition` is known beforehand, CSS rules corresponding to other positions
1575 * .oo-ui-menuLayout-menu {
1579 * .oo-ui-menuLayout-content {
1587 * @extends OO.ui.Layout
1590 * @param {Object} [config] Configuration options
1591 * @cfg {boolean} [showMenu=true] Show menu
1592 * @cfg {string} [menuPosition='before'] Position of menu: `top`, `after`, `bottom` or `before`
1594 OO
.ui
.MenuLayout
= function OoUiMenuLayout( config
) {
1595 // Configuration initialization
1596 config
= $.extend( {
1598 menuPosition
: 'before'
1601 // Parent constructor
1602 OO
.ui
.MenuLayout
.parent
.call( this, config
);
1607 * @property {jQuery}
1609 this.$menu
= $( '<div>' );
1613 * @property {jQuery}
1615 this.$content
= $( '<div>' );
1619 .addClass( 'oo-ui-menuLayout-menu' );
1620 this.$content
.addClass( 'oo-ui-menuLayout-content' );
1622 .addClass( 'oo-ui-menuLayout' )
1623 .append( this.$content
, this.$menu
);
1624 this.setMenuPosition( config
.menuPosition
);
1625 this.toggleMenu( config
.showMenu
);
1630 OO
.inheritClass( OO
.ui
.MenuLayout
, OO
.ui
.Layout
);
1637 * @param {boolean} showMenu Show menu, omit to toggle
1640 OO
.ui
.MenuLayout
.prototype.toggleMenu = function ( showMenu
) {
1641 showMenu
= showMenu
=== undefined ? !this.showMenu
: !!showMenu
;
1643 if ( this.showMenu
!== showMenu
) {
1644 this.showMenu
= showMenu
;
1646 .toggleClass( 'oo-ui-menuLayout-showMenu', this.showMenu
)
1647 .toggleClass( 'oo-ui-menuLayout-hideMenu', !this.showMenu
);
1648 this.$menu
.attr( 'aria-hidden', this.showMenu
? 'false' : 'true' );
1655 * Check if menu is visible
1657 * @return {boolean} Menu is visible
1659 OO
.ui
.MenuLayout
.prototype.isMenuVisible = function () {
1660 return this.showMenu
;
1664 * Set menu position.
1666 * @param {string} position Position of menu, either `top`, `after`, `bottom` or `before`
1667 * @throws {Error} If position value is not supported
1670 OO
.ui
.MenuLayout
.prototype.setMenuPosition = function ( position
) {
1671 this.$element
.removeClass( 'oo-ui-menuLayout-' + this.menuPosition
);
1672 this.menuPosition
= position
;
1673 this.$element
.addClass( 'oo-ui-menuLayout-' + position
);
1679 * Get menu position.
1681 * @return {string} Menu position
1683 OO
.ui
.MenuLayout
.prototype.getMenuPosition = function () {
1684 return this.menuPosition
;
1688 * BookletLayouts contain {@link OO.ui.PageLayout page layouts} as well as
1689 * an {@link OO.ui.OutlineSelectWidget outline} that allows users to easily navigate
1690 * through the pages and select which one to display. By default, only one page is
1691 * displayed at a time and the outline is hidden. When a user navigates to a new page,
1692 * the booklet layout automatically focuses on the first focusable element, unless the
1693 * default setting is changed. Optionally, booklets can be configured to show
1694 * {@link OO.ui.OutlineControlsWidget controls} for adding, moving, and removing items.
1697 * // Example of a BookletLayout that contains two PageLayouts.
1699 * function PageOneLayout( name, config ) {
1700 * PageOneLayout.parent.call( this, name, config );
1701 * this.$element.append( '<p>First page</p><p>(This booklet has an outline, displayed on the left)</p>' );
1703 * OO.inheritClass( PageOneLayout, OO.ui.PageLayout );
1704 * PageOneLayout.prototype.setupOutlineItem = function () {
1705 * this.outlineItem.setLabel( 'Page One' );
1708 * function PageTwoLayout( name, config ) {
1709 * PageTwoLayout.parent.call( this, name, config );
1710 * this.$element.append( '<p>Second page</p>' );
1712 * OO.inheritClass( PageTwoLayout, OO.ui.PageLayout );
1713 * PageTwoLayout.prototype.setupOutlineItem = function () {
1714 * this.outlineItem.setLabel( 'Page Two' );
1717 * var page1 = new PageOneLayout( 'one' ),
1718 * page2 = new PageTwoLayout( 'two' );
1720 * var booklet = new OO.ui.BookletLayout( {
1724 * booklet.addPages ( [ page1, page2 ] );
1725 * $( 'body' ).append( booklet.$element );
1728 * @extends OO.ui.MenuLayout
1731 * @param {Object} [config] Configuration options
1732 * @cfg {boolean} [continuous=false] Show all pages, one after another
1733 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new page is displayed. Disabled on mobile.
1734 * @cfg {boolean} [outlined=false] Show the outline. The outline is used to navigate through the pages of the booklet.
1735 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
1737 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
1738 // Configuration initialization
1739 config
= config
|| {};
1741 // Parent constructor
1742 OO
.ui
.BookletLayout
.parent
.call( this, config
);
1745 this.currentPageName
= null;
1747 this.ignoreFocus
= false;
1748 this.stackLayout
= new OO
.ui
.StackLayout( { continuous
: !!config
.continuous
} );
1749 this.$content
.append( this.stackLayout
.$element
);
1750 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
1751 this.outlineVisible
= false;
1752 this.outlined
= !!config
.outlined
;
1753 if ( this.outlined
) {
1754 this.editable
= !!config
.editable
;
1755 this.outlineControlsWidget
= null;
1756 this.outlineSelectWidget
= new OO
.ui
.OutlineSelectWidget();
1757 this.outlinePanel
= new OO
.ui
.PanelLayout( { scrollable
: true } );
1758 this.$menu
.append( this.outlinePanel
.$element
);
1759 this.outlineVisible
= true;
1760 if ( this.editable
) {
1761 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
1762 this.outlineSelectWidget
1766 this.toggleMenu( this.outlined
);
1769 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
1770 if ( this.outlined
) {
1771 this.outlineSelectWidget
.connect( this, { select
: 'onOutlineSelectWidgetSelect' } );
1772 this.scrolling
= false;
1773 this.stackLayout
.connect( this, { visibleItemChange
: 'onStackLayoutVisibleItemChange' } );
1775 if ( this.autoFocus
) {
1776 // Event 'focus' does not bubble, but 'focusin' does
1777 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
1781 this.$element
.addClass( 'oo-ui-bookletLayout' );
1782 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
1783 if ( this.outlined
) {
1784 this.outlinePanel
.$element
1785 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
1786 .append( this.outlineSelectWidget
.$element
);
1787 if ( this.editable
) {
1788 this.outlinePanel
.$element
1789 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
1790 .append( this.outlineControlsWidget
.$element
);
1797 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.MenuLayout
);
1802 * A 'set' event is emitted when a page is {@link #setPage set} to be displayed by the booklet layout.
1804 * @param {OO.ui.PageLayout} page Current page
1808 * An 'add' event is emitted when pages are {@link #addPages added} to the booklet layout.
1811 * @param {OO.ui.PageLayout[]} page Added pages
1812 * @param {number} index Index pages were added at
1816 * A 'remove' event is emitted when pages are {@link #clearPages cleared} or
1817 * {@link #removePages removed} from the booklet.
1820 * @param {OO.ui.PageLayout[]} pages Removed pages
1826 * Handle stack layout focus.
1829 * @param {jQuery.Event} e Focusin event
1831 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
1834 // Find the page that an element was focused within
1835 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
1836 for ( name
in this.pages
) {
1837 // Check for page match, exclude current page to find only page changes
1838 if ( this.pages
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentPageName
) {
1839 this.setPage( name
);
1846 * Handle visibleItemChange events from the stackLayout
1848 * The next visible page is set as the current page by selecting it
1851 * @param {OO.ui.PageLayout} page The next visible page in the layout
1853 OO
.ui
.BookletLayout
.prototype.onStackLayoutVisibleItemChange = function ( page
) {
1854 // Set a flag to so that the resulting call to #onStackLayoutSet doesn't
1855 // try and scroll the item into view again.
1856 this.scrolling
= true;
1857 this.outlineSelectWidget
.selectItemByData( page
.getName() );
1858 this.scrolling
= false;
1862 * Handle stack layout set events.
1865 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
1867 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
1869 if ( !this.scrolling
&& page
) {
1870 page
.scrollElementIntoView().done( function () {
1871 if ( layout
.autoFocus
&& !OO
.ui
.isMobile() ) {
1879 * Focus the first input in the current page.
1881 * If no page is selected, the first selectable page will be selected.
1882 * If the focus is already in an element on the current page, nothing will happen.
1884 * @param {number} [itemIndex] A specific item to focus on
1886 OO
.ui
.BookletLayout
.prototype.focus = function ( itemIndex
) {
1888 items
= this.stackLayout
.getItems();
1890 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
1891 page
= items
[ itemIndex
];
1893 page
= this.stackLayout
.getCurrentItem();
1896 if ( !page
&& this.outlined
) {
1897 this.selectFirstSelectablePage();
1898 page
= this.stackLayout
.getCurrentItem();
1903 // Only change the focus if is not already in the current page
1904 if ( !OO
.ui
.contains( page
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
1910 * Find the first focusable input in the booklet layout and focus
1913 OO
.ui
.BookletLayout
.prototype.focusFirstFocusable = function () {
1914 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
1918 * Handle outline widget select events.
1921 * @param {OO.ui.OptionWidget|null} item Selected item
1923 OO
.ui
.BookletLayout
.prototype.onOutlineSelectWidgetSelect = function ( item
) {
1925 this.setPage( item
.getData() );
1930 * Check if booklet has an outline.
1932 * @return {boolean} Booklet has an outline
1934 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
1935 return this.outlined
;
1939 * Check if booklet has editing controls.
1941 * @return {boolean} Booklet is editable
1943 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
1944 return this.editable
;
1948 * Check if booklet has a visible outline.
1950 * @return {boolean} Outline is visible
1952 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
1953 return this.outlined
&& this.outlineVisible
;
1957 * Hide or show the outline.
1959 * @param {boolean} [show] Show outline, omit to invert current state
1962 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
1965 if ( this.outlined
) {
1966 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
1967 this.outlineVisible
= show
;
1968 this.toggleMenu( show
);
1969 if ( show
&& this.editable
) {
1970 // HACK: Kill dumb scrollbars when the sidebar stops animating, see T161798. Only necessary when
1971 // outline controls are present, delay matches transition on `.oo-ui-menuLayout-menu`.
1972 setTimeout( function () {
1973 OO
.ui
.Element
.static.reconsiderScrollbars( booklet
.outlinePanel
.$element
[ 0 ] );
1982 * Find the page closest to the specified page.
1984 * @param {OO.ui.PageLayout} page Page to use as a reference point
1985 * @return {OO.ui.PageLayout|null} Page closest to the specified page
1987 OO
.ui
.BookletLayout
.prototype.findClosestPage = function ( page
) {
1988 var next
, prev
, level
,
1989 pages
= this.stackLayout
.getItems(),
1990 index
= pages
.indexOf( page
);
1992 if ( index
!== -1 ) {
1993 next
= pages
[ index
+ 1 ];
1994 prev
= pages
[ index
- 1 ];
1995 // Prefer adjacent pages at the same level
1996 if ( this.outlined
) {
1997 level
= this.outlineSelectWidget
.getItemFromData( page
.getName() ).getLevel();
2000 level
=== this.outlineSelectWidget
.getItemFromData( prev
.getName() ).getLevel()
2006 level
=== this.outlineSelectWidget
.getItemFromData( next
.getName() ).getLevel()
2012 return prev
|| next
|| null;
2016 * Get the page closest to the specified page.
2018 * @deprecated 0.23.0 Use {@link OO.ui.BookletLayout#findClosestPage} instead.
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.getClosestPage = function ( page
) {
2023 OO
.ui
.warnDeprecation( 'BookletLayout#getClosestPage: Deprecated function. Use findClosestPage instead. See T76630.' );
2024 return this.findClosestPage( page
);
2028 * Get the outline widget.
2030 * If the booklet is not outlined, the method will return `null`.
2032 * @return {OO.ui.OutlineSelectWidget|null} Outline widget, or null if the booklet is not outlined
2034 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
2035 return this.outlineSelectWidget
;
2039 * Get the outline controls widget.
2041 * If the outline is not editable, the method will return `null`.
2043 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
2045 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
2046 return this.outlineControlsWidget
;
2050 * Get a page by its symbolic name.
2052 * @param {string} name Symbolic name of page
2053 * @return {OO.ui.PageLayout|undefined} Page, if found
2055 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
2056 return this.pages
[ name
];
2060 * Get the current page.
2062 * @return {OO.ui.PageLayout|undefined} Current page, if found
2064 OO
.ui
.BookletLayout
.prototype.getCurrentPage = function () {
2065 var name
= this.getCurrentPageName();
2066 return name
? this.getPage( name
) : undefined;
2070 * Get the symbolic name of the current page.
2072 * @return {string|null} Symbolic name of the current page
2074 OO
.ui
.BookletLayout
.prototype.getCurrentPageName = function () {
2075 return this.currentPageName
;
2079 * Add pages to the booklet layout
2081 * When pages are added with the same names as existing pages, the existing pages will be
2082 * automatically removed before the new pages are added.
2084 * @param {OO.ui.PageLayout[]} pages Pages to add
2085 * @param {number} index Index of the insertion point
2089 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
2090 var i
, len
, name
, page
, item
, currentIndex
,
2091 stackLayoutPages
= this.stackLayout
.getItems(),
2095 // Remove pages with same names
2096 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2098 name
= page
.getName();
2100 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
2101 // Correct the insertion index
2102 currentIndex
= stackLayoutPages
.indexOf( this.pages
[ name
] );
2103 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2106 remove
.push( this.pages
[ name
] );
2109 if ( remove
.length
) {
2110 this.removePages( remove
);
2114 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2116 name
= page
.getName();
2117 this.pages
[ page
.getName() ] = page
;
2118 if ( this.outlined
) {
2119 item
= new OO
.ui
.OutlineOptionWidget( { data
: name
} );
2120 page
.setOutlineItem( item
);
2125 if ( this.outlined
&& items
.length
) {
2126 this.outlineSelectWidget
.addItems( items
, index
);
2127 this.selectFirstSelectablePage();
2129 this.stackLayout
.addItems( pages
, index
);
2130 this.emit( 'add', pages
, index
);
2136 * Remove the specified pages from the booklet layout.
2138 * To remove all pages from the booklet, you may wish to use the #clearPages method instead.
2140 * @param {OO.ui.PageLayout[]} pages An array of pages to remove
2144 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
2145 var i
, len
, name
, page
,
2148 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2150 name
= page
.getName();
2151 delete this.pages
[ name
];
2152 if ( this.outlined
) {
2153 items
.push( this.outlineSelectWidget
.getItemFromData( name
) );
2154 page
.setOutlineItem( null );
2157 if ( this.outlined
&& items
.length
) {
2158 this.outlineSelectWidget
.removeItems( items
);
2159 this.selectFirstSelectablePage();
2161 this.stackLayout
.removeItems( pages
);
2162 this.emit( 'remove', pages
);
2168 * Clear all pages from the booklet layout.
2170 * To remove only a subset of pages from the booklet, use the #removePages method.
2175 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
2177 pages
= this.stackLayout
.getItems();
2180 this.currentPageName
= null;
2181 if ( this.outlined
) {
2182 this.outlineSelectWidget
.clearItems();
2183 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2184 pages
[ i
].setOutlineItem( null );
2187 this.stackLayout
.clearItems();
2189 this.emit( 'remove', pages
);
2195 * Set the current page by symbolic name.
2198 * @param {string} name Symbolic name of page
2200 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
2203 page
= this.pages
[ name
],
2204 previousPage
= this.currentPageName
&& this.pages
[ this.currentPageName
];
2206 if ( name
!== this.currentPageName
) {
2207 if ( this.outlined
) {
2208 selectedItem
= this.outlineSelectWidget
.getSelectedItem();
2209 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2210 this.outlineSelectWidget
.selectItemByData( name
);
2214 if ( previousPage
) {
2215 previousPage
.setActive( false );
2216 // Blur anything focused if the next page doesn't have anything focusable.
2217 // This is not needed if the next page has something focusable (because once it is focused
2218 // this blur happens automatically). If the layout is non-continuous, this check is
2219 // meaningless because the next page is not visible yet and thus can't hold focus.
2222 !OO
.ui
.isMobile() &&
2223 this.stackLayout
.continuous
&&
2224 OO
.ui
.findFocusable( page
.$element
).length
!== 0
2226 $focused
= previousPage
.$element
.find( ':focus' );
2227 if ( $focused
.length
) {
2228 $focused
[ 0 ].blur();
2232 this.currentPageName
= name
;
2233 page
.setActive( true );
2234 this.stackLayout
.setItem( page
);
2235 if ( !this.stackLayout
.continuous
&& previousPage
) {
2236 // This should not be necessary, since any inputs on the previous page should have been
2237 // blurred when it was hidden, but browsers are not very consistent about this.
2238 $focused
= previousPage
.$element
.find( ':focus' );
2239 if ( $focused
.length
) {
2240 $focused
[ 0 ].blur();
2243 this.emit( 'set', page
);
2249 * Select the first selectable page.
2253 OO
.ui
.BookletLayout
.prototype.selectFirstSelectablePage = function () {
2254 if ( !this.outlineSelectWidget
.getSelectedItem() ) {
2255 this.outlineSelectWidget
.selectItem( this.outlineSelectWidget
.findFirstSelectableItem() );
2262 * IndexLayouts contain {@link OO.ui.TabPanelLayout tab panel layouts} as well as
2263 * {@link OO.ui.TabSelectWidget tabs} that allow users to easily navigate through the tab panels and
2264 * select which one to display. By default, only one tab panel is displayed at a time. When a user
2265 * navigates to a new tab panel, the index layout automatically focuses on the first focusable element,
2266 * unless the default setting is changed.
2268 * TODO: This class is similar to BookletLayout, we may want to refactor to reduce duplication
2271 * // Example of a IndexLayout that contains two TabPanelLayouts.
2273 * function TabPanelOneLayout( name, config ) {
2274 * TabPanelOneLayout.parent.call( this, name, config );
2275 * this.$element.append( '<p>First tab panel</p>' );
2277 * OO.inheritClass( TabPanelOneLayout, OO.ui.TabPanelLayout );
2278 * TabPanelOneLayout.prototype.setupTabItem = function () {
2279 * this.tabItem.setLabel( 'Tab panel one' );
2282 * var tabPanel1 = new TabPanelOneLayout( 'one' ),
2283 * tabPanel2 = new OO.ui.TabPanelLayout( 'two', { label: 'Tab panel two' } );
2285 * tabPanel2.$element.append( '<p>Second tab panel</p>' );
2287 * var index = new OO.ui.IndexLayout();
2289 * index.addTabPanels ( [ tabPanel1, tabPanel2 ] );
2290 * $( 'body' ).append( index.$element );
2293 * @extends OO.ui.MenuLayout
2296 * @param {Object} [config] Configuration options
2297 * @cfg {boolean} [continuous=false] Show all tab panels, one after another
2298 * @cfg {boolean} [expanded=true] Expand the content panel to fill the entire parent element.
2299 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new tab panel is displayed. Disabled on mobile.
2301 OO
.ui
.IndexLayout
= function OoUiIndexLayout( config
) {
2302 // Configuration initialization
2303 config
= $.extend( {}, config
, { menuPosition
: 'top' } );
2305 // Parent constructor
2306 OO
.ui
.IndexLayout
.parent
.call( this, config
);
2309 this.currentTabPanelName
= null;
2310 this.tabPanels
= {};
2312 this.ignoreFocus
= false;
2313 this.stackLayout
= new OO
.ui
.StackLayout( {
2314 continuous
: !!config
.continuous
,
2315 expanded
: config
.expanded
2317 this.$content
.append( this.stackLayout
.$element
);
2318 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
2320 this.tabSelectWidget
= new OO
.ui
.TabSelectWidget();
2321 this.tabPanel
= new OO
.ui
.PanelLayout();
2322 this.$menu
.append( this.tabPanel
.$element
);
2324 this.toggleMenu( true );
2327 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
2328 this.tabSelectWidget
.connect( this, { select
: 'onTabSelectWidgetSelect' } );
2329 if ( this.autoFocus
) {
2330 // Event 'focus' does not bubble, but 'focusin' does
2331 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
2335 this.$element
.addClass( 'oo-ui-indexLayout' );
2336 this.stackLayout
.$element
.addClass( 'oo-ui-indexLayout-stackLayout' );
2337 this.tabPanel
.$element
2338 .addClass( 'oo-ui-indexLayout-tabPanel' )
2339 .append( this.tabSelectWidget
.$element
);
2344 OO
.inheritClass( OO
.ui
.IndexLayout
, OO
.ui
.MenuLayout
);
2349 * A 'set' event is emitted when a tab panel is {@link #setTabPanel set} to be displayed by the index layout.
2351 * @param {OO.ui.TabPanelLayout} tabPanel Current tab panel
2355 * An 'add' event is emitted when tab panels are {@link #addTabPanels added} to the index layout.
2358 * @param {OO.ui.TabPanelLayout[]} tabPanel Added tab panels
2359 * @param {number} index Index tab panels were added at
2363 * A 'remove' event is emitted when tab panels are {@link #clearTabPanels cleared} or
2364 * {@link #removeTabPanels removed} from the index.
2367 * @param {OO.ui.TabPanelLayout[]} tabPanel Removed tab panels
2373 * Handle stack layout focus.
2376 * @param {jQuery.Event} e Focusing event
2378 OO
.ui
.IndexLayout
.prototype.onStackLayoutFocus = function ( e
) {
2381 // Find the tab panel that an element was focused within
2382 $target
= $( e
.target
).closest( '.oo-ui-tabPanelLayout' );
2383 for ( name
in this.tabPanels
) {
2384 // Check for tab panel match, exclude current tab panel to find only tab panel changes
2385 if ( this.tabPanels
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentTabPanelName
) {
2386 this.setTabPanel( name
);
2393 * Handle stack layout set events.
2396 * @param {OO.ui.PanelLayout|null} tabPanel The tab panel that is now the current panel
2398 OO
.ui
.IndexLayout
.prototype.onStackLayoutSet = function ( tabPanel
) {
2401 tabPanel
.scrollElementIntoView().done( function () {
2402 if ( layout
.autoFocus
&& !OO
.ui
.isMobile() ) {
2410 * Focus the first input in the current tab panel.
2412 * If no tab panel is selected, the first selectable tab panel will be selected.
2413 * If the focus is already in an element on the current tab panel, nothing will happen.
2415 * @param {number} [itemIndex] A specific item to focus on
2417 OO
.ui
.IndexLayout
.prototype.focus = function ( itemIndex
) {
2419 items
= this.stackLayout
.getItems();
2421 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
2422 tabPanel
= items
[ itemIndex
];
2424 tabPanel
= this.stackLayout
.getCurrentItem();
2428 this.selectFirstSelectableTabPanel();
2429 tabPanel
= this.stackLayout
.getCurrentItem();
2434 // Only change the focus if is not already in the current page
2435 if ( !OO
.ui
.contains( tabPanel
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
2441 * Find the first focusable input in the index layout and focus
2444 OO
.ui
.IndexLayout
.prototype.focusFirstFocusable = function () {
2445 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
2449 * Handle tab widget select events.
2452 * @param {OO.ui.OptionWidget|null} item Selected item
2454 OO
.ui
.IndexLayout
.prototype.onTabSelectWidgetSelect = function ( item
) {
2456 this.setTabPanel( item
.getData() );
2461 * Get the tab panel closest to the specified tab panel.
2463 * @param {OO.ui.TabPanelLayout} tabPanel Tab panel to use as a reference point
2464 * @return {OO.ui.TabPanelLayout|null} Tab panel closest to the specified
2466 OO
.ui
.IndexLayout
.prototype.getClosestTabPanel = function ( tabPanel
) {
2467 var next
, prev
, level
,
2468 tabPanels
= this.stackLayout
.getItems(),
2469 index
= tabPanels
.indexOf( tabPanel
);
2471 if ( index
!== -1 ) {
2472 next
= tabPanels
[ index
+ 1 ];
2473 prev
= tabPanels
[ index
- 1 ];
2474 // Prefer adjacent tab panels at the same level
2475 level
= this.tabSelectWidget
.getItemFromData( tabPanel
.getName() ).getLevel();
2478 level
=== this.tabSelectWidget
.getItemFromData( prev
.getName() ).getLevel()
2484 level
=== this.tabSelectWidget
.getItemFromData( next
.getName() ).getLevel()
2489 return prev
|| next
|| null;
2493 * Get the tabs widget.
2495 * @return {OO.ui.TabSelectWidget} Tabs widget
2497 OO
.ui
.IndexLayout
.prototype.getTabs = function () {
2498 return this.tabSelectWidget
;
2502 * Get a tab panel by its symbolic name.
2504 * @param {string} name Symbolic name of tab panel
2505 * @return {OO.ui.TabPanelLayout|undefined} Tab panel, if found
2507 OO
.ui
.IndexLayout
.prototype.getTabPanel = function ( name
) {
2508 return this.tabPanels
[ name
];
2512 * Get the current tab panel.
2514 * @return {OO.ui.TabPanelLayout|undefined} Current tab panel, if found
2516 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanel = function () {
2517 var name
= this.getCurrentTabPanelName();
2518 return name
? this.getTabPanel( name
) : undefined;
2522 * Get the symbolic name of the current tab panel.
2524 * @return {string|null} Symbolic name of the current tab panel
2526 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanelName = function () {
2527 return this.currentTabPanelName
;
2531 * Add tab panels to the index layout
2533 * When tab panels are added with the same names as existing tab panels, the existing tab panels
2534 * will be automatically removed before the new tab panels are added.
2536 * @param {OO.ui.TabPanelLayout[]} tabPanels Tab panels to add
2537 * @param {number} index Index of the insertion point
2541 OO
.ui
.IndexLayout
.prototype.addTabPanels = function ( tabPanels
, index
) {
2542 var i
, len
, name
, tabPanel
, item
, currentIndex
,
2543 stackLayoutTabPanels
= this.stackLayout
.getItems(),
2547 // Remove tab panels with same names
2548 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2549 tabPanel
= tabPanels
[ i
];
2550 name
= tabPanel
.getName();
2552 if ( Object
.prototype.hasOwnProperty
.call( this.tabPanels
, name
) ) {
2553 // Correct the insertion index
2554 currentIndex
= stackLayoutTabPanels
.indexOf( this.tabPanels
[ name
] );
2555 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2558 remove
.push( this.tabPanels
[ name
] );
2561 if ( remove
.length
) {
2562 this.removeTabPanels( remove
);
2565 // Add new tab panels
2566 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2567 tabPanel
= tabPanels
[ i
];
2568 name
= tabPanel
.getName();
2569 this.tabPanels
[ tabPanel
.getName() ] = tabPanel
;
2570 item
= new OO
.ui
.TabOptionWidget( { data
: name
} );
2571 tabPanel
.setTabItem( item
);
2575 if ( items
.length
) {
2576 this.tabSelectWidget
.addItems( items
, index
);
2577 this.selectFirstSelectableTabPanel();
2579 this.stackLayout
.addItems( tabPanels
, index
);
2580 this.emit( 'add', tabPanels
, index
);
2586 * Remove the specified tab panels from the index layout.
2588 * To remove all tab panels from the index, you may wish to use the #clearTabPanels method instead.
2590 * @param {OO.ui.TabPanelLayout[]} tabPanels An array of tab panels to remove
2594 OO
.ui
.IndexLayout
.prototype.removeTabPanels = function ( tabPanels
) {
2595 var i
, len
, name
, tabPanel
,
2598 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2599 tabPanel
= tabPanels
[ i
];
2600 name
= tabPanel
.getName();
2601 delete this.tabPanels
[ name
];
2602 items
.push( this.tabSelectWidget
.getItemFromData( name
) );
2603 tabPanel
.setTabItem( null );
2605 if ( items
.length
) {
2606 this.tabSelectWidget
.removeItems( items
);
2607 this.selectFirstSelectableTabPanel();
2609 this.stackLayout
.removeItems( tabPanels
);
2610 this.emit( 'remove', tabPanels
);
2616 * Clear all tab panels from the index layout.
2618 * To remove only a subset of tab panels from the index, use the #removeTabPanels method.
2623 OO
.ui
.IndexLayout
.prototype.clearTabPanels = function () {
2625 tabPanels
= this.stackLayout
.getItems();
2627 this.tabPanels
= {};
2628 this.currentTabPanelName
= null;
2629 this.tabSelectWidget
.clearItems();
2630 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2631 tabPanels
[ i
].setTabItem( null );
2633 this.stackLayout
.clearItems();
2635 this.emit( 'remove', tabPanels
);
2641 * Set the current tab panel by symbolic name.
2644 * @param {string} name Symbolic name of tab panel
2646 OO
.ui
.IndexLayout
.prototype.setTabPanel = function ( name
) {
2649 tabPanel
= this.tabPanels
[ name
],
2650 previousTabPanel
= this.currentTabPanelName
&& this.tabPanels
[ this.currentTabPanelName
];
2652 if ( name
!== this.currentTabPanelName
) {
2653 selectedItem
= this.tabSelectWidget
.getSelectedItem();
2654 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2655 this.tabSelectWidget
.selectItemByData( name
);
2658 if ( previousTabPanel
) {
2659 previousTabPanel
.setActive( false );
2660 // Blur anything focused if the next tab panel doesn't have anything focusable.
2661 // This is not needed if the next tab panel has something focusable (because once it is focused
2662 // this blur happens automatically). If the layout is non-continuous, this check is
2663 // meaningless because the next tab panel is not visible yet and thus can't hold focus.
2666 !OO
.ui
.isMobile() &&
2667 this.stackLayout
.continuous
&&
2668 OO
.ui
.findFocusable( tabPanel
.$element
).length
!== 0
2670 $focused
= previousTabPanel
.$element
.find( ':focus' );
2671 if ( $focused
.length
) {
2672 $focused
[ 0 ].blur();
2676 this.currentTabPanelName
= name
;
2677 tabPanel
.setActive( true );
2678 this.stackLayout
.setItem( tabPanel
);
2679 if ( !this.stackLayout
.continuous
&& previousTabPanel
) {
2680 // This should not be necessary, since any inputs on the previous tab panel should have been
2681 // blurred when it was hidden, but browsers are not very consistent about this.
2682 $focused
= previousTabPanel
.$element
.find( ':focus' );
2683 if ( $focused
.length
) {
2684 $focused
[ 0 ].blur();
2687 this.emit( 'set', tabPanel
);
2693 * Select the first selectable tab panel.
2697 OO
.ui
.IndexLayout
.prototype.selectFirstSelectableTabPanel = function () {
2698 if ( !this.tabSelectWidget
.getSelectedItem() ) {
2699 this.tabSelectWidget
.selectItem( this.tabSelectWidget
.findFirstSelectableItem() );
2706 * ToggleWidget implements basic behavior of widgets with an on/off state.
2707 * Please see OO.ui.ToggleButtonWidget and OO.ui.ToggleSwitchWidget for examples.
2711 * @extends OO.ui.Widget
2714 * @param {Object} [config] Configuration options
2715 * @cfg {boolean} [value=false] The toggle’s initial on/off state.
2716 * By default, the toggle is in the 'off' state.
2718 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
2719 // Configuration initialization
2720 config
= config
|| {};
2722 // Parent constructor
2723 OO
.ui
.ToggleWidget
.parent
.call( this, config
);
2729 this.$element
.addClass( 'oo-ui-toggleWidget' );
2730 this.setValue( !!config
.value
);
2735 OO
.inheritClass( OO
.ui
.ToggleWidget
, OO
.ui
.Widget
);
2742 * A change event is emitted when the on/off state of the toggle changes.
2744 * @param {boolean} value Value representing the new state of the toggle
2750 * Get the value representing the toggle’s state.
2752 * @return {boolean} The on/off state of the toggle
2754 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
2759 * Set the state of the toggle: `true` for 'on', `false` for 'off'.
2761 * @param {boolean} value The state of the toggle
2765 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
2767 if ( this.value
!== value
) {
2769 this.emit( 'change', value
);
2770 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
2771 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
2777 * ToggleButtons are buttons that have a state (‘on’ or ‘off’) that is represented by a
2778 * Boolean value. Like other {@link OO.ui.ButtonWidget buttons}, toggle buttons can be
2779 * configured with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators},
2780 * {@link OO.ui.mixin.TitledElement titles}, {@link OO.ui.mixin.FlaggedElement styling flags},
2781 * and {@link OO.ui.mixin.LabelElement labels}. Please see
2782 * the [OOjs UI documentation][1] on MediaWiki for more information.
2785 * // Toggle buttons in the 'off' and 'on' state.
2786 * var toggleButton1 = new OO.ui.ToggleButtonWidget( {
2787 * label: 'Toggle Button off'
2789 * var toggleButton2 = new OO.ui.ToggleButtonWidget( {
2790 * label: 'Toggle Button on',
2793 * // Append the buttons to the DOM.
2794 * $( 'body' ).append( toggleButton1.$element, toggleButton2.$element );
2796 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches#Toggle_buttons
2799 * @extends OO.ui.ToggleWidget
2800 * @mixins OO.ui.mixin.ButtonElement
2801 * @mixins OO.ui.mixin.IconElement
2802 * @mixins OO.ui.mixin.IndicatorElement
2803 * @mixins OO.ui.mixin.LabelElement
2804 * @mixins OO.ui.mixin.TitledElement
2805 * @mixins OO.ui.mixin.FlaggedElement
2806 * @mixins OO.ui.mixin.TabIndexedElement
2809 * @param {Object} [config] Configuration options
2810 * @cfg {boolean} [value=false] The toggle button’s initial on/off
2811 * state. By default, the button is in the 'off' state.
2813 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
2814 // Configuration initialization
2815 config
= config
|| {};
2817 // Parent constructor
2818 OO
.ui
.ToggleButtonWidget
.parent
.call( this, config
);
2820 // Mixin constructors
2821 OO
.ui
.mixin
.ButtonElement
.call( this, $.extend( {}, config
, { active
: this.active
} ) );
2822 OO
.ui
.mixin
.IconElement
.call( this, config
);
2823 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
2824 OO
.ui
.mixin
.LabelElement
.call( this, config
);
2825 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
2826 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
2827 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$button
} ) );
2830 this.connect( this, { click
: 'onAction' } );
2833 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
2835 .addClass( 'oo-ui-toggleButtonWidget' )
2836 .append( this.$button
);
2841 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
2842 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.ButtonElement
);
2843 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IconElement
);
2844 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IndicatorElement
);
2845 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.LabelElement
);
2846 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TitledElement
);
2847 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.FlaggedElement
);
2848 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TabIndexedElement
);
2850 /* Static Properties */
2856 OO
.ui
.ToggleButtonWidget
.static.tagName
= 'span';
2861 * Handle the button action being triggered.
2865 OO
.ui
.ToggleButtonWidget
.prototype.onAction = function () {
2866 this.setValue( !this.value
);
2872 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
2874 if ( value
!== this.value
) {
2875 // Might be called from parent constructor before ButtonElement constructor
2876 if ( this.$button
) {
2877 this.$button
.attr( 'aria-pressed', value
.toString() );
2879 this.setActive( value
);
2883 OO
.ui
.ToggleButtonWidget
.parent
.prototype.setValue
.call( this, value
);
2891 OO
.ui
.ToggleButtonWidget
.prototype.setButtonElement = function ( $button
) {
2892 if ( this.$button
) {
2893 this.$button
.removeAttr( 'aria-pressed' );
2895 OO
.ui
.mixin
.ButtonElement
.prototype.setButtonElement
.call( this, $button
);
2896 this.$button
.attr( 'aria-pressed', this.value
.toString() );
2900 * ToggleSwitches are switches that slide on and off. Their state is represented by a Boolean
2901 * value (`true` for ‘on’, and `false` otherwise, the default). The ‘off’ state is represented
2902 * visually by a slider in the leftmost position.
2905 * // Toggle switches in the 'off' and 'on' position.
2906 * var toggleSwitch1 = new OO.ui.ToggleSwitchWidget();
2907 * var toggleSwitch2 = new OO.ui.ToggleSwitchWidget( {
2911 * // Create a FieldsetLayout to layout and label switches
2912 * var fieldset = new OO.ui.FieldsetLayout( {
2913 * label: 'Toggle switches'
2915 * fieldset.addItems( [
2916 * new OO.ui.FieldLayout( toggleSwitch1, { label: 'Off', align: 'top' } ),
2917 * new OO.ui.FieldLayout( toggleSwitch2, { label: 'On', align: 'top' } )
2919 * $( 'body' ).append( fieldset.$element );
2922 * @extends OO.ui.ToggleWidget
2923 * @mixins OO.ui.mixin.TabIndexedElement
2926 * @param {Object} [config] Configuration options
2927 * @cfg {boolean} [value=false] The toggle switch’s initial on/off state.
2928 * By default, the toggle switch is in the 'off' position.
2930 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
2931 // Parent constructor
2932 OO
.ui
.ToggleSwitchWidget
.parent
.call( this, config
);
2934 // Mixin constructors
2935 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
2938 this.dragging
= false;
2939 this.dragStart
= null;
2940 this.sliding
= false;
2941 this.$glow
= $( '<span>' );
2942 this.$grip
= $( '<span>' );
2946 click
: this.onClick
.bind( this ),
2947 keypress
: this.onKeyPress
.bind( this )
2951 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
2952 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
2954 .addClass( 'oo-ui-toggleSwitchWidget' )
2955 .attr( 'role', 'checkbox' )
2956 .append( this.$glow
, this.$grip
);
2961 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
2962 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.mixin
.TabIndexedElement
);
2967 * Handle mouse click events.
2970 * @param {jQuery.Event} e Mouse click event
2972 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
2973 if ( !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
2974 this.setValue( !this.value
);
2980 * Handle key press events.
2983 * @param {jQuery.Event} e Key press event
2985 OO
.ui
.ToggleSwitchWidget
.prototype.onKeyPress = function ( e
) {
2986 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
2987 this.setValue( !this.value
);
2995 OO
.ui
.ToggleSwitchWidget
.prototype.setValue = function ( value
) {
2996 OO
.ui
.ToggleSwitchWidget
.parent
.prototype.setValue
.call( this, value
);
2997 this.$element
.attr( 'aria-checked', this.value
.toString() );
3004 OO
.ui
.ToggleSwitchWidget
.prototype.simulateLabelClick = function () {
3005 if ( !this.isDisabled() ) {
3006 this.setValue( !this.value
);
3012 * OutlineControlsWidget is a set of controls for an {@link OO.ui.OutlineSelectWidget outline select widget}.
3013 * Controls include moving items up and down, removing items, and adding different kinds of items.
3015 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3018 * @extends OO.ui.Widget
3019 * @mixins OO.ui.mixin.GroupElement
3020 * @mixins OO.ui.mixin.IconElement
3023 * @param {OO.ui.OutlineSelectWidget} outline Outline to control
3024 * @param {Object} [config] Configuration options
3025 * @cfg {Object} [abilities] List of abilties
3026 * @cfg {boolean} [abilities.move=true] Allow moving movable items
3027 * @cfg {boolean} [abilities.remove=true] Allow removing removable items
3029 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
3030 // Allow passing positional parameters inside the config object
3031 if ( OO
.isPlainObject( outline
) && config
=== undefined ) {
3033 outline
= config
.outline
;
3036 // Configuration initialization
3037 config
= $.extend( { icon
: 'add' }, config
);
3039 // Parent constructor
3040 OO
.ui
.OutlineControlsWidget
.parent
.call( this, config
);
3042 // Mixin constructors
3043 OO
.ui
.mixin
.GroupElement
.call( this, config
);
3044 OO
.ui
.mixin
.IconElement
.call( this, config
);
3047 this.outline
= outline
;
3048 this.$movers
= $( '<div>' );
3049 this.upButton
= new OO
.ui
.ButtonWidget( {
3052 title
: OO
.ui
.msg( 'ooui-outline-control-move-up' )
3054 this.downButton
= new OO
.ui
.ButtonWidget( {
3057 title
: OO
.ui
.msg( 'ooui-outline-control-move-down' )
3059 this.removeButton
= new OO
.ui
.ButtonWidget( {
3062 title
: OO
.ui
.msg( 'ooui-outline-control-remove' )
3064 this.abilities
= { move: true, remove
: true };
3067 outline
.connect( this, {
3068 select
: 'onOutlineChange',
3069 add
: 'onOutlineChange',
3070 remove
: 'onOutlineChange'
3072 this.upButton
.connect( this, { click
: [ 'emit', 'move', -1 ] } );
3073 this.downButton
.connect( this, { click
: [ 'emit', 'move', 1 ] } );
3074 this.removeButton
.connect( this, { click
: [ 'emit', 'remove' ] } );
3077 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
3078 this.$group
.addClass( 'oo-ui-outlineControlsWidget-items' );
3080 .addClass( 'oo-ui-outlineControlsWidget-movers' )
3081 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
3082 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
3083 this.setAbilities( config
.abilities
|| {} );
3088 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
3089 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.GroupElement
);
3090 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.IconElement
);
3096 * @param {number} places Number of places to move
3108 * @param {Object} abilities List of abilties
3109 * @param {boolean} [abilities.move] Allow moving movable items
3110 * @param {boolean} [abilities.remove] Allow removing removable items
3112 OO
.ui
.OutlineControlsWidget
.prototype.setAbilities = function ( abilities
) {
3115 for ( ability
in this.abilities
) {
3116 if ( abilities
[ ability
] !== undefined ) {
3117 this.abilities
[ ability
] = !!abilities
[ ability
];
3121 this.onOutlineChange();
3125 * Handle outline change events.
3129 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
3130 var i
, len
, firstMovable
, lastMovable
,
3131 items
= this.outline
.getItems(),
3132 selectedItem
= this.outline
.getSelectedItem(),
3133 movable
= this.abilities
.move && selectedItem
&& selectedItem
.isMovable(),
3134 removable
= this.abilities
.remove
&& selectedItem
&& selectedItem
.isRemovable();
3139 while ( ++i
< len
) {
3140 if ( items
[ i
].isMovable() ) {
3141 firstMovable
= items
[ i
];
3147 if ( items
[ i
].isMovable() ) {
3148 lastMovable
= items
[ i
];
3153 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
3154 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
3155 this.removeButton
.setDisabled( !removable
);
3159 * OutlineOptionWidget is an item in an {@link OO.ui.OutlineSelectWidget OutlineSelectWidget}.
3161 * Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}, which contain
3162 * {@link OO.ui.PageLayout page layouts}. See {@link OO.ui.BookletLayout BookletLayout}
3166 * @extends OO.ui.DecoratedOptionWidget
3169 * @param {Object} [config] Configuration options
3170 * @cfg {number} [level] Indentation level
3171 * @cfg {boolean} [movable] Allow modification from {@link OO.ui.OutlineControlsWidget outline controls}.
3173 OO
.ui
.OutlineOptionWidget
= function OoUiOutlineOptionWidget( config
) {
3174 // Configuration initialization
3175 config
= config
|| {};
3177 // Parent constructor
3178 OO
.ui
.OutlineOptionWidget
.parent
.call( this, config
);
3182 this.movable
= !!config
.movable
;
3183 this.removable
= !!config
.removable
;
3186 this.$element
.addClass( 'oo-ui-outlineOptionWidget' );
3187 this.setLevel( config
.level
);
3192 OO
.inheritClass( OO
.ui
.OutlineOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
3194 /* Static Properties */
3200 OO
.ui
.OutlineOptionWidget
.static.highlightable
= true;
3206 OO
.ui
.OutlineOptionWidget
.static.scrollIntoViewOnSelect
= true;
3211 * @property {string}
3213 OO
.ui
.OutlineOptionWidget
.static.levelClass
= 'oo-ui-outlineOptionWidget-level-';
3218 * @property {number}
3220 OO
.ui
.OutlineOptionWidget
.static.levels
= 3;
3225 * Check if item is movable.
3227 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3229 * @return {boolean} Item is movable
3231 OO
.ui
.OutlineOptionWidget
.prototype.isMovable = function () {
3232 return this.movable
;
3236 * Check if item is removable.
3238 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3240 * @return {boolean} Item is removable
3242 OO
.ui
.OutlineOptionWidget
.prototype.isRemovable = function () {
3243 return this.removable
;
3247 * Get indentation level.
3249 * @return {number} Indentation level
3251 OO
.ui
.OutlineOptionWidget
.prototype.getLevel = function () {
3258 OO
.ui
.OutlineOptionWidget
.prototype.setPressed = function ( state
) {
3259 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setPressed
.call( this, state
);
3260 if ( this.pressed
) {
3261 this.setFlags( { progressive
: true } );
3262 } else if ( !this.selected
) {
3263 this.setFlags( { progressive
: false } );
3271 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3273 * @param {boolean} movable Item is movable
3276 OO
.ui
.OutlineOptionWidget
.prototype.setMovable = function ( movable
) {
3277 this.movable
= !!movable
;
3278 this.updateThemeClasses();
3285 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3287 * @param {boolean} removable Item is removable
3290 OO
.ui
.OutlineOptionWidget
.prototype.setRemovable = function ( removable
) {
3291 this.removable
= !!removable
;
3292 this.updateThemeClasses();
3299 OO
.ui
.OutlineOptionWidget
.prototype.setSelected = function ( state
) {
3300 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3301 if ( this.selected
) {
3302 this.setFlags( { progressive
: true } );
3304 this.setFlags( { progressive
: false } );
3310 * Set indentation level.
3312 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
3315 OO
.ui
.OutlineOptionWidget
.prototype.setLevel = function ( level
) {
3316 var levels
= this.constructor.static.levels
,
3317 levelClass
= this.constructor.static.levelClass
,
3320 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
3322 if ( this.level
=== i
) {
3323 this.$element
.addClass( levelClass
+ i
);
3325 this.$element
.removeClass( levelClass
+ i
);
3328 this.updateThemeClasses();
3334 * OutlineSelectWidget is a structured list that contains {@link OO.ui.OutlineOptionWidget outline options}
3335 * A set of controls can be provided with an {@link OO.ui.OutlineControlsWidget outline controls} widget.
3337 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3340 * @extends OO.ui.SelectWidget
3341 * @mixins OO.ui.mixin.TabIndexedElement
3344 * @param {Object} [config] Configuration options
3346 OO
.ui
.OutlineSelectWidget
= function OoUiOutlineSelectWidget( config
) {
3347 // Parent constructor
3348 OO
.ui
.OutlineSelectWidget
.parent
.call( this, config
);
3350 // Mixin constructors
3351 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3355 focus
: this.bindKeyDownListener
.bind( this ),
3356 blur
: this.unbindKeyDownListener
.bind( this )
3360 this.$element
.addClass( 'oo-ui-outlineSelectWidget' );
3365 OO
.inheritClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.SelectWidget
);
3366 OO
.mixinClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3369 * ButtonOptionWidget is a special type of {@link OO.ui.mixin.ButtonElement button element} that
3370 * can be selected and configured with data. The class is
3371 * used with OO.ui.ButtonSelectWidget to create a selection of button options. Please see the
3372 * [OOjs UI documentation on MediaWiki] [1] for more information.
3374 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Button_selects_and_options
3377 * @extends OO.ui.OptionWidget
3378 * @mixins OO.ui.mixin.ButtonElement
3379 * @mixins OO.ui.mixin.IconElement
3380 * @mixins OO.ui.mixin.IndicatorElement
3381 * @mixins OO.ui.mixin.TitledElement
3384 * @param {Object} [config] Configuration options
3386 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( config
) {
3387 // Configuration initialization
3388 config
= config
|| {};
3390 // Parent constructor
3391 OO
.ui
.ButtonOptionWidget
.parent
.call( this, config
);
3393 // Mixin constructors
3394 OO
.ui
.mixin
.ButtonElement
.call( this, config
);
3395 OO
.ui
.mixin
.IconElement
.call( this, config
);
3396 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3397 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
3400 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
3401 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
3402 this.$element
.append( this.$button
);
3407 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.OptionWidget
);
3408 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.ButtonElement
);
3409 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IconElement
);
3410 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IndicatorElement
);
3411 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.TitledElement
);
3413 /* Static Properties */
3416 * Allow button mouse down events to pass through so they can be handled by the parent select widget
3421 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
3427 OO
.ui
.ButtonOptionWidget
.static.highlightable
= false;
3434 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
3435 OO
.ui
.ButtonOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3437 if ( this.constructor.static.selectable
) {
3438 this.setActive( state
);
3445 * ButtonSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains
3446 * button options and is used together with
3447 * OO.ui.ButtonOptionWidget. The ButtonSelectWidget provides an interface for
3448 * highlighting, choosing, and selecting mutually exclusive options. Please see
3449 * the [OOjs UI documentation on MediaWiki] [1] for more information.
3452 * // Example: A ButtonSelectWidget that contains three ButtonOptionWidgets
3453 * var option1 = new OO.ui.ButtonOptionWidget( {
3455 * label: 'Option 1',
3456 * title: 'Button option 1'
3459 * var option2 = new OO.ui.ButtonOptionWidget( {
3461 * label: 'Option 2',
3462 * title: 'Button option 2'
3465 * var option3 = new OO.ui.ButtonOptionWidget( {
3467 * label: 'Option 3',
3468 * title: 'Button option 3'
3471 * var buttonSelect=new OO.ui.ButtonSelectWidget( {
3472 * items: [ option1, option2, option3 ]
3474 * $( 'body' ).append( buttonSelect.$element );
3476 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
3479 * @extends OO.ui.SelectWidget
3480 * @mixins OO.ui.mixin.TabIndexedElement
3483 * @param {Object} [config] Configuration options
3485 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
3486 // Parent constructor
3487 OO
.ui
.ButtonSelectWidget
.parent
.call( this, config
);
3489 // Mixin constructors
3490 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3494 focus
: this.bindKeyDownListener
.bind( this ),
3495 blur
: this.unbindKeyDownListener
.bind( this )
3499 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
3504 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
3505 OO
.mixinClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3508 * TabOptionWidget is an item in a {@link OO.ui.TabSelectWidget TabSelectWidget}.
3510 * Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}, which contain
3511 * {@link OO.ui.TabPanelLayout tab panel layouts}. See {@link OO.ui.IndexLayout IndexLayout}
3515 * @extends OO.ui.OptionWidget
3518 * @param {Object} [config] Configuration options
3520 OO
.ui
.TabOptionWidget
= function OoUiTabOptionWidget( config
) {
3521 // Configuration initialization
3522 config
= config
|| {};
3524 // Parent constructor
3525 OO
.ui
.TabOptionWidget
.parent
.call( this, config
);
3528 this.$element
.addClass( 'oo-ui-tabOptionWidget' );
3533 OO
.inheritClass( OO
.ui
.TabOptionWidget
, OO
.ui
.OptionWidget
);
3535 /* Static Properties */
3541 OO
.ui
.TabOptionWidget
.static.highlightable
= false;
3544 * TabSelectWidget is a list that contains {@link OO.ui.TabOptionWidget tab options}
3546 * **Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}.**
3549 * @extends OO.ui.SelectWidget
3550 * @mixins OO.ui.mixin.TabIndexedElement
3553 * @param {Object} [config] Configuration options
3555 OO
.ui
.TabSelectWidget
= function OoUiTabSelectWidget( config
) {
3556 // Parent constructor
3557 OO
.ui
.TabSelectWidget
.parent
.call( this, config
);
3559 // Mixin constructors
3560 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3564 focus
: this.bindKeyDownListener
.bind( this ),
3565 blur
: this.unbindKeyDownListener
.bind( this )
3569 this.$element
.addClass( 'oo-ui-tabSelectWidget' );
3574 OO
.inheritClass( OO
.ui
.TabSelectWidget
, OO
.ui
.SelectWidget
);
3575 OO
.mixinClass( OO
.ui
.TabSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3578 * CapsuleItemWidgets are used within a {@link OO.ui.CapsuleMultiselectWidget
3579 * CapsuleMultiselectWidget} to display the selected items.
3582 * @extends OO.ui.Widget
3583 * @mixins OO.ui.mixin.ItemWidget
3584 * @mixins OO.ui.mixin.LabelElement
3585 * @mixins OO.ui.mixin.FlaggedElement
3586 * @mixins OO.ui.mixin.TabIndexedElement
3589 * @param {Object} [config] Configuration options
3591 OO
.ui
.CapsuleItemWidget
= function OoUiCapsuleItemWidget( config
) {
3592 // Configuration initialization
3593 config
= config
|| {};
3595 // Parent constructor
3596 OO
.ui
.CapsuleItemWidget
.parent
.call( this, config
);
3598 // Mixin constructors
3599 OO
.ui
.mixin
.ItemWidget
.call( this );
3600 OO
.ui
.mixin
.LabelElement
.call( this, config
);
3601 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
3602 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3605 this.closeButton
= new OO
.ui
.ButtonWidget( {
3609 title
: OO
.ui
.msg( 'ooui-item-remove' )
3610 } ).on( 'click', this.onCloseClick
.bind( this ) );
3612 this.on( 'disable', function ( disabled
) {
3613 this.closeButton
.setDisabled( disabled
);
3619 click
: this.onClick
.bind( this ),
3620 keydown
: this.onKeyDown
.bind( this )
3622 .addClass( 'oo-ui-capsuleItemWidget' )
3623 .append( this.$label
, this.closeButton
.$element
);
3628 OO
.inheritClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.Widget
);
3629 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.ItemWidget
);
3630 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.LabelElement
);
3631 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.FlaggedElement
);
3632 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3637 * Handle close icon clicks
3639 OO
.ui
.CapsuleItemWidget
.prototype.onCloseClick = function () {
3640 var element
= this.getElementGroup();
3642 if ( element
&& $.isFunction( element
.removeItems
) ) {
3643 element
.removeItems( [ this ] );
3649 * Handle click event for the entire capsule
3651 OO
.ui
.CapsuleItemWidget
.prototype.onClick = function () {
3652 var element
= this.getElementGroup();
3654 if ( !this.isDisabled() && element
&& $.isFunction( element
.editItem
) ) {
3655 element
.editItem( this );
3660 * Handle keyDown event for the entire capsule
3662 * @param {jQuery.Event} e Key down event
3664 OO
.ui
.CapsuleItemWidget
.prototype.onKeyDown = function ( e
) {
3665 var element
= this.getElementGroup();
3667 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
|| e
.keyCode
=== OO
.ui
.Keys
.DELETE
) {
3668 element
.removeItems( [ this ] );
3671 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ENTER
) {
3672 element
.editItem( this );
3674 } else if ( e
.keyCode
=== OO
.ui
.Keys
.LEFT
) {
3675 element
.getPreviousItem( this ).focus();
3676 } else if ( e
.keyCode
=== OO
.ui
.Keys
.RIGHT
) {
3677 element
.getNextItem( this ).focus();
3682 * CapsuleMultiselectWidgets are something like a {@link OO.ui.ComboBoxInputWidget combo box widget}
3683 * that allows for selecting multiple values.
3685 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
3688 * // Example: A CapsuleMultiselectWidget.
3689 * var capsule = new OO.ui.CapsuleMultiselectWidget( {
3690 * label: 'CapsuleMultiselectWidget',
3691 * selected: [ 'Option 1', 'Option 3' ],
3694 * new OO.ui.MenuOptionWidget( {
3696 * label: 'Option One'
3698 * new OO.ui.MenuOptionWidget( {
3700 * label: 'Option Two'
3702 * new OO.ui.MenuOptionWidget( {
3704 * label: 'Option Three'
3706 * new OO.ui.MenuOptionWidget( {
3708 * label: 'Option Four'
3710 * new OO.ui.MenuOptionWidget( {
3712 * label: 'Option Five'
3717 * $( 'body' ).append( capsule.$element );
3719 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
3722 * @extends OO.ui.Widget
3723 * @mixins OO.ui.mixin.GroupElement
3724 * @mixins OO.ui.mixin.PopupElement
3725 * @mixins OO.ui.mixin.TabIndexedElement
3726 * @mixins OO.ui.mixin.IndicatorElement
3727 * @mixins OO.ui.mixin.IconElement
3728 * @uses OO.ui.CapsuleItemWidget
3729 * @uses OO.ui.MenuSelectWidget
3732 * @param {Object} [config] Configuration options
3733 * @cfg {string} [placeholder] Placeholder text
3734 * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if not present in the menu.
3735 * @cfg {boolean} [allowDuplicates=false] Allow duplicate items to be added.
3736 * @cfg {Object} [menu] (required) Configuration options to pass to the
3737 * {@link OO.ui.MenuSelectWidget menu select widget}.
3738 * @cfg {Object} [popup] Configuration options to pass to the {@link OO.ui.PopupWidget popup widget}.
3739 * If specified, this popup will be shown instead of the menu (but the menu
3740 * will still be used for item labels and allowArbitrary=false). The widgets
3741 * in the popup should use {@link #addItemsFromData} or {@link #addItems} as necessary.
3742 * @cfg {jQuery} [$overlay=this.$element] Render the menu or popup into a separate layer.
3743 * This configuration is useful in cases where the expanded menu is larger than
3744 * its containing `<div>`. The specified overlay layer is usually on top of
3745 * the containing `<div>` and has a larger area. By default, the menu uses
3746 * relative positioning.
3747 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
3749 OO
.ui
.CapsuleMultiselectWidget
= function OoUiCapsuleMultiselectWidget( config
) {
3752 // Parent constructor
3753 OO
.ui
.CapsuleMultiselectWidget
.parent
.call( this, config
);
3755 // Configuration initialization
3756 config
= $.extend( {
3757 allowArbitrary
: false,
3758 allowDuplicates
: false,
3759 $overlay
: this.$element
3762 // Properties (must be set before mixin constructor calls)
3763 this.$handle
= $( '<div>' );
3764 this.$input
= config
.popup
? null : $( '<input>' );
3765 if ( config
.placeholder
!== undefined && config
.placeholder
!== '' ) {
3766 this.$input
.attr( 'placeholder', config
.placeholder
);
3769 // Mixin constructors
3770 OO
.ui
.mixin
.GroupElement
.call( this, config
);
3771 if ( config
.popup
) {
3772 config
.popup
= $.extend( {}, config
.popup
, {
3776 OO
.ui
.mixin
.PopupElement
.call( this, config
);
3777 $tabFocus
= $( '<span>' );
3778 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: $tabFocus
} ) );
3782 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$input
} ) );
3784 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3785 OO
.ui
.mixin
.IconElement
.call( this, config
);
3788 this.$content
= $( '<div>' );
3789 this.allowArbitrary
= config
.allowArbitrary
;
3790 this.allowDuplicates
= config
.allowDuplicates
;
3791 this.$overlay
= config
.$overlay
;
3792 this.menu
= new OO
.ui
.MenuSelectWidget( $.extend(
3795 $input
: this.$input
,
3796 $floatableContainer
: this.$element
,
3797 filterFromInput
: true,
3798 disabled
: this.isDisabled()
3806 focus
: this.focus
.bind( this )
3808 this.popup
.$element
.on( 'focusout', this.onPopupFocusOut
.bind( this ) );
3809 if ( this.popup
.$autoCloseIgnore
) {
3810 this.popup
.$autoCloseIgnore
.on( 'focusout', this.onPopupFocusOut
.bind( this ) );
3812 this.popup
.connect( this, {
3813 toggle: function ( visible
) {
3814 $tabFocus
.toggle( !visible
);
3819 focus
: this.onInputFocus
.bind( this ),
3820 blur
: this.onInputBlur
.bind( this ),
3821 'propertychange change click mouseup keydown keyup input cut paste select focus':
3822 OO
.ui
.debounce( this.updateInputSize
.bind( this ) ),
3823 keydown
: this.onKeyDown
.bind( this ),
3824 keypress
: this.onKeyPress
.bind( this )
3827 this.menu
.connect( this, {
3828 choose
: 'onMenuChoose',
3829 toggle
: 'onMenuToggle',
3830 add
: 'onMenuItemsChange',
3831 remove
: 'onMenuItemsChange'
3834 mousedown
: this.onMouseDown
.bind( this )
3838 if ( this.$input
) {
3839 this.$input
.prop( 'disabled', this.isDisabled() );
3842 'aria-owns': this.menu
.getElementId(),
3843 'aria-autocomplete': 'list'
3846 if ( config
.data
) {
3847 this.setItemsFromData( config
.data
);
3849 this.$content
.addClass( 'oo-ui-capsuleMultiselectWidget-content' )
3850 .append( this.$group
);
3851 this.$group
.addClass( 'oo-ui-capsuleMultiselectWidget-group' );
3852 this.$handle
.addClass( 'oo-ui-capsuleMultiselectWidget-handle' )
3853 .append( this.$indicator
, this.$icon
, this.$content
);
3854 this.$element
.addClass( 'oo-ui-capsuleMultiselectWidget' )
3855 .append( this.$handle
);
3857 this.popup
.$element
.addClass( 'oo-ui-capsuleMultiselectWidget-popup' );
3858 this.$content
.append( $tabFocus
);
3859 this.$overlay
.append( this.popup
.$element
);
3861 this.$content
.append( this.$input
);
3862 this.$overlay
.append( this.menu
.$element
);
3865 $tabFocus
.addClass( 'oo-ui-capsuleMultiselectWidget-focusTrap' );
3868 // Input size needs to be calculated after everything else is rendered
3869 setTimeout( function () {
3870 if ( this.$input
) {
3871 this.updateInputSize();
3875 this.onMenuItemsChange();
3880 OO
.inheritClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.Widget
);
3881 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.GroupElement
);
3882 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.PopupElement
);
3883 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3884 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.IndicatorElement
);
3885 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.IconElement
);
3892 * A change event is emitted when the set of selected items changes.
3894 * @param {Mixed[]} datas Data of the now-selected items
3900 * A resize event is emitted when the widget's dimensions change to accomodate newly added items or
3901 * current user input.
3907 * Construct a OO.ui.CapsuleItemWidget (or a subclass thereof) from given label and data.
3908 * May return `null` if the given label and data are not valid.
3911 * @param {Mixed} data Custom data of any type.
3912 * @param {string} label The label text.
3913 * @return {OO.ui.CapsuleItemWidget|null}
3915 OO
.ui
.CapsuleMultiselectWidget
.prototype.createItemWidget = function ( data
, label
) {
3916 if ( label
=== '' ) {
3919 return new OO
.ui
.CapsuleItemWidget( { data
: data
, label
: label
} );
3925 OO
.ui
.CapsuleMultiselectWidget
.prototype.getInputId = function () {
3926 if ( !this.$input
) {
3929 return OO
.ui
.mixin
.TabIndexedElement
.prototype.getInputId
.call( this );
3933 * Get the data of the items in the capsule
3937 OO
.ui
.CapsuleMultiselectWidget
.prototype.getItemsData = function () {
3938 return this.getItems().map( function ( item
) {
3944 * Set the items in the capsule by providing data
3947 * @param {Mixed[]} datas
3948 * @return {OO.ui.CapsuleMultiselectWidget}
3950 OO
.ui
.CapsuleMultiselectWidget
.prototype.setItemsFromData = function ( datas
) {
3953 items
= this.getItems();
3955 $.each( datas
, function ( i
, data
) {
3957 item
= menu
.getItemFromData( data
);
3961 } else if ( widget
.allowArbitrary
) {
3962 label
= String( data
);
3968 for ( j
= 0; j
< items
.length
; j
++ ) {
3969 if ( items
[ j
].data
=== data
&& items
[ j
].label
=== label
) {
3971 items
.splice( j
, 1 );
3976 item
= widget
.createItemWidget( data
, label
);
3979 widget
.addItems( [ item
], i
);
3983 if ( items
.length
) {
3984 widget
.removeItems( items
);
3991 * Add items to the capsule by providing their data
3994 * @param {Mixed[]} datas
3995 * @return {OO.ui.CapsuleMultiselectWidget}
3997 OO
.ui
.CapsuleMultiselectWidget
.prototype.addItemsFromData = function ( datas
) {
4002 $.each( datas
, function ( i
, data
) {
4005 if ( !widget
.getItemFromData( data
) || widget
.allowDuplicates
) {
4006 item
= menu
.getItemFromData( data
);
4008 item
= widget
.createItemWidget( data
, item
.label
);
4009 } else if ( widget
.allowArbitrary
) {
4010 item
= widget
.createItemWidget( data
, String( data
) );
4018 if ( items
.length
) {
4019 this.addItems( items
);
4026 * Add items to the capsule by providing a label
4028 * @param {string} label
4029 * @return {boolean} Whether the item was added or not
4031 OO
.ui
.CapsuleMultiselectWidget
.prototype.addItemFromLabel = function ( label
) {
4033 item
= this.menu
.getItemFromLabel( label
, true );
4035 this.addItemsFromData( [ item
.data
] );
4037 } else if ( this.allowArbitrary
) {
4038 items
= this.getItems();
4039 this.addItemsFromData( [ label
] );
4040 return !OO
.compare( this.getItems(), items
);
4046 * Remove items by data
4049 * @param {Mixed[]} datas
4050 * @return {OO.ui.CapsuleMultiselectWidget}
4052 OO
.ui
.CapsuleMultiselectWidget
.prototype.removeItemsFromData = function ( datas
) {
4056 $.each( datas
, function ( i
, data
) {
4057 var item
= widget
.getItemFromData( data
);
4063 if ( items
.length
) {
4064 this.removeItems( items
);
4073 OO
.ui
.CapsuleMultiselectWidget
.prototype.addItems = function ( items
) {
4075 oldItems
= this.items
.slice();
4077 OO
.ui
.mixin
.GroupElement
.prototype.addItems
.call( this, items
);
4079 if ( this.items
.length
!== oldItems
.length
) {
4083 for ( i
= 0, l
= oldItems
.length
; same
&& i
< l
; i
++ ) {
4084 same
= same
&& this.items
[ i
] === oldItems
[ i
];
4088 this.emit( 'change', this.getItemsData() );
4089 this.updateInputSize();
4096 * Removes the item from the list and copies its label to `this.$input`.
4098 * @param {Object} item
4100 OO
.ui
.CapsuleMultiselectWidget
.prototype.editItem = function ( item
) {
4101 this.addItemFromLabel( this.$input
.val() );
4103 this.$input
.val( item
.label
);
4104 this.updateInputSize();
4106 this.menu
.updateItemVisibility(); // Hack, we shouldn't be calling this method directly
4107 this.removeItems( [ item
] );
4113 OO
.ui
.CapsuleMultiselectWidget
.prototype.removeItems = function ( items
) {
4115 oldItems
= this.items
.slice();
4117 OO
.ui
.mixin
.GroupElement
.prototype.removeItems
.call( this, items
);
4119 if ( this.items
.length
!== oldItems
.length
) {
4123 for ( i
= 0, l
= oldItems
.length
; same
&& i
< l
; i
++ ) {
4124 same
= same
&& this.items
[ i
] === oldItems
[ i
];
4128 this.emit( 'change', this.getItemsData() );
4129 this.updateInputSize();
4138 OO
.ui
.CapsuleMultiselectWidget
.prototype.clearItems = function () {
4139 if ( this.items
.length
) {
4140 OO
.ui
.mixin
.GroupElement
.prototype.clearItems
.call( this );
4141 this.emit( 'change', this.getItemsData() );
4142 this.updateInputSize();
4148 * Given an item, returns the item after it. If its the last item,
4149 * returns `this.$input`. If no item is passed, returns the very first
4152 * @param {OO.ui.CapsuleItemWidget} [item]
4153 * @return {OO.ui.CapsuleItemWidget|jQuery|boolean}
4155 OO
.ui
.CapsuleMultiselectWidget
.prototype.getNextItem = function ( item
) {
4158 if ( item
=== undefined ) {
4159 return this.items
[ 0 ];
4162 itemIndex
= this.items
.indexOf( item
);
4163 if ( itemIndex
< 0 ) { // Item not in list
4165 } else if ( itemIndex
=== this.items
.length
- 1 ) { // Last item
4168 return this.items
[ itemIndex
+ 1 ];
4173 * Given an item, returns the item before it. If its the first item,
4174 * returns `this.$input`. If no item is passed, returns the very last
4177 * @param {OO.ui.CapsuleItemWidget} [item]
4178 * @return {OO.ui.CapsuleItemWidget|jQuery|boolean}
4180 OO
.ui
.CapsuleMultiselectWidget
.prototype.getPreviousItem = function ( item
) {
4183 if ( item
=== undefined ) {
4184 return this.items
[ this.items
.length
- 1 ];
4187 itemIndex
= this.items
.indexOf( item
);
4188 if ( itemIndex
< 0 ) { // Item not in list
4190 } else if ( itemIndex
=== 0 ) { // First item
4193 return this.items
[ itemIndex
- 1 ];
4198 * Get the capsule widget's menu.
4200 * @return {OO.ui.MenuSelectWidget} Menu widget
4202 OO
.ui
.CapsuleMultiselectWidget
.prototype.getMenu = function () {
4207 * Handle focus events
4210 * @param {jQuery.Event} event
4212 OO
.ui
.CapsuleMultiselectWidget
.prototype.onInputFocus = function () {
4213 if ( !this.isDisabled() ) {
4214 this.updateInputSize();
4215 this.menu
.toggle( true );
4220 * Handle blur events
4223 * @param {jQuery.Event} event
4225 OO
.ui
.CapsuleMultiselectWidget
.prototype.onInputBlur = function () {
4226 this.addItemFromLabel( this.$input
.val() );
4231 * Handles popup focus out events.
4234 * @param {jQuery.Event} e Focus out event
4236 OO
.ui
.CapsuleMultiselectWidget
.prototype.onPopupFocusOut = function () {
4237 var widget
= this.popup
;
4239 setTimeout( function () {
4241 widget
.isVisible() &&
4242 !OO
.ui
.contains( widget
.$element
.add( widget
.$autoCloseIgnore
).get(), document
.activeElement
, true )
4244 widget
.toggle( false );
4250 * Handle mouse down events.
4253 * @param {jQuery.Event} e Mouse down event
4255 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMouseDown = function ( e
) {
4256 if ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
4260 this.updateInputSize();
4265 * Handle key press events.
4268 * @param {jQuery.Event} e Key press event
4270 OO
.ui
.CapsuleMultiselectWidget
.prototype.onKeyPress = function ( e
) {
4271 if ( !this.isDisabled() ) {
4272 if ( e
.which
=== OO
.ui
.Keys
.ESCAPE
) {
4277 if ( !this.popup
) {
4278 this.menu
.toggle( true );
4279 if ( e
.which
=== OO
.ui
.Keys
.ENTER
) {
4280 if ( this.addItemFromLabel( this.$input
.val() ) ) {
4286 // Make sure the input gets resized.
4287 setTimeout( this.updateInputSize
.bind( this ), 0 );
4293 * Handle key down events.
4296 * @param {jQuery.Event} e Key down event
4298 OO
.ui
.CapsuleMultiselectWidget
.prototype.onKeyDown = function ( e
) {
4300 !this.isDisabled() &&
4301 this.$input
.val() === '' &&
4304 // 'keypress' event is not triggered for Backspace
4305 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
) {
4306 if ( e
.metaKey
|| e
.ctrlKey
) {
4307 this.removeItems( this.items
.slice( -1 ) );
4309 this.editItem( this.items
[ this.items
.length
- 1 ] );
4312 } else if ( e
.keyCode
=== OO
.ui
.Keys
.LEFT
) {
4313 this.getPreviousItem().focus();
4314 } else if ( e
.keyCode
=== OO
.ui
.Keys
.RIGHT
) {
4315 this.getNextItem().focus();
4321 * Update the dimensions of the text input field to encompass all available area.
4324 * @param {jQuery.Event} e Event of some sort
4326 OO
.ui
.CapsuleMultiselectWidget
.prototype.updateInputSize = function () {
4327 var $lastItem
, direction
, contentWidth
, currentWidth
, bestWidth
;
4328 if ( this.$input
&& !this.isDisabled() ) {
4329 this.$input
.css( 'width', '1em' );
4330 $lastItem
= this.$group
.children().last();
4331 direction
= OO
.ui
.Element
.static.getDir( this.$handle
);
4333 // Get the width of the input with the placeholder text as
4334 // the value and save it so that we don't keep recalculating
4336 this.contentWidthWithPlaceholder
=== undefined &&
4337 this.$input
.val() === '' &&
4338 this.$input
.attr( 'placeholder' ) !== undefined
4340 this.$input
.val( this.$input
.attr( 'placeholder' ) );
4341 this.contentWidthWithPlaceholder
= this.$input
[ 0 ].scrollWidth
;
4342 this.$input
.val( '' );
4346 // Always keep the input wide enough for the placeholder text
4347 contentWidth
= Math
.max(
4348 this.$input
[ 0 ].scrollWidth
,
4349 // undefined arguments in Math.max lead to NaN
4350 ( this.contentWidthWithPlaceholder
=== undefined ) ?
4351 0 : this.contentWidthWithPlaceholder
4353 currentWidth
= this.$input
.width();
4355 if ( contentWidth
< currentWidth
) {
4356 this.updateIfHeightChanged();
4357 // All is fine, don't perform expensive calculations
4361 if ( $lastItem
.length
=== 0 ) {
4362 bestWidth
= this.$content
.innerWidth();
4364 bestWidth
= direction
=== 'ltr' ?
4365 this.$content
.innerWidth() - $lastItem
.position().left
- $lastItem
.outerWidth() :
4366 $lastItem
.position().left
;
4369 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
4370 // pixels this is off by are coming from.
4372 if ( contentWidth
> bestWidth
) {
4373 // This will result in the input getting shifted to the next line
4374 bestWidth
= this.$content
.innerWidth() - 10;
4376 this.$input
.width( Math
.floor( bestWidth
) );
4377 this.updateIfHeightChanged();
4379 this.updateIfHeightChanged();
4384 * Determine if widget height changed, and if so, update menu position and emit 'resize' event.
4388 OO
.ui
.CapsuleMultiselectWidget
.prototype.updateIfHeightChanged = function () {
4389 var height
= this.$element
.height();
4390 if ( height
!== this.height
) {
4391 this.height
= height
;
4392 this.menu
.position();
4394 this.popup
.updateDimensions();
4396 this.emit( 'resize' );
4401 * Handle menu choose events.
4404 * @param {OO.ui.OptionWidget} item Chosen item
4406 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMenuChoose = function ( item
) {
4407 if ( item
&& item
.isVisible() ) {
4408 this.addItemsFromData( [ item
.getData() ] );
4414 * Handle menu toggle events.
4417 * @param {boolean} isVisible Menu toggle event
4419 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
4420 this.$element
.toggleClass( 'oo-ui-capsuleMultiselectWidget-open', isVisible
);
4424 * Handle menu item change events.
4428 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMenuItemsChange = function () {
4429 this.setItemsFromData( this.getItemsData() );
4430 this.$element
.toggleClass( 'oo-ui-capsuleMultiselectWidget-empty', this.menu
.isEmpty() );
4434 * Clear the input field
4438 OO
.ui
.CapsuleMultiselectWidget
.prototype.clearInput = function () {
4439 if ( this.$input
) {
4440 this.$input
.val( '' );
4441 this.updateInputSize();
4444 this.popup
.toggle( false );
4446 this.menu
.toggle( false );
4447 this.menu
.selectItem();
4448 this.menu
.highlightItem();
4454 OO
.ui
.CapsuleMultiselectWidget
.prototype.setDisabled = function ( disabled
) {
4458 OO
.ui
.CapsuleMultiselectWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
4460 if ( this.$input
) {
4461 this.$input
.prop( 'disabled', this.isDisabled() );
4464 this.menu
.setDisabled( this.isDisabled() );
4467 this.popup
.setDisabled( this.isDisabled() );
4471 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
4472 this.items
[ i
].updateDisabled();
4484 OO
.ui
.CapsuleMultiselectWidget
.prototype.focus = function () {
4485 if ( !this.isDisabled() ) {
4487 this.popup
.setSize( this.$handle
.outerWidth() );
4488 this.popup
.toggle( true );
4489 OO
.ui
.findFocusable( this.popup
.$element
).focus();
4491 OO
.ui
.mixin
.TabIndexedElement
.prototype.focus
.call( this );
4498 * TagItemWidgets are used within a {@link OO.ui.TagMultiselectWidget
4499 * TagMultiselectWidget} to display the selected items.
4502 * @extends OO.ui.Widget
4503 * @mixins OO.ui.mixin.ItemWidget
4504 * @mixins OO.ui.mixin.LabelElement
4505 * @mixins OO.ui.mixin.FlaggedElement
4506 * @mixins OO.ui.mixin.TabIndexedElement
4507 * @mixins OO.ui.mixin.DraggableElement
4510 * @param {Object} [config] Configuration object
4511 * @cfg {boolean} [valid=true] Item is valid
4513 OO
.ui
.TagItemWidget
= function OoUiTagItemWidget( config
) {
4514 config
= config
|| {};
4516 // Parent constructor
4517 OO
.ui
.TagItemWidget
.parent
.call( this, config
);
4519 // Mixin constructors
4520 OO
.ui
.mixin
.ItemWidget
.call( this );
4521 OO
.ui
.mixin
.LabelElement
.call( this, config
);
4522 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
4523 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
4524 OO
.ui
.mixin
.DraggableElement
.call( this, config
);
4526 this.valid
= config
.valid
=== undefined ? true : !!config
.valid
;
4528 this.closeButton
= new OO
.ui
.ButtonWidget( {
4532 title
: OO
.ui
.msg( 'ooui-item-remove' )
4534 this.closeButton
.setDisabled( this.isDisabled() );
4538 .connect( this, { click
: 'remove' } );
4540 .on( 'click', this.select
.bind( this ) )
4541 .on( 'keydown', this.onKeyDown
.bind( this ) )
4542 // Prevent propagation of mousedown; the tag item "lives" in the
4543 // clickable area of the TagMultiselectWidget, which listens to
4544 // mousedown to open the menu or popup. We want to prevent that
4545 // for clicks specifically on the tag itself, so the actions taken
4546 // are more deliberate. When the tag is clicked, it will emit the
4547 // selection event (similar to how #OO.ui.MultioptionWidget emits 'change')
4548 // and can be handled separately.
4549 .on( 'mousedown', function ( e
) { e
.stopPropagation(); } );
4553 .addClass( 'oo-ui-tagItemWidget' )
4554 .append( this.$label
, this.closeButton
.$element
);
4557 /* Initialization */
4559 OO
.inheritClass( OO
.ui
.TagItemWidget
, OO
.ui
.Widget
);
4560 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.ItemWidget
);
4561 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.LabelElement
);
4562 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.FlaggedElement
);
4563 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.TabIndexedElement
);
4564 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.DraggableElement
);
4571 * A remove action was performed on the item
4576 * @param {string} direction Direction of the movement, forward or backwards
4578 * A navigate action was performed on the item
4584 * The tag widget was selected. This can occur when the widget
4585 * is either clicked or enter was pressed on it.
4590 * @param {boolean} isValid Item is valid
4592 * Item validity has changed
4600 OO
.ui
.TagItemWidget
.prototype.setDisabled = function ( state
) {
4602 OO
.ui
.TagItemWidget
.parent
.prototype.setDisabled
.call( this, state
);
4604 if ( this.closeButton
) {
4605 this.closeButton
.setDisabled( state
);
4611 * Handle removal of the item
4613 * This is mainly for extensibility concerns, so other children
4614 * of this class can change the behavior if they need to. This
4615 * is called by both clicking the 'remove' button but also
4616 * on keypress, which is harder to override if needed.
4620 OO
.ui
.TagItemWidget
.prototype.remove = function () {
4621 if ( !this.isDisabled() ) {
4622 this.emit( 'remove' );
4627 * Handle a keydown event on the widget
4631 * @param {jQuery.Event} e Key down event
4632 * @return {boolean|undefined} false to stop the operation
4634 OO
.ui
.TagItemWidget
.prototype.onKeyDown = function ( e
) {
4637 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
|| e
.keyCode
=== OO
.ui
.Keys
.DELETE
) {
4640 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ENTER
) {
4644 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
4645 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
4647 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
4661 e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
4662 movement
.left
: movement
.right
4672 OO
.ui
.TagItemWidget
.prototype.select = function () {
4673 if ( !this.isDisabled() ) {
4674 this.emit( 'select' );
4679 * Set the valid state of this item
4681 * @param {boolean} [valid] Item is valid
4684 OO
.ui
.TagItemWidget
.prototype.toggleValid = function ( valid
) {
4685 valid
= valid
=== undefined ? !this.valid
: !!valid
;
4687 if ( this.valid
!== valid
) {
4690 this.setFlags( { invalid
: !this.valid
} );
4692 this.emit( 'valid', this.valid
);
4697 * Check whether the item is valid
4699 * @return {boolean} Item is valid
4701 OO
.ui
.TagItemWidget
.prototype.isValid = function () {
4706 * A basic tag multiselect widget, similar in concept to {@link OO.ui.ComboBoxInputWidget combo box widget}
4707 * that allows the user to add multiple values that are displayed in a tag area.
4709 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
4711 * This widget is a base widget; see {@link OO.ui.MenuTagMultiselectWidget MenuTagMultiselectWidget} and
4712 * {@link OO.ui.PopupTagMultiselectWidget PopupTagMultiselectWidget} for the implementations that use
4713 * a menu and a popup respectively.
4716 * // Example: A basic TagMultiselectWidget.
4717 * var widget = new OO.ui.TagMultiselectWidget( {
4718 * inputPosition: 'outline',
4719 * allowedValues: [ 'Option 1', 'Option 2', 'Option 3' ],
4720 * selected: [ 'Option 1' ]
4722 * $( 'body' ).append( widget.$element );
4724 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
4727 * @extends OO.ui.Widget
4728 * @mixins OO.ui.mixin.GroupWidget
4729 * @mixins OO.ui.mixin.DraggableGroupElement
4730 * @mixins OO.ui.mixin.IndicatorElement
4731 * @mixins OO.ui.mixin.IconElement
4732 * @mixins OO.ui.mixin.TabIndexedElement
4733 * @mixins OO.ui.mixin.FlaggedElement
4736 * @param {Object} config Configuration object
4737 * @cfg {Object} [input] Configuration options for the input widget
4738 * @cfg {OO.ui.InputWidget} [inputWidget] An optional input widget. If given, it will
4739 * replace the input widget used in the TagMultiselectWidget. If not given,
4740 * TagMultiselectWidget creates its own.
4741 * @cfg {boolean} [inputPosition='inline'] Position of the input. Options are:
4742 * - inline: The input is invisible, but exists inside the tag list, so
4743 * the user types into the tag groups to add tags.
4744 * - outline: The input is underneath the tag area.
4745 * - none: No input supplied
4746 * @cfg {boolean} [allowEditTags=true] Allow editing of the tags by clicking them
4747 * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if
4748 * not present in the menu.
4749 * @cfg {Object[]} [allowedValues] An array representing the allowed items
4751 * @cfg {boolean} [allowDuplicates=false] Allow duplicate items to be added
4752 * @cfg {boolean} [allowDisplayInvalidTags=false] Allow the display of
4753 * invalid tags. These tags will display with an invalid state, and
4754 * the widget as a whole will have an invalid state if any invalid tags
4756 * @cfg {boolean} [allowReordering=true] Allow reordering of the items
4757 * @cfg {Object[]|String[]} [selected] A set of selected tags. If given,
4758 * these will appear in the tag list on initialization, as long as they
4759 * pass the validity tests.
4761 OO
.ui
.TagMultiselectWidget
= function OoUiTagMultiselectWidget( config
) {
4763 rAF
= window
.requestAnimationFrame
|| setTimeout
,
4765 $tabFocus
= $( '<span>' )
4766 .addClass( 'oo-ui-tagMultiselectWidget-focusTrap' );
4768 config
= config
|| {};
4770 // Parent constructor
4771 OO
.ui
.TagMultiselectWidget
.parent
.call( this, config
);
4773 // Mixin constructors
4774 OO
.ui
.mixin
.GroupWidget
.call( this, config
);
4775 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
4776 OO
.ui
.mixin
.IconElement
.call( this, config
);
4777 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
4778 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
4779 OO
.ui
.mixin
.DraggableGroupElement
.call( this, config
);
4781 this.toggleDraggable(
4782 config
.allowReordering
=== undefined ?
4783 true : !!config
.allowReordering
4786 this.inputPosition
=
4787 this.constructor.static.allowedInputPositions
.indexOf( config
.inputPosition
) > -1 ?
4788 config
.inputPosition
: 'inline';
4789 this.allowEditTags
= config
.allowEditTags
=== undefined ? true : !!config
.allowEditTags
;
4790 this.allowArbitrary
= !!config
.allowArbitrary
;
4791 this.allowDuplicates
= !!config
.allowDuplicates
;
4792 this.allowedValues
= config
.allowedValues
|| [];
4793 this.allowDisplayInvalidTags
= config
.allowDisplayInvalidTags
;
4794 this.hasInput
= this.inputPosition
!== 'none';
4798 this.$content
= $( '<div>' )
4799 .addClass( 'oo-ui-tagMultiselectWidget-content' );
4800 this.$handle
= $( '<div>' )
4801 .addClass( 'oo-ui-tagMultiselectWidget-handle' )
4808 .addClass( 'oo-ui-tagMultiselectWidget-group' )
4814 remove
: 'itemRemove',
4815 navigate
: 'itemNavigate',
4816 select
: 'itemSelect'
4818 this.connect( this, {
4819 itemRemove
: 'onTagRemove',
4820 itemSelect
: 'onTagSelect',
4821 itemNavigate
: 'onTagNavigate',
4822 change
: 'onChangeTags'
4825 mousedown
: this.onMouseDown
.bind( this )
4830 .addClass( 'oo-ui-tagMultiselectWidget' )
4831 .append( this.$handle
);
4833 if ( this.hasInput
) {
4834 if ( config
.inputWidget
) {
4835 this.input
= config
.inputWidget
;
4837 this.input
= new OO
.ui
.TextInputWidget( $.extend( {
4838 placeholder
: config
.placeholder
,
4839 classes
: [ 'oo-ui-tagMultiselectWidget-input' ]
4840 }, config
.input
) );
4842 this.input
.setDisabled( this.isDisabled() );
4845 focus
: this.onInputFocus
.bind( this ),
4846 blur
: this.onInputBlur
.bind( this ),
4847 'propertychange change click mouseup keydown keyup input cut paste select focus':
4848 OO
.ui
.debounce( this.updateInputSize
.bind( this ) ),
4849 keydown
: this.onInputKeyDown
.bind( this ),
4850 keypress
: this.onInputKeyPress
.bind( this )
4853 this.input
.$input
.on( inputEvents
);
4855 if ( this.inputPosition
=== 'outline' ) {
4856 // Override max-height for the input widget
4857 // in the case the widget is outline so it can
4858 // stretch all the way if the widet is wide
4859 this.input
.$element
.css( 'max-width', 'inherit' );
4861 .addClass( 'oo-ui-tagMultiselectWidget-outlined' )
4862 .append( this.input
.$element
);
4864 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-inlined' );
4865 // HACK: When the widget is using 'inline' input, the
4866 // behavior needs to only use the $input itself
4867 // so we style and size it accordingly (otherwise
4868 // the styling and sizing can get very convoluted
4869 // when the wrapping divs and other elements)
4870 // We are taking advantage of still being able to
4871 // call the widget itself for operations like
4872 // .getValue() and setDisabled() and .focus() but
4873 // having only the $input attached to the DOM
4874 this.$content
.append( this.input
.$input
);
4877 this.$content
.append( $tabFocus
);
4880 this.setTabIndexedElement(
4886 if ( config
.selected
) {
4887 this.setValue( config
.selected
);
4890 // HACK: Input size needs to be calculated after everything
4893 if ( widget
.hasInput
) {
4894 widget
.updateInputSize();
4899 /* Initialization */
4901 OO
.inheritClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.Widget
);
4902 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.GroupWidget
);
4903 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.DraggableGroupElement
);
4904 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IndicatorElement
);
4905 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IconElement
);
4906 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
4907 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.FlaggedElement
);
4909 /* Static properties */
4912 * Allowed input positions.
4913 * - inline: The input is inside the tag list
4914 * - outline: The input is under the tag list
4915 * - none: There is no input
4919 OO
.ui
.TagMultiselectWidget
.static.allowedInputPositions
= [ 'inline', 'outline', 'none' ];
4924 * Handle mouse down events.
4927 * @param {jQuery.Event} e Mouse down event
4928 * @return {boolean} False to prevent defaults
4930 OO
.ui
.TagMultiselectWidget
.prototype.onMouseDown = function ( e
) {
4931 if ( !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
4938 * Handle key press events.
4941 * @param {jQuery.Event} e Key press event
4942 * @return {boolean} Whether to prevent defaults
4944 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyPress = function ( e
) {
4946 withMetaKey
= e
.metaKey
|| e
.ctrlKey
;
4948 if ( !this.isDisabled() ) {
4949 if ( e
.which
=== OO
.ui
.Keys
.ENTER
) {
4950 stopOrContinue
= this.doInputEnter( e
, withMetaKey
);
4953 // Make sure the input gets resized.
4954 setTimeout( this.updateInputSize
.bind( this ), 0 );
4955 return stopOrContinue
;
4960 * Handle key down events.
4963 * @param {jQuery.Event} e Key down event
4966 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyDown = function ( e
) {
4967 var movement
, direction
,
4968 withMetaKey
= e
.metaKey
|| e
.ctrlKey
;
4970 if ( !this.isDisabled() ) {
4971 // 'keypress' event is not triggered for Backspace
4972 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
) {
4973 return this.doInputBackspace( e
, withMetaKey
);
4974 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ESCAPE
) {
4975 return this.doInputEscape( e
);
4977 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
4978 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
4980 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
4991 direction
= e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
4992 movement
.left
: movement
.right
;
4994 return this.doInputArrow( e
, direction
, withMetaKey
);
5000 * Respond to input focus event
5002 OO
.ui
.TagMultiselectWidget
.prototype.onInputFocus = function () {
5003 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-focus' );
5007 * Respond to input blur event
5009 OO
.ui
.TagMultiselectWidget
.prototype.onInputBlur = function () {
5010 this.$element
.removeClass( 'oo-ui-tagMultiselectWidget-focus' );
5014 * Perform an action after the enter key on the input
5016 * @param {jQuery.Event} e Event data
5017 * @param {boolean} [withMetaKey] Whether this key was pressed with
5018 * a meta key like 'ctrl'
5019 * @return {boolean} Whether to prevent defaults
5021 OO
.ui
.TagMultiselectWidget
.prototype.doInputEnter = function () {
5022 this.addTagFromInput();
5027 * Perform an action responding to the enter key on the input
5029 * @param {jQuery.Event} e Event data
5030 * @param {boolean} [withMetaKey] Whether this key was pressed with
5031 * a meta key like 'ctrl'
5032 * @return {boolean} Whether to prevent defaults
5034 OO
.ui
.TagMultiselectWidget
.prototype.doInputBackspace = function ( e
, withMetaKey
) {
5038 this.inputPosition
=== 'inline' &&
5039 this.input
.getValue() === '' &&
5042 // Delete the last item
5043 items
= this.getItems();
5044 item
= items
[ items
.length
- 1 ];
5045 this.removeItems( [ item
] );
5046 // If Ctrl/Cmd was pressed, delete item entirely.
5047 // Otherwise put it into the text field for editing.
5048 if ( !withMetaKey
) {
5049 this.input
.setValue( item
.getData() );
5057 * Perform an action after the escape key on the input
5059 * @param {jQuery.Event} e Event data
5061 OO
.ui
.TagMultiselectWidget
.prototype.doInputEscape = function () {
5066 * Perform an action after the arrow key on the input, select the previous
5067 * or next item from the input.
5068 * See #getPreviousItem and #getNextItem
5070 * @param {jQuery.Event} e Event data
5071 * @param {string} direction Direction of the movement; forwards or backwards
5072 * @param {boolean} [withMetaKey] Whether this key was pressed with
5073 * a meta key like 'ctrl'
5075 OO
.ui
.TagMultiselectWidget
.prototype.doInputArrow = function ( e
, direction
) {
5077 this.inputPosition
=== 'inline' &&
5080 if ( direction
=== 'backwards' ) {
5081 // Get previous item
5082 this.getPreviousItem().focus();
5085 this.getNextItem().focus();
5091 * Respond to item select event
5093 * @param {OO.ui.TagItemWidget} item Selected item
5095 OO
.ui
.TagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
5096 if ( this.hasInput
&& this.allowEditTags
) {
5097 if ( this.input
.getValue() ) {
5098 this.addTagFromInput();
5100 // 1. Get the label of the tag into the input
5101 this.input
.setValue( item
.getData() );
5102 // 2. Remove the tag
5103 this.removeItems( [ item
] );
5104 // 3. Focus the input
5110 * Respond to change event, where items were added, removed, or cleared.
5112 OO
.ui
.TagMultiselectWidget
.prototype.onChangeTags = function () {
5113 this.toggleValid( this.checkValidity() );
5114 if ( this.hasInput
) {
5115 this.updateInputSize();
5117 this.updateIfHeightChanged();
5123 OO
.ui
.TagMultiselectWidget
.prototype.setDisabled = function ( isDisabled
) {
5125 OO
.ui
.TagMultiselectWidget
.parent
.prototype.setDisabled
.call( this, isDisabled
);
5127 if ( this.hasInput
&& this.input
) {
5128 this.input
.setDisabled( !!isDisabled
);
5132 this.getItems().forEach( function ( item
) {
5133 item
.setDisabled( !!isDisabled
);
5139 * Respond to tag remove event
5140 * @param {OO.ui.TagItemWidget} item Removed tag
5142 OO
.ui
.TagMultiselectWidget
.prototype.onTagRemove = function ( item
) {
5143 this.removeTagByData( item
.getData() );
5147 * Respond to navigate event on the tag
5149 * @param {OO.ui.TagItemWidget} item Removed tag
5150 * @param {string} direction Direction of movement; 'forwards' or 'backwards'
5152 OO
.ui
.TagMultiselectWidget
.prototype.onTagNavigate = function ( item
, direction
) {
5153 if ( direction
=== 'forwards' ) {
5154 this.getNextItem( item
).focus();
5156 this.getPreviousItem( item
).focus();
5161 * Add tag from input value
5163 OO
.ui
.TagMultiselectWidget
.prototype.addTagFromInput = function () {
5164 var val
= this.input
.getValue(),
5165 isValid
= this.isAllowedData( val
);
5171 if ( isValid
|| this.allowDisplayInvalidTags
) {
5181 OO
.ui
.TagMultiselectWidget
.prototype.clearInput = function () {
5182 this.input
.setValue( '' );
5186 * Check whether the given value is a duplicate of an existing
5187 * tag already in the list.
5189 * @param {string|Object} data Requested value
5190 * @return {boolean} Value is duplicate
5192 OO
.ui
.TagMultiselectWidget
.prototype.isDuplicateData = function ( data
) {
5193 return !!this.getItemFromData( data
);
5197 * Check whether a given value is allowed to be added
5199 * @param {string|Object} data Requested value
5200 * @return {boolean} Value is allowed
5202 OO
.ui
.TagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
5204 !this.allowDuplicates
&&
5205 this.isDuplicateData( data
)
5210 if ( this.allowArbitrary
) {
5214 // Check with allowed values
5216 this.getAllowedValues().some( function ( value
) {
5217 return data
=== value
;
5227 * Get the allowed values list
5229 * @return {string[]} Allowed data values
5231 OO
.ui
.TagMultiselectWidget
.prototype.getAllowedValues = function () {
5232 return this.allowedValues
;
5236 * Add a value to the allowed values list
5238 * @param {string} value Allowed data value
5240 OO
.ui
.TagMultiselectWidget
.prototype.addAllowedValue = function ( value
) {
5241 if ( this.allowedValues
.indexOf( value
) === -1 ) {
5242 this.allowedValues
.push( value
);
5247 * Get the datas of the currently selected items
5249 * @return {string[]|Object[]} Datas of currently selected items
5251 OO
.ui
.TagMultiselectWidget
.prototype.getValue = function () {
5252 return this.getItems()
5253 .filter( function ( item
) {
5254 return item
.isValid();
5256 .map( function ( item
) {
5257 return item
.getData();
5262 * Set the value of this widget by datas.
5264 * @param {string|string[]|Object|Object[]} valueObject An object representing the data
5265 * and label of the value. If the widget allows arbitrary values,
5266 * the items will be added as-is. Otherwise, the data value will
5267 * be checked against allowedValues.
5268 * This object must contain at least a data key. Example:
5269 * { data: 'foo', label: 'Foo item' }
5270 * For multiple items, use an array of objects. For example:
5272 * { data: 'foo', label: 'Foo item' },
5273 * { data: 'bar', label: 'Bar item' }
5275 * Value can also be added with plaintext array, for example:
5276 * [ 'foo', 'bar', 'bla' ] or a single string, like 'foo'
5278 OO
.ui
.TagMultiselectWidget
.prototype.setValue = function ( valueObject
) {
5279 valueObject
= Array
.isArray( valueObject
) ? valueObject
: [ valueObject
];
5282 valueObject
.forEach( function ( obj
) {
5283 if ( typeof obj
=== 'string' ) {
5286 this.addTag( obj
.data
, obj
.label
);
5292 * Add tag to the display area
5294 * @param {string|Object} data Tag data
5295 * @param {string} [label] Tag label. If no label is provided, the
5296 * stringified version of the data will be used instead.
5297 * @return {boolean} Item was added successfully
5299 OO
.ui
.TagMultiselectWidget
.prototype.addTag = function ( data
, label
) {
5301 isValid
= this.isAllowedData( data
);
5303 if ( isValid
|| this.allowDisplayInvalidTags
) {
5304 newItemWidget
= this.createTagItemWidget( data
, label
);
5305 newItemWidget
.toggleValid( isValid
);
5306 this.addItems( [ newItemWidget
] );
5313 * Remove tag by its data property.
5315 * @param {string|Object} data Tag data
5317 OO
.ui
.TagMultiselectWidget
.prototype.removeTagByData = function ( data
) {
5318 var item
= this.getItemFromData( data
);
5320 this.removeItems( [ item
] );
5324 * Construct a OO.ui.TagItemWidget (or a subclass thereof) from given label and data.
5327 * @param {string} data Item data
5328 * @param {string} label The label text.
5329 * @return {OO.ui.TagItemWidget}
5331 OO
.ui
.TagMultiselectWidget
.prototype.createTagItemWidget = function ( data
, label
) {
5332 label
= label
|| data
;
5334 return new OO
.ui
.TagItemWidget( { data
: data
, label
: label
} );
5338 * Given an item, returns the item after it. If the item is already the
5339 * last item, return `this.input`. If no item is passed, returns the
5343 * @param {OO.ui.TagItemWidget} [item] Tag item
5344 * @return {OO.ui.Widget} The next widget available.
5346 OO
.ui
.TagMultiselectWidget
.prototype.getNextItem = function ( item
) {
5347 var itemIndex
= this.items
.indexOf( item
);
5349 if ( item
=== undefined || itemIndex
=== -1 ) {
5350 return this.items
[ 0 ];
5353 if ( itemIndex
=== this.items
.length
- 1 ) { // Last item
5354 if ( this.hasInput
) {
5357 // Return first item
5358 return this.items
[ 0 ];
5361 return this.items
[ itemIndex
+ 1 ];
5366 * Given an item, returns the item before it. If the item is already the
5367 * first item, return `this.input`. If no item is passed, returns the
5371 * @param {OO.ui.TagItemWidget} [item] Tag item
5372 * @return {OO.ui.Widget} The previous widget available.
5374 OO
.ui
.TagMultiselectWidget
.prototype.getPreviousItem = function ( item
) {
5375 var itemIndex
= this.items
.indexOf( item
);
5377 if ( item
=== undefined || itemIndex
=== -1 ) {
5378 return this.items
[ this.items
.length
- 1 ];
5381 if ( itemIndex
=== 0 ) {
5382 if ( this.hasInput
) {
5385 // Return the last item
5386 return this.items
[ this.items
.length
- 1 ];
5389 return this.items
[ itemIndex
- 1 ];
5394 * Update the dimensions of the text input field to encompass all available area.
5395 * This is especially relevant for when the input is at the edge of a line
5396 * and should get smaller. The usual operation (as an inline-block with min-width)
5397 * does not work in that case, pushing the input downwards to the next line.
5401 OO
.ui
.TagMultiselectWidget
.prototype.updateInputSize = function () {
5402 var $lastItem
, direction
, contentWidth
, currentWidth
, bestWidth
;
5403 if ( this.inputPosition
=== 'inline' && !this.isDisabled() ) {
5404 if ( this.input
.$input
[ 0 ].scrollWidth
=== 0 ) {
5405 // Input appears to be attached but not visible.
5406 // Don't attempt to adjust its size, because our measurements
5407 // are going to fail anyway.
5410 this.input
.$input
.css( 'width', '1em' );
5411 $lastItem
= this.$group
.children().last();
5412 direction
= OO
.ui
.Element
.static.getDir( this.$handle
);
5414 // Get the width of the input with the placeholder text as
5415 // the value and save it so that we don't keep recalculating
5417 this.contentWidthWithPlaceholder
=== undefined &&
5418 this.input
.getValue() === '' &&
5419 this.input
.$input
.attr( 'placeholder' ) !== undefined
5421 this.input
.setValue( this.input
.$input
.attr( 'placeholder' ) );
5422 this.contentWidthWithPlaceholder
= this.input
.$input
[ 0 ].scrollWidth
;
5423 this.input
.setValue( '' );
5427 // Always keep the input wide enough for the placeholder text
5428 contentWidth
= Math
.max(
5429 this.input
.$input
[ 0 ].scrollWidth
,
5430 // undefined arguments in Math.max lead to NaN
5431 ( this.contentWidthWithPlaceholder
=== undefined ) ?
5432 0 : this.contentWidthWithPlaceholder
5434 currentWidth
= this.input
.$input
.width();
5436 if ( contentWidth
< currentWidth
) {
5437 this.updateIfHeightChanged();
5438 // All is fine, don't perform expensive calculations
5442 if ( $lastItem
.length
=== 0 ) {
5443 bestWidth
= this.$content
.innerWidth();
5445 bestWidth
= direction
=== 'ltr' ?
5446 this.$content
.innerWidth() - $lastItem
.position().left
- $lastItem
.outerWidth() :
5447 $lastItem
.position().left
;
5450 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
5451 // pixels this is off by are coming from.
5453 if ( contentWidth
> bestWidth
) {
5454 // This will result in the input getting shifted to the next line
5455 bestWidth
= this.$content
.innerWidth() - 10;
5457 this.input
.$input
.width( Math
.floor( bestWidth
) );
5458 this.updateIfHeightChanged();
5460 this.updateIfHeightChanged();
5465 * Determine if widget height changed, and if so,
5466 * emit the resize event. This is useful for when there are either
5467 * menus or popups attached to the bottom of the widget, to allow
5468 * them to change their positioning in case the widget moved down
5473 OO
.ui
.TagMultiselectWidget
.prototype.updateIfHeightChanged = function () {
5474 var height
= this.$element
.height();
5475 if ( height
!== this.height
) {
5476 this.height
= height
;
5477 this.emit( 'resize' );
5482 * Check whether all items in the widget are valid
5484 * @return {boolean} Widget is valid
5486 OO
.ui
.TagMultiselectWidget
.prototype.checkValidity = function () {
5487 return this.getItems().every( function ( item
) {
5488 return item
.isValid();
5493 * Set the valid state of this item
5495 * @param {boolean} [valid] Item is valid
5498 OO
.ui
.TagMultiselectWidget
.prototype.toggleValid = function ( valid
) {
5499 valid
= valid
=== undefined ? !this.valid
: !!valid
;
5501 if ( this.valid
!== valid
) {
5504 this.setFlags( { invalid
: !this.valid
} );
5506 this.emit( 'valid', this.valid
);
5511 * Get the current valid state of the widget
5513 * @return {boolean} Widget is valid
5515 OO
.ui
.TagMultiselectWidget
.prototype.isValid = function () {
5520 * PopupTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
5521 * to use a popup. The popup can be configured to have a default input to insert values into the widget.
5523 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
5526 * // Example: A basic PopupTagMultiselectWidget.
5527 * var widget = new OO.ui.PopupTagMultiselectWidget();
5528 * $( 'body' ).append( widget.$element );
5530 * // Example: A PopupTagMultiselectWidget with an external popup.
5531 * var popupInput = new OO.ui.TextInputWidget(),
5532 * widget = new OO.ui.PopupTagMultiselectWidget( {
5533 * popupInput: popupInput,
5535 * $content: popupInput.$element
5538 * $( 'body' ).append( widget.$element );
5540 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
5543 * @extends OO.ui.TagMultiselectWidget
5544 * @mixins OO.ui.mixin.PopupElement
5546 * @param {Object} config Configuration object
5547 * @cfg {jQuery} [$overlay] An overlay for the popup.
5548 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
5549 * @cfg {Object} [popup] Configuration options for the popup
5550 * @cfg {OO.ui.InputWidget} [popupInput] An input widget inside the popup that will be
5551 * focused when the popup is opened and will be used as replacement for the
5552 * general input in the widget.
5554 OO
.ui
.PopupTagMultiselectWidget
= function OoUiPopupTagMultiselectWidget( config
) {
5556 defaultConfig
= { popup
: {} };
5558 config
= config
|| {};
5560 // Parent constructor
5561 OO
.ui
.PopupTagMultiselectWidget
.parent
.call( this, $.extend( { inputPosition
: 'none' }, config
) );
5563 this.$overlay
= config
.$overlay
|| this.$element
;
5565 if ( !config
.popup
) {
5566 // For the default base implementation, we give a popup
5567 // with an input widget inside it. For any other use cases
5568 // the popup needs to be populated externally and the
5569 // event handled to add tags separately and manually
5570 defaultInput
= new OO
.ui
.TextInputWidget();
5572 defaultConfig
.popupInput
= defaultInput
;
5573 defaultConfig
.popup
.$content
= defaultInput
.$element
;
5575 this.$element
.addClass( 'oo-ui-popupTagMultiselectWidget-defaultPopup' );
5578 // Add overlay, and add that to the autoCloseIgnore
5579 defaultConfig
.popup
.$overlay
= this.$overlay
;
5580 defaultConfig
.popup
.$autoCloseIgnore
= this.hasInput
?
5581 this.input
.$element
.add( this.$overlay
) : this.$overlay
;
5583 // Allow extending any of the above
5584 config
= $.extend( defaultConfig
, config
);
5586 // Mixin constructors
5587 OO
.ui
.mixin
.PopupElement
.call( this, config
);
5589 if ( this.hasInput
) {
5590 this.input
.$input
.on( 'focus', this.popup
.toggle
.bind( this.popup
, true ) );
5593 // Configuration options
5594 this.popupInput
= config
.popupInput
;
5595 if ( this.popupInput
) {
5596 this.popupInput
.connect( this, {
5597 enter
: 'onPopupInputEnter'
5602 this.on( 'resize', this.popup
.updateDimensions
.bind( this.popup
) );
5603 this.popup
.connect( this, { toggle
: 'onPopupToggle' } );
5605 .on( 'focus', this.onFocus
.bind( this ) );
5609 .append( this.popup
.$element
)
5610 .addClass( 'oo-ui-popupTagMultiselectWidget' );
5613 /* Initialization */
5615 OO
.inheritClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
5616 OO
.mixinClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.mixin
.PopupElement
);
5621 * Focus event handler.
5625 OO
.ui
.PopupTagMultiselectWidget
.prototype.onFocus = function () {
5626 this.popup
.toggle( true );
5630 * Respond to popup toggle event
5632 * @param {boolean} isVisible Popup is visible
5634 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupToggle = function ( isVisible
) {
5635 if ( isVisible
&& this.popupInput
) {
5636 this.popupInput
.focus();
5641 * Respond to popup input enter event
5643 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupInputEnter = function () {
5644 if ( this.popupInput
) {
5645 this.addTagByPopupValue( this.popupInput
.getValue() );
5646 this.popupInput
.setValue( '' );
5653 OO
.ui
.PopupTagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
5654 if ( this.popupInput
&& this.allowEditTags
) {
5655 this.popupInput
.setValue( item
.getData() );
5656 this.removeItems( [ item
] );
5658 this.popup
.toggle( true );
5659 this.popupInput
.focus();
5662 OO
.ui
.PopupTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, item
);
5667 * Add a tag by the popup value.
5668 * Whatever is responsible for setting the value in the popup should call
5669 * this method to add a tag, or use the regular methods like #addTag or
5670 * #setValue directly.
5672 * @param {string} data The value of item
5673 * @param {string} [label] The label of the tag. If not given, the data is used.
5675 OO
.ui
.PopupTagMultiselectWidget
.prototype.addTagByPopupValue = function ( data
, label
) {
5676 this.addTag( data
, label
);
5680 * MenuTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
5681 * to use a menu of selectable options.
5683 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
5686 * // Example: A basic MenuTagMultiselectWidget.
5687 * var widget = new OO.ui.MenuTagMultiselectWidget( {
5688 * inputPosition: 'outline',
5690 * { data: 'option1', label: 'Option 1' },
5691 * { data: 'option2', label: 'Option 2' },
5692 * { data: 'option3', label: 'Option 3' },
5694 * selected: [ 'option1', 'option2' ]
5696 * $( 'body' ).append( widget.$element );
5698 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
5701 * @extends OO.ui.TagMultiselectWidget
5704 * @param {Object} [config] Configuration object
5705 * @cfg {Object} [menu] Configuration object for the menu widget
5706 * @cfg {jQuery} [$overlay] An overlay for the menu.
5707 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
5708 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
5710 OO
.ui
.MenuTagMultiselectWidget
= function OoUiMenuTagMultiselectWidget( config
) {
5711 config
= config
|| {};
5713 // Parent constructor
5714 OO
.ui
.MenuTagMultiselectWidget
.parent
.call( this, config
);
5716 this.$overlay
= config
.$overlay
|| this.$element
;
5718 this.menu
= this.createMenuWidget( $.extend( {
5720 input
: this.hasInput
? this.input
: null,
5721 $input
: this.hasInput
? this.input
.$input
: null,
5722 filterFromInput
: !!this.hasInput
,
5723 $autoCloseIgnore
: this.hasInput
?
5724 this.input
.$element
.add( this.$overlay
) : this.$overlay
,
5725 $floatableContainer
: this.hasInput
&& this.inputPosition
=== 'outline' ?
5726 this.input
.$element
: this.$element
,
5727 $overlay
: this.$overlay
,
5728 disabled
: this.isDisabled()
5730 this.addOptions( config
.options
|| [] );
5733 this.menu
.connect( this, {
5734 choose
: 'onMenuChoose',
5735 toggle
: 'onMenuToggle'
5737 if ( this.hasInput
) {
5738 this.input
.connect( this, { change
: 'onInputChange' } );
5740 this.connect( this, { resize
: 'onResize' } );
5744 .append( this.menu
.$element
);
5746 .addClass( 'oo-ui-menuTagMultiselectWidget' );
5747 // TagMultiselectWidget already does this, but it doesn't work right because this.menu is not yet
5748 // set up while the parent constructor runs, and #getAllowedValues rejects everything.
5749 if ( config
.selected
) {
5750 this.setValue( config
.selected
);
5754 /* Initialization */
5756 OO
.inheritClass( OO
.ui
.MenuTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
5761 * Respond to resize event
5763 OO
.ui
.MenuTagMultiselectWidget
.prototype.onResize = function () {
5764 // Reposition the menu
5765 this.menu
.position();
5771 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputFocus = function () {
5773 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
5775 this.menu
.toggle( true );
5779 * Respond to input change event
5781 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputChange = function () {
5782 this.menu
.toggle( true );
5786 * Respond to menu choose event
5788 * @param {OO.ui.OptionWidget} menuItem Chosen menu item
5790 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuChoose = function ( menuItem
) {
5792 this.addTag( menuItem
.getData(), menuItem
.getLabel() );
5796 * Respond to menu toggle event. Reset item highlights on hide.
5798 * @param {boolean} isVisible The menu is visible
5800 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
5802 this.menu
.selectItem( null );
5803 this.menu
.highlightItem( null );
5810 OO
.ui
.MenuTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
5811 var menuItem
= this.menu
.getItemFromData( tagItem
.getData() );
5812 // Override the base behavior from TagMultiselectWidget; the base behavior
5813 // in TagMultiselectWidget is to remove the tag to edit it in the input,
5814 // but in our case, we want to utilize the menu selection behavior, and
5815 // definitely not remove the item.
5817 // Select the menu item
5818 this.menu
.selectItem( menuItem
);
5826 OO
.ui
.MenuTagMultiselectWidget
.prototype.addTagFromInput = function () {
5827 var inputValue
= this.input
.getValue(),
5829 highlightedItem
= this.menu
.findHighlightedItem(),
5830 item
= this.menu
.getItemFromData( inputValue
);
5832 // Override the parent method so we add from the menu
5833 // rather than directly from the input
5835 // Look for a highlighted item first
5836 if ( highlightedItem
) {
5837 validated
= this.addTag( highlightedItem
.getData(), highlightedItem
.getLabel() );
5838 } else if ( item
) {
5839 // Look for the element that fits the data
5840 validated
= this.addTag( item
.getData(), item
.getLabel() );
5842 // Otherwise, add the tag - the method will only add if the
5843 // tag is valid or if invalid tags are allowed
5844 validated
= this.addTag( inputValue
);
5854 * Return the visible items in the menu. This is mainly used for when
5855 * the menu is filtering results.
5857 * @return {OO.ui.MenuOptionWidget[]} Visible results
5859 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenuVisibleItems = function () {
5860 return this.menu
.getItems().filter( function ( menuItem
) {
5861 return menuItem
.isVisible();
5866 * Create the menu for this widget. This is in a separate method so that
5867 * child classes can override this without polluting the constructor with
5868 * unnecessary extra objects that will be overidden.
5870 * @param {Object} menuConfig Configuration options
5871 * @return {OO.ui.MenuSelectWidget} Menu widget
5873 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
5874 return new OO
.ui
.MenuSelectWidget( menuConfig
);
5878 * Add options to the menu
5880 * @param {Object[]} menuOptions Object defining options
5882 OO
.ui
.MenuTagMultiselectWidget
.prototype.addOptions = function ( menuOptions
) {
5884 items
= menuOptions
.map( function ( obj
) {
5885 return widget
.createMenuOptionWidget( obj
.data
, obj
.label
);
5888 this.menu
.addItems( items
);
5892 * Create a menu option widget.
5894 * @param {string} data Item data
5895 * @param {string} [label] Item label
5896 * @return {OO.ui.OptionWidget} Option widget
5898 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuOptionWidget = function ( data
, label
) {
5899 return new OO
.ui
.MenuOptionWidget( {
5901 label
: label
|| data
5908 * @return {OO.ui.MenuSelectWidget} Menu
5910 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenu = function () {
5915 * Get the allowed values list
5917 * @return {string[]} Allowed data values
5919 OO
.ui
.MenuTagMultiselectWidget
.prototype.getAllowedValues = function () {
5922 // If the parent constructor is calling us, we're not ready yet, this.menu is not set up.
5923 menuDatas
= this.menu
.getItems().map( function ( menuItem
) {
5924 return menuItem
.getData();
5927 return this.allowedValues
.concat( menuDatas
);
5931 * SelectFileWidgets allow for selecting files, using the HTML5 File API. These
5932 * widgets can be configured with {@link OO.ui.mixin.IconElement icons} and {@link
5933 * OO.ui.mixin.IndicatorElement indicators}.
5934 * Please see the [OOjs UI documentation on MediaWiki] [1] for more information and examples.
5937 * // Example of a file select widget
5938 * var selectFile = new OO.ui.SelectFileWidget();
5939 * $( 'body' ).append( selectFile.$element );
5941 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets
5944 * @extends OO.ui.Widget
5945 * @mixins OO.ui.mixin.IconElement
5946 * @mixins OO.ui.mixin.IndicatorElement
5947 * @mixins OO.ui.mixin.PendingElement
5948 * @mixins OO.ui.mixin.LabelElement
5951 * @param {Object} [config] Configuration options
5952 * @cfg {string[]|null} [accept=null] MIME types to accept. null accepts all types.
5953 * @cfg {string} [placeholder] Text to display when no file is selected.
5954 * @cfg {string} [notsupported] Text to display when file support is missing in the browser.
5955 * @cfg {boolean} [droppable=true] Whether to accept files by drag and drop.
5956 * @cfg {boolean} [showDropTarget=false] Whether to show a drop target. Requires droppable to be true.
5957 * @cfg {number} [thumbnailSizeLimit=20] File size limit in MiB above which to not try and show a
5958 * preview (for performance)
5960 OO
.ui
.SelectFileWidget
= function OoUiSelectFileWidget( config
) {
5963 // Configuration initialization
5964 config
= $.extend( {
5966 placeholder
: OO
.ui
.msg( 'ooui-selectfile-placeholder' ),
5967 notsupported
: OO
.ui
.msg( 'ooui-selectfile-not-supported' ),
5969 showDropTarget
: false,
5970 thumbnailSizeLimit
: 20
5973 // Parent constructor
5974 OO
.ui
.SelectFileWidget
.parent
.call( this, config
);
5976 // Mixin constructors
5977 OO
.ui
.mixin
.IconElement
.call( this, config
);
5978 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
5979 OO
.ui
.mixin
.PendingElement
.call( this, $.extend( {}, config
, { $pending
: this.$info
} ) );
5980 OO
.ui
.mixin
.LabelElement
.call( this, config
);
5983 this.$info
= $( '<span>' );
5984 this.showDropTarget
= config
.showDropTarget
;
5985 this.thumbnailSizeLimit
= config
.thumbnailSizeLimit
;
5986 this.isSupported
= this.constructor.static.isSupported();
5987 this.currentFile
= null;
5988 if ( Array
.isArray( config
.accept
) ) {
5989 this.accept
= config
.accept
;
5993 this.placeholder
= config
.placeholder
;
5994 this.notsupported
= config
.notsupported
;
5995 this.onFileSelectedHandler
= this.onFileSelected
.bind( this );
5997 this.selectButton
= new OO
.ui
.ButtonWidget( {
5998 classes
: [ 'oo-ui-selectFileWidget-selectButton' ],
5999 label
: OO
.ui
.msg( 'ooui-selectfile-button-select' ),
6000 disabled
: this.disabled
|| !this.isSupported
6003 this.clearButton
= new OO
.ui
.ButtonWidget( {
6004 classes
: [ 'oo-ui-selectFileWidget-clearButton' ],
6007 disabled
: this.disabled
6011 this.selectButton
.$button
.on( {
6012 keypress
: this.onKeyPress
.bind( this )
6014 this.clearButton
.connect( this, {
6015 click
: 'onClearClick'
6017 if ( config
.droppable
) {
6018 dragHandler
= this.onDragEnterOrOver
.bind( this );
6020 dragenter
: dragHandler
,
6021 dragover
: dragHandler
,
6022 dragleave
: this.onDragLeave
.bind( this ),
6023 drop
: this.onDrop
.bind( this )
6029 this.$label
.addClass( 'oo-ui-selectFileWidget-label' );
6031 .addClass( 'oo-ui-selectFileWidget-info' )
6032 .append( this.$icon
, this.$label
, this.clearButton
.$element
, this.$indicator
);
6034 if ( config
.droppable
&& config
.showDropTarget
) {
6035 this.selectButton
.setIcon( 'upload' );
6036 this.$thumbnail
= $( '<div>' ).addClass( 'oo-ui-selectFileWidget-thumbnail' );
6037 this.setPendingElement( this.$thumbnail
);
6039 .addClass( 'oo-ui-selectFileWidget-dropTarget oo-ui-selectFileWidget' )
6041 click
: this.onDropTargetClick
.bind( this )
6046 this.selectButton
.$element
,
6048 .addClass( 'oo-ui-selectFileWidget-dropLabel' )
6049 .text( OO
.ui
.msg( 'ooui-selectfile-dragdrop-placeholder' ) )
6053 .addClass( 'oo-ui-selectFileWidget' )
6054 .append( this.$info
, this.selectButton
.$element
);
6061 OO
.inheritClass( OO
.ui
.SelectFileWidget
, OO
.ui
.Widget
);
6062 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IconElement
);
6063 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IndicatorElement
);
6064 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.PendingElement
);
6065 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.LabelElement
);
6067 /* Static Properties */
6070 * Check if this widget is supported
6075 OO
.ui
.SelectFileWidget
.static.isSupported = function () {
6077 if ( OO
.ui
.SelectFileWidget
.static.isSupportedCache
=== null ) {
6078 $input
= $( '<input>' ).attr( 'type', 'file' );
6079 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= $input
[ 0 ].files
!== undefined;
6081 return OO
.ui
.SelectFileWidget
.static.isSupportedCache
;
6084 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= null;
6091 * A change event is emitted when the on/off state of the toggle changes.
6093 * @param {File|null} value New value
6099 * Get the current value of the field
6101 * @return {File|null}
6103 OO
.ui
.SelectFileWidget
.prototype.getValue = function () {
6104 return this.currentFile
;
6108 * Set the current value of the field
6110 * @param {File|null} file File to select
6112 OO
.ui
.SelectFileWidget
.prototype.setValue = function ( file
) {
6113 if ( this.currentFile
!== file
) {
6114 this.currentFile
= file
;
6116 this.emit( 'change', this.currentFile
);
6123 * Focusses the select file button.
6127 OO
.ui
.SelectFileWidget
.prototype.focus = function () {
6128 this.selectButton
.focus();
6137 OO
.ui
.SelectFileWidget
.prototype.blur = function () {
6138 this.selectButton
.blur();
6145 OO
.ui
.SelectFileWidget
.prototype.simulateLabelClick = function () {
6150 * Update the user interface when a file is selected or unselected
6154 OO
.ui
.SelectFileWidget
.prototype.updateUI = function () {
6156 if ( !this.isSupported
) {
6157 this.$element
.addClass( 'oo-ui-selectFileWidget-notsupported' );
6158 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
6159 this.setLabel( this.notsupported
);
6161 this.$element
.addClass( 'oo-ui-selectFileWidget-supported' );
6162 if ( this.currentFile
) {
6163 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
6165 $label
= $label
.add(
6167 .addClass( 'oo-ui-selectFileWidget-fileName' )
6168 .text( this.currentFile
.name
)
6170 this.setLabel( $label
);
6172 if ( this.showDropTarget
) {
6174 this.loadAndGetImageUrl().done( function ( url
) {
6175 this.$thumbnail
.css( 'background-image', 'url( ' + url
+ ' )' );
6176 }.bind( this ) ).fail( function () {
6177 this.$thumbnail
.append(
6178 new OO
.ui
.IconWidget( {
6180 classes
: [ 'oo-ui-selectFileWidget-noThumbnail-icon' ]
6183 }.bind( this ) ).always( function () {
6186 this.$element
.off( 'click' );
6189 if ( this.showDropTarget
) {
6190 this.$element
.off( 'click' );
6192 click
: this.onDropTargetClick
.bind( this )
6196 .css( 'background-image', '' );
6198 this.$element
.addClass( 'oo-ui-selectFileWidget-empty' );
6199 this.setLabel( this.placeholder
);
6205 * If the selected file is an image, get its URL and load it.
6207 * @return {jQuery.Promise} Promise resolves with the image URL after it has loaded
6209 OO
.ui
.SelectFileWidget
.prototype.loadAndGetImageUrl = function () {
6210 var deferred
= $.Deferred(),
6211 file
= this.currentFile
,
6212 reader
= new FileReader();
6216 ( OO
.getProp( file
, 'type' ) || '' ).indexOf( 'image/' ) === 0 &&
6217 file
.size
< this.thumbnailSizeLimit
* 1024 * 1024
6219 reader
.onload = function ( event
) {
6220 var img
= document
.createElement( 'img' );
6221 img
.addEventListener( 'load', function () {
6223 img
.naturalWidth
=== 0 ||
6224 img
.naturalHeight
=== 0 ||
6225 img
.complete
=== false
6229 deferred
.resolve( event
.target
.result
);
6232 img
.src
= event
.target
.result
;
6234 reader
.readAsDataURL( file
);
6239 return deferred
.promise();
6243 * Add the input to the widget
6247 OO
.ui
.SelectFileWidget
.prototype.addInput = function () {
6248 if ( this.$input
) {
6249 this.$input
.remove();
6252 if ( !this.isSupported
) {
6257 this.$input
= $( '<input>' ).attr( 'type', 'file' );
6258 this.$input
.on( 'change', this.onFileSelectedHandler
);
6259 this.$input
.on( 'click', function ( e
) {
6260 // Prevents dropTarget to get clicked which calls
6261 // a click on this input
6262 e
.stopPropagation();
6267 if ( this.accept
) {
6268 this.$input
.attr( 'accept', this.accept
.join( ', ' ) );
6270 this.selectButton
.$button
.append( this.$input
);
6274 * Determine if we should accept this file
6277 * @param {string} mimeType File MIME type
6280 OO
.ui
.SelectFileWidget
.prototype.isAllowedType = function ( mimeType
) {
6283 if ( !this.accept
|| !mimeType
) {
6287 for ( i
= 0; i
< this.accept
.length
; i
++ ) {
6288 mimeTest
= this.accept
[ i
];
6289 if ( mimeTest
=== mimeType
) {
6291 } else if ( mimeTest
.substr( -2 ) === '/*' ) {
6292 mimeTest
= mimeTest
.substr( 0, mimeTest
.length
- 1 );
6293 if ( mimeType
.substr( 0, mimeTest
.length
) === mimeTest
) {
6303 * Handle file selection from the input
6306 * @param {jQuery.Event} e
6308 OO
.ui
.SelectFileWidget
.prototype.onFileSelected = function ( e
) {
6309 var file
= OO
.getProp( e
.target
, 'files', 0 ) || null;
6311 if ( file
&& !this.isAllowedType( file
.type
) ) {
6315 this.setValue( file
);
6320 * Handle clear button click events.
6324 OO
.ui
.SelectFileWidget
.prototype.onClearClick = function () {
6325 this.setValue( null );
6330 * Handle key press events.
6333 * @param {jQuery.Event} e Key press event
6335 OO
.ui
.SelectFileWidget
.prototype.onKeyPress = function ( e
) {
6336 if ( this.isSupported
&& !this.isDisabled() && this.$input
&&
6337 ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
6339 this.$input
.click();
6345 * Handle drop target click events.
6348 * @param {jQuery.Event} e Key press event
6350 OO
.ui
.SelectFileWidget
.prototype.onDropTargetClick = function () {
6351 if ( this.isSupported
&& !this.isDisabled() && this.$input
) {
6352 this.$input
.click();
6358 * Handle drag enter and over events
6361 * @param {jQuery.Event} e Drag event
6363 OO
.ui
.SelectFileWidget
.prototype.onDragEnterOrOver = function ( e
) {
6365 droppableFile
= false,
6366 dt
= e
.originalEvent
.dataTransfer
;
6369 e
.stopPropagation();
6371 if ( this.isDisabled() || !this.isSupported
) {
6372 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
6373 dt
.dropEffect
= 'none';
6377 // DataTransferItem and File both have a type property, but in Chrome files
6378 // have no information at this point.
6379 itemOrFile
= OO
.getProp( dt
, 'items', 0 ) || OO
.getProp( dt
, 'files', 0 );
6381 if ( this.isAllowedType( itemOrFile
.type
) ) {
6382 droppableFile
= true;
6384 // dt.types is Array-like, but not an Array
6385 } else if ( Array
.prototype.indexOf
.call( OO
.getProp( dt
, 'types' ) || [], 'Files' ) !== -1 ) {
6386 // File information is not available at this point for security so just assume
6387 // it is acceptable for now.
6388 // https://bugzilla.mozilla.org/show_bug.cgi?id=640534
6389 droppableFile
= true;
6392 this.$element
.toggleClass( 'oo-ui-selectFileWidget-canDrop', droppableFile
);
6393 if ( !droppableFile
) {
6394 dt
.dropEffect
= 'none';
6401 * Handle drag leave events
6404 * @param {jQuery.Event} e Drag event
6406 OO
.ui
.SelectFileWidget
.prototype.onDragLeave = function () {
6407 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
6411 * Handle drop events
6414 * @param {jQuery.Event} e Drop event
6416 OO
.ui
.SelectFileWidget
.prototype.onDrop = function ( e
) {
6418 dt
= e
.originalEvent
.dataTransfer
;
6421 e
.stopPropagation();
6422 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
6424 if ( this.isDisabled() || !this.isSupported
) {
6428 file
= OO
.getProp( dt
, 'files', 0 );
6429 if ( file
&& !this.isAllowedType( file
.type
) ) {
6433 this.setValue( file
);
6442 OO
.ui
.SelectFileWidget
.prototype.setDisabled = function ( disabled
) {
6443 OO
.ui
.SelectFileWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
6444 if ( this.selectButton
) {
6445 this.selectButton
.setDisabled( disabled
);
6447 if ( this.clearButton
) {
6448 this.clearButton
.setDisabled( disabled
);
6454 * SearchWidgets combine a {@link OO.ui.TextInputWidget text input field}, where users can type a search query,
6455 * and a menu of search results, which is displayed beneath the query
6456 * field. Unlike {@link OO.ui.mixin.LookupElement lookup menus}, search result menus are always visible to the user.
6457 * Users can choose an item from the menu or type a query into the text field to search for a matching result item.
6458 * In general, search widgets are used inside a separate {@link OO.ui.Dialog dialog} window.
6460 * Each time the query is changed, the search result menu is cleared and repopulated. Please see
6461 * the [OOjs UI demos][1] for an example.
6463 * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/#dialogs-mediawiki-vector-ltr
6466 * @extends OO.ui.Widget
6469 * @param {Object} [config] Configuration options
6470 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
6471 * @cfg {string} [value] Initial query value
6473 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
6474 // Configuration initialization
6475 config
= config
|| {};
6477 // Parent constructor
6478 OO
.ui
.SearchWidget
.parent
.call( this, config
);
6481 this.query
= new OO
.ui
.TextInputWidget( {
6483 placeholder
: config
.placeholder
,
6486 this.results
= new OO
.ui
.SelectWidget();
6487 this.$query
= $( '<div>' );
6488 this.$results
= $( '<div>' );
6491 this.query
.connect( this, {
6492 change
: 'onQueryChange',
6493 enter
: 'onQueryEnter'
6495 this.query
.$input
.on( 'keydown', this.onQueryKeydown
.bind( this ) );
6499 .addClass( 'oo-ui-searchWidget-query' )
6500 .append( this.query
.$element
);
6502 .addClass( 'oo-ui-searchWidget-results' )
6503 .append( this.results
.$element
);
6505 .addClass( 'oo-ui-searchWidget' )
6506 .append( this.$results
, this.$query
);
6511 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
6516 * Handle query key down events.
6519 * @param {jQuery.Event} e Key down event
6521 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
6522 var highlightedItem
, nextItem
,
6523 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
6526 highlightedItem
= this.results
.findHighlightedItem();
6527 if ( !highlightedItem
) {
6528 highlightedItem
= this.results
.getSelectedItem();
6530 nextItem
= this.results
.findRelativeSelectableItem( highlightedItem
, dir
);
6531 this.results
.highlightItem( nextItem
);
6532 nextItem
.scrollElementIntoView();
6537 * Handle select widget select events.
6539 * Clears existing results. Subclasses should repopulate items according to new query.
6542 * @param {string} value New value
6544 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
6546 this.results
.clearItems();
6550 * Handle select widget enter key events.
6552 * Chooses highlighted item.
6555 * @param {string} value New value
6557 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
6558 var highlightedItem
= this.results
.findHighlightedItem();
6559 if ( highlightedItem
) {
6560 this.results
.chooseItem( highlightedItem
);
6565 * Get the query input.
6567 * @return {OO.ui.TextInputWidget} Query input
6569 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
6574 * Get the search results menu.
6576 * @return {OO.ui.SelectWidget} Menu of search results
6578 OO
.ui
.SearchWidget
.prototype.getResults = function () {
6579 return this.results
;
6583 * NumberInputWidgets combine a {@link OO.ui.TextInputWidget text input} (where a value
6584 * can be entered manually) and two {@link OO.ui.ButtonWidget button widgets}
6585 * (to adjust the value in increments) to allow the user to enter a number.
6588 * // Example: A NumberInputWidget.
6589 * var numberInput = new OO.ui.NumberInputWidget( {
6590 * label: 'NumberInputWidget',
6591 * input: { value: 5 },
6595 * $( 'body' ).append( numberInput.$element );
6598 * @extends OO.ui.TextInputWidget
6601 * @param {Object} [config] Configuration options
6602 * @cfg {Object} [minusButton] Configuration options to pass to the {@link OO.ui.ButtonWidget decrementing button widget}.
6603 * @cfg {Object} [plusButton] Configuration options to pass to the {@link OO.ui.ButtonWidget incrementing button widget}.
6604 * @cfg {boolean} [allowInteger=false] Whether the field accepts only integer values.
6605 * @cfg {number} [min=-Infinity] Minimum allowed value
6606 * @cfg {number} [max=Infinity] Maximum allowed value
6607 * @cfg {number} [step=1] Delta when using the buttons or up/down arrow keys
6608 * @cfg {number|null} [pageStep] Delta when using the page-up/page-down keys. Defaults to 10 times #step.
6609 * @cfg {boolean} [showButtons=true] Whether to show the plus and minus buttons.
6611 OO
.ui
.NumberInputWidget
= function OoUiNumberInputWidget( config
) {
6612 var $field
= $( '<div>' )
6613 .addClass( 'oo-ui-numberInputWidget-field' );
6615 // Configuration initialization
6616 config
= $.extend( {
6617 allowInteger
: false,
6625 // For backward compatibility
6626 $.extend( config
, config
.input
);
6629 // Parent constructor
6630 OO
.ui
.NumberInputWidget
.parent
.call( this, $.extend( config
, {
6634 if ( config
.showButtons
) {
6635 this.minusButton
= new OO
.ui
.ButtonWidget( $.extend(
6637 disabled
: this.isDisabled(),
6639 classes
: [ 'oo-ui-numberInputWidget-minusButton' ],
6644 this.plusButton
= new OO
.ui
.ButtonWidget( $.extend(
6646 disabled
: this.isDisabled(),
6648 classes
: [ 'oo-ui-numberInputWidget-plusButton' ],
6657 keydown
: this.onKeyDown
.bind( this ),
6658 'wheel mousewheel DOMMouseScroll': this.onWheel
.bind( this )
6660 if ( config
.showButtons
) {
6661 this.plusButton
.connect( this, {
6662 click
: [ 'onButtonClick', +1 ]
6664 this.minusButton
.connect( this, {
6665 click
: [ 'onButtonClick', -1 ]
6670 $field
.append( this.$input
);
6671 if ( config
.showButtons
) {
6673 .prepend( this.minusButton
.$element
)
6674 .append( this.plusButton
.$element
);
6678 this.setAllowInteger( config
.allowInteger
|| config
.isInteger
);
6679 this.setRange( config
.min
, config
.max
);
6680 this.setStep( config
.step
, config
.pageStep
);
6681 // Set the validation method after we set allowInteger and range
6682 // so that it doesn't immediately call setValidityFlag
6683 this.setValidation( this.validateNumber
.bind( this ) );
6686 .addClass( 'oo-ui-numberInputWidget' )
6687 .toggleClass( 'oo-ui-numberInputWidget-buttoned', config
.showButtons
)
6693 OO
.inheritClass( OO
.ui
.NumberInputWidget
, OO
.ui
.TextInputWidget
);
6698 * Set whether only integers are allowed
6700 * @param {boolean} flag
6702 OO
.ui
.NumberInputWidget
.prototype.setAllowInteger = function ( flag
) {
6703 this.allowInteger
= !!flag
;
6704 this.setValidityFlag();
6706 // Backward compatibility
6707 OO
.ui
.NumberInputWidget
.prototype.setIsInteger
= OO
.ui
.NumberInputWidget
.prototype.setAllowInteger
;
6710 * Get whether only integers are allowed
6712 * @return {boolean} Flag value
6714 OO
.ui
.NumberInputWidget
.prototype.getAllowInteger = function () {
6715 return this.allowInteger
;
6717 // Backward compatibility
6718 OO
.ui
.NumberInputWidget
.prototype.getIsInteger
= OO
.ui
.NumberInputWidget
.prototype.getAllowInteger
;
6721 * Set the range of allowed values
6723 * @param {number} min Minimum allowed value
6724 * @param {number} max Maximum allowed value
6726 OO
.ui
.NumberInputWidget
.prototype.setRange = function ( min
, max
) {
6728 throw new Error( 'Minimum (' + min
+ ') must not be greater than maximum (' + max
+ ')' );
6732 this.setValidityFlag();
6736 * Get the current range
6738 * @return {number[]} Minimum and maximum values
6740 OO
.ui
.NumberInputWidget
.prototype.getRange = function () {
6741 return [ this.min
, this.max
];
6745 * Set the stepping deltas
6747 * @param {number} step Normal step
6748 * @param {number|null} pageStep Page step. If null, 10 * step will be used.
6750 OO
.ui
.NumberInputWidget
.prototype.setStep = function ( step
, pageStep
) {
6752 throw new Error( 'Step value must be positive' );
6754 if ( pageStep
=== null ) {
6755 pageStep
= step
* 10;
6756 } else if ( pageStep
<= 0 ) {
6757 throw new Error( 'Page step value must be positive' );
6760 this.pageStep
= pageStep
;
6764 * Get the current stepping values
6766 * @return {number[]} Step and page step
6768 OO
.ui
.NumberInputWidget
.prototype.getStep = function () {
6769 return [ this.step
, this.pageStep
];
6773 * Get the current value of the widget as a number
6775 * @return {number} May be NaN, or an invalid number
6777 OO
.ui
.NumberInputWidget
.prototype.getNumericValue = function () {
6778 return +this.getValue();
6782 * Adjust the value of the widget
6784 * @param {number} delta Adjustment amount
6786 OO
.ui
.NumberInputWidget
.prototype.adjustValue = function ( delta
) {
6787 var n
, v
= this.getNumericValue();
6790 if ( isNaN( delta
) || !isFinite( delta
) ) {
6791 throw new Error( 'Delta must be a finite number' );
6798 n
= Math
.max( Math
.min( n
, this.max
), this.min
);
6799 if ( this.allowInteger
) {
6800 n
= Math
.round( n
);
6812 * @param {string} value Field value
6815 OO
.ui
.NumberInputWidget
.prototype.validateNumber = function ( value
) {
6817 if ( value
=== '' ) {
6818 return !this.isRequired();
6821 if ( isNaN( n
) || !isFinite( n
) ) {
6825 if ( this.allowInteger
&& Math
.floor( n
) !== n
) {
6829 if ( n
< this.min
|| n
> this.max
) {
6837 * Handle mouse click events.
6840 * @param {number} dir +1 or -1
6842 OO
.ui
.NumberInputWidget
.prototype.onButtonClick = function ( dir
) {
6843 this.adjustValue( dir
* this.step
);
6847 * Handle mouse wheel events.
6850 * @param {jQuery.Event} event
6852 OO
.ui
.NumberInputWidget
.prototype.onWheel = function ( event
) {
6855 if ( !this.isDisabled() && this.$input
.is( ':focus' ) ) {
6856 // Standard 'wheel' event
6857 if ( event
.originalEvent
.deltaMode
!== undefined ) {
6858 this.sawWheelEvent
= true;
6860 if ( event
.originalEvent
.deltaY
) {
6861 delta
= -event
.originalEvent
.deltaY
;
6862 } else if ( event
.originalEvent
.deltaX
) {
6863 delta
= event
.originalEvent
.deltaX
;
6866 // Non-standard events
6867 if ( !this.sawWheelEvent
) {
6868 if ( event
.originalEvent
.wheelDeltaX
) {
6869 delta
= -event
.originalEvent
.wheelDeltaX
;
6870 } else if ( event
.originalEvent
.wheelDeltaY
) {
6871 delta
= event
.originalEvent
.wheelDeltaY
;
6872 } else if ( event
.originalEvent
.wheelDelta
) {
6873 delta
= event
.originalEvent
.wheelDelta
;
6874 } else if ( event
.originalEvent
.detail
) {
6875 delta
= -event
.originalEvent
.detail
;
6880 delta
= delta
< 0 ? -1 : 1;
6881 this.adjustValue( delta
* this.step
);
6889 * Handle key down events.
6892 * @param {jQuery.Event} e Key down event
6894 OO
.ui
.NumberInputWidget
.prototype.onKeyDown = function ( e
) {
6895 if ( !this.isDisabled() ) {
6896 switch ( e
.which
) {
6898 this.adjustValue( this.step
);
6900 case OO
.ui
.Keys
.DOWN
:
6901 this.adjustValue( -this.step
);
6903 case OO
.ui
.Keys
.PAGEUP
:
6904 this.adjustValue( this.pageStep
);
6906 case OO
.ui
.Keys
.PAGEDOWN
:
6907 this.adjustValue( -this.pageStep
);
6916 OO
.ui
.NumberInputWidget
.prototype.setDisabled = function ( disabled
) {
6918 OO
.ui
.NumberInputWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
6920 if ( this.minusButton
) {
6921 this.minusButton
.setDisabled( this.isDisabled() );
6923 if ( this.plusButton
) {
6924 this.plusButton
.setDisabled( this.isDisabled() );
6932 //# sourceMappingURL=oojs-ui-widgets.js.map