2 * OOjs UI v0.1.0-pre (dd888aba5c)
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: Fri May 30 2014 21:28:55 GMT-0700 (PDT)
15 * Namespace for all classes, static methods and static properties.
47 * Get the user's language and any fallback languages.
49 * These language codes are used to localize user interface elements in the user's language.
51 * In environments that provide a localization system, this function should be overridden to
52 * return the user's language(s). The default implementation returns English (en) only.
54 * @return {string[]} Language codes, in descending order of priority
56 OO
.ui
.getUserLanguages = function () {
61 * Get a value in an object keyed by language code.
63 * @param {Object.<string,Mixed>} obj Object keyed by language code
64 * @param {string|null} [lang] Language code, if omitted or null defaults to any user language
65 * @param {string} [fallback] Fallback code, used if no matching language can be found
66 * @return {Mixed} Local value
68 OO
.ui
.getLocalValue = function ( obj
, lang
, fallback
) {
75 // Known user language
76 langs
= OO
.ui
.getUserLanguages();
77 for ( i
= 0, len
= langs
.length
; i
< len
; i
++ ) {
84 if ( obj
[fallback
] ) {
87 // First existing language
98 * Message store for the default implementation of OO.ui.msg
100 * Environments that provide a localization system should not use this, but should override
101 * OO.ui.msg altogether.
106 // Label text for button to exit from dialog
107 'ooui-dialog-action-close': 'Close',
108 // Tool tip for a button that moves items in a list down one place
109 'ooui-outline-control-move-down': 'Move item down',
110 // Tool tip for a button that moves items in a list up one place
111 'ooui-outline-control-move-up': 'Move item up',
112 // Tool tip for a button that removes items from a list
113 'ooui-outline-control-remove': 'Remove item',
114 // Label for the toolbar group that contains a list of all other available tools
115 'ooui-toolbar-more': 'More',
117 // Label for the generic dialog used to confirm things
118 'ooui-dialog-confirm-title': 'Confirm',
119 // The default prompt of a confirmation dialog
120 'ooui-dialog-confirm-default-prompt': 'Are you sure?',
121 // The default OK button text on a confirmation dialog
122 'ooui-dialog-confirm-default-ok': 'OK',
123 // The default cancel button text on a confirmation dialog
124 'ooui-dialog-confirm-default-cancel': 'Cancel'
128 * Get a localized message.
130 * In environments that provide a localization system, this function should be overridden to
131 * return the message translated in the user's language. The default implementation always returns
134 * After the message key, message parameters may optionally be passed. In the default implementation,
135 * any occurrences of $1 are replaced with the first parameter, $2 with the second parameter, etc.
136 * Alternative implementations of OO.ui.msg may use any substitution system they like, as long as
137 * they support unnamed, ordered message parameters.
140 * @param {string} key Message key
141 * @param {Mixed...} [params] Message parameters
142 * @return {string} Translated message with parameters substituted
144 OO
.ui
.msg = function ( key
) {
145 var message
= messages
[key
], params
= Array
.prototype.slice
.call( arguments
, 1 );
146 if ( typeof message
=== 'string' ) {
147 // Perform $1 substitution
148 message
= message
.replace( /\$(\d+)/g, function ( unused
, n
) {
149 var i
= parseInt( n
, 10 );
150 return params
[i
- 1] !== undefined ? params
[i
- 1] : '$' + n
;
153 // Return placeholder if message not found
154 message
= '[' + key
+ ']';
160 OO
.ui
.deferMsg = function ( key
) {
162 return OO
.ui
.msg( key
);
167 OO
.ui
.resolveMsg = function ( msg
) {
168 if ( $.isFunction( msg
) ) {
176 * DOM element abstraction.
182 * @param {Object} [config] Configuration options
183 * @cfg {Function} [$] jQuery for the frame the widget is in
184 * @cfg {string[]} [classes] CSS class names
185 * @cfg {string} [text] Text to insert
186 * @cfg {jQuery} [$content] Content elements to append (after text)
188 OO
.ui
.Element
= function OoUiElement( config
) {
189 // Configuration initialization
190 config
= config
|| {};
193 this.$ = config
.$ || OO
.ui
.Element
.getJQuery( document
);
194 this.$element
= this.$( this.$.context
.createElement( this.getTagName() ) );
195 this.elementGroup
= null;
198 if ( $.isArray( config
.classes
) ) {
199 this.$element
.addClass( config
.classes
.join( ' ' ) );
202 this.$element
.text( config
.text
);
204 if ( config
.$content
) {
205 this.$element
.append( config
.$content
);
211 OO
.initClass( OO
.ui
.Element
);
213 /* Static Properties */
218 * This may be ignored if getTagName is overridden.
224 OO
.ui
.Element
.static.tagName
= 'div';
229 * Get a jQuery function within a specific document.
232 * @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
233 * @param {OO.ui.Frame} [frame] Frame of the document context
234 * @return {Function} Bound jQuery function
236 OO
.ui
.Element
.getJQuery = function ( context
, frame
) {
237 function wrapper( selector
) {
238 return $( selector
, wrapper
.context
);
241 wrapper
.context
= this.getDocument( context
);
244 wrapper
.frame
= frame
;
251 * Get the document of an element.
254 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Object to get the document for
255 * @return {HTMLDocument|null} Document object
257 OO
.ui
.Element
.getDocument = function ( obj
) {
258 // jQuery - selections created "offscreen" won't have a context, so .context isn't reliable
259 return ( obj
[0] && obj
[0].ownerDocument
) ||
260 // Empty jQuery selections might have a context
267 ( obj
.nodeType
=== 9 && obj
) ||
272 * Get the window of an element or document.
275 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the window for
276 * @return {Window} Window object
278 OO
.ui
.Element
.getWindow = function ( obj
) {
279 var doc
= this.getDocument( obj
);
280 return doc
.parentWindow
|| doc
.defaultView
;
284 * Get the direction of an element or document.
287 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the direction for
288 * @return {string} Text direction, either `ltr` or `rtl`
290 OO
.ui
.Element
.getDir = function ( obj
) {
293 if ( obj
instanceof jQuery
) {
296 isDoc
= obj
.nodeType
=== 9;
297 isWin
= obj
.document
!== undefined;
298 if ( isDoc
|| isWin
) {
304 return $( obj
).css( 'direction' );
308 * Get the offset between two frames.
310 * TODO: Make this function not use recursion.
313 * @param {Window} from Window of the child frame
314 * @param {Window} [to=window] Window of the parent frame
315 * @param {Object} [offset] Offset to start with, used internally
316 * @return {Object} Offset object, containing left and top properties
318 OO
.ui
.Element
.getFrameOffset = function ( from, to
, offset
) {
319 var i
, len
, frames
, frame
, rect
;
325 offset
= { 'top': 0, 'left': 0 };
327 if ( from.parent
=== from ) {
331 // Get iframe element
332 frames
= from.parent
.document
.getElementsByTagName( 'iframe' );
333 for ( i
= 0, len
= frames
.length
; i
< len
; i
++ ) {
334 if ( frames
[i
].contentWindow
=== from ) {
340 // Recursively accumulate offset values
342 rect
= frame
.getBoundingClientRect();
343 offset
.left
+= rect
.left
;
344 offset
.top
+= rect
.top
;
346 this.getFrameOffset( from.parent
, offset
);
353 * Get the offset between two elements.
356 * @param {jQuery} $from
357 * @param {jQuery} $to
358 * @return {Object} Translated position coordinates, containing top and left properties
360 OO
.ui
.Element
.getRelativePosition = function ( $from, $to
) {
361 var from = $from.offset(),
363 return { 'top': Math
.round( from.top
- to
.top
), 'left': Math
.round( from.left
- to
.left
) };
367 * Get element border sizes.
370 * @param {HTMLElement} el Element to measure
371 * @return {Object} Dimensions object with `top`, `left`, `bottom` and `right` properties
373 OO
.ui
.Element
.getBorders = function ( el
) {
374 var doc
= el
.ownerDocument
,
375 win
= doc
.parentWindow
|| doc
.defaultView
,
376 style
= win
&& win
.getComputedStyle
?
377 win
.getComputedStyle( el
, null ) :
380 top
= parseFloat( style
? style
.borderTopWidth
: $el
.css( 'borderTopWidth' ) ) || 0,
381 left
= parseFloat( style
? style
.borderLeftWidth
: $el
.css( 'borderLeftWidth' ) ) || 0,
382 bottom
= parseFloat( style
? style
.borderBottomWidth
: $el
.css( 'borderBottomWidth' ) ) || 0,
383 right
= parseFloat( style
? style
.borderRightWidth
: $el
.css( 'borderRightWidth' ) ) || 0;
386 'top': Math
.round( top
),
387 'left': Math
.round( left
),
388 'bottom': Math
.round( bottom
),
389 'right': Math
.round( right
)
394 * Get dimensions of an element or window.
397 * @param {HTMLElement|Window} el Element to measure
398 * @return {Object} Dimensions object with `borders`, `scroll`, `scrollbar` and `rect` properties
400 OO
.ui
.Element
.getDimensions = function ( el
) {
402 doc
= el
.ownerDocument
|| el
.document
,
403 win
= doc
.parentWindow
|| doc
.defaultView
;
405 if ( win
=== el
|| el
=== doc
.documentElement
) {
408 'borders': { 'top': 0, 'left': 0, 'bottom': 0, 'right': 0 },
410 'top': $win
.scrollTop(),
411 'left': $win
.scrollLeft()
413 'scrollbar': { 'right': 0, 'bottom': 0 },
417 'bottom': $win
.innerHeight(),
418 'right': $win
.innerWidth()
424 'borders': this.getBorders( el
),
426 'top': $el
.scrollTop(),
427 'left': $el
.scrollLeft()
430 'right': $el
.innerWidth() - el
.clientWidth
,
431 'bottom': $el
.innerHeight() - el
.clientHeight
433 'rect': el
.getBoundingClientRect()
439 * Get closest scrollable container.
441 * Traverses up until either a scrollable element or the root is reached, in which case the window
445 * @param {HTMLElement} el Element to find scrollable container for
446 * @param {string} [dimension] Dimension of scrolling to look for; `x`, `y` or omit for either
447 * @return {HTMLElement|Window} Closest scrollable container
449 OO
.ui
.Element
.getClosestScrollableContainer = function ( el
, dimension
) {
451 props
= [ 'overflow' ],
452 $parent
= $( el
).parent();
454 if ( dimension
=== 'x' || dimension
=== 'y' ) {
455 props
.push( 'overflow-' + dimension
);
458 while ( $parent
.length
) {
459 if ( $parent
[0] === el
.ownerDocument
.body
) {
464 val
= $parent
.css( props
[i
] );
465 if ( val
=== 'auto' || val
=== 'scroll' ) {
469 $parent
= $parent
.parent();
471 return this.getDocument( el
).body
;
475 * Scroll element into view.
478 * @param {HTMLElement} el Element to scroll into view
479 * @param {Object} [config={}] Configuration config
480 * @param {string} [config.duration] jQuery animation duration value
481 * @param {string} [config.direction] Scroll in only one direction, e.g. 'x' or 'y', omit
482 * to scroll in both directions
483 * @param {Function} [config.complete] Function to call when scrolling completes
485 OO
.ui
.Element
.scrollIntoView = function ( el
, config
) {
486 // Configuration initialization
487 config
= config
|| {};
490 callback
= typeof config
.complete
=== 'function' && config
.complete
,
491 sc
= this.getClosestScrollableContainer( el
, config
.direction
),
493 eld
= this.getDimensions( el
),
494 scd
= this.getDimensions( sc
),
496 'top': eld
.rect
.top
- ( scd
.rect
.top
+ scd
.borders
.top
),
497 'bottom': scd
.rect
.bottom
- scd
.borders
.bottom
- scd
.scrollbar
.bottom
- eld
.rect
.bottom
,
498 'left': eld
.rect
.left
- ( scd
.rect
.left
+ scd
.borders
.left
),
499 'right': scd
.rect
.right
- scd
.borders
.right
- scd
.scrollbar
.right
- eld
.rect
.right
502 if ( !config
.direction
|| config
.direction
=== 'y' ) {
504 anim
.scrollTop
= scd
.scroll
.top
+ rel
.top
;
505 } else if ( rel
.top
> 0 && rel
.bottom
< 0 ) {
506 anim
.scrollTop
= scd
.scroll
.top
+ Math
.min( rel
.top
, -rel
.bottom
);
509 if ( !config
.direction
|| config
.direction
=== 'x' ) {
510 if ( rel
.left
< 0 ) {
511 anim
.scrollLeft
= scd
.scroll
.left
+ rel
.left
;
512 } else if ( rel
.left
> 0 && rel
.right
< 0 ) {
513 anim
.scrollLeft
= scd
.scroll
.left
+ Math
.min( rel
.left
, -rel
.right
);
516 if ( !$.isEmptyObject( anim
) ) {
517 $sc
.stop( true ).animate( anim
, config
.duration
|| 'fast' );
519 $sc
.queue( function ( next
) {
534 * Get the HTML tag name.
536 * Override this method to base the result on instance information.
538 * @return {string} HTML tag name
540 OO
.ui
.Element
.prototype.getTagName = function () {
541 return this.constructor.static.tagName
;
545 * Check if the element is attached to the DOM
546 * @return {boolean} The element is attached to the DOM
548 OO
.ui
.Element
.prototype.isElementAttached = function () {
549 return $.contains( this.getElementDocument(), this.$element
[0] );
553 * Get the DOM document.
555 * @return {HTMLDocument} Document object
557 OO
.ui
.Element
.prototype.getElementDocument = function () {
558 return OO
.ui
.Element
.getDocument( this.$element
);
562 * Get the DOM window.
564 * @return {Window} Window object
566 OO
.ui
.Element
.prototype.getElementWindow = function () {
567 return OO
.ui
.Element
.getWindow( this.$element
);
571 * Get closest scrollable container.
573 OO
.ui
.Element
.prototype.getClosestScrollableElementContainer = function () {
574 return OO
.ui
.Element
.getClosestScrollableContainer( this.$element
[0] );
578 * Get group element is in.
580 * @return {OO.ui.GroupElement|null} Group element, null if none
582 OO
.ui
.Element
.prototype.getElementGroup = function () {
583 return this.elementGroup
;
587 * Set group element is in.
589 * @param {OO.ui.GroupElement|null} group Group element, null if none
592 OO
.ui
.Element
.prototype.setElementGroup = function ( group
) {
593 this.elementGroup
= group
;
598 * Scroll element into view.
600 * @param {Object} [config={}]
602 OO
.ui
.Element
.prototype.scrollElementIntoView = function ( config
) {
603 return OO
.ui
.Element
.scrollIntoView( this.$element
[0], config
);
607 * Bind a handler for an event on this.$element
609 * @param {string} event
610 * @param {Function} callback
612 OO
.ui
.Element
.prototype.onDOMEvent = function ( event
, callback
) {
613 OO
.ui
.Element
.onDOMEvent( this.$element
, event
, callback
);
617 * Unbind a handler bound with #offDOMEvent
619 * @param {string} event
620 * @param {Function} callback
622 OO
.ui
.Element
.prototype.offDOMEvent = function ( event
, callback
) {
623 OO
.ui
.Element
.offDOMEvent( this.$element
, event
, callback
);
629 // jQuery 1.8.3 has a bug with handling focusin/focusout events inside iframes.
630 // Firefox doesn't support focusin/focusout at all, so we listen for 'focus'/'blur' on the
631 // document, and simulate a 'focusin'/'focusout' event on the target element and make
632 // it bubble from there.
634 // - http://jsfiddle.net/sw3hr/
635 // - http://bugs.jquery.com/ticket/14180
636 // - https://github.com/jquery/jquery/commit/1cecf64e5aa4153
637 function specialEvent( simulatedName
, realName
) {
638 function handler( e
) {
639 jQuery
.event
.simulate(
642 jQuery
.event
.fix( e
),
649 var doc
= this.ownerDocument
|| this,
650 attaches
= $.data( doc
, 'ooui-' + simulatedName
+ '-attaches' );
652 doc
.addEventListener( realName
, handler
, true );
654 $.data( doc
, 'ooui-' + simulatedName
+ '-attaches', ( attaches
|| 0 ) + 1 );
656 teardown: function () {
657 var doc
= this.ownerDocument
|| this,
658 attaches
= $.data( doc
, 'ooui-' + simulatedName
+ '-attaches' ) - 1;
660 doc
.removeEventListener( realName
, handler
, true );
661 $.removeData( doc
, 'ooui-' + simulatedName
+ '-attaches' );
663 $.data( doc
, 'ooui-' + simulatedName
+ '-attaches', attaches
);
669 var hasOwn
= Object
.prototype.hasOwnProperty
,
671 focusin
: specialEvent( 'focusin', 'focus' ),
672 focusout
: specialEvent( 'focusout', 'blur' )
676 * Bind a handler for an event on a DOM element.
678 * Uses jQuery internally for everything except for events which are
679 * known to have issues in the browser or in jQuery. This method
680 * should become obsolete eventually.
683 * @param {HTMLElement|jQuery} el DOM element
684 * @param {string} event Event to bind
685 * @param {Function} callback Callback to call when the event fires
687 OO
.ui
.Element
.onDOMEvent = function ( el
, event
, callback
) {
690 if ( hasOwn
.call( specialEvents
, event
) ) {
691 // Replace jQuery's override with our own
692 orig
= $.event
.special
[event
];
693 $.event
.special
[event
] = specialEvents
[event
];
695 $( el
).on( event
, callback
);
698 $.event
.special
[event
] = orig
;
700 $( el
).on( event
, callback
);
705 * Unbind a handler bound with #static-method-onDOMEvent.
708 * @param {HTMLElement|jQuery} el DOM element
709 * @param {string} event Event to unbind
710 * @param {Function} [callback] Callback to unbind
712 OO
.ui
.Element
.offDOMEvent = function ( el
, event
, callback
) {
714 if ( hasOwn
.call( specialEvents
, event
) ) {
715 // Replace jQuery's override with our own
716 orig
= $.event
.special
[event
];
717 $.event
.special
[event
] = specialEvents
[event
];
719 $( el
).off( event
, callback
);
722 $.event
.special
[event
] = orig
;
724 $( el
).off( event
, callback
);
729 * Embedded iframe with the same styles as its parent.
732 * @extends OO.ui.Element
733 * @mixins OO.EventEmitter
736 * @param {Object} [config] Configuration options
738 OO
.ui
.Frame
= function OoUiFrame( config
) {
739 // Parent constructor
740 OO
.ui
.Frame
.super.call( this, config
);
742 // Mixin constructors
743 OO
.EventEmitter
.call( this );
747 this.config
= config
;
751 .addClass( 'oo-ui-frame' )
752 .attr( { 'frameborder': 0, 'scrolling': 'no' } );
758 OO
.inheritClass( OO
.ui
.Frame
, OO
.ui
.Element
);
759 OO
.mixinClass( OO
.ui
.Frame
, OO
.EventEmitter
);
761 /* Static Properties */
767 OO
.ui
.Frame
.static.tagName
= 'iframe';
778 * Transplant the CSS styles from as parent document to a frame's document.
780 * This loops over the style sheets in the parent document, and copies their nodes to the
781 * frame's document. It then polls the document to see when all styles have loaded, and once they
782 * have, resolves the promise.
784 * If the styles still haven't loaded after a long time (5 seconds by default), we give up waiting
785 * and resolve the promise anyway. This protects against cases like a display: none; iframe in
786 * Firefox, where the styles won't load until the iframe becomes visible.
788 * For details of how we arrived at the strategy used in this function, see #load.
792 * @param {HTMLDocument} parentDoc Document to transplant styles from
793 * @param {HTMLDocument} frameDoc Document to transplant styles to
794 * @param {number} [timeout=5000] How long to wait before giving up (in ms). If 0, never give up.
795 * @return {jQuery.Promise} Promise resolved when styles have loaded
797 OO
.ui
.Frame
.static.transplantStyles = function ( parentDoc
, frameDoc
, timeout
) {
798 var i
, numSheets
, styleNode
, newNode
, timeoutID
, pollNodeId
, $pendingPollNodes
,
799 $pollNodes
= $( [] ),
800 // Fake font-family value
801 fontFamily
= 'oo-ui-frame-transplantStyles-loaded',
802 deferred
= $.Deferred();
804 for ( i
= 0, numSheets
= parentDoc
.styleSheets
.length
; i
< numSheets
; i
++ ) {
805 styleNode
= parentDoc
.styleSheets
[i
].ownerNode
;
806 if ( styleNode
.nodeName
.toLowerCase() === 'link' ) {
807 // External stylesheet
808 // Create a node with a unique ID that we're going to monitor to see when the CSS
810 pollNodeId
= 'oo-ui-frame-transplantStyles-loaded-' + i
;
811 $pollNodes
= $pollNodes
.add( $( '<div>', frameDoc
)
812 .attr( 'id', pollNodeId
)
813 .appendTo( frameDoc
.body
)
816 // Add <style>@import url(...); #pollNodeId { font-family: ... }</style>
817 // The font-family rule will only take effect once the @import finishes
818 newNode
= frameDoc
.createElement( 'style' );
819 newNode
.textContent
= '@import url(' + styleNode
.href
+ ');\n' +
820 '#' + pollNodeId
+ ' { font-family: ' + fontFamily
+ '; }';
822 // Not an external stylesheet, or no polling required; just copy the node over
823 newNode
= frameDoc
.importNode( styleNode
, true );
825 frameDoc
.head
.appendChild( newNode
);
828 // Poll every 100ms until all external stylesheets have loaded
829 $pendingPollNodes
= $pollNodes
;
830 timeoutID
= setTimeout( function pollExternalStylesheets() {
832 $pendingPollNodes
.length
> 0 &&
833 $pendingPollNodes
.eq( 0 ).css( 'font-family' ) === fontFamily
835 $pendingPollNodes
= $pendingPollNodes
.slice( 1 );
838 if ( $pendingPollNodes
.length
=== 0 ) {
840 if ( timeoutID
!== null ) {
846 timeoutID
= setTimeout( pollExternalStylesheets
, 100 );
849 // ...but give up after a while
850 if ( timeout
!== 0 ) {
851 setTimeout( function () {
853 clearTimeout( timeoutID
);
858 }, timeout
|| 5000 );
861 return deferred
.promise();
867 * Load the frame contents.
869 * Once the iframe's stylesheets are loaded, the `load` event will be emitted and the returned
870 * promise will be resolved. Calling while loading will return a promise but not trigger a new
871 * loading cycle. Calling after loading is complete will return a promise that's already been
874 * Sounds simple right? Read on...
876 * When you create a dynamic iframe using open/write/close, the window.load event for the
877 * iframe is triggered when you call close, and there's no further load event to indicate that
878 * everything is actually loaded.
880 * In Chrome, stylesheets don't show up in document.styleSheets until they have loaded, so we could
881 * just poll that array and wait for it to have the right length. However, in Firefox, stylesheets
882 * are added to document.styleSheets immediately, and the only way you can determine whether they've
883 * loaded is to attempt to access .cssRules and wait for that to stop throwing an exception. But
884 * cross-domain stylesheets never allow .cssRules to be accessed even after they have loaded.
886 * The workaround is to change all `<link href="...">` tags to `<style>@import url(...)</style>` tags.
887 * Because `@import` is blocking, Chrome won't add the stylesheet to document.styleSheets until
888 * the `@import` has finished, and Firefox won't allow .cssRules to be accessed until the `@import`
889 * has finished. And because the contents of the `<style>` tag are from the same origin, accessing
890 * .cssRules is allowed.
892 * However, now that we control the styles we're injecting, we might as well do away with
893 * browser-specific polling hacks like document.styleSheets and .cssRules, and instead inject
894 * `<style>@import url(...); #foo { font-family: someValue; }</style>`, then create `<div id="foo">`
895 * and wait for its font-family to change to someValue. Because `@import` is blocking, the font-family
896 * rule is not applied until after the `@import` finishes.
898 * All this stylesheet injection and polling magic is in #transplantStyles.
900 * @return {jQuery.Promise} Promise resolved when loading is complete
903 OO
.ui
.Frame
.prototype.load = function () {
906 // Return existing promise if already loading or loaded
907 if ( this.loading
) {
908 return this.loading
.promise();
912 this.loading
= $.Deferred();
914 win
= this.$element
.prop( 'contentWindow' );
917 // Figure out directionality:
918 this.dir
= OO
.ui
.Element
.getDir( this.$element
) || 'ltr';
920 // Initialize contents
925 '<body class="oo-ui-frame-body oo-ui-' + this.dir
+ '" style="direction:' + this.dir
+ ';" dir="' + this.dir
+ '">' +
926 '<div class="oo-ui-frame-content"></div>' +
933 this.$ = OO
.ui
.Element
.getJQuery( doc
, this );
934 this.$content
= this.$( '.oo-ui-frame-content' ).attr( 'tabIndex', 0 );
935 this.$document
= this.$( doc
);
938 this.constructor.static.transplantStyles( this.getElementDocument(), this.$document
[0] )
939 .always( OO
.ui
.bind( function () {
941 this.loading
.resolve();
944 return this.loading
.promise();
948 * Set the size of the frame.
950 * @param {number} width Frame width in pixels
951 * @param {number} height Frame height in pixels
954 OO
.ui
.Frame
.prototype.setSize = function ( width
, height
) {
955 this.$element
.css( { 'width': width
, 'height': height
} );
959 * Container for elements in a child frame.
961 * There are two ways to specify a title: set the static `title` property or provide a `title`
962 * property in the configuration options. The latter will override the former.
966 * @extends OO.ui.Element
967 * @mixins OO.EventEmitter
970 * @param {Object} [config] Configuration options
971 * @cfg {string|Function} [title] Title string or function that returns a string
972 * @cfg {string} [icon] Symbolic name of icon
975 OO
.ui
.Window
= function OoUiWindow( config
) {
977 // Parent constructor
978 OO
.ui
.Window
.super.call( this, config
);
980 // Mixin constructors
981 OO
.EventEmitter
.call( this );
984 this.visible
= false;
988 this.title
= OO
.ui
.resolveMsg( config
.title
|| this.constructor.static.title
);
989 this.icon
= config
.icon
|| this.constructor.static.icon
;
990 this.frame
= new OO
.ui
.Frame( { '$': this.$ } );
991 this.$frame
= this.$( '<div>' );
992 this.$ = function () {
993 throw new Error( 'this.$() cannot be used until the frame has been initialized.' );
998 .addClass( 'oo-ui-window' )
999 // Hide the window using visibility: hidden; while the iframe is still loading
1000 // Can't use display: none; because that prevents the iframe from loading in Firefox
1001 .css( 'visibility', 'hidden' )
1002 .append( this.$frame
);
1004 .addClass( 'oo-ui-window-frame' )
1005 .append( this.frame
.$element
);
1008 this.frame
.on( 'load', function () {
1009 element
.initialize();
1010 // Undo the visibility: hidden; hack and apply display: none;
1011 // We can do this safely now that the iframe has initialized
1012 // (don't do this from within #initialize because it has to happen
1013 // after the all subclasses have been handled as well).
1014 element
.$element
.hide().css( 'visibility', '' );
1020 OO
.inheritClass( OO
.ui
.Window
, OO
.ui
.Element
);
1021 OO
.mixinClass( OO
.ui
.Window
, OO
.EventEmitter
);
1028 * Fired after window has been opened.
1031 * @param {Object} data Window opening data
1037 * Fired after window has been closed.
1040 * @param {Object} data Window closing data
1043 /* Static Properties */
1046 * Symbolic name of icon.
1050 * @property {string}
1052 OO
.ui
.Window
.static.icon
= 'window';
1057 * Subclasses must implement this property before instantiating the window.
1058 * Alternatively, override #getTitle with an alternative implementation.
1063 * @property {string|Function} Title string or function that returns a string
1065 OO
.ui
.Window
.static.title
= null;
1070 * Check if window is visible.
1072 * @return {boolean} Window is visible
1074 OO
.ui
.Window
.prototype.isVisible = function () {
1075 return this.visible
;
1079 * Check if window is opening.
1081 * @return {boolean} Window is opening
1083 OO
.ui
.Window
.prototype.isOpening = function () {
1084 return !!this.opening
&& !this.opening
.isResolved();
1088 * Check if window is closing.
1090 * @return {boolean} Window is closing
1092 OO
.ui
.Window
.prototype.isClosing = function () {
1093 return !!this.closing
&& !this.closing
.isResolved();
1097 * Check if window is opened.
1099 * @return {boolean} Window is opened
1101 OO
.ui
.Window
.prototype.isOpened = function () {
1102 return !!this.opened
&& !this.opened
.isResolved();
1106 * Get the window frame.
1108 * @return {OO.ui.Frame} Frame of window
1110 OO
.ui
.Window
.prototype.getFrame = function () {
1115 * Get the title of the window.
1117 * @return {string} Title text
1119 OO
.ui
.Window
.prototype.getTitle = function () {
1124 * Get the window icon.
1126 * @return {string} Symbolic name of icon
1128 OO
.ui
.Window
.prototype.getIcon = function () {
1133 * Set the size of window frame.
1135 * @param {number} [width=auto] Custom width
1136 * @param {number} [height=auto] Custom height
1139 OO
.ui
.Window
.prototype.setSize = function ( width
, height
) {
1140 if ( !this.frame
.$content
) {
1144 this.frame
.$element
.css( {
1145 'width': width
=== undefined ? 'auto' : width
,
1146 'height': height
=== undefined ? 'auto' : height
1153 * Set the title of the window.
1155 * @param {string|Function} title Title text or a function that returns text
1158 OO
.ui
.Window
.prototype.setTitle = function ( title
) {
1159 this.title
= OO
.ui
.resolveMsg( title
);
1160 if ( this.$title
) {
1161 this.$title
.text( title
);
1167 * Set the icon of the window.
1169 * @param {string} icon Symbolic name of icon
1172 OO
.ui
.Window
.prototype.setIcon = function ( icon
) {
1174 this.$icon
.removeClass( 'oo-ui-icon-' + this.icon
);
1178 this.$icon
.addClass( 'oo-ui-icon-' + this.icon
);
1185 * Set the position of window to fit with contents.
1187 * @param {string} left Left offset
1188 * @param {string} top Top offset
1191 OO
.ui
.Window
.prototype.setPosition = function ( left
, top
) {
1192 this.$element
.css( { 'left': left
, 'top': top
} );
1197 * Set the height of window to fit with contents.
1199 * @param {number} [min=0] Min height
1200 * @param {number} [max] Max height (defaults to content's outer height)
1203 OO
.ui
.Window
.prototype.fitHeightToContents = function ( min
, max
) {
1204 var height
= this.frame
.$content
.outerHeight();
1206 this.frame
.$element
.css(
1207 'height', Math
.max( min
|| 0, max
=== undefined ? height
: Math
.min( max
, height
) )
1214 * Set the width of window to fit with contents.
1216 * @param {number} [min=0] Min height
1217 * @param {number} [max] Max height (defaults to content's outer width)
1220 OO
.ui
.Window
.prototype.fitWidthToContents = function ( min
, max
) {
1221 var width
= this.frame
.$content
.outerWidth();
1223 this.frame
.$element
.css(
1224 'width', Math
.max( min
|| 0, max
=== undefined ? width
: Math
.min( max
, width
) )
1231 * Initialize window contents.
1233 * The first time the window is opened, #initialize is called when it's safe to begin populating
1234 * its contents. See #setup for a way to make changes each time the window opens.
1236 * Once this method is called, this.$$ can be used to create elements within the frame.
1240 OO
.ui
.Window
.prototype.initialize = function () {
1242 this.$ = this.frame
.$;
1243 this.$title
= this.$( '<div class="oo-ui-window-title"></div>' )
1244 .text( this.title
);
1245 this.$icon
= this.$( '<div class="oo-ui-window-icon"></div>' )
1246 .addClass( 'oo-ui-icon-' + this.icon
);
1247 this.$head
= this.$( '<div class="oo-ui-window-head"></div>' );
1248 this.$body
= this.$( '<div class="oo-ui-window-body"></div>' );
1249 this.$foot
= this.$( '<div class="oo-ui-window-foot"></div>' );
1250 this.$overlay
= this.$( '<div class="oo-ui-window-overlay"></div>' );
1253 this.frame
.$content
.append(
1254 this.$head
.append( this.$icon
, this.$title
),
1264 * Get a process for setting up a window for use.
1266 * Each time the window is opened this process will set it up for use in a particular context, based
1267 * on the `data` argument.
1269 * When you override this method, you can add additional setup steps to the process the parent
1270 * method provides using the 'first' and 'next' methods.
1273 * @param {Object} [data] Window opening data
1274 * @return {OO.ui.Process} Setup process
1276 OO
.ui
.Window
.prototype.getSetupProcess = function () {
1277 return new OO
.ui
.Process();
1281 * Get a process for readying a window for use.
1283 * Each time the window is open and setup, this process will ready it up for use in a particular
1284 * context, based on the `data` argument.
1286 * When you override this method, you can add additional setup steps to the process the parent
1287 * method provides using the 'first' and 'next' methods.
1290 * @param {Object} [data] Window opening data
1291 * @return {OO.ui.Process} Setup process
1293 OO
.ui
.Window
.prototype.getReadyProcess = function () {
1294 return new OO
.ui
.Process();
1298 * Get a process for tearing down a window after use.
1300 * Each time the window is closed this process will tear it down and do something with the user's
1301 * interactions within the window, based on the `data` argument.
1303 * When you override this method, you can add additional teardown steps to the process the parent
1304 * method provides using the 'first' and 'next' methods.
1307 * @param {Object} [data] Window closing data
1308 * @return {OO.ui.Process} Teardown process
1310 OO
.ui
.Window
.prototype.getTeardownProcess = function () {
1311 return new OO
.ui
.Process();
1317 * Do not override this method. Use #geSetupProcess to do something each time the window closes.
1319 * @param {Object} [data] Window opening data
1324 * @return {jQuery.Promise} Promise resolved when window is opened; when the promise is resolved the
1325 * first argument will be a promise which will be resolved when the window begins closing
1327 OO
.ui
.Window
.prototype.open = function ( data
) {
1328 // Return existing promise if already opening or open
1329 if ( this.opening
) {
1330 return this.opening
.promise();
1334 this.opening
= $.Deferred();
1335 this.frame
.load().done( OO
.ui
.bind( function () {
1336 this.$element
.show();
1337 this.visible
= true;
1338 this.emit( 'opening', data
);
1339 this.getSetupProcess( data
).execute().done( OO
.ui
.bind( function () {
1340 this.emit( 'open', data
);
1341 setTimeout( OO
.ui
.bind( function () {
1342 // Focus the content div (which has a tabIndex) to inactivate
1343 // (but not clear) selections in the parent frame.
1344 // Must happen after 'open' is emitted (to ensure it is visible)
1345 // but before 'ready' is emitted (so subclasses can give focus to something
1347 this.frame
.$content
.focus();
1348 this.getReadyProcess( data
).execute().done( OO
.ui
.bind( function () {
1349 this.emit( 'ready', data
);
1350 this.opened
= $.Deferred();
1351 this.opening
.resolve( this.opened
.promise() );
1352 // Now that we are totally done opening, it's safe to allow closing
1353 this.closing
= null;
1359 return this.opening
.promise();
1365 * Do not override this method. Use #getTeardownProcess to do something each time the window closes.
1367 * @param {Object} [data] Window closing data
1370 * @return {jQuery.Promise} Promise resolved when window is closed
1372 OO
.ui
.Window
.prototype.close = function ( data
) {
1373 // Return existing promise if already closing or closed
1374 if ( this.closing
) {
1375 return this.closing
.promise();
1379 this.opened
.resolve();
1380 // This.closing needs to exist before we emit the closing event so that handlers can call
1381 // window.close() and trigger the safety check above
1382 this.closing
= $.Deferred();
1383 this.frame
.$content
.find( ':focus' ).blur();
1384 this.emit( 'closing', data
);
1385 this.getTeardownProcess( data
).execute().done( OO
.ui
.bind( function () {
1386 this.emit( 'close', data
);
1387 this.$element
.hide();
1388 this.visible
= false;
1389 this.closing
.resolve();
1390 // Now that we are totally done closing, it's safe to allow opening
1391 this.opening
= null;
1394 return this.closing
.promise();
1397 * Set of mutually exclusive windows.
1400 * @extends OO.ui.Element
1401 * @mixins OO.EventEmitter
1404 * @param {OO.Factory} factory Window factory
1405 * @param {Object} [config] Configuration options
1407 OO
.ui
.WindowSet
= function OoUiWindowSet( factory
, config
) {
1408 // Parent constructor
1409 OO
.ui
.WindowSet
.super.call( this, config
);
1411 // Mixin constructors
1412 OO
.EventEmitter
.call( this );
1415 this.factory
= factory
;
1418 * List of all windows associated with this window set.
1420 * @property {OO.ui.Window[]}
1422 this.windowList
= [];
1425 * Mapping of OO.ui.Window objects created by name from the #factory.
1427 * @property {Object}
1430 this.currentWindow
= null;
1433 this.$element
.addClass( 'oo-ui-windowSet' );
1438 OO
.inheritClass( OO
.ui
.WindowSet
, OO
.ui
.Element
);
1439 OO
.mixinClass( OO
.ui
.WindowSet
, OO
.EventEmitter
);
1445 * @param {OO.ui.Window} win Window that's being opened
1446 * @param {Object} config Window opening information
1451 * @param {OO.ui.Window} win Window that's been opened
1452 * @param {Object} config Window opening information
1457 * @param {OO.ui.Window} win Window that's being closed
1458 * @param {Object} config Window closing information
1463 * @param {OO.ui.Window} win Window that's been closed
1464 * @param {Object} config Window closing information
1470 * Handle a window that's being opened.
1472 * @param {OO.ui.Window} win Window that's being opened
1473 * @param {Object} [config] Window opening information
1476 OO
.ui
.WindowSet
.prototype.onWindowOpening = function ( win
, config
) {
1477 if ( this.currentWindow
&& this.currentWindow
!== win
) {
1478 this.currentWindow
.close();
1480 this.currentWindow
= win
;
1481 this.emit( 'opening', win
, config
);
1485 * Handle a window that's been opened.
1487 * @param {OO.ui.Window} win Window that's been opened
1488 * @param {Object} [config] Window opening information
1491 OO
.ui
.WindowSet
.prototype.onWindowOpen = function ( win
, config
) {
1492 this.emit( 'open', win
, config
);
1496 * Handle a window that's being closed.
1498 * @param {OO.ui.Window} win Window that's being closed
1499 * @param {Object} [config] Window closing information
1502 OO
.ui
.WindowSet
.prototype.onWindowClosing = function ( win
, config
) {
1503 this.currentWindow
= null;
1504 this.emit( 'closing', win
, config
);
1508 * Handle a window that's been closed.
1510 * @param {OO.ui.Window} win Window that's been closed
1511 * @param {Object} [config] Window closing information
1514 OO
.ui
.WindowSet
.prototype.onWindowClose = function ( win
, config
) {
1515 this.emit( 'close', win
, config
);
1519 * Get the current window.
1521 * @return {OO.ui.Window|null} Current window or null if none open
1523 OO
.ui
.WindowSet
.prototype.getCurrentWindow = function () {
1524 return this.currentWindow
;
1528 * Return a given window.
1530 * @param {string} name Symbolic name of window
1531 * @return {OO.ui.Window} Window with specified name
1533 OO
.ui
.WindowSet
.prototype.getWindow = function ( name
) {
1536 if ( !this.factory
.lookup( name
) ) {
1537 throw new Error( 'Unknown window: ' + name
);
1539 if ( !( name
in this.windows
) ) {
1540 win
= this.windows
[name
] = this.createWindow( name
);
1541 this.addWindow( win
);
1543 return this.windows
[name
];
1547 * Create a window for use in this window set.
1549 * @param {string} name Symbolic name of window
1550 * @return {OO.ui.Window} Window with specified name
1552 OO
.ui
.WindowSet
.prototype.createWindow = function ( name
) {
1553 return this.factory
.create( name
, { '$': this.$ } );
1557 * Add a given window to this window set.
1559 * Connects event handlers and attaches it to the DOM. Calling
1560 * OO.ui.Window#open will not work until the window is added to the set.
1562 * @param {OO.ui.Window} win
1564 OO
.ui
.WindowSet
.prototype.addWindow = function ( win
) {
1565 if ( this.windowList
.indexOf( win
) !== -1 ) {
1569 this.windowList
.push( win
);
1571 win
.connect( this, {
1572 'opening': [ 'onWindowOpening', win
],
1573 'open': [ 'onWindowOpen', win
],
1574 'closing': [ 'onWindowClosing', win
],
1575 'close': [ 'onWindowClose', win
]
1577 this.$element
.append( win
.$element
);
1580 * Modal dialog window.
1584 * @extends OO.ui.Window
1587 * @param {Object} [config] Configuration options
1588 * @cfg {boolean} [footless] Hide foot
1589 * @cfg {string} [size='large'] Symbolic name of dialog size, `small`, `medium` or `large`
1591 OO
.ui
.Dialog
= function OoUiDialog( config
) {
1592 // Configuration initialization
1593 config
= $.extend( { 'size': 'large' }, config
);
1595 // Parent constructor
1596 OO
.ui
.Dialog
.super.call( this, config
);
1599 this.visible
= false;
1600 this.footless
= !!config
.footless
;
1603 this.onWindowMouseWheelHandler
= OO
.ui
.bind( this.onWindowMouseWheel
, this );
1604 this.onDocumentKeyDownHandler
= OO
.ui
.bind( this.onDocumentKeyDown
, this );
1607 this.$element
.on( 'mousedown', false );
1608 this.connect( this, { 'open': 'onOpen' } );
1611 this.$element
.addClass( 'oo-ui-dialog' );
1612 this.setSize( config
.size
);
1617 OO
.inheritClass( OO
.ui
.Dialog
, OO
.ui
.Window
);
1619 /* Static Properties */
1622 * Symbolic name of dialog.
1627 * @property {string}
1629 OO
.ui
.Dialog
.static.name
= '';
1632 * Map of symbolic size names and CSS classes.
1636 * @property {Object}
1638 OO
.ui
.Dialog
.static.sizeCssClasses
= {
1639 'small': 'oo-ui-dialog-small',
1640 'medium': 'oo-ui-dialog-medium',
1641 'large': 'oo-ui-dialog-large'
1647 * Handle close button click events.
1649 OO
.ui
.Dialog
.prototype.onCloseButtonClick = function () {
1650 this.close( { 'action': 'cancel' } );
1654 * Handle window mouse wheel events.
1656 * @param {jQuery.Event} e Mouse wheel event
1658 OO
.ui
.Dialog
.prototype.onWindowMouseWheel = function () {
1663 * Handle document key down events.
1665 * @param {jQuery.Event} e Key down event
1667 OO
.ui
.Dialog
.prototype.onDocumentKeyDown = function ( e
) {
1668 switch ( e
.which
) {
1669 case OO
.ui
.Keys
.PAGEUP
:
1670 case OO
.ui
.Keys
.PAGEDOWN
:
1671 case OO
.ui
.Keys
.END
:
1672 case OO
.ui
.Keys
.HOME
:
1673 case OO
.ui
.Keys
.LEFT
:
1675 case OO
.ui
.Keys
.RIGHT
:
1676 case OO
.ui
.Keys
.DOWN
:
1677 // Prevent any key events that might cause scrolling
1683 * Handle frame document key down events.
1685 * @param {jQuery.Event} e Key down event
1687 OO
.ui
.Dialog
.prototype.onFrameDocumentKeyDown = function ( e
) {
1688 if ( e
.which
=== OO
.ui
.Keys
.ESCAPE
) {
1689 this.close( { 'action': 'cancel' } );
1695 * Handle window open events.
1697 OO
.ui
.Dialog
.prototype.onOpen = function () {
1698 this.$element
.addClass( 'oo-ui-dialog-open' );
1704 * @param {string} [size='large'] Symbolic name of dialog size, `small`, `medium` or `large`
1706 OO
.ui
.Dialog
.prototype.setSize = function ( size
) {
1707 var name
, state
, cssClass
,
1708 sizeCssClasses
= OO
.ui
.Dialog
.static.sizeCssClasses
;
1710 if ( !sizeCssClasses
[size
] ) {
1714 for ( name
in sizeCssClasses
) {
1715 state
= name
=== size
;
1716 cssClass
= sizeCssClasses
[name
];
1717 this.$element
.toggleClass( cssClass
, state
);
1718 if ( this.frame
.$content
) {
1719 this.frame
.$content
.toggleClass( cssClass
, state
);
1727 OO
.ui
.Dialog
.prototype.initialize = function () {
1729 OO
.ui
.Dialog
.super.prototype.initialize
.call( this );
1732 this.closeButton
= new OO
.ui
.ButtonWidget( {
1736 'title': OO
.ui
.msg( 'ooui-dialog-action-close' )
1740 this.closeButton
.connect( this, { 'click': 'onCloseButtonClick' } );
1741 this.frame
.$document
.on( 'keydown', OO
.ui
.bind( this.onFrameDocumentKeyDown
, this ) );
1744 this.frame
.$content
.addClass( 'oo-ui-dialog-content' );
1745 if ( this.footless
) {
1746 this.frame
.$content
.addClass( 'oo-ui-dialog-content-footless' );
1748 this.closeButton
.$element
.addClass( 'oo-ui-window-closeButton' );
1749 this.$head
.append( this.closeButton
.$element
);
1755 OO
.ui
.Dialog
.prototype.getSetupProcess = function ( data
) {
1756 return OO
.ui
.Dialog
.super.prototype.getSetupProcess
.call( this, data
)
1757 .next( function () {
1758 // Prevent scrolling in top-level window
1759 this.$( window
).on( 'mousewheel', this.onWindowMouseWheelHandler
);
1760 this.$( document
).on( 'keydown', this.onDocumentKeyDownHandler
);
1767 OO
.ui
.Dialog
.prototype.getTeardownProcess = function ( data
) {
1768 return OO
.ui
.Dialog
.super.prototype.getTeardownProcess
.call( this, data
)
1769 .first( function () {
1770 this.$element
.removeClass( 'oo-ui-dialog-open' );
1771 return OO
.ui
.Process
.static.delay( 250 );
1773 .next( function () {
1774 // Allow scrolling in top-level window
1775 this.$( window
).off( 'mousewheel', this.onWindowMouseWheelHandler
);
1776 this.$( document
).off( 'keydown', this.onDocumentKeyDownHandler
);
1781 * Check if input is pending.
1785 OO
.ui
.Dialog
.prototype.isPending = function () {
1786 return !!this.pending
;
1790 * Increase the pending stack.
1794 OO
.ui
.Dialog
.prototype.pushPending = function () {
1795 if ( this.pending
=== 0 ) {
1796 this.frame
.$content
.addClass( 'oo-ui-dialog-pending' );
1797 this.$head
.addClass( 'oo-ui-texture-pending' );
1798 this.$foot
.addClass( 'oo-ui-texture-pending' );
1806 * Reduce the pending stack.
1812 OO
.ui
.Dialog
.prototype.popPending = function () {
1813 if ( this.pending
=== 1 ) {
1814 this.frame
.$content
.removeClass( 'oo-ui-dialog-pending' );
1815 this.$head
.removeClass( 'oo-ui-texture-pending' );
1816 this.$foot
.removeClass( 'oo-ui-texture-pending' );
1818 this.pending
= Math
.max( 0, this.pending
- 1 );
1823 * Container for elements.
1827 * @extends OO.ui.Element
1828 * @mixins OO.EventEmitter
1831 * @param {Object} [config] Configuration options
1833 OO
.ui
.Layout
= function OoUiLayout( config
) {
1834 // Initialize config
1835 config
= config
|| {};
1837 // Parent constructor
1838 OO
.ui
.Layout
.super.call( this, config
);
1840 // Mixin constructors
1841 OO
.EventEmitter
.call( this );
1844 this.$element
.addClass( 'oo-ui-layout' );
1849 OO
.inheritClass( OO
.ui
.Layout
, OO
.ui
.Element
);
1850 OO
.mixinClass( OO
.ui
.Layout
, OO
.EventEmitter
);
1852 * User interface control.
1856 * @extends OO.ui.Element
1857 * @mixins OO.EventEmitter
1860 * @param {Object} [config] Configuration options
1861 * @cfg {boolean} [disabled=false] Disable
1863 OO
.ui
.Widget
= function OoUiWidget( config
) {
1864 // Initialize config
1865 config
= $.extend( { 'disabled': false }, config
);
1867 // Parent constructor
1868 OO
.ui
.Widget
.super.call( this, config
);
1870 // Mixin constructors
1871 OO
.EventEmitter
.call( this );
1874 this.disabled
= null;
1875 this.wasDisabled
= null;
1878 this.$element
.addClass( 'oo-ui-widget' );
1879 this.setDisabled( !!config
.disabled
);
1884 OO
.inheritClass( OO
.ui
.Widget
, OO
.ui
.Element
);
1885 OO
.mixinClass( OO
.ui
.Widget
, OO
.EventEmitter
);
1891 * @param {boolean} disabled Widget is disabled
1897 * Check if the widget is disabled.
1899 * @param {boolean} Button is disabled
1901 OO
.ui
.Widget
.prototype.isDisabled = function () {
1902 return this.disabled
;
1906 * Update the disabled state, in case of changes in parent widget.
1910 OO
.ui
.Widget
.prototype.updateDisabled = function () {
1911 this.setDisabled( this.disabled
);
1916 * Set the disabled state of the widget.
1918 * This should probably change the widgets' appearance and prevent it from being used.
1920 * @param {boolean} disabled Disable widget
1923 OO
.ui
.Widget
.prototype.setDisabled = function ( disabled
) {
1926 this.disabled
= !!disabled
;
1927 isDisabled
= this.isDisabled();
1928 if ( isDisabled
!== this.wasDisabled
) {
1929 this.$element
.toggleClass( 'oo-ui-widget-disabled', isDisabled
);
1930 this.$element
.toggleClass( 'oo-ui-widget-enabled', !isDisabled
);
1931 this.emit( 'disable', isDisabled
);
1933 this.wasDisabled
= isDisabled
;
1937 * A list of functions, called in sequence.
1939 * If a function added to a process returns boolean false the process will stop; if it returns an
1940 * object with a `promise` method the process will use the promise to either continue to the next
1941 * step when the promise is resolved or stop when the promise is rejected.
1947 OO
.ui
.Process = function () {
1954 OO
.initClass( OO
.ui
.Process
);
1956 /* Static Methods */
1959 * Generate a promise which is resolved after a set amount of time.
1961 * @param {number} length Number of milliseconds before resolving the promise
1962 * @return {jQuery.Promise} Promise that will be resolved after a set amount of time
1964 OO
.ui
.Process
.static.delay = function ( length
) {
1965 var deferred
= $.Deferred();
1967 setTimeout( function () {
1971 return deferred
.promise();
1977 * Start the process.
1979 * @return {jQuery.Promise} Promise that is resolved when all steps have completed or rejected when
1980 * any of the steps return boolean false or a promise which gets rejected; upon stopping the
1981 * process, the remaining steps will not be taken
1983 OO
.ui
.Process
.prototype.execute = function () {
1984 var i
, len
, promise
;
1987 * Continue execution.
1990 * @param {Array} step A function and the context it should be called in
1991 * @return {Function} Function that continues the process
1993 function proceed( step
) {
1994 return function () {
1995 // Execute step in the correct context
1996 var result
= step
[0].call( step
[1] );
1998 if ( result
=== false ) {
1999 // Use rejected promise for boolean false results
2000 return $.Deferred().reject().promise();
2002 // Duck-type the object to see if it can produce a promise
2003 if ( result
&& $.isFunction( result
.promise
) ) {
2004 // Use a promise generated from the result
2005 return result
.promise();
2007 // Use resolved promise for other results
2008 return $.Deferred().resolve().promise();
2012 if ( this.steps
.length
) {
2013 // Generate a chain reaction of promises
2014 promise
= proceed( this.steps
[0] )();
2015 for ( i
= 1, len
= this.steps
.length
; i
< len
; i
++ ) {
2016 promise
= promise
.then( proceed( this.steps
[i
] ) );
2019 promise
= $.Deferred().resolve().promise();
2026 * Add step to the beginning of the process.
2028 * @param {Function} step Function to execute; if it returns boolean false the process will stop; if
2029 * it returns an object with a `promise` method the process will use the promise to either
2030 * continue to the next step when the promise is resolved or stop when the promise is rejected
2031 * @param {Object} [context=null] Context to call the step function in
2034 OO
.ui
.Process
.prototype.first = function ( step
, context
) {
2035 this.steps
.unshift( [ step
, context
|| null ] );
2040 * Add step to the end of the process.
2042 * @param {Function} step Function to execute; if it returns boolean false the process will stop; if
2043 * it returns an object with a `promise` method the process will use the promise to either
2044 * continue to the next step when the promise is resolved or stop when the promise is rejected
2045 * @param {Object} [context=null] Context to call the step function in
2048 OO
.ui
.Process
.prototype.next = function ( step
, context
) {
2049 this.steps
.push( [ step
, context
|| null ] );
2053 * Dialog for showing a confirmation/warning message.
2056 * @extends OO.ui.Dialog
2059 * @param {Object} [config] Configuration options
2061 OO
.ui
.ConfirmationDialog
= function OoUiConfirmationDialog( config
) {
2062 // Configuration initialization
2063 config
= $.extend( { 'size': 'small' }, config
);
2065 // Parent constructor
2066 OO
.ui
.Dialog
.call( this, config
);
2071 OO
.inheritClass( OO
.ui
.ConfirmationDialog
, OO
.ui
.Dialog
);
2073 /* Static Properties */
2075 OO
.ui
.ConfirmationDialog
.static.name
= 'confirm';
2077 OO
.ui
.ConfirmationDialog
.static.icon
= 'help';
2079 OO
.ui
.ConfirmationDialog
.static.title
= OO
.ui
.deferMsg( 'ooui-dialog-confirm-title' );
2086 OO
.ui
.ConfirmationDialog
.prototype.initialize = function () {
2088 OO
.ui
.Dialog
.prototype.initialize
.call( this );
2090 // Set up the layout
2091 var contentLayout
= new OO
.ui
.PanelLayout( {
2096 this.$promptContainer
= this.$( '<div>' ).addClass( 'oo-ui-dialog-confirm-promptContainer' );
2098 this.cancelButton
= new OO
.ui
.ButtonWidget();
2099 this.cancelButton
.connect( this, { 'click': [ 'emit', 'done', 'cancel' ] } );
2101 this.okButton
= new OO
.ui
.ButtonWidget();
2102 this.okButton
.connect( this, { 'click': [ 'emit', 'done', 'ok' ] } );
2105 contentLayout
.$element
.append( this.$promptContainer
);
2106 this.$body
.append( contentLayout
.$element
);
2109 this.okButton
.$element
,
2110 this.cancelButton
.$element
2113 this.connect( this, {
2115 'close': [ 'emit', 'cancel' ]
2120 * Open a confirmation dialog.
2122 * @param {Object} [data] Window opening data including text of the dialog and text for the buttons
2123 * @param {jQuery|string} [data.prompt] Text to display or list of nodes to use as content of the dialog.
2124 * @param {jQuery|string|Function|null} [data.okLabel] Label of the OK button
2125 * @param {jQuery|string|Function|null} [data.cancelLabel] Label of the cancel button
2126 * @param {string|string[]} [data.okFlags="constructive"] Flags for the OK button
2127 * @param {string|string[]} [data.cancelFlags="destructive"] Flags for the cancel button
2129 OO
.ui
.ConfirmationDialog
.prototype.setup = function ( data
) {
2131 OO
.ui
.Dialog
.prototype.setup
.call( this, data
);
2133 var prompt
= data
.prompt
|| OO
.ui
.deferMsg( 'ooui-dialog-confirm-default-prompt' ),
2134 okLabel
= data
.okLabel
|| OO
.ui
.deferMsg( 'ooui-dialog-confirm-default-ok' ),
2135 cancelLabel
= data
.cancelLabel
|| OO
.ui
.deferMsg( 'ooui-dialog-confirm-default-cancel' ),
2136 okFlags
= data
.okFlags
|| 'constructive',
2137 cancelFlags
= data
.cancelFlags
|| 'destructive';
2139 if ( typeof prompt
=== 'string' ) {
2140 this.$promptContainer
.text( prompt
);
2142 this.$promptContainer
.empty().append( prompt
);
2145 this.okButton
.setLabel( okLabel
).clearFlags().setFlags( okFlags
);
2146 this.cancelButton
.setLabel( cancelLabel
).clearFlags().setFlags( cancelFlags
);
2149 * Element with a button.
2155 * @param {jQuery} $button Button node, assigned to #$button
2156 * @param {Object} [config] Configuration options
2157 * @cfg {boolean} [frameless] Render button without a frame
2158 * @cfg {number} [tabIndex=0] Button's tab index, use -1 to prevent tab focusing
2160 OO
.ui
.ButtonedElement
= function OoUiButtonedElement( $button
, config
) {
2161 // Configuration initialization
2162 config
= config
|| {};
2165 this.$button
= $button
;
2166 this.tabIndex
= null;
2167 this.active
= false;
2168 this.onMouseUpHandler
= OO
.ui
.bind( this.onMouseUp
, this );
2171 this.$button
.on( 'mousedown', OO
.ui
.bind( this.onMouseDown
, this ) );
2174 this.$element
.addClass( 'oo-ui-buttonedElement' );
2176 .addClass( 'oo-ui-buttonedElement-button' )
2177 .attr( 'role', 'button' )
2178 .prop( 'tabIndex', config
.tabIndex
|| 0 );
2179 if ( config
.frameless
) {
2180 this.$element
.addClass( 'oo-ui-buttonedElement-frameless' );
2182 this.$element
.addClass( 'oo-ui-buttonedElement-framed' );
2188 OO
.initClass( OO
.ui
.ButtonedElement
);
2190 /* Static Properties */
2193 * Cancel mouse down events.
2197 * @property {boolean}
2199 OO
.ui
.ButtonedElement
.static.cancelButtonMouseDownEvents
= true;
2204 * Handles mouse down events.
2206 * @param {jQuery.Event} e Mouse down event
2208 OO
.ui
.ButtonedElement
.prototype.onMouseDown = function ( e
) {
2209 if ( this.isDisabled() || e
.which
!== 1 ) {
2212 // tabIndex should generally be interacted with via the property, but it's not possible to
2213 // reliably unset a tabIndex via a property so we use the (lowercase) "tabindex" attribute
2214 this.tabIndex
= this.$button
.attr( 'tabindex' );
2216 // Remove the tab-index while the button is down to prevent the button from stealing focus
2217 .removeAttr( 'tabindex' )
2218 .addClass( 'oo-ui-buttonedElement-pressed' );
2219 // Run the mouseup handler no matter where the mouse is when the button is let go, so we can
2220 // reliably reapply the tabindex and remove the pressed class
2221 this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler
, true );
2222 // Prevent change of focus unless specifically configured otherwise
2223 if ( this.constructor.static.cancelButtonMouseDownEvents
) {
2229 * Handles mouse up events.
2231 * @param {jQuery.Event} e Mouse up event
2233 OO
.ui
.ButtonedElement
.prototype.onMouseUp = function ( e
) {
2234 if ( this.isDisabled() || e
.which
!== 1 ) {
2238 // Restore the tab-index after the button is up to restore the button's accesssibility
2239 .attr( 'tabindex', this.tabIndex
)
2240 .removeClass( 'oo-ui-buttonedElement-pressed' );
2241 // Stop listening for mouseup, since we only needed this once
2242 this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler
, true );
2248 * @param {boolean} [value] Make button active
2251 OO
.ui
.ButtonedElement
.prototype.setActive = function ( value
) {
2252 this.$button
.toggleClass( 'oo-ui-buttonedElement-active', !!value
);
2256 * Element that can be automatically clipped to visible boundaies.
2262 * @param {jQuery} $clippable Nodes to clip, assigned to #$clippable
2263 * @param {Object} [config] Configuration options
2265 OO
.ui
.ClippableElement
= function OoUiClippableElement( $clippable
, config
) {
2266 // Configuration initialization
2267 config
= config
|| {};
2270 this.$clippable
= $clippable
;
2271 this.clipping
= false;
2272 this.clipped
= false;
2273 this.$clippableContainer
= null;
2274 this.$clippableScroller
= null;
2275 this.$clippableWindow
= null;
2276 this.idealWidth
= null;
2277 this.idealHeight
= null;
2278 this.onClippableContainerScrollHandler
= OO
.ui
.bind( this.clip
, this );
2279 this.onClippableWindowResizeHandler
= OO
.ui
.bind( this.clip
, this );
2282 this.$clippable
.addClass( 'oo-ui-clippableElement-clippable' );
2290 * @param {boolean} value Enable clipping
2293 OO
.ui
.ClippableElement
.prototype.setClipping = function ( value
) {
2296 if ( this.clipping
!== value
) {
2297 this.clipping
= value
;
2298 if ( this.clipping
) {
2299 this.$clippableContainer
= this.$( this.getClosestScrollableElementContainer() );
2300 // If the clippable container is the body, we have to listen to scroll events and check
2301 // jQuery.scrollTop on the window because of browser inconsistencies
2302 this.$clippableScroller
= this.$clippableContainer
.is( 'body' ) ?
2303 this.$( OO
.ui
.Element
.getWindow( this.$clippableContainer
) ) :
2304 this.$clippableContainer
;
2305 this.$clippableScroller
.on( 'scroll', this.onClippableContainerScrollHandler
);
2306 this.$clippableWindow
= this.$( this.getElementWindow() )
2307 .on( 'resize', this.onClippableWindowResizeHandler
);
2308 // Initial clip after visible
2309 setTimeout( OO
.ui
.bind( this.clip
, this ) );
2311 this.$clippableContainer
= null;
2312 this.$clippableScroller
.off( 'scroll', this.onClippableContainerScrollHandler
);
2313 this.$clippableScroller
= null;
2314 this.$clippableWindow
.off( 'resize', this.onClippableWindowResizeHandler
);
2315 this.$clippableWindow
= null;
2323 * Check if the element will be clipped to fit the visible area of the nearest scrollable container.
2325 * @return {boolean} Element will be clipped to the visible area
2327 OO
.ui
.ClippableElement
.prototype.isClipping = function () {
2328 return this.clipping
;
2332 * Check if the bottom or right of the element is being clipped by the nearest scrollable container.
2334 * @return {boolean} Part of the element is being clipped
2336 OO
.ui
.ClippableElement
.prototype.isClipped = function () {
2337 return this.clipped
;
2341 * Set the ideal size.
2343 * @param {number|string} [width] Width as a number of pixels or CSS string with unit suffix
2344 * @param {number|string} [height] Height as a number of pixels or CSS string with unit suffix
2346 OO
.ui
.ClippableElement
.prototype.setIdealSize = function ( width
, height
) {
2347 this.idealWidth
= width
;
2348 this.idealHeight
= height
;
2352 * Clip element to visible boundaries and allow scrolling when needed.
2354 * Element will be clipped the bottom or right of the element is within 10px of the edge of, or
2355 * overlapped by, the visible area of the nearest scrollable container.
2359 OO
.ui
.ClippableElement
.prototype.clip = function () {
2360 if ( !this.clipping
) {
2361 // this.$clippableContainer and this.$clippableWindow are null, so the below will fail
2366 cOffset
= this.$clippable
.offset(),
2367 ccOffset
= this.$clippableContainer
.offset() || { 'top': 0, 'left': 0 },
2368 ccHeight
= this.$clippableContainer
.innerHeight() - buffer
,
2369 ccWidth
= this.$clippableContainer
.innerWidth() - buffer
,
2370 scrollTop
= this.$clippableScroller
.scrollTop(),
2371 scrollLeft
= this.$clippableScroller
.scrollLeft(),
2372 desiredWidth
= ( ccOffset
.left
+ scrollLeft
+ ccWidth
) - cOffset
.left
,
2373 desiredHeight
= ( ccOffset
.top
+ scrollTop
+ ccHeight
) - cOffset
.top
,
2374 naturalWidth
= this.$clippable
.prop( 'scrollWidth' ),
2375 naturalHeight
= this.$clippable
.prop( 'scrollHeight' ),
2376 clipWidth
= desiredWidth
< naturalWidth
,
2377 clipHeight
= desiredHeight
< naturalHeight
;
2380 this.$clippable
.css( { 'overflow-x': 'auto', 'width': desiredWidth
} );
2382 this.$clippable
.css( { 'overflow-x': '', 'width': this.idealWidth
|| '' } );
2385 this.$clippable
.css( { 'overflow-y': 'auto', 'height': desiredHeight
} );
2387 this.$clippable
.css( { 'overflow-y': '', 'height': this.idealHeight
|| '' } );
2390 this.clipped
= clipWidth
|| clipHeight
;
2395 * Element with named flags that can be added, removed, listed and checked.
2397 * A flag, when set, adds a CSS class on the `$element` by combing `oo-ui-flaggableElement-` with
2398 * the flag name. Flags are primarily useful for styling.
2404 * @param {Object} [config] Configuration options
2405 * @cfg {string[]} [flags=[]] Styling flags, e.g. 'primary', 'destructive' or 'constructive'
2407 OO
.ui
.FlaggableElement
= function OoUiFlaggableElement( config
) {
2408 // Config initialization
2409 config
= config
|| {};
2415 this.setFlags( config
.flags
);
2421 * Check if a flag is set.
2423 * @param {string} flag Name of flag
2424 * @return {boolean} Has flag
2426 OO
.ui
.FlaggableElement
.prototype.hasFlag = function ( flag
) {
2427 return flag
in this.flags
;
2431 * Get the names of all flags set.
2433 * @return {string[]} flags Flag names
2435 OO
.ui
.FlaggableElement
.prototype.getFlags = function () {
2436 return Object
.keys( this.flags
);
2444 OO
.ui
.FlaggableElement
.prototype.clearFlags = function () {
2446 classPrefix
= 'oo-ui-flaggableElement-';
2448 for ( flag
in this.flags
) {
2449 delete this.flags
[flag
];
2450 this.$element
.removeClass( classPrefix
+ flag
);
2457 * Add one or more flags.
2459 * @param {string|string[]|Object.<string, boolean>} flags One or more flags to add, or an object
2460 * keyed by flag name containing boolean set/remove instructions.
2463 OO
.ui
.FlaggableElement
.prototype.setFlags = function ( flags
) {
2465 classPrefix
= 'oo-ui-flaggableElement-';
2467 if ( typeof flags
=== 'string' ) {
2469 this.flags
[flags
] = true;
2470 this.$element
.addClass( classPrefix
+ flags
);
2471 } else if ( $.isArray( flags
) ) {
2472 for ( i
= 0, len
= flags
.length
; i
< len
; i
++ ) {
2475 this.flags
[flag
] = true;
2476 this.$element
.addClass( classPrefix
+ flag
);
2478 } else if ( OO
.isPlainObject( flags
) ) {
2479 for ( flag
in flags
) {
2480 if ( flags
[flag
] ) {
2482 this.flags
[flag
] = true;
2483 this.$element
.addClass( classPrefix
+ flag
);
2486 delete this.flags
[flag
];
2487 this.$element
.removeClass( classPrefix
+ flag
);
2494 * Element containing a sequence of child elements.
2500 * @param {jQuery} $group Container node, assigned to #$group
2501 * @param {Object} [config] Configuration options
2503 OO
.ui
.GroupElement
= function OoUiGroupElement( $group
, config
) {
2505 config
= config
|| {};
2508 this.$group
= $group
;
2510 this.$items
= this.$( [] );
2511 this.aggregateItemEvents
= {};
2519 * @return {OO.ui.Element[]} Items
2521 OO
.ui
.GroupElement
.prototype.getItems = function () {
2522 return this.items
.slice( 0 );
2526 * Add an aggregate item event.
2528 * Aggregated events are listened to on each item and then emitted by the group under a new name,
2529 * and with an additional leading parameter containing the item that emitted the original event.
2530 * Other arguments that were emitted from the original event are passed through.
2532 * @param {Object.<string,string|null>} events Aggregate events emitted by group, keyed by item
2533 * event, use null value to remove aggregation
2534 * @throws {Error} If aggregation already exists
2536 OO
.ui
.GroupElement
.prototype.aggregate = function ( events
) {
2537 var i
, len
, item
, add
, remove
, itemEvent
, groupEvent
;
2539 for ( itemEvent
in events
) {
2540 groupEvent
= events
[itemEvent
];
2542 // Remove existing aggregated event
2543 if ( itemEvent
in this.aggregateItemEvents
) {
2544 // Don't allow duplicate aggregations
2546 throw new Error( 'Duplicate item event aggregation for ' + itemEvent
);
2548 // Remove event aggregation from existing items
2549 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
2550 item
= this.items
[i
];
2551 if ( item
.connect
&& item
.disconnect
) {
2553 remove
[itemEvent
] = [ 'emit', groupEvent
, item
];
2554 item
.disconnect( this, remove
);
2557 // Prevent future items from aggregating event
2558 delete this.aggregateItemEvents
[itemEvent
];
2561 // Add new aggregate event
2563 // Make future items aggregate event
2564 this.aggregateItemEvents
[itemEvent
] = groupEvent
;
2565 // Add event aggregation to existing items
2566 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
2567 item
= this.items
[i
];
2568 if ( item
.connect
&& item
.disconnect
) {
2570 add
[itemEvent
] = [ 'emit', groupEvent
, item
];
2571 item
.connect( this, add
);
2581 * @param {OO.ui.Element[]} items Item
2582 * @param {number} [index] Index to insert items at
2585 OO
.ui
.GroupElement
.prototype.addItems = function ( items
, index
) {
2586 var i
, len
, item
, event
, events
, currentIndex
,
2587 $items
= this.$( [] );
2589 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
2592 // Check if item exists then remove it first, effectively "moving" it
2593 currentIndex
= $.inArray( item
, this.items
);
2594 if ( currentIndex
>= 0 ) {
2595 this.removeItems( [ item
] );
2596 // Adjust index to compensate for removal
2597 if ( currentIndex
< index
) {
2602 if ( item
.connect
&& item
.disconnect
&& !$.isEmptyObject( this.aggregateItemEvents
) ) {
2604 for ( event
in this.aggregateItemEvents
) {
2605 events
[event
] = [ 'emit', this.aggregateItemEvents
[event
], item
];
2607 item
.connect( this, events
);
2609 item
.setElementGroup( this );
2610 $items
= $items
.add( item
.$element
);
2613 if ( index
=== undefined || index
< 0 || index
>= this.items
.length
) {
2614 this.$group
.append( $items
);
2615 this.items
.push
.apply( this.items
, items
);
2616 } else if ( index
=== 0 ) {
2617 this.$group
.prepend( $items
);
2618 this.items
.unshift
.apply( this.items
, items
);
2620 this.$items
.eq( index
).before( $items
);
2621 this.items
.splice
.apply( this.items
, [ index
, 0 ].concat( items
) );
2624 this.$items
= this.$items
.add( $items
);
2632 * Items will be detached, not removed, so they can be used later.
2634 * @param {OO.ui.Element[]} items Items to remove
2637 OO
.ui
.GroupElement
.prototype.removeItems = function ( items
) {
2638 var i
, len
, item
, index
, remove
, itemEvent
;
2640 // Remove specific items
2641 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
2643 index
= $.inArray( item
, this.items
);
2644 if ( index
!== -1 ) {
2646 item
.connect
&& item
.disconnect
&&
2647 !$.isEmptyObject( this.aggregateItemEvents
)
2650 if ( itemEvent
in this.aggregateItemEvents
) {
2651 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
2653 item
.disconnect( this, remove
);
2655 item
.setElementGroup( null );
2656 this.items
.splice( index
, 1 );
2657 item
.$element
.detach();
2658 this.$items
= this.$items
.not( item
.$element
);
2668 * Items will be detached, not removed, so they can be used later.
2672 OO
.ui
.GroupElement
.prototype.clearItems = function () {
2673 var i
, len
, item
, remove
, itemEvent
;
2676 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
2677 item
= this.items
[i
];
2679 item
.connect
&& item
.disconnect
&&
2680 !$.isEmptyObject( this.aggregateItemEvents
)
2683 if ( itemEvent
in this.aggregateItemEvents
) {
2684 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
2686 item
.disconnect( this, remove
);
2688 item
.setElementGroup( null );
2691 this.$items
.detach();
2692 this.$items
= this.$( [] );
2697 * Element containing an icon.
2703 * @param {jQuery} $icon Icon node, assigned to #$icon
2704 * @param {Object} [config] Configuration options
2705 * @cfg {Object|string} [icon=''] Symbolic icon name, or map of icon names keyed by language ID;
2706 * use the 'default' key to specify the icon to be used when there is no icon in the user's
2709 OO
.ui
.IconedElement
= function OoUiIconedElement( $icon
, config
) {
2710 // Config intialization
2711 config
= config
|| {};
2718 this.$icon
.addClass( 'oo-ui-iconedElement-icon' );
2719 this.setIcon( config
.icon
|| this.constructor.static.icon
);
2724 OO
.initClass( OO
.ui
.IconedElement
);
2726 /* Static Properties */
2731 * Value should be the unique portion of an icon CSS class name, such as 'up' for 'oo-ui-icon-up'.
2733 * For i18n purposes, this property can be an object containing a `default` icon name property and
2734 * additional icon names keyed by language code.
2736 * Example of i18n icon definition:
2737 * { 'default': 'bold-a', 'en': 'bold-b', 'de': 'bold-f' }
2741 * @property {Object|string} Symbolic icon name, or map of icon names keyed by language ID;
2742 * use the 'default' key to specify the icon to be used when there is no icon in the user's
2745 OO
.ui
.IconedElement
.static.icon
= null;
2752 * @param {Object|string} icon Symbolic icon name, or map of icon names keyed by language ID;
2753 * use the 'default' key to specify the icon to be used when there is no icon in the user's
2757 OO
.ui
.IconedElement
.prototype.setIcon = function ( icon
) {
2758 icon
= OO
.isPlainObject( icon
) ? OO
.ui
.getLocalValue( icon
, null, 'default' ) : icon
;
2761 this.$icon
.removeClass( 'oo-ui-icon-' + this.icon
);
2763 if ( typeof icon
=== 'string' ) {
2765 if ( icon
.length
) {
2766 this.$icon
.addClass( 'oo-ui-icon-' + icon
);
2770 this.$element
.toggleClass( 'oo-ui-iconedElement', !!this.icon
);
2778 * @return {string} Icon
2780 OO
.ui
.IconedElement
.prototype.getIcon = function () {
2784 * Element containing an indicator.
2790 * @param {jQuery} $indicator Indicator node, assigned to #$indicator
2791 * @param {Object} [config] Configuration options
2792 * @cfg {string} [indicator] Symbolic indicator name
2793 * @cfg {string} [indicatorTitle] Indicator title text or a function that return text
2795 OO
.ui
.IndicatedElement
= function OoUiIndicatedElement( $indicator
, config
) {
2796 // Config intialization
2797 config
= config
|| {};
2800 this.$indicator
= $indicator
;
2801 this.indicator
= null;
2802 this.indicatorLabel
= null;
2805 this.$indicator
.addClass( 'oo-ui-indicatedElement-indicator' );
2806 this.setIndicator( config
.indicator
|| this.constructor.static.indicator
);
2807 this.setIndicatorTitle( config
.indicatorTitle
|| this.constructor.static.indicatorTitle
);
2812 OO
.initClass( OO
.ui
.IndicatedElement
);
2814 /* Static Properties */
2821 * @property {string|null} Symbolic indicator name or null for no indicator
2823 OO
.ui
.IndicatedElement
.static.indicator
= null;
2830 * @property {string|Function|null} Indicator title text, a function that return text or null for no
2833 OO
.ui
.IndicatedElement
.static.indicatorTitle
= null;
2840 * @param {string|null} indicator Symbolic name of indicator to use or null for no indicator
2843 OO
.ui
.IndicatedElement
.prototype.setIndicator = function ( indicator
) {
2844 if ( this.indicator
) {
2845 this.$indicator
.removeClass( 'oo-ui-indicator-' + this.indicator
);
2846 this.indicator
= null;
2848 if ( typeof indicator
=== 'string' ) {
2849 indicator
= indicator
.trim();
2850 if ( indicator
.length
) {
2851 this.$indicator
.addClass( 'oo-ui-indicator-' + indicator
);
2852 this.indicator
= indicator
;
2855 this.$element
.toggleClass( 'oo-ui-indicatedElement', !!this.indicator
);
2861 * Set indicator label.
2863 * @param {string|Function|null} indicator Indicator title text, a function that return text or null
2864 * for no indicator title
2867 OO
.ui
.IndicatedElement
.prototype.setIndicatorTitle = function ( indicatorTitle
) {
2868 this.indicatorTitle
= indicatorTitle
= OO
.ui
.resolveMsg( indicatorTitle
);
2870 if ( typeof indicatorTitle
=== 'string' && indicatorTitle
.length
) {
2871 this.$indicator
.attr( 'title', indicatorTitle
);
2873 this.$indicator
.removeAttr( 'title' );
2882 * @return {string} title Symbolic name of indicator
2884 OO
.ui
.IndicatedElement
.prototype.getIndicator = function () {
2885 return this.indicator
;
2889 * Get indicator title.
2891 * @return {string} Indicator title text
2893 OO
.ui
.IndicatedElement
.prototype.getIndicatorTitle = function () {
2894 return this.indicatorTitle
;
2897 * Element containing a label.
2903 * @param {jQuery} $label Label node, assigned to #$label
2904 * @param {Object} [config] Configuration options
2905 * @cfg {jQuery|string|Function} [label] Label nodes, text or a function that returns nodes or text
2906 * @cfg {boolean} [autoFitLabel=true] Whether to fit the label or not.
2908 OO
.ui
.LabeledElement
= function OoUiLabeledElement( $label
, config
) {
2909 // Config intialization
2910 config
= config
|| {};
2913 this.$label
= $label
;
2917 this.$label
.addClass( 'oo-ui-labeledElement-label' );
2918 this.setLabel( config
.label
|| this.constructor.static.label
);
2919 this.autoFitLabel
= config
.autoFitLabel
=== undefined || !!config
.autoFitLabel
;
2924 OO
.initClass( OO
.ui
.LabeledElement
);
2926 /* Static Properties */
2933 * @property {string|Function|null} Label text; a function that returns a nodes or text; or null for
2936 OO
.ui
.LabeledElement
.static.label
= null;
2943 * An empty string will result in the label being hidden. A string containing only whitespace will
2944 * be converted to a single
2946 * @param {jQuery|string|Function|null} label Label nodes; text; a function that retuns nodes or
2947 * text; or null for no label
2950 OO
.ui
.LabeledElement
.prototype.setLabel = function ( label
) {
2953 this.label
= label
= OO
.ui
.resolveMsg( label
) || null;
2954 if ( typeof label
=== 'string' && label
.length
) {
2955 if ( label
.match( /^\s*$/ ) ) {
2956 // Convert whitespace only string to a single non-breaking space
2957 this.$label
.html( ' ' );
2959 this.$label
.text( label
);
2961 } else if ( label
instanceof jQuery
) {
2962 this.$label
.empty().append( label
);
2964 this.$label
.empty();
2967 this.$element
.toggleClass( 'oo-ui-labeledElement', !empty
);
2968 this.$label
.css( 'display', empty
? 'none' : '' );
2976 * @return {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
2977 * text; or null for no label
2979 OO
.ui
.LabeledElement
.prototype.getLabel = function () {
2988 OO
.ui
.LabeledElement
.prototype.fitLabel = function () {
2989 if ( this.$label
.autoEllipsis
&& this.autoFitLabel
) {
2990 this.$label
.autoEllipsis( { 'hasSpan': false, 'tooltip': true } );
2995 * Popuppable element.
3001 * @param {Object} [config] Configuration options
3002 * @cfg {number} [popupWidth=320] Width of popup
3003 * @cfg {number} [popupHeight] Height of popup
3004 * @cfg {Object} [popup] Configuration to pass to popup
3006 OO
.ui
.PopuppableElement
= function OoUiPopuppableElement( config
) {
3007 // Configuration initialization
3008 config
= $.extend( { 'popupWidth': 320 }, config
);
3011 this.popup
= new OO
.ui
.PopupWidget( $.extend(
3012 { 'align': 'center', 'autoClose': true },
3014 { '$': this.$, '$autoCloseIgnore': this.$element
}
3016 this.popupWidth
= config
.popupWidth
;
3017 this.popupHeight
= config
.popupHeight
;
3025 * @return {OO.ui.PopupWidget} Popup widget
3027 OO
.ui
.PopuppableElement
.prototype.getPopup = function () {
3034 OO
.ui
.PopuppableElement
.prototype.showPopup = function () {
3035 this.popup
.show().display( this.popupWidth
, this.popupHeight
);
3041 OO
.ui
.PopuppableElement
.prototype.hidePopup = function () {
3045 * Element with a title.
3051 * @param {jQuery} $label Titled node, assigned to #$titled
3052 * @param {Object} [config] Configuration options
3053 * @cfg {string|Function} [title] Title text or a function that returns text
3055 OO
.ui
.TitledElement
= function OoUiTitledElement( $titled
, config
) {
3056 // Config intialization
3057 config
= config
|| {};
3060 this.$titled
= $titled
;
3064 this.setTitle( config
.title
|| this.constructor.static.title
);
3069 OO
.initClass( OO
.ui
.TitledElement
);
3071 /* Static Properties */
3078 * @property {string|Function} Title text or a function that returns text
3080 OO
.ui
.TitledElement
.static.title
= null;
3087 * @param {string|Function|null} title Title text, a function that returns text or null for no title
3090 OO
.ui
.TitledElement
.prototype.setTitle = function ( title
) {
3091 this.title
= title
= OO
.ui
.resolveMsg( title
) || null;
3093 if ( typeof title
=== 'string' && title
.length
) {
3094 this.$titled
.attr( 'title', title
);
3096 this.$titled
.removeAttr( 'title' );
3105 * @return {string} Title string
3107 OO
.ui
.TitledElement
.prototype.getTitle = function () {
3111 * Generic toolbar tool.
3115 * @extends OO.ui.Widget
3116 * @mixins OO.ui.IconedElement
3119 * @param {OO.ui.ToolGroup} toolGroup
3120 * @param {Object} [config] Configuration options
3121 * @cfg {string|Function} [title] Title text or a function that returns text
3123 OO
.ui
.Tool
= function OoUiTool( toolGroup
, config
) {
3124 // Config intialization
3125 config
= config
|| {};
3127 // Parent constructor
3128 OO
.ui
.Tool
.super.call( this, config
);
3130 // Mixin constructors
3131 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
3134 this.toolGroup
= toolGroup
;
3135 this.toolbar
= this.toolGroup
.getToolbar();
3136 this.active
= false;
3137 this.$title
= this.$( '<span>' );
3138 this.$link
= this.$( '<a>' );
3142 this.toolbar
.connect( this, { 'updateState': 'onUpdateState' } );
3145 this.$title
.addClass( 'oo-ui-tool-title' );
3147 .addClass( 'oo-ui-tool-link' )
3148 .append( this.$icon
, this.$title
);
3150 .data( 'oo-ui-tool', this )
3152 'oo-ui-tool ' + 'oo-ui-tool-name-' +
3153 this.constructor.static.name
.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' )
3155 .append( this.$link
);
3156 this.setTitle( config
.title
|| this.constructor.static.title
);
3161 OO
.inheritClass( OO
.ui
.Tool
, OO
.ui
.Widget
);
3162 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.IconedElement
);
3170 /* Static Properties */
3176 OO
.ui
.Tool
.static.tagName
= 'span';
3179 * Symbolic name of tool.
3184 * @property {string}
3186 OO
.ui
.Tool
.static.name
= '';
3194 * @property {string}
3196 OO
.ui
.Tool
.static.group
= '';
3201 * Title is used as a tooltip when the tool is part of a bar tool group, or a label when the tool
3202 * is part of a list or menu tool group. If a trigger is associated with an action by the same name
3203 * as the tool, a description of its keyboard shortcut for the appropriate platform will be
3204 * appended to the title if the tool is part of a bar tool group.
3209 * @property {string|Function} Title text or a function that returns text
3211 OO
.ui
.Tool
.static.title
= '';
3214 * Tool can be automatically added to catch-all groups.
3218 * @property {boolean}
3220 OO
.ui
.Tool
.static.autoAddToCatchall
= true;
3223 * Tool can be automatically added to named groups.
3226 * @property {boolean}
3229 OO
.ui
.Tool
.static.autoAddToGroup
= true;
3232 * Check if this tool is compatible with given data.
3236 * @param {Mixed} data Data to check
3237 * @return {boolean} Tool can be used with data
3239 OO
.ui
.Tool
.static.isCompatibleWith = function () {
3246 * Handle the toolbar state being updated.
3248 * This is an abstract method that must be overridden in a concrete subclass.
3252 OO
.ui
.Tool
.prototype.onUpdateState = function () {
3254 'OO.ui.Tool.onUpdateState not implemented in this subclass:' + this.constructor
3259 * Handle the tool being selected.
3261 * This is an abstract method that must be overridden in a concrete subclass.
3265 OO
.ui
.Tool
.prototype.onSelect = function () {
3267 'OO.ui.Tool.onSelect not implemented in this subclass:' + this.constructor
3272 * Check if the button is active.
3274 * @param {boolean} Button is active
3276 OO
.ui
.Tool
.prototype.isActive = function () {
3281 * Make the button appear active or inactive.
3283 * @param {boolean} state Make button appear active
3285 OO
.ui
.Tool
.prototype.setActive = function ( state
) {
3286 this.active
= !!state
;
3287 if ( this.active
) {
3288 this.$element
.addClass( 'oo-ui-tool-active' );
3290 this.$element
.removeClass( 'oo-ui-tool-active' );
3295 * Get the tool title.
3297 * @param {string|Function} title Title text or a function that returns text
3300 OO
.ui
.Tool
.prototype.setTitle = function ( title
) {
3301 this.title
= OO
.ui
.resolveMsg( title
);
3307 * Get the tool title.
3309 * @return {string} Title text
3311 OO
.ui
.Tool
.prototype.getTitle = function () {
3316 * Get the tool's symbolic name.
3318 * @return {string} Symbolic name of tool
3320 OO
.ui
.Tool
.prototype.getName = function () {
3321 return this.constructor.static.name
;
3327 OO
.ui
.Tool
.prototype.updateTitle = function () {
3328 var titleTooltips
= this.toolGroup
.constructor.static.titleTooltips
,
3329 accelTooltips
= this.toolGroup
.constructor.static.accelTooltips
,
3330 accel
= this.toolbar
.getToolAccelerator( this.constructor.static.name
),
3337 .addClass( 'oo-ui-tool-accel' )
3341 if ( titleTooltips
&& typeof this.title
=== 'string' && this.title
.length
) {
3342 tooltipParts
.push( this.title
);
3344 if ( accelTooltips
&& typeof accel
=== 'string' && accel
.length
) {
3345 tooltipParts
.push( accel
);
3347 if ( tooltipParts
.length
) {
3348 this.$link
.attr( 'title', tooltipParts
.join( ' ' ) );
3350 this.$link
.removeAttr( 'title' );
3357 OO
.ui
.Tool
.prototype.destroy = function () {
3358 this.toolbar
.disconnect( this );
3359 this.$element
.remove();
3362 * Collection of tool groups.
3365 * @extends OO.ui.Element
3366 * @mixins OO.EventEmitter
3367 * @mixins OO.ui.GroupElement
3370 * @param {OO.ui.ToolFactory} toolFactory Factory for creating tools
3371 * @param {OO.ui.ToolGroupFactory} toolGroupFactory Factory for creating tool groups
3372 * @param {Object} [config] Configuration options
3373 * @cfg {boolean} [actions] Add an actions section opposite to the tools
3374 * @cfg {boolean} [shadow] Add a shadow below the toolbar
3376 OO
.ui
.Toolbar
= function OoUiToolbar( toolFactory
, toolGroupFactory
, config
) {
3377 // Configuration initialization
3378 config
= config
|| {};
3380 // Parent constructor
3381 OO
.ui
.Toolbar
.super.call( this, config
);
3383 // Mixin constructors
3384 OO
.EventEmitter
.call( this );
3385 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
3388 this.toolFactory
= toolFactory
;
3389 this.toolGroupFactory
= toolGroupFactory
;
3392 this.$bar
= this.$( '<div>' );
3393 this.$actions
= this.$( '<div>' );
3394 this.initialized
= false;
3398 .add( this.$bar
).add( this.$group
).add( this.$actions
)
3399 .on( 'mousedown', OO
.ui
.bind( this.onMouseDown
, this ) );
3402 this.$group
.addClass( 'oo-ui-toolbar-tools' );
3403 this.$bar
.addClass( 'oo-ui-toolbar-bar' ).append( this.$group
);
3404 if ( config
.actions
) {
3405 this.$actions
.addClass( 'oo-ui-toolbar-actions' );
3406 this.$bar
.append( this.$actions
);
3408 this.$bar
.append( '<div style="clear:both"></div>' );
3409 if ( config
.shadow
) {
3410 this.$bar
.append( '<div class="oo-ui-toolbar-shadow"></div>' );
3412 this.$element
.addClass( 'oo-ui-toolbar' ).append( this.$bar
);
3417 OO
.inheritClass( OO
.ui
.Toolbar
, OO
.ui
.Element
);
3418 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.EventEmitter
);
3419 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.ui
.GroupElement
);
3424 * Get the tool factory.
3426 * @return {OO.ui.ToolFactory} Tool factory
3428 OO
.ui
.Toolbar
.prototype.getToolFactory = function () {
3429 return this.toolFactory
;
3433 * Get the tool group factory.
3435 * @return {OO.Factory} Tool group factory
3437 OO
.ui
.Toolbar
.prototype.getToolGroupFactory = function () {
3438 return this.toolGroupFactory
;
3442 * Handles mouse down events.
3444 * @param {jQuery.Event} e Mouse down event
3446 OO
.ui
.Toolbar
.prototype.onMouseDown = function ( e
) {
3447 var $closestWidgetToEvent
= this.$( e
.target
).closest( '.oo-ui-widget' ),
3448 $closestWidgetToToolbar
= this.$element
.closest( '.oo-ui-widget' );
3449 if ( !$closestWidgetToEvent
.length
|| $closestWidgetToEvent
[0] === $closestWidgetToToolbar
[0] ) {
3455 * Sets up handles and preloads required information for the toolbar to work.
3456 * This must be called immediately after it is attached to a visible document.
3458 OO
.ui
.Toolbar
.prototype.initialize = function () {
3459 this.initialized
= true;
3465 * Tools can be specified in the following ways:
3467 * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3468 * - All tools in a group: `{ 'group': 'group-name' }`
3469 * - All tools: `'*'` - Using this will make the group a list with a "More" label by default
3471 * @param {Object.<string,Array>} groups List of tool group configurations
3472 * @param {Array|string} [groups.include] Tools to include
3473 * @param {Array|string} [groups.exclude] Tools to exclude
3474 * @param {Array|string} [groups.promote] Tools to promote to the beginning
3475 * @param {Array|string} [groups.demote] Tools to demote to the end
3477 OO
.ui
.Toolbar
.prototype.setup = function ( groups
) {
3478 var i
, len
, type
, group
,
3480 defaultType
= 'bar';
3482 // Cleanup previous groups
3485 // Build out new groups
3486 for ( i
= 0, len
= groups
.length
; i
< len
; i
++ ) {
3488 if ( group
.include
=== '*' ) {
3489 // Apply defaults to catch-all groups
3490 if ( group
.type
=== undefined ) {
3491 group
.type
= 'list';
3493 if ( group
.label
=== undefined ) {
3494 group
.label
= 'ooui-toolbar-more';
3497 // Check type has been registered
3498 type
= this.getToolGroupFactory().lookup( group
.type
) ? group
.type
: defaultType
;
3500 this.getToolGroupFactory().create( type
, this, $.extend( { '$': this.$ }, group
) )
3503 this.addItems( items
);
3507 * Remove all tools and groups from the toolbar.
3509 OO
.ui
.Toolbar
.prototype.reset = function () {
3514 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3515 this.items
[i
].destroy();
3521 * Destroys toolbar, removing event handlers and DOM elements.
3523 * Call this whenever you are done using a toolbar.
3525 OO
.ui
.Toolbar
.prototype.destroy = function () {
3527 this.$element
.remove();
3531 * Check if tool has not been used yet.
3533 * @param {string} name Symbolic name of tool
3534 * @return {boolean} Tool is available
3536 OO
.ui
.Toolbar
.prototype.isToolAvailable = function ( name
) {
3537 return !this.tools
[name
];
3541 * Prevent tool from being used again.
3543 * @param {OO.ui.Tool} tool Tool to reserve
3545 OO
.ui
.Toolbar
.prototype.reserveTool = function ( tool
) {
3546 this.tools
[tool
.getName()] = tool
;
3550 * Allow tool to be used again.
3552 * @param {OO.ui.Tool} tool Tool to release
3554 OO
.ui
.Toolbar
.prototype.releaseTool = function ( tool
) {
3555 delete this.tools
[tool
.getName()];
3559 * Get accelerator label for tool.
3561 * This is a stub that should be overridden to provide access to accelerator information.
3563 * @param {string} name Symbolic name of tool
3564 * @return {string|undefined} Tool accelerator label if available
3566 OO
.ui
.Toolbar
.prototype.getToolAccelerator = function () {
3570 * Factory for tools.
3573 * @extends OO.Factory
3576 OO
.ui
.ToolFactory
= function OoUiToolFactory() {
3577 // Parent constructor
3578 OO
.ui
.ToolFactory
.super.call( this );
3583 OO
.inheritClass( OO
.ui
.ToolFactory
, OO
.Factory
);
3588 OO
.ui
.ToolFactory
.prototype.getTools = function ( include
, exclude
, promote
, demote
) {
3589 var i
, len
, included
, promoted
, demoted
,
3593 // Collect included and not excluded tools
3594 included
= OO
.simpleArrayDifference( this.extract( include
), this.extract( exclude
) );
3597 promoted
= this.extract( promote
, used
);
3598 demoted
= this.extract( demote
, used
);
3601 for ( i
= 0, len
= included
.length
; i
< len
; i
++ ) {
3602 if ( !used
[included
[i
]] ) {
3603 auto
.push( included
[i
] );
3607 return promoted
.concat( auto
).concat( demoted
);
3611 * Get a flat list of names from a list of names or groups.
3613 * Tools can be specified in the following ways:
3615 * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3616 * - All tools in a group: `{ 'group': 'group-name' }`
3617 * - All tools: `'*'`
3620 * @param {Array|string} collection List of tools
3621 * @param {Object} [used] Object with names that should be skipped as properties; extracted
3622 * names will be added as properties
3623 * @return {string[]} List of extracted names
3625 OO
.ui
.ToolFactory
.prototype.extract = function ( collection
, used
) {
3626 var i
, len
, item
, name
, tool
,
3629 if ( collection
=== '*' ) {
3630 for ( name
in this.registry
) {
3631 tool
= this.registry
[name
];
3633 // Only add tools by group name when auto-add is enabled
3634 tool
.static.autoAddToCatchall
&&
3635 // Exclude already used tools
3636 ( !used
|| !used
[name
] )
3644 } else if ( $.isArray( collection
) ) {
3645 for ( i
= 0, len
= collection
.length
; i
< len
; i
++ ) {
3646 item
= collection
[i
];
3647 // Allow plain strings as shorthand for named tools
3648 if ( typeof item
=== 'string' ) {
3649 item
= { 'name': item
};
3651 if ( OO
.isPlainObject( item
) ) {
3653 for ( name
in this.registry
) {
3654 tool
= this.registry
[name
];
3656 // Include tools with matching group
3657 tool
.static.group
=== item
.group
&&
3658 // Only add tools by group name when auto-add is enabled
3659 tool
.static.autoAddToGroup
&&
3660 // Exclude already used tools
3661 ( !used
|| !used
[name
] )
3669 // Include tools with matching name and exclude already used tools
3670 } else if ( item
.name
&& ( !used
|| !used
[item
.name
] ) ) {
3671 names
.push( item
.name
);
3673 used
[item
.name
] = true;
3682 * Collection of tools.
3684 * Tools can be specified in the following ways:
3686 * - A specific tool: `{ 'name': 'tool-name' }` or `'tool-name'`
3687 * - All tools in a group: `{ 'group': 'group-name' }`
3688 * - All tools: `'*'`
3692 * @extends OO.ui.Widget
3693 * @mixins OO.ui.GroupElement
3696 * @param {OO.ui.Toolbar} toolbar
3697 * @param {Object} [config] Configuration options
3698 * @cfg {Array|string} [include=[]] List of tools to include
3699 * @cfg {Array|string} [exclude=[]] List of tools to exclude
3700 * @cfg {Array|string} [promote=[]] List of tools to promote to the beginning
3701 * @cfg {Array|string} [demote=[]] List of tools to demote to the end
3703 OO
.ui
.ToolGroup
= function OoUiToolGroup( toolbar
, config
) {
3704 // Configuration initialization
3705 config
= config
|| {};
3707 // Parent constructor
3708 OO
.ui
.ToolGroup
.super.call( this, config
);
3710 // Mixin constructors
3711 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
3714 this.toolbar
= toolbar
;
3716 this.pressed
= null;
3717 this.autoDisabled
= false;
3718 this.include
= config
.include
|| [];
3719 this.exclude
= config
.exclude
|| [];
3720 this.promote
= config
.promote
|| [];
3721 this.demote
= config
.demote
|| [];
3722 this.onCapturedMouseUpHandler
= OO
.ui
.bind( this.onCapturedMouseUp
, this );
3726 'mousedown': OO
.ui
.bind( this.onMouseDown
, this ),
3727 'mouseup': OO
.ui
.bind( this.onMouseUp
, this ),
3728 'mouseover': OO
.ui
.bind( this.onMouseOver
, this ),
3729 'mouseout': OO
.ui
.bind( this.onMouseOut
, this )
3731 this.toolbar
.getToolFactory().connect( this, { 'register': 'onToolFactoryRegister' } );
3732 this.aggregate( { 'disable': 'itemDisable' } );
3733 this.connect( this, { 'itemDisable': 'updateDisabled' } );
3736 this.$group
.addClass( 'oo-ui-toolGroup-tools' );
3738 .addClass( 'oo-ui-toolGroup' )
3739 .append( this.$group
);
3745 OO
.inheritClass( OO
.ui
.ToolGroup
, OO
.ui
.Widget
);
3746 OO
.mixinClass( OO
.ui
.ToolGroup
, OO
.ui
.GroupElement
);
3754 /* Static Properties */
3757 * Show labels in tooltips.
3761 * @property {boolean}
3763 OO
.ui
.ToolGroup
.static.titleTooltips
= false;
3766 * Show acceleration labels in tooltips.
3770 * @property {boolean}
3772 OO
.ui
.ToolGroup
.static.accelTooltips
= false;
3775 * Automatically disable the toolgroup when all tools are disabled
3779 * @property {boolean}
3781 OO
.ui
.ToolGroup
.static.autoDisable
= true;
3788 OO
.ui
.ToolGroup
.prototype.isDisabled = function () {
3789 return this.autoDisabled
|| OO
.ui
.ToolGroup
.super.prototype.isDisabled
.apply( this, arguments
);
3795 OO
.ui
.ToolGroup
.prototype.updateDisabled = function () {
3796 var i
, item
, allDisabled
= true;
3798 if ( this.constructor.static.autoDisable
) {
3799 for ( i
= this.items
.length
- 1; i
>= 0; i
-- ) {
3800 item
= this.items
[i
];
3801 if ( !item
.isDisabled() ) {
3802 allDisabled
= false;
3806 this.autoDisabled
= allDisabled
;
3808 OO
.ui
.ToolGroup
.super.prototype.updateDisabled
.apply( this, arguments
);
3812 * Handle mouse down events.
3814 * @param {jQuery.Event} e Mouse down event
3816 OO
.ui
.ToolGroup
.prototype.onMouseDown = function ( e
) {
3817 if ( !this.isDisabled() && e
.which
=== 1 ) {
3818 this.pressed
= this.getTargetTool( e
);
3819 if ( this.pressed
) {
3820 this.pressed
.setActive( true );
3821 this.getElementDocument().addEventListener(
3822 'mouseup', this.onCapturedMouseUpHandler
, true
3830 * Handle captured mouse up events.
3832 * @param {Event} e Mouse up event
3834 OO
.ui
.ToolGroup
.prototype.onCapturedMouseUp = function ( e
) {
3835 this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseUpHandler
, true );
3836 // onMouseUp may be called a second time, depending on where the mouse is when the button is
3837 // released, but since `this.pressed` will no longer be true, the second call will be ignored.
3838 this.onMouseUp( e
);
3842 * Handle mouse up events.
3844 * @param {jQuery.Event} e Mouse up event
3846 OO
.ui
.ToolGroup
.prototype.onMouseUp = function ( e
) {
3847 var tool
= this.getTargetTool( e
);
3849 if ( !this.isDisabled() && e
.which
=== 1 && this.pressed
&& this.pressed
=== tool
) {
3850 this.pressed
.onSelect();
3853 this.pressed
= null;
3858 * Handle mouse over events.
3860 * @param {jQuery.Event} e Mouse over event
3862 OO
.ui
.ToolGroup
.prototype.onMouseOver = function ( e
) {
3863 var tool
= this.getTargetTool( e
);
3865 if ( this.pressed
&& this.pressed
=== tool
) {
3866 this.pressed
.setActive( true );
3871 * Handle mouse out events.
3873 * @param {jQuery.Event} e Mouse out event
3875 OO
.ui
.ToolGroup
.prototype.onMouseOut = function ( e
) {
3876 var tool
= this.getTargetTool( e
);
3878 if ( this.pressed
&& this.pressed
=== tool
) {
3879 this.pressed
.setActive( false );
3884 * Get the closest tool to a jQuery.Event.
3886 * Only tool links are considered, which prevents other elements in the tool such as popups from
3887 * triggering tool group interactions.
3890 * @param {jQuery.Event} e
3891 * @return {OO.ui.Tool|null} Tool, `null` if none was found
3893 OO
.ui
.ToolGroup
.prototype.getTargetTool = function ( e
) {
3895 $item
= this.$( e
.target
).closest( '.oo-ui-tool-link' );
3897 if ( $item
.length
) {
3898 tool
= $item
.parent().data( 'oo-ui-tool' );
3901 return tool
&& !tool
.isDisabled() ? tool
: null;
3905 * Handle tool registry register events.
3907 * If a tool is registered after the group is created, we must repopulate the list to account for:
3909 * - a tool being added that may be included
3910 * - a tool already included being overridden
3912 * @param {string} name Symbolic name of tool
3914 OO
.ui
.ToolGroup
.prototype.onToolFactoryRegister = function () {
3919 * Get the toolbar this group is in.
3921 * @return {OO.ui.Toolbar} Toolbar of group
3923 OO
.ui
.ToolGroup
.prototype.getToolbar = function () {
3924 return this.toolbar
;
3928 * Add and remove tools based on configuration.
3930 OO
.ui
.ToolGroup
.prototype.populate = function () {
3931 var i
, len
, name
, tool
,
3932 toolFactory
= this.toolbar
.getToolFactory(),
3936 list
= this.toolbar
.getToolFactory().getTools(
3937 this.include
, this.exclude
, this.promote
, this.demote
3940 // Build a list of needed tools
3941 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
3945 toolFactory
.lookup( name
) &&
3946 // Tool is available or is already in this group
3947 ( this.toolbar
.isToolAvailable( name
) || this.tools
[name
] )
3949 tool
= this.tools
[name
];
3951 // Auto-initialize tools on first use
3952 this.tools
[name
] = tool
= toolFactory
.create( name
, this );
3955 this.toolbar
.reserveTool( tool
);
3960 // Remove tools that are no longer needed
3961 for ( name
in this.tools
) {
3962 if ( !names
[name
] ) {
3963 this.tools
[name
].destroy();
3964 this.toolbar
.releaseTool( this.tools
[name
] );
3965 remove
.push( this.tools
[name
] );
3966 delete this.tools
[name
];
3969 if ( remove
.length
) {
3970 this.removeItems( remove
);
3972 // Update emptiness state
3974 this.$element
.removeClass( 'oo-ui-toolGroup-empty' );
3976 this.$element
.addClass( 'oo-ui-toolGroup-empty' );
3978 // Re-add tools (moving existing ones to new locations)
3979 this.addItems( add
);
3980 // Disabled state may depend on items
3981 this.updateDisabled();
3985 * Destroy tool group.
3987 OO
.ui
.ToolGroup
.prototype.destroy = function () {
3991 this.toolbar
.getToolFactory().disconnect( this );
3992 for ( name
in this.tools
) {
3993 this.toolbar
.releaseTool( this.tools
[name
] );
3994 this.tools
[name
].disconnect( this ).destroy();
3995 delete this.tools
[name
];
3997 this.$element
.remove();
4000 * Factory for tool groups.
4003 * @extends OO.Factory
4006 OO
.ui
.ToolGroupFactory
= function OoUiToolGroupFactory() {
4007 // Parent constructor
4008 OO
.Factory
.call( this );
4011 defaultClasses
= this.constructor.static.getDefaultClasses();
4013 // Register default toolgroups
4014 for ( i
= 0, l
= defaultClasses
.length
; i
< l
; i
++ ) {
4015 this.register( defaultClasses
[i
] );
4021 OO
.inheritClass( OO
.ui
.ToolGroupFactory
, OO
.Factory
);
4023 /* Static Methods */
4026 * Get a default set of classes to be registered on construction
4028 * @return {Function[]} Default classes
4030 OO
.ui
.ToolGroupFactory
.static.getDefaultClasses = function () {
4033 OO
.ui
.ListToolGroup
,
4038 * Layout made of a fieldset and optional legend.
4040 * Just add OO.ui.FieldLayout items.
4043 * @extends OO.ui.Layout
4044 * @mixins OO.ui.LabeledElement
4045 * @mixins OO.ui.IconedElement
4046 * @mixins OO.ui.GroupElement
4049 * @param {Object} [config] Configuration options
4050 * @cfg {string} [icon] Symbolic icon name
4051 * @cfg {OO.ui.FieldLayout[]} [items] Items to add
4053 OO
.ui
.FieldsetLayout
= function OoUiFieldsetLayout( config
) {
4054 // Config initialization
4055 config
= config
|| {};
4057 // Parent constructor
4058 OO
.ui
.FieldsetLayout
.super.call( this, config
);
4060 // Mixin constructors
4061 OO
.ui
.IconedElement
.call( this, this.$( '<div>' ), config
);
4062 OO
.ui
.LabeledElement
.call( this, this.$( '<div>' ), config
);
4063 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
4067 .addClass( 'oo-ui-fieldsetLayout' )
4068 .prepend( this.$icon
, this.$label
, this.$group
);
4069 if ( $.isArray( config
.items
) ) {
4070 this.addItems( config
.items
);
4076 OO
.inheritClass( OO
.ui
.FieldsetLayout
, OO
.ui
.Layout
);
4077 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.IconedElement
);
4078 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.LabeledElement
);
4079 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.GroupElement
);
4081 /* Static Properties */
4083 OO
.ui
.FieldsetLayout
.static.tagName
= 'div';
4085 * Layout made of a field and optional label.
4088 * @extends OO.ui.Layout
4089 * @mixins OO.ui.LabeledElement
4091 * Available label alignment modes include:
4092 * - 'left': Label is before the field and aligned away from it, best for when the user will be
4093 * scanning for a specific label in a form with many fields
4094 * - 'right': Label is before the field and aligned toward it, best for forms the user is very
4095 * familiar with and will tab through field checking quickly to verify which field they are in
4096 * - 'top': Label is before the field and above it, best for when the use will need to fill out all
4097 * fields from top to bottom in a form with few fields
4098 * - 'inline': Label is after the field and aligned toward it, best for small boolean fields like
4099 * checkboxes or radio buttons
4102 * @param {OO.ui.Widget} field Field widget
4103 * @param {Object} [config] Configuration options
4104 * @cfg {string} [align='left'] Alignment mode, either 'left', 'right', 'top' or 'inline'
4106 OO
.ui
.FieldLayout
= function OoUiFieldLayout( field
, config
) {
4107 // Config initialization
4108 config
= $.extend( { 'align': 'left' }, config
);
4110 // Parent constructor
4111 OO
.ui
.FieldLayout
.super.call( this, config
);
4113 // Mixin constructors
4114 OO
.ui
.LabeledElement
.call( this, this.$( '<label>' ), config
);
4117 this.$field
= this.$( '<div>' );
4122 if ( this.field
instanceof OO
.ui
.InputWidget
) {
4123 this.$label
.on( 'click', OO
.ui
.bind( this.onLabelClick
, this ) );
4125 this.field
.connect( this, { 'disable': 'onFieldDisable' } );
4128 this.$element
.addClass( 'oo-ui-fieldLayout' );
4130 .addClass( 'oo-ui-fieldLayout-field' )
4131 .toggleClass( 'oo-ui-fieldLayout-disable', this.field
.isDisabled() )
4132 .append( this.field
.$element
);
4133 this.setAlignment( config
.align
);
4138 OO
.inheritClass( OO
.ui
.FieldLayout
, OO
.ui
.Layout
);
4139 OO
.mixinClass( OO
.ui
.FieldLayout
, OO
.ui
.LabeledElement
);
4144 * Handle field disable events.
4146 * @param {boolean} value Field is disabled
4148 OO
.ui
.FieldLayout
.prototype.onFieldDisable = function ( value
) {
4149 this.$element
.toggleClass( 'oo-ui-fieldLayout-disabled', value
);
4153 * Handle label mouse click events.
4155 * @param {jQuery.Event} e Mouse click event
4157 OO
.ui
.FieldLayout
.prototype.onLabelClick = function () {
4158 this.field
.simulateLabelClick();
4165 * @return {OO.ui.Widget} Field widget
4167 OO
.ui
.FieldLayout
.prototype.getField = function () {
4172 * Set the field alignment mode.
4174 * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
4177 OO
.ui
.FieldLayout
.prototype.setAlignment = function ( value
) {
4178 if ( value
!== this.align
) {
4179 // Default to 'left'
4180 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value
) === -1 ) {
4184 if ( value
=== 'inline' ) {
4185 this.$element
.append( this.$field
, this.$label
);
4187 this.$element
.append( this.$label
, this.$field
);
4191 this.$element
.removeClass( 'oo-ui-fieldLayout-align-' + this.align
);
4194 this.$element
.addClass( 'oo-ui-fieldLayout-align-' + this.align
);
4200 * Layout made of proportionally sized columns and rows.
4203 * @extends OO.ui.Layout
4206 * @param {OO.ui.PanelLayout[]} panels Panels in the grid
4207 * @param {Object} [config] Configuration options
4208 * @cfg {number[]} [widths] Widths of columns as ratios
4209 * @cfg {number[]} [heights] Heights of columns as ratios
4211 OO
.ui
.GridLayout
= function OoUiGridLayout( panels
, config
) {
4214 // Config initialization
4215 config
= config
|| {};
4217 // Parent constructor
4218 OO
.ui
.GridLayout
.super.call( this, config
);
4226 this.$element
.addClass( 'oo-ui-gridLayout' );
4227 for ( i
= 0, len
= panels
.length
; i
< len
; i
++ ) {
4228 this.panels
.push( panels
[i
] );
4229 this.$element
.append( panels
[i
].$element
);
4231 if ( config
.widths
|| config
.heights
) {
4232 this.layout( config
.widths
|| [ 1 ], config
.heights
|| [ 1 ] );
4234 // Arrange in columns by default
4236 for ( i
= 0, len
= this.panels
.length
; i
< len
; i
++ ) {
4239 this.layout( widths
, [ 1 ] );
4245 OO
.inheritClass( OO
.ui
.GridLayout
, OO
.ui
.Layout
);
4257 /* Static Properties */
4259 OO
.ui
.GridLayout
.static.tagName
= 'div';
4264 * Set grid dimensions.
4266 * @param {number[]} widths Widths of columns as ratios
4267 * @param {number[]} heights Heights of rows as ratios
4269 * @throws {Error} If grid is not large enough to fit all panels
4271 OO
.ui
.GridLayout
.prototype.layout = function ( widths
, heights
) {
4275 cols
= widths
.length
,
4276 rows
= heights
.length
;
4278 // Verify grid is big enough to fit panels
4279 if ( cols
* rows
< this.panels
.length
) {
4280 throw new Error( 'Grid is not large enough to fit ' + this.panels
.length
+ 'panels' );
4283 // Sum up denominators
4284 for ( x
= 0; x
< cols
; x
++ ) {
4287 for ( y
= 0; y
< rows
; y
++ ) {
4293 for ( x
= 0; x
< cols
; x
++ ) {
4294 this.widths
[x
] = widths
[x
] / xd
;
4296 for ( y
= 0; y
< rows
; y
++ ) {
4297 this.heights
[y
] = heights
[y
] / yd
;
4301 this.emit( 'layout' );
4305 * Update panel positions and sizes.
4309 OO
.ui
.GridLayout
.prototype.update = function () {
4317 cols
= this.widths
.length
,
4318 rows
= this.heights
.length
;
4320 for ( y
= 0; y
< rows
; y
++ ) {
4321 for ( x
= 0; x
< cols
; x
++ ) {
4322 panel
= this.panels
[i
];
4323 width
= this.widths
[x
];
4324 height
= this.heights
[y
];
4326 'width': Math
.round( width
* 100 ) + '%',
4327 'height': Math
.round( height
* 100 ) + '%',
4328 'top': Math
.round( top
* 100 ) + '%'
4331 if ( OO
.ui
.Element
.getDir( this.$.context
) === 'rtl' ) {
4332 dimensions
.right
= Math
.round( left
* 100 ) + '%';
4334 dimensions
.left
= Math
.round( left
* 100 ) + '%';
4336 panel
.$element
.css( dimensions
);
4344 this.emit( 'update' );
4348 * Get a panel at a given position.
4350 * The x and y position is affected by the current grid layout.
4352 * @param {number} x Horizontal position
4353 * @param {number} y Vertical position
4354 * @return {OO.ui.PanelLayout} The panel at the given postion
4356 OO
.ui
.GridLayout
.prototype.getPanel = function ( x
, y
) {
4357 return this.panels
[( x
* this.widths
.length
) + y
];
4360 * Layout containing a series of pages.
4363 * @extends OO.ui.Layout
4366 * @param {Object} [config] Configuration options
4367 * @cfg {boolean} [continuous=false] Show all pages, one after another
4368 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when changing to a page
4369 * @cfg {boolean} [outlined=false] Show an outline
4370 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
4371 * @cfg {Object[]} [adders] List of adders for controls, each with name, icon and title properties
4373 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
4374 // Initialize configuration
4375 config
= config
|| {};
4377 // Parent constructor
4378 OO
.ui
.BookletLayout
.super.call( this, config
);
4381 this.currentPageName
= null;
4383 this.ignoreFocus
= false;
4384 this.stackLayout
= new OO
.ui
.StackLayout( { '$': this.$, 'continuous': !!config
.continuous
} );
4385 this.autoFocus
= config
.autoFocus
=== undefined ? true : !!config
.autoFocus
;
4386 this.outlineVisible
= false;
4387 this.outlined
= !!config
.outlined
;
4388 if ( this.outlined
) {
4389 this.editable
= !!config
.editable
;
4390 this.adders
= config
.adders
|| null;
4391 this.outlineControlsWidget
= null;
4392 this.outlineWidget
= new OO
.ui
.OutlineWidget( { '$': this.$ } );
4393 this.outlinePanel
= new OO
.ui
.PanelLayout( { '$': this.$, 'scrollable': true } );
4394 this.gridLayout
= new OO
.ui
.GridLayout(
4395 [ this.outlinePanel
, this.stackLayout
],
4396 { '$': this.$, 'widths': [ 1, 2 ] }
4398 this.outlineVisible
= true;
4399 if ( this.editable
) {
4400 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
4402 { '$': this.$, 'adders': this.adders
}
4408 this.stackLayout
.connect( this, { 'set': 'onStackLayoutSet' } );
4409 if ( this.outlined
) {
4410 this.outlineWidget
.connect( this, { 'select': 'onOutlineWidgetSelect' } );
4412 if ( this.autoFocus
) {
4413 // Event 'focus' does not bubble, but 'focusin' does
4414 this.stackLayout
.onDOMEvent( 'focusin', OO
.ui
.bind( this.onStackLayoutFocus
, this ) );
4418 this.$element
.addClass( 'oo-ui-bookletLayout' );
4419 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
4420 if ( this.outlined
) {
4421 this.outlinePanel
.$element
4422 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
4423 .append( this.outlineWidget
.$element
);
4424 if ( this.editable
) {
4425 this.outlinePanel
.$element
4426 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
4427 .append( this.outlineControlsWidget
.$element
);
4429 this.$element
.append( this.gridLayout
.$element
);
4431 this.$element
.append( this.stackLayout
.$element
);
4437 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.Layout
);
4443 * @param {OO.ui.PageLayout} page Current page
4448 * @param {OO.ui.PageLayout[]} page Added pages
4449 * @param {number} index Index pages were added at
4454 * @param {OO.ui.PageLayout[]} pages Removed pages
4460 * Handle stack layout focus.
4462 * @param {jQuery.Event} e Focusin event
4464 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
4467 // Find the page that an element was focused within
4468 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
4469 for ( name
in this.pages
) {
4470 // Check for page match, exclude current page to find only page changes
4471 if ( this.pages
[name
].$element
[0] === $target
[0] && name
!== this.currentPageName
) {
4472 this.setPage( name
);
4479 * Handle stack layout set events.
4481 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
4483 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
4485 page
.scrollElementIntoView( { 'complete': OO
.ui
.bind( function () {
4486 if ( this.autoFocus
) {
4487 // Set focus to the first input if nothing on the page is focused yet
4488 if ( !page
.$element
.find( ':focus' ).length
) {
4489 page
.$element
.find( ':input:first' ).focus();
4497 * Handle outline widget select events.
4499 * @param {OO.ui.OptionWidget|null} item Selected item
4501 OO
.ui
.BookletLayout
.prototype.onOutlineWidgetSelect = function ( item
) {
4503 this.setPage( item
.getData() );
4508 * Check if booklet has an outline.
4512 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
4513 return this.outlined
;
4517 * Check if booklet has editing controls.
4521 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
4522 return this.editable
;
4526 * Check if booklet has a visible outline.
4530 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
4531 return this.outlined
&& this.outlineVisible
;
4535 * Hide or show the outline.
4537 * @param {boolean} [show] Show outline, omit to invert current state
4540 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
4541 if ( this.outlined
) {
4542 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
4543 this.outlineVisible
= show
;
4544 this.gridLayout
.layout( show
? [ 1, 2 ] : [ 0, 1 ], [ 1 ] );
4551 * Get the outline widget.
4553 * @param {OO.ui.PageLayout} page Page to be selected
4554 * @return {OO.ui.PageLayout|null} Closest page to another
4556 OO
.ui
.BookletLayout
.prototype.getClosestPage = function ( page
) {
4557 var next
, prev
, level
,
4558 pages
= this.stackLayout
.getItems(),
4559 index
= $.inArray( page
, pages
);
4561 if ( index
!== -1 ) {
4562 next
= pages
[index
+ 1];
4563 prev
= pages
[index
- 1];
4564 // Prefer adjacent pages at the same level
4565 if ( this.outlined
) {
4566 level
= this.outlineWidget
.getItemFromData( page
.getName() ).getLevel();
4569 level
=== this.outlineWidget
.getItemFromData( prev
.getName() ).getLevel()
4575 level
=== this.outlineWidget
.getItemFromData( next
.getName() ).getLevel()
4581 return prev
|| next
|| null;
4585 * Get the outline widget.
4587 * @return {OO.ui.OutlineWidget|null} Outline widget, or null if boolet has no outline
4589 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
4590 return this.outlineWidget
;
4594 * Get the outline controls widget. If the outline is not editable, null is returned.
4596 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
4598 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
4599 return this.outlineControlsWidget
;
4603 * Get a page by name.
4605 * @param {string} name Symbolic name of page
4606 * @return {OO.ui.PageLayout|undefined} Page, if found
4608 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
4609 return this.pages
[name
];
4613 * Get the current page name.
4615 * @return {string|null} Current page name
4617 OO
.ui
.BookletLayout
.prototype.getPageName = function () {
4618 return this.currentPageName
;
4622 * Add a page to the layout.
4624 * When pages are added with the same names as existing pages, the existing pages will be
4625 * automatically removed before the new pages are added.
4627 * @param {OO.ui.PageLayout[]} pages Pages to add
4628 * @param {number} index Index to insert pages after
4632 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
4633 var i
, len
, name
, page
, item
, currentIndex
,
4634 stackLayoutPages
= this.stackLayout
.getItems(),
4638 // Remove pages with same names
4639 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4641 name
= page
.getName();
4643 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
4644 // Correct the insertion index
4645 currentIndex
= $.inArray( this.pages
[name
], stackLayoutPages
);
4646 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
4649 remove
.push( this.pages
[name
] );
4652 if ( remove
.length
) {
4653 this.removePages( remove
);
4657 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4659 name
= page
.getName();
4660 this.pages
[page
.getName()] = page
;
4661 if ( this.outlined
) {
4662 item
= new OO
.ui
.OutlineItemWidget( name
, page
, { '$': this.$ } );
4663 page
.setOutlineItem( item
);
4668 if ( this.outlined
&& items
.length
) {
4669 this.outlineWidget
.addItems( items
, index
);
4670 this.updateOutlineWidget();
4672 this.stackLayout
.addItems( pages
, index
);
4673 this.emit( 'add', pages
, index
);
4679 * Remove a page from the layout.
4684 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
4685 var i
, len
, name
, page
,
4688 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4690 name
= page
.getName();
4691 delete this.pages
[name
];
4692 if ( this.outlined
) {
4693 items
.push( this.outlineWidget
.getItemFromData( name
) );
4694 page
.setOutlineItem( null );
4697 if ( this.outlined
&& items
.length
) {
4698 this.outlineWidget
.removeItems( items
);
4699 this.updateOutlineWidget();
4701 this.stackLayout
.removeItems( pages
);
4702 this.emit( 'remove', pages
);
4708 * Clear all pages from the layout.
4713 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
4715 pages
= this.stackLayout
.getItems();
4718 this.currentPageName
= null;
4719 if ( this.outlined
) {
4720 this.outlineWidget
.clearItems();
4721 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
4722 pages
[i
].setOutlineItem( null );
4725 this.stackLayout
.clearItems();
4727 this.emit( 'remove', pages
);
4733 * Set the current page by name.
4736 * @param {string} name Symbolic name of page
4738 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
4740 page
= this.pages
[name
];
4742 if ( name
!== this.currentPageName
) {
4743 if ( this.outlined
) {
4744 selectedItem
= this.outlineWidget
.getSelectedItem();
4745 if ( selectedItem
&& selectedItem
.getData() !== name
) {
4746 this.outlineWidget
.selectItem( this.outlineWidget
.getItemFromData( name
) );
4750 if ( this.currentPageName
&& this.pages
[this.currentPageName
] ) {
4751 this.pages
[this.currentPageName
].setActive( false );
4752 // Blur anything focused if the next page doesn't have anything focusable - this
4753 // is not needed if the next page has something focusable because once it is focused
4754 // this blur happens automatically
4755 if ( this.autoFocus
&& !page
.$element
.find( ':input' ).length
) {
4756 this.pages
[this.currentPageName
].$element
.find( ':focus' ).blur();
4759 this.currentPageName
= name
;
4760 this.stackLayout
.setItem( page
);
4761 page
.setActive( true );
4762 this.emit( 'set', page
);
4768 * Call this after adding or removing items from the OutlineWidget.
4772 OO
.ui
.BookletLayout
.prototype.updateOutlineWidget = function () {
4773 // Auto-select first item when nothing is selected anymore
4774 if ( !this.outlineWidget
.getSelectedItem() ) {
4775 this.outlineWidget
.selectItem( this.outlineWidget
.getFirstSelectableItem() );
4781 * Layout that expands to cover the entire area of its parent, with optional scrolling and padding.
4784 * @extends OO.ui.Layout
4787 * @param {Object} [config] Configuration options
4788 * @cfg {boolean} [scrollable] Allow vertical scrolling
4789 * @cfg {boolean} [padded] Pad the content from the edges
4791 OO
.ui
.PanelLayout
= function OoUiPanelLayout( config
) {
4792 // Config initialization
4793 config
= config
|| {};
4795 // Parent constructor
4796 OO
.ui
.PanelLayout
.super.call( this, config
);
4799 this.$element
.addClass( 'oo-ui-panelLayout' );
4800 if ( config
.scrollable
) {
4801 this.$element
.addClass( 'oo-ui-panelLayout-scrollable' );
4804 if ( config
.padded
) {
4805 this.$element
.addClass( 'oo-ui-panelLayout-padded' );
4811 OO
.inheritClass( OO
.ui
.PanelLayout
, OO
.ui
.Layout
);
4813 * Page within an booklet layout.
4816 * @extends OO.ui.PanelLayout
4819 * @param {string} name Unique symbolic name of page
4820 * @param {Object} [config] Configuration options
4821 * @param {string} [outlineItem] Outline item widget
4823 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
4824 // Configuration initialization
4825 config
= $.extend( { 'scrollable': true }, config
);
4827 // Parent constructor
4828 OO
.ui
.PageLayout
.super.call( this, config
);
4832 this.outlineItem
= config
.outlineItem
|| null;
4833 this.active
= false;
4836 this.$element
.addClass( 'oo-ui-pageLayout' );
4841 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
4847 * @param {boolean} active Page is active
4855 * @return {string} Symbolic name of page
4857 OO
.ui
.PageLayout
.prototype.getName = function () {
4862 * Check if page is active.
4864 * @return {boolean} Page is active
4866 OO
.ui
.PageLayout
.prototype.isActive = function () {
4873 * @return {OO.ui.OutlineItemWidget|null} Outline item widget
4875 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
4876 return this.outlineItem
;
4882 * @param {OO.ui.OutlineItemWidget|null} outlineItem Outline item widget, null to clear
4885 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
4886 this.outlineItem
= outlineItem
;
4891 * Set page active state.
4893 * @param {boolean} Page is active
4896 OO
.ui
.PageLayout
.prototype.setActive = function ( active
) {
4899 if ( active
!== this.active
) {
4900 this.active
= active
;
4901 this.$element
.toggleClass( 'oo-ui-pageLayout-active', active
);
4902 this.emit( 'active', this.active
);
4906 * Layout containing a series of mutually exclusive pages.
4909 * @extends OO.ui.PanelLayout
4910 * @mixins OO.ui.GroupElement
4913 * @param {Object} [config] Configuration options
4914 * @cfg {boolean} [continuous=false] Show all pages, one after another
4915 * @cfg {string} [icon=''] Symbolic icon name
4916 * @cfg {OO.ui.Layout[]} [items] Layouts to add
4918 OO
.ui
.StackLayout
= function OoUiStackLayout( config
) {
4919 // Config initialization
4920 config
= $.extend( { 'scrollable': true }, config
);
4922 // Parent constructor
4923 OO
.ui
.StackLayout
.super.call( this, config
);
4925 // Mixin constructors
4926 OO
.ui
.GroupElement
.call( this, this.$element
, config
);
4929 this.currentItem
= null;
4930 this.continuous
= !!config
.continuous
;
4933 this.$element
.addClass( 'oo-ui-stackLayout' );
4934 if ( this.continuous
) {
4935 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
4937 if ( $.isArray( config
.items
) ) {
4938 this.addItems( config
.items
);
4944 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
4945 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.GroupElement
);
4951 * @param {OO.ui.Layout|null} item Current item or null if there is no longer a layout shown
4957 * Get the current item.
4959 * @return {OO.ui.Layout|null}
4961 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
4962 return this.currentItem
;
4966 * Unset the current item.
4969 * @param {OO.ui.StackLayout} layout
4972 OO
.ui
.StackLayout
.prototype.unsetCurrentItem = function () {
4973 var prevItem
= this.currentItem
;
4974 if ( prevItem
=== null ) {
4978 this.currentItem
= null;
4979 this.emit( 'set', null );
4985 * Adding an existing item (by value) will move it.
4987 * @param {OO.ui.Layout[]} items Items to add
4988 * @param {number} [index] Index to insert items after
4991 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
4993 OO
.ui
.GroupElement
.prototype.addItems
.call( this, items
, index
);
4995 if ( !this.currentItem
&& items
.length
) {
4996 this.setItem( items
[0] );
5005 * Items will be detached, not removed, so they can be used later.
5007 * @param {OO.ui.Layout[]} items Items to remove
5011 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
5013 OO
.ui
.GroupElement
.prototype.removeItems
.call( this, items
);
5015 if ( $.inArray( this.currentItem
, items
) !== -1 ) {
5016 if ( this.items
.length
) {
5017 this.setItem( this.items
[0] );
5019 this.unsetCurrentItem();
5029 * Items will be detached, not removed, so they can be used later.
5034 OO
.ui
.StackLayout
.prototype.clearItems = function () {
5035 this.unsetCurrentItem();
5036 OO
.ui
.GroupElement
.prototype.clearItems
.call( this );
5044 * Any currently shown item will be hidden.
5046 * FIXME: If the passed item to show has not been added in the items list, then
5047 * this method drops it and unsets the current item.
5049 * @param {OO.ui.Layout} item Item to show
5053 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
5054 if ( item
!== this.currentItem
) {
5055 if ( !this.continuous
) {
5056 this.$items
.css( 'display', '' );
5058 if ( $.inArray( item
, this.items
) !== -1 ) {
5059 if ( !this.continuous
) {
5060 item
.$element
.css( 'display', 'block' );
5062 this.currentItem
= item
;
5063 this.emit( 'set', item
);
5065 this.unsetCurrentItem();
5072 * Horizontal bar layout of tools as icon buttons.
5075 * @extends OO.ui.ToolGroup
5078 * @param {OO.ui.Toolbar} toolbar
5079 * @param {Object} [config] Configuration options
5081 OO
.ui
.BarToolGroup
= function OoUiBarToolGroup( toolbar
, config
) {
5082 // Parent constructor
5083 OO
.ui
.BarToolGroup
.super.call( this, toolbar
, config
);
5086 this.$element
.addClass( 'oo-ui-barToolGroup' );
5091 OO
.inheritClass( OO
.ui
.BarToolGroup
, OO
.ui
.ToolGroup
);
5093 /* Static Properties */
5095 OO
.ui
.BarToolGroup
.static.titleTooltips
= true;
5097 OO
.ui
.BarToolGroup
.static.accelTooltips
= true;
5099 OO
.ui
.BarToolGroup
.static.name
= 'bar';
5101 * Popup list of tools with an icon and optional label.
5105 * @extends OO.ui.ToolGroup
5106 * @mixins OO.ui.IconedElement
5107 * @mixins OO.ui.IndicatedElement
5108 * @mixins OO.ui.LabeledElement
5109 * @mixins OO.ui.TitledElement
5110 * @mixins OO.ui.ClippableElement
5113 * @param {OO.ui.Toolbar} toolbar
5114 * @param {Object} [config] Configuration options
5115 * @cfg {string} [header] Text to display at the top of the pop-up
5117 OO
.ui
.PopupToolGroup
= function OoUiPopupToolGroup( toolbar
, config
) {
5118 // Configuration initialization
5119 config
= config
|| {};
5121 // Parent constructor
5122 OO
.ui
.PopupToolGroup
.super.call( this, toolbar
, config
);
5124 // Mixin constructors
5125 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
5126 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
5127 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
5128 OO
.ui
.TitledElement
.call( this, this.$element
, config
);
5129 OO
.ui
.ClippableElement
.call( this, this.$group
, config
);
5132 this.active
= false;
5133 this.dragging
= false;
5134 this.onBlurHandler
= OO
.ui
.bind( this.onBlur
, this );
5135 this.$handle
= this.$( '<span>' );
5139 'mousedown': OO
.ui
.bind( this.onHandleMouseDown
, this ),
5140 'mouseup': OO
.ui
.bind( this.onHandleMouseUp
, this )
5145 .addClass( 'oo-ui-popupToolGroup-handle' )
5146 .append( this.$icon
, this.$label
, this.$indicator
);
5147 // If the pop-up should have a header, add it to the top of the toolGroup.
5148 // Note: If this feature is useful for other widgets, we could abstract it into an
5149 // OO.ui.HeaderedElement mixin constructor.
5150 if ( config
.header
!== undefined ) {
5152 .prepend( this.$( '<span>' )
5153 .addClass( 'oo-ui-popupToolGroup-header' )
5154 .text( config
.header
)
5158 .addClass( 'oo-ui-popupToolGroup' )
5159 .prepend( this.$handle
);
5164 OO
.inheritClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ToolGroup
);
5165 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IconedElement
);
5166 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IndicatedElement
);
5167 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.LabeledElement
);
5168 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.TitledElement
);
5169 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ClippableElement
);
5171 /* Static Properties */
5178 OO
.ui
.PopupToolGroup
.prototype.setDisabled = function () {
5180 OO
.ui
.PopupToolGroup
.super.prototype.setDisabled
.apply( this, arguments
);
5182 if ( this.isDisabled() && this.isElementAttached() ) {
5183 this.setActive( false );
5188 * Handle focus being lost.
5190 * The event is actually generated from a mouseup, so it is not a normal blur event object.
5192 * @param {jQuery.Event} e Mouse up event
5194 OO
.ui
.PopupToolGroup
.prototype.onBlur = function ( e
) {
5195 // Only deactivate when clicking outside the dropdown element
5196 if ( this.$( e
.target
).closest( '.oo-ui-popupToolGroup' )[0] !== this.$element
[0] ) {
5197 this.setActive( false );
5204 OO
.ui
.PopupToolGroup
.prototype.onMouseUp = function ( e
) {
5205 if ( !this.isDisabled() && e
.which
=== 1 ) {
5206 this.setActive( false );
5208 return OO
.ui
.PopupToolGroup
.super.prototype.onMouseUp
.call( this, e
);
5212 * Handle mouse up events.
5214 * @param {jQuery.Event} e Mouse up event
5216 OO
.ui
.PopupToolGroup
.prototype.onHandleMouseUp = function () {
5221 * Handle mouse down events.
5223 * @param {jQuery.Event} e Mouse down event
5225 OO
.ui
.PopupToolGroup
.prototype.onHandleMouseDown = function ( e
) {
5226 if ( !this.isDisabled() && e
.which
=== 1 ) {
5227 this.setActive( !this.active
);
5233 * Switch into active mode.
5235 * When active, mouseup events anywhere in the document will trigger deactivation.
5237 OO
.ui
.PopupToolGroup
.prototype.setActive = function ( value
) {
5239 if ( this.active
!== value
) {
5240 this.active
= value
;
5242 this.setClipping( true );
5243 this.$element
.addClass( 'oo-ui-popupToolGroup-active' );
5244 this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler
, true );
5246 this.setClipping( false );
5247 this.$element
.removeClass( 'oo-ui-popupToolGroup-active' );
5248 this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler
, true );
5253 * Drop down list layout of tools as labeled icon buttons.
5256 * @extends OO.ui.PopupToolGroup
5259 * @param {OO.ui.Toolbar} toolbar
5260 * @param {Object} [config] Configuration options
5262 OO
.ui
.ListToolGroup
= function OoUiListToolGroup( toolbar
, config
) {
5263 // Parent constructor
5264 OO
.ui
.ListToolGroup
.super.call( this, toolbar
, config
);
5267 this.$element
.addClass( 'oo-ui-listToolGroup' );
5272 OO
.inheritClass( OO
.ui
.ListToolGroup
, OO
.ui
.PopupToolGroup
);
5274 /* Static Properties */
5276 OO
.ui
.ListToolGroup
.static.accelTooltips
= true;
5278 OO
.ui
.ListToolGroup
.static.name
= 'list';
5280 * Drop down menu layout of tools as selectable menu items.
5283 * @extends OO.ui.PopupToolGroup
5286 * @param {OO.ui.Toolbar} toolbar
5287 * @param {Object} [config] Configuration options
5289 OO
.ui
.MenuToolGroup
= function OoUiMenuToolGroup( toolbar
, config
) {
5290 // Configuration initialization
5291 config
= config
|| {};
5293 // Parent constructor
5294 OO
.ui
.MenuToolGroup
.super.call( this, toolbar
, config
);
5297 this.toolbar
.connect( this, { 'updateState': 'onUpdateState' } );
5300 this.$element
.addClass( 'oo-ui-menuToolGroup' );
5305 OO
.inheritClass( OO
.ui
.MenuToolGroup
, OO
.ui
.PopupToolGroup
);
5307 /* Static Properties */
5309 OO
.ui
.MenuToolGroup
.static.accelTooltips
= true;
5311 OO
.ui
.MenuToolGroup
.static.name
= 'menu';
5316 * Handle the toolbar state being updated.
5318 * When the state changes, the title of each active item in the menu will be joined together and
5319 * used as a label for the group. The label will be empty if none of the items are active.
5321 OO
.ui
.MenuToolGroup
.prototype.onUpdateState = function () {
5325 for ( name
in this.tools
) {
5326 if ( this.tools
[name
].isActive() ) {
5327 labelTexts
.push( this.tools
[name
].getTitle() );
5331 this.setLabel( labelTexts
.join( ', ' ) || ' ' );
5334 * Tool that shows a popup when selected.
5338 * @extends OO.ui.Tool
5339 * @mixins OO.ui.PopuppableElement
5342 * @param {OO.ui.Toolbar} toolbar
5343 * @param {Object} [config] Configuration options
5345 OO
.ui
.PopupTool
= function OoUiPopupTool( toolbar
, config
) {
5346 // Parent constructor
5347 OO
.ui
.PopupTool
.super.call( this, toolbar
, config
);
5349 // Mixin constructors
5350 OO
.ui
.PopuppableElement
.call( this, config
);
5354 .addClass( 'oo-ui-popupTool' )
5355 .append( this.popup
.$element
);
5360 OO
.inheritClass( OO
.ui
.PopupTool
, OO
.ui
.Tool
);
5361 OO
.mixinClass( OO
.ui
.PopupTool
, OO
.ui
.PopuppableElement
);
5366 * Handle the tool being selected.
5370 OO
.ui
.PopupTool
.prototype.onSelect = function () {
5371 if ( !this.isDisabled() ) {
5372 if ( this.popup
.isVisible() ) {
5378 this.setActive( false );
5383 * Handle the toolbar state being updated.
5387 OO
.ui
.PopupTool
.prototype.onUpdateState = function () {
5388 this.setActive( false );
5393 * Mixin for OO.ui.Widget subclasses.
5395 * Use together with OO.ui.ItemWidget to make disabled state inheritable.
5399 * @extends OO.ui.GroupElement
5402 * @param {jQuery} $group Container node, assigned to #$group
5403 * @param {Object} [config] Configuration options
5405 OO
.ui
.GroupWidget
= function OoUiGroupWidget( $element
, config
) {
5406 // Parent constructor
5407 OO
.ui
.GroupWidget
.super.call( this, $element
, config
);
5412 OO
.inheritClass( OO
.ui
.GroupWidget
, OO
.ui
.GroupElement
);
5417 * Set the disabled state of the widget.
5419 * This will also update the disabled state of child widgets.
5421 * @param {boolean} disabled Disable widget
5424 OO
.ui
.GroupWidget
.prototype.setDisabled = function ( disabled
) {
5428 // Note: Calling #setDisabled this way assumes this is mixed into an OO.ui.Widget
5429 OO
.ui
.Widget
.prototype.setDisabled
.call( this, disabled
);
5431 // During construction, #setDisabled is called before the OO.ui.GroupElement constructor
5433 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
5434 this.items
[i
].updateDisabled();
5443 * Use together with OO.ui.GroupWidget to make disabled state inheritable.
5450 OO
.ui
.ItemWidget
= function OoUiItemWidget() {
5457 * Check if widget is disabled.
5459 * Checks parent if present, making disabled state inheritable.
5461 * @return {boolean} Widget is disabled
5463 OO
.ui
.ItemWidget
.prototype.isDisabled = function () {
5464 return this.disabled
||
5465 ( this.elementGroup
instanceof OO
.ui
.Widget
&& this.elementGroup
.isDisabled() );
5469 * Set group element is in.
5471 * @param {OO.ui.GroupElement|null} group Group element, null if none
5474 OO
.ui
.ItemWidget
.prototype.setElementGroup = function ( group
) {
5476 // Note: Calling #setElementGroup this way assumes this is mixed into an OO.ui.Element
5477 OO
.ui
.Element
.prototype.setElementGroup
.call( this, group
);
5479 // Initialize item disabled states
5480 this.updateDisabled();
5488 * @extends OO.ui.Widget
5489 * @mixins OO.ui.IconedElement
5490 * @mixins OO.ui.TitledElement
5493 * @param {Object} [config] Configuration options
5495 OO
.ui
.IconWidget
= function OoUiIconWidget( config
) {
5496 // Config intialization
5497 config
= config
|| {};
5499 // Parent constructor
5500 OO
.ui
.IconWidget
.super.call( this, config
);
5502 // Mixin constructors
5503 OO
.ui
.IconedElement
.call( this, this.$element
, config
);
5504 OO
.ui
.TitledElement
.call( this, this.$element
, config
);
5507 this.$element
.addClass( 'oo-ui-iconWidget' );
5512 OO
.inheritClass( OO
.ui
.IconWidget
, OO
.ui
.Widget
);
5513 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.IconedElement
);
5514 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.TitledElement
);
5516 /* Static Properties */
5518 OO
.ui
.IconWidget
.static.tagName
= 'span';
5523 * @extends OO.ui.Widget
5524 * @mixins OO.ui.IndicatedElement
5525 * @mixins OO.ui.TitledElement
5528 * @param {Object} [config] Configuration options
5530 OO
.ui
.IndicatorWidget
= function OoUiIndicatorWidget( config
) {
5531 // Config intialization
5532 config
= config
|| {};
5534 // Parent constructor
5535 OO
.ui
.IndicatorWidget
.super.call( this, config
);
5537 // Mixin constructors
5538 OO
.ui
.IndicatedElement
.call( this, this.$element
, config
);
5539 OO
.ui
.TitledElement
.call( this, this.$element
, config
);
5542 this.$element
.addClass( 'oo-ui-indicatorWidget' );
5547 OO
.inheritClass( OO
.ui
.IndicatorWidget
, OO
.ui
.Widget
);
5548 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.IndicatedElement
);
5549 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.TitledElement
);
5551 /* Static Properties */
5553 OO
.ui
.IndicatorWidget
.static.tagName
= 'span';
5555 * Container for multiple related buttons.
5557 * Use together with OO.ui.ButtonWidget.
5560 * @extends OO.ui.Widget
5561 * @mixins OO.ui.GroupElement
5564 * @param {Object} [config] Configuration options
5565 * @cfg {OO.ui.ButtonWidget} [items] Buttons to add
5567 OO
.ui
.ButtonGroupWidget
= function OoUiButtonGroupWidget( config
) {
5568 // Parent constructor
5569 OO
.ui
.ButtonGroupWidget
.super.call( this, config
);
5571 // Mixin constructors
5572 OO
.ui
.GroupElement
.call( this, this.$element
, config
);
5575 this.$element
.addClass( 'oo-ui-buttonGroupWidget' );
5576 if ( $.isArray( config
.items
) ) {
5577 this.addItems( config
.items
);
5583 OO
.inheritClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.Widget
);
5584 OO
.mixinClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.GroupElement
);
5589 * @extends OO.ui.Widget
5590 * @mixins OO.ui.ButtonedElement
5591 * @mixins OO.ui.IconedElement
5592 * @mixins OO.ui.IndicatedElement
5593 * @mixins OO.ui.LabeledElement
5594 * @mixins OO.ui.TitledElement
5595 * @mixins OO.ui.FlaggableElement
5598 * @param {Object} [config] Configuration options
5599 * @cfg {string} [title=''] Title text
5600 * @cfg {string} [href] Hyperlink to visit when clicked
5601 * @cfg {string} [target] Target to open hyperlink in
5603 OO
.ui
.ButtonWidget
= function OoUiButtonWidget( config
) {
5604 // Configuration initialization
5605 config
= $.extend( { 'target': '_blank' }, config
);
5607 // Parent constructor
5608 OO
.ui
.ButtonWidget
.super.call( this, config
);
5610 // Mixin constructors
5611 OO
.ui
.ButtonedElement
.call( this, this.$( '<a>' ), config
);
5612 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
5613 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
5614 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
5615 OO
.ui
.TitledElement
.call( this, this.$button
, config
);
5616 OO
.ui
.FlaggableElement
.call( this, config
);
5619 this.isHyperlink
= typeof config
.href
=== 'string';
5623 'click': OO
.ui
.bind( this.onClick
, this ),
5624 'keypress': OO
.ui
.bind( this.onKeyPress
, this )
5629 .append( this.$icon
, this.$label
, this.$indicator
)
5630 .attr( { 'href': config
.href
, 'target': config
.target
} );
5632 .addClass( 'oo-ui-buttonWidget' )
5633 .append( this.$button
);
5638 OO
.inheritClass( OO
.ui
.ButtonWidget
, OO
.ui
.Widget
);
5639 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.ButtonedElement
);
5640 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IconedElement
);
5641 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IndicatedElement
);
5642 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.LabeledElement
);
5643 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.TitledElement
);
5644 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.FlaggableElement
);
5655 * Handles mouse click events.
5657 * @param {jQuery.Event} e Mouse click event
5660 OO
.ui
.ButtonWidget
.prototype.onClick = function () {
5661 if ( !this.isDisabled() ) {
5662 this.emit( 'click' );
5663 if ( this.isHyperlink
) {
5671 * Handles keypress events.
5673 * @param {jQuery.Event} e Keypress event
5676 OO
.ui
.ButtonWidget
.prototype.onKeyPress = function ( e
) {
5677 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
5679 if ( this.isHyperlink
) {
5690 * @extends OO.ui.Widget
5693 * @param {Object} [config] Configuration options
5694 * @cfg {string} [name=''] HTML input name
5695 * @cfg {string} [value=''] Input value
5696 * @cfg {boolean} [readOnly=false] Prevent changes
5697 * @cfg {Function} [inputFilter] Filter function to apply to the input. Takes a string argument and returns a string.
5699 OO
.ui
.InputWidget
= function OoUiInputWidget( config
) {
5700 // Config intialization
5701 config
= $.extend( { 'readOnly': false }, config
);
5703 // Parent constructor
5704 OO
.ui
.InputWidget
.super.call( this, config
);
5707 this.$input
= this.getInputElement( config
);
5709 this.readOnly
= false;
5710 this.inputFilter
= config
.inputFilter
;
5713 this.$input
.on( 'keydown mouseup cut paste change input select', OO
.ui
.bind( this.onEdit
, this ) );
5717 .attr( 'name', config
.name
)
5718 .prop( 'disabled', this.isDisabled() );
5719 this.setReadOnly( config
.readOnly
);
5720 this.$element
.addClass( 'oo-ui-inputWidget' ).append( this.$input
);
5721 this.setValue( config
.value
);
5726 OO
.inheritClass( OO
.ui
.InputWidget
, OO
.ui
.Widget
);
5738 * Get input element.
5740 * @param {Object} [config] Configuration options
5741 * @return {jQuery} Input element
5743 OO
.ui
.InputWidget
.prototype.getInputElement = function () {
5744 return this.$( '<input>' );
5748 * Handle potentially value-changing events.
5750 * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
5752 OO
.ui
.InputWidget
.prototype.onEdit = function () {
5753 if ( !this.isDisabled() ) {
5754 // Allow the stack to clear so the value will be updated
5755 setTimeout( OO
.ui
.bind( function () {
5756 this.setValue( this.$input
.val() );
5762 * Get the value of the input.
5764 * @return {string} Input value
5766 OO
.ui
.InputWidget
.prototype.getValue = function () {
5771 * Sets the direction of the current input, either RTL or LTR
5773 * @param {boolean} isRTL
5775 OO
.ui
.InputWidget
.prototype.setRTL = function ( isRTL
) {
5777 this.$input
.removeClass( 'oo-ui-ltr' );
5778 this.$input
.addClass( 'oo-ui-rtl' );
5780 this.$input
.removeClass( 'oo-ui-rtl' );
5781 this.$input
.addClass( 'oo-ui-ltr' );
5786 * Set the value of the input.
5788 * @param {string} value New value
5792 OO
.ui
.InputWidget
.prototype.setValue = function ( value
) {
5793 value
= this.sanitizeValue( value
);
5794 if ( this.value
!== value
) {
5796 this.emit( 'change', this.value
);
5798 // Update the DOM if it has changed. Note that with sanitizeValue, it
5799 // is possible for the DOM value to change without this.value changing.
5800 if ( this.$input
.val() !== this.value
) {
5801 this.$input
.val( this.value
);
5807 * Sanitize incoming value.
5809 * Ensures value is a string, and converts undefined and null to empty strings.
5811 * @param {string} value Original value
5812 * @return {string} Sanitized value
5814 OO
.ui
.InputWidget
.prototype.sanitizeValue = function ( value
) {
5815 if ( value
=== undefined || value
=== null ) {
5817 } else if ( this.inputFilter
) {
5818 return this.inputFilter( String( value
) );
5820 return String( value
);
5825 * Simulate the behavior of clicking on a label bound to this input.
5827 OO
.ui
.InputWidget
.prototype.simulateLabelClick = function () {
5828 if ( !this.isDisabled() ) {
5829 if ( this.$input
.is( ':checkbox,:radio' ) ) {
5830 this.$input
.click();
5831 } else if ( this.$input
.is( ':input' ) ) {
5832 this.$input
.focus();
5838 * Check if the widget is read-only.
5842 OO
.ui
.InputWidget
.prototype.isReadOnly = function () {
5843 return this.readOnly
;
5847 * Set the read-only state of the widget.
5849 * This should probably change the widgets's appearance and prevent it from being used.
5851 * @param {boolean} state Make input read-only
5854 OO
.ui
.InputWidget
.prototype.setReadOnly = function ( state
) {
5855 this.readOnly
= !!state
;
5856 this.$input
.prop( 'readOnly', this.readOnly
);
5863 OO
.ui
.InputWidget
.prototype.setDisabled = function ( state
) {
5864 OO
.ui
.InputWidget
.super.prototype.setDisabled
.call( this, state
);
5865 if ( this.$input
) {
5866 this.$input
.prop( 'disabled', this.isDisabled() );
5876 OO
.ui
.InputWidget
.prototype.focus = function () {
5877 this.$input
.focus();
5884 * @extends OO.ui.InputWidget
5887 * @param {Object} [config] Configuration options
5889 OO
.ui
.CheckboxInputWidget
= function OoUiCheckboxInputWidget( config
) {
5890 // Parent constructor
5891 OO
.ui
.CheckboxInputWidget
.super.call( this, config
);
5894 this.$element
.addClass( 'oo-ui-checkboxInputWidget' );
5899 OO
.inheritClass( OO
.ui
.CheckboxInputWidget
, OO
.ui
.InputWidget
);
5906 * Get input element.
5908 * @return {jQuery} Input element
5910 OO
.ui
.CheckboxInputWidget
.prototype.getInputElement = function () {
5911 return this.$( '<input type="checkbox" />' );
5915 * Get checked state of the checkbox
5917 * @return {boolean} If the checkbox is checked
5919 OO
.ui
.CheckboxInputWidget
.prototype.getValue = function () {
5926 OO
.ui
.CheckboxInputWidget
.prototype.setValue = function ( value
) {
5928 if ( this.value
!== value
) {
5930 this.$input
.prop( 'checked', this.value
);
5931 this.emit( 'change', this.value
);
5938 OO
.ui
.CheckboxInputWidget
.prototype.onEdit = function () {
5939 if ( !this.isDisabled() ) {
5940 // Allow the stack to clear so the value will be updated
5941 setTimeout( OO
.ui
.bind( function () {
5942 this.setValue( this.$input
.prop( 'checked' ) );
5950 * @extends OO.ui.Widget
5951 * @mixins OO.ui.LabeledElement
5954 * @param {Object} [config] Configuration options
5956 OO
.ui
.LabelWidget
= function OoUiLabelWidget( config
) {
5957 // Config intialization
5958 config
= config
|| {};
5960 // Parent constructor
5961 OO
.ui
.LabelWidget
.super.call( this, config
);
5963 // Mixin constructors
5964 OO
.ui
.LabeledElement
.call( this, this.$element
, config
);
5967 this.input
= config
.input
;
5970 if ( this.input
instanceof OO
.ui
.InputWidget
) {
5971 this.$element
.on( 'click', OO
.ui
.bind( this.onClick
, this ) );
5975 this.$element
.addClass( 'oo-ui-labelWidget' );
5980 OO
.inheritClass( OO
.ui
.LabelWidget
, OO
.ui
.Widget
);
5981 OO
.mixinClass( OO
.ui
.LabelWidget
, OO
.ui
.LabeledElement
);
5983 /* Static Properties */
5985 OO
.ui
.LabelWidget
.static.tagName
= 'label';
5990 * Handles label mouse click events.
5992 * @param {jQuery.Event} e Mouse click event
5994 OO
.ui
.LabelWidget
.prototype.onClick = function () {
5995 this.input
.simulateLabelClick();
5999 * Lookup input widget.
6001 * Mixin that adds a menu showing suggested values to a text input. Subclasses must handle `select`
6002 * and `choose` events on #lookupMenu to make use of selections.
6008 * @param {OO.ui.TextInputWidget} input Input widget
6009 * @param {Object} [config] Configuration options
6010 * @cfg {jQuery} [$overlay=this.$( 'body' )] Overlay layer
6012 OO
.ui
.LookupInputWidget
= function OoUiLookupInputWidget( input
, config
) {
6013 // Config intialization
6014 config
= config
|| {};
6017 this.lookupInput
= input
;
6018 this.$overlay
= config
.$overlay
|| this.$( 'body,.oo-ui-window-overlay' ).last();
6019 this.lookupMenu
= new OO
.ui
.TextInputMenuWidget( this, {
6020 '$': OO
.ui
.Element
.getJQuery( this.$overlay
),
6021 'input': this.lookupInput
,
6022 '$container': config
.$container
6024 this.lookupCache
= {};
6025 this.lookupQuery
= null;
6026 this.lookupRequest
= null;
6027 this.populating
= false;
6030 this.$overlay
.append( this.lookupMenu
.$element
);
6032 this.lookupInput
.$input
.on( {
6033 'focus': OO
.ui
.bind( this.onLookupInputFocus
, this ),
6034 'blur': OO
.ui
.bind( this.onLookupInputBlur
, this ),
6035 'mousedown': OO
.ui
.bind( this.onLookupInputMouseDown
, this )
6037 this.lookupInput
.connect( this, { 'change': 'onLookupInputChange' } );
6040 this.$element
.addClass( 'oo-ui-lookupWidget' );
6041 this.lookupMenu
.$element
.addClass( 'oo-ui-lookupWidget-menu' );
6047 * Handle input focus event.
6049 * @param {jQuery.Event} e Input focus event
6051 OO
.ui
.LookupInputWidget
.prototype.onLookupInputFocus = function () {
6052 this.openLookupMenu();
6056 * Handle input blur event.
6058 * @param {jQuery.Event} e Input blur event
6060 OO
.ui
.LookupInputWidget
.prototype.onLookupInputBlur = function () {
6061 this.lookupMenu
.hide();
6065 * Handle input mouse down event.
6067 * @param {jQuery.Event} e Input mouse down event
6069 OO
.ui
.LookupInputWidget
.prototype.onLookupInputMouseDown = function () {
6070 this.openLookupMenu();
6074 * Handle input change event.
6076 * @param {string} value New input value
6078 OO
.ui
.LookupInputWidget
.prototype.onLookupInputChange = function () {
6079 this.openLookupMenu();
6085 * @return {OO.ui.TextInputMenuWidget}
6087 OO
.ui
.LookupInputWidget
.prototype.getLookupMenu = function () {
6088 return this.lookupMenu
;
6096 OO
.ui
.LookupInputWidget
.prototype.openLookupMenu = function () {
6097 var value
= this.lookupInput
.getValue();
6099 if ( this.lookupMenu
.$input
.is( ':focus' ) && $.trim( value
) !== '' ) {
6100 this.populateLookupMenu();
6101 if ( !this.lookupMenu
.isVisible() ) {
6102 this.lookupMenu
.show();
6105 this.lookupMenu
.clearItems();
6106 this.lookupMenu
.hide();
6113 * Populate lookup menu with current information.
6117 OO
.ui
.LookupInputWidget
.prototype.populateLookupMenu = function () {
6118 if ( !this.populating
) {
6119 this.populating
= true;
6120 this.getLookupMenuItems()
6121 .done( OO
.ui
.bind( function ( items
) {
6122 this.lookupMenu
.clearItems();
6123 if ( items
.length
) {
6124 this.lookupMenu
.show();
6125 this.lookupMenu
.addItems( items
);
6126 this.initializeLookupMenuSelection();
6127 this.openLookupMenu();
6129 this.lookupMenu
.hide();
6131 this.populating
= false;
6133 .fail( OO
.ui
.bind( function () {
6134 this.lookupMenu
.clearItems();
6135 this.populating
= false;
6143 * Set selection in the lookup menu with current information.
6147 OO
.ui
.LookupInputWidget
.prototype.initializeLookupMenuSelection = function () {
6148 if ( !this.lookupMenu
.getSelectedItem() ) {
6149 this.lookupMenu
.selectItem( this.lookupMenu
.getFirstSelectableItem() );
6151 this.lookupMenu
.highlightItem( this.lookupMenu
.getSelectedItem() );
6155 * Get lookup menu items for the current query.
6157 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument
6160 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItems = function () {
6161 var value
= this.lookupInput
.getValue(),
6162 deferred
= $.Deferred();
6164 if ( value
&& value
!== this.lookupQuery
) {
6165 // Abort current request if query has changed
6166 if ( this.lookupRequest
) {
6167 this.lookupRequest
.abort();
6168 this.lookupQuery
= null;
6169 this.lookupRequest
= null;
6171 if ( value
in this.lookupCache
) {
6172 deferred
.resolve( this.getLookupMenuItemsFromData( this.lookupCache
[value
] ) );
6174 this.lookupQuery
= value
;
6175 this.lookupRequest
= this.getLookupRequest()
6176 .always( OO
.ui
.bind( function () {
6177 this.lookupQuery
= null;
6178 this.lookupRequest
= null;
6180 .done( OO
.ui
.bind( function ( data
) {
6181 this.lookupCache
[value
] = this.getLookupCacheItemFromData( data
);
6182 deferred
.resolve( this.getLookupMenuItemsFromData( this.lookupCache
[value
] ) );
6184 .fail( function () {
6188 this.lookupRequest
.always( OO
.ui
.bind( function () {
6193 return deferred
.promise();
6197 * Get a new request object of the current lookup query value.
6200 * @return {jqXHR} jQuery AJAX object, or promise object with an .abort() method
6202 OO
.ui
.LookupInputWidget
.prototype.getLookupRequest = function () {
6203 // Stub, implemented in subclass
6208 * Handle successful lookup request.
6210 * Overriding methods should call #populateLookupMenu when results are available and cache results
6211 * for future lookups in #lookupCache as an array of #OO.ui.MenuItemWidget objects.
6214 * @param {Mixed} data Response from server
6216 OO
.ui
.LookupInputWidget
.prototype.onLookupRequestDone = function () {
6217 // Stub, implemented in subclass
6221 * Get a list of menu item widgets from the data stored by the lookup request's done handler.
6224 * @param {Mixed} data Cached result data, usually an array
6225 * @return {OO.ui.MenuItemWidget[]} Menu items
6227 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItemsFromData = function () {
6228 // Stub, implemented in subclass
6234 * Use with OO.ui.SelectWidget.
6237 * @extends OO.ui.Widget
6238 * @mixins OO.ui.IconedElement
6239 * @mixins OO.ui.LabeledElement
6240 * @mixins OO.ui.IndicatedElement
6241 * @mixins OO.ui.FlaggableElement
6244 * @param {Mixed} data Option data
6245 * @param {Object} [config] Configuration options
6246 * @cfg {string} [rel] Value for `rel` attribute in DOM, allowing per-option styling
6248 OO
.ui
.OptionWidget
= function OoUiOptionWidget( data
, config
) {
6249 // Config intialization
6250 config
= config
|| {};
6252 // Parent constructor
6253 OO
.ui
.OptionWidget
.super.call( this, config
);
6255 // Mixin constructors
6256 OO
.ui
.ItemWidget
.call( this );
6257 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
6258 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
6259 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
6260 OO
.ui
.FlaggableElement
.call( this, config
);
6264 this.selected
= false;
6265 this.highlighted
= false;
6266 this.pressed
= false;
6270 .data( 'oo-ui-optionWidget', this )
6271 .attr( 'rel', config
.rel
)
6272 .addClass( 'oo-ui-optionWidget' )
6273 .append( this.$label
);
6275 .prepend( this.$icon
)
6276 .append( this.$indicator
);
6281 OO
.inheritClass( OO
.ui
.OptionWidget
, OO
.ui
.Widget
);
6282 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.ItemWidget
);
6283 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IconedElement
);
6284 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.LabeledElement
);
6285 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IndicatedElement
);
6286 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.FlaggableElement
);
6288 /* Static Properties */
6290 OO
.ui
.OptionWidget
.static.tagName
= 'li';
6292 OO
.ui
.OptionWidget
.static.selectable
= true;
6294 OO
.ui
.OptionWidget
.static.highlightable
= true;
6296 OO
.ui
.OptionWidget
.static.pressable
= true;
6298 OO
.ui
.OptionWidget
.static.scrollIntoViewOnSelect
= false;
6303 * Check if option can be selected.
6305 * @return {boolean} Item is selectable
6307 OO
.ui
.OptionWidget
.prototype.isSelectable = function () {
6308 return this.constructor.static.selectable
&& !this.isDisabled();
6312 * Check if option can be highlighted.
6314 * @return {boolean} Item is highlightable
6316 OO
.ui
.OptionWidget
.prototype.isHighlightable = function () {
6317 return this.constructor.static.highlightable
&& !this.isDisabled();
6321 * Check if option can be pressed.
6323 * @return {boolean} Item is pressable
6325 OO
.ui
.OptionWidget
.prototype.isPressable = function () {
6326 return this.constructor.static.pressable
&& !this.isDisabled();
6330 * Check if option is selected.
6332 * @return {boolean} Item is selected
6334 OO
.ui
.OptionWidget
.prototype.isSelected = function () {
6335 return this.selected
;
6339 * Check if option is highlighted.
6341 * @return {boolean} Item is highlighted
6343 OO
.ui
.OptionWidget
.prototype.isHighlighted = function () {
6344 return this.highlighted
;
6348 * Check if option is pressed.
6350 * @return {boolean} Item is pressed
6352 OO
.ui
.OptionWidget
.prototype.isPressed = function () {
6353 return this.pressed
;
6357 * Set selected state.
6359 * @param {boolean} [state=false] Select option
6362 OO
.ui
.OptionWidget
.prototype.setSelected = function ( state
) {
6363 if ( !this.isDisabled() && this.constructor.static.selectable
) {
6364 this.selected
= !!state
;
6365 if ( this.selected
) {
6366 this.$element
.addClass( 'oo-ui-optionWidget-selected' );
6367 if ( this.constructor.static.scrollIntoViewOnSelect
) {
6368 this.scrollElementIntoView();
6371 this.$element
.removeClass( 'oo-ui-optionWidget-selected' );
6378 * Set highlighted state.
6380 * @param {boolean} [state=false] Highlight option
6383 OO
.ui
.OptionWidget
.prototype.setHighlighted = function ( state
) {
6384 if ( !this.isDisabled() && this.constructor.static.highlightable
) {
6385 this.highlighted
= !!state
;
6386 if ( this.highlighted
) {
6387 this.$element
.addClass( 'oo-ui-optionWidget-highlighted' );
6389 this.$element
.removeClass( 'oo-ui-optionWidget-highlighted' );
6396 * Set pressed state.
6398 * @param {boolean} [state=false] Press option
6401 OO
.ui
.OptionWidget
.prototype.setPressed = function ( state
) {
6402 if ( !this.isDisabled() && this.constructor.static.pressable
) {
6403 this.pressed
= !!state
;
6404 if ( this.pressed
) {
6405 this.$element
.addClass( 'oo-ui-optionWidget-pressed' );
6407 this.$element
.removeClass( 'oo-ui-optionWidget-pressed' );
6414 * Make the option's highlight flash.
6416 * While flashing, the visual style of the pressed state is removed if present.
6418 * @return {jQuery.Promise} Promise resolved when flashing is done
6420 OO
.ui
.OptionWidget
.prototype.flash = function () {
6421 var $this = this.$element
,
6422 deferred
= $.Deferred();
6424 if ( !this.isDisabled() && this.constructor.static.pressable
) {
6425 $this.removeClass( 'oo-ui-optionWidget-highlighted oo-ui-optionWidget-pressed' );
6426 setTimeout( OO
.ui
.bind( function () {
6427 // Restore original classes
6429 .toggleClass( 'oo-ui-optionWidget-highlighted', this.highlighted
)
6430 .toggleClass( 'oo-ui-optionWidget-pressed', this.pressed
);
6431 setTimeout( function () {
6437 return deferred
.promise();
6443 * @return {Mixed} Option data
6445 OO
.ui
.OptionWidget
.prototype.getData = function () {
6449 * Selection of options.
6451 * Use together with OO.ui.OptionWidget.
6454 * @extends OO.ui.Widget
6455 * @mixins OO.ui.GroupElement
6458 * @param {Object} [config] Configuration options
6459 * @cfg {OO.ui.OptionWidget[]} [items] Options to add
6461 OO
.ui
.SelectWidget
= function OoUiSelectWidget( config
) {
6462 // Config intialization
6463 config
= config
|| {};
6465 // Parent constructor
6466 OO
.ui
.SelectWidget
.super.call( this, config
);
6468 // Mixin constructors
6469 OO
.ui
.GroupWidget
.call( this, this.$element
, config
);
6472 this.pressed
= false;
6473 this.selecting
= null;
6475 this.onMouseUpHandler
= OO
.ui
.bind( this.onMouseUp
, this );
6476 this.onMouseMoveHandler
= OO
.ui
.bind( this.onMouseMove
, this );
6480 'mousedown': OO
.ui
.bind( this.onMouseDown
, this ),
6481 'mouseover': OO
.ui
.bind( this.onMouseOver
, this ),
6482 'mouseleave': OO
.ui
.bind( this.onMouseLeave
, this )
6486 this.$element
.addClass( 'oo-ui-selectWidget oo-ui-selectWidget-depressed' );
6487 if ( $.isArray( config
.items
) ) {
6488 this.addItems( config
.items
);
6494 OO
.inheritClass( OO
.ui
.SelectWidget
, OO
.ui
.Widget
);
6496 // Need to mixin base class as well
6497 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupElement
);
6498 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupWidget
);
6504 * @param {OO.ui.OptionWidget|null} item Highlighted item
6509 * @param {OO.ui.OptionWidget|null} item Pressed item
6514 * @param {OO.ui.OptionWidget|null} item Selected item
6519 * @param {OO.ui.OptionWidget|null} item Chosen item
6524 * @param {OO.ui.OptionWidget[]} items Added items
6525 * @param {number} index Index items were added at
6530 * @param {OO.ui.OptionWidget[]} items Removed items
6533 /* Static Properties */
6535 OO
.ui
.SelectWidget
.static.tagName
= 'ul';
6540 * Handle mouse down events.
6543 * @param {jQuery.Event} e Mouse down event
6545 OO
.ui
.SelectWidget
.prototype.onMouseDown = function ( e
) {
6548 if ( !this.isDisabled() && e
.which
=== 1 ) {
6549 this.togglePressed( true );
6550 item
= this.getTargetItem( e
);
6551 if ( item
&& item
.isSelectable() ) {
6552 this.pressItem( item
);
6553 this.selecting
= item
;
6554 this.getElementDocument().addEventListener(
6555 'mouseup', this.onMouseUpHandler
, true
6557 this.getElementDocument().addEventListener(
6558 'mousemove', this.onMouseMoveHandler
, true
6566 * Handle mouse up events.
6569 * @param {jQuery.Event} e Mouse up event
6571 OO
.ui
.SelectWidget
.prototype.onMouseUp = function ( e
) {
6574 this.togglePressed( false );
6575 if ( !this.selecting
) {
6576 item
= this.getTargetItem( e
);
6577 if ( item
&& item
.isSelectable() ) {
6578 this.selecting
= item
;
6581 if ( !this.isDisabled() && e
.which
=== 1 && this.selecting
) {
6582 this.pressItem( null );
6583 this.chooseItem( this.selecting
);
6584 this.selecting
= null;
6587 this.getElementDocument().removeEventListener(
6588 'mouseup', this.onMouseUpHandler
, true
6590 this.getElementDocument().removeEventListener(
6591 'mousemove', this.onMouseMoveHandler
, true
6598 * Handle mouse move events.
6601 * @param {jQuery.Event} e Mouse move event
6603 OO
.ui
.SelectWidget
.prototype.onMouseMove = function ( e
) {
6606 if ( !this.isDisabled() && this.pressed
) {
6607 item
= this.getTargetItem( e
);
6608 if ( item
&& item
!== this.selecting
&& item
.isSelectable() ) {
6609 this.pressItem( item
);
6610 this.selecting
= item
;
6617 * Handle mouse over events.
6620 * @param {jQuery.Event} e Mouse over event
6622 OO
.ui
.SelectWidget
.prototype.onMouseOver = function ( e
) {
6625 if ( !this.isDisabled() ) {
6626 item
= this.getTargetItem( e
);
6627 this.highlightItem( item
&& item
.isHighlightable() ? item
: null );
6633 * Handle mouse leave events.
6636 * @param {jQuery.Event} e Mouse over event
6638 OO
.ui
.SelectWidget
.prototype.onMouseLeave = function () {
6639 if ( !this.isDisabled() ) {
6640 this.highlightItem( null );
6646 * Get the closest item to a jQuery.Event.
6649 * @param {jQuery.Event} e
6650 * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
6652 OO
.ui
.SelectWidget
.prototype.getTargetItem = function ( e
) {
6653 var $item
= this.$( e
.target
).closest( '.oo-ui-optionWidget' );
6654 if ( $item
.length
) {
6655 return $item
.data( 'oo-ui-optionWidget' );
6661 * Get selected item.
6663 * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
6665 OO
.ui
.SelectWidget
.prototype.getSelectedItem = function () {
6668 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6669 if ( this.items
[i
].isSelected() ) {
6670 return this.items
[i
];
6677 * Get highlighted item.
6679 * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
6681 OO
.ui
.SelectWidget
.prototype.getHighlightedItem = function () {
6684 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6685 if ( this.items
[i
].isHighlighted() ) {
6686 return this.items
[i
];
6693 * Get an existing item with equivilant data.
6695 * @param {Object} data Item data to search for
6696 * @return {OO.ui.OptionWidget|null} Item with equivilent value, `null` if none exists
6698 OO
.ui
.SelectWidget
.prototype.getItemFromData = function ( data
) {
6699 var hash
= OO
.getHash( data
);
6701 if ( hash
in this.hashes
) {
6702 return this.hashes
[hash
];
6709 * Toggle pressed state.
6711 * @param {boolean} pressed An option is being pressed
6713 OO
.ui
.SelectWidget
.prototype.togglePressed = function ( pressed
) {
6714 if ( pressed
=== undefined ) {
6715 pressed
= !this.pressed
;
6717 if ( pressed
!== this.pressed
) {
6718 this.$element
.toggleClass( 'oo-ui-selectWidget-pressed', pressed
);
6719 this.$element
.toggleClass( 'oo-ui-selectWidget-depressed', !pressed
);
6720 this.pressed
= pressed
;
6725 * Highlight an item.
6727 * Highlighting is mutually exclusive.
6729 * @param {OO.ui.OptionWidget} [item] Item to highlight, omit to deselect all
6733 OO
.ui
.SelectWidget
.prototype.highlightItem = function ( item
) {
6734 var i
, len
, highlighted
,
6737 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6738 highlighted
= this.items
[i
] === item
;
6739 if ( this.items
[i
].isHighlighted() !== highlighted
) {
6740 this.items
[i
].setHighlighted( highlighted
);
6745 this.emit( 'highlight', item
);
6754 * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
6758 OO
.ui
.SelectWidget
.prototype.selectItem = function ( item
) {
6759 var i
, len
, selected
,
6762 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6763 selected
= this.items
[i
] === item
;
6764 if ( this.items
[i
].isSelected() !== selected
) {
6765 this.items
[i
].setSelected( selected
);
6770 this.emit( 'select', item
);
6779 * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
6783 OO
.ui
.SelectWidget
.prototype.pressItem = function ( item
) {
6784 var i
, len
, pressed
,
6787 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6788 pressed
= this.items
[i
] === item
;
6789 if ( this.items
[i
].isPressed() !== pressed
) {
6790 this.items
[i
].setPressed( pressed
);
6795 this.emit( 'press', item
);
6804 * Identical to #selectItem, but may vary in subclasses that want to take additional action when
6805 * an item is selected using the keyboard or mouse.
6807 * @param {OO.ui.OptionWidget} item Item to choose
6811 OO
.ui
.SelectWidget
.prototype.chooseItem = function ( item
) {
6812 this.selectItem( item
);
6813 this.emit( 'choose', item
);
6819 * Get an item relative to another one.
6821 * @param {OO.ui.OptionWidget} item Item to start at
6822 * @param {number} direction Direction to move in
6823 * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the menu
6825 OO
.ui
.SelectWidget
.prototype.getRelativeSelectableItem = function ( item
, direction
) {
6826 var inc
= direction
> 0 ? 1 : -1,
6827 len
= this.items
.length
,
6828 index
= item
instanceof OO
.ui
.OptionWidget
?
6829 $.inArray( item
, this.items
) : ( inc
> 0 ? -1 : 0 ),
6830 stopAt
= Math
.max( Math
.min( index
, len
- 1 ), 0 ),
6832 // Default to 0 instead of -1, if nothing is selected let's start at the beginning
6833 Math
.max( index
, -1 ) :
6834 // Default to n-1 instead of -1, if nothing is selected let's start at the end
6835 Math
.min( index
, len
);
6838 i
= ( i
+ inc
+ len
) % len
;
6839 item
= this.items
[i
];
6840 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
6843 // Stop iterating when we've looped all the way around
6844 if ( i
=== stopAt
) {
6852 * Get the next selectable item.
6854 * @return {OO.ui.OptionWidget|null} Item, `null` if ther aren't any selectable items
6856 OO
.ui
.SelectWidget
.prototype.getFirstSelectableItem = function () {
6859 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
6860 item
= this.items
[i
];
6861 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
6872 * When items are added with the same values as existing items, the existing items will be
6873 * automatically removed before the new items are added.
6875 * @param {OO.ui.OptionWidget[]} items Items to add
6876 * @param {number} [index] Index to insert items after
6880 OO
.ui
.SelectWidget
.prototype.addItems = function ( items
, index
) {
6881 var i
, len
, item
, hash
,
6884 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
6886 hash
= OO
.getHash( item
.getData() );
6887 if ( hash
in this.hashes
) {
6888 // Remove item with same value
6889 remove
.push( this.hashes
[hash
] );
6891 this.hashes
[hash
] = item
;
6893 if ( remove
.length
) {
6894 this.removeItems( remove
);
6898 OO
.ui
.GroupWidget
.prototype.addItems
.call( this, items
, index
);
6900 // Always provide an index, even if it was omitted
6901 this.emit( 'add', items
, index
=== undefined ? this.items
.length
- items
.length
- 1 : index
);
6909 * Items will be detached, not removed, so they can be used later.
6911 * @param {OO.ui.OptionWidget[]} items Items to remove
6915 OO
.ui
.SelectWidget
.prototype.removeItems = function ( items
) {
6916 var i
, len
, item
, hash
;
6918 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
6920 hash
= OO
.getHash( item
.getData() );
6921 if ( hash
in this.hashes
) {
6922 // Remove existing item
6923 delete this.hashes
[hash
];
6925 if ( item
.isSelected() ) {
6926 this.selectItem( null );
6931 OO
.ui
.GroupWidget
.prototype.removeItems
.call( this, items
);
6933 this.emit( 'remove', items
);
6941 * Items will be detached, not removed, so they can be used later.
6946 OO
.ui
.SelectWidget
.prototype.clearItems = function () {
6947 var items
= this.items
.slice();
6952 OO
.ui
.GroupWidget
.prototype.clearItems
.call( this );
6953 this.selectItem( null );
6955 this.emit( 'remove', items
);
6962 * Use with OO.ui.MenuWidget.
6965 * @extends OO.ui.OptionWidget
6968 * @param {Mixed} data Item data
6969 * @param {Object} [config] Configuration options
6971 OO
.ui
.MenuItemWidget
= function OoUiMenuItemWidget( data
, config
) {
6972 // Configuration initialization
6973 config
= $.extend( { 'icon': 'check' }, config
);
6975 // Parent constructor
6976 OO
.ui
.MenuItemWidget
.super.call( this, data
, config
);
6979 this.$element
.addClass( 'oo-ui-menuItemWidget' );
6984 OO
.inheritClass( OO
.ui
.MenuItemWidget
, OO
.ui
.OptionWidget
);
6988 * Use together with OO.ui.MenuItemWidget.
6991 * @extends OO.ui.SelectWidget
6992 * @mixins OO.ui.ClippableElement
6995 * @param {Object} [config] Configuration options
6996 * @cfg {OO.ui.InputWidget} [input] Input to bind keyboard handlers to
6997 * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu
6999 OO
.ui
.MenuWidget
= function OoUiMenuWidget( config
) {
7000 // Config intialization
7001 config
= config
|| {};
7003 // Parent constructor
7004 OO
.ui
.MenuWidget
.super.call( this, config
);
7006 // Mixin constructors
7007 OO
.ui
.ClippableElement
.call( this, this.$group
, config
);
7010 this.autoHide
= config
.autoHide
=== undefined || !!config
.autoHide
;
7011 this.newItems
= null;
7012 this.$input
= config
.input
? config
.input
.$input
: null;
7013 this.$previousFocus
= null;
7014 this.isolated
= !config
.input
;
7015 this.visible
= false;
7016 this.flashing
= false;
7017 this.onKeyDownHandler
= OO
.ui
.bind( this.onKeyDown
, this );
7018 this.onDocumentMouseDownHandler
= OO
.ui
.bind( this.onDocumentMouseDown
, this );
7021 this.$element
.hide().addClass( 'oo-ui-menuWidget' );
7026 OO
.inheritClass( OO
.ui
.MenuWidget
, OO
.ui
.SelectWidget
);
7027 OO
.mixinClass( OO
.ui
.MenuWidget
, OO
.ui
.ClippableElement
);
7032 * Handles document mouse down events.
7034 * @param {jQuery.Event} e Key down event
7036 OO
.ui
.MenuWidget
.prototype.onDocumentMouseDown = function ( e
) {
7037 if ( !$.contains( this.$element
[0], e
.target
) ) {
7043 * Handles key down events.
7045 * @param {jQuery.Event} e Key down event
7047 OO
.ui
.MenuWidget
.prototype.onKeyDown = function ( e
) {
7050 highlightItem
= this.getHighlightedItem();
7052 if ( !this.isDisabled() && this.visible
) {
7053 if ( !highlightItem
) {
7054 highlightItem
= this.getSelectedItem();
7056 switch ( e
.keyCode
) {
7057 case OO
.ui
.Keys
.ENTER
:
7058 this.chooseItem( highlightItem
);
7062 nextItem
= this.getRelativeSelectableItem( highlightItem
, -1 );
7065 case OO
.ui
.Keys
.DOWN
:
7066 nextItem
= this.getRelativeSelectableItem( highlightItem
, 1 );
7069 case OO
.ui
.Keys
.ESCAPE
:
7070 if ( highlightItem
) {
7071 highlightItem
.setHighlighted( false );
7079 this.highlightItem( nextItem
);
7080 nextItem
.scrollElementIntoView();
7085 e
.stopPropagation();
7092 * Check if the menu is visible.
7094 * @return {boolean} Menu is visible
7096 OO
.ui
.MenuWidget
.prototype.isVisible = function () {
7097 return this.visible
;
7101 * Bind key down listener.
7103 OO
.ui
.MenuWidget
.prototype.bindKeyDownListener = function () {
7104 if ( this.$input
) {
7105 this.$input
.on( 'keydown', this.onKeyDownHandler
);
7107 // Capture menu navigation keys
7108 this.getElementWindow().addEventListener( 'keydown', this.onKeyDownHandler
, true );
7113 * Unbind key down listener.
7115 OO
.ui
.MenuWidget
.prototype.unbindKeyDownListener = function () {
7116 if ( this.$input
) {
7117 this.$input
.off( 'keydown' );
7119 this.getElementWindow().removeEventListener( 'keydown', this.onKeyDownHandler
, true );
7126 * This will close the menu when done, unlike selectItem which only changes selection.
7128 * @param {OO.ui.OptionWidget} item Item to choose
7131 OO
.ui
.MenuWidget
.prototype.chooseItem = function ( item
) {
7133 OO
.ui
.MenuWidget
.super.prototype.chooseItem
.call( this, item
);
7135 if ( item
&& !this.flashing
) {
7136 this.flashing
= true;
7137 item
.flash().done( OO
.ui
.bind( function () {
7139 this.flashing
= false;
7151 * Adding an existing item (by value) will move it.
7153 * @param {OO.ui.MenuItemWidget[]} items Items to add
7154 * @param {number} [index] Index to insert items after
7157 OO
.ui
.MenuWidget
.prototype.addItems = function ( items
, index
) {
7161 OO
.ui
.MenuWidget
.super.prototype.addItems
.call( this, items
, index
);
7164 if ( !this.newItems
) {
7168 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
7170 if ( this.visible
) {
7171 // Defer fitting label until
7174 this.newItems
.push( item
);
7186 OO
.ui
.MenuWidget
.prototype.show = function () {
7189 if ( this.items
.length
) {
7190 this.$element
.show();
7191 this.visible
= true;
7192 this.bindKeyDownListener();
7194 // Change focus to enable keyboard navigation
7195 if ( this.isolated
&& this.$input
&& !this.$input
.is( ':focus' ) ) {
7196 this.$previousFocus
= this.$( ':focus' );
7197 this.$input
.focus();
7199 if ( this.newItems
&& this.newItems
.length
) {
7200 for ( i
= 0, len
= this.newItems
.length
; i
< len
; i
++ ) {
7201 this.newItems
[i
].fitLabel();
7203 this.newItems
= null;
7206 this.setClipping( true );
7209 if ( this.autoHide
) {
7210 this.getElementDocument().addEventListener(
7211 'mousedown', this.onDocumentMouseDownHandler
, true
7224 OO
.ui
.MenuWidget
.prototype.hide = function () {
7225 this.$element
.hide();
7226 this.visible
= false;
7227 this.unbindKeyDownListener();
7229 if ( this.isolated
&& this.$previousFocus
) {
7230 this.$previousFocus
.focus();
7231 this.$previousFocus
= null;
7234 this.getElementDocument().removeEventListener(
7235 'mousedown', this.onDocumentMouseDownHandler
, true
7238 this.setClipping( false );
7243 * Inline menu of options.
7245 * Use with OO.ui.MenuOptionWidget.
7248 * @extends OO.ui.Widget
7249 * @mixins OO.ui.IconedElement
7250 * @mixins OO.ui.IndicatedElement
7251 * @mixins OO.ui.LabeledElement
7252 * @mixins OO.ui.TitledElement
7255 * @param {Object} [config] Configuration options
7256 * @cfg {Object} [menu] Configuration options to pass to menu widget
7258 OO
.ui
.InlineMenuWidget
= function OoUiInlineMenuWidget( config
) {
7259 // Configuration initialization
7260 config
= $.extend( { 'indicator': 'down' }, config
);
7262 // Parent constructor
7263 OO
.ui
.InlineMenuWidget
.super.call( this, config
);
7265 // Mixin constructors
7266 OO
.ui
.IconedElement
.call( this, this.$( '<span>' ), config
);
7267 OO
.ui
.IndicatedElement
.call( this, this.$( '<span>' ), config
);
7268 OO
.ui
.LabeledElement
.call( this, this.$( '<span>' ), config
);
7269 OO
.ui
.TitledElement
.call( this, this.$label
, config
);
7272 this.menu
= new OO
.ui
.MenuWidget( $.extend( { '$': this.$ }, config
.menu
) );
7273 this.$handle
= this.$( '<span>' );
7276 this.$element
.on( { 'click': OO
.ui
.bind( this.onClick
, this ) } );
7277 this.menu
.connect( this, { 'select': 'onMenuSelect' } );
7281 .addClass( 'oo-ui-inlineMenuWidget-handle' )
7282 .append( this.$icon
, this.$label
, this.$indicator
);
7284 .addClass( 'oo-ui-inlineMenuWidget' )
7285 .append( this.$handle
, this.menu
.$element
);
7290 OO
.inheritClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.Widget
);
7291 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.IconedElement
);
7292 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.IndicatedElement
);
7293 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.LabeledElement
);
7294 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.TitledElement
);
7301 * @return {OO.ui.MenuWidget} Menu of widget
7303 OO
.ui
.InlineMenuWidget
.prototype.getMenu = function () {
7308 * Handles menu select events.
7310 * @param {OO.ui.MenuItemWidget} item Selected menu item
7312 OO
.ui
.InlineMenuWidget
.prototype.onMenuSelect = function ( item
) {
7319 selectedLabel
= item
.getLabel();
7321 // If the label is a DOM element, clone it, because setLabel will append() it
7322 if ( selectedLabel
instanceof jQuery
) {
7323 selectedLabel
= selectedLabel
.clone();
7326 this.setLabel( selectedLabel
);
7330 * Handles mouse click events.
7332 * @param {jQuery.Event} e Mouse click event
7334 OO
.ui
.InlineMenuWidget
.prototype.onClick = function ( e
) {
7335 // Skip clicks within the menu
7336 if ( $.contains( this.menu
.$element
[0], e
.target
) ) {
7340 if ( !this.isDisabled() ) {
7341 if ( this.menu
.isVisible() ) {
7350 * Menu section item widget.
7352 * Use with OO.ui.MenuWidget.
7355 * @extends OO.ui.OptionWidget
7358 * @param {Mixed} data Item data
7359 * @param {Object} [config] Configuration options
7361 OO
.ui
.MenuSectionItemWidget
= function OoUiMenuSectionItemWidget( data
, config
) {
7362 // Parent constructor
7363 OO
.ui
.MenuSectionItemWidget
.super.call( this, data
, config
);
7366 this.$element
.addClass( 'oo-ui-menuSectionItemWidget' );
7371 OO
.inheritClass( OO
.ui
.MenuSectionItemWidget
, OO
.ui
.OptionWidget
);
7373 /* Static Properties */
7375 OO
.ui
.MenuSectionItemWidget
.static.selectable
= false;
7377 OO
.ui
.MenuSectionItemWidget
.static.highlightable
= false;
7379 * Create an OO.ui.OutlineWidget object.
7381 * Use with OO.ui.OutlineItemWidget.
7384 * @extends OO.ui.SelectWidget
7387 * @param {Object} [config] Configuration options
7389 OO
.ui
.OutlineWidget
= function OoUiOutlineWidget( config
) {
7390 // Config intialization
7391 config
= config
|| {};
7393 // Parent constructor
7394 OO
.ui
.OutlineWidget
.super.call( this, config
);
7397 this.$element
.addClass( 'oo-ui-outlineWidget' );
7402 OO
.inheritClass( OO
.ui
.OutlineWidget
, OO
.ui
.SelectWidget
);
7404 * Creates an OO.ui.OutlineControlsWidget object.
7406 * Use together with OO.ui.OutlineWidget.js
7411 * @param {OO.ui.OutlineWidget} outline Outline to control
7412 * @param {Object} [config] Configuration options
7414 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
7415 // Configuration initialization
7416 config
= $.extend( { 'icon': 'add-item' }, config
);
7418 // Parent constructor
7419 OO
.ui
.OutlineControlsWidget
.super.call( this, config
);
7421 // Mixin constructors
7422 OO
.ui
.GroupElement
.call( this, this.$( '<div>' ), config
);
7423 OO
.ui
.IconedElement
.call( this, this.$( '<div>' ), config
);
7426 this.outline
= outline
;
7427 this.$movers
= this.$( '<div>' );
7428 this.upButton
= new OO
.ui
.ButtonWidget( {
7432 'title': OO
.ui
.msg( 'ooui-outline-control-move-up' )
7434 this.downButton
= new OO
.ui
.ButtonWidget( {
7438 'title': OO
.ui
.msg( 'ooui-outline-control-move-down' )
7440 this.removeButton
= new OO
.ui
.ButtonWidget( {
7444 'title': OO
.ui
.msg( 'ooui-outline-control-remove' )
7448 outline
.connect( this, {
7449 'select': 'onOutlineChange',
7450 'add': 'onOutlineChange',
7451 'remove': 'onOutlineChange'
7453 this.upButton
.connect( this, { 'click': [ 'emit', 'move', -1 ] } );
7454 this.downButton
.connect( this, { 'click': [ 'emit', 'move', 1 ] } );
7455 this.removeButton
.connect( this, { 'click': [ 'emit', 'remove' ] } );
7458 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
7459 this.$group
.addClass( 'oo-ui-outlineControlsWidget-adders' );
7461 .addClass( 'oo-ui-outlineControlsWidget-movers' )
7462 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
7463 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
7468 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
7469 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.GroupElement
);
7470 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.IconedElement
);
7476 * @param {number} places Number of places to move
7486 * Handle outline change events.
7488 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
7489 var i
, len
, firstMovable
, lastMovable
,
7490 items
= this.outline
.getItems(),
7491 selectedItem
= this.outline
.getSelectedItem(),
7492 movable
= selectedItem
&& selectedItem
.isMovable(),
7493 removable
= selectedItem
&& selectedItem
.isRemovable();
7498 while ( ++i
< len
) {
7499 if ( items
[i
].isMovable() ) {
7500 firstMovable
= items
[i
];
7506 if ( items
[i
].isMovable() ) {
7507 lastMovable
= items
[i
];
7512 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
7513 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
7514 this.removeButton
.setDisabled( !removable
);
7517 * Creates an OO.ui.OutlineItemWidget object.
7519 * Use with OO.ui.OutlineWidget.
7522 * @extends OO.ui.OptionWidget
7525 * @param {Mixed} data Item data
7526 * @param {Object} [config] Configuration options
7527 * @cfg {number} [level] Indentation level
7528 * @cfg {boolean} [movable] Allow modification from outline controls
7530 OO
.ui
.OutlineItemWidget
= function OoUiOutlineItemWidget( data
, config
) {
7531 // Config intialization
7532 config
= config
|| {};
7534 // Parent constructor
7535 OO
.ui
.OutlineItemWidget
.super.call( this, data
, config
);
7539 this.movable
= !!config
.movable
;
7540 this.removable
= !!config
.removable
;
7543 this.$element
.addClass( 'oo-ui-outlineItemWidget' );
7544 this.setLevel( config
.level
);
7549 OO
.inheritClass( OO
.ui
.OutlineItemWidget
, OO
.ui
.OptionWidget
);
7551 /* Static Properties */
7553 OO
.ui
.OutlineItemWidget
.static.highlightable
= false;
7555 OO
.ui
.OutlineItemWidget
.static.scrollIntoViewOnSelect
= true;
7557 OO
.ui
.OutlineItemWidget
.static.levelClass
= 'oo-ui-outlineItemWidget-level-';
7559 OO
.ui
.OutlineItemWidget
.static.levels
= 3;
7564 * Check if item is movable.
7566 * Movablilty is used by outline controls.
7568 * @return {boolean} Item is movable
7570 OO
.ui
.OutlineItemWidget
.prototype.isMovable = function () {
7571 return this.movable
;
7575 * Check if item is removable.
7577 * Removablilty is used by outline controls.
7579 * @return {boolean} Item is removable
7581 OO
.ui
.OutlineItemWidget
.prototype.isRemovable = function () {
7582 return this.removable
;
7586 * Get indentation level.
7588 * @return {number} Indentation level
7590 OO
.ui
.OutlineItemWidget
.prototype.getLevel = function () {
7597 * Movablilty is used by outline controls.
7599 * @param {boolean} movable Item is movable
7602 OO
.ui
.OutlineItemWidget
.prototype.setMovable = function ( movable
) {
7603 this.movable
= !!movable
;
7610 * Removablilty is used by outline controls.
7612 * @param {boolean} movable Item is removable
7615 OO
.ui
.OutlineItemWidget
.prototype.setRemovable = function ( removable
) {
7616 this.removable
= !!removable
;
7621 * Set indentation level.
7623 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
7626 OO
.ui
.OutlineItemWidget
.prototype.setLevel = function ( level
) {
7627 var levels
= this.constructor.static.levels
,
7628 levelClass
= this.constructor.static.levelClass
,
7631 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
7633 if ( this.level
=== i
) {
7634 this.$element
.addClass( levelClass
+ i
);
7636 this.$element
.removeClass( levelClass
+ i
);
7643 * Option widget that looks like a button.
7645 * Use together with OO.ui.ButtonSelectWidget.
7648 * @extends OO.ui.OptionWidget
7649 * @mixins OO.ui.ButtonedElement
7650 * @mixins OO.ui.FlaggableElement
7653 * @param {Mixed} data Option data
7654 * @param {Object} [config] Configuration options
7656 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( data
, config
) {
7657 // Parent constructor
7658 OO
.ui
.ButtonOptionWidget
.super.call( this, data
, config
);
7660 // Mixin constructors
7661 OO
.ui
.ButtonedElement
.call( this, this.$( '<a>' ), config
);
7662 OO
.ui
.FlaggableElement
.call( this, config
);
7665 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
7666 this.$button
.append( this.$element
.contents() );
7667 this.$element
.append( this.$button
);
7672 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.OptionWidget
);
7673 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.ButtonedElement
);
7674 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.FlaggableElement
);
7676 /* Static Properties */
7678 // Allow button mouse down events to pass through so they can be handled by the parent select widget
7679 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
7686 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
7687 OO
.ui
.ButtonOptionWidget
.super.prototype.setSelected
.call( this, state
);
7689 this.setActive( state
);
7694 * Select widget containing button options.
7696 * Use together with OO.ui.ButtonOptionWidget.
7699 * @extends OO.ui.SelectWidget
7702 * @param {Object} [config] Configuration options
7704 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
7705 // Parent constructor
7706 OO
.ui
.ButtonSelectWidget
.super.call( this, config
);
7709 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
7714 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
7716 * Container for content that is overlaid and positioned absolutely.
7719 * @extends OO.ui.Widget
7720 * @mixins OO.ui.LabeledElement
7723 * @param {Object} [config] Configuration options
7724 * @cfg {boolean} [tail=true] Show tail pointing to origin of popup
7725 * @cfg {string} [align='center'] Alignment of popup to origin
7726 * @cfg {jQuery} [$container] Container to prevent popup from rendering outside of
7727 * @cfg {boolean} [autoClose=false] Popup auto-closes when it loses focus
7728 * @cfg {jQuery} [$autoCloseIgnore] Elements to not auto close when clicked
7729 * @cfg {boolean} [head] Show label and close button at the top
7731 OO
.ui
.PopupWidget
= function OoUiPopupWidget( config
) {
7732 // Config intialization
7733 config
= config
|| {};
7735 // Parent constructor
7736 OO
.ui
.PopupWidget
.super.call( this, config
);
7738 // Mixin constructors
7739 OO
.ui
.LabeledElement
.call( this, this.$( '<div>' ), config
);
7740 OO
.ui
.ClippableElement
.call( this, this.$( '<div>' ), config
);
7743 this.visible
= false;
7744 this.$popup
= this.$( '<div>' );
7745 this.$head
= this.$( '<div>' );
7746 this.$body
= this.$clippable
;
7747 this.$tail
= this.$( '<div>' );
7748 this.$container
= config
.$container
|| this.$( 'body' );
7749 this.autoClose
= !!config
.autoClose
;
7750 this.$autoCloseIgnore
= config
.$autoCloseIgnore
;
7751 this.transitionTimeout
= null;
7753 this.align
= config
.align
|| 'center';
7754 this.closeButton
= new OO
.ui
.ButtonWidget( { '$': this.$, 'frameless': true, 'icon': 'close' } );
7755 this.onMouseDownHandler
= OO
.ui
.bind( this.onMouseDown
, this );
7758 this.closeButton
.connect( this, { 'click': 'onCloseButtonClick' } );
7761 this.useTail( config
.tail
!== undefined ? !!config
.tail
: true );
7762 this.$body
.addClass( 'oo-ui-popupWidget-body' );
7763 this.$tail
.addClass( 'oo-ui-popupWidget-tail' );
7765 .addClass( 'oo-ui-popupWidget-head' )
7766 .append( this.$label
, this.closeButton
.$element
);
7767 if ( !config
.head
) {
7771 .addClass( 'oo-ui-popupWidget-popup' )
7772 .append( this.$head
, this.$body
);
7773 this.$element
.hide()
7774 .addClass( 'oo-ui-popupWidget' )
7775 .append( this.$popup
, this.$tail
);
7780 OO
.inheritClass( OO
.ui
.PopupWidget
, OO
.ui
.Widget
);
7781 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.LabeledElement
);
7782 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.ClippableElement
);
7797 * Handles mouse down events.
7799 * @param {jQuery.Event} e Mouse down event
7801 OO
.ui
.PopupWidget
.prototype.onMouseDown = function ( e
) {
7804 !$.contains( this.$element
[0], e
.target
) &&
7805 ( !this.$autoCloseIgnore
|| !this.$autoCloseIgnore
.has( e
.target
).length
)
7812 * Bind mouse down listener.
7814 OO
.ui
.PopupWidget
.prototype.bindMouseDownListener = function () {
7815 // Capture clicks outside popup
7816 this.getElementWindow().addEventListener( 'mousedown', this.onMouseDownHandler
, true );
7820 * Handles close button click events.
7822 OO
.ui
.PopupWidget
.prototype.onCloseButtonClick = function () {
7823 if ( this.visible
) {
7829 * Unbind mouse down listener.
7831 OO
.ui
.PopupWidget
.prototype.unbindMouseDownListener = function () {
7832 this.getElementWindow().removeEventListener( 'mousedown', this.onMouseDownHandler
, true );
7836 * Check if the popup is visible.
7838 * @return {boolean} Popup is visible
7840 OO
.ui
.PopupWidget
.prototype.isVisible = function () {
7841 return this.visible
;
7845 * Set whether to show a tail.
7847 * @return {boolean} Make tail visible
7849 OO
.ui
.PopupWidget
.prototype.useTail = function ( value
) {
7851 if ( this.tail
!== value
) {
7854 this.$element
.addClass( 'oo-ui-popupWidget-tailed' );
7856 this.$element
.removeClass( 'oo-ui-popupWidget-tailed' );
7862 * Check if showing a tail.
7864 * @return {boolean} tail is visible
7866 OO
.ui
.PopupWidget
.prototype.hasTail = function () {
7876 OO
.ui
.PopupWidget
.prototype.show = function () {
7877 if ( !this.visible
) {
7878 this.setClipping( true );
7879 this.$element
.show();
7880 this.visible
= true;
7881 this.emit( 'show' );
7882 if ( this.autoClose
) {
7883 this.bindMouseDownListener();
7895 OO
.ui
.PopupWidget
.prototype.hide = function () {
7896 if ( this.visible
) {
7897 this.setClipping( false );
7898 this.$element
.hide();
7899 this.visible
= false;
7900 this.emit( 'hide' );
7901 if ( this.autoClose
) {
7902 this.unbindMouseDownListener();
7909 * Updates the position and size.
7911 * @param {number} width Width
7912 * @param {number} height Height
7913 * @param {boolean} [transition=false] Use a smooth transition
7916 OO
.ui
.PopupWidget
.prototype.display = function ( width
, height
, transition
) {
7918 originOffset
= Math
.round( this.$element
.offset().left
),
7919 containerLeft
= Math
.round( this.$container
.offset().left
),
7920 containerWidth
= this.$container
.innerWidth(),
7921 containerRight
= containerLeft
+ containerWidth
,
7922 popupOffset
= width
* ( { 'left': 0, 'center': -0.5, 'right': -1 } )[this.align
],
7923 popupLeft
= popupOffset
- padding
,
7924 popupRight
= popupOffset
+ padding
+ width
+ padding
,
7925 overlapLeft
= ( originOffset
+ popupLeft
) - containerLeft
,
7926 overlapRight
= containerRight
- ( originOffset
+ popupRight
);
7928 // Prevent transition from being interrupted
7929 clearTimeout( this.transitionTimeout
);
7931 // Enable transition
7932 this.$element
.addClass( 'oo-ui-popupWidget-transitioning' );
7935 if ( overlapRight
< 0 ) {
7936 popupOffset
+= overlapRight
;
7937 } else if ( overlapLeft
< 0 ) {
7938 popupOffset
-= overlapLeft
;
7941 // Position body relative to anchor and resize
7943 'left': popupOffset
,
7945 'height': height
=== undefined ? 'auto' : height
7949 // Prevent transitioning after transition is complete
7950 this.transitionTimeout
= setTimeout( OO
.ui
.bind( function () {
7951 this.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
7954 // Prevent transitioning immediately
7955 this.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
7961 * Button that shows and hides a popup.
7964 * @extends OO.ui.ButtonWidget
7965 * @mixins OO.ui.PopuppableElement
7968 * @param {Object} [config] Configuration options
7970 OO
.ui
.PopupButtonWidget
= function OoUiPopupButtonWidget( config
) {
7971 // Parent constructor
7972 OO
.ui
.PopupButtonWidget
.super.call( this, config
);
7974 // Mixin constructors
7975 OO
.ui
.PopuppableElement
.call( this, config
);
7979 .addClass( 'oo-ui-popupButtonWidget' )
7980 .append( this.popup
.$element
);
7985 OO
.inheritClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.ButtonWidget
);
7986 OO
.mixinClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.PopuppableElement
);
7991 * Handles mouse click events.
7993 * @param {jQuery.Event} e Mouse click event
7995 OO
.ui
.PopupButtonWidget
.prototype.onClick = function ( e
) {
7996 // Skip clicks within the popup
7997 if ( $.contains( this.popup
.$element
[0], e
.target
) ) {
8001 if ( !this.isDisabled() ) {
8002 if ( this.popup
.isVisible() ) {
8007 OO
.ui
.PopupButtonWidget
.super.prototype.onClick
.call( this );
8014 * Combines query and results selection widgets.
8017 * @extends OO.ui.Widget
8020 * @param {Object} [config] Configuration options
8021 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
8022 * @cfg {string} [value] Initial query value
8024 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
8025 // Configuration intialization
8026 config
= config
|| {};
8028 // Parent constructor
8029 OO
.ui
.SearchWidget
.super.call( this, config
);
8032 this.query
= new OO
.ui
.TextInputWidget( {
8035 'placeholder': config
.placeholder
,
8036 'value': config
.value
8038 this.results
= new OO
.ui
.SelectWidget( { '$': this.$ } );
8039 this.$query
= this.$( '<div>' );
8040 this.$results
= this.$( '<div>' );
8043 this.query
.connect( this, {
8044 'change': 'onQueryChange',
8045 'enter': 'onQueryEnter'
8047 this.results
.connect( this, {
8048 'highlight': 'onResultsHighlight',
8049 'select': 'onResultsSelect'
8051 this.query
.$input
.on( 'keydown', OO
.ui
.bind( this.onQueryKeydown
, this ) );
8055 .addClass( 'oo-ui-searchWidget-query' )
8056 .append( this.query
.$element
);
8058 .addClass( 'oo-ui-searchWidget-results' )
8059 .append( this.results
.$element
);
8061 .addClass( 'oo-ui-searchWidget' )
8062 .append( this.$results
, this.$query
);
8067 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
8073 * @param {Object|null} item Item data or null if no item is highlighted
8078 * @param {Object|null} item Item data or null if no item is selected
8084 * Handle query key down events.
8086 * @param {jQuery.Event} e Key down event
8088 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
8089 var highlightedItem
, nextItem
,
8090 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
8093 highlightedItem
= this.results
.getHighlightedItem();
8094 if ( !highlightedItem
) {
8095 highlightedItem
= this.results
.getSelectedItem();
8097 nextItem
= this.results
.getRelativeSelectableItem( highlightedItem
, dir
);
8098 this.results
.highlightItem( nextItem
);
8099 nextItem
.scrollElementIntoView();
8104 * Handle select widget select events.
8106 * Clears existing results. Subclasses should repopulate items according to new query.
8108 * @param {string} value New value
8110 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
8112 this.results
.clearItems();
8116 * Handle select widget enter key events.
8118 * Selects highlighted item.
8120 * @param {string} value New value
8122 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
8124 this.results
.selectItem( this.results
.getHighlightedItem() );
8128 * Handle select widget highlight events.
8130 * @param {OO.ui.OptionWidget} item Highlighted item
8133 OO
.ui
.SearchWidget
.prototype.onResultsHighlight = function ( item
) {
8134 this.emit( 'highlight', item
? item
.getData() : null );
8138 * Handle select widget select events.
8140 * @param {OO.ui.OptionWidget} item Selected item
8143 OO
.ui
.SearchWidget
.prototype.onResultsSelect = function ( item
) {
8144 this.emit( 'select', item
? item
.getData() : null );
8148 * Get the query input.
8150 * @return {OO.ui.TextInputWidget} Query input
8152 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
8157 * Get the results list.
8159 * @return {OO.ui.SelectWidget} Select list
8161 OO
.ui
.SearchWidget
.prototype.getResults = function () {
8162 return this.results
;
8165 * Text input widget.
8168 * @extends OO.ui.InputWidget
8171 * @param {Object} [config] Configuration options
8172 * @cfg {string} [placeholder] Placeholder text
8173 * @cfg {string} [icon] Symbolic name of icon
8174 * @cfg {boolean} [multiline=false] Allow multiple lines of text
8175 * @cfg {boolean} [autosize=false] Automatically resize to fit content
8176 * @cfg {boolean} [maxRows=10] Maximum number of rows to make visible when autosizing
8178 OO
.ui
.TextInputWidget
= function OoUiTextInputWidget( config
) {
8179 config
= $.extend( { 'maxRows': 10 }, config
);
8181 // Parent constructor
8182 OO
.ui
.TextInputWidget
.super.call( this, config
);
8186 this.multiline
= !!config
.multiline
;
8187 this.autosize
= !!config
.autosize
;
8188 this.maxRows
= config
.maxRows
;
8191 this.$input
.on( 'keypress', OO
.ui
.bind( this.onKeyPress
, this ) );
8192 this.$element
.on( 'DOMNodeInsertedIntoDocument', OO
.ui
.bind( this.onElementAttach
, this ) );
8195 this.$element
.addClass( 'oo-ui-textInputWidget' );
8196 if ( config
.icon
) {
8197 this.$element
.addClass( 'oo-ui-textInputWidget-decorated' );
8198 this.$element
.append(
8200 .addClass( 'oo-ui-textInputWidget-icon oo-ui-icon-' + config
.icon
)
8201 .mousedown( OO
.ui
.bind( function () {
8202 this.$input
.focus();
8207 if ( config
.placeholder
) {
8208 this.$input
.attr( 'placeholder', config
.placeholder
);
8214 OO
.inheritClass( OO
.ui
.TextInputWidget
, OO
.ui
.InputWidget
);
8219 * User presses enter inside the text box.
8221 * Not called if input is multiline.
8229 * Handle key press events.
8231 * @param {jQuery.Event} e Key press event
8232 * @fires enter If enter key is pressed and input is not multiline
8234 OO
.ui
.TextInputWidget
.prototype.onKeyPress = function ( e
) {
8235 if ( e
.which
=== OO
.ui
.Keys
.ENTER
&& !this.multiline
) {
8236 this.emit( 'enter' );
8241 * Handle element attach events.
8243 * @param {jQuery.Event} e Element attach event
8245 OO
.ui
.TextInputWidget
.prototype.onElementAttach = function () {
8252 OO
.ui
.TextInputWidget
.prototype.onEdit = function () {
8256 return OO
.ui
.TextInputWidget
.super.prototype.onEdit
.call( this );
8260 * Automatically adjust the size of the text input.
8262 * This only affects multi-line inputs that are auto-sized.
8266 OO
.ui
.TextInputWidget
.prototype.adjustSize = function () {
8267 var $clone
, scrollHeight
, innerHeight
, outerHeight
, maxInnerHeight
, idealHeight
;
8269 if ( this.multiline
&& this.autosize
) {
8270 $clone
= this.$input
.clone()
8271 .val( this.$input
.val() )
8272 .css( { 'height': 0 } )
8273 .insertAfter( this.$input
);
8274 // Set inline height property to 0 to measure scroll height
8275 scrollHeight
= $clone
[0].scrollHeight
;
8276 // Remove inline height property to measure natural heights
8277 $clone
.css( 'height', '' );
8278 innerHeight
= $clone
.innerHeight();
8279 outerHeight
= $clone
.outerHeight();
8280 // Measure max rows height
8281 $clone
.attr( 'rows', this.maxRows
).css( 'height', 'auto' );
8282 maxInnerHeight
= $clone
.innerHeight();
8283 $clone
.removeAttr( 'rows' ).css( 'height', '' );
8285 idealHeight
= Math
.min( maxInnerHeight
, scrollHeight
);
8286 // Only apply inline height when expansion beyond natural height is needed
8289 // Use the difference between the inner and outer height as a buffer
8290 idealHeight
> outerHeight
? idealHeight
+ ( outerHeight
- innerHeight
) : ''
8297 * Get input element.
8299 * @param {Object} [config] Configuration options
8300 * @return {jQuery} Input element
8302 OO
.ui
.TextInputWidget
.prototype.getInputElement = function ( config
) {
8303 return config
.multiline
? this.$( '<textarea>' ) : this.$( '<input type="text" />' );
8309 * Check if input supports multiple lines.
8313 OO
.ui
.TextInputWidget
.prototype.isMultiline = function () {
8314 return !!this.multiline
;
8318 * Check if input automatically adjusts its size.
8322 OO
.ui
.TextInputWidget
.prototype.isAutosizing = function () {
8323 return !!this.autosize
;
8327 * Check if input is pending.
8331 OO
.ui
.TextInputWidget
.prototype.isPending = function () {
8332 return !!this.pending
;
8336 * Increase the pending stack.
8340 OO
.ui
.TextInputWidget
.prototype.pushPending = function () {
8341 if ( this.pending
=== 0 ) {
8342 this.$element
.addClass( 'oo-ui-textInputWidget-pending' );
8343 this.$input
.addClass( 'oo-ui-texture-pending' );
8351 * Reduce the pending stack.
8357 OO
.ui
.TextInputWidget
.prototype.popPending = function () {
8358 if ( this.pending
=== 1 ) {
8359 this.$element
.removeClass( 'oo-ui-textInputWidget-pending' );
8360 this.$input
.removeClass( 'oo-ui-texture-pending' );
8362 this.pending
= Math
.max( 0, this.pending
- 1 );
8368 * Select the contents of the input.
8372 OO
.ui
.TextInputWidget
.prototype.select = function () {
8373 this.$input
.select();
8377 * Menu for a text input widget.
8380 * @extends OO.ui.MenuWidget
8383 * @param {OO.ui.TextInputWidget} input Text input widget to provide menu for
8384 * @param {Object} [config] Configuration options
8385 * @cfg {jQuery} [$container=input.$element] Element to render menu under
8387 OO
.ui
.TextInputMenuWidget
= function OoUiTextInputMenuWidget( input
, config
) {
8388 // Parent constructor
8389 OO
.ui
.TextInputMenuWidget
.super.call( this, config
);
8393 this.$container
= config
.$container
|| this.input
.$element
;
8394 this.onWindowResizeHandler
= OO
.ui
.bind( this.onWindowResize
, this );
8397 this.$element
.addClass( 'oo-ui-textInputMenuWidget' );
8402 OO
.inheritClass( OO
.ui
.TextInputMenuWidget
, OO
.ui
.MenuWidget
);
8407 * Handle window resize event.
8409 * @param {jQuery.Event} e Window resize event
8411 OO
.ui
.TextInputMenuWidget
.prototype.onWindowResize = function () {
8420 OO
.ui
.TextInputMenuWidget
.prototype.show = function () {
8422 OO
.ui
.TextInputMenuWidget
.super.prototype.show
.call( this );
8425 this.$( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler
);
8434 OO
.ui
.TextInputMenuWidget
.prototype.hide = function () {
8436 OO
.ui
.TextInputMenuWidget
.super.prototype.hide
.call( this );
8438 this.$( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler
);
8443 * Position the menu.
8447 OO
.ui
.TextInputMenuWidget
.prototype.position = function () {
8449 $container
= this.$container
,
8450 dimensions
= $container
.offset();
8452 // Position under input
8453 dimensions
.top
+= $container
.height();
8455 // Compensate for frame position if in a differnt frame
8456 if ( this.input
.$.frame
&& this.input
.$.context
!== this.$element
[0].ownerDocument
) {
8457 frameOffset
= OO
.ui
.Element
.getRelativePosition(
8458 this.input
.$.frame
.$element
, this.$element
.offsetParent()
8460 dimensions
.left
+= frameOffset
.left
;
8461 dimensions
.top
+= frameOffset
.top
;
8463 // Fix for RTL (for some reason, no need to fix if the frameoffset is set)
8464 if ( this.$element
.css( 'direction' ) === 'rtl' ) {
8465 dimensions
.right
= this.$element
.parent().position().left
-
8466 dimensions
.width
- dimensions
.left
;
8467 // Erase the value for 'left':
8468 delete dimensions
.left
;
8472 this.$element
.css( dimensions
);
8473 this.setIdealSize( $container
.width() );
8477 * Width with on and off states.
8479 * Mixin for widgets with a boolean state.
8485 * @param {Object} [config] Configuration options
8486 * @cfg {boolean} [value=false] Initial value
8488 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
8489 // Configuration initialization
8490 config
= config
|| {};
8496 this.$element
.addClass( 'oo-ui-toggleWidget' );
8497 this.setValue( !!config
.value
);
8504 * @param {boolean} value Changed value
8510 * Get the value of the toggle.
8514 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
8519 * Set the value of the toggle.
8521 * @param {boolean} value New value
8525 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
8527 if ( this.value
!== value
) {
8529 this.emit( 'change', value
);
8530 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
8531 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
8536 * Button that toggles on and off.
8539 * @extends OO.ui.ButtonWidget
8540 * @mixins OO.ui.ToggleWidget
8543 * @param {Object} [config] Configuration options
8544 * @cfg {boolean} [value=false] Initial value
8546 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
8547 // Configuration initialization
8548 config
= config
|| {};
8550 // Parent constructor
8551 OO
.ui
.ToggleButtonWidget
.super.call( this, config
);
8553 // Mixin constructors
8554 OO
.ui
.ToggleWidget
.call( this, config
);
8557 this.$element
.addClass( 'oo-ui-toggleButtonWidget' );
8562 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ButtonWidget
);
8563 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
8570 OO
.ui
.ToggleButtonWidget
.prototype.onClick = function () {
8571 if ( !this.isDisabled() ) {
8572 this.setValue( !this.value
);
8576 return OO
.ui
.ToggleButtonWidget
.super.prototype.onClick
.call( this );
8582 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
8584 if ( value
!== this.value
) {
8585 this.setActive( value
);
8589 OO
.ui
.ToggleButtonWidget
.super.prototype.setValue
.call( this, value
);
8594 * Switch that slides on and off.
8597 * @extends OO.ui.Widget
8598 * @mixins OO.ui.ToggleWidget
8601 * @param {Object} [config] Configuration options
8602 * @cfg {boolean} [value=false] Initial value
8604 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
8605 // Parent constructor
8606 OO
.ui
.ToggleSwitchWidget
.super.call( this, config
);
8608 // Mixin constructors
8609 OO
.ui
.ToggleWidget
.call( this, config
);
8612 this.dragging
= false;
8613 this.dragStart
= null;
8614 this.sliding
= false;
8615 this.$glow
= this.$( '<span>' );
8616 this.$grip
= this.$( '<span>' );
8619 this.$element
.on( 'click', OO
.ui
.bind( this.onClick
, this ) );
8622 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
8623 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
8625 .addClass( 'oo-ui-toggleSwitchWidget' )
8626 .append( this.$glow
, this.$grip
);
8631 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.Widget
);
8632 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
8637 * Handle mouse down events.
8639 * @param {jQuery.Event} e Mouse down event
8641 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
8642 if ( !this.isDisabled() && e
.which
=== 1 ) {
8643 this.setValue( !this.value
);