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-10-04T01:20:41Z
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} [expanded=true] Expand the layout to fill the entire parent element.
1592 * @cfg {boolean} [showMenu=true] Show menu
1593 * @cfg {string} [menuPosition='before'] Position of menu: `top`, `after`, `bottom` or `before`
1595 OO
.ui
.MenuLayout
= function OoUiMenuLayout( config
) {
1596 // Configuration initialization
1597 config
= $.extend( {
1600 menuPosition
: 'before'
1603 // Parent constructor
1604 OO
.ui
.MenuLayout
.parent
.call( this, config
);
1606 this.expanded
= !!config
.expanded
;
1610 * @property {jQuery}
1612 this.$menu
= $( '<div>' );
1616 * @property {jQuery}
1618 this.$content
= $( '<div>' );
1622 .addClass( 'oo-ui-menuLayout-menu' );
1623 this.$content
.addClass( 'oo-ui-menuLayout-content' );
1625 .addClass( 'oo-ui-menuLayout' );
1626 if ( config
.expanded
) {
1627 this.$element
.addClass( 'oo-ui-menuLayout-expanded' );
1629 this.$element
.addClass( 'oo-ui-menuLayout-static' );
1631 this.setMenuPosition( config
.menuPosition
);
1632 this.toggleMenu( config
.showMenu
);
1637 OO
.inheritClass( OO
.ui
.MenuLayout
, OO
.ui
.Layout
);
1644 * @param {boolean} showMenu Show menu, omit to toggle
1647 OO
.ui
.MenuLayout
.prototype.toggleMenu = function ( showMenu
) {
1648 showMenu
= showMenu
=== undefined ? !this.showMenu
: !!showMenu
;
1650 if ( this.showMenu
!== showMenu
) {
1651 this.showMenu
= showMenu
;
1653 .toggleClass( 'oo-ui-menuLayout-showMenu', this.showMenu
)
1654 .toggleClass( 'oo-ui-menuLayout-hideMenu', !this.showMenu
);
1655 this.$menu
.attr( 'aria-hidden', this.showMenu
? 'false' : 'true' );
1662 * Check if menu is visible
1664 * @return {boolean} Menu is visible
1666 OO
.ui
.MenuLayout
.prototype.isMenuVisible = function () {
1667 return this.showMenu
;
1671 * Set menu position.
1673 * @param {string} position Position of menu, either `top`, `after`, `bottom` or `before`
1674 * @throws {Error} If position value is not supported
1677 OO
.ui
.MenuLayout
.prototype.setMenuPosition = function ( position
) {
1678 this.$element
.removeClass( 'oo-ui-menuLayout-' + this.menuPosition
);
1679 this.menuPosition
= position
;
1680 if ( this.menuPosition
=== 'top' || this.menuPosition
=== 'before' ) {
1681 this.$element
.append( this.$menu
, this.$content
);
1683 this.$element
.append( this.$content
, this.$menu
);
1685 this.$element
.addClass( 'oo-ui-menuLayout-' + position
);
1691 * Get menu position.
1693 * @return {string} Menu position
1695 OO
.ui
.MenuLayout
.prototype.getMenuPosition = function () {
1696 return this.menuPosition
;
1700 * BookletLayouts contain {@link OO.ui.PageLayout page layouts} as well as
1701 * an {@link OO.ui.OutlineSelectWidget outline} that allows users to easily navigate
1702 * through the pages and select which one to display. By default, only one page is
1703 * displayed at a time and the outline is hidden. When a user navigates to a new page,
1704 * the booklet layout automatically focuses on the first focusable element, unless the
1705 * default setting is changed. Optionally, booklets can be configured to show
1706 * {@link OO.ui.OutlineControlsWidget controls} for adding, moving, and removing items.
1709 * // Example of a BookletLayout that contains two PageLayouts.
1711 * function PageOneLayout( name, config ) {
1712 * PageOneLayout.parent.call( this, name, config );
1713 * this.$element.append( '<p>First page</p><p>(This booklet has an outline, displayed on the left)</p>' );
1715 * OO.inheritClass( PageOneLayout, OO.ui.PageLayout );
1716 * PageOneLayout.prototype.setupOutlineItem = function () {
1717 * this.outlineItem.setLabel( 'Page One' );
1720 * function PageTwoLayout( name, config ) {
1721 * PageTwoLayout.parent.call( this, name, config );
1722 * this.$element.append( '<p>Second page</p>' );
1724 * OO.inheritClass( PageTwoLayout, OO.ui.PageLayout );
1725 * PageTwoLayout.prototype.setupOutlineItem = function () {
1726 * this.outlineItem.setLabel( 'Page Two' );
1729 * var page1 = new PageOneLayout( 'one' ),
1730 * page2 = new PageTwoLayout( 'two' );
1732 * var booklet = new OO.ui.BookletLayout( {
1736 * booklet.addPages ( [ page1, page2 ] );
1737 * $( 'body' ).append( booklet.$element );
1740 * @extends OO.ui.MenuLayout
1743 * @param {Object} [config] Configuration options
1744 * @cfg {boolean} [continuous=false] Show all pages, one after another
1745 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new page is displayed. Disabled on mobile.
1746 * @cfg {boolean} [outlined=false] Show the outline. The outline is used to navigate through the pages of the booklet.
1747 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
1749 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
1750 // Configuration initialization
1751 config
= config
|| {};
1753 // Parent constructor
1754 OO
.ui
.BookletLayout
.parent
.call( this, config
);
1757 this.currentPageName
= null;
1759 this.ignoreFocus
= false;
1760 this.stackLayout
= new OO
.ui
.StackLayout( {
1761 continuous
: !!config
.continuous
,
1762 expanded
: this.expanded
1764 this.$content
.append( this.stackLayout
.$element
);
1765 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
1766 this.outlineVisible
= false;
1767 this.outlined
= !!config
.outlined
;
1768 if ( this.outlined
) {
1769 this.editable
= !!config
.editable
;
1770 this.outlineControlsWidget
= null;
1771 this.outlineSelectWidget
= new OO
.ui
.OutlineSelectWidget();
1772 this.outlinePanel
= new OO
.ui
.PanelLayout( {
1773 expanded
: this.expanded
,
1776 this.$menu
.append( this.outlinePanel
.$element
);
1777 this.outlineVisible
= true;
1778 if ( this.editable
) {
1779 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
1780 this.outlineSelectWidget
1784 this.toggleMenu( this.outlined
);
1787 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
1788 if ( this.outlined
) {
1789 this.outlineSelectWidget
.connect( this, { select
: 'onOutlineSelectWidgetSelect' } );
1790 this.scrolling
= false;
1791 this.stackLayout
.connect( this, { visibleItemChange
: 'onStackLayoutVisibleItemChange' } );
1793 if ( this.autoFocus
) {
1794 // Event 'focus' does not bubble, but 'focusin' does
1795 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
1799 this.$element
.addClass( 'oo-ui-bookletLayout' );
1800 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
1801 if ( this.outlined
) {
1802 this.outlinePanel
.$element
1803 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
1804 .append( this.outlineSelectWidget
.$element
);
1805 if ( this.editable
) {
1806 this.outlinePanel
.$element
1807 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
1808 .append( this.outlineControlsWidget
.$element
);
1815 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.MenuLayout
);
1820 * A 'set' event is emitted when a page is {@link #setPage set} to be displayed by the booklet layout.
1822 * @param {OO.ui.PageLayout} page Current page
1826 * An 'add' event is emitted when pages are {@link #addPages added} to the booklet layout.
1829 * @param {OO.ui.PageLayout[]} page Added pages
1830 * @param {number} index Index pages were added at
1834 * A 'remove' event is emitted when pages are {@link #clearPages cleared} or
1835 * {@link #removePages removed} from the booklet.
1838 * @param {OO.ui.PageLayout[]} pages Removed pages
1844 * Handle stack layout focus.
1847 * @param {jQuery.Event} e Focusin event
1849 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
1852 // Find the page that an element was focused within
1853 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
1854 for ( name
in this.pages
) {
1855 // Check for page match, exclude current page to find only page changes
1856 if ( this.pages
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentPageName
) {
1857 this.setPage( name
);
1864 * Handle visibleItemChange events from the stackLayout
1866 * The next visible page is set as the current page by selecting it
1869 * @param {OO.ui.PageLayout} page The next visible page in the layout
1871 OO
.ui
.BookletLayout
.prototype.onStackLayoutVisibleItemChange = function ( page
) {
1872 // Set a flag to so that the resulting call to #onStackLayoutSet doesn't
1873 // try and scroll the item into view again.
1874 this.scrolling
= true;
1875 this.outlineSelectWidget
.selectItemByData( page
.getName() );
1876 this.scrolling
= false;
1880 * Handle stack layout set events.
1883 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
1885 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
1886 var promise
, layout
= this;
1887 // If everything is unselected, do nothing
1891 // For continuous BookletLayouts, scroll the selected page into view first
1892 if ( this.stackLayout
.continuous
&& !this.scrolling
) {
1893 promise
= page
.scrollElementIntoView();
1895 promise
= $.Deferred().resolve();
1897 // Focus the first element on the newly selected panel
1898 if ( this.autoFocus
&& !OO
.ui
.isMobile() ) {
1899 promise
.done( function () {
1906 * Focus the first input in the current page.
1908 * If no page is selected, the first selectable page will be selected.
1909 * If the focus is already in an element on the current page, nothing will happen.
1911 * @param {number} [itemIndex] A specific item to focus on
1913 OO
.ui
.BookletLayout
.prototype.focus = function ( itemIndex
) {
1915 items
= this.stackLayout
.getItems();
1917 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
1918 page
= items
[ itemIndex
];
1920 page
= this.stackLayout
.getCurrentItem();
1923 if ( !page
&& this.outlined
) {
1924 this.selectFirstSelectablePage();
1925 page
= this.stackLayout
.getCurrentItem();
1930 // Only change the focus if is not already in the current page
1931 if ( !OO
.ui
.contains( page
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
1937 * Find the first focusable input in the booklet layout and focus
1940 OO
.ui
.BookletLayout
.prototype.focusFirstFocusable = function () {
1941 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
1945 * Handle outline widget select events.
1948 * @param {OO.ui.OptionWidget|null} item Selected item
1950 OO
.ui
.BookletLayout
.prototype.onOutlineSelectWidgetSelect = function ( item
) {
1952 this.setPage( item
.getData() );
1957 * Check if booklet has an outline.
1959 * @return {boolean} Booklet has an outline
1961 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
1962 return this.outlined
;
1966 * Check if booklet has editing controls.
1968 * @return {boolean} Booklet is editable
1970 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
1971 return this.editable
;
1975 * Check if booklet has a visible outline.
1977 * @return {boolean} Outline is visible
1979 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
1980 return this.outlined
&& this.outlineVisible
;
1984 * Hide or show the outline.
1986 * @param {boolean} [show] Show outline, omit to invert current state
1989 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
1992 if ( this.outlined
) {
1993 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
1994 this.outlineVisible
= show
;
1995 this.toggleMenu( show
);
1996 if ( show
&& this.editable
) {
1997 // HACK: Kill dumb scrollbars when the sidebar stops animating, see T161798. Only necessary when
1998 // outline controls are present, delay matches transition on `.oo-ui-menuLayout-menu`.
1999 setTimeout( function () {
2000 OO
.ui
.Element
.static.reconsiderScrollbars( booklet
.outlinePanel
.$element
[ 0 ] );
2009 * Find the page closest to the specified page.
2011 * @param {OO.ui.PageLayout} page Page to use as a reference point
2012 * @return {OO.ui.PageLayout|null} Page closest to the specified page
2014 OO
.ui
.BookletLayout
.prototype.findClosestPage = function ( page
) {
2015 var next
, prev
, level
,
2016 pages
= this.stackLayout
.getItems(),
2017 index
= pages
.indexOf( page
);
2019 if ( index
!== -1 ) {
2020 next
= pages
[ index
+ 1 ];
2021 prev
= pages
[ index
- 1 ];
2022 // Prefer adjacent pages at the same level
2023 if ( this.outlined
) {
2024 level
= this.outlineSelectWidget
.getItemFromData( page
.getName() ).getLevel();
2027 level
=== this.outlineSelectWidget
.getItemFromData( prev
.getName() ).getLevel()
2033 level
=== this.outlineSelectWidget
.getItemFromData( next
.getName() ).getLevel()
2039 return prev
|| next
|| null;
2043 * Get the page closest to the specified page.
2045 * @deprecated 0.23.0 Use {@link OO.ui.BookletLayout#findClosestPage} instead.
2046 * @param {OO.ui.PageLayout} page Page to use as a reference point
2047 * @return {OO.ui.PageLayout|null} Page closest to the specified page
2049 OO
.ui
.BookletLayout
.prototype.getClosestPage = function ( page
) {
2050 OO
.ui
.warnDeprecation( 'BookletLayout#getClosestPage: Deprecated function. Use findClosestPage instead. See T76630.' );
2051 return this.findClosestPage( page
);
2055 * Get the outline widget.
2057 * If the booklet is not outlined, the method will return `null`.
2059 * @return {OO.ui.OutlineSelectWidget|null} Outline widget, or null if the booklet is not outlined
2061 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
2062 return this.outlineSelectWidget
;
2066 * Get the outline controls widget.
2068 * If the outline is not editable, the method will return `null`.
2070 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
2072 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
2073 return this.outlineControlsWidget
;
2077 * Get a page by its symbolic name.
2079 * @param {string} name Symbolic name of page
2080 * @return {OO.ui.PageLayout|undefined} Page, if found
2082 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
2083 return this.pages
[ name
];
2087 * Get the current page.
2089 * @return {OO.ui.PageLayout|undefined} Current page, if found
2091 OO
.ui
.BookletLayout
.prototype.getCurrentPage = function () {
2092 var name
= this.getCurrentPageName();
2093 return name
? this.getPage( name
) : undefined;
2097 * Get the symbolic name of the current page.
2099 * @return {string|null} Symbolic name of the current page
2101 OO
.ui
.BookletLayout
.prototype.getCurrentPageName = function () {
2102 return this.currentPageName
;
2106 * Add pages to the booklet layout
2108 * When pages are added with the same names as existing pages, the existing pages will be
2109 * automatically removed before the new pages are added.
2111 * @param {OO.ui.PageLayout[]} pages Pages to add
2112 * @param {number} index Index of the insertion point
2116 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
2117 var i
, len
, name
, page
, item
, currentIndex
,
2118 stackLayoutPages
= this.stackLayout
.getItems(),
2122 // Remove pages with same names
2123 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2125 name
= page
.getName();
2127 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
2128 // Correct the insertion index
2129 currentIndex
= stackLayoutPages
.indexOf( this.pages
[ name
] );
2130 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2133 remove
.push( this.pages
[ name
] );
2136 if ( remove
.length
) {
2137 this.removePages( remove
);
2141 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2143 name
= page
.getName();
2144 this.pages
[ page
.getName() ] = page
;
2145 if ( this.outlined
) {
2146 item
= new OO
.ui
.OutlineOptionWidget( { data
: name
} );
2147 page
.setOutlineItem( item
);
2152 if ( this.outlined
&& items
.length
) {
2153 this.outlineSelectWidget
.addItems( items
, index
);
2154 this.selectFirstSelectablePage();
2156 this.stackLayout
.addItems( pages
, index
);
2157 this.emit( 'add', pages
, index
);
2163 * Remove the specified pages from the booklet layout.
2165 * To remove all pages from the booklet, you may wish to use the #clearPages method instead.
2167 * @param {OO.ui.PageLayout[]} pages An array of pages to remove
2171 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
2172 var i
, len
, name
, page
,
2175 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2177 name
= page
.getName();
2178 delete this.pages
[ name
];
2179 if ( this.outlined
) {
2180 items
.push( this.outlineSelectWidget
.getItemFromData( name
) );
2181 page
.setOutlineItem( null );
2184 if ( this.outlined
&& items
.length
) {
2185 this.outlineSelectWidget
.removeItems( items
);
2186 this.selectFirstSelectablePage();
2188 this.stackLayout
.removeItems( pages
);
2189 this.emit( 'remove', pages
);
2195 * Clear all pages from the booklet layout.
2197 * To remove only a subset of pages from the booklet, use the #removePages method.
2202 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
2204 pages
= this.stackLayout
.getItems();
2207 this.currentPageName
= null;
2208 if ( this.outlined
) {
2209 this.outlineSelectWidget
.clearItems();
2210 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2211 pages
[ i
].setOutlineItem( null );
2214 this.stackLayout
.clearItems();
2216 this.emit( 'remove', pages
);
2222 * Set the current page by symbolic name.
2225 * @param {string} name Symbolic name of page
2227 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
2230 page
= this.pages
[ name
],
2231 previousPage
= this.currentPageName
&& this.pages
[ this.currentPageName
];
2233 if ( name
!== this.currentPageName
) {
2234 if ( this.outlined
) {
2235 selectedItem
= this.outlineSelectWidget
.getSelectedItem();
2236 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2237 this.outlineSelectWidget
.selectItemByData( name
);
2241 if ( previousPage
) {
2242 previousPage
.setActive( false );
2243 // Blur anything focused if the next page doesn't have anything focusable.
2244 // This is not needed if the next page has something focusable (because once it is focused
2245 // this blur happens automatically). If the layout is non-continuous, this check is
2246 // meaningless because the next page is not visible yet and thus can't hold focus.
2249 !OO
.ui
.isMobile() &&
2250 this.stackLayout
.continuous
&&
2251 OO
.ui
.findFocusable( page
.$element
).length
!== 0
2253 $focused
= previousPage
.$element
.find( ':focus' );
2254 if ( $focused
.length
) {
2255 $focused
[ 0 ].blur();
2259 this.currentPageName
= name
;
2260 page
.setActive( true );
2261 this.stackLayout
.setItem( page
);
2262 if ( !this.stackLayout
.continuous
&& previousPage
) {
2263 // This should not be necessary, since any inputs on the previous page should have been
2264 // blurred when it was hidden, but browsers are not very consistent about this.
2265 $focused
= previousPage
.$element
.find( ':focus' );
2266 if ( $focused
.length
) {
2267 $focused
[ 0 ].blur();
2270 this.emit( 'set', page
);
2276 * Select the first selectable page.
2280 OO
.ui
.BookletLayout
.prototype.selectFirstSelectablePage = function () {
2281 if ( !this.outlineSelectWidget
.getSelectedItem() ) {
2282 this.outlineSelectWidget
.selectItem( this.outlineSelectWidget
.findFirstSelectableItem() );
2289 * IndexLayouts contain {@link OO.ui.TabPanelLayout tab panel layouts} as well as
2290 * {@link OO.ui.TabSelectWidget tabs} that allow users to easily navigate through the tab panels and
2291 * select which one to display. By default, only one tab panel is displayed at a time. When a user
2292 * navigates to a new tab panel, the index layout automatically focuses on the first focusable element,
2293 * unless the default setting is changed.
2295 * TODO: This class is similar to BookletLayout, we may want to refactor to reduce duplication
2298 * // Example of a IndexLayout that contains two TabPanelLayouts.
2300 * function TabPanelOneLayout( name, config ) {
2301 * TabPanelOneLayout.parent.call( this, name, config );
2302 * this.$element.append( '<p>First tab panel</p>' );
2304 * OO.inheritClass( TabPanelOneLayout, OO.ui.TabPanelLayout );
2305 * TabPanelOneLayout.prototype.setupTabItem = function () {
2306 * this.tabItem.setLabel( 'Tab panel one' );
2309 * var tabPanel1 = new TabPanelOneLayout( 'one' ),
2310 * tabPanel2 = new OO.ui.TabPanelLayout( 'two', { label: 'Tab panel two' } );
2312 * tabPanel2.$element.append( '<p>Second tab panel</p>' );
2314 * var index = new OO.ui.IndexLayout();
2316 * index.addTabPanels ( [ tabPanel1, tabPanel2 ] );
2317 * $( 'body' ).append( index.$element );
2320 * @extends OO.ui.MenuLayout
2323 * @param {Object} [config] Configuration options
2324 * @cfg {boolean} [continuous=false] Show all tab panels, one after another
2325 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new tab panel is displayed. Disabled on mobile.
2327 OO
.ui
.IndexLayout
= function OoUiIndexLayout( config
) {
2328 // Configuration initialization
2329 config
= $.extend( {}, config
, { menuPosition
: 'top' } );
2331 // Parent constructor
2332 OO
.ui
.IndexLayout
.parent
.call( this, config
);
2335 this.currentTabPanelName
= null;
2336 this.tabPanels
= {};
2338 this.ignoreFocus
= false;
2339 this.stackLayout
= new OO
.ui
.StackLayout( {
2340 continuous
: !!config
.continuous
,
2341 expanded
: this.expanded
2343 this.$content
.append( this.stackLayout
.$element
);
2344 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
2346 this.tabSelectWidget
= new OO
.ui
.TabSelectWidget();
2347 this.tabPanel
= new OO
.ui
.PanelLayout( {
2348 expanded
: this.expanded
2350 this.$menu
.append( this.tabPanel
.$element
);
2352 this.toggleMenu( true );
2355 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
2356 this.tabSelectWidget
.connect( this, { select
: 'onTabSelectWidgetSelect' } );
2357 if ( this.autoFocus
) {
2358 // Event 'focus' does not bubble, but 'focusin' does
2359 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
2363 this.$element
.addClass( 'oo-ui-indexLayout' );
2364 this.stackLayout
.$element
.addClass( 'oo-ui-indexLayout-stackLayout' );
2365 this.tabPanel
.$element
2366 .addClass( 'oo-ui-indexLayout-tabPanel' )
2367 .append( this.tabSelectWidget
.$element
);
2372 OO
.inheritClass( OO
.ui
.IndexLayout
, OO
.ui
.MenuLayout
);
2377 * A 'set' event is emitted when a tab panel is {@link #setTabPanel set} to be displayed by the index layout.
2379 * @param {OO.ui.TabPanelLayout} tabPanel Current tab panel
2383 * An 'add' event is emitted when tab panels are {@link #addTabPanels added} to the index layout.
2386 * @param {OO.ui.TabPanelLayout[]} tabPanel Added tab panels
2387 * @param {number} index Index tab panels were added at
2391 * A 'remove' event is emitted when tab panels are {@link #clearTabPanels cleared} or
2392 * {@link #removeTabPanels removed} from the index.
2395 * @param {OO.ui.TabPanelLayout[]} tabPanel Removed tab panels
2401 * Handle stack layout focus.
2404 * @param {jQuery.Event} e Focusing event
2406 OO
.ui
.IndexLayout
.prototype.onStackLayoutFocus = function ( e
) {
2409 // Find the tab panel that an element was focused within
2410 $target
= $( e
.target
).closest( '.oo-ui-tabPanelLayout' );
2411 for ( name
in this.tabPanels
) {
2412 // Check for tab panel match, exclude current tab panel to find only tab panel changes
2413 if ( this.tabPanels
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentTabPanelName
) {
2414 this.setTabPanel( name
);
2421 * Handle stack layout set events.
2424 * @param {OO.ui.PanelLayout|null} tabPanel The tab panel that is now the current panel
2426 OO
.ui
.IndexLayout
.prototype.onStackLayoutSet = function ( tabPanel
) {
2427 // If everything is unselected, do nothing
2431 // Focus the first element on the newly selected panel
2432 if ( this.autoFocus
&& !OO
.ui
.isMobile() ) {
2438 * Focus the first input in the current tab panel.
2440 * If no tab panel is selected, the first selectable tab panel will be selected.
2441 * If the focus is already in an element on the current tab panel, nothing will happen.
2443 * @param {number} [itemIndex] A specific item to focus on
2445 OO
.ui
.IndexLayout
.prototype.focus = function ( itemIndex
) {
2447 items
= this.stackLayout
.getItems();
2449 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
2450 tabPanel
= items
[ itemIndex
];
2452 tabPanel
= this.stackLayout
.getCurrentItem();
2456 this.selectFirstSelectableTabPanel();
2457 tabPanel
= this.stackLayout
.getCurrentItem();
2462 // Only change the focus if is not already in the current page
2463 if ( !OO
.ui
.contains( tabPanel
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
2469 * Find the first focusable input in the index layout and focus
2472 OO
.ui
.IndexLayout
.prototype.focusFirstFocusable = function () {
2473 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
2477 * Handle tab widget select events.
2480 * @param {OO.ui.OptionWidget|null} item Selected item
2482 OO
.ui
.IndexLayout
.prototype.onTabSelectWidgetSelect = function ( item
) {
2484 this.setTabPanel( item
.getData() );
2489 * Get the tab panel closest to the specified tab panel.
2491 * @param {OO.ui.TabPanelLayout} tabPanel Tab panel to use as a reference point
2492 * @return {OO.ui.TabPanelLayout|null} Tab panel closest to the specified
2494 OO
.ui
.IndexLayout
.prototype.getClosestTabPanel = function ( tabPanel
) {
2495 var next
, prev
, level
,
2496 tabPanels
= this.stackLayout
.getItems(),
2497 index
= tabPanels
.indexOf( tabPanel
);
2499 if ( index
!== -1 ) {
2500 next
= tabPanels
[ index
+ 1 ];
2501 prev
= tabPanels
[ index
- 1 ];
2502 // Prefer adjacent tab panels at the same level
2503 level
= this.tabSelectWidget
.getItemFromData( tabPanel
.getName() ).getLevel();
2506 level
=== this.tabSelectWidget
.getItemFromData( prev
.getName() ).getLevel()
2512 level
=== this.tabSelectWidget
.getItemFromData( next
.getName() ).getLevel()
2517 return prev
|| next
|| null;
2521 * Get the tabs widget.
2523 * @return {OO.ui.TabSelectWidget} Tabs widget
2525 OO
.ui
.IndexLayout
.prototype.getTabs = function () {
2526 return this.tabSelectWidget
;
2530 * Get a tab panel by its symbolic name.
2532 * @param {string} name Symbolic name of tab panel
2533 * @return {OO.ui.TabPanelLayout|undefined} Tab panel, if found
2535 OO
.ui
.IndexLayout
.prototype.getTabPanel = function ( name
) {
2536 return this.tabPanels
[ name
];
2540 * Get the current tab panel.
2542 * @return {OO.ui.TabPanelLayout|undefined} Current tab panel, if found
2544 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanel = function () {
2545 var name
= this.getCurrentTabPanelName();
2546 return name
? this.getTabPanel( name
) : undefined;
2550 * Get the symbolic name of the current tab panel.
2552 * @return {string|null} Symbolic name of the current tab panel
2554 OO
.ui
.IndexLayout
.prototype.getCurrentTabPanelName = function () {
2555 return this.currentTabPanelName
;
2559 * Add tab panels to the index layout
2561 * When tab panels are added with the same names as existing tab panels, the existing tab panels
2562 * will be automatically removed before the new tab panels are added.
2564 * @param {OO.ui.TabPanelLayout[]} tabPanels Tab panels to add
2565 * @param {number} index Index of the insertion point
2569 OO
.ui
.IndexLayout
.prototype.addTabPanels = function ( tabPanels
, index
) {
2570 var i
, len
, name
, tabPanel
, item
, currentIndex
,
2571 stackLayoutTabPanels
= this.stackLayout
.getItems(),
2575 // Remove tab panels with same names
2576 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2577 tabPanel
= tabPanels
[ i
];
2578 name
= tabPanel
.getName();
2580 if ( Object
.prototype.hasOwnProperty
.call( this.tabPanels
, name
) ) {
2581 // Correct the insertion index
2582 currentIndex
= stackLayoutTabPanels
.indexOf( this.tabPanels
[ name
] );
2583 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2586 remove
.push( this.tabPanels
[ name
] );
2589 if ( remove
.length
) {
2590 this.removeTabPanels( remove
);
2593 // Add new tab panels
2594 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2595 tabPanel
= tabPanels
[ i
];
2596 name
= tabPanel
.getName();
2597 this.tabPanels
[ tabPanel
.getName() ] = tabPanel
;
2598 item
= new OO
.ui
.TabOptionWidget( { data
: name
} );
2599 tabPanel
.setTabItem( item
);
2603 if ( items
.length
) {
2604 this.tabSelectWidget
.addItems( items
, index
);
2605 this.selectFirstSelectableTabPanel();
2607 this.stackLayout
.addItems( tabPanels
, index
);
2608 this.emit( 'add', tabPanels
, index
);
2614 * Remove the specified tab panels from the index layout.
2616 * To remove all tab panels from the index, you may wish to use the #clearTabPanels method instead.
2618 * @param {OO.ui.TabPanelLayout[]} tabPanels An array of tab panels to remove
2622 OO
.ui
.IndexLayout
.prototype.removeTabPanels = function ( tabPanels
) {
2623 var i
, len
, name
, tabPanel
,
2626 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2627 tabPanel
= tabPanels
[ i
];
2628 name
= tabPanel
.getName();
2629 delete this.tabPanels
[ name
];
2630 items
.push( this.tabSelectWidget
.getItemFromData( name
) );
2631 tabPanel
.setTabItem( null );
2633 if ( items
.length
) {
2634 this.tabSelectWidget
.removeItems( items
);
2635 this.selectFirstSelectableTabPanel();
2637 this.stackLayout
.removeItems( tabPanels
);
2638 this.emit( 'remove', tabPanels
);
2644 * Clear all tab panels from the index layout.
2646 * To remove only a subset of tab panels from the index, use the #removeTabPanels method.
2651 OO
.ui
.IndexLayout
.prototype.clearTabPanels = function () {
2653 tabPanels
= this.stackLayout
.getItems();
2655 this.tabPanels
= {};
2656 this.currentTabPanelName
= null;
2657 this.tabSelectWidget
.clearItems();
2658 for ( i
= 0, len
= tabPanels
.length
; i
< len
; i
++ ) {
2659 tabPanels
[ i
].setTabItem( null );
2661 this.stackLayout
.clearItems();
2663 this.emit( 'remove', tabPanels
);
2669 * Set the current tab panel by symbolic name.
2672 * @param {string} name Symbolic name of tab panel
2674 OO
.ui
.IndexLayout
.prototype.setTabPanel = function ( name
) {
2677 tabPanel
= this.tabPanels
[ name
],
2678 previousTabPanel
= this.currentTabPanelName
&& this.tabPanels
[ this.currentTabPanelName
];
2680 if ( name
!== this.currentTabPanelName
) {
2681 selectedItem
= this.tabSelectWidget
.getSelectedItem();
2682 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2683 this.tabSelectWidget
.selectItemByData( name
);
2686 if ( previousTabPanel
) {
2687 previousTabPanel
.setActive( false );
2688 // Blur anything focused if the next tab panel doesn't have anything focusable.
2689 // This is not needed if the next tab panel has something focusable (because once it is focused
2690 // this blur happens automatically). If the layout is non-continuous, this check is
2691 // meaningless because the next tab panel is not visible yet and thus can't hold focus.
2694 !OO
.ui
.isMobile() &&
2695 this.stackLayout
.continuous
&&
2696 OO
.ui
.findFocusable( tabPanel
.$element
).length
!== 0
2698 $focused
= previousTabPanel
.$element
.find( ':focus' );
2699 if ( $focused
.length
) {
2700 $focused
[ 0 ].blur();
2704 this.currentTabPanelName
= name
;
2705 tabPanel
.setActive( true );
2706 this.stackLayout
.setItem( tabPanel
);
2707 if ( !this.stackLayout
.continuous
&& previousTabPanel
) {
2708 // This should not be necessary, since any inputs on the previous tab panel should have been
2709 // blurred when it was hidden, but browsers are not very consistent about this.
2710 $focused
= previousTabPanel
.$element
.find( ':focus' );
2711 if ( $focused
.length
) {
2712 $focused
[ 0 ].blur();
2715 this.emit( 'set', tabPanel
);
2721 * Select the first selectable tab panel.
2725 OO
.ui
.IndexLayout
.prototype.selectFirstSelectableTabPanel = function () {
2726 if ( !this.tabSelectWidget
.getSelectedItem() ) {
2727 this.tabSelectWidget
.selectItem( this.tabSelectWidget
.findFirstSelectableItem() );
2734 * ToggleWidget implements basic behavior of widgets with an on/off state.
2735 * Please see OO.ui.ToggleButtonWidget and OO.ui.ToggleSwitchWidget for examples.
2739 * @extends OO.ui.Widget
2742 * @param {Object} [config] Configuration options
2743 * @cfg {boolean} [value=false] The toggle’s initial on/off state.
2744 * By default, the toggle is in the 'off' state.
2746 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
2747 // Configuration initialization
2748 config
= config
|| {};
2750 // Parent constructor
2751 OO
.ui
.ToggleWidget
.parent
.call( this, config
);
2757 this.$element
.addClass( 'oo-ui-toggleWidget' );
2758 this.setValue( !!config
.value
);
2763 OO
.inheritClass( OO
.ui
.ToggleWidget
, OO
.ui
.Widget
);
2770 * A change event is emitted when the on/off state of the toggle changes.
2772 * @param {boolean} value Value representing the new state of the toggle
2778 * Get the value representing the toggle’s state.
2780 * @return {boolean} The on/off state of the toggle
2782 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
2787 * Set the state of the toggle: `true` for 'on', `false` for 'off'.
2789 * @param {boolean} value The state of the toggle
2793 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
2795 if ( this.value
!== value
) {
2797 this.emit( 'change', value
);
2798 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
2799 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
2805 * ToggleButtons are buttons that have a state (‘on’ or ‘off’) that is represented by a
2806 * Boolean value. Like other {@link OO.ui.ButtonWidget buttons}, toggle buttons can be
2807 * configured with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators},
2808 * {@link OO.ui.mixin.TitledElement titles}, {@link OO.ui.mixin.FlaggedElement styling flags},
2809 * and {@link OO.ui.mixin.LabelElement labels}. Please see
2810 * the [OOjs UI documentation][1] on MediaWiki for more information.
2813 * // Toggle buttons in the 'off' and 'on' state.
2814 * var toggleButton1 = new OO.ui.ToggleButtonWidget( {
2815 * label: 'Toggle Button off'
2817 * var toggleButton2 = new OO.ui.ToggleButtonWidget( {
2818 * label: 'Toggle Button on',
2821 * // Append the buttons to the DOM.
2822 * $( 'body' ).append( toggleButton1.$element, toggleButton2.$element );
2824 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches#Toggle_buttons
2827 * @extends OO.ui.ToggleWidget
2828 * @mixins OO.ui.mixin.ButtonElement
2829 * @mixins OO.ui.mixin.IconElement
2830 * @mixins OO.ui.mixin.IndicatorElement
2831 * @mixins OO.ui.mixin.LabelElement
2832 * @mixins OO.ui.mixin.TitledElement
2833 * @mixins OO.ui.mixin.FlaggedElement
2834 * @mixins OO.ui.mixin.TabIndexedElement
2837 * @param {Object} [config] Configuration options
2838 * @cfg {boolean} [value=false] The toggle button’s initial on/off
2839 * state. By default, the button is in the 'off' state.
2841 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
2842 // Configuration initialization
2843 config
= config
|| {};
2845 // Parent constructor
2846 OO
.ui
.ToggleButtonWidget
.parent
.call( this, config
);
2848 // Mixin constructors
2849 OO
.ui
.mixin
.ButtonElement
.call( this, $.extend( {}, config
, { active
: this.active
} ) );
2850 OO
.ui
.mixin
.IconElement
.call( this, config
);
2851 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
2852 OO
.ui
.mixin
.LabelElement
.call( this, config
);
2853 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
2854 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
2855 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$button
} ) );
2858 this.connect( this, { click
: 'onAction' } );
2861 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
2863 .addClass( 'oo-ui-toggleButtonWidget' )
2864 .append( this.$button
);
2869 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
2870 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.ButtonElement
);
2871 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IconElement
);
2872 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IndicatorElement
);
2873 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.LabelElement
);
2874 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TitledElement
);
2875 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.FlaggedElement
);
2876 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TabIndexedElement
);
2878 /* Static Properties */
2884 OO
.ui
.ToggleButtonWidget
.static.tagName
= 'span';
2889 * Handle the button action being triggered.
2893 OO
.ui
.ToggleButtonWidget
.prototype.onAction = function () {
2894 this.setValue( !this.value
);
2900 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
2902 if ( value
!== this.value
) {
2903 // Might be called from parent constructor before ButtonElement constructor
2904 if ( this.$button
) {
2905 this.$button
.attr( 'aria-pressed', value
.toString() );
2907 this.setActive( value
);
2911 OO
.ui
.ToggleButtonWidget
.parent
.prototype.setValue
.call( this, value
);
2919 OO
.ui
.ToggleButtonWidget
.prototype.setButtonElement = function ( $button
) {
2920 if ( this.$button
) {
2921 this.$button
.removeAttr( 'aria-pressed' );
2923 OO
.ui
.mixin
.ButtonElement
.prototype.setButtonElement
.call( this, $button
);
2924 this.$button
.attr( 'aria-pressed', this.value
.toString() );
2928 * ToggleSwitches are switches that slide on and off. Their state is represented by a Boolean
2929 * value (`true` for ‘on’, and `false` otherwise, the default). The ‘off’ state is represented
2930 * visually by a slider in the leftmost position.
2933 * // Toggle switches in the 'off' and 'on' position.
2934 * var toggleSwitch1 = new OO.ui.ToggleSwitchWidget();
2935 * var toggleSwitch2 = new OO.ui.ToggleSwitchWidget( {
2939 * // Create a FieldsetLayout to layout and label switches
2940 * var fieldset = new OO.ui.FieldsetLayout( {
2941 * label: 'Toggle switches'
2943 * fieldset.addItems( [
2944 * new OO.ui.FieldLayout( toggleSwitch1, { label: 'Off', align: 'top' } ),
2945 * new OO.ui.FieldLayout( toggleSwitch2, { label: 'On', align: 'top' } )
2947 * $( 'body' ).append( fieldset.$element );
2950 * @extends OO.ui.ToggleWidget
2951 * @mixins OO.ui.mixin.TabIndexedElement
2954 * @param {Object} [config] Configuration options
2955 * @cfg {boolean} [value=false] The toggle switch’s initial on/off state.
2956 * By default, the toggle switch is in the 'off' position.
2958 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
2959 // Parent constructor
2960 OO
.ui
.ToggleSwitchWidget
.parent
.call( this, config
);
2962 // Mixin constructors
2963 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
2966 this.dragging
= false;
2967 this.dragStart
= null;
2968 this.sliding
= false;
2969 this.$glow
= $( '<span>' );
2970 this.$grip
= $( '<span>' );
2974 click
: this.onClick
.bind( this ),
2975 keypress
: this.onKeyPress
.bind( this )
2979 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
2980 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
2982 .addClass( 'oo-ui-toggleSwitchWidget' )
2983 .attr( 'role', 'checkbox' )
2984 .append( this.$glow
, this.$grip
);
2989 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
2990 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.mixin
.TabIndexedElement
);
2995 * Handle mouse click events.
2998 * @param {jQuery.Event} e Mouse click event
3000 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
3001 if ( !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
3002 this.setValue( !this.value
);
3008 * Handle key press events.
3011 * @param {jQuery.Event} e Key press event
3013 OO
.ui
.ToggleSwitchWidget
.prototype.onKeyPress = function ( e
) {
3014 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
3015 this.setValue( !this.value
);
3023 OO
.ui
.ToggleSwitchWidget
.prototype.setValue = function ( value
) {
3024 OO
.ui
.ToggleSwitchWidget
.parent
.prototype.setValue
.call( this, value
);
3025 this.$element
.attr( 'aria-checked', this.value
.toString() );
3032 OO
.ui
.ToggleSwitchWidget
.prototype.simulateLabelClick = function () {
3033 if ( !this.isDisabled() ) {
3034 this.setValue( !this.value
);
3040 * OutlineControlsWidget is a set of controls for an {@link OO.ui.OutlineSelectWidget outline select widget}.
3041 * Controls include moving items up and down, removing items, and adding different kinds of items.
3043 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3046 * @extends OO.ui.Widget
3047 * @mixins OO.ui.mixin.GroupElement
3048 * @mixins OO.ui.mixin.IconElement
3051 * @param {OO.ui.OutlineSelectWidget} outline Outline to control
3052 * @param {Object} [config] Configuration options
3053 * @cfg {Object} [abilities] List of abilties
3054 * @cfg {boolean} [abilities.move=true] Allow moving movable items
3055 * @cfg {boolean} [abilities.remove=true] Allow removing removable items
3057 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
3058 // Allow passing positional parameters inside the config object
3059 if ( OO
.isPlainObject( outline
) && config
=== undefined ) {
3061 outline
= config
.outline
;
3064 // Configuration initialization
3065 config
= $.extend( { icon
: 'add' }, config
);
3067 // Parent constructor
3068 OO
.ui
.OutlineControlsWidget
.parent
.call( this, config
);
3070 // Mixin constructors
3071 OO
.ui
.mixin
.GroupElement
.call( this, config
);
3072 OO
.ui
.mixin
.IconElement
.call( this, config
);
3075 this.outline
= outline
;
3076 this.$movers
= $( '<div>' );
3077 this.upButton
= new OO
.ui
.ButtonWidget( {
3080 title
: OO
.ui
.msg( 'ooui-outline-control-move-up' )
3082 this.downButton
= new OO
.ui
.ButtonWidget( {
3085 title
: OO
.ui
.msg( 'ooui-outline-control-move-down' )
3087 this.removeButton
= new OO
.ui
.ButtonWidget( {
3090 title
: OO
.ui
.msg( 'ooui-outline-control-remove' )
3092 this.abilities
= { move: true, remove
: true };
3095 outline
.connect( this, {
3096 select
: 'onOutlineChange',
3097 add
: 'onOutlineChange',
3098 remove
: 'onOutlineChange'
3100 this.upButton
.connect( this, { click
: [ 'emit', 'move', -1 ] } );
3101 this.downButton
.connect( this, { click
: [ 'emit', 'move', 1 ] } );
3102 this.removeButton
.connect( this, { click
: [ 'emit', 'remove' ] } );
3105 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
3106 this.$group
.addClass( 'oo-ui-outlineControlsWidget-items' );
3108 .addClass( 'oo-ui-outlineControlsWidget-movers' )
3109 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
3110 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
3111 this.setAbilities( config
.abilities
|| {} );
3116 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
3117 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.GroupElement
);
3118 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.IconElement
);
3124 * @param {number} places Number of places to move
3136 * @param {Object} abilities List of abilties
3137 * @param {boolean} [abilities.move] Allow moving movable items
3138 * @param {boolean} [abilities.remove] Allow removing removable items
3140 OO
.ui
.OutlineControlsWidget
.prototype.setAbilities = function ( abilities
) {
3143 for ( ability
in this.abilities
) {
3144 if ( abilities
[ ability
] !== undefined ) {
3145 this.abilities
[ ability
] = !!abilities
[ ability
];
3149 this.onOutlineChange();
3153 * Handle outline change events.
3157 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
3158 var i
, len
, firstMovable
, lastMovable
,
3159 items
= this.outline
.getItems(),
3160 selectedItem
= this.outline
.getSelectedItem(),
3161 movable
= this.abilities
.move && selectedItem
&& selectedItem
.isMovable(),
3162 removable
= this.abilities
.remove
&& selectedItem
&& selectedItem
.isRemovable();
3167 while ( ++i
< len
) {
3168 if ( items
[ i
].isMovable() ) {
3169 firstMovable
= items
[ i
];
3175 if ( items
[ i
].isMovable() ) {
3176 lastMovable
= items
[ i
];
3181 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
3182 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
3183 this.removeButton
.setDisabled( !removable
);
3187 * OutlineOptionWidget is an item in an {@link OO.ui.OutlineSelectWidget OutlineSelectWidget}.
3189 * Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}, which contain
3190 * {@link OO.ui.PageLayout page layouts}. See {@link OO.ui.BookletLayout BookletLayout}
3194 * @extends OO.ui.DecoratedOptionWidget
3197 * @param {Object} [config] Configuration options
3198 * @cfg {number} [level] Indentation level
3199 * @cfg {boolean} [movable] Allow modification from {@link OO.ui.OutlineControlsWidget outline controls}.
3201 OO
.ui
.OutlineOptionWidget
= function OoUiOutlineOptionWidget( config
) {
3202 // Configuration initialization
3203 config
= config
|| {};
3205 // Parent constructor
3206 OO
.ui
.OutlineOptionWidget
.parent
.call( this, config
);
3210 this.movable
= !!config
.movable
;
3211 this.removable
= !!config
.removable
;
3214 this.$element
.addClass( 'oo-ui-outlineOptionWidget' );
3215 this.setLevel( config
.level
);
3220 OO
.inheritClass( OO
.ui
.OutlineOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
3222 /* Static Properties */
3228 OO
.ui
.OutlineOptionWidget
.static.highlightable
= true;
3234 OO
.ui
.OutlineOptionWidget
.static.scrollIntoViewOnSelect
= true;
3239 * @property {string}
3241 OO
.ui
.OutlineOptionWidget
.static.levelClass
= 'oo-ui-outlineOptionWidget-level-';
3246 * @property {number}
3248 OO
.ui
.OutlineOptionWidget
.static.levels
= 3;
3253 * Check if item is movable.
3255 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3257 * @return {boolean} Item is movable
3259 OO
.ui
.OutlineOptionWidget
.prototype.isMovable = function () {
3260 return this.movable
;
3264 * Check if item is removable.
3266 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3268 * @return {boolean} Item is removable
3270 OO
.ui
.OutlineOptionWidget
.prototype.isRemovable = function () {
3271 return this.removable
;
3275 * Get indentation level.
3277 * @return {number} Indentation level
3279 OO
.ui
.OutlineOptionWidget
.prototype.getLevel = function () {
3286 OO
.ui
.OutlineOptionWidget
.prototype.setPressed = function ( state
) {
3287 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setPressed
.call( this, state
);
3288 if ( this.pressed
) {
3289 this.setFlags( { progressive
: true } );
3290 } else if ( !this.selected
) {
3291 this.setFlags( { progressive
: false } );
3299 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3301 * @param {boolean} movable Item is movable
3304 OO
.ui
.OutlineOptionWidget
.prototype.setMovable = function ( movable
) {
3305 this.movable
= !!movable
;
3306 this.updateThemeClasses();
3313 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3315 * @param {boolean} removable Item is removable
3318 OO
.ui
.OutlineOptionWidget
.prototype.setRemovable = function ( removable
) {
3319 this.removable
= !!removable
;
3320 this.updateThemeClasses();
3327 OO
.ui
.OutlineOptionWidget
.prototype.setSelected = function ( state
) {
3328 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3329 if ( this.selected
) {
3330 this.setFlags( { progressive
: true } );
3332 this.setFlags( { progressive
: false } );
3338 * Set indentation level.
3340 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
3343 OO
.ui
.OutlineOptionWidget
.prototype.setLevel = function ( level
) {
3344 var levels
= this.constructor.static.levels
,
3345 levelClass
= this.constructor.static.levelClass
,
3348 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
3350 if ( this.level
=== i
) {
3351 this.$element
.addClass( levelClass
+ i
);
3353 this.$element
.removeClass( levelClass
+ i
);
3356 this.updateThemeClasses();
3362 * OutlineSelectWidget is a structured list that contains {@link OO.ui.OutlineOptionWidget outline options}
3363 * A set of controls can be provided with an {@link OO.ui.OutlineControlsWidget outline controls} widget.
3365 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3368 * @extends OO.ui.SelectWidget
3369 * @mixins OO.ui.mixin.TabIndexedElement
3372 * @param {Object} [config] Configuration options
3374 OO
.ui
.OutlineSelectWidget
= function OoUiOutlineSelectWidget( config
) {
3375 // Parent constructor
3376 OO
.ui
.OutlineSelectWidget
.parent
.call( this, config
);
3378 // Mixin constructors
3379 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3383 focus
: this.bindKeyDownListener
.bind( this ),
3384 blur
: this.unbindKeyDownListener
.bind( this )
3388 this.$element
.addClass( 'oo-ui-outlineSelectWidget' );
3393 OO
.inheritClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.SelectWidget
);
3394 OO
.mixinClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3397 * ButtonOptionWidget is a special type of {@link OO.ui.mixin.ButtonElement button element} that
3398 * can be selected and configured with data. The class is
3399 * used with OO.ui.ButtonSelectWidget to create a selection of button options. Please see the
3400 * [OOjs UI documentation on MediaWiki] [1] for more information.
3402 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Button_selects_and_options
3405 * @extends OO.ui.OptionWidget
3406 * @mixins OO.ui.mixin.ButtonElement
3407 * @mixins OO.ui.mixin.IconElement
3408 * @mixins OO.ui.mixin.IndicatorElement
3409 * @mixins OO.ui.mixin.TitledElement
3412 * @param {Object} [config] Configuration options
3414 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( config
) {
3415 // Configuration initialization
3416 config
= config
|| {};
3418 // Parent constructor
3419 OO
.ui
.ButtonOptionWidget
.parent
.call( this, config
);
3421 // Mixin constructors
3422 OO
.ui
.mixin
.ButtonElement
.call( this, config
);
3423 OO
.ui
.mixin
.IconElement
.call( this, config
);
3424 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3425 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
3428 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
3429 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
3430 this.$element
.append( this.$button
);
3435 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.OptionWidget
);
3436 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.ButtonElement
);
3437 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IconElement
);
3438 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IndicatorElement
);
3439 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.TitledElement
);
3441 /* Static Properties */
3444 * Allow button mouse down events to pass through so they can be handled by the parent select widget
3449 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
3455 OO
.ui
.ButtonOptionWidget
.static.highlightable
= false;
3462 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
3463 OO
.ui
.ButtonOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3465 if ( this.constructor.static.selectable
) {
3466 this.setActive( state
);
3473 * ButtonSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains
3474 * button options and is used together with
3475 * OO.ui.ButtonOptionWidget. The ButtonSelectWidget provides an interface for
3476 * highlighting, choosing, and selecting mutually exclusive options. Please see
3477 * the [OOjs UI documentation on MediaWiki] [1] for more information.
3480 * // Example: A ButtonSelectWidget that contains three ButtonOptionWidgets
3481 * var option1 = new OO.ui.ButtonOptionWidget( {
3483 * label: 'Option 1',
3484 * title: 'Button option 1'
3487 * var option2 = new OO.ui.ButtonOptionWidget( {
3489 * label: 'Option 2',
3490 * title: 'Button option 2'
3493 * var option3 = new OO.ui.ButtonOptionWidget( {
3495 * label: 'Option 3',
3496 * title: 'Button option 3'
3499 * var buttonSelect=new OO.ui.ButtonSelectWidget( {
3500 * items: [ option1, option2, option3 ]
3502 * $( 'body' ).append( buttonSelect.$element );
3504 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
3507 * @extends OO.ui.SelectWidget
3508 * @mixins OO.ui.mixin.TabIndexedElement
3511 * @param {Object} [config] Configuration options
3513 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
3514 // Parent constructor
3515 OO
.ui
.ButtonSelectWidget
.parent
.call( this, config
);
3517 // Mixin constructors
3518 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3522 focus
: this.bindKeyDownListener
.bind( this ),
3523 blur
: this.unbindKeyDownListener
.bind( this )
3527 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
3532 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
3533 OO
.mixinClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3536 * TabOptionWidget is an item in a {@link OO.ui.TabSelectWidget TabSelectWidget}.
3538 * Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}, which contain
3539 * {@link OO.ui.TabPanelLayout tab panel layouts}. See {@link OO.ui.IndexLayout IndexLayout}
3543 * @extends OO.ui.OptionWidget
3546 * @param {Object} [config] Configuration options
3548 OO
.ui
.TabOptionWidget
= function OoUiTabOptionWidget( config
) {
3549 // Configuration initialization
3550 config
= config
|| {};
3552 // Parent constructor
3553 OO
.ui
.TabOptionWidget
.parent
.call( this, config
);
3556 this.$element
.addClass( 'oo-ui-tabOptionWidget' );
3561 OO
.inheritClass( OO
.ui
.TabOptionWidget
, OO
.ui
.OptionWidget
);
3563 /* Static Properties */
3569 OO
.ui
.TabOptionWidget
.static.highlightable
= false;
3572 * TabSelectWidget is a list that contains {@link OO.ui.TabOptionWidget tab options}
3574 * **Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}.**
3577 * @extends OO.ui.SelectWidget
3578 * @mixins OO.ui.mixin.TabIndexedElement
3581 * @param {Object} [config] Configuration options
3583 OO
.ui
.TabSelectWidget
= function OoUiTabSelectWidget( config
) {
3584 // Parent constructor
3585 OO
.ui
.TabSelectWidget
.parent
.call( this, config
);
3587 // Mixin constructors
3588 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3592 focus
: this.bindKeyDownListener
.bind( this ),
3593 blur
: this.unbindKeyDownListener
.bind( this )
3597 this.$element
.addClass( 'oo-ui-tabSelectWidget' );
3602 OO
.inheritClass( OO
.ui
.TabSelectWidget
, OO
.ui
.SelectWidget
);
3603 OO
.mixinClass( OO
.ui
.TabSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3606 * CapsuleItemWidgets are used within a {@link OO.ui.CapsuleMultiselectWidget
3607 * CapsuleMultiselectWidget} to display the selected items.
3610 * @extends OO.ui.Widget
3611 * @mixins OO.ui.mixin.ItemWidget
3612 * @mixins OO.ui.mixin.LabelElement
3613 * @mixins OO.ui.mixin.FlaggedElement
3614 * @mixins OO.ui.mixin.TabIndexedElement
3617 * @param {Object} [config] Configuration options
3619 OO
.ui
.CapsuleItemWidget
= function OoUiCapsuleItemWidget( config
) {
3620 // Configuration initialization
3621 config
= config
|| {};
3623 // Parent constructor
3624 OO
.ui
.CapsuleItemWidget
.parent
.call( this, config
);
3626 // Mixin constructors
3627 OO
.ui
.mixin
.ItemWidget
.call( this );
3628 OO
.ui
.mixin
.LabelElement
.call( this, config
);
3629 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
3630 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3633 this.closeButton
= new OO
.ui
.ButtonWidget( {
3637 title
: OO
.ui
.msg( 'ooui-item-remove' )
3638 } ).on( 'click', this.onCloseClick
.bind( this ) );
3640 this.on( 'disable', function ( disabled
) {
3641 this.closeButton
.setDisabled( disabled
);
3647 click
: this.onClick
.bind( this ),
3648 keydown
: this.onKeyDown
.bind( this )
3650 .addClass( 'oo-ui-capsuleItemWidget' )
3651 .append( this.$label
, this.closeButton
.$element
);
3656 OO
.inheritClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.Widget
);
3657 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.ItemWidget
);
3658 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.LabelElement
);
3659 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.FlaggedElement
);
3660 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3665 * Handle close icon clicks
3667 OO
.ui
.CapsuleItemWidget
.prototype.onCloseClick = function () {
3668 var element
= this.getElementGroup();
3670 if ( element
&& $.isFunction( element
.removeItems
) ) {
3671 element
.removeItems( [ this ] );
3677 * Handle click event for the entire capsule
3679 OO
.ui
.CapsuleItemWidget
.prototype.onClick = function () {
3680 var element
= this.getElementGroup();
3682 if ( !this.isDisabled() && element
&& $.isFunction( element
.editItem
) ) {
3683 element
.editItem( this );
3688 * Handle keyDown event for the entire capsule
3690 * @param {jQuery.Event} e Key down event
3692 OO
.ui
.CapsuleItemWidget
.prototype.onKeyDown = function ( e
) {
3693 var element
= this.getElementGroup();
3695 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
|| e
.keyCode
=== OO
.ui
.Keys
.DELETE
) {
3696 element
.removeItems( [ this ] );
3699 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ENTER
) {
3700 element
.editItem( this );
3702 } else if ( e
.keyCode
=== OO
.ui
.Keys
.LEFT
) {
3703 element
.getPreviousItem( this ).focus();
3704 } else if ( e
.keyCode
=== OO
.ui
.Keys
.RIGHT
) {
3705 element
.getNextItem( this ).focus();
3710 * CapsuleMultiselectWidgets are something like a {@link OO.ui.ComboBoxInputWidget combo box widget}
3711 * that allows for selecting multiple values.
3713 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
3716 * // Example: A CapsuleMultiselectWidget.
3717 * var capsule = new OO.ui.CapsuleMultiselectWidget( {
3718 * label: 'CapsuleMultiselectWidget',
3719 * selected: [ 'Option 1', 'Option 3' ],
3722 * new OO.ui.MenuOptionWidget( {
3724 * label: 'Option One'
3726 * new OO.ui.MenuOptionWidget( {
3728 * label: 'Option Two'
3730 * new OO.ui.MenuOptionWidget( {
3732 * label: 'Option Three'
3734 * new OO.ui.MenuOptionWidget( {
3736 * label: 'Option Four'
3738 * new OO.ui.MenuOptionWidget( {
3740 * label: 'Option Five'
3745 * $( 'body' ).append( capsule.$element );
3747 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
3750 * @extends OO.ui.Widget
3751 * @mixins OO.ui.mixin.GroupElement
3752 * @mixins OO.ui.mixin.PopupElement
3753 * @mixins OO.ui.mixin.TabIndexedElement
3754 * @mixins OO.ui.mixin.IndicatorElement
3755 * @mixins OO.ui.mixin.IconElement
3756 * @uses OO.ui.CapsuleItemWidget
3757 * @uses OO.ui.MenuSelectWidget
3760 * @param {Object} [config] Configuration options
3761 * @cfg {string} [placeholder] Placeholder text
3762 * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if not present in the menu.
3763 * @cfg {boolean} [allowDuplicates=false] Allow duplicate items to be added.
3764 * @cfg {Object} [menu] (required) Configuration options to pass to the
3765 * {@link OO.ui.MenuSelectWidget menu select widget}.
3766 * @cfg {Object} [popup] Configuration options to pass to the {@link OO.ui.PopupWidget popup widget}.
3767 * If specified, this popup will be shown instead of the menu (but the menu
3768 * will still be used for item labels and allowArbitrary=false). The widgets
3769 * in the popup should use {@link #addItemsFromData} or {@link #addItems} as necessary.
3770 * @cfg {jQuery} [$overlay=this.$element] Render the menu or popup into a separate layer.
3771 * This configuration is useful in cases where the expanded menu is larger than
3772 * its containing `<div>`. The specified overlay layer is usually on top of
3773 * the containing `<div>` and has a larger area. By default, the menu uses
3774 * relative positioning.
3775 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
3777 OO
.ui
.CapsuleMultiselectWidget
= function OoUiCapsuleMultiselectWidget( config
) {
3780 // Parent constructor
3781 OO
.ui
.CapsuleMultiselectWidget
.parent
.call( this, config
);
3783 // Configuration initialization
3784 config
= $.extend( {
3785 allowArbitrary
: false,
3786 allowDuplicates
: false,
3787 $overlay
: this.$element
3790 // Properties (must be set before mixin constructor calls)
3791 this.$handle
= $( '<div>' );
3792 this.$input
= config
.popup
? null : $( '<input>' );
3793 if ( config
.placeholder
!== undefined && config
.placeholder
!== '' ) {
3794 this.$input
.attr( 'placeholder', config
.placeholder
);
3797 // Mixin constructors
3798 OO
.ui
.mixin
.GroupElement
.call( this, config
);
3799 if ( config
.popup
) {
3800 config
.popup
= $.extend( {}, config
.popup
, {
3804 OO
.ui
.mixin
.PopupElement
.call( this, config
);
3805 $tabFocus
= $( '<span>' );
3806 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: $tabFocus
} ) );
3810 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$input
} ) );
3812 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3813 OO
.ui
.mixin
.IconElement
.call( this, config
);
3816 this.$content
= $( '<div>' );
3817 this.allowArbitrary
= config
.allowArbitrary
;
3818 this.allowDuplicates
= config
.allowDuplicates
;
3819 this.$overlay
= config
.$overlay
;
3820 this.menu
= new OO
.ui
.MenuSelectWidget( $.extend(
3823 $input
: this.$input
,
3824 $floatableContainer
: this.$element
,
3825 filterFromInput
: true,
3826 disabled
: this.isDisabled()
3834 focus
: this.focus
.bind( this )
3836 this.popup
.$element
.on( 'focusout', this.onPopupFocusOut
.bind( this ) );
3837 if ( this.popup
.$autoCloseIgnore
) {
3838 this.popup
.$autoCloseIgnore
.on( 'focusout', this.onPopupFocusOut
.bind( this ) );
3840 this.popup
.connect( this, {
3841 toggle: function ( visible
) {
3842 $tabFocus
.toggle( !visible
);
3847 focus
: this.onInputFocus
.bind( this ),
3848 blur
: this.onInputBlur
.bind( this ),
3849 'propertychange change click mouseup keydown keyup input cut paste select focus':
3850 OO
.ui
.debounce( this.updateInputSize
.bind( this ) ),
3851 keydown
: this.onKeyDown
.bind( this ),
3852 keypress
: this.onKeyPress
.bind( this )
3855 this.menu
.connect( this, {
3856 choose
: 'onMenuChoose',
3857 toggle
: 'onMenuToggle',
3858 add
: 'onMenuItemsChange',
3859 remove
: 'onMenuItemsChange'
3862 mousedown
: this.onMouseDown
.bind( this )
3866 if ( this.$input
) {
3867 this.$input
.prop( 'disabled', this.isDisabled() );
3870 'aria-owns': this.menu
.getElementId(),
3871 'aria-autocomplete': 'list'
3874 if ( config
.data
) {
3875 this.setItemsFromData( config
.data
);
3877 this.$content
.addClass( 'oo-ui-capsuleMultiselectWidget-content' )
3878 .append( this.$group
);
3879 this.$group
.addClass( 'oo-ui-capsuleMultiselectWidget-group' );
3880 this.$handle
.addClass( 'oo-ui-capsuleMultiselectWidget-handle' )
3881 .append( this.$indicator
, this.$icon
, this.$content
);
3882 this.$element
.addClass( 'oo-ui-capsuleMultiselectWidget' )
3883 .append( this.$handle
);
3885 this.popup
.$element
.addClass( 'oo-ui-capsuleMultiselectWidget-popup' );
3886 this.$content
.append( $tabFocus
);
3887 this.$overlay
.append( this.popup
.$element
);
3889 this.$content
.append( this.$input
);
3890 this.$overlay
.append( this.menu
.$element
);
3893 $tabFocus
.addClass( 'oo-ui-capsuleMultiselectWidget-focusTrap' );
3896 // Input size needs to be calculated after everything else is rendered
3897 setTimeout( function () {
3898 if ( this.$input
) {
3899 this.updateInputSize();
3903 this.onMenuItemsChange();
3908 OO
.inheritClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.Widget
);
3909 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.GroupElement
);
3910 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.PopupElement
);
3911 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3912 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.IndicatorElement
);
3913 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.IconElement
);
3920 * A change event is emitted when the set of selected items changes.
3922 * @param {Mixed[]} datas Data of the now-selected items
3928 * A resize event is emitted when the widget's dimensions change to accomodate newly added items or
3929 * current user input.
3935 * Construct a OO.ui.CapsuleItemWidget (or a subclass thereof) from given label and data.
3936 * May return `null` if the given label and data are not valid.
3939 * @param {Mixed} data Custom data of any type.
3940 * @param {string} label The label text.
3941 * @return {OO.ui.CapsuleItemWidget|null}
3943 OO
.ui
.CapsuleMultiselectWidget
.prototype.createItemWidget = function ( data
, label
) {
3944 if ( label
=== '' ) {
3947 return new OO
.ui
.CapsuleItemWidget( { data
: data
, label
: label
} );
3953 OO
.ui
.CapsuleMultiselectWidget
.prototype.getInputId = function () {
3954 if ( !this.$input
) {
3957 return OO
.ui
.mixin
.TabIndexedElement
.prototype.getInputId
.call( this );
3961 * Get the data of the items in the capsule
3965 OO
.ui
.CapsuleMultiselectWidget
.prototype.getItemsData = function () {
3966 return this.getItems().map( function ( item
) {
3972 * Set the items in the capsule by providing data
3975 * @param {Mixed[]} datas
3976 * @return {OO.ui.CapsuleMultiselectWidget}
3978 OO
.ui
.CapsuleMultiselectWidget
.prototype.setItemsFromData = function ( datas
) {
3981 items
= this.getItems();
3983 $.each( datas
, function ( i
, data
) {
3985 item
= menu
.getItemFromData( data
);
3989 } else if ( widget
.allowArbitrary
) {
3990 label
= String( data
);
3996 for ( j
= 0; j
< items
.length
; j
++ ) {
3997 if ( items
[ j
].data
=== data
&& items
[ j
].label
=== label
) {
3999 items
.splice( j
, 1 );
4004 item
= widget
.createItemWidget( data
, label
);
4007 widget
.addItems( [ item
], i
);
4011 if ( items
.length
) {
4012 widget
.removeItems( items
);
4019 * Add items to the capsule by providing their data
4022 * @param {Mixed[]} datas
4023 * @return {OO.ui.CapsuleMultiselectWidget}
4025 OO
.ui
.CapsuleMultiselectWidget
.prototype.addItemsFromData = function ( datas
) {
4030 $.each( datas
, function ( i
, data
) {
4033 if ( !widget
.getItemFromData( data
) || widget
.allowDuplicates
) {
4034 item
= menu
.getItemFromData( data
);
4036 item
= widget
.createItemWidget( data
, item
.label
);
4037 } else if ( widget
.allowArbitrary
) {
4038 item
= widget
.createItemWidget( data
, String( data
) );
4046 if ( items
.length
) {
4047 this.addItems( items
);
4054 * Add items to the capsule by providing a label
4056 * @param {string} label
4057 * @return {boolean} Whether the item was added or not
4059 OO
.ui
.CapsuleMultiselectWidget
.prototype.addItemFromLabel = function ( label
) {
4061 item
= this.menu
.getItemFromLabel( label
, true );
4063 this.addItemsFromData( [ item
.data
] );
4065 } else if ( this.allowArbitrary
) {
4066 items
= this.getItems();
4067 this.addItemsFromData( [ label
] );
4068 return !OO
.compare( this.getItems(), items
);
4074 * Remove items by data
4077 * @param {Mixed[]} datas
4078 * @return {OO.ui.CapsuleMultiselectWidget}
4080 OO
.ui
.CapsuleMultiselectWidget
.prototype.removeItemsFromData = function ( datas
) {
4084 $.each( datas
, function ( i
, data
) {
4085 var item
= widget
.getItemFromData( data
);
4091 if ( items
.length
) {
4092 this.removeItems( items
);
4101 OO
.ui
.CapsuleMultiselectWidget
.prototype.addItems = function ( items
) {
4103 oldItems
= this.items
.slice();
4105 OO
.ui
.mixin
.GroupElement
.prototype.addItems
.call( this, items
);
4107 if ( this.items
.length
!== oldItems
.length
) {
4111 for ( i
= 0, l
= oldItems
.length
; same
&& i
< l
; i
++ ) {
4112 same
= same
&& this.items
[ i
] === oldItems
[ i
];
4116 this.emit( 'change', this.getItemsData() );
4117 this.updateInputSize();
4124 * Removes the item from the list and copies its label to `this.$input`.
4126 * @param {Object} item
4128 OO
.ui
.CapsuleMultiselectWidget
.prototype.editItem = function ( item
) {
4129 this.addItemFromLabel( this.$input
.val() );
4131 this.$input
.val( item
.label
);
4132 this.updateInputSize();
4134 this.menu
.updateItemVisibility(); // Hack, we shouldn't be calling this method directly
4135 this.removeItems( [ item
] );
4141 OO
.ui
.CapsuleMultiselectWidget
.prototype.removeItems = function ( items
) {
4143 oldItems
= this.items
.slice();
4145 OO
.ui
.mixin
.GroupElement
.prototype.removeItems
.call( this, items
);
4147 if ( this.items
.length
!== oldItems
.length
) {
4151 for ( i
= 0, l
= oldItems
.length
; same
&& i
< l
; i
++ ) {
4152 same
= same
&& this.items
[ i
] === oldItems
[ i
];
4156 this.emit( 'change', this.getItemsData() );
4157 this.updateInputSize();
4166 OO
.ui
.CapsuleMultiselectWidget
.prototype.clearItems = function () {
4167 if ( this.items
.length
) {
4168 OO
.ui
.mixin
.GroupElement
.prototype.clearItems
.call( this );
4169 this.emit( 'change', this.getItemsData() );
4170 this.updateInputSize();
4176 * Given an item, returns the item after it. If its the last item,
4177 * returns `this.$input`. If no item is passed, returns the very first
4180 * @param {OO.ui.CapsuleItemWidget} [item]
4181 * @return {OO.ui.CapsuleItemWidget|jQuery|boolean}
4183 OO
.ui
.CapsuleMultiselectWidget
.prototype.getNextItem = function ( item
) {
4186 if ( item
=== undefined ) {
4187 return this.items
[ 0 ];
4190 itemIndex
= this.items
.indexOf( item
);
4191 if ( itemIndex
< 0 ) { // Item not in list
4193 } else if ( itemIndex
=== this.items
.length
- 1 ) { // Last item
4196 return this.items
[ itemIndex
+ 1 ];
4201 * Given an item, returns the item before it. If its the first item,
4202 * returns `this.$input`. If no item is passed, returns the very last
4205 * @param {OO.ui.CapsuleItemWidget} [item]
4206 * @return {OO.ui.CapsuleItemWidget|jQuery|boolean}
4208 OO
.ui
.CapsuleMultiselectWidget
.prototype.getPreviousItem = function ( item
) {
4211 if ( item
=== undefined ) {
4212 return this.items
[ this.items
.length
- 1 ];
4215 itemIndex
= this.items
.indexOf( item
);
4216 if ( itemIndex
< 0 ) { // Item not in list
4218 } else if ( itemIndex
=== 0 ) { // First item
4221 return this.items
[ itemIndex
- 1 ];
4226 * Get the capsule widget's menu.
4228 * @return {OO.ui.MenuSelectWidget} Menu widget
4230 OO
.ui
.CapsuleMultiselectWidget
.prototype.getMenu = function () {
4235 * Handle focus events
4238 * @param {jQuery.Event} event
4240 OO
.ui
.CapsuleMultiselectWidget
.prototype.onInputFocus = function () {
4241 if ( !this.isDisabled() ) {
4242 this.updateInputSize();
4243 this.menu
.toggle( true );
4248 * Handle blur events
4251 * @param {jQuery.Event} event
4253 OO
.ui
.CapsuleMultiselectWidget
.prototype.onInputBlur = function () {
4254 this.addItemFromLabel( this.$input
.val() );
4259 * Handles popup focus out events.
4262 * @param {jQuery.Event} e Focus out event
4264 OO
.ui
.CapsuleMultiselectWidget
.prototype.onPopupFocusOut = function () {
4265 var widget
= this.popup
;
4267 setTimeout( function () {
4269 widget
.isVisible() &&
4270 !OO
.ui
.contains( widget
.$element
.add( widget
.$autoCloseIgnore
).get(), document
.activeElement
, true )
4272 widget
.toggle( false );
4278 * Handle mouse down events.
4281 * @param {jQuery.Event} e Mouse down event
4283 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMouseDown = function ( e
) {
4284 if ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
4288 this.updateInputSize();
4293 * Handle key press events.
4296 * @param {jQuery.Event} e Key press event
4298 OO
.ui
.CapsuleMultiselectWidget
.prototype.onKeyPress = function ( e
) {
4299 if ( !this.isDisabled() ) {
4300 if ( e
.which
=== OO
.ui
.Keys
.ESCAPE
) {
4305 if ( !this.popup
) {
4306 this.menu
.toggle( true );
4307 if ( e
.which
=== OO
.ui
.Keys
.ENTER
) {
4308 if ( this.addItemFromLabel( this.$input
.val() ) ) {
4314 // Make sure the input gets resized.
4315 setTimeout( this.updateInputSize
.bind( this ), 0 );
4321 * Handle key down events.
4324 * @param {jQuery.Event} e Key down event
4326 OO
.ui
.CapsuleMultiselectWidget
.prototype.onKeyDown = function ( e
) {
4328 !this.isDisabled() &&
4329 this.$input
.val() === '' &&
4332 // 'keypress' event is not triggered for Backspace
4333 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
) {
4334 if ( e
.metaKey
|| e
.ctrlKey
) {
4335 this.removeItems( this.items
.slice( -1 ) );
4337 this.editItem( this.items
[ this.items
.length
- 1 ] );
4340 } else if ( e
.keyCode
=== OO
.ui
.Keys
.LEFT
) {
4341 this.getPreviousItem().focus();
4342 } else if ( e
.keyCode
=== OO
.ui
.Keys
.RIGHT
) {
4343 this.getNextItem().focus();
4349 * Update the dimensions of the text input field to encompass all available area.
4352 * @param {jQuery.Event} e Event of some sort
4354 OO
.ui
.CapsuleMultiselectWidget
.prototype.updateInputSize = function () {
4355 var $lastItem
, direction
, contentWidth
, currentWidth
, bestWidth
;
4356 if ( this.$input
&& !this.isDisabled() ) {
4357 this.$input
.css( 'width', '1em' );
4358 $lastItem
= this.$group
.children().last();
4359 direction
= OO
.ui
.Element
.static.getDir( this.$handle
);
4361 // Get the width of the input with the placeholder text as
4362 // the value and save it so that we don't keep recalculating
4364 this.contentWidthWithPlaceholder
=== undefined &&
4365 this.$input
.val() === '' &&
4366 this.$input
.attr( 'placeholder' ) !== undefined
4368 this.$input
.val( this.$input
.attr( 'placeholder' ) );
4369 this.contentWidthWithPlaceholder
= this.$input
[ 0 ].scrollWidth
;
4370 this.$input
.val( '' );
4374 // Always keep the input wide enough for the placeholder text
4375 contentWidth
= Math
.max(
4376 this.$input
[ 0 ].scrollWidth
,
4377 // undefined arguments in Math.max lead to NaN
4378 ( this.contentWidthWithPlaceholder
=== undefined ) ?
4379 0 : this.contentWidthWithPlaceholder
4381 currentWidth
= this.$input
.width();
4383 if ( contentWidth
< currentWidth
) {
4384 this.updateIfHeightChanged();
4385 // All is fine, don't perform expensive calculations
4389 if ( $lastItem
.length
=== 0 ) {
4390 bestWidth
= this.$content
.innerWidth();
4392 bestWidth
= direction
=== 'ltr' ?
4393 this.$content
.innerWidth() - $lastItem
.position().left
- $lastItem
.outerWidth() :
4394 $lastItem
.position().left
;
4397 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
4398 // pixels this is off by are coming from.
4400 if ( contentWidth
> bestWidth
) {
4401 // This will result in the input getting shifted to the next line
4402 bestWidth
= this.$content
.innerWidth() - 10;
4404 this.$input
.width( Math
.floor( bestWidth
) );
4405 this.updateIfHeightChanged();
4407 this.updateIfHeightChanged();
4412 * Determine if widget height changed, and if so, update menu position and emit 'resize' event.
4416 OO
.ui
.CapsuleMultiselectWidget
.prototype.updateIfHeightChanged = function () {
4417 var height
= this.$element
.height();
4418 if ( height
!== this.height
) {
4419 this.height
= height
;
4420 this.menu
.position();
4422 this.popup
.updateDimensions();
4424 this.emit( 'resize' );
4429 * Handle menu choose events.
4432 * @param {OO.ui.OptionWidget} item Chosen item
4434 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMenuChoose = function ( item
) {
4435 if ( item
&& item
.isVisible() ) {
4436 this.addItemsFromData( [ item
.getData() ] );
4442 * Handle menu toggle events.
4445 * @param {boolean} isVisible Menu toggle event
4447 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
4448 this.$element
.toggleClass( 'oo-ui-capsuleMultiselectWidget-open', isVisible
);
4452 * Handle menu item change events.
4456 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMenuItemsChange = function () {
4457 this.setItemsFromData( this.getItemsData() );
4458 this.$element
.toggleClass( 'oo-ui-capsuleMultiselectWidget-empty', this.menu
.isEmpty() );
4462 * Clear the input field
4466 OO
.ui
.CapsuleMultiselectWidget
.prototype.clearInput = function () {
4467 if ( this.$input
) {
4468 this.$input
.val( '' );
4469 this.updateInputSize();
4472 this.popup
.toggle( false );
4474 this.menu
.toggle( false );
4475 this.menu
.selectItem();
4476 this.menu
.highlightItem();
4482 OO
.ui
.CapsuleMultiselectWidget
.prototype.setDisabled = function ( disabled
) {
4486 OO
.ui
.CapsuleMultiselectWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
4488 if ( this.$input
) {
4489 this.$input
.prop( 'disabled', this.isDisabled() );
4492 this.menu
.setDisabled( this.isDisabled() );
4495 this.popup
.setDisabled( this.isDisabled() );
4499 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
4500 this.items
[ i
].updateDisabled();
4512 OO
.ui
.CapsuleMultiselectWidget
.prototype.focus = function () {
4513 if ( !this.isDisabled() ) {
4515 this.popup
.setSize( this.$handle
.outerWidth() );
4516 this.popup
.toggle( true );
4517 OO
.ui
.findFocusable( this.popup
.$element
).focus();
4519 OO
.ui
.mixin
.TabIndexedElement
.prototype.focus
.call( this );
4526 * TagItemWidgets are used within a {@link OO.ui.TagMultiselectWidget
4527 * TagMultiselectWidget} to display the selected items.
4530 * @extends OO.ui.Widget
4531 * @mixins OO.ui.mixin.ItemWidget
4532 * @mixins OO.ui.mixin.LabelElement
4533 * @mixins OO.ui.mixin.FlaggedElement
4534 * @mixins OO.ui.mixin.TabIndexedElement
4535 * @mixins OO.ui.mixin.DraggableElement
4538 * @param {Object} [config] Configuration object
4539 * @cfg {boolean} [valid=true] Item is valid
4541 OO
.ui
.TagItemWidget
= function OoUiTagItemWidget( config
) {
4542 config
= config
|| {};
4544 // Parent constructor
4545 OO
.ui
.TagItemWidget
.parent
.call( this, config
);
4547 // Mixin constructors
4548 OO
.ui
.mixin
.ItemWidget
.call( this );
4549 OO
.ui
.mixin
.LabelElement
.call( this, config
);
4550 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
4551 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
4552 OO
.ui
.mixin
.DraggableElement
.call( this, config
);
4554 this.valid
= config
.valid
=== undefined ? true : !!config
.valid
;
4556 this.closeButton
= new OO
.ui
.ButtonWidget( {
4560 title
: OO
.ui
.msg( 'ooui-item-remove' )
4562 this.closeButton
.setDisabled( this.isDisabled() );
4566 .connect( this, { click
: 'remove' } );
4568 .on( 'click', this.select
.bind( this ) )
4569 .on( 'keydown', this.onKeyDown
.bind( this ) )
4570 // Prevent propagation of mousedown; the tag item "lives" in the
4571 // clickable area of the TagMultiselectWidget, which listens to
4572 // mousedown to open the menu or popup. We want to prevent that
4573 // for clicks specifically on the tag itself, so the actions taken
4574 // are more deliberate. When the tag is clicked, it will emit the
4575 // selection event (similar to how #OO.ui.MultioptionWidget emits 'change')
4576 // and can be handled separately.
4577 .on( 'mousedown', function ( e
) { e
.stopPropagation(); } );
4581 .addClass( 'oo-ui-tagItemWidget' )
4582 .append( this.$label
, this.closeButton
.$element
);
4585 /* Initialization */
4587 OO
.inheritClass( OO
.ui
.TagItemWidget
, OO
.ui
.Widget
);
4588 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.ItemWidget
);
4589 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.LabelElement
);
4590 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.FlaggedElement
);
4591 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.TabIndexedElement
);
4592 OO
.mixinClass( OO
.ui
.TagItemWidget
, OO
.ui
.mixin
.DraggableElement
);
4599 * A remove action was performed on the item
4604 * @param {string} direction Direction of the movement, forward or backwards
4606 * A navigate action was performed on the item
4612 * The tag widget was selected. This can occur when the widget
4613 * is either clicked or enter was pressed on it.
4618 * @param {boolean} isValid Item is valid
4620 * Item validity has changed
4628 OO
.ui
.TagItemWidget
.prototype.setDisabled = function ( state
) {
4630 OO
.ui
.TagItemWidget
.parent
.prototype.setDisabled
.call( this, state
);
4632 if ( this.closeButton
) {
4633 this.closeButton
.setDisabled( state
);
4639 * Handle removal of the item
4641 * This is mainly for extensibility concerns, so other children
4642 * of this class can change the behavior if they need to. This
4643 * is called by both clicking the 'remove' button but also
4644 * on keypress, which is harder to override if needed.
4648 OO
.ui
.TagItemWidget
.prototype.remove = function () {
4649 if ( !this.isDisabled() ) {
4650 this.emit( 'remove' );
4655 * Handle a keydown event on the widget
4659 * @param {jQuery.Event} e Key down event
4660 * @return {boolean|undefined} false to stop the operation
4662 OO
.ui
.TagItemWidget
.prototype.onKeyDown = function ( e
) {
4665 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
|| e
.keyCode
=== OO
.ui
.Keys
.DELETE
) {
4668 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ENTER
) {
4672 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
4673 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
4675 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
4689 e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
4690 movement
.left
: movement
.right
4700 OO
.ui
.TagItemWidget
.prototype.select = function () {
4701 if ( !this.isDisabled() ) {
4702 this.emit( 'select' );
4707 * Set the valid state of this item
4709 * @param {boolean} [valid] Item is valid
4712 OO
.ui
.TagItemWidget
.prototype.toggleValid = function ( valid
) {
4713 valid
= valid
=== undefined ? !this.valid
: !!valid
;
4715 if ( this.valid
!== valid
) {
4718 this.setFlags( { invalid
: !this.valid
} );
4720 this.emit( 'valid', this.valid
);
4725 * Check whether the item is valid
4727 * @return {boolean} Item is valid
4729 OO
.ui
.TagItemWidget
.prototype.isValid = function () {
4734 * A basic tag multiselect widget, similar in concept to {@link OO.ui.ComboBoxInputWidget combo box widget}
4735 * that allows the user to add multiple values that are displayed in a tag area.
4737 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
4739 * This widget is a base widget; see {@link OO.ui.MenuTagMultiselectWidget MenuTagMultiselectWidget} and
4740 * {@link OO.ui.PopupTagMultiselectWidget PopupTagMultiselectWidget} for the implementations that use
4741 * a menu and a popup respectively.
4744 * // Example: A basic TagMultiselectWidget.
4745 * var widget = new OO.ui.TagMultiselectWidget( {
4746 * inputPosition: 'outline',
4747 * allowedValues: [ 'Option 1', 'Option 2', 'Option 3' ],
4748 * selected: [ 'Option 1' ]
4750 * $( 'body' ).append( widget.$element );
4752 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
4755 * @extends OO.ui.Widget
4756 * @mixins OO.ui.mixin.GroupWidget
4757 * @mixins OO.ui.mixin.DraggableGroupElement
4758 * @mixins OO.ui.mixin.IndicatorElement
4759 * @mixins OO.ui.mixin.IconElement
4760 * @mixins OO.ui.mixin.TabIndexedElement
4761 * @mixins OO.ui.mixin.FlaggedElement
4764 * @param {Object} config Configuration object
4765 * @cfg {Object} [input] Configuration options for the input widget
4766 * @cfg {OO.ui.InputWidget} [inputWidget] An optional input widget. If given, it will
4767 * replace the input widget used in the TagMultiselectWidget. If not given,
4768 * TagMultiselectWidget creates its own.
4769 * @cfg {boolean} [inputPosition='inline'] Position of the input. Options are:
4770 * - inline: The input is invisible, but exists inside the tag list, so
4771 * the user types into the tag groups to add tags.
4772 * - outline: The input is underneath the tag area.
4773 * - none: No input supplied
4774 * @cfg {boolean} [allowEditTags=true] Allow editing of the tags by clicking them
4775 * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if
4776 * not present in the menu.
4777 * @cfg {Object[]} [allowedValues] An array representing the allowed items
4779 * @cfg {boolean} [allowDuplicates=false] Allow duplicate items to be added
4780 * @cfg {boolean} [allowDisplayInvalidTags=false] Allow the display of
4781 * invalid tags. These tags will display with an invalid state, and
4782 * the widget as a whole will have an invalid state if any invalid tags
4784 * @cfg {boolean} [allowReordering=true] Allow reordering of the items
4785 * @cfg {Object[]|String[]} [selected] A set of selected tags. If given,
4786 * these will appear in the tag list on initialization, as long as they
4787 * pass the validity tests.
4789 OO
.ui
.TagMultiselectWidget
= function OoUiTagMultiselectWidget( config
) {
4791 rAF
= window
.requestAnimationFrame
|| setTimeout
,
4793 $tabFocus
= $( '<span>' )
4794 .addClass( 'oo-ui-tagMultiselectWidget-focusTrap' );
4796 config
= config
|| {};
4798 // Parent constructor
4799 OO
.ui
.TagMultiselectWidget
.parent
.call( this, config
);
4801 // Mixin constructors
4802 OO
.ui
.mixin
.GroupWidget
.call( this, config
);
4803 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
4804 OO
.ui
.mixin
.IconElement
.call( this, config
);
4805 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
4806 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
4807 OO
.ui
.mixin
.DraggableGroupElement
.call( this, config
);
4809 this.toggleDraggable(
4810 config
.allowReordering
=== undefined ?
4811 true : !!config
.allowReordering
4814 this.inputPosition
=
4815 this.constructor.static.allowedInputPositions
.indexOf( config
.inputPosition
) > -1 ?
4816 config
.inputPosition
: 'inline';
4817 this.allowEditTags
= config
.allowEditTags
=== undefined ? true : !!config
.allowEditTags
;
4818 this.allowArbitrary
= !!config
.allowArbitrary
;
4819 this.allowDuplicates
= !!config
.allowDuplicates
;
4820 this.allowedValues
= config
.allowedValues
|| [];
4821 this.allowDisplayInvalidTags
= config
.allowDisplayInvalidTags
;
4822 this.hasInput
= this.inputPosition
!== 'none';
4826 this.$content
= $( '<div>' )
4827 .addClass( 'oo-ui-tagMultiselectWidget-content' );
4828 this.$handle
= $( '<div>' )
4829 .addClass( 'oo-ui-tagMultiselectWidget-handle' )
4836 .addClass( 'oo-ui-tagMultiselectWidget-group' )
4842 remove
: 'itemRemove',
4843 navigate
: 'itemNavigate',
4844 select
: 'itemSelect'
4846 this.connect( this, {
4847 itemRemove
: 'onTagRemove',
4848 itemSelect
: 'onTagSelect',
4849 itemNavigate
: 'onTagNavigate',
4850 change
: 'onChangeTags'
4853 mousedown
: this.onMouseDown
.bind( this )
4858 .addClass( 'oo-ui-tagMultiselectWidget' )
4859 .append( this.$handle
);
4861 if ( this.hasInput
) {
4862 if ( config
.inputWidget
) {
4863 this.input
= config
.inputWidget
;
4865 this.input
= new OO
.ui
.TextInputWidget( $.extend( {
4866 placeholder
: config
.placeholder
,
4867 classes
: [ 'oo-ui-tagMultiselectWidget-input' ]
4868 }, config
.input
) );
4870 this.input
.setDisabled( this.isDisabled() );
4873 focus
: this.onInputFocus
.bind( this ),
4874 blur
: this.onInputBlur
.bind( this ),
4875 'propertychange change click mouseup keydown keyup input cut paste select focus':
4876 OO
.ui
.debounce( this.updateInputSize
.bind( this ) ),
4877 keydown
: this.onInputKeyDown
.bind( this ),
4878 keypress
: this.onInputKeyPress
.bind( this )
4881 this.input
.$input
.on( inputEvents
);
4883 if ( this.inputPosition
=== 'outline' ) {
4884 // Override max-height for the input widget
4885 // in the case the widget is outline so it can
4886 // stretch all the way if the widet is wide
4887 this.input
.$element
.css( 'max-width', 'inherit' );
4889 .addClass( 'oo-ui-tagMultiselectWidget-outlined' )
4890 .append( this.input
.$element
);
4892 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-inlined' );
4893 // HACK: When the widget is using 'inline' input, the
4894 // behavior needs to only use the $input itself
4895 // so we style and size it accordingly (otherwise
4896 // the styling and sizing can get very convoluted
4897 // when the wrapping divs and other elements)
4898 // We are taking advantage of still being able to
4899 // call the widget itself for operations like
4900 // .getValue() and setDisabled() and .focus() but
4901 // having only the $input attached to the DOM
4902 this.$content
.append( this.input
.$input
);
4905 this.$content
.append( $tabFocus
);
4908 this.setTabIndexedElement(
4914 if ( config
.selected
) {
4915 this.setValue( config
.selected
);
4918 // HACK: Input size needs to be calculated after everything
4921 if ( widget
.hasInput
) {
4922 widget
.updateInputSize();
4927 /* Initialization */
4929 OO
.inheritClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.Widget
);
4930 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.GroupWidget
);
4931 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.DraggableGroupElement
);
4932 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IndicatorElement
);
4933 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.IconElement
);
4934 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
4935 OO
.mixinClass( OO
.ui
.TagMultiselectWidget
, OO
.ui
.mixin
.FlaggedElement
);
4937 /* Static properties */
4940 * Allowed input positions.
4941 * - inline: The input is inside the tag list
4942 * - outline: The input is under the tag list
4943 * - none: There is no input
4947 OO
.ui
.TagMultiselectWidget
.static.allowedInputPositions
= [ 'inline', 'outline', 'none' ];
4952 * Handle mouse down events.
4955 * @param {jQuery.Event} e Mouse down event
4956 * @return {boolean} False to prevent defaults
4958 OO
.ui
.TagMultiselectWidget
.prototype.onMouseDown = function ( e
) {
4959 if ( !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
4966 * Handle key press events.
4969 * @param {jQuery.Event} e Key press event
4970 * @return {boolean} Whether to prevent defaults
4972 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyPress = function ( e
) {
4974 withMetaKey
= e
.metaKey
|| e
.ctrlKey
;
4976 if ( !this.isDisabled() ) {
4977 if ( e
.which
=== OO
.ui
.Keys
.ENTER
) {
4978 stopOrContinue
= this.doInputEnter( e
, withMetaKey
);
4981 // Make sure the input gets resized.
4982 setTimeout( this.updateInputSize
.bind( this ), 0 );
4983 return stopOrContinue
;
4988 * Handle key down events.
4991 * @param {jQuery.Event} e Key down event
4994 OO
.ui
.TagMultiselectWidget
.prototype.onInputKeyDown = function ( e
) {
4995 var movement
, direction
,
4996 withMetaKey
= e
.metaKey
|| e
.ctrlKey
;
4998 if ( !this.isDisabled() ) {
4999 // 'keypress' event is not triggered for Backspace
5000 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
) {
5001 return this.doInputBackspace( e
, withMetaKey
);
5002 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ESCAPE
) {
5003 return this.doInputEscape( e
);
5005 e
.keyCode
=== OO
.ui
.Keys
.LEFT
||
5006 e
.keyCode
=== OO
.ui
.Keys
.RIGHT
5008 if ( OO
.ui
.Element
.static.getDir( this.$element
) === 'rtl' ) {
5019 direction
= e
.keyCode
=== OO
.ui
.Keys
.LEFT
?
5020 movement
.left
: movement
.right
;
5022 return this.doInputArrow( e
, direction
, withMetaKey
);
5028 * Respond to input focus event
5030 OO
.ui
.TagMultiselectWidget
.prototype.onInputFocus = function () {
5031 this.$element
.addClass( 'oo-ui-tagMultiselectWidget-focus' );
5035 * Respond to input blur event
5037 OO
.ui
.TagMultiselectWidget
.prototype.onInputBlur = function () {
5038 this.$element
.removeClass( 'oo-ui-tagMultiselectWidget-focus' );
5042 * Perform an action after the enter key on the input
5044 * @param {jQuery.Event} e Event data
5045 * @param {boolean} [withMetaKey] Whether this key was pressed with
5046 * a meta key like 'ctrl'
5047 * @return {boolean} Whether to prevent defaults
5049 OO
.ui
.TagMultiselectWidget
.prototype.doInputEnter = function () {
5050 this.addTagFromInput();
5055 * Perform an action responding to the enter key on the input
5057 * @param {jQuery.Event} e Event data
5058 * @param {boolean} [withMetaKey] Whether this key was pressed with
5059 * a meta key like 'ctrl'
5060 * @return {boolean} Whether to prevent defaults
5062 OO
.ui
.TagMultiselectWidget
.prototype.doInputBackspace = function ( e
, withMetaKey
) {
5066 this.inputPosition
=== 'inline' &&
5067 this.input
.getValue() === '' &&
5070 // Delete the last item
5071 items
= this.getItems();
5072 item
= items
[ items
.length
- 1 ];
5073 this.removeItems( [ item
] );
5074 // If Ctrl/Cmd was pressed, delete item entirely.
5075 // Otherwise put it into the text field for editing.
5076 if ( !withMetaKey
) {
5077 this.input
.setValue( item
.getData() );
5085 * Perform an action after the escape key on the input
5087 * @param {jQuery.Event} e Event data
5089 OO
.ui
.TagMultiselectWidget
.prototype.doInputEscape = function () {
5094 * Perform an action after the arrow key on the input, select the previous
5095 * or next item from the input.
5096 * See #getPreviousItem and #getNextItem
5098 * @param {jQuery.Event} e Event data
5099 * @param {string} direction Direction of the movement; forwards or backwards
5100 * @param {boolean} [withMetaKey] Whether this key was pressed with
5101 * a meta key like 'ctrl'
5103 OO
.ui
.TagMultiselectWidget
.prototype.doInputArrow = function ( e
, direction
) {
5105 this.inputPosition
=== 'inline' &&
5108 if ( direction
=== 'backwards' ) {
5109 // Get previous item
5110 this.getPreviousItem().focus();
5113 this.getNextItem().focus();
5119 * Respond to item select event
5121 * @param {OO.ui.TagItemWidget} item Selected item
5123 OO
.ui
.TagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
5124 if ( this.hasInput
&& this.allowEditTags
) {
5125 if ( this.input
.getValue() ) {
5126 this.addTagFromInput();
5128 // 1. Get the label of the tag into the input
5129 this.input
.setValue( item
.getData() );
5130 // 2. Remove the tag
5131 this.removeItems( [ item
] );
5132 // 3. Focus the input
5138 * Respond to change event, where items were added, removed, or cleared.
5140 OO
.ui
.TagMultiselectWidget
.prototype.onChangeTags = function () {
5141 this.toggleValid( this.checkValidity() );
5142 if ( this.hasInput
) {
5143 this.updateInputSize();
5145 this.updateIfHeightChanged();
5151 OO
.ui
.TagMultiselectWidget
.prototype.setDisabled = function ( isDisabled
) {
5153 OO
.ui
.TagMultiselectWidget
.parent
.prototype.setDisabled
.call( this, isDisabled
);
5155 if ( this.hasInput
&& this.input
) {
5156 this.input
.setDisabled( !!isDisabled
);
5160 this.getItems().forEach( function ( item
) {
5161 item
.setDisabled( !!isDisabled
);
5167 * Respond to tag remove event
5168 * @param {OO.ui.TagItemWidget} item Removed tag
5170 OO
.ui
.TagMultiselectWidget
.prototype.onTagRemove = function ( item
) {
5171 this.removeTagByData( item
.getData() );
5175 * Respond to navigate event on the tag
5177 * @param {OO.ui.TagItemWidget} item Removed tag
5178 * @param {string} direction Direction of movement; 'forwards' or 'backwards'
5180 OO
.ui
.TagMultiselectWidget
.prototype.onTagNavigate = function ( item
, direction
) {
5181 if ( direction
=== 'forwards' ) {
5182 this.getNextItem( item
).focus();
5184 this.getPreviousItem( item
).focus();
5189 * Add tag from input value
5191 OO
.ui
.TagMultiselectWidget
.prototype.addTagFromInput = function () {
5192 var val
= this.input
.getValue(),
5193 isValid
= this.isAllowedData( val
);
5199 if ( isValid
|| this.allowDisplayInvalidTags
) {
5209 OO
.ui
.TagMultiselectWidget
.prototype.clearInput = function () {
5210 this.input
.setValue( '' );
5214 * Check whether the given value is a duplicate of an existing
5215 * tag already in the list.
5217 * @param {string|Object} data Requested value
5218 * @return {boolean} Value is duplicate
5220 OO
.ui
.TagMultiselectWidget
.prototype.isDuplicateData = function ( data
) {
5221 return !!this.getItemFromData( data
);
5225 * Check whether a given value is allowed to be added
5227 * @param {string|Object} data Requested value
5228 * @return {boolean} Value is allowed
5230 OO
.ui
.TagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
5232 !this.allowDuplicates
&&
5233 this.isDuplicateData( data
)
5238 if ( this.allowArbitrary
) {
5242 // Check with allowed values
5244 this.getAllowedValues().some( function ( value
) {
5245 return data
=== value
;
5255 * Get the allowed values list
5257 * @return {string[]} Allowed data values
5259 OO
.ui
.TagMultiselectWidget
.prototype.getAllowedValues = function () {
5260 return this.allowedValues
;
5264 * Add a value to the allowed values list
5266 * @param {string} value Allowed data value
5268 OO
.ui
.TagMultiselectWidget
.prototype.addAllowedValue = function ( value
) {
5269 if ( this.allowedValues
.indexOf( value
) === -1 ) {
5270 this.allowedValues
.push( value
);
5275 * Get the datas of the currently selected items
5277 * @return {string[]|Object[]} Datas of currently selected items
5279 OO
.ui
.TagMultiselectWidget
.prototype.getValue = function () {
5280 return this.getItems()
5281 .filter( function ( item
) {
5282 return item
.isValid();
5284 .map( function ( item
) {
5285 return item
.getData();
5290 * Set the value of this widget by datas.
5292 * @param {string|string[]|Object|Object[]} valueObject An object representing the data
5293 * and label of the value. If the widget allows arbitrary values,
5294 * the items will be added as-is. Otherwise, the data value will
5295 * be checked against allowedValues.
5296 * This object must contain at least a data key. Example:
5297 * { data: 'foo', label: 'Foo item' }
5298 * For multiple items, use an array of objects. For example:
5300 * { data: 'foo', label: 'Foo item' },
5301 * { data: 'bar', label: 'Bar item' }
5303 * Value can also be added with plaintext array, for example:
5304 * [ 'foo', 'bar', 'bla' ] or a single string, like 'foo'
5306 OO
.ui
.TagMultiselectWidget
.prototype.setValue = function ( valueObject
) {
5307 valueObject
= Array
.isArray( valueObject
) ? valueObject
: [ valueObject
];
5310 valueObject
.forEach( function ( obj
) {
5311 if ( typeof obj
=== 'string' ) {
5314 this.addTag( obj
.data
, obj
.label
);
5320 * Add tag to the display area
5322 * @param {string|Object} data Tag data
5323 * @param {string} [label] Tag label. If no label is provided, the
5324 * stringified version of the data will be used instead.
5325 * @return {boolean} Item was added successfully
5327 OO
.ui
.TagMultiselectWidget
.prototype.addTag = function ( data
, label
) {
5329 isValid
= this.isAllowedData( data
);
5331 if ( isValid
|| this.allowDisplayInvalidTags
) {
5332 newItemWidget
= this.createTagItemWidget( data
, label
);
5333 newItemWidget
.toggleValid( isValid
);
5334 this.addItems( [ newItemWidget
] );
5341 * Remove tag by its data property.
5343 * @param {string|Object} data Tag data
5345 OO
.ui
.TagMultiselectWidget
.prototype.removeTagByData = function ( data
) {
5346 var item
= this.getItemFromData( data
);
5348 this.removeItems( [ item
] );
5352 * Construct a OO.ui.TagItemWidget (or a subclass thereof) from given label and data.
5355 * @param {string} data Item data
5356 * @param {string} label The label text.
5357 * @return {OO.ui.TagItemWidget}
5359 OO
.ui
.TagMultiselectWidget
.prototype.createTagItemWidget = function ( data
, label
) {
5360 label
= label
|| data
;
5362 return new OO
.ui
.TagItemWidget( { data
: data
, label
: label
} );
5366 * Given an item, returns the item after it. If the item is already the
5367 * last 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 next widget available.
5374 OO
.ui
.TagMultiselectWidget
.prototype.getNextItem = function ( item
) {
5375 var itemIndex
= this.items
.indexOf( item
);
5377 if ( item
=== undefined || itemIndex
=== -1 ) {
5378 return this.items
[ 0 ];
5381 if ( itemIndex
=== this.items
.length
- 1 ) { // Last item
5382 if ( this.hasInput
) {
5385 // Return first item
5386 return this.items
[ 0 ];
5389 return this.items
[ itemIndex
+ 1 ];
5394 * Given an item, returns the item before it. If the item is already the
5395 * first item, return `this.input`. If no item is passed, returns the
5399 * @param {OO.ui.TagItemWidget} [item] Tag item
5400 * @return {OO.ui.Widget} The previous widget available.
5402 OO
.ui
.TagMultiselectWidget
.prototype.getPreviousItem = function ( item
) {
5403 var itemIndex
= this.items
.indexOf( item
);
5405 if ( item
=== undefined || itemIndex
=== -1 ) {
5406 return this.items
[ this.items
.length
- 1 ];
5409 if ( itemIndex
=== 0 ) {
5410 if ( this.hasInput
) {
5413 // Return the last item
5414 return this.items
[ this.items
.length
- 1 ];
5417 return this.items
[ itemIndex
- 1 ];
5422 * Update the dimensions of the text input field to encompass all available area.
5423 * This is especially relevant for when the input is at the edge of a line
5424 * and should get smaller. The usual operation (as an inline-block with min-width)
5425 * does not work in that case, pushing the input downwards to the next line.
5429 OO
.ui
.TagMultiselectWidget
.prototype.updateInputSize = function () {
5430 var $lastItem
, direction
, contentWidth
, currentWidth
, bestWidth
;
5431 if ( this.inputPosition
=== 'inline' && !this.isDisabled() ) {
5432 if ( this.input
.$input
[ 0 ].scrollWidth
=== 0 ) {
5433 // Input appears to be attached but not visible.
5434 // Don't attempt to adjust its size, because our measurements
5435 // are going to fail anyway.
5438 this.input
.$input
.css( 'width', '1em' );
5439 $lastItem
= this.$group
.children().last();
5440 direction
= OO
.ui
.Element
.static.getDir( this.$handle
);
5442 // Get the width of the input with the placeholder text as
5443 // the value and save it so that we don't keep recalculating
5445 this.contentWidthWithPlaceholder
=== undefined &&
5446 this.input
.getValue() === '' &&
5447 this.input
.$input
.attr( 'placeholder' ) !== undefined
5449 this.input
.setValue( this.input
.$input
.attr( 'placeholder' ) );
5450 this.contentWidthWithPlaceholder
= this.input
.$input
[ 0 ].scrollWidth
;
5451 this.input
.setValue( '' );
5455 // Always keep the input wide enough for the placeholder text
5456 contentWidth
= Math
.max(
5457 this.input
.$input
[ 0 ].scrollWidth
,
5458 // undefined arguments in Math.max lead to NaN
5459 ( this.contentWidthWithPlaceholder
=== undefined ) ?
5460 0 : this.contentWidthWithPlaceholder
5462 currentWidth
= this.input
.$input
.width();
5464 if ( contentWidth
< currentWidth
) {
5465 this.updateIfHeightChanged();
5466 // All is fine, don't perform expensive calculations
5470 if ( $lastItem
.length
=== 0 ) {
5471 bestWidth
= this.$content
.innerWidth();
5473 bestWidth
= direction
=== 'ltr' ?
5474 this.$content
.innerWidth() - $lastItem
.position().left
- $lastItem
.outerWidth() :
5475 $lastItem
.position().left
;
5478 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
5479 // pixels this is off by are coming from.
5481 if ( contentWidth
> bestWidth
) {
5482 // This will result in the input getting shifted to the next line
5483 bestWidth
= this.$content
.innerWidth() - 10;
5485 this.input
.$input
.width( Math
.floor( bestWidth
) );
5486 this.updateIfHeightChanged();
5488 this.updateIfHeightChanged();
5493 * Determine if widget height changed, and if so,
5494 * emit the resize event. This is useful for when there are either
5495 * menus or popups attached to the bottom of the widget, to allow
5496 * them to change their positioning in case the widget moved down
5501 OO
.ui
.TagMultiselectWidget
.prototype.updateIfHeightChanged = function () {
5502 var height
= this.$element
.height();
5503 if ( height
!== this.height
) {
5504 this.height
= height
;
5505 this.emit( 'resize' );
5510 * Check whether all items in the widget are valid
5512 * @return {boolean} Widget is valid
5514 OO
.ui
.TagMultiselectWidget
.prototype.checkValidity = function () {
5515 return this.getItems().every( function ( item
) {
5516 return item
.isValid();
5521 * Set the valid state of this item
5523 * @param {boolean} [valid] Item is valid
5526 OO
.ui
.TagMultiselectWidget
.prototype.toggleValid = function ( valid
) {
5527 valid
= valid
=== undefined ? !this.valid
: !!valid
;
5529 if ( this.valid
!== valid
) {
5532 this.setFlags( { invalid
: !this.valid
} );
5534 this.emit( 'valid', this.valid
);
5539 * Get the current valid state of the widget
5541 * @return {boolean} Widget is valid
5543 OO
.ui
.TagMultiselectWidget
.prototype.isValid = function () {
5548 * PopupTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
5549 * to use a popup. The popup can be configured to have a default input to insert values into the widget.
5551 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
5554 * // Example: A basic PopupTagMultiselectWidget.
5555 * var widget = new OO.ui.PopupTagMultiselectWidget();
5556 * $( 'body' ).append( widget.$element );
5558 * // Example: A PopupTagMultiselectWidget with an external popup.
5559 * var popupInput = new OO.ui.TextInputWidget(),
5560 * widget = new OO.ui.PopupTagMultiselectWidget( {
5561 * popupInput: popupInput,
5563 * $content: popupInput.$element
5566 * $( 'body' ).append( widget.$element );
5568 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
5571 * @extends OO.ui.TagMultiselectWidget
5572 * @mixins OO.ui.mixin.PopupElement
5574 * @param {Object} config Configuration object
5575 * @cfg {jQuery} [$overlay] An overlay for the popup.
5576 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
5577 * @cfg {Object} [popup] Configuration options for the popup
5578 * @cfg {OO.ui.InputWidget} [popupInput] An input widget inside the popup that will be
5579 * focused when the popup is opened and will be used as replacement for the
5580 * general input in the widget.
5582 OO
.ui
.PopupTagMultiselectWidget
= function OoUiPopupTagMultiselectWidget( config
) {
5584 defaultConfig
= { popup
: {} };
5586 config
= config
|| {};
5588 // Parent constructor
5589 OO
.ui
.PopupTagMultiselectWidget
.parent
.call( this, $.extend( { inputPosition
: 'none' }, config
) );
5591 this.$overlay
= config
.$overlay
|| this.$element
;
5593 if ( !config
.popup
) {
5594 // For the default base implementation, we give a popup
5595 // with an input widget inside it. For any other use cases
5596 // the popup needs to be populated externally and the
5597 // event handled to add tags separately and manually
5598 defaultInput
= new OO
.ui
.TextInputWidget();
5600 defaultConfig
.popupInput
= defaultInput
;
5601 defaultConfig
.popup
.$content
= defaultInput
.$element
;
5603 this.$element
.addClass( 'oo-ui-popupTagMultiselectWidget-defaultPopup' );
5606 // Add overlay, and add that to the autoCloseIgnore
5607 defaultConfig
.popup
.$overlay
= this.$overlay
;
5608 defaultConfig
.popup
.$autoCloseIgnore
= this.hasInput
?
5609 this.input
.$element
.add( this.$overlay
) : this.$overlay
;
5611 // Allow extending any of the above
5612 config
= $.extend( defaultConfig
, config
);
5614 // Mixin constructors
5615 OO
.ui
.mixin
.PopupElement
.call( this, config
);
5617 if ( this.hasInput
) {
5618 this.input
.$input
.on( 'focus', this.popup
.toggle
.bind( this.popup
, true ) );
5621 // Configuration options
5622 this.popupInput
= config
.popupInput
;
5623 if ( this.popupInput
) {
5624 this.popupInput
.connect( this, {
5625 enter
: 'onPopupInputEnter'
5630 this.on( 'resize', this.popup
.updateDimensions
.bind( this.popup
) );
5631 this.popup
.connect( this, { toggle
: 'onPopupToggle' } );
5633 .on( 'focus', this.onFocus
.bind( this ) );
5637 .append( this.popup
.$element
)
5638 .addClass( 'oo-ui-popupTagMultiselectWidget' );
5641 /* Initialization */
5643 OO
.inheritClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
5644 OO
.mixinClass( OO
.ui
.PopupTagMultiselectWidget
, OO
.ui
.mixin
.PopupElement
);
5649 * Focus event handler.
5653 OO
.ui
.PopupTagMultiselectWidget
.prototype.onFocus = function () {
5654 this.popup
.toggle( true );
5658 * Respond to popup toggle event
5660 * @param {boolean} isVisible Popup is visible
5662 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupToggle = function ( isVisible
) {
5663 if ( isVisible
&& this.popupInput
) {
5664 this.popupInput
.focus();
5669 * Respond to popup input enter event
5671 OO
.ui
.PopupTagMultiselectWidget
.prototype.onPopupInputEnter = function () {
5672 if ( this.popupInput
) {
5673 this.addTagByPopupValue( this.popupInput
.getValue() );
5674 this.popupInput
.setValue( '' );
5681 OO
.ui
.PopupTagMultiselectWidget
.prototype.onTagSelect = function ( item
) {
5682 if ( this.popupInput
&& this.allowEditTags
) {
5683 this.popupInput
.setValue( item
.getData() );
5684 this.removeItems( [ item
] );
5686 this.popup
.toggle( true );
5687 this.popupInput
.focus();
5690 OO
.ui
.PopupTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, item
);
5695 * Add a tag by the popup value.
5696 * Whatever is responsible for setting the value in the popup should call
5697 * this method to add a tag, or use the regular methods like #addTag or
5698 * #setValue directly.
5700 * @param {string} data The value of item
5701 * @param {string} [label] The label of the tag. If not given, the data is used.
5703 OO
.ui
.PopupTagMultiselectWidget
.prototype.addTagByPopupValue = function ( data
, label
) {
5704 this.addTag( data
, label
);
5708 * MenuTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
5709 * to use a menu of selectable options.
5711 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
5714 * // Example: A basic MenuTagMultiselectWidget.
5715 * var widget = new OO.ui.MenuTagMultiselectWidget( {
5716 * inputPosition: 'outline',
5718 * { data: 'option1', label: 'Option 1' },
5719 * { data: 'option2', label: 'Option 2' },
5720 * { data: 'option3', label: 'Option 3' },
5722 * selected: [ 'option1', 'option2' ]
5724 * $( 'body' ).append( widget.$element );
5726 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
5729 * @extends OO.ui.TagMultiselectWidget
5732 * @param {Object} [config] Configuration object
5733 * @cfg {Object} [menu] Configuration object for the menu widget
5734 * @cfg {jQuery} [$overlay] An overlay for the menu.
5735 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
5736 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
5738 OO
.ui
.MenuTagMultiselectWidget
= function OoUiMenuTagMultiselectWidget( config
) {
5739 config
= config
|| {};
5741 // Parent constructor
5742 OO
.ui
.MenuTagMultiselectWidget
.parent
.call( this, config
);
5744 this.$overlay
= config
.$overlay
|| this.$element
;
5746 this.menu
= this.createMenuWidget( $.extend( {
5748 input
: this.hasInput
? this.input
: null,
5749 $input
: this.hasInput
? this.input
.$input
: null,
5750 filterFromInput
: !!this.hasInput
,
5751 $autoCloseIgnore
: this.hasInput
?
5752 this.input
.$element
.add( this.$overlay
) : this.$overlay
,
5753 $floatableContainer
: this.hasInput
&& this.inputPosition
=== 'outline' ?
5754 this.input
.$element
: this.$element
,
5755 $overlay
: this.$overlay
,
5756 disabled
: this.isDisabled()
5758 this.addOptions( config
.options
|| [] );
5761 this.menu
.connect( this, {
5762 choose
: 'onMenuChoose',
5763 toggle
: 'onMenuToggle'
5765 if ( this.hasInput
) {
5766 this.input
.connect( this, { change
: 'onInputChange' } );
5768 this.connect( this, { resize
: 'onResize' } );
5772 .append( this.menu
.$element
);
5774 .addClass( 'oo-ui-menuTagMultiselectWidget' );
5775 // TagMultiselectWidget already does this, but it doesn't work right because this.menu is not yet
5776 // set up while the parent constructor runs, and #getAllowedValues rejects everything.
5777 if ( config
.selected
) {
5778 this.setValue( config
.selected
);
5782 /* Initialization */
5784 OO
.inheritClass( OO
.ui
.MenuTagMultiselectWidget
, OO
.ui
.TagMultiselectWidget
);
5789 * Respond to resize event
5791 OO
.ui
.MenuTagMultiselectWidget
.prototype.onResize = function () {
5792 // Reposition the menu
5793 this.menu
.position();
5799 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputFocus = function () {
5801 OO
.ui
.MenuTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
5803 this.menu
.toggle( true );
5807 * Respond to input change event
5809 OO
.ui
.MenuTagMultiselectWidget
.prototype.onInputChange = function () {
5810 this.menu
.toggle( true );
5814 * Respond to menu choose event
5816 * @param {OO.ui.OptionWidget} menuItem Chosen menu item
5818 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuChoose = function ( menuItem
) {
5820 this.addTag( menuItem
.getData(), menuItem
.getLabel() );
5824 * Respond to menu toggle event. Reset item highlights on hide.
5826 * @param {boolean} isVisible The menu is visible
5828 OO
.ui
.MenuTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
5830 this.menu
.selectItem( null );
5831 this.menu
.highlightItem( null );
5838 OO
.ui
.MenuTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
5839 var menuItem
= this.menu
.getItemFromData( tagItem
.getData() );
5840 // Override the base behavior from TagMultiselectWidget; the base behavior
5841 // in TagMultiselectWidget is to remove the tag to edit it in the input,
5842 // but in our case, we want to utilize the menu selection behavior, and
5843 // definitely not remove the item.
5845 // Select the menu item
5846 this.menu
.selectItem( menuItem
);
5854 OO
.ui
.MenuTagMultiselectWidget
.prototype.addTagFromInput = function () {
5855 var inputValue
= this.input
.getValue(),
5857 highlightedItem
= this.menu
.findHighlightedItem(),
5858 item
= this.menu
.getItemFromData( inputValue
);
5860 // Override the parent method so we add from the menu
5861 // rather than directly from the input
5863 // Look for a highlighted item first
5864 if ( highlightedItem
) {
5865 validated
= this.addTag( highlightedItem
.getData(), highlightedItem
.getLabel() );
5866 } else if ( item
) {
5867 // Look for the element that fits the data
5868 validated
= this.addTag( item
.getData(), item
.getLabel() );
5870 // Otherwise, add the tag - the method will only add if the
5871 // tag is valid or if invalid tags are allowed
5872 validated
= this.addTag( inputValue
);
5882 * Return the visible items in the menu. This is mainly used for when
5883 * the menu is filtering results.
5885 * @return {OO.ui.MenuOptionWidget[]} Visible results
5887 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenuVisibleItems = function () {
5888 return this.menu
.getItems().filter( function ( menuItem
) {
5889 return menuItem
.isVisible();
5894 * Create the menu for this widget. This is in a separate method so that
5895 * child classes can override this without polluting the constructor with
5896 * unnecessary extra objects that will be overidden.
5898 * @param {Object} menuConfig Configuration options
5899 * @return {OO.ui.MenuSelectWidget} Menu widget
5901 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
5902 return new OO
.ui
.MenuSelectWidget( menuConfig
);
5906 * Add options to the menu
5908 * @param {Object[]} menuOptions Object defining options
5910 OO
.ui
.MenuTagMultiselectWidget
.prototype.addOptions = function ( menuOptions
) {
5912 items
= menuOptions
.map( function ( obj
) {
5913 return widget
.createMenuOptionWidget( obj
.data
, obj
.label
);
5916 this.menu
.addItems( items
);
5920 * Create a menu option widget.
5922 * @param {string} data Item data
5923 * @param {string} [label] Item label
5924 * @return {OO.ui.OptionWidget} Option widget
5926 OO
.ui
.MenuTagMultiselectWidget
.prototype.createMenuOptionWidget = function ( data
, label
) {
5927 return new OO
.ui
.MenuOptionWidget( {
5929 label
: label
|| data
5936 * @return {OO.ui.MenuSelectWidget} Menu
5938 OO
.ui
.MenuTagMultiselectWidget
.prototype.getMenu = function () {
5943 * Get the allowed values list
5945 * @return {string[]} Allowed data values
5947 OO
.ui
.MenuTagMultiselectWidget
.prototype.getAllowedValues = function () {
5950 // If the parent constructor is calling us, we're not ready yet, this.menu is not set up.
5951 menuDatas
= this.menu
.getItems().map( function ( menuItem
) {
5952 return menuItem
.getData();
5955 return this.allowedValues
.concat( menuDatas
);
5959 * SelectFileWidgets allow for selecting files, using the HTML5 File API. These
5960 * widgets can be configured with {@link OO.ui.mixin.IconElement icons} and {@link
5961 * OO.ui.mixin.IndicatorElement indicators}.
5962 * Please see the [OOjs UI documentation on MediaWiki] [1] for more information and examples.
5965 * // Example of a file select widget
5966 * var selectFile = new OO.ui.SelectFileWidget();
5967 * $( 'body' ).append( selectFile.$element );
5969 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets
5972 * @extends OO.ui.Widget
5973 * @mixins OO.ui.mixin.IconElement
5974 * @mixins OO.ui.mixin.IndicatorElement
5975 * @mixins OO.ui.mixin.PendingElement
5976 * @mixins OO.ui.mixin.LabelElement
5979 * @param {Object} [config] Configuration options
5980 * @cfg {string[]|null} [accept=null] MIME types to accept. null accepts all types.
5981 * @cfg {string} [placeholder] Text to display when no file is selected.
5982 * @cfg {string} [notsupported] Text to display when file support is missing in the browser.
5983 * @cfg {boolean} [droppable=true] Whether to accept files by drag and drop.
5984 * @cfg {boolean} [showDropTarget=false] Whether to show a drop target. Requires droppable to be true.
5985 * @cfg {number} [thumbnailSizeLimit=20] File size limit in MiB above which to not try and show a
5986 * preview (for performance)
5988 OO
.ui
.SelectFileWidget
= function OoUiSelectFileWidget( config
) {
5991 // Configuration initialization
5992 config
= $.extend( {
5994 placeholder
: OO
.ui
.msg( 'ooui-selectfile-placeholder' ),
5995 notsupported
: OO
.ui
.msg( 'ooui-selectfile-not-supported' ),
5997 showDropTarget
: false,
5998 thumbnailSizeLimit
: 20
6001 // Parent constructor
6002 OO
.ui
.SelectFileWidget
.parent
.call( this, config
);
6004 // Mixin constructors
6005 OO
.ui
.mixin
.IconElement
.call( this, config
);
6006 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
6007 OO
.ui
.mixin
.PendingElement
.call( this, $.extend( {}, config
, { $pending
: this.$info
} ) );
6008 OO
.ui
.mixin
.LabelElement
.call( this, config
);
6011 this.$info
= $( '<span>' );
6012 this.showDropTarget
= config
.showDropTarget
;
6013 this.thumbnailSizeLimit
= config
.thumbnailSizeLimit
;
6014 this.isSupported
= this.constructor.static.isSupported();
6015 this.currentFile
= null;
6016 if ( Array
.isArray( config
.accept
) ) {
6017 this.accept
= config
.accept
;
6021 this.placeholder
= config
.placeholder
;
6022 this.notsupported
= config
.notsupported
;
6023 this.onFileSelectedHandler
= this.onFileSelected
.bind( this );
6025 this.selectButton
= new OO
.ui
.ButtonWidget( {
6026 classes
: [ 'oo-ui-selectFileWidget-selectButton' ],
6027 label
: OO
.ui
.msg( 'ooui-selectfile-button-select' ),
6028 disabled
: this.disabled
|| !this.isSupported
6031 this.clearButton
= new OO
.ui
.ButtonWidget( {
6032 classes
: [ 'oo-ui-selectFileWidget-clearButton' ],
6035 disabled
: this.disabled
6039 this.selectButton
.$button
.on( {
6040 keypress
: this.onKeyPress
.bind( this )
6042 this.clearButton
.connect( this, {
6043 click
: 'onClearClick'
6045 if ( config
.droppable
) {
6046 dragHandler
= this.onDragEnterOrOver
.bind( this );
6048 dragenter
: dragHandler
,
6049 dragover
: dragHandler
,
6050 dragleave
: this.onDragLeave
.bind( this ),
6051 drop
: this.onDrop
.bind( this )
6057 this.$label
.addClass( 'oo-ui-selectFileWidget-label' );
6059 .addClass( 'oo-ui-selectFileWidget-info' )
6060 .append( this.$icon
, this.$label
, this.clearButton
.$element
, this.$indicator
);
6062 if ( config
.droppable
&& config
.showDropTarget
) {
6063 this.selectButton
.setIcon( 'upload' );
6064 this.$thumbnail
= $( '<div>' ).addClass( 'oo-ui-selectFileWidget-thumbnail' );
6065 this.setPendingElement( this.$thumbnail
);
6067 .addClass( 'oo-ui-selectFileWidget-dropTarget oo-ui-selectFileWidget' )
6069 click
: this.onDropTargetClick
.bind( this )
6074 this.selectButton
.$element
,
6076 .addClass( 'oo-ui-selectFileWidget-dropLabel' )
6077 .text( OO
.ui
.msg( 'ooui-selectfile-dragdrop-placeholder' ) )
6081 .addClass( 'oo-ui-selectFileWidget' )
6082 .append( this.$info
, this.selectButton
.$element
);
6089 OO
.inheritClass( OO
.ui
.SelectFileWidget
, OO
.ui
.Widget
);
6090 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IconElement
);
6091 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IndicatorElement
);
6092 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.PendingElement
);
6093 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.LabelElement
);
6095 /* Static Properties */
6098 * Check if this widget is supported
6103 OO
.ui
.SelectFileWidget
.static.isSupported = function () {
6105 if ( OO
.ui
.SelectFileWidget
.static.isSupportedCache
=== null ) {
6106 $input
= $( '<input>' ).attr( 'type', 'file' );
6107 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= $input
[ 0 ].files
!== undefined;
6109 return OO
.ui
.SelectFileWidget
.static.isSupportedCache
;
6112 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= null;
6119 * A change event is emitted when the on/off state of the toggle changes.
6121 * @param {File|null} value New value
6127 * Get the current value of the field
6129 * @return {File|null}
6131 OO
.ui
.SelectFileWidget
.prototype.getValue = function () {
6132 return this.currentFile
;
6136 * Set the current value of the field
6138 * @param {File|null} file File to select
6140 OO
.ui
.SelectFileWidget
.prototype.setValue = function ( file
) {
6141 if ( this.currentFile
!== file
) {
6142 this.currentFile
= file
;
6144 this.emit( 'change', this.currentFile
);
6151 * Focusses the select file button.
6155 OO
.ui
.SelectFileWidget
.prototype.focus = function () {
6156 this.selectButton
.focus();
6165 OO
.ui
.SelectFileWidget
.prototype.blur = function () {
6166 this.selectButton
.blur();
6173 OO
.ui
.SelectFileWidget
.prototype.simulateLabelClick = function () {
6178 * Update the user interface when a file is selected or unselected
6182 OO
.ui
.SelectFileWidget
.prototype.updateUI = function () {
6184 if ( !this.isSupported
) {
6185 this.$element
.addClass( 'oo-ui-selectFileWidget-notsupported' );
6186 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
6187 this.setLabel( this.notsupported
);
6189 this.$element
.addClass( 'oo-ui-selectFileWidget-supported' );
6190 if ( this.currentFile
) {
6191 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
6193 $label
= $label
.add(
6195 .addClass( 'oo-ui-selectFileWidget-fileName' )
6196 .text( this.currentFile
.name
)
6198 this.setLabel( $label
);
6200 if ( this.showDropTarget
) {
6202 this.loadAndGetImageUrl().done( function ( url
) {
6203 this.$thumbnail
.css( 'background-image', 'url( ' + url
+ ' )' );
6204 }.bind( this ) ).fail( function () {
6205 this.$thumbnail
.append(
6206 new OO
.ui
.IconWidget( {
6208 classes
: [ 'oo-ui-selectFileWidget-noThumbnail-icon' ]
6211 }.bind( this ) ).always( function () {
6214 this.$element
.off( 'click' );
6217 if ( this.showDropTarget
) {
6218 this.$element
.off( 'click' );
6220 click
: this.onDropTargetClick
.bind( this )
6224 .css( 'background-image', '' );
6226 this.$element
.addClass( 'oo-ui-selectFileWidget-empty' );
6227 this.setLabel( this.placeholder
);
6233 * If the selected file is an image, get its URL and load it.
6235 * @return {jQuery.Promise} Promise resolves with the image URL after it has loaded
6237 OO
.ui
.SelectFileWidget
.prototype.loadAndGetImageUrl = function () {
6238 var deferred
= $.Deferred(),
6239 file
= this.currentFile
,
6240 reader
= new FileReader();
6244 ( OO
.getProp( file
, 'type' ) || '' ).indexOf( 'image/' ) === 0 &&
6245 file
.size
< this.thumbnailSizeLimit
* 1024 * 1024
6247 reader
.onload = function ( event
) {
6248 var img
= document
.createElement( 'img' );
6249 img
.addEventListener( 'load', function () {
6251 img
.naturalWidth
=== 0 ||
6252 img
.naturalHeight
=== 0 ||
6253 img
.complete
=== false
6257 deferred
.resolve( event
.target
.result
);
6260 img
.src
= event
.target
.result
;
6262 reader
.readAsDataURL( file
);
6267 return deferred
.promise();
6271 * Add the input to the widget
6275 OO
.ui
.SelectFileWidget
.prototype.addInput = function () {
6276 if ( this.$input
) {
6277 this.$input
.remove();
6280 if ( !this.isSupported
) {
6285 this.$input
= $( '<input>' ).attr( 'type', 'file' );
6286 this.$input
.on( 'change', this.onFileSelectedHandler
);
6287 this.$input
.on( 'click', function ( e
) {
6288 // Prevents dropTarget to get clicked which calls
6289 // a click on this input
6290 e
.stopPropagation();
6295 if ( this.accept
) {
6296 this.$input
.attr( 'accept', this.accept
.join( ', ' ) );
6298 this.selectButton
.$button
.append( this.$input
);
6302 * Determine if we should accept this file
6305 * @param {string} mimeType File MIME type
6308 OO
.ui
.SelectFileWidget
.prototype.isAllowedType = function ( mimeType
) {
6311 if ( !this.accept
|| !mimeType
) {
6315 for ( i
= 0; i
< this.accept
.length
; i
++ ) {
6316 mimeTest
= this.accept
[ i
];
6317 if ( mimeTest
=== mimeType
) {
6319 } else if ( mimeTest
.substr( -2 ) === '/*' ) {
6320 mimeTest
= mimeTest
.substr( 0, mimeTest
.length
- 1 );
6321 if ( mimeType
.substr( 0, mimeTest
.length
) === mimeTest
) {
6331 * Handle file selection from the input
6334 * @param {jQuery.Event} e
6336 OO
.ui
.SelectFileWidget
.prototype.onFileSelected = function ( e
) {
6337 var file
= OO
.getProp( e
.target
, 'files', 0 ) || null;
6339 if ( file
&& !this.isAllowedType( file
.type
) ) {
6343 this.setValue( file
);
6348 * Handle clear button click events.
6352 OO
.ui
.SelectFileWidget
.prototype.onClearClick = function () {
6353 this.setValue( null );
6358 * Handle key press events.
6361 * @param {jQuery.Event} e Key press event
6363 OO
.ui
.SelectFileWidget
.prototype.onKeyPress = function ( e
) {
6364 if ( this.isSupported
&& !this.isDisabled() && this.$input
&&
6365 ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
6367 this.$input
.click();
6373 * Handle drop target click events.
6376 * @param {jQuery.Event} e Key press event
6378 OO
.ui
.SelectFileWidget
.prototype.onDropTargetClick = function () {
6379 if ( this.isSupported
&& !this.isDisabled() && this.$input
) {
6380 this.$input
.click();
6386 * Handle drag enter and over events
6389 * @param {jQuery.Event} e Drag event
6391 OO
.ui
.SelectFileWidget
.prototype.onDragEnterOrOver = function ( e
) {
6393 droppableFile
= false,
6394 dt
= e
.originalEvent
.dataTransfer
;
6397 e
.stopPropagation();
6399 if ( this.isDisabled() || !this.isSupported
) {
6400 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
6401 dt
.dropEffect
= 'none';
6405 // DataTransferItem and File both have a type property, but in Chrome files
6406 // have no information at this point.
6407 itemOrFile
= OO
.getProp( dt
, 'items', 0 ) || OO
.getProp( dt
, 'files', 0 );
6409 if ( this.isAllowedType( itemOrFile
.type
) ) {
6410 droppableFile
= true;
6412 // dt.types is Array-like, but not an Array
6413 } else if ( Array
.prototype.indexOf
.call( OO
.getProp( dt
, 'types' ) || [], 'Files' ) !== -1 ) {
6414 // File information is not available at this point for security so just assume
6415 // it is acceptable for now.
6416 // https://bugzilla.mozilla.org/show_bug.cgi?id=640534
6417 droppableFile
= true;
6420 this.$element
.toggleClass( 'oo-ui-selectFileWidget-canDrop', droppableFile
);
6421 if ( !droppableFile
) {
6422 dt
.dropEffect
= 'none';
6429 * Handle drag leave events
6432 * @param {jQuery.Event} e Drag event
6434 OO
.ui
.SelectFileWidget
.prototype.onDragLeave = function () {
6435 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
6439 * Handle drop events
6442 * @param {jQuery.Event} e Drop event
6444 OO
.ui
.SelectFileWidget
.prototype.onDrop = function ( e
) {
6446 dt
= e
.originalEvent
.dataTransfer
;
6449 e
.stopPropagation();
6450 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
6452 if ( this.isDisabled() || !this.isSupported
) {
6456 file
= OO
.getProp( dt
, 'files', 0 );
6457 if ( file
&& !this.isAllowedType( file
.type
) ) {
6461 this.setValue( file
);
6470 OO
.ui
.SelectFileWidget
.prototype.setDisabled = function ( disabled
) {
6471 OO
.ui
.SelectFileWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
6472 if ( this.selectButton
) {
6473 this.selectButton
.setDisabled( disabled
);
6475 if ( this.clearButton
) {
6476 this.clearButton
.setDisabled( disabled
);
6482 * SearchWidgets combine a {@link OO.ui.TextInputWidget text input field}, where users can type a search query,
6483 * and a menu of search results, which is displayed beneath the query
6484 * field. Unlike {@link OO.ui.mixin.LookupElement lookup menus}, search result menus are always visible to the user.
6485 * Users can choose an item from the menu or type a query into the text field to search for a matching result item.
6486 * In general, search widgets are used inside a separate {@link OO.ui.Dialog dialog} window.
6488 * Each time the query is changed, the search result menu is cleared and repopulated. Please see
6489 * the [OOjs UI demos][1] for an example.
6491 * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/#dialogs-mediawiki-vector-ltr
6494 * @extends OO.ui.Widget
6497 * @param {Object} [config] Configuration options
6498 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
6499 * @cfg {string} [value] Initial query value
6501 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
6502 // Configuration initialization
6503 config
= config
|| {};
6505 // Parent constructor
6506 OO
.ui
.SearchWidget
.parent
.call( this, config
);
6509 this.query
= new OO
.ui
.TextInputWidget( {
6511 placeholder
: config
.placeholder
,
6514 this.results
= new OO
.ui
.SelectWidget();
6515 this.$query
= $( '<div>' );
6516 this.$results
= $( '<div>' );
6519 this.query
.connect( this, {
6520 change
: 'onQueryChange',
6521 enter
: 'onQueryEnter'
6523 this.query
.$input
.on( 'keydown', this.onQueryKeydown
.bind( this ) );
6527 .addClass( 'oo-ui-searchWidget-query' )
6528 .append( this.query
.$element
);
6530 .addClass( 'oo-ui-searchWidget-results' )
6531 .append( this.results
.$element
);
6533 .addClass( 'oo-ui-searchWidget' )
6534 .append( this.$results
, this.$query
);
6539 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
6544 * Handle query key down events.
6547 * @param {jQuery.Event} e Key down event
6549 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
6550 var highlightedItem
, nextItem
,
6551 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
6554 highlightedItem
= this.results
.findHighlightedItem();
6555 if ( !highlightedItem
) {
6556 highlightedItem
= this.results
.getSelectedItem();
6558 nextItem
= this.results
.findRelativeSelectableItem( highlightedItem
, dir
);
6559 this.results
.highlightItem( nextItem
);
6560 nextItem
.scrollElementIntoView();
6565 * Handle select widget select events.
6567 * Clears existing results. Subclasses should repopulate items according to new query.
6570 * @param {string} value New value
6572 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
6574 this.results
.clearItems();
6578 * Handle select widget enter key events.
6580 * Chooses highlighted item.
6583 * @param {string} value New value
6585 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
6586 var highlightedItem
= this.results
.findHighlightedItem();
6587 if ( highlightedItem
) {
6588 this.results
.chooseItem( highlightedItem
);
6593 * Get the query input.
6595 * @return {OO.ui.TextInputWidget} Query input
6597 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
6602 * Get the search results menu.
6604 * @return {OO.ui.SelectWidget} Menu of search results
6606 OO
.ui
.SearchWidget
.prototype.getResults = function () {
6607 return this.results
;
6611 * NumberInputWidgets combine a {@link OO.ui.TextInputWidget text input} (where a value
6612 * can be entered manually) and two {@link OO.ui.ButtonWidget button widgets}
6613 * (to adjust the value in increments) to allow the user to enter a number.
6616 * // Example: A NumberInputWidget.
6617 * var numberInput = new OO.ui.NumberInputWidget( {
6618 * label: 'NumberInputWidget',
6619 * input: { value: 5 },
6623 * $( 'body' ).append( numberInput.$element );
6626 * @extends OO.ui.TextInputWidget
6629 * @param {Object} [config] Configuration options
6630 * @cfg {Object} [minusButton] Configuration options to pass to the {@link OO.ui.ButtonWidget decrementing button widget}.
6631 * @cfg {Object} [plusButton] Configuration options to pass to the {@link OO.ui.ButtonWidget incrementing button widget}.
6632 * @cfg {boolean} [allowInteger=false] Whether the field accepts only integer values.
6633 * @cfg {number} [min=-Infinity] Minimum allowed value
6634 * @cfg {number} [max=Infinity] Maximum allowed value
6635 * @cfg {number} [step=1] Delta when using the buttons or up/down arrow keys
6636 * @cfg {number|null} [pageStep] Delta when using the page-up/page-down keys. Defaults to 10 times #step.
6637 * @cfg {boolean} [showButtons=true] Whether to show the plus and minus buttons.
6639 OO
.ui
.NumberInputWidget
= function OoUiNumberInputWidget( config
) {
6640 var $field
= $( '<div>' )
6641 .addClass( 'oo-ui-numberInputWidget-field' );
6643 // Configuration initialization
6644 config
= $.extend( {
6645 allowInteger
: false,
6653 // For backward compatibility
6654 $.extend( config
, config
.input
);
6657 // Parent constructor
6658 OO
.ui
.NumberInputWidget
.parent
.call( this, $.extend( config
, {
6662 if ( config
.showButtons
) {
6663 this.minusButton
= new OO
.ui
.ButtonWidget( $.extend(
6665 disabled
: this.isDisabled(),
6667 classes
: [ 'oo-ui-numberInputWidget-minusButton' ],
6672 this.plusButton
= new OO
.ui
.ButtonWidget( $.extend(
6674 disabled
: this.isDisabled(),
6676 classes
: [ 'oo-ui-numberInputWidget-plusButton' ],
6685 keydown
: this.onKeyDown
.bind( this ),
6686 'wheel mousewheel DOMMouseScroll': this.onWheel
.bind( this )
6688 if ( config
.showButtons
) {
6689 this.plusButton
.connect( this, {
6690 click
: [ 'onButtonClick', +1 ]
6692 this.minusButton
.connect( this, {
6693 click
: [ 'onButtonClick', -1 ]
6698 $field
.append( this.$input
);
6699 if ( config
.showButtons
) {
6701 .prepend( this.minusButton
.$element
)
6702 .append( this.plusButton
.$element
);
6706 this.setAllowInteger( config
.allowInteger
|| config
.isInteger
);
6707 this.setRange( config
.min
, config
.max
);
6708 this.setStep( config
.step
, config
.pageStep
);
6709 // Set the validation method after we set allowInteger and range
6710 // so that it doesn't immediately call setValidityFlag
6711 this.setValidation( this.validateNumber
.bind( this ) );
6714 .addClass( 'oo-ui-numberInputWidget' )
6715 .toggleClass( 'oo-ui-numberInputWidget-buttoned', config
.showButtons
)
6721 OO
.inheritClass( OO
.ui
.NumberInputWidget
, OO
.ui
.TextInputWidget
);
6726 * Set whether only integers are allowed
6728 * @param {boolean} flag
6730 OO
.ui
.NumberInputWidget
.prototype.setAllowInteger = function ( flag
) {
6731 this.allowInteger
= !!flag
;
6732 this.setValidityFlag();
6734 // Backward compatibility
6735 OO
.ui
.NumberInputWidget
.prototype.setIsInteger
= OO
.ui
.NumberInputWidget
.prototype.setAllowInteger
;
6738 * Get whether only integers are allowed
6740 * @return {boolean} Flag value
6742 OO
.ui
.NumberInputWidget
.prototype.getAllowInteger = function () {
6743 return this.allowInteger
;
6745 // Backward compatibility
6746 OO
.ui
.NumberInputWidget
.prototype.getIsInteger
= OO
.ui
.NumberInputWidget
.prototype.getAllowInteger
;
6749 * Set the range of allowed values
6751 * @param {number} min Minimum allowed value
6752 * @param {number} max Maximum allowed value
6754 OO
.ui
.NumberInputWidget
.prototype.setRange = function ( min
, max
) {
6756 throw new Error( 'Minimum (' + min
+ ') must not be greater than maximum (' + max
+ ')' );
6760 this.setValidityFlag();
6764 * Get the current range
6766 * @return {number[]} Minimum and maximum values
6768 OO
.ui
.NumberInputWidget
.prototype.getRange = function () {
6769 return [ this.min
, this.max
];
6773 * Set the stepping deltas
6775 * @param {number} step Normal step
6776 * @param {number|null} pageStep Page step. If null, 10 * step will be used.
6778 OO
.ui
.NumberInputWidget
.prototype.setStep = function ( step
, pageStep
) {
6780 throw new Error( 'Step value must be positive' );
6782 if ( pageStep
=== null ) {
6783 pageStep
= step
* 10;
6784 } else if ( pageStep
<= 0 ) {
6785 throw new Error( 'Page step value must be positive' );
6788 this.pageStep
= pageStep
;
6792 * Get the current stepping values
6794 * @return {number[]} Step and page step
6796 OO
.ui
.NumberInputWidget
.prototype.getStep = function () {
6797 return [ this.step
, this.pageStep
];
6801 * Get the current value of the widget as a number
6803 * @return {number} May be NaN, or an invalid number
6805 OO
.ui
.NumberInputWidget
.prototype.getNumericValue = function () {
6806 return +this.getValue();
6810 * Adjust the value of the widget
6812 * @param {number} delta Adjustment amount
6814 OO
.ui
.NumberInputWidget
.prototype.adjustValue = function ( delta
) {
6815 var n
, v
= this.getNumericValue();
6818 if ( isNaN( delta
) || !isFinite( delta
) ) {
6819 throw new Error( 'Delta must be a finite number' );
6826 n
= Math
.max( Math
.min( n
, this.max
), this.min
);
6827 if ( this.allowInteger
) {
6828 n
= Math
.round( n
);
6840 * @param {string} value Field value
6843 OO
.ui
.NumberInputWidget
.prototype.validateNumber = function ( value
) {
6845 if ( value
=== '' ) {
6846 return !this.isRequired();
6849 if ( isNaN( n
) || !isFinite( n
) ) {
6853 if ( this.allowInteger
&& Math
.floor( n
) !== n
) {
6857 if ( n
< this.min
|| n
> this.max
) {
6865 * Handle mouse click events.
6868 * @param {number} dir +1 or -1
6870 OO
.ui
.NumberInputWidget
.prototype.onButtonClick = function ( dir
) {
6871 this.adjustValue( dir
* this.step
);
6875 * Handle mouse wheel events.
6878 * @param {jQuery.Event} event
6880 OO
.ui
.NumberInputWidget
.prototype.onWheel = function ( event
) {
6883 if ( !this.isDisabled() && this.$input
.is( ':focus' ) ) {
6884 // Standard 'wheel' event
6885 if ( event
.originalEvent
.deltaMode
!== undefined ) {
6886 this.sawWheelEvent
= true;
6888 if ( event
.originalEvent
.deltaY
) {
6889 delta
= -event
.originalEvent
.deltaY
;
6890 } else if ( event
.originalEvent
.deltaX
) {
6891 delta
= event
.originalEvent
.deltaX
;
6894 // Non-standard events
6895 if ( !this.sawWheelEvent
) {
6896 if ( event
.originalEvent
.wheelDeltaX
) {
6897 delta
= -event
.originalEvent
.wheelDeltaX
;
6898 } else if ( event
.originalEvent
.wheelDeltaY
) {
6899 delta
= event
.originalEvent
.wheelDeltaY
;
6900 } else if ( event
.originalEvent
.wheelDelta
) {
6901 delta
= event
.originalEvent
.wheelDelta
;
6902 } else if ( event
.originalEvent
.detail
) {
6903 delta
= -event
.originalEvent
.detail
;
6908 delta
= delta
< 0 ? -1 : 1;
6909 this.adjustValue( delta
* this.step
);
6917 * Handle key down events.
6920 * @param {jQuery.Event} e Key down event
6922 OO
.ui
.NumberInputWidget
.prototype.onKeyDown = function ( e
) {
6923 if ( !this.isDisabled() ) {
6924 switch ( e
.which
) {
6926 this.adjustValue( this.step
);
6928 case OO
.ui
.Keys
.DOWN
:
6929 this.adjustValue( -this.step
);
6931 case OO
.ui
.Keys
.PAGEUP
:
6932 this.adjustValue( this.pageStep
);
6934 case OO
.ui
.Keys
.PAGEDOWN
:
6935 this.adjustValue( -this.pageStep
);
6944 OO
.ui
.NumberInputWidget
.prototype.setDisabled = function ( disabled
) {
6946 OO
.ui
.NumberInputWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
6948 if ( this.minusButton
) {
6949 this.minusButton
.setDisabled( this.isDisabled() );
6951 if ( this.plusButton
) {
6952 this.plusButton
.setDisabled( this.isDisabled() );
6960 //# sourceMappingURL=oojs-ui-widgets.js.map