Class Index | File Index

Classes

Class Qww.Ctls.FlexiSelector.DefaultRenderer

Renderer to be used in conjunction with a Qww.Ctls.FlexiSelector.Mgr. This renderer provides a very basic listbox rendering for illustration purposes only.

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

Class Summary
Constructor Attributes Constructor Name and Description
 
Qww.Ctls.FlexiSelector.DefaultRenderer(cfg)
Constructs a new Qww.Ctls.FlexiSelector.Mgr instance.
Method Summary
Method Attributes Method Name and Description
 
Initialise(lbm, cfg, csm)
Initialises the renderer.
 
OnRenderCurrentSelections(currentSelectionsText)
This method will only be called if the Qww.Ctls.FlexiSelector.Mgr was created with a .CurrentSelectionsObjectID property.
 
OnRenderFrame(parentElement)
This method is called when the outer frame for the control needs to be painted.
 
OnRenderRow(row)
This method is called when an individual entry for the list box needs to be painted.
 
OnUpdateBegin()
This method will be run when the list box data changes, just prior to calling the OnRenderRow method for each listbox item.
 
OnUpdateComplete()
This method will be run when the list box data changes, right after the OnRenderRow method has been called for all the listbox items.
Class Detail
Qww.Ctls.FlexiSelector.DefaultRenderer(cfg)
Constructs a new Qww.Ctls.FlexiSelector.Mgr instance. Constructs a new Qww.Ctls.FlexiSelector.DropDownRenderer instance.
Parameters:
{Object} cfg
JSON object to configure the control.
{String} cfg.Element
Id of the DOM element to render the control into.
{String} cfg.ObjectID
Id of the ListBox in the QlikView application which the flexi selector is rendering a control for.
{String} cfg.CurrentSelectionsObjectID Optional
Id of a current selections box. This is useful if you are using or developing a renderer which wishes to be informed of a string to use to summarise the current selections.
{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.
cfg.Renderer Optional, Default: Qww.Ctls.FlexiSelector.DefaultRenderer
Rendererer object to provide actual rendering implementation. See Qww.FlexiSelector.DefaultRenderer for an outline of the interface which a rendered should implement.
{Function} cfg.OnInitialised Optional
Function to call when the control has been initialised.
{Function} cfg.OnRenderBegin Optional
Function to call when the control is about to re-render.
{Function} cfg.OnRenderComplete Optional
Function to call when the control is about to complete rendering.
{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.
Method Detail
Initialise(lbm, cfg, csm)
Initialises the renderer. Implement this method on your renderer if you wish to be passed the following arguments.
You should implement this if you are developing your own Flexi Selector Renderer.
Parameters:
{Qww.ListBox.Mgr} lbm
List box manager used in the background to provide data for the renderer..
{Object} cfg
JSON configuration object used to initialise the flexi selector manager.
{Qww.CurrentSelections.Mgr} csm Optional
Reference to the current selections manager - this will only be present if the flexi selector manager was created with a .CurrentSelectionsObjectID argument on the JSON configuration object used to construct it.
OnRenderCurrentSelections(currentSelectionsText)
This method will only be called if the Qww.Ctls.FlexiSelector.Mgr was created with a .CurrentSelectionsObjectID property.
You should implement this if you are developing your own Flexi Selector Renderer.
Parameters:
{String} currentSelectionsText
Summary string of the current selections, as supplied by an underlying current selections control in the QlikView application.
OnRenderFrame(parentElement)
This method is called when the outer frame for the control needs to be painted.
You should implement this if you are developing your own Flexi Selector Renderer.
Parameters:
{DOMElement} parentElement
Element in which the control is rendered.
OnRenderRow(row)
This method is called when an individual entry for the list box needs to be painted.
You should implement this if you are developing your own Flexi Selector Renderer.
Parameters:
{Qww.ListBox.Item} row
ListBoxItem to be rendered.
OnUpdateBegin()
This method will be run when the list box data changes, just prior to calling the OnRenderRow method for each listbox item.
You should implement this if you are developing your own Flexi Selector Renderer.
OnUpdateComplete()
This method will be run when the list box data changes, right after the OnRenderRow method has been called for all the listbox items.
You should implement this if you are developing your own Flexi Selector Renderer.