Class Qww.Button.Mgr

JavaScript class to manage communication with an underlying QlikView button object.

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

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

Field Summary
Field Attributes	Field Name and Description
	Caption Current Text/Caption of the button control.
	Cfg Reference to the configuration object which was used to create construct the object.
	Enabled Whether the button is enabled (visible) within the QlikView application.

Method Summary
Method Attributes	Method Name and Description
<static>	Qww.Button.Mgr.CallStandardAction(applicationId, action, isFinal) Sends a click through to the button.
<static>	Qww.Button.Mgr.SendClick(applicationId, buttonId, isFinal) Sends a click through to the button.
	SendClick(isFinal) Sends a click through to the button.

Class Detail

Qww.Button.Mgr(cfg)

Constructs a new Qww.Button.Mgr button instance.

var buttonMgr = new Qww.Button.Mgr(
{
"ObjectID" : 'BUCLEAR',
"OnUpdate": function(btnMgr) {

        alert("Qww.Button.Mgr.OnUpdate fired - .Caption = " + 
        btnMgr.Caption + ", .Enabled = " + btnMgr.Enabled);        
    }
});

Parameters:
{Object} cfg: JSON object to configure ButtonMgr.
{String} cfg.ObjectID: Id of the button 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.
{Function} cfg.OnUpdate Optional: Function to call whenever an update is received for the button (for example if the button text changes). The function should accept a single parameter which is reference to the ButtonMgr itself.

Returns:: {Qww.Button.Mgr} Qww.Button.Mgr

Field Detail

{String} Caption

Current Text/Caption of the button control.

{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.

{Bool} Enabled

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

Method Detail

<static> Qww.Button.Mgr.CallStandardAction(applicationId, action, isFinal)

Sends a click through to the button.

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).
{Qww.Button.Mgr.StandardAction} action: Standard action to carry out on QlikView Application.
{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.Button.Mgr.SendClick(applicationId, buttonId, isFinal)

Sends a click through to the button.

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} buttonId: Id of the button control in the QlikView application.
{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.

SendClick(isFinal)

Sends a click through to the button.

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.

Classes

Class Qww.Button.Mgr