Class Index | File Index

Classes


Class Qww.Ctls.TemplatedListBox.Mgr

JavaScript control to render the contents of a QlikView listbox using template html for the different states.

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

Class Summary
Constructor Attributes Constructor Name and Description
 
Constructs a new Qww.Ctls.TemplatedListBox.Mgr instance.
Field Summary
Field Attributes Field Name and Description
 
Cfg
Reference to the configuration object which was used to create construct the object.
 
Reference to the underlying Qww.ListBox.Mgr being used to communicate with the listbox.
Class Detail
Qww.Ctls.TemplatedListBox.Mgr(cfg)
Constructs a new Qww.Ctls.TemplatedListBox.Mgr instance.
<div id="tabsH">   
    <ul id="tabStrip">
        <!-- 
        This element will have content automatically injected into it by
        the Qww.Ctls.TemplatedListBox.Mgr manager based on the live state of the listbox
        -->
    </ul>
</div>
<div style="background-color:Black;height:10px"> </div>

<script type="text/javascript">
var tabToListBoxMgr = new Qww.Ctls.TemplatedListBox.Mgr(
{
    // this can be left null (or not specified at all) unless you have multiple QVWs per web page
    ApplicationID: null,
    // ObjectID of listbox to be mapped to tabs.
    ObjectID: 'LBRELEASEYEAR',
    // Parent element into which manager will insert content based on templates
    ParentElement: "#tabStrip",             
    // HTML template to be used for each unselected item in listbox
    Template: "<li onclick='[CLICK_HANDLER]'>" +
                    "<a href='#'>" + 
                        "<span>[TEXT]</span>" +
                    "</a>" +
                "</li>",
    // HTML template to be used for each selected item in listbox
    TemplateSelected: "<li class='selectedTab'>" + 
                            "<a href='#'>" +
                                "<span>[TEXT]</span>" +
                            "</a>" + 
                        "</li>"
});
</script>
Parameters:
{Object} cfg
JSON object to configure Qww.Ctls.TemplatedListBox.Mgr.
{String} cfg.ObjectID
Id of the listbox in the QlikView application.
{String} cfg.ParentElement
ID of html element to show the control in.
{String} cfg.Template
HTML template for listbox item in the standard (associated) state. Can contain the tokens [TEXT], [VALUE] and [CLICK_HANDLER] which will be replaced by the actual value for this listbox item.
{String} cfg.TemplateSelected Optional
HTML template for listbox item in the standard selected state. Can contain the tokens [TEXT], [VALUE] and [CLICK_HANDLER] which will be replaced by the actual value for this listbox item.
{Sting} cfg.TemplateDisabled Optional
HTML template for listbox item in the disabled state. Can contain the tokens [TEXT], [VALUE] and [CLICK_HANDLER] which will be replaced by the actual value for this listbox item.
{Int} cfg.PageSize Optional, Default: 20
Number of items to retrieve from the listbox.
{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.
{Function} cfg.OnUpdate Optional
Function to call whenever listbox is updated. Accepts a single parameter, a reference to this Qww.Ctls.TemplatedListBox.Mgr instance.
Field Detail
{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.

{Qww.ListBox.Mgr} ListBoxManager
Reference to the underlying Qww.ListBox.Mgr being used to communicate with the listbox.