3 * https://www.mediawiki.org/wiki/OOjs_UI
5 * Copyright 2011–2016 OOjs UI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
9 * Date: 2016-11-09T00:52:37Z
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
28 OO
.ui
.mixin
.DraggableElement
= function OoUiMixinDraggableElement( config
) {
29 config
= config
|| {};
33 this.$handle
= config
.$handle
|| this.$element
;
34 this.wasHandleUsed
= null;
36 // Initialize and events
37 this.$element
.addClass( 'oo-ui-draggableElement' )
38 // We make the entire element draggable, not just the handle, so that
39 // the whole element appears to move. wasHandleUsed prevents drags from
40 // starting outside the handle
41 .attr( 'draggable', true )
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' );
52 OO
.initClass( OO
.ui
.mixin
.DraggableElement
);
59 * A dragstart event is emitted when the user clicks and begins dragging an item.
60 * @param {OO.ui.mixin.DraggableElement} item The item the user has clicked and is dragging with the mouse.
65 * A dragend event is emitted when the user drags an item and releases the mouse,
66 * thus terminating the drag operation.
71 * A drop event is emitted when the user drags an item and then releases the mouse button
72 * over a valid target.
75 /* Static Properties */
78 * @inheritdoc OO.ui.mixin.ButtonElement
80 OO
.ui
.mixin
.DraggableElement
.static.cancelButtonMouseDownEvents
= false;
85 * Respond to mousedown event.
88 * @param {jQuery.Event} e Drag event
90 OO
.ui
.mixin
.DraggableElement
.prototype.onDragMouseDown = function ( e
) {
92 // Optimization: if the handle is the whole element this is always true
93 this.$handle
[ 0 ] === this.$element
[ 0 ] ||
94 // Check the mousedown occurred inside the handle
95 OO
.ui
.contains( this.$handle
[ 0 ], e
.target
, true );
99 * Respond to dragstart event.
102 * @param {jQuery.Event} e Drag event
103 * @return {boolean} False if the event is cancelled
106 OO
.ui
.mixin
.DraggableElement
.prototype.onDragStart = function ( e
) {
108 dataTransfer
= e
.originalEvent
.dataTransfer
;
110 if ( !this.wasHandleUsed
) {
114 // Define drop effect
115 dataTransfer
.dropEffect
= 'none';
116 dataTransfer
.effectAllowed
= 'move';
118 // We must set up a dataTransfer data property or Firefox seems to
119 // ignore the fact the element is draggable.
121 dataTransfer
.setData( 'application-x/OOjs-UI-draggable', this.getIndex() );
123 // The above is only for Firefox. Move on if it fails.
125 // Briefly add a 'clone' class to style the browser's native drag image
126 this.$element
.addClass( 'oo-ui-draggableElement-clone' );
127 // Add placeholder class after the browser has rendered the clone
128 setTimeout( function () {
130 .removeClass( 'oo-ui-draggableElement-clone' )
131 .addClass( 'oo-ui-draggableElement-placeholder' );
134 this.emit( 'dragstart', this );
139 * Respond to dragend event.
144 OO
.ui
.mixin
.DraggableElement
.prototype.onDragEnd = function () {
145 this.$element
.removeClass( 'oo-ui-draggableElement-placeholder' );
146 this.emit( 'dragend' );
153 * @param {jQuery.Event} e Drop event
156 OO
.ui
.mixin
.DraggableElement
.prototype.onDrop = function ( e
) {
158 this.emit( 'drop', e
);
162 * In order for drag/drop to work, the dragover event must
163 * return false and stop propogation.
165 * @param {jQuery.Event} e Drag event
168 OO
.ui
.mixin
.DraggableElement
.prototype.onDragOver = function ( e
) {
174 * Store it in the DOM so we can access from the widget drag event
177 * @param {number} index Item index
179 OO
.ui
.mixin
.DraggableElement
.prototype.setIndex = function ( index
) {
180 if ( this.index
!== index
) {
182 this.$element
.data( 'index', index
);
190 * @return {number} Item index
192 OO
.ui
.mixin
.DraggableElement
.prototype.getIndex = function () {
197 * DraggableGroupElement is a mixin class used to create a group element to
198 * contain draggable elements, which are items that can be clicked and dragged by a mouse.
199 * The class is used with OO.ui.mixin.DraggableElement.
203 * @mixins OO.ui.mixin.GroupElement
206 * @param {Object} [config] Configuration options
207 * @cfg {string} [orientation] Item orientation: 'horizontal' or 'vertical'. The orientation
208 * should match the layout of the items. Items displayed in a single row
209 * or in several rows should use horizontal orientation. The vertical orientation should only be
210 * used when the items are displayed in a single column. Defaults to 'vertical'
212 OO
.ui
.mixin
.DraggableGroupElement
= function OoUiMixinDraggableGroupElement( config
) {
213 // Configuration initialization
214 config
= config
|| {};
216 // Parent constructor
217 OO
.ui
.mixin
.GroupElement
.call( this, config
);
220 this.orientation
= config
.orientation
|| 'vertical';
221 this.dragItem
= null;
224 this.itemsOrder
= null;
228 dragstart
: 'itemDragStart',
229 dragend
: 'itemDragEnd',
232 this.connect( this, {
233 itemDragStart
: 'onItemDragStart',
234 itemDrop
: 'onItemDropOrDragEnd',
235 itemDragEnd
: 'onItemDropOrDragEnd'
239 if ( Array
.isArray( config
.items
) ) {
240 this.addItems( config
.items
);
243 .addClass( 'oo-ui-draggableGroupElement' )
244 .append( this.$status
)
245 .toggleClass( 'oo-ui-draggableGroupElement-horizontal', this.orientation
=== 'horizontal' );
249 OO
.mixinClass( OO
.ui
.mixin
.DraggableGroupElement
, OO
.ui
.mixin
.GroupElement
);
254 * An item has been dragged to a new position, but not yet dropped.
257 * @param {OO.ui.mixin.DraggableElement} item Dragged item
258 * @param {number} [newIndex] New index for the item
262 * And item has been dropped at a new position.
265 * @param {OO.ui.mixin.DraggableElement} item Reordered item
266 * @param {number} [newIndex] New index for the item
272 * Respond to item drag start event
275 * @param {OO.ui.mixin.DraggableElement} item Dragged item
277 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onItemDragStart = function ( item
) {
278 // Make a shallow copy of this.items so we can re-order it during previews
279 // without affecting the original array.
280 this.itemsOrder
= this.items
.slice();
281 this.updateIndexes();
282 if ( this.orientation
=== 'horizontal' ) {
283 // Calculate and cache directionality on drag start - it's a little
284 // expensive and it shouldn't change while dragging.
285 this.dir
= this.$element
.css( 'direction' );
287 this.setDragItem( item
);
291 * Update the index properties of the items
293 OO
.ui
.mixin
.DraggableGroupElement
.prototype.updateIndexes = function () {
296 // Map the index of each object
297 for ( i
= 0, len
= this.itemsOrder
.length
; i
< len
; i
++ ) {
298 this.itemsOrder
[ i
].setIndex( i
);
303 * Handle drop or dragend event and switch the order of the items accordingly
306 * @param {OO.ui.mixin.DraggableElement} item Dropped item
308 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onItemDropOrDragEnd = function () {
309 var targetIndex
, originalIndex
,
310 item
= this.getDragItem();
312 // TODO: Figure out a way to configure a list of legally droppable
313 // elements even if they are not yet in the list
315 originalIndex
= this.items
.indexOf( item
);
316 // If the item has moved forward, add one to the index to account for the left shift
317 targetIndex
= item
.getIndex() + ( item
.getIndex() > originalIndex
? 1 : 0 );
318 if ( targetIndex
!== originalIndex
) {
319 this.reorder( this.getDragItem(), targetIndex
);
320 this.emit( 'reorder', this.getDragItem(), targetIndex
);
322 this.updateIndexes();
324 this.unsetDragItem();
325 // Return false to prevent propogation
330 * Respond to dragover event
333 * @param {jQuery.Event} e Dragover event
336 OO
.ui
.mixin
.DraggableGroupElement
.prototype.onDragOver = function ( e
) {
337 var overIndex
, targetIndex
,
338 item
= this.getDragItem(),
339 dragItemIndex
= item
.getIndex();
341 // Get the OptionWidget item we are dragging over
342 overIndex
= $( e
.target
).closest( '.oo-ui-draggableElement' ).data( 'index' );
344 if ( overIndex
!== undefined && overIndex
!== dragItemIndex
) {
345 targetIndex
= overIndex
+ ( overIndex
> dragItemIndex
? 1 : 0 );
347 if ( targetIndex
> 0 ) {
348 this.$group
.children().eq( targetIndex
- 1 ).after( item
.$element
);
350 this.$group
.prepend( item
.$element
);
352 // Move item in itemsOrder array
353 this.itemsOrder
.splice( overIndex
, 0,
354 this.itemsOrder
.splice( dragItemIndex
, 1 )[ 0 ]
356 this.updateIndexes();
357 this.emit( 'drag', item
, targetIndex
);
364 * Reorder the items in the group
366 * @param {OO.ui.mixin.DraggableElement} item Reordered item
367 * @param {number} newIndex New index
369 OO
.ui
.mixin
.DraggableGroupElement
.prototype.reorder = function ( item
, newIndex
) {
370 this.addItems( [ item
], newIndex
);
376 * @param {OO.ui.mixin.DraggableElement} item Dragged item
378 OO
.ui
.mixin
.DraggableGroupElement
.prototype.setDragItem = function ( item
) {
379 if ( this.dragItem
!== item
) {
380 this.dragItem
= item
;
381 this.$element
.on( 'dragover', this.onDragOver
.bind( this ) );
382 this.$element
.addClass( 'oo-ui-draggableGroupElement-dragging' );
387 * Unset the current dragged item
389 OO
.ui
.mixin
.DraggableGroupElement
.prototype.unsetDragItem = function () {
390 if ( this.dragItem
) {
391 this.dragItem
= null;
392 this.$element
.off( 'dragover' );
393 this.$element
.removeClass( 'oo-ui-draggableGroupElement-dragging' );
398 * Get the item that is currently being dragged.
400 * @return {OO.ui.mixin.DraggableElement|null} The currently dragged item, or `null` if no item is being dragged
402 OO
.ui
.mixin
.DraggableGroupElement
.prototype.getDragItem = function () {
403 return this.dragItem
;
407 * RequestManager is a mixin that manages the lifecycle of a promise-backed request for a widget, such as
408 * the {@link OO.ui.mixin.LookupElement}.
415 OO
.ui
.mixin
.RequestManager
= function OoUiMixinRequestManager() {
416 this.requestCache
= {};
417 this.requestQuery
= null;
418 this.requestRequest
= null;
423 OO
.initClass( OO
.ui
.mixin
.RequestManager
);
426 * Get request results for the current query.
428 * @return {jQuery.Promise} Promise object which will be passed response data as the first argument of
429 * the done event. If the request was aborted to make way for a subsequent request, this promise
430 * may not be rejected, depending on what jQuery feels like doing.
432 OO
.ui
.mixin
.RequestManager
.prototype.getRequestData = function () {
434 value
= this.getRequestQuery(),
435 deferred
= $.Deferred(),
439 if ( Object
.prototype.hasOwnProperty
.call( this.requestCache
, value
) ) {
440 deferred
.resolve( this.requestCache
[ value
] );
442 if ( this.pushPending
) {
445 this.requestQuery
= value
;
446 ourRequest
= this.requestRequest
= this.getRequest();
448 .always( function () {
449 // We need to pop pending even if this is an old request, otherwise
450 // the widget will remain pending forever.
451 // TODO: this assumes that an aborted request will fail or succeed soon after
452 // being aborted, or at least eventually. It would be nice if we could popPending()
453 // at abort time, but only if we knew that we hadn't already called popPending()
455 if ( widget
.popPending
) {
459 .done( function ( response
) {
460 // If this is an old request (and aborting it somehow caused it to still succeed),
461 // ignore its success completely
462 if ( ourRequest
=== widget
.requestRequest
) {
463 widget
.requestQuery
= null;
464 widget
.requestRequest
= null;
465 widget
.requestCache
[ value
] = widget
.getRequestCacheDataFromResponse( response
);
466 deferred
.resolve( widget
.requestCache
[ value
] );
470 // If this is an old request (or a request failing because it's being aborted),
471 // ignore its failure completely
472 if ( ourRequest
=== widget
.requestRequest
) {
473 widget
.requestQuery
= null;
474 widget
.requestRequest
= null;
479 return deferred
.promise();
483 * Abort the currently pending request, if any.
487 OO
.ui
.mixin
.RequestManager
.prototype.abortRequest = function () {
488 var oldRequest
= this.requestRequest
;
490 // First unset this.requestRequest to the fail handler will notice
491 // that the request is no longer current
492 this.requestRequest
= null;
493 this.requestQuery
= null;
499 * Get the query to be made.
504 * @return {string} query to be used
506 OO
.ui
.mixin
.RequestManager
.prototype.getRequestQuery
= null;
509 * Get a new request object of the current query value.
514 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
516 OO
.ui
.mixin
.RequestManager
.prototype.getRequest
= null;
519 * Pre-process data returned by the request from #getRequest.
521 * The return value of this function will be cached, and any further queries for the given value
522 * will use the cache rather than doing API requests.
527 * @param {Mixed} response Response from server
528 * @return {Mixed} Cached result data
530 OO
.ui
.mixin
.RequestManager
.prototype.getRequestCacheDataFromResponse
= null;
533 * LookupElement is a mixin that creates a {@link OO.ui.FloatingMenuSelectWidget menu} of suggested values for
534 * a {@link OO.ui.TextInputWidget text input widget}. Suggested values are based on the characters the user types
535 * into the text input field and, in general, the menu is only displayed when the user types. If a suggested value is chosen
536 * from the lookup menu, that value becomes the value of the input field.
538 * Note that a new menu of suggested items is displayed when a value is chosen from the lookup menu. If this is
539 * not the desired behavior, disable lookup menus with the #setLookupsDisabled method, then set the value, then
542 * See the [OOjs UI demos][1] for an example.
544 * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/index.html#widgets-apex-vector-ltr
548 * @mixins OO.ui.mixin.RequestManager
551 * @param {Object} [config] Configuration options
552 * @cfg {jQuery} [$overlay] Overlay for the lookup menu; defaults to relative positioning
553 * @cfg {jQuery} [$container=this.$element] The container element. The lookup menu is rendered beneath the specified element.
554 * @cfg {boolean} [allowSuggestionsWhenEmpty=false] Request and display a lookup menu when the text input is empty.
555 * By default, the lookup menu is not generated and displayed until the user begins to type.
556 * @cfg {boolean} [highlightFirst=true] Whether the first lookup result should be highlighted (so, that the user can
557 * take it over into the input with simply pressing return) automatically or not.
559 OO
.ui
.mixin
.LookupElement
= function OoUiMixinLookupElement( config
) {
560 // Configuration initialization
561 config
= $.extend( { highlightFirst
: true }, config
);
563 // Mixin constructors
564 OO
.ui
.mixin
.RequestManager
.call( this, config
);
567 this.$overlay
= config
.$overlay
|| this.$element
;
568 this.lookupMenu
= new OO
.ui
.FloatingMenuSelectWidget( {
571 $container
: config
.$container
|| this.$element
574 this.allowSuggestionsWhenEmpty
= config
.allowSuggestionsWhenEmpty
|| false;
576 this.lookupsDisabled
= false;
577 this.lookupInputFocused
= false;
578 this.lookupHighlightFirstItem
= config
.highlightFirst
;
582 focus
: this.onLookupInputFocus
.bind( this ),
583 blur
: this.onLookupInputBlur
.bind( this ),
584 mousedown
: this.onLookupInputMouseDown
.bind( this )
586 this.connect( this, { change
: 'onLookupInputChange' } );
587 this.lookupMenu
.connect( this, {
588 toggle
: 'onLookupMenuToggle',
589 choose
: 'onLookupMenuItemChoose'
593 this.$element
.addClass( 'oo-ui-lookupElement' );
594 this.lookupMenu
.$element
.addClass( 'oo-ui-lookupElement-menu' );
595 this.$overlay
.append( this.lookupMenu
.$element
);
600 OO
.mixinClass( OO
.ui
.mixin
.LookupElement
, OO
.ui
.mixin
.RequestManager
);
605 * Handle input focus event.
608 * @param {jQuery.Event} e Input focus event
610 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputFocus = function () {
611 this.lookupInputFocused
= true;
612 this.populateLookupMenu();
616 * Handle input blur event.
619 * @param {jQuery.Event} e Input blur event
621 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputBlur = function () {
622 this.closeLookupMenu();
623 this.lookupInputFocused
= false;
627 * Handle input mouse down event.
630 * @param {jQuery.Event} e Input mouse down event
632 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputMouseDown = function () {
633 // Only open the menu if the input was already focused.
634 // This way we allow the user to open the menu again after closing it with Esc
635 // by clicking in the input. Opening (and populating) the menu when initially
636 // clicking into the input is handled by the focus handler.
637 if ( this.lookupInputFocused
&& !this.lookupMenu
.isVisible() ) {
638 this.populateLookupMenu();
643 * Handle input change event.
646 * @param {string} value New input value
648 OO
.ui
.mixin
.LookupElement
.prototype.onLookupInputChange = function () {
649 if ( this.lookupInputFocused
) {
650 this.populateLookupMenu();
655 * Handle the lookup menu being shown/hidden.
658 * @param {boolean} visible Whether the lookup menu is now visible.
660 OO
.ui
.mixin
.LookupElement
.prototype.onLookupMenuToggle = function ( visible
) {
662 // When the menu is hidden, abort any active request and clear the menu.
663 // This has to be done here in addition to closeLookupMenu(), because
664 // MenuSelectWidget will close itself when the user presses Esc.
665 this.abortLookupRequest();
666 this.lookupMenu
.clearItems();
671 * Handle menu item 'choose' event, updating the text input value to the value of the clicked item.
674 * @param {OO.ui.MenuOptionWidget} item Selected item
676 OO
.ui
.mixin
.LookupElement
.prototype.onLookupMenuItemChoose = function ( item
) {
677 this.setValue( item
.getData() );
684 * @return {OO.ui.FloatingMenuSelectWidget}
686 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenu = function () {
687 return this.lookupMenu
;
691 * Disable or re-enable lookups.
693 * When lookups are disabled, calls to #populateLookupMenu will be ignored.
695 * @param {boolean} disabled Disable lookups
697 OO
.ui
.mixin
.LookupElement
.prototype.setLookupsDisabled = function ( disabled
) {
698 this.lookupsDisabled
= !!disabled
;
702 * Open the menu. If there are no entries in the menu, this does nothing.
707 OO
.ui
.mixin
.LookupElement
.prototype.openLookupMenu = function () {
708 if ( !this.lookupMenu
.isEmpty() ) {
709 this.lookupMenu
.toggle( true );
715 * Close the menu, empty it, and abort any pending request.
720 OO
.ui
.mixin
.LookupElement
.prototype.closeLookupMenu = function () {
721 this.lookupMenu
.toggle( false );
722 this.abortLookupRequest();
723 this.lookupMenu
.clearItems();
728 * Request menu items based on the input's current value, and when they arrive,
729 * populate the menu with these items and show the menu.
731 * If lookups have been disabled with #setLookupsDisabled, this function does nothing.
736 OO
.ui
.mixin
.LookupElement
.prototype.populateLookupMenu = function () {
738 value
= this.getValue();
740 if ( this.lookupsDisabled
|| this.isReadOnly() ) {
744 // If the input is empty, clear the menu, unless suggestions when empty are allowed.
745 if ( !this.allowSuggestionsWhenEmpty
&& value
=== '' ) {
746 this.closeLookupMenu();
747 // Skip population if there is already a request pending for the current value
748 } else if ( value
!== this.lookupQuery
) {
749 this.getLookupMenuItems()
750 .done( function ( items
) {
751 widget
.lookupMenu
.clearItems();
752 if ( items
.length
) {
756 widget
.initializeLookupMenuSelection();
758 widget
.lookupMenu
.toggle( false );
762 widget
.lookupMenu
.clearItems();
770 * Highlight the first selectable item in the menu, if configured.
775 OO
.ui
.mixin
.LookupElement
.prototype.initializeLookupMenuSelection = function () {
776 if ( this.lookupHighlightFirstItem
&& !this.lookupMenu
.getSelectedItem() ) {
777 this.lookupMenu
.highlightItem( this.lookupMenu
.getFirstSelectableItem() );
782 * Get lookup menu items for the current query.
785 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument of
786 * the done event. If the request was aborted to make way for a subsequent request, this promise
787 * will not be rejected: it will remain pending forever.
789 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenuItems = function () {
790 return this.getRequestData().then( function ( data
) {
791 return this.getLookupMenuOptionsFromData( data
);
796 * Abort the currently pending lookup request, if any.
800 OO
.ui
.mixin
.LookupElement
.prototype.abortLookupRequest = function () {
805 * Get a new request object of the current lookup query value.
810 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
812 OO
.ui
.mixin
.LookupElement
.prototype.getLookupRequest
= null;
815 * Pre-process data returned by the request from #getLookupRequest.
817 * The return value of this function will be cached, and any further queries for the given value
818 * will use the cache rather than doing API requests.
823 * @param {Mixed} response Response from server
824 * @return {Mixed} Cached result data
826 OO
.ui
.mixin
.LookupElement
.prototype.getLookupCacheDataFromResponse
= null;
829 * Get a list of menu option widgets from the (possibly cached) data returned by
830 * #getLookupCacheDataFromResponse.
835 * @param {Mixed} data Cached result data, usually an array
836 * @return {OO.ui.MenuOptionWidget[]} Menu items
838 OO
.ui
.mixin
.LookupElement
.prototype.getLookupMenuOptionsFromData
= null;
841 * Set the read-only state of the widget.
843 * This will also disable/enable the lookups functionality.
845 * @param {boolean} readOnly Make input read-only
848 OO
.ui
.mixin
.LookupElement
.prototype.setReadOnly = function ( readOnly
) {
850 // Note: Calling #setReadOnly this way assumes this is mixed into an OO.ui.TextInputWidget
851 OO
.ui
.TextInputWidget
.prototype.setReadOnly
.call( this, readOnly
);
853 // During construction, #setReadOnly is called before the OO.ui.mixin.LookupElement constructor
854 if ( this.isReadOnly() && this.lookupMenu
) {
855 this.closeLookupMenu();
862 * @inheritdoc OO.ui.mixin.RequestManager
864 OO
.ui
.mixin
.LookupElement
.prototype.getRequestQuery = function () {
865 return this.getValue();
869 * @inheritdoc OO.ui.mixin.RequestManager
871 OO
.ui
.mixin
.LookupElement
.prototype.getRequest = function () {
872 return this.getLookupRequest();
876 * @inheritdoc OO.ui.mixin.RequestManager
878 OO
.ui
.mixin
.LookupElement
.prototype.getRequestCacheDataFromResponse = function ( response
) {
879 return this.getLookupCacheDataFromResponse( response
);
883 * CardLayouts are used within {@link OO.ui.IndexLayout index layouts} to create cards that users can select and display
884 * from the index's optional {@link OO.ui.TabSelectWidget tab} navigation. Cards are usually not instantiated directly,
885 * rather extended to include the required content and functionality.
887 * Each card must have a unique symbolic name, which is passed to the constructor. In addition, the card's tab
888 * item is customized (with a label) using the #setupTabItem method. See
889 * {@link OO.ui.IndexLayout IndexLayout} for an example.
892 * @extends OO.ui.PanelLayout
895 * @param {string} name Unique symbolic name of card
896 * @param {Object} [config] Configuration options
897 * @cfg {jQuery|string|Function|OO.ui.HtmlSnippet} [label] Label for card's tab
899 OO
.ui
.CardLayout
= function OoUiCardLayout( name
, config
) {
900 // Allow passing positional parameters inside the config object
901 if ( OO
.isPlainObject( name
) && config
=== undefined ) {
906 // Configuration initialization
907 config
= $.extend( { scrollable
: true }, config
);
909 // Parent constructor
910 OO
.ui
.CardLayout
.parent
.call( this, config
);
914 this.label
= config
.label
;
919 this.$element
.addClass( 'oo-ui-cardLayout' );
924 OO
.inheritClass( OO
.ui
.CardLayout
, OO
.ui
.PanelLayout
);
929 * An 'active' event is emitted when the card becomes active. Cards become active when they are
930 * shown in a index layout that is configured to display only one card at a time.
933 * @param {boolean} active Card is active
939 * Get the symbolic name of the card.
941 * @return {string} Symbolic name of card
943 OO
.ui
.CardLayout
.prototype.getName = function () {
948 * Check if card is active.
950 * Cards become active when they are shown in a {@link OO.ui.IndexLayout index layout} that is configured to display
951 * only one card at a time. Additional CSS is applied to the card's tab item to reflect the active state.
953 * @return {boolean} Card is active
955 OO
.ui
.CardLayout
.prototype.isActive = function () {
962 * The tab item allows users to access the card from the index's tab
963 * navigation. The tab item itself can be customized (with a label, level, etc.) using the #setupTabItem method.
965 * @return {OO.ui.TabOptionWidget|null} Tab option widget
967 OO
.ui
.CardLayout
.prototype.getTabItem = function () {
972 * Set or unset the tab item.
974 * Specify a {@link OO.ui.TabOptionWidget tab option} to set it,
975 * or `null` to clear the tab item. To customize the tab item itself (e.g., to set a label or tab
976 * level), use #setupTabItem instead of this method.
978 * @param {OO.ui.TabOptionWidget|null} tabItem Tab option widget, null to clear
981 OO
.ui
.CardLayout
.prototype.setTabItem = function ( tabItem
) {
982 this.tabItem
= tabItem
|| null;
990 * Set up the tab item.
992 * Use this method to customize the tab item (e.g., to add a label or tab level). To set or unset
993 * the tab item itself (with a {@link OO.ui.TabOptionWidget tab option} or `null`), use
994 * the #setTabItem method instead.
996 * @param {OO.ui.TabOptionWidget} tabItem Tab option widget to set up
999 OO
.ui
.CardLayout
.prototype.setupTabItem = function () {
1001 this.tabItem
.setLabel( this.label
);
1007 * Set the card to its 'active' state.
1009 * Cards become active when they are shown in a index layout that is configured to display only one card at a time. Additional
1010 * CSS is applied to the tab item to reflect the card's active state. Outside of the index
1011 * context, setting the active state on a card does nothing.
1013 * @param {boolean} active Card is active
1016 OO
.ui
.CardLayout
.prototype.setActive = function ( active
) {
1019 if ( active
!== this.active
) {
1020 this.active
= active
;
1021 this.$element
.toggleClass( 'oo-ui-cardLayout-active', this.active
);
1022 this.emit( 'active', this.active
);
1027 * PageLayouts are used within {@link OO.ui.BookletLayout booklet layouts} to create pages that users can select and display
1028 * from the booklet's optional {@link OO.ui.OutlineSelectWidget outline} navigation. Pages are usually not instantiated directly,
1029 * rather extended to include the required content and functionality.
1031 * Each page must have a unique symbolic name, which is passed to the constructor. In addition, the page's outline
1032 * item is customized (with a label, outline level, etc.) using the #setupOutlineItem method. See
1033 * {@link OO.ui.BookletLayout BookletLayout} for an example.
1036 * @extends OO.ui.PanelLayout
1039 * @param {string} name Unique symbolic name of page
1040 * @param {Object} [config] Configuration options
1042 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
1043 // Allow passing positional parameters inside the config object
1044 if ( OO
.isPlainObject( name
) && config
=== undefined ) {
1049 // Configuration initialization
1050 config
= $.extend( { scrollable
: true }, config
);
1052 // Parent constructor
1053 OO
.ui
.PageLayout
.parent
.call( this, config
);
1057 this.outlineItem
= null;
1058 this.active
= false;
1061 this.$element
.addClass( 'oo-ui-pageLayout' );
1066 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
1071 * An 'active' event is emitted when the page becomes active. Pages become active when they are
1072 * shown in a booklet layout that is configured to display only one page at a time.
1075 * @param {boolean} active Page is active
1081 * Get the symbolic name of the page.
1083 * @return {string} Symbolic name of page
1085 OO
.ui
.PageLayout
.prototype.getName = function () {
1090 * Check if page is active.
1092 * Pages become active when they are shown in a {@link OO.ui.BookletLayout booklet layout} that is configured to display
1093 * only one page at a time. Additional CSS is applied to the page's outline item to reflect the active state.
1095 * @return {boolean} Page is active
1097 OO
.ui
.PageLayout
.prototype.isActive = function () {
1104 * The outline item allows users to access the page from the booklet's outline
1105 * navigation. The outline item itself can be customized (with a label, level, etc.) using the #setupOutlineItem method.
1107 * @return {OO.ui.OutlineOptionWidget|null} Outline option widget
1109 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
1110 return this.outlineItem
;
1114 * Set or unset the outline item.
1116 * Specify an {@link OO.ui.OutlineOptionWidget outline option} to set it,
1117 * or `null` to clear the outline item. To customize the outline item itself (e.g., to set a label or outline
1118 * level), use #setupOutlineItem instead of this method.
1120 * @param {OO.ui.OutlineOptionWidget|null} outlineItem Outline option widget, null to clear
1123 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
1124 this.outlineItem
= outlineItem
|| null;
1125 if ( outlineItem
) {
1126 this.setupOutlineItem();
1132 * Set up the outline item.
1134 * Use this method to customize the outline item (e.g., to add a label or outline level). To set or unset
1135 * the outline item itself (with an {@link OO.ui.OutlineOptionWidget outline option} or `null`), use
1136 * the #setOutlineItem method instead.
1138 * @param {OO.ui.OutlineOptionWidget} outlineItem Outline option widget to set up
1141 OO
.ui
.PageLayout
.prototype.setupOutlineItem = function () {
1146 * Set the page to its 'active' state.
1148 * Pages become active when they are shown in a booklet layout that is configured to display only one page at a time. Additional
1149 * CSS is applied to the outline item to reflect the page's active state. Outside of the booklet
1150 * context, setting the active state on a page does nothing.
1152 * @param {boolean} active Page is active
1155 OO
.ui
.PageLayout
.prototype.setActive = function ( active
) {
1158 if ( active
!== this.active
) {
1159 this.active
= active
;
1160 this.$element
.toggleClass( 'oo-ui-pageLayout-active', active
);
1161 this.emit( 'active', this.active
);
1166 * StackLayouts contain a series of {@link OO.ui.PanelLayout panel layouts}. By default, only one panel is displayed
1167 * at a time, though the stack layout can also be configured to show all contained panels, one after another,
1168 * by setting the #continuous option to 'true'.
1171 * // A stack layout with two panels, configured to be displayed continously
1172 * var myStack = new OO.ui.StackLayout( {
1174 * new OO.ui.PanelLayout( {
1175 * $content: $( '<p>Panel One</p>' ),
1179 * new OO.ui.PanelLayout( {
1180 * $content: $( '<p>Panel Two</p>' ),
1187 * $( 'body' ).append( myStack.$element );
1190 * @extends OO.ui.PanelLayout
1191 * @mixins OO.ui.mixin.GroupElement
1194 * @param {Object} [config] Configuration options
1195 * @cfg {boolean} [continuous=false] Show all panels, one after another. By default, only one panel is displayed at a time.
1196 * @cfg {OO.ui.Layout[]} [items] Panel layouts to add to the stack layout.
1198 OO
.ui
.StackLayout
= function OoUiStackLayout( config
) {
1199 // Configuration initialization
1200 config
= $.extend( { scrollable
: true }, config
);
1202 // Parent constructor
1203 OO
.ui
.StackLayout
.parent
.call( this, config
);
1205 // Mixin constructors
1206 OO
.ui
.mixin
.GroupElement
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
1209 this.currentItem
= null;
1210 this.continuous
= !!config
.continuous
;
1213 this.$element
.addClass( 'oo-ui-stackLayout' );
1214 if ( this.continuous
) {
1215 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
1216 this.$element
.on( 'scroll', OO
.ui
.debounce( this.onScroll
.bind( this ), 250 ) );
1218 if ( Array
.isArray( config
.items
) ) {
1219 this.addItems( config
.items
);
1225 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
1226 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.mixin
.GroupElement
);
1231 * A 'set' event is emitted when panels are {@link #addItems added}, {@link #removeItems removed},
1232 * {@link #clearItems cleared} or {@link #setItem displayed}.
1235 * @param {OO.ui.Layout|null} item Current panel or `null` if no panel is shown
1239 * When used in continuous mode, this event is emitted when the user scrolls down
1240 * far enough such that currentItem is no longer visible.
1242 * @event visibleItemChange
1243 * @param {OO.ui.PanelLayout} panel The next visible item in the layout
1249 * Handle scroll events from the layout element
1251 * @param {jQuery.Event} e
1252 * @fires visibleItemChange
1254 OO
.ui
.StackLayout
.prototype.onScroll = function () {
1256 len
= this.items
.length
,
1257 currentIndex
= this.items
.indexOf( this.currentItem
),
1258 newIndex
= currentIndex
,
1259 containerRect
= this.$element
[ 0 ].getBoundingClientRect();
1261 if ( !containerRect
|| ( !containerRect
.top
&& !containerRect
.bottom
) ) {
1262 // Can't get bounding rect, possibly not attached.
1266 function getRect( item
) {
1267 return item
.$element
[ 0 ].getBoundingClientRect();
1270 function isVisible( item
) {
1271 var rect
= getRect( item
);
1272 return rect
.bottom
> containerRect
.top
&& rect
.top
< containerRect
.bottom
;
1275 currentRect
= getRect( this.currentItem
);
1277 if ( currentRect
.bottom
< containerRect
.top
) {
1278 // Scrolled down past current item
1279 while ( ++newIndex
< len
) {
1280 if ( isVisible( this.items
[ newIndex
] ) ) {
1284 } else if ( currentRect
.top
> containerRect
.bottom
) {
1285 // Scrolled up past current item
1286 while ( --newIndex
>= 0 ) {
1287 if ( isVisible( this.items
[ newIndex
] ) ) {
1293 if ( newIndex
!== currentIndex
) {
1294 this.emit( 'visibleItemChange', this.items
[ newIndex
] );
1299 * Get the current panel.
1301 * @return {OO.ui.Layout|null}
1303 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
1304 return this.currentItem
;
1308 * Unset the current item.
1311 * @param {OO.ui.StackLayout} layout
1314 OO
.ui
.StackLayout
.prototype.unsetCurrentItem = function () {
1315 var prevItem
= this.currentItem
;
1316 if ( prevItem
=== null ) {
1320 this.currentItem
= null;
1321 this.emit( 'set', null );
1325 * Add panel layouts to the stack layout.
1327 * Panels will be added to the end of the stack layout array unless the optional index parameter specifies a different
1328 * insertion point. Adding a panel that is already in the stack will move it to the end of the array or the point specified
1331 * @param {OO.ui.Layout[]} items Panels to add
1332 * @param {number} [index] Index of the insertion point
1335 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
1336 // Update the visibility
1337 this.updateHiddenState( items
, this.currentItem
);
1340 OO
.ui
.mixin
.GroupElement
.prototype.addItems
.call( this, items
, index
);
1342 if ( !this.currentItem
&& items
.length
) {
1343 this.setItem( items
[ 0 ] );
1350 * Remove the specified panels from the stack layout.
1352 * Removed panels are detached from the DOM, not removed, so that they may be reused. To remove all panels,
1353 * you may wish to use the #clearItems method instead.
1355 * @param {OO.ui.Layout[]} items Panels to remove
1359 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
1361 OO
.ui
.mixin
.GroupElement
.prototype.removeItems
.call( this, items
);
1363 if ( items
.indexOf( this.currentItem
) !== -1 ) {
1364 if ( this.items
.length
) {
1365 this.setItem( this.items
[ 0 ] );
1367 this.unsetCurrentItem();
1375 * Clear all panels from the stack layout.
1377 * Cleared panels are detached from the DOM, not removed, so that they may be reused. To remove only
1378 * a subset of panels, use the #removeItems method.
1383 OO
.ui
.StackLayout
.prototype.clearItems = function () {
1384 this.unsetCurrentItem();
1385 OO
.ui
.mixin
.GroupElement
.prototype.clearItems
.call( this );
1391 * Show the specified panel.
1393 * If another panel is currently displayed, it will be hidden.
1395 * @param {OO.ui.Layout} item Panel to show
1399 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
1400 if ( item
!== this.currentItem
) {
1401 this.updateHiddenState( this.items
, item
);
1403 if ( this.items
.indexOf( item
) !== -1 ) {
1404 this.currentItem
= item
;
1405 this.emit( 'set', item
);
1407 this.unsetCurrentItem();
1415 * Update the visibility of all items in case of non-continuous view.
1417 * Ensure all items are hidden except for the selected one.
1418 * This method does nothing when the stack is continuous.
1421 * @param {OO.ui.Layout[]} items Item list iterate over
1422 * @param {OO.ui.Layout} [selectedItem] Selected item to show
1424 OO
.ui
.StackLayout
.prototype.updateHiddenState = function ( items
, selectedItem
) {
1427 if ( !this.continuous
) {
1428 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
1429 if ( !selectedItem
|| selectedItem
!== items
[ i
] ) {
1430 items
[ i
].$element
.addClass( 'oo-ui-element-hidden' );
1431 items
[ i
].$element
.attr( 'aria-hidden', 'true' );
1434 if ( selectedItem
) {
1435 selectedItem
.$element
.removeClass( 'oo-ui-element-hidden' );
1436 selectedItem
.$element
.removeAttr( 'aria-hidden' );
1442 * 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)
1443 * and its size is customized with the #menuSize config. The content area will fill all remaining space.
1446 * var menuLayout = new OO.ui.MenuLayout( {
1449 * menuPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1450 * contentPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1451 * select = new OO.ui.SelectWidget( {
1453 * new OO.ui.OptionWidget( {
1457 * new OO.ui.OptionWidget( {
1461 * new OO.ui.OptionWidget( {
1465 * new OO.ui.OptionWidget( {
1470 * } ).on( 'select', function ( item ) {
1471 * menuLayout.setMenuPosition( item.getData() );
1474 * menuLayout.$menu.append(
1475 * menuPanel.$element.append( '<b>Menu panel</b>', select.$element )
1477 * menuLayout.$content.append(
1478 * contentPanel.$element.append( '<b>Content panel</b>', '<p>Note that the menu is positioned relative to the content panel: top, bottom, after, before.</p>')
1480 * $( 'body' ).append( menuLayout.$element );
1482 * If menu size needs to be overridden, it can be accomplished using CSS similar to the snippet
1483 * below. MenuLayout's CSS will override the appropriate values with 'auto' or '0' to display the
1484 * menu correctly. If `menuPosition` is known beforehand, CSS rules corresponding to other positions
1487 * .oo-ui-menuLayout-menu {
1491 * .oo-ui-menuLayout-content {
1499 * @extends OO.ui.Layout
1502 * @param {Object} [config] Configuration options
1503 * @cfg {boolean} [showMenu=true] Show menu
1504 * @cfg {string} [menuPosition='before'] Position of menu: `top`, `after`, `bottom` or `before`
1506 OO
.ui
.MenuLayout
= function OoUiMenuLayout( config
) {
1507 // Configuration initialization
1508 config
= $.extend( {
1510 menuPosition
: 'before'
1513 // Parent constructor
1514 OO
.ui
.MenuLayout
.parent
.call( this, config
);
1519 * @property {jQuery}
1521 this.$menu
= $( '<div>' );
1525 * @property {jQuery}
1527 this.$content
= $( '<div>' );
1531 .addClass( 'oo-ui-menuLayout-menu' );
1532 this.$content
.addClass( 'oo-ui-menuLayout-content' );
1534 .addClass( 'oo-ui-menuLayout' )
1535 .append( this.$content
, this.$menu
);
1536 this.setMenuPosition( config
.menuPosition
);
1537 this.toggleMenu( config
.showMenu
);
1542 OO
.inheritClass( OO
.ui
.MenuLayout
, OO
.ui
.Layout
);
1549 * @param {boolean} showMenu Show menu, omit to toggle
1552 OO
.ui
.MenuLayout
.prototype.toggleMenu = function ( showMenu
) {
1553 showMenu
= showMenu
=== undefined ? !this.showMenu
: !!showMenu
;
1555 if ( this.showMenu
!== showMenu
) {
1556 this.showMenu
= showMenu
;
1558 .toggleClass( 'oo-ui-menuLayout-showMenu', this.showMenu
)
1559 .toggleClass( 'oo-ui-menuLayout-hideMenu', !this.showMenu
);
1560 this.$menu
.attr( 'aria-hidden', this.showMenu
? 'false' : 'true' );
1567 * Check if menu is visible
1569 * @return {boolean} Menu is visible
1571 OO
.ui
.MenuLayout
.prototype.isMenuVisible = function () {
1572 return this.showMenu
;
1576 * Set menu position.
1578 * @param {string} position Position of menu, either `top`, `after`, `bottom` or `before`
1579 * @throws {Error} If position value is not supported
1582 OO
.ui
.MenuLayout
.prototype.setMenuPosition = function ( position
) {
1583 this.$element
.removeClass( 'oo-ui-menuLayout-' + this.menuPosition
);
1584 this.menuPosition
= position
;
1585 this.$element
.addClass( 'oo-ui-menuLayout-' + position
);
1591 * Get menu position.
1593 * @return {string} Menu position
1595 OO
.ui
.MenuLayout
.prototype.getMenuPosition = function () {
1596 return this.menuPosition
;
1600 * BookletLayouts contain {@link OO.ui.PageLayout page layouts} as well as
1601 * an {@link OO.ui.OutlineSelectWidget outline} that allows users to easily navigate
1602 * through the pages and select which one to display. By default, only one page is
1603 * displayed at a time and the outline is hidden. When a user navigates to a new page,
1604 * the booklet layout automatically focuses on the first focusable element, unless the
1605 * default setting is changed. Optionally, booklets can be configured to show
1606 * {@link OO.ui.OutlineControlsWidget controls} for adding, moving, and removing items.
1609 * // Example of a BookletLayout that contains two PageLayouts.
1611 * function PageOneLayout( name, config ) {
1612 * PageOneLayout.parent.call( this, name, config );
1613 * this.$element.append( '<p>First page</p><p>(This booklet has an outline, displayed on the left)</p>' );
1615 * OO.inheritClass( PageOneLayout, OO.ui.PageLayout );
1616 * PageOneLayout.prototype.setupOutlineItem = function () {
1617 * this.outlineItem.setLabel( 'Page One' );
1620 * function PageTwoLayout( name, config ) {
1621 * PageTwoLayout.parent.call( this, name, config );
1622 * this.$element.append( '<p>Second page</p>' );
1624 * OO.inheritClass( PageTwoLayout, OO.ui.PageLayout );
1625 * PageTwoLayout.prototype.setupOutlineItem = function () {
1626 * this.outlineItem.setLabel( 'Page Two' );
1629 * var page1 = new PageOneLayout( 'one' ),
1630 * page2 = new PageTwoLayout( 'two' );
1632 * var booklet = new OO.ui.BookletLayout( {
1636 * booklet.addPages ( [ page1, page2 ] );
1637 * $( 'body' ).append( booklet.$element );
1640 * @extends OO.ui.MenuLayout
1643 * @param {Object} [config] Configuration options
1644 * @cfg {boolean} [continuous=false] Show all pages, one after another
1645 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new page is displayed.
1646 * @cfg {boolean} [outlined=false] Show the outline. The outline is used to navigate through the pages of the booklet.
1647 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
1649 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
1650 // Configuration initialization
1651 config
= config
|| {};
1653 // Parent constructor
1654 OO
.ui
.BookletLayout
.parent
.call( this, config
);
1657 this.currentPageName
= null;
1659 this.ignoreFocus
= false;
1660 this.stackLayout
= new OO
.ui
.StackLayout( { continuous
: !!config
.continuous
} );
1661 this.$content
.append( this.stackLayout
.$element
);
1662 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
1663 this.outlineVisible
= false;
1664 this.outlined
= !!config
.outlined
;
1665 if ( this.outlined
) {
1666 this.editable
= !!config
.editable
;
1667 this.outlineControlsWidget
= null;
1668 this.outlineSelectWidget
= new OO
.ui
.OutlineSelectWidget();
1669 this.outlinePanel
= new OO
.ui
.PanelLayout( { scrollable
: true } );
1670 this.$menu
.append( this.outlinePanel
.$element
);
1671 this.outlineVisible
= true;
1672 if ( this.editable
) {
1673 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
1674 this.outlineSelectWidget
1678 this.toggleMenu( this.outlined
);
1681 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
1682 if ( this.outlined
) {
1683 this.outlineSelectWidget
.connect( this, { select
: 'onOutlineSelectWidgetSelect' } );
1684 this.scrolling
= false;
1685 this.stackLayout
.connect( this, { visibleItemChange
: 'onStackLayoutVisibleItemChange' } );
1687 if ( this.autoFocus
) {
1688 // Event 'focus' does not bubble, but 'focusin' does
1689 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
1693 this.$element
.addClass( 'oo-ui-bookletLayout' );
1694 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
1695 if ( this.outlined
) {
1696 this.outlinePanel
.$element
1697 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
1698 .append( this.outlineSelectWidget
.$element
);
1699 if ( this.editable
) {
1700 this.outlinePanel
.$element
1701 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
1702 .append( this.outlineControlsWidget
.$element
);
1709 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.MenuLayout
);
1714 * A 'set' event is emitted when a page is {@link #setPage set} to be displayed by the booklet layout.
1716 * @param {OO.ui.PageLayout} page Current page
1720 * An 'add' event is emitted when pages are {@link #addPages added} to the booklet layout.
1723 * @param {OO.ui.PageLayout[]} page Added pages
1724 * @param {number} index Index pages were added at
1728 * A 'remove' event is emitted when pages are {@link #clearPages cleared} or
1729 * {@link #removePages removed} from the booklet.
1732 * @param {OO.ui.PageLayout[]} pages Removed pages
1738 * Handle stack layout focus.
1741 * @param {jQuery.Event} e Focusin event
1743 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
1746 // Find the page that an element was focused within
1747 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
1748 for ( name
in this.pages
) {
1749 // Check for page match, exclude current page to find only page changes
1750 if ( this.pages
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentPageName
) {
1751 this.setPage( name
);
1758 * Handle visibleItemChange events from the stackLayout
1760 * The next visible page is set as the current page by selecting it
1763 * @param {OO.ui.PageLayout} page The next visible page in the layout
1765 OO
.ui
.BookletLayout
.prototype.onStackLayoutVisibleItemChange = function ( page
) {
1766 // Set a flag to so that the resulting call to #onStackLayoutSet doesn't
1767 // try and scroll the item into view again.
1768 this.scrolling
= true;
1769 this.outlineSelectWidget
.selectItemByData( page
.getName() );
1770 this.scrolling
= false;
1774 * Handle stack layout set events.
1777 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
1779 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
1781 if ( !this.scrolling
&& page
) {
1782 page
.scrollElementIntoView( {
1783 complete: function () {
1784 if ( layout
.autoFocus
) {
1793 * Focus the first input in the current page.
1795 * If no page is selected, the first selectable page will be selected.
1796 * If the focus is already in an element on the current page, nothing will happen.
1798 * @param {number} [itemIndex] A specific item to focus on
1800 OO
.ui
.BookletLayout
.prototype.focus = function ( itemIndex
) {
1802 items
= this.stackLayout
.getItems();
1804 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
1805 page
= items
[ itemIndex
];
1807 page
= this.stackLayout
.getCurrentItem();
1810 if ( !page
&& this.outlined
) {
1811 this.selectFirstSelectablePage();
1812 page
= this.stackLayout
.getCurrentItem();
1817 // Only change the focus if is not already in the current page
1818 if ( !OO
.ui
.contains( page
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
1824 * Find the first focusable input in the booklet layout and focus
1827 OO
.ui
.BookletLayout
.prototype.focusFirstFocusable = function () {
1828 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
1832 * Handle outline widget select events.
1835 * @param {OO.ui.OptionWidget|null} item Selected item
1837 OO
.ui
.BookletLayout
.prototype.onOutlineSelectWidgetSelect = function ( item
) {
1839 this.setPage( item
.getData() );
1844 * Check if booklet has an outline.
1846 * @return {boolean} Booklet has an outline
1848 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
1849 return this.outlined
;
1853 * Check if booklet has editing controls.
1855 * @return {boolean} Booklet is editable
1857 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
1858 return this.editable
;
1862 * Check if booklet has a visible outline.
1864 * @return {boolean} Outline is visible
1866 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
1867 return this.outlined
&& this.outlineVisible
;
1871 * Hide or show the outline.
1873 * @param {boolean} [show] Show outline, omit to invert current state
1876 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
1877 if ( this.outlined
) {
1878 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
1879 this.outlineVisible
= show
;
1880 this.toggleMenu( show
);
1887 * Get the page closest to the specified page.
1889 * @param {OO.ui.PageLayout} page Page to use as a reference point
1890 * @return {OO.ui.PageLayout|null} Page closest to the specified page
1892 OO
.ui
.BookletLayout
.prototype.getClosestPage = function ( page
) {
1893 var next
, prev
, level
,
1894 pages
= this.stackLayout
.getItems(),
1895 index
= pages
.indexOf( page
);
1897 if ( index
!== -1 ) {
1898 next
= pages
[ index
+ 1 ];
1899 prev
= pages
[ index
- 1 ];
1900 // Prefer adjacent pages at the same level
1901 if ( this.outlined
) {
1902 level
= this.outlineSelectWidget
.getItemFromData( page
.getName() ).getLevel();
1905 level
=== this.outlineSelectWidget
.getItemFromData( prev
.getName() ).getLevel()
1911 level
=== this.outlineSelectWidget
.getItemFromData( next
.getName() ).getLevel()
1917 return prev
|| next
|| null;
1921 * Get the outline widget.
1923 * If the booklet is not outlined, the method will return `null`.
1925 * @return {OO.ui.OutlineSelectWidget|null} Outline widget, or null if the booklet is not outlined
1927 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
1928 return this.outlineSelectWidget
;
1932 * Get the outline controls widget.
1934 * If the outline is not editable, the method will return `null`.
1936 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
1938 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
1939 return this.outlineControlsWidget
;
1943 * Get a page by its symbolic name.
1945 * @param {string} name Symbolic name of page
1946 * @return {OO.ui.PageLayout|undefined} Page, if found
1948 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
1949 return this.pages
[ name
];
1953 * Get the current page.
1955 * @return {OO.ui.PageLayout|undefined} Current page, if found
1957 OO
.ui
.BookletLayout
.prototype.getCurrentPage = function () {
1958 var name
= this.getCurrentPageName();
1959 return name
? this.getPage( name
) : undefined;
1963 * Get the symbolic name of the current page.
1965 * @return {string|null} Symbolic name of the current page
1967 OO
.ui
.BookletLayout
.prototype.getCurrentPageName = function () {
1968 return this.currentPageName
;
1972 * Add pages to the booklet layout
1974 * When pages are added with the same names as existing pages, the existing pages will be
1975 * automatically removed before the new pages are added.
1977 * @param {OO.ui.PageLayout[]} pages Pages to add
1978 * @param {number} index Index of the insertion point
1982 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
1983 var i
, len
, name
, page
, item
, currentIndex
,
1984 stackLayoutPages
= this.stackLayout
.getItems(),
1988 // Remove pages with same names
1989 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
1991 name
= page
.getName();
1993 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
1994 // Correct the insertion index
1995 currentIndex
= stackLayoutPages
.indexOf( this.pages
[ name
] );
1996 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
1999 remove
.push( this.pages
[ name
] );
2002 if ( remove
.length
) {
2003 this.removePages( remove
);
2007 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2009 name
= page
.getName();
2010 this.pages
[ page
.getName() ] = page
;
2011 if ( this.outlined
) {
2012 item
= new OO
.ui
.OutlineOptionWidget( { data
: name
} );
2013 page
.setOutlineItem( item
);
2018 if ( this.outlined
&& items
.length
) {
2019 this.outlineSelectWidget
.addItems( items
, index
);
2020 this.selectFirstSelectablePage();
2022 this.stackLayout
.addItems( pages
, index
);
2023 this.emit( 'add', pages
, index
);
2029 * Remove the specified pages from the booklet layout.
2031 * To remove all pages from the booklet, you may wish to use the #clearPages method instead.
2033 * @param {OO.ui.PageLayout[]} pages An array of pages to remove
2037 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
2038 var i
, len
, name
, page
,
2041 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2043 name
= page
.getName();
2044 delete this.pages
[ name
];
2045 if ( this.outlined
) {
2046 items
.push( this.outlineSelectWidget
.getItemFromData( name
) );
2047 page
.setOutlineItem( null );
2050 if ( this.outlined
&& items
.length
) {
2051 this.outlineSelectWidget
.removeItems( items
);
2052 this.selectFirstSelectablePage();
2054 this.stackLayout
.removeItems( pages
);
2055 this.emit( 'remove', pages
);
2061 * Clear all pages from the booklet layout.
2063 * To remove only a subset of pages from the booklet, use the #removePages method.
2068 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
2070 pages
= this.stackLayout
.getItems();
2073 this.currentPageName
= null;
2074 if ( this.outlined
) {
2075 this.outlineSelectWidget
.clearItems();
2076 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
2077 pages
[ i
].setOutlineItem( null );
2080 this.stackLayout
.clearItems();
2082 this.emit( 'remove', pages
);
2088 * Set the current page by symbolic name.
2091 * @param {string} name Symbolic name of page
2093 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
2096 page
= this.pages
[ name
],
2097 previousPage
= this.currentPageName
&& this.pages
[ this.currentPageName
];
2099 if ( name
!== this.currentPageName
) {
2100 if ( this.outlined
) {
2101 selectedItem
= this.outlineSelectWidget
.getSelectedItem();
2102 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2103 this.outlineSelectWidget
.selectItemByData( name
);
2107 if ( previousPage
) {
2108 previousPage
.setActive( false );
2109 // Blur anything focused if the next page doesn't have anything focusable.
2110 // This is not needed if the next page has something focusable (because once it is focused
2111 // this blur happens automatically). If the layout is non-continuous, this check is
2112 // meaningless because the next page is not visible yet and thus can't hold focus.
2115 this.stackLayout
.continuous
&&
2116 OO
.ui
.findFocusable( page
.$element
).length
!== 0
2118 $focused
= previousPage
.$element
.find( ':focus' );
2119 if ( $focused
.length
) {
2120 $focused
[ 0 ].blur();
2124 this.currentPageName
= name
;
2125 page
.setActive( true );
2126 this.stackLayout
.setItem( page
);
2127 if ( !this.stackLayout
.continuous
&& previousPage
) {
2128 // This should not be necessary, since any inputs on the previous page should have been
2129 // blurred when it was hidden, but browsers are not very consistent about this.
2130 $focused
= previousPage
.$element
.find( ':focus' );
2131 if ( $focused
.length
) {
2132 $focused
[ 0 ].blur();
2135 this.emit( 'set', page
);
2141 * Select the first selectable page.
2145 OO
.ui
.BookletLayout
.prototype.selectFirstSelectablePage = function () {
2146 if ( !this.outlineSelectWidget
.getSelectedItem() ) {
2147 this.outlineSelectWidget
.selectItem( this.outlineSelectWidget
.getFirstSelectableItem() );
2154 * IndexLayouts contain {@link OO.ui.CardLayout card layouts} as well as
2155 * {@link OO.ui.TabSelectWidget tabs} that allow users to easily navigate through the cards and
2156 * select which one to display. By default, only one card is displayed at a time. When a user
2157 * navigates to a new card, the index layout automatically focuses on the first focusable element,
2158 * unless the default setting is changed.
2160 * TODO: This class is similar to BookletLayout, we may want to refactor to reduce duplication
2163 * // Example of a IndexLayout that contains two CardLayouts.
2165 * function CardOneLayout( name, config ) {
2166 * CardOneLayout.parent.call( this, name, config );
2167 * this.$element.append( '<p>First card</p>' );
2169 * OO.inheritClass( CardOneLayout, OO.ui.CardLayout );
2170 * CardOneLayout.prototype.setupTabItem = function () {
2171 * this.tabItem.setLabel( 'Card one' );
2174 * var card1 = new CardOneLayout( 'one' ),
2175 * card2 = new OO.ui.CardLayout( 'two', { label: 'Card two' } );
2177 * card2.$element.append( '<p>Second card</p>' );
2179 * var index = new OO.ui.IndexLayout();
2181 * index.addCards ( [ card1, card2 ] );
2182 * $( 'body' ).append( index.$element );
2185 * @extends OO.ui.MenuLayout
2188 * @param {Object} [config] Configuration options
2189 * @cfg {boolean} [continuous=false] Show all cards, one after another
2190 * @cfg {boolean} [expanded=true] Expand the content panel to fill the entire parent element.
2191 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new card is displayed.
2193 OO
.ui
.IndexLayout
= function OoUiIndexLayout( config
) {
2194 // Configuration initialization
2195 config
= $.extend( {}, config
, { menuPosition
: 'top' } );
2197 // Parent constructor
2198 OO
.ui
.IndexLayout
.parent
.call( this, config
);
2201 this.currentCardName
= null;
2203 this.ignoreFocus
= false;
2204 this.stackLayout
= new OO
.ui
.StackLayout( {
2205 continuous
: !!config
.continuous
,
2206 expanded
: config
.expanded
2208 this.$content
.append( this.stackLayout
.$element
);
2209 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
2211 this.tabSelectWidget
= new OO
.ui
.TabSelectWidget();
2212 this.tabPanel
= new OO
.ui
.PanelLayout();
2213 this.$menu
.append( this.tabPanel
.$element
);
2215 this.toggleMenu( true );
2218 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
2219 this.tabSelectWidget
.connect( this, { select
: 'onTabSelectWidgetSelect' } );
2220 if ( this.autoFocus
) {
2221 // Event 'focus' does not bubble, but 'focusin' does
2222 this.stackLayout
.$element
.on( 'focusin', this.onStackLayoutFocus
.bind( this ) );
2226 this.$element
.addClass( 'oo-ui-indexLayout' );
2227 this.stackLayout
.$element
.addClass( 'oo-ui-indexLayout-stackLayout' );
2228 this.tabPanel
.$element
2229 .addClass( 'oo-ui-indexLayout-tabPanel' )
2230 .append( this.tabSelectWidget
.$element
);
2235 OO
.inheritClass( OO
.ui
.IndexLayout
, OO
.ui
.MenuLayout
);
2240 * A 'set' event is emitted when a card is {@link #setCard set} to be displayed by the index layout.
2242 * @param {OO.ui.CardLayout} card Current card
2246 * An 'add' event is emitted when cards are {@link #addCards added} to the index layout.
2249 * @param {OO.ui.CardLayout[]} card Added cards
2250 * @param {number} index Index cards were added at
2254 * A 'remove' event is emitted when cards are {@link #clearCards cleared} or
2255 * {@link #removeCards removed} from the index.
2258 * @param {OO.ui.CardLayout[]} cards Removed cards
2264 * Handle stack layout focus.
2267 * @param {jQuery.Event} e Focusin event
2269 OO
.ui
.IndexLayout
.prototype.onStackLayoutFocus = function ( e
) {
2272 // Find the card that an element was focused within
2273 $target
= $( e
.target
).closest( '.oo-ui-cardLayout' );
2274 for ( name
in this.cards
) {
2275 // Check for card match, exclude current card to find only card changes
2276 if ( this.cards
[ name
].$element
[ 0 ] === $target
[ 0 ] && name
!== this.currentCardName
) {
2277 this.setCard( name
);
2284 * Handle stack layout set events.
2287 * @param {OO.ui.PanelLayout|null} card The card panel that is now the current panel
2289 OO
.ui
.IndexLayout
.prototype.onStackLayoutSet = function ( card
) {
2292 card
.scrollElementIntoView( {
2293 complete: function () {
2294 if ( layout
.autoFocus
) {
2303 * Focus the first input in the current card.
2305 * If no card is selected, the first selectable card will be selected.
2306 * If the focus is already in an element on the current card, nothing will happen.
2308 * @param {number} [itemIndex] A specific item to focus on
2310 OO
.ui
.IndexLayout
.prototype.focus = function ( itemIndex
) {
2312 items
= this.stackLayout
.getItems();
2314 if ( itemIndex
!== undefined && items
[ itemIndex
] ) {
2315 card
= items
[ itemIndex
];
2317 card
= this.stackLayout
.getCurrentItem();
2321 this.selectFirstSelectableCard();
2322 card
= this.stackLayout
.getCurrentItem();
2327 // Only change the focus if is not already in the current page
2328 if ( !OO
.ui
.contains( card
.$element
[ 0 ], this.getElementDocument().activeElement
, true ) ) {
2334 * Find the first focusable input in the index layout and focus
2337 OO
.ui
.IndexLayout
.prototype.focusFirstFocusable = function () {
2338 OO
.ui
.findFocusable( this.stackLayout
.$element
).focus();
2342 * Handle tab widget select events.
2345 * @param {OO.ui.OptionWidget|null} item Selected item
2347 OO
.ui
.IndexLayout
.prototype.onTabSelectWidgetSelect = function ( item
) {
2349 this.setCard( item
.getData() );
2354 * Get the card closest to the specified card.
2356 * @param {OO.ui.CardLayout} card Card to use as a reference point
2357 * @return {OO.ui.CardLayout|null} Card closest to the specified card
2359 OO
.ui
.IndexLayout
.prototype.getClosestCard = function ( card
) {
2360 var next
, prev
, level
,
2361 cards
= this.stackLayout
.getItems(),
2362 index
= cards
.indexOf( card
);
2364 if ( index
!== -1 ) {
2365 next
= cards
[ index
+ 1 ];
2366 prev
= cards
[ index
- 1 ];
2367 // Prefer adjacent cards at the same level
2368 level
= this.tabSelectWidget
.getItemFromData( card
.getName() ).getLevel();
2371 level
=== this.tabSelectWidget
.getItemFromData( prev
.getName() ).getLevel()
2377 level
=== this.tabSelectWidget
.getItemFromData( next
.getName() ).getLevel()
2382 return prev
|| next
|| null;
2386 * Get the tabs widget.
2388 * @return {OO.ui.TabSelectWidget} Tabs widget
2390 OO
.ui
.IndexLayout
.prototype.getTabs = function () {
2391 return this.tabSelectWidget
;
2395 * Get a card by its symbolic name.
2397 * @param {string} name Symbolic name of card
2398 * @return {OO.ui.CardLayout|undefined} Card, if found
2400 OO
.ui
.IndexLayout
.prototype.getCard = function ( name
) {
2401 return this.cards
[ name
];
2405 * Get the current card.
2407 * @return {OO.ui.CardLayout|undefined} Current card, if found
2409 OO
.ui
.IndexLayout
.prototype.getCurrentCard = function () {
2410 var name
= this.getCurrentCardName();
2411 return name
? this.getCard( name
) : undefined;
2415 * Get the symbolic name of the current card.
2417 * @return {string|null} Symbolic name of the current card
2419 OO
.ui
.IndexLayout
.prototype.getCurrentCardName = function () {
2420 return this.currentCardName
;
2424 * Add cards to the index layout
2426 * When cards are added with the same names as existing cards, the existing cards will be
2427 * automatically removed before the new cards are added.
2429 * @param {OO.ui.CardLayout[]} cards Cards to add
2430 * @param {number} index Index of the insertion point
2434 OO
.ui
.IndexLayout
.prototype.addCards = function ( cards
, index
) {
2435 var i
, len
, name
, card
, item
, currentIndex
,
2436 stackLayoutCards
= this.stackLayout
.getItems(),
2440 // Remove cards with same names
2441 for ( i
= 0, len
= cards
.length
; i
< len
; i
++ ) {
2443 name
= card
.getName();
2445 if ( Object
.prototype.hasOwnProperty
.call( this.cards
, name
) ) {
2446 // Correct the insertion index
2447 currentIndex
= stackLayoutCards
.indexOf( this.cards
[ name
] );
2448 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
2451 remove
.push( this.cards
[ name
] );
2454 if ( remove
.length
) {
2455 this.removeCards( remove
);
2459 for ( i
= 0, len
= cards
.length
; i
< len
; i
++ ) {
2461 name
= card
.getName();
2462 this.cards
[ card
.getName() ] = card
;
2463 item
= new OO
.ui
.TabOptionWidget( { data
: name
} );
2464 card
.setTabItem( item
);
2468 if ( items
.length
) {
2469 this.tabSelectWidget
.addItems( items
, index
);
2470 this.selectFirstSelectableCard();
2472 this.stackLayout
.addItems( cards
, index
);
2473 this.emit( 'add', cards
, index
);
2479 * Remove the specified cards from the index layout.
2481 * To remove all cards from the index, you may wish to use the #clearCards method instead.
2483 * @param {OO.ui.CardLayout[]} cards An array of cards to remove
2487 OO
.ui
.IndexLayout
.prototype.removeCards = function ( cards
) {
2488 var i
, len
, name
, card
,
2491 for ( i
= 0, len
= cards
.length
; i
< len
; i
++ ) {
2493 name
= card
.getName();
2494 delete this.cards
[ name
];
2495 items
.push( this.tabSelectWidget
.getItemFromData( name
) );
2496 card
.setTabItem( null );
2498 if ( items
.length
) {
2499 this.tabSelectWidget
.removeItems( items
);
2500 this.selectFirstSelectableCard();
2502 this.stackLayout
.removeItems( cards
);
2503 this.emit( 'remove', cards
);
2509 * Clear all cards from the index layout.
2511 * To remove only a subset of cards from the index, use the #removeCards method.
2516 OO
.ui
.IndexLayout
.prototype.clearCards = function () {
2518 cards
= this.stackLayout
.getItems();
2521 this.currentCardName
= null;
2522 this.tabSelectWidget
.clearItems();
2523 for ( i
= 0, len
= cards
.length
; i
< len
; i
++ ) {
2524 cards
[ i
].setTabItem( null );
2526 this.stackLayout
.clearItems();
2528 this.emit( 'remove', cards
);
2534 * Set the current card by symbolic name.
2537 * @param {string} name Symbolic name of card
2539 OO
.ui
.IndexLayout
.prototype.setCard = function ( name
) {
2542 card
= this.cards
[ name
],
2543 previousCard
= this.currentCardName
&& this.cards
[ this.currentCardName
];
2545 if ( name
!== this.currentCardName
) {
2546 selectedItem
= this.tabSelectWidget
.getSelectedItem();
2547 if ( selectedItem
&& selectedItem
.getData() !== name
) {
2548 this.tabSelectWidget
.selectItemByData( name
);
2551 if ( previousCard
) {
2552 previousCard
.setActive( false );
2553 // Blur anything focused if the next card doesn't have anything focusable.
2554 // This is not needed if the next card has something focusable (because once it is focused
2555 // this blur happens automatically). If the layout is non-continuous, this check is
2556 // meaningless because the next card is not visible yet and thus can't hold focus.
2559 this.stackLayout
.continuous
&&
2560 OO
.ui
.findFocusable( card
.$element
).length
!== 0
2562 $focused
= previousCard
.$element
.find( ':focus' );
2563 if ( $focused
.length
) {
2564 $focused
[ 0 ].blur();
2568 this.currentCardName
= name
;
2569 card
.setActive( true );
2570 this.stackLayout
.setItem( card
);
2571 if ( !this.stackLayout
.continuous
&& previousCard
) {
2572 // This should not be necessary, since any inputs on the previous card should have been
2573 // blurred when it was hidden, but browsers are not very consistent about this.
2574 $focused
= previousCard
.$element
.find( ':focus' );
2575 if ( $focused
.length
) {
2576 $focused
[ 0 ].blur();
2579 this.emit( 'set', card
);
2585 * Select the first selectable card.
2589 OO
.ui
.IndexLayout
.prototype.selectFirstSelectableCard = function () {
2590 if ( !this.tabSelectWidget
.getSelectedItem() ) {
2591 this.tabSelectWidget
.selectItem( this.tabSelectWidget
.getFirstSelectableItem() );
2598 * ToggleWidget implements basic behavior of widgets with an on/off state.
2599 * Please see OO.ui.ToggleButtonWidget and OO.ui.ToggleSwitchWidget for examples.
2603 * @extends OO.ui.Widget
2606 * @param {Object} [config] Configuration options
2607 * @cfg {boolean} [value=false] The toggle’s initial on/off state.
2608 * By default, the toggle is in the 'off' state.
2610 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
2611 // Configuration initialization
2612 config
= config
|| {};
2614 // Parent constructor
2615 OO
.ui
.ToggleWidget
.parent
.call( this, config
);
2621 this.$element
.addClass( 'oo-ui-toggleWidget' );
2622 this.setValue( !!config
.value
);
2627 OO
.inheritClass( OO
.ui
.ToggleWidget
, OO
.ui
.Widget
);
2634 * A change event is emitted when the on/off state of the toggle changes.
2636 * @param {boolean} value Value representing the new state of the toggle
2642 * Get the value representing the toggle’s state.
2644 * @return {boolean} The on/off state of the toggle
2646 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
2651 * Set the state of the toggle: `true` for 'on', `false' for 'off'.
2653 * @param {boolean} value The state of the toggle
2657 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
2659 if ( this.value
!== value
) {
2661 this.emit( 'change', value
);
2662 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
2663 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
2664 this.$element
.attr( 'aria-checked', value
.toString() );
2670 * ToggleButtons are buttons that have a state (‘on’ or ‘off’) that is represented by a
2671 * Boolean value. Like other {@link OO.ui.ButtonWidget buttons}, toggle buttons can be
2672 * configured with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators},
2673 * {@link OO.ui.mixin.TitledElement titles}, {@link OO.ui.mixin.FlaggedElement styling flags},
2674 * and {@link OO.ui.mixin.LabelElement labels}. Please see
2675 * the [OOjs UI documentation][1] on MediaWiki for more information.
2678 * // Toggle buttons in the 'off' and 'on' state.
2679 * var toggleButton1 = new OO.ui.ToggleButtonWidget( {
2680 * label: 'Toggle Button off'
2682 * var toggleButton2 = new OO.ui.ToggleButtonWidget( {
2683 * label: 'Toggle Button on',
2686 * // Append the buttons to the DOM.
2687 * $( 'body' ).append( toggleButton1.$element, toggleButton2.$element );
2689 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches#Toggle_buttons
2692 * @extends OO.ui.ToggleWidget
2693 * @mixins OO.ui.mixin.ButtonElement
2694 * @mixins OO.ui.mixin.IconElement
2695 * @mixins OO.ui.mixin.IndicatorElement
2696 * @mixins OO.ui.mixin.LabelElement
2697 * @mixins OO.ui.mixin.TitledElement
2698 * @mixins OO.ui.mixin.FlaggedElement
2699 * @mixins OO.ui.mixin.TabIndexedElement
2702 * @param {Object} [config] Configuration options
2703 * @cfg {boolean} [value=false] The toggle button’s initial on/off
2704 * state. By default, the button is in the 'off' state.
2706 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
2707 // Configuration initialization
2708 config
= config
|| {};
2710 // Parent constructor
2711 OO
.ui
.ToggleButtonWidget
.parent
.call( this, config
);
2713 // Mixin constructors
2714 OO
.ui
.mixin
.ButtonElement
.call( this, $.extend( {}, config
, { active
: this.active
} ) );
2715 OO
.ui
.mixin
.IconElement
.call( this, config
);
2716 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
2717 OO
.ui
.mixin
.LabelElement
.call( this, config
);
2718 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
2719 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
2720 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$button
} ) );
2723 this.connect( this, { click
: 'onAction' } );
2726 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
2728 .addClass( 'oo-ui-toggleButtonWidget' )
2729 .append( this.$button
);
2734 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
2735 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.ButtonElement
);
2736 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IconElement
);
2737 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.IndicatorElement
);
2738 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.LabelElement
);
2739 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TitledElement
);
2740 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.FlaggedElement
);
2741 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.mixin
.TabIndexedElement
);
2746 * Handle the button action being triggered.
2750 OO
.ui
.ToggleButtonWidget
.prototype.onAction = function () {
2751 this.setValue( !this.value
);
2757 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
2759 if ( value
!== this.value
) {
2760 // Might be called from parent constructor before ButtonElement constructor
2761 if ( this.$button
) {
2762 this.$button
.attr( 'aria-pressed', value
.toString() );
2764 this.setActive( value
);
2768 OO
.ui
.ToggleButtonWidget
.parent
.prototype.setValue
.call( this, value
);
2776 OO
.ui
.ToggleButtonWidget
.prototype.setButtonElement = function ( $button
) {
2777 if ( this.$button
) {
2778 this.$button
.removeAttr( 'aria-pressed' );
2780 OO
.ui
.mixin
.ButtonElement
.prototype.setButtonElement
.call( this, $button
);
2781 this.$button
.attr( 'aria-pressed', this.value
.toString() );
2785 * ToggleSwitches are switches that slide on and off. Their state is represented by a Boolean
2786 * value (`true` for ‘on’, and `false` otherwise, the default). The ‘off’ state is represented
2787 * visually by a slider in the leftmost position.
2790 * // Toggle switches in the 'off' and 'on' position.
2791 * var toggleSwitch1 = new OO.ui.ToggleSwitchWidget();
2792 * var toggleSwitch2 = new OO.ui.ToggleSwitchWidget( {
2796 * // Create a FieldsetLayout to layout and label switches
2797 * var fieldset = new OO.ui.FieldsetLayout( {
2798 * label: 'Toggle switches'
2800 * fieldset.addItems( [
2801 * new OO.ui.FieldLayout( toggleSwitch1, { label: 'Off', align: 'top' } ),
2802 * new OO.ui.FieldLayout( toggleSwitch2, { label: 'On', align: 'top' } )
2804 * $( 'body' ).append( fieldset.$element );
2807 * @extends OO.ui.ToggleWidget
2808 * @mixins OO.ui.mixin.TabIndexedElement
2811 * @param {Object} [config] Configuration options
2812 * @cfg {boolean} [value=false] The toggle switch’s initial on/off state.
2813 * By default, the toggle switch is in the 'off' position.
2815 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
2816 // Parent constructor
2817 OO
.ui
.ToggleSwitchWidget
.parent
.call( this, config
);
2819 // Mixin constructors
2820 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
2823 this.dragging
= false;
2824 this.dragStart
= null;
2825 this.sliding
= false;
2826 this.$glow
= $( '<span>' );
2827 this.$grip
= $( '<span>' );
2831 click
: this.onClick
.bind( this ),
2832 keypress
: this.onKeyPress
.bind( this )
2836 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
2837 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
2839 .addClass( 'oo-ui-toggleSwitchWidget' )
2840 .attr( 'role', 'checkbox' )
2841 .append( this.$glow
, this.$grip
);
2846 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
2847 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.mixin
.TabIndexedElement
);
2852 * Handle mouse click events.
2855 * @param {jQuery.Event} e Mouse click event
2857 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
2858 if ( !this.isDisabled() && e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
2859 this.setValue( !this.value
);
2865 * Handle key press events.
2868 * @param {jQuery.Event} e Key press event
2870 OO
.ui
.ToggleSwitchWidget
.prototype.onKeyPress = function ( e
) {
2871 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
2872 this.setValue( !this.value
);
2878 * OutlineControlsWidget is a set of controls for an {@link OO.ui.OutlineSelectWidget outline select widget}.
2879 * Controls include moving items up and down, removing items, and adding different kinds of items.
2881 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
2884 * @extends OO.ui.Widget
2885 * @mixins OO.ui.mixin.GroupElement
2886 * @mixins OO.ui.mixin.IconElement
2889 * @param {OO.ui.OutlineSelectWidget} outline Outline to control
2890 * @param {Object} [config] Configuration options
2891 * @cfg {Object} [abilities] List of abilties
2892 * @cfg {boolean} [abilities.move=true] Allow moving movable items
2893 * @cfg {boolean} [abilities.remove=true] Allow removing removable items
2895 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
2896 // Allow passing positional parameters inside the config object
2897 if ( OO
.isPlainObject( outline
) && config
=== undefined ) {
2899 outline
= config
.outline
;
2902 // Configuration initialization
2903 config
= $.extend( { icon
: 'add' }, config
);
2905 // Parent constructor
2906 OO
.ui
.OutlineControlsWidget
.parent
.call( this, config
);
2908 // Mixin constructors
2909 OO
.ui
.mixin
.GroupElement
.call( this, config
);
2910 OO
.ui
.mixin
.IconElement
.call( this, config
);
2913 this.outline
= outline
;
2914 this.$movers
= $( '<div>' );
2915 this.upButton
= new OO
.ui
.ButtonWidget( {
2918 title
: OO
.ui
.msg( 'ooui-outline-control-move-up' )
2920 this.downButton
= new OO
.ui
.ButtonWidget( {
2923 title
: OO
.ui
.msg( 'ooui-outline-control-move-down' )
2925 this.removeButton
= new OO
.ui
.ButtonWidget( {
2928 title
: OO
.ui
.msg( 'ooui-outline-control-remove' )
2930 this.abilities
= { move: true, remove
: true };
2933 outline
.connect( this, {
2934 select
: 'onOutlineChange',
2935 add
: 'onOutlineChange',
2936 remove
: 'onOutlineChange'
2938 this.upButton
.connect( this, { click
: [ 'emit', 'move', -1 ] } );
2939 this.downButton
.connect( this, { click
: [ 'emit', 'move', 1 ] } );
2940 this.removeButton
.connect( this, { click
: [ 'emit', 'remove' ] } );
2943 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
2944 this.$group
.addClass( 'oo-ui-outlineControlsWidget-items' );
2946 .addClass( 'oo-ui-outlineControlsWidget-movers' )
2947 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
2948 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
2949 this.setAbilities( config
.abilities
|| {} );
2954 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
2955 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.GroupElement
);
2956 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.mixin
.IconElement
);
2962 * @param {number} places Number of places to move
2974 * @param {Object} abilities List of abilties
2975 * @param {boolean} [abilities.move] Allow moving movable items
2976 * @param {boolean} [abilities.remove] Allow removing removable items
2978 OO
.ui
.OutlineControlsWidget
.prototype.setAbilities = function ( abilities
) {
2981 for ( ability
in this.abilities
) {
2982 if ( abilities
[ ability
] !== undefined ) {
2983 this.abilities
[ ability
] = !!abilities
[ ability
];
2987 this.onOutlineChange();
2991 * Handle outline change events.
2995 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
2996 var i
, len
, firstMovable
, lastMovable
,
2997 items
= this.outline
.getItems(),
2998 selectedItem
= this.outline
.getSelectedItem(),
2999 movable
= this.abilities
.move && selectedItem
&& selectedItem
.isMovable(),
3000 removable
= this.abilities
.remove
&& selectedItem
&& selectedItem
.isRemovable();
3005 while ( ++i
< len
) {
3006 if ( items
[ i
].isMovable() ) {
3007 firstMovable
= items
[ i
];
3013 if ( items
[ i
].isMovable() ) {
3014 lastMovable
= items
[ i
];
3019 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
3020 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
3021 this.removeButton
.setDisabled( !removable
);
3025 * OutlineOptionWidget is an item in an {@link OO.ui.OutlineSelectWidget OutlineSelectWidget}.
3027 * Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}, which contain
3028 * {@link OO.ui.PageLayout page layouts}. See {@link OO.ui.BookletLayout BookletLayout}
3032 * @extends OO.ui.DecoratedOptionWidget
3035 * @param {Object} [config] Configuration options
3036 * @cfg {number} [level] Indentation level
3037 * @cfg {boolean} [movable] Allow modification from {@link OO.ui.OutlineControlsWidget outline controls}.
3039 OO
.ui
.OutlineOptionWidget
= function OoUiOutlineOptionWidget( config
) {
3040 // Configuration initialization
3041 config
= config
|| {};
3043 // Parent constructor
3044 OO
.ui
.OutlineOptionWidget
.parent
.call( this, config
);
3048 this.movable
= !!config
.movable
;
3049 this.removable
= !!config
.removable
;
3052 this.$element
.addClass( 'oo-ui-outlineOptionWidget' );
3053 this.setLevel( config
.level
);
3058 OO
.inheritClass( OO
.ui
.OutlineOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
3060 /* Static Properties */
3062 OO
.ui
.OutlineOptionWidget
.static.highlightable
= true;
3064 OO
.ui
.OutlineOptionWidget
.static.scrollIntoViewOnSelect
= true;
3066 OO
.ui
.OutlineOptionWidget
.static.levelClass
= 'oo-ui-outlineOptionWidget-level-';
3068 OO
.ui
.OutlineOptionWidget
.static.levels
= 3;
3073 * Check if item is movable.
3075 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3077 * @return {boolean} Item is movable
3079 OO
.ui
.OutlineOptionWidget
.prototype.isMovable = function () {
3080 return this.movable
;
3084 * Check if item is removable.
3086 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3088 * @return {boolean} Item is removable
3090 OO
.ui
.OutlineOptionWidget
.prototype.isRemovable = function () {
3091 return this.removable
;
3095 * Get indentation level.
3097 * @return {number} Indentation level
3099 OO
.ui
.OutlineOptionWidget
.prototype.getLevel = function () {
3106 OO
.ui
.OutlineOptionWidget
.prototype.setPressed = function ( state
) {
3107 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setPressed
.call( this, state
);
3108 if ( this.pressed
) {
3109 this.setFlags( 'progressive' );
3110 } else if ( !this.selected
) {
3119 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3121 * @param {boolean} movable Item is movable
3124 OO
.ui
.OutlineOptionWidget
.prototype.setMovable = function ( movable
) {
3125 this.movable
= !!movable
;
3126 this.updateThemeClasses();
3133 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3135 * @param {boolean} removable Item is removable
3138 OO
.ui
.OutlineOptionWidget
.prototype.setRemovable = function ( removable
) {
3139 this.removable
= !!removable
;
3140 this.updateThemeClasses();
3147 OO
.ui
.OutlineOptionWidget
.prototype.setSelected = function ( state
) {
3148 OO
.ui
.OutlineOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3149 if ( this.selected
) {
3150 this.setFlags( 'progressive' );
3158 * Set indentation level.
3160 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
3163 OO
.ui
.OutlineOptionWidget
.prototype.setLevel = function ( level
) {
3164 var levels
= this.constructor.static.levels
,
3165 levelClass
= this.constructor.static.levelClass
,
3168 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
3170 if ( this.level
=== i
) {
3171 this.$element
.addClass( levelClass
+ i
);
3173 this.$element
.removeClass( levelClass
+ i
);
3176 this.updateThemeClasses();
3182 * OutlineSelectWidget is a structured list that contains {@link OO.ui.OutlineOptionWidget outline options}
3183 * A set of controls can be provided with an {@link OO.ui.OutlineControlsWidget outline controls} widget.
3185 * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3188 * @extends OO.ui.SelectWidget
3189 * @mixins OO.ui.mixin.TabIndexedElement
3192 * @param {Object} [config] Configuration options
3194 OO
.ui
.OutlineSelectWidget
= function OoUiOutlineSelectWidget( config
) {
3195 // Parent constructor
3196 OO
.ui
.OutlineSelectWidget
.parent
.call( this, config
);
3198 // Mixin constructors
3199 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3203 focus
: this.bindKeyDownListener
.bind( this ),
3204 blur
: this.unbindKeyDownListener
.bind( this )
3208 this.$element
.addClass( 'oo-ui-outlineSelectWidget' );
3213 OO
.inheritClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.SelectWidget
);
3214 OO
.mixinClass( OO
.ui
.OutlineSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3217 * ButtonOptionWidget is a special type of {@link OO.ui.mixin.ButtonElement button element} that
3218 * can be selected and configured with data. The class is
3219 * used with OO.ui.ButtonSelectWidget to create a selection of button options. Please see the
3220 * [OOjs UI documentation on MediaWiki] [1] for more information.
3222 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Button_selects_and_options
3225 * @extends OO.ui.OptionWidget
3226 * @mixins OO.ui.mixin.ButtonElement
3227 * @mixins OO.ui.mixin.IconElement
3228 * @mixins OO.ui.mixin.IndicatorElement
3229 * @mixins OO.ui.mixin.TitledElement
3232 * @param {Object} [config] Configuration options
3234 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( config
) {
3235 // Configuration initialization
3236 config
= config
|| {};
3238 // Parent constructor
3239 OO
.ui
.ButtonOptionWidget
.parent
.call( this, config
);
3241 // Mixin constructors
3242 OO
.ui
.mixin
.ButtonElement
.call( this, config
);
3243 OO
.ui
.mixin
.IconElement
.call( this, config
);
3244 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3245 OO
.ui
.mixin
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
3248 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
3249 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
3250 this.$element
.append( this.$button
);
3255 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.OptionWidget
);
3256 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.ButtonElement
);
3257 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IconElement
);
3258 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.IndicatorElement
);
3259 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.mixin
.TitledElement
);
3261 /* Static Properties */
3263 // Allow button mouse down events to pass through so they can be handled by the parent select widget
3264 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
3266 OO
.ui
.ButtonOptionWidget
.static.highlightable
= false;
3273 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
3274 OO
.ui
.ButtonOptionWidget
.parent
.prototype.setSelected
.call( this, state
);
3276 if ( this.constructor.static.selectable
) {
3277 this.setActive( state
);
3284 * ButtonSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains
3285 * button options and is used together with
3286 * OO.ui.ButtonOptionWidget. The ButtonSelectWidget provides an interface for
3287 * highlighting, choosing, and selecting mutually exclusive options. Please see
3288 * the [OOjs UI documentation on MediaWiki] [1] for more information.
3291 * // Example: A ButtonSelectWidget that contains three ButtonOptionWidgets
3292 * var option1 = new OO.ui.ButtonOptionWidget( {
3294 * label: 'Option 1',
3295 * title: 'Button option 1'
3298 * var option2 = new OO.ui.ButtonOptionWidget( {
3300 * label: 'Option 2',
3301 * title: 'Button option 2'
3304 * var option3 = new OO.ui.ButtonOptionWidget( {
3306 * label: 'Option 3',
3307 * title: 'Button option 3'
3310 * var buttonSelect=new OO.ui.ButtonSelectWidget( {
3311 * items: [ option1, option2, option3 ]
3313 * $( 'body' ).append( buttonSelect.$element );
3315 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
3318 * @extends OO.ui.SelectWidget
3319 * @mixins OO.ui.mixin.TabIndexedElement
3322 * @param {Object} [config] Configuration options
3324 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
3325 // Parent constructor
3326 OO
.ui
.ButtonSelectWidget
.parent
.call( this, config
);
3328 // Mixin constructors
3329 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3333 focus
: this.bindKeyDownListener
.bind( this ),
3334 blur
: this.unbindKeyDownListener
.bind( this )
3338 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
3343 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
3344 OO
.mixinClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3347 * TabOptionWidget is an item in a {@link OO.ui.TabSelectWidget TabSelectWidget}.
3349 * Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}, which contain
3350 * {@link OO.ui.CardLayout card layouts}. See {@link OO.ui.IndexLayout IndexLayout}
3354 * @extends OO.ui.OptionWidget
3357 * @param {Object} [config] Configuration options
3359 OO
.ui
.TabOptionWidget
= function OoUiTabOptionWidget( config
) {
3360 // Configuration initialization
3361 config
= config
|| {};
3363 // Parent constructor
3364 OO
.ui
.TabOptionWidget
.parent
.call( this, config
);
3367 this.$element
.addClass( 'oo-ui-tabOptionWidget' );
3372 OO
.inheritClass( OO
.ui
.TabOptionWidget
, OO
.ui
.OptionWidget
);
3374 /* Static Properties */
3376 OO
.ui
.TabOptionWidget
.static.highlightable
= false;
3379 * TabSelectWidget is a list that contains {@link OO.ui.TabOptionWidget tab options}
3381 * **Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}.**
3384 * @extends OO.ui.SelectWidget
3385 * @mixins OO.ui.mixin.TabIndexedElement
3388 * @param {Object} [config] Configuration options
3390 OO
.ui
.TabSelectWidget
= function OoUiTabSelectWidget( config
) {
3391 // Parent constructor
3392 OO
.ui
.TabSelectWidget
.parent
.call( this, config
);
3394 // Mixin constructors
3395 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3399 focus
: this.bindKeyDownListener
.bind( this ),
3400 blur
: this.unbindKeyDownListener
.bind( this )
3404 this.$element
.addClass( 'oo-ui-tabSelectWidget' );
3409 OO
.inheritClass( OO
.ui
.TabSelectWidget
, OO
.ui
.SelectWidget
);
3410 OO
.mixinClass( OO
.ui
.TabSelectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3413 * CapsuleItemWidgets are used within a {@link OO.ui.CapsuleMultiselectWidget
3414 * CapsuleMultiselectWidget} to display the selected items.
3417 * @extends OO.ui.Widget
3418 * @mixins OO.ui.mixin.ItemWidget
3419 * @mixins OO.ui.mixin.LabelElement
3420 * @mixins OO.ui.mixin.FlaggedElement
3421 * @mixins OO.ui.mixin.TabIndexedElement
3424 * @param {Object} [config] Configuration options
3426 OO
.ui
.CapsuleItemWidget
= function OoUiCapsuleItemWidget( config
) {
3427 // Configuration initialization
3428 config
= config
|| {};
3430 // Parent constructor
3431 OO
.ui
.CapsuleItemWidget
.parent
.call( this, config
);
3433 // Mixin constructors
3434 OO
.ui
.mixin
.ItemWidget
.call( this );
3435 OO
.ui
.mixin
.LabelElement
.call( this, config
);
3436 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
3437 OO
.ui
.mixin
.TabIndexedElement
.call( this, config
);
3440 this.closeButton
= new OO
.ui
.ButtonWidget( {
3444 } ).on( 'click', this.onCloseClick
.bind( this ) );
3446 this.on( 'disable', function ( disabled
) {
3447 this.closeButton
.setDisabled( disabled
);
3453 click
: this.onClick
.bind( this ),
3454 keydown
: this.onKeyDown
.bind( this )
3456 .addClass( 'oo-ui-capsuleItemWidget' )
3457 .append( this.$label
, this.closeButton
.$element
);
3462 OO
.inheritClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.Widget
);
3463 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.ItemWidget
);
3464 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.LabelElement
);
3465 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.FlaggedElement
);
3466 OO
.mixinClass( OO
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3471 * Handle close icon clicks
3473 OO
.ui
.CapsuleItemWidget
.prototype.onCloseClick = function () {
3474 var element
= this.getElementGroup();
3476 if ( element
&& $.isFunction( element
.removeItems
) ) {
3477 element
.removeItems( [ this ] );
3483 * Handle click event for the entire capsule
3485 OO
.ui
.CapsuleItemWidget
.prototype.onClick = function () {
3486 var element
= this.getElementGroup();
3488 if ( !this.isDisabled() && element
&& $.isFunction( element
.editItem
) ) {
3489 element
.editItem( this );
3494 * Handle keyDown event for the entire capsule
3496 * @param {jQuery.Event} e Key down event
3498 OO
.ui
.CapsuleItemWidget
.prototype.onKeyDown = function ( e
) {
3499 var element
= this.getElementGroup();
3501 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
|| e
.keyCode
=== OO
.ui
.Keys
.DELETE
) {
3502 element
.removeItems( [ this ] );
3505 } else if ( e
.keyCode
=== OO
.ui
.Keys
.ENTER
) {
3506 element
.editItem( this );
3508 } else if ( e
.keyCode
=== OO
.ui
.Keys
.LEFT
) {
3509 element
.getPreviousItem( this ).focus();
3510 } else if ( e
.keyCode
=== OO
.ui
.Keys
.RIGHT
) {
3511 element
.getNextItem( this ).focus();
3516 * Focuses the capsule
3518 OO
.ui
.CapsuleItemWidget
.prototype.focus = function () {
3519 this.$element
.focus();
3523 * CapsuleMultiselectWidgets are something like a {@link OO.ui.ComboBoxInputWidget combo box widget}
3524 * that allows for selecting multiple values.
3526 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
3529 * // Example: A CapsuleMultiselectWidget.
3530 * var capsule = new OO.ui.CapsuleMultiselectWidget( {
3531 * label: 'CapsuleMultiselectWidget',
3532 * selected: [ 'Option 1', 'Option 3' ],
3535 * new OO.ui.MenuOptionWidget( {
3537 * label: 'Option One'
3539 * new OO.ui.MenuOptionWidget( {
3541 * label: 'Option Two'
3543 * new OO.ui.MenuOptionWidget( {
3545 * label: 'Option Three'
3547 * new OO.ui.MenuOptionWidget( {
3549 * label: 'Option Four'
3551 * new OO.ui.MenuOptionWidget( {
3553 * label: 'Option Five'
3558 * $( 'body' ).append( capsule.$element );
3560 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
3563 * @extends OO.ui.Widget
3564 * @mixins OO.ui.mixin.GroupElement
3565 * @mixins OO.ui.mixin.PopupElement
3566 * @mixins OO.ui.mixin.TabIndexedElement
3567 * @mixins OO.ui.mixin.IndicatorElement
3568 * @mixins OO.ui.mixin.IconElement
3569 * @uses OO.ui.CapsuleItemWidget
3570 * @uses OO.ui.FloatingMenuSelectWidget
3573 * @param {Object} [config] Configuration options
3574 * @cfg {string} [placeholder] Placeholder text
3575 * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if not present in the menu.
3576 * @cfg {Object} [menu] (required) Configuration options to pass to the
3577 * {@link OO.ui.MenuSelectWidget menu select widget}.
3578 * @cfg {Object} [popup] Configuration options to pass to the {@link OO.ui.PopupWidget popup widget}.
3579 * If specified, this popup will be shown instead of the menu (but the menu
3580 * will still be used for item labels and allowArbitrary=false). The widgets
3581 * in the popup should use {@link #addItemsFromData} or {@link #addItems} as necessary.
3582 * @cfg {jQuery} [$overlay=this.$element] Render the menu or popup into a separate layer.
3583 * This configuration is useful in cases where the expanded menu is larger than
3584 * its containing `<div>`. The specified overlay layer is usually on top of
3585 * the containing `<div>` and has a larger area. By default, the menu uses
3586 * relative positioning.
3588 OO
.ui
.CapsuleMultiselectWidget
= function OoUiCapsuleMultiselectWidget( config
) {
3591 // Parent constructor
3592 OO
.ui
.CapsuleMultiselectWidget
.parent
.call( this, config
);
3594 // Configuration initialization
3595 config
= $.extend( {
3596 allowArbitrary
: false,
3597 $overlay
: this.$element
3600 // Properties (must be set before mixin constructor calls)
3601 this.$handle
= $( '<div>' );
3602 this.$input
= config
.popup
? null : $( '<input>' );
3603 if ( config
.placeholder
!== undefined && config
.placeholder
!== '' ) {
3604 this.$input
.attr( 'placeholder', config
.placeholder
);
3607 // Mixin constructors
3608 OO
.ui
.mixin
.GroupElement
.call( this, config
);
3609 if ( config
.popup
) {
3610 config
.popup
= $.extend( {}, config
.popup
, {
3614 OO
.ui
.mixin
.PopupElement
.call( this, config
);
3615 $tabFocus
= $( '<span>' );
3616 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: $tabFocus
} ) );
3620 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$input
} ) );
3622 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
3623 OO
.ui
.mixin
.IconElement
.call( this, config
);
3626 this.$content
= $( '<div>' );
3627 this.allowArbitrary
= config
.allowArbitrary
;
3628 this.$overlay
= config
.$overlay
;
3629 this.menu
= new OO
.ui
.FloatingMenuSelectWidget( $.extend(
3632 $input
: this.$input
,
3633 $container
: this.$element
,
3634 filterFromInput
: true,
3635 disabled
: this.isDisabled()
3643 focus
: this.onFocusForPopup
.bind( this )
3645 this.popup
.$element
.on( 'focusout', this.onPopupFocusOut
.bind( this ) );
3646 if ( this.popup
.$autoCloseIgnore
) {
3647 this.popup
.$autoCloseIgnore
.on( 'focusout', this.onPopupFocusOut
.bind( this ) );
3649 this.popup
.connect( this, {
3650 toggle: function ( visible
) {
3651 $tabFocus
.toggle( !visible
);
3656 focus
: this.onInputFocus
.bind( this ),
3657 blur
: this.onInputBlur
.bind( this ),
3658 'propertychange change click mouseup keydown keyup input cut paste select focus':
3659 OO
.ui
.debounce( this.updateInputSize
.bind( this ) ),
3660 keydown
: this.onKeyDown
.bind( this ),
3661 keypress
: this.onKeyPress
.bind( this )
3664 this.menu
.connect( this, {
3665 choose
: 'onMenuChoose',
3666 toggle
: 'onMenuToggle',
3667 add
: 'onMenuItemsChange',
3668 remove
: 'onMenuItemsChange'
3671 mousedown
: this.onMouseDown
.bind( this )
3675 if ( this.$input
) {
3676 this.$input
.prop( 'disabled', this.isDisabled() );
3679 'aria-autocomplete': 'list'
3682 if ( config
.data
) {
3683 this.setItemsFromData( config
.data
);
3685 this.$content
.addClass( 'oo-ui-capsuleMultiselectWidget-content' )
3686 .append( this.$group
);
3687 this.$group
.addClass( 'oo-ui-capsuleMultiselectWidget-group' );
3688 this.$handle
.addClass( 'oo-ui-capsuleMultiselectWidget-handle' )
3689 .append( this.$indicator
, this.$icon
, this.$content
);
3690 this.$element
.addClass( 'oo-ui-capsuleMultiselectWidget' )
3691 .append( this.$handle
);
3693 this.$content
.append( $tabFocus
);
3694 this.$overlay
.append( this.popup
.$element
);
3696 this.$content
.append( this.$input
);
3697 this.$overlay
.append( this.menu
.$element
);
3700 // Input size needs to be calculated after everything else is rendered
3701 setTimeout( function () {
3702 if ( this.$input
) {
3703 this.updateInputSize();
3707 this.onMenuItemsChange();
3712 OO
.inheritClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.Widget
);
3713 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.GroupElement
);
3714 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.PopupElement
);
3715 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.TabIndexedElement
);
3716 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.IndicatorElement
);
3717 OO
.mixinClass( OO
.ui
.CapsuleMultiselectWidget
, OO
.ui
.mixin
.IconElement
);
3724 * A change event is emitted when the set of selected items changes.
3726 * @param {Mixed[]} datas Data of the now-selected items
3732 * A resize event is emitted when the widget's dimensions change to accomodate newly added items or
3733 * current user input.
3739 * Construct a OO.ui.CapsuleItemWidget (or a subclass thereof) from given label and data.
3740 * May return `null` if the given label and data are not valid.
3743 * @param {Mixed} data Custom data of any type.
3744 * @param {string} label The label text.
3745 * @return {OO.ui.CapsuleItemWidget|null}
3747 OO
.ui
.CapsuleMultiselectWidget
.prototype.createItemWidget = function ( data
, label
) {
3748 if ( label
=== '' ) {
3751 return new OO
.ui
.CapsuleItemWidget( { data
: data
, label
: label
} );
3755 * Get the data of the items in the capsule
3759 OO
.ui
.CapsuleMultiselectWidget
.prototype.getItemsData = function () {
3760 return this.getItems().map( function ( item
) {
3766 * Set the items in the capsule by providing data
3769 * @param {Mixed[]} datas
3770 * @return {OO.ui.CapsuleMultiselectWidget}
3772 OO
.ui
.CapsuleMultiselectWidget
.prototype.setItemsFromData = function ( datas
) {
3775 items
= this.getItems();
3777 $.each( datas
, function ( i
, data
) {
3779 item
= menu
.getItemFromData( data
);
3783 } else if ( widget
.allowArbitrary
) {
3784 label
= String( data
);
3790 for ( j
= 0; j
< items
.length
; j
++ ) {
3791 if ( items
[ j
].data
=== data
&& items
[ j
].label
=== label
) {
3793 items
.splice( j
, 1 );
3798 item
= widget
.createItemWidget( data
, label
);
3801 widget
.addItems( [ item
], i
);
3805 if ( items
.length
) {
3806 widget
.removeItems( items
);
3813 * Add items to the capsule by providing their data
3816 * @param {Mixed[]} datas
3817 * @return {OO.ui.CapsuleMultiselectWidget}
3819 OO
.ui
.CapsuleMultiselectWidget
.prototype.addItemsFromData = function ( datas
) {
3824 $.each( datas
, function ( i
, data
) {
3827 if ( !widget
.getItemFromData( data
) ) {
3828 item
= menu
.getItemFromData( data
);
3830 item
= widget
.createItemWidget( data
, item
.label
);
3831 } else if ( widget
.allowArbitrary
) {
3832 item
= widget
.createItemWidget( data
, String( data
) );
3840 if ( items
.length
) {
3841 this.addItems( items
);
3848 * Add items to the capsule by providing a label
3850 * @param {string} label
3851 * @return {boolean} Whether the item was added or not
3853 OO
.ui
.CapsuleMultiselectWidget
.prototype.addItemFromLabel = function ( label
) {
3855 item
= this.menu
.getItemFromLabel( label
, true );
3857 this.addItemsFromData( [ item
.data
] );
3859 } else if ( this.allowArbitrary
) {
3860 items
= this.getItems();
3861 this.addItemsFromData( [ label
] );
3862 return !OO
.compare( this.getItems(), items
);
3868 * Remove items by data
3871 * @param {Mixed[]} datas
3872 * @return {OO.ui.CapsuleMultiselectWidget}
3874 OO
.ui
.CapsuleMultiselectWidget
.prototype.removeItemsFromData = function ( datas
) {
3878 $.each( datas
, function ( i
, data
) {
3879 var item
= widget
.getItemFromData( data
);
3885 if ( items
.length
) {
3886 this.removeItems( items
);
3895 OO
.ui
.CapsuleMultiselectWidget
.prototype.addItems = function ( items
) {
3897 oldItems
= this.items
.slice();
3899 OO
.ui
.mixin
.GroupElement
.prototype.addItems
.call( this, items
);
3901 if ( this.items
.length
!== oldItems
.length
) {
3905 for ( i
= 0, l
= oldItems
.length
; same
&& i
< l
; i
++ ) {
3906 same
= same
&& this.items
[ i
] === oldItems
[ i
];
3910 this.emit( 'change', this.getItemsData() );
3911 this.updateIfHeightChanged();
3918 * Removes the item from the list and copies its label to `this.$input`.
3920 * @param {Object} item
3922 OO
.ui
.CapsuleMultiselectWidget
.prototype.editItem = function ( item
) {
3923 this.addItemFromLabel( this.$input
.val() );
3925 this.$input
.val( item
.label
);
3926 this.updateInputSize();
3928 this.menu
.updateItemVisibility(); // Hack, we shouldn't be calling this method directly
3929 this.removeItems( [ item
] );
3935 OO
.ui
.CapsuleMultiselectWidget
.prototype.removeItems = function ( items
) {
3937 oldItems
= this.items
.slice();
3939 OO
.ui
.mixin
.GroupElement
.prototype.removeItems
.call( this, items
);
3941 if ( this.items
.length
!== oldItems
.length
) {
3945 for ( i
= 0, l
= oldItems
.length
; same
&& i
< l
; i
++ ) {
3946 same
= same
&& this.items
[ i
] === oldItems
[ i
];
3950 this.emit( 'change', this.getItemsData() );
3951 this.updateIfHeightChanged();
3960 OO
.ui
.CapsuleMultiselectWidget
.prototype.clearItems = function () {
3961 if ( this.items
.length
) {
3962 OO
.ui
.mixin
.GroupElement
.prototype.clearItems
.call( this );
3963 this.emit( 'change', this.getItemsData() );
3964 this.updateIfHeightChanged();
3970 * Given an item, returns the item after it. If its the last item,
3971 * returns `this.$input`. If no item is passed, returns the very first
3974 * @param {OO.ui.CapsuleItemWidget} [item]
3975 * @return {OO.ui.CapsuleItemWidget|jQuery|boolean}
3977 OO
.ui
.CapsuleMultiselectWidget
.prototype.getNextItem = function ( item
) {
3980 if ( item
=== undefined ) {
3981 return this.items
[ 0 ];
3984 itemIndex
= this.items
.indexOf( item
);
3985 if ( itemIndex
< 0 ) { // Item not in list
3987 } else if ( itemIndex
=== this.items
.length
- 1 ) { // Last item
3990 return this.items
[ itemIndex
+ 1 ];
3995 * Given an item, returns the item before it. If its the first item,
3996 * returns `this.$input`. If no item is passed, returns the very last
3999 * @param {OO.ui.CapsuleItemWidget} [item]
4000 * @return {OO.ui.CapsuleItemWidget|jQuery|boolean}
4002 OO
.ui
.CapsuleMultiselectWidget
.prototype.getPreviousItem = function ( item
) {
4005 if ( item
=== undefined ) {
4006 return this.items
[ this.items
.length
- 1 ];
4009 itemIndex
= this.items
.indexOf( item
);
4010 if ( itemIndex
< 0 ) { // Item not in list
4012 } else if ( itemIndex
=== 0 ) { // First item
4015 return this.items
[ itemIndex
- 1 ];
4020 * Get the capsule widget's menu.
4022 * @return {OO.ui.MenuSelectWidget} Menu widget
4024 OO
.ui
.CapsuleMultiselectWidget
.prototype.getMenu = function () {
4029 * Handle focus events
4032 * @param {jQuery.Event} event
4034 OO
.ui
.CapsuleMultiselectWidget
.prototype.onInputFocus = function () {
4035 if ( !this.isDisabled() ) {
4036 this.menu
.toggle( true );
4041 * Handle blur events
4044 * @param {jQuery.Event} event
4046 OO
.ui
.CapsuleMultiselectWidget
.prototype.onInputBlur = function () {
4047 this.addItemFromLabel( this.$input
.val() );
4052 * Handle focus events
4055 * @param {jQuery.Event} event
4057 OO
.ui
.CapsuleMultiselectWidget
.prototype.onFocusForPopup = function () {
4058 if ( !this.isDisabled() ) {
4059 this.popup
.setSize( this.$handle
.width() );
4060 this.popup
.toggle( true );
4061 OO
.ui
.findFocusable( this.popup
.$element
).focus();
4066 * Handles popup focus out events.
4069 * @param {jQuery.Event} e Focus out event
4071 OO
.ui
.CapsuleMultiselectWidget
.prototype.onPopupFocusOut = function () {
4072 var widget
= this.popup
;
4074 setTimeout( function () {
4076 widget
.isVisible() &&
4077 !OO
.ui
.contains( widget
.$element
[ 0 ], document
.activeElement
, true ) &&
4078 ( !widget
.$autoCloseIgnore
|| !widget
.$autoCloseIgnore
.has( document
.activeElement
).length
)
4080 widget
.toggle( false );
4086 * Handle mouse down events.
4089 * @param {jQuery.Event} e Mouse down event
4091 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMouseDown = function ( e
) {
4092 if ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
) {
4096 this.updateInputSize();
4101 * Handle key press events.
4104 * @param {jQuery.Event} e Key press event
4106 OO
.ui
.CapsuleMultiselectWidget
.prototype.onKeyPress = function ( e
) {
4107 if ( !this.isDisabled() ) {
4108 if ( e
.which
=== OO
.ui
.Keys
.ESCAPE
) {
4113 if ( !this.popup
) {
4114 this.menu
.toggle( true );
4115 if ( e
.which
=== OO
.ui
.Keys
.ENTER
) {
4116 if ( this.addItemFromLabel( this.$input
.val() ) ) {
4122 // Make sure the input gets resized.
4123 setTimeout( this.updateInputSize
.bind( this ), 0 );
4129 * Handle key down events.
4132 * @param {jQuery.Event} e Key down event
4134 OO
.ui
.CapsuleMultiselectWidget
.prototype.onKeyDown = function ( e
) {
4136 !this.isDisabled() &&
4137 this.$input
.val() === '' &&
4140 // 'keypress' event is not triggered for Backspace
4141 if ( e
.keyCode
=== OO
.ui
.Keys
.BACKSPACE
) {
4142 if ( e
.metaKey
|| e
.ctrlKey
) {
4143 this.removeItems( this.items
.slice( -1 ) );
4145 this.editItem( this.items
[ this.items
.length
- 1 ] );
4148 } else if ( e
.keyCode
=== OO
.ui
.Keys
.LEFT
) {
4149 this.getPreviousItem().focus();
4150 } else if ( e
.keyCode
=== OO
.ui
.Keys
.RIGHT
) {
4151 this.getNextItem().focus();
4157 * Update the dimensions of the text input field to encompass all available area.
4160 * @param {jQuery.Event} e Event of some sort
4162 OO
.ui
.CapsuleMultiselectWidget
.prototype.updateInputSize = function () {
4163 var $lastItem
, direction
, contentWidth
, currentWidth
, bestWidth
;
4164 if ( this.$input
&& !this.isDisabled() ) {
4165 this.$input
.css( 'width', '1em' );
4166 $lastItem
= this.$group
.children().last();
4167 direction
= OO
.ui
.Element
.static.getDir( this.$handle
);
4169 // Get the width of the input with the placeholder text as
4170 // the value and save it so that we don't keep recalculating
4172 this.contentWidthWithPlaceholder
=== undefined &&
4173 this.$input
.val() === '' &&
4174 this.$input
.attr( 'placeholder' ) !== undefined
4176 this.$input
.val( this.$input
.attr( 'placeholder' ) );
4177 this.contentWidthWithPlaceholder
= this.$input
[ 0 ].scrollWidth
;
4178 this.$input
.val( '' );
4182 // Always keep the input wide enough for the placeholder text
4183 contentWidth
= Math
.max(
4184 this.$input
[ 0 ].scrollWidth
,
4185 // undefined arguments in Math.max lead to NaN
4186 ( this.contentWidthWithPlaceholder
=== undefined ) ?
4187 0 : this.contentWidthWithPlaceholder
4189 currentWidth
= this.$input
.width();
4191 if ( contentWidth
< currentWidth
) {
4192 // All is fine, don't perform expensive calculations
4196 if ( $lastItem
.length
=== 0 ) {
4197 bestWidth
= this.$content
.innerWidth();
4199 bestWidth
= direction
=== 'ltr' ?
4200 this.$content
.innerWidth() - $lastItem
.position().left
- $lastItem
.outerWidth() :
4201 $lastItem
.position().left
;
4204 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
4205 // pixels this is off by are coming from.
4207 if ( contentWidth
> bestWidth
) {
4208 // This will result in the input getting shifted to the next line
4209 bestWidth
= this.$content
.innerWidth() - 10;
4211 this.$input
.width( Math
.floor( bestWidth
) );
4212 this.updateIfHeightChanged();
4217 * Determine if widget height changed, and if so, update menu position and emit 'resize' event.
4221 OO
.ui
.CapsuleMultiselectWidget
.prototype.updateIfHeightChanged = function () {
4222 var height
= this.$element
.height();
4223 if ( height
!== this.height
) {
4224 this.height
= height
;
4225 this.menu
.position();
4226 this.emit( 'resize' );
4231 * Handle menu choose events.
4234 * @param {OO.ui.OptionWidget} item Chosen item
4236 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMenuChoose = function ( item
) {
4237 if ( item
&& item
.isVisible() ) {
4238 this.addItemsFromData( [ item
.getData() ] );
4244 * Handle menu toggle events.
4247 * @param {boolean} isVisible Menu toggle event
4249 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
4250 this.$element
.toggleClass( 'oo-ui-capsuleMultiselectWidget-open', isVisible
);
4254 * Handle menu item change events.
4258 OO
.ui
.CapsuleMultiselectWidget
.prototype.onMenuItemsChange = function () {
4259 this.setItemsFromData( this.getItemsData() );
4260 this.$element
.toggleClass( 'oo-ui-capsuleMultiselectWidget-empty', this.menu
.isEmpty() );
4264 * Clear the input field
4268 OO
.ui
.CapsuleMultiselectWidget
.prototype.clearInput = function () {
4269 if ( this.$input
) {
4270 this.$input
.val( '' );
4271 this.updateInputSize();
4274 this.popup
.toggle( false );
4276 this.menu
.toggle( false );
4277 this.menu
.selectItem();
4278 this.menu
.highlightItem();
4284 OO
.ui
.CapsuleMultiselectWidget
.prototype.setDisabled = function ( disabled
) {
4288 OO
.ui
.CapsuleMultiselectWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
4290 if ( this.$input
) {
4291 this.$input
.prop( 'disabled', this.isDisabled() );
4294 this.menu
.setDisabled( this.isDisabled() );
4297 this.popup
.setDisabled( this.isDisabled() );
4301 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
4302 this.items
[ i
].updateDisabled();
4313 * @return {OO.ui.CapsuleMultiselectWidget}
4315 OO
.ui
.CapsuleMultiselectWidget
.prototype.focus = function () {
4316 if ( !this.isDisabled() ) {
4318 this.popup
.setSize( this.$handle
.width() );
4319 this.popup
.toggle( true );
4320 OO
.ui
.findFocusable( this.popup
.$element
).focus();
4322 this.updateInputSize();
4323 this.menu
.toggle( true );
4324 this.$input
.focus();
4332 * @deprecated since 0.17.3; use OO.ui.CapsuleMultiselectWidget instead
4334 OO
.ui
.CapsuleMultiSelectWidget
= OO
.ui
.CapsuleMultiselectWidget
;
4337 * SelectFileWidgets allow for selecting files, using the HTML5 File API. These
4338 * widgets can be configured with {@link OO.ui.mixin.IconElement icons} and {@link
4339 * OO.ui.mixin.IndicatorElement indicators}.
4340 * Please see the [OOjs UI documentation on MediaWiki] [1] for more information and examples.
4343 * // Example of a file select widget
4344 * var selectFile = new OO.ui.SelectFileWidget();
4345 * $( 'body' ).append( selectFile.$element );
4347 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets
4350 * @extends OO.ui.Widget
4351 * @mixins OO.ui.mixin.IconElement
4352 * @mixins OO.ui.mixin.IndicatorElement
4353 * @mixins OO.ui.mixin.PendingElement
4354 * @mixins OO.ui.mixin.LabelElement
4357 * @param {Object} [config] Configuration options
4358 * @cfg {string[]|null} [accept=null] MIME types to accept. null accepts all types.
4359 * @cfg {string} [placeholder] Text to display when no file is selected.
4360 * @cfg {string} [notsupported] Text to display when file support is missing in the browser.
4361 * @cfg {boolean} [droppable=true] Whether to accept files by drag and drop.
4362 * @cfg {boolean} [showDropTarget=false] Whether to show a drop target. Requires droppable to be true.
4363 * @cfg {number} [thumbnailSizeLimit=20] File size limit in MiB above which to not try and show a
4364 * preview (for performance)
4366 OO
.ui
.SelectFileWidget
= function OoUiSelectFileWidget( config
) {
4369 // Configuration initialization
4370 config
= $.extend( {
4372 placeholder
: OO
.ui
.msg( 'ooui-selectfile-placeholder' ),
4373 notsupported
: OO
.ui
.msg( 'ooui-selectfile-not-supported' ),
4375 showDropTarget
: false,
4376 thumbnailSizeLimit
: 20
4379 // Parent constructor
4380 OO
.ui
.SelectFileWidget
.parent
.call( this, config
);
4382 // Mixin constructors
4383 OO
.ui
.mixin
.IconElement
.call( this, config
);
4384 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
4385 OO
.ui
.mixin
.PendingElement
.call( this, $.extend( {}, config
, { $pending
: this.$info
} ) );
4386 OO
.ui
.mixin
.LabelElement
.call( this, config
);
4389 this.$info
= $( '<span>' );
4390 this.showDropTarget
= config
.showDropTarget
;
4391 this.thumbnailSizeLimit
= config
.thumbnailSizeLimit
;
4392 this.isSupported
= this.constructor.static.isSupported();
4393 this.currentFile
= null;
4394 if ( Array
.isArray( config
.accept
) ) {
4395 this.accept
= config
.accept
;
4399 this.placeholder
= config
.placeholder
;
4400 this.notsupported
= config
.notsupported
;
4401 this.onFileSelectedHandler
= this.onFileSelected
.bind( this );
4403 this.selectButton
= new OO
.ui
.ButtonWidget( {
4404 classes
: [ 'oo-ui-selectFileWidget-selectButton' ],
4405 label
: OO
.ui
.msg( 'ooui-selectfile-button-select' ),
4406 disabled
: this.disabled
|| !this.isSupported
4409 this.clearButton
= new OO
.ui
.ButtonWidget( {
4410 classes
: [ 'oo-ui-selectFileWidget-clearButton' ],
4413 disabled
: this.disabled
4417 this.selectButton
.$button
.on( {
4418 keypress
: this.onKeyPress
.bind( this )
4420 this.clearButton
.connect( this, {
4421 click
: 'onClearClick'
4423 if ( config
.droppable
) {
4424 dragHandler
= this.onDragEnterOrOver
.bind( this );
4426 dragenter
: dragHandler
,
4427 dragover
: dragHandler
,
4428 dragleave
: this.onDragLeave
.bind( this ),
4429 drop
: this.onDrop
.bind( this )
4435 this.$label
.addClass( 'oo-ui-selectFileWidget-label' );
4437 .addClass( 'oo-ui-selectFileWidget-info' )
4438 .append( this.$icon
, this.$label
, this.clearButton
.$element
, this.$indicator
);
4440 if ( config
.droppable
&& config
.showDropTarget
) {
4441 this.selectButton
.setIcon( 'upload' );
4442 this.$thumbnail
= $( '<div>' ).addClass( 'oo-ui-selectFileWidget-thumbnail' );
4443 this.setPendingElement( this.$thumbnail
);
4445 .addClass( 'oo-ui-selectFileWidget-dropTarget oo-ui-selectFileWidget' )
4447 click
: this.onDropTargetClick
.bind( this )
4452 this.selectButton
.$element
,
4454 .addClass( 'oo-ui-selectFileWidget-dropLabel' )
4455 .text( OO
.ui
.msg( 'ooui-selectfile-dragdrop-placeholder' ) )
4459 .addClass( 'oo-ui-selectFileWidget' )
4460 .append( this.$info
, this.selectButton
.$element
);
4467 OO
.inheritClass( OO
.ui
.SelectFileWidget
, OO
.ui
.Widget
);
4468 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IconElement
);
4469 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.IndicatorElement
);
4470 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.PendingElement
);
4471 OO
.mixinClass( OO
.ui
.SelectFileWidget
, OO
.ui
.mixin
.LabelElement
);
4473 /* Static Properties */
4476 * Check if this widget is supported
4481 OO
.ui
.SelectFileWidget
.static.isSupported = function () {
4483 if ( OO
.ui
.SelectFileWidget
.static.isSupportedCache
=== null ) {
4484 $input
= $( '<input>' ).attr( 'type', 'file' );
4485 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= $input
[ 0 ].files
!== undefined;
4487 return OO
.ui
.SelectFileWidget
.static.isSupportedCache
;
4490 OO
.ui
.SelectFileWidget
.static.isSupportedCache
= null;
4497 * A change event is emitted when the on/off state of the toggle changes.
4499 * @param {File|null} value New value
4505 * Get the current value of the field
4507 * @return {File|null}
4509 OO
.ui
.SelectFileWidget
.prototype.getValue = function () {
4510 return this.currentFile
;
4514 * Set the current value of the field
4516 * @param {File|null} file File to select
4518 OO
.ui
.SelectFileWidget
.prototype.setValue = function ( file
) {
4519 if ( this.currentFile
!== file
) {
4520 this.currentFile
= file
;
4522 this.emit( 'change', this.currentFile
);
4529 * Focusses the select file button.
4533 OO
.ui
.SelectFileWidget
.prototype.focus = function () {
4534 this.selectButton
.$button
[ 0 ].focus();
4539 * Update the user interface when a file is selected or unselected
4543 OO
.ui
.SelectFileWidget
.prototype.updateUI = function () {
4545 if ( !this.isSupported
) {
4546 this.$element
.addClass( 'oo-ui-selectFileWidget-notsupported' );
4547 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
4548 this.setLabel( this.notsupported
);
4550 this.$element
.addClass( 'oo-ui-selectFileWidget-supported' );
4551 if ( this.currentFile
) {
4552 this.$element
.removeClass( 'oo-ui-selectFileWidget-empty' );
4554 $label
= $label
.add(
4556 .addClass( 'oo-ui-selectFileWidget-fileName' )
4557 .text( this.currentFile
.name
)
4559 this.setLabel( $label
);
4561 if ( this.showDropTarget
) {
4563 this.loadAndGetImageUrl().done( function ( url
) {
4564 this.$thumbnail
.css( 'background-image', 'url( ' + url
+ ' )' );
4565 }.bind( this ) ).fail( function () {
4566 this.$thumbnail
.append(
4567 new OO
.ui
.IconWidget( {
4569 classes
: [ 'oo-ui-selectFileWidget-noThumbnail-icon' ]
4572 }.bind( this ) ).always( function () {
4575 this.$element
.off( 'click' );
4578 if ( this.showDropTarget
) {
4579 this.$element
.off( 'click' );
4581 click
: this.onDropTargetClick
.bind( this )
4585 .css( 'background-image', '' );
4587 this.$element
.addClass( 'oo-ui-selectFileWidget-empty' );
4588 this.setLabel( this.placeholder
);
4594 * If the selected file is an image, get its URL and load it.
4596 * @return {jQuery.Promise} Promise resolves with the image URL after it has loaded
4598 OO
.ui
.SelectFileWidget
.prototype.loadAndGetImageUrl = function () {
4599 var deferred
= $.Deferred(),
4600 file
= this.currentFile
,
4601 reader
= new FileReader();
4605 ( OO
.getProp( file
, 'type' ) || '' ).indexOf( 'image/' ) === 0 &&
4606 file
.size
< this.thumbnailSizeLimit
* 1024 * 1024
4608 reader
.onload = function ( event
) {
4609 var img
= document
.createElement( 'img' );
4610 img
.addEventListener( 'load', function () {
4612 img
.naturalWidth
=== 0 ||
4613 img
.naturalHeight
=== 0 ||
4614 img
.complete
=== false
4618 deferred
.resolve( event
.target
.result
);
4621 img
.src
= event
.target
.result
;
4623 reader
.readAsDataURL( file
);
4628 return deferred
.promise();
4632 * Add the input to the widget
4636 OO
.ui
.SelectFileWidget
.prototype.addInput = function () {
4637 if ( this.$input
) {
4638 this.$input
.remove();
4641 if ( !this.isSupported
) {
4646 this.$input
= $( '<input>' ).attr( 'type', 'file' );
4647 this.$input
.on( 'change', this.onFileSelectedHandler
);
4648 this.$input
.on( 'click', function ( e
) {
4649 // Prevents dropTarget to get clicked which calls
4650 // a click on this input
4651 e
.stopPropagation();
4656 if ( this.accept
) {
4657 this.$input
.attr( 'accept', this.accept
.join( ', ' ) );
4659 this.selectButton
.$button
.append( this.$input
);
4663 * Determine if we should accept this file
4666 * @param {string} mimeType File MIME type
4669 OO
.ui
.SelectFileWidget
.prototype.isAllowedType = function ( mimeType
) {
4672 if ( !this.accept
|| !mimeType
) {
4676 for ( i
= 0; i
< this.accept
.length
; i
++ ) {
4677 mimeTest
= this.accept
[ i
];
4678 if ( mimeTest
=== mimeType
) {
4680 } else if ( mimeTest
.substr( -2 ) === '/*' ) {
4681 mimeTest
= mimeTest
.substr( 0, mimeTest
.length
- 1 );
4682 if ( mimeType
.substr( 0, mimeTest
.length
) === mimeTest
) {
4692 * Handle file selection from the input
4695 * @param {jQuery.Event} e
4697 OO
.ui
.SelectFileWidget
.prototype.onFileSelected = function ( e
) {
4698 var file
= OO
.getProp( e
.target
, 'files', 0 ) || null;
4700 if ( file
&& !this.isAllowedType( file
.type
) ) {
4704 this.setValue( file
);
4709 * Handle clear button click events.
4713 OO
.ui
.SelectFileWidget
.prototype.onClearClick = function () {
4714 this.setValue( null );
4719 * Handle key press events.
4722 * @param {jQuery.Event} e Key press event
4724 OO
.ui
.SelectFileWidget
.prototype.onKeyPress = function ( e
) {
4725 if ( this.isSupported
&& !this.isDisabled() && this.$input
&&
4726 ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
4728 this.$input
.click();
4734 * Handle drop target click events.
4737 * @param {jQuery.Event} e Key press event
4739 OO
.ui
.SelectFileWidget
.prototype.onDropTargetClick = function () {
4740 if ( this.isSupported
&& !this.isDisabled() && this.$input
) {
4741 this.$input
.click();
4747 * Handle drag enter and over events
4750 * @param {jQuery.Event} e Drag event
4752 OO
.ui
.SelectFileWidget
.prototype.onDragEnterOrOver = function ( e
) {
4754 droppableFile
= false,
4755 dt
= e
.originalEvent
.dataTransfer
;
4758 e
.stopPropagation();
4760 if ( this.isDisabled() || !this.isSupported
) {
4761 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
4762 dt
.dropEffect
= 'none';
4766 // DataTransferItem and File both have a type property, but in Chrome files
4767 // have no information at this point.
4768 itemOrFile
= OO
.getProp( dt
, 'items', 0 ) || OO
.getProp( dt
, 'files', 0 );
4770 if ( this.isAllowedType( itemOrFile
.type
) ) {
4771 droppableFile
= true;
4773 // dt.types is Array-like, but not an Array
4774 } else if ( Array
.prototype.indexOf
.call( OO
.getProp( dt
, 'types' ) || [], 'Files' ) !== -1 ) {
4775 // File information is not available at this point for security so just assume
4776 // it is acceptable for now.
4777 // https://bugzilla.mozilla.org/show_bug.cgi?id=640534
4778 droppableFile
= true;
4781 this.$element
.toggleClass( 'oo-ui-selectFileWidget-canDrop', droppableFile
);
4782 if ( !droppableFile
) {
4783 dt
.dropEffect
= 'none';
4790 * Handle drag leave events
4793 * @param {jQuery.Event} e Drag event
4795 OO
.ui
.SelectFileWidget
.prototype.onDragLeave = function () {
4796 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
4800 * Handle drop events
4803 * @param {jQuery.Event} e Drop event
4805 OO
.ui
.SelectFileWidget
.prototype.onDrop = function ( e
) {
4807 dt
= e
.originalEvent
.dataTransfer
;
4810 e
.stopPropagation();
4811 this.$element
.removeClass( 'oo-ui-selectFileWidget-canDrop' );
4813 if ( this.isDisabled() || !this.isSupported
) {
4817 file
= OO
.getProp( dt
, 'files', 0 );
4818 if ( file
&& !this.isAllowedType( file
.type
) ) {
4822 this.setValue( file
);
4831 OO
.ui
.SelectFileWidget
.prototype.setDisabled = function ( disabled
) {
4832 OO
.ui
.SelectFileWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
4833 if ( this.selectButton
) {
4834 this.selectButton
.setDisabled( disabled
);
4836 if ( this.clearButton
) {
4837 this.clearButton
.setDisabled( disabled
);
4843 * SearchWidgets combine a {@link OO.ui.TextInputWidget text input field}, where users can type a search query,
4844 * and a menu of search results, which is displayed beneath the query
4845 * field. Unlike {@link OO.ui.mixin.LookupElement lookup menus}, search result menus are always visible to the user.
4846 * Users can choose an item from the menu or type a query into the text field to search for a matching result item.
4847 * In general, search widgets are used inside a separate {@link OO.ui.Dialog dialog} window.
4849 * Each time the query is changed, the search result menu is cleared and repopulated. Please see
4850 * the [OOjs UI demos][1] for an example.
4852 * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/#dialogs-mediawiki-vector-ltr
4855 * @extends OO.ui.Widget
4858 * @param {Object} [config] Configuration options
4859 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
4860 * @cfg {string} [value] Initial query value
4862 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
4863 // Configuration initialization
4864 config
= config
|| {};
4866 // Parent constructor
4867 OO
.ui
.SearchWidget
.parent
.call( this, config
);
4870 this.query
= new OO
.ui
.TextInputWidget( {
4872 placeholder
: config
.placeholder
,
4875 this.results
= new OO
.ui
.SelectWidget();
4876 this.$query
= $( '<div>' );
4877 this.$results
= $( '<div>' );
4880 this.query
.connect( this, {
4881 change
: 'onQueryChange',
4882 enter
: 'onQueryEnter'
4884 this.query
.$input
.on( 'keydown', this.onQueryKeydown
.bind( this ) );
4888 .addClass( 'oo-ui-searchWidget-query' )
4889 .append( this.query
.$element
);
4891 .addClass( 'oo-ui-searchWidget-results' )
4892 .append( this.results
.$element
);
4894 .addClass( 'oo-ui-searchWidget' )
4895 .append( this.$results
, this.$query
);
4900 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
4905 * Handle query key down events.
4908 * @param {jQuery.Event} e Key down event
4910 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
4911 var highlightedItem
, nextItem
,
4912 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
4915 highlightedItem
= this.results
.getHighlightedItem();
4916 if ( !highlightedItem
) {
4917 highlightedItem
= this.results
.getSelectedItem();
4919 nextItem
= this.results
.getRelativeSelectableItem( highlightedItem
, dir
);
4920 this.results
.highlightItem( nextItem
);
4921 nextItem
.scrollElementIntoView();
4926 * Handle select widget select events.
4928 * Clears existing results. Subclasses should repopulate items according to new query.
4931 * @param {string} value New value
4933 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
4935 this.results
.clearItems();
4939 * Handle select widget enter key events.
4941 * Chooses highlighted item.
4944 * @param {string} value New value
4946 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
4947 var highlightedItem
= this.results
.getHighlightedItem();
4948 if ( highlightedItem
) {
4949 this.results
.chooseItem( highlightedItem
);
4954 * Get the query input.
4956 * @return {OO.ui.TextInputWidget} Query input
4958 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
4963 * Get the search results menu.
4965 * @return {OO.ui.SelectWidget} Menu of search results
4967 OO
.ui
.SearchWidget
.prototype.getResults = function () {
4968 return this.results
;
4972 * NumberInputWidgets combine a {@link OO.ui.TextInputWidget text input} (where a value
4973 * can be entered manually) and two {@link OO.ui.ButtonWidget button widgets}
4974 * (to adjust the value in increments) to allow the user to enter a number.
4977 * // Example: A NumberInputWidget.
4978 * var numberInput = new OO.ui.NumberInputWidget( {
4979 * label: 'NumberInputWidget',
4980 * input: { value: 5 },
4984 * $( 'body' ).append( numberInput.$element );
4987 * @extends OO.ui.Widget
4990 * @param {Object} [config] Configuration options
4991 * @cfg {Object} [input] Configuration options to pass to the {@link OO.ui.TextInputWidget text input widget}.
4992 * @cfg {Object} [minusButton] Configuration options to pass to the {@link OO.ui.ButtonWidget decrementing button widget}.
4993 * @cfg {Object} [plusButton] Configuration options to pass to the {@link OO.ui.ButtonWidget incrementing button widget}.
4994 * @cfg {boolean} [isInteger=false] Whether the field accepts only integer values.
4995 * @cfg {number} [min=-Infinity] Minimum allowed value
4996 * @cfg {number} [max=Infinity] Maximum allowed value
4997 * @cfg {number} [step=1] Delta when using the buttons or up/down arrow keys
4998 * @cfg {number|null} [pageStep] Delta when using the page-up/page-down keys. Defaults to 10 times #step.
4999 * @cfg {boolean} [showButtons=true] Whether to show the plus and minus buttons.
5001 OO
.ui
.NumberInputWidget
= function OoUiNumberInputWidget( config
) {
5002 // Configuration initialization
5003 config
= $.extend( {
5012 // Parent constructor
5013 OO
.ui
.NumberInputWidget
.parent
.call( this, config
);
5016 this.input
= new OO
.ui
.TextInputWidget( $.extend(
5018 disabled
: this.isDisabled(),
5023 if ( config
.showButtons
) {
5024 this.minusButton
= new OO
.ui
.ButtonWidget( $.extend(
5026 disabled
: this.isDisabled(),
5028 classes
: [ 'oo-ui-numberInputWidget-minusButton' ],
5033 this.plusButton
= new OO
.ui
.ButtonWidget( $.extend(
5035 disabled
: this.isDisabled(),
5037 classes
: [ 'oo-ui-numberInputWidget-plusButton' ],
5045 this.input
.connect( this, {
5046 change
: this.emit
.bind( this, 'change' ),
5047 enter
: this.emit
.bind( this, 'enter' )
5049 this.input
.$input
.on( {
5050 keydown
: this.onKeyDown
.bind( this ),
5051 'wheel mousewheel DOMMouseScroll': this.onWheel
.bind( this )
5053 if ( config
.showButtons
) {
5054 this.plusButton
.connect( this, {
5055 click
: [ 'onButtonClick', +1 ]
5057 this.minusButton
.connect( this, {
5058 click
: [ 'onButtonClick', -1 ]
5063 this.setIsInteger( !!config
.isInteger
);
5064 this.setRange( config
.min
, config
.max
);
5065 this.setStep( config
.step
, config
.pageStep
);
5067 this.$field
= $( '<div>' ).addClass( 'oo-ui-numberInputWidget-field' )
5068 .append( this.input
.$element
);
5069 this.$element
.addClass( 'oo-ui-numberInputWidget' ).append( this.$field
);
5070 if ( config
.showButtons
) {
5072 .prepend( this.minusButton
.$element
)
5073 .append( this.plusButton
.$element
);
5074 this.$element
.addClass( 'oo-ui-numberInputWidget-buttoned' );
5076 this.input
.setValidation( this.validateNumber
.bind( this ) );
5081 OO
.inheritClass( OO
.ui
.NumberInputWidget
, OO
.ui
.Widget
);
5086 * A `change` event is emitted when the value of the input changes.
5092 * An `enter` event is emitted when the user presses 'enter' inside the text box.
5100 * Set whether only integers are allowed
5102 * @param {boolean} flag
5104 OO
.ui
.NumberInputWidget
.prototype.setIsInteger = function ( flag
) {
5105 this.isInteger
= !!flag
;
5106 this.input
.setValidityFlag();
5110 * Get whether only integers are allowed
5112 * @return {boolean} Flag value
5114 OO
.ui
.NumberInputWidget
.prototype.getIsInteger = function () {
5115 return this.isInteger
;
5119 * Set the range of allowed values
5121 * @param {number} min Minimum allowed value
5122 * @param {number} max Maximum allowed value
5124 OO
.ui
.NumberInputWidget
.prototype.setRange = function ( min
, max
) {
5126 throw new Error( 'Minimum (' + min
+ ') must not be greater than maximum (' + max
+ ')' );
5130 this.input
.setValidityFlag();
5134 * Get the current range
5136 * @return {number[]} Minimum and maximum values
5138 OO
.ui
.NumberInputWidget
.prototype.getRange = function () {
5139 return [ this.min
, this.max
];
5143 * Set the stepping deltas
5145 * @param {number} step Normal step
5146 * @param {number|null} pageStep Page step. If null, 10 * step will be used.
5148 OO
.ui
.NumberInputWidget
.prototype.setStep = function ( step
, pageStep
) {
5150 throw new Error( 'Step value must be positive' );
5152 if ( pageStep
=== null ) {
5153 pageStep
= step
* 10;
5154 } else if ( pageStep
<= 0 ) {
5155 throw new Error( 'Page step value must be positive' );
5158 this.pageStep
= pageStep
;
5162 * Get the current stepping values
5164 * @return {number[]} Step and page step
5166 OO
.ui
.NumberInputWidget
.prototype.getStep = function () {
5167 return [ this.step
, this.pageStep
];
5171 * Get the current value of the widget
5175 OO
.ui
.NumberInputWidget
.prototype.getValue = function () {
5176 return this.input
.getValue();
5180 * Get the current value of the widget as a number
5182 * @return {number} May be NaN, or an invalid number
5184 OO
.ui
.NumberInputWidget
.prototype.getNumericValue = function () {
5185 return +this.input
.getValue();
5189 * Set the value of the widget
5191 * @param {string} value Invalid values are allowed
5193 OO
.ui
.NumberInputWidget
.prototype.setValue = function ( value
) {
5194 this.input
.setValue( value
);
5198 * Adjust the value of the widget
5200 * @param {number} delta Adjustment amount
5202 OO
.ui
.NumberInputWidget
.prototype.adjustValue = function ( delta
) {
5203 var n
, v
= this.getNumericValue();
5206 if ( isNaN( delta
) || !isFinite( delta
) ) {
5207 throw new Error( 'Delta must be a finite number' );
5214 n
= Math
.max( Math
.min( n
, this.max
), this.min
);
5215 if ( this.isInteger
) {
5216 n
= Math
.round( n
);
5229 * @param {string} value Field value
5232 OO
.ui
.NumberInputWidget
.prototype.validateNumber = function ( value
) {
5234 if ( isNaN( n
) || !isFinite( n
) ) {
5238 /* eslint-disable no-bitwise */
5239 if ( this.isInteger
&& ( n
| 0 ) !== n
) {
5242 /* eslint-enable no-bitwise */
5244 if ( n
< this.min
|| n
> this.max
) {
5252 * Handle mouse click events.
5255 * @param {number} dir +1 or -1
5257 OO
.ui
.NumberInputWidget
.prototype.onButtonClick = function ( dir
) {
5258 this.adjustValue( dir
* this.step
);
5262 * Handle mouse wheel events.
5265 * @param {jQuery.Event} event
5267 OO
.ui
.NumberInputWidget
.prototype.onWheel = function ( event
) {
5270 if ( !this.isDisabled() && this.input
.$input
.is( ':focus' ) ) {
5271 // Standard 'wheel' event
5272 if ( event
.originalEvent
.deltaMode
!== undefined ) {
5273 this.sawWheelEvent
= true;
5275 if ( event
.originalEvent
.deltaY
) {
5276 delta
= -event
.originalEvent
.deltaY
;
5277 } else if ( event
.originalEvent
.deltaX
) {
5278 delta
= event
.originalEvent
.deltaX
;
5281 // Non-standard events
5282 if ( !this.sawWheelEvent
) {
5283 if ( event
.originalEvent
.wheelDeltaX
) {
5284 delta
= -event
.originalEvent
.wheelDeltaX
;
5285 } else if ( event
.originalEvent
.wheelDeltaY
) {
5286 delta
= event
.originalEvent
.wheelDeltaY
;
5287 } else if ( event
.originalEvent
.wheelDelta
) {
5288 delta
= event
.originalEvent
.wheelDelta
;
5289 } else if ( event
.originalEvent
.detail
) {
5290 delta
= -event
.originalEvent
.detail
;
5295 delta
= delta
< 0 ? -1 : 1;
5296 this.adjustValue( delta
* this.step
);
5304 * Handle key down events.
5307 * @param {jQuery.Event} e Key down event
5309 OO
.ui
.NumberInputWidget
.prototype.onKeyDown = function ( e
) {
5310 if ( !this.isDisabled() ) {
5311 switch ( e
.which
) {
5313 this.adjustValue( this.step
);
5315 case OO
.ui
.Keys
.DOWN
:
5316 this.adjustValue( -this.step
);
5318 case OO
.ui
.Keys
.PAGEUP
:
5319 this.adjustValue( this.pageStep
);
5321 case OO
.ui
.Keys
.PAGEDOWN
:
5322 this.adjustValue( -this.pageStep
);
5331 OO
.ui
.NumberInputWidget
.prototype.setDisabled = function ( disabled
) {
5333 OO
.ui
.NumberInputWidget
.parent
.prototype.setDisabled
.call( this, disabled
);
5336 this.input
.setDisabled( this.isDisabled() );
5338 if ( this.minusButton
) {
5339 this.minusButton
.setDisabled( this.isDisabled() );
5341 if ( this.plusButton
) {
5342 this.plusButton
.setDisabled( this.isDisabled() );