oscar.Gui.MultiItemChooserTable

The multiple item chooser allows the user to choose multiple items at the same time.  It lists all the available items in a paginated table and uses a CheckBox to show the selected/unselected state for each.  The chooser also has an AutoComplete input field that can narrow down the list by searching the items.  A reset button is provided to restore the pre-selected items when constructing the chooser.

@deprecated

Summary
oscar.Gui.MultiItemChooserTableThe multiple item chooser allows the user to choose multiple items at the same time.
Constants
EVENT_TYPES {Array(String)} supported events.
Constructor
oscar.Gui.MultiItemChooserTable
Functions
setCheckAllImage Sets the CSS (Class) on the ‘Select All’Image Checkbox.
isAllCheckboxesSelectedVerifies that all the checkboxes are selected so that we can set the ‘CheckAll’ checkbox to a partial selection.
getItemsSelections Gets the selected Items.
setItemsSelectionssets the items selections, could be used to clear the selections if you pass in null.
destroy Destroys the DataTable and clears the innerHTML of thecontainer.
enableResetButton Enables the reset button, changes the style.
Constants
CLASS_NAME - oscar.Gui.MultiItemChooserTable

Constants

EVENT_TYPES {Array(String)} supported events.

clickedTriggered by checkbox clicked. resetClicked - Triggered by reset button clicked.

Constructor

oscar.Gui.MultiItemChooserTable

Parameters: containerThe tag id that the multiItemChooserTable will be
attached to. preSelectedItemsInThe items that will be selected by
default.  DataSourceInThe data source the SRSs come from.
dataTableConfigThe datatable’s configuration parameters. columnDefs -
The column definition configuration. requestParameterInThe request
parameter used in the getItems method. options{Object} An optional object whose properties will be set on this instance.

Functions

setCheckAllImage Sets the CSS (Class) on the ‘Select All’

Image Checkbox.

Parameters: {className}the state of the “Checkbox” [‘All’, ‘None’, ‘Partial’] if left blank, the method will determine the state from the DataTable.

isAllCheckboxesSelected

isAllCheckboxesSelected : function()

Verifies that all the checkboxes are selected so that we can set the ‘CheckAll’ checkbox to a partial selection.

Returns: 0{Number} No items are selected.  1 - {Number} All items are
selected.  -1{Number} Some items are selected.

getItemsSelections Gets the selected Items.

Returns: ItemsSelectionsthe array of the selected Items.

setItemsSelections

setItemsSelections : function(selections)

sets the items selections, could be used to clear the selections if you pass in null.

Parameters: selections{Array} Array of the selected items.

destroy Destroys the DataTable and clears the innerHTML of the

container.

enableResetButton Enables the reset button, changes the style.

Constants

CLASS_NAME - oscar.Gui.MultiItemChooserTable

isAllCheckboxesSelected : function()
Verifies that all the checkboxes are selected so that we can set the ‘CheckAll’ checkbox to a partial selection.
setItemsSelections : function(selections)
sets the items selections, could be used to clear the selections if you pass in null.