2 * OOjs UI v0.1.0-pre (7922a50558)
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-11-19T23:18:49Z
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
97 * Check if a node is contained within another node
99 * Similar to jQuery#contains except a list of containers can be supplied
100 * and a boolean argument allows you to include the container in the match list
102 * @param {HTMLElement|HTMLElement[]} containers Container node(s) to search in
103 * @param {HTMLElement} contained Node to find
104 * @param {boolean} [matchContainers] Include the container(s) in the list of nodes to match, otherwise only match descendents
105 * @return {boolean} The node is in the list of target nodes
107 OO
.ui
.contains = function ( containers
, contained
, matchContainers
) {
109 if ( !Array
.isArray( containers
) ) {
110 containers
= [ containers
];
112 for ( i
= containers
.length
- 1; i
>= 0; i
-- ) {
113 if ( ( matchContainers
&& contained
=== containers
[i
] ) || $.contains( containers
[i
], contained
) ) {
122 * Message store for the default implementation of OO.ui.msg
124 * Environments that provide a localization system should not use this, but should override
125 * OO.ui.msg altogether.
130 // Tool tip for a button that moves items in a list down one place
131 'ooui-outline-control-move-down': 'Move item down',
132 // Tool tip for a button that moves items in a list up one place
133 'ooui-outline-control-move-up': 'Move item up',
134 // Tool tip for a button that removes items from a list
135 'ooui-outline-control-remove': 'Remove item',
136 // Label for the toolbar group that contains a list of all other available tools
137 'ooui-toolbar-more': 'More',
138 // Label for the fake tool that expands the full list of tools in a toolbar group
139 'ooui-toolgroup-expand': 'More',
140 // Label for the fake tool that collapses the full list of tools in a toolbar group
141 'ooui-toolgroup-collapse': 'Fewer',
142 // Default label for the accept button of a confirmation dialog
143 'ooui-dialog-message-accept': 'OK',
144 // Default label for the reject button of a confirmation dialog
145 'ooui-dialog-message-reject': 'Cancel',
146 // Title for process dialog error description
147 'ooui-dialog-process-error': 'Something went wrong',
148 // Label for process dialog dismiss error button, visible when describing errors
149 'ooui-dialog-process-dismiss': 'Dismiss',
150 // Label for process dialog retry action button, visible when describing only recoverable errors
151 'ooui-dialog-process-retry': 'Try again',
152 // Label for process dialog retry action button, visible when describing only warnings
153 'ooui-dialog-process-continue': 'Continue'
157 * Get a localized message.
159 * In environments that provide a localization system, this function should be overridden to
160 * return the message translated in the user's language. The default implementation always returns
163 * After the message key, message parameters may optionally be passed. In the default implementation,
164 * any occurrences of $1 are replaced with the first parameter, $2 with the second parameter, etc.
165 * Alternative implementations of OO.ui.msg may use any substitution system they like, as long as
166 * they support unnamed, ordered message parameters.
169 * @param {string} key Message key
170 * @param {Mixed...} [params] Message parameters
171 * @return {string} Translated message with parameters substituted
173 OO
.ui
.msg = function ( key
) {
174 var message
= messages
[key
], params
= Array
.prototype.slice
.call( arguments
, 1 );
175 if ( typeof message
=== 'string' ) {
176 // Perform $1 substitution
177 message
= message
.replace( /\$(\d+)/g, function ( unused
, n
) {
178 var i
= parseInt( n
, 10 );
179 return params
[i
- 1] !== undefined ? params
[i
- 1] : '$' + n
;
182 // Return placeholder if message not found
183 message
= '[' + key
+ ']';
189 * Package a message and arguments for deferred resolution.
191 * Use this when you are statically specifying a message and the message may not yet be present.
193 * @param {string} key Message key
194 * @param {Mixed...} [params] Message parameters
195 * @return {Function} Function that returns the resolved message when executed
197 OO
.ui
.deferMsg = function () {
198 var args
= arguments
;
200 return OO
.ui
.msg
.apply( OO
.ui
, args
);
207 * If the message is a function it will be executed, otherwise it will pass through directly.
209 * @param {Function|string} msg Deferred message, or message text
210 * @return {string} Resolved message
212 OO
.ui
.resolveMsg = function ( msg
) {
213 if ( $.isFunction( msg
) ) {
222 * Element that can be marked as pending.
228 * @param {Object} [config] Configuration options
229 * @cfg {jQuery} [$pending] Element to mark as pending, defaults to this.$element
231 OO
.ui
.PendingElement
= function OoUiPendingElement( config
) {
232 // Configuration initialization
233 config
= config
|| {};
237 this.$pending
= null;
240 this.setPendingElement( config
.$pending
|| this.$element
);
245 OO
.initClass( OO
.ui
.PendingElement
);
250 * Set the pending element (and clean up any existing one).
252 * @param {jQuery} $pending The element to set to pending.
254 OO
.ui
.PendingElement
.prototype.setPendingElement = function ( $pending
) {
255 if ( this.$pending
) {
256 this.$pending
.removeClass( 'oo-ui-pendingElement-pending' );
259 this.$pending
= $pending
;
260 if ( this.pending
> 0 ) {
261 this.$pending
.addClass( 'oo-ui-pendingElement-pending' );
266 * Check if input is pending.
270 OO
.ui
.PendingElement
.prototype.isPending = function () {
271 return !!this.pending
;
275 * Increase the pending stack.
279 OO
.ui
.PendingElement
.prototype.pushPending = function () {
280 if ( this.pending
=== 0 ) {
281 this.$pending
.addClass( 'oo-ui-pendingElement-pending' );
282 this.updateThemeClasses();
290 * Reduce the pending stack.
296 OO
.ui
.PendingElement
.prototype.popPending = function () {
297 if ( this.pending
=== 1 ) {
298 this.$pending
.removeClass( 'oo-ui-pendingElement-pending' );
299 this.updateThemeClasses();
301 this.pending
= Math
.max( 0, this.pending
- 1 );
311 * @mixins OO.EventEmitter
314 * @param {Object} [config] Configuration options
316 OO
.ui
.ActionSet
= function OoUiActionSet( config
) {
317 // Configuration intialization
318 config
= config
|| {};
320 // Mixin constructors
321 OO
.EventEmitter
.call( this );
326 actions
: 'getAction',
330 this.categorized
= {};
333 this.organized
= false;
334 this.changing
= false;
335 this.changed
= false;
340 OO
.mixinClass( OO
.ui
.ActionSet
, OO
.EventEmitter
);
342 /* Static Properties */
345 * Symbolic name of dialog.
352 OO
.ui
.ActionSet
.static.specialFlags
= [ 'safe', 'primary' ];
358 * @param {OO.ui.ActionWidget} action Action that was clicked
363 * @param {OO.ui.ActionWidget} action Action that was resized
368 * @param {OO.ui.ActionWidget[]} added Actions added
373 * @param {OO.ui.ActionWidget[]} added Actions removed
383 * Handle action change events.
387 OO
.ui
.ActionSet
.prototype.onActionChange = function () {
388 this.organized
= false;
389 if ( this.changing
) {
392 this.emit( 'change' );
397 * Check if a action is one of the special actions.
399 * @param {OO.ui.ActionWidget} action Action to check
400 * @return {boolean} Action is special
402 OO
.ui
.ActionSet
.prototype.isSpecial = function ( action
) {
405 for ( flag
in this.special
) {
406 if ( action
=== this.special
[flag
] ) {
417 * @param {Object} [filters] Filters to use, omit to get all actions
418 * @param {string|string[]} [filters.actions] Actions that actions must have
419 * @param {string|string[]} [filters.flags] Flags that actions must have
420 * @param {string|string[]} [filters.modes] Modes that actions must have
421 * @param {boolean} [filters.visible] Actions must be visible
422 * @param {boolean} [filters.disabled] Actions must be disabled
423 * @return {OO.ui.ActionWidget[]} Actions matching all criteria
425 OO
.ui
.ActionSet
.prototype.get = function ( filters
) {
426 var i
, len
, list
, category
, actions
, index
, match
, matches
;
431 // Collect category candidates
433 for ( category
in this.categorized
) {
434 list
= filters
[category
];
436 if ( !Array
.isArray( list
) ) {
439 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
440 actions
= this.categorized
[category
][list
[i
]];
441 if ( Array
.isArray( actions
) ) {
442 matches
.push
.apply( matches
, actions
);
447 // Remove by boolean filters
448 for ( i
= 0, len
= matches
.length
; i
< len
; i
++ ) {
451 ( filters
.visible
!== undefined && match
.isVisible() !== filters
.visible
) ||
452 ( filters
.disabled
!== undefined && match
.isDisabled() !== filters
.disabled
)
454 matches
.splice( i
, 1 );
460 for ( i
= 0, len
= matches
.length
; i
< len
; i
++ ) {
462 index
= matches
.lastIndexOf( match
);
463 while ( index
!== i
) {
464 matches
.splice( index
, 1 );
466 index
= matches
.lastIndexOf( match
);
471 return this.list
.slice();
475 * Get special actions.
477 * Special actions are the first visible actions with special flags, such as 'safe' and 'primary'.
478 * Special flags can be configured by changing #static-specialFlags in a subclass.
480 * @return {OO.ui.ActionWidget|null} Safe action
482 OO
.ui
.ActionSet
.prototype.getSpecial = function () {
484 return $.extend( {}, this.special
);
490 * Other actions include all non-special visible actions.
492 * @return {OO.ui.ActionWidget[]} Other actions
494 OO
.ui
.ActionSet
.prototype.getOthers = function () {
496 return this.others
.slice();
500 * Toggle actions based on their modes.
502 * Unlike calling toggle on actions with matching flags, this will enforce mutually exclusive
503 * visibility; matching actions will be shown, non-matching actions will be hidden.
505 * @param {string} mode Mode actions must have
510 OO
.ui
.ActionSet
.prototype.setMode = function ( mode
) {
513 this.changing
= true;
514 for ( i
= 0, len
= this.list
.length
; i
< len
; i
++ ) {
515 action
= this.list
[i
];
516 action
.toggle( action
.hasMode( mode
) );
519 this.organized
= false;
520 this.changing
= false;
521 this.emit( 'change' );
527 * Change which actions are able to be performed.
529 * Actions with matching actions will be disabled/enabled. Other actions will not be changed.
531 * @param {Object.<string,boolean>} actions List of abilities, keyed by action name, values
532 * indicate actions are able to be performed
535 OO
.ui
.ActionSet
.prototype.setAbilities = function ( actions
) {
536 var i
, len
, action
, item
;
538 for ( i
= 0, len
= this.list
.length
; i
< len
; i
++ ) {
540 action
= item
.getAction();
541 if ( actions
[action
] !== undefined ) {
542 item
.setDisabled( !actions
[action
] );
550 * Executes a function once per action.
552 * When making changes to multiple actions, use this method instead of iterating over the actions
553 * manually to defer emitting a change event until after all actions have been changed.
555 * @param {Object|null} actions Filters to use for which actions to iterate over; see #get
556 * @param {Function} callback Callback to run for each action; callback is invoked with three
557 * arguments: the action, the action's index, the list of actions being iterated over
560 OO
.ui
.ActionSet
.prototype.forEach = function ( filter
, callback
) {
561 this.changed
= false;
562 this.changing
= true;
563 this.get( filter
).forEach( callback
);
564 this.changing
= false;
565 if ( this.changed
) {
566 this.emit( 'change' );
575 * @param {OO.ui.ActionWidget[]} actions Actions to add
580 OO
.ui
.ActionSet
.prototype.add = function ( actions
) {
583 this.changing
= true;
584 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
586 action
.connect( this, {
587 click
: [ 'emit', 'click', action
],
588 resize
: [ 'emit', 'resize', action
],
589 toggle
: [ 'onActionChange' ]
591 this.list
.push( action
);
593 this.organized
= false;
594 this.emit( 'add', actions
);
595 this.changing
= false;
596 this.emit( 'change' );
604 * @param {OO.ui.ActionWidget[]} actions Actions to remove
609 OO
.ui
.ActionSet
.prototype.remove = function ( actions
) {
610 var i
, len
, index
, action
;
612 this.changing
= true;
613 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
615 index
= this.list
.indexOf( action
);
616 if ( index
!== -1 ) {
617 action
.disconnect( this );
618 this.list
.splice( index
, 1 );
621 this.organized
= false;
622 this.emit( 'remove', actions
);
623 this.changing
= false;
624 this.emit( 'change' );
630 * Remove all actions.
636 OO
.ui
.ActionSet
.prototype.clear = function () {
638 removed
= this.list
.slice();
640 this.changing
= true;
641 for ( i
= 0, len
= this.list
.length
; i
< len
; i
++ ) {
642 action
= this.list
[i
];
643 action
.disconnect( this );
648 this.organized
= false;
649 this.emit( 'remove', removed
);
650 this.changing
= false;
651 this.emit( 'change' );
659 * This is called whenver organized information is requested. It will only reorganize the actions
660 * if something has changed since the last time it ran.
665 OO
.ui
.ActionSet
.prototype.organize = function () {
666 var i
, iLen
, j
, jLen
, flag
, action
, category
, list
, item
, special
,
667 specialFlags
= this.constructor.static.specialFlags
;
669 if ( !this.organized
) {
670 this.categorized
= {};
673 for ( i
= 0, iLen
= this.list
.length
; i
< iLen
; i
++ ) {
674 action
= this.list
[i
];
675 if ( action
.isVisible() ) {
676 // Populate catgeories
677 for ( category
in this.categories
) {
678 if ( !this.categorized
[category
] ) {
679 this.categorized
[category
] = {};
681 list
= action
[this.categories
[category
]]();
682 if ( !Array
.isArray( list
) ) {
685 for ( j
= 0, jLen
= list
.length
; j
< jLen
; j
++ ) {
687 if ( !this.categorized
[category
][item
] ) {
688 this.categorized
[category
][item
] = [];
690 this.categorized
[category
][item
].push( action
);
693 // Populate special/others
695 for ( j
= 0, jLen
= specialFlags
.length
; j
< jLen
; j
++ ) {
696 flag
= specialFlags
[j
];
697 if ( !this.special
[flag
] && action
.hasFlag( flag
) ) {
698 this.special
[flag
] = action
;
704 this.others
.push( action
);
708 this.organized
= true;
715 * DOM element abstraction.
721 * @param {Object} [config] Configuration options
722 * @cfg {Function} [$] jQuery for the frame the widget is in
723 * @cfg {string[]} [classes] CSS class names to add
724 * @cfg {string} [text] Text to insert
725 * @cfg {jQuery} [$content] Content elements to append (after text)
727 OO
.ui
.Element
= function OoUiElement( config
) {
728 // Configuration initialization
729 config
= config
|| {};
732 this.$ = config
.$ || OO
.ui
.Element
.getJQuery( document
);
733 this.$element
= this.$( this.$.context
.createElement( this.getTagName() ) );
734 this.elementGroup
= null;
735 this.debouncedUpdateThemeClassesHandler
= this.debouncedUpdateThemeClasses
.bind( this );
736 this.updateThemeClassesPending
= false;
739 if ( $.isArray( config
.classes
) ) {
740 this.$element
.addClass( config
.classes
.join( ' ' ) );
743 this.$element
.text( config
.text
);
745 if ( config
.$content
) {
746 this.$element
.append( config
.$content
);
752 OO
.initClass( OO
.ui
.Element
);
754 /* Static Properties */
759 * This may be ignored if #getTagName is overridden.
765 OO
.ui
.Element
.static.tagName
= 'div';
770 * Get a jQuery function within a specific document.
773 * @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
774 * @param {jQuery} [$iframe] HTML iframe element that contains the document, omit if document is
776 * @return {Function} Bound jQuery function
778 OO
.ui
.Element
.getJQuery = function ( context
, $iframe
) {
779 function wrapper( selector
) {
780 return $( selector
, wrapper
.context
);
783 wrapper
.context
= this.getDocument( context
);
786 wrapper
.$iframe
= $iframe
;
793 * Get the document of an element.
796 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Object to get the document for
797 * @return {HTMLDocument|null} Document object
799 OO
.ui
.Element
.getDocument = function ( obj
) {
800 // jQuery - selections created "offscreen" won't have a context, so .context isn't reliable
801 return ( obj
[0] && obj
[0].ownerDocument
) ||
802 // Empty jQuery selections might have a context
809 ( obj
.nodeType
=== 9 && obj
) ||
814 * Get the window of an element or document.
817 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the window for
818 * @return {Window} Window object
820 OO
.ui
.Element
.getWindow = function ( obj
) {
821 var doc
= this.getDocument( obj
);
822 return doc
.parentWindow
|| doc
.defaultView
;
826 * Get the direction of an element or document.
829 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the direction for
830 * @return {string} Text direction, either 'ltr' or 'rtl'
832 OO
.ui
.Element
.getDir = function ( obj
) {
835 if ( obj
instanceof jQuery
) {
838 isDoc
= obj
.nodeType
=== 9;
839 isWin
= obj
.document
!== undefined;
840 if ( isDoc
|| isWin
) {
846 return $( obj
).css( 'direction' );
850 * Get the offset between two frames.
852 * TODO: Make this function not use recursion.
855 * @param {Window} from Window of the child frame
856 * @param {Window} [to=window] Window of the parent frame
857 * @param {Object} [offset] Offset to start with, used internally
858 * @return {Object} Offset object, containing left and top properties
860 OO
.ui
.Element
.getFrameOffset = function ( from, to
, offset
) {
861 var i
, len
, frames
, frame
, rect
;
867 offset
= { top
: 0, left
: 0 };
869 if ( from.parent
=== from ) {
873 // Get iframe element
874 frames
= from.parent
.document
.getElementsByTagName( 'iframe' );
875 for ( i
= 0, len
= frames
.length
; i
< len
; i
++ ) {
876 if ( frames
[i
].contentWindow
=== from ) {
882 // Recursively accumulate offset values
884 rect
= frame
.getBoundingClientRect();
885 offset
.left
+= rect
.left
;
886 offset
.top
+= rect
.top
;
888 this.getFrameOffset( from.parent
, offset
);
895 * Get the offset between two elements.
897 * The two elements may be in a different frame, but in that case the frame $element is in must
898 * be contained in the frame $anchor is in.
901 * @param {jQuery} $element Element whose position to get
902 * @param {jQuery} $anchor Element to get $element's position relative to
903 * @return {Object} Translated position coordinates, containing top and left properties
905 OO
.ui
.Element
.getRelativePosition = function ( $element
, $anchor
) {
906 var iframe
, iframePos
,
907 pos
= $element
.offset(),
908 anchorPos
= $anchor
.offset(),
909 elementDocument
= this.getDocument( $element
),
910 anchorDocument
= this.getDocument( $anchor
);
912 // If $element isn't in the same document as $anchor, traverse up
913 while ( elementDocument
!== anchorDocument
) {
914 iframe
= elementDocument
.defaultView
.frameElement
;
916 throw new Error( '$element frame is not contained in $anchor frame' );
918 iframePos
= $( iframe
).offset();
919 pos
.left
+= iframePos
.left
;
920 pos
.top
+= iframePos
.top
;
921 elementDocument
= iframe
.ownerDocument
;
923 pos
.left
-= anchorPos
.left
;
924 pos
.top
-= anchorPos
.top
;
929 * Get element border sizes.
932 * @param {HTMLElement} el Element to measure
933 * @return {Object} Dimensions object with `top`, `left`, `bottom` and `right` properties
935 OO
.ui
.Element
.getBorders = function ( el
) {
936 var doc
= el
.ownerDocument
,
937 win
= doc
.parentWindow
|| doc
.defaultView
,
938 style
= win
&& win
.getComputedStyle
?
939 win
.getComputedStyle( el
, null ) :
942 top
= parseFloat( style
? style
.borderTopWidth
: $el
.css( 'borderTopWidth' ) ) || 0,
943 left
= parseFloat( style
? style
.borderLeftWidth
: $el
.css( 'borderLeftWidth' ) ) || 0,
944 bottom
= parseFloat( style
? style
.borderBottomWidth
: $el
.css( 'borderBottomWidth' ) ) || 0,
945 right
= parseFloat( style
? style
.borderRightWidth
: $el
.css( 'borderRightWidth' ) ) || 0;
948 top
: Math
.round( top
),
949 left
: Math
.round( left
),
950 bottom
: Math
.round( bottom
),
951 right
: Math
.round( right
)
956 * Get dimensions of an element or window.
959 * @param {HTMLElement|Window} el Element to measure
960 * @return {Object} Dimensions object with `borders`, `scroll`, `scrollbar` and `rect` properties
962 OO
.ui
.Element
.getDimensions = function ( el
) {
964 doc
= el
.ownerDocument
|| el
.document
,
965 win
= doc
.parentWindow
|| doc
.defaultView
;
967 if ( win
=== el
|| el
=== doc
.documentElement
) {
970 borders
: { top
: 0, left
: 0, bottom
: 0, right
: 0 },
972 top
: $win
.scrollTop(),
973 left
: $win
.scrollLeft()
975 scrollbar
: { right
: 0, bottom
: 0 },
979 bottom
: $win
.innerHeight(),
980 right
: $win
.innerWidth()
986 borders
: this.getBorders( el
),
988 top
: $el
.scrollTop(),
989 left
: $el
.scrollLeft()
992 right
: $el
.innerWidth() - el
.clientWidth
,
993 bottom
: $el
.innerHeight() - el
.clientHeight
995 rect
: el
.getBoundingClientRect()
1001 * Get closest scrollable container.
1003 * Traverses up until either a scrollable element or the root is reached, in which case the window
1007 * @param {HTMLElement} el Element to find scrollable container for
1008 * @param {string} [dimension] Dimension of scrolling to look for; `x`, `y` or omit for either
1009 * @return {HTMLElement} Closest scrollable container
1011 OO
.ui
.Element
.getClosestScrollableContainer = function ( el
, dimension
) {
1013 props
= [ 'overflow' ],
1014 $parent
= $( el
).parent();
1016 if ( dimension
=== 'x' || dimension
=== 'y' ) {
1017 props
.push( 'overflow-' + dimension
);
1020 while ( $parent
.length
) {
1021 if ( $parent
[0] === el
.ownerDocument
.body
) {
1026 val
= $parent
.css( props
[i
] );
1027 if ( val
=== 'auto' || val
=== 'scroll' ) {
1031 $parent
= $parent
.parent();
1033 return this.getDocument( el
).body
;
1037 * Scroll element into view.
1040 * @param {HTMLElement} el Element to scroll into view
1041 * @param {Object} [config] Configuration options
1042 * @param {string} [config.duration] jQuery animation duration value
1043 * @param {string} [config.direction] Scroll in only one direction, e.g. 'x' or 'y', omit
1044 * to scroll in both directions
1045 * @param {Function} [config.complete] Function to call when scrolling completes
1047 OO
.ui
.Element
.scrollIntoView = function ( el
, config
) {
1048 // Configuration initialization
1049 config
= config
|| {};
1052 callback
= typeof config
.complete
=== 'function' && config
.complete
,
1053 sc
= this.getClosestScrollableContainer( el
, config
.direction
),
1055 eld
= this.getDimensions( el
),
1056 scd
= this.getDimensions( sc
),
1057 $win
= $( this.getWindow( el
) );
1059 // Compute the distances between the edges of el and the edges of the scroll viewport
1060 if ( $sc
.is( 'body' ) ) {
1061 // If the scrollable container is the <body> this is easy
1064 bottom
: $win
.innerHeight() - eld
.rect
.bottom
,
1065 left
: eld
.rect
.left
,
1066 right
: $win
.innerWidth() - eld
.rect
.right
1069 // Otherwise, we have to subtract el's coordinates from sc's coordinates
1071 top
: eld
.rect
.top
- ( scd
.rect
.top
+ scd
.borders
.top
),
1072 bottom
: scd
.rect
.bottom
- scd
.borders
.bottom
- scd
.scrollbar
.bottom
- eld
.rect
.bottom
,
1073 left
: eld
.rect
.left
- ( scd
.rect
.left
+ scd
.borders
.left
),
1074 right
: scd
.rect
.right
- scd
.borders
.right
- scd
.scrollbar
.right
- eld
.rect
.right
1078 if ( !config
.direction
|| config
.direction
=== 'y' ) {
1079 if ( rel
.top
< 0 ) {
1080 anim
.scrollTop
= scd
.scroll
.top
+ rel
.top
;
1081 } else if ( rel
.top
> 0 && rel
.bottom
< 0 ) {
1082 anim
.scrollTop
= scd
.scroll
.top
+ Math
.min( rel
.top
, -rel
.bottom
);
1085 if ( !config
.direction
|| config
.direction
=== 'x' ) {
1086 if ( rel
.left
< 0 ) {
1087 anim
.scrollLeft
= scd
.scroll
.left
+ rel
.left
;
1088 } else if ( rel
.left
> 0 && rel
.right
< 0 ) {
1089 anim
.scrollLeft
= scd
.scroll
.left
+ Math
.min( rel
.left
, -rel
.right
);
1092 if ( !$.isEmptyObject( anim
) ) {
1093 $sc
.stop( true ).animate( anim
, config
.duration
|| 'fast' );
1095 $sc
.queue( function ( next
) {
1108 * Bind a handler for an event on a DOM element.
1110 * Used to be for working around a jQuery bug (jqbug.com/14180),
1111 * but obsolete as of jQuery 1.11.0.
1114 * @deprecated Use jQuery#on instead.
1115 * @param {HTMLElement|jQuery} el DOM element
1116 * @param {string} event Event to bind
1117 * @param {Function} callback Callback to call when the event fires
1119 OO
.ui
.Element
.onDOMEvent = function ( el
, event
, callback
) {
1120 $( el
).on( event
, callback
);
1124 * Unbind a handler bound with #static-method-onDOMEvent.
1126 * @deprecated Use jQuery#off instead.
1128 * @param {HTMLElement|jQuery} el DOM element
1129 * @param {string} event Event to unbind
1130 * @param {Function} [callback] Callback to unbind
1132 OO
.ui
.Element
.offDOMEvent = function ( el
, event
, callback
) {
1133 $( el
).off( event
, callback
);
1139 * Check if element supports one or more methods.
1141 * @param {string|string[]} methods Method or list of methods to check
1142 * @return {boolean} All methods are supported
1144 OO
.ui
.Element
.prototype.supports = function ( methods
) {
1148 methods
= $.isArray( methods
) ? methods
: [ methods
];
1149 for ( i
= 0, len
= methods
.length
; i
< len
; i
++ ) {
1150 if ( $.isFunction( this[methods
[i
]] ) ) {
1155 return methods
.length
=== support
;
1159 * Update the theme-provided classes.
1161 * @localdoc This is called in element mixins and widget classes anytime state changes.
1162 * Updating is debounced, minimizing overhead of changing multiple attributes and
1163 * guaranteeing that theme updates do not occur within an element's constructor
1165 OO
.ui
.Element
.prototype.updateThemeClasses = function () {
1166 if ( !this.updateThemeClassesPending
) {
1167 this.updateThemeClassesPending
= true;
1168 setTimeout( this.debouncedUpdateThemeClassesHandler
);
1175 OO
.ui
.Element
.prototype.debouncedUpdateThemeClasses = function () {
1176 OO
.ui
.theme
.updateElementClasses( this );
1177 this.updateThemeClassesPending
= false;
1181 * Get the HTML tag name.
1183 * Override this method to base the result on instance information.
1185 * @return {string} HTML tag name
1187 OO
.ui
.Element
.prototype.getTagName = function () {
1188 return this.constructor.static.tagName
;
1192 * Check if the element is attached to the DOM
1193 * @return {boolean} The element is attached to the DOM
1195 OO
.ui
.Element
.prototype.isElementAttached = function () {
1196 return $.contains( this.getElementDocument(), this.$element
[0] );
1200 * Get the DOM document.
1202 * @return {HTMLDocument} Document object
1204 OO
.ui
.Element
.prototype.getElementDocument = function () {
1205 return OO
.ui
.Element
.getDocument( this.$element
);
1209 * Get the DOM window.
1211 * @return {Window} Window object
1213 OO
.ui
.Element
.prototype.getElementWindow = function () {
1214 return OO
.ui
.Element
.getWindow( this.$element
);
1218 * Get closest scrollable container.
1220 OO
.ui
.Element
.prototype.getClosestScrollableElementContainer = function () {
1221 return OO
.ui
.Element
.getClosestScrollableContainer( this.$element
[0] );
1225 * Get group element is in.
1227 * @return {OO.ui.GroupElement|null} Group element, null if none
1229 OO
.ui
.Element
.prototype.getElementGroup = function () {
1230 return this.elementGroup
;
1234 * Set group element is in.
1236 * @param {OO.ui.GroupElement|null} group Group element, null if none
1239 OO
.ui
.Element
.prototype.setElementGroup = function ( group
) {
1240 this.elementGroup
= group
;
1245 * Scroll element into view.
1247 * @param {Object} [config] Configuration options
1249 OO
.ui
.Element
.prototype.scrollElementIntoView = function ( config
) {
1250 return OO
.ui
.Element
.scrollIntoView( this.$element
[0], config
);
1254 * Bind a handler for an event on this.$element
1256 * @deprecated Use jQuery#on instead.
1257 * @param {string} event
1258 * @param {Function} callback
1260 OO
.ui
.Element
.prototype.onDOMEvent = function ( event
, callback
) {
1261 OO
.ui
.Element
.onDOMEvent( this.$element
, event
, callback
);
1265 * Unbind a handler bound with #offDOMEvent
1267 * @deprecated Use jQuery#off instead.
1268 * @param {string} event
1269 * @param {Function} callback
1271 OO
.ui
.Element
.prototype.offDOMEvent = function ( event
, callback
) {
1272 OO
.ui
.Element
.offDOMEvent( this.$element
, event
, callback
);
1276 * Container for elements.
1280 * @extends OO.ui.Element
1281 * @mixins OO.EventEmitter
1284 * @param {Object} [config] Configuration options
1286 OO
.ui
.Layout
= function OoUiLayout( config
) {
1287 // Configuration initialization
1288 config
= config
|| {};
1290 // Parent constructor
1291 OO
.ui
.Layout
.super.call( this, config
);
1293 // Mixin constructors
1294 OO
.EventEmitter
.call( this );
1297 this.$element
.addClass( 'oo-ui-layout' );
1302 OO
.inheritClass( OO
.ui
.Layout
, OO
.ui
.Element
);
1303 OO
.mixinClass( OO
.ui
.Layout
, OO
.EventEmitter
);
1306 * User interface control.
1310 * @extends OO.ui.Element
1311 * @mixins OO.EventEmitter
1314 * @param {Object} [config] Configuration options
1315 * @cfg {boolean} [disabled=false] Disable
1317 OO
.ui
.Widget
= function OoUiWidget( config
) {
1318 // Initialize config
1319 config
= $.extend( { disabled
: false }, config
);
1321 // Parent constructor
1322 OO
.ui
.Widget
.super.call( this, config
);
1324 // Mixin constructors
1325 OO
.EventEmitter
.call( this );
1328 this.visible
= true;
1329 this.disabled
= null;
1330 this.wasDisabled
= null;
1333 this.$element
.addClass( 'oo-ui-widget' );
1334 this.setDisabled( !!config
.disabled
);
1339 OO
.inheritClass( OO
.ui
.Widget
, OO
.ui
.Element
);
1340 OO
.mixinClass( OO
.ui
.Widget
, OO
.EventEmitter
);
1346 * @param {boolean} disabled Widget is disabled
1351 * @param {boolean} visible Widget is visible
1357 * Check if the widget is disabled.
1359 * @return {boolean} Button is disabled
1361 OO
.ui
.Widget
.prototype.isDisabled = function () {
1362 return this.disabled
;
1366 * Check if widget is visible.
1368 * @return {boolean} Widget is visible
1370 OO
.ui
.Widget
.prototype.isVisible = function () {
1371 return this.visible
;
1375 * Set the disabled state of the widget.
1377 * This should probably change the widgets' appearance and prevent it from being used.
1379 * @param {boolean} disabled Disable widget
1382 OO
.ui
.Widget
.prototype.setDisabled = function ( disabled
) {
1385 this.disabled
= !!disabled
;
1386 isDisabled
= this.isDisabled();
1387 if ( isDisabled
!== this.wasDisabled
) {
1388 this.$element
.toggleClass( 'oo-ui-widget-disabled', isDisabled
);
1389 this.$element
.toggleClass( 'oo-ui-widget-enabled', !isDisabled
);
1390 this.emit( 'disable', isDisabled
);
1391 this.updateThemeClasses();
1393 this.wasDisabled
= isDisabled
;
1399 * Toggle visibility of widget.
1401 * @param {boolean} [show] Make widget visible, omit to toggle visibility
1405 OO
.ui
.Widget
.prototype.toggle = function ( show
) {
1406 show
= show
=== undefined ? !this.visible
: !!show
;
1408 if ( show
!== this.isVisible() ) {
1409 this.visible
= show
;
1410 this.$element
.toggle( show
);
1411 this.emit( 'toggle', show
);
1418 * Update the disabled state, in case of changes in parent widget.
1422 OO
.ui
.Widget
.prototype.updateDisabled = function () {
1423 this.setDisabled( this.disabled
);
1428 * Container for elements in a child frame.
1430 * Use together with OO.ui.WindowManager.
1434 * @extends OO.ui.Element
1435 * @mixins OO.EventEmitter
1437 * When a window is opened, the setup and ready processes are executed. Similarly, the hold and
1438 * teardown processes are executed when the window is closed.
1440 * - {@link OO.ui.WindowManager#openWindow} or {@link #open} methods are used to start opening
1441 * - Window manager begins opening window
1442 * - {@link #getSetupProcess} method is called and its result executed
1443 * - {@link #getReadyProcess} method is called and its result executed
1444 * - Window is now open
1446 * - {@link OO.ui.WindowManager#closeWindow} or {@link #close} methods are used to start closing
1447 * - Window manager begins closing window
1448 * - {@link #getHoldProcess} method is called and its result executed
1449 * - {@link #getTeardownProcess} method is called and its result executed
1450 * - Window is now closed
1452 * Each process (setup, ready, hold and teardown) can be extended in subclasses by overriding
1453 * {@link #getSetupProcess}, {@link #getReadyProcess}, {@link #getHoldProcess} and
1454 * {@link #getTeardownProcess} respectively. Each process is executed in series, so asynchonous
1455 * processing can complete. Always assume window processes are executed asychronously. See
1456 * OO.ui.Process for more details about how to work with processes. Some events, as well as the
1457 * #open and #close methods, provide promises which are resolved when the window enters a new state.
1459 * Sizing of windows is specified using symbolic names which are interpreted by the window manager.
1460 * If the requested size is not recognized, the window manager will choose a sensible fallback.
1463 * @param {Object} [config] Configuration options
1464 * @cfg {string} [size] Symbolic name of dialog size, `small`, `medium`, `large` or `full`; omit to
1467 OO
.ui
.Window
= function OoUiWindow( config
) {
1468 // Configuration initialization
1469 config
= config
|| {};
1471 // Parent constructor
1472 OO
.ui
.Window
.super.call( this, config
);
1474 // Mixin constructors
1475 OO
.EventEmitter
.call( this );
1478 this.manager
= null;
1479 this.initialized
= false;
1480 this.visible
= false;
1481 this.opening
= null;
1482 this.closing
= null;
1485 this.loading
= null;
1486 this.size
= config
.size
|| this.constructor.static.size
;
1487 this.$frame
= this.$( '<div>' );
1488 this.$overlay
= this.$( '<div>' );
1492 .addClass( 'oo-ui-window' )
1493 .append( this.$frame
, this.$overlay
);
1494 this.$frame
.addClass( 'oo-ui-window-frame' );
1495 this.$overlay
.addClass( 'oo-ui-window-overlay' );
1497 // NOTE: Additional intitialization will occur when #setManager is called
1502 OO
.inheritClass( OO
.ui
.Window
, OO
.ui
.Element
);
1503 OO
.mixinClass( OO
.ui
.Window
, OO
.EventEmitter
);
1505 /* Static Properties */
1508 * Symbolic name of size.
1510 * Size is used if no size is configured during construction.
1514 * @property {string}
1516 OO
.ui
.Window
.static.size
= 'medium';
1518 /* Static Methods */
1521 * Transplant the CSS styles from as parent document to a frame's document.
1523 * This loops over the style sheets in the parent document, and copies their nodes to the
1524 * frame's document. It then polls the document to see when all styles have loaded, and once they
1525 * have, resolves the promise.
1527 * If the styles still haven't loaded after a long time (5 seconds by default), we give up waiting
1528 * and resolve the promise anyway. This protects against cases like a display: none; iframe in
1529 * Firefox, where the styles won't load until the iframe becomes visible.
1531 * For details of how we arrived at the strategy used in this function, see #load.
1535 * @param {HTMLDocument} parentDoc Document to transplant styles from
1536 * @param {HTMLDocument} frameDoc Document to transplant styles to
1537 * @param {number} [timeout=5000] How long to wait before giving up (in ms). If 0, never give up.
1538 * @return {jQuery.Promise} Promise resolved when styles have loaded
1540 OO
.ui
.Window
.static.transplantStyles = function ( parentDoc
, frameDoc
, timeout
) {
1541 var i
, numSheets
, styleNode
, styleText
, newNode
, timeoutID
, pollNodeId
, $pendingPollNodes
,
1542 $pollNodes
= $( [] ),
1543 // Fake font-family value
1544 fontFamily
= 'oo-ui-frame-transplantStyles-loaded',
1545 nextIndex
= parentDoc
.oouiFrameTransplantStylesNextIndex
|| 0,
1546 deferred
= $.Deferred();
1548 for ( i
= 0, numSheets
= parentDoc
.styleSheets
.length
; i
< numSheets
; i
++ ) {
1549 styleNode
= parentDoc
.styleSheets
[i
].ownerNode
;
1550 if ( styleNode
.disabled
) {
1554 if ( styleNode
.nodeName
.toLowerCase() === 'link' ) {
1555 // External stylesheet; use @import
1556 styleText
= '@import url(' + styleNode
.href
+ ');';
1558 // Internal stylesheet; just copy the text
1559 // For IE10 we need to fall back to .cssText, BUT that's undefined in
1560 // other browsers, so fall back to '' rather than 'undefined'
1561 styleText
= styleNode
.textContent
|| parentDoc
.styleSheets
[i
].cssText
|| '';
1564 // Create a node with a unique ID that we're going to monitor to see when the CSS
1566 if ( styleNode
.oouiFrameTransplantStylesId
) {
1567 // If we're nesting transplantStyles operations and this node already has
1568 // a CSS rule to wait for loading, reuse it
1569 pollNodeId
= styleNode
.oouiFrameTransplantStylesId
;
1571 // Otherwise, create a new ID
1572 pollNodeId
= 'oo-ui-frame-transplantStyles-loaded-' + nextIndex
;
1575 // Add #pollNodeId { font-family: ... } to the end of the stylesheet / after the @import
1576 // The font-family rule will only take effect once the @import finishes
1577 styleText
+= '\n' + '#' + pollNodeId
+ ' { font-family: ' + fontFamily
+ '; }';
1580 // Create a node with id=pollNodeId
1581 $pollNodes
= $pollNodes
.add( $( '<div>', frameDoc
)
1582 .attr( 'id', pollNodeId
)
1583 .appendTo( frameDoc
.body
)
1586 // Add our modified CSS as a <style> tag
1587 newNode
= frameDoc
.createElement( 'style' );
1588 newNode
.textContent
= styleText
;
1589 newNode
.oouiFrameTransplantStylesId
= pollNodeId
;
1590 frameDoc
.head
.appendChild( newNode
);
1592 frameDoc
.oouiFrameTransplantStylesNextIndex
= nextIndex
;
1594 // Poll every 100ms until all external stylesheets have loaded
1595 $pendingPollNodes
= $pollNodes
;
1596 timeoutID
= setTimeout( function pollExternalStylesheets() {
1598 $pendingPollNodes
.length
> 0 &&
1599 $pendingPollNodes
.eq( 0 ).css( 'font-family' ) === fontFamily
1601 $pendingPollNodes
= $pendingPollNodes
.slice( 1 );
1604 if ( $pendingPollNodes
.length
=== 0 ) {
1606 if ( timeoutID
!== null ) {
1608 $pollNodes
.remove();
1612 timeoutID
= setTimeout( pollExternalStylesheets
, 100 );
1615 // ...but give up after a while
1616 if ( timeout
!== 0 ) {
1617 setTimeout( function () {
1619 clearTimeout( timeoutID
);
1621 $pollNodes
.remove();
1624 }, timeout
|| 5000 );
1627 return deferred
.promise();
1633 * Handle mouse down events.
1635 * @param {jQuery.Event} e Mouse down event
1637 OO
.ui
.Window
.prototype.onMouseDown = function ( e
) {
1638 // Prevent clicking on the click-block from stealing focus
1639 if ( e
.target
=== this.$element
[0] ) {
1645 * Check if window has been initialized.
1647 * @return {boolean} Window has been initialized
1649 OO
.ui
.Window
.prototype.isInitialized = function () {
1650 return this.initialized
;
1654 * Check if window is visible.
1656 * @return {boolean} Window is visible
1658 OO
.ui
.Window
.prototype.isVisible = function () {
1659 return this.visible
;
1663 * Check if window is loading.
1665 * @return {boolean} Window is loading
1667 OO
.ui
.Window
.prototype.isLoading = function () {
1668 return this.loading
&& this.loading
.state() === 'pending';
1672 * Check if window is loaded.
1674 * @return {boolean} Window is loaded
1676 OO
.ui
.Window
.prototype.isLoaded = function () {
1677 return this.loading
&& this.loading
.state() === 'resolved';
1681 * Check if window is opening.
1683 * This is a wrapper around OO.ui.WindowManager#isOpening.
1685 * @return {boolean} Window is opening
1687 OO
.ui
.Window
.prototype.isOpening = function () {
1688 return this.manager
.isOpening( this );
1692 * Check if window is closing.
1694 * This is a wrapper around OO.ui.WindowManager#isClosing.
1696 * @return {boolean} Window is closing
1698 OO
.ui
.Window
.prototype.isClosing = function () {
1699 return this.manager
.isClosing( this );
1703 * Check if window is opened.
1705 * This is a wrapper around OO.ui.WindowManager#isOpened.
1707 * @return {boolean} Window is opened
1709 OO
.ui
.Window
.prototype.isOpened = function () {
1710 return this.manager
.isOpened( this );
1714 * Get the window manager.
1716 * @return {OO.ui.WindowManager} Manager of window
1718 OO
.ui
.Window
.prototype.getManager = function () {
1719 return this.manager
;
1723 * Get the window size.
1725 * @return {string} Symbolic size name, e.g. 'small', 'medium', 'large', 'full'
1727 OO
.ui
.Window
.prototype.getSize = function () {
1732 * Get the height of the dialog contents.
1734 * @return {number} Content height
1736 OO
.ui
.Window
.prototype.getContentHeight = function () {
1737 // Temporarily resize the frame so getBodyHeight() can use scrollHeight measurements
1738 var bodyHeight
, oldHeight
= this.$frame
[0].style
.height
;
1739 this.$frame
[0].style
.height
= '1px';
1740 bodyHeight
= this.getBodyHeight();
1741 this.$frame
[0].style
.height
= oldHeight
;
1744 // Add buffer for border
1745 ( this.$frame
.outerHeight() - this.$frame
.innerHeight() ) +
1746 // Use combined heights of children
1747 ( this.$head
.outerHeight( true ) + bodyHeight
+ this.$foot
.outerHeight( true ) )
1752 * Get the height of the dialog contents.
1754 * When this function is called, the dialog will temporarily have been resized
1755 * to height=1px, so .scrollHeight measurements can be taken accurately.
1757 * @return {number} Height of content
1759 OO
.ui
.Window
.prototype.getBodyHeight = function () {
1760 return this.$body
[0].scrollHeight
;
1764 * Get the directionality of the frame
1766 * @return {string} Directionality, 'ltr' or 'rtl'
1768 OO
.ui
.Window
.prototype.getDir = function () {
1773 * Get a process for setting up a window for use.
1775 * Each time the window is opened this process will set it up for use in a particular context, based
1776 * on the `data` argument.
1778 * When you override this method, you can add additional setup steps to the process the parent
1779 * method provides using the 'first' and 'next' methods.
1782 * @param {Object} [data] Window opening data
1783 * @return {OO.ui.Process} Setup process
1785 OO
.ui
.Window
.prototype.getSetupProcess = function () {
1786 return new OO
.ui
.Process();
1790 * Get a process for readying a window for use.
1792 * Each time the window is open and setup, this process will ready it up for use in a particular
1793 * context, based on the `data` argument.
1795 * When you override this method, you can add additional setup steps to the process the parent
1796 * method provides using the 'first' and 'next' methods.
1799 * @param {Object} [data] Window opening data
1800 * @return {OO.ui.Process} Setup process
1802 OO
.ui
.Window
.prototype.getReadyProcess = function () {
1803 return new OO
.ui
.Process();
1807 * Get a process for holding a window from use.
1809 * Each time the window is closed, this process will hold it from use in a particular context, based
1810 * on the `data` argument.
1812 * When you override this method, you can add additional setup steps to the process the parent
1813 * method provides using the 'first' and 'next' methods.
1816 * @param {Object} [data] Window closing data
1817 * @return {OO.ui.Process} Hold process
1819 OO
.ui
.Window
.prototype.getHoldProcess = function () {
1820 return new OO
.ui
.Process();
1824 * Get a process for tearing down a window after use.
1826 * Each time the window is closed this process will tear it down and do something with the user's
1827 * interactions within the window, based on the `data` argument.
1829 * When you override this method, you can add additional teardown steps to the process the parent
1830 * method provides using the 'first' and 'next' methods.
1833 * @param {Object} [data] Window closing data
1834 * @return {OO.ui.Process} Teardown process
1836 OO
.ui
.Window
.prototype.getTeardownProcess = function () {
1837 return new OO
.ui
.Process();
1841 * Toggle visibility of window.
1843 * If the window is isolated and hasn't fully loaded yet, the visiblity property will be used
1844 * instead of display.
1846 * @param {boolean} [show] Make window visible, omit to toggle visibility
1850 OO
.ui
.Window
.prototype.toggle = function ( show
) {
1851 show
= show
=== undefined ? !this.visible
: !!show
;
1853 if ( show
!== this.isVisible() ) {
1854 this.visible
= show
;
1856 if ( this.isolated
&& !this.isLoaded() ) {
1857 // Hide the window using visibility instead of display until loading is complete
1858 // Can't use display: none; because that prevents the iframe from loading in Firefox
1859 this.$element
.css( 'visibility', show
? 'visible' : 'hidden' );
1861 this.$element
.toggle( show
).css( 'visibility', '' );
1863 this.emit( 'toggle', show
);
1870 * Set the window manager.
1872 * This must be called before initialize. Calling it more than once will cause an error.
1874 * @param {OO.ui.WindowManager} manager Manager for this window
1875 * @throws {Error} If called more than once
1878 OO
.ui
.Window
.prototype.setManager = function ( manager
) {
1879 if ( this.manager
) {
1880 throw new Error( 'Cannot set window manager, window already has a manager' );
1884 this.manager
= manager
;
1885 this.isolated
= manager
.shouldIsolate();
1888 if ( this.isolated
) {
1889 this.$iframe
= this.$( '<iframe>' );
1890 this.$iframe
.attr( { frameborder
: 0, scrolling
: 'no' } );
1891 this.$frame
.append( this.$iframe
);
1892 this.$ = function () {
1893 throw new Error( 'this.$() cannot be used until the frame has been initialized.' );
1895 // WARNING: Do not use this.$ again until #initialize is called
1897 this.$content
= this.$( '<div>' );
1898 this.$document
= $( this.getElementDocument() );
1899 this.$content
.addClass( 'oo-ui-window-content' );
1900 this.$frame
.append( this.$content
);
1902 this.toggle( false );
1904 // Figure out directionality:
1905 this.dir
= OO
.ui
.Element
.getDir( this.$iframe
|| this.$content
) || 'ltr';
1911 * Set the window size.
1913 * @param {string} size Symbolic size name, e.g. 'small', 'medium', 'large', 'full'
1916 OO
.ui
.Window
.prototype.setSize = function ( size
) {
1918 this.manager
.updateWindowSize( this );
1923 * Set window dimensions.
1925 * Properties are applied to the frame container.
1927 * @param {Object} dim CSS dimension properties
1928 * @param {string|number} [dim.width] Width
1929 * @param {string|number} [dim.minWidth] Minimum width
1930 * @param {string|number} [dim.maxWidth] Maximum width
1931 * @param {string|number} [dim.width] Height, omit to set based on height of contents
1932 * @param {string|number} [dim.minWidth] Minimum height
1933 * @param {string|number} [dim.maxWidth] Maximum height
1936 OO
.ui
.Window
.prototype.setDimensions = function ( dim
) {
1937 // Apply width before height so height is not based on wrapping content using the wrong width
1939 width
: dim
.width
|| '',
1940 minWidth
: dim
.minWidth
|| '',
1941 maxWidth
: dim
.maxWidth
|| ''
1944 height
: ( dim
.height
!== undefined ? dim
.height
: this.getContentHeight() ) || '',
1945 minHeight
: dim
.minHeight
|| '',
1946 maxHeight
: dim
.maxHeight
|| ''
1952 * Initialize window contents.
1954 * The first time the window is opened, #initialize is called when it's safe to begin populating
1955 * its contents. See #getSetupProcess for a way to make changes each time the window opens.
1957 * Once this method is called, this.$ can be used to create elements within the frame.
1959 * @throws {Error} If not attached to a manager
1962 OO
.ui
.Window
.prototype.initialize = function () {
1963 if ( !this.manager
) {
1964 throw new Error( 'Cannot initialize window, must be attached to a manager' );
1968 this.$head
= this.$( '<div>' );
1969 this.$body
= this.$( '<div>' );
1970 this.$foot
= this.$( '<div>' );
1971 this.$innerOverlay
= this.$( '<div>' );
1974 this.$element
.on( 'mousedown', this.onMouseDown
.bind( this ) );
1977 this.$head
.addClass( 'oo-ui-window-head' );
1978 this.$body
.addClass( 'oo-ui-window-body' );
1979 this.$foot
.addClass( 'oo-ui-window-foot' );
1980 this.$innerOverlay
.addClass( 'oo-ui-window-inner-overlay' );
1981 this.$content
.append( this.$head
, this.$body
, this.$foot
, this.$innerOverlay
);
1989 * This is a wrapper around calling {@link OO.ui.WindowManager#openWindow} on the window manager.
1990 * To do something each time the window opens, use #getSetupProcess or #getReadyProcess.
1992 * @param {Object} [data] Window opening data
1993 * @return {jQuery.Promise} Promise resolved when window is opened; when the promise is resolved the
1994 * first argument will be a promise which will be resolved when the window begins closing
1996 OO
.ui
.Window
.prototype.open = function ( data
) {
1997 return this.manager
.openWindow( this, data
);
2003 * This is a wrapper around calling OO.ui.WindowManager#closeWindow on the window manager.
2004 * To do something each time the window closes, use #getHoldProcess or #getTeardownProcess.
2006 * @param {Object} [data] Window closing data
2007 * @return {jQuery.Promise} Promise resolved when window is closed
2009 OO
.ui
.Window
.prototype.close = function ( data
) {
2010 return this.manager
.closeWindow( this, data
);
2016 * This is called by OO.ui.WindowManager durring window opening, and should not be called directly
2019 * @param {Object} [data] Window opening data
2020 * @return {jQuery.Promise} Promise resolved when window is setup
2022 OO
.ui
.Window
.prototype.setup = function ( data
) {
2024 deferred
= $.Deferred();
2026 this.$element
.show();
2027 this.visible
= true;
2028 this.getSetupProcess( data
).execute().done( function () {
2029 // Force redraw by asking the browser to measure the elements' widths
2030 win
.$element
.addClass( 'oo-ui-window-setup' ).width();
2031 win
.$content
.addClass( 'oo-ui-window-content-setup' ).width();
2035 return deferred
.promise();
2041 * This is called by OO.ui.WindowManager durring window opening, and should not be called directly
2044 * @param {Object} [data] Window opening data
2045 * @return {jQuery.Promise} Promise resolved when window is ready
2047 OO
.ui
.Window
.prototype.ready = function ( data
) {
2049 deferred
= $.Deferred();
2051 this.$content
.focus();
2052 this.getReadyProcess( data
).execute().done( function () {
2053 // Force redraw by asking the browser to measure the elements' widths
2054 win
.$element
.addClass( 'oo-ui-window-ready' ).width();
2055 win
.$content
.addClass( 'oo-ui-window-content-ready' ).width();
2059 return deferred
.promise();
2065 * This is called by OO.ui.WindowManager durring window closing, and should not be called directly
2068 * @param {Object} [data] Window closing data
2069 * @return {jQuery.Promise} Promise resolved when window is held
2071 OO
.ui
.Window
.prototype.hold = function ( data
) {
2073 deferred
= $.Deferred();
2075 this.getHoldProcess( data
).execute().done( function () {
2076 // Get the focused element within the window's content
2077 var $focus
= win
.$content
.find( OO
.ui
.Element
.getDocument( win
.$content
).activeElement
);
2079 // Blur the focused element
2080 if ( $focus
.length
) {
2084 // Force redraw by asking the browser to measure the elements' widths
2085 win
.$element
.removeClass( 'oo-ui-window-ready' ).width();
2086 win
.$content
.removeClass( 'oo-ui-window-content-ready' ).width();
2090 return deferred
.promise();
2096 * This is called by OO.ui.WindowManager durring window closing, and should not be called directly
2099 * @param {Object} [data] Window closing data
2100 * @return {jQuery.Promise} Promise resolved when window is torn down
2102 OO
.ui
.Window
.prototype.teardown = function ( data
) {
2104 deferred
= $.Deferred();
2106 this.getTeardownProcess( data
).execute().done( function () {
2107 // Force redraw by asking the browser to measure the elements' widths
2108 win
.$element
.removeClass( 'oo-ui-window-load oo-ui-window-setup' ).width();
2109 win
.$content
.removeClass( 'oo-ui-window-content-setup' ).width();
2110 win
.$element
.hide();
2111 win
.visible
= false;
2115 return deferred
.promise();
2119 * Load the frame contents.
2121 * Once the iframe's stylesheets are loaded the returned promise will be resolved. Calling while
2122 * loading will return a promise but not trigger a new loading cycle. Calling after loading is
2123 * complete will return a promise that's already been resolved.
2125 * Sounds simple right? Read on...
2127 * When you create a dynamic iframe using open/write/close, the window.load event for the
2128 * iframe is triggered when you call close, and there's no further load event to indicate that
2129 * everything is actually loaded.
2131 * In Chrome, stylesheets don't show up in document.styleSheets until they have loaded, so we could
2132 * just poll that array and wait for it to have the right length. However, in Firefox, stylesheets
2133 * are added to document.styleSheets immediately, and the only way you can determine whether they've
2134 * loaded is to attempt to access .cssRules and wait for that to stop throwing an exception. But
2135 * cross-domain stylesheets never allow .cssRules to be accessed even after they have loaded.
2137 * The workaround is to change all `<link href="...">` tags to `<style>@import url(...)</style>`
2138 * tags. Because `@import` is blocking, Chrome won't add the stylesheet to document.styleSheets
2139 * until the `@import` has finished, and Firefox won't allow .cssRules to be accessed until the
2140 * `@import` has finished. And because the contents of the `<style>` tag are from the same origin,
2141 * accessing .cssRules is allowed.
2143 * However, now that we control the styles we're injecting, we might as well do away with
2144 * browser-specific polling hacks like document.styleSheets and .cssRules, and instead inject
2145 * `<style>@import url(...); #foo { font-family: someValue; }</style>`, then create `<div id="foo">`
2146 * and wait for its font-family to change to someValue. Because `@import` is blocking, the
2147 * font-family rule is not applied until after the `@import` finishes.
2149 * All this stylesheet injection and polling magic is in #transplantStyles.
2151 * @return {jQuery.Promise} Promise resolved when loading is complete
2153 OO
.ui
.Window
.prototype.load = function () {
2154 var sub
, doc
, loading
,
2157 this.$element
.addClass( 'oo-ui-window-load' );
2159 // Non-isolated windows are already "loaded"
2160 if ( !this.loading
&& !this.isolated
) {
2161 this.loading
= $.Deferred().resolve();
2163 // Set initialized state after so sub-classes aren't confused by it being set by calling
2164 // their parent initialize method
2165 this.initialized
= true;
2168 // Return existing promise if already loading or loaded
2169 if ( this.loading
) {
2170 return this.loading
.promise();
2174 loading
= this.loading
= $.Deferred();
2175 sub
= this.$iframe
.prop( 'contentWindow' );
2178 // Initialize contents
2183 '<body class="oo-ui-window-isolated oo-ui-' + this.dir
+ '"' +
2184 ' style="direction:' + this.dir
+ ';" dir="' + this.dir
+ '">' +
2185 '<div class="oo-ui-window-content"></div>' +
2192 this.$ = OO
.ui
.Element
.getJQuery( doc
, this.$iframe
);
2193 this.$content
= this.$( '.oo-ui-window-content' ).attr( 'tabIndex', 0 );
2194 this.$document
= this.$( doc
);
2197 this.constructor.static.transplantStyles( this.getElementDocument(), this.$document
[0] )
2198 .always( function () {
2199 // Initialize isolated windows
2201 // Set initialized state after so sub-classes aren't confused by it being set by calling
2202 // their parent initialize method
2203 win
.initialized
= true;
2204 // Undo the visibility: hidden; hack and apply display: none;
2205 // We can do this safely now that the iframe has initialized
2206 // (don't do this from within #initialize because it has to happen
2207 // after the all subclasses have been handled as well).
2208 win
.toggle( win
.isVisible() );
2213 return loading
.promise();
2217 * Base class for all dialogs.
2220 * - Manage the window (open and close, etc.).
2221 * - Store the internal name and display title.
2222 * - A stack to track one or more pending actions.
2223 * - Manage a set of actions that can be performed.
2224 * - Configure and create action widgets.
2227 * - Close the dialog with Escape key.
2228 * - Visually lock the dialog while an action is in
2229 * progress (aka "pending").
2231 * Subclass responsibilities:
2232 * - Display the title somewhere.
2233 * - Add content to the dialog.
2234 * - Provide a UI to close the dialog.
2235 * - Display the action widgets somewhere.
2239 * @extends OO.ui.Window
2240 * @mixins OO.ui.PendingElement
2243 * @param {Object} [config] Configuration options
2245 OO
.ui
.Dialog
= function OoUiDialog( config
) {
2246 // Parent constructor
2247 OO
.ui
.Dialog
.super.call( this, config
);
2249 // Mixin constructors
2250 OO
.ui
.PendingElement
.call( this );
2253 this.actions
= new OO
.ui
.ActionSet();
2254 this.attachedActions
= [];
2255 this.currentAction
= null;
2258 this.actions
.connect( this, {
2259 click
: 'onActionClick',
2260 resize
: 'onActionResize',
2261 change
: 'onActionsChange'
2266 .addClass( 'oo-ui-dialog' )
2267 .attr( 'role', 'dialog' );
2272 OO
.inheritClass( OO
.ui
.Dialog
, OO
.ui
.Window
);
2273 OO
.mixinClass( OO
.ui
.Dialog
, OO
.ui
.PendingElement
);
2275 /* Static Properties */
2278 * Symbolic name of dialog.
2283 * @property {string}
2285 OO
.ui
.Dialog
.static.name
= '';
2293 * @property {jQuery|string|Function} Label nodes, text or a function that returns nodes or text
2295 OO
.ui
.Dialog
.static.title
= '';
2298 * List of OO.ui.ActionWidget configuration options.
2302 * @property {Object[]}
2304 OO
.ui
.Dialog
.static.actions
= [];
2307 * Close dialog when the escape key is pressed.
2312 * @property {boolean}
2314 OO
.ui
.Dialog
.static.escapable
= true;
2319 * Handle frame document key down events.
2321 * @param {jQuery.Event} e Key down event
2323 OO
.ui
.Dialog
.prototype.onDocumentKeyDown = function ( e
) {
2324 if ( e
.which
=== OO
.ui
.Keys
.ESCAPE
) {
2331 * Handle action resized events.
2333 * @param {OO.ui.ActionWidget} action Action that was resized
2335 OO
.ui
.Dialog
.prototype.onActionResize = function () {
2336 // Override in subclass
2340 * Handle action click events.
2342 * @param {OO.ui.ActionWidget} action Action that was clicked
2344 OO
.ui
.Dialog
.prototype.onActionClick = function ( action
) {
2345 if ( !this.isPending() ) {
2346 this.currentAction
= action
;
2347 this.executeAction( action
.getAction() );
2352 * Handle actions change event.
2354 OO
.ui
.Dialog
.prototype.onActionsChange = function () {
2355 this.detachActions();
2356 if ( !this.isClosing() ) {
2357 this.attachActions();
2362 * Get set of actions.
2364 * @return {OO.ui.ActionSet}
2366 OO
.ui
.Dialog
.prototype.getActions = function () {
2367 return this.actions
;
2371 * Get a process for taking action.
2373 * When you override this method, you can add additional accept steps to the process the parent
2374 * method provides using the 'first' and 'next' methods.
2377 * @param {string} [action] Symbolic name of action
2378 * @return {OO.ui.Process} Action process
2380 OO
.ui
.Dialog
.prototype.getActionProcess = function ( action
) {
2381 return new OO
.ui
.Process()
2382 .next( function () {
2384 // An empty action always closes the dialog without data, which should always be
2385 // safe and make no changes
2394 * @param {Object} [data] Dialog opening data
2395 * @param {jQuery|string|Function|null} [data.title] Dialog title, omit to use #static-title
2396 * @param {Object[]} [data.actions] List of OO.ui.ActionWidget configuration options for each
2397 * action item, omit to use #static-actions
2399 OO
.ui
.Dialog
.prototype.getSetupProcess = function ( data
) {
2403 return OO
.ui
.Dialog
.super.prototype.getSetupProcess
.call( this, data
)
2404 .next( function () {
2407 config
= this.constructor.static,
2408 actions
= data
.actions
!== undefined ? data
.actions
: config
.actions
;
2410 this.title
.setLabel(
2411 data
.title
!== undefined ? data
.title
: this.constructor.static.title
2413 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
2415 new OO
.ui
.ActionWidget( $.extend( { $: this.$ }, actions
[i
] ) )
2418 this.actions
.add( items
);
2425 OO
.ui
.Dialog
.prototype.getTeardownProcess = function ( data
) {
2427 return OO
.ui
.Dialog
.super.prototype.getTeardownProcess
.call( this, data
)
2428 .first( function () {
2429 this.actions
.clear();
2430 this.currentAction
= null;
2437 OO
.ui
.Dialog
.prototype.initialize = function () {
2439 OO
.ui
.Dialog
.super.prototype.initialize
.call( this );
2442 this.title
= new OO
.ui
.LabelWidget( { $: this.$ } );
2445 if ( this.constructor.static.escapable
) {
2446 this.$document
.on( 'keydown', this.onDocumentKeyDown
.bind( this ) );
2450 this.$content
.addClass( 'oo-ui-dialog-content' );
2451 this.setPendingElement( this.$head
);
2455 * Attach action actions.
2457 OO
.ui
.Dialog
.prototype.attachActions = function () {
2458 // Remember the list of potentially attached actions
2459 this.attachedActions
= this.actions
.get();
2463 * Detach action actions.
2467 OO
.ui
.Dialog
.prototype.detachActions = function () {
2470 // Detach all actions that may have been previously attached
2471 for ( i
= 0, len
= this.attachedActions
.length
; i
< len
; i
++ ) {
2472 this.attachedActions
[i
].$element
.detach();
2474 this.attachedActions
= [];
2478 * Execute an action.
2480 * @param {string} action Symbolic name of action to execute
2481 * @return {jQuery.Promise} Promise resolved when action completes, rejected if it fails
2483 OO
.ui
.Dialog
.prototype.executeAction = function ( action
) {
2485 return this.getActionProcess( action
).execute()
2486 .always( this.popPending
.bind( this ) );
2490 * Collection of windows.
2493 * @extends OO.ui.Element
2494 * @mixins OO.EventEmitter
2496 * Managed windows are mutually exclusive. If a window is opened while there is a current window
2497 * already opening or opened, the current window will be closed without data. Empty closing data
2498 * should always result in the window being closed without causing constructive or destructive
2501 * As a window is opened and closed, it passes through several stages and the manager emits several
2502 * corresponding events.
2504 * - {@link #openWindow} or {@link OO.ui.Window#open} methods are used to start opening
2505 * - {@link #event-opening} is emitted with `opening` promise
2506 * - {@link #getSetupDelay} is called the returned value is used to time a pause in execution
2507 * - {@link OO.ui.Window#getSetupProcess} method is called on the window and its result executed
2508 * - `setup` progress notification is emitted from opening promise
2509 * - {@link #getReadyDelay} is called the returned value is used to time a pause in execution
2510 * - {@link OO.ui.Window#getReadyProcess} method is called on the window and its result executed
2511 * - `ready` progress notification is emitted from opening promise
2512 * - `opening` promise is resolved with `opened` promise
2513 * - Window is now open
2515 * - {@link #closeWindow} or {@link OO.ui.Window#close} methods are used to start closing
2516 * - `opened` promise is resolved with `closing` promise
2517 * - {@link #event-closing} is emitted with `closing` promise
2518 * - {@link #getHoldDelay} is called the returned value is used to time a pause in execution
2519 * - {@link OO.ui.Window#getHoldProcess} method is called on the window and its result executed
2520 * - `hold` progress notification is emitted from opening promise
2521 * - {@link #getTeardownDelay} is called the returned value is used to time a pause in execution
2522 * - {@link OO.ui.Window#getTeardownProcess} method is called on the window and its result executed
2523 * - `teardown` progress notification is emitted from opening promise
2524 * - Closing promise is resolved
2525 * - Window is now closed
2528 * @param {Object} [config] Configuration options
2529 * @cfg {boolean} [isolate] Configure managed windows to isolate their content using inline frames
2530 * @cfg {OO.Factory} [factory] Window factory to use for automatic instantiation
2531 * @cfg {boolean} [modal=true] Prevent interaction outside the dialog
2533 OO
.ui
.WindowManager
= function OoUiWindowManager( config
) {
2534 // Configuration initialization
2535 config
= config
|| {};
2537 // Parent constructor
2538 OO
.ui
.WindowManager
.super.call( this, config
);
2540 // Mixin constructors
2541 OO
.EventEmitter
.call( this );
2544 this.factory
= config
.factory
;
2545 this.modal
= config
.modal
=== undefined || !!config
.modal
;
2546 this.isolate
= !!config
.isolate
;
2548 this.opening
= null;
2550 this.closing
= null;
2551 this.preparingToOpen
= null;
2552 this.preparingToClose
= null;
2554 this.currentWindow
= null;
2555 this.$ariaHidden
= null;
2556 this.requestedSize
= null;
2557 this.onWindowResizeTimeout
= null;
2558 this.onWindowResizeHandler
= this.onWindowResize
.bind( this );
2559 this.afterWindowResizeHandler
= this.afterWindowResize
.bind( this );
2560 this.onWindowMouseWheelHandler
= this.onWindowMouseWheel
.bind( this );
2561 this.onDocumentKeyDownHandler
= this.onDocumentKeyDown
.bind( this );
2565 .addClass( 'oo-ui-windowManager' )
2566 .toggleClass( 'oo-ui-windowManager-modal', this.modal
);
2571 OO
.inheritClass( OO
.ui
.WindowManager
, OO
.ui
.Element
);
2572 OO
.mixinClass( OO
.ui
.WindowManager
, OO
.EventEmitter
);
2577 * Window is opening.
2579 * Fired when the window begins to be opened.
2582 * @param {OO.ui.Window} win Window that's being opened
2583 * @param {jQuery.Promise} opening Promise resolved when window is opened; when the promise is
2584 * resolved the first argument will be a promise which will be resolved when the window begins
2585 * closing, the second argument will be the opening data; progress notifications will be fired on
2586 * the promise for `setup` and `ready` when those processes are completed respectively.
2587 * @param {Object} data Window opening data
2591 * Window is closing.
2593 * Fired when the window begins to be closed.
2596 * @param {OO.ui.Window} win Window that's being closed
2597 * @param {jQuery.Promise} opening Promise resolved when window is closed; when the promise
2598 * is resolved the first argument will be a the closing data; progress notifications will be fired
2599 * on the promise for `hold` and `teardown` when those processes are completed respectively.
2600 * @param {Object} data Window closing data
2604 * Window was resized.
2607 * @param {OO.ui.Window} win Window that was resized
2610 /* Static Properties */
2613 * Map of symbolic size names and CSS properties.
2617 * @property {Object}
2619 OO
.ui
.WindowManager
.static.sizes
= {
2630 // These can be non-numeric because they are never used in calculations
2637 * Symbolic name of default size.
2639 * Default size is used if the window's requested size is not recognized.
2643 * @property {string}
2645 OO
.ui
.WindowManager
.static.defaultSize
= 'medium';
2650 * Handle window resize events.
2652 * @param {jQuery.Event} e Window resize event
2654 OO
.ui
.WindowManager
.prototype.onWindowResize = function () {
2655 clearTimeout( this.onWindowResizeTimeout
);
2656 this.onWindowResizeTimeout
= setTimeout( this.afterWindowResizeHandler
, 200 );
2660 * Handle window resize events.
2662 * @param {jQuery.Event} e Window resize event
2664 OO
.ui
.WindowManager
.prototype.afterWindowResize = function () {
2665 if ( this.currentWindow
) {
2666 this.updateWindowSize( this.currentWindow
);
2671 * Handle window mouse wheel events.
2673 * @param {jQuery.Event} e Mouse wheel event
2675 OO
.ui
.WindowManager
.prototype.onWindowMouseWheel = function ( e
) {
2676 // Kill all events in the parent window if the child window is isolated,
2677 // or if the event didn't come from the child window
2678 return !( this.shouldIsolate() || !$.contains( this.getCurrentWindow().$frame
[0], e
.target
) );
2682 * Handle document key down events.
2684 * @param {jQuery.Event} e Key down event
2686 OO
.ui
.WindowManager
.prototype.onDocumentKeyDown = function ( e
) {
2687 switch ( e
.which
) {
2688 case OO
.ui
.Keys
.PAGEUP
:
2689 case OO
.ui
.Keys
.PAGEDOWN
:
2690 case OO
.ui
.Keys
.END
:
2691 case OO
.ui
.Keys
.HOME
:
2692 case OO
.ui
.Keys
.LEFT
:
2694 case OO
.ui
.Keys
.RIGHT
:
2695 case OO
.ui
.Keys
.DOWN
:
2696 // Kill all events in the parent window if the child window is isolated,
2697 // or if the event didn't come from the child window
2698 return !( this.shouldIsolate() || !$.contains( this.getCurrentWindow().$frame
[0], e
.target
) );
2703 * Check if window is opening.
2705 * @return {boolean} Window is opening
2707 OO
.ui
.WindowManager
.prototype.isOpening = function ( win
) {
2708 return win
=== this.currentWindow
&& !!this.opening
&& this.opening
.state() === 'pending';
2712 * Check if window is closing.
2714 * @return {boolean} Window is closing
2716 OO
.ui
.WindowManager
.prototype.isClosing = function ( win
) {
2717 return win
=== this.currentWindow
&& !!this.closing
&& this.closing
.state() === 'pending';
2721 * Check if window is opened.
2723 * @return {boolean} Window is opened
2725 OO
.ui
.WindowManager
.prototype.isOpened = function ( win
) {
2726 return win
=== this.currentWindow
&& !!this.opened
&& this.opened
.state() === 'pending';
2730 * Check if window contents should be isolated.
2732 * Window content isolation is done using inline frames.
2734 * @return {boolean} Window contents should be isolated
2736 OO
.ui
.WindowManager
.prototype.shouldIsolate = function () {
2737 return this.isolate
;
2741 * Check if a window is being managed.
2743 * @param {OO.ui.Window} win Window to check
2744 * @return {boolean} Window is being managed
2746 OO
.ui
.WindowManager
.prototype.hasWindow = function ( win
) {
2749 for ( name
in this.windows
) {
2750 if ( this.windows
[name
] === win
) {
2759 * Get the number of milliseconds to wait between beginning opening and executing setup process.
2761 * @param {OO.ui.Window} win Window being opened
2762 * @param {Object} [data] Window opening data
2763 * @return {number} Milliseconds to wait
2765 OO
.ui
.WindowManager
.prototype.getSetupDelay = function () {
2770 * Get the number of milliseconds to wait between finishing setup and executing ready process.
2772 * @param {OO.ui.Window} win Window being opened
2773 * @param {Object} [data] Window opening data
2774 * @return {number} Milliseconds to wait
2776 OO
.ui
.WindowManager
.prototype.getReadyDelay = function () {
2781 * Get the number of milliseconds to wait between beginning closing and executing hold process.
2783 * @param {OO.ui.Window} win Window being closed
2784 * @param {Object} [data] Window closing data
2785 * @return {number} Milliseconds to wait
2787 OO
.ui
.WindowManager
.prototype.getHoldDelay = function () {
2792 * Get the number of milliseconds to wait between finishing hold and executing teardown process.
2794 * @param {OO.ui.Window} win Window being closed
2795 * @param {Object} [data] Window closing data
2796 * @return {number} Milliseconds to wait
2798 OO
.ui
.WindowManager
.prototype.getTeardownDelay = function () {
2799 return this.modal
? 250 : 0;
2803 * Get managed window by symbolic name.
2805 * If window is not yet instantiated, it will be instantiated and added automatically.
2807 * @param {string} name Symbolic window name
2808 * @return {jQuery.Promise} Promise resolved with matching window, or rejected with an OO.ui.Error
2809 * @throws {Error} If the symbolic name is unrecognized by the factory
2810 * @throws {Error} If the symbolic name unrecognized as a managed window
2812 OO
.ui
.WindowManager
.prototype.getWindow = function ( name
) {
2813 var deferred
= $.Deferred(),
2814 win
= this.windows
[name
];
2816 if ( !( win
instanceof OO
.ui
.Window
) ) {
2817 if ( this.factory
) {
2818 if ( !this.factory
.lookup( name
) ) {
2819 deferred
.reject( new OO
.ui
.Error(
2820 'Cannot auto-instantiate window: symbolic name is unrecognized by the factory'
2823 win
= this.factory
.create( name
, this, { $: this.$ } );
2824 this.addWindows( [ win
] );
2825 deferred
.resolve( win
);
2828 deferred
.reject( new OO
.ui
.Error(
2829 'Cannot get unmanaged window: symbolic name unrecognized as a managed window'
2833 deferred
.resolve( win
);
2836 return deferred
.promise();
2840 * Get current window.
2842 * @return {OO.ui.Window|null} Currently opening/opened/closing window
2844 OO
.ui
.WindowManager
.prototype.getCurrentWindow = function () {
2845 return this.currentWindow
;
2851 * @param {OO.ui.Window|string} win Window object or symbolic name of window to open
2852 * @param {Object} [data] Window opening data
2853 * @return {jQuery.Promise} Promise resolved when window is done opening; see {@link #event-opening}
2854 * for more details about the `opening` promise
2857 OO
.ui
.WindowManager
.prototype.openWindow = function ( win
, data
) {
2860 opening
= $.Deferred();
2862 // Argument handling
2863 if ( typeof win
=== 'string' ) {
2864 return this.getWindow( win
).then( function ( win
) {
2865 return manager
.openWindow( win
, data
);
2870 if ( !this.hasWindow( win
) ) {
2871 opening
.reject( new OO
.ui
.Error(
2872 'Cannot open window: window is not attached to manager'
2874 } else if ( this.preparingToOpen
|| this.opening
|| this.opened
) {
2875 opening
.reject( new OO
.ui
.Error(
2876 'Cannot open window: another window is opening or open'
2881 if ( opening
.state() !== 'rejected' ) {
2882 if ( !win
.getManager() ) {
2883 win
.setManager( this );
2885 preparing
.push( win
.load() );
2887 if ( this.closing
) {
2888 // If a window is currently closing, wait for it to complete
2889 preparing
.push( this.closing
);
2892 this.preparingToOpen
= $.when
.apply( $, preparing
);
2893 // Ensure handlers get called after preparingToOpen is set
2894 this.preparingToOpen
.done( function () {
2895 if ( manager
.modal
) {
2896 manager
.toggleGlobalEvents( true );
2897 manager
.toggleAriaIsolation( true );
2899 manager
.currentWindow
= win
;
2900 manager
.opening
= opening
;
2901 manager
.preparingToOpen
= null;
2902 manager
.emit( 'opening', win
, opening
, data
);
2903 setTimeout( function () {
2904 win
.setup( data
).then( function () {
2905 manager
.updateWindowSize( win
);
2906 manager
.opening
.notify( { state
: 'setup' } );
2907 setTimeout( function () {
2908 win
.ready( data
).then( function () {
2909 manager
.opening
.notify( { state
: 'ready' } );
2910 manager
.opening
= null;
2911 manager
.opened
= $.Deferred();
2912 opening
.resolve( manager
.opened
.promise(), data
);
2914 }, manager
.getReadyDelay() );
2916 }, manager
.getSetupDelay() );
2920 return opening
.promise();
2926 * @param {OO.ui.Window|string} win Window object or symbolic name of window to close
2927 * @param {Object} [data] Window closing data
2928 * @return {jQuery.Promise} Promise resolved when window is done closing; see {@link #event-closing}
2929 * for more details about the `closing` promise
2930 * @throws {Error} If no window by that name is being managed
2933 OO
.ui
.WindowManager
.prototype.closeWindow = function ( win
, data
) {
2936 closing
= $.Deferred(),
2939 // Argument handling
2940 if ( typeof win
=== 'string' ) {
2941 win
= this.windows
[win
];
2942 } else if ( !this.hasWindow( win
) ) {
2948 closing
.reject( new OO
.ui
.Error(
2949 'Cannot close window: window is not attached to manager'
2951 } else if ( win
!== this.currentWindow
) {
2952 closing
.reject( new OO
.ui
.Error(
2953 'Cannot close window: window already closed with different data'
2955 } else if ( this.preparingToClose
|| this.closing
) {
2956 closing
.reject( new OO
.ui
.Error(
2957 'Cannot close window: window already closing with different data'
2962 if ( closing
.state() !== 'rejected' ) {
2963 if ( this.opening
) {
2964 // If the window is currently opening, close it when it's done
2965 preparing
.push( this.opening
);
2968 this.preparingToClose
= $.when
.apply( $, preparing
);
2969 // Ensure handlers get called after preparingToClose is set
2970 this.preparingToClose
.done( function () {
2971 manager
.closing
= closing
;
2972 manager
.preparingToClose
= null;
2973 manager
.emit( 'closing', win
, closing
, data
);
2974 opened
= manager
.opened
;
2975 manager
.opened
= null;
2976 opened
.resolve( closing
.promise(), data
);
2977 setTimeout( function () {
2978 win
.hold( data
).then( function () {
2979 closing
.notify( { state
: 'hold' } );
2980 setTimeout( function () {
2981 win
.teardown( data
).then( function () {
2982 closing
.notify( { state
: 'teardown' } );
2983 if ( manager
.modal
) {
2984 manager
.toggleGlobalEvents( false );
2985 manager
.toggleAriaIsolation( false );
2987 manager
.closing
= null;
2988 manager
.currentWindow
= null;
2989 closing
.resolve( data
);
2991 }, manager
.getTeardownDelay() );
2993 }, manager
.getHoldDelay() );
2997 return closing
.promise();
3003 * @param {Object.<string,OO.ui.Window>|OO.ui.Window[]} windows Windows to add
3004 * @throws {Error} If one of the windows being added without an explicit symbolic name does not have
3005 * a statically configured symbolic name
3007 OO
.ui
.WindowManager
.prototype.addWindows = function ( windows
) {
3008 var i
, len
, win
, name
, list
;
3010 if ( $.isArray( windows
) ) {
3011 // Convert to map of windows by looking up symbolic names from static configuration
3013 for ( i
= 0, len
= windows
.length
; i
< len
; i
++ ) {
3014 name
= windows
[i
].constructor.static.name
;
3015 if ( typeof name
!== 'string' ) {
3016 throw new Error( 'Cannot add window' );
3018 list
[name
] = windows
[i
];
3020 } else if ( $.isPlainObject( windows
) ) {
3025 for ( name
in list
) {
3027 this.windows
[name
] = win
;
3028 this.$element
.append( win
.$element
);
3035 * Windows will be closed before they are removed.
3037 * @param {string} name Symbolic name of window to remove
3038 * @return {jQuery.Promise} Promise resolved when window is closed and removed
3039 * @throws {Error} If windows being removed are not being managed
3041 OO
.ui
.WindowManager
.prototype.removeWindows = function ( names
) {
3042 var i
, len
, win
, name
,
3045 cleanup = function ( name
, win
) {
3046 delete manager
.windows
[name
];
3047 win
.$element
.detach();
3050 for ( i
= 0, len
= names
.length
; i
< len
; i
++ ) {
3052 win
= this.windows
[name
];
3054 throw new Error( 'Cannot remove window' );
3056 promises
.push( this.closeWindow( name
).then( cleanup
.bind( null, name
, win
) ) );
3059 return $.when
.apply( $, promises
);
3063 * Remove all windows.
3065 * Windows will be closed before they are removed.
3067 * @return {jQuery.Promise} Promise resolved when all windows are closed and removed
3069 OO
.ui
.WindowManager
.prototype.clearWindows = function () {
3070 return this.removeWindows( Object
.keys( this.windows
) );
3076 * Fullscreen mode will be used if the dialog is too wide to fit in the screen.
3080 OO
.ui
.WindowManager
.prototype.updateWindowSize = function ( win
) {
3081 // Bypass for non-current, and thus invisible, windows
3082 if ( win
!== this.currentWindow
) {
3086 var viewport
= OO
.ui
.Element
.getDimensions( win
.getElementWindow() ),
3087 sizes
= this.constructor.static.sizes
,
3088 size
= win
.getSize();
3090 if ( !sizes
[size
] ) {
3091 size
= this.constructor.static.defaultSize
;
3093 if ( size
!== 'full' && viewport
.rect
.right
- viewport
.rect
.left
< sizes
[size
].width
) {
3097 this.$element
.toggleClass( 'oo-ui-windowManager-fullscreen', size
=== 'full' );
3098 this.$element
.toggleClass( 'oo-ui-windowManager-floating', size
!== 'full' );
3099 win
.setDimensions( sizes
[size
] );
3101 this.emit( 'resize', win
);
3107 * Bind or unbind global events for scrolling.
3109 * @param {boolean} [on] Bind global events
3112 OO
.ui
.WindowManager
.prototype.toggleGlobalEvents = function ( on
) {
3113 on
= on
=== undefined ? !!this.globalEvents
: !!on
;
3116 if ( !this.globalEvents
) {
3117 this.$( this.getElementDocument() ).on( {
3118 // Prevent scrolling by keys in top-level window
3119 keydown
: this.onDocumentKeyDownHandler
3121 this.$( this.getElementWindow() ).on( {
3122 // Prevent scrolling by wheel in top-level window
3123 mousewheel
: this.onWindowMouseWheelHandler
,
3124 // Start listening for top-level window dimension changes
3125 'orientationchange resize': this.onWindowResizeHandler
3127 this.globalEvents
= true;
3129 } else if ( this.globalEvents
) {
3130 // Unbind global events
3131 this.$( this.getElementDocument() ).off( {
3132 // Allow scrolling by keys in top-level window
3133 keydown
: this.onDocumentKeyDownHandler
3135 this.$( this.getElementWindow() ).off( {
3136 // Allow scrolling by wheel in top-level window
3137 mousewheel
: this.onWindowMouseWheelHandler
,
3138 // Stop listening for top-level window dimension changes
3139 'orientationchange resize': this.onWindowResizeHandler
3141 this.globalEvents
= false;
3148 * Toggle screen reader visibility of content other than the window manager.
3150 * @param {boolean} [isolate] Make only the window manager visible to screen readers
3153 OO
.ui
.WindowManager
.prototype.toggleAriaIsolation = function ( isolate
) {
3154 isolate
= isolate
=== undefined ? !this.$ariaHidden
: !!isolate
;
3157 if ( !this.$ariaHidden
) {
3158 // Hide everything other than the window manager from screen readers
3159 this.$ariaHidden
= $( 'body' )
3161 .not( this.$element
.parentsUntil( 'body' ).last() )
3162 .attr( 'aria-hidden', '' );
3164 } else if ( this.$ariaHidden
) {
3165 // Restore screen reader visiblity
3166 this.$ariaHidden
.removeAttr( 'aria-hidden' );
3167 this.$ariaHidden
= null;
3174 * Destroy window manager.
3176 * Windows will not be closed, only removed from the DOM.
3178 OO
.ui
.WindowManager
.prototype.destroy = function () {
3179 this.toggleGlobalEvents( false );
3180 this.toggleAriaIsolation( false );
3181 this.$element
.remove();
3189 * @param {string|jQuery} message Description of error
3190 * @param {Object} [config] Configuration options
3191 * @cfg {boolean} [recoverable=true] Error is recoverable
3192 * @cfg {boolean} [warning=false] Whether this error is a warning or not.
3194 OO
.ui
.Error
= function OoUiElement( message
, config
) {
3195 // Configuration initialization
3196 config
= config
|| {};
3199 this.message
= message
instanceof jQuery
? message
: String( message
);
3200 this.recoverable
= config
.recoverable
=== undefined || !!config
.recoverable
;
3201 this.warning
= !!config
.warning
;
3206 OO
.initClass( OO
.ui
.Error
);
3211 * Check if error can be recovered from.
3213 * @return {boolean} Error is recoverable
3215 OO
.ui
.Error
.prototype.isRecoverable = function () {
3216 return this.recoverable
;
3220 * Check if the error is a warning
3222 * @return {boolean} Error is warning
3224 OO
.ui
.Error
.prototype.isWarning = function () {
3225 return this.warning
;
3229 * Get error message as DOM nodes.
3231 * @return {jQuery} Error message in DOM nodes
3233 OO
.ui
.Error
.prototype.getMessage = function () {
3234 return this.message
instanceof jQuery
?
3235 this.message
.clone() :
3236 $( '<div>' ).text( this.message
).contents();
3240 * Get error message as text.
3242 * @return {string} Error message
3244 OO
.ui
.Error
.prototype.getMessageText = function () {
3245 return this.message
instanceof jQuery
? this.message
.text() : this.message
;
3249 * A list of functions, called in sequence.
3251 * If a function added to a process returns boolean false the process will stop; if it returns an
3252 * object with a `promise` method the process will use the promise to either continue to the next
3253 * step when the promise is resolved or stop when the promise is rejected.
3258 * @param {number|jQuery.Promise|Function} step Time to wait, promise to wait for or function to
3259 * call, see #createStep for more information
3260 * @param {Object} [context=null] Context to call the step function in, ignored if step is a number
3262 * @return {Object} Step object, with `callback` and `context` properties
3264 OO
.ui
.Process = function ( step
, context
) {
3269 if ( step
!== undefined ) {
3270 this.next( step
, context
);
3276 OO
.initClass( OO
.ui
.Process
);
3281 * Start the process.
3283 * @return {jQuery.Promise} Promise that is resolved when all steps have completed or rejected when
3284 * any of the steps return boolean false or a promise which gets rejected; upon stopping the
3285 * process, the remaining steps will not be taken
3287 OO
.ui
.Process
.prototype.execute = function () {
3288 var i
, len
, promise
;
3291 * Continue execution.
3294 * @param {Array} step A function and the context it should be called in
3295 * @return {Function} Function that continues the process
3297 function proceed( step
) {
3298 return function () {
3299 // Execute step in the correct context
3301 result
= step
.callback
.call( step
.context
);
3303 if ( result
=== false ) {
3304 // Use rejected promise for boolean false results
3305 return $.Deferred().reject( [] ).promise();
3307 if ( typeof result
=== 'number' ) {
3309 throw new Error( 'Cannot go back in time: flux capacitor is out of service' );
3311 // Use a delayed promise for numbers, expecting them to be in milliseconds
3312 deferred
= $.Deferred();
3313 setTimeout( deferred
.resolve
, result
);
3314 return deferred
.promise();
3316 if ( result
instanceof OO
.ui
.Error
) {
3317 // Use rejected promise for error
3318 return $.Deferred().reject( [ result
] ).promise();
3320 if ( $.isArray( result
) && result
.length
&& result
[0] instanceof OO
.ui
.Error
) {
3321 // Use rejected promise for list of errors
3322 return $.Deferred().reject( result
).promise();
3324 // Duck-type the object to see if it can produce a promise
3325 if ( result
&& $.isFunction( result
.promise
) ) {
3326 // Use a promise generated from the result
3327 return result
.promise();
3329 // Use resolved promise for other results
3330 return $.Deferred().resolve().promise();
3334 if ( this.steps
.length
) {
3335 // Generate a chain reaction of promises
3336 promise
= proceed( this.steps
[0] )();
3337 for ( i
= 1, len
= this.steps
.length
; i
< len
; i
++ ) {
3338 promise
= promise
.then( proceed( this.steps
[i
] ) );
3341 promise
= $.Deferred().resolve().promise();
3348 * Create a process step.
3351 * @param {number|jQuery.Promise|Function} step
3353 * - Number of milliseconds to wait; or
3354 * - Promise to wait to be resolved; or
3355 * - Function to execute
3356 * - If it returns boolean false the process will stop
3357 * - If it returns an object with a `promise` method the process will use the promise to either
3358 * continue to the next step when the promise is resolved or stop when the promise is rejected
3359 * - If it returns a number, the process will wait for that number of milliseconds before
3361 * @param {Object} [context=null] Context to call the step function in, ignored if step is a number
3363 * @return {Object} Step object, with `callback` and `context` properties
3365 OO
.ui
.Process
.prototype.createStep = function ( step
, context
) {
3366 if ( typeof step
=== 'number' || $.isFunction( step
.promise
) ) {
3368 callback: function () {
3374 if ( $.isFunction( step
) ) {
3380 throw new Error( 'Cannot create process step: number, promise or function expected' );
3384 * Add step to the beginning of the process.
3386 * @inheritdoc #createStep
3387 * @return {OO.ui.Process} this
3390 OO
.ui
.Process
.prototype.first = function ( step
, context
) {
3391 this.steps
.unshift( this.createStep( step
, context
) );
3396 * Add step to the end of the process.
3398 * @inheritdoc #createStep
3399 * @return {OO.ui.Process} this
3402 OO
.ui
.Process
.prototype.next = function ( step
, context
) {
3403 this.steps
.push( this.createStep( step
, context
) );
3408 * Factory for tools.
3411 * @extends OO.Factory
3414 OO
.ui
.ToolFactory
= function OoUiToolFactory() {
3415 // Parent constructor
3416 OO
.ui
.ToolFactory
.super.call( this );
3421 OO
.inheritClass( OO
.ui
.ToolFactory
, OO
.Factory
);
3426 OO
.ui
.ToolFactory
.prototype.getTools = function ( include
, exclude
, promote
, demote
) {
3427 var i
, len
, included
, promoted
, demoted
,
3431 // Collect included and not excluded tools
3432 included
= OO
.simpleArrayDifference( this.extract( include
), this.extract( exclude
) );
3435 promoted
= this.extract( promote
, used
);
3436 demoted
= this.extract( demote
, used
);
3439 for ( i
= 0, len
= included
.length
; i
< len
; i
++ ) {
3440 if ( !used
[included
[i
]] ) {
3441 auto
.push( included
[i
] );
3445 return promoted
.concat( auto
).concat( demoted
);
3449 * Get a flat list of names from a list of names or groups.
3451 * Tools can be specified in the following ways:
3453 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
3454 * - All tools in a group: `{ group: 'group-name' }`
3455 * - All tools: `'*'`
3458 * @param {Array|string} collection List of tools
3459 * @param {Object} [used] Object with names that should be skipped as properties; extracted
3460 * names will be added as properties
3461 * @return {string[]} List of extracted names
3463 OO
.ui
.ToolFactory
.prototype.extract = function ( collection
, used
) {
3464 var i
, len
, item
, name
, tool
,
3467 if ( collection
=== '*' ) {
3468 for ( name
in this.registry
) {
3469 tool
= this.registry
[name
];
3471 // Only add tools by group name when auto-add is enabled
3472 tool
.static.autoAddToCatchall
&&
3473 // Exclude already used tools
3474 ( !used
|| !used
[name
] )
3482 } else if ( $.isArray( collection
) ) {
3483 for ( i
= 0, len
= collection
.length
; i
< len
; i
++ ) {
3484 item
= collection
[i
];
3485 // Allow plain strings as shorthand for named tools
3486 if ( typeof item
=== 'string' ) {
3487 item
= { name
: item
};
3489 if ( OO
.isPlainObject( item
) ) {
3491 for ( name
in this.registry
) {
3492 tool
= this.registry
[name
];
3494 // Include tools with matching group
3495 tool
.static.group
=== item
.group
&&
3496 // Only add tools by group name when auto-add is enabled
3497 tool
.static.autoAddToGroup
&&
3498 // Exclude already used tools
3499 ( !used
|| !used
[name
] )
3507 // Include tools with matching name and exclude already used tools
3508 } else if ( item
.name
&& ( !used
|| !used
[item
.name
] ) ) {
3509 names
.push( item
.name
);
3511 used
[item
.name
] = true;
3521 * Factory for tool groups.
3524 * @extends OO.Factory
3527 OO
.ui
.ToolGroupFactory
= function OoUiToolGroupFactory() {
3528 // Parent constructor
3529 OO
.Factory
.call( this );
3532 defaultClasses
= this.constructor.static.getDefaultClasses();
3534 // Register default toolgroups
3535 for ( i
= 0, l
= defaultClasses
.length
; i
< l
; i
++ ) {
3536 this.register( defaultClasses
[i
] );
3542 OO
.inheritClass( OO
.ui
.ToolGroupFactory
, OO
.Factory
);
3544 /* Static Methods */
3547 * Get a default set of classes to be registered on construction
3549 * @return {Function[]} Default classes
3551 OO
.ui
.ToolGroupFactory
.static.getDefaultClasses = function () {
3554 OO
.ui
.ListToolGroup
,
3566 * @param {Object} [config] Configuration options
3568 OO
.ui
.Theme
= function OoUiTheme( config
) {
3569 // Configuration initialization
3570 config
= config
|| {};
3575 OO
.initClass( OO
.ui
.Theme
);
3580 * Get a list of classes to be applied to a widget.
3582 * The 'on' and 'off' lists combined MUST contain keys for all classes the theme adds or removes,
3583 * otherwise state transitions will not work properly.
3585 * @param {OO.ui.Element} element Element for which to get classes
3586 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
3588 OO
.ui
.Theme
.prototype.getElementClasses = function ( /* element */ ) {
3589 return { on
: [], off
: [] };
3593 * Update CSS classes provided by the theme.
3595 * For elements with theme logic hooks, this should be called anytime there's a state change.
3597 * @param {OO.ui.Element} element Element for which to update classes
3598 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
3600 OO
.ui
.Theme
.prototype.updateElementClasses = function ( element
) {
3601 var classes
= this.getElementClasses( element
);
3604 .removeClass( classes
.off
.join( ' ' ) )
3605 .addClass( classes
.on
.join( ' ' ) );
3609 * Element with a button.
3611 * Buttons are used for controls which can be clicked. They can be configured to use tab indexing
3612 * and access keys for accessibility purposes.
3618 * @param {Object} [config] Configuration options
3619 * @cfg {jQuery} [$button] Button node, assigned to #$button, omit to use a generated `<a>`
3620 * @cfg {boolean} [framed=true] Render button with a frame
3621 * @cfg {number} [tabIndex=0] Button's tab index. Use 0 to use default ordering, use -1 to prevent
3623 * @cfg {string} [accessKey] Button's access key
3625 OO
.ui
.ButtonElement
= function OoUiButtonElement( config
) {
3626 // Configuration initialization
3627 config
= config
|| {};
3630 this.$button
= null;
3632 this.tabIndex
= null;
3633 this.accessKey
= null;
3634 this.active
= false;
3635 this.onMouseUpHandler
= this.onMouseUp
.bind( this );
3636 this.onMouseDownHandler
= this.onMouseDown
.bind( this );
3639 this.$element
.addClass( 'oo-ui-buttonElement' );
3640 this.toggleFramed( config
.framed
=== undefined || config
.framed
);
3641 this.setTabIndex( config
.tabIndex
|| 0 );
3642 this.setAccessKey( config
.accessKey
);
3643 this.setButtonElement( config
.$button
|| this.$( '<a>' ) );
3648 OO
.initClass( OO
.ui
.ButtonElement
);
3650 /* Static Properties */
3653 * Cancel mouse down events.
3657 * @property {boolean}
3659 OO
.ui
.ButtonElement
.static.cancelButtonMouseDownEvents
= true;
3664 * Set the button element.
3666 * If an element is already set, it will be cleaned up before setting up the new element.
3668 * @param {jQuery} $button Element to use as button
3670 OO
.ui
.ButtonElement
.prototype.setButtonElement = function ( $button
) {
3671 if ( this.$button
) {
3673 .removeClass( 'oo-ui-buttonElement-button' )
3674 .removeAttr( 'role accesskey tabindex' )
3675 .off( this.onMouseDownHandler
);
3678 this.$button
= $button
3679 .addClass( 'oo-ui-buttonElement-button' )
3680 .attr( { role
: 'button', accesskey
: this.accessKey
, tabindex
: this.tabIndex
} )
3681 .on( 'mousedown', this.onMouseDownHandler
);
3685 * Handles mouse down events.
3687 * @param {jQuery.Event} e Mouse down event
3689 OO
.ui
.ButtonElement
.prototype.onMouseDown = function ( e
) {
3690 if ( this.isDisabled() || e
.which
!== 1 ) {
3693 // Remove the tab-index while the button is down to prevent the button from stealing focus
3694 this.$button
.removeAttr( 'tabindex' );
3695 this.$element
.addClass( 'oo-ui-buttonElement-pressed' );
3696 // Run the mouseup handler no matter where the mouse is when the button is let go, so we can
3697 // reliably reapply the tabindex and remove the pressed class
3698 this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler
, true );
3699 // Prevent change of focus unless specifically configured otherwise
3700 if ( this.constructor.static.cancelButtonMouseDownEvents
) {
3706 * Handles mouse up events.
3708 * @param {jQuery.Event} e Mouse up event
3710 OO
.ui
.ButtonElement
.prototype.onMouseUp = function ( e
) {
3711 if ( this.isDisabled() || e
.which
!== 1 ) {
3714 // Restore the tab-index after the button is up to restore the button's accesssibility
3715 this.$button
.attr( 'tabindex', this.tabIndex
);
3716 this.$element
.removeClass( 'oo-ui-buttonElement-pressed' );
3717 // Stop listening for mouseup, since we only needed this once
3718 this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler
, true );
3722 * Check if button has a frame.
3724 * @return {boolean} Button is framed
3726 OO
.ui
.ButtonElement
.prototype.isFramed = function () {
3733 * @param {boolean} [framed] Make button framed, omit to toggle
3736 OO
.ui
.ButtonElement
.prototype.toggleFramed = function ( framed
) {
3737 framed
= framed
=== undefined ? !this.framed
: !!framed
;
3738 if ( framed
!== this.framed
) {
3739 this.framed
= framed
;
3741 .toggleClass( 'oo-ui-buttonElement-frameless', !framed
)
3742 .toggleClass( 'oo-ui-buttonElement-framed', framed
);
3743 this.updateThemeClasses();
3752 * @param {number|null} tabIndex Button's tab index, use null to remove
3755 OO
.ui
.ButtonElement
.prototype.setTabIndex = function ( tabIndex
) {
3756 tabIndex
= typeof tabIndex
=== 'number' && tabIndex
>= 0 ? tabIndex
: null;
3758 if ( this.tabIndex
!== tabIndex
) {
3759 if ( this.$button
) {
3760 if ( tabIndex
!== null ) {
3761 this.$button
.attr( 'tabindex', tabIndex
);
3763 this.$button
.removeAttr( 'tabindex' );
3766 this.tabIndex
= tabIndex
;
3775 * @param {string} accessKey Button's access key, use empty string to remove
3778 OO
.ui
.ButtonElement
.prototype.setAccessKey = function ( accessKey
) {
3779 accessKey
= typeof accessKey
=== 'string' && accessKey
.length
? accessKey
: null;
3781 if ( this.accessKey
!== accessKey
) {
3782 if ( this.$button
) {
3783 if ( accessKey
!== null ) {
3784 this.$button
.attr( 'accesskey', accessKey
);
3786 this.$button
.removeAttr( 'accesskey' );
3789 this.accessKey
= accessKey
;
3798 * @param {boolean} [value] Make button active
3801 OO
.ui
.ButtonElement
.prototype.setActive = function ( value
) {
3802 this.$element
.toggleClass( 'oo-ui-buttonElement-active', !!value
);
3807 * Element containing a sequence of child elements.
3813 * @param {Object} [config] Configuration options
3814 * @cfg {jQuery} [$group] Container node, assigned to #$group, omit to use a generated `<div>`
3816 OO
.ui
.GroupElement
= function OoUiGroupElement( config
) {
3817 // Configuration intialization
3818 config
= config
|| {};
3823 this.aggregateItemEvents
= {};
3826 this.setGroupElement( config
.$group
|| this.$( '<div>' ) );
3832 * Set the group element.
3834 * If an element is already set, items will be moved to the new element.
3836 * @param {jQuery} $group Element to use as group
3838 OO
.ui
.GroupElement
.prototype.setGroupElement = function ( $group
) {
3841 this.$group
= $group
;
3842 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3843 this.$group
.append( this.items
[i
].$element
);
3848 * Check if there are no items.
3850 * @return {boolean} Group is empty
3852 OO
.ui
.GroupElement
.prototype.isEmpty = function () {
3853 return !this.items
.length
;
3859 * @return {OO.ui.Element[]} Items
3861 OO
.ui
.GroupElement
.prototype.getItems = function () {
3862 return this.items
.slice( 0 );
3866 * Add an aggregate item event.
3868 * Aggregated events are listened to on each item and then emitted by the group under a new name,
3869 * and with an additional leading parameter containing the item that emitted the original event.
3870 * Other arguments that were emitted from the original event are passed through.
3872 * @param {Object.<string,string|null>} events Aggregate events emitted by group, keyed by item
3873 * event, use null value to remove aggregation
3874 * @throws {Error} If aggregation already exists
3876 OO
.ui
.GroupElement
.prototype.aggregate = function ( events
) {
3877 var i
, len
, item
, add
, remove
, itemEvent
, groupEvent
;
3879 for ( itemEvent
in events
) {
3880 groupEvent
= events
[itemEvent
];
3882 // Remove existing aggregated event
3883 if ( Object
.prototype.hasOwnProperty
.call( this.aggregateItemEvents
, itemEvent
) ) {
3884 // Don't allow duplicate aggregations
3886 throw new Error( 'Duplicate item event aggregation for ' + itemEvent
);
3888 // Remove event aggregation from existing items
3889 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3890 item
= this.items
[i
];
3891 if ( item
.connect
&& item
.disconnect
) {
3893 remove
[itemEvent
] = [ 'emit', groupEvent
, item
];
3894 item
.disconnect( this, remove
);
3897 // Prevent future items from aggregating event
3898 delete this.aggregateItemEvents
[itemEvent
];
3901 // Add new aggregate event
3903 // Make future items aggregate event
3904 this.aggregateItemEvents
[itemEvent
] = groupEvent
;
3905 // Add event aggregation to existing items
3906 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3907 item
= this.items
[i
];
3908 if ( item
.connect
&& item
.disconnect
) {
3910 add
[itemEvent
] = [ 'emit', groupEvent
, item
];
3911 item
.connect( this, add
);
3921 * Adding an existing item will move it.
3923 * @param {OO.ui.Element[]} items Items
3924 * @param {number} [index] Index to insert items at
3927 OO
.ui
.GroupElement
.prototype.addItems = function ( items
, index
) {
3928 var i
, len
, item
, event
, events
, currentIndex
,
3931 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
3934 // Check if item exists then remove it first, effectively "moving" it
3935 currentIndex
= $.inArray( item
, this.items
);
3936 if ( currentIndex
>= 0 ) {
3937 this.removeItems( [ item
] );
3938 // Adjust index to compensate for removal
3939 if ( currentIndex
< index
) {
3944 if ( item
.connect
&& item
.disconnect
&& !$.isEmptyObject( this.aggregateItemEvents
) ) {
3946 for ( event
in this.aggregateItemEvents
) {
3947 events
[event
] = [ 'emit', this.aggregateItemEvents
[event
], item
];
3949 item
.connect( this, events
);
3951 item
.setElementGroup( this );
3952 itemElements
.push( item
.$element
.get( 0 ) );
3955 if ( index
=== undefined || index
< 0 || index
>= this.items
.length
) {
3956 this.$group
.append( itemElements
);
3957 this.items
.push
.apply( this.items
, items
);
3958 } else if ( index
=== 0 ) {
3959 this.$group
.prepend( itemElements
);
3960 this.items
.unshift
.apply( this.items
, items
);
3962 this.items
[index
].$element
.before( itemElements
);
3963 this.items
.splice
.apply( this.items
, [ index
, 0 ].concat( items
) );
3972 * Items will be detached, not removed, so they can be used later.
3974 * @param {OO.ui.Element[]} items Items to remove
3977 OO
.ui
.GroupElement
.prototype.removeItems = function ( items
) {
3978 var i
, len
, item
, index
, remove
, itemEvent
;
3980 // Remove specific items
3981 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
3983 index
= $.inArray( item
, this.items
);
3984 if ( index
!== -1 ) {
3986 item
.connect
&& item
.disconnect
&&
3987 !$.isEmptyObject( this.aggregateItemEvents
)
3990 if ( Object
.prototype.hasOwnProperty
.call( this.aggregateItemEvents
, itemEvent
) ) {
3991 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
3993 item
.disconnect( this, remove
);
3995 item
.setElementGroup( null );
3996 this.items
.splice( index
, 1 );
3997 item
.$element
.detach();
4007 * Items will be detached, not removed, so they can be used later.
4011 OO
.ui
.GroupElement
.prototype.clearItems = function () {
4012 var i
, len
, item
, remove
, itemEvent
;
4015 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
4016 item
= this.items
[i
];
4018 item
.connect
&& item
.disconnect
&&
4019 !$.isEmptyObject( this.aggregateItemEvents
)
4022 if ( Object
.prototype.hasOwnProperty
.call( this.aggregateItemEvents
, itemEvent
) ) {
4023 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
4025 item
.disconnect( this, remove
);
4027 item
.setElementGroup( null );
4028 item
.$element
.detach();
4036 * Element containing an icon.
4038 * Icons are graphics, about the size of normal text. They can be used to aid the user in locating
4039 * a control or convey information in a more space efficient way. Icons should rarely be used
4040 * without labels; such as in a toolbar where space is at a premium or within a context where the
4041 * meaning is very clear to the user.
4047 * @param {Object} [config] Configuration options
4048 * @cfg {jQuery} [$icon] Icon node, assigned to #$icon, omit to use a generated `<span>`
4049 * @cfg {Object|string} [icon=''] Symbolic icon name, or map of icon names keyed by language ID;
4050 * use the 'default' key to specify the icon to be used when there is no icon in the user's
4052 * @cfg {string} [iconTitle] Icon title text or a function that returns text
4054 OO
.ui
.IconElement
= function OoUiIconElement( config
) {
4055 // Configuration intialization
4056 config
= config
|| {};
4061 this.iconTitle
= null;
4064 this.setIcon( config
.icon
|| this.constructor.static.icon
);
4065 this.setIconTitle( config
.iconTitle
|| this.constructor.static.iconTitle
);
4066 this.setIconElement( config
.$icon
|| this.$( '<span>' ) );
4071 OO
.initClass( OO
.ui
.IconElement
);
4073 /* Static Properties */
4078 * Value should be the unique portion of an icon CSS class name, such as 'up' for 'oo-ui-icon-up'.
4080 * For i18n purposes, this property can be an object containing a `default` icon name property and
4081 * additional icon names keyed by language code.
4083 * Example of i18n icon definition:
4084 * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
4088 * @property {Object|string} Symbolic icon name, or map of icon names keyed by language ID;
4089 * use the 'default' key to specify the icon to be used when there is no icon in the user's
4092 OO
.ui
.IconElement
.static.icon
= null;
4099 * @property {string|Function|null} Icon title text, a function that returns text or null for no
4102 OO
.ui
.IconElement
.static.iconTitle
= null;
4107 * Set the icon element.
4109 * If an element is already set, it will be cleaned up before setting up the new element.
4111 * @param {jQuery} $icon Element to use as icon
4113 OO
.ui
.IconElement
.prototype.setIconElement = function ( $icon
) {
4116 .removeClass( 'oo-ui-iconElement-icon oo-ui-icon-' + this.icon
)
4117 .removeAttr( 'title' );
4121 .addClass( 'oo-ui-iconElement-icon' )
4122 .toggleClass( 'oo-ui-icon-' + this.icon
, !!this.icon
);
4123 if ( this.iconTitle
!== null ) {
4124 this.$icon
.attr( 'title', this.iconTitle
);
4131 * @param {Object|string|null} icon Symbolic icon name, or map of icon names keyed by language ID;
4132 * use the 'default' key to specify the icon to be used when there is no icon in the user's
4133 * language, use null to remove icon
4136 OO
.ui
.IconElement
.prototype.setIcon = function ( icon
) {
4137 icon
= OO
.isPlainObject( icon
) ? OO
.ui
.getLocalValue( icon
, null, 'default' ) : icon
;
4138 icon
= typeof icon
=== 'string' && icon
.trim().length
? icon
.trim() : null;
4140 if ( this.icon
!== icon
) {
4142 if ( this.icon
!== null ) {
4143 this.$icon
.removeClass( 'oo-ui-icon-' + this.icon
);
4145 if ( icon
!== null ) {
4146 this.$icon
.addClass( 'oo-ui-icon-' + icon
);
4152 this.$element
.toggleClass( 'oo-ui-iconElement', !!this.icon
);
4153 this.updateThemeClasses();
4161 * @param {string|Function|null} icon Icon title text, a function that returns text or null
4165 OO
.ui
.IconElement
.prototype.setIconTitle = function ( iconTitle
) {
4166 iconTitle
= typeof iconTitle
=== 'function' ||
4167 ( typeof iconTitle
=== 'string' && iconTitle
.length
) ?
4168 OO
.ui
.resolveMsg( iconTitle
) : null;
4170 if ( this.iconTitle
!== iconTitle
) {
4171 this.iconTitle
= iconTitle
;
4173 if ( this.iconTitle
!== null ) {
4174 this.$icon
.attr( 'title', iconTitle
);
4176 this.$icon
.removeAttr( 'title' );
4187 * @return {string} Icon name
4189 OO
.ui
.IconElement
.prototype.getIcon = function () {
4194 * Element containing an indicator.
4196 * Indicators are graphics, smaller than normal text. They can be used to describe unique status or
4197 * behavior. Indicators should only be used in exceptional cases; such as a button that opens a menu
4198 * instead of performing an action directly, or an item in a list which has errors that need to be
4205 * @param {Object} [config] Configuration options
4206 * @cfg {jQuery} [$indicator] Indicator node, assigned to #$indicator, omit to use a generated
4208 * @cfg {string} [indicator] Symbolic indicator name
4209 * @cfg {string} [indicatorTitle] Indicator title text or a function that returns text
4211 OO
.ui
.IndicatorElement
= function OoUiIndicatorElement( config
) {
4212 // Configuration initialization
4213 config
= config
|| {};
4216 this.$indicator
= null;
4217 this.indicator
= null;
4218 this.indicatorTitle
= null;
4221 this.setIndicator( config
.indicator
|| this.constructor.static.indicator
);
4222 this.setIndicatorTitle( config
.indicatorTitle
|| this.constructor.static.indicatorTitle
);
4223 this.setIndicatorElement( config
.$indicator
|| this.$( '<span>' ) );
4228 OO
.initClass( OO
.ui
.IndicatorElement
);
4230 /* Static Properties */
4237 * @property {string|null} Symbolic indicator name
4239 OO
.ui
.IndicatorElement
.static.indicator
= null;
4246 * @property {string|Function|null} Indicator title text, a function that returns text or null for no
4249 OO
.ui
.IndicatorElement
.static.indicatorTitle
= null;
4254 * Set the indicator element.
4256 * If an element is already set, it will be cleaned up before setting up the new element.
4258 * @param {jQuery} $indicator Element to use as indicator
4260 OO
.ui
.IndicatorElement
.prototype.setIndicatorElement = function ( $indicator
) {
4261 if ( this.$indicator
) {
4263 .removeClass( 'oo-ui-indicatorElement-indicator oo-ui-indicator-' + this.indicator
)
4264 .removeAttr( 'title' );
4267 this.$indicator
= $indicator
4268 .addClass( 'oo-ui-indicatorElement-indicator' )
4269 .toggleClass( 'oo-ui-indicator-' + this.indicator
, !!this.indicator
);
4270 if ( this.indicatorTitle
!== null ) {
4271 this.$indicatorTitle
.attr( 'title', this.indicatorTitle
);
4276 * Set indicator name.
4278 * @param {string|null} indicator Symbolic name of indicator to use or null for no indicator
4281 OO
.ui
.IndicatorElement
.prototype.setIndicator = function ( indicator
) {
4282 indicator
= typeof indicator
=== 'string' && indicator
.length
? indicator
.trim() : null;
4284 if ( this.indicator
!== indicator
) {
4285 if ( this.$indicator
) {
4286 if ( this.indicator
!== null ) {
4287 this.$indicator
.removeClass( 'oo-ui-indicator-' + this.indicator
);
4289 if ( indicator
!== null ) {
4290 this.$indicator
.addClass( 'oo-ui-indicator-' + indicator
);
4293 this.indicator
= indicator
;
4296 this.$element
.toggleClass( 'oo-ui-indicatorElement', !!this.indicator
);
4297 this.updateThemeClasses();
4303 * Set indicator title.
4305 * @param {string|Function|null} indicator Indicator title text, a function that returns text or
4306 * null for no indicator title
4309 OO
.ui
.IndicatorElement
.prototype.setIndicatorTitle = function ( indicatorTitle
) {
4310 indicatorTitle
= typeof indicatorTitle
=== 'function' ||
4311 ( typeof indicatorTitle
=== 'string' && indicatorTitle
.length
) ?
4312 OO
.ui
.resolveMsg( indicatorTitle
) : null;
4314 if ( this.indicatorTitle
!== indicatorTitle
) {
4315 this.indicatorTitle
= indicatorTitle
;
4316 if ( this.$indicator
) {
4317 if ( this.indicatorTitle
!== null ) {
4318 this.$indicator
.attr( 'title', indicatorTitle
);
4320 this.$indicator
.removeAttr( 'title' );
4329 * Get indicator name.
4331 * @return {string} Symbolic name of indicator
4333 OO
.ui
.IndicatorElement
.prototype.getIndicator = function () {
4334 return this.indicator
;
4338 * Get indicator title.
4340 * @return {string} Indicator title text
4342 OO
.ui
.IndicatorElement
.prototype.getIndicatorTitle = function () {
4343 return this.indicatorTitle
;
4347 * Element containing a label.
4353 * @param {Object} [config] Configuration options
4354 * @cfg {jQuery} [$label] Label node, assigned to #$label, omit to use a generated `<span>`
4355 * @cfg {jQuery|string|Function} [label] Label nodes, text or a function that returns nodes or text
4356 * @cfg {boolean} [autoFitLabel=true] Whether to fit the label or not.
4358 OO
.ui
.LabelElement
= function OoUiLabelElement( config
) {
4359 // Configuration initialization
4360 config
= config
|| {};
4365 this.autoFitLabel
= config
.autoFitLabel
=== undefined || !!config
.autoFitLabel
;
4368 this.setLabel( config
.label
|| this.constructor.static.label
);
4369 this.setLabelElement( config
.$label
|| this.$( '<span>' ) );
4374 OO
.initClass( OO
.ui
.LabelElement
);
4376 /* Static Properties */
4383 * @property {string|Function|null} Label text; a function that returns nodes or text; or null for
4386 OO
.ui
.LabelElement
.static.label
= null;
4391 * Set the label element.
4393 * If an element is already set, it will be cleaned up before setting up the new element.
4395 * @param {jQuery} $label Element to use as label
4397 OO
.ui
.LabelElement
.prototype.setLabelElement = function ( $label
) {
4398 if ( this.$label
) {
4399 this.$label
.removeClass( 'oo-ui-labelElement-label' ).empty();
4402 this.$label
= $label
.addClass( 'oo-ui-labelElement-label' );
4403 this.setLabelContent( this.label
);
4409 * An empty string will result in the label being hidden. A string containing only whitespace will
4410 * be converted to a single ` `.
4412 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
4413 * text; or null for no label
4416 OO
.ui
.LabelElement
.prototype.setLabel = function ( label
) {
4417 label
= typeof label
=== 'function' ? OO
.ui
.resolveMsg( label
) : label
;
4418 label
= ( typeof label
=== 'string' && label
.length
) || label
instanceof jQuery
? label
: null;
4420 if ( this.label
!== label
) {
4421 if ( this.$label
) {
4422 this.setLabelContent( label
);
4427 this.$element
.toggleClass( 'oo-ui-labelElement', !!this.label
);
4435 * @return {jQuery|string|Function|null} Label nodes; text; a function that returns nodes or
4436 * text; or null for no label
4438 OO
.ui
.LabelElement
.prototype.getLabel = function () {
4447 OO
.ui
.LabelElement
.prototype.fitLabel = function () {
4448 if ( this.$label
&& this.$label
.autoEllipsis
&& this.autoFitLabel
) {
4449 this.$label
.autoEllipsis( { hasSpan
: false, tooltip
: true } );
4456 * Set the content of the label.
4458 * Do not call this method until after the label element has been set by #setLabelElement.
4461 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
4462 * text; or null for no label
4464 OO
.ui
.LabelElement
.prototype.setLabelContent = function ( label
) {
4465 if ( typeof label
=== 'string' ) {
4466 if ( label
.match( /^\s*$/ ) ) {
4467 // Convert whitespace only string to a single non-breaking space
4468 this.$label
.html( ' ' );
4470 this.$label
.text( label
);
4472 } else if ( label
instanceof jQuery
) {
4473 this.$label
.empty().append( label
);
4475 this.$label
.empty();
4477 this.$label
.css( 'display', !label
? 'none' : '' );
4481 * Element containing an OO.ui.PopupWidget object.
4487 * @param {Object} [config] Configuration options
4488 * @cfg {Object} [popup] Configuration to pass to popup
4489 * @cfg {boolean} [autoClose=true] Popup auto-closes when it loses focus
4491 OO
.ui
.PopupElement
= function OoUiPopupElement( config
) {
4492 // Configuration initialization
4493 config
= config
|| {};
4496 this.popup
= new OO
.ui
.PopupWidget( $.extend(
4497 { autoClose
: true },
4499 { $: this.$, $autoCloseIgnore
: this.$element
}
4508 * @return {OO.ui.PopupWidget} Popup widget
4510 OO
.ui
.PopupElement
.prototype.getPopup = function () {
4515 * Element with named flags that can be added, removed, listed and checked.
4517 * A flag, when set, adds a CSS class on the `$element` by combining `oo-ui-flaggedElement-` with
4518 * the flag name. Flags are primarily useful for styling.
4524 * @param {Object} [config] Configuration options
4525 * @cfg {string|string[]} [flags] Styling flags, e.g. 'primary', 'destructive' or 'constructive'
4526 * @cfg {jQuery} [$flagged] Flagged node, assigned to #$flagged, omit to use #$element
4528 OO
.ui
.FlaggedElement
= function OoUiFlaggedElement( config
) {
4529 // Configuration initialization
4530 config
= config
|| {};
4534 this.$flagged
= null;
4537 this.setFlags( config
.flags
);
4538 this.setFlaggedElement( config
.$flagged
|| this.$element
);
4545 * @param {Object.<string,boolean>} changes Object keyed by flag name containing boolean
4546 * added/removed properties
4552 * Set the flagged element.
4554 * If an element is already set, it will be cleaned up before setting up the new element.
4556 * @param {jQuery} $flagged Element to add flags to
4558 OO
.ui
.FlaggedElement
.prototype.setFlaggedElement = function ( $flagged
) {
4559 var classNames
= Object
.keys( this.flags
).map( function ( flag
) {
4560 return 'oo-ui-flaggedElement-' + flag
;
4563 if ( this.$flagged
) {
4564 this.$flagged
.removeClass( classNames
);
4567 this.$flagged
= $flagged
.addClass( classNames
);
4571 * Check if a flag is set.
4573 * @param {string} flag Name of flag
4574 * @return {boolean} Has flag
4576 OO
.ui
.FlaggedElement
.prototype.hasFlag = function ( flag
) {
4577 return flag
in this.flags
;
4581 * Get the names of all flags set.
4583 * @return {string[]} Flag names
4585 OO
.ui
.FlaggedElement
.prototype.getFlags = function () {
4586 return Object
.keys( this.flags
);
4595 OO
.ui
.FlaggedElement
.prototype.clearFlags = function () {
4596 var flag
, className
,
4599 classPrefix
= 'oo-ui-flaggedElement-';
4601 for ( flag
in this.flags
) {
4602 className
= classPrefix
+ flag
;
4603 changes
[flag
] = false;
4604 delete this.flags
[flag
];
4605 remove
.push( className
);
4608 if ( this.$flagged
) {
4609 this.$flagged
.removeClass( remove
.join( ' ' ) );
4612 this.updateThemeClasses();
4613 this.emit( 'flag', changes
);
4619 * Add one or more flags.
4621 * @param {string|string[]|Object.<string, boolean>} flags One or more flags to add, or an object
4622 * keyed by flag name containing boolean set/remove instructions.
4626 OO
.ui
.FlaggedElement
.prototype.setFlags = function ( flags
) {
4627 var i
, len
, flag
, className
,
4631 classPrefix
= 'oo-ui-flaggedElement-';
4633 if ( typeof flags
=== 'string' ) {
4634 className
= classPrefix
+ flags
;
4636 if ( !this.flags
[flags
] ) {
4637 this.flags
[flags
] = true;
4638 add
.push( className
);
4640 } else if ( $.isArray( flags
) ) {
4641 for ( i
= 0, len
= flags
.length
; i
< len
; i
++ ) {
4643 className
= classPrefix
+ flag
;
4645 if ( !this.flags
[flag
] ) {
4646 changes
[flag
] = true;
4647 this.flags
[flag
] = true;
4648 add
.push( className
);
4651 } else if ( OO
.isPlainObject( flags
) ) {
4652 for ( flag
in flags
) {
4653 className
= classPrefix
+ flag
;
4654 if ( flags
[flag
] ) {
4656 if ( !this.flags
[flag
] ) {
4657 changes
[flag
] = true;
4658 this.flags
[flag
] = true;
4659 add
.push( className
);
4663 if ( this.flags
[flag
] ) {
4664 changes
[flag
] = false;
4665 delete this.flags
[flag
];
4666 remove
.push( className
);
4672 if ( this.$flagged
) {
4674 .addClass( add
.join( ' ' ) )
4675 .removeClass( remove
.join( ' ' ) );
4678 this.updateThemeClasses();
4679 this.emit( 'flag', changes
);
4685 * Element with a title.
4687 * Titles are rendered by the browser and are made visible when hovering the element. Titles are
4688 * not visible on touch devices.
4694 * @param {Object} [config] Configuration options
4695 * @cfg {jQuery} [$titled] Titled node, assigned to #$titled, omit to use #$element
4696 * @cfg {string|Function} [title] Title text or a function that returns text. If not provided, the
4697 * static property 'title' is used.
4699 OO
.ui
.TitledElement
= function OoUiTitledElement( config
) {
4700 // Configuration initialization
4701 config
= config
|| {};
4704 this.$titled
= null;
4708 this.setTitle( config
.title
|| this.constructor.static.title
);
4709 this.setTitledElement( config
.$titled
|| this.$element
);
4714 OO
.initClass( OO
.ui
.TitledElement
);
4716 /* Static Properties */
4723 * @property {string|Function} Title text or a function that returns text
4725 OO
.ui
.TitledElement
.static.title
= null;
4730 * Set the titled element.
4732 * If an element is already set, it will be cleaned up before setting up the new element.
4734 * @param {jQuery} $titled Element to set title on
4736 OO
.ui
.TitledElement
.prototype.setTitledElement = function ( $titled
) {
4737 if ( this.$titled
) {
4738 this.$titled
.removeAttr( 'title' );
4741 this.$titled
= $titled
;
4743 this.$titled
.attr( 'title', this.title
);
4750 * @param {string|Function|null} title Title text, a function that returns text or null for no title
4753 OO
.ui
.TitledElement
.prototype.setTitle = function ( title
) {
4754 title
= typeof title
=== 'string' ? OO
.ui
.resolveMsg( title
) : null;
4756 if ( this.title
!== title
) {
4757 if ( this.$titled
) {
4758 if ( title
!== null ) {
4759 this.$titled
.attr( 'title', title
);
4761 this.$titled
.removeAttr( 'title' );
4773 * @return {string} Title string
4775 OO
.ui
.TitledElement
.prototype.getTitle = function () {
4780 * Element that can be automatically clipped to visible boundaries.
4782 * Whenever the element's natural height changes, you have to call
4783 * #clip to make sure it's still clipping correctly.
4789 * @param {Object} [config] Configuration options
4790 * @cfg {jQuery} [$clippable] Nodes to clip, assigned to #$clippable, omit to use #$element
4792 OO
.ui
.ClippableElement
= function OoUiClippableElement( config
) {
4793 // Configuration initialization
4794 config
= config
|| {};
4797 this.$clippable
= null;
4798 this.clipping
= false;
4799 this.clippedHorizontally
= false;
4800 this.clippedVertically
= false;
4801 this.$clippableContainer
= null;
4802 this.$clippableScroller
= null;
4803 this.$clippableWindow
= null;
4804 this.idealWidth
= null;
4805 this.idealHeight
= null;
4806 this.onClippableContainerScrollHandler
= this.clip
.bind( this );
4807 this.onClippableWindowResizeHandler
= this.clip
.bind( this );
4810 this.setClippableElement( config
.$clippable
|| this.$element
);
4816 * Set clippable element.
4818 * If an element is already set, it will be cleaned up before setting up the new element.
4820 * @param {jQuery} $clippable Element to make clippable
4822 OO
.ui
.ClippableElement
.prototype.setClippableElement = function ( $clippable
) {
4823 if ( this.$clippable
) {
4824 this.$clippable
.removeClass( 'oo-ui-clippableElement-clippable' );
4825 this.$clippable
.css( { width
: '', height
: '' } );
4826 this.$clippable
.width(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4827 this.$clippable
.css( { overflowX
: '', overflowY
: '' } );
4830 this.$clippable
= $clippable
.addClass( 'oo-ui-clippableElement-clippable' );
4837 * Do not turn clipping on until after the element is attached to the DOM and visible.
4839 * @param {boolean} [clipping] Enable clipping, omit to toggle
4842 OO
.ui
.ClippableElement
.prototype.toggleClipping = function ( clipping
) {
4843 clipping
= clipping
=== undefined ? !this.clipping
: !!clipping
;
4845 if ( this.clipping
!== clipping
) {
4846 this.clipping
= clipping
;
4848 this.$clippableContainer
= this.$( this.getClosestScrollableElementContainer() );
4849 // If the clippable container is the body, we have to listen to scroll events and check
4850 // jQuery.scrollTop on the window because of browser inconsistencies
4851 this.$clippableScroller
= this.$clippableContainer
.is( 'body' ) ?
4852 this.$( OO
.ui
.Element
.getWindow( this.$clippableContainer
) ) :
4853 this.$clippableContainer
;
4854 this.$clippableScroller
.on( 'scroll', this.onClippableContainerScrollHandler
);
4855 this.$clippableWindow
= this.$( this.getElementWindow() )
4856 .on( 'resize', this.onClippableWindowResizeHandler
);
4857 // Initial clip after visible
4860 this.$clippable
.css( { width
: '', height
: '' } );
4861 this.$clippable
.width(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4862 this.$clippable
.css( { overflowX
: '', overflowY
: '' } );
4864 this.$clippableContainer
= null;
4865 this.$clippableScroller
.off( 'scroll', this.onClippableContainerScrollHandler
);
4866 this.$clippableScroller
= null;
4867 this.$clippableWindow
.off( 'resize', this.onClippableWindowResizeHandler
);
4868 this.$clippableWindow
= null;
4876 * Check if the element will be clipped to fit the visible area of the nearest scrollable container.
4878 * @return {boolean} Element will be clipped to the visible area
4880 OO
.ui
.ClippableElement
.prototype.isClipping = function () {
4881 return this.clipping
;
4885 * Check if the bottom or right of the element is being clipped by the nearest scrollable container.
4887 * @return {boolean} Part of the element is being clipped
4889 OO
.ui
.ClippableElement
.prototype.isClipped = function () {
4890 return this.clippedHorizontally
|| this.clippedVertically
;
4894 * Check if the right of the element is being clipped by the nearest scrollable container.
4896 * @return {boolean} Part of the element is being clipped
4898 OO
.ui
.ClippableElement
.prototype.isClippedHorizontally = function () {
4899 return this.clippedHorizontally
;
4903 * Check if the bottom of the element is being clipped by the nearest scrollable container.
4905 * @return {boolean} Part of the element is being clipped
4907 OO
.ui
.ClippableElement
.prototype.isClippedVertically = function () {
4908 return this.clippedVertically
;
4912 * Set the ideal size. These are the dimensions the element will have when it's not being clipped.
4914 * @param {number|string} [width] Width as a number of pixels or CSS string with unit suffix
4915 * @param {number|string} [height] Height as a number of pixels or CSS string with unit suffix
4917 OO
.ui
.ClippableElement
.prototype.setIdealSize = function ( width
, height
) {
4918 this.idealWidth
= width
;
4919 this.idealHeight
= height
;
4921 if ( !this.clipping
) {
4922 // Update dimensions
4923 this.$clippable
.css( { width
: width
, height
: height
} );
4925 // While clipping, idealWidth and idealHeight are not considered
4929 * Clip element to visible boundaries and allow scrolling when needed. Call this method when
4930 * the element's natural height changes.
4932 * Element will be clipped the bottom or right of the element is within 10px of the edge of, or
4933 * overlapped by, the visible area of the nearest scrollable container.
4937 OO
.ui
.ClippableElement
.prototype.clip = function () {
4938 if ( !this.clipping
) {
4939 // this.$clippableContainer and this.$clippableWindow are null, so the below will fail
4944 cOffset
= this.$clippable
.offset(),
4945 $container
= this.$clippableContainer
.is( 'body' ) ?
4946 this.$clippableWindow
: this.$clippableContainer
,
4947 ccOffset
= $container
.offset() || { top
: 0, left
: 0 },
4948 ccHeight
= $container
.innerHeight() - buffer
,
4949 ccWidth
= $container
.innerWidth() - buffer
,
4950 scrollTop
= this.$clippableScroller
.scrollTop(),
4951 scrollLeft
= this.$clippableScroller
.scrollLeft(),
4952 desiredWidth
= ( ccOffset
.left
+ scrollLeft
+ ccWidth
) - cOffset
.left
,
4953 desiredHeight
= ( ccOffset
.top
+ scrollTop
+ ccHeight
) - cOffset
.top
,
4954 naturalWidth
= this.$clippable
.prop( 'scrollWidth' ),
4955 naturalHeight
= this.$clippable
.prop( 'scrollHeight' ),
4956 clipWidth
= desiredWidth
< naturalWidth
,
4957 clipHeight
= desiredHeight
< naturalHeight
;
4960 this.$clippable
.css( { overflowX
: 'scroll', width
: desiredWidth
} );
4962 this.$clippable
.css( 'width', this.idealWidth
|| '' );
4963 this.$clippable
.width(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4964 this.$clippable
.css( 'overflowX', '' );
4967 this.$clippable
.css( { overflowY
: 'scroll', height
: desiredHeight
} );
4969 this.$clippable
.css( 'height', this.idealHeight
|| '' );
4970 this.$clippable
.height(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4971 this.$clippable
.css( 'overflowY', '' );
4974 this.clippedHorizontally
= clipWidth
;
4975 this.clippedVertically
= clipHeight
;
4981 * Generic toolbar tool.
4985 * @extends OO.ui.Widget
4986 * @mixins OO.ui.IconElement
4987 * @mixins OO.ui.FlaggedElement
4990 * @param {OO.ui.ToolGroup} toolGroup
4991 * @param {Object} [config] Configuration options
4992 * @cfg {string|Function} [title] Title text or a function that returns text
4994 OO
.ui
.Tool
= function OoUiTool( toolGroup
, config
) {
4995 // Configuration initialization
4996 config
= config
|| {};
4998 // Parent constructor
4999 OO
.ui
.Tool
.super.call( this, config
);
5001 // Mixin constructors
5002 OO
.ui
.IconElement
.call( this, config
);
5003 OO
.ui
.FlaggedElement
.call( this, config
);
5006 this.toolGroup
= toolGroup
;
5007 this.toolbar
= this.toolGroup
.getToolbar();
5008 this.active
= false;
5009 this.$title
= this.$( '<span>' );
5010 this.$titleText
= this.$( '<span>' );
5011 this.$accel
= this.$( '<span>' );
5012 this.$link
= this.$( '<a>' );
5016 this.toolbar
.connect( this, { updateState
: 'onUpdateState' } );
5019 this.$titleText
.addClass( 'oo-ui-tool-title-text' );
5021 .addClass( 'oo-ui-tool-accel' )
5023 // This may need to be changed if the key names are ever localized,
5024 // but for now they are essentially written in English
5029 .addClass( 'oo-ui-tool-title' )
5030 .append( this.$titleText
, this.$accel
);
5032 .addClass( 'oo-ui-tool-link' )
5033 .append( this.$icon
, this.$title
)
5034 .prop( 'tabIndex', 0 )
5035 .attr( 'role', 'button' );
5037 .data( 'oo-ui-tool', this )
5039 'oo-ui-tool ' + 'oo-ui-tool-name-' +
5040 this.constructor.static.name
.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' )
5042 .append( this.$link
);
5043 this.setTitle( config
.title
|| this.constructor.static.title
);
5048 OO
.inheritClass( OO
.ui
.Tool
, OO
.ui
.Widget
);
5049 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.IconElement
);
5050 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.FlaggedElement
);
5058 /* Static Properties */
5064 OO
.ui
.Tool
.static.tagName
= 'span';
5067 * Symbolic name of tool.
5072 * @property {string}
5074 OO
.ui
.Tool
.static.name
= '';
5082 * @property {string}
5084 OO
.ui
.Tool
.static.group
= '';
5089 * Title is used as a tooltip when the tool is part of a bar tool group, or a label when the tool
5090 * is part of a list or menu tool group. If a trigger is associated with an action by the same name
5091 * as the tool, a description of its keyboard shortcut for the appropriate platform will be
5092 * appended to the title if the tool is part of a bar tool group.
5097 * @property {string|Function} Title text or a function that returns text
5099 OO
.ui
.Tool
.static.title
= '';
5102 * Tool can be automatically added to catch-all groups.
5106 * @property {boolean}
5108 OO
.ui
.Tool
.static.autoAddToCatchall
= true;
5111 * Tool can be automatically added to named groups.
5114 * @property {boolean}
5117 OO
.ui
.Tool
.static.autoAddToGroup
= true;
5120 * Check if this tool is compatible with given data.
5124 * @param {Mixed} data Data to check
5125 * @return {boolean} Tool can be used with data
5127 OO
.ui
.Tool
.static.isCompatibleWith = function () {
5134 * Handle the toolbar state being updated.
5136 * This is an abstract method that must be overridden in a concrete subclass.
5140 OO
.ui
.Tool
.prototype.onUpdateState = function () {
5142 'OO.ui.Tool.onUpdateState not implemented in this subclass:' + this.constructor
5147 * Handle the tool being selected.
5149 * This is an abstract method that must be overridden in a concrete subclass.
5153 OO
.ui
.Tool
.prototype.onSelect = function () {
5155 'OO.ui.Tool.onSelect not implemented in this subclass:' + this.constructor
5160 * Check if the button is active.
5162 * @return {boolean} Button is active
5164 OO
.ui
.Tool
.prototype.isActive = function () {
5169 * Make the button appear active or inactive.
5171 * @param {boolean} state Make button appear active
5173 OO
.ui
.Tool
.prototype.setActive = function ( state
) {
5174 this.active
= !!state
;
5175 if ( this.active
) {
5176 this.$element
.addClass( 'oo-ui-tool-active' );
5178 this.$element
.removeClass( 'oo-ui-tool-active' );
5183 * Get the tool title.
5185 * @param {string|Function} title Title text or a function that returns text
5188 OO
.ui
.Tool
.prototype.setTitle = function ( title
) {
5189 this.title
= OO
.ui
.resolveMsg( title
);
5195 * Get the tool title.
5197 * @return {string} Title text
5199 OO
.ui
.Tool
.prototype.getTitle = function () {
5204 * Get the tool's symbolic name.
5206 * @return {string} Symbolic name of tool
5208 OO
.ui
.Tool
.prototype.getName = function () {
5209 return this.constructor.static.name
;
5215 OO
.ui
.Tool
.prototype.updateTitle = function () {
5216 var titleTooltips
= this.toolGroup
.constructor.static.titleTooltips
,
5217 accelTooltips
= this.toolGroup
.constructor.static.accelTooltips
,
5218 accel
= this.toolbar
.getToolAccelerator( this.constructor.static.name
),
5221 this.$titleText
.text( this.title
);
5222 this.$accel
.text( accel
);
5224 if ( titleTooltips
&& typeof this.title
=== 'string' && this.title
.length
) {
5225 tooltipParts
.push( this.title
);
5227 if ( accelTooltips
&& typeof accel
=== 'string' && accel
.length
) {
5228 tooltipParts
.push( accel
);
5230 if ( tooltipParts
.length
) {
5231 this.$link
.attr( 'title', tooltipParts
.join( ' ' ) );
5233 this.$link
.removeAttr( 'title' );
5240 OO
.ui
.Tool
.prototype.destroy = function () {
5241 this.toolbar
.disconnect( this );
5242 this.$element
.remove();
5246 * Collection of tool groups.
5249 * @extends OO.ui.Element
5250 * @mixins OO.EventEmitter
5251 * @mixins OO.ui.GroupElement
5254 * @param {OO.ui.ToolFactory} toolFactory Factory for creating tools
5255 * @param {OO.ui.ToolGroupFactory} toolGroupFactory Factory for creating tool groups
5256 * @param {Object} [config] Configuration options
5257 * @cfg {boolean} [actions] Add an actions section opposite to the tools
5258 * @cfg {boolean} [shadow] Add a shadow below the toolbar
5260 OO
.ui
.Toolbar
= function OoUiToolbar( toolFactory
, toolGroupFactory
, config
) {
5261 // Configuration initialization
5262 config
= config
|| {};
5264 // Parent constructor
5265 OO
.ui
.Toolbar
.super.call( this, config
);
5267 // Mixin constructors
5268 OO
.EventEmitter
.call( this );
5269 OO
.ui
.GroupElement
.call( this, config
);
5272 this.toolFactory
= toolFactory
;
5273 this.toolGroupFactory
= toolGroupFactory
;
5276 this.$bar
= this.$( '<div>' );
5277 this.$actions
= this.$( '<div>' );
5278 this.initialized
= false;
5282 .add( this.$bar
).add( this.$group
).add( this.$actions
)
5283 .on( 'mousedown touchstart', this.onPointerDown
.bind( this ) );
5286 this.$group
.addClass( 'oo-ui-toolbar-tools' );
5287 if ( config
.actions
) {
5288 this.$bar
.append( this.$actions
.addClass( 'oo-ui-toolbar-actions' ) );
5290 this.$bar
.append( this.$group
, '<div style="clear:both"></div>' );
5291 if ( config
.shadow
) {
5292 this.$bar
.append( '<div class="oo-ui-toolbar-shadow"></div>' );
5294 this.$element
.addClass( 'oo-ui-toolbar' ).append( this.$bar
);
5299 OO
.inheritClass( OO
.ui
.Toolbar
, OO
.ui
.Element
);
5300 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.EventEmitter
);
5301 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.ui
.GroupElement
);
5306 * Get the tool factory.
5308 * @return {OO.ui.ToolFactory} Tool factory
5310 OO
.ui
.Toolbar
.prototype.getToolFactory = function () {
5311 return this.toolFactory
;
5315 * Get the tool group factory.
5317 * @return {OO.Factory} Tool group factory
5319 OO
.ui
.Toolbar
.prototype.getToolGroupFactory = function () {
5320 return this.toolGroupFactory
;
5324 * Handles mouse down events.
5326 * @param {jQuery.Event} e Mouse down event
5328 OO
.ui
.Toolbar
.prototype.onPointerDown = function ( e
) {
5329 var $closestWidgetToEvent
= this.$( e
.target
).closest( '.oo-ui-widget' ),
5330 $closestWidgetToToolbar
= this.$element
.closest( '.oo-ui-widget' );
5331 if ( !$closestWidgetToEvent
.length
|| $closestWidgetToEvent
[0] === $closestWidgetToToolbar
[0] ) {
5337 * Sets up handles and preloads required information for the toolbar to work.
5338 * This must be called immediately after it is attached to a visible document.
5340 OO
.ui
.Toolbar
.prototype.initialize = function () {
5341 this.initialized
= true;
5347 * Tools can be specified in the following ways:
5349 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
5350 * - All tools in a group: `{ group: 'group-name' }`
5351 * - All tools: `'*'` - Using this will make the group a list with a "More" label by default
5353 * @param {Object.<string,Array>} groups List of tool group configurations
5354 * @param {Array|string} [groups.include] Tools to include
5355 * @param {Array|string} [groups.exclude] Tools to exclude
5356 * @param {Array|string} [groups.promote] Tools to promote to the beginning
5357 * @param {Array|string} [groups.demote] Tools to demote to the end
5359 OO
.ui
.Toolbar
.prototype.setup = function ( groups
) {
5360 var i
, len
, type
, group
,
5362 defaultType
= 'bar';
5364 // Cleanup previous groups
5367 // Build out new groups
5368 for ( i
= 0, len
= groups
.length
; i
< len
; i
++ ) {
5370 if ( group
.include
=== '*' ) {
5371 // Apply defaults to catch-all groups
5372 if ( group
.type
=== undefined ) {
5373 group
.type
= 'list';
5375 if ( group
.label
=== undefined ) {
5376 group
.label
= OO
.ui
.msg( 'ooui-toolbar-more' );
5379 // Check type has been registered
5380 type
= this.getToolGroupFactory().lookup( group
.type
) ? group
.type
: defaultType
;
5382 this.getToolGroupFactory().create( type
, this, $.extend( { $: this.$ }, group
) )
5385 this.addItems( items
);
5389 * Remove all tools and groups from the toolbar.
5391 OO
.ui
.Toolbar
.prototype.reset = function () {
5396 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
5397 this.items
[i
].destroy();
5403 * Destroys toolbar, removing event handlers and DOM elements.
5405 * Call this whenever you are done using a toolbar.
5407 OO
.ui
.Toolbar
.prototype.destroy = function () {
5409 this.$element
.remove();
5413 * Check if tool has not been used yet.
5415 * @param {string} name Symbolic name of tool
5416 * @return {boolean} Tool is available
5418 OO
.ui
.Toolbar
.prototype.isToolAvailable = function ( name
) {
5419 return !this.tools
[name
];
5423 * Prevent tool from being used again.
5425 * @param {OO.ui.Tool} tool Tool to reserve
5427 OO
.ui
.Toolbar
.prototype.reserveTool = function ( tool
) {
5428 this.tools
[tool
.getName()] = tool
;
5432 * Allow tool to be used again.
5434 * @param {OO.ui.Tool} tool Tool to release
5436 OO
.ui
.Toolbar
.prototype.releaseTool = function ( tool
) {
5437 delete this.tools
[tool
.getName()];
5441 * Get accelerator label for tool.
5443 * This is a stub that should be overridden to provide access to accelerator information.
5445 * @param {string} name Symbolic name of tool
5446 * @return {string|undefined} Tool accelerator label if available
5448 OO
.ui
.Toolbar
.prototype.getToolAccelerator = function () {
5453 * Collection of tools.
5455 * Tools can be specified in the following ways:
5457 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
5458 * - All tools in a group: `{ group: 'group-name' }`
5459 * - All tools: `'*'`
5463 * @extends OO.ui.Widget
5464 * @mixins OO.ui.GroupElement
5467 * @param {OO.ui.Toolbar} toolbar
5468 * @param {Object} [config] Configuration options
5469 * @cfg {Array|string} [include=[]] List of tools to include
5470 * @cfg {Array|string} [exclude=[]] List of tools to exclude
5471 * @cfg {Array|string} [promote=[]] List of tools to promote to the beginning
5472 * @cfg {Array|string} [demote=[]] List of tools to demote to the end
5474 OO
.ui
.ToolGroup
= function OoUiToolGroup( toolbar
, config
) {
5475 // Configuration initialization
5476 config
= config
|| {};
5478 // Parent constructor
5479 OO
.ui
.ToolGroup
.super.call( this, config
);
5481 // Mixin constructors
5482 OO
.ui
.GroupElement
.call( this, config
);
5485 this.toolbar
= toolbar
;
5487 this.pressed
= null;
5488 this.autoDisabled
= false;
5489 this.include
= config
.include
|| [];
5490 this.exclude
= config
.exclude
|| [];
5491 this.promote
= config
.promote
|| [];
5492 this.demote
= config
.demote
|| [];
5493 this.onCapturedMouseUpHandler
= this.onCapturedMouseUp
.bind( this );
5497 'mousedown touchstart': this.onPointerDown
.bind( this ),
5498 'mouseup touchend': this.onPointerUp
.bind( this ),
5499 mouseover
: this.onMouseOver
.bind( this ),
5500 mouseout
: this.onMouseOut
.bind( this )
5502 this.toolbar
.getToolFactory().connect( this, { register
: 'onToolFactoryRegister' } );
5503 this.aggregate( { disable
: 'itemDisable' } );
5504 this.connect( this, { itemDisable
: 'updateDisabled' } );
5507 this.$group
.addClass( 'oo-ui-toolGroup-tools' );
5509 .addClass( 'oo-ui-toolGroup' )
5510 .append( this.$group
);
5516 OO
.inheritClass( OO
.ui
.ToolGroup
, OO
.ui
.Widget
);
5517 OO
.mixinClass( OO
.ui
.ToolGroup
, OO
.ui
.GroupElement
);
5525 /* Static Properties */
5528 * Show labels in tooltips.
5532 * @property {boolean}
5534 OO
.ui
.ToolGroup
.static.titleTooltips
= false;
5537 * Show acceleration labels in tooltips.
5541 * @property {boolean}
5543 OO
.ui
.ToolGroup
.static.accelTooltips
= false;
5546 * Automatically disable the toolgroup when all tools are disabled
5550 * @property {boolean}
5552 OO
.ui
.ToolGroup
.static.autoDisable
= true;
5559 OO
.ui
.ToolGroup
.prototype.isDisabled = function () {
5560 return this.autoDisabled
|| OO
.ui
.ToolGroup
.super.prototype.isDisabled
.apply( this, arguments
);
5566 OO
.ui
.ToolGroup
.prototype.updateDisabled = function () {
5567 var i
, item
, allDisabled
= true;
5569 if ( this.constructor.static.autoDisable
) {
5570 for ( i
= this.items
.length
- 1; i
>= 0; i
-- ) {
5571 item
= this.items
[i
];
5572 if ( !item
.isDisabled() ) {
5573 allDisabled
= false;
5577 this.autoDisabled
= allDisabled
;
5579 OO
.ui
.ToolGroup
.super.prototype.updateDisabled
.apply( this, arguments
);
5583 * Handle mouse down events.
5585 * @param {jQuery.Event} e Mouse down event
5587 OO
.ui
.ToolGroup
.prototype.onPointerDown = function ( e
) {
5588 // e.which is 0 for touch events, 1 for left mouse button
5589 if ( !this.isDisabled() && e
.which
<= 1 ) {
5590 this.pressed
= this.getTargetTool( e
);
5591 if ( this.pressed
) {
5592 this.pressed
.setActive( true );
5593 this.getElementDocument().addEventListener(
5594 'mouseup', this.onCapturedMouseUpHandler
, true
5602 * Handle captured mouse up events.
5604 * @param {Event} e Mouse up event
5606 OO
.ui
.ToolGroup
.prototype.onCapturedMouseUp = function ( e
) {
5607 this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseUpHandler
, true );
5608 // onPointerUp may be called a second time, depending on where the mouse is when the button is
5609 // released, but since `this.pressed` will no longer be true, the second call will be ignored.
5610 this.onPointerUp( e
);
5614 * Handle mouse up events.
5616 * @param {jQuery.Event} e Mouse up event
5618 OO
.ui
.ToolGroup
.prototype.onPointerUp = function ( e
) {
5619 var tool
= this.getTargetTool( e
);
5621 // e.which is 0 for touch events, 1 for left mouse button
5622 if ( !this.isDisabled() && e
.which
<= 1 && this.pressed
&& this.pressed
=== tool
) {
5623 this.pressed
.onSelect();
5626 this.pressed
= null;
5631 * Handle mouse over events.
5633 * @param {jQuery.Event} e Mouse over event
5635 OO
.ui
.ToolGroup
.prototype.onMouseOver = function ( e
) {
5636 var tool
= this.getTargetTool( e
);
5638 if ( this.pressed
&& this.pressed
=== tool
) {
5639 this.pressed
.setActive( true );
5644 * Handle mouse out events.
5646 * @param {jQuery.Event} e Mouse out event
5648 OO
.ui
.ToolGroup
.prototype.onMouseOut = function ( e
) {
5649 var tool
= this.getTargetTool( e
);
5651 if ( this.pressed
&& this.pressed
=== tool
) {
5652 this.pressed
.setActive( false );
5657 * Get the closest tool to a jQuery.Event.
5659 * Only tool links are considered, which prevents other elements in the tool such as popups from
5660 * triggering tool group interactions.
5663 * @param {jQuery.Event} e
5664 * @return {OO.ui.Tool|null} Tool, `null` if none was found
5666 OO
.ui
.ToolGroup
.prototype.getTargetTool = function ( e
) {
5668 $item
= this.$( e
.target
).closest( '.oo-ui-tool-link' );
5670 if ( $item
.length
) {
5671 tool
= $item
.parent().data( 'oo-ui-tool' );
5674 return tool
&& !tool
.isDisabled() ? tool
: null;
5678 * Handle tool registry register events.
5680 * If a tool is registered after the group is created, we must repopulate the list to account for:
5682 * - a tool being added that may be included
5683 * - a tool already included being overridden
5685 * @param {string} name Symbolic name of tool
5687 OO
.ui
.ToolGroup
.prototype.onToolFactoryRegister = function () {
5692 * Get the toolbar this group is in.
5694 * @return {OO.ui.Toolbar} Toolbar of group
5696 OO
.ui
.ToolGroup
.prototype.getToolbar = function () {
5697 return this.toolbar
;
5701 * Add and remove tools based on configuration.
5703 OO
.ui
.ToolGroup
.prototype.populate = function () {
5704 var i
, len
, name
, tool
,
5705 toolFactory
= this.toolbar
.getToolFactory(),
5709 list
= this.toolbar
.getToolFactory().getTools(
5710 this.include
, this.exclude
, this.promote
, this.demote
5713 // Build a list of needed tools
5714 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
5718 toolFactory
.lookup( name
) &&
5719 // Tool is available or is already in this group
5720 ( this.toolbar
.isToolAvailable( name
) || this.tools
[name
] )
5722 tool
= this.tools
[name
];
5724 // Auto-initialize tools on first use
5725 this.tools
[name
] = tool
= toolFactory
.create( name
, this );
5728 this.toolbar
.reserveTool( tool
);
5733 // Remove tools that are no longer needed
5734 for ( name
in this.tools
) {
5735 if ( !names
[name
] ) {
5736 this.tools
[name
].destroy();
5737 this.toolbar
.releaseTool( this.tools
[name
] );
5738 remove
.push( this.tools
[name
] );
5739 delete this.tools
[name
];
5742 if ( remove
.length
) {
5743 this.removeItems( remove
);
5745 // Update emptiness state
5747 this.$element
.removeClass( 'oo-ui-toolGroup-empty' );
5749 this.$element
.addClass( 'oo-ui-toolGroup-empty' );
5751 // Re-add tools (moving existing ones to new locations)
5752 this.addItems( add
);
5753 // Disabled state may depend on items
5754 this.updateDisabled();
5758 * Destroy tool group.
5760 OO
.ui
.ToolGroup
.prototype.destroy = function () {
5764 this.toolbar
.getToolFactory().disconnect( this );
5765 for ( name
in this.tools
) {
5766 this.toolbar
.releaseTool( this.tools
[name
] );
5767 this.tools
[name
].disconnect( this ).destroy();
5768 delete this.tools
[name
];
5770 this.$element
.remove();
5774 * Dialog for showing a message.
5777 * - Registers two actions by default (safe and primary).
5778 * - Renders action widgets in the footer.
5781 * @extends OO.ui.Dialog
5784 * @param {Object} [config] Configuration options
5786 OO
.ui
.MessageDialog
= function OoUiMessageDialog( config
) {
5787 // Parent constructor
5788 OO
.ui
.MessageDialog
.super.call( this, config
);
5791 this.verticalActionLayout
= null;
5794 this.$element
.addClass( 'oo-ui-messageDialog' );
5799 OO
.inheritClass( OO
.ui
.MessageDialog
, OO
.ui
.Dialog
);
5801 /* Static Properties */
5803 OO
.ui
.MessageDialog
.static.name
= 'message';
5805 OO
.ui
.MessageDialog
.static.size
= 'small';
5807 OO
.ui
.MessageDialog
.static.verbose
= false;
5812 * A confirmation dialog's title should describe what the progressive action will do. An alert
5813 * dialog's title should describe what event occured.
5817 * @property {jQuery|string|Function|null}
5819 OO
.ui
.MessageDialog
.static.title
= null;
5822 * A confirmation dialog's message should describe the consequences of the progressive action. An
5823 * alert dialog's message should describe why the event occured.
5827 * @property {jQuery|string|Function|null}
5829 OO
.ui
.MessageDialog
.static.message
= null;
5831 OO
.ui
.MessageDialog
.static.actions
= [
5832 { action
: 'accept', label
: OO
.ui
.deferMsg( 'ooui-dialog-message-accept' ), flags
: 'primary' },
5833 { action
: 'reject', label
: OO
.ui
.deferMsg( 'ooui-dialog-message-reject' ), flags
: 'safe' }
5841 OO
.ui
.MessageDialog
.prototype.onActionResize = function ( action
) {
5843 return OO
.ui
.ProcessDialog
.super.prototype.onActionResize
.call( this, action
);
5847 * Toggle action layout between vertical and horizontal.
5849 * @param {boolean} [value] Layout actions vertically, omit to toggle
5852 OO
.ui
.MessageDialog
.prototype.toggleVerticalActionLayout = function ( value
) {
5853 value
= value
=== undefined ? !this.verticalActionLayout
: !!value
;
5855 if ( value
!== this.verticalActionLayout
) {
5856 this.verticalActionLayout
= value
;
5858 .toggleClass( 'oo-ui-messageDialog-actions-vertical', value
)
5859 .toggleClass( 'oo-ui-messageDialog-actions-horizontal', !value
);
5868 OO
.ui
.MessageDialog
.prototype.getActionProcess = function ( action
) {
5870 return new OO
.ui
.Process( function () {
5871 this.close( { action
: action
} );
5874 return OO
.ui
.MessageDialog
.super.prototype.getActionProcess
.call( this, action
);
5880 * @param {Object} [data] Dialog opening data
5881 * @param {jQuery|string|Function|null} [data.title] Description of the action being confirmed
5882 * @param {jQuery|string|Function|null} [data.message] Description of the action's consequence
5883 * @param {boolean} [data.verbose] Message is verbose and should be styled as a long message
5884 * @param {Object[]} [data.actions] List of OO.ui.ActionOptionWidget configuration options for each
5887 OO
.ui
.MessageDialog
.prototype.getSetupProcess = function ( data
) {
5891 return OO
.ui
.MessageDialog
.super.prototype.getSetupProcess
.call( this, data
)
5892 .next( function () {
5893 this.title
.setLabel(
5894 data
.title
!== undefined ? data
.title
: this.constructor.static.title
5896 this.message
.setLabel(
5897 data
.message
!== undefined ? data
.message
: this.constructor.static.message
5899 this.message
.$element
.toggleClass(
5900 'oo-ui-messageDialog-message-verbose',
5901 data
.verbose
!== undefined ? data
.verbose
: this.constructor.static.verbose
5909 OO
.ui
.MessageDialog
.prototype.getBodyHeight = function () {
5910 return Math
.round( this.text
.$element
.outerHeight( true ) );
5916 OO
.ui
.MessageDialog
.prototype.initialize = function () {
5918 OO
.ui
.MessageDialog
.super.prototype.initialize
.call( this );
5921 this.$actions
= this.$( '<div>' );
5922 this.container
= new OO
.ui
.PanelLayout( {
5923 $: this.$, scrollable
: true, classes
: [ 'oo-ui-messageDialog-container' ]
5925 this.text
= new OO
.ui
.PanelLayout( {
5926 $: this.$, padded
: true, expanded
: false, classes
: [ 'oo-ui-messageDialog-text' ]
5928 this.message
= new OO
.ui
.LabelWidget( {
5929 $: this.$, classes
: [ 'oo-ui-messageDialog-message' ]
5933 this.title
.$element
.addClass( 'oo-ui-messageDialog-title' );
5934 this.$content
.addClass( 'oo-ui-messageDialog-content' );
5935 this.container
.$element
.append( this.text
.$element
);
5936 this.text
.$element
.append( this.title
.$element
, this.message
.$element
);
5937 this.$body
.append( this.container
.$element
);
5938 this.$actions
.addClass( 'oo-ui-messageDialog-actions' );
5939 this.$foot
.append( this.$actions
);
5945 OO
.ui
.MessageDialog
.prototype.attachActions = function () {
5946 var i
, len
, other
, special
, others
;
5949 OO
.ui
.MessageDialog
.super.prototype.attachActions
.call( this );
5951 special
= this.actions
.getSpecial();
5952 others
= this.actions
.getOthers();
5953 if ( special
.safe
) {
5954 this.$actions
.append( special
.safe
.$element
);
5955 special
.safe
.toggleFramed( false );
5957 if ( others
.length
) {
5958 for ( i
= 0, len
= others
.length
; i
< len
; i
++ ) {
5960 this.$actions
.append( other
.$element
);
5961 other
.toggleFramed( false );
5964 if ( special
.primary
) {
5965 this.$actions
.append( special
.primary
.$element
);
5966 special
.primary
.toggleFramed( false );
5970 if ( !this.isOpening() ) {
5971 this.manager
.updateWindowSize( this );
5973 this.$body
.css( 'bottom', this.$foot
.outerHeight( true ) );
5977 * Fit action actions into columns or rows.
5979 * Columns will be used if all labels can fit without overflow, otherwise rows will be used.
5981 OO
.ui
.MessageDialog
.prototype.fitActions = function () {
5983 actions
= this.actions
.get();
5986 this.toggleVerticalActionLayout( false );
5987 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
5988 action
= actions
[i
];
5989 if ( action
.$element
.innerWidth() < action
.$label
.outerWidth( true ) ) {
5990 this.toggleVerticalActionLayout( true );
5997 * Navigation dialog window.
6000 * - Show and hide errors.
6001 * - Retry an action.
6004 * - Renders header with dialog title and one action widget on either side
6005 * (a 'safe' button on the left, and a 'primary' button on the right, both of
6006 * which close the dialog).
6007 * - Displays any action widgets in the footer (none by default).
6008 * - Ability to dismiss errors.
6010 * Subclass responsibilities:
6011 * - Register a 'safe' action.
6012 * - Register a 'primary' action.
6013 * - Add content to the dialog.
6017 * @extends OO.ui.Dialog
6020 * @param {Object} [config] Configuration options
6022 OO
.ui
.ProcessDialog
= function OoUiProcessDialog( config
) {
6023 // Parent constructor
6024 OO
.ui
.ProcessDialog
.super.call( this, config
);
6027 this.$element
.addClass( 'oo-ui-processDialog' );
6032 OO
.inheritClass( OO
.ui
.ProcessDialog
, OO
.ui
.Dialog
);
6037 * Handle dismiss button click events.
6041 OO
.ui
.ProcessDialog
.prototype.onDismissErrorButtonClick = function () {
6046 * Handle retry button click events.
6048 * Hides errors and then tries again.
6050 OO
.ui
.ProcessDialog
.prototype.onRetryButtonClick = function () {
6052 this.executeAction( this.currentAction
.getAction() );
6058 OO
.ui
.ProcessDialog
.prototype.onActionResize = function ( action
) {
6059 if ( this.actions
.isSpecial( action
) ) {
6062 return OO
.ui
.ProcessDialog
.super.prototype.onActionResize
.call( this, action
);
6068 OO
.ui
.ProcessDialog
.prototype.initialize = function () {
6070 OO
.ui
.ProcessDialog
.super.prototype.initialize
.call( this );
6073 this.$navigation
= this.$( '<div>' );
6074 this.$location
= this.$( '<div>' );
6075 this.$safeActions
= this.$( '<div>' );
6076 this.$primaryActions
= this.$( '<div>' );
6077 this.$otherActions
= this.$( '<div>' );
6078 this.dismissButton
= new OO
.ui
.ButtonWidget( {
6080 label
: OO
.ui
.msg( 'ooui-dialog-process-dismiss' )
6082 this.retryButton
= new OO
.ui
.ButtonWidget( { $: this.$ } );
6083 this.$errors
= this.$( '<div>' );
6084 this.$errorsTitle
= this.$( '<div>' );
6087 this.dismissButton
.connect( this, { click
: 'onDismissErrorButtonClick' } );
6088 this.retryButton
.connect( this, { click
: 'onRetryButtonClick' } );
6091 this.title
.$element
.addClass( 'oo-ui-processDialog-title' );
6093 .append( this.title
.$element
)
6094 .addClass( 'oo-ui-processDialog-location' );
6095 this.$safeActions
.addClass( 'oo-ui-processDialog-actions-safe' );
6096 this.$primaryActions
.addClass( 'oo-ui-processDialog-actions-primary' );
6097 this.$otherActions
.addClass( 'oo-ui-processDialog-actions-other' );
6099 .addClass( 'oo-ui-processDialog-errors-title' )
6100 .text( OO
.ui
.msg( 'ooui-dialog-process-error' ) );
6102 .addClass( 'oo-ui-processDialog-errors' )
6103 .append( this.$errorsTitle
, this.dismissButton
.$element
, this.retryButton
.$element
);
6105 .addClass( 'oo-ui-processDialog-content' )
6106 .append( this.$errors
);
6108 .addClass( 'oo-ui-processDialog-navigation' )
6109 .append( this.$safeActions
, this.$location
, this.$primaryActions
);
6110 this.$head
.append( this.$navigation
);
6111 this.$foot
.append( this.$otherActions
);
6117 OO
.ui
.ProcessDialog
.prototype.attachActions = function () {
6118 var i
, len
, other
, special
, others
;
6121 OO
.ui
.ProcessDialog
.super.prototype.attachActions
.call( this );
6123 special
= this.actions
.getSpecial();
6124 others
= this.actions
.getOthers();
6125 if ( special
.primary
) {
6126 this.$primaryActions
.append( special
.primary
.$element
);
6127 special
.primary
.toggleFramed( true );
6129 if ( others
.length
) {
6130 for ( i
= 0, len
= others
.length
; i
< len
; i
++ ) {
6132 this.$otherActions
.append( other
.$element
);
6133 other
.toggleFramed( true );
6136 if ( special
.safe
) {
6137 this.$safeActions
.append( special
.safe
.$element
);
6138 special
.safe
.toggleFramed( true );
6142 this.$body
.css( 'bottom', this.$foot
.outerHeight( true ) );
6148 OO
.ui
.ProcessDialog
.prototype.executeAction = function ( action
) {
6149 OO
.ui
.ProcessDialog
.super.prototype.executeAction
.call( this, action
)
6150 .fail( this.showErrors
.bind( this ) );
6154 * Fit label between actions.
6158 OO
.ui
.ProcessDialog
.prototype.fitLabel = function () {
6159 var width
= Math
.max(
6160 this.$safeActions
.is( ':visible' ) ? this.$safeActions
.width() : 0,
6161 this.$primaryActions
.is( ':visible' ) ? this.$primaryActions
.width() : 0
6163 this.$location
.css( { paddingLeft
: width
, paddingRight
: width
} );
6169 * Handle errors that occured durring accept or reject processes.
6171 * @param {OO.ui.Error[]} errors Errors to be handled
6173 OO
.ui
.ProcessDialog
.prototype.showErrors = function ( errors
) {
6179 for ( i
= 0, len
= errors
.length
; i
< len
; i
++ ) {
6180 if ( !errors
[i
].isRecoverable() ) {
6181 recoverable
= false;
6183 if ( errors
[i
].isWarning() ) {
6186 $item
= this.$( '<div>' )
6187 .addClass( 'oo-ui-processDialog-error' )
6188 .append( errors
[i
].getMessage() );
6189 items
.push( $item
[0] );
6191 this.$errorItems
= this.$( items
);
6192 if ( recoverable
) {
6193 this.retryButton
.clearFlags().setFlags( this.currentAction
.getFlags() );
6195 this.currentAction
.setDisabled( true );
6198 this.retryButton
.setLabel( OO
.ui
.msg( 'ooui-dialog-process-continue' ) );
6200 this.retryButton
.setLabel( OO
.ui
.msg( 'ooui-dialog-process-retry' ) );
6202 this.retryButton
.toggle( recoverable
);
6203 this.$errorsTitle
.after( this.$errorItems
);
6204 this.$errors
.show().scrollTop( 0 );
6210 OO
.ui
.ProcessDialog
.prototype.hideErrors = function () {
6211 this.$errors
.hide();
6212 this.$errorItems
.remove();
6213 this.$errorItems
= null;
6217 * Layout containing a series of pages.
6220 * @extends OO.ui.Layout
6223 * @param {Object} [config] Configuration options
6224 * @cfg {boolean} [continuous=false] Show all pages, one after another
6225 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when changing to a page
6226 * @cfg {boolean} [outlined=false] Show an outline
6227 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
6229 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
6230 // Configuration initialization
6231 config
= config
|| {};
6233 // Parent constructor
6234 OO
.ui
.BookletLayout
.super.call( this, config
);
6237 this.currentPageName
= null;
6239 this.ignoreFocus
= false;
6240 this.stackLayout
= new OO
.ui
.StackLayout( { $: this.$, continuous
: !!config
.continuous
} );
6241 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
6242 this.outlineVisible
= false;
6243 this.outlined
= !!config
.outlined
;
6244 if ( this.outlined
) {
6245 this.editable
= !!config
.editable
;
6246 this.outlineControlsWidget
= null;
6247 this.outlineWidget
= new OO
.ui
.OutlineWidget( { $: this.$ } );
6248 this.outlinePanel
= new OO
.ui
.PanelLayout( { $: this.$, scrollable
: true } );
6249 this.gridLayout
= new OO
.ui
.GridLayout(
6250 [ this.outlinePanel
, this.stackLayout
],
6251 { $: this.$, widths
: [ 1, 2 ] }
6253 this.outlineVisible
= true;
6254 if ( this.editable
) {
6255 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
6256 this.outlineWidget
, { $: this.$ }
6262 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
6263 if ( this.outlined
) {
6264 this.outlineWidget
.connect( this, { select
: 'onOutlineWidgetSelect' } );
6266 if ( this.autoFocus
) {
6267 // Event 'focus' does not bubble, but 'focusin' does
6268 this.stackLayout
.onDOMEvent( 'focusin', this.onStackLayoutFocus
.bind( this ) );
6272 this.$element
.addClass( 'oo-ui-bookletLayout' );
6273 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
6274 if ( this.outlined
) {
6275 this.outlinePanel
.$element
6276 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
6277 .append( this.outlineWidget
.$element
);
6278 if ( this.editable
) {
6279 this.outlinePanel
.$element
6280 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
6281 .append( this.outlineControlsWidget
.$element
);
6283 this.$element
.append( this.gridLayout
.$element
);
6285 this.$element
.append( this.stackLayout
.$element
);
6291 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.Layout
);
6297 * @param {OO.ui.PageLayout} page Current page
6302 * @param {OO.ui.PageLayout[]} page Added pages
6303 * @param {number} index Index pages were added at
6308 * @param {OO.ui.PageLayout[]} pages Removed pages
6314 * Handle stack layout focus.
6316 * @param {jQuery.Event} e Focusin event
6318 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
6321 // Find the page that an element was focused within
6322 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
6323 for ( name
in this.pages
) {
6324 // Check for page match, exclude current page to find only page changes
6325 if ( this.pages
[name
].$element
[0] === $target
[0] && name
!== this.currentPageName
) {
6326 this.setPage( name
);
6333 * Handle stack layout set events.
6335 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
6337 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
6338 var $input
, layout
= this;
6340 page
.scrollElementIntoView( { complete: function () {
6341 if ( layout
.autoFocus
) {
6342 // Set focus to the first input if nothing on the page is focused yet
6343 if ( !page
.$element
.find( ':focus' ).length
) {
6344 $input
= page
.$element
.find( ':input:first' );
6345 if ( $input
.length
) {
6355 * Handle outline widget select events.
6357 * @param {OO.ui.OptionWidget|null} item Selected item
6359 OO
.ui
.BookletLayout
.prototype.onOutlineWidgetSelect = function ( item
) {
6361 this.setPage( item
.getData() );
6366 * Check if booklet has an outline.
6370 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
6371 return this.outlined
;
6375 * Check if booklet has editing controls.
6379 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
6380 return this.editable
;
6384 * Check if booklet has a visible outline.
6388 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
6389 return this.outlined
&& this.outlineVisible
;
6393 * Hide or show the outline.
6395 * @param {boolean} [show] Show outline, omit to invert current state
6398 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
6399 if ( this.outlined
) {
6400 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
6401 this.outlineVisible
= show
;
6402 this.gridLayout
.layout( show
? [ 1, 2 ] : [ 0, 1 ], [ 1 ] );
6409 * Get the outline widget.
6411 * @param {OO.ui.PageLayout} page Page to be selected
6412 * @return {OO.ui.PageLayout|null} Closest page to another
6414 OO
.ui
.BookletLayout
.prototype.getClosestPage = function ( page
) {
6415 var next
, prev
, level
,
6416 pages
= this.stackLayout
.getItems(),
6417 index
= $.inArray( page
, pages
);
6419 if ( index
!== -1 ) {
6420 next
= pages
[index
+ 1];
6421 prev
= pages
[index
- 1];
6422 // Prefer adjacent pages at the same level
6423 if ( this.outlined
) {
6424 level
= this.outlineWidget
.getItemFromData( page
.getName() ).getLevel();
6427 level
=== this.outlineWidget
.getItemFromData( prev
.getName() ).getLevel()
6433 level
=== this.outlineWidget
.getItemFromData( next
.getName() ).getLevel()
6439 return prev
|| next
|| null;
6443 * Get the outline widget.
6445 * @return {OO.ui.OutlineWidget|null} Outline widget, or null if boolet has no outline
6447 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
6448 return this.outlineWidget
;
6452 * Get the outline controls widget. If the outline is not editable, null is returned.
6454 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
6456 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
6457 return this.outlineControlsWidget
;
6461 * Get a page by name.
6463 * @param {string} name Symbolic name of page
6464 * @return {OO.ui.PageLayout|undefined} Page, if found
6466 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
6467 return this.pages
[name
];
6471 * Get the current page name.
6473 * @return {string|null} Current page name
6475 OO
.ui
.BookletLayout
.prototype.getPageName = function () {
6476 return this.currentPageName
;
6480 * Add a page to the layout.
6482 * When pages are added with the same names as existing pages, the existing pages will be
6483 * automatically removed before the new pages are added.
6485 * @param {OO.ui.PageLayout[]} pages Pages to add
6486 * @param {number} index Index to insert pages after
6490 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
6491 var i
, len
, name
, page
, item
, currentIndex
,
6492 stackLayoutPages
= this.stackLayout
.getItems(),
6496 // Remove pages with same names
6497 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
6499 name
= page
.getName();
6501 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
6502 // Correct the insertion index
6503 currentIndex
= $.inArray( this.pages
[name
], stackLayoutPages
);
6504 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
6507 remove
.push( this.pages
[name
] );
6510 if ( remove
.length
) {
6511 this.removePages( remove
);
6515 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
6517 name
= page
.getName();
6518 this.pages
[page
.getName()] = page
;
6519 if ( this.outlined
) {
6520 item
= new OO
.ui
.OutlineItemWidget( name
, page
, { $: this.$ } );
6521 page
.setOutlineItem( item
);
6526 if ( this.outlined
&& items
.length
) {
6527 this.outlineWidget
.addItems( items
, index
);
6528 this.updateOutlineWidget();
6530 this.stackLayout
.addItems( pages
, index
);
6531 this.emit( 'add', pages
, index
);
6537 * Remove a page from the layout.
6542 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
6543 var i
, len
, name
, page
,
6546 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
6548 name
= page
.getName();
6549 delete this.pages
[name
];
6550 if ( this.outlined
) {
6551 items
.push( this.outlineWidget
.getItemFromData( name
) );
6552 page
.setOutlineItem( null );
6555 if ( this.outlined
&& items
.length
) {
6556 this.outlineWidget
.removeItems( items
);
6557 this.updateOutlineWidget();
6559 this.stackLayout
.removeItems( pages
);
6560 this.emit( 'remove', pages
);
6566 * Clear all pages from the layout.
6571 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
6573 pages
= this.stackLayout
.getItems();
6576 this.currentPageName
= null;
6577 if ( this.outlined
) {
6578 this.outlineWidget
.clearItems();
6579 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
6580 pages
[i
].setOutlineItem( null );
6583 this.stackLayout
.clearItems();
6585 this.emit( 'remove', pages
);
6591 * Set the current page by name.
6594 * @param {string} name Symbolic name of page
6596 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
6599 page
= this.pages
[name
];
6601 if ( name
!== this.currentPageName
) {
6602 if ( this.outlined
) {
6603 selectedItem
= this.outlineWidget
.getSelectedItem();
6604 if ( selectedItem
&& selectedItem
.getData() !== name
) {
6605 this.outlineWidget
.selectItem( this.outlineWidget
.getItemFromData( name
) );
6609 if ( this.currentPageName
&& this.pages
[this.currentPageName
] ) {
6610 this.pages
[this.currentPageName
].setActive( false );
6611 // Blur anything focused if the next page doesn't have anything focusable - this
6612 // is not needed if the next page has something focusable because once it is focused
6613 // this blur happens automatically
6614 if ( this.autoFocus
&& !page
.$element
.find( ':input' ).length
) {
6615 $focused
= this.pages
[this.currentPageName
].$element
.find( ':focus' );
6616 if ( $focused
.length
) {
6621 this.currentPageName
= name
;
6622 this.stackLayout
.setItem( page
);
6623 page
.setActive( true );
6624 this.emit( 'set', page
);
6630 * Call this after adding or removing items from the OutlineWidget.
6634 OO
.ui
.BookletLayout
.prototype.updateOutlineWidget = function () {
6635 // Auto-select first item when nothing is selected anymore
6636 if ( !this.outlineWidget
.getSelectedItem() ) {
6637 this.outlineWidget
.selectItem( this.outlineWidget
.getFirstSelectableItem() );
6644 * Layout made of a field and optional label.
6646 * Available label alignment modes include:
6647 * - left: Label is before the field and aligned away from it, best for when the user will be
6648 * scanning for a specific label in a form with many fields
6649 * - right: Label is before the field and aligned toward it, best for forms the user is very
6650 * familiar with and will tab through field checking quickly to verify which field they are in
6651 * - top: Label is before the field and above it, best for when the user will need to fill out all
6652 * fields from top to bottom in a form with few fields
6653 * - inline: Label is after the field and aligned toward it, best for small boolean fields like
6654 * checkboxes or radio buttons
6657 * @extends OO.ui.Layout
6658 * @mixins OO.ui.LabelElement
6661 * @param {OO.ui.Widget} fieldWidget Field widget
6662 * @param {Object} [config] Configuration options
6663 * @cfg {string} [align='left'] Alignment mode, either 'left', 'right', 'top' or 'inline'
6664 * @cfg {string} [help] Explanatory text shown as a '?' icon.
6666 OO
.ui
.FieldLayout
= function OoUiFieldLayout( fieldWidget
, config
) {
6667 // Configuration initialization
6668 config
= $.extend( { align
: 'left' }, config
);
6670 // Parent constructor
6671 OO
.ui
.FieldLayout
.super.call( this, config
);
6673 // Mixin constructors
6674 OO
.ui
.LabelElement
.call( this, config
);
6677 this.$field
= this.$( '<div>' );
6678 this.fieldWidget
= fieldWidget
;
6680 if ( config
.help
) {
6681 this.popupButtonWidget
= new OO
.ui
.PopupButtonWidget( {
6683 classes
: [ 'oo-ui-fieldLayout-help' ],
6688 this.popupButtonWidget
.getPopup().$body
.append(
6690 .text( config
.help
)
6691 .addClass( 'oo-ui-fieldLayout-help-content' )
6693 this.$help
= this.popupButtonWidget
.$element
;
6695 this.$help
= this.$( [] );
6699 if ( this.fieldWidget
instanceof OO
.ui
.InputWidget
) {
6700 this.$label
.on( 'click', this.onLabelClick
.bind( this ) );
6702 this.fieldWidget
.connect( this, { disable
: 'onFieldDisable' } );
6705 this.$element
.addClass( 'oo-ui-fieldLayout' );
6707 .addClass( 'oo-ui-fieldLayout-field' )
6708 .toggleClass( 'oo-ui-fieldLayout-disable', this.fieldWidget
.isDisabled() )
6709 .append( this.fieldWidget
.$element
);
6710 this.setAlignment( config
.align
);
6715 OO
.inheritClass( OO
.ui
.FieldLayout
, OO
.ui
.Layout
);
6716 OO
.mixinClass( OO
.ui
.FieldLayout
, OO
.ui
.LabelElement
);
6718 /* Static Properties */
6720 OO
.ui
.FieldLayout
.static.tagName
= 'label';
6725 * Handle field disable events.
6727 * @param {boolean} value Field is disabled
6729 OO
.ui
.FieldLayout
.prototype.onFieldDisable = function ( value
) {
6730 this.$element
.toggleClass( 'oo-ui-fieldLayout-disabled', value
);
6734 * Handle label mouse click events.
6736 * @param {jQuery.Event} e Mouse click event
6738 OO
.ui
.FieldLayout
.prototype.onLabelClick = function () {
6739 this.fieldWidget
.simulateLabelClick();
6746 * @return {OO.ui.Widget} Field widget
6748 OO
.ui
.FieldLayout
.prototype.getField = function () {
6749 return this.fieldWidget
;
6753 * Set the field alignment mode.
6756 * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
6759 OO
.ui
.FieldLayout
.prototype.setAlignment = function ( value
) {
6760 if ( value
!== this.align
) {
6761 // Default to 'left'
6762 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value
) === -1 ) {
6766 if ( value
=== 'inline' ) {
6767 this.$element
.append( this.$field
, this.$label
, this.$help
);
6769 this.$element
.append( this.$help
, this.$label
, this.$field
);
6771 // Set classes. The following classes can be used here:
6772 // * oo-ui-fieldLayout-align-left
6773 // * oo-ui-fieldLayout-align-right
6774 // * oo-ui-fieldLayout-align-top
6775 // * oo-ui-fieldLayout-align-inline
6777 this.$element
.removeClass( 'oo-ui-fieldLayout-align-' + this.align
);
6779 this.$element
.addClass( 'oo-ui-fieldLayout-align-' + value
);
6787 * Layout made of a fieldset and optional legend.
6789 * Just add OO.ui.FieldLayout items.
6792 * @extends OO.ui.Layout
6793 * @mixins OO.ui.IconElement
6794 * @mixins OO.ui.LabelElement
6795 * @mixins OO.ui.GroupElement
6798 * @param {Object} [config] Configuration options
6799 * @cfg {OO.ui.FieldLayout[]} [items] Items to add
6801 OO
.ui
.FieldsetLayout
= function OoUiFieldsetLayout( config
) {
6802 // Configuration initialization
6803 config
= config
|| {};
6805 // Parent constructor
6806 OO
.ui
.FieldsetLayout
.super.call( this, config
);
6808 // Mixin constructors
6809 OO
.ui
.IconElement
.call( this, config
);
6810 OO
.ui
.LabelElement
.call( this, config
);
6811 OO
.ui
.GroupElement
.call( this, config
);
6815 .addClass( 'oo-ui-fieldsetLayout' )
6816 .prepend( this.$icon
, this.$label
, this.$group
);
6817 if ( $.isArray( config
.items
) ) {
6818 this.addItems( config
.items
);
6824 OO
.inheritClass( OO
.ui
.FieldsetLayout
, OO
.ui
.Layout
);
6825 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.IconElement
);
6826 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.LabelElement
);
6827 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.GroupElement
);
6830 * Layout with an HTML form.
6833 * @extends OO.ui.Layout
6836 * @param {Object} [config] Configuration options
6837 * @cfg {string} [method] HTML form `method` attribute
6838 * @cfg {string} [action] HTML form `action` attribute
6839 * @cfg {string} [enctype] HTML form `enctype` attribute
6841 OO
.ui
.FormLayout
= function OoUiFormLayout( config
) {
6842 // Configuration initialization
6843 config
= config
|| {};
6845 // Parent constructor
6846 OO
.ui
.FormLayout
.super.call( this, config
);
6849 this.$element
.on( 'submit', this.onFormSubmit
.bind( this ) );
6853 .addClass( 'oo-ui-formLayout' )
6855 method
: config
.method
,
6856 action
: config
.action
,
6857 enctype
: config
.enctype
6863 OO
.inheritClass( OO
.ui
.FormLayout
, OO
.ui
.Layout
);
6871 /* Static Properties */
6873 OO
.ui
.FormLayout
.static.tagName
= 'form';
6878 * Handle form submit events.
6880 * @param {jQuery.Event} e Submit event
6883 OO
.ui
.FormLayout
.prototype.onFormSubmit = function () {
6884 this.emit( 'submit' );
6889 * Layout made of proportionally sized columns and rows.
6892 * @extends OO.ui.Layout
6895 * @param {OO.ui.PanelLayout[]} panels Panels in the grid
6896 * @param {Object} [config] Configuration options
6897 * @cfg {number[]} [widths] Widths of columns as ratios
6898 * @cfg {number[]} [heights] Heights of rows as ratios
6900 OO
.ui
.GridLayout
= function OoUiGridLayout( panels
, config
) {
6903 // Configuration initialization
6904 config
= config
|| {};
6906 // Parent constructor
6907 OO
.ui
.GridLayout
.super.call( this, config
);
6915 this.$element
.addClass( 'oo-ui-gridLayout' );
6916 for ( i
= 0, len
= panels
.length
; i
< len
; i
++ ) {
6917 this.panels
.push( panels
[i
] );
6918 this.$element
.append( panels
[i
].$element
);
6920 if ( config
.widths
|| config
.heights
) {
6921 this.layout( config
.widths
|| [ 1 ], config
.heights
|| [ 1 ] );
6923 // Arrange in columns by default
6924 widths
= this.panels
.map( function () { return 1; } );
6925 this.layout( widths
, [ 1 ] );
6931 OO
.inheritClass( OO
.ui
.GridLayout
, OO
.ui
.Layout
);
6946 * Set grid dimensions.
6948 * @param {number[]} widths Widths of columns as ratios
6949 * @param {number[]} heights Heights of rows as ratios
6951 * @throws {Error} If grid is not large enough to fit all panels
6953 OO
.ui
.GridLayout
.prototype.layout = function ( widths
, heights
) {
6957 cols
= widths
.length
,
6958 rows
= heights
.length
;
6960 // Verify grid is big enough to fit panels
6961 if ( cols
* rows
< this.panels
.length
) {
6962 throw new Error( 'Grid is not large enough to fit ' + this.panels
.length
+ 'panels' );
6965 // Sum up denominators
6966 for ( x
= 0; x
< cols
; x
++ ) {
6969 for ( y
= 0; y
< rows
; y
++ ) {
6975 for ( x
= 0; x
< cols
; x
++ ) {
6976 this.widths
[x
] = widths
[x
] / xd
;
6978 for ( y
= 0; y
< rows
; y
++ ) {
6979 this.heights
[y
] = heights
[y
] / yd
;
6983 this.emit( 'layout' );
6987 * Update panel positions and sizes.
6991 OO
.ui
.GridLayout
.prototype.update = function () {
6992 var x
, y
, panel
, width
, height
, dimensions
,
6996 cols
= this.widths
.length
,
6997 rows
= this.heights
.length
;
6999 for ( y
= 0; y
< rows
; y
++ ) {
7000 height
= this.heights
[y
];
7001 for ( x
= 0; x
< cols
; x
++ ) {
7002 width
= this.widths
[x
];
7003 panel
= this.panels
[i
];
7005 width
: Math
.round( width
* 100 ) + '%',
7006 height
: Math
.round( height
* 100 ) + '%',
7007 top
: Math
.round( top
* 100 ) + '%'
7010 if ( OO
.ui
.Element
.getDir( this.$.context
) === 'rtl' ) {
7011 dimensions
.right
= Math
.round( left
* 100 ) + '%';
7013 dimensions
.left
= Math
.round( left
* 100 ) + '%';
7015 // HACK: Work around IE bug by setting visibility: hidden; if width or height is zero
7016 if ( width
=== 0 || height
=== 0 ) {
7017 dimensions
.visibility
= 'hidden';
7019 dimensions
.visibility
= '';
7021 panel
.$element
.css( dimensions
);
7029 this.emit( 'update' );
7033 * Get a panel at a given position.
7035 * The x and y position is affected by the current grid layout.
7037 * @param {number} x Horizontal position
7038 * @param {number} y Vertical position
7039 * @return {OO.ui.PanelLayout} The panel at the given postion
7041 OO
.ui
.GridLayout
.prototype.getPanel = function ( x
, y
) {
7042 return this.panels
[ ( x
* this.widths
.length
) + y
];
7046 * Layout that expands to cover the entire area of its parent, with optional scrolling and padding.
7049 * @extends OO.ui.Layout
7052 * @param {Object} [config] Configuration options
7053 * @cfg {boolean} [scrollable=false] Allow vertical scrolling
7054 * @cfg {boolean} [padded=false] Pad the content from the edges
7055 * @cfg {boolean} [expanded=true] Expand size to fill the entire parent element
7057 OO
.ui
.PanelLayout
= function OoUiPanelLayout( config
) {
7058 // Configuration initialization
7059 config
= $.extend( {
7065 // Parent constructor
7066 OO
.ui
.PanelLayout
.super.call( this, config
);
7069 this.$element
.addClass( 'oo-ui-panelLayout' );
7070 if ( config
.scrollable
) {
7071 this.$element
.addClass( 'oo-ui-panelLayout-scrollable' );
7073 if ( config
.padded
) {
7074 this.$element
.addClass( 'oo-ui-panelLayout-padded' );
7076 if ( config
.expanded
) {
7077 this.$element
.addClass( 'oo-ui-panelLayout-expanded' );
7083 OO
.inheritClass( OO
.ui
.PanelLayout
, OO
.ui
.Layout
);
7086 * Page within an booklet layout.
7089 * @extends OO.ui.PanelLayout
7092 * @param {string} name Unique symbolic name of page
7093 * @param {Object} [config] Configuration options
7094 * @param {string} [outlineItem] Outline item widget
7096 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
7097 // Configuration initialization
7098 config
= $.extend( { scrollable
: true }, config
);
7100 // Parent constructor
7101 OO
.ui
.PageLayout
.super.call( this, config
);
7105 this.outlineItem
= config
.outlineItem
|| null;
7106 this.active
= false;
7109 this.$element
.addClass( 'oo-ui-pageLayout' );
7114 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
7120 * @param {boolean} active Page is active
7128 * @return {string} Symbolic name of page
7130 OO
.ui
.PageLayout
.prototype.getName = function () {
7135 * Check if page is active.
7137 * @return {boolean} Page is active
7139 OO
.ui
.PageLayout
.prototype.isActive = function () {
7146 * @return {OO.ui.OutlineItemWidget|null} Outline item widget
7148 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
7149 return this.outlineItem
;
7155 * @localdoc Subclasses should override #setupOutlineItem instead of this method to adjust the
7156 * outline item as desired; this method is called for setting (with an object) and unsetting
7157 * (with null) and overriding methods would have to check the value of `outlineItem` to avoid
7158 * operating on null instead of an OO.ui.OutlineItemWidget object.
7160 * @param {OO.ui.OutlineItemWidget|null} outlineItem Outline item widget, null to clear
7163 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
7164 this.outlineItem
= outlineItem
|| null;
7165 if ( outlineItem
) {
7166 this.setupOutlineItem();
7172 * Setup outline item.
7174 * @localdoc Subclasses should override this method to adjust the outline item as desired.
7176 * @param {OO.ui.OutlineItemWidget} outlineItem Outline item widget to setup
7179 OO
.ui
.PageLayout
.prototype.setupOutlineItem = function () {
7184 * Set page active state.
7186 * @param {boolean} Page is active
7189 OO
.ui
.PageLayout
.prototype.setActive = function ( active
) {
7192 if ( active
!== this.active
) {
7193 this.active
= active
;
7194 this.$element
.toggleClass( 'oo-ui-pageLayout-active', active
);
7195 this.emit( 'active', this.active
);
7200 * Layout containing a series of mutually exclusive pages.
7203 * @extends OO.ui.PanelLayout
7204 * @mixins OO.ui.GroupElement
7207 * @param {Object} [config] Configuration options
7208 * @cfg {boolean} [continuous=false] Show all pages, one after another
7209 * @cfg {string} [icon=''] Symbolic icon name
7210 * @cfg {OO.ui.Layout[]} [items] Layouts to add
7212 OO
.ui
.StackLayout
= function OoUiStackLayout( config
) {
7213 // Configuration initialization
7214 config
= $.extend( { scrollable
: true }, config
);
7216 // Parent constructor
7217 OO
.ui
.StackLayout
.super.call( this, config
);
7219 // Mixin constructors
7220 OO
.ui
.GroupElement
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
7223 this.currentItem
= null;
7224 this.continuous
= !!config
.continuous
;
7227 this.$element
.addClass( 'oo-ui-stackLayout' );
7228 if ( this.continuous
) {
7229 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
7231 if ( $.isArray( config
.items
) ) {
7232 this.addItems( config
.items
);
7238 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
7239 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.GroupElement
);
7245 * @param {OO.ui.Layout|null} item Current item or null if there is no longer a layout shown
7251 * Get the current item.
7253 * @return {OO.ui.Layout|null}
7255 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
7256 return this.currentItem
;
7260 * Unset the current item.
7263 * @param {OO.ui.StackLayout} layout
7266 OO
.ui
.StackLayout
.prototype.unsetCurrentItem = function () {
7267 var prevItem
= this.currentItem
;
7268 if ( prevItem
=== null ) {
7272 this.currentItem
= null;
7273 this.emit( 'set', null );
7279 * Adding an existing item (by value) will move it.
7281 * @param {OO.ui.Layout[]} items Items to add
7282 * @param {number} [index] Index to insert items after
7285 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
7287 OO
.ui
.GroupElement
.prototype.addItems
.call( this, items
, index
);
7289 if ( !this.currentItem
&& items
.length
) {
7290 this.setItem( items
[0] );
7299 * Items will be detached, not removed, so they can be used later.
7301 * @param {OO.ui.Layout[]} items Items to remove
7305 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
7307 OO
.ui
.GroupElement
.prototype.removeItems
.call( this, items
);
7309 if ( $.inArray( this.currentItem
, items
) !== -1 ) {
7310 if ( this.items
.length
) {
7311 this.setItem( this.items
[0] );
7313 this.unsetCurrentItem();
7323 * Items will be detached, not removed, so they can be used later.
7328 OO
.ui
.StackLayout
.prototype.clearItems = function () {
7329 this.unsetCurrentItem();
7330 OO
.ui
.GroupElement
.prototype.clearItems
.call( this );
7338 * Any currently shown item will be hidden.
7340 * FIXME: If the passed item to show has not been added in the items list, then
7341 * this method drops it and unsets the current item.
7343 * @param {OO.ui.Layout} item Item to show
7347 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
7350 if ( item
!== this.currentItem
) {
7351 if ( !this.continuous
) {
7352 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
7353 this.items
[i
].$element
.css( 'display', '' );
7356 if ( $.inArray( item
, this.items
) !== -1 ) {
7357 if ( !this.continuous
) {
7358 item
.$element
.css( 'display', 'block' );
7360 this.currentItem
= item
;
7361 this.emit( 'set', item
);
7363 this.unsetCurrentItem();
7371 * Horizontal bar layout of tools as icon buttons.
7374 * @extends OO.ui.ToolGroup
7377 * @param {OO.ui.Toolbar} toolbar
7378 * @param {Object} [config] Configuration options
7380 OO
.ui
.BarToolGroup
= function OoUiBarToolGroup( toolbar
, config
) {
7381 // Parent constructor
7382 OO
.ui
.BarToolGroup
.super.call( this, toolbar
, config
);
7385 this.$element
.addClass( 'oo-ui-barToolGroup' );
7390 OO
.inheritClass( OO
.ui
.BarToolGroup
, OO
.ui
.ToolGroup
);
7392 /* Static Properties */
7394 OO
.ui
.BarToolGroup
.static.titleTooltips
= true;
7396 OO
.ui
.BarToolGroup
.static.accelTooltips
= true;
7398 OO
.ui
.BarToolGroup
.static.name
= 'bar';
7401 * Popup list of tools with an icon and optional label.
7405 * @extends OO.ui.ToolGroup
7406 * @mixins OO.ui.IconElement
7407 * @mixins OO.ui.IndicatorElement
7408 * @mixins OO.ui.LabelElement
7409 * @mixins OO.ui.TitledElement
7410 * @mixins OO.ui.ClippableElement
7413 * @param {OO.ui.Toolbar} toolbar
7414 * @param {Object} [config] Configuration options
7415 * @cfg {string} [header] Text to display at the top of the pop-up
7417 OO
.ui
.PopupToolGroup
= function OoUiPopupToolGroup( toolbar
, config
) {
7418 // Configuration initialization
7419 config
= config
|| {};
7421 // Parent constructor
7422 OO
.ui
.PopupToolGroup
.super.call( this, toolbar
, config
);
7424 // Mixin constructors
7425 OO
.ui
.IconElement
.call( this, config
);
7426 OO
.ui
.IndicatorElement
.call( this, config
);
7427 OO
.ui
.LabelElement
.call( this, config
);
7428 OO
.ui
.TitledElement
.call( this, config
);
7429 OO
.ui
.ClippableElement
.call( this, $.extend( {}, config
, { $clippable
: this.$group
} ) );
7432 this.active
= false;
7433 this.dragging
= false;
7434 this.onBlurHandler
= this.onBlur
.bind( this );
7435 this.$handle
= this.$( '<span>' );
7439 'mousedown touchstart': this.onHandlePointerDown
.bind( this ),
7440 'mouseup touchend': this.onHandlePointerUp
.bind( this )
7445 .addClass( 'oo-ui-popupToolGroup-handle' )
7446 .append( this.$icon
, this.$label
, this.$indicator
);
7447 // If the pop-up should have a header, add it to the top of the toolGroup.
7448 // Note: If this feature is useful for other widgets, we could abstract it into an
7449 // OO.ui.HeaderedElement mixin constructor.
7450 if ( config
.header
!== undefined ) {
7452 .prepend( this.$( '<span>' )
7453 .addClass( 'oo-ui-popupToolGroup-header' )
7454 .text( config
.header
)
7458 .addClass( 'oo-ui-popupToolGroup' )
7459 .prepend( this.$handle
);
7464 OO
.inheritClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ToolGroup
);
7465 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IconElement
);
7466 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IndicatorElement
);
7467 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.LabelElement
);
7468 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.TitledElement
);
7469 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ClippableElement
);
7471 /* Static Properties */
7478 OO
.ui
.PopupToolGroup
.prototype.setDisabled = function () {
7480 OO
.ui
.PopupToolGroup
.super.prototype.setDisabled
.apply( this, arguments
);
7482 if ( this.isDisabled() && this.isElementAttached() ) {
7483 this.setActive( false );
7488 * Handle focus being lost.
7490 * The event is actually generated from a mouseup, so it is not a normal blur event object.
7492 * @param {jQuery.Event} e Mouse up event
7494 OO
.ui
.PopupToolGroup
.prototype.onBlur = function ( e
) {
7495 // Only deactivate when clicking outside the dropdown element
7496 if ( this.$( e
.target
).closest( '.oo-ui-popupToolGroup' )[0] !== this.$element
[0] ) {
7497 this.setActive( false );
7504 OO
.ui
.PopupToolGroup
.prototype.onPointerUp = function ( e
) {
7505 // e.which is 0 for touch events, 1 for left mouse button
7506 // Only close toolgroup when a tool was actually selected
7507 // FIXME: this duplicates logic from the parent class
7508 if ( !this.isDisabled() && e
.which
<= 1 && this.pressed
&& this.pressed
=== this.getTargetTool( e
) ) {
7509 this.setActive( false );
7511 return OO
.ui
.PopupToolGroup
.super.prototype.onPointerUp
.call( this, e
);
7515 * Handle mouse up events.
7517 * @param {jQuery.Event} e Mouse up event
7519 OO
.ui
.PopupToolGroup
.prototype.onHandlePointerUp = function () {
7524 * Handle mouse down events.
7526 * @param {jQuery.Event} e Mouse down event
7528 OO
.ui
.PopupToolGroup
.prototype.onHandlePointerDown = function ( e
) {
7529 // e.which is 0 for touch events, 1 for left mouse button
7530 if ( !this.isDisabled() && e
.which
<= 1 ) {
7531 this.setActive( !this.active
);
7537 * Switch into active mode.
7539 * When active, mouseup events anywhere in the document will trigger deactivation.
7541 OO
.ui
.PopupToolGroup
.prototype.setActive = function ( value
) {
7543 if ( this.active
!== value
) {
7544 this.active
= value
;
7546 this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler
, true );
7548 // Try anchoring the popup to the left first
7549 this.$element
.addClass( 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left' );
7550 this.toggleClipping( true );
7551 if ( this.isClippedHorizontally() ) {
7552 // Anchoring to the left caused the popup to clip, so anchor it to the right instead
7553 this.toggleClipping( false );
7555 .removeClass( 'oo-ui-popupToolGroup-left' )
7556 .addClass( 'oo-ui-popupToolGroup-right' );
7557 this.toggleClipping( true );
7560 this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler
, true );
7561 this.$element
.removeClass(
7562 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left oo-ui-popupToolGroup-right'
7564 this.toggleClipping( false );
7570 * Drop down list layout of tools as labeled icon buttons.
7572 * This layout allows some tools to be collapsible, controlled by a "More" / "Fewer" option at the
7573 * bottom of the main list. These are not automatically positioned at the bottom of the list; you
7574 * may want to use the 'promote' and 'demote' configuration options to achieve this.
7577 * @extends OO.ui.PopupToolGroup
7580 * @param {OO.ui.Toolbar} toolbar
7581 * @param {Object} [config] Configuration options
7582 * @cfg {Array} [allowCollapse] List of tools that can be collapsed. Remaining tools will be always
7584 * @cfg {Array} [forceExpand] List of tools that *may not* be collapsed. All remaining tools will be
7585 * allowed to be collapsed.
7586 * @cfg {boolean} [expanded=false] Whether the collapsible tools are expanded by default
7588 OO
.ui
.ListToolGroup
= function OoUiListToolGroup( toolbar
, config
) {
7589 // Configuration intialization
7590 config
= config
|| {};
7592 // Properties (must be set before parent constructor, which calls #populate)
7593 this.allowCollapse
= config
.allowCollapse
;
7594 this.forceExpand
= config
.forceExpand
;
7595 this.expanded
= config
.expanded
!== undefined ? config
.expanded
: false;
7596 this.collapsibleTools
= [];
7598 // Parent constructor
7599 OO
.ui
.ListToolGroup
.super.call( this, toolbar
, config
);
7602 this.$element
.addClass( 'oo-ui-listToolGroup' );
7607 OO
.inheritClass( OO
.ui
.ListToolGroup
, OO
.ui
.PopupToolGroup
);
7609 /* Static Properties */
7611 OO
.ui
.ListToolGroup
.static.accelTooltips
= true;
7613 OO
.ui
.ListToolGroup
.static.name
= 'list';
7620 OO
.ui
.ListToolGroup
.prototype.populate = function () {
7621 var i
, len
, allowCollapse
= [];
7623 OO
.ui
.ListToolGroup
.super.prototype.populate
.call( this );
7625 // Update the list of collapsible tools
7626 if ( this.allowCollapse
!== undefined ) {
7627 allowCollapse
= this.allowCollapse
;
7628 } else if ( this.forceExpand
!== undefined ) {
7629 allowCollapse
= OO
.simpleArrayDifference( Object
.keys( this.tools
), this.forceExpand
);
7632 this.collapsibleTools
= [];
7633 for ( i
= 0, len
= allowCollapse
.length
; i
< len
; i
++ ) {
7634 if ( this.tools
[ allowCollapse
[i
] ] !== undefined ) {
7635 this.collapsibleTools
.push( this.tools
[ allowCollapse
[i
] ] );
7639 // Keep at the end, even when tools are added
7640 this.$group
.append( this.getExpandCollapseTool().$element
);
7642 this.getExpandCollapseTool().toggle( this.collapsibleTools
.length
!== 0 );
7644 // Calling jQuery's .hide() and then .show() on a detached element caches the default value of its
7645 // 'display' attribute and restores it, and the tool uses a <span> and can be hidden and re-shown.
7646 // Is this a jQuery bug? http://jsfiddle.net/gtj4hu3h/
7647 if ( this.getExpandCollapseTool().$element
.css( 'display' ) === 'inline' ) {
7648 this.getExpandCollapseTool().$element
.css( 'display', 'inline-block' );
7651 this.updateCollapsibleState();
7654 OO
.ui
.ListToolGroup
.prototype.getExpandCollapseTool = function () {
7655 if ( this.expandCollapseTool
=== undefined ) {
7656 var ExpandCollapseTool = function () {
7657 ExpandCollapseTool
.super.apply( this, arguments
);
7660 OO
.inheritClass( ExpandCollapseTool
, OO
.ui
.Tool
);
7662 ExpandCollapseTool
.prototype.onSelect = function () {
7663 this.toolGroup
.expanded
= !this.toolGroup
.expanded
;
7664 this.toolGroup
.updateCollapsibleState();
7665 this.setActive( false );
7667 ExpandCollapseTool
.prototype.onUpdateState = function () {
7668 // Do nothing. Tool interface requires an implementation of this function.
7671 ExpandCollapseTool
.static.name
= 'more-fewer';
7673 this.expandCollapseTool
= new ExpandCollapseTool( this );
7675 return this.expandCollapseTool
;
7681 OO
.ui
.ListToolGroup
.prototype.onPointerUp = function ( e
) {
7682 var ret
= OO
.ui
.ListToolGroup
.super.prototype.onPointerUp
.call( this, e
);
7684 // Do not close the popup when the user wants to show more/fewer tools
7685 if ( this.$( e
.target
).closest( '.oo-ui-tool-name-more-fewer' ).length
) {
7686 // Prevent the popup list from being hidden
7687 this.setActive( true );
7693 OO
.ui
.ListToolGroup
.prototype.updateCollapsibleState = function () {
7696 this.getExpandCollapseTool()
7697 .setIcon( this.expanded
? 'collapse' : 'expand' )
7698 .setTitle( OO
.ui
.msg( this.expanded
? 'ooui-toolgroup-collapse' : 'ooui-toolgroup-expand' ) );
7700 for ( i
= 0, len
= this.collapsibleTools
.length
; i
< len
; i
++ ) {
7701 this.collapsibleTools
[i
].toggle( this.expanded
);
7706 * Drop down menu layout of tools as selectable menu items.
7709 * @extends OO.ui.PopupToolGroup
7712 * @param {OO.ui.Toolbar} toolbar
7713 * @param {Object} [config] Configuration options
7715 OO
.ui
.MenuToolGroup
= function OoUiMenuToolGroup( toolbar
, config
) {
7716 // Configuration initialization
7717 config
= config
|| {};
7719 // Parent constructor
7720 OO
.ui
.MenuToolGroup
.super.call( this, toolbar
, config
);
7723 this.toolbar
.connect( this, { updateState
: 'onUpdateState' } );
7726 this.$element
.addClass( 'oo-ui-menuToolGroup' );
7731 OO
.inheritClass( OO
.ui
.MenuToolGroup
, OO
.ui
.PopupToolGroup
);
7733 /* Static Properties */
7735 OO
.ui
.MenuToolGroup
.static.accelTooltips
= true;
7737 OO
.ui
.MenuToolGroup
.static.name
= 'menu';
7742 * Handle the toolbar state being updated.
7744 * When the state changes, the title of each active item in the menu will be joined together and
7745 * used as a label for the group. The label will be empty if none of the items are active.
7747 OO
.ui
.MenuToolGroup
.prototype.onUpdateState = function () {
7751 for ( name
in this.tools
) {
7752 if ( this.tools
[name
].isActive() ) {
7753 labelTexts
.push( this.tools
[name
].getTitle() );
7757 this.setLabel( labelTexts
.join( ', ' ) || ' ' );
7761 * Tool that shows a popup when selected.
7765 * @extends OO.ui.Tool
7766 * @mixins OO.ui.PopupElement
7769 * @param {OO.ui.Toolbar} toolbar
7770 * @param {Object} [config] Configuration options
7772 OO
.ui
.PopupTool
= function OoUiPopupTool( toolbar
, config
) {
7773 // Parent constructor
7774 OO
.ui
.PopupTool
.super.call( this, toolbar
, config
);
7776 // Mixin constructors
7777 OO
.ui
.PopupElement
.call( this, config
);
7781 .addClass( 'oo-ui-popupTool' )
7782 .append( this.popup
.$element
);
7787 OO
.inheritClass( OO
.ui
.PopupTool
, OO
.ui
.Tool
);
7788 OO
.mixinClass( OO
.ui
.PopupTool
, OO
.ui
.PopupElement
);
7793 * Handle the tool being selected.
7797 OO
.ui
.PopupTool
.prototype.onSelect = function () {
7798 if ( !this.isDisabled() ) {
7799 this.popup
.toggle();
7801 this.setActive( false );
7806 * Handle the toolbar state being updated.
7810 OO
.ui
.PopupTool
.prototype.onUpdateState = function () {
7811 this.setActive( false );
7815 * Mixin for OO.ui.Widget subclasses to provide OO.ui.GroupElement.
7817 * Use together with OO.ui.ItemWidget to make disabled state inheritable.
7821 * @extends OO.ui.GroupElement
7824 * @param {Object} [config] Configuration options
7826 OO
.ui
.GroupWidget
= function OoUiGroupWidget( config
) {
7827 // Parent constructor
7828 OO
.ui
.GroupWidget
.super.call( this, config
);
7833 OO
.inheritClass( OO
.ui
.GroupWidget
, OO
.ui
.GroupElement
);
7838 * Set the disabled state of the widget.
7840 * This will also update the disabled state of child widgets.
7842 * @param {boolean} disabled Disable widget
7845 OO
.ui
.GroupWidget
.prototype.setDisabled = function ( disabled
) {
7849 // Note: Calling #setDisabled this way assumes this is mixed into an OO.ui.Widget
7850 OO
.ui
.Widget
.prototype.setDisabled
.call( this, disabled
);
7852 // During construction, #setDisabled is called before the OO.ui.GroupElement constructor
7854 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
7855 this.items
[i
].updateDisabled();
7863 * Mixin for widgets used as items in widgets that inherit OO.ui.GroupWidget.
7865 * Item widgets have a reference to a OO.ui.GroupWidget while they are attached to the group. This
7866 * allows bidrectional communication.
7868 * Use together with OO.ui.GroupWidget to make disabled state inheritable.
7875 OO
.ui
.ItemWidget
= function OoUiItemWidget() {
7882 * Check if widget is disabled.
7884 * Checks parent if present, making disabled state inheritable.
7886 * @return {boolean} Widget is disabled
7888 OO
.ui
.ItemWidget
.prototype.isDisabled = function () {
7889 return this.disabled
||
7890 ( this.elementGroup
instanceof OO
.ui
.Widget
&& this.elementGroup
.isDisabled() );
7894 * Set group element is in.
7896 * @param {OO.ui.GroupElement|null} group Group element, null if none
7899 OO
.ui
.ItemWidget
.prototype.setElementGroup = function ( group
) {
7901 // Note: Calling #setElementGroup this way assumes this is mixed into an OO.ui.Element
7902 OO
.ui
.Element
.prototype.setElementGroup
.call( this, group
);
7904 // Initialize item disabled states
7905 this.updateDisabled();
7911 * Mixin that adds a menu showing suggested values for a text input.
7913 * Subclasses must handle `select` and `choose` events on #lookupMenu to make use of selections.
7915 * Subclasses that set the value of #lookupInput from their `choose` or `select` handler should
7916 * be aware that this will cause new suggestions to be looked up for the new value. If this is
7917 * not desired, disable lookups with #setLookupsDisabled, then set the value, then re-enable lookups.
7923 * @param {OO.ui.TextInputWidget} input Input widget
7924 * @param {Object} [config] Configuration options
7925 * @cfg {jQuery} [$overlay] Overlay for dropdown; defaults to relative positioning
7926 * @cfg {jQuery} [$container=input.$element] Element to render menu under
7928 OO
.ui
.LookupInputWidget
= function OoUiLookupInputWidget( input
, config
) {
7929 // Configuration initialization
7930 config
= config
|| {};
7933 this.lookupInput
= input
;
7934 this.$overlay
= config
.$overlay
|| this.$element
;
7935 this.lookupMenu
= new OO
.ui
.TextInputMenuWidget( this, {
7936 $: OO
.ui
.Element
.getJQuery( this.$overlay
),
7937 input
: this.lookupInput
,
7938 $container
: config
.$container
7940 this.lookupCache
= {};
7941 this.lookupQuery
= null;
7942 this.lookupRequest
= null;
7943 this.lookupsDisabled
= false;
7944 this.lookupInputFocused
= false;
7947 this.lookupInput
.$input
.on( {
7948 focus
: this.onLookupInputFocus
.bind( this ),
7949 blur
: this.onLookupInputBlur
.bind( this ),
7950 mousedown
: this.onLookupInputMouseDown
.bind( this )
7952 this.lookupInput
.connect( this, { change
: 'onLookupInputChange' } );
7953 this.lookupMenu
.connect( this, { toggle
: 'onLookupMenuToggle' } );
7956 this.$element
.addClass( 'oo-ui-lookupWidget' );
7957 this.lookupMenu
.$element
.addClass( 'oo-ui-lookupWidget-menu' );
7958 this.$overlay
.append( this.lookupMenu
.$element
);
7964 * Handle input focus event.
7966 * @param {jQuery.Event} e Input focus event
7968 OO
.ui
.LookupInputWidget
.prototype.onLookupInputFocus = function () {
7969 this.lookupInputFocused
= true;
7970 this.populateLookupMenu();
7974 * Handle input blur event.
7976 * @param {jQuery.Event} e Input blur event
7978 OO
.ui
.LookupInputWidget
.prototype.onLookupInputBlur = function () {
7979 this.closeLookupMenu();
7980 this.lookupInputFocused
= false;
7984 * Handle input mouse down event.
7986 * @param {jQuery.Event} e Input mouse down event
7988 OO
.ui
.LookupInputWidget
.prototype.onLookupInputMouseDown = function () {
7989 // Only open the menu if the input was already focused.
7990 // This way we allow the user to open the menu again after closing it with Esc
7991 // by clicking in the input. Opening (and populating) the menu when initially
7992 // clicking into the input is handled by the focus handler.
7993 if ( this.lookupInputFocused
&& !this.lookupMenu
.isVisible() ) {
7994 this.populateLookupMenu();
7999 * Handle input change event.
8001 * @param {string} value New input value
8003 OO
.ui
.LookupInputWidget
.prototype.onLookupInputChange = function () {
8004 if ( this.lookupInputFocused
) {
8005 this.populateLookupMenu();
8010 * Handle the lookup menu being shown/hidden.
8011 * @param {boolean} visible Whether the lookup menu is now visible.
8013 OO
.ui
.LookupInputWidget
.prototype.onLookupMenuToggle = function ( visible
) {
8015 // When the menu is hidden, abort any active request and clear the menu.
8016 // This has to be done here in addition to closeLookupMenu(), because
8017 // MenuWidget will close itself when the user presses Esc.
8018 this.abortLookupRequest();
8019 this.lookupMenu
.clearItems();
8026 * @return {OO.ui.TextInputMenuWidget}
8028 OO
.ui
.LookupInputWidget
.prototype.getLookupMenu = function () {
8029 return this.lookupMenu
;
8033 * Disable or re-enable lookups.
8035 * When lookups are disabled, calls to #populateLookupMenu will be ignored.
8037 * @param {boolean} disabled Disable lookups
8039 OO
.ui
.LookupInputWidget
.prototype.setLookupsDisabled = function ( disabled
) {
8040 this.lookupsDisabled
= !!disabled
;
8044 * Open the menu. If there are no entries in the menu, this does nothing.
8048 OO
.ui
.LookupInputWidget
.prototype.openLookupMenu = function () {
8049 if ( !this.lookupMenu
.isEmpty() ) {
8050 this.lookupMenu
.toggle( true );
8056 * Close the menu, empty it, and abort any pending request.
8060 OO
.ui
.LookupInputWidget
.prototype.closeLookupMenu = function () {
8061 this.lookupMenu
.toggle( false );
8062 this.abortLookupRequest();
8063 this.lookupMenu
.clearItems();
8068 * Request menu items based on the input's current value, and when they arrive,
8069 * populate the menu with these items and show the menu.
8071 * If lookups have been disabled with #setLookupsDisabled, this function does nothing.
8075 OO
.ui
.LookupInputWidget
.prototype.populateLookupMenu = function () {
8077 value
= this.lookupInput
.getValue();
8079 if ( this.lookupsDisabled
) {
8083 // If the input is empty, clear the menu
8084 if ( value
=== '' ) {
8085 this.closeLookupMenu();
8086 // Skip population if there is already a request pending for the current value
8087 } else if ( value
!== this.lookupQuery
) {
8088 this.getLookupMenuItems()
8089 .done( function ( items
) {
8090 widget
.lookupMenu
.clearItems();
8091 if ( items
.length
) {
8095 widget
.initializeLookupMenuSelection();
8097 widget
.lookupMenu
.toggle( false );
8100 .fail( function () {
8101 widget
.lookupMenu
.clearItems();
8109 * Select and highlight the first selectable item in the menu.
8113 OO
.ui
.LookupInputWidget
.prototype.initializeLookupMenuSelection = function () {
8114 if ( !this.lookupMenu
.getSelectedItem() ) {
8115 this.lookupMenu
.selectItem( this.lookupMenu
.getFirstSelectableItem() );
8117 this.lookupMenu
.highlightItem( this.lookupMenu
.getSelectedItem() );
8121 * Get lookup menu items for the current query.
8123 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument
8124 * of the done event. If the request was aborted to make way for a subsequent request,
8125 * this promise will not be rejected: it will remain pending forever.
8127 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItems = function () {
8129 value
= this.lookupInput
.getValue(),
8130 deferred
= $.Deferred(),
8133 this.abortLookupRequest();
8134 if ( Object
.prototype.hasOwnProperty
.call( this.lookupCache
, value
) ) {
8135 deferred
.resolve( this.getLookupMenuItemsFromData( this.lookupCache
[value
] ) );
8137 this.lookupInput
.pushPending();
8138 this.lookupQuery
= value
;
8139 ourRequest
= this.lookupRequest
= this.getLookupRequest();
8141 .always( function () {
8142 // We need to pop pending even if this is an old request, otherwise
8143 // the widget will remain pending forever.
8144 // TODO: this assumes that an aborted request will fail or succeed soon after
8145 // being aborted, or at least eventually. It would be nice if we could popPending()
8146 // at abort time, but only if we knew that we hadn't already called popPending()
8147 // for that request.
8148 widget
.lookupInput
.popPending();
8150 .done( function ( data
) {
8151 // If this is an old request (and aborting it somehow caused it to still succeed),
8152 // ignore its success completely
8153 if ( ourRequest
=== widget
.lookupRequest
) {
8154 widget
.lookupQuery
= null;
8155 widget
.lookupRequest
= null;
8156 widget
.lookupCache
[value
] = widget
.getLookupCacheItemFromData( data
);
8157 deferred
.resolve( widget
.getLookupMenuItemsFromData( widget
.lookupCache
[value
] ) );
8160 .fail( function () {
8161 // If this is an old request (or a request failing because it's being aborted),
8162 // ignore its failure completely
8163 if ( ourRequest
=== widget
.lookupRequest
) {
8164 widget
.lookupQuery
= null;
8165 widget
.lookupRequest
= null;
8170 return deferred
.promise();
8174 * Abort the currently pending lookup request, if any.
8176 OO
.ui
.LookupInputWidget
.prototype.abortLookupRequest = function () {
8177 var oldRequest
= this.lookupRequest
;
8179 // First unset this.lookupRequest to the fail handler will notice
8180 // that the request is no longer current
8181 this.lookupRequest
= null;
8182 this.lookupQuery
= null;
8188 * Get a new request object of the current lookup query value.
8191 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
8193 OO
.ui
.LookupInputWidget
.prototype.getLookupRequest = function () {
8194 // Stub, implemented in subclass
8199 * Get a list of menu item widgets from the data stored by the lookup request's done handler.
8202 * @param {Mixed} data Cached result data, usually an array
8203 * @return {OO.ui.MenuItemWidget[]} Menu items
8205 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItemsFromData = function () {
8206 // Stub, implemented in subclass
8211 * Get lookup cache item from server response data.
8214 * @param {Mixed} data Response from server
8215 * @return {Mixed} Cached result data
8217 OO
.ui
.LookupInputWidget
.prototype.getLookupCacheItemFromData = function () {
8218 // Stub, implemented in subclass
8223 * Set of controls for an OO.ui.OutlineWidget.
8225 * Controls include moving items up and down, removing items, and adding different kinds of items.
8228 * @extends OO.ui.Widget
8229 * @mixins OO.ui.GroupElement
8230 * @mixins OO.ui.IconElement
8233 * @param {OO.ui.OutlineWidget} outline Outline to control
8234 * @param {Object} [config] Configuration options
8236 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
8237 // Configuration initialization
8238 config
= $.extend( { icon
: 'add' }, config
);
8240 // Parent constructor
8241 OO
.ui
.OutlineControlsWidget
.super.call( this, config
);
8243 // Mixin constructors
8244 OO
.ui
.GroupElement
.call( this, config
);
8245 OO
.ui
.IconElement
.call( this, config
);
8248 this.outline
= outline
;
8249 this.$movers
= this.$( '<div>' );
8250 this.upButton
= new OO
.ui
.ButtonWidget( {
8254 title
: OO
.ui
.msg( 'ooui-outline-control-move-up' )
8256 this.downButton
= new OO
.ui
.ButtonWidget( {
8260 title
: OO
.ui
.msg( 'ooui-outline-control-move-down' )
8262 this.removeButton
= new OO
.ui
.ButtonWidget( {
8266 title
: OO
.ui
.msg( 'ooui-outline-control-remove' )
8270 outline
.connect( this, {
8271 select
: 'onOutlineChange',
8272 add
: 'onOutlineChange',
8273 remove
: 'onOutlineChange'
8275 this.upButton
.connect( this, { click
: [ 'emit', 'move', -1 ] } );
8276 this.downButton
.connect( this, { click
: [ 'emit', 'move', 1 ] } );
8277 this.removeButton
.connect( this, { click
: [ 'emit', 'remove' ] } );
8280 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
8281 this.$group
.addClass( 'oo-ui-outlineControlsWidget-items' );
8283 .addClass( 'oo-ui-outlineControlsWidget-movers' )
8284 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
8285 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
8290 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
8291 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.GroupElement
);
8292 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.IconElement
);
8298 * @param {number} places Number of places to move
8308 * Handle outline change events.
8310 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
8311 var i
, len
, firstMovable
, lastMovable
,
8312 items
= this.outline
.getItems(),
8313 selectedItem
= this.outline
.getSelectedItem(),
8314 movable
= selectedItem
&& selectedItem
.isMovable(),
8315 removable
= selectedItem
&& selectedItem
.isRemovable();
8320 while ( ++i
< len
) {
8321 if ( items
[i
].isMovable() ) {
8322 firstMovable
= items
[i
];
8328 if ( items
[i
].isMovable() ) {
8329 lastMovable
= items
[i
];
8334 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
8335 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
8336 this.removeButton
.setDisabled( !removable
);
8340 * Mixin for widgets with a boolean on/off state.
8346 * @param {Object} [config] Configuration options
8347 * @cfg {boolean} [value=false] Initial value
8349 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
8350 // Configuration initialization
8351 config
= config
|| {};
8357 this.$element
.addClass( 'oo-ui-toggleWidget' );
8358 this.setValue( !!config
.value
);
8365 * @param {boolean} value Changed value
8371 * Get the value of the toggle.
8375 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
8380 * Set the value of the toggle.
8382 * @param {boolean} value New value
8386 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
8388 if ( this.value
!== value
) {
8390 this.emit( 'change', value
);
8391 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
8392 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
8398 * Group widget for multiple related buttons.
8400 * Use together with OO.ui.ButtonWidget.
8403 * @extends OO.ui.Widget
8404 * @mixins OO.ui.GroupElement
8407 * @param {Object} [config] Configuration options
8408 * @cfg {OO.ui.ButtonWidget[]} [items] Buttons to add
8410 OO
.ui
.ButtonGroupWidget
= function OoUiButtonGroupWidget( config
) {
8411 // Configuration initialization
8412 config
= config
|| {};
8414 // Parent constructor
8415 OO
.ui
.ButtonGroupWidget
.super.call( this, config
);
8417 // Mixin constructors
8418 OO
.ui
.GroupElement
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
8421 this.$element
.addClass( 'oo-ui-buttonGroupWidget' );
8422 if ( $.isArray( config
.items
) ) {
8423 this.addItems( config
.items
);
8429 OO
.inheritClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.Widget
);
8430 OO
.mixinClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.GroupElement
);
8433 * Generic widget for buttons.
8436 * @extends OO.ui.Widget
8437 * @mixins OO.ui.ButtonElement
8438 * @mixins OO.ui.IconElement
8439 * @mixins OO.ui.IndicatorElement
8440 * @mixins OO.ui.LabelElement
8441 * @mixins OO.ui.TitledElement
8442 * @mixins OO.ui.FlaggedElement
8445 * @param {Object} [config] Configuration options
8446 * @cfg {string} [href] Hyperlink to visit when clicked
8447 * @cfg {string} [target] Target to open hyperlink in
8449 OO
.ui
.ButtonWidget
= function OoUiButtonWidget( config
) {
8450 // Configuration initialization
8451 config
= $.extend( { target
: '_blank' }, config
);
8453 // Parent constructor
8454 OO
.ui
.ButtonWidget
.super.call( this, config
);
8456 // Mixin constructors
8457 OO
.ui
.ButtonElement
.call( this, config
);
8458 OO
.ui
.IconElement
.call( this, config
);
8459 OO
.ui
.IndicatorElement
.call( this, config
);
8460 OO
.ui
.LabelElement
.call( this, config
);
8461 OO
.ui
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$button
} ) );
8462 OO
.ui
.FlaggedElement
.call( this, config
);
8467 this.isHyperlink
= false;
8471 click
: this.onClick
.bind( this ),
8472 keypress
: this.onKeyPress
.bind( this )
8476 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
8478 .addClass( 'oo-ui-buttonWidget' )
8479 .append( this.$button
);
8480 this.setHref( config
.href
);
8481 this.setTarget( config
.target
);
8486 OO
.inheritClass( OO
.ui
.ButtonWidget
, OO
.ui
.Widget
);
8487 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.ButtonElement
);
8488 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IconElement
);
8489 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IndicatorElement
);
8490 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.LabelElement
);
8491 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.TitledElement
);
8492 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.FlaggedElement
);
8503 * Handles mouse click events.
8505 * @param {jQuery.Event} e Mouse click event
8508 OO
.ui
.ButtonWidget
.prototype.onClick = function () {
8509 if ( !this.isDisabled() ) {
8510 this.emit( 'click' );
8511 if ( this.isHyperlink
) {
8519 * Handles keypress events.
8521 * @param {jQuery.Event} e Keypress event
8524 OO
.ui
.ButtonWidget
.prototype.onKeyPress = function ( e
) {
8525 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
8526 this.emit( 'click' );
8527 if ( this.isHyperlink
) {
8535 * Get hyperlink location.
8537 * @return {string} Hyperlink location
8539 OO
.ui
.ButtonWidget
.prototype.getHref = function () {
8544 * Get hyperlink target.
8546 * @return {string} Hyperlink target
8548 OO
.ui
.ButtonWidget
.prototype.getTarget = function () {
8553 * Set hyperlink location.
8555 * @param {string|null} href Hyperlink location, null to remove
8557 OO
.ui
.ButtonWidget
.prototype.setHref = function ( href
) {
8558 href
= typeof href
=== 'string' ? href
: null;
8560 if ( href
!== this.href
) {
8562 if ( href
!== null ) {
8563 this.$button
.attr( 'href', href
);
8564 this.isHyperlink
= true;
8566 this.$button
.removeAttr( 'href' );
8567 this.isHyperlink
= false;
8575 * Set hyperlink target.
8577 * @param {string|null} target Hyperlink target, null to remove
8579 OO
.ui
.ButtonWidget
.prototype.setTarget = function ( target
) {
8580 target
= typeof target
=== 'string' ? target
: null;
8582 if ( target
!== this.target
) {
8583 this.target
= target
;
8584 if ( target
!== null ) {
8585 this.$button
.attr( 'target', target
);
8587 this.$button
.removeAttr( 'target' );
8595 * Button widget that executes an action and is managed by an OO.ui.ActionSet.
8598 * @extends OO.ui.ButtonWidget
8599 * @mixins OO.ui.PendingElement
8602 * @param {Object} [config] Configuration options
8603 * @cfg {string} [action] Symbolic action name
8604 * @cfg {string[]} [modes] Symbolic mode names
8605 * @cfg {boolean} [framed=false] Render button with a frame
8607 OO
.ui
.ActionWidget
= function OoUiActionWidget( config
) {
8608 // Configuration initialization
8609 config
= $.extend( { framed
: false }, config
);
8611 // Parent constructor
8612 OO
.ui
.ActionWidget
.super.call( this, config
);
8614 // Mixin constructors
8615 OO
.ui
.PendingElement
.call( this, config
);
8618 this.action
= config
.action
|| '';
8619 this.modes
= config
.modes
|| [];
8624 this.$element
.addClass( 'oo-ui-actionWidget' );
8629 OO
.inheritClass( OO
.ui
.ActionWidget
, OO
.ui
.ButtonWidget
);
8630 OO
.mixinClass( OO
.ui
.ActionWidget
, OO
.ui
.PendingElement
);
8641 * Check if action is available in a certain mode.
8643 * @param {string} mode Name of mode
8644 * @return {boolean} Has mode
8646 OO
.ui
.ActionWidget
.prototype.hasMode = function ( mode
) {
8647 return this.modes
.indexOf( mode
) !== -1;
8651 * Get symbolic action name.
8655 OO
.ui
.ActionWidget
.prototype.getAction = function () {
8660 * Get symbolic action name.
8664 OO
.ui
.ActionWidget
.prototype.getModes = function () {
8665 return this.modes
.slice();
8669 * Emit a resize event if the size has changed.
8673 OO
.ui
.ActionWidget
.prototype.propagateResize = function () {
8676 if ( this.isElementAttached() ) {
8677 width
= this.$element
.width();
8678 height
= this.$element
.height();
8680 if ( width
!== this.width
|| height
!== this.height
) {
8682 this.height
= height
;
8683 this.emit( 'resize' );
8693 OO
.ui
.ActionWidget
.prototype.setIcon = function () {
8695 OO
.ui
.IconElement
.prototype.setIcon
.apply( this, arguments
);
8696 this.propagateResize();
8704 OO
.ui
.ActionWidget
.prototype.setLabel = function () {
8706 OO
.ui
.LabelElement
.prototype.setLabel
.apply( this, arguments
);
8707 this.propagateResize();
8715 OO
.ui
.ActionWidget
.prototype.setFlags = function () {
8717 OO
.ui
.FlaggedElement
.prototype.setFlags
.apply( this, arguments
);
8718 this.propagateResize();
8726 OO
.ui
.ActionWidget
.prototype.clearFlags = function () {
8728 OO
.ui
.FlaggedElement
.prototype.clearFlags
.apply( this, arguments
);
8729 this.propagateResize();
8735 * Toggle visibility of button.
8737 * @param {boolean} [show] Show button, omit to toggle visibility
8740 OO
.ui
.ActionWidget
.prototype.toggle = function () {
8742 OO
.ui
.ActionWidget
.super.prototype.toggle
.apply( this, arguments
);
8743 this.propagateResize();
8749 * Button that shows and hides a popup.
8752 * @extends OO.ui.ButtonWidget
8753 * @mixins OO.ui.PopupElement
8756 * @param {Object} [config] Configuration options
8758 OO
.ui
.PopupButtonWidget
= function OoUiPopupButtonWidget( config
) {
8759 // Parent constructor
8760 OO
.ui
.PopupButtonWidget
.super.call( this, config
);
8762 // Mixin constructors
8763 OO
.ui
.PopupElement
.call( this, config
);
8767 .addClass( 'oo-ui-popupButtonWidget' )
8768 .append( this.popup
.$element
);
8773 OO
.inheritClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.ButtonWidget
);
8774 OO
.mixinClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.PopupElement
);
8779 * Handles mouse click events.
8781 * @param {jQuery.Event} e Mouse click event
8783 OO
.ui
.PopupButtonWidget
.prototype.onClick = function ( e
) {
8784 // Skip clicks within the popup
8785 if ( $.contains( this.popup
.$element
[0], e
.target
) ) {
8789 if ( !this.isDisabled() ) {
8790 this.popup
.toggle();
8792 OO
.ui
.PopupButtonWidget
.super.prototype.onClick
.call( this );
8798 * Button that toggles on and off.
8801 * @extends OO.ui.ButtonWidget
8802 * @mixins OO.ui.ToggleWidget
8805 * @param {Object} [config] Configuration options
8806 * @cfg {boolean} [value=false] Initial value
8808 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
8809 // Configuration initialization
8810 config
= config
|| {};
8812 // Parent constructor
8813 OO
.ui
.ToggleButtonWidget
.super.call( this, config
);
8815 // Mixin constructors
8816 OO
.ui
.ToggleWidget
.call( this, config
);
8819 this.$element
.addClass( 'oo-ui-toggleButtonWidget' );
8824 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ButtonWidget
);
8825 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
8832 OO
.ui
.ToggleButtonWidget
.prototype.onClick = function () {
8833 if ( !this.isDisabled() ) {
8834 this.setValue( !this.value
);
8838 return OO
.ui
.ToggleButtonWidget
.super.prototype.onClick
.call( this );
8844 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
8846 if ( value
!== this.value
) {
8847 this.setActive( value
);
8850 // Parent method (from mixin)
8851 OO
.ui
.ToggleWidget
.prototype.setValue
.call( this, value
);
8857 * Dropdown menu of options.
8859 * Dropdown menus provide a control for accessing a menu and compose a menu within the widget, which
8860 * can be accessed using the #getMenu method.
8862 * Use with OO.ui.MenuItemWidget.
8865 * @extends OO.ui.Widget
8866 * @mixins OO.ui.IconElement
8867 * @mixins OO.ui.IndicatorElement
8868 * @mixins OO.ui.LabelElement
8869 * @mixins OO.ui.TitledElement
8872 * @param {Object} [config] Configuration options
8873 * @cfg {Object} [menu] Configuration options to pass to menu widget
8875 OO
.ui
.DropdownWidget
= function OoUiDropdownWidget( config
) {
8876 // Configuration initialization
8877 config
= $.extend( { indicator
: 'down' }, config
);
8879 // Parent constructor
8880 OO
.ui
.DropdownWidget
.super.call( this, config
);
8882 // Mixin constructors
8883 OO
.ui
.IconElement
.call( this, config
);
8884 OO
.ui
.IndicatorElement
.call( this, config
);
8885 OO
.ui
.LabelElement
.call( this, config
);
8886 OO
.ui
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$label
} ) );
8889 this.menu
= new OO
.ui
.MenuWidget( $.extend( { $: this.$, widget
: this }, config
.menu
) );
8890 this.$handle
= this.$( '<span>' );
8893 this.$element
.on( { click
: this.onClick
.bind( this ) } );
8894 this.menu
.connect( this, { select
: 'onMenuSelect' } );
8898 .addClass( 'oo-ui-dropdownWidget-handle' )
8899 .append( this.$icon
, this.$label
, this.$indicator
);
8901 .addClass( 'oo-ui-dropdownWidget' )
8902 .append( this.$handle
, this.menu
.$element
);
8907 OO
.inheritClass( OO
.ui
.DropdownWidget
, OO
.ui
.Widget
);
8908 OO
.mixinClass( OO
.ui
.DropdownWidget
, OO
.ui
.IconElement
);
8909 OO
.mixinClass( OO
.ui
.DropdownWidget
, OO
.ui
.IndicatorElement
);
8910 OO
.mixinClass( OO
.ui
.DropdownWidget
, OO
.ui
.LabelElement
);
8911 OO
.mixinClass( OO
.ui
.DropdownWidget
, OO
.ui
.TitledElement
);
8918 * @return {OO.ui.MenuWidget} Menu of widget
8920 OO
.ui
.DropdownWidget
.prototype.getMenu = function () {
8925 * Handles menu select events.
8927 * @param {OO.ui.MenuItemWidget} item Selected menu item
8929 OO
.ui
.DropdownWidget
.prototype.onMenuSelect = function ( item
) {
8936 selectedLabel
= item
.getLabel();
8938 // If the label is a DOM element, clone it, because setLabel will append() it
8939 if ( selectedLabel
instanceof jQuery
) {
8940 selectedLabel
= selectedLabel
.clone();
8943 this.setLabel( selectedLabel
);
8947 * Handles mouse click events.
8949 * @param {jQuery.Event} e Mouse click event
8951 OO
.ui
.DropdownWidget
.prototype.onClick = function ( e
) {
8952 // Skip clicks within the menu
8953 if ( $.contains( this.menu
.$element
[0], e
.target
) ) {
8957 if ( !this.isDisabled() ) {
8958 if ( this.menu
.isVisible() ) {
8959 this.menu
.toggle( false );
8961 this.menu
.toggle( true );
8970 * See OO.ui.IconElement for more information.
8973 * @extends OO.ui.Widget
8974 * @mixins OO.ui.IconElement
8975 * @mixins OO.ui.TitledElement
8978 * @param {Object} [config] Configuration options
8980 OO
.ui
.IconWidget
= function OoUiIconWidget( config
) {
8981 // Configuration initialization
8982 config
= config
|| {};
8984 // Parent constructor
8985 OO
.ui
.IconWidget
.super.call( this, config
);
8987 // Mixin constructors
8988 OO
.ui
.IconElement
.call( this, $.extend( {}, config
, { $icon
: this.$element
} ) );
8989 OO
.ui
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$element
} ) );
8992 this.$element
.addClass( 'oo-ui-iconWidget' );
8997 OO
.inheritClass( OO
.ui
.IconWidget
, OO
.ui
.Widget
);
8998 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.IconElement
);
8999 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.TitledElement
);
9001 /* Static Properties */
9003 OO
.ui
.IconWidget
.static.tagName
= 'span';
9008 * See OO.ui.IndicatorElement for more information.
9011 * @extends OO.ui.Widget
9012 * @mixins OO.ui.IndicatorElement
9013 * @mixins OO.ui.TitledElement
9016 * @param {Object} [config] Configuration options
9018 OO
.ui
.IndicatorWidget
= function OoUiIndicatorWidget( config
) {
9019 // Configuration initialization
9020 config
= config
|| {};
9022 // Parent constructor
9023 OO
.ui
.IndicatorWidget
.super.call( this, config
);
9025 // Mixin constructors
9026 OO
.ui
.IndicatorElement
.call( this, $.extend( {}, config
, { $indicator
: this.$element
} ) );
9027 OO
.ui
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$element
} ) );
9030 this.$element
.addClass( 'oo-ui-indicatorWidget' );
9035 OO
.inheritClass( OO
.ui
.IndicatorWidget
, OO
.ui
.Widget
);
9036 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.IndicatorElement
);
9037 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.TitledElement
);
9039 /* Static Properties */
9041 OO
.ui
.IndicatorWidget
.static.tagName
= 'span';
9044 * Base class for input widgets.
9048 * @extends OO.ui.Widget
9049 * @mixins OO.ui.FlaggedElement
9052 * @param {Object} [config] Configuration options
9053 * @cfg {string} [name=''] HTML input name
9054 * @cfg {string} [value=''] Input value
9055 * @cfg {Function} [inputFilter] Filter function to apply to the input. Takes a string argument and returns a string.
9057 OO
.ui
.InputWidget
= function OoUiInputWidget( config
) {
9058 // Configuration initialization
9059 config
= config
|| {};
9061 // Parent constructor
9062 OO
.ui
.InputWidget
.super.call( this, config
);
9064 // Mixin constructors
9065 OO
.ui
.FlaggedElement
.call( this, config
);
9068 this.$input
= this.getInputElement( config
);
9070 this.inputFilter
= config
.inputFilter
;
9073 this.$input
.on( 'keydown mouseup cut paste change input select', this.onEdit
.bind( this ) );
9077 .attr( 'name', config
.name
)
9078 .prop( 'disabled', this.isDisabled() );
9079 this.$element
.addClass( 'oo-ui-inputWidget' ).append( this.$input
, $( '<span>' ) );
9080 this.setValue( config
.value
);
9085 OO
.inheritClass( OO
.ui
.InputWidget
, OO
.ui
.Widget
);
9086 OO
.mixinClass( OO
.ui
.InputWidget
, OO
.ui
.FlaggedElement
);
9092 * @param {string} value
9098 * Get input element.
9101 * @param {Object} [config] Configuration options
9102 * @return {jQuery} Input element
9104 OO
.ui
.InputWidget
.prototype.getInputElement = function () {
9105 return this.$( '<input>' );
9109 * Handle potentially value-changing events.
9111 * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
9113 OO
.ui
.InputWidget
.prototype.onEdit = function () {
9115 if ( !this.isDisabled() ) {
9116 // Allow the stack to clear so the value will be updated
9117 setTimeout( function () {
9118 widget
.setValue( widget
.$input
.val() );
9124 * Get the value of the input.
9126 * @return {string} Input value
9128 OO
.ui
.InputWidget
.prototype.getValue = function () {
9133 * Sets the direction of the current input, either RTL or LTR
9135 * @param {boolean} isRTL
9137 OO
.ui
.InputWidget
.prototype.setRTL = function ( isRTL
) {
9139 this.$input
.removeClass( 'oo-ui-ltr' );
9140 this.$input
.addClass( 'oo-ui-rtl' );
9142 this.$input
.removeClass( 'oo-ui-rtl' );
9143 this.$input
.addClass( 'oo-ui-ltr' );
9148 * Set the value of the input.
9150 * @param {string} value New value
9154 OO
.ui
.InputWidget
.prototype.setValue = function ( value
) {
9155 value
= this.sanitizeValue( value
);
9156 if ( this.value
!== value
) {
9158 this.emit( 'change', this.value
);
9160 // Update the DOM if it has changed. Note that with sanitizeValue, it
9161 // is possible for the DOM value to change without this.value changing.
9162 if ( this.$input
.val() !== this.value
) {
9163 this.$input
.val( this.value
);
9169 * Sanitize incoming value.
9171 * Ensures value is a string, and converts undefined and null to empty string.
9174 * @param {string} value Original value
9175 * @return {string} Sanitized value
9177 OO
.ui
.InputWidget
.prototype.sanitizeValue = function ( value
) {
9178 if ( value
=== undefined || value
=== null ) {
9180 } else if ( this.inputFilter
) {
9181 return this.inputFilter( String( value
) );
9183 return String( value
);
9188 * Simulate the behavior of clicking on a label bound to this input.
9190 OO
.ui
.InputWidget
.prototype.simulateLabelClick = function () {
9191 if ( !this.isDisabled() ) {
9192 if ( this.$input
.is( ':checkbox,:radio' ) ) {
9193 this.$input
.click();
9194 } else if ( this.$input
.is( ':input' ) ) {
9195 this.$input
[0].focus();
9203 OO
.ui
.InputWidget
.prototype.setDisabled = function ( state
) {
9204 OO
.ui
.InputWidget
.super.prototype.setDisabled
.call( this, state
);
9205 if ( this.$input
) {
9206 this.$input
.prop( 'disabled', this.isDisabled() );
9216 OO
.ui
.InputWidget
.prototype.focus = function () {
9217 this.$input
[0].focus();
9226 OO
.ui
.InputWidget
.prototype.blur = function () {
9227 this.$input
[0].blur();
9232 * A button that is an input widget. Intended to be used within a OO.ui.FormLayout.
9235 * @extends OO.ui.InputWidget
9236 * @mixins OO.ui.ButtonElement
9237 * @mixins OO.ui.IconElement
9238 * @mixins OO.ui.IndicatorElement
9239 * @mixins OO.ui.LabelElement
9240 * @mixins OO.ui.TitledElement
9241 * @mixins OO.ui.FlaggedElement
9244 * @param {Object} [config] Configuration options
9245 * @cfg {string} [type='button'] HTML tag `type` attribute, may be 'button', 'submit' or 'reset'
9246 * @cfg {boolean} [useInputTag=false] Whether to use `<input/>` rather than `<button/>`. Only useful
9247 * if you need IE 6 support in a form with multiple buttons. If you use this option, icons and
9248 * indicators will not be displayed, it won't be possible to have a non-plaintext label, and it
9249 * won't be possible to set a value (which will internally become identical to the label).
9251 OO
.ui
.ButtonInputWidget
= function OoUiButtonInputWidget( config
) {
9252 // Configuration initialization
9253 config
= $.extend( { type
: 'button', useInputTag
: false }, config
);
9255 // Properties (must be set before parent constructor, which calls #setValue)
9256 this.useInputTag
= config
.useInputTag
;
9258 // Parent constructor
9259 OO
.ui
.ButtonInputWidget
.super.call( this, config
);
9261 // Mixin constructors
9262 OO
.ui
.ButtonElement
.call( this, $.extend( {}, config
, { $button
: this.$input
} ) );
9263 OO
.ui
.IconElement
.call( this, config
);
9264 OO
.ui
.IndicatorElement
.call( this, config
);
9265 OO
.ui
.LabelElement
.call( this, config
);
9266 OO
.ui
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$input
} ) );
9267 OO
.ui
.FlaggedElement
.call( this, config
);
9271 click
: this.onClick
.bind( this ),
9272 keypress
: this.onKeyPress
.bind( this )
9276 if ( !config
.useInputTag
) {
9277 this.$input
.append( this.$icon
, this.$label
, this.$indicator
);
9279 this.$element
.addClass( 'oo-ui-buttonInputWidget' );
9284 OO
.inheritClass( OO
.ui
.ButtonInputWidget
, OO
.ui
.InputWidget
);
9285 OO
.mixinClass( OO
.ui
.ButtonInputWidget
, OO
.ui
.ButtonElement
);
9286 OO
.mixinClass( OO
.ui
.ButtonInputWidget
, OO
.ui
.IconElement
);
9287 OO
.mixinClass( OO
.ui
.ButtonInputWidget
, OO
.ui
.IndicatorElement
);
9288 OO
.mixinClass( OO
.ui
.ButtonInputWidget
, OO
.ui
.LabelElement
);
9289 OO
.mixinClass( OO
.ui
.ButtonInputWidget
, OO
.ui
.TitledElement
);
9290 OO
.mixinClass( OO
.ui
.ButtonInputWidget
, OO
.ui
.FlaggedElement
);
9301 * Get input element.
9304 * @param {Object} [config] Configuration options
9305 * @return {jQuery} Input element
9307 OO
.ui
.ButtonInputWidget
.prototype.getInputElement = function ( config
) {
9308 // Configuration intialization
9309 config
= config
|| {};
9311 var html
= '<' + ( config
.useInputTag
? 'input' : 'button' ) + ' type="' + config
.type
+ '">';
9313 return this.$( html
);
9319 * Overridden to support setting the 'value' of `<input/>` elements.
9321 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
9322 * text; or null for no label
9325 OO
.ui
.ButtonInputWidget
.prototype.setLabel = function ( label
) {
9326 OO
.ui
.LabelElement
.prototype.setLabel
.call( this, label
);
9328 if ( this.useInputTag
) {
9329 if ( typeof label
=== 'function' ) {
9330 label
= OO
.ui
.resolveMsg( label
);
9332 if ( label
instanceof jQuery
) {
9333 label
= label
.text();
9338 this.$input
.val( label
);
9345 * Set the value of the input.
9347 * Overridden to disable for `<input/>` elements, which have value identical to the label.
9349 * @param {string} value New value
9352 OO
.ui
.ButtonInputWidget
.prototype.setValue = function ( value
) {
9353 if ( !this.useInputTag
) {
9354 OO
.ui
.ButtonInputWidget
.super.prototype.setValue
.call( this, value
);
9360 * Handles mouse click events.
9362 * @param {jQuery.Event} e Mouse click event
9365 OO
.ui
.ButtonInputWidget
.prototype.onClick = function () {
9366 if ( !this.isDisabled() ) {
9367 this.emit( 'click' );
9373 * Handles keypress events.
9375 * @param {jQuery.Event} e Keypress event
9378 OO
.ui
.ButtonInputWidget
.prototype.onKeyPress = function ( e
) {
9379 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
9380 this.emit( 'click' );
9386 * Checkbox input widget.
9389 * @extends OO.ui.InputWidget
9392 * @param {Object} [config] Configuration options
9394 OO
.ui
.CheckboxInputWidget
= function OoUiCheckboxInputWidget( config
) {
9395 // Parent constructor
9396 OO
.ui
.CheckboxInputWidget
.super.call( this, config
);
9399 this.$element
.addClass( 'oo-ui-checkboxInputWidget' );
9404 OO
.inheritClass( OO
.ui
.CheckboxInputWidget
, OO
.ui
.InputWidget
);
9409 * Get input element.
9412 * @return {jQuery} Input element
9414 OO
.ui
.CheckboxInputWidget
.prototype.getInputElement = function () {
9415 return this.$( '<input type="checkbox" />' );
9419 * Get checked state of the checkbox
9421 * @return {boolean} If the checkbox is checked
9423 OO
.ui
.CheckboxInputWidget
.prototype.getValue = function () {
9428 * Set checked state of the checkbox
9430 * @param {boolean} value New value
9432 OO
.ui
.CheckboxInputWidget
.prototype.setValue = function ( value
) {
9434 if ( this.value
!== value
) {
9436 this.$input
.prop( 'checked', this.value
);
9437 this.emit( 'change', this.value
);
9444 OO
.ui
.CheckboxInputWidget
.prototype.onEdit = function () {
9446 if ( !this.isDisabled() ) {
9447 // Allow the stack to clear so the value will be updated
9448 setTimeout( function () {
9449 widget
.setValue( widget
.$input
.prop( 'checked' ) );
9455 * Input widget with a text field.
9458 * @extends OO.ui.InputWidget
9459 * @mixins OO.ui.IconElement
9460 * @mixins OO.ui.IndicatorElement
9461 * @mixins OO.ui.PendingElement
9464 * @param {Object} [config] Configuration options
9465 * @cfg {string} [type='text'] HTML tag `type` attribute
9466 * @cfg {string} [placeholder] Placeholder text
9467 * @cfg {boolean} [readOnly=false] Prevent changes
9468 * @cfg {boolean} [multiline=false] Allow multiple lines of text
9469 * @cfg {boolean} [autosize=false] Automatically resize to fit content
9470 * @cfg {boolean} [maxRows=10] Maximum number of rows to make visible when autosizing
9471 * @cfg {RegExp|string} [validate] Regular expression (or symbolic name referencing
9472 * one, see #static-validationPatterns)
9474 OO
.ui
.TextInputWidget
= function OoUiTextInputWidget( config
) {
9475 // Configuration initialization
9476 config
= $.extend( { readOnly
: false }, config
);
9478 // Parent constructor
9479 OO
.ui
.TextInputWidget
.super.call( this, config
);
9481 // Mixin constructors
9482 OO
.ui
.IconElement
.call( this, config
);
9483 OO
.ui
.IndicatorElement
.call( this, config
);
9484 OO
.ui
.PendingElement
.call( this, config
);
9487 this.readOnly
= false;
9488 this.multiline
= !!config
.multiline
;
9489 this.autosize
= !!config
.autosize
;
9490 this.maxRows
= config
.maxRows
!== undefined ? config
.maxRows
: 10;
9491 this.validate
= null;
9493 this.setValidation( config
.validate
);
9497 keypress
: this.onKeyPress
.bind( this ),
9498 blur
: this.setValidityFlag
.bind( this )
9500 this.$element
.on( 'DOMNodeInsertedIntoDocument', this.onElementAttach
.bind( this ) );
9501 this.$icon
.on( 'mousedown', this.onIconMouseDown
.bind( this ) );
9502 this.$indicator
.on( 'mousedown', this.onIndicatorMouseDown
.bind( this ) );
9506 .addClass( 'oo-ui-textInputWidget' )
9507 .append( this.$icon
, this.$indicator
);
9508 this.setReadOnly( config
.readOnly
);
9509 if ( config
.placeholder
) {
9510 this.$input
.attr( 'placeholder', config
.placeholder
);
9512 this.$element
.attr( 'role', 'textbox' );
9517 OO
.inheritClass( OO
.ui
.TextInputWidget
, OO
.ui
.InputWidget
);
9518 OO
.mixinClass( OO
.ui
.TextInputWidget
, OO
.ui
.IconElement
);
9519 OO
.mixinClass( OO
.ui
.TextInputWidget
, OO
.ui
.IndicatorElement
);
9520 OO
.mixinClass( OO
.ui
.TextInputWidget
, OO
.ui
.PendingElement
);
9522 /* Static properties */
9524 OO
.ui
.TextInputWidget
.static.validationPatterns
= {
9532 * User presses enter inside the text box.
9534 * Not called if input is multiline.
9540 * User clicks the icon.
9546 * User clicks the indicator.
9554 * Handle icon mouse down events.
9556 * @param {jQuery.Event} e Mouse down event
9559 OO
.ui
.TextInputWidget
.prototype.onIconMouseDown = function ( e
) {
9560 if ( e
.which
=== 1 ) {
9561 this.$input
[0].focus();
9562 this.emit( 'icon' );
9568 * Handle indicator mouse down events.
9570 * @param {jQuery.Event} e Mouse down event
9573 OO
.ui
.TextInputWidget
.prototype.onIndicatorMouseDown = function ( e
) {
9574 if ( e
.which
=== 1 ) {
9575 this.$input
[0].focus();
9576 this.emit( 'indicator' );
9582 * Handle key press events.
9584 * @param {jQuery.Event} e Key press event
9585 * @fires enter If enter key is pressed and input is not multiline
9587 OO
.ui
.TextInputWidget
.prototype.onKeyPress = function ( e
) {
9588 if ( e
.which
=== OO
.ui
.Keys
.ENTER
&& !this.multiline
) {
9589 this.emit( 'enter' );
9594 * Handle element attach events.
9596 * @param {jQuery.Event} e Element attach event
9598 OO
.ui
.TextInputWidget
.prototype.onElementAttach = function () {
9605 OO
.ui
.TextInputWidget
.prototype.onEdit = function () {
9609 return OO
.ui
.TextInputWidget
.super.prototype.onEdit
.call( this );
9615 OO
.ui
.TextInputWidget
.prototype.setValue = function ( value
) {
9617 OO
.ui
.TextInputWidget
.super.prototype.setValue
.call( this, value
);
9619 this.setValidityFlag();
9625 * Check if the widget is read-only.
9629 OO
.ui
.TextInputWidget
.prototype.isReadOnly = function () {
9630 return this.readOnly
;
9634 * Set the read-only state of the widget.
9636 * This should probably change the widgets's appearance and prevent it from being used.
9638 * @param {boolean} state Make input read-only
9641 OO
.ui
.TextInputWidget
.prototype.setReadOnly = function ( state
) {
9642 this.readOnly
= !!state
;
9643 this.$input
.prop( 'readOnly', this.readOnly
);
9648 * Automatically adjust the size of the text input.
9650 * This only affects multi-line inputs that are auto-sized.
9654 OO
.ui
.TextInputWidget
.prototype.adjustSize = function () {
9655 var $clone
, scrollHeight
, innerHeight
, outerHeight
, maxInnerHeight
, measurementError
, idealHeight
;
9657 if ( this.multiline
&& this.autosize
) {
9658 $clone
= this.$input
.clone()
9659 .val( this.$input
.val() )
9660 // Set inline height property to 0 to measure scroll height
9661 .css( { height
: 0 } )
9662 .insertAfter( this.$input
);
9663 scrollHeight
= $clone
[0].scrollHeight
;
9664 // Remove inline height property to measure natural heights
9665 $clone
.css( 'height', '' );
9666 innerHeight
= $clone
.innerHeight();
9667 outerHeight
= $clone
.outerHeight();
9668 // Measure max rows height
9669 $clone
.attr( 'rows', this.maxRows
).css( 'height', 'auto' ).val( '' );
9670 maxInnerHeight
= $clone
.innerHeight();
9671 // Difference between reported innerHeight and scrollHeight with no scrollbars present
9672 // Equals 1 on Blink-based browsers and 0 everywhere else
9673 measurementError
= maxInnerHeight
- $clone
[0].scrollHeight
;
9675 idealHeight
= Math
.min( maxInnerHeight
, scrollHeight
+ measurementError
);
9676 // Only apply inline height when expansion beyond natural height is needed
9677 if ( idealHeight
> innerHeight
) {
9678 // Use the difference between the inner and outer height as a buffer
9679 this.$input
.css( 'height', idealHeight
+ ( outerHeight
- innerHeight
) );
9681 this.$input
.css( 'height', '' );
9688 * Get input element.
9691 * @param {Object} [config] Configuration options
9692 * @return {jQuery} Input element
9694 OO
.ui
.TextInputWidget
.prototype.getInputElement = function ( config
) {
9695 // Configuration initialization
9696 config
= config
|| {};
9698 var type
= config
.type
|| 'text';
9700 return config
.multiline
? this.$( '<textarea>' ) : this.$( '<input type="' + type
+ '" />' );
9704 * Check if input supports multiple lines.
9708 OO
.ui
.TextInputWidget
.prototype.isMultiline = function () {
9709 return !!this.multiline
;
9713 * Check if input automatically adjusts its size.
9717 OO
.ui
.TextInputWidget
.prototype.isAutosizing = function () {
9718 return !!this.autosize
;
9722 * Select the contents of the input.
9726 OO
.ui
.TextInputWidget
.prototype.select = function () {
9727 this.$input
.select();
9732 * Sets the validation pattern to use.
9733 * @param {RegExp|string|null} validate Regular expression (or symbolic name referencing
9734 * one, see #static-validationPatterns)
9736 OO
.ui
.TextInputWidget
.prototype.setValidation = function ( validate
) {
9737 if ( validate
instanceof RegExp
) {
9738 this.validate
= validate
;
9740 this.validate
= this.constructor.static.validationPatterns
[validate
] || /.*/;
9745 * Sets the 'invalid' flag appropriately.
9747 OO
.ui
.TextInputWidget
.prototype.setValidityFlag = function () {
9749 this.isValid().done( function ( valid
) {
9750 widget
.setFlags( { invalid
: !valid
} );
9755 * Returns whether or not the current value is considered valid, according to the
9756 * supplied validation pattern.
9758 * @return {jQuery.Deferred}
9760 OO
.ui
.TextInputWidget
.prototype.isValid = function () {
9761 return $.Deferred().resolve( !!this.getValue().match( this.validate
) ).promise();
9765 * Text input with a menu of optional values.
9768 * @extends OO.ui.Widget
9771 * @param {Object} [config] Configuration options
9772 * @cfg {Object} [menu] Configuration options to pass to menu widget
9773 * @cfg {Object} [input] Configuration options to pass to input widget
9774 * @cfg {jQuery} [$overlay] Overlay layer; defaults to relative positioning
9776 OO
.ui
.ComboBoxWidget
= function OoUiComboBoxWidget( config
) {
9777 // Configuration initialization
9778 config
= config
|| {};
9780 // Parent constructor
9781 OO
.ui
.ComboBoxWidget
.super.call( this, config
);
9784 this.$overlay
= config
.$overlay
|| this.$element
;
9785 this.input
= new OO
.ui
.TextInputWidget( $.extend(
9786 { $: this.$, indicator
: 'down', disabled
: this.isDisabled() },
9789 this.menu
= new OO
.ui
.TextInputMenuWidget( this.input
, $.extend(
9791 $: OO
.ui
.Element
.getJQuery( this.$overlay
),
9794 disabled
: this.isDisabled()
9800 this.input
.connect( this, {
9801 change
: 'onInputChange',
9802 indicator
: 'onInputIndicator',
9803 enter
: 'onInputEnter'
9805 this.menu
.connect( this, {
9806 choose
: 'onMenuChoose',
9807 add
: 'onMenuItemsChange',
9808 remove
: 'onMenuItemsChange'
9812 this.$element
.addClass( 'oo-ui-comboBoxWidget' ).append( this.input
.$element
);
9813 this.$overlay
.append( this.menu
.$element
);
9814 this.onMenuItemsChange();
9819 OO
.inheritClass( OO
.ui
.ComboBoxWidget
, OO
.ui
.Widget
);
9824 * Handle input change events.
9826 * @param {string} value New value
9828 OO
.ui
.ComboBoxWidget
.prototype.onInputChange = function ( value
) {
9829 var match
= this.menu
.getItemFromData( value
);
9831 this.menu
.selectItem( match
);
9833 if ( !this.isDisabled() ) {
9834 this.menu
.toggle( true );
9839 * Handle input indicator events.
9841 OO
.ui
.ComboBoxWidget
.prototype.onInputIndicator = function () {
9842 if ( !this.isDisabled() ) {
9848 * Handle input enter events.
9850 OO
.ui
.ComboBoxWidget
.prototype.onInputEnter = function () {
9851 if ( !this.isDisabled() ) {
9852 this.menu
.toggle( false );
9857 * Handle menu choose events.
9859 * @param {OO.ui.OptionWidget} item Chosen item
9861 OO
.ui
.ComboBoxWidget
.prototype.onMenuChoose = function ( item
) {
9863 this.input
.setValue( item
.getData() );
9868 * Handle menu item change events.
9870 OO
.ui
.ComboBoxWidget
.prototype.onMenuItemsChange = function () {
9871 var match
= this.menu
.getItemFromData( this.input
.getValue() );
9872 this.menu
.selectItem( match
);
9873 this.$element
.toggleClass( 'oo-ui-comboBoxWidget-empty', this.menu
.isEmpty() );
9879 OO
.ui
.ComboBoxWidget
.prototype.setDisabled = function ( disabled
) {
9881 OO
.ui
.ComboBoxWidget
.super.prototype.setDisabled
.call( this, disabled
);
9884 this.input
.setDisabled( this.isDisabled() );
9887 this.menu
.setDisabled( this.isDisabled() );
9897 * @extends OO.ui.Widget
9898 * @mixins OO.ui.LabelElement
9901 * @param {Object} [config] Configuration options
9903 OO
.ui
.LabelWidget
= function OoUiLabelWidget( config
) {
9904 // Configuration initialization
9905 config
= config
|| {};
9907 // Parent constructor
9908 OO
.ui
.LabelWidget
.super.call( this, config
);
9910 // Mixin constructors
9911 OO
.ui
.LabelElement
.call( this, $.extend( {}, config
, { $label
: this.$element
} ) );
9912 OO
.ui
.TitledElement
.call( this, config
);
9915 this.input
= config
.input
;
9918 if ( this.input
instanceof OO
.ui
.InputWidget
) {
9919 this.$element
.on( 'click', this.onClick
.bind( this ) );
9923 this.$element
.addClass( 'oo-ui-labelWidget' );
9928 OO
.inheritClass( OO
.ui
.LabelWidget
, OO
.ui
.Widget
);
9929 OO
.mixinClass( OO
.ui
.LabelWidget
, OO
.ui
.LabelElement
);
9930 OO
.mixinClass( OO
.ui
.LabelWidget
, OO
.ui
.TitledElement
);
9932 /* Static Properties */
9934 OO
.ui
.LabelWidget
.static.tagName
= 'span';
9939 * Handles label mouse click events.
9941 * @param {jQuery.Event} e Mouse click event
9943 OO
.ui
.LabelWidget
.prototype.onClick = function () {
9944 this.input
.simulateLabelClick();
9949 * Generic option widget for use with OO.ui.SelectWidget.
9952 * @extends OO.ui.Widget
9953 * @mixins OO.ui.LabelElement
9954 * @mixins OO.ui.FlaggedElement
9957 * @param {Mixed} data Option data
9958 * @param {Object} [config] Configuration options
9960 OO
.ui
.OptionWidget
= function OoUiOptionWidget( data
, config
) {
9961 // Configuration initialization
9962 config
= config
|| {};
9964 // Parent constructor
9965 OO
.ui
.OptionWidget
.super.call( this, config
);
9967 // Mixin constructors
9968 OO
.ui
.ItemWidget
.call( this );
9969 OO
.ui
.LabelElement
.call( this, config
);
9970 OO
.ui
.FlaggedElement
.call( this, config
);
9974 this.selected
= false;
9975 this.highlighted
= false;
9976 this.pressed
= false;
9980 .data( 'oo-ui-optionWidget', this )
9981 .attr( 'role', 'option' )
9982 .addClass( 'oo-ui-optionWidget' )
9983 .append( this.$label
);
9988 OO
.inheritClass( OO
.ui
.OptionWidget
, OO
.ui
.Widget
);
9989 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.ItemWidget
);
9990 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.LabelElement
);
9991 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.FlaggedElement
);
9993 /* Static Properties */
9995 OO
.ui
.OptionWidget
.static.selectable
= true;
9997 OO
.ui
.OptionWidget
.static.highlightable
= true;
9999 OO
.ui
.OptionWidget
.static.pressable
= true;
10001 OO
.ui
.OptionWidget
.static.scrollIntoViewOnSelect
= false;
10006 * Check if option can be selected.
10008 * @return {boolean} Item is selectable
10010 OO
.ui
.OptionWidget
.prototype.isSelectable = function () {
10011 return this.constructor.static.selectable
&& !this.isDisabled();
10015 * Check if option can be highlighted.
10017 * @return {boolean} Item is highlightable
10019 OO
.ui
.OptionWidget
.prototype.isHighlightable = function () {
10020 return this.constructor.static.highlightable
&& !this.isDisabled();
10024 * Check if option can be pressed.
10026 * @return {boolean} Item is pressable
10028 OO
.ui
.OptionWidget
.prototype.isPressable = function () {
10029 return this.constructor.static.pressable
&& !this.isDisabled();
10033 * Check if option is selected.
10035 * @return {boolean} Item is selected
10037 OO
.ui
.OptionWidget
.prototype.isSelected = function () {
10038 return this.selected
;
10042 * Check if option is highlighted.
10044 * @return {boolean} Item is highlighted
10046 OO
.ui
.OptionWidget
.prototype.isHighlighted = function () {
10047 return this.highlighted
;
10051 * Check if option is pressed.
10053 * @return {boolean} Item is pressed
10055 OO
.ui
.OptionWidget
.prototype.isPressed = function () {
10056 return this.pressed
;
10060 * Set selected state.
10062 * @param {boolean} [state=false] Select option
10065 OO
.ui
.OptionWidget
.prototype.setSelected = function ( state
) {
10066 if ( this.constructor.static.selectable
) {
10067 this.selected
= !!state
;
10068 this.$element
.toggleClass( 'oo-ui-optionWidget-selected', state
);
10069 if ( state
&& this.constructor.static.scrollIntoViewOnSelect
) {
10070 this.scrollElementIntoView();
10072 this.updateThemeClasses();
10078 * Set highlighted state.
10080 * @param {boolean} [state=false] Highlight option
10083 OO
.ui
.OptionWidget
.prototype.setHighlighted = function ( state
) {
10084 if ( this.constructor.static.highlightable
) {
10085 this.highlighted
= !!state
;
10086 this.$element
.toggleClass( 'oo-ui-optionWidget-highlighted', state
);
10087 this.updateThemeClasses();
10093 * Set pressed state.
10095 * @param {boolean} [state=false] Press option
10098 OO
.ui
.OptionWidget
.prototype.setPressed = function ( state
) {
10099 if ( this.constructor.static.pressable
) {
10100 this.pressed
= !!state
;
10101 this.$element
.toggleClass( 'oo-ui-optionWidget-pressed', state
);
10102 this.updateThemeClasses();
10108 * Make the option's highlight flash.
10110 * While flashing, the visual style of the pressed state is removed if present.
10112 * @return {jQuery.Promise} Promise resolved when flashing is done
10114 OO
.ui
.OptionWidget
.prototype.flash = function () {
10116 $element
= this.$element
,
10117 deferred
= $.Deferred();
10119 if ( !this.isDisabled() && this.constructor.static.pressable
) {
10120 $element
.removeClass( 'oo-ui-optionWidget-highlighted oo-ui-optionWidget-pressed' );
10121 setTimeout( function () {
10122 // Restore original classes
10124 .toggleClass( 'oo-ui-optionWidget-highlighted', widget
.highlighted
)
10125 .toggleClass( 'oo-ui-optionWidget-pressed', widget
.pressed
);
10127 setTimeout( function () {
10128 deferred
.resolve();
10134 return deferred
.promise();
10140 * @return {Mixed} Option data
10142 OO
.ui
.OptionWidget
.prototype.getData = function () {
10147 * Option widget with an option icon and indicator.
10149 * Use together with OO.ui.SelectWidget.
10152 * @extends OO.ui.OptionWidget
10153 * @mixins OO.ui.IconElement
10154 * @mixins OO.ui.IndicatorElement
10157 * @param {Mixed} data Option data
10158 * @param {Object} [config] Configuration options
10160 OO
.ui
.DecoratedOptionWidget
= function OoUiDecoratedOptionWidget( data
, config
) {
10161 // Parent constructor
10162 OO
.ui
.DecoratedOptionWidget
.super.call( this, data
, config
);
10164 // Mixin constructors
10165 OO
.ui
.IconElement
.call( this, config
);
10166 OO
.ui
.IndicatorElement
.call( this, config
);
10170 .addClass( 'oo-ui-decoratedOptionWidget' )
10171 .prepend( this.$icon
)
10172 .append( this.$indicator
);
10177 OO
.inheritClass( OO
.ui
.DecoratedOptionWidget
, OO
.ui
.OptionWidget
);
10178 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IconElement
);
10179 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IndicatorElement
);
10182 * Option widget that looks like a button.
10184 * Use together with OO.ui.ButtonSelectWidget.
10187 * @extends OO.ui.DecoratedOptionWidget
10188 * @mixins OO.ui.ButtonElement
10191 * @param {Mixed} data Option data
10192 * @param {Object} [config] Configuration options
10194 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( data
, config
) {
10195 // Parent constructor
10196 OO
.ui
.ButtonOptionWidget
.super.call( this, data
, config
);
10198 // Mixin constructors
10199 OO
.ui
.ButtonElement
.call( this, config
);
10202 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
10203 this.$button
.append( this.$element
.contents() );
10204 this.$element
.append( this.$button
);
10209 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
10210 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.ButtonElement
);
10212 /* Static Properties */
10214 // Allow button mouse down events to pass through so they can be handled by the parent select widget
10215 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
10222 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
10223 OO
.ui
.ButtonOptionWidget
.super.prototype.setSelected
.call( this, state
);
10225 if ( this.constructor.static.selectable
) {
10226 this.setActive( state
);
10233 * Item of an OO.ui.MenuWidget.
10236 * @extends OO.ui.DecoratedOptionWidget
10239 * @param {Mixed} data Item data
10240 * @param {Object} [config] Configuration options
10242 OO
.ui
.MenuItemWidget
= function OoUiMenuItemWidget( data
, config
) {
10243 // Configuration initialization
10244 config
= $.extend( { icon
: 'check' }, config
);
10246 // Parent constructor
10247 OO
.ui
.MenuItemWidget
.super.call( this, data
, config
);
10251 .attr( 'role', 'menuitem' )
10252 .addClass( 'oo-ui-menuItemWidget' );
10257 OO
.inheritClass( OO
.ui
.MenuItemWidget
, OO
.ui
.DecoratedOptionWidget
);
10260 * Section to group one or more items in a OO.ui.MenuWidget.
10263 * @extends OO.ui.DecoratedOptionWidget
10266 * @param {Mixed} data Item data
10267 * @param {Object} [config] Configuration options
10269 OO
.ui
.MenuSectionItemWidget
= function OoUiMenuSectionItemWidget( data
, config
) {
10270 // Parent constructor
10271 OO
.ui
.MenuSectionItemWidget
.super.call( this, data
, config
);
10274 this.$element
.addClass( 'oo-ui-menuSectionItemWidget' );
10279 OO
.inheritClass( OO
.ui
.MenuSectionItemWidget
, OO
.ui
.DecoratedOptionWidget
);
10281 /* Static Properties */
10283 OO
.ui
.MenuSectionItemWidget
.static.selectable
= false;
10285 OO
.ui
.MenuSectionItemWidget
.static.highlightable
= false;
10288 * Items for an OO.ui.OutlineWidget.
10291 * @extends OO.ui.DecoratedOptionWidget
10294 * @param {Mixed} data Item data
10295 * @param {Object} [config] Configuration options
10296 * @cfg {number} [level] Indentation level
10297 * @cfg {boolean} [movable] Allow modification from outline controls
10299 OO
.ui
.OutlineItemWidget
= function OoUiOutlineItemWidget( data
, config
) {
10300 // Configuration initialization
10301 config
= config
|| {};
10303 // Parent constructor
10304 OO
.ui
.OutlineItemWidget
.super.call( this, data
, config
);
10308 this.movable
= !!config
.movable
;
10309 this.removable
= !!config
.removable
;
10312 this.$element
.addClass( 'oo-ui-outlineItemWidget' );
10313 this.setLevel( config
.level
);
10318 OO
.inheritClass( OO
.ui
.OutlineItemWidget
, OO
.ui
.DecoratedOptionWidget
);
10320 /* Static Properties */
10322 OO
.ui
.OutlineItemWidget
.static.highlightable
= false;
10324 OO
.ui
.OutlineItemWidget
.static.scrollIntoViewOnSelect
= true;
10326 OO
.ui
.OutlineItemWidget
.static.levelClass
= 'oo-ui-outlineItemWidget-level-';
10328 OO
.ui
.OutlineItemWidget
.static.levels
= 3;
10333 * Check if item is movable.
10335 * Movablilty is used by outline controls.
10337 * @return {boolean} Item is movable
10339 OO
.ui
.OutlineItemWidget
.prototype.isMovable = function () {
10340 return this.movable
;
10344 * Check if item is removable.
10346 * Removablilty is used by outline controls.
10348 * @return {boolean} Item is removable
10350 OO
.ui
.OutlineItemWidget
.prototype.isRemovable = function () {
10351 return this.removable
;
10355 * Get indentation level.
10357 * @return {number} Indentation level
10359 OO
.ui
.OutlineItemWidget
.prototype.getLevel = function () {
10366 * Movablilty is used by outline controls.
10368 * @param {boolean} movable Item is movable
10371 OO
.ui
.OutlineItemWidget
.prototype.setMovable = function ( movable
) {
10372 this.movable
= !!movable
;
10373 this.updateThemeClasses();
10378 * Set removability.
10380 * Removablilty is used by outline controls.
10382 * @param {boolean} movable Item is removable
10385 OO
.ui
.OutlineItemWidget
.prototype.setRemovable = function ( removable
) {
10386 this.removable
= !!removable
;
10387 this.updateThemeClasses();
10392 * Set indentation level.
10394 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
10397 OO
.ui
.OutlineItemWidget
.prototype.setLevel = function ( level
) {
10398 var levels
= this.constructor.static.levels
,
10399 levelClass
= this.constructor.static.levelClass
,
10402 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
10404 if ( this.level
=== i
) {
10405 this.$element
.addClass( levelClass
+ i
);
10407 this.$element
.removeClass( levelClass
+ i
);
10410 this.updateThemeClasses();
10416 * Container for content that is overlaid and positioned absolutely.
10419 * @extends OO.ui.Widget
10420 * @mixins OO.ui.LabelElement
10423 * @param {Object} [config] Configuration options
10424 * @cfg {number} [width=320] Width of popup in pixels
10425 * @cfg {number} [height] Height of popup, omit to use automatic height
10426 * @cfg {boolean} [anchor=true] Show anchor pointing to origin of popup
10427 * @cfg {string} [align='center'] Alignment of popup to origin
10428 * @cfg {jQuery} [$container] Container to prevent popup from rendering outside of
10429 * @cfg {number} [containerPadding=10] How much padding to keep between popup and container
10430 * @cfg {jQuery} [$content] Content to append to the popup's body
10431 * @cfg {boolean} [autoClose=false] Popup auto-closes when it loses focus
10432 * @cfg {jQuery} [$autoCloseIgnore] Elements to not auto close when clicked
10433 * @cfg {boolean} [head] Show label and close button at the top
10434 * @cfg {boolean} [padded] Add padding to the body
10436 OO
.ui
.PopupWidget
= function OoUiPopupWidget( config
) {
10437 // Configuration initialization
10438 config
= config
|| {};
10440 // Parent constructor
10441 OO
.ui
.PopupWidget
.super.call( this, config
);
10443 // Mixin constructors
10444 OO
.ui
.LabelElement
.call( this, config
);
10445 OO
.ui
.ClippableElement
.call( this, config
);
10448 this.visible
= false;
10449 this.$popup
= this.$( '<div>' );
10450 this.$head
= this.$( '<div>' );
10451 this.$body
= this.$( '<div>' );
10452 this.$anchor
= this.$( '<div>' );
10453 // If undefined, will be computed lazily in updateDimensions()
10454 this.$container
= config
.$container
;
10455 this.containerPadding
= config
.containerPadding
!== undefined ? config
.containerPadding
: 10;
10456 this.autoClose
= !!config
.autoClose
;
10457 this.$autoCloseIgnore
= config
.$autoCloseIgnore
;
10458 this.transitionTimeout
= null;
10459 this.anchor
= null;
10460 this.width
= config
.width
!== undefined ? config
.width
: 320;
10461 this.height
= config
.height
!== undefined ? config
.height
: null;
10462 this.align
= config
.align
|| 'center';
10463 this.closeButton
= new OO
.ui
.ButtonWidget( { $: this.$, framed
: false, icon
: 'close' } );
10464 this.onMouseDownHandler
= this.onMouseDown
.bind( this );
10467 this.closeButton
.connect( this, { click
: 'onCloseButtonClick' } );
10470 this.toggleAnchor( config
.anchor
=== undefined || config
.anchor
);
10471 this.$body
.addClass( 'oo-ui-popupWidget-body' );
10472 this.$anchor
.addClass( 'oo-ui-popupWidget-anchor' );
10474 .addClass( 'oo-ui-popupWidget-head' )
10475 .append( this.$label
, this.closeButton
.$element
);
10476 if ( !config
.head
) {
10480 .addClass( 'oo-ui-popupWidget-popup' )
10481 .append( this.$head
, this.$body
);
10484 .addClass( 'oo-ui-popupWidget' )
10485 .append( this.$popup
, this.$anchor
);
10486 // Move content, which was added to #$element by OO.ui.Widget, to the body
10487 if ( config
.$content
instanceof jQuery
) {
10488 this.$body
.append( config
.$content
);
10490 if ( config
.padded
) {
10491 this.$body
.addClass( 'oo-ui-popupWidget-body-padded' );
10493 this.setClippableElement( this.$body
);
10498 OO
.inheritClass( OO
.ui
.PopupWidget
, OO
.ui
.Widget
);
10499 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.LabelElement
);
10500 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.ClippableElement
);
10505 * Handles mouse down events.
10507 * @param {jQuery.Event} e Mouse down event
10509 OO
.ui
.PopupWidget
.prototype.onMouseDown = function ( e
) {
10511 this.isVisible() &&
10512 !$.contains( this.$element
[0], e
.target
) &&
10513 ( !this.$autoCloseIgnore
|| !this.$autoCloseIgnore
.has( e
.target
).length
)
10515 this.toggle( false );
10520 * Bind mouse down listener.
10522 OO
.ui
.PopupWidget
.prototype.bindMouseDownListener = function () {
10523 // Capture clicks outside popup
10524 this.getElementWindow().addEventListener( 'mousedown', this.onMouseDownHandler
, true );
10528 * Handles close button click events.
10530 OO
.ui
.PopupWidget
.prototype.onCloseButtonClick = function () {
10531 if ( this.isVisible() ) {
10532 this.toggle( false );
10537 * Unbind mouse down listener.
10539 OO
.ui
.PopupWidget
.prototype.unbindMouseDownListener = function () {
10540 this.getElementWindow().removeEventListener( 'mousedown', this.onMouseDownHandler
, true );
10544 * Set whether to show a anchor.
10546 * @param {boolean} [show] Show anchor, omit to toggle
10548 OO
.ui
.PopupWidget
.prototype.toggleAnchor = function ( show
) {
10549 show
= show
=== undefined ? !this.anchored
: !!show
;
10551 if ( this.anchored
!== show
) {
10553 this.$element
.addClass( 'oo-ui-popupWidget-anchored' );
10555 this.$element
.removeClass( 'oo-ui-popupWidget-anchored' );
10557 this.anchored
= show
;
10562 * Check if showing a anchor.
10564 * @return {boolean} anchor is visible
10566 OO
.ui
.PopupWidget
.prototype.hasAnchor = function () {
10567 return this.anchor
;
10573 OO
.ui
.PopupWidget
.prototype.toggle = function ( show
) {
10574 show
= show
=== undefined ? !this.isVisible() : !!show
;
10576 var change
= show
!== this.isVisible();
10579 OO
.ui
.PopupWidget
.super.prototype.toggle
.call( this, show
);
10583 if ( this.autoClose
) {
10584 this.bindMouseDownListener();
10586 this.updateDimensions();
10587 this.toggleClipping( true );
10589 this.toggleClipping( false );
10590 if ( this.autoClose
) {
10591 this.unbindMouseDownListener();
10600 * Set the size of the popup.
10602 * Changing the size may also change the popup's position depending on the alignment.
10604 * @param {number} width Width
10605 * @param {number} height Height
10606 * @param {boolean} [transition=false] Use a smooth transition
10609 OO
.ui
.PopupWidget
.prototype.setSize = function ( width
, height
, transition
) {
10610 this.width
= width
;
10611 this.height
= height
!== undefined ? height
: null;
10612 if ( this.isVisible() ) {
10613 this.updateDimensions( transition
);
10618 * Update the size and position.
10620 * Only use this to keep the popup properly anchored. Use #setSize to change the size, and this will
10621 * be called automatically.
10623 * @param {boolean} [transition=false] Use a smooth transition
10626 OO
.ui
.PopupWidget
.prototype.updateDimensions = function ( transition
) {
10627 var popupOffset
, originOffset
, containerLeft
, containerWidth
, containerRight
,
10628 popupLeft
, popupRight
, overlapLeft
, overlapRight
, anchorWidth
,
10631 if ( !this.$container
) {
10632 // Lazy-initialize $container if not specified in constructor
10633 this.$container
= this.$( this.getClosestScrollableElementContainer() );
10636 // Set height and width before measuring things, since it might cause our measurements
10637 // to change (e.g. due to scrollbars appearing or disappearing)
10640 height
: this.height
!== null ? this.height
: 'auto'
10643 // Compute initial popupOffset based on alignment
10644 popupOffset
= this.width
* ( { left
: 0, center
: -0.5, right
: -1 } )[this.align
];
10646 // Figure out if this will cause the popup to go beyond the edge of the container
10647 originOffset
= Math
.round( this.$element
.offset().left
);
10648 containerLeft
= Math
.round( this.$container
.offset().left
);
10649 containerWidth
= this.$container
.innerWidth();
10650 containerRight
= containerLeft
+ containerWidth
;
10651 popupLeft
= popupOffset
- this.containerPadding
;
10652 popupRight
= popupOffset
+ this.containerPadding
+ this.width
+ this.containerPadding
;
10653 overlapLeft
= ( originOffset
+ popupLeft
) - containerLeft
;
10654 overlapRight
= containerRight
- ( originOffset
+ popupRight
);
10656 // Adjust offset to make the popup not go beyond the edge, if needed
10657 if ( overlapRight
< 0 ) {
10658 popupOffset
+= overlapRight
;
10659 } else if ( overlapLeft
< 0 ) {
10660 popupOffset
-= overlapLeft
;
10663 // Adjust offset to avoid anchor being rendered too close to the edge
10664 // $anchor.width() doesn't work with the pure CSS anchor (returns 0)
10665 // TODO: Find a measurement that works for CSS anchors and image anchors
10666 anchorWidth
= this.$anchor
[0].scrollWidth
* 2;
10667 if ( popupOffset
+ this.width
< anchorWidth
) {
10668 popupOffset
= anchorWidth
- this.width
;
10669 } else if ( -popupOffset
< anchorWidth
) {
10670 popupOffset
= -anchorWidth
;
10673 // Prevent transition from being interrupted
10674 clearTimeout( this.transitionTimeout
);
10675 if ( transition
) {
10676 // Enable transition
10677 this.$element
.addClass( 'oo-ui-popupWidget-transitioning' );
10680 // Position body relative to anchor
10681 this.$popup
.css( 'margin-left', popupOffset
);
10683 if ( transition
) {
10684 // Prevent transitioning after transition is complete
10685 this.transitionTimeout
= setTimeout( function () {
10686 widget
.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
10689 // Prevent transitioning immediately
10690 this.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
10693 // Reevaluate clipping state since we've relocated and resized the popup
10700 * Progress bar widget.
10703 * @extends OO.ui.Widget
10706 * @param {Object} [config] Configuration options
10707 * @cfg {number|boolean} [progress=false] Initial progress percent or false for indeterminate
10709 OO
.ui
.ProgressBarWidget
= function OoUiProgressBarWidget( config
) {
10710 // Configuration initialization
10711 config
= config
|| {};
10713 // Parent constructor
10714 OO
.ui
.ProgressBarWidget
.super.call( this, config
);
10717 this.$bar
= this.$( '<div>' );
10718 this.progress
= null;
10721 this.setProgress( config
.progress
!== undefined ? config
.progress
: false );
10722 this.$bar
.addClass( 'oo-ui-progressBarWidget-bar');
10725 role
: 'progressbar',
10726 'aria-valuemin': 0,
10727 'aria-valuemax': 100
10729 .addClass( 'oo-ui-progressBarWidget' )
10730 .append( this.$bar
);
10735 OO
.inheritClass( OO
.ui
.ProgressBarWidget
, OO
.ui
.Widget
);
10737 /* Static Properties */
10739 OO
.ui
.ProgressBarWidget
.static.tagName
= 'div';
10744 * Get progress percent
10746 * @return {number} Progress percent
10748 OO
.ui
.ProgressBarWidget
.prototype.getProgress = function () {
10749 return this.progress
;
10753 * Set progress percent
10755 * @param {number|boolean} progress Progress percent or false for indeterminate
10757 OO
.ui
.ProgressBarWidget
.prototype.setProgress = function ( progress
) {
10758 this.progress
= progress
;
10760 if ( progress
!== false ) {
10761 this.$bar
.css( 'width', this.progress
+ '%' );
10762 this.$element
.attr( 'aria-valuenow', this.progress
);
10764 this.$bar
.css( 'width', '' );
10765 this.$element
.removeAttr( 'aria-valuenow' );
10767 this.$element
.toggleClass( 'oo-ui-progressBarWidget-indeterminate', !progress
);
10773 * Search widgets combine a query input, placed above, and a results selection widget, placed below.
10774 * Results are cleared and populated each time the query is changed.
10777 * @extends OO.ui.Widget
10780 * @param {Object} [config] Configuration options
10781 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
10782 * @cfg {string} [value] Initial query value
10784 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
10785 // Configuration intialization
10786 config
= config
|| {};
10788 // Parent constructor
10789 OO
.ui
.SearchWidget
.super.call( this, config
);
10792 this.query
= new OO
.ui
.TextInputWidget( {
10795 placeholder
: config
.placeholder
,
10796 value
: config
.value
10798 this.results
= new OO
.ui
.SelectWidget( { $: this.$ } );
10799 this.$query
= this.$( '<div>' );
10800 this.$results
= this.$( '<div>' );
10803 this.query
.connect( this, {
10804 change
: 'onQueryChange',
10805 enter
: 'onQueryEnter'
10807 this.results
.connect( this, {
10808 highlight
: 'onResultsHighlight',
10809 select
: 'onResultsSelect'
10811 this.query
.$input
.on( 'keydown', this.onQueryKeydown
.bind( this ) );
10815 .addClass( 'oo-ui-searchWidget-query' )
10816 .append( this.query
.$element
);
10818 .addClass( 'oo-ui-searchWidget-results' )
10819 .append( this.results
.$element
);
10821 .addClass( 'oo-ui-searchWidget' )
10822 .append( this.$results
, this.$query
);
10827 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
10833 * @param {Object|null} item Item data or null if no item is highlighted
10838 * @param {Object|null} item Item data or null if no item is selected
10844 * Handle query key down events.
10846 * @param {jQuery.Event} e Key down event
10848 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
10849 var highlightedItem
, nextItem
,
10850 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
10853 highlightedItem
= this.results
.getHighlightedItem();
10854 if ( !highlightedItem
) {
10855 highlightedItem
= this.results
.getSelectedItem();
10857 nextItem
= this.results
.getRelativeSelectableItem( highlightedItem
, dir
);
10858 this.results
.highlightItem( nextItem
);
10859 nextItem
.scrollElementIntoView();
10864 * Handle select widget select events.
10866 * Clears existing results. Subclasses should repopulate items according to new query.
10868 * @param {string} value New value
10870 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
10872 this.results
.clearItems();
10876 * Handle select widget enter key events.
10878 * Selects highlighted item.
10880 * @param {string} value New value
10882 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
10884 this.results
.selectItem( this.results
.getHighlightedItem() );
10888 * Handle select widget highlight events.
10890 * @param {OO.ui.OptionWidget} item Highlighted item
10893 OO
.ui
.SearchWidget
.prototype.onResultsHighlight = function ( item
) {
10894 this.emit( 'highlight', item
? item
.getData() : null );
10898 * Handle select widget select events.
10900 * @param {OO.ui.OptionWidget} item Selected item
10903 OO
.ui
.SearchWidget
.prototype.onResultsSelect = function ( item
) {
10904 this.emit( 'select', item
? item
.getData() : null );
10908 * Get the query input.
10910 * @return {OO.ui.TextInputWidget} Query input
10912 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
10917 * Get the results list.
10919 * @return {OO.ui.SelectWidget} Select list
10921 OO
.ui
.SearchWidget
.prototype.getResults = function () {
10922 return this.results
;
10926 * Generic selection of options.
10928 * Items can contain any rendering, and are uniquely identified by a hash of their data. Any widget
10929 * that provides options, from which the user must choose one, should be built on this class.
10931 * Use together with OO.ui.OptionWidget.
10934 * @extends OO.ui.Widget
10935 * @mixins OO.ui.GroupElement
10938 * @param {Object} [config] Configuration options
10939 * @cfg {OO.ui.OptionWidget[]} [items] Options to add
10941 OO
.ui
.SelectWidget
= function OoUiSelectWidget( config
) {
10942 // Configuration initialization
10943 config
= config
|| {};
10945 // Parent constructor
10946 OO
.ui
.SelectWidget
.super.call( this, config
);
10948 // Mixin constructors
10949 OO
.ui
.GroupWidget
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
10952 this.pressed
= false;
10953 this.selecting
= null;
10955 this.onMouseUpHandler
= this.onMouseUp
.bind( this );
10956 this.onMouseMoveHandler
= this.onMouseMove
.bind( this );
10959 this.$element
.on( {
10960 mousedown
: this.onMouseDown
.bind( this ),
10961 mouseover
: this.onMouseOver
.bind( this ),
10962 mouseleave
: this.onMouseLeave
.bind( this )
10966 this.$element
.addClass( 'oo-ui-selectWidget oo-ui-selectWidget-depressed' );
10967 if ( $.isArray( config
.items
) ) {
10968 this.addItems( config
.items
);
10974 OO
.inheritClass( OO
.ui
.SelectWidget
, OO
.ui
.Widget
);
10976 // Need to mixin base class as well
10977 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupElement
);
10978 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupWidget
);
10984 * @param {OO.ui.OptionWidget|null} item Highlighted item
10989 * @param {OO.ui.OptionWidget|null} item Pressed item
10994 * @param {OO.ui.OptionWidget|null} item Selected item
10999 * @param {OO.ui.OptionWidget|null} item Chosen item
11004 * @param {OO.ui.OptionWidget[]} items Added items
11005 * @param {number} index Index items were added at
11010 * @param {OO.ui.OptionWidget[]} items Removed items
11016 * Handle mouse down events.
11019 * @param {jQuery.Event} e Mouse down event
11021 OO
.ui
.SelectWidget
.prototype.onMouseDown = function ( e
) {
11024 if ( !this.isDisabled() && e
.which
=== 1 ) {
11025 this.togglePressed( true );
11026 item
= this.getTargetItem( e
);
11027 if ( item
&& item
.isSelectable() ) {
11028 this.pressItem( item
);
11029 this.selecting
= item
;
11030 this.getElementDocument().addEventListener(
11032 this.onMouseUpHandler
,
11035 this.getElementDocument().addEventListener(
11037 this.onMouseMoveHandler
,
11046 * Handle mouse up events.
11049 * @param {jQuery.Event} e Mouse up event
11051 OO
.ui
.SelectWidget
.prototype.onMouseUp = function ( e
) {
11054 this.togglePressed( false );
11055 if ( !this.selecting
) {
11056 item
= this.getTargetItem( e
);
11057 if ( item
&& item
.isSelectable() ) {
11058 this.selecting
= item
;
11061 if ( !this.isDisabled() && e
.which
=== 1 && this.selecting
) {
11062 this.pressItem( null );
11063 this.chooseItem( this.selecting
);
11064 this.selecting
= null;
11067 this.getElementDocument().removeEventListener(
11069 this.onMouseUpHandler
,
11072 this.getElementDocument().removeEventListener(
11074 this.onMouseMoveHandler
,
11082 * Handle mouse move events.
11085 * @param {jQuery.Event} e Mouse move event
11087 OO
.ui
.SelectWidget
.prototype.onMouseMove = function ( e
) {
11090 if ( !this.isDisabled() && this.pressed
) {
11091 item
= this.getTargetItem( e
);
11092 if ( item
&& item
!== this.selecting
&& item
.isSelectable() ) {
11093 this.pressItem( item
);
11094 this.selecting
= item
;
11101 * Handle mouse over events.
11104 * @param {jQuery.Event} e Mouse over event
11106 OO
.ui
.SelectWidget
.prototype.onMouseOver = function ( e
) {
11109 if ( !this.isDisabled() ) {
11110 item
= this.getTargetItem( e
);
11111 this.highlightItem( item
&& item
.isHighlightable() ? item
: null );
11117 * Handle mouse leave events.
11120 * @param {jQuery.Event} e Mouse over event
11122 OO
.ui
.SelectWidget
.prototype.onMouseLeave = function () {
11123 if ( !this.isDisabled() ) {
11124 this.highlightItem( null );
11130 * Get the closest item to a jQuery.Event.
11133 * @param {jQuery.Event} e
11134 * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
11136 OO
.ui
.SelectWidget
.prototype.getTargetItem = function ( e
) {
11137 var $item
= this.$( e
.target
).closest( '.oo-ui-optionWidget' );
11138 if ( $item
.length
) {
11139 return $item
.data( 'oo-ui-optionWidget' );
11145 * Get selected item.
11147 * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
11149 OO
.ui
.SelectWidget
.prototype.getSelectedItem = function () {
11152 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
11153 if ( this.items
[i
].isSelected() ) {
11154 return this.items
[i
];
11161 * Get highlighted item.
11163 * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
11165 OO
.ui
.SelectWidget
.prototype.getHighlightedItem = function () {
11168 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
11169 if ( this.items
[i
].isHighlighted() ) {
11170 return this.items
[i
];
11177 * Get an existing item with equivilant data.
11179 * @param {Object} data Item data to search for
11180 * @return {OO.ui.OptionWidget|null} Item with equivilent value, `null` if none exists
11182 OO
.ui
.SelectWidget
.prototype.getItemFromData = function ( data
) {
11183 var hash
= OO
.getHash( data
);
11185 if ( Object
.prototype.hasOwnProperty
.call( this.hashes
, hash
) ) {
11186 return this.hashes
[hash
];
11193 * Toggle pressed state.
11195 * @param {boolean} pressed An option is being pressed
11197 OO
.ui
.SelectWidget
.prototype.togglePressed = function ( pressed
) {
11198 if ( pressed
=== undefined ) {
11199 pressed
= !this.pressed
;
11201 if ( pressed
!== this.pressed
) {
11203 .toggleClass( 'oo-ui-selectWidget-pressed', pressed
)
11204 .toggleClass( 'oo-ui-selectWidget-depressed', !pressed
);
11205 this.pressed
= pressed
;
11210 * Highlight an item.
11212 * Highlighting is mutually exclusive.
11214 * @param {OO.ui.OptionWidget} [item] Item to highlight, omit to deselect all
11218 OO
.ui
.SelectWidget
.prototype.highlightItem = function ( item
) {
11219 var i
, len
, highlighted
,
11222 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
11223 highlighted
= this.items
[i
] === item
;
11224 if ( this.items
[i
].isHighlighted() !== highlighted
) {
11225 this.items
[i
].setHighlighted( highlighted
);
11230 this.emit( 'highlight', item
);
11239 * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
11243 OO
.ui
.SelectWidget
.prototype.selectItem = function ( item
) {
11244 var i
, len
, selected
,
11247 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
11248 selected
= this.items
[i
] === item
;
11249 if ( this.items
[i
].isSelected() !== selected
) {
11250 this.items
[i
].setSelected( selected
);
11255 this.emit( 'select', item
);
11264 * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
11268 OO
.ui
.SelectWidget
.prototype.pressItem = function ( item
) {
11269 var i
, len
, pressed
,
11272 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
11273 pressed
= this.items
[i
] === item
;
11274 if ( this.items
[i
].isPressed() !== pressed
) {
11275 this.items
[i
].setPressed( pressed
);
11280 this.emit( 'press', item
);
11289 * Identical to #selectItem, but may vary in subclasses that want to take additional action when
11290 * an item is selected using the keyboard or mouse.
11292 * @param {OO.ui.OptionWidget} item Item to choose
11296 OO
.ui
.SelectWidget
.prototype.chooseItem = function ( item
) {
11297 this.selectItem( item
);
11298 this.emit( 'choose', item
);
11304 * Get an item relative to another one.
11306 * @param {OO.ui.OptionWidget} item Item to start at
11307 * @param {number} direction Direction to move in, -1 to look backward, 1 to move forward
11308 * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the menu
11310 OO
.ui
.SelectWidget
.prototype.getRelativeSelectableItem = function ( item
, direction
) {
11311 var inc
= direction
> 0 ? 1 : -1,
11312 len
= this.items
.length
,
11313 index
= item
instanceof OO
.ui
.OptionWidget
?
11314 $.inArray( item
, this.items
) : ( inc
> 0 ? -1 : 0 ),
11315 stopAt
= Math
.max( Math
.min( index
, len
- 1 ), 0 ),
11317 // Default to 0 instead of -1, if nothing is selected let's start at the beginning
11318 Math
.max( index
, -1 ) :
11319 // Default to n-1 instead of -1, if nothing is selected let's start at the end
11320 Math
.min( index
, len
);
11322 while ( len
!== 0 ) {
11323 i
= ( i
+ inc
+ len
) % len
;
11324 item
= this.items
[i
];
11325 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
11328 // Stop iterating when we've looped all the way around
11329 if ( i
=== stopAt
) {
11337 * Get the next selectable item.
11339 * @return {OO.ui.OptionWidget|null} Item, `null` if ther aren't any selectable items
11341 OO
.ui
.SelectWidget
.prototype.getFirstSelectableItem = function () {
11344 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
11345 item
= this.items
[i
];
11346 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
11357 * When items are added with the same values as existing items, the existing items will be
11358 * automatically removed before the new items are added.
11360 * @param {OO.ui.OptionWidget[]} items Items to add
11361 * @param {number} [index] Index to insert items after
11365 OO
.ui
.SelectWidget
.prototype.addItems = function ( items
, index
) {
11366 var i
, len
, item
, hash
,
11369 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
11371 hash
= OO
.getHash( item
.getData() );
11372 if ( Object
.prototype.hasOwnProperty
.call( this.hashes
, hash
) ) {
11373 // Remove item with same value
11374 remove
.push( this.hashes
[hash
] );
11376 this.hashes
[hash
] = item
;
11378 if ( remove
.length
) {
11379 this.removeItems( remove
);
11383 OO
.ui
.GroupWidget
.prototype.addItems
.call( this, items
, index
);
11385 // Always provide an index, even if it was omitted
11386 this.emit( 'add', items
, index
=== undefined ? this.items
.length
- items
.length
- 1 : index
);
11394 * Items will be detached, not removed, so they can be used later.
11396 * @param {OO.ui.OptionWidget[]} items Items to remove
11400 OO
.ui
.SelectWidget
.prototype.removeItems = function ( items
) {
11401 var i
, len
, item
, hash
;
11403 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
11405 hash
= OO
.getHash( item
.getData() );
11406 if ( Object
.prototype.hasOwnProperty
.call( this.hashes
, hash
) ) {
11407 // Remove existing item
11408 delete this.hashes
[hash
];
11410 if ( item
.isSelected() ) {
11411 this.selectItem( null );
11416 OO
.ui
.GroupWidget
.prototype.removeItems
.call( this, items
);
11418 this.emit( 'remove', items
);
11426 * Items will be detached, not removed, so they can be used later.
11431 OO
.ui
.SelectWidget
.prototype.clearItems = function () {
11432 var items
= this.items
.slice();
11437 OO
.ui
.GroupWidget
.prototype.clearItems
.call( this );
11438 this.selectItem( null );
11440 this.emit( 'remove', items
);
11446 * Select widget containing button options.
11448 * Use together with OO.ui.ButtonOptionWidget.
11451 * @extends OO.ui.SelectWidget
11454 * @param {Object} [config] Configuration options
11456 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
11457 // Parent constructor
11458 OO
.ui
.ButtonSelectWidget
.super.call( this, config
);
11461 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
11466 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
11469 * Overlaid menu of options.
11471 * Menus are clipped to the visible viewport. They do not provide a control for opening or closing
11474 * Use together with OO.ui.MenuItemWidget.
11477 * @extends OO.ui.SelectWidget
11478 * @mixins OO.ui.ClippableElement
11481 * @param {Object} [config] Configuration options
11482 * @cfg {OO.ui.InputWidget} [input] Input to bind keyboard handlers to
11483 * @cfg {OO.ui.Widget} [widget] Widget to bind mouse handlers to
11484 * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu
11486 OO
.ui
.MenuWidget
= function OoUiMenuWidget( config
) {
11487 // Configuration initialization
11488 config
= config
|| {};
11490 // Parent constructor
11491 OO
.ui
.MenuWidget
.super.call( this, config
);
11493 // Mixin constructors
11494 OO
.ui
.ClippableElement
.call( this, $.extend( {}, config
, { $clippable
: this.$group
} ) );
11497 this.flashing
= false;
11498 this.visible
= false;
11499 this.newItems
= null;
11500 this.autoHide
= config
.autoHide
=== undefined || !!config
.autoHide
;
11501 this.$input
= config
.input
? config
.input
.$input
: null;
11502 this.$widget
= config
.widget
? config
.widget
.$element
: null;
11503 this.$previousFocus
= null;
11504 this.isolated
= !config
.input
;
11505 this.onKeyDownHandler
= this.onKeyDown
.bind( this );
11506 this.onDocumentMouseDownHandler
= this.onDocumentMouseDown
.bind( this );
11511 .attr( 'role', 'menu' )
11512 .addClass( 'oo-ui-menuWidget' );
11517 OO
.inheritClass( OO
.ui
.MenuWidget
, OO
.ui
.SelectWidget
);
11518 OO
.mixinClass( OO
.ui
.MenuWidget
, OO
.ui
.ClippableElement
);
11523 * Handles document mouse down events.
11525 * @param {jQuery.Event} e Key down event
11527 OO
.ui
.MenuWidget
.prototype.onDocumentMouseDown = function ( e
) {
11529 !OO
.ui
.contains( this.$element
[0], e
.target
, true ) &&
11530 ( !this.$widget
|| !OO
.ui
.contains( this.$widget
[0], e
.target
, true ) )
11532 this.toggle( false );
11537 * Handles key down events.
11539 * @param {jQuery.Event} e Key down event
11541 OO
.ui
.MenuWidget
.prototype.onKeyDown = function ( e
) {
11544 highlightItem
= this.getHighlightedItem();
11546 if ( !this.isDisabled() && this.isVisible() ) {
11547 if ( !highlightItem
) {
11548 highlightItem
= this.getSelectedItem();
11550 switch ( e
.keyCode
) {
11551 case OO
.ui
.Keys
.ENTER
:
11552 this.chooseItem( highlightItem
);
11555 case OO
.ui
.Keys
.UP
:
11556 nextItem
= this.getRelativeSelectableItem( highlightItem
, -1 );
11559 case OO
.ui
.Keys
.DOWN
:
11560 nextItem
= this.getRelativeSelectableItem( highlightItem
, 1 );
11563 case OO
.ui
.Keys
.ESCAPE
:
11564 if ( highlightItem
) {
11565 highlightItem
.setHighlighted( false );
11567 this.toggle( false );
11573 this.highlightItem( nextItem
);
11574 nextItem
.scrollElementIntoView();
11578 e
.preventDefault();
11579 e
.stopPropagation();
11586 * Bind key down listener.
11588 OO
.ui
.MenuWidget
.prototype.bindKeyDownListener = function () {
11589 if ( this.$input
) {
11590 this.$input
.on( 'keydown', this.onKeyDownHandler
);
11592 // Capture menu navigation keys
11593 this.getElementWindow().addEventListener( 'keydown', this.onKeyDownHandler
, true );
11598 * Unbind key down listener.
11600 OO
.ui
.MenuWidget
.prototype.unbindKeyDownListener = function () {
11601 if ( this.$input
) {
11602 this.$input
.off( 'keydown' );
11604 this.getElementWindow().removeEventListener( 'keydown', this.onKeyDownHandler
, true );
11611 * This will close the menu when done, unlike selectItem which only changes selection.
11613 * @param {OO.ui.OptionWidget} item Item to choose
11616 OO
.ui
.MenuWidget
.prototype.chooseItem = function ( item
) {
11620 OO
.ui
.MenuWidget
.super.prototype.chooseItem
.call( this, item
);
11622 if ( item
&& !this.flashing
) {
11623 this.flashing
= true;
11624 item
.flash().done( function () {
11625 widget
.toggle( false );
11626 widget
.flashing
= false;
11629 this.toggle( false );
11638 OO
.ui
.MenuWidget
.prototype.addItems = function ( items
, index
) {
11642 OO
.ui
.MenuWidget
.super.prototype.addItems
.call( this, items
, index
);
11645 if ( !this.newItems
) {
11646 this.newItems
= [];
11649 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
11651 if ( this.isVisible() ) {
11652 // Defer fitting label until item has been attached
11655 this.newItems
.push( item
);
11659 // Reevaluate clipping
11668 OO
.ui
.MenuWidget
.prototype.removeItems = function ( items
) {
11670 OO
.ui
.MenuWidget
.super.prototype.removeItems
.call( this, items
);
11672 // Reevaluate clipping
11681 OO
.ui
.MenuWidget
.prototype.clearItems = function () {
11683 OO
.ui
.MenuWidget
.super.prototype.clearItems
.call( this );
11685 // Reevaluate clipping
11694 OO
.ui
.MenuWidget
.prototype.toggle = function ( visible
) {
11695 visible
= ( visible
=== undefined ? !this.visible
: !!visible
) && !!this.items
.length
;
11698 change
= visible
!== this.isVisible(),
11699 elementDoc
= this.getElementDocument(),
11700 widgetDoc
= this.$widget
? this.$widget
[0].ownerDocument
: null;
11703 OO
.ui
.MenuWidget
.super.prototype.toggle
.call( this, visible
);
11707 this.bindKeyDownListener();
11709 // Change focus to enable keyboard navigation
11710 if ( this.isolated
&& this.$input
&& !this.$input
.is( ':focus' ) ) {
11711 this.$previousFocus
= this.$( ':focus' );
11712 this.$input
[0].focus();
11714 if ( this.newItems
&& this.newItems
.length
) {
11715 for ( i
= 0, len
= this.newItems
.length
; i
< len
; i
++ ) {
11716 this.newItems
[i
].fitLabel();
11718 this.newItems
= null;
11720 this.toggleClipping( true );
11723 if ( this.autoHide
) {
11724 elementDoc
.addEventListener(
11725 'mousedown', this.onDocumentMouseDownHandler
, true
11727 // Support $widget being in a different document
11728 if ( widgetDoc
&& widgetDoc
!== elementDoc
) {
11729 widgetDoc
.addEventListener(
11730 'mousedown', this.onDocumentMouseDownHandler
, true
11735 this.unbindKeyDownListener();
11736 if ( this.isolated
&& this.$previousFocus
) {
11737 this.$previousFocus
[0].focus();
11738 this.$previousFocus
= null;
11740 elementDoc
.removeEventListener(
11741 'mousedown', this.onDocumentMouseDownHandler
, true
11743 // Support $widget being in a different document
11744 if ( widgetDoc
&& widgetDoc
!== elementDoc
) {
11745 widgetDoc
.removeEventListener(
11746 'mousedown', this.onDocumentMouseDownHandler
, true
11749 this.toggleClipping( false );
11757 * Menu for a text input widget.
11759 * This menu is specially designed to be positioned beneath the text input widget. Even if the input
11760 * is in a different frame, the menu's position is automatically calculated and maintained when the
11761 * menu is toggled or the window is resized.
11764 * @extends OO.ui.MenuWidget
11767 * @param {OO.ui.TextInputWidget} input Text input widget to provide menu for
11768 * @param {Object} [config] Configuration options
11769 * @cfg {jQuery} [$container=input.$element] Element to render menu under
11771 OO
.ui
.TextInputMenuWidget
= function OoUiTextInputMenuWidget( input
, config
) {
11772 // Configuration intialization
11773 config
= config
|| {};
11775 // Parent constructor
11776 OO
.ui
.TextInputMenuWidget
.super.call( this, config
);
11779 this.input
= input
;
11780 this.$container
= config
.$container
|| this.input
.$element
;
11781 this.onWindowResizeHandler
= this.onWindowResize
.bind( this );
11784 this.$element
.addClass( 'oo-ui-textInputMenuWidget' );
11789 OO
.inheritClass( OO
.ui
.TextInputMenuWidget
, OO
.ui
.MenuWidget
);
11794 * Handle window resize event.
11796 * @param {jQuery.Event} e Window resize event
11798 OO
.ui
.TextInputMenuWidget
.prototype.onWindowResize = function () {
11805 OO
.ui
.TextInputMenuWidget
.prototype.toggle = function ( visible
) {
11806 visible
= visible
=== undefined ? !this.isVisible() : !!visible
;
11808 var change
= visible
!== this.isVisible();
11810 if ( change
&& visible
) {
11811 // Make sure the width is set before the parent method runs.
11812 // After this we have to call this.position(); again to actually
11813 // position ourselves correctly.
11818 OO
.ui
.TextInputMenuWidget
.super.prototype.toggle
.call( this, visible
);
11821 if ( this.isVisible() ) {
11823 this.$( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler
);
11825 this.$( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler
);
11833 * Position the menu.
11837 OO
.ui
.TextInputMenuWidget
.prototype.position = function () {
11838 var $container
= this.$container
,
11839 pos
= OO
.ui
.Element
.getRelativePosition( $container
, this.$element
.offsetParent() );
11841 // Position under input
11842 pos
.top
+= $container
.height();
11843 this.$element
.css( pos
);
11846 this.setIdealSize( $container
.width() );
11847 // We updated the position, so re-evaluate the clipping state
11854 * Structured list of items.
11856 * Use with OO.ui.OutlineItemWidget.
11859 * @extends OO.ui.SelectWidget
11862 * @param {Object} [config] Configuration options
11864 OO
.ui
.OutlineWidget
= function OoUiOutlineWidget( config
) {
11865 // Configuration initialization
11866 config
= config
|| {};
11868 // Parent constructor
11869 OO
.ui
.OutlineWidget
.super.call( this, config
);
11872 this.$element
.addClass( 'oo-ui-outlineWidget' );
11877 OO
.inheritClass( OO
.ui
.OutlineWidget
, OO
.ui
.SelectWidget
);
11880 * Switch that slides on and off.
11883 * @extends OO.ui.Widget
11884 * @mixins OO.ui.ToggleWidget
11887 * @param {Object} [config] Configuration options
11888 * @cfg {boolean} [value=false] Initial value
11890 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
11891 // Parent constructor
11892 OO
.ui
.ToggleSwitchWidget
.super.call( this, config
);
11894 // Mixin constructors
11895 OO
.ui
.ToggleWidget
.call( this, config
);
11898 this.dragging
= false;
11899 this.dragStart
= null;
11900 this.sliding
= false;
11901 this.$glow
= this.$( '<span>' );
11902 this.$grip
= this.$( '<span>' );
11905 this.$element
.on( 'click', this.onClick
.bind( this ) );
11908 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
11909 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
11911 .addClass( 'oo-ui-toggleSwitchWidget' )
11912 .append( this.$glow
, this.$grip
);
11917 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.Widget
);
11918 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
11923 * Handle mouse down events.
11925 * @param {jQuery.Event} e Mouse down event
11927 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
11928 if ( !this.isDisabled() && e
.which
=== 1 ) {
11929 this.setValue( !this.value
);