2 * OOjs UI v0.1.0-pre (48980881f3)
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: 2014-10-04T01:50:53Z
16 * Namespace for all classes, static methods and static properties.
48 * Get the user's language and any fallback languages.
50 * These language codes are used to localize user interface elements in the user's language.
52 * In environments that provide a localization system, this function should be overridden to
53 * return the user's language(s). The default implementation returns English (en) only.
55 * @return {string[]} Language codes, in descending order of priority
57 OO
.ui
.getUserLanguages = function () {
62 * Get a value in an object keyed by language code.
64 * @param {Object.<string,Mixed>} obj Object keyed by language code
65 * @param {string|null} [lang] Language code, if omitted or null defaults to any user language
66 * @param {string} [fallback] Fallback code, used if no matching language can be found
67 * @return {Mixed} Local value
69 OO
.ui
.getLocalValue = function ( obj
, lang
, fallback
) {
76 // Known user language
77 langs
= OO
.ui
.getUserLanguages();
78 for ( i
= 0, len
= langs
.length
; i
< len
; i
++ ) {
85 if ( obj
[fallback
] ) {
88 // 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 // Tool tip for a button that moves items in a list down one place
107 'ooui-outline-control-move-down': 'Move item down',
108 // Tool tip for a button that moves items in a list up one place
109 'ooui-outline-control-move-up': 'Move item up',
110 // Tool tip for a button that removes items from a list
111 'ooui-outline-control-remove': 'Remove item',
112 // Label for the toolbar group that contains a list of all other available tools
113 'ooui-toolbar-more': 'More',
114 // Default label for the accept button of a confirmation dialog
115 'ooui-dialog-message-accept': 'OK',
116 // Default label for the reject button of a confirmation dialog
117 'ooui-dialog-message-reject': 'Cancel',
118 // Title for process dialog error description
119 'ooui-dialog-process-error': 'Something went wrong',
120 // Label for process dialog dismiss error button, visible when describing errors
121 'ooui-dialog-process-dismiss': 'Dismiss',
122 // Label for process dialog retry action button, visible when describing recoverable errors
123 'ooui-dialog-process-retry': 'Try again'
127 * Get a localized message.
129 * In environments that provide a localization system, this function should be overridden to
130 * return the message translated in the user's language. The default implementation always returns
133 * After the message key, message parameters may optionally be passed. In the default implementation,
134 * any occurrences of $1 are replaced with the first parameter, $2 with the second parameter, etc.
135 * Alternative implementations of OO.ui.msg may use any substitution system they like, as long as
136 * they support unnamed, ordered message parameters.
139 * @param {string} key Message key
140 * @param {Mixed...} [params] Message parameters
141 * @return {string} Translated message with parameters substituted
143 OO
.ui
.msg = function ( key
) {
144 var message
= messages
[key
], params
= Array
.prototype.slice
.call( arguments
, 1 );
145 if ( typeof message
=== 'string' ) {
146 // Perform $1 substitution
147 message
= message
.replace( /\$(\d+)/g, function ( unused
, n
) {
148 var i
= parseInt( n
, 10 );
149 return params
[i
- 1] !== undefined ? params
[i
- 1] : '$' + n
;
152 // Return placeholder if message not found
153 message
= '[' + key
+ ']';
159 * Package a message and arguments for deferred resolution.
161 * Use this when you are statically specifying a message and the message may not yet be present.
163 * @param {string} key Message key
164 * @param {Mixed...} [params] Message parameters
165 * @return {Function} Function that returns the resolved message when executed
167 OO
.ui
.deferMsg = function () {
168 var args
= arguments
;
170 return OO
.ui
.msg
.apply( OO
.ui
, args
);
177 * If the message is a function it will be executed, otherwise it will pass through directly.
179 * @param {Function|string} msg Deferred message, or message text
180 * @return {string} Resolved message
182 OO
.ui
.resolveMsg = function ( msg
) {
183 if ( $.isFunction( msg
) ) {
192 * Element that can be marked as pending.
198 * @param {Object} [config] Configuration options
200 OO
.ui
.PendingElement
= function OoUiPendingElement( config
) {
201 // Config initialisation
202 config
= config
|| {};
206 this.$pending
= null;
209 this.setPendingElement( config
.$pending
|| this.$element
);
214 OO
.initClass( OO
.ui
.PendingElement
);
219 * Set the pending element (and clean up any existing one).
221 * @param {jQuery} $pending The element to set to pending.
223 OO
.ui
.PendingElement
.prototype.setPendingElement = function ( $pending
) {
224 if ( this.$pending
) {
225 this.$pending
.removeClass( 'oo-ui-pendingElement-pending' );
228 this.$pending
= $pending
;
229 if ( this.pending
> 0 ) {
230 this.$pending
.addClass( 'oo-ui-pendingElement-pending' );
235 * Check if input is pending.
239 OO
.ui
.PendingElement
.prototype.isPending = function () {
240 return !!this.pending
;
244 * Increase the pending stack.
248 OO
.ui
.PendingElement
.prototype.pushPending = function () {
249 if ( this.pending
=== 0 ) {
250 this.$pending
.addClass( 'oo-ui-pendingElement-pending' );
251 this.updateThemeClasses();
259 * Reduce the pending stack.
265 OO
.ui
.PendingElement
.prototype.popPending = function () {
266 if ( this.pending
=== 1 ) {
267 this.$pending
.removeClass( 'oo-ui-pendingElement-pending' );
268 this.updateThemeClasses();
270 this.pending
= Math
.max( 0, this.pending
- 1 );
280 * @mixins OO.EventEmitter
283 * @param {Object} [config] Configuration options
285 OO
.ui
.ActionSet
= function OoUiActionSet( config
) {
286 // Configuration intialization
287 config
= config
|| {};
289 // Mixin constructors
290 OO
.EventEmitter
.call( this );
295 actions
: 'getAction',
299 this.categorized
= {};
302 this.organized
= false;
303 this.changing
= false;
304 this.changed
= false;
309 OO
.mixinClass( OO
.ui
.ActionSet
, OO
.EventEmitter
);
311 /* Static Properties */
314 * Symbolic name of dialog.
321 OO
.ui
.ActionSet
.static.specialFlags
= [ 'safe', 'primary' ];
327 * @param {OO.ui.ActionWidget} action Action that was clicked
332 * @param {OO.ui.ActionWidget} action Action that was resized
337 * @param {OO.ui.ActionWidget[]} added Actions added
342 * @param {OO.ui.ActionWidget[]} added Actions removed
352 * Handle action change events.
356 OO
.ui
.ActionSet
.prototype.onActionChange = function () {
357 this.organized
= false;
358 if ( this.changing
) {
361 this.emit( 'change' );
366 * Check if a action is one of the special actions.
368 * @param {OO.ui.ActionWidget} action Action to check
369 * @return {boolean} Action is special
371 OO
.ui
.ActionSet
.prototype.isSpecial = function ( action
) {
374 for ( flag
in this.special
) {
375 if ( action
=== this.special
[flag
] ) {
386 * @param {Object} [filters] Filters to use, omit to get all actions
387 * @param {string|string[]} [filters.actions] Actions that actions must have
388 * @param {string|string[]} [filters.flags] Flags that actions must have
389 * @param {string|string[]} [filters.modes] Modes that actions must have
390 * @param {boolean} [filters.visible] Actions must be visible
391 * @param {boolean} [filters.disabled] Actions must be disabled
392 * @return {OO.ui.ActionWidget[]} Actions matching all criteria
394 OO
.ui
.ActionSet
.prototype.get = function ( filters
) {
395 var i
, len
, list
, category
, actions
, index
, match
, matches
;
400 // Collect category candidates
402 for ( category
in this.categorized
) {
403 list
= filters
[category
];
405 if ( !Array
.isArray( list
) ) {
408 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
409 actions
= this.categorized
[category
][list
[i
]];
410 if ( Array
.isArray( actions
) ) {
411 matches
.push
.apply( matches
, actions
);
416 // Remove by boolean filters
417 for ( i
= 0, len
= matches
.length
; i
< len
; i
++ ) {
420 ( filters
.visible
!== undefined && match
.isVisible() !== filters
.visible
) ||
421 ( filters
.disabled
!== undefined && match
.isDisabled() !== filters
.disabled
)
423 matches
.splice( i
, 1 );
429 for ( i
= 0, len
= matches
.length
; i
< len
; i
++ ) {
431 index
= matches
.lastIndexOf( match
);
432 while ( index
!== i
) {
433 matches
.splice( index
, 1 );
435 index
= matches
.lastIndexOf( match
);
440 return this.list
.slice();
444 * Get special actions.
446 * Special actions are the first visible actions with special flags, such as 'safe' and 'primary'.
447 * Special flags can be configured by changing #static-specialFlags in a subclass.
449 * @return {OO.ui.ActionWidget|null} Safe action
451 OO
.ui
.ActionSet
.prototype.getSpecial = function () {
453 return $.extend( {}, this.special
);
459 * Other actions include all non-special visible actions.
461 * @return {OO.ui.ActionWidget[]} Other actions
463 OO
.ui
.ActionSet
.prototype.getOthers = function () {
465 return this.others
.slice();
469 * Toggle actions based on their modes.
471 * Unlike calling toggle on actions with matching flags, this will enforce mutually exclusive
472 * visibility; matching actions will be shown, non-matching actions will be hidden.
474 * @param {string} mode Mode actions must have
479 OO
.ui
.ActionSet
.prototype.setMode = function ( mode
) {
482 this.changing
= true;
483 for ( i
= 0, len
= this.list
.length
; i
< len
; i
++ ) {
484 action
= this.list
[i
];
485 action
.toggle( action
.hasMode( mode
) );
488 this.organized
= false;
489 this.changing
= false;
490 this.emit( 'change' );
496 * Change which actions are able to be performed.
498 * Actions with matching actions will be disabled/enabled. Other actions will not be changed.
500 * @param {Object.<string,boolean>} actions List of abilities, keyed by action name, values
501 * indicate actions are able to be performed
504 OO
.ui
.ActionSet
.prototype.setAbilities = function ( actions
) {
505 var i
, len
, action
, item
;
507 for ( i
= 0, len
= this.list
.length
; i
< len
; i
++ ) {
509 action
= item
.getAction();
510 if ( actions
[action
] !== undefined ) {
511 item
.setDisabled( !actions
[action
] );
519 * Executes a function once per action.
521 * When making changes to multiple actions, use this method instead of iterating over the actions
522 * manually to defer emitting a change event until after all actions have been changed.
524 * @param {Object|null} actions Filters to use for which actions to iterate over; see #get
525 * @param {Function} callback Callback to run for each action; callback is invoked with three
526 * arguments: the action, the action's index, the list of actions being iterated over
529 OO
.ui
.ActionSet
.prototype.forEach = function ( filter
, callback
) {
530 this.changed
= false;
531 this.changing
= true;
532 this.get( filter
).forEach( callback
);
533 this.changing
= false;
534 if ( this.changed
) {
535 this.emit( 'change' );
544 * @param {OO.ui.ActionWidget[]} actions Actions to add
549 OO
.ui
.ActionSet
.prototype.add = function ( actions
) {
552 this.changing
= true;
553 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
555 action
.connect( this, {
556 click
: [ 'emit', 'click', action
],
557 resize
: [ 'emit', 'resize', action
],
558 toggle
: [ 'onActionChange' ]
560 this.list
.push( action
);
562 this.organized
= false;
563 this.emit( 'add', actions
);
564 this.changing
= false;
565 this.emit( 'change' );
573 * @param {OO.ui.ActionWidget[]} actions Actions to remove
578 OO
.ui
.ActionSet
.prototype.remove = function ( actions
) {
579 var i
, len
, index
, action
;
581 this.changing
= true;
582 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
584 index
= this.list
.indexOf( action
);
585 if ( index
!== -1 ) {
586 action
.disconnect( this );
587 this.list
.splice( index
, 1 );
590 this.organized
= false;
591 this.emit( 'remove', actions
);
592 this.changing
= false;
593 this.emit( 'change' );
599 * Remove all actions.
605 OO
.ui
.ActionSet
.prototype.clear = function () {
607 removed
= this.list
.slice();
609 this.changing
= true;
610 for ( i
= 0, len
= this.list
.length
; i
< len
; i
++ ) {
611 action
= this.list
[i
];
612 action
.disconnect( this );
617 this.organized
= false;
618 this.emit( 'remove', removed
);
619 this.changing
= false;
620 this.emit( 'change' );
628 * This is called whenver organized information is requested. It will only reorganize the actions
629 * if something has changed since the last time it ran.
634 OO
.ui
.ActionSet
.prototype.organize = function () {
635 var i
, iLen
, j
, jLen
, flag
, action
, category
, list
, item
, special
,
636 specialFlags
= this.constructor.static.specialFlags
;
638 if ( !this.organized
) {
639 this.categorized
= {};
642 for ( i
= 0, iLen
= this.list
.length
; i
< iLen
; i
++ ) {
643 action
= this.list
[i
];
644 if ( action
.isVisible() ) {
645 // Populate catgeories
646 for ( category
in this.categories
) {
647 if ( !this.categorized
[category
] ) {
648 this.categorized
[category
] = {};
650 list
= action
[this.categories
[category
]]();
651 if ( !Array
.isArray( list
) ) {
654 for ( j
= 0, jLen
= list
.length
; j
< jLen
; j
++ ) {
656 if ( !this.categorized
[category
][item
] ) {
657 this.categorized
[category
][item
] = [];
659 this.categorized
[category
][item
].push( action
);
662 // Populate special/others
664 for ( j
= 0, jLen
= specialFlags
.length
; j
< jLen
; j
++ ) {
665 flag
= specialFlags
[j
];
666 if ( !this.special
[flag
] && action
.hasFlag( flag
) ) {
667 this.special
[flag
] = action
;
673 this.others
.push( action
);
677 this.organized
= true;
684 * DOM element abstraction.
690 * @param {Object} [config] Configuration options
691 * @cfg {Function} [$] jQuery for the frame the widget is in
692 * @cfg {string[]} [classes] CSS class names
693 * @cfg {string} [text] Text to insert
694 * @cfg {jQuery} [$content] Content elements to append (after text)
696 OO
.ui
.Element
= function OoUiElement( config
) {
697 // Configuration initialization
698 config
= config
|| {};
701 this.$ = config
.$ || OO
.ui
.Element
.getJQuery( document
);
702 this.$element
= this.$( this.$.context
.createElement( this.getTagName() ) );
703 this.elementGroup
= null;
704 this.debouncedUpdateThemeClassesHandler
= OO
.ui
.bind(
705 this.debouncedUpdateThemeClasses
, this
707 this.updateThemeClassesPending
= false;
710 if ( $.isArray( config
.classes
) ) {
711 this.$element
.addClass( config
.classes
.join( ' ' ) );
714 this.$element
.text( config
.text
);
716 if ( config
.$content
) {
717 this.$element
.append( config
.$content
);
723 OO
.initClass( OO
.ui
.Element
);
725 /* Static Properties */
730 * This may be ignored if getTagName is overridden.
736 OO
.ui
.Element
.static.tagName
= 'div';
741 * Get a jQuery function within a specific document.
744 * @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
745 * @param {jQuery} [$iframe] HTML iframe element that contains the document, omit if document is
747 * @return {Function} Bound jQuery function
749 OO
.ui
.Element
.getJQuery = function ( context
, $iframe
) {
750 function wrapper( selector
) {
751 return $( selector
, wrapper
.context
);
754 wrapper
.context
= this.getDocument( context
);
757 wrapper
.$iframe
= $iframe
;
764 * Get the document of an element.
767 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Object to get the document for
768 * @return {HTMLDocument|null} Document object
770 OO
.ui
.Element
.getDocument = function ( obj
) {
771 // jQuery - selections created "offscreen" won't have a context, so .context isn't reliable
772 return ( obj
[0] && obj
[0].ownerDocument
) ||
773 // Empty jQuery selections might have a context
780 ( obj
.nodeType
=== 9 && obj
) ||
785 * Get the window of an element or document.
788 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the window for
789 * @return {Window} Window object
791 OO
.ui
.Element
.getWindow = function ( obj
) {
792 var doc
= this.getDocument( obj
);
793 return doc
.parentWindow
|| doc
.defaultView
;
797 * Get the direction of an element or document.
800 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the direction for
801 * @return {string} Text direction, either `ltr` or `rtl`
803 OO
.ui
.Element
.getDir = function ( obj
) {
806 if ( obj
instanceof jQuery
) {
809 isDoc
= obj
.nodeType
=== 9;
810 isWin
= obj
.document
!== undefined;
811 if ( isDoc
|| isWin
) {
817 return $( obj
).css( 'direction' );
821 * Get the offset between two frames.
823 * TODO: Make this function not use recursion.
826 * @param {Window} from Window of the child frame
827 * @param {Window} [to=window] Window of the parent frame
828 * @param {Object} [offset] Offset to start with, used internally
829 * @return {Object} Offset object, containing left and top properties
831 OO
.ui
.Element
.getFrameOffset = function ( from, to
, offset
) {
832 var i
, len
, frames
, frame
, rect
;
838 offset
= { top
: 0, left
: 0 };
840 if ( from.parent
=== from ) {
844 // Get iframe element
845 frames
= from.parent
.document
.getElementsByTagName( 'iframe' );
846 for ( i
= 0, len
= frames
.length
; i
< len
; i
++ ) {
847 if ( frames
[i
].contentWindow
=== from ) {
853 // Recursively accumulate offset values
855 rect
= frame
.getBoundingClientRect();
856 offset
.left
+= rect
.left
;
857 offset
.top
+= rect
.top
;
859 this.getFrameOffset( from.parent
, offset
);
866 * Get the offset between two elements.
869 * @param {jQuery} $from
870 * @param {jQuery} $to
871 * @return {Object} Translated position coordinates, containing top and left properties
873 OO
.ui
.Element
.getRelativePosition = function ( $from, $to
) {
874 var from = $from.offset(),
876 return { top
: Math
.round( from.top
- to
.top
), left
: Math
.round( from.left
- to
.left
) };
880 * Get element border sizes.
883 * @param {HTMLElement} el Element to measure
884 * @return {Object} Dimensions object with `top`, `left`, `bottom` and `right` properties
886 OO
.ui
.Element
.getBorders = function ( el
) {
887 var doc
= el
.ownerDocument
,
888 win
= doc
.parentWindow
|| doc
.defaultView
,
889 style
= win
&& win
.getComputedStyle
?
890 win
.getComputedStyle( el
, null ) :
893 top
= parseFloat( style
? style
.borderTopWidth
: $el
.css( 'borderTopWidth' ) ) || 0,
894 left
= parseFloat( style
? style
.borderLeftWidth
: $el
.css( 'borderLeftWidth' ) ) || 0,
895 bottom
= parseFloat( style
? style
.borderBottomWidth
: $el
.css( 'borderBottomWidth' ) ) || 0,
896 right
= parseFloat( style
? style
.borderRightWidth
: $el
.css( 'borderRightWidth' ) ) || 0;
899 top
: Math
.round( top
),
900 left
: Math
.round( left
),
901 bottom
: Math
.round( bottom
),
902 right
: Math
.round( right
)
907 * Get dimensions of an element or window.
910 * @param {HTMLElement|Window} el Element to measure
911 * @return {Object} Dimensions object with `borders`, `scroll`, `scrollbar` and `rect` properties
913 OO
.ui
.Element
.getDimensions = function ( el
) {
915 doc
= el
.ownerDocument
|| el
.document
,
916 win
= doc
.parentWindow
|| doc
.defaultView
;
918 if ( win
=== el
|| el
=== doc
.documentElement
) {
921 borders
: { top
: 0, left
: 0, bottom
: 0, right
: 0 },
923 top
: $win
.scrollTop(),
924 left
: $win
.scrollLeft()
926 scrollbar
: { right
: 0, bottom
: 0 },
930 bottom
: $win
.innerHeight(),
931 right
: $win
.innerWidth()
937 borders
: this.getBorders( el
),
939 top
: $el
.scrollTop(),
940 left
: $el
.scrollLeft()
943 right
: $el
.innerWidth() - el
.clientWidth
,
944 bottom
: $el
.innerHeight() - el
.clientHeight
946 rect
: el
.getBoundingClientRect()
952 * Get closest scrollable container.
954 * Traverses up until either a scrollable element or the root is reached, in which case the window
958 * @param {HTMLElement} el Element to find scrollable container for
959 * @param {string} [dimension] Dimension of scrolling to look for; `x`, `y` or omit for either
960 * @return {HTMLElement} Closest scrollable container
962 OO
.ui
.Element
.getClosestScrollableContainer = function ( el
, dimension
) {
964 props
= [ 'overflow' ],
965 $parent
= $( el
).parent();
967 if ( dimension
=== 'x' || dimension
=== 'y' ) {
968 props
.push( 'overflow-' + dimension
);
971 while ( $parent
.length
) {
972 if ( $parent
[0] === el
.ownerDocument
.body
) {
977 val
= $parent
.css( props
[i
] );
978 if ( val
=== 'auto' || val
=== 'scroll' ) {
982 $parent
= $parent
.parent();
984 return this.getDocument( el
).body
;
988 * Scroll element into view.
991 * @param {HTMLElement} el Element to scroll into view
992 * @param {Object} [config={}] Configuration config
993 * @param {string} [config.duration] jQuery animation duration value
994 * @param {string} [config.direction] Scroll in only one direction, e.g. 'x' or 'y', omit
995 * to scroll in both directions
996 * @param {Function} [config.complete] Function to call when scrolling completes
998 OO
.ui
.Element
.scrollIntoView = function ( el
, config
) {
999 // Configuration initialization
1000 config
= config
|| {};
1003 callback
= typeof config
.complete
=== 'function' && config
.complete
,
1004 sc
= this.getClosestScrollableContainer( el
, config
.direction
),
1006 eld
= this.getDimensions( el
),
1007 scd
= this.getDimensions( sc
),
1008 $win
= $( this.getWindow( el
) );
1010 // Compute the distances between the edges of el and the edges of the scroll viewport
1011 if ( $sc
.is( 'body' ) ) {
1012 // If the scrollable container is the <body> this is easy
1015 bottom
: $win
.innerHeight() - eld
.rect
.bottom
,
1016 left
: eld
.rect
.left
,
1017 right
: $win
.innerWidth() - eld
.rect
.right
1020 // Otherwise, we have to subtract el's coordinates from sc's coordinates
1022 top
: eld
.rect
.top
- ( scd
.rect
.top
+ scd
.borders
.top
),
1023 bottom
: scd
.rect
.bottom
- scd
.borders
.bottom
- scd
.scrollbar
.bottom
- eld
.rect
.bottom
,
1024 left
: eld
.rect
.left
- ( scd
.rect
.left
+ scd
.borders
.left
),
1025 right
: scd
.rect
.right
- scd
.borders
.right
- scd
.scrollbar
.right
- eld
.rect
.right
1029 if ( !config
.direction
|| config
.direction
=== 'y' ) {
1030 if ( rel
.top
< 0 ) {
1031 anim
.scrollTop
= scd
.scroll
.top
+ rel
.top
;
1032 } else if ( rel
.top
> 0 && rel
.bottom
< 0 ) {
1033 anim
.scrollTop
= scd
.scroll
.top
+ Math
.min( rel
.top
, -rel
.bottom
);
1036 if ( !config
.direction
|| config
.direction
=== 'x' ) {
1037 if ( rel
.left
< 0 ) {
1038 anim
.scrollLeft
= scd
.scroll
.left
+ rel
.left
;
1039 } else if ( rel
.left
> 0 && rel
.right
< 0 ) {
1040 anim
.scrollLeft
= scd
.scroll
.left
+ Math
.min( rel
.left
, -rel
.right
);
1043 if ( !$.isEmptyObject( anim
) ) {
1044 $sc
.stop( true ).animate( anim
, config
.duration
|| 'fast' );
1046 $sc
.queue( function ( next
) {
1059 * Bind a handler for an event on a DOM element.
1061 * Used to be for working around a jQuery bug (jqbug.com/14180),
1062 * but obsolete as of jQuery 1.11.0.
1065 * @deprecated Use jQuery#on instead.
1066 * @param {HTMLElement|jQuery} el DOM element
1067 * @param {string} event Event to bind
1068 * @param {Function} callback Callback to call when the event fires
1070 OO
.ui
.Element
.onDOMEvent = function ( el
, event
, callback
) {
1071 $( el
).on( event
, callback
);
1075 * Unbind a handler bound with #static-method-onDOMEvent.
1077 * @deprecated Use jQuery#off instead.
1079 * @param {HTMLElement|jQuery} el DOM element
1080 * @param {string} event Event to unbind
1081 * @param {Function} [callback] Callback to unbind
1083 OO
.ui
.Element
.offDOMEvent = function ( el
, event
, callback
) {
1084 $( el
).off( event
, callback
);
1090 * Update the theme-provided classes.
1092 * @localdoc This is called in element mixins and widget classes anytime state changes.
1093 * Updating is debounced, minimizing overhead of changing multiple attributes and
1094 * guaranteeing that theme updates do not occur within an element's constructor
1096 OO
.ui
.Element
.prototype.updateThemeClasses = function () {
1097 if ( !this.updateThemeClassesPending
) {
1098 this.updateThemeClassesPending
= true;
1099 setTimeout( this.debouncedUpdateThemeClassesHandler
);
1106 OO
.ui
.Element
.prototype.debouncedUpdateThemeClasses = function () {
1107 OO
.ui
.theme
.updateElementClasses( this );
1108 this.updateThemeClassesPending
= false;
1112 * Get the HTML tag name.
1114 * Override this method to base the result on instance information.
1116 * @return {string} HTML tag name
1118 OO
.ui
.Element
.prototype.getTagName = function () {
1119 return this.constructor.static.tagName
;
1123 * Check if the element is attached to the DOM
1124 * @return {boolean} The element is attached to the DOM
1126 OO
.ui
.Element
.prototype.isElementAttached = function () {
1127 return $.contains( this.getElementDocument(), this.$element
[0] );
1131 * Get the DOM document.
1133 * @return {HTMLDocument} Document object
1135 OO
.ui
.Element
.prototype.getElementDocument = function () {
1136 return OO
.ui
.Element
.getDocument( this.$element
);
1140 * Get the DOM window.
1142 * @return {Window} Window object
1144 OO
.ui
.Element
.prototype.getElementWindow = function () {
1145 return OO
.ui
.Element
.getWindow( this.$element
);
1149 * Get closest scrollable container.
1151 OO
.ui
.Element
.prototype.getClosestScrollableElementContainer = function () {
1152 return OO
.ui
.Element
.getClosestScrollableContainer( this.$element
[0] );
1156 * Get group element is in.
1158 * @return {OO.ui.GroupElement|null} Group element, null if none
1160 OO
.ui
.Element
.prototype.getElementGroup = function () {
1161 return this.elementGroup
;
1165 * Set group element is in.
1167 * @param {OO.ui.GroupElement|null} group Group element, null if none
1170 OO
.ui
.Element
.prototype.setElementGroup = function ( group
) {
1171 this.elementGroup
= group
;
1176 * Scroll element into view.
1178 * @param {Object} [config={}]
1180 OO
.ui
.Element
.prototype.scrollElementIntoView = function ( config
) {
1181 return OO
.ui
.Element
.scrollIntoView( this.$element
[0], config
);
1185 * Bind a handler for an event on this.$element
1187 * @deprecated Use jQuery#on instead.
1188 * @param {string} event
1189 * @param {Function} callback
1191 OO
.ui
.Element
.prototype.onDOMEvent = function ( event
, callback
) {
1192 OO
.ui
.Element
.onDOMEvent( this.$element
, event
, callback
);
1196 * Unbind a handler bound with #offDOMEvent
1198 * @deprecated Use jQuery#off instead.
1199 * @param {string} event
1200 * @param {Function} callback
1202 OO
.ui
.Element
.prototype.offDOMEvent = function ( event
, callback
) {
1203 OO
.ui
.Element
.offDOMEvent( this.$element
, event
, callback
);
1207 * Container for elements.
1211 * @extends OO.ui.Element
1212 * @mixins OO.EventEmitter
1215 * @param {Object} [config] Configuration options
1217 OO
.ui
.Layout
= function OoUiLayout( config
) {
1218 // Initialize config
1219 config
= config
|| {};
1221 // Parent constructor
1222 OO
.ui
.Layout
.super.call( this, config
);
1224 // Mixin constructors
1225 OO
.EventEmitter
.call( this );
1228 this.$element
.addClass( 'oo-ui-layout' );
1233 OO
.inheritClass( OO
.ui
.Layout
, OO
.ui
.Element
);
1234 OO
.mixinClass( OO
.ui
.Layout
, OO
.EventEmitter
);
1237 * User interface control.
1241 * @extends OO.ui.Element
1242 * @mixins OO.EventEmitter
1245 * @param {Object} [config] Configuration options
1246 * @cfg {boolean} [disabled=false] Disable
1248 OO
.ui
.Widget
= function OoUiWidget( config
) {
1249 // Initialize config
1250 config
= $.extend( { disabled
: false }, config
);
1252 // Parent constructor
1253 OO
.ui
.Widget
.super.call( this, config
);
1255 // Mixin constructors
1256 OO
.EventEmitter
.call( this );
1259 this.visible
= true;
1260 this.disabled
= null;
1261 this.wasDisabled
= null;
1264 this.$element
.addClass( 'oo-ui-widget' );
1265 this.setDisabled( !!config
.disabled
);
1270 OO
.inheritClass( OO
.ui
.Widget
, OO
.ui
.Element
);
1271 OO
.mixinClass( OO
.ui
.Widget
, OO
.EventEmitter
);
1277 * @param {boolean} disabled Widget is disabled
1282 * @param {boolean} visible Widget is visible
1288 * Check if the widget is disabled.
1290 * @param {boolean} Button is disabled
1292 OO
.ui
.Widget
.prototype.isDisabled = function () {
1293 return this.disabled
;
1297 * Check if widget is visible.
1299 * @return {boolean} Widget is visible
1301 OO
.ui
.Widget
.prototype.isVisible = function () {
1302 return this.visible
;
1306 * Set the disabled state of the widget.
1308 * This should probably change the widgets' appearance and prevent it from being used.
1310 * @param {boolean} disabled Disable widget
1313 OO
.ui
.Widget
.prototype.setDisabled = function ( disabled
) {
1316 this.disabled
= !!disabled
;
1317 isDisabled
= this.isDisabled();
1318 if ( isDisabled
!== this.wasDisabled
) {
1319 this.$element
.toggleClass( 'oo-ui-widget-disabled', isDisabled
);
1320 this.$element
.toggleClass( 'oo-ui-widget-enabled', !isDisabled
);
1321 this.emit( 'disable', isDisabled
);
1322 this.updateThemeClasses();
1324 this.wasDisabled
= isDisabled
;
1330 * Toggle visibility of widget.
1332 * @param {boolean} [show] Make widget visible, omit to toggle visibility
1336 OO
.ui
.Widget
.prototype.toggle = function ( show
) {
1337 show
= show
=== undefined ? !this.visible
: !!show
;
1339 if ( show
!== this.isVisible() ) {
1340 this.visible
= show
;
1341 this.$element
.toggle( show
);
1342 this.emit( 'toggle', show
);
1349 * Update the disabled state, in case of changes in parent widget.
1353 OO
.ui
.Widget
.prototype.updateDisabled = function () {
1354 this.setDisabled( this.disabled
);
1359 * Container for elements in a child frame.
1361 * Use together with OO.ui.WindowManager.
1365 * @extends OO.ui.Element
1366 * @mixins OO.EventEmitter
1368 * When a window is opened, the setup and ready processes are executed. Similarly, the hold and
1369 * teardown processes are executed when the window is closed.
1371 * - {@link OO.ui.WindowManager#openWindow} or {@link #open} methods are used to start opening
1372 * - Window manager begins opening window
1373 * - {@link #getSetupProcess} method is called and its result executed
1374 * - {@link #getReadyProcess} method is called and its result executed
1375 * - Window is now open
1377 * - {@link OO.ui.WindowManager#closeWindow} or {@link #close} methods are used to start closing
1378 * - Window manager begins closing window
1379 * - {@link #getHoldProcess} method is called and its result executed
1380 * - {@link #getTeardownProcess} method is called and its result executed
1381 * - Window is now closed
1383 * Each process (setup, ready, hold and teardown) can be extended in subclasses by overriding
1384 * {@link #getSetupProcess}, {@link #getReadyProcess}, {@link #getHoldProcess} and
1385 * {@link #getTeardownProcess} respectively. Each process is executed in series, so asynchonous
1386 * processing can complete. Always assume window processes are executed asychronously. See
1387 * OO.ui.Process for more details about how to work with processes. Some events, as well as the
1388 * #open and #close methods, provide promises which are resolved when the window enters a new state.
1390 * Sizing of windows is specified using symbolic names which are interpreted by the window manager.
1391 * If the requested size is not recognized, the window manager will choose a sensible fallback.
1394 * @param {Object} [config] Configuration options
1395 * @cfg {string} [size] Symbolic name of dialog size, `small`, `medium`, `large` or `full`; omit to
1399 OO
.ui
.Window
= function OoUiWindow( config
) {
1400 // Configuration initialization
1401 config
= config
|| {};
1403 // Parent constructor
1404 OO
.ui
.Window
.super.call( this, config
);
1406 // Mixin constructors
1407 OO
.EventEmitter
.call( this );
1410 this.manager
= null;
1411 this.initialized
= false;
1412 this.visible
= false;
1413 this.opening
= null;
1414 this.closing
= null;
1417 this.loading
= null;
1418 this.size
= config
.size
|| this.constructor.static.size
;
1419 this.$frame
= this.$( '<div>' );
1423 .addClass( 'oo-ui-window' )
1424 .append( this.$frame
);
1425 this.$frame
.addClass( 'oo-ui-window-frame' );
1427 // NOTE: Additional intitialization will occur when #setManager is called
1432 OO
.inheritClass( OO
.ui
.Window
, OO
.ui
.Element
);
1433 OO
.mixinClass( OO
.ui
.Window
, OO
.EventEmitter
);
1435 /* Static Properties */
1438 * Symbolic name of size.
1440 * Size is used if no size is configured during construction.
1444 * @property {string}
1446 OO
.ui
.Window
.static.size
= 'medium';
1448 /* Static Methods */
1451 * Transplant the CSS styles from as parent document to a frame's document.
1453 * This loops over the style sheets in the parent document, and copies their nodes to the
1454 * frame's document. It then polls the document to see when all styles have loaded, and once they
1455 * have, resolves the promise.
1457 * If the styles still haven't loaded after a long time (5 seconds by default), we give up waiting
1458 * and resolve the promise anyway. This protects against cases like a display: none; iframe in
1459 * Firefox, where the styles won't load until the iframe becomes visible.
1461 * For details of how we arrived at the strategy used in this function, see #load.
1465 * @param {HTMLDocument} parentDoc Document to transplant styles from
1466 * @param {HTMLDocument} frameDoc Document to transplant styles to
1467 * @param {number} [timeout=5000] How long to wait before giving up (in ms). If 0, never give up.
1468 * @return {jQuery.Promise} Promise resolved when styles have loaded
1470 OO
.ui
.Window
.static.transplantStyles = function ( parentDoc
, frameDoc
, timeout
) {
1471 var i
, numSheets
, styleNode
, styleText
, newNode
, timeoutID
, pollNodeId
, $pendingPollNodes
,
1472 $pollNodes
= $( [] ),
1473 // Fake font-family value
1474 fontFamily
= 'oo-ui-frame-transplantStyles-loaded',
1475 nextIndex
= parentDoc
.oouiFrameTransplantStylesNextIndex
|| 0,
1476 deferred
= $.Deferred();
1478 for ( i
= 0, numSheets
= parentDoc
.styleSheets
.length
; i
< numSheets
; i
++ ) {
1479 styleNode
= parentDoc
.styleSheets
[i
].ownerNode
;
1480 if ( styleNode
.disabled
) {
1484 if ( styleNode
.nodeName
.toLowerCase() === 'link' ) {
1485 // External stylesheet; use @import
1486 styleText
= '@import url(' + styleNode
.href
+ ');';
1488 // Internal stylesheet; just copy the text
1489 // For IE10 we need to fall back to .cssText, BUT that's undefined in
1490 // other browsers, so fall back to '' rather than 'undefined'
1491 styleText
= styleNode
.textContent
|| parentDoc
.styleSheets
[i
].cssText
|| '';
1494 // Create a node with a unique ID that we're going to monitor to see when the CSS
1496 if ( styleNode
.oouiFrameTransplantStylesId
) {
1497 // If we're nesting transplantStyles operations and this node already has
1498 // a CSS rule to wait for loading, reuse it
1499 pollNodeId
= styleNode
.oouiFrameTransplantStylesId
;
1501 // Otherwise, create a new ID
1502 pollNodeId
= 'oo-ui-frame-transplantStyles-loaded-' + nextIndex
;
1505 // Add #pollNodeId { font-family: ... } to the end of the stylesheet / after the @import
1506 // The font-family rule will only take effect once the @import finishes
1507 styleText
+= '\n' + '#' + pollNodeId
+ ' { font-family: ' + fontFamily
+ '; }';
1510 // Create a node with id=pollNodeId
1511 $pollNodes
= $pollNodes
.add( $( '<div>', frameDoc
)
1512 .attr( 'id', pollNodeId
)
1513 .appendTo( frameDoc
.body
)
1516 // Add our modified CSS as a <style> tag
1517 newNode
= frameDoc
.createElement( 'style' );
1518 newNode
.textContent
= styleText
;
1519 newNode
.oouiFrameTransplantStylesId
= pollNodeId
;
1520 frameDoc
.head
.appendChild( newNode
);
1522 frameDoc
.oouiFrameTransplantStylesNextIndex
= nextIndex
;
1524 // Poll every 100ms until all external stylesheets have loaded
1525 $pendingPollNodes
= $pollNodes
;
1526 timeoutID
= setTimeout( function pollExternalStylesheets() {
1528 $pendingPollNodes
.length
> 0 &&
1529 $pendingPollNodes
.eq( 0 ).css( 'font-family' ) === fontFamily
1531 $pendingPollNodes
= $pendingPollNodes
.slice( 1 );
1534 if ( $pendingPollNodes
.length
=== 0 ) {
1536 if ( timeoutID
!== null ) {
1538 $pollNodes
.remove();
1542 timeoutID
= setTimeout( pollExternalStylesheets
, 100 );
1545 // ...but give up after a while
1546 if ( timeout
!== 0 ) {
1547 setTimeout( function () {
1549 clearTimeout( timeoutID
);
1551 $pollNodes
.remove();
1554 }, timeout
|| 5000 );
1557 return deferred
.promise();
1563 * Handle mouse down events.
1565 * @param {jQuery.Event} e Mouse down event
1567 OO
.ui
.Window
.prototype.onMouseDown = function ( e
) {
1568 // Prevent clicking on the click-block from stealing focus
1569 if ( e
.target
=== this.$element
[0] ) {
1575 * Check if window has been initialized.
1577 * @return {boolean} Window has been initialized
1579 OO
.ui
.Window
.prototype.isInitialized = function () {
1580 return this.initialized
;
1584 * Check if window is visible.
1586 * @return {boolean} Window is visible
1588 OO
.ui
.Window
.prototype.isVisible = function () {
1589 return this.visible
;
1593 * Check if window is loading.
1595 * @return {boolean} Window is loading
1597 OO
.ui
.Window
.prototype.isLoading = function () {
1598 return this.loading
&& this.loading
.state() === 'pending';
1602 * Check if window is loaded.
1604 * @return {boolean} Window is loaded
1606 OO
.ui
.Window
.prototype.isLoaded = function () {
1607 return this.loading
&& this.loading
.state() === 'resolved';
1611 * Check if window is opening.
1613 * This is a wrapper around OO.ui.WindowManager#isOpening.
1615 * @return {boolean} Window is opening
1617 OO
.ui
.Window
.prototype.isOpening = function () {
1618 return this.manager
.isOpening( this );
1622 * Check if window is closing.
1624 * This is a wrapper around OO.ui.WindowManager#isClosing.
1626 * @return {boolean} Window is closing
1628 OO
.ui
.Window
.prototype.isClosing = function () {
1629 return this.manager
.isClosing( this );
1633 * Check if window is opened.
1635 * This is a wrapper around OO.ui.WindowManager#isOpened.
1637 * @return {boolean} Window is opened
1639 OO
.ui
.Window
.prototype.isOpened = function () {
1640 return this.manager
.isOpened( this );
1644 * Get the window manager.
1646 * @return {OO.ui.WindowManager} Manager of window
1648 OO
.ui
.Window
.prototype.getManager = function () {
1649 return this.manager
;
1653 * Get the window size.
1655 * @return {string} Symbolic size name, e.g. 'small', 'medium', 'large', 'full'
1657 OO
.ui
.Window
.prototype.getSize = function () {
1662 * Get the height of the dialog contents.
1664 * @return {number} Content height
1666 OO
.ui
.Window
.prototype.getContentHeight = function () {
1667 // Temporarily resize the frame so getBodyHeight() can use scrollHeight measurements
1668 var bodyHeight
, oldHeight
= this.$frame
[0].style
.height
;
1669 this.$frame
[0].style
.height
= '1px';
1670 bodyHeight
= this.getBodyHeight();
1671 this.$frame
[0].style
.height
= oldHeight
;
1674 // Add buffer for border
1675 ( this.$frame
.outerHeight() - this.$frame
.innerHeight() ) +
1676 // Use combined heights of children
1677 ( this.$head
.outerHeight( true ) + bodyHeight
+ this.$foot
.outerHeight( true ) )
1682 * Get the height of the dialog contents.
1684 * When this function is called, the dialog will temporarily have been resized
1685 * to height=1px, so .scrollHeight measurements can be taken accurately.
1687 * @return {number} Height of content
1689 OO
.ui
.Window
.prototype.getBodyHeight = function () {
1690 return this.$body
[0].scrollHeight
;
1694 * Get the directionality of the frame
1696 * @return {string} Directionality, 'ltr' or 'rtl'
1698 OO
.ui
.Window
.prototype.getDir = function () {
1703 * Get a process for setting up a window for use.
1705 * Each time the window is opened this process will set it up for use in a particular context, based
1706 * on the `data` argument.
1708 * When you override this method, you can add additional setup steps to the process the parent
1709 * method provides using the 'first' and 'next' methods.
1712 * @param {Object} [data] Window opening data
1713 * @return {OO.ui.Process} Setup process
1715 OO
.ui
.Window
.prototype.getSetupProcess = function () {
1716 return new OO
.ui
.Process();
1720 * Get a process for readying a window for use.
1722 * Each time the window is open and setup, this process will ready it up for use in a particular
1723 * context, based on the `data` argument.
1725 * When you override this method, you can add additional setup steps to the process the parent
1726 * method provides using the 'first' and 'next' methods.
1729 * @param {Object} [data] Window opening data
1730 * @return {OO.ui.Process} Setup process
1732 OO
.ui
.Window
.prototype.getReadyProcess = function () {
1733 return new OO
.ui
.Process();
1737 * Get a process for holding a window from use.
1739 * Each time the window is closed, this process will hold it from use in a particular context, based
1740 * on the `data` argument.
1742 * When you override this method, you can add additional setup steps to the process the parent
1743 * method provides using the 'first' and 'next' methods.
1746 * @param {Object} [data] Window closing data
1747 * @return {OO.ui.Process} Hold process
1749 OO
.ui
.Window
.prototype.getHoldProcess = function () {
1750 return new OO
.ui
.Process();
1754 * Get a process for tearing down a window after use.
1756 * Each time the window is closed this process will tear it down and do something with the user's
1757 * interactions within the window, based on the `data` argument.
1759 * When you override this method, you can add additional teardown steps to the process the parent
1760 * method provides using the 'first' and 'next' methods.
1763 * @param {Object} [data] Window closing data
1764 * @return {OO.ui.Process} Teardown process
1766 OO
.ui
.Window
.prototype.getTeardownProcess = function () {
1767 return new OO
.ui
.Process();
1771 * Toggle visibility of window.
1773 * If the window is isolated and hasn't fully loaded yet, the visiblity property will be used
1774 * instead of display.
1776 * @param {boolean} [show] Make window visible, omit to toggle visibility
1780 OO
.ui
.Window
.prototype.toggle = function ( show
) {
1781 show
= show
=== undefined ? !this.visible
: !!show
;
1783 if ( show
!== this.isVisible() ) {
1784 this.visible
= show
;
1786 if ( this.isolated
&& !this.isLoaded() ) {
1787 // Hide the window using visibility instead of display until loading is complete
1788 // Can't use display: none; because that prevents the iframe from loading in Firefox
1789 this.$element
.css( 'visibility', show
? 'visible' : 'hidden' );
1791 this.$element
.toggle( show
).css( 'visibility', '' );
1793 this.emit( 'toggle', show
);
1800 * Set the window manager.
1802 * This must be called before initialize. Calling it more than once will cause an error.
1804 * @param {OO.ui.WindowManager} manager Manager for this window
1805 * @throws {Error} If called more than once
1808 OO
.ui
.Window
.prototype.setManager = function ( manager
) {
1809 if ( this.manager
) {
1810 throw new Error( 'Cannot set window manager, window already has a manager' );
1814 this.manager
= manager
;
1815 this.isolated
= manager
.shouldIsolate();
1818 if ( this.isolated
) {
1819 this.$iframe
= this.$( '<iframe>' );
1820 this.$iframe
.attr( { frameborder
: 0, scrolling
: 'no' } );
1821 this.$frame
.append( this.$iframe
);
1822 this.$ = function () {
1823 throw new Error( 'this.$() cannot be used until the frame has been initialized.' );
1825 // WARNING: Do not use this.$ again until #initialize is called
1827 this.$content
= this.$( '<div>' );
1828 this.$document
= $( this.getElementDocument() );
1829 this.$content
.addClass( 'oo-ui-window-content' );
1830 this.$frame
.append( this.$content
);
1832 this.toggle( false );
1834 // Figure out directionality:
1835 this.dir
= OO
.ui
.Element
.getDir( this.$iframe
|| this.$content
) || 'ltr';
1841 * Set the window size.
1843 * @param {string} size Symbolic size name, e.g. 'small', 'medium', 'large', 'full'
1846 OO
.ui
.Window
.prototype.setSize = function ( size
) {
1848 this.manager
.updateWindowSize( this );
1853 * Set window dimensions.
1855 * Properties are applied to the frame container.
1857 * @param {Object} dim CSS dimension properties
1858 * @param {string|number} [dim.width] Width
1859 * @param {string|number} [dim.minWidth] Minimum width
1860 * @param {string|number} [dim.maxWidth] Maximum width
1861 * @param {string|number} [dim.width] Height, omit to set based on height of contents
1862 * @param {string|number} [dim.minWidth] Minimum height
1863 * @param {string|number} [dim.maxWidth] Maximum height
1866 OO
.ui
.Window
.prototype.setDimensions = function ( dim
) {
1867 // Apply width before height so height is not based on wrapping content using the wrong width
1869 width
: dim
.width
|| '',
1870 minWidth
: dim
.minWidth
|| '',
1871 maxWidth
: dim
.maxWidth
|| ''
1874 height
: ( dim
.height
!== undefined ? dim
.height
: this.getContentHeight() ) || '',
1875 minHeight
: dim
.minHeight
|| '',
1876 maxHeight
: dim
.maxHeight
|| ''
1882 * Initialize window contents.
1884 * The first time the window is opened, #initialize is called when it's safe to begin populating
1885 * its contents. See #getSetupProcess for a way to make changes each time the window opens.
1887 * Once this method is called, this.$ can be used to create elements within the frame.
1889 * @throws {Error} If not attached to a manager
1892 OO
.ui
.Window
.prototype.initialize = function () {
1893 if ( !this.manager
) {
1894 throw new Error( 'Cannot initialize window, must be attached to a manager' );
1898 this.$head
= this.$( '<div>' );
1899 this.$body
= this.$( '<div>' );
1900 this.$foot
= this.$( '<div>' );
1901 this.$overlay
= this.$( '<div>' );
1902 this.$focusTrap
= this.$( '<div>' ).prop( 'tabIndex', 0 );
1905 this.$element
.on( 'mousedown', OO
.ui
.bind( this.onMouseDown
, this ) );
1908 this.$head
.addClass( 'oo-ui-window-head' );
1909 this.$body
.addClass( 'oo-ui-window-body' );
1910 this.$foot
.addClass( 'oo-ui-window-foot' );
1911 this.$overlay
.addClass( 'oo-ui-window-overlay' );
1912 this.$focusTrap
.addClass( 'oo-ui-window-focustrap' );
1913 this.$content
.append( this.$head
, this.$body
, this.$foot
, this.$overlay
, this.$focusTrap
);
1919 * Called when someone tries to focus the hidden element at the end of the dialog.
1920 * Sends focus back to the start of the dialog.
1922 OO
.ui
.Window
.prototype.onFocusTrapFocused = function () {
1923 this.$content
.find( ':focusable:first' ).focus();
1929 * This is a wrapper around calling {@link OO.ui.WindowManager#openWindow} on the window manager.
1930 * To do something each time the window opens, use #getSetupProcess or #getReadyProcess.
1932 * @param {Object} [data] Window opening data
1933 * @return {jQuery.Promise} Promise resolved when window is opened; when the promise is resolved the
1934 * first argument will be a promise which will be resolved when the window begins closing
1936 OO
.ui
.Window
.prototype.open = function ( data
) {
1937 return this.manager
.openWindow( this, data
);
1943 * This is a wrapper around calling OO.ui.WindowManager#closeWindow on the window manager.
1944 * To do something each time the window closes, use #getHoldProcess or #getTeardownProcess.
1946 * @param {Object} [data] Window closing data
1947 * @return {jQuery.Promise} Promise resolved when window is closed
1949 OO
.ui
.Window
.prototype.close = function ( data
) {
1950 return this.manager
.closeWindow( this, data
);
1956 * This is called by OO.ui.WindowManager durring window opening, and should not be called directly
1959 * @param {Object} [data] Window opening data
1960 * @return {jQuery.Promise} Promise resolved when window is setup
1962 OO
.ui
.Window
.prototype.setup = function ( data
) {
1964 deferred
= $.Deferred();
1966 this.$element
.show();
1967 this.visible
= true;
1968 this.focusTrapHandler
= OO
.ui
.bind( this.onFocusTrapFocused
, this );
1969 this.$focusTrap
.on( 'focus', this.focusTrapHandler
);
1970 this.getSetupProcess( data
).execute().done( function () {
1971 // Force redraw by asking the browser to measure the elements' widths
1972 win
.$element
.addClass( 'oo-ui-window-setup' ).width();
1973 win
.$content
.addClass( 'oo-ui-window-content-setup' ).width();
1977 return deferred
.promise();
1983 * This is called by OO.ui.WindowManager durring window opening, and should not be called directly
1986 * @param {Object} [data] Window opening data
1987 * @return {jQuery.Promise} Promise resolved when window is ready
1989 OO
.ui
.Window
.prototype.ready = function ( data
) {
1991 deferred
= $.Deferred();
1993 this.$content
.focus();
1994 this.getReadyProcess( data
).execute().done( function () {
1995 // Force redraw by asking the browser to measure the elements' widths
1996 win
.$element
.addClass( 'oo-ui-window-ready' ).width();
1997 win
.$content
.addClass( 'oo-ui-window-content-ready' ).width();
2001 return deferred
.promise();
2007 * This is called by OO.ui.WindowManager durring window closing, and should not be called directly
2010 * @param {Object} [data] Window closing data
2011 * @return {jQuery.Promise} Promise resolved when window is held
2013 OO
.ui
.Window
.prototype.hold = function ( data
) {
2015 deferred
= $.Deferred();
2017 this.getHoldProcess( data
).execute().done( function () {
2018 // Get the focused element within the window's content
2019 var $focus
= win
.$content
.find( OO
.ui
.Element
.getDocument( win
.$content
).activeElement
);
2021 // Blur the focused element
2022 if ( $focus
.length
) {
2026 // Force redraw by asking the browser to measure the elements' widths
2027 win
.$element
.removeClass( 'oo-ui-window-ready' ).width();
2028 win
.$content
.removeClass( 'oo-ui-window-content-ready' ).width();
2032 return deferred
.promise();
2038 * This is called by OO.ui.WindowManager durring window closing, and should not be called directly
2041 * @param {Object} [data] Window closing data
2042 * @return {jQuery.Promise} Promise resolved when window is torn down
2044 OO
.ui
.Window
.prototype.teardown = function ( data
) {
2046 deferred
= $.Deferred();
2048 this.getTeardownProcess( data
).execute().done( OO
.ui
.bind( function () {
2049 // Force redraw by asking the browser to measure the elements' widths
2050 win
.$element
.removeClass( 'oo-ui-window-setup' ).width();
2051 win
.$content
.removeClass( 'oo-ui-window-content-setup' ).width();
2052 win
.$element
.hide();
2053 this.$focusTrap
.off( 'focus', this.focusTrapHandler
);
2054 win
.visible
= false;
2058 return deferred
.promise();
2062 * Load the frame contents.
2064 * Once the iframe's stylesheets are loaded, the `load` event will be emitted and the returned
2065 * promise will be resolved. Calling while loading will return a promise but not trigger a new
2066 * loading cycle. Calling after loading is complete will return a promise that's already been
2069 * Sounds simple right? Read on...
2071 * When you create a dynamic iframe using open/write/close, the window.load event for the
2072 * iframe is triggered when you call close, and there's no further load event to indicate that
2073 * everything is actually loaded.
2075 * In Chrome, stylesheets don't show up in document.styleSheets until they have loaded, so we could
2076 * just poll that array and wait for it to have the right length. However, in Firefox, stylesheets
2077 * are added to document.styleSheets immediately, and the only way you can determine whether they've
2078 * loaded is to attempt to access .cssRules and wait for that to stop throwing an exception. But
2079 * cross-domain stylesheets never allow .cssRules to be accessed even after they have loaded.
2081 * The workaround is to change all `<link href="...">` tags to `<style>@import url(...)</style>`
2082 * tags. Because `@import` is blocking, Chrome won't add the stylesheet to document.styleSheets
2083 * until the `@import` has finished, and Firefox won't allow .cssRules to be accessed until the
2084 * `@import` has finished. And because the contents of the `<style>` tag are from the same origin,
2085 * accessing .cssRules is allowed.
2087 * However, now that we control the styles we're injecting, we might as well do away with
2088 * browser-specific polling hacks like document.styleSheets and .cssRules, and instead inject
2089 * `<style>@import url(...); #foo { font-family: someValue; }</style>`, then create `<div id="foo">`
2090 * and wait for its font-family to change to someValue. Because `@import` is blocking, the
2091 * font-family rule is not applied until after the `@import` finishes.
2093 * All this stylesheet injection and polling magic is in #transplantStyles.
2095 * @return {jQuery.Promise} Promise resolved when loading is complete
2098 OO
.ui
.Window
.prototype.load = function () {
2099 var sub
, doc
, loading
,
2102 // Non-isolated windows are already "loaded"
2103 if ( !this.loading
&& !this.isolated
) {
2104 this.loading
= $.Deferred().resolve();
2106 // Set initialized state after so sub-classes aren't confused by it being set by calling
2107 // their parent initialize method
2108 this.initialized
= true;
2111 // Return existing promise if already loading or loaded
2112 if ( this.loading
) {
2113 return this.loading
.promise();
2117 loading
= this.loading
= $.Deferred();
2118 sub
= this.$iframe
.prop( 'contentWindow' );
2121 // Initialize contents
2126 '<body class="oo-ui-window-isolated oo-ui-' + this.dir
+ '"' +
2127 ' style="direction:' + this.dir
+ ';" dir="' + this.dir
+ '">' +
2128 '<div class="oo-ui-window-content"></div>' +
2135 this.$ = OO
.ui
.Element
.getJQuery( doc
, this.$iframe
);
2136 this.$content
= this.$( '.oo-ui-window-content' ).attr( 'tabIndex', 0 );
2137 this.$document
= this.$( doc
);
2140 this.constructor.static.transplantStyles( this.getElementDocument(), this.$document
[0] )
2141 .always( function () {
2142 // Initialize isolated windows
2144 // Set initialized state after so sub-classes aren't confused by it being set by calling
2145 // their parent initialize method
2146 win
.initialized
= true;
2147 // Undo the visibility: hidden; hack and apply display: none;
2148 // We can do this safely now that the iframe has initialized
2149 // (don't do this from within #initialize because it has to happen
2150 // after the all subclasses have been handled as well).
2151 win
.toggle( win
.isVisible() );
2156 return loading
.promise();
2160 * Base class for all dialogs.
2163 * - Manage the window (open and close, etc.).
2164 * - Store the internal name and display title.
2165 * - A stack to track one or more pending actions.
2166 * - Manage a set of actions that can be performed.
2167 * - Configure and create action widgets.
2170 * - Close the dialog with Escape key.
2171 * - Visually lock the dialog while an action is in
2172 * progress (aka "pending").
2174 * Subclass responsibilities:
2175 * - Display the title somewhere.
2176 * - Add content to the dialog.
2177 * - Provide a UI to close the dialog.
2178 * - Display the action widgets somewhere.
2182 * @extends OO.ui.Window
2183 * @mixins OO.ui.PendingElement
2186 * @param {Object} [config] Configuration options
2188 OO
.ui
.Dialog
= function OoUiDialog( config
) {
2189 // Parent constructor
2190 OO
.ui
.Dialog
.super.call( this, config
);
2192 // Mixin constructors
2193 OO
.ui
.PendingElement
.call( this );
2196 this.actions
= new OO
.ui
.ActionSet();
2197 this.attachedActions
= [];
2198 this.currentAction
= null;
2201 this.actions
.connect( this, {
2202 click
: 'onActionClick',
2203 resize
: 'onActionResize',
2204 change
: 'onActionsChange'
2209 .addClass( 'oo-ui-dialog' )
2210 .attr( 'role', 'dialog' );
2215 OO
.inheritClass( OO
.ui
.Dialog
, OO
.ui
.Window
);
2216 OO
.mixinClass( OO
.ui
.Dialog
, OO
.ui
.PendingElement
);
2218 /* Static Properties */
2221 * Symbolic name of dialog.
2226 * @property {string}
2228 OO
.ui
.Dialog
.static.name
= '';
2236 * @property {jQuery|string|Function} Label nodes, text or a function that returns nodes or text
2238 OO
.ui
.Dialog
.static.title
= '';
2241 * List of OO.ui.ActionWidget configuration options.
2245 * @property {Object[]}
2247 OO
.ui
.Dialog
.static.actions
= [];
2250 * Close dialog when the escape key is pressed.
2255 * @property {boolean}
2257 OO
.ui
.Dialog
.static.escapable
= true;
2262 * Handle frame document key down events.
2264 * @param {jQuery.Event} e Key down event
2266 OO
.ui
.Dialog
.prototype.onDocumentKeyDown = function ( e
) {
2267 if ( e
.which
=== OO
.ui
.Keys
.ESCAPE
) {
2274 * Handle action resized events.
2276 * @param {OO.ui.ActionWidget} action Action that was resized
2278 OO
.ui
.Dialog
.prototype.onActionResize = function () {
2279 // Override in subclass
2283 * Handle action click events.
2285 * @param {OO.ui.ActionWidget} action Action that was clicked
2287 OO
.ui
.Dialog
.prototype.onActionClick = function ( action
) {
2288 if ( !this.isPending() ) {
2289 this.currentAction
= action
;
2290 this.executeAction( action
.getAction() );
2295 * Handle actions change event.
2297 OO
.ui
.Dialog
.prototype.onActionsChange = function () {
2298 this.detachActions();
2299 if ( !this.isClosing() ) {
2300 this.attachActions();
2305 * Get set of actions.
2307 * @return {OO.ui.ActionSet}
2309 OO
.ui
.Dialog
.prototype.getActions = function () {
2310 return this.actions
;
2314 * Get a process for taking action.
2316 * When you override this method, you can add additional accept steps to the process the parent
2317 * method provides using the 'first' and 'next' methods.
2320 * @param {string} [action] Symbolic name of action
2321 * @return {OO.ui.Process} Action process
2323 OO
.ui
.Dialog
.prototype.getActionProcess = function ( action
) {
2324 return new OO
.ui
.Process()
2325 .next( function () {
2327 // An empty action always closes the dialog without data, which should always be
2328 // safe and make no changes
2337 * @param {Object} [data] Dialog opening data
2338 * @param {jQuery|string|Function|null} [data.title] Dialog title, omit to use #static-title
2339 * @param {Object[]} [data.actions] List of OO.ui.ActionWidget configuration options for each
2340 * action item, omit to use #static-actions
2342 OO
.ui
.Dialog
.prototype.getSetupProcess = function ( data
) {
2346 return OO
.ui
.Dialog
.super.prototype.getSetupProcess
.call( this, data
)
2347 .next( function () {
2350 config
= this.constructor.static,
2351 actions
= data
.actions
!== undefined ? data
.actions
: config
.actions
;
2353 this.title
.setLabel(
2354 data
.title
!== undefined ? data
.title
: this.constructor.static.title
2356 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
2358 new OO
.ui
.ActionWidget( $.extend( { $: this.$ }, actions
[i
] ) )
2361 this.actions
.add( items
);
2368 OO
.ui
.Dialog
.prototype.getTeardownProcess = function ( data
) {
2370 return OO
.ui
.Dialog
.super.prototype.getTeardownProcess
.call( this, data
)
2371 .first( function () {
2372 this.actions
.clear();
2373 this.currentAction
= null;
2380 OO
.ui
.Dialog
.prototype.initialize = function () {
2382 OO
.ui
.Dialog
.super.prototype.initialize
.call( this );
2385 this.title
= new OO
.ui
.LabelWidget( { $: this.$ } );
2388 if ( this.constructor.static.escapable
) {
2389 this.$document
.on( 'keydown', OO
.ui
.bind( this.onDocumentKeyDown
, this ) );
2393 this.$content
.addClass( 'oo-ui-dialog-content' );
2394 this.setPendingElement( this.$head
);
2398 * Attach action actions.
2400 OO
.ui
.Dialog
.prototype.attachActions = function () {
2401 // Remember the list of potentially attached actions
2402 this.attachedActions
= this.actions
.get();
2406 * Detach action actions.
2410 OO
.ui
.Dialog
.prototype.detachActions = function () {
2413 // Detach all actions that may have been previously attached
2414 for ( i
= 0, len
= this.attachedActions
.length
; i
< len
; i
++ ) {
2415 this.attachedActions
[i
].$element
.detach();
2417 this.attachedActions
= [];
2421 * Execute an action.
2423 * @param {string} action Symbolic name of action to execute
2424 * @return {jQuery.Promise} Promise resolved when action completes, rejected if it fails
2426 OO
.ui
.Dialog
.prototype.executeAction = function ( action
) {
2428 return this.getActionProcess( action
).execute()
2429 .always( OO
.ui
.bind( this.popPending
, this ) );
2433 * Collection of windows.
2436 * @extends OO.ui.Element
2437 * @mixins OO.EventEmitter
2439 * Managed windows are mutually exclusive. If a window is opened while there is a current window
2440 * already opening or opened, the current window will be closed without data. Empty closing data
2441 * should always result in the window being closed without causing constructive or destructive
2444 * As a window is opened and closed, it passes through several stages and the manager emits several
2445 * corresponding events.
2447 * - {@link #openWindow} or {@link OO.ui.Window#open} methods are used to start opening
2448 * - {@link #event-opening} is emitted with `opening` promise
2449 * - {@link #getSetupDelay} is called the returned value is used to time a pause in execution
2450 * - {@link OO.ui.Window#getSetupProcess} method is called on the window and its result executed
2451 * - `setup` progress notification is emitted from opening promise
2452 * - {@link #getReadyDelay} is called the returned value is used to time a pause in execution
2453 * - {@link OO.ui.Window#getReadyProcess} method is called on the window and its result executed
2454 * - `ready` progress notification is emitted from opening promise
2455 * - `opening` promise is resolved with `opened` promise
2456 * - Window is now open
2458 * - {@link #closeWindow} or {@link OO.ui.Window#close} methods are used to start closing
2459 * - `opened` promise is resolved with `closing` promise
2460 * - {@link #event-closing} is emitted with `closing` promise
2461 * - {@link #getHoldDelay} is called the returned value is used to time a pause in execution
2462 * - {@link OO.ui.Window#getHoldProcess} method is called on the window and its result executed
2463 * - `hold` progress notification is emitted from opening promise
2464 * - {@link #getTeardownDelay} is called the returned value is used to time a pause in execution
2465 * - {@link OO.ui.Window#getTeardownProcess} method is called on the window and its result executed
2466 * - `teardown` progress notification is emitted from opening promise
2467 * - Closing promise is resolved
2468 * - Window is now closed
2471 * @param {Object} [config] Configuration options
2472 * @cfg {boolean} [isolate] Configure managed windows to isolate their content using inline frames
2473 * @cfg {OO.Factory} [factory] Window factory to use for automatic instantiation
2474 * @cfg {boolean} [modal=true] Prevent interaction outside the dialog
2476 OO
.ui
.WindowManager
= function OoUiWindowManager( config
) {
2477 // Configuration initialization
2478 config
= config
|| {};
2480 // Parent constructor
2481 OO
.ui
.WindowManager
.super.call( this, config
);
2483 // Mixin constructors
2484 OO
.EventEmitter
.call( this );
2487 this.factory
= config
.factory
;
2488 this.modal
= config
.modal
=== undefined || !!config
.modal
;
2489 this.isolate
= !!config
.isolate
;
2491 this.opening
= null;
2493 this.closing
= null;
2494 this.preparingToOpen
= null;
2495 this.preparingToClose
= null;
2497 this.currentWindow
= null;
2498 this.$ariaHidden
= null;
2499 this.requestedSize
= null;
2500 this.onWindowResizeTimeout
= null;
2501 this.onWindowResizeHandler
= OO
.ui
.bind( this.onWindowResize
, this );
2502 this.afterWindowResizeHandler
= OO
.ui
.bind( this.afterWindowResize
, this );
2503 this.onWindowMouseWheelHandler
= OO
.ui
.bind( this.onWindowMouseWheel
, this );
2504 this.onDocumentKeyDownHandler
= OO
.ui
.bind( this.onDocumentKeyDown
, this );
2508 .addClass( 'oo-ui-windowManager' )
2509 .toggleClass( 'oo-ui-windowManager-modal', this.modal
);
2514 OO
.inheritClass( OO
.ui
.WindowManager
, OO
.ui
.Element
);
2515 OO
.mixinClass( OO
.ui
.WindowManager
, OO
.EventEmitter
);
2520 * Window is opening.
2522 * Fired when the window begins to be opened.
2525 * @param {OO.ui.Window} win Window that's being opened
2526 * @param {jQuery.Promise} opening Promise resolved when window is opened; when the promise is
2527 * resolved the first argument will be a promise which will be resolved when the window begins
2528 * closing, the second argument will be the opening data; progress notifications will be fired on
2529 * the promise for `setup` and `ready` when those processes are completed respectively.
2530 * @param {Object} data Window opening data
2534 * Window is closing.
2536 * Fired when the window begins to be closed.
2539 * @param {OO.ui.Window} win Window that's being closed
2540 * @param {jQuery.Promise} opening Promise resolved when window is closed; when the promise
2541 * is resolved the first argument will be a the closing data; progress notifications will be fired
2542 * on the promise for `hold` and `teardown` when those processes are completed respectively.
2543 * @param {Object} data Window closing data
2547 * Window was resized.
2550 * @param {OO.ui.Window} win Window that was resized
2553 /* Static Properties */
2556 * Map of symbolic size names and CSS properties.
2560 * @property {Object}
2562 OO
.ui
.WindowManager
.static.sizes
= {
2573 // These can be non-numeric because they are never used in calculations
2580 * Symbolic name of default size.
2582 * Default size is used if the window's requested size is not recognized.
2586 * @property {string}
2588 OO
.ui
.WindowManager
.static.defaultSize
= 'medium';
2593 * Handle window resize events.
2595 * @param {jQuery.Event} e Window resize event
2597 OO
.ui
.WindowManager
.prototype.onWindowResize = function () {
2598 clearTimeout( this.onWindowResizeTimeout
);
2599 this.onWindowResizeTimeout
= setTimeout( this.afterWindowResizeHandler
, 200 );
2603 * Handle window resize events.
2605 * @param {jQuery.Event} e Window resize event
2607 OO
.ui
.WindowManager
.prototype.afterWindowResize = function () {
2608 if ( this.currentWindow
) {
2609 this.updateWindowSize( this.currentWindow
);
2614 * Handle window mouse wheel events.
2616 * @param {jQuery.Event} e Mouse wheel event
2618 OO
.ui
.WindowManager
.prototype.onWindowMouseWheel = function () {
2623 * Handle document key down events.
2625 * @param {jQuery.Event} e Key down event
2627 OO
.ui
.WindowManager
.prototype.onDocumentKeyDown = function ( e
) {
2628 switch ( e
.which
) {
2629 case OO
.ui
.Keys
.PAGEUP
:
2630 case OO
.ui
.Keys
.PAGEDOWN
:
2631 case OO
.ui
.Keys
.END
:
2632 case OO
.ui
.Keys
.HOME
:
2633 case OO
.ui
.Keys
.LEFT
:
2635 case OO
.ui
.Keys
.RIGHT
:
2636 case OO
.ui
.Keys
.DOWN
:
2637 // Prevent any key events that might cause scrolling
2643 * Check if window is opening.
2645 * @return {boolean} Window is opening
2647 OO
.ui
.WindowManager
.prototype.isOpening = function ( win
) {
2648 return win
=== this.currentWindow
&& !!this.opening
&& this.opening
.state() === 'pending';
2652 * Check if window is closing.
2654 * @return {boolean} Window is closing
2656 OO
.ui
.WindowManager
.prototype.isClosing = function ( win
) {
2657 return win
=== this.currentWindow
&& !!this.closing
&& this.closing
.state() === 'pending';
2661 * Check if window is opened.
2663 * @return {boolean} Window is opened
2665 OO
.ui
.WindowManager
.prototype.isOpened = function ( win
) {
2666 return win
=== this.currentWindow
&& !!this.opened
&& this.opened
.state() === 'pending';
2670 * Check if window contents should be isolated.
2672 * Window content isolation is done using inline frames.
2674 * @return {boolean} Window contents should be isolated
2676 OO
.ui
.WindowManager
.prototype.shouldIsolate = function () {
2677 return this.isolate
;
2681 * Check if a window is being managed.
2683 * @param {OO.ui.Window} win Window to check
2684 * @return {boolean} Window is being managed
2686 OO
.ui
.WindowManager
.prototype.hasWindow = function ( win
) {
2689 for ( name
in this.windows
) {
2690 if ( this.windows
[name
] === win
) {
2699 * Get the number of milliseconds to wait between beginning opening and executing setup process.
2701 * @param {OO.ui.Window} win Window being opened
2702 * @param {Object} [data] Window opening data
2703 * @return {number} Milliseconds to wait
2705 OO
.ui
.WindowManager
.prototype.getSetupDelay = function () {
2710 * Get the number of milliseconds to wait between finishing setup and executing ready process.
2712 * @param {OO.ui.Window} win Window being opened
2713 * @param {Object} [data] Window opening data
2714 * @return {number} Milliseconds to wait
2716 OO
.ui
.WindowManager
.prototype.getReadyDelay = function () {
2721 * Get the number of milliseconds to wait between beginning closing and executing hold process.
2723 * @param {OO.ui.Window} win Window being closed
2724 * @param {Object} [data] Window closing data
2725 * @return {number} Milliseconds to wait
2727 OO
.ui
.WindowManager
.prototype.getHoldDelay = function () {
2732 * Get the number of milliseconds to wait between finishing hold and executing teardown process.
2734 * @param {OO.ui.Window} win Window being closed
2735 * @param {Object} [data] Window closing data
2736 * @return {number} Milliseconds to wait
2738 OO
.ui
.WindowManager
.prototype.getTeardownDelay = function () {
2739 return this.modal
? 250 : 0;
2743 * Get managed window by symbolic name.
2745 * If window is not yet instantiated, it will be instantiated and added automatically.
2747 * @param {string} name Symbolic window name
2748 * @return {jQuery.Promise} Promise resolved with matching window, or rejected with an OO.ui.Error
2749 * @throws {Error} If the symbolic name is unrecognized by the factory
2750 * @throws {Error} If the symbolic name unrecognized as a managed window
2752 OO
.ui
.WindowManager
.prototype.getWindow = function ( name
) {
2753 var deferred
= $.Deferred(),
2754 win
= this.windows
[name
];
2756 if ( !( win
instanceof OO
.ui
.Window
) ) {
2757 if ( this.factory
) {
2758 if ( !this.factory
.lookup( name
) ) {
2759 deferred
.reject( new OO
.ui
.Error(
2760 'Cannot auto-instantiate window: symbolic name is unrecognized by the factory'
2763 win
= this.factory
.create( name
, this, { $: this.$ } );
2764 this.addWindows( [ win
] );
2765 deferred
.resolve( win
);
2768 deferred
.reject( new OO
.ui
.Error(
2769 'Cannot get unmanaged window: symbolic name unrecognized as a managed window'
2773 deferred
.resolve( win
);
2776 return deferred
.promise();
2780 * Get current window.
2782 * @return {OO.ui.Window|null} Currently opening/opened/closing window
2784 OO
.ui
.WindowManager
.prototype.getCurrentWindow = function () {
2785 return this.currentWindow
;
2791 * @param {OO.ui.Window|string} win Window object or symbolic name of window to open
2792 * @param {Object} [data] Window opening data
2793 * @return {jQuery.Promise} Promise resolved when window is done opening; see {@link #event-opening}
2794 * for more details about the `opening` promise
2797 OO
.ui
.WindowManager
.prototype.openWindow = function ( win
, data
) {
2800 opening
= $.Deferred();
2802 // Argument handling
2803 if ( typeof win
=== 'string' ) {
2804 return this.getWindow( win
).then( function ( win
) {
2805 return manager
.openWindow( win
, data
);
2810 if ( !this.hasWindow( win
) ) {
2811 opening
.reject( new OO
.ui
.Error(
2812 'Cannot open window: window is not attached to manager'
2814 } else if ( this.preparingToOpen
|| this.opening
|| this.opened
) {
2815 opening
.reject( new OO
.ui
.Error(
2816 'Cannot open window: another window is opening or open'
2821 if ( opening
.state() !== 'rejected' ) {
2822 // Begin loading the window if it's not loading or loaded already - may take noticable time
2823 // and we want to do this in paralell with any other preparatory actions
2824 if ( !win
.isLoading() && !win
.isLoaded() ) {
2825 // Finish initializing the window (must be done after manager is attached to DOM)
2826 win
.setManager( this );
2827 preparing
.push( win
.load() );
2830 if ( this.closing
) {
2831 // If a window is currently closing, wait for it to complete
2832 preparing
.push( this.closing
);
2835 this.preparingToOpen
= $.when
.apply( $, preparing
);
2836 // Ensure handlers get called after preparingToOpen is set
2837 this.preparingToOpen
.done( function () {
2838 if ( manager
.modal
) {
2839 manager
.toggleGlobalEvents( true );
2840 manager
.toggleAriaIsolation( true );
2842 manager
.currentWindow
= win
;
2843 manager
.opening
= opening
;
2844 manager
.preparingToOpen
= null;
2845 manager
.emit( 'opening', win
, opening
, data
);
2846 setTimeout( function () {
2847 win
.setup( data
).then( function () {
2848 manager
.updateWindowSize( win
);
2849 manager
.opening
.notify( { state
: 'setup' } );
2850 setTimeout( function () {
2851 win
.ready( data
).then( function () {
2852 manager
.opening
.notify( { state
: 'ready' } );
2853 manager
.opening
= null;
2854 manager
.opened
= $.Deferred();
2855 opening
.resolve( manager
.opened
.promise(), data
);
2857 }, manager
.getReadyDelay() );
2859 }, manager
.getSetupDelay() );
2863 return opening
.promise();
2869 * @param {OO.ui.Window|string} win Window object or symbolic name of window to close
2870 * @param {Object} [data] Window closing data
2871 * @return {jQuery.Promise} Promise resolved when window is done closing; see {@link #event-closing}
2872 * for more details about the `closing` promise
2873 * @throws {Error} If no window by that name is being managed
2876 OO
.ui
.WindowManager
.prototype.closeWindow = function ( win
, data
) {
2879 closing
= $.Deferred(),
2880 opened
= this.opened
;
2882 // Argument handling
2883 if ( typeof win
=== 'string' ) {
2884 win
= this.windows
[win
];
2885 } else if ( !this.hasWindow( win
) ) {
2891 closing
.reject( new OO
.ui
.Error(
2892 'Cannot close window: window is not attached to manager'
2894 } else if ( win
!== this.currentWindow
) {
2895 closing
.reject( new OO
.ui
.Error(
2896 'Cannot close window: window already closed with different data'
2898 } else if ( this.preparingToClose
|| this.closing
) {
2899 closing
.reject( new OO
.ui
.Error(
2900 'Cannot close window: window already closing with different data'
2905 if ( closing
.state() !== 'rejected' ) {
2906 if ( this.opening
) {
2907 // If the window is currently opening, close it when it's done
2908 preparing
.push( this.opening
);
2911 this.preparingToClose
= $.when
.apply( $, preparing
);
2912 // Ensure handlers get called after preparingToClose is set
2913 this.preparingToClose
.done( function () {
2914 manager
.closing
= closing
;
2915 manager
.preparingToClose
= null;
2916 manager
.emit( 'closing', win
, closing
, data
);
2917 manager
.opened
= null;
2918 opened
.resolve( closing
.promise(), data
);
2919 setTimeout( function () {
2920 win
.hold( data
).then( function () {
2921 closing
.notify( { state
: 'hold' } );
2922 setTimeout( function () {
2923 win
.teardown( data
).then( function () {
2924 closing
.notify( { state
: 'teardown' } );
2925 if ( manager
.modal
) {
2926 manager
.toggleGlobalEvents( false );
2927 manager
.toggleAriaIsolation( false );
2929 manager
.closing
= null;
2930 manager
.currentWindow
= null;
2931 closing
.resolve( data
);
2933 }, manager
.getTeardownDelay() );
2935 }, manager
.getHoldDelay() );
2939 return closing
.promise();
2945 * @param {Object.<string,OO.ui.Window>|OO.ui.Window[]} windows Windows to add
2946 * @throws {Error} If one of the windows being added without an explicit symbolic name does not have
2947 * a statically configured symbolic name
2949 OO
.ui
.WindowManager
.prototype.addWindows = function ( windows
) {
2950 var i
, len
, win
, name
, list
;
2952 if ( $.isArray( windows
) ) {
2953 // Convert to map of windows by looking up symbolic names from static configuration
2955 for ( i
= 0, len
= windows
.length
; i
< len
; i
++ ) {
2956 name
= windows
[i
].constructor.static.name
;
2957 if ( typeof name
!== 'string' ) {
2958 throw new Error( 'Cannot add window' );
2960 list
[name
] = windows
[i
];
2962 } else if ( $.isPlainObject( windows
) ) {
2967 for ( name
in list
) {
2969 this.windows
[name
] = win
;
2970 this.$element
.append( win
.$element
);
2977 * Windows will be closed before they are removed.
2979 * @param {string} name Symbolic name of window to remove
2980 * @return {jQuery.Promise} Promise resolved when window is closed and removed
2981 * @throws {Error} If windows being removed are not being managed
2983 OO
.ui
.WindowManager
.prototype.removeWindows = function ( names
) {
2984 var i
, len
, win
, name
,
2987 cleanup = function ( name
, win
) {
2988 delete manager
.windows
[name
];
2989 win
.$element
.detach();
2992 for ( i
= 0, len
= names
.length
; i
< len
; i
++ ) {
2994 win
= this.windows
[name
];
2996 throw new Error( 'Cannot remove window' );
2998 promises
.push( this.closeWindow( name
).then( OO
.ui
.bind( cleanup
, null, name
, win
) ) );
3001 return $.when
.apply( $, promises
);
3005 * Remove all windows.
3007 * Windows will be closed before they are removed.
3009 * @return {jQuery.Promise} Promise resolved when all windows are closed and removed
3011 OO
.ui
.WindowManager
.prototype.clearWindows = function () {
3012 return this.removeWindows( Object
.keys( this.windows
) );
3018 * Fullscreen mode will be used if the dialog is too wide to fit in the screen.
3022 OO
.ui
.WindowManager
.prototype.updateWindowSize = function ( win
) {
3023 // Bypass for non-current, and thus invisible, windows
3024 if ( win
!== this.currentWindow
) {
3028 var viewport
= OO
.ui
.Element
.getDimensions( win
.getElementWindow() ),
3029 sizes
= this.constructor.static.sizes
,
3030 size
= win
.getSize();
3032 if ( !sizes
[size
] ) {
3033 size
= this.constructor.static.defaultSize
;
3035 if ( size
!== 'full' && viewport
.rect
.right
- viewport
.rect
.left
< sizes
[size
].width
) {
3039 this.$element
.toggleClass( 'oo-ui-windowManager-fullscreen', size
=== 'full' );
3040 this.$element
.toggleClass( 'oo-ui-windowManager-floating', size
!== 'full' );
3041 win
.setDimensions( sizes
[size
] );
3043 this.emit( 'resize', win
);
3049 * Bind or unbind global events for scrolling.
3051 * @param {boolean} [on] Bind global events
3054 OO
.ui
.WindowManager
.prototype.toggleGlobalEvents = function ( on
) {
3055 on
= on
=== undefined ? !!this.globalEvents
: !!on
;
3058 if ( !this.globalEvents
) {
3059 this.$( this.getElementDocument() ).on( {
3060 // Prevent scrolling by keys in top-level window
3061 keydown
: this.onDocumentKeyDownHandler
3063 this.$( this.getElementWindow() ).on( {
3064 // Prevent scrolling by wheel in top-level window
3065 mousewheel
: this.onWindowMouseWheelHandler
,
3066 // Start listening for top-level window dimension changes
3067 'orientationchange resize': this.onWindowResizeHandler
3069 this.globalEvents
= true;
3071 } else if ( this.globalEvents
) {
3072 // Unbind global events
3073 this.$( this.getElementDocument() ).off( {
3074 // Allow scrolling by keys in top-level window
3075 keydown
: this.onDocumentKeyDownHandler
3077 this.$( this.getElementWindow() ).off( {
3078 // Allow scrolling by wheel in top-level window
3079 mousewheel
: this.onWindowMouseWheelHandler
,
3080 // Stop listening for top-level window dimension changes
3081 'orientationchange resize': this.onWindowResizeHandler
3083 this.globalEvents
= false;
3090 * Toggle screen reader visibility of content other than the window manager.
3092 * @param {boolean} [isolate] Make only the window manager visible to screen readers
3095 OO
.ui
.WindowManager
.prototype.toggleAriaIsolation = function ( isolate
) {
3096 isolate
= isolate
=== undefined ? !this.$ariaHidden
: !!isolate
;
3099 if ( !this.$ariaHidden
) {
3100 // Hide everything other than the window manager from screen readers
3101 this.$ariaHidden
= $( 'body' )
3103 .not( this.$element
.parentsUntil( 'body' ).last() )
3104 .attr( 'aria-hidden', '' );
3106 } else if ( this.$ariaHidden
) {
3107 // Restore screen reader visiblity
3108 this.$ariaHidden
.removeAttr( 'aria-hidden' );
3109 this.$ariaHidden
= null;
3116 * Destroy window manager.
3118 * Windows will not be closed, only removed from the DOM.
3120 OO
.ui
.WindowManager
.prototype.destroy = function () {
3121 this.toggleGlobalEvents( false );
3122 this.toggleAriaIsolation( false );
3123 this.$element
.remove();
3131 * @param {string|jQuery} message Description of error
3132 * @param {Object} [config] Configuration options
3133 * @cfg {boolean} [recoverable=true] Error is recoverable
3135 OO
.ui
.Error
= function OoUiElement( message
, config
) {
3136 // Configuration initialization
3137 config
= config
|| {};
3140 this.message
= message
instanceof jQuery
? message
: String( message
);
3141 this.recoverable
= config
.recoverable
=== undefined || !!config
.recoverable
;
3146 OO
.initClass( OO
.ui
.Error
);
3151 * Check if error can be recovered from.
3153 * @return {boolean} Error is recoverable
3155 OO
.ui
.Error
.prototype.isRecoverable = function () {
3156 return this.recoverable
;
3160 * Get error message as DOM nodes.
3162 * @return {jQuery} Error message in DOM nodes
3164 OO
.ui
.Error
.prototype.getMessage = function () {
3165 return this.message
instanceof jQuery
?
3166 this.message
.clone() :
3167 $( '<div>' ).text( this.message
).contents();
3171 * Get error message as text.
3173 * @return {string} Error message
3175 OO
.ui
.Error
.prototype.getMessageText = function () {
3176 return this.message
instanceof jQuery
? this.message
.text() : this.message
;
3180 * A list of functions, called in sequence.
3182 * If a function added to a process returns boolean false the process will stop; if it returns an
3183 * object with a `promise` method the process will use the promise to either continue to the next
3184 * step when the promise is resolved or stop when the promise is rejected.
3189 * @param {number|jQuery.Promise|Function} step Time to wait, promise to wait for or function to
3190 * call, see #createStep for more information
3191 * @param {Object} [context=null] Context to call the step function in, ignored if step is a number
3193 * @return {Object} Step object, with `callback` and `context` properties
3195 OO
.ui
.Process = function ( step
, context
) {
3200 if ( step
!== undefined ) {
3201 this.next( step
, context
);
3207 OO
.initClass( OO
.ui
.Process
);
3212 * Start the process.
3214 * @return {jQuery.Promise} Promise that is resolved when all steps have completed or rejected when
3215 * any of the steps return boolean false or a promise which gets rejected; upon stopping the
3216 * process, the remaining steps will not be taken
3218 OO
.ui
.Process
.prototype.execute = function () {
3219 var i
, len
, promise
;
3222 * Continue execution.
3225 * @param {Array} step A function and the context it should be called in
3226 * @return {Function} Function that continues the process
3228 function proceed( step
) {
3229 return function () {
3230 // Execute step in the correct context
3232 result
= step
.callback
.call( step
.context
);
3234 if ( result
=== false ) {
3235 // Use rejected promise for boolean false results
3236 return $.Deferred().reject( [] ).promise();
3238 if ( typeof result
=== 'number' ) {
3240 throw new Error( 'Cannot go back in time: flux capacitor is out of service' );
3242 // Use a delayed promise for numbers, expecting them to be in milliseconds
3243 deferred
= $.Deferred();
3244 setTimeout( deferred
.resolve
, result
);
3245 return deferred
.promise();
3247 if ( result
instanceof OO
.ui
.Error
) {
3248 // Use rejected promise for error
3249 return $.Deferred().reject( [ result
] ).promise();
3251 if ( $.isArray( result
) && result
.length
&& result
[0] instanceof OO
.ui
.Error
) {
3252 // Use rejected promise for list of errors
3253 return $.Deferred().reject( result
).promise();
3255 // Duck-type the object to see if it can produce a promise
3256 if ( result
&& $.isFunction( result
.promise
) ) {
3257 // Use a promise generated from the result
3258 return result
.promise();
3260 // Use resolved promise for other results
3261 return $.Deferred().resolve().promise();
3265 if ( this.steps
.length
) {
3266 // Generate a chain reaction of promises
3267 promise
= proceed( this.steps
[0] )();
3268 for ( i
= 1, len
= this.steps
.length
; i
< len
; i
++ ) {
3269 promise
= promise
.then( proceed( this.steps
[i
] ) );
3272 promise
= $.Deferred().resolve().promise();
3279 * Create a process step.
3282 * @param {number|jQuery.Promise|Function} step
3284 * - Number of milliseconds to wait; or
3285 * - Promise to wait to be resolved; or
3286 * - Function to execute
3287 * - If it returns boolean false the process will stop
3288 * - If it returns an object with a `promise` method the process will use the promise to either
3289 * continue to the next step when the promise is resolved or stop when the promise is rejected
3290 * - If it returns a number, the process will wait for that number of milliseconds before
3292 * @param {Object} [context=null] Context to call the step function in, ignored if step is a number
3294 * @return {Object} Step object, with `callback` and `context` properties
3296 OO
.ui
.Process
.prototype.createStep = function ( step
, context
) {
3297 if ( typeof step
=== 'number' || $.isFunction( step
.promise
) ) {
3299 callback: function () {
3305 if ( $.isFunction( step
) ) {
3311 throw new Error( 'Cannot create process step: number, promise or function expected' );
3315 * Add step to the beginning of the process.
3317 * @inheritdoc #createStep
3318 * @return {OO.ui.Process} this
3321 OO
.ui
.Process
.prototype.first = function ( step
, context
) {
3322 this.steps
.unshift( this.createStep( step
, context
) );
3327 * Add step to the end of the process.
3329 * @inheritdoc #createStep
3330 * @return {OO.ui.Process} this
3333 OO
.ui
.Process
.prototype.next = function ( step
, context
) {
3334 this.steps
.push( this.createStep( step
, context
) );
3339 * Factory for tools.
3342 * @extends OO.Factory
3345 OO
.ui
.ToolFactory
= function OoUiToolFactory() {
3346 // Parent constructor
3347 OO
.ui
.ToolFactory
.super.call( this );
3352 OO
.inheritClass( OO
.ui
.ToolFactory
, OO
.Factory
);
3357 OO
.ui
.ToolFactory
.prototype.getTools = function ( include
, exclude
, promote
, demote
) {
3358 var i
, len
, included
, promoted
, demoted
,
3362 // Collect included and not excluded tools
3363 included
= OO
.simpleArrayDifference( this.extract( include
), this.extract( exclude
) );
3366 promoted
= this.extract( promote
, used
);
3367 demoted
= this.extract( demote
, used
);
3370 for ( i
= 0, len
= included
.length
; i
< len
; i
++ ) {
3371 if ( !used
[included
[i
]] ) {
3372 auto
.push( included
[i
] );
3376 return promoted
.concat( auto
).concat( demoted
);
3380 * Get a flat list of names from a list of names or groups.
3382 * Tools can be specified in the following ways:
3384 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
3385 * - All tools in a group: `{ group: 'group-name' }`
3386 * - All tools: `'*'`
3389 * @param {Array|string} collection List of tools
3390 * @param {Object} [used] Object with names that should be skipped as properties; extracted
3391 * names will be added as properties
3392 * @return {string[]} List of extracted names
3394 OO
.ui
.ToolFactory
.prototype.extract = function ( collection
, used
) {
3395 var i
, len
, item
, name
, tool
,
3398 if ( collection
=== '*' ) {
3399 for ( name
in this.registry
) {
3400 tool
= this.registry
[name
];
3402 // Only add tools by group name when auto-add is enabled
3403 tool
.static.autoAddToCatchall
&&
3404 // Exclude already used tools
3405 ( !used
|| !used
[name
] )
3413 } else if ( $.isArray( collection
) ) {
3414 for ( i
= 0, len
= collection
.length
; i
< len
; i
++ ) {
3415 item
= collection
[i
];
3416 // Allow plain strings as shorthand for named tools
3417 if ( typeof item
=== 'string' ) {
3418 item
= { name
: item
};
3420 if ( OO
.isPlainObject( item
) ) {
3422 for ( name
in this.registry
) {
3423 tool
= this.registry
[name
];
3425 // Include tools with matching group
3426 tool
.static.group
=== item
.group
&&
3427 // Only add tools by group name when auto-add is enabled
3428 tool
.static.autoAddToGroup
&&
3429 // Exclude already used tools
3430 ( !used
|| !used
[name
] )
3438 // Include tools with matching name and exclude already used tools
3439 } else if ( item
.name
&& ( !used
|| !used
[item
.name
] ) ) {
3440 names
.push( item
.name
);
3442 used
[item
.name
] = true;
3452 * Factory for tool groups.
3455 * @extends OO.Factory
3458 OO
.ui
.ToolGroupFactory
= function OoUiToolGroupFactory() {
3459 // Parent constructor
3460 OO
.Factory
.call( this );
3463 defaultClasses
= this.constructor.static.getDefaultClasses();
3465 // Register default toolgroups
3466 for ( i
= 0, l
= defaultClasses
.length
; i
< l
; i
++ ) {
3467 this.register( defaultClasses
[i
] );
3473 OO
.inheritClass( OO
.ui
.ToolGroupFactory
, OO
.Factory
);
3475 /* Static Methods */
3478 * Get a default set of classes to be registered on construction
3480 * @return {Function[]} Default classes
3482 OO
.ui
.ToolGroupFactory
.static.getDefaultClasses = function () {
3485 OO
.ui
.ListToolGroup
,
3497 * @param {Object} [config] Configuration options
3499 OO
.ui
.Theme
= function OoUiTheme( config
) {
3500 // Initialize config
3501 config
= config
|| {};
3506 OO
.initClass( OO
.ui
.Theme
);
3511 * Get a list of classes to be applied to a widget.
3513 * @localdoc The 'on' and 'off' lists combined MUST contain keys for all classes the theme adds or
3514 * removes, otherwise state transitions will not work properly.
3516 * @param {OO.ui.Element} element Element for which to get classes
3517 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
3519 OO
.ui
.Theme
.prototype.getElementClasses = function ( /* element */ ) {
3520 return { on
: [], off
: [] };
3524 * Update CSS classes provided by the theme.
3526 * For elements with theme logic hooks, this should be called anytime there's a state change.
3528 * @param {OO.ui.Element} Element for which to update classes
3529 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
3531 OO
.ui
.Theme
.prototype.updateElementClasses = function ( element
) {
3532 var classes
= this.getElementClasses( element
);
3535 .removeClass( classes
.off
.join( ' ' ) )
3536 .addClass( classes
.on
.join( ' ' ) );
3540 * Element with a button.
3542 * Buttons are used for controls which can be clicked. They can be configured to use tab indexing
3543 * and access keys for accessibility purposes.
3549 * @param {Object} [config] Configuration options
3550 * @cfg {jQuery} [$button] Button node, assigned to #$button, omit to use a generated `<a>`
3551 * @cfg {boolean} [framed=true] Render button with a frame
3552 * @cfg {number} [tabIndex=0] Button's tab index, use null to have no tabIndex
3553 * @cfg {string} [accessKey] Button's access key
3555 OO
.ui
.ButtonElement
= function OoUiButtonElement( config
) {
3556 // Configuration initialization
3557 config
= config
|| {};
3560 this.$button
= null;
3562 this.tabIndex
= null;
3563 this.accessKey
= null;
3564 this.active
= false;
3565 this.onMouseUpHandler
= OO
.ui
.bind( this.onMouseUp
, this );
3566 this.onMouseDownHandler
= OO
.ui
.bind( this.onMouseDown
, this );
3569 this.$element
.addClass( 'oo-ui-buttonElement' );
3570 this.toggleFramed( config
.framed
=== undefined || config
.framed
);
3571 this.setTabIndex( config
.tabIndex
|| 0 );
3572 this.setAccessKey( config
.accessKey
);
3573 this.setButtonElement( config
.$button
|| this.$( '<a>' ) );
3578 OO
.initClass( OO
.ui
.ButtonElement
);
3580 /* Static Properties */
3583 * Cancel mouse down events.
3587 * @property {boolean}
3589 OO
.ui
.ButtonElement
.static.cancelButtonMouseDownEvents
= true;
3594 * Set the button element.
3596 * If an element is already set, it will be cleaned up before setting up the new element.
3598 * @param {jQuery} $button Element to use as button
3600 OO
.ui
.ButtonElement
.prototype.setButtonElement = function ( $button
) {
3601 if ( this.$button
) {
3603 .removeClass( 'oo-ui-buttonElement-button' )
3604 .removeAttr( 'role accesskey tabindex' )
3605 .off( this.onMouseDownHandler
);
3608 this.$button
= $button
3609 .addClass( 'oo-ui-buttonElement-button' )
3610 .attr( { role
: 'button', accesskey
: this.accessKey
, tabindex
: this.tabIndex
} )
3611 .on( 'mousedown', this.onMouseDownHandler
);
3615 * Handles mouse down events.
3617 * @param {jQuery.Event} e Mouse down event
3619 OO
.ui
.ButtonElement
.prototype.onMouseDown = function ( e
) {
3620 if ( this.isDisabled() || e
.which
!== 1 ) {
3623 // Remove the tab-index while the button is down to prevent the button from stealing focus
3624 this.$button
.removeAttr( 'tabindex' );
3625 this.$element
.addClass( 'oo-ui-buttonElement-pressed' );
3626 // Run the mouseup handler no matter where the mouse is when the button is let go, so we can
3627 // reliably reapply the tabindex and remove the pressed class
3628 this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler
, true );
3629 // Prevent change of focus unless specifically configured otherwise
3630 if ( this.constructor.static.cancelButtonMouseDownEvents
) {
3636 * Handles mouse up events.
3638 * @param {jQuery.Event} e Mouse up event
3640 OO
.ui
.ButtonElement
.prototype.onMouseUp = function ( e
) {
3641 if ( this.isDisabled() || e
.which
!== 1 ) {
3644 // Restore the tab-index after the button is up to restore the button's accesssibility
3645 this.$button
.attr( 'tabindex', this.tabIndex
);
3646 this.$element
.removeClass( 'oo-ui-buttonElement-pressed' );
3647 // Stop listening for mouseup, since we only needed this once
3648 this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler
, true );
3652 * Check if button has a frame.
3654 * @return {boolean} Button is framed
3656 OO
.ui
.ButtonElement
.prototype.isFramed = function () {
3663 * @param {boolean} [framed] Make button framed, omit to toggle
3666 OO
.ui
.ButtonElement
.prototype.toggleFramed = function ( framed
) {
3667 framed
= framed
=== undefined ? !this.framed
: !!framed
;
3668 if ( framed
!== this.framed
) {
3669 this.framed
= framed
;
3671 .toggleClass( 'oo-ui-buttonElement-frameless', !framed
)
3672 .toggleClass( 'oo-ui-buttonElement-framed', framed
);
3673 this.updateThemeClasses();
3682 * @param {number|null} tabIndex Button's tab index, use null to remove
3685 OO
.ui
.ButtonElement
.prototype.setTabIndex = function ( tabIndex
) {
3686 tabIndex
= typeof tabIndex
=== 'number' && tabIndex
>= 0 ? tabIndex
: null;
3688 if ( this.tabIndex
!== tabIndex
) {
3689 if ( this.$button
) {
3690 if ( tabIndex
!== null ) {
3691 this.$button
.attr( 'tabindex', tabIndex
);
3693 this.$button
.removeAttr( 'tabindex' );
3696 this.tabIndex
= tabIndex
;
3705 * @param {string} accessKey Button's access key, use empty string to remove
3708 OO
.ui
.ButtonElement
.prototype.setAccessKey = function ( accessKey
) {
3709 accessKey
= typeof accessKey
=== 'string' && accessKey
.length
? accessKey
: null;
3711 if ( this.accessKey
!== accessKey
) {
3712 if ( this.$button
) {
3713 if ( accessKey
!== null ) {
3714 this.$button
.attr( 'accesskey', accessKey
);
3716 this.$button
.removeAttr( 'accesskey' );
3719 this.accessKey
= accessKey
;
3728 * @param {boolean} [value] Make button active
3731 OO
.ui
.ButtonElement
.prototype.setActive = function ( value
) {
3732 this.$element
.toggleClass( 'oo-ui-buttonElement-active', !!value
);
3737 * Element containing a sequence of child elements.
3743 * @param {Object} [config] Configuration options
3744 * @cfg {jQuery} [$group] Container node, assigned to #$group, omit to use a generated `<div>`
3746 OO
.ui
.GroupElement
= function OoUiGroupElement( config
) {
3748 config
= config
|| {};
3753 this.aggregateItemEvents
= {};
3756 this.setGroupElement( config
.$group
|| this.$( '<div>' ) );
3762 * Set the group element.
3764 * If an element is already set, items will be moved to the new element.
3766 * @param {jQuery} $group Element to use as group
3768 OO
.ui
.GroupElement
.prototype.setGroupElement = function ( $group
) {
3771 this.$group
= $group
;
3772 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3773 this.$group
.append( this.items
[i
].$element
);
3778 * Check if there are no items.
3780 * @return {boolean} Group is empty
3782 OO
.ui
.GroupElement
.prototype.isEmpty = function () {
3783 return !this.items
.length
;
3789 * @return {OO.ui.Element[]} Items
3791 OO
.ui
.GroupElement
.prototype.getItems = function () {
3792 return this.items
.slice( 0 );
3796 * Add an aggregate item event.
3798 * Aggregated events are listened to on each item and then emitted by the group under a new name,
3799 * and with an additional leading parameter containing the item that emitted the original event.
3800 * Other arguments that were emitted from the original event are passed through.
3802 * @param {Object.<string,string|null>} events Aggregate events emitted by group, keyed by item
3803 * event, use null value to remove aggregation
3804 * @throws {Error} If aggregation already exists
3806 OO
.ui
.GroupElement
.prototype.aggregate = function ( events
) {
3807 var i
, len
, item
, add
, remove
, itemEvent
, groupEvent
;
3809 for ( itemEvent
in events
) {
3810 groupEvent
= events
[itemEvent
];
3812 // Remove existing aggregated event
3813 if ( itemEvent
in this.aggregateItemEvents
) {
3814 // Don't allow duplicate aggregations
3816 throw new Error( 'Duplicate item event aggregation for ' + itemEvent
);
3818 // Remove event aggregation from existing items
3819 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3820 item
= this.items
[i
];
3821 if ( item
.connect
&& item
.disconnect
) {
3823 remove
[itemEvent
] = [ 'emit', groupEvent
, item
];
3824 item
.disconnect( this, remove
);
3827 // Prevent future items from aggregating event
3828 delete this.aggregateItemEvents
[itemEvent
];
3831 // Add new aggregate event
3833 // Make future items aggregate event
3834 this.aggregateItemEvents
[itemEvent
] = groupEvent
;
3835 // Add event aggregation to existing items
3836 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3837 item
= this.items
[i
];
3838 if ( item
.connect
&& item
.disconnect
) {
3840 add
[itemEvent
] = [ 'emit', groupEvent
, item
];
3841 item
.connect( this, add
);
3851 * Adding an existing item (by value) will move it.
3853 * @param {OO.ui.Element[]} items Item
3854 * @param {number} [index] Index to insert items at
3857 OO
.ui
.GroupElement
.prototype.addItems = function ( items
, index
) {
3858 var i
, len
, item
, event
, events
, currentIndex
,
3861 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
3864 // Check if item exists then remove it first, effectively "moving" it
3865 currentIndex
= $.inArray( item
, this.items
);
3866 if ( currentIndex
>= 0 ) {
3867 this.removeItems( [ item
] );
3868 // Adjust index to compensate for removal
3869 if ( currentIndex
< index
) {
3874 if ( item
.connect
&& item
.disconnect
&& !$.isEmptyObject( this.aggregateItemEvents
) ) {
3876 for ( event
in this.aggregateItemEvents
) {
3877 events
[event
] = [ 'emit', this.aggregateItemEvents
[event
], item
];
3879 item
.connect( this, events
);
3881 item
.setElementGroup( this );
3882 itemElements
.push( item
.$element
.get( 0 ) );
3885 if ( index
=== undefined || index
< 0 || index
>= this.items
.length
) {
3886 this.$group
.append( itemElements
);
3887 this.items
.push
.apply( this.items
, items
);
3888 } else if ( index
=== 0 ) {
3889 this.$group
.prepend( itemElements
);
3890 this.items
.unshift
.apply( this.items
, items
);
3892 this.items
[index
].$element
.before( itemElements
);
3893 this.items
.splice
.apply( this.items
, [ index
, 0 ].concat( items
) );
3902 * Items will be detached, not removed, so they can be used later.
3904 * @param {OO.ui.Element[]} items Items to remove
3907 OO
.ui
.GroupElement
.prototype.removeItems = function ( items
) {
3908 var i
, len
, item
, index
, remove
, itemEvent
;
3910 // Remove specific items
3911 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
3913 index
= $.inArray( item
, this.items
);
3914 if ( index
!== -1 ) {
3916 item
.connect
&& item
.disconnect
&&
3917 !$.isEmptyObject( this.aggregateItemEvents
)
3920 if ( itemEvent
in this.aggregateItemEvents
) {
3921 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
3923 item
.disconnect( this, remove
);
3925 item
.setElementGroup( null );
3926 this.items
.splice( index
, 1 );
3927 item
.$element
.detach();
3937 * Items will be detached, not removed, so they can be used later.
3941 OO
.ui
.GroupElement
.prototype.clearItems = function () {
3942 var i
, len
, item
, remove
, itemEvent
;
3945 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3946 item
= this.items
[i
];
3948 item
.connect
&& item
.disconnect
&&
3949 !$.isEmptyObject( this.aggregateItemEvents
)
3952 if ( itemEvent
in this.aggregateItemEvents
) {
3953 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
3955 item
.disconnect( this, remove
);
3957 item
.setElementGroup( null );
3958 item
.$element
.detach();
3966 * Element containing an icon.
3968 * Icons are graphics, about the size of normal text. They can be used to aid the user in locating
3969 * a control or convey information in a more space efficient way. Icons should rarely be used
3970 * without labels; such as in a toolbar where space is at a premium or within a context where the
3971 * meaning is very clear to the user.
3977 * @param {Object} [config] Configuration options
3978 * @cfg {jQuery} [$icon] Icon node, assigned to #$icon, omit to use a generated `<span>`
3979 * @cfg {Object|string} [icon=''] Symbolic icon name, or map of icon names keyed by language ID;
3980 * use the 'default' key to specify the icon to be used when there is no icon in the user's
3982 * @cfg {string} [iconTitle] Icon title text or a function that returns text
3984 OO
.ui
.IconElement
= function OoUiIconElement( config
) {
3985 // Config intialization
3986 config
= config
|| {};
3991 this.iconTitle
= null;
3994 this.setIcon( config
.icon
|| this.constructor.static.icon
);
3995 this.setIconTitle( config
.iconTitle
|| this.constructor.static.iconTitle
);
3996 this.setIconElement( config
.$icon
|| this.$( '<span>' ) );
4001 OO
.initClass( OO
.ui
.IconElement
);
4003 /* Static Properties */
4008 * Value should be the unique portion of an icon CSS class name, such as 'up' for 'oo-ui-icon-up'.
4010 * For i18n purposes, this property can be an object containing a `default` icon name property and
4011 * additional icon names keyed by language code.
4013 * Example of i18n icon definition:
4014 * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
4018 * @property {Object|string} Symbolic icon name, or map of icon names keyed by language ID;
4019 * use the 'default' key to specify the icon to be used when there is no icon in the user's
4022 OO
.ui
.IconElement
.static.icon
= null;
4029 * @property {string|Function|null} Icon title text, a function that returns text or null for no
4032 OO
.ui
.IconElement
.static.iconTitle
= null;
4037 * Set the icon element.
4039 * If an element is already set, it will be cleaned up before setting up the new element.
4041 * @param {jQuery} $icon Element to use as icon
4043 OO
.ui
.IconElement
.prototype.setIconElement = function ( $icon
) {
4046 .removeClass( 'oo-ui-iconElement-icon oo-ui-icon-' + this.icon
)
4047 .removeAttr( 'title' );
4051 .addClass( 'oo-ui-iconElement-icon' )
4052 .toggleClass( 'oo-ui-icon-' + this.icon
, !!this.icon
);
4053 if ( this.iconTitle
!== null ) {
4054 this.$icon
.attr( 'title', this.iconTitle
);
4061 * @param {Object|string|null} icon Symbolic icon name, or map of icon names keyed by language ID;
4062 * use the 'default' key to specify the icon to be used when there is no icon in the user's
4063 * language, use null to remove icon
4066 OO
.ui
.IconElement
.prototype.setIcon = function ( icon
) {
4067 icon
= OO
.isPlainObject( icon
) ? OO
.ui
.getLocalValue( icon
, null, 'default' ) : icon
;
4068 icon
= typeof icon
=== 'string' && icon
.trim().length
? icon
.trim() : null;
4070 if ( this.icon
!== icon
) {
4072 if ( this.icon
!== null ) {
4073 this.$icon
.removeClass( 'oo-ui-icon-' + this.icon
);
4075 if ( icon
!== null ) {
4076 this.$icon
.addClass( 'oo-ui-icon-' + icon
);
4082 this.$element
.toggleClass( 'oo-ui-iconElement', !!this.icon
);
4083 this.updateThemeClasses();
4091 * @param {string|Function|null} icon Icon title text, a function that returns text or null
4095 OO
.ui
.IconElement
.prototype.setIconTitle = function ( iconTitle
) {
4096 iconTitle
= typeof iconTitle
=== 'function' ||
4097 ( typeof iconTitle
=== 'string' && iconTitle
.length
) ?
4098 OO
.ui
.resolveMsg( iconTitle
) : null;
4100 if ( this.iconTitle
!== iconTitle
) {
4101 this.iconTitle
= iconTitle
;
4103 if ( this.iconTitle
!== null ) {
4104 this.$icon
.attr( 'title', iconTitle
);
4106 this.$icon
.removeAttr( 'title' );
4117 * @return {string} Icon
4119 OO
.ui
.IconElement
.prototype.getIcon = function () {
4124 * Element containing an indicator.
4126 * Indicators are graphics, smaller than normal text. They can be used to describe unique status or
4127 * behavior. Indicators should only be used in exceptional cases; such as a button that opens a menu
4128 * instead of performing an action directly, or an item in a list which has errors that need to be
4135 * @param {Object} [config] Configuration options
4136 * @cfg {jQuery} [$indicator] Indicator node, assigned to #$indicator, omit to use a generated
4138 * @cfg {string} [indicator] Symbolic indicator name
4139 * @cfg {string} [indicatorTitle] Indicator title text or a function that returns text
4141 OO
.ui
.IndicatorElement
= function OoUiIndicatorElement( config
) {
4142 // Config intialization
4143 config
= config
|| {};
4146 this.$indicator
= null;
4147 this.indicator
= null;
4148 this.indicatorTitle
= null;
4151 this.setIndicator( config
.indicator
|| this.constructor.static.indicator
);
4152 this.setIndicatorTitle( config
.indicatorTitle
|| this.constructor.static.indicatorTitle
);
4153 this.setIndicatorElement( config
.$indicator
|| this.$( '<span>' ) );
4158 OO
.initClass( OO
.ui
.IndicatorElement
);
4160 /* Static Properties */
4167 * @property {string|null} Symbolic indicator name or null for no indicator
4169 OO
.ui
.IndicatorElement
.static.indicator
= null;
4176 * @property {string|Function|null} Indicator title text, a function that returns text or null for no
4179 OO
.ui
.IndicatorElement
.static.indicatorTitle
= null;
4184 * Set the indicator element.
4186 * If an element is already set, it will be cleaned up before setting up the new element.
4188 * @param {jQuery} $indicator Element to use as indicator
4190 OO
.ui
.IndicatorElement
.prototype.setIndicatorElement = function ( $indicator
) {
4191 if ( this.$indicator
) {
4193 .removeClass( 'oo-ui-indicatorElement-indicator oo-ui-indicator-' + this.indicator
)
4194 .removeAttr( 'title' );
4197 this.$indicator
= $indicator
4198 .addClass( 'oo-ui-indicatorElement-indicator' )
4199 .toggleClass( 'oo-ui-indicator-' + this.indicator
, !!this.indicator
);
4200 if ( this.indicatorTitle
!== null ) {
4201 this.$indicatorTitle
.attr( 'title', this.indicatorTitle
);
4208 * @param {string|null} indicator Symbolic name of indicator to use or null for no indicator
4211 OO
.ui
.IndicatorElement
.prototype.setIndicator = function ( indicator
) {
4212 indicator
= typeof indicator
=== 'string' && indicator
.length
? indicator
.trim() : null;
4214 if ( this.indicator
!== indicator
) {
4215 if ( this.$indicator
) {
4216 if ( this.indicator
!== null ) {
4217 this.$indicator
.removeClass( 'oo-ui-indicator-' + this.indicator
);
4219 if ( indicator
!== null ) {
4220 this.$indicator
.addClass( 'oo-ui-indicator-' + indicator
);
4223 this.indicator
= indicator
;
4226 this.$element
.toggleClass( 'oo-ui-indicatorElement', !!this.indicator
);
4227 this.updateThemeClasses();
4233 * Set indicator title.
4235 * @param {string|Function|null} indicator Indicator title text, a function that returns text or
4236 * null for no indicator title
4239 OO
.ui
.IndicatorElement
.prototype.setIndicatorTitle = function ( indicatorTitle
) {
4240 indicatorTitle
= typeof indicatorTitle
=== 'function' ||
4241 ( typeof indicatorTitle
=== 'string' && indicatorTitle
.length
) ?
4242 OO
.ui
.resolveMsg( indicatorTitle
) : null;
4244 if ( this.indicatorTitle
!== indicatorTitle
) {
4245 this.indicatorTitle
= indicatorTitle
;
4246 if ( this.$indicator
) {
4247 if ( this.indicatorTitle
!== null ) {
4248 this.$indicator
.attr( 'title', indicatorTitle
);
4250 this.$indicator
.removeAttr( 'title' );
4261 * @return {string} title Symbolic name of indicator
4263 OO
.ui
.IndicatorElement
.prototype.getIndicator = function () {
4264 return this.indicator
;
4268 * Get indicator title.
4270 * @return {string} Indicator title text
4272 OO
.ui
.IndicatorElement
.prototype.getIndicatorTitle = function () {
4273 return this.indicatorTitle
;
4277 * Element containing a label.
4283 * @param {Object} [config] Configuration options
4284 * @cfg {jQuery} [$label] Label node, assigned to #$label, omit to use a generated `<span>`
4285 * @cfg {jQuery|string|Function} [label] Label nodes, text or a function that returns nodes or text
4286 * @cfg {boolean} [autoFitLabel=true] Whether to fit the label or not.
4288 OO
.ui
.LabelElement
= function OoUiLabelElement( config
) {
4289 // Config intialization
4290 config
= config
|| {};
4295 this.autoFitLabel
= config
.autoFitLabel
=== undefined || !!config
.autoFitLabel
;
4298 this.setLabel( config
.label
|| this.constructor.static.label
);
4299 this.setLabelElement( config
.$label
|| this.$( '<span>' ) );
4304 OO
.initClass( OO
.ui
.LabelElement
);
4306 /* Static Properties */
4313 * @property {string|Function|null} Label text; a function that returns nodes or text; or null for
4316 OO
.ui
.LabelElement
.static.label
= null;
4321 * Set the label element.
4323 * If an element is already set, it will be cleaned up before setting up the new element.
4325 * @param {jQuery} $label Element to use as label
4327 OO
.ui
.LabelElement
.prototype.setLabelElement = function ( $label
) {
4328 if ( this.$label
) {
4329 this.$label
.removeClass( 'oo-ui-labelElement-label' ).empty();
4332 this.$label
= $label
.addClass( 'oo-ui-labelElement-label' );
4333 this.setLabelContent( this.label
);
4339 * An empty string will result in the label being hidden. A string containing only whitespace will
4340 * be converted to a single
4342 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
4343 * text; or null for no label
4346 OO
.ui
.LabelElement
.prototype.setLabel = function ( label
) {
4347 label
= typeof label
=== 'function' ? OO
.ui
.resolveMsg( label
) : label
;
4348 label
= ( typeof label
=== 'string' && label
.length
) || label
instanceof jQuery
? label
: null;
4350 if ( this.label
!== label
) {
4351 if ( this.$label
) {
4352 this.setLabelContent( label
);
4357 this.$element
.toggleClass( 'oo-ui-labelElement', !!this.label
);
4365 * @return {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
4366 * text; or null for no label
4368 OO
.ui
.LabelElement
.prototype.getLabel = function () {
4377 OO
.ui
.LabelElement
.prototype.fitLabel = function () {
4378 if ( this.$label
&& this.$label
.autoEllipsis
&& this.autoFitLabel
) {
4379 this.$label
.autoEllipsis( { hasSpan
: false, tooltip
: true } );
4386 * Set the content of the label.
4388 * Do not call this method until after the label element has been set by #setLabelElement.
4391 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
4392 * text; or null for no label
4394 OO
.ui
.LabelElement
.prototype.setLabelContent = function ( label
) {
4395 if ( typeof label
=== 'string' ) {
4396 if ( label
.match( /^\s*$/ ) ) {
4397 // Convert whitespace only string to a single non-breaking space
4398 this.$label
.html( ' ' );
4400 this.$label
.text( label
);
4402 } else if ( label
instanceof jQuery
) {
4403 this.$label
.empty().append( label
);
4405 this.$label
.empty();
4407 this.$label
.css( 'display', !label
? 'none' : '' );
4411 * Element containing an OO.ui.PopupWidget object.
4417 * @param {Object} [config] Configuration options
4418 * @cfg {Object} [popup] Configuration to pass to popup
4419 * @cfg {boolean} [autoClose=true] Popup auto-closes when it loses focus
4421 OO
.ui
.PopupElement
= function OoUiPopupElement( config
) {
4422 // Configuration initialization
4423 config
= config
|| {};
4426 this.popup
= new OO
.ui
.PopupWidget( $.extend(
4427 { autoClose
: true },
4429 { $: this.$, $autoCloseIgnore
: this.$element
}
4438 * @return {OO.ui.PopupWidget} Popup widget
4440 OO
.ui
.PopupElement
.prototype.getPopup = function () {
4445 * Element with named flags that can be added, removed, listed and checked.
4447 * A flag, when set, adds a CSS class on the `$element` by combining `oo-ui-flaggedElement-` with
4448 * the flag name. Flags are primarily useful for styling.
4454 * @param {Object} [config] Configuration options
4455 * @cfg {string[]} [flags=[]] Styling flags, e.g. 'primary', 'destructive' or 'constructive'
4456 * @cfg {jQuery} [$flagged] Flagged node, assigned to #$flagged, omit to use #$element
4458 OO
.ui
.FlaggedElement
= function OoUiFlaggedElement( config
) {
4459 // Config initialization
4460 config
= config
|| {};
4464 this.$flagged
= null;
4467 this.setFlags( config
.flags
);
4468 this.setFlaggedElement( config
.$flagged
|| this.$element
);
4475 * @param {Object.<string,boolean>} changes Object keyed by flag name containing boolean
4476 * added/removed properties
4482 * Set the flagged element.
4484 * If an element is already set, it will be cleaned up before setting up the new element.
4486 * @param {jQuery} $flagged Element to add flags to
4488 OO
.ui
.FlaggedElement
.prototype.setFlaggedElement = function ( $flagged
) {
4489 var classNames
= Object
.keys( this.flags
).map( function ( flag
) {
4490 return 'oo-ui-flaggedElement-' + flag
;
4493 if ( this.$flagged
) {
4494 this.$flagged
.removeClass( classNames
);
4497 this.$flagged
= $flagged
.addClass( classNames
);
4501 * Check if a flag is set.
4503 * @param {string} flag Name of flag
4504 * @return {boolean} Has flag
4506 OO
.ui
.FlaggedElement
.prototype.hasFlag = function ( flag
) {
4507 return flag
in this.flags
;
4511 * Get the names of all flags set.
4513 * @return {string[]} flags Flag names
4515 OO
.ui
.FlaggedElement
.prototype.getFlags = function () {
4516 return Object
.keys( this.flags
);
4525 OO
.ui
.FlaggedElement
.prototype.clearFlags = function () {
4526 var flag
, className
,
4529 classPrefix
= 'oo-ui-flaggedElement-';
4531 for ( flag
in this.flags
) {
4532 className
= classPrefix
+ flag
;
4533 changes
[flag
] = false;
4534 delete this.flags
[flag
];
4535 remove
.push( className
);
4538 if ( this.$flagged
) {
4539 this.$flagged
.removeClass( remove
.join( ' ' ) );
4542 this.updateThemeClasses();
4543 this.emit( 'flag', changes
);
4549 * Add one or more flags.
4551 * @param {string|string[]|Object.<string, boolean>} flags One or more flags to add, or an object
4552 * keyed by flag name containing boolean set/remove instructions.
4556 OO
.ui
.FlaggedElement
.prototype.setFlags = function ( flags
) {
4557 var i
, len
, flag
, className
,
4561 classPrefix
= 'oo-ui-flaggedElement-';
4563 if ( typeof flags
=== 'string' ) {
4564 className
= classPrefix
+ flags
;
4566 if ( !this.flags
[flags
] ) {
4567 this.flags
[flags
] = true;
4568 add
.push( className
);
4570 } else if ( $.isArray( flags
) ) {
4571 for ( i
= 0, len
= flags
.length
; i
< len
; i
++ ) {
4573 className
= classPrefix
+ flag
;
4575 if ( !this.flags
[flag
] ) {
4576 changes
[flag
] = true;
4577 this.flags
[flag
] = true;
4578 add
.push( className
);
4581 } else if ( OO
.isPlainObject( flags
) ) {
4582 for ( flag
in flags
) {
4583 className
= classPrefix
+ flag
;
4584 if ( flags
[flag
] ) {
4586 if ( !this.flags
[flag
] ) {
4587 changes
[flag
] = true;
4588 this.flags
[flag
] = true;
4589 add
.push( className
);
4593 if ( this.flags
[flag
] ) {
4594 changes
[flag
] = false;
4595 delete this.flags
[flag
];
4596 remove
.push( className
);
4602 if ( this.$flagged
) {
4604 .addClass( add
.join( ' ' ) )
4605 .removeClass( remove
.join( ' ' ) );
4608 this.updateThemeClasses();
4609 this.emit( 'flag', changes
);
4615 * Element with a title.
4617 * Titles are rendered by the browser and are made visible when hovering the element. Titles are
4618 * not visible on touch devices.
4624 * @param {Object} [config] Configuration options
4625 * @cfg {jQuery} [$titled] Titled node, assigned to #$titled, omit to use #$element
4626 * @cfg {string|Function} [title] Title text or a function that returns text
4628 OO
.ui
.TitledElement
= function OoUiTitledElement( config
) {
4629 // Config intialization
4630 config
= config
|| {};
4633 this.$titled
= null;
4637 this.setTitle( config
.title
|| this.constructor.static.title
);
4638 this.setTitledElement( config
.$titled
|| this.$element
);
4643 OO
.initClass( OO
.ui
.TitledElement
);
4645 /* Static Properties */
4652 * @property {string|Function} Title text or a function that returns text
4654 OO
.ui
.TitledElement
.static.title
= null;
4659 * Set the titled element.
4661 * If an element is already set, it will be cleaned up before setting up the new element.
4663 * @param {jQuery} $titled Element to set title on
4665 OO
.ui
.TitledElement
.prototype.setTitledElement = function ( $titled
) {
4666 if ( this.$titled
) {
4667 this.$titled
.removeAttr( 'title' );
4670 this.$titled
= $titled
;
4672 this.$titled
.attr( 'title', this.title
);
4679 * @param {string|Function|null} title Title text, a function that returns text or null for no title
4682 OO
.ui
.TitledElement
.prototype.setTitle = function ( title
) {
4683 title
= typeof title
=== 'string' ? OO
.ui
.resolveMsg( title
) : null;
4685 if ( this.title
!== title
) {
4686 if ( this.$titled
) {
4687 if ( title
!== null ) {
4688 this.$titled
.attr( 'title', title
);
4690 this.$titled
.removeAttr( 'title' );
4702 * @return {string} Title string
4704 OO
.ui
.TitledElement
.prototype.getTitle = function () {
4709 * Element that can be automatically clipped to visible boundaries.
4711 * Whenever the element's natural height changes, you have to call
4712 * #clip to make sure it's still clipping correctly.
4718 * @param {Object} [config] Configuration options
4719 * @cfg {jQuery} [$clippable] Nodes to clip, assigned to #$clippable, omit to use #$element
4721 OO
.ui
.ClippableElement
= function OoUiClippableElement( config
) {
4722 // Configuration initialization
4723 config
= config
|| {};
4726 this.$clippable
= null;
4727 this.clipping
= false;
4728 this.clippedHorizontally
= false;
4729 this.clippedVertically
= false;
4730 this.$clippableContainer
= null;
4731 this.$clippableScroller
= null;
4732 this.$clippableWindow
= null;
4733 this.idealWidth
= null;
4734 this.idealHeight
= null;
4735 this.onClippableContainerScrollHandler
= OO
.ui
.bind( this.clip
, this );
4736 this.onClippableWindowResizeHandler
= OO
.ui
.bind( this.clip
, this );
4739 this.setClippableElement( config
.$clippable
|| this.$element
);
4745 * Set clippable element.
4747 * If an element is already set, it will be cleaned up before setting up the new element.
4749 * @param {jQuery} $clippable Element to make clippable
4751 OO
.ui
.ClippableElement
.prototype.setClippableElement = function ( $clippable
) {
4752 if ( this.$clippable
) {
4753 this.$clippable
.removeClass( 'oo-ui-clippableElement-clippable' );
4754 this.$clippable
.css( { width
: '', height
: '' } );
4755 this.$clippable
.width(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4756 this.$clippable
.css( { overflowX
: '', overflowY
: '' } );
4759 this.$clippable
= $clippable
.addClass( 'oo-ui-clippableElement-clippable' );
4766 * Do not turn clipping on until after the element is attached to the DOM and visible.
4768 * @param {boolean} [clipping] Enable clipping, omit to toggle
4771 OO
.ui
.ClippableElement
.prototype.toggleClipping = function ( clipping
) {
4772 clipping
= clipping
=== undefined ? !this.clipping
: !!clipping
;
4774 if ( this.clipping
!== clipping
) {
4775 this.clipping
= clipping
;
4777 this.$clippableContainer
= this.$( this.getClosestScrollableElementContainer() );
4778 // If the clippable container is the body, we have to listen to scroll events and check
4779 // jQuery.scrollTop on the window because of browser inconsistencies
4780 this.$clippableScroller
= this.$clippableContainer
.is( 'body' ) ?
4781 this.$( OO
.ui
.Element
.getWindow( this.$clippableContainer
) ) :
4782 this.$clippableContainer
;
4783 this.$clippableScroller
.on( 'scroll', this.onClippableContainerScrollHandler
);
4784 this.$clippableWindow
= this.$( this.getElementWindow() )
4785 .on( 'resize', this.onClippableWindowResizeHandler
);
4786 // Initial clip after visible
4789 this.$clippable
.css( { width
: '', height
: '' } );
4790 this.$clippable
.width(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4791 this.$clippable
.css( { overflowX
: '', overflowY
: '' } );
4793 this.$clippableContainer
= null;
4794 this.$clippableScroller
.off( 'scroll', this.onClippableContainerScrollHandler
);
4795 this.$clippableScroller
= null;
4796 this.$clippableWindow
.off( 'resize', this.onClippableWindowResizeHandler
);
4797 this.$clippableWindow
= null;
4805 * Check if the element will be clipped to fit the visible area of the nearest scrollable container.
4807 * @return {boolean} Element will be clipped to the visible area
4809 OO
.ui
.ClippableElement
.prototype.isClipping = function () {
4810 return this.clipping
;
4814 * Check if the bottom or right of the element is being clipped by the nearest scrollable container.
4816 * @return {boolean} Part of the element is being clipped
4818 OO
.ui
.ClippableElement
.prototype.isClipped = function () {
4819 return this.clippedHorizontally
|| this.clippedVertically
;
4823 * Check if the right of the element is being clipped by the nearest scrollable container.
4825 * @return {boolean} Part of the element is being clipped
4827 OO
.ui
.ClippableElement
.prototype.isClippedHorizontally = function () {
4828 return this.clippedHorizontally
;
4832 * Check if the bottom of the element is being clipped by the nearest scrollable container.
4834 * @return {boolean} Part of the element is being clipped
4836 OO
.ui
.ClippableElement
.prototype.isClippedVertically = function () {
4837 return this.clippedVertically
;
4841 * Set the ideal size. These are the dimensions the element will have when it's not being clipped.
4843 * @param {number|string} [width] Width as a number of pixels or CSS string with unit suffix
4844 * @param {number|string} [height] Height as a number of pixels or CSS string with unit suffix
4846 OO
.ui
.ClippableElement
.prototype.setIdealSize = function ( width
, height
) {
4847 this.idealWidth
= width
;
4848 this.idealHeight
= height
;
4850 if ( !this.clipping
) {
4851 // Update dimensions
4852 this.$clippable
.css( { width
: width
, height
: height
} );
4854 // While clipping, idealWidth and idealHeight are not considered
4858 * Clip element to visible boundaries and allow scrolling when needed. Call this method when
4859 * the element's natural height changes.
4861 * Element will be clipped the bottom or right of the element is within 10px of the edge of, or
4862 * overlapped by, the visible area of the nearest scrollable container.
4866 OO
.ui
.ClippableElement
.prototype.clip = function () {
4867 if ( !this.clipping
) {
4868 // this.$clippableContainer and this.$clippableWindow are null, so the below will fail
4873 cOffset
= this.$clippable
.offset(),
4874 $container
= this.$clippableContainer
.is( 'body' ) ?
4875 this.$clippableWindow
: this.$clippableContainer
,
4876 ccOffset
= $container
.offset() || { top
: 0, left
: 0 },
4877 ccHeight
= $container
.innerHeight() - buffer
,
4878 ccWidth
= $container
.innerWidth() - buffer
,
4879 scrollTop
= this.$clippableScroller
.scrollTop(),
4880 scrollLeft
= this.$clippableScroller
.scrollLeft(),
4881 desiredWidth
= ( ccOffset
.left
+ scrollLeft
+ ccWidth
) - cOffset
.left
,
4882 desiredHeight
= ( ccOffset
.top
+ scrollTop
+ ccHeight
) - cOffset
.top
,
4883 naturalWidth
= this.$clippable
.prop( 'scrollWidth' ),
4884 naturalHeight
= this.$clippable
.prop( 'scrollHeight' ),
4885 clipWidth
= desiredWidth
< naturalWidth
,
4886 clipHeight
= desiredHeight
< naturalHeight
;
4889 this.$clippable
.css( { overflowX
: 'scroll', width
: desiredWidth
} );
4891 this.$clippable
.css( 'width', this.idealWidth
|| '' );
4892 this.$clippable
.width(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4893 this.$clippable
.css( 'overflowX', '' );
4896 this.$clippable
.css( { overflowY
: 'scroll', height
: desiredHeight
} );
4898 this.$clippable
.css( 'height', this.idealHeight
|| '' );
4899 this.$clippable
.height(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4900 this.$clippable
.css( 'overflowY', '' );
4903 this.clippedHorizontally
= clipWidth
;
4904 this.clippedVertically
= clipHeight
;
4910 * Generic toolbar tool.
4914 * @extends OO.ui.Widget
4915 * @mixins OO.ui.IconElement
4916 * @mixins OO.ui.FlaggedElement
4919 * @param {OO.ui.ToolGroup} toolGroup
4920 * @param {Object} [config] Configuration options
4921 * @cfg {string|Function} [title] Title text or a function that returns text
4923 OO
.ui
.Tool
= function OoUiTool( toolGroup
, config
) {
4924 // Config intialization
4925 config
= config
|| {};
4927 // Parent constructor
4928 OO
.ui
.Tool
.super.call( this, config
);
4930 // Mixin constructors
4931 OO
.ui
.IconElement
.call( this, config
);
4932 OO
.ui
.FlaggedElement
.call( this, config
);
4935 this.toolGroup
= toolGroup
;
4936 this.toolbar
= this.toolGroup
.getToolbar();
4937 this.active
= false;
4938 this.$title
= this.$( '<span>' );
4939 this.$link
= this.$( '<a>' );
4943 this.toolbar
.connect( this, { updateState
: 'onUpdateState' } );
4946 this.$title
.addClass( 'oo-ui-tool-title' );
4948 .addClass( 'oo-ui-tool-link' )
4949 .append( this.$icon
, this.$title
)
4950 .prop( 'tabIndex', 0 )
4951 .attr( 'role', 'button' );
4953 .data( 'oo-ui-tool', this )
4955 'oo-ui-tool ' + 'oo-ui-tool-name-' +
4956 this.constructor.static.name
.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' )
4958 .append( this.$link
);
4959 this.setTitle( config
.title
|| this.constructor.static.title
);
4964 OO
.inheritClass( OO
.ui
.Tool
, OO
.ui
.Widget
);
4965 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.IconElement
);
4966 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.FlaggedElement
);
4974 /* Static Properties */
4980 OO
.ui
.Tool
.static.tagName
= 'span';
4983 * Symbolic name of tool.
4988 * @property {string}
4990 OO
.ui
.Tool
.static.name
= '';
4998 * @property {string}
5000 OO
.ui
.Tool
.static.group
= '';
5005 * Title is used as a tooltip when the tool is part of a bar tool group, or a label when the tool
5006 * is part of a list or menu tool group. If a trigger is associated with an action by the same name
5007 * as the tool, a description of its keyboard shortcut for the appropriate platform will be
5008 * appended to the title if the tool is part of a bar tool group.
5013 * @property {string|Function} Title text or a function that returns text
5015 OO
.ui
.Tool
.static.title
= '';
5018 * Tool can be automatically added to catch-all groups.
5022 * @property {boolean}
5024 OO
.ui
.Tool
.static.autoAddToCatchall
= true;
5027 * Tool can be automatically added to named groups.
5030 * @property {boolean}
5033 OO
.ui
.Tool
.static.autoAddToGroup
= true;
5036 * Check if this tool is compatible with given data.
5040 * @param {Mixed} data Data to check
5041 * @return {boolean} Tool can be used with data
5043 OO
.ui
.Tool
.static.isCompatibleWith = function () {
5050 * Handle the toolbar state being updated.
5052 * This is an abstract method that must be overridden in a concrete subclass.
5056 OO
.ui
.Tool
.prototype.onUpdateState = function () {
5058 'OO.ui.Tool.onUpdateState not implemented in this subclass:' + this.constructor
5063 * Handle the tool being selected.
5065 * This is an abstract method that must be overridden in a concrete subclass.
5069 OO
.ui
.Tool
.prototype.onSelect = function () {
5071 'OO.ui.Tool.onSelect not implemented in this subclass:' + this.constructor
5076 * Check if the button is active.
5078 * @param {boolean} Button is active
5080 OO
.ui
.Tool
.prototype.isActive = function () {
5085 * Make the button appear active or inactive.
5087 * @param {boolean} state Make button appear active
5089 OO
.ui
.Tool
.prototype.setActive = function ( state
) {
5090 this.active
= !!state
;
5091 if ( this.active
) {
5092 this.$element
.addClass( 'oo-ui-tool-active' );
5094 this.$element
.removeClass( 'oo-ui-tool-active' );
5099 * Get the tool title.
5101 * @param {string|Function} title Title text or a function that returns text
5104 OO
.ui
.Tool
.prototype.setTitle = function ( title
) {
5105 this.title
= OO
.ui
.resolveMsg( title
);
5111 * Get the tool title.
5113 * @return {string} Title text
5115 OO
.ui
.Tool
.prototype.getTitle = function () {
5120 * Get the tool's symbolic name.
5122 * @return {string} Symbolic name of tool
5124 OO
.ui
.Tool
.prototype.getName = function () {
5125 return this.constructor.static.name
;
5131 OO
.ui
.Tool
.prototype.updateTitle = function () {
5132 var titleTooltips
= this.toolGroup
.constructor.static.titleTooltips
,
5133 accelTooltips
= this.toolGroup
.constructor.static.accelTooltips
,
5134 accel
= this.toolbar
.getToolAccelerator( this.constructor.static.name
),
5141 .addClass( 'oo-ui-tool-accel' )
5145 if ( titleTooltips
&& typeof this.title
=== 'string' && this.title
.length
) {
5146 tooltipParts
.push( this.title
);
5148 if ( accelTooltips
&& typeof accel
=== 'string' && accel
.length
) {
5149 tooltipParts
.push( accel
);
5151 if ( tooltipParts
.length
) {
5152 this.$link
.attr( 'title', tooltipParts
.join( ' ' ) );
5154 this.$link
.removeAttr( 'title' );
5161 OO
.ui
.Tool
.prototype.destroy = function () {
5162 this.toolbar
.disconnect( this );
5163 this.$element
.remove();
5167 * Collection of tool groups.
5170 * @extends OO.ui.Element
5171 * @mixins OO.EventEmitter
5172 * @mixins OO.ui.GroupElement
5175 * @param {OO.ui.ToolFactory} toolFactory Factory for creating tools
5176 * @param {OO.ui.ToolGroupFactory} toolGroupFactory Factory for creating tool groups
5177 * @param {Object} [config] Configuration options
5178 * @cfg {boolean} [actions] Add an actions section opposite to the tools
5179 * @cfg {boolean} [shadow] Add a shadow below the toolbar
5181 OO
.ui
.Toolbar
= function OoUiToolbar( toolFactory
, toolGroupFactory
, config
) {
5182 // Configuration initialization
5183 config
= config
|| {};
5185 // Parent constructor
5186 OO
.ui
.Toolbar
.super.call( this, config
);
5188 // Mixin constructors
5189 OO
.EventEmitter
.call( this );
5190 OO
.ui
.GroupElement
.call( this, config
);
5193 this.toolFactory
= toolFactory
;
5194 this.toolGroupFactory
= toolGroupFactory
;
5197 this.$bar
= this.$( '<div>' );
5198 this.$actions
= this.$( '<div>' );
5199 this.initialized
= false;
5203 .add( this.$bar
).add( this.$group
).add( this.$actions
)
5204 .on( 'mousedown touchstart', OO
.ui
.bind( this.onPointerDown
, this ) );
5207 this.$group
.addClass( 'oo-ui-toolbar-tools' );
5208 this.$bar
.addClass( 'oo-ui-toolbar-bar' ).append( this.$group
);
5209 if ( config
.actions
) {
5210 this.$actions
.addClass( 'oo-ui-toolbar-actions' );
5211 this.$bar
.append( this.$actions
);
5213 this.$bar
.append( '<div style="clear:both"></div>' );
5214 if ( config
.shadow
) {
5215 this.$bar
.append( '<div class="oo-ui-toolbar-shadow"></div>' );
5217 this.$element
.addClass( 'oo-ui-toolbar' ).append( this.$bar
);
5222 OO
.inheritClass( OO
.ui
.Toolbar
, OO
.ui
.Element
);
5223 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.EventEmitter
);
5224 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.ui
.GroupElement
);
5229 * Get the tool factory.
5231 * @return {OO.ui.ToolFactory} Tool factory
5233 OO
.ui
.Toolbar
.prototype.getToolFactory = function () {
5234 return this.toolFactory
;
5238 * Get the tool group factory.
5240 * @return {OO.Factory} Tool group factory
5242 OO
.ui
.Toolbar
.prototype.getToolGroupFactory = function () {
5243 return this.toolGroupFactory
;
5247 * Handles mouse down events.
5249 * @param {jQuery.Event} e Mouse down event
5251 OO
.ui
.Toolbar
.prototype.onPointerDown = function ( e
) {
5252 var $closestWidgetToEvent
= this.$( e
.target
).closest( '.oo-ui-widget' ),
5253 $closestWidgetToToolbar
= this.$element
.closest( '.oo-ui-widget' );
5254 if ( !$closestWidgetToEvent
.length
|| $closestWidgetToEvent
[0] === $closestWidgetToToolbar
[0] ) {
5260 * Sets up handles and preloads required information for the toolbar to work.
5261 * This must be called immediately after it is attached to a visible document.
5263 OO
.ui
.Toolbar
.prototype.initialize = function () {
5264 this.initialized
= true;
5270 * Tools can be specified in the following ways:
5272 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
5273 * - All tools in a group: `{ group: 'group-name' }`
5274 * - All tools: `'*'` - Using this will make the group a list with a "More" label by default
5276 * @param {Object.<string,Array>} groups List of tool group configurations
5277 * @param {Array|string} [groups.include] Tools to include
5278 * @param {Array|string} [groups.exclude] Tools to exclude
5279 * @param {Array|string} [groups.promote] Tools to promote to the beginning
5280 * @param {Array|string} [groups.demote] Tools to demote to the end
5282 OO
.ui
.Toolbar
.prototype.setup = function ( groups
) {
5283 var i
, len
, type
, group
,
5285 defaultType
= 'bar';
5287 // Cleanup previous groups
5290 // Build out new groups
5291 for ( i
= 0, len
= groups
.length
; i
< len
; i
++ ) {
5293 if ( group
.include
=== '*' ) {
5294 // Apply defaults to catch-all groups
5295 if ( group
.type
=== undefined ) {
5296 group
.type
= 'list';
5298 if ( group
.label
=== undefined ) {
5299 group
.label
= 'ooui-toolbar-more';
5302 // Check type has been registered
5303 type
= this.getToolGroupFactory().lookup( group
.type
) ? group
.type
: defaultType
;
5305 this.getToolGroupFactory().create( type
, this, $.extend( { $: this.$ }, group
) )
5308 this.addItems( items
);
5312 * Remove all tools and groups from the toolbar.
5314 OO
.ui
.Toolbar
.prototype.reset = function () {
5319 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
5320 this.items
[i
].destroy();
5326 * Destroys toolbar, removing event handlers and DOM elements.
5328 * Call this whenever you are done using a toolbar.
5330 OO
.ui
.Toolbar
.prototype.destroy = function () {
5332 this.$element
.remove();
5336 * Check if tool has not been used yet.
5338 * @param {string} name Symbolic name of tool
5339 * @return {boolean} Tool is available
5341 OO
.ui
.Toolbar
.prototype.isToolAvailable = function ( name
) {
5342 return !this.tools
[name
];
5346 * Prevent tool from being used again.
5348 * @param {OO.ui.Tool} tool Tool to reserve
5350 OO
.ui
.Toolbar
.prototype.reserveTool = function ( tool
) {
5351 this.tools
[tool
.getName()] = tool
;
5355 * Allow tool to be used again.
5357 * @param {OO.ui.Tool} tool Tool to release
5359 OO
.ui
.Toolbar
.prototype.releaseTool = function ( tool
) {
5360 delete this.tools
[tool
.getName()];
5364 * Get accelerator label for tool.
5366 * This is a stub that should be overridden to provide access to accelerator information.
5368 * @param {string} name Symbolic name of tool
5369 * @return {string|undefined} Tool accelerator label if available
5371 OO
.ui
.Toolbar
.prototype.getToolAccelerator = function () {
5376 * Collection of tools.
5378 * Tools can be specified in the following ways:
5380 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
5381 * - All tools in a group: `{ group: 'group-name' }`
5382 * - All tools: `'*'`
5386 * @extends OO.ui.Widget
5387 * @mixins OO.ui.GroupElement
5390 * @param {OO.ui.Toolbar} toolbar
5391 * @param {Object} [config] Configuration options
5392 * @cfg {Array|string} [include=[]] List of tools to include
5393 * @cfg {Array|string} [exclude=[]] List of tools to exclude
5394 * @cfg {Array|string} [promote=[]] List of tools to promote to the beginning
5395 * @cfg {Array|string} [demote=[]] List of tools to demote to the end
5397 OO
.ui
.ToolGroup
= function OoUiToolGroup( toolbar
, config
) {
5398 // Configuration initialization
5399 config
= config
|| {};
5401 // Parent constructor
5402 OO
.ui
.ToolGroup
.super.call( this, config
);
5404 // Mixin constructors
5405 OO
.ui
.GroupElement
.call( this, config
);
5408 this.toolbar
= toolbar
;
5410 this.pressed
= null;
5411 this.autoDisabled
= false;
5412 this.include
= config
.include
|| [];
5413 this.exclude
= config
.exclude
|| [];
5414 this.promote
= config
.promote
|| [];
5415 this.demote
= config
.demote
|| [];
5416 this.onCapturedMouseUpHandler
= OO
.ui
.bind( this.onCapturedMouseUp
, this );
5420 'mousedown touchstart': OO
.ui
.bind( this.onPointerDown
, this ),
5421 'mouseup touchend': OO
.ui
.bind( this.onPointerUp
, this ),
5422 mouseover
: OO
.ui
.bind( this.onMouseOver
, this ),
5423 mouseout
: OO
.ui
.bind( this.onMouseOut
, this )
5425 this.toolbar
.getToolFactory().connect( this, { register
: 'onToolFactoryRegister' } );
5426 this.aggregate( { disable
: 'itemDisable' } );
5427 this.connect( this, { itemDisable
: 'updateDisabled' } );
5430 this.$group
.addClass( 'oo-ui-toolGroup-tools' );
5432 .addClass( 'oo-ui-toolGroup' )
5433 .append( this.$group
);
5439 OO
.inheritClass( OO
.ui
.ToolGroup
, OO
.ui
.Widget
);
5440 OO
.mixinClass( OO
.ui
.ToolGroup
, OO
.ui
.GroupElement
);
5448 /* Static Properties */
5451 * Show labels in tooltips.
5455 * @property {boolean}
5457 OO
.ui
.ToolGroup
.static.titleTooltips
= false;
5460 * Show acceleration labels in tooltips.
5464 * @property {boolean}
5466 OO
.ui
.ToolGroup
.static.accelTooltips
= false;
5469 * Automatically disable the toolgroup when all tools are disabled
5473 * @property {boolean}
5475 OO
.ui
.ToolGroup
.static.autoDisable
= true;
5482 OO
.ui
.ToolGroup
.prototype.isDisabled = function () {
5483 return this.autoDisabled
|| OO
.ui
.ToolGroup
.super.prototype.isDisabled
.apply( this, arguments
);
5489 OO
.ui
.ToolGroup
.prototype.updateDisabled = function () {
5490 var i
, item
, allDisabled
= true;
5492 if ( this.constructor.static.autoDisable
) {
5493 for ( i
= this.items
.length
- 1; i
>= 0; i
-- ) {
5494 item
= this.items
[i
];
5495 if ( !item
.isDisabled() ) {
5496 allDisabled
= false;
5500 this.autoDisabled
= allDisabled
;
5502 OO
.ui
.ToolGroup
.super.prototype.updateDisabled
.apply( this, arguments
);
5506 * Handle mouse down events.
5508 * @param {jQuery.Event} e Mouse down event
5510 OO
.ui
.ToolGroup
.prototype.onPointerDown = function ( e
) {
5511 // e.which is 0 for touch events, 1 for left mouse button
5512 if ( !this.isDisabled() && e
.which
<= 1 ) {
5513 this.pressed
= this.getTargetTool( e
);
5514 if ( this.pressed
) {
5515 this.pressed
.setActive( true );
5516 this.getElementDocument().addEventListener(
5517 'mouseup', this.onCapturedMouseUpHandler
, true
5525 * Handle captured mouse up events.
5527 * @param {Event} e Mouse up event
5529 OO
.ui
.ToolGroup
.prototype.onCapturedMouseUp = function ( e
) {
5530 this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseUpHandler
, true );
5531 // onPointerUp may be called a second time, depending on where the mouse is when the button is
5532 // released, but since `this.pressed` will no longer be true, the second call will be ignored.
5533 this.onPointerUp( e
);
5537 * Handle mouse up events.
5539 * @param {jQuery.Event} e Mouse up event
5541 OO
.ui
.ToolGroup
.prototype.onPointerUp = function ( e
) {
5542 var tool
= this.getTargetTool( e
);
5544 // e.which is 0 for touch events, 1 for left mouse button
5545 if ( !this.isDisabled() && e
.which
<= 1 && this.pressed
&& this.pressed
=== tool
) {
5546 this.pressed
.onSelect();
5549 this.pressed
= null;
5554 * Handle mouse over events.
5556 * @param {jQuery.Event} e Mouse over event
5558 OO
.ui
.ToolGroup
.prototype.onMouseOver = function ( e
) {
5559 var tool
= this.getTargetTool( e
);
5561 if ( this.pressed
&& this.pressed
=== tool
) {
5562 this.pressed
.setActive( true );
5567 * Handle mouse out events.
5569 * @param {jQuery.Event} e Mouse out event
5571 OO
.ui
.ToolGroup
.prototype.onMouseOut = function ( e
) {
5572 var tool
= this.getTargetTool( e
);
5574 if ( this.pressed
&& this.pressed
=== tool
) {
5575 this.pressed
.setActive( false );
5580 * Get the closest tool to a jQuery.Event.
5582 * Only tool links are considered, which prevents other elements in the tool such as popups from
5583 * triggering tool group interactions.
5586 * @param {jQuery.Event} e
5587 * @return {OO.ui.Tool|null} Tool, `null` if none was found
5589 OO
.ui
.ToolGroup
.prototype.getTargetTool = function ( e
) {
5591 $item
= this.$( e
.target
).closest( '.oo-ui-tool-link' );
5593 if ( $item
.length
) {
5594 tool
= $item
.parent().data( 'oo-ui-tool' );
5597 return tool
&& !tool
.isDisabled() ? tool
: null;
5601 * Handle tool registry register events.
5603 * If a tool is registered after the group is created, we must repopulate the list to account for:
5605 * - a tool being added that may be included
5606 * - a tool already included being overridden
5608 * @param {string} name Symbolic name of tool
5610 OO
.ui
.ToolGroup
.prototype.onToolFactoryRegister = function () {
5615 * Get the toolbar this group is in.
5617 * @return {OO.ui.Toolbar} Toolbar of group
5619 OO
.ui
.ToolGroup
.prototype.getToolbar = function () {
5620 return this.toolbar
;
5624 * Add and remove tools based on configuration.
5626 OO
.ui
.ToolGroup
.prototype.populate = function () {
5627 var i
, len
, name
, tool
,
5628 toolFactory
= this.toolbar
.getToolFactory(),
5632 list
= this.toolbar
.getToolFactory().getTools(
5633 this.include
, this.exclude
, this.promote
, this.demote
5636 // Build a list of needed tools
5637 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
5641 toolFactory
.lookup( name
) &&
5642 // Tool is available or is already in this group
5643 ( this.toolbar
.isToolAvailable( name
) || this.tools
[name
] )
5645 tool
= this.tools
[name
];
5647 // Auto-initialize tools on first use
5648 this.tools
[name
] = tool
= toolFactory
.create( name
, this );
5651 this.toolbar
.reserveTool( tool
);
5656 // Remove tools that are no longer needed
5657 for ( name
in this.tools
) {
5658 if ( !names
[name
] ) {
5659 this.tools
[name
].destroy();
5660 this.toolbar
.releaseTool( this.tools
[name
] );
5661 remove
.push( this.tools
[name
] );
5662 delete this.tools
[name
];
5665 if ( remove
.length
) {
5666 this.removeItems( remove
);
5668 // Update emptiness state
5670 this.$element
.removeClass( 'oo-ui-toolGroup-empty' );
5672 this.$element
.addClass( 'oo-ui-toolGroup-empty' );
5674 // Re-add tools (moving existing ones to new locations)
5675 this.addItems( add
);
5676 // Disabled state may depend on items
5677 this.updateDisabled();
5681 * Destroy tool group.
5683 OO
.ui
.ToolGroup
.prototype.destroy = function () {
5687 this.toolbar
.getToolFactory().disconnect( this );
5688 for ( name
in this.tools
) {
5689 this.toolbar
.releaseTool( this.tools
[name
] );
5690 this.tools
[name
].disconnect( this ).destroy();
5691 delete this.tools
[name
];
5693 this.$element
.remove();
5697 * Dialog for showing a message.
5700 * - Registers two actions by default (safe and primary).
5701 * - Renders action widgets in the footer.
5704 * @extends OO.ui.Dialog
5707 * @param {Object} [config] Configuration options
5709 OO
.ui
.MessageDialog
= function OoUiMessageDialog( config
) {
5710 // Parent constructor
5711 OO
.ui
.MessageDialog
.super.call( this, config
);
5714 this.verticalActionLayout
= null;
5717 this.$element
.addClass( 'oo-ui-messageDialog' );
5722 OO
.inheritClass( OO
.ui
.MessageDialog
, OO
.ui
.Dialog
);
5724 /* Static Properties */
5726 OO
.ui
.MessageDialog
.static.name
= 'message';
5728 OO
.ui
.MessageDialog
.static.size
= 'small';
5730 OO
.ui
.MessageDialog
.static.verbose
= false;
5735 * A confirmation dialog's title should describe what the progressive action will do. An alert
5736 * dialog's title should describe what event occured.
5740 * @property {jQuery|string|Function|null}
5742 OO
.ui
.MessageDialog
.static.title
= null;
5745 * A confirmation dialog's message should describe the consequences of the progressive action. An
5746 * alert dialog's message should describe why the event occured.
5750 * @property {jQuery|string|Function|null}
5752 OO
.ui
.MessageDialog
.static.message
= null;
5754 OO
.ui
.MessageDialog
.static.actions
= [
5755 { action
: 'accept', label
: OO
.ui
.deferMsg( 'ooui-dialog-message-accept' ), flags
: 'primary' },
5756 { action
: 'reject', label
: OO
.ui
.deferMsg( 'ooui-dialog-message-reject' ), flags
: 'safe' }
5764 OO
.ui
.MessageDialog
.prototype.onActionResize = function ( action
) {
5766 return OO
.ui
.ProcessDialog
.super.prototype.onActionResize
.call( this, action
);
5770 * Toggle action layout between vertical and horizontal.
5772 * @param {boolean} [value] Layout actions vertically, omit to toggle
5775 OO
.ui
.MessageDialog
.prototype.toggleVerticalActionLayout = function ( value
) {
5776 value
= value
=== undefined ? !this.verticalActionLayout
: !!value
;
5778 if ( value
!== this.verticalActionLayout
) {
5779 this.verticalActionLayout
= value
;
5781 .toggleClass( 'oo-ui-messageDialog-actions-vertical', value
)
5782 .toggleClass( 'oo-ui-messageDialog-actions-horizontal', !value
);
5791 OO
.ui
.MessageDialog
.prototype.getActionProcess = function ( action
) {
5793 return new OO
.ui
.Process( function () {
5794 this.close( { action
: action
} );
5797 return OO
.ui
.MessageDialog
.super.prototype.getActionProcess
.call( this, action
);
5803 * @param {Object} [data] Dialog opening data
5804 * @param {jQuery|string|Function|null} [data.title] Description of the action being confirmed
5805 * @param {jQuery|string|Function|null} [data.message] Description of the action's consequence
5806 * @param {boolean} [data.verbose] Message is verbose and should be styled as a long message
5807 * @param {Object[]} [data.actions] List of OO.ui.ActionOptionWidget configuration options for each
5810 OO
.ui
.MessageDialog
.prototype.getSetupProcess = function ( data
) {
5814 return OO
.ui
.MessageDialog
.super.prototype.getSetupProcess
.call( this, data
)
5815 .next( function () {
5816 this.title
.setLabel(
5817 data
.title
!== undefined ? data
.title
: this.constructor.static.title
5819 this.message
.setLabel(
5820 data
.message
!== undefined ? data
.message
: this.constructor.static.message
5822 this.message
.$element
.toggleClass(
5823 'oo-ui-messageDialog-message-verbose',
5824 data
.verbose
!== undefined ? data
.verbose
: this.constructor.static.verbose
5832 OO
.ui
.MessageDialog
.prototype.getBodyHeight = function () {
5833 return Math
.round( this.text
.$element
.outerHeight( true ) );
5839 OO
.ui
.MessageDialog
.prototype.initialize = function () {
5841 OO
.ui
.MessageDialog
.super.prototype.initialize
.call( this );
5844 this.$actions
= this.$( '<div>' );
5845 this.container
= new OO
.ui
.PanelLayout( {
5846 $: this.$, scrollable
: true, classes
: [ 'oo-ui-messageDialog-container' ]
5848 this.text
= new OO
.ui
.PanelLayout( {
5849 $: this.$, padded
: true, expanded
: false, classes
: [ 'oo-ui-messageDialog-text' ]
5851 this.message
= new OO
.ui
.LabelWidget( {
5852 $: this.$, classes
: [ 'oo-ui-messageDialog-message' ]
5856 this.title
.$element
.addClass( 'oo-ui-messageDialog-title' );
5857 this.$content
.addClass( 'oo-ui-messageDialog-content' );
5858 this.container
.$element
.append( this.text
.$element
);
5859 this.text
.$element
.append( this.title
.$element
, this.message
.$element
);
5860 this.$body
.append( this.container
.$element
);
5861 this.$actions
.addClass( 'oo-ui-messageDialog-actions' );
5862 this.$foot
.append( this.$actions
);
5868 OO
.ui
.MessageDialog
.prototype.attachActions = function () {
5869 var i
, len
, other
, special
, others
;
5872 OO
.ui
.MessageDialog
.super.prototype.attachActions
.call( this );
5874 special
= this.actions
.getSpecial();
5875 others
= this.actions
.getOthers();
5876 if ( special
.safe
) {
5877 this.$actions
.append( special
.safe
.$element
);
5878 special
.safe
.toggleFramed( false );
5880 if ( others
.length
) {
5881 for ( i
= 0, len
= others
.length
; i
< len
; i
++ ) {
5883 this.$actions
.append( other
.$element
);
5884 other
.toggleFramed( false );
5887 if ( special
.primary
) {
5888 this.$actions
.append( special
.primary
.$element
);
5889 special
.primary
.toggleFramed( false );
5893 if ( !this.isOpening() ) {
5894 this.manager
.updateWindowSize( this );
5896 this.$body
.css( 'bottom', this.$foot
.outerHeight( true ) );
5900 * Fit action actions into columns or rows.
5902 * Columns will be used if all labels can fit without overflow, otherwise rows will be used.
5904 OO
.ui
.MessageDialog
.prototype.fitActions = function () {
5906 actions
= this.actions
.get();
5909 this.toggleVerticalActionLayout( false );
5910 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
5911 action
= actions
[i
];
5912 if ( action
.$element
.innerWidth() < action
.$label
.outerWidth( true ) ) {
5913 this.toggleVerticalActionLayout( true );
5920 * Navigation dialog window.
5923 * - Show and hide errors.
5924 * - Retry an action.
5927 * - Renders header with dialog title and one action widget on either side
5928 * (a 'safe' button on the left, and a 'primary' button on the right, both of
5929 * which close the dialog).
5930 * - Displays any action widgets in the footer (none by default).
5931 * - Ability to dismiss errors.
5933 * Subclass responsibilities:
5934 * - Register a 'safe' action.
5935 * - Register a 'primary' action.
5936 * - Add content to the dialog.
5940 * @extends OO.ui.Dialog
5943 * @param {Object} [config] Configuration options
5945 OO
.ui
.ProcessDialog
= function OoUiProcessDialog( config
) {
5946 // Parent constructor
5947 OO
.ui
.ProcessDialog
.super.call( this, config
);
5950 this.$element
.addClass( 'oo-ui-processDialog' );
5955 OO
.inheritClass( OO
.ui
.ProcessDialog
, OO
.ui
.Dialog
);
5960 * Handle dismiss button click events.
5964 OO
.ui
.ProcessDialog
.prototype.onDismissErrorButtonClick = function () {
5969 * Handle retry button click events.
5971 * Hides errors and then tries again.
5973 OO
.ui
.ProcessDialog
.prototype.onRetryButtonClick = function () {
5975 this.executeAction( this.currentAction
.getAction() );
5981 OO
.ui
.ProcessDialog
.prototype.onActionResize = function ( action
) {
5982 if ( this.actions
.isSpecial( action
) ) {
5985 return OO
.ui
.ProcessDialog
.super.prototype.onActionResize
.call( this, action
);
5991 OO
.ui
.ProcessDialog
.prototype.initialize = function () {
5993 OO
.ui
.ProcessDialog
.super.prototype.initialize
.call( this );
5996 this.$navigation
= this.$( '<div>' );
5997 this.$location
= this.$( '<div>' );
5998 this.$safeActions
= this.$( '<div>' );
5999 this.$primaryActions
= this.$( '<div>' );
6000 this.$otherActions
= this.$( '<div>' );
6001 this.dismissButton
= new OO
.ui
.ButtonWidget( {
6003 label
: OO
.ui
.msg( 'ooui-dialog-process-dismiss' )
6005 this.retryButton
= new OO
.ui
.ButtonWidget( {
6007 label
: OO
.ui
.msg( 'ooui-dialog-process-retry' )
6009 this.$errors
= this.$( '<div>' );
6010 this.$errorsTitle
= this.$( '<div>' );
6013 this.dismissButton
.connect( this, { click
: 'onDismissErrorButtonClick' } );
6014 this.retryButton
.connect( this, { click
: 'onRetryButtonClick' } );
6017 this.title
.$element
.addClass( 'oo-ui-processDialog-title' );
6019 .append( this.title
.$element
)
6020 .addClass( 'oo-ui-processDialog-location' );
6021 this.$safeActions
.addClass( 'oo-ui-processDialog-actions-safe' );
6022 this.$primaryActions
.addClass( 'oo-ui-processDialog-actions-primary' );
6023 this.$otherActions
.addClass( 'oo-ui-processDialog-actions-other' );
6025 .addClass( 'oo-ui-processDialog-errors-title' )
6026 .text( OO
.ui
.msg( 'ooui-dialog-process-error' ) );
6028 .addClass( 'oo-ui-processDialog-errors' )
6029 .append( this.$errorsTitle
, this.dismissButton
.$element
, this.retryButton
.$element
);
6031 .addClass( 'oo-ui-processDialog-content' )
6032 .append( this.$errors
);
6034 .addClass( 'oo-ui-processDialog-navigation' )
6035 .append( this.$safeActions
, this.$location
, this.$primaryActions
);
6036 this.$head
.append( this.$navigation
);
6037 this.$foot
.append( this.$otherActions
);
6043 OO
.ui
.ProcessDialog
.prototype.attachActions = function () {
6044 var i
, len
, other
, special
, others
;
6047 OO
.ui
.ProcessDialog
.super.prototype.attachActions
.call( this );
6049 special
= this.actions
.getSpecial();
6050 others
= this.actions
.getOthers();
6051 if ( special
.primary
) {
6052 this.$primaryActions
.append( special
.primary
.$element
);
6053 special
.primary
.toggleFramed( true );
6055 if ( others
.length
) {
6056 for ( i
= 0, len
= others
.length
; i
< len
; i
++ ) {
6058 this.$otherActions
.append( other
.$element
);
6059 other
.toggleFramed( true );
6062 if ( special
.safe
) {
6063 this.$safeActions
.append( special
.safe
.$element
);
6064 special
.safe
.toggleFramed( true );
6068 this.$body
.css( 'bottom', this.$foot
.outerHeight( true ) );
6074 OO
.ui
.ProcessDialog
.prototype.executeAction = function ( action
) {
6075 OO
.ui
.ProcessDialog
.super.prototype.executeAction
.call( this, action
)
6076 .fail( OO
.ui
.bind( this.showErrors
, this ) );
6080 * Fit label between actions.
6084 OO
.ui
.ProcessDialog
.prototype.fitLabel = function () {
6085 var width
= Math
.max(
6086 this.$safeActions
.is( ':visible' ) ? this.$safeActions
.width() : 0,
6087 this.$primaryActions
.is( ':visible' ) ? this.$primaryActions
.width() : 0
6089 this.$location
.css( { paddingLeft
: width
, paddingRight
: width
} );
6095 * Handle errors that occured durring accept or reject processes.
6097 * @param {OO.ui.Error[]} errors Errors to be handled
6099 OO
.ui
.ProcessDialog
.prototype.showErrors = function ( errors
) {
6104 for ( i
= 0, len
= errors
.length
; i
< len
; i
++ ) {
6105 if ( !errors
[i
].isRecoverable() ) {
6106 recoverable
= false;
6108 $item
= this.$( '<div>' )
6109 .addClass( 'oo-ui-processDialog-error' )
6110 .append( errors
[i
].getMessage() );
6111 items
.push( $item
[0] );
6113 this.$errorItems
= this.$( items
);
6114 if ( recoverable
) {
6115 this.retryButton
.clearFlags().setFlags( this.currentAction
.getFlags() );
6117 this.currentAction
.setDisabled( true );
6119 this.retryButton
.toggle( recoverable
);
6120 this.$errorsTitle
.after( this.$errorItems
);
6121 this.$errors
.show().scrollTop( 0 );
6127 OO
.ui
.ProcessDialog
.prototype.hideErrors = function () {
6128 this.$errors
.hide();
6129 this.$errorItems
.remove();
6130 this.$errorItems
= null;
6134 * Layout containing a series of pages.
6137 * @extends OO.ui.Layout
6140 * @param {Object} [config] Configuration options
6141 * @cfg {boolean} [continuous=false] Show all pages, one after another
6142 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when changing to a page
6143 * @cfg {boolean} [outlined=false] Show an outline
6144 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
6146 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
6147 // Initialize configuration
6148 config
= config
|| {};
6150 // Parent constructor
6151 OO
.ui
.BookletLayout
.super.call( this, config
);
6154 this.currentPageName
= null;
6156 this.ignoreFocus
= false;
6157 this.stackLayout
= new OO
.ui
.StackLayout( { $: this.$, continuous
: !!config
.continuous
} );
6158 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
6159 this.outlineVisible
= false;
6160 this.outlined
= !!config
.outlined
;
6161 if ( this.outlined
) {
6162 this.editable
= !!config
.editable
;
6163 this.outlineControlsWidget
= null;
6164 this.outlineWidget
= new OO
.ui
.OutlineWidget( { $: this.$ } );
6165 this.outlinePanel
= new OO
.ui
.PanelLayout( { $: this.$, scrollable
: true } );
6166 this.gridLayout
= new OO
.ui
.GridLayout(
6167 [ this.outlinePanel
, this.stackLayout
],
6168 { $: this.$, widths
: [ 1, 2 ] }
6170 this.outlineVisible
= true;
6171 if ( this.editable
) {
6172 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
6173 this.outlineWidget
, { $: this.$ }
6179 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
6180 if ( this.outlined
) {
6181 this.outlineWidget
.connect( this, { select
: 'onOutlineWidgetSelect' } );
6183 if ( this.autoFocus
) {
6184 // Event 'focus' does not bubble, but 'focusin' does
6185 this.stackLayout
.onDOMEvent( 'focusin', OO
.ui
.bind( this.onStackLayoutFocus
, this ) );
6189 this.$element
.addClass( 'oo-ui-bookletLayout' );
6190 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
6191 if ( this.outlined
) {
6192 this.outlinePanel
.$element
6193 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
6194 .append( this.outlineWidget
.$element
);
6195 if ( this.editable
) {
6196 this.outlinePanel
.$element
6197 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
6198 .append( this.outlineControlsWidget
.$element
);
6200 this.$element
.append( this.gridLayout
.$element
);
6202 this.$element
.append( this.stackLayout
.$element
);
6208 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.Layout
);
6214 * @param {OO.ui.PageLayout} page Current page
6219 * @param {OO.ui.PageLayout[]} page Added pages
6220 * @param {number} index Index pages were added at
6225 * @param {OO.ui.PageLayout[]} pages Removed pages
6231 * Handle stack layout focus.
6233 * @param {jQuery.Event} e Focusin event
6235 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
6238 // Find the page that an element was focused within
6239 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
6240 for ( name
in this.pages
) {
6241 // Check for page match, exclude current page to find only page changes
6242 if ( this.pages
[name
].$element
[0] === $target
[0] && name
!== this.currentPageName
) {
6243 this.setPage( name
);
6250 * Handle stack layout set events.
6252 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
6254 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
6255 var $input
, layout
= this;
6257 page
.scrollElementIntoView( { complete: function () {
6258 if ( layout
.autoFocus
) {
6259 // Set focus to the first input if nothing on the page is focused yet
6260 if ( !page
.$element
.find( ':focus' ).length
) {
6261 $input
= page
.$element
.find( ':input:first' );
6262 if ( $input
.length
) {
6272 * Handle outline widget select events.
6274 * @param {OO.ui.OptionWidget|null} item Selected item
6276 OO
.ui
.BookletLayout
.prototype.onOutlineWidgetSelect = function ( item
) {
6278 this.setPage( item
.getData() );
6283 * Check if booklet has an outline.
6287 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
6288 return this.outlined
;
6292 * Check if booklet has editing controls.
6296 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
6297 return this.editable
;
6301 * Check if booklet has a visible outline.
6305 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
6306 return this.outlined
&& this.outlineVisible
;
6310 * Hide or show the outline.
6312 * @param {boolean} [show] Show outline, omit to invert current state
6315 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
6316 if ( this.outlined
) {
6317 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
6318 this.outlineVisible
= show
;
6319 this.gridLayout
.layout( show
? [ 1, 2 ] : [ 0, 1 ], [ 1 ] );
6326 * Get the outline widget.
6328 * @param {OO.ui.PageLayout} page Page to be selected
6329 * @return {OO.ui.PageLayout|null} Closest page to another
6331 OO
.ui
.BookletLayout
.prototype.getClosestPage = function ( page
) {
6332 var next
, prev
, level
,
6333 pages
= this.stackLayout
.getItems(),
6334 index
= $.inArray( page
, pages
);
6336 if ( index
!== -1 ) {
6337 next
= pages
[index
+ 1];
6338 prev
= pages
[index
- 1];
6339 // Prefer adjacent pages at the same level
6340 if ( this.outlined
) {
6341 level
= this.outlineWidget
.getItemFromData( page
.getName() ).getLevel();
6344 level
=== this.outlineWidget
.getItemFromData( prev
.getName() ).getLevel()
6350 level
=== this.outlineWidget
.getItemFromData( next
.getName() ).getLevel()
6356 return prev
|| next
|| null;
6360 * Get the outline widget.
6362 * @return {OO.ui.OutlineWidget|null} Outline widget, or null if boolet has no outline
6364 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
6365 return this.outlineWidget
;
6369 * Get the outline controls widget. If the outline is not editable, null is returned.
6371 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
6373 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
6374 return this.outlineControlsWidget
;
6378 * Get a page by name.
6380 * @param {string} name Symbolic name of page
6381 * @return {OO.ui.PageLayout|undefined} Page, if found
6383 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
6384 return this.pages
[name
];
6388 * Get the current page name.
6390 * @return {string|null} Current page name
6392 OO
.ui
.BookletLayout
.prototype.getPageName = function () {
6393 return this.currentPageName
;
6397 * Add a page to the layout.
6399 * When pages are added with the same names as existing pages, the existing pages will be
6400 * automatically removed before the new pages are added.
6402 * @param {OO.ui.PageLayout[]} pages Pages to add
6403 * @param {number} index Index to insert pages after
6407 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
6408 var i
, len
, name
, page
, item
, currentIndex
,
6409 stackLayoutPages
= this.stackLayout
.getItems(),
6413 // Remove pages with same names
6414 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
6416 name
= page
.getName();
6418 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
6419 // Correct the insertion index
6420 currentIndex
= $.inArray( this.pages
[name
], stackLayoutPages
);
6421 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
6424 remove
.push( this.pages
[name
] );
6427 if ( remove
.length
) {
6428 this.removePages( remove
);
6432 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
6434 name
= page
.getName();
6435 this.pages
[page
.getName()] = page
;
6436 if ( this.outlined
) {
6437 item
= new OO
.ui
.OutlineItemWidget( name
, page
, { $: this.$ } );
6438 page
.setOutlineItem( item
);
6443 if ( this.outlined
&& items
.length
) {
6444 this.outlineWidget
.addItems( items
, index
);
6445 this.updateOutlineWidget();
6447 this.stackLayout
.addItems( pages
, index
);
6448 this.emit( 'add', pages
, index
);
6454 * Remove a page from the layout.
6459 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
6460 var i
, len
, name
, page
,
6463 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
6465 name
= page
.getName();
6466 delete this.pages
[name
];
6467 if ( this.outlined
) {
6468 items
.push( this.outlineWidget
.getItemFromData( name
) );
6469 page
.setOutlineItem( null );
6472 if ( this.outlined
&& items
.length
) {
6473 this.outlineWidget
.removeItems( items
);
6474 this.updateOutlineWidget();
6476 this.stackLayout
.removeItems( pages
);
6477 this.emit( 'remove', pages
);
6483 * Clear all pages from the layout.
6488 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
6490 pages
= this.stackLayout
.getItems();
6493 this.currentPageName
= null;
6494 if ( this.outlined
) {
6495 this.outlineWidget
.clearItems();
6496 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
6497 pages
[i
].setOutlineItem( null );
6500 this.stackLayout
.clearItems();
6502 this.emit( 'remove', pages
);
6508 * Set the current page by name.
6511 * @param {string} name Symbolic name of page
6513 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
6516 page
= this.pages
[name
];
6518 if ( name
!== this.currentPageName
) {
6519 if ( this.outlined
) {
6520 selectedItem
= this.outlineWidget
.getSelectedItem();
6521 if ( selectedItem
&& selectedItem
.getData() !== name
) {
6522 this.outlineWidget
.selectItem( this.outlineWidget
.getItemFromData( name
) );
6526 if ( this.currentPageName
&& this.pages
[this.currentPageName
] ) {
6527 this.pages
[this.currentPageName
].setActive( false );
6528 // Blur anything focused if the next page doesn't have anything focusable - this
6529 // is not needed if the next page has something focusable because once it is focused
6530 // this blur happens automatically
6531 if ( this.autoFocus
&& !page
.$element
.find( ':input' ).length
) {
6532 $focused
= this.pages
[this.currentPageName
].$element
.find( ':focus' );
6533 if ( $focused
.length
) {
6538 this.currentPageName
= name
;
6539 this.stackLayout
.setItem( page
);
6540 page
.setActive( true );
6541 this.emit( 'set', page
);
6547 * Call this after adding or removing items from the OutlineWidget.
6551 OO
.ui
.BookletLayout
.prototype.updateOutlineWidget = function () {
6552 // Auto-select first item when nothing is selected anymore
6553 if ( !this.outlineWidget
.getSelectedItem() ) {
6554 this.outlineWidget
.selectItem( this.outlineWidget
.getFirstSelectableItem() );
6561 * Layout made of a field and optional label.
6564 * @extends OO.ui.Layout
6565 * @mixins OO.ui.LabelElement
6567 * Available label alignment modes include:
6568 * - left: Label is before the field and aligned away from it, best for when the user will be
6569 * scanning for a specific label in a form with many fields
6570 * - right: Label is before the field and aligned toward it, best for forms the user is very
6571 * familiar with and will tab through field checking quickly to verify which field they are in
6572 * - top: Label is before the field and above it, best for when the use will need to fill out all
6573 * fields from top to bottom in a form with few fields
6574 * - inline: Label is after the field and aligned toward it, best for small boolean fields like
6575 * checkboxes or radio buttons
6578 * @param {OO.ui.Widget} field Field widget
6579 * @param {Object} [config] Configuration options
6580 * @cfg {string} [align='left'] Alignment mode, either 'left', 'right', 'top' or 'inline'
6581 * @cfg {string} [help] Explanatory text shown as a '?' icon.
6583 OO
.ui
.FieldLayout
= function OoUiFieldLayout( field
, config
) {
6584 // Config initialization
6585 config
= $.extend( { align
: 'left' }, config
);
6587 // Parent constructor
6588 OO
.ui
.FieldLayout
.super.call( this, config
);
6590 // Mixin constructors
6591 OO
.ui
.LabelElement
.call( this, config
);
6594 this.$field
= this.$( '<div>' );
6597 if ( config
.help
) {
6598 this.popupButtonWidget
= new OO
.ui
.PopupButtonWidget( {
6600 classes
: [ 'oo-ui-fieldLayout-help' ],
6605 this.popupButtonWidget
.getPopup().$body
.append(
6607 .text( config
.help
)
6608 .addClass( 'oo-ui-fieldLayout-help-content' )
6610 this.$help
= this.popupButtonWidget
.$element
;
6612 this.$help
= this.$( [] );
6616 if ( this.field
instanceof OO
.ui
.InputWidget
) {
6617 this.$label
.on( 'click', OO
.ui
.bind( this.onLabelClick
, this ) );
6619 this.field
.connect( this, { disable
: 'onFieldDisable' } );
6622 this.$element
.addClass( 'oo-ui-fieldLayout' );
6624 .addClass( 'oo-ui-fieldLayout-field' )
6625 .toggleClass( 'oo-ui-fieldLayout-disable', this.field
.isDisabled() )
6626 .append( this.field
.$element
);
6627 this.setAlignment( config
.align
);
6632 OO
.inheritClass( OO
.ui
.FieldLayout
, OO
.ui
.Layout
);
6633 OO
.mixinClass( OO
.ui
.FieldLayout
, OO
.ui
.LabelElement
);
6638 * Handle field disable events.
6640 * @param {boolean} value Field is disabled
6642 OO
.ui
.FieldLayout
.prototype.onFieldDisable = function ( value
) {
6643 this.$element
.toggleClass( 'oo-ui-fieldLayout-disabled', value
);
6647 * Handle label mouse click events.
6649 * @param {jQuery.Event} e Mouse click event
6651 OO
.ui
.FieldLayout
.prototype.onLabelClick = function () {
6652 this.field
.simulateLabelClick();
6659 * @return {OO.ui.Widget} Field widget
6661 OO
.ui
.FieldLayout
.prototype.getField = function () {
6666 * Set the field alignment mode.
6668 * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
6671 OO
.ui
.FieldLayout
.prototype.setAlignment = function ( value
) {
6672 if ( value
!== this.align
) {
6673 // Default to 'left'
6674 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value
) === -1 ) {
6678 if ( value
=== 'inline' ) {
6679 this.$element
.append( this.$field
, this.$label
, this.$help
);
6681 this.$element
.append( this.$help
, this.$label
, this.$field
);
6685 this.$element
.removeClass( 'oo-ui-fieldLayout-align-' + this.align
);
6688 // The following classes can be used here:
6689 // oo-ui-fieldLayout-align-left
6690 // oo-ui-fieldLayout-align-right
6691 // oo-ui-fieldLayout-align-top
6692 // oo-ui-fieldLayout-align-inline
6693 this.$element
.addClass( 'oo-ui-fieldLayout-align-' + this.align
);
6700 * Layout made of a fieldset and optional legend.
6702 * Just add OO.ui.FieldLayout items.
6705 * @extends OO.ui.Layout
6706 * @mixins OO.ui.LabelElement
6707 * @mixins OO.ui.IconElement
6708 * @mixins OO.ui.GroupElement
6711 * @param {Object} [config] Configuration options
6712 * @cfg {string} [icon] Symbolic icon name
6713 * @cfg {OO.ui.FieldLayout[]} [items] Items to add
6715 OO
.ui
.FieldsetLayout
= function OoUiFieldsetLayout( config
) {
6716 // Config initialization
6717 config
= config
|| {};
6719 // Parent constructor
6720 OO
.ui
.FieldsetLayout
.super.call( this, config
);
6722 // Mixin constructors
6723 OO
.ui
.IconElement
.call( this, config
);
6724 OO
.ui
.LabelElement
.call( this, config
);
6725 OO
.ui
.GroupElement
.call( this, config
);
6729 .addClass( 'oo-ui-fieldsetLayout' )
6730 .prepend( this.$icon
, this.$label
, this.$group
);
6731 if ( $.isArray( config
.items
) ) {
6732 this.addItems( config
.items
);
6738 OO
.inheritClass( OO
.ui
.FieldsetLayout
, OO
.ui
.Layout
);
6739 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.IconElement
);
6740 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.LabelElement
);
6741 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.GroupElement
);
6743 /* Static Properties */
6745 OO
.ui
.FieldsetLayout
.static.tagName
= 'div';
6748 * Layout with an HTML form.
6751 * @extends OO.ui.Layout
6754 * @param {Object} [config] Configuration options
6756 OO
.ui
.FormLayout
= function OoUiFormLayout( config
) {
6757 // Configuration initialization
6758 config
= config
|| {};
6760 // Parent constructor
6761 OO
.ui
.FormLayout
.super.call( this, config
);
6764 this.$element
.on( 'submit', OO
.ui
.bind( this.onFormSubmit
, this ) );
6767 this.$element
.addClass( 'oo-ui-formLayout' );
6772 OO
.inheritClass( OO
.ui
.FormLayout
, OO
.ui
.Layout
);
6780 /* Static Properties */
6782 OO
.ui
.FormLayout
.static.tagName
= 'form';
6787 * Handle form submit events.
6789 * @param {jQuery.Event} e Submit event
6792 OO
.ui
.FormLayout
.prototype.onFormSubmit = function () {
6793 this.emit( 'submit' );
6798 * Layout made of proportionally sized columns and rows.
6801 * @extends OO.ui.Layout
6804 * @param {OO.ui.PanelLayout[]} panels Panels in the grid
6805 * @param {Object} [config] Configuration options
6806 * @cfg {number[]} [widths] Widths of columns as ratios
6807 * @cfg {number[]} [heights] Heights of columns as ratios
6809 OO
.ui
.GridLayout
= function OoUiGridLayout( panels
, config
) {
6812 // Config initialization
6813 config
= config
|| {};
6815 // Parent constructor
6816 OO
.ui
.GridLayout
.super.call( this, config
);
6824 this.$element
.addClass( 'oo-ui-gridLayout' );
6825 for ( i
= 0, len
= panels
.length
; i
< len
; i
++ ) {
6826 this.panels
.push( panels
[i
] );
6827 this.$element
.append( panels
[i
].$element
);
6829 if ( config
.widths
|| config
.heights
) {
6830 this.layout( config
.widths
|| [ 1 ], config
.heights
|| [ 1 ] );
6832 // Arrange in columns by default
6834 for ( i
= 0, len
= this.panels
.length
; i
< len
; i
++ ) {
6837 this.layout( widths
, [ 1 ] );
6843 OO
.inheritClass( OO
.ui
.GridLayout
, OO
.ui
.Layout
);
6855 /* Static Properties */
6857 OO
.ui
.GridLayout
.static.tagName
= 'div';
6862 * Set grid dimensions.
6864 * @param {number[]} widths Widths of columns as ratios
6865 * @param {number[]} heights Heights of rows as ratios
6867 * @throws {Error} If grid is not large enough to fit all panels
6869 OO
.ui
.GridLayout
.prototype.layout = function ( widths
, heights
) {
6873 cols
= widths
.length
,
6874 rows
= heights
.length
;
6876 // Verify grid is big enough to fit panels
6877 if ( cols
* rows
< this.panels
.length
) {
6878 throw new Error( 'Grid is not large enough to fit ' + this.panels
.length
+ 'panels' );
6881 // Sum up denominators
6882 for ( x
= 0; x
< cols
; x
++ ) {
6885 for ( y
= 0; y
< rows
; y
++ ) {
6891 for ( x
= 0; x
< cols
; x
++ ) {
6892 this.widths
[x
] = widths
[x
] / xd
;
6894 for ( y
= 0; y
< rows
; y
++ ) {
6895 this.heights
[y
] = heights
[y
] / yd
;
6899 this.emit( 'layout' );
6903 * Update panel positions and sizes.
6907 OO
.ui
.GridLayout
.prototype.update = function () {
6915 cols
= this.widths
.length
,
6916 rows
= this.heights
.length
;
6918 for ( y
= 0; y
< rows
; y
++ ) {
6919 height
= this.heights
[y
];
6920 for ( x
= 0; x
< cols
; x
++ ) {
6921 panel
= this.panels
[i
];
6922 width
= this.widths
[x
];
6924 width
: Math
.round( width
* 100 ) + '%',
6925 height
: Math
.round( height
* 100 ) + '%',
6926 top
: Math
.round( top
* 100 ) + '%',
6927 // HACK: Work around IE bug by setting visibility: hidden; if width or height is zero
6928 visibility
: width
=== 0 || height
=== 0 ? 'hidden' : ''
6931 if ( OO
.ui
.Element
.getDir( this.$.context
) === 'rtl' ) {
6932 dimensions
.right
= Math
.round( left
* 100 ) + '%';
6934 dimensions
.left
= Math
.round( left
* 100 ) + '%';
6936 panel
.$element
.css( dimensions
);
6944 this.emit( 'update' );
6948 * Get a panel at a given position.
6950 * The x and y position is affected by the current grid layout.
6952 * @param {number} x Horizontal position
6953 * @param {number} y Vertical position
6954 * @return {OO.ui.PanelLayout} The panel at the given postion
6956 OO
.ui
.GridLayout
.prototype.getPanel = function ( x
, y
) {
6957 return this.panels
[( x
* this.widths
.length
) + y
];
6961 * Layout that expands to cover the entire area of its parent, with optional scrolling and padding.
6964 * @extends OO.ui.Layout
6967 * @param {Object} [config] Configuration options
6968 * @cfg {boolean} [scrollable=false] Allow vertical scrolling
6969 * @cfg {boolean} [padded=false] Pad the content from the edges
6970 * @cfg {boolean} [expanded=true] Expand size to fill the entire parent element
6972 OO
.ui
.PanelLayout
= function OoUiPanelLayout( config
) {
6973 // Config initialization
6974 config
= config
|| {};
6976 // Parent constructor
6977 OO
.ui
.PanelLayout
.super.call( this, config
);
6980 this.$element
.addClass( 'oo-ui-panelLayout' );
6981 if ( config
.scrollable
) {
6982 this.$element
.addClass( 'oo-ui-panelLayout-scrollable' );
6985 if ( config
.padded
) {
6986 this.$element
.addClass( 'oo-ui-panelLayout-padded' );
6989 if ( config
.expanded
=== undefined || config
.expanded
) {
6990 this.$element
.addClass( 'oo-ui-panelLayout-expanded' );
6996 OO
.inheritClass( OO
.ui
.PanelLayout
, OO
.ui
.Layout
);
6999 * Page within an booklet layout.
7002 * @extends OO.ui.PanelLayout
7005 * @param {string} name Unique symbolic name of page
7006 * @param {Object} [config] Configuration options
7007 * @param {string} [outlineItem] Outline item widget
7009 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
7010 // Configuration initialization
7011 config
= $.extend( { scrollable
: true }, config
);
7013 // Parent constructor
7014 OO
.ui
.PageLayout
.super.call( this, config
);
7018 this.outlineItem
= config
.outlineItem
|| null;
7019 this.active
= false;
7022 this.$element
.addClass( 'oo-ui-pageLayout' );
7027 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
7033 * @param {boolean} active Page is active
7041 * @return {string} Symbolic name of page
7043 OO
.ui
.PageLayout
.prototype.getName = function () {
7048 * Check if page is active.
7050 * @return {boolean} Page is active
7052 OO
.ui
.PageLayout
.prototype.isActive = function () {
7059 * @return {OO.ui.OutlineItemWidget|null} Outline item widget
7061 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
7062 return this.outlineItem
;
7068 * @localdoc Subclasses should override #setupOutlineItem instead of this method to adjust the
7069 * outline item as desired; this method is called for setting (with an object) and unsetting
7070 * (with null) and overriding methods would have to check the value of `outlineItem` to avoid
7071 * operating on null instead of an OO.ui.OutlineItemWidget object.
7073 * @param {OO.ui.OutlineItemWidget|null} outlineItem Outline item widget, null to clear
7076 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
7077 this.outlineItem
= outlineItem
|| null;
7078 if ( outlineItem
) {
7079 this.setupOutlineItem();
7085 * Setup outline item.
7087 * @localdoc Subclasses should override this method to adjust the outline item as desired.
7089 * @param {OO.ui.OutlineItemWidget} outlineItem Outline item widget to setup
7092 OO
.ui
.PageLayout
.prototype.setupOutlineItem = function () {
7097 * Set page active state.
7099 * @param {boolean} Page is active
7102 OO
.ui
.PageLayout
.prototype.setActive = function ( active
) {
7105 if ( active
!== this.active
) {
7106 this.active
= active
;
7107 this.$element
.toggleClass( 'oo-ui-pageLayout-active', active
);
7108 this.emit( 'active', this.active
);
7113 * Layout containing a series of mutually exclusive pages.
7116 * @extends OO.ui.PanelLayout
7117 * @mixins OO.ui.GroupElement
7120 * @param {Object} [config] Configuration options
7121 * @cfg {boolean} [continuous=false] Show all pages, one after another
7122 * @cfg {string} [icon=''] Symbolic icon name
7123 * @cfg {OO.ui.Layout[]} [items] Layouts to add
7125 OO
.ui
.StackLayout
= function OoUiStackLayout( config
) {
7126 // Config initialization
7127 config
= $.extend( { scrollable
: true }, config
);
7129 // Parent constructor
7130 OO
.ui
.StackLayout
.super.call( this, config
);
7132 // Mixin constructors
7133 OO
.ui
.GroupElement
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
7136 this.currentItem
= null;
7137 this.continuous
= !!config
.continuous
;
7140 this.$element
.addClass( 'oo-ui-stackLayout' );
7141 if ( this.continuous
) {
7142 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
7144 if ( $.isArray( config
.items
) ) {
7145 this.addItems( config
.items
);
7151 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
7152 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.GroupElement
);
7158 * @param {OO.ui.Layout|null} item Current item or null if there is no longer a layout shown
7164 * Get the current item.
7166 * @return {OO.ui.Layout|null}
7168 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
7169 return this.currentItem
;
7173 * Unset the current item.
7176 * @param {OO.ui.StackLayout} layout
7179 OO
.ui
.StackLayout
.prototype.unsetCurrentItem = function () {
7180 var prevItem
= this.currentItem
;
7181 if ( prevItem
=== null ) {
7185 this.currentItem
= null;
7186 this.emit( 'set', null );
7192 * Adding an existing item (by value) will move it.
7194 * @param {OO.ui.Layout[]} items Items to add
7195 * @param {number} [index] Index to insert items after
7198 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
7200 OO
.ui
.GroupElement
.prototype.addItems
.call( this, items
, index
);
7202 if ( !this.currentItem
&& items
.length
) {
7203 this.setItem( items
[0] );
7212 * Items will be detached, not removed, so they can be used later.
7214 * @param {OO.ui.Layout[]} items Items to remove
7218 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
7220 OO
.ui
.GroupElement
.prototype.removeItems
.call( this, items
);
7222 if ( $.inArray( this.currentItem
, items
) !== -1 ) {
7223 if ( this.items
.length
) {
7224 this.setItem( this.items
[0] );
7226 this.unsetCurrentItem();
7236 * Items will be detached, not removed, so they can be used later.
7241 OO
.ui
.StackLayout
.prototype.clearItems = function () {
7242 this.unsetCurrentItem();
7243 OO
.ui
.GroupElement
.prototype.clearItems
.call( this );
7251 * Any currently shown item will be hidden.
7253 * FIXME: If the passed item to show has not been added in the items list, then
7254 * this method drops it and unsets the current item.
7256 * @param {OO.ui.Layout} item Item to show
7260 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
7263 if ( item
!== this.currentItem
) {
7264 if ( !this.continuous
) {
7265 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
7266 this.items
[i
].$element
.css( 'display', '' );
7269 if ( $.inArray( item
, this.items
) !== -1 ) {
7270 if ( !this.continuous
) {
7271 item
.$element
.css( 'display', 'block' );
7273 this.currentItem
= item
;
7274 this.emit( 'set', item
);
7276 this.unsetCurrentItem();
7284 * Horizontal bar layout of tools as icon buttons.
7287 * @extends OO.ui.ToolGroup
7290 * @param {OO.ui.Toolbar} toolbar
7291 * @param {Object} [config] Configuration options
7293 OO
.ui
.BarToolGroup
= function OoUiBarToolGroup( toolbar
, config
) {
7294 // Parent constructor
7295 OO
.ui
.BarToolGroup
.super.call( this, toolbar
, config
);
7298 this.$element
.addClass( 'oo-ui-barToolGroup' );
7303 OO
.inheritClass( OO
.ui
.BarToolGroup
, OO
.ui
.ToolGroup
);
7305 /* Static Properties */
7307 OO
.ui
.BarToolGroup
.static.titleTooltips
= true;
7309 OO
.ui
.BarToolGroup
.static.accelTooltips
= true;
7311 OO
.ui
.BarToolGroup
.static.name
= 'bar';
7314 * Popup list of tools with an icon and optional label.
7318 * @extends OO.ui.ToolGroup
7319 * @mixins OO.ui.IconElement
7320 * @mixins OO.ui.IndicatorElement
7321 * @mixins OO.ui.LabelElement
7322 * @mixins OO.ui.TitledElement
7323 * @mixins OO.ui.ClippableElement
7326 * @param {OO.ui.Toolbar} toolbar
7327 * @param {Object} [config] Configuration options
7328 * @cfg {string} [header] Text to display at the top of the pop-up
7330 OO
.ui
.PopupToolGroup
= function OoUiPopupToolGroup( toolbar
, config
) {
7331 // Configuration initialization
7332 config
= config
|| {};
7334 // Parent constructor
7335 OO
.ui
.PopupToolGroup
.super.call( this, toolbar
, config
);
7337 // Mixin constructors
7338 OO
.ui
.IconElement
.call( this, config
);
7339 OO
.ui
.IndicatorElement
.call( this, config
);
7340 OO
.ui
.LabelElement
.call( this, config
);
7341 OO
.ui
.TitledElement
.call( this, config
);
7342 OO
.ui
.ClippableElement
.call( this, $.extend( {}, config
, { $clippable
: this.$group
} ) );
7345 this.active
= false;
7346 this.dragging
= false;
7347 this.onBlurHandler
= OO
.ui
.bind( this.onBlur
, this );
7348 this.$handle
= this.$( '<span>' );
7352 'mousedown touchstart': OO
.ui
.bind( this.onHandlePointerDown
, this ),
7353 'mouseup touchend': OO
.ui
.bind( this.onHandlePointerUp
, this )
7358 .addClass( 'oo-ui-popupToolGroup-handle' )
7359 .append( this.$icon
, this.$label
, this.$indicator
);
7360 // If the pop-up should have a header, add it to the top of the toolGroup.
7361 // Note: If this feature is useful for other widgets, we could abstract it into an
7362 // OO.ui.HeaderedElement mixin constructor.
7363 if ( config
.header
!== undefined ) {
7365 .prepend( this.$( '<span>' )
7366 .addClass( 'oo-ui-popupToolGroup-header' )
7367 .text( config
.header
)
7371 .addClass( 'oo-ui-popupToolGroup' )
7372 .prepend( this.$handle
);
7377 OO
.inheritClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ToolGroup
);
7378 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IconElement
);
7379 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IndicatorElement
);
7380 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.LabelElement
);
7381 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.TitledElement
);
7382 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ClippableElement
);
7384 /* Static Properties */
7391 OO
.ui
.PopupToolGroup
.prototype.setDisabled = function () {
7393 OO
.ui
.PopupToolGroup
.super.prototype.setDisabled
.apply( this, arguments
);
7395 if ( this.isDisabled() && this.isElementAttached() ) {
7396 this.setActive( false );
7401 * Handle focus being lost.
7403 * The event is actually generated from a mouseup, so it is not a normal blur event object.
7405 * @param {jQuery.Event} e Mouse up event
7407 OO
.ui
.PopupToolGroup
.prototype.onBlur = function ( e
) {
7408 // Only deactivate when clicking outside the dropdown element
7409 if ( this.$( e
.target
).closest( '.oo-ui-popupToolGroup' )[0] !== this.$element
[0] ) {
7410 this.setActive( false );
7417 OO
.ui
.PopupToolGroup
.prototype.onPointerUp = function ( e
) {
7418 // e.which is 0 for touch events, 1 for left mouse button
7419 if ( !this.isDisabled() && e
.which
<= 1 ) {
7420 this.setActive( false );
7422 return OO
.ui
.PopupToolGroup
.super.prototype.onPointerUp
.call( this, e
);
7426 * Handle mouse up events.
7428 * @param {jQuery.Event} e Mouse up event
7430 OO
.ui
.PopupToolGroup
.prototype.onHandlePointerUp = function () {
7435 * Handle mouse down events.
7437 * @param {jQuery.Event} e Mouse down event
7439 OO
.ui
.PopupToolGroup
.prototype.onHandlePointerDown = function ( e
) {
7440 // e.which is 0 for touch events, 1 for left mouse button
7441 if ( !this.isDisabled() && e
.which
<= 1 ) {
7442 this.setActive( !this.active
);
7448 * Switch into active mode.
7450 * When active, mouseup events anywhere in the document will trigger deactivation.
7452 OO
.ui
.PopupToolGroup
.prototype.setActive = function ( value
) {
7454 if ( this.active
!== value
) {
7455 this.active
= value
;
7457 this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler
, true );
7459 // Try anchoring the popup to the left first
7460 this.$element
.addClass( 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left' );
7461 this.toggleClipping( true );
7462 if ( this.isClippedHorizontally() ) {
7463 // Anchoring to the left caused the popup to clip, so anchor it to the right instead
7464 this.toggleClipping( false );
7466 .removeClass( 'oo-ui-popupToolGroup-left' )
7467 .addClass( 'oo-ui-popupToolGroup-right' );
7468 this.toggleClipping( true );
7471 this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler
, true );
7472 this.$element
.removeClass(
7473 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left oo-ui-popupToolGroup-right'
7475 this.toggleClipping( false );
7481 * Drop down list layout of tools as labeled icon buttons.
7484 * @extends OO.ui.PopupToolGroup
7487 * @param {OO.ui.Toolbar} toolbar
7488 * @param {Object} [config] Configuration options
7490 OO
.ui
.ListToolGroup
= function OoUiListToolGroup( toolbar
, config
) {
7491 // Parent constructor
7492 OO
.ui
.ListToolGroup
.super.call( this, toolbar
, config
);
7495 this.$element
.addClass( 'oo-ui-listToolGroup' );
7500 OO
.inheritClass( OO
.ui
.ListToolGroup
, OO
.ui
.PopupToolGroup
);
7502 /* Static Properties */
7504 OO
.ui
.ListToolGroup
.static.accelTooltips
= true;
7506 OO
.ui
.ListToolGroup
.static.name
= 'list';
7509 * Drop down menu layout of tools as selectable menu items.
7512 * @extends OO.ui.PopupToolGroup
7515 * @param {OO.ui.Toolbar} toolbar
7516 * @param {Object} [config] Configuration options
7518 OO
.ui
.MenuToolGroup
= function OoUiMenuToolGroup( toolbar
, config
) {
7519 // Configuration initialization
7520 config
= config
|| {};
7522 // Parent constructor
7523 OO
.ui
.MenuToolGroup
.super.call( this, toolbar
, config
);
7526 this.toolbar
.connect( this, { updateState
: 'onUpdateState' } );
7529 this.$element
.addClass( 'oo-ui-menuToolGroup' );
7534 OO
.inheritClass( OO
.ui
.MenuToolGroup
, OO
.ui
.PopupToolGroup
);
7536 /* Static Properties */
7538 OO
.ui
.MenuToolGroup
.static.accelTooltips
= true;
7540 OO
.ui
.MenuToolGroup
.static.name
= 'menu';
7545 * Handle the toolbar state being updated.
7547 * When the state changes, the title of each active item in the menu will be joined together and
7548 * used as a label for the group. The label will be empty if none of the items are active.
7550 OO
.ui
.MenuToolGroup
.prototype.onUpdateState = function () {
7554 for ( name
in this.tools
) {
7555 if ( this.tools
[name
].isActive() ) {
7556 labelTexts
.push( this.tools
[name
].getTitle() );
7560 this.setLabel( labelTexts
.join( ', ' ) || ' ' );
7564 * Tool that shows a popup when selected.
7568 * @extends OO.ui.Tool
7569 * @mixins OO.ui.PopupElement
7572 * @param {OO.ui.Toolbar} toolbar
7573 * @param {Object} [config] Configuration options
7575 OO
.ui
.PopupTool
= function OoUiPopupTool( toolbar
, config
) {
7576 // Parent constructor
7577 OO
.ui
.PopupTool
.super.call( this, toolbar
, config
);
7579 // Mixin constructors
7580 OO
.ui
.PopupElement
.call( this, config
);
7584 .addClass( 'oo-ui-popupTool' )
7585 .append( this.popup
.$element
);
7590 OO
.inheritClass( OO
.ui
.PopupTool
, OO
.ui
.Tool
);
7591 OO
.mixinClass( OO
.ui
.PopupTool
, OO
.ui
.PopupElement
);
7596 * Handle the tool being selected.
7600 OO
.ui
.PopupTool
.prototype.onSelect = function () {
7601 if ( !this.isDisabled() ) {
7602 this.popup
.toggle();
7604 this.setActive( false );
7609 * Handle the toolbar state being updated.
7613 OO
.ui
.PopupTool
.prototype.onUpdateState = function () {
7614 this.setActive( false );
7618 * Mixin for OO.ui.Widget subclasses to provide OO.ui.GroupElement.
7620 * Use together with OO.ui.ItemWidget to make disabled state inheritable.
7624 * @extends OO.ui.GroupElement
7627 * @param {Object} [config] Configuration options
7629 OO
.ui
.GroupWidget
= function OoUiGroupWidget( config
) {
7630 // Parent constructor
7631 OO
.ui
.GroupWidget
.super.call( this, config
);
7636 OO
.inheritClass( OO
.ui
.GroupWidget
, OO
.ui
.GroupElement
);
7641 * Set the disabled state of the widget.
7643 * This will also update the disabled state of child widgets.
7645 * @param {boolean} disabled Disable widget
7648 OO
.ui
.GroupWidget
.prototype.setDisabled = function ( disabled
) {
7652 // Note: Calling #setDisabled this way assumes this is mixed into an OO.ui.Widget
7653 OO
.ui
.Widget
.prototype.setDisabled
.call( this, disabled
);
7655 // During construction, #setDisabled is called before the OO.ui.GroupElement constructor
7657 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
7658 this.items
[i
].updateDisabled();
7666 * Mixin for widgets used as items in widgets that inherit OO.ui.GroupWidget.
7668 * Item widgets have a reference to a OO.ui.GroupWidget while they are attached to the group. This
7669 * allows bidrectional communication.
7671 * Use together with OO.ui.GroupWidget to make disabled state inheritable.
7678 OO
.ui
.ItemWidget
= function OoUiItemWidget() {
7685 * Check if widget is disabled.
7687 * Checks parent if present, making disabled state inheritable.
7689 * @return {boolean} Widget is disabled
7691 OO
.ui
.ItemWidget
.prototype.isDisabled = function () {
7692 return this.disabled
||
7693 ( this.elementGroup
instanceof OO
.ui
.Widget
&& this.elementGroup
.isDisabled() );
7697 * Set group element is in.
7699 * @param {OO.ui.GroupElement|null} group Group element, null if none
7702 OO
.ui
.ItemWidget
.prototype.setElementGroup = function ( group
) {
7704 // Note: Calling #setElementGroup this way assumes this is mixed into an OO.ui.Element
7705 OO
.ui
.Element
.prototype.setElementGroup
.call( this, group
);
7707 // Initialize item disabled states
7708 this.updateDisabled();
7714 * Mixin that adds a menu showing suggested values for a text input.
7716 * Subclasses must handle `select` and `choose` events on #lookupMenu to make use of selections.
7722 * @param {OO.ui.TextInputWidget} input Input widget
7723 * @param {Object} [config] Configuration options
7724 * @cfg {jQuery} [$overlay=this.$( 'body, .oo-ui-window-overlay' ).last()] Overlay layer
7726 OO
.ui
.LookupInputWidget
= function OoUiLookupInputWidget( input
, config
) {
7727 // Config intialization
7728 config
= config
|| {};
7731 this.lookupInput
= input
;
7732 this.$overlay
= config
.$overlay
|| this.$( 'body, .oo-ui-window-overlay' ).last();
7733 this.lookupMenu
= new OO
.ui
.TextInputMenuWidget( this, {
7734 $: OO
.ui
.Element
.getJQuery( this.$overlay
),
7735 input
: this.lookupInput
,
7736 $container
: config
.$container
7738 this.lookupCache
= {};
7739 this.lookupQuery
= null;
7740 this.lookupRequest
= null;
7741 this.populating
= false;
7744 this.$overlay
.append( this.lookupMenu
.$element
);
7746 this.lookupInput
.$input
.on( {
7747 focus
: OO
.ui
.bind( this.onLookupInputFocus
, this ),
7748 blur
: OO
.ui
.bind( this.onLookupInputBlur
, this ),
7749 mousedown
: OO
.ui
.bind( this.onLookupInputMouseDown
, this )
7751 this.lookupInput
.connect( this, { change
: 'onLookupInputChange' } );
7754 this.$element
.addClass( 'oo-ui-lookupWidget' );
7755 this.lookupMenu
.$element
.addClass( 'oo-ui-lookupWidget-menu' );
7761 * Handle input focus event.
7763 * @param {jQuery.Event} e Input focus event
7765 OO
.ui
.LookupInputWidget
.prototype.onLookupInputFocus = function () {
7766 this.openLookupMenu();
7770 * Handle input blur event.
7772 * @param {jQuery.Event} e Input blur event
7774 OO
.ui
.LookupInputWidget
.prototype.onLookupInputBlur = function () {
7775 this.lookupMenu
.toggle( false );
7779 * Handle input mouse down event.
7781 * @param {jQuery.Event} e Input mouse down event
7783 OO
.ui
.LookupInputWidget
.prototype.onLookupInputMouseDown = function () {
7784 this.openLookupMenu();
7788 * Handle input change event.
7790 * @param {string} value New input value
7792 OO
.ui
.LookupInputWidget
.prototype.onLookupInputChange = function () {
7793 this.openLookupMenu();
7799 * @return {OO.ui.TextInputMenuWidget}
7801 OO
.ui
.LookupInputWidget
.prototype.getLookupMenu = function () {
7802 return this.lookupMenu
;
7810 OO
.ui
.LookupInputWidget
.prototype.openLookupMenu = function () {
7811 var value
= this.lookupInput
.getValue();
7813 if ( this.lookupMenu
.$input
.is( ':focus' ) && $.trim( value
) !== '' ) {
7814 this.populateLookupMenu();
7815 this.lookupMenu
.toggle( true );
7826 * Populate lookup menu with current information.
7830 OO
.ui
.LookupInputWidget
.prototype.populateLookupMenu = function () {
7833 if ( !this.populating
) {
7834 this.populating
= true;
7835 this.getLookupMenuItems()
7836 .done( function ( items
) {
7837 widget
.lookupMenu
.clearItems();
7838 if ( items
.length
) {
7842 widget
.initializeLookupMenuSelection();
7843 widget
.openLookupMenu();
7845 widget
.lookupMenu
.toggle( true );
7847 widget
.populating
= false;
7849 .fail( function () {
7850 widget
.lookupMenu
.clearItems();
7851 widget
.populating
= false;
7859 * Set selection in the lookup menu with current information.
7863 OO
.ui
.LookupInputWidget
.prototype.initializeLookupMenuSelection = function () {
7864 if ( !this.lookupMenu
.getSelectedItem() ) {
7865 this.lookupMenu
.selectItem( this.lookupMenu
.getFirstSelectableItem() );
7867 this.lookupMenu
.highlightItem( this.lookupMenu
.getSelectedItem() );
7871 * Get lookup menu items for the current query.
7873 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument
7876 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItems = function () {
7878 value
= this.lookupInput
.getValue(),
7879 deferred
= $.Deferred();
7881 if ( value
&& value
!== this.lookupQuery
) {
7882 // Abort current request if query has changed
7883 if ( this.lookupRequest
) {
7884 this.lookupRequest
.abort();
7885 this.lookupQuery
= null;
7886 this.lookupRequest
= null;
7888 if ( value
in this.lookupCache
) {
7889 deferred
.resolve( this.getLookupMenuItemsFromData( this.lookupCache
[value
] ) );
7891 this.lookupQuery
= value
;
7892 this.lookupRequest
= this.getLookupRequest()
7893 .always( function () {
7894 widget
.lookupQuery
= null;
7895 widget
.lookupRequest
= null;
7897 .done( function ( data
) {
7898 widget
.lookupCache
[value
] = widget
.getLookupCacheItemFromData( data
);
7899 deferred
.resolve( widget
.getLookupMenuItemsFromData( widget
.lookupCache
[value
] ) );
7901 .fail( function () {
7905 this.lookupRequest
.always( function () {
7906 widget
.popPending();
7910 return deferred
.promise();
7914 * Get a new request object of the current lookup query value.
7917 * @return {jqXHR} jQuery AJAX object, or promise object with an .abort() method
7919 OO
.ui
.LookupInputWidget
.prototype.getLookupRequest = function () {
7920 // Stub, implemented in subclass
7925 * Handle successful lookup request.
7927 * Overriding methods should call #populateLookupMenu when results are available and cache results
7928 * for future lookups in #lookupCache as an array of #OO.ui.MenuItemWidget objects.
7931 * @param {Mixed} data Response from server
7933 OO
.ui
.LookupInputWidget
.prototype.onLookupRequestDone = function () {
7934 // Stub, implemented in subclass
7938 * Get a list of menu item widgets from the data stored by the lookup request's done handler.
7941 * @param {Mixed} data Cached result data, usually an array
7942 * @return {OO.ui.MenuItemWidget[]} Menu items
7944 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItemsFromData = function () {
7945 // Stub, implemented in subclass
7950 * Set of controls for an OO.ui.OutlineWidget.
7952 * Controls include moving items up and down, removing items, and adding different kinds of items.
7955 * @extends OO.ui.Widget
7956 * @mixins OO.ui.GroupElement
7957 * @mixins OO.ui.IconElement
7960 * @param {OO.ui.OutlineWidget} outline Outline to control
7961 * @param {Object} [config] Configuration options
7963 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
7964 // Configuration initialization
7965 config
= $.extend( { icon
: 'add' }, config
);
7967 // Parent constructor
7968 OO
.ui
.OutlineControlsWidget
.super.call( this, config
);
7970 // Mixin constructors
7971 OO
.ui
.GroupElement
.call( this, config
);
7972 OO
.ui
.IconElement
.call( this, config
);
7975 this.outline
= outline
;
7976 this.$movers
= this.$( '<div>' );
7977 this.upButton
= new OO
.ui
.ButtonWidget( {
7981 title
: OO
.ui
.msg( 'ooui-outline-control-move-up' )
7983 this.downButton
= new OO
.ui
.ButtonWidget( {
7987 title
: OO
.ui
.msg( 'ooui-outline-control-move-down' )
7989 this.removeButton
= new OO
.ui
.ButtonWidget( {
7993 title
: OO
.ui
.msg( 'ooui-outline-control-remove' )
7997 outline
.connect( this, {
7998 select
: 'onOutlineChange',
7999 add
: 'onOutlineChange',
8000 remove
: 'onOutlineChange'
8002 this.upButton
.connect( this, { click
: [ 'emit', 'move', -1 ] } );
8003 this.downButton
.connect( this, { click
: [ 'emit', 'move', 1 ] } );
8004 this.removeButton
.connect( this, { click
: [ 'emit', 'remove' ] } );
8007 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
8008 this.$group
.addClass( 'oo-ui-outlineControlsWidget-items' );
8010 .addClass( 'oo-ui-outlineControlsWidget-movers' )
8011 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
8012 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
8017 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
8018 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.GroupElement
);
8019 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.IconElement
);
8025 * @param {number} places Number of places to move
8035 * Handle outline change events.
8037 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
8038 var i
, len
, firstMovable
, lastMovable
,
8039 items
= this.outline
.getItems(),
8040 selectedItem
= this.outline
.getSelectedItem(),
8041 movable
= selectedItem
&& selectedItem
.isMovable(),
8042 removable
= selectedItem
&& selectedItem
.isRemovable();
8047 while ( ++i
< len
) {
8048 if ( items
[i
].isMovable() ) {
8049 firstMovable
= items
[i
];
8055 if ( items
[i
].isMovable() ) {
8056 lastMovable
= items
[i
];
8061 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
8062 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
8063 this.removeButton
.setDisabled( !removable
);
8067 * Mixin for widgets with a boolean on/off state.
8073 * @param {Object} [config] Configuration options
8074 * @cfg {boolean} [value=false] Initial value
8076 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
8077 // Configuration initialization
8078 config
= config
|| {};
8084 this.$element
.addClass( 'oo-ui-toggleWidget' );
8085 this.setValue( !!config
.value
);
8092 * @param {boolean} value Changed value
8098 * Get the value of the toggle.
8102 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
8107 * Set the value of the toggle.
8109 * @param {boolean} value New value
8113 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
8115 if ( this.value
!== value
) {
8117 this.emit( 'change', value
);
8118 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
8119 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
8125 * Group widget for multiple related buttons.
8127 * Use together with OO.ui.ButtonWidget.
8130 * @extends OO.ui.Widget
8131 * @mixins OO.ui.GroupElement
8134 * @param {Object} [config] Configuration options
8135 * @cfg {OO.ui.ButtonWidget} [items] Buttons to add
8137 OO
.ui
.ButtonGroupWidget
= function OoUiButtonGroupWidget( config
) {
8138 // Parent constructor
8139 OO
.ui
.ButtonGroupWidget
.super.call( this, config
);
8141 // Mixin constructors
8142 OO
.ui
.GroupElement
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
8145 this.$element
.addClass( 'oo-ui-buttonGroupWidget' );
8146 if ( $.isArray( config
.items
) ) {
8147 this.addItems( config
.items
);
8153 OO
.inheritClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.Widget
);
8154 OO
.mixinClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.GroupElement
);
8157 * Generic widget for buttons.
8160 * @extends OO.ui.Widget
8161 * @mixins OO.ui.ButtonElement
8162 * @mixins OO.ui.IconElement
8163 * @mixins OO.ui.IndicatorElement
8164 * @mixins OO.ui.LabelElement
8165 * @mixins OO.ui.TitledElement
8166 * @mixins OO.ui.FlaggedElement
8169 * @param {Object} [config] Configuration options
8170 * @cfg {string} [href] Hyperlink to visit when clicked
8171 * @cfg {string} [target] Target to open hyperlink in
8173 OO
.ui
.ButtonWidget
= function OoUiButtonWidget( config
) {
8174 // Configuration initialization
8175 config
= $.extend( { target
: '_blank' }, config
);
8177 // Parent constructor
8178 OO
.ui
.ButtonWidget
.super.call( this, config
);
8180 // Mixin constructors
8181 OO
.ui
.ButtonElement
.call( this, config
);
8182 OO
.ui
.IconElement
.call( this, config
);
8183 OO
.ui
.IndicatorElement
.call( this, config
);
8184 OO
.ui
.LabelElement
.call( this, config
);
8185 OO
.ui
.TitledElement
.call( this, config
, $.extend( {}, config
, { $titled
: this.$button
} ) );
8186 OO
.ui
.FlaggedElement
.call( this, config
);
8191 this.isHyperlink
= false;
8195 click
: OO
.ui
.bind( this.onClick
, this ),
8196 keypress
: OO
.ui
.bind( this.onKeyPress
, this )
8200 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
8202 .addClass( 'oo-ui-buttonWidget' )
8203 .append( this.$button
);
8204 this.setHref( config
.href
);
8205 this.setTarget( config
.target
);
8210 OO
.inheritClass( OO
.ui
.ButtonWidget
, OO
.ui
.Widget
);
8211 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.ButtonElement
);
8212 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IconElement
);
8213 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IndicatorElement
);
8214 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.LabelElement
);
8215 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.TitledElement
);
8216 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.FlaggedElement
);
8227 * Handles mouse click events.
8229 * @param {jQuery.Event} e Mouse click event
8232 OO
.ui
.ButtonWidget
.prototype.onClick = function () {
8233 if ( !this.isDisabled() ) {
8234 this.emit( 'click' );
8235 if ( this.isHyperlink
) {
8243 * Handles keypress events.
8245 * @param {jQuery.Event} e Keypress event
8248 OO
.ui
.ButtonWidget
.prototype.onKeyPress = function ( e
) {
8249 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
8251 if ( this.isHyperlink
) {
8259 * Get hyperlink location.
8261 * @return {string} Hyperlink location
8263 OO
.ui
.ButtonWidget
.prototype.getHref = function () {
8268 * Get hyperlink target.
8270 * @return {string} Hyperlink target
8272 OO
.ui
.ButtonWidget
.prototype.getTarget = function () {
8277 * Set hyperlink location.
8279 * @param {string|null} href Hyperlink location, null to remove
8281 OO
.ui
.ButtonWidget
.prototype.setHref = function ( href
) {
8282 href
= typeof href
=== 'string' ? href
: null;
8284 if ( href
!== this.href
) {
8286 if ( href
!== null ) {
8287 this.$button
.attr( 'href', href
);
8288 this.isHyperlink
= true;
8290 this.$button
.removeAttr( 'href' );
8291 this.isHyperlink
= false;
8299 * Set hyperlink target.
8301 * @param {string|null} target Hyperlink target, null to remove
8303 OO
.ui
.ButtonWidget
.prototype.setTarget = function ( target
) {
8304 target
= typeof target
=== 'string' ? target
: null;
8306 if ( target
!== this.target
) {
8307 this.target
= target
;
8308 if ( target
!== null ) {
8309 this.$button
.attr( 'target', target
);
8311 this.$button
.removeAttr( 'target' );
8319 * Button widget that executes an action and is managed by an OO.ui.ActionSet.
8322 * @extends OO.ui.ButtonWidget
8323 * @mixins OO.ui.PendingElement
8326 * @param {Object} [config] Configuration options
8327 * @cfg {string} [action] Symbolic action name
8328 * @cfg {string[]} [modes] Symbolic mode names
8329 * @cfg {boolean} [framed=false] Render button with a frame
8331 OO
.ui
.ActionWidget
= function OoUiActionWidget( config
) {
8332 // Config intialization
8333 config
= $.extend( { framed
: false }, config
);
8335 // Parent constructor
8336 OO
.ui
.ActionWidget
.super.call( this, config
);
8338 // Mixin constructors
8339 OO
.ui
.PendingElement
.call( this, config
);
8342 this.action
= config
.action
|| '';
8343 this.modes
= config
.modes
|| [];
8348 this.$element
.addClass( 'oo-ui-actionWidget' );
8353 OO
.inheritClass( OO
.ui
.ActionWidget
, OO
.ui
.ButtonWidget
);
8354 OO
.mixinClass( OO
.ui
.ActionWidget
, OO
.ui
.PendingElement
);
8365 * Check if action is available in a certain mode.
8367 * @param {string} mode Name of mode
8368 * @return {boolean} Has mode
8370 OO
.ui
.ActionWidget
.prototype.hasMode = function ( mode
) {
8371 return this.modes
.indexOf( mode
) !== -1;
8375 * Get symbolic action name.
8379 OO
.ui
.ActionWidget
.prototype.getAction = function () {
8384 * Get symbolic action name.
8388 OO
.ui
.ActionWidget
.prototype.getModes = function () {
8389 return this.modes
.slice();
8393 * Emit a resize event if the size has changed.
8397 OO
.ui
.ActionWidget
.prototype.propagateResize = function () {
8400 if ( this.isElementAttached() ) {
8401 width
= this.$element
.width();
8402 height
= this.$element
.height();
8404 if ( width
!== this.width
|| height
!== this.height
) {
8406 this.height
= height
;
8407 this.emit( 'resize' );
8417 OO
.ui
.ActionWidget
.prototype.setIcon = function () {
8419 OO
.ui
.IconElement
.prototype.setIcon
.apply( this, arguments
);
8420 this.propagateResize();
8428 OO
.ui
.ActionWidget
.prototype.setLabel = function () {
8430 OO
.ui
.LabelElement
.prototype.setLabel
.apply( this, arguments
);
8431 this.propagateResize();
8439 OO
.ui
.ActionWidget
.prototype.setFlags = function () {
8441 OO
.ui
.FlaggedElement
.prototype.setFlags
.apply( this, arguments
);
8442 this.propagateResize();
8450 OO
.ui
.ActionWidget
.prototype.clearFlags = function () {
8452 OO
.ui
.FlaggedElement
.prototype.clearFlags
.apply( this, arguments
);
8453 this.propagateResize();
8459 * Toggle visibility of button.
8461 * @param {boolean} [show] Show button, omit to toggle visibility
8464 OO
.ui
.ActionWidget
.prototype.toggle = function () {
8466 OO
.ui
.ActionWidget
.super.prototype.toggle
.apply( this, arguments
);
8467 this.propagateResize();
8473 * Button that shows and hides a popup.
8476 * @extends OO.ui.ButtonWidget
8477 * @mixins OO.ui.PopupElement
8480 * @param {Object} [config] Configuration options
8482 OO
.ui
.PopupButtonWidget
= function OoUiPopupButtonWidget( config
) {
8483 // Parent constructor
8484 OO
.ui
.PopupButtonWidget
.super.call( this, config
);
8486 // Mixin constructors
8487 OO
.ui
.PopupElement
.call( this, config
);
8491 .addClass( 'oo-ui-popupButtonWidget' )
8492 .append( this.popup
.$element
);
8497 OO
.inheritClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.ButtonWidget
);
8498 OO
.mixinClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.PopupElement
);
8503 * Handles mouse click events.
8505 * @param {jQuery.Event} e Mouse click event
8507 OO
.ui
.PopupButtonWidget
.prototype.onClick = function ( e
) {
8508 // Skip clicks within the popup
8509 if ( $.contains( this.popup
.$element
[0], e
.target
) ) {
8513 if ( !this.isDisabled() ) {
8514 this.popup
.toggle();
8516 OO
.ui
.PopupButtonWidget
.super.prototype.onClick
.call( this );
8522 * Button that toggles on and off.
8525 * @extends OO.ui.ButtonWidget
8526 * @mixins OO.ui.ToggleWidget
8529 * @param {Object} [config] Configuration options
8530 * @cfg {boolean} [value=false] Initial value
8532 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
8533 // Configuration initialization
8534 config
= config
|| {};
8536 // Parent constructor
8537 OO
.ui
.ToggleButtonWidget
.super.call( this, config
);
8539 // Mixin constructors
8540 OO
.ui
.ToggleWidget
.call( this, config
);
8543 this.$element
.addClass( 'oo-ui-toggleButtonWidget' );
8548 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ButtonWidget
);
8549 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
8556 OO
.ui
.ToggleButtonWidget
.prototype.onClick = function () {
8557 if ( !this.isDisabled() ) {
8558 this.setValue( !this.value
);
8562 return OO
.ui
.ToggleButtonWidget
.super.prototype.onClick
.call( this );
8568 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
8570 if ( value
!== this.value
) {
8571 this.setActive( value
);
8574 // Parent method (from mixin)
8575 OO
.ui
.ToggleWidget
.prototype.setValue
.call( this, value
);
8583 * See OO.ui.IconElement for more information.
8586 * @extends OO.ui.Widget
8587 * @mixins OO.ui.IconElement
8588 * @mixins OO.ui.TitledElement
8591 * @param {Object} [config] Configuration options
8593 OO
.ui
.IconWidget
= function OoUiIconWidget( config
) {
8594 // Config intialization
8595 config
= config
|| {};
8597 // Parent constructor
8598 OO
.ui
.IconWidget
.super.call( this, config
);
8600 // Mixin constructors
8601 OO
.ui
.IconElement
.call( this, $.extend( {}, config
, { $icon
: this.$element
} ) );
8602 OO
.ui
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$element
} ) );
8605 this.$element
.addClass( 'oo-ui-iconWidget' );
8610 OO
.inheritClass( OO
.ui
.IconWidget
, OO
.ui
.Widget
);
8611 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.IconElement
);
8612 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.TitledElement
);
8614 /* Static Properties */
8616 OO
.ui
.IconWidget
.static.tagName
= 'span';
8621 * See OO.ui.IndicatorElement for more information.
8624 * @extends OO.ui.Widget
8625 * @mixins OO.ui.IndicatorElement
8626 * @mixins OO.ui.TitledElement
8629 * @param {Object} [config] Configuration options
8631 OO
.ui
.IndicatorWidget
= function OoUiIndicatorWidget( config
) {
8632 // Config intialization
8633 config
= config
|| {};
8635 // Parent constructor
8636 OO
.ui
.IndicatorWidget
.super.call( this, config
);
8638 // Mixin constructors
8639 OO
.ui
.IndicatorElement
.call( this, $.extend( {}, config
, { $indicator
: this.$element
} ) );
8640 OO
.ui
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$element
} ) );
8643 this.$element
.addClass( 'oo-ui-indicatorWidget' );
8648 OO
.inheritClass( OO
.ui
.IndicatorWidget
, OO
.ui
.Widget
);
8649 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.IndicatorElement
);
8650 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.TitledElement
);
8652 /* Static Properties */
8654 OO
.ui
.IndicatorWidget
.static.tagName
= 'span';
8657 * Inline menu of options.
8659 * Inline menus provide a control for accessing a menu and compose a menu within the widget, which
8660 * can be accessed using the #getMenu method.
8662 * Use with OO.ui.MenuOptionWidget.
8665 * @extends OO.ui.Widget
8666 * @mixins OO.ui.IconElement
8667 * @mixins OO.ui.IndicatorElement
8668 * @mixins OO.ui.LabelElement
8669 * @mixins OO.ui.TitledElement
8672 * @param {Object} [config] Configuration options
8673 * @cfg {Object} [menu] Configuration options to pass to menu widget
8675 OO
.ui
.InlineMenuWidget
= function OoUiInlineMenuWidget( config
) {
8676 // Configuration initialization
8677 config
= $.extend( { indicator
: 'down' }, config
);
8679 // Parent constructor
8680 OO
.ui
.InlineMenuWidget
.super.call( this, config
);
8682 // Mixin constructors
8683 OO
.ui
.IconElement
.call( this, config
);
8684 OO
.ui
.IndicatorElement
.call( this, config
);
8685 OO
.ui
.LabelElement
.call( this, config
);
8686 OO
.ui
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$label
} ) );
8689 this.menu
= new OO
.ui
.MenuWidget( $.extend( { $: this.$, widget
: this }, config
.menu
) );
8690 this.$handle
= this.$( '<span>' );
8693 this.$element
.on( { click
: OO
.ui
.bind( this.onClick
, this ) } );
8694 this.menu
.connect( this, { select
: 'onMenuSelect' } );
8698 .addClass( 'oo-ui-inlineMenuWidget-handle' )
8699 .append( this.$icon
, this.$label
, this.$indicator
);
8701 .addClass( 'oo-ui-inlineMenuWidget' )
8702 .append( this.$handle
, this.menu
.$element
);
8707 OO
.inheritClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.Widget
);
8708 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.IconElement
);
8709 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.IndicatorElement
);
8710 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.LabelElement
);
8711 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.TitledElement
);
8718 * @return {OO.ui.MenuWidget} Menu of widget
8720 OO
.ui
.InlineMenuWidget
.prototype.getMenu = function () {
8725 * Handles menu select events.
8727 * @param {OO.ui.MenuItemWidget} item Selected menu item
8729 OO
.ui
.InlineMenuWidget
.prototype.onMenuSelect = function ( item
) {
8736 selectedLabel
= item
.getLabel();
8738 // If the label is a DOM element, clone it, because setLabel will append() it
8739 if ( selectedLabel
instanceof jQuery
) {
8740 selectedLabel
= selectedLabel
.clone();
8743 this.setLabel( selectedLabel
);
8747 * Handles mouse click events.
8749 * @param {jQuery.Event} e Mouse click event
8751 OO
.ui
.InlineMenuWidget
.prototype.onClick = function ( e
) {
8752 // Skip clicks within the menu
8753 if ( $.contains( this.menu
.$element
[0], e
.target
) ) {
8757 if ( !this.isDisabled() ) {
8758 if ( this.menu
.isVisible() ) {
8759 this.menu
.toggle( false );
8761 this.menu
.toggle( true );
8768 * Base class for input widgets.
8772 * @extends OO.ui.Widget
8773 * @mixins OO.ui.FlaggedElement
8776 * @param {Object} [config] Configuration options
8777 * @cfg {string} [name=''] HTML input name
8778 * @cfg {string} [value=''] Input value
8779 * @cfg {boolean} [readOnly=false] Prevent changes
8780 * @cfg {Function} [inputFilter] Filter function to apply to the input. Takes a string argument and returns a string.
8782 OO
.ui
.InputWidget
= function OoUiInputWidget( config
) {
8783 // Config intialization
8784 config
= $.extend( { readOnly
: false }, config
);
8786 // Parent constructor
8787 OO
.ui
.InputWidget
.super.call( this, config
);
8789 // Mixin constructors
8790 OO
.ui
.FlaggedElement
.call( this, config
);
8793 this.$input
= this.getInputElement( config
);
8795 this.readOnly
= false;
8796 this.inputFilter
= config
.inputFilter
;
8799 this.$input
.on( 'keydown mouseup cut paste change input select', OO
.ui
.bind( this.onEdit
, this ) );
8803 .attr( 'name', config
.name
)
8804 .prop( 'disabled', this.isDisabled() );
8805 this.setReadOnly( config
.readOnly
);
8806 this.$element
.addClass( 'oo-ui-inputWidget' ).append( this.$input
);
8807 this.setValue( config
.value
);
8812 OO
.inheritClass( OO
.ui
.InputWidget
, OO
.ui
.Widget
);
8813 OO
.mixinClass( OO
.ui
.InputWidget
, OO
.ui
.FlaggedElement
);
8825 * Get input element.
8827 * @param {Object} [config] Configuration options
8828 * @return {jQuery} Input element
8830 OO
.ui
.InputWidget
.prototype.getInputElement = function () {
8831 return this.$( '<input>' );
8835 * Handle potentially value-changing events.
8837 * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
8839 OO
.ui
.InputWidget
.prototype.onEdit = function () {
8841 if ( !this.isDisabled() ) {
8842 // Allow the stack to clear so the value will be updated
8843 setTimeout( function () {
8844 widget
.setValue( widget
.$input
.val() );
8850 * Get the value of the input.
8852 * @return {string} Input value
8854 OO
.ui
.InputWidget
.prototype.getValue = function () {
8859 * Sets the direction of the current input, either RTL or LTR
8861 * @param {boolean} isRTL
8863 OO
.ui
.InputWidget
.prototype.setRTL = function ( isRTL
) {
8865 this.$input
.removeClass( 'oo-ui-ltr' );
8866 this.$input
.addClass( 'oo-ui-rtl' );
8868 this.$input
.removeClass( 'oo-ui-rtl' );
8869 this.$input
.addClass( 'oo-ui-ltr' );
8874 * Set the value of the input.
8876 * @param {string} value New value
8880 OO
.ui
.InputWidget
.prototype.setValue = function ( value
) {
8881 value
= this.sanitizeValue( value
);
8882 if ( this.value
!== value
) {
8884 this.emit( 'change', this.value
);
8886 // Update the DOM if it has changed. Note that with sanitizeValue, it
8887 // is possible for the DOM value to change without this.value changing.
8888 if ( this.$input
.val() !== this.value
) {
8889 this.$input
.val( this.value
);
8895 * Sanitize incoming value.
8897 * Ensures value is a string, and converts undefined and null to empty strings.
8899 * @param {string} value Original value
8900 * @return {string} Sanitized value
8902 OO
.ui
.InputWidget
.prototype.sanitizeValue = function ( value
) {
8903 if ( value
=== undefined || value
=== null ) {
8905 } else if ( this.inputFilter
) {
8906 return this.inputFilter( String( value
) );
8908 return String( value
);
8913 * Simulate the behavior of clicking on a label bound to this input.
8915 OO
.ui
.InputWidget
.prototype.simulateLabelClick = function () {
8916 if ( !this.isDisabled() ) {
8917 if ( this.$input
.is( ':checkbox,:radio' ) ) {
8918 this.$input
.click();
8919 } else if ( this.$input
.is( ':input' ) ) {
8920 this.$input
[0].focus();
8926 * Check if the widget is read-only.
8930 OO
.ui
.InputWidget
.prototype.isReadOnly = function () {
8931 return this.readOnly
;
8935 * Set the read-only state of the widget.
8937 * This should probably change the widgets's appearance and prevent it from being used.
8939 * @param {boolean} state Make input read-only
8942 OO
.ui
.InputWidget
.prototype.setReadOnly = function ( state
) {
8943 this.readOnly
= !!state
;
8944 this.$input
.prop( 'readOnly', this.readOnly
);
8951 OO
.ui
.InputWidget
.prototype.setDisabled = function ( state
) {
8952 OO
.ui
.InputWidget
.super.prototype.setDisabled
.call( this, state
);
8953 if ( this.$input
) {
8954 this.$input
.prop( 'disabled', this.isDisabled() );
8964 OO
.ui
.InputWidget
.prototype.focus = function () {
8965 this.$input
[0].focus();
8974 OO
.ui
.InputWidget
.prototype.blur = function () {
8975 this.$input
[0].blur();
8980 * Checkbox input widget.
8983 * @extends OO.ui.InputWidget
8986 * @param {Object} [config] Configuration options
8988 OO
.ui
.CheckboxInputWidget
= function OoUiCheckboxInputWidget( config
) {
8989 // Parent constructor
8990 OO
.ui
.CheckboxInputWidget
.super.call( this, config
);
8993 this.$element
.addClass( 'oo-ui-checkboxInputWidget' );
8998 OO
.inheritClass( OO
.ui
.CheckboxInputWidget
, OO
.ui
.InputWidget
);
9005 * Get input element.
9007 * @return {jQuery} Input element
9009 OO
.ui
.CheckboxInputWidget
.prototype.getInputElement = function () {
9010 return this.$( '<input type="checkbox" />' );
9014 * Get checked state of the checkbox
9016 * @return {boolean} If the checkbox is checked
9018 OO
.ui
.CheckboxInputWidget
.prototype.getValue = function () {
9025 OO
.ui
.CheckboxInputWidget
.prototype.setValue = function ( value
) {
9027 if ( this.value
!== value
) {
9029 this.$input
.prop( 'checked', this.value
);
9030 this.emit( 'change', this.value
);
9037 OO
.ui
.CheckboxInputWidget
.prototype.onEdit = function () {
9039 if ( !this.isDisabled() ) {
9040 // Allow the stack to clear so the value will be updated
9041 setTimeout( function () {
9042 widget
.setValue( widget
.$input
.prop( 'checked' ) );
9048 * Input widget with a text field.
9051 * @extends OO.ui.InputWidget
9052 * @mixins OO.ui.IconElement
9053 * @mixins OO.ui.IndicatorElement
9054 * @mixins OO.ui.PendingElement
9057 * @param {Object} [config] Configuration options
9058 * @cfg {string} [placeholder] Placeholder text
9059 * @cfg {boolean} [multiline=false] Allow multiple lines of text
9060 * @cfg {boolean} [autosize=false] Automatically resize to fit content
9061 * @cfg {boolean} [maxRows=10] Maximum number of rows to make visible when autosizing
9062 * @cfg {RegExp|string} [validate] Regular expression (or symbolic name referencing
9063 * one, see #static-validationPatterns)
9065 OO
.ui
.TextInputWidget
= function OoUiTextInputWidget( config
) {
9066 // Configuration initialization
9067 config
= config
|| {};
9069 // Parent constructor
9070 OO
.ui
.TextInputWidget
.super.call( this, config
);
9072 // Mixin constructors
9073 OO
.ui
.IconElement
.call( this, config
);
9074 OO
.ui
.IndicatorElement
.call( this, config
);
9075 OO
.ui
.PendingElement
.call( this, config
);
9078 this.multiline
= !!config
.multiline
;
9079 this.autosize
= !!config
.autosize
;
9080 this.maxRows
= config
.maxRows
!== undefined ? config
.maxRows
: 10;
9081 this.validate
= null;
9083 this.setValidation( config
.validate
);
9087 keypress
: OO
.ui
.bind( this.onKeyPress
, this ),
9088 blur
: OO
.ui
.bind( this.setValidityFlag
, this )
9090 this.$element
.on( 'DOMNodeInsertedIntoDocument', OO
.ui
.bind( this.onElementAttach
, this ) );
9091 this.$icon
.on( 'mousedown', OO
.ui
.bind( this.onIconMouseDown
, this ) );
9092 this.$indicator
.on( 'mousedown', OO
.ui
.bind( this.onIndicatorMouseDown
, this ) );
9096 .addClass( 'oo-ui-textInputWidget' )
9097 .append( this.$icon
, this.$indicator
);
9098 if ( config
.placeholder
) {
9099 this.$input
.attr( 'placeholder', config
.placeholder
);
9101 this.$element
.attr( 'role', 'textbox' );
9106 OO
.inheritClass( OO
.ui
.TextInputWidget
, OO
.ui
.InputWidget
);
9107 OO
.mixinClass( OO
.ui
.TextInputWidget
, OO
.ui
.IconElement
);
9108 OO
.mixinClass( OO
.ui
.TextInputWidget
, OO
.ui
.IndicatorElement
);
9109 OO
.mixinClass( OO
.ui
.TextInputWidget
, OO
.ui
.PendingElement
);
9111 /* Static properties */
9113 OO
.ui
.TextInputWidget
.static.validationPatterns
= {
9121 * User presses enter inside the text box.
9123 * Not called if input is multiline.
9129 * User clicks the icon.
9135 * User clicks the indicator.
9143 * Handle icon mouse down events.
9145 * @param {jQuery.Event} e Mouse down event
9148 OO
.ui
.TextInputWidget
.prototype.onIconMouseDown = function ( e
) {
9149 if ( e
.which
=== 1 ) {
9150 this.$input
[0].focus();
9151 this.emit( 'icon' );
9157 * Handle indicator mouse down events.
9159 * @param {jQuery.Event} e Mouse down event
9162 OO
.ui
.TextInputWidget
.prototype.onIndicatorMouseDown = function ( e
) {
9163 if ( e
.which
=== 1 ) {
9164 this.$input
[0].focus();
9165 this.emit( 'indicator' );
9171 * Handle key press events.
9173 * @param {jQuery.Event} e Key press event
9174 * @fires enter If enter key is pressed and input is not multiline
9176 OO
.ui
.TextInputWidget
.prototype.onKeyPress = function ( e
) {
9177 if ( e
.which
=== OO
.ui
.Keys
.ENTER
&& !this.multiline
) {
9178 this.emit( 'enter' );
9183 * Handle element attach events.
9185 * @param {jQuery.Event} e Element attach event
9187 OO
.ui
.TextInputWidget
.prototype.onElementAttach = function () {
9194 OO
.ui
.TextInputWidget
.prototype.onEdit = function () {
9198 return OO
.ui
.TextInputWidget
.super.prototype.onEdit
.call( this );
9204 OO
.ui
.TextInputWidget
.prototype.setValue = function ( value
) {
9206 OO
.ui
.TextInputWidget
.super.prototype.setValue
.call( this, value
);
9208 this.setValidityFlag();
9214 * Automatically adjust the size of the text input.
9216 * This only affects multi-line inputs that are auto-sized.
9220 OO
.ui
.TextInputWidget
.prototype.adjustSize = function () {
9221 var $clone
, scrollHeight
, innerHeight
, outerHeight
, maxInnerHeight
, measurementError
, idealHeight
;
9223 if ( this.multiline
&& this.autosize
) {
9224 $clone
= this.$input
.clone()
9225 .val( this.$input
.val() )
9226 // Set inline height property to 0 to measure scroll height
9227 .css( { height
: 0 } )
9228 .insertAfter( this.$input
);
9229 scrollHeight
= $clone
[0].scrollHeight
;
9230 // Remove inline height property to measure natural heights
9231 $clone
.css( 'height', '' );
9232 innerHeight
= $clone
.innerHeight();
9233 outerHeight
= $clone
.outerHeight();
9234 // Measure max rows height
9235 $clone
.attr( 'rows', this.maxRows
).css( 'height', 'auto' ).val( '' );
9236 maxInnerHeight
= $clone
.innerHeight();
9237 // Difference between reported innerHeight and scrollHeight with no scrollbars present
9238 // Equals 1 on Blink-based browsers and 0 everywhere else
9239 measurementError
= maxInnerHeight
- $clone
[0].scrollHeight
;
9241 idealHeight
= Math
.min( maxInnerHeight
, scrollHeight
+ measurementError
);
9242 // Only apply inline height when expansion beyond natural height is needed
9243 if ( idealHeight
> innerHeight
) {
9244 // Use the difference between the inner and outer height as a buffer
9245 this.$input
.css( 'height', idealHeight
+ ( outerHeight
- innerHeight
) );
9247 this.$input
.css( 'height', '' );
9254 * Get input element.
9256 * @param {Object} [config] Configuration options
9257 * @return {jQuery} Input element
9259 OO
.ui
.TextInputWidget
.prototype.getInputElement = function ( config
) {
9260 return config
.multiline
? this.$( '<textarea>' ) : this.$( '<input type="text" />' );
9266 * Check if input supports multiple lines.
9270 OO
.ui
.TextInputWidget
.prototype.isMultiline = function () {
9271 return !!this.multiline
;
9275 * Check if input automatically adjusts its size.
9279 OO
.ui
.TextInputWidget
.prototype.isAutosizing = function () {
9280 return !!this.autosize
;
9284 * Select the contents of the input.
9288 OO
.ui
.TextInputWidget
.prototype.select = function () {
9289 this.$input
.select();
9294 * Sets the validation pattern to use.
9295 * @param validate {RegExp|string|null} Regular expression (or symbolic name referencing
9296 * one, see #static-validationPatterns)
9298 OO
.ui
.TextInputWidget
.prototype.setValidation = function ( validate
) {
9299 if ( validate
instanceof RegExp
) {
9300 this.validate
= validate
;
9302 this.validate
= this.constructor.static.validationPatterns
[validate
] || /.*/;
9307 * Sets the 'invalid' flag appropriately.
9309 OO
.ui
.TextInputWidget
.prototype.setValidityFlag = function () {
9310 this.isValid().done( OO
.ui
.bind( function ( valid
) {
9311 this.setFlags( { invalid
: !valid
} );
9316 * Returns whether or not the current value is considered valid, according to the
9317 * supplied validation pattern.
9319 * @return {jQuery.Deferred}
9321 OO
.ui
.TextInputWidget
.prototype.isValid = function () {
9322 return $.Deferred().resolve( !!this.getValue().match( this.validate
) ).promise();
9326 * Text input with a menu of optional values.
9329 * @extends OO.ui.Widget
9332 * @param {Object} [config] Configuration options
9333 * @cfg {Object} [menu] Configuration options to pass to menu widget
9334 * @cfg {Object} [input] Configuration options to pass to input widget
9336 OO
.ui
.ComboBoxWidget
= function OoUiComboBoxWidget( config
) {
9337 // Configuration initialization
9338 config
= config
|| {};
9340 // Parent constructor
9341 OO
.ui
.ComboBoxWidget
.super.call( this, config
);
9344 this.input
= new OO
.ui
.TextInputWidget( $.extend(
9345 { $: this.$, indicator
: 'down', disabled
: this.isDisabled() },
9348 this.menu
= new OO
.ui
.MenuWidget( $.extend(
9349 { $: this.$, widget
: this, input
: this.input
, disabled
: this.isDisabled() },
9354 this.input
.connect( this, {
9355 change
: 'onInputChange',
9356 indicator
: 'onInputIndicator',
9357 enter
: 'onInputEnter'
9359 this.menu
.connect( this, {
9360 choose
: 'onMenuChoose',
9361 add
: 'onMenuItemsChange',
9362 remove
: 'onMenuItemsChange'
9366 this.$element
.addClass( 'oo-ui-comboBoxWidget' ).append(
9367 this.input
.$element
,
9370 this.onMenuItemsChange();
9375 OO
.inheritClass( OO
.ui
.ComboBoxWidget
, OO
.ui
.Widget
);
9380 * Handle input change events.
9382 * @param {string} value New value
9384 OO
.ui
.ComboBoxWidget
.prototype.onInputChange = function ( value
) {
9385 var match
= this.menu
.getItemFromData( value
);
9387 this.menu
.selectItem( match
);
9389 if ( !this.isDisabled() ) {
9390 this.menu
.toggle( true );
9395 * Handle input indicator events.
9397 OO
.ui
.ComboBoxWidget
.prototype.onInputIndicator = function () {
9398 if ( !this.isDisabled() ) {
9404 * Handle input enter events.
9406 OO
.ui
.ComboBoxWidget
.prototype.onInputEnter = function () {
9407 if ( !this.isDisabled() ) {
9408 this.menu
.toggle( false );
9413 * Handle menu choose events.
9415 * @param {OO.ui.OptionWidget} item Chosen item
9417 OO
.ui
.ComboBoxWidget
.prototype.onMenuChoose = function ( item
) {
9419 this.input
.setValue( item
.getData() );
9424 * Handle menu item change events.
9426 OO
.ui
.ComboBoxWidget
.prototype.onMenuItemsChange = function () {
9427 this.$element
.toggleClass( 'oo-ui-comboBoxWidget-empty', this.menu
.isEmpty() );
9433 OO
.ui
.ComboBoxWidget
.prototype.setDisabled = function ( disabled
) {
9435 OO
.ui
.ComboBoxWidget
.super.prototype.setDisabled
.call( this, disabled
);
9438 this.input
.setDisabled( this.isDisabled() );
9441 this.menu
.setDisabled( this.isDisabled() );
9451 * @extends OO.ui.Widget
9452 * @mixins OO.ui.LabelElement
9455 * @param {Object} [config] Configuration options
9457 OO
.ui
.LabelWidget
= function OoUiLabelWidget( config
) {
9458 // Config intialization
9459 config
= config
|| {};
9461 // Parent constructor
9462 OO
.ui
.LabelWidget
.super.call( this, config
);
9464 // Mixin constructors
9465 OO
.ui
.LabelElement
.call( this, $.extend( {}, config
, { $label
: this.$element
} ) );
9468 this.input
= config
.input
;
9471 if ( this.input
instanceof OO
.ui
.InputWidget
) {
9472 this.$element
.on( 'click', OO
.ui
.bind( this.onClick
, this ) );
9476 this.$element
.addClass( 'oo-ui-labelWidget' );
9481 OO
.inheritClass( OO
.ui
.LabelWidget
, OO
.ui
.Widget
);
9482 OO
.mixinClass( OO
.ui
.LabelWidget
, OO
.ui
.LabelElement
);
9484 /* Static Properties */
9486 OO
.ui
.LabelWidget
.static.tagName
= 'span';
9491 * Handles label mouse click events.
9493 * @param {jQuery.Event} e Mouse click event
9495 OO
.ui
.LabelWidget
.prototype.onClick = function () {
9496 this.input
.simulateLabelClick();
9501 * Generic option widget for use with OO.ui.SelectWidget.
9504 * @extends OO.ui.Widget
9505 * @mixins OO.ui.LabelElement
9506 * @mixins OO.ui.FlaggedElement
9509 * @param {Mixed} data Option data
9510 * @param {Object} [config] Configuration options
9511 * @cfg {string} [rel] Value for `rel` attribute in DOM, allowing per-option styling
9513 OO
.ui
.OptionWidget
= function OoUiOptionWidget( data
, config
) {
9514 // Config intialization
9515 config
= config
|| {};
9517 // Parent constructor
9518 OO
.ui
.OptionWidget
.super.call( this, config
);
9520 // Mixin constructors
9521 OO
.ui
.ItemWidget
.call( this );
9522 OO
.ui
.LabelElement
.call( this, config
);
9523 OO
.ui
.FlaggedElement
.call( this, config
);
9527 this.selected
= false;
9528 this.highlighted
= false;
9529 this.pressed
= false;
9533 .data( 'oo-ui-optionWidget', this )
9534 .attr( 'rel', config
.rel
)
9535 .attr( 'role', 'option' )
9536 .addClass( 'oo-ui-optionWidget' )
9537 .append( this.$label
);
9539 .prepend( this.$icon
)
9540 .append( this.$indicator
);
9545 OO
.inheritClass( OO
.ui
.OptionWidget
, OO
.ui
.Widget
);
9546 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.ItemWidget
);
9547 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.LabelElement
);
9548 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.FlaggedElement
);
9550 /* Static Properties */
9552 OO
.ui
.OptionWidget
.static.selectable
= true;
9554 OO
.ui
.OptionWidget
.static.highlightable
= true;
9556 OO
.ui
.OptionWidget
.static.pressable
= true;
9558 OO
.ui
.OptionWidget
.static.scrollIntoViewOnSelect
= false;
9563 * Check if option can be selected.
9565 * @return {boolean} Item is selectable
9567 OO
.ui
.OptionWidget
.prototype.isSelectable = function () {
9568 return this.constructor.static.selectable
&& !this.isDisabled();
9572 * Check if option can be highlighted.
9574 * @return {boolean} Item is highlightable
9576 OO
.ui
.OptionWidget
.prototype.isHighlightable = function () {
9577 return this.constructor.static.highlightable
&& !this.isDisabled();
9581 * Check if option can be pressed.
9583 * @return {boolean} Item is pressable
9585 OO
.ui
.OptionWidget
.prototype.isPressable = function () {
9586 return this.constructor.static.pressable
&& !this.isDisabled();
9590 * Check if option is selected.
9592 * @return {boolean} Item is selected
9594 OO
.ui
.OptionWidget
.prototype.isSelected = function () {
9595 return this.selected
;
9599 * Check if option is highlighted.
9601 * @return {boolean} Item is highlighted
9603 OO
.ui
.OptionWidget
.prototype.isHighlighted = function () {
9604 return this.highlighted
;
9608 * Check if option is pressed.
9610 * @return {boolean} Item is pressed
9612 OO
.ui
.OptionWidget
.prototype.isPressed = function () {
9613 return this.pressed
;
9617 * Set selected state.
9619 * @param {boolean} [state=false] Select option
9622 OO
.ui
.OptionWidget
.prototype.setSelected = function ( state
) {
9623 if ( this.constructor.static.selectable
) {
9624 this.selected
= !!state
;
9625 this.$element
.toggleClass( 'oo-ui-optionWidget-selected', state
);
9626 if ( state
&& this.constructor.static.scrollIntoViewOnSelect
) {
9627 this.scrollElementIntoView();
9629 this.updateThemeClasses();
9635 * Set highlighted state.
9637 * @param {boolean} [state=false] Highlight option
9640 OO
.ui
.OptionWidget
.prototype.setHighlighted = function ( state
) {
9641 if ( this.constructor.static.highlightable
) {
9642 this.highlighted
= !!state
;
9643 this.$element
.toggleClass( 'oo-ui-optionWidget-highlighted', state
);
9644 this.updateThemeClasses();
9650 * Set pressed state.
9652 * @param {boolean} [state=false] Press option
9655 OO
.ui
.OptionWidget
.prototype.setPressed = function ( state
) {
9656 if ( this.constructor.static.pressable
) {
9657 this.pressed
= !!state
;
9658 this.$element
.toggleClass( 'oo-ui-optionWidget-pressed', state
);
9659 this.updateThemeClasses();
9665 * Make the option's highlight flash.
9667 * While flashing, the visual style of the pressed state is removed if present.
9669 * @return {jQuery.Promise} Promise resolved when flashing is done
9671 OO
.ui
.OptionWidget
.prototype.flash = function () {
9673 $element
= this.$element
,
9674 deferred
= $.Deferred();
9676 if ( !this.isDisabled() && this.constructor.static.pressable
) {
9677 $element
.removeClass( 'oo-ui-optionWidget-highlighted oo-ui-optionWidget-pressed' );
9678 setTimeout( function () {
9679 // Restore original classes
9681 .toggleClass( 'oo-ui-optionWidget-highlighted', widget
.highlighted
)
9682 .toggleClass( 'oo-ui-optionWidget-pressed', widget
.pressed
);
9684 setTimeout( function () {
9691 return deferred
.promise();
9697 * @return {Mixed} Option data
9699 OO
.ui
.OptionWidget
.prototype.getData = function () {
9704 * Option widget with an option icon and indicator.
9706 * Use together with OO.ui.SelectWidget.
9709 * @extends OO.ui.OptionWidget
9710 * @mixins OO.ui.IconElement
9711 * @mixins OO.ui.IndicatorElement
9714 * @param {Mixed} data Option data
9715 * @param {Object} [config] Configuration options
9717 OO
.ui
.DecoratedOptionWidget
= function OoUiDecoratedOptionWidget( data
, config
) {
9718 // Parent constructor
9719 OO
.ui
.DecoratedOptionWidget
.super.call( this, data
, config
);
9721 // Mixin constructors
9722 OO
.ui
.IconElement
.call( this, config
);
9723 OO
.ui
.IndicatorElement
.call( this, config
);
9727 .addClass( 'oo-ui-decoratedOptionWidget' )
9728 .prepend( this.$icon
)
9729 .append( this.$indicator
);
9734 OO
.inheritClass( OO
.ui
.DecoratedOptionWidget
, OO
.ui
.OptionWidget
);
9735 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IconElement
);
9736 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IndicatorElement
);
9739 * Option widget that looks like a button.
9741 * Use together with OO.ui.ButtonSelectWidget.
9744 * @extends OO.ui.DecoratedOptionWidget
9745 * @mixins OO.ui.ButtonElement
9748 * @param {Mixed} data Option data
9749 * @param {Object} [config] Configuration options
9751 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( data
, config
) {
9752 // Parent constructor
9753 OO
.ui
.ButtonOptionWidget
.super.call( this, data
, config
);
9755 // Mixin constructors
9756 OO
.ui
.ButtonElement
.call( this, config
);
9759 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
9760 this.$button
.append( this.$element
.contents() );
9761 this.$element
.append( this.$button
);
9766 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
9767 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.ButtonElement
);
9769 /* Static Properties */
9771 // Allow button mouse down events to pass through so they can be handled by the parent select widget
9772 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
9779 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
9780 OO
.ui
.ButtonOptionWidget
.super.prototype.setSelected
.call( this, state
);
9782 if ( this.constructor.static.selectable
) {
9783 this.setActive( state
);
9790 * Item of an OO.ui.MenuWidget.
9793 * @extends OO.ui.DecoratedOptionWidget
9796 * @param {Mixed} data Item data
9797 * @param {Object} [config] Configuration options
9799 OO
.ui
.MenuItemWidget
= function OoUiMenuItemWidget( data
, config
) {
9800 // Configuration initialization
9801 config
= $.extend( { icon
: 'check' }, config
);
9803 // Parent constructor
9804 OO
.ui
.MenuItemWidget
.super.call( this, data
, config
);
9808 .attr( 'role', 'menuitem' )
9809 .addClass( 'oo-ui-menuItemWidget' );
9814 OO
.inheritClass( OO
.ui
.MenuItemWidget
, OO
.ui
.DecoratedOptionWidget
);
9817 * Section to group one or more items in a OO.ui.MenuWidget.
9820 * @extends OO.ui.DecoratedOptionWidget
9823 * @param {Mixed} data Item data
9824 * @param {Object} [config] Configuration options
9826 OO
.ui
.MenuSectionItemWidget
= function OoUiMenuSectionItemWidget( data
, config
) {
9827 // Parent constructor
9828 OO
.ui
.MenuSectionItemWidget
.super.call( this, data
, config
);
9831 this.$element
.addClass( 'oo-ui-menuSectionItemWidget' );
9836 OO
.inheritClass( OO
.ui
.MenuSectionItemWidget
, OO
.ui
.DecoratedOptionWidget
);
9838 /* Static Properties */
9840 OO
.ui
.MenuSectionItemWidget
.static.selectable
= false;
9842 OO
.ui
.MenuSectionItemWidget
.static.highlightable
= false;
9845 * Items for an OO.ui.OutlineWidget.
9848 * @extends OO.ui.DecoratedOptionWidget
9851 * @param {Mixed} data Item data
9852 * @param {Object} [config] Configuration options
9853 * @cfg {number} [level] Indentation level
9854 * @cfg {boolean} [movable] Allow modification from outline controls
9856 OO
.ui
.OutlineItemWidget
= function OoUiOutlineItemWidget( data
, config
) {
9857 // Config intialization
9858 config
= config
|| {};
9860 // Parent constructor
9861 OO
.ui
.OutlineItemWidget
.super.call( this, data
, config
);
9865 this.movable
= !!config
.movable
;
9866 this.removable
= !!config
.removable
;
9869 this.$element
.addClass( 'oo-ui-outlineItemWidget' );
9870 this.setLevel( config
.level
);
9875 OO
.inheritClass( OO
.ui
.OutlineItemWidget
, OO
.ui
.DecoratedOptionWidget
);
9877 /* Static Properties */
9879 OO
.ui
.OutlineItemWidget
.static.highlightable
= false;
9881 OO
.ui
.OutlineItemWidget
.static.scrollIntoViewOnSelect
= true;
9883 OO
.ui
.OutlineItemWidget
.static.levelClass
= 'oo-ui-outlineItemWidget-level-';
9885 OO
.ui
.OutlineItemWidget
.static.levels
= 3;
9890 * Check if item is movable.
9892 * Movablilty is used by outline controls.
9894 * @return {boolean} Item is movable
9896 OO
.ui
.OutlineItemWidget
.prototype.isMovable = function () {
9897 return this.movable
;
9901 * Check if item is removable.
9903 * Removablilty is used by outline controls.
9905 * @return {boolean} Item is removable
9907 OO
.ui
.OutlineItemWidget
.prototype.isRemovable = function () {
9908 return this.removable
;
9912 * Get indentation level.
9914 * @return {number} Indentation level
9916 OO
.ui
.OutlineItemWidget
.prototype.getLevel = function () {
9923 * Movablilty is used by outline controls.
9925 * @param {boolean} movable Item is movable
9928 OO
.ui
.OutlineItemWidget
.prototype.setMovable = function ( movable
) {
9929 this.movable
= !!movable
;
9930 this.updateThemeClasses();
9937 * Removablilty is used by outline controls.
9939 * @param {boolean} movable Item is removable
9942 OO
.ui
.OutlineItemWidget
.prototype.setRemovable = function ( removable
) {
9943 this.removable
= !!removable
;
9944 this.updateThemeClasses();
9949 * Set indentation level.
9951 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
9954 OO
.ui
.OutlineItemWidget
.prototype.setLevel = function ( level
) {
9955 var levels
= this.constructor.static.levels
,
9956 levelClass
= this.constructor.static.levelClass
,
9959 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
9961 if ( this.level
=== i
) {
9962 this.$element
.addClass( levelClass
+ i
);
9964 this.$element
.removeClass( levelClass
+ i
);
9967 this.updateThemeClasses();
9973 * Container for content that is overlaid and positioned absolutely.
9976 * @extends OO.ui.Widget
9977 * @mixins OO.ui.LabelElement
9980 * @param {Object} [config] Configuration options
9981 * @cfg {number} [width=320] Width of popup in pixels
9982 * @cfg {number} [height] Height of popup, omit to use automatic height
9983 * @cfg {boolean} [anchor=true] Show anchor pointing to origin of popup
9984 * @cfg {string} [align='center'] Alignment of popup to origin
9985 * @cfg {jQuery} [$container] Container to prevent popup from rendering outside of
9986 * @cfg {jQuery} [$content] Content to append to the popup's body
9987 * @cfg {boolean} [autoClose=false] Popup auto-closes when it loses focus
9988 * @cfg {jQuery} [$autoCloseIgnore] Elements to not auto close when clicked
9989 * @cfg {boolean} [head] Show label and close button at the top
9990 * @cfg {boolean} [padded] Add padding to the body
9992 OO
.ui
.PopupWidget
= function OoUiPopupWidget( config
) {
9993 // Config intialization
9994 config
= config
|| {};
9996 // Parent constructor
9997 OO
.ui
.PopupWidget
.super.call( this, config
);
9999 // Mixin constructors
10000 OO
.ui
.LabelElement
.call( this, config
);
10001 OO
.ui
.ClippableElement
.call( this, config
);
10004 this.visible
= false;
10005 this.$popup
= this.$( '<div>' );
10006 this.$head
= this.$( '<div>' );
10007 this.$body
= this.$( '<div>' );
10008 this.$anchor
= this.$( '<div>' );
10009 this.$container
= config
.$container
; // If undefined, will be computed lazily in updateDimensions()
10010 this.autoClose
= !!config
.autoClose
;
10011 this.$autoCloseIgnore
= config
.$autoCloseIgnore
;
10012 this.transitionTimeout
= null;
10013 this.anchor
= null;
10014 this.width
= config
.width
!== undefined ? config
.width
: 320;
10015 this.height
= config
.height
!== undefined ? config
.height
: null;
10016 this.align
= config
.align
|| 'center';
10017 this.closeButton
= new OO
.ui
.ButtonWidget( { $: this.$, framed
: false, icon
: 'close' } );
10018 this.onMouseDownHandler
= OO
.ui
.bind( this.onMouseDown
, this );
10021 this.closeButton
.connect( this, { click
: 'onCloseButtonClick' } );
10024 this.toggleAnchor( config
.anchor
=== undefined || config
.anchor
);
10025 this.$body
.addClass( 'oo-ui-popupWidget-body' );
10026 this.$anchor
.addClass( 'oo-ui-popupWidget-anchor' );
10028 .addClass( 'oo-ui-popupWidget-head' )
10029 .append( this.$label
, this.closeButton
.$element
);
10030 if ( !config
.head
) {
10034 .addClass( 'oo-ui-popupWidget-popup' )
10035 .append( this.$head
, this.$body
);
10038 .addClass( 'oo-ui-popupWidget' )
10039 .append( this.$popup
, this.$anchor
);
10040 // Move content, which was added to #$element by OO.ui.Widget, to the body
10041 if ( config
.$content
instanceof jQuery
) {
10042 this.$body
.append( config
.$content
);
10044 if ( config
.padded
) {
10045 this.$body
.addClass( 'oo-ui-popupWidget-body-padded' );
10047 this.setClippableElement( this.$body
);
10052 OO
.inheritClass( OO
.ui
.PopupWidget
, OO
.ui
.Widget
);
10053 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.LabelElement
);
10054 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.ClippableElement
);
10069 * Handles mouse down events.
10071 * @param {jQuery.Event} e Mouse down event
10073 OO
.ui
.PopupWidget
.prototype.onMouseDown = function ( e
) {
10075 this.isVisible() &&
10076 !$.contains( this.$element
[0], e
.target
) &&
10077 ( !this.$autoCloseIgnore
|| !this.$autoCloseIgnore
.has( e
.target
).length
)
10079 this.toggle( false );
10084 * Bind mouse down listener.
10086 OO
.ui
.PopupWidget
.prototype.bindMouseDownListener = function () {
10087 // Capture clicks outside popup
10088 this.getElementWindow().addEventListener( 'mousedown', this.onMouseDownHandler
, true );
10092 * Handles close button click events.
10094 OO
.ui
.PopupWidget
.prototype.onCloseButtonClick = function () {
10095 if ( this.isVisible() ) {
10096 this.toggle( false );
10101 * Unbind mouse down listener.
10103 OO
.ui
.PopupWidget
.prototype.unbindMouseDownListener = function () {
10104 this.getElementWindow().removeEventListener( 'mousedown', this.onMouseDownHandler
, true );
10108 * Set whether to show a anchor.
10110 * @param {boolean} [show] Show anchor, omit to toggle
10112 OO
.ui
.PopupWidget
.prototype.toggleAnchor = function ( show
) {
10113 show
= show
=== undefined ? !this.anchored
: !!show
;
10115 if ( this.anchored
!== show
) {
10117 this.$element
.addClass( 'oo-ui-popupWidget-anchored' );
10119 this.$element
.removeClass( 'oo-ui-popupWidget-anchored' );
10121 this.anchored
= show
;
10126 * Check if showing a anchor.
10128 * @return {boolean} anchor is visible
10130 OO
.ui
.PopupWidget
.prototype.hasAnchor = function () {
10131 return this.anchor
;
10137 OO
.ui
.PopupWidget
.prototype.toggle = function ( show
) {
10138 show
= show
=== undefined ? !this.isVisible() : !!show
;
10140 var change
= show
!== this.isVisible();
10143 OO
.ui
.PopupWidget
.super.prototype.toggle
.call( this, show
);
10147 if ( this.autoClose
) {
10148 this.bindMouseDownListener();
10150 this.updateDimensions();
10151 this.toggleClipping( true );
10153 this.toggleClipping( false );
10154 if ( this.autoClose
) {
10155 this.unbindMouseDownListener();
10164 * Set the size of the popup.
10166 * Changing the size may also change the popup's position depending on the alignment.
10168 * @param {number} width Width
10169 * @param {number} height Height
10170 * @param {boolean} [transition=false] Use a smooth transition
10173 OO
.ui
.PopupWidget
.prototype.setSize = function ( width
, height
, transition
) {
10174 this.width
= width
;
10175 this.height
= height
!== undefined ? height
: null;
10176 if ( this.isVisible() ) {
10177 this.updateDimensions( transition
);
10182 * Update the size and position.
10184 * Only use this to keep the popup properly anchored. Use #setSize to change the size, and this will
10185 * be called automatically.
10187 * @param {boolean} [transition=false] Use a smooth transition
10190 OO
.ui
.PopupWidget
.prototype.updateDimensions = function ( transition
) {
10191 var popupOffset
, originOffset
, containerLeft
, containerWidth
, containerRight
,
10192 popupLeft
, popupRight
, overlapLeft
, overlapRight
, anchorWidth
,
10196 if ( !this.$container
) {
10197 // Lazy-initialize $container if not specified in constructor
10198 this.$container
= this.$( this.getClosestScrollableElementContainer() );
10201 // Set height and width before measuring things, since it might cause our measurements
10202 // to change (e.g. due to scrollbars appearing or disappearing)
10205 height
: this.height
!== null ? this.height
: 'auto'
10208 // Compute initial popupOffset based on alignment
10209 popupOffset
= this.width
* ( { left
: 0, center
: -0.5, right
: -1 } )[this.align
];
10211 // Figure out if this will cause the popup to go beyond the edge of the container
10212 originOffset
= Math
.round( this.$element
.offset().left
);
10213 containerLeft
= Math
.round( this.$container
.offset().left
);
10214 containerWidth
= this.$container
.innerWidth();
10215 containerRight
= containerLeft
+ containerWidth
;
10216 popupLeft
= popupOffset
- padding
;
10217 popupRight
= popupOffset
+ padding
+ this.width
+ padding
;
10218 overlapLeft
= ( originOffset
+ popupLeft
) - containerLeft
;
10219 overlapRight
= containerRight
- ( originOffset
+ popupRight
);
10221 // Adjust offset to make the popup not go beyond the edge, if needed
10222 if ( overlapRight
< 0 ) {
10223 popupOffset
+= overlapRight
;
10224 } else if ( overlapLeft
< 0 ) {
10225 popupOffset
-= overlapLeft
;
10228 // Adjust offset to avoid anchor being rendered too close to the edge
10229 anchorWidth
= this.$anchor
.width();
10230 if ( this.align
=== 'right' ) {
10231 popupOffset
+= anchorWidth
;
10232 } else if ( this.align
=== 'left' ) {
10233 popupOffset
-= anchorWidth
;
10236 // Prevent transition from being interrupted
10237 clearTimeout( this.transitionTimeout
);
10238 if ( transition
) {
10239 // Enable transition
10240 this.$element
.addClass( 'oo-ui-popupWidget-transitioning' );
10243 // Position body relative to anchor
10244 this.$popup
.css( 'margin-left', popupOffset
);
10246 if ( transition
) {
10247 // Prevent transitioning after transition is complete
10248 this.transitionTimeout
= setTimeout( function () {
10249 widget
.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
10252 // Prevent transitioning immediately
10253 this.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
10256 // Reevaluate clipping state since we've relocated and resized the popup
10265 * Search widgets combine a query input, placed above, and a results selection widget, placed below.
10266 * Results are cleared and populated each time the query is changed.
10269 * @extends OO.ui.Widget
10272 * @param {Object} [config] Configuration options
10273 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
10274 * @cfg {string} [value] Initial query value
10276 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
10277 // Configuration intialization
10278 config
= config
|| {};
10280 // Parent constructor
10281 OO
.ui
.SearchWidget
.super.call( this, config
);
10284 this.query
= new OO
.ui
.TextInputWidget( {
10287 placeholder
: config
.placeholder
,
10288 value
: config
.value
10290 this.results
= new OO
.ui
.SelectWidget( { $: this.$ } );
10291 this.$query
= this.$( '<div>' );
10292 this.$results
= this.$( '<div>' );
10295 this.query
.connect( this, {
10296 change
: 'onQueryChange',
10297 enter
: 'onQueryEnter'
10299 this.results
.connect( this, {
10300 highlight
: 'onResultsHighlight',
10301 select
: 'onResultsSelect'
10303 this.query
.$input
.on( 'keydown', OO
.ui
.bind( this.onQueryKeydown
, this ) );
10307 .addClass( 'oo-ui-searchWidget-query' )
10308 .append( this.query
.$element
);
10310 .addClass( 'oo-ui-searchWidget-results' )
10311 .append( this.results
.$element
);
10313 .addClass( 'oo-ui-searchWidget' )
10314 .append( this.$results
, this.$query
);
10319 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
10325 * @param {Object|null} item Item data or null if no item is highlighted
10330 * @param {Object|null} item Item data or null if no item is selected
10336 * Handle query key down events.
10338 * @param {jQuery.Event} e Key down event
10340 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
10341 var highlightedItem
, nextItem
,
10342 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
10345 highlightedItem
= this.results
.getHighlightedItem();
10346 if ( !highlightedItem
) {
10347 highlightedItem
= this.results
.getSelectedItem();
10349 nextItem
= this.results
.getRelativeSelectableItem( highlightedItem
, dir
);
10350 this.results
.highlightItem( nextItem
);
10351 nextItem
.scrollElementIntoView();
10356 * Handle select widget select events.
10358 * Clears existing results. Subclasses should repopulate items according to new query.
10360 * @param {string} value New value
10362 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
10364 this.results
.clearItems();
10368 * Handle select widget enter key events.
10370 * Selects highlighted item.
10372 * @param {string} value New value
10374 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
10376 this.results
.selectItem( this.results
.getHighlightedItem() );
10380 * Handle select widget highlight events.
10382 * @param {OO.ui.OptionWidget} item Highlighted item
10385 OO
.ui
.SearchWidget
.prototype.onResultsHighlight = function ( item
) {
10386 this.emit( 'highlight', item
? item
.getData() : null );
10390 * Handle select widget select events.
10392 * @param {OO.ui.OptionWidget} item Selected item
10395 OO
.ui
.SearchWidget
.prototype.onResultsSelect = function ( item
) {
10396 this.emit( 'select', item
? item
.getData() : null );
10400 * Get the query input.
10402 * @return {OO.ui.TextInputWidget} Query input
10404 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
10409 * Get the results list.
10411 * @return {OO.ui.SelectWidget} Select list
10413 OO
.ui
.SearchWidget
.prototype.getResults = function () {
10414 return this.results
;
10418 * Generic selection of options.
10420 * Items can contain any rendering, and are uniquely identified by a has of thier data. Any widget
10421 * that provides options, from which the user must choose one, should be built on this class.
10423 * Use together with OO.ui.OptionWidget.
10426 * @extends OO.ui.Widget
10427 * @mixins OO.ui.GroupElement
10430 * @param {Object} [config] Configuration options
10431 * @cfg {OO.ui.OptionWidget[]} [items] Options to add
10433 OO
.ui
.SelectWidget
= function OoUiSelectWidget( config
) {
10434 // Config intialization
10435 config
= config
|| {};
10437 // Parent constructor
10438 OO
.ui
.SelectWidget
.super.call( this, config
);
10440 // Mixin constructors
10441 OO
.ui
.GroupWidget
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
10444 this.pressed
= false;
10445 this.selecting
= null;
10447 this.onMouseUpHandler
= OO
.ui
.bind( this.onMouseUp
, this );
10448 this.onMouseMoveHandler
= OO
.ui
.bind( this.onMouseMove
, this );
10451 this.$element
.on( {
10452 mousedown
: OO
.ui
.bind( this.onMouseDown
, this ),
10453 mouseover
: OO
.ui
.bind( this.onMouseOver
, this ),
10454 mouseleave
: OO
.ui
.bind( this.onMouseLeave
, this )
10458 this.$element
.addClass( 'oo-ui-selectWidget oo-ui-selectWidget-depressed' );
10459 if ( $.isArray( config
.items
) ) {
10460 this.addItems( config
.items
);
10466 OO
.inheritClass( OO
.ui
.SelectWidget
, OO
.ui
.Widget
);
10468 // Need to mixin base class as well
10469 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupElement
);
10470 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupWidget
);
10476 * @param {OO.ui.OptionWidget|null} item Highlighted item
10481 * @param {OO.ui.OptionWidget|null} item Pressed item
10486 * @param {OO.ui.OptionWidget|null} item Selected item
10491 * @param {OO.ui.OptionWidget|null} item Chosen item
10496 * @param {OO.ui.OptionWidget[]} items Added items
10497 * @param {number} index Index items were added at
10502 * @param {OO.ui.OptionWidget[]} items Removed items
10508 * Handle mouse down events.
10511 * @param {jQuery.Event} e Mouse down event
10513 OO
.ui
.SelectWidget
.prototype.onMouseDown = function ( e
) {
10516 if ( !this.isDisabled() && e
.which
=== 1 ) {
10517 this.togglePressed( true );
10518 item
= this.getTargetItem( e
);
10519 if ( item
&& item
.isSelectable() ) {
10520 this.pressItem( item
);
10521 this.selecting
= item
;
10522 this.getElementDocument().addEventListener(
10524 this.onMouseUpHandler
,
10527 this.getElementDocument().addEventListener(
10529 this.onMouseMoveHandler
,
10538 * Handle mouse up events.
10541 * @param {jQuery.Event} e Mouse up event
10543 OO
.ui
.SelectWidget
.prototype.onMouseUp = function ( e
) {
10546 this.togglePressed( false );
10547 if ( !this.selecting
) {
10548 item
= this.getTargetItem( e
);
10549 if ( item
&& item
.isSelectable() ) {
10550 this.selecting
= item
;
10553 if ( !this.isDisabled() && e
.which
=== 1 && this.selecting
) {
10554 this.pressItem( null );
10555 this.chooseItem( this.selecting
);
10556 this.selecting
= null;
10559 this.getElementDocument().removeEventListener(
10561 this.onMouseUpHandler
,
10564 this.getElementDocument().removeEventListener(
10566 this.onMouseMoveHandler
,
10574 * Handle mouse move events.
10577 * @param {jQuery.Event} e Mouse move event
10579 OO
.ui
.SelectWidget
.prototype.onMouseMove = function ( e
) {
10582 if ( !this.isDisabled() && this.pressed
) {
10583 item
= this.getTargetItem( e
);
10584 if ( item
&& item
!== this.selecting
&& item
.isSelectable() ) {
10585 this.pressItem( item
);
10586 this.selecting
= item
;
10593 * Handle mouse over events.
10596 * @param {jQuery.Event} e Mouse over event
10598 OO
.ui
.SelectWidget
.prototype.onMouseOver = function ( e
) {
10601 if ( !this.isDisabled() ) {
10602 item
= this.getTargetItem( e
);
10603 this.highlightItem( item
&& item
.isHighlightable() ? item
: null );
10609 * Handle mouse leave events.
10612 * @param {jQuery.Event} e Mouse over event
10614 OO
.ui
.SelectWidget
.prototype.onMouseLeave = function () {
10615 if ( !this.isDisabled() ) {
10616 this.highlightItem( null );
10622 * Get the closest item to a jQuery.Event.
10625 * @param {jQuery.Event} e
10626 * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
10628 OO
.ui
.SelectWidget
.prototype.getTargetItem = function ( e
) {
10629 var $item
= this.$( e
.target
).closest( '.oo-ui-optionWidget' );
10630 if ( $item
.length
) {
10631 return $item
.data( 'oo-ui-optionWidget' );
10637 * Get selected item.
10639 * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
10641 OO
.ui
.SelectWidget
.prototype.getSelectedItem = function () {
10644 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
10645 if ( this.items
[i
].isSelected() ) {
10646 return this.items
[i
];
10653 * Get highlighted item.
10655 * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
10657 OO
.ui
.SelectWidget
.prototype.getHighlightedItem = function () {
10660 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
10661 if ( this.items
[i
].isHighlighted() ) {
10662 return this.items
[i
];
10669 * Get an existing item with equivilant data.
10671 * @param {Object} data Item data to search for
10672 * @return {OO.ui.OptionWidget|null} Item with equivilent value, `null` if none exists
10674 OO
.ui
.SelectWidget
.prototype.getItemFromData = function ( data
) {
10675 var hash
= OO
.getHash( data
);
10677 if ( hash
in this.hashes
) {
10678 return this.hashes
[hash
];
10685 * Toggle pressed state.
10687 * @param {boolean} pressed An option is being pressed
10689 OO
.ui
.SelectWidget
.prototype.togglePressed = function ( pressed
) {
10690 if ( pressed
=== undefined ) {
10691 pressed
= !this.pressed
;
10693 if ( pressed
!== this.pressed
) {
10695 .toggleClass( 'oo-ui-selectWidget-pressed', pressed
)
10696 .toggleClass( 'oo-ui-selectWidget-depressed', !pressed
);
10697 this.pressed
= pressed
;
10702 * Highlight an item.
10704 * Highlighting is mutually exclusive.
10706 * @param {OO.ui.OptionWidget} [item] Item to highlight, omit to deselect all
10710 OO
.ui
.SelectWidget
.prototype.highlightItem = function ( item
) {
10711 var i
, len
, highlighted
,
10714 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
10715 highlighted
= this.items
[i
] === item
;
10716 if ( this.items
[i
].isHighlighted() !== highlighted
) {
10717 this.items
[i
].setHighlighted( highlighted
);
10722 this.emit( 'highlight', item
);
10731 * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
10735 OO
.ui
.SelectWidget
.prototype.selectItem = function ( item
) {
10736 var i
, len
, selected
,
10739 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
10740 selected
= this.items
[i
] === item
;
10741 if ( this.items
[i
].isSelected() !== selected
) {
10742 this.items
[i
].setSelected( selected
);
10747 this.emit( 'select', item
);
10756 * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
10760 OO
.ui
.SelectWidget
.prototype.pressItem = function ( item
) {
10761 var i
, len
, pressed
,
10764 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
10765 pressed
= this.items
[i
] === item
;
10766 if ( this.items
[i
].isPressed() !== pressed
) {
10767 this.items
[i
].setPressed( pressed
);
10772 this.emit( 'press', item
);
10781 * Identical to #selectItem, but may vary in subclasses that want to take additional action when
10782 * an item is selected using the keyboard or mouse.
10784 * @param {OO.ui.OptionWidget} item Item to choose
10788 OO
.ui
.SelectWidget
.prototype.chooseItem = function ( item
) {
10789 this.selectItem( item
);
10790 this.emit( 'choose', item
);
10796 * Get an item relative to another one.
10798 * @param {OO.ui.OptionWidget} item Item to start at
10799 * @param {number} direction Direction to move in
10800 * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the menu
10802 OO
.ui
.SelectWidget
.prototype.getRelativeSelectableItem = function ( item
, direction
) {
10803 var inc
= direction
> 0 ? 1 : -1,
10804 len
= this.items
.length
,
10805 index
= item
instanceof OO
.ui
.OptionWidget
?
10806 $.inArray( item
, this.items
) : ( inc
> 0 ? -1 : 0 ),
10807 stopAt
= Math
.max( Math
.min( index
, len
- 1 ), 0 ),
10809 // Default to 0 instead of -1, if nothing is selected let's start at the beginning
10810 Math
.max( index
, -1 ) :
10811 // Default to n-1 instead of -1, if nothing is selected let's start at the end
10812 Math
.min( index
, len
);
10814 while ( len
!== 0 ) {
10815 i
= ( i
+ inc
+ len
) % len
;
10816 item
= this.items
[i
];
10817 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
10820 // Stop iterating when we've looped all the way around
10821 if ( i
=== stopAt
) {
10829 * Get the next selectable item.
10831 * @return {OO.ui.OptionWidget|null} Item, `null` if ther aren't any selectable items
10833 OO
.ui
.SelectWidget
.prototype.getFirstSelectableItem = function () {
10836 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
10837 item
= this.items
[i
];
10838 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
10849 * When items are added with the same values as existing items, the existing items will be
10850 * automatically removed before the new items are added.
10852 * @param {OO.ui.OptionWidget[]} items Items to add
10853 * @param {number} [index] Index to insert items after
10857 OO
.ui
.SelectWidget
.prototype.addItems = function ( items
, index
) {
10858 var i
, len
, item
, hash
,
10861 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
10863 hash
= OO
.getHash( item
.getData() );
10864 if ( hash
in this.hashes
) {
10865 // Remove item with same value
10866 remove
.push( this.hashes
[hash
] );
10868 this.hashes
[hash
] = item
;
10870 if ( remove
.length
) {
10871 this.removeItems( remove
);
10875 OO
.ui
.GroupWidget
.prototype.addItems
.call( this, items
, index
);
10877 // Always provide an index, even if it was omitted
10878 this.emit( 'add', items
, index
=== undefined ? this.items
.length
- items
.length
- 1 : index
);
10886 * Items will be detached, not removed, so they can be used later.
10888 * @param {OO.ui.OptionWidget[]} items Items to remove
10892 OO
.ui
.SelectWidget
.prototype.removeItems = function ( items
) {
10893 var i
, len
, item
, hash
;
10895 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
10897 hash
= OO
.getHash( item
.getData() );
10898 if ( hash
in this.hashes
) {
10899 // Remove existing item
10900 delete this.hashes
[hash
];
10902 if ( item
.isSelected() ) {
10903 this.selectItem( null );
10908 OO
.ui
.GroupWidget
.prototype.removeItems
.call( this, items
);
10910 this.emit( 'remove', items
);
10918 * Items will be detached, not removed, so they can be used later.
10923 OO
.ui
.SelectWidget
.prototype.clearItems = function () {
10924 var items
= this.items
.slice();
10929 OO
.ui
.GroupWidget
.prototype.clearItems
.call( this );
10930 this.selectItem( null );
10932 this.emit( 'remove', items
);
10938 * Select widget containing button options.
10940 * Use together with OO.ui.ButtonOptionWidget.
10943 * @extends OO.ui.SelectWidget
10946 * @param {Object} [config] Configuration options
10948 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
10949 // Parent constructor
10950 OO
.ui
.ButtonSelectWidget
.super.call( this, config
);
10953 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
10958 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
10961 * Overlaid menu of options.
10963 * Menus are clipped to the visible viewport. They do not provide a control for opening or closing
10966 * Use together with OO.ui.MenuItemWidget.
10969 * @extends OO.ui.SelectWidget
10970 * @mixins OO.ui.ClippableElement
10973 * @param {Object} [config] Configuration options
10974 * @cfg {OO.ui.InputWidget} [input] Input to bind keyboard handlers to
10975 * @cfg {OO.ui.Widget} [widget] Widget to bind mouse handlers to
10976 * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu
10978 OO
.ui
.MenuWidget
= function OoUiMenuWidget( config
) {
10979 // Config intialization
10980 config
= config
|| {};
10982 // Parent constructor
10983 OO
.ui
.MenuWidget
.super.call( this, config
);
10985 // Mixin constructors
10986 OO
.ui
.ClippableElement
.call( this, $.extend( {}, config
, { $clippable
: this.$group
} ) );
10989 this.flashing
= false;
10990 this.visible
= false;
10991 this.newItems
= null;
10992 this.autoHide
= config
.autoHide
=== undefined || !!config
.autoHide
;
10993 this.$input
= config
.input
? config
.input
.$input
: null;
10994 this.$widget
= config
.widget
? config
.widget
.$element
: null;
10995 this.$previousFocus
= null;
10996 this.isolated
= !config
.input
;
10997 this.onKeyDownHandler
= OO
.ui
.bind( this.onKeyDown
, this );
10998 this.onDocumentMouseDownHandler
= OO
.ui
.bind( this.onDocumentMouseDown
, this );
11003 .attr( 'role', 'menu' )
11004 .addClass( 'oo-ui-menuWidget' );
11009 OO
.inheritClass( OO
.ui
.MenuWidget
, OO
.ui
.SelectWidget
);
11010 OO
.mixinClass( OO
.ui
.MenuWidget
, OO
.ui
.ClippableElement
);
11015 * Handles document mouse down events.
11017 * @param {jQuery.Event} e Key down event
11019 OO
.ui
.MenuWidget
.prototype.onDocumentMouseDown = function ( e
) {
11020 if ( !$.contains( this.$element
[0], e
.target
) && ( !this.$widget
|| !$.contains( this.$widget
[0], e
.target
) ) ) {
11021 this.toggle( false );
11026 * Handles key down events.
11028 * @param {jQuery.Event} e Key down event
11030 OO
.ui
.MenuWidget
.prototype.onKeyDown = function ( e
) {
11033 highlightItem
= this.getHighlightedItem();
11035 if ( !this.isDisabled() && this.isVisible() ) {
11036 if ( !highlightItem
) {
11037 highlightItem
= this.getSelectedItem();
11039 switch ( e
.keyCode
) {
11040 case OO
.ui
.Keys
.ENTER
:
11041 this.chooseItem( highlightItem
);
11044 case OO
.ui
.Keys
.UP
:
11045 nextItem
= this.getRelativeSelectableItem( highlightItem
, -1 );
11048 case OO
.ui
.Keys
.DOWN
:
11049 nextItem
= this.getRelativeSelectableItem( highlightItem
, 1 );
11052 case OO
.ui
.Keys
.ESCAPE
:
11053 if ( highlightItem
) {
11054 highlightItem
.setHighlighted( false );
11056 this.toggle( false );
11062 this.highlightItem( nextItem
);
11063 nextItem
.scrollElementIntoView();
11067 e
.preventDefault();
11068 e
.stopPropagation();
11075 * Bind key down listener.
11077 OO
.ui
.MenuWidget
.prototype.bindKeyDownListener = function () {
11078 if ( this.$input
) {
11079 this.$input
.on( 'keydown', this.onKeyDownHandler
);
11081 // Capture menu navigation keys
11082 this.getElementWindow().addEventListener( 'keydown', this.onKeyDownHandler
, true );
11087 * Unbind key down listener.
11089 OO
.ui
.MenuWidget
.prototype.unbindKeyDownListener = function () {
11090 if ( this.$input
) {
11091 this.$input
.off( 'keydown' );
11093 this.getElementWindow().removeEventListener( 'keydown', this.onKeyDownHandler
, true );
11100 * This will close the menu when done, unlike selectItem which only changes selection.
11102 * @param {OO.ui.OptionWidget} item Item to choose
11105 OO
.ui
.MenuWidget
.prototype.chooseItem = function ( item
) {
11109 OO
.ui
.MenuWidget
.super.prototype.chooseItem
.call( this, item
);
11111 if ( item
&& !this.flashing
) {
11112 this.flashing
= true;
11113 item
.flash().done( function () {
11114 widget
.toggle( false );
11115 widget
.flashing
= false;
11118 this.toggle( false );
11127 OO
.ui
.MenuWidget
.prototype.addItems = function ( items
, index
) {
11131 OO
.ui
.MenuWidget
.super.prototype.addItems
.call( this, items
, index
);
11134 if ( !this.newItems
) {
11135 this.newItems
= [];
11138 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
11140 if ( this.isVisible() ) {
11141 // Defer fitting label until item has been attached
11144 this.newItems
.push( item
);
11148 // Reevaluate clipping
11157 OO
.ui
.MenuWidget
.prototype.removeItems = function ( items
) {
11159 OO
.ui
.MenuWidget
.super.prototype.removeItems
.call( this, items
);
11161 // Reevaluate clipping
11170 OO
.ui
.MenuWidget
.prototype.clearItems = function () {
11172 OO
.ui
.MenuWidget
.super.prototype.clearItems
.call( this );
11174 // Reevaluate clipping
11183 OO
.ui
.MenuWidget
.prototype.toggle = function ( visible
) {
11184 visible
= ( visible
=== undefined ? !this.visible
: !!visible
) && !!this.items
.length
;
11187 change
= visible
!== this.isVisible();
11190 OO
.ui
.MenuWidget
.super.prototype.toggle
.call( this, visible
);
11194 this.bindKeyDownListener();
11196 // Change focus to enable keyboard navigation
11197 if ( this.isolated
&& this.$input
&& !this.$input
.is( ':focus' ) ) {
11198 this.$previousFocus
= this.$( ':focus' );
11199 this.$input
[0].focus();
11201 if ( this.newItems
&& this.newItems
.length
) {
11202 for ( i
= 0, len
= this.newItems
.length
; i
< len
; i
++ ) {
11203 this.newItems
[i
].fitLabel();
11205 this.newItems
= null;
11207 this.toggleClipping( true );
11210 if ( this.autoHide
) {
11211 this.getElementDocument().addEventListener(
11212 'mousedown', this.onDocumentMouseDownHandler
, true
11216 this.unbindKeyDownListener();
11217 if ( this.isolated
&& this.$previousFocus
) {
11218 this.$previousFocus
[0].focus();
11219 this.$previousFocus
= null;
11221 this.getElementDocument().removeEventListener(
11222 'mousedown', this.onDocumentMouseDownHandler
, true
11224 this.toggleClipping( false );
11232 * Menu for a text input widget.
11234 * This menu is specially designed to be positioned beneath the text input widget. Even if the input
11235 * is in a different frame, the menu's position is automatically calulated and maintained when the
11236 * menu is toggled or the window is resized.
11239 * @extends OO.ui.MenuWidget
11242 * @param {OO.ui.TextInputWidget} input Text input widget to provide menu for
11243 * @param {Object} [config] Configuration options
11244 * @cfg {jQuery} [$container=input.$element] Element to render menu under
11246 OO
.ui
.TextInputMenuWidget
= function OoUiTextInputMenuWidget( input
, config
) {
11247 // Parent constructor
11248 OO
.ui
.TextInputMenuWidget
.super.call( this, config
);
11251 this.input
= input
;
11252 this.$container
= config
.$container
|| this.input
.$element
;
11253 this.onWindowResizeHandler
= OO
.ui
.bind( this.onWindowResize
, this );
11256 this.$element
.addClass( 'oo-ui-textInputMenuWidget' );
11261 OO
.inheritClass( OO
.ui
.TextInputMenuWidget
, OO
.ui
.MenuWidget
);
11266 * Handle window resize event.
11268 * @param {jQuery.Event} e Window resize event
11270 OO
.ui
.TextInputMenuWidget
.prototype.onWindowResize = function () {
11277 OO
.ui
.TextInputMenuWidget
.prototype.toggle = function ( visible
) {
11278 visible
= !!visible
;
11280 var change
= visible
!== this.isVisible();
11282 if ( change
&& visible
) {
11283 // Make sure the width is set before the parent method runs.
11284 // After this we have to call this.position(); again to actually
11285 // position ourselves correctly.
11290 OO
.ui
.TextInputMenuWidget
.super.prototype.toggle
.call( this, visible
);
11293 if ( this.isVisible() ) {
11295 this.$( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler
);
11297 this.$( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler
);
11305 * Position the menu.
11309 OO
.ui
.TextInputMenuWidget
.prototype.position = function () {
11311 $container
= this.$container
,
11312 dimensions
= $container
.offset();
11314 // Position under input
11315 dimensions
.top
+= $container
.height();
11317 // Compensate for frame position if in a differnt frame
11318 if ( this.input
.$.$iframe
&& this.input
.$.context
!== this.$element
[0].ownerDocument
) {
11319 frameOffset
= OO
.ui
.Element
.getRelativePosition(
11320 this.input
.$.$iframe
, this.$element
.offsetParent()
11322 dimensions
.left
+= frameOffset
.left
;
11323 dimensions
.top
+= frameOffset
.top
;
11325 // Fix for RTL (for some reason, no need to fix if the frameoffset is set)
11326 if ( this.$element
.css( 'direction' ) === 'rtl' ) {
11327 dimensions
.right
= this.$element
.parent().position().left
-
11328 $container
.width() - dimensions
.left
;
11329 // Erase the value for 'left':
11330 delete dimensions
.left
;
11333 this.$element
.css( dimensions
);
11334 this.setIdealSize( $container
.width() );
11335 // We updated the position, so re-evaluate the clipping state
11342 * Structured list of items.
11344 * Use with OO.ui.OutlineItemWidget.
11347 * @extends OO.ui.SelectWidget
11350 * @param {Object} [config] Configuration options
11352 OO
.ui
.OutlineWidget
= function OoUiOutlineWidget( config
) {
11353 // Config intialization
11354 config
= config
|| {};
11356 // Parent constructor
11357 OO
.ui
.OutlineWidget
.super.call( this, config
);
11360 this.$element
.addClass( 'oo-ui-outlineWidget' );
11365 OO
.inheritClass( OO
.ui
.OutlineWidget
, OO
.ui
.SelectWidget
);
11368 * Switch that slides on and off.
11371 * @extends OO.ui.Widget
11372 * @mixins OO.ui.ToggleWidget
11375 * @param {Object} [config] Configuration options
11376 * @cfg {boolean} [value=false] Initial value
11378 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
11379 // Parent constructor
11380 OO
.ui
.ToggleSwitchWidget
.super.call( this, config
);
11382 // Mixin constructors
11383 OO
.ui
.ToggleWidget
.call( this, config
);
11386 this.dragging
= false;
11387 this.dragStart
= null;
11388 this.sliding
= false;
11389 this.$glow
= this.$( '<span>' );
11390 this.$grip
= this.$( '<span>' );
11393 this.$element
.on( 'click', OO
.ui
.bind( this.onClick
, this ) );
11396 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
11397 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
11399 .addClass( 'oo-ui-toggleSwitchWidget' )
11400 .append( this.$glow
, this.$grip
);
11405 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.Widget
);
11406 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
11411 * Handle mouse down events.
11413 * @param {jQuery.Event} e Mouse down event
11415 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
11416 if ( !this.isDisabled() && e
.which
=== 1 ) {
11417 this.setValue( !this.value
);