# all files / src/mixins/ LookupElement.js

27.06% Statements 23/85
0% Branches 0/36
0% Functions 0/22
27.06% Lines 23/85

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

     /**
     * LookupElement is a mixin that creates a {@link OO.ui.MenuSelectWidget menu} of suggested values for
     * a {@link OO.ui.TextInputWidget text input widget}. Suggested values are based on the characters the user types
     * into the text input field and, in general, the menu is only displayed when the user types. If a suggested value is chosen
     * from the lookup menu, that value becomes the value of the input field.
     *
     * Note that a new menu of suggested items is displayed when a value is chosen from the lookup menu. If this is
     * not the desired behavior, disable lookup menus with the #setLookupsDisabled method, then set the value, then
     * re-enable lookups.
     *
     * See the [OOjs UI demos][1] for an example.
     *
     * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/index.html#widgets-apex-vector-ltr
     *
     * @class
     * @abstract
     * @mixins OO.ui.mixin.RequestManager
     *
     * @constructor
     * @param {Object} [config] Configuration options
     * @cfg {jQuery} [$overlay] Overlay for the lookup menu; defaults to relative positioning.
     *  See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
     * @cfg {jQuery} [$container=this.$element] The container element. The lookup menu is rendered beneath the specified element.
     * @cfg {boolean} [allowSuggestionsWhenEmpty=false] Request and display a lookup menu when the text input is empty.
     *  By default, the lookup menu is not generated and displayed until the user begins to type.
     * @cfg {boolean} [highlightFirst=true] Whether the first lookup result should be highlighted (so, that the user can
     *  take it over into the input with simply pressing return) automatically or not.
     */
    OO.ui.mixin.LookupElement = function OoUiMixinLookupElement( config ) {
    	// Configuration initialization
    	config = $.extend( { highlightFirst: true }, config );

    	// Mixin constructors
    	OO.ui.mixin.RequestManager.call( this, config );

    	// Properties
    	this.$overlay = config.$overlay || this.$element;
    	this.lookupMenu = new OO.ui.MenuSelectWidget( {
    		widget: this,
    		input: this,
    		$floatableContainer: config.$container || this.$element
    	} );

    	this.allowSuggestionsWhenEmpty = config.allowSuggestionsWhenEmpty || false;

    	this.lookupsDisabled = false;
    	this.lookupInputFocused = false;
    	this.lookupHighlightFirstItem = config.highlightFirst;

    	// Events
    	this.$input.on( {
    		focus: this.onLookupInputFocus.bind( this ),
    		blur: this.onLookupInputBlur.bind( this ),
    		mousedown: this.onLookupInputMouseDown.bind( this )
    	} );
    	this.connect( this, { change: 'onLookupInputChange' } );
    	this.lookupMenu.connect( this, {
    		toggle: 'onLookupMenuToggle',
    		choose: 'onLookupMenuItemChoose'
    	} );

    	// Initialization
    	this.$input.attr( {
    		role: 'combobox',
    		'aria-owns': this.lookupMenu.getElementId(),
    		'aria-autocomplete': 'list'
    	} );
    	this.$element.addClass( 'oo-ui-lookupElement' );
    	this.lookupMenu.$element.addClass( 'oo-ui-lookupElement-menu' );
    	this.$overlay.append( this.lookupMenu.$element );
    };

    /* Setup */

    OO.mixinClass( OO.ui.mixin.LookupElement, OO.ui.mixin.RequestManager );

    /* Methods */

    /**
     * Handle input focus event.
     *
     * @protected
     * @param {jQuery.Event} e Input focus event
     */
    OO.ui.mixin.LookupElement.prototype.onLookupInputFocus = function () {
    	this.lookupInputFocused = true;
    	this.populateLookupMenu();
    };

    /**
     * Handle input blur event.
     *
     * @protected
     * @param {jQuery.Event} e Input blur event
     */
    OO.ui.mixin.LookupElement.prototype.onLookupInputBlur = function () {
    	this.closeLookupMenu();
    	this.lookupInputFocused = false;
    };

    /**
     * Handle input mouse down event.
     *
     * @protected
     * @param {jQuery.Event} e Input mouse down event
     */
    OO.ui.mixin.LookupElement.prototype.onLookupInputMouseDown = function () {
    	// Only open the menu if the input was already focused.
    	// This way we allow the user to open the menu again after closing it with Esc
    	// by clicking in the input. Opening (and populating) the menu when initially
    	// clicking into the input is handled by the focus handler.
    	if ( this.lookupInputFocused && !this.lookupMenu.isVisible() ) {
    		this.populateLookupMenu();
    	}
    };

    /**
     * Handle input change event.
     *
     * @protected
     * @param {string} value New input value
     */
    OO.ui.mixin.LookupElement.prototype.onLookupInputChange = function () {
    	if ( this.lookupInputFocused ) {
    		this.populateLookupMenu();
    	}
    };

    /**
     * Handle the lookup menu being shown/hidden.
     *
     * @protected
     * @param {boolean} visible Whether the lookup menu is now visible.
     */
    OO.ui.mixin.LookupElement.prototype.onLookupMenuToggle = function ( visible ) {
    	if ( !visible ) {
    		// When the menu is hidden, abort any active request and clear the menu.
    		// This has to be done here in addition to closeLookupMenu(), because
    		// MenuSelectWidget will close itself when the user presses Esc.
    		this.abortLookupRequest();
    		this.lookupMenu.clearItems();
    	}
    };

    /**
     * Handle menu item 'choose' event, updating the text input value to the value of the clicked item.
     *
     * @protected
     * @param {OO.ui.MenuOptionWidget} item Selected item
     */
    OO.ui.mixin.LookupElement.prototype.onLookupMenuItemChoose = function ( item ) {
    	this.setValue( item.getData() );
    };

    /**
     * Get lookup menu.
     *
     * @private
     * @return {OO.ui.MenuSelectWidget}
     */
    OO.ui.mixin.LookupElement.prototype.getLookupMenu = function () {
    	return this.lookupMenu;
    };

    /**
     * Disable or re-enable lookups.
     *
     * When lookups are disabled, calls to #populateLookupMenu will be ignored.
     *
     * @param {boolean} disabled Disable lookups
     */
    OO.ui.mixin.LookupElement.prototype.setLookupsDisabled = function ( disabled ) {
    	this.lookupsDisabled = !!disabled;
    };

    /**
     * Open the menu. If there are no entries in the menu, this does nothing.
     *
     * @private
     * @chainable
     */
    OO.ui.mixin.LookupElement.prototype.openLookupMenu = function () {
    	if ( !this.lookupMenu.isEmpty() ) {
    		this.lookupMenu.toggle( true );
    	}
    	return this;
    };

    /**
     * Close the menu, empty it, and abort any pending request.
     *
     * @private
     * @chainable
     */
    OO.ui.mixin.LookupElement.prototype.closeLookupMenu = function () {
    	this.lookupMenu.toggle( false );
    	this.abortLookupRequest();
    	this.lookupMenu.clearItems();
    	return this;
    };

    /**
     * Request menu items based on the input's current value, and when they arrive,
     * populate the menu with these items and show the menu.
     *
     * If lookups have been disabled with #setLookupsDisabled, this function does nothing.
     *
     * @private
     * @chainable
     */
    OO.ui.mixin.LookupElement.prototype.populateLookupMenu = function () {
    	var widget = this,
    		value = this.getValue();

    	if ( this.lookupsDisabled || this.isReadOnly() ) {
    		return;
    	}

    	// If the input is empty, clear the menu, unless suggestions when empty are allowed.
    	if ( !this.allowSuggestionsWhenEmpty && value === '' ) {
    		this.closeLookupMenu();
    	// Skip population if there is already a request pending for the current value
    	} else if ( value !== this.lookupQuery ) {
    		this.getLookupMenuItems()
    			.done( function ( items ) {
    				widget.lookupMenu.clearItems();
    				if ( items.length ) {
    					widget.lookupMenu
    						.addItems( items )
    						.toggle( true );
    					widget.initializeLookupMenuSelection();
    				} else {
    					widget.lookupMenu.toggle( false );
    				}
    			} )
    			.fail( function () {
    				widget.lookupMenu.clearItems();
    			} );
    	}

    	return this;
    };

    /**
     * Highlight the first selectable item in the menu, if configured.
     *
     * @private
     * @chainable
     */
    OO.ui.mixin.LookupElement.prototype.initializeLookupMenuSelection = function () {
    	if ( this.lookupHighlightFirstItem && !this.lookupMenu.getSelectedItem() ) {
    		this.lookupMenu.highlightItem( this.lookupMenu.getFirstSelectableItem() );
    	}
    };

    /**
     * Get lookup menu items for the current query.
     *
     * @private
     * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument of
     *   the done event. If the request was aborted to make way for a subsequent request, this promise
     *   will not be rejected: it will remain pending forever.
     */
    OO.ui.mixin.LookupElement.prototype.getLookupMenuItems = function () {
    	return this.getRequestData().then( function ( data ) {
    		return this.getLookupMenuOptionsFromData( data );
    	}.bind( this ) );
    };

    /**
     * Abort the currently pending lookup request, if any.
     *
     * @private
     */
    OO.ui.mixin.LookupElement.prototype.abortLookupRequest = function () {
    	this.abortRequest();
    };

    /**
     * Get a new request object of the current lookup query value.
     *
     * @protected
     * @method
     * @abstract
     * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
     */
    OO.ui.mixin.LookupElement.prototype.getLookupRequest = null;

    /**
     * Pre-process data returned by the request from #getLookupRequest.
     *
     * The return value of this function will be cached, and any further queries for the given value
     * will use the cache rather than doing API requests.
     *
     * @protected
     * @method
     * @abstract
     * @param {Mixed} response Response from server
     * @return {Mixed} Cached result data
     */
    OO.ui.mixin.LookupElement.prototype.getLookupCacheDataFromResponse = null;

    /**
     * Get a list of menu option widgets from the (possibly cached) data returned by
     * #getLookupCacheDataFromResponse.
     *
     * @protected
     * @method
     * @abstract
     * @param {Mixed} data Cached result data, usually an array
     * @return {OO.ui.MenuOptionWidget[]} Menu items
     */
    OO.ui.mixin.LookupElement.prototype.getLookupMenuOptionsFromData = null;

    /**
     * Set the read-only state of the widget.
     *
     * This will also disable/enable the lookups functionality.
     *
     * @param {boolean} readOnly Make input read-only
     * @chainable
     */
    OO.ui.mixin.LookupElement.prototype.setReadOnly = function ( readOnly ) {
    	// Parent method
    	// Note: Calling #setReadOnly this way assumes this is mixed into an OO.ui.TextInputWidget
    	OO.ui.TextInputWidget.prototype.setReadOnly.call( this, readOnly );

    	// During construction, #setReadOnly is called before the OO.ui.mixin.LookupElement constructor
    	if ( this.isReadOnly() && this.lookupMenu ) {
    		this.closeLookupMenu();
    	}

    	return this;
    };

    /**
     * @inheritdoc OO.ui.mixin.RequestManager
     */
    OO.ui.mixin.LookupElement.prototype.getRequestQuery = function () {
    	return this.getValue();
    };

    /**
     * @inheritdoc OO.ui.mixin.RequestManager
     */
    OO.ui.mixin.LookupElement.prototype.getRequest = function () {
    	return this.getLookupRequest();
    };

    /**
     * @inheritdoc OO.ui.mixin.RequestManager
     */
    OO.ui.mixin.LookupElement.prototype.getRequestCacheDataFromResponse = function ( response ) {
    	return this.getLookupCacheDataFromResponse( response );
    };