Class Qww.ListBox.Mgr

JavaScript class to manage communication with a QlikView ListBox.

Defined in: <JavaScript\QWW\QwwJs_ListBoxMgr.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	Qww.ListBox.Mgr(cfg) Constructs a new Qww.ListBox.Mgr instance.

Field Summary
Field Attributes	Field Name and Description
	Caption Caption for text object.
	Cfg Reference to the configuration object which was used to create construct the object.
	CurrentPage Returns the current page number which the ListBoxMgr holds data for.
	Enabled Whether the listbox is enabled (visible) within the QlikView application.
	NoPages Number of pages of data for the listbox.
	NumberOfColumns The number of columns the listbox is configured with.
	PageSize Number of items per page of data received for the listbox.
	Results Set of results for current page of data which the ListBoxMgr is showing.
	TotalSize Total number of items in the listbox.

Method Summary
Method Attributes	Method Name and Description
<static>	Qww.ListBox.Mgr.CallAction(applicationId, objectID, action, isFinal) Calls a standard action on the list box (e.g.
	CallAction(action, isFinal) Calls a standard action on the list box (e.g.
	ClearAll(isFinal) Clears all selections in the listbox.
	GetSummary() Returns a html string summary of the main properties of the TableMgr.
<static>	Qww.ListBox.Mgr.MakeSelection(applicationId, objectID, arrayOfItems, optionalUseText, isFinal) Makes a selection in the listbox based on the array of text or underlying numerical values passed.
	MakeSelection(arrayOfItems, valueIsText, isFinal) Makes a single selection in the listbox based on a text or underlying numerical value.
<static>	Qww.ListBox.Mgr.MakeSingleSelection(applicationId, objectID, itemValueOrText, optionalUseText, isFinal) Makes a single selection in the listbox based on a text or underlying numerical value.
	MakeSingleSelection(itemValueOrText, valueIsText, isFinal) Makes a single selection in the listbox based on a text or underlying numerical value.
	PageDown() Moves to the next page of data in the listbox.
	PageUp() Moves to the previous page of data in the listbox.
<static>	Qww.ListBox.Mgr.SearchAndClose(applicationId, objectID, searchString, isFinal) Selects all items in the listbox which match the specified search string.
	SearchAndClose(searchString, isFinal) Selects all items in the listbox which match the specified search string.
	SetPage(pageNumber) Moves to the page number specified.

Class Detail

Qww.ListBox.Mgr(cfg)

Constructs a new Qww.ListBox.Mgr instance.

var lbMgr = new Qww.ListBox.Mgr(
{   
ObjectID: "LBLISTBOXID", 
OnUpdate: function(listBoxMgr)
{
var s = "";
    
var allResults = listBoxMgr.Results.All;
    
for(var i = 0; i < allResults.length; i++)
{
var item = allResults[i];

s += item.GetSummary() + ", ";
}
    
$("#summary").html(listBoxMgr.Results.GetSummary() + " - " + s);
}
});

Parameters:
{Object} cfg: JSON object to configure ListBoxMgr.
{String} cfg.ObjectID: Id of the ListBox in the QlikView application.
{String} cfg.ApplicationID Optional, Default: null: Id/Name of the QlikView application. Note this is only necessary when multiple QlikView documents are being used on the same web page and should otherwise be set to null.
{Int} cfg.PageSize Optional, Default: 20: Number of rows to return in a single page of data.
{Bool} cfg.DoNotInitialise Optional, Default: false: Set this to false if you do not want this particular object to initialise the underlying object with QlikView Server. Use this option for example if you are already using another object or control which will have already initialised this. In this mode this object will simply parse the existing data for this object as it comese from QlikView Server.
{Function} cfg.OnUpdate Optional: Function to call whenever the data is updated.

Returns:: {Qww.ListBox.Mgr} Qww.ListBox.Mgr

Field Detail

{Qww.ObjectCaption} Caption

Caption for text object.

{Object} Cfg

Reference to the configuration object which was used to create construct the object. This allows certain properties to be updated after initial instantiation.

{Int} CurrentPage

Returns the current page number which the ListBoxMgr holds data for.

{Bool} Enabled

Whether the listbox is enabled (visible) within the QlikView application. This can be dependent, for example, upon show and hide conditions set for the object in QlikView.

{Int} NoPages

Number of pages of data for the listbox.

{Number} NumberOfColumns

The number of columns the listbox is configured with.

{Int} PageSize

Number of items per page of data received for the listbox.

{Qww.ListBox.Results} Results

Set of results for current page of data which the ListBoxMgr is showing.

{Int} TotalSize

Total number of items in the listbox.

Method Detail

<static> Qww.ListBox.Mgr.CallAction(applicationId, objectID, action, isFinal)

Calls a standard action on the list box (e.g. clear all, lock selections).

Qww.ListBox.Mgr.CallAction(null, 'LBID', Qww.ListBox.Mgr.StandardAction.ClearAll);

Parameters:
{String} applicationId: Id/Name of the QlikView application (note this is only necessary when multiple QlikView documents are being used on the same web page and should otherwise be set to null).
{String} objectID: Id of the ListBox in the QlikView application.
{Qww.ListBox.Mgr.StandardAction} action: Action to call
{Bool} isFinal Optional, Default: true: If this is the final command in this set to send to QlikView Server. Set this to false if you intend to call some methods on other objects and would like all the commands to be sent in one request.

CallAction(action, isFinal)

Calls a standard action on the list box (e.g. clear all, lock selections).

    lbMgr.CallAction(Qww.ListBox.Mgr.StandardAction.ClearAll, true);

Parameters:
{Qww.ListBox.Mgr.StandardAction} action: Action to call
{Bool} isFinal Optional, Default: true: If this is the final command in this set to send to QlikView Server. Set this to false if you intend to call some methods on other objects and would like all the commands to be sent in one request.

ClearAll(isFinal)

Clears all selections in the listbox.

Parameters:
{Bool} isFinal Optional, Default: true: If this is the final command in this set to send to QlikView Server. Set this to false if you intend to call some methods on other objects and would like all the commands to be sent in one request.

GetSummary()

Returns a html string summary of the main properties of the TableMgr.

<static> Qww.ListBox.Mgr.MakeSelection(applicationId, objectID, arrayOfItems, optionalUseText, isFinal)

Makes a selection in the listbox based on the array of text or underlying numerical values passed.

Parameters:
{String} applicationId: Id/Name of the QlikView application (note this is only necessary when multiple QlikView documents are being used on the same web page and should otherwise be set to null).
{String} objectID: Id of the ListBox in the QlikView application.
{String[]|Int[]} arrayOfItems: Array of Value or Text items to select.
{Bool} optionalUseText Optional, Default: false: Set to true if value is text, otherwise use false. Note using values is more
{Bool} isFinal Optional, Default: true: If this is the final command in this set to send to QlikView Server. Set this to false if you intend to call some methods on other objects and would like all the commands to be sent in one request.

MakeSelection(arrayOfItems, valueIsText, isFinal)

Makes a single selection in the listbox based on a text or underlying numerical value.

Parameters:
{String[]|Int[]} arrayOfItems: Array of Value or Text items to select.
{Bool} valueIsText Optional, Default: false: Set to true if value is text, otherwise use false. Note using values is more reliable however you must know the underlying value of the listbox item.
{Bool} isFinal Optional, Default: true: If this is the final command in this set to send to QlikView Server. Set this to false if you intend to call some methods on other objects and would like all the commands to be sent in one request.

<static> Qww.ListBox.Mgr.MakeSingleSelection(applicationId, objectID, itemValueOrText, optionalUseText, isFinal)

Makes a single selection in the listbox based on a text or underlying numerical value.

Parameters:
{String} applicationId: Id/Name of the QlikView application (note this is only necessary when multiple QlikView documents are being used on the same web page and should otherwise be set to null).
{String} objectID: Id of the ListBox in the QlikView application.
{String|Int} itemValueOrText: Value or Text of item to select.
{Bool} optionalUseText Optional, Default: false: Set to true if value is text, otherwise use false. Note using values is more reliable however you must know the underlying value of the listbox item.
{Bool} isFinal Optional, Default: true: If this is the final command in this set to send to QlikView Server. Set this to false if you intend to call some methods on other objects and would like all the commands to be sent in one request.

MakeSingleSelection(itemValueOrText, valueIsText, isFinal)

Makes a single selection in the listbox based on a text or underlying numerical value.

Parameters:
{String|Int} itemValueOrText: Value or Text of listbox item.
{Bool} valueIsText Optional, Default: false: Set to true if value is text, otherwise use false. Note using values is more reliable however you must know the underlying value of the listbox item.
{Bool} isFinal Optional, Default: true: If this is the final command in this set to send to QlikView Server. Set this to false if you intend to call some methods on other objects and would like all the commands to be sent in one request.

{Bool} PageDown()

Moves to the next page of data in the listbox.

Returns:: {Bool} Returns true if the page was changed (if the listbox was already set to the last page then false will be returned).

{Bool} PageUp()

Moves to the previous page of data in the listbox.

Returns:: {Bool} Returns true if the page was changed (if the listbox was already set to the first page then false will be returned).

<static> Qww.ListBox.Mgr.SearchAndClose(applicationId, objectID, searchString, isFinal)

Selects all items in the listbox which match the specified search string.

Parameters:
{String} applicationId: Id/Name of the QlikView application (note this is only necessary when multiple QlikView documents are being used on the same web page and should otherwise be set to null).
{String} objectID: Id of the ListBox in the QlikView application.
{String} searchString: Search string.
{Bool} isFinal Optional, Default: true: If this is the final command in this set to send to QlikView Server. Set this to false if you intend to call some methods on other objects and would like all the commands to be sent in one request.

SearchAndClose(searchString, isFinal)

Selects all items in the listbox which match the specified search string.

Parameters:
{String} searchString: Search string.
{Bool} isFinal Optional, Default: true: If this is the final command in this set to send to QlikView Server. Set this to false if you intend to call some methods on other objects and would like all the commands to be sent in one request.

SetPage(pageNumber)

Moves to the page number specified.

Parameters:
{Int} pageNumber: Page number to move to.

Classes

Class Qww.ListBox.Mgr