Utiliser le Code JavaScript avec les pages du Développeur HTML

Dans cette section :

 

Bien que le Développeur HTML intègre parfaitement JavaScript, il vous est conseillé de ne pas créer de JavaScript personnalisé qui manipule les contrôles générés par le Développeur HTML, dans la mesure où WebFOCUS ne prend pas en charge les codes JavaScript personnalisés. De plus, il n'existe aucune garantie que le code JavaScript fonctionne correctement dans les version à venir.

Remarque :


Haut de page

x
Fonction : IbComposer_runAnimation

Comment :

IbComposer_runAnimation lance l'animation définie par l'utilisateur dans le panneau Tâches & Animations.



x
Syntaxe : Exécuter une animation
IbComposer_runAnimation(name);

où :

name

Alphanumérique

est le nom de l'animation définie par l'utilisateur dans le panneau Tâches & Animations.



Exemple : Exécution d'une animation
function submit1_onclick(event) {
   IbComposer_runAnimation('animation1');
}

Haut de page

x
Fonction: IbComposer_triggerExecution

Comment :

IbComposer_triggerExecution permet à l'utilisateur d'exécuter une tâche spécifique définie dans la section Tâches du panneau Tâches & Animations.



x
Syntaxe : Exécuter une Tâche spécifique
IbComposer_triggerExecution(taskName,index);

où :

taskName

Alphanumérique

Est le nom de la tâche spécifiée par l'utilisateur dans la section tâche du panneau tâches & animations dans le canevas HTML.

index

Numérique

Est le numéro de la tâche commençant par le numéro 1.



Exemple : Exécution d'une tâche
function submit1_onclick(event) {
   IbComposer_triggerExecution('task1',1);
}

Haut de page

x
Fonction: IbComposer_getMapObject

Comment :

IbComposer_getMapObject renvoie l'objet carte pour le conteneur carte passé en tant que paramètre. L'objet peut alors être utilisé en tant que paramètre dans d'autres fonctions API.



x
Syntaxe : Retourner un objet Carte
IbComposer_getMapObject(mapId);

où :

mapId

Alphanumérique

est l'identifiant unique du premier contrôle. Par exemple, 1.



Exemple : Retourner un objet carte pour une Carte
function onInitialUpdate() {
   var map = IbComposer_getMapObject('mapcontrol1');
}

Haut de page

x
Fonction : IbComposer_getMarkers

Comment :

IbComposer_getMarkers renvoie un tableau de marqueur pour un calque spécifique d'une carte.



x
Syntaxe : Renvoyer une zone de marqueur pour une carte
IbComposer_getMarkers(mapId,layerName);

où :

mapId

Alphanumérique

est l'identifiant unique du premier contrôle. Par exemple, 1.

layerName

Alphanumérique

Et le nom du calque pour lesquels les marqueurs sont retournés. Par exemple, 1.



Exemple : Obtenir une zone de marqueur pour une carte
function  onInitialUpdate() {
   var map = IbComposer_getMapObject('mapcontrol1');
   var markers = IbComposer_getMarkers('mapcontrol1','Customers');
}

Haut de page

x
Fonction : IbComposer_populateDynamicCtrl

Comment :

IbComposer_populateDynamicCtrl vous permet de déterminer quelles données de contrôle à partir desquelles effectuer le traçage pour remplir un contrôle de destination.



x
Syntaxe : Remplir un contrôle de façon dynamique
IbComposer_populateDynamicCtrl(controlID,fromControlId);

où :

controlID

Alphanumérique

est l'identifiant unique du contrôle depuis lequel les valeurs sont obtenues. Par exemple, listbox1.

fromControlId

Alphanumérique

est l'identificateur unique du contrôle à partir duquel les valeurs sont obtenues, lorsque deux ou plusieurs contrôles sont reliés à un contrôle de destination. Par exemple, si listbox1 et listbox2 sont reliés à listbox3, les valeurs de listbox3 seront par défaut déterminées par listbox1. Vous pouvez utiliser IbComposer_populateDynamicCtrl('listbox3','listbox2') pour que listbox2 détermine les valeurs de listbox3. Cet identifiant est falcutatif.



Exemple : Remplir un contrôle de façon dynamique
function button3_onclick(event) {
   var acc = IbComposer_populateDynamicCtrl('listbox3','listbox2');
   acc.selectNextPage();
}

Haut de page

x
Fonction : IbComposer_getComponentById

Comment :

La fonction IbComposer_getComponentById se procure un composant en utilisant ses identifiants.



x
Syntaxe : Obtenir un composant en utilisant ses identifiants
IbComposer_getComponentById(controlID);

où :

controlID

Alphanumérique

est l'identifiant unique du contrôle depuis lequel les valeurs sont obtenues. Par exemple, listbox1.



Exemple : Obtenir le rapport en accordéon en utilisant ses identifiants
function button3_onclick(event) {
   var acc = IbComposer_getComponentById('accordion1');
   acc.selectNextPage();
}

Haut de page

x
Fonction : IbComposer_getCurrentSelection

Comment :

La fonction IbComposer_getCurrentSelection obtient les valeurs sélectionnées actuelles depuis un contrôle.



x
Syntaxe : Obtenir les valeurs actuelles sélectionnées d'un contrôle
IbComposer_getCurrentSelection(controlID,[layer]);

où :

controlID

Alphanumérique

est l'identifiant unique du contrôle depuis lequel les valeurs sont obtenues.

couche

Entier

est le paramètre optionnel utilisé pour spécifier le nombre de couches dans une structure de contrôle à source multiple si une Structure de contrôle à source multiple est utilisée. Le nombre de couches commence avec 1 pour la première couche.



Exemple : Obtenir la valeur actuelle sélectionnée pour une liste déroulante
function button1_onclick(event) {
   var values = IbComposer_getCurrentSelection('combobox1');
   for(var I = 0; i < values.length; i++)
   alert(values[i]);
}

Haut de page

x
Fonction : IbComposer_getCurrentSelectionEx

Comment :

IbComposer_getCurrentSelectionEx obtient les valeurs d'affichage ou actuelles sélectionnées depuis un contrôle. Cette fonction peut aussi être utilisée pour obtenir les valeurs d'index pour des boites de liste, des listes déroulantes, et des listes doubles.



x
Syntaxe : Obtenir la valeur sélectionnée en cours, la valeur actuelle, ou afficher la valeur à partir d'un contrôle
IbComposer_getCurrentSelectionEx(controlID,[layer]);

où :

controlID

Alphanumérique

est l'identifiant unique du contrôle depuis lequel les valeurs sont obtenues.

couche

Entier

est le paramètre optionnel utilisé pour spécifier le nombre de couches dans une structure de contrôle à source multiple si une Structure de contrôle à source multiple est utilisée. Le nombre de couches commence avec 0 pour la première couche.



Exemple : Obtention de la valeur d'index en sélectionné en cours, la valeur actuelle, et afficher une valeur pour une liste à sélections multiples
function button1_onclick(event) {
   var values = IbComposer_getCurrentSelectionEx('combobox1');
   for(var i = 0; i < values.length; i++)
{
   alert("Index Value: " + values[i].getIndex() + "\n" +
   "Actual Value: " + values[i].getValue() + "\n" +
   "Display Value: " + values[i].getDisplayValue());
}

Haut de page

x
Fonction : IbComposer_setCurrentSelection

Comment :

La fonction IbComposer_setCurrentSelection définit les valeurs actuelles sélectionnées pour les paramètres de contrôle.



x
Syntaxe : Définir la valeur actuelle sélectionnée pour un contrôle
IbComposer_setCurrentSelection(controlID,arrValues,bUpdateDependencies);

où :

controlID

Alphanumérique

est l'identifiant unique du contrôle pour lequel les valeurs doivent être définies.

arrValues

Table/Tableau

est la matrice de valeurs à définir.

bUpdateDependencies

booléennes

est un opérateur qui peut être définit à Vrai pour mettre à jour les contrôles et les évènements lancés. « Milieu » est la valeur par défaut.



Exemple : Définir la Valeur actuelle sélectionnée pour une Zone de liste
function button2_onclick(event) {
   var arr = [];
   arr.push('ITALY');
   arr.push('JAPAN');
   IbComposer_setCurrentSelection('listbox1',arr,false);
}

Haut de page

x
Fonction : IbComposer_execute

Comment :

La fonction IbComposer_execute exécute un rapport ou un graphique.



x
Syntaxe : Exécuter un rapport ou un graphique
IbComposer_execute(reportID,[outputTarget]);

où :

reportID

Alphanumérique

est l'identifiant unique du rapport ou le graphique à exécuter.

outputTarget

Alphanumérique

est le paramètre optionnel pour définir la cible de la sortie. indique une des choses suivantes :

  • Le nom d'un cadre.
  • '_blank'.
  • '_target'.
  • Le nom d'une nouvelle fenêtre.


Exemple : Exécuter un rapport dans une nouvelle fenêtre
function button3_onclick(event) {
   IbComposer_execute('report1','newwin');
}

Haut de page

x
Fonction : IbComposer_isSelected

Comment :

La fonction IbComposer_isSelected détermine si un contrôle ou une valeur est sélectionnée.



x
Syntaxe : Détermine si un contrôle ou une valeur est sélectionné
IbComposer_isSelected(controlID,[testValue]);

où :

controlID

Alphanumérique

est l'identifiant unique du contrôle testé.

testValue

Alphanumérique

est la valeur contre laquelle le contrôle est vérifié.



Exemple : Détermine si une case à cocher est sélectionnée
function checkbox1_onclick(event) {
   var curValue = IbComposer_isSelected('checkbox1');	
   IbComposer_showHtmlElement('form1',curValue);
}

Haut de page

x
Fonction : IbComposer_showHtmlElement

Comment :

La fonction IbComposer_showHtmlElement affiche ou masque un élément HTML.



x
Syntaxe : Afficher ou masquer un élément HTML
IbComposer_showHtmlElement(elementID,bShow);

où :

elementID

Alphanumérique

est l'identifiant unique de l'élément affiché ou masqué.

bShow

booléennes

est un opérateur qui peut être définit à Vrai pour afficher l'élément et à Faux pour le masquer.



Exemple : Afficher ou masquer une case à cocher
function checkbox1_onclick(event) {
   var curValue = IbComposer_isSelected('checkbox1');
   IbComposer_showHtmlElement('form1',curValue);
}

Haut de page

x
Fonction : IbComposer_enableHtmlElement

Comment :

La fonction IbComposer_enableHtmlElement active ou dsactive un élément HTML.



x
Syntaxe : Activer ou désactiver un élément HTML
IbComposer_enableHtmlElement(elementID,bEnable);

où :

elementID

Alphanumérique

est l'identifiant unique de l'élément activé ou désactivé.

bEnable

booléennes

est un opérateur qui peut être définit à Vrai pour activer l'élément et à Faux pour le désactiver.



Exemple : Activer ou désactiver des éléments
function checkbox2_onclick(event) {
   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'));
}

Haut de page

x
Fonction : IbComposer_ResetDownChainControls

Comment :

La fonction IbComposer_ResetDownChainControls réinitialise les contrôles en bas de la chaîne depuis le contrôle actuel pour disposer de valeurs correspondantes.



x
Syntaxe : Réinitialiser les contrôles de la chaîne
IbComposer_ResetDownChainControls(ctrl);

où :

ctrl

Alphanumérique

est l'identifiant unique du premier contrôle.



Exemple : Réinitialiser la chaîne commençant par une zone de liste
function button4_onclick(event) {
   var arr = [];arr.push('ENGLAND');
   IbComposer_setCurrentSelection('listbox1',arr,false);
   IbComposer_ResetDownChainControls('listbox1');
}

Haut de page

x
Fonction : IbComposer_selectTab

Comment :

La fonction IbComposer_selectTab sélectionne l'onglet spécifié par le tabNumberToSelect (nombre d'onglets à sélectionner) et le rend actif.



x
Syntaxe : Sélectionner un onglet et le rendre actif
IbComposer_selectTab(tabControlID,tabNumberToSelect);

où :

tabControlID

Alphanumérique

est l'identifiant unique du contrôle d'onglet rendu actif.

tabNumberToSelect

Entier

est le nombre de l'onglet à rendre actif.



Exemple : Rendre un onglet actif
<FORM id=form1 onsubmit="OnExecute(this);
   IbComposer_selectTab('tab1',1) name="form1">

Haut de page

x
Fonction : IbComposer_selectTemplateTab

Comment :

IbComposer_selectTemplateTab sélectionne un onglet sur une page modèle et en fait l'onglet actif.



x
Syntaxe : Sélectionner un onglet et le rendre actif
IbComposer_selectTemplateTab(tabId);

où :

tabId

Alphanumérique

est l'identifiant unique du contrôle d'onglet rendu actif.



Exemple : Rendre un onglet actif
function submit1_onclick(event) {
   IbComposer_selectTemplateTab('tab5');
}

Haut de page

x
Function: IbComposer_getAllAmpersValues

Comment :

IbComposer_getAllAmpersValues est utilisé pour obtenir les valeurs de sélection en cours de tous les contrôles sur la disposition de votre page. Cette fonction prend alors ces valeurs et les assemble en une chaîne pouvant être ajoutée à la fin d'un appel URL. Un exemple serait un contrôle REGION et une multi-sélection de Mid-Est, Nord-Est, et Nord-Ouest. Elle va assembler ces sélections comme ce qui suit :

&REGION=%27MidEast%27%20OR%20%27NorthEast%27%20OR%20%27NorthWest%27

La fonction peut être utilisée en conjonction avec Business Intelligence Portal, ou la chaîne générée est ajoutée à tous les appels Business Intelligence Portal qui exécute les rapports et les graphiques. Ceci permet aux valeurs de paramètres d'affecter tous les composant du portail, même si de nouvelles sont ajoutées ou si des valeurs existantes sont supprimées à l'exécution.



x
Syntaxe : Obtenir toutes les valeurs d'un paramètre
IbComposer_getAllAmpersValues([verifySelection]);

où :

verifySelection

Booléennes

Il s'agit d'une propriété facultative. Si Vrai et si la propriété Sélection requise pour le contrôle a la valeur Oui, ceci renvoie une chaîne vide pour les contrôles de paramètres n'ayant aucune sélection active.

Remarque : tous les contrôles ont la propriété Sélection requise. Cette propriété a la valeur Oui par défaut. Si un contrôle ne possède pas de sélection valide au moment de l'exécution, une boîte rouge apparaît autour de lui et la barre de statut affiche le message suivant :

Please make required selections



Exemple : Extraire une liste de tous les paramètres sélectionnés dans un rapport.
function button1_onclick(event) {
   var val = IbComposer_getAllAmpersValues();
   alert(val);
   OnExecute(event);
}

Haut de page

x
Evènement : onbeforeload

Comment :

L'événement onbeforeload est un gestionnaire utiliser avant qu'un contrôle ne soit renseigné avec des valeurs.



x
Syntaxe : Utiliser l'événement onafterload
onbeforeload(ctrl,arrValuesToLoad);

où :

ctrl

Est un terme statique et ne doit pas être modifié.

arrValuesToLoad

Alphanumérique

est la matrice de valeurs qui sera chargé vers le contrôle.



Exemple : Population d'une boîte liste avec l'événement onbeforeload
function listbox1_onbeforeload(ctrl,arrValuesToLoad) {
   for(var i = 0; i < arrValuesToLoad.length; i++) {
   alert(arrValuesToLoad[i].dispValue + "  " + arrValuesToLoad[i].value +
   "  " + arrValuesToLoad[i].selected); 
   }
}

Haut de page

x
Evènement : onafterload

Comment :

L'événement onafteroad est un gestionnaire utiliser après qu'un contrôle ne soit renseigné avec des valeurs.



x
Syntaxe : Utiliser l'événement onafterload
onafterload(ctrl);

où :

ctrl

Est un terme statique et ne doit pas être modifié.



Exemple : Sélectionner la valeur ALL dans une zone de liste avec onafterload
function listbox1_onafterload(event) {
   alert(IbComposer_isSelected(ctrl.id,'ALL'));
}

Haut de page

x
Fonction : IbComposer_showLayer

Comment :

IbComposer_showLayer affiche ou masque le calque spécifié.



x
Syntaxe : Montrer ou masquer un calque
IbComposer_showLayer(layerName,bShow);

où :

layerName

Alphanumérique

est le nom du calque, qui sera montré ou masqué.

bShow

est un opérateur qui peut être définit à Vrai pour afficher l'élément et à Faux pour le masquer.



Exemple : Afficher ou masquer un calque
function button1_onclick(event) {
   var eventObject = event ? event : window.event;
   var ctrl = eventObject.target ? eventObject.target :
   eventObject.srcElement;
   // TODO: Add your event handler code here
   IbComposer_showLayer('Customers','true');
}

Haut de page

x
Fonction : IbComposer_toggleLayer

Comment :

IbComposer_toggleLayer bascule la visibilité d'un calque spécifié.



x
Syntaxe : Basculer Visibilité Couche
IbComposer_toggleLayer(mapId,layerName);

où :

mapId

Alphanumérique

est l'identifiant unique du premier contrôle. Par exemple, 1.

layerName

Alphanumérique

Est l'identifiant unique d'un calque au sein de la carte. Par exemple, 1.



Exemple : Basculer Visibilité Calque
function button1_onclick(event) {
   var eventObject = event ? event : window.event;
   var ctrl = eventObject.target ? eventObject.target :
   eventObject.srcElement;
   // TODO: Add your event handler code here
   IbComposer_toggleLayer('mapcontrol1','Customers');
}

Haut de page

x
Fonction : IbComposer_toggleMarker

Comment :

IbComposer_toggleMarker bascule la visibilité d'un marqueur spécifié.



x
Syntaxe : Basculer Visibilité Marqueur
IbComposer_toggleMarker(mapId,layerName,markerName);

où :

mapId

Alphanumérique

est l'identifiant unique du premier contrôle. Par exemple, 1.

layerName

Alphanumérique

Est l'identifiant unique d'un calque au sein de la carte. Par exemple, 1.

markerName

Alphanumérique

Est l'identifiant unique d'un marqueur au sein de la carte. Par exemple,.



Exemple : Basculement de marqueur cible
function button1_onclick(event) {
   var eventObject = event ? event : window.event;
   var ctrl = eventObject.target ? eventObject.target :
   eventObject.srcElement;
   // TODO: Add your event handler code here
   IbComposer_toggleMarker('mapcontrol1','Stores','EMart');
}

Haut de page

x
Fonction : IbComposer_refreshLayer

Comment :

IbComposer_refreshLayer actualise le calque spécifié depuis la base de données.



x
Syntaxe : Actualiser un Calque
IbComposer_refreshLayer(mapId,layerName);

où :

mapId

Alphanumérique

est l'identifiant unique du premier contrôle. Par exemple, 1.

layerName

Alphanumérique

Est l'identifiant unique d'un calque au sein de la carte. Par exemple, 1.



Exemple : Actualisation du calque
function button1_onclick(event) {
   var eventObject = event ? event : window.event;
   var ctrl = eventObject.target ? eventObject.target : 
   eventObject.srcElement;
   // TODO: Add your event handler code here
   IbComposer_refreshLayer('mapcontrol1','Customers');    
}


Haut de page

x
Fonction : IbComposer_panToAddress

Comment :

IbComposer_panToAddress permet à l'utilisateur d'effectuer un panorama sur le point d'une carte pour l'adresse spécifiée et le niveau de zoom.



x
Syntaxe : Effectuer un panoramique sur une Adresse
IbComposer_panToAddress(address,mapId,zoom);

où :

Domicile permanent

Alphanumérique

Est l'adresse à laquelle vous souhaitez effectuer un panoramique. Par exemple, 2 Penn Plaza New York NY 10001.

mapId

Alphanumérique

est l'identifiant unique du premier contrôle. Par exemple, 1.

Loupe

Entier

Correspond à votre choix de profondeur de zoom. Par exemple, 7.



Exemple : Effectuer un panoramique sur une Adresse
function button1_onclick(event) {
   var eventObject = event ? event : window.event;
   var ctrl = eventObject.target ? eventObject.target :
   eventObject.srcElement;
   // TODO: Add your event handler code here
   IbComposer_panToAddress('2 Penn Plaza,NY,NY','mapcontrol1',10);
}

Haut de page

x
Fonction : ibComposer_panToPoint

Comment :

ibComposer_panToPoint permet à l'utilisateur d'effectuer un panorama sur le point d'une carte pour les coordonnées spécifiées et le niveau de zoom.



x
Syntaxe : Effectuer un panoramique sur un Point
IbComposer_panToPoint(lat,long,mapId,zoom);

où :

lat

Entier

Est la coordonnée latitude du point sur lequel vous souhaitez effectuer un panoramique. Par exemple, 40.7663277.

longue

Entier

Est la coordonnée longitude du point sur lequel vous souhaitez effectuer un panoramique. Par exemple, 73.9920777.

mapId

Alphanumérique

est l'identifiant unique du premier contrôle. Par exemple, 1.

Loupe

Entier

Correspond à votre choix de profondeur de zoom. Par exemple, 7.



Exemple : Effectuer un panoramique sur un Point
function button1_onclick(event) {
   var eventObject = event ? event : window.event;
   var ctrl = eventObject.target ? eventObject.target :
   eventObject.srcElement;
   // TODO: Add your event handler code here
   IbComposer_panToPoint(37.0625,-95.677068,'mapcontrol1',5); 
}

Haut de page

x
Fonction : IbComposer_showAllMarkers

Comment :

IbComposer_showAllMarkers affiche tous les marqueurs du calque spécifié.



x
Syntaxe : Afficher tous les marqueurs de cartes
IbComposer_showAllMarkers(mapId,layerName);

où :

mapId

Alphanumérique

est l'identifiant unique du premier contrôle. Par exemple, 1.



Exemple : Afficher tous les marqueurs de cartes
function button1_onclick(event) {
   var eventObject = event ? event : window.event;
   var ctrl = eventObject.target ? eventObject.target :
   eventObject.srcElement;
   // TODO: Add your event handler code here
   IbComposer_showAllMarkers('mapcontrol1','Customers');  
}

Haut de page

x
Function: IbComposer_drawBullseye

Comment :

IbComposer_drawBullseye dessine une cible sur un point de la carte. Cette fonction offre des paramètres optionnels pour indiquer si vous souhaitez afficher des marqueurs, les unités de mesure utilisées pour le curseur cible, le nombre de cercles, leur taille, et leur couleur.



x
Syntaxe : Dessine une Cible (deux cercles concentriques)
IbComposer_drawBullseye(mapId,lat,long,selectmarkers,units,rings,[list-of-sizes],[list-of-colors]);

où :

mapId

Alphanumérique

est l'identifiant unique du premier contrôle. Par exemple, 1.

lat

Entier

Est la coordonnée latitude du point sur lequel vous souhaitez effectuer un panoramique. Par exemple, 40.7663277.

longue

Entier

Est la coordonnée longitude du point sur lequel vous souhaitez effectuer un panoramique. Par exemple, 73.9920777.

selectmarkers

Booléennes

Est un opérateur qui, s'il a la valeur vrai (true), sélectionne tous les marqueurs au sein de la cible.

units

Alphanumérique

L'unité de mesure pour les cercles du curseur cible, par exemple, mi pour miles.

anneaux

Entier

Le nombre de cercles que le curseur cible utilise. Par exemple, 3.

list-of-sizes

Entier

est un paramètre optionnel, telle une liste séparée par virgule de couleur pour les anneaux cible. Par exemple, 1/3/5.

list-of-colors

Alphanumérique

est un paramètre optionnel, telle une liste séparée par virgule de couleur pour les anneaux cible. Les couleurs peuvent être des valeurs RGB ou des valeurs hexadécimales. Par exemple, Bleu ou #FFFF.



Exemple : Dessine une Cible (deux cercles concentriques)
function button1_onclick(event) {
   var eventObject = event ? event : window.event;
   var ctrl = eventObject.target ? eventObject.target :
   eventObject.srcElement;
   // TODO: Add your event handler code here
   IbComposer_drawBullseye('mapcontrol1',37.0625,-95.677068,'true','mi',3);
}

WebFOCUS