2 * OOjs UI v0.1.0-pre (30b0407428)
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-09-30T23:08:05Z
16 * Namespace for all classes, static methods and static properties.
48 * Get the user's language and any fallback languages.
50 * These language codes are used to localize user interface elements in the user's language.
52 * In environments that provide a localization system, this function should be overridden to
53 * return the user's language(s). The default implementation returns English (en) only.
55 * @return {string[]} Language codes, in descending order of priority
57 OO
.ui
.getUserLanguages = function () {
62 * Get a value in an object keyed by language code.
64 * @param {Object.<string,Mixed>} obj Object keyed by language code
65 * @param {string|null} [lang] Language code, if omitted or null defaults to any user language
66 * @param {string} [fallback] Fallback code, used if no matching language can be found
67 * @return {Mixed} Local value
69 OO
.ui
.getLocalValue = function ( obj
, lang
, fallback
) {
76 // Known user language
77 langs
= OO
.ui
.getUserLanguages();
78 for ( i
= 0, len
= langs
.length
; i
< len
; i
++ ) {
85 if ( obj
[fallback
] ) {
88 // First existing language
98 * Message store for the default implementation of OO.ui.msg
100 * Environments that provide a localization system should not use this, but should override
101 * OO.ui.msg altogether.
106 // Tool tip for a button that moves items in a list down one place
107 'ooui-outline-control-move-down': 'Move item down',
108 // Tool tip for a button that moves items in a list up one place
109 'ooui-outline-control-move-up': 'Move item up',
110 // Tool tip for a button that removes items from a list
111 'ooui-outline-control-remove': 'Remove item',
112 // Label for the toolbar group that contains a list of all other available tools
113 'ooui-toolbar-more': 'More',
114 // Default label for the accept button of a confirmation dialog
115 'ooui-dialog-message-accept': 'OK',
116 // Default label for the reject button of a confirmation dialog
117 'ooui-dialog-message-reject': 'Cancel',
118 // Title for process dialog error description
119 'ooui-dialog-process-error': 'Something went wrong',
120 // Label for process dialog dismiss error button, visible when describing errors
121 'ooui-dialog-process-dismiss': 'Dismiss',
122 // Label for process dialog retry action button, visible when describing recoverable errors
123 'ooui-dialog-process-retry': 'Try again'
127 * Get a localized message.
129 * In environments that provide a localization system, this function should be overridden to
130 * return the message translated in the user's language. The default implementation always returns
133 * After the message key, message parameters may optionally be passed. In the default implementation,
134 * any occurrences of $1 are replaced with the first parameter, $2 with the second parameter, etc.
135 * Alternative implementations of OO.ui.msg may use any substitution system they like, as long as
136 * they support unnamed, ordered message parameters.
139 * @param {string} key Message key
140 * @param {Mixed...} [params] Message parameters
141 * @return {string} Translated message with parameters substituted
143 OO
.ui
.msg = function ( key
) {
144 var message
= messages
[key
], params
= Array
.prototype.slice
.call( arguments
, 1 );
145 if ( typeof message
=== 'string' ) {
146 // Perform $1 substitution
147 message
= message
.replace( /\$(\d+)/g, function ( unused
, n
) {
148 var i
= parseInt( n
, 10 );
149 return params
[i
- 1] !== undefined ? params
[i
- 1] : '$' + n
;
152 // Return placeholder if message not found
153 message
= '[' + key
+ ']';
159 * Package a message and arguments for deferred resolution.
161 * Use this when you are statically specifying a message and the message may not yet be present.
163 * @param {string} key Message key
164 * @param {Mixed...} [params] Message parameters
165 * @return {Function} Function that returns the resolved message when executed
167 OO
.ui
.deferMsg = function () {
168 var args
= arguments
;
170 return OO
.ui
.msg
.apply( OO
.ui
, args
);
177 * If the message is a function it will be executed, otherwise it will pass through directly.
179 * @param {Function|string} msg Deferred message, or message text
180 * @return {string} Resolved message
182 OO
.ui
.resolveMsg = function ( msg
) {
183 if ( $.isFunction( msg
) ) {
192 * Element that can be marked as pending.
198 * @param {Object} [config] Configuration options
200 OO
.ui
.PendingElement
= function OoUiPendingElement( config
) {
201 // Config initialisation
202 config
= config
|| {};
206 this.$pending
= null;
209 this.setPendingElement( config
.$pending
|| this.$element
);
214 OO
.initClass( OO
.ui
.PendingElement
);
219 * Set the pending element (and clean up any existing one).
221 * @param {jQuery} $pending The element to set to pending.
223 OO
.ui
.PendingElement
.prototype.setPendingElement = function ( $pending
) {
224 if ( this.$pending
) {
225 this.$pending
.removeClass( 'oo-ui-pendingElement-pending' );
228 this.$pending
= $pending
;
229 if ( this.pending
> 0 ) {
230 this.$pending
.addClass( 'oo-ui-pendingElement-pending' );
235 * Check if input is pending.
239 OO
.ui
.PendingElement
.prototype.isPending = function () {
240 return !!this.pending
;
244 * Increase the pending stack.
248 OO
.ui
.PendingElement
.prototype.pushPending = function () {
249 if ( this.pending
=== 0 ) {
250 this.$pending
.addClass( 'oo-ui-pendingElement-pending' );
251 this.updateThemeClasses();
259 * Reduce the pending stack.
265 OO
.ui
.PendingElement
.prototype.popPending = function () {
266 if ( this.pending
=== 1 ) {
267 this.$pending
.removeClass( 'oo-ui-pendingElement-pending' );
268 this.updateThemeClasses();
270 this.pending
= Math
.max( 0, this.pending
- 1 );
280 * @mixins OO.EventEmitter
283 * @param {Object} [config] Configuration options
285 OO
.ui
.ActionSet
= function OoUiActionSet( config
) {
286 // Configuration intialization
287 config
= config
|| {};
289 // Mixin constructors
290 OO
.EventEmitter
.call( this );
295 actions
: 'getAction',
299 this.categorized
= {};
302 this.organized
= false;
303 this.changing
= false;
304 this.changed
= false;
309 OO
.mixinClass( OO
.ui
.ActionSet
, OO
.EventEmitter
);
311 /* Static Properties */
314 * Symbolic name of dialog.
321 OO
.ui
.ActionSet
.static.specialFlags
= [ 'safe', 'primary' ];
327 * @param {OO.ui.ActionWidget} action Action that was clicked
332 * @param {OO.ui.ActionWidget} action Action that was resized
337 * @param {OO.ui.ActionWidget[]} added Actions added
342 * @param {OO.ui.ActionWidget[]} added Actions removed
352 * Handle action change events.
356 OO
.ui
.ActionSet
.prototype.onActionChange = function () {
357 this.organized
= false;
358 if ( this.changing
) {
361 this.emit( 'change' );
366 * Check if a action is one of the special actions.
368 * @param {OO.ui.ActionWidget} action Action to check
369 * @return {boolean} Action is special
371 OO
.ui
.ActionSet
.prototype.isSpecial = function ( action
) {
374 for ( flag
in this.special
) {
375 if ( action
=== this.special
[flag
] ) {
386 * @param {Object} [filters] Filters to use, omit to get all actions
387 * @param {string|string[]} [filters.actions] Actions that actions must have
388 * @param {string|string[]} [filters.flags] Flags that actions must have
389 * @param {string|string[]} [filters.modes] Modes that actions must have
390 * @param {boolean} [filters.visible] Actions must be visible
391 * @param {boolean} [filters.disabled] Actions must be disabled
392 * @return {OO.ui.ActionWidget[]} Actions matching all criteria
394 OO
.ui
.ActionSet
.prototype.get = function ( filters
) {
395 var i
, len
, list
, category
, actions
, index
, match
, matches
;
400 // Collect category candidates
402 for ( category
in this.categorized
) {
403 list
= filters
[category
];
405 if ( !Array
.isArray( list
) ) {
408 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
409 actions
= this.categorized
[category
][list
[i
]];
410 if ( Array
.isArray( actions
) ) {
411 matches
.push
.apply( matches
, actions
);
416 // Remove by boolean filters
417 for ( i
= 0, len
= matches
.length
; i
< len
; i
++ ) {
420 ( filters
.visible
!== undefined && match
.isVisible() !== filters
.visible
) ||
421 ( filters
.disabled
!== undefined && match
.isDisabled() !== filters
.disabled
)
423 matches
.splice( i
, 1 );
429 for ( i
= 0, len
= matches
.length
; i
< len
; i
++ ) {
431 index
= matches
.lastIndexOf( match
);
432 while ( index
!== i
) {
433 matches
.splice( index
, 1 );
435 index
= matches
.lastIndexOf( match
);
440 return this.list
.slice();
444 * Get special actions.
446 * Special actions are the first visible actions with special flags, such as 'safe' and 'primary'.
447 * Special flags can be configured by changing #static-specialFlags in a subclass.
449 * @return {OO.ui.ActionWidget|null} Safe action
451 OO
.ui
.ActionSet
.prototype.getSpecial = function () {
453 return $.extend( {}, this.special
);
459 * Other actions include all non-special visible actions.
461 * @return {OO.ui.ActionWidget[]} Other actions
463 OO
.ui
.ActionSet
.prototype.getOthers = function () {
465 return this.others
.slice();
469 * Toggle actions based on their modes.
471 * Unlike calling toggle on actions with matching flags, this will enforce mutually exclusive
472 * visibility; matching actions will be shown, non-matching actions will be hidden.
474 * @param {string} mode Mode actions must have
479 OO
.ui
.ActionSet
.prototype.setMode = function ( mode
) {
482 this.changing
= true;
483 for ( i
= 0, len
= this.list
.length
; i
< len
; i
++ ) {
484 action
= this.list
[i
];
485 action
.toggle( action
.hasMode( mode
) );
488 this.organized
= false;
489 this.changing
= false;
490 this.emit( 'change' );
496 * Change which actions are able to be performed.
498 * Actions with matching actions will be disabled/enabled. Other actions will not be changed.
500 * @param {Object.<string,boolean>} actions List of abilities, keyed by action name, values
501 * indicate actions are able to be performed
504 OO
.ui
.ActionSet
.prototype.setAbilities = function ( actions
) {
505 var i
, len
, action
, item
;
507 for ( i
= 0, len
= this.list
.length
; i
< len
; i
++ ) {
509 action
= item
.getAction();
510 if ( actions
[action
] !== undefined ) {
511 item
.setDisabled( !actions
[action
] );
519 * Executes a function once per action.
521 * When making changes to multiple actions, use this method instead of iterating over the actions
522 * manually to defer emitting a change event until after all actions have been changed.
524 * @param {Object|null} actions Filters to use for which actions to iterate over; see #get
525 * @param {Function} callback Callback to run for each action; callback is invoked with three
526 * arguments: the action, the action's index, the list of actions being iterated over
529 OO
.ui
.ActionSet
.prototype.forEach = function ( filter
, callback
) {
530 this.changed
= false;
531 this.changing
= true;
532 this.get( filter
).forEach( callback
);
533 this.changing
= false;
534 if ( this.changed
) {
535 this.emit( 'change' );
544 * @param {OO.ui.ActionWidget[]} actions Actions to add
549 OO
.ui
.ActionSet
.prototype.add = function ( actions
) {
552 this.changing
= true;
553 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
555 action
.connect( this, {
556 click
: [ 'emit', 'click', action
],
557 resize
: [ 'emit', 'resize', action
],
558 toggle
: [ 'onActionChange' ]
560 this.list
.push( action
);
562 this.organized
= false;
563 this.emit( 'add', actions
);
564 this.changing
= false;
565 this.emit( 'change' );
573 * @param {OO.ui.ActionWidget[]} actions Actions to remove
578 OO
.ui
.ActionSet
.prototype.remove = function ( actions
) {
579 var i
, len
, index
, action
;
581 this.changing
= true;
582 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
584 index
= this.list
.indexOf( action
);
585 if ( index
!== -1 ) {
586 action
.disconnect( this );
587 this.list
.splice( index
, 1 );
590 this.organized
= false;
591 this.emit( 'remove', actions
);
592 this.changing
= false;
593 this.emit( 'change' );
599 * Remove all actions.
605 OO
.ui
.ActionSet
.prototype.clear = function () {
607 removed
= this.list
.slice();
609 this.changing
= true;
610 for ( i
= 0, len
= this.list
.length
; i
< len
; i
++ ) {
611 action
= this.list
[i
];
612 action
.disconnect( this );
617 this.organized
= false;
618 this.emit( 'remove', removed
);
619 this.changing
= false;
620 this.emit( 'change' );
628 * This is called whenver organized information is requested. It will only reorganize the actions
629 * if something has changed since the last time it ran.
634 OO
.ui
.ActionSet
.prototype.organize = function () {
635 var i
, iLen
, j
, jLen
, flag
, action
, category
, list
, item
, special
,
636 specialFlags
= this.constructor.static.specialFlags
;
638 if ( !this.organized
) {
639 this.categorized
= {};
642 for ( i
= 0, iLen
= this.list
.length
; i
< iLen
; i
++ ) {
643 action
= this.list
[i
];
644 if ( action
.isVisible() ) {
645 // Populate catgeories
646 for ( category
in this.categories
) {
647 if ( !this.categorized
[category
] ) {
648 this.categorized
[category
] = {};
650 list
= action
[this.categories
[category
]]();
651 if ( !Array
.isArray( list
) ) {
654 for ( j
= 0, jLen
= list
.length
; j
< jLen
; j
++ ) {
656 if ( !this.categorized
[category
][item
] ) {
657 this.categorized
[category
][item
] = [];
659 this.categorized
[category
][item
].push( action
);
662 // Populate special/others
664 for ( j
= 0, jLen
= specialFlags
.length
; j
< jLen
; j
++ ) {
665 flag
= specialFlags
[j
];
666 if ( !this.special
[flag
] && action
.hasFlag( flag
) ) {
667 this.special
[flag
] = action
;
673 this.others
.push( action
);
677 this.organized
= true;
684 * DOM element abstraction.
690 * @param {Object} [config] Configuration options
691 * @cfg {Function} [$] jQuery for the frame the widget is in
692 * @cfg {string[]} [classes] CSS class names
693 * @cfg {string} [text] Text to insert
694 * @cfg {jQuery} [$content] Content elements to append (after text)
696 OO
.ui
.Element
= function OoUiElement( config
) {
697 // Configuration initialization
698 config
= config
|| {};
701 this.$ = config
.$ || OO
.ui
.Element
.getJQuery( document
);
702 this.$element
= this.$( this.$.context
.createElement( this.getTagName() ) );
703 this.elementGroup
= null;
704 this.debouncedUpdateThemeClassesHandler
= OO
.ui
.bind(
705 this.debouncedUpdateThemeClasses
, this
707 this.updateThemeClassesPending
= false;
710 if ( $.isArray( config
.classes
) ) {
711 this.$element
.addClass( config
.classes
.join( ' ' ) );
714 this.$element
.text( config
.text
);
716 if ( config
.$content
) {
717 this.$element
.append( config
.$content
);
723 OO
.initClass( OO
.ui
.Element
);
725 /* Static Properties */
730 * This may be ignored if getTagName is overridden.
736 OO
.ui
.Element
.static.tagName
= 'div';
741 * Get a jQuery function within a specific document.
744 * @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
745 * @param {jQuery} [$iframe] HTML iframe element that contains the document, omit if document is
747 * @return {Function} Bound jQuery function
749 OO
.ui
.Element
.getJQuery = function ( context
, $iframe
) {
750 function wrapper( selector
) {
751 return $( selector
, wrapper
.context
);
754 wrapper
.context
= this.getDocument( context
);
757 wrapper
.$iframe
= $iframe
;
764 * Get the document of an element.
767 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Object to get the document for
768 * @return {HTMLDocument|null} Document object
770 OO
.ui
.Element
.getDocument = function ( obj
) {
771 // jQuery - selections created "offscreen" won't have a context, so .context isn't reliable
772 return ( obj
[0] && obj
[0].ownerDocument
) ||
773 // Empty jQuery selections might have a context
780 ( obj
.nodeType
=== 9 && obj
) ||
785 * Get the window of an element or document.
788 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the window for
789 * @return {Window} Window object
791 OO
.ui
.Element
.getWindow = function ( obj
) {
792 var doc
= this.getDocument( obj
);
793 return doc
.parentWindow
|| doc
.defaultView
;
797 * Get the direction of an element or document.
800 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the direction for
801 * @return {string} Text direction, either `ltr` or `rtl`
803 OO
.ui
.Element
.getDir = function ( obj
) {
806 if ( obj
instanceof jQuery
) {
809 isDoc
= obj
.nodeType
=== 9;
810 isWin
= obj
.document
!== undefined;
811 if ( isDoc
|| isWin
) {
817 return $( obj
).css( 'direction' );
821 * Get the offset between two frames.
823 * TODO: Make this function not use recursion.
826 * @param {Window} from Window of the child frame
827 * @param {Window} [to=window] Window of the parent frame
828 * @param {Object} [offset] Offset to start with, used internally
829 * @return {Object} Offset object, containing left and top properties
831 OO
.ui
.Element
.getFrameOffset = function ( from, to
, offset
) {
832 var i
, len
, frames
, frame
, rect
;
838 offset
= { top
: 0, left
: 0 };
840 if ( from.parent
=== from ) {
844 // Get iframe element
845 frames
= from.parent
.document
.getElementsByTagName( 'iframe' );
846 for ( i
= 0, len
= frames
.length
; i
< len
; i
++ ) {
847 if ( frames
[i
].contentWindow
=== from ) {
853 // Recursively accumulate offset values
855 rect
= frame
.getBoundingClientRect();
856 offset
.left
+= rect
.left
;
857 offset
.top
+= rect
.top
;
859 this.getFrameOffset( from.parent
, offset
);
866 * Get the offset between two elements.
869 * @param {jQuery} $from
870 * @param {jQuery} $to
871 * @return {Object} Translated position coordinates, containing top and left properties
873 OO
.ui
.Element
.getRelativePosition = function ( $from, $to
) {
874 var from = $from.offset(),
876 return { top
: Math
.round( from.top
- to
.top
), left
: Math
.round( from.left
- to
.left
) };
880 * Get element border sizes.
883 * @param {HTMLElement} el Element to measure
884 * @return {Object} Dimensions object with `top`, `left`, `bottom` and `right` properties
886 OO
.ui
.Element
.getBorders = function ( el
) {
887 var doc
= el
.ownerDocument
,
888 win
= doc
.parentWindow
|| doc
.defaultView
,
889 style
= win
&& win
.getComputedStyle
?
890 win
.getComputedStyle( el
, null ) :
893 top
= parseFloat( style
? style
.borderTopWidth
: $el
.css( 'borderTopWidth' ) ) || 0,
894 left
= parseFloat( style
? style
.borderLeftWidth
: $el
.css( 'borderLeftWidth' ) ) || 0,
895 bottom
= parseFloat( style
? style
.borderBottomWidth
: $el
.css( 'borderBottomWidth' ) ) || 0,
896 right
= parseFloat( style
? style
.borderRightWidth
: $el
.css( 'borderRightWidth' ) ) || 0;
899 top
: Math
.round( top
),
900 left
: Math
.round( left
),
901 bottom
: Math
.round( bottom
),
902 right
: Math
.round( right
)
907 * Get dimensions of an element or window.
910 * @param {HTMLElement|Window} el Element to measure
911 * @return {Object} Dimensions object with `borders`, `scroll`, `scrollbar` and `rect` properties
913 OO
.ui
.Element
.getDimensions = function ( el
) {
915 doc
= el
.ownerDocument
|| el
.document
,
916 win
= doc
.parentWindow
|| doc
.defaultView
;
918 if ( win
=== el
|| el
=== doc
.documentElement
) {
921 borders
: { top
: 0, left
: 0, bottom
: 0, right
: 0 },
923 top
: $win
.scrollTop(),
924 left
: $win
.scrollLeft()
926 scrollbar
: { right
: 0, bottom
: 0 },
930 bottom
: $win
.innerHeight(),
931 right
: $win
.innerWidth()
937 borders
: this.getBorders( el
),
939 top
: $el
.scrollTop(),
940 left
: $el
.scrollLeft()
943 right
: $el
.innerWidth() - el
.clientWidth
,
944 bottom
: $el
.innerHeight() - el
.clientHeight
946 rect
: el
.getBoundingClientRect()
952 * Get closest scrollable container.
954 * Traverses up until either a scrollable element or the root is reached, in which case the window
958 * @param {HTMLElement} el Element to find scrollable container for
959 * @param {string} [dimension] Dimension of scrolling to look for; `x`, `y` or omit for either
960 * @return {HTMLElement} Closest scrollable container
962 OO
.ui
.Element
.getClosestScrollableContainer = function ( el
, dimension
) {
964 props
= [ 'overflow' ],
965 $parent
= $( el
).parent();
967 if ( dimension
=== 'x' || dimension
=== 'y' ) {
968 props
.push( 'overflow-' + dimension
);
971 while ( $parent
.length
) {
972 if ( $parent
[0] === el
.ownerDocument
.body
) {
977 val
= $parent
.css( props
[i
] );
978 if ( val
=== 'auto' || val
=== 'scroll' ) {
982 $parent
= $parent
.parent();
984 return this.getDocument( el
).body
;
988 * Scroll element into view.
991 * @param {HTMLElement} el Element to scroll into view
992 * @param {Object} [config={}] Configuration config
993 * @param {string} [config.duration] jQuery animation duration value
994 * @param {string} [config.direction] Scroll in only one direction, e.g. 'x' or 'y', omit
995 * to scroll in both directions
996 * @param {Function} [config.complete] Function to call when scrolling completes
998 OO
.ui
.Element
.scrollIntoView = function ( el
, config
) {
999 // Configuration initialization
1000 config
= config
|| {};
1003 callback
= typeof config
.complete
=== 'function' && config
.complete
,
1004 sc
= this.getClosestScrollableContainer( el
, config
.direction
),
1006 eld
= this.getDimensions( el
),
1007 scd
= this.getDimensions( sc
),
1008 $win
= $( this.getWindow( el
) );
1010 // Compute the distances between the edges of el and the edges of the scroll viewport
1011 if ( $sc
.is( 'body' ) ) {
1012 // If the scrollable container is the <body> this is easy
1015 bottom
: $win
.innerHeight() - eld
.rect
.bottom
,
1016 left
: eld
.rect
.left
,
1017 right
: $win
.innerWidth() - eld
.rect
.right
1020 // Otherwise, we have to subtract el's coordinates from sc's coordinates
1022 top
: eld
.rect
.top
- ( scd
.rect
.top
+ scd
.borders
.top
),
1023 bottom
: scd
.rect
.bottom
- scd
.borders
.bottom
- scd
.scrollbar
.bottom
- eld
.rect
.bottom
,
1024 left
: eld
.rect
.left
- ( scd
.rect
.left
+ scd
.borders
.left
),
1025 right
: scd
.rect
.right
- scd
.borders
.right
- scd
.scrollbar
.right
- eld
.rect
.right
1029 if ( !config
.direction
|| config
.direction
=== 'y' ) {
1030 if ( rel
.top
< 0 ) {
1031 anim
.scrollTop
= scd
.scroll
.top
+ rel
.top
;
1032 } else if ( rel
.top
> 0 && rel
.bottom
< 0 ) {
1033 anim
.scrollTop
= scd
.scroll
.top
+ Math
.min( rel
.top
, -rel
.bottom
);
1036 if ( !config
.direction
|| config
.direction
=== 'x' ) {
1037 if ( rel
.left
< 0 ) {
1038 anim
.scrollLeft
= scd
.scroll
.left
+ rel
.left
;
1039 } else if ( rel
.left
> 0 && rel
.right
< 0 ) {
1040 anim
.scrollLeft
= scd
.scroll
.left
+ Math
.min( rel
.left
, -rel
.right
);
1043 if ( !$.isEmptyObject( anim
) ) {
1044 $sc
.stop( true ).animate( anim
, config
.duration
|| 'fast' );
1046 $sc
.queue( function ( next
) {
1061 * Update the theme-provided classes.
1063 * @localdoc This is called in element mixins and widget classes anytime state changes.
1064 * Updating is debounced, minimizing overhead of changing multiple attributes and
1065 * guaranteeing that theme updates do not occur within an element's constructor
1067 OO
.ui
.Element
.prototype.updateThemeClasses = function () {
1068 if ( !this.updateThemeClassesPending
) {
1069 this.updateThemeClassesPending
= true;
1070 setTimeout( this.debouncedUpdateThemeClassesHandler
);
1077 OO
.ui
.Element
.prototype.debouncedUpdateThemeClasses = function () {
1078 OO
.ui
.theme
.updateElementClasses( this );
1079 this.updateThemeClassesPending
= false;
1083 * Get the HTML tag name.
1085 * Override this method to base the result on instance information.
1087 * @return {string} HTML tag name
1089 OO
.ui
.Element
.prototype.getTagName = function () {
1090 return this.constructor.static.tagName
;
1094 * Check if the element is attached to the DOM
1095 * @return {boolean} The element is attached to the DOM
1097 OO
.ui
.Element
.prototype.isElementAttached = function () {
1098 return $.contains( this.getElementDocument(), this.$element
[0] );
1102 * Get the DOM document.
1104 * @return {HTMLDocument} Document object
1106 OO
.ui
.Element
.prototype.getElementDocument = function () {
1107 return OO
.ui
.Element
.getDocument( this.$element
);
1111 * Get the DOM window.
1113 * @return {Window} Window object
1115 OO
.ui
.Element
.prototype.getElementWindow = function () {
1116 return OO
.ui
.Element
.getWindow( this.$element
);
1120 * Get closest scrollable container.
1122 OO
.ui
.Element
.prototype.getClosestScrollableElementContainer = function () {
1123 return OO
.ui
.Element
.getClosestScrollableContainer( this.$element
[0] );
1127 * Get group element is in.
1129 * @return {OO.ui.GroupElement|null} Group element, null if none
1131 OO
.ui
.Element
.prototype.getElementGroup = function () {
1132 return this.elementGroup
;
1136 * Set group element is in.
1138 * @param {OO.ui.GroupElement|null} group Group element, null if none
1141 OO
.ui
.Element
.prototype.setElementGroup = function ( group
) {
1142 this.elementGroup
= group
;
1147 * Scroll element into view.
1149 * @param {Object} [config={}]
1151 OO
.ui
.Element
.prototype.scrollElementIntoView = function ( config
) {
1152 return OO
.ui
.Element
.scrollIntoView( this.$element
[0], config
);
1156 * Bind a handler for an event on this.$element
1158 * @deprecated Use jQuery#on instead.
1159 * @param {string} event
1160 * @param {Function} callback
1162 OO
.ui
.Element
.prototype.onDOMEvent = function ( event
, callback
) {
1163 OO
.ui
.Element
.onDOMEvent( this.$element
, event
, callback
);
1167 * Unbind a handler bound with #offDOMEvent
1169 * @deprecated Use jQuery#off instead.
1170 * @param {string} event
1171 * @param {Function} callback
1173 OO
.ui
.Element
.prototype.offDOMEvent = function ( event
, callback
) {
1174 OO
.ui
.Element
.offDOMEvent( this.$element
, event
, callback
);
1179 * Bind a handler for an event on a DOM element.
1181 * Used to be for working around a jQuery bug (jqbug.com/14180),
1182 * but obsolete as of jQuery 1.11.0.
1185 * @deprecated Use jQuery#on instead.
1186 * @param {HTMLElement|jQuery} el DOM element
1187 * @param {string} event Event to bind
1188 * @param {Function} callback Callback to call when the event fires
1190 OO
.ui
.Element
.onDOMEvent = function ( el
, event
, callback
) {
1191 $( el
).on( event
, callback
);
1195 * Unbind a handler bound with #static-method-onDOMEvent.
1197 * @deprecated Use jQuery#off instead.
1199 * @param {HTMLElement|jQuery} el DOM element
1200 * @param {string} event Event to unbind
1201 * @param {Function} [callback] Callback to unbind
1203 OO
.ui
.Element
.offDOMEvent = function ( el
, event
, callback
) {
1204 $( el
).off( event
, callback
);
1209 * Container for elements.
1213 * @extends OO.ui.Element
1214 * @mixins OO.EventEmitter
1217 * @param {Object} [config] Configuration options
1219 OO
.ui
.Layout
= function OoUiLayout( config
) {
1220 // Initialize config
1221 config
= config
|| {};
1223 // Parent constructor
1224 OO
.ui
.Layout
.super.call( this, config
);
1226 // Mixin constructors
1227 OO
.EventEmitter
.call( this );
1230 this.$element
.addClass( 'oo-ui-layout' );
1235 OO
.inheritClass( OO
.ui
.Layout
, OO
.ui
.Element
);
1236 OO
.mixinClass( OO
.ui
.Layout
, OO
.EventEmitter
);
1239 * User interface control.
1243 * @extends OO.ui.Element
1244 * @mixins OO.EventEmitter
1247 * @param {Object} [config] Configuration options
1248 * @cfg {boolean} [disabled=false] Disable
1250 OO
.ui
.Widget
= function OoUiWidget( config
) {
1251 // Initialize config
1252 config
= $.extend( { disabled
: false }, config
);
1254 // Parent constructor
1255 OO
.ui
.Widget
.super.call( this, config
);
1257 // Mixin constructors
1258 OO
.EventEmitter
.call( this );
1261 this.visible
= true;
1262 this.disabled
= null;
1263 this.wasDisabled
= null;
1266 this.$element
.addClass( 'oo-ui-widget' );
1267 this.setDisabled( !!config
.disabled
);
1272 OO
.inheritClass( OO
.ui
.Widget
, OO
.ui
.Element
);
1273 OO
.mixinClass( OO
.ui
.Widget
, OO
.EventEmitter
);
1279 * @param {boolean} disabled Widget is disabled
1284 * @param {boolean} visible Widget is visible
1290 * Check if the widget is disabled.
1292 * @param {boolean} Button is disabled
1294 OO
.ui
.Widget
.prototype.isDisabled = function () {
1295 return this.disabled
;
1299 * Check if widget is visible.
1301 * @return {boolean} Widget is visible
1303 OO
.ui
.Widget
.prototype.isVisible = function () {
1304 return this.visible
;
1308 * Set the disabled state of the widget.
1310 * This should probably change the widgets' appearance and prevent it from being used.
1312 * @param {boolean} disabled Disable widget
1315 OO
.ui
.Widget
.prototype.setDisabled = function ( disabled
) {
1318 this.disabled
= !!disabled
;
1319 isDisabled
= this.isDisabled();
1320 if ( isDisabled
!== this.wasDisabled
) {
1321 this.$element
.toggleClass( 'oo-ui-widget-disabled', isDisabled
);
1322 this.$element
.toggleClass( 'oo-ui-widget-enabled', !isDisabled
);
1323 this.emit( 'disable', isDisabled
);
1324 this.updateThemeClasses();
1326 this.wasDisabled
= isDisabled
;
1332 * Toggle visibility of widget.
1334 * @param {boolean} [show] Make widget visible, omit to toggle visibility
1338 OO
.ui
.Widget
.prototype.toggle = function ( show
) {
1339 show
= show
=== undefined ? !this.visible
: !!show
;
1341 if ( show
!== this.isVisible() ) {
1342 this.visible
= show
;
1343 this.$element
.toggle( show
);
1344 this.emit( 'toggle', show
);
1351 * Update the disabled state, in case of changes in parent widget.
1355 OO
.ui
.Widget
.prototype.updateDisabled = function () {
1356 this.setDisabled( this.disabled
);
1361 * Container for elements in a child frame.
1363 * Use together with OO.ui.WindowManager.
1367 * @extends OO.ui.Element
1368 * @mixins OO.EventEmitter
1370 * When a window is opened, the setup and ready processes are executed. Similarly, the hold and
1371 * teardown processes are executed when the window is closed.
1373 * - {@link OO.ui.WindowManager#openWindow} or {@link #open} methods are used to start opening
1374 * - Window manager begins opening window
1375 * - {@link #getSetupProcess} method is called and its result executed
1376 * - {@link #getReadyProcess} method is called and its result executed
1377 * - Window is now open
1379 * - {@link OO.ui.WindowManager#closeWindow} or {@link #close} methods are used to start closing
1380 * - Window manager begins closing window
1381 * - {@link #getHoldProcess} method is called and its result executed
1382 * - {@link #getTeardownProcess} method is called and its result executed
1383 * - Window is now closed
1385 * Each process (setup, ready, hold and teardown) can be extended in subclasses by overriding
1386 * {@link #getSetupProcess}, {@link #getReadyProcess}, {@link #getHoldProcess} and
1387 * {@link #getTeardownProcess} respectively. Each process is executed in series, so asynchonous
1388 * processing can complete. Always assume window processes are executed asychronously. See
1389 * OO.ui.Process for more details about how to work with processes. Some events, as well as the
1390 * #open and #close methods, provide promises which are resolved when the window enters a new state.
1392 * Sizing of windows is specified using symbolic names which are interpreted by the window manager.
1393 * If the requested size is not recognized, the window manager will choose a sensible fallback.
1396 * @param {Object} [config] Configuration options
1397 * @cfg {string} [size] Symbolic name of dialog size, `small`, `medium`, `large` or `full`; omit to
1401 OO
.ui
.Window
= function OoUiWindow( config
) {
1402 // Configuration initialization
1403 config
= config
|| {};
1405 // Parent constructor
1406 OO
.ui
.Window
.super.call( this, config
);
1408 // Mixin constructors
1409 OO
.EventEmitter
.call( this );
1412 this.manager
= null;
1413 this.initialized
= false;
1414 this.visible
= false;
1415 this.opening
= null;
1416 this.closing
= null;
1419 this.loading
= null;
1420 this.size
= config
.size
|| this.constructor.static.size
;
1421 this.$frame
= this.$( '<div>' );
1425 .addClass( 'oo-ui-window' )
1426 .append( this.$frame
);
1427 this.$frame
.addClass( 'oo-ui-window-frame' );
1429 // NOTE: Additional intitialization will occur when #setManager is called
1434 OO
.inheritClass( OO
.ui
.Window
, OO
.ui
.Element
);
1435 OO
.mixinClass( OO
.ui
.Window
, OO
.EventEmitter
);
1437 /* Static Properties */
1440 * Symbolic name of size.
1442 * Size is used if no size is configured during construction.
1446 * @property {string}
1448 OO
.ui
.Window
.static.size
= 'medium';
1450 /* Static Methods */
1453 * Transplant the CSS styles from as parent document to a frame's document.
1455 * This loops over the style sheets in the parent document, and copies their nodes to the
1456 * frame's document. It then polls the document to see when all styles have loaded, and once they
1457 * have, resolves the promise.
1459 * If the styles still haven't loaded after a long time (5 seconds by default), we give up waiting
1460 * and resolve the promise anyway. This protects against cases like a display: none; iframe in
1461 * Firefox, where the styles won't load until the iframe becomes visible.
1463 * For details of how we arrived at the strategy used in this function, see #load.
1467 * @param {HTMLDocument} parentDoc Document to transplant styles from
1468 * @param {HTMLDocument} frameDoc Document to transplant styles to
1469 * @param {number} [timeout=5000] How long to wait before giving up (in ms). If 0, never give up.
1470 * @return {jQuery.Promise} Promise resolved when styles have loaded
1472 OO
.ui
.Window
.static.transplantStyles = function ( parentDoc
, frameDoc
, timeout
) {
1473 var i
, numSheets
, styleNode
, styleText
, newNode
, timeoutID
, pollNodeId
, $pendingPollNodes
,
1474 $pollNodes
= $( [] ),
1475 // Fake font-family value
1476 fontFamily
= 'oo-ui-frame-transplantStyles-loaded',
1477 nextIndex
= parentDoc
.oouiFrameTransplantStylesNextIndex
|| 0,
1478 deferred
= $.Deferred();
1480 for ( i
= 0, numSheets
= parentDoc
.styleSheets
.length
; i
< numSheets
; i
++ ) {
1481 styleNode
= parentDoc
.styleSheets
[i
].ownerNode
;
1482 if ( styleNode
.disabled
) {
1486 if ( styleNode
.nodeName
.toLowerCase() === 'link' ) {
1487 // External stylesheet; use @import
1488 styleText
= '@import url(' + styleNode
.href
+ ');';
1490 // Internal stylesheet; just copy the text
1491 // For IE10 we need to fall back to .cssText, BUT that's undefined in
1492 // other browsers, so fall back to '' rather than 'undefined'
1493 styleText
= styleNode
.textContent
|| parentDoc
.styleSheets
[i
].cssText
|| '';
1496 // Create a node with a unique ID that we're going to monitor to see when the CSS
1498 if ( styleNode
.oouiFrameTransplantStylesId
) {
1499 // If we're nesting transplantStyles operations and this node already has
1500 // a CSS rule to wait for loading, reuse it
1501 pollNodeId
= styleNode
.oouiFrameTransplantStylesId
;
1503 // Otherwise, create a new ID
1504 pollNodeId
= 'oo-ui-frame-transplantStyles-loaded-' + nextIndex
;
1507 // Add #pollNodeId { font-family: ... } to the end of the stylesheet / after the @import
1508 // The font-family rule will only take effect once the @import finishes
1509 styleText
+= '\n' + '#' + pollNodeId
+ ' { font-family: ' + fontFamily
+ '; }';
1512 // Create a node with id=pollNodeId
1513 $pollNodes
= $pollNodes
.add( $( '<div>', frameDoc
)
1514 .attr( 'id', pollNodeId
)
1515 .appendTo( frameDoc
.body
)
1518 // Add our modified CSS as a <style> tag
1519 newNode
= frameDoc
.createElement( 'style' );
1520 newNode
.textContent
= styleText
;
1521 newNode
.oouiFrameTransplantStylesId
= pollNodeId
;
1522 frameDoc
.head
.appendChild( newNode
);
1524 frameDoc
.oouiFrameTransplantStylesNextIndex
= nextIndex
;
1526 // Poll every 100ms until all external stylesheets have loaded
1527 $pendingPollNodes
= $pollNodes
;
1528 timeoutID
= setTimeout( function pollExternalStylesheets() {
1530 $pendingPollNodes
.length
> 0 &&
1531 $pendingPollNodes
.eq( 0 ).css( 'font-family' ) === fontFamily
1533 $pendingPollNodes
= $pendingPollNodes
.slice( 1 );
1536 if ( $pendingPollNodes
.length
=== 0 ) {
1538 if ( timeoutID
!== null ) {
1540 $pollNodes
.remove();
1544 timeoutID
= setTimeout( pollExternalStylesheets
, 100 );
1547 // ...but give up after a while
1548 if ( timeout
!== 0 ) {
1549 setTimeout( function () {
1551 clearTimeout( timeoutID
);
1553 $pollNodes
.remove();
1556 }, timeout
|| 5000 );
1559 return deferred
.promise();
1565 * Handle mouse down events.
1567 * @param {jQuery.Event} e Mouse down event
1569 OO
.ui
.Window
.prototype.onMouseDown = function ( e
) {
1570 // Prevent clicking on the click-block from stealing focus
1571 if ( e
.target
=== this.$element
[0] ) {
1577 * Check if window has been initialized.
1579 * @return {boolean} Window has been initialized
1581 OO
.ui
.Window
.prototype.isInitialized = function () {
1582 return this.initialized
;
1586 * Check if window is visible.
1588 * @return {boolean} Window is visible
1590 OO
.ui
.Window
.prototype.isVisible = function () {
1591 return this.visible
;
1595 * Check if window is loading.
1597 * @return {boolean} Window is loading
1599 OO
.ui
.Window
.prototype.isLoading = function () {
1600 return this.loading
&& this.loading
.state() === 'pending';
1604 * Check if window is loaded.
1606 * @return {boolean} Window is loaded
1608 OO
.ui
.Window
.prototype.isLoaded = function () {
1609 return this.loading
&& this.loading
.state() === 'resolved';
1613 * Check if window is opening.
1615 * This is a wrapper around OO.ui.WindowManager#isOpening.
1617 * @return {boolean} Window is opening
1619 OO
.ui
.Window
.prototype.isOpening = function () {
1620 return this.manager
.isOpening( this );
1624 * Check if window is closing.
1626 * This is a wrapper around OO.ui.WindowManager#isClosing.
1628 * @return {boolean} Window is closing
1630 OO
.ui
.Window
.prototype.isClosing = function () {
1631 return this.manager
.isClosing( this );
1635 * Check if window is opened.
1637 * This is a wrapper around OO.ui.WindowManager#isOpened.
1639 * @return {boolean} Window is opened
1641 OO
.ui
.Window
.prototype.isOpened = function () {
1642 return this.manager
.isOpened( this );
1646 * Get the window manager.
1648 * @return {OO.ui.WindowManager} Manager of window
1650 OO
.ui
.Window
.prototype.getManager = function () {
1651 return this.manager
;
1655 * Get the window size.
1657 * @return {string} Symbolic size name, e.g. 'small', 'medium', 'large', 'full'
1659 OO
.ui
.Window
.prototype.getSize = function () {
1664 * Get the height of the dialog contents.
1666 * @return {number} Content height
1668 OO
.ui
.Window
.prototype.getContentHeight = function () {
1669 // Temporarily resize the frame so getBodyHeight() can use scrollHeight measurements
1670 var bodyHeight
, oldHeight
= this.$frame
[0].style
.height
;
1671 this.$frame
[0].style
.height
= '1px';
1672 bodyHeight
= this.getBodyHeight();
1673 this.$frame
[0].style
.height
= oldHeight
;
1676 // Add buffer for border
1677 ( this.$frame
.outerHeight() - this.$frame
.innerHeight() ) +
1678 // Use combined heights of children
1679 ( this.$head
.outerHeight( true ) + bodyHeight
+ this.$foot
.outerHeight( true ) )
1684 * Get the height of the dialog contents.
1686 * When this function is called, the dialog will temporarily have been resized
1687 * to height=1px, so .scrollHeight measurements can be taken accurately.
1689 * @return {number} Height of content
1691 OO
.ui
.Window
.prototype.getBodyHeight = function () {
1692 return this.$body
[0].scrollHeight
;
1696 * Get the directionality of the frame
1698 * @return {string} Directionality, 'ltr' or 'rtl'
1700 OO
.ui
.Window
.prototype.getDir = function () {
1705 * Get a process for setting up a window for use.
1707 * Each time the window is opened this process will set it up for use in a particular context, based
1708 * on the `data` argument.
1710 * When you override this method, you can add additional setup steps to the process the parent
1711 * method provides using the 'first' and 'next' methods.
1714 * @param {Object} [data] Window opening data
1715 * @return {OO.ui.Process} Setup process
1717 OO
.ui
.Window
.prototype.getSetupProcess = function () {
1718 return new OO
.ui
.Process();
1722 * Get a process for readying a window for use.
1724 * Each time the window is open and setup, this process will ready it up for use in a particular
1725 * context, based on the `data` argument.
1727 * When you override this method, you can add additional setup steps to the process the parent
1728 * method provides using the 'first' and 'next' methods.
1731 * @param {Object} [data] Window opening data
1732 * @return {OO.ui.Process} Setup process
1734 OO
.ui
.Window
.prototype.getReadyProcess = function () {
1735 return new OO
.ui
.Process();
1739 * Get a process for holding a window from use.
1741 * Each time the window is closed, this process will hold it from use in a particular context, based
1742 * on the `data` argument.
1744 * When you override this method, you can add additional setup steps to the process the parent
1745 * method provides using the 'first' and 'next' methods.
1748 * @param {Object} [data] Window closing data
1749 * @return {OO.ui.Process} Hold process
1751 OO
.ui
.Window
.prototype.getHoldProcess = function () {
1752 return new OO
.ui
.Process();
1756 * Get a process for tearing down a window after use.
1758 * Each time the window is closed this process will tear it down and do something with the user's
1759 * interactions within the window, based on the `data` argument.
1761 * When you override this method, you can add additional teardown steps to the process the parent
1762 * method provides using the 'first' and 'next' methods.
1765 * @param {Object} [data] Window closing data
1766 * @return {OO.ui.Process} Teardown process
1768 OO
.ui
.Window
.prototype.getTeardownProcess = function () {
1769 return new OO
.ui
.Process();
1773 * Toggle visibility of window.
1775 * If the window is isolated and hasn't fully loaded yet, the visiblity property will be used
1776 * instead of display.
1778 * @param {boolean} [show] Make window visible, omit to toggle visibility
1782 OO
.ui
.Window
.prototype.toggle = function ( show
) {
1783 show
= show
=== undefined ? !this.visible
: !!show
;
1785 if ( show
!== this.isVisible() ) {
1786 this.visible
= show
;
1788 if ( this.isolated
&& !this.isLoaded() ) {
1789 // Hide the window using visibility instead of display until loading is complete
1790 // Can't use display: none; because that prevents the iframe from loading in Firefox
1791 this.$element
.css( 'visibility', show
? 'visible' : 'hidden' );
1793 this.$element
.toggle( show
).css( 'visibility', '' );
1795 this.emit( 'toggle', show
);
1802 * Set the window manager.
1804 * This must be called before initialize. Calling it more than once will cause an error.
1806 * @param {OO.ui.WindowManager} manager Manager for this window
1807 * @throws {Error} If called more than once
1810 OO
.ui
.Window
.prototype.setManager = function ( manager
) {
1811 if ( this.manager
) {
1812 throw new Error( 'Cannot set window manager, window already has a manager' );
1816 this.manager
= manager
;
1817 this.isolated
= manager
.shouldIsolate();
1820 if ( this.isolated
) {
1821 this.$iframe
= this.$( '<iframe>' );
1822 this.$iframe
.attr( { frameborder
: 0, scrolling
: 'no' } );
1823 this.$frame
.append( this.$iframe
);
1824 this.$ = function () {
1825 throw new Error( 'this.$() cannot be used until the frame has been initialized.' );
1827 // WARNING: Do not use this.$ again until #initialize is called
1829 this.$content
= this.$( '<div>' );
1830 this.$document
= $( this.getElementDocument() );
1831 this.$content
.addClass( 'oo-ui-window-content' );
1832 this.$frame
.append( this.$content
);
1834 this.toggle( false );
1836 // Figure out directionality:
1837 this.dir
= OO
.ui
.Element
.getDir( this.$iframe
|| this.$content
) || 'ltr';
1843 * Set the window size.
1845 * @param {string} size Symbolic size name, e.g. 'small', 'medium', 'large', 'full'
1848 OO
.ui
.Window
.prototype.setSize = function ( size
) {
1850 this.manager
.updateWindowSize( this );
1855 * Set window dimensions.
1857 * Properties are applied to the frame container.
1859 * @param {Object} dim CSS dimension properties
1860 * @param {string|number} [dim.width] Width
1861 * @param {string|number} [dim.minWidth] Minimum width
1862 * @param {string|number} [dim.maxWidth] Maximum width
1863 * @param {string|number} [dim.width] Height, omit to set based on height of contents
1864 * @param {string|number} [dim.minWidth] Minimum height
1865 * @param {string|number} [dim.maxWidth] Maximum height
1868 OO
.ui
.Window
.prototype.setDimensions = function ( dim
) {
1869 // Apply width before height so height is not based on wrapping content using the wrong width
1871 width
: dim
.width
|| '',
1872 minWidth
: dim
.minWidth
|| '',
1873 maxWidth
: dim
.maxWidth
|| ''
1876 height
: ( dim
.height
!== undefined ? dim
.height
: this.getContentHeight() ) || '',
1877 minHeight
: dim
.minHeight
|| '',
1878 maxHeight
: dim
.maxHeight
|| ''
1884 * Initialize window contents.
1886 * The first time the window is opened, #initialize is called when it's safe to begin populating
1887 * its contents. See #getSetupProcess for a way to make changes each time the window opens.
1889 * Once this method is called, this.$ can be used to create elements within the frame.
1891 * @throws {Error} If not attached to a manager
1894 OO
.ui
.Window
.prototype.initialize = function () {
1895 if ( !this.manager
) {
1896 throw new Error( 'Cannot initialize window, must be attached to a manager' );
1900 this.$head
= this.$( '<div>' );
1901 this.$body
= this.$( '<div>' );
1902 this.$foot
= this.$( '<div>' );
1903 this.$overlay
= this.$( '<div>' );
1904 this.$focusTrap
= this.$( '<div>' ).prop( 'tabIndex', 0 );
1907 this.$element
.on( 'mousedown', OO
.ui
.bind( this.onMouseDown
, this ) );
1910 this.$head
.addClass( 'oo-ui-window-head' );
1911 this.$body
.addClass( 'oo-ui-window-body' );
1912 this.$foot
.addClass( 'oo-ui-window-foot' );
1913 this.$overlay
.addClass( 'oo-ui-window-overlay' );
1914 this.$focusTrap
.addClass( 'oo-ui-window-focustrap' );
1915 this.$content
.append( this.$head
, this.$body
, this.$foot
, this.$overlay
, this.$focusTrap
);
1921 * Called when someone tries to focus the hidden element at the end of the dialog.
1922 * Sends focus back to the start of the dialog.
1924 OO
.ui
.Window
.prototype.onFocusTrapFocused = function () {
1925 this.$content
.find( ':focusable:first' ).focus();
1931 * This is a wrapper around calling {@link OO.ui.WindowManager#openWindow} on the window manager.
1932 * To do something each time the window opens, use #getSetupProcess or #getReadyProcess.
1934 * @param {Object} [data] Window opening data
1935 * @return {jQuery.Promise} Promise resolved when window is opened; when the promise is resolved the
1936 * first argument will be a promise which will be resolved when the window begins closing
1938 OO
.ui
.Window
.prototype.open = function ( data
) {
1939 return this.manager
.openWindow( this, data
);
1945 * This is a wrapper around calling OO.ui.WindowManager#closeWindow on the window manager.
1946 * To do something each time the window closes, use #getHoldProcess or #getTeardownProcess.
1948 * @param {Object} [data] Window closing data
1949 * @return {jQuery.Promise} Promise resolved when window is closed
1951 OO
.ui
.Window
.prototype.close = function ( data
) {
1952 return this.manager
.closeWindow( this, data
);
1958 * This is called by OO.ui.WindowManager durring window opening, and should not be called directly
1961 * @param {Object} [data] Window opening data
1962 * @return {jQuery.Promise} Promise resolved when window is setup
1964 OO
.ui
.Window
.prototype.setup = function ( data
) {
1966 deferred
= $.Deferred();
1968 this.$element
.show();
1969 this.visible
= true;
1970 this.focusTrapHandler
= OO
.ui
.bind( this.onFocusTrapFocused
, this );
1971 this.$focusTrap
.on( 'focus', this.focusTrapHandler
);
1972 this.getSetupProcess( data
).execute().done( function () {
1973 // Force redraw by asking the browser to measure the elements' widths
1974 win
.$element
.addClass( 'oo-ui-window-setup' ).width();
1975 win
.$content
.addClass( 'oo-ui-window-content-setup' ).width();
1979 return deferred
.promise();
1985 * This is called by OO.ui.WindowManager durring window opening, and should not be called directly
1988 * @param {Object} [data] Window opening data
1989 * @return {jQuery.Promise} Promise resolved when window is ready
1991 OO
.ui
.Window
.prototype.ready = function ( data
) {
1993 deferred
= $.Deferred();
1995 this.$content
.focus();
1996 this.getReadyProcess( data
).execute().done( function () {
1997 // Force redraw by asking the browser to measure the elements' widths
1998 win
.$element
.addClass( 'oo-ui-window-ready' ).width();
1999 win
.$content
.addClass( 'oo-ui-window-content-ready' ).width();
2003 return deferred
.promise();
2009 * This is called by OO.ui.WindowManager durring window closing, and should not be called directly
2012 * @param {Object} [data] Window closing data
2013 * @return {jQuery.Promise} Promise resolved when window is held
2015 OO
.ui
.Window
.prototype.hold = function ( data
) {
2017 deferred
= $.Deferred();
2019 this.getHoldProcess( data
).execute().done( function () {
2020 // Get the focused element within the window's content
2021 var $focus
= win
.$content
.find( OO
.ui
.Element
.getDocument( win
.$content
).activeElement
);
2023 // Blur the focused element
2024 if ( $focus
.length
) {
2028 // Force redraw by asking the browser to measure the elements' widths
2029 win
.$element
.removeClass( 'oo-ui-window-ready' ).width();
2030 win
.$content
.removeClass( 'oo-ui-window-content-ready' ).width();
2034 return deferred
.promise();
2040 * This is called by OO.ui.WindowManager durring window closing, and should not be called directly
2043 * @param {Object} [data] Window closing data
2044 * @return {jQuery.Promise} Promise resolved when window is torn down
2046 OO
.ui
.Window
.prototype.teardown = function ( data
) {
2048 deferred
= $.Deferred();
2050 this.getTeardownProcess( data
).execute().done( OO
.ui
.bind( function () {
2051 // Force redraw by asking the browser to measure the elements' widths
2052 win
.$element
.removeClass( 'oo-ui-window-setup' ).width();
2053 win
.$content
.removeClass( 'oo-ui-window-content-setup' ).width();
2054 win
.$element
.hide();
2055 this.$focusTrap
.off( 'focus', this.focusTrapHandler
);
2056 win
.visible
= false;
2060 return deferred
.promise();
2064 * Load the frame contents.
2066 * Once the iframe's stylesheets are loaded, the `load` event will be emitted and the returned
2067 * promise will be resolved. Calling while loading will return a promise but not trigger a new
2068 * loading cycle. Calling after loading is complete will return a promise that's already been
2071 * Sounds simple right? Read on...
2073 * When you create a dynamic iframe using open/write/close, the window.load event for the
2074 * iframe is triggered when you call close, and there's no further load event to indicate that
2075 * everything is actually loaded.
2077 * In Chrome, stylesheets don't show up in document.styleSheets until they have loaded, so we could
2078 * just poll that array and wait for it to have the right length. However, in Firefox, stylesheets
2079 * are added to document.styleSheets immediately, and the only way you can determine whether they've
2080 * loaded is to attempt to access .cssRules and wait for that to stop throwing an exception. But
2081 * cross-domain stylesheets never allow .cssRules to be accessed even after they have loaded.
2083 * The workaround is to change all `<link href="...">` tags to `<style>@import url(...)</style>`
2084 * tags. Because `@import` is blocking, Chrome won't add the stylesheet to document.styleSheets
2085 * until the `@import` has finished, and Firefox won't allow .cssRules to be accessed until the
2086 * `@import` has finished. And because the contents of the `<style>` tag are from the same origin,
2087 * accessing .cssRules is allowed.
2089 * However, now that we control the styles we're injecting, we might as well do away with
2090 * browser-specific polling hacks like document.styleSheets and .cssRules, and instead inject
2091 * `<style>@import url(...); #foo { font-family: someValue; }</style>`, then create `<div id="foo">`
2092 * and wait for its font-family to change to someValue. Because `@import` is blocking, the
2093 * font-family rule is not applied until after the `@import` finishes.
2095 * All this stylesheet injection and polling magic is in #transplantStyles.
2097 * @return {jQuery.Promise} Promise resolved when loading is complete
2100 OO
.ui
.Window
.prototype.load = function () {
2101 var sub
, doc
, loading
,
2104 // Non-isolated windows are already "loaded"
2105 if ( !this.loading
&& !this.isolated
) {
2106 this.loading
= $.Deferred().resolve();
2108 // Set initialized state after so sub-classes aren't confused by it being set by calling
2109 // their parent initialize method
2110 this.initialized
= true;
2113 // Return existing promise if already loading or loaded
2114 if ( this.loading
) {
2115 return this.loading
.promise();
2119 loading
= this.loading
= $.Deferred();
2120 sub
= this.$iframe
.prop( 'contentWindow' );
2123 // Initialize contents
2128 '<body class="oo-ui-window-isolated oo-ui-' + this.dir
+ '"' +
2129 ' style="direction:' + this.dir
+ ';" dir="' + this.dir
+ '">' +
2130 '<div class="oo-ui-window-content"></div>' +
2137 this.$ = OO
.ui
.Element
.getJQuery( doc
, this.$iframe
);
2138 this.$content
= this.$( '.oo-ui-window-content' ).attr( 'tabIndex', 0 );
2139 this.$document
= this.$( doc
);
2142 this.constructor.static.transplantStyles( this.getElementDocument(), this.$document
[0] )
2143 .always( function () {
2144 // Initialize isolated windows
2146 // Set initialized state after so sub-classes aren't confused by it being set by calling
2147 // their parent initialize method
2148 win
.initialized
= true;
2149 // Undo the visibility: hidden; hack and apply display: none;
2150 // We can do this safely now that the iframe has initialized
2151 // (don't do this from within #initialize because it has to happen
2152 // after the all subclasses have been handled as well).
2153 win
.toggle( win
.isVisible() );
2158 return loading
.promise();
2162 * Base class for all dialogs.
2165 * - Manage the window (open and close, etc.).
2166 * - Store the internal name and display title.
2167 * - A stack to track one or more pending actions.
2168 * - Manage a set of actions that can be performed.
2169 * - Configure and create action widgets.
2172 * - Close the dialog with Escape key.
2173 * - Visually lock the dialog while an action is in
2174 * progress (aka "pending").
2176 * Subclass responsibilities:
2177 * - Display the title somewhere.
2178 * - Add content to the dialog.
2179 * - Provide a UI to close the dialog.
2180 * - Display the action widgets somewhere.
2184 * @extends OO.ui.Window
2185 * @mixins OO.ui.PendingElement
2188 * @param {Object} [config] Configuration options
2190 OO
.ui
.Dialog
= function OoUiDialog( config
) {
2191 // Parent constructor
2192 OO
.ui
.Dialog
.super.call( this, config
);
2194 // Mixin constructors
2195 OO
.ui
.PendingElement
.call( this );
2198 this.actions
= new OO
.ui
.ActionSet();
2199 this.attachedActions
= [];
2200 this.currentAction
= null;
2203 this.actions
.connect( this, {
2204 click
: 'onActionClick',
2205 resize
: 'onActionResize',
2206 change
: 'onActionsChange'
2211 .addClass( 'oo-ui-dialog' )
2212 .attr( 'role', 'dialog' );
2217 OO
.inheritClass( OO
.ui
.Dialog
, OO
.ui
.Window
);
2218 OO
.mixinClass( OO
.ui
.Dialog
, OO
.ui
.PendingElement
);
2220 /* Static Properties */
2223 * Symbolic name of dialog.
2228 * @property {string}
2230 OO
.ui
.Dialog
.static.name
= '';
2238 * @property {jQuery|string|Function} Label nodes, text or a function that returns nodes or text
2240 OO
.ui
.Dialog
.static.title
= '';
2243 * List of OO.ui.ActionWidget configuration options.
2247 * @property {Object[]}
2249 OO
.ui
.Dialog
.static.actions
= [];
2252 * Close dialog when the escape key is pressed.
2257 * @property {boolean}
2259 OO
.ui
.Dialog
.static.escapable
= true;
2264 * Handle frame document key down events.
2266 * @param {jQuery.Event} e Key down event
2268 OO
.ui
.Dialog
.prototype.onDocumentKeyDown = function ( e
) {
2269 if ( e
.which
=== OO
.ui
.Keys
.ESCAPE
) {
2276 * Handle action resized events.
2278 * @param {OO.ui.ActionWidget} action Action that was resized
2280 OO
.ui
.Dialog
.prototype.onActionResize = function () {
2281 // Override in subclass
2285 * Handle action click events.
2287 * @param {OO.ui.ActionWidget} action Action that was clicked
2289 OO
.ui
.Dialog
.prototype.onActionClick = function ( action
) {
2290 if ( !this.isPending() ) {
2291 this.currentAction
= action
;
2292 this.executeAction( action
.getAction() );
2297 * Handle actions change event.
2299 OO
.ui
.Dialog
.prototype.onActionsChange = function () {
2300 this.detachActions();
2301 if ( !this.isClosing() ) {
2302 this.attachActions();
2307 * Get set of actions.
2309 * @return {OO.ui.ActionSet}
2311 OO
.ui
.Dialog
.prototype.getActions = function () {
2312 return this.actions
;
2316 * Get a process for taking action.
2318 * When you override this method, you can add additional accept steps to the process the parent
2319 * method provides using the 'first' and 'next' methods.
2322 * @param {string} [action] Symbolic name of action
2323 * @return {OO.ui.Process} Action process
2325 OO
.ui
.Dialog
.prototype.getActionProcess = function ( action
) {
2326 return new OO
.ui
.Process()
2327 .next( function () {
2329 // An empty action always closes the dialog without data, which should always be
2330 // safe and make no changes
2339 * @param {Object} [data] Dialog opening data
2340 * @param {jQuery|string|Function|null} [data.title] Dialog title, omit to use #static-title
2341 * @param {Object[]} [data.actions] List of OO.ui.ActionWidget configuration options for each
2342 * action item, omit to use #static-actions
2344 OO
.ui
.Dialog
.prototype.getSetupProcess = function ( data
) {
2348 return OO
.ui
.Dialog
.super.prototype.getSetupProcess
.call( this, data
)
2349 .next( function () {
2352 config
= this.constructor.static,
2353 actions
= data
.actions
!== undefined ? data
.actions
: config
.actions
;
2355 this.title
.setLabel(
2356 data
.title
!== undefined ? data
.title
: this.constructor.static.title
2358 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
2360 new OO
.ui
.ActionWidget( $.extend( { $: this.$ }, actions
[i
] ) )
2363 this.actions
.add( items
);
2370 OO
.ui
.Dialog
.prototype.getTeardownProcess = function ( data
) {
2372 return OO
.ui
.Dialog
.super.prototype.getTeardownProcess
.call( this, data
)
2373 .first( function () {
2374 this.actions
.clear();
2375 this.currentAction
= null;
2382 OO
.ui
.Dialog
.prototype.initialize = function () {
2384 OO
.ui
.Dialog
.super.prototype.initialize
.call( this );
2387 this.title
= new OO
.ui
.LabelWidget( { $: this.$ } );
2390 if ( this.constructor.static.escapable
) {
2391 this.$document
.on( 'keydown', OO
.ui
.bind( this.onDocumentKeyDown
, this ) );
2395 this.$content
.addClass( 'oo-ui-dialog-content' );
2396 this.setPendingElement( this.$head
);
2400 * Attach action actions.
2402 OO
.ui
.Dialog
.prototype.attachActions = function () {
2403 // Remember the list of potentially attached actions
2404 this.attachedActions
= this.actions
.get();
2408 * Detach action actions.
2412 OO
.ui
.Dialog
.prototype.detachActions = function () {
2415 // Detach all actions that may have been previously attached
2416 for ( i
= 0, len
= this.attachedActions
.length
; i
< len
; i
++ ) {
2417 this.attachedActions
[i
].$element
.detach();
2419 this.attachedActions
= [];
2423 * Execute an action.
2425 * @param {string} action Symbolic name of action to execute
2426 * @return {jQuery.Promise} Promise resolved when action completes, rejected if it fails
2428 OO
.ui
.Dialog
.prototype.executeAction = function ( action
) {
2430 return this.getActionProcess( action
).execute()
2431 .always( OO
.ui
.bind( this.popPending
, this ) );
2435 * Collection of windows.
2438 * @extends OO.ui.Element
2439 * @mixins OO.EventEmitter
2441 * Managed windows are mutually exclusive. If a window is opened while there is a current window
2442 * already opening or opened, the current window will be closed without data. Empty closing data
2443 * should always result in the window being closed without causing constructive or destructive
2446 * As a window is opened and closed, it passes through several stages and the manager emits several
2447 * corresponding events.
2449 * - {@link #openWindow} or {@link OO.ui.Window#open} methods are used to start opening
2450 * - {@link #event-opening} is emitted with `opening` promise
2451 * - {@link #getSetupDelay} is called the returned value is used to time a pause in execution
2452 * - {@link OO.ui.Window#getSetupProcess} method is called on the window and its result executed
2453 * - `setup` progress notification is emitted from opening promise
2454 * - {@link #getReadyDelay} is called the returned value is used to time a pause in execution
2455 * - {@link OO.ui.Window#getReadyProcess} method is called on the window and its result executed
2456 * - `ready` progress notification is emitted from opening promise
2457 * - `opening` promise is resolved with `opened` promise
2458 * - Window is now open
2460 * - {@link #closeWindow} or {@link OO.ui.Window#close} methods are used to start closing
2461 * - `opened` promise is resolved with `closing` promise
2462 * - {@link #event-closing} is emitted with `closing` promise
2463 * - {@link #getHoldDelay} is called the returned value is used to time a pause in execution
2464 * - {@link OO.ui.Window#getHoldProcess} method is called on the window and its result executed
2465 * - `hold` progress notification is emitted from opening promise
2466 * - {@link #getTeardownDelay} is called the returned value is used to time a pause in execution
2467 * - {@link OO.ui.Window#getTeardownProcess} method is called on the window and its result executed
2468 * - `teardown` progress notification is emitted from opening promise
2469 * - Closing promise is resolved
2470 * - Window is now closed
2473 * @param {Object} [config] Configuration options
2474 * @cfg {boolean} [isolate] Configure managed windows to isolate their content using inline frames
2475 * @cfg {OO.Factory} [factory] Window factory to use for automatic instantiation
2476 * @cfg {boolean} [modal=true] Prevent interaction outside the dialog
2478 OO
.ui
.WindowManager
= function OoUiWindowManager( config
) {
2479 // Configuration initialization
2480 config
= config
|| {};
2482 // Parent constructor
2483 OO
.ui
.WindowManager
.super.call( this, config
);
2485 // Mixin constructors
2486 OO
.EventEmitter
.call( this );
2489 this.factory
= config
.factory
;
2490 this.modal
= config
.modal
=== undefined || !!config
.modal
;
2491 this.isolate
= !!config
.isolate
;
2493 this.opening
= null;
2495 this.closing
= null;
2496 this.preparingToOpen
= null;
2497 this.preparingToClose
= null;
2499 this.currentWindow
= null;
2500 this.$ariaHidden
= null;
2501 this.requestedSize
= null;
2502 this.onWindowResizeTimeout
= null;
2503 this.onWindowResizeHandler
= OO
.ui
.bind( this.onWindowResize
, this );
2504 this.afterWindowResizeHandler
= OO
.ui
.bind( this.afterWindowResize
, this );
2505 this.onWindowMouseWheelHandler
= OO
.ui
.bind( this.onWindowMouseWheel
, this );
2506 this.onDocumentKeyDownHandler
= OO
.ui
.bind( this.onDocumentKeyDown
, this );
2510 .addClass( 'oo-ui-windowManager' )
2511 .toggleClass( 'oo-ui-windowManager-modal', this.modal
);
2516 OO
.inheritClass( OO
.ui
.WindowManager
, OO
.ui
.Element
);
2517 OO
.mixinClass( OO
.ui
.WindowManager
, OO
.EventEmitter
);
2522 * Window is opening.
2524 * Fired when the window begins to be opened.
2527 * @param {OO.ui.Window} win Window that's being opened
2528 * @param {jQuery.Promise} opening Promise resolved when window is opened; when the promise is
2529 * resolved the first argument will be a promise which will be resolved when the window begins
2530 * closing, the second argument will be the opening data; progress notifications will be fired on
2531 * the promise for `setup` and `ready` when those processes are completed respectively.
2532 * @param {Object} data Window opening data
2536 * Window is closing.
2538 * Fired when the window begins to be closed.
2541 * @param {OO.ui.Window} win Window that's being closed
2542 * @param {jQuery.Promise} opening Promise resolved when window is closed; when the promise
2543 * is resolved the first argument will be a the closing data; progress notifications will be fired
2544 * on the promise for `hold` and `teardown` when those processes are completed respectively.
2545 * @param {Object} data Window closing data
2549 * Window was resized.
2552 * @param {OO.ui.Window} win Window that was resized
2555 /* Static Properties */
2558 * Map of symbolic size names and CSS properties.
2562 * @property {Object}
2564 OO
.ui
.WindowManager
.static.sizes
= {
2575 // These can be non-numeric because they are never used in calculations
2582 * Symbolic name of default size.
2584 * Default size is used if the window's requested size is not recognized.
2588 * @property {string}
2590 OO
.ui
.WindowManager
.static.defaultSize
= 'medium';
2595 * Handle window resize events.
2597 * @param {jQuery.Event} e Window resize event
2599 OO
.ui
.WindowManager
.prototype.onWindowResize = function () {
2600 clearTimeout( this.onWindowResizeTimeout
);
2601 this.onWindowResizeTimeout
= setTimeout( this.afterWindowResizeHandler
, 200 );
2605 * Handle window resize events.
2607 * @param {jQuery.Event} e Window resize event
2609 OO
.ui
.WindowManager
.prototype.afterWindowResize = function () {
2610 if ( this.currentWindow
) {
2611 this.updateWindowSize( this.currentWindow
);
2616 * Handle window mouse wheel events.
2618 * @param {jQuery.Event} e Mouse wheel event
2620 OO
.ui
.WindowManager
.prototype.onWindowMouseWheel = function () {
2625 * Handle document key down events.
2627 * @param {jQuery.Event} e Key down event
2629 OO
.ui
.WindowManager
.prototype.onDocumentKeyDown = function ( e
) {
2630 switch ( e
.which
) {
2631 case OO
.ui
.Keys
.PAGEUP
:
2632 case OO
.ui
.Keys
.PAGEDOWN
:
2633 case OO
.ui
.Keys
.END
:
2634 case OO
.ui
.Keys
.HOME
:
2635 case OO
.ui
.Keys
.LEFT
:
2637 case OO
.ui
.Keys
.RIGHT
:
2638 case OO
.ui
.Keys
.DOWN
:
2639 // Prevent any key events that might cause scrolling
2645 * Check if window is opening.
2647 * @return {boolean} Window is opening
2649 OO
.ui
.WindowManager
.prototype.isOpening = function ( win
) {
2650 return win
=== this.currentWindow
&& !!this.opening
&& this.opening
.state() === 'pending';
2654 * Check if window is closing.
2656 * @return {boolean} Window is closing
2658 OO
.ui
.WindowManager
.prototype.isClosing = function ( win
) {
2659 return win
=== this.currentWindow
&& !!this.closing
&& this.closing
.state() === 'pending';
2663 * Check if window is opened.
2665 * @return {boolean} Window is opened
2667 OO
.ui
.WindowManager
.prototype.isOpened = function ( win
) {
2668 return win
=== this.currentWindow
&& !!this.opened
&& this.opened
.state() === 'pending';
2672 * Check if window contents should be isolated.
2674 * Window content isolation is done using inline frames.
2676 * @return {boolean} Window contents should be isolated
2678 OO
.ui
.WindowManager
.prototype.shouldIsolate = function () {
2679 return this.isolate
;
2683 * Check if a window is being managed.
2685 * @param {OO.ui.Window} win Window to check
2686 * @return {boolean} Window is being managed
2688 OO
.ui
.WindowManager
.prototype.hasWindow = function ( win
) {
2691 for ( name
in this.windows
) {
2692 if ( this.windows
[name
] === win
) {
2701 * Get the number of milliseconds to wait between beginning opening and executing setup process.
2703 * @param {OO.ui.Window} win Window being opened
2704 * @param {Object} [data] Window opening data
2705 * @return {number} Milliseconds to wait
2707 OO
.ui
.WindowManager
.prototype.getSetupDelay = function () {
2712 * Get the number of milliseconds to wait between finishing setup and executing ready process.
2714 * @param {OO.ui.Window} win Window being opened
2715 * @param {Object} [data] Window opening data
2716 * @return {number} Milliseconds to wait
2718 OO
.ui
.WindowManager
.prototype.getReadyDelay = function () {
2723 * Get the number of milliseconds to wait between beginning closing and executing hold process.
2725 * @param {OO.ui.Window} win Window being closed
2726 * @param {Object} [data] Window closing data
2727 * @return {number} Milliseconds to wait
2729 OO
.ui
.WindowManager
.prototype.getHoldDelay = function () {
2734 * Get the number of milliseconds to wait between finishing hold and executing teardown process.
2736 * @param {OO.ui.Window} win Window being closed
2737 * @param {Object} [data] Window closing data
2738 * @return {number} Milliseconds to wait
2740 OO
.ui
.WindowManager
.prototype.getTeardownDelay = function () {
2741 return this.modal
? 250 : 0;
2745 * Get managed window by symbolic name.
2747 * If window is not yet instantiated, it will be instantiated and added automatically.
2749 * @param {string} name Symbolic window name
2750 * @return {jQuery.Promise} Promise resolved with matching window, or rejected with an OO.ui.Error
2751 * @throws {Error} If the symbolic name is unrecognized by the factory
2752 * @throws {Error} If the symbolic name unrecognized as a managed window
2754 OO
.ui
.WindowManager
.prototype.getWindow = function ( name
) {
2755 var deferred
= $.Deferred(),
2756 win
= this.windows
[name
];
2758 if ( !( win
instanceof OO
.ui
.Window
) ) {
2759 if ( this.factory
) {
2760 if ( !this.factory
.lookup( name
) ) {
2761 deferred
.reject( new OO
.ui
.Error(
2762 'Cannot auto-instantiate window: symbolic name is unrecognized by the factory'
2765 win
= this.factory
.create( name
, this, { $: this.$ } );
2766 this.addWindows( [ win
] );
2767 deferred
.resolve( win
);
2770 deferred
.reject( new OO
.ui
.Error(
2771 'Cannot get unmanaged window: symbolic name unrecognized as a managed window'
2775 deferred
.resolve( win
);
2778 return deferred
.promise();
2782 * Get current window.
2784 * @return {OO.ui.Window|null} Currently opening/opened/closing window
2786 OO
.ui
.WindowManager
.prototype.getCurrentWindow = function () {
2787 return this.currentWindow
;
2793 * @param {OO.ui.Window|string} win Window object or symbolic name of window to open
2794 * @param {Object} [data] Window opening data
2795 * @return {jQuery.Promise} Promise resolved when window is done opening; see {@link #event-opening}
2796 * for more details about the `opening` promise
2799 OO
.ui
.WindowManager
.prototype.openWindow = function ( win
, data
) {
2802 opening
= $.Deferred();
2804 // Argument handling
2805 if ( typeof win
=== 'string' ) {
2806 return this.getWindow( win
).then( function ( win
) {
2807 return manager
.openWindow( win
, data
);
2812 if ( !this.hasWindow( win
) ) {
2813 opening
.reject( new OO
.ui
.Error(
2814 'Cannot open window: window is not attached to manager'
2816 } else if ( this.preparingToOpen
|| this.opening
|| this.opened
) {
2817 opening
.reject( new OO
.ui
.Error(
2818 'Cannot open window: another window is opening or open'
2823 if ( opening
.state() !== 'rejected' ) {
2824 // Begin loading the window if it's not loading or loaded already - may take noticable time
2825 // and we want to do this in paralell with any other preparatory actions
2826 if ( !win
.isLoading() && !win
.isLoaded() ) {
2827 // Finish initializing the window (must be done after manager is attached to DOM)
2828 win
.setManager( this );
2829 preparing
.push( win
.load() );
2832 if ( this.closing
) {
2833 // If a window is currently closing, wait for it to complete
2834 preparing
.push( this.closing
);
2837 this.preparingToOpen
= $.when
.apply( $, preparing
);
2838 // Ensure handlers get called after preparingToOpen is set
2839 this.preparingToOpen
.done( function () {
2840 if ( manager
.modal
) {
2841 manager
.toggleGlobalEvents( true );
2842 manager
.toggleAriaIsolation( true );
2844 manager
.currentWindow
= win
;
2845 manager
.opening
= opening
;
2846 manager
.preparingToOpen
= null;
2847 manager
.emit( 'opening', win
, opening
, data
);
2848 setTimeout( function () {
2849 win
.setup( data
).then( function () {
2850 manager
.updateWindowSize( win
);
2851 manager
.opening
.notify( { state
: 'setup' } );
2852 setTimeout( function () {
2853 win
.ready( data
).then( function () {
2854 manager
.opening
.notify( { state
: 'ready' } );
2855 manager
.opening
= null;
2856 manager
.opened
= $.Deferred();
2857 opening
.resolve( manager
.opened
.promise(), data
);
2859 }, manager
.getReadyDelay() );
2861 }, manager
.getSetupDelay() );
2865 return opening
.promise();
2871 * @param {OO.ui.Window|string} win Window object or symbolic name of window to close
2872 * @param {Object} [data] Window closing data
2873 * @return {jQuery.Promise} Promise resolved when window is done closing; see {@link #event-closing}
2874 * for more details about the `closing` promise
2875 * @throws {Error} If no window by that name is being managed
2878 OO
.ui
.WindowManager
.prototype.closeWindow = function ( win
, data
) {
2881 closing
= $.Deferred(),
2882 opened
= this.opened
;
2884 // Argument handling
2885 if ( typeof win
=== 'string' ) {
2886 win
= this.windows
[win
];
2887 } else if ( !this.hasWindow( win
) ) {
2893 closing
.reject( new OO
.ui
.Error(
2894 'Cannot close window: window is not attached to manager'
2896 } else if ( win
!== this.currentWindow
) {
2897 closing
.reject( new OO
.ui
.Error(
2898 'Cannot close window: window already closed with different data'
2900 } else if ( this.preparingToClose
|| this.closing
) {
2901 closing
.reject( new OO
.ui
.Error(
2902 'Cannot close window: window already closing with different data'
2907 if ( closing
.state() !== 'rejected' ) {
2908 if ( this.opening
) {
2909 // If the window is currently opening, close it when it's done
2910 preparing
.push( this.opening
);
2913 this.preparingToClose
= $.when
.apply( $, preparing
);
2914 // Ensure handlers get called after preparingToClose is set
2915 this.preparingToClose
.done( function () {
2916 manager
.closing
= closing
;
2917 manager
.preparingToClose
= null;
2918 manager
.emit( 'closing', win
, closing
, data
);
2919 manager
.opened
= null;
2920 opened
.resolve( closing
.promise(), data
);
2921 setTimeout( function () {
2922 win
.hold( data
).then( function () {
2923 closing
.notify( { state
: 'hold' } );
2924 setTimeout( function () {
2925 win
.teardown( data
).then( function () {
2926 closing
.notify( { state
: 'teardown' } );
2927 if ( manager
.modal
) {
2928 manager
.toggleGlobalEvents( false );
2929 manager
.toggleAriaIsolation( false );
2931 manager
.closing
= null;
2932 manager
.currentWindow
= null;
2933 closing
.resolve( data
);
2935 }, manager
.getTeardownDelay() );
2937 }, manager
.getHoldDelay() );
2941 return closing
.promise();
2947 * @param {Object.<string,OO.ui.Window>|OO.ui.Window[]} windows Windows to add
2948 * @throws {Error} If one of the windows being added without an explicit symbolic name does not have
2949 * a statically configured symbolic name
2951 OO
.ui
.WindowManager
.prototype.addWindows = function ( windows
) {
2952 var i
, len
, win
, name
, list
;
2954 if ( $.isArray( windows
) ) {
2955 // Convert to map of windows by looking up symbolic names from static configuration
2957 for ( i
= 0, len
= windows
.length
; i
< len
; i
++ ) {
2958 name
= windows
[i
].constructor.static.name
;
2959 if ( typeof name
!== 'string' ) {
2960 throw new Error( 'Cannot add window' );
2962 list
[name
] = windows
[i
];
2964 } else if ( $.isPlainObject( windows
) ) {
2969 for ( name
in list
) {
2971 this.windows
[name
] = win
;
2972 this.$element
.append( win
.$element
);
2979 * Windows will be closed before they are removed.
2981 * @param {string} name Symbolic name of window to remove
2982 * @return {jQuery.Promise} Promise resolved when window is closed and removed
2983 * @throws {Error} If windows being removed are not being managed
2985 OO
.ui
.WindowManager
.prototype.removeWindows = function ( names
) {
2986 var i
, len
, win
, name
,
2989 cleanup = function ( name
, win
) {
2990 delete manager
.windows
[name
];
2991 win
.$element
.detach();
2994 for ( i
= 0, len
= names
.length
; i
< len
; i
++ ) {
2996 win
= this.windows
[name
];
2998 throw new Error( 'Cannot remove window' );
3000 promises
.push( this.closeWindow( name
).then( OO
.ui
.bind( cleanup
, null, name
, win
) ) );
3003 return $.when
.apply( $, promises
);
3007 * Remove all windows.
3009 * Windows will be closed before they are removed.
3011 * @return {jQuery.Promise} Promise resolved when all windows are closed and removed
3013 OO
.ui
.WindowManager
.prototype.clearWindows = function () {
3014 return this.removeWindows( Object
.keys( this.windows
) );
3020 * Fullscreen mode will be used if the dialog is too wide to fit in the screen.
3024 OO
.ui
.WindowManager
.prototype.updateWindowSize = function ( win
) {
3025 // Bypass for non-current, and thus invisible, windows
3026 if ( win
!== this.currentWindow
) {
3030 var viewport
= OO
.ui
.Element
.getDimensions( win
.getElementWindow() ),
3031 sizes
= this.constructor.static.sizes
,
3032 size
= win
.getSize();
3034 if ( !sizes
[size
] ) {
3035 size
= this.constructor.static.defaultSize
;
3037 if ( size
!== 'full' && viewport
.rect
.right
- viewport
.rect
.left
< sizes
[size
].width
) {
3041 this.$element
.toggleClass( 'oo-ui-windowManager-fullscreen', size
=== 'full' );
3042 this.$element
.toggleClass( 'oo-ui-windowManager-floating', size
!== 'full' );
3043 win
.setDimensions( sizes
[size
] );
3045 this.emit( 'resize', win
);
3051 * Bind or unbind global events for scrolling.
3053 * @param {boolean} [on] Bind global events
3056 OO
.ui
.WindowManager
.prototype.toggleGlobalEvents = function ( on
) {
3057 on
= on
=== undefined ? !!this.globalEvents
: !!on
;
3060 if ( !this.globalEvents
) {
3061 this.$( this.getElementDocument() ).on( {
3062 // Prevent scrolling by keys in top-level window
3063 keydown
: this.onDocumentKeyDownHandler
3065 this.$( this.getElementWindow() ).on( {
3066 // Prevent scrolling by wheel in top-level window
3067 mousewheel
: this.onWindowMouseWheelHandler
,
3068 // Start listening for top-level window dimension changes
3069 'orientationchange resize': this.onWindowResizeHandler
3071 this.globalEvents
= true;
3073 } else if ( this.globalEvents
) {
3074 // Unbind global events
3075 this.$( this.getElementDocument() ).off( {
3076 // Allow scrolling by keys in top-level window
3077 keydown
: this.onDocumentKeyDownHandler
3079 this.$( this.getElementWindow() ).off( {
3080 // Allow scrolling by wheel in top-level window
3081 mousewheel
: this.onWindowMouseWheelHandler
,
3082 // Stop listening for top-level window dimension changes
3083 'orientationchange resize': this.onWindowResizeHandler
3085 this.globalEvents
= false;
3092 * Toggle screen reader visibility of content other than the window manager.
3094 * @param {boolean} [isolate] Make only the window manager visible to screen readers
3097 OO
.ui
.WindowManager
.prototype.toggleAriaIsolation = function ( isolate
) {
3098 isolate
= isolate
=== undefined ? !this.$ariaHidden
: !!isolate
;
3101 if ( !this.$ariaHidden
) {
3102 // Hide everything other than the window manager from screen readers
3103 this.$ariaHidden
= $( 'body' )
3105 .not( this.$element
.parentsUntil( 'body' ).last() )
3106 .attr( 'aria-hidden', '' );
3108 } else if ( this.$ariaHidden
) {
3109 // Restore screen reader visiblity
3110 this.$ariaHidden
.removeAttr( 'aria-hidden' );
3111 this.$ariaHidden
= null;
3118 * Destroy window manager.
3120 * Windows will not be closed, only removed from the DOM.
3122 OO
.ui
.WindowManager
.prototype.destroy = function () {
3123 this.toggleGlobalEvents( false );
3124 this.toggleAriaIsolation( false );
3125 this.$element
.remove();
3133 * @param {string|jQuery} message Description of error
3134 * @param {Object} [config] Configuration options
3135 * @cfg {boolean} [recoverable=true] Error is recoverable
3137 OO
.ui
.Error
= function OoUiElement( message
, config
) {
3138 // Configuration initialization
3139 config
= config
|| {};
3142 this.message
= message
instanceof jQuery
? message
: String( message
);
3143 this.recoverable
= config
.recoverable
=== undefined || !!config
.recoverable
;
3148 OO
.initClass( OO
.ui
.Error
);
3153 * Check if error can be recovered from.
3155 * @return {boolean} Error is recoverable
3157 OO
.ui
.Error
.prototype.isRecoverable = function () {
3158 return this.recoverable
;
3162 * Get error message as DOM nodes.
3164 * @return {jQuery} Error message in DOM nodes
3166 OO
.ui
.Error
.prototype.getMessage = function () {
3167 return this.message
instanceof jQuery
?
3168 this.message
.clone() :
3169 $( '<div>' ).text( this.message
).contents();
3173 * Get error message as text.
3175 * @return {string} Error message
3177 OO
.ui
.Error
.prototype.getMessageText = function () {
3178 return this.message
instanceof jQuery
? this.message
.text() : this.message
;
3182 * A list of functions, called in sequence.
3184 * If a function added to a process returns boolean false the process will stop; if it returns an
3185 * object with a `promise` method the process will use the promise to either continue to the next
3186 * step when the promise is resolved or stop when the promise is rejected.
3191 * @param {number|jQuery.Promise|Function} step Time to wait, promise to wait for or function to
3192 * call, see #createStep for more information
3193 * @param {Object} [context=null] Context to call the step function in, ignored if step is a number
3195 * @return {Object} Step object, with `callback` and `context` properties
3197 OO
.ui
.Process = function ( step
, context
) {
3202 if ( step
!== undefined ) {
3203 this.next( step
, context
);
3209 OO
.initClass( OO
.ui
.Process
);
3214 * Start the process.
3216 * @return {jQuery.Promise} Promise that is resolved when all steps have completed or rejected when
3217 * any of the steps return boolean false or a promise which gets rejected; upon stopping the
3218 * process, the remaining steps will not be taken
3220 OO
.ui
.Process
.prototype.execute = function () {
3221 var i
, len
, promise
;
3224 * Continue execution.
3227 * @param {Array} step A function and the context it should be called in
3228 * @return {Function} Function that continues the process
3230 function proceed( step
) {
3231 return function () {
3232 // Execute step in the correct context
3234 result
= step
.callback
.call( step
.context
);
3236 if ( result
=== false ) {
3237 // Use rejected promise for boolean false results
3238 return $.Deferred().reject( [] ).promise();
3240 if ( typeof result
=== 'number' ) {
3242 throw new Error( 'Cannot go back in time: flux capacitor is out of service' );
3244 // Use a delayed promise for numbers, expecting them to be in milliseconds
3245 deferred
= $.Deferred();
3246 setTimeout( deferred
.resolve
, result
);
3247 return deferred
.promise();
3249 if ( result
instanceof OO
.ui
.Error
) {
3250 // Use rejected promise for error
3251 return $.Deferred().reject( [ result
] ).promise();
3253 if ( $.isArray( result
) && result
.length
&& result
[0] instanceof OO
.ui
.Error
) {
3254 // Use rejected promise for list of errors
3255 return $.Deferred().reject( result
).promise();
3257 // Duck-type the object to see if it can produce a promise
3258 if ( result
&& $.isFunction( result
.promise
) ) {
3259 // Use a promise generated from the result
3260 return result
.promise();
3262 // Use resolved promise for other results
3263 return $.Deferred().resolve().promise();
3267 if ( this.steps
.length
) {
3268 // Generate a chain reaction of promises
3269 promise
= proceed( this.steps
[0] )();
3270 for ( i
= 1, len
= this.steps
.length
; i
< len
; i
++ ) {
3271 promise
= promise
.then( proceed( this.steps
[i
] ) );
3274 promise
= $.Deferred().resolve().promise();
3281 * Create a process step.
3284 * @param {number|jQuery.Promise|Function} step
3286 * - Number of milliseconds to wait; or
3287 * - Promise to wait to be resolved; or
3288 * - Function to execute
3289 * - If it returns boolean false the process will stop
3290 * - If it returns an object with a `promise` method the process will use the promise to either
3291 * continue to the next step when the promise is resolved or stop when the promise is rejected
3292 * - If it returns a number, the process will wait for that number of milliseconds before
3294 * @param {Object} [context=null] Context to call the step function in, ignored if step is a number
3296 * @return {Object} Step object, with `callback` and `context` properties
3298 OO
.ui
.Process
.prototype.createStep = function ( step
, context
) {
3299 if ( typeof step
=== 'number' || $.isFunction( step
.promise
) ) {
3301 callback: function () {
3307 if ( $.isFunction( step
) ) {
3313 throw new Error( 'Cannot create process step: number, promise or function expected' );
3317 * Add step to the beginning of the process.
3319 * @inheritdoc #createStep
3320 * @return {OO.ui.Process} this
3323 OO
.ui
.Process
.prototype.first = function ( step
, context
) {
3324 this.steps
.unshift( this.createStep( step
, context
) );
3329 * Add step to the end of the process.
3331 * @inheritdoc #createStep
3332 * @return {OO.ui.Process} this
3335 OO
.ui
.Process
.prototype.next = function ( step
, context
) {
3336 this.steps
.push( this.createStep( step
, context
) );
3341 * Factory for tools.
3344 * @extends OO.Factory
3347 OO
.ui
.ToolFactory
= function OoUiToolFactory() {
3348 // Parent constructor
3349 OO
.ui
.ToolFactory
.super.call( this );
3354 OO
.inheritClass( OO
.ui
.ToolFactory
, OO
.Factory
);
3359 OO
.ui
.ToolFactory
.prototype.getTools = function ( include
, exclude
, promote
, demote
) {
3360 var i
, len
, included
, promoted
, demoted
,
3364 // Collect included and not excluded tools
3365 included
= OO
.simpleArrayDifference( this.extract( include
), this.extract( exclude
) );
3368 promoted
= this.extract( promote
, used
);
3369 demoted
= this.extract( demote
, used
);
3372 for ( i
= 0, len
= included
.length
; i
< len
; i
++ ) {
3373 if ( !used
[included
[i
]] ) {
3374 auto
.push( included
[i
] );
3378 return promoted
.concat( auto
).concat( demoted
);
3382 * Get a flat list of names from a list of names or groups.
3384 * Tools can be specified in the following ways:
3386 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
3387 * - All tools in a group: `{ group: 'group-name' }`
3388 * - All tools: `'*'`
3391 * @param {Array|string} collection List of tools
3392 * @param {Object} [used] Object with names that should be skipped as properties; extracted
3393 * names will be added as properties
3394 * @return {string[]} List of extracted names
3396 OO
.ui
.ToolFactory
.prototype.extract = function ( collection
, used
) {
3397 var i
, len
, item
, name
, tool
,
3400 if ( collection
=== '*' ) {
3401 for ( name
in this.registry
) {
3402 tool
= this.registry
[name
];
3404 // Only add tools by group name when auto-add is enabled
3405 tool
.static.autoAddToCatchall
&&
3406 // Exclude already used tools
3407 ( !used
|| !used
[name
] )
3415 } else if ( $.isArray( collection
) ) {
3416 for ( i
= 0, len
= collection
.length
; i
< len
; i
++ ) {
3417 item
= collection
[i
];
3418 // Allow plain strings as shorthand for named tools
3419 if ( typeof item
=== 'string' ) {
3420 item
= { name
: item
};
3422 if ( OO
.isPlainObject( item
) ) {
3424 for ( name
in this.registry
) {
3425 tool
= this.registry
[name
];
3427 // Include tools with matching group
3428 tool
.static.group
=== item
.group
&&
3429 // Only add tools by group name when auto-add is enabled
3430 tool
.static.autoAddToGroup
&&
3431 // Exclude already used tools
3432 ( !used
|| !used
[name
] )
3440 // Include tools with matching name and exclude already used tools
3441 } else if ( item
.name
&& ( !used
|| !used
[item
.name
] ) ) {
3442 names
.push( item
.name
);
3444 used
[item
.name
] = true;
3454 * Factory for tool groups.
3457 * @extends OO.Factory
3460 OO
.ui
.ToolGroupFactory
= function OoUiToolGroupFactory() {
3461 // Parent constructor
3462 OO
.Factory
.call( this );
3465 defaultClasses
= this.constructor.static.getDefaultClasses();
3467 // Register default toolgroups
3468 for ( i
= 0, l
= defaultClasses
.length
; i
< l
; i
++ ) {
3469 this.register( defaultClasses
[i
] );
3475 OO
.inheritClass( OO
.ui
.ToolGroupFactory
, OO
.Factory
);
3477 /* Static Methods */
3480 * Get a default set of classes to be registered on construction
3482 * @return {Function[]} Default classes
3484 OO
.ui
.ToolGroupFactory
.static.getDefaultClasses = function () {
3487 OO
.ui
.ListToolGroup
,
3499 * @param {Object} [config] Configuration options
3501 OO
.ui
.Theme
= function OoUiTheme( config
) {
3502 // Initialize config
3503 config
= config
|| {};
3508 OO
.initClass( OO
.ui
.Theme
);
3513 * Get a list of classes to be applied to a widget.
3515 * @localdoc The 'on' and 'off' lists combined MUST contain keys for all classes the theme adds or
3516 * removes, otherwise state transitions will not work properly.
3518 * @param {OO.ui.Element} element Element for which to get classes
3519 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
3521 OO
.ui
.Theme
.prototype.getElementClasses = function ( /* element */ ) {
3522 return { on
: [], off
: [] };
3526 * Update CSS classes provided by the theme.
3528 * For elements with theme logic hooks, this should be called anytime there's a state change.
3530 * @param {OO.ui.Element} Element for which to update classes
3531 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
3533 OO
.ui
.Theme
.prototype.updateElementClasses = function ( element
) {
3534 var classes
= this.getElementClasses( element
);
3537 .removeClass( classes
.off
.join( ' ' ) )
3538 .addClass( classes
.on
.join( ' ' ) );
3542 * Element with a button.
3544 * Buttons are used for controls which can be clicked. They can be configured to use tab indexing
3545 * and access keys for accessibility purposes.
3551 * @param {Object} [config] Configuration options
3552 * @cfg {jQuery} [$button] Button node, assigned to #$button, omit to use a generated `<a>`
3553 * @cfg {boolean} [framed=true] Render button with a frame
3554 * @cfg {number} [tabIndex=0] Button's tab index, use null to have no tabIndex
3555 * @cfg {string} [accessKey] Button's access key
3557 OO
.ui
.ButtonElement
= function OoUiButtonElement( config
) {
3558 // Configuration initialization
3559 config
= config
|| {};
3562 this.$button
= null;
3564 this.tabIndex
= null;
3565 this.accessKey
= null;
3566 this.active
= false;
3567 this.onMouseUpHandler
= OO
.ui
.bind( this.onMouseUp
, this );
3568 this.onMouseDownHandler
= OO
.ui
.bind( this.onMouseDown
, this );
3571 this.$element
.addClass( 'oo-ui-buttonElement' );
3572 this.toggleFramed( config
.framed
=== undefined || config
.framed
);
3573 this.setTabIndex( config
.tabIndex
|| 0 );
3574 this.setAccessKey( config
.accessKey
);
3575 this.setButtonElement( config
.$button
|| this.$( '<a>' ) );
3580 OO
.initClass( OO
.ui
.ButtonElement
);
3582 /* Static Properties */
3585 * Cancel mouse down events.
3589 * @property {boolean}
3591 OO
.ui
.ButtonElement
.static.cancelButtonMouseDownEvents
= true;
3596 * Set the button element.
3598 * If an element is already set, it will be cleaned up before setting up the new element.
3600 * @param {jQuery} $button Element to use as button
3602 OO
.ui
.ButtonElement
.prototype.setButtonElement = function ( $button
) {
3603 if ( this.$button
) {
3605 .removeClass( 'oo-ui-buttonElement-button' )
3606 .removeAttr( 'role accesskey tabindex' )
3607 .off( this.onMouseDownHandler
);
3610 this.$button
= $button
3611 .addClass( 'oo-ui-buttonElement-button' )
3612 .attr( { role
: 'button', accesskey
: this.accessKey
, tabindex
: this.tabIndex
} )
3613 .on( 'mousedown', this.onMouseDownHandler
);
3617 * Handles mouse down events.
3619 * @param {jQuery.Event} e Mouse down event
3621 OO
.ui
.ButtonElement
.prototype.onMouseDown = function ( e
) {
3622 if ( this.isDisabled() || e
.which
!== 1 ) {
3625 // Remove the tab-index while the button is down to prevent the button from stealing focus
3626 this.$button
.removeAttr( 'tabindex' );
3627 this.$element
.addClass( 'oo-ui-buttonElement-pressed' );
3628 // Run the mouseup handler no matter where the mouse is when the button is let go, so we can
3629 // reliably reapply the tabindex and remove the pressed class
3630 this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler
, true );
3631 // Prevent change of focus unless specifically configured otherwise
3632 if ( this.constructor.static.cancelButtonMouseDownEvents
) {
3638 * Handles mouse up events.
3640 * @param {jQuery.Event} e Mouse up event
3642 OO
.ui
.ButtonElement
.prototype.onMouseUp = function ( e
) {
3643 if ( this.isDisabled() || e
.which
!== 1 ) {
3646 // Restore the tab-index after the button is up to restore the button's accesssibility
3647 this.$button
.attr( 'tabindex', this.tabIndex
);
3648 this.$element
.removeClass( 'oo-ui-buttonElement-pressed' );
3649 // Stop listening for mouseup, since we only needed this once
3650 this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler
, true );
3654 * Check if button has a frame.
3656 * @return {boolean} Button is framed
3658 OO
.ui
.ButtonElement
.prototype.isFramed = function () {
3665 * @param {boolean} [framed] Make button framed, omit to toggle
3668 OO
.ui
.ButtonElement
.prototype.toggleFramed = function ( framed
) {
3669 framed
= framed
=== undefined ? !this.framed
: !!framed
;
3670 if ( framed
!== this.framed
) {
3671 this.framed
= framed
;
3673 .toggleClass( 'oo-ui-buttonElement-frameless', !framed
)
3674 .toggleClass( 'oo-ui-buttonElement-framed', framed
);
3675 this.updateThemeClasses();
3684 * @param {number|null} tabIndex Button's tab index, use null to remove
3687 OO
.ui
.ButtonElement
.prototype.setTabIndex = function ( tabIndex
) {
3688 tabIndex
= typeof tabIndex
=== 'number' && tabIndex
>= 0 ? tabIndex
: null;
3690 if ( this.tabIndex
!== tabIndex
) {
3691 if ( this.$button
) {
3692 if ( tabIndex
!== null ) {
3693 this.$button
.attr( 'tabindex', tabIndex
);
3695 this.$button
.removeAttr( 'tabindex' );
3698 this.tabIndex
= tabIndex
;
3707 * @param {string} accessKey Button's access key, use empty string to remove
3710 OO
.ui
.ButtonElement
.prototype.setAccessKey = function ( accessKey
) {
3711 accessKey
= typeof accessKey
=== 'string' && accessKey
.length
? accessKey
: null;
3713 if ( this.accessKey
!== accessKey
) {
3714 if ( this.$button
) {
3715 if ( accessKey
!== null ) {
3716 this.$button
.attr( 'accesskey', accessKey
);
3718 this.$button
.removeAttr( 'accesskey' );
3721 this.accessKey
= accessKey
;
3730 * @param {boolean} [value] Make button active
3733 OO
.ui
.ButtonElement
.prototype.setActive = function ( value
) {
3734 this.$element
.toggleClass( 'oo-ui-buttonElement-active', !!value
);
3739 * Element containing a sequence of child elements.
3745 * @param {Object} [config] Configuration options
3746 * @cfg {jQuery} [$group] Container node, assigned to #$group, omit to use a generated `<div>`
3748 OO
.ui
.GroupElement
= function OoUiGroupElement( config
) {
3750 config
= config
|| {};
3755 this.aggregateItemEvents
= {};
3758 this.setGroupElement( config
.$group
|| this.$( '<div>' ) );
3764 * Set the group element.
3766 * If an element is already set, items will be moved to the new element.
3768 * @param {jQuery} $group Element to use as group
3770 OO
.ui
.GroupElement
.prototype.setGroupElement = function ( $group
) {
3773 this.$group
= $group
;
3774 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3775 this.$group
.append( this.items
[i
].$element
);
3780 * Check if there are no items.
3782 * @return {boolean} Group is empty
3784 OO
.ui
.GroupElement
.prototype.isEmpty = function () {
3785 return !this.items
.length
;
3791 * @return {OO.ui.Element[]} Items
3793 OO
.ui
.GroupElement
.prototype.getItems = function () {
3794 return this.items
.slice( 0 );
3798 * Add an aggregate item event.
3800 * Aggregated events are listened to on each item and then emitted by the group under a new name,
3801 * and with an additional leading parameter containing the item that emitted the original event.
3802 * Other arguments that were emitted from the original event are passed through.
3804 * @param {Object.<string,string|null>} events Aggregate events emitted by group, keyed by item
3805 * event, use null value to remove aggregation
3806 * @throws {Error} If aggregation already exists
3808 OO
.ui
.GroupElement
.prototype.aggregate = function ( events
) {
3809 var i
, len
, item
, add
, remove
, itemEvent
, groupEvent
;
3811 for ( itemEvent
in events
) {
3812 groupEvent
= events
[itemEvent
];
3814 // Remove existing aggregated event
3815 if ( itemEvent
in this.aggregateItemEvents
) {
3816 // Don't allow duplicate aggregations
3818 throw new Error( 'Duplicate item event aggregation for ' + itemEvent
);
3820 // Remove event aggregation from existing items
3821 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3822 item
= this.items
[i
];
3823 if ( item
.connect
&& item
.disconnect
) {
3825 remove
[itemEvent
] = [ 'emit', groupEvent
, item
];
3826 item
.disconnect( this, remove
);
3829 // Prevent future items from aggregating event
3830 delete this.aggregateItemEvents
[itemEvent
];
3833 // Add new aggregate event
3835 // Make future items aggregate event
3836 this.aggregateItemEvents
[itemEvent
] = groupEvent
;
3837 // Add event aggregation to existing items
3838 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3839 item
= this.items
[i
];
3840 if ( item
.connect
&& item
.disconnect
) {
3842 add
[itemEvent
] = [ 'emit', groupEvent
, item
];
3843 item
.connect( this, add
);
3853 * Adding an existing item (by value) will move it.
3855 * @param {OO.ui.Element[]} items Item
3856 * @param {number} [index] Index to insert items at
3859 OO
.ui
.GroupElement
.prototype.addItems = function ( items
, index
) {
3860 var i
, len
, item
, event
, events
, currentIndex
,
3863 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
3866 // Check if item exists then remove it first, effectively "moving" it
3867 currentIndex
= $.inArray( item
, this.items
);
3868 if ( currentIndex
>= 0 ) {
3869 this.removeItems( [ item
] );
3870 // Adjust index to compensate for removal
3871 if ( currentIndex
< index
) {
3876 if ( item
.connect
&& item
.disconnect
&& !$.isEmptyObject( this.aggregateItemEvents
) ) {
3878 for ( event
in this.aggregateItemEvents
) {
3879 events
[event
] = [ 'emit', this.aggregateItemEvents
[event
], item
];
3881 item
.connect( this, events
);
3883 item
.setElementGroup( this );
3884 itemElements
.push( item
.$element
.get( 0 ) );
3887 if ( index
=== undefined || index
< 0 || index
>= this.items
.length
) {
3888 this.$group
.append( itemElements
);
3889 this.items
.push
.apply( this.items
, items
);
3890 } else if ( index
=== 0 ) {
3891 this.$group
.prepend( itemElements
);
3892 this.items
.unshift
.apply( this.items
, items
);
3894 this.items
[index
].$element
.before( itemElements
);
3895 this.items
.splice
.apply( this.items
, [ index
, 0 ].concat( items
) );
3904 * Items will be detached, not removed, so they can be used later.
3906 * @param {OO.ui.Element[]} items Items to remove
3909 OO
.ui
.GroupElement
.prototype.removeItems = function ( items
) {
3910 var i
, len
, item
, index
, remove
, itemEvent
;
3912 // Remove specific items
3913 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
3915 index
= $.inArray( item
, this.items
);
3916 if ( index
!== -1 ) {
3918 item
.connect
&& item
.disconnect
&&
3919 !$.isEmptyObject( this.aggregateItemEvents
)
3922 if ( itemEvent
in this.aggregateItemEvents
) {
3923 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
3925 item
.disconnect( this, remove
);
3927 item
.setElementGroup( null );
3928 this.items
.splice( index
, 1 );
3929 item
.$element
.detach();
3939 * Items will be detached, not removed, so they can be used later.
3943 OO
.ui
.GroupElement
.prototype.clearItems = function () {
3944 var i
, len
, item
, remove
, itemEvent
;
3947 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
3948 item
= this.items
[i
];
3950 item
.connect
&& item
.disconnect
&&
3951 !$.isEmptyObject( this.aggregateItemEvents
)
3954 if ( itemEvent
in this.aggregateItemEvents
) {
3955 remove
[itemEvent
] = [ 'emit', this.aggregateItemEvents
[itemEvent
], item
];
3957 item
.disconnect( this, remove
);
3959 item
.setElementGroup( null );
3960 item
.$element
.detach();
3968 * Element containing an icon.
3970 * Icons are graphics, about the size of normal text. They can be used to aid the user in locating
3971 * a control or convey information in a more space efficient way. Icons should rarely be used
3972 * without labels; such as in a toolbar where space is at a premium or within a context where the
3973 * meaning is very clear to the user.
3979 * @param {Object} [config] Configuration options
3980 * @cfg {jQuery} [$icon] Icon node, assigned to #$icon, omit to use a generated `<span>`
3981 * @cfg {Object|string} [icon=''] Symbolic icon name, or map of icon names keyed by language ID;
3982 * use the 'default' key to specify the icon to be used when there is no icon in the user's
3984 * @cfg {string} [iconTitle] Icon title text or a function that returns text
3986 OO
.ui
.IconElement
= function OoUiIconElement( config
) {
3987 // Config intialization
3988 config
= config
|| {};
3993 this.iconTitle
= null;
3996 this.setIcon( config
.icon
|| this.constructor.static.icon
);
3997 this.setIconTitle( config
.iconTitle
|| this.constructor.static.iconTitle
);
3998 this.setIconElement( config
.$icon
|| this.$( '<span>' ) );
4003 OO
.initClass( OO
.ui
.IconElement
);
4005 /* Static Properties */
4010 * Value should be the unique portion of an icon CSS class name, such as 'up' for 'oo-ui-icon-up'.
4012 * For i18n purposes, this property can be an object containing a `default` icon name property and
4013 * additional icon names keyed by language code.
4015 * Example of i18n icon definition:
4016 * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
4020 * @property {Object|string} Symbolic icon name, or map of icon names keyed by language ID;
4021 * use the 'default' key to specify the icon to be used when there is no icon in the user's
4024 OO
.ui
.IconElement
.static.icon
= null;
4031 * @property {string|Function|null} Icon title text, a function that returns text or null for no
4034 OO
.ui
.IconElement
.static.iconTitle
= null;
4039 * Set the icon element.
4041 * If an element is already set, it will be cleaned up before setting up the new element.
4043 * @param {jQuery} $icon Element to use as icon
4045 OO
.ui
.IconElement
.prototype.setIconElement = function ( $icon
) {
4048 .removeClass( 'oo-ui-iconElement-icon oo-ui-icon-' + this.icon
)
4049 .removeAttr( 'title' );
4053 .addClass( 'oo-ui-iconElement-icon' )
4054 .toggleClass( 'oo-ui-icon-' + this.icon
, !!this.icon
);
4055 if ( this.iconTitle
!== null ) {
4056 this.$icon
.attr( 'title', this.iconTitle
);
4063 * @param {Object|string|null} icon Symbolic icon name, or map of icon names keyed by language ID;
4064 * use the 'default' key to specify the icon to be used when there is no icon in the user's
4065 * language, use null to remove icon
4068 OO
.ui
.IconElement
.prototype.setIcon = function ( icon
) {
4069 icon
= OO
.isPlainObject( icon
) ? OO
.ui
.getLocalValue( icon
, null, 'default' ) : icon
;
4070 icon
= typeof icon
=== 'string' && icon
.trim().length
? icon
.trim() : null;
4072 if ( this.icon
!== icon
) {
4074 if ( this.icon
!== null ) {
4075 this.$icon
.removeClass( 'oo-ui-icon-' + this.icon
);
4077 if ( icon
!== null ) {
4078 this.$icon
.addClass( 'oo-ui-icon-' + icon
);
4084 this.$element
.toggleClass( 'oo-ui-iconElement', !!this.icon
);
4085 this.updateThemeClasses();
4093 * @param {string|Function|null} icon Icon title text, a function that returns text or null
4097 OO
.ui
.IconElement
.prototype.setIconTitle = function ( iconTitle
) {
4098 iconTitle
= typeof iconTitle
=== 'function' ||
4099 ( typeof iconTitle
=== 'string' && iconTitle
.length
) ?
4100 OO
.ui
.resolveMsg( iconTitle
) : null;
4102 if ( this.iconTitle
!== iconTitle
) {
4103 this.iconTitle
= iconTitle
;
4105 if ( this.iconTitle
!== null ) {
4106 this.$icon
.attr( 'title', iconTitle
);
4108 this.$icon
.removeAttr( 'title' );
4119 * @return {string} Icon
4121 OO
.ui
.IconElement
.prototype.getIcon = function () {
4126 * Element containing an indicator.
4128 * Indicators are graphics, smaller than normal text. They can be used to describe unique status or
4129 * behavior. Indicators should only be used in exceptional cases; such as a button that opens a menu
4130 * instead of performing an action directly, or an item in a list which has errors that need to be
4137 * @param {Object} [config] Configuration options
4138 * @cfg {jQuery} [$indicator] Indicator node, assigned to #$indicator, omit to use a generated
4140 * @cfg {string} [indicator] Symbolic indicator name
4141 * @cfg {string} [indicatorTitle] Indicator title text or a function that returns text
4143 OO
.ui
.IndicatorElement
= function OoUiIndicatorElement( config
) {
4144 // Config intialization
4145 config
= config
|| {};
4148 this.$indicator
= null;
4149 this.indicator
= null;
4150 this.indicatorTitle
= null;
4153 this.setIndicator( config
.indicator
|| this.constructor.static.indicator
);
4154 this.setIndicatorTitle( config
.indicatorTitle
|| this.constructor.static.indicatorTitle
);
4155 this.setIndicatorElement( config
.$indicator
|| this.$( '<span>' ) );
4160 OO
.initClass( OO
.ui
.IndicatorElement
);
4162 /* Static Properties */
4169 * @property {string|null} Symbolic indicator name or null for no indicator
4171 OO
.ui
.IndicatorElement
.static.indicator
= null;
4178 * @property {string|Function|null} Indicator title text, a function that returns text or null for no
4181 OO
.ui
.IndicatorElement
.static.indicatorTitle
= null;
4186 * Set the indicator element.
4188 * If an element is already set, it will be cleaned up before setting up the new element.
4190 * @param {jQuery} $indicator Element to use as indicator
4192 OO
.ui
.IndicatorElement
.prototype.setIndicatorElement = function ( $indicator
) {
4193 if ( this.$indicator
) {
4195 .removeClass( 'oo-ui-indicatorElement-indicator oo-ui-indicator-' + this.indicator
)
4196 .removeAttr( 'title' );
4199 this.$indicator
= $indicator
4200 .addClass( 'oo-ui-indicatorElement-indicator' )
4201 .toggleClass( 'oo-ui-indicator-' + this.indicator
, !!this.indicator
);
4202 if ( this.indicatorTitle
!== null ) {
4203 this.$indicatorTitle
.attr( 'title', this.indicatorTitle
);
4210 * @param {string|null} indicator Symbolic name of indicator to use or null for no indicator
4213 OO
.ui
.IndicatorElement
.prototype.setIndicator = function ( indicator
) {
4214 indicator
= typeof indicator
=== 'string' && indicator
.length
? indicator
.trim() : null;
4216 if ( this.indicator
!== indicator
) {
4217 if ( this.$indicator
) {
4218 if ( this.indicator
!== null ) {
4219 this.$indicator
.removeClass( 'oo-ui-indicator-' + this.indicator
);
4221 if ( indicator
!== null ) {
4222 this.$indicator
.addClass( 'oo-ui-indicator-' + indicator
);
4225 this.indicator
= indicator
;
4228 this.$element
.toggleClass( 'oo-ui-indicatorElement', !!this.indicator
);
4229 this.updateThemeClasses();
4235 * Set indicator title.
4237 * @param {string|Function|null} indicator Indicator title text, a function that returns text or
4238 * null for no indicator title
4241 OO
.ui
.IndicatorElement
.prototype.setIndicatorTitle = function ( indicatorTitle
) {
4242 indicatorTitle
= typeof indicatorTitle
=== 'function' ||
4243 ( typeof indicatorTitle
=== 'string' && indicatorTitle
.length
) ?
4244 OO
.ui
.resolveMsg( indicatorTitle
) : null;
4246 if ( this.indicatorTitle
!== indicatorTitle
) {
4247 this.indicatorTitle
= indicatorTitle
;
4248 if ( this.$indicator
) {
4249 if ( this.indicatorTitle
!== null ) {
4250 this.$indicator
.attr( 'title', indicatorTitle
);
4252 this.$indicator
.removeAttr( 'title' );
4263 * @return {string} title Symbolic name of indicator
4265 OO
.ui
.IndicatorElement
.prototype.getIndicator = function () {
4266 return this.indicator
;
4270 * Get indicator title.
4272 * @return {string} Indicator title text
4274 OO
.ui
.IndicatorElement
.prototype.getIndicatorTitle = function () {
4275 return this.indicatorTitle
;
4279 * Element containing a label.
4285 * @param {Object} [config] Configuration options
4286 * @cfg {jQuery} [$label] Label node, assigned to #$label, omit to use a generated `<span>`
4287 * @cfg {jQuery|string|Function} [label] Label nodes, text or a function that returns nodes or text
4288 * @cfg {boolean} [autoFitLabel=true] Whether to fit the label or not.
4290 OO
.ui
.LabelElement
= function OoUiLabelElement( config
) {
4291 // Config intialization
4292 config
= config
|| {};
4297 this.autoFitLabel
= config
.autoFitLabel
=== undefined || !!config
.autoFitLabel
;
4300 this.setLabel( config
.label
|| this.constructor.static.label
);
4301 this.setLabelElement( config
.$label
|| this.$( '<span>' ) );
4306 OO
.initClass( OO
.ui
.LabelElement
);
4308 /* Static Properties */
4315 * @property {string|Function|null} Label text; a function that returns nodes or text; or null for
4318 OO
.ui
.LabelElement
.static.label
= null;
4323 * Set the label element.
4325 * If an element is already set, it will be cleaned up before setting up the new element.
4327 * @param {jQuery} $label Element to use as label
4329 OO
.ui
.LabelElement
.prototype.setLabelElement = function ( $label
) {
4330 if ( this.$label
) {
4331 this.$label
.removeClass( 'oo-ui-labelElement-label' ).empty();
4334 this.$label
= $label
.addClass( 'oo-ui-labelElement-label' );
4335 this.setLabelContent( this.label
);
4341 * An empty string will result in the label being hidden. A string containing only whitespace will
4342 * be converted to a single
4344 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
4345 * text; or null for no label
4348 OO
.ui
.LabelElement
.prototype.setLabel = function ( label
) {
4349 label
= typeof label
=== 'function' ? OO
.ui
.resolveMsg( label
) : label
;
4350 label
= ( typeof label
=== 'string' && label
.length
) || label
instanceof jQuery
? label
: null;
4352 if ( this.label
!== label
) {
4353 if ( this.$label
) {
4354 this.setLabelContent( label
);
4359 this.$element
.toggleClass( 'oo-ui-labelElement', !!this.label
);
4367 * @return {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
4368 * text; or null for no label
4370 OO
.ui
.LabelElement
.prototype.getLabel = function () {
4379 OO
.ui
.LabelElement
.prototype.fitLabel = function () {
4380 if ( this.$label
&& this.$label
.autoEllipsis
&& this.autoFitLabel
) {
4381 this.$label
.autoEllipsis( { hasSpan
: false, tooltip
: true } );
4388 * Set the content of the label.
4390 * Do not call this method until after the label element has been set by #setLabelElement.
4393 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
4394 * text; or null for no label
4396 OO
.ui
.LabelElement
.prototype.setLabelContent = function ( label
) {
4397 if ( typeof label
=== 'string' ) {
4398 if ( label
.match( /^\s*$/ ) ) {
4399 // Convert whitespace only string to a single non-breaking space
4400 this.$label
.html( ' ' );
4402 this.$label
.text( label
);
4404 } else if ( label
instanceof jQuery
) {
4405 this.$label
.empty().append( label
);
4407 this.$label
.empty();
4409 this.$label
.css( 'display', !label
? 'none' : '' );
4413 * Element containing an OO.ui.PopupWidget object.
4419 * @param {Object} [config] Configuration options
4420 * @cfg {Object} [popup] Configuration to pass to popup
4421 * @cfg {boolean} [autoClose=true] Popup auto-closes when it loses focus
4423 OO
.ui
.PopupElement
= function OoUiPopupElement( config
) {
4424 // Configuration initialization
4425 config
= config
|| {};
4428 this.popup
= new OO
.ui
.PopupWidget( $.extend(
4429 { autoClose
: true },
4431 { $: this.$, $autoCloseIgnore
: this.$element
}
4440 * @return {OO.ui.PopupWidget} Popup widget
4442 OO
.ui
.PopupElement
.prototype.getPopup = function () {
4447 * Element with named flags that can be added, removed, listed and checked.
4449 * A flag, when set, adds a CSS class on the `$element` by combining `oo-ui-flaggedElement-` with
4450 * the flag name. Flags are primarily useful for styling.
4456 * @param {Object} [config] Configuration options
4457 * @cfg {string[]} [flags=[]] Styling flags, e.g. 'primary', 'destructive' or 'constructive'
4458 * @cfg {jQuery} [$flagged] Flagged node, assigned to #$flagged, omit to use #$element
4460 OO
.ui
.FlaggedElement
= function OoUiFlaggedElement( config
) {
4461 // Config initialization
4462 config
= config
|| {};
4466 this.$flagged
= null;
4469 this.setFlags( config
.flags
);
4470 this.setFlaggedElement( config
.$flagged
|| this.$element
);
4477 * @param {Object.<string,boolean>} changes Object keyed by flag name containing boolean
4478 * added/removed properties
4484 * Set the flagged element.
4486 * If an element is already set, it will be cleaned up before setting up the new element.
4488 * @param {jQuery} $flagged Element to add flags to
4490 OO
.ui
.FlaggedElement
.prototype.setFlaggedElement = function ( $flagged
) {
4491 var classNames
= Object
.keys( this.flags
).map( function ( flag
) {
4492 return 'oo-ui-flaggedElement-' + flag
;
4495 if ( this.$flagged
) {
4496 this.$flagged
.removeClass( classNames
);
4499 this.$flagged
= $flagged
.addClass( classNames
);
4503 * Check if a flag is set.
4505 * @param {string} flag Name of flag
4506 * @return {boolean} Has flag
4508 OO
.ui
.FlaggedElement
.prototype.hasFlag = function ( flag
) {
4509 return flag
in this.flags
;
4513 * Get the names of all flags set.
4515 * @return {string[]} flags Flag names
4517 OO
.ui
.FlaggedElement
.prototype.getFlags = function () {
4518 return Object
.keys( this.flags
);
4527 OO
.ui
.FlaggedElement
.prototype.clearFlags = function () {
4528 var flag
, className
,
4531 classPrefix
= 'oo-ui-flaggedElement-';
4533 for ( flag
in this.flags
) {
4534 className
= classPrefix
+ flag
;
4535 changes
[flag
] = false;
4536 delete this.flags
[flag
];
4537 remove
.push( className
);
4540 if ( this.$flagged
) {
4541 this.$flagged
.removeClass( remove
.join( ' ' ) );
4544 this.updateThemeClasses();
4545 this.emit( 'flag', changes
);
4551 * Add one or more flags.
4553 * @param {string|string[]|Object.<string, boolean>} flags One or more flags to add, or an object
4554 * keyed by flag name containing boolean set/remove instructions.
4558 OO
.ui
.FlaggedElement
.prototype.setFlags = function ( flags
) {
4559 var i
, len
, flag
, className
,
4563 classPrefix
= 'oo-ui-flaggedElement-';
4565 if ( typeof flags
=== 'string' ) {
4566 className
= classPrefix
+ flags
;
4568 if ( !this.flags
[flags
] ) {
4569 this.flags
[flags
] = true;
4570 add
.push( className
);
4572 } else if ( $.isArray( flags
) ) {
4573 for ( i
= 0, len
= flags
.length
; i
< len
; i
++ ) {
4575 className
= classPrefix
+ flag
;
4577 if ( !this.flags
[flag
] ) {
4578 changes
[flag
] = true;
4579 this.flags
[flag
] = true;
4580 add
.push( className
);
4583 } else if ( OO
.isPlainObject( flags
) ) {
4584 for ( flag
in flags
) {
4585 className
= classPrefix
+ flag
;
4586 if ( flags
[flag
] ) {
4588 if ( !this.flags
[flag
] ) {
4589 changes
[flag
] = true;
4590 this.flags
[flag
] = true;
4591 add
.push( className
);
4595 if ( this.flags
[flag
] ) {
4596 changes
[flag
] = false;
4597 delete this.flags
[flag
];
4598 remove
.push( className
);
4604 if ( this.$flagged
) {
4606 .addClass( add
.join( ' ' ) )
4607 .removeClass( remove
.join( ' ' ) );
4610 this.updateThemeClasses();
4611 this.emit( 'flag', changes
);
4617 * Element with a title.
4619 * Titles are rendered by the browser and are made visible when hovering the element. Titles are
4620 * not visible on touch devices.
4626 * @param {Object} [config] Configuration options
4627 * @cfg {jQuery} [$titled] Titled node, assigned to #$titled, omit to use #$element
4628 * @cfg {string|Function} [title] Title text or a function that returns text
4630 OO
.ui
.TitledElement
= function OoUiTitledElement( config
) {
4631 // Config intialization
4632 config
= config
|| {};
4635 this.$titled
= null;
4639 this.setTitle( config
.title
|| this.constructor.static.title
);
4640 this.setTitledElement( config
.$titled
|| this.$element
);
4645 OO
.initClass( OO
.ui
.TitledElement
);
4647 /* Static Properties */
4654 * @property {string|Function} Title text or a function that returns text
4656 OO
.ui
.TitledElement
.static.title
= null;
4661 * Set the titled element.
4663 * If an element is already set, it will be cleaned up before setting up the new element.
4665 * @param {jQuery} $titled Element to set title on
4667 OO
.ui
.TitledElement
.prototype.setTitledElement = function ( $titled
) {
4668 if ( this.$titled
) {
4669 this.$titled
.removeAttr( 'title' );
4672 this.$titled
= $titled
;
4674 this.$titled
.attr( 'title', this.title
);
4681 * @param {string|Function|null} title Title text, a function that returns text or null for no title
4684 OO
.ui
.TitledElement
.prototype.setTitle = function ( title
) {
4685 title
= typeof title
=== 'string' ? OO
.ui
.resolveMsg( title
) : null;
4687 if ( this.title
!== title
) {
4688 if ( this.$titled
) {
4689 if ( title
!== null ) {
4690 this.$titled
.attr( 'title', title
);
4692 this.$titled
.removeAttr( 'title' );
4704 * @return {string} Title string
4706 OO
.ui
.TitledElement
.prototype.getTitle = function () {
4711 * Element that can be automatically clipped to visible boundaries.
4713 * Whenever the element's natural height changes, you have to call
4714 * #clip to make sure it's still clipping correctly.
4720 * @param {Object} [config] Configuration options
4721 * @cfg {jQuery} [$clippable] Nodes to clip, assigned to #$clippable, omit to use #$element
4723 OO
.ui
.ClippableElement
= function OoUiClippableElement( config
) {
4724 // Configuration initialization
4725 config
= config
|| {};
4728 this.$clippable
= null;
4729 this.clipping
= false;
4730 this.clippedHorizontally
= false;
4731 this.clippedVertically
= false;
4732 this.$clippableContainer
= null;
4733 this.$clippableScroller
= null;
4734 this.$clippableWindow
= null;
4735 this.idealWidth
= null;
4736 this.idealHeight
= null;
4737 this.onClippableContainerScrollHandler
= OO
.ui
.bind( this.clip
, this );
4738 this.onClippableWindowResizeHandler
= OO
.ui
.bind( this.clip
, this );
4741 this.setClippableElement( config
.$clippable
|| this.$element
);
4747 * Set clippable element.
4749 * If an element is already set, it will be cleaned up before setting up the new element.
4751 * @param {jQuery} $clippable Element to make clippable
4753 OO
.ui
.ClippableElement
.prototype.setClippableElement = function ( $clippable
) {
4754 if ( this.$clippable
) {
4755 this.$clippable
.removeClass( 'oo-ui-clippableElement-clippable' );
4756 this.$clippable
.css( { width
: '', height
: '' } );
4757 this.$clippable
.width(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4758 this.$clippable
.css( { overflowX
: '', overflowY
: '' } );
4761 this.$clippable
= $clippable
.addClass( 'oo-ui-clippableElement-clippable' );
4768 * Do not turn clipping on until after the element is attached to the DOM and visible.
4770 * @param {boolean} [clipping] Enable clipping, omit to toggle
4773 OO
.ui
.ClippableElement
.prototype.toggleClipping = function ( clipping
) {
4774 clipping
= clipping
=== undefined ? !this.clipping
: !!clipping
;
4776 if ( this.clipping
!== clipping
) {
4777 this.clipping
= clipping
;
4779 this.$clippableContainer
= this.$( this.getClosestScrollableElementContainer() );
4780 // If the clippable container is the body, we have to listen to scroll events and check
4781 // jQuery.scrollTop on the window because of browser inconsistencies
4782 this.$clippableScroller
= this.$clippableContainer
.is( 'body' ) ?
4783 this.$( OO
.ui
.Element
.getWindow( this.$clippableContainer
) ) :
4784 this.$clippableContainer
;
4785 this.$clippableScroller
.on( 'scroll', this.onClippableContainerScrollHandler
);
4786 this.$clippableWindow
= this.$( this.getElementWindow() )
4787 .on( 'resize', this.onClippableWindowResizeHandler
);
4788 // Initial clip after visible
4791 this.$clippable
.css( { width
: '', height
: '' } );
4792 this.$clippable
.width(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4793 this.$clippable
.css( { overflowX
: '', overflowY
: '' } );
4795 this.$clippableContainer
= null;
4796 this.$clippableScroller
.off( 'scroll', this.onClippableContainerScrollHandler
);
4797 this.$clippableScroller
= null;
4798 this.$clippableWindow
.off( 'resize', this.onClippableWindowResizeHandler
);
4799 this.$clippableWindow
= null;
4807 * Check if the element will be clipped to fit the visible area of the nearest scrollable container.
4809 * @return {boolean} Element will be clipped to the visible area
4811 OO
.ui
.ClippableElement
.prototype.isClipping = function () {
4812 return this.clipping
;
4816 * Check if the bottom or right of the element is being clipped by the nearest scrollable container.
4818 * @return {boolean} Part of the element is being clipped
4820 OO
.ui
.ClippableElement
.prototype.isClipped = function () {
4821 return this.clippedHorizontally
|| this.clippedVertically
;
4825 * Check if the right of the element is being clipped by the nearest scrollable container.
4827 * @return {boolean} Part of the element is being clipped
4829 OO
.ui
.ClippableElement
.prototype.isClippedHorizontally = function () {
4830 return this.clippedHorizontally
;
4834 * Check if the bottom of the element is being clipped by the nearest scrollable container.
4836 * @return {boolean} Part of the element is being clipped
4838 OO
.ui
.ClippableElement
.prototype.isClippedVertically = function () {
4839 return this.clippedVertically
;
4843 * Set the ideal size. These are the dimensions the element will have when it's not being clipped.
4845 * @param {number|string} [width] Width as a number of pixels or CSS string with unit suffix
4846 * @param {number|string} [height] Height as a number of pixels or CSS string with unit suffix
4848 OO
.ui
.ClippableElement
.prototype.setIdealSize = function ( width
, height
) {
4849 this.idealWidth
= width
;
4850 this.idealHeight
= height
;
4852 if ( !this.clipping
) {
4853 // Update dimensions
4854 this.$clippable
.css( { width
: width
, height
: height
} );
4856 // While clipping, idealWidth and idealHeight are not considered
4860 * Clip element to visible boundaries and allow scrolling when needed. Call this method when
4861 * the element's natural height changes.
4863 * Element will be clipped the bottom or right of the element is within 10px of the edge of, or
4864 * overlapped by, the visible area of the nearest scrollable container.
4868 OO
.ui
.ClippableElement
.prototype.clip = function () {
4869 if ( !this.clipping
) {
4870 // this.$clippableContainer and this.$clippableWindow are null, so the below will fail
4875 cOffset
= this.$clippable
.offset(),
4876 $container
= this.$clippableContainer
.is( 'body' ) ?
4877 this.$clippableWindow
: this.$clippableContainer
,
4878 ccOffset
= $container
.offset() || { top
: 0, left
: 0 },
4879 ccHeight
= $container
.innerHeight() - buffer
,
4880 ccWidth
= $container
.innerWidth() - buffer
,
4881 scrollTop
= this.$clippableScroller
.scrollTop(),
4882 scrollLeft
= this.$clippableScroller
.scrollLeft(),
4883 desiredWidth
= ( ccOffset
.left
+ scrollLeft
+ ccWidth
) - cOffset
.left
,
4884 desiredHeight
= ( ccOffset
.top
+ scrollTop
+ ccHeight
) - cOffset
.top
,
4885 naturalWidth
= this.$clippable
.prop( 'scrollWidth' ),
4886 naturalHeight
= this.$clippable
.prop( 'scrollHeight' ),
4887 clipWidth
= desiredWidth
< naturalWidth
,
4888 clipHeight
= desiredHeight
< naturalHeight
;
4891 this.$clippable
.css( { overflowX
: 'scroll', width
: desiredWidth
} );
4893 this.$clippable
.css( 'width', this.idealWidth
|| '' );
4894 this.$clippable
.width(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4895 this.$clippable
.css( 'overflowX', '' );
4898 this.$clippable
.css( { overflowY
: 'scroll', height
: desiredHeight
} );
4900 this.$clippable
.css( 'height', this.idealHeight
|| '' );
4901 this.$clippable
.height(); // Force reflow for https://code.google.com/p/chromium/issues/detail?id=387290
4902 this.$clippable
.css( 'overflowY', '' );
4905 this.clippedHorizontally
= clipWidth
;
4906 this.clippedVertically
= clipHeight
;
4912 * Generic toolbar tool.
4916 * @extends OO.ui.Widget
4917 * @mixins OO.ui.IconElement
4918 * @mixins OO.ui.FlaggedElement
4921 * @param {OO.ui.ToolGroup} toolGroup
4922 * @param {Object} [config] Configuration options
4923 * @cfg {string|Function} [title] Title text or a function that returns text
4925 OO
.ui
.Tool
= function OoUiTool( toolGroup
, config
) {
4926 // Config intialization
4927 config
= config
|| {};
4929 // Parent constructor
4930 OO
.ui
.Tool
.super.call( this, config
);
4932 // Mixin constructors
4933 OO
.ui
.IconElement
.call( this, config
);
4934 OO
.ui
.FlaggedElement
.call( this, config
);
4937 this.toolGroup
= toolGroup
;
4938 this.toolbar
= this.toolGroup
.getToolbar();
4939 this.active
= false;
4940 this.$title
= this.$( '<span>' );
4941 this.$link
= this.$( '<a>' );
4945 this.toolbar
.connect( this, { updateState
: 'onUpdateState' } );
4948 this.$title
.addClass( 'oo-ui-tool-title' );
4950 .addClass( 'oo-ui-tool-link' )
4951 .append( this.$icon
, this.$title
)
4952 .prop( 'tabIndex', 0 )
4953 .attr( 'role', 'button' );
4955 .data( 'oo-ui-tool', this )
4957 'oo-ui-tool ' + 'oo-ui-tool-name-' +
4958 this.constructor.static.name
.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' )
4960 .append( this.$link
);
4961 this.setTitle( config
.title
|| this.constructor.static.title
);
4966 OO
.inheritClass( OO
.ui
.Tool
, OO
.ui
.Widget
);
4967 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.IconElement
);
4968 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.FlaggedElement
);
4976 /* Static Properties */
4982 OO
.ui
.Tool
.static.tagName
= 'span';
4985 * Symbolic name of tool.
4990 * @property {string}
4992 OO
.ui
.Tool
.static.name
= '';
5000 * @property {string}
5002 OO
.ui
.Tool
.static.group
= '';
5007 * Title is used as a tooltip when the tool is part of a bar tool group, or a label when the tool
5008 * is part of a list or menu tool group. If a trigger is associated with an action by the same name
5009 * as the tool, a description of its keyboard shortcut for the appropriate platform will be
5010 * appended to the title if the tool is part of a bar tool group.
5015 * @property {string|Function} Title text or a function that returns text
5017 OO
.ui
.Tool
.static.title
= '';
5020 * Tool can be automatically added to catch-all groups.
5024 * @property {boolean}
5026 OO
.ui
.Tool
.static.autoAddToCatchall
= true;
5029 * Tool can be automatically added to named groups.
5032 * @property {boolean}
5035 OO
.ui
.Tool
.static.autoAddToGroup
= true;
5038 * Check if this tool is compatible with given data.
5042 * @param {Mixed} data Data to check
5043 * @return {boolean} Tool can be used with data
5045 OO
.ui
.Tool
.static.isCompatibleWith = function () {
5052 * Handle the toolbar state being updated.
5054 * This is an abstract method that must be overridden in a concrete subclass.
5058 OO
.ui
.Tool
.prototype.onUpdateState = function () {
5060 'OO.ui.Tool.onUpdateState not implemented in this subclass:' + this.constructor
5065 * Handle the tool being selected.
5067 * This is an abstract method that must be overridden in a concrete subclass.
5071 OO
.ui
.Tool
.prototype.onSelect = function () {
5073 'OO.ui.Tool.onSelect not implemented in this subclass:' + this.constructor
5078 * Check if the button is active.
5080 * @param {boolean} Button is active
5082 OO
.ui
.Tool
.prototype.isActive = function () {
5087 * Make the button appear active or inactive.
5089 * @param {boolean} state Make button appear active
5091 OO
.ui
.Tool
.prototype.setActive = function ( state
) {
5092 this.active
= !!state
;
5093 if ( this.active
) {
5094 this.$element
.addClass( 'oo-ui-tool-active' );
5096 this.$element
.removeClass( 'oo-ui-tool-active' );
5101 * Get the tool title.
5103 * @param {string|Function} title Title text or a function that returns text
5106 OO
.ui
.Tool
.prototype.setTitle = function ( title
) {
5107 this.title
= OO
.ui
.resolveMsg( title
);
5113 * Get the tool title.
5115 * @return {string} Title text
5117 OO
.ui
.Tool
.prototype.getTitle = function () {
5122 * Get the tool's symbolic name.
5124 * @return {string} Symbolic name of tool
5126 OO
.ui
.Tool
.prototype.getName = function () {
5127 return this.constructor.static.name
;
5133 OO
.ui
.Tool
.prototype.updateTitle = function () {
5134 var titleTooltips
= this.toolGroup
.constructor.static.titleTooltips
,
5135 accelTooltips
= this.toolGroup
.constructor.static.accelTooltips
,
5136 accel
= this.toolbar
.getToolAccelerator( this.constructor.static.name
),
5143 .addClass( 'oo-ui-tool-accel' )
5147 if ( titleTooltips
&& typeof this.title
=== 'string' && this.title
.length
) {
5148 tooltipParts
.push( this.title
);
5150 if ( accelTooltips
&& typeof accel
=== 'string' && accel
.length
) {
5151 tooltipParts
.push( accel
);
5153 if ( tooltipParts
.length
) {
5154 this.$link
.attr( 'title', tooltipParts
.join( ' ' ) );
5156 this.$link
.removeAttr( 'title' );
5163 OO
.ui
.Tool
.prototype.destroy = function () {
5164 this.toolbar
.disconnect( this );
5165 this.$element
.remove();
5169 * Collection of tool groups.
5172 * @extends OO.ui.Element
5173 * @mixins OO.EventEmitter
5174 * @mixins OO.ui.GroupElement
5177 * @param {OO.ui.ToolFactory} toolFactory Factory for creating tools
5178 * @param {OO.ui.ToolGroupFactory} toolGroupFactory Factory for creating tool groups
5179 * @param {Object} [config] Configuration options
5180 * @cfg {boolean} [actions] Add an actions section opposite to the tools
5181 * @cfg {boolean} [shadow] Add a shadow below the toolbar
5183 OO
.ui
.Toolbar
= function OoUiToolbar( toolFactory
, toolGroupFactory
, config
) {
5184 // Configuration initialization
5185 config
= config
|| {};
5187 // Parent constructor
5188 OO
.ui
.Toolbar
.super.call( this, config
);
5190 // Mixin constructors
5191 OO
.EventEmitter
.call( this );
5192 OO
.ui
.GroupElement
.call( this, config
);
5195 this.toolFactory
= toolFactory
;
5196 this.toolGroupFactory
= toolGroupFactory
;
5199 this.$bar
= this.$( '<div>' );
5200 this.$actions
= this.$( '<div>' );
5201 this.initialized
= false;
5205 .add( this.$bar
).add( this.$group
).add( this.$actions
)
5206 .on( 'mousedown touchstart', OO
.ui
.bind( this.onPointerDown
, this ) );
5209 this.$group
.addClass( 'oo-ui-toolbar-tools' );
5210 this.$bar
.addClass( 'oo-ui-toolbar-bar' ).append( this.$group
);
5211 if ( config
.actions
) {
5212 this.$actions
.addClass( 'oo-ui-toolbar-actions' );
5213 this.$bar
.append( this.$actions
);
5215 this.$bar
.append( '<div style="clear:both"></div>' );
5216 if ( config
.shadow
) {
5217 this.$bar
.append( '<div class="oo-ui-toolbar-shadow"></div>' );
5219 this.$element
.addClass( 'oo-ui-toolbar' ).append( this.$bar
);
5224 OO
.inheritClass( OO
.ui
.Toolbar
, OO
.ui
.Element
);
5225 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.EventEmitter
);
5226 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.ui
.GroupElement
);
5231 * Get the tool factory.
5233 * @return {OO.ui.ToolFactory} Tool factory
5235 OO
.ui
.Toolbar
.prototype.getToolFactory = function () {
5236 return this.toolFactory
;
5240 * Get the tool group factory.
5242 * @return {OO.Factory} Tool group factory
5244 OO
.ui
.Toolbar
.prototype.getToolGroupFactory = function () {
5245 return this.toolGroupFactory
;
5249 * Handles mouse down events.
5251 * @param {jQuery.Event} e Mouse down event
5253 OO
.ui
.Toolbar
.prototype.onPointerDown = function ( e
) {
5254 var $closestWidgetToEvent
= this.$( e
.target
).closest( '.oo-ui-widget' ),
5255 $closestWidgetToToolbar
= this.$element
.closest( '.oo-ui-widget' );
5256 if ( !$closestWidgetToEvent
.length
|| $closestWidgetToEvent
[0] === $closestWidgetToToolbar
[0] ) {
5262 * Sets up handles and preloads required information for the toolbar to work.
5263 * This must be called immediately after it is attached to a visible document.
5265 OO
.ui
.Toolbar
.prototype.initialize = function () {
5266 this.initialized
= true;
5272 * Tools can be specified in the following ways:
5274 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
5275 * - All tools in a group: `{ group: 'group-name' }`
5276 * - All tools: `'*'` - Using this will make the group a list with a "More" label by default
5278 * @param {Object.<string,Array>} groups List of tool group configurations
5279 * @param {Array|string} [groups.include] Tools to include
5280 * @param {Array|string} [groups.exclude] Tools to exclude
5281 * @param {Array|string} [groups.promote] Tools to promote to the beginning
5282 * @param {Array|string} [groups.demote] Tools to demote to the end
5284 OO
.ui
.Toolbar
.prototype.setup = function ( groups
) {
5285 var i
, len
, type
, group
,
5287 defaultType
= 'bar';
5289 // Cleanup previous groups
5292 // Build out new groups
5293 for ( i
= 0, len
= groups
.length
; i
< len
; i
++ ) {
5295 if ( group
.include
=== '*' ) {
5296 // Apply defaults to catch-all groups
5297 if ( group
.type
=== undefined ) {
5298 group
.type
= 'list';
5300 if ( group
.label
=== undefined ) {
5301 group
.label
= 'ooui-toolbar-more';
5304 // Check type has been registered
5305 type
= this.getToolGroupFactory().lookup( group
.type
) ? group
.type
: defaultType
;
5307 this.getToolGroupFactory().create( type
, this, $.extend( { $: this.$ }, group
) )
5310 this.addItems( items
);
5314 * Remove all tools and groups from the toolbar.
5316 OO
.ui
.Toolbar
.prototype.reset = function () {
5321 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
5322 this.items
[i
].destroy();
5328 * Destroys toolbar, removing event handlers and DOM elements.
5330 * Call this whenever you are done using a toolbar.
5332 OO
.ui
.Toolbar
.prototype.destroy = function () {
5334 this.$element
.remove();
5338 * Check if tool has not been used yet.
5340 * @param {string} name Symbolic name of tool
5341 * @return {boolean} Tool is available
5343 OO
.ui
.Toolbar
.prototype.isToolAvailable = function ( name
) {
5344 return !this.tools
[name
];
5348 * Prevent tool from being used again.
5350 * @param {OO.ui.Tool} tool Tool to reserve
5352 OO
.ui
.Toolbar
.prototype.reserveTool = function ( tool
) {
5353 this.tools
[tool
.getName()] = tool
;
5357 * Allow tool to be used again.
5359 * @param {OO.ui.Tool} tool Tool to release
5361 OO
.ui
.Toolbar
.prototype.releaseTool = function ( tool
) {
5362 delete this.tools
[tool
.getName()];
5366 * Get accelerator label for tool.
5368 * This is a stub that should be overridden to provide access to accelerator information.
5370 * @param {string} name Symbolic name of tool
5371 * @return {string|undefined} Tool accelerator label if available
5373 OO
.ui
.Toolbar
.prototype.getToolAccelerator = function () {
5378 * Collection of tools.
5380 * Tools can be specified in the following ways:
5382 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
5383 * - All tools in a group: `{ group: 'group-name' }`
5384 * - All tools: `'*'`
5388 * @extends OO.ui.Widget
5389 * @mixins OO.ui.GroupElement
5392 * @param {OO.ui.Toolbar} toolbar
5393 * @param {Object} [config] Configuration options
5394 * @cfg {Array|string} [include=[]] List of tools to include
5395 * @cfg {Array|string} [exclude=[]] List of tools to exclude
5396 * @cfg {Array|string} [promote=[]] List of tools to promote to the beginning
5397 * @cfg {Array|string} [demote=[]] List of tools to demote to the end
5399 OO
.ui
.ToolGroup
= function OoUiToolGroup( toolbar
, config
) {
5400 // Configuration initialization
5401 config
= config
|| {};
5403 // Parent constructor
5404 OO
.ui
.ToolGroup
.super.call( this, config
);
5406 // Mixin constructors
5407 OO
.ui
.GroupElement
.call( this, config
);
5410 this.toolbar
= toolbar
;
5412 this.pressed
= null;
5413 this.autoDisabled
= false;
5414 this.include
= config
.include
|| [];
5415 this.exclude
= config
.exclude
|| [];
5416 this.promote
= config
.promote
|| [];
5417 this.demote
= config
.demote
|| [];
5418 this.onCapturedMouseUpHandler
= OO
.ui
.bind( this.onCapturedMouseUp
, this );
5422 'mousedown touchstart': OO
.ui
.bind( this.onPointerDown
, this ),
5423 'mouseup touchend': OO
.ui
.bind( this.onPointerUp
, this ),
5424 mouseover
: OO
.ui
.bind( this.onMouseOver
, this ),
5425 mouseout
: OO
.ui
.bind( this.onMouseOut
, this )
5427 this.toolbar
.getToolFactory().connect( this, { register
: 'onToolFactoryRegister' } );
5428 this.aggregate( { disable
: 'itemDisable' } );
5429 this.connect( this, { itemDisable
: 'updateDisabled' } );
5432 this.$group
.addClass( 'oo-ui-toolGroup-tools' );
5434 .addClass( 'oo-ui-toolGroup' )
5435 .append( this.$group
);
5441 OO
.inheritClass( OO
.ui
.ToolGroup
, OO
.ui
.Widget
);
5442 OO
.mixinClass( OO
.ui
.ToolGroup
, OO
.ui
.GroupElement
);
5450 /* Static Properties */
5453 * Show labels in tooltips.
5457 * @property {boolean}
5459 OO
.ui
.ToolGroup
.static.titleTooltips
= false;
5462 * Show acceleration labels in tooltips.
5466 * @property {boolean}
5468 OO
.ui
.ToolGroup
.static.accelTooltips
= false;
5471 * Automatically disable the toolgroup when all tools are disabled
5475 * @property {boolean}
5477 OO
.ui
.ToolGroup
.static.autoDisable
= true;
5484 OO
.ui
.ToolGroup
.prototype.isDisabled = function () {
5485 return this.autoDisabled
|| OO
.ui
.ToolGroup
.super.prototype.isDisabled
.apply( this, arguments
);
5491 OO
.ui
.ToolGroup
.prototype.updateDisabled = function () {
5492 var i
, item
, allDisabled
= true;
5494 if ( this.constructor.static.autoDisable
) {
5495 for ( i
= this.items
.length
- 1; i
>= 0; i
-- ) {
5496 item
= this.items
[i
];
5497 if ( !item
.isDisabled() ) {
5498 allDisabled
= false;
5502 this.autoDisabled
= allDisabled
;
5504 OO
.ui
.ToolGroup
.super.prototype.updateDisabled
.apply( this, arguments
);
5508 * Handle mouse down events.
5510 * @param {jQuery.Event} e Mouse down event
5512 OO
.ui
.ToolGroup
.prototype.onPointerDown = function ( e
) {
5513 // e.which is 0 for touch events, 1 for left mouse button
5514 if ( !this.isDisabled() && e
.which
<= 1 ) {
5515 this.pressed
= this.getTargetTool( e
);
5516 if ( this.pressed
) {
5517 this.pressed
.setActive( true );
5518 this.getElementDocument().addEventListener(
5519 'mouseup', this.onCapturedMouseUpHandler
, true
5527 * Handle captured mouse up events.
5529 * @param {Event} e Mouse up event
5531 OO
.ui
.ToolGroup
.prototype.onCapturedMouseUp = function ( e
) {
5532 this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseUpHandler
, true );
5533 // onPointerUp may be called a second time, depending on where the mouse is when the button is
5534 // released, but since `this.pressed` will no longer be true, the second call will be ignored.
5535 this.onPointerUp( e
);
5539 * Handle mouse up events.
5541 * @param {jQuery.Event} e Mouse up event
5543 OO
.ui
.ToolGroup
.prototype.onPointerUp = function ( e
) {
5544 var tool
= this.getTargetTool( e
);
5546 // e.which is 0 for touch events, 1 for left mouse button
5547 if ( !this.isDisabled() && e
.which
<= 1 && this.pressed
&& this.pressed
=== tool
) {
5548 this.pressed
.onSelect();
5551 this.pressed
= null;
5556 * Handle mouse over events.
5558 * @param {jQuery.Event} e Mouse over event
5560 OO
.ui
.ToolGroup
.prototype.onMouseOver = function ( e
) {
5561 var tool
= this.getTargetTool( e
);
5563 if ( this.pressed
&& this.pressed
=== tool
) {
5564 this.pressed
.setActive( true );
5569 * Handle mouse out events.
5571 * @param {jQuery.Event} e Mouse out event
5573 OO
.ui
.ToolGroup
.prototype.onMouseOut = function ( e
) {
5574 var tool
= this.getTargetTool( e
);
5576 if ( this.pressed
&& this.pressed
=== tool
) {
5577 this.pressed
.setActive( false );
5582 * Get the closest tool to a jQuery.Event.
5584 * Only tool links are considered, which prevents other elements in the tool such as popups from
5585 * triggering tool group interactions.
5588 * @param {jQuery.Event} e
5589 * @return {OO.ui.Tool|null} Tool, `null` if none was found
5591 OO
.ui
.ToolGroup
.prototype.getTargetTool = function ( e
) {
5593 $item
= this.$( e
.target
).closest( '.oo-ui-tool-link' );
5595 if ( $item
.length
) {
5596 tool
= $item
.parent().data( 'oo-ui-tool' );
5599 return tool
&& !tool
.isDisabled() ? tool
: null;
5603 * Handle tool registry register events.
5605 * If a tool is registered after the group is created, we must repopulate the list to account for:
5607 * - a tool being added that may be included
5608 * - a tool already included being overridden
5610 * @param {string} name Symbolic name of tool
5612 OO
.ui
.ToolGroup
.prototype.onToolFactoryRegister = function () {
5617 * Get the toolbar this group is in.
5619 * @return {OO.ui.Toolbar} Toolbar of group
5621 OO
.ui
.ToolGroup
.prototype.getToolbar = function () {
5622 return this.toolbar
;
5626 * Add and remove tools based on configuration.
5628 OO
.ui
.ToolGroup
.prototype.populate = function () {
5629 var i
, len
, name
, tool
,
5630 toolFactory
= this.toolbar
.getToolFactory(),
5634 list
= this.toolbar
.getToolFactory().getTools(
5635 this.include
, this.exclude
, this.promote
, this.demote
5638 // Build a list of needed tools
5639 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
5643 toolFactory
.lookup( name
) &&
5644 // Tool is available or is already in this group
5645 ( this.toolbar
.isToolAvailable( name
) || this.tools
[name
] )
5647 tool
= this.tools
[name
];
5649 // Auto-initialize tools on first use
5650 this.tools
[name
] = tool
= toolFactory
.create( name
, this );
5653 this.toolbar
.reserveTool( tool
);
5658 // Remove tools that are no longer needed
5659 for ( name
in this.tools
) {
5660 if ( !names
[name
] ) {
5661 this.tools
[name
].destroy();
5662 this.toolbar
.releaseTool( this.tools
[name
] );
5663 remove
.push( this.tools
[name
] );
5664 delete this.tools
[name
];
5667 if ( remove
.length
) {
5668 this.removeItems( remove
);
5670 // Update emptiness state
5672 this.$element
.removeClass( 'oo-ui-toolGroup-empty' );
5674 this.$element
.addClass( 'oo-ui-toolGroup-empty' );
5676 // Re-add tools (moving existing ones to new locations)
5677 this.addItems( add
);
5678 // Disabled state may depend on items
5679 this.updateDisabled();
5683 * Destroy tool group.
5685 OO
.ui
.ToolGroup
.prototype.destroy = function () {
5689 this.toolbar
.getToolFactory().disconnect( this );
5690 for ( name
in this.tools
) {
5691 this.toolbar
.releaseTool( this.tools
[name
] );
5692 this.tools
[name
].disconnect( this ).destroy();
5693 delete this.tools
[name
];
5695 this.$element
.remove();
5699 * Dialog for showing a message.
5702 * - Registers two actions by default (safe and primary).
5703 * - Renders action widgets in the footer.
5706 * @extends OO.ui.Dialog
5709 * @param {Object} [config] Configuration options
5711 OO
.ui
.MessageDialog
= function OoUiMessageDialog( config
) {
5712 // Parent constructor
5713 OO
.ui
.MessageDialog
.super.call( this, config
);
5716 this.verticalActionLayout
= null;
5719 this.$element
.addClass( 'oo-ui-messageDialog' );
5724 OO
.inheritClass( OO
.ui
.MessageDialog
, OO
.ui
.Dialog
);
5726 /* Static Properties */
5728 OO
.ui
.MessageDialog
.static.name
= 'message';
5730 OO
.ui
.MessageDialog
.static.size
= 'small';
5732 OO
.ui
.MessageDialog
.static.verbose
= false;
5737 * A confirmation dialog's title should describe what the progressive action will do. An alert
5738 * dialog's title should describe what event occured.
5742 * @property {jQuery|string|Function|null}
5744 OO
.ui
.MessageDialog
.static.title
= null;
5747 * A confirmation dialog's message should describe the consequences of the progressive action. An
5748 * alert dialog's message should describe why the event occured.
5752 * @property {jQuery|string|Function|null}
5754 OO
.ui
.MessageDialog
.static.message
= null;
5756 OO
.ui
.MessageDialog
.static.actions
= [
5757 { action
: 'accept', label
: OO
.ui
.deferMsg( 'ooui-dialog-message-accept' ), flags
: 'primary' },
5758 { action
: 'reject', label
: OO
.ui
.deferMsg( 'ooui-dialog-message-reject' ), flags
: 'safe' }
5766 OO
.ui
.MessageDialog
.prototype.onActionResize = function ( action
) {
5768 return OO
.ui
.ProcessDialog
.super.prototype.onActionResize
.call( this, action
);
5772 * Toggle action layout between vertical and horizontal.
5774 * @param {boolean} [value] Layout actions vertically, omit to toggle
5777 OO
.ui
.MessageDialog
.prototype.toggleVerticalActionLayout = function ( value
) {
5778 value
= value
=== undefined ? !this.verticalActionLayout
: !!value
;
5780 if ( value
!== this.verticalActionLayout
) {
5781 this.verticalActionLayout
= value
;
5783 .toggleClass( 'oo-ui-messageDialog-actions-vertical', value
)
5784 .toggleClass( 'oo-ui-messageDialog-actions-horizontal', !value
);
5793 OO
.ui
.MessageDialog
.prototype.getActionProcess = function ( action
) {
5795 return new OO
.ui
.Process( function () {
5796 this.close( { action
: action
} );
5799 return OO
.ui
.MessageDialog
.super.prototype.getActionProcess
.call( this, action
);
5805 * @param {Object} [data] Dialog opening data
5806 * @param {jQuery|string|Function|null} [data.title] Description of the action being confirmed
5807 * @param {jQuery|string|Function|null} [data.message] Description of the action's consequence
5808 * @param {boolean} [data.verbose] Message is verbose and should be styled as a long message
5809 * @param {Object[]} [data.actions] List of OO.ui.ActionOptionWidget configuration options for each
5812 OO
.ui
.MessageDialog
.prototype.getSetupProcess = function ( data
) {
5816 return OO
.ui
.MessageDialog
.super.prototype.getSetupProcess
.call( this, data
)
5817 .next( function () {
5818 this.title
.setLabel(
5819 data
.title
!== undefined ? data
.title
: this.constructor.static.title
5821 this.message
.setLabel(
5822 data
.message
!== undefined ? data
.message
: this.constructor.static.message
5824 this.message
.$element
.toggleClass(
5825 'oo-ui-messageDialog-message-verbose',
5826 data
.verbose
!== undefined ? data
.verbose
: this.constructor.static.verbose
5834 OO
.ui
.MessageDialog
.prototype.getBodyHeight = function () {
5835 return Math
.round( this.text
.$element
.outerHeight( true ) );
5841 OO
.ui
.MessageDialog
.prototype.initialize = function () {
5843 OO
.ui
.MessageDialog
.super.prototype.initialize
.call( this );
5846 this.$actions
= this.$( '<div>' );
5847 this.container
= new OO
.ui
.PanelLayout( {
5848 $: this.$, scrollable
: true, classes
: [ 'oo-ui-messageDialog-container' ]
5850 this.text
= new OO
.ui
.PanelLayout( {
5851 $: this.$, padded
: true, expanded
: false, classes
: [ 'oo-ui-messageDialog-text' ]
5853 this.message
= new OO
.ui
.LabelWidget( {
5854 $: this.$, classes
: [ 'oo-ui-messageDialog-message' ]
5858 this.title
.$element
.addClass( 'oo-ui-messageDialog-title' );
5859 this.$content
.addClass( 'oo-ui-messageDialog-content' );
5860 this.container
.$element
.append( this.text
.$element
);
5861 this.text
.$element
.append( this.title
.$element
, this.message
.$element
);
5862 this.$body
.append( this.container
.$element
);
5863 this.$actions
.addClass( 'oo-ui-messageDialog-actions' );
5864 this.$foot
.append( this.$actions
);
5870 OO
.ui
.MessageDialog
.prototype.attachActions = function () {
5871 var i
, len
, other
, special
, others
;
5874 OO
.ui
.MessageDialog
.super.prototype.attachActions
.call( this );
5876 special
= this.actions
.getSpecial();
5877 others
= this.actions
.getOthers();
5878 if ( special
.safe
) {
5879 this.$actions
.append( special
.safe
.$element
);
5880 special
.safe
.toggleFramed( false );
5882 if ( others
.length
) {
5883 for ( i
= 0, len
= others
.length
; i
< len
; i
++ ) {
5885 this.$actions
.append( other
.$element
);
5886 other
.toggleFramed( false );
5889 if ( special
.primary
) {
5890 this.$actions
.append( special
.primary
.$element
);
5891 special
.primary
.toggleFramed( false );
5895 if ( !this.isOpening() ) {
5896 this.manager
.updateWindowSize( this );
5898 this.$body
.css( 'bottom', this.$foot
.outerHeight( true ) );
5902 * Fit action actions into columns or rows.
5904 * Columns will be used if all labels can fit without overflow, otherwise rows will be used.
5906 OO
.ui
.MessageDialog
.prototype.fitActions = function () {
5908 actions
= this.actions
.get();
5911 this.toggleVerticalActionLayout( false );
5912 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
5913 action
= actions
[i
];
5914 if ( action
.$element
.innerWidth() < action
.$label
.outerWidth( true ) ) {
5915 this.toggleVerticalActionLayout( true );
5922 * Navigation dialog window.
5925 * - Show and hide errors.
5926 * - Retry an action.
5929 * - Renders header with dialog title and one action widget on either side
5930 * (a 'safe' button on the left, and a 'primary' button on the right, both of
5931 * which close the dialog).
5932 * - Displays any action widgets in the footer (none by default).
5933 * - Ability to dismiss errors.
5935 * Subclass responsibilities:
5936 * - Register a 'safe' action.
5937 * - Register a 'primary' action.
5938 * - Add content to the dialog.
5942 * @extends OO.ui.Dialog
5945 * @param {Object} [config] Configuration options
5947 OO
.ui
.ProcessDialog
= function OoUiProcessDialog( config
) {
5948 // Parent constructor
5949 OO
.ui
.ProcessDialog
.super.call( this, config
);
5952 this.$element
.addClass( 'oo-ui-processDialog' );
5957 OO
.inheritClass( OO
.ui
.ProcessDialog
, OO
.ui
.Dialog
);
5962 * Handle dismiss button click events.
5966 OO
.ui
.ProcessDialog
.prototype.onDismissErrorButtonClick = function () {
5971 * Handle retry button click events.
5973 * Hides errors and then tries again.
5975 OO
.ui
.ProcessDialog
.prototype.onRetryButtonClick = function () {
5977 this.executeAction( this.currentAction
.getAction() );
5983 OO
.ui
.ProcessDialog
.prototype.onActionResize = function ( action
) {
5984 if ( this.actions
.isSpecial( action
) ) {
5987 return OO
.ui
.ProcessDialog
.super.prototype.onActionResize
.call( this, action
);
5993 OO
.ui
.ProcessDialog
.prototype.initialize = function () {
5995 OO
.ui
.ProcessDialog
.super.prototype.initialize
.call( this );
5998 this.$navigation
= this.$( '<div>' );
5999 this.$location
= this.$( '<div>' );
6000 this.$safeActions
= this.$( '<div>' );
6001 this.$primaryActions
= this.$( '<div>' );
6002 this.$otherActions
= this.$( '<div>' );
6003 this.dismissButton
= new OO
.ui
.ButtonWidget( {
6005 label
: OO
.ui
.msg( 'ooui-dialog-process-dismiss' )
6007 this.retryButton
= new OO
.ui
.ButtonWidget( {
6009 label
: OO
.ui
.msg( 'ooui-dialog-process-retry' )
6011 this.$errors
= this.$( '<div>' );
6012 this.$errorsTitle
= this.$( '<div>' );
6015 this.dismissButton
.connect( this, { click
: 'onDismissErrorButtonClick' } );
6016 this.retryButton
.connect( this, { click
: 'onRetryButtonClick' } );
6019 this.title
.$element
.addClass( 'oo-ui-processDialog-title' );
6021 .append( this.title
.$element
)
6022 .addClass( 'oo-ui-processDialog-location' );
6023 this.$safeActions
.addClass( 'oo-ui-processDialog-actions-safe' );
6024 this.$primaryActions
.addClass( 'oo-ui-processDialog-actions-primary' );
6025 this.$otherActions
.addClass( 'oo-ui-processDialog-actions-other' );
6027 .addClass( 'oo-ui-processDialog-errors-title' )
6028 .text( OO
.ui
.msg( 'ooui-dialog-process-error' ) );
6030 .addClass( 'oo-ui-processDialog-errors' )
6031 .append( this.$errorsTitle
, this.dismissButton
.$element
, this.retryButton
.$element
);
6033 .addClass( 'oo-ui-processDialog-content' )
6034 .append( this.$errors
);
6036 .addClass( 'oo-ui-processDialog-navigation' )
6037 .append( this.$safeActions
, this.$location
, this.$primaryActions
);
6038 this.$head
.append( this.$navigation
);
6039 this.$foot
.append( this.$otherActions
);
6045 OO
.ui
.ProcessDialog
.prototype.attachActions = function () {
6046 var i
, len
, other
, special
, others
;
6049 OO
.ui
.ProcessDialog
.super.prototype.attachActions
.call( this );
6051 special
= this.actions
.getSpecial();
6052 others
= this.actions
.getOthers();
6053 if ( special
.primary
) {
6054 this.$primaryActions
.append( special
.primary
.$element
);
6055 special
.primary
.toggleFramed( true );
6057 if ( others
.length
) {
6058 for ( i
= 0, len
= others
.length
; i
< len
; i
++ ) {
6060 this.$otherActions
.append( other
.$element
);
6061 other
.toggleFramed( true );
6064 if ( special
.safe
) {
6065 this.$safeActions
.append( special
.safe
.$element
);
6066 special
.safe
.toggleFramed( true );
6070 this.$body
.css( 'bottom', this.$foot
.outerHeight( true ) );
6076 OO
.ui
.ProcessDialog
.prototype.executeAction = function ( action
) {
6077 OO
.ui
.ProcessDialog
.super.prototype.executeAction
.call( this, action
)
6078 .fail( OO
.ui
.bind( this.showErrors
, this ) );
6082 * Fit label between actions.
6086 OO
.ui
.ProcessDialog
.prototype.fitLabel = function () {
6087 var width
= Math
.max(
6088 this.$safeActions
.is( ':visible' ) ? this.$safeActions
.width() : 0,
6089 this.$primaryActions
.is( ':visible' ) ? this.$primaryActions
.width() : 0
6091 this.$location
.css( { paddingLeft
: width
, paddingRight
: width
} );
6097 * Handle errors that occured durring accept or reject processes.
6099 * @param {OO.ui.Error[]} errors Errors to be handled
6101 OO
.ui
.ProcessDialog
.prototype.showErrors = function ( errors
) {
6106 for ( i
= 0, len
= errors
.length
; i
< len
; i
++ ) {
6107 if ( !errors
[i
].isRecoverable() ) {
6108 recoverable
= false;
6110 $item
= this.$( '<div>' )
6111 .addClass( 'oo-ui-processDialog-error' )
6112 .append( errors
[i
].getMessage() );
6113 items
.push( $item
[0] );
6115 this.$errorItems
= this.$( items
);
6116 if ( recoverable
) {
6117 this.retryButton
.clearFlags().setFlags( this.currentAction
.getFlags() );
6119 this.currentAction
.setDisabled( true );
6121 this.retryButton
.toggle( recoverable
);
6122 this.$errorsTitle
.after( this.$errorItems
);
6123 this.$errors
.show().scrollTop( 0 );
6129 OO
.ui
.ProcessDialog
.prototype.hideErrors = function () {
6130 this.$errors
.hide();
6131 this.$errorItems
.remove();
6132 this.$errorItems
= null;
6136 * Layout containing a series of pages.
6139 * @extends OO.ui.Layout
6142 * @param {Object} [config] Configuration options
6143 * @cfg {boolean} [continuous=false] Show all pages, one after another
6144 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when changing to a page
6145 * @cfg {boolean} [outlined=false] Show an outline
6146 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
6148 OO
.ui
.BookletLayout
= function OoUiBookletLayout( config
) {
6149 // Initialize configuration
6150 config
= config
|| {};
6152 // Parent constructor
6153 OO
.ui
.BookletLayout
.super.call( this, config
);
6156 this.currentPageName
= null;
6158 this.ignoreFocus
= false;
6159 this.stackLayout
= new OO
.ui
.StackLayout( { $: this.$, continuous
: !!config
.continuous
} );
6160 this.autoFocus
= config
.autoFocus
=== undefined || !!config
.autoFocus
;
6161 this.outlineVisible
= false;
6162 this.outlined
= !!config
.outlined
;
6163 if ( this.outlined
) {
6164 this.editable
= !!config
.editable
;
6165 this.outlineControlsWidget
= null;
6166 this.outlineWidget
= new OO
.ui
.OutlineWidget( { $: this.$ } );
6167 this.outlinePanel
= new OO
.ui
.PanelLayout( { $: this.$, scrollable
: true } );
6168 this.gridLayout
= new OO
.ui
.GridLayout(
6169 [ this.outlinePanel
, this.stackLayout
],
6170 { $: this.$, widths
: [ 1, 2 ] }
6172 this.outlineVisible
= true;
6173 if ( this.editable
) {
6174 this.outlineControlsWidget
= new OO
.ui
.OutlineControlsWidget(
6175 this.outlineWidget
, { $: this.$ }
6181 this.stackLayout
.connect( this, { set: 'onStackLayoutSet' } );
6182 if ( this.outlined
) {
6183 this.outlineWidget
.connect( this, { select
: 'onOutlineWidgetSelect' } );
6185 if ( this.autoFocus
) {
6186 // Event 'focus' does not bubble, but 'focusin' does
6187 this.stackLayout
.onDOMEvent( 'focusin', OO
.ui
.bind( this.onStackLayoutFocus
, this ) );
6191 this.$element
.addClass( 'oo-ui-bookletLayout' );
6192 this.stackLayout
.$element
.addClass( 'oo-ui-bookletLayout-stackLayout' );
6193 if ( this.outlined
) {
6194 this.outlinePanel
.$element
6195 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
6196 .append( this.outlineWidget
.$element
);
6197 if ( this.editable
) {
6198 this.outlinePanel
.$element
6199 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
6200 .append( this.outlineControlsWidget
.$element
);
6202 this.$element
.append( this.gridLayout
.$element
);
6204 this.$element
.append( this.stackLayout
.$element
);
6210 OO
.inheritClass( OO
.ui
.BookletLayout
, OO
.ui
.Layout
);
6216 * @param {OO.ui.PageLayout} page Current page
6221 * @param {OO.ui.PageLayout[]} page Added pages
6222 * @param {number} index Index pages were added at
6227 * @param {OO.ui.PageLayout[]} pages Removed pages
6233 * Handle stack layout focus.
6235 * @param {jQuery.Event} e Focusin event
6237 OO
.ui
.BookletLayout
.prototype.onStackLayoutFocus = function ( e
) {
6240 // Find the page that an element was focused within
6241 $target
= $( e
.target
).closest( '.oo-ui-pageLayout' );
6242 for ( name
in this.pages
) {
6243 // Check for page match, exclude current page to find only page changes
6244 if ( this.pages
[name
].$element
[0] === $target
[0] && name
!== this.currentPageName
) {
6245 this.setPage( name
);
6252 * Handle stack layout set events.
6254 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
6256 OO
.ui
.BookletLayout
.prototype.onStackLayoutSet = function ( page
) {
6257 var $input
, layout
= this;
6259 page
.scrollElementIntoView( { complete: function () {
6260 if ( layout
.autoFocus
) {
6261 // Set focus to the first input if nothing on the page is focused yet
6262 if ( !page
.$element
.find( ':focus' ).length
) {
6263 $input
= page
.$element
.find( ':input:first' );
6264 if ( $input
.length
) {
6274 * Handle outline widget select events.
6276 * @param {OO.ui.OptionWidget|null} item Selected item
6278 OO
.ui
.BookletLayout
.prototype.onOutlineWidgetSelect = function ( item
) {
6280 this.setPage( item
.getData() );
6285 * Check if booklet has an outline.
6289 OO
.ui
.BookletLayout
.prototype.isOutlined = function () {
6290 return this.outlined
;
6294 * Check if booklet has editing controls.
6298 OO
.ui
.BookletLayout
.prototype.isEditable = function () {
6299 return this.editable
;
6303 * Check if booklet has a visible outline.
6307 OO
.ui
.BookletLayout
.prototype.isOutlineVisible = function () {
6308 return this.outlined
&& this.outlineVisible
;
6312 * Hide or show the outline.
6314 * @param {boolean} [show] Show outline, omit to invert current state
6317 OO
.ui
.BookletLayout
.prototype.toggleOutline = function ( show
) {
6318 if ( this.outlined
) {
6319 show
= show
=== undefined ? !this.outlineVisible
: !!show
;
6320 this.outlineVisible
= show
;
6321 this.gridLayout
.layout( show
? [ 1, 2 ] : [ 0, 1 ], [ 1 ] );
6328 * Get the outline widget.
6330 * @param {OO.ui.PageLayout} page Page to be selected
6331 * @return {OO.ui.PageLayout|null} Closest page to another
6333 OO
.ui
.BookletLayout
.prototype.getClosestPage = function ( page
) {
6334 var next
, prev
, level
,
6335 pages
= this.stackLayout
.getItems(),
6336 index
= $.inArray( page
, pages
);
6338 if ( index
!== -1 ) {
6339 next
= pages
[index
+ 1];
6340 prev
= pages
[index
- 1];
6341 // Prefer adjacent pages at the same level
6342 if ( this.outlined
) {
6343 level
= this.outlineWidget
.getItemFromData( page
.getName() ).getLevel();
6346 level
=== this.outlineWidget
.getItemFromData( prev
.getName() ).getLevel()
6352 level
=== this.outlineWidget
.getItemFromData( next
.getName() ).getLevel()
6358 return prev
|| next
|| null;
6362 * Get the outline widget.
6364 * @return {OO.ui.OutlineWidget|null} Outline widget, or null if boolet has no outline
6366 OO
.ui
.BookletLayout
.prototype.getOutline = function () {
6367 return this.outlineWidget
;
6371 * Get the outline controls widget. If the outline is not editable, null is returned.
6373 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
6375 OO
.ui
.BookletLayout
.prototype.getOutlineControls = function () {
6376 return this.outlineControlsWidget
;
6380 * Get a page by name.
6382 * @param {string} name Symbolic name of page
6383 * @return {OO.ui.PageLayout|undefined} Page, if found
6385 OO
.ui
.BookletLayout
.prototype.getPage = function ( name
) {
6386 return this.pages
[name
];
6390 * Get the current page name.
6392 * @return {string|null} Current page name
6394 OO
.ui
.BookletLayout
.prototype.getPageName = function () {
6395 return this.currentPageName
;
6399 * Add a page to the layout.
6401 * When pages are added with the same names as existing pages, the existing pages will be
6402 * automatically removed before the new pages are added.
6404 * @param {OO.ui.PageLayout[]} pages Pages to add
6405 * @param {number} index Index to insert pages after
6409 OO
.ui
.BookletLayout
.prototype.addPages = function ( pages
, index
) {
6410 var i
, len
, name
, page
, item
, currentIndex
,
6411 stackLayoutPages
= this.stackLayout
.getItems(),
6415 // Remove pages with same names
6416 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
6418 name
= page
.getName();
6420 if ( Object
.prototype.hasOwnProperty
.call( this.pages
, name
) ) {
6421 // Correct the insertion index
6422 currentIndex
= $.inArray( this.pages
[name
], stackLayoutPages
);
6423 if ( currentIndex
!== -1 && currentIndex
+ 1 < index
) {
6426 remove
.push( this.pages
[name
] );
6429 if ( remove
.length
) {
6430 this.removePages( remove
);
6434 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
6436 name
= page
.getName();
6437 this.pages
[page
.getName()] = page
;
6438 if ( this.outlined
) {
6439 item
= new OO
.ui
.OutlineItemWidget( name
, page
, { $: this.$ } );
6440 page
.setOutlineItem( item
);
6445 if ( this.outlined
&& items
.length
) {
6446 this.outlineWidget
.addItems( items
, index
);
6447 this.updateOutlineWidget();
6449 this.stackLayout
.addItems( pages
, index
);
6450 this.emit( 'add', pages
, index
);
6456 * Remove a page from the layout.
6461 OO
.ui
.BookletLayout
.prototype.removePages = function ( pages
) {
6462 var i
, len
, name
, page
,
6465 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
6467 name
= page
.getName();
6468 delete this.pages
[name
];
6469 if ( this.outlined
) {
6470 items
.push( this.outlineWidget
.getItemFromData( name
) );
6471 page
.setOutlineItem( null );
6474 if ( this.outlined
&& items
.length
) {
6475 this.outlineWidget
.removeItems( items
);
6476 this.updateOutlineWidget();
6478 this.stackLayout
.removeItems( pages
);
6479 this.emit( 'remove', pages
);
6485 * Clear all pages from the layout.
6490 OO
.ui
.BookletLayout
.prototype.clearPages = function () {
6492 pages
= this.stackLayout
.getItems();
6495 this.currentPageName
= null;
6496 if ( this.outlined
) {
6497 this.outlineWidget
.clearItems();
6498 for ( i
= 0, len
= pages
.length
; i
< len
; i
++ ) {
6499 pages
[i
].setOutlineItem( null );
6502 this.stackLayout
.clearItems();
6504 this.emit( 'remove', pages
);
6510 * Set the current page by name.
6513 * @param {string} name Symbolic name of page
6515 OO
.ui
.BookletLayout
.prototype.setPage = function ( name
) {
6518 page
= this.pages
[name
];
6520 if ( name
!== this.currentPageName
) {
6521 if ( this.outlined
) {
6522 selectedItem
= this.outlineWidget
.getSelectedItem();
6523 if ( selectedItem
&& selectedItem
.getData() !== name
) {
6524 this.outlineWidget
.selectItem( this.outlineWidget
.getItemFromData( name
) );
6528 if ( this.currentPageName
&& this.pages
[this.currentPageName
] ) {
6529 this.pages
[this.currentPageName
].setActive( false );
6530 // Blur anything focused if the next page doesn't have anything focusable - this
6531 // is not needed if the next page has something focusable because once it is focused
6532 // this blur happens automatically
6533 if ( this.autoFocus
&& !page
.$element
.find( ':input' ).length
) {
6534 $focused
= this.pages
[this.currentPageName
].$element
.find( ':focus' );
6535 if ( $focused
.length
) {
6540 this.currentPageName
= name
;
6541 this.stackLayout
.setItem( page
);
6542 page
.setActive( true );
6543 this.emit( 'set', page
);
6549 * Call this after adding or removing items from the OutlineWidget.
6553 OO
.ui
.BookletLayout
.prototype.updateOutlineWidget = function () {
6554 // Auto-select first item when nothing is selected anymore
6555 if ( !this.outlineWidget
.getSelectedItem() ) {
6556 this.outlineWidget
.selectItem( this.outlineWidget
.getFirstSelectableItem() );
6563 * Layout made of a field and optional label.
6566 * @extends OO.ui.Layout
6567 * @mixins OO.ui.LabelElement
6569 * Available label alignment modes include:
6570 * - left: Label is before the field and aligned away from it, best for when the user will be
6571 * scanning for a specific label in a form with many fields
6572 * - right: Label is before the field and aligned toward it, best for forms the user is very
6573 * familiar with and will tab through field checking quickly to verify which field they are in
6574 * - top: Label is before the field and above it, best for when the use will need to fill out all
6575 * fields from top to bottom in a form with few fields
6576 * - inline: Label is after the field and aligned toward it, best for small boolean fields like
6577 * checkboxes or radio buttons
6580 * @param {OO.ui.Widget} field Field widget
6581 * @param {Object} [config] Configuration options
6582 * @cfg {string} [align='left'] Alignment mode, either 'left', 'right', 'top' or 'inline'
6583 * @cfg {string} [help] Explanatory text shown as a '?' icon.
6585 OO
.ui
.FieldLayout
= function OoUiFieldLayout( field
, config
) {
6586 // Config initialization
6587 config
= $.extend( { align
: 'left' }, config
);
6589 // Parent constructor
6590 OO
.ui
.FieldLayout
.super.call( this, config
);
6592 // Mixin constructors
6593 OO
.ui
.LabelElement
.call( this, config
);
6596 this.$field
= this.$( '<div>' );
6599 if ( config
.help
) {
6600 this.popupButtonWidget
= new OO
.ui
.PopupButtonWidget( {
6602 classes
: [ 'oo-ui-fieldLayout-help' ],
6607 this.popupButtonWidget
.getPopup().$body
.append(
6609 .text( config
.help
)
6610 .addClass( 'oo-ui-fieldLayout-help-content' )
6612 this.$help
= this.popupButtonWidget
.$element
;
6614 this.$help
= this.$( [] );
6618 if ( this.field
instanceof OO
.ui
.InputWidget
) {
6619 this.$label
.on( 'click', OO
.ui
.bind( this.onLabelClick
, this ) );
6621 this.field
.connect( this, { disable
: 'onFieldDisable' } );
6624 this.$element
.addClass( 'oo-ui-fieldLayout' );
6626 .addClass( 'oo-ui-fieldLayout-field' )
6627 .toggleClass( 'oo-ui-fieldLayout-disable', this.field
.isDisabled() )
6628 .append( this.field
.$element
);
6629 this.setAlignment( config
.align
);
6634 OO
.inheritClass( OO
.ui
.FieldLayout
, OO
.ui
.Layout
);
6635 OO
.mixinClass( OO
.ui
.FieldLayout
, OO
.ui
.LabelElement
);
6640 * Handle field disable events.
6642 * @param {boolean} value Field is disabled
6644 OO
.ui
.FieldLayout
.prototype.onFieldDisable = function ( value
) {
6645 this.$element
.toggleClass( 'oo-ui-fieldLayout-disabled', value
);
6649 * Handle label mouse click events.
6651 * @param {jQuery.Event} e Mouse click event
6653 OO
.ui
.FieldLayout
.prototype.onLabelClick = function () {
6654 this.field
.simulateLabelClick();
6661 * @return {OO.ui.Widget} Field widget
6663 OO
.ui
.FieldLayout
.prototype.getField = function () {
6668 * Set the field alignment mode.
6670 * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
6673 OO
.ui
.FieldLayout
.prototype.setAlignment = function ( value
) {
6674 if ( value
!== this.align
) {
6675 // Default to 'left'
6676 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value
) === -1 ) {
6680 if ( value
=== 'inline' ) {
6681 this.$element
.append( this.$field
, this.$label
, this.$help
);
6683 this.$element
.append( this.$help
, this.$label
, this.$field
);
6687 this.$element
.removeClass( 'oo-ui-fieldLayout-align-' + this.align
);
6690 // The following classes can be used here:
6691 // oo-ui-fieldLayout-align-left
6692 // oo-ui-fieldLayout-align-right
6693 // oo-ui-fieldLayout-align-top
6694 // oo-ui-fieldLayout-align-inline
6695 this.$element
.addClass( 'oo-ui-fieldLayout-align-' + this.align
);
6702 * Layout made of a fieldset and optional legend.
6704 * Just add OO.ui.FieldLayout items.
6707 * @extends OO.ui.Layout
6708 * @mixins OO.ui.LabelElement
6709 * @mixins OO.ui.IconElement
6710 * @mixins OO.ui.GroupElement
6713 * @param {Object} [config] Configuration options
6714 * @cfg {string} [icon] Symbolic icon name
6715 * @cfg {OO.ui.FieldLayout[]} [items] Items to add
6717 OO
.ui
.FieldsetLayout
= function OoUiFieldsetLayout( config
) {
6718 // Config initialization
6719 config
= config
|| {};
6721 // Parent constructor
6722 OO
.ui
.FieldsetLayout
.super.call( this, config
);
6724 // Mixin constructors
6725 OO
.ui
.IconElement
.call( this, config
);
6726 OO
.ui
.LabelElement
.call( this, config
);
6727 OO
.ui
.GroupElement
.call( this, config
);
6731 .addClass( 'oo-ui-fieldsetLayout' )
6732 .prepend( this.$icon
, this.$label
, this.$group
);
6733 if ( $.isArray( config
.items
) ) {
6734 this.addItems( config
.items
);
6740 OO
.inheritClass( OO
.ui
.FieldsetLayout
, OO
.ui
.Layout
);
6741 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.IconElement
);
6742 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.LabelElement
);
6743 OO
.mixinClass( OO
.ui
.FieldsetLayout
, OO
.ui
.GroupElement
);
6745 /* Static Properties */
6747 OO
.ui
.FieldsetLayout
.static.tagName
= 'div';
6750 * Layout with an HTML form.
6753 * @extends OO.ui.Layout
6756 * @param {Object} [config] Configuration options
6758 OO
.ui
.FormLayout
= function OoUiFormLayout( config
) {
6759 // Configuration initialization
6760 config
= config
|| {};
6762 // Parent constructor
6763 OO
.ui
.FormLayout
.super.call( this, config
);
6766 this.$element
.on( 'submit', OO
.ui
.bind( this.onFormSubmit
, this ) );
6769 this.$element
.addClass( 'oo-ui-formLayout' );
6774 OO
.inheritClass( OO
.ui
.FormLayout
, OO
.ui
.Layout
);
6782 /* Static Properties */
6784 OO
.ui
.FormLayout
.static.tagName
= 'form';
6789 * Handle form submit events.
6791 * @param {jQuery.Event} e Submit event
6794 OO
.ui
.FormLayout
.prototype.onFormSubmit = function () {
6795 this.emit( 'submit' );
6800 * Layout made of proportionally sized columns and rows.
6803 * @extends OO.ui.Layout
6806 * @param {OO.ui.PanelLayout[]} panels Panels in the grid
6807 * @param {Object} [config] Configuration options
6808 * @cfg {number[]} [widths] Widths of columns as ratios
6809 * @cfg {number[]} [heights] Heights of columns as ratios
6811 OO
.ui
.GridLayout
= function OoUiGridLayout( panels
, config
) {
6814 // Config initialization
6815 config
= config
|| {};
6817 // Parent constructor
6818 OO
.ui
.GridLayout
.super.call( this, config
);
6826 this.$element
.addClass( 'oo-ui-gridLayout' );
6827 for ( i
= 0, len
= panels
.length
; i
< len
; i
++ ) {
6828 this.panels
.push( panels
[i
] );
6829 this.$element
.append( panels
[i
].$element
);
6831 if ( config
.widths
|| config
.heights
) {
6832 this.layout( config
.widths
|| [ 1 ], config
.heights
|| [ 1 ] );
6834 // Arrange in columns by default
6836 for ( i
= 0, len
= this.panels
.length
; i
< len
; i
++ ) {
6839 this.layout( widths
, [ 1 ] );
6845 OO
.inheritClass( OO
.ui
.GridLayout
, OO
.ui
.Layout
);
6857 /* Static Properties */
6859 OO
.ui
.GridLayout
.static.tagName
= 'div';
6864 * Set grid dimensions.
6866 * @param {number[]} widths Widths of columns as ratios
6867 * @param {number[]} heights Heights of rows as ratios
6869 * @throws {Error} If grid is not large enough to fit all panels
6871 OO
.ui
.GridLayout
.prototype.layout = function ( widths
, heights
) {
6875 cols
= widths
.length
,
6876 rows
= heights
.length
;
6878 // Verify grid is big enough to fit panels
6879 if ( cols
* rows
< this.panels
.length
) {
6880 throw new Error( 'Grid is not large enough to fit ' + this.panels
.length
+ 'panels' );
6883 // Sum up denominators
6884 for ( x
= 0; x
< cols
; x
++ ) {
6887 for ( y
= 0; y
< rows
; y
++ ) {
6893 for ( x
= 0; x
< cols
; x
++ ) {
6894 this.widths
[x
] = widths
[x
] / xd
;
6896 for ( y
= 0; y
< rows
; y
++ ) {
6897 this.heights
[y
] = heights
[y
] / yd
;
6901 this.emit( 'layout' );
6905 * Update panel positions and sizes.
6909 OO
.ui
.GridLayout
.prototype.update = function () {
6917 cols
= this.widths
.length
,
6918 rows
= this.heights
.length
;
6920 for ( y
= 0; y
< rows
; y
++ ) {
6921 height
= this.heights
[y
];
6922 for ( x
= 0; x
< cols
; x
++ ) {
6923 panel
= this.panels
[i
];
6924 width
= this.widths
[x
];
6926 width
: Math
.round( width
* 100 ) + '%',
6927 height
: Math
.round( height
* 100 ) + '%',
6928 top
: Math
.round( top
* 100 ) + '%',
6929 // HACK: Work around IE bug by setting visibility: hidden; if width or height is zero
6930 visibility
: width
=== 0 || height
=== 0 ? 'hidden' : ''
6933 if ( OO
.ui
.Element
.getDir( this.$.context
) === 'rtl' ) {
6934 dimensions
.right
= Math
.round( left
* 100 ) + '%';
6936 dimensions
.left
= Math
.round( left
* 100 ) + '%';
6938 panel
.$element
.css( dimensions
);
6946 this.emit( 'update' );
6950 * Get a panel at a given position.
6952 * The x and y position is affected by the current grid layout.
6954 * @param {number} x Horizontal position
6955 * @param {number} y Vertical position
6956 * @return {OO.ui.PanelLayout} The panel at the given postion
6958 OO
.ui
.GridLayout
.prototype.getPanel = function ( x
, y
) {
6959 return this.panels
[( x
* this.widths
.length
) + y
];
6963 * Layout that expands to cover the entire area of its parent, with optional scrolling and padding.
6966 * @extends OO.ui.Layout
6969 * @param {Object} [config] Configuration options
6970 * @cfg {boolean} [scrollable=false] Allow vertical scrolling
6971 * @cfg {boolean} [padded=false] Pad the content from the edges
6972 * @cfg {boolean} [expanded=true] Expand size to fill the entire parent element
6974 OO
.ui
.PanelLayout
= function OoUiPanelLayout( config
) {
6975 // Config initialization
6976 config
= config
|| {};
6978 // Parent constructor
6979 OO
.ui
.PanelLayout
.super.call( this, config
);
6982 this.$element
.addClass( 'oo-ui-panelLayout' );
6983 if ( config
.scrollable
) {
6984 this.$element
.addClass( 'oo-ui-panelLayout-scrollable' );
6987 if ( config
.padded
) {
6988 this.$element
.addClass( 'oo-ui-panelLayout-padded' );
6991 if ( config
.expanded
=== undefined || config
.expanded
) {
6992 this.$element
.addClass( 'oo-ui-panelLayout-expanded' );
6998 OO
.inheritClass( OO
.ui
.PanelLayout
, OO
.ui
.Layout
);
7001 * Page within an booklet layout.
7004 * @extends OO.ui.PanelLayout
7007 * @param {string} name Unique symbolic name of page
7008 * @param {Object} [config] Configuration options
7009 * @param {string} [outlineItem] Outline item widget
7011 OO
.ui
.PageLayout
= function OoUiPageLayout( name
, config
) {
7012 // Configuration initialization
7013 config
= $.extend( { scrollable
: true }, config
);
7015 // Parent constructor
7016 OO
.ui
.PageLayout
.super.call( this, config
);
7020 this.outlineItem
= config
.outlineItem
|| null;
7021 this.active
= false;
7024 this.$element
.addClass( 'oo-ui-pageLayout' );
7029 OO
.inheritClass( OO
.ui
.PageLayout
, OO
.ui
.PanelLayout
);
7035 * @param {boolean} active Page is active
7043 * @return {string} Symbolic name of page
7045 OO
.ui
.PageLayout
.prototype.getName = function () {
7050 * Check if page is active.
7052 * @return {boolean} Page is active
7054 OO
.ui
.PageLayout
.prototype.isActive = function () {
7061 * @return {OO.ui.OutlineItemWidget|null} Outline item widget
7063 OO
.ui
.PageLayout
.prototype.getOutlineItem = function () {
7064 return this.outlineItem
;
7070 * @localdoc Subclasses should override #setupOutlineItem instead of this method to adjust the
7071 * outline item as desired; this method is called for setting (with an object) and unsetting
7072 * (with null) and overriding methods would have to check the value of `outlineItem` to avoid
7073 * operating on null instead of an OO.ui.OutlineItemWidget object.
7075 * @param {OO.ui.OutlineItemWidget|null} outlineItem Outline item widget, null to clear
7078 OO
.ui
.PageLayout
.prototype.setOutlineItem = function ( outlineItem
) {
7079 this.outlineItem
= outlineItem
|| null;
7080 if ( outlineItem
) {
7081 this.setupOutlineItem();
7087 * Setup outline item.
7089 * @localdoc Subclasses should override this method to adjust the outline item as desired.
7091 * @param {OO.ui.OutlineItemWidget} outlineItem Outline item widget to setup
7094 OO
.ui
.PageLayout
.prototype.setupOutlineItem = function () {
7099 * Set page active state.
7101 * @param {boolean} Page is active
7104 OO
.ui
.PageLayout
.prototype.setActive = function ( active
) {
7107 if ( active
!== this.active
) {
7108 this.active
= active
;
7109 this.$element
.toggleClass( 'oo-ui-pageLayout-active', active
);
7110 this.emit( 'active', this.active
);
7115 * Layout containing a series of mutually exclusive pages.
7118 * @extends OO.ui.PanelLayout
7119 * @mixins OO.ui.GroupElement
7122 * @param {Object} [config] Configuration options
7123 * @cfg {boolean} [continuous=false] Show all pages, one after another
7124 * @cfg {string} [icon=''] Symbolic icon name
7125 * @cfg {OO.ui.Layout[]} [items] Layouts to add
7127 OO
.ui
.StackLayout
= function OoUiStackLayout( config
) {
7128 // Config initialization
7129 config
= $.extend( { scrollable
: true }, config
);
7131 // Parent constructor
7132 OO
.ui
.StackLayout
.super.call( this, config
);
7134 // Mixin constructors
7135 OO
.ui
.GroupElement
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
7138 this.currentItem
= null;
7139 this.continuous
= !!config
.continuous
;
7142 this.$element
.addClass( 'oo-ui-stackLayout' );
7143 if ( this.continuous
) {
7144 this.$element
.addClass( 'oo-ui-stackLayout-continuous' );
7146 if ( $.isArray( config
.items
) ) {
7147 this.addItems( config
.items
);
7153 OO
.inheritClass( OO
.ui
.StackLayout
, OO
.ui
.PanelLayout
);
7154 OO
.mixinClass( OO
.ui
.StackLayout
, OO
.ui
.GroupElement
);
7160 * @param {OO.ui.Layout|null} item Current item or null if there is no longer a layout shown
7166 * Get the current item.
7168 * @return {OO.ui.Layout|null}
7170 OO
.ui
.StackLayout
.prototype.getCurrentItem = function () {
7171 return this.currentItem
;
7175 * Unset the current item.
7178 * @param {OO.ui.StackLayout} layout
7181 OO
.ui
.StackLayout
.prototype.unsetCurrentItem = function () {
7182 var prevItem
= this.currentItem
;
7183 if ( prevItem
=== null ) {
7187 this.currentItem
= null;
7188 this.emit( 'set', null );
7194 * Adding an existing item (by value) will move it.
7196 * @param {OO.ui.Layout[]} items Items to add
7197 * @param {number} [index] Index to insert items after
7200 OO
.ui
.StackLayout
.prototype.addItems = function ( items
, index
) {
7202 OO
.ui
.GroupElement
.prototype.addItems
.call( this, items
, index
);
7204 if ( !this.currentItem
&& items
.length
) {
7205 this.setItem( items
[0] );
7214 * Items will be detached, not removed, so they can be used later.
7216 * @param {OO.ui.Layout[]} items Items to remove
7220 OO
.ui
.StackLayout
.prototype.removeItems = function ( items
) {
7222 OO
.ui
.GroupElement
.prototype.removeItems
.call( this, items
);
7224 if ( $.inArray( this.currentItem
, items
) !== -1 ) {
7225 if ( this.items
.length
) {
7226 this.setItem( this.items
[0] );
7228 this.unsetCurrentItem();
7238 * Items will be detached, not removed, so they can be used later.
7243 OO
.ui
.StackLayout
.prototype.clearItems = function () {
7244 this.unsetCurrentItem();
7245 OO
.ui
.GroupElement
.prototype.clearItems
.call( this );
7253 * Any currently shown item will be hidden.
7255 * FIXME: If the passed item to show has not been added in the items list, then
7256 * this method drops it and unsets the current item.
7258 * @param {OO.ui.Layout} item Item to show
7262 OO
.ui
.StackLayout
.prototype.setItem = function ( item
) {
7265 if ( item
!== this.currentItem
) {
7266 if ( !this.continuous
) {
7267 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
7268 this.items
[i
].$element
.css( 'display', '' );
7271 if ( $.inArray( item
, this.items
) !== -1 ) {
7272 if ( !this.continuous
) {
7273 item
.$element
.css( 'display', 'block' );
7275 this.currentItem
= item
;
7276 this.emit( 'set', item
);
7278 this.unsetCurrentItem();
7286 * Horizontal bar layout of tools as icon buttons.
7289 * @extends OO.ui.ToolGroup
7292 * @param {OO.ui.Toolbar} toolbar
7293 * @param {Object} [config] Configuration options
7295 OO
.ui
.BarToolGroup
= function OoUiBarToolGroup( toolbar
, config
) {
7296 // Parent constructor
7297 OO
.ui
.BarToolGroup
.super.call( this, toolbar
, config
);
7300 this.$element
.addClass( 'oo-ui-barToolGroup' );
7305 OO
.inheritClass( OO
.ui
.BarToolGroup
, OO
.ui
.ToolGroup
);
7307 /* Static Properties */
7309 OO
.ui
.BarToolGroup
.static.titleTooltips
= true;
7311 OO
.ui
.BarToolGroup
.static.accelTooltips
= true;
7313 OO
.ui
.BarToolGroup
.static.name
= 'bar';
7316 * Popup list of tools with an icon and optional label.
7320 * @extends OO.ui.ToolGroup
7321 * @mixins OO.ui.IconElement
7322 * @mixins OO.ui.IndicatorElement
7323 * @mixins OO.ui.LabelElement
7324 * @mixins OO.ui.TitledElement
7325 * @mixins OO.ui.ClippableElement
7328 * @param {OO.ui.Toolbar} toolbar
7329 * @param {Object} [config] Configuration options
7330 * @cfg {string} [header] Text to display at the top of the pop-up
7332 OO
.ui
.PopupToolGroup
= function OoUiPopupToolGroup( toolbar
, config
) {
7333 // Configuration initialization
7334 config
= config
|| {};
7336 // Parent constructor
7337 OO
.ui
.PopupToolGroup
.super.call( this, toolbar
, config
);
7339 // Mixin constructors
7340 OO
.ui
.IconElement
.call( this, config
);
7341 OO
.ui
.IndicatorElement
.call( this, config
);
7342 OO
.ui
.LabelElement
.call( this, config
);
7343 OO
.ui
.TitledElement
.call( this, config
);
7344 OO
.ui
.ClippableElement
.call( this, $.extend( {}, config
, { $clippable
: this.$group
} ) );
7347 this.active
= false;
7348 this.dragging
= false;
7349 this.onBlurHandler
= OO
.ui
.bind( this.onBlur
, this );
7350 this.$handle
= this.$( '<span>' );
7354 'mousedown touchstart': OO
.ui
.bind( this.onHandlePointerDown
, this ),
7355 'mouseup touchend': OO
.ui
.bind( this.onHandlePointerUp
, this )
7360 .addClass( 'oo-ui-popupToolGroup-handle' )
7361 .append( this.$icon
, this.$label
, this.$indicator
);
7362 // If the pop-up should have a header, add it to the top of the toolGroup.
7363 // Note: If this feature is useful for other widgets, we could abstract it into an
7364 // OO.ui.HeaderedElement mixin constructor.
7365 if ( config
.header
!== undefined ) {
7367 .prepend( this.$( '<span>' )
7368 .addClass( 'oo-ui-popupToolGroup-header' )
7369 .text( config
.header
)
7373 .addClass( 'oo-ui-popupToolGroup' )
7374 .prepend( this.$handle
);
7379 OO
.inheritClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ToolGroup
);
7380 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IconElement
);
7381 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.IndicatorElement
);
7382 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.LabelElement
);
7383 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.TitledElement
);
7384 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ClippableElement
);
7386 /* Static Properties */
7393 OO
.ui
.PopupToolGroup
.prototype.setDisabled = function () {
7395 OO
.ui
.PopupToolGroup
.super.prototype.setDisabled
.apply( this, arguments
);
7397 if ( this.isDisabled() && this.isElementAttached() ) {
7398 this.setActive( false );
7403 * Handle focus being lost.
7405 * The event is actually generated from a mouseup, so it is not a normal blur event object.
7407 * @param {jQuery.Event} e Mouse up event
7409 OO
.ui
.PopupToolGroup
.prototype.onBlur = function ( e
) {
7410 // Only deactivate when clicking outside the dropdown element
7411 if ( this.$( e
.target
).closest( '.oo-ui-popupToolGroup' )[0] !== this.$element
[0] ) {
7412 this.setActive( false );
7419 OO
.ui
.PopupToolGroup
.prototype.onPointerUp = function ( e
) {
7420 // e.which is 0 for touch events, 1 for left mouse button
7421 if ( !this.isDisabled() && e
.which
<= 1 ) {
7422 this.setActive( false );
7424 return OO
.ui
.PopupToolGroup
.super.prototype.onPointerUp
.call( this, e
);
7428 * Handle mouse up events.
7430 * @param {jQuery.Event} e Mouse up event
7432 OO
.ui
.PopupToolGroup
.prototype.onHandlePointerUp = function () {
7437 * Handle mouse down events.
7439 * @param {jQuery.Event} e Mouse down event
7441 OO
.ui
.PopupToolGroup
.prototype.onHandlePointerDown = function ( e
) {
7442 // e.which is 0 for touch events, 1 for left mouse button
7443 if ( !this.isDisabled() && e
.which
<= 1 ) {
7444 this.setActive( !this.active
);
7450 * Switch into active mode.
7452 * When active, mouseup events anywhere in the document will trigger deactivation.
7454 OO
.ui
.PopupToolGroup
.prototype.setActive = function ( value
) {
7456 if ( this.active
!== value
) {
7457 this.active
= value
;
7459 this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler
, true );
7461 // Try anchoring the popup to the left first
7462 this.$element
.addClass( 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left' );
7463 this.toggleClipping( true );
7464 if ( this.isClippedHorizontally() ) {
7465 // Anchoring to the left caused the popup to clip, so anchor it to the right instead
7466 this.toggleClipping( false );
7468 .removeClass( 'oo-ui-popupToolGroup-left' )
7469 .addClass( 'oo-ui-popupToolGroup-right' );
7470 this.toggleClipping( true );
7473 this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler
, true );
7474 this.$element
.removeClass(
7475 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left oo-ui-popupToolGroup-right'
7477 this.toggleClipping( false );
7483 * Drop down list layout of tools as labeled icon buttons.
7486 * @extends OO.ui.PopupToolGroup
7489 * @param {OO.ui.Toolbar} toolbar
7490 * @param {Object} [config] Configuration options
7492 OO
.ui
.ListToolGroup
= function OoUiListToolGroup( toolbar
, config
) {
7493 // Parent constructor
7494 OO
.ui
.ListToolGroup
.super.call( this, toolbar
, config
);
7497 this.$element
.addClass( 'oo-ui-listToolGroup' );
7502 OO
.inheritClass( OO
.ui
.ListToolGroup
, OO
.ui
.PopupToolGroup
);
7504 /* Static Properties */
7506 OO
.ui
.ListToolGroup
.static.accelTooltips
= true;
7508 OO
.ui
.ListToolGroup
.static.name
= 'list';
7511 * Drop down menu layout of tools as selectable menu items.
7514 * @extends OO.ui.PopupToolGroup
7517 * @param {OO.ui.Toolbar} toolbar
7518 * @param {Object} [config] Configuration options
7520 OO
.ui
.MenuToolGroup
= function OoUiMenuToolGroup( toolbar
, config
) {
7521 // Configuration initialization
7522 config
= config
|| {};
7524 // Parent constructor
7525 OO
.ui
.MenuToolGroup
.super.call( this, toolbar
, config
);
7528 this.toolbar
.connect( this, { updateState
: 'onUpdateState' } );
7531 this.$element
.addClass( 'oo-ui-menuToolGroup' );
7536 OO
.inheritClass( OO
.ui
.MenuToolGroup
, OO
.ui
.PopupToolGroup
);
7538 /* Static Properties */
7540 OO
.ui
.MenuToolGroup
.static.accelTooltips
= true;
7542 OO
.ui
.MenuToolGroup
.static.name
= 'menu';
7547 * Handle the toolbar state being updated.
7549 * When the state changes, the title of each active item in the menu will be joined together and
7550 * used as a label for the group. The label will be empty if none of the items are active.
7552 OO
.ui
.MenuToolGroup
.prototype.onUpdateState = function () {
7556 for ( name
in this.tools
) {
7557 if ( this.tools
[name
].isActive() ) {
7558 labelTexts
.push( this.tools
[name
].getTitle() );
7562 this.setLabel( labelTexts
.join( ', ' ) || ' ' );
7566 * Tool that shows a popup when selected.
7570 * @extends OO.ui.Tool
7571 * @mixins OO.ui.PopupElement
7574 * @param {OO.ui.Toolbar} toolbar
7575 * @param {Object} [config] Configuration options
7577 OO
.ui
.PopupTool
= function OoUiPopupTool( toolbar
, config
) {
7578 // Parent constructor
7579 OO
.ui
.PopupTool
.super.call( this, toolbar
, config
);
7581 // Mixin constructors
7582 OO
.ui
.PopupElement
.call( this, config
);
7586 .addClass( 'oo-ui-popupTool' )
7587 .append( this.popup
.$element
);
7592 OO
.inheritClass( OO
.ui
.PopupTool
, OO
.ui
.Tool
);
7593 OO
.mixinClass( OO
.ui
.PopupTool
, OO
.ui
.PopupElement
);
7598 * Handle the tool being selected.
7602 OO
.ui
.PopupTool
.prototype.onSelect = function () {
7603 if ( !this.isDisabled() ) {
7604 this.popup
.toggle();
7606 this.setActive( false );
7611 * Handle the toolbar state being updated.
7615 OO
.ui
.PopupTool
.prototype.onUpdateState = function () {
7616 this.setActive( false );
7620 * Mixin for OO.ui.Widget subclasses to provide OO.ui.GroupElement.
7622 * Use together with OO.ui.ItemWidget to make disabled state inheritable.
7626 * @extends OO.ui.GroupElement
7629 * @param {Object} [config] Configuration options
7631 OO
.ui
.GroupWidget
= function OoUiGroupWidget( config
) {
7632 // Parent constructor
7633 OO
.ui
.GroupWidget
.super.call( this, config
);
7638 OO
.inheritClass( OO
.ui
.GroupWidget
, OO
.ui
.GroupElement
);
7643 * Set the disabled state of the widget.
7645 * This will also update the disabled state of child widgets.
7647 * @param {boolean} disabled Disable widget
7650 OO
.ui
.GroupWidget
.prototype.setDisabled = function ( disabled
) {
7654 // Note: Calling #setDisabled this way assumes this is mixed into an OO.ui.Widget
7655 OO
.ui
.Widget
.prototype.setDisabled
.call( this, disabled
);
7657 // During construction, #setDisabled is called before the OO.ui.GroupElement constructor
7659 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
7660 this.items
[i
].updateDisabled();
7668 * Mixin for widgets used as items in widgets that inherit OO.ui.GroupWidget.
7670 * Item widgets have a reference to a OO.ui.GroupWidget while they are attached to the group. This
7671 * allows bidrectional communication.
7673 * Use together with OO.ui.GroupWidget to make disabled state inheritable.
7680 OO
.ui
.ItemWidget
= function OoUiItemWidget() {
7687 * Check if widget is disabled.
7689 * Checks parent if present, making disabled state inheritable.
7691 * @return {boolean} Widget is disabled
7693 OO
.ui
.ItemWidget
.prototype.isDisabled = function () {
7694 return this.disabled
||
7695 ( this.elementGroup
instanceof OO
.ui
.Widget
&& this.elementGroup
.isDisabled() );
7699 * Set group element is in.
7701 * @param {OO.ui.GroupElement|null} group Group element, null if none
7704 OO
.ui
.ItemWidget
.prototype.setElementGroup = function ( group
) {
7706 // Note: Calling #setElementGroup this way assumes this is mixed into an OO.ui.Element
7707 OO
.ui
.Element
.prototype.setElementGroup
.call( this, group
);
7709 // Initialize item disabled states
7710 this.updateDisabled();
7716 * Mixin that adds a menu showing suggested values for a text input.
7718 * Subclasses must handle `select` and `choose` events on #lookupMenu to make use of selections.
7724 * @param {OO.ui.TextInputWidget} input Input widget
7725 * @param {Object} [config] Configuration options
7726 * @cfg {jQuery} [$overlay=this.$( 'body' )] Overlay layer
7728 OO
.ui
.LookupInputWidget
= function OoUiLookupInputWidget( input
, config
) {
7729 // Config intialization
7730 config
= config
|| {};
7733 this.lookupInput
= input
;
7734 this.$overlay
= config
.$overlay
|| this.$( 'body,.oo-ui-window-overlay' ).last();
7735 this.lookupMenu
= new OO
.ui
.TextInputMenuWidget( this, {
7736 $: OO
.ui
.Element
.getJQuery( this.$overlay
),
7737 input
: this.lookupInput
,
7738 $container
: config
.$container
7740 this.lookupCache
= {};
7741 this.lookupQuery
= null;
7742 this.lookupRequest
= null;
7743 this.populating
= false;
7746 this.$overlay
.append( this.lookupMenu
.$element
);
7748 this.lookupInput
.$input
.on( {
7749 focus
: OO
.ui
.bind( this.onLookupInputFocus
, this ),
7750 blur
: OO
.ui
.bind( this.onLookupInputBlur
, this ),
7751 mousedown
: OO
.ui
.bind( this.onLookupInputMouseDown
, this )
7753 this.lookupInput
.connect( this, { change
: 'onLookupInputChange' } );
7756 this.$element
.addClass( 'oo-ui-lookupWidget' );
7757 this.lookupMenu
.$element
.addClass( 'oo-ui-lookupWidget-menu' );
7763 * Handle input focus event.
7765 * @param {jQuery.Event} e Input focus event
7767 OO
.ui
.LookupInputWidget
.prototype.onLookupInputFocus = function () {
7768 this.openLookupMenu();
7772 * Handle input blur event.
7774 * @param {jQuery.Event} e Input blur event
7776 OO
.ui
.LookupInputWidget
.prototype.onLookupInputBlur = function () {
7777 this.lookupMenu
.toggle( false );
7781 * Handle input mouse down event.
7783 * @param {jQuery.Event} e Input mouse down event
7785 OO
.ui
.LookupInputWidget
.prototype.onLookupInputMouseDown = function () {
7786 this.openLookupMenu();
7790 * Handle input change event.
7792 * @param {string} value New input value
7794 OO
.ui
.LookupInputWidget
.prototype.onLookupInputChange = function () {
7795 this.openLookupMenu();
7801 * @return {OO.ui.TextInputMenuWidget}
7803 OO
.ui
.LookupInputWidget
.prototype.getLookupMenu = function () {
7804 return this.lookupMenu
;
7812 OO
.ui
.LookupInputWidget
.prototype.openLookupMenu = function () {
7813 var value
= this.lookupInput
.getValue();
7815 if ( this.lookupMenu
.$input
.is( ':focus' ) && $.trim( value
) !== '' ) {
7816 this.populateLookupMenu();
7817 this.lookupMenu
.toggle( true );
7828 * Populate lookup menu with current information.
7832 OO
.ui
.LookupInputWidget
.prototype.populateLookupMenu = function () {
7835 if ( !this.populating
) {
7836 this.populating
= true;
7837 this.getLookupMenuItems()
7838 .done( function ( items
) {
7839 widget
.lookupMenu
.clearItems();
7840 if ( items
.length
) {
7844 widget
.initializeLookupMenuSelection();
7845 widget
.openLookupMenu();
7847 widget
.lookupMenu
.toggle( true );
7849 widget
.populating
= false;
7851 .fail( function () {
7852 widget
.lookupMenu
.clearItems();
7853 widget
.populating
= false;
7861 * Set selection in the lookup menu with current information.
7865 OO
.ui
.LookupInputWidget
.prototype.initializeLookupMenuSelection = function () {
7866 if ( !this.lookupMenu
.getSelectedItem() ) {
7867 this.lookupMenu
.selectItem( this.lookupMenu
.getFirstSelectableItem() );
7869 this.lookupMenu
.highlightItem( this.lookupMenu
.getSelectedItem() );
7873 * Get lookup menu items for the current query.
7875 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument
7878 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItems = function () {
7880 value
= this.lookupInput
.getValue(),
7881 deferred
= $.Deferred();
7883 if ( value
&& value
!== this.lookupQuery
) {
7884 // Abort current request if query has changed
7885 if ( this.lookupRequest
) {
7886 this.lookupRequest
.abort();
7887 this.lookupQuery
= null;
7888 this.lookupRequest
= null;
7890 if ( value
in this.lookupCache
) {
7891 deferred
.resolve( this.getLookupMenuItemsFromData( this.lookupCache
[value
] ) );
7893 this.lookupQuery
= value
;
7894 this.lookupRequest
= this.getLookupRequest()
7895 .always( function () {
7896 widget
.lookupQuery
= null;
7897 widget
.lookupRequest
= null;
7899 .done( function ( data
) {
7900 widget
.lookupCache
[value
] = widget
.getLookupCacheItemFromData( data
);
7901 deferred
.resolve( widget
.getLookupMenuItemsFromData( widget
.lookupCache
[value
] ) );
7903 .fail( function () {
7907 this.lookupRequest
.always( function () {
7908 widget
.popPending();
7912 return deferred
.promise();
7916 * Get a new request object of the current lookup query value.
7919 * @return {jqXHR} jQuery AJAX object, or promise object with an .abort() method
7921 OO
.ui
.LookupInputWidget
.prototype.getLookupRequest = function () {
7922 // Stub, implemented in subclass
7927 * Handle successful lookup request.
7929 * Overriding methods should call #populateLookupMenu when results are available and cache results
7930 * for future lookups in #lookupCache as an array of #OO.ui.MenuItemWidget objects.
7933 * @param {Mixed} data Response from server
7935 OO
.ui
.LookupInputWidget
.prototype.onLookupRequestDone = function () {
7936 // Stub, implemented in subclass
7940 * Get a list of menu item widgets from the data stored by the lookup request's done handler.
7943 * @param {Mixed} data Cached result data, usually an array
7944 * @return {OO.ui.MenuItemWidget[]} Menu items
7946 OO
.ui
.LookupInputWidget
.prototype.getLookupMenuItemsFromData = function () {
7947 // Stub, implemented in subclass
7952 * Set of controls for an OO.ui.OutlineWidget.
7954 * Controls include moving items up and down, removing items, and adding different kinds of items.
7957 * @extends OO.ui.Widget
7958 * @mixins OO.ui.GroupElement
7959 * @mixins OO.ui.IconElement
7962 * @param {OO.ui.OutlineWidget} outline Outline to control
7963 * @param {Object} [config] Configuration options
7965 OO
.ui
.OutlineControlsWidget
= function OoUiOutlineControlsWidget( outline
, config
) {
7966 // Configuration initialization
7967 config
= $.extend( { icon
: 'add' }, config
);
7969 // Parent constructor
7970 OO
.ui
.OutlineControlsWidget
.super.call( this, config
);
7972 // Mixin constructors
7973 OO
.ui
.GroupElement
.call( this, config
);
7974 OO
.ui
.IconElement
.call( this, config
);
7977 this.outline
= outline
;
7978 this.$movers
= this.$( '<div>' );
7979 this.upButton
= new OO
.ui
.ButtonWidget( {
7983 title
: OO
.ui
.msg( 'ooui-outline-control-move-up' )
7985 this.downButton
= new OO
.ui
.ButtonWidget( {
7989 title
: OO
.ui
.msg( 'ooui-outline-control-move-down' )
7991 this.removeButton
= new OO
.ui
.ButtonWidget( {
7995 title
: OO
.ui
.msg( 'ooui-outline-control-remove' )
7999 outline
.connect( this, {
8000 select
: 'onOutlineChange',
8001 add
: 'onOutlineChange',
8002 remove
: 'onOutlineChange'
8004 this.upButton
.connect( this, { click
: [ 'emit', 'move', -1 ] } );
8005 this.downButton
.connect( this, { click
: [ 'emit', 'move', 1 ] } );
8006 this.removeButton
.connect( this, { click
: [ 'emit', 'remove' ] } );
8009 this.$element
.addClass( 'oo-ui-outlineControlsWidget' );
8010 this.$group
.addClass( 'oo-ui-outlineControlsWidget-items' );
8012 .addClass( 'oo-ui-outlineControlsWidget-movers' )
8013 .append( this.removeButton
.$element
, this.upButton
.$element
, this.downButton
.$element
);
8014 this.$element
.append( this.$icon
, this.$group
, this.$movers
);
8019 OO
.inheritClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.Widget
);
8020 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.GroupElement
);
8021 OO
.mixinClass( OO
.ui
.OutlineControlsWidget
, OO
.ui
.IconElement
);
8027 * @param {number} places Number of places to move
8037 * Handle outline change events.
8039 OO
.ui
.OutlineControlsWidget
.prototype.onOutlineChange = function () {
8040 var i
, len
, firstMovable
, lastMovable
,
8041 items
= this.outline
.getItems(),
8042 selectedItem
= this.outline
.getSelectedItem(),
8043 movable
= selectedItem
&& selectedItem
.isMovable(),
8044 removable
= selectedItem
&& selectedItem
.isRemovable();
8049 while ( ++i
< len
) {
8050 if ( items
[i
].isMovable() ) {
8051 firstMovable
= items
[i
];
8057 if ( items
[i
].isMovable() ) {
8058 lastMovable
= items
[i
];
8063 this.upButton
.setDisabled( !movable
|| selectedItem
=== firstMovable
);
8064 this.downButton
.setDisabled( !movable
|| selectedItem
=== lastMovable
);
8065 this.removeButton
.setDisabled( !removable
);
8069 * Mixin for widgets with a boolean on/off state.
8075 * @param {Object} [config] Configuration options
8076 * @cfg {boolean} [value=false] Initial value
8078 OO
.ui
.ToggleWidget
= function OoUiToggleWidget( config
) {
8079 // Configuration initialization
8080 config
= config
|| {};
8086 this.$element
.addClass( 'oo-ui-toggleWidget' );
8087 this.setValue( !!config
.value
);
8094 * @param {boolean} value Changed value
8100 * Get the value of the toggle.
8104 OO
.ui
.ToggleWidget
.prototype.getValue = function () {
8109 * Set the value of the toggle.
8111 * @param {boolean} value New value
8115 OO
.ui
.ToggleWidget
.prototype.setValue = function ( value
) {
8117 if ( this.value
!== value
) {
8119 this.emit( 'change', value
);
8120 this.$element
.toggleClass( 'oo-ui-toggleWidget-on', value
);
8121 this.$element
.toggleClass( 'oo-ui-toggleWidget-off', !value
);
8127 * Group widget for multiple related buttons.
8129 * Use together with OO.ui.ButtonWidget.
8132 * @extends OO.ui.Widget
8133 * @mixins OO.ui.GroupElement
8136 * @param {Object} [config] Configuration options
8137 * @cfg {OO.ui.ButtonWidget} [items] Buttons to add
8139 OO
.ui
.ButtonGroupWidget
= function OoUiButtonGroupWidget( config
) {
8140 // Parent constructor
8141 OO
.ui
.ButtonGroupWidget
.super.call( this, config
);
8143 // Mixin constructors
8144 OO
.ui
.GroupElement
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
8147 this.$element
.addClass( 'oo-ui-buttonGroupWidget' );
8148 if ( $.isArray( config
.items
) ) {
8149 this.addItems( config
.items
);
8155 OO
.inheritClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.Widget
);
8156 OO
.mixinClass( OO
.ui
.ButtonGroupWidget
, OO
.ui
.GroupElement
);
8159 * Generic widget for buttons.
8162 * @extends OO.ui.Widget
8163 * @mixins OO.ui.ButtonElement
8164 * @mixins OO.ui.IconElement
8165 * @mixins OO.ui.IndicatorElement
8166 * @mixins OO.ui.LabelElement
8167 * @mixins OO.ui.TitledElement
8168 * @mixins OO.ui.FlaggedElement
8171 * @param {Object} [config] Configuration options
8172 * @cfg {string} [href] Hyperlink to visit when clicked
8173 * @cfg {string} [target] Target to open hyperlink in
8175 OO
.ui
.ButtonWidget
= function OoUiButtonWidget( config
) {
8176 // Configuration initialization
8177 config
= $.extend( { target
: '_blank' }, config
);
8179 // Parent constructor
8180 OO
.ui
.ButtonWidget
.super.call( this, config
);
8182 // Mixin constructors
8183 OO
.ui
.ButtonElement
.call( this, config
);
8184 OO
.ui
.IconElement
.call( this, config
);
8185 OO
.ui
.IndicatorElement
.call( this, config
);
8186 OO
.ui
.LabelElement
.call( this, config
);
8187 OO
.ui
.TitledElement
.call( this, config
, $.extend( {}, config
, { $titled
: this.$button
} ) );
8188 OO
.ui
.FlaggedElement
.call( this, config
);
8193 this.isHyperlink
= false;
8197 click
: OO
.ui
.bind( this.onClick
, this ),
8198 keypress
: OO
.ui
.bind( this.onKeyPress
, this )
8202 this.$button
.append( this.$icon
, this.$label
, this.$indicator
);
8204 .addClass( 'oo-ui-buttonWidget' )
8205 .append( this.$button
);
8206 this.setHref( config
.href
);
8207 this.setTarget( config
.target
);
8212 OO
.inheritClass( OO
.ui
.ButtonWidget
, OO
.ui
.Widget
);
8213 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.ButtonElement
);
8214 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IconElement
);
8215 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.IndicatorElement
);
8216 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.LabelElement
);
8217 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.TitledElement
);
8218 OO
.mixinClass( OO
.ui
.ButtonWidget
, OO
.ui
.FlaggedElement
);
8229 * Handles mouse click events.
8231 * @param {jQuery.Event} e Mouse click event
8234 OO
.ui
.ButtonWidget
.prototype.onClick = function () {
8235 if ( !this.isDisabled() ) {
8236 this.emit( 'click' );
8237 if ( this.isHyperlink
) {
8245 * Handles keypress events.
8247 * @param {jQuery.Event} e Keypress event
8250 OO
.ui
.ButtonWidget
.prototype.onKeyPress = function ( e
) {
8251 if ( !this.isDisabled() && ( e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
) ) {
8253 if ( this.isHyperlink
) {
8261 * Get hyperlink location.
8263 * @return {string} Hyperlink location
8265 OO
.ui
.ButtonWidget
.prototype.getHref = function () {
8270 * Get hyperlink target.
8272 * @return {string} Hyperlink target
8274 OO
.ui
.ButtonWidget
.prototype.getTarget = function () {
8279 * Set hyperlink location.
8281 * @param {string|null} href Hyperlink location, null to remove
8283 OO
.ui
.ButtonWidget
.prototype.setHref = function ( href
) {
8284 href
= typeof href
=== 'string' ? href
: null;
8286 if ( href
!== this.href
) {
8288 if ( href
!== null ) {
8289 this.$button
.attr( 'href', href
);
8290 this.isHyperlink
= true;
8292 this.$button
.removeAttr( 'href' );
8293 this.isHyperlink
= false;
8301 * Set hyperlink target.
8303 * @param {string|null} target Hyperlink target, null to remove
8305 OO
.ui
.ButtonWidget
.prototype.setTarget = function ( target
) {
8306 target
= typeof target
=== 'string' ? target
: null;
8308 if ( target
!== this.target
) {
8309 this.target
= target
;
8310 if ( target
!== null ) {
8311 this.$button
.attr( 'target', target
);
8313 this.$button
.removeAttr( 'target' );
8321 * Button widget that executes an action and is managed by an OO.ui.ActionSet.
8324 * @extends OO.ui.ButtonWidget
8325 * @mixins OO.ui.PendingElement
8328 * @param {Object} [config] Configuration options
8329 * @cfg {string} [action] Symbolic action name
8330 * @cfg {string[]} [modes] Symbolic mode names
8331 * @cfg {boolean} [framed=false] Render button with a frame
8333 OO
.ui
.ActionWidget
= function OoUiActionWidget( config
) {
8334 // Config intialization
8335 config
= $.extend( { framed
: false }, config
);
8337 // Parent constructor
8338 OO
.ui
.ActionWidget
.super.call( this, config
);
8340 // Mixin constructors
8341 OO
.ui
.PendingElement
.call( this, config
);
8344 this.action
= config
.action
|| '';
8345 this.modes
= config
.modes
|| [];
8350 this.$element
.addClass( 'oo-ui-actionWidget' );
8355 OO
.inheritClass( OO
.ui
.ActionWidget
, OO
.ui
.ButtonWidget
);
8356 OO
.mixinClass( OO
.ui
.ActionWidget
, OO
.ui
.PendingElement
);
8367 * Check if action is available in a certain mode.
8369 * @param {string} mode Name of mode
8370 * @return {boolean} Has mode
8372 OO
.ui
.ActionWidget
.prototype.hasMode = function ( mode
) {
8373 return this.modes
.indexOf( mode
) !== -1;
8377 * Get symbolic action name.
8381 OO
.ui
.ActionWidget
.prototype.getAction = function () {
8386 * Get symbolic action name.
8390 OO
.ui
.ActionWidget
.prototype.getModes = function () {
8391 return this.modes
.slice();
8395 * Emit a resize event if the size has changed.
8399 OO
.ui
.ActionWidget
.prototype.propagateResize = function () {
8402 if ( this.isElementAttached() ) {
8403 width
= this.$element
.width();
8404 height
= this.$element
.height();
8406 if ( width
!== this.width
|| height
!== this.height
) {
8408 this.height
= height
;
8409 this.emit( 'resize' );
8419 OO
.ui
.ActionWidget
.prototype.setIcon = function () {
8421 OO
.ui
.IconElement
.prototype.setIcon
.apply( this, arguments
);
8422 this.propagateResize();
8430 OO
.ui
.ActionWidget
.prototype.setLabel = function () {
8432 OO
.ui
.LabelElement
.prototype.setLabel
.apply( this, arguments
);
8433 this.propagateResize();
8441 OO
.ui
.ActionWidget
.prototype.setFlags = function () {
8443 OO
.ui
.FlaggedElement
.prototype.setFlags
.apply( this, arguments
);
8444 this.propagateResize();
8452 OO
.ui
.ActionWidget
.prototype.clearFlags = function () {
8454 OO
.ui
.FlaggedElement
.prototype.clearFlags
.apply( this, arguments
);
8455 this.propagateResize();
8461 * Toggle visibility of button.
8463 * @param {boolean} [show] Show button, omit to toggle visibility
8466 OO
.ui
.ActionWidget
.prototype.toggle = function () {
8468 OO
.ui
.ActionWidget
.super.prototype.toggle
.apply( this, arguments
);
8469 this.propagateResize();
8475 * Button that shows and hides a popup.
8478 * @extends OO.ui.ButtonWidget
8479 * @mixins OO.ui.PopupElement
8482 * @param {Object} [config] Configuration options
8484 OO
.ui
.PopupButtonWidget
= function OoUiPopupButtonWidget( config
) {
8485 // Parent constructor
8486 OO
.ui
.PopupButtonWidget
.super.call( this, config
);
8488 // Mixin constructors
8489 OO
.ui
.PopupElement
.call( this, config
);
8493 .addClass( 'oo-ui-popupButtonWidget' )
8494 .append( this.popup
.$element
);
8499 OO
.inheritClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.ButtonWidget
);
8500 OO
.mixinClass( OO
.ui
.PopupButtonWidget
, OO
.ui
.PopupElement
);
8505 * Handles mouse click events.
8507 * @param {jQuery.Event} e Mouse click event
8509 OO
.ui
.PopupButtonWidget
.prototype.onClick = function ( e
) {
8510 // Skip clicks within the popup
8511 if ( $.contains( this.popup
.$element
[0], e
.target
) ) {
8515 if ( !this.isDisabled() ) {
8516 this.popup
.toggle();
8518 OO
.ui
.PopupButtonWidget
.super.prototype.onClick
.call( this );
8524 * Button that toggles on and off.
8527 * @extends OO.ui.ButtonWidget
8528 * @mixins OO.ui.ToggleWidget
8531 * @param {Object} [config] Configuration options
8532 * @cfg {boolean} [value=false] Initial value
8534 OO
.ui
.ToggleButtonWidget
= function OoUiToggleButtonWidget( config
) {
8535 // Configuration initialization
8536 config
= config
|| {};
8538 // Parent constructor
8539 OO
.ui
.ToggleButtonWidget
.super.call( this, config
);
8541 // Mixin constructors
8542 OO
.ui
.ToggleWidget
.call( this, config
);
8545 this.$element
.addClass( 'oo-ui-toggleButtonWidget' );
8550 OO
.inheritClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ButtonWidget
);
8551 OO
.mixinClass( OO
.ui
.ToggleButtonWidget
, OO
.ui
.ToggleWidget
);
8558 OO
.ui
.ToggleButtonWidget
.prototype.onClick = function () {
8559 if ( !this.isDisabled() ) {
8560 this.setValue( !this.value
);
8564 return OO
.ui
.ToggleButtonWidget
.super.prototype.onClick
.call( this );
8570 OO
.ui
.ToggleButtonWidget
.prototype.setValue = function ( value
) {
8572 if ( value
!== this.value
) {
8573 this.setActive( value
);
8576 // Parent method (from mixin)
8577 OO
.ui
.ToggleWidget
.prototype.setValue
.call( this, value
);
8585 * See OO.ui.IconElement for more information.
8588 * @extends OO.ui.Widget
8589 * @mixins OO.ui.IconElement
8590 * @mixins OO.ui.TitledElement
8593 * @param {Object} [config] Configuration options
8595 OO
.ui
.IconWidget
= function OoUiIconWidget( config
) {
8596 // Config intialization
8597 config
= config
|| {};
8599 // Parent constructor
8600 OO
.ui
.IconWidget
.super.call( this, config
);
8602 // Mixin constructors
8603 OO
.ui
.IconElement
.call( this, $.extend( {}, config
, { $icon
: this.$element
} ) );
8604 OO
.ui
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$element
} ) );
8607 this.$element
.addClass( 'oo-ui-iconWidget' );
8612 OO
.inheritClass( OO
.ui
.IconWidget
, OO
.ui
.Widget
);
8613 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.IconElement
);
8614 OO
.mixinClass( OO
.ui
.IconWidget
, OO
.ui
.TitledElement
);
8616 /* Static Properties */
8618 OO
.ui
.IconWidget
.static.tagName
= 'span';
8623 * See OO.ui.IndicatorElement for more information.
8626 * @extends OO.ui.Widget
8627 * @mixins OO.ui.IndicatorElement
8628 * @mixins OO.ui.TitledElement
8631 * @param {Object} [config] Configuration options
8633 OO
.ui
.IndicatorWidget
= function OoUiIndicatorWidget( config
) {
8634 // Config intialization
8635 config
= config
|| {};
8637 // Parent constructor
8638 OO
.ui
.IndicatorWidget
.super.call( this, config
);
8640 // Mixin constructors
8641 OO
.ui
.IndicatorElement
.call( this, $.extend( {}, config
, { $indicator
: this.$element
} ) );
8642 OO
.ui
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$element
} ) );
8645 this.$element
.addClass( 'oo-ui-indicatorWidget' );
8650 OO
.inheritClass( OO
.ui
.IndicatorWidget
, OO
.ui
.Widget
);
8651 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.IndicatorElement
);
8652 OO
.mixinClass( OO
.ui
.IndicatorWidget
, OO
.ui
.TitledElement
);
8654 /* Static Properties */
8656 OO
.ui
.IndicatorWidget
.static.tagName
= 'span';
8659 * Inline menu of options.
8661 * Inline menus provide a control for accessing a menu and compose a menu within the widget, which
8662 * can be accessed using the #getMenu method.
8664 * Use with OO.ui.MenuOptionWidget.
8667 * @extends OO.ui.Widget
8668 * @mixins OO.ui.IconElement
8669 * @mixins OO.ui.IndicatorElement
8670 * @mixins OO.ui.LabelElement
8671 * @mixins OO.ui.TitledElement
8674 * @param {Object} [config] Configuration options
8675 * @cfg {Object} [menu] Configuration options to pass to menu widget
8677 OO
.ui
.InlineMenuWidget
= function OoUiInlineMenuWidget( config
) {
8678 // Configuration initialization
8679 config
= $.extend( { indicator
: 'down' }, config
);
8681 // Parent constructor
8682 OO
.ui
.InlineMenuWidget
.super.call( this, config
);
8684 // Mixin constructors
8685 OO
.ui
.IconElement
.call( this, config
);
8686 OO
.ui
.IndicatorElement
.call( this, config
);
8687 OO
.ui
.LabelElement
.call( this, config
);
8688 OO
.ui
.TitledElement
.call( this, $.extend( {}, config
, { $titled
: this.$label
} ) );
8691 this.menu
= new OO
.ui
.MenuWidget( $.extend( { $: this.$, widget
: this }, config
.menu
) );
8692 this.$handle
= this.$( '<span>' );
8695 this.$element
.on( { click
: OO
.ui
.bind( this.onClick
, this ) } );
8696 this.menu
.connect( this, { select
: 'onMenuSelect' } );
8700 .addClass( 'oo-ui-inlineMenuWidget-handle' )
8701 .append( this.$icon
, this.$label
, this.$indicator
);
8703 .addClass( 'oo-ui-inlineMenuWidget' )
8704 .append( this.$handle
, this.menu
.$element
);
8709 OO
.inheritClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.Widget
);
8710 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.IconElement
);
8711 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.IndicatorElement
);
8712 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.LabelElement
);
8713 OO
.mixinClass( OO
.ui
.InlineMenuWidget
, OO
.ui
.TitledElement
);
8720 * @return {OO.ui.MenuWidget} Menu of widget
8722 OO
.ui
.InlineMenuWidget
.prototype.getMenu = function () {
8727 * Handles menu select events.
8729 * @param {OO.ui.MenuItemWidget} item Selected menu item
8731 OO
.ui
.InlineMenuWidget
.prototype.onMenuSelect = function ( item
) {
8738 selectedLabel
= item
.getLabel();
8740 // If the label is a DOM element, clone it, because setLabel will append() it
8741 if ( selectedLabel
instanceof jQuery
) {
8742 selectedLabel
= selectedLabel
.clone();
8745 this.setLabel( selectedLabel
);
8749 * Handles mouse click events.
8751 * @param {jQuery.Event} e Mouse click event
8753 OO
.ui
.InlineMenuWidget
.prototype.onClick = function ( e
) {
8754 // Skip clicks within the menu
8755 if ( $.contains( this.menu
.$element
[0], e
.target
) ) {
8759 if ( !this.isDisabled() ) {
8760 if ( this.menu
.isVisible() ) {
8761 this.menu
.toggle( false );
8763 this.menu
.toggle( true );
8770 * Base class for input widgets.
8774 * @extends OO.ui.Widget
8775 * @mixins OO.ui.FlaggedElement
8778 * @param {Object} [config] Configuration options
8779 * @cfg {string} [name=''] HTML input name
8780 * @cfg {string} [value=''] Input value
8781 * @cfg {boolean} [readOnly=false] Prevent changes
8782 * @cfg {Function} [inputFilter] Filter function to apply to the input. Takes a string argument and returns a string.
8784 OO
.ui
.InputWidget
= function OoUiInputWidget( config
) {
8785 // Config intialization
8786 config
= $.extend( { readOnly
: false }, config
);
8788 // Parent constructor
8789 OO
.ui
.InputWidget
.super.call( this, config
);
8791 // Mixin constructors
8792 OO
.ui
.FlaggedElement
.call( this, config
);
8795 this.$input
= this.getInputElement( config
);
8797 this.readOnly
= false;
8798 this.inputFilter
= config
.inputFilter
;
8801 this.$input
.on( 'keydown mouseup cut paste change input select', OO
.ui
.bind( this.onEdit
, this ) );
8805 .attr( 'name', config
.name
)
8806 .prop( 'disabled', this.isDisabled() );
8807 this.setReadOnly( config
.readOnly
);
8808 this.$element
.addClass( 'oo-ui-inputWidget' ).append( this.$input
);
8809 this.setValue( config
.value
);
8814 OO
.inheritClass( OO
.ui
.InputWidget
, OO
.ui
.Widget
);
8815 OO
.mixinClass( OO
.ui
.InputWidget
, OO
.ui
.FlaggedElement
);
8827 * Get input element.
8829 * @param {Object} [config] Configuration options
8830 * @return {jQuery} Input element
8832 OO
.ui
.InputWidget
.prototype.getInputElement = function () {
8833 return this.$( '<input>' );
8837 * Handle potentially value-changing events.
8839 * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
8841 OO
.ui
.InputWidget
.prototype.onEdit = function () {
8843 if ( !this.isDisabled() ) {
8844 // Allow the stack to clear so the value will be updated
8845 setTimeout( function () {
8846 widget
.setValue( widget
.$input
.val() );
8852 * Get the value of the input.
8854 * @return {string} Input value
8856 OO
.ui
.InputWidget
.prototype.getValue = function () {
8861 * Sets the direction of the current input, either RTL or LTR
8863 * @param {boolean} isRTL
8865 OO
.ui
.InputWidget
.prototype.setRTL = function ( isRTL
) {
8867 this.$input
.removeClass( 'oo-ui-ltr' );
8868 this.$input
.addClass( 'oo-ui-rtl' );
8870 this.$input
.removeClass( 'oo-ui-rtl' );
8871 this.$input
.addClass( 'oo-ui-ltr' );
8876 * Set the value of the input.
8878 * @param {string} value New value
8882 OO
.ui
.InputWidget
.prototype.setValue = function ( value
) {
8883 value
= this.sanitizeValue( value
);
8884 if ( this.value
!== value
) {
8886 this.emit( 'change', this.value
);
8888 // Update the DOM if it has changed. Note that with sanitizeValue, it
8889 // is possible for the DOM value to change without this.value changing.
8890 if ( this.$input
.val() !== this.value
) {
8891 this.$input
.val( this.value
);
8897 * Sanitize incoming value.
8899 * Ensures value is a string, and converts undefined and null to empty strings.
8901 * @param {string} value Original value
8902 * @return {string} Sanitized value
8904 OO
.ui
.InputWidget
.prototype.sanitizeValue = function ( value
) {
8905 if ( value
=== undefined || value
=== null ) {
8907 } else if ( this.inputFilter
) {
8908 return this.inputFilter( String( value
) );
8910 return String( value
);
8915 * Simulate the behavior of clicking on a label bound to this input.
8917 OO
.ui
.InputWidget
.prototype.simulateLabelClick = function () {
8918 if ( !this.isDisabled() ) {
8919 if ( this.$input
.is( ':checkbox,:radio' ) ) {
8920 this.$input
.click();
8921 } else if ( this.$input
.is( ':input' ) ) {
8922 this.$input
[0].focus();
8928 * Check if the widget is read-only.
8932 OO
.ui
.InputWidget
.prototype.isReadOnly = function () {
8933 return this.readOnly
;
8937 * Set the read-only state of the widget.
8939 * This should probably change the widgets's appearance and prevent it from being used.
8941 * @param {boolean} state Make input read-only
8944 OO
.ui
.InputWidget
.prototype.setReadOnly = function ( state
) {
8945 this.readOnly
= !!state
;
8946 this.$input
.prop( 'readOnly', this.readOnly
);
8953 OO
.ui
.InputWidget
.prototype.setDisabled = function ( state
) {
8954 OO
.ui
.InputWidget
.super.prototype.setDisabled
.call( this, state
);
8955 if ( this.$input
) {
8956 this.$input
.prop( 'disabled', this.isDisabled() );
8966 OO
.ui
.InputWidget
.prototype.focus = function () {
8967 this.$input
[0].focus();
8976 OO
.ui
.InputWidget
.prototype.blur = function () {
8977 this.$input
[0].blur();
8982 * Checkbox input widget.
8985 * @extends OO.ui.InputWidget
8988 * @param {Object} [config] Configuration options
8990 OO
.ui
.CheckboxInputWidget
= function OoUiCheckboxInputWidget( config
) {
8991 // Parent constructor
8992 OO
.ui
.CheckboxInputWidget
.super.call( this, config
);
8995 this.$element
.addClass( 'oo-ui-checkboxInputWidget' );
9000 OO
.inheritClass( OO
.ui
.CheckboxInputWidget
, OO
.ui
.InputWidget
);
9007 * Get input element.
9009 * @return {jQuery} Input element
9011 OO
.ui
.CheckboxInputWidget
.prototype.getInputElement = function () {
9012 return this.$( '<input type="checkbox" />' );
9016 * Get checked state of the checkbox
9018 * @return {boolean} If the checkbox is checked
9020 OO
.ui
.CheckboxInputWidget
.prototype.getValue = function () {
9027 OO
.ui
.CheckboxInputWidget
.prototype.setValue = function ( value
) {
9029 if ( this.value
!== value
) {
9031 this.$input
.prop( 'checked', this.value
);
9032 this.emit( 'change', this.value
);
9039 OO
.ui
.CheckboxInputWidget
.prototype.onEdit = function () {
9041 if ( !this.isDisabled() ) {
9042 // Allow the stack to clear so the value will be updated
9043 setTimeout( function () {
9044 widget
.setValue( widget
.$input
.prop( 'checked' ) );
9050 * Input widget with a text field.
9053 * @extends OO.ui.InputWidget
9054 * @mixins OO.ui.IconElement
9055 * @mixins OO.ui.IndicatorElement
9056 * @mixins OO.ui.PendingElement
9059 * @param {Object} [config] Configuration options
9060 * @cfg {string} [placeholder] Placeholder text
9061 * @cfg {boolean} [multiline=false] Allow multiple lines of text
9062 * @cfg {boolean} [autosize=false] Automatically resize to fit content
9063 * @cfg {boolean} [maxRows=10] Maximum number of rows to make visible when autosizing
9064 * @cfg {RegExp|string} [validate] Regular expression (or symbolic name referencing
9065 * one, see #static-validationPatterns)
9067 OO
.ui
.TextInputWidget
= function OoUiTextInputWidget( config
) {
9068 // Configuration initialization
9069 config
= config
|| {};
9071 // Parent constructor
9072 OO
.ui
.TextInputWidget
.super.call( this, config
);
9074 // Mixin constructors
9075 OO
.ui
.IconElement
.call( this, config
);
9076 OO
.ui
.IndicatorElement
.call( this, config
);
9077 OO
.ui
.PendingElement
.call( this, config
);
9080 this.multiline
= !!config
.multiline
;
9081 this.autosize
= !!config
.autosize
;
9082 this.maxRows
= config
.maxRows
!== undefined ? config
.maxRows
: 10;
9083 this.validate
= null;
9085 this.setValidation( config
.validate
);
9089 keypress
: OO
.ui
.bind( this.onKeyPress
, this ),
9090 blur
: OO
.ui
.bind( this.setValidityFlag
, this )
9092 this.$element
.on( 'DOMNodeInsertedIntoDocument', OO
.ui
.bind( this.onElementAttach
, this ) );
9093 this.$icon
.on( 'mousedown', OO
.ui
.bind( this.onIconMouseDown
, this ) );
9094 this.$indicator
.on( 'mousedown', OO
.ui
.bind( this.onIndicatorMouseDown
, this ) );
9098 .addClass( 'oo-ui-textInputWidget' )
9099 .append( this.$icon
, this.$indicator
);
9100 if ( config
.placeholder
) {
9101 this.$input
.attr( 'placeholder', config
.placeholder
);
9103 this.$element
.attr( 'role', 'textbox' );
9108 OO
.inheritClass( OO
.ui
.TextInputWidget
, OO
.ui
.InputWidget
);
9109 OO
.mixinClass( OO
.ui
.TextInputWidget
, OO
.ui
.IconElement
);
9110 OO
.mixinClass( OO
.ui
.TextInputWidget
, OO
.ui
.IndicatorElement
);
9111 OO
.mixinClass( OO
.ui
.TextInputWidget
, OO
.ui
.PendingElement
);
9113 /* Static properties */
9115 OO
.ui
.TextInputWidget
.static.validationPatterns
= {
9123 * User presses enter inside the text box.
9125 * Not called if input is multiline.
9131 * User clicks the icon.
9137 * User clicks the indicator.
9145 * Handle icon mouse down events.
9147 * @param {jQuery.Event} e Mouse down event
9150 OO
.ui
.TextInputWidget
.prototype.onIconMouseDown = function ( e
) {
9151 if ( e
.which
=== 1 ) {
9152 this.$input
[0].focus();
9153 this.emit( 'icon' );
9159 * Handle indicator mouse down events.
9161 * @param {jQuery.Event} e Mouse down event
9164 OO
.ui
.TextInputWidget
.prototype.onIndicatorMouseDown = function ( e
) {
9165 if ( e
.which
=== 1 ) {
9166 this.$input
[0].focus();
9167 this.emit( 'indicator' );
9173 * Handle key press events.
9175 * @param {jQuery.Event} e Key press event
9176 * @fires enter If enter key is pressed and input is not multiline
9178 OO
.ui
.TextInputWidget
.prototype.onKeyPress = function ( e
) {
9179 if ( e
.which
=== OO
.ui
.Keys
.ENTER
&& !this.multiline
) {
9180 this.emit( 'enter' );
9185 * Handle element attach events.
9187 * @param {jQuery.Event} e Element attach event
9189 OO
.ui
.TextInputWidget
.prototype.onElementAttach = function () {
9196 OO
.ui
.TextInputWidget
.prototype.onEdit = function () {
9200 return OO
.ui
.TextInputWidget
.super.prototype.onEdit
.call( this );
9206 OO
.ui
.TextInputWidget
.prototype.setValue = function ( value
) {
9208 OO
.ui
.TextInputWidget
.super.prototype.setValue
.call( this, value
);
9210 this.setValidityFlag();
9216 * Automatically adjust the size of the text input.
9218 * This only affects multi-line inputs that are auto-sized.
9222 OO
.ui
.TextInputWidget
.prototype.adjustSize = function () {
9223 var $clone
, scrollHeight
, innerHeight
, outerHeight
, maxInnerHeight
, measurementError
, idealHeight
;
9225 if ( this.multiline
&& this.autosize
) {
9226 $clone
= this.$input
.clone()
9227 .val( this.$input
.val() )
9228 // Set inline height property to 0 to measure scroll height
9229 .css( { height
: 0 } )
9230 .insertAfter( this.$input
);
9231 scrollHeight
= $clone
[0].scrollHeight
;
9232 // Remove inline height property to measure natural heights
9233 $clone
.css( 'height', '' );
9234 innerHeight
= $clone
.innerHeight();
9235 outerHeight
= $clone
.outerHeight();
9236 // Measure max rows height
9237 $clone
.attr( 'rows', this.maxRows
).css( 'height', 'auto' ).val( '' );
9238 maxInnerHeight
= $clone
.innerHeight();
9239 // Difference between reported innerHeight and scrollHeight with no scrollbars present
9240 // Equals 1 on Blink-based browsers and 0 everywhere else
9241 measurementError
= maxInnerHeight
- $clone
[0].scrollHeight
;
9243 idealHeight
= Math
.min( maxInnerHeight
, scrollHeight
+ measurementError
);
9244 // Only apply inline height when expansion beyond natural height is needed
9245 if ( idealHeight
> innerHeight
) {
9246 // Use the difference between the inner and outer height as a buffer
9247 this.$input
.css( 'height', idealHeight
+ ( outerHeight
- innerHeight
) );
9249 this.$input
.css( 'height', '' );
9256 * Get input element.
9258 * @param {Object} [config] Configuration options
9259 * @return {jQuery} Input element
9261 OO
.ui
.TextInputWidget
.prototype.getInputElement = function ( config
) {
9262 return config
.multiline
? this.$( '<textarea>' ) : this.$( '<input type="text" />' );
9268 * Check if input supports multiple lines.
9272 OO
.ui
.TextInputWidget
.prototype.isMultiline = function () {
9273 return !!this.multiline
;
9277 * Check if input automatically adjusts its size.
9281 OO
.ui
.TextInputWidget
.prototype.isAutosizing = function () {
9282 return !!this.autosize
;
9286 * Select the contents of the input.
9290 OO
.ui
.TextInputWidget
.prototype.select = function () {
9291 this.$input
.select();
9296 * Sets the validation pattern to use.
9297 * @param validate {RegExp|string|null} Regular expression (or symbolic name referencing
9298 * one, see #static-validationPatterns)
9300 OO
.ui
.TextInputWidget
.prototype.setValidation = function ( validate
) {
9301 if ( validate
instanceof RegExp
) {
9302 this.validate
= validate
;
9304 this.validate
= this.constructor.static.validationPatterns
[validate
] || /.*/;
9309 * Sets the 'invalid' flag appropriately.
9311 OO
.ui
.TextInputWidget
.prototype.setValidityFlag = function () {
9312 this.isValid().done( OO
.ui
.bind( function ( valid
) {
9313 this.setFlags( { invalid
: !valid
} );
9318 * Returns whether or not the current value is considered valid, according to the
9319 * supplied validation pattern.
9321 * @return {jQuery.Deferred}
9323 OO
.ui
.TextInputWidget
.prototype.isValid = function () {
9324 return $.Deferred().resolve( !!this.getValue().match( this.validate
) ).promise();
9328 * Text input with a menu of optional values.
9331 * @extends OO.ui.Widget
9334 * @param {Object} [config] Configuration options
9335 * @cfg {Object} [menu] Configuration options to pass to menu widget
9336 * @cfg {Object} [input] Configuration options to pass to input widget
9338 OO
.ui
.ComboBoxWidget
= function OoUiComboBoxWidget( config
) {
9339 // Configuration initialization
9340 config
= config
|| {};
9342 // Parent constructor
9343 OO
.ui
.ComboBoxWidget
.super.call( this, config
);
9346 this.input
= new OO
.ui
.TextInputWidget( $.extend(
9347 { $: this.$, indicator
: 'down', disabled
: this.isDisabled() },
9350 this.menu
= new OO
.ui
.MenuWidget( $.extend(
9351 { $: this.$, widget
: this, input
: this.input
, disabled
: this.isDisabled() },
9356 this.input
.connect( this, {
9357 change
: 'onInputChange',
9358 indicator
: 'onInputIndicator',
9359 enter
: 'onInputEnter'
9361 this.menu
.connect( this, {
9362 choose
: 'onMenuChoose',
9363 add
: 'onMenuItemsChange',
9364 remove
: 'onMenuItemsChange'
9368 this.$element
.addClass( 'oo-ui-comboBoxWidget' ).append(
9369 this.input
.$element
,
9372 this.onMenuItemsChange();
9377 OO
.inheritClass( OO
.ui
.ComboBoxWidget
, OO
.ui
.Widget
);
9382 * Handle input change events.
9384 * @param {string} value New value
9386 OO
.ui
.ComboBoxWidget
.prototype.onInputChange = function ( value
) {
9387 var match
= this.menu
.getItemFromData( value
);
9389 this.menu
.selectItem( match
);
9391 if ( !this.isDisabled() ) {
9392 this.menu
.toggle( true );
9397 * Handle input indicator events.
9399 OO
.ui
.ComboBoxWidget
.prototype.onInputIndicator = function () {
9400 if ( !this.isDisabled() ) {
9406 * Handle input enter events.
9408 OO
.ui
.ComboBoxWidget
.prototype.onInputEnter = function () {
9409 if ( !this.isDisabled() ) {
9410 this.menu
.toggle( false );
9415 * Handle menu choose events.
9417 * @param {OO.ui.OptionWidget} item Chosen item
9419 OO
.ui
.ComboBoxWidget
.prototype.onMenuChoose = function ( item
) {
9421 this.input
.setValue( item
.getData() );
9426 * Handle menu item change events.
9428 OO
.ui
.ComboBoxWidget
.prototype.onMenuItemsChange = function () {
9429 this.$element
.toggleClass( 'oo-ui-comboBoxWidget-empty', this.menu
.isEmpty() );
9435 OO
.ui
.ComboBoxWidget
.prototype.setDisabled = function ( disabled
) {
9437 OO
.ui
.ComboBoxWidget
.super.prototype.setDisabled
.call( this, disabled
);
9440 this.input
.setDisabled( this.isDisabled() );
9443 this.menu
.setDisabled( this.isDisabled() );
9453 * @extends OO.ui.Widget
9454 * @mixins OO.ui.LabelElement
9457 * @param {Object} [config] Configuration options
9459 OO
.ui
.LabelWidget
= function OoUiLabelWidget( config
) {
9460 // Config intialization
9461 config
= config
|| {};
9463 // Parent constructor
9464 OO
.ui
.LabelWidget
.super.call( this, config
);
9466 // Mixin constructors
9467 OO
.ui
.LabelElement
.call( this, $.extend( {}, config
, { $label
: this.$element
} ) );
9470 this.input
= config
.input
;
9473 if ( this.input
instanceof OO
.ui
.InputWidget
) {
9474 this.$element
.on( 'click', OO
.ui
.bind( this.onClick
, this ) );
9478 this.$element
.addClass( 'oo-ui-labelWidget' );
9483 OO
.inheritClass( OO
.ui
.LabelWidget
, OO
.ui
.Widget
);
9484 OO
.mixinClass( OO
.ui
.LabelWidget
, OO
.ui
.LabelElement
);
9486 /* Static Properties */
9488 OO
.ui
.LabelWidget
.static.tagName
= 'span';
9493 * Handles label mouse click events.
9495 * @param {jQuery.Event} e Mouse click event
9497 OO
.ui
.LabelWidget
.prototype.onClick = function () {
9498 this.input
.simulateLabelClick();
9503 * Generic option widget for use with OO.ui.SelectWidget.
9506 * @extends OO.ui.Widget
9507 * @mixins OO.ui.LabelElement
9508 * @mixins OO.ui.FlaggedElement
9511 * @param {Mixed} data Option data
9512 * @param {Object} [config] Configuration options
9513 * @cfg {string} [rel] Value for `rel` attribute in DOM, allowing per-option styling
9515 OO
.ui
.OptionWidget
= function OoUiOptionWidget( data
, config
) {
9516 // Config intialization
9517 config
= config
|| {};
9519 // Parent constructor
9520 OO
.ui
.OptionWidget
.super.call( this, config
);
9522 // Mixin constructors
9523 OO
.ui
.ItemWidget
.call( this );
9524 OO
.ui
.LabelElement
.call( this, config
);
9525 OO
.ui
.FlaggedElement
.call( this, config
);
9529 this.selected
= false;
9530 this.highlighted
= false;
9531 this.pressed
= false;
9535 .data( 'oo-ui-optionWidget', this )
9536 .attr( 'rel', config
.rel
)
9537 .attr( 'role', 'option' )
9538 .addClass( 'oo-ui-optionWidget' )
9539 .append( this.$label
);
9541 .prepend( this.$icon
)
9542 .append( this.$indicator
);
9547 OO
.inheritClass( OO
.ui
.OptionWidget
, OO
.ui
.Widget
);
9548 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.ItemWidget
);
9549 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.LabelElement
);
9550 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.FlaggedElement
);
9552 /* Static Properties */
9554 OO
.ui
.OptionWidget
.static.selectable
= true;
9556 OO
.ui
.OptionWidget
.static.highlightable
= true;
9558 OO
.ui
.OptionWidget
.static.pressable
= true;
9560 OO
.ui
.OptionWidget
.static.scrollIntoViewOnSelect
= false;
9565 * Check if option can be selected.
9567 * @return {boolean} Item is selectable
9569 OO
.ui
.OptionWidget
.prototype.isSelectable = function () {
9570 return this.constructor.static.selectable
&& !this.isDisabled();
9574 * Check if option can be highlighted.
9576 * @return {boolean} Item is highlightable
9578 OO
.ui
.OptionWidget
.prototype.isHighlightable = function () {
9579 return this.constructor.static.highlightable
&& !this.isDisabled();
9583 * Check if option can be pressed.
9585 * @return {boolean} Item is pressable
9587 OO
.ui
.OptionWidget
.prototype.isPressable = function () {
9588 return this.constructor.static.pressable
&& !this.isDisabled();
9592 * Check if option is selected.
9594 * @return {boolean} Item is selected
9596 OO
.ui
.OptionWidget
.prototype.isSelected = function () {
9597 return this.selected
;
9601 * Check if option is highlighted.
9603 * @return {boolean} Item is highlighted
9605 OO
.ui
.OptionWidget
.prototype.isHighlighted = function () {
9606 return this.highlighted
;
9610 * Check if option is pressed.
9612 * @return {boolean} Item is pressed
9614 OO
.ui
.OptionWidget
.prototype.isPressed = function () {
9615 return this.pressed
;
9619 * Set selected state.
9621 * @param {boolean} [state=false] Select option
9624 OO
.ui
.OptionWidget
.prototype.setSelected = function ( state
) {
9625 if ( this.constructor.static.selectable
) {
9626 this.selected
= !!state
;
9627 this.$element
.toggleClass( 'oo-ui-optionWidget-selected', state
);
9628 if ( state
&& this.constructor.static.scrollIntoViewOnSelect
) {
9629 this.scrollElementIntoView();
9631 this.updateThemeClasses();
9637 * Set highlighted state.
9639 * @param {boolean} [state=false] Highlight option
9642 OO
.ui
.OptionWidget
.prototype.setHighlighted = function ( state
) {
9643 if ( this.constructor.static.highlightable
) {
9644 this.highlighted
= !!state
;
9645 this.$element
.toggleClass( 'oo-ui-optionWidget-highlighted', state
);
9646 this.updateThemeClasses();
9652 * Set pressed state.
9654 * @param {boolean} [state=false] Press option
9657 OO
.ui
.OptionWidget
.prototype.setPressed = function ( state
) {
9658 if ( this.constructor.static.pressable
) {
9659 this.pressed
= !!state
;
9660 this.$element
.toggleClass( 'oo-ui-optionWidget-pressed', state
);
9661 this.updateThemeClasses();
9667 * Make the option's highlight flash.
9669 * While flashing, the visual style of the pressed state is removed if present.
9671 * @return {jQuery.Promise} Promise resolved when flashing is done
9673 OO
.ui
.OptionWidget
.prototype.flash = function () {
9675 $element
= this.$element
,
9676 deferred
= $.Deferred();
9678 if ( !this.isDisabled() && this.constructor.static.pressable
) {
9679 $element
.removeClass( 'oo-ui-optionWidget-highlighted oo-ui-optionWidget-pressed' );
9680 setTimeout( function () {
9681 // Restore original classes
9683 .toggleClass( 'oo-ui-optionWidget-highlighted', widget
.highlighted
)
9684 .toggleClass( 'oo-ui-optionWidget-pressed', widget
.pressed
);
9686 setTimeout( function () {
9693 return deferred
.promise();
9699 * @return {Mixed} Option data
9701 OO
.ui
.OptionWidget
.prototype.getData = function () {
9706 * Option widget with an option icon and indicator.
9708 * Use together with OO.ui.SelectWidget.
9711 * @extends OO.ui.OptionWidget
9712 * @mixins OO.ui.IconElement
9713 * @mixins OO.ui.IndicatorElement
9716 * @param {Mixed} data Option data
9717 * @param {Object} [config] Configuration options
9719 OO
.ui
.DecoratedOptionWidget
= function OoUiDecoratedOptionWidget( data
, config
) {
9720 // Parent constructor
9721 OO
.ui
.DecoratedOptionWidget
.super.call( this, data
, config
);
9723 // Mixin constructors
9724 OO
.ui
.IconElement
.call( this, config
);
9725 OO
.ui
.IndicatorElement
.call( this, config
);
9729 .addClass( 'oo-ui-decoratedOptionWidget' )
9730 .prepend( this.$icon
)
9731 .append( this.$indicator
);
9736 OO
.inheritClass( OO
.ui
.DecoratedOptionWidget
, OO
.ui
.OptionWidget
);
9737 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IconElement
);
9738 OO
.mixinClass( OO
.ui
.OptionWidget
, OO
.ui
.IndicatorElement
);
9741 * Option widget that looks like a button.
9743 * Use together with OO.ui.ButtonSelectWidget.
9746 * @extends OO.ui.DecoratedOptionWidget
9747 * @mixins OO.ui.ButtonElement
9750 * @param {Mixed} data Option data
9751 * @param {Object} [config] Configuration options
9753 OO
.ui
.ButtonOptionWidget
= function OoUiButtonOptionWidget( data
, config
) {
9754 // Parent constructor
9755 OO
.ui
.ButtonOptionWidget
.super.call( this, data
, config
);
9757 // Mixin constructors
9758 OO
.ui
.ButtonElement
.call( this, config
);
9761 this.$element
.addClass( 'oo-ui-buttonOptionWidget' );
9762 this.$button
.append( this.$element
.contents() );
9763 this.$element
.append( this.$button
);
9768 OO
.inheritClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.DecoratedOptionWidget
);
9769 OO
.mixinClass( OO
.ui
.ButtonOptionWidget
, OO
.ui
.ButtonElement
);
9771 /* Static Properties */
9773 // Allow button mouse down events to pass through so they can be handled by the parent select widget
9774 OO
.ui
.ButtonOptionWidget
.static.cancelButtonMouseDownEvents
= false;
9781 OO
.ui
.ButtonOptionWidget
.prototype.setSelected = function ( state
) {
9782 OO
.ui
.ButtonOptionWidget
.super.prototype.setSelected
.call( this, state
);
9784 if ( this.constructor.static.selectable
) {
9785 this.setActive( state
);
9792 * Item of an OO.ui.MenuWidget.
9795 * @extends OO.ui.DecoratedOptionWidget
9798 * @param {Mixed} data Item data
9799 * @param {Object} [config] Configuration options
9801 OO
.ui
.MenuItemWidget
= function OoUiMenuItemWidget( data
, config
) {
9802 // Configuration initialization
9803 config
= $.extend( { icon
: 'check' }, config
);
9805 // Parent constructor
9806 OO
.ui
.MenuItemWidget
.super.call( this, data
, config
);
9810 .attr( 'role', 'menuitem' )
9811 .addClass( 'oo-ui-menuItemWidget' );
9816 OO
.inheritClass( OO
.ui
.MenuItemWidget
, OO
.ui
.DecoratedOptionWidget
);
9819 * Section to group one or more items in a OO.ui.MenuWidget.
9822 * @extends OO.ui.DecoratedOptionWidget
9825 * @param {Mixed} data Item data
9826 * @param {Object} [config] Configuration options
9828 OO
.ui
.MenuSectionItemWidget
= function OoUiMenuSectionItemWidget( data
, config
) {
9829 // Parent constructor
9830 OO
.ui
.MenuSectionItemWidget
.super.call( this, data
, config
);
9833 this.$element
.addClass( 'oo-ui-menuSectionItemWidget' );
9838 OO
.inheritClass( OO
.ui
.MenuSectionItemWidget
, OO
.ui
.DecoratedOptionWidget
);
9840 /* Static Properties */
9842 OO
.ui
.MenuSectionItemWidget
.static.selectable
= false;
9844 OO
.ui
.MenuSectionItemWidget
.static.highlightable
= false;
9847 * Items for an OO.ui.OutlineWidget.
9850 * @extends OO.ui.DecoratedOptionWidget
9853 * @param {Mixed} data Item data
9854 * @param {Object} [config] Configuration options
9855 * @cfg {number} [level] Indentation level
9856 * @cfg {boolean} [movable] Allow modification from outline controls
9858 OO
.ui
.OutlineItemWidget
= function OoUiOutlineItemWidget( data
, config
) {
9859 // Config intialization
9860 config
= config
|| {};
9862 // Parent constructor
9863 OO
.ui
.OutlineItemWidget
.super.call( this, data
, config
);
9867 this.movable
= !!config
.movable
;
9868 this.removable
= !!config
.removable
;
9871 this.$element
.addClass( 'oo-ui-outlineItemWidget' );
9872 this.setLevel( config
.level
);
9877 OO
.inheritClass( OO
.ui
.OutlineItemWidget
, OO
.ui
.DecoratedOptionWidget
);
9879 /* Static Properties */
9881 OO
.ui
.OutlineItemWidget
.static.highlightable
= false;
9883 OO
.ui
.OutlineItemWidget
.static.scrollIntoViewOnSelect
= true;
9885 OO
.ui
.OutlineItemWidget
.static.levelClass
= 'oo-ui-outlineItemWidget-level-';
9887 OO
.ui
.OutlineItemWidget
.static.levels
= 3;
9892 * Check if item is movable.
9894 * Movablilty is used by outline controls.
9896 * @return {boolean} Item is movable
9898 OO
.ui
.OutlineItemWidget
.prototype.isMovable = function () {
9899 return this.movable
;
9903 * Check if item is removable.
9905 * Removablilty is used by outline controls.
9907 * @return {boolean} Item is removable
9909 OO
.ui
.OutlineItemWidget
.prototype.isRemovable = function () {
9910 return this.removable
;
9914 * Get indentation level.
9916 * @return {number} Indentation level
9918 OO
.ui
.OutlineItemWidget
.prototype.getLevel = function () {
9925 * Movablilty is used by outline controls.
9927 * @param {boolean} movable Item is movable
9930 OO
.ui
.OutlineItemWidget
.prototype.setMovable = function ( movable
) {
9931 this.movable
= !!movable
;
9932 this.updateThemeClasses();
9939 * Removablilty is used by outline controls.
9941 * @param {boolean} movable Item is removable
9944 OO
.ui
.OutlineItemWidget
.prototype.setRemovable = function ( removable
) {
9945 this.removable
= !!removable
;
9946 this.updateThemeClasses();
9951 * Set indentation level.
9953 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
9956 OO
.ui
.OutlineItemWidget
.prototype.setLevel = function ( level
) {
9957 var levels
= this.constructor.static.levels
,
9958 levelClass
= this.constructor.static.levelClass
,
9961 this.level
= level
? Math
.max( 0, Math
.min( levels
- 1, level
) ) : 0;
9963 if ( this.level
=== i
) {
9964 this.$element
.addClass( levelClass
+ i
);
9966 this.$element
.removeClass( levelClass
+ i
);
9969 this.updateThemeClasses();
9975 * Container for content that is overlaid and positioned absolutely.
9978 * @extends OO.ui.Widget
9979 * @mixins OO.ui.LabelElement
9982 * @param {Object} [config] Configuration options
9983 * @cfg {number} [width=320] Width of popup in pixels
9984 * @cfg {number} [height] Height of popup, omit to use automatic height
9985 * @cfg {boolean} [anchor=true] Show anchor pointing to origin of popup
9986 * @cfg {string} [align='center'] Alignment of popup to origin
9987 * @cfg {jQuery} [$container] Container to prevent popup from rendering outside of
9988 * @cfg {jQuery} [$content] Content to append to the popup's body
9989 * @cfg {boolean} [autoClose=false] Popup auto-closes when it loses focus
9990 * @cfg {jQuery} [$autoCloseIgnore] Elements to not auto close when clicked
9991 * @cfg {boolean} [head] Show label and close button at the top
9992 * @cfg {boolean} [padded] Add padding to the body
9994 OO
.ui
.PopupWidget
= function OoUiPopupWidget( config
) {
9995 // Config intialization
9996 config
= config
|| {};
9998 // Parent constructor
9999 OO
.ui
.PopupWidget
.super.call( this, config
);
10001 // Mixin constructors
10002 OO
.ui
.LabelElement
.call( this, config
);
10003 OO
.ui
.ClippableElement
.call( this, config
);
10006 this.visible
= false;
10007 this.$popup
= this.$( '<div>' );
10008 this.$head
= this.$( '<div>' );
10009 this.$body
= this.$( '<div>' );
10010 this.$anchor
= this.$( '<div>' );
10011 this.$container
= config
.$container
; // If undefined, will be computed lazily in updateDimensions()
10012 this.autoClose
= !!config
.autoClose
;
10013 this.$autoCloseIgnore
= config
.$autoCloseIgnore
;
10014 this.transitionTimeout
= null;
10015 this.anchor
= null;
10016 this.width
= config
.width
!== undefined ? config
.width
: 320;
10017 this.height
= config
.height
!== undefined ? config
.height
: null;
10018 this.align
= config
.align
|| 'center';
10019 this.closeButton
= new OO
.ui
.ButtonWidget( { $: this.$, framed
: false, icon
: 'close' } );
10020 this.onMouseDownHandler
= OO
.ui
.bind( this.onMouseDown
, this );
10023 this.closeButton
.connect( this, { click
: 'onCloseButtonClick' } );
10026 this.toggleAnchor( config
.anchor
=== undefined || config
.anchor
);
10027 this.$body
.addClass( 'oo-ui-popupWidget-body' );
10028 this.$anchor
.addClass( 'oo-ui-popupWidget-anchor' );
10030 .addClass( 'oo-ui-popupWidget-head' )
10031 .append( this.$label
, this.closeButton
.$element
);
10032 if ( !config
.head
) {
10036 .addClass( 'oo-ui-popupWidget-popup' )
10037 .append( this.$head
, this.$body
);
10040 .addClass( 'oo-ui-popupWidget' )
10041 .append( this.$popup
, this.$anchor
);
10042 // Move content, which was added to #$element by OO.ui.Widget, to the body
10043 if ( config
.$content
instanceof jQuery
) {
10044 this.$body
.append( config
.$content
);
10046 if ( config
.padded
) {
10047 this.$body
.addClass( 'oo-ui-popupWidget-body-padded' );
10049 this.setClippableElement( this.$body
);
10054 OO
.inheritClass( OO
.ui
.PopupWidget
, OO
.ui
.Widget
);
10055 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.LabelElement
);
10056 OO
.mixinClass( OO
.ui
.PopupWidget
, OO
.ui
.ClippableElement
);
10071 * Handles mouse down events.
10073 * @param {jQuery.Event} e Mouse down event
10075 OO
.ui
.PopupWidget
.prototype.onMouseDown = function ( e
) {
10077 this.isVisible() &&
10078 !$.contains( this.$element
[0], e
.target
) &&
10079 ( !this.$autoCloseIgnore
|| !this.$autoCloseIgnore
.has( e
.target
).length
)
10081 this.toggle( false );
10086 * Bind mouse down listener.
10088 OO
.ui
.PopupWidget
.prototype.bindMouseDownListener = function () {
10089 // Capture clicks outside popup
10090 this.getElementWindow().addEventListener( 'mousedown', this.onMouseDownHandler
, true );
10094 * Handles close button click events.
10096 OO
.ui
.PopupWidget
.prototype.onCloseButtonClick = function () {
10097 if ( this.isVisible() ) {
10098 this.toggle( false );
10103 * Unbind mouse down listener.
10105 OO
.ui
.PopupWidget
.prototype.unbindMouseDownListener = function () {
10106 this.getElementWindow().removeEventListener( 'mousedown', this.onMouseDownHandler
, true );
10110 * Set whether to show a anchor.
10112 * @param {boolean} [show] Show anchor, omit to toggle
10114 OO
.ui
.PopupWidget
.prototype.toggleAnchor = function ( show
) {
10115 show
= show
=== undefined ? !this.anchored
: !!show
;
10117 if ( this.anchored
!== show
) {
10119 this.$element
.addClass( 'oo-ui-popupWidget-anchored' );
10121 this.$element
.removeClass( 'oo-ui-popupWidget-anchored' );
10123 this.anchored
= show
;
10128 * Check if showing a anchor.
10130 * @return {boolean} anchor is visible
10132 OO
.ui
.PopupWidget
.prototype.hasAnchor = function () {
10133 return this.anchor
;
10139 OO
.ui
.PopupWidget
.prototype.toggle = function ( show
) {
10140 show
= show
=== undefined ? !this.isVisible() : !!show
;
10142 var change
= show
!== this.isVisible();
10145 OO
.ui
.PopupWidget
.super.prototype.toggle
.call( this, show
);
10149 if ( this.autoClose
) {
10150 this.bindMouseDownListener();
10152 this.updateDimensions();
10153 this.toggleClipping( true );
10155 this.toggleClipping( false );
10156 if ( this.autoClose
) {
10157 this.unbindMouseDownListener();
10166 * Set the size of the popup.
10168 * Changing the size may also change the popup's position depending on the alignment.
10170 * @param {number} width Width
10171 * @param {number} height Height
10172 * @param {boolean} [transition=false] Use a smooth transition
10175 OO
.ui
.PopupWidget
.prototype.setSize = function ( width
, height
, transition
) {
10176 this.width
= width
;
10177 this.height
= height
!== undefined ? height
: null;
10178 if ( this.isVisible() ) {
10179 this.updateDimensions( transition
);
10184 * Update the size and position.
10186 * Only use this to keep the popup properly anchored. Use #setSize to change the size, and this will
10187 * be called automatically.
10189 * @param {boolean} [transition=false] Use a smooth transition
10192 OO
.ui
.PopupWidget
.prototype.updateDimensions = function ( transition
) {
10193 var popupOffset
, originOffset
, containerLeft
, containerWidth
, containerRight
,
10194 popupLeft
, popupRight
, overlapLeft
, overlapRight
, anchorWidth
,
10198 if ( !this.$container
) {
10199 // Lazy-initialize $container if not specified in constructor
10200 this.$container
= this.$( this.getClosestScrollableElementContainer() );
10203 // Set height and width before measuring things, since it might cause our measurements
10204 // to change (e.g. due to scrollbars appearing or disappearing)
10207 height
: this.height
!== null ? this.height
: 'auto'
10210 // Compute initial popupOffset based on alignment
10211 popupOffset
= this.width
* ( { left
: 0, center
: -0.5, right
: -1 } )[this.align
];
10213 // Figure out if this will cause the popup to go beyond the edge of the container
10214 originOffset
= Math
.round( this.$element
.offset().left
);
10215 containerLeft
= Math
.round( this.$container
.offset().left
);
10216 containerWidth
= this.$container
.innerWidth();
10217 containerRight
= containerLeft
+ containerWidth
;
10218 popupLeft
= popupOffset
- padding
;
10219 popupRight
= popupOffset
+ padding
+ this.width
+ padding
;
10220 overlapLeft
= ( originOffset
+ popupLeft
) - containerLeft
;
10221 overlapRight
= containerRight
- ( originOffset
+ popupRight
);
10223 // Adjust offset to make the popup not go beyond the edge, if needed
10224 if ( overlapRight
< 0 ) {
10225 popupOffset
+= overlapRight
;
10226 } else if ( overlapLeft
< 0 ) {
10227 popupOffset
-= overlapLeft
;
10230 // Adjust offset to avoid anchor being rendered too close to the edge
10231 anchorWidth
= this.$anchor
.width();
10232 if ( this.align
=== 'right' ) {
10233 popupOffset
+= anchorWidth
;
10234 } else if ( this.align
=== 'left' ) {
10235 popupOffset
-= anchorWidth
;
10238 // Prevent transition from being interrupted
10239 clearTimeout( this.transitionTimeout
);
10240 if ( transition
) {
10241 // Enable transition
10242 this.$element
.addClass( 'oo-ui-popupWidget-transitioning' );
10245 // Position body relative to anchor
10246 this.$popup
.css( 'margin-left', popupOffset
);
10248 if ( transition
) {
10249 // Prevent transitioning after transition is complete
10250 this.transitionTimeout
= setTimeout( function () {
10251 widget
.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
10254 // Prevent transitioning immediately
10255 this.$element
.removeClass( 'oo-ui-popupWidget-transitioning' );
10258 // Reevaluate clipping state since we've relocated and resized the popup
10267 * Search widgets combine a query input, placed above, and a results selection widget, placed below.
10268 * Results are cleared and populated each time the query is changed.
10271 * @extends OO.ui.Widget
10274 * @param {Object} [config] Configuration options
10275 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
10276 * @cfg {string} [value] Initial query value
10278 OO
.ui
.SearchWidget
= function OoUiSearchWidget( config
) {
10279 // Configuration intialization
10280 config
= config
|| {};
10282 // Parent constructor
10283 OO
.ui
.SearchWidget
.super.call( this, config
);
10286 this.query
= new OO
.ui
.TextInputWidget( {
10289 placeholder
: config
.placeholder
,
10290 value
: config
.value
10292 this.results
= new OO
.ui
.SelectWidget( { $: this.$ } );
10293 this.$query
= this.$( '<div>' );
10294 this.$results
= this.$( '<div>' );
10297 this.query
.connect( this, {
10298 change
: 'onQueryChange',
10299 enter
: 'onQueryEnter'
10301 this.results
.connect( this, {
10302 highlight
: 'onResultsHighlight',
10303 select
: 'onResultsSelect'
10305 this.query
.$input
.on( 'keydown', OO
.ui
.bind( this.onQueryKeydown
, this ) );
10309 .addClass( 'oo-ui-searchWidget-query' )
10310 .append( this.query
.$element
);
10312 .addClass( 'oo-ui-searchWidget-results' )
10313 .append( this.results
.$element
);
10315 .addClass( 'oo-ui-searchWidget' )
10316 .append( this.$results
, this.$query
);
10321 OO
.inheritClass( OO
.ui
.SearchWidget
, OO
.ui
.Widget
);
10327 * @param {Object|null} item Item data or null if no item is highlighted
10332 * @param {Object|null} item Item data or null if no item is selected
10338 * Handle query key down events.
10340 * @param {jQuery.Event} e Key down event
10342 OO
.ui
.SearchWidget
.prototype.onQueryKeydown = function ( e
) {
10343 var highlightedItem
, nextItem
,
10344 dir
= e
.which
=== OO
.ui
.Keys
.DOWN
? 1 : ( e
.which
=== OO
.ui
.Keys
.UP
? -1 : 0 );
10347 highlightedItem
= this.results
.getHighlightedItem();
10348 if ( !highlightedItem
) {
10349 highlightedItem
= this.results
.getSelectedItem();
10351 nextItem
= this.results
.getRelativeSelectableItem( highlightedItem
, dir
);
10352 this.results
.highlightItem( nextItem
);
10353 nextItem
.scrollElementIntoView();
10358 * Handle select widget select events.
10360 * Clears existing results. Subclasses should repopulate items according to new query.
10362 * @param {string} value New value
10364 OO
.ui
.SearchWidget
.prototype.onQueryChange = function () {
10366 this.results
.clearItems();
10370 * Handle select widget enter key events.
10372 * Selects highlighted item.
10374 * @param {string} value New value
10376 OO
.ui
.SearchWidget
.prototype.onQueryEnter = function () {
10378 this.results
.selectItem( this.results
.getHighlightedItem() );
10382 * Handle select widget highlight events.
10384 * @param {OO.ui.OptionWidget} item Highlighted item
10387 OO
.ui
.SearchWidget
.prototype.onResultsHighlight = function ( item
) {
10388 this.emit( 'highlight', item
? item
.getData() : null );
10392 * Handle select widget select events.
10394 * @param {OO.ui.OptionWidget} item Selected item
10397 OO
.ui
.SearchWidget
.prototype.onResultsSelect = function ( item
) {
10398 this.emit( 'select', item
? item
.getData() : null );
10402 * Get the query input.
10404 * @return {OO.ui.TextInputWidget} Query input
10406 OO
.ui
.SearchWidget
.prototype.getQuery = function () {
10411 * Get the results list.
10413 * @return {OO.ui.SelectWidget} Select list
10415 OO
.ui
.SearchWidget
.prototype.getResults = function () {
10416 return this.results
;
10420 * Generic selection of options.
10422 * Items can contain any rendering, and are uniquely identified by a has of thier data. Any widget
10423 * that provides options, from which the user must choose one, should be built on this class.
10425 * Use together with OO.ui.OptionWidget.
10428 * @extends OO.ui.Widget
10429 * @mixins OO.ui.GroupElement
10432 * @param {Object} [config] Configuration options
10433 * @cfg {OO.ui.OptionWidget[]} [items] Options to add
10435 OO
.ui
.SelectWidget
= function OoUiSelectWidget( config
) {
10436 // Config intialization
10437 config
= config
|| {};
10439 // Parent constructor
10440 OO
.ui
.SelectWidget
.super.call( this, config
);
10442 // Mixin constructors
10443 OO
.ui
.GroupWidget
.call( this, $.extend( {}, config
, { $group
: this.$element
} ) );
10446 this.pressed
= false;
10447 this.selecting
= null;
10449 this.onMouseUpHandler
= OO
.ui
.bind( this.onMouseUp
, this );
10450 this.onMouseMoveHandler
= OO
.ui
.bind( this.onMouseMove
, this );
10453 this.$element
.on( {
10454 mousedown
: OO
.ui
.bind( this.onMouseDown
, this ),
10455 mouseover
: OO
.ui
.bind( this.onMouseOver
, this ),
10456 mouseleave
: OO
.ui
.bind( this.onMouseLeave
, this )
10460 this.$element
.addClass( 'oo-ui-selectWidget oo-ui-selectWidget-depressed' );
10461 if ( $.isArray( config
.items
) ) {
10462 this.addItems( config
.items
);
10468 OO
.inheritClass( OO
.ui
.SelectWidget
, OO
.ui
.Widget
);
10470 // Need to mixin base class as well
10471 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupElement
);
10472 OO
.mixinClass( OO
.ui
.SelectWidget
, OO
.ui
.GroupWidget
);
10478 * @param {OO.ui.OptionWidget|null} item Highlighted item
10483 * @param {OO.ui.OptionWidget|null} item Pressed item
10488 * @param {OO.ui.OptionWidget|null} item Selected item
10493 * @param {OO.ui.OptionWidget|null} item Chosen item
10498 * @param {OO.ui.OptionWidget[]} items Added items
10499 * @param {number} index Index items were added at
10504 * @param {OO.ui.OptionWidget[]} items Removed items
10510 * Handle mouse down events.
10513 * @param {jQuery.Event} e Mouse down event
10515 OO
.ui
.SelectWidget
.prototype.onMouseDown = function ( e
) {
10518 if ( !this.isDisabled() && e
.which
=== 1 ) {
10519 this.togglePressed( true );
10520 item
= this.getTargetItem( e
);
10521 if ( item
&& item
.isSelectable() ) {
10522 this.pressItem( item
);
10523 this.selecting
= item
;
10524 this.getElementDocument().addEventListener(
10526 this.onMouseUpHandler
,
10529 this.getElementDocument().addEventListener(
10531 this.onMouseMoveHandler
,
10540 * Handle mouse up events.
10543 * @param {jQuery.Event} e Mouse up event
10545 OO
.ui
.SelectWidget
.prototype.onMouseUp = function ( e
) {
10548 this.togglePressed( false );
10549 if ( !this.selecting
) {
10550 item
= this.getTargetItem( e
);
10551 if ( item
&& item
.isSelectable() ) {
10552 this.selecting
= item
;
10555 if ( !this.isDisabled() && e
.which
=== 1 && this.selecting
) {
10556 this.pressItem( null );
10557 this.chooseItem( this.selecting
);
10558 this.selecting
= null;
10561 this.getElementDocument().removeEventListener(
10563 this.onMouseUpHandler
,
10566 this.getElementDocument().removeEventListener(
10568 this.onMouseMoveHandler
,
10576 * Handle mouse move events.
10579 * @param {jQuery.Event} e Mouse move event
10581 OO
.ui
.SelectWidget
.prototype.onMouseMove = function ( e
) {
10584 if ( !this.isDisabled() && this.pressed
) {
10585 item
= this.getTargetItem( e
);
10586 if ( item
&& item
!== this.selecting
&& item
.isSelectable() ) {
10587 this.pressItem( item
);
10588 this.selecting
= item
;
10595 * Handle mouse over events.
10598 * @param {jQuery.Event} e Mouse over event
10600 OO
.ui
.SelectWidget
.prototype.onMouseOver = function ( e
) {
10603 if ( !this.isDisabled() ) {
10604 item
= this.getTargetItem( e
);
10605 this.highlightItem( item
&& item
.isHighlightable() ? item
: null );
10611 * Handle mouse leave events.
10614 * @param {jQuery.Event} e Mouse over event
10616 OO
.ui
.SelectWidget
.prototype.onMouseLeave = function () {
10617 if ( !this.isDisabled() ) {
10618 this.highlightItem( null );
10624 * Get the closest item to a jQuery.Event.
10627 * @param {jQuery.Event} e
10628 * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
10630 OO
.ui
.SelectWidget
.prototype.getTargetItem = function ( e
) {
10631 var $item
= this.$( e
.target
).closest( '.oo-ui-optionWidget' );
10632 if ( $item
.length
) {
10633 return $item
.data( 'oo-ui-optionWidget' );
10639 * Get selected item.
10641 * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
10643 OO
.ui
.SelectWidget
.prototype.getSelectedItem = function () {
10646 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
10647 if ( this.items
[i
].isSelected() ) {
10648 return this.items
[i
];
10655 * Get highlighted item.
10657 * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
10659 OO
.ui
.SelectWidget
.prototype.getHighlightedItem = function () {
10662 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
10663 if ( this.items
[i
].isHighlighted() ) {
10664 return this.items
[i
];
10671 * Get an existing item with equivilant data.
10673 * @param {Object} data Item data to search for
10674 * @return {OO.ui.OptionWidget|null} Item with equivilent value, `null` if none exists
10676 OO
.ui
.SelectWidget
.prototype.getItemFromData = function ( data
) {
10677 var hash
= OO
.getHash( data
);
10679 if ( hash
in this.hashes
) {
10680 return this.hashes
[hash
];
10687 * Toggle pressed state.
10689 * @param {boolean} pressed An option is being pressed
10691 OO
.ui
.SelectWidget
.prototype.togglePressed = function ( pressed
) {
10692 if ( pressed
=== undefined ) {
10693 pressed
= !this.pressed
;
10695 if ( pressed
!== this.pressed
) {
10697 .toggleClass( 'oo-ui-selectWidget-pressed', pressed
)
10698 .toggleClass( 'oo-ui-selectWidget-depressed', !pressed
);
10699 this.pressed
= pressed
;
10704 * Highlight an item.
10706 * Highlighting is mutually exclusive.
10708 * @param {OO.ui.OptionWidget} [item] Item to highlight, omit to deselect all
10712 OO
.ui
.SelectWidget
.prototype.highlightItem = function ( item
) {
10713 var i
, len
, highlighted
,
10716 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
10717 highlighted
= this.items
[i
] === item
;
10718 if ( this.items
[i
].isHighlighted() !== highlighted
) {
10719 this.items
[i
].setHighlighted( highlighted
);
10724 this.emit( 'highlight', item
);
10733 * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
10737 OO
.ui
.SelectWidget
.prototype.selectItem = function ( item
) {
10738 var i
, len
, selected
,
10741 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
10742 selected
= this.items
[i
] === item
;
10743 if ( this.items
[i
].isSelected() !== selected
) {
10744 this.items
[i
].setSelected( selected
);
10749 this.emit( 'select', item
);
10758 * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
10762 OO
.ui
.SelectWidget
.prototype.pressItem = function ( item
) {
10763 var i
, len
, pressed
,
10766 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
10767 pressed
= this.items
[i
] === item
;
10768 if ( this.items
[i
].isPressed() !== pressed
) {
10769 this.items
[i
].setPressed( pressed
);
10774 this.emit( 'press', item
);
10783 * Identical to #selectItem, but may vary in subclasses that want to take additional action when
10784 * an item is selected using the keyboard or mouse.
10786 * @param {OO.ui.OptionWidget} item Item to choose
10790 OO
.ui
.SelectWidget
.prototype.chooseItem = function ( item
) {
10791 this.selectItem( item
);
10792 this.emit( 'choose', item
);
10798 * Get an item relative to another one.
10800 * @param {OO.ui.OptionWidget} item Item to start at
10801 * @param {number} direction Direction to move in
10802 * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the menu
10804 OO
.ui
.SelectWidget
.prototype.getRelativeSelectableItem = function ( item
, direction
) {
10805 var inc
= direction
> 0 ? 1 : -1,
10806 len
= this.items
.length
,
10807 index
= item
instanceof OO
.ui
.OptionWidget
?
10808 $.inArray( item
, this.items
) : ( inc
> 0 ? -1 : 0 ),
10809 stopAt
= Math
.max( Math
.min( index
, len
- 1 ), 0 ),
10811 // Default to 0 instead of -1, if nothing is selected let's start at the beginning
10812 Math
.max( index
, -1 ) :
10813 // Default to n-1 instead of -1, if nothing is selected let's start at the end
10814 Math
.min( index
, len
);
10816 while ( len
!== 0 ) {
10817 i
= ( i
+ inc
+ len
) % len
;
10818 item
= this.items
[i
];
10819 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
10822 // Stop iterating when we've looped all the way around
10823 if ( i
=== stopAt
) {
10831 * Get the next selectable item.
10833 * @return {OO.ui.OptionWidget|null} Item, `null` if ther aren't any selectable items
10835 OO
.ui
.SelectWidget
.prototype.getFirstSelectableItem = function () {
10838 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
10839 item
= this.items
[i
];
10840 if ( item
instanceof OO
.ui
.OptionWidget
&& item
.isSelectable() ) {
10851 * When items are added with the same values as existing items, the existing items will be
10852 * automatically removed before the new items are added.
10854 * @param {OO.ui.OptionWidget[]} items Items to add
10855 * @param {number} [index] Index to insert items after
10859 OO
.ui
.SelectWidget
.prototype.addItems = function ( items
, index
) {
10860 var i
, len
, item
, hash
,
10863 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
10865 hash
= OO
.getHash( item
.getData() );
10866 if ( hash
in this.hashes
) {
10867 // Remove item with same value
10868 remove
.push( this.hashes
[hash
] );
10870 this.hashes
[hash
] = item
;
10872 if ( remove
.length
) {
10873 this.removeItems( remove
);
10877 OO
.ui
.GroupWidget
.prototype.addItems
.call( this, items
, index
);
10879 // Always provide an index, even if it was omitted
10880 this.emit( 'add', items
, index
=== undefined ? this.items
.length
- items
.length
- 1 : index
);
10888 * Items will be detached, not removed, so they can be used later.
10890 * @param {OO.ui.OptionWidget[]} items Items to remove
10894 OO
.ui
.SelectWidget
.prototype.removeItems = function ( items
) {
10895 var i
, len
, item
, hash
;
10897 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
10899 hash
= OO
.getHash( item
.getData() );
10900 if ( hash
in this.hashes
) {
10901 // Remove existing item
10902 delete this.hashes
[hash
];
10904 if ( item
.isSelected() ) {
10905 this.selectItem( null );
10910 OO
.ui
.GroupWidget
.prototype.removeItems
.call( this, items
);
10912 this.emit( 'remove', items
);
10920 * Items will be detached, not removed, so they can be used later.
10925 OO
.ui
.SelectWidget
.prototype.clearItems = function () {
10926 var items
= this.items
.slice();
10931 OO
.ui
.GroupWidget
.prototype.clearItems
.call( this );
10932 this.selectItem( null );
10934 this.emit( 'remove', items
);
10940 * Select widget containing button options.
10942 * Use together with OO.ui.ButtonOptionWidget.
10945 * @extends OO.ui.SelectWidget
10948 * @param {Object} [config] Configuration options
10950 OO
.ui
.ButtonSelectWidget
= function OoUiButtonSelectWidget( config
) {
10951 // Parent constructor
10952 OO
.ui
.ButtonSelectWidget
.super.call( this, config
);
10955 this.$element
.addClass( 'oo-ui-buttonSelectWidget' );
10960 OO
.inheritClass( OO
.ui
.ButtonSelectWidget
, OO
.ui
.SelectWidget
);
10963 * Overlaid menu of options.
10965 * Menus are clipped to the visible viewport. They do not provide a control for opening or closing
10968 * Use together with OO.ui.MenuItemWidget.
10971 * @extends OO.ui.SelectWidget
10972 * @mixins OO.ui.ClippableElement
10975 * @param {Object} [config] Configuration options
10976 * @cfg {OO.ui.InputWidget} [input] Input to bind keyboard handlers to
10977 * @cfg {OO.ui.Widget} [widget] Widget to bind mouse handlers to
10978 * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu
10980 OO
.ui
.MenuWidget
= function OoUiMenuWidget( config
) {
10981 // Config intialization
10982 config
= config
|| {};
10984 // Parent constructor
10985 OO
.ui
.MenuWidget
.super.call( this, config
);
10987 // Mixin constructors
10988 OO
.ui
.ClippableElement
.call( this, $.extend( {}, config
, { $clippable
: this.$group
} ) );
10991 this.flashing
= false;
10992 this.visible
= false;
10993 this.newItems
= null;
10994 this.autoHide
= config
.autoHide
=== undefined || !!config
.autoHide
;
10995 this.$input
= config
.input
? config
.input
.$input
: null;
10996 this.$widget
= config
.widget
? config
.widget
.$element
: null;
10997 this.$previousFocus
= null;
10998 this.isolated
= !config
.input
;
10999 this.onKeyDownHandler
= OO
.ui
.bind( this.onKeyDown
, this );
11000 this.onDocumentMouseDownHandler
= OO
.ui
.bind( this.onDocumentMouseDown
, this );
11005 .attr( 'role', 'menu' )
11006 .addClass( 'oo-ui-menuWidget' );
11011 OO
.inheritClass( OO
.ui
.MenuWidget
, OO
.ui
.SelectWidget
);
11012 OO
.mixinClass( OO
.ui
.MenuWidget
, OO
.ui
.ClippableElement
);
11017 * Handles document mouse down events.
11019 * @param {jQuery.Event} e Key down event
11021 OO
.ui
.MenuWidget
.prototype.onDocumentMouseDown = function ( e
) {
11022 if ( !$.contains( this.$element
[0], e
.target
) && ( !this.$widget
|| !$.contains( this.$widget
[0], e
.target
) ) ) {
11023 this.toggle( false );
11028 * Handles key down events.
11030 * @param {jQuery.Event} e Key down event
11032 OO
.ui
.MenuWidget
.prototype.onKeyDown = function ( e
) {
11035 highlightItem
= this.getHighlightedItem();
11037 if ( !this.isDisabled() && this.isVisible() ) {
11038 if ( !highlightItem
) {
11039 highlightItem
= this.getSelectedItem();
11041 switch ( e
.keyCode
) {
11042 case OO
.ui
.Keys
.ENTER
:
11043 this.chooseItem( highlightItem
);
11046 case OO
.ui
.Keys
.UP
:
11047 nextItem
= this.getRelativeSelectableItem( highlightItem
, -1 );
11050 case OO
.ui
.Keys
.DOWN
:
11051 nextItem
= this.getRelativeSelectableItem( highlightItem
, 1 );
11054 case OO
.ui
.Keys
.ESCAPE
:
11055 if ( highlightItem
) {
11056 highlightItem
.setHighlighted( false );
11058 this.toggle( false );
11064 this.highlightItem( nextItem
);
11065 nextItem
.scrollElementIntoView();
11069 e
.preventDefault();
11070 e
.stopPropagation();
11077 * Bind key down listener.
11079 OO
.ui
.MenuWidget
.prototype.bindKeyDownListener = function () {
11080 if ( this.$input
) {
11081 this.$input
.on( 'keydown', this.onKeyDownHandler
);
11083 // Capture menu navigation keys
11084 this.getElementWindow().addEventListener( 'keydown', this.onKeyDownHandler
, true );
11089 * Unbind key down listener.
11091 OO
.ui
.MenuWidget
.prototype.unbindKeyDownListener = function () {
11092 if ( this.$input
) {
11093 this.$input
.off( 'keydown' );
11095 this.getElementWindow().removeEventListener( 'keydown', this.onKeyDownHandler
, true );
11102 * This will close the menu when done, unlike selectItem which only changes selection.
11104 * @param {OO.ui.OptionWidget} item Item to choose
11107 OO
.ui
.MenuWidget
.prototype.chooseItem = function ( item
) {
11111 OO
.ui
.MenuWidget
.super.prototype.chooseItem
.call( this, item
);
11113 if ( item
&& !this.flashing
) {
11114 this.flashing
= true;
11115 item
.flash().done( function () {
11116 widget
.toggle( false );
11117 widget
.flashing
= false;
11120 this.toggle( false );
11129 OO
.ui
.MenuWidget
.prototype.addItems = function ( items
, index
) {
11133 OO
.ui
.MenuWidget
.super.prototype.addItems
.call( this, items
, index
);
11136 if ( !this.newItems
) {
11137 this.newItems
= [];
11140 for ( i
= 0, len
= items
.length
; i
< len
; i
++ ) {
11142 if ( this.isVisible() ) {
11143 // Defer fitting label until item has been attached
11146 this.newItems
.push( item
);
11150 // Reevaluate clipping
11159 OO
.ui
.MenuWidget
.prototype.removeItems = function ( items
) {
11161 OO
.ui
.MenuWidget
.super.prototype.removeItems
.call( this, items
);
11163 // Reevaluate clipping
11172 OO
.ui
.MenuWidget
.prototype.clearItems = function () {
11174 OO
.ui
.MenuWidget
.super.prototype.clearItems
.call( this );
11176 // Reevaluate clipping
11185 OO
.ui
.MenuWidget
.prototype.toggle = function ( visible
) {
11186 visible
= ( visible
=== undefined ? !this.visible
: !!visible
) && !!this.items
.length
;
11189 change
= visible
!== this.isVisible();
11192 OO
.ui
.MenuWidget
.super.prototype.toggle
.call( this, visible
);
11196 this.bindKeyDownListener();
11198 // Change focus to enable keyboard navigation
11199 if ( this.isolated
&& this.$input
&& !this.$input
.is( ':focus' ) ) {
11200 this.$previousFocus
= this.$( ':focus' );
11201 this.$input
[0].focus();
11203 if ( this.newItems
&& this.newItems
.length
) {
11204 for ( i
= 0, len
= this.newItems
.length
; i
< len
; i
++ ) {
11205 this.newItems
[i
].fitLabel();
11207 this.newItems
= null;
11209 this.toggleClipping( true );
11212 if ( this.autoHide
) {
11213 this.getElementDocument().addEventListener(
11214 'mousedown', this.onDocumentMouseDownHandler
, true
11218 this.unbindKeyDownListener();
11219 if ( this.isolated
&& this.$previousFocus
) {
11220 this.$previousFocus
[0].focus();
11221 this.$previousFocus
= null;
11223 this.getElementDocument().removeEventListener(
11224 'mousedown', this.onDocumentMouseDownHandler
, true
11226 this.toggleClipping( false );
11234 * Menu for a text input widget.
11236 * This menu is specially designed to be positioned beneath the text input widget. Even if the input
11237 * is in a different frame, the menu's position is automatically calulated and maintained when the
11238 * menu is toggled or the window is resized.
11241 * @extends OO.ui.MenuWidget
11244 * @param {OO.ui.TextInputWidget} input Text input widget to provide menu for
11245 * @param {Object} [config] Configuration options
11246 * @cfg {jQuery} [$container=input.$element] Element to render menu under
11248 OO
.ui
.TextInputMenuWidget
= function OoUiTextInputMenuWidget( input
, config
) {
11249 // Parent constructor
11250 OO
.ui
.TextInputMenuWidget
.super.call( this, config
);
11253 this.input
= input
;
11254 this.$container
= config
.$container
|| this.input
.$element
;
11255 this.onWindowResizeHandler
= OO
.ui
.bind( this.onWindowResize
, this );
11258 this.$element
.addClass( 'oo-ui-textInputMenuWidget' );
11263 OO
.inheritClass( OO
.ui
.TextInputMenuWidget
, OO
.ui
.MenuWidget
);
11268 * Handle window resize event.
11270 * @param {jQuery.Event} e Window resize event
11272 OO
.ui
.TextInputMenuWidget
.prototype.onWindowResize = function () {
11279 OO
.ui
.TextInputMenuWidget
.prototype.toggle = function ( visible
) {
11280 visible
= !!visible
;
11282 var change
= visible
!== this.isVisible();
11284 if ( change
&& visible
) {
11285 // Make sure the width is set before the parent method runs.
11286 // After this we have to call this.position(); again to actually
11287 // position ourselves correctly.
11292 OO
.ui
.TextInputMenuWidget
.super.prototype.toggle
.call( this, visible
);
11295 if ( this.isVisible() ) {
11297 this.$( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler
);
11299 this.$( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler
);
11307 * Position the menu.
11311 OO
.ui
.TextInputMenuWidget
.prototype.position = function () {
11313 $container
= this.$container
,
11314 dimensions
= $container
.offset();
11316 // Position under input
11317 dimensions
.top
+= $container
.height();
11319 // Compensate for frame position if in a differnt frame
11320 if ( this.input
.$.$iframe
&& this.input
.$.context
!== this.$element
[0].ownerDocument
) {
11321 frameOffset
= OO
.ui
.Element
.getRelativePosition(
11322 this.input
.$.$iframe
, this.$element
.offsetParent()
11324 dimensions
.left
+= frameOffset
.left
;
11325 dimensions
.top
+= frameOffset
.top
;
11327 // Fix for RTL (for some reason, no need to fix if the frameoffset is set)
11328 if ( this.$element
.css( 'direction' ) === 'rtl' ) {
11329 dimensions
.right
= this.$element
.parent().position().left
-
11330 $container
.width() - dimensions
.left
;
11331 // Erase the value for 'left':
11332 delete dimensions
.left
;
11335 this.$element
.css( dimensions
);
11336 this.setIdealSize( $container
.width() );
11337 // We updated the position, so re-evaluate the clipping state
11344 * Structured list of items.
11346 * Use with OO.ui.OutlineItemWidget.
11349 * @extends OO.ui.SelectWidget
11352 * @param {Object} [config] Configuration options
11354 OO
.ui
.OutlineWidget
= function OoUiOutlineWidget( config
) {
11355 // Config intialization
11356 config
= config
|| {};
11358 // Parent constructor
11359 OO
.ui
.OutlineWidget
.super.call( this, config
);
11362 this.$element
.addClass( 'oo-ui-outlineWidget' );
11367 OO
.inheritClass( OO
.ui
.OutlineWidget
, OO
.ui
.SelectWidget
);
11370 * Switch that slides on and off.
11373 * @extends OO.ui.Widget
11374 * @mixins OO.ui.ToggleWidget
11377 * @param {Object} [config] Configuration options
11378 * @cfg {boolean} [value=false] Initial value
11380 OO
.ui
.ToggleSwitchWidget
= function OoUiToggleSwitchWidget( config
) {
11381 // Parent constructor
11382 OO
.ui
.ToggleSwitchWidget
.super.call( this, config
);
11384 // Mixin constructors
11385 OO
.ui
.ToggleWidget
.call( this, config
);
11388 this.dragging
= false;
11389 this.dragStart
= null;
11390 this.sliding
= false;
11391 this.$glow
= this.$( '<span>' );
11392 this.$grip
= this.$( '<span>' );
11395 this.$element
.on( 'click', OO
.ui
.bind( this.onClick
, this ) );
11398 this.$glow
.addClass( 'oo-ui-toggleSwitchWidget-glow' );
11399 this.$grip
.addClass( 'oo-ui-toggleSwitchWidget-grip' );
11401 .addClass( 'oo-ui-toggleSwitchWidget' )
11402 .append( this.$glow
, this.$grip
);
11407 OO
.inheritClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.Widget
);
11408 OO
.mixinClass( OO
.ui
.ToggleSwitchWidget
, OO
.ui
.ToggleWidget
);
11413 * Handle mouse down events.
11415 * @param {jQuery.Event} e Mouse down event
11417 OO
.ui
.ToggleSwitchWidget
.prototype.onClick = function ( e
) {
11418 if ( !this.isDisabled() && e
.which
=== 1 ) {
11419 this.setValue( !this.value
);