Using JavaScript Code With HTML Composer Pages

In this section:

Although the HTML Composer is fully integrated with JavaScript, it is suggested that you do not create custom JavaScript that manipulates the HTML Composer generated controls, as WebFOCUS cannot support such custom JavaScript code. Additionally, there is no guarantee that the JavaScript code will work correctly in future releases.

Note:


Top of page

x
Function: IbComposer_getCurrentSelection

How to:

The IbComposer_getCurrentSelection function gets the current selected values from a control.



x
Syntax: How to Get the Current Selected Value From a Control
IbComposer_getCurrentSelection('controlID', [layer]);

where:

controlID

Alphanumeric

Is the unique identifier of the control from which values are obtained.

layer

Integer

Is an optional parameter used to specify the layer number in a multi source Tree control if a Multi source Tree control is being used. The layer number starts with 1 for the first layer.



Example: Getting the Current Selected Value for a Drop Down List
function button1_onclick(ctrl) {
   var values = IbComposer_getCurrentSelection('combobox1');
   for(var I = 0; i < values.length; i++)		
      alert(values[i]);
}

Top of page

x
Function: IbComposer_setCurrentSelection

How to:

The IbComposer_setCurrentSelection function sets the current selected values for control parameters.



x
Syntax: How to Set the Current Selected Value for a Control
IbComposer_setCurrentSelection('controlID', arrValues, bUpdateDependencies);

where:

controlID

Alphanumeric

Is the unique identifier of the control for which to set the values.

arrValues

Array

Is the array of values to be set.

bUpdateDependencies

Boolean

Is an operator that can be set to true to update chained controls and triggered events. Default is false.



Example: Setting the Current Selected Value for a List Box
function button2_onclick(ctrl) {
   var arr = [];
   arr.push('ITALY');
   arr.push('JAPAN');
   IbComposer_setCurrentSelection('listbox1', arr, false);
}

Top of page

x
Function: IbComposer_execute

How to:

The IbComposer_execute function executes a report or chart.



x
Syntax: How to Execute a Report or Chart
IbComposer_execute('reportID', ['outputTarget']);

where:

reportID

Alphanumeric

Is the unique identifier of the report or chart to execute.

outputTarget

Alphanumeric

Is the optional parameter to set the target of the output. Is one of the following:

  • The name of a frame.
  • '_blank'.
  • '_target'.
  • The name of a new window.


Example: Executing a Report in a New Window
function button3_onclick(ctrl) {
   IbComposer_execute('report1', 'newwin');
}

Top of page

x
Function: IbComposer_isSelected

How to:

The IbComposer_isSelected function determines if a control or value is selected.



x
Syntax: How to Determine If a Control or Value Is Selected
IbComposer_isSelected('controlID', 'testValue');

where:

controlID

Alphanumeric

Is the unique identifier of the control being tested.

testValue

Alphanumeric

Is the value the control is being checked against.



Example: Determining If a Checkbox Is Selected
function checkbox1_onclick(ctrl){
   var curValue = IbComposer_isSelected('checkbox1');	
   IbComposer_showHtmlElement('form1', curValue);
}

Top of page

x
Function: IbComposer_showHtmlElement

How to:

The IbComposer_showHtmlElement function shows or hides an HTML element.



x
Syntax: How to Show or Hide an HTML Element
IbComposer_showHtmlElement('elementID', bShow);

where:

elementID

Alphanumeric

Is the unique identifier of the element which is shown or hidden.

bShow

Boolean

Is an operator that can be set to true to show the element and false to hide it.



Example: Hiding or Showing a Check Box
function checkbox1_onclick(ctrl){
   var curValue = IbComposer_isSelected('checkbox1');
   IbComposer_showHtmlElement('form1', curValue);
}

Top of page

x
Function: IbComposer_enableHtmlElement

How to:

The IbComposer_enableHtmlElement function enables or disables an HTML element.



x
Syntax: How to Enable or Disable an HTML Element
IbComposer_enableHtmlElement('elementID', bEnable);

where:

elementID

Alphanumeric

Is the unique identifier of the element which is enabled or disabled.

bEnable

Boolean

Is an operator that can be set to true to enable the element and false to disable it.



Example: Enabling or Disabling Elements
function checkbox2_onclick(ctrl){
   IbComposer_enableHtmlElement('listbox1', IbComposer_isSelected('checkbox2', 'country'));
   IbComposer_enableHtmlElement('combobox1', IbComposer_isSelected('checkbox2', 'car'));
   IbComposer_enableHtmlElement('listbox2', IbComposer_isSelected('checkbox2', 'model'));
   IbComposer_enableHtmlElement('combobox2', IbComposer_isSelected('checkbox2', 'dcost'));
}

Top of page

x
Function: IbComposer_ResetDownChainControls

How to:

The IbComposer_ResetDownChainControls function resets the controls down the chain from the current control to have correct corresponding values.



x
Syntax: How to Reset Chain Controls
IbComposer_ResetDownChainControls('ctrl');

where:

ctrl

Alphanumeric

Is the unique identifier of the first control.



Example: Resetting the Chain Started by a List Box
function button4_onclick(ctrl) {
   var arr = [];arr.push('ENGLAND');
   IbComposer_setCurrentSelection('listbox1', arr, false);
   IbComposer_ResetDownChainControls('listbox1');
}

Top of page

x
Function: IbComposer_selectTab

How to:

The IbComposer_selectTab function selects the tab specified by the tabNumberToSelect and makes it the active tab.



x
Syntax: How to Select a Tab and Make It Active
IbComposer_selectTab('tabControlID', tabNumberToSelect);

where:

tabControlID

Alphanumeric

Is the unique identifier of the tab control being made active.

tabNumberToSelect

Integer

Is the number of the tab to make active.



Example: Making a Tab Active
<FORM id=form1 onsubmit="OnExecute(this);
IbComposer_selectTab('tab1', 1) name="form1">

Top of page

x
Event: onbeforeload

How to:

The onbeforeload event is called before a control is populated with values.



x
Syntax: How to Call onbeforeload
onbeforeload('ctrl', 'arrValuesToLoad');

where:

ctrl

Alphanumeric

Is the object of the control.

arrValuesToLoad

Alphanumeric

Is the array of values that will be loaded into the control.



Example: Populating a Listbox With onbeforeload
function listbox1_onbeforeload(ctrl,arrValuesToLoad) {
   for(var i = 0; i < arrValuesToLoad.length; i++) {
   alert(arrValuesToLoad[i].dispValue + "  " + arrValuesToLoad[i].value + "  " + arrValuesToLoad[i].selected); 
   }
}

Top of page

x
Event: onafterload

How to:

The onafterload event is called after a control is populated with values.



x
Syntax: How to Call onafterload
onafterload('ctrl');

where:

ctrl

Alphanumeric

Is the object of the control.



Example: Selecting the ALL Value in a Listbox With onafterload
function listbox1_onafterload(ctrl){
   alert(IbComposer_isSelected(ctrl.id, 'ALL'));
}

WebFOCUS