resources/lib/oojs-ui/oojs-ui.js

   1 /*!
   2  * OOjs UI v0.1.0-pre (c5ae888f67)
   3  * https://www.mediawiki.org/wiki/OOjs_UI
   4  *
   5  * Copyright 2011–2014 OOjs Team and other contributors.
   6  * Released under the MIT license
   7  * http://oojs.mit-license.org
   8  *
   9  * Date: Wed Jun 11 2014 18:10:09 GMT-0700 (PDT)
  10  */
  11 ( function ( OO ) {
  12
  13 'use strict';
  14 /**
  15  * Namespace for all classes, static methods and static properties.
  16  *
  17  * @class
  18  * @singleton
  19  */
  20 OO.ui = {};
  21
  22 OO.ui.bind = $.proxy;
  23
  24 /**
  25  * @property {Object}
  26  */
  27 OO.ui.Keys = {
  28         'UNDEFINED': 0,
  29         'BACKSPACE': 8,
  30         'DELETE': 46,
  31         'LEFT': 37,
  32         'RIGHT': 39,
  33         'UP': 38,
  34         'DOWN': 40,
  35         'ENTER': 13,
  36         'END': 35,
  37         'HOME': 36,
  38         'TAB': 9,
  39         'PAGEUP': 33,
  40         'PAGEDOWN': 34,
  41         'ESCAPE': 27,
  42         'SHIFT': 16,
  43         'SPACE': 32
  44 };
  45
  46 /**
  47  * Get the user's language and any fallback languages.
  48  *
  49  * These language codes are used to localize user interface elements in the user's language.
  50  *
  51  * In environments that provide a localization system, this function should be overridden to
  52  * return the user's language(s). The default implementation returns English (en) only.
  53  *
  54  * @return {string[]} Language codes, in descending order of priority
  55  */
  56 OO.ui.getUserLanguages = function () {
  57         return [ 'en' ];
  58 };
  59
  60 /**
  61  * Get a value in an object keyed by language code.
  62  *
  63  * @param {Object.<string,Mixed>} obj Object keyed by language code
  64  * @param {string|null} [lang] Language code, if omitted or null defaults to any user language
  65  * @param {string} [fallback] Fallback code, used if no matching language can be found
  66  * @return {Mixed} Local value
  67  */
  68 OO.ui.getLocalValue = function ( obj, lang, fallback ) {
  69         var i, len, langs;
  70
  71         // Requested language
  72         if ( obj[lang] ) {
  73                 return obj[lang];
  74         }
  75         // Known user language
  76         langs = OO.ui.getUserLanguages();
  77         for ( i = 0, len = langs.length; i < len; i++ ) {
  78                 lang = langs[i];
  79                 if ( obj[lang] ) {
  80                         return obj[lang];
  81                 }
  82         }
  83         // Fallback language
  84         if ( obj[fallback] ) {
  85                 return obj[fallback];
  86         }
  87         // First existing language
  88         for ( lang in obj ) {
  89                 return obj[lang];
  90         }
  91
  92         return undefined;
  93 };
  94
  95 ( function () {
  96
  97 /**
  98  * Message store for the default implementation of OO.ui.msg
  99  *
 100  * Environments that provide a localization system should not use this, but should override
 101  * OO.ui.msg altogether.
 102  *
 103  * @private
 104  */
 105 var messages = {
 106         // Label text for button to exit from dialog
 107         'ooui-dialog-action-close': 'Close',
 108         // Tool tip for a button that moves items in a list down one place
 109         'ooui-outline-control-move-down': 'Move item down',
 110         // Tool tip for a button that moves items in a list up one place
 111         'ooui-outline-control-move-up': 'Move item up',
 112         // Tool tip for a button that removes items from a list
 113         'ooui-outline-control-remove': 'Remove item',
 114         // Label for the toolbar group that contains a list of all other available tools
 115         'ooui-toolbar-more': 'More',
 116
 117         // Label for the generic dialog used to confirm things
 118         'ooui-dialog-confirm-title': 'Confirm',
 119         // The default prompt of a confirmation dialog
 120         'ooui-dialog-confirm-default-prompt': 'Are you sure?',
 121         // The default OK button text on a confirmation dialog
 122         'ooui-dialog-confirm-default-ok': 'OK',
 123         // The default cancel button text on a confirmation dialog
 124         'ooui-dialog-confirm-default-cancel': 'Cancel'
 125 };
 126
 127 /**
 128  * Get a localized message.
 129  *
 130  * In environments that provide a localization system, this function should be overridden to
 131  * return the message translated in the user's language. The default implementation always returns
 132  * English messages.
 133  *
 134  * After the message key, message parameters may optionally be passed. In the default implementation,
 135  * any occurrences of $1 are replaced with the first parameter, $2 with the second parameter, etc.
 136  * Alternative implementations of OO.ui.msg may use any substitution system they like, as long as
 137  * they support unnamed, ordered message parameters.
 138  *
 139  * @abstract
 140  * @param {string} key Message key
 141  * @param {Mixed...} [params] Message parameters
 142  * @return {string} Translated message with parameters substituted
 143  */
 144 OO.ui.msg = function ( key ) {
 145         var message = messages[key], params = Array.prototype.slice.call( arguments, 1 );
 146         if ( typeof message === 'string' ) {
 147                 // Perform $1 substitution
 148                 message = message.replace( /\$(\d+)/g, function ( unused, n ) {
 149                         var i = parseInt( n, 10 );
 150                         return params[i - 1] !== undefined ? params[i - 1] : '$' + n;
 151                 } );
 152         } else {
 153                 // Return placeholder if message not found
 154                 message = '[' + key + ']';
 155         }
 156         return message;
 157 };
 158
 159 /** */
 160 OO.ui.deferMsg = function ( key ) {
 161         return function () {
 162                 return OO.ui.msg( key );
 163         };
 164 };
 165
 166 /** */
 167 OO.ui.resolveMsg = function ( msg ) {
 168         if ( $.isFunction( msg ) ) {
 169                 return msg();
 170         }
 171         return msg;
 172 };
 173
 174 } )();
 175 /**
 176  * DOM element abstraction.
 177  *
 178  * @abstract
 179  * @class
 180  *
 181  * @constructor
 182  * @param {Object} [config] Configuration options
 183  * @cfg {Function} [$] jQuery for the frame the widget is in
 184  * @cfg {string[]} [classes] CSS class names
 185  * @cfg {string} [text] Text to insert
 186  * @cfg {jQuery} [$content] Content elements to append (after text)
 187  */
 188 OO.ui.Element = function OoUiElement( config ) {
 189         // Configuration initialization
 190         config = config || {};
 191
 192         // Properties
 193         this.$ = config.$ || OO.ui.Element.getJQuery( document );
 194         this.$element = this.$( this.$.context.createElement( this.getTagName() ) );
 195         this.elementGroup = null;
 196
 197         // Initialization
 198         if ( $.isArray( config.classes ) ) {
 199                 this.$element.addClass( config.classes.join( ' ' ) );
 200         }
 201         if ( config.text ) {
 202                 this.$element.text( config.text );
 203         }
 204         if ( config.$content ) {
 205                 this.$element.append( config.$content );
 206         }
 207 };
 208
 209 /* Setup */
 210
 211 OO.initClass( OO.ui.Element );
 212
 213 /* Static Properties */
 214
 215 /**
 216  * HTML tag name.
 217  *
 218  * This may be ignored if getTagName is overridden.
 219  *
 220  * @static
 221  * @inheritable
 222  * @property {string}
 223  */
 224 OO.ui.Element.static.tagName = 'div';
 225
 226 /* Static Methods */
 227
 228 /**
 229  * Get a jQuery function within a specific document.
 230  *
 231  * @static
 232  * @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
 233  * @param {OO.ui.Frame} [frame] Frame of the document context
 234  * @return {Function} Bound jQuery function
 235  */
 236 OO.ui.Element.getJQuery = function ( context, frame ) {
 237         function wrapper( selector ) {
 238                 return $( selector, wrapper.context );
 239         }
 240
 241         wrapper.context = this.getDocument( context );
 242
 243         if ( frame ) {
 244                 wrapper.frame = frame;
 245         }
 246
 247         return wrapper;
 248 };
 249
 250 /**
 251  * Get the document of an element.
 252  *
 253  * @static
 254  * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Object to get the document for
 255  * @return {HTMLDocument|null} Document object
 256  */
 257 OO.ui.Element.getDocument = function ( obj ) {
 258         // jQuery - selections created "offscreen" won't have a context, so .context isn't reliable
 259         return ( obj[0] && obj[0].ownerDocument ) ||
 260                 // Empty jQuery selections might have a context
 261                 obj.context ||
 262                 // HTMLElement
 263                 obj.ownerDocument ||
 264                 // Window
 265                 obj.document ||
 266                 // HTMLDocument
 267                 ( obj.nodeType === 9 && obj ) ||
 268                 null;
 269 };
 270
 271 /**
 272  * Get the window of an element or document.
 273  *
 274  * @static
 275  * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the window for
 276  * @return {Window} Window object
 277  */
 278 OO.ui.Element.getWindow = function ( obj ) {
 279         var doc = this.getDocument( obj );
 280         return doc.parentWindow || doc.defaultView;
 281 };
 282
 283 /**
 284  * Get the direction of an element or document.
 285  *
 286  * @static
 287  * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the direction for
 288  * @return {string} Text direction, either `ltr` or `rtl`
 289  */
 290 OO.ui.Element.getDir = function ( obj ) {
 291         var isDoc, isWin;
 292
 293         if ( obj instanceof jQuery ) {
 294                 obj = obj[0];
 295         }
 296         isDoc = obj.nodeType === 9;
 297         isWin = obj.document !== undefined;
 298         if ( isDoc || isWin ) {
 299                 if ( isWin ) {
 300                         obj = obj.document;
 301                 }
 302                 obj = obj.body;
 303         }
 304         return $( obj ).css( 'direction' );
 305 };
 306
 307 /**
 308  * Get the offset between two frames.
 309  *
 310  * TODO: Make this function not use recursion.
 311  *
 312  * @static
 313  * @param {Window} from Window of the child frame
 314  * @param {Window} [to=window] Window of the parent frame
 315  * @param {Object} [offset] Offset to start with, used internally
 316  * @return {Object} Offset object, containing left and top properties
 317  */
 318 OO.ui.Element.getFrameOffset = function ( from, to, offset ) {
 319         var i, len, frames, frame, rect;
 320
 321         if ( !to ) {
 322                 to = window;
 323         }
 324         if ( !offset ) {
 325                 offset = { 'top': 0, 'left': 0 };
 326         }
 327         if ( from.parent === from ) {
 328                 return offset;
 329         }
 330
 331         // Get iframe element
 332         frames = from.parent.document.getElementsByTagName( 'iframe' );
 333         for ( i = 0, len = frames.length; i < len; i++ ) {
 334                 if ( frames[i].contentWindow === from ) {
 335                         frame = frames[i];
 336                         break;
 337                 }
 338         }
 339
 340         // Recursively accumulate offset values
 341         if ( frame ) {
 342                 rect = frame.getBoundingClientRect();
 343                 offset.left += rect.left;
 344                 offset.top += rect.top;
 345                 if ( from !== to ) {
 346                         this.getFrameOffset( from.parent, offset );
 347                 }
 348         }
 349         return offset;
 350 };
 351
 352 /**
 353  * Get the offset between two elements.
 354  *
 355  * @static
 356  * @param {jQuery} $from
 357  * @param {jQuery} $to
 358  * @return {Object} Translated position coordinates, containing top and left properties
 359  */
 360 OO.ui.Element.getRelativePosition = function ( $from, $to ) {
 361         var from = $from.offset(),
 362                 to = $to.offset();
 363         return { 'top': Math.round( from.top - to.top ), 'left': Math.round( from.left - to.left ) };
 364 };
 365
 366 /**
 367  * Get element border sizes.
 368  *
 369  * @static
 370  * @param {HTMLElement} el Element to measure
 371  * @return {Object} Dimensions object with `top`, `left`, `bottom` and `right` properties
 372  */
 373 OO.ui.Element.getBorders = function ( el ) {
 374         var doc = el.ownerDocument,
 375                 win = doc.parentWindow || doc.defaultView,
 376                 style = win && win.getComputedStyle ?
 377                         win.getComputedStyle( el, null ) :
 378                         el.currentStyle,
 379                 $el = $( el ),
 380                 top = parseFloat( style ? style.borderTopWidth : $el.css( 'borderTopWidth' ) ) || 0,
 381                 left = parseFloat( style ? style.borderLeftWidth : $el.css( 'borderLeftWidth' ) ) || 0,
 382                 bottom = parseFloat( style ? style.borderBottomWidth : $el.css( 'borderBottomWidth' ) ) || 0,
 383                 right = parseFloat( style ? style.borderRightWidth : $el.css( 'borderRightWidth' ) ) || 0;
 384
 385         return {
 386                 'top': Math.round( top ),
 387                 'left': Math.round( left ),
 388                 'bottom': Math.round( bottom ),
 389                 'right': Math.round( right )
 390         };
 391 };
 392
 393 /**
 394  * Get dimensions of an element or window.
 395  *
 396  * @static
 397  * @param {HTMLElement|Window} el Element to measure
 398  * @return {Object} Dimensions object with `borders`, `scroll`, `scrollbar` and `rect` properties
 399  */
 400 OO.ui.Element.getDimensions = function ( el ) {
 401         var $el, $win,
 402                 doc = el.ownerDocument || el.document,
 403                 win = doc.parentWindow || doc.defaultView;
 404
 405         if ( win === el || el === doc.documentElement ) {
 406                 $win = $( win );
 407                 return {
 408                         'borders': { 'top': 0, 'left': 0, 'bottom': 0, 'right': 0 },
 409                         'scroll': {
 410                                 'top': $win.scrollTop(),
 411                                 'left': $win.scrollLeft()
 412                         },
 413                         'scrollbar': { 'right': 0, 'bottom': 0 },
 414                         'rect': {
 415                                 'top': 0,
 416                                 'left': 0,
 417                                 'bottom': $win.innerHeight(),
 418                                 'right': $win.innerWidth()
 419                         }
 420                 };
 421         } else {
 422                 $el = $( el );
 423                 return {
 424                         'borders': this.getBorders( el ),
 425                         'scroll': {
 426                                 'top': $el.scrollTop(),
 427                                 'left': $el.scrollLeft()
 428                         },
 429                         'scrollbar': {
 430                                 'right': $el.innerWidth() - el.clientWidth,
 431                                 'bottom': $el.innerHeight() - el.clientHeight
 432                         },
 433                         'rect': el.getBoundingClientRect()
 434                 };
 435         }
 436 };
 437
 438 /**
 439  * Get closest scrollable container.
 440  *
 441  * Traverses up until either a scrollable element or the root is reached, in which case the window
 442  * will be returned.
 443  *
 444  * @static
 445  * @param {HTMLElement} el Element to find scrollable container for
 446  * @param {string} [dimension] Dimension of scrolling to look for; `x`, `y` or omit for either
 447  * @return {HTMLElement|Window} Closest scrollable container
 448  */
 449 OO.ui.Element.getClosestScrollableContainer = function ( el, dimension ) {
 450         var i, val,
 451                 props = [ 'overflow' ],
 452                 $parent = $( el ).parent();
 453
 454         if ( dimension === 'x' || dimension === 'y' ) {
 455                 props.push( 'overflow-' + dimension );
 456         }
 457
 458         while ( $parent.length ) {
 459                 if ( $parent[0] === el.ownerDocument.body ) {
 460                         return $parent[0];
 461                 }
 462                 i = props.length;
 463                 while ( i-- ) {
 464                         val = $parent.css( props[i] );
 465                         if ( val === 'auto' || val === 'scroll' ) {
 466                                 return $parent[0];
 467                         }
 468                 }
 469                 $parent = $parent.parent();
 470         }
 471         return this.getDocument( el ).body;
 472 };
 473
 474 /**
 475  * Scroll element into view.
 476  *
 477  * @static
 478  * @param {HTMLElement} el Element to scroll into view
 479  * @param {Object} [config={}] Configuration config
 480  * @param {string} [config.duration] jQuery animation duration value
 481  * @param {string} [config.direction] Scroll in only one direction, e.g. 'x' or 'y', omit
 482  *  to scroll in both directions
 483  * @param {Function} [config.complete] Function to call when scrolling completes
 484  */
 485 OO.ui.Element.scrollIntoView = function ( el, config ) {
 486         // Configuration initialization
 487         config = config || {};
 488
 489         var anim = {},
 490                 callback = typeof config.complete === 'function' && config.complete,
 491                 sc = this.getClosestScrollableContainer( el, config.direction ),
 492                 $sc = $( sc ),
 493                 eld = this.getDimensions( el ),
 494                 scd = this.getDimensions( sc ),
 495                 rel = {
 496                         'top': eld.rect.top - ( scd.rect.top + scd.borders.top ),
 497                         'bottom': scd.rect.bottom - scd.borders.bottom - scd.scrollbar.bottom - eld.rect.bottom,
 498                         'left': eld.rect.left - ( scd.rect.left + scd.borders.left ),
 499                         'right': scd.rect.right - scd.borders.right - scd.scrollbar.right - eld.rect.right
 500                 };
 501
 502         if ( !config.direction || config.direction === 'y' ) {
 503                 if ( rel.top < 0 ) {
 504                         anim.scrollTop = scd.scroll.top + rel.top;
 505                 } else if ( rel.top > 0 && rel.bottom < 0 ) {
 506                         anim.scrollTop = scd.scroll.top + Math.min( rel.top, -rel.bottom );
 507                 }
 508         }
 509         if ( !config.direction || config.direction === 'x' ) {
 510                 if ( rel.left < 0 ) {
 511                         anim.scrollLeft = scd.scroll.left + rel.left;
 512                 } else if ( rel.left > 0 && rel.right < 0 ) {
 513                         anim.scrollLeft = scd.scroll.left + Math.min( rel.left, -rel.right );
 514                 }
 515         }
 516         if ( !$.isEmptyObject( anim ) ) {
 517                 $sc.stop( true ).animate( anim, config.duration || 'fast' );
 518                 if ( callback ) {
 519                         $sc.queue( function ( next ) {
 520                                 callback();
 521                                 next();
 522                         } );
 523                 }
 524         } else {
 525                 if ( callback ) {
 526                         callback();
 527                 }
 528         }
 529 };
 530
 531 /* Methods */
 532
 533 /**
 534  * Get the HTML tag name.
 535  *
 536  * Override this method to base the result on instance information.
 537  *
 538  * @return {string} HTML tag name
 539  */
 540 OO.ui.Element.prototype.getTagName = function () {
 541         return this.constructor.static.tagName;
 542 };
 543
 544 /**
 545  * Check if the element is attached to the DOM
 546  * @return {boolean} The element is attached to the DOM
 547  */
 548 OO.ui.Element.prototype.isElementAttached = function () {
 549         return $.contains( this.getElementDocument(), this.$element[0] );
 550 };
 551
 552 /**
 553  * Get the DOM document.
 554  *
 555  * @return {HTMLDocument} Document object
 556  */
 557 OO.ui.Element.prototype.getElementDocument = function () {
 558         return OO.ui.Element.getDocument( this.$element );
 559 };
 560
 561 /**
 562  * Get the DOM window.
 563  *
 564  * @return {Window} Window object
 565  */
 566 OO.ui.Element.prototype.getElementWindow = function () {
 567         return OO.ui.Element.getWindow( this.$element );
 568 };
 569
 570 /**
 571  * Get closest scrollable container.
 572  */
 573 OO.ui.Element.prototype.getClosestScrollableElementContainer = function () {
 574         return OO.ui.Element.getClosestScrollableContainer( this.$element[0] );
 575 };
 576
 577 /**
 578  * Get group element is in.
 579  *
 580  * @return {OO.ui.GroupElement|null} Group element, null if none
 581  */
 582 OO.ui.Element.prototype.getElementGroup = function () {
 583         return this.elementGroup;
 584 };
 585
 586 /**
 587  * Set group element is in.
 588  *
 589  * @param {OO.ui.GroupElement|null} group Group element, null if none
 590  * @chainable
 591  */
 592 OO.ui.Element.prototype.setElementGroup = function ( group ) {
 593         this.elementGroup = group;
 594         return this;
 595 };
 596
 597 /**
 598  * Scroll element into view.
 599  *
 600  * @param {Object} [config={}]
 601  */
 602 OO.ui.Element.prototype.scrollElementIntoView = function ( config ) {
 603         return OO.ui.Element.scrollIntoView( this.$element[0], config );
 604 };
 605
 606 /**
 607  * Bind a handler for an event on this.$element
 608  *
 609  * @param {string} event
 610  * @param {Function} callback
 611  */
 612 OO.ui.Element.prototype.onDOMEvent = function ( event, callback ) {
 613         OO.ui.Element.onDOMEvent( this.$element, event, callback );
 614 };
 615
 616 /**
 617  * Unbind a handler bound with #offDOMEvent
 618  *
 619  * @param {string} event
 620  * @param {Function} callback
 621  */
 622 OO.ui.Element.prototype.offDOMEvent = function ( event, callback ) {
 623         OO.ui.Element.offDOMEvent( this.$element, event, callback );
 624 };
 625
 626 ( function () {
 627         // Static
 628
 629         // jQuery 1.8.3 has a bug with handling focusin/focusout events inside iframes.
 630         // Firefox doesn't support focusin/focusout at all, so we listen for 'focus'/'blur' on the
 631         // document, and simulate a 'focusin'/'focusout' event on the target element and make
 632         // it bubble from there.
 633         //
 634         // - http://jsfiddle.net/sw3hr/
 635         // - http://bugs.jquery.com/ticket/14180
 636         // - https://github.com/jquery/jquery/commit/1cecf64e5aa4153
 637         function specialEvent( simulatedName, realName ) {
 638                 function handler( e ) {
 639                         jQuery.event.simulate(
 640                                 simulatedName,
 641                                 e.target,
 642                                 jQuery.event.fix( e ),
 643                                 /* bubble = */ true
 644                         );
 645                 }
 646
 647                 return {
 648                         setup: function () {
 649                                 var doc = this.ownerDocument || this,
 650                                         attaches = $.data( doc, 'ooui-' + simulatedName + '-attaches' );
 651                                 if ( !attaches ) {
 652                                         doc.addEventListener( realName, handler, true );
 653                                 }
 654                                 $.data( doc, 'ooui-' + simulatedName + '-attaches', ( attaches || 0 ) + 1 );
 655                         },
 656                         teardown: function () {
 657                                 var doc = this.ownerDocument || this,
 658                                         attaches = $.data( doc, 'ooui-' + simulatedName + '-attaches' ) - 1;
 659                                 if ( !attaches ) {
 660                                         doc.removeEventListener( realName, handler, true );
 661                                         $.removeData( doc, 'ooui-' + simulatedName + '-attaches' );
 662                                 } else {
 663                                         $.data( doc, 'ooui-' + simulatedName + '-attaches', attaches );
 664                                 }
 665                         }
 666                 };
 667         }
 668
 669         var hasOwn = Object.prototype.hasOwnProperty,
 670                 specialEvents = {
 671                         focusin: specialEvent( 'focusin', 'focus' ),
 672                         focusout: specialEvent( 'focusout', 'blur' )
 673                 };
 674
 675         /**
 676          * Bind a handler for an event on a DOM element.
 677          *
 678          * Uses jQuery internally for everything except for events which are
 679          * known to have issues in the browser or in jQuery. This method
 680          * should become obsolete eventually.
 681          *
 682          * @static
 683          * @param {HTMLElement|jQuery} el DOM element
 684          * @param {string} event Event to bind
 685          * @param {Function} callback Callback to call when the event fires
 686          */
 687         OO.ui.Element.onDOMEvent = function ( el, event, callback ) {
 688                 var orig;
 689
 690                 if ( hasOwn.call( specialEvents, event ) ) {
 691                         // Replace jQuery's override with our own
 692                         orig = $.event.special[event];
 693                         $.event.special[event] = specialEvents[event];
 694
 695                         $( el ).on( event, callback );
 696
 697                         // Restore
 698                         $.event.special[event] = orig;
 699                 } else {
 700                         $( el ).on( event, callback );
 701                 }
 702         };
 703
 704         /**
 705          * Unbind a handler bound with #static-method-onDOMEvent.
 706          *
 707          * @static
 708          * @param {HTMLElement|jQuery} el DOM element
 709          * @param {string} event Event to unbind
 710          * @param {Function} [callback] Callback to unbind
 711          */
 712         OO.ui.Element.offDOMEvent = function ( el, event, callback ) {
 713                 var orig;
 714                 if ( hasOwn.call( specialEvents, event ) ) {
 715                         // Replace jQuery's override with our own
 716                         orig = $.event.special[event];
 717                         $.event.special[event] = specialEvents[event];
 718
 719                         $( el ).off( event, callback );
 720
 721                         // Restore
 722                         $.event.special[event] = orig;
 723                 } else {
 724                         $( el ).off( event, callback );
 725                 }
 726         };
 727 }() );
 728 /**
 729  * Embedded iframe with the same styles as its parent.
 730  *
 731  * @class
 732  * @extends OO.ui.Element
 733  * @mixins OO.EventEmitter
 734  *
 735  * @constructor
 736  * @param {Object} [config] Configuration options
 737  */
 738 OO.ui.Frame = function OoUiFrame( config ) {
 739         // Parent constructor
 740         OO.ui.Frame.super.call( this, config );
 741
 742         // Mixin constructors
 743         OO.EventEmitter.call( this );
 744
 745         // Properties
 746         this.loading = null;
 747         this.config = config;
 748
 749         // Initialize
 750         this.$element
 751                 .addClass( 'oo-ui-frame' )
 752                 .attr( { 'frameborder': 0, 'scrolling': 'no' } );
 753
 754 };
 755
 756 /* Setup */
 757
 758 OO.inheritClass( OO.ui.Frame, OO.ui.Element );
 759 OO.mixinClass( OO.ui.Frame, OO.EventEmitter );
 760
 761 /* Static Properties */
 762
 763 /**
 764  * @static
 765  * @inheritdoc
 766  */
 767 OO.ui.Frame.static.tagName = 'iframe';
 768
 769 /* Events */
 770
 771 /**
 772  * @event load
 773  */
 774
 775 /* Static Methods */
 776
 777 /**
 778  * Transplant the CSS styles from as parent document to a frame's document.
 779  *
 780  * This loops over the style sheets in the parent document, and copies their nodes to the
 781  * frame's document. It then polls the document to see when all styles have loaded, and once they
 782  * have, resolves the promise.
 783  *
 784  * If the styles still haven't loaded after a long time (5 seconds by default), we give up waiting
 785  * and resolve the promise anyway. This protects against cases like a display: none; iframe in
 786  * Firefox, where the styles won't load until the iframe becomes visible.
 787  *
 788  * For details of how we arrived at the strategy used in this function, see #load.
 789  *
 790  * @static
 791  * @inheritable
 792  * @param {HTMLDocument} parentDoc Document to transplant styles from
 793  * @param {HTMLDocument} frameDoc Document to transplant styles to
 794  * @param {number} [timeout=5000] How long to wait before giving up (in ms). If 0, never give up.
 795  * @return {jQuery.Promise} Promise resolved when styles have loaded
 796  */
 797 OO.ui.Frame.static.transplantStyles = function ( parentDoc, frameDoc, timeout ) {
 798         var i, numSheets, styleNode, newNode, timeoutID, pollNodeId, $pendingPollNodes,
 799                 $pollNodes = $( [] ),
 800                 // Fake font-family value
 801                 fontFamily = 'oo-ui-frame-transplantStyles-loaded',
 802                 deferred = $.Deferred();
 803
 804         for ( i = 0, numSheets = parentDoc.styleSheets.length; i < numSheets; i++ ) {
 805                 styleNode = parentDoc.styleSheets[i].ownerNode;
 806                 if ( styleNode.nodeName.toLowerCase() === 'link' ) {
 807                         // External stylesheet
 808                         // Create a node with a unique ID that we're going to monitor to see when the CSS
 809                         // has loaded
 810                         pollNodeId = 'oo-ui-frame-transplantStyles-loaded-' + i;
 811                         $pollNodes = $pollNodes.add( $( '<div>', frameDoc )
 812                                 .attr( 'id', pollNodeId )
 813                                 .appendTo( frameDoc.body )
 814                         );
 815
 816                         // Add <style>@import url(...); #pollNodeId { font-family: ... }</style>
 817                         // The font-family rule will only take effect once the @import finishes
 818                         newNode = frameDoc.createElement( 'style' );
 819                         newNode.textContent = '@import url(' + styleNode.href + ');\n' +
 820                                 '#' + pollNodeId + ' { font-family: ' + fontFamily + '; }';
 821                 } else {
 822                         // Not an external stylesheet, or no polling required; just copy the node over
 823                         newNode = frameDoc.importNode( styleNode, true );
 824                 }
 825                 frameDoc.head.appendChild( newNode );
 826         }
 827
 828         // Poll every 100ms until all external stylesheets have loaded
 829         $pendingPollNodes = $pollNodes;
 830         timeoutID = setTimeout( function pollExternalStylesheets() {
 831                 while (
 832                         $pendingPollNodes.length > 0 &&
 833                         $pendingPollNodes.eq( 0 ).css( 'font-family' ) === fontFamily
 834                 ) {
 835                         $pendingPollNodes = $pendingPollNodes.slice( 1 );
 836                 }
 837
 838                 if ( $pendingPollNodes.length === 0 ) {
 839                         // We're done!
 840                         if ( timeoutID !== null ) {
 841                                 timeoutID = null;
 842                                 $pollNodes.remove();
 843                                 deferred.resolve();
 844                         }
 845                 } else {
 846                         timeoutID = setTimeout( pollExternalStylesheets, 100 );
 847                 }
 848         }, 100 );
 849         // ...but give up after a while
 850         if ( timeout !== 0 ) {
 851                 setTimeout( function () {
 852                         if ( timeoutID ) {
 853                                 clearTimeout( timeoutID );
 854                                 timeoutID = null;
 855                                 $pollNodes.remove();
 856                                 deferred.reject();
 857                         }
 858                 }, timeout || 5000 );
 859         }
 860
 861         return deferred.promise();
 862 };
 863
 864 /* Methods */
 865
 866 /**
 867  * Load the frame contents.
 868  *
 869  * Once the iframe's stylesheets are loaded, the `load` event will be emitted and the returned
 870  * promise will be resolved. Calling while loading will return a promise but not trigger a new
 871  * loading cycle. Calling after loading is complete will return a promise that's already been
 872  * resolved.
 873  *
 874  * Sounds simple right? Read on...
 875  *
 876  * When you create a dynamic iframe using open/write/close, the window.load event for the
 877  * iframe is triggered when you call close, and there's no further load event to indicate that
 878  * everything is actually loaded.
 879  *
 880  * In Chrome, stylesheets don't show up in document.styleSheets until they have loaded, so we could
 881  * just poll that array and wait for it to have the right length. However, in Firefox, stylesheets
 882  * are added to document.styleSheets immediately, and the only way you can determine whether they've
 883  * loaded is to attempt to access .cssRules and wait for that to stop throwing an exception. But
 884  * cross-domain stylesheets never allow .cssRules to be accessed even after they have loaded.
 885  *
 886  * The workaround is to change all `<link href="...">` tags to `<style>@import url(...)</style>` tags.
 887  * Because `@import` is blocking, Chrome won't add the stylesheet to document.styleSheets until
 888  * the `@import` has finished, and Firefox won't allow .cssRules to be accessed until the `@import`
 889  * has finished. And because the contents of the `<style>` tag are from the same origin, accessing
 890  * .cssRules is allowed.
 891  *
 892  * However, now that we control the styles we're injecting, we might as well do away with
 893  * browser-specific polling hacks like document.styleSheets and .cssRules, and instead inject
 894  * `<style>@import url(...); #foo { font-family: someValue; }</style>`, then create `<div id="foo">`
 895  * and wait for its font-family to change to someValue. Because `@import` is blocking, the font-family
 896  * rule is not applied until after the `@import` finishes.
 897  *
 898  * All this stylesheet injection and polling magic is in #transplantStyles.
 899  *
 900  * @return {jQuery.Promise} Promise resolved when loading is complete
 901  * @fires load
 902  */
 903 OO.ui.Frame.prototype.load = function () {
 904         var win, doc;
 905
 906         // Return existing promise if already loading or loaded
 907         if ( this.loading ) {
 908                 return this.loading.promise();
 909         }
 910
 911         // Load the frame
 912         this.loading = $.Deferred();
 913
 914         win = this.$element.prop( 'contentWindow' );
 915         doc = win.document;
 916
 917         // Figure out directionality:
 918         this.dir = OO.ui.Element.getDir( this.$element ) || 'ltr';
 919
 920         // Initialize contents
 921         doc.open();
 922         doc.write(
 923                 '<!doctype html>' +
 924                 '<html>' +
 925                         '<body class="oo-ui-frame-body oo-ui-' + this.dir + '" style="direction:' + this.dir + ';" dir="' + this.dir + '">' +
 926                                 '<div class="oo-ui-frame-content"></div>' +
 927                         '</body>' +
 928                 '</html>'
 929         );
 930         doc.close();
 931
 932         // Properties
 933         this.$ = OO.ui.Element.getJQuery( doc, this );
 934         this.$content = this.$( '.oo-ui-frame-content' ).attr( 'tabIndex', 0 );
 935         this.$document = this.$( doc );
 936
 937         // Initialization
 938         this.constructor.static.transplantStyles( this.getElementDocument(), this.$document[0] )
 939                 .always( OO.ui.bind( function () {
 940                         this.emit( 'load' );
 941                         this.loading.resolve();
 942                 }, this ) );
 943
 944         return this.loading.promise();
 945 };
 946
 947 /**
 948  * Set the size of the frame.
 949  *
 950  * @param {number} width Frame width in pixels
 951  * @param {number} height Frame height in pixels
 952  * @chainable
 953  */
 954 OO.ui.Frame.prototype.setSize = function ( width, height ) {
 955         this.$element.css( { 'width': width, 'height': height } );
 956         return this;
 957 };
 958 /**
 959  * Container for elements in a child frame.
 960  *
 961  * There are two ways to specify a title: set the static `title` property or provide a `title`
 962  * property in the configuration options. The latter will override the former.
 963  *
 964  * @abstract
 965  * @class
 966  * @extends OO.ui.Element
 967  * @mixins OO.EventEmitter
 968  *
 969  * @constructor
 970  * @param {Object} [config] Configuration options
 971  * @cfg {string|Function} [title] Title string or function that returns a string
 972  * @cfg {string} [icon] Symbolic name of icon
 973  * @fires initialize
 974  */
 975 OO.ui.Window = function OoUiWindow( config ) {
 976         var element = this;
 977         // Parent constructor
 978         OO.ui.Window.super.call( this, config );
 979
 980         // Mixin constructors
 981         OO.EventEmitter.call( this );
 982
 983         // Properties
 984         this.visible = false;
 985         this.opening = null;
 986         this.closing = null;
 987         this.opened = null;
 988         this.title = OO.ui.resolveMsg( config.title || this.constructor.static.title );
 989         this.icon = config.icon || this.constructor.static.icon;
 990         this.frame = new OO.ui.Frame( { '$': this.$ } );
 991         this.$frame = this.$( '<div>' );
 992         this.$ = function () {
 993                 throw new Error( 'this.$() cannot be used until the frame has been initialized.' );
 994         };
 995
 996         // Initialization
 997         this.$element
 998                 .addClass( 'oo-ui-window' )
 999                 // Hide the window using visibility: hidden; while the iframe is still loading
1000                 // Can't use display: none; because that prevents the iframe from loading in Firefox
1001                 .css( 'visibility', 'hidden' )
1002                 .append( this.$frame );
1003         this.$frame
1004                 .addClass( 'oo-ui-window-frame' )
1005                 .append( this.frame.$element );
1006
1007         // Events
1008         this.frame.on( 'load', function () {
1009                 element.initialize();
1010                 // Undo the visibility: hidden; hack and apply display: none;
1011                 // We can do this safely now that the iframe has initialized
1012                 // (don't do this from within #initialize because it has to happen
1013                 // after the all subclasses have been handled as well).
1014                 element.$element.hide().css( 'visibility', '' );
1015         } );
1016 };
1017
1018 /* Setup */
1019
1020 OO.inheritClass( OO.ui.Window, OO.ui.Element );
1021 OO.mixinClass( OO.ui.Window, OO.EventEmitter );
1022
1023 /* Events */
1024
1025 /**
1026  * Window is setup.
1027  *
1028  * Fired after the setup process has been executed.
1029  *
1030  * @event setup
1031  * @param {Object} data Window opening data
1032  */
1033
1034 /**
1035  * Window is ready.
1036  *
1037  * Fired after the ready process has been executed.
1038  *
1039  * @event ready
1040  * @param {Object} data Window opening data
1041  */
1042
1043 /**
1044  * Window is torn down
1045  *
1046  * Fired after the teardown process has been executed.
1047  *
1048  * @event teardown
1049  * @param {Object} data Window closing data
1050  */
1051
1052 /* Static Properties */
1053
1054 /**
1055  * Symbolic name of icon.
1056  *
1057  * @static
1058  * @inheritable
1059  * @property {string}
1060  */
1061 OO.ui.Window.static.icon = 'window';
1062
1063 /**
1064  * Window title.
1065  *
1066  * Subclasses must implement this property before instantiating the window.
1067  * Alternatively, override #getTitle with an alternative implementation.
1068  *
1069  * @static
1070  * @abstract
1071  * @inheritable
1072  * @property {string|Function} Title string or function that returns a string
1073  */
1074 OO.ui.Window.static.title = null;
1075
1076 /* Methods */
1077
1078 /**
1079  * Check if window is visible.
1080  *
1081  * @return {boolean} Window is visible
1082  */
1083 OO.ui.Window.prototype.isVisible = function () {
1084         return this.visible;
1085 };
1086
1087 /**
1088  * Check if window is opening.
1089  *
1090  * @return {boolean} Window is opening
1091  */
1092 OO.ui.Window.prototype.isOpening = function () {
1093         return !!this.opening && this.opening.state() === 'pending';
1094 };
1095
1096 /**
1097  * Check if window is closing.
1098  *
1099  * @return {boolean} Window is closing
1100  */
1101 OO.ui.Window.prototype.isClosing = function () {
1102         return !!this.closing && this.closing.state() === 'pending';
1103 };
1104
1105 /**
1106  * Check if window is opened.
1107  *
1108  * @return {boolean} Window is opened
1109  */
1110 OO.ui.Window.prototype.isOpened = function () {
1111         return !!this.opened && this.opened.state() === 'pending';
1112 };
1113
1114 /**
1115  * Get the window frame.
1116  *
1117  * @return {OO.ui.Frame} Frame of window
1118  */
1119 OO.ui.Window.prototype.getFrame = function () {
1120         return this.frame;
1121 };
1122
1123 /**
1124  * Get the title of the window.
1125  *
1126  * @return {string} Title text
1127  */
1128 OO.ui.Window.prototype.getTitle = function () {
1129         return this.title;
1130 };
1131
1132 /**
1133  * Get the window icon.
1134  *
1135  * @return {string} Symbolic name of icon
1136  */
1137 OO.ui.Window.prototype.getIcon = function () {
1138         return this.icon;
1139 };
1140
1141 /**
1142  * Set the size of window frame.
1143  *
1144  * @param {number} [width=auto] Custom width
1145  * @param {number} [height=auto] Custom height
1146  * @chainable
1147  */
1148 OO.ui.Window.prototype.setSize = function ( width, height ) {
1149         if ( !this.frame.$content ) {
1150                 return;
1151         }
1152
1153         this.frame.$element.css( {
1154                 'width': width === undefined ? 'auto' : width,
1155                 'height': height === undefined ? 'auto' : height
1156         } );
1157
1158         return this;
1159 };
1160
1161 /**
1162  * Set the title of the window.
1163  *
1164  * @param {string|Function} title Title text or a function that returns text
1165  * @chainable
1166  */
1167 OO.ui.Window.prototype.setTitle = function ( title ) {
1168         this.title = OO.ui.resolveMsg( title );
1169         if ( this.$title ) {
1170                 this.$title.text( title );
1171         }
1172         return this;
1173 };
1174
1175 /**
1176  * Set the icon of the window.
1177  *
1178  * @param {string} icon Symbolic name of icon
1179  * @chainable
1180  */
1181 OO.ui.Window.prototype.setIcon = function ( icon ) {
1182         if ( this.$icon ) {
1183                 this.$icon.removeClass( 'oo-ui-icon-' + this.icon );
1184         }
1185         this.icon = icon;
1186         if ( this.$icon ) {
1187                 this.$icon.addClass( 'oo-ui-icon-' + this.icon );
1188         }
1189
1190         return this;
1191 };
1192
1193 /**
1194  * Set the position of window to fit with contents.
1195  *
1196  * @param {string} left Left offset
1197  * @param {string} top Top offset
1198  * @chainable
1199  */
1200 OO.ui.Window.prototype.setPosition = function ( left, top ) {
1201         this.$element.css( { 'left': left, 'top': top } );
1202         return this;
1203 };
1204
1205 /**
1206  * Set the height of window to fit with contents.
1207  *
1208  * @param {number} [min=0] Min height
1209  * @param {number} [max] Max height (defaults to content's outer height)
1210  * @chainable
1211  */
1212 OO.ui.Window.prototype.fitHeightToContents = function ( min, max ) {
1213         var height = this.frame.$content.outerHeight();
1214
1215         this.frame.$element.css(
1216                 'height', Math.max( min || 0, max === undefined ? height : Math.min( max, height ) )
1217         );
1218
1219         return this;
1220 };
1221
1222 /**
1223  * Set the width of window to fit with contents.
1224  *
1225  * @param {number} [min=0] Min height
1226  * @param {number} [max] Max height (defaults to content's outer width)
1227  * @chainable
1228  */
1229 OO.ui.Window.prototype.fitWidthToContents = function ( min, max ) {
1230         var width = this.frame.$content.outerWidth();
1231
1232         this.frame.$element.css(
1233                 'width', Math.max( min || 0, max === undefined ? width : Math.min( max, width ) )
1234         );
1235
1236         return this;
1237 };
1238
1239 /**
1240  * Initialize window contents.
1241  *
1242  * The first time the window is opened, #initialize is called when it's safe to begin populating
1243  * its contents. See #setup for a way to make changes each time the window opens.
1244  *
1245  * Once this method is called, this.$$ can be used to create elements within the frame.
1246  *
1247  * @chainable
1248  */
1249 OO.ui.Window.prototype.initialize = function () {
1250         // Properties
1251         this.$ = this.frame.$;
1252         this.$title = this.$( '<div class="oo-ui-window-title"></div>' )
1253                 .text( this.title );
1254         this.$icon = this.$( '<div class="oo-ui-window-icon"></div>' )
1255                 .addClass( 'oo-ui-icon-' + this.icon );
1256         this.$head = this.$( '<div class="oo-ui-window-head"></div>' );
1257         this.$body = this.$( '<div class="oo-ui-window-body"></div>' );
1258         this.$foot = this.$( '<div class="oo-ui-window-foot"></div>' );
1259         this.$overlay = this.$( '<div class="oo-ui-window-overlay"></div>' );
1260
1261         // Initialization
1262         this.frame.$content.append(
1263                 this.$head.append( this.$icon, this.$title ),
1264                 this.$body,
1265                 this.$foot,
1266                 this.$overlay
1267         );
1268
1269         return this;
1270 };
1271
1272 /**
1273  * Get a process for setting up a window for use.
1274  *
1275  * Each time the window is opened this process will set it up for use in a particular context, based
1276  * on the `data` argument.
1277  *
1278  * When you override this method, you can add additional setup steps to the process the parent
1279  * method provides using the 'first' and 'next' methods.
1280  *
1281  * @abstract
1282  * @param {Object} [data] Window opening data
1283  * @return {OO.ui.Process} Setup process
1284  */
1285 OO.ui.Window.prototype.getSetupProcess = function () {
1286         return new OO.ui.Process();
1287 };
1288
1289 /**
1290  * Get a process for readying a window for use.
1291  *
1292  * Each time the window is open and setup, this process will ready it up for use in a particular
1293  * context, based on the `data` argument.
1294  *
1295  * When you override this method, you can add additional setup steps to the process the parent
1296  * method provides using the 'first' and 'next' methods.
1297  *
1298  * @abstract
1299  * @param {Object} [data] Window opening data
1300  * @return {OO.ui.Process} Setup process
1301  */
1302 OO.ui.Window.prototype.getReadyProcess = function () {
1303         return new OO.ui.Process();
1304 };
1305
1306 /**
1307  * Get a process for tearing down a window after use.
1308  *
1309  * Each time the window is closed this process will tear it down and do something with the user's
1310  * interactions within the window, based on the `data` argument.
1311  *
1312  * When you override this method, you can add additional teardown steps to the process the parent
1313  * method provides using the 'first' and 'next' methods.
1314  *
1315  * @abstract
1316  * @param {Object} [data] Window closing data
1317  * @return {OO.ui.Process} Teardown process
1318  */
1319 OO.ui.Window.prototype.getTeardownProcess = function () {
1320         return new OO.ui.Process();
1321 };
1322
1323 /**
1324  * Open window.
1325  *
1326  * Do not override this method. Use #getSetupProcess to do something each time the window closes.
1327  *
1328  * @param {Object} [data] Window opening data
1329  * @fires initialize
1330  * @fires opening
1331  * @fires open
1332  * @fires ready
1333  * @return {jQuery.Promise} Promise resolved when window is opened; when the promise is resolved the
1334  *   first argument will be a promise which will be resolved when the window begins closing
1335  */
1336 OO.ui.Window.prototype.open = function ( data ) {
1337         // Return existing promise if already opening or open
1338         if ( this.opening ) {
1339                 return this.opening.promise();
1340         }
1341
1342         // Open the window
1343         this.opening = $.Deferred();
1344         this.frame.load().done( OO.ui.bind( function () {
1345                 this.$element.show();
1346                 this.visible = true;
1347                 this.getSetupProcess( data ).execute().done( OO.ui.bind( function () {
1348                         this.$element.addClass( 'oo-ui-window-setup' );
1349                         this.emit( 'setup', data );
1350                         setTimeout( OO.ui.bind( function () {
1351                                 this.frame.$content.focus();
1352                                 this.getReadyProcess( data ).execute().done( OO.ui.bind( function () {
1353                                         this.$element.addClass( 'oo-ui-window-ready' );
1354                                         this.emit( 'ready', data );
1355                                         this.opened = $.Deferred();
1356                                         // Now that we are totally done opening, it's safe to allow closing
1357                                         this.closing = null;
1358                                         this.opening.resolve( this.opened.promise() );
1359                                 }, this ) );
1360                         }, this ) );
1361                 }, this ) );
1362         }, this ) );
1363
1364         return this.opening.promise();
1365 };
1366
1367 /**
1368  * Close window.
1369  *
1370  * Do not override this method. Use #getTeardownProcess to do something each time the window closes.
1371  *
1372  * @param {Object} [data] Window closing data
1373  * @fires closing
1374  * @fires close
1375  * @return {jQuery.Promise} Promise resolved when window is closed
1376  */
1377 OO.ui.Window.prototype.close = function ( data ) {
1378         var close;
1379
1380         // Return existing promise if already closing or closed
1381         if ( this.closing ) {
1382                 return this.closing.promise();
1383         }
1384
1385         // Close after opening is done if opening is in progress
1386         if ( this.opening && this.opening.state() === 'pending' ) {
1387                 close = OO.ui.bind( function () {
1388                         return this.close( data );
1389                 }, this );
1390                 return this.opening.then( close, close );
1391         }
1392
1393         // Close the window
1394         // This.closing needs to exist before we emit the closing event so that handlers can call
1395         // window.close() and trigger the safety check above
1396         this.closing = $.Deferred();
1397         this.frame.$content.find( ':focus' ).blur();
1398         this.$element.removeClass( 'oo-ui-window-ready' );
1399         this.getTeardownProcess( data ).execute().done( OO.ui.bind( function () {
1400                 this.$element.removeClass( 'oo-ui-window-setup' );
1401                 this.emit( 'teardown', data );
1402                 // To do something different with #opened, resolve/reject #opened in the teardown process
1403                 if ( this.opened && this.opened.state() === 'pending' ) {
1404                         this.opened.resolve();
1405                 }
1406                 this.$element.hide();
1407                 this.visible = false;
1408                 this.closing.resolve();
1409                 // Now that we are totally done closing, it's safe to allow opening
1410                 this.opening = null;
1411         }, this ) );
1412
1413         return this.closing.promise();
1414 };
1415 /**
1416  * Set of mutually exclusive windows.
1417  *
1418  * @class
1419  * @extends OO.ui.Element
1420  * @mixins OO.EventEmitter
1421  *
1422  * @constructor
1423  * @param {OO.Factory} factory Window factory
1424  * @param {Object} [config] Configuration options
1425  */
1426 OO.ui.WindowSet = function OoUiWindowSet( factory, config ) {
1427         // Parent constructor
1428         OO.ui.WindowSet.super.call( this, config );
1429
1430         // Mixin constructors
1431         OO.EventEmitter.call( this );
1432
1433         // Properties
1434         this.factory = factory;
1435
1436         /**
1437          * List of all windows associated with this window set.
1438          *
1439          * @property {OO.ui.Window[]}
1440          */
1441         this.windowList = [];
1442
1443         /**
1444          * Mapping of OO.ui.Window objects created by name from the #factory.
1445          *
1446          * @property {Object}
1447          */
1448         this.windows = {};
1449         this.currentWindow = null;
1450
1451         // Initialization
1452         this.$element.addClass( 'oo-ui-windowSet' );
1453 };
1454
1455 /* Setup */
1456
1457 OO.inheritClass( OO.ui.WindowSet, OO.ui.Element );
1458 OO.mixinClass( OO.ui.WindowSet, OO.EventEmitter );
1459
1460 /* Events */
1461
1462 /**
1463  * @event setup
1464  * @param {OO.ui.Window} win Window that's been setup
1465  * @param {Object} config Window opening information
1466  */
1467
1468 /**
1469  * @event ready
1470  * @param {OO.ui.Window} win Window that's ready
1471  * @param {Object} config Window opening information
1472  */
1473
1474 /**
1475  * @event teardown
1476  * @param {OO.ui.Window} win Window that's been torn down
1477  * @param {Object} config Window closing information
1478  */
1479
1480 /* Methods */
1481
1482 /**
1483  * Handle a window setup event.
1484  *
1485  * @param {OO.ui.Window} win Window that's been setup
1486  * @param {Object} [config] Window opening information
1487  * @fires setup
1488  */
1489 OO.ui.WindowSet.prototype.onWindowSetup = function ( win, config ) {
1490         if ( this.currentWindow && this.currentWindow !== win ) {
1491                 this.currentWindow.close();
1492         }
1493         this.currentWindow = win;
1494         this.emit( 'setup', win, config );
1495 };
1496
1497 /**
1498  * Handle a window ready event.
1499  *
1500  * @param {OO.ui.Window} win Window that's ready
1501  * @param {Object} [config] Window opening information
1502  * @fires ready
1503  */
1504 OO.ui.WindowSet.prototype.onWindowReady = function ( win, config ) {
1505         this.emit( 'ready', win, config );
1506 };
1507
1508 /**
1509  * Handle a window teardown event.
1510  *
1511  * @param {OO.ui.Window} win Window that's been torn down
1512  * @param {Object} [config] Window closing information
1513  * @fires teardown
1514  */
1515 OO.ui.WindowSet.prototype.onWindowTeardown = function ( win, config ) {
1516         this.currentWindow = null;
1517         this.emit( 'teardown', win, config );
1518 };
1519
1520 /**
1521  * Get the current window.
1522  *
1523  * @return {OO.ui.Window|null} Current window or null if none open
1524  */
1525 OO.ui.WindowSet.prototype.getCurrentWindow = function () {
1526         return this.currentWindow;
1527 };
1528
1529 /**
1530  * Return a given window.
1531  *
1532  * @param {string} name Symbolic name of window
1533  * @return {OO.ui.Window} Window with specified name
1534  */
1535 OO.ui.WindowSet.prototype.getWindow = function ( name ) {
1536         var win;
1537
1538         if ( !this.factory.lookup( name ) ) {
1539                 throw new Error( 'Unknown window: ' + name );
1540         }
1541         if ( !( name in this.windows ) ) {
1542                 win = this.windows[name] = this.createWindow( name );
1543                 this.addWindow( win );
1544         }
1545         return this.windows[name];
1546 };
1547
1548 /**
1549  * Create a window for use in this window set.
1550  *
1551  * @param {string} name Symbolic name of window
1552  * @return {OO.ui.Window} Window with specified name
1553  */
1554 OO.ui.WindowSet.prototype.createWindow = function ( name ) {
1555         return this.factory.create( name, { '$': this.$ } );
1556 };
1557
1558 /**
1559  * Add a given window to this window set.
1560  *
1561  * Connects event handlers and attaches it to the DOM. Calling
1562  * OO.ui.Window#open will not work until the window is added to the set.
1563  *
1564  * @param {OO.ui.Window} win Window to add
1565  */
1566 OO.ui.WindowSet.prototype.addWindow = function ( win ) {
1567         if ( this.windowList.indexOf( win ) !== -1 ) {
1568                 // Already set up
1569                 return;
1570         }
1571         this.windowList.push( win );
1572
1573         win.connect( this, {
1574                 'setup': [ 'onWindowSetup', win ],
1575                 'ready': [ 'onWindowReady', win ],
1576                 'teardown': [ 'onWindowTeardown', win ]
1577         } );
1578         this.$element.append( win.$element );
1579 };
1580 /**
1581  * Modal dialog window.
1582  *
1583  * @abstract
1584  * @class
1585  * @extends OO.ui.Window
1586  *
1587  * @constructor
1588  * @param {Object} [config] Configuration options
1589  * @cfg {boolean} [footless] Hide foot
1590  * @cfg {string} [size='large'] Symbolic name of dialog size, `small`, `medium` or `large`
1591  */
1592 OO.ui.Dialog = function OoUiDialog( config ) {
1593         // Configuration initialization
1594         config = $.extend( { 'size': 'large' }, config );
1595
1596         // Parent constructor
1597         OO.ui.Dialog.super.call( this, config );
1598
1599         // Properties
1600         this.visible = false;
1601         this.footless = !!config.footless;
1602         this.size = null;
1603         this.pending = 0;
1604         this.onWindowMouseWheelHandler = OO.ui.bind( this.onWindowMouseWheel, this );
1605         this.onDocumentKeyDownHandler = OO.ui.bind( this.onDocumentKeyDown, this );
1606
1607         // Events
1608         this.$element.on( 'mousedown', false );
1609
1610         // Initialization
1611         this.$element.addClass( 'oo-ui-dialog' );
1612         this.setSize( config.size );
1613 };
1614
1615 /* Setup */
1616
1617 OO.inheritClass( OO.ui.Dialog, OO.ui.Window );
1618
1619 /* Static Properties */
1620
1621 /**
1622  * Symbolic name of dialog.
1623  *
1624  * @abstract
1625  * @static
1626  * @inheritable
1627  * @property {string}
1628  */
1629 OO.ui.Dialog.static.name = '';
1630
1631 /**
1632  * Map of symbolic size names and CSS classes.
1633  *
1634  * @static
1635  * @inheritable
1636  * @property {Object}
1637  */
1638 OO.ui.Dialog.static.sizeCssClasses = {
1639         'small': 'oo-ui-dialog-small',
1640         'medium': 'oo-ui-dialog-medium',
1641         'large': 'oo-ui-dialog-large'
1642 };
1643
1644 /* Methods */
1645
1646 /**
1647  * Handle close button click events.
1648  */
1649 OO.ui.Dialog.prototype.onCloseButtonClick = function () {
1650         this.close( { 'action': 'cancel' } );
1651 };
1652
1653 /**
1654  * Handle window mouse wheel events.
1655  *
1656  * @param {jQuery.Event} e Mouse wheel event
1657  */
1658 OO.ui.Dialog.prototype.onWindowMouseWheel = function () {
1659         return false;
1660 };
1661
1662 /**
1663  * Handle document key down events.
1664  *
1665  * @param {jQuery.Event} e Key down event
1666  */
1667 OO.ui.Dialog.prototype.onDocumentKeyDown = function ( e ) {
1668         switch ( e.which ) {
1669                 case OO.ui.Keys.PAGEUP:
1670                 case OO.ui.Keys.PAGEDOWN:
1671                 case OO.ui.Keys.END:
1672                 case OO.ui.Keys.HOME:
1673                 case OO.ui.Keys.LEFT:
1674                 case OO.ui.Keys.UP:
1675                 case OO.ui.Keys.RIGHT:
1676                 case OO.ui.Keys.DOWN:
1677                         // Prevent any key events that might cause scrolling
1678                         return false;
1679         }
1680 };
1681
1682 /**
1683  * Handle frame document key down events.
1684  *
1685  * @param {jQuery.Event} e Key down event
1686  */
1687 OO.ui.Dialog.prototype.onFrameDocumentKeyDown = function ( e ) {
1688         if ( e.which === OO.ui.Keys.ESCAPE ) {
1689                 this.close( { 'action': 'cancel' } );
1690                 return false;
1691         }
1692 };
1693
1694 /**
1695  * Set dialog size.
1696  *
1697  * @param {string} [size='large'] Symbolic name of dialog size, `small`, `medium` or `large`
1698  */
1699 OO.ui.Dialog.prototype.setSize = function ( size ) {
1700         var name, state, cssClass,
1701                 sizeCssClasses = OO.ui.Dialog.static.sizeCssClasses;
1702
1703         if ( !sizeCssClasses[size] ) {
1704                 size = 'large';
1705         }
1706         this.size = size;
1707         for ( name in sizeCssClasses ) {
1708                 state = name === size;
1709                 cssClass = sizeCssClasses[name];
1710                 this.$element.toggleClass( cssClass, state );
1711         }
1712 };
1713
1714 /**
1715  * @inheritdoc
1716  */
1717 OO.ui.Dialog.prototype.initialize = function () {
1718         // Parent method
1719         OO.ui.Dialog.super.prototype.initialize.call( this );
1720
1721         // Properties
1722         this.closeButton = new OO.ui.ButtonWidget( {
1723                 '$': this.$,
1724                 'frameless': true,
1725                 'icon': 'close',
1726                 'title': OO.ui.msg( 'ooui-dialog-action-close' )
1727         } );
1728
1729         // Events
1730         this.closeButton.connect( this, { 'click': 'onCloseButtonClick' } );
1731         this.frame.$document.on( 'keydown', OO.ui.bind( this.onFrameDocumentKeyDown, this ) );
1732
1733         // Initialization
1734         this.frame.$content.addClass( 'oo-ui-dialog-content' );
1735         if ( this.footless ) {
1736                 this.frame.$content.addClass( 'oo-ui-dialog-content-footless' );
1737         }
1738         this.closeButton.$element.addClass( 'oo-ui-window-closeButton' );
1739         this.$head.append( this.closeButton.$element );
1740 };
1741
1742 /**
1743  * @inheritdoc
1744  */
1745 OO.ui.Dialog.prototype.getSetupProcess = function ( data ) {
1746         return OO.ui.Dialog.super.prototype.getSetupProcess.call( this, data )
1747                 .next( function () {
1748                         // Prevent scrolling in top-level window
1749                         this.$( window ).on( 'mousewheel', this.onWindowMouseWheelHandler );
1750                         this.$( document ).on( 'keydown', this.onDocumentKeyDownHandler );
1751                 }, this );
1752 };
1753
1754 /**
1755  * @inheritdoc
1756  */
1757 OO.ui.Dialog.prototype.getTeardownProcess = function ( data ) {
1758         return OO.ui.Dialog.super.prototype.getTeardownProcess.call( this, data )
1759                 .first( function () {
1760                         // Wait for closing transition
1761                         return OO.ui.Process.static.delay( 250 );
1762                 }, this )
1763                 .next( function () {
1764                         // Allow scrolling in top-level window
1765                         this.$( window ).off( 'mousewheel', this.onWindowMouseWheelHandler );
1766                         this.$( document ).off( 'keydown', this.onDocumentKeyDownHandler );
1767                 }, this );
1768 };
1769
1770 /**
1771  * Check if input is pending.
1772  *
1773  * @return {boolean}
1774  */
1775 OO.ui.Dialog.prototype.isPending = function () {
1776         return !!this.pending;
1777 };
1778
1779 /**
1780  * Increase the pending stack.
1781  *
1782  * @chainable
1783  */
1784 OO.ui.Dialog.prototype.pushPending = function () {
1785         if ( this.pending === 0 ) {
1786                 this.frame.$content.addClass( 'oo-ui-dialog-pending' );
1787                 this.$head.addClass( 'oo-ui-texture-pending' );
1788                 this.$foot.addClass( 'oo-ui-texture-pending' );
1789         }
1790         this.pending++;
1791
1792         return this;
1793 };
1794
1795 /**
1796  * Reduce the pending stack.
1797  *
1798  * Clamped at zero.
1799  *
1800  * @chainable
1801  */
1802 OO.ui.Dialog.prototype.popPending = function () {
1803         if ( this.pending === 1 ) {
1804                 this.frame.$content.removeClass( 'oo-ui-dialog-pending' );
1805                 this.$head.removeClass( 'oo-ui-texture-pending' );
1806                 this.$foot.removeClass( 'oo-ui-texture-pending' );
1807         }
1808         this.pending = Math.max( 0, this.pending - 1 );
1809
1810         return this;
1811 };
1812 /**
1813  * Container for elements.
1814  *
1815  * @abstract
1816  * @class
1817  * @extends OO.ui.Element
1818  * @mixins OO.EventEmitter
1819  *
1820  * @constructor
1821  * @param {Object} [config] Configuration options
1822  */
1823 OO.ui.Layout = function OoUiLayout( config ) {
1824         // Initialize config
1825         config = config || {};
1826
1827         // Parent constructor
1828         OO.ui.Layout.super.call( this, config );
1829
1830         // Mixin constructors
1831         OO.EventEmitter.call( this );
1832
1833         // Initialization
1834         this.$element.addClass( 'oo-ui-layout' );
1835 };
1836
1837 /* Setup */
1838
1839 OO.inheritClass( OO.ui.Layout, OO.ui.Element );
1840 OO.mixinClass( OO.ui.Layout, OO.EventEmitter );
1841 /**
1842  * User interface control.
1843  *
1844  * @abstract
1845  * @class
1846  * @extends OO.ui.Element
1847  * @mixins OO.EventEmitter
1848  *
1849  * @constructor
1850  * @param {Object} [config] Configuration options
1851  * @cfg {boolean} [disabled=false] Disable
1852  */
1853 OO.ui.Widget = function OoUiWidget( config ) {
1854         // Initialize config
1855         config = $.extend( { 'disabled': false }, config );
1856
1857         // Parent constructor
1858         OO.ui.Widget.super.call( this, config );
1859
1860         // Mixin constructors
1861         OO.EventEmitter.call( this );
1862
1863         // Properties
1864         this.disabled = null;
1865         this.wasDisabled = null;
1866
1867         // Initialization
1868         this.$element.addClass( 'oo-ui-widget' );
1869         this.setDisabled( !!config.disabled );
1870 };
1871
1872 /* Setup */
1873
1874 OO.inheritClass( OO.ui.Widget, OO.ui.Element );
1875 OO.mixinClass( OO.ui.Widget, OO.EventEmitter );
1876
1877 /* Events */
1878
1879 /**
1880  * @event disable
1881  * @param {boolean} disabled Widget is disabled
1882  */
1883
1884 /* Methods */
1885
1886 /**
1887  * Check if the widget is disabled.
1888  *
1889  * @param {boolean} Button is disabled
1890  */
1891 OO.ui.Widget.prototype.isDisabled = function () {
1892         return this.disabled;
1893 };
1894
1895 /**
1896  * Update the disabled state, in case of changes in parent widget.
1897  *
1898  * @chainable
1899  */
1900 OO.ui.Widget.prototype.updateDisabled = function () {
1901         this.setDisabled( this.disabled );
1902         return this;
1903 };
1904
1905 /**
1906  * Set the disabled state of the widget.
1907  *
1908  * This should probably change the widgets' appearance and prevent it from being used.
1909  *
1910  * @param {boolean} disabled Disable widget
1911  * @chainable
1912  */
1913 OO.ui.Widget.prototype.setDisabled = function ( disabled ) {
1914         var isDisabled;
1915
1916         this.disabled = !!disabled;
1917         isDisabled = this.isDisabled();
1918         if ( isDisabled !== this.wasDisabled ) {
1919                 this.$element.toggleClass( 'oo-ui-widget-disabled', isDisabled );
1920                 this.$element.toggleClass( 'oo-ui-widget-enabled', !isDisabled );
1921                 this.emit( 'disable', isDisabled );
1922         }
1923         this.wasDisabled = isDisabled;
1924         return this;
1925 };
1926 /**
1927  * A list of functions, called in sequence.
1928  *
1929  * If a function added to a process returns boolean false the process will stop; if it returns an
1930  * object with a `promise` method the process will use the promise to either continue to the next
1931  * step when the promise is resolved or stop when the promise is rejected.
1932  *
1933  * @class
1934  *
1935  * @constructor
1936  */
1937 OO.ui.Process = function () {
1938         // Properties
1939         this.steps = [];
1940 };
1941
1942 /* Setup */
1943
1944 OO.initClass( OO.ui.Process );
1945
1946 /* Static Methods */
1947
1948 /**
1949  * Generate a promise which is resolved after a set amount of time.
1950  *
1951  * @param {number} length Number of milliseconds before resolving the promise
1952  * @return {jQuery.Promise} Promise that will be resolved after a set amount of time
1953  */
1954 OO.ui.Process.static.delay = function ( length ) {
1955         var deferred = $.Deferred();
1956
1957         setTimeout( function () {
1958                 deferred.resolve();
1959         }, length );
1960
1961         return deferred.promise();
1962 };
1963
1964 /* Methods */
1965
1966 /**
1967  * Start the process.
1968  *
1969  * @return {jQuery.Promise} Promise that is resolved when all steps have completed or rejected when
1970  *   any of the steps return boolean false or a promise which gets rejected; upon stopping the
1971  *   process, the remaining steps will not be taken
1972  */
1973 OO.ui.Process.prototype.execute = function () {
1974         var i, len, promise;
1975
1976         /**
1977          * Continue execution.
1978          *
1979          * @ignore
1980          * @param {Array} step A function and the context it should be called in
1981          * @return {Function} Function that continues the process
1982          */
1983         function proceed( step ) {
1984                 return function () {
1985                         // Execute step in the correct context
1986                         var result = step[0].call( step[1] );
1987
1988                         if ( result === false ) {
1989                                 // Use rejected promise for boolean false results
1990                                 return $.Deferred().reject().promise();
1991                         }
1992                         // Duck-type the object to see if it can produce a promise
1993                         if ( result && $.isFunction( result.promise ) ) {
1994                                 // Use a promise generated from the result
1995                                 return result.promise();
1996                         }
1997                         // Use resolved promise for other results
1998                         return $.Deferred().resolve().promise();
1999                 };
2000         }
2001
2002         if ( this.steps.length ) {
2003                 // Generate a chain reaction of promises
2004                 promise = proceed( this.steps[0] )();
2005                 for ( i = 1, len = this.steps.length; i < len; i++ ) {
2006                         promise = promise.then( proceed( this.steps[i] ) );
2007                 }
2008         } else {
2009                 promise = $.Deferred().resolve().promise();
2010         }
2011
2012         return promise;
2013 };
2014
2015 /**
2016  * Add step to the beginning of the process.
2017  *
2018  * @param {Function} step Function to execute; if it returns boolean false the process will stop; if
2019  *   it returns an object with a `promise` method the process will use the promise to either
2020  *   continue to the next step when the promise is resolved or stop when the promise is rejected
2021  * @param {Object} [context=null] Context to call the step function in
2022  * @chainable
2023  */
2024 OO.ui.Process.prototype.first = function ( step, context ) {
2025         this.steps.unshift( [ step, context || null ] );
2026         return this;
2027 };
2028
2029 /**
2030  * Add step to the end of the process.
2031  *
2032  * @param {Function} step Function to execute; if it returns boolean false the process will stop; if
2033  *   it returns an object with a `promise` method the process will use the promise to either
2034  *   continue to the next step when the promise is resolved or stop when the promise is rejected
2035  * @param {Object} [context=null] Context to call the step function in
2036  * @chainable
2037  */
2038 OO.ui.Process.prototype.next = function ( step, context ) {
2039         this.steps.push( [ step, context || null ] );
2040         return this;
2041 };
2042 /**
2043  * Dialog for showing a confirmation/warning message.
2044  *
2045  * @class
2046  * @extends OO.ui.Dialog
2047  *
2048  * @constructor
2049  * @param {Object} [config] Configuration options
2050  */
2051 OO.ui.ConfirmationDialog = function OoUiConfirmationDialog( config ) {
2052         // Configuration initialization
2053         config = $.extend( { 'size': 'small' }, config );
2054
2055         // Parent constructor
2056         OO.ui.Dialog.call( this, config );
2057 };
2058
2059 /* Inheritance */
2060
2061 OO.inheritClass( OO.ui.ConfirmationDialog, OO.ui.Dialog );
2062
2063 /* Static Properties */
2064
2065 OO.ui.ConfirmationDialog.static.name = 'confirm';
2066
2067 OO.ui.ConfirmationDialog.static.icon = 'help';
2068
2069 OO.ui.ConfirmationDialog.static.title = OO.ui.deferMsg( 'ooui-dialog-confirm-title' );
2070
2071 /* Methods */
2072
2073 /**
2074  * @inheritdoc
2075  */
2076 OO.ui.ConfirmationDialog.prototype.initialize = function () {
2077         // Parent method
2078         OO.ui.Dialog.prototype.initialize.call( this );
2079
2080         // Set up the layout
2081         var contentLayout = new OO.ui.PanelLayout( {
2082                 '$': this.$,
2083                 'padded': true
2084         } );
2085
2086         this.$promptContainer = this.$( '<div>' ).addClass( 'oo-ui-dialog-confirm-promptContainer' );
2087
2088         this.cancelButton = new OO.ui.ButtonWidget();
2089         this.cancelButton.connect( this, { 'click': [ 'close', 'cancel' ] } );
2090
2091         this.okButton = new OO.ui.ButtonWidget();
2092         this.okButton.connect( this, { 'click': [ 'close', 'ok' ] } );
2093
2094         // Make the buttons
2095         contentLayout.$element.append( this.$promptContainer );
2096         this.$body.append( contentLayout.$element );
2097
2098         this.$foot.append(
2099                 this.okButton.$element,
2100                 this.cancelButton.$element
2101         );
2102
2103         this.connect( this, { 'teardown': [ 'close', 'cancel' ] } );
2104 };
2105
2106 /*
2107  * Setup a confirmation dialog.
2108  *
2109  * @param {Object} [data] Window opening data including text of the dialog and text for the buttons
2110  * @param {jQuery|string} [data.prompt] Text to display or list of nodes to use as content of the dialog.
2111  * @param {jQuery|string|Function|null} [data.okLabel] Label of the OK button
2112  * @param {jQuery|string|Function|null} [data.cancelLabel] Label of the cancel button
2113  * @param {string|string[]} [data.okFlags="constructive"] Flags for the OK button
2114  * @param {string|string[]} [data.cancelFlags="destructive"] Flags for the cancel button
2115  * @return {OO.ui.Process} Setup process
2116  */
2117 OO.ui.ConfirmationDialog.prototype.getSetupProcess = function ( data ) {
2118         // Parent method
2119         return OO.ui.ConfirmationDialog.super.prototype.getSetupProcess.call( this, data )
2120                 .next( function () {
2121                         var prompt = data.prompt || OO.ui.deferMsg( 'ooui-dialog-confirm-default-prompt' ),
2122                                 okLabel = data.okLabel || OO.ui.deferMsg( 'ooui-dialog-confirm-default-ok' ),
2123                                 cancelLabel = data.cancelLabel || OO.ui.deferMsg( 'ooui-dialog-confirm-default-cancel' ),
2124                                 okFlags = data.okFlags || 'constructive',
2125                                 cancelFlags = data.cancelFlags || 'destructive';
2126
2127                         if ( typeof prompt === 'string' ) {
2128                                 this.$promptContainer.text( prompt );
2129                         } else {
2130                                 this.$promptContainer.empty().append( prompt );
2131                         }
2132
2133                         this.okButton.setLabel( okLabel ).clearFlags().setFlags( okFlags );
2134                         this.cancelButton.setLabel( cancelLabel ).clearFlags().setFlags( cancelFlags );
2135                 }, this );
2136 };
2137
2138 /**
2139  * @inheritdoc
2140  */
2141 OO.ui.ConfirmationDialog.prototype.getTeardownProcess = function ( data ) {
2142         // Parent method
2143         return OO.ui.ConfirmationDialog.super.prototype.getTeardownProcess.call( this, data )
2144                 .first( function () {
2145                         if ( data === 'ok' ) {
2146                                 this.opened.resolve();
2147                         } else if ( data === 'cancel' ) {
2148                                 this.opened.reject();
2149                         }
2150                 }, this );
2151 };
2152 /**
2153  * Element with a button.
2154  *
2155  * @abstract
2156  * @class
2157  *
2158  * @constructor
2159  * @param {jQuery} $button Button node, assigned to #$button
2160  * @param {Object} [config] Configuration options
2161  * @cfg {boolean} [frameless] Render button without a frame
2162  * @cfg {number} [tabIndex=0] Button's tab index, use -1 to prevent tab focusing
2163  */
2164 OO.ui.ButtonedElement = function OoUiButtonedElement( $button, config ) {
2165         // Configuration initialization
2166         config = config || {};
2167
2168         // Properties
2169         this.$button = $button;
2170         this.tabIndex = null;
2171         this.active = false;
2172         this.onMouseUpHandler = OO.ui.bind( this.onMouseUp, this );
2173
2174         // Events
2175         this.$button.on( 'mousedown', OO.ui.bind( this.onMouseDown, this ) );
2176
2177         // Initialization
2178         this.$element.addClass( 'oo-ui-buttonedElement' );
2179         this.$button
2180                 .addClass( 'oo-ui-buttonedElement-button' )
2181                 .attr( 'role', 'button' )
2182                 .prop( 'tabIndex', config.tabIndex || 0 );
2183         if ( config.frameless ) {
2184                 this.$element.addClass( 'oo-ui-buttonedElement-frameless' );
2185         } else {
2186                 this.$element.addClass( 'oo-ui-buttonedElement-framed' );
2187         }
2188 };
2189
2190 /* Setup */
2191
2192 OO.initClass( OO.ui.ButtonedElement );
2193
2194 /* Static Properties */
2195
2196 /**
2197  * Cancel mouse down events.
2198  *
2199  * @static
2200  * @inheritable
2201  * @property {boolean}
2202  */
2203 OO.ui.ButtonedElement.static.cancelButtonMouseDownEvents = true;
2204
2205 /* Methods */
2206
2207 /**
2208  * Handles mouse down events.
2209  *
2210  * @param {jQuery.Event} e Mouse down event
2211  */
2212 OO.ui.ButtonedElement.prototype.onMouseDown = function ( e ) {
2213         if ( this.isDisabled() || e.which !== 1 ) {
2214                 return false;
2215         }
2216         // tabIndex should generally be interacted with via the property, but it's not possible to
2217         // reliably unset a tabIndex via a property so we use the (lowercase) "tabindex" attribute
2218         this.tabIndex = this.$button.attr( 'tabindex' );
2219         this.$button
2220                 // Remove the tab-index while the button is down to prevent the button from stealing focus
2221                 .removeAttr( 'tabindex' )
2222                 .addClass( 'oo-ui-buttonedElement-pressed' );
2223         // Run the mouseup handler no matter where the mouse is when the button is let go, so we can
2224         // reliably reapply the tabindex and remove the pressed class
2225         this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler, true );
2226         // Prevent change of focus unless specifically configured otherwise
2227         if ( this.constructor.static.cancelButtonMouseDownEvents ) {
2228                 return false;
2229         }
2230 };
2231
2232 /**
2233  * Handles mouse up events.
2234  *
2235  * @param {jQuery.Event} e Mouse up event
2236  */
2237 OO.ui.ButtonedElement.prototype.onMouseUp = function ( e ) {
2238         if ( this.isDisabled() || e.which !== 1 ) {
2239                 return false;
2240         }
2241         this.$button
2242                 // Restore the tab-index after the button is up to restore the button's accesssibility
2243                 .attr( 'tabindex', this.tabIndex )
2244                 .removeClass( 'oo-ui-buttonedElement-pressed' );
2245         // Stop listening for mouseup, since we only needed this once
2246         this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler, true );
2247 };
2248
2249 /**
2250  * Set active state.
2251  *
2252  * @param {boolean} [value] Make button active
2253  * @chainable
2254  */
2255 OO.ui.ButtonedElement.prototype.setActive = function ( value ) {
2256         this.$button.toggleClass( 'oo-ui-buttonedElement-active', !!value );
2257         return this;
2258 };
2259 /**
2260  * Element that can be automatically clipped to visible boundaies.
2261  *
2262  * @abstract
2263  * @class
2264  *
2265  * @constructor
2266  * @param {jQuery} $clippable Nodes to clip, assigned to #$clippable
2267  * @param {Object} [config] Configuration options
2268  */
2269 OO.ui.ClippableElement = function OoUiClippableElement( $clippable, config ) {
2270         // Configuration initialization
2271         config = config || {};
2272
2273         // Properties
2274         this.$clippable = $clippable;
2275         this.clipping = false;
2276         this.clipped = false;
2277         this.$clippableContainer = null;
2278         this.$clippableScroller = null;
2279         this.$clippableWindow = null;
2280         this.idealWidth = null;
2281         this.idealHeight = null;
2282         this.onClippableContainerScrollHandler = OO.ui.bind( this.clip, this );
2283         this.onClippableWindowResizeHandler = OO.ui.bind( this.clip, this );
2284
2285         // Initialization
2286         this.$clippable.addClass( 'oo-ui-clippableElement-clippable' );
2287 };
2288
2289 /* Methods */
2290
2291 /**
2292  * Set clipping.
2293  *
2294  * @param {boolean} value Enable clipping
2295  * @chainable
2296  */
2297 OO.ui.ClippableElement.prototype.setClipping = function ( value ) {
2298         value = !!value;
2299
2300         if ( this.clipping !== value ) {
2301                 this.clipping = value;
2302                 if ( this.clipping ) {
2303                         this.$clippableContainer = this.$( this.getClosestScrollableElementContainer() );
2304                         // If the clippable container is the body, we have to listen to scroll events and check
2305                         // jQuery.scrollTop on the window because of browser inconsistencies
2306                         this.$clippableScroller = this.$clippableContainer.is( 'body' ) ?
2307                                 this.$( OO.ui.Element.getWindow( this.$clippableContainer ) ) :
2308                                 this.$clippableContainer;
2309                         this.$clippableScroller.on( 'scroll', this.onClippableContainerScrollHandler );
2310                         this.$clippableWindow = this.$( this.getElementWindow() )
2311                                 .on( 'resize', this.onClippableWindowResizeHandler );
2312                         // Initial clip after visible
2313                         setTimeout( OO.ui.bind( this.clip, this ) );
2314                 } else {
2315                         this.$clippableContainer = null;
2316                         this.$clippableScroller.off( 'scroll', this.onClippableContainerScrollHandler );
2317                         this.$clippableScroller = null;
2318                         this.$clippableWindow.off( 'resize', this.onClippableWindowResizeHandler );
2319                         this.$clippableWindow = null;
2320                 }
2321         }
2322
2323         return this;
2324 };
2325
2326 /**
2327  * Check if the element will be clipped to fit the visible area of the nearest scrollable container.
2328  *
2329  * @return {boolean} Element will be clipped to the visible area
2330  */
2331 OO.ui.ClippableElement.prototype.isClipping = function () {
2332         return this.clipping;
2333 };
2334
2335 /**
2336  * Check if the bottom or right of the element is being clipped by the nearest scrollable container.
2337  *
2338  * @return {boolean} Part of the element is being clipped
2339  */
2340 OO.ui.ClippableElement.prototype.isClipped = function () {
2341         return this.clipped;
2342 };
2343
2344 /**
2345  * Set the ideal size.
2346  *
2347  * @param {number|string} [width] Width as a number of pixels or CSS string with unit suffix
2348  * @param {number|string} [height] Height as a number of pixels or CSS string with unit suffix
2349  */
2350 OO.ui.ClippableElement.prototype.setIdealSize = function ( width, height ) {
2351         this.idealWidth = width;
2352         this.idealHeight = height;
2353 };
2354
2355 /**
2356  * Clip element to visible boundaries and allow scrolling when needed.
2357  *
2358  * Element will be clipped the bottom or right of the element is within 10px of the edge of, or
2359  * overlapped by, the visible area of the nearest scrollable container.
2360  *
2361  * @chainable
2362  */
2363 OO.ui.ClippableElement.prototype.clip = function () {
2364         if ( !this.clipping ) {
2365                 // this.$clippableContainer and this.$clippableWindow are null, so the below will fail
2366                 return this;
2367         }
2368
2369         var buffer = 10,
2370                 cOffset = this.$clippable.offset(),
2371                 ccOffset = this.$clippableContainer.offset() || { 'top': 0, 'left': 0 },
2372                 ccHeight = this.$clippableContainer.innerHeight() - buffer,
2373                 ccWidth = this.$clippableContainer.innerWidth() - buffer,
2374                 scrollTop = this.$clippableScroller.scrollTop(),
2375                 scrollLeft = this.$clippableScroller.scrollLeft(),
2376                 desiredWidth = ( ccOffset.left + scrollLeft + ccWidth ) - cOffset.left,
2377                 desiredHeight = ( ccOffset.top + scrollTop + ccHeight ) - cOffset.top,
2378                 naturalWidth = this.$clippable.prop( 'scrollWidth' ),
2379                 naturalHeight = this.$clippable.prop( 'scrollHeight' ),
2380                 clipWidth = desiredWidth < naturalWidth,
2381                 clipHeight = desiredHeight < naturalHeight;
2382
2383         if ( clipWidth ) {
2384                 this.$clippable.css( { 'overflow-x': 'auto', 'width': desiredWidth } );
2385         } else {
2386                 this.$clippable.css( { 'overflow-x': '', 'width': this.idealWidth || '' } );
2387         }
2388         if ( clipHeight ) {
2389                 this.$clippable.css( { 'overflow-y': 'auto', 'height': desiredHeight } );
2390         } else {
2391                 this.$clippable.css( { 'overflow-y': '', 'height': this.idealHeight || '' } );
2392         }
2393
2394         this.clipped = clipWidth || clipHeight;
2395
2396         return this;
2397 };
2398 /**
2399  * Element with named flags that can be added, removed, listed and checked.
2400  *
2401  * A flag, when set, adds a CSS class on the `$element` by combing `oo-ui-flaggableElement-` with
2402  * the flag name. Flags are primarily useful for styling.
2403  *
2404  * @abstract
2405  * @class
2406  *
2407  * @constructor
2408  * @param {Object} [config] Configuration options
2409  * @cfg {string[]} [flags=[]] Styling flags, e.g. 'primary', 'destructive' or 'constructive'
2410  */
2411 OO.ui.FlaggableElement = function OoUiFlaggableElement( config ) {
2412         // Config initialization
2413         config = config || {};
2414
2415         // Properties
2416         this.flags = {};
2417
2418         // Initialization
2419         this.setFlags( config.flags );
2420 };
2421
2422 /* Methods */
2423
2424 /**
2425  * Check if a flag is set.
2426  *
2427  * @param {string} flag Name of flag
2428  * @return {boolean} Has flag
2429  */
2430 OO.ui.FlaggableElement.prototype.hasFlag = function ( flag ) {
2431         return flag in this.flags;
2432 };
2433
2434 /**
2435  * Get the names of all flags set.
2436  *
2437  * @return {string[]} flags Flag names
2438  */
2439 OO.ui.FlaggableElement.prototype.getFlags = function () {
2440         return Object.keys( this.flags );
2441 };
2442
2443 /**
2444  * Clear all flags.
2445  *
2446  * @chainable
2447  */
2448 OO.ui.FlaggableElement.prototype.clearFlags = function () {
2449         var flag,
2450                 classPrefix = 'oo-ui-flaggableElement-';
2451
2452         for ( flag in this.flags ) {
2453                 delete this.flags[flag];
2454                 this.$element.removeClass( classPrefix + flag );
2455         }
2456
2457         return this;
2458 };
2459
2460 /**
2461  * Add one or more flags.
2462  *
2463  * @param {string|string[]|Object.<string, boolean>} flags One or more flags to add, or an object
2464  *  keyed by flag name containing boolean set/remove instructions.
2465  * @chainable
2466  */
2467 OO.ui.FlaggableElement.prototype.setFlags = function ( flags ) {
2468         var i, len, flag,
2469                 classPrefix = 'oo-ui-flaggableElement-';
2470
2471         if ( typeof flags === 'string' ) {
2472                 // Set
2473                 this.flags[flags] = true;
2474                 this.$element.addClass( classPrefix + flags );
2475         } else if ( $.isArray( flags ) ) {
2476                 for ( i = 0, len = flags.length; i < len; i++ ) {
2477                         flag = flags[i];
2478                         // Set
2479                         this.flags[flag] = true;
2480                         this.$element.addClass( classPrefix + flag );
2481                 }
2482         } else if ( OO.isPlainObject( flags ) ) {
2483                 for ( flag in flags ) {
2484                         if ( flags[flag] ) {
2485                                 // Set
2486                                 this.flags[flag] = true;
2487                                 this.$element.addClass( classPrefix + flag );
2488                         } else {
2489                                 // Remove
2490                                 delete this.flags[flag];
2491                                 this.$element.removeClass( classPrefix + flag );
2492                         }
2493                 }
2494         }
2495         return this;
2496 };
2497 /**
2498  * Element containing a sequence of child elements.
2499  *
2500  * @abstract
2501  * @class
2502  *
2503  * @constructor
2504  * @param {jQuery} $group Container node, assigned to #$group
2505  * @param {Object} [config] Configuration options
2506  */
2507 OO.ui.GroupElement = function OoUiGroupElement( $group, config ) {
2508         // Configuration
2509         config = config || {};
2510
2511         // Properties
2512         this.$group = $group;
2513         this.items = [];
2514         this.aggregateItemEvents = {};
2515 };
2516
2517 /* Methods */
2518
2519 /**
2520  * Get items.
2521  *
2522  * @return {OO.ui.Element[]} Items
2523  */
2524 OO.ui.GroupElement.prototype.getItems = function () {
2525         return this.items.slice( 0 );
2526 };
2527
2528 /**
2529  * Add an aggregate item event.
2530  *
2531  * Aggregated events are listened to on each item and then emitted by the group under a new name,
2532  * and with an additional leading parameter containing the item that emitted the original event.
2533  * Other arguments that were emitted from the original event are passed through.
2534  *
2535  * @param {Object.<string,string|null>} events Aggregate events emitted by group, keyed by item
2536  *   event, use null value to remove aggregation
2537  * @throws {Error} If aggregation already exists
2538  */
2539 OO.ui.GroupElement.prototype.aggregate = function ( events ) {
2540         var i, len, item, add, remove, itemEvent, groupEvent;
2541
2542         for ( itemEvent in events ) {
2543                 groupEvent = events[itemEvent];
2544
2545                 // Remove existing aggregated event
2546                 if ( itemEvent in this.aggregateItemEvents ) {
2547                         // Don't allow duplicate aggregations
2548                         if ( groupEvent ) {
2549                                 throw new Error( 'Duplicate item event aggregation for ' + itemEvent );
2550                         }
2551                         // Remove event aggregation from existing items
2552                         for ( i = 0, len = this.items.length; i < len; i++ ) {
2553                                 item = this.items[i];
2554                                 if ( item.connect && item.disconnect ) {
2555                                         remove = {};
2556                                         remove[itemEvent] = [ 'emit', groupEvent, item ];
2557                                         item.disconnect( this, remove );
2558                                 }
2559                         }
2560                         // Prevent future items from aggregating event
2561                         delete this.aggregateItemEvents[itemEvent];
2562                 }
2563
2564                 // Add new aggregate event
2565                 if ( groupEvent ) {
2566                         // Make future items aggregate event
2567                         this.aggregateItemEvents[itemEvent] = groupEvent;
2568                         // Add event aggregation to existing items
2569                         for ( i = 0, len = this.items.length; i < len; i++ ) {
2570                                 item = this.items[i];
2571                                 if ( item.connect && item.disconnect ) {
2572                                         add = {};
2573                                         add[itemEvent] = [ 'emit', groupEvent, item ];
2574                                         item.connect( this, add );
2575                                 }
2576                         }
2577                 }
2578         }
2579 };
2580
2581 /**
2582  * Add items.
2583  *
2584  * @param {OO.ui.Element[]} items Item
2585  * @param {number} [index] Index to insert items at
2586  * @chainable
2587  */
2588 OO.ui.GroupElement.prototype.addItems = function ( items, index ) {
2589         var i, len, item, event, events, currentIndex,
2590                 itemElements = [];
2591
2592         for ( i = 0, len = items.length; i < len; i++ ) {
2593                 item = items[i];
2594
2595                 // Check if item exists then remove it first, effectively "moving" it
2596                 currentIndex = $.inArray( item, this.items );
2597                 if ( currentIndex >= 0 ) {
2598                         this.removeItems( [ item ] );
2599                         // Adjust index to compensate for removal
2600                         if ( currentIndex < index ) {
2601                                 index--;
2602                         }
2603                 }
2604                 // Add the item
2605                 if ( item.connect && item.disconnect && !$.isEmptyObject( this.aggregateItemEvents ) ) {
2606                         events = {};
2607                         for ( event in this.aggregateItemEvents ) {
2608                                 events[event] = [ 'emit', this.aggregateItemEvents[event], item ];
2609                         }
2610                         item.connect( this, events );
2611                 }
2612                 item.setElementGroup( this );
2613                 itemElements.push( item.$element.get( 0 ) );
2614         }
2615
2616         if ( index === undefined || index < 0 || index >= this.items.length ) {
2617                 this.$group.append( itemElements );
2618                 this.items.push.apply( this.items, items );
2619         } else if ( index === 0 ) {
2620                 this.$group.prepend( itemElements );
2621                 this.items.unshift.apply( this.items, items );
2622         } else {
2623                 this.items[index].$element.before( itemElements );
2624                 this.items.splice.apply( this.items, [ index, 0 ].concat( items ) );
2625         }
2626
2627         return this;
2628 };
2629
2630 /**
2631  * Remove items.
2632  *
2633  * Items will be detached, not removed, so they can be used later.
2634  *
2635  * @param {OO.ui.Element[]} items Items to remove
2636  * @chainable
2637  */
2638 OO.ui.GroupElement.prototype.removeItems = function ( items ) {
2639         var i, len, item, index, remove, itemEvent;
2640
2641         // Remove specific items
2642         for ( i = 0, len = items.length; i < len; i++ ) {
2643                 item = items[i];
2644                 index = $.inArray( item, this.items );
2645                 if ( index !== -1 ) {
2646                         if (
2647                                 item.connect && item.disconnect &&
2648                                 !$.isEmptyObject( this.aggregateItemEvents )
2649                         ) {
2650                                 remove = {};
2651                                 if ( itemEvent in this.aggregateItemEvents ) {
2652                                         remove[itemEvent] = [ 'emit', this.aggregateItemEvents[itemEvent], item ];
2653                                 }
2654                                 item.disconnect( this, remove );
2655                         }
2656                         item.setElementGroup( null );
2657                         this.items.splice( index, 1 );
2658                         item.$element.detach();
2659                 }
2660         }
2661
2662         return this;
2663 };
2664
2665 /**
2666  * Clear all items.
2667  *
2668  * Items will be detached, not removed, so they can be used later.
2669  *
2670  * @chainable
2671  */
2672 OO.ui.GroupElement.prototype.clearItems = function () {
2673         var i, len, item, remove, itemEvent;
2674
2675         // Remove all items
2676         for ( i = 0, len = this.items.length; i < len; i++ ) {
2677                 item = this.items[i];
2678                 if (
2679                         item.connect && item.disconnect &&
2680                         !$.isEmptyObject( this.aggregateItemEvents )
2681                 ) {
2682                         remove = {};
2683                         if ( itemEvent in this.aggregateItemEvents ) {
2684                                 remove[itemEvent] = [ 'emit', this.aggregateItemEvents[itemEvent], item ];
2685                         }
2686                         item.disconnect( this, remove );
2687                 }
2688                 item.setElementGroup( null );
2689                 item.$element.detach();
2690         }
2691
2692         this.items = [];
2693         return this;
2694 };
2695 /**
2696  * Element containing an icon.
2697  *
2698  * @abstract
2699  * @class
2700  *
2701  * @constructor
2702  * @param {jQuery} $icon Icon node, assigned to #$icon
2703  * @param {Object} [config] Configuration options
2704  * @cfg {Object|string} [icon=''] Symbolic icon name, or map of icon names keyed by language ID;
2705  *  use the 'default' key to specify the icon to be used when there is no icon in the user's
2706  *  language
2707  */
2708 OO.ui.IconedElement = function OoUiIconedElement( $icon, config ) {
2709         // Config intialization
2710         config = config || {};
2711
2712         // Properties
2713         this.$icon = $icon;
2714         this.icon = null;
2715
2716         // Initialization
2717         this.$icon.addClass( 'oo-ui-iconedElement-icon' );
2718         this.setIcon( config.icon || this.constructor.static.icon );
2719 };
2720
2721 /* Setup */
2722
2723 OO.initClass( OO.ui.IconedElement );
2724
2725 /* Static Properties */
2726
2727 /**
2728  * Icon.
2729  *
2730  * Value should be the unique portion of an icon CSS class name, such as 'up' for 'oo-ui-icon-up'.
2731  *
2732  * For i18n purposes, this property can be an object containing a `default` icon name property and
2733  * additional icon names keyed by language code.
2734  *
2735  * Example of i18n icon definition:
2736  *     { 'default': 'bold-a', 'en': 'bold-b', 'de': 'bold-f' }
2737  *
2738  * @static
2739  * @inheritable
2740  * @property {Object|string} Symbolic icon name, or map of icon names keyed by language ID;
2741  *  use the 'default' key to specify the icon to be used when there is no icon in the user's
2742  *  language
2743  */
2744 OO.ui.IconedElement.static.icon = null;
2745
2746 /* Methods */
2747
2748 /**
2749  * Set icon.
2750  *
2751  * @param {Object|string} icon Symbolic icon name, or map of icon names keyed by language ID;
2752  *  use the 'default' key to specify the icon to be used when there is no icon in the user's
2753  *  language
2754  * @chainable
2755  */
2756 OO.ui.IconedElement.prototype.setIcon = function ( icon ) {
2757         icon = OO.isPlainObject( icon ) ? OO.ui.getLocalValue( icon, null, 'default' ) : icon;
2758
2759         if ( this.icon ) {
2760                 this.$icon.removeClass( 'oo-ui-icon-' + this.icon );
2761         }
2762         if ( typeof icon === 'string' ) {
2763                 icon = icon.trim();
2764                 if ( icon.length ) {
2765                         this.$icon.addClass( 'oo-ui-icon-' + icon );
2766                         this.icon = icon;
2767                 }
2768         }
2769         this.$element.toggleClass( 'oo-ui-iconedElement', !!this.icon );
2770
2771         return this;
2772 };
2773
2774 /**
2775  * Get icon.
2776  *
2777  * @return {string} Icon
2778  */
2779 OO.ui.IconedElement.prototype.getIcon = function () {
2780         return this.icon;
2781 };
2782 /**
2783  * Element containing an indicator.
2784  *
2785  * @abstract
2786  * @class
2787  *
2788  * @constructor
2789  * @param {jQuery} $indicator Indicator node, assigned to #$indicator
2790  * @param {Object} [config] Configuration options
2791  * @cfg {string} [indicator] Symbolic indicator name
2792  * @cfg {string} [indicatorTitle] Indicator title text or a function that return text
2793  */
2794 OO.ui.IndicatedElement = function OoUiIndicatedElement( $indicator, config ) {
2795         // Config intialization
2796         config = config || {};
2797
2798         // Properties
2799         this.$indicator = $indicator;
2800         this.indicator = null;
2801         this.indicatorLabel = null;
2802
2803         // Initialization
2804         this.$indicator.addClass( 'oo-ui-indicatedElement-indicator' );
2805         this.setIndicator( config.indicator || this.constructor.static.indicator );
2806         this.setIndicatorTitle( config.indicatorTitle  || this.constructor.static.indicatorTitle );
2807 };
2808
2809 /* Setup */
2810
2811 OO.initClass( OO.ui.IndicatedElement );
2812
2813 /* Static Properties */
2814
2815 /**
2816  * indicator.
2817  *
2818  * @static
2819  * @inheritable
2820  * @property {string|null} Symbolic indicator name or null for no indicator
2821  */
2822 OO.ui.IndicatedElement.static.indicator = null;
2823
2824 /**
2825  * Indicator title.
2826  *
2827  * @static
2828  * @inheritable
2829  * @property {string|Function|null} Indicator title text, a function that return text or null for no
2830  *  indicator title
2831  */
2832 OO.ui.IndicatedElement.static.indicatorTitle = null;
2833
2834 /* Methods */
2835
2836 /**
2837  * Set indicator.
2838  *
2839  * @param {string|null} indicator Symbolic name of indicator to use or null for no indicator
2840  * @chainable
2841  */
2842 OO.ui.IndicatedElement.prototype.setIndicator = function ( indicator ) {
2843         if ( this.indicator ) {
2844                 this.$indicator.removeClass( 'oo-ui-indicator-' + this.indicator );
2845                 this.indicator = null;
2846         }
2847         if ( typeof indicator === 'string' ) {
2848                 indicator = indicator.trim();
2849                 if ( indicator.length ) {
2850                         this.$indicator.addClass( 'oo-ui-indicator-' + indicator );
2851                         this.indicator = indicator;
2852                 }
2853         }
2854         this.$element.toggleClass( 'oo-ui-indicatedElement', !!this.indicator );
2855
2856         return this;
2857 };
2858
2859 /**
2860  * Set indicator label.
2861  *
2862  * @param {string|Function|null} indicator Indicator title text, a function that return text or null
2863  *  for no indicator title
2864  * @chainable
2865  */
2866 OO.ui.IndicatedElement.prototype.setIndicatorTitle = function ( indicatorTitle ) {
2867         this.indicatorTitle = indicatorTitle = OO.ui.resolveMsg( indicatorTitle );
2868
2869         if ( typeof indicatorTitle === 'string' && indicatorTitle.length ) {
2870                 this.$indicator.attr( 'title', indicatorTitle );
2871         } else {
2872                 this.$indicator.removeAttr( 'title' );
2873         }
2874
2875         return this;
2876 };
2877
2878 /**
2879  * Get indicator.
2880  *
2881  * @return {string} title Symbolic name of indicator
2882  */
2883 OO.ui.IndicatedElement.prototype.getIndicator = function () {
2884         return this.indicator;
2885 };
2886
2887 /**
2888  * Get indicator title.
2889  *
2890  * @return {string} Indicator title text
2891  */
2892 OO.ui.IndicatedElement.prototype.getIndicatorTitle = function () {
2893         return this.indicatorTitle;
2894 };
2895 /**
2896  * Element containing a label.
2897  *
2898  * @abstract
2899  * @class
2900  *
2901  * @constructor
2902  * @param {jQuery} $label Label node, assigned to #$label
2903  * @param {Object} [config] Configuration options
2904  * @cfg {jQuery|string|Function} [label] Label nodes, text or a function that returns nodes or text
2905  * @cfg {boolean} [autoFitLabel=true] Whether to fit the label or not.
2906  */
2907 OO.ui.LabeledElement = function OoUiLabeledElement( $label, config ) {
2908         // Config intialization
2909         config = config || {};
2910
2911         // Properties
2912         this.$label = $label;
2913         this.label = null;
2914
2915         // Initialization
2916         this.$label.addClass( 'oo-ui-labeledElement-label' );
2917         this.setLabel( config.label || this.constructor.static.label );
2918         this.autoFitLabel = config.autoFitLabel === undefined || !!config.autoFitLabel;
2919 };
2920
2921 /* Setup */
2922
2923 OO.initClass( OO.ui.LabeledElement );
2924
2925 /* Static Properties */
2926
2927 /**
2928  * Label.
2929  *
2930  * @static
2931  * @inheritable
2932  * @property {string|Function|null} Label text; a function that returns a nodes or text; or null for
2933  *  no label
2934  */
2935 OO.ui.LabeledElement.static.label = null;
2936
2937 /* Methods */
2938
2939 /**
2940  * Set the label.
2941  *
2942  * An empty string will result in the label being hidden. A string containing only whitespace will
2943  * be converted to a single &nbsp;
2944  *
2945  * @param {jQuery|string|Function|null} label Label nodes; text; a function that retuns nodes or
2946  *  text; or null for no label
2947  * @chainable
2948  */
2949 OO.ui.LabeledElement.prototype.setLabel = function ( label ) {
2950         var empty = false;
2951
2952         this.label = label = OO.ui.resolveMsg( label ) || null;
2953         if ( typeof label === 'string' && label.length ) {
2954                 if ( label.match( /^\s*$/ ) ) {
2955                         // Convert whitespace only string to a single non-breaking space
2956                         this.$label.html( '&nbsp;' );
2957                 } else {
2958                         this.$label.text( label );
2959                 }
2960         } else if ( label instanceof jQuery ) {
2961                 this.$label.empty().append( label );
2962         } else {
2963                 this.$label.empty();
2964                 empty = true;
2965         }
2966         this.$element.toggleClass( 'oo-ui-labeledElement', !empty );
2967         this.$label.css( 'display', empty ? 'none' : '' );
2968
2969         return this;
2970 };
2971
2972 /**
2973  * Get the label.
2974  *
2975  * @return {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
2976  *  text; or null for no label
2977  */
2978 OO.ui.LabeledElement.prototype.getLabel = function () {
2979         return this.label;
2980 };
2981
2982 /**
2983  * Fit the label.
2984  *
2985  * @chainable
2986  */
2987 OO.ui.LabeledElement.prototype.fitLabel = function () {
2988         if ( this.$label.autoEllipsis && this.autoFitLabel ) {
2989                 this.$label.autoEllipsis( { 'hasSpan': false, 'tooltip': true } );
2990         }
2991         return this;
2992 };
2993 /**
2994  * Popuppable element.
2995  *
2996  * @abstract
2997  * @class
2998  *
2999  * @constructor
3000  * @param {Object} [config] Configuration options
3001  * @cfg {number} [popupWidth=320] Width of popup
3002  * @cfg {number} [popupHeight] Height of popup
3003  * @cfg {Object} [popup] Configuration to pass to popup
3004  */
3005 OO.ui.PopuppableElement = function OoUiPopuppableElement( config ) {
3006         // Configuration initialization
3007         config = $.extend( { 'popupWidth': 320 }, config );
3008
3009         // Properties
3010         this.popup = new OO.ui.PopupWidget( $.extend(
3011                 { 'align': 'center', 'autoClose': true },
3012                 config.popup,
3013                 { '$': this.$, '$autoCloseIgnore': this.$element }
3014         ) );
3015         this.popupWidth = config.popupWidth;
3016         this.popupHeight = config.popupHeight;
3017 };
3018
3019 /* Methods */
3020
3021 /**
3022  * Get popup.
3023  *
3024  * @return {OO.ui.PopupWidget} Popup widget
3025  */
3026 OO.ui.PopuppableElement.prototype.getPopup = function () {
3027         return this.popup;
3028 };
3029
3030 /**
3031  * Show popup.
3032  */
3033 OO.ui.PopuppableElement.prototype.showPopup = function () {
3034         this.popup.show().display( this.popupWidth, this.popupHeight );
3035 };
3036
3037 /**
3038  * Hide popup.
3039  */
3040 OO.ui.PopuppableElement.prototype.hidePopup = function () {
3041         this.popup.hide();
3042 };
3043 /**
3044  * Element with a title.
3045  *
3046  * @abstract
3047  * @class
3048  *
3049  * @constructor
3050  * @param {jQuery} $label Titled node, assigned to #$titled
3051  * @param {Object} [config] Configuration options
3052  * @cfg {string|Function} [title] Title text or a function that returns text
3053  */
3054 OO.ui.TitledElement = function OoUiTitledElement( $titled, config ) {
3055         // Config intialization
3056         config = config || {};
3057
3058         // Properties
3059         this.$titled = $titled;
3060         this.title = null;
3061
3062         // Initialization
3063         this.setTitle( config.title || this.constructor.static.title );
3064 };
3065
3066 /* Setup */
3067
3068 OO.initClass( OO.ui.TitledElement );
3069
3070 /* Static Properties */
3071
3072 /**
3073  * Title.
3074  *
3075  * @static
3076  * @inheritable
3077  * @property {string|Function} Title text or a function that returns text
3078  */
3079 OO.ui.TitledElement.static.title = null;
3080
3081 /* Methods */
3082
3083 /**
3084  * Set title.
3085  *
3086  * @param {string|Function|null} title Title text, a function that returns text or null for no title
3087  * @chainable
3088  */
3089 OO.ui.TitledElement.prototype.setTitle = function ( title ) {
3090         this.title = title = OO.ui.resolveMsg( title ) || null;
3091
3092         if ( typeof title === 'string' && title.length ) {
3093                 this.$titled.attr( 'title', title );
3094         } else {
3095                 this.$titled.removeAttr( 'title' );
3096         }
3097
3098         return this;
3099 };
3100
3101 /**
3102  * Get title.
3103  *
3104  * @return {string} Title string
3105  */
3106 OO.ui.TitledElement.prototype.getTitle = function () {
3107         return this.title;
3108 };
3109 /**
3110  * Generic toolbar tool.
3111  *
3112  * @abstract
3113  * @class
3114  * @extends OO.ui.Widget
3115  * @mixins OO.ui.IconedElement
3116  *
3117  * @constructor
3118  * @param {OO.ui.ToolGroup} toolGroup
3119  * @param {Object} [config] Configuration options
3120  * @cfg {string|Function} [title] Title text or a function that returns text
3121  */
3122 OO.ui.Tool = function OoUiTool( toolGroup, config ) {
3123         // Config intialization
3124         config = config || {};
3125
3126         // Parent constructor
3127         OO.ui.Tool.super.call( this, config );
3128
3129         // Mixin constructors
3130         OO.ui.IconedElement.call( this, this.$( '<span>' ), config );
3131
3132         // Properties
3133         this.toolGroup = toolGroup;
3134         this.toolbar = this.toolGroup.getToolbar();
3135         this.active = false;
3136         this.$title = this.$( '<span>' );
3137         this.$link = this.$( '<a>' );
3138         this.title = null;
3139
3140         // Events
3141         this.toolbar.connect( this, { 'updateState': 'onUpdateState' } );
3142
3143         // Initialization
3144         this.$title.addClass( 'oo-ui-tool-title' );
3145         this.$link
3146                 .addClass( 'oo-ui-tool-link' )
3147                 .append( this.$icon, this.$title );
3148         this.$element
3149                 .data( 'oo-ui-tool', this )
3150                 .addClass(
3151                         'oo-ui-tool ' + 'oo-ui-tool-name-' +
3152                         this.constructor.static.name.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' )
3153                 )
3154                 .append( this.$link );
3155         this.setTitle( config.title || this.constructor.static.title );
3156 };
3157
3158 /* Setup */
3159
3160 OO.inheritClass( OO.ui.Tool, OO.ui.Widget );
3161 OO.mixinClass( OO.ui.Tool, OO.ui.IconedElement );
3162
3163 /* Events */
3164
3165 /**
3166  * @event select
3167  */
3168
3169 /* Static Properties */
3170
3171 /**
3172  * @static
3173  * @inheritdoc
3174  */
3175 OO.ui.Tool.static.tagName = 'span';
3176
3177 /**
3178  * Symbolic name of tool.
3179  *
3180  * @abstract
3181  * @static
3182  * @inheritable
3183  * @property {string}
3184  */
3185 OO.ui.Tool.static.name = '';
3186
3187 /**
3188  * Tool group.
3189  *
3190  * @abstract
3191  * @static
3192  * @inheritable
3193  * @property {string}
3194  */
3195 OO.ui.Tool.static.group = '';
3196
3197 /**
3198  * Tool title.
3199  *
3200  * Title is used as a tooltip when the tool is part of a bar tool group, or a label when the tool
3201  * is part of a list or menu tool group. If a trigger is associated with an action by the same name
3202  * as the tool, a description of its keyboard shortcut for the appropriate platform will be
3203  * appended to the title if the tool is part of a bar tool group.
3204  *
3205  * @abstract
3206  * @static
3207  * @inheritable
3208  * @property {string|Function} Title text or a function that returns text
3209  */
3210 OO.ui.Tool.static.title = '';
3211
3212 /**
3213  * Tool can be automatically added to catch-all groups.
3214  *
3215  * @static
3216  * @inheritable
3217  * @property {boolean}
3218  */
3219 OO.ui.Tool.static.autoAddToCatchall = true;
3220
3221 /**
3222  * Tool can be automatically added to named groups.
3223  *
3224  * @static
3225  * @property {boolean}
3226  * @inheritable
3227  */
3228 OO.ui.Tool.static.autoAddToGroup = true;
3229
3230 /**
3231  * Check if this tool is compatible with given data.
3232  *
3233  * @static
3234  * @inheritable
3235  * @param {Mixed} data Data to check
3236  * @return {boolean} Tool can be used with data
3237  */
3238 OO.ui.Tool.static.isCompatibleWith = function () {
3239         return false;
3240 };
3241
3242 /* Methods */
3243
3244 /**
3245  * Handle the toolbar state being updated.
3246  *
3247  * This is an abstract method that must be overridden in a concrete subclass.
3248  *
3249  * @abstract
3250  */
3251 OO.ui.Tool.prototype.onUpdateState = function () {
3252         throw new Error(
3253                 'OO.ui.Tool.onUpdateState not implemented in this subclass:' + this.constructor
3254         );
3255 };
3256
3257 /**
3258  * Handle the tool being selected.
3259  *
3260  * This is an abstract method that must be overridden in a concrete subclass.
3261  *
3262  * @abstract
3263  */
3264 OO.ui.Tool.prototype.onSelect = function () {
3265         throw new Error(
3266                 'OO.ui.Tool.onSelect not implemented in this subclass:' + this.constructor
3267         );
3268 };
3269
3270 /**
3271  * Check if the button is active.
3272  *
3273  * @param {boolean} Button is active
3274  */
3275 OO.ui.Tool.prototype.isActive = function () {
3276         return this.active;
3277 };
3278
3279 /**
3280  * Make the button appear active or inactive.
3281  *
3282  * @param {boolean} state Make button appear active
3283  */
3284 OO.ui.Tool.prototype.setActive = function ( state ) {
3285         this.active = !!state;
3286         if ( this.active ) {
3287                 this.$element.addClass( 'oo-ui-tool-active' );
3288         } else {
3289                 this.$element.removeClass( 'oo-ui-tool-active' );
3290         }
3291 };
3292
3293 /**
3294  * Get the tool title.
3295  *
3296  * @param {string|Function} title Title text or a function that returns text
3297  * @chainable
3298  */
3299 OO.ui.Tool.prototype.setTitle = function ( title ) {
3300         this.title = OO.ui.resolveMsg( title );
3301         this.updateTitle();
3302         return this;
3303 };
3304
3305 /**
3306  * Get the tool title.
3307  *
3308  * @return {string} Title text
3309  */
3310 OO.ui.Tool.prototype.getTitle = function () {
3311         return this.title;
3312 };
3313
3314 /**
3315  * Get the tool's symbolic name.
3316  *
3317  * @return {string} Symbolic name of tool
3318  */
3319 OO.ui.Tool.prototype.getName = function () {
3320         return this.constructor.static.name;
3321 };
3322
3323 /**
3324  * Update the title.
3325  */
3326 OO.ui.Tool.prototype.updateTitle = function () {
3327         var titleTooltips = this.toolGroup.constructor.static.titleTooltips,
3328                 accelTooltips = this.toolGroup.constructor.static.accelTooltips,
3329                 accel = this.toolbar.getToolAccelerator( this.constructor.static.name ),
3330                 tooltipParts = [];
3331
3332         this.$title.empty()
3333                 .text( this.title )
3334                 .append(
3335                         this.$( '<span>' )
3336                                 .addClass( 'oo-ui-tool-accel' )
3337                                 .text( accel )
3338                 );
3339
3340         if ( titleTooltips && typeof this.title === 'string' && this.title.length ) {
3341                 tooltipParts.push( this.title );
3342         }
3343         if ( accelTooltips && typeof accel === 'string' && accel.length ) {
3344                 tooltipParts.push( accel );
3345         }
3346         if ( tooltipParts.length ) {
3347                 this.$link.attr( 'title', tooltipParts.join( ' ' ) );
3348         } else {
3349                 this.$link.removeAttr( 'title' );
3350         }
3351 };
3352
3353 /**
3354  * Destroy tool.
3355  */
3356 OO.ui.Tool.prototype.destroy = function () {
3357         this.toolbar.disconnect( this );
3358         this.$element.remove();
3359 };
3360 /**
3361  * Collection of tool groups.
3362  *
3363  * @class
3364  * @extends OO.ui.Element
3365  * @mixins OO.EventEmitter
3366  * @mixins OO.ui.GroupElement
3367  *
3368  * @constructor
3369  * @param {OO.ui.ToolFactory} toolFactory Factory for creating tools
3370  * @param {OO.ui.ToolGroupFactory} toolGroupFactory Factory for creating tool groups
3371  * @param {Object} [config] Configuration options
3372  * @cfg {boolean} [actions] Add an actions section opposite to the tools
3373  * @cfg {boolean} [shadow] Add a shadow below the toolbar
3374  */
3375 OO.ui.Toolbar = function OoUiToolbar( toolFactory, toolGroupFactory, config ) {
3376         // Configuration initialization
3377         config = config || {};
3378
3379         // Parent constructor
3380         OO.ui.Toolbar.super.call( this, config );
3381
3382         // Mixin constructors
3383         OO.EventEmitter.call( this );
3384         OO.ui.GroupElement.call( this, this.$( '<div>' ), config );
3385
3386         // Properties
3387         this.toolFactory = toolFactory;
3388         this.toolGroupFactory = toolGroupFactory;
3389         this.groups = [];
3390         this.tools = {};
3391         this.$bar = this.$( '<div>' );
3392         this.$actions = this.$( '<div>' );
3393         this.initialized = false;
3394
3395         // Events
3396         this.$element
3397                 .add( this.$bar ).add( this.$group ).add( this.$actions )
3398                 .on( 'mousedown', OO.ui.bind( this.onMouseDown, this ) );
3399
3400         // Initialization
3401         this.$group.addClass( 'oo-ui-toolbar-tools' );
3402         this.$bar.addClass( 'oo-ui-toolbar-bar' ).append( this.$group );
3403         if ( config.actions ) {
3404                 this.$actions.addClass( 'oo-ui-toolbar-actions' );
3405                 this.$bar.append( this.$actions );
3406         }
3407         this.$bar.append( '<div style="clear:both"></div>' );
3408         if ( config.shadow ) {
3409                 this.$bar.append( '<div class="oo-ui-toolbar-shadow"></div>' );
3410         }
3411         this.$element.addClass( 'oo-ui-toolbar' ).append( this.$bar );
3412 };
3413
3414 /* Setup */
3415
3416 OO.inheritClass( OO.ui.Toolbar, OO.ui.Element );
3417 OO.mixinClass( OO.ui.Toolbar, OO.EventEmitter );
3418 OO.mixinClass( OO.ui.Toolbar, OO.ui.GroupElement );
3419
3420 /* Methods */
3421
3422 /**
3423  * Get the tool factory.
3424  *
3425  * @return {OO.ui.ToolFactory} Tool factory
3426  */
3427 OO.ui.Toolbar.prototype.getToolFactory = function () {
3428         return this.toolFactory;
3429 };
3430
3431 /**
3432  * Get the tool group factory.
3433  *
3434  * @return {OO.Factory} Tool group factory
3435  */
3436 OO.ui.Toolbar.prototype.getToolGroupFactory = function () {
3437         return this.toolGroupFactory;
3438 };
3439
3440 /**
3441  * Handles mouse down events.
3442  *
3443  * @param {jQuery.Event} e Mouse down event
3444  */
3445 OO.ui.Toolbar.prototype.onMouseDown = function ( e ) {
3446         var $closestWidgetToEvent = this.$( e.target ).closest( '.oo-ui-widget' ),
3447                 $closestWidgetToToolbar = this.$element.closest( '.oo-ui-widget' );
3448         if ( !$closestWidgetToEvent.length || $closestWidgetToEvent[0] === $closestWidgetToToolbar[0] ) {
3449                 return false;
3450         }
3451 };
3452
3453 /**
3454  * Sets up handles and preloads required information for the toolbar to work.
3455  * This must be called immediately after it is attached to a visible document.
3456  */
3457 OO.ui.Toolbar.prototype.initialize = function () {
3458         this.initialized = true;
3459 };
3460
3461 /**
3462  * Setup toolbar.
3463  *
3464  * Tools can be specified in the following ways:
3465  *
3466  * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3467  * - All tools in a group: `{ 'group': 'group-name' }`
3468  * - All tools: `'*'` - Using this will make the group a list with a "More" label by default
3469  *
3470  * @param {Object.<string,Array>} groups List of tool group configurations
3471  * @param {Array|string} [groups.include] Tools to include
3472  * @param {Array|string} [groups.exclude] Tools to exclude
3473  * @param {Array|string} [groups.promote] Tools to promote to the beginning
3474  * @param {Array|string} [groups.demote] Tools to demote to the end
3475  */
3476 OO.ui.Toolbar.prototype.setup = function ( groups ) {
3477         var i, len, type, group,
3478                 items = [],
3479                 defaultType = 'bar';
3480
3481         // Cleanup previous groups
3482         this.reset();
3483
3484         // Build out new groups
3485         for ( i = 0, len = groups.length; i < len; i++ ) {
3486                 group = groups[i];
3487                 if ( group.include === '*' ) {
3488                         // Apply defaults to catch-all groups
3489                         if ( group.type === undefined ) {
3490                                 group.type = 'list';
3491                         }
3492                         if ( group.label === undefined ) {
3493                                 group.label = 'ooui-toolbar-more';
3494                         }
3495                 }
3496                 // Check type has been registered
3497                 type = this.getToolGroupFactory().lookup( group.type ) ? group.type : defaultType;
3498                 items.push(
3499                         this.getToolGroupFactory().create( type, this, $.extend( { '$': this.$ }, group ) )
3500                 );
3501         }
3502         this.addItems( items );
3503 };
3504
3505 /**
3506  * Remove all tools and groups from the toolbar.
3507  */
3508 OO.ui.Toolbar.prototype.reset = function () {
3509         var i, len;
3510
3511         this.groups = [];
3512         this.tools = {};
3513         for ( i = 0, len = this.items.length; i < len; i++ ) {
3514                 this.items[i].destroy();
3515         }
3516         this.clearItems();
3517 };
3518
3519 /**
3520  * Destroys toolbar, removing event handlers and DOM elements.
3521  *
3522  * Call this whenever you are done using a toolbar.
3523  */
3524 OO.ui.Toolbar.prototype.destroy = function () {
3525         this.reset();
3526         this.$element.remove();
3527 };
3528
3529 /**
3530  * Check if tool has not been used yet.
3531  *
3532  * @param {string} name Symbolic name of tool
3533  * @return {boolean} Tool is available
3534  */
3535 OO.ui.Toolbar.prototype.isToolAvailable = function ( name ) {
3536         return !this.tools[name];
3537 };
3538
3539 /**
3540  * Prevent tool from being used again.
3541  *
3542  * @param {OO.ui.Tool} tool Tool to reserve
3543  */
3544 OO.ui.Toolbar.prototype.reserveTool = function ( tool ) {
3545         this.tools[tool.getName()] = tool;
3546 };
3547
3548 /**
3549  * Allow tool to be used again.
3550  *
3551  * @param {OO.ui.Tool} tool Tool to release
3552  */
3553 OO.ui.Toolbar.prototype.releaseTool = function ( tool ) {
3554         delete this.tools[tool.getName()];
3555 };
3556
3557 /**
3558  * Get accelerator label for tool.
3559  *
3560  * This is a stub that should be overridden to provide access to accelerator information.
3561  *
3562  * @param {string} name Symbolic name of tool
3563  * @return {string|undefined} Tool accelerator label if available
3564  */
3565 OO.ui.Toolbar.prototype.getToolAccelerator = function () {
3566         return undefined;
3567 };
3568 /**
3569  * Factory for tools.
3570  *
3571  * @class
3572  * @extends OO.Factory
3573  * @constructor
3574  */
3575 OO.ui.ToolFactory = function OoUiToolFactory() {
3576         // Parent constructor
3577         OO.ui.ToolFactory.super.call( this );
3578 };
3579
3580 /* Setup */
3581
3582 OO.inheritClass( OO.ui.ToolFactory, OO.Factory );
3583
3584 /* Methods */
3585
3586 /** */
3587 OO.ui.ToolFactory.prototype.getTools = function ( include, exclude, promote, demote ) {
3588         var i, len, included, promoted, demoted,
3589                 auto = [],
3590                 used = {};
3591
3592         // Collect included and not excluded tools
3593         included = OO.simpleArrayDifference( this.extract( include ), this.extract( exclude ) );
3594
3595         // Promotion
3596         promoted = this.extract( promote, used );
3597         demoted = this.extract( demote, used );
3598
3599         // Auto
3600         for ( i = 0, len = included.length; i < len; i++ ) {
3601                 if ( !used[included[i]] ) {
3602                         auto.push( included[i] );
3603                 }
3604         }
3605
3606         return promoted.concat( auto ).concat( demoted );
3607 };
3608
3609 /**
3610  * Get a flat list of names from a list of names or groups.
3611  *
3612  * Tools can be specified in the following ways:
3613  *
3614  * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3615  * - All tools in a group: `{ 'group': 'group-name' }`
3616  * - All tools: `'*'`
3617  *
3618  * @private
3619  * @param {Array|string} collection List of tools
3620  * @param {Object} [used] Object with names that should be skipped as properties; extracted
3621  *  names will be added as properties
3622  * @return {string[]} List of extracted names
3623  */
3624 OO.ui.ToolFactory.prototype.extract = function ( collection, used ) {
3625         var i, len, item, name, tool,
3626                 names = [];
3627
3628         if ( collection === '*' ) {
3629                 for ( name in this.registry ) {
3630                         tool = this.registry[name];
3631                         if (
3632                                 // Only add tools by group name when auto-add is enabled
3633                                 tool.static.autoAddToCatchall &&
3634                                 // Exclude already used tools
3635                                 ( !used || !used[name] )
3636                         ) {
3637                                 names.push( name );
3638                                 if ( used ) {
3639                                         used[name] = true;
3640                                 }
3641                         }
3642                 }
3643         } else if ( $.isArray( collection ) ) {
3644                 for ( i = 0, len = collection.length; i < len; i++ ) {
3645                         item = collection[i];
3646                         // Allow plain strings as shorthand for named tools
3647                         if ( typeof item === 'string' ) {
3648                                 item = { 'name': item };
3649                         }
3650                         if ( OO.isPlainObject( item ) ) {
3651                                 if ( item.group ) {
3652                                         for ( name in this.registry ) {
3653                                                 tool = this.registry[name];
3654                                                 if (
3655                                                         // Include tools with matching group
3656                                                         tool.static.group === item.group &&
3657                                                         // Only add tools by group name when auto-add is enabled
3658                                                         tool.static.autoAddToGroup &&
3659                                                         // Exclude already used tools
3660                                                         ( !used || !used[name] )
3661                                                 ) {
3662                                                         names.push( name );
3663                                                         if ( used ) {
3664                                                                 used[name] = true;
3665                                                         }
3666                                                 }
3667                                         }
3668                                 // Include tools with matching name and exclude already used tools
3669                                 } else if ( item.name && ( !used || !used[item.name] ) ) {
3670                                         names.push( item.name );
3671                                         if ( used ) {
3672                                                 used[item.name] = true;
3673                                         }
3674                                 }
3675                         }
3676                 }
3677         }
3678         return names;
3679 };
3680 /**
3681  * Collection of tools.
3682  *
3683  * Tools can be specified in the following ways:
3684  *
3685  * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3686  * - All tools in a group: `{ 'group': 'group-name' }`
3687  * - All tools: `'*'`
3688  *
3689  * @abstract
3690  * @class
3691  * @extends OO.ui.Widget
3692  * @mixins OO.ui.GroupElement
3693  *
3694  * @constructor
3695  * @param {OO.ui.Toolbar} toolbar
3696  * @param {Object} [config] Configuration options
3697  * @cfg {Array|string} [include=[]] List of tools to include
3698  * @cfg {Array|string} [exclude=[]] List of tools to exclude
3699  * @cfg {Array|string} [promote=[]] List of tools to promote to the beginning
3700  * @cfg {Array|string} [demote=[]] List of tools to demote to the end
3701  */
3702 OO.ui.ToolGroup = function OoUiToolGroup( toolbar, config ) {
3703         // Configuration initialization
3704         config = config || {};
3705
3706         // Parent constructor
3707         OO.ui.ToolGroup.super.call( this, config );
3708
3709         // Mixin constructors
3710         OO.ui.GroupElement.call( this, this.$( '<div>' ), config );
3711
3712         // Properties
3713         this.toolbar = toolbar;
3714         this.tools = {};
3715         this.pressed = null;
3716         this.autoDisabled = false;
3717         this.include = config.include || [];
3718         this.exclude = config.exclude || [];
3719         this.promote = config.promote || [];
3720         this.demote = config.demote || [];
3721         this.onCapturedMouseUpHandler = OO.ui.bind( this.onCapturedMouseUp, this );
3722
3723         // Events
3724         this.$element.on( {
3725                 'mousedown': OO.ui.bind( this.onMouseDown, this ),
3726                 'mouseup': OO.ui.bind( this.onMouseUp, this ),
3727                 'mouseover': OO.ui.bind( this.onMouseOver, this ),
3728                 'mouseout': OO.ui.bind( this.onMouseOut, this )
3729         } );
3730         this.toolbar.getToolFactory().connect( this, { 'register': 'onToolFactoryRegister' } );
3731         this.aggregate( { 'disable': 'itemDisable' } );
3732         this.connect( this, { 'itemDisable': 'updateDisabled' } );
3733
3734         // Initialization
3735         this.$group.addClass( 'oo-ui-toolGroup-tools' );
3736         this.$element
3737                 .addClass( 'oo-ui-toolGroup' )
3738                 .append( this.$group );
3739         this.populate();
3740 };
3741
3742 /* Setup */
3743
3744 OO.inheritClass( OO.ui.ToolGroup, OO.ui.Widget );
3745 OO.mixinClass( OO.ui.ToolGroup, OO.ui.GroupElement );
3746
3747 /* Events */
3748
3749 /**
3750  * @event update
3751  */
3752
3753 /* Static Properties */
3754
3755 /**
3756  * Show labels in tooltips.
3757  *
3758  * @static
3759  * @inheritable
3760  * @property {boolean}
3761  */
3762 OO.ui.ToolGroup.static.titleTooltips = false;
3763
3764 /**
3765  * Show acceleration labels in tooltips.
3766  *
3767  * @static
3768  * @inheritable
3769  * @property {boolean}
3770  */
3771 OO.ui.ToolGroup.static.accelTooltips = false;
3772
3773 /**
3774  * Automatically disable the toolgroup when all tools are disabled
3775  *
3776  * @static
3777  * @inheritable
3778  * @property {boolean}
3779  */
3780 OO.ui.ToolGroup.static.autoDisable = true;
3781
3782 /* Methods */
3783
3784 /**
3785  * @inheritdoc
3786  */
3787 OO.ui.ToolGroup.prototype.isDisabled = function () {
3788         return this.autoDisabled || OO.ui.ToolGroup.super.prototype.isDisabled.apply( this, arguments );
3789 };
3790
3791 /**
3792  * @inheritdoc
3793  */
3794 OO.ui.ToolGroup.prototype.updateDisabled = function () {
3795         var i, item, allDisabled = true;
3796
3797         if ( this.constructor.static.autoDisable ) {
3798                 for ( i = this.items.length - 1; i >= 0; i-- ) {
3799                         item = this.items[i];
3800                         if ( !item.isDisabled() ) {
3801                                 allDisabled = false;
3802                                 break;
3803                         }
3804                 }
3805                 this.autoDisabled = allDisabled;
3806         }
3807         OO.ui.ToolGroup.super.prototype.updateDisabled.apply( this, arguments );
3808 };
3809
3810 /**
3811  * Handle mouse down events.
3812  *
3813  * @param {jQuery.Event} e Mouse down event
3814  */
3815 OO.ui.ToolGroup.prototype.onMouseDown = function ( e ) {
3816         if ( !this.isDisabled() && e.which === 1 ) {
3817                 this.pressed = this.getTargetTool( e );
3818                 if ( this.pressed ) {
3819                         this.pressed.setActive( true );
3820                         this.getElementDocument().addEventListener(
3821                                 'mouseup', this.onCapturedMouseUpHandler, true
3822                         );
3823                         return false;
3824                 }
3825         }
3826 };
3827
3828 /**
3829  * Handle captured mouse up events.
3830  *
3831  * @param {Event} e Mouse up event
3832  */
3833 OO.ui.ToolGroup.prototype.onCapturedMouseUp = function ( e ) {
3834         this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseUpHandler, true );
3835         // onMouseUp may be called a second time, depending on where the mouse is when the button is
3836         // released, but since `this.pressed` will no longer be true, the second call will be ignored.
3837         this.onMouseUp( e );
3838 };
3839
3840 /**
3841  * Handle mouse up events.
3842  *
3843  * @param {jQuery.Event} e Mouse up event
3844  */
3845 OO.ui.ToolGroup.prototype.onMouseUp = function ( e ) {
3846         var tool = this.getTargetTool( e );
3847
3848         if ( !this.isDisabled() && e.which === 1 && this.pressed && this.pressed === tool ) {
3849                 this.pressed.onSelect();
3850         }
3851
3852         this.pressed = null;
3853         return false;
3854 };
3855
3856 /**
3857  * Handle mouse over events.
3858  *
3859  * @param {jQuery.Event} e Mouse over event
3860  */
3861 OO.ui.ToolGroup.prototype.onMouseOver = function ( e ) {
3862         var tool = this.getTargetTool( e );
3863
3864         if ( this.pressed && this.pressed === tool ) {
3865                 this.pressed.setActive( true );
3866         }
3867 };
3868
3869 /**
3870  * Handle mouse out events.
3871  *
3872  * @param {jQuery.Event} e Mouse out event
3873  */
3874 OO.ui.ToolGroup.prototype.onMouseOut = function ( e ) {
3875         var tool = this.getTargetTool( e );
3876
3877         if ( this.pressed && this.pressed === tool ) {
3878                 this.pressed.setActive( false );
3879         }
3880 };
3881
3882 /**
3883  * Get the closest tool to a jQuery.Event.
3884  *
3885  * Only tool links are considered, which prevents other elements in the tool such as popups from
3886  * triggering tool group interactions.
3887  *
3888  * @private
3889  * @param {jQuery.Event} e
3890  * @return {OO.ui.Tool|null} Tool, `null` if none was found
3891  */
3892 OO.ui.ToolGroup.prototype.getTargetTool = function ( e ) {
3893         var tool,
3894                 $item = this.$( e.target ).closest( '.oo-ui-tool-link' );
3895
3896         if ( $item.length ) {
3897                 tool = $item.parent().data( 'oo-ui-tool' );
3898         }
3899
3900         return tool && !tool.isDisabled() ? tool : null;
3901 };
3902
3903 /**
3904  * Handle tool registry register events.
3905  *
3906  * If a tool is registered after the group is created, we must repopulate the list to account for:
3907  *
3908  * - a tool being added that may be included
3909  * - a tool already included being overridden
3910  *
3911  * @param {string} name Symbolic name of tool
3912  */
3913 OO.ui.ToolGroup.prototype.onToolFactoryRegister = function () {
3914         this.populate();
3915 };
3916
3917 /**
3918  * Get the toolbar this group is in.
3919  *
3920  * @return {OO.ui.Toolbar} Toolbar of group
3921  */
3922 OO.ui.ToolGroup.prototype.getToolbar = function () {
3923         return this.toolbar;
3924 };
3925
3926 /**
3927  * Add and remove tools based on configuration.
3928  */
3929 OO.ui.ToolGroup.prototype.populate = function () {
3930         var i, len, name, tool,
3931                 toolFactory = this.toolbar.getToolFactory(),
3932                 names = {},
3933                 add = [],
3934                 remove = [],
3935                 list = this.toolbar.getToolFactory().getTools(
3936                         this.include, this.exclude, this.promote, this.demote
3937                 );
3938
3939         // Build a list of needed tools
3940         for ( i = 0, len = list.length; i < len; i++ ) {
3941                 name = list[i];
3942                 if (
3943                         // Tool exists
3944                         toolFactory.lookup( name ) &&
3945                         // Tool is available or is already in this group
3946                         ( this.toolbar.isToolAvailable( name ) || this.tools[name] )
3947                 ) {
3948                         tool = this.tools[name];
3949                         if ( !tool ) {
3950                                 // Auto-initialize tools on first use
3951                                 this.tools[name] = tool = toolFactory.create( name, this );
3952                                 tool.updateTitle();
3953                         }
3954                         this.toolbar.reserveTool( tool );
3955                         add.push( tool );
3956                         names[name] = true;
3957                 }
3958         }
3959         // Remove tools that are no longer needed
3960         for ( name in this.tools ) {
3961                 if ( !names[name] ) {
3962                         this.tools[name].destroy();
3963                         this.toolbar.releaseTool( this.tools[name] );
3964                         remove.push( this.tools[name] );
3965                         delete this.tools[name];
3966                 }
3967         }
3968         if ( remove.length ) {
3969                 this.removeItems( remove );
3970         }
3971         // Update emptiness state
3972         if ( add.length ) {
3973                 this.$element.removeClass( 'oo-ui-toolGroup-empty' );
3974         } else {
3975                 this.$element.addClass( 'oo-ui-toolGroup-empty' );
3976         }
3977         // Re-add tools (moving existing ones to new locations)
3978         this.addItems( add );
3979         // Disabled state may depend on items
3980         this.updateDisabled();
3981 };
3982
3983 /**
3984  * Destroy tool group.
3985  */
3986 OO.ui.ToolGroup.prototype.destroy = function () {
3987         var name;
3988
3989         this.clearItems();
3990         this.toolbar.getToolFactory().disconnect( this );
3991         for ( name in this.tools ) {
3992                 this.toolbar.releaseTool( this.tools[name] );
3993                 this.tools[name].disconnect( this ).destroy();
3994                 delete this.tools[name];
3995         }
3996         this.$element.remove();
3997 };
3998 /**
3999  * Factory for tool groups.
4000  *
4001  * @class
4002  * @extends OO.Factory
4003  * @constructor
4004  */
4005 OO.ui.ToolGroupFactory = function OoUiToolGroupFactory() {
4006         // Parent constructor
4007         OO.Factory.call( this );
4008
4009         var i, l,
4010                 defaultClasses = this.constructor.static.getDefaultClasses();
4011
4012         // Register default toolgroups
4013         for ( i = 0, l = defaultClasses.length; i < l; i++ ) {
4014                 this.register( defaultClasses[i] );
4015         }
4016 };
4017
4018 /* Setup */
4019
4020 OO.inheritClass( OO.ui.ToolGroupFactory, OO.Factory );
4021
4022 /* Static Methods */
4023
4024 /**
4025  * Get a default set of classes to be registered on construction
4026  *
4027  * @return {Function[]} Default classes
4028  */
4029 OO.ui.ToolGroupFactory.static.getDefaultClasses = function () {
4030         return [
4031                 OO.ui.BarToolGroup,
4032                 OO.ui.ListToolGroup,
4033                 OO.ui.MenuToolGroup
4034         ];
4035 };
4036 /**
4037  * Layout made of a fieldset and optional legend.
4038  *
4039  * Just add OO.ui.FieldLayout items.
4040  *
4041  * @class
4042  * @extends OO.ui.Layout
4043  * @mixins OO.ui.LabeledElement
4044  * @mixins OO.ui.IconedElement
4045  * @mixins OO.ui.GroupElement
4046  *
4047  * @constructor
4048  * @param {Object} [config] Configuration options
4049  * @cfg {string} [icon] Symbolic icon name
4050  * @cfg {OO.ui.FieldLayout[]} [items] Items to add
4051  */
4052 OO.ui.FieldsetLayout = function OoUiFieldsetLayout( config ) {
4053         // Config initialization
4054         config = config || {};
4055
4056         // Parent constructor
4057         OO.ui.FieldsetLayout.super.call( this, config );
4058
4059         // Mixin constructors
4060         OO.ui.IconedElement.call( this, this.$( '<div>' ), config );
4061         OO.ui.LabeledElement.call( this, this.$( '<div>' ), config );
4062         OO.ui.GroupElement.call( this, this.$( '<div>' ), config );
4063
4064         // Initialization
4065         this.$element
4066                 .addClass( 'oo-ui-fieldsetLayout' )
4067                 .prepend( this.$icon, this.$label, this.$group );
4068         if ( $.isArray( config.items ) ) {
4069                 this.addItems( config.items );
4070         }
4071 };
4072
4073 /* Setup */
4074
4075 OO.inheritClass( OO.ui.FieldsetLayout, OO.ui.Layout );
4076 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.IconedElement );
4077 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.LabeledElement );
4078 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.GroupElement );
4079
4080 /* Static Properties */
4081
4082 OO.ui.FieldsetLayout.static.tagName = 'div';
4083 /**
4084  * Layout made of a field and optional label.
4085  *
4086  * @class
4087  * @extends OO.ui.Layout
4088  * @mixins OO.ui.LabeledElement
4089  *
4090  * Available label alignment modes include:
4091  *  - 'left': Label is before the field and aligned away from it, best for when the user will be
4092  *    scanning for a specific label in a form with many fields
4093  *  - 'right': Label is before the field and aligned toward it, best for forms the user is very
4094  *    familiar with and will tab through field checking quickly to verify which field they are in
4095  *  - 'top': Label is before the field and above it, best for when the use will need to fill out all
4096  *    fields from top to bottom in a form with few fields
4097  *  - 'inline': Label is after the field and aligned toward it, best for small boolean fields like
4098  *    checkboxes or radio buttons
4099  *
4100  * @constructor
4101  * @param {OO.ui.Widget} field Field widget
4102  * @param {Object} [config] Configuration options
4103  * @cfg {string} [align='left'] Alignment mode, either 'left', 'right', 'top' or 'inline'
4104  */
4105 OO.ui.FieldLayout = function OoUiFieldLayout( field, config ) {
4106         // Config initialization
4107         config = $.extend( { 'align': 'left' }, config );
4108
4109         // Parent constructor
4110         OO.ui.FieldLayout.super.call( this, config );
4111
4112         // Mixin constructors
4113         OO.ui.LabeledElement.call( this, this.$( '<label>' ), config );
4114
4115         // Properties
4116         this.$field = this.$( '<div>' );
4117         this.field = field;
4118         this.align = null;
4119
4120         // Events
4121         if ( this.field instanceof OO.ui.InputWidget ) {
4122                 this.$label.on( 'click', OO.ui.bind( this.onLabelClick, this ) );
4123         }
4124         this.field.connect( this, { 'disable': 'onFieldDisable' } );
4125
4126         // Initialization
4127         this.$element.addClass( 'oo-ui-fieldLayout' );
4128         this.$field
4129                 .addClass( 'oo-ui-fieldLayout-field' )
4130                 .toggleClass( 'oo-ui-fieldLayout-disable', this.field.isDisabled() )
4131                 .append( this.field.$element );
4132         this.setAlignment( config.align );
4133 };
4134
4135 /* Setup */
4136
4137 OO.inheritClass( OO.ui.FieldLayout, OO.ui.Layout );
4138 OO.mixinClass( OO.ui.FieldLayout, OO.ui.LabeledElement );
4139
4140 /* Methods */
4141
4142 /**
4143  * Handle field disable events.
4144  *
4145  * @param {boolean} value Field is disabled
4146  */
4147 OO.ui.FieldLayout.prototype.onFieldDisable = function ( value ) {
4148         this.$element.toggleClass( 'oo-ui-fieldLayout-disabled', value );
4149 };
4150
4151 /**
4152  * Handle label mouse click events.
4153  *
4154  * @param {jQuery.Event} e Mouse click event
4155  */
4156 OO.ui.FieldLayout.prototype.onLabelClick = function () {
4157         this.field.simulateLabelClick();
4158         return false;
4159 };
4160
4161 /**
4162  * Get the field.
4163  *
4164  * @return {OO.ui.Widget} Field widget
4165  */
4166 OO.ui.FieldLayout.prototype.getField = function () {
4167         return this.field;
4168 };
4169
4170 /**
4171  * Set the field alignment mode.
4172  *
4173  * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
4174  * @chainable
4175  */
4176 OO.ui.FieldLayout.prototype.setAlignment = function ( value ) {
4177         if ( value !== this.align ) {
4178                 // Default to 'left'
4179                 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value ) === -1 ) {
4180                         value = 'left';
4181                 }
4182                 // Reorder elements
4183                 if ( value === 'inline' ) {
4184                         this.$element.append( this.$field, this.$label );
4185                 } else {
4186                         this.$element.append( this.$label, this.$field );
4187                 }
4188                 // Set classes
4189                 if ( this.align ) {
4190                         this.$element.removeClass( 'oo-ui-fieldLayout-align-' + this.align );
4191                 }
4192                 this.align = value;
4193                 this.$element.addClass( 'oo-ui-fieldLayout-align-' + this.align );
4194         }
4195
4196         return this;
4197 };
4198 /**
4199  * Layout made of proportionally sized columns and rows.
4200  *
4201  * @class
4202  * @extends OO.ui.Layout
4203  *
4204  * @constructor
4205  * @param {OO.ui.PanelLayout[]} panels Panels in the grid
4206  * @param {Object} [config] Configuration options
4207  * @cfg {number[]} [widths] Widths of columns as ratios
4208  * @cfg {number[]} [heights] Heights of columns as ratios
4209  */
4210 OO.ui.GridLayout = function OoUiGridLayout( panels, config ) {
4211         var i, len, widths;
4212
4213         // Config initialization
4214         config = config || {};
4215
4216         // Parent constructor
4217         OO.ui.GridLayout.super.call( this, config );
4218
4219         // Properties
4220         this.panels = [];
4221         this.widths = [];
4222         this.heights = [];
4223
4224         // Initialization
4225         this.$element.addClass( 'oo-ui-gridLayout' );
4226         for ( i = 0, len = panels.length; i < len; i++ ) {
4227                 this.panels.push( panels[i] );
4228                 this.$element.append( panels[i].$element );
4229         }
4230         if ( config.widths || config.heights ) {
4231                 this.layout( config.widths || [ 1 ], config.heights || [ 1 ] );
4232         } else {
4233                 // Arrange in columns by default
4234                 widths = [];
4235                 for ( i = 0, len = this.panels.length; i < len; i++ ) {
4236                         widths[i] = 1;
4237                 }
4238                 this.layout( widths, [ 1 ] );
4239         }
4240 };
4241
4242 /* Setup */
4243
4244 OO.inheritClass( OO.ui.GridLayout, OO.ui.Layout );
4245
4246 /* Events */
4247
4248 /**
4249  * @event layout
4250  */
4251
4252 /**
4253  * @event update
4254  */
4255
4256 /* Static Properties */
4257
4258 OO.ui.GridLayout.static.tagName = 'div';
4259
4260 /* Methods */
4261
4262 /**
4263  * Set grid dimensions.
4264  *
4265  * @param {number[]} widths Widths of columns as ratios
4266  * @param {number[]} heights Heights of rows as ratios
4267  * @fires layout
4268  * @throws {Error} If grid is not large enough to fit all panels
4269  */
4270 OO.ui.GridLayout.prototype.layout = function ( widths, heights ) {
4271         var x, y,
4272                 xd = 0,
4273                 yd = 0,
4274                 cols = widths.length,
4275                 rows = heights.length;
4276
4277         // Verify grid is big enough to fit panels
4278         if ( cols * rows < this.panels.length ) {
4279                 throw new Error( 'Grid is not large enough to fit ' + this.panels.length + 'panels' );
4280         }
4281
4282         // Sum up denominators
4283         for ( x = 0; x < cols; x++ ) {
4284                 xd += widths[x];
4285         }
4286         for ( y = 0; y < rows; y++ ) {
4287                 yd += heights[y];
4288         }
4289         // Store factors
4290         this.widths = [];
4291         this.heights = [];
4292         for ( x = 0; x < cols; x++ ) {
4293                 this.widths[x] = widths[x] / xd;
4294         }
4295         for ( y = 0; y < rows; y++ ) {
4296                 this.heights[y] = heights[y] / yd;
4297         }
4298         // Synchronize view
4299         this.update();
4300         this.emit( 'layout' );
4301 };
4302
4303 /**
4304  * Update panel positions and sizes.
4305  *
4306  * @fires update
4307  */
4308 OO.ui.GridLayout.prototype.update = function () {
4309         var x, y, panel,
4310                 i = 0,
4311                 left = 0,
4312                 top = 0,
4313                 dimensions,
4314                 width = 0,
4315                 height = 0,
4316                 cols = this.widths.length,
4317                 rows = this.heights.length;
4318
4319         for ( y = 0; y < rows; y++ ) {
4320                 for ( x = 0; x < cols; x++ ) {
4321                         panel = this.panels[i];
4322                         width = this.widths[x];
4323                         height = this.heights[y];
4324                         dimensions = {
4325                                 'width': Math.round( width * 100 ) + '%',
4326                                 'height': Math.round( height * 100 ) + '%',
4327                                 'top': Math.round( top * 100 ) + '%'
4328                         };
4329                         // If RTL, reverse:
4330                         if ( OO.ui.Element.getDir( this.$.context ) === 'rtl' ) {
4331                                 dimensions.right = Math.round( left * 100 ) + '%';
4332                         } else {
4333                                 dimensions.left = Math.round( left * 100 ) + '%';
4334                         }
4335                         panel.$element.css( dimensions );
4336                         i++;
4337                         left += width;
4338                 }
4339                 top += height;
4340                 left = 0;
4341         }
4342
4343         this.emit( 'update' );
4344 };
4345
4346 /**
4347  * Get a panel at a given position.
4348  *
4349  * The x and y position is affected by the current grid layout.
4350  *
4351  * @param {number} x Horizontal position
4352  * @param {number} y Vertical position
4353  * @return {OO.ui.PanelLayout} The panel at the given postion
4354  */
4355 OO.ui.GridLayout.prototype.getPanel = function ( x, y ) {
4356         return this.panels[( x * this.widths.length ) + y];
4357 };
4358 /**
4359  * Layout containing a series of pages.
4360  *
4361  * @class
4362  * @extends OO.ui.Layout
4363  *
4364  * @constructor
4365  * @param {Object} [config] Configuration options
4366  * @cfg {boolean} [continuous=false] Show all pages, one after another
4367  * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when changing to a page
4368  * @cfg {boolean} [outlined=false] Show an outline
4369  * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
4370  */
4371 OO.ui.BookletLayout = function OoUiBookletLayout( config ) {
4372         // Initialize configuration
4373         config = config || {};
4374
4375         // Parent constructor
4376         OO.ui.BookletLayout.super.call( this, config );
4377
4378         // Properties
4379         this.currentPageName = null;
4380         this.pages = {};
4381         this.ignoreFocus = false;
4382         this.stackLayout = new OO.ui.StackLayout( { '$': this.$, 'continuous': !!config.continuous } );
4383         this.autoFocus = config.autoFocus === undefined ? true : !!config.autoFocus;
4384         this.outlineVisible = false;
4385         this.outlined = !!config.outlined;
4386         if ( this.outlined ) {
4387                 this.editable = !!config.editable;
4388                 this.outlineControlsWidget = null;
4389                 this.outlineWidget = new OO.ui.OutlineWidget( { '$': this.$ } );
4390                 this.outlinePanel = new OO.ui.PanelLayout( { '$': this.$, 'scrollable': true } );
4391                 this.gridLayout = new OO.ui.GridLayout(
4392                         [ this.outlinePanel, this.stackLayout ],
4393                         { '$': this.$, 'widths': [ 1, 2 ] }
4394                 );
4395                 this.outlineVisible = true;
4396                 if ( this.editable ) {
4397                         this.outlineControlsWidget = new OO.ui.OutlineControlsWidget(
4398                                 this.outlineWidget, { '$': this.$ }
4399                         );
4400                 }
4401         }
4402
4403         // Events
4404         this.stackLayout.connect( this, { 'set': 'onStackLayoutSet' } );
4405         if ( this.outlined ) {
4406                 this.outlineWidget.connect( this, { 'select': 'onOutlineWidgetSelect' } );
4407         }
4408         if ( this.autoFocus ) {
4409                 // Event 'focus' does not bubble, but 'focusin' does
4410                 this.stackLayout.onDOMEvent( 'focusin', OO.ui.bind( this.onStackLayoutFocus, this ) );
4411         }
4412
4413         // Initialization
4414         this.$element.addClass( 'oo-ui-bookletLayout' );
4415         this.stackLayout.$element.addClass( 'oo-ui-bookletLayout-stackLayout' );
4416         if ( this.outlined ) {
4417                 this.outlinePanel.$element
4418                         .addClass( 'oo-ui-bookletLayout-outlinePanel' )
4419                         .append( this.outlineWidget.$element );
4420                 if ( this.editable ) {
4421                         this.outlinePanel.$element
4422                                 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
4423                                 .append( this.outlineControlsWidget.$element );
4424                 }
4425                 this.$element.append( this.gridLayout.$element );
4426         } else {
4427                 this.$element.append( this.stackLayout.$element );
4428         }
4429 };
4430
4431 /* Setup */
4432
4433 OO.inheritClass( OO.ui.BookletLayout, OO.ui.Layout );
4434
4435 /* Events */
4436
4437 /**
4438  * @event set
4439  * @param {OO.ui.PageLayout} page Current page
4440  */
4441
4442 /**
4443  * @event add
4444  * @param {OO.ui.PageLayout[]} page Added pages
4445  * @param {number} index Index pages were added at
4446  */
4447
4448 /**
4449  * @event remove
4450  * @param {OO.ui.PageLayout[]} pages Removed pages
4451  */
4452
4453 /* Methods */
4454
4455 /**
4456  * Handle stack layout focus.
4457  *
4458  * @param {jQuery.Event} e Focusin event
4459  */
4460 OO.ui.BookletLayout.prototype.onStackLayoutFocus = function ( e ) {
4461         var name, $target;
4462
4463         // Find the page that an element was focused within
4464         $target = $( e.target ).closest( '.oo-ui-pageLayout' );
4465         for ( name in this.pages ) {
4466                 // Check for page match, exclude current page to find only page changes
4467                 if ( this.pages[name].$element[0] === $target[0] && name !== this.currentPageName ) {
4468                         this.setPage( name );
4469                         break;
4470                 }
4471         }
4472 };
4473
4474 /**
4475  * Handle stack layout set events.
4476  *
4477  * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
4478  */
4479 OO.ui.BookletLayout.prototype.onStackLayoutSet = function ( page ) {
4480         if ( page ) {
4481                 page.scrollElementIntoView( { 'complete': OO.ui.bind( function () {
4482                         if ( this.autoFocus ) {
4483                                 // Set focus to the first input if nothing on the page is focused yet
4484                                 if ( !page.$element.find( ':focus' ).length ) {
4485                                         page.$element.find( ':input:first' ).focus();
4486                                 }
4487                         }
4488                 }, this ) } );
4489         }
4490 };
4491
4492 /**
4493  * Handle outline widget select events.
4494  *
4495  * @param {OO.ui.OptionWidget|null} item Selected item
4496  */
4497 OO.ui.BookletLayout.prototype.onOutlineWidgetSelect = function ( item ) {
4498         if ( item ) {
4499                 this.setPage( item.getData() );
4500         }
4501 };
4502
4503 /**
4504  * Check if booklet has an outline.
4505  *
4506  * @return {boolean}
4507  */
4508 OO.ui.BookletLayout.prototype.isOutlined = function () {
4509         return this.outlined;
4510 };
4511
4512 /**
4513  * Check if booklet has editing controls.
4514  *
4515  * @return {boolean}
4516  */
4517 OO.ui.BookletLayout.prototype.isEditable = function () {
4518         return this.editable;
4519 };
4520
4521 /**
4522  * Check if booklet has a visible outline.
4523  *
4524  * @return {boolean}
4525  */
4526 OO.ui.BookletLayout.prototype.isOutlineVisible = function () {
4527         return this.outlined && this.outlineVisible;
4528 };
4529
4530 /**
4531  * Hide or show the outline.
4532  *
4533  * @param {boolean} [show] Show outline, omit to invert current state
4534  * @chainable
4535  */
4536 OO.ui.BookletLayout.prototype.toggleOutline = function ( show ) {
4537         if ( this.outlined ) {
4538                 show = show === undefined ? !this.outlineVisible : !!show;
4539                 this.outlineVisible = show;
4540                 this.gridLayout.layout( show ? [ 1, 2 ] : [ 0, 1 ], [ 1 ] );
4541         }
4542
4543         return this;
4544 };
4545
4546 /**
4547  * Get the outline widget.
4548  *
4549  * @param {OO.ui.PageLayout} page Page to be selected
4550  * @return {OO.ui.PageLayout|null} Closest page to another
4551  */
4552 OO.ui.BookletLayout.prototype.getClosestPage = function ( page ) {
4553         var next, prev, level,
4554                 pages = this.stackLayout.getItems(),
4555                 index = $.inArray( page, pages );
4556
4557         if ( index !== -1 ) {
4558                 next = pages[index + 1];
4559                 prev = pages[index - 1];
4560                 // Prefer adjacent pages at the same level
4561                 if ( this.outlined ) {
4562                         level = this.outlineWidget.getItemFromData( page.getName() ).getLevel();
4563                         if (
4564                                 prev &&
4565                                 level === this.outlineWidget.getItemFromData( prev.getName() ).getLevel()
4566                         ) {
4567                                 return prev;
4568                         }
4569                         if (
4570                                 next &&
4571                                 level === this.outlineWidget.getItemFromData( next.getName() ).getLevel()
4572                         ) {
4573                                 return next;
4574                         }
4575                 }
4576         }
4577         return prev || next || null;
4578 };
4579
4580 /**
4581  * Get the outline widget.
4582  *
4583  * @return {OO.ui.OutlineWidget|null} Outline widget, or null if boolet has no outline
4584  */
4585 OO.ui.BookletLayout.prototype.getOutline = function () {
4586         return this.outlineWidget;
4587 };
4588
4589 /**
4590  * Get the outline controls widget. If the outline is not editable, null is returned.
4591  *
4592  * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
4593  */
4594 OO.ui.BookletLayout.prototype.getOutlineControls = function () {
4595         return this.outlineControlsWidget;
4596 };
4597
4598 /**
4599  * Get a page by name.
4600  *
4601  * @param {string} name Symbolic name of page
4602  * @return {OO.ui.PageLayout|undefined} Page, if found
4603  */
4604 OO.ui.BookletLayout.prototype.getPage = function ( name ) {
4605         return this.pages[name];
4606 };
4607
4608 /**
4609  * Get the current page name.
4610  *
4611  * @return {string|null} Current page name
4612  */
4613 OO.ui.BookletLayout.prototype.getPageName = function () {
4614         return this.currentPageName;
4615 };
4616
4617 /**
4618  * Add a page to the layout.
4619  *
4620  * When pages are added with the same names as existing pages, the existing pages will be
4621  * automatically removed before the new pages are added.
4622  *
4623  * @param {OO.ui.PageLayout[]} pages Pages to add
4624  * @param {number} index Index to insert pages after
4625  * @fires add
4626  * @chainable
4627  */
4628 OO.ui.BookletLayout.prototype.addPages = function ( pages, index ) {
4629         var i, len, name, page, item, currentIndex,
4630                 stackLayoutPages = this.stackLayout.getItems(),
4631                 remove = [],
4632                 items = [];
4633
4634         // Remove pages with same names
4635         for ( i = 0, len = pages.length; i < len; i++ ) {
4636                 page = pages[i];
4637                 name = page.getName();
4638
4639                 if ( Object.prototype.hasOwnProperty.call( this.pages, name ) ) {
4640                         // Correct the insertion index
4641                         currentIndex = $.inArray( this.pages[name], stackLayoutPages );
4642                         if ( currentIndex !== -1 && currentIndex + 1 < index ) {
4643                                 index--;
4644                         }
4645                         remove.push( this.pages[name] );
4646                 }
4647         }
4648         if ( remove.length ) {
4649                 this.removePages( remove );
4650         }
4651
4652         // Add new pages
4653         for ( i = 0, len = pages.length; i < len; i++ ) {
4654                 page = pages[i];
4655                 name = page.getName();
4656                 this.pages[page.getName()] = page;
4657                 if ( this.outlined ) {
4658                         item = new OO.ui.OutlineItemWidget( name, page, { '$': this.$ } );
4659                         page.setOutlineItem( item );
4660                         items.push( item );
4661                 }
4662         }
4663
4664         if ( this.outlined && items.length ) {
4665                 this.outlineWidget.addItems( items, index );
4666                 this.updateOutlineWidget();
4667         }
4668         this.stackLayout.addItems( pages, index );
4669         this.emit( 'add', pages, index );
4670
4671         return this;
4672 };
4673
4674 /**
4675  * Remove a page from the layout.
4676  *
4677  * @fires remove
4678  * @chainable
4679  */
4680 OO.ui.BookletLayout.prototype.removePages = function ( pages ) {
4681         var i, len, name, page,
4682                 items = [];
4683
4684         for ( i = 0, len = pages.length; i < len; i++ ) {
4685                 page = pages[i];
4686                 name = page.getName();
4687                 delete this.pages[name];
4688                 if ( this.outlined ) {
4689                         items.push( this.outlineWidget.getItemFromData( name ) );
4690                         page.setOutlineItem( null );
4691                 }
4692         }
4693         if ( this.outlined && items.length ) {
4694                 this.outlineWidget.removeItems( items );
4695                 this.updateOutlineWidget();
4696         }
4697         this.stackLayout.removeItems( pages );
4698         this.emit( 'remove', pages );
4699
4700         return this;
4701 };
4702
4703 /**
4704  * Clear all pages from the layout.
4705  *
4706  * @fires remove
4707  * @chainable
4708  */
4709 OO.ui.BookletLayout.prototype.clearPages = function () {
4710         var i, len,
4711                 pages = this.stackLayout.getItems();
4712
4713         this.pages = {};
4714         this.currentPageName = null;
4715         if ( this.outlined ) {
4716                 this.outlineWidget.clearItems();
4717                 for ( i = 0, len = pages.length; i < len; i++ ) {
4718                         pages[i].setOutlineItem( null );
4719                 }
4720         }
4721         this.stackLayout.clearItems();
4722
4723         this.emit( 'remove', pages );
4724
4725         return this;
4726 };
4727
4728 /**
4729  * Set the current page by name.
4730  *
4731  * @fires set
4732  * @param {string} name Symbolic name of page
4733  */
4734 OO.ui.BookletLayout.prototype.setPage = function ( name ) {
4735         var selectedItem,
4736                 page = this.pages[name];
4737
4738         if ( name !== this.currentPageName ) {
4739                 if ( this.outlined ) {
4740                         selectedItem = this.outlineWidget.getSelectedItem();
4741                         if ( selectedItem && selectedItem.getData() !== name ) {
4742                                 this.outlineWidget.selectItem( this.outlineWidget.getItemFromData( name ) );
4743                         }
4744                 }
4745                 if ( page ) {
4746                         if ( this.currentPageName && this.pages[this.currentPageName] ) {
4747                                 this.pages[this.currentPageName].setActive( false );
4748                                 // Blur anything focused if the next page doesn't have anything focusable - this
4749                                 // is not needed if the next page has something focusable because once it is focused
4750                                 // this blur happens automatically
4751                                 if ( this.autoFocus && !page.$element.find( ':input' ).length ) {
4752                                         this.pages[this.currentPageName].$element.find( ':focus' ).blur();
4753                                 }
4754                         }
4755                         this.currentPageName = name;
4756                         this.stackLayout.setItem( page );
4757                         page.setActive( true );
4758                         this.emit( 'set', page );
4759                 }
4760         }
4761 };
4762
4763 /**
4764  * Call this after adding or removing items from the OutlineWidget.
4765  *
4766  * @chainable
4767  */
4768 OO.ui.BookletLayout.prototype.updateOutlineWidget = function () {
4769         // Auto-select first item when nothing is selected anymore
4770         if ( !this.outlineWidget.getSelectedItem() ) {
4771                 this.outlineWidget.selectItem( this.outlineWidget.getFirstSelectableItem() );
4772         }
4773
4774         return this;
4775 };
4776 /**
4777  * Layout that expands to cover the entire area of its parent, with optional scrolling and padding.
4778  *
4779  * @class
4780  * @extends OO.ui.Layout
4781  *
4782  * @constructor
4783  * @param {Object} [config] Configuration options
4784  * @cfg {boolean} [scrollable] Allow vertical scrolling
4785  * @cfg {boolean} [padded] Pad the content from the edges
4786  */
4787 OO.ui.PanelLayout = function OoUiPanelLayout( config ) {
4788         // Config initialization
4789         config = config || {};
4790
4791         // Parent constructor
4792         OO.ui.PanelLayout.super.call( this, config );
4793
4794         // Initialization
4795         this.$element.addClass( 'oo-ui-panelLayout' );
4796         if ( config.scrollable ) {
4797                 this.$element.addClass( 'oo-ui-panelLayout-scrollable' );
4798         }
4799
4800         if ( config.padded ) {
4801                 this.$element.addClass( 'oo-ui-panelLayout-padded' );
4802         }
4803 };
4804
4805 /* Setup */
4806
4807 OO.inheritClass( OO.ui.PanelLayout, OO.ui.Layout );
4808 /**
4809  * Page within an booklet layout.
4810  *
4811  * @class
4812  * @extends OO.ui.PanelLayout
4813  *
4814  * @constructor
4815  * @param {string} name Unique symbolic name of page
4816  * @param {Object} [config] Configuration options
4817  * @param {string} [outlineItem] Outline item widget
4818  */
4819 OO.ui.PageLayout = function OoUiPageLayout( name, config ) {
4820         // Configuration initialization
4821         config = $.extend( { 'scrollable': true }, config );
4822
4823         // Parent constructor
4824         OO.ui.PageLayout.super.call( this, config );
4825
4826         // Properties
4827         this.name = name;
4828         this.outlineItem = config.outlineItem || null;
4829         this.active = false;
4830
4831         // Initialization
4832         this.$element.addClass( 'oo-ui-pageLayout' );
4833 };
4834
4835 /* Setup */
4836
4837 OO.inheritClass( OO.ui.PageLayout, OO.ui.PanelLayout );
4838
4839 /* Events */
4840
4841 /**
4842  * @event active
4843  * @param {boolean} active Page is active
4844  */
4845
4846 /* Methods */
4847
4848 /**
4849  * Get page name.
4850  *
4851  * @return {string} Symbolic name of page
4852  */
4853 OO.ui.PageLayout.prototype.getName = function () {
4854         return this.name;
4855 };
4856
4857 /**
4858  * Check if page is active.
4859  *
4860  * @return {boolean} Page is active
4861  */
4862 OO.ui.PageLayout.prototype.isActive = function () {
4863         return this.active;
4864 };
4865
4866 /**
4867  * Get outline item.
4868  *
4869  * @return {OO.ui.OutlineItemWidget|null} Outline item widget
4870  */
4871 OO.ui.PageLayout.prototype.getOutlineItem = function () {
4872         return this.outlineItem;
4873 };
4874
4875 /**
4876  * Get outline item.
4877  *
4878  * @param {OO.ui.OutlineItemWidget|null} outlineItem Outline item widget, null to clear
4879  * @chainable
4880  */
4881 OO.ui.PageLayout.prototype.setOutlineItem = function ( outlineItem ) {
4882         this.outlineItem = outlineItem;
4883         return this;
4884 };
4885
4886 /**
4887  * Set page active state.
4888  *
4889  * @param {boolean} Page is active
4890  * @fires active
4891  */
4892 OO.ui.PageLayout.prototype.setActive = function ( active ) {
4893         active = !!active;
4894
4895         if ( active !== this.active ) {
4896                 this.active = active;
4897                 this.$element.toggleClass( 'oo-ui-pageLayout-active', active );
4898                 this.emit( 'active', this.active );
4899         }
4900 };
4901 /**
4902  * Layout containing a series of mutually exclusive pages.
4903  *
4904  * @class
4905  * @extends OO.ui.PanelLayout
4906  * @mixins OO.ui.GroupElement
4907  *
4908  * @constructor
4909  * @param {Object} [config] Configuration options
4910  * @cfg {boolean} [continuous=false] Show all pages, one after another
4911  * @cfg {string} [icon=''] Symbolic icon name
4912  * @cfg {OO.ui.Layout[]} [items] Layouts to add
4913  */
4914 OO.ui.StackLayout = function OoUiStackLayout( config ) {
4915         // Config initialization
4916         config = $.extend( { 'scrollable': true }, config );
4917
4918         // Parent constructor
4919         OO.ui.StackLayout.super.call( this, config );
4920
4921         // Mixin constructors
4922         OO.ui.GroupElement.call( this, this.$element, config );
4923
4924         // Properties
4925         this.currentItem = null;
4926         this.continuous = !!config.continuous;
4927
4928         // Initialization
4929         this.$element.addClass( 'oo-ui-stackLayout' );
4930         if ( this.continuous ) {
4931                 this.$element.addClass( 'oo-ui-stackLayout-continuous' );
4932         }
4933         if ( $.isArray( config.items ) ) {
4934                 this.addItems( config.items );
4935         }
4936 };
4937
4938 /* Setup */
4939
4940 OO.inheritClass( OO.ui.StackLayout, OO.ui.PanelLayout );
4941 OO.mixinClass( OO.ui.StackLayout, OO.ui.GroupElement );
4942
4943 /* Events */
4944
4945 /**
4946  * @event set
4947  * @param {OO.ui.Layout|null} item Current item or null if there is no longer a layout shown
4948  */
4949
4950 /* Methods */
4951
4952 /**
4953  * Get the current item.
4954  *
4955  * @return {OO.ui.Layout|null}
4956  */
4957 OO.ui.StackLayout.prototype.getCurrentItem = function () {
4958         return this.currentItem;
4959 };
4960
4961 /**
4962  * Unset the current item.
4963  *
4964  * @private
4965  * @param {OO.ui.StackLayout} layout
4966  * @fires set
4967  */
4968 OO.ui.StackLayout.prototype.unsetCurrentItem = function () {
4969         var prevItem = this.currentItem;
4970         if ( prevItem === null ) {
4971                 return;
4972         }
4973
4974         this.currentItem = null;
4975         this.emit( 'set', null );
4976 };
4977
4978 /**
4979  * Add items.
4980  *
4981  * Adding an existing item (by value) will move it.
4982  *
4983  * @param {OO.ui.Layout[]} items Items to add
4984  * @param {number} [index] Index to insert items after
4985  * @chainable
4986  */
4987 OO.ui.StackLayout.prototype.addItems = function ( items, index ) {
4988         // Mixin method
4989         OO.ui.GroupElement.prototype.addItems.call( this, items, index );
4990
4991         if ( !this.currentItem && items.length ) {
4992                 this.setItem( items[0] );
4993         }
4994
4995         return this;
4996 };
4997
4998 /**
4999  * Remove items.
5000  *
5001  * Items will be detached, not removed, so they can be used later.
5002  *
5003  * @param {OO.ui.Layout[]} items Items to remove
5004  * @chainable
5005  * @fires set
5006  */
5007 OO.ui.StackLayout.prototype.removeItems = function ( items ) {
5008         // Mixin method
5009         OO.ui.GroupElement.prototype.removeItems.call( this, items );
5010
5011         if ( $.inArray( this.currentItem, items  ) !== -1 ) {
5012                 if ( this.items.length ) {
5013                         this.setItem( this.items[0] );
5014                 } else {
5015                         this.unsetCurrentItem();
5016                 }
5017         }
5018
5019         return this;
5020 };
5021
5022 /**
5023  * Clear all items.
5024  *
5025  * Items will be detached, not removed, so they can be used later.
5026  *
5027  * @chainable
5028  * @fires set
5029  */
5030 OO.ui.StackLayout.prototype.clearItems = function () {
5031         this.unsetCurrentItem();
5032         OO.ui.GroupElement.prototype.clearItems.call( this );
5033
5034         return this;
5035 };
5036
5037 /**
5038  * Show item.
5039  *
5040  * Any currently shown item will be hidden.
5041  *
5042  * FIXME: If the passed item to show has not been added in the items list, then
5043  * this method drops it and unsets the current item.
5044  *
5045  * @param {OO.ui.Layout} item Item to show
5046  * @chainable
5047  * @fires set
5048  */
5049 OO.ui.StackLayout.prototype.setItem = function ( item ) {
5050         var i, len;
5051
5052         if ( item !== this.currentItem ) {
5053                 if ( !this.continuous ) {
5054                         for ( i = 0, len = this.items.length; i < len; i++ ) {
5055                                 this.items[i].$element.css( 'display', '' );
5056                         }
5057                 }
5058                 if ( $.inArray( item, this.items ) !== -1 ) {
5059                         if ( !this.continuous ) {
5060                                 item.$element.css( 'display', 'block' );
5061                         }
5062                         this.currentItem = item;
5063                         this.emit( 'set', item );
5064                 } else {
5065                         this.unsetCurrentItem();
5066                 }
5067         }
5068
5069         return this;
5070 };
5071 /**
5072  * Horizontal bar layout of tools as icon buttons.
5073  *
5074  * @class
5075  * @extends OO.ui.ToolGroup
5076  *
5077  * @constructor
5078  * @param {OO.ui.Toolbar} toolbar
5079  * @param {Object} [config] Configuration options
5080  */
5081 OO.ui.BarToolGroup = function OoUiBarToolGroup( toolbar, config ) {
5082         // Parent constructor
5083         OO.ui.BarToolGroup.super.call( this, toolbar, config );
5084
5085         // Initialization
5086         this.$element.addClass( 'oo-ui-barToolGroup' );
5087 };
5088
5089 /* Setup */
5090
5091 OO.inheritClass( OO.ui.BarToolGroup, OO.ui.ToolGroup );
5092
5093 /* Static Properties */
5094
5095 OO.ui.BarToolGroup.static.titleTooltips = true;
5096
5097 OO.ui.BarToolGroup.static.accelTooltips = true;
5098
5099 OO.ui.BarToolGroup.static.name = 'bar';
5100 /**
5101  * Popup list of tools with an icon and optional label.
5102  *
5103  * @abstract
5104  * @class
5105  * @extends OO.ui.ToolGroup
5106  * @mixins OO.ui.IconedElement
5107  * @mixins OO.ui.IndicatedElement
5108  * @mixins OO.ui.LabeledElement
5109  * @mixins OO.ui.TitledElement
5110  * @mixins OO.ui.ClippableElement
5111  *
5112  * @constructor
5113  * @param {OO.ui.Toolbar} toolbar
5114  * @param {Object} [config] Configuration options
5115  * @cfg {string} [header] Text to display at the top of the pop-up
5116  */
5117 OO.ui.PopupToolGroup = function OoUiPopupToolGroup( toolbar, config ) {
5118         // Configuration initialization
5119         config = config || {};
5120
5121         // Parent constructor
5122         OO.ui.PopupToolGroup.super.call( this, toolbar, config );
5123
5124         // Mixin constructors
5125         OO.ui.IconedElement.call( this, this.$( '<span>' ), config );
5126         OO.ui.IndicatedElement.call( this, this.$( '<span>' ), config );
5127         OO.ui.LabeledElement.call( this, this.$( '<span>' ), config );
5128         OO.ui.TitledElement.call( this, this.$element, config );
5129         OO.ui.ClippableElement.call( this, this.$group, config );
5130
5131         // Properties
5132         this.active = false;
5133         this.dragging = false;
5134         this.onBlurHandler = OO.ui.bind( this.onBlur, this );
5135         this.$handle = this.$( '<span>' );
5136
5137         // Events
5138         this.$handle.on( {
5139                 'mousedown': OO.ui.bind( this.onHandleMouseDown, this ),
5140                 'mouseup': OO.ui.bind( this.onHandleMouseUp, this )
5141         } );
5142
5143         // Initialization
5144         this.$handle
5145                 .addClass( 'oo-ui-popupToolGroup-handle' )
5146                 .append( this.$icon, this.$label, this.$indicator );
5147         // If the pop-up should have a header, add it to the top of the toolGroup.
5148         // Note: If this feature is useful for other widgets, we could abstract it into an
5149         // OO.ui.HeaderedElement mixin constructor.
5150         if ( config.header !== undefined ) {
5151                 this.$group
5152                         .prepend( this.$( '<span>' )
5153                                 .addClass( 'oo-ui-popupToolGroup-header' )
5154                                 .text( config.header )
5155                         );
5156         }
5157         this.$element
5158                 .addClass( 'oo-ui-popupToolGroup' )
5159                 .prepend( this.$handle );
5160 };
5161
5162 /* Setup */
5163
5164 OO.inheritClass( OO.ui.PopupToolGroup, OO.ui.ToolGroup );
5165 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.IconedElement );
5166 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.IndicatedElement );
5167 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.LabeledElement );
5168 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.TitledElement );
5169 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.ClippableElement );
5170
5171 /* Static Properties */
5172
5173 /* Methods */
5174
5175 /**
5176  * @inheritdoc
5177  */
5178 OO.ui.PopupToolGroup.prototype.setDisabled = function () {
5179         // Parent method
5180         OO.ui.PopupToolGroup.super.prototype.setDisabled.apply( this, arguments );
5181
5182         if ( this.isDisabled() && this.isElementAttached() ) {
5183                 this.setActive( false );
5184         }
5185 };
5186
5187 /**
5188  * Handle focus being lost.
5189  *
5190  * The event is actually generated from a mouseup, so it is not a normal blur event object.
5191  *
5192  * @param {jQuery.Event} e Mouse up event
5193  */
5194 OO.ui.PopupToolGroup.prototype.onBlur = function ( e ) {
5195         // Only deactivate when clicking outside the dropdown element
5196         if ( this.$( e.target ).closest( '.oo-ui-popupToolGroup' )[0] !== this.$element[0] ) {
5197                 this.setActive( false );
5198         }
5199 };
5200
5201 /**
5202  * @inheritdoc
5203  */
5204 OO.ui.PopupToolGroup.prototype.onMouseUp = function ( e ) {
5205         if ( !this.isDisabled() && e.which === 1 ) {
5206                 this.setActive( false );
5207         }
5208         return OO.ui.PopupToolGroup.super.prototype.onMouseUp.call( this, e );
5209 };
5210
5211 /**
5212  * Handle mouse up events.
5213  *
5214  * @param {jQuery.Event} e Mouse up event
5215  */
5216 OO.ui.PopupToolGroup.prototype.onHandleMouseUp = function () {
5217         return false;
5218 };
5219
5220 /**
5221  * Handle mouse down events.
5222  *
5223  * @param {jQuery.Event} e Mouse down event
5224  */
5225 OO.ui.PopupToolGroup.prototype.onHandleMouseDown = function ( e ) {
5226         if ( !this.isDisabled() && e.which === 1 ) {
5227                 this.setActive( !this.active );
5228         }
5229         return false;
5230 };
5231
5232 /**
5233  * Switch into active mode.
5234  *
5235  * When active, mouseup events anywhere in the document will trigger deactivation.
5236  */
5237 OO.ui.PopupToolGroup.prototype.setActive = function ( value ) {
5238         value = !!value;
5239         if ( this.active !== value ) {
5240                 this.active = value;
5241                 if ( value ) {
5242                         this.setClipping( true );
5243                         this.$element.addClass( 'oo-ui-popupToolGroup-active' );
5244                         this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler, true );
5245                 } else {
5246                         this.setClipping( false );
5247                         this.$element.removeClass( 'oo-ui-popupToolGroup-active' );
5248                         this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler, true );
5249                 }
5250         }
5251 };
5252 /**
5253  * Drop down list layout of tools as labeled icon buttons.
5254  *
5255  * @class
5256  * @extends OO.ui.PopupToolGroup
5257  *
5258  * @constructor
5259  * @param {OO.ui.Toolbar} toolbar
5260  * @param {Object} [config] Configuration options
5261  */
5262 OO.ui.ListToolGroup = function OoUiListToolGroup( toolbar, config ) {
5263         // Parent constructor
5264         OO.ui.ListToolGroup.super.call( this, toolbar, config );
5265
5266         // Initialization
5267         this.$element.addClass( 'oo-ui-listToolGroup' );
5268 };
5269
5270 /* Setup */
5271
5272 OO.inheritClass( OO.ui.ListToolGroup, OO.ui.PopupToolGroup );
5273
5274 /* Static Properties */
5275
5276 OO.ui.ListToolGroup.static.accelTooltips = true;
5277
5278 OO.ui.ListToolGroup.static.name = 'list';
5279 /**
5280  * Drop down menu layout of tools as selectable menu items.
5281  *
5282  * @class
5283  * @extends OO.ui.PopupToolGroup
5284  *
5285  * @constructor
5286  * @param {OO.ui.Toolbar} toolbar
5287  * @param {Object} [config] Configuration options
5288  */
5289 OO.ui.MenuToolGroup = function OoUiMenuToolGroup( toolbar, config ) {
5290         // Configuration initialization
5291         config = config || {};
5292
5293         // Parent constructor
5294         OO.ui.MenuToolGroup.super.call( this, toolbar, config );
5295
5296         // Events
5297         this.toolbar.connect( this, { 'updateState': 'onUpdateState' } );
5298
5299         // Initialization
5300         this.$element.addClass( 'oo-ui-menuToolGroup' );
5301 };
5302
5303 /* Setup */
5304
5305 OO.inheritClass( OO.ui.MenuToolGroup, OO.ui.PopupToolGroup );
5306
5307 /* Static Properties */
5308
5309 OO.ui.MenuToolGroup.static.accelTooltips = true;
5310
5311 OO.ui.MenuToolGroup.static.name = 'menu';
5312
5313 /* Methods */
5314
5315 /**
5316  * Handle the toolbar state being updated.
5317  *
5318  * When the state changes, the title of each active item in the menu will be joined together and
5319  * used as a label for the group. The label will be empty if none of the items are active.
5320  */
5321 OO.ui.MenuToolGroup.prototype.onUpdateState = function () {
5322         var name,
5323                 labelTexts = [];
5324
5325         for ( name in this.tools ) {
5326                 if ( this.tools[name].isActive() ) {
5327                         labelTexts.push( this.tools[name].getTitle() );
5328                 }
5329         }
5330
5331         this.setLabel( labelTexts.join( ', ' ) || ' ' );
5332 };
5333 /**
5334  * Tool that shows a popup when selected.
5335  *
5336  * @abstract
5337  * @class
5338  * @extends OO.ui.Tool
5339  * @mixins OO.ui.PopuppableElement
5340  *
5341  * @constructor
5342  * @param {OO.ui.Toolbar} toolbar
5343  * @param {Object} [config] Configuration options
5344  */
5345 OO.ui.PopupTool = function OoUiPopupTool( toolbar, config ) {
5346         // Parent constructor
5347         OO.ui.PopupTool.super.call( this, toolbar, config );
5348
5349         // Mixin constructors
5350         OO.ui.PopuppableElement.call( this, config );
5351
5352         // Initialization
5353         this.$element
5354                 .addClass( 'oo-ui-popupTool' )
5355                 .append( this.popup.$element );
5356 };
5357
5358 /* Setup */
5359
5360 OO.inheritClass( OO.ui.PopupTool, OO.ui.Tool );
5361 OO.mixinClass( OO.ui.PopupTool, OO.ui.PopuppableElement );
5362
5363 /* Methods */
5364
5365 /**
5366  * Handle the tool being selected.
5367  *
5368  * @inheritdoc
5369  */
5370 OO.ui.PopupTool.prototype.onSelect = function () {
5371         if ( !this.isDisabled() ) {
5372                 if ( this.popup.isVisible() ) {
5373                         this.hidePopup();
5374                 } else {
5375                         this.showPopup();
5376                 }
5377         }
5378         this.setActive( false );
5379         return false;
5380 };
5381
5382 /**
5383  * Handle the toolbar state being updated.
5384  *
5385  * @inheritdoc
5386  */
5387 OO.ui.PopupTool.prototype.onUpdateState = function () {
5388         this.setActive( false );
5389 };
5390 /**
5391  * Group widget.
5392  *
5393  * Mixin for OO.ui.Widget subclasses.
5394  *
5395  * Use together with OO.ui.ItemWidget to make disabled state inheritable.
5396  *
5397  * @abstract
5398  * @class
5399  * @extends OO.ui.GroupElement
5400  *
5401  * @constructor
5402  * @param {jQuery} $group Container node, assigned to #$group
5403  * @param {Object} [config] Configuration options
5404  */
5405 OO.ui.GroupWidget = function OoUiGroupWidget( $element, config ) {
5406         // Parent constructor
5407         OO.ui.GroupWidget.super.call( this, $element, config );
5408 };
5409
5410 /* Setup */
5411
5412 OO.inheritClass( OO.ui.GroupWidget, OO.ui.GroupElement );
5413
5414 /* Methods */
5415
5416 /**
5417  * Set the disabled state of the widget.
5418  *
5419  * This will also update the disabled state of child widgets.
5420  *
5421  * @param {boolean} disabled Disable widget
5422  * @chainable
5423  */
5424 OO.ui.GroupWidget.prototype.setDisabled = function ( disabled ) {
5425         var i, len;
5426
5427         // Parent method
5428         // Note: Calling #setDisabled this way assumes this is mixed into an OO.ui.Widget
5429         OO.ui.Widget.prototype.setDisabled.call( this, disabled );
5430
5431         // During construction, #setDisabled is called before the OO.ui.GroupElement constructor
5432         if ( this.items ) {
5433                 for ( i = 0, len = this.items.length; i < len; i++ ) {
5434                         this.items[i].updateDisabled();
5435                 }
5436         }
5437
5438         return this;
5439 };
5440 /**
5441  * Item widget.
5442  *
5443  * Use together with OO.ui.GroupWidget to make disabled state inheritable.
5444  *
5445  * @abstract
5446  * @class
5447  *
5448  * @constructor
5449  */
5450 OO.ui.ItemWidget = function OoUiItemWidget() {
5451         //
5452 };
5453
5454 /* Methods */
5455
5456 /**
5457  * Check if widget is disabled.
5458  *
5459  * Checks parent if present, making disabled state inheritable.
5460  *
5461  * @return {boolean} Widget is disabled
5462  */
5463 OO.ui.ItemWidget.prototype.isDisabled = function () {
5464         return this.disabled ||
5465                 ( this.elementGroup instanceof OO.ui.Widget && this.elementGroup.isDisabled() );
5466 };
5467
5468 /**
5469  * Set group element is in.
5470  *
5471  * @param {OO.ui.GroupElement|null} group Group element, null if none
5472  * @chainable
5473  */
5474 OO.ui.ItemWidget.prototype.setElementGroup = function ( group ) {
5475         // Parent method
5476         // Note: Calling #setElementGroup this way assumes this is mixed into an OO.ui.Element
5477         OO.ui.Element.prototype.setElementGroup.call( this, group );
5478
5479         // Initialize item disabled states
5480         this.updateDisabled();
5481
5482         return this;
5483 };
5484 /**
5485  * Icon widget.
5486  *
5487  * @class
5488  * @extends OO.ui.Widget
5489  * @mixins OO.ui.IconedElement
5490  * @mixins OO.ui.TitledElement
5491  *
5492  * @constructor
5493  * @param {Object} [config] Configuration options
5494  */
5495 OO.ui.IconWidget = function OoUiIconWidget( config ) {
5496         // Config intialization
5497         config = config || {};
5498
5499         // Parent constructor
5500         OO.ui.IconWidget.super.call( this, config );
5501
5502         // Mixin constructors
5503         OO.ui.IconedElement.call( this, this.$element, config );
5504         OO.ui.TitledElement.call( this, this.$element, config );
5505
5506         // Initialization
5507         this.$element.addClass( 'oo-ui-iconWidget' );
5508 };
5509
5510 /* Setup */
5511
5512 OO.inheritClass( OO.ui.IconWidget, OO.ui.Widget );
5513 OO.mixinClass( OO.ui.IconWidget, OO.ui.IconedElement );
5514 OO.mixinClass( OO.ui.IconWidget, OO.ui.TitledElement );
5515
5516 /* Static Properties */
5517
5518 OO.ui.IconWidget.static.tagName = 'span';
5519 /**
5520  * Indicator widget.
5521  *
5522  * @class
5523  * @extends OO.ui.Widget
5524  * @mixins OO.ui.IndicatedElement
5525  * @mixins OO.ui.TitledElement
5526  *
5527  * @constructor
5528  * @param {Object} [config] Configuration options
5529  */
5530 OO.ui.IndicatorWidget = function OoUiIndicatorWidget( config ) {
5531         // Config intialization
5532         config = config || {};
5533
5534         // Parent constructor
5535         OO.ui.IndicatorWidget.super.call( this, config );
5536
5537         // Mixin constructors
5538         OO.ui.IndicatedElement.call( this, this.$element, config );
5539         OO.ui.TitledElement.call( this, this.$element, config );
5540
5541         // Initialization
5542         this.$element.addClass( 'oo-ui-indicatorWidget' );
5543 };
5544
5545 /* Setup */
5546
5547 OO.inheritClass( OO.ui.IndicatorWidget, OO.ui.Widget );
5548 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.IndicatedElement );
5549 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.TitledElement );
5550
5551 /* Static Properties */
5552
5553 OO.ui.IndicatorWidget.static.tagName = 'span';
5554 /**
5555  * Container for multiple related buttons.
5556  *
5557  * Use together with OO.ui.ButtonWidget.
5558  *
5559  * @class
5560  * @extends OO.ui.Widget
5561  * @mixins OO.ui.GroupElement
5562  *
5563  * @constructor
5564  * @param {Object} [config] Configuration options
5565  * @cfg {OO.ui.ButtonWidget} [items] Buttons to add
5566  */
5567 OO.ui.ButtonGroupWidget = function OoUiButtonGroupWidget( config ) {
5568         // Parent constructor
5569         OO.ui.ButtonGroupWidget.super.call( this, config );
5570
5571         // Mixin constructors
5572         OO.ui.GroupElement.call( this, this.$element, config );
5573
5574         // Initialization
5575         this.$element.addClass( 'oo-ui-buttonGroupWidget' );
5576         if ( $.isArray( config.items ) ) {
5577                 this.addItems( config.items );
5578         }
5579 };
5580
5581 /* Setup */
5582
5583 OO.inheritClass( OO.ui.ButtonGroupWidget, OO.ui.Widget );
5584 OO.mixinClass( OO.ui.ButtonGroupWidget, OO.ui.GroupElement );
5585 /**
5586  * Button widget.
5587  *
5588  * @class
5589  * @extends OO.ui.Widget
5590  * @mixins OO.ui.ButtonedElement
5591  * @mixins OO.ui.IconedElement
5592  * @mixins OO.ui.IndicatedElement
5593  * @mixins OO.ui.LabeledElement
5594  * @mixins OO.ui.TitledElement
5595  * @mixins OO.ui.FlaggableElement
5596  *
5597  * @constructor
5598  * @param {Object} [config] Configuration options
5599  * @cfg {string} [title=''] Title text
5600  * @cfg {string} [href] Hyperlink to visit when clicked
5601  * @cfg {string} [target] Target to open hyperlink in
5602  */
5603 OO.ui.ButtonWidget = function OoUiButtonWidget( config ) {
5604         // Configuration initialization
5605         config = $.extend( { 'target': '_blank' }, config );
5606
5607         // Parent constructor
5608         OO.ui.ButtonWidget.super.call( this, config );
5609
5610         // Mixin constructors
5611         OO.ui.ButtonedElement.call( this, this.$( '<a>' ), config );
5612         OO.ui.IconedElement.call( this, this.$( '<span>' ), config );
5613         OO.ui.IndicatedElement.call( this, this.$( '<span>' ), config );
5614         OO.ui.LabeledElement.call( this, this.$( '<span>' ), config );
5615         OO.ui.TitledElement.call( this, this.$button, config );
5616         OO.ui.FlaggableElement.call( this, config );
5617
5618         // Properties
5619         this.isHyperlink = typeof config.href === 'string';
5620
5621         // Events
5622         this.$button.on( {
5623                 'click': OO.ui.bind( this.onClick, this ),
5624                 'keypress': OO.ui.bind( this.onKeyPress, this )
5625         } );
5626
5627         // Initialization
5628         this.$button
5629                 .append( this.$icon, this.$label, this.$indicator )
5630                 .attr( { 'href': config.href, 'target': config.target } );
5631         this.$element
5632                 .addClass( 'oo-ui-buttonWidget' )
5633                 .append( this.$button );
5634 };
5635
5636 /* Setup */
5637
5638 OO.inheritClass( OO.ui.ButtonWidget, OO.ui.Widget );
5639 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.ButtonedElement );
5640 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.IconedElement );
5641 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.IndicatedElement );
5642 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.LabeledElement );
5643 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.TitledElement );
5644 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.FlaggableElement );
5645
5646 /* Events */
5647
5648 /**
5649  * @event click
5650  */
5651
5652 /* Methods */
5653
5654 /**
5655  * Handles mouse click events.
5656  *
5657  * @param {jQuery.Event} e Mouse click event
5658  * @fires click
5659  */
5660 OO.ui.ButtonWidget.prototype.onClick = function () {
5661         if ( !this.isDisabled() ) {
5662                 this.emit( 'click' );
5663                 if ( this.isHyperlink ) {
5664                         return true;
5665                 }
5666         }
5667         return false;
5668 };
5669
5670 /**
5671  * Handles keypress events.
5672  *
5673  * @param {jQuery.Event} e Keypress event
5674  * @fires click
5675  */
5676 OO.ui.ButtonWidget.prototype.onKeyPress = function ( e ) {
5677         if ( !this.isDisabled() && ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER ) ) {
5678                 this.onClick();
5679                 if ( this.isHyperlink ) {
5680                         return true;
5681                 }
5682         }
5683         return false;
5684 };
5685 /**
5686  * Input widget.
5687  *
5688  * @abstract
5689  * @class
5690  * @extends OO.ui.Widget
5691  *
5692  * @constructor
5693  * @param {Object} [config] Configuration options
5694  * @cfg {string} [name=''] HTML input name
5695  * @cfg {string} [value=''] Input value
5696  * @cfg {boolean} [readOnly=false] Prevent changes
5697  * @cfg {Function} [inputFilter] Filter function to apply to the input. Takes a string argument and returns a string.
5698  */
5699 OO.ui.InputWidget = function OoUiInputWidget( config ) {
5700         // Config intialization
5701         config = $.extend( { 'readOnly': false }, config );
5702
5703         // Parent constructor
5704         OO.ui.InputWidget.super.call( this, config );
5705
5706         // Properties
5707         this.$input = this.getInputElement( config );
5708         this.value = '';
5709         this.readOnly = false;
5710         this.inputFilter = config.inputFilter;
5711
5712         // Events
5713         this.$input.on( 'keydown mouseup cut paste change input select', OO.ui.bind( this.onEdit, this ) );
5714
5715         // Initialization
5716         this.$input
5717                 .attr( 'name', config.name )
5718                 .prop( 'disabled', this.isDisabled() );
5719         this.setReadOnly( config.readOnly );
5720         this.$element.addClass( 'oo-ui-inputWidget' ).append( this.$input );
5721         this.setValue( config.value );
5722 };
5723
5724 /* Setup */
5725
5726 OO.inheritClass( OO.ui.InputWidget, OO.ui.Widget );
5727
5728 /* Events */
5729
5730 /**
5731  * @event change
5732  * @param value
5733  */
5734
5735 /* Methods */
5736
5737 /**
5738  * Get input element.
5739  *
5740  * @param {Object} [config] Configuration options
5741  * @return {jQuery} Input element
5742  */
5743 OO.ui.InputWidget.prototype.getInputElement = function () {
5744         return this.$( '<input>' );
5745 };
5746
5747 /**
5748  * Handle potentially value-changing events.
5749  *
5750  * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
5751  */
5752 OO.ui.InputWidget.prototype.onEdit = function () {
5753         if ( !this.isDisabled() ) {
5754                 // Allow the stack to clear so the value will be updated
5755                 setTimeout( OO.ui.bind( function () {
5756                         this.setValue( this.$input.val() );
5757                 }, this ) );
5758         }
5759 };
5760
5761 /**
5762  * Get the value of the input.
5763  *
5764  * @return {string} Input value
5765  */
5766 OO.ui.InputWidget.prototype.getValue = function () {
5767         return this.value;
5768 };
5769
5770 /**
5771  * Sets the direction of the current input, either RTL or LTR
5772  *
5773  * @param {boolean} isRTL
5774  */
5775 OO.ui.InputWidget.prototype.setRTL = function ( isRTL ) {
5776         if ( isRTL ) {
5777                 this.$input.removeClass( 'oo-ui-ltr' );
5778                 this.$input.addClass( 'oo-ui-rtl' );
5779         } else {
5780                 this.$input.removeClass( 'oo-ui-rtl' );
5781                 this.$input.addClass( 'oo-ui-ltr' );
5782         }
5783 };
5784
5785 /**
5786  * Set the value of the input.
5787  *
5788  * @param {string} value New value
5789  * @fires change
5790  * @chainable
5791  */
5792 OO.ui.InputWidget.prototype.setValue = function ( value ) {
5793         value = this.sanitizeValue( value );
5794         if ( this.value !== value ) {
5795                 this.value = value;
5796                 this.emit( 'change', this.value );
5797         }
5798         // Update the DOM if it has changed. Note that with sanitizeValue, it
5799         // is possible for the DOM value to change without this.value changing.
5800         if ( this.$input.val() !== this.value ) {
5801                 this.$input.val( this.value );
5802         }
5803         return this;
5804 };
5805
5806 /**
5807  * Sanitize incoming value.
5808  *
5809  * Ensures value is a string, and converts undefined and null to empty strings.
5810  *
5811  * @param {string} value Original value
5812  * @return {string} Sanitized value
5813  */
5814 OO.ui.InputWidget.prototype.sanitizeValue = function ( value ) {
5815         if ( value === undefined || value === null ) {
5816                 return '';
5817         } else if ( this.inputFilter ) {
5818                 return this.inputFilter( String( value ) );
5819         } else {
5820                 return String( value );
5821         }
5822 };
5823
5824 /**
5825  * Simulate the behavior of clicking on a label bound to this input.
5826  */
5827 OO.ui.InputWidget.prototype.simulateLabelClick = function () {
5828         if ( !this.isDisabled() ) {
5829                 if ( this.$input.is( ':checkbox,:radio' ) ) {
5830                         this.$input.click();
5831                 } else if ( this.$input.is( ':input' ) ) {
5832                         this.$input.focus();
5833                 }
5834         }
5835 };
5836
5837 /**
5838  * Check if the widget is read-only.
5839  *
5840  * @return {boolean}
5841  */
5842 OO.ui.InputWidget.prototype.isReadOnly = function () {
5843         return this.readOnly;
5844 };
5845
5846 /**
5847  * Set the read-only state of the widget.
5848  *
5849  * This should probably change the widgets's appearance and prevent it from being used.
5850  *
5851  * @param {boolean} state Make input read-only
5852  * @chainable
5853  */
5854 OO.ui.InputWidget.prototype.setReadOnly = function ( state ) {
5855         this.readOnly = !!state;
5856         this.$input.prop( 'readOnly', this.readOnly );
5857         return this;
5858 };
5859
5860 /**
5861  * @inheritdoc
5862  */
5863 OO.ui.InputWidget.prototype.setDisabled = function ( state ) {
5864         OO.ui.InputWidget.super.prototype.setDisabled.call( this, state );
5865         if ( this.$input ) {
5866                 this.$input.prop( 'disabled', this.isDisabled() );
5867         }
5868         return this;
5869 };
5870
5871 /**
5872  * Focus the input.
5873  *
5874  * @chainable
5875  */
5876 OO.ui.InputWidget.prototype.focus = function () {
5877         this.$input.focus();
5878         return this;
5879 };
5880 /**
5881  * Checkbox widget.
5882  *
5883  * @class
5884  * @extends OO.ui.InputWidget
5885  *
5886  * @constructor
5887  * @param {Object} [config] Configuration options
5888  */
5889 OO.ui.CheckboxInputWidget = function OoUiCheckboxInputWidget( config ) {
5890         // Parent constructor
5891         OO.ui.CheckboxInputWidget.super.call( this, config );
5892
5893         // Initialization
5894         this.$element.addClass( 'oo-ui-checkboxInputWidget' );
5895 };
5896
5897 /* Setup */
5898
5899 OO.inheritClass( OO.ui.CheckboxInputWidget, OO.ui.InputWidget );
5900
5901 /* Events */
5902
5903 /* Methods */
5904
5905 /**
5906  * Get input element.
5907  *
5908  * @return {jQuery} Input element
5909  */
5910 OO.ui.CheckboxInputWidget.prototype.getInputElement = function () {
5911         return this.$( '<input type="checkbox" />' );
5912 };
5913
5914 /**
5915  * Get checked state of the checkbox
5916  *
5917  * @return {boolean} If the checkbox is checked
5918  */
5919 OO.ui.CheckboxInputWidget.prototype.getValue = function () {
5920         return this.value;
5921 };
5922
5923 /**
5924  * Set value
5925  */
5926 OO.ui.CheckboxInputWidget.prototype.setValue = function ( value ) {
5927         value = !!value;
5928         if ( this.value !== value ) {
5929                 this.value = value;
5930                 this.$input.prop( 'checked', this.value );
5931                 this.emit( 'change', this.value );
5932         }
5933 };
5934
5935 /**
5936  * @inheritdoc
5937  */
5938 OO.ui.CheckboxInputWidget.prototype.onEdit = function () {
5939         if ( !this.isDisabled() ) {
5940                 // Allow the stack to clear so the value will be updated
5941                 setTimeout( OO.ui.bind( function () {
5942                         this.setValue( this.$input.prop( 'checked' ) );
5943                 }, this ) );
5944         }
5945 };
5946 /**
5947  * Label widget.
5948  *
5949  * @class
5950  * @extends OO.ui.Widget
5951  * @mixins OO.ui.LabeledElement
5952  *
5953  * @constructor
5954  * @param {Object} [config] Configuration options
5955  */
5956 OO.ui.LabelWidget = function OoUiLabelWidget( config ) {
5957         // Config intialization
5958         config = config || {};
5959
5960         // Parent constructor
5961         OO.ui.LabelWidget.super.call( this, config );
5962
5963         // Mixin constructors
5964         OO.ui.LabeledElement.call( this, this.$element, config );
5965
5966         // Properties
5967         this.input = config.input;
5968
5969         // Events
5970         if ( this.input instanceof OO.ui.InputWidget ) {
5971                 this.$element.on( 'click', OO.ui.bind( this.onClick, this ) );
5972         }
5973
5974         // Initialization
5975         this.$element.addClass( 'oo-ui-labelWidget' );
5976 };
5977
5978 /* Setup */
5979
5980 OO.inheritClass( OO.ui.LabelWidget, OO.ui.Widget );
5981 OO.mixinClass( OO.ui.LabelWidget, OO.ui.LabeledElement );
5982
5983 /* Static Properties */
5984
5985 OO.ui.LabelWidget.static.tagName = 'label';
5986
5987 /* Methods */
5988
5989 /**
5990  * Handles label mouse click events.
5991  *
5992  * @param {jQuery.Event} e Mouse click event
5993  */
5994 OO.ui.LabelWidget.prototype.onClick = function () {
5995         this.input.simulateLabelClick();
5996         return false;
5997 };
5998 /**
5999  * Lookup input widget.
6000  *
6001  * Mixin that adds a menu showing suggested values to a text input. Subclasses must handle `select`
6002  * and `choose` events on #lookupMenu to make use of selections.
6003  *
6004  * @class
6005  * @abstract
6006  *
6007  * @constructor
6008  * @param {OO.ui.TextInputWidget} input Input widget
6009  * @param {Object} [config] Configuration options
6010  * @cfg {jQuery} [$overlay=this.$( 'body' )] Overlay layer
6011  */
6012 OO.ui.LookupInputWidget = function OoUiLookupInputWidget( input, config ) {
6013         // Config intialization
6014         config = config || {};
6015
6016         // Properties
6017         this.lookupInput = input;
6018         this.$overlay = config.$overlay || this.$( 'body,.oo-ui-window-overlay' ).last();
6019         this.lookupMenu = new OO.ui.TextInputMenuWidget( this, {
6020                 '$': OO.ui.Element.getJQuery( this.$overlay ),
6021                 'input': this.lookupInput,
6022                 '$container': config.$container
6023         } );
6024         this.lookupCache = {};
6025         this.lookupQuery = null;
6026         this.lookupRequest = null;
6027         this.populating = false;
6028
6029         // Events
6030         this.$overlay.append( this.lookupMenu.$element );
6031
6032         this.lookupInput.$input.on( {
6033                 'focus': OO.ui.bind( this.onLookupInputFocus, this ),
6034                 'blur': OO.ui.bind( this.onLookupInputBlur, this ),
6035                 'mousedown': OO.ui.bind( this.onLookupInputMouseDown, this )
6036         } );
6037         this.lookupInput.connect( this, { 'change': 'onLookupInputChange' } );
6038
6039         // Initialization
6040         this.$element.addClass( 'oo-ui-lookupWidget' );
6041         this.lookupMenu.$element.addClass( 'oo-ui-lookupWidget-menu' );
6042 };
6043
6044 /* Methods */
6045
6046 /**
6047  * Handle input focus event.
6048  *
6049  * @param {jQuery.Event} e Input focus event
6050  */
6051 OO.ui.LookupInputWidget.prototype.onLookupInputFocus = function () {
6052         this.openLookupMenu();
6053 };
6054
6055 /**
6056  * Handle input blur event.
6057  *
6058  * @param {jQuery.Event} e Input blur event
6059  */
6060 OO.ui.LookupInputWidget.prototype.onLookupInputBlur = function () {
6061         this.lookupMenu.hide();
6062 };
6063
6064 /**
6065  * Handle input mouse down event.
6066  *
6067  * @param {jQuery.Event} e Input mouse down event
6068  */
6069 OO.ui.LookupInputWidget.prototype.onLookupInputMouseDown = function () {
6070         this.openLookupMenu();
6071 };
6072
6073 /**
6074  * Handle input change event.
6075  *
6076  * @param {string} value New input value
6077  */
6078 OO.ui.LookupInputWidget.prototype.onLookupInputChange = function () {
6079         this.openLookupMenu();
6080 };
6081
6082 /**
6083  * Get lookup menu.
6084  *
6085  * @return {OO.ui.TextInputMenuWidget}
6086  */
6087 OO.ui.LookupInputWidget.prototype.getLookupMenu = function () {
6088         return this.lookupMenu;
6089 };
6090
6091 /**
6092  * Open the menu.
6093  *
6094  * @chainable
6095  */
6096 OO.ui.LookupInputWidget.prototype.openLookupMenu = function () {
6097         var value = this.lookupInput.getValue();
6098
6099         if ( this.lookupMenu.$input.is( ':focus' ) && $.trim( value ) !== '' ) {
6100                 this.populateLookupMenu();
6101                 if ( !this.lookupMenu.isVisible() ) {
6102                         this.lookupMenu.show();
6103                 }
6104         } else {
6105                 this.lookupMenu.clearItems();
6106                 this.lookupMenu.hide();
6107         }
6108
6109         return this;
6110 };
6111
6112 /**
6113  * Populate lookup menu with current information.
6114  *
6115  * @chainable
6116  */
6117 OO.ui.LookupInputWidget.prototype.populateLookupMenu = function () {
6118         if ( !this.populating ) {
6119                 this.populating = true;
6120                 this.getLookupMenuItems()
6121                         .done( OO.ui.bind( function ( items ) {
6122                                 this.lookupMenu.clearItems();
6123                                 if ( items.length ) {
6124                                         this.lookupMenu.show();
6125                                         this.lookupMenu.addItems( items );
6126                                         this.initializeLookupMenuSelection();
6127                                         this.openLookupMenu();
6128                                 } else {
6129                                         this.lookupMenu.hide();
6130                                 }
6131                                 this.populating = false;
6132                         }, this ) )
6133                         .fail( OO.ui.bind( function () {
6134                                 this.lookupMenu.clearItems();
6135                                 this.populating = false;
6136                         }, this ) );
6137         }
6138
6139         return this;
6140 };
6141
6142 /**
6143  * Set selection in the lookup menu with current information.
6144  *
6145  * @chainable
6146  */
6147 OO.ui.LookupInputWidget.prototype.initializeLookupMenuSelection = function () {
6148         if ( !this.lookupMenu.getSelectedItem() ) {
6149                 this.lookupMenu.selectItem( this.lookupMenu.getFirstSelectableItem() );
6150         }
6151         this.lookupMenu.highlightItem( this.lookupMenu.getSelectedItem() );
6152 };
6153
6154 /**
6155  * Get lookup menu items for the current query.
6156  *
6157  * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument
6158  * of the done event
6159  */
6160 OO.ui.LookupInputWidget.prototype.getLookupMenuItems = function () {
6161         var value = this.lookupInput.getValue(),
6162                 deferred = $.Deferred();
6163
6164         if ( value && value !== this.lookupQuery ) {
6165                 // Abort current request if query has changed
6166                 if ( this.lookupRequest ) {
6167                         this.lookupRequest.abort();
6168                         this.lookupQuery = null;
6169                         this.lookupRequest = null;
6170                 }
6171                 if ( value in this.lookupCache ) {
6172                         deferred.resolve( this.getLookupMenuItemsFromData( this.lookupCache[value] ) );
6173                 } else {
6174                         this.lookupQuery = value;
6175                         this.lookupRequest = this.getLookupRequest()
6176                                 .always( OO.ui.bind( function () {
6177                                         this.lookupQuery = null;
6178                                         this.lookupRequest = null;
6179                                 }, this ) )
6180                                 .done( OO.ui.bind( function ( data ) {
6181                                         this.lookupCache[value] = this.getLookupCacheItemFromData( data );
6182                                         deferred.resolve( this.getLookupMenuItemsFromData( this.lookupCache[value] ) );
6183                                 }, this ) )
6184                                 .fail( function () {
6185                                         deferred.reject();
6186                                 } );
6187                         this.pushPending();
6188                         this.lookupRequest.always( OO.ui.bind( function () {
6189                                 this.popPending();
6190                         }, this ) );
6191                 }
6192         }
6193         return deferred.promise();
6194 };
6195
6196 /**
6197  * Get a new request object of the current lookup query value.
6198  *
6199  * @abstract
6200  * @return {jqXHR} jQuery AJAX object, or promise object with an .abort() method
6201  */
6202 OO.ui.LookupInputWidget.prototype.getLookupRequest = function () {
6203         // Stub, implemented in subclass
6204         return null;
6205 };
6206
6207 /**
6208  * Handle successful lookup request.
6209  *
6210  * Overriding methods should call #populateLookupMenu when results are available and cache results
6211  * for future lookups in #lookupCache as an array of #OO.ui.MenuItemWidget objects.
6212  *
6213  * @abstract
6214  * @param {Mixed} data Response from server
6215  */
6216 OO.ui.LookupInputWidget.prototype.onLookupRequestDone = function () {
6217         // Stub, implemented in subclass
6218 };
6219
6220 /**
6221  * Get a list of menu item widgets from the data stored by the lookup request's done handler.
6222  *
6223  * @abstract
6224  * @param {Mixed} data Cached result data, usually an array
6225  * @return {OO.ui.MenuItemWidget[]} Menu items
6226  */
6227 OO.ui.LookupInputWidget.prototype.getLookupMenuItemsFromData = function () {
6228         // Stub, implemented in subclass
6229         return [];
6230 };
6231 /**
6232  * Option widget.
6233  *
6234  * Use with OO.ui.SelectWidget.
6235  *
6236  * @class
6237  * @extends OO.ui.Widget
6238  * @mixins OO.ui.IconedElement
6239  * @mixins OO.ui.LabeledElement
6240  * @mixins OO.ui.IndicatedElement
6241  * @mixins OO.ui.FlaggableElement
6242  *
6243  * @constructor
6244  * @param {Mixed} data Option data
6245  * @param {Object} [config] Configuration options
6246  * @cfg {string} [rel] Value for `rel` attribute in DOM, allowing per-option styling
6247  */
6248 OO.ui.OptionWidget = function OoUiOptionWidget( data, config ) {
6249         // Config intialization
6250         config = config || {};
6251
6252         // Parent constructor
6253         OO.ui.OptionWidget.super.call( this, config );
6254
6255         // Mixin constructors
6256         OO.ui.ItemWidget.call( this );
6257         OO.ui.IconedElement.call( this, this.$( '<span>' ), config );
6258         OO.ui.LabeledElement.call( this, this.$( '<span>' ), config );
6259         OO.ui.IndicatedElement.call( this, this.$( '<span>' ), config );
6260         OO.ui.FlaggableElement.call( this, config );
6261
6262         // Properties
6263         this.data = data;
6264         this.selected = false;
6265         this.highlighted = false;
6266         this.pressed = false;
6267
6268         // Initialization
6269         this.$element
6270                 .data( 'oo-ui-optionWidget', this )
6271                 .attr( 'rel', config.rel )
6272                 .addClass( 'oo-ui-optionWidget' )
6273                 .append( this.$label );
6274         this.$element
6275                 .prepend( this.$icon )
6276                 .append( this.$indicator );
6277 };
6278
6279 /* Setup */
6280
6281 OO.inheritClass( OO.ui.OptionWidget, OO.ui.Widget );
6282 OO.mixinClass( OO.ui.OptionWidget, OO.ui.ItemWidget );
6283 OO.mixinClass( OO.ui.OptionWidget, OO.ui.IconedElement );
6284 OO.mixinClass( OO.ui.OptionWidget, OO.ui.LabeledElement );
6285 OO.mixinClass( OO.ui.OptionWidget, OO.ui.IndicatedElement );
6286 OO.mixinClass( OO.ui.OptionWidget, OO.ui.FlaggableElement );
6287
6288 /* Static Properties */
6289
6290 OO.ui.OptionWidget.static.tagName = 'li';
6291
6292 OO.ui.OptionWidget.static.selectable = true;
6293
6294 OO.ui.OptionWidget.static.highlightable = true;
6295
6296 OO.ui.OptionWidget.static.pressable = true;
6297
6298 OO.ui.OptionWidget.static.scrollIntoViewOnSelect = false;
6299
6300 /* Methods */
6301
6302 /**
6303  * Check if option can be selected.
6304  *
6305  * @return {boolean} Item is selectable
6306  */
6307 OO.ui.OptionWidget.prototype.isSelectable = function () {
6308         return this.constructor.static.selectable && !this.isDisabled();
6309 };
6310
6311 /**
6312  * Check if option can be highlighted.
6313  *
6314  * @return {boolean} Item is highlightable
6315  */
6316 OO.ui.OptionWidget.prototype.isHighlightable = function () {
6317         return this.constructor.static.highlightable && !this.isDisabled();
6318 };
6319
6320 /**
6321  * Check if option can be pressed.
6322  *
6323  * @return {boolean} Item is pressable
6324  */
6325 OO.ui.OptionWidget.prototype.isPressable = function () {
6326         return this.constructor.static.pressable && !this.isDisabled();
6327 };
6328
6329 /**
6330  * Check if option is selected.
6331  *
6332  * @return {boolean} Item is selected
6333  */
6334 OO.ui.OptionWidget.prototype.isSelected = function () {
6335         return this.selected;
6336 };
6337
6338 /**
6339  * Check if option is highlighted.
6340  *
6341  * @return {boolean} Item is highlighted
6342  */
6343 OO.ui.OptionWidget.prototype.isHighlighted = function () {
6344         return this.highlighted;
6345 };
6346
6347 /**
6348  * Check if option is pressed.
6349  *
6350  * @return {boolean} Item is pressed
6351  */
6352 OO.ui.OptionWidget.prototype.isPressed = function () {
6353         return this.pressed;
6354 };
6355
6356 /**
6357  * Set selected state.
6358  *
6359  * @param {boolean} [state=false] Select option
6360  * @chainable
6361  */
6362 OO.ui.OptionWidget.prototype.setSelected = function ( state ) {
6363         if ( this.constructor.static.selectable ) {
6364                 this.selected = !!state;
6365                 if ( this.selected ) {
6366                         this.$element.addClass( 'oo-ui-optionWidget-selected' );
6367                         if ( this.constructor.static.scrollIntoViewOnSelect ) {
6368                                 this.scrollElementIntoView();
6369                         }
6370                 } else {
6371                         this.$element.removeClass( 'oo-ui-optionWidget-selected' );
6372                 }
6373         }
6374         return this;
6375 };
6376
6377 /**
6378  * Set highlighted state.
6379  *
6380  * @param {boolean} [state=false] Highlight option
6381  * @chainable
6382  */
6383 OO.ui.OptionWidget.prototype.setHighlighted = function ( state ) {
6384         if ( this.constructor.static.highlightable ) {
6385                 this.highlighted = !!state;
6386                 if ( this.highlighted ) {
6387                         this.$element.addClass( 'oo-ui-optionWidget-highlighted' );
6388                 } else {
6389                         this.$element.removeClass( 'oo-ui-optionWidget-highlighted' );
6390                 }
6391         }
6392         return this;
6393 };
6394
6395 /**
6396  * Set pressed state.
6397  *
6398  * @param {boolean} [state=false] Press option
6399  * @chainable
6400  */
6401 OO.ui.OptionWidget.prototype.setPressed = function ( state ) {
6402         if ( this.constructor.static.pressable ) {
6403                 this.pressed = !!state;
6404                 if ( this.pressed ) {
6405                         this.$element.addClass( 'oo-ui-optionWidget-pressed' );
6406                 } else {
6407                         this.$element.removeClass( 'oo-ui-optionWidget-pressed' );
6408                 }
6409         }
6410         return this;
6411 };
6412
6413 /**
6414  * Make the option's highlight flash.
6415  *
6416  * While flashing, the visual style of the pressed state is removed if present.
6417  *
6418  * @return {jQuery.Promise} Promise resolved when flashing is done
6419  */
6420 OO.ui.OptionWidget.prototype.flash = function () {
6421         var $this = this.$element,
6422                 deferred = $.Deferred();
6423
6424         if ( !this.isDisabled() && this.constructor.static.pressable ) {
6425                 $this.removeClass( 'oo-ui-optionWidget-highlighted oo-ui-optionWidget-pressed' );
6426                 setTimeout( OO.ui.bind( function () {
6427                         // Restore original classes
6428                         $this
6429                                 .toggleClass( 'oo-ui-optionWidget-highlighted', this.highlighted )
6430                                 .toggleClass( 'oo-ui-optionWidget-pressed', this.pressed );
6431                         setTimeout( function () {
6432                                 deferred.resolve();
6433                         }, 100 );
6434                 }, this ), 100 );
6435         }
6436
6437         return deferred.promise();
6438 };
6439
6440 /**
6441  * Get option data.
6442  *
6443  * @return {Mixed} Option data
6444  */
6445 OO.ui.OptionWidget.prototype.getData = function () {
6446         return this.data;
6447 };
6448 /**
6449  * Selection of options.
6450  *
6451  * Use together with OO.ui.OptionWidget.
6452  *
6453  * @class
6454  * @extends OO.ui.Widget
6455  * @mixins OO.ui.GroupElement
6456  *
6457  * @constructor
6458  * @param {Object} [config] Configuration options
6459  * @cfg {OO.ui.OptionWidget[]} [items] Options to add
6460  */
6461 OO.ui.SelectWidget = function OoUiSelectWidget( config ) {
6462         // Config intialization
6463         config = config || {};
6464
6465         // Parent constructor
6466         OO.ui.SelectWidget.super.call( this, config );
6467
6468         // Mixin constructors
6469         OO.ui.GroupWidget.call( this, this.$element, config );
6470
6471         // Properties
6472         this.pressed = false;
6473         this.selecting = null;
6474         this.hashes = {};
6475         this.onMouseUpHandler = OO.ui.bind( this.onMouseUp, this );
6476         this.onMouseMoveHandler = OO.ui.bind( this.onMouseMove, this );
6477
6478         // Events
6479         this.$element.on( {
6480                 'mousedown': OO.ui.bind( this.onMouseDown, this ),
6481                 'mouseover': OO.ui.bind( this.onMouseOver, this ),
6482                 'mouseleave': OO.ui.bind( this.onMouseLeave, this )
6483         } );
6484
6485         // Initialization
6486         this.$element.addClass( 'oo-ui-selectWidget oo-ui-selectWidget-depressed' );
6487         if ( $.isArray( config.items ) ) {
6488                 this.addItems( config.items );
6489         }
6490 };
6491
6492 /* Setup */
6493
6494 OO.inheritClass( OO.ui.SelectWidget, OO.ui.Widget );
6495
6496 // Need to mixin base class as well
6497 OO.mixinClass( OO.ui.SelectWidget, OO.ui.GroupElement );
6498 OO.mixinClass( OO.ui.SelectWidget, OO.ui.GroupWidget );
6499
6500 /* Events */
6501
6502 /**
6503  * @event highlight
6504  * @param {OO.ui.OptionWidget|null} item Highlighted item
6505  */
6506
6507 /**
6508  * @event press
6509  * @param {OO.ui.OptionWidget|null} item Pressed item
6510  */
6511
6512 /**
6513  * @event select
6514  * @param {OO.ui.OptionWidget|null} item Selected item
6515  */
6516
6517 /**
6518  * @event choose
6519  * @param {OO.ui.OptionWidget|null} item Chosen item
6520  */
6521
6522 /**
6523  * @event add
6524  * @param {OO.ui.OptionWidget[]} items Added items
6525  * @param {number} index Index items were added at
6526  */
6527
6528 /**
6529  * @event remove
6530  * @param {OO.ui.OptionWidget[]} items Removed items
6531  */
6532
6533 /* Static Properties */
6534
6535 OO.ui.SelectWidget.static.tagName = 'ul';
6536
6537 /* Methods */
6538
6539 /**
6540  * Handle mouse down events.
6541  *
6542  * @private
6543  * @param {jQuery.Event} e Mouse down event
6544  */
6545 OO.ui.SelectWidget.prototype.onMouseDown = function ( e ) {
6546         var item;
6547
6548         if ( !this.isDisabled() && e.which === 1 ) {
6549                 this.togglePressed( true );
6550                 item = this.getTargetItem( e );
6551                 if ( item && item.isSelectable() ) {
6552                         this.pressItem( item );
6553                         this.selecting = item;
6554                         this.getElementDocument().addEventListener(
6555                                 'mouseup', this.onMouseUpHandler, true
6556                         );
6557                         this.getElementDocument().addEventListener(
6558                                 'mousemove', this.onMouseMoveHandler, true
6559                         );
6560                 }
6561         }
6562         return false;
6563 };
6564
6565 /**
6566  * Handle mouse up events.
6567  *
6568  * @private
6569  * @param {jQuery.Event} e Mouse up event
6570  */
6571 OO.ui.SelectWidget.prototype.onMouseUp = function ( e ) {
6572         var item;
6573
6574         this.togglePressed( false );
6575         if ( !this.selecting ) {
6576                 item = this.getTargetItem( e );
6577                 if ( item && item.isSelectable() ) {
6578                         this.selecting = item;
6579                 }
6580         }
6581         if ( !this.isDisabled() && e.which === 1 && this.selecting ) {
6582                 this.pressItem( null );
6583                 this.chooseItem( this.selecting );
6584                 this.selecting = null;
6585         }
6586
6587         this.getElementDocument().removeEventListener(
6588                 'mouseup', this.onMouseUpHandler, true
6589         );
6590         this.getElementDocument().removeEventListener(
6591                 'mousemove', this.onMouseMoveHandler, true
6592         );
6593
6594         return false;
6595 };
6596
6597 /**
6598  * Handle mouse move events.
6599  *
6600  * @private
6601  * @param {jQuery.Event} e Mouse move event
6602  */
6603 OO.ui.SelectWidget.prototype.onMouseMove = function ( e ) {
6604         var item;
6605
6606         if ( !this.isDisabled() && this.pressed ) {
6607                 item = this.getTargetItem( e );
6608                 if ( item && item !== this.selecting && item.isSelectable() ) {
6609                         this.pressItem( item );
6610                         this.selecting = item;
6611                 }
6612         }
6613         return false;
6614 };
6615
6616 /**
6617  * Handle mouse over events.
6618  *
6619  * @private
6620  * @param {jQuery.Event} e Mouse over event
6621  */
6622 OO.ui.SelectWidget.prototype.onMouseOver = function ( e ) {
6623         var item;
6624
6625         if ( !this.isDisabled() ) {
6626                 item = this.getTargetItem( e );
6627                 this.highlightItem( item && item.isHighlightable() ? item : null );
6628         }
6629         return false;
6630 };
6631
6632 /**
6633  * Handle mouse leave events.
6634  *
6635  * @private
6636  * @param {jQuery.Event} e Mouse over event
6637  */
6638 OO.ui.SelectWidget.prototype.onMouseLeave = function () {
6639         if ( !this.isDisabled() ) {
6640                 this.highlightItem( null );
6641         }
6642         return false;
6643 };
6644
6645 /**
6646  * Get the closest item to a jQuery.Event.
6647  *
6648  * @private
6649  * @param {jQuery.Event} e
6650  * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
6651  */
6652 OO.ui.SelectWidget.prototype.getTargetItem = function ( e ) {
6653         var $item = this.$( e.target ).closest( '.oo-ui-optionWidget' );
6654         if ( $item.length ) {
6655                 return $item.data( 'oo-ui-optionWidget' );
6656         }
6657         return null;
6658 };
6659
6660 /**
6661  * Get selected item.
6662  *
6663  * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
6664  */
6665 OO.ui.SelectWidget.prototype.getSelectedItem = function () {
6666         var i, len;
6667
6668         for ( i = 0, len = this.items.length; i < len; i++ ) {
6669                 if ( this.items[i].isSelected() ) {
6670                         return this.items[i];
6671                 }
6672         }
6673         return null;
6674 };
6675
6676 /**
6677  * Get highlighted item.
6678  *
6679  * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
6680  */
6681 OO.ui.SelectWidget.prototype.getHighlightedItem = function () {
6682         var i, len;
6683
6684         for ( i = 0, len = this.items.length; i < len; i++ ) {
6685                 if ( this.items[i].isHighlighted() ) {
6686                         return this.items[i];
6687                 }
6688         }
6689         return null;
6690 };
6691
6692 /**
6693  * Get an existing item with equivilant data.
6694  *
6695  * @param {Object} data Item data to search for
6696  * @return {OO.ui.OptionWidget|null} Item with equivilent value, `null` if none exists
6697  */
6698 OO.ui.SelectWidget.prototype.getItemFromData = function ( data ) {
6699         var hash = OO.getHash( data );
6700
6701         if ( hash in this.hashes ) {
6702                 return this.hashes[hash];
6703         }
6704
6705         return null;
6706 };
6707
6708 /**
6709  * Toggle pressed state.
6710  *
6711  * @param {boolean} pressed An option is being pressed
6712  */
6713 OO.ui.SelectWidget.prototype.togglePressed = function ( pressed ) {
6714         if ( pressed === undefined ) {
6715                 pressed = !this.pressed;
6716         }
6717         if ( pressed !== this.pressed ) {
6718                 this.$element.toggleClass( 'oo-ui-selectWidget-pressed', pressed );
6719                 this.$element.toggleClass( 'oo-ui-selectWidget-depressed', !pressed );
6720                 this.pressed = pressed;
6721         }
6722 };
6723
6724 /**
6725  * Highlight an item.
6726  *
6727  * Highlighting is mutually exclusive.
6728  *
6729  * @param {OO.ui.OptionWidget} [item] Item to highlight, omit to deselect all
6730  * @fires highlight
6731  * @chainable
6732  */
6733 OO.ui.SelectWidget.prototype.highlightItem = function ( item ) {
6734         var i, len, highlighted,
6735                 changed = false;
6736
6737         for ( i = 0, len = this.items.length; i < len; i++ ) {
6738                 highlighted = this.items[i] === item;
6739                 if ( this.items[i].isHighlighted() !== highlighted ) {
6740                         this.items[i].setHighlighted( highlighted );
6741                         changed = true;
6742                 }
6743         }
6744         if ( changed ) {
6745                 this.emit( 'highlight', item );
6746         }
6747
6748         return this;
6749 };
6750
6751 /**
6752  * Select an item.
6753  *
6754  * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
6755  * @fires select
6756  * @chainable
6757  */
6758 OO.ui.SelectWidget.prototype.selectItem = function ( item ) {
6759         var i, len, selected,
6760                 changed = false;
6761
6762         for ( i = 0, len = this.items.length; i < len; i++ ) {
6763                 selected = this.items[i] === item;
6764                 if ( this.items[i].isSelected() !== selected ) {
6765                         this.items[i].setSelected( selected );
6766                         changed = true;
6767                 }
6768         }
6769         if ( changed ) {
6770                 this.emit( 'select', item );
6771         }
6772
6773         return this;
6774 };
6775
6776 /**
6777  * Press an item.
6778  *
6779  * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
6780  * @fires press
6781  * @chainable
6782  */
6783 OO.ui.SelectWidget.prototype.pressItem = function ( item ) {
6784         var i, len, pressed,
6785                 changed = false;
6786
6787         for ( i = 0, len = this.items.length; i < len; i++ ) {
6788                 pressed = this.items[i] === item;
6789                 if ( this.items[i].isPressed() !== pressed ) {
6790                         this.items[i].setPressed( pressed );
6791                         changed = true;
6792                 }
6793         }
6794         if ( changed ) {
6795                 this.emit( 'press', item );
6796         }
6797
6798         return this;
6799 };
6800
6801 /**
6802  * Choose an item.
6803  *
6804  * Identical to #selectItem, but may vary in subclasses that want to take additional action when
6805  * an item is selected using the keyboard or mouse.
6806  *
6807  * @param {OO.ui.OptionWidget} item Item to choose
6808  * @fires choose
6809  * @chainable
6810  */
6811 OO.ui.SelectWidget.prototype.chooseItem = function ( item ) {
6812         this.selectItem( item );
6813         this.emit( 'choose', item );
6814
6815         return this;
6816 };
6817
6818 /**
6819  * Get an item relative to another one.
6820  *
6821  * @param {OO.ui.OptionWidget} item Item to start at
6822  * @param {number} direction Direction to move in
6823  * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the menu
6824  */
6825 OO.ui.SelectWidget.prototype.getRelativeSelectableItem = function ( item, direction ) {
6826         var inc = direction > 0 ? 1 : -1,
6827                 len = this.items.length,
6828                 index = item instanceof OO.ui.OptionWidget ?
6829                         $.inArray( item, this.items ) : ( inc > 0 ? -1 : 0 ),
6830                 stopAt = Math.max( Math.min( index, len - 1 ), 0 ),
6831                 i = inc > 0 ?
6832                         // Default to 0 instead of -1, if nothing is selected let's start at the beginning
6833                         Math.max( index, -1 ) :
6834                         // Default to n-1 instead of -1, if nothing is selected let's start at the end
6835                         Math.min( index, len );
6836
6837         while ( true ) {
6838                 i = ( i + inc + len ) % len;
6839                 item = this.items[i];
6840                 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() ) {
6841                         return item;
6842                 }
6843                 // Stop iterating when we've looped all the way around
6844                 if ( i === stopAt ) {
6845                         break;
6846                 }
6847         }
6848         return null;
6849 };
6850
6851 /**
6852  * Get the next selectable item.
6853  *
6854  * @return {OO.ui.OptionWidget|null} Item, `null` if ther aren't any selectable items
6855  */
6856 OO.ui.SelectWidget.prototype.getFirstSelectableItem = function () {
6857         var i, len, item;
6858
6859         for ( i = 0, len = this.items.length; i < len; i++ ) {
6860                 item = this.items[i];
6861                 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() ) {
6862                         return item;
6863                 }
6864         }
6865
6866         return null;
6867 };
6868
6869 /**
6870  * Add items.
6871  *
6872  * When items are added with the same values as existing items, the existing items will be
6873  * automatically removed before the new items are added.
6874  *
6875  * @param {OO.ui.OptionWidget[]} items Items to add
6876  * @param {number} [index] Index to insert items after
6877  * @fires add
6878  * @chainable
6879  */
6880 OO.ui.SelectWidget.prototype.addItems = function ( items, index ) {
6881         var i, len, item, hash,
6882                 remove = [];
6883
6884         for ( i = 0, len = items.length; i < len; i++ ) {
6885                 item = items[i];
6886                 hash = OO.getHash( item.getData() );
6887                 if ( hash in this.hashes ) {
6888                         // Remove item with same value
6889                         remove.push( this.hashes[hash] );
6890                 }
6891                 this.hashes[hash] = item;
6892         }
6893         if ( remove.length ) {
6894                 this.removeItems( remove );
6895         }
6896
6897         // Mixin method
6898         OO.ui.GroupWidget.prototype.addItems.call( this, items, index );
6899
6900         // Always provide an index, even if it was omitted
6901         this.emit( 'add', items, index === undefined ? this.items.length - items.length - 1 : index );
6902
6903         return this;
6904 };
6905
6906 /**
6907  * Remove items.
6908  *
6909  * Items will be detached, not removed, so they can be used later.
6910  *
6911  * @param {OO.ui.OptionWidget[]} items Items to remove
6912  * @fires remove
6913  * @chainable
6914  */
6915 OO.ui.SelectWidget.prototype.removeItems = function ( items ) {
6916         var i, len, item, hash;
6917
6918         for ( i = 0, len = items.length; i < len; i++ ) {
6919                 item = items[i];
6920                 hash = OO.getHash( item.getData() );
6921                 if ( hash in this.hashes ) {
6922                         // Remove existing item
6923                         delete this.hashes[hash];
6924                 }
6925                 if ( item.isSelected() ) {
6926                         this.selectItem( null );
6927                 }
6928         }
6929
6930         // Mixin method
6931         OO.ui.GroupWidget.prototype.removeItems.call( this, items );
6932
6933         this.emit( 'remove', items );
6934
6935         return this;
6936 };
6937
6938 /**
6939  * Clear all items.
6940  *
6941  * Items will be detached, not removed, so they can be used later.
6942  *
6943  * @fires remove
6944  * @chainable
6945  */
6946 OO.ui.SelectWidget.prototype.clearItems = function () {
6947         var items = this.items.slice();
6948
6949         // Clear all items
6950         this.hashes = {};
6951         // Mixin method
6952         OO.ui.GroupWidget.prototype.clearItems.call( this );
6953         this.selectItem( null );
6954
6955         this.emit( 'remove', items );
6956
6957         return this;
6958 };
6959 /**
6960  * Menu item widget.
6961  *
6962  * Use with OO.ui.MenuWidget.
6963  *
6964  * @class
6965  * @extends OO.ui.OptionWidget
6966  *
6967  * @constructor
6968  * @param {Mixed} data Item data
6969  * @param {Object} [config] Configuration options
6970  */
6971 OO.ui.MenuItemWidget = function OoUiMenuItemWidget( data, config ) {
6972         // Configuration initialization
6973         config = $.extend( { 'icon': 'check' }, config );
6974
6975         // Parent constructor
6976         OO.ui.MenuItemWidget.super.call( this, data, config );
6977
6978         // Initialization
6979         this.$element.addClass( 'oo-ui-menuItemWidget' );
6980 };
6981
6982 /* Setup */
6983
6984 OO.inheritClass( OO.ui.MenuItemWidget, OO.ui.OptionWidget );
6985 /**
6986  * Menu widget.
6987  *
6988  * Use together with OO.ui.MenuItemWidget.
6989  *
6990  * @class
6991  * @extends OO.ui.SelectWidget
6992  * @mixins OO.ui.ClippableElement
6993  *
6994  * @constructor
6995  * @param {Object} [config] Configuration options
6996  * @cfg {OO.ui.InputWidget} [input] Input to bind keyboard handlers to
6997  * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu
6998  */
6999 OO.ui.MenuWidget = function OoUiMenuWidget( config ) {
7000         // Config intialization
7001         config = config || {};
7002
7003         // Parent constructor
7004         OO.ui.MenuWidget.super.call( this, config );
7005
7006         // Mixin constructors
7007         OO.ui.ClippableElement.call( this, this.$group, config );
7008
7009         // Properties
7010         this.autoHide = config.autoHide === undefined || !!config.autoHide;
7011         this.newItems = null;
7012         this.$input = config.input ? config.input.$input : null;
7013         this.$previousFocus = null;
7014         this.isolated = !config.input;
7015         this.visible = false;
7016         this.flashing = false;
7017         this.onKeyDownHandler = OO.ui.bind( this.onKeyDown, this );
7018         this.onDocumentMouseDownHandler = OO.ui.bind( this.onDocumentMouseDown, this );
7019
7020         // Initialization
7021         this.$element.hide().addClass( 'oo-ui-menuWidget' );
7022 };
7023
7024 /* Setup */
7025
7026 OO.inheritClass( OO.ui.MenuWidget, OO.ui.SelectWidget );
7027 OO.mixinClass( OO.ui.MenuWidget, OO.ui.ClippableElement );
7028
7029 /* Methods */
7030
7031 /**
7032  * Handles document mouse down events.
7033  *
7034  * @param {jQuery.Event} e Key down event
7035  */
7036 OO.ui.MenuWidget.prototype.onDocumentMouseDown = function ( e ) {
7037         if ( !$.contains( this.$element[0], e.target ) ) {
7038                 this.hide();
7039         }
7040 };
7041
7042 /**
7043  * Handles key down events.
7044  *
7045  * @param {jQuery.Event} e Key down event
7046  */
7047 OO.ui.MenuWidget.prototype.onKeyDown = function ( e ) {
7048         var nextItem,
7049                 handled = false,
7050                 highlightItem = this.getHighlightedItem();
7051
7052         if ( !this.isDisabled() && this.visible ) {
7053                 if ( !highlightItem ) {
7054                         highlightItem = this.getSelectedItem();
7055                 }
7056                 switch ( e.keyCode ) {
7057                         case OO.ui.Keys.ENTER:
7058                                 this.chooseItem( highlightItem );
7059                                 handled = true;
7060                                 break;
7061                         case OO.ui.Keys.UP:
7062                                 nextItem = this.getRelativeSelectableItem( highlightItem, -1 );
7063                                 handled = true;
7064                                 break;
7065                         case OO.ui.Keys.DOWN:
7066                                 nextItem = this.getRelativeSelectableItem( highlightItem, 1 );
7067                                 handled = true;
7068                                 break;
7069                         case OO.ui.Keys.ESCAPE:
7070                                 if ( highlightItem ) {
7071                                         highlightItem.setHighlighted( false );
7072                                 }
7073                                 this.hide();
7074                                 handled = true;
7075                                 break;
7076                 }
7077
7078                 if ( nextItem ) {
7079                         this.highlightItem( nextItem );
7080                         nextItem.scrollElementIntoView();
7081                 }
7082
7083                 if ( handled ) {
7084                         e.preventDefault();
7085                         e.stopPropagation();
7086                         return false;
7087                 }
7088         }
7089 };
7090
7091 /**
7092  * Check if the menu is visible.
7093  *
7094  * @return {boolean} Menu is visible
7095  */
7096 OO.ui.MenuWidget.prototype.isVisible = function () {
7097         return this.visible;
7098 };
7099
7100 /**
7101  * Bind key down listener.
7102  */
7103 OO.ui.MenuWidget.prototype.bindKeyDownListener = function () {
7104         if ( this.$input ) {
7105                 this.$input.on( 'keydown', this.onKeyDownHandler );
7106         } else {
7107                 // Capture menu navigation keys
7108                 this.getElementWindow().addEventListener( 'keydown', this.onKeyDownHandler, true );
7109         }
7110 };
7111
7112 /**
7113  * Unbind key down listener.
7114  */
7115 OO.ui.MenuWidget.prototype.unbindKeyDownListener = function () {
7116         if ( this.$input ) {
7117                 this.$input.off( 'keydown' );
7118         } else {
7119                 this.getElementWindow().removeEventListener( 'keydown', this.onKeyDownHandler, true );
7120         }
7121 };
7122
7123 /**
7124  * Choose an item.
7125  *
7126  * This will close the menu when done, unlike selectItem which only changes selection.
7127  *
7128  * @param {OO.ui.OptionWidget} item Item to choose
7129  * @chainable
7130  */
7131 OO.ui.MenuWidget.prototype.chooseItem = function ( item ) {
7132         // Parent method
7133         OO.ui.MenuWidget.super.prototype.chooseItem.call( this, item );
7134
7135         if ( item && !this.flashing ) {
7136                 this.flashing = true;
7137                 item.flash().done( OO.ui.bind( function () {
7138                         this.hide();
7139                         this.flashing = false;
7140                 }, this ) );
7141         } else {
7142                 this.hide();
7143         }
7144
7145         return this;
7146 };
7147
7148 /**
7149  * Add items.
7150  *
7151  * Adding an existing item (by value) will move it.
7152  *
7153  * @param {OO.ui.MenuItemWidget[]} items Items to add
7154  * @param {number} [index] Index to insert items after
7155  * @chainable
7156  */
7157 OO.ui.MenuWidget.prototype.addItems = function ( items, index ) {
7158         var i, len, item;
7159
7160         // Parent method
7161         OO.ui.MenuWidget.super.prototype.addItems.call( this, items, index );
7162
7163         // Auto-initialize
7164         if ( !this.newItems ) {
7165                 this.newItems = [];
7166         }
7167
7168         for ( i = 0, len = items.length; i < len; i++ ) {
7169                 item = items[i];
7170                 if ( this.visible ) {
7171                         // Defer fitting label until
7172                         item.fitLabel();
7173                 } else {
7174                         this.newItems.push( item );
7175                 }
7176         }
7177
7178         return this;
7179 };
7180
7181 /**
7182  * Show the menu.
7183  *
7184  * @chainable
7185  */
7186 OO.ui.MenuWidget.prototype.show = function () {
7187         var i, len;
7188
7189         if ( this.items.length ) {
7190                 this.$element.show();
7191                 this.visible = true;
7192                 this.bindKeyDownListener();
7193
7194                 // Change focus to enable keyboard navigation
7195                 if ( this.isolated && this.$input && !this.$input.is( ':focus' ) ) {
7196                         this.$previousFocus = this.$( ':focus' );
7197                         this.$input.focus();
7198                 }
7199                 if ( this.newItems && this.newItems.length ) {
7200                         for ( i = 0, len = this.newItems.length; i < len; i++ ) {
7201                                 this.newItems[i].fitLabel();
7202                         }
7203                         this.newItems = null;
7204                 }
7205
7206                 this.setClipping( true );
7207
7208                 // Auto-hide
7209                 if ( this.autoHide ) {
7210                         this.getElementDocument().addEventListener(
7211                                 'mousedown', this.onDocumentMouseDownHandler, true
7212                         );
7213                 }
7214         }
7215
7216         return this;
7217 };
7218
7219 /**
7220  * Hide the menu.
7221  *
7222  * @chainable
7223  */
7224 OO.ui.MenuWidget.prototype.hide = function () {
7225         this.$element.hide();
7226         this.visible = false;
7227         this.unbindKeyDownListener();
7228
7229         if ( this.isolated && this.$previousFocus ) {
7230                 this.$previousFocus.focus();
7231                 this.$previousFocus = null;
7232         }
7233
7234         this.getElementDocument().removeEventListener(
7235                 'mousedown', this.onDocumentMouseDownHandler, true
7236         );
7237
7238         this.setClipping( false );
7239
7240         return this;
7241 };
7242 /**
7243  * Inline menu of options.
7244  *
7245  * Use with OO.ui.MenuOptionWidget.
7246  *
7247  * @class
7248  * @extends OO.ui.Widget
7249  * @mixins OO.ui.IconedElement
7250  * @mixins OO.ui.IndicatedElement
7251  * @mixins OO.ui.LabeledElement
7252  * @mixins OO.ui.TitledElement
7253  *
7254  * @constructor
7255  * @param {Object} [config] Configuration options
7256  * @cfg {Object} [menu] Configuration options to pass to menu widget
7257  */
7258 OO.ui.InlineMenuWidget = function OoUiInlineMenuWidget( config ) {
7259         // Configuration initialization
7260         config = $.extend( { 'indicator': 'down' }, config );
7261
7262         // Parent constructor
7263         OO.ui.InlineMenuWidget.super.call( this, config );
7264
7265         // Mixin constructors
7266         OO.ui.IconedElement.call( this, this.$( '<span>' ), config );
7267         OO.ui.IndicatedElement.call( this, this.$( '<span>' ), config );
7268         OO.ui.LabeledElement.call( this, this.$( '<span>' ), config );
7269         OO.ui.TitledElement.call( this, this.$label, config );
7270
7271         // Properties
7272         this.menu = new OO.ui.MenuWidget( $.extend( { '$': this.$ }, config.menu ) );
7273         this.$handle = this.$( '<span>' );
7274
7275         // Events
7276         this.$element.on( { 'click': OO.ui.bind( this.onClick, this ) } );
7277         this.menu.connect( this, { 'select': 'onMenuSelect' } );
7278
7279         // Initialization
7280         this.$handle
7281                 .addClass( 'oo-ui-inlineMenuWidget-handle' )
7282                 .append( this.$icon, this.$label, this.$indicator );
7283         this.$element
7284                 .addClass( 'oo-ui-inlineMenuWidget' )
7285                 .append( this.$handle, this.menu.$element );
7286 };
7287
7288 /* Setup */
7289
7290 OO.inheritClass( OO.ui.InlineMenuWidget, OO.ui.Widget );
7291 OO.mixinClass( OO.ui.InlineMenuWidget, OO.ui.IconedElement );
7292 OO.mixinClass( OO.ui.InlineMenuWidget, OO.ui.IndicatedElement );
7293 OO.mixinClass( OO.ui.InlineMenuWidget, OO.ui.LabeledElement );
7294 OO.mixinClass( OO.ui.InlineMenuWidget, OO.ui.TitledElement );
7295
7296 /* Methods */
7297
7298 /**
7299  * Get the menu.
7300  *
7301  * @return {OO.ui.MenuWidget} Menu of widget
7302  */
7303 OO.ui.InlineMenuWidget.prototype.getMenu = function () {
7304         return this.menu;
7305 };
7306
7307 /**
7308  * Handles menu select events.
7309  *
7310  * @param {OO.ui.MenuItemWidget} item Selected menu item
7311  */
7312 OO.ui.InlineMenuWidget.prototype.onMenuSelect = function ( item ) {
7313         var selectedLabel;
7314
7315         if ( !item ) {
7316                 return;
7317         }
7318
7319         selectedLabel = item.getLabel();
7320
7321         // If the label is a DOM element, clone it, because setLabel will append() it
7322         if ( selectedLabel instanceof jQuery ) {
7323                 selectedLabel = selectedLabel.clone();
7324         }
7325
7326         this.setLabel( selectedLabel );
7327 };
7328
7329 /**
7330  * Handles mouse click events.
7331  *
7332  * @param {jQuery.Event} e Mouse click event
7333  */
7334 OO.ui.InlineMenuWidget.prototype.onClick = function ( e ) {
7335         // Skip clicks within the menu
7336         if ( $.contains( this.menu.$element[0], e.target ) ) {
7337                 return;
7338         }
7339
7340         if ( !this.isDisabled() ) {
7341                 if ( this.menu.isVisible() ) {
7342                         this.menu.hide();
7343                 } else {
7344                         this.menu.show();
7345                 }
7346         }
7347         return false;
7348 };
7349 /**
7350  * Menu section item widget.
7351  *
7352  * Use with OO.ui.MenuWidget.
7353  *
7354  * @class
7355  * @extends OO.ui.OptionWidget
7356  *
7357  * @constructor
7358  * @param {Mixed} data Item data
7359  * @param {Object} [config] Configuration options
7360  */
7361 OO.ui.MenuSectionItemWidget = function OoUiMenuSectionItemWidget( data, config ) {
7362         // Parent constructor
7363         OO.ui.MenuSectionItemWidget.super.call( this, data, config );
7364
7365         // Initialization
7366         this.$element.addClass( 'oo-ui-menuSectionItemWidget' );
7367 };
7368
7369 /* Setup */
7370
7371 OO.inheritClass( OO.ui.MenuSectionItemWidget, OO.ui.OptionWidget );
7372
7373 /* Static Properties */
7374
7375 OO.ui.MenuSectionItemWidget.static.selectable = false;
7376
7377 OO.ui.MenuSectionItemWidget.static.highlightable = false;
7378 /**
7379  * Create an OO.ui.OutlineWidget object.
7380  *
7381  * Use with OO.ui.OutlineItemWidget.
7382  *
7383  * @class
7384  * @extends OO.ui.SelectWidget
7385  *
7386  * @constructor
7387  * @param {Object} [config] Configuration options
7388  */
7389 OO.ui.OutlineWidget = function OoUiOutlineWidget( config ) {
7390         // Config intialization
7391         config = config || {};
7392
7393         // Parent constructor
7394         OO.ui.OutlineWidget.super.call( this, config );
7395
7396         // Initialization
7397         this.$element.addClass( 'oo-ui-outlineWidget' );
7398 };
7399
7400 /* Setup */
7401
7402 OO.inheritClass( OO.ui.OutlineWidget, OO.ui.SelectWidget );
7403 /**
7404  * Creates an OO.ui.OutlineControlsWidget object.
7405  *
7406  * Use together with OO.ui.OutlineWidget.js
7407  *
7408  * @class
7409  *
7410  * @constructor
7411  * @param {OO.ui.OutlineWidget} outline Outline to control
7412  * @param {Object} [config] Configuration options
7413  */
7414 OO.ui.OutlineControlsWidget = function OoUiOutlineControlsWidget( outline, config ) {
7415         // Configuration initialization
7416         config = $.extend( { 'icon': 'add-item' }, config );
7417
7418         // Parent constructor
7419         OO.ui.OutlineControlsWidget.super.call( this, config );
7420
7421         // Mixin constructors
7422         OO.ui.GroupElement.call( this, this.$( '<div>' ), config );
7423         OO.ui.IconedElement.call( this, this.$( '<div>' ), config );
7424
7425         // Properties
7426         this.outline = outline;
7427         this.$movers = this.$( '<div>' );
7428         this.upButton = new OO.ui.ButtonWidget( {
7429                 '$': this.$,
7430                 'frameless': true,
7431                 'icon': 'collapse',
7432                 'title': OO.ui.msg( 'ooui-outline-control-move-up' )
7433         } );
7434         this.downButton = new OO.ui.ButtonWidget( {
7435                 '$': this.$,
7436                 'frameless': true,
7437                 'icon': 'expand',
7438                 'title': OO.ui.msg( 'ooui-outline-control-move-down' )
7439         } );
7440         this.removeButton = new OO.ui.ButtonWidget( {
7441                 '$': this.$,
7442                 'frameless': true,
7443                 'icon': 'remove',
7444                 'title': OO.ui.msg( 'ooui-outline-control-remove' )
7445         } );
7446
7447         // Events
7448         outline.connect( this, {
7449                 'select': 'onOutlineChange',
7450                 'add': 'onOutlineChange',
7451                 'remove': 'onOutlineChange'
7452         } );
7453         this.upButton.connect( this, { 'click': [ 'emit', 'move', -1 ] } );
7454         this.downButton.connect( this, { 'click': [ 'emit', 'move', 1 ] } );
7455         this.removeButton.connect( this, { 'click': [ 'emit', 'remove' ] } );
7456
7457         // Initialization
7458         this.$element.addClass( 'oo-ui-outlineControlsWidget' );
7459         this.$group.addClass( 'oo-ui-outlineControlsWidget-items' );
7460         this.$movers
7461                 .addClass( 'oo-ui-outlineControlsWidget-movers' )
7462                 .append( this.removeButton.$element, this.upButton.$element, this.downButton.$element );
7463         this.$element.append( this.$icon, this.$group, this.$movers );
7464 };
7465
7466 /* Setup */
7467
7468 OO.inheritClass( OO.ui.OutlineControlsWidget, OO.ui.Widget );
7469 OO.mixinClass( OO.ui.OutlineControlsWidget, OO.ui.GroupElement );
7470 OO.mixinClass( OO.ui.OutlineControlsWidget, OO.ui.IconedElement );
7471
7472 /* Events */
7473
7474 /**
7475  * @event move
7476  * @param {number} places Number of places to move
7477  */
7478
7479 /**
7480  * @event remove
7481  */
7482
7483 /* Methods */
7484
7485 /**
7486  * Handle outline change events.
7487  */
7488 OO.ui.OutlineControlsWidget.prototype.onOutlineChange = function () {
7489         var i, len, firstMovable, lastMovable,
7490                 items = this.outline.getItems(),
7491                 selectedItem = this.outline.getSelectedItem(),
7492                 movable = selectedItem && selectedItem.isMovable(),
7493                 removable = selectedItem && selectedItem.isRemovable();
7494
7495         if ( movable ) {
7496                 i = -1;
7497                 len = items.length;
7498                 while ( ++i < len ) {
7499                         if ( items[i].isMovable() ) {
7500                                 firstMovable = items[i];
7501                                 break;
7502                         }
7503                 }
7504                 i = len;
7505                 while ( i-- ) {
7506                         if ( items[i].isMovable() ) {
7507                                 lastMovable = items[i];
7508                                 break;
7509                         }
7510                 }
7511         }
7512         this.upButton.setDisabled( !movable || selectedItem === firstMovable );
7513         this.downButton.setDisabled( !movable || selectedItem === lastMovable );
7514         this.removeButton.setDisabled( !removable );
7515 };
7516 /**
7517  * Creates an OO.ui.OutlineItemWidget object.
7518  *
7519  * Use with OO.ui.OutlineWidget.
7520  *
7521  * @class
7522  * @extends OO.ui.OptionWidget
7523  *
7524  * @constructor
7525  * @param {Mixed} data Item data
7526  * @param {Object} [config] Configuration options
7527  * @cfg {number} [level] Indentation level
7528  * @cfg {boolean} [movable] Allow modification from outline controls
7529  */
7530 OO.ui.OutlineItemWidget = function OoUiOutlineItemWidget( data, config ) {
7531         // Config intialization
7532         config = config || {};
7533
7534         // Parent constructor
7535         OO.ui.OutlineItemWidget.super.call( this, data, config );
7536
7537         // Properties
7538         this.level = 0;
7539         this.movable = !!config.movable;
7540         this.removable = !!config.removable;
7541
7542         // Initialization
7543         this.$element.addClass( 'oo-ui-outlineItemWidget' );
7544         this.setLevel( config.level );
7545 };
7546
7547 /* Setup */
7548
7549 OO.inheritClass( OO.ui.OutlineItemWidget, OO.ui.OptionWidget );
7550
7551 /* Static Properties */
7552
7553 OO.ui.OutlineItemWidget.static.highlightable = false;
7554
7555 OO.ui.OutlineItemWidget.static.scrollIntoViewOnSelect = true;
7556
7557 OO.ui.OutlineItemWidget.static.levelClass = 'oo-ui-outlineItemWidget-level-';
7558
7559 OO.ui.OutlineItemWidget.static.levels = 3;
7560
7561 /* Methods */
7562
7563 /**
7564  * Check if item is movable.
7565  *
7566  * Movablilty is used by outline controls.
7567  *
7568  * @return {boolean} Item is movable
7569  */
7570 OO.ui.OutlineItemWidget.prototype.isMovable = function () {
7571         return this.movable;
7572 };
7573
7574 /**
7575  * Check if item is removable.
7576  *
7577  * Removablilty is used by outline controls.
7578  *
7579  * @return {boolean} Item is removable
7580  */
7581 OO.ui.OutlineItemWidget.prototype.isRemovable = function () {
7582         return this.removable;
7583 };
7584
7585 /**
7586  * Get indentation level.
7587  *
7588  * @return {number} Indentation level
7589  */
7590 OO.ui.OutlineItemWidget.prototype.getLevel = function () {
7591         return this.level;
7592 };
7593
7594 /**
7595  * Set movability.
7596  *
7597  * Movablilty is used by outline controls.
7598  *
7599  * @param {boolean} movable Item is movable
7600  * @chainable
7601  */
7602 OO.ui.OutlineItemWidget.prototype.setMovable = function ( movable ) {
7603         this.movable = !!movable;
7604         return this;
7605 };
7606
7607 /**
7608  * Set removability.
7609  *
7610  * Removablilty is used by outline controls.
7611  *
7612  * @param {boolean} movable Item is removable
7613  * @chainable
7614  */
7615 OO.ui.OutlineItemWidget.prototype.setRemovable = function ( removable ) {
7616         this.removable = !!removable;
7617         return this;
7618 };
7619
7620 /**
7621  * Set indentation level.
7622  *
7623  * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
7624  * @chainable
7625  */
7626 OO.ui.OutlineItemWidget.prototype.setLevel = function ( level ) {
7627         var levels = this.constructor.static.levels,
7628                 levelClass = this.constructor.static.levelClass,
7629                 i = levels;
7630
7631         this.level = level ? Math.max( 0, Math.min( levels - 1, level ) ) : 0;
7632         while ( i-- ) {
7633                 if ( this.level === i ) {
7634                         this.$element.addClass( levelClass + i );
7635                 } else {
7636                         this.$element.removeClass( levelClass + i );
7637                 }
7638         }
7639
7640         return this;
7641 };
7642 /**
7643  * Option widget that looks like a button.
7644  *
7645  * Use together with OO.ui.ButtonSelectWidget.
7646  *
7647  * @class
7648  * @extends OO.ui.OptionWidget
7649  * @mixins OO.ui.ButtonedElement
7650  * @mixins OO.ui.FlaggableElement
7651  *
7652  * @constructor
7653  * @param {Mixed} data Option data
7654  * @param {Object} [config] Configuration options
7655  */
7656 OO.ui.ButtonOptionWidget = function OoUiButtonOptionWidget( data, config ) {
7657         // Parent constructor
7658         OO.ui.ButtonOptionWidget.super.call( this, data, config );
7659
7660         // Mixin constructors
7661         OO.ui.ButtonedElement.call( this, this.$( '<a>' ), config );
7662         OO.ui.FlaggableElement.call( this, config );
7663
7664         // Initialization
7665         this.$element.addClass( 'oo-ui-buttonOptionWidget' );
7666         this.$button.append( this.$element.contents() );
7667         this.$element.append( this.$button );
7668 };
7669
7670 /* Setup */
7671
7672 OO.inheritClass( OO.ui.ButtonOptionWidget, OO.ui.OptionWidget );
7673 OO.mixinClass( OO.ui.ButtonOptionWidget, OO.ui.ButtonedElement );
7674 OO.mixinClass( OO.ui.ButtonOptionWidget, OO.ui.FlaggableElement );
7675
7676 /* Static Properties */
7677
7678 // Allow button mouse down events to pass through so they can be handled by the parent select widget
7679 OO.ui.ButtonOptionWidget.static.cancelButtonMouseDownEvents = false;
7680
7681 /* Methods */
7682
7683 /**
7684  * @inheritdoc
7685  */
7686 OO.ui.ButtonOptionWidget.prototype.setSelected = function ( state ) {
7687         OO.ui.ButtonOptionWidget.super.prototype.setSelected.call( this, state );
7688
7689         if ( this.constructor.static.selectable ) {
7690                 this.setActive( state );
7691         }
7692
7693         return this;
7694 };
7695 /**
7696  * Select widget containing button options.
7697  *
7698  * Use together with OO.ui.ButtonOptionWidget.
7699  *
7700  * @class
7701  * @extends OO.ui.SelectWidget
7702  *
7703  * @constructor
7704  * @param {Object} [config] Configuration options
7705  */
7706 OO.ui.ButtonSelectWidget = function OoUiButtonSelectWidget( config ) {
7707         // Parent constructor
7708         OO.ui.ButtonSelectWidget.super.call( this, config );
7709
7710         // Initialization
7711         this.$element.addClass( 'oo-ui-buttonSelectWidget' );
7712 };
7713
7714 /* Setup */
7715
7716 OO.inheritClass( OO.ui.ButtonSelectWidget, OO.ui.SelectWidget );
7717 /**
7718  * Container for content that is overlaid and positioned absolutely.
7719  *
7720  * @class
7721  * @extends OO.ui.Widget
7722  * @mixins OO.ui.LabeledElement
7723  *
7724  * @constructor
7725  * @param {Object} [config] Configuration options
7726  * @cfg {boolean} [tail=true] Show tail pointing to origin of popup
7727  * @cfg {string} [align='center'] Alignment of popup to origin
7728  * @cfg {jQuery} [$container] Container to prevent popup from rendering outside of
7729  * @cfg {boolean} [autoClose=false] Popup auto-closes when it loses focus
7730  * @cfg {jQuery} [$autoCloseIgnore] Elements to not auto close when clicked
7731  * @cfg {boolean} [head] Show label and close button at the top
7732  */
7733 OO.ui.PopupWidget = function OoUiPopupWidget( config ) {
7734         // Config intialization
7735         config = config || {};
7736
7737         // Parent constructor
7738         OO.ui.PopupWidget.super.call( this, config );
7739
7740         // Mixin constructors
7741         OO.ui.LabeledElement.call( this, this.$( '<div>' ), config );
7742         OO.ui.ClippableElement.call( this, this.$( '<div>' ), config );
7743
7744         // Properties
7745         this.visible = false;
7746         this.$popup = this.$( '<div>' );
7747         this.$head = this.$( '<div>' );
7748         this.$body = this.$clippable;
7749         this.$tail = this.$( '<div>' );
7750         this.$container = config.$container || this.$( 'body' );
7751         this.autoClose = !!config.autoClose;
7752         this.$autoCloseIgnore = config.$autoCloseIgnore;
7753         this.transitionTimeout = null;
7754         this.tail = false;
7755         this.align = config.align || 'center';
7756         this.closeButton = new OO.ui.ButtonWidget( { '$': this.$, 'frameless': true, 'icon': 'close' } );
7757         this.onMouseDownHandler = OO.ui.bind( this.onMouseDown, this );
7758
7759         // Events
7760         this.closeButton.connect( this, { 'click': 'onCloseButtonClick' } );
7761
7762         // Initialization
7763         this.useTail( config.tail !== undefined ? !!config.tail : true );
7764         this.$body.addClass( 'oo-ui-popupWidget-body' );
7765         this.$tail.addClass( 'oo-ui-popupWidget-tail' );
7766         this.$head
7767                 .addClass( 'oo-ui-popupWidget-head' )
7768                 .append( this.$label, this.closeButton.$element );
7769         if ( !config.head ) {
7770                 this.$head.hide();
7771         }
7772         this.$popup
7773                 .addClass( 'oo-ui-popupWidget-popup' )
7774                 .append( this.$head, this.$body );
7775         this.$element.hide()
7776                 .addClass( 'oo-ui-popupWidget' )
7777                 .append( this.$popup, this.$tail );
7778 };
7779
7780 /* Setup */
7781
7782 OO.inheritClass( OO.ui.PopupWidget, OO.ui.Widget );
7783 OO.mixinClass( OO.ui.PopupWidget, OO.ui.LabeledElement );
7784 OO.mixinClass( OO.ui.PopupWidget, OO.ui.ClippableElement );
7785
7786 /* Events */
7787
7788 /**
7789  * @event hide
7790  */
7791
7792 /**
7793  * @event show
7794  */
7795
7796 /* Methods */
7797
7798 /**
7799  * Handles mouse down events.
7800  *
7801  * @param {jQuery.Event} e Mouse down event
7802  */
7803 OO.ui.PopupWidget.prototype.onMouseDown = function ( e ) {
7804         if (
7805                 this.visible &&
7806                 !$.contains( this.$element[0], e.target ) &&
7807                 ( !this.$autoCloseIgnore || !this.$autoCloseIgnore.has( e.target ).length )
7808         ) {
7809                 this.hide();
7810         }
7811 };
7812
7813 /**
7814  * Bind mouse down listener.
7815  */
7816 OO.ui.PopupWidget.prototype.bindMouseDownListener = function () {
7817         // Capture clicks outside popup
7818         this.getElementWindow().addEventListener( 'mousedown', this.onMouseDownHandler, true );
7819 };
7820
7821 /**
7822  * Handles close button click events.
7823  */
7824 OO.ui.PopupWidget.prototype.onCloseButtonClick = function () {
7825         if ( this.visible ) {
7826                 this.hide();
7827         }
7828 };
7829
7830 /**
7831  * Unbind mouse down listener.
7832  */
7833 OO.ui.PopupWidget.prototype.unbindMouseDownListener = function () {
7834         this.getElementWindow().removeEventListener( 'mousedown', this.onMouseDownHandler, true );
7835 };
7836
7837 /**
7838  * Check if the popup is visible.
7839  *
7840  * @return {boolean} Popup is visible
7841  */
7842 OO.ui.PopupWidget.prototype.isVisible = function () {
7843         return this.visible;
7844 };
7845
7846 /**
7847  * Set whether to show a tail.
7848  *
7849  * @return {boolean} Make tail visible
7850  */
7851 OO.ui.PopupWidget.prototype.useTail = function ( value ) {
7852         value = !!value;
7853         if ( this.tail !== value ) {
7854                 this.tail = value;
7855                 if ( value ) {
7856                         this.$element.addClass( 'oo-ui-popupWidget-tailed' );
7857                 } else {
7858                         this.$element.removeClass( 'oo-ui-popupWidget-tailed' );
7859                 }
7860         }
7861 };
7862
7863 /**
7864  * Check if showing a tail.
7865  *
7866  * @return {boolean} tail is visible
7867  */
7868 OO.ui.PopupWidget.prototype.hasTail = function () {
7869         return this.tail;
7870 };
7871
7872 /**
7873  * Show the context.
7874  *
7875  * @fires show
7876  * @chainable
7877  */
7878 OO.ui.PopupWidget.prototype.show = function () {
7879         if ( !this.visible ) {
7880                 this.setClipping( true );
7881                 this.$element.show();
7882                 this.visible = true;
7883                 this.emit( 'show' );
7884                 if ( this.autoClose ) {
7885                         this.bindMouseDownListener();
7886                 }
7887         }
7888         return this;
7889 };
7890
7891 /**
7892  * Hide the context.
7893  *
7894  * @fires hide
7895  * @chainable
7896  */
7897 OO.ui.PopupWidget.prototype.hide = function () {
7898         if ( this.visible ) {
7899                 this.setClipping( false );
7900                 this.$element.hide();
7901                 this.visible = false;
7902                 this.emit( 'hide' );
7903                 if ( this.autoClose ) {
7904                         this.unbindMouseDownListener();
7905                 }
7906         }
7907         return this;
7908 };
7909
7910 /**
7911  * Updates the position and size.
7912  *
7913  * @param {number} width Width
7914  * @param {number} height Height
7915  * @param {boolean} [transition=false] Use a smooth transition
7916  * @chainable
7917  */
7918 OO.ui.PopupWidget.prototype.display = function ( width, height, transition ) {
7919         var padding = 10,
7920                 originOffset = Math.round( this.$element.offset().left ),
7921                 containerLeft = Math.round( this.$container.offset().left ),
7922                 containerWidth = this.$container.innerWidth(),
7923                 containerRight = containerLeft + containerWidth,
7924                 popupOffset = width * ( { 'left': 0, 'center': -0.5, 'right': -1 } )[this.align],
7925                 popupLeft = popupOffset - padding,
7926                 popupRight = popupOffset + padding + width + padding,
7927                 overlapLeft = ( originOffset + popupLeft ) - containerLeft,
7928                 overlapRight = containerRight - ( originOffset + popupRight );
7929
7930         // Prevent transition from being interrupted
7931         clearTimeout( this.transitionTimeout );
7932         if ( transition ) {
7933                 // Enable transition
7934                 this.$element.addClass( 'oo-ui-popupWidget-transitioning' );
7935         }
7936
7937         if ( overlapRight < 0 ) {
7938                 popupOffset += overlapRight;
7939         } else if ( overlapLeft < 0 ) {
7940                 popupOffset -= overlapLeft;
7941         }
7942
7943         // Position body relative to anchor and resize
7944         this.$popup.css( {
7945                 'left': popupOffset,
7946                 'width': width,
7947                 'height': height === undefined ? 'auto' : height
7948         } );
7949
7950         if ( transition ) {
7951                 // Prevent transitioning after transition is complete
7952                 this.transitionTimeout = setTimeout( OO.ui.bind( function () {
7953                         this.$element.removeClass( 'oo-ui-popupWidget-transitioning' );
7954                 }, this ), 200 );
7955         } else {
7956                 // Prevent transitioning immediately
7957                 this.$element.removeClass( 'oo-ui-popupWidget-transitioning' );
7958         }
7959
7960         return this;
7961 };
7962 /**
7963  * Button that shows and hides a popup.
7964  *
7965  * @class
7966  * @extends OO.ui.ButtonWidget
7967  * @mixins OO.ui.PopuppableElement
7968  *
7969  * @constructor
7970  * @param {Object} [config] Configuration options
7971  */
7972 OO.ui.PopupButtonWidget = function OoUiPopupButtonWidget( config ) {
7973         // Parent constructor
7974         OO.ui.PopupButtonWidget.super.call( this, config );
7975
7976         // Mixin constructors
7977         OO.ui.PopuppableElement.call( this, config );
7978
7979         // Initialization
7980         this.$element
7981                 .addClass( 'oo-ui-popupButtonWidget' )
7982                 .append( this.popup.$element );
7983 };
7984
7985 /* Setup */
7986
7987 OO.inheritClass( OO.ui.PopupButtonWidget, OO.ui.ButtonWidget );
7988 OO.mixinClass( OO.ui.PopupButtonWidget, OO.ui.PopuppableElement );
7989
7990 /* Methods */
7991
7992 /**
7993  * Handles mouse click events.
7994  *
7995  * @param {jQuery.Event} e Mouse click event
7996  */
7997 OO.ui.PopupButtonWidget.prototype.onClick = function ( e ) {
7998         // Skip clicks within the popup
7999         if ( $.contains( this.popup.$element[0], e.target ) ) {
8000                 return;
8001         }
8002
8003         if ( !this.isDisabled() ) {
8004                 if ( this.popup.isVisible() ) {
8005                         this.hidePopup();
8006                 } else {
8007                         this.showPopup();
8008                 }
8009                 OO.ui.PopupButtonWidget.super.prototype.onClick.call( this );
8010         }
8011         return false;
8012 };
8013 /**
8014  * Search widget.
8015  *
8016  * Combines query and results selection widgets.
8017  *
8018  * @class
8019  * @extends OO.ui.Widget
8020  *
8021  * @constructor
8022  * @param {Object} [config] Configuration options
8023  * @cfg {string|jQuery} [placeholder] Placeholder text for query input
8024  * @cfg {string} [value] Initial query value
8025  */
8026 OO.ui.SearchWidget = function OoUiSearchWidget( config ) {
8027         // Configuration intialization
8028         config = config || {};
8029
8030         // Parent constructor
8031         OO.ui.SearchWidget.super.call( this, config );
8032
8033         // Properties
8034         this.query = new OO.ui.TextInputWidget( {
8035                 '$': this.$,
8036                 'icon': 'search',
8037                 'placeholder': config.placeholder,
8038                 'value': config.value
8039         } );
8040         this.results = new OO.ui.SelectWidget( { '$': this.$ } );
8041         this.$query = this.$( '<div>' );
8042         this.$results = this.$( '<div>' );
8043
8044         // Events
8045         this.query.connect( this, {
8046                 'change': 'onQueryChange',
8047                 'enter': 'onQueryEnter'
8048         } );
8049         this.results.connect( this, {
8050                 'highlight': 'onResultsHighlight',
8051                 'select': 'onResultsSelect'
8052         } );
8053         this.query.$input.on( 'keydown', OO.ui.bind( this.onQueryKeydown, this ) );
8054
8055         // Initialization
8056         this.$query
8057                 .addClass( 'oo-ui-searchWidget-query' )
8058                 .append( this.query.$element );
8059         this.$results
8060                 .addClass( 'oo-ui-searchWidget-results' )
8061                 .append( this.results.$element );
8062         this.$element
8063                 .addClass( 'oo-ui-searchWidget' )
8064                 .append( this.$results, this.$query );
8065 };
8066
8067 /* Setup */
8068
8069 OO.inheritClass( OO.ui.SearchWidget, OO.ui.Widget );
8070
8071 /* Events */
8072
8073 /**
8074  * @event highlight
8075  * @param {Object|null} item Item data or null if no item is highlighted
8076  */
8077
8078 /**
8079  * @event select
8080  * @param {Object|null} item Item data or null if no item is selected
8081  */
8082
8083 /* Methods */
8084
8085 /**
8086  * Handle query key down events.
8087  *
8088  * @param {jQuery.Event} e Key down event
8089  */
8090 OO.ui.SearchWidget.prototype.onQueryKeydown = function ( e ) {
8091         var highlightedItem, nextItem,
8092                 dir = e.which === OO.ui.Keys.DOWN ? 1 : ( e.which === OO.ui.Keys.UP ? -1 : 0 );
8093
8094         if ( dir ) {
8095                 highlightedItem = this.results.getHighlightedItem();
8096                 if ( !highlightedItem ) {
8097                         highlightedItem = this.results.getSelectedItem();
8098                 }
8099                 nextItem = this.results.getRelativeSelectableItem( highlightedItem, dir );
8100                 this.results.highlightItem( nextItem );
8101                 nextItem.scrollElementIntoView();
8102         }
8103 };
8104
8105 /**
8106  * Handle select widget select events.
8107  *
8108  * Clears existing results. Subclasses should repopulate items according to new query.
8109  *
8110  * @param {string} value New value
8111  */
8112 OO.ui.SearchWidget.prototype.onQueryChange = function () {
8113         // Reset
8114         this.results.clearItems();
8115 };
8116
8117 /**
8118  * Handle select widget enter key events.
8119  *
8120  * Selects highlighted item.
8121  *
8122  * @param {string} value New value
8123  */
8124 OO.ui.SearchWidget.prototype.onQueryEnter = function () {
8125         // Reset
8126         this.results.selectItem( this.results.getHighlightedItem() );
8127 };
8128
8129 /**
8130  * Handle select widget highlight events.
8131  *
8132  * @param {OO.ui.OptionWidget} item Highlighted item
8133  * @fires highlight
8134  */
8135 OO.ui.SearchWidget.prototype.onResultsHighlight = function ( item ) {
8136         this.emit( 'highlight', item ? item.getData() : null );
8137 };
8138
8139 /**
8140  * Handle select widget select events.
8141  *
8142  * @param {OO.ui.OptionWidget} item Selected item
8143  * @fires select
8144  */
8145 OO.ui.SearchWidget.prototype.onResultsSelect = function ( item ) {
8146         this.emit( 'select', item ? item.getData() : null );
8147 };
8148
8149 /**
8150  * Get the query input.
8151  *
8152  * @return {OO.ui.TextInputWidget} Query input
8153  */
8154 OO.ui.SearchWidget.prototype.getQuery = function () {
8155         return this.query;
8156 };
8157
8158 /**
8159  * Get the results list.
8160  *
8161  * @return {OO.ui.SelectWidget} Select list
8162  */
8163 OO.ui.SearchWidget.prototype.getResults = function () {
8164         return this.results;
8165 };
8166 /**
8167  * Text input widget.
8168  *
8169  * @class
8170  * @extends OO.ui.InputWidget
8171  *
8172  * @constructor
8173  * @param {Object} [config] Configuration options
8174  * @cfg {string} [placeholder] Placeholder text
8175  * @cfg {string} [icon] Symbolic name of icon
8176  * @cfg {boolean} [multiline=false] Allow multiple lines of text
8177  * @cfg {boolean} [autosize=false] Automatically resize to fit content
8178  * @cfg {boolean} [maxRows=10] Maximum number of rows to make visible when autosizing
8179  */
8180 OO.ui.TextInputWidget = function OoUiTextInputWidget( config ) {
8181         config = $.extend( { 'maxRows': 10 }, config );
8182
8183         // Parent constructor
8184         OO.ui.TextInputWidget.super.call( this, config );
8185
8186         // Properties
8187         this.pending = 0;
8188         this.multiline = !!config.multiline;
8189         this.autosize = !!config.autosize;
8190         this.maxRows = config.maxRows;
8191
8192         // Events
8193         this.$input.on( 'keypress', OO.ui.bind( this.onKeyPress, this ) );
8194         this.$element.on( 'DOMNodeInsertedIntoDocument', OO.ui.bind( this.onElementAttach, this ) );
8195
8196         // Initialization
8197         this.$element.addClass( 'oo-ui-textInputWidget' );
8198         if ( config.icon ) {
8199                 this.$element.addClass( 'oo-ui-textInputWidget-decorated' );
8200                 this.$element.append(
8201                         this.$( '<span>' )
8202                                 .addClass( 'oo-ui-textInputWidget-icon oo-ui-icon-' + config.icon )
8203                                 .mousedown( OO.ui.bind( function () {
8204                                         this.$input.focus();
8205                                         return false;
8206                                 }, this ) )
8207                 );
8208         }
8209         if ( config.placeholder ) {
8210                 this.$input.attr( 'placeholder', config.placeholder );
8211         }
8212 };
8213
8214 /* Setup */
8215
8216 OO.inheritClass( OO.ui.TextInputWidget, OO.ui.InputWidget );
8217
8218 /* Events */
8219
8220 /**
8221  * User presses enter inside the text box.
8222  *
8223  * Not called if input is multiline.
8224  *
8225  * @event enter
8226  */
8227
8228 /* Methods */
8229
8230 /**
8231  * Handle key press events.
8232  *
8233  * @param {jQuery.Event} e Key press event
8234  * @fires enter If enter key is pressed and input is not multiline
8235  */
8236 OO.ui.TextInputWidget.prototype.onKeyPress = function ( e ) {
8237         if ( e.which === OO.ui.Keys.ENTER && !this.multiline ) {
8238                 this.emit( 'enter' );
8239         }
8240 };
8241
8242 /**
8243  * Handle element attach events.
8244  *
8245  * @param {jQuery.Event} e Element attach event
8246  */
8247 OO.ui.TextInputWidget.prototype.onElementAttach = function () {
8248         this.adjustSize();
8249 };
8250
8251 /**
8252  * @inheritdoc
8253  */
8254 OO.ui.TextInputWidget.prototype.onEdit = function () {
8255         this.adjustSize();
8256
8257         // Parent method
8258         return OO.ui.TextInputWidget.super.prototype.onEdit.call( this );
8259 };
8260
8261 /**
8262  * Automatically adjust the size of the text input.
8263  *
8264  * This only affects multi-line inputs that are auto-sized.
8265  *
8266  * @chainable
8267  */
8268 OO.ui.TextInputWidget.prototype.adjustSize = function () {
8269         var $clone, scrollHeight, innerHeight, outerHeight, maxInnerHeight, idealHeight;
8270
8271         if ( this.multiline && this.autosize ) {
8272                 $clone = this.$input.clone()
8273                         .val( this.$input.val() )
8274                         .css( { 'height': 0 } )
8275                         .insertAfter( this.$input );
8276                 // Set inline height property to 0 to measure scroll height
8277                 scrollHeight = $clone[0].scrollHeight;
8278                 // Remove inline height property to measure natural heights
8279                 $clone.css( 'height', '' );
8280                 innerHeight = $clone.innerHeight();
8281                 outerHeight = $clone.outerHeight();
8282                 // Measure max rows height
8283                 $clone.attr( 'rows', this.maxRows ).css( 'height', 'auto' );
8284                 maxInnerHeight = $clone.innerHeight();
8285                 $clone.removeAttr( 'rows' ).css( 'height', '' );
8286                 $clone.remove();
8287                 idealHeight = Math.min( maxInnerHeight, scrollHeight );
8288                 // Only apply inline height when expansion beyond natural height is needed
8289                 this.$input.css(
8290                         'height',
8291                         // Use the difference between the inner and outer height as a buffer
8292                         idealHeight > outerHeight ? idealHeight + ( outerHeight - innerHeight ) : ''
8293                 );
8294         }
8295         return this;
8296 };
8297
8298 /**
8299  * Get input element.
8300  *
8301  * @param {Object} [config] Configuration options
8302  * @return {jQuery} Input element
8303  */
8304 OO.ui.TextInputWidget.prototype.getInputElement = function ( config ) {
8305         return config.multiline ? this.$( '<textarea>' ) : this.$( '<input type="text" />' );
8306 };
8307
8308 /* Methods */
8309
8310 /**
8311  * Check if input supports multiple lines.
8312  *
8313  * @return {boolean}
8314  */
8315 OO.ui.TextInputWidget.prototype.isMultiline = function () {
8316         return !!this.multiline;
8317 };
8318
8319 /**
8320  * Check if input automatically adjusts its size.
8321  *
8322  * @return {boolean}
8323  */
8324 OO.ui.TextInputWidget.prototype.isAutosizing = function () {
8325         return !!this.autosize;
8326 };
8327
8328 /**
8329  * Check if input is pending.
8330  *
8331  * @return {boolean}
8332  */
8333 OO.ui.TextInputWidget.prototype.isPending = function () {
8334         return !!this.pending;
8335 };
8336
8337 /**
8338  * Increase the pending stack.
8339  *
8340  * @chainable
8341  */
8342 OO.ui.TextInputWidget.prototype.pushPending = function () {
8343         if ( this.pending === 0 ) {
8344                 this.$element.addClass( 'oo-ui-textInputWidget-pending' );
8345                 this.$input.addClass( 'oo-ui-texture-pending' );
8346         }
8347         this.pending++;
8348
8349         return this;
8350 };
8351
8352 /**
8353  * Reduce the pending stack.
8354  *
8355  * Clamped at zero.
8356  *
8357  * @chainable
8358  */
8359 OO.ui.TextInputWidget.prototype.popPending = function () {
8360         if ( this.pending === 1 ) {
8361                 this.$element.removeClass( 'oo-ui-textInputWidget-pending' );
8362                 this.$input.removeClass( 'oo-ui-texture-pending' );
8363         }
8364         this.pending = Math.max( 0, this.pending - 1 );
8365
8366         return this;
8367 };
8368
8369 /**
8370  * Select the contents of the input.
8371  *
8372  * @chainable
8373  */
8374 OO.ui.TextInputWidget.prototype.select = function () {
8375         this.$input.select();
8376         return this;
8377 };
8378 /**
8379  * Menu for a text input widget.
8380  *
8381  * @class
8382  * @extends OO.ui.MenuWidget
8383  *
8384  * @constructor
8385  * @param {OO.ui.TextInputWidget} input Text input widget to provide menu for
8386  * @param {Object} [config] Configuration options
8387  * @cfg {jQuery} [$container=input.$element] Element to render menu under
8388  */
8389 OO.ui.TextInputMenuWidget = function OoUiTextInputMenuWidget( input, config ) {
8390         // Parent constructor
8391         OO.ui.TextInputMenuWidget.super.call( this, config );
8392
8393         // Properties
8394         this.input = input;
8395         this.$container = config.$container || this.input.$element;
8396         this.onWindowResizeHandler = OO.ui.bind( this.onWindowResize, this );
8397
8398         // Initialization
8399         this.$element.addClass( 'oo-ui-textInputMenuWidget' );
8400 };
8401
8402 /* Setup */
8403
8404 OO.inheritClass( OO.ui.TextInputMenuWidget, OO.ui.MenuWidget );
8405
8406 /* Methods */
8407
8408 /**
8409  * Handle window resize event.
8410  *
8411  * @param {jQuery.Event} e Window resize event
8412  */
8413 OO.ui.TextInputMenuWidget.prototype.onWindowResize = function () {
8414         this.position();
8415 };
8416
8417 /**
8418  * Show the menu.
8419  *
8420  * @chainable
8421  */
8422 OO.ui.TextInputMenuWidget.prototype.show = function () {
8423         // Parent method
8424         OO.ui.TextInputMenuWidget.super.prototype.show.call( this );
8425
8426         this.position();
8427         this.$( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler );
8428         return this;
8429 };
8430
8431 /**
8432  * Hide the menu.
8433  *
8434  * @chainable
8435  */
8436 OO.ui.TextInputMenuWidget.prototype.hide = function () {
8437         // Parent method
8438         OO.ui.TextInputMenuWidget.super.prototype.hide.call( this );
8439
8440         this.$( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler );
8441         return this;
8442 };
8443
8444 /**
8445  * Position the menu.
8446  *
8447  * @chainable
8448  */
8449 OO.ui.TextInputMenuWidget.prototype.position = function () {
8450         var frameOffset,
8451                 $container = this.$container,
8452                 dimensions = $container.offset();
8453
8454         // Position under input
8455         dimensions.top += $container.height();
8456
8457         // Compensate for frame position if in a differnt frame
8458         if ( this.input.$.frame && this.input.$.context !== this.$element[0].ownerDocument ) {
8459                 frameOffset = OO.ui.Element.getRelativePosition(
8460                         this.input.$.frame.$element, this.$element.offsetParent()
8461                 );
8462                 dimensions.left += frameOffset.left;
8463                 dimensions.top += frameOffset.top;
8464         } else {
8465                 // Fix for RTL (for some reason, no need to fix if the frameoffset is set)
8466                 if ( this.$element.css( 'direction' ) === 'rtl' ) {
8467                         dimensions.right = this.$element.parent().position().left -
8468                                 $container.width() - dimensions.left;
8469                         // Erase the value for 'left':
8470                         delete dimensions.left;
8471                 }
8472         }
8473
8474         this.$element.css( dimensions );
8475         this.setIdealSize( $container.width() );
8476         return this;
8477 };
8478 /**
8479  * Width with on and off states.
8480  *
8481  * Mixin for widgets with a boolean state.
8482  *
8483  * @abstract
8484  * @class
8485  *
8486  * @constructor
8487  * @param {Object} [config] Configuration options
8488  * @cfg {boolean} [value=false] Initial value
8489  */
8490 OO.ui.ToggleWidget = function OoUiToggleWidget( config ) {
8491         // Configuration initialization
8492         config = config || {};
8493
8494         // Properties
8495         this.value = null;
8496
8497         // Initialization
8498         this.$element.addClass( 'oo-ui-toggleWidget' );
8499         this.setValue( !!config.value );
8500 };
8501
8502 /* Events */
8503
8504 /**
8505  * @event change
8506  * @param {boolean} value Changed value
8507  */
8508
8509 /* Methods */
8510
8511 /**
8512  * Get the value of the toggle.
8513  *
8514  * @return {boolean}
8515  */
8516 OO.ui.ToggleWidget.prototype.getValue = function () {
8517         return this.value;
8518 };
8519
8520 /**
8521  * Set the value of the toggle.
8522  *
8523  * @param {boolean} value New value
8524  * @fires change
8525  * @chainable
8526  */
8527 OO.ui.ToggleWidget.prototype.setValue = function ( value ) {
8528         value = !!value;
8529         if ( this.value !== value ) {
8530                 this.value = value;
8531                 this.emit( 'change', value );
8532                 this.$element.toggleClass( 'oo-ui-toggleWidget-on', value );
8533                 this.$element.toggleClass( 'oo-ui-toggleWidget-off', !value );
8534         }
8535         return this;
8536 };
8537 /**
8538  * Button that toggles on and off.
8539  *
8540  * @class
8541  * @extends OO.ui.ButtonWidget
8542  * @mixins OO.ui.ToggleWidget
8543  *
8544  * @constructor
8545  * @param {Object} [config] Configuration options
8546  * @cfg {boolean} [value=false] Initial value
8547  */
8548 OO.ui.ToggleButtonWidget = function OoUiToggleButtonWidget( config ) {
8549         // Configuration initialization
8550         config = config || {};
8551
8552         // Parent constructor
8553         OO.ui.ToggleButtonWidget.super.call( this, config );
8554
8555         // Mixin constructors
8556         OO.ui.ToggleWidget.call( this, config );
8557
8558         // Initialization
8559         this.$element.addClass( 'oo-ui-toggleButtonWidget' );
8560 };
8561
8562 /* Setup */
8563
8564 OO.inheritClass( OO.ui.ToggleButtonWidget, OO.ui.ButtonWidget );
8565 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.ToggleWidget );
8566
8567 /* Methods */
8568
8569 /**
8570  * @inheritdoc
8571  */
8572 OO.ui.ToggleButtonWidget.prototype.onClick = function () {
8573         if ( !this.isDisabled() ) {
8574                 this.setValue( !this.value );
8575         }
8576
8577         // Parent method
8578         return OO.ui.ToggleButtonWidget.super.prototype.onClick.call( this );
8579 };
8580
8581 /**
8582  * @inheritdoc
8583  */
8584 OO.ui.ToggleButtonWidget.prototype.setValue = function ( value ) {
8585         value = !!value;
8586         if ( value !== this.value ) {
8587                 this.setActive( value );
8588         }
8589
8590         // Parent method (from mixin)
8591         OO.ui.ToggleWidget.prototype.setValue.call( this, value );
8592
8593         return this;
8594 };
8595 /**
8596  * Switch that slides on and off.
8597  *
8598  * @class
8599  * @extends OO.ui.Widget
8600  * @mixins OO.ui.ToggleWidget
8601  *
8602  * @constructor
8603  * @param {Object} [config] Configuration options
8604  * @cfg {boolean} [value=false] Initial value
8605  */
8606 OO.ui.ToggleSwitchWidget = function OoUiToggleSwitchWidget( config ) {
8607         // Parent constructor
8608         OO.ui.ToggleSwitchWidget.super.call( this, config );
8609
8610         // Mixin constructors
8611         OO.ui.ToggleWidget.call( this, config );
8612
8613         // Properties
8614         this.dragging = false;
8615         this.dragStart = null;
8616         this.sliding = false;
8617         this.$glow = this.$( '<span>' );
8618         this.$grip = this.$( '<span>' );
8619
8620         // Events
8621         this.$element.on( 'click', OO.ui.bind( this.onClick, this ) );
8622
8623         // Initialization
8624         this.$glow.addClass( 'oo-ui-toggleSwitchWidget-glow' );
8625         this.$grip.addClass( 'oo-ui-toggleSwitchWidget-grip' );
8626         this.$element
8627                 .addClass( 'oo-ui-toggleSwitchWidget' )
8628                 .append( this.$glow, this.$grip );
8629 };
8630
8631 /* Setup */
8632
8633 OO.inheritClass( OO.ui.ToggleSwitchWidget, OO.ui.Widget );
8634 OO.mixinClass( OO.ui.ToggleSwitchWidget, OO.ui.ToggleWidget );
8635
8636 /* Methods */
8637
8638 /**
8639  * Handle mouse down events.
8640  *
8641  * @param {jQuery.Event} e Mouse down event
8642  */
8643 OO.ui.ToggleSwitchWidget.prototype.onClick = function ( e ) {
8644         if ( !this.isDisabled() && e.which === 1 ) {
8645                 this.setValue( !this.value );
8646         }
8647 };
8648 }( OO ) );