2 * OOjs UI v0.1.0-pre (99068355d6)
3 * https://www.mediawiki.org/wiki/OOjs_UI
5 * Copyright 2011–2014 OOjs Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
9 * Date: Tue Jun 10 2014 11:03:38 GMT-0700 (PDT)
15 * Namespace for all classes, static methods and static properties.
47 * Get the user's language and any fallback languages.
49 * These language codes are used to localize user interface elements in the user's language.
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.
54 * @return {string[]} Language codes, in descending order of priority
56 OO
.ui
.getUserLanguages = function () {
61 * Get a value in an object keyed by language code.
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
68 OO
.ui
.getLocalValue = function ( obj
, lang
, fallback
) {
75 // Known user language
76 langs
= OO
.ui
.getUserLanguages();
77 for ( i
= 0, len
= langs
.length
; i
< len
; i
++ ) {
84 if ( obj
[fallback
] ) {
87 // First existing language
98 * Message store for the default implementation of OO.ui.msg
100 * Environments that provide a localization system should not use this, but should override
101 * OO.ui.msg altogether.
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',
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'
128 * Get a localized message.
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
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.
140 * @param {string} key Message key
141 * @param {Mixed...} [params] Message parameters
142 * @return {string} Translated message with parameters substituted
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
;
153 // Return placeholder if message not found
154 message
= '[' + key
+ ']';
160 OO
.ui
.deferMsg = function ( key
) {
162 return OO
.ui
.msg( key
);
167 OO
.ui
.resolveMsg = function ( msg
) {
168 if ( $.isFunction( msg
) ) {
176 * DOM element abstraction.
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)
188 OO
.ui
.Element
= function OoUiElement( config
) {
189 // Configuration initialization
190 config
= config
|| {};
193 this.$ = config
.$ || OO
.ui
.Element
.getJQuery( document
);
194 this.$element
= this.$( this.$.context
.createElement( this.getTagName() ) );
195 this.elementGroup
= null;
198 if ( $.isArray( config
.classes
) ) {
199 this.$element
.addClass( config
.classes
.join( ' ' ) );
202 this.$element
.text( config
.text
);
204 if ( config
.$content
) {
205 this.$element
.append( config
.$content
);
211 OO
.initClass( OO
.ui
.Element
);
213 /* Static Properties */
218 * This may be ignored if getTagName is overridden.
224 OO
.ui
.Element
.static.tagName
= 'div';
229 * Get a jQuery function within a specific document.
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
236 OO
.ui
.Element
.getJQuery = function ( context
, frame
) {
237 function wrapper( selector
) {
238 return $( selector
, wrapper
.context
);
241 wrapper
.context
= this.getDocument( context
);
244 wrapper
.frame
= frame
;
251 * Get the document of an element.
254 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Object to get the document for
255 * @return {HTMLDocument|null} Document object
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
267 ( obj
.nodeType
=== 9 && obj
) ||
272 * Get the window of an element or document.
275 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the window for
276 * @return {Window} Window object
278 OO
.ui
.Element
.getWindow = function ( obj
) {
279 var doc
= this.getDocument( obj
);
280 return doc
.parentWindow
|| doc
.defaultView
;
284 * Get the direction of an element or document.
287 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the direction for
288 * @return {string} Text direction, either `ltr` or `rtl`
290 OO
.ui
.Element
.getDir = function ( obj
) {
293 if ( obj
instanceof jQuery
) {
296 isDoc
= obj
.nodeType
=== 9;
297 isWin
= obj
.document
!== undefined;
298 if ( isDoc
|| isWin
) {
304 return $( obj
).css( 'direction' );
308 * Get the offset between two frames.
310 * TODO: Make this function not use recursion.
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
318 OO
.ui
.Element
.getFrameOffset = function ( from, to
, offset
) {
319 var i
, len
, frames
, frame
, rect
;
325 offset
= { 'top': 0, 'left': 0 };
327 if ( from.parent
=== from ) {
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 ) {
340 // Recursively accumulate offset values
342 rect
= frame
.getBoundingClientRect();
343 offset
.left
+= rect
.left
;
344 offset
.top
+= rect
.top
;
346 this.getFrameOffset( from.parent
, offset
);
353 * Get the offset between two elements.
356 * @param {jQuery} $from
357 * @param {jQuery} $to
358 * @return {Object} Translated position coordinates, containing top and left properties
360 OO
.ui
.Element
.getRelativePosition = function ( $from, $to
) {
361 var from = $from.offset(),
363 return { 'top': Math
.round( from.top
- to
.top
), 'left': Math
.round( from.left
- to
.left
) };
367 * Get element border sizes.
370 * @param {HTMLElement} el Element to measure
371 * @return {Object} Dimensions object with `top`, `left`, `bottom` and `right` properties
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 ) :
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;
386 'top': Math
.round( top
),
387 'left': Math
.round( left
),
388 'bottom': Math
.round( bottom
),
389 'right': Math
.round( right
)
394 * Get dimensions of an element or window.
397 * @param {HTMLElement|Window} el Element to measure
398 * @return {Object} Dimensions object with `borders`, `scroll`, `scrollbar` and `rect` properties
400 OO
.ui
.Element
.getDimensions = function ( el
) {
402 doc
= el
.ownerDocument
|| el
.document
,
403 win
= doc
.parentWindow
|| doc
.defaultView
;
405 if ( win
=== el
|| el
=== doc
.documentElement
) {
408 'borders': { 'top': 0, 'left': 0, 'bottom': 0, 'right': 0 },
410 'top': $win
.scrollTop(),
411 'left': $win
.scrollLeft()
413 'scrollbar': { 'right': 0, 'bottom': 0 },
417 'bottom': $win
.innerHeight(),
418 'right': $win
.innerWidth()
424 'borders': this.getBorders( el
),
426 'top': $el
.scrollTop(),
427 'left': $el
.scrollLeft()
430 'right': $el
.innerWidth() - el
.clientWidth
,
431 'bottom': $el
.innerHeight() - el
.clientHeight
433 'rect': el
.getBoundingClientRect()
439 * Get closest scrollable container.
441 * Traverses up until either a scrollable element or the root is reached, in which case the window
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
449 OO
.ui
.Element
.getClosestScrollableContainer = function ( el
, dimension
) {
451 props
= [ 'overflow' ],
452 $parent
= $( el
).parent();
454 if ( dimension
=== 'x' || dimension
=== 'y' ) {
455 props
.push( 'overflow-' + dimension
);
458 while ( $parent
.length
) {
459 if ( $parent
[0] === el
.ownerDocument
.body
) {
464 val
= $parent
.css( props
[i
] );
465 if ( val
=== 'auto' || val
=== 'scroll' ) {
469 $parent
= $parent
.parent();
471 return this.getDocument( el
).body
;
475 * Scroll element into view.
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
485 OO
.ui
.Element
.scrollIntoView = function ( el
, config
) {
486 // Configuration initialization
487 config
= config
|| {};
490 callback
= typeof config
.complete
=== 'function' && config
.complete
,
491 sc
= this.getClosestScrollableContainer( el
, config
.direction
),
493 eld
= this.getDimensions( el
),
494 scd
= this.getDimensions( sc
),
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
502 if ( !config
.direction
|| config
.direction
=== 'y' ) {
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
);
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
);
516 if ( !$.isEmptyObject( anim
) ) {
517 $sc
.stop( true ).animate( anim
, config
.duration
|| 'fast' );
519 $sc
.queue( function ( next
) {
534 * Get the HTML tag name.
536 * Override this method to base the result on instance information.
538 * @return {string} HTML tag name
540 OO
.ui
.Element
.prototype.getTagName = function () {
541 return this.constructor.static.tagName
;
545 * Check if the element is attached to the DOM
546 * @return {boolean} The element is attached to the DOM
548 OO
.ui
.Element
.prototype.isElementAttached = function () {
549 return $.contains( this.getElementDocument(), this.$element
[0] );
553 * Get the DOM document.
555 * @return {HTMLDocument} Document object
557 OO
.ui
.Element
.prototype.getElementDocument = function () {
558 return OO
.ui
.Element
.getDocument( this.$element
);
562 * Get the DOM window.
564 * @return {Window} Window object
566 OO
.ui
.Element
.prototype.getElementWindow = function () {
567 return OO
.ui
.Element
.getWindow( this.$element
);
571 * Get closest scrollable container.
573 OO
.ui
.Element
.prototype.getClosestScrollableElementContainer = function () {
574 return OO
.ui
.Element
.getClosestScrollableContainer( this.$element
[0] );
578 * Get group element is in.
580 * @return {OO.ui.GroupElement|null} Group element, null if none
582 OO
.ui
.Element
.prototype.getElementGroup = function () {
583 return this.elementGroup
;
587 * Set group element is in.
589 * @param {OO.ui.GroupElement|null} group Group element, null if none
592 OO
.ui
.Element
.prototype.setElementGroup = function ( group
) {
593 this.elementGroup
= group
;
598 * Scroll element into view.
600 * @param {Object} [config={}]
602 OO
.ui
.Element
.prototype.scrollElementIntoView = function ( config
) {
603 return OO
.ui
.Element
.scrollIntoView( this.$element
[0], config
);
607 * Bind a handler for an event on this.$element
609 * @param {string} event
610 * @param {Function} callback
612 OO
.ui
.Element
.prototype.onDOMEvent = function ( event
, callback
) {
613 OO
.ui
.Element
.onDOMEvent( this.$element
, event
, callback
);
617 * Unbind a handler bound with #offDOMEvent
619 * @param {string} event
620 * @param {Function} callback
622 OO
.ui
.Element
.prototype.offDOMEvent = function ( event
, callback
) {
623 OO
.ui
.Element
.offDOMEvent( this.$element
, event
, callback
);
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.
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(
642 jQuery
.event
.fix( e
),
649 var doc
= this.ownerDocument
|| this,
650 attaches
= $.data( doc
, 'ooui-' + simulatedName
+ '-attaches' );
652 doc
.addEventListener( realName
, handler
, true );
654 $.data( doc
, 'ooui-' + simulatedName
+ '-attaches', ( attaches
|| 0 ) + 1 );
656 teardown: function () {
657 var doc
= this.ownerDocument
|| this,
658 attaches
= $.data( doc
, 'ooui-' + simulatedName
+ '-attaches' ) - 1;
660 doc
.removeEventListener( realName
, handler
, true );
661 $.removeData( doc
, 'ooui-' + simulatedName
+ '-attaches' );
663 $.data( doc
, 'ooui-' + simulatedName
+ '-attaches', attaches
);
669 var hasOwn
= Object
.prototype.hasOwnProperty
,
671 focusin
: specialEvent( 'focusin', 'focus' ),
672 focusout
: specialEvent( 'focusout', 'blur' )
676 * Bind a handler for an event on a DOM element.
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.
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
687 OO
.ui
.Element
.onDOMEvent = function ( el
, event
, callback
) {
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
];
695 $( el
).on( event
, callback
);
698 $.event
.special
[event
] = orig
;
700 $( el
).on( event
, callback
);
705 * Unbind a handler bound with #static-method-onDOMEvent.
708 * @param {HTMLElement|jQuery} el DOM element
709 * @param {string} event Event to unbind
710 * @param {Function} [callback] Callback to unbind
712 OO
.ui
.Element
.offDOMEvent = function ( el
, event
, callback
) {
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
];
719 $( el
).off( event
, callback
);
722 $.event
.special
[event
] = orig
;
724 $( el
).off( event
, callback
);
729 * Embedded iframe with the same styles as its parent.
732 * @extends OO.ui.Element
733 * @mixins OO.EventEmitter
736 * @param {Object} [config] Configuration options
738 OO
.ui
.Frame
= function OoUiFrame( config
) {
739 // Parent constructor
740 OO
.ui
.Frame
.super.call( this, config
);
742 // Mixin constructors
743 OO
.EventEmitter
.call( this );
747 this.config
= config
;
751 .addClass( 'oo-ui-frame' )
752 .attr( { 'frameborder': 0, 'scrolling': 'no' } );
758 OO
.inheritClass( OO
.ui
.Frame
, OO
.ui
.Element
);
759 OO
.mixinClass( OO
.ui
.Frame
, OO
.EventEmitter
);
761 /* Static Properties */
767 OO
.ui
.Frame
.static.tagName
= 'iframe';
778 * Transplant the CSS styles from as parent document to a frame's document.
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.
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.
788 * For details of how we arrived at the strategy used in this function, see #load.
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
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();
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
810 pollNodeId
= 'oo-ui-frame-transplantStyles-loaded-' + i
;
811 $pollNodes
= $pollNodes
.add( $( '<div>', frameDoc
)
812 .attr( 'id', pollNodeId
)
813 .appendTo( frameDoc
.body
)
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
+ '; }';
822 // Not an external stylesheet, or no polling required; just copy the node over
823 newNode
= frameDoc
.importNode( styleNode
, true );
825 frameDoc
.head
.appendChild( newNode
);
828 // Poll every 100ms until all external stylesheets have loaded
829 $pendingPollNodes
= $pollNodes
;
830 timeoutID
= setTimeout( function pollExternalStylesheets() {
832 $pendingPollNodes
.length
> 0 &&
833 $pendingPollNodes
.eq( 0 ).css( 'font-family' ) === fontFamily
835 $pendingPollNodes
= $pendingPollNodes
.slice( 1 );
838 if ( $pendingPollNodes
.length
=== 0 ) {
840 if ( timeoutID
!== null ) {
846 timeoutID
= setTimeout( pollExternalStylesheets
, 100 );
849 // ...but give up after a while
850 if ( timeout
!== 0 ) {
851 setTimeout( function () {
853 clearTimeout( timeoutID
);
858 }, timeout
|| 5000 );
861 return deferred
.promise();
867 * Load the frame contents.
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
874 * Sounds simple right? Read on...
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.
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.
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.
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.
898 * All this stylesheet injection and polling magic is in #transplantStyles.
900 * @return {jQuery.Promise} Promise resolved when loading is complete
903 OO
.ui
.Frame
.prototype.load = function () {
906 // Return existing promise if already loading or loaded
907 if ( this.loading
) {
908 return this.loading
.promise();
912 this.loading
= $.Deferred();
914 win
= this.$element
.prop( 'contentWindow' );
917 // Figure out directionality:
918 this.dir
= OO
.ui
.Element
.getDir( this.$element
) || 'ltr';
920 // Initialize contents
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>' +
933 this.$ = OO
.ui
.Element
.getJQuery( doc
, this );
934 this.$content
= this.$( '.oo-ui-frame-content' ).attr( 'tabIndex', 0 );
935 this.$document
= this.$( doc
);
938 this.constructor.static.transplantStyles( this.getElementDocument(), this.$document
[0] )
939 .always( OO
.ui
.bind( function () {
941 this.loading
.resolve();
944 return this.loading
.promise();
948 * Set the size of the frame.
950 * @param {number} width Frame width in pixels
951 * @param {number} height Frame height in pixels
954 OO
.ui
.Frame
.prototype.setSize = function ( width
, height
) {
955 this.$element
.css( { 'width': width
, 'height': height
} );
959 * Container for elements in a child frame.
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.
966 * @extends OO.ui.Element
967 * @mixins OO.EventEmitter
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
975 OO
.ui
.Window
= function OoUiWindow( config
) {
977 // Parent constructor
978 OO
.ui
.Window
.super.call( this, config
);
980 // Mixin constructors
981 OO
.EventEmitter
.call( this );
984 this.visible
= false;
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.' );
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
);
1004 .addClass( 'oo-ui-window-frame' )
1005 .append( this.frame
.$element
);
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', '' );
1020 OO
.inheritClass( OO
.ui
.Window
, OO
.ui
.Element
);
1021 OO
.mixinClass( OO
.ui
.Window
, OO
.EventEmitter
);
1028 * Fired after window has been opened.
1031 * @param {Object} data Window opening data
1037 * Fired after window has been closed.
1040 * @param {Object} data Window closing data
1043 /* Static Properties */
1046 * Symbolic name of icon.
1050 * @property {string}
1052 OO
.ui
.Window
.static.icon
= 'window';
1057 * Subclasses must implement this property before instantiating the window.
1058 * Alternatively, override #getTitle with an alternative implementation.
1063 * @property {string|Function} Title string or function that returns a string
1065 OO
.ui
.Window
.static.title
= null;
1070 * Check if window is visible.
1072 * @return {boolean} Window is visible
1074 OO
.ui
.Window
.prototype.isVisible = function () {
1075 return this.visible
;
1079 * Check if window is opening.
1081 * @return {boolean} Window is opening
1083 OO
.ui
.Window
.prototype.isOpening = function () {
1084 return !!this.opening
&& this.opening
.state() !== 'resolved';
1088 * Check if window is closing.
1090 * @return {boolean} Window is closing
1092 OO
.ui
.Window
.prototype.isClosing = function () {
1093 return !!this.closing
&& this.closing
.state() !== 'resolved';
1097 * Check if window is opened.
1099 * @return {boolean} Window is opened
1101 OO
.ui
.Window
.prototype.isOpened = function () {
1102 return !!this.opened
&& this.opened
.state() !== 'resolved';
1106 * Get the window frame.
1108 * @return {OO.ui.Frame} Frame of window
1110 OO
.ui
.Window
.prototype.getFrame = function () {
1115 * Get the title of the window.
1117 * @return {string} Title text
1119 OO
.ui
.Window
.prototype.getTitle = function () {
1124 * Get the window icon.
1126 * @return {string} Symbolic name of icon
1128 OO
.ui
.Window
.prototype.getIcon = function () {
1133 * Set the size of window frame.
1135 * @param {number} [width=auto] Custom width
1136 * @param {number} [height=auto] Custom height
1139 OO
.ui
.Window
.prototype.setSize = function ( width
, height
) {
1140 if ( !this.frame
.$content
) {
1144 this.frame
.$element
.css( {
1145 'width': width
=== undefined ? 'auto' : width
,
1146 'height': height
=== undefined ? 'auto' : height
1153 * Set the title of the window.
1155 * @param {string|Function} title Title text or a function that returns text
1158 OO
.ui
.Window
.prototype.setTitle = function ( title
) {
1159 this.title
= OO
.ui
.resolveMsg( title
);
1160 if ( this.$title
) {
1161 this.$title
.text( title
);
1167 * Set the icon of the window.
1169 * @param {string} icon Symbolic name of icon
1172 OO
.ui
.Window
.prototype.setIcon = function ( icon
) {
1174 this.$icon
.removeClass( 'oo-ui-icon-' + this.icon
);
1178 this.$icon
.addClass( 'oo-ui-icon-' + this.icon
);
1185 * Set the position of window to fit with contents.
1187 * @param {string} left Left offset
1188 * @param {string} top Top offset
1191 OO
.ui
.Window
.prototype.setPosition = function ( left
, top
) {
1192 this.$element
.css( { 'left': left
, 'top': top
} );
1197 * Set the height of window to fit with contents.
1199 * @param {number} [min=0] Min height
1200 * @param {number} [max] Max height (defaults to content's outer height)
1203 OO
.ui
.Window
.prototype.fitHeightToContents = function ( min
, max
) {
1204 var height
= this.frame
.$content
.outerHeight();
1206 this.frame
.$element
.css(
1207 'height', Math
.max( min
|| 0, max
=== undefined ? height
: Math
.min( max
, height
) )
1214 * Set the width of window to fit with contents.
1216 * @param {number} [min=0] Min height
1217 * @param {number} [max] Max height (defaults to content's outer width)
1220 OO
.ui
.Window
.prototype.fitWidthToContents = function ( min
, max
) {
1221 var width
= this.frame
.$content
.outerWidth();
1223 this.frame
.$element
.css(
1224 'width', Math
.max( min
|| 0, max
=== undefined ? width
: Math
.min( max
, width
) )
1231 * Initialize window contents.
1233 * The first time the window is opened, #initialize is called when it's safe to begin populating
1234 * its contents. See #setup for a way to make changes each time the window opens.
1236 * Once this method is called, this.$$ can be used to create elements within the frame.
1240 OO
.ui
.Window
.prototype.initialize = function () {
1242 this.$ = this.frame
.$;
1243 this.$title
= this.$( '<div class="oo-ui-window-title"></div>' )
1244 .text( this.title
);
1245 this.$icon
= this.$( '<div class="oo-ui-window-icon"></div>' )
1246 .addClass( 'oo-ui-icon-' + this.icon
);
1247 this.$head
= this.$( '<div class="oo-ui-window-head"></div>' );
1248 this.$body
= this.$( '<div class="oo-ui-window-body"></div>' );
1249 this.$foot
= this.$( '<div class="oo-ui-window-foot"></div>' );
1250 this.$overlay
= this.$( '<div class="oo-ui-window-overlay"></div>' );
1253 this.frame
.$content
.append(
1254 this.$head
.append( this.$icon
, this.$title
),
1264 * Get a process for setting up a window for use.
1266 * Each time the window is opened this process will set it up for use in a particular context, based
1267 * on the `data` argument.
1269 * When you override this method, you can add additional setup steps to the process the parent
1270 * method provides using the 'first' and 'next' methods.
1273 * @param {Object} [data] Window opening data
1274 * @return {OO.ui.Process} Setup process
1276 OO
.ui
.Window
.prototype.getSetupProcess = function () {
1277 return new OO
.ui
.Process();
1281 * Get a process for readying a window for use.
1283 * Each time the window is open and setup, this process will ready it up for use in a particular
1284 * context, based on the `data` argument.
1286 * When you override this method, you can add additional setup steps to the process the parent
1287 * method provides using the 'first' and 'next' methods.
1290 * @param {Object} [data] Window opening data
1291 * @return {OO.ui.Process} Setup process
1293 OO
.ui
.Window
.prototype.getReadyProcess = function () {
1294 return new OO
.ui
.Process();
1298 * Get a process for tearing down a window after use.
1300 * Each time the window is closed this process will tear it down and do something with the user's
1301 * interactions within the window, based on the `data` argument.
1303 * When you override this method, you can add additional teardown steps to the process the parent
1304 * method provides using the 'first' and 'next' methods.
1307 * @param {Object} [data] Window closing data
1308 * @return {OO.ui.Process} Teardown process
1310 OO
.ui
.Window
.prototype.getTeardownProcess = function () {
1311 return new OO
.ui
.Process();
1317 * Do not override this method. Use #getSetupProcess to do something each time the window closes.
1319 * @param {Object} [data] Window opening data
1324 * @return {jQuery.Promise} Promise resolved when window is opened; when the promise is resolved the
1325 * first argument will be a promise which will be resolved when the window begins closing
1327 OO
.ui
.Window
.prototype.open = function ( data
) {
1328 // Return existing promise if already opening or open
1329 if ( this.opening
) {
1330 return this.opening
.promise();
1334 this.opening
= $.Deferred();
1335 this.frame
.load().done( OO
.ui
.bind( function () {
1336 this.$element
.show();
1337 this.visible
= true;
1338 this.emit( 'opening', data
);
1339 this.getSetupProcess( data
).execute().done( OO
.ui
.bind( function () {
1340 this.emit( 'open', data
);
1341 setTimeout( OO
.ui
.bind( function () {
1342 // Focus the content div (which has a tabIndex) to inactivate
1343 // (but not clear) selections in the parent frame.
1344 // Must happen after 'open' is emitted (to ensure it is visible)
1345 // but before 'ready' is emitted (so subclasses can give focus to something
1347 this.frame
.$content
.focus();
1348 this.getReadyProcess( data
).execute().done( OO
.ui
.bind( function () {
1349 this.emit( 'ready', data
);
1350 this.opened
= $.Deferred();
1351 this.opening
.resolve( this.opened
.promise() );
1352 // Now that we are totally done opening, it's safe to allow closing
1353 this.closing
= null;
1359 return this.opening
.promise();
1365 * Do not override this method. Use #getTeardownProcess to do something each time the window closes.
1367 * @param {Object} [data] Window closing data
1370 * @return {jQuery.Promise} Promise resolved when window is closed
1372 OO
.ui
.Window
.prototype.close = function ( data
) {
1373 // Return existing promise if already closing or closed
1374 if ( this.closing
) {
1375 return this.closing
.promise();
1379 // This.closing needs to exist before we emit the closing event so that handlers can call
1380 // window.close() and trigger the safety check above
1381 this.closing
= $.Deferred();
1382 this.frame
.$content
.find( ':focus' ).blur();
1383 this.emit( 'closing', data
);
1384 this.getTeardownProcess( data
).execute().done( OO
.ui
.bind( function () {
1385 // To do something different with #opened, resolve/reject #opened in the teardown process
1386 if ( this.opened
.state() === 'pending' ) {
1387 this.opened
.resolve();
1389 this.emit( 'close', data
);
1390 this.$element
.hide();
1391 this.visible
= false;
1392 this.closing
.resolve();
1393 // Now that we are totally done closing, it's safe to allow opening
1394 this.opening
= null;
1397 return this.closing
.promise();
1400 * Set of mutually exclusive windows.
1403 * @extends OO.ui.Element
1404 * @mixins OO.EventEmitter
1407 * @param {OO.Factory} factory Window factory
1408 * @param {Object} [config] Configuration options
1410 OO
.ui
.WindowSet
= function OoUiWindowSet( factory
, config
) {
1411 // Parent constructor
1412 OO
.ui
.WindowSet
.super.call( this, config
);
1414 // Mixin constructors
1415 OO
.EventEmitter
.call( this );
1418 this.factory
= factory
;
1421 * List of all windows associated with this window set.
1423 * @property {OO.ui.Window[]}
1425 this.windowList
= [];
1428 * Mapping of OO.ui.Window objects created by name from the #factory.
1430 * @property {Object}
1433 this.currentWindow
= null;
1436 this.$element
.addClass( 'oo-ui-windowSet' );
1441 OO
.inheritClass( OO
.ui
.WindowSet
, OO
.ui
.Element
);
1442 OO
.mixinClass( OO
.ui
.WindowSet
, OO
.EventEmitter
);
1448 * @param {OO.ui.Window} win Window that's being opened
1449 * @param {Object} config Window opening information
1454 * @param {OO.ui.Window} win Window that's been opened
1455 * @param {Object} config Window opening information
1460 * @param {OO.ui.Window} win Window that's being closed
1461 * @param {Object} config Window closing information
1466 * @param {OO.ui.Window} win Window that's been closed
1467 * @param {Object} config Window closing information
1473 * Handle a window that's being opened.
1475 * @param {OO.ui.Window} win Window that's being opened
1476 * @param {Object} [config] Window opening information
1479 OO
.ui
.WindowSet
.prototype.onWindowOpening = function ( win
, config
) {
1480 if ( this.currentWindow
&& this.currentWindow
!== win
) {
1481 this.currentWindow
.close();
1483 this.currentWindow
= win
;
1484 this.emit( 'opening', win
, config
);
1488 * Handle a window that's been opened.
1490 * @param {OO.ui.Window} win Window that's been opened
1491 * @param {Object} [config] Window opening information
1494 OO
.ui
.WindowSet
.prototype.onWindowOpen = function ( win
, config
) {
1495 this.emit( 'open', win
, config
);
1499 * Handle a window that's being closed.
1501 * @param {OO.ui.Window} win Window that's being closed
1502 * @param {Object} [config] Window closing information
1505 OO
.ui
.WindowSet
.prototype.onWindowClosing = function ( win
, config
) {
1506 this.currentWindow
= null;
1507 this.emit( 'closing', win
, config
);
1511 * Handle a window that's been closed.
1513 * @param {OO.ui.Window} win Window that's been closed
1514 * @param {Object} [config] Window closing information
1517 OO
.ui
.WindowSet
.prototype.onWindowClose = function ( win
, config
) {
1518 this.emit( 'close', win
, config
);
1522 * Get the current window.
1524 * @return {OO.ui.Window|null} Current window or null if none open
1526 OO
.ui
.WindowSet
.prototype.getCurrentWindow = function () {
1527 return this.currentWindow
;
1531 * Return a given window.
1533 * @param {string} name Symbolic name of window
1534 * @return {OO.ui.Window} Window with specified name
1536 OO
.ui
.WindowSet
.prototype.getWindow = function ( name
) {
1539 if ( !this.factory
.lookup( name
) ) {
1540 throw new Error( 'Unknown window: ' + name
);
1542 if ( !( name
in this.windows
) ) {
1543 win
= this.windows
[name
] = this.createWindow( name
);
1544 this.addWindow( win
);
1546 return this.windows
[name
];
1550 * Create a window for use in this window set.
1552 * @param {string} name Symbolic name of window
1553 * @return {OO.ui.Window} Window with specified name
1555 OO
.ui
.WindowSet
.prototype.createWindow = function ( name
) {
1556 return this.factory
.create( name
, { '$': this.$ } );
1560 * Add a given window to this window set.
1562 * Connects event handlers and attaches it to the DOM. Calling
1563 * OO.ui.Window#open will not work until the window is added to the set.
1565 * @param {OO.ui.Window} win
1567 OO
.ui
.WindowSet
.prototype.addWindow = function ( win
) {
1568 if ( this.windowList
.indexOf( win
) !== -1 ) {
1572 this.windowList
.push( win
);
1574 win
.connect( this, {
1575 'opening': [ 'onWindowOpening', win
],
1576 'open': [ 'onWindowOpen', win
],
1577 'closing': [ 'onWindowClosing', win
],
1578 'close': [ 'onWindowClose', win
]
1580 this.$element
.append( win
.$element
);
1583 * Modal dialog window.
1587 * @extends OO.ui.Window
1590 * @param {Object} [config] Configuration options
1591 * @cfg {boolean} [footless] Hide foot
1592 * @cfg {string} [size='large'] Symbolic name of dialog size, `small`, `medium` or `large`
1594 OO
.ui
.Dialog
= function OoUiDialog( config
) {
1595 // Configuration initialization
1596 config
= $.extend( { 'size': 'large' }, config
);
1598 // Parent constructor
1599 OO
.ui
.Dialog
.super.call( this, config
);
1602 this.visible
= false;
1603 this.footless
= !!config
.footless
;
1606 this.onWindowMouseWheelHandler
= OO
.ui
.bind( this.onWindowMouseWheel
, this );
1607 this.onDocumentKeyDownHandler
= OO
.ui
.bind( this.onDocumentKeyDown
, this );
1610 this.$element
.on( 'mousedown', false );
1611 this.connect( this, { 'open': 'onOpen' } );
1614 this.$element
.addClass( 'oo-ui-dialog' );
1615 this.setSize( config
.size
);
1620 OO
.inheritClass( OO
.ui
.Dialog
, OO
.ui
.Window
);
1622 /* Static Properties */
1625 * Symbolic name of dialog.
1630 * @property {string}
1632 OO
.ui
.Dialog
.static.name
= '';
1635 * Map of symbolic size names and CSS classes.
1639 * @property {Object}
1641 OO
.ui
.Dialog
.static.sizeCssClasses
= {
1642 'small': 'oo-ui-dialog-small',
1643 'medium': 'oo-ui-dialog-medium',
1644 'large': 'oo-ui-dialog-large'
1650 * Handle close button click events.
1652 OO
.ui
.Dialog
.prototype.onCloseButtonClick = function () {
1653 this.close( { 'action': 'cancel' } );
1657 * Handle window mouse wheel events.
1659 * @param {jQuery.Event} e Mouse wheel event
1661 OO
.ui
.Dialog
.prototype.onWindowMouseWheel = function () {
1666 * Handle document key down events.
1668 * @param {jQuery.Event} e Key down event
1670 OO
.ui
.Dialog
.prototype.onDocumentKeyDown = function ( e
) {
1671 switch ( e
.which
) {
1672 case OO
.ui
.Keys
.PAGEUP
:
1673 case OO
.ui
.Keys
.PAGEDOWN
:
1674 case OO
.ui
.Keys
.END
:
1675 case OO
.ui
.Keys
.HOME
:
1676 case OO
.ui
.Keys
.LEFT
:
1678 case OO
.ui
.Keys
.RIGHT
:
1679 case OO
.ui
.Keys
.DOWN
:
1680 // Prevent any key events that might cause scrolling
1686 * Handle frame document key down events.
1688 * @param {jQuery.Event} e Key down event
1690 OO
.ui
.Dialog
.prototype.onFrameDocumentKeyDown = function ( e
) {
1691 if ( e
.which
=== OO
.ui
.Keys
.ESCAPE
) {
1692 this.close( { 'action': 'cancel' } );
1698 * Handle window open events.
1700 OO
.ui
.Dialog
.prototype.onOpen = function () {
1701 this.$element
.addClass( 'oo-ui-dialog-open' );
1707 * @param {string} [size='large'] Symbolic name of dialog size, `small`, `medium` or `large`
1709 OO
.ui
.Dialog
.prototype.setSize = function ( size
) {
1710 var name
, state
, cssClass
,
1711 sizeCssClasses
= OO
.ui
.Dialog
.static.sizeCssClasses
;
1713 if ( !sizeCssClasses
[size
] ) {
1717 for ( name
in sizeCssClasses
) {
1718 state
= name
=== size
;
1719 cssClass
= sizeCssClasses
[name
];
1720 this.$element
.toggleClass( cssClass
, state
);
1721 if ( this.frame
.$content
) {
1722 this.frame
.$content
.toggleClass( cssClass
, state
);
1730 OO
.ui
.Dialog
.prototype.initialize = function () {
1732 OO
.ui
.Dialog
.super.prototype.initialize
.call( this );
1735 this.closeButton
= new OO
.ui
.ButtonWidget( {
1739 'title': OO
.ui
.msg( 'ooui-dialog-action-close' )
1743 this.closeButton
.connect( this, { 'click': 'onCloseButtonClick' } );
1744 this.frame
.$document
.on( 'keydown', OO
.ui
.bind( this.onFrameDocumentKeyDown
, this ) );
1747 this.frame
.$content
.addClass( 'oo-ui-dialog-content' );
1748 if ( this.footless
) {
1749 this.frame
.$content
.addClass( 'oo-ui-dialog-content-footless' );
1751 this.closeButton
.$element
.addClass( 'oo-ui-window-closeButton' );
1752 this.$head
.append( this.closeButton
.$element
);
1758 OO
.ui
.Dialog
.prototype.getSetupProcess = function ( data
) {
1759 return OO
.ui
.Dialog
.super.prototype.getSetupProcess
.call( this, data
)
1760 .next( function () {
1761 // Prevent scrolling in top-level window
1762 this.$( window
).on( 'mousewheel', this.onWindowMouseWheelHandler
);
1763 this.$( document
).on( 'keydown', this.onDocumentKeyDownHandler
);
1770 OO
.ui
.Dialog
.prototype.getTeardownProcess = function ( data
) {
1771 return OO
.ui
.Dialog
.super.prototype.getTeardownProcess
.call( this, data
)
1772 .first( function () {
1773 this.$element
.removeClass( 'oo-ui-dialog-open' );
1774 return OO
.ui
.Process
.static.delay( 250 );
1776 .next( function () {
1777 // Allow scrolling in top-level window
1778 this.$( window
).off( 'mousewheel', this.onWindowMouseWheelHandler
);
1779 this.$( document
).off( 'keydown', this.onDocumentKeyDownHandler
);
1784 * Check if input is pending.
1788 OO
.ui
.Dialog
.prototype.isPending = function () {
1789 return !!this.pending
;
1793 * Increase the pending stack.
1797 OO
.ui
.Dialog
.prototype.pushPending = function () {
1798 if ( this.pending
=== 0 ) {
1799 this.frame
.$content
.addClass( 'oo-ui-dialog-pending' );
1800 this.$head
.addClass( 'oo-ui-texture-pending' );
1801 this.$foot
.addClass( 'oo-ui-texture-pending' );
1809 * Reduce the pending stack.
1815 OO
.ui
.Dialog
.prototype.popPending = function () {
1816 if ( this.pending
=== 1 ) {
1817 this.frame
.$content
.removeClass( 'oo-ui-dialog-pending' );
1818 this.$head
.removeClass( 'oo-ui-texture-pending' );
1819 this.$foot
.removeClass( 'oo-ui-texture-pending' );
1821 this.pending
= Math
.max( 0, this.pending
- 1 );
1826 * Container for elements.
1830 * @extends OO.ui.Element
1831 * @mixins OO.EventEmitter
1834 * @param {Object} [config] Configuration options
1836 OO
.ui
.Layout
= function OoUiLayout( config
) {
1837 // Initialize config
1838 config
= config
|| {};
1840 // Parent constructor
1841 OO
.ui
.Layout
.super.call( this, config
);
1843 // Mixin constructors
1844 OO
.EventEmitter
.call( this );
1847 this.$element
.addClass( 'oo-ui-layout' );
1852 OO
.inheritClass( OO
.ui
.Layout
, OO
.ui
.Element
);
1853 OO
.mixinClass( OO
.ui
.Layout
, OO
.EventEmitter
);
1855 * User interface control.
1859 * @extends OO.ui.Element
1860 * @mixins OO.EventEmitter
1863 * @param {Object} [config] Configuration options
1864 * @cfg {boolean} [disabled=false] Disable
1866 OO
.ui
.Widget
= function OoUiWidget( config
) {
1867 // Initialize config
1868 config
= $.extend( { 'disabled': false }, config
);
1870 // Parent constructor
1871 OO
.ui
.Widget
.super.call( this, config
);
1873 // Mixin constructors
1874 OO
.EventEmitter
.call( this );
1877 this.disabled
= null;
1878 this.wasDisabled
= null;
1881 this.$element
.addClass( 'oo-ui-widget' );
1882 this.setDisabled( !!config
.disabled
);
1887 OO
.inheritClass( OO
.ui
.Widget
, OO
.ui
.Element
);
1888 OO
.mixinClass( OO
.ui
.Widget
, OO
.EventEmitter
);
1894 * @param {boolean} disabled Widget is disabled
1900 * Check if the widget is disabled.
1902 * @param {boolean} Button is disabled
1904 OO
.ui
.Widget
.prototype.isDisabled = function () {
1905 return this.disabled
;
1909 * Update the disabled state, in case of changes in parent widget.
1913 OO
.ui
.Widget
.prototype.updateDisabled = function () {
1914 this.setDisabled( this.disabled
);
1919 * Set the disabled state of the widget.
1921 * This should probably change the widgets' appearance and prevent it from being used.
1923 * @param {boolean} disabled Disable widget
1926 OO
.ui
.Widget
.prototype.setDisabled = function ( disabled
) {
1929 this.disabled
= !!disabled
;
1930 isDisabled
= this.isDisabled();
1931 if ( isDisabled
!== this.wasDisabled
) {
1932 this.$element
.toggleClass( 'oo-ui-widget-disabled', isDisabled
);
1933 this.$element
.toggleClass( 'oo-ui-widget-enabled', !isDisabled
);
1934 this.emit( 'disable', isDisabled
);
1936 this.wasDisabled
= isDisabled
;
1940 * A list of functions, called in sequence.
1942 * If a function added to a process returns boolean false the process will stop; if it returns an
1943 * object with a `promise` method the process will use the promise to either continue to the next
1944 * step when the promise is resolved or stop when the promise is rejected.
1950 OO
.ui
.Process = function () {
1957 OO
.initClass( OO
.ui
.Process
);
1959 /* Static Methods */
1962 * Generate a promise which is resolved after a set amount of time.
1964 * @param {number} length Number of milliseconds before resolving the promise
1965 * @return {jQuery.Promise} Promise that will be resolved after a set amount of time
1967 OO
.ui
.Process
.static.delay = function ( length
) {
1968 var deferred
= $.Deferred();
1970 setTimeout( function () {
1974 return deferred
.promise();
1980 * Start the process.
1982 * @return {jQuery.Promise} Promise that is resolved when all steps have completed or rejected when
1983 * any of the steps return boolean false or a promise which gets rejected; upon stopping the
1984 * process, the remaining steps will not be taken
1986 OO
.ui
.Process
.prototype.execute = function () {
1987 var i
, len
, promise
;
1990 * Continue execution.
1993 * @param {Array} step A function and the context it should be called in
1994 * @return {Function} Function that continues the process
1996 function proceed( step
) {
1997 return function () {
1998 // Execute step in the correct context
1999 var result
= step
[0].call( step
[1] );
2001 if ( result
=== false ) {
2002 // Use rejected promise for boolean false results
2003 return $.Deferred().reject().promise();
2005 // Duck-type the object to see if it can produce a promise
2006 if ( result
&& $.isFunction( result
.promise
) ) {
2007 // Use a promise generated from the result
2008 return result
.promise();
2010 // Use resolved promise for other results
2011 return $.Deferred().resolve().promise();
2015 if ( this.steps
.length
) {
2016 // Generate a chain reaction of promises
2017 promise
= proceed( this.steps
[0] )();
2018 for ( i
= 1, len
= this.steps
.length
; i
< len
; i
++ ) {
2019 promise
= promise
.then( proceed( this.steps
[i
] ) );
2022 promise
= $.Deferred().resolve().promise();
2029 * Add step to the beginning of the process.
2031 * @param {Function} step Function to execute; if it returns boolean false the process will stop; if
2032 * it returns an object with a `promise` method the process will use the promise to either
2033 * continue to the next step when the promise is resolved or stop when the promise is rejected
2034 * @param {Object} [context=null] Context to call the step function in
2037 OO
.ui
.Process
.prototype.first = function ( step
, context
) {
2038 this.steps
.unshift( [ step
, context
|| null ] );
2043 * Add step to the end of the process.
2045 * @param {Function} step Function to execute; if it returns boolean false the process will stop; if
2046 * it returns an object with a `promise` method the process will use the promise to either
2047 * continue to the next step when the promise is resolved or stop when the promise is rejected
2048 * @param {Object} [context=null] Context to call the step function in
2051 OO
.ui
.Process
.prototype.next = function ( step
, context
) {
2052 this.steps
.push( [ step
, context
|| null ] );
2056 * Dialog for showing a confirmation/warning message.
2059 * @extends OO.ui.Dialog
2062 * @param {Object} [config] Configuration options
2064 OO
.ui
.ConfirmationDialog
= function OoUiConfirmationDialog( config
) {
2065 // Configuration initialization
2066 config
= $.extend( { 'size': 'small' }, config
);
2068 // Parent constructor
2069 OO
.ui
.Dialog
.call( this, config
);
2074 OO
.inheritClass( OO
.ui
.ConfirmationDialog
, OO
.ui
.Dialog
);
2076 /* Static Properties */
2078 OO
.ui
.ConfirmationDialog
.static.name
= 'confirm';
2080 OO
.ui
.ConfirmationDialog
.static.icon
= 'help';
2082 OO
.ui
.ConfirmationDialog
.static.title
= OO
.ui
.deferMsg( 'ooui-dialog-confirm-title' );
2089 OO
.ui
.ConfirmationDialog
.prototype.initialize = function () {
2091 OO
.ui
.Dialog
.prototype.initialize
.call( this );
2093 // Set up the layout
2094 var contentLayout
= new OO
.ui
.PanelLayout( {
2099 this.$promptContainer
= this.$( '<div>' ).addClass( 'oo-ui-dialog-confirm-promptContainer' );
2101 this.cancelButton
= new OO
.ui
.ButtonWidget();
2102 this.cancelButton
.connect( this, { 'click': [ 'close', 'cancel' ] } );
2104 this.okButton
= new OO
.ui
.ButtonWidget();
2105 this.okButton
.connect( this, { 'click': [ 'close', 'ok' ] } );
2108 contentLayout
.$element
.append( this.$promptContainer
);
2109 this.$body
.append( contentLayout
.$element
);
2112 this.okButton
.$element
,
2113 this.cancelButton
.$element
2116 this.connect( this, { 'close': [ 'close', 'cancel' ] } );
2120 * Setup a confirmation dialog.
2122 * @param {Object} [data] Window opening data including text of the dialog and text for the buttons
2123 * @param {jQuery|string} [data.prompt] Text to display or list of nodes to use as content of the dialog.
2124 * @param {jQuery|string|Function|null} [data.okLabel] Label of the OK button
2125 * @param {jQuery|string|Function|null} [data.cancelLabel] Label of the cancel button
2126 * @param {string|string[]} [data.okFlags="constructive"] Flags for the OK button
2127 * @param {string|string[]} [data.cancelFlags="destructive"] Flags for the cancel button
2128 * @return {OO.ui.Process} Setup process
2130 OO
.ui
.ConfirmationDialog
.prototype.getSetupProcess = function ( data
) {
2132 return OO
.ui
.ConfirmationDialog
.super.prototype.getSetupProcess
.call( this, data
)
2133 .next( function () {
2134 var prompt
= data
.prompt
|| OO
.ui
.deferMsg( 'ooui-dialog-confirm-default-prompt' ),
2135 okLabel
= data
.okLabel
|| OO
.ui
.deferMsg( 'ooui-dialog-confirm-default-ok' ),
2136 cancelLabel
= data
.cancelLabel
|| OO
.ui
.deferMsg( 'ooui-dialog-confirm-default-cancel' ),
2137 okFlags
= data
.okFlags
|| 'constructive',
2138 cancelFlags
= data
.cancelFlags
|| 'destructive';
2140 if ( typeof prompt
=== 'string' ) {
2141 this.$promptContainer
.text( prompt
);
2143 this.$promptContainer
.empty().append( prompt
);
2146 this.okButton
.setLabel( okLabel
).clearFlags().setFlags( okFlags
);
2147 this.cancelButton
.setLabel( cancelLabel
).clearFlags().setFlags( cancelFlags
);
2154 OO
.ui
.ConfirmationDialog
.prototype.getTeardownProcess = function ( data
) {
2156 return OO
.ui
.ConfirmationDialog
.super.prototype.getTeardownProcess
.call( this, data
)
2157 .first( function () {
2158 if ( data
=== 'ok' ) {
2159 this.opened
.resolve();
2160 } else if ( data
=== 'cancel' ) {
2161 this.opened
.reject();
2166 * Element with a button.
2172 * @param {jQuery} $button Button node, assigned to #$button
2173 * @param {Object} [config] Configuration options
2174 * @cfg {boolean} [frameless] Render button without a frame
2175 * @cfg {number} [tabIndex=0] Button's tab index, use -1 to prevent tab focusing
2177 OO
.ui
.ButtonedElement
= function OoUiButtonedElement( $button
, config
) {
2178 // Configuration initialization
2179 config
= config
|| {};
2182 this.$button
= $button
;
2183 this.tabIndex
= null;
2184 this.active
= false;
2185 this.onMouseUpHandler
= OO
.ui
.bind( this.onMouseUp
, this );
2188 this.$button
.on( 'mousedown', OO
.ui
.bind( this.onMouseDown
, this ) );
2191 this.$element
.addClass( 'oo-ui-buttonedElement' );
2193 .addClass( 'oo-ui-buttonedElement-button' )
2194 .attr( 'role', 'button' )
2195 .prop( 'tabIndex', config
.tabIndex
|| 0 );
2196 if ( config
.frameless
) {
2197 this.$element
.addClass( 'oo-ui-buttonedElement-frameless' );
2199 this.$element
.addClass( 'oo-ui-buttonedElement-framed' );
2205 OO
.initClass( OO
.ui
.ButtonedElement
);
2207 /* Static Properties */
2210 * Cancel mouse down events.
2214 * @property {boolean}
2216 OO
.ui
.ButtonedElement
.static.cancelButtonMouseDownEvents
= true;
2221 * Handles mouse down events.
2223 * @param {jQuery.Event} e Mouse down event
2225 OO
.ui
.ButtonedElement
.prototype.onMouseDown = function ( e
) {
2226 if ( this.isDisabled() || e
.which
!== 1 ) {
2229 // tabIndex should generally be interacted with via the property, but it's not possible to
2230 // reliably unset a tabIndex via a property so we use the (lowercase) "tabindex" attribute
2231 this.tabIndex
= this.$button
.attr( 'tabindex' );
2233 // Remove the tab-index while the button is down to prevent the button from stealing focus
2234 .removeAttr( 'tabindex' )
2235 .addClass( 'oo-ui-buttonedElement-pressed' );
2236 // Run the mouseup handler no matter where the mouse is when the button is let go, so we can
2237 // reliably reapply the tabindex and remove the pressed class
2238 this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler
, true );
2239 // Prevent change of focus unless specifically configured otherwise
2240 if ( this.constructor.static.cancelButtonMouseDownEvents
) {
2246 * Handles mouse up events.
2248 * @param {jQuery.Event} e Mouse up event
2250 OO
.ui
.ButtonedElement
.prototype.onMouseUp = function ( e
) {
2251 if ( this.isDisabled() || e
.which
!== 1 ) {
2255 // Restore the tab-index after the button is up to restore the button's accesssibility
2256 .attr( 'tabindex', this.tabIndex
)
2257 .removeClass( 'oo-ui-buttonedElement-pressed' );
2258 // Stop listening for mouseup, since we only needed this once
2259 this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler
, true );
2265 * @param {boolean} [value] Make button active
2268 OO
.ui
.ButtonedElement
.prototype.setActive = function ( value
) {
2269 this.$button
.toggleClass( 'oo-ui-buttonedElement-active', !!value
);
2273 * Element that can be automatically clipped to visible boundaies.
2279 * @param {jQuery} $clippable Nodes to clip, assigned to #$clippable
2280 * @param {Object} [config] Configuration options
2282 OO
.ui
.ClippableElement
= function OoUiClippableElement( $clippable
, config
) {
2283 // Configuration initialization
2284 config
= config
|| {};
2287 this.$clippable
= $clippable
;
2288 this.clipping
= false;
2289 this.clipped
= false;
2290 this.$clippableContainer
= null;
2291 this.$clippableScroller
= null;
2292 this.$clippableWindow
= null;
2293 this.idealWidth
= null;
2294 this.idealHeight
= null;
2295 this.onClippableContainerScrollHandler
= OO
.ui
.bind( this.clip
, this );
2296 this.onClippableWindowResizeHandler
= OO
.ui
.bind( this.clip
, this );
2299 this.$clippable
.addClass( 'oo-ui-clippableElement-clippable' );
2307 * @param {boolean} value Enable clipping
2310 OO
.ui
.ClippableElement
.prototype.setClipping = function ( value
) {
2313 if ( this.clipping
!== value
) {
2314 this.clipping
= value
;
2315 if ( this.clipping
) {
2316 this.$clippableContainer
= this.$( this.getClosestScrollableElementContainer() );
2317 // If the clippable container is the body, we have to listen to scroll events and check
2318 // jQuery.scrollTop on the window because of browser inconsistencies
2319 this.$clippableScroller
= this.$clippableContainer
.is( 'body' ) ?
2320 this.$( OO
.ui
.Element
.getWindow( this.$clippableContainer
) ) :
2321 this.$clippableContainer
;
2322 this.$clippableScroller
.on( 'scroll', this.onClippableContainerScrollHandler
);
2323 this.$clippableWindow
= this.$( this.getElementWindow() )
2324 .on( 'resize', this.onClippableWindowResizeHandler
);
2325 // Initial clip after visible
2326 setTimeout( OO
.ui
.bind( this.clip
, this ) );
2328 this.$clippableContainer
= null;
2329 this.$clippableScroller
.off( 'scroll', this.onClippableContainerScrollHandler
);
2330 this.$clippableScroller
= null;
2331 this.$clippableWindow
.off( 'resize', this.onClippableWindowResizeHandler
);
2332 this.$clippableWindow
= null;
2340 * Check if the element will be clipped to fit the visible area of the nearest scrollable container.
2342 * @return {boolean} Element will be clipped to the visible area
2344 OO
.ui
.ClippableElement
.prototype.isClipping = function () {
2345 return this.clipping
;
2349 * Check if the bottom or right of the element is being clipped by the nearest scrollable container.
2351 * @return {boolean} Part of the element is being clipped
2353 OO
.ui
.ClippableElement
.prototype.isClipped = function () {
2354 return this.clipped
;
2358 * Set the ideal size.
2360 * @param {number|string} [width] Width as a number of pixels or CSS string with unit suffix
2361 * @param {number|string} [height] Height as a number of pixels or CSS string with unit suffix
2363 OO
.ui
.ClippableElement
.prototype.setIdealSize = function ( width
, height
) {
2364 this.idealWidth
= width
;
2365 this.idealHeight
= height
;
2369 * Clip element to visible boundaries and allow scrolling when needed.
2371 * Element will be clipped the bottom or right of the element is within 10px of the edge of, or
2372 * overlapped by, the visible area of the nearest scrollable container.
2376 OO
.ui
.ClippableElement
.prototype.clip = function () {
2377 if ( !this.clipping
) {
2378 // this.$clippableContainer and this.$clippableWindow are null, so the below will fail
2383 cOffset
= this.$clippable
.offset(),
2384 ccOffset
= this.$clippableContainer
.offset() || { 'top': 0, 'left': 0 },
2385 ccHeight
= this.$clippableContainer
.innerHeight() - buffer
,
2386 ccWidth
= this.$clippableContainer
.innerWidth() - buffer
,
2387 scrollTop
= this.$clippableScroller
.scrollTop(),
2388 scrollLeft
= this.$clippableScroller
.scrollLeft(),
2389 desiredWidth
= ( ccOffset
.left
+ scrollLeft
+ ccWidth
) - cOffset
.left
,
2390 desiredHeight
= ( ccOffset
.top
+ scrollTop
+ ccHeight
) - cOffset
.top
,
2391 naturalWidth
= this.$clippable
.prop( 'scrollWidth' ),
2392 naturalHeight
= this.$clippable
.prop( 'scrollHeight' ),
2393 clipWidth
= desiredWidth
< naturalWidth
,
2394 clipHeight
= desiredHeight
< naturalHeight
;
2397 this.$clippable
.css( { 'overflow-x': 'auto', 'width': desiredWidth
} );
2399 this.$clippable
.css( { 'overflow-x': '', 'width': this.idealWidth
|| '' } );
2402 this.$clippable
.css( { 'overflow-y': 'auto', 'height': desiredHeight
} );
2404 this.$clippable
.css( { 'overflow-y': '', 'height': this.idealHeight
|| '' } );
2407 this.clipped
= clipWidth
|| clipHeight
;
2412 * Element with named flags that can be added, removed, listed and checked.
2414 * A flag, when set, adds a CSS class on the `$element` by combing `oo-ui-flaggableElement-` with
2415 * the flag name. Flags are primarily useful for styling.
2421 * @param {Object} [config] Configuration options
2422 * @cfg {string[]} [flags=[]] Styling flags, e.g. 'primary', 'destructive' or 'constructive'
2424 OO
.ui
.FlaggableElement
= function OoUiFlaggableElement( config
) {
2425 // Config initialization
2426 config
= config
|| {};
2432 this.setFlags( config
.flags
);
2438 * Check if a flag is set.
2440 * @param {string} flag Name of flag
2441 * @return {boolean} Has flag
2443 OO
.ui
.FlaggableElement
.prototype.hasFlag = function ( flag
) {
2444 return flag
in this.flags
;
2448 * Get the names of all flags set.
2450 * @return {string[]} flags Flag names
2452 OO
.ui
.FlaggableElement
.prototype.getFlags = function () {
2453 return Object
.keys( this.flags
);
2461 OO
.ui
.FlaggableElement
.prototype.clearFlags = function () {
2463 classPrefix
= 'oo-ui-flaggableElement-';
2465 for ( flag
in this.flags
) {
2466 delete this.flags
[flag
];
2467 this.$element
.removeClass( classPrefix
+ flag
);
2474 * Add one or more flags.
2476 * @param {string|string[]|Object.<string, boolean>} flags One or more flags to add, or an object
2477 * keyed by flag name containing boolean set/remove instructions.
2480 OO
.ui
.FlaggableElement
.prototype.setFlags = function ( flags
) {
2482 classPrefix
= 'oo-ui-flaggableElement-';
2484 if ( typeof flags
=== 'string' ) {
2486 this.flags
[flags
] = true;
2487 this.$element
.addClass( classPrefix
+ flags
);
2488 } else if ( $.isArray( flags
) ) {
2489 for ( i
= 0, len
= flags
.length
; i
< len
; i
++ ) {
2492 this.flags
[flag
] = true;
2493 this.$element
.addClass( classPrefix
+ flag
);
2495 } else if ( OO
.isPlainObject( flags
) ) {
2496 for ( flag
in flags
) {
2497 if ( flags
[flag
] ) {
2499 this.flags
[flag
] = true;
2500 this.$element
.addClass( classPrefix
+ flag
);
2503 delete this.flags
[flag
];
2504 this.$element
.removeClass( classPrefix
+ flag
);
2511 * Element containing a sequence of child elements.
2517 * @param {jQuery} $group Container node, assigned to #$group
2518 * @param {Object} [config] Configuration options
2520 OO
.ui
.GroupElement
= function OoUiGroupElement( $group
, config
) {
2522 config
= config
|| {};
2525 this.$group
= $group
;
2527 this.aggregateItemEvents
= {};
2535 * @return {OO.ui.Element[]} Items
2537 OO
.ui
.GroupElement
.prototype.getItems = function () {
2538 return this.items
.slice( 0 );
2542 * Add an aggregate item event.
2544 * Aggregated events are listened to on each item and then emitted by the group under a new name,
2545 * and with an additional leading parameter containing the item that emitted the original event.
2546 * Other arguments that were emitted from the original event are passed through.
2548 * @param {Object.<string,string|null>} events Aggregate events emitted by group, keyed by item
2549 * event, use null value to remove aggregation
2550 * @throws {Error} If aggregation already exists
2552 OO
.ui
.GroupElement
.prototype.aggregate = function ( events
) {
2553 var i
, len
, item
, add
, remove
, itemEvent
, groupEvent
;
2555 for ( itemEvent
in events
) {
2556 groupEvent
= events
[itemEvent
];
2558 // Remove existing aggregated event
2559 if ( itemEvent
in this.aggregateItemEvents
) {
2560 // Don't allow duplicate aggregations
2562 throw new Error( 'Duplicate item event aggregation for ' + itemEvent
);
2564 // Remove event aggregation from existing items
2565 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
2566 item
= this.items
[i
];
2567 if ( item
.connect
&& item
.disconnect
) {
2569 remove
[itemEvent
] = [ 'emit', groupEvent
, item
];
2570 item
.disconnect( this, remove
);
2573 // Prevent future items from aggregating event
2574 delete this.aggregateItemEvents
[itemEvent
];
2577 // Add new aggregate event
2579 // Make future items aggregate event
2580 this.aggregateItemEvents
[itemEvent
] = groupEvent
;
2581 // Add event aggregation to existing items
2582 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
2583 item
= this.items
[i
];
2584 if ( item
.connect
&& item
.disconnect
) {
2586 add
[itemEvent
] = [ 'emit', groupEvent
, item
];
2587 item
.connect( this, add
);
2597 * @param {OO.ui.Element[]} items Item
2598 * @param {number} [index] Index to insert items at
2601 OO
.ui
.GroupElement
.prototype.addItems = function ( items
, index
) {
2602 var i
, len
, item
, event
, events
, currentIndex
,
2605 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
2608 // Check if item exists then remove it first, effectively "moving" it
2609 currentIndex
= $.inArray( item
, this.items
);
2610 if ( currentIndex
>= 0 ) {
2611 this.removeItems( [ item
] );
2612 // Adjust index to compensate for removal
2613 if ( currentIndex
< index
) {
2618 if ( item
.connect
&& item
.disconnect
&& !$.isEmptyObject( this.aggregateItemEvents
) ) {
2620 for ( event
in this.aggregateItemEvents
) {
2621 events
[event
] = [ 'emit', this.aggregateItemEvents
[event
], item
];
2623 item
.connect( this, events
);
2625 item
.setElementGroup( this );
2626 itemElements
.push( item
.$element
.get( 0 ) );
2629 if ( index
=== undefined || index
< 0 || index
>= this.items
.length
) {
2630 this.$group
.append( itemElements
);
2631 this.items
.push
.apply( this.items
, items
);
2632 } else if ( index
=== 0 ) {
2633 this.$group
.prepend( itemElements
);
2634 this.items
.unshift
.apply( this.items
, items
);
2636 this.items
[index
].$element
.before( itemElements
);
2637 this.items
.splice
.apply( this.items
, [ index
, 0 ].concat( items
) );
2646 * Items will be detached, not removed, so they can be used later.
2648 * @param {OO.ui.Element[]} items Items to remove
2651 OO
.ui
.GroupElement
.prototype.removeItems = function ( items
) {
2652 var i
, len
, item
, index
, remove
, itemEvent
;
2654 // Remove specific items
2655 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
2657 index
= $.inArray( item
, this.items
);
2658 if ( index
!== -1 ) {
2660 item
.connect
&& item
.disconnect
&&
2661 !$.isEmptyObject( this.aggregateItemEvents
)
2664 if ( itemEvent
in this.aggregateItemEvents
) {
2665 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
2667 item
.disconnect( this, remove
);
2669 item
.setElementGroup( null );
2670 this.items
.splice( index
, 1 );
2671 item
.$element
.detach();
2681 * Items will be detached, not removed, so they can be used later.
2685 OO
.ui
.GroupElement
.prototype.clearItems = function () {
2686 var i
, len
, item
, remove
, itemEvent
;
2689 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
2690 item
= this.items
[i
];
2692 item
.connect
&& item
.disconnect
&&
2693 !$.isEmptyObject( this.aggregateItemEvents
)
2696 if ( itemEvent
in this.aggregateItemEvents
) {
2697 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
2699 item
.disconnect( this, remove
);
2701 item
.setElementGroup( null );
2702 item
.$element
.detach();
2709 * Element containing an icon.
2715 * @param {jQuery} $icon Icon node, assigned to #$icon
2716 * @param {Object} [config] Configuration options
2717 * @cfg {Object|string} [icon=''] Symbolic icon name, or map of icon names keyed by language ID;
2718 * use the 'default' key to specify the icon to be used when there is no icon in the user's
2721 OO
.ui
.IconedElement
= function OoUiIconedElement( $icon
, config
) {
2722 // Config intialization
2723 config
= config
|| {};
2730 this.$icon
.addClass( 'oo-ui-iconedElement-icon' );
2731 this.setIcon( config
.icon
|| this.constructor.static.icon
);
2736 OO
.initClass( OO
.ui
.IconedElement
);
2738 /* Static Properties */
2743 * Value should be the unique portion of an icon CSS class name, such as 'up' for 'oo-ui-icon-up'.
2745 * For i18n purposes, this property can be an object containing a `default` icon name property and
2746 * additional icon names keyed by language code.
2748 * Example of i18n icon definition:
2749 * { 'default': 'bold-a', 'en': 'bold-b', 'de': 'bold-f' }
2753 * @property {Object|string} Symbolic icon name, or map of icon names keyed by language ID;
2754 * use the 'default' key to specify the icon to be used when there is no icon in the user's
2757 OO
.ui
.IconedElement
.static.icon
= null;
2764 * @param {Object|string} icon Symbolic icon name, or map of icon names keyed by language ID;
2765 * use the 'default' key to specify the icon to be used when there is no icon in the user's
2769 OO
.ui
.IconedElement
.prototype.setIcon = function ( icon
) {
2770 icon
= OO
.isPlainObject( icon
) ? OO
.ui
.getLocalValue( icon
, null, 'default' ) : icon
;
2773 this.$icon
.removeClass( 'oo-ui-icon-' + this.icon
);
2775 if ( typeof icon
=== 'string' ) {
2777 if ( icon
.length
) {
2778 this.$icon
.addClass( 'oo-ui-icon-' + icon
);
2782 this.$element
.toggleClass( 'oo-ui-iconedElement', !!this.icon
);
2790 * @return {string} Icon
2792 OO
.ui
.IconedElement
.prototype.getIcon = function () {
2796 * Element containing an indicator.
2802 * @param {jQuery} $indicator Indicator node, assigned to #$indicator
2803 * @param {Object} [config] Configuration options
2804 * @cfg {string} [indicator] Symbolic indicator name
2805 * @cfg {string} [indicatorTitle] Indicator title text or a function that return text
2807 OO
.ui
.IndicatedElement
= function OoUiIndicatedElement( $indicator
, config
) {
2808 // Config intialization
2809 config
= config
|| {};
2812 this.$indicator
= $indicator
;
2813 this.indicator
= null;
2814 this.indicatorLabel
= null;
2817 this.$indicator
.addClass( 'oo-ui-indicatedElement-indicator' );
2818 this.setIndicator( config
.indicator
|| this.constructor.static.indicator
);
2819 this.setIndicatorTitle( config
.indicatorTitle
|| this.constructor.static.indicatorTitle
);
2824 OO
.initClass( OO
.ui
.IndicatedElement
);
2826 /* Static Properties */
2833 * @property {string|null} Symbolic indicator name or null for no indicator
2835 OO
.ui
.IndicatedElement
.static.indicator
= null;
2842 * @property {string|Function|null} Indicator title text, a function that return text or null for no
2845 OO
.ui
.IndicatedElement
.static.indicatorTitle
= null;
2852 * @param {string|null} indicator Symbolic name of indicator to use or null for no indicator
2855 OO
.ui
.IndicatedElement
.prototype.setIndicator = function ( indicator
) {
2856 if ( this.indicator
) {
2857 this.$indicator
.removeClass( 'oo-ui-indicator-' + this.indicator
);
2858 this.indicator
= null;
2860 if ( typeof indicator
=== 'string' ) {
2861 indicator
= indicator
.trim();
2862 if ( indicator
.length
) {
2863 this.$indicator
.addClass( 'oo-ui-indicator-' + indicator
);
2864 this.indicator
= indicator
;
2867 this.$element
.toggleClass( 'oo-ui-indicatedElement', !!this.indicator
);
2873 * Set indicator label.
2875 * @param {string|Function|null} indicator Indicator title text, a function that return text or null
2876 * for no indicator title
2879 OO
.ui
.IndicatedElement
.prototype.setIndicatorTitle = function ( indicatorTitle
) {
2880 this.indicatorTitle
= indicatorTitle
= OO
.ui
.resolveMsg( indicatorTitle
);
2882 if ( typeof indicatorTitle
=== 'string' && indicatorTitle
.length
) {
2883 this.$indicator
.attr( 'title', indicatorTitle
);
2885 this.$indicator
.removeAttr( 'title' );
2894 * @return {string} title Symbolic name of indicator
2896 OO
.ui
.IndicatedElement
.prototype.getIndicator = function () {
2897 return this.indicator
;
2901 * Get indicator title.
2903 * @return {string} Indicator title text
2905 OO
.ui
.IndicatedElement
.prototype.getIndicatorTitle = function () {
2906 return this.indicatorTitle
;
2909 * Element containing a label.
2915 * @param {jQuery} $label Label node, assigned to #$label
2916 * @param {Object} [config] Configuration options
2917 * @cfg {jQuery|string|Function} [label] Label nodes, text or a function that returns nodes or text
2918 * @cfg {boolean} [autoFitLabel=true] Whether to fit the label or not.
2920 OO
.ui
.LabeledElement
= function OoUiLabeledElement( $label
, config
) {
2921 // Config intialization
2922 config
= config
|| {};
2925 this.$label
= $label
;
2929 this.$label
.addClass( 'oo-ui-labeledElement-label' );
2930 this.setLabel( config
.label
|| this.constructor.static.label
);
2931 this.autoFitLabel
= config
.autoFitLabel
=== undefined || !!config
.autoFitLabel
;
2936 OO
.initClass( OO
.ui
.LabeledElement
);
2938 /* Static Properties */
2945 * @property {string|Function|null} Label text; a function that returns a nodes or text; or null for
2948 OO
.ui
.LabeledElement
.static.label
= null;
2955 * An empty string will result in the label being hidden. A string containing only whitespace will
2956 * be converted to a single
2958 * @param {jQuery|string|Function|null} label Label nodes; text; a function that retuns nodes or
2959 * text; or null for no label
2962 OO
.ui
.LabeledElement
.prototype.setLabel = function ( label
) {
2965 this.label
= label
= OO
.ui
.resolveMsg( label
) || null;
2966 if ( typeof label
=== 'string' && label
.length
) {
2967 if ( label
.match( /^\s*$/ ) ) {
2968 // Convert whitespace only string to a single non-breaking space
2969 this.$label
.html( ' ' );
2971 this.$label
.text( label
);
2973 } else if ( label
instanceof jQuery
) {
2974 this.$label
.empty().append( label
);
2976 this.$label
.empty();
2979 this.$element
.toggleClass( 'oo-ui-labeledElement', !empty
);
2980 this.$label
.css( 'display', empty
? 'none' : '' );
2988 * @return {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
2989 * text; or null for no label
2991 OO
.ui
.LabeledElement
.prototype.getLabel = function () {
3000 OO
.ui
.LabeledElement
.prototype.fitLabel = function () {
3001 if ( this.$label
.autoEllipsis
&& this.autoFitLabel
) {
3002 this.$label
.autoEllipsis( { 'hasSpan': false, 'tooltip': true } );
3007 * Popuppable element.
3013 * @param {Object} [config] Configuration options
3014 * @cfg {number} [popupWidth=320] Width of popup
3015 * @cfg {number} [popupHeight] Height of popup
3016 * @cfg {Object} [popup] Configuration to pass to popup
3018 OO
.ui
.PopuppableElement
= function OoUiPopuppableElement( config
) {
3019 // Configuration initialization
3020 config
= $.extend( { 'popupWidth': 320 }, config
);
3023 this.popup
= new OO
.ui
.PopupWidget( $.extend(
3024 { 'align': 'center', 'autoClose': true },
3026 { '$': this.$, '$autoCloseIgnore': this.$element
}
3028 this.popupWidth
= config
.popupWidth
;
3029 this.popupHeight
= config
.popupHeight
;
3037 * @return {OO.ui.PopupWidget} Popup widget
3039 OO
.ui
.PopuppableElement
.prototype.getPopup = function () {
3046 OO
.ui
.PopuppableElement
.prototype.showPopup = function () {
3047 this.popup
.show().display( this.popupWidth
, this.popupHeight
);
3053 OO
.ui
.PopuppableElement
.prototype.hidePopup = function () {
3057 * Element with a title.
3063 * @param {jQuery} $label Titled node, assigned to #$titled
3064 * @param {Object} [config] Configuration options
3065 * @cfg {string|Function} [title] Title text or a function that returns text
3067 OO
.ui
.TitledElement
= function OoUiTitledElement( $titled
, config
) {
3068 // Config intialization
3069 config
= config
|| {};
3072 this.$titled
= $titled
;
3076 this.setTitle( config
.title
|| this.constructor.static.title
);
3081 OO
.initClass( OO
.ui
.TitledElement
);
3083 /* Static Properties */
3090 * @property {string|Function} Title text or a function that returns text
3092 OO
.ui
.TitledElement
.static.title
= null;
3099 * @param {string|Function|null} title Title text, a function that returns text or null for no title
3102 OO
.ui
.TitledElement
.prototype.setTitle = function ( title
) {
3103 this.title
= title
= OO
.ui
.resolveMsg( title
) || null;
3105 if ( typeof title
=== 'string' && title
.length
) {
3106 this.$titled
.attr( 'title', title
);
3108 this.$titled
.removeAttr( 'title' );
3117 * @return {string} Title string
3119 OO
.ui
.TitledElement
.prototype.getTitle = function () {
3123 * Generic toolbar tool.
3127 * @extends OO.ui.Widget
3128 * @mixins OO.ui.IconedElement
3131 * @param {OO.ui.ToolGroup} toolGroup
3132 * @param {Object} [config] Configuration options
3133 * @cfg {string|Function} [title] Title text or a function that returns text
3135 OO
.ui
.Tool
= function OoUiTool( toolGroup
, config
) {
3136 // Config intialization
3137 config
= config
|| {};
3139 // Parent constructor
3140 OO
.ui
.Tool
.super.call( this, config
);
3142 // Mixin constructors
3143 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
3146 this.toolGroup
= toolGroup
;
3147 this.toolbar
= this.toolGroup
.getToolbar();
3148 this.active
= false;
3149 this.$title
= this.$( '<span>' );
3150 this.$link
= this.$( '<a>' );
3154 this.toolbar
.connect( this, { 'updateState': 'onUpdateState' } );
3157 this.$title
.addClass( 'oo-ui-tool-title' );
3159 .addClass( 'oo-ui-tool-link' )
3160 .append( this.$icon
, this.$title
);
3162 .data( 'oo-ui-tool', this )
3164 'oo-ui-tool ' + 'oo-ui-tool-name-' +
3165 this.constructor.static.name
.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' )
3167 .append( this.$link
);
3168 this.setTitle( config
.title
|| this.constructor.static.title
);
3173 OO
.inheritClass( OO
.ui
.Tool
, OO
.ui
.Widget
);
3174 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.IconedElement
);
3182 /* Static Properties */
3188 OO
.ui
.Tool
.static.tagName
= 'span';
3191 * Symbolic name of tool.
3196 * @property {string}
3198 OO
.ui
.Tool
.static.name
= '';
3206 * @property {string}
3208 OO
.ui
.Tool
.static.group
= '';
3213 * Title is used as a tooltip when the tool is part of a bar tool group, or a label when the tool
3214 * is part of a list or menu tool group. If a trigger is associated with an action by the same name
3215 * as the tool, a description of its keyboard shortcut for the appropriate platform will be
3216 * appended to the title if the tool is part of a bar tool group.
3221 * @property {string|Function} Title text or a function that returns text
3223 OO
.ui
.Tool
.static.title
= '';
3226 * Tool can be automatically added to catch-all groups.
3230 * @property {boolean}
3232 OO
.ui
.Tool
.static.autoAddToCatchall
= true;
3235 * Tool can be automatically added to named groups.
3238 * @property {boolean}
3241 OO
.ui
.Tool
.static.autoAddToGroup
= true;
3244 * Check if this tool is compatible with given data.
3248 * @param {Mixed} data Data to check
3249 * @return {boolean} Tool can be used with data
3251 OO
.ui
.Tool
.static.isCompatibleWith = function () {
3258 * Handle the toolbar state being updated.
3260 * This is an abstract method that must be overridden in a concrete subclass.
3264 OO
.ui
.Tool
.prototype.onUpdateState = function () {
3266 'OO.ui.Tool.onUpdateState not implemented in this subclass:' + this.constructor
3271 * Handle the tool being selected.
3273 * This is an abstract method that must be overridden in a concrete subclass.
3277 OO
.ui
.Tool
.prototype.onSelect = function () {
3279 'OO.ui.Tool.onSelect not implemented in this subclass:' + this.constructor
3284 * Check if the button is active.
3286 * @param {boolean} Button is active
3288 OO
.ui
.Tool
.prototype.isActive = function () {
3293 * Make the button appear active or inactive.
3295 * @param {boolean} state Make button appear active
3297 OO
.ui
.Tool
.prototype.setActive = function ( state
) {
3298 this.active
= !!state
;
3299 if ( this.active
) {
3300 this.$element
.addClass( 'oo-ui-tool-active' );
3302 this.$element
.removeClass( 'oo-ui-tool-active' );
3307 * Get the tool title.
3309 * @param {string|Function} title Title text or a function that returns text
3312 OO
.ui
.Tool
.prototype.setTitle = function ( title
) {
3313 this.title
= OO
.ui
.resolveMsg( title
);
3319 * Get the tool title.
3321 * @return {string} Title text
3323 OO
.ui
.Tool
.prototype.getTitle = function () {
3328 * Get the tool's symbolic name.
3330 * @return {string} Symbolic name of tool
3332 OO
.ui
.Tool
.prototype.getName = function () {
3333 return this.constructor.static.name
;
3339 OO
.ui
.Tool
.prototype.updateTitle = function () {
3340 var titleTooltips
= this.toolGroup
.constructor.static.titleTooltips
,
3341 accelTooltips
= this.toolGroup
.constructor.static.accelTooltips
,
3342 accel
= this.toolbar
.getToolAccelerator( this.constructor.static.name
),
3349 .addClass( 'oo-ui-tool-accel' )
3353 if ( titleTooltips
&& typeof this.title
=== 'string' && this.title
.length
) {
3354 tooltipParts
.push( this.title
);
3356 if ( accelTooltips
&& typeof accel
=== 'string' && accel
.length
) {
3357 tooltipParts
.push( accel
);
3359 if ( tooltipParts
.length
) {
3360 this.$link
.attr( 'title', tooltipParts
.join( ' ' ) );
3362 this.$link
.removeAttr( 'title' );
3369 OO
.ui
.Tool
.prototype.destroy = function () {
3370 this.toolbar
.disconnect( this );
3371 this.$element
.remove();
3374 * Collection of tool groups.
3377 * @extends OO.ui.Element
3378 * @mixins OO.EventEmitter
3379 * @mixins OO.ui.GroupElement
3382 * @param {OO.ui.ToolFactory} toolFactory Factory for creating tools
3383 * @param {OO.ui.ToolGroupFactory} toolGroupFactory Factory for creating tool groups
3384 * @param {Object} [config] Configuration options
3385 * @cfg {boolean} [actions] Add an actions section opposite to the tools
3386 * @cfg {boolean} [shadow] Add a shadow below the toolbar
3388 OO
.ui
.Toolbar
= function OoUiToolbar( toolFactory
, toolGroupFactory
, config
) {
3389 // Configuration initialization
3390 config
= config
|| {};
3392 // Parent constructor
3393 OO
.ui
.Toolbar
.super.call( this, config
);
3395 // Mixin constructors
3396 OO
.EventEmitter
.call( this );
3397 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
3400 this.toolFactory
= toolFactory
;
3401 this.toolGroupFactory
= toolGroupFactory
;
3404 this.$bar
= this.$( '<div>' );
3405 this.$actions
= this.$( '<div>' );
3406 this.initialized
= false;
3410 .add( this.$bar
).add( this.$group
).add( this.$actions
)
3411 .on( 'mousedown', OO
.ui
.bind( this.onMouseDown
, this ) );
3414 this.$group
.addClass( 'oo-ui-toolbar-tools' );
3415 this.$bar
.addClass( 'oo-ui-toolbar-bar' ).append( this.$group
);
3416 if ( config
.actions
) {
3417 this.$actions
.addClass( 'oo-ui-toolbar-actions' );
3418 this.$bar
.append( this.$actions
);
3420 this.$bar
.append( '<div style="clear:both"></div>' );
3421 if ( config
.shadow
) {
3422 this.$bar
.append( '<div class="oo-ui-toolbar-shadow"></div>' );
3424 this.$element
.addClass( 'oo-ui-toolbar' ).append( this.$bar
);
3429 OO
.inheritClass( OO
.ui
.Toolbar
, OO
.ui
.Element
);
3430 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.EventEmitter
);
3431 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.ui
.GroupElement
);
3436 * Get the tool factory.
3438 * @return {OO.ui.ToolFactory} Tool factory
3440 OO
.ui
.Toolbar
.prototype.getToolFactory = function () {
3441 return this.toolFactory
;
3445 * Get the tool group factory.
3447 * @return {OO.Factory} Tool group factory
3449 OO
.ui
.Toolbar
.prototype.getToolGroupFactory = function () {
3450 return this.toolGroupFactory
;
3454 * Handles mouse down events.
3456 * @param {jQuery.Event} e Mouse down event
3458 OO
.ui
.Toolbar
.prototype.onMouseDown = function ( e
) {
3459 var $closestWidgetToEvent
= this.$( e
.target
).closest( '.oo-ui-widget' ),
3460 $closestWidgetToToolbar
= this.$element
.closest( '.oo-ui-widget' );
3461 if ( !$closestWidgetToEvent
.length
|| $closestWidgetToEvent
[0] === $closestWidgetToToolbar
[0] ) {
3467 * Sets up handles and preloads required information for the toolbar to work.
3468 * This must be called immediately after it is attached to a visible document.
3470 OO
.ui
.Toolbar
.prototype.initialize = function () {
3471 this.initialized
= true;
3477 * Tools can be specified in the following ways:
3479 * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3480 * - All tools in a group: `{ 'group': 'group-name' }`
3481 * - All tools: `'*'` - Using this will make the group a list with a "More" label by default
3483 * @param {Object.<string,Array>} groups List of tool group configurations
3484 * @param {Array|string} [groups.include] Tools to include
3485 * @param {Array|string} [groups.exclude] Tools to exclude
3486 * @param {Array|string} [groups.promote] Tools to promote to the beginning
3487 * @param {Array|string} [groups.demote] Tools to demote to the end
3489 OO
.ui
.Toolbar
.prototype.setup = function ( groups
) {
3490 var i
, len
, type
, group
,
3492 defaultType
= 'bar';
3494 // Cleanup previous groups
3497 // Build out new groups
3498 for ( i
= 0, len
= groups
.length
; i
< len
; i
++ ) {
3500 if ( group
.include
=== '*' ) {
3501 // Apply defaults to catch-all groups
3502 if ( group
.type
=== undefined ) {
3503 group
.type
= 'list';
3505 if ( group
.label
=== undefined ) {
3506 group
.label
= 'ooui-toolbar-more';
3509 // Check type has been registered
3510 type
= this.getToolGroupFactory().lookup( group
.type
) ? group
.type
: defaultType
;
3512 this.getToolGroupFactory().create( type
, this, $.extend( { '$': this.$ }, group
) )
3515 this.addItems( items
);
3519 * Remove all tools and groups from the toolbar.
3521 OO
.ui
.Toolbar
.prototype.reset = function () {
3526 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3527 this.items
[i
].destroy();
3533 * Destroys toolbar, removing event handlers and DOM elements.
3535 * Call this whenever you are done using a toolbar.
3537 OO
.ui
.Toolbar
.prototype.destroy = function () {
3539 this.$element
.remove();
3543 * Check if tool has not been used yet.
3545 * @param {string} name Symbolic name of tool
3546 * @return {boolean} Tool is available
3548 OO
.ui
.Toolbar
.prototype.isToolAvailable = function ( name
) {
3549 return !this.tools
[name
];
3553 * Prevent tool from being used again.
3555 * @param {OO.ui.Tool} tool Tool to reserve
3557 OO
.ui
.Toolbar
.prototype.reserveTool = function ( tool
) {
3558 this.tools
[tool
.getName()] = tool
;
3562 * Allow tool to be used again.
3564 * @param {OO.ui.Tool} tool Tool to release
3566 OO
.ui
.Toolbar
.prototype.releaseTool = function ( tool
) {
3567 delete this.tools
[tool
.getName()];
3571 * Get accelerator label for tool.
3573 * This is a stub that should be overridden to provide access to accelerator information.
3575 * @param {string} name Symbolic name of tool
3576 * @return {string|undefined} Tool accelerator label if available
3578 OO
.ui
.Toolbar
.prototype.getToolAccelerator = function () {
3582 * Factory for tools.
3585 * @extends OO.Factory
3588 OO
.ui
.ToolFactory
= function OoUiToolFactory() {
3589 // Parent constructor
3590 OO
.ui
.ToolFactory
.super.call( this );
3595 OO
.inheritClass( OO
.ui
.ToolFactory
, OO
.Factory
);
3600 OO
.ui
.ToolFactory
.prototype.getTools = function ( include
, exclude
, promote
, demote
) {
3601 var i
, len
, included
, promoted
, demoted
,
3605 // Collect included and not excluded tools
3606 included
= OO
.simpleArrayDifference( this.extract( include
), this.extract( exclude
) );
3609 promoted
= this.extract( promote
, used
);
3610 demoted
= this.extract( demote
, used
);
3613 for ( i
= 0, len
= included
.length
; i
< len
; i
++ ) {
3614 if ( !used
[included
[i
]] ) {
3615 auto
.push( included
[i
] );
3619 return promoted
.concat( auto
).concat( demoted
);
3623 * Get a flat list of names from a list of names or groups.
3625 * Tools can be specified in the following ways:
3627 * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3628 * - All tools in a group: `{ 'group': 'group-name' }`
3629 * - All tools: `'*'`
3632 * @param {Array|string} collection List of tools
3633 * @param {Object} [used] Object with names that should be skipped as properties; extracted
3634 * names will be added as properties
3635 * @return {string[]} List of extracted names
3637 OO
.ui
.ToolFactory
.prototype.extract = function ( collection
, used
) {
3638 var i
, len
, item
, name
, tool
,
3641 if ( collection
=== '*' ) {
3642 for ( name
in this.registry
) {
3643 tool
= this.registry
[name
];
3645 // Only add tools by group name when auto-add is enabled
3646 tool
.static.autoAddToCatchall
&&
3647 // Exclude already used tools
3648 ( !used
|| !used
[name
] )
3656 } else if ( $.isArray( collection
) ) {
3657 for ( i
= 0, len
= collection
.length
; i
< len
; i
++ ) {
3658 item
= collection
[i
];
3659 // Allow plain strings as shorthand for named tools
3660 if ( typeof item
=== 'string' ) {
3661 item
= { 'name': item
};
3663 if ( OO
.isPlainObject( item
) ) {
3665 for ( name
in this.registry
) {
3666 tool
= this.registry
[name
];
3668 // Include tools with matching group
3669 tool
.static.group
=== item
.group
&&
3670 // Only add tools by group name when auto-add is enabled
3671 tool
.static.autoAddToGroup
&&
3672 // Exclude already used tools
3673 ( !used
|| !used
[name
] )
3681 // Include tools with matching name and exclude already used tools
3682 } else if ( item
.name
&& ( !used
|| !used
[item
.name
] ) ) {
3683 names
.push( item
.name
);
3685 used
[item
.name
] = true;
3694 * Collection of tools.
3696 * Tools can be specified in the following ways:
3698 * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3699 * - All tools in a group: `{ 'group': 'group-name' }`
3700 * - All tools: `'*'`
3704 * @extends OO.ui.Widget
3705 * @mixins OO.ui.GroupElement
3708 * @param {OO.ui.Toolbar} toolbar
3709 * @param {Object} [config] Configuration options
3710 * @cfg {Array|string} [include=[]] List of tools to include
3711 * @cfg {Array|string} [exclude=[]] List of tools to exclude
3712 * @cfg {Array|string} [promote=[]] List of tools to promote to the beginning
3713 * @cfg {Array|string} [demote=[]] List of tools to demote to the end
3715 OO
.ui
.ToolGroup
= function OoUiToolGroup( toolbar
, config
) {
3716 // Configuration initialization
3717 config
= config
|| {};
3719 // Parent constructor
3720 OO
.ui
.ToolGroup
.super.call( this, config
);
3722 // Mixin constructors
3723 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
3726 this.toolbar
= toolbar
;
3728 this.pressed
= null;
3729 this.autoDisabled
= false;
3730 this.include
= config
.include
|| [];
3731 this.exclude
= config
.exclude
|| [];
3732 this.promote
= config
.promote
|| [];
3733 this.demote
= config
.demote
|| [];
3734 this.onCapturedMouseUpHandler
= OO
.ui
.bind( this.onCapturedMouseUp
, this );
3738 'mousedown': OO
.ui
.bind( this.onMouseDown
, this ),
3739 'mouseup': OO
.ui
.bind( this.onMouseUp
, this ),
3740 'mouseover': OO
.ui
.bind( this.onMouseOver
, this ),
3741 'mouseout': OO
.ui
.bind( this.onMouseOut
, this )
3743 this.toolbar
.getToolFactory().connect( this, { 'register': 'onToolFactoryRegister' } );
3744 this.aggregate( { 'disable': 'itemDisable' } );
3745 this.connect( this, { 'itemDisable': 'updateDisabled' } );
3748 this.$group
.addClass( 'oo-ui-toolGroup-tools' );
3750 .addClass( 'oo-ui-toolGroup' )
3751 .append( this.$group
);
3757 OO
.inheritClass( OO
.ui
.ToolGroup
, OO
.ui
.Widget
);
3758 OO
.mixinClass( OO
.ui
.ToolGroup
, OO
.ui
.GroupElement
);
3766 /* Static Properties */
3769 * Show labels in tooltips.
3773 * @property {boolean}
3775 OO
.ui
.ToolGroup
.static.titleTooltips
= false;
3778 * Show acceleration labels in tooltips.
3782 * @property {boolean}
3784 OO
.ui
.ToolGroup
.static.accelTooltips
= false;
3787 * Automatically disable the toolgroup when all tools are disabled
3791 * @property {boolean}
3793 OO
.ui
.ToolGroup
.static.autoDisable
= true;
3800 OO
.ui
.ToolGroup
.prototype.isDisabled = function () {
3801 return this.autoDisabled
|| OO
.ui
.ToolGroup
.super.prototype.isDisabled
.apply( this, arguments
);
3807 OO
.ui
.ToolGroup
.prototype.updateDisabled = function () {
3808 var i
, item
, allDisabled
= true;
3810 if ( this.constructor.static.autoDisable
) {
3811 for ( i
= this.items
.length
- 1; i
>= 0; i
-- ) {
3812 item
= this.items
[i
];
3813 if ( !item
.isDisabled() ) {
3814 allDisabled
= false;
3818 this.autoDisabled
= allDisabled
;
3820 OO
.ui
.ToolGroup
.super.prototype.updateDisabled
.apply( this, arguments
);
3824 * Handle mouse down events.
3826 * @param {jQuery.Event} e Mouse down event
3828 OO
.ui
.ToolGroup
.prototype.onMouseDown = function ( e
) {
3829 if ( !this.isDisabled() && e
.which
=== 1 ) {
3830 this.pressed
= this.getTargetTool( e
);
3831 if ( this.pressed
) {
3832 this.pressed
.setActive( true );
3833 this.getElementDocument().addEventListener(
3834 'mouseup', this.onCapturedMouseUpHandler
, true
3842 * Handle captured mouse up events.
3844 * @param {Event} e Mouse up event
3846 OO
.ui
.ToolGroup
.prototype.onCapturedMouseUp = function ( e
) {
3847 this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseUpHandler
, true );
3848 // onMouseUp may be called a second time, depending on where the mouse is when the button is
3849 // released, but since `this.pressed` will no longer be true, the second call will be ignored.
3850 this.onMouseUp( e
);
3854 * Handle mouse up events.
3856 * @param {jQuery.Event} e Mouse up event
3858 OO
.ui
.ToolGroup
.prototype.onMouseUp = function ( e
) {
3859 var tool
= this.getTargetTool( e
);
3861 if ( !this.isDisabled() && e
.which
=== 1 && this.pressed
&& this.pressed
=== tool
) {
3862 this.pressed
.onSelect();
3865 this.pressed
= null;
3870 * Handle mouse over events.
3872 * @param {jQuery.Event} e Mouse over event
3874 OO
.ui
.ToolGroup
.prototype.onMouseOver = function ( e
) {
3875 var tool
= this.getTargetTool( e
);
3877 if ( this.pressed
&& this.pressed
=== tool
) {
3878 this.pressed
.setActive( true );
3883 * Handle mouse out events.
3885 * @param {jQuery.Event} e Mouse out event
3887 OO
.ui
.ToolGroup
.prototype.onMouseOut = function ( e
) {
3888 var tool
= this.getTargetTool( e
);
3890 if ( this.pressed
&& this.pressed
=== tool
) {
3891 this.pressed
.setActive( false );
3896 * Get the closest tool to a jQuery.Event.
3898 * Only tool links are considered, which prevents other elements in the tool such as popups from
3899 * triggering tool group interactions.
3902 * @param {jQuery.Event} e
3903 * @return {OO.ui.Tool|null} Tool, `null` if none was found
3905 OO
.ui
.ToolGroup
.prototype.getTargetTool = function ( e
) {
3907 $item
= this.$( e
.target
).closest( '.oo-ui-tool-link' );
3909 if ( $item
.length
) {
3910 tool
= $item
.parent().data( 'oo-ui-tool' );
3913 return tool
&& !tool
.isDisabled() ? tool
: null;
3917 * Handle tool registry register events.
3919 * If a tool is registered after the group is created, we must repopulate the list to account for:
3921 * - a tool being added that may be included
3922 * - a tool already included being overridden
3924 * @param {string} name Symbolic name of tool
3926 OO
.ui
.ToolGroup
.prototype.onToolFactoryRegister = function () {
3931 * Get the toolbar this group is in.
3933 * @return {OO.ui.Toolbar} Toolbar of group
3935 OO
.ui
.ToolGroup
.prototype.getToolbar = function () {
3936 return this.toolbar
;
3940 * Add and remove tools based on configuration.
3942 OO
.ui
.ToolGroup
.prototype.populate = function () {
3943 var i
, len
, name
, tool
,
3944 toolFactory
= this.toolbar
.getToolFactory(),
3948 list
= this.toolbar
.getToolFactory().getTools(
3949 this.include
, this.exclude
, this.promote
, this.demote
3952 // Build a list of needed tools
3953 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
3957 toolFactory
.lookup( name
) &&
3958 // Tool is available or is already in this group
3959 ( this.toolbar
.isToolAvailable( name
) || this.tools
[name
] )
3961 tool
= this.tools
[name
];
3963 // Auto-initialize tools on first use
3964 this.tools
[name
] = tool
= toolFactory
.create( name
, this );
3967 this.toolbar
.reserveTool( tool
);
3972 // Remove tools that are no longer needed
3973 for ( name
in this.tools
) {
3974 if ( !names
[name
] ) {
3975 this.tools
[name
].destroy();
3976 this.toolbar
.releaseTool( this.tools
[name
] );
3977 remove
.push( this.tools
[name
] );
3978 delete this.tools
[name
];
3981 if ( remove
.length
) {
3982 this.removeItems( remove
);
3984 // Update emptiness state
3986 this.$element
.removeClass( 'oo-ui-toolGroup-empty' );
3988 this.$element
.addClass( 'oo-ui-toolGroup-empty' );
3990 // Re-add tools (moving existing ones to new locations)
3991 this.addItems( add
);
3992 // Disabled state may depend on items
3993 this.updateDisabled();
3997 * Destroy tool group.
3999 OO
.ui
.ToolGroup
.prototype.destroy = function () {
4003 this.toolbar
.getToolFactory().disconnect( this );
4004 for ( name
in this.tools
) {
4005 this.toolbar
.releaseTool( this.tools
[name
] );
4006 this.tools
[name
].disconnect( this ).destroy();
4007 delete this.tools
[name
];
4009 this.$element
.remove();
4012 * Factory for tool groups.
4015 * @extends OO.Factory
4018 OO
.ui
.ToolGroupFactory
= function OoUiToolGroupFactory() {
4019 // Parent constructor
4020 OO
.Factory
.call( this );
4023 defaultClasses
= this.constructor.static.getDefaultClasses();
4025 // Register default toolgroups
4026 for ( i
= 0, l
= defaultClasses
.length
; i
< l
; i
++ ) {
4027 this.register( defaultClasses
[i
] );
4033 OO
.inheritClass( OO
.ui
.ToolGroupFactory
, OO
.Factory
);
4035 /* Static Methods */
4038 * Get a default set of classes to be registered on construction
4040 * @return {Function[]} Default classes
4042 OO
.ui
.ToolGroupFactory
.static.getDefaultClasses = function () {
4045 OO
.ui
.ListToolGroup
,
4050 * Layout made of a fieldset and optional legend.
4052 * Just add OO.ui.FieldLayout items.
4055 * @extends OO.ui.Layout
4056 * @mixins OO.ui.LabeledElement
4057 * @mixins OO.ui.IconedElement
4058 * @mixins OO.ui.GroupElement
4061 * @param {Object} [config] Configuration options
4062 * @cfg {string} [icon] Symbolic icon name
4063 * @cfg {OO.ui.FieldLayout[]} [items] Items to add
4065 OO
.ui
.FieldsetLayout
= function OoUiFieldsetLayout( config
) {
4066 // Config initialization
4067 config
= config
|| {};
4069 // Parent constructor
4070 OO
.ui
.FieldsetLayout
.super.call( this, config
);
4072 // Mixin constructors
4073 OO
.ui
.IconedElement
.call( this, this.$( '<div>' ), config
);
4074 OO
.ui
.LabeledElement
.call( this, this.$( '<div>' ), config
);
4075 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
4079 .addClass( 'oo-ui-fieldsetLayout' )
4080 .prepend( this.$icon
, this.$label
, this.$group
);
4081 if ( $.isArray( config
.items
) ) {
4082 this.addItems( config
.items
);
4088 OO
.inheritClass( OO
.ui
.FieldsetLayout
, OO
.ui
.Layout
);
4089 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.IconedElement
);
4090 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.LabeledElement
);
4091 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.GroupElement
);
4093 /* Static Properties */
4095 OO
.ui
.FieldsetLayout
.static.tagName
= 'div';
4097 * Layout made of a field and optional label.
4100 * @extends OO.ui.Layout
4101 * @mixins OO.ui.LabeledElement
4103 * Available label alignment modes include:
4104 * - 'left': Label is before the field and aligned away from it, best for when the user will be
4105 * scanning for a specific label in a form with many fields
4106 * - 'right': Label is before the field and aligned toward it, best for forms the user is very
4107 * familiar with and will tab through field checking quickly to verify which field they are in
4108 * - 'top': Label is before the field and above it, best for when the use will need to fill out all
4109 * fields from top to bottom in a form with few fields
4110 * - 'inline': Label is after the field and aligned toward it, best for small boolean fields like
4111 * checkboxes or radio buttons
4114 * @param {OO.ui.Widget} field Field widget
4115 * @param {Object} [config] Configuration options
4116 * @cfg {string} [align='left'] Alignment mode, either 'left', 'right', 'top' or 'inline'
4118 OO
.ui
.FieldLayout
= function OoUiFieldLayout( field
, config
) {
4119 // Config initialization
4120 config
= $.extend( { 'align': 'left' }, config
);
4122 // Parent constructor
4123 OO
.ui
.FieldLayout
.super.call( this, config
);
4125 // Mixin constructors
4126 OO
.ui
.LabeledElement
.call( this, this.$( '<label>' ), config
);
4129 this.$field
= this.$( '<div>' );
4134 if ( this.field
instanceof OO
.ui
.InputWidget
) {
4135 this.$label
.on( 'click', OO
.ui
.bind( this.onLabelClick
, this ) );
4137 this.field
.connect( this, { 'disable': 'onFieldDisable' } );
4140 this.$element
.addClass( 'oo-ui-fieldLayout' );
4142 .addClass( 'oo-ui-fieldLayout-field' )
4143 .toggleClass( 'oo-ui-fieldLayout-disable', this.field
.isDisabled() )
4144 .append( this.field
.$element
);
4145 this.setAlignment( config
.align
);
4150 OO
.inheritClass( OO
.ui
.FieldLayout
, OO
.ui
.Layout
);
4151 OO
.mixinClass( OO
.ui
.FieldLayout
, OO
.ui
.LabeledElement
);
4156 * Handle field disable events.
4158 * @param {boolean} value Field is disabled
4160 OO
.ui
.FieldLayout
.prototype.onFieldDisable = function ( value
) {
4161 this.$element
.toggleClass( 'oo-ui-fieldLayout-disabled', value
);
4165 * Handle label mouse click events.
4167 * @param {jQuery.Event} e Mouse click event
4169 OO
.ui
.FieldLayout
.prototype.onLabelClick = function () {
4170 this.field
.simulateLabelClick();
4177 * @return {OO.ui.Widget} Field widget
4179 OO
.ui
.FieldLayout
.prototype.getField = function () {
4184 * Set the field alignment mode.
4186 * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
4189 OO
.ui
.FieldLayout
.prototype.setAlignment = function ( value
) {
4190 if ( value
!== this.align
) {
4191 // Default to 'left'
4192 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value
) === -1 ) {
4196 if ( value
=== 'inline' ) {
4197 this.$element
.append( this.$field
, this.$label
);
4199 this.$element
.append( this.$label
, this.$field
);
4203 this.$element
.removeClass( 'oo-ui-fieldLayout-align-' + this.align
);
4206 this.$element
.addClass( 'oo-ui-fieldLayout-align-' + this.align
);
4212 * Layout made of proportionally sized columns and rows.
4215 * @extends OO.ui.Layout
4218 * @param {OO.ui.PanelLayout[]} panels Panels in the grid
4219 * @param {Object} [config] Configuration options
4220 * @cfg {number[]} [widths] Widths of columns as ratios
4221 * @cfg {number[]} [heights] Heights of columns as ratios
4223 OO
.ui
.GridLayout
= function OoUiGridLayout( panels
, config
) {
4226 // Config initialization
4227 config
= config
|| {};
4229 // Parent constructor
4230 OO
.ui
.GridLayout
.super.call( this, config
);
4238 this.$element
.addClass( 'oo-ui-gridLayout' );
4239 for ( i
= 0, len
= panels
.length
; i
< len
; i
++ ) {
4240 this.panels
.push( panels
[i
] );
4241 this.$element
.append( panels
[i
].$element
);
4243 if ( config
.widths
|| config
.heights
) {
4244 this.layout( config
.widths
|| [ 1 ], config
.heights
|| [ 1 ] );
4246 // Arrange in columns by default
4248 for ( i
= 0, len
= this.panels
.length
; i
< len
; i
++ ) {
4251 this.layout( widths
, [ 1 ] );
4257 OO
.inheritClass( OO
.ui
.GridLayout
, OO
.ui
.Layout
);
4269 /* Static Properties */
4271 OO
.ui
.GridLayout
.static.tagName
= 'div';
4276 * Set grid dimensions.
4278 * @param {number[]} widths Widths of columns as ratios
4279 * @param {number[]} heights Heights of rows as ratios
4281 * @throws {Error} If grid is not large enough to fit all panels
4283 OO
.ui
.GridLayout
.prototype.layout = function ( widths
, heights
) {
4287 cols
= widths
.length
,
4288 rows
= heights
.length
;
4290 // Verify grid is big enough to fit panels
4291 if ( cols
* rows
< this.panels
.length
) {
4292 throw new Error( 'Grid is not large enough to fit ' + this.panels
.length
+ 'panels' );
4295 // Sum up denominators
4296 for ( x
= 0; x
< cols
; x
++ ) {
4299 for ( y
= 0; y
< rows
; y
++ ) {
4305 for ( x
= 0; x
< cols
; x
++ ) {
4306 this.widths
[x
] = widths
[x
] / xd
;
4308 for ( y
= 0; y
< rows
; y
++ ) {
4309 this.heights
[y
] = heights
[y
] / yd
;
4313 this.emit( 'layout' );
4317 * Update panel positions and sizes.
4321 OO
.ui
.GridLayout
.prototype.update = function () {
4329 cols
= this.widths
.length
,
4330 rows
= this.heights
.length
;
4332 for ( y
= 0; y
< rows
; y
++ ) {
4333 for ( x
= 0; x
< cols
; x
++ ) {
4334 panel
= this.panels
[i
];
4335 width
= this.widths
[x
];
4336 height
= this.heights
[y
];
4338 'width': Math
.round( width
* 100 ) + '%',
4339 'height': Math
.round( height
* 100 ) + '%',
4340 'top': Math
.round( top
* 100 ) + '%'
4343 if ( OO
.ui
.Element
.getDir( this.$.context
) === 'rtl' ) {
4344 dimensions
.right
= Math
.round( left
* 100 ) + '%';
4346 dimensions
.left
= Math
.round( left
* 100 ) + '%';
4348 panel
.$element
.css( dimensions
);
4356 this.emit( 'update' );
4360 * Get a panel at a given position.
4362 * The x and y position is affected by the current grid layout.
4364 * @param {number} x Horizontal position
4365 * @param {number} y Vertical position
4366 * @return {OO.ui.PanelLayout} The panel at the given postion
4368 OO
.ui
.GridLayout
.prototype.getPanel = function ( x
, y
) {
4369 return this.panels
[( x
* this.widths
.length
) + y
];
4372 * Layout containing a series of pages.
4375 * @extends OO.ui.Layout
4378 * @param {Object} [config] Configuration options
4379 * @cfg {boolean} [continuous=false] Show all pages, one after another
4380 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when changing to a page
4381 * @cfg {boolean} [outlined=false] Show an outline
4382 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
4383 * @cfg {Object[]} [adders] List of adders for controls, each with name, icon and title properties
4385 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
4386 // Initialize configuration
4387 config
= config
|| {};
4389 // Parent constructor
4390 OO
.ui
.BookletLayout
.super.call( this, config
);
4393 this.currentPageName
= null;
4395 this.ignoreFocus
= false;
4396 this.stackLayout
= new OO
.ui
.StackLayout( { '$': this.$, 'continuous': !!config
.continuous
} );
4397 this.autoFocus
= config
.autoFocus
=== undefined ? true : !!config
.autoFocus
;
4398 this.outlineVisible
= false;
4399 this.outlined
= !!config
.outlined
;
4400 if ( this.outlined
) {
4401 this.editable
= !!config
.editable
;
4402 this.adders
= config
.adders
|| null;
4403 this.outlineControlsWidget
= null;
4404 this.outlineWidget
= new OO
.ui
.OutlineWidget( { '$': this.$ } );
4405 this.outlinePanel
= new OO
.ui
.PanelLayout( { '$': this.$, 'scrollable': true } );
4406 this.gridLayout
= new OO
.ui
.GridLayout(
4407 [ this.outlinePanel
, this.stackLayout
],
4408 { '$': this.$, 'widths': [ 1, 2 ] }
4410 this.outlineVisible
= true;
4411 if ( this.editable
) {
4412 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
4414 { '$': this.$, 'adders': this.adders
}
4420 this.stackLayout
.connect( this, { 'set': 'onStackLayoutSet' } );
4421 if ( this.outlined
) {
4422 this.outlineWidget
.connect( this, { 'select': 'onOutlineWidgetSelect' } );
4424 if ( this.autoFocus
) {
4425 // Event 'focus' does not bubble, but 'focusin' does
4426 this.stackLayout
.onDOMEvent( 'focusin', OO
.ui
.bind( this.onStackLayoutFocus
, this ) );
4430 this.$element
.addClass( 'oo-ui-bookletLayout' );
4431 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
4432 if ( this.outlined
) {
4433 this.outlinePanel
.$element
4434 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
4435 .append( this.outlineWidget
.$element
);
4436 if ( this.editable
) {
4437 this.outlinePanel
.$element
4438 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
4439 .append( this.outlineControlsWidget
.$element
);
4441 this.$element
.append( this.gridLayout
.$element
);
4443 this.$element
.append( this.stackLayout
.$element
);
4449 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.Layout
);
4455 * @param {OO.ui.PageLayout} page Current page
4460 * @param {OO.ui.PageLayout[]} page Added pages
4461 * @param {number} index Index pages were added at
4466 * @param {OO.ui.PageLayout[]} pages Removed pages
4472 * Handle stack layout focus.
4474 * @param {jQuery.Event} e Focusin event
4476 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
4479 // Find the page that an element was focused within
4480 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
4481 for ( name
in this.pages
) {
4482 // Check for page match, exclude current page to find only page changes
4483 if ( this.pages
[name
].$element
[0] === $target
[0] && name
!== this.currentPageName
) {
4484 this.setPage( name
);
4491 * Handle stack layout set events.
4493 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
4495 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
4497 page
.scrollElementIntoView( { 'complete': OO
.ui
.bind( function () {
4498 if ( this.autoFocus
) {
4499 // Set focus to the first input if nothing on the page is focused yet
4500 if ( !page
.$element
.find( ':focus' ).length
) {
4501 page
.$element
.find( ':input:first' ).focus();
4509 * Handle outline widget select events.
4511 * @param {OO.ui.OptionWidget|null} item Selected item
4513 OO
.ui
.BookletLayout
.prototype.onOutlineWidgetSelect = function ( item
) {
4515 this.setPage( item
.getData() );
4520 * Check if booklet has an outline.
4524 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
4525 return this.outlined
;
4529 * Check if booklet has editing controls.
4533 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
4534 return this.editable
;
4538 * Check if booklet has a visible outline.
4542 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
4543 return this.outlined
&& this.outlineVisible
;
4547 * Hide or show the outline.
4549 * @param {boolean} [show] Show outline, omit to invert current state
4552 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
4553 if ( this.outlined
) {
4554 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
4555 this.outlineVisible
= show
;
4556 this.gridLayout
.layout( show
? [ 1, 2 ] : [ 0, 1 ], [ 1 ] );
4563 * Get the outline widget.
4565 * @param {OO.ui.PageLayout} page Page to be selected
4566 * @return {OO.ui.PageLayout|null} Closest page to another
4568 OO
.ui
.BookletLayout
.prototype.getClosestPage = function ( page
) {
4569 var next
, prev
, level
,
4570 pages
= this.stackLayout
.getItems(),
4571 index
= $.inArray( page
, pages
);
4573 if ( index
!== -1 ) {
4574 next
= pages
[index
+ 1];
4575 prev
= pages
[index
- 1];
4576 // Prefer adjacent pages at the same level
4577 if ( this.outlined
) {
4578 level
= this.outlineWidget
.getItemFromData( page
.getName() ).getLevel();
4581 level
=== this.outlineWidget
.getItemFromData( prev
.getName() ).getLevel()
4587 level
=== this.outlineWidget
.getItemFromData( next
.getName() ).getLevel()
4593 return prev
|| next
|| null;
4597 * Get the outline widget.
4599 * @return {OO.ui.OutlineWidget|null} Outline widget, or null if boolet has no outline
4601 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
4602 return this.outlineWidget
;
4606 * Get the outline controls widget. If the outline is not editable, null is returned.
4608 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
4610 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
4611 return this.outlineControlsWidget
;
4615 * Get a page by name.
4617 * @param {string} name Symbolic name of page
4618 * @return {OO.ui.PageLayout|undefined} Page, if found
4620 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
4621 return this.pages
[name
];
4625 * Get the current page name.
4627 * @return {string|null} Current page name
4629 OO
.ui
.BookletLayout
.prototype.getPageName = function () {
4630 return this.currentPageName
;
4634 * Add a page to the layout.
4636 * When pages are added with the same names as existing pages, the existing pages will be
4637 * automatically removed before the new pages are added.
4639 * @param {OO.ui.PageLayout[]} pages Pages to add
4640 * @param {number} index Index to insert pages after
4644 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
4645 var i
, len
, name
, page
, item
, currentIndex
,
4646 stackLayoutPages
= this.stackLayout
.getItems(),
4650 // Remove pages with same names
4651 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4653 name
= page
.getName();
4655 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
4656 // Correct the insertion index
4657 currentIndex
= $.inArray( this.pages
[name
], stackLayoutPages
);
4658 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
4661 remove
.push( this.pages
[name
] );
4664 if ( remove
.length
) {
4665 this.removePages( remove
);
4669 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4671 name
= page
.getName();
4672 this.pages
[page
.getName()] = page
;
4673 if ( this.outlined
) {
4674 item
= new OO
.ui
.OutlineItemWidget( name
, page
, { '$': this.$ } );
4675 page
.setOutlineItem( item
);
4680 if ( this.outlined
&& items
.length
) {
4681 this.outlineWidget
.addItems( items
, index
);
4682 this.updateOutlineWidget();
4684 this.stackLayout
.addItems( pages
, index
);
4685 this.emit( 'add', pages
, index
);
4691 * Remove a page from the layout.
4696 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
4697 var i
, len
, name
, page
,
4700 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4702 name
= page
.getName();
4703 delete this.pages
[name
];
4704 if ( this.outlined
) {
4705 items
.push( this.outlineWidget
.getItemFromData( name
) );
4706 page
.setOutlineItem( null );
4709 if ( this.outlined
&& items
.length
) {
4710 this.outlineWidget
.removeItems( items
);
4711 this.updateOutlineWidget();
4713 this.stackLayout
.removeItems( pages
);
4714 this.emit( 'remove', pages
);
4720 * Clear all pages from the layout.
4725 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
4727 pages
= this.stackLayout
.getItems();
4730 this.currentPageName
= null;
4731 if ( this.outlined
) {
4732 this.outlineWidget
.clearItems();
4733 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4734 pages
[i
].setOutlineItem( null );
4737 this.stackLayout
.clearItems();
4739 this.emit( 'remove', pages
);
4745 * Set the current page by name.
4748 * @param {string} name Symbolic name of page
4750 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
4752 page
= this.pages
[name
];
4754 if ( name
!== this.currentPageName
) {
4755 if ( this.outlined
) {
4756 selectedItem
= this.outlineWidget
.getSelectedItem();
4757 if ( selectedItem
&& selectedItem
.getData() !== name
) {
4758 this.outlineWidget
.selectItem( this.outlineWidget
.getItemFromData( name
) );
4762 if ( this.currentPageName
&& this.pages
[this.currentPageName
] ) {
4763 this.pages
[this.currentPageName
].setActive( false );
4764 // Blur anything focused if the next page doesn't have anything focusable - this
4765 // is not needed if the next page has something focusable because once it is focused
4766 // this blur happens automatically
4767 if ( this.autoFocus
&& !page
.$element
.find( ':input' ).length
) {
4768 this.pages
[this.currentPageName
].$element
.find( ':focus' ).blur();
4771 this.currentPageName
= name
;
4772 this.stackLayout
.setItem( page
);
4773 page
.setActive( true );
4774 this.emit( 'set', page
);
4780 * Call this after adding or removing items from the OutlineWidget.
4784 OO
.ui
.BookletLayout
.prototype.updateOutlineWidget = function () {
4785 // Auto-select first item when nothing is selected anymore
4786 if ( !this.outlineWidget
.getSelectedItem() ) {
4787 this.outlineWidget
.selectItem( this.outlineWidget
.getFirstSelectableItem() );
4793 * Layout that expands to cover the entire area of its parent, with optional scrolling and padding.
4796 * @extends OO.ui.Layout
4799 * @param {Object} [config] Configuration options
4800 * @cfg {boolean} [scrollable] Allow vertical scrolling
4801 * @cfg {boolean} [padded] Pad the content from the edges
4803 OO
.ui
.PanelLayout
= function OoUiPanelLayout( config
) {
4804 // Config initialization
4805 config
= config
|| {};
4807 // Parent constructor
4808 OO
.ui
.PanelLayout
.super.call( this, config
);
4811 this.$element
.addClass( 'oo-ui-panelLayout' );
4812 if ( config
.scrollable
) {
4813 this.$element
.addClass( 'oo-ui-panelLayout-scrollable' );
4816 if ( config
.padded
) {
4817 this.$element
.addClass( 'oo-ui-panelLayout-padded' );
4823 OO
.inheritClass( OO
.ui
.PanelLayout
, OO
.ui
.Layout
);
4825 * Page within an booklet layout.
4828 * @extends OO.ui.PanelLayout
4831 * @param {string} name Unique symbolic name of page
4832 * @param {Object} [config] Configuration options
4833 * @param {string} [outlineItem] Outline item widget
4835 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
4836 // Configuration initialization
4837 config
= $.extend( { 'scrollable': true }, config
);
4839 // Parent constructor
4840 OO
.ui
.PageLayout
.super.call( this, config
);
4844 this.outlineItem
= config
.outlineItem
|| null;
4845 this.active
= false;
4848 this.$element
.addClass( 'oo-ui-pageLayout' );
4853 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
4859 * @param {boolean} active Page is active
4867 * @return {string} Symbolic name of page
4869 OO
.ui
.PageLayout
.prototype.getName = function () {
4874 * Check if page is active.
4876 * @return {boolean} Page is active
4878 OO
.ui
.PageLayout
.prototype.isActive = function () {
4885 * @return {OO.ui.OutlineItemWidget|null} Outline item widget
4887 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
4888 return this.outlineItem
;
4894 * @param {OO.ui.OutlineItemWidget|null} outlineItem Outline item widget, null to clear
4897 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
4898 this.outlineItem
= outlineItem
;
4903 * Set page active state.
4905 * @param {boolean} Page is active
4908 OO
.ui
.PageLayout
.prototype.setActive = function ( active
) {
4911 if ( active
!== this.active
) {
4912 this.active
= active
;
4913 this.$element
.toggleClass( 'oo-ui-pageLayout-active', active
);
4914 this.emit( 'active', this.active
);
4918 * Layout containing a series of mutually exclusive pages.
4921 * @extends OO.ui.PanelLayout
4922 * @mixins OO.ui.GroupElement
4925 * @param {Object} [config] Configuration options
4926 * @cfg {boolean} [continuous=false] Show all pages, one after another
4927 * @cfg {string} [icon=''] Symbolic icon name
4928 * @cfg {OO.ui.Layout[]} [items] Layouts to add
4930 OO
.ui
.StackLayout
= function OoUiStackLayout( config
) {
4931 // Config initialization
4932 config
= $.extend( { 'scrollable': true }, config
);
4934 // Parent constructor
4935 OO
.ui
.StackLayout
.super.call( this, config
);
4937 // Mixin constructors
4938 OO
.ui
.GroupElement
.call( this, this.$element
, config
);
4941 this.currentItem
= null;
4942 this.continuous
= !!config
.continuous
;
4945 this.$element
.addClass( 'oo-ui-stackLayout' );
4946 if ( this.continuous
) {
4947 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
4949 if ( $.isArray( config
.items
) ) {
4950 this.addItems( config
.items
);
4956 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
4957 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.GroupElement
);
4963 * @param {OO.ui.Layout|null} item Current item or null if there is no longer a layout shown
4969 * Get the current item.
4971 * @return {OO.ui.Layout|null}
4973 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
4974 return this.currentItem
;
4978 * Unset the current item.
4981 * @param {OO.ui.StackLayout} layout
4984 OO
.ui
.StackLayout
.prototype.unsetCurrentItem = function () {
4985 var prevItem
= this.currentItem
;
4986 if ( prevItem
=== null ) {
4990 this.currentItem
= null;
4991 this.emit( 'set', null );
4997 * Adding an existing item (by value) will move it.
4999 * @param {OO.ui.Layout[]} items Items to add
5000 * @param {number} [index] Index to insert items after
5003 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
5005 OO
.ui
.GroupElement
.prototype.addItems
.call( this, items
, index
);
5007 if ( !this.currentItem
&& items
.length
) {
5008 this.setItem( items
[0] );
5017 * Items will be detached, not removed, so they can be used later.
5019 * @param {OO.ui.Layout[]} items Items to remove
5023 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
5025 OO
.ui
.GroupElement
.prototype.removeItems
.call( this, items
);
5027 if ( $.inArray( this.currentItem
, items
) !== -1 ) {
5028 if ( this.items
.length
) {
5029 this.setItem( this.items
[0] );
5031 this.unsetCurrentItem();
5041 * Items will be detached, not removed, so they can be used later.
5046 OO
.ui
.StackLayout
.prototype.clearItems = function () {
5047 this.unsetCurrentItem();
5048 OO
.ui
.GroupElement
.prototype.clearItems
.call( this );
5056 * Any currently shown item will be hidden.
5058 * FIXME: If the passed item to show has not been added in the items list, then
5059 * this method drops it and unsets the current item.
5061 * @param {OO.ui.Layout} item Item to show
5065 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
5068 if ( item
!== this.currentItem
) {
5069 if ( !this.continuous
) {
5070 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
5071 this.items
[i
].$element
.css( 'display', '' );
5074 if ( $.inArray( item
, this.items
) !== -1 ) {
5075 if ( !this.continuous
) {
5076 item
.$element
.css( 'display', 'block' );
5078 this.currentItem
= item
;
5079 this.emit( 'set', item
);
5081 this.unsetCurrentItem();
5088 * Horizontal bar layout of tools as icon buttons.
5091 * @extends OO.ui.ToolGroup
5094 * @param {OO.ui.Toolbar} toolbar
5095 * @param {Object} [config] Configuration options
5097 OO
.ui
.BarToolGroup
= function OoUiBarToolGroup( toolbar
, config
) {
5098 // Parent constructor
5099 OO
.ui
.BarToolGroup
.super.call( this, toolbar
, config
);
5102 this.$element
.addClass( 'oo-ui-barToolGroup' );
5107 OO
.inheritClass( OO
.ui
.BarToolGroup
, OO
.ui
.ToolGroup
);
5109 /* Static Properties */
5111 OO
.ui
.BarToolGroup
.static.titleTooltips
= true;
5113 OO
.ui
.BarToolGroup
.static.accelTooltips
= true;
5115 OO
.ui
.BarToolGroup
.static.name
= 'bar';
5117 * Popup list of tools with an icon and optional label.
5121 * @extends OO.ui.ToolGroup
5122 * @mixins OO.ui.IconedElement
5123 * @mixins OO.ui.IndicatedElement
5124 * @mixins OO.ui.LabeledElement
5125 * @mixins OO.ui.TitledElement
5126 * @mixins OO.ui.ClippableElement
5129 * @param {OO.ui.Toolbar} toolbar
5130 * @param {Object} [config] Configuration options
5131 * @cfg {string} [header] Text to display at the top of the pop-up
5133 OO
.ui
.PopupToolGroup
= function OoUiPopupToolGroup( toolbar
, config
) {
5134 // Configuration initialization
5135 config
= config
|| {};
5137 // Parent constructor
5138 OO
.ui
.PopupToolGroup
.super.call( this, toolbar
, config
);
5140 // Mixin constructors
5141 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
5142 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
5143 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
5144 OO
.ui
.TitledElement
.call( this, this.$element
, config
);
5145 OO
.ui
.ClippableElement
.call( this, this.$group
, config
);
5148 this.active
= false;
5149 this.dragging
= false;
5150 this.onBlurHandler
= OO
.ui
.bind( this.onBlur
, this );
5151 this.$handle
= this.$( '<span>' );
5155 'mousedown': OO
.ui
.bind( this.onHandleMouseDown
, this ),
5156 'mouseup': OO
.ui
.bind( this.onHandleMouseUp
, this )
5161 .addClass( 'oo-ui-popupToolGroup-handle' )
5162 .append( this.$icon
, this.$label
, this.$indicator
);
5163 // If the pop-up should have a header, add it to the top of the toolGroup.
5164 // Note: If this feature is useful for other widgets, we could abstract it into an
5165 // OO.ui.HeaderedElement mixin constructor.
5166 if ( config
.header
!== undefined ) {
5168 .prepend( this.$( '<span>' )
5169 .addClass( 'oo-ui-popupToolGroup-header' )
5170 .text( config
.header
)
5174 .addClass( 'oo-ui-popupToolGroup' )
5175 .prepend( this.$handle
);
5180 OO
.inheritClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ToolGroup
);
5181 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IconedElement
);
5182 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IndicatedElement
);
5183 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.LabeledElement
);
5184 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.TitledElement
);
5185 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ClippableElement
);
5187 /* Static Properties */
5194 OO
.ui
.PopupToolGroup
.prototype.setDisabled = function () {
5196 OO
.ui
.PopupToolGroup
.super.prototype.setDisabled
.apply( this, arguments
);
5198 if ( this.isDisabled() && this.isElementAttached() ) {
5199 this.setActive( false );
5204 * Handle focus being lost.
5206 * The event is actually generated from a mouseup, so it is not a normal blur event object.
5208 * @param {jQuery.Event} e Mouse up event
5210 OO
.ui
.PopupToolGroup
.prototype.onBlur = function ( e
) {
5211 // Only deactivate when clicking outside the dropdown element
5212 if ( this.$( e
.target
).closest( '.oo-ui-popupToolGroup' )[0] !== this.$element
[0] ) {
5213 this.setActive( false );
5220 OO
.ui
.PopupToolGroup
.prototype.onMouseUp = function ( e
) {
5221 if ( !this.isDisabled() && e
.which
=== 1 ) {
5222 this.setActive( false );
5224 return OO
.ui
.PopupToolGroup
.super.prototype.onMouseUp
.call( this, e
);
5228 * Handle mouse up events.
5230 * @param {jQuery.Event} e Mouse up event
5232 OO
.ui
.PopupToolGroup
.prototype.onHandleMouseUp = function () {
5237 * Handle mouse down events.
5239 * @param {jQuery.Event} e Mouse down event
5241 OO
.ui
.PopupToolGroup
.prototype.onHandleMouseDown = function ( e
) {
5242 if ( !this.isDisabled() && e
.which
=== 1 ) {
5243 this.setActive( !this.active
);
5249 * Switch into active mode.
5251 * When active, mouseup events anywhere in the document will trigger deactivation.
5253 OO
.ui
.PopupToolGroup
.prototype.setActive = function ( value
) {
5255 if ( this.active
!== value
) {
5256 this.active
= value
;
5258 this.setClipping( true );
5259 this.$element
.addClass( 'oo-ui-popupToolGroup-active' );
5260 this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler
, true );
5262 this.setClipping( false );
5263 this.$element
.removeClass( 'oo-ui-popupToolGroup-active' );
5264 this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler
, true );
5269 * Drop down list layout of tools as labeled icon buttons.
5272 * @extends OO.ui.PopupToolGroup
5275 * @param {OO.ui.Toolbar} toolbar
5276 * @param {Object} [config] Configuration options
5278 OO
.ui
.ListToolGroup
= function OoUiListToolGroup( toolbar
, config
) {
5279 // Parent constructor
5280 OO
.ui
.ListToolGroup
.super.call( this, toolbar
, config
);
5283 this.$element
.addClass( 'oo-ui-listToolGroup' );
5288 OO
.inheritClass( OO
.ui
.ListToolGroup
, OO
.ui
.PopupToolGroup
);
5290 /* Static Properties */
5292 OO
.ui
.ListToolGroup
.static.accelTooltips
= true;
5294 OO
.ui
.ListToolGroup
.static.name
= 'list';
5296 * Drop down menu layout of tools as selectable menu items.
5299 * @extends OO.ui.PopupToolGroup
5302 * @param {OO.ui.Toolbar} toolbar
5303 * @param {Object} [config] Configuration options
5305 OO
.ui
.MenuToolGroup
= function OoUiMenuToolGroup( toolbar
, config
) {
5306 // Configuration initialization
5307 config
= config
|| {};
5309 // Parent constructor
5310 OO
.ui
.MenuToolGroup
.super.call( this, toolbar
, config
);
5313 this.toolbar
.connect( this, { 'updateState': 'onUpdateState' } );
5316 this.$element
.addClass( 'oo-ui-menuToolGroup' );
5321 OO
.inheritClass( OO
.ui
.MenuToolGroup
, OO
.ui
.PopupToolGroup
);
5323 /* Static Properties */
5325 OO
.ui
.MenuToolGroup
.static.accelTooltips
= true;
5327 OO
.ui
.MenuToolGroup
.static.name
= 'menu';
5332 * Handle the toolbar state being updated.
5334 * When the state changes, the title of each active item in the menu will be joined together and
5335 * used as a label for the group. The label will be empty if none of the items are active.
5337 OO
.ui
.MenuToolGroup
.prototype.onUpdateState = function () {
5341 for ( name
in this.tools
) {
5342 if ( this.tools
[name
].isActive() ) {
5343 labelTexts
.push( this.tools
[name
].getTitle() );
5347 this.setLabel( labelTexts
.join( ', ' ) || ' ' );
5350 * Tool that shows a popup when selected.
5354 * @extends OO.ui.Tool
5355 * @mixins OO.ui.PopuppableElement
5358 * @param {OO.ui.Toolbar} toolbar
5359 * @param {Object} [config] Configuration options
5361 OO
.ui
.PopupTool
= function OoUiPopupTool( toolbar
, config
) {
5362 // Parent constructor
5363 OO
.ui
.PopupTool
.super.call( this, toolbar
, config
);
5365 // Mixin constructors
5366 OO
.ui
.PopuppableElement
.call( this, config
);
5370 .addClass( 'oo-ui-popupTool' )
5371 .append( this.popup
.$element
);
5376 OO
.inheritClass( OO
.ui
.PopupTool
, OO
.ui
.Tool
);
5377 OO
.mixinClass( OO
.ui
.PopupTool
, OO
.ui
.PopuppableElement
);
5382 * Handle the tool being selected.
5386 OO
.ui
.PopupTool
.prototype.onSelect = function () {
5387 if ( !this.isDisabled() ) {
5388 if ( this.popup
.isVisible() ) {
5394 this.setActive( false );
5399 * Handle the toolbar state being updated.
5403 OO
.ui
.PopupTool
.prototype.onUpdateState = function () {
5404 this.setActive( false );
5409 * Mixin for OO.ui.Widget subclasses.
5411 * Use together with OO.ui.ItemWidget to make disabled state inheritable.
5415 * @extends OO.ui.GroupElement
5418 * @param {jQuery} $group Container node, assigned to #$group
5419 * @param {Object} [config] Configuration options
5421 OO
.ui
.GroupWidget
= function OoUiGroupWidget( $element
, config
) {
5422 // Parent constructor
5423 OO
.ui
.GroupWidget
.super.call( this, $element
, config
);
5428 OO
.inheritClass( OO
.ui
.GroupWidget
, OO
.ui
.GroupElement
);
5433 * Set the disabled state of the widget.
5435 * This will also update the disabled state of child widgets.
5437 * @param {boolean} disabled Disable widget
5440 OO
.ui
.GroupWidget
.prototype.setDisabled = function ( disabled
) {
5444 // Note: Calling #setDisabled this way assumes this is mixed into an OO.ui.Widget
5445 OO
.ui
.Widget
.prototype.setDisabled
.call( this, disabled
);
5447 // During construction, #setDisabled is called before the OO.ui.GroupElement constructor
5449 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
5450 this.items
[i
].updateDisabled();
5459 * Use together with OO.ui.GroupWidget to make disabled state inheritable.
5466 OO
.ui
.ItemWidget
= function OoUiItemWidget() {
5473 * Check if widget is disabled.
5475 * Checks parent if present, making disabled state inheritable.
5477 * @return {boolean} Widget is disabled
5479 OO
.ui
.ItemWidget
.prototype.isDisabled = function () {
5480 return this.disabled
||
5481 ( this.elementGroup
instanceof OO
.ui
.Widget
&& this.elementGroup
.isDisabled() );
5485 * Set group element is in.
5487 * @param {OO.ui.GroupElement|null} group Group element, null if none
5490 OO
.ui
.ItemWidget
.prototype.setElementGroup = function ( group
) {
5492 // Note: Calling #setElementGroup this way assumes this is mixed into an OO.ui.Element
5493 OO
.ui
.Element
.prototype.setElementGroup
.call( this, group
);
5495 // Initialize item disabled states
5496 this.updateDisabled();
5504 * @extends OO.ui.Widget
5505 * @mixins OO.ui.IconedElement
5506 * @mixins OO.ui.TitledElement
5509 * @param {Object} [config] Configuration options
5511 OO
.ui
.IconWidget
= function OoUiIconWidget( config
) {
5512 // Config intialization
5513 config
= config
|| {};
5515 // Parent constructor
5516 OO
.ui
.IconWidget
.super.call( this, config
);
5518 // Mixin constructors
5519 OO
.ui
.IconedElement
.call( this, this.$element
, config
);
5520 OO
.ui
.TitledElement
.call( this, this.$element
, config
);
5523 this.$element
.addClass( 'oo-ui-iconWidget' );
5528 OO
.inheritClass( OO
.ui
.IconWidget
, OO
.ui
.Widget
);
5529 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.IconedElement
);
5530 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.TitledElement
);
5532 /* Static Properties */
5534 OO
.ui
.IconWidget
.static.tagName
= 'span';
5539 * @extends OO.ui.Widget
5540 * @mixins OO.ui.IndicatedElement
5541 * @mixins OO.ui.TitledElement
5544 * @param {Object} [config] Configuration options
5546 OO
.ui
.IndicatorWidget
= function OoUiIndicatorWidget( config
) {
5547 // Config intialization
5548 config
= config
|| {};
5550 // Parent constructor
5551 OO
.ui
.IndicatorWidget
.super.call( this, config
);
5553 // Mixin constructors
5554 OO
.ui
.IndicatedElement
.call( this, this.$element
, config
);
5555 OO
.ui
.TitledElement
.call( this, this.$element
, config
);
5558 this.$element
.addClass( 'oo-ui-indicatorWidget' );
5563 OO
.inheritClass( OO
.ui
.IndicatorWidget
, OO
.ui
.Widget
);
5564 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.IndicatedElement
);
5565 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.TitledElement
);
5567 /* Static Properties */
5569 OO
.ui
.IndicatorWidget
.static.tagName
= 'span';
5571 * Container for multiple related buttons.
5573 * Use together with OO.ui.ButtonWidget.
5576 * @extends OO.ui.Widget
5577 * @mixins OO.ui.GroupElement
5580 * @param {Object} [config] Configuration options
5581 * @cfg {OO.ui.ButtonWidget} [items] Buttons to add
5583 OO
.ui
.ButtonGroupWidget
= function OoUiButtonGroupWidget( config
) {
5584 // Parent constructor
5585 OO
.ui
.ButtonGroupWidget
.super.call( this, config
);
5587 // Mixin constructors
5588 OO
.ui
.GroupElement
.call( this, this.$element
, config
);
5591 this.$element
.addClass( 'oo-ui-buttonGroupWidget' );
5592 if ( $.isArray( config
.items
) ) {
5593 this.addItems( config
.items
);
5599 OO
.inheritClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.Widget
);
5600 OO
.mixinClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.GroupElement
);
5605 * @extends OO.ui.Widget
5606 * @mixins OO.ui.ButtonedElement
5607 * @mixins OO.ui.IconedElement
5608 * @mixins OO.ui.IndicatedElement
5609 * @mixins OO.ui.LabeledElement
5610 * @mixins OO.ui.TitledElement
5611 * @mixins OO.ui.FlaggableElement
5614 * @param {Object} [config] Configuration options
5615 * @cfg {string} [title=''] Title text
5616 * @cfg {string} [href] Hyperlink to visit when clicked
5617 * @cfg {string} [target] Target to open hyperlink in
5619 OO
.ui
.ButtonWidget
= function OoUiButtonWidget( config
) {
5620 // Configuration initialization
5621 config
= $.extend( { 'target': '_blank' }, config
);
5623 // Parent constructor
5624 OO
.ui
.ButtonWidget
.super.call( this, config
);
5626 // Mixin constructors
5627 OO
.ui
.ButtonedElement
.call( this, this.$( '<a>' ), config
);
5628 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
5629 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
5630 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
5631 OO
.ui
.TitledElement
.call( this, this.$button
, config
);
5632 OO
.ui
.FlaggableElement
.call( this, config
);
5635 this.isHyperlink
= typeof config
.href
=== 'string';
5639 'click': OO
.ui
.bind( this.onClick
, this ),
5640 'keypress': OO
.ui
.bind( this.onKeyPress
, this )
5645 .append( this.$icon
, this.$label
, this.$indicator
)
5646 .attr( { 'href': config
.href
, 'target': config
.target
} );
5648 .addClass( 'oo-ui-buttonWidget' )
5649 .append( this.$button
);
5654 OO
.inheritClass( OO
.ui
.ButtonWidget
, OO
.ui
.Widget
);
5655 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.ButtonedElement
);
5656 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IconedElement
);
5657 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IndicatedElement
);
5658 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.LabeledElement
);
5659 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.TitledElement
);
5660 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.FlaggableElement
);
5671 * Handles mouse click events.
5673 * @param {jQuery.Event} e Mouse click event
5676 OO
.ui
.ButtonWidget
.prototype.onClick = function () {
5677 if ( !this.isDisabled() ) {
5678 this.emit( 'click' );
5679 if ( this.isHyperlink
) {
5687 * Handles keypress events.
5689 * @param {jQuery.Event} e Keypress event
5692 OO
.ui
.ButtonWidget
.prototype.onKeyPress = function ( e
) {
5693 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
5695 if ( this.isHyperlink
) {
5706 * @extends OO.ui.Widget
5709 * @param {Object} [config] Configuration options
5710 * @cfg {string} [name=''] HTML input name
5711 * @cfg {string} [value=''] Input value
5712 * @cfg {boolean} [readOnly=false] Prevent changes
5713 * @cfg {Function} [inputFilter] Filter function to apply to the input. Takes a string argument and returns a string.
5715 OO
.ui
.InputWidget
= function OoUiInputWidget( config
) {
5716 // Config intialization
5717 config
= $.extend( { 'readOnly': false }, config
);
5719 // Parent constructor
5720 OO
.ui
.InputWidget
.super.call( this, config
);
5723 this.$input
= this.getInputElement( config
);
5725 this.readOnly
= false;
5726 this.inputFilter
= config
.inputFilter
;
5729 this.$input
.on( 'keydown mouseup cut paste change input select', OO
.ui
.bind( this.onEdit
, this ) );
5733 .attr( 'name', config
.name
)
5734 .prop( 'disabled', this.isDisabled() );
5735 this.setReadOnly( config
.readOnly
);
5736 this.$element
.addClass( 'oo-ui-inputWidget' ).append( this.$input
);
5737 this.setValue( config
.value
);
5742 OO
.inheritClass( OO
.ui
.InputWidget
, OO
.ui
.Widget
);
5754 * Get input element.
5756 * @param {Object} [config] Configuration options
5757 * @return {jQuery} Input element
5759 OO
.ui
.InputWidget
.prototype.getInputElement = function () {
5760 return this.$( '<input>' );
5764 * Handle potentially value-changing events.
5766 * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
5768 OO
.ui
.InputWidget
.prototype.onEdit = function () {
5769 if ( !this.isDisabled() ) {
5770 // Allow the stack to clear so the value will be updated
5771 setTimeout( OO
.ui
.bind( function () {
5772 this.setValue( this.$input
.val() );
5778 * Get the value of the input.
5780 * @return {string} Input value
5782 OO
.ui
.InputWidget
.prototype.getValue = function () {
5787 * Sets the direction of the current input, either RTL or LTR
5789 * @param {boolean} isRTL
5791 OO
.ui
.InputWidget
.prototype.setRTL = function ( isRTL
) {
5793 this.$input
.removeClass( 'oo-ui-ltr' );
5794 this.$input
.addClass( 'oo-ui-rtl' );
5796 this.$input
.removeClass( 'oo-ui-rtl' );
5797 this.$input
.addClass( 'oo-ui-ltr' );
5802 * Set the value of the input.
5804 * @param {string} value New value
5808 OO
.ui
.InputWidget
.prototype.setValue = function ( value
) {
5809 value
= this.sanitizeValue( value
);
5810 if ( this.value
!== value
) {
5812 this.emit( 'change', this.value
);
5814 // Update the DOM if it has changed. Note that with sanitizeValue, it
5815 // is possible for the DOM value to change without this.value changing.
5816 if ( this.$input
.val() !== this.value
) {
5817 this.$input
.val( this.value
);
5823 * Sanitize incoming value.
5825 * Ensures value is a string, and converts undefined and null to empty strings.
5827 * @param {string} value Original value
5828 * @return {string} Sanitized value
5830 OO
.ui
.InputWidget
.prototype.sanitizeValue = function ( value
) {
5831 if ( value
=== undefined || value
=== null ) {
5833 } else if ( this.inputFilter
) {
5834 return this.inputFilter( String( value
) );
5836 return String( value
);
5841 * Simulate the behavior of clicking on a label bound to this input.
5843 OO
.ui
.InputWidget
.prototype.simulateLabelClick = function () {
5844 if ( !this.isDisabled() ) {
5845 if ( this.$input
.is( ':checkbox,:radio' ) ) {
5846 this.$input
.click();
5847 } else if ( this.$input
.is( ':input' ) ) {
5848 this.$input
.focus();
5854 * Check if the widget is read-only.
5858 OO
.ui
.InputWidget
.prototype.isReadOnly = function () {
5859 return this.readOnly
;
5863 * Set the read-only state of the widget.
5865 * This should probably change the widgets's appearance and prevent it from being used.
5867 * @param {boolean} state Make input read-only
5870 OO
.ui
.InputWidget
.prototype.setReadOnly = function ( state
) {
5871 this.readOnly
= !!state
;
5872 this.$input
.prop( 'readOnly', this.readOnly
);
5879 OO
.ui
.InputWidget
.prototype.setDisabled = function ( state
) {
5880 OO
.ui
.InputWidget
.super.prototype.setDisabled
.call( this, state
);
5881 if ( this.$input
) {
5882 this.$input
.prop( 'disabled', this.isDisabled() );
5892 OO
.ui
.InputWidget
.prototype.focus = function () {
5893 this.$input
.focus();
5900 * @extends OO.ui.InputWidget
5903 * @param {Object} [config] Configuration options
5905 OO
.ui
.CheckboxInputWidget
= function OoUiCheckboxInputWidget( config
) {
5906 // Parent constructor
5907 OO
.ui
.CheckboxInputWidget
.super.call( this, config
);
5910 this.$element
.addClass( 'oo-ui-checkboxInputWidget' );
5915 OO
.inheritClass( OO
.ui
.CheckboxInputWidget
, OO
.ui
.InputWidget
);
5922 * Get input element.
5924 * @return {jQuery} Input element
5926 OO
.ui
.CheckboxInputWidget
.prototype.getInputElement = function () {
5927 return this.$( '<input type="checkbox" />' );
5931 * Get checked state of the checkbox
5933 * @return {boolean} If the checkbox is checked
5935 OO
.ui
.CheckboxInputWidget
.prototype.getValue = function () {
5942 OO
.ui
.CheckboxInputWidget
.prototype.setValue = function ( value
) {
5944 if ( this.value
!== value
) {
5946 this.$input
.prop( 'checked', this.value
);
5947 this.emit( 'change', this.value
);
5954 OO
.ui
.CheckboxInputWidget
.prototype.onEdit = function () {
5955 if ( !this.isDisabled() ) {
5956 // Allow the stack to clear so the value will be updated
5957 setTimeout( OO
.ui
.bind( function () {
5958 this.setValue( this.$input
.prop( 'checked' ) );
5966 * @extends OO.ui.Widget
5967 * @mixins OO.ui.LabeledElement
5970 * @param {Object} [config] Configuration options
5972 OO
.ui
.LabelWidget
= function OoUiLabelWidget( config
) {
5973 // Config intialization
5974 config
= config
|| {};
5976 // Parent constructor
5977 OO
.ui
.LabelWidget
.super.call( this, config
);
5979 // Mixin constructors
5980 OO
.ui
.LabeledElement
.call( this, this.$element
, config
);
5983 this.input
= config
.input
;
5986 if ( this.input
instanceof OO
.ui
.InputWidget
) {
5987 this.$element
.on( 'click', OO
.ui
.bind( this.onClick
, this ) );
5991 this.$element
.addClass( 'oo-ui-labelWidget' );
5996 OO
.inheritClass( OO
.ui
.LabelWidget
, OO
.ui
.Widget
);
5997 OO
.mixinClass( OO
.ui
.LabelWidget
, OO
.ui
.LabeledElement
);
5999 /* Static Properties */
6001 OO
.ui
.LabelWidget
.static.tagName
= 'label';
6006 * Handles label mouse click events.
6008 * @param {jQuery.Event} e Mouse click event
6010 OO
.ui
.LabelWidget
.prototype.onClick = function () {
6011 this.input
.simulateLabelClick();
6015 * Lookup input widget.
6017 * Mixin that adds a menu showing suggested values to a text input. Subclasses must handle `select`
6018 * and `choose` events on #lookupMenu to make use of selections.
6024 * @param {OO.ui.TextInputWidget} input Input widget
6025 * @param {Object} [config] Configuration options
6026 * @cfg {jQuery} [$overlay=this.$( 'body' )] Overlay layer
6028 OO
.ui
.LookupInputWidget
= function OoUiLookupInputWidget( input
, config
) {
6029 // Config intialization
6030 config
= config
|| {};
6033 this.lookupInput
= input
;
6034 this.$overlay
= config
.$overlay
|| this.$( 'body,.oo-ui-window-overlay' ).last();
6035 this.lookupMenu
= new OO
.ui
.TextInputMenuWidget( this, {
6036 '$': OO
.ui
.Element
.getJQuery( this.$overlay
),
6037 'input': this.lookupInput
,
6038 '$container': config
.$container
6040 this.lookupCache
= {};
6041 this.lookupQuery
= null;
6042 this.lookupRequest
= null;
6043 this.populating
= false;
6046 this.$overlay
.append( this.lookupMenu
.$element
);
6048 this.lookupInput
.$input
.on( {
6049 'focus': OO
.ui
.bind( this.onLookupInputFocus
, this ),
6050 'blur': OO
.ui
.bind( this.onLookupInputBlur
, this ),
6051 'mousedown': OO
.ui
.bind( this.onLookupInputMouseDown
, this )
6053 this.lookupInput
.connect( this, { 'change': 'onLookupInputChange' } );
6056 this.$element
.addClass( 'oo-ui-lookupWidget' );
6057 this.lookupMenu
.$element
.addClass( 'oo-ui-lookupWidget-menu' );
6063 * Handle input focus event.
6065 * @param {jQuery.Event} e Input focus event
6067 OO
.ui
.LookupInputWidget
.prototype.onLookupInputFocus = function () {
6068 this.openLookupMenu();
6072 * Handle input blur event.
6074 * @param {jQuery.Event} e Input blur event
6076 OO
.ui
.LookupInputWidget
.prototype.onLookupInputBlur = function () {
6077 this.lookupMenu
.hide();
6081 * Handle input mouse down event.
6083 * @param {jQuery.Event} e Input mouse down event
6085 OO
.ui
.LookupInputWidget
.prototype.onLookupInputMouseDown = function () {
6086 this.openLookupMenu();
6090 * Handle input change event.
6092 * @param {string} value New input value
6094 OO
.ui
.LookupInputWidget
.prototype.onLookupInputChange = function () {
6095 this.openLookupMenu();
6101 * @return {OO.ui.TextInputMenuWidget}
6103 OO
.ui
.LookupInputWidget
.prototype.getLookupMenu = function () {
6104 return this.lookupMenu
;
6112 OO
.ui
.LookupInputWidget
.prototype.openLookupMenu = function () {
6113 var value
= this.lookupInput
.getValue();
6115 if ( this.lookupMenu
.$input
.is( ':focus' ) && $.trim( value
) !== '' ) {
6116 this.populateLookupMenu();
6117 if ( !this.lookupMenu
.isVisible() ) {
6118 this.lookupMenu
.show();
6121 this.lookupMenu
.clearItems();
6122 this.lookupMenu
.hide();
6129 * Populate lookup menu with current information.
6133 OO
.ui
.LookupInputWidget
.prototype.populateLookupMenu = function () {
6134 if ( !this.populating
) {
6135 this.populating
= true;
6136 this.getLookupMenuItems()
6137 .done( OO
.ui
.bind( function ( items
) {
6138 this.lookupMenu
.clearItems();
6139 if ( items
.length
) {
6140 this.lookupMenu
.show();
6141 this.lookupMenu
.addItems( items
);
6142 this.initializeLookupMenuSelection();
6143 this.openLookupMenu();
6145 this.lookupMenu
.hide();
6147 this.populating
= false;
6149 .fail( OO
.ui
.bind( function () {
6150 this.lookupMenu
.clearItems();
6151 this.populating
= false;
6159 * Set selection in the lookup menu with current information.
6163 OO
.ui
.LookupInputWidget
.prototype.initializeLookupMenuSelection = function () {
6164 if ( !this.lookupMenu
.getSelectedItem() ) {
6165 this.lookupMenu
.selectItem( this.lookupMenu
.getFirstSelectableItem() );
6167 this.lookupMenu
.highlightItem( this.lookupMenu
.getSelectedItem() );
6171 * Get lookup menu items for the current query.
6173 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument
6176 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItems = function () {
6177 var value
= this.lookupInput
.getValue(),
6178 deferred
= $.Deferred();
6180 if ( value
&& value
!== this.lookupQuery
) {
6181 // Abort current request if query has changed
6182 if ( this.lookupRequest
) {
6183 this.lookupRequest
.abort();
6184 this.lookupQuery
= null;
6185 this.lookupRequest
= null;
6187 if ( value
in this.lookupCache
) {
6188 deferred
.resolve( this.getLookupMenuItemsFromData( this.lookupCache
[value
] ) );
6190 this.lookupQuery
= value
;
6191 this.lookupRequest
= this.getLookupRequest()
6192 .always( OO
.ui
.bind( function () {
6193 this.lookupQuery
= null;
6194 this.lookupRequest
= null;
6196 .done( OO
.ui
.bind( function ( data
) {
6197 this.lookupCache
[value
] = this.getLookupCacheItemFromData( data
);
6198 deferred
.resolve( this.getLookupMenuItemsFromData( this.lookupCache
[value
] ) );
6200 .fail( function () {
6204 this.lookupRequest
.always( OO
.ui
.bind( function () {
6209 return deferred
.promise();
6213 * Get a new request object of the current lookup query value.
6216 * @return {jqXHR} jQuery AJAX object, or promise object with an .abort() method
6218 OO
.ui
.LookupInputWidget
.prototype.getLookupRequest = function () {
6219 // Stub, implemented in subclass
6224 * Handle successful lookup request.
6226 * Overriding methods should call #populateLookupMenu when results are available and cache results
6227 * for future lookups in #lookupCache as an array of #OO.ui.MenuItemWidget objects.
6230 * @param {Mixed} data Response from server
6232 OO
.ui
.LookupInputWidget
.prototype.onLookupRequestDone = function () {
6233 // Stub, implemented in subclass
6237 * Get a list of menu item widgets from the data stored by the lookup request's done handler.
6240 * @param {Mixed} data Cached result data, usually an array
6241 * @return {OO.ui.MenuItemWidget[]} Menu items
6243 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItemsFromData = function () {
6244 // Stub, implemented in subclass
6250 * Use with OO.ui.SelectWidget.
6253 * @extends OO.ui.Widget
6254 * @mixins OO.ui.IconedElement
6255 * @mixins OO.ui.LabeledElement
6256 * @mixins OO.ui.IndicatedElement
6257 * @mixins OO.ui.FlaggableElement
6260 * @param {Mixed} data Option data
6261 * @param {Object} [config] Configuration options
6262 * @cfg {string} [rel] Value for `rel` attribute in DOM, allowing per-option styling
6264 OO
.ui
.OptionWidget
= function OoUiOptionWidget( data
, config
) {
6265 // Config intialization
6266 config
= config
|| {};
6268 // Parent constructor
6269 OO
.ui
.OptionWidget
.super.call( this, config
);
6271 // Mixin constructors
6272 OO
.ui
.ItemWidget
.call( this );
6273 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
6274 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
6275 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
6276 OO
.ui
.FlaggableElement
.call( this, config
);
6280 this.selected
= false;
6281 this.highlighted
= false;
6282 this.pressed
= false;
6286 .data( 'oo-ui-optionWidget', this )
6287 .attr( 'rel', config
.rel
)
6288 .addClass( 'oo-ui-optionWidget' )
6289 .append( this.$label
);
6291 .prepend( this.$icon
)
6292 .append( this.$indicator
);
6297 OO
.inheritClass( OO
.ui
.OptionWidget
, OO
.ui
.Widget
);
6298 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.ItemWidget
);
6299 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IconedElement
);
6300 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.LabeledElement
);
6301 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IndicatedElement
);
6302 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.FlaggableElement
);
6304 /* Static Properties */
6306 OO
.ui
.OptionWidget
.static.tagName
= 'li';
6308 OO
.ui
.OptionWidget
.static.selectable
= true;
6310 OO
.ui
.OptionWidget
.static.highlightable
= true;
6312 OO
.ui
.OptionWidget
.static.pressable
= true;
6314 OO
.ui
.OptionWidget
.static.scrollIntoViewOnSelect
= false;
6319 * Check if option can be selected.
6321 * @return {boolean} Item is selectable
6323 OO
.ui
.OptionWidget
.prototype.isSelectable = function () {
6324 return this.constructor.static.selectable
&& !this.isDisabled();
6328 * Check if option can be highlighted.
6330 * @return {boolean} Item is highlightable
6332 OO
.ui
.OptionWidget
.prototype.isHighlightable = function () {
6333 return this.constructor.static.highlightable
&& !this.isDisabled();
6337 * Check if option can be pressed.
6339 * @return {boolean} Item is pressable
6341 OO
.ui
.OptionWidget
.prototype.isPressable = function () {
6342 return this.constructor.static.pressable
&& !this.isDisabled();
6346 * Check if option is selected.
6348 * @return {boolean} Item is selected
6350 OO
.ui
.OptionWidget
.prototype.isSelected = function () {
6351 return this.selected
;
6355 * Check if option is highlighted.
6357 * @return {boolean} Item is highlighted
6359 OO
.ui
.OptionWidget
.prototype.isHighlighted = function () {
6360 return this.highlighted
;
6364 * Check if option is pressed.
6366 * @return {boolean} Item is pressed
6368 OO
.ui
.OptionWidget
.prototype.isPressed = function () {
6369 return this.pressed
;
6373 * Set selected state.
6375 * @param {boolean} [state=false] Select option
6378 OO
.ui
.OptionWidget
.prototype.setSelected = function ( state
) {
6379 if ( this.constructor.static.selectable
) {
6380 this.selected
= !!state
;
6381 if ( this.selected
) {
6382 this.$element
.addClass( 'oo-ui-optionWidget-selected' );
6383 if ( this.constructor.static.scrollIntoViewOnSelect
) {
6384 this.scrollElementIntoView();
6387 this.$element
.removeClass( 'oo-ui-optionWidget-selected' );
6394 * Set highlighted state.
6396 * @param {boolean} [state=false] Highlight option
6399 OO
.ui
.OptionWidget
.prototype.setHighlighted = function ( state
) {
6400 if ( this.constructor.static.highlightable
) {
6401 this.highlighted
= !!state
;
6402 if ( this.highlighted
) {
6403 this.$element
.addClass( 'oo-ui-optionWidget-highlighted' );
6405 this.$element
.removeClass( 'oo-ui-optionWidget-highlighted' );
6412 * Set pressed state.
6414 * @param {boolean} [state=false] Press option
6417 OO
.ui
.OptionWidget
.prototype.setPressed = function ( state
) {
6418 if ( this.constructor.static.pressable
) {
6419 this.pressed
= !!state
;
6420 if ( this.pressed
) {
6421 this.$element
.addClass( 'oo-ui-optionWidget-pressed' );
6423 this.$element
.removeClass( 'oo-ui-optionWidget-pressed' );
6430 * Make the option's highlight flash.
6432 * While flashing, the visual style of the pressed state is removed if present.
6434 * @return {jQuery.Promise} Promise resolved when flashing is done
6436 OO
.ui
.OptionWidget
.prototype.flash = function () {
6437 var $this = this.$element
,
6438 deferred
= $.Deferred();
6440 if ( !this.isDisabled() && this.constructor.static.pressable
) {
6441 $this.removeClass( 'oo-ui-optionWidget-highlighted oo-ui-optionWidget-pressed' );
6442 setTimeout( OO
.ui
.bind( function () {
6443 // Restore original classes
6445 .toggleClass( 'oo-ui-optionWidget-highlighted', this.highlighted
)
6446 .toggleClass( 'oo-ui-optionWidget-pressed', this.pressed
);
6447 setTimeout( function () {
6453 return deferred
.promise();
6459 * @return {Mixed} Option data
6461 OO
.ui
.OptionWidget
.prototype.getData = function () {
6465 * Selection of options.
6467 * Use together with OO.ui.OptionWidget.
6470 * @extends OO.ui.Widget
6471 * @mixins OO.ui.GroupElement
6474 * @param {Object} [config] Configuration options
6475 * @cfg {OO.ui.OptionWidget[]} [items] Options to add
6477 OO
.ui
.SelectWidget
= function OoUiSelectWidget( config
) {
6478 // Config intialization
6479 config
= config
|| {};
6481 // Parent constructor
6482 OO
.ui
.SelectWidget
.super.call( this, config
);
6484 // Mixin constructors
6485 OO
.ui
.GroupWidget
.call( this, this.$element
, config
);
6488 this.pressed
= false;
6489 this.selecting
= null;
6491 this.onMouseUpHandler
= OO
.ui
.bind( this.onMouseUp
, this );
6492 this.onMouseMoveHandler
= OO
.ui
.bind( this.onMouseMove
, this );
6496 'mousedown': OO
.ui
.bind( this.onMouseDown
, this ),
6497 'mouseover': OO
.ui
.bind( this.onMouseOver
, this ),
6498 'mouseleave': OO
.ui
.bind( this.onMouseLeave
, this )
6502 this.$element
.addClass( 'oo-ui-selectWidget oo-ui-selectWidget-depressed' );
6503 if ( $.isArray( config
.items
) ) {
6504 this.addItems( config
.items
);
6510 OO
.inheritClass( OO
.ui
.SelectWidget
, OO
.ui
.Widget
);
6512 // Need to mixin base class as well
6513 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupElement
);
6514 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupWidget
);
6520 * @param {OO.ui.OptionWidget|null} item Highlighted item
6525 * @param {OO.ui.OptionWidget|null} item Pressed item
6530 * @param {OO.ui.OptionWidget|null} item Selected item
6535 * @param {OO.ui.OptionWidget|null} item Chosen item
6540 * @param {OO.ui.OptionWidget[]} items Added items
6541 * @param {number} index Index items were added at
6546 * @param {OO.ui.OptionWidget[]} items Removed items
6549 /* Static Properties */
6551 OO
.ui
.SelectWidget
.static.tagName
= 'ul';
6556 * Handle mouse down events.
6559 * @param {jQuery.Event} e Mouse down event
6561 OO
.ui
.SelectWidget
.prototype.onMouseDown = function ( e
) {
6564 if ( !this.isDisabled() && e
.which
=== 1 ) {
6565 this.togglePressed( true );
6566 item
= this.getTargetItem( e
);
6567 if ( item
&& item
.isSelectable() ) {
6568 this.pressItem( item
);
6569 this.selecting
= item
;
6570 this.getElementDocument().addEventListener(
6571 'mouseup', this.onMouseUpHandler
, true
6573 this.getElementDocument().addEventListener(
6574 'mousemove', this.onMouseMoveHandler
, true
6582 * Handle mouse up events.
6585 * @param {jQuery.Event} e Mouse up event
6587 OO
.ui
.SelectWidget
.prototype.onMouseUp = function ( e
) {
6590 this.togglePressed( false );
6591 if ( !this.selecting
) {
6592 item
= this.getTargetItem( e
);
6593 if ( item
&& item
.isSelectable() ) {
6594 this.selecting
= item
;
6597 if ( !this.isDisabled() && e
.which
=== 1 && this.selecting
) {
6598 this.pressItem( null );
6599 this.chooseItem( this.selecting
);
6600 this.selecting
= null;
6603 this.getElementDocument().removeEventListener(
6604 'mouseup', this.onMouseUpHandler
, true
6606 this.getElementDocument().removeEventListener(
6607 'mousemove', this.onMouseMoveHandler
, true
6614 * Handle mouse move events.
6617 * @param {jQuery.Event} e Mouse move event
6619 OO
.ui
.SelectWidget
.prototype.onMouseMove = function ( e
) {
6622 if ( !this.isDisabled() && this.pressed
) {
6623 item
= this.getTargetItem( e
);
6624 if ( item
&& item
!== this.selecting
&& item
.isSelectable() ) {
6625 this.pressItem( item
);
6626 this.selecting
= item
;
6633 * Handle mouse over events.
6636 * @param {jQuery.Event} e Mouse over event
6638 OO
.ui
.SelectWidget
.prototype.onMouseOver = function ( e
) {
6641 if ( !this.isDisabled() ) {
6642 item
= this.getTargetItem( e
);
6643 this.highlightItem( item
&& item
.isHighlightable() ? item
: null );
6649 * Handle mouse leave events.
6652 * @param {jQuery.Event} e Mouse over event
6654 OO
.ui
.SelectWidget
.prototype.onMouseLeave = function () {
6655 if ( !this.isDisabled() ) {
6656 this.highlightItem( null );
6662 * Get the closest item to a jQuery.Event.
6665 * @param {jQuery.Event} e
6666 * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
6668 OO
.ui
.SelectWidget
.prototype.getTargetItem = function ( e
) {
6669 var $item
= this.$( e
.target
).closest( '.oo-ui-optionWidget' );
6670 if ( $item
.length
) {
6671 return $item
.data( 'oo-ui-optionWidget' );
6677 * Get selected item.
6679 * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
6681 OO
.ui
.SelectWidget
.prototype.getSelectedItem = function () {
6684 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6685 if ( this.items
[i
].isSelected() ) {
6686 return this.items
[i
];
6693 * Get highlighted item.
6695 * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
6697 OO
.ui
.SelectWidget
.prototype.getHighlightedItem = function () {
6700 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6701 if ( this.items
[i
].isHighlighted() ) {
6702 return this.items
[i
];
6709 * Get an existing item with equivilant data.
6711 * @param {Object} data Item data to search for
6712 * @return {OO.ui.OptionWidget|null} Item with equivilent value, `null` if none exists
6714 OO
.ui
.SelectWidget
.prototype.getItemFromData = function ( data
) {
6715 var hash
= OO
.getHash( data
);
6717 if ( hash
in this.hashes
) {
6718 return this.hashes
[hash
];
6725 * Toggle pressed state.
6727 * @param {boolean} pressed An option is being pressed
6729 OO
.ui
.SelectWidget
.prototype.togglePressed = function ( pressed
) {
6730 if ( pressed
=== undefined ) {
6731 pressed
= !this.pressed
;
6733 if ( pressed
!== this.pressed
) {
6734 this.$element
.toggleClass( 'oo-ui-selectWidget-pressed', pressed
);
6735 this.$element
.toggleClass( 'oo-ui-selectWidget-depressed', !pressed
);
6736 this.pressed
= pressed
;
6741 * Highlight an item.
6743 * Highlighting is mutually exclusive.
6745 * @param {OO.ui.OptionWidget} [item] Item to highlight, omit to deselect all
6749 OO
.ui
.SelectWidget
.prototype.highlightItem = function ( item
) {
6750 var i
, len
, highlighted
,
6753 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6754 highlighted
= this.items
[i
] === item
;
6755 if ( this.items
[i
].isHighlighted() !== highlighted
) {
6756 this.items
[i
].setHighlighted( highlighted
);
6761 this.emit( 'highlight', item
);
6770 * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
6774 OO
.ui
.SelectWidget
.prototype.selectItem = function ( item
) {
6775 var i
, len
, selected
,
6778 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6779 selected
= this.items
[i
] === item
;
6780 if ( this.items
[i
].isSelected() !== selected
) {
6781 this.items
[i
].setSelected( selected
);
6786 this.emit( 'select', item
);
6795 * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
6799 OO
.ui
.SelectWidget
.prototype.pressItem = function ( item
) {
6800 var i
, len
, pressed
,
6803 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6804 pressed
= this.items
[i
] === item
;
6805 if ( this.items
[i
].isPressed() !== pressed
) {
6806 this.items
[i
].setPressed( pressed
);
6811 this.emit( 'press', item
);
6820 * Identical to #selectItem, but may vary in subclasses that want to take additional action when
6821 * an item is selected using the keyboard or mouse.
6823 * @param {OO.ui.OptionWidget} item Item to choose
6827 OO
.ui
.SelectWidget
.prototype.chooseItem = function ( item
) {
6828 this.selectItem( item
);
6829 this.emit( 'choose', item
);
6835 * Get an item relative to another one.
6837 * @param {OO.ui.OptionWidget} item Item to start at
6838 * @param {number} direction Direction to move in
6839 * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the menu
6841 OO
.ui
.SelectWidget
.prototype.getRelativeSelectableItem = function ( item
, direction
) {
6842 var inc
= direction
> 0 ? 1 : -1,
6843 len
= this.items
.length
,
6844 index
= item
instanceof OO
.ui
.OptionWidget
?
6845 $.inArray( item
, this.items
) : ( inc
> 0 ? -1 : 0 ),
6846 stopAt
= Math
.max( Math
.min( index
, len
- 1 ), 0 ),
6848 // Default to 0 instead of -1, if nothing is selected let's start at the beginning
6849 Math
.max( index
, -1 ) :
6850 // Default to n-1 instead of -1, if nothing is selected let's start at the end
6851 Math
.min( index
, len
);
6854 i
= ( i
+ inc
+ len
) % len
;
6855 item
= this.items
[i
];
6856 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
6859 // Stop iterating when we've looped all the way around
6860 if ( i
=== stopAt
) {
6868 * Get the next selectable item.
6870 * @return {OO.ui.OptionWidget|null} Item, `null` if ther aren't any selectable items
6872 OO
.ui
.SelectWidget
.prototype.getFirstSelectableItem = function () {
6875 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6876 item
= this.items
[i
];
6877 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
6888 * When items are added with the same values as existing items, the existing items will be
6889 * automatically removed before the new items are added.
6891 * @param {OO.ui.OptionWidget[]} items Items to add
6892 * @param {number} [index] Index to insert items after
6896 OO
.ui
.SelectWidget
.prototype.addItems = function ( items
, index
) {
6897 var i
, len
, item
, hash
,
6900 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
6902 hash
= OO
.getHash( item
.getData() );
6903 if ( hash
in this.hashes
) {
6904 // Remove item with same value
6905 remove
.push( this.hashes
[hash
] );
6907 this.hashes
[hash
] = item
;
6909 if ( remove
.length
) {
6910 this.removeItems( remove
);
6914 OO
.ui
.GroupWidget
.prototype.addItems
.call( this, items
, index
);
6916 // Always provide an index, even if it was omitted
6917 this.emit( 'add', items
, index
=== undefined ? this.items
.length
- items
.length
- 1 : index
);
6925 * Items will be detached, not removed, so they can be used later.
6927 * @param {OO.ui.OptionWidget[]} items Items to remove
6931 OO
.ui
.SelectWidget
.prototype.removeItems = function ( items
) {
6932 var i
, len
, item
, hash
;
6934 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
6936 hash
= OO
.getHash( item
.getData() );
6937 if ( hash
in this.hashes
) {
6938 // Remove existing item
6939 delete this.hashes
[hash
];
6941 if ( item
.isSelected() ) {
6942 this.selectItem( null );
6947 OO
.ui
.GroupWidget
.prototype.removeItems
.call( this, items
);
6949 this.emit( 'remove', items
);
6957 * Items will be detached, not removed, so they can be used later.
6962 OO
.ui
.SelectWidget
.prototype.clearItems = function () {
6963 var items
= this.items
.slice();
6968 OO
.ui
.GroupWidget
.prototype.clearItems
.call( this );
6969 this.selectItem( null );
6971 this.emit( 'remove', items
);
6978 * Use with OO.ui.MenuWidget.
6981 * @extends OO.ui.OptionWidget
6984 * @param {Mixed} data Item data
6985 * @param {Object} [config] Configuration options
6987 OO
.ui
.MenuItemWidget
= function OoUiMenuItemWidget( data
, config
) {
6988 // Configuration initialization
6989 config
= $.extend( { 'icon': 'check' }, config
);
6991 // Parent constructor
6992 OO
.ui
.MenuItemWidget
.super.call( this, data
, config
);
6995 this.$element
.addClass( 'oo-ui-menuItemWidget' );
7000 OO
.inheritClass( OO
.ui
.MenuItemWidget
, OO
.ui
.OptionWidget
);
7004 * Use together with OO.ui.MenuItemWidget.
7007 * @extends OO.ui.SelectWidget
7008 * @mixins OO.ui.ClippableElement
7011 * @param {Object} [config] Configuration options
7012 * @cfg {OO.ui.InputWidget} [input] Input to bind keyboard handlers to
7013 * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu
7015 OO
.ui
.MenuWidget
= function OoUiMenuWidget( config
) {
7016 // Config intialization
7017 config
= config
|| {};
7019 // Parent constructor
7020 OO
.ui
.MenuWidget
.super.call( this, config
);
7022 // Mixin constructors
7023 OO
.ui
.ClippableElement
.call( this, this.$group
, config
);
7026 this.autoHide
= config
.autoHide
=== undefined || !!config
.autoHide
;
7027 this.newItems
= null;
7028 this.$input
= config
.input
? config
.input
.$input
: null;
7029 this.$previousFocus
= null;
7030 this.isolated
= !config
.input
;
7031 this.visible
= false;
7032 this.flashing
= false;
7033 this.onKeyDownHandler
= OO
.ui
.bind( this.onKeyDown
, this );
7034 this.onDocumentMouseDownHandler
= OO
.ui
.bind( this.onDocumentMouseDown
, this );
7037 this.$element
.hide().addClass( 'oo-ui-menuWidget' );
7042 OO
.inheritClass( OO
.ui
.MenuWidget
, OO
.ui
.SelectWidget
);
7043 OO
.mixinClass( OO
.ui
.MenuWidget
, OO
.ui
.ClippableElement
);
7048 * Handles document mouse down events.
7050 * @param {jQuery.Event} e Key down event
7052 OO
.ui
.MenuWidget
.prototype.onDocumentMouseDown = function ( e
) {
7053 if ( !$.contains( this.$element
[0], e
.target
) ) {
7059 * Handles key down events.
7061 * @param {jQuery.Event} e Key down event
7063 OO
.ui
.MenuWidget
.prototype.onKeyDown = function ( e
) {
7066 highlightItem
= this.getHighlightedItem();
7068 if ( !this.isDisabled() && this.visible
) {
7069 if ( !highlightItem
) {
7070 highlightItem
= this.getSelectedItem();
7072 switch ( e
.keyCode
) {
7073 case OO
.ui
.Keys
.ENTER
:
7074 this.chooseItem( highlightItem
);
7078 nextItem
= this.getRelativeSelectableItem( highlightItem
, -1 );
7081 case OO
.ui
.Keys
.DOWN
:
7082 nextItem
= this.getRelativeSelectableItem( highlightItem
, 1 );
7085 case OO
.ui
.Keys
.ESCAPE
:
7086 if ( highlightItem
) {
7087 highlightItem
.setHighlighted( false );
7095 this.highlightItem( nextItem
);
7096 nextItem
.scrollElementIntoView();
7101 e
.stopPropagation();
7108 * Check if the menu is visible.
7110 * @return {boolean} Menu is visible
7112 OO
.ui
.MenuWidget
.prototype.isVisible = function () {
7113 return this.visible
;
7117 * Bind key down listener.
7119 OO
.ui
.MenuWidget
.prototype.bindKeyDownListener = function () {
7120 if ( this.$input
) {
7121 this.$input
.on( 'keydown', this.onKeyDownHandler
);
7123 // Capture menu navigation keys
7124 this.getElementWindow().addEventListener( 'keydown', this.onKeyDownHandler
, true );
7129 * Unbind key down listener.
7131 OO
.ui
.MenuWidget
.prototype.unbindKeyDownListener = function () {
7132 if ( this.$input
) {
7133 this.$input
.off( 'keydown' );
7135 this.getElementWindow().removeEventListener( 'keydown', this.onKeyDownHandler
, true );
7142 * This will close the menu when done, unlike selectItem which only changes selection.
7144 * @param {OO.ui.OptionWidget} item Item to choose
7147 OO
.ui
.MenuWidget
.prototype.chooseItem = function ( item
) {
7149 OO
.ui
.MenuWidget
.super.prototype.chooseItem
.call( this, item
);
7151 if ( item
&& !this.flashing
) {
7152 this.flashing
= true;
7153 item
.flash().done( OO
.ui
.bind( function () {
7155 this.flashing
= false;
7167 * Adding an existing item (by value) will move it.
7169 * @param {OO.ui.MenuItemWidget[]} items Items to add
7170 * @param {number} [index] Index to insert items after
7173 OO
.ui
.MenuWidget
.prototype.addItems = function ( items
, index
) {
7177 OO
.ui
.MenuWidget
.super.prototype.addItems
.call( this, items
, index
);
7180 if ( !this.newItems
) {
7184 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
7186 if ( this.visible
) {
7187 // Defer fitting label until
7190 this.newItems
.push( item
);
7202 OO
.ui
.MenuWidget
.prototype.show = function () {
7205 if ( this.items
.length
) {
7206 this.$element
.show();
7207 this.visible
= true;
7208 this.bindKeyDownListener();
7210 // Change focus to enable keyboard navigation
7211 if ( this.isolated
&& this.$input
&& !this.$input
.is( ':focus' ) ) {
7212 this.$previousFocus
= this.$( ':focus' );
7213 this.$input
.focus();
7215 if ( this.newItems
&& this.newItems
.length
) {
7216 for ( i
= 0, len
= this.newItems
.length
; i
< len
; i
++ ) {
7217 this.newItems
[i
].fitLabel();
7219 this.newItems
= null;
7222 this.setClipping( true );
7225 if ( this.autoHide
) {
7226 this.getElementDocument().addEventListener(
7227 'mousedown', this.onDocumentMouseDownHandler
, true
7240 OO
.ui
.MenuWidget
.prototype.hide = function () {
7241 this.$element
.hide();
7242 this.visible
= false;
7243 this.unbindKeyDownListener();
7245 if ( this.isolated
&& this.$previousFocus
) {
7246 this.$previousFocus
.focus();
7247 this.$previousFocus
= null;
7250 this.getElementDocument().removeEventListener(
7251 'mousedown', this.onDocumentMouseDownHandler
, true
7254 this.setClipping( false );
7259 * Inline menu of options.
7261 * Use with OO.ui.MenuOptionWidget.
7264 * @extends OO.ui.Widget
7265 * @mixins OO.ui.IconedElement
7266 * @mixins OO.ui.IndicatedElement
7267 * @mixins OO.ui.LabeledElement
7268 * @mixins OO.ui.TitledElement
7271 * @param {Object} [config] Configuration options
7272 * @cfg {Object} [menu] Configuration options to pass to menu widget
7274 OO
.ui
.InlineMenuWidget
= function OoUiInlineMenuWidget( config
) {
7275 // Configuration initialization
7276 config
= $.extend( { 'indicator': 'down' }, config
);
7278 // Parent constructor
7279 OO
.ui
.InlineMenuWidget
.super.call( this, config
);
7281 // Mixin constructors
7282 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
7283 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
7284 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
7285 OO
.ui
.TitledElement
.call( this, this.$label
, config
);
7288 this.menu
= new OO
.ui
.MenuWidget( $.extend( { '$': this.$ }, config
.menu
) );
7289 this.$handle
= this.$( '<span>' );
7292 this.$element
.on( { 'click': OO
.ui
.bind( this.onClick
, this ) } );
7293 this.menu
.connect( this, { 'select': 'onMenuSelect' } );
7297 .addClass( 'oo-ui-inlineMenuWidget-handle' )
7298 .append( this.$icon
, this.$label
, this.$indicator
);
7300 .addClass( 'oo-ui-inlineMenuWidget' )
7301 .append( this.$handle
, this.menu
.$element
);
7306 OO
.inheritClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.Widget
);
7307 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.IconedElement
);
7308 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.IndicatedElement
);
7309 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.LabeledElement
);
7310 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.TitledElement
);
7317 * @return {OO.ui.MenuWidget} Menu of widget
7319 OO
.ui
.InlineMenuWidget
.prototype.getMenu = function () {
7324 * Handles menu select events.
7326 * @param {OO.ui.MenuItemWidget} item Selected menu item
7328 OO
.ui
.InlineMenuWidget
.prototype.onMenuSelect = function ( item
) {
7335 selectedLabel
= item
.getLabel();
7337 // If the label is a DOM element, clone it, because setLabel will append() it
7338 if ( selectedLabel
instanceof jQuery
) {
7339 selectedLabel
= selectedLabel
.clone();
7342 this.setLabel( selectedLabel
);
7346 * Handles mouse click events.
7348 * @param {jQuery.Event} e Mouse click event
7350 OO
.ui
.InlineMenuWidget
.prototype.onClick = function ( e
) {
7351 // Skip clicks within the menu
7352 if ( $.contains( this.menu
.$element
[0], e
.target
) ) {
7356 if ( !this.isDisabled() ) {
7357 if ( this.menu
.isVisible() ) {
7366 * Menu section item widget.
7368 * Use with OO.ui.MenuWidget.
7371 * @extends OO.ui.OptionWidget
7374 * @param {Mixed} data Item data
7375 * @param {Object} [config] Configuration options
7377 OO
.ui
.MenuSectionItemWidget
= function OoUiMenuSectionItemWidget( data
, config
) {
7378 // Parent constructor
7379 OO
.ui
.MenuSectionItemWidget
.super.call( this, data
, config
);
7382 this.$element
.addClass( 'oo-ui-menuSectionItemWidget' );
7387 OO
.inheritClass( OO
.ui
.MenuSectionItemWidget
, OO
.ui
.OptionWidget
);
7389 /* Static Properties */
7391 OO
.ui
.MenuSectionItemWidget
.static.selectable
= false;
7393 OO
.ui
.MenuSectionItemWidget
.static.highlightable
= false;
7395 * Create an OO.ui.OutlineWidget object.
7397 * Use with OO.ui.OutlineItemWidget.
7400 * @extends OO.ui.SelectWidget
7403 * @param {Object} [config] Configuration options
7405 OO
.ui
.OutlineWidget
= function OoUiOutlineWidget( config
) {
7406 // Config intialization
7407 config
= config
|| {};
7409 // Parent constructor
7410 OO
.ui
.OutlineWidget
.super.call( this, config
);
7413 this.$element
.addClass( 'oo-ui-outlineWidget' );
7418 OO
.inheritClass( OO
.ui
.OutlineWidget
, OO
.ui
.SelectWidget
);
7420 * Creates an OO.ui.OutlineControlsWidget object.
7422 * Use together with OO.ui.OutlineWidget.js
7427 * @param {OO.ui.OutlineWidget} outline Outline to control
7428 * @param {Object} [config] Configuration options
7430 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
7431 // Configuration initialization
7432 config
= $.extend( { 'icon': 'add-item' }, config
);
7434 // Parent constructor
7435 OO
.ui
.OutlineControlsWidget
.super.call( this, config
);
7437 // Mixin constructors
7438 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
7439 OO
.ui
.IconedElement
.call( this, this.$( '<div>' ), config
);
7442 this.outline
= outline
;
7443 this.$movers
= this.$( '<div>' );
7444 this.upButton
= new OO
.ui
.ButtonWidget( {
7448 'title': OO
.ui
.msg( 'ooui-outline-control-move-up' )
7450 this.downButton
= new OO
.ui
.ButtonWidget( {
7454 'title': OO
.ui
.msg( 'ooui-outline-control-move-down' )
7456 this.removeButton
= new OO
.ui
.ButtonWidget( {
7460 'title': OO
.ui
.msg( 'ooui-outline-control-remove' )
7464 outline
.connect( this, {
7465 'select': 'onOutlineChange',
7466 'add': 'onOutlineChange',
7467 'remove': 'onOutlineChange'
7469 this.upButton
.connect( this, { 'click': [ 'emit', 'move', -1 ] } );
7470 this.downButton
.connect( this, { 'click': [ 'emit', 'move', 1 ] } );
7471 this.removeButton
.connect( this, { 'click': [ 'emit', 'remove' ] } );
7474 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
7475 this.$group
.addClass( 'oo-ui-outlineControlsWidget-adders' );
7477 .addClass( 'oo-ui-outlineControlsWidget-movers' )
7478 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
7479 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
7484 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
7485 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.GroupElement
);
7486 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.IconedElement
);
7492 * @param {number} places Number of places to move
7502 * Handle outline change events.
7504 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
7505 var i
, len
, firstMovable
, lastMovable
,
7506 items
= this.outline
.getItems(),
7507 selectedItem
= this.outline
.getSelectedItem(),
7508 movable
= selectedItem
&& selectedItem
.isMovable(),
7509 removable
= selectedItem
&& selectedItem
.isRemovable();
7514 while ( ++i
< len
) {
7515 if ( items
[i
].isMovable() ) {
7516 firstMovable
= items
[i
];
7522 if ( items
[i
].isMovable() ) {
7523 lastMovable
= items
[i
];
7528 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
7529 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
7530 this.removeButton
.setDisabled( !removable
);
7533 * Creates an OO.ui.OutlineItemWidget object.
7535 * Use with OO.ui.OutlineWidget.
7538 * @extends OO.ui.OptionWidget
7541 * @param {Mixed} data Item data
7542 * @param {Object} [config] Configuration options
7543 * @cfg {number} [level] Indentation level
7544 * @cfg {boolean} [movable] Allow modification from outline controls
7546 OO
.ui
.OutlineItemWidget
= function OoUiOutlineItemWidget( data
, config
) {
7547 // Config intialization
7548 config
= config
|| {};
7550 // Parent constructor
7551 OO
.ui
.OutlineItemWidget
.super.call( this, data
, config
);
7555 this.movable
= !!config
.movable
;
7556 this.removable
= !!config
.removable
;
7559 this.$element
.addClass( 'oo-ui-outlineItemWidget' );
7560 this.setLevel( config
.level
);
7565 OO
.inheritClass( OO
.ui
.OutlineItemWidget
, OO
.ui
.OptionWidget
);
7567 /* Static Properties */
7569 OO
.ui
.OutlineItemWidget
.static.highlightable
= false;
7571 OO
.ui
.OutlineItemWidget
.static.scrollIntoViewOnSelect
= true;
7573 OO
.ui
.OutlineItemWidget
.static.levelClass
= 'oo-ui-outlineItemWidget-level-';
7575 OO
.ui
.OutlineItemWidget
.static.levels
= 3;
7580 * Check if item is movable.
7582 * Movablilty is used by outline controls.
7584 * @return {boolean} Item is movable
7586 OO
.ui
.OutlineItemWidget
.prototype.isMovable = function () {
7587 return this.movable
;
7591 * Check if item is removable.
7593 * Removablilty is used by outline controls.
7595 * @return {boolean} Item is removable
7597 OO
.ui
.OutlineItemWidget
.prototype.isRemovable = function () {
7598 return this.removable
;
7602 * Get indentation level.
7604 * @return {number} Indentation level
7606 OO
.ui
.OutlineItemWidget
.prototype.getLevel = function () {
7613 * Movablilty is used by outline controls.
7615 * @param {boolean} movable Item is movable
7618 OO
.ui
.OutlineItemWidget
.prototype.setMovable = function ( movable
) {
7619 this.movable
= !!movable
;
7626 * Removablilty is used by outline controls.
7628 * @param {boolean} movable Item is removable
7631 OO
.ui
.OutlineItemWidget
.prototype.setRemovable = function ( removable
) {
7632 this.removable
= !!removable
;
7637 * Set indentation level.
7639 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
7642 OO
.ui
.OutlineItemWidget
.prototype.setLevel = function ( level
) {
7643 var levels
= this.constructor.static.levels
,
7644 levelClass
= this.constructor.static.levelClass
,
7647 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
7649 if ( this.level
=== i
) {
7650 this.$element
.addClass( levelClass
+ i
);
7652 this.$element
.removeClass( levelClass
+ i
);
7659 * Option widget that looks like a button.
7661 * Use together with OO.ui.ButtonSelectWidget.
7664 * @extends OO.ui.OptionWidget
7665 * @mixins OO.ui.ButtonedElement
7666 * @mixins OO.ui.FlaggableElement
7669 * @param {Mixed} data Option data
7670 * @param {Object} [config] Configuration options
7672 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( data
, config
) {
7673 // Parent constructor
7674 OO
.ui
.ButtonOptionWidget
.super.call( this, data
, config
);
7676 // Mixin constructors
7677 OO
.ui
.ButtonedElement
.call( this, this.$( '<a>' ), config
);
7678 OO
.ui
.FlaggableElement
.call( this, config
);
7681 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
7682 this.$button
.append( this.$element
.contents() );
7683 this.$element
.append( this.$button
);
7688 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.OptionWidget
);
7689 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.ButtonedElement
);
7690 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.FlaggableElement
);
7692 /* Static Properties */
7694 // Allow button mouse down events to pass through so they can be handled by the parent select widget
7695 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
7702 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
7703 OO
.ui
.ButtonOptionWidget
.super.prototype.setSelected
.call( this, state
);
7705 if ( this.constructor.static.selectable
) {
7706 this.setActive( state
);
7712 * Select widget containing button options.
7714 * Use together with OO.ui.ButtonOptionWidget.
7717 * @extends OO.ui.SelectWidget
7720 * @param {Object} [config] Configuration options
7722 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
7723 // Parent constructor
7724 OO
.ui
.ButtonSelectWidget
.super.call( this, config
);
7727 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
7732 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
7734 * Container for content that is overlaid and positioned absolutely.
7737 * @extends OO.ui.Widget
7738 * @mixins OO.ui.LabeledElement
7741 * @param {Object} [config] Configuration options
7742 * @cfg {boolean} [tail=true] Show tail pointing to origin of popup
7743 * @cfg {string} [align='center'] Alignment of popup to origin
7744 * @cfg {jQuery} [$container] Container to prevent popup from rendering outside of
7745 * @cfg {boolean} [autoClose=false] Popup auto-closes when it loses focus
7746 * @cfg {jQuery} [$autoCloseIgnore] Elements to not auto close when clicked
7747 * @cfg {boolean} [head] Show label and close button at the top
7749 OO
.ui
.PopupWidget
= function OoUiPopupWidget( config
) {
7750 // Config intialization
7751 config
= config
|| {};
7753 // Parent constructor
7754 OO
.ui
.PopupWidget
.super.call( this, config
);
7756 // Mixin constructors
7757 OO
.ui
.LabeledElement
.call( this, this.$( '<div>' ), config
);
7758 OO
.ui
.ClippableElement
.call( this, this.$( '<div>' ), config
);
7761 this.visible
= false;
7762 this.$popup
= this.$( '<div>' );
7763 this.$head
= this.$( '<div>' );
7764 this.$body
= this.$clippable
;
7765 this.$tail
= this.$( '<div>' );
7766 this.$container
= config
.$container
|| this.$( 'body' );
7767 this.autoClose
= !!config
.autoClose
;
7768 this.$autoCloseIgnore
= config
.$autoCloseIgnore
;
7769 this.transitionTimeout
= null;
7771 this.align
= config
.align
|| 'center';
7772 this.closeButton
= new OO
.ui
.ButtonWidget( { '$': this.$, 'frameless': true, 'icon': 'close' } );
7773 this.onMouseDownHandler
= OO
.ui
.bind( this.onMouseDown
, this );
7776 this.closeButton
.connect( this, { 'click': 'onCloseButtonClick' } );
7779 this.useTail( config
.tail
!== undefined ? !!config
.tail
: true );
7780 this.$body
.addClass( 'oo-ui-popupWidget-body' );
7781 this.$tail
.addClass( 'oo-ui-popupWidget-tail' );
7783 .addClass( 'oo-ui-popupWidget-head' )
7784 .append( this.$label
, this.closeButton
.$element
);
7785 if ( !config
.head
) {
7789 .addClass( 'oo-ui-popupWidget-popup' )
7790 .append( this.$head
, this.$body
);
7791 this.$element
.hide()
7792 .addClass( 'oo-ui-popupWidget' )
7793 .append( this.$popup
, this.$tail
);
7798 OO
.inheritClass( OO
.ui
.PopupWidget
, OO
.ui
.Widget
);
7799 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.LabeledElement
);
7800 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.ClippableElement
);
7815 * Handles mouse down events.
7817 * @param {jQuery.Event} e Mouse down event
7819 OO
.ui
.PopupWidget
.prototype.onMouseDown = function ( e
) {
7822 !$.contains( this.$element
[0], e
.target
) &&
7823 ( !this.$autoCloseIgnore
|| !this.$autoCloseIgnore
.has( e
.target
).length
)
7830 * Bind mouse down listener.
7832 OO
.ui
.PopupWidget
.prototype.bindMouseDownListener = function () {
7833 // Capture clicks outside popup
7834 this.getElementWindow().addEventListener( 'mousedown', this.onMouseDownHandler
, true );
7838 * Handles close button click events.
7840 OO
.ui
.PopupWidget
.prototype.onCloseButtonClick = function () {
7841 if ( this.visible
) {
7847 * Unbind mouse down listener.
7849 OO
.ui
.PopupWidget
.prototype.unbindMouseDownListener = function () {
7850 this.getElementWindow().removeEventListener( 'mousedown', this.onMouseDownHandler
, true );
7854 * Check if the popup is visible.
7856 * @return {boolean} Popup is visible
7858 OO
.ui
.PopupWidget
.prototype.isVisible = function () {
7859 return this.visible
;
7863 * Set whether to show a tail.
7865 * @return {boolean} Make tail visible
7867 OO
.ui
.PopupWidget
.prototype.useTail = function ( value
) {
7869 if ( this.tail
!== value
) {
7872 this.$element
.addClass( 'oo-ui-popupWidget-tailed' );
7874 this.$element
.removeClass( 'oo-ui-popupWidget-tailed' );
7880 * Check if showing a tail.
7882 * @return {boolean} tail is visible
7884 OO
.ui
.PopupWidget
.prototype.hasTail = function () {
7894 OO
.ui
.PopupWidget
.prototype.show = function () {
7895 if ( !this.visible
) {
7896 this.setClipping( true );
7897 this.$element
.show();
7898 this.visible
= true;
7899 this.emit( 'show' );
7900 if ( this.autoClose
) {
7901 this.bindMouseDownListener();
7913 OO
.ui
.PopupWidget
.prototype.hide = function () {
7914 if ( this.visible
) {
7915 this.setClipping( false );
7916 this.$element
.hide();
7917 this.visible
= false;
7918 this.emit( 'hide' );
7919 if ( this.autoClose
) {
7920 this.unbindMouseDownListener();
7927 * Updates the position and size.
7929 * @param {number} width Width
7930 * @param {number} height Height
7931 * @param {boolean} [transition=false] Use a smooth transition
7934 OO
.ui
.PopupWidget
.prototype.display = function ( width
, height
, transition
) {
7936 originOffset
= Math
.round( this.$element
.offset().left
),
7937 containerLeft
= Math
.round( this.$container
.offset().left
),
7938 containerWidth
= this.$container
.innerWidth(),
7939 containerRight
= containerLeft
+ containerWidth
,
7940 popupOffset
= width
* ( { 'left': 0, 'center': -0.5, 'right': -1 } )[this.align
],
7941 popupLeft
= popupOffset
- padding
,
7942 popupRight
= popupOffset
+ padding
+ width
+ padding
,
7943 overlapLeft
= ( originOffset
+ popupLeft
) - containerLeft
,
7944 overlapRight
= containerRight
- ( originOffset
+ popupRight
);
7946 // Prevent transition from being interrupted
7947 clearTimeout( this.transitionTimeout
);
7949 // Enable transition
7950 this.$element
.addClass( 'oo-ui-popupWidget-transitioning' );
7953 if ( overlapRight
< 0 ) {
7954 popupOffset
+= overlapRight
;
7955 } else if ( overlapLeft
< 0 ) {
7956 popupOffset
-= overlapLeft
;
7959 // Position body relative to anchor and resize
7961 'left': popupOffset
,
7963 'height': height
=== undefined ? 'auto' : height
7967 // Prevent transitioning after transition is complete
7968 this.transitionTimeout
= setTimeout( OO
.ui
.bind( function () {
7969 this.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
7972 // Prevent transitioning immediately
7973 this.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
7979 * Button that shows and hides a popup.
7982 * @extends OO.ui.ButtonWidget
7983 * @mixins OO.ui.PopuppableElement
7986 * @param {Object} [config] Configuration options
7988 OO
.ui
.PopupButtonWidget
= function OoUiPopupButtonWidget( config
) {
7989 // Parent constructor
7990 OO
.ui
.PopupButtonWidget
.super.call( this, config
);
7992 // Mixin constructors
7993 OO
.ui
.PopuppableElement
.call( this, config
);
7997 .addClass( 'oo-ui-popupButtonWidget' )
7998 .append( this.popup
.$element
);
8003 OO
.inheritClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.ButtonWidget
);
8004 OO
.mixinClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.PopuppableElement
);
8009 * Handles mouse click events.
8011 * @param {jQuery.Event} e Mouse click event
8013 OO
.ui
.PopupButtonWidget
.prototype.onClick = function ( e
) {
8014 // Skip clicks within the popup
8015 if ( $.contains( this.popup
.$element
[0], e
.target
) ) {
8019 if ( !this.isDisabled() ) {
8020 if ( this.popup
.isVisible() ) {
8025 OO
.ui
.PopupButtonWidget
.super.prototype.onClick
.call( this );
8032 * Combines query and results selection widgets.
8035 * @extends OO.ui.Widget
8038 * @param {Object} [config] Configuration options
8039 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
8040 * @cfg {string} [value] Initial query value
8042 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
8043 // Configuration intialization
8044 config
= config
|| {};
8046 // Parent constructor
8047 OO
.ui
.SearchWidget
.super.call( this, config
);
8050 this.query
= new OO
.ui
.TextInputWidget( {
8053 'placeholder': config
.placeholder
,
8054 'value': config
.value
8056 this.results
= new OO
.ui
.SelectWidget( { '$': this.$ } );
8057 this.$query
= this.$( '<div>' );
8058 this.$results
= this.$( '<div>' );
8061 this.query
.connect( this, {
8062 'change': 'onQueryChange',
8063 'enter': 'onQueryEnter'
8065 this.results
.connect( this, {
8066 'highlight': 'onResultsHighlight',
8067 'select': 'onResultsSelect'
8069 this.query
.$input
.on( 'keydown', OO
.ui
.bind( this.onQueryKeydown
, this ) );
8073 .addClass( 'oo-ui-searchWidget-query' )
8074 .append( this.query
.$element
);
8076 .addClass( 'oo-ui-searchWidget-results' )
8077 .append( this.results
.$element
);
8079 .addClass( 'oo-ui-searchWidget' )
8080 .append( this.$results
, this.$query
);
8085 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
8091 * @param {Object|null} item Item data or null if no item is highlighted
8096 * @param {Object|null} item Item data or null if no item is selected
8102 * Handle query key down events.
8104 * @param {jQuery.Event} e Key down event
8106 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
8107 var highlightedItem
, nextItem
,
8108 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
8111 highlightedItem
= this.results
.getHighlightedItem();
8112 if ( !highlightedItem
) {
8113 highlightedItem
= this.results
.getSelectedItem();
8115 nextItem
= this.results
.getRelativeSelectableItem( highlightedItem
, dir
);
8116 this.results
.highlightItem( nextItem
);
8117 nextItem
.scrollElementIntoView();
8122 * Handle select widget select events.
8124 * Clears existing results. Subclasses should repopulate items according to new query.
8126 * @param {string} value New value
8128 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
8130 this.results
.clearItems();
8134 * Handle select widget enter key events.
8136 * Selects highlighted item.
8138 * @param {string} value New value
8140 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
8142 this.results
.selectItem( this.results
.getHighlightedItem() );
8146 * Handle select widget highlight events.
8148 * @param {OO.ui.OptionWidget} item Highlighted item
8151 OO
.ui
.SearchWidget
.prototype.onResultsHighlight = function ( item
) {
8152 this.emit( 'highlight', item
? item
.getData() : null );
8156 * Handle select widget select events.
8158 * @param {OO.ui.OptionWidget} item Selected item
8161 OO
.ui
.SearchWidget
.prototype.onResultsSelect = function ( item
) {
8162 this.emit( 'select', item
? item
.getData() : null );
8166 * Get the query input.
8168 * @return {OO.ui.TextInputWidget} Query input
8170 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
8175 * Get the results list.
8177 * @return {OO.ui.SelectWidget} Select list
8179 OO
.ui
.SearchWidget
.prototype.getResults = function () {
8180 return this.results
;
8183 * Text input widget.
8186 * @extends OO.ui.InputWidget
8189 * @param {Object} [config] Configuration options
8190 * @cfg {string} [placeholder] Placeholder text
8191 * @cfg {string} [icon] Symbolic name of icon
8192 * @cfg {boolean} [multiline=false] Allow multiple lines of text
8193 * @cfg {boolean} [autosize=false] Automatically resize to fit content
8194 * @cfg {boolean} [maxRows=10] Maximum number of rows to make visible when autosizing
8196 OO
.ui
.TextInputWidget
= function OoUiTextInputWidget( config
) {
8197 config
= $.extend( { 'maxRows': 10 }, config
);
8199 // Parent constructor
8200 OO
.ui
.TextInputWidget
.super.call( this, config
);
8204 this.multiline
= !!config
.multiline
;
8205 this.autosize
= !!config
.autosize
;
8206 this.maxRows
= config
.maxRows
;
8209 this.$input
.on( 'keypress', OO
.ui
.bind( this.onKeyPress
, this ) );
8210 this.$element
.on( 'DOMNodeInsertedIntoDocument', OO
.ui
.bind( this.onElementAttach
, this ) );
8213 this.$element
.addClass( 'oo-ui-textInputWidget' );
8214 if ( config
.icon
) {
8215 this.$element
.addClass( 'oo-ui-textInputWidget-decorated' );
8216 this.$element
.append(
8218 .addClass( 'oo-ui-textInputWidget-icon oo-ui-icon-' + config
.icon
)
8219 .mousedown( OO
.ui
.bind( function () {
8220 this.$input
.focus();
8225 if ( config
.placeholder
) {
8226 this.$input
.attr( 'placeholder', config
.placeholder
);
8232 OO
.inheritClass( OO
.ui
.TextInputWidget
, OO
.ui
.InputWidget
);
8237 * User presses enter inside the text box.
8239 * Not called if input is multiline.
8247 * Handle key press events.
8249 * @param {jQuery.Event} e Key press event
8250 * @fires enter If enter key is pressed and input is not multiline
8252 OO
.ui
.TextInputWidget
.prototype.onKeyPress = function ( e
) {
8253 if ( e
.which
=== OO
.ui
.Keys
.ENTER
&& !this.multiline
) {
8254 this.emit( 'enter' );
8259 * Handle element attach events.
8261 * @param {jQuery.Event} e Element attach event
8263 OO
.ui
.TextInputWidget
.prototype.onElementAttach = function () {
8270 OO
.ui
.TextInputWidget
.prototype.onEdit = function () {
8274 return OO
.ui
.TextInputWidget
.super.prototype.onEdit
.call( this );
8278 * Automatically adjust the size of the text input.
8280 * This only affects multi-line inputs that are auto-sized.
8284 OO
.ui
.TextInputWidget
.prototype.adjustSize = function () {
8285 var $clone
, scrollHeight
, innerHeight
, outerHeight
, maxInnerHeight
, idealHeight
;
8287 if ( this.multiline
&& this.autosize
) {
8288 $clone
= this.$input
.clone()
8289 .val( this.$input
.val() )
8290 .css( { 'height': 0 } )
8291 .insertAfter( this.$input
);
8292 // Set inline height property to 0 to measure scroll height
8293 scrollHeight
= $clone
[0].scrollHeight
;
8294 // Remove inline height property to measure natural heights
8295 $clone
.css( 'height', '' );
8296 innerHeight
= $clone
.innerHeight();
8297 outerHeight
= $clone
.outerHeight();
8298 // Measure max rows height
8299 $clone
.attr( 'rows', this.maxRows
).css( 'height', 'auto' );
8300 maxInnerHeight
= $clone
.innerHeight();
8301 $clone
.removeAttr( 'rows' ).css( 'height', '' );
8303 idealHeight
= Math
.min( maxInnerHeight
, scrollHeight
);
8304 // Only apply inline height when expansion beyond natural height is needed
8307 // Use the difference between the inner and outer height as a buffer
8308 idealHeight
> outerHeight
? idealHeight
+ ( outerHeight
- innerHeight
) : ''
8315 * Get input element.
8317 * @param {Object} [config] Configuration options
8318 * @return {jQuery} Input element
8320 OO
.ui
.TextInputWidget
.prototype.getInputElement = function ( config
) {
8321 return config
.multiline
? this.$( '<textarea>' ) : this.$( '<input type="text" />' );
8327 * Check if input supports multiple lines.
8331 OO
.ui
.TextInputWidget
.prototype.isMultiline = function () {
8332 return !!this.multiline
;
8336 * Check if input automatically adjusts its size.
8340 OO
.ui
.TextInputWidget
.prototype.isAutosizing = function () {
8341 return !!this.autosize
;
8345 * Check if input is pending.
8349 OO
.ui
.TextInputWidget
.prototype.isPending = function () {
8350 return !!this.pending
;
8354 * Increase the pending stack.
8358 OO
.ui
.TextInputWidget
.prototype.pushPending = function () {
8359 if ( this.pending
=== 0 ) {
8360 this.$element
.addClass( 'oo-ui-textInputWidget-pending' );
8361 this.$input
.addClass( 'oo-ui-texture-pending' );
8369 * Reduce the pending stack.
8375 OO
.ui
.TextInputWidget
.prototype.popPending = function () {
8376 if ( this.pending
=== 1 ) {
8377 this.$element
.removeClass( 'oo-ui-textInputWidget-pending' );
8378 this.$input
.removeClass( 'oo-ui-texture-pending' );
8380 this.pending
= Math
.max( 0, this.pending
- 1 );
8386 * Select the contents of the input.
8390 OO
.ui
.TextInputWidget
.prototype.select = function () {
8391 this.$input
.select();
8395 * Menu for a text input widget.
8398 * @extends OO.ui.MenuWidget
8401 * @param {OO.ui.TextInputWidget} input Text input widget to provide menu for
8402 * @param {Object} [config] Configuration options
8403 * @cfg {jQuery} [$container=input.$element] Element to render menu under
8405 OO
.ui
.TextInputMenuWidget
= function OoUiTextInputMenuWidget( input
, config
) {
8406 // Parent constructor
8407 OO
.ui
.TextInputMenuWidget
.super.call( this, config
);
8411 this.$container
= config
.$container
|| this.input
.$element
;
8412 this.onWindowResizeHandler
= OO
.ui
.bind( this.onWindowResize
, this );
8415 this.$element
.addClass( 'oo-ui-textInputMenuWidget' );
8420 OO
.inheritClass( OO
.ui
.TextInputMenuWidget
, OO
.ui
.MenuWidget
);
8425 * Handle window resize event.
8427 * @param {jQuery.Event} e Window resize event
8429 OO
.ui
.TextInputMenuWidget
.prototype.onWindowResize = function () {
8438 OO
.ui
.TextInputMenuWidget
.prototype.show = function () {
8440 OO
.ui
.TextInputMenuWidget
.super.prototype.show
.call( this );
8443 this.$( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler
);
8452 OO
.ui
.TextInputMenuWidget
.prototype.hide = function () {
8454 OO
.ui
.TextInputMenuWidget
.super.prototype.hide
.call( this );
8456 this.$( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler
);
8461 * Position the menu.
8465 OO
.ui
.TextInputMenuWidget
.prototype.position = function () {
8467 $container
= this.$container
,
8468 dimensions
= $container
.offset();
8470 // Position under input
8471 dimensions
.top
+= $container
.height();
8473 // Compensate for frame position if in a differnt frame
8474 if ( this.input
.$.frame
&& this.input
.$.context
!== this.$element
[0].ownerDocument
) {
8475 frameOffset
= OO
.ui
.Element
.getRelativePosition(
8476 this.input
.$.frame
.$element
, this.$element
.offsetParent()
8478 dimensions
.left
+= frameOffset
.left
;
8479 dimensions
.top
+= frameOffset
.top
;
8481 // Fix for RTL (for some reason, no need to fix if the frameoffset is set)
8482 if ( this.$element
.css( 'direction' ) === 'rtl' ) {
8483 dimensions
.right
= this.$element
.parent().position().left
-
8484 $container
.width() - dimensions
.left
;
8485 // Erase the value for 'left':
8486 delete dimensions
.left
;
8490 this.$element
.css( dimensions
);
8491 this.setIdealSize( $container
.width() );
8495 * Width with on and off states.
8497 * Mixin for widgets with a boolean state.
8503 * @param {Object} [config] Configuration options
8504 * @cfg {boolean} [value=false] Initial value
8506 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
8507 // Configuration initialization
8508 config
= config
|| {};
8514 this.$element
.addClass( 'oo-ui-toggleWidget' );
8515 this.setValue( !!config
.value
);
8522 * @param {boolean} value Changed value
8528 * Get the value of the toggle.
8532 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
8537 * Set the value of the toggle.
8539 * @param {boolean} value New value
8543 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
8545 if ( this.value
!== value
) {
8547 this.emit( 'change', value
);
8548 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
8549 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
8554 * Button that toggles on and off.
8557 * @extends OO.ui.ButtonWidget
8558 * @mixins OO.ui.ToggleWidget
8561 * @param {Object} [config] Configuration options
8562 * @cfg {boolean} [value=false] Initial value
8564 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
8565 // Configuration initialization
8566 config
= config
|| {};
8568 // Parent constructor
8569 OO
.ui
.ToggleButtonWidget
.super.call( this, config
);
8571 // Mixin constructors
8572 OO
.ui
.ToggleWidget
.call( this, config
);
8575 this.$element
.addClass( 'oo-ui-toggleButtonWidget' );
8580 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ButtonWidget
);
8581 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
8588 OO
.ui
.ToggleButtonWidget
.prototype.onClick = function () {
8589 if ( !this.isDisabled() ) {
8590 this.setValue( !this.value
);
8594 return OO
.ui
.ToggleButtonWidget
.super.prototype.onClick
.call( this );
8600 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
8602 if ( value
!== this.value
) {
8603 this.setActive( value
);
8606 // Parent method (from mixin)
8607 OO
.ui
.ToggleWidget
.prototype.setValue
.call( this, value
);
8612 * Switch that slides on and off.
8615 * @extends OO.ui.Widget
8616 * @mixins OO.ui.ToggleWidget
8619 * @param {Object} [config] Configuration options
8620 * @cfg {boolean} [value=false] Initial value
8622 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
8623 // Parent constructor
8624 OO
.ui
.ToggleSwitchWidget
.super.call( this, config
);
8626 // Mixin constructors
8627 OO
.ui
.ToggleWidget
.call( this, config
);
8630 this.dragging
= false;
8631 this.dragStart
= null;
8632 this.sliding
= false;
8633 this.$glow
= this.$( '<span>' );
8634 this.$grip
= this.$( '<span>' );
8637 this.$element
.on( 'click', OO
.ui
.bind( this.onClick
, this ) );
8640 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
8641 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
8643 .addClass( 'oo-ui-toggleSwitchWidget' )
8644 .append( this.$glow
, this.$grip
);
8649 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.Widget
);
8650 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
8655 * Handle mouse down events.
8657 * @param {jQuery.Event} e Mouse down event
8659 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
8660 if ( !this.isDisabled() && e
.which
=== 1 ) {
8661 this.setValue( !this.value
);