2 * OOjs UI v0.1.0-pre (0436296667)
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: Wed May 21 2014 13:17:11 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 this.cancelButton
.connect( this, { 'click': [ 'emit', 'cancel' ] } );
1963 this.okButton
= new OO
.ui
.ButtonWidget();
1964 this.okButton
.connect( this, { 'click': [ 'emit', 'ok' ] } );
1967 contentLayout
.$element
.append( this.$promptContainer
);
1968 this.$body
.append( contentLayout
.$element
);
1971 this.okButton
.$element
,
1972 this.cancelButton
.$element
1975 this.connect( this, {
1978 'close': [ 'emit', 'cancel' ]
1983 * Open a confirmation dialog.
1985 * @param {Object} [data] Window opening data including text of the dialog and text for the buttons
1986 * @param {jQuery|string} [data.prompt] Text to display or list of nodes to use as content of the dialog.
1987 * @param {jQuery|string|Function|null} [data.okLabel] Label of the OK button
1988 * @param {jQuery|string|Function|null} [data.cancelLabel] Label of the cancel button
1989 * @param {string|string[]} [data.okFlags="constructive"] Flags for the OK button
1990 * @param {string|string[]} [data.cancelFlags="destructive"] Flags for the cancel button
1992 OO
.ui
.ConfirmationDialog
.prototype.setup = function ( data
) {
1994 OO
.ui
.Dialog
.prototype.setup
.call( this, data
);
1996 var prompt
= data
.prompt
|| OO
.ui
.deferMsg( 'ooui-dialog-confirm-default-prompt' ),
1997 okLabel
= data
.okLabel
|| OO
.ui
.deferMsg( 'ooui-dialog-confirm-default-ok' ),
1998 cancelLabel
= data
.cancelLabel
|| OO
.ui
.deferMsg( 'ooui-dialog-confirm-default-cancel' ),
1999 okFlags
= data
.okFlags
|| 'constructive',
2000 cancelFlags
= data
.cancelFlags
|| 'destructive';
2002 if ( typeof prompt
=== 'string' ) {
2003 this.$promptContainer
.text( prompt
);
2005 this.$promptContainer
.empty().append( prompt
);
2008 this.okButton
.setLabel( okLabel
).clearFlags().setFlags( okFlags
);
2009 this.cancelButton
.setLabel( cancelLabel
).clearFlags().setFlags( cancelFlags
);
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|string[]|Object.<string, boolean>} flags One or more flags to add, or an object
2303 * keyed by flag name containing boolean set/remove instructions.
2306 OO
.ui
.FlaggableElement
.prototype.setFlags = function ( flags
) {
2308 classPrefix
= 'oo-ui-flaggableElement-';
2310 if ( typeof flags
=== 'string' ) {
2312 this.flags
[flags
] = true;
2313 this.$element
.addClass( classPrefix
+ flags
);
2314 } else if ( $.isArray( flags
) ) {
2315 for ( i
= 0, len
= flags
.length
; i
< len
; i
++ ) {
2318 this.flags
[flag
] = true;
2319 this.$element
.addClass( classPrefix
+ flag
);
2321 } else if ( OO
.isPlainObject( flags
) ) {
2322 for ( flag
in flags
) {
2323 if ( flags
[flag
] ) {
2325 this.flags
[flag
] = true;
2326 this.$element
.addClass( classPrefix
+ flag
);
2329 delete this.flags
[flag
];
2330 this.$element
.removeClass( classPrefix
+ flag
);
2337 * Element containing a sequence of child elements.
2343 * @param {jQuery} $group Container node, assigned to #$group
2344 * @param {Object} [config] Configuration options
2346 OO
.ui
.GroupElement
= function OoUiGroupElement( $group
, config
) {
2348 config
= config
|| {};
2351 this.$group
= $group
;
2353 this.$items
= this.$( [] );
2354 this.aggregateItemEvents
= {};
2362 * @return {OO.ui.Element[]} Items
2364 OO
.ui
.GroupElement
.prototype.getItems = function () {
2365 return this.items
.slice( 0 );
2369 * Add an aggregate item event.
2371 * Aggregated events are listened to on each item and then emitted by the group under a new name,
2372 * and with an additional leading parameter containing the item that emitted the original event.
2373 * Other arguments that were emitted from the original event are passed through.
2375 * @param {Object.<string,string|null>} events Aggregate events emitted by group, keyed by item
2376 * event, use null value to remove aggregation
2377 * @throws {Error} If aggregation already exists
2379 OO
.ui
.GroupElement
.prototype.aggregate = function ( events
) {
2380 var i
, len
, item
, add
, remove
, itemEvent
, groupEvent
;
2382 for ( itemEvent
in events
) {
2383 groupEvent
= events
[itemEvent
];
2385 // Remove existing aggregated event
2386 if ( itemEvent
in this.aggregateItemEvents
) {
2387 // Don't allow duplicate aggregations
2389 throw new Error( 'Duplicate item event aggregation for ' + itemEvent
);
2391 // Remove event aggregation from existing items
2392 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
2393 item
= this.items
[i
];
2394 if ( item
.connect
&& item
.disconnect
) {
2396 remove
[itemEvent
] = [ 'emit', groupEvent
, item
];
2397 item
.disconnect( this, remove
);
2400 // Prevent future items from aggregating event
2401 delete this.aggregateItemEvents
[itemEvent
];
2404 // Add new aggregate event
2406 // Make future items aggregate event
2407 this.aggregateItemEvents
[itemEvent
] = groupEvent
;
2408 // Add event aggregation to existing items
2409 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
2410 item
= this.items
[i
];
2411 if ( item
.connect
&& item
.disconnect
) {
2413 add
[itemEvent
] = [ 'emit', groupEvent
, item
];
2414 item
.connect( this, add
);
2424 * @param {OO.ui.Element[]} items Item
2425 * @param {number} [index] Index to insert items at
2428 OO
.ui
.GroupElement
.prototype.addItems = function ( items
, index
) {
2429 var i
, len
, item
, event
, events
, currentIndex
,
2430 $items
= this.$( [] );
2432 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
2435 // Check if item exists then remove it first, effectively "moving" it
2436 currentIndex
= $.inArray( item
, this.items
);
2437 if ( currentIndex
>= 0 ) {
2438 this.removeItems( [ item
] );
2439 // Adjust index to compensate for removal
2440 if ( currentIndex
< index
) {
2445 if ( item
.connect
&& item
.disconnect
&& !$.isEmptyObject( this.aggregateItemEvents
) ) {
2447 for ( event
in this.aggregateItemEvents
) {
2448 events
[event
] = [ 'emit', this.aggregateItemEvents
[event
], item
];
2450 item
.connect( this, events
);
2452 item
.setElementGroup( this );
2453 $items
= $items
.add( item
.$element
);
2456 if ( index
=== undefined || index
< 0 || index
>= this.items
.length
) {
2457 this.$group
.append( $items
);
2458 this.items
.push
.apply( this.items
, items
);
2459 } else if ( index
=== 0 ) {
2460 this.$group
.prepend( $items
);
2461 this.items
.unshift
.apply( this.items
, items
);
2463 this.$items
.eq( index
).before( $items
);
2464 this.items
.splice
.apply( this.items
, [ index
, 0 ].concat( items
) );
2467 this.$items
= this.$items
.add( $items
);
2475 * Items will be detached, not removed, so they can be used later.
2477 * @param {OO.ui.Element[]} items Items to remove
2480 OO
.ui
.GroupElement
.prototype.removeItems = function ( items
) {
2481 var i
, len
, item
, index
, remove
, itemEvent
;
2483 // Remove specific items
2484 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
2486 index
= $.inArray( item
, this.items
);
2487 if ( index
!== -1 ) {
2489 item
.connect
&& item
.disconnect
&&
2490 !$.isEmptyObject( this.aggregateItemEvents
)
2493 if ( itemEvent
in this.aggregateItemEvents
) {
2494 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
2496 item
.disconnect( this, remove
);
2498 item
.setElementGroup( null );
2499 this.items
.splice( index
, 1 );
2500 item
.$element
.detach();
2501 this.$items
= this.$items
.not( item
.$element
);
2511 * Items will be detached, not removed, so they can be used later.
2515 OO
.ui
.GroupElement
.prototype.clearItems = function () {
2516 var i
, len
, item
, remove
, itemEvent
;
2519 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
2520 item
= this.items
[i
];
2522 item
.connect
&& item
.disconnect
&&
2523 !$.isEmptyObject( this.aggregateItemEvents
)
2526 if ( itemEvent
in this.aggregateItemEvents
) {
2527 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
2529 item
.disconnect( this, remove
);
2531 item
.setElementGroup( null );
2534 this.$items
.detach();
2535 this.$items
= this.$( [] );
2540 * Element containing an icon.
2546 * @param {jQuery} $icon Icon node, assigned to #$icon
2547 * @param {Object} [config] Configuration options
2548 * @cfg {Object|string} [icon=''] Symbolic icon name, or map of icon names keyed by language ID;
2549 * use the 'default' key to specify the icon to be used when there is no icon in the user's
2552 OO
.ui
.IconedElement
= function OoUiIconedElement( $icon
, config
) {
2553 // Config intialization
2554 config
= config
|| {};
2561 this.$icon
.addClass( 'oo-ui-iconedElement-icon' );
2562 this.setIcon( config
.icon
|| this.constructor.static.icon
);
2567 OO
.initClass( OO
.ui
.IconedElement
);
2569 /* Static Properties */
2574 * Value should be the unique portion of an icon CSS class name, such as 'up' for 'oo-ui-icon-up'.
2576 * For i18n purposes, this property can be an object containing a `default` icon name property and
2577 * additional icon names keyed by language code.
2579 * Example of i18n icon definition:
2580 * { 'default': 'bold-a', 'en': 'bold-b', 'de': 'bold-f' }
2584 * @property {Object|string} Symbolic icon name, or map of icon names keyed by language ID;
2585 * use the 'default' key to specify the icon to be used when there is no icon in the user's
2588 OO
.ui
.IconedElement
.static.icon
= null;
2595 * @param {Object|string} icon Symbolic icon name, or map of icon names keyed by language ID;
2596 * use the 'default' key to specify the icon to be used when there is no icon in the user's
2600 OO
.ui
.IconedElement
.prototype.setIcon = function ( icon
) {
2601 icon
= OO
.isPlainObject( icon
) ? OO
.ui
.getLocalValue( icon
, null, 'default' ) : icon
;
2604 this.$icon
.removeClass( 'oo-ui-icon-' + this.icon
);
2606 if ( typeof icon
=== 'string' ) {
2608 if ( icon
.length
) {
2609 this.$icon
.addClass( 'oo-ui-icon-' + icon
);
2613 this.$element
.toggleClass( 'oo-ui-iconedElement', !!this.icon
);
2621 * @return {string} Icon
2623 OO
.ui
.IconedElement
.prototype.getIcon = function () {
2627 * Element containing an indicator.
2633 * @param {jQuery} $indicator Indicator node, assigned to #$indicator
2634 * @param {Object} [config] Configuration options
2635 * @cfg {string} [indicator] Symbolic indicator name
2636 * @cfg {string} [indicatorTitle] Indicator title text or a function that return text
2638 OO
.ui
.IndicatedElement
= function OoUiIndicatedElement( $indicator
, config
) {
2639 // Config intialization
2640 config
= config
|| {};
2643 this.$indicator
= $indicator
;
2644 this.indicator
= null;
2645 this.indicatorLabel
= null;
2648 this.$indicator
.addClass( 'oo-ui-indicatedElement-indicator' );
2649 this.setIndicator( config
.indicator
|| this.constructor.static.indicator
);
2650 this.setIndicatorTitle( config
.indicatorTitle
|| this.constructor.static.indicatorTitle
);
2655 OO
.initClass( OO
.ui
.IndicatedElement
);
2657 /* Static Properties */
2664 * @property {string|null} Symbolic indicator name or null for no indicator
2666 OO
.ui
.IndicatedElement
.static.indicator
= null;
2673 * @property {string|Function|null} Indicator title text, a function that return text or null for no
2676 OO
.ui
.IndicatedElement
.static.indicatorTitle
= null;
2683 * @param {string|null} indicator Symbolic name of indicator to use or null for no indicator
2686 OO
.ui
.IndicatedElement
.prototype.setIndicator = function ( indicator
) {
2687 if ( this.indicator
) {
2688 this.$indicator
.removeClass( 'oo-ui-indicator-' + this.indicator
);
2689 this.indicator
= null;
2691 if ( typeof indicator
=== 'string' ) {
2692 indicator
= indicator
.trim();
2693 if ( indicator
.length
) {
2694 this.$indicator
.addClass( 'oo-ui-indicator-' + indicator
);
2695 this.indicator
= indicator
;
2698 this.$element
.toggleClass( 'oo-ui-indicatedElement', !!this.indicator
);
2704 * Set indicator label.
2706 * @param {string|Function|null} indicator Indicator title text, a function that return text or null
2707 * for no indicator title
2710 OO
.ui
.IndicatedElement
.prototype.setIndicatorTitle = function ( indicatorTitle
) {
2711 this.indicatorTitle
= indicatorTitle
= OO
.ui
.resolveMsg( indicatorTitle
);
2713 if ( typeof indicatorTitle
=== 'string' && indicatorTitle
.length
) {
2714 this.$indicator
.attr( 'title', indicatorTitle
);
2716 this.$indicator
.removeAttr( 'title' );
2725 * @return {string} title Symbolic name of indicator
2727 OO
.ui
.IndicatedElement
.prototype.getIndicator = function () {
2728 return this.indicator
;
2732 * Get indicator title.
2734 * @return {string} Indicator title text
2736 OO
.ui
.IndicatedElement
.prototype.getIndicatorTitle = function () {
2737 return this.indicatorTitle
;
2740 * Element containing a label.
2746 * @param {jQuery} $label Label node, assigned to #$label
2747 * @param {Object} [config] Configuration options
2748 * @cfg {jQuery|string|Function} [label] Label nodes, text or a function that returns nodes or text
2749 * @cfg {boolean} [autoFitLabel=true] Whether to fit the label or not.
2751 OO
.ui
.LabeledElement
= function OoUiLabeledElement( $label
, config
) {
2752 // Config intialization
2753 config
= config
|| {};
2756 this.$label
= $label
;
2760 this.$label
.addClass( 'oo-ui-labeledElement-label' );
2761 this.setLabel( config
.label
|| this.constructor.static.label
);
2762 this.autoFitLabel
= config
.autoFitLabel
=== undefined || !!config
.autoFitLabel
;
2767 OO
.initClass( OO
.ui
.LabeledElement
);
2769 /* Static Properties */
2776 * @property {string|Function|null} Label text; a function that returns a nodes or text; or null for
2779 OO
.ui
.LabeledElement
.static.label
= null;
2786 * An empty string will result in the label being hidden. A string containing only whitespace will
2787 * be converted to a single
2789 * @param {jQuery|string|Function|null} label Label nodes; text; a function that retuns nodes or
2790 * text; or null for no label
2793 OO
.ui
.LabeledElement
.prototype.setLabel = function ( label
) {
2796 this.label
= label
= OO
.ui
.resolveMsg( label
) || null;
2797 if ( typeof label
=== 'string' && label
.length
) {
2798 if ( label
.match( /^\s*$/ ) ) {
2799 // Convert whitespace only string to a single non-breaking space
2800 this.$label
.html( ' ' );
2802 this.$label
.text( label
);
2804 } else if ( label
instanceof jQuery
) {
2805 this.$label
.empty().append( label
);
2807 this.$label
.empty();
2810 this.$element
.toggleClass( 'oo-ui-labeledElement', !empty
);
2811 this.$label
.css( 'display', empty
? 'none' : '' );
2819 * @return {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
2820 * text; or null for no label
2822 OO
.ui
.LabeledElement
.prototype.getLabel = function () {
2831 OO
.ui
.LabeledElement
.prototype.fitLabel = function () {
2832 if ( this.$label
.autoEllipsis
&& this.autoFitLabel
) {
2833 this.$label
.autoEllipsis( { 'hasSpan': false, 'tooltip': true } );
2838 * Popuppable element.
2844 * @param {Object} [config] Configuration options
2845 * @cfg {number} [popupWidth=320] Width of popup
2846 * @cfg {number} [popupHeight] Height of popup
2847 * @cfg {Object} [popup] Configuration to pass to popup
2849 OO
.ui
.PopuppableElement
= function OoUiPopuppableElement( config
) {
2850 // Configuration initialization
2851 config
= $.extend( { 'popupWidth': 320 }, config
);
2854 this.popup
= new OO
.ui
.PopupWidget( $.extend(
2855 { 'align': 'center', 'autoClose': true },
2857 { '$': this.$, '$autoCloseIgnore': this.$element
}
2859 this.popupWidth
= config
.popupWidth
;
2860 this.popupHeight
= config
.popupHeight
;
2868 * @return {OO.ui.PopupWidget} Popup widget
2870 OO
.ui
.PopuppableElement
.prototype.getPopup = function () {
2877 OO
.ui
.PopuppableElement
.prototype.showPopup = function () {
2878 this.popup
.show().display( this.popupWidth
, this.popupHeight
);
2884 OO
.ui
.PopuppableElement
.prototype.hidePopup = function () {
2888 * Element with a title.
2894 * @param {jQuery} $label Titled node, assigned to #$titled
2895 * @param {Object} [config] Configuration options
2896 * @cfg {string|Function} [title] Title text or a function that returns text
2898 OO
.ui
.TitledElement
= function OoUiTitledElement( $titled
, config
) {
2899 // Config intialization
2900 config
= config
|| {};
2903 this.$titled
= $titled
;
2907 this.setTitle( config
.title
|| this.constructor.static.title
);
2912 OO
.initClass( OO
.ui
.TitledElement
);
2914 /* Static Properties */
2921 * @property {string|Function} Title text or a function that returns text
2923 OO
.ui
.TitledElement
.static.title
= null;
2930 * @param {string|Function|null} title Title text, a function that returns text or null for no title
2933 OO
.ui
.TitledElement
.prototype.setTitle = function ( title
) {
2934 this.title
= title
= OO
.ui
.resolveMsg( title
) || null;
2936 if ( typeof title
=== 'string' && title
.length
) {
2937 this.$titled
.attr( 'title', title
);
2939 this.$titled
.removeAttr( 'title' );
2948 * @return {string} Title string
2950 OO
.ui
.TitledElement
.prototype.getTitle = function () {
2954 * Generic toolbar tool.
2958 * @extends OO.ui.Widget
2959 * @mixins OO.ui.IconedElement
2962 * @param {OO.ui.ToolGroup} toolGroup
2963 * @param {Object} [config] Configuration options
2964 * @cfg {string|Function} [title] Title text or a function that returns text
2966 OO
.ui
.Tool
= function OoUiTool( toolGroup
, config
) {
2967 // Config intialization
2968 config
= config
|| {};
2970 // Parent constructor
2971 OO
.ui
.Tool
.super.call( this, config
);
2973 // Mixin constructors
2974 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
2977 this.toolGroup
= toolGroup
;
2978 this.toolbar
= this.toolGroup
.getToolbar();
2979 this.active
= false;
2980 this.$title
= this.$( '<span>' );
2981 this.$link
= this.$( '<a>' );
2985 this.toolbar
.connect( this, { 'updateState': 'onUpdateState' } );
2988 this.$title
.addClass( 'oo-ui-tool-title' );
2990 .addClass( 'oo-ui-tool-link' )
2991 .append( this.$icon
, this.$title
);
2993 .data( 'oo-ui-tool', this )
2995 'oo-ui-tool ' + 'oo-ui-tool-name-' +
2996 this.constructor.static.name
.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' )
2998 .append( this.$link
);
2999 this.setTitle( config
.title
|| this.constructor.static.title
);
3004 OO
.inheritClass( OO
.ui
.Tool
, OO
.ui
.Widget
);
3005 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.IconedElement
);
3013 /* Static Properties */
3019 OO
.ui
.Tool
.static.tagName
= 'span';
3022 * Symbolic name of tool.
3027 * @property {string}
3029 OO
.ui
.Tool
.static.name
= '';
3037 * @property {string}
3039 OO
.ui
.Tool
.static.group
= '';
3044 * Title is used as a tooltip when the tool is part of a bar tool group, or a label when the tool
3045 * is part of a list or menu tool group. If a trigger is associated with an action by the same name
3046 * as the tool, a description of its keyboard shortcut for the appropriate platform will be
3047 * appended to the title if the tool is part of a bar tool group.
3052 * @property {string|Function} Title text or a function that returns text
3054 OO
.ui
.Tool
.static.title
= '';
3057 * Tool can be automatically added to catch-all groups.
3061 * @property {boolean}
3063 OO
.ui
.Tool
.static.autoAddToCatchall
= true;
3066 * Tool can be automatically added to named groups.
3069 * @property {boolean}
3072 OO
.ui
.Tool
.static.autoAddToGroup
= true;
3075 * Check if this tool is compatible with given data.
3079 * @param {Mixed} data Data to check
3080 * @return {boolean} Tool can be used with data
3082 OO
.ui
.Tool
.static.isCompatibleWith = function () {
3089 * Handle the toolbar state being updated.
3091 * This is an abstract method that must be overridden in a concrete subclass.
3095 OO
.ui
.Tool
.prototype.onUpdateState = function () {
3097 'OO.ui.Tool.onUpdateState not implemented in this subclass:' + this.constructor
3102 * Handle the tool being selected.
3104 * This is an abstract method that must be overridden in a concrete subclass.
3108 OO
.ui
.Tool
.prototype.onSelect = function () {
3110 'OO.ui.Tool.onSelect not implemented in this subclass:' + this.constructor
3115 * Check if the button is active.
3117 * @param {boolean} Button is active
3119 OO
.ui
.Tool
.prototype.isActive = function () {
3124 * Make the button appear active or inactive.
3126 * @param {boolean} state Make button appear active
3128 OO
.ui
.Tool
.prototype.setActive = function ( state
) {
3129 this.active
= !!state
;
3130 if ( this.active
) {
3131 this.$element
.addClass( 'oo-ui-tool-active' );
3133 this.$element
.removeClass( 'oo-ui-tool-active' );
3138 * Get the tool title.
3140 * @param {string|Function} title Title text or a function that returns text
3143 OO
.ui
.Tool
.prototype.setTitle = function ( title
) {
3144 this.title
= OO
.ui
.resolveMsg( title
);
3150 * Get the tool title.
3152 * @return {string} Title text
3154 OO
.ui
.Tool
.prototype.getTitle = function () {
3159 * Get the tool's symbolic name.
3161 * @return {string} Symbolic name of tool
3163 OO
.ui
.Tool
.prototype.getName = function () {
3164 return this.constructor.static.name
;
3170 OO
.ui
.Tool
.prototype.updateTitle = function () {
3171 var titleTooltips
= this.toolGroup
.constructor.static.titleTooltips
,
3172 accelTooltips
= this.toolGroup
.constructor.static.accelTooltips
,
3173 accel
= this.toolbar
.getToolAccelerator( this.constructor.static.name
),
3180 .addClass( 'oo-ui-tool-accel' )
3184 if ( titleTooltips
&& typeof this.title
=== 'string' && this.title
.length
) {
3185 tooltipParts
.push( this.title
);
3187 if ( accelTooltips
&& typeof accel
=== 'string' && accel
.length
) {
3188 tooltipParts
.push( accel
);
3190 if ( tooltipParts
.length
) {
3191 this.$link
.attr( 'title', tooltipParts
.join( ' ' ) );
3193 this.$link
.removeAttr( 'title' );
3200 OO
.ui
.Tool
.prototype.destroy = function () {
3201 this.toolbar
.disconnect( this );
3202 this.$element
.remove();
3205 * Collection of tool groups.
3208 * @extends OO.ui.Element
3209 * @mixins OO.EventEmitter
3210 * @mixins OO.ui.GroupElement
3213 * @param {OO.ui.ToolFactory} toolFactory Factory for creating tools
3214 * @param {OO.ui.ToolGroupFactory} toolGroupFactory Factory for creating tool groups
3215 * @param {Object} [config] Configuration options
3216 * @cfg {boolean} [actions] Add an actions section opposite to the tools
3217 * @cfg {boolean} [shadow] Add a shadow below the toolbar
3219 OO
.ui
.Toolbar
= function OoUiToolbar( toolFactory
, toolGroupFactory
, config
) {
3220 // Configuration initialization
3221 config
= config
|| {};
3223 // Parent constructor
3224 OO
.ui
.Toolbar
.super.call( this, config
);
3226 // Mixin constructors
3227 OO
.EventEmitter
.call( this );
3228 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
3231 this.toolFactory
= toolFactory
;
3232 this.toolGroupFactory
= toolGroupFactory
;
3235 this.$bar
= this.$( '<div>' );
3236 this.$actions
= this.$( '<div>' );
3237 this.initialized
= false;
3241 .add( this.$bar
).add( this.$group
).add( this.$actions
)
3242 .on( 'mousedown', OO
.ui
.bind( this.onMouseDown
, this ) );
3245 this.$group
.addClass( 'oo-ui-toolbar-tools' );
3246 this.$bar
.addClass( 'oo-ui-toolbar-bar' ).append( this.$group
);
3247 if ( config
.actions
) {
3248 this.$actions
.addClass( 'oo-ui-toolbar-actions' );
3249 this.$bar
.append( this.$actions
);
3251 this.$bar
.append( '<div style="clear:both"></div>' );
3252 if ( config
.shadow
) {
3253 this.$bar
.append( '<div class="oo-ui-toolbar-shadow"></div>' );
3255 this.$element
.addClass( 'oo-ui-toolbar' ).append( this.$bar
);
3260 OO
.inheritClass( OO
.ui
.Toolbar
, OO
.ui
.Element
);
3261 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.EventEmitter
);
3262 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.ui
.GroupElement
);
3267 * Get the tool factory.
3269 * @return {OO.ui.ToolFactory} Tool factory
3271 OO
.ui
.Toolbar
.prototype.getToolFactory = function () {
3272 return this.toolFactory
;
3276 * Get the tool group factory.
3278 * @return {OO.Factory} Tool group factory
3280 OO
.ui
.Toolbar
.prototype.getToolGroupFactory = function () {
3281 return this.toolGroupFactory
;
3285 * Handles mouse down events.
3287 * @param {jQuery.Event} e Mouse down event
3289 OO
.ui
.Toolbar
.prototype.onMouseDown = function ( e
) {
3290 var $closestWidgetToEvent
= this.$( e
.target
).closest( '.oo-ui-widget' ),
3291 $closestWidgetToToolbar
= this.$element
.closest( '.oo-ui-widget' );
3292 if ( !$closestWidgetToEvent
.length
|| $closestWidgetToEvent
[0] === $closestWidgetToToolbar
[0] ) {
3298 * Sets up handles and preloads required information for the toolbar to work.
3299 * This must be called immediately after it is attached to a visible document.
3301 OO
.ui
.Toolbar
.prototype.initialize = function () {
3302 this.initialized
= true;
3308 * Tools can be specified in the following ways:
3310 * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3311 * - All tools in a group: `{ 'group': 'group-name' }`
3312 * - All tools: `'*'` - Using this will make the group a list with a "More" label by default
3314 * @param {Object.<string,Array>} groups List of tool group configurations
3315 * @param {Array|string} [groups.include] Tools to include
3316 * @param {Array|string} [groups.exclude] Tools to exclude
3317 * @param {Array|string} [groups.promote] Tools to promote to the beginning
3318 * @param {Array|string} [groups.demote] Tools to demote to the end
3320 OO
.ui
.Toolbar
.prototype.setup = function ( groups
) {
3321 var i
, len
, type
, group
,
3323 defaultType
= 'bar';
3325 // Cleanup previous groups
3328 // Build out new groups
3329 for ( i
= 0, len
= groups
.length
; i
< len
; i
++ ) {
3331 if ( group
.include
=== '*' ) {
3332 // Apply defaults to catch-all groups
3333 if ( group
.type
=== undefined ) {
3334 group
.type
= 'list';
3336 if ( group
.label
=== undefined ) {
3337 group
.label
= 'ooui-toolbar-more';
3340 // Check type has been registered
3341 type
= this.getToolGroupFactory().lookup( group
.type
) ? group
.type
: defaultType
;
3343 this.getToolGroupFactory().create( type
, this, $.extend( { '$': this.$ }, group
) )
3346 this.addItems( items
);
3350 * Remove all tools and groups from the toolbar.
3352 OO
.ui
.Toolbar
.prototype.reset = function () {
3357 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3358 this.items
[i
].destroy();
3364 * Destroys toolbar, removing event handlers and DOM elements.
3366 * Call this whenever you are done using a toolbar.
3368 OO
.ui
.Toolbar
.prototype.destroy = function () {
3370 this.$element
.remove();
3374 * Check if tool has not been used yet.
3376 * @param {string} name Symbolic name of tool
3377 * @return {boolean} Tool is available
3379 OO
.ui
.Toolbar
.prototype.isToolAvailable = function ( name
) {
3380 return !this.tools
[name
];
3384 * Prevent tool from being used again.
3386 * @param {OO.ui.Tool} tool Tool to reserve
3388 OO
.ui
.Toolbar
.prototype.reserveTool = function ( tool
) {
3389 this.tools
[tool
.getName()] = tool
;
3393 * Allow tool to be used again.
3395 * @param {OO.ui.Tool} tool Tool to release
3397 OO
.ui
.Toolbar
.prototype.releaseTool = function ( tool
) {
3398 delete this.tools
[tool
.getName()];
3402 * Get accelerator label for tool.
3404 * This is a stub that should be overridden to provide access to accelerator information.
3406 * @param {string} name Symbolic name of tool
3407 * @return {string|undefined} Tool accelerator label if available
3409 OO
.ui
.Toolbar
.prototype.getToolAccelerator = function () {
3413 * Factory for tools.
3416 * @extends OO.Factory
3419 OO
.ui
.ToolFactory
= function OoUiToolFactory() {
3420 // Parent constructor
3421 OO
.ui
.ToolFactory
.super.call( this );
3426 OO
.inheritClass( OO
.ui
.ToolFactory
, OO
.Factory
);
3431 OO
.ui
.ToolFactory
.prototype.getTools = function ( include
, exclude
, promote
, demote
) {
3432 var i
, len
, included
, promoted
, demoted
,
3436 // Collect included and not excluded tools
3437 included
= OO
.simpleArrayDifference( this.extract( include
), this.extract( exclude
) );
3440 promoted
= this.extract( promote
, used
);
3441 demoted
= this.extract( demote
, used
);
3444 for ( i
= 0, len
= included
.length
; i
< len
; i
++ ) {
3445 if ( !used
[included
[i
]] ) {
3446 auto
.push( included
[i
] );
3450 return promoted
.concat( auto
).concat( demoted
);
3454 * Get a flat list of names from a list of names or groups.
3456 * Tools can be specified in the following ways:
3458 * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3459 * - All tools in a group: `{ 'group': 'group-name' }`
3460 * - All tools: `'*'`
3463 * @param {Array|string} collection List of tools
3464 * @param {Object} [used] Object with names that should be skipped as properties; extracted
3465 * names will be added as properties
3466 * @return {string[]} List of extracted names
3468 OO
.ui
.ToolFactory
.prototype.extract = function ( collection
, used
) {
3469 var i
, len
, item
, name
, tool
,
3472 if ( collection
=== '*' ) {
3473 for ( name
in this.registry
) {
3474 tool
= this.registry
[name
];
3476 // Only add tools by group name when auto-add is enabled
3477 tool
.static.autoAddToCatchall
&&
3478 // Exclude already used tools
3479 ( !used
|| !used
[name
] )
3487 } else if ( $.isArray( collection
) ) {
3488 for ( i
= 0, len
= collection
.length
; i
< len
; i
++ ) {
3489 item
= collection
[i
];
3490 // Allow plain strings as shorthand for named tools
3491 if ( typeof item
=== 'string' ) {
3492 item
= { 'name': item
};
3494 if ( OO
.isPlainObject( item
) ) {
3496 for ( name
in this.registry
) {
3497 tool
= this.registry
[name
];
3499 // Include tools with matching group
3500 tool
.static.group
=== item
.group
&&
3501 // Only add tools by group name when auto-add is enabled
3502 tool
.static.autoAddToGroup
&&
3503 // Exclude already used tools
3504 ( !used
|| !used
[name
] )
3512 // Include tools with matching name and exclude already used tools
3513 } else if ( item
.name
&& ( !used
|| !used
[item
.name
] ) ) {
3514 names
.push( item
.name
);
3516 used
[item
.name
] = true;
3525 * Collection of tools.
3527 * Tools can be specified in the following ways:
3529 * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3530 * - All tools in a group: `{ 'group': 'group-name' }`
3531 * - All tools: `'*'`
3535 * @extends OO.ui.Widget
3536 * @mixins OO.ui.GroupElement
3539 * @param {OO.ui.Toolbar} toolbar
3540 * @param {Object} [config] Configuration options
3541 * @cfg {Array|string} [include=[]] List of tools to include
3542 * @cfg {Array|string} [exclude=[]] List of tools to exclude
3543 * @cfg {Array|string} [promote=[]] List of tools to promote to the beginning
3544 * @cfg {Array|string} [demote=[]] List of tools to demote to the end
3546 OO
.ui
.ToolGroup
= function OoUiToolGroup( toolbar
, config
) {
3547 // Configuration initialization
3548 config
= config
|| {};
3550 // Parent constructor
3551 OO
.ui
.ToolGroup
.super.call( this, config
);
3553 // Mixin constructors
3554 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
3557 this.toolbar
= toolbar
;
3559 this.pressed
= null;
3560 this.autoDisabled
= false;
3561 this.include
= config
.include
|| [];
3562 this.exclude
= config
.exclude
|| [];
3563 this.promote
= config
.promote
|| [];
3564 this.demote
= config
.demote
|| [];
3565 this.onCapturedMouseUpHandler
= OO
.ui
.bind( this.onCapturedMouseUp
, this );
3569 'mousedown': OO
.ui
.bind( this.onMouseDown
, this ),
3570 'mouseup': OO
.ui
.bind( this.onMouseUp
, this ),
3571 'mouseover': OO
.ui
.bind( this.onMouseOver
, this ),
3572 'mouseout': OO
.ui
.bind( this.onMouseOut
, this )
3574 this.toolbar
.getToolFactory().connect( this, { 'register': 'onToolFactoryRegister' } );
3575 this.aggregate( { 'disable': 'itemDisable' } );
3576 this.connect( this, { 'itemDisable': 'updateDisabled' } );
3579 this.$group
.addClass( 'oo-ui-toolGroup-tools' );
3581 .addClass( 'oo-ui-toolGroup' )
3582 .append( this.$group
);
3588 OO
.inheritClass( OO
.ui
.ToolGroup
, OO
.ui
.Widget
);
3589 OO
.mixinClass( OO
.ui
.ToolGroup
, OO
.ui
.GroupElement
);
3597 /* Static Properties */
3600 * Show labels in tooltips.
3604 * @property {boolean}
3606 OO
.ui
.ToolGroup
.static.titleTooltips
= false;
3609 * Show acceleration labels in tooltips.
3613 * @property {boolean}
3615 OO
.ui
.ToolGroup
.static.accelTooltips
= false;
3618 * Automatically disable the toolgroup when all tools are disabled
3622 * @property {boolean}
3624 OO
.ui
.ToolGroup
.static.autoDisable
= true;
3631 OO
.ui
.ToolGroup
.prototype.isDisabled = function () {
3632 return this.autoDisabled
|| OO
.ui
.ToolGroup
.super.prototype.isDisabled
.apply( this, arguments
);
3638 OO
.ui
.ToolGroup
.prototype.updateDisabled = function () {
3639 var i
, item
, allDisabled
= true;
3641 if ( this.constructor.static.autoDisable
) {
3642 for ( i
= this.items
.length
- 1; i
>= 0; i
-- ) {
3643 item
= this.items
[i
];
3644 if ( !item
.isDisabled() ) {
3645 allDisabled
= false;
3649 this.autoDisabled
= allDisabled
;
3651 OO
.ui
.ToolGroup
.super.prototype.updateDisabled
.apply( this, arguments
);
3655 * Handle mouse down events.
3657 * @param {jQuery.Event} e Mouse down event
3659 OO
.ui
.ToolGroup
.prototype.onMouseDown = function ( e
) {
3660 if ( !this.isDisabled() && e
.which
=== 1 ) {
3661 this.pressed
= this.getTargetTool( e
);
3662 if ( this.pressed
) {
3663 this.pressed
.setActive( true );
3664 this.getElementDocument().addEventListener(
3665 'mouseup', this.onCapturedMouseUpHandler
, true
3673 * Handle captured mouse up events.
3675 * @param {Event} e Mouse up event
3677 OO
.ui
.ToolGroup
.prototype.onCapturedMouseUp = function ( e
) {
3678 this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseUpHandler
, true );
3679 // onMouseUp may be called a second time, depending on where the mouse is when the button is
3680 // released, but since `this.pressed` will no longer be true, the second call will be ignored.
3681 this.onMouseUp( e
);
3685 * Handle mouse up events.
3687 * @param {jQuery.Event} e Mouse up event
3689 OO
.ui
.ToolGroup
.prototype.onMouseUp = function ( e
) {
3690 var tool
= this.getTargetTool( e
);
3692 if ( !this.isDisabled() && e
.which
=== 1 && this.pressed
&& this.pressed
=== tool
) {
3693 this.pressed
.onSelect();
3696 this.pressed
= null;
3701 * Handle mouse over events.
3703 * @param {jQuery.Event} e Mouse over event
3705 OO
.ui
.ToolGroup
.prototype.onMouseOver = function ( e
) {
3706 var tool
= this.getTargetTool( e
);
3708 if ( this.pressed
&& this.pressed
=== tool
) {
3709 this.pressed
.setActive( true );
3714 * Handle mouse out events.
3716 * @param {jQuery.Event} e Mouse out event
3718 OO
.ui
.ToolGroup
.prototype.onMouseOut = function ( e
) {
3719 var tool
= this.getTargetTool( e
);
3721 if ( this.pressed
&& this.pressed
=== tool
) {
3722 this.pressed
.setActive( false );
3727 * Get the closest tool to a jQuery.Event.
3729 * Only tool links are considered, which prevents other elements in the tool such as popups from
3730 * triggering tool group interactions.
3733 * @param {jQuery.Event} e
3734 * @return {OO.ui.Tool|null} Tool, `null` if none was found
3736 OO
.ui
.ToolGroup
.prototype.getTargetTool = function ( e
) {
3738 $item
= this.$( e
.target
).closest( '.oo-ui-tool-link' );
3740 if ( $item
.length
) {
3741 tool
= $item
.parent().data( 'oo-ui-tool' );
3744 return tool
&& !tool
.isDisabled() ? tool
: null;
3748 * Handle tool registry register events.
3750 * If a tool is registered after the group is created, we must repopulate the list to account for:
3752 * - a tool being added that may be included
3753 * - a tool already included being overridden
3755 * @param {string} name Symbolic name of tool
3757 OO
.ui
.ToolGroup
.prototype.onToolFactoryRegister = function () {
3762 * Get the toolbar this group is in.
3764 * @return {OO.ui.Toolbar} Toolbar of group
3766 OO
.ui
.ToolGroup
.prototype.getToolbar = function () {
3767 return this.toolbar
;
3771 * Add and remove tools based on configuration.
3773 OO
.ui
.ToolGroup
.prototype.populate = function () {
3774 var i
, len
, name
, tool
,
3775 toolFactory
= this.toolbar
.getToolFactory(),
3779 list
= this.toolbar
.getToolFactory().getTools(
3780 this.include
, this.exclude
, this.promote
, this.demote
3783 // Build a list of needed tools
3784 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
3788 toolFactory
.lookup( name
) &&
3789 // Tool is available or is already in this group
3790 ( this.toolbar
.isToolAvailable( name
) || this.tools
[name
] )
3792 tool
= this.tools
[name
];
3794 // Auto-initialize tools on first use
3795 this.tools
[name
] = tool
= toolFactory
.create( name
, this );
3798 this.toolbar
.reserveTool( tool
);
3803 // Remove tools that are no longer needed
3804 for ( name
in this.tools
) {
3805 if ( !names
[name
] ) {
3806 this.tools
[name
].destroy();
3807 this.toolbar
.releaseTool( this.tools
[name
] );
3808 remove
.push( this.tools
[name
] );
3809 delete this.tools
[name
];
3812 if ( remove
.length
) {
3813 this.removeItems( remove
);
3815 // Update emptiness state
3817 this.$element
.removeClass( 'oo-ui-toolGroup-empty' );
3819 this.$element
.addClass( 'oo-ui-toolGroup-empty' );
3821 // Re-add tools (moving existing ones to new locations)
3822 this.addItems( add
);
3823 // Disabled state may depend on items
3824 this.updateDisabled();
3828 * Destroy tool group.
3830 OO
.ui
.ToolGroup
.prototype.destroy = function () {
3834 this.toolbar
.getToolFactory().disconnect( this );
3835 for ( name
in this.tools
) {
3836 this.toolbar
.releaseTool( this.tools
[name
] );
3837 this.tools
[name
].disconnect( this ).destroy();
3838 delete this.tools
[name
];
3840 this.$element
.remove();
3843 * Factory for tool groups.
3846 * @extends OO.Factory
3849 OO
.ui
.ToolGroupFactory
= function OoUiToolGroupFactory() {
3850 // Parent constructor
3851 OO
.Factory
.call( this );
3854 defaultClasses
= this.constructor.static.getDefaultClasses();
3856 // Register default toolgroups
3857 for ( i
= 0, l
= defaultClasses
.length
; i
< l
; i
++ ) {
3858 this.register( defaultClasses
[i
] );
3864 OO
.inheritClass( OO
.ui
.ToolGroupFactory
, OO
.Factory
);
3866 /* Static Methods */
3869 * Get a default set of classes to be registered on construction
3871 * @return {Function[]} Default classes
3873 OO
.ui
.ToolGroupFactory
.static.getDefaultClasses = function () {
3876 OO
.ui
.ListToolGroup
,
3881 * Layout made of a fieldset and optional legend.
3883 * Just add OO.ui.FieldLayout items.
3886 * @extends OO.ui.Layout
3887 * @mixins OO.ui.LabeledElement
3888 * @mixins OO.ui.IconedElement
3889 * @mixins OO.ui.GroupElement
3892 * @param {Object} [config] Configuration options
3893 * @cfg {string} [icon] Symbolic icon name
3894 * @cfg {OO.ui.FieldLayout[]} [items] Items to add
3896 OO
.ui
.FieldsetLayout
= function OoUiFieldsetLayout( config
) {
3897 // Config initialization
3898 config
= config
|| {};
3900 // Parent constructor
3901 OO
.ui
.FieldsetLayout
.super.call( this, config
);
3903 // Mixin constructors
3904 OO
.ui
.IconedElement
.call( this, this.$( '<div>' ), config
);
3905 OO
.ui
.LabeledElement
.call( this, this.$( '<div>' ), config
);
3906 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
3910 .addClass( 'oo-ui-fieldsetLayout' )
3911 .prepend( this.$icon
, this.$label
, this.$group
);
3912 if ( $.isArray( config
.items
) ) {
3913 this.addItems( config
.items
);
3919 OO
.inheritClass( OO
.ui
.FieldsetLayout
, OO
.ui
.Layout
);
3920 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.IconedElement
);
3921 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.LabeledElement
);
3922 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.GroupElement
);
3924 /* Static Properties */
3926 OO
.ui
.FieldsetLayout
.static.tagName
= 'div';
3928 * Layout made of a field and optional label.
3931 * @extends OO.ui.Layout
3932 * @mixins OO.ui.LabeledElement
3934 * Available label alignment modes include:
3935 * - 'left': Label is before the field and aligned away from it, best for when the user will be
3936 * scanning for a specific label in a form with many fields
3937 * - 'right': Label is before the field and aligned toward it, best for forms the user is very
3938 * familiar with and will tab through field checking quickly to verify which field they are in
3939 * - 'top': Label is before the field and above it, best for when the use will need to fill out all
3940 * fields from top to bottom in a form with few fields
3941 * - 'inline': Label is after the field and aligned toward it, best for small boolean fields like
3942 * checkboxes or radio buttons
3945 * @param {OO.ui.Widget} field Field widget
3946 * @param {Object} [config] Configuration options
3947 * @cfg {string} [align='left'] Alignment mode, either 'left', 'right', 'top' or 'inline'
3949 OO
.ui
.FieldLayout
= function OoUiFieldLayout( field
, config
) {
3950 // Config initialization
3951 config
= $.extend( { 'align': 'left' }, config
);
3953 // Parent constructor
3954 OO
.ui
.FieldLayout
.super.call( this, config
);
3956 // Mixin constructors
3957 OO
.ui
.LabeledElement
.call( this, this.$( '<label>' ), config
);
3960 this.$field
= this.$( '<div>' );
3965 if ( this.field
instanceof OO
.ui
.InputWidget
) {
3966 this.$label
.on( 'click', OO
.ui
.bind( this.onLabelClick
, this ) );
3968 this.field
.connect( this, { 'disable': 'onFieldDisable' } );
3971 this.$element
.addClass( 'oo-ui-fieldLayout' );
3973 .addClass( 'oo-ui-fieldLayout-field' )
3974 .toggleClass( 'oo-ui-fieldLayout-disable', this.field
.isDisabled() )
3975 .append( this.field
.$element
);
3976 this.setAlignment( config
.align
);
3981 OO
.inheritClass( OO
.ui
.FieldLayout
, OO
.ui
.Layout
);
3982 OO
.mixinClass( OO
.ui
.FieldLayout
, OO
.ui
.LabeledElement
);
3987 * Handle field disable events.
3989 * @param {boolean} value Field is disabled
3991 OO
.ui
.FieldLayout
.prototype.onFieldDisable = function ( value
) {
3992 this.$element
.toggleClass( 'oo-ui-fieldLayout-disabled', value
);
3996 * Handle label mouse click events.
3998 * @param {jQuery.Event} e Mouse click event
4000 OO
.ui
.FieldLayout
.prototype.onLabelClick = function () {
4001 this.field
.simulateLabelClick();
4008 * @return {OO.ui.Widget} Field widget
4010 OO
.ui
.FieldLayout
.prototype.getField = function () {
4015 * Set the field alignment mode.
4017 * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
4020 OO
.ui
.FieldLayout
.prototype.setAlignment = function ( value
) {
4021 if ( value
!== this.align
) {
4022 // Default to 'left'
4023 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value
) === -1 ) {
4027 if ( value
=== 'inline' ) {
4028 this.$element
.append( this.$field
, this.$label
);
4030 this.$element
.append( this.$label
, this.$field
);
4034 this.$element
.removeClass( 'oo-ui-fieldLayout-align-' + this.align
);
4037 this.$element
.addClass( 'oo-ui-fieldLayout-align-' + this.align
);
4043 * Layout made of proportionally sized columns and rows.
4046 * @extends OO.ui.Layout
4049 * @param {OO.ui.PanelLayout[]} panels Panels in the grid
4050 * @param {Object} [config] Configuration options
4051 * @cfg {number[]} [widths] Widths of columns as ratios
4052 * @cfg {number[]} [heights] Heights of columns as ratios
4054 OO
.ui
.GridLayout
= function OoUiGridLayout( panels
, config
) {
4057 // Config initialization
4058 config
= config
|| {};
4060 // Parent constructor
4061 OO
.ui
.GridLayout
.super.call( this, config
);
4069 this.$element
.addClass( 'oo-ui-gridLayout' );
4070 for ( i
= 0, len
= panels
.length
; i
< len
; i
++ ) {
4071 this.panels
.push( panels
[i
] );
4072 this.$element
.append( panels
[i
].$element
);
4074 if ( config
.widths
|| config
.heights
) {
4075 this.layout( config
.widths
|| [ 1 ], config
.heights
|| [ 1 ] );
4077 // Arrange in columns by default
4079 for ( i
= 0, len
= this.panels
.length
; i
< len
; i
++ ) {
4082 this.layout( widths
, [ 1 ] );
4088 OO
.inheritClass( OO
.ui
.GridLayout
, OO
.ui
.Layout
);
4100 /* Static Properties */
4102 OO
.ui
.GridLayout
.static.tagName
= 'div';
4107 * Set grid dimensions.
4109 * @param {number[]} widths Widths of columns as ratios
4110 * @param {number[]} heights Heights of rows as ratios
4112 * @throws {Error} If grid is not large enough to fit all panels
4114 OO
.ui
.GridLayout
.prototype.layout = function ( widths
, heights
) {
4118 cols
= widths
.length
,
4119 rows
= heights
.length
;
4121 // Verify grid is big enough to fit panels
4122 if ( cols
* rows
< this.panels
.length
) {
4123 throw new Error( 'Grid is not large enough to fit ' + this.panels
.length
+ 'panels' );
4126 // Sum up denominators
4127 for ( x
= 0; x
< cols
; x
++ ) {
4130 for ( y
= 0; y
< rows
; y
++ ) {
4136 for ( x
= 0; x
< cols
; x
++ ) {
4137 this.widths
[x
] = widths
[x
] / xd
;
4139 for ( y
= 0; y
< rows
; y
++ ) {
4140 this.heights
[y
] = heights
[y
] / yd
;
4144 this.emit( 'layout' );
4148 * Update panel positions and sizes.
4152 OO
.ui
.GridLayout
.prototype.update = function () {
4160 cols
= this.widths
.length
,
4161 rows
= this.heights
.length
;
4163 for ( y
= 0; y
< rows
; y
++ ) {
4164 for ( x
= 0; x
< cols
; x
++ ) {
4165 panel
= this.panels
[i
];
4166 width
= this.widths
[x
];
4167 height
= this.heights
[y
];
4169 'width': Math
.round( width
* 100 ) + '%',
4170 'height': Math
.round( height
* 100 ) + '%',
4171 'top': Math
.round( top
* 100 ) + '%'
4174 if ( OO
.ui
.Element
.getDir( this.$.context
) === 'rtl' ) {
4175 dimensions
.right
= Math
.round( left
* 100 ) + '%';
4177 dimensions
.left
= Math
.round( left
* 100 ) + '%';
4179 panel
.$element
.css( dimensions
);
4187 this.emit( 'update' );
4191 * Get a panel at a given position.
4193 * The x and y position is affected by the current grid layout.
4195 * @param {number} x Horizontal position
4196 * @param {number} y Vertical position
4197 * @return {OO.ui.PanelLayout} The panel at the given postion
4199 OO
.ui
.GridLayout
.prototype.getPanel = function ( x
, y
) {
4200 return this.panels
[( x
* this.widths
.length
) + y
];
4203 * Layout containing a series of pages.
4206 * @extends OO.ui.Layout
4209 * @param {Object} [config] Configuration options
4210 * @cfg {boolean} [continuous=false] Show all pages, one after another
4211 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when changing to a page
4212 * @cfg {boolean} [outlined=false] Show an outline
4213 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
4214 * @cfg {Object[]} [adders] List of adders for controls, each with name, icon and title properties
4216 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
4217 // Initialize configuration
4218 config
= config
|| {};
4220 // Parent constructor
4221 OO
.ui
.BookletLayout
.super.call( this, config
);
4224 this.currentPageName
= null;
4226 this.ignoreFocus
= false;
4227 this.stackLayout
= new OO
.ui
.StackLayout( { '$': this.$, 'continuous': !!config
.continuous
} );
4228 this.autoFocus
= config
.autoFocus
=== undefined ? true : !!config
.autoFocus
;
4229 this.outlineVisible
= false;
4230 this.outlined
= !!config
.outlined
;
4231 if ( this.outlined
) {
4232 this.editable
= !!config
.editable
;
4233 this.adders
= config
.adders
|| null;
4234 this.outlineControlsWidget
= null;
4235 this.outlineWidget
= new OO
.ui
.OutlineWidget( { '$': this.$ } );
4236 this.outlinePanel
= new OO
.ui
.PanelLayout( { '$': this.$, 'scrollable': true } );
4237 this.gridLayout
= new OO
.ui
.GridLayout(
4238 [ this.outlinePanel
, this.stackLayout
],
4239 { '$': this.$, 'widths': [ 1, 2 ] }
4241 this.outlineVisible
= true;
4242 if ( this.editable
) {
4243 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
4245 { '$': this.$, 'adders': this.adders
}
4251 this.stackLayout
.connect( this, { 'set': 'onStackLayoutSet' } );
4252 if ( this.outlined
) {
4253 this.outlineWidget
.connect( this, { 'select': 'onOutlineWidgetSelect' } );
4255 if ( this.autoFocus
) {
4256 // Event 'focus' does not bubble, but 'focusin' does
4257 this.stackLayout
.onDOMEvent( 'focusin', OO
.ui
.bind( this.onStackLayoutFocus
, this ) );
4261 this.$element
.addClass( 'oo-ui-bookletLayout' );
4262 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
4263 if ( this.outlined
) {
4264 this.outlinePanel
.$element
4265 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
4266 .append( this.outlineWidget
.$element
);
4267 if ( this.editable
) {
4268 this.outlinePanel
.$element
4269 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
4270 .append( this.outlineControlsWidget
.$element
);
4272 this.$element
.append( this.gridLayout
.$element
);
4274 this.$element
.append( this.stackLayout
.$element
);
4280 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.Layout
);
4286 * @param {OO.ui.PageLayout} page Current page
4291 * @param {OO.ui.PageLayout[]} page Added pages
4292 * @param {number} index Index pages were added at
4297 * @param {OO.ui.PageLayout[]} pages Removed pages
4303 * Handle stack layout focus.
4305 * @param {jQuery.Event} e Focusin event
4307 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
4310 // Find the page that an element was focused within
4311 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
4312 for ( name
in this.pages
) {
4313 // Check for page match, exclude current page to find only page changes
4314 if ( this.pages
[name
].$element
[0] === $target
[0] && name
!== this.currentPageName
) {
4315 this.setPage( name
);
4322 * Handle stack layout set events.
4324 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
4326 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
4328 page
.scrollElementIntoView( { 'complete': OO
.ui
.bind( function () {
4329 if ( this.autoFocus
) {
4330 // Set focus to the first input if nothing on the page is focused yet
4331 if ( !page
.$element
.find( ':focus' ).length
) {
4332 page
.$element
.find( ':input:first' ).focus();
4340 * Handle outline widget select events.
4342 * @param {OO.ui.OptionWidget|null} item Selected item
4344 OO
.ui
.BookletLayout
.prototype.onOutlineWidgetSelect = function ( item
) {
4346 this.setPage( item
.getData() );
4351 * Check if booklet has an outline.
4355 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
4356 return this.outlined
;
4360 * Check if booklet has editing controls.
4364 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
4365 return this.editable
;
4369 * Check if booklet has a visible outline.
4373 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
4374 return this.outlined
&& this.outlineVisible
;
4378 * Hide or show the outline.
4380 * @param {boolean} [show] Show outline, omit to invert current state
4383 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
4384 if ( this.outlined
) {
4385 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
4386 this.outlineVisible
= show
;
4387 this.gridLayout
.layout( show
? [ 1, 2 ] : [ 0, 1 ], [ 1 ] );
4394 * Get the outline widget.
4396 * @param {OO.ui.PageLayout} page Page to be selected
4397 * @return {OO.ui.PageLayout|null} Closest page to another
4399 OO
.ui
.BookletLayout
.prototype.getClosestPage = function ( page
) {
4400 var next
, prev
, level
,
4401 pages
= this.stackLayout
.getItems(),
4402 index
= $.inArray( page
, pages
);
4404 if ( index
!== -1 ) {
4405 next
= pages
[index
+ 1];
4406 prev
= pages
[index
- 1];
4407 // Prefer adjacent pages at the same level
4408 if ( this.outlined
) {
4409 level
= this.outlineWidget
.getItemFromData( page
.getName() ).getLevel();
4412 level
=== this.outlineWidget
.getItemFromData( prev
.getName() ).getLevel()
4418 level
=== this.outlineWidget
.getItemFromData( next
.getName() ).getLevel()
4424 return prev
|| next
|| null;
4428 * Get the outline widget.
4430 * @return {OO.ui.OutlineWidget|null} Outline widget, or null if boolet has no outline
4432 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
4433 return this.outlineWidget
;
4437 * Get the outline controls widget. If the outline is not editable, null is returned.
4439 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
4441 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
4442 return this.outlineControlsWidget
;
4446 * Get a page by name.
4448 * @param {string} name Symbolic name of page
4449 * @return {OO.ui.PageLayout|undefined} Page, if found
4451 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
4452 return this.pages
[name
];
4456 * Get the current page name.
4458 * @return {string|null} Current page name
4460 OO
.ui
.BookletLayout
.prototype.getPageName = function () {
4461 return this.currentPageName
;
4465 * Add a page to the layout.
4467 * When pages are added with the same names as existing pages, the existing pages will be
4468 * automatically removed before the new pages are added.
4470 * @param {OO.ui.PageLayout[]} pages Pages to add
4471 * @param {number} index Index to insert pages after
4475 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
4476 var i
, len
, name
, page
, item
, currentIndex
,
4477 stackLayoutPages
= this.stackLayout
.getItems(),
4481 // Remove pages with same names
4482 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4484 name
= page
.getName();
4486 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
4487 // Correct the insertion index
4488 currentIndex
= $.inArray( this.pages
[name
], stackLayoutPages
);
4489 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
4492 remove
.push( this.pages
[name
] );
4495 if ( remove
.length
) {
4496 this.removePages( remove
);
4500 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4502 name
= page
.getName();
4503 this.pages
[page
.getName()] = page
;
4504 if ( this.outlined
) {
4505 item
= new OO
.ui
.OutlineItemWidget( name
, page
, { '$': this.$ } );
4506 page
.setOutlineItem( item
);
4511 if ( this.outlined
&& items
.length
) {
4512 this.outlineWidget
.addItems( items
, index
);
4513 this.updateOutlineWidget();
4515 this.stackLayout
.addItems( pages
, index
);
4516 this.emit( 'add', pages
, index
);
4522 * Remove a page from the layout.
4527 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
4528 var i
, len
, name
, page
,
4531 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4533 name
= page
.getName();
4534 delete this.pages
[name
];
4535 if ( this.outlined
) {
4536 items
.push( this.outlineWidget
.getItemFromData( name
) );
4537 page
.setOutlineItem( null );
4540 if ( this.outlined
&& items
.length
) {
4541 this.outlineWidget
.removeItems( items
);
4542 this.updateOutlineWidget();
4544 this.stackLayout
.removeItems( pages
);
4545 this.emit( 'remove', pages
);
4551 * Clear all pages from the layout.
4556 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
4558 pages
= this.stackLayout
.getItems();
4561 this.currentPageName
= null;
4562 if ( this.outlined
) {
4563 this.outlineWidget
.clearItems();
4564 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4565 pages
[i
].setOutlineItem( null );
4568 this.stackLayout
.clearItems();
4570 this.emit( 'remove', pages
);
4576 * Set the current page by name.
4579 * @param {string} name Symbolic name of page
4581 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
4583 page
= this.pages
[name
];
4585 if ( name
!== this.currentPageName
) {
4586 if ( this.outlined
) {
4587 selectedItem
= this.outlineWidget
.getSelectedItem();
4588 if ( selectedItem
&& selectedItem
.getData() !== name
) {
4589 this.outlineWidget
.selectItem( this.outlineWidget
.getItemFromData( name
) );
4593 if ( this.currentPageName
&& this.pages
[this.currentPageName
] ) {
4594 this.pages
[this.currentPageName
].setActive( false );
4595 // Blur anything focused if the next page doesn't have anything focusable - this
4596 // is not needed if the next page has something focusable because once it is focused
4597 // this blur happens automatically
4598 if ( this.autoFocus
&& !page
.$element
.find( ':input' ).length
) {
4599 this.pages
[this.currentPageName
].$element
.find( ':focus' ).blur();
4602 this.currentPageName
= name
;
4603 this.stackLayout
.setItem( page
);
4604 page
.setActive( true );
4605 this.emit( 'set', page
);
4611 * Call this after adding or removing items from the OutlineWidget.
4615 OO
.ui
.BookletLayout
.prototype.updateOutlineWidget = function () {
4616 // Auto-select first item when nothing is selected anymore
4617 if ( !this.outlineWidget
.getSelectedItem() ) {
4618 this.outlineWidget
.selectItem( this.outlineWidget
.getFirstSelectableItem() );
4624 * Layout that expands to cover the entire area of its parent, with optional scrolling and padding.
4627 * @extends OO.ui.Layout
4630 * @param {Object} [config] Configuration options
4631 * @cfg {boolean} [scrollable] Allow vertical scrolling
4632 * @cfg {boolean} [padded] Pad the content from the edges
4634 OO
.ui
.PanelLayout
= function OoUiPanelLayout( config
) {
4635 // Config initialization
4636 config
= config
|| {};
4638 // Parent constructor
4639 OO
.ui
.PanelLayout
.super.call( this, config
);
4642 this.$element
.addClass( 'oo-ui-panelLayout' );
4643 if ( config
.scrollable
) {
4644 this.$element
.addClass( 'oo-ui-panelLayout-scrollable' );
4647 if ( config
.padded
) {
4648 this.$element
.addClass( 'oo-ui-panelLayout-padded' );
4654 OO
.inheritClass( OO
.ui
.PanelLayout
, OO
.ui
.Layout
);
4656 * Page within an booklet layout.
4659 * @extends OO.ui.PanelLayout
4662 * @param {string} name Unique symbolic name of page
4663 * @param {Object} [config] Configuration options
4664 * @param {string} [outlineItem] Outline item widget
4666 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
4667 // Configuration initialization
4668 config
= $.extend( { 'scrollable': true }, config
);
4670 // Parent constructor
4671 OO
.ui
.PageLayout
.super.call( this, config
);
4675 this.outlineItem
= config
.outlineItem
|| null;
4676 this.active
= false;
4679 this.$element
.addClass( 'oo-ui-pageLayout' );
4684 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
4690 * @param {boolean} active Page is active
4698 * @return {string} Symbolic name of page
4700 OO
.ui
.PageLayout
.prototype.getName = function () {
4705 * Check if page is active.
4707 * @return {boolean} Page is active
4709 OO
.ui
.PageLayout
.prototype.isActive = function () {
4716 * @return {OO.ui.OutlineItemWidget|null} Outline item widget
4718 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
4719 return this.outlineItem
;
4725 * @param {OO.ui.OutlineItemWidget|null} outlineItem Outline item widget, null to clear
4728 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
4729 this.outlineItem
= outlineItem
;
4734 * Set page active state.
4736 * @param {boolean} Page is active
4739 OO
.ui
.PageLayout
.prototype.setActive = function ( active
) {
4742 if ( active
!== this.active
) {
4743 this.active
= active
;
4744 this.$element
.toggleClass( 'oo-ui-pageLayout-active', active
);
4745 this.emit( 'active', this.active
);
4749 * Layout containing a series of mutually exclusive pages.
4752 * @extends OO.ui.PanelLayout
4753 * @mixins OO.ui.GroupElement
4756 * @param {Object} [config] Configuration options
4757 * @cfg {boolean} [continuous=false] Show all pages, one after another
4758 * @cfg {string} [icon=''] Symbolic icon name
4759 * @cfg {OO.ui.Layout[]} [items] Layouts to add
4761 OO
.ui
.StackLayout
= function OoUiStackLayout( config
) {
4762 // Config initialization
4763 config
= $.extend( { 'scrollable': true }, config
);
4765 // Parent constructor
4766 OO
.ui
.StackLayout
.super.call( this, config
);
4768 // Mixin constructors
4769 OO
.ui
.GroupElement
.call( this, this.$element
, config
);
4772 this.currentItem
= null;
4773 this.continuous
= !!config
.continuous
;
4776 this.$element
.addClass( 'oo-ui-stackLayout' );
4777 if ( this.continuous
) {
4778 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
4780 if ( $.isArray( config
.items
) ) {
4781 this.addItems( config
.items
);
4787 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
4788 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.GroupElement
);
4794 * @param {OO.ui.Layout|null} [item] Current item
4800 * Get the current item.
4802 * @return {OO.ui.Layout|null} [description]
4804 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
4805 return this.currentItem
;
4811 * Adding an existing item (by value) will move it.
4813 * @param {OO.ui.Layout[]} items Items to add
4814 * @param {number} [index] Index to insert items after
4817 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
4818 OO
.ui
.GroupElement
.prototype.addItems
.call( this, items
, index
);
4820 if ( !this.currentItem
&& items
.length
) {
4821 this.setItem( items
[0] );
4830 * Items will be detached, not removed, so they can be used later.
4832 * @param {OO.ui.Layout[]} items Items to remove
4835 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
4836 OO
.ui
.GroupElement
.prototype.removeItems
.call( this, items
);
4837 if ( $.inArray( this.currentItem
, items
) !== -1 ) {
4838 this.currentItem
= null;
4839 if ( !this.currentItem
&& this.items
.length
) {
4840 this.setItem( this.items
[0] );
4850 * Items will be detached, not removed, so they can be used later.
4854 OO
.ui
.StackLayout
.prototype.clearItems = function () {
4855 this.currentItem
= null;
4856 OO
.ui
.GroupElement
.prototype.clearItems
.call( this );
4864 * Any currently shown item will be hidden.
4866 * @param {OO.ui.Layout} item Item to show
4869 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
4870 if ( item
!== this.currentItem
) {
4871 if ( !this.continuous
) {
4872 this.$items
.css( 'display', '' );
4874 if ( $.inArray( item
, this.items
) !== -1 ) {
4875 if ( !this.continuous
) {
4876 item
.$element
.css( 'display', 'block' );
4881 this.currentItem
= item
;
4882 this.emit( 'set', item
);
4888 * Horizontal bar layout of tools as icon buttons.
4891 * @extends OO.ui.ToolGroup
4894 * @param {OO.ui.Toolbar} toolbar
4895 * @param {Object} [config] Configuration options
4897 OO
.ui
.BarToolGroup
= function OoUiBarToolGroup( toolbar
, config
) {
4898 // Parent constructor
4899 OO
.ui
.BarToolGroup
.super.call( this, toolbar
, config
);
4902 this.$element
.addClass( 'oo-ui-barToolGroup' );
4907 OO
.inheritClass( OO
.ui
.BarToolGroup
, OO
.ui
.ToolGroup
);
4909 /* Static Properties */
4911 OO
.ui
.BarToolGroup
.static.titleTooltips
= true;
4913 OO
.ui
.BarToolGroup
.static.accelTooltips
= true;
4915 OO
.ui
.BarToolGroup
.static.name
= 'bar';
4917 * Popup list of tools with an icon and optional label.
4921 * @extends OO.ui.ToolGroup
4922 * @mixins OO.ui.IconedElement
4923 * @mixins OO.ui.IndicatedElement
4924 * @mixins OO.ui.LabeledElement
4925 * @mixins OO.ui.TitledElement
4926 * @mixins OO.ui.ClippableElement
4929 * @param {OO.ui.Toolbar} toolbar
4930 * @param {Object} [config] Configuration options
4932 OO
.ui
.PopupToolGroup
= function OoUiPopupToolGroup( toolbar
, config
) {
4933 // Configuration initialization
4934 config
= config
|| {};
4936 // Parent constructor
4937 OO
.ui
.PopupToolGroup
.super.call( this, toolbar
, config
);
4939 // Mixin constructors
4940 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
4941 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
4942 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
4943 OO
.ui
.TitledElement
.call( this, this.$element
, config
);
4944 OO
.ui
.ClippableElement
.call( this, this.$group
, config
);
4947 this.active
= false;
4948 this.dragging
= false;
4949 this.onBlurHandler
= OO
.ui
.bind( this.onBlur
, this );
4950 this.$handle
= this.$( '<span>' );
4954 'mousedown': OO
.ui
.bind( this.onHandleMouseDown
, this ),
4955 'mouseup': OO
.ui
.bind( this.onHandleMouseUp
, this )
4960 .addClass( 'oo-ui-popupToolGroup-handle' )
4961 .append( this.$icon
, this.$label
, this.$indicator
);
4963 .addClass( 'oo-ui-popupToolGroup' )
4964 .prepend( this.$handle
);
4969 OO
.inheritClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ToolGroup
);
4970 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IconedElement
);
4971 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IndicatedElement
);
4972 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.LabeledElement
);
4973 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.TitledElement
);
4974 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ClippableElement
);
4976 /* Static Properties */
4983 OO
.ui
.PopupToolGroup
.prototype.setDisabled = function () {
4985 OO
.ui
.PopupToolGroup
.super.prototype.setDisabled
.apply( this, arguments
);
4987 if ( this.isDisabled() && this.isElementAttached() ) {
4988 this.setActive( false );
4993 * Handle focus being lost.
4995 * The event is actually generated from a mouseup, so it is not a normal blur event object.
4997 * @param {jQuery.Event} e Mouse up event
4999 OO
.ui
.PopupToolGroup
.prototype.onBlur = function ( e
) {
5000 // Only deactivate when clicking outside the dropdown element
5001 if ( this.$( e
.target
).closest( '.oo-ui-popupToolGroup' )[0] !== this.$element
[0] ) {
5002 this.setActive( false );
5009 OO
.ui
.PopupToolGroup
.prototype.onMouseUp = function ( e
) {
5010 if ( !this.isDisabled() && e
.which
=== 1 ) {
5011 this.setActive( false );
5013 return OO
.ui
.ToolGroup
.prototype.onMouseUp
.call( this, e
);
5017 * Handle mouse up events.
5019 * @param {jQuery.Event} e Mouse up event
5021 OO
.ui
.PopupToolGroup
.prototype.onHandleMouseUp = function () {
5026 * Handle mouse down events.
5028 * @param {jQuery.Event} e Mouse down event
5030 OO
.ui
.PopupToolGroup
.prototype.onHandleMouseDown = function ( e
) {
5031 if ( !this.isDisabled() && e
.which
=== 1 ) {
5032 this.setActive( !this.active
);
5038 * Switch into active mode.
5040 * When active, mouseup events anywhere in the document will trigger deactivation.
5042 OO
.ui
.PopupToolGroup
.prototype.setActive = function ( value
) {
5044 if ( this.active
!== value
) {
5045 this.active
= value
;
5047 this.setClipping( true );
5048 this.$element
.addClass( 'oo-ui-popupToolGroup-active' );
5049 this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler
, true );
5051 this.setClipping( false );
5052 this.$element
.removeClass( 'oo-ui-popupToolGroup-active' );
5053 this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler
, true );
5058 * Drop down list layout of tools as labeled icon buttons.
5061 * @extends OO.ui.PopupToolGroup
5064 * @param {OO.ui.Toolbar} toolbar
5065 * @param {Object} [config] Configuration options
5067 OO
.ui
.ListToolGroup
= function OoUiListToolGroup( toolbar
, config
) {
5068 // Parent constructor
5069 OO
.ui
.ListToolGroup
.super.call( this, toolbar
, config
);
5072 this.$element
.addClass( 'oo-ui-listToolGroup' );
5077 OO
.inheritClass( OO
.ui
.ListToolGroup
, OO
.ui
.PopupToolGroup
);
5079 /* Static Properties */
5081 OO
.ui
.ListToolGroup
.static.accelTooltips
= true;
5083 OO
.ui
.ListToolGroup
.static.name
= 'list';
5085 * Drop down menu layout of tools as selectable menu items.
5088 * @extends OO.ui.PopupToolGroup
5091 * @param {OO.ui.Toolbar} toolbar
5092 * @param {Object} [config] Configuration options
5094 OO
.ui
.MenuToolGroup
= function OoUiMenuToolGroup( toolbar
, config
) {
5095 // Configuration initialization
5096 config
= config
|| {};
5098 // Parent constructor
5099 OO
.ui
.MenuToolGroup
.super.call( this, toolbar
, config
);
5102 this.toolbar
.connect( this, { 'updateState': 'onUpdateState' } );
5105 this.$element
.addClass( 'oo-ui-menuToolGroup' );
5110 OO
.inheritClass( OO
.ui
.MenuToolGroup
, OO
.ui
.PopupToolGroup
);
5112 /* Static Properties */
5114 OO
.ui
.MenuToolGroup
.static.accelTooltips
= true;
5116 OO
.ui
.MenuToolGroup
.static.name
= 'menu';
5121 * Handle the toolbar state being updated.
5123 * When the state changes, the title of each active item in the menu will be joined together and
5124 * used as a label for the group. The label will be empty if none of the items are active.
5126 OO
.ui
.MenuToolGroup
.prototype.onUpdateState = function () {
5130 for ( name
in this.tools
) {
5131 if ( this.tools
[name
].isActive() ) {
5132 labelTexts
.push( this.tools
[name
].getTitle() );
5136 this.setLabel( labelTexts
.join( ', ' ) || ' ' );
5139 * Tool that shows a popup when selected.
5143 * @extends OO.ui.Tool
5144 * @mixins OO.ui.PopuppableElement
5147 * @param {OO.ui.Toolbar} toolbar
5148 * @param {Object} [config] Configuration options
5150 OO
.ui
.PopupTool
= function OoUiPopupTool( toolbar
, config
) {
5151 // Parent constructor
5152 OO
.ui
.PopupTool
.super.call( this, toolbar
, config
);
5154 // Mixin constructors
5155 OO
.ui
.PopuppableElement
.call( this, config
);
5159 .addClass( 'oo-ui-popupTool' )
5160 .append( this.popup
.$element
);
5165 OO
.inheritClass( OO
.ui
.PopupTool
, OO
.ui
.Tool
);
5166 OO
.mixinClass( OO
.ui
.PopupTool
, OO
.ui
.PopuppableElement
);
5171 * Handle the tool being selected.
5175 OO
.ui
.PopupTool
.prototype.onSelect = function () {
5176 if ( !this.isDisabled() ) {
5177 if ( this.popup
.isVisible() ) {
5183 this.setActive( false );
5188 * Handle the toolbar state being updated.
5192 OO
.ui
.PopupTool
.prototype.onUpdateState = function () {
5193 this.setActive( false );
5198 * Mixin for OO.ui.Widget subclasses.
5200 * Use together with OO.ui.ItemWidget to make disabled state inheritable.
5204 * @extends OO.ui.GroupElement
5207 * @param {jQuery} $group Container node, assigned to #$group
5208 * @param {Object} [config] Configuration options
5210 OO
.ui
.GroupWidget
= function OoUiGroupWidget( $element
, config
) {
5211 // Parent constructor
5212 OO
.ui
.GroupWidget
.super.call( this, $element
, config
);
5217 OO
.inheritClass( OO
.ui
.GroupWidget
, OO
.ui
.GroupElement
);
5222 * Set the disabled state of the widget.
5224 * This will also update the disabled state of child widgets.
5226 * @param {boolean} disabled Disable widget
5229 OO
.ui
.GroupWidget
.prototype.setDisabled = function ( disabled
) {
5233 // Note this is calling OO.ui.Widget; we're assuming the class this is mixed into
5234 // is a subclass of OO.ui.Widget.
5235 OO
.ui
.Widget
.prototype.setDisabled
.call( this, disabled
);
5237 // During construction, #setDisabled is called before the OO.ui.GroupElement constructor
5239 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
5240 this.items
[i
].updateDisabled();
5249 * Use together with OO.ui.GroupWidget to make disabled state inheritable.
5256 OO
.ui
.ItemWidget
= function OoUiItemWidget() {
5263 * Check if widget is disabled.
5265 * Checks parent if present, making disabled state inheritable.
5267 * @return {boolean} Widget is disabled
5269 OO
.ui
.ItemWidget
.prototype.isDisabled = function () {
5270 return this.disabled
||
5271 ( this.elementGroup
instanceof OO
.ui
.Widget
&& this.elementGroup
.isDisabled() );
5275 * Set group element is in.
5277 * @param {OO.ui.GroupElement|null} group Group element, null if none
5280 OO
.ui
.ItemWidget
.prototype.setElementGroup = function ( group
) {
5282 OO
.ui
.Element
.prototype.setElementGroup
.call( this, group
);
5284 // Initialize item disabled states
5285 this.updateDisabled();
5293 * @extends OO.ui.Widget
5294 * @mixins OO.ui.IconedElement
5295 * @mixins OO.ui.TitledElement
5298 * @param {Object} [config] Configuration options
5300 OO
.ui
.IconWidget
= function OoUiIconWidget( config
) {
5301 // Config intialization
5302 config
= config
|| {};
5304 // Parent constructor
5305 OO
.ui
.IconWidget
.super.call( this, config
);
5307 // Mixin constructors
5308 OO
.ui
.IconedElement
.call( this, this.$element
, config
);
5309 OO
.ui
.TitledElement
.call( this, this.$element
, config
);
5312 this.$element
.addClass( 'oo-ui-iconWidget' );
5317 OO
.inheritClass( OO
.ui
.IconWidget
, OO
.ui
.Widget
);
5318 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.IconedElement
);
5319 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.TitledElement
);
5321 /* Static Properties */
5323 OO
.ui
.IconWidget
.static.tagName
= 'span';
5328 * @extends OO.ui.Widget
5329 * @mixins OO.ui.IndicatedElement
5330 * @mixins OO.ui.TitledElement
5333 * @param {Object} [config] Configuration options
5335 OO
.ui
.IndicatorWidget
= function OoUiIndicatorWidget( config
) {
5336 // Config intialization
5337 config
= config
|| {};
5339 // Parent constructor
5340 OO
.ui
.IndicatorWidget
.super.call( this, config
);
5342 // Mixin constructors
5343 OO
.ui
.IndicatedElement
.call( this, this.$element
, config
);
5344 OO
.ui
.TitledElement
.call( this, this.$element
, config
);
5347 this.$element
.addClass( 'oo-ui-indicatorWidget' );
5352 OO
.inheritClass( OO
.ui
.IndicatorWidget
, OO
.ui
.Widget
);
5353 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.IndicatedElement
);
5354 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.TitledElement
);
5356 /* Static Properties */
5358 OO
.ui
.IndicatorWidget
.static.tagName
= 'span';
5360 * Container for multiple related buttons.
5362 * Use together with OO.ui.ButtonWidget.
5365 * @extends OO.ui.Widget
5366 * @mixins OO.ui.GroupElement
5369 * @param {Object} [config] Configuration options
5370 * @cfg {OO.ui.ButtonWidget} [items] Buttons to add
5372 OO
.ui
.ButtonGroupWidget
= function OoUiButtonGroupWidget( config
) {
5373 // Parent constructor
5374 OO
.ui
.ButtonGroupWidget
.super.call( this, config
);
5376 // Mixin constructors
5377 OO
.ui
.GroupElement
.call( this, this.$element
, config
);
5380 this.$element
.addClass( 'oo-ui-buttonGroupWidget' );
5381 if ( $.isArray( config
.items
) ) {
5382 this.addItems( config
.items
);
5388 OO
.inheritClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.Widget
);
5389 OO
.mixinClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.GroupElement
);
5394 * @extends OO.ui.Widget
5395 * @mixins OO.ui.ButtonedElement
5396 * @mixins OO.ui.IconedElement
5397 * @mixins OO.ui.IndicatedElement
5398 * @mixins OO.ui.LabeledElement
5399 * @mixins OO.ui.TitledElement
5400 * @mixins OO.ui.FlaggableElement
5403 * @param {Object} [config] Configuration options
5404 * @cfg {string} [title=''] Title text
5405 * @cfg {string} [href] Hyperlink to visit when clicked
5406 * @cfg {string} [target] Target to open hyperlink in
5408 OO
.ui
.ButtonWidget
= function OoUiButtonWidget( config
) {
5409 // Configuration initialization
5410 config
= $.extend( { 'target': '_blank' }, config
);
5412 // Parent constructor
5413 OO
.ui
.ButtonWidget
.super.call( this, config
);
5415 // Mixin constructors
5416 OO
.ui
.ButtonedElement
.call( this, this.$( '<a>' ), config
);
5417 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
5418 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
5419 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
5420 OO
.ui
.TitledElement
.call( this, this.$button
, config
);
5421 OO
.ui
.FlaggableElement
.call( this, config
);
5424 this.isHyperlink
= typeof config
.href
=== 'string';
5428 'click': OO
.ui
.bind( this.onClick
, this ),
5429 'keypress': OO
.ui
.bind( this.onKeyPress
, this )
5434 .append( this.$icon
, this.$label
, this.$indicator
)
5435 .attr( { 'href': config
.href
, 'target': config
.target
} );
5437 .addClass( 'oo-ui-buttonWidget' )
5438 .append( this.$button
);
5443 OO
.inheritClass( OO
.ui
.ButtonWidget
, OO
.ui
.Widget
);
5444 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.ButtonedElement
);
5445 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IconedElement
);
5446 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IndicatedElement
);
5447 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.LabeledElement
);
5448 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.TitledElement
);
5449 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.FlaggableElement
);
5460 * Handles mouse click events.
5462 * @param {jQuery.Event} e Mouse click event
5465 OO
.ui
.ButtonWidget
.prototype.onClick = function () {
5466 if ( !this.isDisabled() ) {
5467 this.emit( 'click' );
5468 if ( this.isHyperlink
) {
5476 * Handles keypress events.
5478 * @param {jQuery.Event} e Keypress event
5481 OO
.ui
.ButtonWidget
.prototype.onKeyPress = function ( e
) {
5482 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
5484 if ( this.isHyperlink
) {
5495 * @extends OO.ui.Widget
5498 * @param {Object} [config] Configuration options
5499 * @cfg {string} [name=''] HTML input name
5500 * @cfg {string} [value=''] Input value
5501 * @cfg {boolean} [readOnly=false] Prevent changes
5502 * @cfg {Function} [inputFilter] Filter function to apply to the input. Takes a string argument and returns a string.
5504 OO
.ui
.InputWidget
= function OoUiInputWidget( config
) {
5505 // Config intialization
5506 config
= $.extend( { 'readOnly': false }, config
);
5508 // Parent constructor
5509 OO
.ui
.InputWidget
.super.call( this, config
);
5512 this.$input
= this.getInputElement( config
);
5514 this.readOnly
= false;
5515 this.inputFilter
= config
.inputFilter
;
5518 this.$input
.on( 'keydown mouseup cut paste change input select', OO
.ui
.bind( this.onEdit
, this ) );
5522 .attr( 'name', config
.name
)
5523 .prop( 'disabled', this.isDisabled() );
5524 this.setReadOnly( config
.readOnly
);
5525 this.$element
.addClass( 'oo-ui-inputWidget' ).append( this.$input
);
5526 this.setValue( config
.value
);
5531 OO
.inheritClass( OO
.ui
.InputWidget
, OO
.ui
.Widget
);
5543 * Get input element.
5545 * @param {Object} [config] Configuration options
5546 * @return {jQuery} Input element
5548 OO
.ui
.InputWidget
.prototype.getInputElement = function () {
5549 return this.$( '<input>' );
5553 * Handle potentially value-changing events.
5555 * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
5557 OO
.ui
.InputWidget
.prototype.onEdit = function () {
5558 if ( !this.isDisabled() ) {
5559 // Allow the stack to clear so the value will be updated
5560 setTimeout( OO
.ui
.bind( function () {
5561 this.setValue( this.$input
.val() );
5567 * Get the value of the input.
5569 * @return {string} Input value
5571 OO
.ui
.InputWidget
.prototype.getValue = function () {
5576 * Sets the direction of the current input, either RTL or LTR
5578 * @param {boolean} isRTL
5580 OO
.ui
.InputWidget
.prototype.setRTL = function ( isRTL
) {
5582 this.$input
.removeClass( 'oo-ui-ltr' );
5583 this.$input
.addClass( 'oo-ui-rtl' );
5585 this.$input
.removeClass( 'oo-ui-rtl' );
5586 this.$input
.addClass( 'oo-ui-ltr' );
5591 * Set the value of the input.
5593 * @param {string} value New value
5597 OO
.ui
.InputWidget
.prototype.setValue = function ( value
) {
5598 value
= this.sanitizeValue( value
);
5599 if ( this.value
!== value
) {
5601 this.emit( 'change', this.value
);
5603 // Update the DOM if it has changed. Note that with sanitizeValue, it
5604 // is possible for the DOM value to change without this.value changing.
5605 if ( this.$input
.val() !== this.value
) {
5606 this.$input
.val( this.value
);
5612 * Sanitize incoming value.
5614 * Ensures value is a string, and converts undefined and null to empty strings.
5616 * @param {string} value Original value
5617 * @return {string} Sanitized value
5619 OO
.ui
.InputWidget
.prototype.sanitizeValue = function ( value
) {
5620 if ( value
=== undefined || value
=== null ) {
5622 } else if ( this.inputFilter
) {
5623 return this.inputFilter( String( value
) );
5625 return String( value
);
5630 * Simulate the behavior of clicking on a label bound to this input.
5632 OO
.ui
.InputWidget
.prototype.simulateLabelClick = function () {
5633 if ( !this.isDisabled() ) {
5634 if ( this.$input
.is( ':checkbox,:radio' ) ) {
5635 this.$input
.click();
5636 } else if ( this.$input
.is( ':input' ) ) {
5637 this.$input
.focus();
5643 * Check if the widget is read-only.
5647 OO
.ui
.InputWidget
.prototype.isReadOnly = function () {
5648 return this.readOnly
;
5652 * Set the read-only state of the widget.
5654 * This should probably change the widgets's appearance and prevent it from being used.
5656 * @param {boolean} state Make input read-only
5659 OO
.ui
.InputWidget
.prototype.setReadOnly = function ( state
) {
5660 this.readOnly
= !!state
;
5661 this.$input
.prop( 'readOnly', this.readOnly
);
5668 OO
.ui
.InputWidget
.prototype.setDisabled = function ( state
) {
5669 OO
.ui
.Widget
.prototype.setDisabled
.call( this, state
);
5670 if ( this.$input
) {
5671 this.$input
.prop( 'disabled', this.isDisabled() );
5681 OO
.ui
.InputWidget
.prototype.focus = function () {
5682 this.$input
.focus();
5689 * @extends OO.ui.InputWidget
5692 * @param {Object} [config] Configuration options
5694 OO
.ui
.CheckboxInputWidget
= function OoUiCheckboxInputWidget( config
) {
5695 // Parent constructor
5696 OO
.ui
.CheckboxInputWidget
.super.call( this, config
);
5699 this.$element
.addClass( 'oo-ui-checkboxInputWidget' );
5704 OO
.inheritClass( OO
.ui
.CheckboxInputWidget
, OO
.ui
.InputWidget
);
5711 * Get input element.
5713 * @return {jQuery} Input element
5715 OO
.ui
.CheckboxInputWidget
.prototype.getInputElement = function () {
5716 return this.$( '<input type="checkbox" />' );
5720 * Get checked state of the checkbox
5722 * @return {boolean} If the checkbox is checked
5724 OO
.ui
.CheckboxInputWidget
.prototype.getValue = function () {
5731 OO
.ui
.CheckboxInputWidget
.prototype.setValue = function ( value
) {
5733 if ( this.value
!== value
) {
5735 this.$input
.prop( 'checked', this.value
);
5736 this.emit( 'change', this.value
);
5743 OO
.ui
.CheckboxInputWidget
.prototype.onEdit = function () {
5744 if ( !this.isDisabled() ) {
5745 // Allow the stack to clear so the value will be updated
5746 setTimeout( OO
.ui
.bind( function () {
5747 this.setValue( this.$input
.prop( 'checked' ) );
5755 * @extends OO.ui.Widget
5756 * @mixins OO.ui.LabeledElement
5759 * @param {Object} [config] Configuration options
5761 OO
.ui
.LabelWidget
= function OoUiLabelWidget( config
) {
5762 // Config intialization
5763 config
= config
|| {};
5765 // Parent constructor
5766 OO
.ui
.LabelWidget
.super.call( this, config
);
5768 // Mixin constructors
5769 OO
.ui
.LabeledElement
.call( this, this.$element
, config
);
5772 this.input
= config
.input
;
5775 if ( this.input
instanceof OO
.ui
.InputWidget
) {
5776 this.$element
.on( 'click', OO
.ui
.bind( this.onClick
, this ) );
5780 this.$element
.addClass( 'oo-ui-labelWidget' );
5785 OO
.inheritClass( OO
.ui
.LabelWidget
, OO
.ui
.Widget
);
5786 OO
.mixinClass( OO
.ui
.LabelWidget
, OO
.ui
.LabeledElement
);
5788 /* Static Properties */
5790 OO
.ui
.LabelWidget
.static.tagName
= 'label';
5795 * Handles label mouse click events.
5797 * @param {jQuery.Event} e Mouse click event
5799 OO
.ui
.LabelWidget
.prototype.onClick = function () {
5800 this.input
.simulateLabelClick();
5804 * Lookup input widget.
5806 * Mixin that adds a menu showing suggested values to a text input. Subclasses must handle `select`
5807 * and `choose` events on #lookupMenu to make use of selections.
5813 * @param {OO.ui.TextInputWidget} input Input widget
5814 * @param {Object} [config] Configuration options
5815 * @cfg {jQuery} [$overlay=this.$( 'body' )] Overlay layer
5817 OO
.ui
.LookupInputWidget
= function OoUiLookupInputWidget( input
, config
) {
5818 // Config intialization
5819 config
= config
|| {};
5822 this.lookupInput
= input
;
5823 this.$overlay
= config
.$overlay
|| this.$( 'body,.oo-ui-window-overlay' ).last();
5824 this.lookupMenu
= new OO
.ui
.TextInputMenuWidget( this, {
5825 '$': OO
.ui
.Element
.getJQuery( this.$overlay
),
5826 'input': this.lookupInput
,
5827 '$container': config
.$container
5829 this.lookupCache
= {};
5830 this.lookupQuery
= null;
5831 this.lookupRequest
= null;
5832 this.populating
= false;
5835 this.$overlay
.append( this.lookupMenu
.$element
);
5837 this.lookupInput
.$input
.on( {
5838 'focus': OO
.ui
.bind( this.onLookupInputFocus
, this ),
5839 'blur': OO
.ui
.bind( this.onLookupInputBlur
, this ),
5840 'mousedown': OO
.ui
.bind( this.onLookupInputMouseDown
, this )
5842 this.lookupInput
.connect( this, { 'change': 'onLookupInputChange' } );
5845 this.$element
.addClass( 'oo-ui-lookupWidget' );
5846 this.lookupMenu
.$element
.addClass( 'oo-ui-lookupWidget-menu' );
5852 * Handle input focus event.
5854 * @param {jQuery.Event} e Input focus event
5856 OO
.ui
.LookupInputWidget
.prototype.onLookupInputFocus = function () {
5857 this.openLookupMenu();
5861 * Handle input blur event.
5863 * @param {jQuery.Event} e Input blur event
5865 OO
.ui
.LookupInputWidget
.prototype.onLookupInputBlur = function () {
5866 this.lookupMenu
.hide();
5870 * Handle input mouse down event.
5872 * @param {jQuery.Event} e Input mouse down event
5874 OO
.ui
.LookupInputWidget
.prototype.onLookupInputMouseDown = function () {
5875 this.openLookupMenu();
5879 * Handle input change event.
5881 * @param {string} value New input value
5883 OO
.ui
.LookupInputWidget
.prototype.onLookupInputChange = function () {
5884 this.openLookupMenu();
5890 * @return {OO.ui.TextInputMenuWidget}
5892 OO
.ui
.LookupInputWidget
.prototype.getLookupMenu = function () {
5893 return this.lookupMenu
;
5901 OO
.ui
.LookupInputWidget
.prototype.openLookupMenu = function () {
5902 var value
= this.lookupInput
.getValue();
5904 if ( this.lookupMenu
.$input
.is( ':focus' ) && $.trim( value
) !== '' ) {
5905 this.populateLookupMenu();
5906 if ( !this.lookupMenu
.isVisible() ) {
5907 this.lookupMenu
.show();
5910 this.lookupMenu
.clearItems();
5911 this.lookupMenu
.hide();
5918 * Populate lookup menu with current information.
5922 OO
.ui
.LookupInputWidget
.prototype.populateLookupMenu = function () {
5923 if ( !this.populating
) {
5924 this.populating
= true;
5925 this.getLookupMenuItems()
5926 .done( OO
.ui
.bind( function ( items
) {
5927 this.lookupMenu
.clearItems();
5928 if ( items
.length
) {
5929 this.lookupMenu
.show();
5930 this.lookupMenu
.addItems( items
);
5931 this.initializeLookupMenuSelection();
5932 this.openLookupMenu();
5934 this.lookupMenu
.hide();
5936 this.populating
= false;
5938 .fail( OO
.ui
.bind( function () {
5939 this.lookupMenu
.clearItems();
5940 this.populating
= false;
5948 * Set selection in the lookup menu with current information.
5952 OO
.ui
.LookupInputWidget
.prototype.initializeLookupMenuSelection = function () {
5953 if ( !this.lookupMenu
.getSelectedItem() ) {
5954 this.lookupMenu
.selectItem( this.lookupMenu
.getFirstSelectableItem() );
5956 this.lookupMenu
.highlightItem( this.lookupMenu
.getSelectedItem() );
5960 * Get lookup menu items for the current query.
5962 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument
5965 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItems = function () {
5966 var value
= this.lookupInput
.getValue(),
5967 deferred
= $.Deferred();
5969 if ( value
&& value
!== this.lookupQuery
) {
5970 // Abort current request if query has changed
5971 if ( this.lookupRequest
) {
5972 this.lookupRequest
.abort();
5973 this.lookupQuery
= null;
5974 this.lookupRequest
= null;
5976 if ( value
in this.lookupCache
) {
5977 deferred
.resolve( this.getLookupMenuItemsFromData( this.lookupCache
[value
] ) );
5979 this.lookupQuery
= value
;
5980 this.lookupRequest
= this.getLookupRequest()
5981 .always( OO
.ui
.bind( function () {
5982 this.lookupQuery
= null;
5983 this.lookupRequest
= null;
5985 .done( OO
.ui
.bind( function ( data
) {
5986 this.lookupCache
[value
] = this.getLookupCacheItemFromData( data
);
5987 deferred
.resolve( this.getLookupMenuItemsFromData( this.lookupCache
[value
] ) );
5989 .fail( function () {
5993 this.lookupRequest
.always( OO
.ui
.bind( function () {
5998 return deferred
.promise();
6002 * Get a new request object of the current lookup query value.
6005 * @return {jqXHR} jQuery AJAX object, or promise object with an .abort() method
6007 OO
.ui
.LookupInputWidget
.prototype.getLookupRequest = function () {
6008 // Stub, implemented in subclass
6013 * Handle successful lookup request.
6015 * Overriding methods should call #populateLookupMenu when results are available and cache results
6016 * for future lookups in #lookupCache as an array of #OO.ui.MenuItemWidget objects.
6019 * @param {Mixed} data Response from server
6021 OO
.ui
.LookupInputWidget
.prototype.onLookupRequestDone = function () {
6022 // Stub, implemented in subclass
6026 * Get a list of menu item widgets from the data stored by the lookup request's done handler.
6029 * @param {Mixed} data Cached result data, usually an array
6030 * @return {OO.ui.MenuItemWidget[]} Menu items
6032 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItemsFromData = function () {
6033 // Stub, implemented in subclass
6039 * Use with OO.ui.SelectWidget.
6042 * @extends OO.ui.Widget
6043 * @mixins OO.ui.IconedElement
6044 * @mixins OO.ui.LabeledElement
6045 * @mixins OO.ui.IndicatedElement
6046 * @mixins OO.ui.FlaggableElement
6049 * @param {Mixed} data Option data
6050 * @param {Object} [config] Configuration options
6051 * @cfg {string} [rel] Value for `rel` attribute in DOM, allowing per-option styling
6053 OO
.ui
.OptionWidget
= function OoUiOptionWidget( data
, config
) {
6054 // Config intialization
6055 config
= config
|| {};
6057 // Parent constructor
6058 OO
.ui
.OptionWidget
.super.call( this, config
);
6060 // Mixin constructors
6061 OO
.ui
.ItemWidget
.call( this );
6062 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
6063 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
6064 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
6065 OO
.ui
.FlaggableElement
.call( this, config
);
6069 this.selected
= false;
6070 this.highlighted
= false;
6071 this.pressed
= false;
6075 .data( 'oo-ui-optionWidget', this )
6076 .attr( 'rel', config
.rel
)
6077 .addClass( 'oo-ui-optionWidget' )
6078 .append( this.$label
);
6080 .prepend( this.$icon
)
6081 .append( this.$indicator
);
6086 OO
.inheritClass( OO
.ui
.OptionWidget
, OO
.ui
.Widget
);
6087 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.ItemWidget
);
6088 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IconedElement
);
6089 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.LabeledElement
);
6090 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IndicatedElement
);
6091 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.FlaggableElement
);
6093 /* Static Properties */
6095 OO
.ui
.OptionWidget
.static.tagName
= 'li';
6097 OO
.ui
.OptionWidget
.static.selectable
= true;
6099 OO
.ui
.OptionWidget
.static.highlightable
= true;
6101 OO
.ui
.OptionWidget
.static.pressable
= true;
6103 OO
.ui
.OptionWidget
.static.scrollIntoViewOnSelect
= false;
6108 * Check if option can be selected.
6110 * @return {boolean} Item is selectable
6112 OO
.ui
.OptionWidget
.prototype.isSelectable = function () {
6113 return this.constructor.static.selectable
&& !this.isDisabled();
6117 * Check if option can be highlighted.
6119 * @return {boolean} Item is highlightable
6121 OO
.ui
.OptionWidget
.prototype.isHighlightable = function () {
6122 return this.constructor.static.highlightable
&& !this.isDisabled();
6126 * Check if option can be pressed.
6128 * @return {boolean} Item is pressable
6130 OO
.ui
.OptionWidget
.prototype.isPressable = function () {
6131 return this.constructor.static.pressable
&& !this.isDisabled();
6135 * Check if option is selected.
6137 * @return {boolean} Item is selected
6139 OO
.ui
.OptionWidget
.prototype.isSelected = function () {
6140 return this.selected
;
6144 * Check if option is highlighted.
6146 * @return {boolean} Item is highlighted
6148 OO
.ui
.OptionWidget
.prototype.isHighlighted = function () {
6149 return this.highlighted
;
6153 * Check if option is pressed.
6155 * @return {boolean} Item is pressed
6157 OO
.ui
.OptionWidget
.prototype.isPressed = function () {
6158 return this.pressed
;
6162 * Set selected state.
6164 * @param {boolean} [state=false] Select option
6167 OO
.ui
.OptionWidget
.prototype.setSelected = function ( state
) {
6168 if ( !this.isDisabled() && this.constructor.static.selectable
) {
6169 this.selected
= !!state
;
6170 if ( this.selected
) {
6171 this.$element
.addClass( 'oo-ui-optionWidget-selected' );
6172 if ( this.constructor.static.scrollIntoViewOnSelect
) {
6173 this.scrollElementIntoView();
6176 this.$element
.removeClass( 'oo-ui-optionWidget-selected' );
6183 * Set highlighted state.
6185 * @param {boolean} [state=false] Highlight option
6188 OO
.ui
.OptionWidget
.prototype.setHighlighted = function ( state
) {
6189 if ( !this.isDisabled() && this.constructor.static.highlightable
) {
6190 this.highlighted
= !!state
;
6191 if ( this.highlighted
) {
6192 this.$element
.addClass( 'oo-ui-optionWidget-highlighted' );
6194 this.$element
.removeClass( 'oo-ui-optionWidget-highlighted' );
6201 * Set pressed state.
6203 * @param {boolean} [state=false] Press option
6206 OO
.ui
.OptionWidget
.prototype.setPressed = function ( state
) {
6207 if ( !this.isDisabled() && this.constructor.static.pressable
) {
6208 this.pressed
= !!state
;
6209 if ( this.pressed
) {
6210 this.$element
.addClass( 'oo-ui-optionWidget-pressed' );
6212 this.$element
.removeClass( 'oo-ui-optionWidget-pressed' );
6219 * Make the option's highlight flash.
6221 * While flashing, the visual style of the pressed state is removed if present.
6223 * @return {jQuery.Promise} Promise resolved when flashing is done
6225 OO
.ui
.OptionWidget
.prototype.flash = function () {
6226 var $this = this.$element
,
6227 deferred
= $.Deferred();
6229 if ( !this.isDisabled() && this.constructor.static.pressable
) {
6230 $this.removeClass( 'oo-ui-optionWidget-highlighted oo-ui-optionWidget-pressed' );
6231 setTimeout( OO
.ui
.bind( function () {
6232 // Restore original classes
6234 .toggleClass( 'oo-ui-optionWidget-highlighted', this.highlighted
)
6235 .toggleClass( 'oo-ui-optionWidget-pressed', this.pressed
);
6236 setTimeout( function () {
6242 return deferred
.promise();
6248 * @return {Mixed} Option data
6250 OO
.ui
.OptionWidget
.prototype.getData = function () {
6254 * Selection of options.
6256 * Use together with OO.ui.OptionWidget.
6259 * @extends OO.ui.Widget
6260 * @mixins OO.ui.GroupElement
6263 * @param {Object} [config] Configuration options
6264 * @cfg {OO.ui.OptionWidget[]} [items] Options to add
6266 OO
.ui
.SelectWidget
= function OoUiSelectWidget( config
) {
6267 // Config intialization
6268 config
= config
|| {};
6270 // Parent constructor
6271 OO
.ui
.SelectWidget
.super.call( this, config
);
6273 // Mixin constructors
6274 OO
.ui
.GroupWidget
.call( this, this.$element
, config
);
6277 this.pressed
= false;
6278 this.selecting
= null;
6283 'mousedown': OO
.ui
.bind( this.onMouseDown
, this ),
6284 'mouseup': OO
.ui
.bind( this.onMouseUp
, this ),
6285 'mousemove': OO
.ui
.bind( this.onMouseMove
, this ),
6286 'mouseover': OO
.ui
.bind( this.onMouseOver
, this ),
6287 'mouseleave': OO
.ui
.bind( this.onMouseLeave
, this )
6291 this.$element
.addClass( 'oo-ui-selectWidget oo-ui-selectWidget-depressed' );
6292 if ( $.isArray( config
.items
) ) {
6293 this.addItems( config
.items
);
6299 OO
.inheritClass( OO
.ui
.SelectWidget
, OO
.ui
.Widget
);
6301 // Need to mixin base class as well
6302 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupElement
);
6303 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupWidget
);
6309 * @param {OO.ui.OptionWidget|null} item Highlighted item
6314 * @param {OO.ui.OptionWidget|null} item Pressed item
6319 * @param {OO.ui.OptionWidget|null} item Selected item
6324 * @param {OO.ui.OptionWidget|null} item Chosen item
6329 * @param {OO.ui.OptionWidget[]} items Added items
6330 * @param {number} index Index items were added at
6335 * @param {OO.ui.OptionWidget[]} items Removed items
6338 /* Static Properties */
6340 OO
.ui
.SelectWidget
.static.tagName
= 'ul';
6345 * Handle mouse down events.
6348 * @param {jQuery.Event} e Mouse down event
6350 OO
.ui
.SelectWidget
.prototype.onMouseDown = function ( e
) {
6353 if ( !this.isDisabled() && e
.which
=== 1 ) {
6354 this.togglePressed( true );
6355 item
= this.getTargetItem( e
);
6356 if ( item
&& item
.isSelectable() ) {
6357 this.pressItem( item
);
6358 this.selecting
= item
;
6359 this.$( this.$.context
).one( 'mouseup', OO
.ui
.bind( this.onMouseUp
, this ) );
6366 * Handle mouse up events.
6369 * @param {jQuery.Event} e Mouse up event
6371 OO
.ui
.SelectWidget
.prototype.onMouseUp = function ( e
) {
6374 this.togglePressed( false );
6375 if ( !this.selecting
) {
6376 item
= this.getTargetItem( e
);
6377 if ( item
&& item
.isSelectable() ) {
6378 this.selecting
= item
;
6381 if ( !this.isDisabled() && e
.which
=== 1 && this.selecting
) {
6382 this.pressItem( null );
6383 this.chooseItem( this.selecting
);
6384 this.selecting
= null;
6391 * Handle mouse move events.
6394 * @param {jQuery.Event} e Mouse move event
6396 OO
.ui
.SelectWidget
.prototype.onMouseMove = function ( e
) {
6399 if ( !this.isDisabled() && this.pressed
) {
6400 item
= this.getTargetItem( e
);
6401 if ( item
&& item
!== this.selecting
&& item
.isSelectable() ) {
6402 this.pressItem( item
);
6403 this.selecting
= item
;
6410 * Handle mouse over events.
6413 * @param {jQuery.Event} e Mouse over event
6415 OO
.ui
.SelectWidget
.prototype.onMouseOver = function ( e
) {
6418 if ( !this.isDisabled() ) {
6419 item
= this.getTargetItem( e
);
6420 this.highlightItem( item
&& item
.isHighlightable() ? item
: null );
6426 * Handle mouse leave events.
6429 * @param {jQuery.Event} e Mouse over event
6431 OO
.ui
.SelectWidget
.prototype.onMouseLeave = function () {
6432 if ( !this.isDisabled() ) {
6433 this.highlightItem( null );
6439 * Get the closest item to a jQuery.Event.
6442 * @param {jQuery.Event} e
6443 * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
6445 OO
.ui
.SelectWidget
.prototype.getTargetItem = function ( e
) {
6446 var $item
= this.$( e
.target
).closest( '.oo-ui-optionWidget' );
6447 if ( $item
.length
) {
6448 return $item
.data( 'oo-ui-optionWidget' );
6454 * Get selected item.
6456 * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
6458 OO
.ui
.SelectWidget
.prototype.getSelectedItem = function () {
6461 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6462 if ( this.items
[i
].isSelected() ) {
6463 return this.items
[i
];
6470 * Get highlighted item.
6472 * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
6474 OO
.ui
.SelectWidget
.prototype.getHighlightedItem = function () {
6477 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6478 if ( this.items
[i
].isHighlighted() ) {
6479 return this.items
[i
];
6486 * Get an existing item with equivilant data.
6488 * @param {Object} data Item data to search for
6489 * @return {OO.ui.OptionWidget|null} Item with equivilent value, `null` if none exists
6491 OO
.ui
.SelectWidget
.prototype.getItemFromData = function ( data
) {
6492 var hash
= OO
.getHash( data
);
6494 if ( hash
in this.hashes
) {
6495 return this.hashes
[hash
];
6502 * Toggle pressed state.
6504 * @param {boolean} pressed An option is being pressed
6506 OO
.ui
.SelectWidget
.prototype.togglePressed = function ( pressed
) {
6507 if ( pressed
=== undefined ) {
6508 pressed
= !this.pressed
;
6510 if ( pressed
!== this.pressed
) {
6511 this.$element
.toggleClass( 'oo-ui-selectWidget-pressed', pressed
);
6512 this.$element
.toggleClass( 'oo-ui-selectWidget-depressed', !pressed
);
6513 this.pressed
= pressed
;
6518 * Highlight an item.
6520 * Highlighting is mutually exclusive.
6522 * @param {OO.ui.OptionWidget} [item] Item to highlight, omit to deselect all
6526 OO
.ui
.SelectWidget
.prototype.highlightItem = function ( item
) {
6527 var i
, len
, highlighted
,
6530 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6531 highlighted
= this.items
[i
] === item
;
6532 if ( this.items
[i
].isHighlighted() !== highlighted
) {
6533 this.items
[i
].setHighlighted( highlighted
);
6538 this.emit( 'highlight', item
);
6547 * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
6551 OO
.ui
.SelectWidget
.prototype.selectItem = function ( item
) {
6552 var i
, len
, selected
,
6555 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6556 selected
= this.items
[i
] === item
;
6557 if ( this.items
[i
].isSelected() !== selected
) {
6558 this.items
[i
].setSelected( selected
);
6563 this.emit( 'select', item
);
6572 * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
6576 OO
.ui
.SelectWidget
.prototype.pressItem = function ( item
) {
6577 var i
, len
, pressed
,
6580 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6581 pressed
= this.items
[i
] === item
;
6582 if ( this.items
[i
].isPressed() !== pressed
) {
6583 this.items
[i
].setPressed( pressed
);
6588 this.emit( 'press', item
);
6597 * Identical to #selectItem, but may vary in subclasses that want to take additional action when
6598 * an item is selected using the keyboard or mouse.
6600 * @param {OO.ui.OptionWidget} item Item to choose
6604 OO
.ui
.SelectWidget
.prototype.chooseItem = function ( item
) {
6605 this.selectItem( item
);
6606 this.emit( 'choose', item
);
6612 * Get an item relative to another one.
6614 * @param {OO.ui.OptionWidget} item Item to start at
6615 * @param {number} direction Direction to move in
6616 * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the menu
6618 OO
.ui
.SelectWidget
.prototype.getRelativeSelectableItem = function ( item
, direction
) {
6619 var inc
= direction
> 0 ? 1 : -1,
6620 len
= this.items
.length
,
6621 index
= item
instanceof OO
.ui
.OptionWidget
?
6622 $.inArray( item
, this.items
) : ( inc
> 0 ? -1 : 0 ),
6623 stopAt
= Math
.max( Math
.min( index
, len
- 1 ), 0 ),
6625 // Default to 0 instead of -1, if nothing is selected let's start at the beginning
6626 Math
.max( index
, -1 ) :
6627 // Default to n-1 instead of -1, if nothing is selected let's start at the end
6628 Math
.min( index
, len
);
6631 i
= ( i
+ inc
+ len
) % len
;
6632 item
= this.items
[i
];
6633 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
6636 // Stop iterating when we've looped all the way around
6637 if ( i
=== stopAt
) {
6645 * Get the next selectable item.
6647 * @return {OO.ui.OptionWidget|null} Item, `null` if ther aren't any selectable items
6649 OO
.ui
.SelectWidget
.prototype.getFirstSelectableItem = function () {
6652 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6653 item
= this.items
[i
];
6654 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
6665 * When items are added with the same values as existing items, the existing items will be
6666 * automatically removed before the new items are added.
6668 * @param {OO.ui.OptionWidget[]} items Items to add
6669 * @param {number} [index] Index to insert items after
6673 OO
.ui
.SelectWidget
.prototype.addItems = function ( items
, index
) {
6674 var i
, len
, item
, hash
,
6677 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
6679 hash
= OO
.getHash( item
.getData() );
6680 if ( hash
in this.hashes
) {
6681 // Remove item with same value
6682 remove
.push( this.hashes
[hash
] );
6684 this.hashes
[hash
] = item
;
6686 if ( remove
.length
) {
6687 this.removeItems( remove
);
6690 OO
.ui
.GroupElement
.prototype.addItems
.call( this, items
, index
);
6692 // Always provide an index, even if it was omitted
6693 this.emit( 'add', items
, index
=== undefined ? this.items
.length
- items
.length
- 1 : index
);
6701 * Items will be detached, not removed, so they can be used later.
6703 * @param {OO.ui.OptionWidget[]} items Items to remove
6707 OO
.ui
.SelectWidget
.prototype.removeItems = function ( items
) {
6708 var i
, len
, item
, hash
;
6710 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
6712 hash
= OO
.getHash( item
.getData() );
6713 if ( hash
in this.hashes
) {
6714 // Remove existing item
6715 delete this.hashes
[hash
];
6717 if ( item
.isSelected() ) {
6718 this.selectItem( null );
6721 OO
.ui
.GroupElement
.prototype.removeItems
.call( this, items
);
6723 this.emit( 'remove', items
);
6731 * Items will be detached, not removed, so they can be used later.
6736 OO
.ui
.SelectWidget
.prototype.clearItems = function () {
6737 var items
= this.items
.slice();
6741 OO
.ui
.GroupElement
.prototype.clearItems
.call( this );
6742 this.selectItem( null );
6744 this.emit( 'remove', items
);
6751 * Use with OO.ui.MenuWidget.
6754 * @extends OO.ui.OptionWidget
6757 * @param {Mixed} data Item data
6758 * @param {Object} [config] Configuration options
6760 OO
.ui
.MenuItemWidget
= function OoUiMenuItemWidget( data
, config
) {
6761 // Configuration initialization
6762 config
= $.extend( { 'icon': 'check' }, config
);
6764 // Parent constructor
6765 OO
.ui
.MenuItemWidget
.super.call( this, data
, config
);
6768 this.$element
.addClass( 'oo-ui-menuItemWidget' );
6773 OO
.inheritClass( OO
.ui
.MenuItemWidget
, OO
.ui
.OptionWidget
);
6777 * Use together with OO.ui.MenuItemWidget.
6780 * @extends OO.ui.SelectWidget
6781 * @mixins OO.ui.ClippableElement
6784 * @param {Object} [config] Configuration options
6785 * @cfg {OO.ui.InputWidget} [input] Input to bind keyboard handlers to
6786 * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu
6788 OO
.ui
.MenuWidget
= function OoUiMenuWidget( config
) {
6789 // Config intialization
6790 config
= config
|| {};
6792 // Parent constructor
6793 OO
.ui
.MenuWidget
.super.call( this, config
);
6795 // Mixin constructors
6796 OO
.ui
.ClippableElement
.call( this, this.$group
, config
);
6799 this.autoHide
= config
.autoHide
=== undefined || !!config
.autoHide
;
6800 this.newItems
= null;
6801 this.$input
= config
.input
? config
.input
.$input
: null;
6802 this.$previousFocus
= null;
6803 this.isolated
= !config
.input
;
6804 this.visible
= false;
6805 this.flashing
= false;
6806 this.onKeyDownHandler
= OO
.ui
.bind( this.onKeyDown
, this );
6807 this.onDocumentMouseDownHandler
= OO
.ui
.bind( this.onDocumentMouseDown
, this );
6810 this.$element
.hide().addClass( 'oo-ui-menuWidget' );
6815 OO
.inheritClass( OO
.ui
.MenuWidget
, OO
.ui
.SelectWidget
);
6816 OO
.mixinClass( OO
.ui
.MenuWidget
, OO
.ui
.ClippableElement
);
6821 * Handles document mouse down events.
6823 * @param {jQuery.Event} e Key down event
6825 OO
.ui
.MenuWidget
.prototype.onDocumentMouseDown = function ( e
) {
6826 if ( !$.contains( this.$element
[0], e
.target
) ) {
6832 * Handles key down events.
6834 * @param {jQuery.Event} e Key down event
6836 OO
.ui
.MenuWidget
.prototype.onKeyDown = function ( e
) {
6839 highlightItem
= this.getHighlightedItem();
6841 if ( !this.isDisabled() && this.visible
) {
6842 if ( !highlightItem
) {
6843 highlightItem
= this.getSelectedItem();
6845 switch ( e
.keyCode
) {
6846 case OO
.ui
.Keys
.ENTER
:
6847 this.chooseItem( highlightItem
);
6851 nextItem
= this.getRelativeSelectableItem( highlightItem
, -1 );
6854 case OO
.ui
.Keys
.DOWN
:
6855 nextItem
= this.getRelativeSelectableItem( highlightItem
, 1 );
6858 case OO
.ui
.Keys
.ESCAPE
:
6859 if ( highlightItem
) {
6860 highlightItem
.setHighlighted( false );
6868 this.highlightItem( nextItem
);
6869 nextItem
.scrollElementIntoView();
6874 e
.stopPropagation();
6881 * Check if the menu is visible.
6883 * @return {boolean} Menu is visible
6885 OO
.ui
.MenuWidget
.prototype.isVisible = function () {
6886 return this.visible
;
6890 * Bind key down listener.
6892 OO
.ui
.MenuWidget
.prototype.bindKeyDownListener = function () {
6893 if ( this.$input
) {
6894 this.$input
.on( 'keydown', this.onKeyDownHandler
);
6896 // Capture menu navigation keys
6897 this.getElementWindow().addEventListener( 'keydown', this.onKeyDownHandler
, true );
6902 * Unbind key down listener.
6904 OO
.ui
.MenuWidget
.prototype.unbindKeyDownListener = function () {
6905 if ( this.$input
) {
6906 this.$input
.off( 'keydown' );
6908 this.getElementWindow().removeEventListener( 'keydown', this.onKeyDownHandler
, true );
6915 * This will close the menu when done, unlike selectItem which only changes selection.
6917 * @param {OO.ui.OptionWidget} item Item to choose
6920 OO
.ui
.MenuWidget
.prototype.chooseItem = function ( item
) {
6922 OO
.ui
.MenuWidget
.super.prototype.chooseItem
.call( this, item
);
6924 if ( item
&& !this.flashing
) {
6925 this.flashing
= true;
6926 item
.flash().done( OO
.ui
.bind( function () {
6928 this.flashing
= false;
6940 * Adding an existing item (by value) will move it.
6942 * @param {OO.ui.MenuItemWidget[]} items Items to add
6943 * @param {number} [index] Index to insert items after
6946 OO
.ui
.MenuWidget
.prototype.addItems = function ( items
, index
) {
6950 OO
.ui
.SelectWidget
.prototype.addItems
.call( this, items
, index
);
6953 if ( !this.newItems
) {
6957 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
6959 if ( this.visible
) {
6960 // Defer fitting label until
6963 this.newItems
.push( item
);
6975 OO
.ui
.MenuWidget
.prototype.show = function () {
6978 if ( this.items
.length
) {
6979 this.$element
.show();
6980 this.visible
= true;
6981 this.bindKeyDownListener();
6983 // Change focus to enable keyboard navigation
6984 if ( this.isolated
&& this.$input
&& !this.$input
.is( ':focus' ) ) {
6985 this.$previousFocus
= this.$( ':focus' );
6986 this.$input
.focus();
6988 if ( this.newItems
&& this.newItems
.length
) {
6989 for ( i
= 0, len
= this.newItems
.length
; i
< len
; i
++ ) {
6990 this.newItems
[i
].fitLabel();
6992 this.newItems
= null;
6995 this.setClipping( true );
6998 if ( this.autoHide
) {
6999 this.getElementDocument().addEventListener(
7000 'mousedown', this.onDocumentMouseDownHandler
, true
7013 OO
.ui
.MenuWidget
.prototype.hide = function () {
7014 this.$element
.hide();
7015 this.visible
= false;
7016 this.unbindKeyDownListener();
7018 if ( this.isolated
&& this.$previousFocus
) {
7019 this.$previousFocus
.focus();
7020 this.$previousFocus
= null;
7023 this.getElementDocument().removeEventListener(
7024 'mousedown', this.onDocumentMouseDownHandler
, true
7027 this.setClipping( false );
7032 * Inline menu of options.
7034 * Use with OO.ui.MenuOptionWidget.
7037 * @extends OO.ui.Widget
7038 * @mixins OO.ui.IconedElement
7039 * @mixins OO.ui.IndicatedElement
7040 * @mixins OO.ui.LabeledElement
7041 * @mixins OO.ui.TitledElement
7044 * @param {Object} [config] Configuration options
7045 * @cfg {Object} [menu] Configuration options to pass to menu widget
7047 OO
.ui
.InlineMenuWidget
= function OoUiInlineMenuWidget( config
) {
7048 // Configuration initialization
7049 config
= $.extend( { 'indicator': 'down' }, config
);
7051 // Parent constructor
7052 OO
.ui
.InlineMenuWidget
.super.call( this, config
);
7054 // Mixin constructors
7055 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
7056 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
7057 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
7058 OO
.ui
.TitledElement
.call( this, this.$label
, config
);
7061 this.menu
= new OO
.ui
.MenuWidget( $.extend( { '$': this.$ }, config
.menu
) );
7062 this.$handle
= this.$( '<span>' );
7065 this.$element
.on( { 'click': OO
.ui
.bind( this.onClick
, this ) } );
7066 this.menu
.connect( this, { 'select': 'onMenuSelect' } );
7070 .addClass( 'oo-ui-inlineMenuWidget-handle' )
7071 .append( this.$icon
, this.$label
, this.$indicator
);
7073 .addClass( 'oo-ui-inlineMenuWidget' )
7074 .append( this.$handle
, this.menu
.$element
);
7079 OO
.inheritClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.Widget
);
7080 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.IconedElement
);
7081 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.IndicatedElement
);
7082 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.LabeledElement
);
7083 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.TitledElement
);
7090 * @return {OO.ui.MenuWidget} Menu of widget
7092 OO
.ui
.InlineMenuWidget
.prototype.getMenu = function () {
7097 * Handles menu select events.
7099 * @param {OO.ui.MenuItemWidget} item Selected menu item
7101 OO
.ui
.InlineMenuWidget
.prototype.onMenuSelect = function ( item
) {
7108 selectedLabel
= item
.getLabel();
7110 // If the label is a DOM element, clone it, because setLabel will append() it
7111 if ( selectedLabel
instanceof jQuery
) {
7112 selectedLabel
= selectedLabel
.clone();
7115 this.setLabel( selectedLabel
);
7119 * Handles mouse click events.
7121 * @param {jQuery.Event} e Mouse click event
7123 OO
.ui
.InlineMenuWidget
.prototype.onClick = function ( e
) {
7124 // Skip clicks within the menu
7125 if ( $.contains( this.menu
.$element
[0], e
.target
) ) {
7129 if ( !this.isDisabled() ) {
7130 if ( this.menu
.isVisible() ) {
7139 * Menu section item widget.
7141 * Use with OO.ui.MenuWidget.
7144 * @extends OO.ui.OptionWidget
7147 * @param {Mixed} data Item data
7148 * @param {Object} [config] Configuration options
7150 OO
.ui
.MenuSectionItemWidget
= function OoUiMenuSectionItemWidget( data
, config
) {
7151 // Parent constructor
7152 OO
.ui
.MenuSectionItemWidget
.super.call( this, data
, config
);
7155 this.$element
.addClass( 'oo-ui-menuSectionItemWidget' );
7160 OO
.inheritClass( OO
.ui
.MenuSectionItemWidget
, OO
.ui
.OptionWidget
);
7162 /* Static Properties */
7164 OO
.ui
.MenuSectionItemWidget
.static.selectable
= false;
7166 OO
.ui
.MenuSectionItemWidget
.static.highlightable
= false;
7168 * Create an OO.ui.OutlineWidget object.
7170 * Use with OO.ui.OutlineItemWidget.
7173 * @extends OO.ui.SelectWidget
7176 * @param {Object} [config] Configuration options
7178 OO
.ui
.OutlineWidget
= function OoUiOutlineWidget( config
) {
7179 // Config intialization
7180 config
= config
|| {};
7182 // Parent constructor
7183 OO
.ui
.OutlineWidget
.super.call( this, config
);
7186 this.$element
.addClass( 'oo-ui-outlineWidget' );
7191 OO
.inheritClass( OO
.ui
.OutlineWidget
, OO
.ui
.SelectWidget
);
7193 * Creates an OO.ui.OutlineControlsWidget object.
7195 * Use together with OO.ui.OutlineWidget.js
7200 * @param {OO.ui.OutlineWidget} outline Outline to control
7201 * @param {Object} [config] Configuration options
7203 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
7204 // Configuration initialization
7205 config
= $.extend( { 'icon': 'add-item' }, config
);
7207 // Parent constructor
7208 OO
.ui
.OutlineControlsWidget
.super.call( this, config
);
7210 // Mixin constructors
7211 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
7212 OO
.ui
.IconedElement
.call( this, this.$( '<div>' ), config
);
7215 this.outline
= outline
;
7216 this.$movers
= this.$( '<div>' );
7217 this.upButton
= new OO
.ui
.ButtonWidget( {
7221 'title': OO
.ui
.msg( 'ooui-outline-control-move-up' )
7223 this.downButton
= new OO
.ui
.ButtonWidget( {
7227 'title': OO
.ui
.msg( 'ooui-outline-control-move-down' )
7229 this.removeButton
= new OO
.ui
.ButtonWidget( {
7233 'title': OO
.ui
.msg( 'ooui-outline-control-remove' )
7237 outline
.connect( this, {
7238 'select': 'onOutlineChange',
7239 'add': 'onOutlineChange',
7240 'remove': 'onOutlineChange'
7242 this.upButton
.connect( this, { 'click': [ 'emit', 'move', -1 ] } );
7243 this.downButton
.connect( this, { 'click': [ 'emit', 'move', 1 ] } );
7244 this.removeButton
.connect( this, { 'click': [ 'emit', 'remove' ] } );
7247 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
7248 this.$group
.addClass( 'oo-ui-outlineControlsWidget-adders' );
7250 .addClass( 'oo-ui-outlineControlsWidget-movers' )
7251 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
7252 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
7257 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
7258 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.GroupElement
);
7259 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.IconedElement
);
7265 * @param {number} places Number of places to move
7275 * Handle outline change events.
7277 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
7278 var i
, len
, firstMovable
, lastMovable
,
7279 items
= this.outline
.getItems(),
7280 selectedItem
= this.outline
.getSelectedItem(),
7281 movable
= selectedItem
&& selectedItem
.isMovable(),
7282 removable
= selectedItem
&& selectedItem
.isRemovable();
7287 while ( ++i
< len
) {
7288 if ( items
[i
].isMovable() ) {
7289 firstMovable
= items
[i
];
7295 if ( items
[i
].isMovable() ) {
7296 lastMovable
= items
[i
];
7301 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
7302 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
7303 this.removeButton
.setDisabled( !removable
);
7306 * Creates an OO.ui.OutlineItemWidget object.
7308 * Use with OO.ui.OutlineWidget.
7311 * @extends OO.ui.OptionWidget
7314 * @param {Mixed} data Item data
7315 * @param {Object} [config] Configuration options
7316 * @cfg {number} [level] Indentation level
7317 * @cfg {boolean} [movable] Allow modification from outline controls
7319 OO
.ui
.OutlineItemWidget
= function OoUiOutlineItemWidget( data
, config
) {
7320 // Config intialization
7321 config
= config
|| {};
7323 // Parent constructor
7324 OO
.ui
.OutlineItemWidget
.super.call( this, data
, config
);
7328 this.movable
= !!config
.movable
;
7329 this.removable
= !!config
.removable
;
7332 this.$element
.addClass( 'oo-ui-outlineItemWidget' );
7333 this.setLevel( config
.level
);
7338 OO
.inheritClass( OO
.ui
.OutlineItemWidget
, OO
.ui
.OptionWidget
);
7340 /* Static Properties */
7342 OO
.ui
.OutlineItemWidget
.static.highlightable
= false;
7344 OO
.ui
.OutlineItemWidget
.static.scrollIntoViewOnSelect
= true;
7346 OO
.ui
.OutlineItemWidget
.static.levelClass
= 'oo-ui-outlineItemWidget-level-';
7348 OO
.ui
.OutlineItemWidget
.static.levels
= 3;
7353 * Check if item is movable.
7355 * Movablilty is used by outline controls.
7357 * @return {boolean} Item is movable
7359 OO
.ui
.OutlineItemWidget
.prototype.isMovable = function () {
7360 return this.movable
;
7364 * Check if item is removable.
7366 * Removablilty is used by outline controls.
7368 * @return {boolean} Item is removable
7370 OO
.ui
.OutlineItemWidget
.prototype.isRemovable = function () {
7371 return this.removable
;
7375 * Get indentation level.
7377 * @return {number} Indentation level
7379 OO
.ui
.OutlineItemWidget
.prototype.getLevel = function () {
7386 * Movablilty is used by outline controls.
7388 * @param {boolean} movable Item is movable
7391 OO
.ui
.OutlineItemWidget
.prototype.setMovable = function ( movable
) {
7392 this.movable
= !!movable
;
7399 * Removablilty is used by outline controls.
7401 * @param {boolean} movable Item is removable
7404 OO
.ui
.OutlineItemWidget
.prototype.setRemovable = function ( removable
) {
7405 this.removable
= !!removable
;
7410 * Set indentation level.
7412 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
7415 OO
.ui
.OutlineItemWidget
.prototype.setLevel = function ( level
) {
7416 var levels
= this.constructor.static.levels
,
7417 levelClass
= this.constructor.static.levelClass
,
7420 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
7422 if ( this.level
=== i
) {
7423 this.$element
.addClass( levelClass
+ i
);
7425 this.$element
.removeClass( levelClass
+ i
);
7432 * Option widget that looks like a button.
7434 * Use together with OO.ui.ButtonSelectWidget.
7437 * @extends OO.ui.OptionWidget
7438 * @mixins OO.ui.ButtonedElement
7439 * @mixins OO.ui.FlaggableElement
7442 * @param {Mixed} data Option data
7443 * @param {Object} [config] Configuration options
7445 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( data
, config
) {
7446 // Parent constructor
7447 OO
.ui
.ButtonOptionWidget
.super.call( this, data
, config
);
7449 // Mixin constructors
7450 OO
.ui
.ButtonedElement
.call( this, this.$( '<a>' ), config
);
7451 OO
.ui
.FlaggableElement
.call( this, config
);
7454 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
7455 this.$button
.append( this.$element
.contents() );
7456 this.$element
.append( this.$button
);
7461 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.OptionWidget
);
7462 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.ButtonedElement
);
7463 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.FlaggableElement
);
7470 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
7471 OO
.ui
.OptionWidget
.prototype.setSelected
.call( this, state
);
7473 this.setActive( state
);
7478 * Select widget containing button options.
7480 * Use together with OO.ui.ButtonOptionWidget.
7483 * @extends OO.ui.SelectWidget
7486 * @param {Object} [config] Configuration options
7488 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
7489 // Parent constructor
7490 OO
.ui
.ButtonSelectWidget
.super.call( this, config
);
7493 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
7498 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
7500 * Container for content that is overlaid and positioned absolutely.
7503 * @extends OO.ui.Widget
7504 * @mixins OO.ui.LabeledElement
7507 * @param {Object} [config] Configuration options
7508 * @cfg {boolean} [tail=true] Show tail pointing to origin of popup
7509 * @cfg {string} [align='center'] Alignment of popup to origin
7510 * @cfg {jQuery} [$container] Container to prevent popup from rendering outside of
7511 * @cfg {boolean} [autoClose=false] Popup auto-closes when it loses focus
7512 * @cfg {jQuery} [$autoCloseIgnore] Elements to not auto close when clicked
7513 * @cfg {boolean} [head] Show label and close button at the top
7515 OO
.ui
.PopupWidget
= function OoUiPopupWidget( config
) {
7516 // Config intialization
7517 config
= config
|| {};
7519 // Parent constructor
7520 OO
.ui
.PopupWidget
.super.call( this, config
);
7522 // Mixin constructors
7523 OO
.ui
.LabeledElement
.call( this, this.$( '<div>' ), config
);
7524 OO
.ui
.ClippableElement
.call( this, this.$( '<div>' ), config
);
7527 this.visible
= false;
7528 this.$popup
= this.$( '<div>' );
7529 this.$head
= this.$( '<div>' );
7530 this.$body
= this.$clippable
;
7531 this.$tail
= this.$( '<div>' );
7532 this.$container
= config
.$container
|| this.$( 'body' );
7533 this.autoClose
= !!config
.autoClose
;
7534 this.$autoCloseIgnore
= config
.$autoCloseIgnore
;
7535 this.transitionTimeout
= null;
7537 this.align
= config
.align
|| 'center';
7538 this.closeButton
= new OO
.ui
.ButtonWidget( { '$': this.$, 'frameless': true, 'icon': 'close' } );
7539 this.onMouseDownHandler
= OO
.ui
.bind( this.onMouseDown
, this );
7542 this.closeButton
.connect( this, { 'click': 'onCloseButtonClick' } );
7545 this.useTail( config
.tail
!== undefined ? !!config
.tail
: true );
7546 this.$body
.addClass( 'oo-ui-popupWidget-body' );
7547 this.$tail
.addClass( 'oo-ui-popupWidget-tail' );
7549 .addClass( 'oo-ui-popupWidget-head' )
7550 .append( this.$label
, this.closeButton
.$element
);
7551 if ( !config
.head
) {
7555 .addClass( 'oo-ui-popupWidget-popup' )
7556 .append( this.$head
, this.$body
);
7557 this.$element
.hide()
7558 .addClass( 'oo-ui-popupWidget' )
7559 .append( this.$popup
, this.$tail
);
7564 OO
.inheritClass( OO
.ui
.PopupWidget
, OO
.ui
.Widget
);
7565 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.LabeledElement
);
7566 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.ClippableElement
);
7581 * Handles mouse down events.
7583 * @param {jQuery.Event} e Mouse down event
7585 OO
.ui
.PopupWidget
.prototype.onMouseDown = function ( e
) {
7588 !$.contains( this.$element
[0], e
.target
) &&
7589 ( !this.$autoCloseIgnore
|| !this.$autoCloseIgnore
.has( e
.target
).length
)
7596 * Bind mouse down listener.
7598 OO
.ui
.PopupWidget
.prototype.bindMouseDownListener = function () {
7599 // Capture clicks outside popup
7600 this.getElementWindow().addEventListener( 'mousedown', this.onMouseDownHandler
, true );
7604 * Handles close button click events.
7606 OO
.ui
.PopupWidget
.prototype.onCloseButtonClick = function () {
7607 if ( this.visible
) {
7613 * Unbind mouse down listener.
7615 OO
.ui
.PopupWidget
.prototype.unbindMouseDownListener = function () {
7616 this.getElementWindow().removeEventListener( 'mousedown', this.onMouseDownHandler
, true );
7620 * Check if the popup is visible.
7622 * @return {boolean} Popup is visible
7624 OO
.ui
.PopupWidget
.prototype.isVisible = function () {
7625 return this.visible
;
7629 * Set whether to show a tail.
7631 * @return {boolean} Make tail visible
7633 OO
.ui
.PopupWidget
.prototype.useTail = function ( value
) {
7635 if ( this.tail
!== value
) {
7638 this.$element
.addClass( 'oo-ui-popupWidget-tailed' );
7640 this.$element
.removeClass( 'oo-ui-popupWidget-tailed' );
7646 * Check if showing a tail.
7648 * @return {boolean} tail is visible
7650 OO
.ui
.PopupWidget
.prototype.hasTail = function () {
7660 OO
.ui
.PopupWidget
.prototype.show = function () {
7661 if ( !this.visible
) {
7662 this.setClipping( true );
7663 this.$element
.show();
7664 this.visible
= true;
7665 this.emit( 'show' );
7666 if ( this.autoClose
) {
7667 this.bindMouseDownListener();
7679 OO
.ui
.PopupWidget
.prototype.hide = function () {
7680 if ( this.visible
) {
7681 this.setClipping( false );
7682 this.$element
.hide();
7683 this.visible
= false;
7684 this.emit( 'hide' );
7685 if ( this.autoClose
) {
7686 this.unbindMouseDownListener();
7693 * Updates the position and size.
7695 * @param {number} width Width
7696 * @param {number} height Height
7697 * @param {boolean} [transition=false] Use a smooth transition
7700 OO
.ui
.PopupWidget
.prototype.display = function ( width
, height
, transition
) {
7702 originOffset
= Math
.round( this.$element
.offset().left
),
7703 containerLeft
= Math
.round( this.$container
.offset().left
),
7704 containerWidth
= this.$container
.innerWidth(),
7705 containerRight
= containerLeft
+ containerWidth
,
7706 popupOffset
= width
* ( { 'left': 0, 'center': -0.5, 'right': -1 } )[this.align
],
7707 popupLeft
= popupOffset
- padding
,
7708 popupRight
= popupOffset
+ padding
+ width
+ padding
,
7709 overlapLeft
= ( originOffset
+ popupLeft
) - containerLeft
,
7710 overlapRight
= containerRight
- ( originOffset
+ popupRight
);
7712 // Prevent transition from being interrupted
7713 clearTimeout( this.transitionTimeout
);
7715 // Enable transition
7716 this.$element
.addClass( 'oo-ui-popupWidget-transitioning' );
7719 if ( overlapRight
< 0 ) {
7720 popupOffset
+= overlapRight
;
7721 } else if ( overlapLeft
< 0 ) {
7722 popupOffset
-= overlapLeft
;
7725 // Position body relative to anchor and resize
7727 'left': popupOffset
,
7729 'height': height
=== undefined ? 'auto' : height
7733 // Prevent transitioning after transition is complete
7734 this.transitionTimeout
= setTimeout( OO
.ui
.bind( function () {
7735 this.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
7738 // Prevent transitioning immediately
7739 this.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
7745 * Button that shows and hides a popup.
7748 * @extends OO.ui.ButtonWidget
7749 * @mixins OO.ui.PopuppableElement
7752 * @param {Object} [config] Configuration options
7754 OO
.ui
.PopupButtonWidget
= function OoUiPopupButtonWidget( config
) {
7755 // Parent constructor
7756 OO
.ui
.PopupButtonWidget
.super.call( this, config
);
7758 // Mixin constructors
7759 OO
.ui
.PopuppableElement
.call( this, config
);
7763 .addClass( 'oo-ui-popupButtonWidget' )
7764 .append( this.popup
.$element
);
7769 OO
.inheritClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.ButtonWidget
);
7770 OO
.mixinClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.PopuppableElement
);
7775 * Handles mouse click events.
7777 * @param {jQuery.Event} e Mouse click event
7779 OO
.ui
.PopupButtonWidget
.prototype.onClick = function ( e
) {
7780 // Skip clicks within the popup
7781 if ( $.contains( this.popup
.$element
[0], e
.target
) ) {
7785 if ( !this.isDisabled() ) {
7786 if ( this.popup
.isVisible() ) {
7791 OO
.ui
.ButtonWidget
.prototype.onClick
.call( this );
7798 * Combines query and results selection widgets.
7801 * @extends OO.ui.Widget
7804 * @param {Object} [config] Configuration options
7805 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
7806 * @cfg {string} [value] Initial query value
7808 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
7809 // Configuration intialization
7810 config
= config
|| {};
7812 // Parent constructor
7813 OO
.ui
.SearchWidget
.super.call( this, config
);
7816 this.query
= new OO
.ui
.TextInputWidget( {
7819 'placeholder': config
.placeholder
,
7820 'value': config
.value
7822 this.results
= new OO
.ui
.SelectWidget( { '$': this.$ } );
7823 this.$query
= this.$( '<div>' );
7824 this.$results
= this.$( '<div>' );
7827 this.query
.connect( this, {
7828 'change': 'onQueryChange',
7829 'enter': 'onQueryEnter'
7831 this.results
.connect( this, {
7832 'highlight': 'onResultsHighlight',
7833 'select': 'onResultsSelect'
7835 this.query
.$input
.on( 'keydown', OO
.ui
.bind( this.onQueryKeydown
, this ) );
7839 .addClass( 'oo-ui-searchWidget-query' )
7840 .append( this.query
.$element
);
7842 .addClass( 'oo-ui-searchWidget-results' )
7843 .append( this.results
.$element
);
7845 .addClass( 'oo-ui-searchWidget' )
7846 .append( this.$results
, this.$query
);
7851 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
7857 * @param {Object|null} item Item data or null if no item is highlighted
7862 * @param {Object|null} item Item data or null if no item is selected
7868 * Handle query key down events.
7870 * @param {jQuery.Event} e Key down event
7872 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
7873 var highlightedItem
, nextItem
,
7874 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
7877 highlightedItem
= this.results
.getHighlightedItem();
7878 if ( !highlightedItem
) {
7879 highlightedItem
= this.results
.getSelectedItem();
7881 nextItem
= this.results
.getRelativeSelectableItem( highlightedItem
, dir
);
7882 this.results
.highlightItem( nextItem
);
7883 nextItem
.scrollElementIntoView();
7888 * Handle select widget select events.
7890 * Clears existing results. Subclasses should repopulate items according to new query.
7892 * @param {string} value New value
7894 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
7896 this.results
.clearItems();
7900 * Handle select widget enter key events.
7902 * Selects highlighted item.
7904 * @param {string} value New value
7906 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
7908 this.results
.selectItem( this.results
.getHighlightedItem() );
7912 * Handle select widget highlight events.
7914 * @param {OO.ui.OptionWidget} item Highlighted item
7917 OO
.ui
.SearchWidget
.prototype.onResultsHighlight = function ( item
) {
7918 this.emit( 'highlight', item
? item
.getData() : null );
7922 * Handle select widget select events.
7924 * @param {OO.ui.OptionWidget} item Selected item
7927 OO
.ui
.SearchWidget
.prototype.onResultsSelect = function ( item
) {
7928 this.emit( 'select', item
? item
.getData() : null );
7932 * Get the query input.
7934 * @return {OO.ui.TextInputWidget} Query input
7936 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
7941 * Get the results list.
7943 * @return {OO.ui.SelectWidget} Select list
7945 OO
.ui
.SearchWidget
.prototype.getResults = function () {
7946 return this.results
;
7949 * Text input widget.
7952 * @extends OO.ui.InputWidget
7955 * @param {Object} [config] Configuration options
7956 * @cfg {string} [placeholder] Placeholder text
7957 * @cfg {string} [icon] Symbolic name of icon
7958 * @cfg {boolean} [multiline=false] Allow multiple lines of text
7959 * @cfg {boolean} [autosize=false] Automatically resize to fit content
7960 * @cfg {boolean} [maxRows=10] Maximum number of rows to make visible when autosizing
7962 OO
.ui
.TextInputWidget
= function OoUiTextInputWidget( config
) {
7963 config
= $.extend( { 'maxRows': 10 }, config
);
7965 // Parent constructor
7966 OO
.ui
.TextInputWidget
.super.call( this, config
);
7970 this.multiline
= !!config
.multiline
;
7971 this.autosize
= !!config
.autosize
;
7972 this.maxRows
= config
.maxRows
;
7975 this.$input
.on( 'keypress', OO
.ui
.bind( this.onKeyPress
, this ) );
7976 this.$element
.on( 'DOMNodeInsertedIntoDocument', OO
.ui
.bind( this.onElementAttach
, this ) );
7979 this.$element
.addClass( 'oo-ui-textInputWidget' );
7980 if ( config
.icon
) {
7981 this.$element
.addClass( 'oo-ui-textInputWidget-decorated' );
7982 this.$element
.append(
7984 .addClass( 'oo-ui-textInputWidget-icon oo-ui-icon-' + config
.icon
)
7985 .mousedown( OO
.ui
.bind( function () {
7986 this.$input
.focus();
7991 if ( config
.placeholder
) {
7992 this.$input
.attr( 'placeholder', config
.placeholder
);
7998 OO
.inheritClass( OO
.ui
.TextInputWidget
, OO
.ui
.InputWidget
);
8003 * User presses enter inside the text box.
8005 * Not called if input is multiline.
8013 * Handle key press events.
8015 * @param {jQuery.Event} e Key press event
8016 * @fires enter If enter key is pressed and input is not multiline
8018 OO
.ui
.TextInputWidget
.prototype.onKeyPress = function ( e
) {
8019 if ( e
.which
=== OO
.ui
.Keys
.ENTER
&& !this.multiline
) {
8020 this.emit( 'enter' );
8025 * Handle element attach events.
8027 * @param {jQuery.Event} e Element attach event
8029 OO
.ui
.TextInputWidget
.prototype.onElementAttach = function () {
8036 OO
.ui
.TextInputWidget
.prototype.onEdit = function () {
8040 return OO
.ui
.InputWidget
.prototype.onEdit
.call( this );
8044 * Automatically adjust the size of the text input.
8046 * This only affects multi-line inputs that are auto-sized.
8050 OO
.ui
.TextInputWidget
.prototype.adjustSize = function () {
8051 var $clone
, scrollHeight
, innerHeight
, outerHeight
, maxInnerHeight
, idealHeight
;
8053 if ( this.multiline
&& this.autosize
) {
8054 $clone
= this.$input
.clone()
8055 .val( this.$input
.val() )
8056 .css( { 'height': 0 } )
8057 .insertAfter( this.$input
);
8058 // Set inline height property to 0 to measure scroll height
8059 scrollHeight
= $clone
[0].scrollHeight
;
8060 // Remove inline height property to measure natural heights
8061 $clone
.css( 'height', '' );
8062 innerHeight
= $clone
.innerHeight();
8063 outerHeight
= $clone
.outerHeight();
8064 // Measure max rows height
8065 $clone
.attr( 'rows', this.maxRows
).css( 'height', 'auto' );
8066 maxInnerHeight
= $clone
.innerHeight();
8067 $clone
.removeAttr( 'rows' ).css( 'height', '' );
8069 idealHeight
= Math
.min( maxInnerHeight
, scrollHeight
);
8070 // Only apply inline height when expansion beyond natural height is needed
8073 // Use the difference between the inner and outer height as a buffer
8074 idealHeight
> outerHeight
? idealHeight
+ ( outerHeight
- innerHeight
) : ''
8081 * Get input element.
8083 * @param {Object} [config] Configuration options
8084 * @return {jQuery} Input element
8086 OO
.ui
.TextInputWidget
.prototype.getInputElement = function ( config
) {
8087 return config
.multiline
? this.$( '<textarea>' ) : this.$( '<input type="text" />' );
8093 * Check if input supports multiple lines.
8097 OO
.ui
.TextInputWidget
.prototype.isMultiline = function () {
8098 return !!this.multiline
;
8102 * Check if input automatically adjusts its size.
8106 OO
.ui
.TextInputWidget
.prototype.isAutosizing = function () {
8107 return !!this.autosize
;
8111 * Check if input is pending.
8115 OO
.ui
.TextInputWidget
.prototype.isPending = function () {
8116 return !!this.pending
;
8120 * Increase the pending stack.
8124 OO
.ui
.TextInputWidget
.prototype.pushPending = function () {
8125 if ( this.pending
=== 0 ) {
8126 this.$element
.addClass( 'oo-ui-textInputWidget-pending' );
8127 this.$input
.addClass( 'oo-ui-texture-pending' );
8135 * Reduce the pending stack.
8141 OO
.ui
.TextInputWidget
.prototype.popPending = function () {
8142 if ( this.pending
=== 1 ) {
8143 this.$element
.removeClass( 'oo-ui-textInputWidget-pending' );
8144 this.$input
.removeClass( 'oo-ui-texture-pending' );
8146 this.pending
= Math
.max( 0, this.pending
- 1 );
8152 * Select the contents of the input.
8156 OO
.ui
.TextInputWidget
.prototype.select = function () {
8157 this.$input
.select();
8161 * Menu for a text input widget.
8164 * @extends OO.ui.MenuWidget
8167 * @param {OO.ui.TextInputWidget} input Text input widget to provide menu for
8168 * @param {Object} [config] Configuration options
8169 * @cfg {jQuery} [$container=input.$element] Element to render menu under
8171 OO
.ui
.TextInputMenuWidget
= function OoUiTextInputMenuWidget( input
, config
) {
8172 // Parent constructor
8173 OO
.ui
.TextInputMenuWidget
.super.call( this, config
);
8177 this.$container
= config
.$container
|| this.input
.$element
;
8178 this.onWindowResizeHandler
= OO
.ui
.bind( this.onWindowResize
, this );
8181 this.$element
.addClass( 'oo-ui-textInputMenuWidget' );
8186 OO
.inheritClass( OO
.ui
.TextInputMenuWidget
, OO
.ui
.MenuWidget
);
8191 * Handle window resize event.
8193 * @param {jQuery.Event} e Window resize event
8195 OO
.ui
.TextInputMenuWidget
.prototype.onWindowResize = function () {
8204 OO
.ui
.TextInputMenuWidget
.prototype.show = function () {
8206 OO
.ui
.MenuWidget
.prototype.show
.call( this );
8209 this.$( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler
);
8218 OO
.ui
.TextInputMenuWidget
.prototype.hide = function () {
8220 OO
.ui
.MenuWidget
.prototype.hide
.call( this );
8222 this.$( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler
);
8227 * Position the menu.
8231 OO
.ui
.TextInputMenuWidget
.prototype.position = function () {
8233 $container
= this.$container
,
8234 dimensions
= $container
.offset();
8236 // Position under input
8237 dimensions
.top
+= $container
.height();
8239 // Compensate for frame position if in a differnt frame
8240 if ( this.input
.$.frame
&& this.input
.$.context
!== this.$element
[0].ownerDocument
) {
8241 frameOffset
= OO
.ui
.Element
.getRelativePosition(
8242 this.input
.$.frame
.$element
, this.$element
.offsetParent()
8244 dimensions
.left
+= frameOffset
.left
;
8245 dimensions
.top
+= frameOffset
.top
;
8247 // Fix for RTL (for some reason, no need to fix if the frameoffset is set)
8248 if ( this.$element
.css( 'direction' ) === 'rtl' ) {
8249 dimensions
.right
= this.$element
.parent().position().left
-
8250 dimensions
.width
- dimensions
.left
;
8251 // Erase the value for 'left':
8252 delete dimensions
.left
;
8256 this.$element
.css( dimensions
);
8257 this.setIdealSize( $container
.width() );
8261 * Width with on and off states.
8263 * Mixin for widgets with a boolean state.
8269 * @param {Object} [config] Configuration options
8270 * @cfg {boolean} [value=false] Initial value
8272 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
8273 // Configuration initialization
8274 config
= config
|| {};
8280 this.$element
.addClass( 'oo-ui-toggleWidget' );
8281 this.setValue( !!config
.value
);
8288 * @param {boolean} value Changed value
8294 * Get the value of the toggle.
8298 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
8303 * Set the value of the toggle.
8305 * @param {boolean} value New value
8309 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
8311 if ( this.value
!== value
) {
8313 this.emit( 'change', value
);
8314 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
8315 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
8320 * Button that toggles on and off.
8323 * @extends OO.ui.ButtonWidget
8324 * @mixins OO.ui.ToggleWidget
8327 * @param {Object} [config] Configuration options
8328 * @cfg {boolean} [value=false] Initial value
8330 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
8331 // Configuration initialization
8332 config
= config
|| {};
8334 // Parent constructor
8335 OO
.ui
.ToggleButtonWidget
.super.call( this, config
);
8337 // Mixin constructors
8338 OO
.ui
.ToggleWidget
.call( this, config
);
8341 this.$element
.addClass( 'oo-ui-toggleButtonWidget' );
8346 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ButtonWidget
);
8347 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
8354 OO
.ui
.ToggleButtonWidget
.prototype.onClick = function () {
8355 if ( !this.isDisabled() ) {
8356 this.setValue( !this.value
);
8360 return OO
.ui
.ButtonWidget
.prototype.onClick
.call( this );
8366 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
8368 if ( value
!== this.value
) {
8369 this.setActive( value
);
8373 OO
.ui
.ToggleWidget
.prototype.setValue
.call( this, value
);
8378 * Switch that slides on and off.
8381 * @extends OO.ui.Widget
8382 * @mixins OO.ui.ToggleWidget
8385 * @param {Object} [config] Configuration options
8386 * @cfg {boolean} [value=false] Initial value
8388 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
8389 // Parent constructor
8390 OO
.ui
.ToggleSwitchWidget
.super.call( this, config
);
8392 // Mixin constructors
8393 OO
.ui
.ToggleWidget
.call( this, config
);
8396 this.dragging
= false;
8397 this.dragStart
= null;
8398 this.sliding
= false;
8399 this.$glow
= this.$( '<span>' );
8400 this.$grip
= this.$( '<span>' );
8403 this.$element
.on( 'click', OO
.ui
.bind( this.onClick
, this ) );
8406 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
8407 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
8409 .addClass( 'oo-ui-toggleSwitchWidget' )
8410 .append( this.$glow
, this.$grip
);
8415 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.Widget
);
8416 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
8421 * Handle mouse down events.
8423 * @param {jQuery.Event} e Mouse down event
8425 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
8426 if ( !this.isDisabled() && e
.which
=== 1 ) {
8427 this.setValue( !this.value
);