jQuery UI Multiselect

• enabled

  Signature:

  .multiselect( 'enabled', [state], [msg] )

  Get or set the state of the enabled multiselect. If no state is specified, will act as a getter. If state is set to false, the msg argument will display the specified string as custom disabled message inside the multiseelct.

• deselect

  Signature:

  .multiselect( 'deselect', item )

  Deselect the specified item. The value should be the text of the option to verify (not case sensitive).

  If only the option key is known, the option may be specified using the following command:

  $('.mulstiselect').multiselect('deselect', $('.multiselect').find('option[value=key]').text() );

• destroy

  Signature:

  .multiselect( 'destroy' )

  Remove the multiselect functionality completely. This will return the element back to it's default look.

• isBusy

  Signature:

  .multiselect( 'isBusy' )

  Return the busy state of the multiselect. The method will return true if the multiselect is processing item selection, search, etc.

• isSelected

  Signature:

  .multiselect( 'isSelected', item )

  Return true if and only if item is selected. The value should be the text of the option to verify (not case sensitive).

  If only the option key is known, the option may be specified using the following command:

  $('.mulstiselect').multiselect('isSelected', $('.multiselect').find('option[value=key]').text() );

• option

  Signature:

  .multiselect( 'option', optionName, [value] )

  Get or set any dialog option. If no value is specified, will act as a getter.

• search

  Signature:

  .multiselect( 'search', query )

  Perform a search of all the available elements, and filter out (hide) any unmatched item. This method controls the search input fields, if the multiselect is not searchable, or is busy, or not enabled, the method does nothing.

• select

  Signature:

  .multiselect( 'select', item )

  Select the specified item. The value should the text of the option to select (not case sensitive).

  If only the option key is known, the option may be specified using the following command:

  $('.mulstiselect').multiselect('select', $('.multiselect').find('option[value=key]').text() );

• selectAll

  Signature:

  .multiselect( 'selectAll' )

  Select all of the available items.

• selectedValues

  Signature:

  .multiselect( 'selectedValues' )

  Return an array of the keys of all the currently selected values.

  This method is an utility method equivalent to :

  $.map( $('.multiselect').find('option[selected]'), function(item,i) { return $(item).val(); });

• selectNone

  Signature:

  .multiselect( 'selectNone' )

  Deselect all the selected items (equivalent to "Remove all").

All event callbacks receive two parameters: the event object and the ui object. The ui object's property may vary between events, but all share these basic properties:

• ui.sender : the SELECT element where the event originated (use $(ui.sender).multiselect(...) to access widget)

• deselected

  Type:

  multiselectdeselected

  This event is triggered whenever the an option has been deselected. The event deselected is triggered for every option deselected.

  Code examples

  Supply a feedback function to handle the deselected events as an init option.

  $('.selector').multiselect({ deselected: function(event, ui) { alert($(ui.option).val() + " has been deselected"); } });

  Bind to the deselected event of type multiselectdeselected.

  $('.selector').bind('multiselectdeselected', function(event, ui) {
    ...   // ui.option is the DOMOption node of ui.sender
  });

• messages

  Type:

  multiselectmessages

  This event is triggered whenever the widget needs to send some feedback to the user.

  Code examples

  Supply a feedback function to handle the messages supplied by the widget as an init option. The ui object will hold these extra parameters:

  • ui.description : a preformatted message describing the event's message
  • ui.type : one of the following value: 0=message (warning), 1=exception, 2=error

  $('.selector').multiselect({ messages: function(event, ui) { alert(ui.description); } });

  Bind to the messages event of type multiselectmessages.

  $('.selector').bind('multiselectmessages', function(event, ui) {
    ...
  });

• selected

  Type:

  multiselectselected

  This event is triggered whenever the an option has been selected. The event selected is triggered for every option selected.

  Code examples

  Supply a feedback function to handle the selected events as an init option.

  $('.selector').multiselect({ selected: function(event, ui) { alert($(ui.option).val() + " has been selected"); } });

  Bind to the selected event of type multiselectselected.

  $('.selector').bind('multiselectselected', function(event, options) {
    ...   // ui.option is the DOMOption node of ui.sender
  });