2 * OOjs UI v0.1.0-pre (521a9e242b)
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: Mon May 19 2014 10:42:43 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 );
746 this.loading
= false;
748 this.config
= config
;
752 .addClass( 'oo-ui-frame' )
753 .attr( { 'frameborder': 0, 'scrolling': 'no' } );
759 OO
.inheritClass( OO
.ui
.Frame
, OO
.ui
.Element
);
760 OO
.mixinClass( OO
.ui
.Frame
, OO
.EventEmitter
);
762 /* Static Properties */
768 OO
.ui
.Frame
.static.tagName
= 'iframe';
779 * Transplant the CSS styles from as parent document to a frame's document.
781 * This loops over the style sheets in the parent document, and copies their nodes to the
782 * frame's document. It then polls the document to see when all styles have loaded, and once they
783 * have, invokes the callback.
785 * If the styles still haven't loaded after a long time (5 seconds by default), we give up waiting
786 * and invoke the callback anyway. This protects against cases like a display: none; iframe in
787 * Firefox, where the styles won't load until the iframe becomes visible.
789 * For details of how we arrived at the strategy used in this function, see #load.
793 * @param {HTMLDocument} parentDoc Document to transplant styles from
794 * @param {HTMLDocument} frameDoc Document to transplant styles to
795 * @param {Function} [callback] Callback to execute once styles have loaded
796 * @param {number} [timeout=5000] How long to wait before giving up (in ms). If 0, never give up.
798 OO
.ui
.Frame
.static.transplantStyles = function ( parentDoc
, frameDoc
, callback
, timeout
) {
799 var i
, numSheets
, styleNode
, newNode
, timeoutID
, pollNodeId
, $pendingPollNodes
,
800 $pollNodes
= $( [] ),
801 // Fake font-family value
802 fontFamily
= 'oo-ui-frame-transplantStyles-loaded';
804 for ( i
= 0, numSheets
= parentDoc
.styleSheets
.length
; i
< numSheets
; i
++ ) {
805 styleNode
= parentDoc
.styleSheets
[i
].ownerNode
;
806 if ( callback
&& 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
);
829 // Poll every 100ms until all external stylesheets have loaded
830 $pendingPollNodes
= $pollNodes
;
831 timeoutID
= setTimeout( function pollExternalStylesheets() {
833 $pendingPollNodes
.length
> 0 &&
834 $pendingPollNodes
.eq( 0 ).css( 'font-family' ) === fontFamily
836 $pendingPollNodes
= $pendingPollNodes
.slice( 1 );
839 if ( $pendingPollNodes
.length
=== 0 ) {
841 if ( timeoutID
!== null ) {
847 timeoutID
= setTimeout( pollExternalStylesheets
, 100 );
850 // ...but give up after a while
851 if ( timeout
!== 0 ) {
852 setTimeout( function () {
854 clearTimeout( timeoutID
);
859 }, timeout
|| 5000 );
867 * Load the frame contents.
869 * Once the iframe's stylesheets are loaded, the `initialize` event will be emitted.
871 * Sounds simple right? Read on...
873 * When you create a dynamic iframe using open/write/close, the window.load event for the
874 * iframe is triggered when you call close, and there's no further load event to indicate that
875 * everything is actually loaded.
877 * In Chrome, stylesheets don't show up in document.styleSheets until they have loaded, so we could
878 * just poll that array and wait for it to have the right length. However, in Firefox, stylesheets
879 * are added to document.styleSheets immediately, and the only way you can determine whether they've
880 * loaded is to attempt to access .cssRules and wait for that to stop throwing an exception. But
881 * cross-domain stylesheets never allow .cssRules to be accessed even after they have loaded.
883 * The workaround is to change all `<link href="...">` tags to `<style>@import url(...)</style>` tags.
884 * Because `@import` is blocking, Chrome won't add the stylesheet to document.styleSheets until
885 * the `@import` has finished, and Firefox won't allow .cssRules to be accessed until the `@import`
886 * has finished. And because the contents of the `<style>` tag are from the same origin, accessing
887 * .cssRules is allowed.
889 * However, now that we control the styles we're injecting, we might as well do away with
890 * browser-specific polling hacks like document.styleSheets and .cssRules, and instead inject
891 * `<style>@import url(...); #foo { font-family: someValue; }</style>`, then create `<div id="foo">`
892 * and wait for its font-family to change to someValue. Because `@import` is blocking, the font-family
893 * rule is not applied until after the `@import` finishes.
895 * All this stylesheet injection and polling magic is in #transplantStyles.
900 OO
.ui
.Frame
.prototype.load = function () {
901 var win
= this.$element
.prop( 'contentWindow' ),
907 // Figure out directionality:
908 this.dir
= this.$element
.closest( '[dir]' ).prop( 'dir' ) || 'ltr';
910 // Initialize contents
915 '<body class="oo-ui-frame-body oo-ui-' + this.dir
+ '" style="direction:' + this.dir
+ ';" dir="' + this.dir
+ '">' +
916 '<div class="oo-ui-frame-content"></div>' +
923 this.$ = OO
.ui
.Element
.getJQuery( doc
, this );
924 this.$content
= this.$( '.oo-ui-frame-content' ).attr( 'tabIndex', 0 );
925 this.$document
= this.$( doc
);
927 this.constructor.static.transplantStyles(
928 this.getElementDocument(),
931 frame
.loading
= false;
933 frame
.emit( 'load' );
939 * Run a callback as soon as the frame has been loaded.
942 * This will start loading if it hasn't already, and runs
943 * immediately if the frame is already loaded.
945 * Don't call this until the element is attached.
947 * @param {Function} callback
949 OO
.ui
.Frame
.prototype.run = function ( callback
) {
953 if ( !this.loading
) {
956 this.once( 'load', callback
);
961 * Set the size of the frame.
963 * @param {number} width Frame width in pixels
964 * @param {number} height Frame height in pixels
967 OO
.ui
.Frame
.prototype.setSize = function ( width
, height
) {
968 this.$element
.css( { 'width': width
, 'height': height
} );
972 * Container for elements in a child frame.
974 * There are two ways to specify a title: set the static `title` property or provide a `title`
975 * property in the configuration options. The latter will override the former.
979 * @extends OO.ui.Element
980 * @mixins OO.EventEmitter
983 * @param {Object} [config] Configuration options
984 * @cfg {string|Function} [title] Title string or function that returns a string
985 * @cfg {string} [icon] Symbolic name of icon
988 OO
.ui
.Window
= function OoUiWindow( config
) {
990 // Parent constructor
991 OO
.ui
.Window
.super.call( this, config
);
993 // Mixin constructors
994 OO
.EventEmitter
.call( this );
997 this.visible
= false;
998 this.opening
= false;
999 this.closing
= false;
1000 this.title
= OO
.ui
.resolveMsg( config
.title
|| this.constructor.static.title
);
1001 this.icon
= config
.icon
|| this.constructor.static.icon
;
1002 this.frame
= new OO
.ui
.Frame( { '$': this.$ } );
1003 this.$frame
= this.$( '<div>' );
1004 this.$ = function () {
1005 throw new Error( 'this.$() cannot be used until the frame has been initialized.' );
1010 .addClass( 'oo-ui-window' )
1011 // Hide the window using visibility: hidden; while the iframe is still loading
1012 // Can't use display: none; because that prevents the iframe from loading in Firefox
1013 .css( 'visibility', 'hidden' )
1014 .append( this.$frame
);
1016 .addClass( 'oo-ui-window-frame' )
1017 .append( this.frame
.$element
);
1020 this.frame
.on( 'load', function () {
1021 element
.initialize();
1022 // Undo the visibility: hidden; hack and apply display: none;
1023 // We can do this safely now that the iframe has initialized
1024 // (don't do this from within #initialize because it has to happen
1025 // after the all subclasses have been handled as well).
1026 element
.$element
.hide().css( 'visibility', '' );
1032 OO
.inheritClass( OO
.ui
.Window
, OO
.ui
.Element
);
1033 OO
.mixinClass( OO
.ui
.Window
, OO
.EventEmitter
);
1038 * Initialize contents.
1040 * Fired asynchronously after construction when iframe is ready.
1048 * Fired after window has been opened.
1051 * @param {Object} data Window opening data
1057 * Fired after window has been closed.
1060 * @param {Object} data Window closing data
1063 /* Static Properties */
1066 * Symbolic name of icon.
1070 * @property {string}
1072 OO
.ui
.Window
.static.icon
= 'window';
1077 * Subclasses must implement this property before instantiating the window.
1078 * Alternatively, override #getTitle with an alternative implementation.
1083 * @property {string|Function} Title string or function that returns a string
1085 OO
.ui
.Window
.static.title
= null;
1090 * Check if window is visible.
1092 * @return {boolean} Window is visible
1094 OO
.ui
.Window
.prototype.isVisible = function () {
1095 return this.visible
;
1099 * Check if window is opening.
1101 * @return {boolean} Window is opening
1103 OO
.ui
.Window
.prototype.isOpening = function () {
1104 return this.opening
;
1108 * Check if window is closing.
1110 * @return {boolean} Window is closing
1112 OO
.ui
.Window
.prototype.isClosing = function () {
1113 return this.closing
;
1117 * Get the window frame.
1119 * @return {OO.ui.Frame} Frame of window
1121 OO
.ui
.Window
.prototype.getFrame = function () {
1126 * Get the title of the window.
1128 * @return {string} Title text
1130 OO
.ui
.Window
.prototype.getTitle = function () {
1135 * Get the window icon.
1137 * @return {string} Symbolic name of icon
1139 OO
.ui
.Window
.prototype.getIcon = function () {
1144 * Set the size of window frame.
1146 * @param {number} [width=auto] Custom width
1147 * @param {number} [height=auto] Custom height
1150 OO
.ui
.Window
.prototype.setSize = function ( width
, height
) {
1151 if ( !this.frame
.$content
) {
1155 this.frame
.$element
.css( {
1156 'width': width
=== undefined ? 'auto' : width
,
1157 'height': height
=== undefined ? 'auto' : height
1164 * Set the title of the window.
1166 * @param {string|Function} title Title text or a function that returns text
1169 OO
.ui
.Window
.prototype.setTitle = function ( title
) {
1170 this.title
= OO
.ui
.resolveMsg( title
);
1171 if ( this.$title
) {
1172 this.$title
.text( title
);
1178 * Set the icon of the window.
1180 * @param {string} icon Symbolic name of icon
1183 OO
.ui
.Window
.prototype.setIcon = function ( icon
) {
1185 this.$icon
.removeClass( 'oo-ui-icon-' + this.icon
);
1189 this.$icon
.addClass( 'oo-ui-icon-' + this.icon
);
1196 * Set the position of window to fit with contents.
1198 * @param {string} left Left offset
1199 * @param {string} top Top offset
1202 OO
.ui
.Window
.prototype.setPosition = function ( left
, top
) {
1203 this.$element
.css( { 'left': left
, 'top': top
} );
1208 * Set the height of window to fit with contents.
1210 * @param {number} [min=0] Min height
1211 * @param {number} [max] Max height (defaults to content's outer height)
1214 OO
.ui
.Window
.prototype.fitHeightToContents = function ( min
, max
) {
1215 var height
= this.frame
.$content
.outerHeight();
1217 this.frame
.$element
.css(
1218 'height', Math
.max( min
|| 0, max
=== undefined ? height
: Math
.min( max
, height
) )
1225 * Set the width of window to fit with contents.
1227 * @param {number} [min=0] Min height
1228 * @param {number} [max] Max height (defaults to content's outer width)
1231 OO
.ui
.Window
.prototype.fitWidthToContents = function ( min
, max
) {
1232 var width
= this.frame
.$content
.outerWidth();
1234 this.frame
.$element
.css(
1235 'width', Math
.max( min
|| 0, max
=== undefined ? width
: Math
.min( max
, width
) )
1242 * Initialize window contents.
1244 * The first time the window is opened, #initialize is called when it's safe to begin populating
1245 * its contents. See #setup for a way to make changes each time the window opens.
1247 * Once this method is called, this.$$ can be used to create elements within the frame.
1252 OO
.ui
.Window
.prototype.initialize = function () {
1254 this.$ = this.frame
.$;
1255 this.$title
= this.$( '<div class="oo-ui-window-title"></div>' )
1256 .text( this.title
);
1257 this.$icon
= this.$( '<div class="oo-ui-window-icon"></div>' )
1258 .addClass( 'oo-ui-icon-' + this.icon
);
1259 this.$head
= this.$( '<div class="oo-ui-window-head"></div>' );
1260 this.$body
= this.$( '<div class="oo-ui-window-body"></div>' );
1261 this.$foot
= this.$( '<div class="oo-ui-window-foot"></div>' );
1262 this.$overlay
= this.$( '<div class="oo-ui-window-overlay"></div>' );
1265 this.frame
.$content
.append(
1266 this.$head
.append( this.$icon
, this.$title
),
1276 * Setup window for use.
1278 * Each time the window is opened, once it's ready to be interacted with, this will set it up for
1279 * use in a particular context, based on the `data` argument.
1281 * When you override this method, you must call the parent method at the very beginning.
1284 * @param {Object} [data] Window opening data
1286 OO
.ui
.Window
.prototype.setup = function () {
1287 // Override to do something
1291 * Tear down window after use.
1293 * Each time the window is closed, and it's done being interacted with, this will tear it down and
1294 * do something with the user's interactions within the window, based on the `data` argument.
1296 * When you override this method, you must call the parent method at the very end.
1299 * @param {Object} [data] Window closing data
1301 OO
.ui
.Window
.prototype.teardown = function () {
1302 // Override to do something
1308 * Do not override this method. See #setup for a way to make changes each time the window opens.
1310 * @param {Object} [data] Window opening data
1316 OO
.ui
.Window
.prototype.open = function ( data
) {
1317 if ( !this.opening
&& !this.closing
&& !this.visible
) {
1318 this.opening
= true;
1319 this.frame
.run( OO
.ui
.bind( function () {
1320 this.$element
.show();
1321 this.visible
= true;
1322 this.emit( 'opening', data
);
1324 this.emit( 'open', data
);
1325 setTimeout( OO
.ui
.bind( function () {
1326 // Focus the content div (which has a tabIndex) to inactivate
1327 // (but not clear) selections in the parent frame.
1328 // Must happen after 'open' is emitted (to ensure it is visible)
1329 // but before 'ready' is emitted (so subclasses can give focus to something else)
1330 this.frame
.$content
.focus();
1331 this.emit( 'ready', data
);
1332 this.opening
= false;
1343 * See #teardown for a way to do something each time the window closes.
1345 * @param {Object} [data] Window closing data
1350 OO
.ui
.Window
.prototype.close = function ( data
) {
1351 if ( !this.opening
&& !this.closing
&& this.visible
) {
1352 this.frame
.$content
.find( ':focus' ).blur();
1353 this.closing
= true;
1354 this.$element
.hide();
1355 this.visible
= false;
1356 this.emit( 'closing', data
);
1357 this.teardown( data
);
1358 this.emit( 'close', data
);
1359 this.closing
= false;
1365 * Set of mutually exclusive windows.
1368 * @extends OO.ui.Element
1369 * @mixins OO.EventEmitter
1372 * @param {OO.Factory} factory Window factory
1373 * @param {Object} [config] Configuration options
1375 OO
.ui
.WindowSet
= function OoUiWindowSet( factory
, config
) {
1376 // Parent constructor
1377 OO
.ui
.WindowSet
.super.call( this, config
);
1379 // Mixin constructors
1380 OO
.EventEmitter
.call( this );
1383 this.factory
= factory
;
1386 * List of all windows associated with this window set.
1388 * @property {OO.ui.Window[]}
1390 this.windowList
= [];
1393 * Mapping of OO.ui.Window objects created by name from the #factory.
1395 * @property {Object}
1398 this.currentWindow
= null;
1401 this.$element
.addClass( 'oo-ui-windowSet' );
1406 OO
.inheritClass( OO
.ui
.WindowSet
, OO
.ui
.Element
);
1407 OO
.mixinClass( OO
.ui
.WindowSet
, OO
.EventEmitter
);
1413 * @param {OO.ui.Window} win Window that's being opened
1414 * @param {Object} config Window opening information
1419 * @param {OO.ui.Window} win Window that's been opened
1420 * @param {Object} config Window opening information
1425 * @param {OO.ui.Window} win Window that's being closed
1426 * @param {Object} config Window closing information
1431 * @param {OO.ui.Window} win Window that's been closed
1432 * @param {Object} config Window closing information
1438 * Handle a window that's being opened.
1440 * @param {OO.ui.Window} win Window that's being opened
1441 * @param {Object} [config] Window opening information
1444 OO
.ui
.WindowSet
.prototype.onWindowOpening = function ( win
, config
) {
1445 if ( this.currentWindow
&& this.currentWindow
!== win
) {
1446 this.currentWindow
.close();
1448 this.currentWindow
= win
;
1449 this.emit( 'opening', win
, config
);
1453 * Handle a window that's been opened.
1455 * @param {OO.ui.Window} win Window that's been opened
1456 * @param {Object} [config] Window opening information
1459 OO
.ui
.WindowSet
.prototype.onWindowOpen = function ( win
, config
) {
1460 this.emit( 'open', win
, config
);
1464 * Handle a window that's being closed.
1466 * @param {OO.ui.Window} win Window that's being closed
1467 * @param {Object} [config] Window closing information
1470 OO
.ui
.WindowSet
.prototype.onWindowClosing = function ( win
, config
) {
1471 this.currentWindow
= null;
1472 this.emit( 'closing', win
, config
);
1476 * Handle a window that's been closed.
1478 * @param {OO.ui.Window} win Window that's been closed
1479 * @param {Object} [config] Window closing information
1482 OO
.ui
.WindowSet
.prototype.onWindowClose = function ( win
, config
) {
1483 this.emit( 'close', win
, config
);
1487 * Get the current window.
1489 * @return {OO.ui.Window|null} Current window or null if none open
1491 OO
.ui
.WindowSet
.prototype.getCurrentWindow = function () {
1492 return this.currentWindow
;
1496 * Return a given window.
1498 * @param {string} name Symbolic name of window
1499 * @return {OO.ui.Window} Window with specified name
1501 OO
.ui
.WindowSet
.prototype.getWindow = function ( name
) {
1504 if ( !this.factory
.lookup( name
) ) {
1505 throw new Error( 'Unknown window: ' + name
);
1507 if ( !( name
in this.windows
) ) {
1508 win
= this.windows
[name
] = this.createWindow( name
);
1509 this.addWindow( win
);
1511 return this.windows
[name
];
1515 * Create a window for use in this window set.
1517 * @param {string} name Symbolic name of window
1518 * @return {OO.ui.Window} Window with specified name
1520 OO
.ui
.WindowSet
.prototype.createWindow = function ( name
) {
1521 return this.factory
.create( name
, { '$': this.$ } );
1525 * Add a given window to this window set.
1527 * Connects event handlers and attaches it to the DOM. Calling
1528 * OO.ui.Window#open will not work until the window is added to the set.
1530 * @param {OO.ui.Window} win
1532 OO
.ui
.WindowSet
.prototype.addWindow = function ( win
) {
1533 if ( this.windowList
.indexOf( win
) !== -1 ) {
1537 this.windowList
.push( win
);
1539 win
.connect( this, {
1540 'opening': [ 'onWindowOpening', win
],
1541 'open': [ 'onWindowOpen', win
],
1542 'closing': [ 'onWindowClosing', win
],
1543 'close': [ 'onWindowClose', win
]
1545 this.$element
.append( win
.$element
);
1548 * Modal dialog window.
1552 * @extends OO.ui.Window
1555 * @param {Object} [config] Configuration options
1556 * @cfg {boolean} [footless] Hide foot
1557 * @cfg {string} [size='large'] Symbolic name of dialog size, `small`, `medium` or `large`
1559 OO
.ui
.Dialog
= function OoUiDialog( config
) {
1560 // Configuration initialization
1561 config
= $.extend( { 'size': 'large' }, config
);
1563 // Parent constructor
1564 OO
.ui
.Dialog
.super.call( this, config
);
1567 this.visible
= false;
1568 this.footless
= !!config
.footless
;
1571 this.onWindowMouseWheelHandler
= OO
.ui
.bind( this.onWindowMouseWheel
, this );
1572 this.onDocumentKeyDownHandler
= OO
.ui
.bind( this.onDocumentKeyDown
, this );
1575 this.$element
.on( 'mousedown', false );
1576 this.connect( this, { 'opening': 'onOpening' } );
1579 this.$element
.addClass( 'oo-ui-dialog' );
1580 this.setSize( config
.size
);
1585 OO
.inheritClass( OO
.ui
.Dialog
, OO
.ui
.Window
);
1587 /* Static Properties */
1590 * Symbolic name of dialog.
1595 * @property {string}
1597 OO
.ui
.Dialog
.static.name
= '';
1600 * Map of symbolic size names and CSS classes.
1604 * @property {Object}
1606 OO
.ui
.Dialog
.static.sizeCssClasses
= {
1607 'small': 'oo-ui-dialog-small',
1608 'medium': 'oo-ui-dialog-medium',
1609 'large': 'oo-ui-dialog-large'
1615 * Handle close button click events.
1617 OO
.ui
.Dialog
.prototype.onCloseButtonClick = function () {
1618 this.close( { 'action': 'cancel' } );
1622 * Handle window mouse wheel events.
1624 * @param {jQuery.Event} e Mouse wheel event
1626 OO
.ui
.Dialog
.prototype.onWindowMouseWheel = function () {
1631 * Handle document key down events.
1633 * @param {jQuery.Event} e Key down event
1635 OO
.ui
.Dialog
.prototype.onDocumentKeyDown = function ( e
) {
1636 switch ( e
.which
) {
1637 case OO
.ui
.Keys
.PAGEUP
:
1638 case OO
.ui
.Keys
.PAGEDOWN
:
1639 case OO
.ui
.Keys
.END
:
1640 case OO
.ui
.Keys
.HOME
:
1641 case OO
.ui
.Keys
.LEFT
:
1643 case OO
.ui
.Keys
.RIGHT
:
1644 case OO
.ui
.Keys
.DOWN
:
1645 // Prevent any key events that might cause scrolling
1651 * Handle frame document key down events.
1653 * @param {jQuery.Event} e Key down event
1655 OO
.ui
.Dialog
.prototype.onFrameDocumentKeyDown = function ( e
) {
1656 if ( e
.which
=== OO
.ui
.Keys
.ESCAPE
) {
1657 this.close( { 'action': 'cancel' } );
1663 OO
.ui
.Dialog
.prototype.onOpening = function () {
1664 this.$element
.addClass( 'oo-ui-dialog-open' );
1670 * @param {string} [size='large'] Symbolic name of dialog size, `small`, `medium` or `large`
1672 OO
.ui
.Dialog
.prototype.setSize = function ( size
) {
1673 var name
, state
, cssClass
,
1674 sizeCssClasses
= OO
.ui
.Dialog
.static.sizeCssClasses
;
1676 if ( !sizeCssClasses
[size
] ) {
1680 for ( name
in sizeCssClasses
) {
1681 state
= name
=== size
;
1682 cssClass
= sizeCssClasses
[name
];
1683 this.$element
.toggleClass( cssClass
, state
);
1684 if ( this.frame
.$content
) {
1685 this.frame
.$content
.toggleClass( cssClass
, state
);
1693 OO
.ui
.Dialog
.prototype.initialize = function () {
1695 OO
.ui
.Window
.prototype.initialize
.call( this );
1698 this.closeButton
= new OO
.ui
.ButtonWidget( {
1702 'title': OO
.ui
.msg( 'ooui-dialog-action-close' )
1706 this.closeButton
.connect( this, { 'click': 'onCloseButtonClick' } );
1707 this.frame
.$document
.on( 'keydown', OO
.ui
.bind( this.onFrameDocumentKeyDown
, this ) );
1710 this.frame
.$content
.addClass( 'oo-ui-dialog-content' );
1711 if ( this.footless
) {
1712 this.frame
.$content
.addClass( 'oo-ui-dialog-content-footless' );
1714 this.closeButton
.$element
.addClass( 'oo-ui-window-closeButton' );
1715 this.$head
.append( this.closeButton
.$element
);
1721 OO
.ui
.Dialog
.prototype.setup = function ( data
) {
1723 OO
.ui
.Window
.prototype.setup
.call( this, data
);
1725 // Prevent scrolling in top-level window
1726 this.$( window
).on( 'mousewheel', this.onWindowMouseWheelHandler
);
1727 this.$( document
).on( 'keydown', this.onDocumentKeyDownHandler
);
1733 OO
.ui
.Dialog
.prototype.teardown = function ( data
) {
1735 OO
.ui
.Window
.prototype.teardown
.call( this, data
);
1737 // Allow scrolling in top-level window
1738 this.$( window
).off( 'mousewheel', this.onWindowMouseWheelHandler
);
1739 this.$( document
).off( 'keydown', this.onDocumentKeyDownHandler
);
1745 OO
.ui
.Dialog
.prototype.close = function ( data
) {
1747 if ( !dialog
.opening
&& !dialog
.closing
&& dialog
.visible
) {
1748 // Trigger transition
1749 dialog
.$element
.removeClass( 'oo-ui-dialog-open' );
1750 // Allow transition to complete before actually closing
1751 setTimeout( function () {
1753 OO
.ui
.Window
.prototype.close
.call( dialog
, data
);
1759 * Check if input is pending.
1763 OO
.ui
.Dialog
.prototype.isPending = function () {
1764 return !!this.pending
;
1768 * Increase the pending stack.
1772 OO
.ui
.Dialog
.prototype.pushPending = function () {
1773 if ( this.pending
=== 0 ) {
1774 this.frame
.$content
.addClass( 'oo-ui-dialog-pending' );
1775 this.$head
.addClass( 'oo-ui-texture-pending' );
1776 this.$foot
.addClass( 'oo-ui-texture-pending' );
1784 * Reduce the pending stack.
1790 OO
.ui
.Dialog
.prototype.popPending = function () {
1791 if ( this.pending
=== 1 ) {
1792 this.frame
.$content
.removeClass( 'oo-ui-dialog-pending' );
1793 this.$head
.removeClass( 'oo-ui-texture-pending' );
1794 this.$foot
.removeClass( 'oo-ui-texture-pending' );
1796 this.pending
= Math
.max( 0, this.pending
- 1 );
1801 * Container for elements.
1805 * @extends OO.ui.Element
1806 * @mixins OO.EventEmitter
1809 * @param {Object} [config] Configuration options
1811 OO
.ui
.Layout
= function OoUiLayout( config
) {
1812 // Initialize config
1813 config
= config
|| {};
1815 // Parent constructor
1816 OO
.ui
.Layout
.super.call( this, config
);
1818 // Mixin constructors
1819 OO
.EventEmitter
.call( this );
1822 this.$element
.addClass( 'oo-ui-layout' );
1827 OO
.inheritClass( OO
.ui
.Layout
, OO
.ui
.Element
);
1828 OO
.mixinClass( OO
.ui
.Layout
, OO
.EventEmitter
);
1830 * User interface control.
1834 * @extends OO.ui.Element
1835 * @mixins OO.EventEmitter
1838 * @param {Object} [config] Configuration options
1839 * @cfg {boolean} [disabled=false] Disable
1841 OO
.ui
.Widget
= function OoUiWidget( config
) {
1842 // Initialize config
1843 config
= $.extend( { 'disabled': false }, config
);
1845 // Parent constructor
1846 OO
.ui
.Widget
.super.call( this, config
);
1848 // Mixin constructors
1849 OO
.EventEmitter
.call( this );
1852 this.disabled
= null;
1853 this.wasDisabled
= null;
1856 this.$element
.addClass( 'oo-ui-widget' );
1857 this.setDisabled( !!config
.disabled
);
1862 OO
.inheritClass( OO
.ui
.Widget
, OO
.ui
.Element
);
1863 OO
.mixinClass( OO
.ui
.Widget
, OO
.EventEmitter
);
1869 * @param {boolean} disabled Widget is disabled
1875 * Check if the widget is disabled.
1877 * @param {boolean} Button is disabled
1879 OO
.ui
.Widget
.prototype.isDisabled = function () {
1880 return this.disabled
;
1884 * Update the disabled state, in case of changes in parent widget.
1888 OO
.ui
.Widget
.prototype.updateDisabled = function () {
1889 this.setDisabled( this.disabled
);
1894 * Set the disabled state of the widget.
1896 * This should probably change the widgets' appearance and prevent it from being used.
1898 * @param {boolean} disabled Disable widget
1901 OO
.ui
.Widget
.prototype.setDisabled = function ( disabled
) {
1904 this.disabled
= !!disabled
;
1905 isDisabled
= this.isDisabled();
1906 if ( isDisabled
!== this.wasDisabled
) {
1907 this.$element
.toggleClass( 'oo-ui-widget-disabled', isDisabled
);
1908 this.$element
.toggleClass( 'oo-ui-widget-enabled', !isDisabled
);
1909 this.emit( 'disable', isDisabled
);
1911 this.wasDisabled
= isDisabled
;
1915 * Dialog for showing a confirmation/warning message.
1918 * @extends OO.ui.Dialog
1921 * @param {Object} [config] Configuration options
1923 OO
.ui
.ConfirmationDialog
= function OoUiConfirmationDialog( config
) {
1924 // Configuration initialization
1925 config
= $.extend( { 'size': 'small' }, config
);
1927 // Parent constructor
1928 OO
.ui
.Dialog
.call( this, config
);
1933 OO
.inheritClass( OO
.ui
.ConfirmationDialog
, OO
.ui
.Dialog
);
1935 /* Static Properties */
1937 OO
.ui
.ConfirmationDialog
.static.name
= 'confirm';
1939 OO
.ui
.ConfirmationDialog
.static.icon
= 'help';
1941 OO
.ui
.ConfirmationDialog
.static.title
= OO
.ui
.deferMsg( 'ooui-dialog-confirm-title' );
1948 OO
.ui
.ConfirmationDialog
.prototype.initialize = function () {
1950 OO
.ui
.Dialog
.prototype.initialize
.call( this );
1952 // Set up the layout
1953 var contentLayout
= new OO
.ui
.PanelLayout( {
1958 this.$promptContainer
= this.$( '<div>' ).addClass( 'oo-ui-dialog-confirm-promptContainer' );
1960 this.cancelButton
= new OO
.ui
.ButtonWidget( {
1961 'flags': [ 'destructive' ]
1963 this.cancelButton
.connect( this, { 'click': [ 'emit', 'cancel' ] } );
1965 this.okButton
= new OO
.ui
.ButtonWidget( {
1966 'flags': [ 'constructive' ]
1968 this.okButton
.connect( this, { 'click': [ 'emit', 'ok' ] } );
1971 contentLayout
.$element
.append( this.$promptContainer
);
1972 this.$body
.append( contentLayout
.$element
);
1975 this.okButton
.$element
,
1976 this.cancelButton
.$element
1979 this.connect( this, {
1982 'close': [ 'emit', 'cancel' ]
1987 * Open a confirmation dialog.
1989 * @param {object} [data] Window opening data including text of the dialog and text for the buttons
1990 * @param {jQuery|string} [data.prompt] The text of the dialog.
1991 * @param {jQuery|string|Function|null} [data.okLabel] The text used on the OK button
1992 * @param {jQuery|string|Function|null} [data.cancelLabel] The text used on the cancel button
1994 OO
.ui
.ConfirmationDialog
.prototype.setup = function ( data
) {
1996 OO
.ui
.Dialog
.prototype.setup
.call( this, data
);
1998 var prompt
= data
.prompt
|| OO
.ui
.deferMsg( 'ooui-dialog-confirm-default-prompt' ),
1999 okLabel
= data
.okLabel
|| OO
.ui
.deferMsg( 'ooui-dialog-confirm-default-ok' ),
2000 cancelLabel
= data
.cancelLabel
|| OO
.ui
.deferMsg( 'ooui-dialog-confirm-default-cancel' );
2002 if ( typeof prompt
=== 'string' ) {
2003 this.$promptContainer
.text( prompt
);
2005 this.$promptContainer
.empty().append( prompt
);
2008 this.okButton
.setLabel( okLabel
);
2009 this.cancelButton
.setLabel( cancelLabel
);
2012 * Element with a button.
2018 * @param {jQuery} $button Button node, assigned to #$button
2019 * @param {Object} [config] Configuration options
2020 * @cfg {boolean} [frameless] Render button without a frame
2021 * @cfg {number} [tabIndex=0] Button's tab index, use -1 to prevent tab focusing
2023 OO
.ui
.ButtonedElement
= function OoUiButtonedElement( $button
, config
) {
2024 // Configuration initialization
2025 config
= config
|| {};
2028 this.$button
= $button
;
2029 this.tabIndex
= null;
2030 this.active
= false;
2031 this.onMouseUpHandler
= OO
.ui
.bind( this.onMouseUp
, this );
2034 this.$button
.on( 'mousedown', OO
.ui
.bind( this.onMouseDown
, this ) );
2037 this.$element
.addClass( 'oo-ui-buttonedElement' );
2039 .addClass( 'oo-ui-buttonedElement-button' )
2040 .attr( 'role', 'button' )
2041 .prop( 'tabIndex', config
.tabIndex
|| 0 );
2042 if ( config
.frameless
) {
2043 this.$element
.addClass( 'oo-ui-buttonedElement-frameless' );
2045 this.$element
.addClass( 'oo-ui-buttonedElement-framed' );
2052 * Handles mouse down events.
2054 * @param {jQuery.Event} e Mouse down event
2056 OO
.ui
.ButtonedElement
.prototype.onMouseDown = function ( e
) {
2057 if ( this.isDisabled() || e
.which
!== 1 ) {
2060 // tabIndex should generally be interacted with via the property,
2061 // but it's not possible to reliably unset a tabIndex via a property
2062 // so we use the (lowercase) "tabindex" attribute instead.
2063 this.tabIndex
= this.$button
.attr( 'tabindex' );
2064 // Remove the tab-index while the button is down to prevent the button from stealing focus
2066 .removeAttr( 'tabindex' )
2067 .addClass( 'oo-ui-buttonedElement-pressed' );
2068 this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler
, true );
2073 * Handles mouse up events.
2075 * @param {jQuery.Event} e Mouse up event
2077 OO
.ui
.ButtonedElement
.prototype.onMouseUp = function ( e
) {
2078 if ( this.isDisabled() || e
.which
!== 1 ) {
2081 // Restore the tab-index after the button is up to restore the button's accesssibility
2083 .attr( 'tabindex', this.tabIndex
)
2084 .removeClass( 'oo-ui-buttonedElement-pressed' );
2085 this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler
, true );
2091 * @param {boolean} [value] Make button active
2094 OO
.ui
.ButtonedElement
.prototype.setActive = function ( value
) {
2095 this.$button
.toggleClass( 'oo-ui-buttonedElement-active', !!value
);
2099 * Element that can be automatically clipped to visible boundaies.
2105 * @param {jQuery} $clippable Nodes to clip, assigned to #$clippable
2106 * @param {Object} [config] Configuration options
2108 OO
.ui
.ClippableElement
= function OoUiClippableElement( $clippable
, config
) {
2109 // Configuration initialization
2110 config
= config
|| {};
2113 this.$clippable
= $clippable
;
2114 this.clipping
= false;
2115 this.clipped
= false;
2116 this.$clippableContainer
= null;
2117 this.$clippableScroller
= null;
2118 this.$clippableWindow
= null;
2119 this.idealWidth
= null;
2120 this.idealHeight
= null;
2121 this.onClippableContainerScrollHandler
= OO
.ui
.bind( this.clip
, this );
2122 this.onClippableWindowResizeHandler
= OO
.ui
.bind( this.clip
, this );
2125 this.$clippable
.addClass( 'oo-ui-clippableElement-clippable' );
2133 * @param {boolean} value Enable clipping
2136 OO
.ui
.ClippableElement
.prototype.setClipping = function ( value
) {
2139 if ( this.clipping
!== value
) {
2140 this.clipping
= value
;
2141 if ( this.clipping
) {
2142 this.$clippableContainer
= this.$( this.getClosestScrollableElementContainer() );
2143 // If the clippable container is the body, we have to listen to scroll events and check
2144 // jQuery.scrollTop on the window because of browser inconsistencies
2145 this.$clippableScroller
= this.$clippableContainer
.is( 'body' ) ?
2146 this.$( OO
.ui
.Element
.getWindow( this.$clippableContainer
) ) :
2147 this.$clippableContainer
;
2148 this.$clippableScroller
.on( 'scroll', this.onClippableContainerScrollHandler
);
2149 this.$clippableWindow
= this.$( this.getElementWindow() )
2150 .on( 'resize', this.onClippableWindowResizeHandler
);
2151 // Initial clip after visible
2152 setTimeout( OO
.ui
.bind( this.clip
, this ) );
2154 this.$clippableContainer
= null;
2155 this.$clippableScroller
.off( 'scroll', this.onClippableContainerScrollHandler
);
2156 this.$clippableScroller
= null;
2157 this.$clippableWindow
.off( 'resize', this.onClippableWindowResizeHandler
);
2158 this.$clippableWindow
= null;
2166 * Check if the element will be clipped to fit the visible area of the nearest scrollable container.
2168 * @return {boolean} Element will be clipped to the visible area
2170 OO
.ui
.ClippableElement
.prototype.isClipping = function () {
2171 return this.clipping
;
2175 * Check if the bottom or right of the element is being clipped by the nearest scrollable container.
2177 * @return {boolean} Part of the element is being clipped
2179 OO
.ui
.ClippableElement
.prototype.isClipped = function () {
2180 return this.clipped
;
2184 * Set the ideal size.
2186 * @param {number|string} [width] Width as a number of pixels or CSS string with unit suffix
2187 * @param {number|string} [height] Height as a number of pixels or CSS string with unit suffix
2189 OO
.ui
.ClippableElement
.prototype.setIdealSize = function ( width
, height
) {
2190 this.idealWidth
= width
;
2191 this.idealHeight
= height
;
2195 * Clip element to visible boundaries and allow scrolling when needed.
2197 * Element will be clipped the bottom or right of the element is within 10px of the edge of, or
2198 * overlapped by, the visible area of the nearest scrollable container.
2202 OO
.ui
.ClippableElement
.prototype.clip = function () {
2203 if ( !this.clipping
) {
2204 // this.$clippableContainer and this.$clippableWindow are null, so the below will fail
2209 cOffset
= this.$clippable
.offset(),
2210 ccOffset
= this.$clippableContainer
.offset() || { 'top': 0, 'left': 0 },
2211 ccHeight
= this.$clippableContainer
.innerHeight() - buffer
,
2212 ccWidth
= this.$clippableContainer
.innerWidth() - buffer
,
2213 scrollTop
= this.$clippableScroller
.scrollTop(),
2214 scrollLeft
= this.$clippableScroller
.scrollLeft(),
2215 desiredWidth
= ( ccOffset
.left
+ scrollLeft
+ ccWidth
) - cOffset
.left
,
2216 desiredHeight
= ( ccOffset
.top
+ scrollTop
+ ccHeight
) - cOffset
.top
,
2217 naturalWidth
= this.$clippable
.prop( 'scrollWidth' ),
2218 naturalHeight
= this.$clippable
.prop( 'scrollHeight' ),
2219 clipWidth
= desiredWidth
< naturalWidth
,
2220 clipHeight
= desiredHeight
< naturalHeight
;
2223 this.$clippable
.css( { 'overflow-x': 'auto', 'width': desiredWidth
} );
2225 this.$clippable
.css( { 'overflow-x': '', 'width': this.idealWidth
|| '' } );
2228 this.$clippable
.css( { 'overflow-y': 'auto', 'height': desiredHeight
} );
2230 this.$clippable
.css( { 'overflow-y': '', 'height': this.idealHeight
|| '' } );
2233 this.clipped
= clipWidth
|| clipHeight
;
2238 * Element with named flags that can be added, removed, listed and checked.
2240 * A flag, when set, adds a CSS class on the `$element` by combing `oo-ui-flaggableElement-` with
2241 * the flag name. Flags are primarily useful for styling.
2247 * @param {Object} [config] Configuration options
2248 * @cfg {string[]} [flags=[]] Styling flags, e.g. 'primary', 'destructive' or 'constructive'
2250 OO
.ui
.FlaggableElement
= function OoUiFlaggableElement( config
) {
2251 // Config initialization
2252 config
= config
|| {};
2258 this.setFlags( config
.flags
);
2264 * Check if a flag is set.
2266 * @param {string} flag Name of flag
2267 * @return {boolean} Has flag
2269 OO
.ui
.FlaggableElement
.prototype.hasFlag = function ( flag
) {
2270 return flag
in this.flags
;
2274 * Get the names of all flags set.
2276 * @return {string[]} flags Flag names
2278 OO
.ui
.FlaggableElement
.prototype.getFlags = function () {
2279 return Object
.keys( this.flags
);
2287 OO
.ui
.FlaggableElement
.prototype.clearFlags = function () {
2289 classPrefix
= 'oo-ui-flaggableElement-';
2291 for ( flag
in this.flags
) {
2292 delete this.flags
[flag
];
2293 this.$element
.removeClass( classPrefix
+ flag
);
2300 * Add one or more flags.
2302 * @param {string[]|Object.<string, boolean>} flags List of flags to add, or list of set/remove
2303 * values, keyed by flag name
2306 OO
.ui
.FlaggableElement
.prototype.setFlags = function ( flags
) {
2308 classPrefix
= 'oo-ui-flaggableElement-';
2310 if ( $.isArray( flags
) ) {
2311 for ( i
= 0, len
= flags
.length
; i
< len
; i
++ ) {
2314 this.flags
[flag
] = true;
2315 this.$element
.addClass( classPrefix
+ flag
);
2317 } else if ( OO
.isPlainObject( flags
) ) {
2318 for ( flag
in flags
) {
2319 if ( flags
[flag
] ) {
2321 this.flags
[flag
] = true;
2322 this.$element
.addClass( classPrefix
+ flag
);
2325 delete this.flags
[flag
];
2326 this.$element
.removeClass( classPrefix
+ flag
);
2333 * Element containing a sequence of child elements.
2339 * @param {jQuery} $group Container node, assigned to #$group
2340 * @param {Object} [config] Configuration options
2342 OO
.ui
.GroupElement
= function OoUiGroupElement( $group
, config
) {
2344 config
= config
|| {};
2347 this.$group
= $group
;
2349 this.$items
= this.$( [] );
2350 this.aggregateItemEvents
= {};
2358 * @return {OO.ui.Element[]} Items
2360 OO
.ui
.GroupElement
.prototype.getItems = function () {
2361 return this.items
.slice( 0 );
2365 * Add an aggregate item event.
2367 * Aggregated events are listened to on each item and then emitted by the group under a new name,
2368 * and with an additional leading parameter containing the item that emitted the original event.
2369 * Other arguments that were emitted from the original event are passed through.
2371 * @param {Object.<string,string|null>} events Aggregate events emitted by group, keyed by item
2372 * event, use null value to remove aggregation
2373 * @throws {Error} If aggregation already exists
2375 OO
.ui
.GroupElement
.prototype.aggregate = function ( events
) {
2376 var i
, len
, item
, add
, remove
, itemEvent
, groupEvent
;
2378 for ( itemEvent
in events
) {
2379 groupEvent
= events
[itemEvent
];
2381 // Remove existing aggregated event
2382 if ( itemEvent
in this.aggregateItemEvents
) {
2383 // Don't allow duplicate aggregations
2385 throw new Error( 'Duplicate item event aggregation for ' + itemEvent
);
2387 // Remove event aggregation from existing items
2388 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
2389 item
= this.items
[i
];
2390 if ( item
.connect
&& item
.disconnect
) {
2392 remove
[itemEvent
] = [ 'emit', groupEvent
, item
];
2393 item
.disconnect( this, remove
);
2396 // Prevent future items from aggregating event
2397 delete this.aggregateItemEvents
[itemEvent
];
2400 // Add new aggregate event
2402 // Make future items aggregate event
2403 this.aggregateItemEvents
[itemEvent
] = groupEvent
;
2404 // Add event aggregation to existing items
2405 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
2406 item
= this.items
[i
];
2407 if ( item
.connect
&& item
.disconnect
) {
2409 add
[itemEvent
] = [ 'emit', groupEvent
, item
];
2410 item
.connect( this, add
);
2420 * @param {OO.ui.Element[]} items Item
2421 * @param {number} [index] Index to insert items at
2424 OO
.ui
.GroupElement
.prototype.addItems = function ( items
, index
) {
2425 var i
, len
, item
, event
, events
, currentIndex
,
2426 $items
= this.$( [] );
2428 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
2431 // Check if item exists then remove it first, effectively "moving" it
2432 currentIndex
= $.inArray( item
, this.items
);
2433 if ( currentIndex
>= 0 ) {
2434 this.removeItems( [ item
] );
2435 // Adjust index to compensate for removal
2436 if ( currentIndex
< index
) {
2441 if ( item
.connect
&& item
.disconnect
&& !$.isEmptyObject( this.aggregateItemEvents
) ) {
2443 for ( event
in this.aggregateItemEvents
) {
2444 events
[event
] = [ 'emit', this.aggregateItemEvents
[event
], item
];
2446 item
.connect( this, events
);
2448 item
.setElementGroup( this );
2449 $items
= $items
.add( item
.$element
);
2452 if ( index
=== undefined || index
< 0 || index
>= this.items
.length
) {
2453 this.$group
.append( $items
);
2454 this.items
.push
.apply( this.items
, items
);
2455 } else if ( index
=== 0 ) {
2456 this.$group
.prepend( $items
);
2457 this.items
.unshift
.apply( this.items
, items
);
2459 this.$items
.eq( index
).before( $items
);
2460 this.items
.splice
.apply( this.items
, [ index
, 0 ].concat( items
) );
2463 this.$items
= this.$items
.add( $items
);
2471 * Items will be detached, not removed, so they can be used later.
2473 * @param {OO.ui.Element[]} items Items to remove
2476 OO
.ui
.GroupElement
.prototype.removeItems = function ( items
) {
2477 var i
, len
, item
, index
, remove
, itemEvent
;
2479 // Remove specific items
2480 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
2482 index
= $.inArray( item
, this.items
);
2483 if ( index
!== -1 ) {
2485 item
.connect
&& item
.disconnect
&&
2486 !$.isEmptyObject( this.aggregateItemEvents
)
2489 if ( itemEvent
in this.aggregateItemEvents
) {
2490 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
2492 item
.disconnect( this, remove
);
2494 item
.setElementGroup( null );
2495 this.items
.splice( index
, 1 );
2496 item
.$element
.detach();
2497 this.$items
= this.$items
.not( item
.$element
);
2507 * Items will be detached, not removed, so they can be used later.
2511 OO
.ui
.GroupElement
.prototype.clearItems = function () {
2512 var i
, len
, item
, remove
, itemEvent
;
2515 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
2516 item
= this.items
[i
];
2518 item
.connect
&& item
.disconnect
&&
2519 !$.isEmptyObject( this.aggregateItemEvents
)
2522 if ( itemEvent
in this.aggregateItemEvents
) {
2523 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
2525 item
.disconnect( this, remove
);
2527 item
.setElementGroup( null );
2530 this.$items
.detach();
2531 this.$items
= this.$( [] );
2536 * Element containing an icon.
2542 * @param {jQuery} $icon Icon node, assigned to #$icon
2543 * @param {Object} [config] Configuration options
2544 * @cfg {Object|string} [icon=''] Symbolic icon name, or map of icon names keyed by language ID;
2545 * use the 'default' key to specify the icon to be used when there is no icon in the user's
2548 OO
.ui
.IconedElement
= function OoUiIconedElement( $icon
, config
) {
2549 // Config intialization
2550 config
= config
|| {};
2557 this.$icon
.addClass( 'oo-ui-iconedElement-icon' );
2558 this.setIcon( config
.icon
|| this.constructor.static.icon
);
2563 OO
.initClass( OO
.ui
.IconedElement
);
2565 /* Static Properties */
2570 * Value should be the unique portion of an icon CSS class name, such as 'up' for 'oo-ui-icon-up'.
2572 * For i18n purposes, this property can be an object containing a `default` icon name property and
2573 * additional icon names keyed by language code.
2575 * Example of i18n icon definition:
2576 * { 'default': 'bold-a', 'en': 'bold-b', 'de': 'bold-f' }
2580 * @property {Object|string} Symbolic icon name, or map of icon names keyed by language ID;
2581 * use the 'default' key to specify the icon to be used when there is no icon in the user's
2584 OO
.ui
.IconedElement
.static.icon
= null;
2591 * @param {Object|string} icon Symbolic icon name, or map of icon names keyed by language ID;
2592 * use the 'default' key to specify the icon to be used when there is no icon in the user's
2596 OO
.ui
.IconedElement
.prototype.setIcon = function ( icon
) {
2597 icon
= OO
.isPlainObject( icon
) ? OO
.ui
.getLocalValue( icon
, null, 'default' ) : icon
;
2600 this.$icon
.removeClass( 'oo-ui-icon-' + this.icon
);
2602 if ( typeof icon
=== 'string' ) {
2604 if ( icon
.length
) {
2605 this.$icon
.addClass( 'oo-ui-icon-' + icon
);
2609 this.$element
.toggleClass( 'oo-ui-iconedElement', !!this.icon
);
2617 * @return {string} Icon
2619 OO
.ui
.IconedElement
.prototype.getIcon = function () {
2623 * Element containing an indicator.
2629 * @param {jQuery} $indicator Indicator node, assigned to #$indicator
2630 * @param {Object} [config] Configuration options
2631 * @cfg {string} [indicator] Symbolic indicator name
2632 * @cfg {string} [indicatorTitle] Indicator title text or a function that return text
2634 OO
.ui
.IndicatedElement
= function OoUiIndicatedElement( $indicator
, config
) {
2635 // Config intialization
2636 config
= config
|| {};
2639 this.$indicator
= $indicator
;
2640 this.indicator
= null;
2641 this.indicatorLabel
= null;
2644 this.$indicator
.addClass( 'oo-ui-indicatedElement-indicator' );
2645 this.setIndicator( config
.indicator
|| this.constructor.static.indicator
);
2646 this.setIndicatorTitle( config
.indicatorTitle
|| this.constructor.static.indicatorTitle
);
2651 OO
.initClass( OO
.ui
.IndicatedElement
);
2653 /* Static Properties */
2660 * @property {string|null} Symbolic indicator name or null for no indicator
2662 OO
.ui
.IndicatedElement
.static.indicator
= null;
2669 * @property {string|Function|null} Indicator title text, a function that return text or null for no
2672 OO
.ui
.IndicatedElement
.static.indicatorTitle
= null;
2679 * @param {string|null} indicator Symbolic name of indicator to use or null for no indicator
2682 OO
.ui
.IndicatedElement
.prototype.setIndicator = function ( indicator
) {
2683 if ( this.indicator
) {
2684 this.$indicator
.removeClass( 'oo-ui-indicator-' + this.indicator
);
2685 this.indicator
= null;
2687 if ( typeof indicator
=== 'string' ) {
2688 indicator
= indicator
.trim();
2689 if ( indicator
.length
) {
2690 this.$indicator
.addClass( 'oo-ui-indicator-' + indicator
);
2691 this.indicator
= indicator
;
2694 this.$element
.toggleClass( 'oo-ui-indicatedElement', !!this.indicator
);
2700 * Set indicator label.
2702 * @param {string|Function|null} indicator Indicator title text, a function that return text or null
2703 * for no indicator title
2706 OO
.ui
.IndicatedElement
.prototype.setIndicatorTitle = function ( indicatorTitle
) {
2707 this.indicatorTitle
= indicatorTitle
= OO
.ui
.resolveMsg( indicatorTitle
);
2709 if ( typeof indicatorTitle
=== 'string' && indicatorTitle
.length
) {
2710 this.$indicator
.attr( 'title', indicatorTitle
);
2712 this.$indicator
.removeAttr( 'title' );
2721 * @return {string} title Symbolic name of indicator
2723 OO
.ui
.IndicatedElement
.prototype.getIndicator = function () {
2724 return this.indicator
;
2728 * Get indicator title.
2730 * @return {string} Indicator title text
2732 OO
.ui
.IndicatedElement
.prototype.getIndicatorTitle = function () {
2733 return this.indicatorTitle
;
2736 * Element containing a label.
2742 * @param {jQuery} $label Label node, assigned to #$label
2743 * @param {Object} [config] Configuration options
2744 * @cfg {jQuery|string|Function} [label] Label nodes, text or a function that returns nodes or text
2745 * @cfg {boolean} [autoFitLabel=true] Whether to fit the label or not.
2747 OO
.ui
.LabeledElement
= function OoUiLabeledElement( $label
, config
) {
2748 // Config intialization
2749 config
= config
|| {};
2752 this.$label
= $label
;
2756 this.$label
.addClass( 'oo-ui-labeledElement-label' );
2757 this.setLabel( config
.label
|| this.constructor.static.label
);
2758 this.autoFitLabel
= config
.autoFitLabel
=== undefined || !!config
.autoFitLabel
;
2763 OO
.initClass( OO
.ui
.LabeledElement
);
2765 /* Static Properties */
2772 * @property {string|Function|null} Label text; a function that returns a nodes or text; or null for
2775 OO
.ui
.LabeledElement
.static.label
= null;
2782 * An empty string will result in the label being hidden. A string containing only whitespace will
2783 * be converted to a single
2785 * @param {jQuery|string|Function|null} label Label nodes; text; a function that retuns nodes or
2786 * text; or null for no label
2789 OO
.ui
.LabeledElement
.prototype.setLabel = function ( label
) {
2792 this.label
= label
= OO
.ui
.resolveMsg( label
) || null;
2793 if ( typeof label
=== 'string' && label
.length
) {
2794 if ( label
.match( /^\s*$/ ) ) {
2795 // Convert whitespace only string to a single non-breaking space
2796 this.$label
.html( ' ' );
2798 this.$label
.text( label
);
2800 } else if ( label
instanceof jQuery
) {
2801 this.$label
.empty().append( label
);
2803 this.$label
.empty();
2806 this.$element
.toggleClass( 'oo-ui-labeledElement', !empty
);
2807 this.$label
.css( 'display', empty
? 'none' : '' );
2815 * @return {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
2816 * text; or null for no label
2818 OO
.ui
.LabeledElement
.prototype.getLabel = function () {
2827 OO
.ui
.LabeledElement
.prototype.fitLabel = function () {
2828 if ( this.$label
.autoEllipsis
&& this.autoFitLabel
) {
2829 this.$label
.autoEllipsis( { 'hasSpan': false, 'tooltip': true } );
2834 * Popuppable element.
2840 * @param {Object} [config] Configuration options
2841 * @cfg {number} [popupWidth=320] Width of popup
2842 * @cfg {number} [popupHeight] Height of popup
2843 * @cfg {Object} [popup] Configuration to pass to popup
2845 OO
.ui
.PopuppableElement
= function OoUiPopuppableElement( config
) {
2846 // Configuration initialization
2847 config
= $.extend( { 'popupWidth': 320 }, config
);
2850 this.popup
= new OO
.ui
.PopupWidget( $.extend(
2851 { 'align': 'center', 'autoClose': true },
2853 { '$': this.$, '$autoCloseIgnore': this.$element
}
2855 this.popupWidth
= config
.popupWidth
;
2856 this.popupHeight
= config
.popupHeight
;
2864 * @return {OO.ui.PopupWidget} Popup widget
2866 OO
.ui
.PopuppableElement
.prototype.getPopup = function () {
2873 OO
.ui
.PopuppableElement
.prototype.showPopup = function () {
2874 this.popup
.show().display( this.popupWidth
, this.popupHeight
);
2880 OO
.ui
.PopuppableElement
.prototype.hidePopup = function () {
2884 * Element with a title.
2890 * @param {jQuery} $label Titled node, assigned to #$titled
2891 * @param {Object} [config] Configuration options
2892 * @cfg {string|Function} [title] Title text or a function that returns text
2894 OO
.ui
.TitledElement
= function OoUiTitledElement( $titled
, config
) {
2895 // Config intialization
2896 config
= config
|| {};
2899 this.$titled
= $titled
;
2903 this.setTitle( config
.title
|| this.constructor.static.title
);
2908 OO
.initClass( OO
.ui
.TitledElement
);
2910 /* Static Properties */
2917 * @property {string|Function} Title text or a function that returns text
2919 OO
.ui
.TitledElement
.static.title
= null;
2926 * @param {string|Function|null} title Title text, a function that returns text or null for no title
2929 OO
.ui
.TitledElement
.prototype.setTitle = function ( title
) {
2930 this.title
= title
= OO
.ui
.resolveMsg( title
) || null;
2932 if ( typeof title
=== 'string' && title
.length
) {
2933 this.$titled
.attr( 'title', title
);
2935 this.$titled
.removeAttr( 'title' );
2944 * @return {string} Title string
2946 OO
.ui
.TitledElement
.prototype.getTitle = function () {
2950 * Generic toolbar tool.
2954 * @extends OO.ui.Widget
2955 * @mixins OO.ui.IconedElement
2958 * @param {OO.ui.ToolGroup} toolGroup
2959 * @param {Object} [config] Configuration options
2960 * @cfg {string|Function} [title] Title text or a function that returns text
2962 OO
.ui
.Tool
= function OoUiTool( toolGroup
, config
) {
2963 // Config intialization
2964 config
= config
|| {};
2966 // Parent constructor
2967 OO
.ui
.Tool
.super.call( this, config
);
2969 // Mixin constructors
2970 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
2973 this.toolGroup
= toolGroup
;
2974 this.toolbar
= this.toolGroup
.getToolbar();
2975 this.active
= false;
2976 this.$title
= this.$( '<span>' );
2977 this.$link
= this.$( '<a>' );
2981 this.toolbar
.connect( this, { 'updateState': 'onUpdateState' } );
2984 this.$title
.addClass( 'oo-ui-tool-title' );
2986 .addClass( 'oo-ui-tool-link' )
2987 .append( this.$icon
, this.$title
);
2989 .data( 'oo-ui-tool', this )
2991 'oo-ui-tool ' + 'oo-ui-tool-name-' +
2992 this.constructor.static.name
.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' )
2994 .append( this.$link
);
2995 this.setTitle( config
.title
|| this.constructor.static.title
);
3000 OO
.inheritClass( OO
.ui
.Tool
, OO
.ui
.Widget
);
3001 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.IconedElement
);
3009 /* Static Properties */
3015 OO
.ui
.Tool
.static.tagName
= 'span';
3018 * Symbolic name of tool.
3023 * @property {string}
3025 OO
.ui
.Tool
.static.name
= '';
3033 * @property {string}
3035 OO
.ui
.Tool
.static.group
= '';
3040 * Title is used as a tooltip when the tool is part of a bar tool group, or a label when the tool
3041 * is part of a list or menu tool group. If a trigger is associated with an action by the same name
3042 * as the tool, a description of its keyboard shortcut for the appropriate platform will be
3043 * appended to the title if the tool is part of a bar tool group.
3048 * @property {string|Function} Title text or a function that returns text
3050 OO
.ui
.Tool
.static.title
= '';
3053 * Tool can be automatically added to catch-all groups.
3057 * @property {boolean}
3059 OO
.ui
.Tool
.static.autoAddToCatchall
= true;
3062 * Tool can be automatically added to named groups.
3065 * @property {boolean}
3068 OO
.ui
.Tool
.static.autoAddToGroup
= true;
3071 * Check if this tool is compatible with given data.
3075 * @param {Mixed} data Data to check
3076 * @return {boolean} Tool can be used with data
3078 OO
.ui
.Tool
.static.isCompatibleWith = function () {
3085 * Handle the toolbar state being updated.
3087 * This is an abstract method that must be overridden in a concrete subclass.
3091 OO
.ui
.Tool
.prototype.onUpdateState = function () {
3093 'OO.ui.Tool.onUpdateState not implemented in this subclass:' + this.constructor
3098 * Handle the tool being selected.
3100 * This is an abstract method that must be overridden in a concrete subclass.
3104 OO
.ui
.Tool
.prototype.onSelect = function () {
3106 'OO.ui.Tool.onSelect not implemented in this subclass:' + this.constructor
3111 * Check if the button is active.
3113 * @param {boolean} Button is active
3115 OO
.ui
.Tool
.prototype.isActive = function () {
3120 * Make the button appear active or inactive.
3122 * @param {boolean} state Make button appear active
3124 OO
.ui
.Tool
.prototype.setActive = function ( state
) {
3125 this.active
= !!state
;
3126 if ( this.active
) {
3127 this.$element
.addClass( 'oo-ui-tool-active' );
3129 this.$element
.removeClass( 'oo-ui-tool-active' );
3134 * Get the tool title.
3136 * @param {string|Function} title Title text or a function that returns text
3139 OO
.ui
.Tool
.prototype.setTitle = function ( title
) {
3140 this.title
= OO
.ui
.resolveMsg( title
);
3146 * Get the tool title.
3148 * @return {string} Title text
3150 OO
.ui
.Tool
.prototype.getTitle = function () {
3155 * Get the tool's symbolic name.
3157 * @return {string} Symbolic name of tool
3159 OO
.ui
.Tool
.prototype.getName = function () {
3160 return this.constructor.static.name
;
3166 OO
.ui
.Tool
.prototype.updateTitle = function () {
3167 var titleTooltips
= this.toolGroup
.constructor.static.titleTooltips
,
3168 accelTooltips
= this.toolGroup
.constructor.static.accelTooltips
,
3169 accel
= this.toolbar
.getToolAccelerator( this.constructor.static.name
),
3176 .addClass( 'oo-ui-tool-accel' )
3180 if ( titleTooltips
&& typeof this.title
=== 'string' && this.title
.length
) {
3181 tooltipParts
.push( this.title
);
3183 if ( accelTooltips
&& typeof accel
=== 'string' && accel
.length
) {
3184 tooltipParts
.push( accel
);
3186 if ( tooltipParts
.length
) {
3187 this.$link
.attr( 'title', tooltipParts
.join( ' ' ) );
3189 this.$link
.removeAttr( 'title' );
3196 OO
.ui
.Tool
.prototype.destroy = function () {
3197 this.toolbar
.disconnect( this );
3198 this.$element
.remove();
3201 * Collection of tool groups.
3204 * @extends OO.ui.Element
3205 * @mixins OO.EventEmitter
3206 * @mixins OO.ui.GroupElement
3209 * @param {OO.ui.ToolFactory} toolFactory Factory for creating tools
3210 * @param {OO.ui.ToolGroupFactory} toolGroupFactory Factory for creating tool groups
3211 * @param {Object} [config] Configuration options
3212 * @cfg {boolean} [actions] Add an actions section opposite to the tools
3213 * @cfg {boolean} [shadow] Add a shadow below the toolbar
3215 OO
.ui
.Toolbar
= function OoUiToolbar( toolFactory
, toolGroupFactory
, config
) {
3216 // Configuration initialization
3217 config
= config
|| {};
3219 // Parent constructor
3220 OO
.ui
.Toolbar
.super.call( this, config
);
3222 // Mixin constructors
3223 OO
.EventEmitter
.call( this );
3224 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
3227 this.toolFactory
= toolFactory
;
3228 this.toolGroupFactory
= toolGroupFactory
;
3231 this.$bar
= this.$( '<div>' );
3232 this.$actions
= this.$( '<div>' );
3233 this.initialized
= false;
3237 .add( this.$bar
).add( this.$group
).add( this.$actions
)
3238 .on( 'mousedown', OO
.ui
.bind( this.onMouseDown
, this ) );
3241 this.$group
.addClass( 'oo-ui-toolbar-tools' );
3242 this.$bar
.addClass( 'oo-ui-toolbar-bar' ).append( this.$group
);
3243 if ( config
.actions
) {
3244 this.$actions
.addClass( 'oo-ui-toolbar-actions' );
3245 this.$bar
.append( this.$actions
);
3247 this.$bar
.append( '<div style="clear:both"></div>' );
3248 if ( config
.shadow
) {
3249 this.$bar
.append( '<div class="oo-ui-toolbar-shadow"></div>' );
3251 this.$element
.addClass( 'oo-ui-toolbar' ).append( this.$bar
);
3256 OO
.inheritClass( OO
.ui
.Toolbar
, OO
.ui
.Element
);
3257 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.EventEmitter
);
3258 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.ui
.GroupElement
);
3263 * Get the tool factory.
3265 * @return {OO.ui.ToolFactory} Tool factory
3267 OO
.ui
.Toolbar
.prototype.getToolFactory = function () {
3268 return this.toolFactory
;
3272 * Get the tool group factory.
3274 * @return {OO.Factory} Tool group factory
3276 OO
.ui
.Toolbar
.prototype.getToolGroupFactory = function () {
3277 return this.toolGroupFactory
;
3281 * Handles mouse down events.
3283 * @param {jQuery.Event} e Mouse down event
3285 OO
.ui
.Toolbar
.prototype.onMouseDown = function ( e
) {
3286 var $closestWidgetToEvent
= this.$( e
.target
).closest( '.oo-ui-widget' ),
3287 $closestWidgetToToolbar
= this.$element
.closest( '.oo-ui-widget' );
3288 if ( !$closestWidgetToEvent
.length
|| $closestWidgetToEvent
[0] === $closestWidgetToToolbar
[0] ) {
3294 * Sets up handles and preloads required information for the toolbar to work.
3295 * This must be called immediately after it is attached to a visible document.
3297 OO
.ui
.Toolbar
.prototype.initialize = function () {
3298 this.initialized
= true;
3304 * Tools can be specified in the following ways:
3306 * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3307 * - All tools in a group: `{ 'group': 'group-name' }`
3308 * - All tools: `'*'` - Using this will make the group a list with a "More" label by default
3310 * @param {Object.<string,Array>} groups List of tool group configurations
3311 * @param {Array|string} [groups.include] Tools to include
3312 * @param {Array|string} [groups.exclude] Tools to exclude
3313 * @param {Array|string} [groups.promote] Tools to promote to the beginning
3314 * @param {Array|string} [groups.demote] Tools to demote to the end
3316 OO
.ui
.Toolbar
.prototype.setup = function ( groups
) {
3317 var i
, len
, type
, group
,
3319 defaultType
= 'bar';
3321 // Cleanup previous groups
3324 // Build out new groups
3325 for ( i
= 0, len
= groups
.length
; i
< len
; i
++ ) {
3327 if ( group
.include
=== '*' ) {
3328 // Apply defaults to catch-all groups
3329 if ( group
.type
=== undefined ) {
3330 group
.type
= 'list';
3332 if ( group
.label
=== undefined ) {
3333 group
.label
= 'ooui-toolbar-more';
3336 // Check type has been registered
3337 type
= this.getToolGroupFactory().lookup( group
.type
) ? group
.type
: defaultType
;
3339 this.getToolGroupFactory().create( type
, this, $.extend( { '$': this.$ }, group
) )
3342 this.addItems( items
);
3346 * Remove all tools and groups from the toolbar.
3348 OO
.ui
.Toolbar
.prototype.reset = function () {
3353 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3354 this.items
[i
].destroy();
3360 * Destroys toolbar, removing event handlers and DOM elements.
3362 * Call this whenever you are done using a toolbar.
3364 OO
.ui
.Toolbar
.prototype.destroy = function () {
3366 this.$element
.remove();
3370 * Check if tool has not been used yet.
3372 * @param {string} name Symbolic name of tool
3373 * @return {boolean} Tool is available
3375 OO
.ui
.Toolbar
.prototype.isToolAvailable = function ( name
) {
3376 return !this.tools
[name
];
3380 * Prevent tool from being used again.
3382 * @param {OO.ui.Tool} tool Tool to reserve
3384 OO
.ui
.Toolbar
.prototype.reserveTool = function ( tool
) {
3385 this.tools
[tool
.getName()] = tool
;
3389 * Allow tool to be used again.
3391 * @param {OO.ui.Tool} tool Tool to release
3393 OO
.ui
.Toolbar
.prototype.releaseTool = function ( tool
) {
3394 delete this.tools
[tool
.getName()];
3398 * Get accelerator label for tool.
3400 * This is a stub that should be overridden to provide access to accelerator information.
3402 * @param {string} name Symbolic name of tool
3403 * @return {string|undefined} Tool accelerator label if available
3405 OO
.ui
.Toolbar
.prototype.getToolAccelerator = function () {
3409 * Factory for tools.
3412 * @extends OO.Factory
3415 OO
.ui
.ToolFactory
= function OoUiToolFactory() {
3416 // Parent constructor
3417 OO
.ui
.ToolFactory
.super.call( this );
3422 OO
.inheritClass( OO
.ui
.ToolFactory
, OO
.Factory
);
3427 OO
.ui
.ToolFactory
.prototype.getTools = function ( include
, exclude
, promote
, demote
) {
3428 var i
, len
, included
, promoted
, demoted
,
3432 // Collect included and not excluded tools
3433 included
= OO
.simpleArrayDifference( this.extract( include
), this.extract( exclude
) );
3436 promoted
= this.extract( promote
, used
);
3437 demoted
= this.extract( demote
, used
);
3440 for ( i
= 0, len
= included
.length
; i
< len
; i
++ ) {
3441 if ( !used
[included
[i
]] ) {
3442 auto
.push( included
[i
] );
3446 return promoted
.concat( auto
).concat( demoted
);
3450 * Get a flat list of names from a list of names or groups.
3452 * Tools can be specified in the following ways:
3454 * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3455 * - All tools in a group: `{ 'group': 'group-name' }`
3456 * - All tools: `'*'`
3459 * @param {Array|string} collection List of tools
3460 * @param {Object} [used] Object with names that should be skipped as properties; extracted
3461 * names will be added as properties
3462 * @return {string[]} List of extracted names
3464 OO
.ui
.ToolFactory
.prototype.extract = function ( collection
, used
) {
3465 var i
, len
, item
, name
, tool
,
3468 if ( collection
=== '*' ) {
3469 for ( name
in this.registry
) {
3470 tool
= this.registry
[name
];
3472 // Only add tools by group name when auto-add is enabled
3473 tool
.static.autoAddToCatchall
&&
3474 // Exclude already used tools
3475 ( !used
|| !used
[name
] )
3483 } else if ( $.isArray( collection
) ) {
3484 for ( i
= 0, len
= collection
.length
; i
< len
; i
++ ) {
3485 item
= collection
[i
];
3486 // Allow plain strings as shorthand for named tools
3487 if ( typeof item
=== 'string' ) {
3488 item
= { 'name': item
};
3490 if ( OO
.isPlainObject( item
) ) {
3492 for ( name
in this.registry
) {
3493 tool
= this.registry
[name
];
3495 // Include tools with matching group
3496 tool
.static.group
=== item
.group
&&
3497 // Only add tools by group name when auto-add is enabled
3498 tool
.static.autoAddToGroup
&&
3499 // Exclude already used tools
3500 ( !used
|| !used
[name
] )
3508 // Include tools with matching name and exclude already used tools
3509 } else if ( item
.name
&& ( !used
|| !used
[item
.name
] ) ) {
3510 names
.push( item
.name
);
3512 used
[item
.name
] = true;
3521 * Collection of tools.
3523 * Tools can be specified in the following ways:
3525 * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3526 * - All tools in a group: `{ 'group': 'group-name' }`
3527 * - All tools: `'*'`
3531 * @extends OO.ui.Widget
3532 * @mixins OO.ui.GroupElement
3535 * @param {OO.ui.Toolbar} toolbar
3536 * @param {Object} [config] Configuration options
3537 * @cfg {Array|string} [include=[]] List of tools to include
3538 * @cfg {Array|string} [exclude=[]] List of tools to exclude
3539 * @cfg {Array|string} [promote=[]] List of tools to promote to the beginning
3540 * @cfg {Array|string} [demote=[]] List of tools to demote to the end
3542 OO
.ui
.ToolGroup
= function OoUiToolGroup( toolbar
, config
) {
3543 // Configuration initialization
3544 config
= config
|| {};
3546 // Parent constructor
3547 OO
.ui
.ToolGroup
.super.call( this, config
);
3549 // Mixin constructors
3550 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
3553 this.toolbar
= toolbar
;
3555 this.pressed
= null;
3556 this.autoDisabled
= false;
3557 this.include
= config
.include
|| [];
3558 this.exclude
= config
.exclude
|| [];
3559 this.promote
= config
.promote
|| [];
3560 this.demote
= config
.demote
|| [];
3561 this.onCapturedMouseUpHandler
= OO
.ui
.bind( this.onCapturedMouseUp
, this );
3565 'mousedown': OO
.ui
.bind( this.onMouseDown
, this ),
3566 'mouseup': OO
.ui
.bind( this.onMouseUp
, this ),
3567 'mouseover': OO
.ui
.bind( this.onMouseOver
, this ),
3568 'mouseout': OO
.ui
.bind( this.onMouseOut
, this )
3570 this.toolbar
.getToolFactory().connect( this, { 'register': 'onToolFactoryRegister' } );
3571 this.aggregate( { 'disable': 'itemDisable' } );
3572 this.connect( this, { 'itemDisable': 'updateDisabled' } );
3575 this.$group
.addClass( 'oo-ui-toolGroup-tools' );
3577 .addClass( 'oo-ui-toolGroup' )
3578 .append( this.$group
);
3584 OO
.inheritClass( OO
.ui
.ToolGroup
, OO
.ui
.Widget
);
3585 OO
.mixinClass( OO
.ui
.ToolGroup
, OO
.ui
.GroupElement
);
3593 /* Static Properties */
3596 * Show labels in tooltips.
3600 * @property {boolean}
3602 OO
.ui
.ToolGroup
.static.titleTooltips
= false;
3605 * Show acceleration labels in tooltips.
3609 * @property {boolean}
3611 OO
.ui
.ToolGroup
.static.accelTooltips
= false;
3614 * Automatically disable the toolgroup when all tools are disabled
3618 * @property {boolean}
3620 OO
.ui
.ToolGroup
.static.autoDisable
= true;
3627 OO
.ui
.ToolGroup
.prototype.isDisabled = function () {
3628 return this.autoDisabled
|| OO
.ui
.ToolGroup
.super.prototype.isDisabled
.apply( this, arguments
);
3634 OO
.ui
.ToolGroup
.prototype.updateDisabled = function () {
3635 var i
, item
, allDisabled
= true;
3637 if ( this.constructor.static.autoDisable
) {
3638 for ( i
= this.items
.length
- 1; i
>= 0; i
-- ) {
3639 item
= this.items
[i
];
3640 if ( !item
.isDisabled() ) {
3641 allDisabled
= false;
3645 this.autoDisabled
= allDisabled
;
3647 OO
.ui
.ToolGroup
.super.prototype.updateDisabled
.apply( this, arguments
);
3651 * Handle mouse down events.
3653 * @param {jQuery.Event} e Mouse down event
3655 OO
.ui
.ToolGroup
.prototype.onMouseDown = function ( e
) {
3656 if ( !this.isDisabled() && e
.which
=== 1 ) {
3657 this.pressed
= this.getTargetTool( e
);
3658 if ( this.pressed
) {
3659 this.pressed
.setActive( true );
3660 this.getElementDocument().addEventListener(
3661 'mouseup', this.onCapturedMouseUpHandler
, true
3669 * Handle captured mouse up events.
3671 * @param {Event} e Mouse up event
3673 OO
.ui
.ToolGroup
.prototype.onCapturedMouseUp = function ( e
) {
3674 this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseUpHandler
, true );
3675 // onMouseUp may be called a second time, depending on where the mouse is when the button is
3676 // released, but since `this.pressed` will no longer be true, the second call will be ignored.
3677 this.onMouseUp( e
);
3681 * Handle mouse up events.
3683 * @param {jQuery.Event} e Mouse up event
3685 OO
.ui
.ToolGroup
.prototype.onMouseUp = function ( e
) {
3686 var tool
= this.getTargetTool( e
);
3688 if ( !this.isDisabled() && e
.which
=== 1 && this.pressed
&& this.pressed
=== tool
) {
3689 this.pressed
.onSelect();
3692 this.pressed
= null;
3697 * Handle mouse over events.
3699 * @param {jQuery.Event} e Mouse over event
3701 OO
.ui
.ToolGroup
.prototype.onMouseOver = function ( e
) {
3702 var tool
= this.getTargetTool( e
);
3704 if ( this.pressed
&& this.pressed
=== tool
) {
3705 this.pressed
.setActive( true );
3710 * Handle mouse out events.
3712 * @param {jQuery.Event} e Mouse out event
3714 OO
.ui
.ToolGroup
.prototype.onMouseOut = function ( e
) {
3715 var tool
= this.getTargetTool( e
);
3717 if ( this.pressed
&& this.pressed
=== tool
) {
3718 this.pressed
.setActive( false );
3723 * Get the closest tool to a jQuery.Event.
3725 * Only tool links are considered, which prevents other elements in the tool such as popups from
3726 * triggering tool group interactions.
3729 * @param {jQuery.Event} e
3730 * @return {OO.ui.Tool|null} Tool, `null` if none was found
3732 OO
.ui
.ToolGroup
.prototype.getTargetTool = function ( e
) {
3734 $item
= this.$( e
.target
).closest( '.oo-ui-tool-link' );
3736 if ( $item
.length
) {
3737 tool
= $item
.parent().data( 'oo-ui-tool' );
3740 return tool
&& !tool
.isDisabled() ? tool
: null;
3744 * Handle tool registry register events.
3746 * If a tool is registered after the group is created, we must repopulate the list to account for:
3748 * - a tool being added that may be included
3749 * - a tool already included being overridden
3751 * @param {string} name Symbolic name of tool
3753 OO
.ui
.ToolGroup
.prototype.onToolFactoryRegister = function () {
3758 * Get the toolbar this group is in.
3760 * @return {OO.ui.Toolbar} Toolbar of group
3762 OO
.ui
.ToolGroup
.prototype.getToolbar = function () {
3763 return this.toolbar
;
3767 * Add and remove tools based on configuration.
3769 OO
.ui
.ToolGroup
.prototype.populate = function () {
3770 var i
, len
, name
, tool
,
3771 toolFactory
= this.toolbar
.getToolFactory(),
3775 list
= this.toolbar
.getToolFactory().getTools(
3776 this.include
, this.exclude
, this.promote
, this.demote
3779 // Build a list of needed tools
3780 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
3784 toolFactory
.lookup( name
) &&
3785 // Tool is available or is already in this group
3786 ( this.toolbar
.isToolAvailable( name
) || this.tools
[name
] )
3788 tool
= this.tools
[name
];
3790 // Auto-initialize tools on first use
3791 this.tools
[name
] = tool
= toolFactory
.create( name
, this );
3794 this.toolbar
.reserveTool( tool
);
3799 // Remove tools that are no longer needed
3800 for ( name
in this.tools
) {
3801 if ( !names
[name
] ) {
3802 this.tools
[name
].destroy();
3803 this.toolbar
.releaseTool( this.tools
[name
] );
3804 remove
.push( this.tools
[name
] );
3805 delete this.tools
[name
];
3808 if ( remove
.length
) {
3809 this.removeItems( remove
);
3811 // Update emptiness state
3813 this.$element
.removeClass( 'oo-ui-toolGroup-empty' );
3815 this.$element
.addClass( 'oo-ui-toolGroup-empty' );
3817 // Re-add tools (moving existing ones to new locations)
3818 this.addItems( add
);
3819 // Disabled state may depend on items
3820 this.updateDisabled();
3824 * Destroy tool group.
3826 OO
.ui
.ToolGroup
.prototype.destroy = function () {
3830 this.toolbar
.getToolFactory().disconnect( this );
3831 for ( name
in this.tools
) {
3832 this.toolbar
.releaseTool( this.tools
[name
] );
3833 this.tools
[name
].disconnect( this ).destroy();
3834 delete this.tools
[name
];
3836 this.$element
.remove();
3839 * Factory for tool groups.
3842 * @extends OO.Factory
3845 OO
.ui
.ToolGroupFactory
= function OoUiToolGroupFactory() {
3846 // Parent constructor
3847 OO
.Factory
.call( this );
3850 defaultClasses
= this.constructor.static.getDefaultClasses();
3852 // Register default toolgroups
3853 for ( i
= 0, l
= defaultClasses
.length
; i
< l
; i
++ ) {
3854 this.register( defaultClasses
[i
] );
3860 OO
.inheritClass( OO
.ui
.ToolGroupFactory
, OO
.Factory
);
3862 /* Static Methods */
3865 * Get a default set of classes to be registered on construction
3867 * @return {Function[]} Default classes
3869 OO
.ui
.ToolGroupFactory
.static.getDefaultClasses = function () {
3872 OO
.ui
.ListToolGroup
,
3877 * Layout made of a fieldset and optional legend.
3879 * Just add OO.ui.FieldLayout items.
3882 * @extends OO.ui.Layout
3883 * @mixins OO.ui.LabeledElement
3884 * @mixins OO.ui.IconedElement
3885 * @mixins OO.ui.GroupElement
3888 * @param {Object} [config] Configuration options
3889 * @cfg {string} [icon] Symbolic icon name
3890 * @cfg {OO.ui.FieldLayout[]} [items] Items to add
3892 OO
.ui
.FieldsetLayout
= function OoUiFieldsetLayout( config
) {
3893 // Config initialization
3894 config
= config
|| {};
3896 // Parent constructor
3897 OO
.ui
.FieldsetLayout
.super.call( this, config
);
3899 // Mixin constructors
3900 OO
.ui
.IconedElement
.call( this, this.$( '<div>' ), config
);
3901 OO
.ui
.LabeledElement
.call( this, this.$( '<div>' ), config
);
3902 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
3906 .addClass( 'oo-ui-fieldsetLayout' )
3907 .prepend( this.$icon
, this.$label
, this.$group
);
3908 if ( $.isArray( config
.items
) ) {
3909 this.addItems( config
.items
);
3915 OO
.inheritClass( OO
.ui
.FieldsetLayout
, OO
.ui
.Layout
);
3916 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.IconedElement
);
3917 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.LabeledElement
);
3918 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.GroupElement
);
3920 /* Static Properties */
3922 OO
.ui
.FieldsetLayout
.static.tagName
= 'div';
3924 * Layout made of a field and optional label.
3927 * @extends OO.ui.Layout
3928 * @mixins OO.ui.LabeledElement
3930 * Available label alignment modes include:
3931 * - 'left': Label is before the field and aligned away from it, best for when the user will be
3932 * scanning for a specific label in a form with many fields
3933 * - 'right': Label is before the field and aligned toward it, best for forms the user is very
3934 * familiar with and will tab through field checking quickly to verify which field they are in
3935 * - 'top': Label is before the field and above it, best for when the use will need to fill out all
3936 * fields from top to bottom in a form with few fields
3937 * - 'inline': Label is after the field and aligned toward it, best for small boolean fields like
3938 * checkboxes or radio buttons
3941 * @param {OO.ui.Widget} field Field widget
3942 * @param {Object} [config] Configuration options
3943 * @cfg {string} [align='left'] Alignment mode, either 'left', 'right', 'top' or 'inline'
3945 OO
.ui
.FieldLayout
= function OoUiFieldLayout( field
, config
) {
3946 // Config initialization
3947 config
= $.extend( { 'align': 'left' }, config
);
3949 // Parent constructor
3950 OO
.ui
.FieldLayout
.super.call( this, config
);
3952 // Mixin constructors
3953 OO
.ui
.LabeledElement
.call( this, this.$( '<label>' ), config
);
3956 this.$field
= this.$( '<div>' );
3961 if ( this.field
instanceof OO
.ui
.InputWidget
) {
3962 this.$label
.on( 'click', OO
.ui
.bind( this.onLabelClick
, this ) );
3964 this.field
.connect( this, { 'disable': 'onFieldDisable' } );
3967 this.$element
.addClass( 'oo-ui-fieldLayout' );
3969 .addClass( 'oo-ui-fieldLayout-field' )
3970 .toggleClass( 'oo-ui-fieldLayout-disable', this.field
.isDisabled() )
3971 .append( this.field
.$element
);
3972 this.setAlignment( config
.align
);
3977 OO
.inheritClass( OO
.ui
.FieldLayout
, OO
.ui
.Layout
);
3978 OO
.mixinClass( OO
.ui
.FieldLayout
, OO
.ui
.LabeledElement
);
3983 * Handle field disable events.
3985 * @param {boolean} value Field is disabled
3987 OO
.ui
.FieldLayout
.prototype.onFieldDisable = function ( value
) {
3988 this.$element
.toggleClass( 'oo-ui-fieldLayout-disabled', value
);
3992 * Handle label mouse click events.
3994 * @param {jQuery.Event} e Mouse click event
3996 OO
.ui
.FieldLayout
.prototype.onLabelClick = function () {
3997 this.field
.simulateLabelClick();
4004 * @return {OO.ui.Widget} Field widget
4006 OO
.ui
.FieldLayout
.prototype.getField = function () {
4011 * Set the field alignment mode.
4013 * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
4016 OO
.ui
.FieldLayout
.prototype.setAlignment = function ( value
) {
4017 if ( value
!== this.align
) {
4018 // Default to 'left'
4019 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value
) === -1 ) {
4023 if ( value
=== 'inline' ) {
4024 this.$element
.append( this.$field
, this.$label
);
4026 this.$element
.append( this.$label
, this.$field
);
4030 this.$element
.removeClass( 'oo-ui-fieldLayout-align-' + this.align
);
4033 this.$element
.addClass( 'oo-ui-fieldLayout-align-' + this.align
);
4039 * Layout made of proportionally sized columns and rows.
4042 * @extends OO.ui.Layout
4045 * @param {OO.ui.PanelLayout[]} panels Panels in the grid
4046 * @param {Object} [config] Configuration options
4047 * @cfg {number[]} [widths] Widths of columns as ratios
4048 * @cfg {number[]} [heights] Heights of columns as ratios
4050 OO
.ui
.GridLayout
= function OoUiGridLayout( panels
, config
) {
4053 // Config initialization
4054 config
= config
|| {};
4056 // Parent constructor
4057 OO
.ui
.GridLayout
.super.call( this, config
);
4065 this.$element
.addClass( 'oo-ui-gridLayout' );
4066 for ( i
= 0, len
= panels
.length
; i
< len
; i
++ ) {
4067 this.panels
.push( panels
[i
] );
4068 this.$element
.append( panels
[i
].$element
);
4070 if ( config
.widths
|| config
.heights
) {
4071 this.layout( config
.widths
|| [1], config
.heights
|| [1] );
4073 // Arrange in columns by default
4075 for ( i
= 0, len
= this.panels
.length
; i
< len
; i
++ ) {
4078 this.layout( widths
, [1] );
4084 OO
.inheritClass( OO
.ui
.GridLayout
, OO
.ui
.Layout
);
4096 /* Static Properties */
4098 OO
.ui
.GridLayout
.static.tagName
= 'div';
4103 * Set grid dimensions.
4105 * @param {number[]} widths Widths of columns as ratios
4106 * @param {number[]} heights Heights of rows as ratios
4108 * @throws {Error} If grid is not large enough to fit all panels
4110 OO
.ui
.GridLayout
.prototype.layout = function ( widths
, heights
) {
4114 cols
= widths
.length
,
4115 rows
= heights
.length
;
4117 // Verify grid is big enough to fit panels
4118 if ( cols
* rows
< this.panels
.length
) {
4119 throw new Error( 'Grid is not large enough to fit ' + this.panels
.length
+ 'panels' );
4122 // Sum up denominators
4123 for ( x
= 0; x
< cols
; x
++ ) {
4126 for ( y
= 0; y
< rows
; y
++ ) {
4132 for ( x
= 0; x
< cols
; x
++ ) {
4133 this.widths
[x
] = widths
[x
] / xd
;
4135 for ( y
= 0; y
< rows
; y
++ ) {
4136 this.heights
[y
] = heights
[y
] / yd
;
4140 this.emit( 'layout' );
4144 * Update panel positions and sizes.
4148 OO
.ui
.GridLayout
.prototype.update = function () {
4156 cols
= this.widths
.length
,
4157 rows
= this.heights
.length
;
4159 for ( y
= 0; y
< rows
; y
++ ) {
4160 for ( x
= 0; x
< cols
; x
++ ) {
4161 panel
= this.panels
[i
];
4162 width
= this.widths
[x
];
4163 height
= this.heights
[y
];
4165 'width': Math
.round( width
* 100 ) + '%',
4166 'height': Math
.round( height
* 100 ) + '%',
4167 'top': Math
.round( top
* 100 ) + '%'
4170 if ( OO
.ui
.Element
.getDir( this.$.context
) === 'rtl' ) {
4171 dimensions
.right
= Math
.round( left
* 100 ) + '%';
4173 dimensions
.left
= Math
.round( left
* 100 ) + '%';
4175 panel
.$element
.css( dimensions
);
4183 this.emit( 'update' );
4187 * Get a panel at a given position.
4189 * The x and y position is affected by the current grid layout.
4191 * @param {number} x Horizontal position
4192 * @param {number} y Vertical position
4193 * @return {OO.ui.PanelLayout} The panel at the given postion
4195 OO
.ui
.GridLayout
.prototype.getPanel = function ( x
, y
) {
4196 return this.panels
[( x
* this.widths
.length
) + y
];
4199 * Layout containing a series of pages.
4202 * @extends OO.ui.Layout
4205 * @param {Object} [config] Configuration options
4206 * @cfg {boolean} [continuous=false] Show all pages, one after another
4207 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when changing to a page
4208 * @cfg {boolean} [outlined=false] Show an outline
4209 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
4210 * @cfg {Object[]} [adders] List of adders for controls, each with name, icon and title properties
4212 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
4213 // Initialize configuration
4214 config
= config
|| {};
4216 // Parent constructor
4217 OO
.ui
.BookletLayout
.super.call( this, config
);
4220 this.currentPageName
= null;
4222 this.ignoreFocus
= false;
4223 this.stackLayout
= new OO
.ui
.StackLayout( { '$': this.$, 'continuous': !!config
.continuous
} );
4224 this.autoFocus
= config
.autoFocus
=== undefined ? true : !!config
.autoFocus
;
4225 this.outlineVisible
= false;
4226 this.outlined
= !!config
.outlined
;
4227 if ( this.outlined
) {
4228 this.editable
= !!config
.editable
;
4229 this.adders
= config
.adders
|| null;
4230 this.outlineControlsWidget
= null;
4231 this.outlineWidget
= new OO
.ui
.OutlineWidget( { '$': this.$ } );
4232 this.outlinePanel
= new OO
.ui
.PanelLayout( { '$': this.$, 'scrollable': true } );
4233 this.gridLayout
= new OO
.ui
.GridLayout(
4234 [this.outlinePanel
, this.stackLayout
], { '$': this.$, 'widths': [1, 2] }
4236 this.outlineVisible
= true;
4237 if ( this.editable
) {
4238 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
4240 { '$': this.$, 'adders': this.adders
}
4246 this.stackLayout
.connect( this, { 'set': 'onStackLayoutSet' } );
4247 if ( this.outlined
) {
4248 this.outlineWidget
.connect( this, { 'select': 'onOutlineWidgetSelect' } );
4250 if ( this.autoFocus
) {
4251 // Event 'focus' does not bubble, but 'focusin' does
4252 this.stackLayout
.onDOMEvent( 'focusin', OO
.ui
.bind( this.onStackLayoutFocus
, this ) );
4256 this.$element
.addClass( 'oo-ui-bookletLayout' );
4257 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
4258 if ( this.outlined
) {
4259 this.outlinePanel
.$element
4260 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
4261 .append( this.outlineWidget
.$element
);
4262 if ( this.editable
) {
4263 this.outlinePanel
.$element
4264 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
4265 .append( this.outlineControlsWidget
.$element
);
4267 this.$element
.append( this.gridLayout
.$element
);
4269 this.$element
.append( this.stackLayout
.$element
);
4275 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.Layout
);
4281 * @param {OO.ui.PageLayout} page Current page
4286 * @param {OO.ui.PageLayout[]} page Added pages
4287 * @param {number} index Index pages were added at
4292 * @param {OO.ui.PageLayout[]} pages Removed pages
4298 * Handle stack layout focus.
4300 * @param {jQuery.Event} e Focusin event
4302 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
4305 // Find the page that an element was focused within
4306 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
4307 for ( name
in this.pages
) {
4308 // Check for page match, exclude current page to find only page changes
4309 if ( this.pages
[name
].$element
[0] === $target
[0] && name
!== this.currentPageName
) {
4310 this.setPage( name
);
4317 * Handle stack layout set events.
4319 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
4321 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
4323 page
.scrollElementIntoView( { 'complete': OO
.ui
.bind( function () {
4324 if ( this.autoFocus
) {
4325 // Set focus to the first input if nothing on the page is focused yet
4326 if ( !page
.$element
.find( ':focus' ).length
) {
4327 page
.$element
.find( ':input:first' ).focus();
4335 * Handle outline widget select events.
4337 * @param {OO.ui.OptionWidget|null} item Selected item
4339 OO
.ui
.BookletLayout
.prototype.onOutlineWidgetSelect = function ( item
) {
4341 this.setPage( item
.getData() );
4346 * Check if booklet has an outline.
4350 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
4351 return this.outlined
;
4355 * Check if booklet has editing controls.
4359 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
4360 return this.editable
;
4364 * Check if booklet has a visible outline.
4368 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
4369 return this.outlined
&& this.outlineVisible
;
4373 * Hide or show the outline.
4375 * @param {boolean} [show] Show outline, omit to invert current state
4378 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
4379 if ( this.outlined
) {
4380 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
4381 this.outlineVisible
= show
;
4382 this.gridLayout
.layout( show
? [ 1, 2 ] : [ 0, 1 ], [ 1 ] );
4389 * Get the outline widget.
4391 * @param {OO.ui.PageLayout} page Page to be selected
4392 * @return {OO.ui.PageLayout|null} Closest page to another
4394 OO
.ui
.BookletLayout
.prototype.getClosestPage = function ( page
) {
4395 var next
, prev
, level
,
4396 pages
= this.stackLayout
.getItems(),
4397 index
= $.inArray( page
, pages
);
4399 if ( index
!== -1 ) {
4400 next
= pages
[index
+ 1];
4401 prev
= pages
[index
- 1];
4402 // Prefer adjacent pages at the same level
4403 if ( this.outlined
) {
4404 level
= this.outlineWidget
.getItemFromData( page
.getName() ).getLevel();
4407 level
=== this.outlineWidget
.getItemFromData( prev
.getName() ).getLevel()
4413 level
=== this.outlineWidget
.getItemFromData( next
.getName() ).getLevel()
4419 return prev
|| next
|| null;
4423 * Get the outline widget.
4425 * @return {OO.ui.OutlineWidget|null} Outline widget, or null if boolet has no outline
4427 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
4428 return this.outlineWidget
;
4432 * Get the outline controls widget. If the outline is not editable, null is returned.
4434 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
4436 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
4437 return this.outlineControlsWidget
;
4441 * Get a page by name.
4443 * @param {string} name Symbolic name of page
4444 * @return {OO.ui.PageLayout|undefined} Page, if found
4446 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
4447 return this.pages
[name
];
4451 * Get the current page name.
4453 * @return {string|null} Current page name
4455 OO
.ui
.BookletLayout
.prototype.getPageName = function () {
4456 return this.currentPageName
;
4460 * Add a page to the layout.
4462 * When pages are added with the same names as existing pages, the existing pages will be
4463 * automatically removed before the new pages are added.
4465 * @param {OO.ui.PageLayout[]} pages Pages to add
4466 * @param {number} index Index to insert pages after
4470 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
4471 var i
, len
, name
, page
, item
, currentIndex
,
4472 stackLayoutPages
= this.stackLayout
.getItems(),
4476 // Remove pages with same names
4477 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4479 name
= page
.getName();
4481 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
4482 // Correct the insertion index
4483 currentIndex
= $.inArray( this.pages
[name
], stackLayoutPages
);
4484 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
4487 remove
.push( this.pages
[name
] );
4490 if ( remove
.length
) {
4491 this.removePages( remove
);
4495 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4497 name
= page
.getName();
4498 this.pages
[page
.getName()] = page
;
4499 if ( this.outlined
) {
4500 item
= new OO
.ui
.OutlineItemWidget( name
, page
, { '$': this.$ } );
4501 page
.setOutlineItem( item
);
4506 if ( this.outlined
&& items
.length
) {
4507 this.outlineWidget
.addItems( items
, index
);
4508 this.updateOutlineWidget();
4510 this.stackLayout
.addItems( pages
, index
);
4511 this.emit( 'add', pages
, index
);
4517 * Remove a page from the layout.
4522 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
4523 var i
, len
, name
, page
,
4526 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4528 name
= page
.getName();
4529 delete this.pages
[name
];
4530 if ( this.outlined
) {
4531 items
.push( this.outlineWidget
.getItemFromData( name
) );
4532 page
.setOutlineItem( null );
4535 if ( this.outlined
&& items
.length
) {
4536 this.outlineWidget
.removeItems( items
);
4537 this.updateOutlineWidget();
4539 this.stackLayout
.removeItems( pages
);
4540 this.emit( 'remove', pages
);
4546 * Clear all pages from the layout.
4551 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
4553 pages
= this.stackLayout
.getItems();
4556 this.currentPageName
= null;
4557 if ( this.outlined
) {
4558 this.outlineWidget
.clearItems();
4559 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4560 pages
[i
].setOutlineItem( null );
4563 this.stackLayout
.clearItems();
4565 this.emit( 'remove', pages
);
4571 * Set the current page by name.
4574 * @param {string} name Symbolic name of page
4576 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
4578 page
= this.pages
[name
];
4580 if ( name
!== this.currentPageName
) {
4581 if ( this.outlined
) {
4582 selectedItem
= this.outlineWidget
.getSelectedItem();
4583 if ( selectedItem
&& selectedItem
.getData() !== name
) {
4584 this.outlineWidget
.selectItem( this.outlineWidget
.getItemFromData( name
) );
4588 if ( this.currentPageName
&& this.pages
[this.currentPageName
] ) {
4589 this.pages
[this.currentPageName
].setActive( false );
4590 // Blur anything focused if the next page doesn't have anything focusable - this
4591 // is not needed if the next page has something focusable because once it is focused
4592 // this blur happens automatically
4593 if ( this.autoFocus
&& !page
.$element
.find( ':input' ).length
) {
4594 this.pages
[this.currentPageName
].$element
.find( ':focus' ).blur();
4597 this.currentPageName
= name
;
4598 this.stackLayout
.setItem( page
);
4599 page
.setActive( true );
4600 this.emit( 'set', page
);
4606 * Call this after adding or removing items from the OutlineWidget.
4610 OO
.ui
.BookletLayout
.prototype.updateOutlineWidget = function () {
4611 // Auto-select first item when nothing is selected anymore
4612 if ( !this.outlineWidget
.getSelectedItem() ) {
4613 this.outlineWidget
.selectItem( this.outlineWidget
.getFirstSelectableItem() );
4619 * Layout that expands to cover the entire area of its parent, with optional scrolling and padding.
4622 * @extends OO.ui.Layout
4625 * @param {Object} [config] Configuration options
4626 * @cfg {boolean} [scrollable] Allow vertical scrolling
4627 * @cfg {boolean} [padded] Pad the content from the edges
4629 OO
.ui
.PanelLayout
= function OoUiPanelLayout( config
) {
4630 // Config initialization
4631 config
= config
|| {};
4633 // Parent constructor
4634 OO
.ui
.PanelLayout
.super.call( this, config
);
4637 this.$element
.addClass( 'oo-ui-panelLayout' );
4638 if ( config
.scrollable
) {
4639 this.$element
.addClass( 'oo-ui-panelLayout-scrollable' );
4642 if ( config
.padded
) {
4643 this.$element
.addClass( 'oo-ui-panelLayout-padded' );
4649 OO
.inheritClass( OO
.ui
.PanelLayout
, OO
.ui
.Layout
);
4651 * Page within an booklet layout.
4654 * @extends OO.ui.PanelLayout
4657 * @param {string} name Unique symbolic name of page
4658 * @param {Object} [config] Configuration options
4659 * @param {string} [outlineItem] Outline item widget
4661 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
4662 // Configuration initialization
4663 config
= $.extend( { 'scrollable': true }, config
);
4665 // Parent constructor
4666 OO
.ui
.PageLayout
.super.call( this, config
);
4670 this.outlineItem
= config
.outlineItem
|| null;
4671 this.active
= false;
4674 this.$element
.addClass( 'oo-ui-pageLayout' );
4679 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
4685 * @param {boolean} active Page is active
4693 * @return {string} Symbolic name of page
4695 OO
.ui
.PageLayout
.prototype.getName = function () {
4700 * Check if page is active.
4702 * @return {boolean} Page is active
4704 OO
.ui
.PageLayout
.prototype.isActive = function () {
4711 * @return {OO.ui.OutlineItemWidget|null} Outline item widget
4713 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
4714 return this.outlineItem
;
4720 * @param {OO.ui.OutlineItemWidget|null} outlineItem Outline item widget, null to clear
4723 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
4724 this.outlineItem
= outlineItem
;
4729 * Set page active state.
4731 * @param {boolean} Page is active
4734 OO
.ui
.PageLayout
.prototype.setActive = function ( active
) {
4737 if ( active
!== this.active
) {
4738 this.active
= active
;
4739 this.$element
.toggleClass( 'oo-ui-pageLayout-active', active
);
4740 this.emit( 'active', this.active
);
4744 * Layout containing a series of mutually exclusive pages.
4747 * @extends OO.ui.PanelLayout
4748 * @mixins OO.ui.GroupElement
4751 * @param {Object} [config] Configuration options
4752 * @cfg {boolean} [continuous=false] Show all pages, one after another
4753 * @cfg {string} [icon=''] Symbolic icon name
4754 * @cfg {OO.ui.Layout[]} [items] Layouts to add
4756 OO
.ui
.StackLayout
= function OoUiStackLayout( config
) {
4757 // Config initialization
4758 config
= $.extend( { 'scrollable': true }, config
);
4760 // Parent constructor
4761 OO
.ui
.StackLayout
.super.call( this, config
);
4763 // Mixin constructors
4764 OO
.ui
.GroupElement
.call( this, this.$element
, config
);
4767 this.currentItem
= null;
4768 this.continuous
= !!config
.continuous
;
4771 this.$element
.addClass( 'oo-ui-stackLayout' );
4772 if ( this.continuous
) {
4773 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
4775 if ( $.isArray( config
.items
) ) {
4776 this.addItems( config
.items
);
4782 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
4783 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.GroupElement
);
4789 * @param {OO.ui.Layout|null} [item] Current item
4795 * Get the current item.
4797 * @return {OO.ui.Layout|null} [description]
4799 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
4800 return this.currentItem
;
4806 * Adding an existing item (by value) will move it.
4808 * @param {OO.ui.Layout[]} items Items to add
4809 * @param {number} [index] Index to insert items after
4812 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
4813 OO
.ui
.GroupElement
.prototype.addItems
.call( this, items
, index
);
4815 if ( !this.currentItem
&& items
.length
) {
4816 this.setItem( items
[0] );
4825 * Items will be detached, not removed, so they can be used later.
4827 * @param {OO.ui.Layout[]} items Items to remove
4830 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
4831 OO
.ui
.GroupElement
.prototype.removeItems
.call( this, items
);
4832 if ( $.inArray( this.currentItem
, items
) !== -1 ) {
4833 this.currentItem
= null;
4834 if ( !this.currentItem
&& this.items
.length
) {
4835 this.setItem( this.items
[0] );
4845 * Items will be detached, not removed, so they can be used later.
4849 OO
.ui
.StackLayout
.prototype.clearItems = function () {
4850 this.currentItem
= null;
4851 OO
.ui
.GroupElement
.prototype.clearItems
.call( this );
4859 * Any currently shown item will be hidden.
4861 * @param {OO.ui.Layout} item Item to show
4864 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
4865 if ( item
!== this.currentItem
) {
4866 if ( !this.continuous
) {
4867 this.$items
.css( 'display', '' );
4869 if ( $.inArray( item
, this.items
) !== -1 ) {
4870 if ( !this.continuous
) {
4871 item
.$element
.css( 'display', 'block' );
4876 this.currentItem
= item
;
4877 this.emit( 'set', item
);
4883 * Horizontal bar layout of tools as icon buttons.
4886 * @extends OO.ui.ToolGroup
4889 * @param {OO.ui.Toolbar} toolbar
4890 * @param {Object} [config] Configuration options
4892 OO
.ui
.BarToolGroup
= function OoUiBarToolGroup( toolbar
, config
) {
4893 // Parent constructor
4894 OO
.ui
.BarToolGroup
.super.call( this, toolbar
, config
);
4897 this.$element
.addClass( 'oo-ui-barToolGroup' );
4902 OO
.inheritClass( OO
.ui
.BarToolGroup
, OO
.ui
.ToolGroup
);
4904 /* Static Properties */
4906 OO
.ui
.BarToolGroup
.static.titleTooltips
= true;
4908 OO
.ui
.BarToolGroup
.static.accelTooltips
= true;
4910 OO
.ui
.BarToolGroup
.static.name
= 'bar';
4912 * Popup list of tools with an icon and optional label.
4916 * @extends OO.ui.ToolGroup
4917 * @mixins OO.ui.IconedElement
4918 * @mixins OO.ui.IndicatedElement
4919 * @mixins OO.ui.LabeledElement
4920 * @mixins OO.ui.TitledElement
4921 * @mixins OO.ui.ClippableElement
4924 * @param {OO.ui.Toolbar} toolbar
4925 * @param {Object} [config] Configuration options
4927 OO
.ui
.PopupToolGroup
= function OoUiPopupToolGroup( toolbar
, config
) {
4928 // Configuration initialization
4929 config
= config
|| {};
4931 // Parent constructor
4932 OO
.ui
.PopupToolGroup
.super.call( this, toolbar
, config
);
4934 // Mixin constructors
4935 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
4936 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
4937 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
4938 OO
.ui
.TitledElement
.call( this, this.$element
, config
);
4939 OO
.ui
.ClippableElement
.call( this, this.$group
, config
);
4942 this.active
= false;
4943 this.dragging
= false;
4944 this.onBlurHandler
= OO
.ui
.bind( this.onBlur
, this );
4945 this.$handle
= this.$( '<span>' );
4949 'mousedown': OO
.ui
.bind( this.onHandleMouseDown
, this ),
4950 'mouseup': OO
.ui
.bind( this.onHandleMouseUp
, this )
4955 .addClass( 'oo-ui-popupToolGroup-handle' )
4956 .append( this.$icon
, this.$label
, this.$indicator
);
4958 .addClass( 'oo-ui-popupToolGroup' )
4959 .prepend( this.$handle
);
4964 OO
.inheritClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ToolGroup
);
4965 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IconedElement
);
4966 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IndicatedElement
);
4967 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.LabeledElement
);
4968 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.TitledElement
);
4969 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ClippableElement
);
4971 /* Static Properties */
4978 OO
.ui
.PopupToolGroup
.prototype.setDisabled = function () {
4980 OO
.ui
.PopupToolGroup
.super.prototype.setDisabled
.apply( this, arguments
);
4982 if ( this.isDisabled() && this.isElementAttached() ) {
4983 this.setActive( false );
4988 * Handle focus being lost.
4990 * The event is actually generated from a mouseup, so it is not a normal blur event object.
4992 * @param {jQuery.Event} e Mouse up event
4994 OO
.ui
.PopupToolGroup
.prototype.onBlur = function ( e
) {
4995 // Only deactivate when clicking outside the dropdown element
4996 if ( this.$( e
.target
).closest( '.oo-ui-popupToolGroup' )[0] !== this.$element
[0] ) {
4997 this.setActive( false );
5004 OO
.ui
.PopupToolGroup
.prototype.onMouseUp = function ( e
) {
5005 if ( !this.isDisabled() && e
.which
=== 1 ) {
5006 this.setActive( false );
5008 return OO
.ui
.ToolGroup
.prototype.onMouseUp
.call( this, e
);
5012 * Handle mouse up events.
5014 * @param {jQuery.Event} e Mouse up event
5016 OO
.ui
.PopupToolGroup
.prototype.onHandleMouseUp = function () {
5021 * Handle mouse down events.
5023 * @param {jQuery.Event} e Mouse down event
5025 OO
.ui
.PopupToolGroup
.prototype.onHandleMouseDown = function ( e
) {
5026 if ( !this.isDisabled() && e
.which
=== 1 ) {
5027 this.setActive( !this.active
);
5033 * Switch into active mode.
5035 * When active, mouseup events anywhere in the document will trigger deactivation.
5037 OO
.ui
.PopupToolGroup
.prototype.setActive = function ( value
) {
5039 if ( this.active
!== value
) {
5040 this.active
= value
;
5042 this.setClipping( true );
5043 this.$element
.addClass( 'oo-ui-popupToolGroup-active' );
5044 this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler
, true );
5046 this.setClipping( false );
5047 this.$element
.removeClass( 'oo-ui-popupToolGroup-active' );
5048 this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler
, true );
5053 * Drop down list layout of tools as labeled icon buttons.
5056 * @extends OO.ui.PopupToolGroup
5059 * @param {OO.ui.Toolbar} toolbar
5060 * @param {Object} [config] Configuration options
5062 OO
.ui
.ListToolGroup
= function OoUiListToolGroup( toolbar
, config
) {
5063 // Parent constructor
5064 OO
.ui
.ListToolGroup
.super.call( this, toolbar
, config
);
5067 this.$element
.addClass( 'oo-ui-listToolGroup' );
5072 OO
.inheritClass( OO
.ui
.ListToolGroup
, OO
.ui
.PopupToolGroup
);
5074 /* Static Properties */
5076 OO
.ui
.ListToolGroup
.static.accelTooltips
= true;
5078 OO
.ui
.ListToolGroup
.static.name
= 'list';
5080 * Drop down menu layout of tools as selectable menu items.
5083 * @extends OO.ui.PopupToolGroup
5086 * @param {OO.ui.Toolbar} toolbar
5087 * @param {Object} [config] Configuration options
5089 OO
.ui
.MenuToolGroup
= function OoUiMenuToolGroup( toolbar
, config
) {
5090 // Configuration initialization
5091 config
= config
|| {};
5093 // Parent constructor
5094 OO
.ui
.MenuToolGroup
.super.call( this, toolbar
, config
);
5097 this.toolbar
.connect( this, { 'updateState': 'onUpdateState' } );
5100 this.$element
.addClass( 'oo-ui-menuToolGroup' );
5105 OO
.inheritClass( OO
.ui
.MenuToolGroup
, OO
.ui
.PopupToolGroup
);
5107 /* Static Properties */
5109 OO
.ui
.MenuToolGroup
.static.accelTooltips
= true;
5111 OO
.ui
.MenuToolGroup
.static.name
= 'menu';
5116 * Handle the toolbar state being updated.
5118 * When the state changes, the title of each active item in the menu will be joined together and
5119 * used as a label for the group. The label will be empty if none of the items are active.
5121 OO
.ui
.MenuToolGroup
.prototype.onUpdateState = function () {
5125 for ( name
in this.tools
) {
5126 if ( this.tools
[name
].isActive() ) {
5127 labelTexts
.push( this.tools
[name
].getTitle() );
5131 this.setLabel( labelTexts
.join( ', ' ) || ' ' );
5134 * Tool that shows a popup when selected.
5138 * @extends OO.ui.Tool
5139 * @mixins OO.ui.PopuppableElement
5142 * @param {OO.ui.Toolbar} toolbar
5143 * @param {Object} [config] Configuration options
5145 OO
.ui
.PopupTool
= function OoUiPopupTool( toolbar
, config
) {
5146 // Parent constructor
5147 OO
.ui
.PopupTool
.super.call( this, toolbar
, config
);
5149 // Mixin constructors
5150 OO
.ui
.PopuppableElement
.call( this, config
);
5154 .addClass( 'oo-ui-popupTool' )
5155 .append( this.popup
.$element
);
5160 OO
.inheritClass( OO
.ui
.PopupTool
, OO
.ui
.Tool
);
5161 OO
.mixinClass( OO
.ui
.PopupTool
, OO
.ui
.PopuppableElement
);
5166 * Handle the tool being selected.
5170 OO
.ui
.PopupTool
.prototype.onSelect = function () {
5171 if ( !this.isDisabled() ) {
5172 if ( this.popup
.isVisible() ) {
5178 this.setActive( false );
5183 * Handle the toolbar state being updated.
5187 OO
.ui
.PopupTool
.prototype.onUpdateState = function () {
5188 this.setActive( false );
5193 * Mixin for OO.ui.Widget subclasses.
5195 * Use together with OO.ui.ItemWidget to make disabled state inheritable.
5199 * @extends OO.ui.GroupElement
5202 * @param {jQuery} $group Container node, assigned to #$group
5203 * @param {Object} [config] Configuration options
5205 OO
.ui
.GroupWidget
= function OoUiGroupWidget( $element
, config
) {
5206 // Parent constructor
5207 OO
.ui
.GroupWidget
.super.call( this, $element
, config
);
5212 OO
.inheritClass( OO
.ui
.GroupWidget
, OO
.ui
.GroupElement
);
5217 * Set the disabled state of the widget.
5219 * This will also update the disabled state of child widgets.
5221 * @param {boolean} disabled Disable widget
5224 OO
.ui
.GroupWidget
.prototype.setDisabled = function ( disabled
) {
5228 // Note this is calling OO.ui.Widget; we're assuming the class this is mixed into
5229 // is a subclass of OO.ui.Widget.
5230 OO
.ui
.Widget
.prototype.setDisabled
.call( this, disabled
);
5232 // During construction, #setDisabled is called before the OO.ui.GroupElement constructor
5234 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
5235 this.items
[i
].updateDisabled();
5244 * Use together with OO.ui.GroupWidget to make disabled state inheritable.
5251 OO
.ui
.ItemWidget
= function OoUiItemWidget() {
5258 * Check if widget is disabled.
5260 * Checks parent if present, making disabled state inheritable.
5262 * @return {boolean} Widget is disabled
5264 OO
.ui
.ItemWidget
.prototype.isDisabled = function () {
5265 return this.disabled
||
5266 ( this.elementGroup
instanceof OO
.ui
.Widget
&& this.elementGroup
.isDisabled() );
5270 * Set group element is in.
5272 * @param {OO.ui.GroupElement|null} group Group element, null if none
5275 OO
.ui
.ItemWidget
.prototype.setElementGroup = function ( group
) {
5277 OO
.ui
.Element
.prototype.setElementGroup
.call( this, group
);
5279 // Initialize item disabled states
5280 this.updateDisabled();
5288 * @extends OO.ui.Widget
5289 * @mixins OO.ui.IconedElement
5290 * @mixins OO.ui.TitledElement
5293 * @param {Object} [config] Configuration options
5295 OO
.ui
.IconWidget
= function OoUiIconWidget( config
) {
5296 // Config intialization
5297 config
= config
|| {};
5299 // Parent constructor
5300 OO
.ui
.IconWidget
.super.call( this, config
);
5302 // Mixin constructors
5303 OO
.ui
.IconedElement
.call( this, this.$element
, config
);
5304 OO
.ui
.TitledElement
.call( this, this.$element
, config
);
5307 this.$element
.addClass( 'oo-ui-iconWidget' );
5312 OO
.inheritClass( OO
.ui
.IconWidget
, OO
.ui
.Widget
);
5313 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.IconedElement
);
5314 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.TitledElement
);
5316 /* Static Properties */
5318 OO
.ui
.IconWidget
.static.tagName
= 'span';
5323 * @extends OO.ui.Widget
5324 * @mixins OO.ui.IndicatedElement
5325 * @mixins OO.ui.TitledElement
5328 * @param {Object} [config] Configuration options
5330 OO
.ui
.IndicatorWidget
= function OoUiIndicatorWidget( config
) {
5331 // Config intialization
5332 config
= config
|| {};
5334 // Parent constructor
5335 OO
.ui
.IndicatorWidget
.super.call( this, config
);
5337 // Mixin constructors
5338 OO
.ui
.IndicatedElement
.call( this, this.$element
, config
);
5339 OO
.ui
.TitledElement
.call( this, this.$element
, config
);
5342 this.$element
.addClass( 'oo-ui-indicatorWidget' );
5347 OO
.inheritClass( OO
.ui
.IndicatorWidget
, OO
.ui
.Widget
);
5348 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.IndicatedElement
);
5349 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.TitledElement
);
5351 /* Static Properties */
5353 OO
.ui
.IndicatorWidget
.static.tagName
= 'span';
5355 * Container for multiple related buttons.
5357 * Use together with OO.ui.ButtonWidget.
5360 * @extends OO.ui.Widget
5361 * @mixins OO.ui.GroupElement
5364 * @param {Object} [config] Configuration options
5365 * @cfg {OO.ui.ButtonWidget} [items] Buttons to add
5367 OO
.ui
.ButtonGroupWidget
= function OoUiButtonGroupWidget( config
) {
5368 // Parent constructor
5369 OO
.ui
.ButtonGroupWidget
.super.call( this, config
);
5371 // Mixin constructors
5372 OO
.ui
.GroupElement
.call( this, this.$element
, config
);
5375 this.$element
.addClass( 'oo-ui-buttonGroupWidget' );
5376 if ( $.isArray( config
.items
) ) {
5377 this.addItems( config
.items
);
5383 OO
.inheritClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.Widget
);
5384 OO
.mixinClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.GroupElement
);
5389 * @extends OO.ui.Widget
5390 * @mixins OO.ui.ButtonedElement
5391 * @mixins OO.ui.IconedElement
5392 * @mixins OO.ui.IndicatedElement
5393 * @mixins OO.ui.LabeledElement
5394 * @mixins OO.ui.TitledElement
5395 * @mixins OO.ui.FlaggableElement
5398 * @param {Object} [config] Configuration options
5399 * @cfg {string} [title=''] Title text
5400 * @cfg {string} [href] Hyperlink to visit when clicked
5401 * @cfg {string} [target] Target to open hyperlink in
5403 OO
.ui
.ButtonWidget
= function OoUiButtonWidget( config
) {
5404 // Configuration initialization
5405 config
= $.extend( { 'target': '_blank' }, config
);
5407 // Parent constructor
5408 OO
.ui
.ButtonWidget
.super.call( this, config
);
5410 // Mixin constructors
5411 OO
.ui
.ButtonedElement
.call( this, this.$( '<a>' ), config
);
5412 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
5413 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
5414 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
5415 OO
.ui
.TitledElement
.call( this, this.$button
, config
);
5416 OO
.ui
.FlaggableElement
.call( this, config
);
5419 this.isHyperlink
= typeof config
.href
=== 'string';
5423 'click': OO
.ui
.bind( this.onClick
, this ),
5424 'keypress': OO
.ui
.bind( this.onKeyPress
, this )
5429 .append( this.$icon
, this.$label
, this.$indicator
)
5430 .attr( { 'href': config
.href
, 'target': config
.target
} );
5432 .addClass( 'oo-ui-buttonWidget' )
5433 .append( this.$button
);
5438 OO
.inheritClass( OO
.ui
.ButtonWidget
, OO
.ui
.Widget
);
5439 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.ButtonedElement
);
5440 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IconedElement
);
5441 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IndicatedElement
);
5442 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.LabeledElement
);
5443 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.TitledElement
);
5444 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.FlaggableElement
);
5455 * Handles mouse click events.
5457 * @param {jQuery.Event} e Mouse click event
5460 OO
.ui
.ButtonWidget
.prototype.onClick = function () {
5461 if ( !this.isDisabled() ) {
5462 this.emit( 'click' );
5463 if ( this.isHyperlink
) {
5471 * Handles keypress events.
5473 * @param {jQuery.Event} e Keypress event
5476 OO
.ui
.ButtonWidget
.prototype.onKeyPress = function ( e
) {
5477 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
5479 if ( this.isHyperlink
) {
5490 * @extends OO.ui.Widget
5493 * @param {Object} [config] Configuration options
5494 * @cfg {string} [name=''] HTML input name
5495 * @cfg {string} [value=''] Input value
5496 * @cfg {boolean} [readOnly=false] Prevent changes
5497 * @cfg {Function} [inputFilter] Filter function to apply to the input. Takes a string argument and returns a string.
5499 OO
.ui
.InputWidget
= function OoUiInputWidget( config
) {
5500 // Config intialization
5501 config
= $.extend( { 'readOnly': false }, config
);
5503 // Parent constructor
5504 OO
.ui
.InputWidget
.super.call( this, config
);
5507 this.$input
= this.getInputElement( config
);
5509 this.readOnly
= false;
5510 this.inputFilter
= config
.inputFilter
;
5513 this.$input
.on( 'keydown mouseup cut paste change input select', OO
.ui
.bind( this.onEdit
, this ) );
5517 .attr( 'name', config
.name
)
5518 .prop( 'disabled', this.isDisabled() );
5519 this.setReadOnly( config
.readOnly
);
5520 this.$element
.addClass( 'oo-ui-inputWidget' ).append( this.$input
);
5521 this.setValue( config
.value
);
5526 OO
.inheritClass( OO
.ui
.InputWidget
, OO
.ui
.Widget
);
5538 * Get input element.
5540 * @param {Object} [config] Configuration options
5541 * @return {jQuery} Input element
5543 OO
.ui
.InputWidget
.prototype.getInputElement = function () {
5544 return this.$( '<input>' );
5548 * Handle potentially value-changing events.
5550 * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
5552 OO
.ui
.InputWidget
.prototype.onEdit = function () {
5553 if ( !this.isDisabled() ) {
5554 // Allow the stack to clear so the value will be updated
5555 setTimeout( OO
.ui
.bind( function () {
5556 this.setValue( this.$input
.val() );
5562 * Get the value of the input.
5564 * @return {string} Input value
5566 OO
.ui
.InputWidget
.prototype.getValue = function () {
5571 * Sets the direction of the current input, either RTL or LTR
5573 * @param {boolean} isRTL
5575 OO
.ui
.InputWidget
.prototype.setRTL = function ( isRTL
) {
5577 this.$input
.removeClass( 'oo-ui-ltr' );
5578 this.$input
.addClass( 'oo-ui-rtl' );
5580 this.$input
.removeClass( 'oo-ui-rtl' );
5581 this.$input
.addClass( 'oo-ui-ltr' );
5586 * Set the value of the input.
5588 * @param {string} value New value
5592 OO
.ui
.InputWidget
.prototype.setValue = function ( value
) {
5593 value
= this.sanitizeValue( value
);
5594 if ( this.value
!== value
) {
5596 this.emit( 'change', this.value
);
5598 // Update the DOM if it has changed. Note that with sanitizeValue, it
5599 // is possible for the DOM value to change without this.value changing.
5600 if ( this.$input
.val() !== this.value
) {
5601 this.$input
.val( this.value
);
5607 * Sanitize incoming value.
5609 * Ensures value is a string, and converts undefined and null to empty strings.
5611 * @param {string} value Original value
5612 * @return {string} Sanitized value
5614 OO
.ui
.InputWidget
.prototype.sanitizeValue = function ( value
) {
5615 if ( value
=== undefined || value
=== null ) {
5617 } else if ( this.inputFilter
) {
5618 return this.inputFilter( String( value
) );
5620 return String( value
);
5625 * Simulate the behavior of clicking on a label bound to this input.
5627 OO
.ui
.InputWidget
.prototype.simulateLabelClick = function () {
5628 if ( !this.isDisabled() ) {
5629 if ( this.$input
.is( ':checkbox,:radio' ) ) {
5630 this.$input
.click();
5631 } else if ( this.$input
.is( ':input' ) ) {
5632 this.$input
.focus();
5638 * Check if the widget is read-only.
5642 OO
.ui
.InputWidget
.prototype.isReadOnly = function () {
5643 return this.readOnly
;
5647 * Set the read-only state of the widget.
5649 * This should probably change the widgets's appearance and prevent it from being used.
5651 * @param {boolean} state Make input read-only
5654 OO
.ui
.InputWidget
.prototype.setReadOnly = function ( state
) {
5655 this.readOnly
= !!state
;
5656 this.$input
.prop( 'readOnly', this.readOnly
);
5663 OO
.ui
.InputWidget
.prototype.setDisabled = function ( state
) {
5664 OO
.ui
.Widget
.prototype.setDisabled
.call( this, state
);
5665 if ( this.$input
) {
5666 this.$input
.prop( 'disabled', this.isDisabled() );
5676 OO
.ui
.InputWidget
.prototype.focus = function () {
5677 this.$input
.focus();
5684 * @extends OO.ui.InputWidget
5687 * @param {Object} [config] Configuration options
5689 OO
.ui
.CheckboxInputWidget
= function OoUiCheckboxInputWidget( config
) {
5690 // Parent constructor
5691 OO
.ui
.CheckboxInputWidget
.super.call( this, config
);
5694 this.$element
.addClass( 'oo-ui-checkboxInputWidget' );
5699 OO
.inheritClass( OO
.ui
.CheckboxInputWidget
, OO
.ui
.InputWidget
);
5706 * Get input element.
5708 * @return {jQuery} Input element
5710 OO
.ui
.CheckboxInputWidget
.prototype.getInputElement = function () {
5711 return this.$( '<input type="checkbox" />' );
5715 * Get checked state of the checkbox
5717 * @return {boolean} If the checkbox is checked
5719 OO
.ui
.CheckboxInputWidget
.prototype.getValue = function () {
5726 OO
.ui
.CheckboxInputWidget
.prototype.setValue = function ( value
) {
5728 if ( this.value
!== value
) {
5730 this.$input
.prop( 'checked', this.value
);
5731 this.emit( 'change', this.value
);
5738 OO
.ui
.CheckboxInputWidget
.prototype.onEdit = function () {
5739 if ( !this.isDisabled() ) {
5740 // Allow the stack to clear so the value will be updated
5741 setTimeout( OO
.ui
.bind( function () {
5742 this.setValue( this.$input
.prop( 'checked' ) );
5750 * @extends OO.ui.Widget
5751 * @mixins OO.ui.LabeledElement
5754 * @param {Object} [config] Configuration options
5756 OO
.ui
.LabelWidget
= function OoUiLabelWidget( config
) {
5757 // Config intialization
5758 config
= config
|| {};
5760 // Parent constructor
5761 OO
.ui
.LabelWidget
.super.call( this, config
);
5763 // Mixin constructors
5764 OO
.ui
.LabeledElement
.call( this, this.$element
, config
);
5767 this.input
= config
.input
;
5770 if ( this.input
instanceof OO
.ui
.InputWidget
) {
5771 this.$element
.on( 'click', OO
.ui
.bind( this.onClick
, this ) );
5775 this.$element
.addClass( 'oo-ui-labelWidget' );
5780 OO
.inheritClass( OO
.ui
.LabelWidget
, OO
.ui
.Widget
);
5781 OO
.mixinClass( OO
.ui
.LabelWidget
, OO
.ui
.LabeledElement
);
5783 /* Static Properties */
5785 OO
.ui
.LabelWidget
.static.tagName
= 'label';
5790 * Handles label mouse click events.
5792 * @param {jQuery.Event} e Mouse click event
5794 OO
.ui
.LabelWidget
.prototype.onClick = function () {
5795 this.input
.simulateLabelClick();
5799 * Lookup input widget.
5801 * Mixin that adds a menu showing suggested values to a text input. Subclasses must handle `select`
5802 * and `choose` events on #lookupMenu to make use of selections.
5808 * @param {OO.ui.TextInputWidget} input Input widget
5809 * @param {Object} [config] Configuration options
5810 * @cfg {jQuery} [$overlay=this.$( 'body' )] Overlay layer
5812 OO
.ui
.LookupInputWidget
= function OoUiLookupInputWidget( input
, config
) {
5813 // Config intialization
5814 config
= config
|| {};
5817 this.lookupInput
= input
;
5818 this.$overlay
= config
.$overlay
|| this.$( 'body,.oo-ui-window-overlay' ).last();
5819 this.lookupMenu
= new OO
.ui
.TextInputMenuWidget( this, {
5820 '$': OO
.ui
.Element
.getJQuery( this.$overlay
),
5821 'input': this.lookupInput
,
5822 '$container': config
.$container
5824 this.lookupCache
= {};
5825 this.lookupQuery
= null;
5826 this.lookupRequest
= null;
5827 this.populating
= false;
5830 this.$overlay
.append( this.lookupMenu
.$element
);
5832 this.lookupInput
.$input
.on( {
5833 'focus': OO
.ui
.bind( this.onLookupInputFocus
, this ),
5834 'blur': OO
.ui
.bind( this.onLookupInputBlur
, this ),
5835 'mousedown': OO
.ui
.bind( this.onLookupInputMouseDown
, this )
5837 this.lookupInput
.connect( this, { 'change': 'onLookupInputChange' } );
5840 this.$element
.addClass( 'oo-ui-lookupWidget' );
5841 this.lookupMenu
.$element
.addClass( 'oo-ui-lookupWidget-menu' );
5847 * Handle input focus event.
5849 * @param {jQuery.Event} e Input focus event
5851 OO
.ui
.LookupInputWidget
.prototype.onLookupInputFocus = function () {
5852 this.openLookupMenu();
5856 * Handle input blur event.
5858 * @param {jQuery.Event} e Input blur event
5860 OO
.ui
.LookupInputWidget
.prototype.onLookupInputBlur = function () {
5861 this.lookupMenu
.hide();
5865 * Handle input mouse down event.
5867 * @param {jQuery.Event} e Input mouse down event
5869 OO
.ui
.LookupInputWidget
.prototype.onLookupInputMouseDown = function () {
5870 this.openLookupMenu();
5874 * Handle input change event.
5876 * @param {string} value New input value
5878 OO
.ui
.LookupInputWidget
.prototype.onLookupInputChange = function () {
5879 this.openLookupMenu();
5885 * @return {OO.ui.TextInputMenuWidget}
5887 OO
.ui
.LookupInputWidget
.prototype.getLookupMenu = function () {
5888 return this.lookupMenu
;
5896 OO
.ui
.LookupInputWidget
.prototype.openLookupMenu = function () {
5897 var value
= this.lookupInput
.getValue();
5899 if ( this.lookupMenu
.$input
.is( ':focus' ) && $.trim( value
) !== '' ) {
5900 this.populateLookupMenu();
5901 if ( !this.lookupMenu
.isVisible() ) {
5902 this.lookupMenu
.show();
5905 this.lookupMenu
.clearItems();
5906 this.lookupMenu
.hide();
5913 * Populate lookup menu with current information.
5917 OO
.ui
.LookupInputWidget
.prototype.populateLookupMenu = function () {
5918 if ( !this.populating
) {
5919 this.populating
= true;
5920 this.getLookupMenuItems()
5921 .done( OO
.ui
.bind( function ( items
) {
5922 this.lookupMenu
.clearItems();
5923 if ( items
.length
) {
5924 this.lookupMenu
.show();
5925 this.lookupMenu
.addItems( items
);
5926 this.initializeLookupMenuSelection();
5927 this.openLookupMenu();
5929 this.lookupMenu
.hide();
5931 this.populating
= false;
5933 .fail( OO
.ui
.bind( function () {
5934 this.lookupMenu
.clearItems();
5935 this.populating
= false;
5943 * Set selection in the lookup menu with current information.
5947 OO
.ui
.LookupInputWidget
.prototype.initializeLookupMenuSelection = function () {
5948 if ( !this.lookupMenu
.getSelectedItem() ) {
5949 this.lookupMenu
.selectItem( this.lookupMenu
.getFirstSelectableItem() );
5951 this.lookupMenu
.highlightItem( this.lookupMenu
.getSelectedItem() );
5955 * Get lookup menu items for the current query.
5957 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument
5960 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItems = function () {
5961 var value
= this.lookupInput
.getValue(),
5962 deferred
= $.Deferred();
5964 if ( value
&& value
!== this.lookupQuery
) {
5965 // Abort current request if query has changed
5966 if ( this.lookupRequest
) {
5967 this.lookupRequest
.abort();
5968 this.lookupQuery
= null;
5969 this.lookupRequest
= null;
5971 if ( value
in this.lookupCache
) {
5972 deferred
.resolve( this.getLookupMenuItemsFromData( this.lookupCache
[value
] ) );
5974 this.lookupQuery
= value
;
5975 this.lookupRequest
= this.getLookupRequest()
5976 .always( OO
.ui
.bind( function () {
5977 this.lookupQuery
= null;
5978 this.lookupRequest
= null;
5980 .done( OO
.ui
.bind( function ( data
) {
5981 this.lookupCache
[value
] = this.getLookupCacheItemFromData( data
);
5982 deferred
.resolve( this.getLookupMenuItemsFromData( this.lookupCache
[value
] ) );
5984 .fail( function () {
5988 this.lookupRequest
.always( OO
.ui
.bind( function () {
5993 return deferred
.promise();
5997 * Get a new request object of the current lookup query value.
6000 * @return {jqXHR} jQuery AJAX object, or promise object with an .abort() method
6002 OO
.ui
.LookupInputWidget
.prototype.getLookupRequest = function () {
6003 // Stub, implemented in subclass
6008 * Handle successful lookup request.
6010 * Overriding methods should call #populateLookupMenu when results are available and cache results
6011 * for future lookups in #lookupCache as an array of #OO.ui.MenuItemWidget objects.
6014 * @param {Mixed} data Response from server
6016 OO
.ui
.LookupInputWidget
.prototype.onLookupRequestDone = function () {
6017 // Stub, implemented in subclass
6021 * Get a list of menu item widgets from the data stored by the lookup request's done handler.
6024 * @param {Mixed} data Cached result data, usually an array
6025 * @return {OO.ui.MenuItemWidget[]} Menu items
6027 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItemsFromData = function () {
6028 // Stub, implemented in subclass
6034 * Use with OO.ui.SelectWidget.
6037 * @extends OO.ui.Widget
6038 * @mixins OO.ui.IconedElement
6039 * @mixins OO.ui.LabeledElement
6040 * @mixins OO.ui.IndicatedElement
6041 * @mixins OO.ui.FlaggableElement
6044 * @param {Mixed} data Option data
6045 * @param {Object} [config] Configuration options
6046 * @cfg {string} [rel] Value for `rel` attribute in DOM, allowing per-option styling
6048 OO
.ui
.OptionWidget
= function OoUiOptionWidget( data
, config
) {
6049 // Config intialization
6050 config
= config
|| {};
6052 // Parent constructor
6053 OO
.ui
.OptionWidget
.super.call( this, config
);
6055 // Mixin constructors
6056 OO
.ui
.ItemWidget
.call( this );
6057 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
6058 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
6059 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
6060 OO
.ui
.FlaggableElement
.call( this, config
);
6064 this.selected
= false;
6065 this.highlighted
= false;
6066 this.pressed
= false;
6070 .data( 'oo-ui-optionWidget', this )
6071 .attr( 'rel', config
.rel
)
6072 .addClass( 'oo-ui-optionWidget' )
6073 .append( this.$label
);
6075 .prepend( this.$icon
)
6076 .append( this.$indicator
);
6081 OO
.inheritClass( OO
.ui
.OptionWidget
, OO
.ui
.Widget
);
6082 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.ItemWidget
);
6083 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IconedElement
);
6084 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.LabeledElement
);
6085 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IndicatedElement
);
6086 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.FlaggableElement
);
6088 /* Static Properties */
6090 OO
.ui
.OptionWidget
.static.tagName
= 'li';
6092 OO
.ui
.OptionWidget
.static.selectable
= true;
6094 OO
.ui
.OptionWidget
.static.highlightable
= true;
6096 OO
.ui
.OptionWidget
.static.pressable
= true;
6098 OO
.ui
.OptionWidget
.static.scrollIntoViewOnSelect
= false;
6103 * Check if option can be selected.
6105 * @return {boolean} Item is selectable
6107 OO
.ui
.OptionWidget
.prototype.isSelectable = function () {
6108 return this.constructor.static.selectable
&& !this.isDisabled();
6112 * Check if option can be highlighted.
6114 * @return {boolean} Item is highlightable
6116 OO
.ui
.OptionWidget
.prototype.isHighlightable = function () {
6117 return this.constructor.static.highlightable
&& !this.isDisabled();
6121 * Check if option can be pressed.
6123 * @return {boolean} Item is pressable
6125 OO
.ui
.OptionWidget
.prototype.isPressable = function () {
6126 return this.constructor.static.pressable
&& !this.isDisabled();
6130 * Check if option is selected.
6132 * @return {boolean} Item is selected
6134 OO
.ui
.OptionWidget
.prototype.isSelected = function () {
6135 return this.selected
;
6139 * Check if option is highlighted.
6141 * @return {boolean} Item is highlighted
6143 OO
.ui
.OptionWidget
.prototype.isHighlighted = function () {
6144 return this.highlighted
;
6148 * Check if option is pressed.
6150 * @return {boolean} Item is pressed
6152 OO
.ui
.OptionWidget
.prototype.isPressed = function () {
6153 return this.pressed
;
6157 * Set selected state.
6159 * @param {boolean} [state=false] Select option
6162 OO
.ui
.OptionWidget
.prototype.setSelected = function ( state
) {
6163 if ( !this.isDisabled() && this.constructor.static.selectable
) {
6164 this.selected
= !!state
;
6165 if ( this.selected
) {
6166 this.$element
.addClass( 'oo-ui-optionWidget-selected' );
6167 if ( this.constructor.static.scrollIntoViewOnSelect
) {
6168 this.scrollElementIntoView();
6171 this.$element
.removeClass( 'oo-ui-optionWidget-selected' );
6178 * Set highlighted state.
6180 * @param {boolean} [state=false] Highlight option
6183 OO
.ui
.OptionWidget
.prototype.setHighlighted = function ( state
) {
6184 if ( !this.isDisabled() && this.constructor.static.highlightable
) {
6185 this.highlighted
= !!state
;
6186 if ( this.highlighted
) {
6187 this.$element
.addClass( 'oo-ui-optionWidget-highlighted' );
6189 this.$element
.removeClass( 'oo-ui-optionWidget-highlighted' );
6196 * Set pressed state.
6198 * @param {boolean} [state=false] Press option
6201 OO
.ui
.OptionWidget
.prototype.setPressed = function ( state
) {
6202 if ( !this.isDisabled() && this.constructor.static.pressable
) {
6203 this.pressed
= !!state
;
6204 if ( this.pressed
) {
6205 this.$element
.addClass( 'oo-ui-optionWidget-pressed' );
6207 this.$element
.removeClass( 'oo-ui-optionWidget-pressed' );
6214 * Make the option's highlight flash.
6216 * While flashing, the visual style of the pressed state is removed if present.
6218 * @return {jQuery.Promise} Promise resolved when flashing is done
6220 OO
.ui
.OptionWidget
.prototype.flash = function () {
6221 var $this = this.$element
,
6222 deferred
= $.Deferred();
6224 if ( !this.isDisabled() && this.constructor.static.pressable
) {
6225 $this.removeClass( 'oo-ui-optionWidget-highlighted oo-ui-optionWidget-pressed' );
6226 setTimeout( OO
.ui
.bind( function () {
6227 // Restore original classes
6229 .toggleClass( 'oo-ui-optionWidget-highlighted', this.highlighted
)
6230 .toggleClass( 'oo-ui-optionWidget-pressed', this.pressed
);
6231 setTimeout( function () {
6237 return deferred
.promise();
6243 * @return {Mixed} Option data
6245 OO
.ui
.OptionWidget
.prototype.getData = function () {
6249 * Selection of options.
6251 * Use together with OO.ui.OptionWidget.
6254 * @extends OO.ui.Widget
6255 * @mixins OO.ui.GroupElement
6258 * @param {Object} [config] Configuration options
6259 * @cfg {OO.ui.OptionWidget[]} [items] Options to add
6261 OO
.ui
.SelectWidget
= function OoUiSelectWidget( config
) {
6262 // Config intialization
6263 config
= config
|| {};
6265 // Parent constructor
6266 OO
.ui
.SelectWidget
.super.call( this, config
);
6268 // Mixin constructors
6269 OO
.ui
.GroupWidget
.call( this, this.$element
, config
);
6272 this.pressed
= false;
6273 this.selecting
= null;
6278 'mousedown': OO
.ui
.bind( this.onMouseDown
, this ),
6279 'mouseup': OO
.ui
.bind( this.onMouseUp
, this ),
6280 'mousemove': OO
.ui
.bind( this.onMouseMove
, this ),
6281 'mouseover': OO
.ui
.bind( this.onMouseOver
, this ),
6282 'mouseleave': OO
.ui
.bind( this.onMouseLeave
, this )
6286 this.$element
.addClass( 'oo-ui-selectWidget oo-ui-selectWidget-depressed' );
6287 if ( $.isArray( config
.items
) ) {
6288 this.addItems( config
.items
);
6294 OO
.inheritClass( OO
.ui
.SelectWidget
, OO
.ui
.Widget
);
6296 // Need to mixin base class as well
6297 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupElement
);
6298 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupWidget
);
6304 * @param {OO.ui.OptionWidget|null} item Highlighted item
6309 * @param {OO.ui.OptionWidget|null} item Pressed item
6314 * @param {OO.ui.OptionWidget|null} item Selected item
6319 * @param {OO.ui.OptionWidget|null} item Chosen item
6324 * @param {OO.ui.OptionWidget[]} items Added items
6325 * @param {number} index Index items were added at
6330 * @param {OO.ui.OptionWidget[]} items Removed items
6333 /* Static Properties */
6335 OO
.ui
.SelectWidget
.static.tagName
= 'ul';
6340 * Handle mouse down events.
6343 * @param {jQuery.Event} e Mouse down event
6345 OO
.ui
.SelectWidget
.prototype.onMouseDown = function ( e
) {
6348 if ( !this.isDisabled() && e
.which
=== 1 ) {
6349 this.togglePressed( true );
6350 item
= this.getTargetItem( e
);
6351 if ( item
&& item
.isSelectable() ) {
6352 this.pressItem( item
);
6353 this.selecting
= item
;
6354 this.$( this.$.context
).one( 'mouseup', OO
.ui
.bind( this.onMouseUp
, this ) );
6361 * Handle mouse up events.
6364 * @param {jQuery.Event} e Mouse up event
6366 OO
.ui
.SelectWidget
.prototype.onMouseUp = function ( e
) {
6369 this.togglePressed( false );
6370 if ( !this.selecting
) {
6371 item
= this.getTargetItem( e
);
6372 if ( item
&& item
.isSelectable() ) {
6373 this.selecting
= item
;
6376 if ( !this.isDisabled() && e
.which
=== 1 && this.selecting
) {
6377 this.pressItem( null );
6378 this.chooseItem( this.selecting
);
6379 this.selecting
= null;
6386 * Handle mouse move events.
6389 * @param {jQuery.Event} e Mouse move event
6391 OO
.ui
.SelectWidget
.prototype.onMouseMove = function ( e
) {
6394 if ( !this.isDisabled() && this.pressed
) {
6395 item
= this.getTargetItem( e
);
6396 if ( item
&& item
!== this.selecting
&& item
.isSelectable() ) {
6397 this.pressItem( item
);
6398 this.selecting
= item
;
6405 * Handle mouse over events.
6408 * @param {jQuery.Event} e Mouse over event
6410 OO
.ui
.SelectWidget
.prototype.onMouseOver = function ( e
) {
6413 if ( !this.isDisabled() ) {
6414 item
= this.getTargetItem( e
);
6415 this.highlightItem( item
&& item
.isHighlightable() ? item
: null );
6421 * Handle mouse leave events.
6424 * @param {jQuery.Event} e Mouse over event
6426 OO
.ui
.SelectWidget
.prototype.onMouseLeave = function () {
6427 if ( !this.isDisabled() ) {
6428 this.highlightItem( null );
6434 * Get the closest item to a jQuery.Event.
6437 * @param {jQuery.Event} e
6438 * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
6440 OO
.ui
.SelectWidget
.prototype.getTargetItem = function ( e
) {
6441 var $item
= this.$( e
.target
).closest( '.oo-ui-optionWidget' );
6442 if ( $item
.length
) {
6443 return $item
.data( 'oo-ui-optionWidget' );
6449 * Get selected item.
6451 * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
6453 OO
.ui
.SelectWidget
.prototype.getSelectedItem = function () {
6456 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6457 if ( this.items
[i
].isSelected() ) {
6458 return this.items
[i
];
6465 * Get highlighted item.
6467 * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
6469 OO
.ui
.SelectWidget
.prototype.getHighlightedItem = function () {
6472 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6473 if ( this.items
[i
].isHighlighted() ) {
6474 return this.items
[i
];
6481 * Get an existing item with equivilant data.
6483 * @param {Object} data Item data to search for
6484 * @return {OO.ui.OptionWidget|null} Item with equivilent value, `null` if none exists
6486 OO
.ui
.SelectWidget
.prototype.getItemFromData = function ( data
) {
6487 var hash
= OO
.getHash( data
);
6489 if ( hash
in this.hashes
) {
6490 return this.hashes
[hash
];
6497 * Toggle pressed state.
6499 * @param {boolean} pressed An option is being pressed
6501 OO
.ui
.SelectWidget
.prototype.togglePressed = function ( pressed
) {
6502 if ( pressed
=== undefined ) {
6503 pressed
= !this.pressed
;
6505 if ( pressed
!== this.pressed
) {
6506 this.$element
.toggleClass( 'oo-ui-selectWidget-pressed', pressed
);
6507 this.$element
.toggleClass( 'oo-ui-selectWidget-depressed', !pressed
);
6508 this.pressed
= pressed
;
6513 * Highlight an item.
6515 * Highlighting is mutually exclusive.
6517 * @param {OO.ui.OptionWidget} [item] Item to highlight, omit to deselect all
6521 OO
.ui
.SelectWidget
.prototype.highlightItem = function ( item
) {
6522 var i
, len
, highlighted
,
6525 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6526 highlighted
= this.items
[i
] === item
;
6527 if ( this.items
[i
].isHighlighted() !== highlighted
) {
6528 this.items
[i
].setHighlighted( highlighted
);
6533 this.emit( 'highlight', item
);
6542 * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
6546 OO
.ui
.SelectWidget
.prototype.selectItem = function ( item
) {
6547 var i
, len
, selected
,
6550 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6551 selected
= this.items
[i
] === item
;
6552 if ( this.items
[i
].isSelected() !== selected
) {
6553 this.items
[i
].setSelected( selected
);
6558 this.emit( 'select', item
);
6567 * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
6571 OO
.ui
.SelectWidget
.prototype.pressItem = function ( item
) {
6572 var i
, len
, pressed
,
6575 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6576 pressed
= this.items
[i
] === item
;
6577 if ( this.items
[i
].isPressed() !== pressed
) {
6578 this.items
[i
].setPressed( pressed
);
6583 this.emit( 'press', item
);
6592 * Identical to #selectItem, but may vary in subclasses that want to take additional action when
6593 * an item is selected using the keyboard or mouse.
6595 * @param {OO.ui.OptionWidget} item Item to choose
6599 OO
.ui
.SelectWidget
.prototype.chooseItem = function ( item
) {
6600 this.selectItem( item
);
6601 this.emit( 'choose', item
);
6607 * Get an item relative to another one.
6609 * @param {OO.ui.OptionWidget} item Item to start at
6610 * @param {number} direction Direction to move in
6611 * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the menu
6613 OO
.ui
.SelectWidget
.prototype.getRelativeSelectableItem = function ( item
, direction
) {
6614 var inc
= direction
> 0 ? 1 : -1,
6615 len
= this.items
.length
,
6616 index
= item
instanceof OO
.ui
.OptionWidget
?
6617 $.inArray( item
, this.items
) : ( inc
> 0 ? -1 : 0 ),
6618 stopAt
= Math
.max( Math
.min( index
, len
- 1 ), 0 ),
6620 // Default to 0 instead of -1, if nothing is selected let's start at the beginning
6621 Math
.max( index
, -1 ) :
6622 // Default to n-1 instead of -1, if nothing is selected let's start at the end
6623 Math
.min( index
, len
);
6626 i
= ( i
+ inc
+ len
) % len
;
6627 item
= this.items
[i
];
6628 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
6631 // Stop iterating when we've looped all the way around
6632 if ( i
=== stopAt
) {
6640 * Get the next selectable item.
6642 * @return {OO.ui.OptionWidget|null} Item, `null` if ther aren't any selectable items
6644 OO
.ui
.SelectWidget
.prototype.getFirstSelectableItem = function () {
6647 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6648 item
= this.items
[i
];
6649 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
6660 * When items are added with the same values as existing items, the existing items will be
6661 * automatically removed before the new items are added.
6663 * @param {OO.ui.OptionWidget[]} items Items to add
6664 * @param {number} [index] Index to insert items after
6668 OO
.ui
.SelectWidget
.prototype.addItems = function ( items
, index
) {
6669 var i
, len
, item
, hash
,
6672 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
6674 hash
= OO
.getHash( item
.getData() );
6675 if ( hash
in this.hashes
) {
6676 // Remove item with same value
6677 remove
.push( this.hashes
[hash
] );
6679 this.hashes
[hash
] = item
;
6681 if ( remove
.length
) {
6682 this.removeItems( remove
);
6685 OO
.ui
.GroupElement
.prototype.addItems
.call( this, items
, index
);
6687 // Always provide an index, even if it was omitted
6688 this.emit( 'add', items
, index
=== undefined ? this.items
.length
- items
.length
- 1 : index
);
6696 * Items will be detached, not removed, so they can be used later.
6698 * @param {OO.ui.OptionWidget[]} items Items to remove
6702 OO
.ui
.SelectWidget
.prototype.removeItems = function ( items
) {
6703 var i
, len
, item
, hash
;
6705 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
6707 hash
= OO
.getHash( item
.getData() );
6708 if ( hash
in this.hashes
) {
6709 // Remove existing item
6710 delete this.hashes
[hash
];
6712 if ( item
.isSelected() ) {
6713 this.selectItem( null );
6716 OO
.ui
.GroupElement
.prototype.removeItems
.call( this, items
);
6718 this.emit( 'remove', items
);
6726 * Items will be detached, not removed, so they can be used later.
6731 OO
.ui
.SelectWidget
.prototype.clearItems = function () {
6732 var items
= this.items
.slice();
6736 OO
.ui
.GroupElement
.prototype.clearItems
.call( this );
6737 this.selectItem( null );
6739 this.emit( 'remove', items
);
6746 * Use with OO.ui.MenuWidget.
6749 * @extends OO.ui.OptionWidget
6752 * @param {Mixed} data Item data
6753 * @param {Object} [config] Configuration options
6755 OO
.ui
.MenuItemWidget
= function OoUiMenuItemWidget( data
, config
) {
6756 // Configuration initialization
6757 config
= $.extend( { 'icon': 'check' }, config
);
6759 // Parent constructor
6760 OO
.ui
.MenuItemWidget
.super.call( this, data
, config
);
6763 this.$element
.addClass( 'oo-ui-menuItemWidget' );
6768 OO
.inheritClass( OO
.ui
.MenuItemWidget
, OO
.ui
.OptionWidget
);
6772 * Use together with OO.ui.MenuItemWidget.
6775 * @extends OO.ui.SelectWidget
6776 * @mixins OO.ui.ClippableElement
6779 * @param {Object} [config] Configuration options
6780 * @cfg {OO.ui.InputWidget} [input] Input to bind keyboard handlers to
6781 * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu
6783 OO
.ui
.MenuWidget
= function OoUiMenuWidget( config
) {
6784 // Config intialization
6785 config
= config
|| {};
6787 // Parent constructor
6788 OO
.ui
.MenuWidget
.super.call( this, config
);
6790 // Mixin constructors
6791 OO
.ui
.ClippableElement
.call( this, this.$group
, config
);
6794 this.autoHide
= config
.autoHide
=== undefined || !!config
.autoHide
;
6795 this.newItems
= null;
6796 this.$input
= config
.input
? config
.input
.$input
: null;
6797 this.$previousFocus
= null;
6798 this.isolated
= !config
.input
;
6799 this.visible
= false;
6800 this.flashing
= false;
6801 this.onKeyDownHandler
= OO
.ui
.bind( this.onKeyDown
, this );
6802 this.onDocumentMouseDownHandler
= OO
.ui
.bind( this.onDocumentMouseDown
, this );
6805 this.$element
.hide().addClass( 'oo-ui-menuWidget' );
6810 OO
.inheritClass( OO
.ui
.MenuWidget
, OO
.ui
.SelectWidget
);
6811 OO
.mixinClass( OO
.ui
.MenuWidget
, OO
.ui
.ClippableElement
);
6816 * Handles document mouse down events.
6818 * @param {jQuery.Event} e Key down event
6820 OO
.ui
.MenuWidget
.prototype.onDocumentMouseDown = function ( e
) {
6821 if ( !$.contains( this.$element
[0], e
.target
) ) {
6827 * Handles key down events.
6829 * @param {jQuery.Event} e Key down event
6831 OO
.ui
.MenuWidget
.prototype.onKeyDown = function ( e
) {
6834 highlightItem
= this.getHighlightedItem();
6836 if ( !this.isDisabled() && this.visible
) {
6837 if ( !highlightItem
) {
6838 highlightItem
= this.getSelectedItem();
6840 switch ( e
.keyCode
) {
6841 case OO
.ui
.Keys
.ENTER
:
6842 this.chooseItem( highlightItem
);
6846 nextItem
= this.getRelativeSelectableItem( highlightItem
, -1 );
6849 case OO
.ui
.Keys
.DOWN
:
6850 nextItem
= this.getRelativeSelectableItem( highlightItem
, 1 );
6853 case OO
.ui
.Keys
.ESCAPE
:
6854 if ( highlightItem
) {
6855 highlightItem
.setHighlighted( false );
6863 this.highlightItem( nextItem
);
6864 nextItem
.scrollElementIntoView();
6869 e
.stopPropagation();
6876 * Check if the menu is visible.
6878 * @return {boolean} Menu is visible
6880 OO
.ui
.MenuWidget
.prototype.isVisible = function () {
6881 return this.visible
;
6885 * Bind key down listener.
6887 OO
.ui
.MenuWidget
.prototype.bindKeyDownListener = function () {
6888 if ( this.$input
) {
6889 this.$input
.on( 'keydown', this.onKeyDownHandler
);
6891 // Capture menu navigation keys
6892 this.getElementWindow().addEventListener( 'keydown', this.onKeyDownHandler
, true );
6897 * Unbind key down listener.
6899 OO
.ui
.MenuWidget
.prototype.unbindKeyDownListener = function () {
6900 if ( this.$input
) {
6901 this.$input
.off( 'keydown' );
6903 this.getElementWindow().removeEventListener( 'keydown', this.onKeyDownHandler
, true );
6910 * This will close the menu when done, unlike selectItem which only changes selection.
6912 * @param {OO.ui.OptionWidget} item Item to choose
6915 OO
.ui
.MenuWidget
.prototype.chooseItem = function ( item
) {
6917 OO
.ui
.MenuWidget
.super.prototype.chooseItem
.call( this, item
);
6919 if ( item
&& !this.flashing
) {
6920 this.flashing
= true;
6921 item
.flash().done( OO
.ui
.bind( function () {
6923 this.flashing
= false;
6935 * Adding an existing item (by value) will move it.
6937 * @param {OO.ui.MenuItemWidget[]} items Items to add
6938 * @param {number} [index] Index to insert items after
6941 OO
.ui
.MenuWidget
.prototype.addItems = function ( items
, index
) {
6945 OO
.ui
.SelectWidget
.prototype.addItems
.call( this, items
, index
);
6948 if ( !this.newItems
) {
6952 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
6954 if ( this.visible
) {
6955 // Defer fitting label until
6958 this.newItems
.push( item
);
6970 OO
.ui
.MenuWidget
.prototype.show = function () {
6973 if ( this.items
.length
) {
6974 this.$element
.show();
6975 this.visible
= true;
6976 this.bindKeyDownListener();
6978 // Change focus to enable keyboard navigation
6979 if ( this.isolated
&& this.$input
&& !this.$input
.is( ':focus' ) ) {
6980 this.$previousFocus
= this.$( ':focus' );
6981 this.$input
.focus();
6983 if ( this.newItems
&& this.newItems
.length
) {
6984 for ( i
= 0, len
= this.newItems
.length
; i
< len
; i
++ ) {
6985 this.newItems
[i
].fitLabel();
6987 this.newItems
= null;
6990 this.setClipping( true );
6993 if ( this.autoHide
) {
6994 this.getElementDocument().addEventListener(
6995 'mousedown', this.onDocumentMouseDownHandler
, true
7008 OO
.ui
.MenuWidget
.prototype.hide = function () {
7009 this.$element
.hide();
7010 this.visible
= false;
7011 this.unbindKeyDownListener();
7013 if ( this.isolated
&& this.$previousFocus
) {
7014 this.$previousFocus
.focus();
7015 this.$previousFocus
= null;
7018 this.getElementDocument().removeEventListener(
7019 'mousedown', this.onDocumentMouseDownHandler
, true
7022 this.setClipping( false );
7027 * Inline menu of options.
7029 * Use with OO.ui.MenuOptionWidget.
7032 * @extends OO.ui.Widget
7033 * @mixins OO.ui.IconedElement
7034 * @mixins OO.ui.IndicatedElement
7035 * @mixins OO.ui.LabeledElement
7036 * @mixins OO.ui.TitledElement
7039 * @param {Object} [config] Configuration options
7040 * @cfg {Object} [menu] Configuration options to pass to menu widget
7042 OO
.ui
.InlineMenuWidget
= function OoUiInlineMenuWidget( config
) {
7043 // Configuration initialization
7044 config
= $.extend( { 'indicator': 'down' }, config
);
7046 // Parent constructor
7047 OO
.ui
.InlineMenuWidget
.super.call( this, config
);
7049 // Mixin constructors
7050 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
7051 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
7052 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
7053 OO
.ui
.TitledElement
.call( this, this.$label
, config
);
7056 this.menu
= new OO
.ui
.MenuWidget( $.extend( { '$': this.$ }, config
.menu
) );
7057 this.$handle
= this.$( '<span>' );
7060 this.$element
.on( { 'click': OO
.ui
.bind( this.onClick
, this ) } );
7061 this.menu
.connect( this, { 'select': 'onMenuSelect' } );
7065 .addClass( 'oo-ui-inlineMenuWidget-handle' )
7066 .append( this.$icon
, this.$label
, this.$indicator
);
7068 .addClass( 'oo-ui-inlineMenuWidget' )
7069 .append( this.$handle
, this.menu
.$element
);
7074 OO
.inheritClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.Widget
);
7075 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.IconedElement
);
7076 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.IndicatedElement
);
7077 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.LabeledElement
);
7078 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.TitledElement
);
7085 * @return {OO.ui.MenuWidget} Menu of widget
7087 OO
.ui
.InlineMenuWidget
.prototype.getMenu = function () {
7092 * Handles menu select events.
7094 * @param {OO.ui.MenuItemWidget} item Selected menu item
7096 OO
.ui
.InlineMenuWidget
.prototype.onMenuSelect = function ( item
) {
7103 selectedLabel
= item
.getLabel();
7105 // If the label is a DOM element, clone it, because setLabel will append() it
7106 if ( selectedLabel
instanceof jQuery
) {
7107 selectedLabel
= selectedLabel
.clone();
7110 this.setLabel( selectedLabel
);
7114 * Handles mouse click events.
7116 * @param {jQuery.Event} e Mouse click event
7118 OO
.ui
.InlineMenuWidget
.prototype.onClick = function ( e
) {
7119 // Skip clicks within the menu
7120 if ( $.contains( this.menu
.$element
[0], e
.target
) ) {
7124 if ( !this.isDisabled() ) {
7125 if ( this.menu
.isVisible() ) {
7134 * Menu section item widget.
7136 * Use with OO.ui.MenuWidget.
7139 * @extends OO.ui.OptionWidget
7142 * @param {Mixed} data Item data
7143 * @param {Object} [config] Configuration options
7145 OO
.ui
.MenuSectionItemWidget
= function OoUiMenuSectionItemWidget( data
, config
) {
7146 // Parent constructor
7147 OO
.ui
.MenuSectionItemWidget
.super.call( this, data
, config
);
7150 this.$element
.addClass( 'oo-ui-menuSectionItemWidget' );
7155 OO
.inheritClass( OO
.ui
.MenuSectionItemWidget
, OO
.ui
.OptionWidget
);
7157 /* Static Properties */
7159 OO
.ui
.MenuSectionItemWidget
.static.selectable
= false;
7161 OO
.ui
.MenuSectionItemWidget
.static.highlightable
= false;
7163 * Create an OO.ui.OutlineWidget object.
7165 * Use with OO.ui.OutlineItemWidget.
7168 * @extends OO.ui.SelectWidget
7171 * @param {Object} [config] Configuration options
7173 OO
.ui
.OutlineWidget
= function OoUiOutlineWidget( config
) {
7174 // Config intialization
7175 config
= config
|| {};
7177 // Parent constructor
7178 OO
.ui
.OutlineWidget
.super.call( this, config
);
7181 this.$element
.addClass( 'oo-ui-outlineWidget' );
7186 OO
.inheritClass( OO
.ui
.OutlineWidget
, OO
.ui
.SelectWidget
);
7188 * Creates an OO.ui.OutlineControlsWidget object.
7190 * Use together with OO.ui.OutlineWidget.js
7195 * @param {OO.ui.OutlineWidget} outline Outline to control
7196 * @param {Object} [config] Configuration options
7198 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
7199 // Configuration initialization
7200 config
= $.extend( { 'icon': 'add-item' }, config
);
7202 // Parent constructor
7203 OO
.ui
.OutlineControlsWidget
.super.call( this, config
);
7205 // Mixin constructors
7206 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
7207 OO
.ui
.IconedElement
.call( this, this.$( '<div>' ), config
);
7210 this.outline
= outline
;
7211 this.$movers
= this.$( '<div>' );
7212 this.upButton
= new OO
.ui
.ButtonWidget( {
7216 'title': OO
.ui
.msg( 'ooui-outline-control-move-up' )
7218 this.downButton
= new OO
.ui
.ButtonWidget( {
7222 'title': OO
.ui
.msg( 'ooui-outline-control-move-down' )
7224 this.removeButton
= new OO
.ui
.ButtonWidget( {
7228 'title': OO
.ui
.msg( 'ooui-outline-control-remove' )
7232 outline
.connect( this, {
7233 'select': 'onOutlineChange',
7234 'add': 'onOutlineChange',
7235 'remove': 'onOutlineChange'
7237 this.upButton
.connect( this, { 'click': ['emit', 'move', -1] } );
7238 this.downButton
.connect( this, { 'click': ['emit', 'move', 1] } );
7239 this.removeButton
.connect( this, { 'click': ['emit', 'remove'] } );
7242 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
7243 this.$group
.addClass( 'oo-ui-outlineControlsWidget-adders' );
7245 .addClass( 'oo-ui-outlineControlsWidget-movers' )
7246 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
7247 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
7252 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
7253 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.GroupElement
);
7254 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.IconedElement
);
7260 * @param {number} places Number of places to move
7270 * Handle outline change events.
7272 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
7273 var i
, len
, firstMovable
, lastMovable
,
7274 items
= this.outline
.getItems(),
7275 selectedItem
= this.outline
.getSelectedItem(),
7276 movable
= selectedItem
&& selectedItem
.isMovable(),
7277 removable
= selectedItem
&& selectedItem
.isRemovable();
7282 while ( ++i
< len
) {
7283 if ( items
[i
].isMovable() ) {
7284 firstMovable
= items
[i
];
7290 if ( items
[i
].isMovable() ) {
7291 lastMovable
= items
[i
];
7296 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
7297 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
7298 this.removeButton
.setDisabled( !removable
);
7301 * Creates an OO.ui.OutlineItemWidget object.
7303 * Use with OO.ui.OutlineWidget.
7306 * @extends OO.ui.OptionWidget
7309 * @param {Mixed} data Item data
7310 * @param {Object} [config] Configuration options
7311 * @cfg {number} [level] Indentation level
7312 * @cfg {boolean} [movable] Allow modification from outline controls
7314 OO
.ui
.OutlineItemWidget
= function OoUiOutlineItemWidget( data
, config
) {
7315 // Config intialization
7316 config
= config
|| {};
7318 // Parent constructor
7319 OO
.ui
.OutlineItemWidget
.super.call( this, data
, config
);
7323 this.movable
= !!config
.movable
;
7324 this.removable
= !!config
.removable
;
7327 this.$element
.addClass( 'oo-ui-outlineItemWidget' );
7328 this.setLevel( config
.level
);
7333 OO
.inheritClass( OO
.ui
.OutlineItemWidget
, OO
.ui
.OptionWidget
);
7335 /* Static Properties */
7337 OO
.ui
.OutlineItemWidget
.static.highlightable
= false;
7339 OO
.ui
.OutlineItemWidget
.static.scrollIntoViewOnSelect
= true;
7341 OO
.ui
.OutlineItemWidget
.static.levelClass
= 'oo-ui-outlineItemWidget-level-';
7343 OO
.ui
.OutlineItemWidget
.static.levels
= 3;
7348 * Check if item is movable.
7350 * Movablilty is used by outline controls.
7352 * @return {boolean} Item is movable
7354 OO
.ui
.OutlineItemWidget
.prototype.isMovable = function () {
7355 return this.movable
;
7359 * Check if item is removable.
7361 * Removablilty is used by outline controls.
7363 * @return {boolean} Item is removable
7365 OO
.ui
.OutlineItemWidget
.prototype.isRemovable = function () {
7366 return this.removable
;
7370 * Get indentation level.
7372 * @return {number} Indentation level
7374 OO
.ui
.OutlineItemWidget
.prototype.getLevel = function () {
7381 * Movablilty is used by outline controls.
7383 * @param {boolean} movable Item is movable
7386 OO
.ui
.OutlineItemWidget
.prototype.setMovable = function ( movable
) {
7387 this.movable
= !!movable
;
7394 * Removablilty is used by outline controls.
7396 * @param {boolean} movable Item is removable
7399 OO
.ui
.OutlineItemWidget
.prototype.setRemovable = function ( removable
) {
7400 this.removable
= !!removable
;
7405 * Set indentation level.
7407 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
7410 OO
.ui
.OutlineItemWidget
.prototype.setLevel = function ( level
) {
7411 var levels
= this.constructor.static.levels
,
7412 levelClass
= this.constructor.static.levelClass
,
7415 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
7417 if ( this.level
=== i
) {
7418 this.$element
.addClass( levelClass
+ i
);
7420 this.$element
.removeClass( levelClass
+ i
);
7427 * Option widget that looks like a button.
7429 * Use together with OO.ui.ButtonSelectWidget.
7432 * @extends OO.ui.OptionWidget
7433 * @mixins OO.ui.ButtonedElement
7434 * @mixins OO.ui.FlaggableElement
7437 * @param {Mixed} data Option data
7438 * @param {Object} [config] Configuration options
7440 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( data
, config
) {
7441 // Parent constructor
7442 OO
.ui
.ButtonOptionWidget
.super.call( this, data
, config
);
7444 // Mixin constructors
7445 OO
.ui
.ButtonedElement
.call( this, this.$( '<a>' ), config
);
7446 OO
.ui
.FlaggableElement
.call( this, config
);
7449 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
7450 this.$button
.append( this.$element
.contents() );
7451 this.$element
.append( this.$button
);
7456 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.OptionWidget
);
7457 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.ButtonedElement
);
7458 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.FlaggableElement
);
7465 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
7466 OO
.ui
.OptionWidget
.prototype.setSelected
.call( this, state
);
7468 this.setActive( state
);
7473 * Select widget containing button options.
7475 * Use together with OO.ui.ButtonOptionWidget.
7478 * @extends OO.ui.SelectWidget
7481 * @param {Object} [config] Configuration options
7483 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
7484 // Parent constructor
7485 OO
.ui
.ButtonSelectWidget
.super.call( this, config
);
7488 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
7493 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
7495 * Container for content that is overlaid and positioned absolutely.
7498 * @extends OO.ui.Widget
7499 * @mixins OO.ui.LabeledElement
7502 * @param {Object} [config] Configuration options
7503 * @cfg {boolean} [tail=true] Show tail pointing to origin of popup
7504 * @cfg {string} [align='center'] Alignment of popup to origin
7505 * @cfg {jQuery} [$container] Container to prevent popup from rendering outside of
7506 * @cfg {boolean} [autoClose=false] Popup auto-closes when it loses focus
7507 * @cfg {jQuery} [$autoCloseIgnore] Elements to not auto close when clicked
7508 * @cfg {boolean} [head] Show label and close button at the top
7510 OO
.ui
.PopupWidget
= function OoUiPopupWidget( config
) {
7511 // Config intialization
7512 config
= config
|| {};
7514 // Parent constructor
7515 OO
.ui
.PopupWidget
.super.call( this, config
);
7517 // Mixin constructors
7518 OO
.ui
.LabeledElement
.call( this, this.$( '<div>' ), config
);
7519 OO
.ui
.ClippableElement
.call( this, this.$( '<div>' ), config
);
7522 this.visible
= false;
7523 this.$popup
= this.$( '<div>' );
7524 this.$head
= this.$( '<div>' );
7525 this.$body
= this.$clippable
;
7526 this.$tail
= this.$( '<div>' );
7527 this.$container
= config
.$container
|| this.$( 'body' );
7528 this.autoClose
= !!config
.autoClose
;
7529 this.$autoCloseIgnore
= config
.$autoCloseIgnore
;
7530 this.transitionTimeout
= null;
7532 this.align
= config
.align
|| 'center';
7533 this.closeButton
= new OO
.ui
.ButtonWidget( { '$': this.$, 'frameless': true, 'icon': 'close' } );
7534 this.onMouseDownHandler
= OO
.ui
.bind( this.onMouseDown
, this );
7537 this.closeButton
.connect( this, { 'click': 'onCloseButtonClick' } );
7540 this.useTail( config
.tail
!== undefined ? !!config
.tail
: true );
7541 this.$body
.addClass( 'oo-ui-popupWidget-body' );
7542 this.$tail
.addClass( 'oo-ui-popupWidget-tail' );
7544 .addClass( 'oo-ui-popupWidget-head' )
7545 .append( this.$label
, this.closeButton
.$element
);
7546 if ( !config
.head
) {
7550 .addClass( 'oo-ui-popupWidget-popup' )
7551 .append( this.$head
, this.$body
);
7552 this.$element
.hide()
7553 .addClass( 'oo-ui-popupWidget' )
7554 .append( this.$popup
, this.$tail
);
7559 OO
.inheritClass( OO
.ui
.PopupWidget
, OO
.ui
.Widget
);
7560 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.LabeledElement
);
7561 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.ClippableElement
);
7576 * Handles mouse down events.
7578 * @param {jQuery.Event} e Mouse down event
7580 OO
.ui
.PopupWidget
.prototype.onMouseDown = function ( e
) {
7583 !$.contains( this.$element
[0], e
.target
) &&
7584 ( !this.$autoCloseIgnore
|| !this.$autoCloseIgnore
.has( e
.target
).length
)
7591 * Bind mouse down listener.
7593 OO
.ui
.PopupWidget
.prototype.bindMouseDownListener = function () {
7594 // Capture clicks outside popup
7595 this.getElementWindow().addEventListener( 'mousedown', this.onMouseDownHandler
, true );
7599 * Handles close button click events.
7601 OO
.ui
.PopupWidget
.prototype.onCloseButtonClick = function () {
7602 if ( this.visible
) {
7608 * Unbind mouse down listener.
7610 OO
.ui
.PopupWidget
.prototype.unbindMouseDownListener = function () {
7611 this.getElementWindow().removeEventListener( 'mousedown', this.onMouseDownHandler
, true );
7615 * Check if the popup is visible.
7617 * @return {boolean} Popup is visible
7619 OO
.ui
.PopupWidget
.prototype.isVisible = function () {
7620 return this.visible
;
7624 * Set whether to show a tail.
7626 * @return {boolean} Make tail visible
7628 OO
.ui
.PopupWidget
.prototype.useTail = function ( value
) {
7630 if ( this.tail
!== value
) {
7633 this.$element
.addClass( 'oo-ui-popupWidget-tailed' );
7635 this.$element
.removeClass( 'oo-ui-popupWidget-tailed' );
7641 * Check if showing a tail.
7643 * @return {boolean} tail is visible
7645 OO
.ui
.PopupWidget
.prototype.hasTail = function () {
7655 OO
.ui
.PopupWidget
.prototype.show = function () {
7656 if ( !this.visible
) {
7657 this.setClipping( true );
7658 this.$element
.show();
7659 this.visible
= true;
7660 this.emit( 'show' );
7661 if ( this.autoClose
) {
7662 this.bindMouseDownListener();
7674 OO
.ui
.PopupWidget
.prototype.hide = function () {
7675 if ( this.visible
) {
7676 this.setClipping( false );
7677 this.$element
.hide();
7678 this.visible
= false;
7679 this.emit( 'hide' );
7680 if ( this.autoClose
) {
7681 this.unbindMouseDownListener();
7688 * Updates the position and size.
7690 * @param {number} width Width
7691 * @param {number} height Height
7692 * @param {boolean} [transition=false] Use a smooth transition
7695 OO
.ui
.PopupWidget
.prototype.display = function ( width
, height
, transition
) {
7697 originOffset
= Math
.round( this.$element
.offset().left
),
7698 containerLeft
= Math
.round( this.$container
.offset().left
),
7699 containerWidth
= this.$container
.innerWidth(),
7700 containerRight
= containerLeft
+ containerWidth
,
7701 popupOffset
= width
* ( { 'left': 0, 'center': -0.5, 'right': -1 } )[this.align
],
7702 popupLeft
= popupOffset
- padding
,
7703 popupRight
= popupOffset
+ padding
+ width
+ padding
,
7704 overlapLeft
= ( originOffset
+ popupLeft
) - containerLeft
,
7705 overlapRight
= containerRight
- ( originOffset
+ popupRight
);
7707 // Prevent transition from being interrupted
7708 clearTimeout( this.transitionTimeout
);
7710 // Enable transition
7711 this.$element
.addClass( 'oo-ui-popupWidget-transitioning' );
7714 if ( overlapRight
< 0 ) {
7715 popupOffset
+= overlapRight
;
7716 } else if ( overlapLeft
< 0 ) {
7717 popupOffset
-= overlapLeft
;
7720 // Position body relative to anchor and resize
7722 'left': popupOffset
,
7724 'height': height
=== undefined ? 'auto' : height
7728 // Prevent transitioning after transition is complete
7729 this.transitionTimeout
= setTimeout( OO
.ui
.bind( function () {
7730 this.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
7733 // Prevent transitioning immediately
7734 this.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
7740 * Button that shows and hides a popup.
7743 * @extends OO.ui.ButtonWidget
7744 * @mixins OO.ui.PopuppableElement
7747 * @param {Object} [config] Configuration options
7749 OO
.ui
.PopupButtonWidget
= function OoUiPopupButtonWidget( config
) {
7750 // Parent constructor
7751 OO
.ui
.PopupButtonWidget
.super.call( this, config
);
7753 // Mixin constructors
7754 OO
.ui
.PopuppableElement
.call( this, config
);
7758 .addClass( 'oo-ui-popupButtonWidget' )
7759 .append( this.popup
.$element
);
7764 OO
.inheritClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.ButtonWidget
);
7765 OO
.mixinClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.PopuppableElement
);
7770 * Handles mouse click events.
7772 * @param {jQuery.Event} e Mouse click event
7774 OO
.ui
.PopupButtonWidget
.prototype.onClick = function ( e
) {
7775 // Skip clicks within the popup
7776 if ( $.contains( this.popup
.$element
[0], e
.target
) ) {
7780 if ( !this.isDisabled() ) {
7781 if ( this.popup
.isVisible() ) {
7786 OO
.ui
.ButtonWidget
.prototype.onClick
.call( this );
7793 * Combines query and results selection widgets.
7796 * @extends OO.ui.Widget
7799 * @param {Object} [config] Configuration options
7800 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
7801 * @cfg {string} [value] Initial query value
7803 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
7804 // Configuration intialization
7805 config
= config
|| {};
7807 // Parent constructor
7808 OO
.ui
.SearchWidget
.super.call( this, config
);
7811 this.query
= new OO
.ui
.TextInputWidget( {
7814 'placeholder': config
.placeholder
,
7815 'value': config
.value
7817 this.results
= new OO
.ui
.SelectWidget( { '$': this.$ } );
7818 this.$query
= this.$( '<div>' );
7819 this.$results
= this.$( '<div>' );
7822 this.query
.connect( this, {
7823 'change': 'onQueryChange',
7824 'enter': 'onQueryEnter'
7826 this.results
.connect( this, {
7827 'highlight': 'onResultsHighlight',
7828 'select': 'onResultsSelect'
7830 this.query
.$input
.on( 'keydown', OO
.ui
.bind( this.onQueryKeydown
, this ) );
7834 .addClass( 'oo-ui-searchWidget-query' )
7835 .append( this.query
.$element
);
7837 .addClass( 'oo-ui-searchWidget-results' )
7838 .append( this.results
.$element
);
7840 .addClass( 'oo-ui-searchWidget' )
7841 .append( this.$results
, this.$query
);
7846 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
7852 * @param {Object|null} item Item data or null if no item is highlighted
7857 * @param {Object|null} item Item data or null if no item is selected
7863 * Handle query key down events.
7865 * @param {jQuery.Event} e Key down event
7867 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
7868 var highlightedItem
, nextItem
,
7869 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
7872 highlightedItem
= this.results
.getHighlightedItem();
7873 if ( !highlightedItem
) {
7874 highlightedItem
= this.results
.getSelectedItem();
7876 nextItem
= this.results
.getRelativeSelectableItem( highlightedItem
, dir
);
7877 this.results
.highlightItem( nextItem
);
7878 nextItem
.scrollElementIntoView();
7883 * Handle select widget select events.
7885 * Clears existing results. Subclasses should repopulate items according to new query.
7887 * @param {string} value New value
7889 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
7891 this.results
.clearItems();
7895 * Handle select widget enter key events.
7897 * Selects highlighted item.
7899 * @param {string} value New value
7901 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
7903 this.results
.selectItem( this.results
.getHighlightedItem() );
7907 * Handle select widget highlight events.
7909 * @param {OO.ui.OptionWidget} item Highlighted item
7912 OO
.ui
.SearchWidget
.prototype.onResultsHighlight = function ( item
) {
7913 this.emit( 'highlight', item
? item
.getData() : null );
7917 * Handle select widget select events.
7919 * @param {OO.ui.OptionWidget} item Selected item
7922 OO
.ui
.SearchWidget
.prototype.onResultsSelect = function ( item
) {
7923 this.emit( 'select', item
? item
.getData() : null );
7927 * Get the query input.
7929 * @return {OO.ui.TextInputWidget} Query input
7931 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
7936 * Get the results list.
7938 * @return {OO.ui.SelectWidget} Select list
7940 OO
.ui
.SearchWidget
.prototype.getResults = function () {
7941 return this.results
;
7944 * Text input widget.
7947 * @extends OO.ui.InputWidget
7950 * @param {Object} [config] Configuration options
7951 * @cfg {string} [placeholder] Placeholder text
7952 * @cfg {string} [icon] Symbolic name of icon
7953 * @cfg {boolean} [multiline=false] Allow multiple lines of text
7954 * @cfg {boolean} [autosize=false] Automatically resize to fit content
7955 * @cfg {boolean} [maxRows=10] Maximum number of rows to make visible when autosizing
7957 OO
.ui
.TextInputWidget
= function OoUiTextInputWidget( config
) {
7958 config
= $.extend( { 'maxRows': 10 }, config
);
7960 // Parent constructor
7961 OO
.ui
.TextInputWidget
.super.call( this, config
);
7965 this.multiline
= !!config
.multiline
;
7966 this.autosize
= !!config
.autosize
;
7967 this.maxRows
= config
.maxRows
;
7970 this.$input
.on( 'keypress', OO
.ui
.bind( this.onKeyPress
, this ) );
7971 this.$element
.on( 'DOMNodeInsertedIntoDocument', OO
.ui
.bind( this.onElementAttach
, this ) );
7974 this.$element
.addClass( 'oo-ui-textInputWidget' );
7975 if ( config
.icon
) {
7976 this.$element
.addClass( 'oo-ui-textInputWidget-decorated' );
7977 this.$element
.append(
7979 .addClass( 'oo-ui-textInputWidget-icon oo-ui-icon-' + config
.icon
)
7980 .mousedown( OO
.ui
.bind( function () {
7981 this.$input
.focus();
7986 if ( config
.placeholder
) {
7987 this.$input
.attr( 'placeholder', config
.placeholder
);
7993 OO
.inheritClass( OO
.ui
.TextInputWidget
, OO
.ui
.InputWidget
);
7998 * User presses enter inside the text box.
8000 * Not called if input is multiline.
8008 * Handle key press events.
8010 * @param {jQuery.Event} e Key press event
8011 * @fires enter If enter key is pressed and input is not multiline
8013 OO
.ui
.TextInputWidget
.prototype.onKeyPress = function ( e
) {
8014 if ( e
.which
=== OO
.ui
.Keys
.ENTER
&& !this.multiline
) {
8015 this.emit( 'enter' );
8020 * Handle element attach events.
8022 * @param {jQuery.Event} e Element attach event
8024 OO
.ui
.TextInputWidget
.prototype.onElementAttach = function () {
8031 OO
.ui
.TextInputWidget
.prototype.onEdit = function () {
8035 return OO
.ui
.InputWidget
.prototype.onEdit
.call( this );
8039 * Automatically adjust the size of the text input.
8041 * This only affects multi-line inputs that are auto-sized.
8045 OO
.ui
.TextInputWidget
.prototype.adjustSize = function () {
8046 var $clone
, scrollHeight
, innerHeight
, outerHeight
, maxInnerHeight
, idealHeight
;
8048 if ( this.multiline
&& this.autosize
) {
8049 $clone
= this.$input
.clone()
8050 .val( this.$input
.val() )
8051 .css( { 'height': 0 } )
8052 .insertAfter( this.$input
);
8053 // Set inline height property to 0 to measure scroll height
8054 scrollHeight
= $clone
[0].scrollHeight
;
8055 // Remove inline height property to measure natural heights
8056 $clone
.css( 'height', '' );
8057 innerHeight
= $clone
.innerHeight();
8058 outerHeight
= $clone
.outerHeight();
8059 // Measure max rows height
8060 $clone
.attr( 'rows', this.maxRows
).css( 'height', 'auto' );
8061 maxInnerHeight
= $clone
.innerHeight();
8062 $clone
.removeAttr( 'rows' ).css( 'height', '' );
8064 idealHeight
= Math
.min( maxInnerHeight
, scrollHeight
);
8065 // Only apply inline height when expansion beyond natural height is needed
8068 // Use the difference between the inner and outer height as a buffer
8069 idealHeight
> outerHeight
? idealHeight
+ ( outerHeight
- innerHeight
) : ''
8076 * Get input element.
8078 * @param {Object} [config] Configuration options
8079 * @return {jQuery} Input element
8081 OO
.ui
.TextInputWidget
.prototype.getInputElement = function ( config
) {
8082 return config
.multiline
? this.$( '<textarea>' ) : this.$( '<input type="text" />' );
8088 * Check if input supports multiple lines.
8092 OO
.ui
.TextInputWidget
.prototype.isMultiline = function () {
8093 return !!this.multiline
;
8097 * Check if input automatically adjusts its size.
8101 OO
.ui
.TextInputWidget
.prototype.isAutosizing = function () {
8102 return !!this.autosize
;
8106 * Check if input is pending.
8110 OO
.ui
.TextInputWidget
.prototype.isPending = function () {
8111 return !!this.pending
;
8115 * Increase the pending stack.
8119 OO
.ui
.TextInputWidget
.prototype.pushPending = function () {
8120 if ( this.pending
=== 0 ) {
8121 this.$element
.addClass( 'oo-ui-textInputWidget-pending' );
8122 this.$input
.addClass( 'oo-ui-texture-pending' );
8130 * Reduce the pending stack.
8136 OO
.ui
.TextInputWidget
.prototype.popPending = function () {
8137 if ( this.pending
=== 1 ) {
8138 this.$element
.removeClass( 'oo-ui-textInputWidget-pending' );
8139 this.$input
.removeClass( 'oo-ui-texture-pending' );
8141 this.pending
= Math
.max( 0, this.pending
- 1 );
8147 * Select the contents of the input.
8151 OO
.ui
.TextInputWidget
.prototype.select = function () {
8152 this.$input
.select();
8156 * Menu for a text input widget.
8159 * @extends OO.ui.MenuWidget
8162 * @param {OO.ui.TextInputWidget} input Text input widget to provide menu for
8163 * @param {Object} [config] Configuration options
8164 * @cfg {jQuery} [$container=input.$element] Element to render menu under
8166 OO
.ui
.TextInputMenuWidget
= function OoUiTextInputMenuWidget( input
, config
) {
8167 // Parent constructor
8168 OO
.ui
.TextInputMenuWidget
.super.call( this, config
);
8172 this.$container
= config
.$container
|| this.input
.$element
;
8173 this.onWindowResizeHandler
= OO
.ui
.bind( this.onWindowResize
, this );
8176 this.$element
.addClass( 'oo-ui-textInputMenuWidget' );
8181 OO
.inheritClass( OO
.ui
.TextInputMenuWidget
, OO
.ui
.MenuWidget
);
8186 * Handle window resize event.
8188 * @param {jQuery.Event} e Window resize event
8190 OO
.ui
.TextInputMenuWidget
.prototype.onWindowResize = function () {
8199 OO
.ui
.TextInputMenuWidget
.prototype.show = function () {
8201 OO
.ui
.MenuWidget
.prototype.show
.call( this );
8204 this.$( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler
);
8213 OO
.ui
.TextInputMenuWidget
.prototype.hide = function () {
8215 OO
.ui
.MenuWidget
.prototype.hide
.call( this );
8217 this.$( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler
);
8222 * Position the menu.
8226 OO
.ui
.TextInputMenuWidget
.prototype.position = function () {
8228 $container
= this.$container
,
8229 dimensions
= $container
.offset();
8231 // Position under input
8232 dimensions
.top
+= $container
.height();
8234 // Compensate for frame position if in a differnt frame
8235 if ( this.input
.$.frame
&& this.input
.$.context
!== this.$element
[0].ownerDocument
) {
8236 frameOffset
= OO
.ui
.Element
.getRelativePosition(
8237 this.input
.$.frame
.$element
, this.$element
.offsetParent()
8239 dimensions
.left
+= frameOffset
.left
;
8240 dimensions
.top
+= frameOffset
.top
;
8242 // Fix for RTL (for some reason, no need to fix if the frameoffset is set)
8243 if ( this.$element
.css( 'direction' ) === 'rtl' ) {
8244 dimensions
.right
= this.$element
.parent().position().left
-
8245 dimensions
.width
- dimensions
.left
;
8246 // Erase the value for 'left':
8247 delete dimensions
.left
;
8251 this.$element
.css( dimensions
);
8252 this.setIdealSize( $container
.width() );
8256 * Width with on and off states.
8258 * Mixin for widgets with a boolean state.
8264 * @param {Object} [config] Configuration options
8265 * @cfg {boolean} [value=false] Initial value
8267 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
8268 // Configuration initialization
8269 config
= config
|| {};
8275 this.$element
.addClass( 'oo-ui-toggleWidget' );
8276 this.setValue( !!config
.value
);
8283 * @param {boolean} value Changed value
8289 * Get the value of the toggle.
8293 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
8298 * Set the value of the toggle.
8300 * @param {boolean} value New value
8304 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
8306 if ( this.value
!== value
) {
8308 this.emit( 'change', value
);
8309 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
8310 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
8315 * Button that toggles on and off.
8318 * @extends OO.ui.ButtonWidget
8319 * @mixins OO.ui.ToggleWidget
8322 * @param {Object} [config] Configuration options
8323 * @cfg {boolean} [value=false] Initial value
8325 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
8326 // Configuration initialization
8327 config
= config
|| {};
8329 // Parent constructor
8330 OO
.ui
.ToggleButtonWidget
.super.call( this, config
);
8332 // Mixin constructors
8333 OO
.ui
.ToggleWidget
.call( this, config
);
8336 this.$element
.addClass( 'oo-ui-toggleButtonWidget' );
8341 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ButtonWidget
);
8342 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
8349 OO
.ui
.ToggleButtonWidget
.prototype.onClick = function () {
8350 if ( !this.isDisabled() ) {
8351 this.setValue( !this.value
);
8355 return OO
.ui
.ButtonWidget
.prototype.onClick
.call( this );
8361 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
8363 if ( value
!== this.value
) {
8364 this.setActive( value
);
8368 OO
.ui
.ToggleWidget
.prototype.setValue
.call( this, value
);
8373 * Switch that slides on and off.
8376 * @extends OO.ui.Widget
8377 * @mixins OO.ui.ToggleWidget
8380 * @param {Object} [config] Configuration options
8381 * @cfg {boolean} [value=false] Initial value
8383 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
8384 // Parent constructor
8385 OO
.ui
.ToggleSwitchWidget
.super.call( this, config
);
8387 // Mixin constructors
8388 OO
.ui
.ToggleWidget
.call( this, config
);
8391 this.dragging
= false;
8392 this.dragStart
= null;
8393 this.sliding
= false;
8394 this.$glow
= this.$( '<span>' );
8395 this.$grip
= this.$( '<span>' );
8398 this.$element
.on( 'click', OO
.ui
.bind( this.onClick
, this ) );
8401 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
8402 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
8404 .addClass( 'oo-ui-toggleSwitchWidget' )
8405 .append( this.$glow
, this.$grip
);
8410 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.Widget
);
8411 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
8416 * Handle mouse down events.
8418 * @param {jQuery.Event} e Mouse down event
8420 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
8421 if ( !this.isDisabled() && e
.which
=== 1 ) {
8422 this.setValue( !this.value
);